3 /* Size of the object pointed to by an untagged pointer */
4 template <typename Fixup> cell object::size(Fixup fixup) const {
6 return ((free_heap_block*)this)->size();
10 return align(array_size((array*)this), data_alignment);
12 return align(array_size((bignum*)this), data_alignment);
14 return align(array_size((byte_array*)this), data_alignment);
16 return align(string_size(string_capacity((string*)this)), data_alignment);
18 tuple_layout* layout = (tuple_layout*)fixup.translate_data(
19 untag<object>(((tuple*)this)->layout));
20 return align(tuple_size(layout), data_alignment);
23 return align(sizeof(quotation), data_alignment);
25 return align(sizeof(word), data_alignment);
27 return align(sizeof(boxed_float), data_alignment);
29 return align(sizeof(dll), data_alignment);
31 return align(sizeof(alien), data_alignment);
33 return align(sizeof(wrapper), data_alignment);
36 callstack_object_size(untag_fixnum(((callstack*)this)->length)),
39 critical_error("Invalid header in size", (cell)this);
40 return 0; /* can't happen */
44 inline cell object::size() const { return size(no_fixup()); }
46 /* The number of cells from the start of the object which should be scanned by
47 the GC. Some types have a binary payload at the end (string, word, DLL) which
49 template <typename Fixup> cell object::binary_payload_start(Fixup fixup) const {
54 /* these objects do not refer to other objects at all */
60 /* these objects have some binary data at the end */
62 return sizeof(word) - sizeof(cell);
64 return sizeof(cell) * 3;
66 return sizeof(cell) * 2;
68 return sizeof(quotation) - sizeof(cell);
70 return sizeof(string);
71 /* everything else consists entirely of pointers */
73 return array_size<array>(array_capacity((array*)this));
75 tuple_layout* layout = (tuple_layout*)fixup.translate_data(
76 untag<object>(((tuple*)this)->layout));
77 return tuple_size(layout);
80 return sizeof(wrapper);
82 critical_error("Invalid header in binary_payload_start", (cell)this);
83 return 0; /* can't happen */
87 inline cell object::binary_payload_start() const {
88 return binary_payload_start(no_fixup());
91 /* Slot visitors iterate over the slots of an object, applying a functor to
92 each one that is a non-immediate slot. The pointer is untagged first. The
93 functor returns a new untagged object pointer. The return value may or may not
95 however the new pointer receives the same tag before being stored back to the
98 Slots storing immediate values are left unchanged and the visitor does inspect
101 This is used by GC's copying, sweep and compact phases, and the implementation
102 of the become primitive.
104 Iteration is driven by visit_*() methods. Some of them define GC roots:
106 - visit_contexts() */
108 template <typename Fixup> struct slot_visitor {
112 slot_visitor<Fixup>(factor_vm* parent, Fixup fixup)
113 : parent(parent), fixup(fixup) {}
115 cell visit_pointer(cell pointer);
116 void visit_handle(cell* handle);
117 void visit_object_array(cell* start, cell* end);
118 void visit_slots(object* ptr, cell payload_start);
119 void visit_slots(object* ptr);
120 void visit_stack_elements(segment* region, cell* top);
121 void visit_data_roots();
122 void visit_bignum_roots();
123 void visit_callback_roots();
124 void visit_literal_table_roots();
126 void visit_callstack_object(callstack* stack);
127 void visit_callstack(context* ctx);
128 void visit_contexts();
129 void visit_code_block_objects(code_block* compiled);
130 void visit_embedded_literals(code_block* compiled);
131 void visit_sample_callstacks();
132 void visit_sample_threads();
135 template <typename Fixup>
136 cell slot_visitor<Fixup>::visit_pointer(cell pointer) {
137 if (immediate_p(pointer))
140 object* untagged = fixup.fixup_data(untag<object>(pointer));
141 return RETAG(untagged, TAG(pointer));
144 template <typename Fixup> void slot_visitor<Fixup>::visit_handle(cell* handle) {
145 *handle = visit_pointer(*handle);
148 template <typename Fixup>
149 void slot_visitor<Fixup>::visit_object_array(cell* start, cell* end) {
151 visit_handle(start++);
154 template <typename Fixup>
155 void slot_visitor<Fixup>::visit_slots(object* ptr, cell payload_start) {
156 cell* slot = (cell*)ptr;
157 cell* end = (cell*)((cell)ptr + payload_start);
161 visit_object_array(slot, end);
165 template <typename Fixup> void slot_visitor<Fixup>::visit_slots(object* obj) {
166 if (obj->type() == CALLSTACK_TYPE)
167 visit_callstack_object((callstack*)obj);
169 visit_slots(obj, obj->binary_payload_start(fixup));
172 template <typename Fixup>
173 void slot_visitor<Fixup>::visit_stack_elements(segment* region, cell* top) {
174 visit_object_array((cell*)region->start, top + 1);
177 template <typename Fixup> void slot_visitor<Fixup>::visit_data_roots() {
178 std::vector<cell*>::const_iterator iter =
179 parent->data_roots.begin();
180 std::vector<cell*>::const_iterator end =
181 parent->data_roots.end();
183 for (; iter < end; iter++) {
188 template <typename Fixup> void slot_visitor<Fixup>::visit_bignum_roots() {
189 std::vector<bignum**>::const_iterator iter =
190 parent->bignum_roots.begin();
191 std::vector<bignum**>::const_iterator end =
192 parent->bignum_roots.end();
194 for (; iter < end; iter++) {
195 bignum** ref = *iter;
196 *ref = (bignum*)fixup.fixup_data(*ref);
200 template <typename Fixup> struct callback_slot_visitor {
201 callback_heap* callbacks;
202 slot_visitor<Fixup>* visitor;
204 callback_slot_visitor(callback_heap* callbacks,
205 slot_visitor<Fixup>* visitor)
206 : callbacks(callbacks), visitor(visitor) {}
208 void operator()(code_block* stub) { visitor->visit_handle(&stub->owner); }
211 template <typename Fixup> void slot_visitor<Fixup>::visit_callback_roots() {
212 callback_slot_visitor<Fixup> callback_visitor(parent->callbacks, this);
213 parent->callbacks->each_callback(callback_visitor);
216 template <typename Fixup>
217 void slot_visitor<Fixup>::visit_literal_table_roots() {
218 std::map<code_block*, cell>* uninitialized_blocks =
219 &parent->code->uninitialized_blocks;
220 std::map<code_block*, cell>::const_iterator iter =
221 uninitialized_blocks->begin();
222 std::map<code_block*, cell>::const_iterator end = uninitialized_blocks->end();
224 std::map<code_block*, cell> new_uninitialized_blocks;
225 for (; iter != end; iter++) {
226 new_uninitialized_blocks.insert(
227 std::make_pair(iter->first, visit_pointer(iter->second)));
230 parent->code->uninitialized_blocks = new_uninitialized_blocks;
233 template <typename Fixup> void slot_visitor<Fixup>::visit_sample_callstacks() {
234 for (std::vector<cell>::iterator iter = parent->sample_callstacks.begin();
235 iter != parent->sample_callstacks.end(); ++iter) {
236 visit_handle(&*iter);
240 template <typename Fixup> void slot_visitor<Fixup>::visit_sample_threads() {
241 for (std::vector<profiling_sample>::iterator iter = parent->samples.begin();
242 iter != parent->samples.end(); ++iter) {
243 visit_handle(&iter->thread);
247 template <typename Fixup> void slot_visitor<Fixup>::visit_roots() {
248 visit_handle(&parent->true_object);
249 visit_handle(&parent->bignum_zero);
250 visit_handle(&parent->bignum_pos_one);
251 visit_handle(&parent->bignum_neg_one);
254 visit_bignum_roots();
255 visit_callback_roots();
256 visit_literal_table_roots();
257 visit_sample_callstacks();
258 visit_sample_threads();
260 visit_object_array(parent->special_objects,
261 parent->special_objects + special_object_count);
264 template <typename Fixup> struct call_frame_slot_visitor {
266 slot_visitor<Fixup>* visitor;
268 call_frame_slot_visitor(factor_vm* parent,
269 slot_visitor<Fixup>* visitor)
270 : parent(parent), visitor(visitor) {}
273 frame top -> [return address]
279 void operator()(void* frame_top, cell frame_size, code_block* owner,
281 cell return_address = owner->offset(addr);
283 code_block* compiled =
284 Fixup::translated_code_block_map ? owner
285 : visitor->fixup.translate_code(owner);
286 gc_info* info = compiled->block_gc_info();
288 FACTOR_ASSERT(return_address < compiled->size());
289 cell callsite = info->return_address_index(return_address);
290 if (callsite == (cell)-1)
294 std::cout << "call frame code block " << compiled << " with offset "
295 << return_address << std::endl;
297 cell* stack_pointer = (cell*)frame_top;
298 uint8_t* bitmap = info->gc_info_bitmap();
300 /* Subtract old value of base pointer from every derived pointer. */
301 for (cell spill_slot = 0; spill_slot < info->derived_root_count;
303 uint32_t base_pointer = info->lookup_base_pointer(callsite, spill_slot);
304 if (base_pointer != (uint32_t)-1) {
306 std::cout << "visiting derived root " << spill_slot
307 << " with base pointer " << base_pointer << std::endl;
309 stack_pointer[spill_slot] -= stack_pointer[base_pointer];
313 /* Update all GC roots, including base pointers. */
314 cell callsite_gc_roots = info->callsite_gc_roots(callsite);
316 for (cell spill_slot = 0; spill_slot < info->gc_root_count; spill_slot++) {
317 if (bitmap_p(bitmap, callsite_gc_roots + spill_slot)) {
319 std::cout << "visiting GC root " << spill_slot << std::endl;
321 visitor->visit_handle(stack_pointer + spill_slot);
325 /* Add the base pointers to obtain new derived pointer values. */
326 for (cell spill_slot = 0; spill_slot < info->derived_root_count;
328 uint32_t base_pointer = info->lookup_base_pointer(callsite, spill_slot);
329 if (base_pointer != (uint32_t)-1)
330 stack_pointer[spill_slot] += stack_pointer[base_pointer];
335 template <typename Fixup>
336 void slot_visitor<Fixup>::visit_callstack_object(callstack* stack) {
337 call_frame_slot_visitor<Fixup> call_frame_visitor(parent, this);
338 parent->iterate_callstack_object(stack, call_frame_visitor, fixup);
341 template <typename Fixup>
342 void slot_visitor<Fixup>::visit_callstack(context* ctx) {
343 call_frame_slot_visitor<Fixup> call_frame_visitor(parent, this);
344 parent->iterate_callstack(ctx, call_frame_visitor, fixup);
347 template <typename Fixup> void slot_visitor<Fixup>::visit_contexts() {
348 std::set<context*>::const_iterator begin = parent->active_contexts.begin();
349 std::set<context*>::const_iterator end = parent->active_contexts.end();
350 while (begin != end) {
351 context* ctx = *begin;
353 visit_stack_elements(ctx->datastack_seg, (cell*)ctx->datastack);
354 visit_stack_elements(ctx->retainstack_seg, (cell*)ctx->retainstack);
355 visit_object_array(ctx->context_objects,
356 ctx->context_objects + context_object_count);
357 visit_callstack(ctx);
362 template <typename Fixup> struct literal_references_visitor {
363 slot_visitor<Fixup>* visitor;
365 explicit literal_references_visitor(slot_visitor<Fixup>* visitor)
366 : visitor(visitor) {}
368 void operator()(instruction_operand op) {
369 if (op.rel_type() == RT_LITERAL)
370 op.store_value(visitor->visit_pointer(op.load_value()));
374 template <typename Fixup>
375 void slot_visitor<Fixup>::visit_code_block_objects(code_block* compiled) {
376 visit_handle(&compiled->owner);
377 visit_handle(&compiled->parameters);
378 visit_handle(&compiled->relocation);
381 template <typename Fixup>
382 void slot_visitor<Fixup>::visit_embedded_literals(code_block* compiled) {
383 if (!parent->code->uninitialized_p(compiled)) {
384 literal_references_visitor<Fixup> visitor(this);
385 compiled->each_instruction_operand(visitor);