XRootD
XrdXrootdTransit.hh
Go to the documentation of this file.
1 #ifndef __XRDXROOTDTRANSIT_HH_
2 #define __XRDXROOTDTRANSIT_HH_
3 /******************************************************************************/
4 /* */
5 /* X r d X r o o t d T r a n s i t . h h */
6 /* */
7 /* (c) 2012 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 <sys/types.h>
34 
35 #include "XrdSys/XrdSysPthread.hh"
38 
39 #include "Xrd/XrdObject.hh"
40 
41 //-----------------------------------------------------------------------------
45 //-----------------------------------------------------------------------------
46 
47 class XrdOucSFVec;
48 class XrdScheduler;
49 class XrdXrootdTransPend;
50 struct iovec;
51 
53 {
54 public:
55 
56 //-----------------------------------------------------------------------------
58 //-----------------------------------------------------------------------------
59 
60 static
62  XrdLink *linkP,
63  XrdSecEntity *seceP,
64  const char *nameP,
65  const char *protP
66  );
67 
68 //-----------------------------------------------------------------------------
70 //-----------------------------------------------------------------------------
71 
72 static int Attn(XrdLink *lP, short *theSID, int rcode,
73  const struct iovec *ioVec, int ioNum, int ioLen);
74 
75 //-----------------------------------------------------------------------------
77 //-----------------------------------------------------------------------------
78 
79 bool Disc();
80 
81 //-----------------------------------------------------------------------------
83 //-----------------------------------------------------------------------------
84 
85 static void Init(XrdScheduler *schedP, int qMax, int qTTL);
86 
87 //-----------------------------------------------------------------------------
89 //-----------------------------------------------------------------------------
90 
91 void Proceed();
92 
93 //-----------------------------------------------------------------------------
95 //-----------------------------------------------------------------------------
96 
97 int Process(XrdLink *lp); // XrdProtocol override
98 
99 //-----------------------------------------------------------------------------
101 //-----------------------------------------------------------------------------
102 
103 void Recycle(XrdLink *lp, int consec, const char *reason);
104 
105 //-----------------------------------------------------------------------------
107 //-----------------------------------------------------------------------------
108 
109 void Redrive();
110 
111 //-----------------------------------------------------------------------------
113 //-----------------------------------------------------------------------------
114 
115 static
116 const char *ReqTable();
117 
118 //-----------------------------------------------------------------------------
120 //-----------------------------------------------------------------------------
121 
122 bool Run(const char *xreqP,
123  char *xdataP=0,
124  int xdataL=0
125  );
126 
127 //-----------------------------------------------------------------------------
129 //-----------------------------------------------------------------------------
130 
131 int Send(int rcode, const struct iovec *ioVec, int ioNum, int ioLen);
132 
133 //-----------------------------------------------------------------------------
135 //-----------------------------------------------------------------------------
136 
137 int Send(long long offset, int dlen, int fdnum);
138 
139 int Send(XrdOucSFVec *sfvec, int sfvnum, int dlen);
140 
141 //-----------------------------------------------------------------------------
143 //-----------------------------------------------------------------------------
144 
145 int setSF(kXR_char *fhandle, bool seton=false)
146  {return SetSF(fhandle, seton);}
147 
148 //-----------------------------------------------------------------------------
150 //-----------------------------------------------------------------------------
151 
152 void SetWait(int wtime, bool notify=false)
153  {runWMax = wtime; runWCall = notify;}
154 
155 //-----------------------------------------------------------------------------
157 //-----------------------------------------------------------------------------
158 
159  XrdXrootdTransit() : TranLink(this),
160  respJob(this, &XrdXrootdTransit::Proceed,
161  "Transit proceed"),
162  waitJob(this, &XrdXrootdTransit::Redrive,
163  "Transit redrive")
164  {}
165 virtual ~XrdXrootdTransit() {}
166 
167 private:
168 int AttnCont(XrdXrootdTransPend *tP, int rcode,
169  const struct iovec *ioV, int ioN, int ioL);
170 bool Fail(int ecode, const char *etext);
171 int Fatal(int rc);
172 void Init(Result *rsltP, XrdLink *linkP, XrdSecEntity *seceP,
173  const char *nameP, const char *protP
174  );
175 bool ReqWrite(char *xdataP, int xdataL);
176 bool RunCopy(char *buffP, int buffL);
177 int Wait(XrdXrootd::Bridge::Context &rInfo,
178  const struct iovec *ioV, int ioN, int ioL);
179 int WaitResp(XrdXrootd::Bridge::Context &rInfo,
180  const struct iovec *ioV, int ioN, int ioL);
181 
182 class SchedReq : public XrdJob
183  {public:
184  typedef void (XrdXrootdTransit::*callbackFP)();
185  void DoIt() {(spanP->*cbFunc)();}
186 
187  SchedReq(XrdXrootdTransit *tP, callbackFP cbP, const char *why)
188  : XrdJob(why), spanP(tP), cbFunc(cbP) {}
189  ~SchedReq() {}
190  private:
191  XrdXrootdTransit *spanP;
192  callbackFP cbFunc;
193  };
194 
195 static XrdObjectQ<XrdXrootdTransit> TranStack;
197 
198 SchedReq respJob;
199 SchedReq waitJob;
200 XrdSysMutex runMutex;
201 static const char *reqTab;
202 XrdProtocol *realProt;
204 const char *runEText;
205 char *runArgs;
206 int runALen;
207 int runABsz;
208 int runError;
209 int runStatus;
210 int runWait;
211 int runWTot;
212 int runWMax;
213 bool runDone;
214 bool reInvoke;
215 bool runWCall;
216 int wBLen;
217 char *wBuff;
218 const char *pName;
219 time_t cTime;
220 };
221 #endif
unsigned char kXR_char
Definition: XPtypes.hh:65
Definition: XrdJob.hh:43
int SetSF(kXR_char *fhandle, bool seton=false)
void DoIt() override
bool Run(const char *xreqP, char *xdataP=0, int xdataL=0)
Inject an xrootd request into the protocol stack.
static const char * ReqTable()
Initialize the valid request table.
void Redrive()
Redrive a request after a wait.
int Send(int rcode, const struct iovec *ioVec, int ioNum, int ioLen)
Handle request data response.
void Recycle(XrdLink *lp, int consec, const char *reason)
Handle link shutdown.
static void Init(XrdScheduler *schedP, int qMax, int qTTL)
Perform one-time initialization.
static XrdXrootdTransit * Alloc(XrdXrootd::Bridge::Result *respP, XrdLink *linkP, XrdSecEntity *seceP, const char *nameP, const char *protP)
Get a new transit object.
int setSF(kXR_char *fhandle, bool seton=false)
Set sendfile() enablement.
static int Attn(XrdLink *lP, short *theSID, int rcode, const struct iovec *ioVec, int ioNum, int ioLen)
Handle attention response (i.e. async response)
virtual ~XrdXrootdTransit()
void SetWait(int wtime, bool notify=false)
Set maximum wait time.
XrdXrootdTransit()
Constructor & Destructor.
void Proceed()
Resume processing after a waitresp completion.
bool Disc()
Handle dismantlement.
int Process(XrdLink *lp)
Handle link activation (replaces parent activation).
XrdScheduler * schedP