XRootD
Loading...
Searching...
No Matches
XrdXrootdProtocol.hh
Go to the documentation of this file.
1#ifndef __XROOTD_PROTOCOL_H__
2#define __XROOTD_PROTOCOL_H__
3/******************************************************************************/
4/* */
5/* X r d X r o o t d P r o t o c o l . h h */
6/* */
7/* (c) 2004 by the Board of Trustees of the Leland Stanford, Jr., University */
8/* Produced by Andrew Hanushevsky for Stanford University under contract */
9/* DE-AC02-76-SFO0515 with the Department of Energy */
10/* */
11/* This file is part of the XRootD software suite. */
12/* */
13/* XRootD is free software: you can redistribute it and/or modify it under */
14/* the terms of the GNU Lesser General Public License as published by the */
15/* Free Software Foundation, either version 3 of the License, or (at your */
16/* option) any later version. */
17/* */
18/* XRootD is distributed in the hope that it will be useful, but WITHOUT */
19/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or */
20/* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public */
21/* License for more details. */
22/* */
23/* You should have received a copy of the GNU Lesser General Public License */
24/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file */
25/* COPYING (GPL license). If not, see <http://www.gnu.org/licenses/>. */
26/* */
27/* The copyright holder's institutional names and contributor's names may not */
28/* be used to endorse or promote products derived from this software without */
29/* specific prior written permission of the institution or contributor. */
30/******************************************************************************/
31
32#include <cstdlib>
33#include <unistd.h>
34#include <sys/types.h>
35
36#include "XrdNet/XrdNetPMark.hh"
37#include "XrdSys/XrdSysError.hh"
41#include "XrdSfs/XrdSfsDio.hh"
43
44#include "Xrd/XrdObject.hh"
45#include "Xrd/XrdProtocol.hh"
50
51/******************************************************************************/
52/* D e f i n e s */
53/******************************************************************************/
54
55#define ROOTD_PQ 2012
56
57#define XRD_LOGGEDIN 1
58#define XRD_NEED_AUTH 2
59#define XRD_BOUNDPATH 8
60
61#ifndef __GNUC__
62#define __attribute__(x)
63#endif
64
65/******************************************************************************/
66/* x r d _ P r o t o c o l _ X R o o t d */
67/******************************************************************************/
68
69class XrdNetSocket;
70class XrdOucEnv;
71class XrdOucErrInfo;
72class XrdOucReqID;
73class XrdOucStream;
74class XrdOucTList;
75class XrdOucTokenizer;
76class XrdSecProtect;
77class XrdSecProtector;
78class XrdSfsDirectory;
79class XrdSfsFACtl;
81class XrdSecProtocol;
82class XrdBuffer;
83class XrdLink;
84class XrdTlsContext;
85class XrdXrootdFile;
88class XrdXrootdJob;
90class XrdXrootdPgwCtl;
91class XrdXrootdPio;
92class XrdXrootdStats;
93class XrdXrootdWVInfo;
94class XrdXrootdXPath;
95
96/******************************************************************************/
97/* N a m e s p a c e X r d X r o o t d */
98/******************************************************************************/
99
100namespace XrdXrootd
101{
102/******************************************************************************/
103/* g d C a l l B a c k */
104/******************************************************************************/
105
106class gdCallBack // Used for new style getData() with callback
107{
108public:
109
110// Called when getData with a buffer successfully completed with a suspension.
111// A direct return is made if there was no suspension. Return values and action:
112// >1 If getData with a buffer was called while in the callback, the operation
113// is performed with a subsequent callback. Otherwise, a fatal error results.
114// =0 Variable discard holds the number of bytes to be discarded from the
115// from the socket (default 0). Return is made to link-level.
116// <0 Considered a fatal link error.
117//
118virtual int gdDone() = 0;
119
120// Called when a fatal link error occurs during reading.
121//
122virtual void gdFail() {} // Called when a link failure occurs
123
125virtual ~gdCallBack() {}
126};
127
128/******************************************************************************/
129/* I O P a r m s */
130/******************************************************************************/
131
133{
135union {
136long long Offset;
137long long WVBytes;
138int EInfo[2];
139 };
141unsigned short Flags;
143char Mode;
144static const int useBasic = 0;
145static const int useMMap = 1;
146static const int useSF = 2;
147};
148}
149
150/******************************************************************************/
151/* C l a s s X r d X r o o t d P r o t o c o l */
152/******************************************************************************/
153
155 public XrdSfsDio, public XrdSfsXio
156{
157friend class XrdXrootdAdmin;
158public:
159
160 void aioUpdate(int val) {srvrAioOps += val;}
161
162 void aioUpdReq(int val) {linkAioReq += val;}
163
164static char *Buffer(XrdSfsXioHandle h, int *bsz); // XrdSfsXio
165
166XrdSfsXioHandle Claim(const char *buff, int datasz, int minasz=0) override;// XrdSfsXio
167
168static int Configure(char *parms, XrdProtocol_Config *pi);
169
170 void DoIt() override {(*this.*Resume)();}
171
172 int do_WriteSpan();
173
174 int getData(gdCallBack *gdcbP, const char *dtype,
175 char *buff, int blen);
176
177 int getData(gdCallBack *gdcbP, const char *dtype,
178 struct iovec *iov, int iovn);
179
180 int getDump(const char *dtype, int dlen);
181
182 int getPathID() {return PathID;}
183
184 XrdProtocol *Match(XrdLink *lp) override;
185
186 int Process(XrdLink *lp) override; // Sync: Job->Link.DoIt->Process
187
188 int Process2();
189
190 int ProcSig();
191
192 void Recycle(XrdLink *lp, int consec, const char *reason) override;
193
194static void Reclaim(XrdSfsXioHandle h); // XrdSfsXio
195
196 int SendFile(int fildes) override; // XrdSfsDio
197
198 int SendFile(XrdOucSFVec *sfvec, int sfvnum) override; // XrdSfsDio
199
200 void SetFD(int fildes) override; // XrdSfsDio
201
202 int Stats(char *buff, int blen, int do_sync=0) override;
203
204 void StreamNOP();
205
206XrdSfsXioHandle Swap(const char *buff, XrdSfsXioHandle h=0) override; // XrdSfsXio
207
208XrdXrootdProtocol *VerifyStream(int &rc, int pID, bool lok=true);
209
212 ~XrdXrootdProtocol() {Cleanup();}
213
214static const int maxStreams = 16;
215
216// async configuration values (referenced outside this class)
217//
218static int as_maxperlnk; // Max async requests per link
219static int as_maxperreq; // Max async ops per request
220static int as_maxpersrv; // Max async ops per server
221static int as_miniosz; // Min async request size
222static int as_minsfsz; // Min sendf request size
223static int as_seghalf;
224static int as_segsize; // Aio quantum (optimal)
225static int as_maxstalls; // Maximum stalls we will tolerate
226static short as_okstutter; // Allowable stutters per transfer unit
227static short as_timeout; // request timeout (usually < stream timeout)
228static bool as_force; // aio to be forced
229static bool as_aioOK; // aio is enabled
230static bool as_nosf; // sendfile is disabled
231static bool as_syncw; // writes to be synchronous
232
233private:
234
235// Note that Route[] structure (below) must have RD_Num elements!
236//
237enum RD_func {RD_chmod = 0, RD_chksum, RD_dirlist, RD_locate, RD_mkdir,
238 RD_mv, RD_prepare, RD_prepstg, RD_rm, RD_rmdir,
239 RD_stat, RD_trunc, RD_ovld, RD_client,
240 RD_open1, RD_open2, RD_open3, RD_open4, RD_Num};
241
242 int do_Auth();
243 int do_Bind();
244 int do_ChkPnt();
245 int do_ChkPntXeq();
246 int do_Chmod();
247 int do_CKsum(int canit);
248 int do_CKsum(char *algT, const char *Path, char *Opaque);
249 int do_Close();
250 int do_Dirlist();
251 int do_DirStat(XrdSfsDirectory *dp, char *pbuff, char *opaque);
252 int do_Endsess();
253 int do_FAttr();
254 int do_gpFile();
255 int do_Login();
256 int do_Locate();
257 int do_Mkdir();
258 int do_Mv();
259 int do_Offload(int (XrdXrootdProtocol::*Invoke)(), int pathID);
260 int do_OffloadIO();
261 int do_Open();
262 bool do_PgClose(XrdXrootdFile *fP, int &rc);
263 int do_PgRead();
264 int do_PgRIO();
265 int do_PgWrite();
266 bool do_PgWAIO(int &rc);
267 int do_PgWIO();
268 int do_PgWIO(bool isFresh);
269 bool do_PgWIORetry(int &rc);
270 bool do_PgWIOSetup(XrdXrootdPgwCtl *pgwCtl);
271 int do_Ping();
272 int do_Prepare(bool isQuery=false);
273 int do_Protocol();
274 int do_Qconf();
275 int do_QconfCX(XrdOucTokenizer &qcargs, char *val);
276 int do_Qfh();
277 int do_Qopaque(short);
278 int do_Qspace();
279 int do_Query();
280 int do_Qxattr();
281 int do_Read();
282 int do_ReadV();
283 int do_ReadAll();
284 int do_ReadNone(int &retc, int &pathID);
285 int do_Rm();
286 int do_Rmdir();
287 int do_Set();
288 int do_Set_Cache(XrdOucTokenizer &setargs);
289 int do_Set_Mon(XrdOucTokenizer &setargs);
290 int do_Stat();
291 int do_Statx();
292 int do_Sync();
293 int do_Truncate();
294 int do_Write();
295 int do_WriteAio();
296 int do_WriteAll();
297 int do_WriteCont();
298 int do_WriteNone();
299 int do_WriteNone(int pathid, XErrorCode ec=kXR_noErrorYet,
300 const char *emsg=0);
301 int do_WriteNoneMsg();
302 int do_WriteV();
303 int do_WriteVec();
304
305 int gdDone() override {return do_PgWIO(false);}
306
307 void Assign(const XrdXrootdProtocol &rhs);
308static int CheckSum(XrdOucStream *, char **, int);
309 void Cleanup();
310static int Config(const char *fn);
311static bool ConfigMon(XrdProtocol_Config *pi, XrdOucEnv &xrootdEnv);
312static int ConfigSecurity(XrdOucEnv &xEnv, const char *cfn);
313 int fsError(int rc, char opc, XrdOucErrInfo &myError,
314 const char *Path, char *Cgi);
315 int fsOvrld(char opc, const char *Path, char *Cgi);
316 int fsRedirNoEnt(const char *eMsg, char *Cgi, int popt);
317 int getBuff(const int isRead, int Quantum);
318 char *getCksType(char *opaque, char *cspec=0, int cslen=0);
319 int getData(const char *dtype, char *buff, int blen);
320 int getDataCont();
321 int getDataIovCont();
322 int getDumpCont();
323 bool logLogin(bool xauth=false);
324static int mapMode(int mode);
325 void Reset();
326static int rpCheck(char *fn, char **opaque);
327 int rpEmsg(const char *op, char *fn);
328 int vpEmsg(const char *op, char *fn);
329static int CheckTLS(const char *tlsProt);
330static bool ConfigFS(XrdOucEnv &xEnv, const char *cfn);
331static bool ConfigFS(const char *path, XrdOucEnv &xEnv, const char *cfn);
332static bool ConfigGStream(XrdOucEnv &myEnv, XrdOucEnv *urEnv);
333static int Squash(char *);
334 int StatGen(struct stat &buf, char *xxBuff, int xxLen, bool xa=false);
335static int xapath(XrdOucStream &Config);
336static int xasync(XrdOucStream &Config);
337static int xcksum(XrdOucStream &Config);
338static int xbif(XrdOucStream &Config);
339static int xdig(XrdOucStream &Config);
340static int xexp(XrdOucStream &Config);
341static int xexpdo(char *path, int popt=0);
342static int xfsl(XrdOucStream &Config);
343static int xfsL(XrdOucStream &Config, char *val, int lix);
344static int xfso(XrdOucStream &Config);
345static int xgpf(XrdOucStream &Config);
346static int xprep(XrdOucStream &Config);
347static int xlog(XrdOucStream &Config);
348static int xmon(XrdOucStream &Config);
349static char *xmondest(const char *what, char *val);
350static int xmongs(XrdOucStream &Config);
351static bool xmongsend(XrdOucStream &Config, char *val, char *&dest,
352 int &opt, int &fmt, int &hdr);
353static int xred(XrdOucStream &Config);
354static int xred_clnt(XrdOucStream &Config, char *hP[2], int rPort[2]);
355static bool xred_php(char *val, char *hP[2], int rPort[2], const char *what,
356 bool optport=false);
357static void xred_set(RD_func func, char *rHost[2], int rPort[2]);
358static bool xred_xok(int func, char *rHost[2], int rPort[2]);
359static int xsecl(XrdOucStream &Config);
360static int xtls(XrdOucStream &Config);
361static int xtlsr(XrdOucStream &Config);
362static int xtrace(XrdOucStream &Config);
363static int xlimit(XrdOucStream &Config);
364
365 int ProcFAttr(char *faPath, char *faCgi, char *faArgs,
366 int faALen, int faCode, bool doAChk);
367 int XeqFADel(XrdSfsFACtl &ctl, char *faVars, int faVLen);
368 int XeqFAGet(XrdSfsFACtl &ctl, char *faVars, int faVLen);
369 int XeqFALsd(XrdSfsFACtl &ctl);
370 int XeqFALst(XrdSfsFACtl &ctl);
371 int XeqFASet(XrdSfsFACtl &ctl, char *faVars, int faVLen);
372
373static XrdObjectQ<XrdXrootdProtocol> ProtStack;
375
376protected:
377
378static unsigned int getSID();
379
380 void MonAuth();
381 int SetSF(kXR_char *fhandle, bool seton=false);
382
383static XrdXrootdXPath RPList; // Redirected paths
384static XrdXrootdXPath RQList; // Redirected paths for ENOENT
385static XrdXrootdXPath XPList; // Exported paths
386static XrdSfsFileSystem *osFS; // The filesystem
387static XrdSfsFileSystem *digFS; // The filesystem (digFS)
388static XrdSecService *CIA; // Authentication Server
389static XrdSecProtector *DHS; // Protection Server
390static XrdTlsContext *tlsCtx; // Protection Server TLS available
391static XrdXrootdFileLock *Locker; // File lock handler
392static XrdScheduler *Sched; // System scheduler
393static XrdBuffManager *BPool; // Buffer manager
394static XrdSysError &eDest; // Error message handler
395static XrdNetPMark *PMark; // Packet marking API
396static const char *myInst;
397static const char *TraceID;
398static int RQLxist; // Something is present in RQList
399static int myPID;
400static int myRole; // Role for kXR_protocol (>= 2.9.7)
401static int myRolf; // Role for kXR_protocol (< 2.9.7)
402
403static gid_t myGID;
404static uid_t myUID;
405static int myGNLen;
406static int myUNLen;
407static const char *myGName;
408static const char *myUName;
409static time_t keepT;
410
411// Admin control area
412//
414
415// Processing configuration values
416//
417static int hailWait;
418static int readWait;
419static int Port;
420static int Window;
421static int tlsPort;
422static char *Notify;
423static const char *myCName;
424static int myCNlen;
425static char isRedir;
426static char JobLCL;
427static char JobCKCGI;
429static char *JobCKT;
432static uint64_t fsFeatures;
433
434// Static redirection
435//
436static struct RD_Table {char *Host[2];
437 unsigned short Port[2];
438 short RDSz[2];} Route[RD_Num];
439
440static struct RC_Table {char *Domain[4];
441 short DomCnt;
442 bool pvtIP;
444
445static int OD_Stall;
446static bool OD_Bypass;
447static bool OD_Redir;
448
449static bool CL_Redir;
450
451static bool isProxy;
452
453// Extended attributes
454//
455static int usxMaxNsz;
456static int usxMaxVsz;
457static char *usxParms;
458
459// TLS configuration
460//
461static const char Req_TLSData = 0x01;
462static const char Req_TLSGPFile= 0x02;
463static const char Req_TLSLogin = 0x04;
464static const char Req_TLSSess = 0x08;
465static const char Req_TLSTPC = 0x10;
466
467static char tlsCap; // TLS requirements for capable clients
468static char tlsNot; // TLS requirements for incapable clients
469
470// Buffer configuration
471//
472static int maxBuffsz; // Maximum buffer size we can have
473static int maxTransz; // Maximum transfer size we can have
474static int maxReadv_ior; // Maximum readv element length
475
476// Statistical area
477//
479int numReads; // Count for kXR_read
480int numReadP; // Count for kXR_read pre-preads
481int numReadV; // Count for kkR_readv
482int numSegsV; // Count for kkR_readv segmens
483int numWritV; // Count for kkR_write
484int numSegsW; // Count for kkR_writev segmens
485int numWrites; // Count
486int numFiles; // Count
487
488int cumReads; // Count less numReads
489int cumReadP; // Count less numReadP
490int cumReadV; // Count less numReadV
491int cumSegsV; // Count less numSegsV
492int cumWritV; // Count less numWritV
493int cumSegsW; // Count less numSegsW
494int cumWrites; // Count less numWrites
495int myStalls; // Number of stalls
496long long totReadP; // Bytes
497
498// Data local to each protocol/link combination
499//
505int clientPV; // Protocol version + capabilities
506int clientRN; // Release as maj.min.patch (1 byte each).
507bool pmDone; // Packet marking has been enabled
508char reserved[3];
509short rdType;
511unsigned char CapVer;
512
513// Authentication area
514//
520
521// Request signing area
522//
523ClientRequest sigReq2Ver; // Request to verify
524SecurityRequest sigReq; // Signature request
525char sigBuff[64]; // Signature payload SHA256 + blowfish
526bool sigNeed; // Signature target present
527bool sigHere; // Signature request present
528bool sigRead; // Signature being read
529bool sigWarn; // Once for unneeded signature
530
531// Async I/O area, these need to be atomic
532//
533RAtomic_int linkAioReq; // Aio requests inflight for link
534static RAtomic_int srvrAioOps; // Aio operations inflight for server
535
536// Buffer information, used to drive getData(), and (*Resume)()
537//
539char *myBuff;
542
544{
547union {int iovAdj;
548 int BuffLen;
549 int DumpLen;
550 };
551bool useCB;
553unsigned char stalls;
555union {struct iovec *iovVec;
556 char *Buffer;
557 };
558const char *ioDType;
560
561static const int inNone = 0;
562static const int inCallBk = 1;
563static const int inData = 2;
564static const int inDataIov = 3;
565static const int inDump = 4;
566
567static const int Active = 1; // linkWait: thread is waiting for link
568static const int Terminate = 3; // linkWait: thread should immediately exit
569
571
573int (XrdXrootdProtocol::*ResumePio)(); //Used by Offload
576
577// Buffer resize control area
578//
579static int hcMax;
582 int hcNow;
584
585// This area is used for parallel streams
586//
587XrdSysMutex unbindMutex; // If locked always before streamMutex
592unsigned int mySID;
595bool isNOP;
597
598static const int maxPio = 4;
602
603short PathID; // Path for this protocol object
604bool newPio; // True when initially scheduled
605unsigned char rvSeq;
606unsigned char wvSeq;
607
608char doTLS; // TLS requirements for client
609bool ableTLS; // T->Client is able to use TLS
610bool isTLS; // T->Client using TLS on control stream
611
612// Track usage limts.
613//
614static bool PrepareAlt; // Use alternate prepare handling
615static bool LimitError; // Indicates that hitting a limit should result in an error response.
616 // If false, when possible, silently ignore errors.
618static int PrepareLimit;
619
620// Buffers to handle client requests
621//
625};
626#endif
XErrorCode
Definition XProtocol.hh:987
@ kXR_noErrorYet
unsigned char kXR_char
Definition XPtypes.hh:65
#define stat(a, b)
Definition XrdPosix.hh:96
XrdOucString Path
#define eMsg(x)
int emsg(int rc, char *msg)
class XrdBuffer * XrdSfsXioHandle
Definition XrdSfsXio.hh:46
static XrdXrootdStats * SI
static const char * myInst
int SendFile(int fildes) override
XrdXrootdProtocol * VerifyStream(int &rc, int pID, bool lok=true)
static XrdSfsFileSystem * digFS
int SetSF(kXR_char *fhandle, bool seton=false)
XrdSecProtect * Protect
int getData(gdCallBack *gdcbP, const char *dtype, struct iovec *iov, int iovn)
XrdNetPMark::Handle * pmHandle
static XrdNetPMark * PMark
XrdXrootdProtocol * Stream[maxStreams]
XrdXrootd::IOParms IO
static XrdXrootdXPath RPList
static XrdNetSocket * AdminSock
static const char Req_TLSGPFile
XrdProtocol * Match(XrdLink *lp) override
struct XrdXrootdProtocol::GetDataCtl gdCtl
void SetFD(int fildes) override
static const char Req_TLSSess
XrdXrootdWVInfo * wvInfo
XrdXrootdPgwCtl * pgwCtl
static void Reclaim(XrdSfsXioHandle h)
XrdSysSemaphore * reTry
XrdXrootdFileTable * FTab
static XrdXrootdJob * JobCKS
static XrdSysError & eDest
static unsigned int getSID()
XrdSecProtocol * AuthProt
int getData(gdCallBack *gdcbP, const char *dtype, char *buff, int blen)
XrdSfsXioHandle Claim(const char *buff, int datasz, int minasz=0) override
XrdXrootdMonitor::User Monitor
static const char * myCName
static const char Req_TLSData
XrdSfsXioHandle Swap(const char *buff, XrdSfsXioHandle h=0) override
static XrdXrootdFileLock * Locker
static const int maxPio
SecurityRequest sigReq
int(XrdXrootdProtocol::* Resume)()
static const char Req_TLSTPC
static XrdTlsContext * tlsCtx
static XrdXrootdXPath XPList
static XrdScheduler * Sched
static struct XrdXrootdProtocol::RC_Table RouteClient
int Process(XrdLink *lp) override
void Recycle(XrdLink *lp, int consec, const char *reason) override
static char * Buffer(XrdSfsXioHandle h, int *bsz)
static const char * myUName
static const char Req_TLSLogin
XrdXrootdResponse Response
int(XrdXrootdProtocol::* ResumePio)()
static const char * TraceID
static int Configure(char *parms, XrdProtocol_Config *pi)
int Stats(char *buff, int blen, int do_sync=0) override
static const int maxStreams
int getDump(const char *dtype, int dlen)
static XrdOucTList * JobCKTLST
static XrdXrootdXPath RQList
static XrdSecProtector * DHS
static XrdBuffManager * BPool
static XrdSecService * CIA
static RAtomic_int srvrAioOps
static const char * myGName
static uint64_t fsFeatures
static XrdOucReqID * PrepID
XrdXrootdPio * pioFirst
XrdSysCondVar2 * endNote
static struct XrdXrootdProtocol::RD_Table Route[RD_Num]
static XrdSfsFileSystem * osFS
XrdXrootdProtocol operator=(const XrdXrootdProtocol &rhs)=delete
virtual int gdDone()=0
XrdXrootd::gdCallBack * CallBack
static const int useSF
static const int useBasic
static const int useMMap