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
use core::cell::UnsafeCell;
use core::net::SocketAddr;
use core::sync::atomic::{AtomicBool, AtomicU8, Ordering};
use axerrno::{ax_err, ax_err_type, AxError, AxResult};
use axhal::time::current_ticks;
use axio::{PollState, Read, Write};
use axsync::Mutex;
use axtask::yield_now;
use smoltcp::iface::SocketHandle;
use smoltcp::socket::tcp::{self, ConnectError, State};
use smoltcp::wire::{IpEndpoint, IpListenEndpoint};
use super::addr::{from_core_sockaddr, into_core_sockaddr, is_unspecified, UNSPECIFIED_ENDPOINT};
use super::{SocketSetWrapper, LISTEN_TABLE, SOCKET_SET};
// State transitions:
// CLOSED -(connect)-> BUSY -> CONNECTING -> CONNECTED -(shutdown)-> BUSY -> CLOSED
// |
// |-(listen)-> BUSY -> LISTENING -(shutdown)-> BUSY -> CLOSED
// |
// -(bind)-> BUSY -> CLOSED
const STATE_CLOSED: u8 = 0;
const STATE_BUSY: u8 = 1;
const STATE_CONNECTING: u8 = 2;
const STATE_CONNECTED: u8 = 3;
const STATE_LISTENING: u8 = 4;
/// A TCP socket that provides POSIX-like APIs.
///
/// - [`connect`] is for TCP clients.
/// - [`bind`], [`listen`], and [`accept`] are for TCP servers.
/// - Other methods are for both TCP clients and servers.
///
/// [`connect`]: TcpSocket::connect
/// [`bind`]: TcpSocket::bind
/// [`listen`]: TcpSocket::listen
/// [`accept`]: TcpSocket::accept
pub struct TcpSocket {
state: AtomicU8,
handle: UnsafeCell<Option<SocketHandle>>,
local_addr: UnsafeCell<IpEndpoint>,
peer_addr: UnsafeCell<IpEndpoint>,
nonblock: AtomicBool,
}
unsafe impl Sync for TcpSocket {}
impl TcpSocket {
/// Creates a new TCP socket.
pub const fn new() -> Self {
Self {
state: AtomicU8::new(STATE_CLOSED),
handle: UnsafeCell::new(None),
local_addr: UnsafeCell::new(UNSPECIFIED_ENDPOINT),
peer_addr: UnsafeCell::new(UNSPECIFIED_ENDPOINT),
nonblock: AtomicBool::new(false),
}
}
/// Creates a new TCP socket that is already connected.
const fn new_connected(
handle: SocketHandle,
local_addr: IpEndpoint,
peer_addr: IpEndpoint,
) -> Self {
Self {
state: AtomicU8::new(STATE_CONNECTED),
handle: UnsafeCell::new(Some(handle)),
local_addr: UnsafeCell::new(local_addr),
peer_addr: UnsafeCell::new(peer_addr),
nonblock: AtomicBool::new(false),
}
}
/// Returns the local address and port, or
/// [`Err(NotConnected)`](AxError::NotConnected) if not connected.
#[inline]
pub fn local_addr(&self) -> AxResult<SocketAddr> {
// 为了通过测例,已经`bind`但未`listen`的socket也可以返回地址
match self.get_state() {
STATE_CONNECTED | STATE_LISTENING | STATE_CLOSED => {
Ok(into_core_sockaddr(unsafe { self.local_addr.get().read() }))
}
_ => Err(AxError::NotConnected),
}
}
/// Returns the remote address and port, or
/// [`Err(NotConnected)`](AxError::NotConnected) if not connected.
#[inline]
pub fn peer_addr(&self) -> AxResult<SocketAddr> {
match self.get_state() {
STATE_CONNECTED | STATE_LISTENING => {
Ok(into_core_sockaddr(unsafe { self.peer_addr.get().read() }))
}
_ => Err(AxError::NotConnected),
}
}
/// Returns whether this socket is in nonblocking mode.
#[inline]
pub fn is_nonblocking(&self) -> bool {
self.nonblock.load(Ordering::Acquire)
}
/// Moves this TCP stream into or out of nonblocking mode.
///
/// This will result in `read`, `write`, `recv` and `send` operations
/// becoming nonblocking, i.e., immediately returning from their calls.
/// If the IO operation is successful, `Ok` is returned and no further
/// action is required. If the IO operation could not be completed and needs
/// to be retried, an error with kind [`Err(WouldBlock)`](AxError::WouldBlock) is
/// returned.
#[inline]
pub fn set_nonblocking(&self, nonblocking: bool) {
self.nonblock.store(nonblocking, Ordering::Release);
}
/// Connects to the given address and port.
///
/// The local port is generated automatically.
pub fn connect(&self, remote_addr: SocketAddr) -> AxResult {
self.update_state(STATE_CLOSED, STATE_CONNECTING, || {
// SAFETY: no other threads can read or write these fields.
let handle = unsafe { self.handle.get().read() }
.unwrap_or_else(|| SOCKET_SET.add(SocketSetWrapper::new_tcp_socket()));
// TODO: check remote addr unreachable
let remote_endpoint = from_core_sockaddr(remote_addr);
let bound_endpoint = self.bound_endpoint()?;
#[cfg(not(feature = "ip"))]
let iface = &super::ETH0.iface;
#[cfg(feature = "ip")]
let iface = super::LOOPBACK.try_get().unwrap();
let (local_endpoint, remote_endpoint) = SOCKET_SET
.with_socket_mut::<tcp::Socket, _, _>(handle, |socket| {
socket
.connect(iface.lock().context(), remote_endpoint, bound_endpoint)
.or_else(|e| match e {
ConnectError::InvalidState => {
ax_err!(BadState, "socket connect() failed")
}
ConnectError::Unaddressable => {
ax_err!(ConnectionRefused, "socket connect() failed")
}
})?;
Ok((
socket.local_endpoint().unwrap(),
socket.remote_endpoint().unwrap(),
))
})?;
unsafe {
// SAFETY: no other threads can read or write these fields as we
// have changed the state to `BUSY`.
self.local_addr.get().write(local_endpoint);
self.peer_addr.get().write(remote_endpoint);
self.handle.get().write(Some(handle));
}
Ok(())
})
.unwrap_or_else(|_| ax_err!(AlreadyExists, "socket connect() failed: already connected"))?; // EISCONN
// HACK: yield() to let server to listen
yield_now();
// Here our state must be `CONNECTING`, and only one thread can run here.
if self.is_nonblocking() {
Err(AxError::WouldBlock)
} else {
self.block_on(|| {
let PollState { writable, .. } = self.poll_connect()?;
if !writable {
Err(AxError::WouldBlock)
} else if self.get_state() == STATE_CONNECTED {
Ok(())
} else {
ax_err!(ConnectionRefused, "socket connect() failed")
}
})
}
}
/// Binds an unbound socket to the given address and port.
///
/// If the given port is 0, it generates one automatically.
///
/// It's must be called before [`listen`](Self::listen) and
/// [`accept`](Self::accept).
pub fn bind(&self, mut local_addr: SocketAddr) -> AxResult {
self.update_state(STATE_CLOSED, STATE_CLOSED, || {
// TODO: check addr is available
if local_addr.port() == 0 {
local_addr.set_port(get_ephemeral_port()?);
}
// SAFETY: no other threads can read or write `self.local_addr` as we
// have changed the state to `BUSY`.
unsafe {
let old = self.local_addr.get().read();
if old != UNSPECIFIED_ENDPOINT {
return ax_err!(InvalidInput, "socket bind() failed: already bound");
}
self.local_addr.get().write(from_core_sockaddr(local_addr));
}
Ok(())
})
.unwrap_or_else(|_| ax_err!(InvalidInput, "socket bind() failed: already bound"))
}
/// Starts listening on the bound address and port.
///
/// It's must be called after [`bind`](Self::bind) and before
/// [`accept`](Self::accept).
pub fn listen(&self) -> AxResult {
self.update_state(STATE_CLOSED, STATE_LISTENING, || {
let bound_endpoint = self.bound_endpoint()?;
unsafe {
(*self.local_addr.get()).port = bound_endpoint.port;
}
LISTEN_TABLE.listen(bound_endpoint)?;
debug!("TCP socket listening on {}", bound_endpoint);
Ok(())
})
.unwrap_or(Ok(())) // ignore simultaneous `listen`s.
}
/// Accepts a new connection.
///
/// This function will block the calling thread until a new TCP connection
/// is established. When established, a new [`TcpSocket`] is returned.
///
/// It's must be called after [`bind`](Self::bind) and [`listen`](Self::listen).
pub fn accept(&self) -> AxResult<TcpSocket> {
if !self.is_listening() {
return ax_err!(InvalidInput, "socket accept() failed: not listen");
}
// SAFETY: `self.local_addr` should be initialized after `bind()`.
let local_port = unsafe { self.local_addr.get().read().port };
self.block_on(|| {
let (handle, (local_addr, peer_addr)) = LISTEN_TABLE.accept(local_port)?;
debug!("TCP socket accepted a new connection {}", peer_addr);
Ok(TcpSocket::new_connected(handle, local_addr, peer_addr))
})
}
/// Close the connection.
pub fn shutdown(&self) -> AxResult {
// stream
self.update_state(STATE_CONNECTED, STATE_CLOSED, || {
// SAFETY: `self.handle` should be initialized in a connected socket, and
// no other threads can read or write it.
let handle = unsafe { self.handle.get().read().unwrap() };
SOCKET_SET.with_socket_mut::<tcp::Socket, _, _>(handle, |socket| {
debug!("TCP socket {}: shutting down", handle);
socket.close();
});
unsafe { self.local_addr.get().write(UNSPECIFIED_ENDPOINT) }; // clear bound address
SOCKET_SET.poll_interfaces();
Ok(())
})
.unwrap_or(Ok(()))?;
// listener
self.update_state(STATE_LISTENING, STATE_CLOSED, || {
// SAFETY: `self.local_addr` should be initialized in a listening socket,
// and no other threads can read or write it.
let local_port = unsafe { self.local_addr.get().read().port };
unsafe { self.local_addr.get().write(UNSPECIFIED_ENDPOINT) }; // clear bound address
LISTEN_TABLE.unlisten(local_port);
SOCKET_SET.poll_interfaces();
Ok(())
})
.unwrap_or(Ok(()))?;
// ignore for other states
Ok(())
}
/// Close the transmit half of the tcp socket.
/// It will call `close()` on smoltcp::socket::tcp::Socket. It should send FIN to remote half.
///
/// This function is for shutdown(fd, SHUT_WR) syscall.
///
/// It won't change TCP state.
/// It won't affect unconnected sockets (listener).
pub fn close(&mut self) {
let handle = match unsafe { self.handle.get().read() } {
Some(h) => h,
None => return,
};
SOCKET_SET.with_socket_mut::<tcp::Socket, _, _>(handle, |socket| socket.close());
SOCKET_SET.poll_interfaces();
}
/// Receives data from the socket, stores it in the given buffer.
pub fn recv(&self, buf: &mut [u8]) -> AxResult<usize> {
if self.is_connecting() {
return Err(AxError::WouldBlock);
} else if !self.is_connected() {
return ax_err!(NotConnected, "socket recv() failed");
}
// SAFETY: `self.handle` should be initialized in a connected socket.
let handle = unsafe { self.handle.get().read().unwrap() };
self.block_on(|| {
SOCKET_SET.with_socket_mut::<tcp::Socket, _, _>(handle, |socket| {
if !socket.is_active() {
// not open
ax_err!(ConnectionRefused, "socket recv() failed")
} else if !socket.may_recv() {
// connection closed
Ok(0)
} else if socket.recv_queue() > 0 {
// data available
// TODO: use socket.recv(|buf| {...})
let len = socket
.recv_slice(buf)
.map_err(|_| ax_err_type!(BadState, "socket recv() failed"))?;
Ok(len)
} else {
// no more data
Err(AxError::WouldBlock)
}
})
})
}
/// Receives data from the socket, stores it in the given buffer.
///
/// It will return [`Err(Timeout)`](AxError::Timeout) if expired.
pub fn recv_timeout(&self, buf: &mut [u8], ticks: u64) -> AxResult<usize> {
if self.is_connecting() {
return Err(AxError::WouldBlock);
} else if !self.is_connected() {
return ax_err!(NotConnected, "socket recv() failed");
}
let expire_at = current_ticks() + ticks;
// SAFETY: `self.handle` should be initialized in a connected socket.
let handle = unsafe { self.handle.get().read().unwrap() };
self.block_on(|| {
SOCKET_SET.with_socket_mut::<tcp::Socket, _, _>(handle, |socket| {
if !socket.is_active() {
// not open
ax_err!(ConnectionRefused, "socket recv() failed")
} else if !socket.may_recv() {
// connection closed
Ok(0)
} else if socket.recv_queue() > 0 {
// data available
// TODO: use socket.recv(|buf| {...})
let len = socket
.recv_slice(buf)
.map_err(|_| ax_err_type!(BadState, "socket recv() failed"))?;
Ok(len)
} else {
// no more data
if current_ticks() > expire_at {
Err(AxError::Timeout)
} else {
Err(AxError::WouldBlock)
}
}
})
})
}
/// Transmits data in the given buffer.
pub fn send(&self, buf: &[u8]) -> AxResult<usize> {
if self.is_connecting() {
return Err(AxError::WouldBlock);
} else if !self.is_connected() {
return ax_err!(NotConnected, "socket send() failed");
}
// SAFETY: `self.handle` should be initialized in a connected socket.
let handle = unsafe { self.handle.get().read().unwrap() };
self.block_on(|| {
SOCKET_SET.with_socket_mut::<tcp::Socket, _, _>(handle, |socket| {
if !socket.is_active() || !socket.may_send() {
// closed by remote
ax_err!(ConnectionReset, "socket send() failed")
} else if socket.can_send() {
// connected, and the tx buffer is not full
// TODO: use socket.send(|buf| {...})
let len = socket
.send_slice(buf)
.map_err(|_| ax_err_type!(BadState, "socket send() failed"))?;
Ok(len)
} else {
// tx buffer is full
Err(AxError::WouldBlock)
}
})
})
}
/// Whether the socket is readable or writable.
pub fn poll(&self) -> AxResult<PollState> {
match self.get_state() {
STATE_CONNECTING => self.poll_connect(),
STATE_CONNECTED => self.poll_stream(),
STATE_LISTENING => self.poll_listener(),
_ => Ok(PollState {
readable: false,
writable: false,
}),
}
}
/// To set the nagle algorithm enabled or not.
pub fn set_nagle_enabled(&self, enabled: bool) -> AxResult {
let handle = unsafe { self.handle.get().read() };
let Some(handle) = handle else {
return Err(AxError::NotConnected);
};
SOCKET_SET.with_socket_mut::<tcp::Socket, _, _>(handle, |socket| {
socket.set_nagle_enabled(enabled)
});
Ok(())
}
/// To get the nagle algorithm enabled or not.
pub fn nagle_enabled(&self) -> bool {
let handle = unsafe { self.handle.get().read() };
match handle {
Some(handle) => {
SOCKET_SET.with_socket::<tcp::Socket, _, _>(handle, |socket| socket.nagle_enabled())
}
// Nagle algorithm will be enabled by default once the socket is created
None => true,
}
}
/// To get the socket and call the given function.
///
/// If the socket is not connected, it will return None.
///
/// Or it will return the result of the given function.
pub fn with_socket<R>(&self, f: impl FnOnce(Option<&tcp::Socket>) -> R) -> R {
let handle = unsafe { self.handle.get().read() };
match handle {
Some(handle) => {
SOCKET_SET.with_socket::<tcp::Socket, _, _>(handle, |socket| f(Some(socket)))
}
None => f(None),
}
}
/// To get the mutable socket and call the given function.
///
/// If the socket is not connected, it will return None.
///
/// Or it will return the result of the given function.
pub fn with_socket_mut<R>(&mut self, f: impl FnOnce(Option<&mut tcp::Socket>) -> R) -> R {
let handle = unsafe { self.handle.get().read() };
match handle {
Some(handle) => {
SOCKET_SET.with_socket_mut::<tcp::Socket, _, _>(handle, |socket| f(Some(socket)))
}
None => f(None),
}
}
}
/// Private methods
impl TcpSocket {
#[inline]
fn get_state(&self) -> u8 {
self.state.load(Ordering::Acquire)
}
#[inline]
fn set_state(&self, state: u8) {
self.state.store(state, Ordering::Release);
}
/// Update the state of the socket atomically.
///
/// If the current state is `expect`, it first changes the state to `STATE_BUSY`,
/// then calls the given function. If the function returns `Ok`, it changes the
/// state to `new`, otherwise it changes the state back to `expect`.
///
/// It returns `Ok` if the current state is `expect`, otherwise it returns
/// the current state in `Err`.
fn update_state<F, T>(&self, expect: u8, new: u8, f: F) -> Result<AxResult<T>, u8>
where
F: FnOnce() -> AxResult<T>,
{
match self
.state
.compare_exchange(expect, STATE_BUSY, Ordering::Acquire, Ordering::Acquire)
{
Ok(_) => {
let res = f();
if res.is_ok() {
self.set_state(new);
} else {
self.set_state(expect);
}
Ok(res)
}
Err(old) => Err(old),
}
}
#[inline]
fn is_connecting(&self) -> bool {
self.get_state() == STATE_CONNECTING
}
#[inline]
/// Whether the socket is connected.
pub fn is_connected(&self) -> bool {
self.get_state() == STATE_CONNECTED
}
#[inline]
fn is_listening(&self) -> bool {
self.get_state() == STATE_LISTENING
}
fn bound_endpoint(&self) -> AxResult<IpListenEndpoint> {
// SAFETY: no other threads can read or write `self.local_addr`.
let local_addr = unsafe { self.local_addr.get().read() };
let port = if local_addr.port != 0 {
local_addr.port
} else {
get_ephemeral_port()?
};
assert_ne!(port, 0);
let addr = if !is_unspecified(local_addr.addr) {
Some(local_addr.addr)
} else {
None
};
Ok(IpListenEndpoint { addr, port })
}
fn poll_connect(&self) -> AxResult<PollState> {
// SAFETY: `self.handle` should be initialized above.
let handle = unsafe { self.handle.get().read().unwrap() };
let writable =
SOCKET_SET.with_socket::<tcp::Socket, _, _>(handle, |socket| match socket.state() {
State::SynSent => false, // wait for connection
State::Established => {
self.set_state(STATE_CONNECTED); // connected
debug!(
"TCP socket {}: connected to {}",
handle,
socket.remote_endpoint().unwrap(),
);
true
}
_ => {
unsafe {
self.local_addr.get().write(UNSPECIFIED_ENDPOINT);
self.peer_addr.get().write(UNSPECIFIED_ENDPOINT);
}
self.set_state(STATE_CLOSED); // connection failed
true
}
});
Ok(PollState {
readable: false,
writable,
})
}
fn poll_stream(&self) -> AxResult<PollState> {
// SAFETY: `self.handle` should be initialized in a connected socket.
let handle = unsafe { self.handle.get().read().unwrap() };
SOCKET_SET.with_socket::<tcp::Socket, _, _>(handle, |socket| {
Ok(PollState {
readable: !socket.may_recv() || socket.can_recv(),
writable: !socket.may_send() || socket.can_send(),
})
})
}
fn poll_listener(&self) -> AxResult<PollState> {
// SAFETY: `self.local_addr` should be initialized in a listening socket.
let local_addr = unsafe { self.local_addr.get().read() };
Ok(PollState {
readable: LISTEN_TABLE.can_accept(local_addr.port)?,
writable: false,
})
}
/// Block the current thread until the given function completes or fails.
///
/// If the socket is non-blocking, it calls the function once and returns
/// immediately. Otherwise, it may call the function multiple times if it
/// returns [`Err(WouldBlock)`](AxError::WouldBlock).
fn block_on<F, T>(&self, mut f: F) -> AxResult<T>
where
F: FnMut() -> AxResult<T>,
{
if self.is_nonblocking() {
f()
} else {
loop {
SOCKET_SET.poll_interfaces();
match f() {
Ok(t) => return Ok(t),
Err(AxError::WouldBlock) => axtask::yield_now(),
Err(e) => return Err(e),
}
}
}
}
}
impl Read for TcpSocket {
fn read(&mut self, buf: &mut [u8]) -> AxResult<usize> {
self.recv(buf)
}
}
impl Write for TcpSocket {
fn write(&mut self, buf: &[u8]) -> AxResult<usize> {
self.send(buf)
}
fn flush(&mut self) -> AxResult {
Err(AxError::Unsupported)
}
}
impl Drop for TcpSocket {
fn drop(&mut self) {
self.shutdown().ok();
// Safe because we have mut reference to `self`.
if let Some(handle) = unsafe { self.handle.get().read() } {
SOCKET_SET.remove(handle);
}
}
}
fn get_ephemeral_port() -> AxResult<u16> {
const PORT_START: u16 = 0xc000;
const PORT_END: u16 = 0xffff;
static CURR: Mutex<u16> = Mutex::new(PORT_START);
let mut curr = CURR.lock();
let mut tries = 0;
// TODO: more robust
while tries <= PORT_END - PORT_START {
let port = *curr;
if *curr == PORT_END {
*curr = PORT_START;
} else {
*curr += 1;
}
if LISTEN_TABLE.can_listen(port) {
return Ok(port);
}
tries += 1;
}
ax_err!(AddrInUse, "no avaliable ports!")
}