SC::Globals Struct Reference

Customizable thread-local and global variables for memory handling. More...

#include <Globals.h>

Public Types
enum	Type {   Global = 0 ,   ThreadLocal = 1 }

Public Member Functions
	Globals (MemoryAllocator &allocator)

Static Public Member Functions
static void	init (Type type, GlobalSettings settings={})
	Initialized Globals for current thread. More...
static Globals *	push (Type type, Globals &globals)
	Sets Globals as current, saving previous one. More...
static Globals *	pop (Type type)
	Restores Globals previously replaced by a push. More...
static Globals &	get (Type type)
	Obtains current set of Globals. More...

Public Attributes
MemoryAllocator &	allocator

Detailed Description

Customizable thread-local and global variables for memory handling.

This class holds pointers to systems that must be globally available, like the memory allocator. It allows "stacking" different Globals through a push / pop mechanism, connecting them through a linked list. The Default allocator is automatically setup and uses standard malloc, realloc, free for allocations.

Note

Globals use no locking mechanism so they are thread-unsafe. Every method however requires a Globals::Type parameter that can be set to Globals::ThreadLocal to avoid such issues.

Example (Fixed Allocator):

    alignas(uint64_t) char stackMemory[256] = {0};
 
    FixedAllocator fixedAllocator = {stackMemory, sizeof(stackMemory)};
    Globals        globals        = {fixedAllocator};
    Globals::push(Globals::Global, globals);
    // ...
    Buffer& buffer = *Globals::get(Globals::Global).allocator.allocate<Buffer>();
    (void)buffer.append({"ASDF"}); // Allocates from stackMemory
    // ...
    Globals::pop(Globals::Global);

Example (Virtual Allocator):

    // Create a Virtual memory block that can expand up to 1 MB
    VirtualMemory virtualMemory;
    SC_TEST_EXPECT(virtualMemory.reserve(1024 * 1024));
 
    VirtualAllocator virtualAllocator = {virtualMemory};
    Globals          virtualGlobals   = {virtualAllocator};
    Globals::push(Globals::Global, virtualGlobals);
    // ...
    Buffer& buffer = *Globals::get(Globals::Global).allocator.allocate<Buffer>();
    (void)buffer.append({"ASDF"}); // Allocates from virtualMemory
    // ...
    Globals::pop(Globals::Global);

Member Enumeration Documentation

Type

enum SC::Globals::Type

Enumerator
Global	Shared globals (NOT thread-safe)
ThreadLocal	Thread-specific globals (separate copy for each thread)

Member Function Documentation

get()

static Globals & SC::Globals::get ( Type  type )

static

Obtains current set of Globals.

init()

static void SC::Globals::init ( Type  type, GlobalSettings  settings = {}  )

static

Initialized Globals for current thread.

Note

Each thread can use different GlobalSettings

pop()

static Globals * SC::Globals::pop ( Type  type )

static

Restores Globals previously replaced by a push.

Returns

Pointer to Globals that are no longer current (or nullptr if current is the Default Allocator)

push()

static Globals * SC::Globals::push ( Type  type, Globals &  globals  )

static

Sets Globals as current, saving previous one.

Returns

Pointer to Globals that have been replaced

---

The documentation for this struct was generated from the following file:

• Globals.h