XRootD
Loading...
Searching...
No Matches
XrdCl::XRootDMsgHandler Class Reference

Handle/Process/Forward XRootD messages. More...

#include <XrdClXRootDMsgHandler.hh>

+ Inheritance diagram for XrdCl::XRootDMsgHandler:
+ Collaboration diagram for XrdCl::XRootDMsgHandler:

Public Member Functions

 XRootDMsgHandler (Message *msg, ResponseHandler *respHandler, const URL *url, std::shared_ptr< SIDManager > sidMgr, LocalFileHandler *lFileHandler)
 
 ~XRootDMsgHandler ()
 Destructor.
 
virtual uint16_t Examine (std::shared_ptr< Message > &msg) override
 
time_t GetExpiration () override
 Get a timestamp after which we give up.
 
const MessageGetRequest () const
 Get the request pointer.
 
virtual uint16_t GetSid () const override
 
virtual uint16_t InspectStatusRsp () override
 
virtual bool IsRaw () const override
 Are we a raw writer or not?
 
void OnReadyToSend (Message *msg) override
 
virtual void OnStatusReady (const Message *message, XRootDStatus status) override
 The requested action has been performed and the status is available.
 
virtual uint8_t OnStreamEvent (StreamEvent event, XRootDStatus status) override
 
void PartialReceived ()
 
virtual void Process () override
 Process the message if it was "taken" by the examine action.
 
virtual XRootDStatus ReadMessageBody (Message *msg, Socket *socket, uint32_t &bytesRead) override
 
void SetChunkList (ChunkList *chunkList)
 Set the chunk list.
 
void SetCrc32cDigests (std::vector< uint32_t > &&crc32cDigests)
 
void SetExpiration (time_t expiration)
 Set a timestamp after which we give up.
 
void SetFollowMetalink (bool followMetalink)
 
void SetHostList (HostList *hostList)
 Set host list.
 
void SetKernelBuffer (XrdSys::KernelBuffer *kbuff)
 Set the kernel buffer.
 
void SetLoadBalancer (const HostInfo &loadBalancer)
 Set the load balancer.
 
void SetOksofarAsAnswer (bool oksofarAsAnswer)
 
void SetRedirectAsAnswer (bool redirectAsAnswer)
 
void SetRedirectCounter (uint16_t redirectCounter)
 Set the redirect counter.
 
void SetStateful (bool stateful)
 
void WaitDone (time_t now)
 
XRootDStatus WriteMessageBody (Socket *socket, uint32_t &bytesWritten) override
 
- Public Member Functions inherited from XrdCl::MsgHandler
virtual ~MsgHandler ()
 Event types that the message handler may receive.
 

Friends

class HandleRspJob
 

Additional Inherited Members

- Public Types inherited from XrdCl::MsgHandler
enum  Action {
  None = 0x0000 ,
  Nop = 0x0001 ,
  Ignore = 0x0002 ,
  RemoveHandler = 0x0004 ,
  Raw = 0x0008 ,
  NoProcess = 0x0010 ,
  Corrupted = 0x0020 ,
  More = 0x0040
}
 Actions to be taken after a message is processed by the handler. More...
 
enum  StreamEvent {
  Ready = 1 ,
  Broken = 2 ,
  Timeout = 3 ,
  FatalError = 4
}
 Events that may have occurred to the stream. More...
 

Detailed Description

Handle/Process/Forward XRootD messages.

Definition at line 119 of file XrdClXRootDMsgHandler.hh.

Constructor & Destructor Documentation

◆ XRootDMsgHandler()

XrdCl::XRootDMsgHandler::XRootDMsgHandler ( Message * msg,
ResponseHandler * respHandler,
const URL * url,
std::shared_ptr< SIDManager > sidMgr,
LocalFileHandler * lFileHandler )
inline

Constructor

Parameters
msgmessage that has been sent out
respHandlerresponse handler to be called then the final final response arrives
urlthe url the message has been sent to
sidMgrthe sid manager used to allocate SID for the initial message

Definition at line 134 of file XrdClXRootDMsgHandler.hh.

138 :
139 pRequest( msg ),
140 pResponseHandler( respHandler ),
141 pUrl( *url ),
142 pEffectiveDataServerUrl( 0 ),
143 pSidMgr( sidMgr ),
144 pLFileHandler( lFileHandler ),
145 pExpiration( 0 ),
146 pRedirectAsAnswer( false ),
147 pOksofarAsAnswer( false ),
148 pHasLoadBalancer( false ),
149 pHasSessionId( false ),
150 pChunkList( 0 ),
151 pKBuff( 0 ),
152 pRedirectCounter( 0 ),
153 pNotAuthorizedCounter( 0 ),
154
155 pAsyncOffset( 0 ),
156 pAsyncChunkIndex( 0 ),
157
158 pPgWrtCksumBuff( 4 ),
159 pPgWrtCurrentPageOffset( 0 ),
160 pPgWrtCurrentPageNb( 0 ),
161
162 pOtherRawStarted( false ),
163
164 pFollowMetalink( false ),
165
166 pStateful( false ),
167
168 pAggregatedWaitTime( 0 ),
169
170 pMsgInFly( false ),
171 pSendingState( 0 ),
172
173 pTimeoutFence( false ),
174
175 pDirListStarted( false ),
176 pDirListWithStat( false ),
177
178 pCV( 0 ),
179
180 pSslErrCnt( 0 )
181 {
182 pPostMaster = DefaultEnv::GetPostMaster();
183 if( msg->GetSessionId() )
184 pHasSessionId = true;
185
186 Log *log = DefaultEnv::GetLog();
187 log->Debug( ExDbgMsg, "[%s] MsgHandler created: %p (message: %s ).",
188 pUrl.GetHostId().c_str(), this,
189 pRequest->GetObfuscatedDescription().c_str() );
190
191 ClientRequestHdr *hdr = (ClientRequestHdr*)pRequest->GetBuffer();
192 if( ntohs( hdr->requestid ) == kXR_pgread )
193 {
194 ClientPgReadRequest *pgrdreq = (ClientPgReadRequest*)pRequest->GetBuffer();
195 pCrc32cDigests.reserve( XrdOucPgrwUtils::csNum( ntohll( pgrdreq->offset ),
196 ntohl( pgrdreq->rlen ) ) );
197 }
198
199 if( ntohs( hdr->requestid ) == kXR_readv )
200 pBodyReader.reset( new AsyncVectorReader( *url, *pRequest ) );
201 else if( ntohs( hdr->requestid ) == kXR_read )
202 pBodyReader.reset( new AsyncRawReader( *url, *pRequest ) );
203 else
204 pBodyReader.reset( new AsyncDiscardReader( *url, *pRequest ) );
205 }
kXR_unt16 requestid
Definition XProtocol.hh:157
@ kXR_read
Definition XProtocol.hh:125
@ kXR_readv
Definition XProtocol.hh:137
@ kXR_pgread
Definition XProtocol.hh:142
const char * GetBuffer(uint32_t offset=0) const
Get the message buffer.
static Log * GetLog()
Get default log.
static PostMaster * GetPostMaster()
Get default post master.
const std::string & GetObfuscatedDescription() const
Get the description of the message with authz parameter obfuscated.
std::string GetHostId() const
Get the host part of the URL (user:password@host:port)
Definition XrdClURL.hh:99
static int csNum(off_t offs, int count)
Compute the required size of a checksum vector based on offset & length.
const uint64_t ExDbgMsg
XrdSysError Log
Definition XrdConfig.cc:113

References XrdOucPgrwUtils::csNum(), XrdCl::Log::Debug(), XrdCl::ExDbgMsg, XrdCl::Buffer::GetBuffer(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), XrdCl::Message::GetObfuscatedDescription(), XrdCl::DefaultEnv::GetPostMaster(), XrdCl::Message::GetSessionId(), kXR_pgread, kXR_read, kXR_readv, ClientPgReadRequest::offset, ClientRequestHdr::requestid, and ClientPgReadRequest::rlen.

+ Here is the call graph for this function:

◆ ~XRootDMsgHandler()

XrdCl::XRootDMsgHandler::~XRootDMsgHandler ( )
inline

Destructor.

Definition at line 210 of file XrdClXRootDMsgHandler.hh.

