XRootD
XrdPss.hh
Go to the documentation of this file.
1 #ifndef _XRDPSS_API_H
2 #define _XRDPSS_API_H
3 /******************************************************************************/
4 /* */
5 /* X r d P s s . h h */
6 /* */
7 /* (c) 2010 by the Board of Trustees of the Leland Stanford, Jr., University */
8 /* All Rights Reserved */
9 /* Produced by Andrew Hanushevsky for Stanford University under contract */
10 /* DE-AC02-76-SFO0515 with the Department of Energy */
11 /* */
12 /* This file is part of the XRootD software suite. */
13 /* */
14 /* XRootD is free software: you can redistribute it and/or modify it under */
15 /* the terms of the GNU Lesser General Public License as published by the */
16 /* Free Software Foundation, either version 3 of the License, or (at your */
17 /* option) any later version. */
18 /* */
19 /* XRootD is distributed in the hope that it will be useful, but WITHOUT */
20 /* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
21 /* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
22 /* License for more details. */
23 /* */
24 /* You should have received a copy of the GNU Lesser General Public License */
25 /* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
26 /* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
27 /* */
28 /* The copyright holder's institutional names and contributor's names may not */
29 /* be used to endorse or promote products derived from this software without */
30 /* specific prior written permission of the institution or contributor. */
31 /******************************************************************************/
32 
33 #include <cerrno>
34 #include <unistd.h>
35 #include <sys/types.h>
36 #include <vector>
37 #include "XrdSys/XrdSysHeaders.hh"
38 #include "XrdOuc/XrdOucECMsg.hh"
39 #include "XrdOuc/XrdOucExport.hh"
41 #include "XrdOuc/XrdOucPList.hh"
42 #include "XrdOuc/XrdOucSid.hh"
43 #include "XrdOss/XrdOss.hh"
44 
45 /******************************************************************************/
46 /* X r d P s s D i r */
47 /******************************************************************************/
48 
49 class XrdPssDir : public XrdOssDF
50 {
51 public:
52 int Close(long long *retsz=0);
53 int Opendir(const char *, XrdOucEnv &);
54 int Readdir(char *buff, int blen);
55 
56 // Store the `buf` pointer in the directory object. Future calls to `Readdir`
57 // will, as a side-effect, fill in the corresponding `stat` information in
58 // the memory referred to from the pointer.
59 //
60 // Returns -errno on failure; otherwise, returns 0 and stashes away the pointer.
61 int StatRet(struct stat *buf);
62 
63  // Constructor and destructor
64  XrdPssDir(const char *tid)
66  myDir(0) {}
67 
68  ~XrdPssDir() {if (myDir) Close();}
69 private:
70  DIR *myDir;
71 };
72 
73 /******************************************************************************/
74 /* X r d P s s F i l e */
75 /******************************************************************************/
76 
77 struct XrdOucIOVec;
78 class XrdSecEntity;
79 class XrdSfsAio;
80 
81 class XrdPssFile : public XrdOssDF
82 {
83 public:
84 
85 // The following two are virtual functions to allow for upcasting derivations
86 // of this implementation
87 //
88 virtual int Close(long long *retsz=0);
89 virtual int Open(const char *, int, mode_t, XrdOucEnv &);
90 
91 int Fchmod(mode_t mode) {return XrdOssOK;}
92 int Fstat(struct stat *);
93 int Fsync();
94 int Fsync(XrdSfsAio *aiop);
95 int Ftruncate(unsigned long long);
96 ssize_t pgRead (void* buffer, off_t offset, size_t rdlen,
97  uint32_t* csvec, uint64_t opts);
98 int pgRead (XrdSfsAio* aioparm, uint64_t opts);
99 ssize_t pgWrite(void* buffer, off_t offset, size_t wrlen,
100  uint32_t* csvec, uint64_t opts);
101 int pgWrite(XrdSfsAio* aioparm, uint64_t opts);
102 ssize_t Read( off_t, size_t);
103 ssize_t Read( void *, off_t, size_t);
104 int Read(XrdSfsAio *aiop);
105 ssize_t ReadV(XrdOucIOVec *readV, int n);
106 ssize_t ReadRaw( void *, off_t, size_t);
107 ssize_t Write(const void *, off_t, size_t);
108 int Write(XrdSfsAio *aiop);
109 
110  // Constructor and destructor
111  XrdPssFile(const char *tid)
113  rpInfo(0), tpcPath(0), entity(0) {}
114 
115 virtual ~XrdPssFile() {if (fd >= 0) Close();
116  if (rpInfo) delete(rpInfo);
117  if (tpcPath) free(tpcPath);
118  }
119 
120 private:
121 
122 struct tprInfo
123  {char *tprPath;
124  char *dstURL;
125  size_t fSize;
126 
127  tprInfo(const char *fn) : tprPath(strdup(fn)),dstURL(0),fSize(0)
128  {}
129  ~tprInfo() {if (tprPath) free(tprPath);
130  if (dstURL) free(dstURL);
131  }
132  } *rpInfo;
133 
134  char *tpcPath;
135 const XrdSecEntity *entity;
136 };
137 
138 /******************************************************************************/
139 /* X r d P s s S y s */
140 /******************************************************************************/
141 
142 class XrdNetSecurity;
143 class XrdOucEnv;
144 class XrdOucStream;
145 class XrdOucTList;
146 class XrdPssUrlInfo;
147 class XrdSecsssID;
148 class XrdSysError;
149 
150 struct XrdVersionInfo;
151 
152 class XrdPssSys : public XrdOss
153 {
154 public:
155 virtual XrdOssDF *newDir(const char *tident) override
156  {return (XrdOssDF *)new XrdPssDir(tident);}
157 virtual XrdOssDF *newFile(const char *tident) override
158  {return (XrdOssDF *)new XrdPssFile(tident);}
159 
160 virtual void Connect(XrdOucEnv &) override;
161 
162 virtual void Disc(XrdOucEnv &) override;
163 
164 int Chmod(const char *, mode_t mode, XrdOucEnv *eP=0) override;
165 bool ConfigMapID();
166 virtual
167 int Create(const char *, const char *, mode_t, XrdOucEnv &, int opts=0) override;
168 void EnvInfo(XrdOucEnv *envP) override;
169 uint64_t Features() override {return myFeatures;}
170 int Init(XrdSysLogger *, const char *) override {return -ENOTSUP;}
171 int Init(XrdSysLogger *, const char *, XrdOucEnv *envP) override;
172 int Lfn2Pfn(const char *Path, char *buff, int blen) override;
173 const
174 char *Lfn2Pfn(const char *Path, char *buff, int blen, int &rc) override;
175 int Mkdir(const char *, mode_t mode, int mkpath=0, XrdOucEnv *eP=0) override;
176 int Remdir(const char *, int Opts=0, XrdOucEnv *eP=0) override;
177 int Rename(const char *, const char *,
178  XrdOucEnv *eP1=0, XrdOucEnv *eP2=0) override;
179 int Stat(const char *, struct stat *, int opts=0, XrdOucEnv *eP=0) override;
180 int Stats(char *bp, int bl) override;
181 int Truncate(const char *, unsigned long long, XrdOucEnv *eP=0) override;
182 int Unlink(const char *, int Opts=0, XrdOucEnv *eP=0) override;
183 
184 static const int PolNum = 2;
185 enum PolAct {PolPath = 0, PolObj = 1};
186 
187 static int Info(int rc);
188 static int P2DST(int &retc, char *hBuff, int hBlen, PolAct pType,
189  const char *path);
190 static int P2OUT(char *pbuff, int pblen, XrdPssUrlInfo &uInfo);
191 static int P2URL(char *pbuff, int pblen, XrdPssUrlInfo &uInfo,
192  bool doN2N=true);
193 
194 static const char *ConfigFN; // -> Pointer to the config file name
195 static const char *myHost;
196 static const char *myName;
197 static
198 XrdOucPListAnchor XPList; // Exported path list
199 
202 static char *fileOrgn;
203 static const char *protName;
204 static const char *hdrData;
205 static int hdrLen;
206 static int Streams;
207 static int Workers;
208 static int Trace;
209 static int dcaCTime;
210 
211 static bool xLfn2Pfn;
212 static bool dcaCheck;
213 static bool dcaWorld;
214 static bool deferID; // Defer ID mapping until needed
215 static bool reProxy; // TPC requires reproxing
216 
217  XrdPssSys();
218 virtual ~XrdPssSys() {}
219 
220 private:
221 
222 char *HostArena;// -> path qualification for remote origins
223 char *LocalRoot;// -> pss Local n2n root, if any
224 XrdOucName2Name *theN2N; // -> File mapper object
225 unsigned long long DirFlags; // Defaults for exports
226 XrdVersionInfo *myVersion;// -> Compilation version
227 XrdSecsssID *idMapper; // -> Auth ID mapper
228 uint64_t myFeatures;// Our feature set
229 
230 int Configure(const char *, XrdOucEnv *);
231 int ConfigProc(const char *ConfigFN);
232 int ConfigXeq(char*, XrdOucStream&);
233 int xconf(XrdSysError *Eroute, XrdOucStream &Config);
234 int xdef( XrdSysError *Eroute, XrdOucStream &Config);
235 int xdca( XrdSysError *errp, XrdOucStream &Config);
236 int xexp( XrdSysError *Eroute, XrdOucStream &Config);
237 int xperm(XrdSysError *errp, XrdOucStream &Config);
238 int xpers(XrdSysError *errp, XrdOucStream &Config);
239 int xorig(XrdSysError *errp, XrdOucStream &Config);
240 };
241 #endif
#define tident
#define XrdOssOK
Definition: XrdOss.hh:50
int stat(const char *path, struct stat *buf)
XrdOucString Path
struct myOpts opts
static const uint16_t DF_isFile
Object is for a file.
Definition: XrdOss.hh:393
int fd
Definition: XrdOss.hh:455
static const uint16_t DF_isDir
Object is for a directory.
Definition: XrdOss.hh:392
static const uint16_t DF_isProxy
Object is a proxy object.
Definition: XrdOss.hh:394
~XrdPssDir()
Definition: XrdPss.hh:68
int Close(long long *retsz=0)
Definition: XrdPss.cc:748
int Opendir(const char *, XrdOucEnv &)
Definition: XrdPss.cc:650
int Readdir(char *buff, int blen)
Definition: XrdPss.cc:707
int StatRet(struct stat *buf)
Definition: XrdPss.cc:728
XrdPssDir(const char *tid)
Definition: XrdPss.hh:64
ssize_t ReadRaw(void *, off_t, size_t)
Definition: XrdPss.cc:1145
int Fsync()
Definition: XrdPss.cc:1273
virtual ~XrdPssFile()
Definition: XrdPss.hh:115
virtual int Close(long long *retsz=0)
Definition: XrdPss.cc:919
virtual int Open(const char *, int, mode_t, XrdOucEnv &)
Definition: XrdPss.cc:783
ssize_t Read(off_t, size_t)
Definition: XrdPss.cc:1069
int Fstat(struct stat *)
Definition: XrdPss.cc:1187
int Fchmod(mode_t mode)
Definition: XrdPss.hh:91
ssize_t Write(const void *, off_t, size_t)
Definition: XrdPss.cc:1165
XrdPssFile(const char *tid)
Definition: XrdPss.hh:111
ssize_t ReadV(XrdOucIOVec *readV, int n)
Definition: XrdPss.cc:1107
ssize_t pgRead(void *buffer, off_t offset, size_t rdlen, uint32_t *csvec, uint64_t opts)
Definition: XrdPss.cc:960
int Ftruncate(unsigned long long)
Definition: XrdPss.cc:1302
ssize_t pgWrite(void *buffer, off_t offset, size_t wrlen, uint32_t *csvec, uint64_t opts)
Definition: XrdPss.cc:1013
virtual ~XrdPssSys()
Definition: XrdPss.hh:218
static const int PolNum
Definition: XrdPss.hh:184
virtual XrdOssDF * newFile(const char *tident) override
Definition: XrdPss.hh:157
int Mkdir(const char *, mode_t mode, int mkpath=0, XrdOucEnv *eP=0) override
Definition: XrdPss.cc:350
static int P2OUT(char *pbuff, int pblen, XrdPssUrlInfo &uInfo)
Definition: XrdPss.cc:1350
uint64_t Features() override
Definition: XrdPss.hh:169
static int dcaCTime
Definition: XrdPss.hh:209
int Unlink(const char *, int Opts=0, XrdOucEnv *eP=0) override
Definition: XrdPss.cc:600
static int Streams
Definition: XrdPss.hh:206
XrdPssSys()
Definition: XrdPss.cc:165
virtual void Connect(XrdOucEnv &) override
Definition: XrdPss.cc:234
int Truncate(const char *, unsigned long long, XrdOucEnv *eP=0) override
Definition: XrdPss.cc:559
int Stats(char *bp, int bl) override
Definition: XrdPss.cc:541
static int Info(int rc)
Definition: XrdPss.cc:1313
static bool deferID
Definition: XrdPss.hh:214
static const char * ConfigFN
Definition: XrdPss.hh:194
static int hdrLen
Definition: XrdPss.hh:205
static const char * hdrData
Definition: XrdPss.hh:204
int Stat(const char *, struct stat *, int opts=0, XrdOucEnv *eP=0) override
Definition: XrdPss.cc:490
int Init(XrdSysLogger *, const char *) override
Definition: XrdPss.hh:170
static XrdOucTList * ManList
Definition: XrdPss.hh:201
static char * fileOrgn
Definition: XrdPss.hh:202
static int P2DST(int &retc, char *hBuff, int hBlen, PolAct pType, const char *path)
Definition: XrdPss.cc:1323
static bool dcaCheck
Definition: XrdPss.hh:212
static bool reProxy
Definition: XrdPss.hh:215
int Chmod(const char *, mode_t mode, XrdOucEnv *eP=0) override
Definition: XrdPss.cc:223
static int Workers
Definition: XrdPss.hh:207
@ PolObj
Definition: XrdPss.hh:185
@ PolPath
Definition: XrdPss.hh:185
void EnvInfo(XrdOucEnv *envP) override
Definition: XrdPss.cc:303
static XrdNetSecurity * Police[PolNum]
Definition: XrdPss.hh:200
static const char * myName
Definition: XrdPss.hh:196
static int Trace
Definition: XrdPss.hh:208
bool ConfigMapID()
static XrdOucPListAnchor XPList
Definition: XrdPss.hh:198
static int P2URL(char *pbuff, int pblen, XrdPssUrlInfo &uInfo, bool doN2N=true)
Definition: XrdPss.cc:1414
virtual XrdOssDF * newDir(const char *tident) override
Definition: XrdPss.hh:155
static const char * myHost
Definition: XrdPss.hh:195
int Remdir(const char *, int Opts=0, XrdOucEnv *eP=0) override
Definition: XrdPss.cc:389
int Lfn2Pfn(const char *Path, char *buff, int blen) override
Definition: XrdPss.cc:318
static bool xLfn2Pfn
Definition: XrdPss.hh:211
virtual int Create(const char *, const char *, mode_t, XrdOucEnv &, int opts=0) override
Definition: XrdPss.cc:272
virtual void Disc(XrdOucEnv &) override
Definition: XrdPss.cc:283
int Rename(const char *, const char *, XrdOucEnv *eP1=0, XrdOucEnv *eP2=0) override
Definition: XrdPss.cc:437
static bool dcaWorld
Definition: XrdPss.hh:213
static const char * protName
Definition: XrdPss.hh:203
XrdCmsConfig Config
int Opts
Definition: XrdMpxStats.cc:58
XrdOucEnv * envP
Definition: XrdPss.cc:109