AllocationStats.h

Go to the documentation of this file.

/*
 * This file is a part of the Biology project by eons LLC.
 * Biology (aka Develop Biology) is a framework for approaching software
 * development from a natural sciences perspective.
 *
 * Copyright (C) 2026 Séon O'Shannon & eons LLC
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "bio/common/macro/LanguageMacros.h"
#include "bio/common/macro/OptimizeMacros.h"
#include <cstddef>
 
//@formatter:off
#if BIO_CPP_VERSION < 11
    #include <stdint.h>
#else
    #include <cstdint>
#endif
//@formatter:on
 
namespace bio {
 
struct AllocationCounters
{
    uint64_t totalBytesRequested;
 
    uint64_t containerConstructions;
    uint64_t containerCopyConstructions;
    uint64_t containerDestructions;
    uint64_t containerExpansions;
    uint64_t containerBackingAllocations;
    uint64_t containerBackingReallocations;
    uint64_t containerCapacityRequested;
    uint64_t containerCapacityExpanded;
    uint64_t containerBytesRequested;
    uint64_t containerBytesExpanded;
    uint64_t containerPeakCapacity;
    uint64_t containerPeakBytes;
 
    uint64_t physicalSymmetryConstructions;
    uint64_t chemicalSymmetryConstructions;
    uint64_t classPropertyRegistrations;
    uint64_t classTypeRegistrations;
    uint64_t classArchetypeConstructions;
};
 
//@formatter:off
#if BIO_ALLOCATION_STATS
//@formatter:on
 
AllocationCounters GetAllocationCounters();
 
void ResetAllocationCounters();
 
void RecordContainerConstruction(
    uint64_t capacity,
    std::size_t stepSize
);
 
void RecordContainerCopyConstruction();
 
void RecordContainerDestruction();
 
void RecordContainerBackingAllocation(
    uint64_t capacity,
    std::size_t stepSize
);
 
void RecordContainerExpansion(
    uint64_t capacity,
    std::size_t stepSize,
    bool reallocation = true
);
 
void RecordPhysicalSymmetryConstruction();
 
void RecordChemicalSymmetryConstruction();
 
void RecordClassPropertyRegistration();
 
void RecordClassTypeRegistration();
 
void RecordClassArchetypeConstruction();
 
//@formatter:off
#else
//@formatter:on
 
// Counters disabled (default, BIO_ALLOCATION_STATS=0): every Record* inlines to
// nothing -- the optimizer elides each call site, removing the shared atomic
// counters and the cross-thread false sharing they cause under concurrent
// construction. GetAllocationCounters() returns a zeroed snapshot.
inline AllocationCounters GetAllocationCounters() { return AllocationCounters(); }
inline void ResetAllocationCounters() {}
inline void RecordContainerConstruction(uint64_t, std::size_t) {}
inline void RecordContainerCopyConstruction() {}
inline void RecordContainerDestruction() {}
inline void RecordContainerBackingAllocation(uint64_t, std::size_t) {}
inline void RecordContainerExpansion(uint64_t, std::size_t, bool = true) {}
inline void RecordPhysicalSymmetryConstruction() {}
inline void RecordChemicalSymmetryConstruction() {}
inline void RecordClassPropertyRegistration() {}
inline void RecordClassTypeRegistration() {}
inline void RecordClassArchetypeConstruction() {}
 
//@formatter:off
#endif
//@formatter:on
 
} //bio namespace