XrdStorageMaker Class Reference

Inheritance diagram for XrdStorageMaker:

Public Member Functions
bool	check (const std::string &proto, const std::string &path, const AuxSettings &aux, IOOffset *size=nullptr) const override
std::unique_ptr< Storage >	open (const std::string &proto, const std::string &path, int mode, const AuxSettings &aux) const override
void	setDebugLevel (unsigned int level) const
void	setTimeout (unsigned int timeout) const
void	stagein (const std::string &proto, const std::string &path, const AuxSettings &aux) const override
	XrdStorageMaker ()
Public Member Functions inherited from StorageMaker
	StorageMaker ()=default
virtual	~StorageMaker ()=default

Static Public Attributes
static const unsigned int	XRD_DEFAULT_TIMEOUT = 3 * 60

Private Attributes
std::mutex	m_envMutex
std::atomic< unsigned int >	m_lastDebugLevel
std::atomic< unsigned int >	m_lastTimeout
MakerResponseHandler	m_null_handler

Detailed Description

Definition at line 28 of file XrdStorageMaker.cc.

Constructor & Destructor Documentation

XrdStorageMaker()

XrdStorageMaker::XrdStorageMaker ( )

inline

Definition at line 32 of file XrdStorageMaker.cc.

      : m_lastDebugLevel(1),  //so that 0 will trigger change
        m_lastTimeout(0) {
    // When CMSSW loads, both XrdCl and XrdClient end up being loaded
    // (ROOT loads XrdClient).  XrdClient forces IPv4-only.  Accordingly,
    // we must explicitly set the default network stack in XrdCl to
    // whatever is available on the node (IPv4 or IPv6).
    XrdCl::Env *env = XrdCl::DefaultEnv::GetEnv();
    if (env) {
      env->PutString("NetworkStack", "IPAuto");
    }
    XrdNetUtils::SetAuto(XrdNetUtils::prefAuto);
    setTimeout(XRD_DEFAULT_TIMEOUT);
    setDebugLevel(0);
  }

References web.browse_db::env, setDebugLevel(), setTimeout(), and XRD_DEFAULT_TIMEOUT.

Member Function Documentation

check()

bool XrdStorageMaker::check ( const std::string &  proto, const std::string &  path, const AuxSettings &  aux, IOOffset *  size = nullptr  ) const

inlineoverridevirtual

Reimplemented from StorageMaker.

Definition at line 87 of file XrdStorageMaker.cc.

                                                      {
    setDebugLevel(aux.debugLevel);
    setTimeout(aux.timeout);
 
    std::string fullpath(proto + ":" + path);
    XrdCl::URL url(fullpath);
    XrdCl::FileSystem fs(url);
 
    XrdCl::StatInfo *stat;
    if (!(fs.Stat(url.GetPath(), stat)).IsOK() || (stat == nullptr)) {
      return false;
    }
 
    if (size)
      *size = stat->GetSize();
    return true;
  }

References printConversionInfo::aux, reco_skim_cfg_mod::fullpath, castor_dqm_sourceclient_file_cfg::path, setDebugLevel(), setTimeout(), findQualityFiles::size, edm_modernize_messagelogger::stat, AlCaHLTBitMon_QueryRunRegistry::string, hcal_runs::URL, and relmon_authenticated_wget::url.

open()

std::unique_ptr<Storage> XrdStorageMaker::open ( const std::string &  proto, const std::string &  path, int  mode, const AuxSettings &  aux  ) const

inlineoverridevirtual

Open a storage object for the given URL (protocol + path), using the mode bits. No temporary files are downloaded.

Implements StorageMaker.

Definition at line 50 of file XrdStorageMaker.cc.

                                                                       {
    setDebugLevel(aux.debugLevel);
    setTimeout(aux.timeout);
 
    const StorageFactory *f = StorageFactory::get();
    StorageFactory::ReadHint readHint = f->readHint();
    StorageFactory::CacheHint cacheHint = f->cacheHint();
 
    if (readHint != StorageFactory::READ_HINT_UNBUFFERED || cacheHint == StorageFactory::CACHE_HINT_STORAGE)
      mode &= ~IOFlags::OpenUnbuffered;
    else
      mode |= IOFlags::OpenUnbuffered;
 
    std::string fullpath(proto + ":" + path);
    auto file = std::make_unique<XrdFile>(fullpath, mode);
    return f->wrapNonLocalFile(std::move(file), proto, std::string(), mode);
  }

References printConversionInfo::aux, StorageFactory::CACHE_HINT_STORAGE, f, FrontierConditions_GlobalTag_cff::file, reco_skim_cfg_mod::fullpath, StorageFactory::get(), ALCARECOPromptCalibProdSiPixelAli0T_cff::mode, eostools::move(), IOFlags::OpenUnbuffered, castor_dqm_sourceclient_file_cfg::path, StorageFactory::READ_HINT_UNBUFFERED, setDebugLevel(), setTimeout(), and AlCaHLTBitMon_QueryRunRegistry::string.

setDebugLevel()

void XrdStorageMaker::setDebugLevel ( unsigned int  level ) const

inline

