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
[];
50 /* Basically, our "initialized" flag. */
51 BOOL need_to_recreate_heap
= FALSE
;
53 /* So we can find our heap in the file to recreate it. */
54 unsigned long heap_index_in_executable
= 0;
56 int open_input_file (file_data
*p_file
, char *name
);
57 int open_output_file (file_data
*p_file
, char *name
, unsigned long size
);
58 void close_file_data (file_data
*p_file
);
60 void get_section_info (file_data
*p_file
);
61 void copy_executable_and_dump_data_section (file_data
*, file_data
*);
62 void dump_bss_and_heap (file_data
*p_infile
, file_data
*p_outfile
);
64 /* Cached info about the .data section in the executable. */
65 PUCHAR data_start_va
= 0;
66 DWORD data_start_file
= 0;
69 /* Cached info about the .bss section in the executable. */
74 HINSTANCE hinst
= NULL
;
75 HINSTANCE hprevinst
= NULL
;
78 #endif /* HAVE_NTGUI */
80 /* Startup code for running on NT. When we are running as the dumped
81 version, we need to bootstrap our heap and .bss section into our
82 address space before we can actually hand off control to the startup
83 code supplied by NT (primarily because that code relies upon malloc ()). */
87 extern void mainCRTStartup (void);
90 /* Give us a way to debug problems with crashes on startup when
91 running under the MSVC profiler. */
92 if (GetEnvironmentVariable ("EMACS_DEBUG", NULL
, 0) > 0)
96 /* Cache system info, e.g., the NT page size. */
99 /* If we're a dumped version of emacs then we need to recreate
100 our heap and play tricks with our .bss section. Do this before
101 start up. (WARNING: Do not put any code before this section
102 that relies upon malloc () and runs in the dumped version. It
104 if (need_to_recreate_heap
)
106 char executable_path
[MAX_PATH
];
108 if (GetModuleFileName (NULL
, executable_path
, MAX_PATH
) == 0)
110 printf ("Failed to find path for executable.\n");
115 /* To allow profiling, make sure executable_path names the .exe
116 file, not the ._xe file created by the profiler which contains
117 extra code that makes the stored exe offsets incorrect. (This
118 will not be necessary when unexec properly extends the .bss (or
119 .data as appropriate) section to include the dumped bss data,
120 and dumps the heap into a proper section of its own.) */
122 char * p
= strrchr (executable_path
, '.');
123 if (p
&& p
[1] == '_')
127 /* Using HiProf profiler, exe name is different still. */
129 char * p
= strrchr (executable_path
, '\\');
130 strcpy (p
, "\\emacs.exe");
134 recreate_heap (executable_path
);
135 need_to_recreate_heap
= FALSE
;
139 /* Grab our malloc arena space now, before CRT starts up. */
143 /* The default behavior is to treat files as binary and patch up
144 text files appropriately, in accordance with the MSDOS code. */
147 /* This prevents ctrl-c's in shells running while we're suspended from
149 SetConsoleCtrlHandler ((PHANDLER_ROUTINE
) ctrl_c_handler
, TRUE
);
151 /* Invoke the NT CRT startup routine now that our housecleaning
154 /* determine WinMain args like crt0.c does */
155 hinst
= GetModuleHandle(NULL
);
156 lpCmdLine
= GetCommandLine();
157 nCmdShow
= SW_SHOWDEFAULT
;
162 /* Dump out .data and .bss sections into a new executable. */
164 unexec (char *new_name
, char *old_name
, void *start_data
, void *start_bss
,
167 file_data in_file
, out_file
;
168 char out_filename
[MAX_PATH
], in_filename
[MAX_PATH
];
172 /* Make sure that the input and output filenames have the
173 ".exe" extension...patch them up if they don't. */
174 strcpy (in_filename
, old_name
);
175 ptr
= in_filename
+ strlen (in_filename
) - 4;
176 if (strcmp (ptr
, ".exe"))
177 strcat (in_filename
, ".exe");
179 strcpy (out_filename
, new_name
);
180 ptr
= out_filename
+ strlen (out_filename
) - 4;
181 if (strcmp (ptr
, ".exe"))
182 strcat (out_filename
, ".exe");
184 printf ("Dumping from %s\n", in_filename
);
185 printf (" to %s\n", out_filename
);
187 /* We need to round off our heap to NT's allocation unit (64KB). */
188 round_heap (get_allocation_unit ());
190 /* Open the undumped executable file. */
191 if (!open_input_file (&in_file
, in_filename
))
193 printf ("Failed to open %s (%d)...bailing.\n",
194 in_filename
, GetLastError ());
198 /* Get the interesting section info, like start and size of .bss... */
199 get_section_info (&in_file
);
201 /* The size of the dumped executable is the size of the original
202 executable plus the size of the heap and the size of the .bss section. */
203 heap_index_in_executable
= (unsigned long)
204 round_to_next ((unsigned char *) in_file
.size
, get_allocation_unit ());
205 size
= heap_index_in_executable
+ get_committed_heap_size () + bss_size
;
206 if (!open_output_file (&out_file
, out_filename
, size
))
208 printf ("Failed to open %s (%d)...bailing.\n",
209 out_filename
, GetLastError ());
213 /* Set the flag (before dumping). */
214 need_to_recreate_heap
= TRUE
;
216 copy_executable_and_dump_data_section (&in_file
, &out_file
);
217 dump_bss_and_heap (&in_file
, &out_file
);
219 /* Patch up header fields; profiler is picky about this. */
221 PIMAGE_DOS_HEADER dos_header
;
222 PIMAGE_NT_HEADERS nt_header
;
223 HANDLE hImagehelp
= LoadLibrary ("imagehlp.dll");
227 dos_header
= (PIMAGE_DOS_HEADER
) out_file
.file_base
;
228 nt_header
= (PIMAGE_NT_HEADERS
) ((char *) dos_header
+ dos_header
->e_lfanew
);
230 nt_header
->OptionalHeader
.CheckSum
= 0;
231 // nt_header->FileHeader.TimeDateStamp = time (NULL);
232 // dos_header->e_cp = size / 512;
233 // nt_header->OptionalHeader.SizeOfImage = size;
235 pfnCheckSumMappedFile
= (void *) GetProcAddress (hImagehelp
, "CheckSumMappedFile");
236 if (pfnCheckSumMappedFile
)
238 // nt_header->FileHeader.TimeDateStamp = time (NULL);
239 pfnCheckSumMappedFile (out_file
.file_base
,
243 nt_header
->OptionalHeader
.CheckSum
= checksum
;
245 FreeLibrary (hImagehelp
);
248 close_file_data (&in_file
);
249 close_file_data (&out_file
);
257 open_input_file (file_data
*p_file
, char *filename
)
262 unsigned long size
, upper_size
;
264 file
= CreateFile (filename
, GENERIC_READ
, FILE_SHARE_READ
, NULL
,
265 OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, 0);
266 if (file
== INVALID_HANDLE_VALUE
)
269 size
= GetFileSize (file
, &upper_size
);
270 file_mapping
= CreateFileMapping (file
, NULL
, PAGE_READONLY
,
275 file_base
= MapViewOfFile (file_mapping
, FILE_MAP_READ
, 0, 0, size
);
279 p_file
->name
= filename
;
282 p_file
->file_mapping
= file_mapping
;
283 p_file
->file_base
= file_base
;
289 open_output_file (file_data
*p_file
, char *filename
, unsigned long size
)
295 file
= CreateFile (filename
, GENERIC_READ
| GENERIC_WRITE
, 0, NULL
,
296 CREATE_ALWAYS
, FILE_ATTRIBUTE_NORMAL
, 0);
297 if (file
== INVALID_HANDLE_VALUE
)
300 file_mapping
= CreateFileMapping (file
, NULL
, PAGE_READWRITE
,
305 file_base
= MapViewOfFile (file_mapping
, FILE_MAP_WRITE
, 0, 0, size
);
309 p_file
->name
= filename
;
312 p_file
->file_mapping
= file_mapping
;
313 p_file
->file_base
= file_base
;
318 /* Close the system structures associated with the given file. */
320 close_file_data (file_data
*p_file
)
322 UnmapViewOfFile (p_file
->file_base
);
323 CloseHandle (p_file
->file_mapping
);
324 CloseHandle (p_file
->file
);
328 /* Routines to manipulate NT executable file sections. */
331 get_bss_info_from_map_file (file_data
*p_infile
, PUCHAR
*p_bss_start
,
335 char map_filename
[MAX_PATH
];
339 /* Overwrite the .exe extension on the executable file name with
340 the .map extension. */
341 strcpy (map_filename
, p_infile
->name
);
342 n
= strlen (map_filename
) - 3;
343 strcpy (&map_filename
[n
], "map");
345 map
= fopen (map_filename
, "r");
348 printf ("Failed to open map file %s, error %d...bailing out.\n",
349 map_filename
, GetLastError ());
353 while (fgets (buffer
, sizeof (buffer
), map
))
355 if (!(strstr (buffer
, ".bss") && strstr (buffer
, "DATA")))
357 n
= sscanf (buffer
, " %*d:%x %x", &start
, &len
);
360 printf ("Failed to scan the .bss section line:\n%s", buffer
);
365 *p_bss_start
= (PUCHAR
) start
;
366 *p_bss_size
= (DWORD
) len
;
370 get_section_size (PIMAGE_SECTION_HEADER p_section
)
372 /* The true section size, before rounding. Some linkers swap the
373 meaning of these two values. */
374 return min (p_section
->SizeOfRawData
,
375 p_section
->Misc
.VirtualSize
);
378 /* Return pointer to section header for named section. */
379 IMAGE_SECTION_HEADER
*
380 find_section (char * name
, IMAGE_NT_HEADERS
* nt_header
)
382 PIMAGE_SECTION_HEADER section
;
385 section
= IMAGE_FIRST_SECTION (nt_header
);
387 for (i
= 0; i
< nt_header
->FileHeader
.NumberOfSections
; i
++)
389 if (strcmp (section
->Name
, name
) == 0)
396 /* Return pointer to section header for section containing the given
397 relative virtual address. */
398 IMAGE_SECTION_HEADER
*
399 rva_to_section (DWORD rva
, IMAGE_NT_HEADERS
* nt_header
)
401 PIMAGE_SECTION_HEADER section
;
404 section
= IMAGE_FIRST_SECTION (nt_header
);
406 for (i
= 0; i
< nt_header
->FileHeader
.NumberOfSections
; i
++)
408 if (rva
>= section
->VirtualAddress
409 && rva
< section
->VirtualAddress
+ section
->SizeOfRawData
)
417 /* Flip through the executable and cache the info necessary for dumping. */
419 get_section_info (file_data
*p_infile
)
421 PIMAGE_DOS_HEADER dos_header
;
422 PIMAGE_NT_HEADERS nt_header
;
423 PIMAGE_SECTION_HEADER section
, data_section
;
427 dos_header
= (PIMAGE_DOS_HEADER
) p_infile
->file_base
;
428 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
430 printf ("Unknown EXE header in %s...bailing.\n", p_infile
->name
);
433 nt_header
= (PIMAGE_NT_HEADERS
) (((unsigned long) dos_header
) +
434 dos_header
->e_lfanew
);
435 if (nt_header
== NULL
)
437 printf ("Failed to find IMAGE_NT_HEADER in %s...bailing.\n",
442 /* Check the NT header signature ... */
443 if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
)
445 printf ("Invalid IMAGE_NT_SIGNATURE 0x%x in %s...bailing.\n",
446 nt_header
->Signature
, p_infile
->name
);
449 /* Flip through the sections for .data and .bss ... */
450 section
= (PIMAGE_SECTION_HEADER
) IMAGE_FIRST_SECTION (nt_header
);
451 for (i
= 0; i
< nt_header
->FileHeader
.NumberOfSections
; i
++)
453 #ifdef SEPARATE_BSS_SECTION
454 if (!strcmp (section
->Name
, ".bss"))
456 /* The .bss section. */
457 ptr
= (char *) nt_header
->OptionalHeader
.ImageBase
+
458 section
->VirtualAddress
;
460 bss_size
= get_section_size (section
);
464 if (!strcmp (section
->Name
, ".data"))
466 /* From lastfile.c */
467 extern char my_edata
[];
469 /* The .data section. */
470 data_section
= section
;
471 ptr
= (char *) nt_header
->OptionalHeader
.ImageBase
+
472 section
->VirtualAddress
;
474 data_start_file
= section
->PointerToRawData
;
476 /* We want to only write Emacs data back to the executable,
477 not any of the library data (if library data is included,
478 then a dumped Emacs won't run on system versions other
479 than the one Emacs was dumped on). */
480 data_size
= my_edata
- data_start_va
;
483 if (!strcmp (section
->Name
, "EMDATA"))
485 /* The Emacs initialized data section. */
486 data_section
= section
;
487 ptr
= (char *) nt_header
->OptionalHeader
.ImageBase
+
488 section
->VirtualAddress
;
490 data_start_file
= section
->PointerToRawData
;
492 /* Write back the full section. */
493 data_size
= get_section_size (section
);
499 #ifdef SEPARATE_BSS_SECTION
500 if (bss_start
== UNINIT_PTR
&& bss_size
== UNINIT_LONG
)
502 /* Starting with MSVC 4.0, the .bss section has been eliminated
503 and appended virtually to the end of the .data section. Our
504 only hint about where the .bss section starts in the address
505 comes from the SizeOfRawData field in the .data section
506 header. Unfortunately, this field is only approximate, as it
507 is a rounded number and is typically rounded just beyond the
508 start of the .bss section. To find the start and size of the
509 .bss section exactly, we have to peek into the map file. */
510 get_bss_info_from_map_file (p_infile
, &ptr
, &bss_size
);
511 bss_start
= ptr
+ nt_header
->OptionalHeader
.ImageBase
512 + data_section
->VirtualAddress
;
515 bss_start
= my_begbss
;
516 bss_size
= my_endbss
- bss_start
;
521 /* The dump routines. */
524 copy_executable_and_dump_data_section (file_data
*p_infile
,
525 file_data
*p_outfile
)
527 unsigned char *data_file
, *data_va
;
528 unsigned long size
, index
;
530 /* Get a pointer to where the raw data should go in the executable file. */
531 data_file
= (char *) p_outfile
->file_base
+ data_start_file
;
533 /* Get a pointer to the raw data in our address space. */
534 data_va
= data_start_va
;
536 size
= (DWORD
) data_file
- (DWORD
) p_outfile
->file_base
;
537 printf ("Copying executable up to data section...\n");
538 printf ("\t0x%08x Offset in input file.\n", 0);
539 printf ("\t0x%08x Offset in output file.\n", 0);
540 printf ("\t0x%08x Size in bytes.\n", size
);
541 memcpy (p_outfile
->file_base
, p_infile
->file_base
, size
);
544 printf ("Dumping .data section...\n");
545 printf ("\t0x%08x Address in process.\n", data_va
);
546 printf ("\t0x%08x Offset in output file.\n",
547 data_file
- p_outfile
->file_base
);
548 printf ("\t0x%08x Size in bytes.\n", size
);
549 memcpy (data_file
, data_va
, size
);
551 index
= (DWORD
) data_file
+ size
- (DWORD
) p_outfile
->file_base
;
552 size
= p_infile
->size
- index
;
553 printf ("Copying rest of executable...\n");
554 printf ("\t0x%08x Offset in input file.\n", index
);
555 printf ("\t0x%08x Offset in output file.\n", index
);
556 printf ("\t0x%08x Size in bytes.\n", size
);
557 memcpy ((char *) p_outfile
->file_base
+ index
,
558 (char *) p_infile
->file_base
+ index
, size
);
562 dump_bss_and_heap (file_data
*p_infile
, file_data
*p_outfile
)
564 unsigned char *heap_data
, *bss_data
;
565 unsigned long size
, index
;
567 printf ("Dumping heap into executable...\n");
569 index
= heap_index_in_executable
;
570 size
= get_committed_heap_size ();
571 heap_data
= get_heap_start ();
573 printf ("\t0x%08x Heap start in process.\n", heap_data
);
574 printf ("\t0x%08x Heap offset in executable.\n", index
);
575 printf ("\t0x%08x Heap size in bytes.\n", size
);
577 memcpy ((PUCHAR
) p_outfile
->file_base
+ index
, heap_data
, size
);
579 printf ("Dumping .bss into executable...\n");
583 bss_data
= bss_start
;
585 printf ("\t0x%08x BSS start in process.\n", bss_data
);
586 printf ("\t0x%08x BSS offset in executable.\n", index
);
587 printf ("\t0x%08x BSS size in bytes.\n", size
);
588 memcpy ((char *) p_outfile
->file_base
+ index
, bss_data
, size
);
592 /* Reload and remap routines. */
595 /* Load the dumped .bss section into the .bss area of our address space. */
597 read_in_bss (char *filename
)
600 unsigned long size
, index
, n_read
, total_read
;
601 char buffer
[512], *bss
;
604 file
= CreateFile (filename
, GENERIC_READ
, FILE_SHARE_READ
, NULL
,
605 OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, 0);
606 if (file
== INVALID_HANDLE_VALUE
)
612 /* Seek to where the .bss section is tucked away after the heap... */
613 index
= heap_index_in_executable
+ get_committed_heap_size ();
614 if (SetFilePointer (file
, index
, NULL
, FILE_BEGIN
) == 0xFFFFFFFF)
621 /* Ok, read in the saved .bss section and initialize all
622 uninitialized variables. */
623 if (!ReadFile (file
, bss_start
, bss_size
, &n_read
, NULL
))
632 /* Map the heap dumped into the executable file into our address space. */
634 map_in_heap (char *filename
)
639 unsigned long size
, upper_size
, n_read
;
642 file
= CreateFile (filename
, GENERIC_READ
, FILE_SHARE_READ
, NULL
,
643 OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, 0);
644 if (file
== INVALID_HANDLE_VALUE
)
650 size
= GetFileSize (file
, &upper_size
);
651 file_mapping
= CreateFileMapping (file
, NULL
, PAGE_WRITECOPY
,
659 size
= get_committed_heap_size ();
660 file_base
= MapViewOfFileEx (file_mapping
, FILE_MAP_COPY
, 0,
661 heap_index_in_executable
, size
,
668 /* If we don't succeed with the mapping, then copy from the
669 data into the heap. */
671 CloseHandle (file_mapping
);
673 if (VirtualAlloc (get_heap_start (), get_committed_heap_size (),
674 MEM_RESERVE
| MEM_COMMIT
, PAGE_READWRITE
) == NULL
)
680 /* Seek to the location of the heap data in the executable. */
681 i
= heap_index_in_executable
;
682 if (SetFilePointer (file
, i
, NULL
, FILE_BEGIN
) == 0xFFFFFFFF)
688 /* Read in the data. */
689 if (!ReadFile (file
, get_heap_start (),
690 get_committed_heap_size (), &n_read
, NULL
))