vm/data_heap.cpp

   1 #include "master.hpp"
   2
   3 factor::zone nursery;
   4
   5 namespace factor
   6 {
   7
   8 /* Set by the -securegc command line argument */
   9 bool secure_gc;
  10
  11 /* new objects are allocated here */
  12 VM_C_API zone nursery;
  13
  14 /* GC is off during heap walking */
  15 bool gc_off;
  16
  17 data_heap *data;
  18
  19 cell init_zone(zone *z, cell size, cell start)
  20 {
  21         z->size = size;
  22         z->start = z->here = start;
  23         z->end = start + size;
  24         return z->end;
  25 }
  26
  27 void init_card_decks()
  28 {
  29         cell start = align(data->seg->start,deck_size);
  30         allot_markers_offset = (cell)data->allot_markers - (start >> card_bits);
  31         cards_offset = (cell)data->cards - (start >> card_bits);
  32         decks_offset = (cell)data->decks - (start >> deck_bits);
  33 }
  34
  35 data_heap *alloc_data_heap(cell gens,
  36         cell young_size,
  37         cell aging_size,
  38         cell tenured_size)
  39 {
  40         young_size = align(young_size,deck_size);
  41         aging_size = align(aging_size,deck_size);
  42         tenured_size = align(tenured_size,deck_size);
  43
  44         data_heap *data = (data_heap *)safe_malloc(sizeof(data_heap));
  45         data->young_size = young_size;
  46         data->aging_size = aging_size;
  47         data->tenured_size = tenured_size;
  48         data->gen_count = gens;
  49
  50         cell total_size;
  51         if(data->gen_count == 2)
  52                 total_size = young_size + 2 * tenured_size;
  53         else if(data->gen_count == 3)
  54                 total_size = young_size + 2 * aging_size + 2 * tenured_size;
  55         else
  56         {
  57                 fatal_error("Invalid number of generations",data->gen_count);
  58                 return NULL; /* can't happen */
  59         }
  60
  61         total_size += deck_size;
  62
  63         data->seg = alloc_segment(total_size);
  64
  65         data->generations = (zone *)safe_malloc(sizeof(zone) * data->gen_count);
  66         data->semispaces = (zone *)safe_malloc(sizeof(zone) * data->gen_count);
  67
  68         cell cards_size = total_size >> card_bits;
  69         data->allot_markers = (cell *)safe_malloc(cards_size);
  70         data->allot_markers_end = data->allot_markers + cards_size;
  71
  72         data->cards = (cell *)safe_malloc(cards_size);
  73         data->cards_end = data->cards + cards_size;
  74
  75         cell decks_size = total_size >> deck_bits;
  76         data->decks = (cell *)safe_malloc(decks_size);
  77         data->decks_end = data->decks + decks_size;
  78
  79         cell alloter = align(data->seg->start,deck_size);
  80
  81         alloter = init_zone(&data->generations[data->tenured()],tenured_size,alloter);
  82         alloter = init_zone(&data->semispaces[data->tenured()],tenured_size,alloter);
  83
  84         if(data->gen_count == 3)
  85         {
  86                 alloter = init_zone(&data->generations[data->aging()],aging_size,alloter);
  87                 alloter = init_zone(&data->semispaces[data->aging()],aging_size,alloter);
  88         }
  89
  90         if(data->gen_count >= 2)
  91         {
  92                 alloter = init_zone(&data->generations[data->nursery()],young_size,alloter);
  93                 alloter = init_zone(&data->semispaces[data->nursery()],0,alloter);
  94         }
  95
  96         if(data->seg->end - alloter > deck_size)
  97                 critical_error("Bug in alloc_data_heap",alloter);
  98
  99         return data;
 100 }
 101
 102 data_heap *grow_data_heap(data_heap *data, cell requested_bytes)
 103 {
 104         cell new_tenured_size = (data->tenured_size * 2) + requested_bytes;
 105
 106         return alloc_data_heap(data->gen_count,
 107                 data->young_size,
 108                 data->aging_size,
 109                 new_tenured_size);
 110 }
 111
 112 void dealloc_data_heap(data_heap *data)
 113 {
 114         dealloc_segment(data->seg);
 115         free(data->generations);
 116         free(data->semispaces);
 117         free(data->allot_markers);
 118         free(data->cards);
 119         free(data->decks);
 120         free(data);
 121 }
 122
 123 void clear_cards(cell from, cell to)
 124 {
 125         /* NOTE: reverse order due to heap layout. */
 126         card *first_card = addr_to_card(data->generations[to].start);
 127         card *last_card = addr_to_card(data->generations[from].end);
 128         memset(first_card,0,last_card - first_card);
 129 }
 130
 131 void clear_decks(cell from, cell to)
 132 {
 133         /* NOTE: reverse order due to heap layout. */
 134         card_deck *first_deck = addr_to_deck(data->generations[to].start);
 135         card_deck *last_deck = addr_to_deck(data->generations[from].end);
 136         memset(first_deck,0,last_deck - first_deck);
 137 }
 138
 139 void clear_allot_markers(cell from, cell to)
 140 {
 141         /* NOTE: reverse order due to heap layout. */
 142         card *first_card = addr_to_allot_marker((object *)data->generations[to].start);
 143         card *last_card = addr_to_allot_marker((object *)data->generations[from].end);
 144         memset(first_card,invalid_allot_marker,last_card - first_card);
 145 }
 146
 147 void reset_generation(cell i)
 148 {
 149         zone *z = (i == data->nursery() ? &nursery : &data->generations[i]);
 150
 151         z->here = z->start;
 152         if(secure_gc)
 153                 memset((void*)z->start,69,z->size);
 154 }
 155
 156 /* After garbage collection, any generations which are now empty need to have
 157 their allocation pointers and cards reset. */
 158 void reset_generations(cell from, cell to)
 159 {
 160         cell i;
 161         for(i = from; i <= to; i++)
 162                 reset_generation(i);
 163
 164         clear_cards(from,to);
 165         clear_decks(from,to);
 166         clear_allot_markers(from,to);
 167 }
 168
 169 void set_data_heap(data_heap *data_)
 170 {
 171         data = data_;
 172         nursery = data->generations[data->nursery()];
 173         init_card_decks();
 174         clear_cards(data->nursery(),data->tenured());
 175         clear_decks(data->nursery(),data->tenured());
 176         clear_allot_markers(data->nursery(),data->tenured());
 177 }
 178
 179 void init_data_heap(cell gens,
 180         cell young_size,
 181         cell aging_size,
 182         cell tenured_size,
 183         bool secure_gc_)
 184 {
 185         set_data_heap(alloc_data_heap(gens,young_size,aging_size,tenured_size));
 186         secure_gc = secure_gc_;
 187         init_data_gc();
 188 }
 189
 190 /* Size of the object pointed to by a tagged pointer */
 191 cell object_size(cell tagged)
 192 {
 193         if(immediate_p(tagged))
 194                 return 0;
 195         else
 196                 return untagged_object_size(untag<object>(tagged));
 197 }
 198
 199 /* Size of the object pointed to by an untagged pointer */
 200 cell untagged_object_size(object *pointer)
 201 {
 202         return align8(unaligned_object_size(pointer));
 203 }
 204
 205 /* Size of the data area of an object pointed to by an untagged pointer */
 206 cell unaligned_object_size(object *pointer)
 207 {
 208         switch(pointer->h.hi_tag())
 209         {
 210         case ARRAY_TYPE:
 211                 return array_size((array*)pointer);
 212         case BIGNUM_TYPE:
 213                 return array_size((bignum*)pointer);
 214         case BYTE_ARRAY_TYPE:
 215                 return array_size((byte_array*)pointer);
 216         case STRING_TYPE:
 217                 return string_size(string_capacity((string*)pointer));
 218         case TUPLE_TYPE:
 219                 return tuple_size(untag<tuple_layout>(((tuple *)pointer)->layout));
 220         case QUOTATION_TYPE:
 221                 return sizeof(quotation);
 222         case WORD_TYPE:
 223                 return sizeof(word);
 224         case FLOAT_TYPE:
 225                 return sizeof(boxed_float);
 226         case DLL_TYPE:
 227                 return sizeof(dll);
 228         case ALIEN_TYPE:
 229                 return sizeof(alien);
 230         case WRAPPER_TYPE:
 231                 return sizeof(wrapper);
 232         case CALLSTACK_TYPE:
 233                 return callstack_size(untag_fixnum(((callstack *)pointer)->length));
 234         default:
 235                 critical_error("Invalid header",(cell)pointer);
 236                 return 0; /* can't happen */
 237         }
 238 }
 239
 240 PRIMITIVE(size)
 241 {
 242         box_unsigned_cell(object_size(dpop()));
 243 }
 244
 245 /* The number of cells from the start of the object which should be scanned by
 246 the GC. Some types have a binary payload at the end (string, word, DLL) which
 247 we ignore. */
 248 cell binary_payload_start(object *pointer)
 249 {
 250         switch(pointer->h.hi_tag())
 251         {
 252         /* these objects do not refer to other objects at all */
 253         case FLOAT_TYPE:
 254         case BYTE_ARRAY_TYPE:
 255         case BIGNUM_TYPE:
 256         case CALLSTACK_TYPE:
 257                 return 0;
 258         /* these objects have some binary data at the end */
 259         case WORD_TYPE:
 260                 return sizeof(word) - sizeof(cell) * 3;
 261         case ALIEN_TYPE:
 262                 return sizeof(cell) * 3;
 263         case DLL_TYPE:
 264                 return sizeof(cell) * 2;
 265         case QUOTATION_TYPE:
 266                 return sizeof(quotation) - sizeof(cell) * 2;
 267         case STRING_TYPE:
 268                 return sizeof(string);
 269         /* everything else consists entirely of pointers */
 270         case ARRAY_TYPE:
 271                 return array_size<array>(array_capacity((array*)pointer));
 272         case TUPLE_TYPE:
 273                 return tuple_size(untag<tuple_layout>(((tuple *)pointer)->layout));
 274         case WRAPPER_TYPE:
 275                 return sizeof(wrapper);
 276         default:
 277                 critical_error("Invalid header",(cell)pointer);
 278                 return 0; /* can't happen */
 279         }
 280 }
 281
 282 /* Push memory usage statistics in data heap */
 283 PRIMITIVE(data_room)
 284 {
 285         dpush(tag_fixnum((data->cards_end - data->cards) >> 10));
 286         dpush(tag_fixnum((data->decks_end - data->decks) >> 10));
 287
 288         growable_array a;
 289
 290         cell gen;
 291         for(gen = 0; gen < data->gen_count; gen++)
 292         {
 293                 zone *z = (gen == data->nursery() ? &nursery : &data->generations[gen]);
 294                 a.add(tag_fixnum((z->end - z->here) >> 10));
 295                 a.add(tag_fixnum((z->size) >> 10));
 296         }
 297
 298         a.trim();
 299         dpush(a.elements.value());
 300 }
 301
 302 /* A heap walk allows useful things to be done, like finding all
 303 references to an object for debugging purposes. */
 304 cell heap_scan_ptr;
 305
 306 /* Disables GC and activates next-object ( -- obj ) primitive */
 307 void begin_scan()
 308 {
 309         heap_scan_ptr = data->generations[data->tenured()].start;
 310         gc_off = true;
 311 }
 312
 313 void end_scan()
 314 {
 315         gc_off = false;
 316 }
 317
 318 PRIMITIVE(begin_scan)
 319 {
 320         begin_scan();
 321 }
 322
 323 cell next_object()
 324 {
 325         if(!gc_off)
 326                 general_error(ERROR_HEAP_SCAN,F,F,NULL);
 327
 328         if(heap_scan_ptr >= data->generations[data->tenured()].here)
 329                 return F;
 330
 331         object *obj = (object *)heap_scan_ptr;
 332         heap_scan_ptr += untagged_object_size(obj);
 333         return tag_dynamic(obj);
 334 }
 335
 336 /* Push object at heap scan cursor and advance; pushes f when done */
 337 PRIMITIVE(next_object)
 338 {
 339         dpush(next_object());
 340 }
 341
 342 /* Re-enables GC */
 343 PRIMITIVE(end_scan)
 344 {
 345         gc_off = false;
 346 }
 347
 348 template<typename T> void each_object(T &functor)
 349 {
 350         begin_scan();
 351         cell obj;
 352         while((obj = next_object()) != F)
 353                 functor(tagged<object>(obj));
 354         end_scan();
 355 }
 356
 357 namespace
 358 {
 359
 360 struct word_counter {
 361         cell count;
 362         word_counter() : count(0) {}
 363         void operator()(tagged<object> obj) { if(obj.type_p(WORD_TYPE)) count++; }
 364 };
 365
 366 struct word_accumulator {
 367         growable_array words;
 368         word_accumulator(int count) : words(count) {}
 369         void operator()(tagged<object> obj) { if(obj.type_p(WORD_TYPE)) words.add(obj.value()); }
 370 };
 371
 372 }
 373
 374 cell find_all_words()
 375 {
 376         word_counter counter;
 377         each_object(counter);
 378         word_accumulator accum(counter.count);
 379         each_object(accum);
 380         accum.words.trim();
 381         return accum.words.elements.value();
 382 }
 383
 384 }