veil_datatypes.h File Reference


Detailed Description

Define all Veil public datatypes.

     Author:       Marc Munro
     Copyright (c) 2005 - 2011 Marc Munro
     License:      BSD

Definition in file veil_datatypes.h.

#include "utils/hsearch.h"
#include "storage/lwlock.h"

Include dependency graph for veil_datatypes.h:

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

Go to the source code of this file.

Data Structures

struct  MemChunk
 Chunks provide a linked list of dynamically allocated shared memory segments, with the most recently allocated chunk at the tail. More...
struct  Object
 General purpose object-type. More...
struct  ShmemCtl
 The ShmemCtl structure is the first object allocated from the first chunk of shared memory in context 0. More...
struct  Int4Var
 Subtype of Object for storing simple int4 values. More...
struct  Range
 Subtype of Object for storing range values. More...
struct  Bitmap
 Subtype of Object for storing bitmaps. More...
struct  BitmapRef
 Subtype of Object for storing bitmap refs. More...
struct  BitmapArray
 Subtype of Object for storing bitmap arrays. More...
struct  BitmapHash
 Subtype of Object for storing bitmap hashes. More...
struct  Int4Array
 Subtype of Object for storing arrays of integers. More...
struct  VarEntry
 A Veil variable. More...
struct  veil_variable_t
 Describes a veil shared or session variable. More...

Defines

#define VEIL_DATATYPES   1
 Prevent this header from being included multiple times.
#define VEIL_DEBUG   1
 Enables various debugging constructs, such as canaries, in code and data structures.
#define DBG_CANARY   0xca96ca96
 Value to be set in sacrificial "canary" fields.
#define DBG_CANARY_ENTRY   int32 canary;
 Defines a canary element in a data structure.
#define DBG_ELEMS_ENTRY   int32 dbgelems;
 Field to record the size of an array so that its canary element can be found.
#define DBG_SET_ELEMS(x, y)   (x).dbgelems = y
 Code to records the size of an array so that its canary element can be found.
#define DBG_SET_CANARY(x)   (x).canary = DBG_CANARY
 Code to initialise a canary.
#define DBG_TEST_CANARY(x)
 Code to test for a canary having been overwritten.
#define EMPTY   1
 Base size for an array containing a canary.
#define DBG_SET_TRAILER(x, y)   (x).y[(x).dbgelems] = DBG_CANARY;
 Set a trailing canary in an array.
#define DBG_SET_TRAILERP(x, y)   (x).y[(x).dbgelems] = (void *) DBG_CANARY;
 Set a trailing canary in an array (using a void pointer).
#define DBG_TEST_TRAILER(x, y)
 Test the trailing canary in an array.
#define DBG_CHECK_INDEX(x, i)
 Check whether an array index is in bounds.
#define HASH_KEYLEN   60
 The key length for veil hash types.
#define BITZERO(x)   (x & 0xffffffe0)
 Gives the bitmask index for the bitzero value of a Bitmap.
#define BITMAX(x)   (x | 0x1f)
 Gives the bitmask index for the bitmax value of a bitmap.
#define BITSET_ELEM(x)   (x >> 5)
 Gives the index of a bit within the array of 32-bit words that comprise the bitmap.
#define BITSET_BIT(x)   (x & 0x1f)
 Gives the index into bitmasks for the bit specified in x.
#define ARRAYELEMS(min, max)   (((max - BITZERO(min)) >> 5) + 1)
 Gives the number of array elements in a Bitmap that runs from element min to element max.
#define MIN(a, b)   ((a < b)? a: b)
 Return the smaller of a or b.

Enumerations

enum  ObjType {
  OBJ_UNDEFINED = 0, OBJ_SHMEMCTL, OBJ_INT4, OBJ_RANGE,
  OBJ_BITMAP, OBJ_BITMAP_ARRAY, OBJ_BITMAP_HASH, OBJ_BITMAP_REF,
  OBJ_INT4_ARRAY, OBJ_UNDEFINED = 0, OBJ_SHMEMCTL, OBJ_INT4,
  OBJ_RANGE, OBJ_BITMAP, OBJ_BITMAP_ARRAY, OBJ_BITMAP_HASH,
  OBJ_BITMAP_REF, OBJ_INT4_ARRAY
}
 Describes the type of an Object record or one of its subtypes.


