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
use std::cell::{Cell, RefCell};
use std::ffi::{CString, OsStr};
use std::net::{Ipv4Addr, SocketAddrV4};
use std::num::NonZeroU8;
use std::ops::{Deref, DerefMut};
use std::sync::Arc;
use atomic_refcell::AtomicRefCell;
use shadow_shim_helper_rs::util::SyncSendPointer;
use shadow_shim_helper_rs::HostId;
use crate::core::configuration::QDiscMode;
use crate::core::worker::Worker;
use crate::cshadow;
use crate::host::descriptor::socket::abstract_unix_ns::AbstractUnixNamespace;
use crate::host::descriptor::socket::inet::InetSocket;
use crate::host::network::interface::{NetworkInterface, PcapOptions};
// The start of our random port range in host order, used if application doesn't
// specify the port it wants to bind to, and for client connections.
const MIN_RANDOM_PORT: u16 = 10000;
/// Represents a network namespace.
///
/// Can be thought of as roughly equivalent to a Linux `struct net`. Shadow doesn't support multiple
/// network namespaces, but this `NetworkNamespace` allows us to consolidate the host's networking
/// objects, and hopefully might make it easier to support multiple network namespaces if we want to
/// in the future.
pub struct NetworkNamespace {
// map abstract socket addresses to unix sockets
pub unix: Arc<AtomicRefCell<AbstractUnixNamespace>>,
pub localhost: RefCell<NetworkInterface>,
pub internet: RefCell<NetworkInterface>,
// TODO: use a Rust address type
pub default_address: SyncSendPointer<cshadow::Address>,
pub default_ip: Ipv4Addr,
// used for debugging to make sure we've cleaned up before being dropped
has_run_cleanup: Cell<bool>,
}
impl NetworkNamespace {
/// # Safety
///
/// `dns` must be a valid pointer.
pub unsafe fn new(
host_id: HostId,
hostname: Vec<NonZeroU8>,
public_ip: Ipv4Addr,
pcap: Option<PcapOptions>,
qdisc: QDiscMode,
dns: *mut cshadow::DNS,
) -> Self {
let (localhost, local_addr) = unsafe {
Self::setup_net_interface(
OsStr::new("lo"),
&InterfaceOptions {
host_id,
hostname: hostname.clone(),
ip: Ipv4Addr::LOCALHOST,
pcap: pcap.clone(),
qdisc,
},
dns,
)
};
unsafe { cshadow::address_unref(local_addr) };
let (internet, public_addr) = unsafe {
Self::setup_net_interface(
OsStr::new("eth0"),
&InterfaceOptions {
host_id,
hostname,
ip: public_ip,
pcap,
qdisc,
},
dns,
)
};
Self {
unix: Arc::new(AtomicRefCell::new(AbstractUnixNamespace::new())),
localhost: RefCell::new(localhost),
internet: RefCell::new(internet),
default_address: unsafe { SyncSendPointer::new(public_addr) },
default_ip: public_ip,
has_run_cleanup: Cell::new(false),
}
}
/// Must free the returned `*mut cshadow::Address` using [`cshadow::address_unref`].
unsafe fn setup_net_interface(
name: &OsStr,
options: &InterfaceOptions,
dns: *mut cshadow::DNS,
) -> (NetworkInterface, *mut cshadow::Address) {
let ip = u32::from(options.ip).to_be();
// hostname is shadowed so that we can't accidentally drop the CString before the end of the
// scope
let hostname: CString = options.hostname.clone().into();
let hostname = hostname.as_ptr();
let addr = unsafe { cshadow::dns_register(dns, options.host_id, hostname, ip) };
assert!(!addr.is_null());
let interface = unsafe {
NetworkInterface::new(
options.host_id,
addr,
name,
options.pcap.clone(),
options.qdisc,
)
};
(interface, addr)
}
/// Clean up the network namespace. This should be called while `Worker` has the active host
/// set. The `dns` object should be the same object that was originally provided to
/// [`Self::new`].
pub fn cleanup(&self, dns: &cshadow::DNS) {
assert!(!self.has_run_cleanup.get());
let dns = std::ptr::from_ref(dns);
// deregistering localhost is a no-op, so we skip it
unsafe {
cshadow::dns_deregister(dns.cast_mut(), self.default_address.ptr());
}
// we need to unref all sockets and free them before we drop the host, otherwise they'll try
// to access the global host and panic since there is no host
self.localhost.borrow().remove_all_sockets();
self.internet.borrow().remove_all_sockets();
self.has_run_cleanup.set(true);
}
/// Returns `None` if there is no such interface.
#[track_caller]
pub fn interface_borrow(
&self,
addr: Ipv4Addr,
) -> Option<impl Deref<Target = NetworkInterface> + '_> {
// Notes:
// - The `is_loopback` matches all loopback addresses, but shadow will only work correctly
// with 127.0.0.1. Using any other loopback address will lead to problems.
// - If the address is 0.0.0.0, we return the `internet` interface. This is not ideal if a
// socket bound to 0.0.0.0 is trying to send a localhost packet and uses this method to
// get the network interface, since the packet will be sent on the internet interface
// instead of loopback. It's not clear if this will lead to bugs.
if addr.is_loopback() {
Some(self.localhost.borrow())
} else if addr == self.default_ip || addr.is_unspecified() {
Some(self.internet.borrow())
} else {
None
}
}
/// Returns `None` if there is no such interface.
#[track_caller]
pub fn interface_borrow_mut(
&self,
addr: Ipv4Addr,
) -> Option<impl DerefMut<Target = NetworkInterface> + '_> {
// Notes:
// - The `is_loopback` matches all loopback addresses, but shadow will only work correctly
// with 127.0.0.1. Using any other loopback address will lead to problems.
// - If the address is 0.0.0.0, we return the `internet` interface. This is not ideal if a
// socket bound to 0.0.0.0 is trying to send a localhost packet and uses this method to
// get the network interface, since the packet will be sent on the internet interface
// instead of loopback. It's not clear if this will lead to bugs.
if addr.is_loopback() {
Some(self.localhost.borrow_mut())
} else if addr == self.default_ip || addr.is_unspecified() {
Some(self.internet.borrow_mut())
} else {
None
}
}
pub fn is_addr_in_use(
&self,
protocol_type: cshadow::ProtocolType,
src: SocketAddrV4,
dst: SocketAddrV4,
) -> Result<bool, NoInterface> {
if src.ip().is_unspecified() {
Ok(self
.localhost
.borrow()
.is_addr_in_use(protocol_type, src.port(), dst)
|| self
.internet
.borrow()
.is_addr_in_use(protocol_type, src.port(), dst))
} else {
match self.interface_borrow(*src.ip()) {
Some(i) => Ok(i.is_addr_in_use(protocol_type, src.port(), dst)),
None => Err(NoInterface),
}
}
}
/// Returns a random port in host byte order.
pub fn get_random_free_port(
&self,
protocol_type: cshadow::ProtocolType,
interface_ip: Ipv4Addr,
peer: SocketAddrV4,
mut rng: impl rand::Rng,
) -> Option<u16> {
// we need a random port that is free everywhere we need it to be.
// we have two modes here: first we just try grabbing a random port until we
// get a free one. if we cannot find one fast enough, then as a fallback we
// do an inefficient linear search that is guaranteed to succeed or fail.
// if choosing randomly doesn't succeed within 10 tries, then we have already
// allocated a lot of ports (>90% on average). then we fall back to linear search.
for _ in 0..10 {
let random_port = rng.gen_range(MIN_RANDOM_PORT..=u16::MAX);
// `is_addr_in_use` will check all interfaces in the case of INADDR_ANY
let specific_in_use = self
.is_addr_in_use(
protocol_type,
SocketAddrV4::new(interface_ip, random_port),
peer,
)
.unwrap_or(true);
let generic_in_use = self
.is_addr_in_use(
protocol_type,
SocketAddrV4::new(interface_ip, random_port),
SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, 0),
)
.unwrap_or(true);
if !specific_in_use && !generic_in_use {
return Some(random_port);
}
}
// now if we tried too many times and still don't have a port, fall back
// to a linear search to make sure we get a free port if we have one.
// but start from a random port instead of the min.
let start = rng.gen_range(MIN_RANDOM_PORT..=u16::MAX);
for port in (start..=u16::MAX).chain(MIN_RANDOM_PORT..start) {
let specific_in_use = self
.is_addr_in_use(protocol_type, SocketAddrV4::new(interface_ip, port), peer)
.unwrap_or(true);
let generic_in_use = self
.is_addr_in_use(
protocol_type,
SocketAddrV4::new(interface_ip, port),
SocketAddrV4::new(Ipv4Addr::UNSPECIFIED, 0),
)
.unwrap_or(true);
if !specific_in_use && !generic_in_use {
return Some(port);
}
}
log::warn!("unable to find free ephemeral port for {protocol_type} peer {peer}");
None
}
/// Associate the socket with any applicable network interfaces. The socket will be
/// automatically disassociated when the returned handle is dropped.
///
/// # Safety
///
/// Pointer args must be safely dereferenceable.
pub unsafe fn associate_interface(
&self,
socket: &InetSocket,
protocol: cshadow::ProtocolType,
bind_addr: SocketAddrV4,
peer_addr: SocketAddrV4,
) -> AssociationHandle {
if bind_addr.ip().is_unspecified() {
// need to associate all interfaces
self.localhost
.borrow()
.associate(socket, protocol, bind_addr.port(), peer_addr);
self.internet
.borrow()
.associate(socket, protocol, bind_addr.port(), peer_addr);
} else {
// TODO: return error if interface does not exist
if let Some(iface) = self.interface_borrow(*bind_addr.ip()) {
iface.associate(socket, protocol, bind_addr.port(), peer_addr);
}
}
AssociationHandle {
protocol,
local_addr: bind_addr,
remote_addr: peer_addr,
}
}
/// Disassociate the socket associated using the local and remote addresses from all network
/// interfaces.
///
/// Is only public so that it can be called from `host_disassociateInterface`. Normally this
/// should only be called from the [`AssociationHandle`].
pub fn disassociate_interface(
&self,
protocol: cshadow::ProtocolType,
bind_addr: SocketAddrV4,
peer_addr: SocketAddrV4,
) {
if bind_addr.ip().is_unspecified() {
// need to disassociate all interfaces
self.localhost
.borrow()
.disassociate(protocol, bind_addr.port(), peer_addr);
self.internet
.borrow()
.disassociate(protocol, bind_addr.port(), peer_addr);
} else {
// TODO: return error if interface does not exist
if let Some(iface) = self.interface_borrow(*bind_addr.ip()) {
iface.disassociate(protocol, bind_addr.port(), peer_addr);
}
}
}
}
impl std::ops::Drop for NetworkNamespace {
fn drop(&mut self) {
unsafe { cshadow::address_unref(self.default_address.ptr()) };
if !self.has_run_cleanup.get() && !std::thread::panicking() {
debug_panic!("Dropped the network namespace before it has been cleaned up");
}
}
}
struct InterfaceOptions {
pub host_id: HostId,
pub hostname: Vec<NonZeroU8>,
pub ip: Ipv4Addr,
pub pcap: Option<PcapOptions>,
pub qdisc: QDiscMode,
}
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub struct NoInterface;
impl std::fmt::Display for NoInterface {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "No interface available")
}
}
impl std::error::Error for NoInterface {}
/// A handle for a socket association with a network interface(s).
///
/// The network association will be dissolved when this handle is dropped (similar to
/// [`callback_queue::Handle`](crate::utility::callback_queue::Handle)).
#[derive(Debug)]
pub struct AssociationHandle {
protocol: cshadow::ProtocolType,
local_addr: SocketAddrV4,
remote_addr: SocketAddrV4,
}
impl AssociationHandle {
pub fn local_addr(&self) -> SocketAddrV4 {
self.local_addr
}
pub fn remote_addr(&self) -> SocketAddrV4 {
self.remote_addr
}
}
impl std::ops::Drop for AssociationHandle {
fn drop(&mut self) {
Worker::with_active_host(|host| {
host.network_namespace_borrow().disassociate_interface(
self.protocol,
self.local_addr,
self.remote_addr,
);
})
.unwrap();
}
}