clCachedCkpt.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        : clCachedCkpt.h
 *******************************************************************************/

/*******************************************************************************
 * Description :
 * This file contains essential definitions for the Cached Checkpoint
 * which provides a fast lookup for a P2P generated database.
 *
 *
 *******************************************************************************/

#ifndef _CL_CACHED_CKPT_H_
#define _CL_CACHED_CKPT_H_

#include <clCommon.h>
#include <clCommonErrors.h>
#include <clHash.h>
#include <clIocApi.h>
#include <clOsalApi.h>
#include <saCkpt.h>
#include <clCkptApi.h>

#ifdef __cplusplus
extern "C"
{
#endif

/*******************************************************************************/
#define CL_CACHED_CKPT_MAX_SECTION      1024

#define CL_CACHED_CKPT_SHM_MODE                (S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH)
#define CL_CACHED_CKPT_SHM_OPEN_FLAGS          (O_RDWR)
#define CL_CACHED_CKPT_SHM_CREATE_FLAGS        (O_RDWR | O_CREAT)
#define CL_CACHED_CKPT_SHM_EXCL_CREATE_FLAGS   (O_RDWR | O_CREAT | O_EXCL)
#define CL_CACHED_CKPT_MMAP_FLAGS              (MAP_SHARED)
#define CL_CACHED_CKPT_MMAP_PROT_FLAGS         (PROT_READ | PROT_WRITE)

typedef struct {
    ClNameT sectionName;
    ClIocAddressT sectionAddress;
    ClUint32T dataSize;
    ClUint8T *data;
    
}ClCachedCkptDataT;



typedef struct {
    ClInt32T         fd;
    ClOsalSemIdT cacheSem;
    SaCkptHandleT ckptSvcHandle;
    SaCkptCheckpointHandleT ckptHandle;
    ClUint32T cachSize;
    ClUint8T *cache;
}ClCachedCkptSvcInfoT;

/*******************************************************************************/

/************************* CACHED CHECKPOINT APIs ******************************/

ClRcT clCachedCkptInitialize(ClCachedCkptSvcInfoT *serviceInfo, 
                                       const SaNameT *ckptName,
                                       const SaCkptCheckpointCreationAttributesT *ckptAttributes,
                                       SaCkptCheckpointOpenFlagsT openFlags,
                                       ClUint32T cachSize);
/*******************************************************************************/


ClRcT clCachedCkptFinalize(ClCachedCkptSvcInfoT *serviceInfo);
/*******************************************************************************/


ClRcT clCachedCkptSectionCreate(ClCachedCkptSvcInfoT *serviceInfo,
                                       const ClCachedCkptDataT *sectionData);
/*******************************************************************************/


ClRcT clCachedCkptSectionUpdate(ClCachedCkptSvcInfoT *serviceInfo,
                                       const ClCachedCkptDataT *sectionData);
/*******************************************************************************/


ClRcT clCachedCkptSectionDelete(ClCachedCkptSvcInfoT *serviceInfo,
                                       const ClNameT *sectionName);
/*******************************************************************************/

void clCachedCkptSectionRead(ClCachedCkptSvcInfoT *serviceInfo,
                                       const ClNameT *sectionName,
                                       ClCachedCkptDataT **sectionData);

void clCachedCkptSectionGetFirst(ClCachedCkptSvcInfoT *serviceInfo,
                                       ClCachedCkptDataT **sectionData,
                                       ClUint32T        *sectionOffset);

void clCachedCkptSectionGetNext(ClCachedCkptSvcInfoT *serviceInfo,
                                       ClCachedCkptDataT **sectionData,
                                       ClUint32T        *sectionOffset);

/*******************************************************************************/

ClRcT clCachedCkptSynch(ClCachedCkptSvcInfoT *serviceInfo, ClBoolT isEmpty);
/*******************************************************************************/

/* Functions to update cache */
ClRcT clCacheEntryAdd (ClCachedCkptSvcInfoT *serviceInfo, 
                                       const ClCachedCkptDataT *sectionData);
ClRcT clCacheEntryUpdate (ClCachedCkptSvcInfoT *serviceInfo, 
                                       const ClCachedCkptDataT *sectionData);
ClRcT clCacheEntryDelete (ClCachedCkptSvcInfoT *serviceInfo, 
                                       const ClNameT *sectionName);

/* Functions to update checkpoint */
ClRcT clCkptEntryUpdate(ClCachedCkptSvcInfoT *serviceInfo,
                                       const ClCachedCkptDataT *sectionData);
ClRcT clCkptEntryDelete(ClCachedCkptSvcInfoT *serviceInfo, const ClNameT *sectionName);

/****************************Client Side APIs**************************/
typedef struct {
    ClInt32T         fd;
    ClOsalSemIdT cacheSem;
    ClUint32T cachSize;
    ClUint8T *cache;
}ClCachedCkptClientSvcInfoT;

void clCachedCkptClientLookup(ClCachedCkptClientSvcInfoT *serviceInfo,
                                       const ClNameT *sectionName,
                                       ClCachedCkptDataT **sectionData);
ClRcT clCachedCkptClientInitialize(ClCachedCkptClientSvcInfoT *serviceInfo,
                                       const ClNameT *ckptName,
                                       ClUint32T cachSize);
ClRcT clCachedCkptClientFinalize(ClCachedCkptClientSvcInfoT *serviceInfo);



#ifdef __cplusplus
}
#endif

#endif                          /* _CL_CACHED_CKPT_H_ */