#include <ExecutorBase.h>

Collaboration diagram for onert::exec::ExecutorBase:

[legend]

Public Member Functions
	ExecutorBase (std::unique_ptr< compiler::LoweredGraph > &&lowered_graph, backend::BackendContexts &&backend_contexts, const compiler::TensorRegistries &tensor_regs, const util::TracingCtx *tracing_ctx)
	Construct a new ExecutorBase object.

virtual	~ExecutorBase ()=default

const ir::Graph &	graph () const final
	Returns graph object.

void	execute (const std::vector< backend::IPortableTensor * > &inputs, const std::vector< backend::IPortableTensor * > &outputs, const ExecutionOptions &options) override
	Execute with given input/output tensors.

uint32_t	inputSize () const override
	Get input size.

uint32_t	outputSize () const override
	Get output size.

const ir::OperandInfo &	inputInfo (uint32_t index) const override
	Get input info at index.

const ir::OperandInfo &	outputInfo (uint32_t index) const override
	Get output info at index.

ir::Layout	inputLayout (uint32_t index) const override
	Get input layout at index.

ir::Layout	outputLayout (uint32_t index) const override
	Get output layout at index.

void	setIndexedRanks (std::shared_ptr< ir::OperationIndexMap< int64_t > > ranks) final
	Set an ordering on operations.

virtual void	executeImpl (const ExecutionObservee &subject)=0

void	addObserver (std::unique_ptr< IExecutionObserver > ref)

backend::BackendContexts &	getBackendContexts ()

const ExecutionOptions &	currentOptions () const override
	Return current execution configuration.

Public Member Functions inherited from onert::exec::IExecutor
	IExecutor ()=default
	Construct a new IExecutor object.

virtual	~IExecutor ()=default
	Destroy the IExecutor object.

Protected Member Functions
bool	hasDynamicInput ()
	Returns `true` if any input tensor is dynamic; `false` if all are static tensors.

Protected Attributes
ExecObservers	_observers

std::shared_ptr< ir::OperationIndexMap< int64_t > >	_indexed_ranks

std::unique_ptr< compiler::LoweredGraph >	_lowered_graph

backend::BackendContexts	_backend_contexts

const ir::Graph &	_graph

std::vector< backend::builtin::IOTensor * >	_input_tensors

std::vector< backend::builtin::IOTensor * >	_output_tensors

std::mutex	_mutex

const util::TracingCtx *	_tracing_ctx

ExecutionOptions	_current_options

Detailed Description

Definition at line 40 of file ExecutorBase.h.

Constructor & Destructor Documentation

◆ ExecutorBase()

onert::exec::ExecutorBase::ExecutorBase	(	std::unique_ptr< compiler::LoweredGraph > &&	lowered_graph,
		backend::BackendContexts &&	backend_contexts,
		const compiler::TensorRegistries &	tensor_regs,
		const util::TracingCtx *	tracing_ctx
	)

Construct a new ExecutorBase object.

Parameters

graph	Graph object
tensor_builders	Tensor builders that are currently used

Definition at line 27 of file ExecutorBase.cc.

  : _lowered_graph{std::move(lowered_graph)}, _backend_contexts{std::move(backend_contexts)},
    _graph{_lowered_graph->graph()}, _mutex(), _tracing_ctx(tracing_ctx)
{
  auto build_tensor_list = [&](const auto &ind_seq, auto &tensors) {
    assert(tensors.empty());
    for (auto &&ind : ind_seq)
    {
      backend::ITensor *tensor = tensor_regs.getITensor(ind);
      assert(tensor != nullptr);
      auto io_tensor = nnfw::misc::polymorphic_downcast<backend::builtin::IOTensor *>(tensor);
      tensors.push_back(io_tensor);
    }
  };
  build_tensor_list(_graph.getInputs(), _input_tensors);
  build_tensor_list(_graph.getOutputs(), _output_tensors);
}

References _graph, _input_tensors, _output_tensors, onert::ir::Graph::getInputs(), onert::compiler::TensorRegistries::getITensor(), and onert::ir::Graph::getOutputs().

◆ ~ExecutorBase()

virtual onert::exec::ExecutorBase::~ExecutorBase ( )

virtualdefault

Member Function Documentation

◆ addObserver()

void onert::exec::ExecutorBase::addObserver ( std::unique_ptr< IExecutionObserver > ref )

inline

Definition at line 89 of file ExecutorBase.h.

89{ _observers.add(std::move(ref)); };

onert::exec::ExecObservers::add

void add(std::unique_ptr< IExecutionObserver > &&observer)

Definition ExecutionObservers.h:65

onert::exec::ExecutorBase::_observers

ExecObservers _observers

Definition ExecutorBase.h:102

References _observers, and onert::exec::ExecObservers::add().

◆ currentOptions()

const ExecutionOptions & onert::exec::ExecutorBase::currentOptions ( ) const

inlineoverridevirtual

Return current execution configuration.

Returns: Current execution configuration

Implements onert::exec::IExecutor.

Definition at line 93 of file ExecutorBase.h.

93{ return _current_options; }

onert::exec::ExecutorBase::_current_options

