ruCCL 0.21.1

Ruda collective communication algorithms and orchestration.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use super::device::InProcessDevice;
use std::fmt::{Debug, Formatter};
use std::marker::PhantomData;

pub struct DistributedBuffer<T, D: InProcessDevice<T>> {
    pub(super) communicator_id: u64,
    pub(super) buffers: Vec<D::Buffer>,
    pub(super) length_per_rank: usize,
    pub(super) marker: PhantomData<fn() -> (T, D)>,
}

impl<T, D: InProcessDevice<T>> Clone for DistributedBuffer<T, D> {
    fn clone(&self) -> Self {
        Self {
            communicator_id: self.communicator_id,
            buffers: self.buffers.clone(),
            length_per_rank: self.length_per_rank,
            marker: PhantomData,
        }
    }
}

impl<T, D> Debug for DistributedBuffer<T, D>
where
    D: InProcessDevice<T>,
    D::Buffer: Debug,
{
    fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
        formatter
            .debug_struct("DistributedBuffer")
            .field("communicator_id", &self.communicator_id)
            .field("buffers", &self.buffers)
            .field("length_per_rank", &self.length_per_rank)
            .finish()
    }
}

pub struct VariableDistributedBuffer<T, D: InProcessDevice<T>> {
    pub(super) communicator_id: u64,
    pub(super) buffers: Vec<Option<D::Buffer>>,
    pub(super) lengths: Vec<usize>,
    pub(super) marker: PhantomData<fn() -> (T, D)>,
}

impl<T, D: InProcessDevice<T>> Clone for VariableDistributedBuffer<T, D> {
    fn clone(&self) -> Self {
        Self {
            communicator_id: self.communicator_id,
            buffers: self.buffers.clone(),
            lengths: self.lengths.clone(),
            marker: PhantomData,
        }
    }
}

impl<T, D> Debug for VariableDistributedBuffer<T, D>
where
    D: InProcessDevice<T>,
    D::Buffer: Debug,
{
    fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
        formatter
            .debug_struct("VariableDistributedBuffer")
            .field("communicator_id", &self.communicator_id)
            .field("buffers", &self.buffers)
            .field("lengths", &self.lengths)
            .finish()
    }
}

pub struct RootedBuffer<T, D: InProcessDevice<T>> {
    pub(super) communicator_id: u64,
    pub(super) root: usize,
    pub(super) buffer: D::Buffer,
    pub(super) marker: PhantomData<fn() -> (T, D)>,
}

impl<T, D: InProcessDevice<T>> Clone for RootedBuffer<T, D> {
    fn clone(&self) -> Self {
        Self {
            communicator_id: self.communicator_id,
            root: self.root,
            buffer: self.buffer.clone(),
            marker: PhantomData,
        }
    }
}

impl<T, D> Debug for RootedBuffer<T, D>
where
    D: InProcessDevice<T>,
    D::Buffer: Debug,
{
    fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
        formatter
            .debug_struct("RootedBuffer")
            .field("communicator_id", &self.communicator_id)
            .field("root", &self.root)
            .field("buffer", &self.buffer)
            .finish()
    }
}

impl<T, D: InProcessDevice<T>> DistributedBuffer<T, D> {
    pub fn world_size(&self) -> usize {
        self.buffers.len()
    }

    pub fn length_per_rank(&self) -> usize {
        self.length_per_rank
    }

    pub fn rank_buffer(&self, rank: usize) -> Option<&D::Buffer> {
        self.buffers.get(rank)
    }
}

impl<T, D: InProcessDevice<T>> VariableDistributedBuffer<T, D> {
    pub fn world_size(&self) -> usize {
        self.buffers.len()
    }

    pub fn rank_length(&self, rank: usize) -> Option<usize> {
        self.lengths.get(rank).copied()
    }

    pub fn rank_buffer(&self, rank: usize) -> Option<&D::Buffer> {
        self.buffers.get(rank).and_then(Option::as_ref)
    }
}

impl<T, D: InProcessDevice<T>> RootedBuffer<T, D> {
    pub const fn root(&self) -> usize {
        self.root
    }

    pub fn len(&self) -> usize {
        D::buffer_len(&self.buffer)
    }

    pub fn is_empty(&self) -> bool {
        D::buffer_is_empty(&self.buffer)
    }

    pub const fn buffer(&self) -> &D::Buffer {
        &self.buffer
    }
}