summaryrefslogtreecommitdiff
path: root/runtime/neurun/core/include/util/EventCollectorGlobal.h
blob: 15e40844ec24f43be92d544a10f7c735846e6b5b (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
/*
 * 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_UTIL_EVENT_COLLECTOR_GLOBAL_H__
#define __NEURUN_UTIL_EVENT_COLLECTOR_GLOBAL_H__

#include "misc/EventRecorder.h"
#include "misc/EventCollector.h"

namespace neurun
{
namespace util
{

/**
 * @brief Singleton class for event collection from anywhere in code
 *
 */
class EventCollectorGlobal
{
public:
  /**
   * @brief Get the singleton object of this class
   *
   * @return EventCollectorGlobal& Singleton object
   */
  static EventCollectorGlobal &get();

public:
  /**
   * @brief Getter for event collector object
   *
   * @return EventCollector& Collector object
   */
  EventCollector &collector() { return _collector; }

private:
  EventCollectorGlobal();
  ~EventCollectorGlobal();

private:
  EventRecorder _recorder;
  EventCollector _collector;
};

/**
 * @brief Helper class for emitting duration event which is handled automatically with ctor/dtor
 *
 */
class EventDurationBlock
{
public:
  /**
   * @brief Raise a duration event with type of BEGIN
   *
   * @param tag A label for the duration event
   */
  EventDurationBlock(const std::string &tag);
  /**
   * @brief Raise a duration event with type of END
   *
   */
  ~EventDurationBlock();

private:
  std::string _tag;
};

/**
 * @brief Helper class for emitting duration event which is handled manually
 *
 *        Usage:
 *        {
 *          ...
 *          EventDurationManual duration("some tag");
 *          duration.begin();
 *          ...
 *          ... // Code for duration
 *          ...
 *          duration.end();
 *        }
 *
 */
class EventDurationManual
{
public:
  /**
   * @brief Construct a new Event Duration Manual object
   *
   * @param tag A label for the duration object
   */
  EventDurationManual(const std::string &tag);
  /**
   * @brief Destroy the Event Duration Manual object
   *
   */
  ~EventDurationManual();

  /**
   * @brief Raise a duration event with type of BEGIN
   *
   */
  void begin();
  /**
   * @brief Raise a duration event with type of END
   *
   */
  void end();

private:
  std::string _tag;
  bool _pair;
};

} // namespace util
} // namespace neurun

/**
 * Helper Macro Definitions
 *
 * HOW TO USE
 *
 * void f(args)
 * {
 *   EVENT_DURATION_FUNCTION();
 *   ...
 *   if(cond)
 *   {
 *     EVENT_DURATION_REGION("if branch");
 *     ...
 *   }
 *   ...
 * }
 */

#define EVENT_DURATION_FUNCTION() \
  ::neurun::util::EventDurationBlock __event_duration__##__LINE__ { __FUNCTION__ }

#define EVENT_DURATION_REGION(tag) \
  ::neurun::util::EventDurationBlock __event_duration__##__LINE__ { tag }

#endif // __NEURUN_UTIL_EVENT_COLLECTOR_GLOBAL_H__