BaseCmd

Fully qualified name: cupva::BaseCmd

Defined in cupva_host.hpp

class BaseCmd : public cupva::StaticStorage<impl::BaseCmd, priv::CUPVA_BASE_CMD_SIZE, priv::CUPVA_BASE_CMD_ALIGN>

BaseCmd is the abstraction of the command passed to hardware.

Multiple classes are inherited from the BaseCmd class: CmdProgram, CmdRequestFences, CmdWaitOnFences, Barrier. Although BaseCmd destructor is not virtual, it is safe to call the destructor using pointers to BaseCmd base class. The internal implementation will automatically call destructor of the implementation matching the initially constructed command object.

• Maturity: GA

Subclassed by cupva::CmdBarrier, cupva::CmdL2Ops, cupva::CmdMemcpy, cupva::CmdPFSD, cupva::CmdProgram, cupva::CmdRequestFences, cupva::CmdWaitOnFences

Public Functions

BaseCmd() noexcept

Construct empty BaseCmd instance.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: No

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: Yes

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Pre:

None

BaseCmd(BaseCmd &&obj) noexcept

Move constructor.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: No

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: Yes

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Pre:

None

~BaseCmd() noexcept

Destroy BaseCmd object.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: No

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: No

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Pre:

None

void finalize()

Destroy the resources created by a BaseCmd object.

This method is exposed to allow fine-grained control over error handling.

During destruction of the object, this method will be called but the destructor must not propagate exceptions. To handle exceptions, manually invoke this method prior to object destruction.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: No

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: No

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Throws:

• cupva::Exception(DriverAPIError) – if driver returns error during de-initialization of mapped/pinned memory

• cupva::Exception(NotAllowedInOperationalState) – if called when NVIDIA DRIVE OS VM state is “Operational”

Pre:

None

BaseCmd &operator=(BaseCmd &&obj) & noexcept

Move assignment.

Usage considerations

• Allowed context for the API call

  • Interrupt handler: No

  • Signal handler: No

  • Thread-safe: No

  • Re-entrant: No

  • Async/Sync: Sync

• Required privileges: None

• Allowed execution state

  • Initialization: Yes

  • Operational: Yes

  • Reinit/Deinit Preparation: Yes

• Maturity: GA

Pre:

None