(o-UU+4EDE): Use U+4EBB instead of <CJK RADICAL PERSON> in
[chise/xemacs-chise.git.1] / src / unexaix.c
1 /* Dump an executable image.
2    Copyright (C) 1985, 1986, 1987, 1988 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
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.  */
20
21 /* Synched up with: FSF 20.2. */
22
23 /* Originally based on the COFF unexec.c by Spencer W. Thomas.
24  *
25  * Subsequently hacked on by
26  * Bill Mann <Bill_Man@praxisint.com>
27  * Andrew Vignaux <Andrew.Vignaux@comp.vuw.ac.nz>
28  * Mike Sperber <sperber@informatik.uni-tuebingen.de>
29  *
30  * Synopsis:
31  *      unexec (new_name, a_name, data_start, bss_start, entry_address)
32  *      char *new_name, *a_name;
33  *      unsigned data_start, bss_start, entry_address;
34  *
35  * Takes a snapshot of the program and makes an a.out format file in the
36  * file named by the string argument new_name.
37  * If a_name is non-NULL, the symbol table will be taken from the given file.
38  * On some machines, an existing a_name file is required.
39  *
40  * data_start and entry_address are ignored.
41  *
42  * bss_start indicates how much of the data segment is to be saved in the
43  * a.out file and restored when the program is executed.  It gives the lowest
44  * unsaved address, and is rounded up to a page boundary.  The default when 0
45  * is given assumes that the entire data segment is to be stored, including
46  * the previous data and bss as well as any additional storage allocated with
47  * sbrk(2).
48  *
49  */
50
51 #ifndef emacs
52 #define PERROR(arg) perror (arg); return -1
53 #else
54 #include <config.h>
55 #define PERROR(file) report_error (file, new)
56 #endif
57
58 #include <a.out.h>
59 /* Define getpagesize () if the system does not.
60    Note that this may depend on symbols defined in a.out.h
61  */
62 #include "getpagesize.h"
63
64 #include <sys/types.h>
65 #include <stdio.h>
66 #include <sys/stat.h>
67 #include <errno.h>
68 #include <unistd.h>
69 #include <fcntl.h>
70
71 extern char *start_of_text (void);              /* Start of text */
72 extern char *start_of_data (void);              /* Start of initialized data */
73
74 extern int _data;
75 extern int _text;
76
77 #include <filehdr.h>
78 #include <aouthdr.h>
79 #include <scnhdr.h>
80 #include <syms.h>
81
82 static struct filehdr f_hdr;            /* File header */
83 static struct aouthdr f_ohdr;           /* Optional file header (a.out) */
84 static long bias;                       /* Bias to add for growth */
85 static long lnnoptr;                    /* Pointer to line-number info within file */
86
87 static long text_scnptr;
88 static long data_scnptr;
89 #define ALIGN(val, pwr) (((val) + ((1L<<(pwr))-1)) & ~((1L<<(pwr))-1))
90 static long load_scnptr;
91 static long orig_load_scnptr;
92 static long orig_data_scnptr;
93 static int unrelocate_symbols (int, int, char *, char *);
94
95 #ifndef MAX_SECTIONS
96 #define MAX_SECTIONS    10
97 #endif
98
99 static int adjust_lnnoptrs (int, int, char *);
100
101 static int pagemask;
102
103 /* Correct an int which is the bit pattern of a pointer to a byte
104    into an int which is the number of a byte.
105    This is a no-op on ordinary machines, but not on all.  */
106
107 #ifndef ADDR_CORRECT   /* Let m-*.h files override this definition */
108 #define ADDR_CORRECT(x) ((char *)(x) - (char*)0)
109 #endif
110
111 #ifdef emacs
112 #include "lisp.h"
113
114 static void
115 report_error (char *file, int fd)
116 {
117   if (fd)
118     close (fd);
119   report_file_error ("Cannot unexec", Fcons (build_string (file), Qnil));
120 }
121 #endif /* emacs */
122
123 #define ERROR0(msg) report_error_1 (new, msg, 0, 0); return -1
124 #define ERROR1(msg,x) report_error_1 (new, msg, x, 0); return -1
125 #define ERROR2(msg,x,y) report_error_1 (new, msg, x, y); return -1
126
127 static void
128 report_error_1 (int fd, char *msg, int a1, int a2)
129 {
130   close (fd);
131 #ifdef emacs
132   error (msg, a1, a2);
133 #else
134   fprintf (stderr, msg, a1, a2);
135   fprintf (stderr, "\n");
136 #endif
137 }
138
139 static int make_hdr (int, int, unsigned, unsigned, unsigned, char *, char *);
140 static void mark_x (char *);
141 static int copy_text_and_data (int);
142 static int copy_sym (int, int, char *, char *);
143 static void write_segment (int, char *, char *);
144 \f
145 /* ****************************************************************
146  * unexec
147  *
148  * driving logic.
149  */
150 int unexec (char *new_name, char *a_name,
151             uintptr_t data_start,
152             uintptr_t bss_start,
153             uintptr_t entry_address)
154 {
155   int new = -1, a_out = -1;
156
157   if (a_name && (a_out = open (a_name, O_RDONLY)) < 0)
158     {
159       PERROR (a_name);
160     }
161   if ((new = creat (new_name, 0666)) < 0)
162     {
163       PERROR (new_name);
164     }
165   if (make_hdr (new, a_out,
166                 data_start, bss_start,
167                 entry_address,
168                 a_name, new_name) < 0
169       || copy_text_and_data (new) < 0
170       || copy_sym (new, a_out, a_name, new_name) < 0
171       || adjust_lnnoptrs (new, a_out, new_name) < 0
172       || unrelocate_symbols (new, a_out, a_name, new_name) < 0)
173     {
174       close (new);
175       return -1;        
176     }
177
178   close (new);
179   if (a_out >= 0)
180     close (a_out);
181   mark_x (new_name);
182   return 0;
183 }
184
185 /* ****************************************************************
186  * make_hdr
187  *
188  * Make the header in the new a.out from the header in core.
189  * Modify the text and data sizes.
190  */
191 static int
192 make_hdr (int new, int a_out,
193           unsigned data_start, unsigned bss_start,
194           unsigned entry_address,
195           char *a_name, char *new_name)
196 {
197   int scns;
198   unsigned int bss_end;
199
200   struct scnhdr section[MAX_SECTIONS];
201   struct scnhdr * f_thdr;               /* Text section header */
202   struct scnhdr * f_dhdr;               /* Data section header */
203   struct scnhdr * f_bhdr;               /* Bss section header */
204   struct scnhdr * f_lhdr;               /* Loader section header */
205   struct scnhdr * f_tchdr;              /* Typechk section header */
206   struct scnhdr * f_dbhdr;              /* Debug section header */
207   struct scnhdr * f_xhdr;               /* Except section header */
208
209   load_scnptr = orig_load_scnptr = lnnoptr = 0;
210   pagemask = getpagesize () - 1;
211
212   /* Adjust text/data boundary. */
213   data_start = (long) start_of_data ();
214   data_start = ADDR_CORRECT (data_start);
215
216   data_start = data_start & ~pagemask; /* (Down) to page boundary. */
217
218   bss_end = ADDR_CORRECT (sbrk (0)) + pagemask;
219   bss_end &= ~ pagemask;
220   /* Adjust data/bss boundary. */
221   if (bss_start != 0)
222     {
223       bss_start = (ADDR_CORRECT (bss_start) + pagemask);
224       /* (Up) to page bdry. */
225       bss_start &= ~ pagemask;
226       if (bss_start > bss_end)
227         {
228           ERROR1 ("unexec: Specified bss_start (%u) is past end of program",
229                   bss_start);
230         }
231     }
232   else
233     bss_start = bss_end;
234
235   if (data_start > bss_start)   /* Can't have negative data size. */
236     {
237       ERROR2 ("unexec: data_start (%u) can't be greater than bss_start (%u)",
238               data_start, bss_start);
239     }
240
241   /* Salvage as much info from the existing file as possible */
242   f_thdr = NULL; f_dhdr = NULL; f_bhdr = NULL;
243   f_lhdr = NULL; f_tchdr = NULL; f_dbhdr = NULL; f_xhdr = NULL;
244   if (a_out >= 0)
245     {
246       if (read (a_out, &f_hdr, sizeof (f_hdr)) != sizeof (f_hdr))
247         {
248           PERROR (a_name);
249         }
250       if (f_hdr.f_opthdr > 0)
251         {
252           if (read (a_out, &f_ohdr, sizeof (f_ohdr)) != sizeof (f_ohdr))
253             {
254               PERROR (a_name);
255             }
256         }
257       if (f_hdr.f_nscns > MAX_SECTIONS)
258         {
259           ERROR0 ("unexec: too many section headers -- increase MAX_SECTIONS");
260         }
261       /* Loop through section headers */
262       for (scns = 0; scns < f_hdr.f_nscns; scns++) {
263         struct scnhdr *s = &section[scns];
264         if (read (a_out, s, sizeof (*s)) != sizeof (*s))
265           {
266             PERROR (a_name);
267           }
268
269 #define CHECK_SCNHDR(ptr, name, flags) \
270   if (strcmp(s->s_name, name) == 0) { \
271     if (s->s_flags != flags) { \
272       fprintf(stderr, "unexec: %lx flags where %x expected in %s section.\n", \
273               (unsigned long)s->s_flags, flags, name); \
274     } \
275     if (ptr) { \
276       fprintf(stderr, "unexec: duplicate section header for section %s.\n", \
277               name); \
278     } \
279     ptr = s; \
280   }
281         CHECK_SCNHDR(f_thdr, _TEXT, STYP_TEXT);
282         CHECK_SCNHDR(f_dhdr, _DATA, STYP_DATA);
283         CHECK_SCNHDR(f_bhdr, _BSS, STYP_BSS);
284         CHECK_SCNHDR(f_lhdr, _LOADER, STYP_LOADER);
285         CHECK_SCNHDR(f_dbhdr, _DEBUG,  STYP_DEBUG);
286         CHECK_SCNHDR(f_tchdr, _TYPCHK,  STYP_TYPCHK);
287         CHECK_SCNHDR(f_xhdr, _EXCEPT,  STYP_EXCEPT);
288       }
289
290       if (f_thdr == 0)
291         {
292           ERROR1 ("unexec: couldn't find \"%s\" section", (int) _TEXT);
293         }
294       if (f_dhdr == 0)
295         {
296           ERROR1 ("unexec: couldn't find \"%s\" section", (int) _DATA);
297         }
298       if (f_bhdr == 0)
299         {
300           ERROR1 ("unexec: couldn't find \"%s\" section", (int) _BSS);
301         }
302     }
303   else
304     {
305       ERROR0 ("can't build a COFF file from scratch yet");
306     }
307   orig_data_scnptr = f_dhdr->s_scnptr;
308   orig_load_scnptr = f_lhdr ? f_lhdr->s_scnptr : 0;
309
310   /* Now we alter the contents of all the f_*hdr variables
311      to correspond to what we want to dump.  */
312
313   /* Indicate that the reloc information is no longer valid for ld (bind);
314      we only update it enough to fake out the exec-time loader.  */
315   f_hdr.f_flags |= (F_RELFLG | F_EXEC);
316
317   f_ohdr.dsize = bss_start - f_ohdr.data_start;
318   f_ohdr.bsize = bss_end - bss_start;
319
320   f_dhdr->s_size = f_ohdr.dsize;
321   f_bhdr->s_size = f_ohdr.bsize;
322   f_bhdr->s_paddr = f_ohdr.data_start + f_ohdr.dsize;
323   f_bhdr->s_vaddr = f_ohdr.data_start + f_ohdr.dsize;
324
325   /* fix scnptr's */
326   {
327     ulong ptr = section[0].s_scnptr;
328
329     bias = -1;
330     for (scns = 0; scns < f_hdr.f_nscns; scns++)
331       {
332         struct scnhdr *s = &section[scns];
333
334         if (s->s_flags & STYP_PAD)        /* .pad sections omitted in AIX 4.1 */
335           {
336             /*
337              * the text_start should probably be o_algntext but that doesn't
338              * seem to change
339              */
340             if (f_ohdr.text_start != 0) /* && scns != 0 */
341               {
342                 s->s_size = 512 - (ptr % 512);
343                 if (s->s_size == 512)
344                   s->s_size = 0;
345               }
346             s->s_scnptr = ptr;
347           }
348         else if (s->s_flags & STYP_DATA)
349           s->s_scnptr = ptr;
350         else if (!(s->s_flags & (STYP_TEXT | STYP_BSS)))
351           {
352             if (bias == -1)                /* if first section after bss */
353               bias = ptr - s->s_scnptr;
354
355             s->s_scnptr += bias;
356             ptr = s->s_scnptr;
357           }
358   
359         ptr = ptr + s->s_size;
360       }
361   }
362
363   /* fix other pointers */
364   for (scns = 0; scns < f_hdr.f_nscns; scns++)
365     {
366       struct scnhdr *s = &section[scns];
367
368       if (s->s_relptr != 0)
369         {
370           s->s_relptr += bias;
371         }
372       if (s->s_lnnoptr != 0)
373         {
374           if (lnnoptr == 0) lnnoptr = s->s_lnnoptr;
375           s->s_lnnoptr += bias;
376         }
377     }
378
379   if (f_hdr.f_symptr > 0L)
380     {
381       f_hdr.f_symptr += bias;
382     }
383
384   text_scnptr = f_thdr->s_scnptr;
385   data_scnptr = f_dhdr->s_scnptr;
386   load_scnptr = f_lhdr ? f_lhdr->s_scnptr : 0;
387
388   if (write (new, &f_hdr, sizeof (f_hdr)) != sizeof (f_hdr))
389     {
390       PERROR (new_name);
391     }
392
393   if (f_hdr.f_opthdr > 0)
394     {
395       if (write (new, &f_ohdr, sizeof (f_ohdr)) != sizeof (f_ohdr))
396         {
397           PERROR (new_name);
398         }
399     }
400
401   for (scns = 0; scns < f_hdr.f_nscns; scns++) {
402     struct scnhdr *s = &section[scns];
403     if (write (new, s, sizeof (*s)) != sizeof (*s))
404       {
405         PERROR (new_name);
406       }
407   }
408
409   return (0);
410 }
411 \f
412 /* ****************************************************************
413  
414  *
415  * Copy the text and data segments from memory to the new a.out
416  */
417 static int
418 copy_text_and_data (int new)
419 {
420   char *end;
421   char *ptr;
422
423   lseek (new, (long) text_scnptr, SEEK_SET);
424   ptr = start_of_text () + text_scnptr;
425   end = ptr + f_ohdr.tsize;
426   write_segment (new, ptr, end);
427
428   lseek (new, (long) data_scnptr, SEEK_SET);
429   ptr = (char *) f_ohdr.data_start;
430   end = ptr + f_ohdr.dsize;
431   write_segment (new, ptr, end);
432
433   return 0;
434 }
435
436 #define UnexBlockSz (1<<12)                     /* read/write block size */
437 static void
438 write_segment (int new, char *ptr, char *end)
439 {
440   int i, nwrite, ret;
441   char buf[80];
442   char zeros[UnexBlockSz];
443
444   for (i = 0; ptr < end;)
445     {
446       /* distance to next block.  */
447       nwrite = (((int) ptr + UnexBlockSz) & -UnexBlockSz) - (int) ptr;
448       /* But not beyond specified end.  */
449       if (nwrite > end - ptr) nwrite = end - ptr;
450       ret = write (new, ptr, nwrite);
451       /* If write gets a page fault, it means we reached
452          a gap between the old text segment and the old data segment.
453          This gap has probably been remapped into part of the text segment.
454          So write zeros for it.  */
455       if (ret == -1 && errno == EFAULT)
456         {
457           memset (zeros, 0, nwrite);
458           write (new, zeros, nwrite);
459         }
460       else if (nwrite != ret)
461         {
462           sprintf (buf,
463                    "unexec write failure: addr 0x%lx, fileno %d, size 0x%x, wrote 0x%x, errno %d",
464                    (unsigned long)ptr, new, nwrite, ret, errno);
465           PERROR (buf);
466         }
467       i += nwrite;
468       ptr += nwrite;
469     }
470 }
471 \f
472 /* ****************************************************************
473  * copy_sym
474  *
475  * Copy the relocation information and symbol table from the a.out to the new
476  */
477 static int
478 copy_sym (int new, int a_out, char *a_name, char *new_name)
479 {
480   char page[UnexBlockSz];
481   int n;
482
483   if (a_out < 0)
484     return 0;
485
486   if (orig_load_scnptr == 0L)
487     return 0;
488
489   if (lnnoptr && lnnoptr < orig_load_scnptr) /* if there is line number info  */
490     lseek (a_out, lnnoptr, SEEK_SET);  /* start copying from there */
491   else
492     lseek (a_out, orig_load_scnptr, SEEK_SET); /* Position a.out to symtab. */
493
494   while ((n = read (a_out, page, sizeof page)) > 0)
495     {
496       if (write (new, page, n) != n)
497         {
498           PERROR (new_name);
499         }
500     }
501   if (n < 0)
502     {
503       PERROR (a_name);
504     }
505   return 0;
506 }
507 \f
508 /* ****************************************************************
509  * mark_x
510  *
511  * After successfully building the new a.out, mark it executable
512  */
513 static void
514 mark_x (char *name)
515 {
516   struct stat sbuf;
517   int um;
518   int new = 0;  /* for PERROR */
519
520   um = umask (777);
521   umask (um);
522   if (stat (name, &sbuf) == -1)
523     {
524       PERROR (name);
525     }
526   sbuf.st_mode |= 0111 & ~um;
527   if (chmod (name, sbuf.st_mode) == -1)
528     PERROR (name);
529 }
530 \f
531 static int
532 adjust_lnnoptrs (int writedesc, int readdesc, char *new_name)
533 {
534   int nsyms;
535   int naux;
536   int new;
537   struct syment symentry;
538   union auxent auxentry;
539
540   if (!lnnoptr || !f_hdr.f_symptr)
541     return 0;
542
543   if ((new = open (new_name, O_RDWR)) < 0)
544     {
545       PERROR (new_name);
546       return -1;
547     }
548
549   lseek (new, f_hdr.f_symptr, SEEK_SET);
550   for (nsyms = 0; nsyms < f_hdr.f_nsyms; nsyms++)
551     {
552       read (new, &symentry, SYMESZ);
553       if (symentry.n_sclass == C_BINCL || symentry.n_sclass == C_EINCL)
554         {
555           symentry.n_value += bias;
556           lseek (new, -SYMESZ, SEEK_CUR);
557           write (new, &symentry, SYMESZ);
558         }
559
560       for (naux = symentry.n_numaux; naux-- != 0; )
561         {
562           read (new, &auxentry, AUXESZ);
563           nsyms++;
564           if (naux != 0              /* skip csect auxentry (last entry) */
565               && (symentry.n_sclass == C_EXT || symentry.n_sclass == C_HIDEXT))
566             {
567               auxentry.x_sym.x_fcnary.x_fcn.x_lnnoptr += bias;
568               lseek (new, -AUXESZ, SEEK_CUR);
569               write (new, &auxentry, AUXESZ);
570             }
571         }
572     }
573   close (new);
574
575   return 0;
576 }
577
578 static int
579 unrelocate_symbols (int new, int a_out, char *a_name, char *new_name)
580 {
581   int i;
582   LDHDR ldhdr;
583   LDREL ldrel;
584   ulong t_reloc = (ulong) &_text - f_ohdr.text_start;
585 #ifndef ALIGN_DATA_RELOC
586   ulong d_reloc = (ulong) &_data - f_ohdr.data_start;
587 #else
588   /* This worked (and was needed) before AIX 4.2. 
589      I have no idea why. -- Mike */
590   ulong d_reloc = (ulong) &_data - ALIGN(f_ohdr.data_start, 2);
591 #endif
592   int * p;
593
594   if (load_scnptr == 0)
595     return 0;
596
597   lseek (a_out, orig_load_scnptr, SEEK_SET);
598   if (read (a_out, &ldhdr, sizeof (ldhdr)) != sizeof (ldhdr))
599     {
600       PERROR (new_name);
601     }
602
603 #define SYMNDX_TEXT     0
604 #define SYMNDX_DATA     1
605 #define SYMNDX_BSS      2
606
607   for (i = 0; i < ldhdr.l_nreloc; i++)
608     {
609       lseek (a_out,
610              orig_load_scnptr + LDHDRSZ + LDSYMSZ*ldhdr.l_nsyms + LDRELSZ*i,
611              SEEK_SET);
612
613       if (read (a_out, &ldrel, LDRELSZ) != LDRELSZ)
614         {
615           PERROR (a_name);
616         }
617
618       /* move the BSS loader symbols to the DATA segment */
619       if (ldrel.l_symndx == SYMNDX_BSS)
620         {
621           ldrel.l_symndx = SYMNDX_DATA;
622
623           lseek (new,
624                  load_scnptr + LDHDRSZ + LDSYMSZ*ldhdr.l_nsyms + LDRELSZ*i,
625                  SEEK_SET);
626
627           if (write (new, &ldrel, LDRELSZ) != LDRELSZ)
628             {
629               PERROR (new_name);
630             }
631         }
632
633       if (ldrel.l_rsecnm == f_ohdr.o_sndata)
634         {
635           int orig_int;
636
637           lseek (a_out,
638                  orig_data_scnptr + (ldrel.l_vaddr - f_ohdr.data_start),
639                  SEEK_SET);
640
641           if (read (a_out, (void *) &orig_int, sizeof (orig_int))
642               != sizeof (orig_int))
643             {
644               PERROR (a_name);
645             }
646
647           p = (int *) (ldrel.l_vaddr + d_reloc);
648
649           switch (ldrel.l_symndx) {
650           case SYMNDX_TEXT:
651             orig_int = * p - t_reloc;
652             break;
653
654           case SYMNDX_DATA:
655           case SYMNDX_BSS:
656             orig_int = * p - d_reloc;
657             break;
658           }
659
660           if (orig_int != * p)
661             {
662               lseek (new,
663                      data_scnptr + (ldrel.l_vaddr - f_ohdr.data_start),
664                      SEEK_SET);
665               if (write (new, (void *) &orig_int, sizeof (orig_int))
666                   != sizeof (orig_int))
667                 {
668                   PERROR (new_name);
669                 }
670             }
671         }
672     }
673   return 0;
674 }