211 {
212 DumpRedirectTraceBack();
213
214 if( !pHasSessionId )
215 delete pRequest;
216 delete pEffectiveDataServerUrl;
217
218 pRequest = reinterpret_cast<Message*>( 0xDEADBEEF );
219 pResponseHandler = reinterpret_cast<ResponseHandler*>( 0xDEADBEEF );
220 pPostMaster = reinterpret_cast<PostMaster*>( 0xDEADBEEF );
221 pLFileHandler = reinterpret_cast<LocalFileHandler*>( 0xDEADBEEF );
222 pChunkList = reinterpret_cast<ChunkList*>( 0xDEADBEEF );
223 pEffectiveDataServerUrl = reinterpret_cast<URL*>( 0xDEADBEEF );
224
225 Log *log = DefaultEnv::GetLog();
226 log->Debug( ExDbgMsg, "[%s] Destroying MsgHandler: %p.",
227 pUrl.GetHostId().c_str(), this );
228 }
std::vector< ChunkInfo > ChunkList
List of chunks.

References XrdCl::Log::Debug(), XrdCl::ExDbgMsg, XrdCl::URL::GetHostId(), and XrdCl::DefaultEnv::GetLog().

+ Here is the call graph for this function:

Member Function Documentation

◆ Examine()

uint16_t XrdCl::XRootDMsgHandler::Examine ( std::shared_ptr< Message > & msg)
overridevirtual

Examine an incoming message, and decide on the action to be taken

Parameters
msgthe message, may be zero if receive failed
Returns
action type that needs to be take wrt the message and the handler

Implements XrdCl::MsgHandler.

Definition at line 109 of file XrdClXRootDMsgHandler.cc.

110 {
111 const int sst = pSendingState.fetch_or( kSawResp );
112
113 if( !( sst & kSendDone ) && !( sst & kSawResp ) )
114 {
115 // we must have been sent although we haven't got the OnStatusReady
116 // notification yet. Set the inflight notice.
117
118 Log *log = DefaultEnv::GetLog();
119 log->Dump( XRootDMsg, "[%s] Message %s reply received before notification "
120 "that it was sent, assuming it was sent ok.",
121 pUrl.GetHostId().c_str(),
122 pRequest->GetObfuscatedDescription().c_str() );
123
124 pMsgInFly = true;
125 }
126
127 //--------------------------------------------------------------------------
128 // if the MsgHandler is already being used to process another request
129 // (kXR_oksofar) we need to wait
130 //--------------------------------------------------------------------------
131 if( pOksofarAsAnswer )
132 {
133 XrdSysCondVarHelper lck( pCV );
134 while( pResponse ) pCV.Wait();
135 }
136 else
137 {
138 if( pResponse )
139 {
140 Log *log = DefaultEnv::GetLog();
141 log->Warning( ExDbgMsg, "[%s] MsgHandler is examining a response although "
142 "it already owns a response: %p (message: %s ).",
143 pUrl.GetHostId().c_str(), this,
144 pRequest->GetObfuscatedDescription().c_str() );
145 }
146 }
147
148 if( msg->GetSize() < 8 )
149 return Ignore;
150
151 ServerResponse *rsp = (ServerResponse *)msg->GetBuffer();
152 ClientRequest *req = (ClientRequest *)pRequest->GetBuffer();
153 uint16_t status = 0;
154 uint32_t dlen = 0;
155
156 //--------------------------------------------------------------------------
157 // We only care about async responses, but those are extracted now
158 // in the SocketHandler.
159 //--------------------------------------------------------------------------
160 if( rsp->hdr.status == kXR_attn )
161 {
162 return Ignore;
163 }
164 //--------------------------------------------------------------------------
165 // We got a sync message - check if it belongs to us
166 //--------------------------------------------------------------------------
167 else
168 {
169 if( rsp->hdr.streamid[0] != req->header.streamid[0] ||
170 rsp->hdr.streamid[1] != req->header.streamid[1] )
171 return Ignore;
172
173 status = rsp->hdr.status;
174 dlen = rsp->hdr.dlen;
175 }
176
177 //--------------------------------------------------------------------------
178 // We take the ownership of the message and decide what we will do
179 // with the handler itself, the options are:
180 // 1) we want to either read in raw mode (the Raw flag) or have the message
181 // body reconstructed for us by the TransportHandler by the time
182 // Process() is called (default, no extra flag)
183 // 2) we either got a full response in which case we don't want to be
184 // notified about anything anymore (RemoveHandler) or we got a partial
185 // answer and we need to wait for more (default, no extra flag)
186 //--------------------------------------------------------------------------
187 pResponse = msg;
188 pBodyReader->SetDataLength( dlen );
189
190 Log *log = DefaultEnv::GetLog();
191 switch( status )
192 {
193 //------------------------------------------------------------------------
194 // Handle the cached cases
195 //------------------------------------------------------------------------
196 case kXR_error:
197 case kXR_redirect:
198 case kXR_wait:
199 return RemoveHandler;
200
201 case kXR_waitresp:
202 {
203 log->Dump( XRootDMsg, "[%s] Got kXR_waitresp response to "
204 "message %s", pUrl.GetHostId().c_str(),
205 pRequest->GetObfuscatedDescription().c_str() );
206
207 pResponse.reset();
208 return Ignore; // This must be handled synchronously!
209 }
210
211 //------------------------------------------------------------------------
212 // Handle the potential raw cases
213 //------------------------------------------------------------------------
214 case kXR_ok:
215 {
216 //----------------------------------------------------------------------
217 // For kXR_read we read in raw mode
218 //----------------------------------------------------------------------
219 uint16_t reqId = ntohs( req->header.requestid );
220 if( reqId == kXR_read )
221 {
222 return Raw | RemoveHandler;
223 }
224
225 //----------------------------------------------------------------------
226 // kXR_readv is the same as kXR_read
227 //----------------------------------------------------------------------
228 if( reqId == kXR_readv )
229 {
230 return Raw | RemoveHandler;
231 }
232
233 //----------------------------------------------------------------------
234 // For everything else we just take what we got
235 //----------------------------------------------------------------------
236 return RemoveHandler;
237 }
238
239 //------------------------------------------------------------------------
240 // kXR_oksofars are special, they are not full responses, so we reset
241 // the response pointer to 0 and add the message to the partial list
242 //------------------------------------------------------------------------
243 case kXR_oksofar:
244 {
245 log->Dump( XRootDMsg, "[%s] Got a kXR_oksofar response to request "
246 "%s", pUrl.GetHostId().c_str(),
247 pRequest->GetObfuscatedDescription().c_str() );
248
249 if( !pOksofarAsAnswer )
250 {
251 pPartialResps.emplace_back( std::move( pResponse ) );
252 }
253
254 //----------------------------------------------------------------------
255 // For kXR_read we either read in raw mode if the message has not
256 // been fully reconstructed already, if it has, we adjust
257 // the buffer offset to prepare for the next one
258 //----------------------------------------------------------------------
259 uint16_t reqId = ntohs( req->header.requestid );
260 if( reqId == kXR_read )
261 {
262 pTimeoutFence.store( true, std::memory_order_relaxed );
263 return Raw | ( pOksofarAsAnswer ? None : NoProcess );
264 }
265
266 //----------------------------------------------------------------------
267 // kXR_readv is similar to read, except that the payload is different
268 //----------------------------------------------------------------------
269 if( reqId == kXR_readv )
270 {
271 pTimeoutFence.store( true, std::memory_order_relaxed );
272 return Raw | ( pOksofarAsAnswer ? None : NoProcess );
273 }
274
275 return ( pOksofarAsAnswer ? None : NoProcess );
276 }
277
278 case kXR_status:
279 {
280 log->Dump( XRootDMsg, "[%s] Got a kXR_status response to request "
281 "%s", pUrl.GetHostId().c_str(),
282 pRequest->GetObfuscatedDescription().c_str() );
283
284 uint16_t reqId = ntohs( req->header.requestid );
285 if( reqId == kXR_pgwrite )
286 {
287 //--------------------------------------------------------------------
288 // In case of pgwrite by definition this wont be a partial response
289 // so we can already remove the handler from the in-queue
290 //--------------------------------------------------------------------
291 return RemoveHandler;
292 }
293
294 //----------------------------------------------------------------------
295 // Otherwise (pgread), first of all we need to read the body of the
296 // kXR_status response, we can handle the raw data (if any) only after
297 // we have the whole kXR_status body
298 //----------------------------------------------------------------------
299 pTimeoutFence.store( true, std::memory_order_relaxed );
300 return None;
301 }
302
303 //------------------------------------------------------------------------
304 // Default
305 //------------------------------------------------------------------------
306 default:
307 return RemoveHandler;
308 }
309 return RemoveHandler;
310 }
kXR_char streamid[2]
Definition XProtocol.hh:156
kXR_char streamid[2]
Definition XProtocol.hh:914
@ kXR_waitresp
Definition XProtocol.hh:906
@ kXR_redirect
Definition XProtocol.hh:904
@ kXR_oksofar
Definition XProtocol.hh:900
@ kXR_status
Definition XProtocol.hh:907
@ kXR_ok
Definition XProtocol.hh:899
@ kXR_attn
Definition XProtocol.hh:901
@ kXR_wait
Definition XProtocol.hh:905
@ kXR_error
Definition XProtocol.hh:903
struct ClientRequestHdr header
Definition XProtocol.hh:846
@ kXR_pgwrite
Definition XProtocol.hh:138
ServerResponseHeader hdr
@ Ignore
Ignore the message.
const uint64_t XRootDMsg

