XRootD
Loading...
Searching...
No Matches
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>
38#include "XrdOuc/XrdOucECMsg.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
49class XrdPssDir : public XrdOssDF
50{
51public:
52int Close(long long *retsz=0);
53int Opendir(const char *, XrdOucEnv &);
54int 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.
61int StatRet(struct stat *buf);
62
63 // Constructor and destructor
64 XrdPssDir(const char *tid)
66 myDir(0) {}
67
68 ~XrdPssDir() {if (myDir) Close();}
69private:
70 DIR *myDir;
71};
72
73/******************************************************************************/
74/* X r d P s s F i l e */
75/******************************************************************************/
76
77struct XrdOucIOVec;
78class XrdSecEntity;
79class XrdSfsAio;
80
81class XrdPssFile : public XrdOssDF
82{
83public:
84
85// The following two are virtual functions to allow for upcasting derivations
86// of this implementation
87//
88virtual int Close(long long *retsz=0);
89virtual int Open(const char *, int, mode_t, XrdOucEnv &);
90
91int Fchmod(mode_t mode) {return XrdOssOK;}
92int Fstat(struct stat *);
93int Fsync();
94int Fsync(XrdSfsAio *aiop);
95int Ftruncate(unsigned long long);
96ssize_t pgRead (void* buffer, off_t offset, size_t rdlen,
97 uint32_t* csvec, uint64_t opts);
98int pgRead (XrdSfsAio* aioparm, uint64_t opts);
99ssize_t pgWrite(void* buffer, off_t offset, size_t wrlen,
100 uint32_t* csvec, uint64_t opts);
101int pgWrite(XrdSfsAio* aioparm, uint64_t opts);
102ssize_t Read( off_t, size_t);
103ssize_t Read( void *, off_t, size_t);
104int Read(XrdSfsAio *aiop);
105ssize_t ReadV(XrdOucIOVec *readV, int n);
106ssize_t ReadRaw( void *, off_t, size_t);
107ssize_t Write(const void *, off_t, size_t);
108int Write(XrdSfsAio *aiop);
109
110 // Constructor and destructor
111 XrdPssFile(const char *tid)
113 rpInfo(0), tpcPath(0), entity(0) {}
114
115virtual ~XrdPssFile() {if (fd >= 0) Close();
116 if (rpInfo) delete(rpInfo);
117 if (tpcPath) free(tpcPath);
118 }
119
120private:
121
122struct 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;
135const XrdSecEntity *entity;
136};
137
138/******************************************************************************/
139/* X r d P s s S y s */
140/******************************************************************************/
141
142class XrdNetSecurity;
143class XrdOucEnv;
144class XrdOucStream;
145class XrdOucTList;
146class XrdPssUrlInfo;
147class XrdSecsssID;
148class XrdSysError;
149
150struct XrdVersionInfo;
151
152class XrdPssSys : public XrdOss
153{
154public:
155virtual XrdOssDF *newDir(const char *tident) override
156 {return (XrdOssDF *)new XrdPssDir(tident);}
157virtual XrdOssDF *newFile(const char *tident) override
158 {return (XrdOssDF *)new XrdPssFile(tident);}
159
160virtual void Connect(XrdOucEnv &) override;
161
162virtual void Disc(XrdOucEnv &) override;
163
164int Chmod(const char *, mode_t mode, XrdOucEnv *eP=0) override;
165bool ConfigMapID();
166virtual
167int Create(const char *, const char *, mode_t, XrdOucEnv &, int opts=0) override;
168void EnvInfo(XrdOucEnv *envP) override;
169uint64_t Features() override {return myFeatures;}
170int Init(XrdSysLogger *, const char *) override {return -ENOTSUP;}
171int Init(XrdSysLogger *, const char *, XrdOucEnv *envP) override;
172int Lfn2Pfn(const char *Path, char *buff, int blen) override;
173const
174char *Lfn2Pfn(const char *Path, char *buff, int blen, int &rc) override;
175int Mkdir(const char *, mode_t mode, int mkpath=0, XrdOucEnv *eP=0) override;
176int Remdir(const char *, int Opts=0, XrdOucEnv *eP=0) override;
177int Rename(const char *, const char *,
178 XrdOucEnv *eP1=0, XrdOucEnv *eP2=0) override;
179int Stat(const char *, struct stat *, int opts=0, XrdOucEnv *eP=0) override;
180int Stats(char *bp, int bl) override;
181int Truncate(const char *, unsigned long long, XrdOucEnv *eP=0) override;
182int Unlink(const char *, int Opts=0, XrdOucEnv *eP=0) override;
183
184static const int PolNum = 2;
185enum PolAct {PolPath = 0, PolObj = 1};
186
187static int Info(int rc);
188static int P2DST(int &retc, char *hBuff, int hBlen, PolAct pType,
189 const char *path);
190static int P2OUT(char *pbuff, int pblen, XrdPssUrlInfo &uInfo);
191static int P2URL(char *pbuff, int pblen, XrdPssUrlInfo &uInfo,
192 bool doN2N=true);
193
194static const char *ConfigFN; // -> Pointer to the config file name
195static const char *myHost;
196static const char *myName;
197static
198XrdOucPListAnchor XPList; // Exported path list
199
202static char *fileOrgn;
203static const char *protName;
204static const char *hdrData;
205static int hdrLen;
206static int Streams;
207static int Workers;
208static int Trace;
209static int dcaCTime;
210
211static bool xLfn2Pfn;
212static bool dcaCheck;
213static bool dcaWorld;
214static bool deferID; // Defer ID mapping until needed
215static bool reProxy; // TPC requires reproxing
216
217 XrdPssSys();
218virtual ~XrdPssSys() {}
219
220private:
221
222char *HostArena;// -> path qualification for remote origins
223char *LocalRoot;// -> pss Local n2n root, if any
224XrdOucName2Name *theN2N; // -> File mapper object
225unsigned long long DirFlags; // Defaults for exports
226XrdVersionInfo *myVersion;// -> Compilation version
227XrdSecsssID *idMapper; // -> Auth ID mapper
228uint64_t myFeatures;// Our feature set
229
230int Configure(const char *, XrdOucEnv *);
231int ConfigProc(const char *ConfigFN);
232int ConfigXeq(char*, XrdOucStream&);
233int xconf(XrdSysError *Eroute, XrdOucStream &Config);
234int xdef( XrdSysError *Eroute, XrdOucStream &Config);
235int xdca( XrdSysError *errp, XrdOucStream &Config);
236int xexp( XrdSysError *Eroute, XrdOucStream &Config);
237int xperm(XrdSysError *errp, XrdOucStream &Config);
238int xpers(XrdSysError *errp, XrdOucStream &Config);
239int xorig(XrdSysError *errp, XrdOucStream &Config);
240};
241#endif
#define tident
struct stat Stat
Definition XrdCks.cc:49
#define XrdOssOK
Definition XrdOss.hh:50
#define stat(a, b)
Definition XrdPosix.hh:101
XrdOucString Path
bool Create
struct myOpts opts
static const uint16_t DF_isFile
Object is for a file.
Definition XrdOss.hh:393
XrdOssDF(const char *tid="", uint16_t dftype=0, int fdnum=-1)
Definition XrdOss.hh:444
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
XrdOss()
Constructor and Destructor.
Definition XrdOss.hh:897
~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
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 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
virtual XrdOssDF * newDir(const char *tident) override
Definition XrdPss.hh:155
void EnvInfo(XrdOucEnv *envP) override
Definition XrdPss.cc:303
static XrdNetSecurity * Police[PolNum]
Definition XrdPss.hh:101
static const char * myName
Definition XrdPss.hh:196
virtual XrdOssDF * newFile(const char *tident) override
Definition XrdPss.hh:157
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
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 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