ExecutionOptions _current_options

Definition ExecutorBase.h:118

References _current_options.

◆ execute()

void onert::exec::ExecutorBase::execute	(	const std::vector< backend::IPortableTensor * > &	inputs,
		const std::vector< backend::IPortableTensor * > &	outputs,
		const ExecutionOptions &	options
	)

overridevirtual

Execute with given input/output tensors.

Input and output tensors must be given.

Parameters

[in]	inputs	Tensors that are passed as inputs
[in]	outputs	Tensors that are passed as outputs
[in]	options	Execution options

Implements onert::exec::IExecutor.

Definition at line 48 of file ExecutorBase.cc.

{
  // For thread-safe, use mutex
  // TODO: if all used backends on this executor are thread-safe,
  //       do not need to use mutex (otherwise, use mutex)
  // Deadlock occurs when an Executor is called recursively.
  std::lock_guard<std::mutex> lock(_mutex);
  _current_options = options;
 
  assert(inputs.size() == _graph.getInputs().size());
  assert(inputs.size() == _input_tensors.size());
  for (uint32_t n = 0; n < inputs.size(); ++n)
  {
    const auto input = inputs[n];
    assert(input->buffer() != nullptr || input->get_info().total_size() == 0);
    auto input_tensor = _input_tensors[n];
    assert(input_tensor != nullptr);
    input_tensor->setTensor(input);
  }
 
  assert(outputs.size() == _graph.getOutputs().size());
  assert(outputs.size() == _output_tensors.size());
  for (uint32_t n = 0; n < outputs.size(); ++n)
  {
    const auto output = outputs[n];
    assert(output->buffer() != nullptr || output->get_info().total_size() == 0);
    auto output_tensor = _output_tensors[n];
    assert(output_tensor != nullptr);
    output_tensor->setTensor(output);
  }
 
  // Create observee
  ExecutionObservee subject(_observers, options);
 
  executeImpl(subject);
}

References _current_options, _graph, _input_tensors, _mutex, _observers, _output_tensors, executeImpl(), onert::ir::Graph::getInputs(), onert::ir::Graph::getOutputs(), and onert::ir::OperandIndexSequence::size().

◆ executeImpl()

virtual void onert::exec::ExecutorBase::executeImpl ( const ExecutionObservee & subject )

pure virtual

Implemented in onert::exec::DataflowExecutor, onert::exec::LinearExecutor, and onert::exec::ParallelExecutor.

Referenced by execute().

◆ getBackendContexts()

backend::BackendContexts & onert::exec::ExecutorBase::getBackendContexts ( )

inline

Definition at line 91 of file ExecutorBase.h.

91{ return _backend_contexts; }

References _backend_contexts.

◆ graph()

const ir::Graph & onert::exec::ExecutorBase::graph ( ) const

inlinefinalvirtual

Returns graph object.

Returns: Graph object

Implements onert::exec::IExecutor.

Definition at line 54 of file ExecutorBase.h.

54{ return _graph; }

References _graph.

Referenced by TopologicalSortHelper.TopologicalSortHelper::add_edge(), and TopologicalSortHelper.TopologicalSortHelper::sort_util().

◆ hasDynamicInput()

bool onert::exec::ExecutorBase::hasDynamicInput ( )

protected

Returns true if any input tensor is dynamic; false if all are static tensors.

Definition at line 87 of file ExecutorBase.cc.

{
  for (auto &&tensor : _input_tensors)
  {
    if (tensor->is_dynamic())
      return true;
  }
  return false;
}

References _input_tensors.

Referenced by onert::exec::DataflowExecutor::executeImpl(), onert::exec::LinearExecutor::executeImpl(), and onert::exec::ParallelExecutor::executeImpl().

◆ inputInfo()

const ir::OperandInfo & onert::exec::ExecutorBase::inputInfo ( uint32_t index ) const

inlineoverridevirtual

Get input info at index.

Parameters

[in] index Index of input

Returns: Input operand info

Implements onert::exec::IExecutor.

Definition at line 64 of file ExecutorBase.h.

  {
    return _input_tensors[index]->get_info();
  }

References _input_tensors.

◆ inputLayout()

ir::Layout onert::exec::ExecutorBase::inputLayout ( uint32_t index ) const

inlineoverridevirtual

Get input layout at index.

Parameters

[in] index Index of input

Returns: Input operand layout

Implements onert::exec::IExecutor.

Definition at line 74 of file ExecutorBase.h.

74{ return _input_tensors[index]->layout(); }

References _input_tensors.

◆ inputSize()

uint32_t onert::exec::ExecutorBase::inputSize ( ) const

inlineoverridevirtual

Get input size.

Returns: Input size

Implements onert::exec::IExecutor.

Definition at line 60 of file ExecutorBase.h.

60{ return _input_tensors.size(); }

References _input_tensors.

◆ outputInfo()

const ir::OperandInfo & onert::exec::ExecutorBase::outputInfo ( uint32_t index ) const

inlineoverridevirtual

Get output info at index.

Parameters

[in] index Index of output

Returns: Output operand info

Implements onert::exec::IExecutor.