References ServerResponseHeader::dlen, XrdCl::Log::Dump(), XrdCl::ExDbgMsg, XrdCl::Buffer::GetBuffer(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), XrdCl::Message::GetObfuscatedDescription(), ServerResponse::hdr, ClientRequest::header, XrdCl::MsgHandler::Ignore, kXR_attn, kXR_error, kXR_ok, kXR_oksofar, kXR_pgwrite, kXR_read, kXR_readv, kXR_redirect, kXR_status, kXR_wait, kXR_waitresp, XrdCl::MsgHandler::None, XrdCl::MsgHandler::NoProcess, XrdCl::MsgHandler::Raw, XrdCl::MsgHandler::RemoveHandler, ClientRequestHdr::requestid, ServerResponseHeader::status, ClientRequestHdr::streamid, ServerResponseHeader::streamid, XrdSysCondVar::Wait(), XrdCl::Log::Warning(), and XrdCl::XRootDMsg.

+ Here is the call graph for this function:

◆ GetExpiration()

time_t XrdCl::XRootDMsgHandler::GetExpiration ( )
inlineoverridevirtual

Get a timestamp after which we give up.

Implements XrdCl::MsgHandler.

Definition at line 331 of file XrdClXRootDMsgHandler.hh.

332 {
333 return pExpiration;
334 }

◆ GetRequest()

const Message * XrdCl::XRootDMsgHandler::GetRequest ( ) const
inline

Get the request pointer.

Definition at line 357 of file XrdClXRootDMsgHandler.hh.

358 {
359 return pRequest;
360 }

◆ GetSid()

uint16_t XrdCl::XRootDMsgHandler::GetSid ( ) const
overridevirtual

Get handler sid

return sid of the corresponding request, otherwise 0

Implements XrdCl::MsgHandler.

Definition at line 405 of file XrdClXRootDMsgHandler.cc.

406 {
407 ClientRequest* req = (ClientRequest*) pRequest->GetBuffer();
408 return ((uint16_t)req->header.streamid[1] << 8) | (uint16_t)req->header.streamid[0];
409 }

References XrdCl::Buffer::GetBuffer(), ClientRequest::header, and ClientRequestHdr::streamid.

+ Here is the call graph for this function:

◆ InspectStatusRsp()

uint16_t XrdCl::XRootDMsgHandler::InspectStatusRsp ( )
overridevirtual

Reexamine the incoming message, and decide on the action to be taken

In case of kXR_status the message can be only fully examined after reading the whole body (without raw data).

Parameters
msgthe message, may be zero if receive failed
Returns
action type that needs to be take wrt the message and the handler

Implements XrdCl::MsgHandler.

Definition at line 315 of file XrdClXRootDMsgHandler.cc.

316 {
317 if( !pResponse )
318 return 0;
319
320 Log *log = DefaultEnv::GetLog();
321 ServerResponse *rsp = (ServerResponse *)pResponse->GetBuffer();
322
323 //--------------------------------------------------------------------------
324 // Additional action is only required for kXR_status
325 //--------------------------------------------------------------------------
326 if( rsp->hdr.status != kXR_status ) return 0;
327
328 //--------------------------------------------------------------------------
329 // Ignore malformed status response
330 //--------------------------------------------------------------------------
331 if( pResponse->GetSize() < sizeof( ServerResponseStatus ) )
332 {
333 log->Error( XRootDMsg, "[%s] kXR_status: invalid message size.", pUrl.GetHostId().c_str() );
334 return Corrupted;
335 }
336
337 ClientRequest *req = (ClientRequest *)pRequest->GetBuffer();
338 uint16_t reqId = ntohs( req->header.requestid );
339 //--------------------------------------------------------------------------
340 // Unmarshal the status body
341 //--------------------------------------------------------------------------
342 XRootDStatus st = XRootDTransport::UnMarshalStatusBody( *pResponse, reqId );
343
344 if( !st.IsOK() && st.code == errDataError )
345 {
346 log->Error( XRootDMsg, "[%s] %s", pUrl.GetHostId().c_str(),
347 st.GetErrorMessage().c_str() );
348 return Corrupted;
349 }
350
351 if( !st.IsOK() )
352 {
353 log->Error( XRootDMsg, "[%s] Failed to unmarshall status body.",
354 pUrl.GetHostId().c_str() );
355 pStatus = st;
356 HandleRspOrQueue();
357 return Ignore;
358 }
359
360 //--------------------------------------------------------------------------
361 // Common handling for partial results
362 //--------------------------------------------------------------------------
363 ServerResponseV2 *rspst = (ServerResponseV2*)pResponse->GetBuffer();
365 {
366 pPartialResps.push_back( std::move( pResponse ) );
367 }
368
369 //--------------------------------------------------------------------------
370 // Decide the actions that we need to take
371 //--------------------------------------------------------------------------
372 uint16_t action = 0;
373 if( reqId == kXR_pgread )
374 {
375 //----------------------------------------------------------------------
376 // The message contains only Status header and body but no raw data
377 //----------------------------------------------------------------------
378 if( !pPageReader )
379 pPageReader.reset( new AsyncPageReader( *pChunkList, pCrc32cDigests ) );
380 pPageReader->SetRsp( rspst );
381
382 action |= Raw;
383
385 action |= NoProcess;
386 else
387 action |= RemoveHandler;
388 }
389 else if( reqId == kXR_pgwrite )
390 {
391 // if data corruption has been detected on the server side we will
392 // send some additional data pointing to the pages that need to be
393 // retransmitted
394 if( size_t( sizeof( ServerResponseHeader ) + rspst->status.hdr.dlen + rspst->status.bdy.dlen ) >
395 pResponse->GetCursor() )
396 action |= More;
397 }
398
399 return action;
400 }
ServerResponseStatus status
struct ServerResponseBody_Status bdy
struct ServerResponseHeader hdr
@ More
there are more (non-raw) data to be read
static XRootDStatus UnMarshalStatusBody(Message &msg, uint16_t reqType)
Unmarshall the body of the status response.
const uint16_t errDataError
data is corrupted
@ kXR_PartialResult

References ServerResponseStatus::bdy, XrdCl::Status::code, XrdCl::MsgHandler::Corrupted, ServerResponseBody_Status::dlen, ServerResponseHeader::dlen, XrdCl::errDataError, XrdCl::Log::Error(), XrdCl::Buffer::GetBuffer(), XrdCl::XRootDStatus::GetErrorMessage(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), ServerResponse::hdr, ServerResponseStatus::hdr, ClientRequest::header, XrdCl::MsgHandler::Ignore, XrdCl::Status::IsOK(), XrdProto::kXR_PartialResult, kXR_pgread, kXR_pgwrite, kXR_status, XrdCl::MsgHandler::More, XrdCl::MsgHandler::NoProcess, XrdCl::MsgHandler::Raw, XrdCl::MsgHandler::RemoveHandler, ClientRequestHdr::requestid, ServerResponseBody_Status::resptype, ServerResponseHeader::status, ServerResponseV2::status, XrdCl::XRootDTransport::UnMarshalStatusBody(), and XrdCl::XRootDMsg.

+ Here is the call graph for this function:

◆ IsRaw()

bool XrdCl::XRootDMsgHandler::IsRaw ( ) const
overridevirtual

Are we a raw writer or not?

Reimplemented from XrdCl::MsgHandler.

Definition at line 960 of file XrdClXRootDMsgHandler.cc.

961 {
962 ClientRequest *req = (ClientRequest *)pRequest->GetBuffer();
963 uint16_t reqId = ntohs( req->header.requestid );
964 if( reqId == kXR_write || reqId == kXR_writev || reqId == kXR_pgwrite )
965 return true;
966 // checkpoint + execute
967 if( reqId == kXR_chkpoint && req->chkpoint.opcode == kXR_ckpXeq )
968 {
969 ClientRequest *xeq = (ClientRequest*)pRequest->GetBuffer( sizeof( ClientRequest ) );
970 reqId = ntohs( xeq->header.requestid );
971 return reqId != kXR_truncate; // only checkpointed truncate does not have raw data
972 }
973
974 return false;
975 }
static const int kXR_ckpXeq
Definition XProtocol.hh:216
@ kXR_writev
Definition XProtocol.hh:143
@ kXR_write
Definition XProtocol.hh:131
@ kXR_truncate
Definition XProtocol.hh:140
@ kXR_chkpoint
Definition XProtocol.hh:124
struct ClientChkPointRequest chkpoint
Definition XProtocol.hh:849

