rtipc 0.9.0

Real-Time IPC, based on a zero-copy, wait-free circular message queue implementation
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

#[cfg(feature = "predefined_cacheline_size")]
mod cache_env;
#[cfg(not(feature = "predefined_cacheline_size"))]
mod cache_linux;
mod channel;
pub mod error;
mod header;
mod protocol;
mod queue;
mod shm;
mod socket;
mod unix;

#[macro_use]
extern crate nix;

use std::{num::NonZeroUsize, sync::atomic::AtomicU32};

#[cfg(feature = "predefined_cacheline_size")]
pub use crate::cache_env::max_cacheline_size;

#[cfg(not(feature = "predefined_cacheline_size"))]
pub use crate::cache_linux::max_cacheline_size;

pub use channel::{ChannelGroup, Consumer, Producer};
pub use error::*;
pub use queue::{ForcePushResult, PopResult, TryPushResult};
pub use socket::{Server, client_connect, client_connect_fd};

pub use nix::errno::Errno;
pub use nix::sys::eventfd::EventFd;

pub use log;

pub(crate) type AtomicIndex = AtomicU32;
pub(crate) type Index = u32;
pub(crate) const MIN_MSGS: usize = 3;

pub fn index_size() -> usize {
    std::mem::size_of::<Index>()
}

pub(crate) fn mem_align(size: usize, alignment: usize) -> usize {
    (size + alignment - 1) & !(alignment - 1)
}

pub(crate) fn cacheline_aligned(size: usize) -> usize {
    mem_align(size, max_cacheline_size())
}

#[derive(Clone)]
pub struct QueueAttributes {
    pub additional_messages: usize,
    pub message_size: NonZeroUsize,
}

impl QueueAttributes {
    fn data_size(&self) -> usize {
        let n = MIN_MSGS + self.additional_messages;

        n * cacheline_aligned(self.message_size.get())
    }

    fn queue_size(&self) -> usize {
        let n = 2 + MIN_MSGS + self.additional_messages;
        cacheline_aligned(n * std::mem::size_of::<Index>())
    }

    pub(crate) fn shm_size(&self) -> NonZeroUsize {
        NonZeroUsize::new(self.queue_size() + self.data_size()).unwrap()
    }
}

#[derive(Eq, Clone)]
pub struct ChannelAttributes {
    pub additional_messages: usize,
    pub message_size: NonZeroUsize,
    pub eventfd: bool,
    pub info: Vec<u8>,
}

impl ChannelAttributes {
    fn to_queue_attr(&self) -> QueueAttributes {
        QueueAttributes {
            additional_messages: self.additional_messages,
            message_size: self.message_size,
        }
    }
}

impl PartialEq for ChannelAttributes {
    fn eq(&self, other: &Self) -> bool {
        self.additional_messages == other.additional_messages
            && self.message_size == other.message_size
            && self.eventfd == other.eventfd
            && self.info == other.info
    }
}

#[derive(Eq, Clone)]
pub struct GroupAttributes {
    pub producers: Vec<ChannelAttributes>,
    pub consumers: Vec<ChannelAttributes>,
    pub info: Vec<u8>,
}

impl GroupAttributes {
    pub fn count_producer_eventfds(&self) -> usize {
        self.producers.iter().map(|c| c.eventfd as usize).sum()
    }

    pub fn count_consumer_eventfds(&self) -> usize {
        self.consumers.iter().map(|c| c.eventfd as usize).sum()
    }

    pub fn calc_shm_size(&self) -> usize {
        let producers_size: usize = self
            .producers
            .iter()
            .map(|c| c.to_queue_attr().shm_size().get())
            .sum();

        let consumers_size: usize = self
            .consumers
            .iter()
            .map(|c| c.to_queue_attr().shm_size().get())
            .sum();

        producers_size + consumers_size
    }
}

impl PartialEq for GroupAttributes {
    fn eq(&self, other: &Self) -> bool {
        self.consumers == other.consumers
            && self.producers == other.producers
            && self.info == other.info
    }
}