source: trunk/source/lisp-kernel/image.c @ 15373

Last change on this file since 15373 was 15373, checked in by gb, 7 years ago

Suppress some warnings from llvm.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 17.8 KB
Line 
1/*
2   Copyright (C) 2002-2009 Clozure Associates
3   This file is part of Clozure CL. 
4
5   Clozure CL is licensed under the terms of the Lisp Lesser GNU Public
6   License , known as the LLGPL and distributed with Clozure CL as the
7   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
8   which is distributed with Clozure CL as the file "LGPL".  Where these
9   conflict, the preamble takes precedence. 
10
11   Clozure CL is referenced in the preamble as the "LIBRARY."
12
13   The LLGPL is also available online at
14   http://opensource.franz.com/preamble.html
15*/
16
17#include "lisp.h"
18#include "lisp_globals.h"
19#include "area.h"
20#include "image.h"
21#include "gc.h"
22#include <errno.h>
23#include <unistd.h>
24#ifndef WINDOWS
25#include <sys/mman.h>
26#endif
27#include <stdio.h>
28#include <limits.h>
29#include <time.h>
30
31
32#if defined(PPC64) || defined(X8632)
33#define RELOCATABLE_FULLTAG_MASK \
34  ((1<<fulltag_cons)|(1<<fulltag_misc))
35#else
36#ifdef X8664
37#define RELOCATABLE_FULLTAG_MASK \
38  ((1<<fulltag_cons)|(1<<fulltag_misc)|(1<<fulltag_symbol)|(1<<fulltag_function))
39#else
40#define RELOCATABLE_FULLTAG_MASK \
41  ((1<<fulltag_cons)|(1<<fulltag_nil)|(1<<fulltag_misc))
42#endif
43#endif
44
45void
46relocate_area_contents(area *a, LispObj bias)
47{
48  LispObj
49    *start = (LispObj *)(a->low), 
50    *end = (LispObj *)(a->active),
51    low = (LispObj)image_base - bias,
52    high = ptr_to_lispobj(active_dynamic_area->active) - bias,
53    w0, w1;
54  int fulltag;
55  Boolean fixnum_after_header_is_link = false;
56
57  while (start < end) {
58    w0 = *start;
59    fulltag = fulltag_of(w0);
60    if (immheader_tag_p(fulltag)) {
61      start = (LispObj *)skip_over_ivector((natural)start, w0);
62    } else {
63#ifdef X86
64      if (header_subtag(w0) == subtag_function) {
65#ifdef X8664
66        int skip = ((int) start[1])+1;
67#else
68        extern void update_self_references(LispObj *);
69        extern natural imm_word_count(LispObj);
70
71        natural skip = (natural)imm_word_count(((LispObj)start)+fulltag_misc)+1;
72        update_self_references(start);
73#endif
74     
75        start += skip;
76        if (((LispObj) start) & node_size) {
77          --start;
78        }
79        w0 = *start;
80        fulltag = fulltag_of(w0);
81      }
82#endif
83#ifdef ARM
84      if ((header_subtag(w0) == subtag_function) ||
85          (header_subtag(w0) == subtag_pseudofunction)) {
86        w1 = start[1];
87        if ((w1 >= low) && (w1 < high)) {
88          start[1]=(w1+bias);
89        }
90        start+=2;
91        w0 = *start;
92        fulltag = fulltag_of(w0);
93      }
94#endif
95      if (header_subtag(w0) == subtag_weak) {
96        fixnum_after_header_is_link = true;
97      }
98      if (header_subtag(w0) == subtag_hash_vector) {
99        hash_table_vector_header *hashp = (hash_table_vector_header *)start;
100       
101        if (hashp->flags & nhash_track_keys_mask) {
102          hashp->flags |= nhash_key_moved_mask;
103        }
104        fixnum_after_header_is_link = true;
105      }
106
107      if ((w0 >= low) && (w0 < high) &&
108          ((1<<fulltag) & RELOCATABLE_FULLTAG_MASK)) {
109        *start = (w0+bias);
110      }
111      w1 = *++start;
112      fulltag = fulltag_of(w1);
113      if ((w1 >= low) && (w1 < high) &&
114          (fixnum_after_header_is_link ||
115           ((1<<fulltag) & RELOCATABLE_FULLTAG_MASK))) {
116        *start = (w1+bias);
117      }
118      fixnum_after_header_is_link = false;
119      ++start;
120    }
121  }
122  if (start > end) {
123    Bug(NULL, "Overran area bounds in relocate_area_contents");
124  }
125}
126     
127
128
129
130off_t
131seek_to_next_page(int fd)
132{
133  off_t pos = LSEEK(fd, 0, SEEK_CUR);
134  pos = align_to_power_of_2(pos, log2_page_size);
135  return LSEEK(fd, pos, SEEK_SET);
136}
137 
138/*
139  fd is positioned to EOF; header has been allocated by caller.
140  If we find a trailer (and that leads us to the header), read
141  the header & return true else return false.
142*/
143Boolean
144find_openmcl_image_file_header(int fd, openmcl_image_file_header *header)
145{
146  openmcl_image_file_trailer trailer;
147  int disp;
148  off_t pos;
149  unsigned version, flags;
150
151  pos = LSEEK(fd, 0, SEEK_END);
152  if (pos < 0) {
153    return false;
154  }
155  pos -= sizeof(trailer);
156
157  if (LSEEK(fd, pos, SEEK_SET) < 0) {
158    return false;
159  }
160  if (read(fd, &trailer, sizeof(trailer)) != sizeof(trailer)) {
161    return false;
162  }
163  if ((trailer.sig0 != IMAGE_SIG0) ||
164      (trailer.sig1 != IMAGE_SIG1) ||
165      (trailer.sig2 != IMAGE_SIG2)) {
166    return false;
167  }
168  disp = trailer.delta;
169 
170  if (disp >= 0) {
171    return false;
172  }
173  if (LSEEK(fd, disp, SEEK_CUR) < 0) {
174    return false;
175  }
176  if (read(fd, header, sizeof(openmcl_image_file_header)) !=
177      sizeof(openmcl_image_file_header)) {
178    return false;
179  }
180  if ((header->sig0 != IMAGE_SIG0) ||
181      (header->sig1 != IMAGE_SIG1) ||
182      (header->sig2 != IMAGE_SIG2) ||
183      (header->sig3 != IMAGE_SIG3)) {
184    return false;
185  }
186  version = (header->abi_version) & 0xffff;
187  if (version < ABI_VERSION_MIN) {
188    fprintf(dbgout, "Heap image is too old for this kernel.\n");
189    return false;
190  }
191  if (version > ABI_VERSION_MAX) {
192    fprintf(dbgout, "Heap image is too new for this kernel.\n");
193    return false;
194  }
195  flags = header->flags;
196  if (flags != PLATFORM) {
197    fprintf(dbgout, "Heap image was saved for another platform.\n");
198    return false;
199  }
200  return true;
201}
202
203void
204load_image_section(int fd, openmcl_image_section_header *sect)
205{
206  extern area* allocate_dynamic_area(natural);
207  off_t
208    pos = seek_to_next_page(fd), advance;
209  natural
210    mem_size = sect->memory_size;
211  char *addr;
212  area *a;
213
214  advance = mem_size;
215  switch(sect->code) {
216  case AREA_READONLY:
217    if (mem_size != 0) {
218      if (!MapFile(pure_space_active,
219                   pos,
220                   align_to_power_of_2(mem_size,log2_page_size),
221                   MEMPROTECT_RX,
222                   fd)) {
223        return;
224      }
225    }
226    a = new_area(pure_space_active, pure_space_limit, AREA_READONLY);
227    pure_space_active += mem_size;
228    a->active = pure_space_active;
229    sect->area = a;     
230    break;
231
232  case AREA_STATIC:
233    if (!MapFile(static_space_active,
234                 pos,
235                 align_to_power_of_2(mem_size,log2_page_size),
236                 MEMPROTECT_RWX,
237                 fd)) {
238      return;
239    }
240    a = new_area(static_space_active, static_space_limit, AREA_STATIC);
241    static_space_active += mem_size;
242    a->active = static_space_active;
243    sect->area = a;
244    break;
245
246  case AREA_DYNAMIC:
247    a = allocate_dynamic_area(mem_size);
248    if (!MapFile(a->low,
249                 pos,
250                 align_to_power_of_2(mem_size,log2_page_size),
251                 MEMPROTECT_RWX,
252                 fd)) {
253      return;
254    }
255
256    a->static_dnodes = sect->static_dnodes;
257    sect->area = a;
258    break;
259
260  case AREA_MANAGED_STATIC:
261    a = new_area(pure_space_limit, pure_space_limit+align_to_power_of_2(mem_size,log2_page_size), AREA_MANAGED_STATIC);
262    a->active = a->low+mem_size;
263    if (mem_size) {
264      natural
265        refbits_size = align_to_power_of_2((((mem_size>>dnode_shift)+7)>>3),
266                                           log2_page_size);
267      if (!MapFile(a->low,
268                   pos,
269                   align_to_power_of_2(mem_size,log2_page_size),
270                   MEMPROTECT_RWX,
271                   fd)) {
272        return;
273      }
274      if (!CommitMemory(global_mark_ref_bits,refbits_size)) {
275        return;
276      }
277      /* Need to save/restore persistent refbits. */
278      if (!MapFile(managed_static_refbits,
279                   align_to_power_of_2(pos+mem_size,log2_page_size),
280                   refbits_size,
281                   MEMPROTECT_RW,
282                   fd)) {
283        return;
284      }
285      advance += refbits_size;
286    }
287    sect->area = a;
288    a->ndnodes = area_dnode(a->active, a->low);
289    managed_static_area = a;
290    lisp_global(REF_BASE) = (LispObj) a->low;
291    break;
292
293    /* In many respects, the static_cons_area is part of the dynamic
294       area; it's physically adjacent to it (immediately precedes the
295       dynamic area in memory) and its contents are subject to full
296       GC (but not compaction.)  It's maintained as a seperate section
297       in the image file, at least for now. */
298
299
300  case AREA_STATIC_CONS:
301    addr = (char *) lisp_global(HEAP_START);
302    a = new_area(addr-align_to_power_of_2(mem_size,log2_page_size), addr, AREA_STATIC_CONS);
303    if (mem_size) {     
304      if (!MapFile(a->low,
305                   pos,
306                   align_to_power_of_2(mem_size,log2_page_size),
307                   MEMPROTECT_RWX,
308                   fd)) {
309        return;
310      }
311    }
312    a->ndnodes = area_dnode(a->active, a->low);
313    sect->area = a;
314    static_cons_area = a;
315    break;
316
317  default:
318    return;
319   
320  }
321  LSEEK(fd, pos+advance, SEEK_SET);
322}
323
324LispObj
325load_openmcl_image(int fd, openmcl_image_file_header *h)
326{
327  void make_dynamic_heap_executable(BytePtr, BytePtr);
328  void xMakeDataExecutable(BytePtr, natural);
329  void lower_heap_start(BytePtr, area*);
330  void set_nil(LispObj);
331  LispObj image_nil = 0;
332  area *a;
333  if (find_openmcl_image_file_header(fd, h)) {
334    int i, nsections = h->nsections;
335    openmcl_image_section_header sections[nsections], *sect=sections;
336    LispObj bias = image_base - ACTUAL_IMAGE_BASE(h);
337#if (WORD_SIZE== 64)
338    signed_natural section_data_delta = 
339      ((signed_natural)(h->section_data_offset_high) << 32L) | h->section_data_offset_low;
340#endif
341
342    if (read (fd, sections, nsections*sizeof(openmcl_image_section_header)) !=
343        nsections * sizeof(openmcl_image_section_header)) {
344      return 0;
345    }
346#if WORD_SIZE == 64
347    LSEEK(fd, section_data_delta, SEEK_CUR);
348#endif
349    for (i = 0; i < nsections; i++, sect++) {
350      load_image_section(fd, sect);
351      a = sect->area;
352      if (a == NULL) {
353        return 0;
354      }
355    }
356
357    for (i = 0, sect = sections; i < nsections; i++, sect++) {
358      a = sect->area;
359      switch(sect->code) {
360      case AREA_STATIC:
361        nilreg_area = a;
362#ifdef PPC
363#ifdef PPC64
364        image_nil = ptr_to_lispobj(a->low + (1024*4) + sizeof(lispsymbol) + fulltag_misc);
365#else
366        image_nil = (LispObj)(a->low + 8 + 8 + (1024*4) + fulltag_nil);
367#endif
368#endif
369#ifdef X86
370#ifdef X8664
371        image_nil = (LispObj)(a->low) + (1024*4) + fulltag_nil;
372#else
373        image_nil = (LispObj)(a->low) + (1024*4) + fulltag_cons;
374#endif
375#endif
376#ifdef ARM
377        image_nil = (LispObj)(a->low) + (1024*4) + fulltag_nil;
378#endif
379        set_nil(image_nil);
380        if (bias) {
381          LispObj weakvll = lisp_global(WEAKVLL);
382
383          if ((weakvll >= ((LispObj)image_base-bias)) &&
384              (weakvll < (ptr_to_lispobj(active_dynamic_area->active)-bias))) {
385            lisp_global(WEAKVLL) = weakvll+bias;
386          }
387          relocate_area_contents(a, bias);
388        }
389        make_dynamic_heap_executable(a->low, a->active);
390        add_area_holding_area_lock(a);
391        break;
392       
393      case AREA_READONLY:
394        if (bias && 
395            (managed_static_area->active != managed_static_area->low)) {
396          UnProtectMemory(a->low, a->active-a->low);
397          relocate_area_contents(a, bias);
398          ProtectMemory(a->low, a->active-a->low);
399        }
400        readonly_area = a;
401        add_area_holding_area_lock(a);
402        break;
403      }
404    }
405    for (i = 0, sect = sections; i < nsections; i++, sect++) {
406      a = sect->area;
407      switch(sect->code) {
408      case AREA_MANAGED_STATIC:
409        if (bias) {
410          relocate_area_contents(a, bias);
411        }
412        add_area_holding_area_lock(a);
413        break;
414      case AREA_STATIC_CONS:
415        break;
416      case AREA_DYNAMIC:
417        lower_heap_start(static_cons_area->low,a);
418        if (bias) {
419          relocate_area_contents(a, bias);
420        }
421        resize_dynamic_heap(a->active, lisp_heap_gc_threshold);
422        xMakeDataExecutable(a->low, a->active - a->low);
423        break;
424      }
425    }
426  }
427  return image_nil;
428}
429 
430void
431prepare_to_write_dynamic_space(area *a)
432{
433  LispObj
434    *start = (LispObj *)(a->low),
435    *end = (LispObj *) (a->active),
436    x1;
437  int tag, subtag, element_count;
438
439  while (start < end) {
440    x1 = *start;
441    tag = fulltag_of(x1);
442    if (immheader_tag_p(tag)) {
443      subtag = header_subtag(x1);
444      if (subtag == subtag_macptr) {
445        if ((start[1] >= (natural)0x10000) && (start[1] < (natural)-0x10000)) {
446          /* Leave small pointers alone */
447          *start = make_header(subtag_dead_macptr,header_element_count(x1));
448        }
449      }
450      start = (LispObj *)skip_over_ivector((natural)start, x1);
451    } else if (nodeheader_tag_p(tag)) {
452      element_count = header_element_count(x1) | 1;
453      start += (element_count+1);
454    } else {
455      start += 2;
456    }
457  }
458}
459
460 
461
462int
463write_file_and_section_headers(int fd, 
464                               openmcl_image_file_header *file_header,
465                               openmcl_image_section_header* section_headers,
466                               int nsections,
467                               off_t *header_pos)
468{
469  *header_pos = seek_to_next_page(fd);
470
471  if (LSEEK (fd, *header_pos, SEEK_SET) < 0) {
472    return errno;
473  }
474  if (write(fd, file_header, sizeof(*file_header)) != sizeof(*file_header)) {
475    return errno;
476  }
477  if (write(fd, section_headers, sizeof(section_headers[0])*nsections)
478      != (sizeof(section_headers[0])*nsections)) {
479    return errno;
480  }
481  return 0;
482}
483 
484natural
485writebuf(int fd, char *bytes, natural n)
486{
487  natural remain = n, this_size;
488  signed_natural result;
489
490  while (remain) {
491    this_size = remain;
492    if (this_size > INT_MAX) {
493      this_size = INT_MAX;
494    }
495    result = write(fd, bytes, this_size);
496    if (result < 0) {
497      return errno;
498    }
499    bytes += result;
500
501    remain -= result;
502  }
503  return 0;
504}
505
506void
507prepare_to_write_static_space(Boolean egc_was_enabled)
508{
509  area *g0_area = g1_area->younger;
510  int i;
511
512  /* Save GC config */
513  lisp_global(LISP_HEAP_THRESHOLD) = lisp_heap_gc_threshold;
514  lisp_global(G0_THRESHOLD) = g0_area->threshold;
515  lisp_global(G1_THRESHOLD) = g1_area->threshold;
516  lisp_global(G2_THRESHOLD) = g2_area->threshold;
517  lisp_global(EGC_ENABLED) = (LispObj)egc_was_enabled;
518  lisp_global(GC_NOTIFY_THRESHOLD) = lisp_heap_notify_threshold;
519  /*
520    lisp_global(GC_NUM) and lisp_global(FWDNUM) are persistent,
521    as is DELETED_STATIC_PAIRS.
522    Nothing else is even meaningful at this point.
523    Except for those things that've become meaningful since that
524    comment was written.
525  */
526  for (i = MIN_KERNEL_GLOBAL; i < 0; i++) {
527    switch (i) {
528    case FREE_STATIC_CONSES:
529    case FWDNUM:
530    case GC_NUM:
531    case STATIC_CONSES:
532    case WEAK_GC_METHOD:
533    case LISP_HEAP_THRESHOLD:
534    case EGC_ENABLED:
535    case G0_THRESHOLD:
536    case G1_THRESHOLD:
537    case G2_THRESHOLD:
538    case GC_NOTIFY_THRESHOLD:
539      break;
540    case WEAKVLL:
541      break;
542    default:
543      lisp_global(i) = 0;
544    }
545  }
546}
547
548
549OSErr
550save_application_internal(unsigned fd, Boolean egc_was_enabled)
551{
552  openmcl_image_file_header fh;
553  openmcl_image_section_header sections[NUM_IMAGE_SECTIONS];
554  openmcl_image_file_trailer trailer;
555  area *areas[NUM_IMAGE_SECTIONS], *a;
556  int i, err;
557  off_t header_pos, eof_pos;
558#if WORD_SIZE == 64
559  off_t image_data_pos;
560  signed_natural section_data_delta;
561#endif
562
563  /*
564    Coerce macptrs to dead_macptrs.
565  */
566 
567  prepare_to_write_dynamic_space(active_dynamic_area);
568  prepare_to_write_dynamic_space(managed_static_area);
569
570  /*
571     If we ever support continuing after saving an image,
572     undo this .. */
573
574  if (static_cons_area->high > static_cons_area->low) {
575    active_dynamic_area->low = static_cons_area->high;
576    tenured_area->static_dnodes -= area_dnode(static_cons_area->high, static_cons_area->low);
577  }
578
579  areas[0] = nilreg_area; 
580  areas[1] = readonly_area;
581  areas[2] = active_dynamic_area;
582  areas[3] = managed_static_area;
583  areas[4] = static_cons_area;
584  for (i = 0; i < NUM_IMAGE_SECTIONS; i++) {
585    a = areas[i];
586    sections[i].code = a->code;
587    sections[i].area = NULL;
588    sections[i].memory_size  = a->active - a->low;
589    if (a == active_dynamic_area) {
590      sections[i].static_dnodes = tenured_area->static_dnodes;
591    } else {
592      sections[i].static_dnodes = 0;
593    }
594  }
595  fh.sig0 = IMAGE_SIG0;
596  fh.sig1 = IMAGE_SIG1;
597  fh.sig2 = IMAGE_SIG2;
598  fh.sig3 = IMAGE_SIG3;
599  fh.timestamp = time(NULL);
600  CANONICAL_IMAGE_BASE(&fh) = IMAGE_BASE_ADDRESS;
601  ACTUAL_IMAGE_BASE(&fh) = image_base;
602  fh.nsections = NUM_IMAGE_SECTIONS;
603  fh.abi_version=ABI_VERSION_CURRENT;
604#if WORD_SIZE == 64
605  fh.section_data_offset_high = 0;
606  fh.section_data_offset_low = 0;
607#else
608  fh.pad0[0] = fh.pad0[1] = 0;
609  fh.pad1[0] = fh.pad1[1] = fh.pad1[2] = fh.pad1[3] = 0;
610#endif
611  fh.flags = PLATFORM;
612
613#if WORD_SIZE == 64
614  image_data_pos = seek_to_next_page(fd);
615#else
616  err = write_file_and_section_headers(fd, &fh, sections, NUM_IMAGE_SECTIONS, &header_pos);
617  if (err) {
618    return err;
619  }
620#endif
621
622  prepare_to_write_static_space(egc_was_enabled);
623
624
625
626  for (i = 0; i < NUM_IMAGE_SECTIONS; i++) {
627    natural n;
628    a = areas[i];
629    seek_to_next_page(fd);
630    n = sections[i].memory_size;
631    if (writebuf(fd, a->low, n)) {
632        return errno;
633    }
634    if (n &&  ((sections[i].code) == AREA_MANAGED_STATIC)) {
635      natural ndnodes = area_dnode(a->active, a->low);
636      natural nrefbytes = align_to_power_of_2((ndnodes+7)>>3,log2_page_size);
637
638      seek_to_next_page(fd);
639      if (writebuf(fd,(char*)managed_static_refbits,nrefbytes)) {
640        return errno;
641      }
642    }
643  }
644
645#if WORD_SIZE == 64
646  seek_to_next_page(fd);
647  section_data_delta = -((LSEEK(fd,0,SEEK_CUR)+sizeof(fh)+sizeof(sections)) -
648                         image_data_pos);
649  fh.section_data_offset_high = (int)(section_data_delta>>32L);
650  fh.section_data_offset_low = (unsigned)section_data_delta;
651  err =  write_file_and_section_headers(fd, &fh, sections, NUM_IMAGE_SECTIONS, &header_pos);
652  if (err) {
653    return err;
654  } 
655#endif
656
657  trailer.sig0 = IMAGE_SIG0;
658  trailer.sig1 = IMAGE_SIG1;
659  trailer.sig2 = IMAGE_SIG2;
660  eof_pos = LSEEK(fd, 0, SEEK_CUR) + sizeof(trailer);
661  trailer.delta = (int) (header_pos-eof_pos);
662  if (write(fd, &trailer, sizeof(trailer)) == sizeof(trailer)) {
663#ifndef WINDOWS
664    fsync(fd);
665#endif
666    close(fd);
667    return 0;
668  } 
669  i = errno;
670  close(fd);
671  return i;
672}
673
674OSErr
675save_application(int fd, Boolean egc_was_enabled)
676{
677#ifdef DARWIN
678#ifdef X86
679  extern void save_native_library(int, Boolean);
680 
681  if (fd < 0) {
682    save_native_library(-fd, egc_was_enabled);
683    return 0;
684  }
685#endif
686#endif
687  return save_application_internal(fd, egc_was_enabled);
688}
689
690     
691
692
693
Note: See TracBrowser for help on using the repository browser.