forked from rapidsai/cudf
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Experimental support for configurable prefetching (rapidsai#16020)
This PR adds experimental support for prefetching managed memory at a select few points in libcudf. A new configuration object is introduced for handling whether prefetching is enabled or disabled, and whether to print debug information about pointers being prefetched. Prefetching control is managed on a per API basis to enable profiling of the effects of prefetching different classes of data in different contexts. Prefetching in this PR always occurs on the default stream, so it will trigger synchronization with any blocking streams that the user has created. Turning on prefetching and then passing non-blocking to any libcudf APIs will trigger undefined behavior. Authors: - Vyas Ramasubramani (https://github.com/vyasr) Approvers: - David Wendt (https://github.com/davidwendt) - Kyle Edwards (https://github.com/KyleFromNVIDIA) - Thomas Li (https://github.com/lithomas1) - Muhammad Haseeb (https://github.com/mhaseeb123) URL: rapidsai#16020
- Loading branch information
Showing
15 changed files
with
416 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| /* | ||
| * Copyright (c) 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 <cudf/utilities/default_stream.hpp> | ||
|
|
||
| #include <rmm/device_uvector.hpp> | ||
|
|
||
| #include <map> | ||
| #include <string> | ||
| #include <string_view> | ||
|
|
||
| namespace cudf::experimental::prefetch { | ||
|
|
||
| namespace detail { | ||
|
|
||
| /** | ||
| * @brief A singleton class that manages the prefetching configuration. | ||
| */ | ||
| class PrefetchConfig { | ||
| public: | ||
| PrefetchConfig& operator=(const PrefetchConfig&) = delete; | ||
| PrefetchConfig(const PrefetchConfig&) = delete; | ||
|
|
||
| /** | ||
| * @brief Get the singleton instance of the prefetching configuration. | ||
| * | ||
| * @return The singleton instance of the prefetching configuration. | ||
| */ | ||
| static PrefetchConfig& instance(); | ||
|
|
||
| /** | ||
| * @brief Get the value of a configuration key. | ||
| * | ||
| * @param key The configuration key. | ||
| * @return The value of the configuration key. | ||
| */ | ||
| bool get(std::string_view key); | ||
| /** | ||
| * @brief Set the value of a configuration key. | ||
| * | ||
| * @param key The configuration key. | ||
| * @param value The value to set. | ||
| */ | ||
| void set(std::string_view key, bool value); | ||
| /** | ||
| * @brief Enable or disable debug mode. | ||
| * | ||
| * In debug mode, the pointers being prefetched are printed to stderr. | ||
| */ | ||
| bool debug{false}; | ||
|
|
||
| private: | ||
| PrefetchConfig() = default; //< Private constructor to enforce singleton pattern | ||
| std::map<std::string, bool> config_values; //< Map of configuration keys to values | ||
| }; | ||
|
|
||
| /** | ||
| * @brief Enable prefetching for a particular structure or algorithm. | ||
| * | ||
| * @param key The key to enable prefetching for. | ||
| * @param ptr The pointer to prefetch. | ||
| * @param size The size of the memory region to prefetch. | ||
| * @param stream The stream to prefetch on. | ||
| * @param device_id The device to prefetch on. | ||
| */ | ||
| void prefetch(std::string_view key, | ||
| void const* ptr, | ||
| std::size_t size, | ||
| rmm::cuda_stream_view stream, | ||
| rmm::cuda_device_id device_id = rmm::get_current_cuda_device()); | ||
|
|
||
| /** | ||
| * @brief Enable prefetching for a particular structure or algorithm. | ||
| * | ||
| * @note This function will not throw exceptions, so it is safe to call in | ||
| * noexcept contexts. If an error occurs, the error code is returned. This | ||
| * function primarily exists for [mutable_]column_view::get_data and should be | ||
| * removed once an method for stream-ordered data pointer access is added to | ||
| * those data structures. | ||
| * | ||
| * @param key The key to enable prefetching for. | ||
| * @param ptr The pointer to prefetch. | ||
| * @param size The size of the memory region to prefetch. | ||
| * @param stream The stream to prefetch on. | ||
| * @param device_id The device to prefetch on. | ||
| */ | ||
| cudaError_t prefetch_noexcept( | ||
| std::string_view key, | ||
| void const* ptr, | ||
| std::size_t size, | ||
| rmm::cuda_stream_view stream, | ||
| rmm::cuda_device_id device_id = rmm::get_current_cuda_device()) noexcept; | ||
|
|
||
| /** | ||
| * @brief Prefetch the data in a device_uvector. | ||
| * | ||
| * @note At present this function does not support stream-ordered execution. Prefetching always | ||
| * occurs on the default stream. | ||
| * | ||
| * @param key The key to enable prefetching for. | ||
| * @param v The device_uvector to prefetch. | ||
| * @param stream The stream to prefetch on. | ||
| * @param device_id The device to prefetch on. | ||
| */ | ||
| template <typename T> | ||
| void prefetch(std::string_view key, | ||
| rmm::device_uvector<T> const& v, | ||
| rmm::cuda_stream_view stream, | ||
| rmm::cuda_device_id device_id = rmm::get_current_cuda_device()) | ||
| { | ||
| if (v.is_empty()) { return; } | ||
| prefetch(key, v.data(), v.size(), stream, device_id); | ||
| } | ||
|
|
||
| } // namespace detail | ||
|
|
||
| /** | ||
| * @brief Enable prefetching for a particular structure or algorithm. | ||
| * | ||
| * @param key The key to enable prefetching for. | ||
| */ | ||
| void enable_prefetching(std::string_view key); | ||
|
|
||
| /** | ||
| * @brief Disable prefetching for a particular structure or algorithm. | ||
| * | ||
| * @param key The key to disable prefetching for. | ||
| */ | ||
| void disable_prefetching(std::string_view key); | ||
|
|
||
| /** | ||
| * @brief Enable or disable debug mode. | ||
| * | ||
| * In debug mode, the pointers being prefetched are printed to stderr. | ||
| * | ||
| * @param enable Whether to enable or disable debug mode. | ||
| */ | ||
| void prefetch_debugging(bool enable); | ||
|
|
||
| } // namespace cudf::experimental::prefetch |
Oops, something went wrong.