source: branches/purify/source/lisp-kernel/image.c @ 12886

Last change on this file since 12886 was 12886, checked in by gb, 11 years ago

Write a (possibly empty) static-cons-area to image file;
read it. Change image version.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.1 KB
Line 
1/*
2   Copyright (C) 2002 Clozure Associates
3   This file is part of OpenMCL. 
4
5   OpenMCL is licensed under the terms of the Lisp Lesser GNU Public
6   License , known as the LLGPL and distributed with OpenMCL as the
7   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
8   which is distributed with OpenMCL as the file "LGPL".  Where these
9   conflict, the preamble takes precedence. 
10
11   OpenMCL 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
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;
54  int fulltag;
55
56  while (start < end) {
57    w0 = *start;
58    fulltag = fulltag_of(w0);
59    if (immheader_tag_p(fulltag)) {
60      start = (LispObj *)skip_over_ivector((natural)start, w0);
61    } else {
62#ifdef X86
63      if (header_subtag(w0) == subtag_function) {
64#ifdef X8664
65        int skip = ((int) start[1])+1;
66#else
67        int skip = ((unsigned short)start[1])+1;
68        extern void update_self_references(LispObj *);
69        update_self_references(start);
70#endif
71     
72        start += skip;
73        if (((LispObj) start) & node_size) {
74          --start;
75        }
76        w0 = *start;
77        fulltag = fulltag_of(w0);
78      }
79#endif
80
81      if ((w0 >= low) && (w0 < high) &&
82          ((1<<fulltag) & RELOCATABLE_FULLTAG_MASK)) {
83        *start = (w0+bias);
84      }
85      w0 = *++start;
86      fulltag = fulltag_of(w0);
87      if ((w0 >= low) && (w0 < high) &&
88          ((1<<fulltag) & RELOCATABLE_FULLTAG_MASK)) {
89        *start = (w0+bias);
90      }
91      ++start;
92    }
93  }
94}
95     
96
97
98
99off_t
100seek_to_next_page(int fd)
101{
102  off_t pos = LSEEK(fd, 0, SEEK_CUR);
103  pos = align_to_power_of_2(pos, log2_page_size);
104  return LSEEK(fd, pos, SEEK_SET);
105}
106 
107/*
108  fd is positioned to EOF; header has been allocated by caller.
109  If we find a trailer (and that leads us to the header), read
110  the header & return true else return false.
111*/
112Boolean
113find_openmcl_image_file_header(int fd, openmcl_image_file_header *header)
114{
115  openmcl_image_file_trailer trailer;
116  int disp;
117  off_t pos;
118  unsigned version, flags;
119
120  pos = LSEEK(fd, 0, SEEK_END);
121  if (pos < 0) {
122    return false;
123  }
124  pos -= sizeof(trailer);
125
126  if (LSEEK(fd, pos, SEEK_SET) < 0) {
127    return false;
128  }
129  if (read(fd, &trailer, sizeof(trailer)) != sizeof(trailer)) {
130    return false;
131  }
132  if ((trailer.sig0 != IMAGE_SIG0) ||
133      (trailer.sig1 != IMAGE_SIG1) ||
134      (trailer.sig2 != IMAGE_SIG2)) {
135    return false;
136  }
137  disp = trailer.delta;
138 
139  if (disp >= 0) {
140    return false;
141  }
142  if (LSEEK(fd, disp, SEEK_CUR) < 0) {
143    return false;
144  }
145  if (read(fd, header, sizeof(openmcl_image_file_header)) !=
146      sizeof(openmcl_image_file_header)) {
147    return false;
148  }
149  if ((header->sig0 != IMAGE_SIG0) ||
150      (header->sig1 != IMAGE_SIG1) ||
151      (header->sig2 != IMAGE_SIG2) ||
152      (header->sig3 != IMAGE_SIG3)) {
153    return false;
154  }
155  version = (header->abi_version) & 0xffff;
156  if (version < ABI_VERSION_MIN) {
157    fprintf(dbgout, "Heap image is too old for this kernel.\n");
158    return false;
159  }
160  if (version > ABI_VERSION_MAX) {
161    fprintf(dbgout, "Heap image is too new for this kernel.\n");
162    return false;
163  }
164  flags = header->flags;
165  if (flags != PLATFORM) {
166    fprintf(dbgout, "Heap image was saved for another platform.\n");
167    return false;
168  }
169  return true;
170}
171
172void
173load_image_section(int fd, openmcl_image_section_header *sect)
174{
175  extern area* allocate_dynamic_area(unsigned);
176  off_t
177    pos = seek_to_next_page(fd), advance;
178  natural
179    mem_size = sect->memory_size;
180  void *addr;
181  area *a;
182
183  advance = mem_size;
184  switch(sect->code) {
185  case AREA_READONLY:
186    if (!MapFile(pure_space_active,
187                 pos,
188                 align_to_power_of_2(mem_size,log2_page_size),
189                 MEMPROTECT_RX,
190                 fd)) {
191      return;
192    }
193    a = new_area(pure_space_active, pure_space_limit, AREA_READONLY);
194    pure_space_active += mem_size;
195    a->active = pure_space_active;
196    sect->area = a;     
197    break;
198
199  case AREA_STATIC:
200    if (!MapFile(static_space_active,
201                 pos,
202                 align_to_power_of_2(mem_size,log2_page_size),
203                 MEMPROTECT_RWX,
204                 fd)) {
205      return;
206    }
207    a = new_area(static_space_active, static_space_limit, AREA_STATIC);
208    static_space_active += mem_size;
209    a->active = static_space_active;
210    sect->area = a;
211    break;
212
213  case AREA_DYNAMIC:
214    a = allocate_dynamic_area(mem_size);
215    if (!MapFile(a->low,
216                 pos,
217                 align_to_power_of_2(mem_size,log2_page_size),
218                 MEMPROTECT_RWX,
219                 fd)) {
220      return;
221    }
222
223    a->static_dnodes = sect->static_dnodes;
224    sect->area = a;
225    break;
226
227  case AREA_MANAGED_STATIC:
228    a = new_area(pure_space_limit, pure_space_limit, AREA_MANAGED_STATIC);
229    sect->area = a;
230    break;
231
232  case AREA_STATIC_CONS:
233    a = new_area(pure_space_limit, pure_space_limit, AREA_STATIC_CONS);
234    sect->area = a;
235    break;
236
237  default:
238    return;
239   
240  }
241  LSEEK(fd, pos+advance, SEEK_SET);
242}
243
244LispObj
245load_openmcl_image(int fd, openmcl_image_file_header *h)
246{
247  LispObj image_nil = 0;
248  area *a;
249  if (find_openmcl_image_file_header(fd, h)) {
250    int i, nsections = h->nsections;
251    openmcl_image_section_header sections[nsections], *sect=sections;
252    LispObj bias = image_base - ACTUAL_IMAGE_BASE(h);
253#if (WORD_SIZE== 64)
254    signed_natural section_data_delta = 
255      ((signed_natural)(h->section_data_offset_high) << 32L) | h->section_data_offset_low;
256#endif
257
258    if (read (fd, sections, nsections*sizeof(openmcl_image_section_header)) !=
259        nsections * sizeof(openmcl_image_section_header)) {
260      return 0;
261    }
262#if WORD_SIZE == 64
263    LSEEK(fd, section_data_delta, SEEK_CUR);
264#endif
265    for (i = 0; i < nsections; i++, sect++) {
266      load_image_section(fd, sect);
267      a = sect->area;
268      if (a == NULL) {
269        return 0;
270      }
271    }
272
273    for (i = 0, sect = sections; i < nsections; i++, sect++) {
274      a = sect->area;
275      switch(sect->code) {
276      case AREA_STATIC:
277        nilreg_area = a;
278#ifdef PPC
279#ifdef PPC64
280        image_nil = ptr_to_lispobj(a->low + (1024*4) + sizeof(lispsymbol) + fulltag_misc);
281#else
282        image_nil = (LispObj)(a->low + 8 + 8 + (1024*4) + fulltag_nil);
283#endif
284#endif
285#ifdef X86
286#ifdef X8664
287        image_nil = (LispObj)(a->low) + (1024*4) + fulltag_nil;
288#else
289        image_nil = (LispObj)(a->low) + (1024*4) + fulltag_cons;
290#endif
291#endif
292        set_nil(image_nil);
293        if (bias) {
294          relocate_area_contents(a, bias);
295        }
296        make_dynamic_heap_executable(a->low, a->active);
297        add_area_holding_area_lock(a);
298        break;
299       
300      case AREA_READONLY:
301        readonly_area = a;
302        add_area_holding_area_lock(a);
303        break;
304      }
305    }
306    for (i = 0, sect = sections; i < nsections; i++, sect++) {
307      a = sect->area;
308      switch(sect->code) {
309      case AREA_MANAGED_STATIC:
310        if (bias) {
311          relocate_area_contents(a, bias);
312        }
313        managed_static_area = a;
314        add_area_holding_area_lock(a);
315        break;
316      case AREA_STATIC_CONS:
317        if (bias) {
318          relocate_area_contents(a, bias);
319        }
320        static_cons_area = a;
321        add_area_holding_area_lock(a);
322        break;
323      case AREA_DYNAMIC:
324        if (bias) {
325          relocate_area_contents(a, bias);
326        }
327        resize_dynamic_heap(a->active, lisp_heap_gc_threshold);
328        xMakeDataExecutable(a->low, a->active - a->low);
329        break;
330      }
331    }
332  }
333  return image_nil;
334}
335 
336void
337prepare_to_write_dynamic_space()
338{
339  area *a = active_dynamic_area;
340  LispObj
341    *start = (LispObj *)(a->low),
342    *end = (LispObj *) (a->active),
343    x1;
344  int tag, subtag, element_count;
345
346  while (start < end) {
347    x1 = *start;
348    tag = fulltag_of(x1);
349    if (immheader_tag_p(tag)) {
350      subtag = header_subtag(x1);
351      if (subtag == subtag_macptr) {
352        if ((start[1] >= (natural)0x10000) && (start[1] < (natural)-0x10000)) {
353          /* Leave small pointers alone */
354          *start = make_header(subtag_dead_macptr,header_element_count(x1));
355        }
356      }
357      start = (LispObj *)skip_over_ivector((natural)start, x1);
358    } else if (nodeheader_tag_p(tag)) {
359      element_count = header_element_count(x1) | 1;
360      start += (element_count+1);
361    } else {
362      start += 2;
363    }
364  }
365}
366
367 
368
369int
370write_file_and_section_headers(int fd, 
371                               openmcl_image_file_header *file_header,
372                               openmcl_image_section_header* section_headers,
373                               int nsections,
374                               off_t *header_pos)
375{
376  *header_pos = seek_to_next_page(fd);
377
378  if (LSEEK (fd, *header_pos, SEEK_SET) < 0) {
379    return errno;
380  }
381  if (write(fd, file_header, sizeof(*file_header)) != sizeof(*file_header)) {
382    return errno;
383  }
384  if (write(fd, section_headers, sizeof(section_headers[0])*nsections)
385      != (sizeof(section_headers[0])*nsections)) {
386    return errno;
387  }
388  return 0;
389}
390 
391natural
392writebuf(int fd, char *bytes, natural n)
393{
394  natural remain = n, this_size;
395  signed_natural result;
396
397  while (remain) {
398    this_size = remain;
399    if (this_size > INT_MAX) {
400      this_size = INT_MAX;
401    }
402    result = write(fd, bytes, this_size);
403    if (result < 0) {
404      return errno;
405    }
406    bytes += result;
407
408    remain -= result;
409  }
410  return 0;
411}
412
413OSErr
414save_application(unsigned fd, Boolean egc_was_enabled)
415{
416  openmcl_image_file_header fh;
417  openmcl_image_section_header sections[NUM_IMAGE_SECTIONS];
418  openmcl_image_file_trailer trailer;
419  area *areas[NUM_IMAGE_SECTIONS], *a;
420  int i, err;
421  off_t header_pos, eof_pos;
422#if WORD_SIZE == 64
423  off_t image_data_pos;
424  signed_natural section_data_delta;
425#endif
426
427  areas[0] = nilreg_area; 
428  areas[1] = active_dynamic_area;
429  areas[2] = readonly_area;
430  areas[3] = managed_static_area;
431  areas[4] = static_cons_area;
432  for (i = 0; i < NUM_IMAGE_SECTIONS; i++) {
433    a = areas[i];
434    sections[i].code = a->code;
435    sections[i].area = NULL;
436    sections[i].memory_size  = a->active - a->low;
437    if (a == active_dynamic_area) {
438      sections[i].static_dnodes = tenured_area->static_dnodes;
439    } else {
440      sections[i].static_dnodes = 0;
441    }
442  }
443  fh.sig0 = IMAGE_SIG0;
444  fh.sig1 = IMAGE_SIG1;
445  fh.sig2 = IMAGE_SIG2;
446  fh.sig3 = IMAGE_SIG3;
447  fh.timestamp = time(NULL);
448  CANONICAL_IMAGE_BASE(&fh) = IMAGE_BASE_ADDRESS;
449  ACTUAL_IMAGE_BASE(&fh) = image_base;
450  fh.nsections = NUM_IMAGE_SECTIONS;
451  fh.abi_version=ABI_VERSION_CURRENT;
452#if WORD_SIZE == 64
453  fh.section_data_offset_high = 0;
454  fh.section_data_offset_low = 0;
455#else
456  fh.pad0[0] = fh.pad0[1] = 0;
457  fh.pad1[0] = fh.pad1[1] = fh.pad1[2] = fh.pad1[3] = 0;
458#endif
459  fh.flags = PLATFORM;
460
461#if WORD_SIZE == 64
462  image_data_pos = seek_to_next_page(fd);
463#else
464  err = write_file_and_section_headers(fd, &fh, sections, NUM_IMAGE_SECTIONS, &header_pos);
465  if (err) {
466    return err;
467  }
468#endif
469
470  /*
471    Coerce macptrs to dead_macptrs.
472  */
473 
474  prepare_to_write_dynamic_space(active_dynamic_area);
475
476  {
477    area *g0_area = g1_area->younger;
478
479    /* Save GC config */
480    lisp_global(LISP_HEAP_THRESHOLD) = lisp_heap_gc_threshold;
481    lisp_global(G0_THRESHOLD) = g0_area->threshold;
482    lisp_global(G1_THRESHOLD) = g1_area->threshold;
483    lisp_global(G2_THRESHOLD) = g2_area->threshold;
484    lisp_global(EGC_ENABLED) = (LispObj)egc_was_enabled;
485  }
486  /*
487    lisp_global(GC_NUM) and lisp_global(FWDNUM) are persistent,
488    as is DELETED_STATIC_PAIRS.
489    Nothing else is even meaningful at this point.
490  */
491  for (i = MIN_KERNEL_GLOBAL; i < 0; i++) {
492    switch (i) {
493    case FWDNUM:
494    case GC_NUM:
495    case STATIC_CONSES:
496    case WEAK_GC_METHOD:
497    case LISP_HEAP_THRESHOLD:
498    case EGC_ENABLED:
499    case G0_THRESHOLD:
500    case G1_THRESHOLD:
501    case G2_THRESHOLD:
502      break;
503    default:
504      lisp_global(i) = 0;
505    }
506  }
507
508  for (i = 0; i < NUM_IMAGE_SECTIONS; i++) {
509    natural n;
510    a = areas[i];
511    seek_to_next_page(fd);
512    n = sections[i].memory_size;
513    if (writebuf(fd, a->low, n)) {
514        return errno;
515    }
516  }
517
518#if WORD_SIZE == 64
519  seek_to_next_page(fd);
520  section_data_delta = -((LSEEK(fd,0,SEEK_CUR)+sizeof(fh)+sizeof(sections)) -
521                         image_data_pos);
522  fh.section_data_offset_high = (int)(section_data_delta>>32L);
523  fh.section_data_offset_low = (unsigned)section_data_delta;
524  err =  write_file_and_section_headers(fd, &fh, sections, NUM_IMAGE_SECTIONS, &header_pos);
525  if (err) {
526    return err;
527  } 
528#endif
529
530  trailer.sig0 = IMAGE_SIG0;
531  trailer.sig1 = IMAGE_SIG1;
532  trailer.sig2 = IMAGE_SIG2;
533  eof_pos = LSEEK(fd, 0, SEEK_CUR) + sizeof(trailer);
534  trailer.delta = (int) (header_pos-eof_pos);
535  if (write(fd, &trailer, sizeof(trailer)) == sizeof(trailer)) {
536#ifndef WINDOWS
537    fsync(fd);
538#endif
539    close(fd);
540    return 0;
541  } 
542  i = errno;
543  close(fd);
544  return i;
545}
546     
547
548
549
Note: See TracBrowser for help on using the repository browser.