source: release/1.4/source/lisp-kernel/image.c @ 13075

Last change on this file since 13075 was 13075, checked in by rme, 10 years ago

Merge trunk changes r13066 through r13067.
(copyright notices)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.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
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  default:
233    return;
234   
235  }
236  LSEEK(fd, pos+advance, SEEK_SET);
237}
238
239LispObj
240load_openmcl_image(int fd, openmcl_image_file_header *h)
241{
242  LispObj image_nil = 0;
243  area *a;
244  if (find_openmcl_image_file_header(fd, h)) {
245    int i, nsections = h->nsections;
246    openmcl_image_section_header sections[nsections], *sect=sections;
247    LispObj bias = image_base - ACTUAL_IMAGE_BASE(h);
248#if (WORD_SIZE== 64)
249    signed_natural section_data_delta = 
250      ((signed_natural)(h->section_data_offset_high) << 32L) | h->section_data_offset_low;
251#endif
252
253    if (read (fd, sections, nsections*sizeof(openmcl_image_section_header)) !=
254        nsections * sizeof(openmcl_image_section_header)) {
255      return 0;
256    }
257#if WORD_SIZE == 64
258    LSEEK(fd, section_data_delta, SEEK_CUR);
259#endif
260    for (i = 0; i < nsections; i++, sect++) {
261      load_image_section(fd, sect);
262      a = sect->area;
263      if (a == NULL) {
264        return 0;
265      }
266    }
267
268    for (i = 0, sect = sections; i < nsections; i++, sect++) {
269      a = sect->area;
270      switch(sect->code) {
271      case AREA_STATIC:
272        nilreg_area = a;
273#ifdef PPC
274#ifdef PPC64
275        image_nil = ptr_to_lispobj(a->low + (1024*4) + sizeof(lispsymbol) + fulltag_misc);
276#else
277        image_nil = (LispObj)(a->low + 8 + 8 + (1024*4) + fulltag_nil);
278#endif
279#endif
280#ifdef X86
281#ifdef X8664
282        image_nil = (LispObj)(a->low) + (1024*4) + fulltag_nil;
283#else
284        image_nil = (LispObj)(a->low) + (1024*4) + fulltag_cons;
285#endif
286#endif
287        set_nil(image_nil);
288        if (bias) {
289          relocate_area_contents(a, bias);
290        }
291        make_dynamic_heap_executable(a->low, a->active);
292        add_area_holding_area_lock(a);
293        break;
294       
295      case AREA_READONLY:
296        readonly_area = a;
297        add_area_holding_area_lock(a);
298        break;
299      }
300    }
301    for (i = 0, sect = sections; i < nsections; i++, sect++) {
302      a = sect->area;
303      switch(sect->code) {
304      case AREA_MANAGED_STATIC:
305        if (bias) {
306          relocate_area_contents(a, bias);
307        }
308        managed_static_area = a;
309        add_area_holding_area_lock(a);
310        break;
311      case AREA_DYNAMIC:
312        if (bias) {
313          relocate_area_contents(a, bias);
314        }
315        resize_dynamic_heap(a->active, lisp_heap_gc_threshold);
316        xMakeDataExecutable(a->low, a->active - a->low);
317        break;
318      }
319    }
320  }
321  return image_nil;
322}
323 
324void
325prepare_to_write_dynamic_space()
326{
327  area *a = active_dynamic_area;
328  LispObj
329    *start = (LispObj *)(a->low),
330    *end = (LispObj *) (a->active),
331    x1;
332  int tag, subtag, element_count;
333
334  while (start < end) {
335    x1 = *start;
336    tag = fulltag_of(x1);
337    if (immheader_tag_p(tag)) {
338      subtag = header_subtag(x1);
339      if (subtag == subtag_macptr) {
340        if ((start[1] >= (natural)0x10000) && (start[1] < (natural)-0x10000)) {
341          /* Leave small pointers alone */
342          *start = make_header(subtag_dead_macptr,header_element_count(x1));
343        }
344      }
345      start = (LispObj *)skip_over_ivector((natural)start, x1);
346    } else if (nodeheader_tag_p(tag)) {
347      element_count = header_element_count(x1) | 1;
348      start += (element_count+1);
349    } else {
350      start += 2;
351    }
352  }
353}
354
355 
356
357int
358write_file_and_section_headers(int fd, 
359                               openmcl_image_file_header *file_header,
360                               openmcl_image_section_header* section_headers,
361                               int nsections,
362                               off_t *header_pos)
363{
364  *header_pos = seek_to_next_page(fd);
365
366  if (LSEEK (fd, *header_pos, SEEK_SET) < 0) {
367    return errno;
368  }
369  if (write(fd, file_header, sizeof(*file_header)) != sizeof(*file_header)) {
370    return errno;
371  }
372  if (write(fd, section_headers, sizeof(section_headers[0])*nsections)
373      != (sizeof(section_headers[0])*nsections)) {
374    return errno;
375  }
376  return 0;
377}
378 
379natural
380writebuf(int fd, char *bytes, natural n)
381{
382  natural remain = n, this_size;
383  signed_natural result;
384
385  while (remain) {
386    this_size = remain;
387    if (this_size > INT_MAX) {
388      this_size = INT_MAX;
389    }
390    result = write(fd, bytes, this_size);
391    if (result < 0) {
392      return errno;
393    }
394    bytes += result;
395
396    remain -= result;
397  }
398  return 0;
399}
400
401OSErr
402save_application(unsigned fd, Boolean egc_was_enabled)
403{
404  openmcl_image_file_header fh;
405  openmcl_image_section_header sections[NUM_IMAGE_SECTIONS];
406  openmcl_image_file_trailer trailer;
407  area *areas[NUM_IMAGE_SECTIONS], *a;
408  int i, err;
409  off_t header_pos, eof_pos;
410#if WORD_SIZE == 64
411  off_t image_data_pos;
412  signed_natural section_data_delta;
413#endif
414
415  areas[0] = nilreg_area; 
416  areas[1] = active_dynamic_area;
417  areas[2] = readonly_area;
418  areas[3] = managed_static_area;
419  for (i = 0; i < NUM_IMAGE_SECTIONS; i++) {
420    a = areas[i];
421    sections[i].code = a->code;
422    sections[i].area = NULL;
423    sections[i].memory_size  = a->active - a->low;
424    if (a == active_dynamic_area) {
425      sections[i].static_dnodes = tenured_area->static_dnodes;
426    } else {
427      sections[i].static_dnodes = 0;
428    }
429  }
430  fh.sig0 = IMAGE_SIG0;
431  fh.sig1 = IMAGE_SIG1;
432  fh.sig2 = IMAGE_SIG2;
433  fh.sig3 = IMAGE_SIG3;
434  fh.timestamp = time(NULL);
435  CANONICAL_IMAGE_BASE(&fh) = IMAGE_BASE_ADDRESS;
436  ACTUAL_IMAGE_BASE(&fh) = image_base;
437  fh.nsections = NUM_IMAGE_SECTIONS;
438  fh.abi_version=ABI_VERSION_CURRENT;
439#if WORD_SIZE == 64
440  fh.section_data_offset_high = 0;
441  fh.section_data_offset_low = 0;
442#else
443  fh.pad0[0] = fh.pad0[1] = 0;
444  fh.pad1[0] = fh.pad1[1] = fh.pad1[2] = fh.pad1[3] = 0;
445#endif
446  fh.flags = PLATFORM;
447
448#if WORD_SIZE == 64
449  image_data_pos = seek_to_next_page(fd);
450#else
451  err = write_file_and_section_headers(fd, &fh, sections, NUM_IMAGE_SECTIONS, &header_pos);
452  if (err) {
453    return err;
454  }
455#endif
456
457  /*
458    Coerce macptrs to dead_macptrs.
459  */
460 
461  prepare_to_write_dynamic_space(active_dynamic_area);
462
463  {
464    area *g0_area = g1_area->younger;
465
466    /* Save GC config */
467    lisp_global(LISP_HEAP_THRESHOLD) = lisp_heap_gc_threshold;
468    lisp_global(G0_THRESHOLD) = g0_area->threshold;
469    lisp_global(G1_THRESHOLD) = g1_area->threshold;
470    lisp_global(G2_THRESHOLD) = g2_area->threshold;
471    lisp_global(EGC_ENABLED) = (LispObj)egc_was_enabled;
472  }
473  /*
474    lisp_global(GC_NUM) and lisp_global(FWDNUM) are persistent,
475    as is DELETED_STATIC_PAIRS.
476    Nothing else is even meaningful at this point.
477  */
478  for (i = MIN_KERNEL_GLOBAL; i < 0; i++) {
479    switch (i) {
480    case FWDNUM:
481    case GC_NUM:
482    case STATIC_CONSES:
483    case WEAK_GC_METHOD:
484    case LISP_HEAP_THRESHOLD:
485    case EGC_ENABLED:
486    case G0_THRESHOLD:
487    case G1_THRESHOLD:
488    case G2_THRESHOLD:
489      break;
490    default:
491      lisp_global(i) = 0;
492    }
493  }
494
495  for (i = 0; i < NUM_IMAGE_SECTIONS; i++) {
496    natural n;
497    a = areas[i];
498    seek_to_next_page(fd);
499    n = sections[i].memory_size;
500    if (writebuf(fd, a->low, n)) {
501        return errno;
502    }
503  }
504
505#if WORD_SIZE == 64
506  seek_to_next_page(fd);
507  section_data_delta = -((LSEEK(fd,0,SEEK_CUR)+sizeof(fh)+sizeof(sections)) -
508                         image_data_pos);
509  fh.section_data_offset_high = (int)(section_data_delta>>32L);
510  fh.section_data_offset_low = (unsigned)section_data_delta;
511  err =  write_file_and_section_headers(fd, &fh, sections, NUM_IMAGE_SECTIONS, &header_pos);
512  if (err) {
513    return err;
514  } 
515#endif
516
517  trailer.sig0 = IMAGE_SIG0;
518  trailer.sig1 = IMAGE_SIG1;
519  trailer.sig2 = IMAGE_SIG2;
520  eof_pos = LSEEK(fd, 0, SEEK_CUR) + sizeof(trailer);
521  trailer.delta = (int) (header_pos-eof_pos);
522  if (write(fd, &trailer, sizeof(trailer)) == sizeof(trailer)) {
523#ifndef WINDOWS
524    fsync(fd);
525#endif
526    close(fd);
527    return 0;
528  } 
529  i = errno;
530  close(fd);
531  return i;
532}
533     
534
535
536
Note: See TracBrowser for help on using the repository browser.