containerization-framework 0.10.1

Rust bindings for Apple's Containerization framework: Linux containers in lightweight VMs, in-process and without a daemon.
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

//! `ProcNetSnmp`, and its nested `ProcNetSnmp.Counters`.

use crate::error::Error;
use crate::platform;
use crate::platform::ffi;

/// `ProcNetSnmp.Counters`, the traffic counters for one protocol. [`Default`]
/// is Swift's `init()`: zero packets, and every other counter `None`.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub struct Counters {
  pub received_packets: u64,
  pub transmitted_packets: u64,
  /// `None` when the kernel keeps no byte counter for the protocol.
  pub received_bytes: Option<u64>,
  pub transmitted_bytes: Option<u64>,
  /// Packets discarded for lack of resources or a destination. The kernel's
  /// causes differ for each protocol. `None` when the protocol has no
  /// matching counter, and zero when none happened.
  pub received_drops: Option<u64>,
  pub transmitted_drops: Option<u64>,
  /// Malformed or failed packets. As with drops, the causes differ for each
  /// protocol.
  pub received_errors: Option<u64>,
  pub transmitted_errors: Option<u64>,
}

/// `ProcNetSnmp`, the protocol traffic counters of a network namespace, as
/// the kernel reports them in `/proc/net/snmp`, `/proc/net/netstat` and
/// `/proc/net/snmp6`. They cover the whole namespace, including loopback,
/// and not one interface. [`Default`] is Swift's `init()`: every counter at
/// its default, and no IPv6 counters.
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub struct ProcNetSnmp {
  /// TCP segments, both IPv4 and IPv6, because the kernel shares its TCP
  /// counters between the two families.
  pub tcp: Counters,
  /// IPv4 UDP datagrams.
  pub udp: Counters,
  /// IPv4 ICMP messages.
  pub icmp: Counters,
  /// All IPv4 packets and bytes.
  pub ip: Counters,
  /// IPv6 UDP datagrams. `None` without `/proc/net/snmp6`.
  pub udp6: Option<Counters>,
  /// IPv6 ICMP messages. `None` without `/proc/net/snmp6`.
  pub icmp6: Option<Counters>,
  /// All IPv6 packets and bytes. `None` without `/proc/net/snmp6`.
  pub ip6: Option<Counters>,
}

impl ProcNetSnmp {
  /// `ProcNetSnmp(snmp:netstat:snmp6:)`, which parses the contents of
  /// `/proc/net/snmp` and, if given, `/proc/net/netstat` and
  /// `/proc/net/snmp6`. Swift matches fields by name, so columns that newer
  /// kernels add don't break parsing.
  pub fn new(snmp: &str, netstat: Option<&str>, snmp6: Option<&str>) -> Result<Self, Error> {
    platform::outcome(
      ffi::cz_proc_net_snmp_new(snmp, netstat.map(str::to_string), snmp6.map(str::to_string)),
      "parse network protocol counters",
    )
    .map(|outcome| outcome.proc_net_snmp())
  }

  /// `ProcNetSnmp.read(pid:)`, which reads the counters of the network
  /// namespace of process `pid`, or of the calling thread for `None`. Only
  /// Linux has these files, so on macOS it fails.
  pub fn read(pid: Option<i32>) -> Result<Self, Error> {
    platform::outcome(ffi::cz_proc_net_snmp_read(pid), "read network protocol counters")
      .map(|outcome| outcome.proc_net_snmp())
  }
}