References ClientRequest::chkpoint, XrdCl::Buffer::GetBuffer(), ClientRequest::header, kXR_chkpoint, kXR_ckpXeq, kXR_pgwrite, kXR_truncate, kXR_write, kXR_writev, ClientChkPointRequest::opcode, and ClientRequestHdr::requestid.

+ Here is the call graph for this function:

◆ OnReadyToSend()

void XrdCl::XRootDMsgHandler::OnReadyToSend ( Message * msg)
inlineoverridevirtual

Called just before the message is going to be sent through a valid connection, so that the user can still make some modifications that were impossible before (ie. protocol version dependent adjustments)

Parameters
msgmessage concerned

Reimplemented from XrdCl::MsgHandler.

Definition at line 433 of file XrdClXRootDMsgHandler.hh.

434 {
435 pSendingState = 0;
436 }

◆ OnStatusReady()

void XrdCl::XRootDMsgHandler::OnStatusReady ( const Message * message,
XRootDStatus status )
overridevirtual

The requested action has been performed and the status is available.

Implements XrdCl::MsgHandler.

Definition at line 912 of file XrdClXRootDMsgHandler.cc.

914 {
915 Log *log = DefaultEnv::GetLog();
916
917 const int sst = pSendingState.fetch_or( kSendDone );
918
919 if( sst & kFinalResp )
920 {
921 log->Dump( XRootDMsg, "[%s] Got late notification that outgoing message %s was "
922 "sent, already have final response, queuing handler callback.",
923 pUrl.GetHostId().c_str(), message->GetObfuscatedDescription().c_str() );
924 HandleRspOrQueue();
925 return;
926 }
927
928 if( sst & kSawResp )
929 {
930 log->Dump( XRootDMsg, "[%s] Got late notification that message %s has "
931 "been successfully sent.",
932 pUrl.GetHostId().c_str(), message->GetObfuscatedDescription().c_str() );
933 return;
934 }
935
936 //--------------------------------------------------------------------------
937 // We were successful, so we now need to listen for a response
938 //--------------------------------------------------------------------------
939 if( status.IsOK() )
940 {
941 log->Dump( XRootDMsg, "[%s] Message %s has been successfully sent.",
942 pUrl.GetHostId().c_str(), message->GetObfuscatedDescription().c_str() );
943
944 pMsgInFly = true;
945 return;
946 }
947
948 //--------------------------------------------------------------------------
949 // We have failed, recover if possible
950 //--------------------------------------------------------------------------
951 log->Error( XRootDMsg, "[%s] Impossible to send message %s. Trying to "
952 "recover.", pUrl.GetHostId().c_str(),
953 message->GetObfuscatedDescription().c_str() );
954 HandleError( status );
955 }

References XrdCl::Log::Dump(), XrdCl::Log::Error(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), XrdCl::Message::GetObfuscatedDescription(), XrdCl::Status::IsOK(), and XrdCl::XRootDMsg.

+ Here is the call graph for this function:

◆ OnStreamEvent()

uint8_t XrdCl::XRootDMsgHandler::OnStreamEvent ( StreamEvent event,
XRootDStatus status )
overridevirtual

Handle an event other that a message arrival

Parameters
eventtype of the event
statusstatus info

Reimplemented from XrdCl::MsgHandler.

Definition at line 875 of file XrdClXRootDMsgHandler.cc.

877 {
878 Log *log = DefaultEnv::GetLog();
879 log->Dump( XRootDMsg, "[%s] Stream event reported for msg %s",
880 pUrl.GetHostId().c_str(), pRequest->GetObfuscatedDescription().c_str() );
881
882 if( event == Ready )
883 return 0;
884
885 if( pTimeoutFence.load( std::memory_order_relaxed ) )
886 return 0;
887
888 HandleError( status );
889 return RemoveHandler;
890 }
@ Ready
The stream has become connected.

References XrdCl::Log::Dump(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), XrdCl::Message::GetObfuscatedDescription(), XrdCl::MsgHandler::Ready, XrdCl::MsgHandler::RemoveHandler, and XrdCl::XRootDMsg.

+ Here is the call graph for this function:

◆ PartialReceived()

void XrdCl::XRootDMsgHandler::PartialReceived ( )

Bookkeeping after partial response has been received:

  • take down the timeout fence after oksofar response has been handled
  • reset status-response-body marshaled flag

Definition at line 1137 of file XrdClXRootDMsgHandler.cc.

1138 {
1139 pTimeoutFence.store( false, std::memory_order_relaxed ); // Take down the timeout fence
1140 }

Referenced by XrdCl::Stream::ForceError(), XrdCl::Stream::OnError(), and XrdCl::Stream::OnIncoming().

+ Here is the caller graph for this function:

◆ Process()

void XrdCl::XRootDMsgHandler::Process ( )
overridevirtual

Process the message if it was "taken" by the examine action.

Process the message if it was "taken" by the examine action

Parameters
msgthe message to be processed

Reimplemented from XrdCl::MsgHandler.

Definition at line 414 of file XrdClXRootDMsgHandler.cc.

