LogBinProfiler.h

/*
MIT License
 
Copyright (c) 2022 Brian T. Park
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
#ifndef ACE_ROUTINE_LOG_BIN_PROFILER_H
#define ACE_ROUTINE_LOG_BIN_PROFILER_H
 
#include <stdint.h> // uint8_t, uint32_t
#include <stdio.h> // memset()
#include "Coroutine.h"
#include "CoroutineProfiler.h"
 
 
namespace ace_routine {
 
template <typename T_COROUTINE>
class LogBinProfilerTemplate : public CoroutineProfiler {
  public:
    static const uint8_t kNumBins = 32;
 
  public:
    LogBinProfilerTemplate() {
      clear();
    }
 
    void clear() {
      memset(mBins, 0, sizeof(mBins));
    }
 
    void updateElapsedMicros(uint32_t micros) override {
      uint8_t index = 0; // [0, 31]
 
      while (true) {
        micros >>= 1;
        if (micros == 0) break;
        index++;
      }
      uint16_t count = mBins[index];
      if (count < UINT16_MAX) {
        mBins[index]++;
      }
    }
 
    static void createProfilers() {
      T_COROUTINE** root = T_COROUTINE::getRoot();
      for (T_COROUTINE** p = root; (*p) != nullptr; p = (*p)->getNext()) {
        auto* profiler = new LogBinProfilerTemplate();
        (*p)->setProfiler(profiler);
      }
    }
 
    static void deleteProfilers() {
      T_COROUTINE** root = T_COROUTINE::getRoot();
      for (T_COROUTINE** p = root; (*p) != nullptr; p = (*p)->getNext()) {
        auto* profiler = (LogBinProfilerTemplate*) (*p)->getProfiler();
        if (profiler) {
          delete profiler;
          (*p)->setProfiler(nullptr);
        }
      }
    }
 
    static void clearProfilers() {
      T_COROUTINE** root = T_COROUTINE::getRoot();
      for (T_COROUTINE** p = root; (*p) != nullptr; p = (*p)->getNext()) {
        auto* profiler = (LogBinProfilerTemplate*) (*p)->getProfiler();
        if (profiler) {
          profiler->clear();
        }
      }
    }
 
  public:
    uint16_t mBins[kNumBins];
};
 
using LogBinProfiler = LogBinProfilerTemplate<Coroutine>;
 
namespace internal {
 
void rollupExteriorBins(
    uint16_t dst[],
    const uint16_t src[],
    uint8_t numBins,
    uint8_t startBin,
    uint8_t endBin
);
 
}
 
}
 
#endif