xrootd
XrdPosixFile.hh
Go to the documentation of this file.
1 #ifndef __XRDPOSIXFILE_HH__
2 #define __XRDPOSIXFILE_HH__
3 /******************************************************************************/
4 /* */
5 /* X r d P o s i x F i l e . h h */
6 /* */
7 /* (c) 2013 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 <errno.h>
34 #include <fcntl.h>
35 #include <sys/time.h>
36 #include <sys/param.h>
37 #include <sys/resource.h>
38 #include <sys/uio.h>
39 
40 #include "XrdCl/XrdClFileSystem.hh"
41 #include "XrdCl/XrdClFile.hh"
42 #include "XrdCl/XrdClURL.hh"
44 
45 #include "XrdOuc/XrdOucCache.hh"
46 
47 #include "XrdPosix/XrdPosixMap.hh"
49 
50 /******************************************************************************/
51 /* X r d P o s i x F i l e C l a s s */
52 /******************************************************************************/
53 
54 class XrdPosixCallBack;
55 class XrdPosixPrepIO;
56 
57 class XrdPosixFile : public XrdPosixObject,
58  public XrdOucCacheIO,
59  public XrdOucCacheIOCD,
61 {
62 public:
63 
67 
68  long long addOffset(long long offs, int updtSz=0)
69  {updMutex.Lock();
70  currOffset += offs;
71  if (updtSz && currOffset > (long long)mySize)
73  long long retOffset = currOffset;
74  updMutex.UnLock();
75  return retOffset;
76  }
77 
78 //atic XrdPosixFile *Alloc(const char *path, XrdPosixCallBack *cbP, int Opts);
79 
80 static void* DelayedDestroy(void*);
81 
82 static void DelayedDestroy(XrdPosixFile *fp);
83 
84  bool Close(XrdCl::XRootDStatus &Status);
85 
86  bool Detach(XrdOucCacheIOCD &cdP) {(void)cdP; return true;}
87 
88  void DetachDone() {unRef();}
89 
90  bool Finalize(XrdCl::XRootDStatus *Status);
91 
92  long long FSize() {AtomicBeg(updMutex);
93  long long retSize = AtomicGet(mySize);
95  return retSize;
96  }
97 
98  int Fstat(struct stat &buf);
99 
100  const char *Location(bool refresh=false);
101 
102  void HandleResponse(XrdCl::XRootDStatus *status,
103  XrdCl::AnyObject *response);
104 
105  void updLock() {updMutex.Lock();}
106 
108 
110 
111  const char *Origin() {return fOpen;}
112 
113  const char *Path() {return fPath;}
114 
115  int pgRead(char *buff, long long offs, int rdlen,
116  std::vector<uint32_t> &csvec, uint64_t opts=0);
117 
118  void pgRead(XrdOucCacheIOCB &iocb,
119  char *buff, long long offs, int rdlen,
120  std::vector<uint32_t> &csvec, uint64_t opts=0);
121 
122  int Read (char *Buff, long long Offs, int Len);
123 
124  void Read (XrdOucCacheIOCB &iocb, char *buff, long long offs,
125  int rlen);
126 
127  int ReadV (const XrdOucIOVec *readV, int n);
128 
129  void ReadV (XrdOucCacheIOCB &iocb, const XrdOucIOVec *readV,
130  int n);
131 
132  long long setOffset(long long offs)
133  {updMutex.Lock();
134  currOffset = offs;
135  updMutex.UnLock();
136  return offs;
137  }
138 
139  bool Stat(XrdCl::XRootDStatus &Status, bool force=false);
140 
141  int Sync();
142 
143  void Sync(XrdOucCacheIOCB &iocb);
144 
145  int Trunc(long long Offset);
146 
147  void UpdtSize(size_t newsz)
148  {updMutex.Lock();
149  if (newsz > mySize) mySize = newsz;
150  updMutex.UnLock();
151  }
152 
153  using XrdPosixObject::Who;
154 
155  bool Who(XrdPosixFile **fileP)
156  {*fileP = this; return true;}
157 
158  int Write(char *Buff, long long Offs, int Len);
159 
160  void Write(XrdOucCacheIOCB &iocb, char *buff, long long offs,
161  int wlen);
162 
163  size_t mySize;
164  time_t myAtime;
165  time_t myCtime;
166  time_t myMtime;
167  dev_t myRdev;
168  ino_t myInode;
169  mode_t myMode;
170 
171 static
176 static char *sfSFX;
177 static short sfSLN;
178 static bool ddPosted;
179 static int ddNum;
180 
181 static const int realFD = 1;
182 static const int isStrm = 2;
183 static const int isUpdt = 4;
184 
185  XrdPosixFile(bool &aOK, const char *path, XrdPosixCallBack *cbP=0,
186  int Opts=0);
187  ~XrdPosixFile();
188 
189 private:
190 
191 union {long long currOffset;
194  };
195 
196 char *fPath;
197 char *fOpen;
198 char *fLoc;
199 union {int cOpt; int numTries;};
200 char isStream;
201 };
202 #endif
bool Stat(XrdCl::XRootDStatus &Status, bool force=false)
XrdSysRecMutex updMutex
Definition: XrdPosixObject.hh:94
Definition: XrdClAnyObject.hh:32
#define AtomicGet(x)
Definition: XrdSysAtomics.hh:71
virtual bool Who(XrdPosixDir **dirP)
Definition: XrdPosixObject.hh:86
static short sfSLN
Definition: XrdPosixFile.hh:177
char * fLoc
Definition: XrdPosixFile.hh:198
Definition: XrdPosixFile.hh:57
long long currOffset
Definition: XrdPosixFile.hh:191
long long Offset()
Definition: XrdPosixFile.hh:109
int Fstat(struct stat &buf)
time_t myMtime
Definition: XrdPosixFile.hh:166
int ReadV(const XrdOucIOVec *readV, int n)
XrdCl::File clFile
Definition: XrdPosixFile.hh:66
Definition: XrdOucCache.hh:104
mode_t myMode
Definition: XrdPosixFile.hh:169
long long addOffset(long long offs, int updtSz=0)
Definition: XrdPosixFile.hh:68
XrdPosixFile(bool &aOK, const char *path, XrdPosixCallBack *cbP=0, int Opts=0)
Definition: XrdPosixObject.hh:41
char isStream
Definition: XrdPosixFile.hh:200
void updLock()
Definition: XrdPosixFile.hh:105
static void * DelayedDestroy(void *)
static const int isStrm
Definition: XrdPosixFile.hh:182
#define AtomicBeg(Mtx)
Definition: XrdSysAtomics.hh:63
Definition: XrdOucCache.hh:81
const char * Origin()
Definition: XrdPosixFile.hh:111
int Read(char *Buff, long long Offs, int Len)
int pgRead(char *buff, long long offs, int rdlen, std::vector< uint32_t > &csvec, uint64_t opts=0)
char * fOpen
Definition: XrdPosixFile.hh:197
bool Detach(XrdOucCacheIOCD &cdP)
Definition: XrdPosixFile.hh:86
Definition: XrdSysPthread.hh:165
void UpdtSize(size_t newsz)
Definition: XrdPosixFile.hh:147
int Trunc(long long Offset)
A file.
Definition: XrdClFile.hh:45
XrdPosixFile * nextFile
Definition: XrdPosixFile.hh:193
#define AtomicEnd(Mtx)
Definition: XrdSysAtomics.hh:64
long long setOffset(long long offs)
Definition: XrdPosixFile.hh:132
XrdPosixPrepIO * PrepIO
Definition: XrdPosixFile.hh:65
const char * Path()
Definition: XrdPosixFile.hh:113
static XrdSysMutex ddMutex
Definition: XrdPosixFile.hh:173
static XrdPosixFile * ddLost
Definition: XrdPosixFile.hh:175
Definition: XrdSysPthread.hh:405
#define AtomicRet(mtx, x)
Definition: XrdSysAtomics.hh:76
bool Who(XrdPosixFile **fileP)
Definition: XrdPosixFile.hh:155
Request status.
Definition: XrdClXRootDResponses.hh:218
An abstract class to define a callback for Open() call.
Definition: XrdPosixCallBack.hh:51
Definition: XrdOucIOVec.hh:40
static bool ddPosted
Definition: XrdPosixFile.hh:178
Definition: XrdPosixPrepIO.hh:38
size_t mySize
Definition: XrdPosixFile.hh:163
Definition: XrdOucCache.hh:52
time_t myAtime
Definition: XrdPosixFile.hh:164
static XrdPosixFile * ddList
Definition: XrdPosixFile.hh:174
Handle an async response.
Definition: XrdClXRootDResponses.hh:1040
#define stat(a, b)
Definition: XrdPosix.hh:96
void Lock()
Definition: XrdSysPthread.hh:222
ino_t myInode
Definition: XrdPosixFile.hh:168
XrdOucCacheIO * XCio
Definition: XrdPosixFile.hh:64
dev_t myRdev
Definition: XrdPosixFile.hh:167
static XrdSysSemaphore ddSem
Definition: XrdPosixFile.hh:172
char * fPath
Definition: XrdPosixFile.hh:196
static const int isUpdt
Definition: XrdPosixFile.hh:183
const char * Location(bool refresh=false)
bool Close(XrdCl::XRootDStatus &Status)
void HandleResponse(XrdCl::XRootDStatus *status, XrdCl::AnyObject *response)
bool Finalize(XrdCl::XRootDStatus *Status)
static const int realFD
Definition: XrdPosixFile.hh:181
long long FSize()
Definition: XrdPosixFile.hh:92
static int ddNum
Definition: XrdPosixFile.hh:179
void updUnLock()
Definition: XrdPosixFile.hh:107
XrdPosixCallBack * theCB
Definition: XrdPosixFile.hh:192
int Write(char *Buff, long long Offs, int Len)
void UnLock()
Definition: XrdSysPthread.hh:224
static char * sfSFX
Definition: XrdPosixFile.hh:176
int cOpt
Definition: XrdPosixFile.hh:199
int numTries
Definition: XrdPosixFile.hh:199
void DetachDone()
Indicate that the CacheIO object has been detached.
Definition: XrdPosixFile.hh:88
time_t myCtime
Definition: XrdPosixFile.hh:165
void unRef()
Definition: XrdPosixObject.hh:67