415 {
416 Log *log = DefaultEnv::GetLog();
417
418 ServerResponse *rsp = (ServerResponse *)pResponse->GetBuffer();
419
420 ClientRequest *req = (ClientRequest *)pRequest->GetBuffer();
421
422 //--------------------------------------------------------------------------
423 // If it is a local file, it can be only a metalink redirector
424 //--------------------------------------------------------------------------
425 if( pUrl.IsLocalFile() && pUrl.IsMetalink() )
426 pHosts->back().protocol = kXR_PROTOCOLVERSION;
427
428 //--------------------------------------------------------------------------
429 // We got an answer, check who we were talking to
430 //--------------------------------------------------------------------------
431 else
432 {
433 AnyObject qryResult;
434 int *qryResponse = 0;
435 pPostMaster->QueryTransport( pUrl, XRootDQuery::ServerFlags, qryResult );
436 qryResult.Get( qryResponse );
437 pHosts->back().flags = *qryResponse; delete qryResponse; qryResponse = 0;
438 pPostMaster->QueryTransport( pUrl, XRootDQuery::ProtocolVersion, qryResult );
439 qryResult.Get( qryResponse );
440 pHosts->back().protocol = *qryResponse; delete qryResponse;
441 }
442
443 //--------------------------------------------------------------------------
444 // Process the message
445 //--------------------------------------------------------------------------
446 Status st = XRootDTransport::UnMarshallBody( pResponse.get(), req->header.requestid );
447 if( !st.IsOK() )
448 {
449 pStatus = Status( stFatal, errInvalidMessage );
450 HandleResponse();
451 return;
452 }
453
454 //--------------------------------------------------------------------------
455 // we have an response for the message so it's not in fly anymore
456 //--------------------------------------------------------------------------
457 pMsgInFly = false;
458
459 //--------------------------------------------------------------------------
460 // Reset the aggregated wait (used to omit wait response in case of Metalink
461 // redirector)
462 //--------------------------------------------------------------------------
463 if( rsp->hdr.status != kXR_wait )
464 pAggregatedWaitTime = 0;
465
466 switch( rsp->hdr.status )
467 {
468 //------------------------------------------------------------------------
469 // kXR_ok - we're done here
470 //------------------------------------------------------------------------
471 case kXR_ok:
472 {
473 log->Dump( XRootDMsg, "[%s] Got a kXR_ok response to request %s",
474 pUrl.GetHostId().c_str(),
475 pRequest->GetObfuscatedDescription().c_str() );
476 pStatus = Status();
477 HandleResponse();
478 return;
479 }
480
481 case kXR_status:
482 {
483 log->Dump( XRootDMsg, "[%s] Got a kXR_status response to request %s",
484 pUrl.GetHostId().c_str(),
485 pRequest->GetObfuscatedDescription().c_str() );
486 pStatus = Status();
487 HandleResponse();
488 return;
489 }
490
491 //------------------------------------------------------------------------
492 // kXR_ok - we're serving partial result to the user
493 //------------------------------------------------------------------------
494 case kXR_oksofar:
495 {
496 log->Dump( XRootDMsg, "[%s] Got a kXR_oksofar response to request %s",
497 pUrl.GetHostId().c_str(),
498 pRequest->GetObfuscatedDescription().c_str() );
499 pStatus = Status( stOK, suContinue );
500 HandleResponse();
501 return;
502 }
503
504 //------------------------------------------------------------------------
505 // kXR_error - we've got a problem
506 //------------------------------------------------------------------------
507 case kXR_error:
508 {
509 char *errmsg = new char[rsp->hdr.dlen-3]; errmsg[rsp->hdr.dlen-4] = 0;
510 memcpy( errmsg, rsp->body.error.errmsg, rsp->hdr.dlen-4 );
511 log->Dump( XRootDMsg, "[%s] Got a kXR_error response to request %s "
512 "[%d] %s", pUrl.GetHostId().c_str(),
513 pRequest->GetObfuscatedDescription().c_str(), rsp->body.error.errnum,
514 errmsg );
515 delete [] errmsg;
516
517 HandleError( Status(stError, errErrorResponse, rsp->body.error.errnum) );
518 return;
519 }
520
521 //------------------------------------------------------------------------
522 // kXR_redirect - they tell us to go elsewhere
523 //------------------------------------------------------------------------
524 case kXR_redirect:
525 {
526 if( rsp->hdr.dlen <= 4 )
527 {
528 log->Error( XRootDMsg, "[%s] Got invalid redirect response.",
529 pUrl.GetHostId().c_str() );
530 pStatus = Status( stError, errInvalidResponse );
531 HandleResponse();
532 return;
533 }
534
535 char *urlInfoBuff = new char[rsp->hdr.dlen-3];
536 urlInfoBuff[rsp->hdr.dlen-4] = 0;
537 memcpy( urlInfoBuff, rsp->body.redirect.host, rsp->hdr.dlen-4 );
538 std::string urlInfo = urlInfoBuff;
539 delete [] urlInfoBuff;
540 log->Dump( XRootDMsg, "[%s] Got kXR_redirect response to "
541 "message %s: %s, port %d", pUrl.GetHostId().c_str(),
542 pRequest->GetObfuscatedDescription().c_str(), urlInfo.c_str(),
543 rsp->body.redirect.port );
544
545 //----------------------------------------------------------------------
546 // Check if we can proceed
547 //----------------------------------------------------------------------
548 if( !pRedirectCounter )
549 {
550 log->Warning( XRootDMsg, "[%s] Redirect limit has been reached for "
551 "message %s, the last known error is: %s",
552 pUrl.GetHostId().c_str(),
553 pRequest->GetObfuscatedDescription().c_str(),
554 pLastError.ToString().c_str() );
555
556
557 pStatus = Status( stFatal, errRedirectLimit );
558 HandleResponse();
559 return;
560 }
561 --pRedirectCounter;
562
563 //----------------------------------------------------------------------
564 // Keep the info about this server if we still need to find a load
565 // balancer
566 //----------------------------------------------------------------------
567 uint32_t flags = pHosts->back().flags;
568 if( !pHasLoadBalancer )
569 {
570 if( flags & kXR_isManager )
571 {
572 //------------------------------------------------------------------
573 // If the current server is a meta manager then it supersedes
574 // any existing load balancer, otherwise we assign a load-balancer
575 // only if it has not been already assigned
576 //------------------------------------------------------------------
577 if( ( flags & kXR_attrMeta ) || !pLoadBalancer.url.IsValid() )
578 {
579 pLoadBalancer = pHosts->back();
580 log->Dump( XRootDMsg, "[%s] Current server has been assigned "
581 "as a load-balancer for message %s",
582 pUrl.GetHostId().c_str(),
583 pRequest->GetObfuscatedDescription().c_str() );
584 HostList::iterator it;
585 for( it = pHosts->begin(); it != pHosts->end(); ++it )
586 it->loadBalancer = false;
587 pHosts->back().loadBalancer = true;
588 }
589 }
590 }
591
592 //----------------------------------------------------------------------
593 // If the redirect comes from a data server safe the URL because
594 // in case of a failure we will use it as the effective data server URL
595 // for the tried CGI opaque info
596 //----------------------------------------------------------------------
597 if( flags & kXR_isServer )
598 pEffectiveDataServerUrl = new URL( pHosts->back().url );
599
600 //----------------------------------------------------------------------
601 // Build the URL and check it's validity
602 //----------------------------------------------------------------------
603 std::vector<std::string> urlComponents;
604 std::string newCgi;
605 Utils::splitString( urlComponents, urlInfo, "?" );
606
607 std::ostringstream o;
608
609 o << urlComponents[0];
610 if( rsp->body.redirect.port > 0 )
611 o << ":" << rsp->body.redirect.port << "/";
612 else if( rsp->body.redirect.port < 0 )
613 {
614 //--------------------------------------------------------------------
615 // check if the manager wants to enforce write recovery at himself
616 // (beware we are dealing here with negative flags)
617 //--------------------------------------------------------------------
618 if( ~uint32_t( rsp->body.redirect.port ) & kXR_recoverWrts )
619 pHosts->back().flags |= kXR_recoverWrts;
620
621 //--------------------------------------------------------------------
622 // check if the manager wants to collapse the communication channel
623 // (the redirect host is to replace the current host)
624 //--------------------------------------------------------------------
625 if( ~uint32_t( rsp->body.redirect.port ) & kXR_collapseRedir )
626 {
627 std::string url( rsp->body.redirect.host, rsp->hdr.dlen-4 );
628 pPostMaster->CollapseRedirect( pUrl, url );
629 }
630
631 if( ~uint32_t( rsp->body.redirect.port ) & kXR_ecRedir )
632 {
633 std::string url( rsp->body.redirect.host, rsp->hdr.dlen-4 );
634 if( Utils::CheckEC( pRequest, url ) )
635 pRedirectAsAnswer = true;
636 }
637 }
638
639 URL newUrl = URL( o.str() );
640 if( !newUrl.IsValid() )
641 {
642 pStatus = Status( stError, errInvalidRedirectURL );
643 log->Error( XRootDMsg, "[%s] Got invalid redirection URL: %s",
644 pUrl.GetHostId().c_str(), urlInfo.c_str() );
645 HandleResponse();
646 return;
647 }
648
649 if( pUrl.GetUserName() != "" && newUrl.GetUserName() == "" )
650 newUrl.SetUserName( pUrl.GetUserName() );
651
652 if( pUrl.GetPassword() != "" && newUrl.GetPassword() == "" )
653 newUrl.SetPassword( pUrl.GetPassword() );
654
655 //----------------------------------------------------------------------
656 // Forward any "xrd.*" params from the original client request also to
657 // the new redirection url
658 // Also, we need to preserve any "xrdcl.*' as they are important for
659 // our internal workflows.
660 //----------------------------------------------------------------------
661 std::ostringstream ossXrd;
662 const URL::ParamsMap &urlParams = pUrl.GetParams();
663
664 for(URL::ParamsMap::const_iterator it = urlParams.begin();
665 it != urlParams.end(); ++it )
666 {
667 if( it->first.compare( 0, 4, "xrd." ) &&
668 it->first.compare( 0, 6, "xrdcl." ) )
669 continue;
670
671 ossXrd << it->first << '=' << it->second << '&';
672 }
673
674 std::string xrdCgi = ossXrd.str();
675 pRedirectUrl = newUrl.GetURL();
676
677 URL cgiURL;
678 if( urlComponents.size() > 1 )
679 {
680 pRedirectUrl += "?";
681 pRedirectUrl += urlComponents[1];
682 std::ostringstream o;
683 o << "fake://fake:111//fake?";
684 o << urlComponents[1];
685
686 if( urlComponents.size() == 3 )
687 o << '?' << urlComponents[2];
688
689 if (!xrdCgi.empty())
690 {
691 o << '&' << xrdCgi;
692 pRedirectUrl += '&';
693 pRedirectUrl += xrdCgi;
694 }
695
696 cgiURL = URL( o.str() );
697 }
698 else {
699 if (!xrdCgi.empty())
700 {
701 std::ostringstream o;
702 o << "fake://fake:111//fake?";
703 o << xrdCgi;
704 cgiURL = URL( o.str() );
705 pRedirectUrl += '?';
706 pRedirectUrl += xrdCgi;
707 }
708 }
709
710 //----------------------------------------------------------------------
711 // Check if we need to return the URL as a response
712 //----------------------------------------------------------------------
713 if( newUrl.GetProtocol() != "root" && newUrl.GetProtocol() != "xroot" &&
714 newUrl.GetProtocol() != "roots" && newUrl.GetProtocol() != "xroots" &&
715 !newUrl.IsLocalFile() )
716 pRedirectAsAnswer = true;
717
718 if( pRedirectAsAnswer )
719 {
720 pStatus = Status( stError, errRedirect );
721 HandleResponse();
722 return;
723 }
724
725 //----------------------------------------------------------------------
726 // Rewrite the message in a way required to send it to another server
727 //----------------------------------------------------------------------
728 newUrl.SetParams( cgiURL.GetParams() );
729 Status st = RewriteRequestRedirect( newUrl );
730 if( !st.IsOK() )
731 {
732 pStatus = st;
733 HandleResponse();
734 return;
735 }
736
737 //----------------------------------------------------------------------
738 // Make sure we don't change the protocol by accident (root vs roots)
739 //----------------------------------------------------------------------
740 if( ( pUrl.GetProtocol() == "roots" || pUrl.GetProtocol() == "xroots" ) &&
741 ( newUrl.GetProtocol() == "root" || newUrl.GetProtocol() == "xroot" ) )
742 newUrl.SetProtocol( "roots" );
743
744 //----------------------------------------------------------------------
745 // Send the request to the new location
746 //----------------------------------------------------------------------
747 HandleError( RetryAtServer( newUrl, RedirectEntry::EntryRedirect ) );
748 return;
749 }
750
751 //------------------------------------------------------------------------
752 // kXR_wait - we wait, and re-issue the request later
753 //------------------------------------------------------------------------
754 case kXR_wait:
755 {
756 uint32_t waitSeconds = 0;
757
758 if( rsp->hdr.dlen >= 4 )
759 {
760 char *infoMsg = new char[rsp->hdr.dlen-3];
761 infoMsg[rsp->hdr.dlen-4] = 0;
762 memcpy( infoMsg, rsp->body.wait.infomsg, rsp->hdr.dlen-4 );
763 log->Dump( XRootDMsg, "[%s] Got kXR_wait response of %d seconds to "
764 "message %s: %s", pUrl.GetHostId().c_str(),
765 rsp->body.wait.seconds, pRequest->GetObfuscatedDescription().c_str(),
766 infoMsg );
767 delete [] infoMsg;
768 waitSeconds = rsp->body.wait.seconds;
769 }
770 else
771 {
772 log->Dump( XRootDMsg, "[%s] Got kXR_wait response of 0 seconds to "
773 "message %s", pUrl.GetHostId().c_str(),
774 pRequest->GetObfuscatedDescription().c_str() );
775 }
776
777 pAggregatedWaitTime += waitSeconds;
778
779 // We need a special case if the data node comes from metalink
780 // redirector. In this case it might make more sense to try the
781 // next entry in the Metalink than wait.
782 if( OmitWait( *pRequest, pLoadBalancer.url ) )
783 {
784 int maxWait = DefaultMaxMetalinkWait;
785 DefaultEnv::GetEnv()->GetInt( "MaxMetalinkWait", maxWait );
786 if( pAggregatedWaitTime > maxWait )
787 {
788 UpdateTriedCGI();
789 HandleError( RetryAtServer( pLoadBalancer.url, RedirectEntry::EntryRedirectOnWait ) );
790 return;
791 }
792 }
793
794 //----------------------------------------------------------------------
795 // Some messages require rewriting before they can be sent again
796 // after wait
797 //----------------------------------------------------------------------
798 Status st = RewriteRequestWait();
799 if( !st.IsOK() )
800 {
801 pStatus = st;
802 HandleResponse();
803 return;
804 }
805
806 //----------------------------------------------------------------------
807 // Register a task to resend the message in some seconds, if we still
808 // have time to do that, and report a timeout otherwise
809 //----------------------------------------------------------------------
810 time_t resendTime = ::time(0)+waitSeconds;
811
812 if( resendTime < pExpiration )
813 {
814 log->Debug( ExDbgMsg, "[%s] Scheduling WaitTask for MsgHandler: %p (message: %s ).",
815 pUrl.GetHostId().c_str(), this,
816 pRequest->GetObfuscatedDescription().c_str() );
817
818 TaskManager *taskMgr = pPostMaster->GetTaskManager();
819 taskMgr->RegisterTask( new WaitTask( this ), resendTime );
820 }
821 else
822 {
823 log->Debug( XRootDMsg, "[%s] Wait time is too long, timing out %s",
824 pUrl.GetHostId().c_str(),
825 pRequest->GetObfuscatedDescription().c_str() );
826 HandleError( Status( stError, errOperationExpired) );
827 }
828 return;
829 }
830
831 //------------------------------------------------------------------------
832 // kXR_waitresp - the response will be returned in some seconds as an
833 // unsolicited message. Currently all messages of this type are handled
834 // one step before in the XrdClStream::OnIncoming as they need to be
835 // processed synchronously.
836 //------------------------------------------------------------------------
837 case kXR_waitresp:
838 {
839 if( rsp->hdr.dlen < 4 )
840 {
841 log->Error( XRootDMsg, "[%s] Got invalid waitresp response.",
842 pUrl.GetHostId().c_str() );
843 pStatus = Status( stError, errInvalidResponse );
844 HandleResponse();
845 return;
846 }
847
848 log->Dump( XRootDMsg, "[%s] Got kXR_waitresp response of %d seconds to "
849 "message %s", pUrl.GetHostId().c_str(),
850 rsp->body.waitresp.seconds,
851 pRequest->GetObfuscatedDescription().c_str() );
852 return;
853 }
854
855 //------------------------------------------------------------------------
856 // Default - unrecognized/unsupported response, declare an error
857 //------------------------------------------------------------------------
858 default:
859 {
860 log->Dump( XRootDMsg, "[%s] Got unrecognized response %d to "
861 "message %s", pUrl.GetHostId().c_str(),
862 rsp->hdr.status, pRequest->GetObfuscatedDescription().c_str() );
863 pStatus = Status( stError, errInvalidResponse );
864 HandleResponse();
865 return;
866 }
867 }
868
869 return;
870 }
#define kXR_isManager
union ServerResponse::@0 body
#define kXR_collapseRedir
#define kXR_attrMeta
#define kXR_recoverWrts
#define kXR_isServer
#define kXR_PROTOCOLVERSION
Definition XProtocol.hh:70
#define kXR_ecRedir
static Env * GetEnv()
Get default client environment.
bool GetInt(const std::string &key, int &value)
Definition XrdClEnv.cc:89
void CollapseRedirect(const URL &oldurl, const URL &newURL)
Collapse channel URL - replace the URL of the channel.
TaskManager * GetTaskManager()
Get the task manager object user by the post master.
Status QueryTransport(const URL &url, uint16_t query, AnyObject &result)
void RegisterTask(Task *task, time_t time, bool own=true)
bool IsMetalink() const
Is it a URL to a metalink.
Definition XrdClURL.cc:465
const std::string & GetPassword() const
Get the password.
Definition XrdClURL.hh:153
const std::string & GetUserName() const
Get the username.
Definition XrdClURL.hh:135
std::map< std::string, std::string > ParamsMap
Definition XrdClURL.hh:33
bool IsLocalFile() const
Definition XrdClURL.cc:474
const ParamsMap & GetParams() const
Get the URL params.
Definition XrdClURL.hh:244
const std::string & GetProtocol() const
Get the protocol.
Definition XrdClURL.hh:118
bool IsValid() const
Is the url valid.
Definition XrdClURL.cc:452
static void splitString(Container &result, const std::string &input, const std::string &delimiter)
Split a string.
Definition XrdClUtils.hh:56
static bool CheckEC(const Message *req, const URL &url)
Check if this client can support given EC redirect.
static XRootDStatus UnMarshallBody(Message *msg, uint16_t reqType)
Unmarshall the body of the incoming message.
const uint16_t errRedirectLimit
const int DefaultMaxMetalinkWait
const uint16_t errErrorResponse
const uint16_t errOperationExpired
const uint16_t stFatal
Fatal error, it's still an error.
const uint16_t stError
An error occurred that could potentially be retried.
const uint16_t stOK
Everything went OK.
const uint16_t errInvalidResponse
const uint16_t errInvalidRedirectURL
const uint16_t suContinue
const uint16_t errRedirect
const uint16_t errInvalidMessage
URL url
URL of the host.
std::string ToString() const
Create a string representation.
static const uint16_t ServerFlags
returns server flags
static const uint16_t ProtocolVersion
returns the protocol version

