runtime/onert/core/src/util/EventRecorder.h

   1 /*
   2  * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *    http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __ONERT_UTIL_EVENT_RECORDER_H__
  18 #define __ONERT_UTIL_EVENT_RECORDER_H__
  19
  20 #include <map>
  21 #include <memory>
  22 #include <mutex>
  23
  24 #include <ostream>
  25 #include <vector>
  26
  27 struct Event
  28 {
  29   std::string name;
  30   std::string tid;
  31   std::string ph; /* REQUIRED */
  32   std::string ts; /* REQUIRED */
  33 };
  34
  35 struct DurationEvent : public Event
  36 {
  37   // TO BE FILLED
  38 };
  39
  40 struct CounterEvent : public Event
  41 {
  42   std::map<std::string, std::string> values;
  43 };
  44
  45 //
  46 // Record Event as Chrome Trace Event File Format
  47 //
  48 // Refrence: https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/edit
  49 //
  50 class EventRecorder
  51 {
  52 public:
  53   enum class WriteFormat
  54   {
  55     CHROME_TRACING,
  56     SNPE_BENCHMARK
  57   };
  58
  59 public:
  60   EventRecorder() = default;
  61
  62 public:
  63   void emit(const DurationEvent &evt);
  64   void emit(const CounterEvent &evt);
  65
  66 public:
  67   bool empty() { return _duration_events.empty() && _counter_events.empty(); }
  68   void writeToFile(std::ostream &os);
  69   void setWriteFormat(WriteFormat write_format) { _write_format = write_format; }
  70
  71 private:
  72   void writeSNPEBenchmark(std::ostream &os);
  73   void writeChromeTrace(std::ostream &os);
  74
  75 private:
  76   std::mutex _mu;
  77   // TODO: Allow user to control write_format
  78   WriteFormat _write_format{WriteFormat::SNPE_BENCHMARK};
  79   std::vector<DurationEvent> _duration_events;
  80   std::vector<CounterEvent> _counter_events;
  81 };
  82
  83 #endif // __ONERT_UTIL_EVENT_RECORDER_H__