Definition at line 108 of file XrdStorageMaker.cc.

                                               {
    auto oldLevel = m_lastDebugLevel.load();
    if (level == oldLevel) {
      return;
    }
    std::lock_guard<std::mutex> guard(m_envMutex);
    if (oldLevel != m_lastDebugLevel) {
      //another thread just changed this value
      return;
    }
 
    // 'Error' is way too low of debug level - we have interest
    // in warning in the default
    switch (level) {
      case 0:
        XrdCl::DefaultEnv::SetLogLevel("Warning");
        break;
      case 1:
        XrdCl::DefaultEnv::SetLogLevel("Info");
        break;
      case 2:
        XrdCl::DefaultEnv::SetLogLevel("Debug");
        break;
      case 3:
        XrdCl::DefaultEnv::SetLogLevel("Dump");
        break;
      case 4:
        XrdCl::DefaultEnv::SetLogLevel("Dump");
        break;
      default:
        edm::Exception ex(edm::errors::Configuration);
        ex << "Invalid log level specified " << level;
        ex.addContext("Calling XrdStorageMaker::setDebugLevel()");
        throw ex;
    }
    m_lastDebugLevel = level;
  }

References cms::Exception::addContext(), edm::errors::Configuration, personalPlayback::level, m_envMutex, and m_lastDebugLevel.

Referenced by check(), open(), stagein(), and XrdStorageMaker().

setTimeout()

void XrdStorageMaker::setTimeout ( unsigned int  timeout ) const

inline

Definition at line 146 of file XrdStorageMaker.cc.

                                              {
    timeout = timeout ? timeout : XRD_DEFAULT_TIMEOUT;
 
    auto oldTimeout = m_lastTimeout.load();
    if (oldTimeout == timeout) {
      return;
    }
 
    std::lock_guard<std::mutex> guard(m_envMutex);
    if (oldTimeout != m_lastTimeout) {
      //Another thread beat us to changing the value
      return;
    }
 
    XrdCl::Env *env = XrdCl::DefaultEnv::GetEnv();
    if (env) {
      env->PutInt("StreamTimeout", timeout);
      env->PutInt("RequestTimeout", timeout);
      env->PutInt("ConnectionWindow", timeout);
      env->PutInt("StreamErrorWindow", timeout);
      // Crank down some of the connection defaults.  We have more
      // aggressive error recovery than the default client so we
      // can error out sooner.
      env->PutInt("ConnectionWindow", timeout / 6 + 1);
      env->PutInt("ConnectionRetry", 2);
    }
    m_lastTimeout = timeout;
  }

References web.browse_db::env, m_envMutex, m_lastTimeout, mps_check::timeout, and XRD_DEFAULT_TIMEOUT.

Referenced by check(), open(), stagein(), and XrdStorageMaker().

stagein()

void XrdStorageMaker::stagein ( const std::string &  proto, const std::string &  path, const AuxSettings &  aux  ) const

inlineoverridevirtual

Reimplemented from StorageMaker.

Definition at line 71 of file XrdStorageMaker.cc.

                                                                                                     {
    setDebugLevel(aux.debugLevel);
    setTimeout(aux.timeout);
 
    std::string fullpath(proto + ":" + path);
    XrdCl::URL url(fullpath);
    XrdCl::FileSystem fs(url);
    std::vector<std::string> fileList;
    fileList.push_back(url.GetPath());
    auto status = fs.Prepare(fileList, XrdCl::PrepareFlags::Stage, 0, &m_null_handler);
    if (!status.IsOK()) {
      edm::LogWarning("StageInError") << "XrdCl::FileSystem::Prepare failed with error '" << status.ToStr()
                                      << "' (errNo = " << status.errNo << ")";
    }
  }

References printConversionInfo::aux, reco_skim_cfg_mod::fullpath, m_null_handler, castor_dqm_sourceclient_file_cfg::path, setDebugLevel(), setTimeout(), mps_update::status, AlCaHLTBitMon_QueryRunRegistry::string, hcal_runs::URL, and relmon_authenticated_wget::url.

Member Data Documentation

m_envMutex

std::mutex XrdStorageMaker::m_envMutex

mutableprivate

Definition at line 177 of file XrdStorageMaker.cc.

Referenced by setDebugLevel(), and setTimeout().

m_lastDebugLevel

std::atomic<unsigned int> XrdStorageMaker::m_lastDebugLevel

mutableprivate

Definition at line 178 of file XrdStorageMaker.cc.

Referenced by setDebugLevel().

m_lastTimeout

std::atomic<unsigned int> XrdStorageMaker::m_lastTimeout

mutableprivate

Definition at line 179 of file XrdStorageMaker.cc.

Referenced by setTimeout().

m_null_handler

MakerResponseHandler XrdStorageMaker::m_null_handler

mutableprivate

Definition at line 176 of file XrdStorageMaker.cc.

Referenced by stagein().

XRD_DEFAULT_TIMEOUT

const unsigned int XrdStorageMaker::XRD_DEFAULT_TIMEOUT = 3 * 60

static

Definition at line 30 of file XrdStorageMaker.cc.

Referenced by setTimeout(), and XrdStorageMaker().