XrdPosixXrootd.hh

Go to the documentation of this file.

#ifndef __XRDPOSIXXROOTD_H__
#define __XRDPOSIXXROOTD_H__
/******************************************************************************/
/*                                                                            */
/*                        X r d P o s i x X r o o t d                         */
/*                                                                            */
/* (c) 2010 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*                            All Rights Reserved                             */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* 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 Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/* Modified by Frank Winklmeier to add the full Posix file system definition. */
/******************************************************************************/
 
#include <string>
#include <dirent.h>
#include <unistd.h>
#include <sys/stat.h>
#include <sys/statvfs.h>
#include <sys/types.h>
 
#if defined(__APPLE__) || defined(__FreeBSD__)
#include <sys/param.h>
#include <sys/mount.h>
#else
#include <sys/statfs.h>
#endif
 
#include "XrdPosix/XrdPosixOsDep.hh"
#include "XrdSys/XrdSysPthread.hh"
 
struct XrdOucIOVec;
 
class XrdPosixCallBack;
class XrdPosixCallBackIO;
class XrdPosixFile;
struct XrdPosixInfo;
class XrdPosixAdmin;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
class XrdPosixXrootd
{
public:
friend class XrdPosixConfig;
friend class XrdPosixExtra;
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Access(const char *path, int amode);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Close(int fildes);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Closedir(DIR *dirp);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     endPoint(int FD, char *Buff, int Blen);
 
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
enum class Fcop { QFInfo };
 
static int Fcntl(int fildes, Fcop op, const std::string& args,
                                            std::string& resp);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Fstat(int fildes, struct stat *buf);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Fsync(int fildes);
 
static void    Fsync(int fildes, XrdPosixCallBackIO *cbp); // Async extension!
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Ftruncate(int fildes, off_t offset);
 
//-----------------------------------------------------------------------------
 
static long long Getxattr (const char *path, const char *name,
                           void *value, unsigned long long size);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static off_t   Lseek(int fildes, off_t offset, int whence);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Mkdir(const char *path, mode_t mode);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static const int isStream = 0x40000000; // Internal for Open oflag
 
static int     Open(const char *path, int oflag, mode_t mode=0,
                    XrdPosixCallBack *cbP=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static DIR*    Opendir(const char *path);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
  
static ssize_t Pread(int fildes, void *buf, size_t nbyte, off_t offset);
 
static void    Pread(int fildes, void *buf, size_t nbyte, off_t offset,
                     XrdPosixCallBackIO *cbp); // Async extension!
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static ssize_t Pwrite(int fildes, const void *buf, size_t nbyte, off_t offset);
 
static void    Pwrite(int fildes, const void *buf, size_t nbyte, off_t offset,
                      XrdPosixCallBackIO *cbp); // Async extension!
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     QueryChksum(const char *path, time_t &mtime,
                                 char *buff, int     blen);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     QueryError(std::string& emsg, int fd=-1, bool reset=true);
 
static int     QueryError(std::string& emsg, DIR* dirP, bool reset=true);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static long long QueryOpaque(const char *path, char *buff, int blen);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
  
static ssize_t Read(int fildes, void *buf, size_t nbyte);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static ssize_t Readv(int fildes, const struct iovec *iov, int iovcnt);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static struct  dirent*   Readdir  (DIR *dirp);
static struct  dirent64* Readdir64(DIR *dirp);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Readdir_r  (DIR *dirp, struct dirent   *entry, struct dirent   **result);
static int     Readdir64_r(DIR *dirp, struct dirent64 *entry, struct dirent64 **result);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Rename(const char *oldpath, const char *newpath);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static void    Rewinddir(DIR *dirp);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Rmdir(const char *path);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static void    Seekdir(DIR *dirp, long loc);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Stat(const char *path, struct stat *buf);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Statfs(const char *path, struct statfs *buf);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Statvfs(const char *path, struct statvfs *buf);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static long    Telldir(DIR *dirp);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Truncate(const char *path, off_t offset);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static int     Unlink(const char *path);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static void    VRead(int fildes, const XrdOucIOVec *readV, int n,
                     XrdPosixCallBackIO *cbp); // Async extension!
 
static ssize_t VRead(int fildes, const XrdOucIOVec *readV, int n);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static ssize_t Write(int fildes, const void *buf, size_t nbyte);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
static ssize_t Writev(int fildes, const struct iovec *iov, int iovcnt);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
inline int     fdOrigin() {return baseFD;}
 
static bool    isXrootdDir(DIR *dirp);
 
static bool    myFD(int fd);
 
// The XRootD client will fetch the information needed for a full `stat` call
// as part of the directory listing.  By calling this function from XrdPss
// layer, we enable the use of the `autoStat` functionality, which avoids
// having to call `stat` for each entry in the directory listing.
//
// On error, returns errno; on success, returns 0 and stores the buffer
// internally; on subsequent Readdir calls, the `buf` contents are filled in
// as if one called `fstatat` on it.
//
// Note that this matches other XrdPosixXrootd methods in returning errno on
// failure; this differs from the similar XrdOss method which returns -errno.
static int     StatRet(DIR *dirp, struct stat *buf);
 
/* There must be one instance of this object per executable image. Typically,
   this object is declared in main() or at file level. This is necessary to
   properly do one-time initialization of the static members. When declaring
   this object, you can pass the following information:
   maxfd  - maximum number of simultaneous files and directories to support.
            The value returned by getrlimit() over-rides the passed value
            unless maxfd is negative. When negative, abs(maxfd) becomes the
            absolute maximum and shadow file descriptors are not used.
   maxdir - Ignored, only here for backward compatibility.
   maxthr - Ignored, only here for backward compatibility.
*/
               XrdPosixXrootd(int maxfd=255, int maxdir=0, int maxthr=0);
              ~XrdPosixXrootd();
 
private:
 
static int  Fault(XrdPosixFile *fp, int ecode, const char *msg=0);
 
static int  Open(const char *path, int oflag, mode_t mode,
                 XrdPosixCallBack *cbP, XrdPosixInfo *infoP);
static bool OpenCache(XrdPosixFile &file, XrdPosixInfo &Info);
 
// functions that will be used when XrdEC is invoked
static int  EcRename(const char*, const char*, XrdPosixAdmin&);
static int  EcStat(const char*, struct stat*, XrdPosixAdmin&);
static int  EcUnlink(const char*, XrdPosixAdmin&);
 
static int  baseFD;
static int  initDone;
};
#endif