ucommon/cpr.h File Reference

Runtime functions. More...

#include <ucommon/platform.h>

Include dependency graph for cpr.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void * cpr_memalloc (size_t size)
 Portable memory allocation helper function.
void * cpr_memassign (size_t size, caddr_t address, size_t known)
 Portable memory placement helper function.
void cpr_memswap (void *mem1, void *mem2, size_t size)
 Portable swap code.
void cpr_runtime_error (char *text)
 Function to handle runtime errors.
uint32_t lsb_getlong (uint8_t *b)
uint16_t lsb_getshort (uint8_t *b)
void lsb_setlong (uint8_t *b, uint32_t v)
void lsb_setshort (uint8_t *b, uint16_t v)
uint32_t msb_getlong (uint8_t *b)
uint16_t msb_getshort (uint8_t *b)
void msb_setlong (uint8_t *b, uint32_t v)
void msb_setshort (uint8_t *b, uint16_t v)
void * operator new (size_t size, caddr_t address, size_t known)
 A placement new operator where we know the allocated size.
void * operator new (size_t size, caddr_t address)
 A placement new operator where we assume the size of memory is good.
void * operator new (size_t size, size_t extra)
 Overdraft new to allocate extra memory for object from heap.


Detailed Description

Runtime functions.

This includes common runtime library functions we may need portably.

Author:
David Sugar <dyfet@gnutelephony.org>

Definition in file cpr.h.


Function Documentation

void* cpr_memalloc ( size_t  size  ) 

Portable memory allocation helper function.

Handles out of heap error as a runtime error.

Parameters:
size of memory block to allocate from heap.
Returns:
memory address of allocated heap space.

Referenced by operator new().

void* cpr_memassign ( size_t  size,
caddr_t  address,
size_t  known 
)

Portable memory placement helper function.

This is used to process "placement" new operators where a new object is constructed over a pre-allocated area of memory. This handles invalid values through runtime error.

Parameters:
size of object being constructed.
address where the object is being placed.
known size of the location we are constructing the object in.

Referenced by operator new().

void cpr_memswap ( void *  mem1,
void *  mem2,
size_t  size 
)

Portable swap code.

Parameters:
mem1 to swap.
mem2 to swap.
size of swap area.

Referenced by ucommon::swap().

void cpr_runtime_error ( char *  text  ) 

Function to handle runtime errors.

When using the standard C library, runtime errors are handled by a simple abort. When using the stdc++ library with stdexcept, then std::runtime_error will be thrown.

Parameters:
text of runtime error.

void* operator new ( size_t  size,
caddr_t  address,
size_t  known 
) [inline]

A placement new operator where we know the allocated size.

We find out how much memory is needed by the new and can prevent the object from exceeding the available space we are placing the object.

Parameters:
size of memory needed for object.
address where to place object.
known size of location we are placing object.
Returns:
memory we placed object.

Definition at line 155 of file cpr.h.

References cpr_memassign().

Here is the call graph for this function:

void* operator new ( size_t  size,
caddr_t  address 
) [inline]

A placement new operator where we assume the size of memory is good.

We construct the object at a specified place in memory which we assume is valid for our needs.

Parameters:
size of memory needed for object.
address where to place object.
Returns:
memory we placed object.

Definition at line 142 of file cpr.h.

References cpr_memassign().

Here is the call graph for this function:

void* operator new ( size_t  size,
size_t  extra 
) [inline]

Overdraft new to allocate extra memory for object from heap.

This is used for objects that must have a known class size but store extra data behind the class. The last member might be an unsized or 0 element array, and the actual size needed from the heap is hence not the size of the class itself but is known by the routine allocating the object.

Parameters:
size of object.
extra heap space needed for data.

Definition at line 131 of file cpr.h.

References cpr_memalloc().

Here is the call graph for this function:


Generated on 14 Aug 2013 for UCommon by  doxygen 1.4.7