2 unexec for GNU Emacs on Windows NT.
4 Copyright (C) 1994 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any later
13 GNU Emacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
18 You should have received a copy of the GNU General Public License along
19 with GNU Emacs; see the file COPYING. If not, write to the Free Software
20 Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
22 Geoff Voelker (voelker@cs.washington.edu) 8-12-94
25 #include <stdlib.h> /* _fmode */
30 extern BOOL
ctrl_c_handler (unsigned long type
);
34 /* A convenient type for keeping all the info about a mapped file together. */
35 typedef struct file_data
{
40 unsigned char *file_base
;
43 /* Basically, our "initialized" flag. */
44 BOOL need_to_recreate_heap
= FALSE
;
46 /* So we can find our heap in the file to recreate it. */
47 unsigned long heap_index_in_executable
= 0;
49 void open_input_file (file_data
*p_file
, char *name
);
50 void open_output_file (file_data
*p_file
, char *name
, unsigned long size
);
51 void close_file_data (file_data
*p_file
);
53 void get_section_info (file_data
*p_file
);
54 void copy_executable_and_dump_data_section (file_data
*, file_data
*);
55 void dump_bss_and_heap (file_data
*p_infile
, file_data
*p_outfile
);
57 /* Cached info about the .data section in the executable. */
58 PUCHAR data_start_va
= 0;
59 DWORD data_start_file
= 0;
62 /* Cached info about the .bss section in the executable. */
67 HINSTANCE hinst
= NULL
;
68 HINSTANCE hprevinst
= NULL
;
73 WinMain (_hinst
, _hPrevInst
, _lpCmdLine
, _nCmdShow
)
79 /* Need to parse command line */
82 hprevinst
= _hPrevInst
;
83 lpCmdLine
= _lpCmdLine
;
86 return (main (__argc
,__argv
,_environ
));
88 #endif /* HAVE_NTGUI */
90 /* Startup code for running on NT. When we are running as the dumped
91 version, we need to bootstrap our heap and .bss section into our
92 address space before we can actually hand off control to the startup
93 code supplied by NT (primarily because that code relies upon malloc ()). */
98 extern void WinMainCRTStartup (void);
100 extern void mainCRTStartup (void);
101 #endif /* HAVE_NTGUI */
103 /* Cache system info, e.g., the NT page size. */
104 cache_system_info ();
106 /* If we're a dumped version of emacs then we need to recreate
107 our heap and play tricks with our .bss section. Do this before
108 start up. (WARNING: Do not put any code before this section
109 that relies upon malloc () and runs in the dumped version. It
111 if (need_to_recreate_heap
)
113 char executable_path
[MAX_PATH
];
115 if (GetModuleFileName (NULL
, executable_path
, MAX_PATH
) == 0)
117 printf ("Failed to find path for executable.\n");
120 recreate_heap (executable_path
);
121 need_to_recreate_heap
= FALSE
;
124 /* The default behavior is to treat files as binary and patch up
125 text files appropriately, in accordance with the MSDOS code. */
128 /* This prevents ctrl-c's in shells running while we're suspended from
130 SetConsoleCtrlHandler ((PHANDLER_ROUTINE
) ctrl_c_handler
, TRUE
);
132 /* Invoke the NT CRT startup routine now that our housecleaning
135 WinMainCRTStartup ();
138 #endif /* HAVE_NTGUI */
141 /* Dump out .data and .bss sections into a new exectubale. */
143 unexec (char *new_name
, char *old_name
, void *start_data
, void *start_bss
,
146 file_data in_file
, out_file
;
147 char out_filename
[MAX_PATH
], in_filename
[MAX_PATH
];
151 /* Make sure that the input and output filenames have the
152 ".exe" extension...patch them up if they don't. */
153 strcpy (in_filename
, old_name
);
154 ptr
= in_filename
+ strlen (in_filename
) - 4;
155 if (strcmp (ptr
, ".exe"))
156 strcat (in_filename
, ".exe");
158 strcpy (out_filename
, new_name
);
159 ptr
= out_filename
+ strlen (out_filename
) - 4;
160 if (strcmp (ptr
, ".exe"))
161 strcat (out_filename
, ".exe");
163 printf ("Dumping from %s\n", in_filename
);
164 printf (" to %s\n", out_filename
);
166 /* We need to round off our heap to NT's allocation unit (64KB). */
167 round_heap (get_allocation_unit ());
169 /* Open the undumped executable file. */
170 open_input_file (&in_file
, in_filename
);
172 /* Get the interesting section info, like start and size of .bss... */
173 get_section_info (&in_file
);
175 /* The size of the dumped executable is the size of the original
176 executable plus the size of the heap and the size of the .bss section. */
177 heap_index_in_executable
= (unsigned long)
178 round_to_next ((unsigned char *) in_file
.size
, get_allocation_unit ());
179 size
= heap_index_in_executable
+ get_committed_heap_size () + bss_size
;
180 open_output_file (&out_file
, out_filename
, size
);
182 /* Set the flag (before dumping). */
183 need_to_recreate_heap
= TRUE
;
185 copy_executable_and_dump_data_section (&in_file
, &out_file
);
186 dump_bss_and_heap (&in_file
, &out_file
);
188 close_file_data (&in_file
);
189 close_file_data (&out_file
);
197 open_input_file (file_data
*p_file
, char *filename
)
202 unsigned long size
, upper_size
;
204 file
= CreateFile (filename
, GENERIC_READ
, FILE_SHARE_READ
, NULL
,
205 OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, 0);
206 if (file
== INVALID_HANDLE_VALUE
)
208 printf ("Failed to open %s (%d)...bailing.\n",
209 filename
, GetLastError ());
213 size
= GetFileSize (file
, &upper_size
);
214 file_mapping
= CreateFileMapping (file
, NULL
, PAGE_READONLY
,
218 printf ("Failed to create file mapping of %s (%d)...bailing.\n",
219 filename
, GetLastError ());
223 file_base
= MapViewOfFile (file_mapping
, FILE_MAP_READ
, 0, 0, size
);
226 printf ("Failed to map view of file of %s (%d)...bailing.\n",
227 filename
, GetLastError ());
231 p_file
->name
= filename
;
234 p_file
->file_mapping
= file_mapping
;
235 p_file
->file_base
= file_base
;
239 open_output_file (file_data
*p_file
, char *filename
, unsigned long size
)
246 file
= CreateFile (filename
, GENERIC_READ
| GENERIC_WRITE
, 0, NULL
,
247 CREATE_ALWAYS
, FILE_ATTRIBUTE_NORMAL
, 0);
248 if (file
== INVALID_HANDLE_VALUE
)
251 printf ("open_output_file: Failed to open %s (%d).\n",
256 file_mapping
= CreateFileMapping (file
, NULL
, PAGE_READWRITE
,
261 printf ("open_output_file: Failed to create file mapping of %s (%d).\n",
266 file_base
= MapViewOfFile (file_mapping
, FILE_MAP_WRITE
, 0, 0, size
);
270 printf ("open_output_file: Failed to map view of file of %s (%d).\n",
275 p_file
->name
= filename
;
278 p_file
->file_mapping
= file_mapping
;
279 p_file
->file_base
= file_base
;
282 /* Close the system structures associated with the given file. */
284 close_file_data (file_data
*p_file
)
286 UnmapViewOfFile (p_file
->file_base
);
287 CloseHandle (p_file
->file_mapping
);
288 CloseHandle (p_file
->file
);
292 /* Routines to manipulate NT executable file sections. */
295 get_bss_info_from_map_file (file_data
*p_infile
, PUCHAR
*p_bss_start
,
299 char map_filename
[MAX_PATH
];
303 /* Overwrite the .exe extension on the executable file name with
304 the .map extension. */
305 strcpy (map_filename
, p_infile
->name
);
306 n
= strlen (map_filename
) - 3;
307 strcpy (&map_filename
[n
], "map");
309 map
= fopen (map_filename
, "r");
312 printf ("Failed to open map file %s, error %d...bailing out.\n",
313 map_filename
, GetLastError ());
317 while (fgets (buffer
, sizeof (buffer
), map
))
319 if (!(strstr (buffer
, ".bss") && strstr (buffer
, "DATA")))
321 n
= sscanf (buffer
, " %*d:%x %x", &start
, &len
);
324 printf ("Failed to scan the .bss section line:\n%s", buffer
);
329 *p_bss_start
= (PUCHAR
) start
;
330 *p_bss_size
= (DWORD
) len
;
334 get_section_size (PIMAGE_SECTION_HEADER p_section
)
336 /* The section size is in different locations in the different versions. */
337 switch (get_nt_minor_version ())
340 return p_section
->SizeOfRawData
;
342 return p_section
->Misc
.VirtualSize
;
346 /* Flip through the executable and cache the info necessary for dumping. */
348 get_section_info (file_data
*p_infile
)
350 PIMAGE_DOS_HEADER dos_header
;
351 PIMAGE_NT_HEADERS nt_header
;
352 PIMAGE_SECTION_HEADER section
, data_section
;
356 dos_header
= (PIMAGE_DOS_HEADER
) p_infile
->file_base
;
357 if (dos_header
->e_magic
!= IMAGE_DOS_SIGNATURE
)
359 printf ("Unknown EXE header in %s...bailing.\n", p_infile
->name
);
362 nt_header
= (PIMAGE_NT_HEADERS
) (((unsigned long) dos_header
) +
363 dos_header
->e_lfanew
);
364 if (nt_header
== NULL
)
366 printf ("Failed to find IMAGE_NT_HEADER in %s...bailing.\n",
371 /* Check the NT header signature ... */
372 if (nt_header
->Signature
!= IMAGE_NT_SIGNATURE
)
374 printf ("Invalid IMAGE_NT_SIGNATURE 0x%x in %s...bailing.\n",
375 nt_header
->Signature
, p_infile
->name
);
378 /* Flip through the sections for .data and .bss ... */
379 section
= (PIMAGE_SECTION_HEADER
) IMAGE_FIRST_SECTION (nt_header
);
380 for (i
= 0; i
< nt_header
->FileHeader
.NumberOfSections
; i
++)
382 if (!strcmp (section
->Name
, ".bss"))
384 /* The .bss section. */
385 ptr
= (char *) nt_header
->OptionalHeader
.ImageBase
+
386 section
->VirtualAddress
;
388 bss_size
= get_section_size (section
);
390 if (!strcmp (section
->Name
, ".data"))
392 /* From lastfile.c */
393 extern char my_edata
[];
395 /* The .data section. */
396 data_section
= section
;
397 ptr
= (char *) nt_header
->OptionalHeader
.ImageBase
+
398 section
->VirtualAddress
;
400 data_start_file
= section
->PointerToRawData
;
402 /* We want to only write Emacs data back to the executable,
403 not any of the library data (if library data is included,
404 then a dumped Emacs won't run on system versions other
405 than the one Emacs was dumped on). */
406 data_size
= my_edata
- data_start_va
;
411 if (!bss_start
&& !bss_size
)
413 /* Starting with MSVC 4.0, the .bss section has been eliminated
414 and appended virtually to the end of the .data section. Our
415 only hint about where the .bss section starts in the address
416 comes from the SizeOfRawData field in the .data section
417 header. Unfortunately, this field is only approximate, as it
418 is a rounded number and is typically rounded just beyond the
419 start of the .bss section. To find the start and size of the
420 .bss section exactly, we have to peek into the map file. */
421 get_bss_info_from_map_file (p_infile
, &ptr
, &bss_size
);
422 bss_start
= ptr
+ nt_header
->OptionalHeader
.ImageBase
423 + data_section
->VirtualAddress
;
428 /* The dump routines. */
431 copy_executable_and_dump_data_section (file_data
*p_infile
,
432 file_data
*p_outfile
)
434 unsigned char *data_file
, *data_va
;
435 unsigned long size
, index
;
437 /* Get a pointer to where the raw data should go in the executable file. */
438 data_file
= (char *) p_outfile
->file_base
+ data_start_file
;
440 /* Get a pointer to the raw data in our address space. */
441 data_va
= data_start_va
;
443 size
= (DWORD
) data_file
- (DWORD
) p_outfile
->file_base
;
444 printf ("Copying executable up to data section...\n");
445 printf ("\t0x%08x Offset in input file.\n", 0);
446 printf ("\t0x%08x Offset in output file.\n", 0);
447 printf ("\t0x%08x Size in bytes.\n", size
);
448 memcpy (p_outfile
->file_base
, p_infile
->file_base
, size
);
451 printf ("Dumping .data section...\n");
452 printf ("\t0x%08x Address in process.\n", data_va
);
453 printf ("\t0x%08x Offset in output file.\n",
454 data_file
- p_outfile
->file_base
);
455 printf ("\t0x%08x Size in bytes.\n", size
);
456 memcpy (data_file
, data_va
, size
);
458 index
= (DWORD
) data_file
+ size
- (DWORD
) p_outfile
->file_base
;
459 size
= p_infile
->size
- index
;
460 printf ("Copying rest of executable...\n");
461 printf ("\t0x%08x Offset in input file.\n", index
);
462 printf ("\t0x%08x Offset in output file.\n", index
);
463 printf ("\t0x%08x Size in bytes.\n", size
);
464 memcpy ((char *) p_outfile
->file_base
+ index
,
465 (char *) p_infile
->file_base
+ index
, size
);
469 dump_bss_and_heap (file_data
*p_infile
, file_data
*p_outfile
)
471 unsigned char *heap_data
, *bss_data
;
472 unsigned long size
, index
;
474 printf ("Dumping heap into executable...\n");
476 index
= heap_index_in_executable
;
477 size
= get_committed_heap_size ();
478 heap_data
= get_heap_start ();
480 printf ("\t0x%08x Heap start in process.\n", heap_data
);
481 printf ("\t0x%08x Heap offset in executable.\n", index
);
482 printf ("\t0x%08x Heap size in bytes.\n", size
);
484 memcpy ((PUCHAR
) p_outfile
->file_base
+ index
, heap_data
, size
);
486 printf ("Dumping .bss into executable...\n");
490 bss_data
= bss_start
;
492 printf ("\t0x%08x BSS start in process.\n", bss_data
);
493 printf ("\t0x%08x BSS offset in executable.\n", index
);
494 printf ("\t0x%08x BSS size in bytes.\n", size
);
495 memcpy ((char *) p_outfile
->file_base
+ index
, bss_data
, size
);
499 /* Reload and remap routines. */
502 /* Load the dumped .bss section into the .bss area of our address space. */
504 read_in_bss (char *filename
)
507 unsigned long size
, index
, n_read
, total_read
;
508 char buffer
[512], *bss
;
511 file
= CreateFile (filename
, GENERIC_READ
, FILE_SHARE_READ
, NULL
,
512 OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, 0);
513 if (file
== INVALID_HANDLE_VALUE
)
519 /* Seek to where the .bss section is tucked away after the heap... */
520 index
= heap_index_in_executable
+ get_committed_heap_size ();
521 if (SetFilePointer (file
, index
, NULL
, FILE_BEGIN
) == 0xFFFFFFFF)
528 /* Ok, read in the saved .bss section and initialize all
529 uninitialized variables. */
530 if (!ReadFile (file
, bss_start
, bss_size
, &n_read
, NULL
))
539 /* Map the heap dumped into the executable file into our address space. */
541 map_in_heap (char *filename
)
546 unsigned long size
, upper_size
, n_read
;
549 file
= CreateFile (filename
, GENERIC_READ
, FILE_SHARE_READ
, NULL
,
550 OPEN_EXISTING
, FILE_ATTRIBUTE_NORMAL
, 0);
551 if (file
== INVALID_HANDLE_VALUE
)
557 size
= GetFileSize (file
, &upper_size
);
558 file_mapping
= CreateFileMapping (file
, NULL
, PAGE_WRITECOPY
,
566 size
= get_committed_heap_size ();
567 file_base
= MapViewOfFileEx (file_mapping
, FILE_MAP_COPY
, 0,
568 heap_index_in_executable
, size
,
575 /* If we don't succeed with the mapping, then copy from the
576 data into the heap. */
578 CloseHandle (file_mapping
);
580 if (VirtualAlloc (get_heap_start (), get_committed_heap_size (),
581 MEM_RESERVE
| MEM_COMMIT
, PAGE_READWRITE
) == NULL
)
587 /* Seek to the location of the heap data in the executable. */
588 i
= heap_index_in_executable
;
589 if (SetFilePointer (file
, i
, NULL
, FILE_BEGIN
) == 0xFFFFFFFF)
595 /* Read in the data. */
596 if (!ReadFile (file
, get_heap_start (),
597 get_committed_heap_size (), &n_read
, NULL
))