rocm-systems/projects/clr/hipamd/src/hip_prof_api.h

/* Copyright (c) 2019 - 2021 Advanced Micro Devices, Inc.

 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 HIP_SRC_HIP_PROF_API_H
#define HIP_SRC_HIP_PROF_API_H

#include <atomic>
#include <cassert>
#include <iostream>
#include <mutex>
#include <utility>

#if USE_PROF_API
#include "hip/amd_detail/hip_prof_str.h"
#include "platform/prof_protocol.h"

// HIP API callbacks spawner object macro
#define HIP_CB_SPAWNER_OBJECT(CB_ID) \
  api_callbacks_spawner_t<HIP_API_ID_##CB_ID> __api_tracer; \
  { \
    hip_api_data_t* api_data = __api_tracer.get_api_data_ptr(); \
    if (api_data != nullptr) { \
      INIT_CB_ARGS_DATA(CB_ID, (*api_data)); \
      __api_tracer.call(); \
    } \
  }

class api_callbacks_table_t {
 public:
  api_callbacks_table_t() = default;

  bool set_activity(hip_api_id_t id, activity_sync_callback_t function, void* arg) {
    if (id < HIP_API_ID_FIRST || id > HIP_API_ID_LAST)
      return false;

    std::lock_guard<std::mutex> lock(writer_mutex_);

    /* 'function != nullptr' indicates it is activity register call,
       increment should happen only once but client is free to call
       register CB multiple times for same API id hence the check

       'function == nullptr' indicates it is de-register call and
       decrement should happen only once hence the check. */

    if (function != nullptr) {
      if (callbacks_table_[id].activity.first == nullptr) {
        ++enabled_api_count_;
      }
    } else {
      if (callbacks_table_[id].activity.first != nullptr) {
        --enabled_api_count_;
      }
    }
    amd::IS_PROFILER_ON = (enabled_api_count_ > 0);

    acquire_writer_lock(id);
    callbacks_table_[id].activity = { function, arg };
    release_writer_lock(id);

    return true;
  }

  bool set_callback(hip_api_id_t id, activity_rtapi_callback_t function, void* arg) {
    if (id < HIP_API_ID_FIRST || id > HIP_API_ID_LAST)
      return false;

    std::lock_guard<std::mutex> lock(writer_mutex_);

    acquire_writer_lock(id);
    callbacks_table_[id].user_callback = { function, arg };
    release_writer_lock(id);

    return true;
  }

  auto get_callback_and_activity(hip_api_id_t id) {
    assert(id >= HIP_API_ID_FIRST && id <= HIP_API_ID_LAST && "invalid callback id");
    auto& entry = callbacks_table_[id];

    acquire_reader_lock(id);
    auto ret = std::make_pair(entry.user_callback, entry.activity);
    release_reader_lock(id);

    return ret;
  }

  void set_enabled(bool enabled) {
    amd::IS_PROFILER_ON = enabled;
  }

  bool is_enabled() const {
    return amd::IS_PROFILER_ON;
  }

 private:
  void acquire_reader_lock(hip_api_id_t id) {
    auto& entry = callbacks_table_[id];

    while (true) {
      if (entry.reader_count++ == std::numeric_limits<uint32_t>::max())
        assert(!"reader_count overflow");

      if (!entry.writer_lock) break;

      // A writer owns the lock, decrement the reader count and wait for the
      // writer to release the lock.

      if (entry.reader_count-- == 0) assert (!"reader_count corrupted");
      while (entry.writer_lock) {}
    }
  }

  void release_reader_lock(hip_api_id_t id) {
    if (callbacks_table_[id].reader_count-- == 0)
      assert (!"reader_count corrupted");
  }

  void acquire_writer_lock(hip_api_id_t id) {
    callbacks_table_[id].writer_lock = true;
    while (callbacks_table_[id].reader_count != 0) {}
  }

  void release_writer_lock(hip_api_id_t id) {
    callbacks_table_[id].writer_lock = false;
  }

  std::mutex writer_mutex_{};
  uint32_t enabled_api_count_{0};

  // HIP API callbacks table
  struct  {
    std::atomic<bool> writer_lock{false};
    std::atomic<uint32_t> reader_count{0};
    std::pair<activity_sync_callback_t, void*> activity;
    std::pair<activity_rtapi_callback_t, void*> user_callback;
  } callbacks_table_[HIP_API_ID_LAST + 1]{};
};

extern api_callbacks_table_t callbacks_table;

template <hip_api_id_t ID>
class api_callbacks_spawner_t {
 public:
  api_callbacks_spawner_t() :
    api_data_(nullptr)
  {
    static_assert(ID >= HIP_API_ID_FIRST && ID <= HIP_API_ID_LAST, "invalid callback id");
    if (!callbacks_table.is_enabled()) return;

    std::tie(user_callback_, activity_) = callbacks_table.get_callback_and_activity(ID);

    if (activity_.first != nullptr)
      api_data_ = (hip_api_data_t*) activity_.first(ID, nullptr, nullptr, nullptr);
  }

  void call() {
    if (user_callback_.first != nullptr)
      user_callback_.first(ACTIVITY_DOMAIN_HIP_API, ID, api_data_, user_callback_.second);
  }

  ~api_callbacks_spawner_t() {
    if (api_data_ == nullptr)
      return;

    api_data_->phase = ACTIVITY_API_PHASE_EXIT;
    if (user_callback_.first != nullptr)
      user_callback_.first(ACTIVITY_DOMAIN_HIP_API, ID, api_data_, user_callback_.second);

    if (activity_.first != nullptr)
      activity_.first(ID, nullptr, nullptr, activity_.second);
  }

  hip_api_data_t* get_api_data_ptr() const {
    return api_data_;
  }

 private:
  std::pair<activity_rtapi_callback_t /* function */, void * /* arg */> user_callback_;
  std::pair<activity_sync_callback_t /* function */, void * /* arg */> activity_;
  hip_api_data_t* api_data_;
};

template <>
class api_callbacks_spawner_t<HIP_API_ID_NONE> {
 public:
  api_callbacks_spawner_t() {}
  void call() {}
  hip_api_data_t* get_api_data_ptr() { return nullptr; }
};

#else

#define HIP_CB_SPAWNER_OBJECT(x) do {} while(0)

class api_callbacks_table_t {
 public:
  bool set_activity(hip_api_id_t, activity_sync_callback_t, void*) { return false; }
  bool set_callback(hip_api_id_t, activity_rtapi_callback_t, void*) { return false; }
};

#endif

#endif  // HIP_SRC_HIP_PROF_API_H