arm_compute/runtime/Scheduler.h

   1 /*
   2  * Copyright (c) 2017-2018 ARM Limited.
   3  *
   4  * SPDX-License-Identifier: MIT
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to
   8  * deal in the Software without restriction, including without limitation the
   9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  10  * sell copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all
  14  * copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24 #ifndef __ARM_COMPUTE_SCHEDULER_H__
  25 #define __ARM_COMPUTE_SCHEDULER_H__
  26
  27 #include "arm_compute/runtime/IScheduler.h"
  28 #include <memory>
  29
  30 namespace arm_compute
  31 {
  32 /** Configurable scheduler which supports multiple multithreading APIs and choosing between different schedulers at runtime. */
  33 class Scheduler
  34 {
  35 public:
  36     /** Scheduler type */
  37     enum class Type
  38     {
  39         ST,    /**< Single thread. */
  40         CPP,   /**< C++11 threads. */
  41         OMP,   /**< OpenMP. */
  42         CUSTOM /**< Provided by the user. */
  43     };
  44     /** Sets the user defined scheduler and makes it the active scheduler.
  45      *
  46      * @param[in] scheduler A shared pointer to a custom scheduler implemented by the user.
  47      */
  48     static void set(std::shared_ptr<IScheduler> scheduler);
  49     /** Access the scheduler singleton.
  50      *
  51      * @return A reference to the scheduler object.
  52      */
  53     static IScheduler &get();
  54     /** Set the active scheduler.
  55      *
  56      * Only one scheduler can be enabled at any time.
  57      *
  58      * @param[in] t the type of the scheduler to be enabled.
  59      */
  60     static void set(Type t);
  61     /** Returns the type of the active scheduler.
  62      *
  63      * @return The current scheduler's type.
  64      */
  65     static Type get_type();
  66     /** Returns true if the given scheduler type is supported. False otherwise.
  67      *
  68      * @param[in] t the type of the scheduler to check.
  69      *
  70      * @return true if the given scheduler type is supported. False otherwise.
  71      */
  72     static bool is_available(Type t);
  73
  74 private:
  75     static Type                        _scheduler_type;
  76     static std::shared_ptr<IScheduler> _custom_scheduler;
  77     Scheduler();
  78 };
  79 }
  80 #endif /* __ARM_COMPUTE_SCHEDULER_H__ */