References ServerResponse::body, XrdCl::Utils::CheckEC(), XrdCl::PostMaster::CollapseRedirect(), XrdCl::Log::Debug(), XrdCl::DefaultMaxMetalinkWait, ServerResponseHeader::dlen, XrdCl::Log::Dump(), XrdCl::RedirectEntry::EntryRedirect, XrdCl::RedirectEntry::EntryRedirectOnWait, XrdCl::errErrorResponse, XrdCl::errInvalidMessage, XrdCl::errInvalidRedirectURL, XrdCl::errInvalidResponse, XrdCl::errOperationExpired, XrdCl::Log::Error(), XrdCl::errRedirect, XrdCl::errRedirectLimit, XrdCl::ExDbgMsg, XrdCl::AnyObject::Get(), XrdCl::Buffer::GetBuffer(), XrdCl::DefaultEnv::GetEnv(), XrdCl::URL::GetHostId(), XrdCl::Env::GetInt(), XrdCl::DefaultEnv::GetLog(), XrdCl::Message::GetObfuscatedDescription(), XrdCl::URL::GetParams(), XrdCl::URL::GetPassword(), XrdCl::URL::GetProtocol(), XrdCl::PostMaster::GetTaskManager(), XrdCl::URL::GetURL(), XrdCl::URL::GetUserName(), ServerResponse::hdr, ClientRequest::header, XrdCl::URL::IsLocalFile(), XrdCl::URL::IsMetalink(), XrdCl::Status::IsOK(), XrdCl::URL::IsValid(), kXR_attrMeta, kXR_collapseRedir, kXR_ecRedir, kXR_error, kXR_isManager, kXR_isServer, kXR_ok, kXR_oksofar, kXR_PROTOCOLVERSION, kXR_recoverWrts, kXR_redirect, kXR_status, kXR_wait, kXR_waitresp, XrdCl::XRootDQuery::ProtocolVersion, XrdCl::PostMaster::QueryTransport(), XrdCl::TaskManager::RegisterTask(), ClientRequestHdr::requestid, XrdCl::XRootDQuery::ServerFlags, XrdCl::URL::SetParams(), XrdCl::URL::SetPassword(), XrdCl::URL::SetProtocol(), XrdCl::URL::SetUserName(), XrdCl::Utils::splitString(), ServerResponseHeader::status, XrdCl::stError, XrdCl::stFatal, XrdCl::stOK, XrdCl::suContinue, XrdCl::Status::ToString(), XrdCl::XRootDTransport::UnMarshallBody(), XrdCl::HostInfo::url, XrdCl::Log::Warning(), and XrdCl::XRootDMsg.

