triton::backend::traccc::TracccTritonInitializer Class Reference

Owns the embedded Athena application that backs the Traccc Triton backend, plus the process-wide device infrastructure it brings up. More...

#include <TracccTritonInitializer.h>

Collaboration diagram for triton::backend::traccc::TracccTritonInitializer:

Classes
struct	Config
	Construction parameters, normally read from the model config, plus the StoreGate keys initialize() fills in from the python configuration. More...
struct	Impl

Public Member Functions
void	initialize (const Config &config)
	Boot the embedded Athena application and resolve all cached handles.
void	finalize ()
	Tear the application down. Safe to call when not initialized.
bool	isReady () const
	Whether initialize has completed successfully.
const Config &	config () const
	The construction parameters the application was configured with.
int	deviceId () const
	The CUDA device id this instance is pinned to.
ISvcLocator &	serviceLocator () const
	The service locator of the embedded Athena application (never null once ready).
std::size_t	acquireSlot ()
	Claim the next free event-store slot for a Triton model instance.
	~TracccTritonInitializer ()
	TracccTritonInitializer (const TracccTritonInitializer &)=delete
TracccTritonInitializer &	operator= (const TracccTritonInitializer &)=delete

Static Public Member Functions
static TracccTritonInitializer &	instance ()
	Get the process-wide singleton.

Private Member Functions
	TracccTritonInitializer ()

Private Attributes
std::unique_ptr< Impl >	m_impl

Detailed Description

Owns the embedded Athena application that backs the Traccc Triton backend, plus the process-wide device infrastructure it brings up.

The device reconstruction algorithms are ordinary Gaudi AthReentrantAlgorithm components: they read/write StoreGate and depend on provider tools and DetectorStore services. They therefore cannot be constructed as plain C++ objects; an initialized Athena application has to exist.

The python configuration schedules them inside a single AthSequencer named Config::sequenceName, which is what TracccTritonRunner executes; the composition and ordering of the chain therefore live entirely in TracccTritonDeviceRecoCfg.

Definition at line 38 of file TracccTritonInitializer.h.

Constructor & Destructor Documentation

~TracccTritonInitializer()

triton::backend::traccc::TracccTritonInitializer::~TracccTritonInitializer

(

)

Definition at line 177 of file TracccTritonInitializer.cxx.

                                                  {
    try {
        finalize();
    } catch (...) {
    }
}

TracccTritonInitializer() [1/2]

triton::backend::traccc::TracccTritonInitializer::TracccTritonInitializer ( const TracccTritonInitializer & )

delete

TracccTritonInitializer() [2/2]

triton::backend::traccc::TracccTritonInitializer::TracccTritonInitializer ( )

private

Definition at line 174 of file TracccTritonInitializer.cxx.

    : m_impl(std::make_unique<Impl>()) {}

Member Function Documentation

acquireSlot()

std::size_t triton::backend::traccc::TracccTritonInitializer::acquireSlot

(

)

Claim the next free event-store slot for a Triton model instance.

Exceptions

std::runtime_error

if more slots are claimed than the application was configured with.

Definition at line 277 of file TracccTritonInitializer.cxx.

                                     {
    if (!m_impl->ready) {
        throw std::runtime_error(
            "TracccTritonInitializer::acquireSlot: not initialized");
    }
    const std::size_t slot = m_impl->nextSlot.fetch_add(1);
    if (slot >= m_impl->config.nSlots) {
        throw std::runtime_error(
            "TracccTritonInitializer: Triton created more model instances "
            "than the " + std::to_string(m_impl->config.nSlots) +
            " event slot(s) the application was configured with");
    }
    return slot;
}

config()

const TracccTritonInitializer::Config & triton::backend::traccc::TracccTritonInitializer::config

(

)

const

The construction parameters the application was configured with.

Definition at line 272 of file TracccTritonInitializer.cxx.

                                      {
    return m_impl->config;
}

deviceId()

int triton::backend::traccc::TracccTritonInitializer::deviceId

(

)

const

The CUDA device id this instance is pinned to.

Definition at line 292 of file TracccTritonInitializer.cxx.

                                            {
    return m_impl->config.deviceId;
}

finalize()

void triton::backend::traccc::TracccTritonInitializer::finalize

(

)

Tear the application down. Safe to call when not initialized.

