Go to the documentation of this file. 1 #ifndef __SFS_INTERFACE_H__
2 #define __SFS_INTERFACE_H__
34 #include <sys/types.h>
45 #define SFS_O_RDONLY 0 // open read/only
46 #define SFS_O_WRONLY 1 // open write/only
47 #define SFS_O_RDWR 2 // open read/write
48 #define SFS_O_CREAT 0x100 // used for file creation
49 #define SFS_O_TRUNC 0x200 // used for file truncation
50 #define SFS_O_MULTIW 0x400 // used for multi-write locations
51 #define SFS_O_POSC 0x0100000 // persist on successful close
52 #define SFS_O_FORCE 0x0200000 // used for locate only
53 #define SFS_O_HNAME 0x0400000 // used for locate only
54 #define SFS_O_LOCAL 0x0800000 // used for locate only (local cmd)
55 #define SFS_O_NOWAIT 0x01000000 // do not impose operational delays
56 #define SFS_O_RAWIO 0x02000000 // allow client-side decompression
57 #define SFS_O_RESET 0x04000000 // Reset any cached information
58 #define SFS_O_REPLICA 0x08000000 // Open for replication
63 #define SFS_O_MKPTH 0x00004000 // Make directory path if missing
68 #define SFS_O_LOCATE 0x10000000 // This request generated by locate()
69 #define SFS_O_STAT 0x20000000 // This request generated by stat()
70 #define SFS_O_META 0x40000000 // This request generated by metaop
78 #define SFS_FCTL_GETFD 1 // Return file descriptor if possible
79 #define SFS_FCTL_STATV 2 // Return visa information
80 #define SFS_FCTL_SPEC1 3 // Return implementation defined information
82 #define SFS_SFIO_FDVAL 0x80000000 // Use SendData() method GETFD response value
86 #define SFS_FSCTL_CMD 255
88 #define SFS_FSCTL_LOCATE 1 // Locate a file
89 #define SFS_FSCTL_STATFS 2 // Return FS data
90 #define SFS_FSCTL_STATLS 3 // Return LS data
91 #define SFS_FSCTL_STATXA 4 // Return XA data
92 #define SFS_FSCTL_STATCC 5 // Return Cluster Config status
93 #define SFS_FSCTL_PLUGIN 8 // Return Implementation Dependent Data
94 #define SFS_FSCTL_PLUGIO 16 // Return Implementation Dependent Data
98 #define SFS_STALL 1 // Return value -> Seconds to stall client
99 #define SFS_OK 0 // ErrInfo code -> All is well
100 #define SFS_ERROR -1 // ErrInfo code -> Error occurred
101 #define SFS_REDIRECT -256 // ErrInfo code -> Port number to redirect to
102 #define SFS_STARTED -512 // ErrInfo code -> Estimated seconds to completion
103 #define SFS_DATA -1024 // ErrInfo code -> Length of data
104 #define SFS_DATAVEC -2048 // ErrInfo code -> Num iovec elements in msgbuff
108 #define SFS_LCLPRFX "/=/"
109 #define SFS_LCLPLEN 3
110 #define SFS_LCLPATH(x) !strncmp(x, SFS_LCLPRFX, SFS_LCLPLEN)
111 #define SFS_LCLPRFY "/="
112 #define SFS_LCLROOT(x) !strncmp(x, SFS_LCLPRFX, SFS_LCLPLEN-1) \
113 && (*(x+SFS_LCLPLEN-1) == '/' || *(x+SFS_LCLPLEN-1) == 0)
139 #define Prep_SENDAOK 4
140 #define Prep_SENDERR 8
141 #define Prep_SENDACK 12
142 #define Prep_WMODE 16
143 #define Prep_STAGE 32
144 #define Prep_COLOC 64
145 #define Prep_FRESH 128
146 #define Prep_CANCEL 256
147 #define Prep_QUERY 512
148 #define Prep_EVICT 1024
269 const char *opaque = 0)
271 (void)Func; (void)csName; (void)path; (void)eInfo; (void)client;
289 virtual int chmod(
const char *path,
293 const char *opaque = 0) = 0;
353 (void)cmd; (void)args; (void)eInfo; (void)client;
375 virtual int fsctl(
const int cmd,
392 virtual int getStats(
char *buff,
int blen) = 0;
420 virtual int exists(
const char *path,
424 const char *opaque = 0) = 0;
438 virtual int mkdir(
const char *path,
442 const char *opaque = 0) = 0;
469 virtual int rem(
const char *path,
472 const char *opaque = 0) = 0;
485 virtual int remdir(
const char *path,
488 const char *opaque = 0) = 0;
503 virtual int rename(
const char *oPath,
507 const char *opaqueO = 0,
508 const char *opaqueN = 0) = 0;
523 virtual int stat(
const char *Name,
527 const char *opaque = 0) = 0;
543 virtual int stat(
const char *path,
547 const char *opaque = 0) = 0;
561 virtual int truncate(
const char *path,
565 const char *opaque = 0) = 0;
615 const char *configFn);
619 const char *configFn,
685 virtual int open(
const char *fileName,
689 const char *opaque = 0) = 0;
697 virtual int close() = 0;
718 virtual int fctl(
const int cmd,
737 virtual int fctl(
const int cmd,
742 (void)cmd; (void)alen; (void)args; (void)client;
752 virtual const char *
FName() = 0;
764 virtual int getMmap(
void **Addr, off_t &Size) = 0;
820 for (
int i = 0; i < rdvCnt; i++)
821 {rdsz =
read(readV[i].offset,
822 readV[i].data, readV[i].size);
823 if (rdsz != readV[i].size)
824 {
if (rdsz < 0)
return rdsz;
849 (void)sfDio; (void)offset; (void)size;
894 for (
int i = 0; i < wdvCnt; i++)
895 {wrsz =
write(writeV[i].offset,
896 writeV[i].data, writeV[i].size);
897 if (wrsz != writeV[i].size)
898 {
if (wrsz < 0)
return wrsz;
916 virtual int stat(
struct stat *buf) = 0;
924 virtual int sync() = 0;
955 virtual int getCXinfo(
char cxtype[4],
int &cxrsz) = 0;
975 :
error(user, MonID) {}
1015 virtual int open(
const char *path,
1017 const char *opaque = 0) = 0;
1037 virtual int close() = 0;
1045 virtual const char *
FName() = 0;
1071 :
error(user, MonID) {}
int opts
Prep_xxx.
Definition: XrdSfsInterface.hh:164
#define SFS_OK
Definition: XrdSfsInterface.hh:99
virtual const char * FName()=0
@ csSize
Definition: XrdSfsInterface.hh:262
Definition: XrdSfsXio.hh:80
@ XrdSfsFileExistIsDirectory
Definition: XrdSfsInterface.hh:128
virtual const char * nextEntry()=0
virtual XrdSfsXferSize readv(XrdOucIOVec *readV, int rdvCnt)
Definition: XrdSfsInterface.hh:817
virtual int truncate(const char *path, XrdSfsFileOffset fsize, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
virtual int rename(const char *oPath, const char *nPath, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaqueO=0, const char *opaqueN=0)=0
Definition: XrdSfsInterface.hh:209
csFunc
Definition: XrdSfsInterface.hh:262
virtual void Disc(const XrdSecEntity *client=0)
Definition: XrdSfsInterface.hh:301
@ csCalc
Definition: XrdSfsInterface.hh:262
virtual const char * getVersion()=0
char * notify
Notification path or 0.
Definition: XrdSfsInterface.hh:163
virtual XrdSfsXferSize write(XrdSfsFileOffset offset, const char *buffer, XrdSfsXferSize size)=0
virtual int mkdir(const char *path, XrdSfsMode mode, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
int XrdSfsXferSize
Definition: XrdSfsInterface.hh:122
@ csGet
Definition: XrdSfsInterface.hh:262
XrdSfsFileExistence
Definition: XrdSfsInterface.hh:124
virtual ~XrdSfsDirectory()
Destructor.
Definition: XrdSfsInterface.hh:1077
XrdSfsFile(const char *user=0, int MonID=0)
Definition: XrdSfsInterface.hh:974
#define SFS_ERROR
Definition: XrdSfsInterface.hh:100
virtual int remdir(const char *path, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
Definition: XrdSfsInterface.hh:651
long long XrdSfsFileOffset
Definition: XrdSfsInterface.hh:119
virtual int fctl(const int cmd, int alen, const char *args, const XrdSecEntity *client=0)
Definition: XrdSfsInterface.hh:737
Definition: XrdOucIOVec.hh:40
@ XrdSfsFileExistIsFile
Definition: XrdSfsInterface.hh:127
virtual int fsctl(const int cmd, const char *args, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
XrdSfsDirectory(const char *user=0, int MonID=0)
Definition: XrdSfsInterface.hh:1070
virtual ~XrdSfsFile()
Destructor.
Definition: XrdSfsInterface.hh:981
const char * Arg1
PLUGIO & PLUGIN.
Definition: XrdSfsInterface.hh:154
virtual int autoStat(struct stat *buf)
Definition: XrdSfsInterface.hh:1055
int setErrInfo(int code, const char *emsg)
Definition: XrdOucErrInfo.hh:146
virtual int stat(struct stat *buf)=0
Definition: XrdSfsInterface.hh:994
virtual int chmod(const char *path, XrdSfsMode mode, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
XrdOucErrInfo error
Definition: XrdSfsInterface.hh:1003
Definition: XrdOucEnv.hh:41
const char * Arg2
PLUGIN opaque string.
Definition: XrdSfsInterface.hh:157
virtual XrdSfsXferSize writev(XrdOucIOVec *writeV, int wdvCnt)
Definition: XrdSfsInterface.hh:891
XrdSfsFileSystem()
Constructor and Destructor.
Definition: XrdSfsInterface.hh:571
virtual int SendData(XrdSfsDio *sfDio, XrdSfsFileOffset offset, XrdSfsXferSize size)
Definition: XrdSfsInterface.hh:845
virtual ~XrdSfsFileSystem()
Definition: XrdSfsInterface.hh:572
virtual int exists(const char *path, XrdSfsFileExistence &eFlag, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
int Arg2Len
Length.
Definition: XrdSfsInterface.hh:156
@ XrdSfsFileExistIsOffline
Definition: XrdSfsInterface.hh:129
Definition: XrdSysLogger.hh:52
virtual void setXio(XrdSfsXio *xioP)
Definition: XrdSfsInterface.hh:963
@ XrdSfsFileExistNo
Definition: XrdSfsInterface.hh:126
virtual int fctl(const int cmd, const char *args, XrdOucErrInfo &eInfo)=0
virtual int rem(const char *path, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
int XrdSfsMode
Definition: XrdSfsInterface.hh:121
XrdOucTList * paths
List of paths.
Definition: XrdSfsInterface.hh:165
virtual int open(const char *path, const XrdSecEntity *client=0, const char *opaque=0)=0
virtual int chksum(csFunc Func, const char *csName, const char *path, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)
Definition: XrdSfsInterface.hh:264
< Prepare parameters
Definition: XrdSfsInterface.hh:160
XrdOucErrInfo error
Definition: XrdSfsInterface.hh:660
virtual XrdSfsXferSize read(XrdSfsFileOffset offset, XrdSfsXferSize size)=0
virtual int stat(const char *Name, struct stat *buf, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0, const char *opaque=0)=0
char * reqid
Request ID.
Definition: XrdSfsInterface.hh:162
virtual XrdSfsDirectory * newDir(char *user=0, int MonID=0)=0
int XrdSfsFileOpenMode
Definition: XrdSfsInterface.hh:120
int Arg1Len
Length.
Definition: XrdSfsInterface.hh:155
Definition: XrdSfsDio.hh:46
virtual int getStats(char *buff, int blen)=0
Definition: XrdSecEntity.hh:51
Definition: XrdSfsAio.hh:57
< SFS_FSCTL_PLUGIN/PLUGIO parameters
Definition: XrdSfsInterface.hh:152
Definition: XrdOucErrInfo.hh:99
virtual XrdSfsFile * newFile(char *user=0, int MonID=0)=0
virtual int truncate(XrdSfsFileOffset fsize)=0
#define stat(a, b)
Definition: XrdPosix.hh:96
virtual int getCXinfo(char cxtype[4], int &cxrsz)=0
virtual void EnvInfo(XrdOucEnv *envP)
Definition: XrdSfsInterface.hh:313
virtual int prepare(XrdSfsPrep &pargs, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)=0
virtual const char * FName()=0
@ XrdSfsFileExistIsOther
Definition: XrdSfsInterface.hh:130
XrdOucTList * oinfo
1-to-1 correspondence of opaque info
Definition: XrdSfsInterface.hh:166
virtual int getMmap(void **Addr, off_t &Size)=0
virtual int FSctl(const int cmd, XrdSfsFSctl &args, XrdOucErrInfo &eInfo, const XrdSecEntity *client=0)
Definition: XrdSfsInterface.hh:348
virtual int open(const char *fileName, XrdSfsFileOpenMode openMode, mode_t createMode, const XrdSecEntity *client=0, const char *opaque=0)=0
Definition: XrdOucTList.hh:41