Containment Domains C++ API  0.1
Containment Domains C++ API v0.1
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Groups Pages
Classes | Enumerations | Functions
cd Namespace Reference

Containment Domains namespace for global functions, types, and main interface. More...

Classes

class  CDEvent
 An object that provides an event identifier to a non-blocking CD runtime call. More...
 
class  CDHandle
 An object that provides a handle to a specific CD instance. More...
 
struct  CDNameT
 A type to uniquely name a CD in the tree. More...
 
class  DegradedMemErrInfo
 Interface to degraded memory error information. More...
 
class  RegenObject
 Interface for specifying regeneration functions for preserve/restore. More...
 
class  SoftMemErrInfo
 Interface to soft memory error information. More...
 
struct  SysErrT
 Type for specifying errors and failure. More...
 

Enumerations

enum  CDModeT { kStrict =0, kRelaxed }
 Type for specifying whether a CD is strict or relaxed. More...
 
enum  CDExecutionModeT { kExec =0, kReexec }
 Type for specifying whether the current CD is executing for the first time or is currently reexecuting as part of recovery. More...
 
enum  PreserveUseT { kUnsure =0, kReadOnly = 1, kReadWrite = 2 }
 Type to indicate whether preserved data is from read-only or potentially read/write application data. More...
 
enum  PGASUsageT { kShared = 0, kPotentiallyShared, kPrivatized, kPrivate }
 Different types of PGAS memory behavior for relaxed CDs. More...
 
enum  SysErrNameT {
  kOK =0, kSoftMem = 0b1, kDegradedMem = 0b01, kSoftComm = 0b001,
  kDegradedComm = 0b0001, kSoftComp = 0b00001, kDegradedResource =0b000001, kHardResource = 0b0000001,
  kFileSys = 0b00000001
}
 Type for specifying system errors and failure names. More...
 
enum  SysErrLocT {
  kOK =0, kIntraCore = 0b1, kCore = 0b01, kProc = 0b001,
  kNode = 0b0001, kModule = 0b00001, kCabinet = 0b000001, kCabinetGroup =0b0000001,
  kSystem = 0b00000001
}
 Type for specifying errors and failure location names. More...
 
enum  CDErrT { kOK =0, kAlreadyInit, kError }
 Type for specifying error return codes from an API call – signifies some failure of the API call itself, not a system failure. More...
 
enum  PreserveMechanismT { kCopy =0b001, kRef =0b010, kRegen =0b100 }
 Type for specifying preservation methods. More...
 

Functions

uint DeclareErrName (const char *name_string)
 Create a new error/failure type name. More...
 
CDErrT UndeclareErrName (uint error_name_id)
 Free a name that was created with DeclareErrorName() More...
 
uint DeclareErrLoc (const char *name_string)
 Create a new error/failure type name. More...
 
CDErrT UndeclareErrLoc (uint error_name_id) class SysErrInfo
 Free a name that was created with DeclareErrLoc() More...
 
CDHandleInit (bool collective=trueCDErrT *error=0)
 Initialize the CD runtime. More...
 
CDHandleGetRootCD ()
 Accessor function to root CD of the application. More...
 
CDHandleGetCurrentCD ()
 Accessor function to current active CD. More...
 
CDErrT SetCurrentCD (const CDHandle *cd)
 Accessor function for setting the current active CD. More...
 

Detailed Description

Containment Domains namespace for global functions, types, and main interface.

All user-visible CD API calls and definitions are under the CD namespace. Internal CD API implementation components are under a separate cd_internal namespace; the CDInternal class of namespace cd serves as an interface where necessary.