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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
use alloc::raw_vec::RawVec;
use core::ptr;
use core::mem::transmute;
use std::slice::{from_raw_parts, from_raw_parts_mut};
use std;
use std::ffi::CString;
use std::io;
use std::io::Result;
use libc;
use std::mem;

#[repr(C)]
pub struct RingBuffer<T> {
    buffer: RawVec<T>,
    mask: usize,
}

impl<T> RingBuffer<T> {
    pub fn with_capacity(cap: usize) -> Self {
        let adjusted = cap.next_power_of_two();
        RingBuffer {
            buffer: RawVec::with_capacity(adjusted),
            mask: adjusted - 1,
        }
    }

    pub fn with_mirror(name: CString, cap: usize) -> Result<RingBuffer<T>> {
        let adjusted = cap.next_power_of_two();
        let mask = 4096 - 1;
        let size = (adjusted * std::mem::size_of::<T>() + mask) & !mask;

        let fd_raw = unsafe {
            libc::shm_open(name.as_ptr(),
                           libc::O_RDWR | libc::O_CREAT | libc::O_EXCL,
                           0666)
        };
        let n = unsafe { libc::ftruncate(fd_raw, size as libc::off_t) };
        let ptr = unsafe {
            libc::mmap(ptr::null_mut(),
                       2 * size as libc::size_t,
                       libc::PROT_NONE,
                       libc::MAP_ANON | libc::MAP_PRIVATE,
                       -1,
                       0)
        };

        if ptr == libc::MAP_FAILED {
            return Err(io::Error::last_os_error());
        }

        let addr = unsafe {
            libc::mmap(ptr,
                       size as libc::size_t,
                       libc::PROT_READ | libc::PROT_WRITE,
                       libc::MAP_FIXED | libc::MAP_SHARED,
                       fd_raw,
                       0)
        };

        if addr != ptr {
            return Err(io::Error::last_os_error());
        }

        let addr = unsafe {
            libc::mmap(ptr.offset(size as isize),
                       size as libc::size_t,
                       libc::PROT_READ | libc::PROT_WRITE,
                       libc::MAP_FIXED | libc::MAP_SHARED,
                       fd_raw,
                       0)
        };

        if addr != unsafe { ptr.offset(size as isize) } {
            return Err(io::Error::last_os_error());
        }

        let n = unsafe { libc::close(fd_raw) };
        if n != 0 {
            println!("error {} when closing file descriptor {}", n, fd_raw);
            return Err(io::Error::last_os_error());
        }

        if unsafe { libc::shm_unlink(name.as_ptr()) < 0 } {
            return Err(io::Error::last_os_error());
        }

        mem::forget(ptr);

        Ok(RingBuffer {
            buffer: unsafe { RawVec::from_raw_parts(ptr as *mut T, adjusted) },
            mask: adjusted - 1,
        })
    }

    pub fn from_raw_parts(ptr: *mut T, cap: usize) -> Self {
        RingBuffer {
            buffer: unsafe { RawVec::from_raw_parts(ptr, cap) },
            mask: cap - 1,
        }
    }

    #[inline]
    pub fn cap(&self) -> usize {
        self.buffer.cap()
    }

    #[inline]
    pub unsafe fn get(&self, pos: usize) -> &T {
        transmute(self.buffer.ptr().offset((pos & self.mask) as isize))
    }

    #[inline]
    pub unsafe fn get_slice(&self, pos: usize, len: usize) -> &[T] {
        transmute(from_raw_parts(self.buffer.ptr().offset((pos & self.mask) as isize), len))
    }

    #[inline]
    pub unsafe fn get_slice_mut(&self, pos: usize, len: usize) -> &mut [T] {
        transmute(from_raw_parts_mut(self.buffer.ptr().offset((pos & self.mask) as isize), len))
    }

    #[inline]
    pub unsafe fn take(&self, pos: usize) -> T {
        ptr::read(self.buffer.ptr().offset((pos & self.mask) as isize))
    }

    #[inline]
    pub unsafe fn store(&mut self, pos: usize, value: T) {
        ptr::write(self.buffer.ptr().offset((pos & self.mask) as isize), value);
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_ring_buffer_cap() {
        let mut ring: RingBuffer<u64> = RingBuffer::with_capacity(3);
        assert!(ring.cap() == 4);
    }

    #[test]
    fn test_ring_buffer_pow2_cap() {
        let mut ring: RingBuffer<u64> = RingBuffer::with_capacity(8);
        assert!(ring.cap() == 8);
    }

    #[test]
    fn test_ring_buffer_take() {
        let mut ring: RingBuffer<u64> = RingBuffer::with_capacity(4);
        unsafe {
            ring.store(0, 42u64);
            let v1 = ring.take(0);
            let v2 = ring.take(8);
            assert!(v1 == v2);
        }
    }

    #[test]
    fn test_ring_buffer_get() {
        let mut ring: RingBuffer<u64> = RingBuffer::with_capacity(4);
        unsafe {
            ring.store(0, 42u64);
            let v1 = ring.get(0);
            let v2 = ring.get(8);
            assert!(*v1 == *v2);
        }
    }

    #[test]
    fn test_ring_buffer_get_slice() {
        let mut ring: RingBuffer<u64> = RingBuffer::with_capacity(4);
        unsafe {
            ring.store(1, 42u64);
            ring.store(2, 43u64);
            ring.store(3, 44u64);

            let s1 = ring.get_slice(1, 3);
            let s2 = ring.get_slice(9, 3);
            assert_eq!(s1, &[42, 43, 44u64]);
            assert_eq!(s2, &[42, 43, 44u64]);
            assert_eq!(s1, s2);
        }
    }

    #[test]
    fn test_ring_buffer_get_slice_mut() {
        let mut ring: RingBuffer<u64> = RingBuffer::with_capacity(4);
        unsafe {
            ring.store(1, 42u64);
            ring.store(2, 43u64);
            ring.store(3, 44u64);

            let s1 = ring.get_slice_mut(1, 3);
            let s2 = ring.get_slice(9, 3);
            s1[0] = 45u64;
            assert_eq!(s1, &[45, 43, 44u64]);
            assert_eq!(s2, &[45, 43, 44u64]);
            assert_eq!(s1, s2);
        }
    }

    #[test]
    fn test_ring_buffer_from_raw_parts() {
        use std::mem;
        let mut arr = vec![0u64, 1, 2, 3];
        let mut ring: RingBuffer<u64> = RingBuffer::from_raw_parts(arr.as_mut_ptr(), arr.len());
        unsafe {
            mem::forget(arr);

            ring.store(1, 42u64);
            ring.store(2, 43u64);
            ring.store(3, 44u64);

            let s1 = ring.get_slice_mut(1, 3);
            let s2 = ring.get_slice(9, 3);

            s1[0] = 45u64;

            assert_eq!(s1, &[45, 43, 44u64]);
            assert_eq!(s2, &[45, 43, 44u64]);
            assert_eq!(s1, s2);
        }
    }

}