1 /* Heap management routines for GNU Emacs on the Microsoft Windows API.
2 Copyright (C) 1994, 2001-2016 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 Geoff Voelker (voelker@cs.washington.edu) 7-29-94
24 Heavily modified by Fabrice Popineau (fabrice.popineau@gmail.com) 28-02-2014
28 Memory allocation scheme for w32/w64:
30 - Buffers are mmap'ed using a very simple emulation of mmap/munmap
31 - During the temacs phase:
32 * we use a private heap declared to be stored into the `dumped_data'
33 * unfortunately, this heap cannot be made growable, so the size of
34 blocks it can allocate is limited to (0x80000 - pagesize)
35 * the blocks that are larger than this are allocated from the end
36 of the `dumped_data' array; there are not so many of them.
37 We use a very simple first-fit scheme to reuse those blocks.
38 * we check that the private heap does not cross the area used
40 - During the emacs phase:
41 * we create a private heap for new memory blocks
42 * we make sure that we never free a block that has been dumped.
43 Freeing a dumped block could work in principle, but may prove
44 unreliable if we distribute binaries of emacs.exe: MS does not
45 guarantee that the heap data structures are the same across all
46 versions of their OS, even though the API is available since XP. */
53 #include "w32common.h"
57 /* We chose to leave those declarations here. They are used only in
58 this file. The RtlCreateHeap is available since XP. It is located
59 in ntdll.dll and is available with the DDK. People often
60 complained that HeapCreate doesn't offer the ability to create a
61 heap at a given place, which we need here, and which RtlCreateHeap
62 provides. We reproduce here the definitions available with the
65 typedef PVOID (WINAPI
* RtlCreateHeap_Proc
) (
66 /* _In_ */ ULONG Flags
,
67 /* _In_opt_ */ PVOID HeapBase
,
68 /* _In_opt_ */ SIZE_T ReserveSize
,
69 /* _In_opt_ */ SIZE_T CommitSize
,
70 /* _In_opt_ */ PVOID Lock
,
71 /* _In_opt_ */ PVOID Parameters
74 typedef LONG NTSTATUS
;
77 (NTAPI
* PRTL_HEAP_COMMIT_ROUTINE
)(
79 IN OUT PVOID
*CommitAddress
,
80 IN OUT PSIZE_T CommitSize
83 typedef struct _RTL_HEAP_PARAMETERS
{
85 SIZE_T SegmentReserve
;
87 SIZE_T DeCommitFreeBlockThreshold
;
88 SIZE_T DeCommitTotalFreeThreshold
;
89 SIZE_T MaximumAllocationSize
;
90 SIZE_T VirtualMemoryThreshold
;
92 SIZE_T InitialReserve
;
93 PRTL_HEAP_COMMIT_ROUTINE CommitRoutine
;
95 } RTL_HEAP_PARAMETERS
, *PRTL_HEAP_PARAMETERS
;
97 /* We reserve space for dumping emacs lisp byte-code inside a static
98 array. By storing it in an array, the generic mechanism in
99 unexecw32.c will be able to dump it without the need to add a
100 special segment to the executable. In order to be able to do this
101 without losing too much space, we need to create a Windows heap at
102 the specific address of the static array. The RtlCreateHeap
103 available inside the NT kernel since XP will do this. It allows the
104 creation of a non-growable heap at a specific address. So before
105 dumping, we create a non-growable heap at the address of the
106 dumped_data[] array. After dumping, we reuse memory allocated
107 there without being able to free it (but most of it is not meant to
108 be freed anyway), and we use a new private heap for all new
111 /* FIXME: Most of the space reserved for dumped_data[] is only used by
112 the 1st bootstrap-emacs.exe built while bootstrapping. Once the
113 preloaded Lisp files are byte-compiled, the next loadup uses less
114 than half of the size stated below. It would be nice to find a way
115 to build only the first bootstrap-emacs.exe with the large size,
116 and reset that to a lower value afterwards. */
117 #if defined _WIN64 || defined WIDE_EMACS_INT
118 # define DUMPED_HEAP_SIZE (20*1024*1024)
120 # define DUMPED_HEAP_SIZE (12*1024*1024)
123 static unsigned char dumped_data
[DUMPED_HEAP_SIZE
];
125 /* Info for keeping track of our dynamic heap used after dumping. */
126 unsigned char *data_region_base
= NULL
;
127 unsigned char *data_region_end
= NULL
;
128 static DWORD_PTR committed
= 0;
130 /* The maximum block size that can be handled by a non-growable w32
131 heap is limited by the MaxBlockSize value below.
133 This point deserves and explanation.
135 The W32 heap allocator can be used for a growable
136 heap or a non-growable one.
138 A growable heap is not compatible with a fixed base address for the
139 heap. Only a non-growable one is. One drawback of non-growable
140 heaps is that they can hold only objects smaller than a certain
141 size (the one defined below). Most of the largest blocks are GC'ed
142 before dumping. In any case and to be safe, we implement a simple
143 first-fit allocation algorithm starting at the end of the
144 dumped_data[] array like depicted below:
146 ----------------------------------------------
148 | Private heap |-> <-| Big chunks |
150 ----------------------------------------------
152 dumped_data dumped_data bc_limit
157 /* Info for managing our preload heap, which is essentially a fixed size
158 data area in the executable. */
159 #define PAGE_SIZE 0x1000
160 #define MaxBlockSize (0x80000 - PAGE_SIZE)
162 #define MAX_BLOCKS 0x40
166 unsigned char *address
;
169 } blocks
[MAX_BLOCKS
];
171 static DWORD blocks_number
= 0;
172 static unsigned char *bc_limit
;
174 /* Handle for the private heap:
175 - inside the dumped_data[] array before dump,
176 - outside of it after dump.
180 /* We redirect the standard allocation functions. */
181 malloc_fn the_malloc_fn
;
182 realloc_fn the_realloc_fn
;
185 /* It doesn't seem to be useful to allocate from a file mapping.
186 It would be if the memory was shared.
187 http://stackoverflow.com/questions/307060/what-is-the-purpose-of-allocating-pages-in-the-pagefile-with-createfilemapping */
189 /* This is the function to commit memory when the heap allocator
190 claims for new memory. Before dumping, we allocate space
191 from the fixed size dumped_data[] array.
194 dumped_data_commit (PVOID Base
, PVOID
*CommitAddress
, PSIZE_T CommitSize
)
196 /* This is used before dumping.
198 The private heap is stored at dumped_data[] address.
199 We commit contiguous areas of the dumped_data array
200 as requests arrive. */
201 *CommitAddress
= data_region_base
+ committed
;
202 committed
+= *CommitSize
;
203 /* Check that the private heap area does not overlap the big chunks area. */
204 if (((unsigned char *)(*CommitAddress
)) + *CommitSize
>= bc_limit
)
207 "dumped_data_commit: memory exhausted.\nEnlarge dumped_data[]!\n");
215 /* We want to turn on Low Fragmentation Heap for XP and older systems.
216 MinGW32 lacks those definitions. */
218 typedef enum _HEAP_INFORMATION_CLASS
{
219 HeapCompatibilityInformation
220 } HEAP_INFORMATION_CLASS
;
222 typedef WINBASEAPI
BOOL (WINAPI
* HeapSetInformation_Proc
)(HANDLE
,HEAP_INFORMATION_CLASS
,PVOID
,SIZE_T
);
228 if (using_dynamic_heap
)
230 unsigned long enable_lfh
= 2;
232 /* After dumping, use a new private heap. We explicitly enable
233 the low fragmentation heap (LFH) here, for the sake of pre
234 Vista versions. Note: this will harmlessly fail on Vista and
235 later, where the low-fragmentation heap is enabled by
236 default. It will also fail on pre-Vista versions when Emacs
237 is run under a debugger; set _NO_DEBUG_HEAP=1 in the
238 environment before starting GDB to get low fragmentation heap
239 on XP and older systems, for the price of losing "certain
240 heap debug options"; for the details see
241 http://msdn.microsoft.com/en-us/library/windows/desktop/aa366705%28v=vs.85%29.aspx. */
242 data_region_end
= data_region_base
;
244 /* Create the private heap. */
245 heap
= HeapCreate (0, 0, 0);
248 /* Set the low-fragmentation heap for OS before Vista. */
249 HMODULE hm_kernel32dll
= LoadLibrary ("kernel32.dll");
250 HeapSetInformation_Proc s_pfn_Heap_Set_Information
= (HeapSetInformation_Proc
) GetProcAddress (hm_kernel32dll
, "HeapSetInformation");
251 if (s_pfn_Heap_Set_Information
!= NULL
)
253 if (s_pfn_Heap_Set_Information ((PVOID
) heap
,
254 HeapCompatibilityInformation
,
255 &enable_lfh
, sizeof(enable_lfh
)) == 0)
256 DebPrint (("Enabling Low Fragmentation Heap failed: error %ld\n",
261 if (os_subtype
== OS_9X
)
263 the_malloc_fn
= malloc_after_dump_9x
;
264 the_realloc_fn
= realloc_after_dump_9x
;
265 the_free_fn
= free_after_dump_9x
;
269 the_malloc_fn
= malloc_after_dump
;
270 the_realloc_fn
= realloc_after_dump
;
271 the_free_fn
= free_after_dump
;
276 /* Find the RtlCreateHeap function. Headers for this function
277 are provided with the w32 ddk, but the function is available
278 in ntdll.dll since XP. */
279 HMODULE hm_ntdll
= LoadLibrary ("ntdll.dll");
280 RtlCreateHeap_Proc s_pfn_Rtl_Create_Heap
281 = (RtlCreateHeap_Proc
) GetProcAddress (hm_ntdll
, "RtlCreateHeap");
282 /* Specific parameters for the private heap. */
283 RTL_HEAP_PARAMETERS params
;
284 ZeroMemory (¶ms
, sizeof(params
));
285 params
.Length
= sizeof(RTL_HEAP_PARAMETERS
);
287 data_region_base
= (unsigned char *)ROUND_UP (dumped_data
, 0x1000);
288 data_region_end
= bc_limit
= dumped_data
+ DUMPED_HEAP_SIZE
;
290 params
.InitialCommit
= committed
= 0x1000;
291 params
.InitialReserve
= sizeof(dumped_data
);
292 /* Use our own routine to commit memory from the dumped_data
294 params
.CommitRoutine
= &dumped_data_commit
;
296 /* Create the private heap. */
297 if (s_pfn_Rtl_Create_Heap
== NULL
)
299 fprintf (stderr
, "Cannot build Emacs without RtlCreateHeap being available; exiting.\n");
302 heap
= s_pfn_Rtl_Create_Heap (0, data_region_base
, 0, 0, NULL
, ¶ms
);
304 if (os_subtype
== OS_9X
)
306 fprintf (stderr
, "Cannot dump Emacs on Windows 9X; exiting.\n");
311 the_malloc_fn
= malloc_before_dump
;
312 the_realloc_fn
= realloc_before_dump
;
313 the_free_fn
= free_before_dump
;
317 /* Update system version information to match current system. */
318 cache_system_info ();
325 /* FREEABLE_P checks if the block can be safely freed. */
326 #define FREEABLE_P(addr) \
327 ((unsigned char *)(addr) > 0 \
328 && ((unsigned char *)(addr) < dumped_data \
329 || (unsigned char *)(addr) >= dumped_data + DUMPED_HEAP_SIZE))
332 malloc_after_dump (size_t size
)
334 /* Use the new private heap. */
335 void *p
= HeapAlloc (heap
, 0, size
);
337 /* After dump, keep track of the "brk value" for sbrk(0). */
340 unsigned char *new_brk
= (unsigned char *)p
+ size
;
342 if (new_brk
> data_region_end
)
343 data_region_end
= new_brk
;
351 malloc_before_dump (size_t size
)
355 /* Before dumping. The private heap can handle only requests for
356 less than MaxBlockSize. */
357 if (size
< MaxBlockSize
)
359 /* Use the private heap if possible. */
360 p
= HeapAlloc (heap
, 0, size
);
366 /* Find the first big chunk that can hold the requested size. */
369 for (i
= 0; i
< blocks_number
; i
++)
371 if (blocks
[i
].occupied
== 0 && blocks
[i
].size
>= size
)
374 if (i
< blocks_number
)
376 /* If found, use it. */
377 p
= blocks
[i
].address
;
378 blocks
[i
].occupied
= TRUE
;
382 /* Allocate a new big chunk from the end of the dumped_data
384 if (blocks_number
>= MAX_BLOCKS
)
387 "malloc_before_dump: no more big chunks available.\nEnlarge MAX_BLOCKS!\n");
391 bc_limit
= (unsigned char *)ROUND_DOWN (bc_limit
, 0x10);
393 blocks
[blocks_number
].address
= p
;
394 blocks
[blocks_number
].size
= size
;
395 blocks
[blocks_number
].occupied
= TRUE
;
397 /* Check that areas do not overlap. */
398 if (bc_limit
< dumped_data
+ committed
)
401 "malloc_before_dump: memory exhausted.\nEnlarge dumped_data[]!\n");
409 /* Re-allocate the previously allocated block in ptr, making the new
410 block SIZE bytes long. */
412 realloc_after_dump (void *ptr
, size_t size
)
417 if (FREEABLE_P (ptr
))
419 /* Reallocate the block since it lies in the new heap. */
420 p
= HeapReAlloc (heap
, 0, ptr
, size
);
426 /* If the block lies in the dumped data, do not free it. Only
427 allocate a new one. */
428 p
= HeapAlloc (heap
, 0, size
);
432 CopyMemory (p
, ptr
, size
);
434 /* After dump, keep track of the "brk value" for sbrk(0). */
437 unsigned char *new_brk
= (unsigned char *)p
+ size
;
439 if (new_brk
> data_region_end
)
440 data_region_end
= new_brk
;
446 realloc_before_dump (void *ptr
, size_t size
)
450 /* Before dumping. */
451 if (dumped_data
< (unsigned char *)ptr
452 && (unsigned char *)ptr
< bc_limit
&& size
<= MaxBlockSize
)
454 p
= HeapReAlloc (heap
, 0, ptr
, size
);
460 /* In this case, either the new block is too large for the heap,
461 or the old block was already too large. In both cases,
462 malloc_before_dump() and free_before_dump() will take care of
464 p
= malloc_before_dump (size
);
465 /* If SIZE is below MaxBlockSize, malloc_before_dump will try to
466 allocate it in the fixed heap. If that fails, we could have
467 kept the block in its original place, above bc_limit, instead
468 of failing the call as below. But this doesn't seem to be
469 worth the added complexity, as loadup allocates only a very
470 small number of large blocks, and never reallocates them. */
473 CopyMemory (p
, ptr
, size
);
474 free_before_dump (ptr
);
480 /* Free a block allocated by `malloc', `realloc' or `calloc'. */
482 free_after_dump (void *ptr
)
485 if (FREEABLE_P (ptr
))
487 /* Free the block if it is in the new private heap. */
488 HeapFree (heap
, 0, ptr
);
493 free_before_dump (void *ptr
)
498 /* Before dumping. */
499 if (dumped_data
< (unsigned char *)ptr
500 && (unsigned char *)ptr
< bc_limit
)
502 /* Free the block if it is allocated in the private heap. */
503 HeapFree (heap
, 0, ptr
);
507 /* Look for the big chunk. */
510 for (i
= 0; i
< blocks_number
; i
++)
512 if (blocks
[i
].address
== ptr
)
514 /* Reset block occupation if found. */
515 blocks
[i
].occupied
= 0;
518 /* What if the block is not found? We should trigger an
520 eassert (i
< blocks_number
);
525 /* On Windows 9X, HeapAlloc may return pointers that are not aligned
526 on 8-byte boundary, alignment which is required by the Lisp memory
527 management. To circumvent this problem, manually enforce alignment
531 malloc_after_dump_9x (size_t size
)
533 void *p
= malloc_after_dump (size
+ 8);
537 pa
= (void*)(((intptr_t)p
+ 8) & ~7);
543 realloc_after_dump_9x (void *ptr
, size_t size
)
545 if (FREEABLE_P (ptr
))
547 void *po
= *((void**)ptr
-1);
550 p
= realloc_after_dump (po
, size
+ 8);
553 pa
= (void*)(((intptr_t)p
+ 8) & ~7);
555 (char*)pa
- (char*)p
!= (char*)ptr
- (char*)po
)
557 /* Handle the case where alignment in pre-realloc and
558 post-realloc blocks does not match. */
559 MoveMemory (pa
, (void*)((char*)p
+ ((char*)ptr
- (char*)po
)), size
);
566 /* Non-freeable pointers have no alignment-enforcing header
567 (since dumping is not allowed on Windows 9X). */
568 void* p
= malloc_after_dump_9x (size
);
570 CopyMemory (p
, ptr
, size
);
576 free_after_dump_9x (void *ptr
)
578 if (FREEABLE_P (ptr
))
580 free_after_dump (*((void**)ptr
-1));
584 #ifdef ENABLE_CHECKING
586 report_temacs_memory_usage (void)
588 DWORD blocks_used
= 0;
589 size_t large_mem_used
= 0;
592 for (i
= 0; i
< blocks_number
; i
++)
593 if (blocks
[i
].occupied
)
596 large_mem_used
+= blocks
[i
].size
;
599 /* Emulate 'message', which writes to stderr in non-interactive
602 "Dump memory usage: Heap: %" PRIu64
" Large blocks(%lu/%lu): %" PRIu64
"/%" PRIu64
"\n",
603 (unsigned long long)committed
, blocks_used
, blocks_number
,
604 (unsigned long long)large_mem_used
,
605 (unsigned long long)(dumped_data
+ DUMPED_HEAP_SIZE
- bc_limit
));
609 /* Emulate getpagesize. */
613 return sysinfo_cache
.dwPageSize
;
617 sbrk (ptrdiff_t increment
)
619 /* data_region_end is the address beyond the last allocated byte.
620 The sbrk() function is not emulated at all, except for a 0 value
621 of its parameter. This is needed by the Emacs Lisp function
623 eassert (increment
== 0);
624 return data_region_end
;
627 #define MAX_BUFFER_SIZE (512 * 1024 * 1024)
629 /* MMAP allocation for buffers. */
631 mmap_alloc (void **var
, size_t nbytes
)
635 /* We implement amortized allocation. We start by reserving twice
636 the size requested and commit only the size requested. Then
637 realloc could proceed and use the reserved pages, reallocating
638 only if needed. Buffer shrink would happen only so that we stay
639 in the 2x range. This is a big win when visiting compressed
640 files, where the final size of the buffer is not known in
641 advance, and the buffer is enlarged several times as the data is
642 decompressed on the fly. */
643 if (nbytes
< MAX_BUFFER_SIZE
)
644 p
= VirtualAlloc (NULL
, (nbytes
* 2), MEM_RESERVE
, PAGE_READWRITE
);
646 /* If it fails, or if the request is above 512MB, try with the
649 p
= VirtualAlloc (NULL
, nbytes
, MEM_RESERVE
, PAGE_READWRITE
);
653 /* Now, commit pages for NBYTES. */
654 *var
= VirtualAlloc (p
, nbytes
, MEM_COMMIT
, PAGE_READWRITE
);
661 DWORD e
= GetLastError ();
663 if (e
== ERROR_NOT_ENOUGH_MEMORY
)
667 DebPrint (("mmap_alloc: error %ld\n", e
));
676 mmap_free (void **var
)
680 if (VirtualFree (*var
, 0, MEM_RELEASE
) == 0)
681 DebPrint (("mmap_free: error %ld\n", GetLastError ()));
687 mmap_realloc (void **var
, size_t nbytes
)
689 MEMORY_BASIC_INFORMATION memInfo
, m2
;
693 return mmap_alloc (var
, nbytes
);
695 /* This case happens in init_buffer(). */
699 return mmap_alloc (var
, nbytes
);
702 memset (&memInfo
, 0, sizeof (memInfo
));
703 if (VirtualQuery (*var
, &memInfo
, sizeof (memInfo
)) == 0)
704 DebPrint (("mmap_realloc: VirtualQuery error = %ld\n", GetLastError ()));
706 /* We need to enlarge the block. */
707 if (memInfo
.RegionSize
< nbytes
)
709 memset (&m2
, 0, sizeof (m2
));
710 if (VirtualQuery (*var
+ memInfo
.RegionSize
, &m2
, sizeof(m2
)) == 0)
711 DebPrint (("mmap_realloc: VirtualQuery error = %ld\n",
713 /* If there is enough room in the current reserved area, then
714 commit more pages as needed. */
715 if (m2
.State
== MEM_RESERVE
716 && nbytes
<= memInfo
.RegionSize
+ m2
.RegionSize
)
720 p
= VirtualAlloc (*var
+ memInfo
.RegionSize
,
721 nbytes
- memInfo
.RegionSize
,
722 MEM_COMMIT
, PAGE_READWRITE
);
723 if (!p
/* && GetLastError() != ERROR_NOT_ENOUGH_MEMORY */)
725 DebPrint (("realloc enlarge: VirtualAlloc (%p + %I64x, %I64x) error %ld\n",
726 *var
, (uint64_t)memInfo
.RegionSize
,
727 (uint64_t)(nbytes
- memInfo
.RegionSize
),
729 DebPrint (("next region: %p %p %I64x %x\n", m2
.BaseAddress
,
730 m2
.AllocationBase
, m2
.RegionSize
, m2
.AllocationProtect
));
735 /* Else we must actually enlarge the block by allocating a new
736 one and copying previous contents from the old to the new one. */
739 if (mmap_alloc (var
, nbytes
))
741 CopyMemory (*var
, old_ptr
, memInfo
.RegionSize
);
742 mmap_free (&old_ptr
);
747 /* We failed to reallocate the buffer. */
753 /* If we are shrinking by more than one page... */
754 if (memInfo
.RegionSize
> nbytes
+ getpagesize())
756 /* If we are shrinking a lot... */
757 if ((memInfo
.RegionSize
/ 2) > nbytes
)
759 /* Let's give some memory back to the system and release
763 if (mmap_alloc (var
, nbytes
))
765 CopyMemory (*var
, old_ptr
, nbytes
);
766 mmap_free (&old_ptr
);
771 /* In case we fail to shrink, try to go on with the old block.
772 But that means there is a lot of memory pressure.
773 We could also decommit pages. */
779 /* We still can decommit pages. */
780 if (VirtualFree (*var
+ nbytes
+ get_page_size(),
781 memInfo
.RegionSize
- nbytes
- get_page_size(),
783 DebPrint (("mmap_realloc: VirtualFree error %ld\n", GetLastError ()));
787 /* Not enlarging, not shrinking by more than one page. */