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 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
//! Extensions and types for the standard networking primitives.
//!
//! This module contains a number of extension traits for the types in
//! `std::net` for Windows-specific functionality.
use crate::*;
use std::cmp;
use std::io;
use std::mem;
use std::net::{Ipv4Addr, Ipv6Addr, SocketAddrV4, SocketAddrV6};
use std::net::{SocketAddr, TcpListener, TcpStream, UdpSocket};
use std::os::windows::prelude::*;
use std::sync::atomic::{AtomicUsize, Ordering};
use windows_sys::core::*;
use windows_sys::Win32::NetworkManagement::IpHelper::*;
use windows_sys::Win32::Networking::WinSock::*;
use windows_sys::Win32::System::IO::*;
/// A type to represent a buffer in which a socket address will be stored.
///
/// This type is used with the `recv_from_overlapped` function on the
/// `UdpSocketExt` trait to provide space for the overlapped I/O operation to
/// fill in the address upon completion.
#[derive(Clone, Copy)]
pub struct SocketAddrBuf {
buf: SOCKADDR_STORAGE,
len: i32,
}
/// A type to represent a buffer in which an accepted socket's address will be
/// stored.
///
/// This type is used with the `accept_overlapped` method on the
/// `TcpListenerExt` trait to provide space for the overlapped I/O operation to
/// fill in the socket addresses upon completion.
#[repr(C)]
pub struct AcceptAddrsBuf {
// For AcceptEx we've got the restriction that the addresses passed in that
// buffer need to be at least 16 bytes more than the maximum address length
// for the protocol in question, so add some extra here and there
local: SOCKADDR_STORAGE,
_pad1: [u8; 16],
remote: SOCKADDR_STORAGE,
_pad2: [u8; 16],
}
/// The parsed return value of `AcceptAddrsBuf`.
pub struct AcceptAddrs<'a> {
local: *mut SOCKADDR,
local_len: i32,
remote: *mut SOCKADDR,
remote_len: i32,
_data: &'a AcceptAddrsBuf,
}
struct WsaExtension {
guid: GUID,
val: AtomicUsize,
}
/// Additional methods for the `TcpStream` type in the standard library.
pub trait TcpStreamExt {
/// Execute an overlapped read I/O operation on this TCP stream.
///
/// This function will issue an overlapped I/O read (via `WSARecv`) on this
/// socket. The provided buffer will be filled in when the operation
/// completes and the given `OVERLAPPED` instance is used to track the
/// overlapped operation.
///
/// If the operation succeeds, `Ok(Some(n))` is returned indicating how
/// many bytes were read. If the operation returns an error indicating that
/// the I/O is currently pending, `Ok(None)` is returned. Otherwise, the
/// error associated with the operation is returned and no overlapped
/// operation is enqueued.
///
/// The number of bytes read will be returned as part of the completion
/// notification when the I/O finishes.
///
/// # Unsafety
///
/// This function is unsafe because the kernel requires that the `buf` and
/// `overlapped` pointers are 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 these two input
/// pointers are valid until the I/O operation is completed, typically via
/// completion ports and waiting to receive the completion notification on
/// the port.
unsafe fn read_overlapped(
&self,
buf: &mut [u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>>;
/// Execute an overlapped write I/O operation on this TCP stream.
///
/// This function will issue an overlapped I/O write (via `WSASend`) on this
/// socket. The provided buffer will be written when the operation completes
/// and the given `OVERLAPPED` instance is used to track the overlapped
/// operation.
///
/// If the operation succeeds, `Ok(Some(n))` is returned where `n` is the
/// number of bytes that were written. If the operation returns an error
/// indicating that the I/O is currently pending, `Ok(None)` is returned.
/// Otherwise, the error associated with the operation is returned and no
/// overlapped operation is enqueued.
///
/// The number of bytes written will be returned as part of the completion
/// notification when the I/O finishes.
///
/// # Unsafety
///
/// This function is unsafe because the kernel requires that the `buf` and
/// `overlapped` pointers are 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 these two input
/// pointers are valid until the I/O operation is completed, typically via
/// completion ports and waiting to receive the completion notification on
/// the port.
unsafe fn write_overlapped(
&self,
buf: &[u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>>;
/// Attempt to consume the internal socket in this builder by executing an
/// overlapped connect operation.
///
/// This function will issue a connect operation to the address specified on
/// the underlying socket, flagging it as an overlapped operation which will
/// complete asynchronously. If successful this function will return the
/// corresponding TCP stream.
///
/// The `buf` argument provided is an initial buffer of data that should be
/// sent after the connection is initiated. It's acceptable to
/// pass an empty slice here.
///
/// This function will also return whether the connect immediately
/// succeeded or not. If `None` is returned then the I/O operation is still
/// pending and will complete at a later date, and if `Some(bytes)` is
/// returned then that many bytes were transferred.
///
/// Note that to succeed this requires that the underlying socket has
/// previously been bound via a call to `bind` to a local address.
///
/// # Unsafety
///
/// This function is unsafe because the kernel requires that the
/// `overlapped` and `buf` 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 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.
unsafe fn connect_overlapped(
&self,
addr: &SocketAddr,
buf: &[u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>>;
/// Once a `connect_overlapped` has finished, this function needs to be
/// called to finish the connect operation.
///
/// Currently this just calls `setsockopt` with `SO_UPDATE_CONNECT_CONTEXT`
/// to ensure that further functions like `getpeername` and `getsockname`
/// work correctly.
fn connect_complete(&self) -> io::Result<()>;
/// 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, along with the results of the `lpFlags` parameter of
/// the relevant operation, if applicable.
///
/// # 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
unsafe fn result(&self, overlapped: *mut OVERLAPPED) -> io::Result<(usize, u32)>;
}
/// Additional methods for the `UdpSocket` type in the standard library.
pub trait UdpSocketExt {
/// Execute an overlapped receive I/O operation on this UDP socket.
///
/// This function will issue an overlapped I/O read (via `WSARecvFrom`) on
/// this socket. The provided buffer will be filled in when the operation
/// completes, the source from where the data came from will be written to
/// `addr`, and the given `OVERLAPPED` instance is used to track the
/// overlapped operation.
///
/// If the operation succeeds, `Ok(Some(n))` is returned where `n` is the
/// number of bytes that were read. If the operation returns an error
/// indicating that the I/O is currently pending, `Ok(None)` is returned.
/// Otherwise, the error associated with the operation is returned and no
/// overlapped operation is enqueued.
///
/// The number of bytes read will be returned as part of the completion
/// notification when the I/O finishes.
///
/// # Unsafety
///
/// This function is unsafe because the kernel requires that the `buf`,
/// `addr`, and `overlapped` pointers are 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 these two input
/// pointers are valid until the I/O operation is completed, typically via
/// completion ports and waiting to receive the completion notification on
/// the port.
unsafe fn recv_from_overlapped(
&self,
buf: &mut [u8],
addr: *mut SocketAddrBuf,
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>>;
/// Execute an overlapped receive I/O operation on this UDP socket.
///
/// This function will issue an overlapped I/O read (via `WSARecv`) on
/// this socket. The provided buffer will be filled in when the operation
/// completes, the source from where the data came from will be written to
/// `addr`, and the given `OVERLAPPED` instance is used to track the
/// overlapped operation.
///
/// If the operation succeeds, `Ok(Some(n))` is returned where `n` is the
/// number of bytes that were read. If the operation returns an error
/// indicating that the I/O is currently pending, `Ok(None)` is returned.
/// Otherwise, the error associated with the operation is returned and no
/// overlapped operation is enqueued.
///
/// The number of bytes read will be returned as part of the completion
/// notification when the I/O finishes.
///
/// # Unsafety
///
/// This function is unsafe because the kernel requires that the `buf`,
/// and `overlapped` pointers are 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 these two input
/// pointers are valid until the I/O operation is completed, typically via
/// completion ports and waiting to receive the completion notification on
/// the port.
unsafe fn recv_overlapped(
&self,
buf: &mut [u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>>;
/// Execute an overlapped send I/O operation on this UDP socket.
///
/// This function will issue an overlapped I/O write (via `WSASendTo`) on
/// this socket to the address specified by `addr`. The provided buffer will
/// be written when the operation completes and the given `OVERLAPPED`
/// instance is used to track the overlapped operation.
///
/// If the operation succeeds, `Ok(Some(n0)` is returned where `n` byte
/// were written. If the operation returns an error indicating that the I/O
/// is currently pending, `Ok(None)` is returned. Otherwise, the error
/// associated with the operation is returned and no overlapped operation
/// is enqueued.
///
/// The number of bytes written will be returned as part of the completion
/// notification when the I/O finishes.
///
/// # Unsafety
///
/// This function is unsafe because the kernel requires that the `buf` and
/// `overlapped` pointers are 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 these two input
/// pointers are valid until the I/O operation is completed, typically via
/// completion ports and waiting to receive the completion notification on
/// the port.
unsafe fn send_to_overlapped(
&self,
buf: &[u8],
addr: &SocketAddr,
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>>;
/// Execute an overlapped send I/O operation on this UDP socket.
///
/// This function will issue an overlapped I/O write (via `WSASend`) on
/// this socket to the address it was previously connected to. The provided
/// buffer will be written when the operation completes and the given `OVERLAPPED`
/// instance is used to track the overlapped operation.
///
/// If the operation succeeds, `Ok(Some(n0)` is returned where `n` byte
/// were written. If the operation returns an error indicating that the I/O
/// is currently pending, `Ok(None)` is returned. Otherwise, the error
/// associated with the operation is returned and no overlapped operation
/// is enqueued.
///
/// The number of bytes written will be returned as part of the completion
/// notification when the I/O finishes.
///
/// # Unsafety
///
/// This function is unsafe because the kernel requires that the `buf` and
/// `overlapped` pointers are 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 these two input
/// pointers are valid until the I/O operation is completed, typically via
/// completion ports and waiting to receive the completion notification on
/// the port.
unsafe fn send_overlapped(
&self,
buf: &[u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>>;
/// 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, along with the results of the `lpFlags` parameter of
/// the relevant operation, if applicable.
///
/// # 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
unsafe fn result(&self, overlapped: *mut OVERLAPPED) -> io::Result<(usize, u32)>;
}
/// Additional methods for the `TcpListener` type in the standard library.
pub trait TcpListenerExt {
/// Perform an accept operation on this listener, accepting a connection in
/// an overlapped fashion.
///
/// This function will issue an I/O request to accept an incoming connection
/// with the specified overlapped instance. The `socket` provided must be a
/// configured but not bound or connected socket, and if successful this
/// will consume the internal socket of the builder to return a TCP stream.
///
/// The `addrs` buffer provided will be filled in with the local and remote
/// addresses of the connection upon completion.
///
/// If the accept succeeds immediately, `Ok(true)` is returned. If
/// the connect indicates that the I/O is currently pending, `Ok(false)` is
/// returned. Otherwise, the error associated with the operation is
/// returned and no overlapped operation is enqueued.
///
/// # Unsafety
///
/// This function is unsafe because the kernel requires that the
/// `addrs` and `overlapped` pointers are 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.
unsafe fn accept_overlapped(
&self,
socket: &TcpStream,
addrs: &mut AcceptAddrsBuf,
overlapped: *mut OVERLAPPED,
) -> io::Result<bool>;
/// Once an `accept_overlapped` has finished, this function needs to be
/// called to finish the accept operation.
///
/// Currently this just calls `setsockopt` with `SO_UPDATE_ACCEPT_CONTEXT`
/// to ensure that further functions like `getpeername` and `getsockname`
/// work correctly.
fn accept_complete(&self, socket: &TcpStream) -> io::Result<()>;
/// 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, along with the results of the `lpFlags` parameter of
/// the relevant operation, if applicable.
///
/// # 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
unsafe fn result(&self, overlapped: *mut OVERLAPPED) -> io::Result<(usize, u32)>;
}
#[doc(hidden)]
trait NetInt {
fn from_be(i: Self) -> Self;
fn to_be(&self) -> Self;
}
macro_rules! doit {
($($t:ident)*) => ($(impl NetInt for $t {
fn from_be(i: Self) -> Self { <$t>::from_be(i) }
fn to_be(&self) -> Self { <$t>::to_be(*self) }
})*)
}
doit! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }
// fn hton<I: NetInt>(i: I) -> I { i.to_be() }
fn ntoh<I: NetInt>(i: I) -> I {
I::from_be(i)
}
fn last_err() -> io::Result<Option<usize>> {
let err = unsafe { WSAGetLastError() };
if err == WSA_IO_PENDING as i32 {
Ok(None)
} else {
Err(io::Error::from_raw_os_error(err))
}
}
fn cvt(i: i32, size: u32) -> io::Result<Option<usize>> {
if i == SOCKET_ERROR {
last_err()
} else {
Ok(Some(size as usize))
}
}
/// A type with the same memory layout as `SOCKADDR`. Used in converting Rust level
/// SocketAddr* types into their system representation. The benefit of this specific
/// type over using `SOCKADDR_STORAGE` is that this type is exactly as large as it
/// needs to be and not a lot larger. And it can be initialized cleaner from Rust.
#[repr(C)]
pub(crate) union SocketAddrCRepr {
v4: SOCKADDR_IN,
v6: SOCKADDR_IN6,
}
impl SocketAddrCRepr {
pub(crate) fn as_ptr(&self) -> *const SOCKADDR {
self as *const _ as *const SOCKADDR
}
}
fn socket_addr_to_ptrs(addr: &SocketAddr) -> (SocketAddrCRepr, i32) {
match *addr {
SocketAddr::V4(ref a) => {
let sin_addr = IN_ADDR {
S_un: IN_ADDR_0 {
S_addr: u32::from_ne_bytes(a.ip().octets()),
},
};
let sockaddr_in = SOCKADDR_IN {
sin_family: AF_INET as _,
sin_port: a.port().to_be(),
sin_addr,
sin_zero: [0; 8],
};
let sockaddr = SocketAddrCRepr { v4: sockaddr_in };
(sockaddr, mem::size_of::<SOCKADDR_IN>() as i32)
}
SocketAddr::V6(ref a) => {
let sockaddr_in6 = SOCKADDR_IN6 {
sin6_family: AF_INET6 as _,
sin6_port: a.port().to_be(),
sin6_addr: IN6_ADDR {
u: IN6_ADDR_0 {
Byte: a.ip().octets(),
},
},
sin6_flowinfo: a.flowinfo(),
Anonymous: SOCKADDR_IN6_0 {
sin6_scope_id: a.scope_id(),
},
};
let sockaddr = SocketAddrCRepr { v6: sockaddr_in6 };
(sockaddr, mem::size_of::<SOCKADDR_IN6>() as i32)
}
}
}
unsafe fn ptrs_to_socket_addr(ptr: *const SOCKADDR, len: i32) -> Option<SocketAddr> {
if (len as usize) < mem::size_of::<i32>() {
return None;
}
match (*ptr).sa_family as _ {
AF_INET if len as usize >= mem::size_of::<SOCKADDR_IN>() => {
let b = &*(ptr as *const SOCKADDR_IN);
let ip = ntoh(b.sin_addr.S_un.S_addr);
let ip = Ipv4Addr::new(
(ip >> 24) as u8,
(ip >> 16) as u8,
(ip >> 8) as u8,
ip as u8,
);
Some(SocketAddr::V4(SocketAddrV4::new(ip, ntoh(b.sin_port))))
}
AF_INET6 if len as usize >= mem::size_of::<SOCKADDR_IN6>() => {
let b = &*(ptr as *const SOCKADDR_IN6);
let arr = &b.sin6_addr.u.Byte;
let ip = Ipv6Addr::new(
((arr[0] as u16) << 8) | (arr[1] as u16),
((arr[2] as u16) << 8) | (arr[3] as u16),
((arr[4] as u16) << 8) | (arr[5] as u16),
((arr[6] as u16) << 8) | (arr[7] as u16),
((arr[8] as u16) << 8) | (arr[9] as u16),
((arr[10] as u16) << 8) | (arr[11] as u16),
((arr[12] as u16) << 8) | (arr[13] as u16),
((arr[14] as u16) << 8) | (arr[15] as u16),
);
let addr = SocketAddrV6::new(
ip,
ntoh(b.sin6_port),
ntoh(b.sin6_flowinfo),
ntoh(b.Anonymous.sin6_scope_id),
);
Some(SocketAddr::V6(addr))
}
_ => None,
}
}
unsafe fn slice2buf(slice: &[u8]) -> WSABUF {
WSABUF {
len: cmp::min(slice.len(), <u32>::max_value() as usize) as u32,
buf: slice.as_ptr() as *mut _,
}
}
unsafe fn result(socket: SOCKET, overlapped: *mut OVERLAPPED) -> io::Result<(usize, u32)> {
let mut transferred = 0;
let mut flags = 0;
let r = WSAGetOverlappedResult(socket, overlapped, &mut transferred, FALSE, &mut flags);
if r == 0 {
Err(io::Error::last_os_error())
} else {
Ok((transferred as usize, flags))
}
}
impl TcpStreamExt for TcpStream {
unsafe fn read_overlapped(
&self,
buf: &mut [u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>> {
let mut buf = slice2buf(buf);
let mut flags = 0;
let mut bytes_read: u32 = 0;
let r = WSARecv(
self.as_raw_socket() as SOCKET,
&mut buf,
1,
&mut bytes_read,
&mut flags,
overlapped,
None,
);
cvt(r, bytes_read)
}
unsafe fn write_overlapped(
&self,
buf: &[u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>> {
let mut buf = slice2buf(buf);
let mut bytes_written = 0;
// Note here that we capture the number of bytes written. The
// documentation on MSDN, however, states:
//
// > Use NULL for this parameter if the lpOverlapped parameter is not
// > NULL to avoid potentially erroneous results. This parameter can be
// > NULL only if the lpOverlapped parameter is not NULL.
//
// If we're not passing a null overlapped pointer here, then why are we
// then capturing the number of bytes! Well so it turns out that this is
// clearly faster to learn the bytes here rather than later calling
// `WSAGetOverlappedResult`, and in practice almost all implementations
// use this anyway [1].
//
// As a result we use this to and report back the result.
//
// [1]: https://github.com/carllerche/mio/pull/520#issuecomment-273983823
let r = WSASend(
self.as_raw_socket() as SOCKET,
&mut buf,
1,
&mut bytes_written,
0,
overlapped,
None,
);
cvt(r, bytes_written)
}
unsafe fn connect_overlapped(
&self,
addr: &SocketAddr,
buf: &[u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>> {
connect_overlapped(self.as_raw_socket() as SOCKET, addr, buf, overlapped)
}
fn connect_complete(&self) -> io::Result<()> {
const SO_UPDATE_CONNECT_CONTEXT: i32 = 0x7010;
let result = unsafe {
setsockopt(
self.as_raw_socket() as SOCKET,
SOL_SOCKET as _,
SO_UPDATE_CONNECT_CONTEXT,
0 as *mut _,
0,
)
};
if result == 0 {
Ok(())
} else {
Err(io::Error::last_os_error())
}
}
unsafe fn result(&self, overlapped: *mut OVERLAPPED) -> io::Result<(usize, u32)> {
result(self.as_raw_socket() as SOCKET, overlapped)
}
}
unsafe fn connect_overlapped(
socket: SOCKET,
addr: &SocketAddr,
buf: &[u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>> {
static CONNECTEX: WsaExtension = WsaExtension {
guid: GUID {
data1: 0x25a207b9,
data2: 0xddf3,
data3: 0x4660,
data4: [0x8e, 0xe9, 0x76, 0xe5, 0x8c, 0x74, 0x06, 0x3e],
},
val: AtomicUsize::new(0),
};
let ptr = CONNECTEX.get(socket)?;
assert!(ptr != 0);
let connect_ex = mem::transmute::<_, LPFN_CONNECTEX>(ptr);
let (addr_buf, addr_len) = socket_addr_to_ptrs(addr);
let mut bytes_sent: u32 = 0;
let r = connect_ex(
socket,
addr_buf.as_ptr(),
addr_len,
buf.as_ptr() as *mut _,
buf.len() as u32,
&mut bytes_sent,
overlapped,
);
if r == TRUE {
Ok(Some(bytes_sent as usize))
} else {
last_err()
}
}
impl UdpSocketExt for UdpSocket {
unsafe fn recv_from_overlapped(
&self,
buf: &mut [u8],
addr: *mut SocketAddrBuf,
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>> {
let mut buf = slice2buf(buf);
let mut flags = 0;
let mut received_bytes: u32 = 0;
let r = WSARecvFrom(
self.as_raw_socket() as SOCKET,
&mut buf,
1,
&mut received_bytes,
&mut flags,
&mut (*addr).buf as *mut _ as *mut _,
&mut (*addr).len,
overlapped,
None,
);
cvt(r, received_bytes)
}
unsafe fn recv_overlapped(
&self,
buf: &mut [u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>> {
let mut buf = slice2buf(buf);
let mut flags = 0;
let mut received_bytes: u32 = 0;
let r = WSARecv(
self.as_raw_socket() as SOCKET,
&mut buf,
1,
&mut received_bytes,
&mut flags,
overlapped,
None,
);
cvt(r, received_bytes)
}
unsafe fn send_to_overlapped(
&self,
buf: &[u8],
addr: &SocketAddr,
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>> {
let (addr_buf, addr_len) = socket_addr_to_ptrs(addr);
let mut buf = slice2buf(buf);
let mut sent_bytes = 0;
let r = WSASendTo(
self.as_raw_socket() as SOCKET,
&mut buf,
1,
&mut sent_bytes,
0,
addr_buf.as_ptr() as *const _,
addr_len,
overlapped,
None,
);
cvt(r, sent_bytes)
}
unsafe fn send_overlapped(
&self,
buf: &[u8],
overlapped: *mut OVERLAPPED,
) -> io::Result<Option<usize>> {
let mut buf = slice2buf(buf);
let mut sent_bytes = 0;
let r = WSASend(
self.as_raw_socket() as SOCKET,
&mut buf,
1,
&mut sent_bytes,
0,
overlapped,
None,
);
cvt(r, sent_bytes)
}
unsafe fn result(&self, overlapped: *mut OVERLAPPED) -> io::Result<(usize, u32)> {
result(self.as_raw_socket() as SOCKET, overlapped)
}
}
impl TcpListenerExt for TcpListener {
unsafe fn accept_overlapped(
&self,
socket: &TcpStream,
addrs: &mut AcceptAddrsBuf,
overlapped: *mut OVERLAPPED,
) -> io::Result<bool> {
static ACCEPTEX: WsaExtension = WsaExtension {
guid: GUID {
data1: 0xb5367df1,
data2: 0xcbac,
data3: 0x11cf,
data4: [0x95, 0xca, 0x00, 0x80, 0x5f, 0x48, 0xa1, 0x92],
},
val: AtomicUsize::new(0),
};
let ptr = ACCEPTEX.get(self.as_raw_socket() as SOCKET)?;
assert!(ptr != 0);
let accept_ex = mem::transmute::<_, LPFN_ACCEPTEX>(ptr);
let mut bytes = 0;
let (a, b, c, d) = (*addrs).args();
let r = accept_ex(
self.as_raw_socket() as SOCKET,
socket.as_raw_socket() as SOCKET,
a,
b,
c,
d,
&mut bytes,
overlapped,
);
let succeeded = if r == TRUE {
true
} else {
last_err()?;
false
};
Ok(succeeded)
}
fn accept_complete(&self, socket: &TcpStream) -> io::Result<()> {
const SO_UPDATE_ACCEPT_CONTEXT: i32 = 0x700B;
let me = self.as_raw_socket();
let result = unsafe {
setsockopt(
socket.as_raw_socket() as SOCKET,
SOL_SOCKET as _,
SO_UPDATE_ACCEPT_CONTEXT,
&me as *const _ as *mut _,
mem::size_of_val(&me) as i32,
)
};
if result == 0 {
Ok(())
} else {
Err(io::Error::last_os_error())
}
}
unsafe fn result(&self, overlapped: *mut OVERLAPPED) -> io::Result<(usize, u32)> {
result(self.as_raw_socket() as SOCKET, overlapped)
}
}
impl SocketAddrBuf {
/// Creates a new blank socket address buffer.
///
/// This should be used before a call to `recv_from_overlapped` overlapped
/// to create an instance to pass down.
pub fn new() -> SocketAddrBuf {
SocketAddrBuf {
buf: unsafe { mem::zeroed() },
len: mem::size_of::<SOCKADDR_STORAGE>() as i32,
}
}
/// Parses this buffer to return a standard socket address.
///
/// This function should be called after the buffer has been filled in with
/// a call to `recv_from_overlapped` being completed. It will interpret the
/// address filled in and return the standard socket address type.
///
/// If an error is encountered then `None` is returned.
pub fn to_socket_addr(&self) -> Option<SocketAddr> {
unsafe { ptrs_to_socket_addr(&self.buf as *const _ as *const _, self.len) }
}
}
static GETACCEPTEXSOCKADDRS: WsaExtension = WsaExtension {
guid: GUID {
data1: 0xb5367df2,
data2: 0xcbac,
data3: 0x11cf,
data4: [0x95, 0xca, 0x00, 0x80, 0x5f, 0x48, 0xa1, 0x92],
},
val: AtomicUsize::new(0),
};
impl AcceptAddrsBuf {
/// Creates a new blank buffer ready to be passed to a call to
/// `accept_overlapped`.
pub fn new() -> AcceptAddrsBuf {
unsafe { mem::zeroed() }
}
/// Parses the data contained in this address buffer, returning the parsed
/// result if successful.
///
/// This function can be called after a call to `accept_overlapped` has
/// succeeded to parse out the data that was written in.
pub fn parse(&self, socket: &TcpListener) -> io::Result<AcceptAddrs> {
let mut ret = AcceptAddrs {
local: 0 as *mut _,
local_len: 0,
remote: 0 as *mut _,
remote_len: 0,
_data: self,
};
let ptr = GETACCEPTEXSOCKADDRS.get(socket.as_raw_socket() as SOCKET)?;
assert!(ptr != 0);
unsafe {
let get_sockaddrs = mem::transmute::<_, LPFN_GETACCEPTEXSOCKADDRS>(ptr);
let (a, b, c, d) = self.args();
get_sockaddrs(
a,
b,
c,
d,
&mut ret.local,
&mut ret.local_len,
&mut ret.remote,
&mut ret.remote_len,
);
Ok(ret)
}
}
#[allow(deref_nullptr)]
fn args(&self) -> (*mut std::ffi::c_void, u32, u32, u32) {
let remote_offset = unsafe { &(*(0 as *const AcceptAddrsBuf)).remote as *const _ as usize };
(
self as *const _ as *mut _,
0,
remote_offset as u32,
(mem::size_of_val(self) - remote_offset) as u32,
)
}
}
impl<'a> AcceptAddrs<'a> {
/// Returns the local socket address contained in this buffer.
pub fn local(&self) -> Option<SocketAddr> {
unsafe { ptrs_to_socket_addr(self.local, self.local_len) }
}
/// Returns the remote socket address contained in this buffer.
pub fn remote(&self) -> Option<SocketAddr> {
unsafe { ptrs_to_socket_addr(self.remote, self.remote_len) }
}
}
impl WsaExtension {
fn get(&self, socket: SOCKET) -> io::Result<usize> {
let prev = self.val.load(Ordering::SeqCst);
if prev != 0 && !cfg!(debug_assertions) {
return Ok(prev);
}
let mut ret = 0 as usize;
let mut bytes = 0;
// https://github.com/microsoft/win32metadata/issues/671
const SIO_GET_EXTENSION_FUNCTION_POINTER: u32 = 33_5544_3206u32;
let r = unsafe {
WSAIoctl(
socket,
SIO_GET_EXTENSION_FUNCTION_POINTER,
&self.guid as *const _ as *mut _,
mem::size_of_val(&self.guid) as u32,
&mut ret as *mut _ as *mut _,
mem::size_of_val(&ret) as u32,
&mut bytes,
0 as *mut _,
None,
)
};
cvt(r, 0).map(|_| {
debug_assert_eq!(bytes as usize, mem::size_of_val(&ret));
debug_assert!(prev == 0 || prev == ret);
self.val.store(ret, Ordering::SeqCst);
ret
})
}
}
#[cfg(test)]
mod tests {
use std::io::prelude::*;
use std::net::{
IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, SocketAddrV6, TcpListener, TcpStream, UdpSocket,
};
use std::slice;
use std::thread;
use socket2::{Domain, Socket, Type};
use crate::iocp::CompletionPort;
use crate::net::{AcceptAddrsBuf, TcpListenerExt};
use crate::net::{SocketAddrBuf, TcpStreamExt, UdpSocketExt};
use crate::Overlapped;
fn each_ip(f: &mut dyn FnMut(SocketAddr)) {
f(t!("127.0.0.1:0".parse()));
f(t!("[::1]:0".parse()));
}
#[test]
fn tcp_read() {
each_ip(&mut |addr| {
let l = t!(TcpListener::bind(addr));
let addr = t!(l.local_addr());
let t = thread::spawn(move || {
let mut a = t!(l.accept()).0;
t!(a.write_all(&[1, 2, 3]));
});
let cp = t!(CompletionPort::new(1));
let s = t!(TcpStream::connect(addr));
t!(cp.add_socket(1, &s));
let mut b = [0; 10];
let a = Overlapped::zero();
unsafe {
t!(s.read_overlapped(&mut b, a.raw()));
}
let status = t!(cp.get(None));
assert_eq!(status.bytes_transferred(), 3);
assert_eq!(status.token(), 1);
assert_eq!(status.overlapped(), a.raw());
assert_eq!(&b[0..3], &[1, 2, 3]);
t!(t.join());
})
}
#[test]
fn tcp_write() {
each_ip(&mut |addr| {
let l = t!(TcpListener::bind(addr));
let addr = t!(l.local_addr());
let t = thread::spawn(move || {
let mut a = t!(l.accept()).0;
let mut b = [0; 10];
let n = t!(a.read(&mut b));
assert_eq!(n, 3);
assert_eq!(&b[0..3], &[1, 2, 3]);
});
let cp = t!(CompletionPort::new(1));
let s = t!(TcpStream::connect(addr));
t!(cp.add_socket(1, &s));
let b = [1, 2, 3];
let a = Overlapped::zero();
unsafe {
t!(s.write_overlapped(&b, a.raw()));
}
let status = t!(cp.get(None));
assert_eq!(status.bytes_transferred(), 3);
assert_eq!(status.token(), 1);
assert_eq!(status.overlapped(), a.raw());
t!(t.join());
})
}
#[test]
fn tcp_connect() {
each_ip(&mut |addr_template| {
let l = t!(TcpListener::bind(addr_template));
let addr = t!(l.local_addr());
let t = thread::spawn(move || {
t!(l.accept());
});
let cp = t!(CompletionPort::new(1));
let domain = Domain::for_address(addr);
let socket = t!(Socket::new(domain, Type::STREAM, None));
t!(socket.bind(&addr_template.into()));
let socket = TcpStream::from(socket);
t!(cp.add_socket(1, &socket));
let a = Overlapped::zero();
unsafe {
t!(socket.connect_overlapped(&addr, &[], a.raw()));
}
let status = t!(cp.get(None));
assert_eq!(status.bytes_transferred(), 0);
assert_eq!(status.token(), 1);
assert_eq!(status.overlapped(), a.raw());
t!(socket.connect_complete());
t!(t.join());
})
}
#[test]
fn udp_recv_from() {
each_ip(&mut |addr| {
let a = t!(UdpSocket::bind(addr));
let b = t!(UdpSocket::bind(addr));
let a_addr = t!(a.local_addr());
let b_addr = t!(b.local_addr());
let t = thread::spawn(move || {
t!(a.send_to(&[1, 2, 3], b_addr));
});
let cp = t!(CompletionPort::new(1));
t!(cp.add_socket(1, &b));
let mut buf = [0; 10];
let a = Overlapped::zero();
let mut addr = SocketAddrBuf::new();
unsafe {
t!(b.recv_from_overlapped(&mut buf, &mut addr, a.raw()));
}
let status = t!(cp.get(None));
assert_eq!(status.bytes_transferred(), 3);
assert_eq!(status.token(), 1);
assert_eq!(status.overlapped(), a.raw());
assert_eq!(&buf[..3], &[1, 2, 3]);
assert_eq!(addr.to_socket_addr(), Some(a_addr));
t!(t.join());
})
}
#[test]
fn udp_recv() {
each_ip(&mut |addr| {
let a = t!(UdpSocket::bind(addr));
let b = t!(UdpSocket::bind(addr));
let a_addr = t!(a.local_addr());
let b_addr = t!(b.local_addr());
assert!(b.connect(a_addr).is_ok());
assert!(a.connect(b_addr).is_ok());
let t = thread::spawn(move || {
t!(a.send_to(&[1, 2, 3], b_addr));
});
let cp = t!(CompletionPort::new(1));
t!(cp.add_socket(1, &b));
let mut buf = [0; 10];
let a = Overlapped::zero();
unsafe {
t!(b.recv_overlapped(&mut buf, a.raw()));
}
let status = t!(cp.get(None));
assert_eq!(status.bytes_transferred(), 3);
assert_eq!(status.token(), 1);
assert_eq!(status.overlapped(), a.raw());
assert_eq!(&buf[..3], &[1, 2, 3]);
t!(t.join());
})
}
#[test]
fn udp_send_to() {
each_ip(&mut |addr| {
let a = t!(UdpSocket::bind(addr));
let b = t!(UdpSocket::bind(addr));
let a_addr = t!(a.local_addr());
let b_addr = t!(b.local_addr());
let t = thread::spawn(move || {
let mut b = [0; 100];
let (n, addr) = t!(a.recv_from(&mut b));
assert_eq!(n, 3);
assert_eq!(addr, b_addr);
assert_eq!(&b[..3], &[1, 2, 3]);
});
let cp = t!(CompletionPort::new(1));
t!(cp.add_socket(1, &b));
let a = Overlapped::zero();
unsafe {
t!(b.send_to_overlapped(&[1, 2, 3], &a_addr, a.raw()));
}
let status = t!(cp.get(None));
assert_eq!(status.bytes_transferred(), 3);
assert_eq!(status.token(), 1);
assert_eq!(status.overlapped(), a.raw());
t!(t.join());
})
}
#[test]
fn udp_send() {
each_ip(&mut |addr| {
let a = t!(UdpSocket::bind(addr));
let b = t!(UdpSocket::bind(addr));
let a_addr = t!(a.local_addr());
let b_addr = t!(b.local_addr());
assert!(b.connect(a_addr).is_ok());
assert!(a.connect(b_addr).is_ok());
let t = thread::spawn(move || {
let mut b = [0; 100];
let (n, addr) = t!(a.recv_from(&mut b));
assert_eq!(n, 3);
assert_eq!(addr, b_addr);
assert_eq!(&b[..3], &[1, 2, 3]);
});
let cp = t!(CompletionPort::new(1));
t!(cp.add_socket(1, &b));
let a = Overlapped::zero();
unsafe {
t!(b.send_overlapped(&[1, 2, 3], a.raw()));
}
let status = t!(cp.get(None));
assert_eq!(status.bytes_transferred(), 3);
assert_eq!(status.token(), 1);
assert_eq!(status.overlapped(), a.raw());
t!(t.join());
})
}
#[test]
fn tcp_accept() {
each_ip(&mut |addr_template| {
let l = t!(TcpListener::bind(addr_template));
let addr = t!(l.local_addr());
let t = thread::spawn(move || {
let socket = t!(TcpStream::connect(addr));
(socket.local_addr().unwrap(), socket.peer_addr().unwrap())
});
let cp = t!(CompletionPort::new(1));
let domain = Domain::for_address(addr);
let socket = TcpStream::from(t!(Socket::new(domain, Type::STREAM, None)));
t!(cp.add_socket(1, &l));
let a = Overlapped::zero();
let mut addrs = AcceptAddrsBuf::new();
unsafe {
t!(l.accept_overlapped(&socket, &mut addrs, a.raw()));
}
let status = t!(cp.get(None));
assert_eq!(status.bytes_transferred(), 0);
assert_eq!(status.token(), 1);
assert_eq!(status.overlapped(), a.raw());
t!(l.accept_complete(&socket));
let (remote, local) = t!(t.join());
let addrs = addrs.parse(&l).unwrap();
assert_eq!(addrs.local(), Some(local));
assert_eq!(addrs.remote(), Some(remote));
})
}
#[test]
fn sockaddr_convert_4() {
let addr = SocketAddr::new(IpAddr::V4(Ipv4Addr::new(3, 4, 5, 6)), 0xabcd);
let (raw_addr, addr_len) = super::socket_addr_to_ptrs(&addr);
assert_eq!(addr_len, 16);
let addr_bytes =
unsafe { slice::from_raw_parts(raw_addr.as_ptr() as *const u8, addr_len as usize) };
assert_eq!(
addr_bytes,
&[2, 0, 0xab, 0xcd, 3, 4, 5, 6, 0, 0, 0, 0, 0, 0, 0, 0]
);
}
#[test]
fn sockaddr_convert_v6() {
let port = 0xabcd;
let flowinfo = 0x12345678;
let scope_id = 0x87654321;
let addr = SocketAddr::V6(SocketAddrV6::new(
Ipv6Addr::new(
0x0102, 0x0304, 0x0506, 0x0708, 0x090a, 0x0b0c, 0x0d0e, 0x0f10,
),
port,
flowinfo,
scope_id,
));
let (raw_addr, addr_len) = super::socket_addr_to_ptrs(&addr);
assert_eq!(addr_len, 28);
let addr_bytes =
unsafe { slice::from_raw_parts(raw_addr.as_ptr() as *const u8, addr_len as usize) };
assert_eq!(
addr_bytes,
&[
23, 0, // AF_INET6
0xab, 0xcd, // Port
0x78, 0x56, 0x34, 0x12, // flowinfo
0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e,
0x0f, 0x10, // IP
0x21, 0x43, 0x65, 0x87, // scope_id
]
);
}
}