XrdAdaptor::Source Class Reference

#include <XrdSource.h>

Inheritance diagram for XrdAdaptor::Source:

Public Member Functions
const std::string &	ExcludeID () const
std::shared_ptr< XrdCl::File >	getFileHandle ()
struct timespec	getLastDowngrade () const
unsigned	getQuality ()
void	handle (std::shared_ptr< ClientRequest >)
void	handle (RequestList &)
const std::string &	ID () const
const std::string &	PrettyID () const
void	setLastDowngrade (struct timespec now)
const std::string &	Site () const
	Source (timespec now, std::unique_ptr< XrdCl::File > fileHandle, const std::string &exclude)
	~Source ()

Static Public Member Functions
static void	determineHostExcludeString (XrdCl::File &file, const XrdCl::HostList *hostList, std::string &exclude)
static bool	getDomain (const std::string &host, std::string &domain)
static bool	getHostname (const std::string &id, std::string &hostname)
static bool	getXrootdSite (XrdCl::File &file, std::string &site)
static bool	getXrootdSiteFromURL (std::string url, std::string &site)
static bool	isDCachePool (XrdCl::File &file, const XrdCl::HostList *hostList=nullptr)
static bool	isDCachePool (const std::string &url)

Private Member Functions
std::shared_ptr< XrdCl::File const >	fh () const
std::shared_ptr< XrdCl::File > &	fh ()
void	requestCallback ()
void	setXrootdSite ()
std::shared_ptr< XrdSiteStatistics const >	stats () const
std::shared_ptr< XrdSiteStatistics > &	stats ()

Private Attributes
std::string	m_exclude
edm::propagate_const< std::shared_ptr< XrdCl::File > >	m_fh
std::string	m_id
struct timespec	m_lastDowngrade
std::string	m_prettyid
edm::propagate_const< std::unique_ptr< QualityMetricSource > >	m_qm
std::string	m_site
edm::propagate_const< std::shared_ptr< XrdSiteStatistics > >	m_stats

Detailed Description

Definition at line 25 of file XrdSource.h.

Constructor & Destructor Documentation

Source::Source	(	timespec	now,
		std::unique_ptr< XrdCl::File >	fileHandle,
		const std::string &	exclude
	)

Definition at line 190 of file XrdSource.cc.

References fh(), g_delayCount, edm::propagate_const< T >::get(), XrdAdaptor::QualityMetricFactory::get(), getDomain(), XrdAdaptor::XrdSiteStatisticsInformation::getInstance(), m_exclude, m_fh, m_id, m_prettyid, m_qm, m_site, m_stats, eostools::move(), cmsPerfSuiteHarvest::now, setXrootdSite(), and AlCaHLTBitMon_QueryRunRegistry::string.

    : m_lastDowngrade({0, 0}),
      m_id("(unknown)"),
      m_exclude(exclude),
      m_fh(std::move(fh)),
      m_stats(nullptr)
#ifdef XRD_FAKE_SLOW
    , m_slow(++g_delayCount % XRD_SLOW_RATE == 0)
    //, m_slow(++g_delayCount >= XRD_SLOW_RATE)
    //, m_slow(true)
#endif
{
    if (m_fh.get())
    {
      if (!m_fh->GetProperty("DataServer", m_id))
      {
        edm::LogWarning("XrdFileWarning")
          << "Source::Source() failed to determine data server name.'";
      }
      if (m_exclude.empty()) {m_exclude = m_id;}
    }
    m_qm = QualityMetricFactory::get(now, m_id);
    m_prettyid = m_id + " (unknown site)";
    std::string domain_id;
    if (getDomain(m_id, domain_id)) {m_site = domain_id;}
    else {m_site = "Unknown (" + m_id + ")";}
    setXrootdSite();
    assert(m_qm.get());
    assert(m_fh.get());
    XrdSiteStatisticsInformation *statsService = XrdSiteStatisticsInformation::getInstance();
    if (statsService)
    {
        m_stats = statsService->getStatisticsForSite(m_site);
    }
}

Source::~Source

(

)

Definition at line 393 of file XrdSource.cc.

References fh(), m_id, and m_site.

{
  new DelayedClose(fh(), m_id, m_site);
}

Member Function Documentation

void Source::determineHostExcludeString ( XrdCl::File &  file, const XrdCl::HostList *  hostList, std::string &  exclude  )

