xrootd
XrdXrootdAioTask.hh
Go to the documentation of this file.
1 #ifndef __XRDXROOTDAIOTASK_H__
2 #define __XRDXROOTDAIOTASK_H__
3 /******************************************************************************/
4 /* */
5 /* X r d X r o o t d A i o T a s k . h h */
6 /* */
7 /* (c) 2021 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 <atomic>
34 
35 #include "Xrd/XrdJob.hh"
37 #include "XrdSys/XrdSysPthread.hh"
38 
39 class XrdLink;
40 class XrdXrootdAioBuff;
41 class XrdXrootdNormAio;
42 class XrdXrootdPgrwAio;
43 class XrdXrootdFile;
44 
46 {
47 public:
48 friend class XrdXrootdAioFob;
49 
50  void Completed(XrdXrootdAioBuff *aioP);
51 
52  const char *ID();
53 
54  void Init(XrdXrootdProtocol *protP,
55  XrdXrootdResponse &resp,
56  XrdXrootdFile *fP);
57 
58 virtual void Read(long long offs, int dlen) = 0;
59 
60 virtual void Recycle(bool release) = 0;
61 
63 
64 virtual int Write(long long offs, int dlen) = 0;
65 
66 protected:
67 
68  XrdXrootdAioTask(const char *what="aio request")
69  : XrdJob(what), aioReady(aioMutex) {}
70 virtual ~XrdXrootdAioTask() {}
71 
72 virtual void CopyF2L() = 0;
73 virtual int CopyL2F() = 0;
74 virtual bool CopyL2F(XrdXrootdAioBuff *aioP) = 0;
75  bool Drain();
76  int gdDone() override;
77  void gdFail() override;
78  XrdXrootdAioBuff* getBuff(bool wait);
79  void SendError(int rc, const char *eText);
80  void SendFSError(int rc);
81  bool Validate(XrdXrootdAioBuff* aioP);
82 
83 static const char* TraceID;
84 
86  XrdSysMutex aioMutex; // Locks private data
88  XrdXrootdAioBuff* pendQEnd; // -> Last element in pendQ
89 
90 union {XrdXrootdNormAio* nextNorm; // Never used in conflicting context!
93  };
94 
95  XrdXrootdProtocol* Protocol; // -> Protocol associated with dataLink
96  XrdLink* dataLink; // -> Network link
97  XrdXrootdFile* dataFile; // -> Associated file
98 union {XrdXrootdAioBuff *finalRead; // -> A short read indicating EOF
99  XrdXrootdAioBuff *pendWrite; // -> Pending write operation
100  };
101  off_t highOffset; // F2L: EOF offset L2F: initial offset
102  off_t dataOffset; // Next offset
103  int dataLen; // Size remaining
104 
105  char aioState; // See aioXXX below
106  std::atomic_uchar inFlight;
107  std::atomic_bool isDone; // Request finished
108  char Status; // Offline | Running | Waiting
109 
111 
112 // These values may be present in aioState
113 //
114 static const int aioDead = 0x01; // This aio encountered a fatal link error
115 static const int aioHeld = 0x02; // This aio is recycled but held
116 static const int aioPage = 0x04; // This read is a pgread
117 static const int aioRead = 0x08; // This is a read (i.e. File to Link copy)
118 static const int aioSchd = 0x10; // Next read has been scheduled
119 
120 // These must be inspected or set with aioMutex held
121 //
122 static const int Offline = 0; // Needs to be rescheduled (read only)
123 static const int Running = 1; // Executing
124 static const int Waiting = 2; // Waiting for buffer needs to be signaled
125 
126 private:
127 
128  bool Wait4Buff(int maxWait=0);
129 };
130 #endif
bool Wait4Buff(int maxWait=0)
XrdXrootdPgrwAio * nextPgrw
Definition: XrdXrootdAioTask.hh:91
XrdXrootdAioBuff * getBuff(bool wait)
void Completed(XrdXrootdAioBuff *aioP)
const char * ID()
XrdXrootdProtocol * Protocol
Definition: XrdXrootdAioTask.hh:95
int dataLen
Definition: XrdXrootdAioTask.hh:103
Definition: XrdXrootdAioBuff.hh:40
static const int aioSchd
Definition: XrdXrootdAioTask.hh:118
virtual ~XrdXrootdAioTask()
Definition: XrdXrootdAioTask.hh:70
std::atomic_bool isDone
Definition: XrdXrootdAioTask.hh:107
XrdLink * dataLink
Definition: XrdXrootdAioTask.hh:96
virtual int Write(long long offs, int dlen)=0
XrdXrootdResponse Response
Definition: XrdXrootdAioTask.hh:110
off_t highOffset
Definition: XrdXrootdAioTask.hh:101
static const int aioRead
Definition: XrdXrootdAioTask.hh:117
Definition: XrdXrootdProtocol.hh:154
std::atomic_uchar inFlight
Definition: XrdXrootdAioTask.hh:106
void gdFail() override
void SendFSError(int rc)
virtual void CopyF2L()=0
Definition: XrdXrootdFile.hh:100
Definition: XrdSysPthread.hh:164
XrdSysMutex aioMutex
Definition: XrdXrootdAioTask.hh:86
XrdXrootdNormAio * nextNorm
Definition: XrdXrootdAioTask.hh:90
bool Validate(XrdXrootdAioBuff *aioP)
Definition: XrdXrootdPgrwAio.hh:38
XrdXrootdFile * dataFile
Definition: XrdXrootdAioTask.hh:97
XrdXrootdAioBuff * pendWrite
Definition: XrdXrootdAioTask.hh:99
XrdXrootdAioTask(const char *what="aio request")
Definition: XrdXrootdAioTask.hh:68
static const int Waiting
Definition: XrdXrootdAioTask.hh:124
Definition: XrdSysPthread.hh:299
XrdXrootdAioBuff * finalRead
Definition: XrdXrootdAioTask.hh:98
Definition: XrdXrootdAioTask.hh:45
static const int aioHeld
Definition: XrdXrootdAioTask.hh:115
int gdDone() override
static const int Offline
Definition: XrdXrootdAioTask.hh:122
XrdXrootdAioBuff * pendQ
Definition: XrdXrootdAioTask.hh:87
Definition: XrdXrootdResponse.hh:48
virtual void Read(long long offs, int dlen)=0
virtual int CopyL2F()=0
char aioState
Definition: XrdXrootdAioTask.hh:105
Definition: XrdXrootdNormAio.hh:38
void Init(XrdXrootdProtocol *protP, XrdXrootdResponse &resp, XrdXrootdFile *fP)
char Status
Definition: XrdXrootdAioTask.hh:108
Definition: XrdXrootdAioFob.hh:37
static const int aioPage
Definition: XrdXrootdAioTask.hh:116
static const int Running
Definition: XrdXrootdAioTask.hh:123
XrdXrootdAioTask * nextTask
Definition: XrdXrootdAioTask.hh:92
static const char * TraceID
Definition: XrdXrootdAioTask.hh:83
gdCallBack()
Definition: XrdXrootdProtocol.hh:124
XrdSysCondVar2 aioReady
Definition: XrdXrootdAioTask.hh:85
virtual void Recycle(bool release)=0
XrdXrootdProtocol * urProtocol()
Definition: XrdXrootdAioTask.hh:62
Definition: XrdJob.hh:42
static const int aioDead
Definition: XrdXrootdAioTask.hh:114
off_t dataOffset
Definition: XrdXrootdAioTask.hh:102
void SendError(int rc, const char *eText)
XrdXrootdAioBuff * pendQEnd
Definition: XrdXrootdAioTask.hh:88