428
+ − 1 /* Heap management routines for XEmacs on Windows NT.
+ − 2 Copyright (C) 1994 Free Software Foundation, Inc.
+ − 3
+ − 4 This file is part of XEmacs.
+ − 5
+ − 6 XEmacs is free software; you can redistribute it and/or modify it
+ − 7 under the terms of the GNU General Public License as published by the
+ − 8 Free Software Foundation; either version 2, or (at your option) any
+ − 9 later version.
+ − 10
+ − 11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
+ − 12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ − 13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ − 14 for more details.
+ − 15
+ − 16 You should have received a copy of the GNU General Public License
+ − 17 along with XEmacs; see the file COPYING. If not, write to the Free
+ − 18 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
+ − 19 02111-1307, USA.
+ − 20
+ − 21 Geoff Voelker (voelker@cs.washington.edu) 7-29-94 */
+ − 22
+ − 23 /* Adapted for XEmacs by David Hobley <david@spook-le0.cia.com.au> */
771
+ − 24 /* Synced with FSF Emacs 19.34.6 by Marc Paquette <marcpa@cam.org>
+ − 25 (Note: Sync messages from Marc Paquette may indicate
+ − 26 incomplete synching, so beware.)
+ − 27 */
428
+ − 28
814
+ − 29 /* This file has been Mule-ized, Ben Wing, 4-13-02. */
+ − 30
428
+ − 31 #include <config.h>
771
+ − 32 #include "lisp.h"
428
+ − 33
814
+ − 34 #include "sysdep.h"
771
+ − 35 #include "syswindows.h"
428
+ − 36
+ − 37 /* This gives us the page size and the size of the allocation unit on NT. */
+ − 38 SYSTEM_INFO sysinfo_cache;
+ − 39 unsigned long syspage_mask = 0;
+ − 40
+ − 41 /* These are defined to get Emacs to compile, but are not used. */
+ − 42 int edata;
+ − 43 int etext;
+ − 44
+ − 45 /* Cache information describing the NT system for later use. */
+ − 46 void
+ − 47 cache_system_info (void)
+ − 48 {
+ − 49 /* Cache page size, allocation unit, processor type, etc. */
+ − 50 GetSystemInfo (&sysinfo_cache);
+ − 51 syspage_mask = sysinfo_cache.dwPageSize - 1;
+ − 52 }
+ − 53
+ − 54 /* Round ADDRESS up to be aligned with ALIGN. */
2367
+ − 55 URawbyte *
+ − 56 round_to_next (URawbyte *address, unsigned long align)
428
+ − 57 {
+ − 58 unsigned long tmp;
+ − 59
+ − 60 tmp = (unsigned long) address;
+ − 61 tmp = (tmp + align - 1) / align;
+ − 62
2367
+ − 63 return (URawbyte *) (tmp * align);
428
+ − 64 }
+ − 65
+ − 66 /* Info for keeping track of our heap. */
2367
+ − 67 URawbyte *data_region_base = UNINIT_PTR;
+ − 68 URawbyte *data_region_end = UNINIT_PTR;
+ − 69 URawbyte *real_data_region_end = UNINIT_PTR;
428
+ − 70 unsigned long data_region_size = UNINIT_LONG;
+ − 71 unsigned long reserved_heap_size = UNINIT_LONG;
+ − 72
+ − 73 /* The start of the data segment. */
2367
+ − 74 URawbyte *
428
+ − 75 get_data_start (void)
+ − 76 {
+ − 77 return data_region_base;
+ − 78 }
+ − 79
+ − 80 /* The end of the data segment. */
2367
+ − 81 URawbyte *
428
+ − 82 get_data_end (void)
+ − 83 {
+ − 84 return data_region_end;
+ − 85 }
+ − 86
2367
+ − 87 static URawbyte *
428
+ − 88 allocate_heap (void)
+ − 89 {
+ − 90 /* The base address for our GNU malloc heap is chosen in conjunction
+ − 91 with the link settings for temacs.exe which control the stack size,
+ − 92 the initial default process heap size and the executable image base
+ − 93 address. The link settings and the malloc heap base below must all
+ − 94 correspond; the relationship between these values depends on how NT
+ − 95 and Win95 arrange the virtual address space for a process (and on
+ − 96 the size of the code and data segments in temacs.exe).
+ − 97
+ − 98 The most important thing is to make base address for the executable
+ − 99 image high enough to leave enough room between it and the 4MB floor
+ − 100 of the process address space on Win95 for the primary thread stack,
+ − 101 the process default heap, and other assorted odds and ends
+ − 102 (eg. environment strings, private system dll memory etc) that are
+ − 103 allocated before temacs has a chance to grab its malloc arena. The
+ − 104 malloc heap base can then be set several MB higher than the
+ − 105 executable image base, leaving enough room for the code and data
+ − 106 segments.
+ − 107
+ − 108 Because some parts of Emacs can use rather a lot of stack space
+ − 109 (for instance, the regular expression routines can potentially
+ − 110 allocate several MB of stack space) we allow 8MB for the stack.
+ − 111
+ − 112 Allowing 1MB for the default process heap, and 1MB for odds and
+ − 113 ends, we can base the executable at 16MB and still have a generous
+ − 114 safety margin. At the moment, the executable has about 810KB of
+ − 115 code (for x86) and about 550KB of data - on RISC platforms the code
+ − 116 size could be roughly double, so if we allow 4MB for the executable
+ − 117 we will have plenty of room for expansion.
+ − 118
+ − 119 Thus we would like to set the malloc heap base to 20MB. However,
+ − 120 Win95 refuses to allocate the heap starting at this address, so we
+ − 121 set the base to 27MB to make it happy. Since Emacs now leaves
+ − 122 28 bits available for pointers, this lets us use the remainder of
+ − 123 the region below the 256MB line for our malloc arena - 229MB is
+ − 124 still a pretty decent arena to play in! */
+ − 125
+ − 126 unsigned long base = 0x01B00000; /* 27MB */
438
+ − 127 /* Temporary hack for the non-starting problem - use 28 (256Mb) rather than VALBITS (1Gb) */
+ − 128 unsigned long end = 1 << 28; /* 256MB */
428
+ − 129 void *ptr = NULL;
+ − 130
+ − 131 #define NTHEAP_PROBE_BASE 1
+ − 132 #if NTHEAP_PROBE_BASE /* This is never normally defined */
+ − 133 /* Try various addresses looking for one the kernel will let us have. */
+ − 134 while (!ptr && (base < end))
+ − 135 {
+ − 136 reserved_heap_size = end - base;
+ − 137 ptr = VirtualAlloc ((void *) base,
+ − 138 get_reserved_heap_size (),
+ − 139 MEM_RESERVE,
+ − 140 PAGE_NOACCESS);
+ − 141 base += 0x00100000; /* 1MB increment */
+ − 142 }
+ − 143 #else
+ − 144 reserved_heap_size = end - base;
+ − 145 ptr = VirtualAlloc ((void *) base,
+ − 146 get_reserved_heap_size (),
+ − 147 MEM_RESERVE,
+ − 148 PAGE_NOACCESS);
+ − 149 #endif
+ − 150
2367
+ − 151 return (URawbyte *) ptr;
428
+ − 152 }
+ − 153
+ − 154
+ − 155 /* Emulate Unix sbrk. */
+ − 156 void *
+ − 157 sbrk (unsigned long increment)
+ − 158 {
+ − 159 void *result;
+ − 160 long size = (long) increment;
+ − 161
+ − 162 /* Allocate our heap if we haven't done so already. */
+ − 163 if (data_region_base == UNINIT_PTR)
+ − 164 {
+ − 165 data_region_base = allocate_heap ();
+ − 166 if (!data_region_base)
+ − 167 return NULL;
+ − 168
+ − 169 data_region_end = data_region_base;
+ − 170 real_data_region_end = data_region_end;
+ − 171 data_region_size = get_reserved_heap_size ();
+ − 172 }
+ − 173
+ − 174 result = data_region_end;
+ − 175
+ − 176 /* If size is negative, shrink the heap by decommitting pages. */
+ − 177 if (size < 0)
+ − 178 {
+ − 179 int new_size;
2367
+ − 180 URawbyte *new_data_region_end;
428
+ − 181
+ − 182 size = -size;
+ − 183
+ − 184 /* Sanity checks. */
+ − 185 if ((data_region_end - size) < data_region_base)
+ − 186 return NULL;
+ − 187
+ − 188 /* We can only decommit full pages, so allow for
+ − 189 partial deallocation [cga]. */
+ − 190 new_data_region_end = (data_region_end - size);
2367
+ − 191 new_data_region_end = (URawbyte *)
428
+ − 192 ((long) (new_data_region_end + syspage_mask) & ~syspage_mask);
+ − 193 new_size = real_data_region_end - new_data_region_end;
+ − 194 real_data_region_end = new_data_region_end;
+ − 195 if (new_size > 0)
+ − 196 {
+ − 197 /* Decommit size bytes from the end of the heap. */
+ − 198 if (!VirtualFree (real_data_region_end, new_size, MEM_DECOMMIT))
+ − 199 return NULL;
+ − 200 }
+ − 201
+ − 202 data_region_end -= size;
+ − 203 }
+ − 204 /* If size is positive, grow the heap by committing reserved pages. */
+ − 205 else if (size > 0)
+ − 206 {
+ − 207 /* Sanity checks. */
+ − 208 if ((data_region_end + size) >
+ − 209 (data_region_base + get_reserved_heap_size ()))
+ − 210 return NULL;
+ − 211
+ − 212 /* Commit more of our heap. */
+ − 213 if (VirtualAlloc (data_region_end, size, MEM_COMMIT,
+ − 214 PAGE_READWRITE) == NULL)
+ − 215 return NULL;
+ − 216 data_region_end += size;
+ − 217
+ − 218 /* We really only commit full pages, so record where
+ − 219 the real end of committed memory is [cga]. */
2367
+ − 220 real_data_region_end = (URawbyte *)
428
+ − 221 ((long) (data_region_end + syspage_mask) & ~syspage_mask);
+ − 222 }
+ − 223
+ − 224 return result;
+ − 225 }
+ − 226
1330
+ − 227 #if !defined (HEAP_IN_DATA) && !defined (PDUMP)
428
+ − 228
+ − 229 /* Recreate the heap from the data that was dumped to the executable.
+ − 230 EXECUTABLE_PATH tells us where to find the executable. */
+ − 231 void
814
+ − 232 recreate_heap (Extbyte *executable_path)
428
+ − 233 {
442
+ − 234 /* First reserve the upper part of our heap. (We reserve first
+ − 235 because there have been problems in the past where doing the
+ − 236 mapping first has loaded DLLs into the VA space of our heap.) */
428
+ − 237
442
+ − 238 /* Query the region at the end of the committed heap */
+ − 239 void *tmp;
+ − 240 MEMORY_BASIC_INFORMATION info;
+ − 241 DWORD size;
2367
+ − 242 URawbyte *base = get_heap_end ();
+ − 243 URawbyte *end =
814
+ − 244 base + get_reserved_heap_size () - get_committed_heap_size ();
647
+ − 245 VirtualQuery (base, &info, sizeof (info));
442
+ − 246 if (info.State != MEM_FREE)
814
+ − 247 {
+ − 248 /* Oops, something has already reserved or commited it, nothing
+ − 249 we can do but exit */
+ − 250 Extbyte buf[256];
+ − 251 sprintf (buf,
+ − 252 "XEmacs cannot start because the memory region required "
+ − 253 "by the heap is not available.\n"
+ − 254 "(BaseAddress = 0x%lx, AllocationBase = 0x%lx, "
+ − 255 "Size = 0x%lx, State = %s, Type = %s)",
+ − 256 info.BaseAddress, info.AllocationBase, info.RegionSize,
+ − 257 info.State == MEM_COMMIT ? "COMMITED" : "RESERVED",
+ − 258 info.Type == MEM_IMAGE ? "IMAGE" :
+ − 259 info.Type == MEM_MAPPED ? "MAPPED" : "PRIVATE");
+ − 260 MessageBoxA (NULL, buf, "XEmacs", MB_OK | MB_ICONSTOP);
+ − 261 exit(1);
+ − 262 }
442
+ − 263
+ − 264 /* Now try and reserve as much as possible */
647
+ − 265 size = min (info.RegionSize, (DWORD) (end - base));
442
+ − 266 tmp = VirtualAlloc (base, size, MEM_RESERVE, PAGE_NOACCESS);
428
+ − 267 if (!tmp)
814
+ − 268 {
+ − 269 /* Can't reserve it, nothing we can do but exit */
+ − 270 Extbyte buf[256];
+ − 271 sprintf (buf,
+ − 272 "XEmacs cannot start because it couldn't reserve space "
+ − 273 "required for the heap.\n"
+ − 274 "(VirtualAlloc at 0x%lx of 0x%lx failed (%d))",
+ − 275 base, size, GetLastError());
+ − 276 MessageBoxA (NULL, buf, "XEmacs", MB_OK | MB_ICONSTOP);
+ − 277 exit (1);
+ − 278 }
428
+ − 279
+ − 280 /* We read in the data for the .bss section from the executable
+ − 281 first and map in the heap from the executable second to prevent
+ − 282 any funny interactions between file I/O and file mapping. */
+ − 283 read_in_bss (executable_path);
+ − 284 map_in_heap (executable_path);
+ − 285
+ − 286 /* Update system version information to match current system. */
+ − 287 cache_system_info ();
+ − 288 }
1330
+ − 289
+ − 290 #endif /* !defined (HEAP_IN_DATA) && !defined (PDUMP) */
428
+ − 291
+ − 292 /* Round the heap up to the given alignment. */
+ − 293 void
+ − 294 round_heap (unsigned long align)
+ − 295 {
+ − 296 unsigned long needs_to_be;
+ − 297 unsigned long need_to_alloc;
+ − 298
+ − 299 needs_to_be = (unsigned long) round_to_next (get_heap_end (), align);
+ − 300 need_to_alloc = needs_to_be - (unsigned long) get_heap_end ();
+ − 301
+ − 302 if (need_to_alloc)
+ − 303 sbrk (need_to_alloc);
+ − 304 }
+ − 305
707
+ − 306 #if ((_MSC_VER >= 1000) && (_MSC_VER < 1300))
428
+ − 307
+ − 308 /* MSVC 4.2 invokes these functions from mainCRTStartup to initialize
+ − 309 a heap via HeapCreate. They are normally defined by the runtime,
+ − 310 but we override them here so that the unnecessary HeapCreate call
+ − 311 is not performed. */
+ − 312
707
+ − 313 /* MSVC 7.0 does not allow you to redefine _heap_init or _heap_term. */
+ − 314
428
+ − 315 int __cdecl
+ − 316 _heap_init (void)
+ − 317 {
+ − 318 /* Stepping through the assembly indicates that mainCRTStartup is
+ − 319 expecting a nonzero success return value. */
+ − 320 return 1;
+ − 321 }
+ − 322
+ − 323 void __cdecl
+ − 324 _heap_term (void)
+ − 325 {
+ − 326 return;
+ − 327 }
+ − 328
+ − 329 #endif
