summaryrefslogtreecommitdiff
path: root/runtime/onert/core/src/exec/WorkQueue.h
blob: 2e56d85e80a0ced94c84105477a1a26ea8d5edc4 (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
/*
 * 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 __ONERT_EXEC_WORK_QUEUE_H__
#define __ONERT_EXEC_WORK_QUEUE_H__

#include <condition_variable>
#include <memory>
#include <mutex>
#include <queue>

#include "exec/IFunction.h"

namespace onert
{
namespace exec
{

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;
};

} // namespace exec
} // namespace onert

#endif // __ONERT_EXEC_WORK_QUEUE_H__