Scheduler Class Reference

Configurable scheduler which supports multiple multithreading APIs and choosing between different schedulers at runtime. More...

#include <Scheduler.h>

Public Types
enum	Type { ST, CPP, OMP, CUSTOM }
	Scheduler type. More...

Static Public Member Functions
static void	set (std::shared_ptr< IScheduler > scheduler)
	Sets the user defined scheduler and makes it the active scheduler. More...
static IScheduler &	get ()
	Access the scheduler singleton. More...
static void	set (Type t)
	Set the active scheduler. More...
static Type	get_type ()
	Returns the type of the active scheduler. More...
static bool	is_available (Type t)
	Returns true if the given scheduler type is supported. More...

Detailed Description

Configurable scheduler which supports multiple multithreading APIs and choosing between different schedulers at runtime.

Definition at line 35 of file Scheduler.h.

Member Enumeration Documentation

Type

enum Type

strong

Scheduler type.

Enumerator
ST	Single thread.
CPP	C++11 threads.
OMP	OpenMP.
CUSTOM	Provided by the user.

Definition at line 39 of file Scheduler.h.

    {
        ST,    /**< Single thread. */
        CPP,   /**< C++11 threads. */
        OMP,   /**< OpenMP. */
        CUSTOM /**< Provided by the user. */
    };

Member Function Documentation

get()

IScheduler & get ( )

static

Access the scheduler singleton.

Returns

A reference to the scheduler object.

Definition at line 94 of file Scheduler.cpp.

{
    if(_scheduler_type == Type::CUSTOM)
    {
        if(_custom_scheduler == nullptr)
        {
            ARM_COMPUTE_ERROR("No custom scheduler has been setup. Call set(std::shared_ptr<IScheduler> &scheduler) before Scheduler::get()");
        }
        else
        {
            return *_custom_scheduler;
        }
    }
    else
    {
        if(_schedulers.empty())
        {
            _schedulers = init();
        }
 
        auto it = _schedulers.find(_scheduler_type);
        if(it != _schedulers.end())
        {
            return *it->second;
        }
        else
        {
            ARM_COMPUTE_ERROR("Invalid Scheduler type");
        }
    }
}

References ARM_COMPUTE_ERROR, and Scheduler::CUSTOM.

Referenced by CpuDepthwiseConv2dAssemblyDispatch::configure(), CpuPool2d::configure(), CpuWinogradConv2d::configure(), CpuConv2d::get_convolution_method(), CpuGemmAssemblyDispatch::has_opt_impl(), main(), CpuFullyConnected::prepare(), CpuGemmLowpMatrixMultiplyCore::prepare(), CpuGemmConv2d::prepare(), NEQLSTMLayer::prepare(), ICPPSimpleFunction::run(), CpuDequantize::run(), CpuQuantize::run(), CpuConvertFullyConnectedWeights::run(), INESimpleFunction::run(), CpuActivation::run(), CpuAddMulAdd::run(), CpuScale::run(), NEFillBorder::run(), CpuPool3d::run(), CpuSub::run(), CpuConcatenate::run(), CpuAdd::run(), CpuPool2d::run(), CpuDepthwiseConv2dAssemblyDispatch::run(), CpuMul::run(), NEROIPoolingLayer::run(), CpuMatMul::run(), CpuSoftmaxGeneric< IS_LOG >::run(), NESpaceToDepthLayer::run(), NELogicalAnd::run(), CpuGemmLowpOutputStage::run(), CPPBoxWithNonMaximaSuppressionLimit::run(), CpuDirectConv2d::run(), CpuDirectConv3d::run(), CpuWinogradConv2d::run(), NEStackLayer::run(), NEFFT1D::run(), NEL2NormalizeLayer::run(), NERange::run(), NENormalizationLayer::run(), NEReductionOperation::run(), NEInstanceNormalizationLayer::run(), NEPadLayer::run(), NECropResize::run(), CpuComplexMul::run(), NEFuseBatchNormalization::run(), NEBatchNormalizationLayer::run(), NESpaceToBatchLayer::run(), CpuGemm::run(), NEGenerateProposalsLayer::run(), CpuGemmLowpMatrixMultiplyCore::run(), NESynthetizeFunctionWithZeroConstantKernelBorder< K >::run(), NELogicalOr::run(), CpuGemmConv2d::run(), NELogicalNot::run(), NEQLSTMLayer::run(), arm_compute::utils::schedule_kernel_on_ctx(), CpuQueue::scheduler(), NEDeviceBackend::setup_backend_context(), and SchedulerClock< output_timestamps >::test_start().

get_type()

Scheduler::Type get_type ( )

static

Returns the type of the active scheduler.

Returns

The current scheduler's type.

Definition at line 89 of file Scheduler.cpp.

{
    return _scheduler_type;
}

Referenced by SchedulerClock< output_timestamps >::test_start().

is_available()

bool is_available ( Type  t )

static

Returns true if the given scheduler type is supported.

False otherwise.

Parameters

[in]

t

the type of the scheduler to check.

Returns

true if the given scheduler type is supported. False otherwise.

Definition at line 77 of file Scheduler.cpp.

{
    if(t == Type::CUSTOM)
    {
        return _custom_scheduler != nullptr;
    }
    else
    {
        return _schedulers.find(t) != _schedulers.end();
    }
}

References Scheduler::CUSTOM, and tf_frozen_model_extractor::t.

Referenced by Scheduler::set().

set() [1/2]

void set ( std::shared_ptr< IScheduler >  scheduler )

static

Sets the user defined scheduler and makes it the active scheduler.

Parameters

[in]

scheduler

A shared pointer to a custom scheduler implemented by the user.

Definition at line 126 of file Scheduler.cpp.

{
    _custom_scheduler = std::move(scheduler);
    set(Type::CUSTOM);
}

References Scheduler::CUSTOM.

Referenced by SchedulerClock< output_timestamps >::test_start(), and SchedulerClock< output_timestamps >::test_stop().

set() [2/2]

void set ( Type  t )

static

Set the active scheduler.

Only one scheduler can be enabled at any time.

Parameters

[in]

t

the type of the scheduler to be enabled.

Definition at line 71 of file Scheduler.cpp.

{
    ARM_COMPUTE_ERROR_ON(!Scheduler::is_available(t));
    _scheduler_type = t;
}

References ARM_COMPUTE_ERROR_ON, Scheduler::is_available(), and tf_frozen_model_extractor::t.

---

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

• arm_compute/runtime/Scheduler.h
• src/runtime/Scheduler.cpp