arm_compute/runtime/SingleThreadScheduler.h

   1 /*
   2  * Copyright (c) 2017 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_SINGLETHREADSCHEDULER_H__
  25 #define __ARM_COMPUTE_SINGLETHREADSCHEDULER_H__
  26
  27 #include "arm_compute/runtime/IScheduler.h"
  28
  29 namespace arm_compute
  30 {
  31 /** Pool of threads to automatically split a kernel's execution among several threads. */
  32 class SingleThreadScheduler : public IScheduler
  33 {
  34 public:
  35     /** Sets the number of threads the scheduler will use to run the kernels.
  36      *
  37      * @param[in] num_threads This is ignored for this scheduler as the number of threads is always one.
  38      */
  39     void set_num_threads(unsigned int num_threads) override;
  40     /** Returns the number of threads that the SingleThreadScheduler has, which is always 1.
  41      *
  42      * @return Number of threads available in SingleThreadScheduler.
  43      */
  44     unsigned int num_threads() const override;
  45     /** Access the scheduler singleton
  46      *
  47      * @return The scheduler
  48      */
  49     static SingleThreadScheduler &get();
  50     /** Runs the kernel in the same thread as the caller synchronously.
  51      *
  52      * @param[in] kernel          Kernel to execute.
  53      * @param[in] split_dimension Dimension along which to split the kernel's execution window.
  54      */
  55     void schedule(ICPPKernel *kernel, unsigned int split_dimension) override;
  56
  57 private:
  58     /** Constructor. */
  59     SingleThreadScheduler() = default;
  60 };
  61 }
  62 #endif /* __ARM_COMPUTE_SINGLETHREADSCHEDULER_H__ */