1 /* unexec for GNU Emacs on Windows NT.
2 Copyright (C) 1994 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 2, or (at your option)
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; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.
21 Geoff Voelker (voelker@cs.washington.edu) 8-12-94
26 #include <stdlib.h> /* _fmode */
32 /* Include relevant definitions from IMAGEHLP.H, which can be found
33 in \\win32sdk\mstools\samples\image\include\imagehlp.h. */
36 (__stdcall
* pfnCheckSumMappedFile
) (LPVOID BaseAddress
,
41 extern BOOL
ctrl_c_handler (unsigned long type
);
43 extern char my_begdata
[];
44 extern char my_edata
[];
45 extern char my_begbss
[];
46 extern char my_endbss
[];
52 #define min(x, y) (((x) < (y)) ? (x) : (y))
53 #define max(x, y) (((x) > (y)) ? (x) : (y))
55 /* Basically, our "initialized" flag. */
56 BOOL need_to_recreate_heap
= FALSE
;
58 /* So we can find our heap in the file to recreate it. */
59 unsigned long heap_index_in_executable
= 0;
61 int open_input_file (file_data
*p_file
, char *name
);
62 int open_output_file (file_data
*p_file
, char *name
, unsigned long size
);
63 void close_file_data (file_data
*p_file
);
65 void get_section_info (file_data
*p_file
);
66 void copy_executable_and_dump_data_section (file_data
*, file_data
*);
67 void dump_bss_and_heap (file_data
*p_infile
, file_data
*p_outfile
);
69 /* Cached info about the .data section in the executable. */
70 PUCHAR data_start_va
= 0;
71 DWORD data_start_file
= 0;
74 /* Cached info about the .bss section in the executable. */
79 HINSTANCE hinst
= NULL
;
80 HINSTANCE hprevinst
= NULL
;
83 #endif /* HAVE_NTGUI */
85 /* Startup code for running on NT. When we are running as the dumped
86 version, we need to bootstrap our heap and .bss section into our
87 address space before we can actually hand off control to the startup
88 code supplied by NT (primarily because that code relies upon malloc ()). */
92 extern void mainCRTStartup (void);
95 /* Give us a way to debug problems with crashes on startup when
96 running under the MSVC profiler. */
97 if (GetEnvironmentVariable ("EMACS_DEBUG", NULL
, 0) > 0)
101 /* Cache system info, e.g., the NT page size. */
102 cache_system_info ();
104 /* If we're a dumped version of emacs then we need to recreate
105 our heap and play tricks with our .bss section. Do this before
106 start up. (WARNING: Do not put any code before this section
107 that relies upon malloc () and runs in the dumped version. It
109 if (need_to_recreate_heap
)
111 char executable_path
[MAX_PATH
];
113 if (GetModuleFileName (NULL
, executable_path
, MAX_PATH
) == 0)
115 printf ("Failed to find path for executable.\n");
120 /* To allow profiling, make sure executable_path names the .exe
121 file, not the ._xe file created by the profiler which contains
122 extra code that makes the stored exe offsets incorrect. (This
123 will not be necessary when unexec properly extends the .bss (or
124 .data as appropriate) section to include the dumped bss data,
125 and dumps the heap into a proper section of its own.) */
127 char * p
= strrchr (executable_path
, '.');
128 if (p
&& p
[1] == '_')
132 /* Using HiProf profiler, exe name is different still. */
134 char * p
= strrchr (executable_path
, '\\');
135 strcpy (p
, "\\emacs.exe");
139 recreate_heap (executable_path
);
140 need_to_recreate_heap
= FALSE
;
144 /* Grab our malloc arena space now, before CRT starts up. */
148 /* The default behavior is to treat files as binary and patch up
149 text files appropriately, in accordance with the MSDOS code. */
152 /* This prevents ctrl-c's in shells running while we're suspended from
154 SetConsoleCtrlHandler ((PHANDLER_ROUTINE
) ctrl_c_handler
, TRUE
);
156 /* Invoke the NT CRT startup routine now that our housecleaning
159 /* determine WinMain args like crt0.c does */
160 hinst
= GetModuleHandle(NULL
);
161 lpCmdLine
= GetCommandLine();
162 nCmdShow
= SW_SHOWDEFAULT
;
167 /* Dump out .data and .bss sections into a new executable. */
169 unexec (char *new_name
, char *old_name
, void *start_data
, void *start_bss
,
172 file_data in_file
, out_file
;
173 char out_filename
[MAX_PATH
], in_filename
[MAX_PATH
];
177 /* Make sure that the input and output filenames have the
178 ".exe" extension...patch them up if they don't. */
179 strcpy (in_filename
, old_name
);
180 ptr
= in_filename
+ strlen (in_filename
) - 4;
181 if (strcmp (ptr
, ".exe"))
182 strcat (in_filename
, ".exe");
184 strcpy (out_filename
, new_name
);
185 ptr
= out_filename
+ strlen (out_filename
) - 4;
186 if (strcmp (ptr
, ".exe"))
187 strcat (out_filename
, ".exe");
189 printf ("Dumping from %s\n", in_filename
);
190 printf (" to %s\n", out_filename
);
192 /* We need to round off our heap to NT's allocation unit (64KB). */
193 round_heap (get_allocation_unit ());
195 /* Open the undumped executable file. */
196 if (!open_input_file (&in_file
, in_filename
))
198 printf ("Failed to open %s (%d)...bailing.\n",
199 in_filename
, GetLastError ());
203 /* Get the interesting section info, like start and size of .bss... */
204 get_section_info (&in_file
);
206 /* The size of the dumped executable is the size of the original
207 executable plus the size of the heap and the size of the .bss section. */
208 heap_index_in_executable
= (unsigned long)
209 round_to_next ((unsigned char *) in_file
.size
, get_allocation_unit ());
210 size
= heap_index_in_executable
+ get_committed_heap_size () + bss_size
;
211 if (!open_output_file (&out_file
, out_filename
, size
))
213 printf ("Failed to open %s (%d)...bailing.\n",
214 out_filename
, GetLastError ());
218 /* Set the flag (before dumping). */
219 need_to_recreate_heap
= TRUE
;
221 copy_executable_and_dump_data_section (&in_file
, &out_file
);
222 dump_bss_and_heap (&in_file
, &out_file
);
224 /* Patch up header fields; profiler is picky about this. */
226 PIMAGE_DOS_HEADER dos_header
;
227 PIMAGE_NT_HEADERS nt_header
;
228 HANDLE hImagehelp
= LoadLibrary ("imagehlp.dll");
232 dos_header
= (PIMAGE_DOS_HEADER
) out_file
.file_base
;
233 nt_header
= (PIMAGE_NT_HEADERS
) ((char *) dos_header
+ dos_header
->e_lfanew
);
235 nt_header
->OptionalHeader
.CheckSum
= 0;
236 // nt_header->FileHeader.TimeDateStamp = time (NULL);
237 // dos_header->e_cp = size / 512;
238 // nt_header->OptionalHeader.SizeOfImage = size;
240 pfnCheckSumMappedFile
= (void *) GetProcAddress (hImagehelp
, "CheckSumMappedFile");
241 if (pfnCheckSumMappedFile
)
243 // nt_header->FileHeader.TimeDateStamp = time (NULL);
244 pfnCheckSumMappedFile (out_file
.file_base
,
248 nt_header
->OptionalHeader
.CheckSum
= checksum
;
250 FreeLibrary (hImagehelp
);
253 close_file_data (&in_file
);
254 close_file_data (&out_file
);
262 open_input_file (file_data
*p_file
, char *filename
)
267 unsigned long size
, upper_size
;
269 file
= CreateFile (filename
, GENERIC_READ
, FILE_SHARE_READ
, NULL
,
270 OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, 0);
271 if (file
== INVALID_HANDLE_VALUE
)
274 size
= GetFileSize (file
, &upper_size
);
275 file_mapping
= CreateFileMapping (file
, NULL
, PAGE_READONLY
,
280 file_base
= MapViewOfFile (file_mapping
, FILE_MAP_READ
, 0, 0, size
);
284 p_file
->name
= filename
;
287 p_file
->file_mapping
= file_mapping
;
288 p_file
->file_base
= file_base
;
294 open_output_file (file_data
*p_file
, char *filename
, unsigned long size
)
300 file
= CreateFile (filename
, GENERIC_READ
| GENERIC_WRITE
, 0, NULL
,
301 CREATE_ALWAYS
, FILE_ATTRIBUTE_NORMAL
, 0);
302 if (file
== INVALID_HANDLE_VALUE
)
305 file_mapping
= CreateFileMapping (file
, NULL
, PAGE_READWRITE
,
310 file_base
= MapViewOfFile (file_mapping
, FILE_MAP_WRITE
, 0, 0, size
);
314 p_file
->name
= filename
;
317 p_file
->file_mapping
= file_mapping
;
318 p_file
->file_base
= file_base
;
323 /* Close the system structures associated with the given file. */
325 close_file_data (file_data
*p_file
)
327 UnmapViewOfFile (p_file
->file_base
);
328 CloseHandle (p_file
->file_mapping
);
329 CloseHandle (p_file
->file
);
333 /* Routines to manipulate NT executable file sections. */
336 get_bss_info_from_map_file (file_data
*p_infile
, PUCHAR
*p_bss_start
,
340 char map_filename
[MAX_PATH
];
344 /* Overwrite the .exe extension on the executable file name with
345 the .map extension. */
346 strcpy (map_filename
, p_infile
->name
);
347 n
= strlen (map_filename
) - 3;
348 strcpy (&map_filename
[n
], "map");
350 map
= fopen (map_filename
, "r");
353 printf ("Failed to open map file %s, error %d...bailing out.\n",
354 map_filename
, GetLastError ());
358 while (fgets (buffer
, sizeof (buffer
), map
))
360 if (!(strstr (buffer
, ".bss") && strstr (buffer
, "DATA")))
362 n
= sscanf (buffer
, " %*d:%x %x", &start
, &len
);
365 printf ("Failed to scan the .bss section line:\n%s", buffer
);
370 *p_bss_start
= (PUCHAR
) start
;
371 *p_bss_size
= (DWORD
) len
;
375 get_section_size (PIMAGE_SECTION_HEADER p_section
)
377 /* The true section size, before rounding. Some linkers swap the
378 meaning of these two values. */
379 return min (p_section
->SizeOfRawData
,
380 p_section
->Misc
.VirtualSize
);
383 /* Return pointer to section header for named section. */
384 IMAGE_SECTION_HEADER
*
385 find_section (char * name
, IMAGE_NT_HEADERS
* nt_header
)
387 PIMAGE_SECTION_HEADER section
;
390 section
= IMAGE_FIRST_SECTION (nt_header
);
392 for (i
= 0; i
< nt_header
->FileHeader
.NumberOfSections
; i
++)
394 if (strcmp (section
->Name
, name
) == 0)
401 /* Return pointer to section header for section containing the given
402 relative virtual address. */
403 IMAGE_SECTION_HEADER
*
404 rva_to_section (DWORD rva
, IMAGE_NT_HEADERS
* nt_header
)
406 PIMAGE_SECTION_HEADER section
;
409 section
= IMAGE_FIRST_SECTION (nt_header
);
411 for (i
= 0; i
< nt_header
->FileHeader
.NumberOfSections
; i
++)
413 if (rva
>= section
->VirtualAddress
414 && rva
< section
->VirtualAddress
+ section
->SizeOfRawData
)
422 /* Flip through the executable and cache the info necessary for dumping. */
424 get_section_info (file_data
*p_infile
)
426 PIMAGE_DOS_HEADER dos_header
;
427 PIMAGE_NT_HEADERS nt_header
;
428 PIMAGE_SECTION_HEADER section
, data_section
;
432 dos_header
= (PIMAGE_DOS_HEADER
) p_infile
->file_base
;
433 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
435 printf ("Unknown EXE header in %s...bailing.\n", p_infile
->name
);
438 nt_header
= (PIMAGE_NT_HEADERS
) (((unsigned long) dos_header
) +
439 dos_header
->e_lfanew
);
440 if (nt_header
== NULL
)
442 printf ("Failed to find IMAGE_NT_HEADER in %s...bailing.\n",
447 /* Check the NT header signature ... */
448 if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
)
450 printf ("Invalid IMAGE_NT_SIGNATURE 0x%x in %s...bailing.\n",
451 nt_header
->Signature
, p_infile
->name
);
454 /* Flip through the sections for .data and .bss ... */
455 section
= (PIMAGE_SECTION_HEADER
) IMAGE_FIRST_SECTION (nt_header
);
456 for (i
= 0; i
< nt_header
->FileHeader
.NumberOfSections
; i
++)
458 #ifdef SEPARATE_BSS_SECTION
459 if (!strcmp (section
->Name
, ".bss"))
461 /* The .bss section. */
462 ptr
= (char *) nt_header
->OptionalHeader
.ImageBase
+
463 section
->VirtualAddress
;
465 bss_size
= get_section_size (section
);
469 if (!strcmp (section
->Name
, ".data"))
471 /* From lastfile.c */
472 extern char my_edata
[];
474 /* The .data section. */
475 data_section
= section
;
476 ptr
= (char *) nt_header
->OptionalHeader
.ImageBase
+
477 section
->VirtualAddress
;
479 data_start_file
= section
->PointerToRawData
;
481 /* We want to only write Emacs data back to the executable,
482 not any of the library data (if library data is included,
483 then a dumped Emacs won't run on system versions other
484 than the one Emacs was dumped on). */
485 data_size
= my_edata
- data_start_va
;
488 if (!strcmp (section
->Name
, "EMDATA"))
490 /* The Emacs initialized data section. */
491 data_section
= section
;
492 ptr
= (char *) nt_header
->OptionalHeader
.ImageBase
+
493 section
->VirtualAddress
;
495 data_start_file
= section
->PointerToRawData
;
497 /* Write back the full section. */
498 data_size
= get_section_size (section
);
504 #ifdef SEPARATE_BSS_SECTION
505 if (bss_start
== UNINIT_PTR
&& bss_size
== UNINIT_LONG
)
507 /* Starting with MSVC 4.0, the .bss section has been eliminated
508 and appended virtually to the end of the .data section. Our
509 only hint about where the .bss section starts in the address
510 comes from the SizeOfRawData field in the .data section
511 header. Unfortunately, this field is only approximate, as it
512 is a rounded number and is typically rounded just beyond the
513 start of the .bss section. To find the start and size of the
514 .bss section exactly, we have to peek into the map file. */
515 get_bss_info_from_map_file (p_infile
, &ptr
, &bss_size
);
516 bss_start
= ptr
+ nt_header
->OptionalHeader
.ImageBase
517 + data_section
->VirtualAddress
;
520 bss_start
= my_begbss
;
521 bss_size
= my_endbss
- bss_start
;
526 /* The dump routines. */
529 copy_executable_and_dump_data_section (file_data
*p_infile
,
530 file_data
*p_outfile
)
532 unsigned char *data_file
, *data_va
;
533 unsigned long size
, index
;
535 /* Get a pointer to where the raw data should go in the executable file. */
536 data_file
= (char *) p_outfile
->file_base
+ data_start_file
;
538 /* Get a pointer to the raw data in our address space. */
539 data_va
= data_start_va
;
541 size
= (DWORD
) data_file
- (DWORD
) p_outfile
->file_base
;
542 printf ("Copying executable up to data section...\n");
543 printf ("\t0x%08x Offset in input file.\n", 0);
544 printf ("\t0x%08x Offset in output file.\n", 0);
545 printf ("\t0x%08x Size in bytes.\n", size
);
546 memcpy (p_outfile
->file_base
, p_infile
->file_base
, size
);
549 printf ("Dumping .data section...\n");
550 printf ("\t0x%08x Address in process.\n", data_va
);
551 printf ("\t0x%08x Offset in output file.\n",
552 data_file
- p_outfile
->file_base
);
553 printf ("\t0x%08x Size in bytes.\n", size
);
554 memcpy (data_file
, data_va
, size
);
556 index
= (DWORD
) data_file
+ size
- (DWORD
) p_outfile
->file_base
;
557 size
= p_infile
->size
- index
;
558 printf ("Copying rest of executable...\n");
559 printf ("\t0x%08x Offset in input file.\n", index
);
560 printf ("\t0x%08x Offset in output file.\n", index
);
561 printf ("\t0x%08x Size in bytes.\n", size
);
562 memcpy ((char *) p_outfile
->file_base
+ index
,
563 (char *) p_infile
->file_base
+ index
, size
);
567 dump_bss_and_heap (file_data
*p_infile
, file_data
*p_outfile
)
569 unsigned char *heap_data
, *bss_data
;
570 unsigned long size
, index
;
572 printf ("Dumping heap into executable...\n");
574 index
= heap_index_in_executable
;
575 size
= get_committed_heap_size ();
576 heap_data
= get_heap_start ();
578 printf ("\t0x%08x Heap start in process.\n", heap_data
);
579 printf ("\t0x%08x Heap offset in executable.\n", index
);
580 printf ("\t0x%08x Heap size in bytes.\n", size
);
582 memcpy ((PUCHAR
) p_outfile
->file_base
+ index
, heap_data
, size
);
584 printf ("Dumping .bss into executable...\n");
588 bss_data
= bss_start
;
590 printf ("\t0x%08x BSS start in process.\n", bss_data
);
591 printf ("\t0x%08x BSS offset in executable.\n", index
);
592 printf ("\t0x%08x BSS size in bytes.\n", size
);
593 memcpy ((char *) p_outfile
->file_base
+ index
, bss_data
, size
);
597 /* Reload and remap routines. */
600 /* Load the dumped .bss section into the .bss area of our address space. */
602 read_in_bss (char *filename
)
605 unsigned long size
, index
, n_read
, total_read
;
606 char buffer
[512], *bss
;
609 file
= CreateFile (filename
, GENERIC_READ
, FILE_SHARE_READ
, NULL
,
610 OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, 0);
611 if (file
== INVALID_HANDLE_VALUE
)
617 /* Seek to where the .bss section is tucked away after the heap... */
618 index
= heap_index_in_executable
+ get_committed_heap_size ();
619 if (SetFilePointer (file
, index
, NULL
, FILE_BEGIN
) == 0xFFFFFFFF)
626 /* Ok, read in the saved .bss section and initialize all
627 uninitialized variables. */
628 if (!ReadFile (file
, bss_start
, bss_size
, &n_read
, NULL
))
637 /* Map the heap dumped into the executable file into our address space. */
639 map_in_heap (char *filename
)
644 unsigned long size
, upper_size
, n_read
;
647 file
= CreateFile (filename
, GENERIC_READ
, FILE_SHARE_READ
, NULL
,
648 OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, 0);
649 if (file
== INVALID_HANDLE_VALUE
)
655 size
= GetFileSize (file
, &upper_size
);
656 file_mapping
= CreateFileMapping (file
, NULL
, PAGE_WRITECOPY
,
664 size
= get_committed_heap_size ();
665 file_base
= MapViewOfFileEx (file_mapping
, FILE_MAP_COPY
, 0,
666 heap_index_in_executable
, size
,
673 /* If we don't succeed with the mapping, then copy from the
674 data into the heap. */
676 CloseHandle (file_mapping
);
678 if (VirtualAlloc (get_heap_start (), get_committed_heap_size (),
679 MEM_RESERVE
| MEM_COMMIT
, PAGE_READWRITE
) == NULL
)
685 /* Seek to the location of the heap data in the executable. */
686 i
= heap_index_in_executable
;
687 if (SetFilePointer (file
, i
, NULL
, FILE_BEGIN
) == 0xFFFFFFFF)
693 /* Read in the data. */
694 if (!ReadFile (file
, get_heap_start (),
695 get_committed_heap_size (), &n_read
, NULL
))