+ Here is the call graph for this function:

◆ ReadMessageBody()

XRootDStatus XrdCl::XRootDMsgHandler::ReadMessageBody ( Message * msg,
Socket * socket,
uint32_t & bytesRead )
overridevirtual

Read message body directly from a socket - called if Examine returns Raw flag - only socket related errors may be returned here

Parameters
msgthe corresponding message header
socketthe socket to read from
bytesReadnumber of bytes read by the method
Returns
stOK & suDone if the whole body has been processed stOK & suRetry if more data is needed stError on failure

Reimplemented from XrdCl::MsgHandler.

Definition at line 895 of file XrdClXRootDMsgHandler.cc.

898 {
899 ClientRequest *req = (ClientRequest *)pRequest->GetBuffer();
900 uint16_t reqId = ntohs( req->header.requestid );
901
902 if( reqId == kXR_pgread )
903 return pPageReader->Read( *socket, bytesRead );
904
905 return pBodyReader->Read( *socket, bytesRead );
906 }

References XrdCl::Buffer::GetBuffer(), ClientRequest::header, kXR_pgread, and ClientRequestHdr::requestid.

+ Here is the call graph for this function:

◆ SetChunkList()

void XrdCl::XRootDMsgHandler::SetChunkList ( ChunkList * chunkList)
inline

Set the chunk list.

Definition at line 384 of file XrdClXRootDMsgHandler.hh.

385 {
386 pChunkList = chunkList;
387 if( pBodyReader )
388 pBodyReader->SetChunkList( chunkList );
389 if( chunkList )
390 pChunkStatus.resize( chunkList->size() );
391 else
392 pChunkStatus.clear();
393 }

Referenced by XrdCl::MessageUtils::RedirectMessage(), and XrdCl::MessageUtils::SendMessage().

+ Here is the caller graph for this function:

◆ SetCrc32cDigests()

void XrdCl::XRootDMsgHandler::SetCrc32cDigests ( std::vector< uint32_t > && crc32cDigests)
inline

Definition at line 395 of file XrdClXRootDMsgHandler.hh.

396 {
397 pCrc32cDigests = std::move( crc32cDigests );
398 }

Referenced by XrdCl::MessageUtils::SendMessage().

+ Here is the caller graph for this function:

◆ SetExpiration()

void XrdCl::XRootDMsgHandler::SetExpiration ( time_t expiration)
inline

Set a timestamp after which we give up.

Definition at line 323 of file XrdClXRootDMsgHandler.hh.

324 {
325 pExpiration = expiration;
326 }

Referenced by XrdCl::MessageUtils::RedirectMessage(), and XrdCl::MessageUtils::SendMessage().

+ Here is the caller graph for this function:

◆ SetFollowMetalink()

void XrdCl::XRootDMsgHandler::SetFollowMetalink ( bool followMetalink)
inline

Definition at line 416 of file XrdClXRootDMsgHandler.hh.

417 {
418 pFollowMetalink = followMetalink;
419 }

Referenced by XrdCl::MessageUtils::RedirectMessage().

+ Here is the caller graph for this function:

◆ SetHostList()

void XrdCl::XRootDMsgHandler::SetHostList ( HostList * hostList)
inline

Set host list.

Definition at line 376 of file XrdClXRootDMsgHandler.hh.

377 {
378 pHosts.reset( hostList );
379 }

Referenced by XrdCl::MessageUtils::RedirectMessage(), and XrdCl::MessageUtils::SendMessage().

+ Here is the caller graph for this function:

◆ SetKernelBuffer()

void XrdCl::XRootDMsgHandler::SetKernelBuffer ( XrdSys::KernelBuffer * kbuff)
inline

Set the kernel buffer.

Definition at line 403 of file XrdClXRootDMsgHandler.hh.

404 {
405 pKBuff = kbuff;
406 }

Referenced by XrdCl::MessageUtils::SendMessage().

+ Here is the caller graph for this function:

◆ SetLoadBalancer()

void XrdCl::XRootDMsgHandler::SetLoadBalancer ( const HostInfo & loadBalancer)
inline

Set the load balancer.

Definition at line 365 of file XrdClXRootDMsgHandler.hh.

366 {
367 if( !loadBalancer.url.IsValid() )
368 return;
369 pLoadBalancer = loadBalancer;
370 pHasLoadBalancer = true;
371 }

References XrdCl::URL::IsValid(), and XrdCl::HostInfo::url.

Referenced by XrdCl::MessageUtils::RedirectMessage(), and XrdCl::MessageUtils::SendMessage().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetOksofarAsAnswer()

void XrdCl::XRootDMsgHandler::SetOksofarAsAnswer ( bool oksofarAsAnswer)
inline

Treat the kXR_oksofar response as a valid answer to the message and notify the handler with the URL as a response

Definition at line 349 of file XrdClXRootDMsgHandler.hh.

350 {
351 pOksofarAsAnswer = oksofarAsAnswer;
352 }

Referenced by XrdCl::MessageUtils::RedirectMessage(), and XrdCl::MessageUtils::SendMessage().

+ Here is the caller graph for this function:

◆ SetRedirectAsAnswer()

void XrdCl::XRootDMsgHandler::SetRedirectAsAnswer ( bool redirectAsAnswer)
inline

Treat the kXR_redirect response as a valid answer to the message and notify the handler with the URL as a response

Definition at line 340 of file XrdClXRootDMsgHandler.hh.

341 {
342 pRedirectAsAnswer = redirectAsAnswer;
343 }

Referenced by XrdCl::MessageUtils::RedirectMessage(), and XrdCl::MessageUtils::SendMessage().

+ Here is the caller graph for this function:

◆ SetRedirectCounter()

void XrdCl::XRootDMsgHandler::SetRedirectCounter ( uint16_t redirectCounter)
inline

Set the redirect counter.

Definition at line 411 of file XrdClXRootDMsgHandler.hh.

412 {
413 pRedirectCounter = redirectCounter;
414 }

Referenced by XrdCl::MessageUtils::RedirectMessage(), and XrdCl::MessageUtils::SendMessage().

+ Here is the caller graph for this function:

◆ SetStateful()

void XrdCl::XRootDMsgHandler::SetStateful ( bool stateful)
inline

Definition at line 421 of file XrdClXRootDMsgHandler.hh.

422 {
423 pStateful = stateful;
424 }

Referenced by XrdCl::MessageUtils::SendMessage().

+ Here is the caller graph for this function:

◆ WaitDone()

void XrdCl::XRootDMsgHandler::WaitDone ( time_t now)

Called after the wait time for kXR_wait has elapsed

Parameters
nowcurrent timestamp

Definition at line 1129 of file XrdClXRootDMsgHandler.cc.

1130 {
1131 HandleError( RetryAtServer( pUrl, RedirectEntry::EntryWait ) );
1132 }

References XrdCl::RedirectEntry::EntryWait.

