TFileAdaptor Class Reference

#include <TFileAdaptor.h>

Public Member Functions
	TFileAdaptor (edm::ParameterSet const &pset, edm::ActivityRegistry &ar)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

Private Member Functions
bool	native (char const *proto) const
void	stats (std::ostream &o) const
void	statsXML (std::map< std::string, std::string > &data) const
void	termination (void) const

Static Private Member Functions
static void	addType (TPluginManager *mgr, char const *type, int altType=0)

Private Attributes
std::string	cacheHint_
unsigned int	debugLevel_
bool	doStats_
bool	enabled_
bool	enablePrefetching_
double	minFree_
std::vector< std::string >	native_
std::string	readHint_
std::string	tempDir_
unsigned int	timeout_

Friends
class	TFileAdaptorUI

Detailed Description

Definition at line 20 of file TFileAdaptor.h.

Constructor & Destructor Documentation

TFileAdaptor()

TFileAdaptor::TFileAdaptor	(	edm::ParameterSet const &	pset,
		edm::ActivityRegistry &	ar
	)

Definition at line 70 of file TFileAdaptor.cc.

References addType(), cacheHint_, haddnano::cl, edm::SiteLocalConfig::debugLevel(), debugLevel_, doStats_, enabled_, edm::SiteLocalConfig::enablePrefetching(), enablePrefetching_, Exception, f, edm::Service< T >::isAvailable(), minFree_, native(), native_, AlCaHLTBitMon_ParallelJobs::p, muonDTDigis_cfi::pset, readHint_, edm::SiteLocalConfig::sourceCacheHint(), edm::SiteLocalConfig::sourceCacheMinFree(), edm::SiteLocalConfig::sourceCacheTempDir(), edm::SiteLocalConfig::sourceNativeProtocols(), edm::SiteLocalConfig::sourceReadHint(), edm::SiteLocalConfig::sourceTimeout(), AlCaHLTBitMon_QueryRunRegistry::string, tempDir_, termination(), timeout_, and edm::ActivityRegistry::watchPostEndJob().

    : enabled_(true),
      doStats_(true),
      enablePrefetching_(false),
      cacheHint_("auto-detect"),
      readHint_("auto-detect"),
      tempDir_(),
      minFree_(0),
      timeout_(0U),
      debugLevel_(0U),
      native_() {
  if (!(enabled_ = pset.getUntrackedParameter<bool>("enable", enabled_)))
    return;

  using namespace edm::storage;
  StorageFactory* f = StorageFactory::getToModify();
  doStats_ = pset.getUntrackedParameter<bool>("stats", doStats_);

  // values set in the site local config or in SiteLocalConfigService override
  // any values set here for this service.
  // These parameters here are needed only for backward compatibility
  // for WMDM tools until we switch to only using the site local config for this info.
  cacheHint_ = pset.getUntrackedParameter<std::string>("cacheHint", cacheHint_);
  readHint_ = pset.getUntrackedParameter<std::string>("readHint", readHint_);
  tempDir_ = pset.getUntrackedParameter<std::string>("tempDir", f->tempPath());
  minFree_ = pset.getUntrackedParameter<double>("tempMinFree", f->tempMinFree());
  native_ = pset.getUntrackedParameter<std::vector<std::string> >("native", native_);

  ar.watchPostEndJob(this, &TFileAdaptor::termination);

  // Retrieve values from SiteLocalConfigService.
  // Any such values will override values set above.
  edm::Service<edm::SiteLocalConfig> pSLC;
  if (pSLC.isAvailable()) {
    if (std::string const* p = pSLC->sourceCacheTempDir()) {
      tempDir_ = *p;
    }
    if (double const* p = pSLC->sourceCacheMinFree()) {
      minFree_ = *p;
    }
    if (std::string const* p = pSLC->sourceCacheHint()) {
      cacheHint_ = *p;
    }
    if (std::string const* p = pSLC->sourceReadHint()) {
      readHint_ = *p;
    }
    if (unsigned int const* p = pSLC->sourceTimeout()) {
      timeout_ = *p;
    }
    if (std::vector<std::string> const* p = pSLC->sourceNativeProtocols()) {
      native_ = *p;
    }
    debugLevel_ = pSLC->debugLevel();
    enablePrefetching_ = pSLC->enablePrefetching();
  }

  // Prefetching does not work with storage-only; forcibly disable it.
  if ((enablePrefetching_) && ((cacheHint_ == "storage-only") || (cacheHint_ == "auto-detect")))
    cacheHint_ = "application-only";

  // tell factory how clients should access files
  if (cacheHint_ == "application-only")
    f->setCacheHint(StorageFactory::CACHE_HINT_APPLICATION);
  else if (cacheHint_ == "storage-only")
    f->setCacheHint(StorageFactory::CACHE_HINT_STORAGE);
  else if (cacheHint_ == "lazy-download")
    f->setCacheHint(StorageFactory::CACHE_HINT_LAZY_DOWNLOAD);
  else if (cacheHint_ == "auto-detect")
    f->setCacheHint(StorageFactory::CACHE_HINT_AUTO_DETECT);
  else
    throw cms::Exception("TFileAdaptor") << "Unrecognised 'cacheHint' value '" << cacheHint_
                                         << "', recognised values are 'application-only',"
                                         << " 'storage-only', 'lazy-download', 'auto-detect'";

  if (readHint_ == "direct-unbuffered")
    f->setReadHint(StorageFactory::READ_HINT_UNBUFFERED);
  else if (readHint_ == "read-ahead-buffered")
    f->setReadHint(StorageFactory::READ_HINT_READAHEAD);
  else if (readHint_ == "auto-detect")
    f->setReadHint(StorageFactory::READ_HINT_AUTO);
  else
    throw cms::Exception("TFileAdaptor") << "Unrecognised 'readHint' value '" << readHint_
                                         << "', recognised values are 'direct-unbuffered',"
                                         << " 'read-ahead-buffered', 'auto-detect'";

  f->setTimeout(timeout_);
  f->setDebugLevel(debugLevel_);

  // enable file access stats accounting if requested
  f->enableAccounting(doStats_);

  // tell where to save files.
  f->setTempDir(tempDir_, minFree_);

  // set our own root plugins
  TPluginManager* mgr = gROOT->GetPluginManager();

  // Make sure ROOT parses system directories first.
  mgr->LoadHandlersFromPluginDirs("TFile");
  mgr->LoadHandlersFromPluginDirs("TSystem");

  if (!native("file"))
    addType(mgr, "^file:");
  if (!native("http"))
    addType(mgr, "^http:");
  if (!native("http"))
    addType(mgr, "^http[s]?:");
  if (!native("ftp"))
    addType(mgr, "^ftp:");
  /* always */ addType(mgr, "^web:");
  /* always */ addType(mgr, "^gsiftp:");
  /* always */ addType(mgr, "^sfn:");
  if (!native("rfio"))
    addType(mgr, "^rfio:");
  if (!native("dcache"))
    addType(mgr, "^dcache:");
  if (!native("dcap"))
    addType(mgr, "^dcap:");
  if (!native("gsidcap"))
    addType(mgr, "^gsidcap:");
  if (!native("storm"))
    addType(mgr, "^storm:");
  if (!native("storm-lcg"))
    addType(mgr, "^storm-lcg:");
  if (!native("lstore"))
    addType(mgr, "^lstore:");
  if (!native("root"))
    addType(mgr, "^root:", 1);  // See comments in addType
  if (!native("root"))
    addType(mgr, "^[x]?root:", 1);  // See comments in addType

  // Make sure the TStorageFactoryFile can be loaded regardless of the header auto-parsing setting
  {
    edm::SetClassParsing guard(true);
    if (auto cl = TClass::GetClass("TStorageFactoryFile")) {
      cl->GetClassInfo();
    } else {
      throw cms::Exception("TFileAdaptor") << "Unable to obtain TClass for TStorageFactoryFile";
    }
  }
}

