annotate src/w32heap.h @ 106623:a0bf2614deb1

*** empty log message ***
author Eli Zaretskii <eliz@gnu.org>
date Sat, 19 Dec 2009 11:58:11 +0000
parents e038c1a8307c
children 1d1d5d9bd884
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 /* Heap management routines (including unexec) for GNU Emacs on Windows NT.
75227
e90d04cd455a Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents: 68651
diff changeset
2 Copyright (C) 1994, 2001, 2002, 2003, 2004, 2005,
100951
e038c1a8307c Add 2009 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 95011
diff changeset
3 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
5 This file is part of GNU Emacs.
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6
94994
29adfc9354e7 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 79759
diff changeset
7 GNU Emacs is free software: you can redistribute it and/or modify
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
8 it under the terms of the GNU General Public License as published by
94994
29adfc9354e7 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 79759
diff changeset
9 the Free Software Foundation, either version 3 of the License, or
29adfc9354e7 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 79759
diff changeset
10 (at your option) any later version.
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
12 GNU Emacs is distributed in the hope that it will be useful,
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
15 GNU General Public License for more details.
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
17 You should have received a copy of the GNU General Public License
95011
a1e7d73546c4 Fix typo in previous change.
Juanma Barranquero <lekktu@gmail.com>
parents: 94994
diff changeset
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 Geoff Voelker (voelker@cs.washington.edu) 7-29-94
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 */
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 #ifndef NTHEAP_H_
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 #define NTHEAP_H_
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 #include <windows.h>
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27
24104
939f14a75ce2 (ROUND_UP):
Andrew Innes <andrewi@gnu.org>
parents: 21610
diff changeset
28 #define ROUND_UP(p, align) (((DWORD)(p) + (align)-1) & ~((align)-1))
939f14a75ce2 (ROUND_UP):
Andrew Innes <andrewi@gnu.org>
parents: 21610
diff changeset
29 #define ROUND_DOWN(p, align) ((DWORD)(p) & ~((align)-1))
939f14a75ce2 (ROUND_UP):
Andrew Innes <andrewi@gnu.org>
parents: 21610
diff changeset
30
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 /*
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 * Heap related stuff.
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 */
11944
89ccf3b3208d (get_data_region_base): Undefined.
Geoff Voelker <voelker@cs.washington.edu>
parents: 9803
diff changeset
34 #define get_reserved_heap_size() reserved_heap_size
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 #define get_committed_heap_size() (get_data_end () - get_data_start ())
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 #define get_heap_start() get_data_start ()
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 #define get_heap_end() get_data_end ()
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 #define get_page_size() sysinfo_cache.dwPageSize
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 #define get_allocation_unit() sysinfo_cache.dwAllocationGranularity
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 #define get_processor_type() sysinfo_cache.dwProcessorType
16588
481b7874a1e9 Change identifiers of the form win32* to w32*.
Geoff Voelker <voelker@cs.washington.edu>
parents: 14186
diff changeset
41 #define get_w32_major_version() w32_major_version
481b7874a1e9 Change identifiers of the form win32* to w32*.
Geoff Voelker <voelker@cs.washington.edu>
parents: 14186
diff changeset
42 #define get_w32_minor_version() w32_minor_version
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 extern unsigned char *get_data_start();
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 extern unsigned char *get_data_end();
11944
89ccf3b3208d (get_data_region_base): Undefined.
Geoff Voelker <voelker@cs.washington.edu>
parents: 9803
diff changeset
46 extern unsigned long reserved_heap_size;
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 extern SYSTEM_INFO sysinfo_cache;
24887
c440aa9c1485 w32heap.h (osinfo_cache): Declare.
Geoff Voelker <voelker@cs.washington.edu>
parents: 24104
diff changeset
48 extern OSVERSIONINFO osinfo_cache;
24104
939f14a75ce2 (ROUND_UP):
Andrew Innes <andrewi@gnu.org>
parents: 21610
diff changeset
49 extern BOOL using_dynamic_heap;
16588
481b7874a1e9 Change identifiers of the form win32* to w32*.
Geoff Voelker <voelker@cs.washington.edu>
parents: 14186
diff changeset
50 extern int w32_major_version;
481b7874a1e9 Change identifiers of the form win32* to w32*.
Geoff Voelker <voelker@cs.washington.edu>
parents: 14186
diff changeset
51 extern int w32_minor_version;
33214
3ee9bf6f1dd2 (w32_build_number): Add extern.
Andrew Innes <andrewi@gnu.org>
parents: 31112
diff changeset
52 extern int w32_build_number;
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53
19709
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
54 enum {
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
55 OS_WIN95 = 1,
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
56 OS_NT
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
57 };
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
58
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
59 extern int os_subtype;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
60
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61 /* Emulation of Unix sbrk(). */
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 extern void *sbrk (unsigned long size);
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63
24104
939f14a75ce2 (ROUND_UP):
Andrew Innes <andrewi@gnu.org>
parents: 21610
diff changeset
64 /* Initialize heap structures for sbrk on startup. */
939f14a75ce2 (ROUND_UP):
Andrew Innes <andrewi@gnu.org>
parents: 21610
diff changeset
65 extern void init_heap ();
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 /* Round the heap to this size. */
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 extern void round_heap (unsigned long size);
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 /* Cache system info, e.g., the NT page size. */
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 extern void cache_system_info (void);
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72
19709
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
73 /* ----------------------------------------------------------------- */
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
74 /* Useful routines for manipulating memory-mapped files. */
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
75
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
76 typedef struct file_data {
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
77 char *name;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
78 unsigned long size;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
79 HANDLE file;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
80 HANDLE file_mapping;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
81 unsigned char *file_base;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
82 } file_data;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
83
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
84 int open_input_file (file_data *p_file, char *name);
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
85 int open_output_file (file_data *p_file, char *name, unsigned long size);
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
86 void close_file_data (file_data *p_file);
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
87
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
88 /* Return pointer to section header for named section. */
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
89 IMAGE_SECTION_HEADER * find_section (char * name, IMAGE_NT_HEADERS * nt_header);
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
90
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
91 /* Return pointer to section header for section containing the given
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
92 relative virtual address. */
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
93 IMAGE_SECTION_HEADER * rva_to_section (DWORD rva, IMAGE_NT_HEADERS * nt_header);
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
94
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95 #endif /* NTHEAP_H_ */
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 39711
diff changeset
96
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 39711
diff changeset
97 /* arch-tag: 3ba4cbe1-8a09-4a41-8f37-fd31f7426b3c
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 39711
diff changeset
98 (do not change this comment) */