Definition at line 69 of file ExecutorBase.h.

  {
    return _output_tensors[index]->get_info();
  }

References _output_tensors.

◆ outputLayout()

ir::Layout onert::exec::ExecutorBase::outputLayout ( uint32_t index ) const

inlineoverridevirtual

Get output layout at index.

Parameters

[in] index Index of output

Returns: Output operand layout

Implements onert::exec::IExecutor.

Definition at line 76 of file ExecutorBase.h.

  {
    return _output_tensors[index]->layout();
  }

References _output_tensors.

◆ outputSize()

uint32_t onert::exec::ExecutorBase::outputSize ( ) const

inlineoverridevirtual

Get output size.

Returns: Output size

Implements onert::exec::IExecutor.

Definition at line 62 of file ExecutorBase.h.

62{ return _output_tensors.size(); }

References _output_tensors.

◆ setIndexedRanks()

void onert::exec::ExecutorBase::setIndexedRanks ( std::shared_ptr< ir::OperationIndexMap< int64_t > > )

inlinefinalvirtual

Set an ordering on operations.

Parameters

[in] ranks The table encoding the ordering

Implements onert::exec::IExecutor.

Definition at line 82 of file ExecutorBase.h.

  {
    _indexed_ranks = std::move(ranks);
  };

References _indexed_ranks.

Field Documentation

◆ _backend_contexts

backend::BackendContexts onert::exec::ExecutorBase::_backend_contexts

protected

Definition at line 105 of file ExecutorBase.h.

Referenced by getBackendContexts().

◆ _current_options

ExecutionOptions onert::exec::ExecutorBase::_current_options

protected

It is set by execute() method only in thread-safe environment. It is used for non-primary executor call on builtin backend and accessed by entryExecutor's currentOptions() method.

TODO: Find better way to pass config to non-primary executor

Definition at line 118 of file ExecutorBase.h.

Referenced by currentOptions(), and execute().

◆ _graph

const ir::Graph& onert::exec::ExecutorBase::_graph

protected

Definition at line 106 of file ExecutorBase.h.

Referenced by onert::exec::DataflowExecutor::calculateRank(), execute(), onert::exec::DataflowExecutor::executeImpl(), onert::exec::LinearExecutor::executeImpl(), onert::exec::ParallelExecutor::executeImpl(), ExecutorBase(), and graph().

◆ _indexed_ranks

std::shared_ptr<ir::OperationIndexMap<int64_t> > onert::exec::ExecutorBase::_indexed_ranks

protected

Definition at line 103 of file ExecutorBase.h.

Referenced by onert::exec::DataflowExecutor::calculateRank(), and setIndexedRanks().

◆ _input_tensors

std::vector<backend::builtin::IOTensor *> onert::exec::ExecutorBase::_input_tensors

protected

Definition at line 107 of file ExecutorBase.h.

Referenced by execute(), ExecutorBase(), hasDynamicInput(), inputInfo(), inputLayout(), and inputSize().

◆ _lowered_graph

std::unique_ptr<compiler::LoweredGraph> onert::exec::ExecutorBase::_lowered_graph

protected

Definition at line 104 of file ExecutorBase.h.

Referenced by onert::exec::DataflowExecutor::DataflowExecutor(), onert::exec::DataflowExecutor::executeImpl(), onert::exec::LinearExecutor::executeImpl(), and onert::exec::ParallelExecutor::executeImpl().

◆ _mutex

std::mutex onert::exec::ExecutorBase::_mutex

protected

Definition at line 109 of file ExecutorBase.h.

Referenced by execute().

◆ _observers

ExecObservers onert::exec::ExecutorBase::_observers

protected

Definition at line 102 of file ExecutorBase.h.

Referenced by addObserver(), and execute().

◆ _output_tensors

std::vector<backend::builtin::IOTensor *> onert::exec::ExecutorBase::_output_tensors

protected

Definition at line 108 of file ExecutorBase.h.

Referenced by execute(), ExecutorBase(), outputInfo(), outputLayout(), and outputSize().

◆ _tracing_ctx

const util::TracingCtx* onert::exec::ExecutorBase::_tracing_ctx

protected

Definition at line 110 of file ExecutorBase.h.

Referenced by onert::exec::DataflowExecutor::executeImpl(), onert::exec::LinearExecutor::executeImpl(), and onert::exec::ParallelExecutor::executeImpl().

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

runtime/onert/core/src/exec/ExecutorBase.h
runtime/onert/core/src/exec/ExecutorBase.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExecutorBase()

◆ ~ExecutorBase()

Member Function Documentation

◆ addObserver()

◆ currentOptions()

◆ execute()

◆ executeImpl()

◆ getBackendContexts()

◆ graph()

◆ hasDynamicInput()

◆ inputInfo()

◆ inputLayout()

◆ inputSize()

◆ outputInfo()

◆ outputLayout()

◆ outputSize()

◆ setIndexedRanks()

Field Documentation

◆ _backend_contexts

◆ _current_options

◆ _graph

◆ _indexed_ranks

◆ _input_tensors

◆ _lowered_graph

◆ _mutex

◆ _observers

◆ _output_tensors

◆ _tracing_ctx