clCorMetaData.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2012 OpenClovis Solutions Inc.  All Rights Reserved.
 *
 * This file is available  under  a  commercial  license  from  the
 * copyright  holder or the GNU General Public License Version 2.0.
 * 
 * The source code for  this program is not published  or otherwise 
 * divested of  its trade secrets, irrespective  of  what  has been 
 * deposited with the U.S. Copyright office.
 * 
 * This program is distributed in the  hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied  warranty  of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * For more  information, see  the file  COPYING provided with this
 * material.
 */
/*******************************************************************************
 * ModuleName  : cor                                                           
 * File        : clCorMetaData.h
 *******************************************************************************/

/*******************************************************************************
 * Description :                                                                
 *
 *  The file contains all the MetaData data structures.
 *
 *
 *****************************************************************************/

#ifndef _CL_COR_META_DATA_H_

#define _CL_COR_META_DATA_H_

#ifdef __cplusplus
    extern "C" {
#endif

#include <clCommon.h>
#include <clCntApi.h>
#include <clIocApi.h>
#include <clOsalApi.h>


/******************************************************************************
 *  Constant and Macro Definitions
 *****************************************************************************/

#define CL_COR_WTH_COOKIE_ID         CL_EO_COR_SERVER_COOKIE_ID+1  


#define CL_COR_VERSION_NO  0x0100
#define CL_COR_DEFAULT_MAX_SESSIONS      5

#define CL_COR_DEFAULT_MAX_RETRIES       3

#define CL_COR_DEFAULT_TIMEOUT           3000 

#define CL_COR_MAX_NAME_SZ              CL_MAX_NAME_LENGTH

#define CL_COR_NO_SAVE                 0
#define CL_COR_SAVE_PER_TXN            1   
#define CL_COR_PERIODIC_SAVE           2
#define CL_COR_DELTA_SAVE              3

#define CL_COR_UNKNOWN_ATTRIB  -1

#define CL_COR_CLI_STR_LEN     1024


#define CL_COR_VERSION_NO         0x0100
#define CL_COR_HANDLE_MAX_DEPTH       20
#define CL_COR_INVALID_MO_ID          -1
#define CL_COR_INVALID_MO_INSTANCE    -1
#define CL_COR_INVALID_SVC_ID         -1
#define CL_COR_SVC_ID_DEFAULT 0

#define CL_COR_CLASS_WILD_CARD     ((ClCorClassTypeT)0xFFFFFFFE)

#define CL_COR_INSTANCE_WILD_CARD  0xFFFFFFFE 
#define CL_COR_SVC_WILD_CARD       ((ClCorMOServiceIdT)0xFFFE)


#define CL_COR_CONT_ATTR_MAX_DEPTH     10

#define CL_COR_INVALID_ATTR_ID         -1

#define CL_COR_INVALID_ATTR_IDX        -1
#define CL_COR_ATTR_WILD_CARD          -2
#define CL_COR_INDEX_WILD_CARD         -2 

#define CL_COR_SIMPLE_TXN  NULL

#define CL_COR_OH_MAX_TYPES    16
#define CL_COR_OH_MAX_LEVELS   64

#define CL_COR_OH_MASK_END_MARKER   0xFF

#define CL_COR_ATTR_CONFIG          0x01000000

#define CL_COR_ATTR_RUNTIME         0x02000000

#define CL_COR_ATTR_OPERATIONAL     0x04000000

#define CL_COR_ATTR_WRITABLE        0x00010000

#define CL_COR_ATTR_INITIALIZED     0x00020000

#define CL_COR_ATTR_CACHED          0x00000100

#define CL_COR_ATTR_PERSISTENT      0x00000200

/******************************************************************************
 *  Data Types 
 *****************************************************************************/
        
typedef ClInt32T   ClCorClassTypeT;

typedef ClInt32T   ClCorAttrIdT;

typedef ClInt32T   ClCorInstanceIdT;

typedef ClUint32T  ClCorAttrFlagT;

typedef ClUint32T ClCorJobStatusT;

typedef     ClHandleT   ClCorBundleHandleT;
typedef     ClHandleT*  ClCorBundleHandlePtrT;


typedef enum ClCorType {
    
  CL_COR_INVALID_DATA_TYPE = -1,

  CL_COR_VOID,                                        

  CL_COR_INT8,                                        

  CL_COR_UINT8,                                       

  CL_COR_INT16,

  CL_COR_UINT16,                                      

  CL_COR_INT32,                                       

  CL_COR_UINT32,                                      

  CL_COR_INT64,                                       

  CL_COR_UINT64,                                      

  CL_COR_FLOAT,                                       

  CL_COR_DOUBLE,                                      

  CL_COR_COUNTER32,                                   

  CL_COR_COUNTER64,                                   

  CL_COR_SEQUENCE32                                  

} ClCorTypeT;

typedef enum ClCorAttrType { 

    CL_COR_MAX_TYPE = CL_COR_SEQUENCE32, 

    CL_COR_SIMPLE_ATTR,                                

    CL_COR_ARRAY_ATTR,                                 

    CL_COR_CONTAINMENT_ATTR,                           

    CL_COR_ASSOCIATION_ATTR,                           

    CL_COR_VIRTUAL_ATTR                               

} ClCorAttrTypeT ; 

typedef enum{ 
              CL_COR_ATTR_CMP_FLAG_INVALID = 0,
              CL_COR_ATTR_CMP_FLAG_VALUE_EQUAL_TO,
              CL_COR_ATTR_CMP_FLAG_VALUE_LESS_THAN,
              CL_COR_ATTR_CMP_FLAG_VALUE_LESS_OR_EQUALS,
              CL_COR_ATTR_CMP_FLAG_VALUE_GREATER_THAN,
              CL_COR_ATTR_CMP_FLAG_VALUE_GREATER_OR_EQUALS,
              CL_COR_ATTR_CMP_FLAG_MAX
            }ClCorAttrCmpFlagT;

typedef enum{ 
             CL_COR_ATTR_INVALID_OPTION = 0,
             CL_COR_ATTR_WALK_ALL_ATTR,
             CL_COR_ATTR_WALK_ONLY_MATCHED_ATTR,
             CL_COR_ATTR_WALK_MAX
            }ClCorAttrWalkOpT;

struct ClCorAttrValues{
       ClInt64T init;

       ClInt64T min;

       ClInt64T max;
};

typedef struct ClCorAttrValues ClCorAttrValuesT;

struct ClCorAttrAdditionalInfo{

       ClCorTypeT   arrDataType; 

       ClUint32T        maxElement;   

       ClCorClassTypeT  classId;       
       };
typedef struct ClCorAttrAdditionalInfo  ClCorAttrAdditionalInfoT;
struct ClCorAttrDef
       {
         ClCorAttrIdT  attrId;
         ClCorAttrTypeT attrType;
         /* union{ - NOTE: Struct made in place of Union becoz of IDL related issues.  */
         struct 
         {

                ClCorAttrValuesT simpleAttrVals;

                ClCorAttrAdditionalInfoT attrInfo; 
                 
        }u;                                      
         /*     }u; */
       };
typedef struct ClCorAttrDef ClCorAttrDefT;

typedef ClRcT (* ClCorClassAttrWalkFunc)(ClCorClassTypeT clsId, ClCorAttrDefT *attrDef, ClPtrT cookie);

typedef enum {
  CL_COR_OBJ_TYPE_SIMPLE,
  CL_COR_OBJ_TYPE_MO,
  CL_COR_OBJ_TYPE_MSO
} ClCorObjTypesT;

typedef enum {

    CL_COR_LOCK_OBJECT,
    CL_COR_LOCK_SUBTREE

} ClCorObjLockFlagsT;

typedef enum {
        CL_COR_MOTREE_WALK,
    CL_COR_MO_WALK,
    CL_COR_MSO_WALK,
        CL_COR_MO_SUBTREE_WALK,
        CL_COR_MSO_SUBTREE_WALK,
    CL_COR_MO_WALK_UP,
    CL_COR_MSO_WALK_UP

} ClCorObjWalkFlagsT;

typedef enum {
  CL_COR_MO_CLASS_GET,
  CL_COR_MSO_CLASS_GET
} ClCorMoIdClassGetFlagsT;

typedef ClPtrT ClCorObjectHandleT;

#define CL_COR_OBJ_HANDLE_NULL              NULL 

#define CL_COR_OBJ_HANDLE_INIT(objH) \
    do \
    { \
        if (objH != NULL) \
        { \
            ClUint16T size = 0; \
            ClRcT rc = CL_OK; \
            ClUint8T* tempHandle = (ClUint8T *) objH; \
            rc = clCorObjectHandleSizeGet(objH, &size); \
            if (rc != CL_OK) \
                return rc; \
            tempHandle += sizeof(ClUint16T); \
            memset((void *) tempHandle, 0, size - sizeof(ClUint16T)); \
        } \
    } while(0)

#define CL_COR_OBJ_HANDLE_ISNULL(objH) (objH == NULL)

typedef ClPtrT          ClCorTxnSessionIdT;

typedef ClPtrT          ClCorTxnIdT;

typedef ClUint32T       ClCorTxnJobIdT;

typedef enum {
    CL_COR_OP_RESERVED = 0,
    CL_COR_OP_CREATE = 0x1,
    CL_COR_OP_SET =    0x2,
    CL_COR_OP_DELETE = 0x4,
    CL_COR_OP_GET =    0x8,
    CL_COR_OP_CREATE_AND_SET = 0x10,
    CL_COR_OP_ALL = 
        (CL_COR_OP_CREATE |
        CL_COR_OP_SET     |
        CL_COR_OP_DELETE  | 
        CL_COR_OP_GET     |
        CL_COR_OP_CREATE_AND_SET)
} ClCorOpsT;

typedef enum ClCorTxnJobStatus
{
    CL_COR_TXN_JOB_PASS,
    CL_COR_TXN_JOB_FAIL
}ClCorTxnJobStatusT;

typedef enum {

    CL_COR_OBJ_CACHE_LOCAL = 0x1,           

    CL_COR_OBJ_CACHE_ONLY_ON_MASTER = 0x2, 

    CL_COR_OBJ_CACHE_ON_MASTER = 0x4,       

    CL_COR_OBJ_CACHE_GLOBAL = 0x8,          
    CL_COR_OBJ_CACHE_MAX = CL_COR_OBJ_CACHE_GLOBAL,
    CL_COR_OBJ_CACHE_MASK = 0xFF,

    CL_COR_OBJ_PERSIST = 0x100,

    CL_COR_OBJ_DO_NOT_PUBLISH = 0x200,

    CL_COR_OBJ_ALLOW_SUB_TREE_DELETE = 0x400,

    CL_COR_OBJ_FLAGS_ALL = (CL_COR_OBJ_CACHE_MASK |
                     CL_COR_OBJ_PERSIST    |
             CL_COR_OBJ_DO_NOT_PUBLISH |CL_COR_OBJ_ALLOW_SUB_TREE_DELETE)
} ClCorObjFlagsT;

#define CL_COR_OBJ_FLAGS_DEFAULT \
       (CL_COR_OBJ_CACHE_GLOBAL | CL_COR_OBJ_PERSIST | CL_COR_OBJ_ALLOW_SUB_TREE_DELETE)

typedef enum ClCorBundleOperationType {
    CL_COR_BUNDLE_TRANSACTIONAL = 1,
    CL_COR_BUNDLE_NON_TRANSACTIONAL
}ClCorBundleOperationTypeT;


typedef ClIocPhysicalAddressT ClCorAddrT; 

typedef ClCorAddrT *          ClCorAddrPtrT;

/*
 * This structure ClCorCommInfo contains the communication information for COR. Used for COR 
 * communication configuration.
 */ 
struct ClCorCommInfo {

  ClCorAddrT         addr;                         

  ClUint32T        timeout;                      

  ClUint16T        maxRetries;                   

  ClUint16T        maxSessions;                  

};

typedef struct ClCorCommInfo ClCorCommInfoT;
typedef ClCorCommInfoT*     ClCorCommInfoPtrT;

typedef enum {

  CL_COR_MO_PATH_ABSOLUTE = 0,     

  CL_COR_MO_PATH_RELATIVE,         

  CL_COR_MO_PATH_RELATIVE_TO_BASE,
 
  CL_COR_MO_PATH_QUALIFIER_MAX = CL_COR_MO_PATH_RELATIVE_TO_BASE

} ClCorMoPathQualifierT;

struct ClCorMOHandle {
  ClCorClassTypeT    type;

  ClCorInstanceIdT   instance;
};

typedef struct ClCorMOHandle    ClCorMOHandleT;

typedef ClCorMOHandleT* ClCorMOHandlePtrT;

/* TODO: Finally need to use directly ClCorServiceIdT, but the issue with
 * enums is they occupy int space (4 bytes). So need to test and
 * figure out
 */
typedef ClInt16T         ClCorMOServiceIdT;  
  
struct ClCorMOId {

  ClCorMOHandleT        node[CL_COR_HANDLE_MAX_DEPTH];   

  ClCorMOServiceIdT     svcId;                        

  ClUint16T        depth;                        

  ClCorMoPathQualifierT qualifier;                   

  ClVersionT    version;
};

typedef struct ClCorMOId     ClCorMOIdT;

typedef ClCorMOIdT*         ClCorMOIdPtrT;

struct ClCorAttrIdIdxPair
{
   ClCorAttrIdT attrId;

   ClUint32T  index;

};

typedef struct ClCorAttrIdIdxPair ClCorAttrIdIdxPairT;

typedef ClCorAttrIdIdxPairT *ClCorAttrIdIdxPairPtr;

struct ClCorAttrPath
{
    ClCorAttrIdIdxPairT node[CL_COR_CONT_ATTR_MAX_DEPTH];

    ClUint16T        depth;

    ClUint16T        tmp;   
};

typedef struct ClCorAttrPath ClCorAttrPathT;

typedef ClCorAttrPathT* ClCorAttrPathPtrT;

struct ClCorObjAttrWalkFilter
{
          ClUint8T              baseAttrWalk;

          ClUint8T              contAttrWalk;

          ClCorAttrPathT       *pAttrPath;  

          ClCorAttrIdT          attrId;    

          ClInt32T              index;     

          ClCorAttrCmpFlagT     cmpFlag;   

          ClCorAttrWalkOpT      attrWalkOption;     

          ClUint32T             size;      

          void                 *value;     
       };

typedef struct ClCorObjAttrWalkFilter ClCorObjAttrWalkFilterT;

typedef ClRcT (*ClCorObjAttrWalkFuncT) (

/*
 * Attribute path of contained object,whose attribute is being walked.
 * pAttrPath is NULL, if attribute are of the base object (containing object).
 */
ClCorAttrPathPtrT pAttrPath, 

/*
 * Attribute ID.
 */
ClCorAttrIdT attrId, 

/*
 * Attribute type. It can be any of the following values:
 * \arg \c CL_COR_SIMPLE_ATTR
 * \arg \c CL_COR_ARRAY_ATTR 
 * \arg \c CL_COR_ASSOCIATION_ATTR
 */
ClCorAttrTypeT attrType,
              
/*
 * Data type of an attribute. E.g.: \c CL_COR_UINT32.
 * \note
 * For attrType \c CL_COR_ASSOCIATION_ATTR, attrDataType is \c CL_COR_INVALID_DATA_TYPE.
 */
ClCorTypeT attrDataType, 

/*
 * Pointer to actual value of \e attrId.
 */
void *value, 

/*
 * Size of value.
 */
ClUint32T size, 

/*
 * Attribute additional Data.
 */
ClCorAttrFlagT attrData,

/*
 * Cookie passed by you.
 */
void *cookie);

/*
 * COR MOTree walk information.
 * 
 * Provides the class Id, flags and maximum number of instances. In case of MSOs, the 
 * maximum number of instances should be ignored.
 */
struct ClCorMOClassTreeWalkInfo
{

  ClCorClassTypeT    classId;             

  ClUint16T        flags;               

  ClUint32T        maxInstances;        
};

typedef struct ClCorMOClassTreeWalkInfo ClCorMOClassTreeWalkInfoT;
typedef ClCorMOClassTreeWalkInfoT* ClCorMOClassTreeWalkInfoPtrT;

struct ClCorMOClassPath {

  ClCorClassTypeT    node[CL_COR_HANDLE_MAX_DEPTH];   

  ClUint32T        depth;                        

  ClCorMoPathQualifierT qualifier;                   

};

typedef struct ClCorMOClassPath  ClCorMOClassPathT;
typedef ClCorMOClassPathT*      ClCorMOClassPathPtrT;

struct ClCorTxnInfo
{
    ClCorOpsT opType;
    ClCorMOIdT moId;
    ClCorAttrPathT attrPath;
    ClCorAttrIdT attrId;
    ClUint32T jobStatus;
};

typedef struct ClCorTxnInfo ClCorTxnInfoT;

typedef ClCorTxnInfoT* ClCorTxnInfoPtrT;

/*
 * Operations used while storing and retrieving the failed jobs in/from the container. 
 */
 
typedef enum  ClCorTxnEntryId
{
    CL_COR_TXN_INFO_ADD,
    CL_COR_TXN_INFO_FIRST_GET,
    CL_COR_TXN_INFO_NEXT_GET,
    CL_COR_TXN_INFO_CLEAN
}ClCorTxnEntryIdT;

/*
 * The data that is used to form the key while storing the
 * failed jobs into the container
 */
struct ClCorTxnInfoStore
{
    ClCorTxnEntryIdT op;
    
    ClCorTxnSessionIdT txnSessionId;

    ClCorTxnInfoT txnInfo;
};

typedef struct ClCorTxnInfoStore ClCorTxnInfoStoreT;
typedef ClCorTxnInfoStoreT* ClCorTxnInfoStorePtrT;

struct ClCorAttributeValue
{
    ClCorAttrPathPtrT pAttrPath;

    ClCorAttrIdT attrId;

    ClInt32T index;

    ClPtrT bufferPtr;

    ClInt32T bufferSize;
};

typedef struct ClCorAttributeValue ClCorAttributeValueT;

typedef ClCorAttributeValueT* ClCorAttributeValuePtrT;

struct ClCorAttributeValueList
{
    ClUint32T numOfValues;

    ClCorAttributeValuePtrT pAttributeValue;
};

typedef struct ClCorAttributeValueList ClCorAttributeValueListT;

typedef ClCorAttributeValueListT * ClCorAttributeValueListPtrT;

struct ClCorAttrValueDescriptor
{
    ClCorAttrPathPtrT pAttrPath;
    ClCorAttrIdT      attrId;
    ClInt32T          index;
    ClPtrT      bufferPtr;
    ClInt32T    bufferSize;
    ClCorJobStatusT * pJobStatus;
};

typedef struct ClCorAttrValueDescriptor ClCorAttrValueDescriptorT;

typedef ClCorAttrValueDescriptorT *     ClCorAttrValueDescriptorPtrT;

struct ClCorAttrValueDescriptorList
{
    ClUint32T numOfDescriptor;

    ClCorAttrValueDescriptorPtrT pAttrDescriptor;
};

typedef struct ClCorAttrValueDescriptorList ClCorAttrValueDescriptorListT;

typedef ClCorAttrValueDescriptorListT * ClCorAttrValueDescriptorListPtrT;

struct ClCorJobDescriptor {
    ClCorObjectHandleT          *objHandle;
    ClCorMOIdPtrT               pMoId;
    ClCorOpsT                   opType;
    ClUint32T                   numOfAttrDesc;
    ClCorAttrValueDescriptorPtrT  pAttrDesc;
};

typedef  struct ClCorJobDescriptor ClCorJobDescriptorT;
typedef   ClCorJobDescriptorT  *ClCorJobDescriptorPtrT ;


struct ClCorBundleConfig
{
    ClCorBundleOperationTypeT bundleType;
};

typedef struct ClCorBundleConfig ClCorBundleConfigT;
typedef ClCorBundleConfigT *    ClCorBundleConfigPtrT;


typedef ClRcT (*ClCorObjectWalkFunT)(void * data, void *cookie);

typedef ClRcT (*clCorXdrMarshallFP)(void *pGenVar, ClBufferHandleT msg, ClUint32T isDelete);

typedef ClRcT (*clCorXdrUnmarshallFP)(ClBufferHandleT msg, void *pGenVar);

typedef ClRcT (*ClCorBundleCallbackPtrT) (ClCorBundleHandleT bundleHandle, ClPtrT userArg);


#ifdef __cplusplus
}
#endif
#endif  /* _CL_COR_META_DATA_H_ */