annotate src/w32heap.h @ 39378:5d2d33028798

*** empty log message ***
author Eli Zaretskii <eliz@gnu.org>
date Fri, 21 Sep 2001 16:45:34 +0000
parents 3ee9bf6f1dd2
children d943962e1b24
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.
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2 Copyright (C) 1994 Free Software Foundation, Inc.
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
4 This file is part of GNU Emacs.
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
6 GNU Emacs is free software; you can redistribute it and/or modify
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
7 it under the terms of the GNU General Public License as published by
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
9 any later version.
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
11 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
12 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
13 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
14 GNU General Public License for more details.
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
16 You should have received a copy of the GNU General Public License
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
17 along with GNU Emacs; see the file COPYING. If not, write to
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 11944
diff changeset
19 Boston, MA 02111-1307, USA.
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 Geoff Voelker (voelker@cs.washington.edu) 7-29-94
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
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 #ifndef NTHEAP_H_
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 #define NTHEAP_H_
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 #include <windows.h>
31112
1c1c5d1eb49c Undefine min, max.
Andrew Innes <andrewi@gnu.org>
parents: 24887
diff changeset
28 /* Emacs takes care of ensuring that these are defined. */
1c1c5d1eb49c Undefine min, max.
Andrew Innes <andrewi@gnu.org>
parents: 24887
diff changeset
29 #ifdef max
1c1c5d1eb49c Undefine min, max.
Andrew Innes <andrewi@gnu.org>
parents: 24887
diff changeset
30 #undef max
1c1c5d1eb49c Undefine min, max.
Andrew Innes <andrewi@gnu.org>
parents: 24887
diff changeset
31 #undef min
1c1c5d1eb49c Undefine min, max.
Andrew Innes <andrewi@gnu.org>
parents: 24887
diff changeset
32 #endif
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33
24104
939f14a75ce2 (ROUND_UP):
Andrew Innes <andrewi@gnu.org>
parents: 21610
diff changeset
34 #define ROUND_UP(p, align) (((DWORD)(p) + (align)-1) & ~((align)-1))
939f14a75ce2 (ROUND_UP):
Andrew Innes <andrewi@gnu.org>
parents: 21610
diff changeset
35 #define ROUND_DOWN(p, align) ((DWORD)(p) & ~((align)-1))
939f14a75ce2 (ROUND_UP):
Andrew Innes <andrewi@gnu.org>
parents: 21610
diff changeset
36
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 /*
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 * Heap related stuff.
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 */
11944
89ccf3b3208d (get_data_region_base): Undefined.
Geoff Voelker <voelker@cs.washington.edu>
parents: 9803
diff changeset
40 #define get_reserved_heap_size() reserved_heap_size
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 #define get_committed_heap_size() (get_data_end () - get_data_start ())
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 #define get_heap_start() get_data_start ()
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 #define get_heap_end() get_data_end ()
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 #define get_page_size() sysinfo_cache.dwPageSize
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 #define get_allocation_unit() sysinfo_cache.dwAllocationGranularity
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 #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
47 #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
48 #define get_w32_minor_version() w32_minor_version
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 extern unsigned char *get_data_start();
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 extern unsigned char *get_data_end();
11944
89ccf3b3208d (get_data_region_base): Undefined.
Geoff Voelker <voelker@cs.washington.edu>
parents: 9803
diff changeset
52 extern unsigned long reserved_heap_size;
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
53 extern SYSTEM_INFO sysinfo_cache;
24887
c440aa9c1485 w32heap.h (osinfo_cache): Declare.
Geoff Voelker <voelker@cs.washington.edu>
parents: 24104
diff changeset
54 extern OSVERSIONINFO osinfo_cache;
24104
939f14a75ce2 (ROUND_UP):
Andrew Innes <andrewi@gnu.org>
parents: 21610
diff changeset
55 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
56 extern int w32_major_version;
481b7874a1e9 Change identifiers of the form win32* to w32*.
Geoff Voelker <voelker@cs.washington.edu>
parents: 14186
diff changeset
57 extern int w32_minor_version;
33214
3ee9bf6f1dd2 (w32_build_number): Add extern.
Andrew Innes <andrewi@gnu.org>
parents: 31112
diff changeset
58 extern int w32_build_number;
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59
19709
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
60 enum {
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
61 OS_WIN95 = 1,
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
62 OS_NT
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
63 };
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
64
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
65 extern int os_subtype;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
66
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 /* Emulation of Unix sbrk(). */
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68 extern void *sbrk (unsigned long size);
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69
24104
939f14a75ce2 (ROUND_UP):
Andrew Innes <andrewi@gnu.org>
parents: 21610
diff changeset
70 /* Initialize heap structures for sbrk on startup. */
939f14a75ce2 (ROUND_UP):
Andrew Innes <andrewi@gnu.org>
parents: 21610
diff changeset
71 extern void init_heap ();
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 /* Round the heap to this size. */
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 extern void round_heap (unsigned long size);
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 /* Cache system info, e.g., the NT page size. */
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 extern void cache_system_info (void);
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78
19709
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
79 /* ----------------------------------------------------------------- */
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
80 /* Useful routines for manipulating memory-mapped files. */
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
81
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
82 typedef struct file_data {
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
83 char *name;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
84 unsigned long size;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
85 HANDLE file;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
86 HANDLE file_mapping;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
87 unsigned char *file_base;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
88 } file_data;
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
89
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
90 #define OFFSET_TO_RVA(var,section) \
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
91 (section->VirtualAddress + ((DWORD)(var) - section->PointerToRawData))
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
92
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
93 #define RVA_TO_OFFSET(var,section) \
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
94 (section->PointerToRawData + ((DWORD)(var) - section->VirtualAddress))
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
95
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
96 #define RVA_TO_PTR(var,section,filedata) \
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
97 ((void *)(RVA_TO_OFFSET(var,section) + (filedata).file_base))
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
98
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
99 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
100 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
101 void close_file_data (file_data *p_file);
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
102
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
103 /* Return pointer to section header for named section. */
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
104 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
105
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
106 /* 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
107 relative virtual address. */
6b326be52f18 Enumerate operating system types.
Geoff Voelker <voelker@cs.washington.edu>
parents: 16588
diff changeset
108 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
109
9803
fa698fd10c05 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
110 #endif /* NTHEAP_H_ */