Embedded Multicore Building Blocks V1.0.0
execution_policy.h
1 /*
2  * Copyright (c) 2014-2017, Siemens AG. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * 1. Redistributions of source code must retain the above copyright notice,
8  * this list of conditions and the following disclaimer.
9  *
10  * 2. Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
18  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24  * POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef EMBB_MTAPI_EXECUTION_POLICY_H_
28 #define EMBB_MTAPI_EXECUTION_POLICY_H_
29 
30 #include <embb/mtapi/c/mtapi.h>
31 #include <embb/mtapi/internal/cmake_config.h>
32 
33 namespace embb {
34 namespace mtapi {
35 
49  public:
57 
63  bool initial_affinity,
66  mtapi_uint_t priority
68  );
69 
75  explicit ExecutionPolicy(
76  mtapi_uint_t priority
78  );
79 
85  explicit ExecutionPolicy(
86  bool initial_affinity
89  );
90 
95  void AddWorker(
96  mtapi_uint_t worker
97  );
98 
103  void RemoveWorker(
104  mtapi_uint_t worker
105  );
106 
113  bool IsSetWorker(
114  mtapi_uint_t worker
115  );
116 
123  unsigned int GetCoreCount() const;
124 
132 
138  mtapi_uint_t GetPriority() const;
139 
140  friend class Task;
141 
142  private:
147  static const mtapi_uint_t DefaultPriority;
148 
153  mtapi_affinity_t affinity_;
154 
158  mtapi_uint_t priority_;
159 };
160 
161 } // namespace mtapi
162 } // namespace embb
163 
164 #endif // EMBB_MTAPI_EXECUTION_POLICY_H_
Definition: lock_free_mpmc_queue.h:40
mtapi_uint64_t mtapi_affinity_t
Core affinity type.
Definition: mtapi.h:350
mtapi_uint_t GetPriority() const
Returns the priority.
void RemoveWorker(mtapi_uint_t worker)
Removes affinity to a specific worker thread.
ExecutionPolicy()
Constructs the default execution policy.
unsigned int GetCoreCount() const
Returns the number of cores the policy is affine to.
Describes the execution policy of a parallel algorithm.
Definition: execution_policy.h:48
void AddWorker(mtapi_uint_t worker)
Sets affinity to a specific worker thread.
mtapi_affinity_t GetAffinity() const
Returns the affinity.
bool IsSetWorker(mtapi_uint_t worker)
Checks if affinity to a specific worker thread is set.
A Task represents a running Action of a specific Job.
Definition: task.h:41