◆ WriteMessageBody()

XRootDStatus XrdCl::XRootDMsgHandler::WriteMessageBody ( Socket * socket,
uint32_t & bytesWritten )
overridevirtual

Write message body directly to a socket - called if IsRaw returns true - only socket related errors may be returned here

Parameters
socketthe socket to read from
bytesWrittennumber of bytes written by the method
Returns
stOK & suDone if the whole body has been processed stOK & suRetry if more data needs to be written stError on failure

Reimplemented from XrdCl::MsgHandler.

Definition at line 980 of file XrdClXRootDMsgHandler.cc.

982 {
983 //--------------------------------------------------------------------------
984 // First check if it is a PgWrite
985 //--------------------------------------------------------------------------
986 if( !pChunkList->empty() && !pCrc32cDigests.empty() )
987 {
988 //------------------------------------------------------------------------
989 // PgWrite will have just one chunk
990 //------------------------------------------------------------------------
991 ChunkInfo chunk = pChunkList->front();
992 //------------------------------------------------------------------------
993 // Calculate the size of the first and last page (in case the chunk is not
994 // 4KB aligned)
995 //------------------------------------------------------------------------
996 int fLen = 0, lLen = 0;
997 size_t nbpgs = XrdOucPgrwUtils::csNum( chunk.offset, chunk.length, fLen, lLen );
998
999 //------------------------------------------------------------------------
1000 // Set the crc32c buffer if not ready yet
1001 //------------------------------------------------------------------------
1002 if( pPgWrtCksumBuff.GetCursor() == 0 )
1003 {
1004 uint32_t digest = htonl( pCrc32cDigests[pPgWrtCurrentPageNb] );
1005 memcpy( pPgWrtCksumBuff.GetBuffer(), &digest, sizeof( uint32_t ) );
1006 }
1007
1008 uint32_t btsLeft = chunk.length - pAsyncOffset;
1009 uint32_t pglen = ( pPgWrtCurrentPageNb == 0 ? fLen : XrdSys::PageSize ) - pPgWrtCurrentPageOffset;
1010 if( pglen > btsLeft ) pglen = btsLeft;
1011 char* pgbuf = static_cast<char*>( chunk.buffer ) + pAsyncOffset;
1012
1013 while( btsLeft > 0 )
1014 {
1015 // first write the crc32c digest
1016 while( pPgWrtCksumBuff.GetCursor() < sizeof( uint32_t ) )
1017 {
1018 uint32_t dgstlen = sizeof( uint32_t ) - pPgWrtCksumBuff.GetCursor();
1019 char* dgstbuf = pPgWrtCksumBuff.GetBufferAtCursor();
1020 int btswrt = 0;
1021 Status st = socket->Send( dgstbuf, dgstlen, btswrt );
1022 if( !st.IsOK() ) return st;
1023 bytesWritten += btswrt;
1024 pPgWrtCksumBuff.AdvanceCursor( btswrt );
1025 if( st.code == suRetry ) return st;
1026 }
1027 // then write the raw data (one page)
1028 int btswrt = 0;
1029 Status st = socket->Send( pgbuf, pglen, btswrt );
1030 if( !st.IsOK() ) return st;
1031 pgbuf += btswrt;
1032 pglen -= btswrt;
1033 btsLeft -= btswrt;
1034 bytesWritten += btswrt;
1035 pAsyncOffset += btswrt; // update the offset to the raw data
1036 if( st.code == suRetry ) return st;
1037 // if we managed to write all the data ...
1038 if( pglen == 0 )
1039 {
1040 // move to the next page
1041 ++pPgWrtCurrentPageNb;
1042 if( pPgWrtCurrentPageNb < nbpgs )
1043 {
1044 // set the digest buffer
1045 pPgWrtCksumBuff.SetCursor( 0 );
1046 uint32_t digest = htonl( pCrc32cDigests[pPgWrtCurrentPageNb] );
1047 memcpy( pPgWrtCksumBuff.GetBuffer(), &digest, sizeof( uint32_t ) );
1048 }
1049 // set the page length
1050 pglen = XrdSys::PageSize;
1051 if( pglen > btsLeft ) pglen = btsLeft;
1052 // reset offset in the current page
1053 pPgWrtCurrentPageOffset = 0;
1054 }
1055 else
1056 // otherwise just adjust the offset in the current page
1057 pPgWrtCurrentPageOffset += btswrt;
1058
1059 }
1060 }
1061 else if( !pChunkList->empty() )
1062 {
1063 size_t size = pChunkList->size();
1064 for( size_t i = pAsyncChunkIndex ; i < size; ++i )
1065 {
1066 char *buffer = (char*)(*pChunkList)[i].buffer;
1067 uint32_t size = (*pChunkList)[i].length;
1068 size_t leftToBeWritten = size - pAsyncOffset;
1069
1070 while( leftToBeWritten )
1071 {
1072 int btswrt = 0;
1073 Status st = socket->Send( buffer + pAsyncOffset, leftToBeWritten, btswrt );
1074 bytesWritten += btswrt;
1075 if( !st.IsOK() || st.code == suRetry ) return st;
1076 pAsyncOffset += btswrt;
1077 leftToBeWritten -= btswrt;
1078 }
1079 //----------------------------------------------------------------------
1080 // Remember that we have moved to the next chunk, also clear the offset
1081 // within the buffer as we are going to move to a new one
1082 //----------------------------------------------------------------------
1083 ++pAsyncChunkIndex;
1084 pAsyncOffset = 0;
1085 }
1086 }
1087 else
1088 {
1089 Log *log = DefaultEnv::GetLog();
1090
1091 //------------------------------------------------------------------------
1092 // If the socket is encrypted we cannot use a kernel buffer, we have to
1093 // convert to user space buffer
1094 //------------------------------------------------------------------------
1095 if( socket->IsEncrypted() )
1096 {
1097 log->Debug( XRootDMsg, "[%s] Channel is encrypted: cannot use kernel buffer.",
1098 pUrl.GetHostId().c_str() );
1099
1100 char *ubuff = 0;
1101 ssize_t ret = XrdSys::Move( *pKBuff, ubuff );
1102 if( ret < 0 ) return Status( stError, errInternal );
1103 pChunkList->push_back( ChunkInfo( 0, ret, ubuff ) );
1104 return WriteMessageBody( socket, bytesWritten );
1105 }
1106
1107 //------------------------------------------------------------------------
1108 // Send the data
1109 //------------------------------------------------------------------------
1110 while( !pKBuff->Empty() )
1111 {
1112 int btswrt = 0;
1113 Status st = socket->Send( *pKBuff, btswrt );
1114 bytesWritten += btswrt;
1115 if( !st.IsOK() || st.code == suRetry ) return st;
1116 }
1117
1118 log->Debug( XRootDMsg, "[%s] Request %s payload (kernel buffer) transferred to socket.",
1119 pUrl.GetHostId().c_str(), pRequest->GetObfuscatedDescription().c_str() );
1120 }
1121
1122 return Status();
1123 }
void AdvanceCursor(uint32_t delta)
Advance the cursor.
char * GetBufferAtCursor()
Get the buffer pointer at the append cursor.
void SetCursor(uint32_t cursor)
Set the cursor.
uint32_t GetCursor() const
Get append cursor.
XRootDStatus WriteMessageBody(Socket *socket, uint32_t &bytesWritten) override
const uint16_t suRetry
const uint16_t errInternal
Internal error.
static const int PageSize
ssize_t Move(KernelBuffer &kbuff, char *&ubuff)

References XrdCl::Buffer::AdvanceCursor(), XrdCl::ChunkInfo::buffer, XrdCl::Status::code, XrdOucPgrwUtils::csNum(), XrdCl::Log::Debug(), XrdSys::KernelBuffer::Empty(), XrdCl::errInternal, XrdCl::Buffer::GetBuffer(), XrdCl::Buffer::GetBufferAtCursor(), XrdCl::Buffer::GetCursor(), XrdCl::URL::GetHostId(), XrdCl::DefaultEnv::GetLog(), XrdCl::Message::GetObfuscatedDescription(), XrdCl::Socket::IsEncrypted(), XrdCl::Status::IsOK(), XrdCl::ChunkInfo::length, XrdSys::Move(), XrdCl::ChunkInfo::offset, XrdSys::PageSize, XrdCl::Socket::Send(), XrdCl::Buffer::SetCursor(), XrdCl::stError, XrdCl::suRetry, WriteMessageBody(), and XrdCl::XRootDMsg.

Referenced by WriteMessageBody().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ HandleRspJob

friend class HandleRspJob
friend

Definition at line 121 of file XrdClXRootDMsgHandler.hh.


The documentation for this class was generated from the following files: