[Docs] Add docstrings to JIT kernel include headers (#19770)

This commit is contained in:
xingsy97
2026-03-07 20:48:00 +08:00
committed by GitHub
parent ef6540b439
commit f8d4eb7022
13 changed files with 355 additions and 3 deletions

View File

@@ -1,3 +1,11 @@
/// \file vec.cuh
/// \brief Aligned vector types for coalesced global memory access.
///
/// `AlignedVector<T, N>` wraps `N` elements of type `T` in a naturally
/// aligned struct so that the compiler emits wide (vectorized) load/store
/// instructions (e.g. `LDG.128`). The maximum supported vector width is
/// 256 bits (32 bytes), matching CUDA's widest vector load.
#pragma once
#include <sgl_kernel/utils.cuh>
@@ -8,6 +16,7 @@ namespace device {
namespace details {
/// \brief Maps byte-width to the corresponding unsigned integer type.
template <std::size_t N>
struct uint_trait {};
@@ -31,35 +40,58 @@ struct uint_trait<8> {
using type = uint64_t;
};
/// \brief Alias: maps `sizeof(T)` to matching unsigned int type.
template <typename T>
using sized_int = typename uint_trait<sizeof(T)>::type;
} // namespace details
/// \brief Raw aligned storage for `N` elements of type `T`.
template <typename T, std::size_t N>
struct alignas(sizeof(T) * N) AlignedStorage {
T data[N];
};
/**
* \brief Aligned vector for vectorized memory access on GPU.
*
* Stores `N` elements of type `T` with natural alignment so that a single
* `load`/`store` call compiles to a wide memory transaction.
*
* \tparam T Element type (e.g. `fp16_t`, `bf16_t`, `float`).
* \tparam N Number of elements. Must be a power of two and
* `sizeof(T) * N <= 32` (256 bits).
*
* Example:
* \code
* AlignedVector<fp16_t, 8> vec; // 16 bytes, 128-bit aligned
* vec.load(input_ptr, tid); // vectorized load
* vec[0] = vec[0] + 1;
* vec.store(output_ptr, tid); // vectorized store
* \endcode
*/
template <typename T, std::size_t N>
struct AlignedVector {
private:
/// NOTE: 1. must be pow of two 2. 16 * 8 = 128 byte, which is the max vector size supported by most devices
static_assert((N > 0 && (N & (N - 1)) == 0) && sizeof(T) * N <= 32, "CUDA only support at most 256B vector op");
/// NOTE: N must be a power of two and sizeof(T) * N <= 32 bytes (256 bits)
static_assert((N > 0 && (N & (N - 1)) == 0) && sizeof(T) * N <= 32, "CUDA only supports at most 256-bit vector op");
using element_t = typename details::sized_int<T>;
using storage_t = AlignedStorage<element_t, N>;
public:
/// \brief Vectorized load from `ptr` at the given element `offset`.
template <typename U>
SGL_DEVICE void load(const U* ptr, std::size_t offset = 0) {
static_assert(std::is_same_v<U, T> || std::is_same_v<U, void>);
m_storage = reinterpret_cast<const storage_t*>(ptr)[offset];
}
/// \brief Vectorized store to `ptr` at the given element `offset`.
template <typename U>
SGL_DEVICE void store(U* ptr, std::size_t offset = 0) const {
static_assert(std::is_same_v<U, T> || std::is_same_v<U, void>);
reinterpret_cast<storage_t*>(ptr)[offset] = m_storage;
}
/// \brief Fill all N elements with the same `value`.
SGL_DEVICE void fill(T value) {
const auto store_value = *reinterpret_cast<element_t*>(&value);
#pragma unroll