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 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603
//! Asynchonous I/O operaions. use std::{ hash::{Hash, Hasher}, num::NonZeroU32, os::raw::c_void, ptr::{self, NonNull}, sync::{ atomic::{AtomicPtr, AtomicUsize, Ordering}, Arc, }, time::Duration, }; use crate::{ ctx::Context, error::{Error, Result, SendResult}, message::Message, socket::Socket, util::{abort_unwind, duration_to_nng, validate_ptr}, }; use log::error; /// Represents the type of the inner "trampoline" callback function. type InnerCallback = Box<dyn Fn() + Send + Sync + 'static>; /// An asynchronous I/O context. /// /// Asynchronous operations are performed without blocking calling application /// threads. Instead the application registers a “callback” function to be /// executed when the operation is complete (whether successfully or not). This /// callback will be executed exactly once. /// /// The callback must not perform any blocking operations and must complete it’s /// execution quickly. If the callback does block, this can lead ultimately to /// an apparent "hang" or deadlock in the application. /// /// ## Example /// /// A simple server that will sleep for the requested number of milliseconds /// before responding: /// /// ``` /// use std::time::Duration; /// use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt}; /// use nng::*; /// /// const ADDRESS: &'static str = "inproc://nng/aio/example"; /// const WORKERS: usize = 10; /// /// fn server() -> Result<()> { /// // Set up the server socket but don't listen for connections yet. /// let server = Socket::new(Protocol::Rep0)?; /// /// // Create all of the worker contexts. These do *not* represent the number /// // of threads that the REP socket will use. /// let workers: Vec<_> = (0..WORKERS) /// .map(|_| { /// let ctx = Context::new(&server)?; /// let ctx_clone = ctx.clone(); /// /// // An actual program should have better error handling. /// let aio = Aio::new(move |aio, res| callback(&aio, &ctx_clone, res).unwrap())?; /// Ok((aio, ctx)) /// }) /// .collect::<Result<_>>()?; /// /// // Only after we have all of the workers do we start listening. /// server.listen(ADDRESS)?; /// /// // Now, start the workers. /// for (a, c) in &workers { /// c.recv(a)?; /// } /// /// // Now, do nothing and let the workers handle the jobs. /// std::thread::park(); /// Ok(()) /// } /// /// fn callback(aio: &Aio, ctx: &Context, res: AioResult) -> Result<()> { /// match res { /// // We successfully send the reply, wait for a new request. /// AioResult::Send(Ok(_)) => ctx.recv(aio), /// /// // We successfully received a message. /// AioResult::Recv(Ok(m)) => { /// let ms = m.as_slice().read_u64::<LittleEndian>().unwrap(); /// aio.sleep(Duration::from_millis(ms)) /// }, /// /// // We successfully slept. /// AioResult::Sleep(Ok(_)) => { /// // We could have hung on to the request `Message` to avoid an /// let _ = ctx.send(aio, Message::new()?)?; /// Ok(()) /// }, /// /// // Anything else is an error and an actual program should handle it. /// _ => panic!("Error in the AIO"), /// } /// } /// /// fn client(ms: u64) -> Result<()> { /// // Set up the client socket and connect to the server. /// let client = Socket::new(Protocol::Req0)?; /// client.dial(ADDRESS)?; /// // Create the message containing the number of milliseconds to sleep. /// let mut req = Message::new()?; /// req.write_u64::<LittleEndian>(ms).unwrap(); /// /// // Send the request to the server and wait for a response. /// client.send(req)?; /// /// // This should block for approximately `ms` milliseconds as we wait for the /// // server to sleep. /// client.recv()?; /// /// Ok(()) /// } /// /// # // The async of this makes it hard to test, so we won't /// ``` #[derive(Clone, Debug)] pub struct Aio { /// The inner AIO bits shared by all instances of this AIO. inner: Arc<Inner>, } impl Aio { /// Creates a new asynchronous I/O handle. /// /// The provided callback will be called on every single I/O event, /// successful or not. It is possible that the callback will be entered /// multiple times simultaneously. /// /// ## Panicking /// /// If the callback function panics, the program will log the panic if /// possible and then abort. Future Rustc versions will likely do the /// same for uncaught panics at FFI boundaries, so this library will /// produce the abort in order to keep things consistent. As such, the user /// is responsible for either having a callback that never panics or /// catching and handling the panic within the callback. pub fn new<F>(callback: F) -> Result<Self> where F: Fn(Aio, AioResult) + Sync + Send + 'static, { // The shared inner needs to have a fixed location before we can do anything // else, which complicates the process of building the AIO slightly. We need to // use a second, non-atomic pointer and then atomically copy it in. let inner = Arc::new(Inner { handle: AtomicPtr::new(ptr::null_mut()), state: AtomicUsize::new(State::Inactive as usize), callback: AtomicPtr::new(ptr::null_mut()), }); // Now, we create the weak reference to the inner bits that will be stored // inside of the callback. let weak = Arc::downgrade(&inner); // Wrap the user's callback in our own state-keeping logic let bounce = move || { // If we can't upgrade the pointer, then we are in the middle of dropping, // so we can't do anything except return. let cb_aio = match weak.upgrade() { Some(i) => Aio { inner: i }, None => return, }; let res = unsafe { let state = cb_aio.inner.state.load(Ordering::Acquire).into(); let aiop = cb_aio.inner.handle.load(Ordering::Relaxed); let rv = nng_sys::nng_aio_result(aiop) as u32; let res = match (state, rv) { (State::Sending, 0) => AioResult::Send(Ok(())), (State::Sending, e) => { let msgp = nng_sys::nng_aio_get_msg(aiop); let msg = Message::from_ptr(NonNull::new(msgp).unwrap()); AioResult::Send(Err((msg, NonZeroU32::new(e).unwrap().into()))) }, (State::Receiving, 0) => { let msgp = nng_sys::nng_aio_get_msg(aiop); let msg = Message::from_ptr(NonNull::new(msgp).unwrap()); AioResult::Recv(Ok(msg)) }, (State::Receiving, e) => { AioResult::Recv(Err(NonZeroU32::new(e).unwrap().into())) }, (State::Sleeping, 0) => AioResult::Sleep(Ok(())), (State::Sleeping, e) => { AioResult::Sleep(Err(NonZeroU32::new(e).unwrap().into())) }, // I am 99% sure that we will never get a callback in the Inactive state (State::Inactive, _) => unreachable!(), }; cb_aio.inner.state.store(State::Inactive as usize, Ordering::Release); res }; callback(cb_aio, res) }; // There are ways to avoid the double boxing, but unfortunately storing // the callback inside of the Inner object means that we will need some // way to mutate it and all of those options require `Sized`, which in // turn means it needs a box. let boxed: Box<InnerCallback> = Box::new(Box::new(bounce)); let callback_ptr = Box::into_raw(boxed); let mut aio: *mut nng_sys::nng_aio = ptr::null_mut(); let aiop: *mut *mut nng_sys::nng_aio = &mut aio as _; let rv = unsafe { nng_sys::nng_aio_alloc(aiop, Some(Aio::trampoline), callback_ptr as _) }; // NNG should never touch the pointer and return a non-zero code at the same // time. That being said, I'm going to be a pessimist and double check. If we do // encounter that case, the safest thing to do is make the pointer null again so // that the dropping of the inner can detect that something went south. // // This might leak memory (I'm not sure, depends on what NNG did), but a small // amount of lost memory is better than a segfaulting Rust library. if rv != 0 && !aio.is_null() { error!("NNG returned a non-null pointer from a failed function"); return Err(Error::Unknown(0)); } validate_ptr(rv, aio)?; inner.handle.store(aio, Ordering::Release); inner.callback.store(callback_ptr, Ordering::Relaxed); Ok(Self { inner }) } /// Set the timeout of asynchronous operations. /// /// This causes a timer to be started when the operation is actually /// started. If the timer expires before the operation is completed, then it /// is aborted with `Error::TimedOut`. /// /// As most operations involve some context switching, it is usually a good /// idea to allow a least a few tens of milliseconds before timing them out /// - a too small timeout might not allow the operation to properly begin /// before giving up! /// /// It is only valid to try and set this when no operations are active. pub fn set_timeout(&self, dur: Option<Duration>) -> Result<()> { // We need to check that no operations are happening and then prevent them from // happening while we set the timeout. Any state that isn't `Inactive` will do // so the choice is arbitrary. That being said, `Sleeping` feels the most // accurate. let sleeping = State::Sleeping as usize; let inactive = State::Inactive as usize; let old_state = self.inner.state.compare_and_swap(inactive, sleeping, Ordering::Acquire); if old_state == inactive { let ms = duration_to_nng(dur); let aiop = self.inner.handle.load(Ordering::Relaxed); unsafe { nng_sys::nng_aio_set_timeout(aiop, ms); } self.inner.state.store(inactive, Ordering::Release); Ok(()) } else { // Should this be `Error::TryAgain`? Err(Error::IncorrectState) } } /// Performs and asynchronous sleep operation. /// /// If the sleep finishes completely, it will never return an error. If a /// timeout has been set and it is shorter than the duration of the sleep /// operation, the sleep operation will end early with /// `Error::TimedOut`. /// /// This function will return immediately. If there is already an I/O /// operation in progress, this function will return `Error::TryAgain`. pub fn sleep(&self, dur: Duration) -> Result<()> { let sleeping = State::Sleeping as usize; let inactive = State::Inactive as usize; let old_state = self.inner.state.compare_and_swap(inactive, sleeping, Ordering::AcqRel); if old_state == inactive { let ms = duration_to_nng(Some(dur)); let aiop = self.inner.handle.load(Ordering::Relaxed); unsafe { nng_sys::nng_sleep_aio(ms, aiop); } Ok(()) } else { Err(Error::TryAgain) } } /// Blocks the current thread until the current asynchronous operation /// completes. /// /// If there are no operations running then this function returns /// immediately. This function should **not** be called from within the /// completion callback. pub fn wait(&self) { unsafe { nng_sys::nng_aio_wait(self.inner.handle.load(Ordering::Relaxed)); } } /// Cancel the currently running I/O operation. pub fn cancel(&self) { unsafe { nng_sys::nng_aio_cancel(self.inner.handle.load(Ordering::Relaxed)); } } /// Send a message on the provided socket. pub(crate) fn send_socket(&self, socket: &Socket, msg: Message) -> SendResult<()> { let inactive = State::Inactive as usize; let sending = State::Sending as usize; let old_state = self.inner.state.compare_and_swap(inactive, sending, Ordering::AcqRel); if old_state == inactive { let aiop = self.inner.handle.load(Ordering::Relaxed); unsafe { nng_sys::nng_aio_set_msg(aiop, msg.into_ptr().as_ptr()); nng_sys::nng_send_aio(socket.handle(), aiop); } Ok(()) } else { Err((msg, Error::TryAgain)) } } /// Receive a message on the provided socket. pub(crate) fn recv_socket(&self, socket: &Socket) -> Result<()> { let inactive = State::Inactive as usize; let receiving = State::Receiving as usize; let old_state = self.inner.state.compare_and_swap(inactive, receiving, Ordering::AcqRel); if old_state == inactive { let aiop = self.inner.handle.load(Ordering::Relaxed); unsafe { nng_sys::nng_recv_aio(socket.handle(), aiop); } Ok(()) } else { Err(Error::TryAgain) } } /// Send a message on the provided context. pub(crate) fn send_ctx(&self, ctx: &Context, msg: Message) -> SendResult<()> { let inactive = State::Inactive as usize; let sending = State::Sending as usize; let old_state = self.inner.state.compare_and_swap(inactive, sending, Ordering::AcqRel); if old_state == inactive { let aiop = self.inner.handle.load(Ordering::Relaxed); unsafe { nng_sys::nng_aio_set_msg(aiop, msg.into_ptr().as_ptr()); nng_sys::nng_ctx_send(ctx.handle(), aiop); } Ok(()) } else { Err((msg, Error::TryAgain)) } } /// Receive a message on the provided context. pub(crate) fn recv_ctx(&self, ctx: &Context) -> Result<()> { let inactive = State::Inactive as usize; let receiving = State::Receiving as usize; let old_state = self.inner.state.compare_and_swap(inactive, receiving, Ordering::AcqRel); if old_state == inactive { let aiop = self.inner.handle.load(Ordering::Relaxed); unsafe { nng_sys::nng_ctx_recv(ctx.handle(), aiop); } Ok(()) } else { Err(Error::TryAgain) } } /// Trampoline function for calling a closure from C. /// /// This is really unsafe because you have to be absolutely positive in that /// the type of the pointer is actually `F`. Because we're going through C /// and a `c_void`, the type system does not enforce this for us. extern "C" fn trampoline(arg: *mut c_void) { abort_unwind(|| unsafe { let callback_ptr = arg as *const InnerCallback; if callback_ptr.is_null() { // This should never happen. It means we, Nng-rs, got something wrong in the // allocation code. panic!("Null argument given to trampoline function - please open an issue"); } (*callback_ptr)() }); } } #[cfg(feature = "ffi-module")] impl Aio { /// Retrieves the `nng_aio` handle for this AIO object. /// /// The Rust AIO wrapper internally keeps track of the state of the /// `nng_aio` object in order to monitor whether or not there is a message /// owned by the `nng_aio`. If the state of the `nng_aio` object is changed /// in any way other than through the wrapper, then the wrapper will need to /// have its state updated to match. Failing to do so and then using the /// wrapper can cause segfaults. // We don't expose a `from_nng_aio` function because we have a strict // requirement on the callback function. This type fundamentally will not work // without our wrapper around the callback. pub fn nng_aio(&self) -> *mut nng_sys::nng_aio { self.inner.handle.load(Ordering::Relaxed) } /// Retrieves the current state of the wrapper. pub fn state(&self, ordering: Ordering) -> State { self.inner.state.load(ordering).into() } /// Sets the current state of the wrapper. /// /// If the provided state does not actually match the state of the `nng_aio` /// object, this can cause segfaults. pub unsafe fn set_state(&self, state: State, ordering: Ordering) { self.inner.state.store(state as usize, ordering) } } impl Hash for Aio { fn hash<H: Hasher>(&self, state: &mut H) { self.inner.handle.load(Ordering::Relaxed).hash(state) } } impl PartialEq for Aio { fn eq(&self, other: &Aio) -> bool { self.inner.handle.load(Ordering::Relaxed) == other.inner.handle.load(Ordering::Relaxed) } } impl Eq for Aio {} /// The shared inner items of a `Aio`. #[derive(Debug)] struct Inner { /// The handle to the NNG AIO object. /// /// Unfortunately, we do have to put this behind some kind of /// synchronization primitive. Fortunately, we can always access it with /// with the Relaxed ordering and, because we're almost always accessing the /// state atomic when we access the handle, we shouldn't have any /// extra cache issues. handle: AtomicPtr<nng_sys::nng_aio>, /// The current state of the AIO object, represented as a `usize`. state: AtomicUsize, /// The callback function. /// /// We're OK with the extra layer of indirection because we never call it. callback: AtomicPtr<InnerCallback>, } impl Drop for Inner { fn drop(&mut self) { // It is possible for this to be dropping while the pointer is null. The // Inner struct is created before the pointer is allocated and it will be // dropped with a null pointer if the NNG allocation fails. let aiop = self.handle.load(Ordering::Acquire); if !aiop.is_null() { // If the callback has started, it will not be able to upgrade the weak pointer // to a strong one and so it will just return from the callback. Otherwise, the // NNG call to stop the AIO will wait until all callbacks have completed and it // will prevent any more operations from starting. // // I think the call to free will do the same thing as the stop, but the online // docs aren't super clear, the header has a comment saying that the AIO must // not be running an operation when free is called, and the source doesn't // clearly (to my understanding of the code) show that it is being done. Plus, // the manual does suggest cases where stopping first is good. unsafe { nng_sys::nng_aio_stop(aiop); nng_sys::nng_aio_free(aiop); // Now that we know nothing is in the callback, we can free it. let _ = Box::from_raw(self.callback.load(Ordering::Relaxed)); } } } } /// The result of an AIO operation. // There are no "Inactive" results as I don't think there is a valid way to get any type of callback // trigger when there are no operations running. All of the "user forced" errors, such as // cancellation or timeouts, don't happen if there are no running operations. If there are no // running operations, then no non-"user forced" errors can happen. #[derive(Clone, Debug)] #[must_use] pub enum AioResult { /// Result of a send operation. Send(SendResult<()>), /// The result of a receive operation. Recv(Result<Message>), /// The result of a sleep operation. Sleep(Result<()>), } impl From<AioResult> for Result<Option<Message>> { fn from(aio_res: AioResult) -> Result<Option<Message>> { use self::AioResult::*; match aio_res { Recv(Ok(m)) => Ok(Some(m)), Send(Ok(_)) | Sleep(Ok(_)) => Ok(None), Send(Err((_, e))) | Recv(Err(e)) | Sleep(Err(e)) => Err(e), } } } /// Module used to allow the conditional visibility of the `State` type. mod state { /// Represents the state of the AIO object. #[derive(Clone, Copy, Debug, Eq, PartialEq)] #[repr(usize)] pub enum State { /// There is currently nothing happening on the AIO. Inactive, /// A send operation is currently in progress. Sending, /// A receive operation is currently in progress. Receiving, /// The AIO object is currently sleeping. Sleeping, } #[cfg_attr(feature = "ffi-module", doc(hidden))] impl From<usize> for State { fn from(atm: usize) -> State { // Fortunately, Godbolt says that this will compile to a compare, jump, and a // subtract. Three instructions isn't that bad. match atm { x if x == State::Inactive as usize => State::Inactive, x if x == State::Sending as usize => State::Sending, x if x == State::Receiving as usize => State::Receiving, x if x == State::Sleeping as usize => State::Sleeping, _ => unreachable!(), } } } } #[cfg(not(feature = "ffi-module"))] use self::state::State; #[cfg(feature = "ffi-module")] pub use self::state::State;