cusbf::detail::FastxPinnedSequenceBuffer Class Reference

Page-locked host buffer for fused FASTX normalize + H2D staging. More...

#include <fastx_pinned_buffer.hpp>

Public Member Functions
	FastxPinnedSequenceBuffer ()=default
	FastxPinnedSequenceBuffer (const FastxPinnedSequenceBuffer &)=delete
FastxPinnedSequenceBuffer &	operator= (const FastxPinnedSequenceBuffer &)=delete
	FastxPinnedSequenceBuffer (FastxPinnedSequenceBuffer &&other) noexcept
FastxPinnedSequenceBuffer &	operator= (FastxPinnedSequenceBuffer &&other) noexcept
	~FastxPinnedSequenceBuffer ()
char *	data () noexcept
	Writable pinned host pointer (may be nullptr before reserve).
const char *	data () const noexcept
	Read-only view of data().
size_t	size () const noexcept
	Logical byte length (≤ capacity).
size_t	capacity () const noexcept
	Allocated pinned bytes.
std::string_view	view () const noexcept
	data() as a string view of length size().
void	clear () noexcept
	Sets logical size to zero without freeing capacity.
void	release ()
	Frees pinned host memory and resets size and capacity.
Result< void >	reserve (size_t nbytes)
	Grows pinned allocation to at least nbytes, preserving existing bytes.
Result< void >	set_size (size_t nbytes)
	Sets logical size to nbytes, reserving if needed.

Detailed Description

Page-locked host buffer for fused FASTX normalize + H2D staging.

Definition at line 15 of file fastx_pinned_buffer.hpp.

Constructor & Destructor Documentation

FastxPinnedSequenceBuffer() [1/3]

cusbf::detail::FastxPinnedSequenceBuffer::FastxPinnedSequenceBuffer ( )

default

FastxPinnedSequenceBuffer() [2/3]

cusbf::detail::FastxPinnedSequenceBuffer::FastxPinnedSequenceBuffer ( const FastxPinnedSequenceBuffer &  )

delete

FastxPinnedSequenceBuffer() [3/3]

cusbf::detail::FastxPinnedSequenceBuffer::FastxPinnedSequenceBuffer ( FastxPinnedSequenceBuffer &&  other )

inlinenoexcept

Definition at line 21 of file fastx_pinned_buffer.hpp.

                                                                          {
        *this = std::move(other);
    }

Here is the call graph for this function:

~FastxPinnedSequenceBuffer()

cusbf::detail::FastxPinnedSequenceBuffer::~FastxPinnedSequenceBuffer ( )

inline

Definition at line 38 of file fastx_pinned_buffer.hpp.

                                 {
        release();
    }

Here is the call graph for this function:

Member Function Documentation

capacity()

size_t cusbf::detail::FastxPinnedSequenceBuffer::capacity ( ) const

inlinenoexcept

Allocated pinned bytes.

Definition at line 58 of file fastx_pinned_buffer.hpp.

                                                   {
        return capacity_;
    }

clear()

void cusbf::detail::FastxPinnedSequenceBuffer::clear ( )

inlinenoexcept

Sets logical size to zero without freeing capacity.

Definition at line 68 of file fastx_pinned_buffer.hpp.

                          {
        size_ = 0;
    }

data() [1/2]

const char * cusbf::detail::FastxPinnedSequenceBuffer::data ( ) const

inlinenoexcept

Read-only view of data().

Definition at line 48 of file fastx_pinned_buffer.hpp.

                                                    {
        return data_;
    }

data() [2/2]

char * cusbf::detail::FastxPinnedSequenceBuffer::data ( )

inlinenoexcept

Writable pinned host pointer (may be nullptr before reserve).

Definition at line 43 of file fastx_pinned_buffer.hpp.

                                        {
        return data_;
    }

operator=() [1/2]

FastxPinnedSequenceBuffer & cusbf::detail::FastxPinnedSequenceBuffer::operator= ( const FastxPinnedSequenceBuffer &  )

delete

operator=() [2/2]

FastxPinnedSequenceBuffer & cusbf::detail::FastxPinnedSequenceBuffer::operator= ( FastxPinnedSequenceBuffer &&  other )

inlinenoexcept

Definition at line 25 of file fastx_pinned_buffer.hpp.

                                                                                     {
        if (this != &other) {
            release();
            data_ = other.data_;
            size_ = other.size_;
            capacity_ = other.capacity_;
            other.data_ = nullptr;
            other.size_ = 0;
            other.capacity_ = 0;
        }
        return *this;
    }

Here is the call graph for this function:

release()

void cusbf::detail::FastxPinnedSequenceBuffer::release ( )

inline

Frees pinned host memory and resets size and capacity.

Definition at line 73 of file fastx_pinned_buffer.hpp.

                   {
        if (data_ != nullptr) {
            CUSBF_CUDA_ABORT(cudaFreeHost(data_));
            data_ = nullptr;
        }
        size_ = 0;
        capacity_ = 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

reserve()

Result< void > cusbf::detail::FastxPinnedSequenceBuffer::reserve ( size_t  nbytes )

inline

Grows pinned allocation to at least nbytes, preserving existing bytes.

Definition at line 83 of file fastx_pinned_buffer.hpp.

                                                      {
        if (nbytes <= capacity_) {
            return {};
        }
 
        char* reallocated = nullptr;
        CUSBF_CUDA_TRY(cudaHostAlloc(&reallocated, nbytes, cudaHostAllocDefault));
        if (data_ != nullptr) {
            if (size_ != 0) {
                std::memcpy(reallocated, data_, size_);
            }
            CUSBF_CUDA_ABORT(cudaFreeHost(data_));
        }
        data_ = reallocated;
        capacity_ = nbytes;
        return {};
    }

Here is the call graph for this function:

Here is the caller graph for this function:

set_size()

Result< void > cusbf::detail::FastxPinnedSequenceBuffer::set_size ( size_t  nbytes )

inline

Sets logical size to nbytes, reserving if needed.

Definition at line 102 of file fastx_pinned_buffer.hpp.

                                                       {
        if (nbytes > capacity_) {
            CUSBF_TRY(reserve(nbytes));
        }
        size_ = nbytes;
        return {};
    }

Here is the call graph for this function:

size()

size_t cusbf::detail::FastxPinnedSequenceBuffer::size ( ) const

inlinenoexcept

Logical byte length (≤ capacity).

Definition at line 53 of file fastx_pinned_buffer.hpp.

                                               {
        return size_;
    }

view()

std::string_view cusbf::detail::FastxPinnedSequenceBuffer::view ( ) const

inlinenoexcept

data() as a string view of length size().

Definition at line 63 of file fastx_pinned_buffer.hpp.

                                                       {
        return std::string_view{data_, size_};
    }

---

The documentation for this class was generated from the following file:

• fastx_pinned_buffer.hpp