logging_resource_adaptor.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2024, NVIDIA CORPORATION.
 *
 * 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.
 */
#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/mr/device/device_memory_resource.hpp>
#include <rmm/resource_ref.hpp>
 
#include <spdlog/common.h>
#include <spdlog/sinks/basic_file_sink.h>
#include <spdlog/sinks/ostream_sink.h>
#include <spdlog/spdlog.h>
 
#include <cstddef>
#include <cstdio>
#include <memory>
#include <sstream>
#include <string_view>
 
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)
    : logger_{make_logger(filename)}, upstream_{to_device_async_resource_ref_checked(upstream)}
  {
    init_logger(auto_flush);
  }
 
  logging_resource_adaptor(Upstream* upstream, std::ostream& stream, bool auto_flush = false)
    : logger_{make_logger(stream)}, upstream_{to_device_async_resource_ref_checked(upstream)}
  {
    init_logger(auto_flush);
  }
 
  logging_resource_adaptor(Upstream* upstream,
                           spdlog::sinks_init_list sinks,
                           bool auto_flush = false)
    : logger_{make_logger(sinks)}, upstream_{to_device_async_resource_ref_checked(upstream)}
  {
    init_logger(auto_flush);
  }
 
  logging_resource_adaptor(device_async_resource_ref upstream,
                           std::string const& filename = get_default_filename(),
                           bool auto_flush             = false)
    : logger_{make_logger(filename)}, upstream_{upstream}
  {
    init_logger(auto_flush);
  }
 
  logging_resource_adaptor(device_async_resource_ref upstream,
                           std::ostream& stream,
                           bool auto_flush = false)
    : logger_{make_logger(stream)}, upstream_{upstream}
  {
    init_logger(auto_flush);
  }
 
  logging_resource_adaptor(device_async_resource_ref upstream,
                           spdlog::sinks_init_list sinks,
                           bool auto_flush = false)
    : logger_{make_logger(sinks)}, upstream_{upstream}
  {
    init_logger(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<spdlog::logger>(
      "RMM", std::make_shared<spdlog::sinks::ostream_sink_mt>(stream));
  }
 
  static auto make_logger(std::string const& filename)
  {
    return std::make_shared<spdlog::logger>(
      "RMM", std::make_shared<spdlog::sinks::basic_file_sink_mt>(filename, true /*truncate file*/));
  }
 
  static auto make_logger(spdlog::sinks_init_list sinks)
  {
    return std::make_shared<spdlog::logger>("RMM", sinks);
  }
 
  void init_logger(bool auto_flush)
  {
    if (auto_flush) { logger_->flush_on(spdlog::level::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_async(bytes, stream);
      logger_->info(rmm::detail::formatted_log(
        "allocate,%p,%zu,%s", ptr, bytes, rmm::detail::format_stream(stream)));
      return ptr;
    } catch (...) {
      logger_->info(rmm::detail::formatted_log(
        "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) override
  {
    logger_->info(
      rmm::detail::formatted_log("free,%p,%zu,%s", ptr, bytes, rmm::detail::format_stream(stream)));
    get_upstream_resource().deallocate_async(ptr, bytes, stream);
  }
 
  [[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<spdlog::logger> logger_;  
 
  device_async_resource_ref upstream_;  
};
 
template <typename Upstream>
[[deprecated(
  "make_logging_adaptor is deprecated in RMM 24.10. Use the logging_resource_adaptor constructor "
  "instead.")]]
logging_resource_adaptor<Upstream> make_logging_adaptor(
  Upstream* upstream,
  std::string const& filename = logging_resource_adaptor<Upstream>::get_default_filename(),
  bool auto_flush             = false)
{
  return logging_resource_adaptor<Upstream>{upstream, filename, auto_flush};
}
 
template <typename Upstream>
[[deprecated(
  "make_logging_adaptor is deprecated in RMM 24.10. Use the logging_resource_adaptor constructor "
  "instead.")]]
logging_resource_adaptor<Upstream> make_logging_adaptor(Upstream* upstream,
                                                        std::ostream& stream,
                                                        bool auto_flush = false)
{
  return logging_resource_adaptor<Upstream>{upstream, stream, auto_flush};
}
  // end of group
}  // namespace mr
}  // namespace RMM_NAMESPACE