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 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
//! Interprocess Communication pipes
//!
//! A pipe is a section of shared memory that processes use for communication.
//! The process that creates a pipe is the _pipe server_. A process that connects
//! to a pipe is a _pipe client_. One process writes information to the pipe, then
//! the other process reads the information from the pipe. This overview
//! describes how to create, manage, and use pipes.
//!
//! There are two types of pipes: [anonymous pipes](#fn.anonymous.html) and
//! [named pipes](#fn.named.html). Anonymous pipes require less overhead than
//! named pipes, but offer limited services.
//!
//! # Anonymous pipes
//!
//! An anonymous pipe is an unnamed, one-way pipe that typically transfers data
//! between a parent process and a child process. Anonymous pipes are always
//! local; they cannot be used for communication over a network.
//!
//! # Named pipes
//!
//! A *named pipe* is a named, one-way or duplex pipe for communication between
//! the pipe server and one or more pipe clients. All instances of a named pipe
//! share the same pipe name, but each instance has its own buffers and handles,
//! and provides a separate conduit for client/server communication. The use of
//! instances enables multiple pipe clients to use the same named pipe
//! simultaneously.
//!
//! Any process can access named pipes, subject to security checks, making named
//! pipes an easy form of communication between related or unrelated processes.
//!
//! Any process can act as both a server and a client, making peer-to-peer
//! communication possible. As used here, the term pipe server refers to a
//! process that creates a named pipe, and the term pipe client refers to a
//! process that connects to an instance of a named pipe.
//!
//! Named pipes can be used to provide communication between processes on the
//! same computer or between processes on different computers across a network.
//! If the server service is running, all named pipes are accessible remotely. If
//! you intend to use a named pipe locally only, deny access to NT
//! AUTHORITY\\NETWORK or switch to local RPC.
//!
//! # References
//!
//! - [win32 pipe docs](https://github.com/MicrosoftDocs/win32/blob/docs/desktop-src/ipc/pipes.md)
use crate::FALSE;
use std::cell::RefCell;
use std::ffi::OsStr;
use std::fs::{File, OpenOptions};
use std::io;
use std::io::{Read, Write};
use std::os::windows::ffi::OsStrExt;
use std::os::windows::io::{AsRawHandle, FromRawHandle, IntoRawHandle, RawHandle};
use std::time::Duration;
use crate::handle::Handle;
use crate::overlapped::Overlapped;
use windows_sys::Win32::Foundation::{
ERROR_IO_PENDING, ERROR_NO_DATA, ERROR_PIPE_BUSY, ERROR_PIPE_CONNECTED, HANDLE,
INVALID_HANDLE_VALUE,
};
use windows_sys::Win32::Security::SECURITY_ATTRIBUTES;
use windows_sys::Win32::Storage::FileSystem::{
FlushFileBuffers, FILE_FLAG_FIRST_PIPE_INSTANCE, FILE_FLAG_OVERLAPPED, PIPE_ACCESS_DUPLEX,
PIPE_ACCESS_INBOUND, PIPE_ACCESS_OUTBOUND,
};
use windows_sys::Win32::System::Pipes::{
ConnectNamedPipe, CreateNamedPipeW, CreatePipe, DisconnectNamedPipe, WaitNamedPipeW,
PIPE_REJECT_REMOTE_CLIENTS, PIPE_TYPE_BYTE, PIPE_UNLIMITED_INSTANCES,
};
use windows_sys::Win32::System::IO::{GetOverlappedResult, OVERLAPPED};
/// Readable half of an anonymous pipe.
#[derive(Debug)]
pub struct AnonRead(Handle);
/// Writable half of an anonymous pipe.
#[derive(Debug)]
pub struct AnonWrite(Handle);
/// A named pipe that can accept connections.
#[derive(Debug)]
pub struct NamedPipe(Handle);
/// A builder structure for creating a new named pipe.
#[derive(Debug)]
pub struct NamedPipeBuilder {
name: Vec<u16>,
dwOpenMode: u32,
dwPipeMode: u32,
nMaxInstances: u32,
nOutBufferSize: u32,
nInBufferSize: u32,
nDefaultTimeOut: u32,
}
/// Creates a new anonymous in-memory pipe, returning the read/write ends of the
/// pipe.
///
/// The buffer size for this pipe may also be specified, but the system will
/// normally use this as a suggestion and it's not guaranteed that the buffer
/// will be precisely this size.
pub fn anonymous(buffer_size: u32) -> io::Result<(AnonRead, AnonWrite)> {
let mut read = 0 as HANDLE;
let mut write = 0 as HANDLE;
crate::cvt(unsafe { CreatePipe(&mut read, &mut write, 0 as *mut _, buffer_size) })?;
Ok((AnonRead(Handle::new(read)), AnonWrite(Handle::new(write))))
}
impl Read for AnonRead {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
self.0.read(buf)
}
}
impl<'a> Read for &'a AnonRead {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
self.0.read(buf)
}
}
impl AsRawHandle for AnonRead {
fn as_raw_handle(&self) -> RawHandle {
self.0.raw() as RawHandle
}
}
impl FromRawHandle for AnonRead {
unsafe fn from_raw_handle(handle: RawHandle) -> AnonRead {
AnonRead(Handle::new(handle as HANDLE))
}
}
impl IntoRawHandle for AnonRead {
fn into_raw_handle(self) -> RawHandle {
self.0.into_raw() as RawHandle
}
}
impl Write for AnonWrite {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
self.0.write(buf)
}
fn flush(&mut self) -> io::Result<()> {
Ok(())
}
}
impl<'a> Write for &'a AnonWrite {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
self.0.write(buf)
}
fn flush(&mut self) -> io::Result<()> {
Ok(())
}
}
impl AsRawHandle for AnonWrite {
fn as_raw_handle(&self) -> RawHandle {
self.0.raw() as RawHandle
}
}
impl FromRawHandle for AnonWrite {
unsafe fn from_raw_handle(handle: RawHandle) -> AnonWrite {
AnonWrite(Handle::new(handle as HANDLE))
}
}
impl IntoRawHandle for AnonWrite {
fn into_raw_handle(self) -> RawHandle {
self.0.into_raw() as RawHandle
}
}
/// A convenience function to connect to a named pipe.
///
/// This function will block the calling process until it can connect to the
/// pipe server specified by `addr`. This will use `NamedPipe::wait` internally
/// to block until it can connect.
pub fn connect<A: AsRef<OsStr>>(addr: A) -> io::Result<File> {
_connect(addr.as_ref())
}
fn _connect(addr: &OsStr) -> io::Result<File> {
let mut r = OpenOptions::new();
let mut w = OpenOptions::new();
let mut rw = OpenOptions::new();
r.read(true);
w.write(true);
rw.read(true).write(true);
loop {
let res = rw
.open(addr)
.or_else(|_| r.open(addr))
.or_else(|_| w.open(addr));
match res {
Ok(f) => return Ok(f),
Err(ref e) if e.raw_os_error() == Some(ERROR_PIPE_BUSY as i32) => {}
Err(e) => return Err(e),
}
NamedPipe::wait(addr, Some(Duration::new(20, 0)))?;
}
}
impl NamedPipe {
/// Creates a new initial named pipe.
///
/// This function is equivalent to:
///
/// ```
/// use miow::pipe::NamedPipeBuilder;
///
/// # let addr = "foo";
/// NamedPipeBuilder::new(addr)
/// .first(true)
/// .inbound(true)
/// .outbound(true)
/// .out_buffer_size(65536)
/// .in_buffer_size(65536)
/// .create();
/// ```
pub fn new<A: AsRef<OsStr>>(addr: A) -> io::Result<NamedPipe> {
NamedPipeBuilder::new(addr).create()
}
/// Waits until either a time-out interval elapses or an instance of the
/// specified named pipe is available for connection.
///
/// If this function succeeds the process can create a `File` to connect to
/// the named pipe.
pub fn wait<A: AsRef<OsStr>>(addr: A, timeout: Option<Duration>) -> io::Result<()> {
NamedPipe::_wait(addr.as_ref(), timeout)
}
fn _wait(addr: &OsStr, timeout: Option<Duration>) -> io::Result<()> {
let addr = addr.encode_wide().chain(Some(0)).collect::<Vec<_>>();
let timeout = crate::dur2ms(timeout);
crate::cvt(unsafe { WaitNamedPipeW(addr.as_ptr() as _, timeout) }).map(|_| ())
}
/// Connects this named pipe to a client, blocking until one becomes
/// available.
///
/// This function will call the `ConnectNamedPipe` function to await for a
/// client to connect. This can be called immediately after the pipe is
/// created, or after it has been disconnected from a previous client.
pub fn connect(&self) -> io::Result<()> {
match crate::cvt(unsafe { ConnectNamedPipe(self.0.raw(), 0 as *mut _) }) {
Ok(_) => Ok(()),
Err(ref e) if e.raw_os_error() == Some(ERROR_PIPE_CONNECTED as i32) => Ok(()),
Err(e) => Err(e),
}
}
/// Issue a connection request with the specified overlapped operation.
///
/// This function will issue a request to connect a client to this server,
/// returning immediately after starting the overlapped operation.
///
/// If this function immediately succeeds then `Ok(true)` is returned. If
/// the overlapped operation is enqueued and pending, then `Ok(false)` is
/// returned. Otherwise an error is returned indicating what went wrong.
///
/// # Unsafety
///
/// This function is unsafe because the kernel requires that the
/// `overlapped` pointer is valid until the end of the I/O operation. The
/// kernel also requires that `overlapped` is unique for this I/O operation
/// and is not in use for any other I/O.
///
/// To safely use this function callers must ensure that this pointer is
/// valid until the I/O operation is completed, typically via completion
/// ports and waiting to receive the completion notification on the port.
pub unsafe fn connect_overlapped(&self, overlapped: *mut OVERLAPPED) -> io::Result<bool> {
match crate::cvt(ConnectNamedPipe(self.0.raw(), overlapped)) {
Ok(_) => Ok(true),
Err(ref e) if e.raw_os_error() == Some(ERROR_PIPE_CONNECTED as i32) => Ok(true),
Err(ref e) if e.raw_os_error() == Some(ERROR_IO_PENDING as i32) => Ok(false),
Err(ref e) if e.raw_os_error() == Some(ERROR_NO_DATA as i32) => Ok(true),
Err(e) => Err(e),
}
}
/// Disconnects this named pipe from any connected client.
pub fn disconnect(&self) -> io::Result<()> {
crate::cvt(unsafe { DisconnectNamedPipe(self.0.raw()) }).map(|_| ())
}
/// Issues an overlapped read operation to occur on this pipe.
///
/// This function will issue an asynchronous read to occur in an overlapped
/// fashion, returning immediately. The `buf` provided will be filled in
/// with data and the request is tracked by the `overlapped` function
/// provided.
///
/// If the operation succeeds immediately, `Ok(Some(n))` is returned where
/// `n` is the number of bytes read. If an asynchronous operation is
/// enqueued, then `Ok(None)` is returned. Otherwise if an error occurred
/// it is returned.
///
/// When this operation completes (or if it completes immediately), another
/// mechanism must be used to learn how many bytes were transferred (such as
/// looking at the filed in the IOCP status message).
///
/// # Unsafety
///
/// This function is unsafe because the kernel requires that the `buf` and
/// `overlapped` pointers to be valid until the end of the I/O operation.
/// The kernel also requires that `overlapped` is unique for this I/O
/// operation and is not in use for any other I/O.
///
/// To safely use this function callers must ensure that the pointers are
/// valid until the I/O operation is completed, typically via completion
/// ports and waiting to receive the completion notification on the port.
pub unsafe fn read_overlapped(
&self,
buf: &mut [u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>> {
self.0.read_overlapped(buf, overlapped)
}
/// Issues an overlapped write operation to occur on this pipe.
///
/// This function will issue an asynchronous write to occur in an overlapped
/// fashion, returning immediately. The `buf` provided will be filled in
/// with data and the request is tracked by the `overlapped` function
/// provided.
///
/// If the operation succeeds immediately, `Ok(Some(n))` is returned where
/// `n` is the number of bytes written. If an asynchronous operation is
/// enqueued, then `Ok(None)` is returned. Otherwise if an error occurred
/// it is returned.
///
/// When this operation completes (or if it completes immediately), another
/// mechanism must be used to learn how many bytes were transferred (such as
/// looking at the filed in the IOCP status message).
///
/// # Unsafety
///
/// This function is unsafe because the kernel requires that the `buf` and
/// `overlapped` pointers to be valid until the end of the I/O operation.
/// The kernel also requires that `overlapped` is unique for this I/O
/// operation and is not in use for any other I/O.
///
/// To safely use this function callers must ensure that the pointers are
/// valid until the I/O operation is completed, typically via completion
/// ports and waiting to receive the completion notification on the port.
pub unsafe fn write_overlapped(
&self,
buf: &[u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>> {
self.0.write_overlapped(buf, overlapped)
}
/// Calls the `GetOverlappedResult` function to get the result of an
/// overlapped operation for this handle.
///
/// This function takes the `OVERLAPPED` argument which must have been used
/// to initiate an overlapped I/O operation, and returns either the
/// successful number of bytes transferred during the operation or an error
/// if one occurred.
///
/// # Unsafety
///
/// This function is unsafe as `overlapped` must have previously been used
/// to execute an operation for this handle, and it must also be a valid
/// pointer to an `Overlapped` instance.
///
/// # Panics
///
/// This function will panic
pub unsafe fn result(&self, overlapped: *mut OVERLAPPED) -> io::Result<usize> {
let mut transferred = 0;
let r = GetOverlappedResult(self.0.raw(), overlapped, &mut transferred, FALSE);
if r == 0 {
Err(io::Error::last_os_error())
} else {
Ok(transferred as usize)
}
}
}
thread_local! {
static NAMED_PIPE_OVERLAPPED: RefCell<Option<Overlapped>> = RefCell::new(None);
}
/// Call a function with a threadlocal `Overlapped`. The function `f` should be
/// sure that the event is reset, either manually or by a thread being released.
fn with_threadlocal_overlapped<F>(f: F) -> io::Result<usize>
where
F: FnOnce(&Overlapped) -> io::Result<usize>,
{
NAMED_PIPE_OVERLAPPED.with(|overlapped| {
let mut mborrow = overlapped.borrow_mut();
if let None = *mborrow {
let op = Overlapped::initialize_with_autoreset_event()?;
*mborrow = Some(op);
}
f(mborrow.as_ref().unwrap())
})
}
impl Read for NamedPipe {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
// This is necessary because the pipe is opened with `FILE_FLAG_OVERLAPPED`.
with_threadlocal_overlapped(|overlapped| unsafe {
self.0
.read_overlapped_wait(buf, overlapped.raw() as *mut OVERLAPPED)
})
}
}
impl<'a> Read for &'a NamedPipe {
fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
// This is necessary because the pipe is opened with `FILE_FLAG_OVERLAPPED`.
with_threadlocal_overlapped(|overlapped| unsafe {
self.0
.read_overlapped_wait(buf, overlapped.raw() as *mut OVERLAPPED)
})
}
}
impl Write for NamedPipe {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
// This is necessary because the pipe is opened with `FILE_FLAG_OVERLAPPED`.
with_threadlocal_overlapped(|overlapped| unsafe {
self.0
.write_overlapped_wait(buf, overlapped.raw() as *mut OVERLAPPED)
})
}
fn flush(&mut self) -> io::Result<()> {
<&NamedPipe as Write>::flush(&mut &*self)
}
}
impl<'a> Write for &'a NamedPipe {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
// This is necessary because the pipe is opened with `FILE_FLAG_OVERLAPPED`.
with_threadlocal_overlapped(|overlapped| unsafe {
self.0
.write_overlapped_wait(buf, overlapped.raw() as *mut OVERLAPPED)
})
}
fn flush(&mut self) -> io::Result<()> {
crate::cvt(unsafe { FlushFileBuffers(self.0.raw()) }).map(|_| ())
}
}
impl AsRawHandle for NamedPipe {
fn as_raw_handle(&self) -> RawHandle {
self.0.raw() as RawHandle
}
}
impl FromRawHandle for NamedPipe {
unsafe fn from_raw_handle(handle: RawHandle) -> NamedPipe {
NamedPipe(Handle::new(handle as HANDLE))
}
}
impl IntoRawHandle for NamedPipe {
fn into_raw_handle(self) -> RawHandle {
self.0.into_raw() as RawHandle
}
}
fn flag(slot: &mut u32, on: bool, val: u32) {
if on {
*slot |= val;
} else {
*slot &= !val;
}
}
impl NamedPipeBuilder {
/// Creates a new named pipe builder with the default settings.
pub fn new<A: AsRef<OsStr>>(addr: A) -> NamedPipeBuilder {
NamedPipeBuilder {
name: addr.as_ref().encode_wide().chain(Some(0)).collect(),
dwOpenMode: PIPE_ACCESS_DUPLEX | FILE_FLAG_FIRST_PIPE_INSTANCE | FILE_FLAG_OVERLAPPED,
dwPipeMode: PIPE_TYPE_BYTE,
nMaxInstances: PIPE_UNLIMITED_INSTANCES,
nOutBufferSize: 65536,
nInBufferSize: 65536,
nDefaultTimeOut: 0,
}
}
/// Indicates whether data is allowed to flow from the client to the server.
pub fn inbound(&mut self, allowed: bool) -> &mut Self {
flag(&mut self.dwOpenMode, allowed, PIPE_ACCESS_INBOUND);
self
}
/// Indicates whether data is allowed to flow from the server to the client.
pub fn outbound(&mut self, allowed: bool) -> &mut Self {
flag(&mut self.dwOpenMode, allowed, PIPE_ACCESS_OUTBOUND);
self
}
/// Indicates that this pipe must be the first instance.
///
/// If set to true, then creation will fail if there's already an instance
/// elsewhere.
pub fn first(&mut self, first: bool) -> &mut Self {
flag(&mut self.dwOpenMode, first, FILE_FLAG_FIRST_PIPE_INSTANCE);
self
}
/// Indicates whether this server can accept remote clients or not.
pub fn accept_remote(&mut self, accept: bool) -> &mut Self {
flag(&mut self.dwPipeMode, !accept, PIPE_REJECT_REMOTE_CLIENTS);
self
}
/// Specifies the maximum number of instances of the server pipe that are
/// allowed.
///
/// The first instance of a pipe can specify this value. A value of 255
/// indicates that there is no limit to the number of instances.
pub fn max_instances(&mut self, instances: u8) -> &mut Self {
self.nMaxInstances = instances as u32;
self
}
/// Specifies the number of bytes to reserver for the output buffer
pub fn out_buffer_size(&mut self, buffer: u32) -> &mut Self {
self.nOutBufferSize = buffer as u32;
self
}
/// Specifies the number of bytes to reserver for the input buffer
pub fn in_buffer_size(&mut self, buffer: u32) -> &mut Self {
self.nInBufferSize = buffer as u32;
self
}
/// Using the options in this builder, attempt to create a new named pipe.
///
/// This function will call the `CreateNamedPipe` function and return the
/// result.
pub fn create(&mut self) -> io::Result<NamedPipe> {
unsafe { self.with_security_attributes(::std::ptr::null_mut()) }
}
/// Using the options in the builder and the provided security attributes, attempt to create a
/// new named pipe. This function has to be called with a valid pointer to a
/// `SECURITY_ATTRIBUTES` struct that will stay valid for the lifetime of this function or a
/// null pointer.
///
/// This function will call the `CreateNamedPipe` function and return the
/// result.
pub unsafe fn with_security_attributes(
&mut self,
attrs: *mut SECURITY_ATTRIBUTES,
) -> io::Result<NamedPipe> {
let h = CreateNamedPipeW(
self.name.as_mut_ptr(),
self.dwOpenMode,
self.dwPipeMode,
self.nMaxInstances,
self.nOutBufferSize,
self.nInBufferSize,
self.nDefaultTimeOut,
attrs,
);
if h == INVALID_HANDLE_VALUE {
Err(io::Error::last_os_error())
} else {
Ok(NamedPipe(Handle::new(h)))
}
}
}
#[cfg(test)]
mod tests {
use std::fs::{File, OpenOptions};
use std::io::prelude::*;
use std::sync::mpsc::channel;
use std::thread;
use std::time::Duration;
use rand::{distributions::Alphanumeric, thread_rng, Rng};
use super::{anonymous, NamedPipe, NamedPipeBuilder};
use crate::iocp::CompletionPort;
use crate::Overlapped;
fn name() -> String {
let name = thread_rng()
.sample_iter(Alphanumeric)
.take(30)
.map(char::from)
.collect::<String>();
format!(r"\\.\pipe\{}", name)
}
#[test]
fn anon() {
let (mut read, mut write) = t!(anonymous(256));
assert_eq!(t!(write.write(&[1, 2, 3])), 3);
let mut b = [0; 10];
assert_eq!(t!(read.read(&mut b)), 3);
assert_eq!(&b[..3], &[1, 2, 3]);
}
#[test]
fn named_not_first() {
let name = name();
let _a = t!(NamedPipe::new(&name));
assert!(NamedPipe::new(&name).is_err());
t!(NamedPipeBuilder::new(&name).first(false).create());
}
#[test]
fn named_connect() {
let name = name();
let a = t!(NamedPipe::new(&name));
let t = thread::spawn(move || {
t!(File::open(name));
});
t!(a.connect());
t!(a.disconnect());
t!(t.join());
}
#[test]
fn named_wait() {
let name = name();
let a = t!(NamedPipe::new(&name));
let (tx, rx) = channel();
let t = thread::spawn(move || {
t!(NamedPipe::wait(&name, None));
t!(File::open(&name));
assert!(NamedPipe::wait(&name, Some(Duration::from_millis(1))).is_err());
t!(tx.send(()));
});
t!(a.connect());
t!(rx.recv());
t!(a.disconnect());
t!(t.join());
}
#[test]
fn named_connect_overlapped() {
let name = name();
let a = t!(NamedPipe::new(&name));
let t = thread::spawn(move || {
t!(File::open(name));
});
let cp = t!(CompletionPort::new(1));
t!(cp.add_handle(2, &a));
let over = Overlapped::zero();
unsafe {
t!(a.connect_overlapped(over.raw()));
}
let status = t!(cp.get(None));
assert_eq!(status.bytes_transferred(), 0);
assert_eq!(status.token(), 2);
assert_eq!(status.overlapped(), over.raw());
t!(t.join());
}
#[test]
fn named_read_write() {
let name = name();
let mut a = t!(NamedPipe::new(&name));
let t = thread::spawn(move || {
let mut f = t!(OpenOptions::new().read(true).write(true).open(name));
t!(f.write_all(&[1, 2, 3]));
let mut b = [0; 10];
assert_eq!(t!(f.read(&mut b)), 3);
assert_eq!(&b[..3], &[1, 2, 3]);
});
t!(a.connect());
let mut b = [0; 10];
assert_eq!(t!(a.read(&mut b)), 3);
assert_eq!(&b[..3], &[1, 2, 3]);
t!(a.write_all(&[1, 2, 3]));
t!(a.flush());
t!(a.disconnect());
t!(t.join());
}
#[test]
fn named_read_write_multi() {
for _ in 0..5 {
named_read_write()
}
}
#[test]
fn named_read_write_multi_same_thread() {
let name1 = name();
let mut a1 = t!(NamedPipe::new(&name1));
let name2 = name();
let mut a2 = t!(NamedPipe::new(&name2));
let t = thread::spawn(move || {
let mut f = t!(OpenOptions::new().read(true).write(true).open(name1));
t!(f.write_all(&[1, 2, 3]));
let mut b = [0; 10];
assert_eq!(t!(f.read(&mut b)), 3);
assert_eq!(&b[..3], &[1, 2, 3]);
let mut f = t!(OpenOptions::new().read(true).write(true).open(name2));
t!(f.write_all(&[1, 2, 3]));
let mut b = [0; 10];
assert_eq!(t!(f.read(&mut b)), 3);
assert_eq!(&b[..3], &[1, 2, 3]);
});
t!(a1.connect());
let mut b = [0; 10];
assert_eq!(t!(a1.read(&mut b)), 3);
assert_eq!(&b[..3], &[1, 2, 3]);
t!(a1.write_all(&[1, 2, 3]));
t!(a1.flush());
t!(a1.disconnect());
t!(a2.connect());
let mut b = [0; 10];
assert_eq!(t!(a2.read(&mut b)), 3);
assert_eq!(&b[..3], &[1, 2, 3]);
t!(a2.write_all(&[1, 2, 3]));
t!(a2.flush());
t!(a2.disconnect());
t!(t.join());
}
#[test]
fn named_read_overlapped() {
let name = name();
let a = t!(NamedPipe::new(&name));
let t = thread::spawn(move || {
let mut f = t!(File::create(name));
t!(f.write_all(&[1, 2, 3]));
});
let cp = t!(CompletionPort::new(1));
t!(cp.add_handle(3, &a));
t!(a.connect());
let mut b = [0; 10];
let over = Overlapped::zero();
unsafe {
t!(a.read_overlapped(&mut b, over.raw()));
}
let status = t!(cp.get(None));
assert_eq!(status.bytes_transferred(), 3);
assert_eq!(status.token(), 3);
assert_eq!(status.overlapped(), over.raw());
assert_eq!(&b[..3], &[1, 2, 3]);
t!(t.join());
}
#[test]
fn named_write_overlapped() {
let name = name();
let a = t!(NamedPipe::new(&name));
let t = thread::spawn(move || {
let mut f = t!(super::connect(name));
let mut b = [0; 10];
assert_eq!(t!(f.read(&mut b)), 3);
assert_eq!(&b[..3], &[1, 2, 3])
});
let cp = t!(CompletionPort::new(1));
t!(cp.add_handle(3, &a));
t!(a.connect());
let over = Overlapped::zero();
unsafe {
t!(a.write_overlapped(&[1, 2, 3], over.raw()));
}
let status = t!(cp.get(None));
assert_eq!(status.bytes_transferred(), 3);
assert_eq!(status.token(), 3);
assert_eq!(status.overlapped(), over.raw());
t!(t.join());
}
}