-
Notifications
You must be signed in to change notification settings - Fork 149
/
XrdClFile.cc
415 lines (362 loc) · 15.6 KB
/
XrdClFile.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
//------------------------------------------------------------------------------
// Copyright (c) 2011-2014 by European Organization for Nuclear Research (CERN)
// Author: Lukasz Janyst <ljanyst@cern.ch>
//------------------------------------------------------------------------------
// This file is part of the XRootD software suite.
//
// XRootD is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// XRootD is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with XRootD. If not, see <http://www.gnu.org/licenses/>.
//
// In applying this licence, CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
//------------------------------------------------------------------------------
#include "XrdCl/XrdClLog.hh"
#include "XrdCl/XrdClUtils.hh"
#include "XrdCl/XrdClConstants.hh"
#include "XrdCl/XrdClFile.hh"
#include "XrdCl/XrdClFileStateHandler.hh"
#include "XrdCl/XrdClMessageUtils.hh"
#include "XrdCl/XrdClDefaultEnv.hh"
#include "XrdCl/XrdClPlugInInterface.hh"
#include "XrdCl/XrdClPlugInManager.hh"
#include "XrdCl/XrdClDefaultEnv.hh"
namespace XrdCl
{
//----------------------------------------------------------------------------
// Constructor
//----------------------------------------------------------------------------
File::File( bool enablePlugIns ):
pPlugIn(0),
pEnablePlugIns( enablePlugIns )
{
pStateHandler = new FileStateHandler();
}
//------------------------------------------------------------------------
// Destructor
//------------------------------------------------------------------------
File::~File()
{
//--------------------------------------------------------------------------
// This, in principle, should never ever happen. Except for the case
// when we're interfaced with ROOT that may call this desctructor from
// its garbage collector, from its __cxa_finalize, ie. after the XrdCl lib
// has been finalized by the linker. So, if we don't have the log object
// at this point we just give up the hope.
//--------------------------------------------------------------------------
if ( DefaultEnv::GetLog() && IsOpen() ) {XRootDStatus status = Close();}
pStateHandler->Destroy();
delete pPlugIn;
}
//----------------------------------------------------------------------------
// Open the file pointed to by the given URL - async
//----------------------------------------------------------------------------
XRootDStatus File::Open( const std::string &url,
OpenFlags::Flags flags,
Access::Mode mode,
ResponseHandler *handler,
uint16_t timeout )
{
//--------------------------------------------------------------------------
// Check if we need to install and run a plug-in for this URL
//--------------------------------------------------------------------------
if( pEnablePlugIns && !pPlugIn )
{
Log *log = DefaultEnv::GetLog();
PlugInFactory *fact = DefaultEnv::GetPlugInManager()->GetFactory( url );
if( fact )
{
pPlugIn = fact->CreateFile( url );
if( !pPlugIn )
{
log->Error( FileMsg, "Plug-in factory failed to produce a plug-in "
"for %s, continuing without one", url.c_str() );
}
}
}
//--------------------------------------------------------------------------
// Open the file
//--------------------------------------------------------------------------
if( pPlugIn )
return pPlugIn->Open( url, flags, mode, handler, timeout );
return pStateHandler->Open( url, flags, mode, handler, timeout );
}
//----------------------------------------------------------------------------
// Open the file pointed to by the given URL - sync
//----------------------------------------------------------------------------
XRootDStatus File::Open( const std::string &url,
OpenFlags::Flags flags,
Access::Mode mode,
uint16_t timeout )
{
SyncResponseHandler handler;
Status st = Open( url, flags, mode, &handler, timeout );
if( !st.IsOK() )
return st;
return MessageUtils::WaitForStatus( &handler );
}
//----------------------------------------------------------------------------
// Close the file - async
//----------------------------------------------------------------------------
XRootDStatus File::Close( ResponseHandler *handler,
uint16_t timeout )
{
if( pPlugIn )
return pPlugIn->Close( handler, timeout );
return pStateHandler->Close( handler, timeout );
}
//----------------------------------------------------------------------------
// Close the file
//----------------------------------------------------------------------------
XRootDStatus File::Close( uint16_t timeout )
{
SyncResponseHandler handler;
Status st = Close( &handler, timeout );
if( !st.IsOK() )
return st;
return MessageUtils::WaitForStatus( &handler );
}
//----------------------------------------------------------------------------
// Obtain status information for this file - async
//----------------------------------------------------------------------------
XRootDStatus File::Stat( bool force,
ResponseHandler *handler,
uint16_t timeout )
{
if( pPlugIn )
return pPlugIn->Stat( force, handler, timeout );
return pStateHandler->Stat( force, handler, timeout );
}
//----------------------------------------------------------------------------
// Obtain status information for this file - sync
//----------------------------------------------------------------------------
XRootDStatus File::Stat( bool force,
StatInfo *&response,
uint16_t timeout )
{
SyncResponseHandler handler;
Status st = Stat( force, &handler, timeout );
if( !st.IsOK() )
return st;
return MessageUtils::WaitForResponse( &handler, response );
}
//----------------------------------------------------------------------------
// Read a data chunk at a given offset - sync
//----------------------------------------------------------------------------
XRootDStatus File::Read( uint64_t offset,
uint32_t size,
void *buffer,
ResponseHandler *handler,
uint16_t timeout )
{
if( pPlugIn )
return pPlugIn->Read( offset, size, buffer, handler, timeout );
return pStateHandler->Read( offset, size, buffer, handler, timeout );
}
//----------------------------------------------------------------------------
// Read a data chunk at a given offset - sync
//----------------------------------------------------------------------------
XRootDStatus File::Read( uint64_t offset,
uint32_t size,
void *buffer,
uint32_t &bytesRead,
uint16_t timeout )
{
SyncResponseHandler handler;
Status st = Read( offset, size, buffer, &handler, timeout );
if( !st.IsOK() )
return st;
ChunkInfo *chunkInfo = 0;
XRootDStatus status = MessageUtils::WaitForResponse( &handler, chunkInfo );
if( status.IsOK() )
{
bytesRead = chunkInfo->length;
delete chunkInfo;
}
return status;
}
//----------------------------------------------------------------------------
// Write a data chunk at a given offset - async
//----------------------------------------------------------------------------
XRootDStatus File::Write( uint64_t offset,
uint32_t size,
const void *buffer,
ResponseHandler *handler,
uint16_t timeout )
{
if( pPlugIn )
return pPlugIn->Write( offset, size, buffer, handler, timeout );
return pStateHandler->Write( offset, size, buffer, handler, timeout );
}
//----------------------------------------------------------------------------
// Write a data chunk at a given offset - sync
//----------------------------------------------------------------------------
XRootDStatus File::Write( uint64_t offset,
uint32_t size,
const void *buffer,
uint16_t timeout )
{
SyncResponseHandler handler;
Status st = Write( offset, size, buffer, &handler, timeout );
if( !st.IsOK() )
return st;
XRootDStatus status = MessageUtils::WaitForStatus( &handler );
return status;
}
//----------------------------------------------------------------------------
// Commit all pending disk writes - async
//----------------------------------------------------------------------------
XRootDStatus File::Sync( ResponseHandler *handler,
uint16_t timeout )
{
if( pPlugIn )
return pPlugIn->Sync( handler, timeout );
return pStateHandler->Sync( handler, timeout );
}
//----------------------------------------------------------------------------
// Commit all pending disk writes - sync
//----------------------------------------------------------------------------
XRootDStatus File::Sync( uint16_t timeout )
{
SyncResponseHandler handler;
Status st = Sync( &handler, timeout );
if( !st.IsOK() )
return st;
XRootDStatus status = MessageUtils::WaitForStatus( &handler );
return status;
}
//----------------------------------------------------------------------------
// Truncate the file to a particular size - async
//----------------------------------------------------------------------------
XRootDStatus File::Truncate( uint64_t size,
ResponseHandler *handler,
uint16_t timeout )
{
if( pPlugIn )
return pPlugIn->Truncate( size, handler, timeout );
return pStateHandler->Truncate( size, handler, timeout );
}
//----------------------------------------------------------------------------
// Truncate the file to a particular size - sync
//----------------------------------------------------------------------------
XRootDStatus File::Truncate( uint64_t size, uint16_t timeout )
{
SyncResponseHandler handler;
Status st = Truncate( size, &handler, timeout );
if( !st.IsOK() )
return st;
XRootDStatus status = MessageUtils::WaitForStatus( &handler );
return status;
}
//----------------------------------------------------------------------------
// Read scattered data chunks in one operation - async
//----------------------------------------------------------------------------
XRootDStatus File::VectorRead( const ChunkList &chunks,
void *buffer,
ResponseHandler *handler,
uint16_t timeout )
{
if( pPlugIn )
return pPlugIn->VectorRead( chunks, buffer, handler, timeout );
return pStateHandler->VectorRead( chunks, buffer, handler, timeout );
}
//----------------------------------------------------------------------------
// Read scattered data chunks in one operation - sync
//----------------------------------------------------------------------------
XRootDStatus File::VectorRead( const ChunkList &chunks,
void *buffer,
VectorReadInfo *&vReadInfo,
uint16_t timeout )
{
SyncResponseHandler handler;
Status st = VectorRead( chunks, buffer, &handler, timeout );
if( !st.IsOK() )
return st;
return MessageUtils::WaitForResponse( &handler, vReadInfo );
}
//----------------------------------------------------------------------------
// Performs a custom operation on an open file, server implementation
// dependent - async
//----------------------------------------------------------------------------
XRootDStatus File::Fcntl( const Buffer &arg,
ResponseHandler *handler,
uint16_t timeout )
{
if( pPlugIn )
return pPlugIn->Fcntl( arg, handler, timeout );
return pStateHandler->Fcntl( arg, handler, timeout );
}
//----------------------------------------------------------------------------
// Performs a custom operation on an open file, server implementation
// dependent - sync
//----------------------------------------------------------------------------
XRootDStatus File::Fcntl( const Buffer &arg,
Buffer *&response,
uint16_t timeout )
{
SyncResponseHandler handler;
Status st = Fcntl( arg, &handler, timeout );
if( !st.IsOK() )
return st;
return MessageUtils::WaitForResponse( &handler, response );
}
//------------------------------------------------------------------------
//! Get access token to a file - async
//------------------------------------------------------------------------
XRootDStatus File::Visa( ResponseHandler *handler,
uint16_t timeout )
{
if( pPlugIn )
return pPlugIn->Visa( handler, timeout );
return pStateHandler->Visa( handler, timeout );
}
//----------------------------------------------------------------------------
// Get access token to a file - sync
//----------------------------------------------------------------------------
XRootDStatus File::Visa( Buffer *&visa,
uint16_t timeout )
{
SyncResponseHandler handler;
Status st = Visa( &handler, timeout );
if( !st.IsOK() )
return st;
return MessageUtils::WaitForResponse( &handler, visa );
}
//----------------------------------------------------------------------------
// Check if the file is open
//----------------------------------------------------------------------------
bool File::IsOpen() const
{
if( pPlugIn )
return pPlugIn->IsOpen();
return pStateHandler->IsOpen();
}
//----------------------------------------------------------------------------
// Set file property
//----------------------------------------------------------------------------
bool File::SetProperty( const std::string &name, const std::string &value )
{
if( pPlugIn )
return pPlugIn->SetProperty( name, value );
return pStateHandler->SetProperty( name, value );
}
//----------------------------------------------------------------------------
// Get file property
//----------------------------------------------------------------------------
bool File::GetProperty( const std::string &name, std::string &value ) const
{
if( pPlugIn )
return pPlugIn->GetProperty( name, value );
return pStateHandler->GetProperty( name, value );
}
}