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     enum class Type
  37     {
  38         ST,    // Single thread.
  39         CPP,   // C++11 threads.
  40         OMP,   // OpenMP.
  41         CUSTOM // Provided by the user.
  42     };
  43     /** Sets the user defined scheduler and makes it the active scheduler.
  44      *
  45      * @param[in] scheduler A shared pointer to a custom scheduler implemented by the user.
  46      */
  47     static void set(std::shared_ptr<IScheduler> scheduler);
  48     /** Access the scheduler singleton.
  49      *
  50      * @return A reference to the scheduler object.
  51      */
  52     static IScheduler &get();
  53     /** Set the active scheduler.
  54      *
  55      * Only one scheduler can be enabled at any time.
  56      *
  57      * @param[in] t the type of the scheduler to be enabled.
  58      */
  59     static void set(Type t);
  60     /** Returns the type of the active scheduler.
  61      *
  62      * @return The current scheduler's type.
  63      */
  64     static Type get_type();
  65     /** Returns true if the given scheduler type is supported. False otherwise.
  66      *
  67      * @return true if the given scheduler type is supported. False otherwise.
  68      */
  69     static bool is_available(Type t);
  70
  71 private:
  72     static Type                        _scheduler_type;
  73     static std::shared_ptr<IScheduler> _custom_scheduler;
  74     Scheduler();
  75 };
  76 }
  77 #endif /* __ARM_COMPUTE_SCHEDULER_H__ */