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

Containment Domains API v0.1 (C++) More...

#include <vector>

Go to the source code of this file.

Classes

struct  cd::CDNameT
 A type to uniquely name a CD in the tree. More...
 
class  cd::SoftMemErrInfo
 Interface to soft memory error information. More...
 
class  cd::DegradedMemErrInfo
 Interface to degraded memory error information. More...
 
struct  cd::SysErrT
 Type for specifying errors and failure. More...
 
class  cd::RegenObject
 Interface for specifying regeneration functions for preserve/restore. More...
 
class  cd::CDHandle
 An object that provides a handle to a specific CD instance. More...
 
class  cd::CDEvent
 An object that provides an event identifier to a non-blocking CD runtime call. More...
 
class  CDInternalPtr
 A class that represents the interface to the internal implementation of an actual CD. More...
 
class  RecoverObject
 Recovery method that can be inherited and specialized by user. More...
 

Namespaces

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

Enumerations

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

Functions

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

Detailed Description

Containment Domains API v0.1 (C++)

Author
Kyushick Lee, Jinsuk Chung, Song Zhang, Seong-Lyong Gong, Derong Liu, Mattan Erez
Date
March 2014