Struct RingKernelConfig 

pub struct RingKernelConfig {

    pub id: String,
    pub block_size: u32,
    pub queue_capacity: u32,
    pub enable_k2k: bool,
    pub enable_hlc: bool,
    pub message_size: usize,
    pub response_size: usize,
    pub cooperative_groups: bool,
    pub idle_sleep_ns: u32,
    pub use_envelope_format: bool,
    pub kernel_id_num: u64,
    pub hlc_node_id: u64,
    pub reduction: KernelReductionConfig,
}

Configuration for a ring kernel.

Fields

id: String

Kernel identifier (used in function name).

block_size: u32

Block size (threads per block).

queue_capacity: u32

Input queue capacity (must be power of 2).

enable_k2k: bool

Enable kernel-to-kernel messaging.

enable_hlc: bool

Enable HLC clock operations.

message_size: usize

Message size in bytes (for buffer offset calculations).

response_size: usize

Response size in bytes.

cooperative_groups: bool

Use cooperative thread groups.

idle_sleep_ns: u32

Nanosleep duration when idle (0 to spin).

use_envelope_format: bool

Use MessageEnvelope format (256-byte header + payload). When enabled, messages in queues are full envelopes with headers.

kernel_id_num: u64

Kernel numeric ID (for response routing).

hlc_node_id: u64

HLC node ID for this kernel.

reduction: KernelReductionConfig

Configuration for global reductions (e.g., for PageRank dangling sum).

Implementations

impl RingKernelConfig

pub fn new(id: impl Into<String>) -> Self

Create a new ring kernel configuration with the given ID.

pub fn with_block_size(self, size: u32) -> Self

Set the block size.

pub fn with_queue_capacity(self, capacity: u32) -> Self

Set the queue capacity (must be power of 2).

pub fn with_k2k(self, enabled: bool) -> Self

Enable kernel-to-kernel messaging.

pub fn with_hlc(self, enabled: bool) -> Self

Enable HLC clock operations.

pub fn with_message_sizes(self, message: usize, response: usize) -> Self

Set message and response sizes.

pub fn with_idle_sleep(self, ns: u32) -> Self

Set idle sleep duration in nanoseconds.

pub fn with_envelope_format(self, enabled: bool) -> Self

Enable or disable MessageEnvelope format. When enabled, messages use the 256-byte header + payload format.

pub fn with_kernel_id(self, id: u64) -> Self

Set the kernel numeric ID (for K2K routing and response headers).

pub fn with_hlc_node_id(self, node_id: u64) -> Self

Set the HLC node ID for this kernel.

pub fn with_reduction(self, reduction: KernelReductionConfig) -> Self

Configure global reduction for this kernel.

Example

use ringkernel_cuda_codegen::{RingKernelConfig, KernelReductionConfig};
use ringkernel_cuda_codegen::reduction_intrinsics::ReductionOp;

let config = RingKernelConfig::new("pagerank")
    .with_reduction(
        KernelReductionConfig::new()
            .with_op(ReductionOp::Sum)
            .with_type("double")
    );

pub fn with_sum_reduction(self) -> Self

Enable global sum reduction with default settings.

This is a convenience method for enabling a sum reduction with double precision.

pub fn kernel_name(&self) -> String

Generate the kernel function name.

pub fn generate_signature(&self) -> String

Generate CUDA kernel signature.

pub fn generate_preamble(&self, indent: &str) -> String

Generate the kernel preamble (thread setup, variable declarations).

pub fn generate_loop_header(&self, indent: &str) -> String

Generate the persistent message loop header.

pub fn generate_message_complete(&self, indent: &str) -> String

Generate message processing completion code.

pub fn generate_loop_footer(&self, indent: &str) -> String

Generate the loop footer (end of while loop).

pub fn generate_epilogue(&self, indent: &str) -> String

Generate kernel epilogue (termination marking).

pub fn generate_kernel_wrapper(&self, handler_placeholder: &str) -> String

Generate complete kernel wrapper (without handler body).

Trait Implementations

impl Clone for RingKernelConfig

fn clone(&self) -> RingKernelConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RingKernelConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RingKernelConfig

fn default() -> Self

Returns the “default value” for a type.