static

Definition at line 307 of file XrdSource.cc.

References info(), isDCachePool(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by XrdAdaptor::RequestManager::OpenHandler::HandleResponseWithHosts(), and XrdAdaptor::RequestManager::initialize().

{
    // Detect a dCache pool and, if we are in the federation context, give a custom
    // exclude parameter.
    // We assume this is a federation context if there's at least a regional, dCache door,
    // and dCache pool server (so, more than 2 servers!).

    exclude = "";
    if (hostList && (hostList->size() > 3) && isDCachePool(file, hostList))
    {
        const XrdCl::HostInfo &info = (*hostList)[hostList->size()-3];
        exclude = info.url.GetHostName();
        std::string lastUrl; file.GetProperty("LastURL", lastUrl);
        edm::LogVerbatim("XrdAdaptorInternal") << "Changing exclude list for URL " << lastUrl << " to " << exclude;
    }
}

const std::string& XrdAdaptor::Source::ExcludeID ( ) const

inline

Definition at line 41 of file XrdSource.h.

{return m_exclude;}

std::shared_ptr<XrdCl::File const> XrdAdaptor::Source::fh ( ) const

inlineprivate

Definition at line 69 of file XrdSource.h.

References edm::get_underlying_safe().

Referenced by getFileHandle(), Source(), and ~Source().

{return get_underlying_safe(m_fh);}

std::shared_ptr<XrdCl::File>& XrdAdaptor::Source::fh ( )

inlineprivate

Definition at line 70 of file XrdSource.h.

References edm::get_underlying_safe().

{return get_underlying_safe(m_fh);}

bool Source::getDomain ( const std::string &  host, std::string &  domain  )

static

Definition at line 255 of file XrdSource.cc.

References getHostname().

Referenced by getXrootdSite(), getXrootdSiteFromURL(), XrdAdaptor::RequestManager::initialize(), and Source().

{
    getHostname(host, domain);
    size_t pos = domain.find(".");
    if (pos != std::string::npos && (pos < domain.size())) {domain = domain.substr(pos+1);}

    return !domain.empty();
}

std::shared_ptr< XrdCl::File > Source::getFileHandle

(

)

Definition at line 399 of file XrdSource.cc.

References fh().

{
    return fh();
}

bool Source::getHostname ( const std::string &  id, std::string &  hostname  )

static

Definition at line 227 of file XrdSource.cc.

References query::host, triggerObjects_cff::id, and mps_fire::result.

Referenced by getDomain(), XrdAdaptor::RequestManager::initialize(), and XrdAdaptor::RequestManager::queueUpdateCurrentServer().

{
    size_t pos = id.find(":");
    hostname = id;
    if ((pos != std::string::npos) && (pos > 0)) {hostname = id.substr(0, pos);}

    bool retval = true;
    if (!hostname.empty() && ((hostname[0] == '[') || isdigit(hostname[0])))
    {
        retval = false;
        struct addrinfo hints; memset(&hints, 0, sizeof(struct addrinfo));
        hints.ai_family = AF_UNSPEC;
        struct addrinfo *result;
        if (!getaddrinfo(hostname.c_str(), nullptr, &hints, &result))
        {
            std::vector<char> host; host.reserve(256);
            if (!getnameinfo(result->ai_addr, result->ai_addrlen, &host[0], 255, nullptr, 0, NI_NAMEREQD))
            {
                hostname = &host[0];
                retval = true;
            }
            freeaddrinfo(result);
        }
    }
    return retval;
}

struct timespec XrdAdaptor::Source::getLastDowngrade ( ) const

inline

Definition at line 45 of file XrdSource.h.

{return m_lastDowngrade;}

unsigned XrdAdaptor::Source::getQuality ( )

inline

Definition at line 43 of file XrdSource.h.

{return m_qm->get();}

bool Source::getXrootdSite ( XrdCl::File &  file, std::string &  site  )

static

Definition at line 326 of file XrdSource.cc.

References getDomain(), getXrootdSiteFromURL(), triggerObjects_cff::id, isDCachePool(), definitions::server, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by setXrootdSite().

{
    std::string lastUrl;
    fh.GetProperty("LastURL", lastUrl);
    if (lastUrl.empty() || isDCachePool(lastUrl))
    {
        std::string server, id;
        if (!fh.GetProperty("DataServer", server)) {id = "(unknown)";}
        else {id = server;}
        if (lastUrl.empty()) {edm::LogWarning("XrdFileWarning") << "Unable to determine the URL associated with server " << id;}
        site = "Unknown";
        if (!server.empty()) {getDomain(server, site);}
        return false;
    }
    return getXrootdSiteFromURL(lastUrl, site);
}

bool Source::getXrootdSiteFromURL ( std::string  url, std::string &  site  )

static

Definition at line 344 of file XrdSource.cc.

References getDomain(), QueryAttrHandler::query(), seconds(), and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by getXrootdSite(), and XrdAdaptor::RequestManager::initialize().

{
    const std::string attr = "sitename";
    XrdCl::Buffer *response = nullptr;
    XrdCl::Buffer arg( attr.size() );
    arg.FromString( attr );

    XrdCl::FileSystem fs(url);
    std::string rsite;
    XrdCl::XRootDStatus st = QueryAttrHandler::query(fs, "sitename", std::chrono::seconds(1), rsite);
    if (!st.IsOK())
    {
        XrdCl::URL xurl(url);
        getDomain(xurl.GetHostName(), site);
        delete response;
        return false;
    }
    if (!rsite.empty() && (rsite[rsite.size()-1] == '\n'))
    {
        rsite = rsite.substr(0, rsite.size()-1);
    }
    if (rsite == "sitename")
    {
        XrdCl::URL xurl(url);
        getDomain(xurl.GetHostName(), site);
        return false;
    }
    site = rsite;
    return true;
}

void Source::handle

(

std::shared_ptr< ClientRequest >

c

)

Definition at line 420 of file XrdSource.cc.

References cms::Exception::addContext(), EnergyCorrector::c, GetRecoTauVFromDQM_MC_cff::cl, edm::errors::FileReadError, ID(), m_fh, m_qm, m_stats, XrdAdaptor::XrdSiteStatistics::startRead(), stats(), mps_update::status, and validateList().

{
    edm::LogVerbatim("XrdAdaptorInternal") << "Reading from " << ID() << ", quality " << m_qm->get() << std::endl;
    c->m_source = shared_from_this();
    c->m_self_reference = c;
    m_qm->startWatch(c->m_qmw);
    if (m_stats)
    {
        std::shared_ptr<XrdReadStatistics> readStats = XrdSiteStatistics::startRead(stats(), c);
        c->setStatistics(readStats);
    }
#ifdef XRD_FAKE_SLOW
    if (m_slow) std::this_thread::sleep_for(std::chrono::milliseconds(XRD_DELAY));
#endif

    XrdCl::XRootDStatus status;
    if (c->m_into)
    {
        // See notes in ClientRequest definition to understand this voodoo.
        status = m_fh->Read(c->m_off, c->m_size, c->m_into, c.get());
    }
    else
    {
        XrdCl::ChunkList cl;
        cl.reserve(c->m_iolist->size());
        for (const auto & it : *c->m_iolist)
        {
            cl.emplace_back(it.offset(), it.size(), it.data());
        }
        validateList(cl);
        status = m_fh->VectorRead(cl, nullptr, c.get());
    }

    if (!status.IsOK())
    {
        edm::Exception ex(edm::errors::FileReadError);
        ex << "XrdFile::Read or XrdFile::VectorRead failed with error: '"
           << status.ToStr() << "' (errNo = " << status.errNo << ")";
        ex.addContext("Calling Source::handle");
        throw ex;
    }
}

void XrdAdaptor::Source::handle

(

RequestList &

)

const std::string& XrdAdaptor::Source::ID ( ) const

inline

Definition at line 38 of file XrdSource.h.

Referenced by handle().

{return m_id;}

bool Source::isDCachePool ( XrdCl::File &  file, const XrdCl::HostList *  hostList = nullptr  )

static

Definition at line 266 of file XrdSource.cc.

References mps_fire::result, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by determineHostExcludeString(), getXrootdSite(), and SendMonitoringInfo().

{
    // WORKAROUND: On open-file recovery in the Xrootd client, it'll carry around the
    // dCache opaque information to other sites, causing isDCachePool to erroneously return
    // true.  We are working with the upstream developers to solve this.
    //
    // For now, we see if the previous server also looks like a dCache pool - something that
    // wouldn't happen at a real site, as the previous server should look like a dCache door.
    std::string lastUrl;
    file.GetProperty("LastURL", lastUrl);
    if (!lastUrl.empty())
    {
        bool result = isDCachePool(lastUrl);
        if (result && hostList && (hostList->size() > 1))
        {
        if (isDCachePool((*hostList)[hostList->size()-2].url.GetURL()))
        {
            return false;
        }
        return true;
        }
    return result;
    }
    return false;
}

bool Source::isDCachePool ( const std::string &  url )

static

Definition at line 293 of file XrdSource.cc.

References genParticles_cff::map, and relmon_authenticated_wget::url.

{
    XrdCl::URL url(lastUrl);
    XrdCl::URL::ParamsMap map = url.GetParams();
    // dCache pools always utilize this opaque identifier.
    if (map.find("org.dcache.uuid") != map.end())
    {
        return true;
    }
    return false;
}

const std::string& XrdAdaptor::Source::PrettyID ( ) const

inline

Definition at line 40 of file XrdSource.h.

Referenced by XrdAdaptor::ClientRequest::HandleResponse().

{return m_prettyid;}

void XrdAdaptor::Source::requestCallback ( )

private

void XrdAdaptor::Source::setLastDowngrade ( struct timespec  now )

inline

Definition at line 46 of file XrdSource.h.

References FrontierConditions_GlobalTag_cff::file, ecalTB2006H4_GenSimDigiReco_cfg::File, query::host, cmsPerfSuiteHarvest::now, AlCaHLTBitMon_QueryRunRegistry::string, and relmon_authenticated_wget::url.

{m_lastDowngrade = now;}

void Source::setXrootdSite ( )

private

Definition at line 376 of file XrdSource.cc.

References getXrootdSite(), m_fh, m_id, m_prettyid, m_site, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by Source().

{
    std::string site;
    bool goodSitename = getXrootdSite(*m_fh, site);
    if (!goodSitename)
    {
        edm::LogInfo("XrdAdaptorInternal")
          << "Xrootd server at " << m_id << " did not provide a sitename.  Monitoring may be incomplete.";
    }
    else
    {
       m_site = site;
        m_prettyid = m_id + " (site " + m_site + ")";
    }
    edm::LogInfo("XrdAdaptorInternal") << "Reading from new server " << m_id << " at site " << m_site;
}

const std::string& XrdAdaptor::Source::Site ( ) const

inline

Definition at line 39 of file XrdSource.h.

{return m_site;}

std::shared_ptr<XrdSiteStatistics const> XrdAdaptor::Source::stats ( ) const

inlineprivate

Definition at line 71 of file XrdSource.h.

References edm::get_underlying_safe().

Referenced by handle().

{return get_underlying_safe(m_stats);}

std::shared_ptr<XrdSiteStatistics>& XrdAdaptor::Source::stats ( )

inlineprivate

Definition at line 72 of file XrdSource.h.

References edm::get_underlying_safe().

{return get_underlying_safe(m_stats);}

Member Data Documentation

std::string XrdAdaptor::Source::m_exclude

private

Definition at line 78 of file XrdSource.h.

Referenced by Source().

edm::propagate_const<std::shared_ptr<XrdCl::File> > XrdAdaptor::Source::m_fh

private

Definition at line 79 of file XrdSource.h.

Referenced by handle(), setXrootdSite(), and Source().

std::string XrdAdaptor::Source::m_id

private

Definition at line 75 of file XrdSource.h.

Referenced by setXrootdSite(), Source(), and ~Source().

struct timespec XrdAdaptor::Source::m_lastDowngrade

private

Definition at line 74 of file XrdSource.h.

std::string XrdAdaptor::Source::m_prettyid

private

Definition at line 76 of file XrdSource.h.

Referenced by setXrootdSite(), and Source().

edm::propagate_const<std::unique_ptr<QualityMetricSource> > XrdAdaptor::Source::m_qm

private

Definition at line 81 of file XrdSource.h.

Referenced by handle(), and Source().

std::string XrdAdaptor::Source::m_site

private

Definition at line 77 of file XrdSource.h.

Referenced by setXrootdSite(), Source(), and ~Source().

edm::propagate_const<std::shared_ptr<XrdSiteStatistics> > XrdAdaptor::Source::m_stats

private

Definition at line 82 of file XrdSource.h.

Referenced by handle(), and Source().