Definition at line 251 of file TracccTritonInitializer.cxx.

                                       {
    if (!m_impl->ready) return;
 
    if (m_impl->app) {
        // finalize() expects the INITIALIZED state, so the RUNNING state the
        // bootstrap left the application in has to be unwound first.
        m_impl->app->stop().ignore();
        m_impl->app->finalize().ignore();
        m_impl->app->terminate().ignore();
    }
 
    m_impl->svcLocator = nullptr;
    m_impl->app = nullptr;
    m_impl->ready = false;
}

initialize()

void triton::backend::traccc::TracccTritonInitializer::initialize

(

const Config &

config

)

Boot the embedded Athena application and resolve all cached handles.

Exceptions

std::runtime_error

on any failure to bring it up.

Definition at line 192 of file TracccTritonInitializer.cxx.

                                                             {
    static std::mutex initMutex;
    std::lock_guard<std::mutex> lock(initMutex);
 
    if (m_impl->ready) {
        // Gaudi is a process singleton; a second initialize() with a
        // different device id cannot be honored.
        if (config.deviceId != m_impl->config.deviceId) {
            throw std::runtime_error(
                "TracccTritonInitializer: already initialized on device " +
                std::to_string(m_impl->config.deviceId) +
                ", cannot re-initialize on device " +
                std::to_string(config.deviceId) +
                ". Pin the model to a single GPU in instance_group.");
        }
        if (config.nSlots != m_impl->config.nSlots) {
            throw std::runtime_error(
                "TracccTritonInitializer: already initialized with " +
                std::to_string(m_impl->config.nSlots) +
                " event slots, cannot re-initialize with " +
                std::to_string(config.nSlots));
        }
        return;
    }
 
    m_impl->config = config;
 
    promoteSelfToGlobal();
 
    // Fills in the StoreGate keys on m_impl->config from the python configuration
    m_impl->bootstrapPython();
 
    // Fetch the ApplicationMgr
    m_impl->app = Gaudi::createApplicationMgr();
    if (!m_impl->app) {
        throw std::runtime_error(
            "TracccTritonInitializer: Gaudi::createApplicationMgr() "
            "returned null after the Python bootstrap");
    }
    // bootstrap() takes the application all the way to RUNNING
    if (m_impl->app->FSMState() != Gaudi::StateMachine::RUNNING) {
        throw std::runtime_error(
            "TracccTritonInitializer: application manager is not "
            "RUNNING after the Python bootstrap (FSM state " +
            std::to_string(static_cast<int>(m_impl->app->FSMState())) + ")");
    }
 
    m_impl->svcLocator = SmartIF<ISvcLocator>(m_impl->app);
    if (!m_impl->svcLocator) {
        throw std::runtime_error(
            "TracccTritonInitializer: could not obtain ISvcLocator");
    }
 
    // Sanity-check that the device chain the Runner will execute exists.
    m_impl->algorithm(m_impl->config.sequenceName);
 
    m_impl->ready = true;
}

instance()

TracccTritonInitializer & triton::backend::traccc::TracccTritonInitializer::instance ( )

static

Get the process-wide singleton.

Definition at line 184 of file TracccTritonInitializer.cxx.

                                                           {
    // The singleton is mutable, but every method that touches its state
    // serialises on its own mutex, so sharing it between Triton's worker
    // threads is safe.
    static TracccTritonInitializer theInstance ATLAS_THREAD_SAFE;
    return theInstance;
}

isReady()

bool triton::backend::traccc::TracccTritonInitializer::isReady

(

)

const

Whether initialize has completed successfully.

Definition at line 267 of file TracccTritonInitializer.cxx.

                                            {
    return m_impl->ready;
}

operator=()

TracccTritonInitializer & triton::backend::traccc::TracccTritonInitializer::operator= ( const TracccTritonInitializer & )

delete

serviceLocator()

ISvcLocator & triton::backend::traccc::TracccTritonInitializer::serviceLocator

(

)

const

The service locator of the embedded Athena application (never null once ready).

Used by TracccTritonRunner to look up the device chain.

Definition at line 296 of file TracccTritonInitializer.cxx.

                                                           {
    if (!m_impl->svcLocator) {
        throw std::runtime_error(
            "TracccTritonInitializer::serviceLocator: not initialized");
    }
    return *m_impl->svcLocator;
}

Member Data Documentation

m_impl

std::unique_ptr<Impl> triton::backend::traccc::TracccTritonInitializer::m_impl

private

Definition at line 99 of file TracccTritonInitializer.h.

---

The documentation for this class was generated from the following files:

• TracccTritonInitializer.h
• TracccTritonInitializer.cxx