logging_resource_adaptor.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2020-2025, NVIDIA CORPORATION.
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <rmm/cuda_stream_view.hpp>
#include <rmm/detail/error.hpp>
#include <rmm/detail/export.hpp>
#include <rmm/detail/format.hpp>
#include <rmm/logger.hpp>
#include <rmm/mr/device/device_memory_resource.hpp>
#include <rmm/resource_ref.hpp>
 
#include <cstddef>
#include <cstdio>
#include <initializer_list>
#include <memory>
#include <ostream>
#include <string>
 
namespace RMM_NAMESPACE {
namespace mr {
 
template <typename Upstream>
class logging_resource_adaptor final : public device_memory_resource {
 public:
  logging_resource_adaptor(Upstream* upstream,
                           std::string const& filename = get_default_filename(),
                           bool auto_flush             = false)
    : logging_resource_adaptor(to_device_async_resource_ref_checked(upstream), filename, auto_flush)
  {
  }
 
  logging_resource_adaptor(Upstream* upstream, std::ostream& stream, bool auto_flush = false)
    : logging_resource_adaptor(to_device_async_resource_ref_checked(upstream), stream, auto_flush)
  {
  }
 
  logging_resource_adaptor(Upstream* upstream,
                           std::initializer_list<rapids_logger::sink_ptr> sinks,
                           bool auto_flush = false)
    : logging_resource_adaptor{to_device_async_resource_ref_checked(upstream), sinks, auto_flush}
  {
  }
 
  logging_resource_adaptor(device_async_resource_ref upstream,
                           std::string const& filename = get_default_filename(),
                           bool auto_flush             = false)
    : logging_resource_adaptor{make_logger(filename), upstream, auto_flush}
  {
  }
 
  logging_resource_adaptor(device_async_resource_ref upstream,
                           std::ostream& stream,
                           bool auto_flush = false)
    : logging_resource_adaptor{make_logger(stream), upstream, auto_flush}
  {
  }
 
  logging_resource_adaptor(device_async_resource_ref upstream,
                           std::initializer_list<rapids_logger::sink_ptr> sinks,
                           bool auto_flush = false)
    : logging_resource_adaptor{make_logger(sinks), upstream, auto_flush}
  {
  }
 
  logging_resource_adaptor()                                           = delete;
  ~logging_resource_adaptor() override                                 = default;
  logging_resource_adaptor(logging_resource_adaptor const&)            = delete;
  logging_resource_adaptor& operator=(logging_resource_adaptor const&) = delete;
  logging_resource_adaptor(logging_resource_adaptor&&) noexcept =
    default;  
  logging_resource_adaptor& operator=(logging_resource_adaptor&&) noexcept =
    default;  
 
  [[nodiscard]] rmm::device_async_resource_ref get_upstream_resource() const noexcept
  {
    return upstream_;
  }
 
  void flush() { logger_->flush(); }
 
  [[nodiscard]] std::string header() const
  {
    return std::string{"Thread,Time,Action,Pointer,Size,Stream"};
  }
 
  static std::string get_default_filename()
  {
    auto* filename = std::getenv("RMM_LOG_FILE");
    RMM_EXPECTS(filename != nullptr,
                "RMM logging requested without an explicit file name, but RMM_LOG_FILE is unset");
    return std::string{filename};
  }
 
 private:
  static auto make_logger(std::ostream& stream)
  {
    return std::make_shared<rapids_logger::logger>("RMM", stream);
  }
 
  static auto make_logger(std::string const& filename)
  {
    return std::make_shared<rapids_logger::logger>("RMM", filename);
  }
 
  static auto make_logger(std::initializer_list<rapids_logger::sink_ptr> sinks)
  {
    return std::make_shared<rapids_logger::logger>("RMM", sinks);
  }
 
  logging_resource_adaptor(std::shared_ptr<rapids_logger::logger> logger,
                           device_async_resource_ref upstream,
                           bool auto_flush)
    : logger_{logger}, upstream_{upstream}
  {
    if (auto_flush) { logger_->flush_on(rapids_logger::level_enum::info); }
    logger_->set_pattern("%v");
    logger_->info(header());
    logger_->set_pattern("%t,%H:%M:%S.%f,%v");
  }
 
  void* do_allocate(std::size_t bytes, cuda_stream_view stream) override
  {
    try {
      auto const ptr = get_upstream_resource().allocate(stream, bytes);
      logger_->info("allocate,%p,%zu,%s", ptr, bytes, rmm::detail::format_stream(stream));
      return ptr;
    } catch (...) {
      logger_->info(
        "allocate failure,%p,%zu,%s", nullptr, bytes, rmm::detail::format_stream(stream));
      throw;
    }
  }
 
  void do_deallocate(void* ptr, std::size_t bytes, cuda_stream_view stream) noexcept override
  {
    logger_->info("free,%p,%zu,%s", ptr, bytes, rmm::detail::format_stream(stream));
    get_upstream_resource().deallocate(stream, ptr, bytes);
  }
 
  [[nodiscard]] bool do_is_equal(device_memory_resource const& other) const noexcept override
  {
    if (this == &other) { return true; }
    auto const* cast = dynamic_cast<logging_resource_adaptor<Upstream> const*>(&other);
    if (cast == nullptr) { return false; }
    return get_upstream_resource() == cast->get_upstream_resource();
  }
 
  std::shared_ptr<rapids_logger::logger> logger_{};
 
  device_async_resource_ref upstream_;  
};
  // end of group
}  // namespace mr
}  // namespace RMM_NAMESPACE