clCkptExtApi.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  : ckpt                                                          
 * File        : clCkptExtApi.h
 *******************************************************************************/

/*******************************************************************************
* Description :                                                                
*
*    Checkpoint service provides more functionality than whatever described
*    in SAF.  This file contains APIs to access such functionality 
*
*
*****************************************************************************/

#ifndef _CL_CKPT_EXT_API_H_
#define _CL_CKPT_EXT_API_H_

# ifdef __cplusplus
extern "C" {
# endif

#include <clCommon.h>
#include <clCkptApi.h>
#include <clCntApi.h>
#include <clOsalApi.h>
#include <clEoApi.h>
#include <clDifferenceVector.h>

typedef ClRcT (*ClCkptSerializeT)(

                                  ClUint32T,

                                  ClAddrT *,

                                  ClUint32T *,                                  ClPtrT );


typedef ClRcT (*ClCkptDeserializeT)(

                                   ClUint32T,

                                   ClAddrT ,

                                   ClUint32T,
                                   ClPtrT );

/*
 * Data set versioned callbacks for serializing and deserializing on-disk data.
 */
typedef struct ClCkptDataSetCallback
{
    ClVersionT version; 
    ClCkptSerializeT serialiser;
    ClCkptDeserializeT deSerialiser;
}ClCkptDataSetCallbackT;

typedef struct ClCkptDifferenceIOVectorElement
{
    ClCkptSectionIdT      sectionId;
    ClSizeT dataSize;
    ClOffsetT dataOffset;
    ClDifferenceVectorT *differenceVector;  /* the dataBuffer difference vector representation*/
}ClCkptDifferenceIOVectorElementT;

typedef struct ClCkptClientInfo
{
    ClIocNodeAddressT nodeAddress;
    ClIocPortT portId;
} ClCkptClientInfoT;

typedef struct ClCkptClientInfoList
{
    ClUint32T numEntries;
    ClCkptClientInfoT *pClientInfo;
} ClCkptClientInfoListT;

    
extern ClRcT clCkptLibraryInitialize(
                                      CL_INOUT ClCkptSvcHdlT  *pCkptHdl );

extern ClRcT clCkptLibraryInitializeDB(
                                       CL_INOUT ClCkptSvcHdlT  *pCkptHdl,
                                       const ClCharT *dbName);

extern ClRcT clCkptLibraryFinalize( CL_IN ClCkptSvcHdlT ckptHdl);

extern ClRcT clCkptLibraryCkptCreate( CL_IN ClCkptSvcHdlT  ckptHdl,
                                      CL_IN ClNameT       *pCkptName);


extern ClRcT clCkptLibraryCkptDelete(CL_IN ClCkptSvcHdlT ckptHdl,
                              CL_IN ClNameT     *pCkptName);


extern ClRcT clCkptLibraryCkptDataSetCreate( CL_IN ClCkptSvcHdlT    ckptHdl,
                                      CL_IN ClNameT          *pCkptName,
                                      CL_IN ClUint32T         dsId,
                                      CL_IN ClUint32T         grpId,
                                      CL_IN ClUint32T         order,
                                      CL_IN ClCkptSerializeT   dsSerialiser,
                                      CL_IN ClCkptDeserializeT dsDeserialiser);

extern ClRcT clCkptLibraryCkptDataSetVersionCreate( CL_IN ClCkptSvcHdlT    ckptHdl,
                                      CL_IN ClNameT          *pCkptName,
                                      CL_IN ClUint32T         dsId,
                                      CL_IN ClUint32T         grpId,
                                      CL_IN ClUint32T         order,
                                      CL_IN ClCkptDataSetCallbackT *pTable,
                                      CL_IN ClUint32T numTableEntries);
                                                    

extern ClRcT clCkptLibraryCkptDataSetDelete( CL_IN ClCkptSvcHdlT  ckptHdl,
                                      CL_IN ClNameT       *pCkptName,
                                      CL_IN ClUint32T      dsId );

extern ClRcT clCkptLibraryCkptDataSetWrite(CL_IN ClCkptSvcHdlT   ckptHdl,
                                    CL_IN ClNameT        *pCkptName,
                                    CL_IN ClUint32T       dsId,
                                    CL_IN ClPtrT       cookie );

extern ClRcT clCkptLibraryCkptDataSetVersionWrite(CL_IN ClCkptSvcHdlT   ckptHdl,
                                    CL_IN ClNameT        *pCkptName,
                                    CL_IN ClUint32T       dsId,
                                    CL_IN ClPtrT          cookie,
                                    CL_IN ClVersionT      *pVersion);

extern ClRcT clCkptLibraryCkptDataSetRead( CL_IN ClCkptSvcHdlT      ckptHdl,
                                    CL_IN ClNameT           *pCkptName,
                                    CL_IN ClUint32T          dsId,
                                    CL_IN ClPtrT          cookie);

extern ClRcT clCkptLibraryDoesCkptExist(CL_IN  ClCkptSvcHdlT      ckptHdl,
                                        CL_IN  ClNameT           *pCkptName,
                                        CL_OUT ClBoolT           *pRetVal);

extern ClRcT clCkptLibraryDoesDatasetExist( CL_IN  ClCkptSvcHdlT    ckptHdl,
                                            CL_IN  ClNameT            *pCkptName,
                                            CL_IN  ClUint32T           dsId,
                                            CL_OUT ClBoolT            *pRetVal);
extern ClRcT clCkptLibraryCkptElementCreate(ClCkptSvcHdlT        ckptHdl,
                                     ClNameT              *pCkptName,
                                     ClUint32T            dsId,
                                     ClCkptSerializeT     elemSerialiser,
                                     ClCkptDeserializeT   elemDeserialiser);

extern ClRcT clCkptLibraryCkptElementVersionCreate(ClCkptSvcHdlT        ckptHdl,
                                     ClNameT              *pCkptName,
                                     ClUint32T            dsId,
                                     ClCkptDataSetCallbackT *pTable,
                                     ClUint32T numTableEntries);

extern ClRcT clCkptLibraryCkptElementWrite (ClCkptSvcHdlT   ckptHdl,
                                    ClNameT        *pCkptName,
                                    ClUint32T       dsId,
                                    ClPtrT          elemId,
                                    ClUint32T       elemLen,
                                    ClPtrT       cookie);

extern ClRcT clCkptLibraryCkptElementVersionWrite (ClCkptSvcHdlT   ckptHdl,
                                    ClNameT        *pCkptName,
                                    ClUint32T       dsId,
                                    ClPtrT          elemId,
                                    ClUint32T       elemLen,
                                    ClPtrT       cookie,
                                    ClVersionT   *pVersion);

extern ClRcT clCkptLibraryCkptElementDelete (ClCkptSvcHdlT   ckptHdl,
                                    ClNameT        *pCkptName,
                                    ClUint32T       dsId,
                                    ClPtrT          elemId,
                                    ClUint32T       elemLen);

extern ClRcT clCkptReplicaChangeRegister(ClRcT (*pCkptRelicaChangeCallback)
                                         (const ClNameT *pCkptName, ClIocNodeAddressT replicaAddr));

extern ClRcT clCkptReplicaChangeDeregister(void);

ClRcT clCkptSectionOverwriteVector(ClCkptHdlT               ckptHdl,
                                   const ClCkptSectionIdT   *pSectionId,
                                   ClSizeT                  dataSize,
                                   ClDifferenceVectorT         *differenceVector);

#ifdef __cplusplus
}
#endif

#endif  /* _CL_CKPT_EXT_API_H_*/