1 #ifndef __SFS_INTERFACE_H__ 2 #define __SFS_INTERFACE_H__ 34 #include <sys/types.h> 39 #include "XrdOuc/XrdOucSFVec.hh" 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 171 class XrdSfsDirectory;
206 class XrdSfsFileSystem
222 virtual XrdSfsDirectory *newDir(
char *user=0,
int MonID=0) = 0;
236 virtual XrdSfsFile *newFile(
char *user=0,
int MonID=0) = 0;
259 enum csFunc {csCalc = 0, csGet, csSize};
261 virtual int chksum( csFunc Func,
266 const char *opaque = 0)
268 (void)Func; (void)csName; (void)path; (void)eInfo; (void)client;
286 virtual int chmod(
const char *path,
290 const char *opaque = 0) = 0;
345 virtual int FSctl(
const int cmd,
350 (void)cmd; (void)args; (void)eInfo; (void)client;
372 virtual int fsctl(
const int cmd,
389 virtual int getStats(
char *buff,
int blen) = 0;
397 virtual const char *getVersion() = 0;
417 virtual int exists(
const char *path,
421 const char *opaque = 0) = 0;
435 virtual int mkdir(
const char *path,
439 const char *opaque = 0) = 0;
466 virtual int rem(
const char *path,
469 const char *opaque = 0) = 0;
482 virtual int remdir(
const char *path,
485 const char *opaque = 0) = 0;
500 virtual int rename(
const char *oPath,
504 const char *opaqueO = 0,
505 const char *opaqueN = 0) = 0;
520 virtual int stat(
const char *Name,
524 const char *opaque = 0) = 0;
540 virtual int stat(
const char *path,
544 const char *opaque = 0) = 0;
558 virtual int truncate(
const char *path,
562 const char *opaque = 0) = 0;
568 XrdSfsFileSystem() {}
569 virtual ~XrdSfsFileSystem() {}
610 typedef XrdSfsFileSystem *(*XrdSfsFileSystem_t) (XrdSfsFileSystem *nativeFS,
612 const char *configFn);
614 typedef XrdSfsFileSystem *(*XrdSfsFileSystem2_t)(XrdSfsFileSystem *nativeFS,
616 const char *configFn,
682 virtual int open(
const char *fileName,
686 const char *opaque = 0) = 0;
694 virtual int close() = 0;
715 virtual int fctl(
const int cmd,
734 virtual int fctl(
const int cmd,
739 (void)cmd; (void)alen; (void)args; (void)client;
749 virtual const char *FName() = 0;
761 virtual int getMmap(
void **Addr, off_t &Size) = 0;
817 for (
int i = 0; i < rdvCnt; i++)
818 {rdsz = read(readV[i].offset,
819 readV[i].data, readV[i].size);
820 if (rdsz != readV[i].size)
821 {
if (rdsz < 0)
return rdsz;
842 virtual int SendData(XrdSfsDio *sfDio,
846 (void)sfDio; (void)offset; (void)size;
874 virtual int write(
XrdSfsAio *aioparm) = 0;
891 for (
int i = 0; i < wdvCnt; i++)
892 {wrsz = write(writeV[i].offset,
893 writeV[i].data, writeV[i].size);
894 if (wrsz != writeV[i].size)
895 {
if (wrsz < 0)
return wrsz;
913 virtual int stat(
struct stat *buf) = 0;
921 virtual int sync() = 0;
952 virtual int getCXinfo(
char cxtype[4],
int &cxrsz) = 0;
960 virtual void setXio(XrdSfsXio *xioP) { (void)xioP; }
971 XrdSfsFile(
const char *user=0,
int MonID=0)
972 : error(user, MonID) {}
978 virtual ~XrdSfsFile() {}
991 class XrdSfsDirectory
1012 virtual int open(
const char *path,
1014 const char *opaque = 0) = 0;
1026 virtual const char *nextEntry() = 0;
1034 virtual int close() = 0;
1042 virtual const char *FName() = 0;
1052 virtual int autoStat(
struct stat *buf)
1067 XrdSfsDirectory(
const char *user=0,
int MonID=0)
1068 : error(user, MonID) {}
1074 virtual ~XrdSfsDirectory() {}
int opts
Prep_xxx.
Definition: XrdSfsInterface.hh:161
XrdOucTList * oinfo
1-to-1 correspondence of opaque info
Definition: XrdSfsInterface.hh:163
#define SFS_OK
Definition: XrdSfsInterface.hh:99
const char * Arg1
PLUGIO & PLUGIN.
Definition: XrdSfsInterface.hh:151
int XrdSfsXferSize
Definition: XrdSfsInterface.hh:122
char * notify
Notification path or 0.
Definition: XrdSfsInterface.hh:160
XrdSfsFileExistence
Definition: XrdSfsInterface.hh:124
long long XrdSfsFileOffset
Definition: XrdSfsInterface.hh:119
int Arg1Len
Length.
Definition: XrdSfsInterface.hh:152
Definition: XrdSfsInterface.hh:126
< SFS_FSCTL_PLUGIN/PLUGIO parameters
Definition: XrdSfsInterface.hh:149
Definition: XrdOucErrInfo.hh:97
Definition: XrdSfsInterface.hh:127
Definition: XrdSfsInterface.hh:129
#define SFS_ERROR
Definition: XrdSfsInterface.hh:100
Definition: XrdOucEnv.hh:41
Definition: XrdOucIOVec.hh:40
const char * Arg2
PLUGIN opaque string.
Definition: XrdSfsInterface.hh:154
Definition: XrdOucTList.hh:41
XrdOucTList * paths
List of paths.
Definition: XrdSfsInterface.hh:162
Definition: XrdSysLogger.hh:52
char * reqid
Request ID.
Definition: XrdSfsInterface.hh:159
int XrdSfsMode
Definition: XrdSfsInterface.hh:121
int Arg2Len
Length.
Definition: XrdSfsInterface.hh:153
Definition: XrdSecEntity.hh:51
Definition: XrdSfsInterface.hh:130
Definition: XrdSfsAio.hh:57
< Prepare parameters
Definition: XrdSfsInterface.hh:157
int XrdSfsFileOpenMode
Definition: XrdSfsInterface.hh:120
int setErrInfo(int code, const char *emsg)
Definition: XrdOucErrInfo.hh:144
Definition: XrdSfsInterface.hh:128