Define Documentation

#define VEIL_DEBUG   1

Enables various debugging constructs, such as canaries, in code and data structures.

If such debugging is required, define VEIL_DEBUG in the make invocation, eg: "make VEIL_DEBUG=1".

Definition at line 27 of file veil_datatypes.h.

#define DBG_CANARY   0xca96ca96

Value to be set in sacrificial "canary" fields.

If this value is not as expected, the canary has been killed by something inappropriately stomping on memory.

Definition at line 36 of file veil_datatypes.h.

#define DBG_TEST_CANARY (  ) 

Value:

if ((x).canary != DBG_CANARY) {\
        elog(ERROR, "canary fault"); }
Code to test for a canary having been overwritten.

Definition at line 63 of file veil_datatypes.h.

Referenced by vl_BitmapSetbit(), vl_ClearBitmapArray(), and vl_NewBitmap().

#define EMPTY   1

Base size for an array containing a canary.

This is zero if VEIL_DEBUG is not defined, when this is defined arrays will be one element longer to allow a canary to be placed at the end of the array.

Definition at line 71 of file veil_datatypes.h.

#define DBG_TEST_TRAILER ( x,
 ) 

Value:

if ((int) (x).y[(x).dbgelems] != DBG_CANARY) {      \
        elog(ERROR, "trailing canary fault"); }
Test the trailing canary in an array.

Definition at line 85 of file veil_datatypes.h.

Referenced by vl_BitmapSetbit(), and vl_NewBitmap().

#define DBG_CHECK_INDEX ( x,
 ) 

Value:

if (i >= (x).dbgelems) {\
        elog(ERROR, "Element index out of range %d", i); }
Check whether an array index is in bounds.

Definition at line 92 of file veil_datatypes.h.

Referenced by vl_BitmapSetbit().

#define BITZERO (  )     (x & 0xffffffe0)

Gives the bitmask index for the bitzero value of a Bitmap.

This is part of the "normalisation" process for bitmap ranges. This process allows unlike bitmaps to be more easily compared by forcing bitmap indexes to be normalised around 32-bit word boundaries. Eg, 2 bitmaps with domains 1 to 50 and 3 to 55, will have identical bit patterns for bits 3 to 50.

Parameters:
x The bitzero value of a bitmap
Returns:
The bitmask index representing x.

Definition at line 214 of file veil_datatypes.h.

Referenced by vl_BitmapSetbit().

#define BITMAX (  )     (x | 0x1f)

Gives the bitmask index for the bitmax value of a bitmap.

See BITZERO() for more information.

Parameters:
x The bitmax value of a bitmap
Returns:
The bitmask index representing x.

Definition at line 224 of file veil_datatypes.h.

#define BITSET_ELEM (  )     (x >> 5)

Gives the index of a bit within the array of 32-bit words that comprise the bitmap.

Parameters:
x The bit in question
Returns:
The array index of the bit.

Definition at line 234 of file veil_datatypes.h.

Referenced by vl_BitmapSetbit().

#define BITSET_BIT (  )     (x & 0x1f)

Gives the index into bitmasks for the bit specified in x.

Parameters:
x The bit in question
Returns:
The bitmask index

Definition at line 243 of file veil_datatypes.h.

Referenced by vl_BitmapSetbit().

#define ARRAYELEMS ( min,
max   )     (((max - BITZERO(min)) >> 5) + 1)

Gives the number of array elements in a Bitmap that runs from element min to element max.

Parameters:
min 
max 
Returns:
The number of elements in the bitmap.

Definition at line 254 of file veil_datatypes.h.

Referenced by deserialise_one_bitmap(), serialise_bitmap(), serialise_bitmap_array(), serialise_bitmap_hash(), serialise_one_bitmap(), vl_ClearBitmap(), vl_ClearBitmapArray(), and vl_NewBitmap().

#define MIN ( a,
 )     ((a < b)? a: b)

Return the smaller of a or b.

Note that expressions a and b may be evaluated more than once.

Parameters:
a 
b 
Returns:
The smaller value of a or b.

Definition at line 266 of file veil_datatypes.h.


Generated on Mon Sep 12 15:26:47 2011 for Veil by  doxygen 1.5.6