usb_vsock/
lib.rs

1// Copyright 2025 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4#![warn(missing_docs, unsafe_op_in_unsafe_fn)]
5//! A transport-agnostic library for implementing a vsock bridge over a usb bulk device.
6
7mod connection;
8mod packet;
9
10pub use connection::*;
11pub use packet::*;
12
13/// An address for a vsock packet transmitted over USB. Since this library does not implement
14/// policy decisions, it includes all four components of a vsock address pair even though some
15/// may not be appropriate for some situations.
16#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
17pub struct Address {
18    /// For Connect, Reset, Accept, and Data packets this represents the device side's address.
19    /// Usually this will be a special value representing either that it is simply "the device",
20    /// or zero along with the rest of the cid and port fields to indicate that it's a control stream
21    /// packet. Must be zero for any other packet type.
22    pub device_cid: u32,
23    /// For Connect, Reset, Accept, and Data packets this represents the host side's address.
24    /// Usually this will be a special value representing either that it is simply "the host",
25    /// or zero along with the rest of the cid and port fields to indicate that it's a control stream
26    /// packet. Must be zero for any other packet type.
27    pub host_cid: u32,
28    /// For Connect, Reset, Accept, and Data packets this represents the device side's port.
29    /// This must be a valid positive value for any of those packet types, unless all of the cid and
30    /// port fields are also zero, in which case it is a control stream packet. Must be zero for any
31    /// other packet type.
32    pub device_port: u32,
33    /// For Connect, Reset, Accept, and Data packets this represents the host side's port.
34    /// This must be a valid positive value for any of those packet types, unless all of the cid and
35    /// port fields are also zero, in which case it is a control stream packet. Must be zero for any
36    /// other packet type.
37    pub host_port: u32,
38}
39
40impl Address {
41    /// Returns true if all the fields of this address are zero (which usually means it's a control
42    /// packet of some sort).
43    pub fn is_zeros(&self) -> bool {
44        *self == Self::default()
45    }
46}
47
48impl From<&Header> for Address {
49    fn from(header: &Header) -> Self {
50        Self {
51            device_cid: header.device_cid.get(),
52            host_cid: header.host_cid.get(),
53            device_port: header.device_port.get(),
54            host_port: header.host_port.get(),
55        }
56    }
57}
usb_vsock/lib.rs

usb_vsock/
lib.rs
