Beatmup::AlignedMemory Class Reference

Aligned memory buffer. More...

#include <memory.h>

Public Member Functions
	AlignedMemory ()
	AlignedMemory (size_t size, size_t align=DEFAULT_ALIGNMENT)
	AlignedMemory (size_t size, int value, size_t align=DEFAULT_ALIGNMENT)
	~AlignedMemory ()
AlignedMemory &	operator= (AlignedMemory &&)
void *	operator() ()
const void *	operator() () const
template<typename datatype >
datatype *	ptr (int offset=0)
template<typename datatype >
const datatype *	ptr (int offset=0) const
template<typename datatype >
datatype &	at (int offset)
template<typename datatype >
const datatype &	at (int offset) const
unsigned char	operator[] (int offset) const
	operator bool () const
void	free ()
	Frees the allocated memory. More...

Static Public Member Functions
static uint64_t	available ()
	Returns the size of available (free) operating memory in bytes. More...
static uint64_t	total ()
	Returns the size of total operating memory in bytes. More...

Static Public Attributes
static const size_t	DEFAULT_ALIGNMENT = 8
	default number of bytes to align the address More...

Private Member Functions
	AlignedMemory (const AlignedMemory &)=delete

Private Attributes
void *	rawAddr
void *	alignAddr

Detailed Description

Aligned memory buffer.

Definition at line 27 of file memory.h.

Constructor & Destructor Documentation

AlignedMemory() [1/4]

Beatmup::AlignedMemory::AlignedMemory ( const AlignedMemory &  )

privatedelete

AlignedMemory() [2/4]

Beatmup::AlignedMemory::AlignedMemory ( )

inline

Definition at line 35 of file memory.h.

: rawAddr(nullptr), alignAddr(nullptr) {}

AlignedMemory() [3/4]

AlignedMemory::AlignedMemory	(	size_t	size,
		size_t	align = DEFAULT_ALIGNMENT
	)

Definition at line 70 of file memory.cpp.

                                                      {
#ifdef BEATMUP_DEBUG
    DebugAssertion::check(size > 0, "Trying to allocate zero memory");
    BEATMUP_DEBUG_I("Allocating %lu Kbytes (%lu MB free)...", (unsigned long)(size / 1024), (unsigned long)(available() / 1048576));
#endif
    rawAddr = malloc(size + align);
    alignAddr = reinterpret_cast<void*>(
            reinterpret_cast<std::uintptr_t>(rawAddr) + (align - reinterpret_cast<std::uintptr_t>(rawAddr) % align)
    );
}

AlignedMemory() [4/4]

AlignedMemory::AlignedMemory	(	size_t	size,
		int	value,
		size_t	align = DEFAULT_ALIGNMENT
	)

Definition at line 82 of file memory.cpp.

                                                                : AlignedMemory(size, align) {
    memset(alignAddr, value, size);
}

~AlignedMemory()

AlignedMemory::~AlignedMemory

(

)

Definition at line 87 of file memory.cpp.

                              {
    if (rawAddr)
        std::free(rawAddr);
}

Member Function Documentation

operator=()

AlignedMemory & AlignedMemory::operator=

(

AlignedMemory &&

other

)

Definition at line 93 of file memory.cpp.

                                                             {
    if (rawAddr)
        std::free(rawAddr);
    rawAddr = other.rawAddr;
    alignAddr = other.alignAddr;
    other.rawAddr = nullptr;
    other.alignAddr = nullptr;
    return *this;
}

operator()() [1/2]

void* Beatmup::AlignedMemory::operator() ( )

inline

Definition at line 42 of file memory.h.

{ return alignAddr; }

operator()() [2/2]

const void* Beatmup::AlignedMemory::operator() ( ) const

inline

Definition at line 44 of file memory.h.

{ return alignAddr; }

ptr() [1/2]

template<typename datatype >

datatype* Beatmup::AlignedMemory::ptr ( int  offset = 0 )

inline

Definition at line 46 of file memory.h.

                                                                         {
            return static_cast<datatype*>(alignAddr) + offset;
        }

ptr() [2/2]

template<typename datatype >

const datatype* Beatmup::AlignedMemory::ptr ( int  offset = 0 ) const

inline

Definition at line 50 of file memory.h.

                                                                                     {
            return static_cast<const datatype*>(alignAddr) + offset;
        }

at() [1/2]

template<typename datatype >

datatype& Beatmup::AlignedMemory::at ( int  offset )

inline

Definition at line 54 of file memory.h.

                                                                    {
            return *(static_cast<datatype*>(alignAddr) + offset);
        }

at() [2/2]

template<typename datatype >

const datatype& Beatmup::AlignedMemory::at ( int  offset ) const

inline

Definition at line 58 of file memory.h.

                                                                                {
            return *(static_cast<datatype*>(alignAddr) + offset);
        }

operator[]()

unsigned char Beatmup::AlignedMemory::operator[] ( int  offset ) const

inline

Definition at line 62 of file memory.h.

{ return at<unsigned char>(offset); }

operator bool()

Beatmup::AlignedMemory::operator bool ( ) const

inline

Definition at line 64 of file memory.h.

{ return rawAddr != nullptr; }

free()

void AlignedMemory::free

(

)

Frees the allocated memory.

Definition at line 104 of file memory.cpp.

                         {
    if (rawAddr) {
        std::free(rawAddr);
        rawAddr = nullptr;
        alignAddr = nullptr;
    }
}

available()

uint64_t AlignedMemory::available ( )

static

Returns the size of available (free) operating memory in bytes.

Definition at line 43 of file memory.cpp.

                                  {
#if BEATMUP_PLATFORM_WINDOWS
    MEMORYSTATUSEX status;
    status.dwLength = sizeof(status);
    GlobalMemoryStatusEx(&status);
    return status.ullAvailPhys;
#else
    struct sysinfo info;
    sysinfo(&info);
    return info.freeram * info.mem_unit;
#endif
}

total()

uint64_t AlignedMemory::total ( )

static

Returns the size of total operating memory in bytes.

Definition at line 56 of file memory.cpp.

                              {
#if BEATMUP_PLATFORM_WINDOWS
    MEMORYSTATUSEX status;
    status.dwLength = sizeof(status);
    GlobalMemoryStatusEx(&status);
    return status.ullTotalPhys;
#else
    struct sysinfo info;
    sysinfo(&info);
    return info.totalram * info.mem_unit;
#endif
}

Member Data Documentation

rawAddr

void* Beatmup::AlignedMemory::rawAddr

private

Definition at line 29 of file memory.h.

alignAddr

void* Beatmup::AlignedMemory::alignAddr

private

Definition at line 30 of file memory.h.

DEFAULT_ALIGNMENT

const size_t AlignedMemory::DEFAULT_ALIGNMENT = 8

static

default number of bytes to align the address

Definition at line 33 of file memory.h.

---

The documentation for this class was generated from the following files:

• core/memory.h
• core/memory.cpp