/** @file DX1Collector.cpp * * @author Roland Conybeare, Dec 2025 **/ #include "Allocator.hpp" #include "arena/IAllocator_DArena.hpp" #include "xo/gc/DX1Collector.hpp" #include "xo/gc/DX1CollectorIterator.hpp" #include "generation.hpp" #include "object_age.hpp" #include #include #include #include #include #include // for ::getpagesize() namespace xo { using xo::mm::AAllocator; using xo::facet::typeseq; using xo::facet::with_facet; namespace mm { #ifdef NOT_USING constexpr std::uint64_t CollectorConfig::gen_mult() const { return 1ul << arena_config_.header_size_bits_; } #endif #ifdef NOT_USING constexpr std::uint64_t CollectorConfig::tseq_mult() const { return 1ul << (gen_bits_ + arena_config_.header_size_bits_); } #endif // ----- GCRunState ----- GCRunState::GCRunState(generation gc_upto) : gc_upto_{gc_upto} {} GCRunState GCRunState::gc_not_running() { return GCRunState(generation(0)); } GCRunState GCRunState::gc_upto(generation g) { return GCRunState(generation(g + 1)); } // ----- DX1Collector ----- using size_type = xo::mm::DX1Collector::size_type; DX1Collector::DX1Collector(const CollectorConfig & cfg) : config_{cfg} { assert(config_.arena_config_.header_.size_bits_ + config_.arena_config_.header_.age_bits_ + config_.arena_config_.header_.tseq_bits_ <= 64); size_t page_z = getpagesize(); /* 1MB reserved address space enough for up to 128k distinct types. * In this case don't want to use hugepages since actual #of types * likely << .size/8 */ object_types_ = DArena::map( ArenaConfig{ .name_ = "x1-object-types", .size_ = cfg.object_types_z_, .hugepage_z_ = page_z, .store_header_flag_ = false}); for (uint32_t igen = 0, ngen = cfg.n_generation_; igen < ngen; ++igen) { space_storage_[0][igen] = DArena::map(cfg.arena_config_); space_storage_[1][igen] = DArena::map(cfg.arena_config_); space_[role::to_space()][igen] = &space_storage_[0][igen]; space_[role::from_space()][igen] = &space_storage_[1][igen]; } for (uint32_t igen = cfg.n_generation_; igen < c_max_generation; ++igen) { space_[role::to_space()][igen] = nullptr; space_[role::from_space()][igen] = nullptr; } } bool DX1Collector::contains(role r, const void * addr) const noexcept { for (generation gi{0}; gi < config_.n_generation_; ++gi) { const DArena * arena = get_space(r, gi); if (arena->contains(addr)) return true; } return false; } AllocError DX1Collector::last_error() const noexcept { // TODO: // need to adjust here if runtime errors // encountered during gc. return get_space(role::to_space(), generation::nursery())->last_error_; } namespace { size_type accumulate_total_aux(const DX1Collector & d, size_t (DArena::* get_stat_fn)() const) noexcept { size_t z = (d.object_types_.*get_stat_fn)(); for (role ri : role::all()) { for (generation gj{0}; gj < d.config_.n_generation_; ++gj) { const DArena * arena = d.get_space(ri, gj); assert(arena); z += (arena->*get_stat_fn)(); } } return z; } } size_type DX1Collector::reserved_total() const noexcept { return accumulate_total_aux(*this, &DArena::reserved); } size_type DX1Collector::size_total() const noexcept { return committed_total(); } size_type DX1Collector::committed_total() const noexcept { return accumulate_total_aux(*this, &DArena::committed); } size_type DX1Collector::available_total() const noexcept { return accumulate_total_aux(*this, &DArena::available); } size_type DX1Collector::allocated_total() const noexcept { return accumulate_total_aux(*this, &DArena::allocated); } size_type DX1Collector::header2size(header_type hdr) const noexcept { uint32_t z = config_.arena_config_.header_.size(hdr); return z; } object_age DX1Collector::header2age(header_type hdr) const noexcept { uint32_t age = config_.arena_config_.header_.age(hdr); assert(age < c_max_object_age); return object_age(age); } uint32_t DX1Collector::header2tseq(header_type hdr) const noexcept { uint32_t tseq = config_.arena_config_.header_.tseq(hdr); return tseq; } bool DX1Collector::is_forwarding_header(header_type hdr) const noexcept { /** forwarding pointer encoded as sentinel tseq **/ return config_.arena_config_.header_.is_forwarding_tseq(hdr); } bool DX1Collector::is_type_installed(typeseq tseq) const noexcept { if (object_types_.committed() < sizeof(AGCObject) * (tseq.seqno() + 1)) return false; AGCObject * v = reinterpret_cast(object_types_.lo_); void * vtable = *(void **)&(v[tseq.seqno()]); return (vtable != nullptr); } bool DX1Collector::install_type(const AGCObject & meta) noexcept { typeseq tseq = meta._typeseq(); bool ok = object_types_.expand(sizeof(AGCObject) * (tseq.seqno() + 1)); if (!ok) return false; AGCObject * v = reinterpret_cast(object_types_.lo_); /* explicitly copying vtable pointer here */ std::memcpy((void*)&(v[tseq.seqno()]), (void*)&meta, sizeof(AGCObject)); return true; } void DX1Collector::add_gc_root(typeseq tseq, Opaque * root) noexcept { (void)tseq; (void)root; } void DX1Collector::request_gc(generation upto) noexcept { if (gc_blocked_ > 0) { if (gc_pending_upto_ < upto) { this->gc_pending_upto_ = upto; } /* intend collecting later */ } else { this->execute_gc(upto); } } void DX1Collector::execute_gc(generation upto) noexcept { scope log(XO_DEBUG(true), xtag("upto", upto)); //auto t0 = std::chrono::steady_clock::now(); log && log("step 0a : [STUB] snapshot alloc state"); log && log("step 0b : [STUB] scan for object statistics"); log && log("step 1 : swap from/to roles"); this->swap_roles(upto); log && log("step 2a : copy roots"); this->copy_roots(upto); log && log("step 2b : [STUB] copy pinned"); log && log("step 3a : [STUB] run destructors"); log && log("step 3b : [STUB] keep reachable weak pointers"); log && log("step 4 : [STUB] cleanup"); } void DX1Collector::swap_roles(generation upto) noexcept { for (generation g = generation{0}; g < upto; ++g) { std::swap(space_[role::to_space()][g], space_[role::from_space()][g]); } } void DX1Collector::copy_roots(generation upto) noexcept { scope log(XO_DEBUG(true), "STUB", xtag("upto", upto)); } auto DX1Collector::alloc(typeseq t, size_type z) noexcept -> value_type { return with_facet::mkobj(new_space()).alloc(t, z); } auto DX1Collector::super_alloc(typeseq t, size_type z) noexcept -> value_type { return with_facet::mkobj(new_space()).super_alloc(t, z); } auto DX1Collector::sub_alloc(size_type z, bool complete) noexcept -> value_type { return with_facet::mkobj(new_space()).sub_alloc(z, complete); } auto DX1Collector::alloc_copy(value_type src) noexcept -> value_type { return with_facet::mkobj(new_space()).alloc_copy(src); } bool DX1Collector::expand(size_type z) noexcept { if (with_facet::mkobj(to_space(generation{0})).expand(z)) return with_facet::mkobj(from_space(generation{0})).expand(z); return false; } AllocInfo DX1Collector::alloc_info(value_type mem) const noexcept { for (role ri : role::all()) { for (generation gj{0}; gj < config_.n_generation_; ++gj) { const DArena * arena = this->get_space(ri, gj); assert(arena); if (arena->contains(mem)) { return arena->alloc_info(mem); } } } // deliberately attempt on nursery to-space, to capture error info + return sentinel return this->get_space(role::to_space(), generation{0})->alloc_info(mem); } DX1CollectorIterator DX1Collector::begin() const noexcept { scope log(XO_DEBUG(false)); const DArena * arena = get_space(role::to_space(), generation{0}); return DX1CollectorIterator(this, generation{0}, generation{config_.n_generation_}, arena->begin(), arena->end()); } DX1CollectorIterator DX1Collector::end() const noexcept { scope log(XO_DEBUG(false)); generation gen_hi = generation{config_.n_generation_}; /** valid iterator for end points to end of last DArena. * otherwise will interfere with working compare * (since invalid iterators are incomparable) **/ const DArena * arena = get_space(role::to_space(), generation(config_.n_generation_ - 1)); DArenaIterator arena_end = arena->end(); return DX1CollectorIterator(this, gen_hi, gen_hi, arena_end, arena_end); } void DX1Collector::reverse_roles(generation g) noexcept { assert(g < config_.n_generation_); std::swap(space_[0][g], space_[1][g]); } void DX1Collector::clear() noexcept { for (role ri : role::all()) { for (generation gj{0}; gj < config_.n_generation_; ++gj) { DArena * arena = this->get_space(ri, gj); assert(arena); arena->clear(); } } } } /*namespace mm*/ } /*namespace xo*/ /* end DX1Collector.cpp */