XrdSsiShMap.hh

Go to the documentation of this file.

#ifndef __SSI_SHMAP__
#define __SSI_SHMAP__
/******************************************************************************/
/*                                                                            */
/*                        X r d S s i S h M a p . h h                         */
/*                                                                            */
/* (c) 2015 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD 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 Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/
 
#include <cstdlib>
#include <cstring>
 
#include "XrdSsi/XrdSsiShMat.hh"
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
namespace XrdSsi
{
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
enum ShMap_Access         
    {ReadOnly  = 1,       
     ReadWrite = 2        
    };
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static const int ShMap_4Resize = -1;
 
struct ShMap_Parms
      {int   indexSize;   
       int   maxKeyLen;   
       int   maxKeys;     
       int   mode;        
       int   options;     
       int   reserved;    
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static const
       int   MultW  = 0x88000000; 
static const
       int noMultW  = 0x08000000; 
static const
       int   ReUse  = 0x44000000; 
static const
       int noReUse  = 0x04000000; 
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
       ShMap_Parms()        : indexSize(16381), maxKeyLen(63), maxKeys(32768),
                              mode(0640),       options(0),    reserved(0) {}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
static const
       int ForResize = 0;       
 
       ShMap_Parms(int rsz) : indexSize(0),     maxKeyLen(0),  maxKeys(0),
                              mode(0640),       options(0),    reserved(rsz) {}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
      ~ShMap_Parms()   {}
      };
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
enum   SyncOpt {SyncOff = 0, SyncOn, SyncAll, SyncNow, SyncQSz};
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
typedef int (*ShMap_Hash_t)(const char *key);
 
template<class T>
class ShMap
{
public:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool         Attach(const char *path, ShMap_Access access, int tmo=-1);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool         Create(const char *path, ShMap_Parms &parms);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
void         Detach();
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool         Export();
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool         Add(const char *key, T &val);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool         Del(const char *key, T *valP=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool         Enumerate(void *&jar, char *&key, T *&val);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool         Enumerate(void *&jar);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool         Exists(const char *key);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool         Get(const char *key, T &val);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
int          Info(const char *vname, char *buff=0, int blen=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool         Rep(const char *key, T &val, T *valP=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool         Resize(ShMap_Parms *parms=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool         Sync(SyncOpt dosync, int syncqsz=256);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
             ShMap(const char *typeName, ShMap_Hash_t hFunc=0,
                   const char *implName=0)
                  : shMat(0), hashFunc(hFunc), typeID(strdup(typeName)),
                    implID((implName ? strdup(implName) : 0)) {}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
            ~ShMap() {Detach();
                      if (typeID) free(typeID);
                      if (implID) free(implID);
                     }
 
private:
 
XrdSsiShMat     *shMat;
ShMap_Hash_t     hashFunc;
char            *typeID;
char            *implID;
};
}
 
/******************************************************************************/
/*                 A c t u a l   I m p l e m e n t a t i o n                  */
/******************************************************************************/
  
#include "XrdSsi/XrdSsiShMap.icc"
#endif