Member Function Documentation

addType()

void TFileAdaptor::addType ( TPluginManager *  mgr, char const *  type, int  altType = 0  )

staticprivate

Register TFileAdaptor to be the handler for a given type.

Once registered, URLs matching a specified regexp (for example, ^lstore: to manage files starting with lstore://) will be managed by a TFileAdaptor instance, possibly overriding any built-in ROOT adaptors.

Parameters

[in]	mgr	The ROOT plugin manager object.
[in]	type	A regexp-string; URLs matching this string will use TFileAdaptor.
[in]	altType	Due to a limitation in the TPluginManager, if the type was previously managed by TXNetFile, we must invoke AddHandler with a slightly different syntax. Set this parameter to 1 if this applies to you. Otherwise, leave it at the default (0)

Definition at line 39 of file TFileAdaptor.cc.

Referenced by TFileAdaptor().

                                                                               {
  // HACK:
  // The ROOT plug-in manager does not understand loading plugins with different
  // signatures.  So, because TXNetSystem is registered with a different constructor
  // than all the other plugins, we must match its interface in order to override
  // it.
  if (altType == 0) {
    mgr->AddHandler("TFile",
                    type,
                    "TStorageFactoryFile",
                    "IOPoolTFileAdaptor",
                    "TStorageFactoryFile(char const*,Option_t*,char const*,Int_t)");

    mgr->AddHandler("TSystem", type, "TStorageFactorySystem", "IOPoolTFileAdaptor", "TStorageFactorySystem()");
  } else if (altType == 1) {
    mgr->AddHandler("TFile",
                    type,
                    "TStorageFactoryFile",
                    "IOPoolTFileAdaptor",
                    "TStorageFactoryFile(char const*,Option_t*,char const*,Int_t, Int_t, Bool_t)");

    mgr->AddHandler(
        "TSystem", type, "TStorageFactorySystem", "IOPoolTFileAdaptor", "TStorageFactorySystem(const char *,Bool_t)");
  }
}

fillDescriptions()

void TFileAdaptor::fillDescriptions ( edm::ConfigurationDescriptions &  descriptions )

static

Definition at line 212 of file TFileAdaptor.cc.

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                              {
  edm::ParameterSetDescription desc;
  desc.addOptionalUntracked<bool>("enable");
  desc.addOptionalUntracked<bool>("stats");
  desc.addOptionalUntracked<std::string>("cacheHint");
  desc.addOptionalUntracked<std::string>("readHint");
  desc.addOptionalUntracked<std::string>("tempDir");
  desc.addOptionalUntracked<double>("tempMinFree");
  desc.addOptionalUntracked<std::vector<std::string> >("native");
  descriptions.add("AdaptorConfig", desc);
}

native()

bool TFileAdaptor::native ( char const *  proto ) const

private

Definition at line 65 of file TFileAdaptor.cc.

References spr::find(), and native_.

Referenced by TFileAdaptor().

                                                 {
  return std::find(native_.begin(), native_.end(), "all") != native_.end() ||
         std::find(native_.begin(), native_.end(), proto) != native_.end();
}

stats()

void TFileAdaptor::stats ( std::ostream &  o ) const

private

Definition at line 234 of file TFileAdaptor.cc.

References cacheHint_, doStats_, enablePrefetching_, EcalTangentSkim_cfg::o, readHint_, and edm::storage::StorageAccount::summaryText().

                                            {
  if (!doStats_) {
    return;
  }
  float const oneMeg = 1048576.0;
  o << "Storage parameters: adaptor: true"
    << " Stats:" << (doStats_ ? "true" : "false") << '\n'
    << " Prefetching:" << (enablePrefetching_ ? "true" : "false") << '\n'
    << " Cache hint:" << cacheHint_ << '\n'
    << " Read hint:" << readHint_ << '\n'
    << "Storage statistics: " << edm::storage::StorageAccount::summaryText() << "; tfile/read=?/?/"
    << (TFile::GetFileBytesRead() / oneMeg) << "MB/?ms/?ms/?ms"
    << "; tfile/write=?/?/" << (TFile::GetFileBytesWritten() / oneMeg) << "MB/?ms/?ms/?ms";
}

statsXML()

void TFileAdaptor::statsXML ( std::map< std::string, std::string > &  data ) const

private

Definition at line 249 of file TFileAdaptor.cc.

References cacheHint_, data, doStats_, enablePrefetching_, edm::storage::StorageAccount::fillSummary(), alignCSCRings::r, readHint_, and w().

Referenced by termination().

                                                                    {
  if (!doStats_) {
    return;
  }
  float const oneMeg = 1048576.0;
  data.insert(std::make_pair("Parameter-untracked-bool-enabled", "true"));
  data.insert(std::make_pair("Parameter-untracked-bool-stats", (doStats_ ? "true" : "false")));
  data.insert(std::make_pair("Parameter-untracked-bool-prefetching", (enablePrefetching_ ? "true" : "false")));
  data.insert(std::make_pair("Parameter-untracked-string-cacheHint", cacheHint_));
  data.insert(std::make_pair("Parameter-untracked-string-readHint", readHint_));
  edm::storage::StorageAccount::fillSummary(data);
  std::ostringstream r;
  std::ostringstream w;
  r << (TFile::GetFileBytesRead() / oneMeg);
  w << (TFile::GetFileBytesWritten() / oneMeg);
  data.insert(std::make_pair("ROOT-tfile-read-totalMegabytes", r.str()));
  data.insert(std::make_pair("ROOT-tfile-write-totalMegabytes", w.str()));
}

termination()

void TFileAdaptor::termination ( void  ) const

private

Definition at line 225 of file TFileAdaptor.cc.

References data, edm::JobReport::reportPerformanceSummary(), and statsXML().

Referenced by TFileAdaptor().

                                         {
  std::map<std::string, std::string> data;
  statsXML(data);
  if (!data.empty()) {
    edm::Service<edm::JobReport> reportSvc;
    reportSvc->reportPerformanceSummary("StorageStatistics", data);
  }
}

Friends And Related Function Documentation

TFileAdaptorUI

friend class TFileAdaptorUI

friend

Definition at line 26 of file TFileAdaptor.h.

Member Data Documentation

cacheHint_

std::string TFileAdaptor::cacheHint_

private

Definition at line 43 of file TFileAdaptor.h.

Referenced by stats(), statsXML(), and TFileAdaptor().

debugLevel_

unsigned int TFileAdaptor::debugLevel_

private

Definition at line 48 of file TFileAdaptor.h.

Referenced by TFileAdaptor().

doStats_

bool TFileAdaptor::doStats_

private

Definition at line 41 of file TFileAdaptor.h.

Referenced by stats(), statsXML(), and TFileAdaptor().

enabled_

bool TFileAdaptor::enabled_

private

Definition at line 40 of file TFileAdaptor.h.

Referenced by TFileAdaptor().

enablePrefetching_

bool TFileAdaptor::enablePrefetching_

private

Definition at line 42 of file TFileAdaptor.h.

Referenced by stats(), statsXML(), and TFileAdaptor().

minFree_

double TFileAdaptor::minFree_

private

Definition at line 46 of file TFileAdaptor.h.

Referenced by TFileAdaptor().

native_

std::vector<std::string> TFileAdaptor::native_

private

Definition at line 49 of file TFileAdaptor.h.

Referenced by native(), and TFileAdaptor().

readHint_

std::string TFileAdaptor::readHint_

private

Definition at line 44 of file TFileAdaptor.h.

Referenced by stats(), statsXML(), and TFileAdaptor().

tempDir_

std::string TFileAdaptor::tempDir_

private

Definition at line 45 of file TFileAdaptor.h.

Referenced by TFileAdaptor().

timeout_

unsigned int TFileAdaptor::timeout_

private

Definition at line 47 of file TFileAdaptor.h.

Referenced by TFileAdaptor().