hf_buf.h

// Adapted from PHF reference (origin/v1.1.0_dev:modules/codec/huffman/hf_hl.hh)
// Changes:
//   - Replaced #include "mem/cxx_smart_ptr.h" with local RAII wrappers below.
//   - Replaced #include "err.hh" (not needed in header; hf_buf.cc uses cuda_check.h).
//   - Removed HuffmanCodec<E> class (not used; we use Buf<E> + high_level<E> directly).
//   - Removed timer/io includes (not needed).
//   - Buf<E> refactored to use pool-managed raw pointers instead of unique_ptr members.
//     Constructor takes MemoryPool* and allocates via allocatePersistentDevice/Pinned.
//     Destructor asks the pool to free and untrack them via freePersistentDevice/Pinned.
//     The pool is the sole owner; Buf<E> holds non-owning raw pointers.
 
#pragma once
 
#include "backend/types.h"
#include <cstddef>
#include <cstdint>
#include <memory>
 
#include "hf.h"
#include "hf_impl.hh"
#include "mem/mempool.h"
 
// ── HuffmanHelper (used by hf_kernels.cu) ────────────────────────────────────
 
struct HuffmanHelper {
    static const int BLOCK_DIM_ENCODE   = 256;
    static const int BLOCK_DIM_DEFLATE  = 256;
    static const int ENC_SEQUENTIALITY  = 4;
    static const int DEFLATE_CONSTANT   = 4;
};
 
// ── HF_SPACE / HF_STREAM convenience macros ──────────────────────────────────
 
#define HF_SPACE phf::Buf<E>
#define HF_STREAM void*
 
// ── phf::Buf<E> ──────────────────────────────────────────────────────────────
 
namespace phf {
 
template <typename E>
struct Buf {
    using H4 = uint32_t;
    using M  = PHF_METADATA;
 
    struct RC {
        static const int SCRATCH    = 0;
        static const int FREQ       = 1;
        static const int BK         = 2;
        static const int REVBK      = 3;
        static const int PAR_NBIT   = 4;
        static const int PAR_NCELL  = 5;
        static const int PAR_ENTRY  = 6;
        static const int BITSTREAM  = 7;
        static const int END        = 8;
    };
 
    struct memcpy_helper {
        void*  const ptr;
        size_t const nbyte;
        size_t const dst;
    };
 
    using SYM    = E;
    using Header = phf_header;
 
    // ── Fields ────────────────────────────────────────────────────────────────
    const size_t len;
    size_t       pardeg;
    size_t       sublen;
    const size_t bklen;
    const size_t revbk4_bytes;
    const size_t bitstream_max_len;
    const size_t scratch4_len;
 
    uint16_t rt_bklen;
    int      numSMs;
 
    size_t   total_footprint_d = 0;
    size_t   total_footprint_h = 0;
 
    // Device scratch — raw pointers, allocated from pool_ on construction
    H4*       d_scratch4;
    H4*       h_scratch4;
    PHF_BYTE* d_encoded;   // alias into d_scratch4 (not a separate allocation)
    PHF_BYTE* h_encoded;   // alias into h_scratch4 (not a separate allocation)
 
    H4*       d_bitstream4;
    H4*       h_bitstream4;
 
    H4*       d_bk4;
    H4*       h_bk4;
    PHF_BYTE* d_revbk4;
    PHF_BYTE* h_revbk4;
 
    // Per-partition metadata
    M*  d_par_nbit;
    M*  h_par_nbit;
    M*  d_par_ncell;
    M*  h_par_ncell;
    M*  d_par_entry;
    M*  h_par_entry;
 
    // Histogram buffers — pre-allocated for forward execute; size = bklen each
    uint32_t* d_freq;
    uint32_t* h_freq;
 
    // Device-book build status: status, flags, floor shift used, range offender.
    // Kept persistent because terminal DeviceResident reads it only after the
    // pipeline completion barrier.
    uint32_t* d_book_meta;
    uint32_t* h_book_meta;
 
    // ── Static helpers ────────────────────────────────────────────────────────
    static int _revbk4_bytes(int bklen);
    static int _revbk8_bytes(int bklen);
 
    static size_t _bitstream4_len(size_t pardeg, size_t sublen);
 
    // Non-copyable, non-movable
    Buf(const Buf&)            = delete;
    Buf& operator=(const Buf&) = delete;
    Buf(Buf&&)                 = delete;
    Buf& operator=(Buf&&)      = delete;
 
    // ── Constructor / destructor ──────────────────────────────────────────────
 
    Buf(size_t inlen, size_t _bklen, fz::MemoryPool* pool, int _pardeg = -1);
    ~Buf();
 
    // ── Mutators ──────────────────────────────────────────────────────────────
    void register_runtime_bklen(int _rt_bklen) { rt_bklen = _rt_bklen; }
 
    void memcpy_merge(phf_header& header, phf_stream_t stream);
    void clear_buffer();
 
private:
    fz::MemoryPool* pool_;  // non-owning; used only in destructor to return allocations
    std::weak_ptr<const void> pool_alive_;
};
 
// ── phf::high_level<E> ───────────────────────────────────────────────────────
 
template <typename E>
struct high_level {
    // Build codebook from host histogram; H2D copies codebook and revbook.
    static int build_book(Buf<E>* buf, uint32_t* h_hist,
                          uint16_t rt_bklen, HF_STREAM stream);
 
    // GPU coarse encode: histogram must already be done (histogram D2H happened
    // outside this function to fill h_hist before build_book was called).
    // Output lives at buf->d_encoded; *outlen = phf_encoded_bytes(&header).
    static int encode(Buf<E>* buf, E* in_data, size_t data_len,
                      uint8_t** out_encoded, size_t* encoded_len,
                      phf_header& header, HF_STREAM stream);
 
    // GPU coarse decode: reads phf_header from in_encoded[0..127],
    // reconstructs symbols into out_decoded.
    static int decode(Buf<E>* buf, phf_header& header,
                      PHF_BYTE* in_encoded, E* out_decoded, HF_STREAM stream);
};
 
}  // namespace phf