XRootD
XrdSfsAio.hh
Go to the documentation of this file.
1 #ifndef __SFS_AIO_H__
2 #define __SFS_AIO_H__
3 /******************************************************************************/
4 /* */
5 /* X r d S f s A i o . h h */
6 /* */
7 /* (c) 2004 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 <cstdint>
33 #include <signal.h>
34 #include <sys/types.h>
35 // _POSIX_ASYNCHRONOUS_IO, if it is defined, is in unistd.h.
36 #include <unistd.h>
37 #ifdef _POSIX_ASYNCHRONOUS_IO
38 #ifdef __APPLE__
39 #include <AvailabilityMacros.h>
40 #include <sys/aio.h>
41 #else
42 #include <aio.h>
43 #endif
44 #else
45 struct aiocb { // Minimal structure to avoid compiler errors
47  void *aio_buf;
48  size_t aio_nbytes;
49  off_t aio_offset;
51  struct sigevent aio_sigevent;
52  };
53 #endif
54 
55 // The XrdSfsAIO class is meant to be derived. This object provides the
56 // basic interface to handle AIO control block queues not processing.
57 //
58 class XrdSfsAio
59 {
60 public:
61 
62 struct aiocb sfsAio;
63 uint32_t *cksVec; // For pgRead and pgWrite
64 
65 ssize_t Result; // If >= 0 valid result; else is -errno
66 
67 const char *TIdent; // Trace information (optional)
68 
69 // Method to handle completed reads
70 //
71 virtual void doneRead() = 0;
72 
73 // Method to hand completed writes
74 //
75 virtual void doneWrite() = 0;
76 
77 // Method to recycle free object
78 //
79 virtual void Recycle() = 0;
80 
82 #if defined(__APPLE__) && (!defined(MAC_OS_X_VERSION_10_4) || \
83  MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_4)
84  sfsAio.aio_sigevent.sigev_value.sigval_ptr = (void *)this;
85 #else
86  sfsAio.aio_sigevent.sigev_value.sival_ptr = (void *)this;
87 #endif
88  sfsAio.aio_sigevent.sigev_notify = SIGEV_SIGNAL;
89  sfsAio.aio_reqprio = 0;
90  cksVec = 0;
91  TIdent = "";
92  }
93 virtual ~XrdSfsAio() {}
94 };
95 #endif
off_t aio_offset
Definition: XrdSfsAio.hh:49
size_t aio_nbytes
Definition: XrdSfsAio.hh:48
struct sigevent aio_sigevent
Definition: XrdSfsAio.hh:51
int aio_reqprio
Definition: XrdSfsAio.hh:50
int aio_fildes
Definition: XrdSfsAio.hh:46
void * aio_buf
Definition: XrdSfsAio.hh:47
uint32_t * cksVec
Definition: XrdSfsAio.hh:63
ssize_t Result
Definition: XrdSfsAio.hh:65
const char * TIdent
Definition: XrdSfsAio.hh:67
virtual ~XrdSfsAio()
Definition: XrdSfsAio.hh:93
virtual void Recycle()=0
virtual void doneRead()=0
struct aiocb sfsAio
Definition: XrdSfsAio.hh:62
virtual void doneWrite()=0