From 6ff3b19ee6120edf015fad8caab2991faa3070af Mon Sep 17 00:00:00 2001 From: Anthony Barbier Date: Mon, 4 Sep 2017 18:44:23 +0100 Subject: COMPMID-344 Updated doxygen Change-Id: I32f7b84daa560e460b77216add529c8fa8b327ae --- arm_compute/runtime/OMP/OMPScheduler.h | 68 ++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 arm_compute/runtime/OMP/OMPScheduler.h (limited to 'arm_compute/runtime/OMP/OMPScheduler.h') diff --git a/arm_compute/runtime/OMP/OMPScheduler.h b/arm_compute/runtime/OMP/OMPScheduler.h new file mode 100644 index 0000000000..21df6a699d --- /dev/null +++ b/arm_compute/runtime/OMP/OMPScheduler.h @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2017 ARM Limited. + * + * SPDX-License-Identifier: MIT + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to + * deal in the Software without restriction, including without limitation the + * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + * sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +#ifndef __ARM_COMPUTE_OMPSCHEDULER_H__ +#define __ARM_COMPUTE_OMPSCHEDULER_H__ + +#include "arm_compute/runtime/IScheduler.h" + +namespace arm_compute +{ +/** Pool of threads to automatically split a kernel's execution among several threads. */ +class OMPScheduler : public IScheduler +{ +public: + /** Sets the number of threads the scheduler will use to run the kernels. + * + * @param[in] num_threads If set to 0, then the number returned by omp_get_max_threads() will be used, otherwise the number of threads specified. + */ + void set_num_threads(unsigned int num_threads) override; + /** Returns the number of threads that the OMPScheduler has in its pool. + * + * @return Number of threads available in OMPScheduler. + */ + unsigned int num_threads() const override; + /** Access the scheduler singleton + * + * @return The scheduler + */ + static OMPScheduler &get(); + /** Multithread the execution of the passed kernel if possible. + * + * The kernel will run on a single thread if any of these conditions is true: + * - ICPPKernel::is_parallelisable() returns false + * - The scheduler has been initialized with only one thread. + * + * @param[in] kernel Kernel to execute. + * @param[in] split_dimension Dimension along which to split the kernel's execution window. + */ + void schedule(ICPPKernel *kernel, unsigned int split_dimension) override; + +private: + /** Constructor. */ + OMPScheduler(); + + unsigned int _num_threads; +}; +} +#endif /* __ARM_COMPUTE_OMPSCHEDULER_H__ */ -- cgit v1.2.1