Logo ROOT  
Reference Guide
TDCacheFile.h
Go to the documentation of this file.
1// @(#)root/dcache:$Id$
2// Author: Grzegorz Mazur 20/01/2002
3// Updated: William Tanenbaum 21/11/2003
4// Updated: Tgiran Mkrtchyan 28/06/2004
5
6/*************************************************************************
7 * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
8 * All rights reserved. *
9 * *
10 * For the licensing terms see $ROOTSYS/LICENSE. *
11 * For the list of contributors see $ROOTSYS/README/CREDITS. *
12 *************************************************************************/
13
14#ifndef ROOT_TDCacheFile
15#define ROOT_TDCacheFile
16
17#include "TFile.h"
18#include "TSystem.h"
19#include "TString.h"
20
21#include <sys/stat.h>
22
23#define RAHEAD_BUFFER_SIZE 131072
24
25class TDCacheFile : public TFile {
26
27private:
28 Bool_t fStatCached; ///<! (transient) is file status cached?
29 struct stat64 fStatBuffer; ///<! (transient) Cached file status buffer (for performance)
30
32
33 // Interface to basic system I/O routines
34 Int_t SysOpen(const char *pathname, Int_t flags, UInt_t mode);
36 Int_t SysRead(Int_t fd, void *buf, Int_t len);
37 Int_t SysWrite(Int_t fd, const void *buf, Int_t len);
38 Long64_t SysSeek(Int_t fd, Long64_t offset, Int_t whence);
39 Int_t SysStat(Int_t fd, Long_t *id, Long64_t *size, Long_t *flags, Long_t *modtime);
41
42public:
43 TDCacheFile(const char *path, Option_t *option="",
45
47
48 Bool_t ReadBuffer(char *buf, Int_t len);
49 Bool_t ReadBuffer(char *buf, Long64_t pos, Int_t len);
50 Bool_t WriteBuffer(const char *buf, Int_t len);
51
52 Bool_t ReadBuffers(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf);
53
54 void ResetErrno() const;
55
56 static Bool_t Stage(const char *path, UInt_t secs,
57 const char *location = 0);
58 static Bool_t CheckFile(const char *path, const char *location = 0);
59
60 /// Note: This must be kept in sync with values \#defined in dcap.h
65 };
66
67 static void SetOpenTimeout(UInt_t secs);
69
70 static void SetReplyHostName(const char *host_name);
71 static const char *GetDcapVersion();
72 static TString GetDcapPath(const char *path);
73
74
75 ClassDef(TDCacheFile,1) //A ROOT file that reads/writes via a dCache server
76};
77
78
79class TDCacheSystem : public TSystem {
80
81private:
82 void *fDirp; ///< directory handler
83
84 void *GetDirPtr() const { return fDirp; }
85
86public:
88 virtual ~TDCacheSystem() { }
89
90 Int_t MakeDirectory(const char *name);
91 void *OpenDirectory(const char *name);
92 void FreeDirectory(void *dirp);
93 const char *GetDirEntry(void *dirp);
94 Int_t GetPathInfo(const char *path, FileStat_t &buf);
95 Bool_t AccessPathName(const char *path, EAccessMode mode);
96
97 ClassDef(TDCacheSystem,0) // Directory handler for DCache
98};
99
100#endif
int Int_t
Definition: RtypesCore.h:43
unsigned int UInt_t
Definition: RtypesCore.h:44
const Bool_t kFALSE
Definition: RtypesCore.h:90
long Long_t
Definition: RtypesCore.h:52
bool Bool_t
Definition: RtypesCore.h:61
long long Long64_t
Definition: RtypesCore.h:71
const char Option_t
Definition: RtypesCore.h:64
#define ClassDef(name, id)
Definition: Rtypes.h:322
char name[80]
Definition: TGX11.cxx:109
EAccessMode
Definition: TSystem.h:42
A TDCacheFile is like a normal TFile except that it may read and write its data via a dCache server (...
Definition: TDCacheFile.h:25
Int_t SysWrite(Int_t fd, const void *buf, Int_t len)
Interface to system write. All arguments like in POSIX write.
Int_t SysStat(Int_t fd, Long_t *id, Long64_t *size, Long_t *flags, Long_t *modtime)
Get info about a file: id, size, flags, modification time.
Int_t SysClose(Int_t fd)
Interface to system close. All arguments like in POSIX close.
Bool_t fStatCached
! (transient) is file status cached?
Definition: TDCacheFile.h:28
~TDCacheFile()
Close and cleanup dCache file.
Long64_t SysSeek(Int_t fd, Long64_t offset, Int_t whence)
Interface to system seek. All arguments like in POSIX lseek.
static Bool_t CheckFile(const char *path, const char *location=0)
CheckFile() returns kTRUE on success and kFALSE on failure.
static void SetOnError(EOnErrorAction=kOnErrorDefault)
Set on error handler.
static void SetOpenTimeout(UInt_t secs)
Set file open timeout.
Int_t SysRead(Int_t fd, void *buf, Int_t len)
Interface to system read. All arguments like in POSIX read.
Bool_t WriteBuffer(const char *buf, Int_t len)
Write specified byte range to remote file via dCache daemon.
EOnErrorAction
Note: This must be kept in sync with values #defined in dcap.h.
Definition: TDCacheFile.h:61
static Bool_t Stage(const char *path, UInt_t secs, const char *location=0)
Stage() returns kTRUE on success and kFALSE on failure.
Bool_t ReadBuffer(char *buf, Int_t len)
Read specified byte range from remote file via dCache daemon.
Int_t SysSync(Int_t fd)
Interface to system sync.
struct stat64 fStatBuffer
! (transient) Cached file status buffer (for performance)
Definition: TDCacheFile.h:29
static const char * GetDcapVersion()
Return dCache version string.
static TString GetDcapPath(const char *path)
Transform the input path into a path usuable by the dcap C library, i.e either dcap://nodename....
Int_t SysOpen(const char *pathname, Int_t flags, UInt_t mode)
Interface to system open. All arguments like in POSIX open.
Bool_t ReadBuffers(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf)
Read the nbuf blocks described in arrays pos and len, where pos[i] is the seek position of block i of...
static void SetReplyHostName(const char *host_name)
Set reply host name.
void ResetErrno() const
Method resetting the dc_errno and errno.
void * fDirp
directory handler
Definition: TDCacheFile.h:82
Bool_t AccessPathName(const char *path, EAccessMode mode)
Returns FALSE if one can access a file using the specified access mode.
Int_t GetPathInfo(const char *path, FileStat_t &buf)
Get info about a file.
const char * GetDirEntry(void *dirp)
Get a directory entry.
void * GetDirPtr() const
Definition: TDCacheFile.h:84
void FreeDirectory(void *dirp)
Close a directory.
void * OpenDirectory(const char *name)
Open a directory.
Int_t MakeDirectory(const char *name)
Create a directory.
TDCacheSystem()
Create helper class that allows directory access via dCache.
virtual ~TDCacheSystem()
Definition: TDCacheFile.h:88
A ROOT file is a suite of consecutive data records (TKey instances) with a well defined format.
Definition: TFile.h:53
Basic string class.
Definition: TString.h:131
Abstract base class defining a generic interface to the underlying Operating System.
Definition: TSystem.h:265
@ kUseCompiledDefault
Use the compile-time default setting.
Definition: Compression.h:50