xrootd
XrdSsiFileReq.hh
Go to the documentation of this file.
1 #ifndef __SSI_FILEREQ_H__
2 #define __SSI_FILEREQ_H__
3 /******************************************************************************/
4 /* */
5 /* X r d S s i F i l e R e q . h h */
6 /* */
7 /* (c) 2013 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 <string.h>
33 #include <sys/types.h>
34 
35 #include "Xrd/XrdJob.hh"
36 #include "Xrd/XrdScheduler.hh"
38 #include "XrdSfs/XrdSfsXio.hh"
39 #include "XrdSsi/XrdSsiRequest.hh"
41 #include "XrdSsi/XrdSsiStream.hh"
42 #include "XrdSys/XrdSysPthread.hh"
43 
44 class XrdOucErrInfo;
45 class XrdSsiAlert;
46 class XrdSsiFileResource;
47 class XrdSsiFileSess;
48 class XrdSsiRespInfoMsg;
49 class XrdSsiRRInfo;
50 class XrdSsiService;
51 class XrdSsiStream;
52 
53 class XrdSsiFileReq : public XrdSsiRequest, public XrdOucEICB, public XrdJob
54 {
55 public:
56 
57 
58 // SsiRequest methods
59 //
60  void Activate(XrdOucBuffer *oP, XrdSfsXioHandle bR, int rSz);
61 
62  void Alert(XrdSsiRespInfoMsg &aMsg);
63 
65  XrdSsiFileSess *fP, const char *sn,
66  const char *id, unsigned int rnum);
67 
68  void Finalize();
69 
71 
72  void Finished( XrdSsiRequest &rqstR,
73  const XrdSsiRespInfo &rInfo,
74  bool cancel=false) {}
75 
76  char *GetRequest(int &rLen);
77 
78  bool ProcessResponse(const XrdSsiErrInfo &eInfo,
79  const XrdSsiRespInfo &resp);
80 
81  XrdSfsXferSize Read(bool &done,
82  char *buffer,
83  XrdSfsXferSize blen);
84 
86 
87  int Send(XrdSfsDio *sfDio, XrdSfsXferSize size);
88 
89 static void SetMax(int mVal) {freeMax = mVal;}
90 
92 
93 // OucEICB methods
94 //
95  void Done(int &Result, XrdOucErrInfo *cbInfo,
96  const char *path=0);
97 
98  int Same(unsigned long long arg1, unsigned long long arg2)
99  {return 0;}
100 // Job methods
101 //
102  void DoIt();
103 
104 // Constructor and destructor
105 //
106  XrdSsiFileReq(const char *cID=0)
107  : frqMutex(XrdSsiMutex::Recursive)
108  {Init(cID);}
109 
110 virtual ~XrdSsiFileReq() {if (tident) free(tident);}
111 
114 
115 private:
116 
117 void BindDone(); // Override
118 void Dispose(); // Override
119 int Emsg(const char *pfx, int ecode, const char *op);
120 int Emsg(const char *pfx, XrdSsiErrInfo &eObj,
121  const char *op);
122 void Init(const char *cID=0);
124  XrdSfsXferSize blen);
126  XrdSfsXferSize blen);
127 int sendStrmA(XrdSsiStream *strmP, XrdSfsDio *sfDio,
128  XrdSfsXferSize blen);
129 void Recycle();
130 void WakeUp(XrdSsiAlert *aP=0);
131 
134 static int freeCnt;
135 static int freeMax;
136 
141 unsigned long long respCBarg;
142 
146 
147 char *tident;
148 const char *sessN;
152 char *respBuf;
153 long long respOff;
154 union {long long fileSz;
155  int respLen;
156  };
163 unsigned int reqID;
164 bool haveResp;
165 bool respWait;
166 bool strmEOF;
168 bool isEnding;
169 char rID[8];
170 };
171 #endif
XrdSsiFileReq::sessN
const char * sessN
Definition: XrdSsiFileReq.hh:148
XrdSsiFileReq::strmEOF
bool strmEOF
Definition: XrdSsiFileReq.hh:166
XrdSsiStream.hh
XrdSfsInterface.hh
XrdSsiFileReq::frqMutex
XrdSsiMutex frqMutex
Definition: XrdSsiFileReq.hh:137
XrdSsiRequest::Finished
bool Finished(bool cancel=false)
XrdSsiFileReq::aqMutex
static XrdSysMutex aqMutex
Definition: XrdSsiFileReq.hh:132
XrdSsiFileReq::Read
XrdSfsXferSize Read(bool &done, char *buffer, XrdSfsXferSize blen)
XrdSsiFileReq::erRsp
@ erRsp
Definition: XrdSsiFileReq.hh:112
XrdSsiFileReq::Finalize
void Finalize()
XrdSsiFileReq::WantResponse
bool WantResponse(XrdOucErrInfo &eInfo)
XrdSysMutex
Definition: XrdSysPthread.hh:165
XrdSsiFileReq::respCB
XrdOucEICB * respCB
Definition: XrdSsiFileReq.hh:140
XrdSsiFileReq::rID
char rID[8]
Definition: XrdSsiFileReq.hh:169
XrdSsiFileReq::respWait
bool respWait
Definition: XrdSsiFileReq.hh:165
XrdSysPthread.hh
XrdSsiFileResource
Definition: XrdSsiFileResource.hh:42
XrdSsiFileReq::oucBuff
XrdOucBuffer * oucBuff
Definition: XrdSsiFileReq.hh:158
XrdSsiFileReq::isDone
@ isDone
Definition: XrdSsiFileReq.hh:113
XrdSsiFileReq::SetMax
static void SetMax(int mVal)
Definition: XrdSsiFileReq.hh:89
XrdSsiFileReq::sendStrmA
int sendStrmA(XrdSsiStream *strmP, XrdSfsDio *sfDio, XrdSfsXferSize blen)
XrdSsiFileReq::GetRequest
char * GetRequest(int &rLen)
XrdSsiFileReq
Definition: XrdSsiFileReq.hh:54
XrdSsiFileReq::WakeUp
void WakeUp(XrdSsiAlert *aP=0)
XrdSsiRequest.hh
XrdSsiFileReq::urState
rspState urState
Definition: XrdSsiFileReq.hh:161
XrdSsiFileReq::reqSize
int reqSize
Definition: XrdSsiFileReq.hh:162
XrdSsiFileReq::respLen
int respLen
Definition: XrdSsiFileReq.hh:155
XrdSfsXioHandle
class XrdBuffer * XrdSfsXioHandle
Definition: XrdSfsXio.hh:46
XrdSsiFileReq::nextReq
XrdSsiFileReq * nextReq
Definition: XrdSsiFileReq.hh:138
XrdSsiFileReq::respOff
long long respOff
Definition: XrdSsiFileReq.hh:153
XrdSfsXferSize
int XrdSfsXferSize
Definition: XrdSfsInterface.hh:129
XrdSsiFileReq::schedDone
bool schedDone
Definition: XrdSsiFileReq.hh:167
XrdSsiFileReq::finWait
XrdSysSemaphore * finWait
Definition: XrdSsiFileReq.hh:139
XrdSsiFileReq::Alert
void Alert(XrdSsiRespInfoMsg &aMsg)
Send or receive a server generated alert.
XrdSsiResponder.hh
XrdSsiFileReq::~XrdSsiFileReq
virtual ~XrdSsiFileReq()
Definition: XrdSsiFileReq.hh:110
XrdSsiRespInfoMsg
Definition: XrdSsiRespInfo.hh:87
XrdSsiFileReq::Activate
void Activate(XrdOucBuffer *oP, XrdSfsXioHandle bR, int rSz)
XrdSsiFileReq::Done
void Done(int &Result, XrdOucErrInfo *cbInfo, const char *path=0)
XrdSsiFileReq::isMax
@ isMax
Definition: XrdSsiFileReq.hh:113
XrdSsiRRInfo
Definition: XrdSsiRRInfo.hh:38
XrdSsiFileReq::respCBarg
unsigned long long respCBarg
Definition: XrdSsiFileReq.hh:141
XrdSsiFileReq::rspState
rspState
Definition: XrdSsiFileReq.hh:113
XrdSsiFileReq::isEnding
bool isEnding
Definition: XrdSsiFileReq.hh:168
XrdSsiFileReq::Send
int Send(XrdSfsDio *sfDio, XrdSfsXferSize size)
XrdSsiFileReq::freeCnt
static int freeCnt
Definition: XrdSsiFileReq.hh:134
XrdSsiMutex
Definition: XrdSsiAtomics.hh:110
XrdSsiFileReq::odRsp
@ odRsp
Definition: XrdSsiFileReq.hh:112
XrdSsiFileReq::Emsg
int Emsg(const char *pfx, XrdSsiErrInfo &eObj, const char *op)
XrdSsiFileReq::reqState
reqState
Definition: XrdSsiFileReq.hh:112
XrdSsiFileReq::ProcessResponse
bool ProcessResponse(const XrdSsiErrInfo &eInfo, const XrdSsiRespInfo &resp)
XrdSsiRequest
Definition: XrdSsiRequest.hh:71
XrdOucEICB
Definition: XrdOucErrInfo.hh:485
XrdSsiFileReq::strBuff
XrdSsiStream::Buffer * strBuff
Definition: XrdSsiFileReq.hh:159
XrdSsiFileReq::sfsBref
XrdSfsXioHandle sfsBref
Definition: XrdSsiFileReq.hh:157
XrdSsiErrInfo
Definition: XrdSsiErrInfo.hh:41
XrdSsiFileReq::Dispose
void Dispose()
XrdSsiFileReq::rsEnd
@ rsEnd
Definition: XrdSsiFileReq.hh:112
XrdSsiFileReq::Finished
void Finished(XrdSsiRequest &rqstR, const XrdSsiRespInfo &rInfo, bool cancel=false)
Definition: XrdSsiFileReq.hh:72
XrdSsiFileReq::alrtLast
XrdSsiAlert * alrtLast
Definition: XrdSsiFileReq.hh:145
XrdSsiFileReq::Emsg
int Emsg(const char *pfx, int ecode, const char *op)
XrdSsiFileReq::haveResp
bool haveResp
Definition: XrdSsiFileReq.hh:164
XrdSsiFileReq::tident
char * tident
Definition: XrdSsiFileReq.hh:147
XrdSsiFileReq::cbInfo
XrdOucErrInfo * cbInfo
Definition: XrdSsiFileReq.hh:149
XrdSsiFileReq::Init
void Init(const char *cID=0)
XrdSysSemaphore
Definition: XrdSysPthread.hh:438
XrdSsiFileReq::isBegun
@ isBegun
Definition: XrdSsiFileReq.hh:113
XrdSsiFileReq::isNew
@ isNew
Definition: XrdSsiFileReq.hh:113
XrdSsiFileReq::alrtSent
XrdSsiAlert * alrtSent
Definition: XrdSsiFileReq.hh:143
XrdSsiStream::Buffer
Definition: XrdSsiStream.hh:64
XrdSsiFileReq::reqID
unsigned int reqID
Definition: XrdSsiFileReq.hh:163
XrdJob
Definition: XrdJob.hh:43
XrdSsiFileReq::freeMax
static int freeMax
Definition: XrdSsiFileReq.hh:135
XrdSsiFileReq::alrtPend
XrdSsiAlert * alrtPend
Definition: XrdSsiFileReq.hh:144
XrdSsiFileReq::readStrmP
XrdSfsXferSize readStrmP(XrdSsiStream *strmP, char *buff, XrdSfsXferSize blen)
XrdSsiAlert
Definition: XrdSsiAlert.hh:38
XrdSsiFileReq::BindDone
void BindDone()
XrdScheduler.hh
XrdSsiFileSess
Definition: XrdSsiFileSess.hh:47
XrdSsiStream
Definition: XrdSsiStream.hh:54
XrdSsiFileReq::isBound
@ isBound
Definition: XrdSsiFileReq.hh:113
XrdSsiFileReq::Same
int Same(unsigned long long arg1, unsigned long long arg2)
Definition: XrdSsiFileReq.hh:98
XrdSsiFileReq::isAbort
@ isAbort
Definition: XrdSsiFileReq.hh:113
XrdSsiFileReq::readStrmA
XrdSfsXferSize readStrmA(XrdSsiStream *strmP, char *buff, XrdSfsXferSize blen)
XrdSsiFileReq::XrdSsiFileReq
XrdSsiFileReq(const char *cID=0)
Definition: XrdSsiFileReq.hh:106
XrdSfsDio
Definition: XrdSfsDio.hh:47
XrdSsiFileReq::Recycle
void Recycle()
XrdSfsXio.hh
XrdSsiFileReq::fileR
XrdSsiFileResource * fileR
Definition: XrdSsiFileReq.hh:150
XrdOucErrInfo
Definition: XrdOucErrInfo.hh:101
XrdSsiFileReq::Alloc
static XrdSsiFileReq * Alloc(XrdOucErrInfo *eP, XrdSsiFileResource *rP, XrdSsiFileSess *fP, const char *sn, const char *id, unsigned int rnum)
XrdSsiFileReq::wtRsp
@ wtRsp
Definition: XrdSsiFileReq.hh:112
XrdSsiFileReq::RelRequestBuffer
void RelRequestBuffer()
XrdSsiFileReq::DoIt
void DoIt()
XrdSsiFileReq::myState
reqState myState
Definition: XrdSsiFileReq.hh:160
XrdSsiService
Definition: XrdSsiService.hh:55
XrdJob.hh
XrdSsiFileReq::fileP
XrdSsiFileSess * fileP
Definition: XrdSsiFileReq.hh:151
XrdSsiFileReq::freeReq
static XrdSsiFileReq * freeReq
Definition: XrdSsiFileReq.hh:133
XrdSsiFileReq::fileSz
long long fileSz
Definition: XrdSsiFileReq.hh:154
XrdSsiRespInfo
Definition: XrdSsiRespInfo.hh:44
XrdOucBuffer
Definition: XrdOucBuffer.hh:141
XrdSsiFileReq::doRsp
@ doRsp
Definition: XrdSsiFileReq.hh:112
XrdSsiFileReq::xqReq
@ xqReq
Definition: XrdSsiFileReq.hh:112
XrdSsiFileReq::respBuf
char * respBuf
Definition: XrdSsiFileReq.hh:152
XrdSsiFileReq::wtReq
@ wtReq
Definition: XrdSsiFileReq.hh:112