summaryrefslogtreecommitdiff
path: root/runtimes/neurun/core/src/exec/ParallelScheduler.h
blob: 9660478e876024602e1c6d4fc0c8d6e196bb84f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
 * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef __NEURUN_EXEC_PARALLEL_SCHEDULER_H__
#define __NEURUN_EXEC_PARALLEL_SCHEDULER_H__

#include <unordered_map>
#include <thread>
#include <mutex>
#include <condition_variable>
#include <memory>
#include <queue>
#include <vector>
#include <unordered_set>

#include "exec/IFunction.h"
#include "graph/BackendSet.h"

namespace neurun
{
namespace exec
{

// TODO Extract this class to a separate file
class WorkQueue
{
public:
  enum class State
  {
    ONLINE,
    FINISHING,
    FORCE_FINISHING
  };

public:
  /**
   * @brief Create WorkQueue object
   */
  WorkQueue() = default;
  /**
   * @brief Destroy WorkQueue object
   */
  ~WorkQueue();
  /**
   * @brief Thread entry function
   */
  void operator()();
  /**
   * @brief Push the given Task to the job queue
   *
   * @param fn Function to be executed(a job)
   */
  void enqueue(std::unique_ptr<IFunction> &&fn);
  /**
   * @brief Flag as terminating so all the worker threads can terminate
   */
  void terminate();
  /**
   * @brief Flag as terminating so all the worker threads can terminate
   */
  void finish();
  /**
   * @brief Check if it has pending jobs. Even if this returns fals, WorkQueue threads may be still
   * running
   *
   * @return true if the job queue not empty otherwise false
   */
  uint32_t numJobsInQueue();

private:
  State _state{State::ONLINE};
  std::queue<std::unique_ptr<IFunction>> _functions;
  std::mutex _mu;
  std::condition_variable _cv;
};

// TODO Extract this class to a separate file
class ThreadPool
{
public:
  /**
   * @brief Coustruct ThreadPool object
   *
   * @param num_threads Number of threads
   */
  ThreadPool(uint32_t num_threads = 1);
  /**
   * @brief Destroy ThreadPool object
   */
  ~ThreadPool();
  /**
   * @brief Enqueue a function
   *
   * @param fn A function to be queued
   */
  void enqueue(std::unique_ptr<IFunction> &&fn);
  /**
   * @brief Get number of jobs in worker's queue
   *
   * @return Number of jobs
   */
  uint32_t numJobsInQueue();

  /**
   * @brief Block until all jobs are finished
   */
  void finish();

private:
  void join();

private:
  WorkQueue _worker;
  std::vector<std::thread> _threads;
};

class ParallelScheduler
{
public:
  /**
   * @brief Constructs ParallelScheduler object
   *
   * @param backends Backend set
   */
  ParallelScheduler(const graph::BackendSet &backends);
  /**
   * @brief Assign a task to the given backend
   *
   * @param[in] fn Function to be assigned
   * @param[in] fn Target backend
   */
  void assign(std::unique_ptr<IFunction> &&fn, const backend::Backend *backend);
  /**
   * @brief Block until all jobs are finished
   */
  void finish();

private:
  std::unordered_map<const backend::Backend *, std::unique_ptr<ThreadPool>> _thread_pools;
};

} // namespace exec
} // namespace neurun

#endif // __NEURUN_EXEC_PARALLEL_SCHEDULER_H__