TDavixFile.h

Go to the documentation of this file.

// @(#)root/net:$Id$
// Author: Adrien Devresse and Tigran Mkrtchyan
 
/*************************************************************************
 * Copyright (C) 1995-2013, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/
 
#ifndef ROOT_TDavixFile
#define ROOT_TDavixFile
 
//////////////////////////////////////////////////////////////////////////
//                                                                      //
// TDavixFile                                                           //
//                                                                      //
// A TDavixFile is like a normal TFile except that it uses              //
// libdavix to read/write remote files.                                 //
// It supports HTTP and HTTPS in a number of dialects and options       //
//  e.g. S3 is one of them                                              //
// Other caracteristics come from the full support of Davix,            //
//  e.g. full redirection support in any circumstance                   //
//                                                                      //
// Authors:     Adrien Devresse (CERN IT/SDC)                           //
//              Tigran Mkrtchyan (DESY)                                 //
//                                                                      //
// Checks, refactoring and ROOT5 porting:                               //
//              Fabrizio Furano (CERN IT/SDC)                           //
//                                                                      //
// September 2013                                                       //
//                                                                      //
//////////////////////////////////////////////////////////////////////////
 
//
// Parameters that influence the behavior of TDavixFile/TDavixSystem. The names should be self-explanatory
//
//Davix.Debug
//Davix.GSI.UserProxy
//Davix.GSI.UserCert
//Davix.GSI.UserKey
 
//Davix.GSI.CAdir
//Davix.GSI.CACheck
//Davix.GSI.GridMode
//
//Davix.S3.AccessKey
//Davix.S3.SecretKey
//Davix.S3.Region
//Davix.S3.Token
//
// Environment variables:
// X509_USER_CERT, X509_USER_KEY, X509_USER_PROXY ... usual meaning for the X509 Grid things. gEnv vars have higher priority.
// S3_ACCESS_KEY, S3_SECRET_KEY, S3_REGION, S3_TOKEN. gEnv vars have higher priority.
 
#include "TFile.h"
 
class TDavixFileInternal;
struct Davix_fd;
 
namespace ROOT {
class RLogChannel;
ROOT::RLogChannel &TDavixLogChannel();
} // namespace ROOT
 
class TDavixFile : public TFile {
private:
    TDavixFileInternal* d_ptr;
 
    void Init(Bool_t init) override;
    Long64_t DavixReadBuffer(Davix_fd *fd, char *buf, Int_t len);
    Long64_t DavixPReadBuffer(Davix_fd *fd, char *buf, Long64_t pos, Int_t len);
    Long64_t DavixReadBuffers(Davix_fd *fd, char *buf, Long64_t *pos, Int_t *len, Int_t nbuf);
    Long64_t DavixWriteBuffer(Davix_fd *fd, const char *buf, Int_t len);
    Int_t DavixStat(struct stat *st) const;
 
    // perfStats
    Double_t eventStart();
    void eventStop(Double_t t, Long64_t len, bool read = true);
 
public:
    ///
    ///  Open function for TDavixFile
    ///
    /// TDavixFile supports several options :
    ///
    ///  - GRID_MODE=yes   : enable the grid authentication and CA support
    ///  - CA_CHECK=no     : remove all the certificate authority check, this option can create a security vulnerability
    ///  - S3SECKEY=string : Amazon S3 secret token
    ///  - S3ACCKEY=string : Amazon S3 access token
    ///  - S3REGION=string : Amazon S3 region. Optional, if provided, davix will use v4 signatures.
    ///  - S3TOKEN=string  : Amazon STS temporary credentials token.
    ///
    /// Several parameters can be used if separated with whitespace
 
   TDavixFile(const char* url, Option_t *option="", const char *ftitle="", Int_t compress = ROOT::RCompressionSetting::EDefaults::kUseCompiledDefault);
 
   ~TDavixFile();
 
    // TFile interface.
    Long64_t GetSize() const override;
    void  Seek(Long64_t offset, ERelativeTo pos = kBeg) override;
    Bool_t ReadBuffer(char *buf, Int_t len) override;
    Bool_t ReadBuffer(char *buf, Long64_t pos, Int_t len) override;
    Bool_t ReadBuffers(char *buf, Long64_t *pos, Int_t *len, Int_t nbuf) override;
    Bool_t ReadBufferAsync(Long64_t offs, Int_t len) override;
    Bool_t WriteBuffer(const char *buffer, Int_t bufferLength) override;
    TString GetNewUrl() override;
 
    // TDavixFile options
    /// Enable or disable certificate authority check
    void setCACheck(Bool_t check);
 
    // Determine the value of the current token from the process's environment.
    // Follows the WLCG Bearer Token Discovery schema.
    // On error or no token discovered, returns the empty string.
    std::string DiscoverToken();
 
    /// Enable the grid mode
    /// The grid Mode configure automatically all grid-CA path, VOMS authentication
    /// and grid related extension for a grid analysis usage
    void enableGridMode();
 
    ClassDefOverride(TDavixFile, 0)
};
 
#endif