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 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
#![cfg(target_os = "linux")] //! Linux [Transparent Inter Process Communication (TIPC)][1] bindings for Rust //! //! [1]: http://tipc.io/ //! //! This library provides bindings for some of the more common TIPC operations. //! //! ## Prerequisites //! * Linux OS (version >= 4.14 for communication groups) //! * Clang compiler //! * TIPC kernel module enabled (`sudo modprobe tipc`) //! //! ### Open a socket, bind to an address and listen for messages //! ```no_run //! use tipc::{TipcConn, SockType, TipcScope}; //! let conn = TipcConn::new(SockType::SockRdm).unwrap(); //! //! conn.bind(12345, 0, 0, TipcScope::Cluster).expect("Unable to bind to address"); //! let mut buf: [u8; tipc::MAX_MSG_SIZE] = [0; tipc::MAX_MSG_SIZE]; //! loop { //! let msg_size = conn.recv(&mut buf).unwrap(); //! println!("received: {}", std::str::from_utf8(&buf[0..msg_size as usize]).unwrap()) //! } //! ``` //! //! ### Join a group and listen for group membership events or messages //! Note: Joining a group automatically binds to an address and creates the group //! if it doesn't already exist. //! ```no_run //! use tipc::{TipcConn, SockType, TipcScope, GroupMessage}; //! let mut conn = TipcConn::new(SockType::SockRdm).unwrap(); //! //! conn.join(12345, 1, TipcScope::Cluster).expect("Unable to join group"); //! //! // Listen for messages //! loop { //! match conn.recvfrom().unwrap() { //! GroupMessage::MemberEvent(e) => { //! let action = if e.joined() { "joined" } else { "left" }; //! println!("group member {}:{} {}", e.socket_ref(), e.node_ref(), action); //! }, //! GroupMessage::DataEvent(d) => { //! println!("received message: {}", std::str::from_utf8(&d).unwrap()); //! } //! } //! } //! ``` #![doc(html_root_url = "https://docs.rs/tipc/0.1.2")] use std::os::raw::{c_int, c_void}; mod bindings; mod cmd; mod error; mod group; use bindings::*; pub use cmd::{attach_to_interface, set_host_addr}; pub use error::TipcError; pub use group::{GroupMessage, Membership}; pub const MAX_MSG_SIZE: usize = TIPC_MAX_USER_MSG_SIZE as usize; #[derive(Debug, Clone, Copy)] /// The scope to use when binding to an address. /// ``` /// # use tipc::TipcScope; /// assert_eq!(TipcScope::Cluster as u32, 2); /// assert_eq!(TipcScope::Node as u32, 3); /// ``` pub enum TipcScope { Cluster = 2, Node = 3, } /// TIPC socket type to be used. #[derive(Clone, Copy)] pub enum SockType { SockStream = __socket_type_SOCK_STREAM as isize, SockDgram = __socket_type_SOCK_DGRAM as isize, SockSeqpacket = __socket_type_SOCK_SEQPACKET as isize, SockRdm = __socket_type_SOCK_RDM as isize, } type TipcResult<T> = Result<T, TipcError>; /// Wrapper around a socket to provide convenience functions for binding, sending data, etc. #[derive(Debug)] pub struct TipcConn { socket: c_int, socket_ref: u32, node_ref: u32, buf: Vec<u8>, in_group: bool, } impl Drop for TipcConn { fn drop(&mut self) { self.close(); } } impl TipcConn { pub fn socket_ref(&self) -> u32 { self.socket_ref } pub fn node_ref(&self) -> u32 { self.node_ref } fn close(&self) { unsafe { tipc_close(self.socket) }; } /// Create a new conn of a specific socket type. pub fn new(socktype: SockType) -> TipcResult<Self> { let socket = unsafe { tipc_socket(socktype as i32) }; if socket < 0 { return Err(TipcError::new("Unable to initialize socket")); } let (socket_ref, node_ref) = socket_and_node_refs(socket)?; Ok(Self { socket, socket_ref, node_ref, buf: [0; MAX_MSG_SIZE].to_vec(), in_group: false, }) } /// Set the socket to be non-blocking. This causes socket calls to return a /// `TipcError` with EAGAIN | EWOULDBLOCK error code set when it's not possible /// to send/recv on the socket. pub fn set_sock_non_block(&mut self) -> TipcResult<()> { self.socket = unsafe { tipc_sock_non_block(self.socket) }; Ok(()) } /// Connect a stream socket. pub fn connect( &self, service_type: u32, service_instance: u32, node: u32, scope: TipcScope, ) -> TipcResult<()> { let addr = tipc_addr { type_: service_type, instance: service_instance, node, scope: scope as u32, }; let r = unsafe { tipc_connect(self.socket, &addr) }; if r < 0 { return Err(TipcError::new("Error connecting socket")); } Ok(()) } /// Listen for incoming connections on a stream socket. /// See Linux [listen(2)](https://man7.org/linux/man-pages/man2/listen.2.html) /// for definition of `backlog`. pub fn listen(&self, backlog: i32) -> TipcResult<()> { let r = unsafe { tipc_listen(self.socket, backlog) }; if r < 0 { return Err(TipcError::new("Unable to listen for new connections")); } Ok(()) } /// Accept a connection on a listening socket. pub fn accept(&self) -> TipcResult<Self> { let mut addr = tipc_addr { type_: 0, instance: 0, node: 0, scope: 0, }; let socket = unsafe { tipc_accept(self.socket, &mut addr) }; if socket < 0 { return Err(TipcError::new("Error accepting a connection")); } let (socket_ref, node_ref) = socket_and_node_refs(socket)?; Ok(Self { socket, socket_ref, node_ref, buf: [0; MAX_MSG_SIZE].to_vec(), in_group: self.in_group, }) } /// Send data to the socket. Returns the number of bytes sent. pub fn send(&self, data: &[u8]) -> TipcResult<i32> { let r = unsafe { tipc_send( self.socket, data.as_ptr() as *const c_void, data.len() as u64, ) }; if r < 0 { return Err(TipcError::new("Send error")); } Ok(r) } /// Broadcast data to every node in a group. Returns the number /// of bytes sent. pub fn broadcast(&self, data: &[u8]) -> TipcResult<i32> { self.send(data) } /// Anycast data to a random node bound to `service_type` and `service_instance`. TIPC /// protocol will round-robin available hosts. If this call is made in a group, TIPC will /// also take into consideration the destination's load, possible passing it by to /// pick another node. pub fn anycast( &self, data: &[u8], service_type: u32, service_instance: u32, scope: TipcScope, ) -> TipcResult<i32> { let addr = tipc_addr { type_: service_type, instance: service_instance, node: 0, scope: scope as u32, }; let bytes_sent = self.send_to(data, &addr); if bytes_sent < 0 { return Err(TipcError::new("Anycast error")); } Ok(bytes_sent) } /// Unicast data to a specific socket address. Returns the number of bytes sent. pub fn unicast( &self, data: &[u8], socket_ref: u32, node_ref: u32, scope: TipcScope, ) -> TipcResult<i32> { let addr = tipc_addr { type_: 0, instance: socket_ref, node: node_ref, scope: scope as u32, }; let bytes_sent = self.send_to(data, &addr); if bytes_sent < 0 { return Err(TipcError::new("Unicast error")); } Ok(bytes_sent) } /// Multicast data to every node bound to `service_type`. If not part of a group, the message /// will be sent to any node bound in the range of `lower` to `upper`. If part of a group, the /// message will be sent only to those nodes that are bound to `lower`. Returns the number of /// bytes sent. pub fn multicast( &self, data: &[u8], service_type: u32, lower: u32, upper: u32, scope: TipcScope, ) -> TipcResult<i32> { let node = if self.in_group { lower } else { upper }; let addr = tipc_addr { type_: service_type, instance: lower, node, scope: scope as u32, }; let bytes_sent = unsafe { tipc_mcast( self.socket, data.as_ptr() as *const c_void, data.len() as size_t, &addr, ) }; if bytes_sent < 0 { return Err(TipcError::new("Multicast error")); } Ok(bytes_sent) } /// Join a group. If the group doesn't exist, it is automatically created. pub fn join(&mut self, group_id: u32, member_id: u32, scope: TipcScope) -> TipcResult<()> { let mut addr = tipc_addr { type_: group_id, instance: member_id, node: 0, scope: scope as u32, }; let r = unsafe { tipc_join(self.socket, &mut addr, true, false) }; if r < 0 { return Err(TipcError::new("Unable to join group")); } self.in_group = true; Ok(()) } /// Leave a group. pub fn leave(&mut self) -> TipcResult<()> { let r = unsafe { tipc_leave(self.socket) }; if r < 0 { return Err(TipcError::new("Leave error")); } self.in_group = false; Ok(()) } /// Bind to an address and range. pub fn bind( &self, service_type: u32, lower: u32, upper: u32, scope: TipcScope, ) -> TipcResult<()> { let r = unsafe { tipc_bind(self.socket, service_type, lower, upper, scope as u32) }; if r < 0 { return Err(TipcError::new("Error binding to socket address")); } Ok(()) } /// Receive data from a socket, copying it to the passed in buffer. Returns /// the number of bytes received. /// # Example /// ```no_run /// # use tipc::{TipcConn, SockType, TipcScope}; /// # use tipc; /// let conn = TipcConn::new(SockType::SockRdm).unwrap(); /// conn.bind(88888, 0, 10, TipcScope::Cluster).expect("Unable to bind to address"); /// let mut buf: [u8; tipc::MAX_MSG_SIZE] = [0; tipc::MAX_MSG_SIZE]; /// loop { /// let msg_size = conn.recv(&mut buf).unwrap(); /// println!("{}", std::str::from_utf8(&buf[0..msg_size as usize]).unwrap()) /// } pub fn recv(&self, buf: &mut [u8; MAX_MSG_SIZE]) -> TipcResult<i32> { let msg_size = unsafe { tipc_recv( self.socket, buf.as_ptr() as *mut c_void, MAX_MSG_SIZE as size_t, false, ) }; if msg_size < 0 { return Err(TipcError::new("Receive error")); } Ok(msg_size) } /// Receive data or group membership messages from the socket. /// # Example /// ```no_run /// # use tipc::{TipcConn, SockType, TipcScope, GroupMessage}; /// # use tipc; /// let mut conn = TipcConn::new(SockType::SockRdm).unwrap(); /// conn.join(88888, 10, TipcScope::Cluster).expect("Unable to join group"); /// /// loop { /// match conn.recvfrom() { /// Ok(msg) => match msg { /// GroupMessage::DataEvent(d) => { /// println!("group message: {}", std::str::from_utf8(&d).unwrap()) /// }, /// GroupMessage::MemberEvent(e) => { /// let event_type = if e.joined() { "joined" } else { "left" }; /// println!("member {} {}", e, event_type); /// }, /// } /// Err(e) => panic!("error receiving from socket: {}", e), /// } /// } /// ``` pub fn recvfrom(&self) -> TipcResult<GroupMessage> { let mut socket_addr = tipc_addr { type_: 0, instance: 0, node: 0, scope: 0, }; let mut member_addr = tipc_addr { type_: 0, instance: 0, node: 0, scope: 0, }; let mut err = 0; let msg_size = unsafe { tipc_recvfrom( self.socket, self.buf.as_ptr() as *mut c_void, self.buf.len() as u64, &mut socket_addr, &mut member_addr, &mut err, ) }; if msg_size < 0 { return Err(TipcError::new("recvfrom error")); } let msg = if msg_size == 0 { GroupMessage::MemberEvent(Membership { socket_ref: socket_addr.instance, node_ref: socket_addr.node, service_address: member_addr.type_, service_instance: member_addr.instance, joined: if err == 0 { true } else { false }, }) } else { let data = self.buf[0..msg_size as usize].to_vec(); GroupMessage::DataEvent(data) }; Ok(msg) } fn send_to(&self, data: &[u8], addr: &tipc_addr) -> c_int { unsafe { tipc_sendto( self.socket, data.as_ptr() as *const c_void, data.len() as size_t, addr, ) } } } fn socket_and_node_refs(socket: c_int) -> TipcResult<(u32, u32)> { let mut addr = tipc_addr { type_: 0, instance: 0, node: 0, scope: 0, }; let r = unsafe { tipc_sockaddr(socket, &mut addr) }; if r < 0 { return Err(TipcError::new("Unable to determine socket and node refs")); } Ok((addr.instance, addr.node)) }