source: branches/win64/lisp-kernel/image.c @ 8707

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