defs.hpp

Go to the documentation of this file.

// Copyright 2023 Lawrence Livermore National Security, LLC and other Metall
// Project Developers. See the top-level COPYRIGHT file for details.
//
// SPDX-License-Identifier: (Apache-2.0 OR MIT)
 
 
#ifndef METALL_DEFS_HPP
#define METALL_DEFS_HPP
 
#ifndef METALL_MAX_CAPACITY
#define METALL_MAX_CAPACITY (1ULL << 47ULL)
#endif
 
#ifndef METALL_DEFAULT_CAPACITY
#if defined(__linux__)
#define METALL_DEFAULT_CAPACITY (1ULL << 43ULL)
#else
#define METALL_DEFAULT_CAPACITY (1ULL << 42ULL)
#endif
#endif
 
#ifdef DOXYGEN_SKIP
#define METALL_VERBOSE_SYSTEM_SUPPORT_WARNING
 
#define METALL_USE_SORTED_BIN
 
#define METALL_FREE_SMALL_OBJECT_SIZE_HINT
#endif
 
// --------------------
// Macros for the default segment storage
// --------------------
 
#ifndef METALL_SEGMENT_BLOCK_SIZE
#define METALL_SEGMENT_BLOCK_SIZE (1ULL << 28ULL)
#endif
 
#ifdef DOXYGEN_SKIP
#define METALL_DISABLE_FREE_FILE_SPACE
#endif
 
// --------------------
// Macros for the segment allocator
// --------------------
 
#ifdef DOXYGEN_SKIP
#define METALL_DISABLE_CONCURRENCY
#endif
 
// --------------------
// Macros for the object cache
// --------------------
 
#ifdef DOXYGEN_SKIP
#define METALL_DISABLE_OBJECT_CACHE
#endif
 
#ifdef DOXYGEN_SKIP
#define METALL_NUM_OBJECT_CACHES 2
#endif
 
#if defined(METALL_NUM_OBJECT_CACHES) && METALL_NUM_OBJECT_CACHES <= 0
#warning "METALL_NUM_OBJECT_CACHES must be > 0. This value is ignored."
#undef METALL_NUM_OBJECT_CACHES
#endif
 
#ifndef METALL_NUM_CACHES_PER_CPU
#define METALL_NUM_CACHES_PER_CPU 2
#endif
 
#if METALL_NUM_CACHES_PER_CPU <= 0
#warning "METALL_NUM_CACHES_PER_CPU must be > 0."
#undef METALL_NUM_CACHES_PER_CPU
#define METALL_NUM_CACHES_PER_CPU 2
#endif
 
#ifndef METALL_MAX_PER_CPU_CACHE_SIZE
#define METALL_MAX_PER_CPU_CACHE_SIZE (1ULL << 20ULL)
#endif
 
// --------------------
// Deprecated macros
 
#ifdef METALL_MAX_SEGMENT_SIZE
#warning \
    "METALL_MAX_SEGMENT_SIZE is deprecated. Use METALL_MAX_CAPACITY instead."
#endif
 
#ifdef METALL_DEFAULT_VM_RESERVE_SIZE
#warning \
    "METALL_DEFAULT_VM_RESERVE_SIZE is deprecated. Use METALL_DEFAULT_CAPACITY instead."
#endif
 
#ifdef METALL_INITIAL_SEGMENT_SIZE
#warning \
    "METALL_INITIAL_SEGMENT_SIZE is deprecated. Use METALL_SEGMENT_BLOCK_SIZE instead."
#endif
 
#endif  // METALL_DEFS_HPP