logging_resource_adaptor.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2020-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <rmm/detail/export.hpp>
#include <rmm/mr/detail/logging_resource_adaptor_impl.hpp>
#include <rmm/resource_ref.hpp>
 
#include <cuda/memory_resource>
 
#include <initializer_list>
#include <ostream>
#include <string>
 
RMM_NAMESPACE_BEGIN
namespace mr {


class RMM_EXPORT logging_resource_adaptor
  : public cuda::mr::shared_resource<detail::logging_resource_adaptor_impl> {
  using shared_base = cuda::mr::shared_resource<detail::logging_resource_adaptor_impl>;
 
 public:
  RMM_CONSTEXPR_FRIEND void get_property(logging_resource_adaptor const&,
                                         cuda::mr::device_accessible) noexcept
  {
  }

  logging_resource_adaptor(cuda::mr::any_resource<cuda::mr::device_accessible> upstream,
                           std::string const& filename = get_default_filename(),
                           bool auto_flush             = false);

  logging_resource_adaptor(cuda::mr::any_resource<cuda::mr::device_accessible> upstream,
                           std::ostream& stream,
                           bool auto_flush = false);

  logging_resource_adaptor(cuda::mr::any_resource<cuda::mr::device_accessible> upstream,
                           std::initializer_list<rapids_logger::sink_ptr> sinks,
                           bool auto_flush = false);

  [[nodiscard]] rmm::device_async_resource_ref get_upstream_resource() const noexcept;

  void flush();

  [[nodiscard]] std::string header() const;

  static std::string get_default_filename();
};
 
static_assert(cuda::mr::resource_with<logging_resource_adaptor, cuda::mr::device_accessible>,
              "logging_resource_adaptor does not satisfy the cuda::mr::resource concept");
  // end of group
}  // namespace mr
RMM_NAMESPACE_END