XrdOfsConfigPI.hh

Go to the documentation of this file.

#ifndef __XRDOFSCONFIGPI_HH__
#define __XRDOFSCONFIGPI_HH__
/******************************************************************************/
/*                                                                            */
/*                     X r d O f s C o n f i g P I . h h                      */
/*                                                                            */
/* (c) 2014 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   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 <vector>
 
#include "XrdCms/XrdCmsClient.hh"
 
class  XrdAccAuthorize;
class  XrdCks;
class  XrdCksConfig;
class  XrdOfs;
class  XrdOfsFSctl_PI;
class  XrdOfsPrepare;
class  XrdOss;
class  XrdOucEnv;
class  XrdOucStream;
class  XrdSfsFileSystem;
class  XrdSysError;
class  XrdSysXAttr;
struct XrdVersionInfo;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
class XrdOfsConfigPI
{
public:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
enum TheLib {theAtrLib = 0x0100,  
             theAutLib = 0x0201,  
             theCksLib = 0x0402,  
             theCmsLib = 0x0803,  
             theCtlLib = 0x1004,  
             theOssLib = 0x2005,  
             thePrpLib = 0x4006,  
             allXXXLib = 0x7f07,  
             maxXXXLib = 0x0007,  
             libIXMask = 0x00ff
            };
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool   Configure(XrdCmsClient *cmscP, XrdOucEnv *envP);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool   ConfigCtl(XrdCmsClient *cmscP, XrdOucEnv *envP=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
void   Default(TheLib what, const char *lpath, const char *lparm=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
void   DefaultCS(const char *alg);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
void   Display();
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool   Load(int what, XrdOucEnv *envP=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static
XrdOfsConfigPI *New(const char *cfn, XrdOucStream *cfgP, XrdSysError *errP,
                    XrdVersionInfo *verP=0, XrdSfsFileSystem *sfsP=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool   LclCks() {return cksLcl;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool   OssCks();
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool   Parse(TheLib what);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool   Plugin(XrdAccAuthorize *&piP);    
bool   Plugin(XrdCks          *&pip);    
bool   Plugin(XrdCmsClient_t   &piP);    
bool   Plugin(XrdOfsFSctl_PI  *&piP);    
bool   Plugin(XrdOfsPrepare   *&piP);    
bool   Plugin(XrdOss          *&piP);    
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool   PrepAuth();
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool   Push(TheLib what, const char *plugP, const char *parmP=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
void   SetCksRdSz(int rdsz);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
      ~XrdOfsConfigPI();
 
private:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
       XrdOfsConfigPI(const char *cfn, XrdOucStream *cfgP, XrdSysError *errP,
                      XrdSfsFileSystem *sfsP, XrdVersionInfo *verP=0);
 
bool          AddLib(TheLib what);
bool          AddLibAtr(XrdOucEnv *envP, XrdSysXAttr *&atrPI);
bool          AddLibAut(XrdOucEnv *envP);
bool          AddLibCtl(XrdOucEnv *envP);
bool          AddLibOss(XrdOucEnv *envP);
bool          AddLibPrp(XrdOucEnv *envP);
bool          ParseAtrLib();
bool          ParseOssLib();
bool          ParsePrpLib();
bool          RepLib(TheLib what, const char *newLib, const char *newParms=0, bool parseParms=true);
bool          SetupAttr(TheLib what, XrdOucEnv *envP);
bool          SetupAuth(XrdOucEnv *envP);
bool          SetupCtl(XrdOucEnv *envP);
bool          SetupCms();
bool          SetupPrp(XrdOucEnv *envP);
 
XrdAccAuthorize  *autPI;    
XrdCks           *cksPI;    
XrdCmsClient_t    cmsPI;    
XrdOfsFSctl_PI   *ctlPI;    
XrdOfsPrepare    *prpPI;    
XrdOss           *ossPI;    
XrdSfsFileSystem *sfsPI;    
XrdVersionInfo   *urVer;    
 
XrdOucStream *Config;
XrdSysError  *Eroute;
XrdCksConfig *CksConfig;
const char   *ConfigFN;
 
struct xxxLP
      {char  *lib;
       char  *parms;
       char  *opts;
              xxxLP() : lib(0), parms(0), opts(0) {}
             ~xxxLP() {if (lib)   free(lib);
                       if (parms) free(parms);
                       if (opts)  free(opts);
                      }
              xxxLP& operator=(const xxxLP& rhs)
                      {if (this != &rhs)
                          {lib   = (rhs.lib   ? strdup(rhs.lib)   : 0);
                           parms = (rhs.parms ? strdup(rhs.parms) : 0);
                           opts  = (rhs.opts  ? strdup(rhs.opts)  : 0);
                          }
                       return *this;
                      }
              xxxLP(const xxxLP& rhs) {*this = rhs;}
 
      }       LP[maxXXXLib];
std::vector<xxxLP> ALP[maxXXXLib];
 
struct ctlLP {XrdOfsFSctl_PI *ctlPI; const char *parms;};
 
std::vector<ctlLP> ctlVec;
 
char         *CksAlg;
int           CksRdsz;
bool          pushOK[maxXXXLib];
bool          defLib[maxXXXLib];
bool          ossXAttr;
char          ossCksio;
bool          prpAuth;
bool          Loaded;
bool          LoadOK;
bool          cksLcl;
};
#endif