netwatch 0.18.0

Cross-platform monitoring for network interface changes
Documentation 
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

use libc::c_int;

use super::{MessageType, RoutingStack, WireFormat};

// Missing constants from libc.
// https://github.com/rust-lang/libc/issues/3711

// net/route.h
pub const RTF_GATEWAY: c_int = 0x2;
pub const RTAX_DST: c_int = 0;
pub const RTAX_GATEWAY: c_int = 1;
pub const RTAX_NETMASK: c_int = 2;
pub const RTAX_IFP: c_int = 4;
pub const RTAX_BRD: c_int = 7;
pub const RTAX_MAX: c_int = 8;
pub const RTM_VERSION: c_int = 5;
pub const RTA_DST: c_int = 0x1;
pub const RTA_GATEWAY: c_int = 0x2;
pub const RTA_NETMASK: c_int = 0x4;
pub const RTA_GENMASK: c_int = 0x8;
pub const RTA_IFP: c_int = 0x10;
pub const RTA_IFA: c_int = 0x20;
pub const RTA_AUTHOR: c_int = 0x40;
pub const RTA_BRD: c_int = 0x80;

// Message types
pub const RTM_ADD: c_int = 0x1;
pub const RTM_DELETE: c_int = 0x2;
pub const RTM_CHANGE: c_int = 0x3;
pub const RTM_GET: c_int = 0x4;
pub const RTM_LOSING: c_int = 0x5;
pub const RTM_REDIRECT: c_int = 0x6;
pub const RTM_MISS: c_int = 0x7;
pub const RTM_LOCK: c_int = 0x8;
pub const RTM_OLDADD: c_int = 0x9;
pub const RTM_OLDDEL: c_int = 0xa;
pub const RTM_RESOLVE: c_int = 0xb;
pub const RTM_NEWADDR: c_int = 0xc;
pub const RTM_DELADDR: c_int = 0xd;
pub const RTM_IFINFO: c_int = 0xe;
pub const RTM_NEWMADDR: c_int = 0xf;
pub const RTM_DELMADDR: c_int = 0x10;
pub const RTM_IFANNOUNCE: c_int = 0x11;
pub const RTM_IEEE80211: c_int = 0x12;

// Hardcoded based on the generated values here: https://cs.opensource.google/go/x/net/+/master:route/zsys_freebsd_amd64.go
#[cfg(target_arch = "x86_64")]
pub use self::amd64::*;
#[cfg(target_arch = "x86_64")]
mod amd64 {
    pub const SIZEOF_IF_MSGHDRL_FREE_BSD10: usize = 0xb0;
    pub const SIZEOF_IFA_MSGHDR_FREE_BSD10: usize = 0x14;
    pub const SIZEOF_IFA_MSGHDRL_FREE_BSD10: usize = 0xb0;
    pub const SIZEOF_IFMA_MSGHDR_FREE_BSD10: usize = 0x10;
    pub const SIZEOF_IF_ANNOUNCEMSGHDR_FREE_BSD10: usize = 0x18;

    pub const SIZEOF_RT_MSGHDR_FREE_BSD10: usize = 0x98;
    pub const SIZEOF_RT_METRICS_FREE_BSD10: usize = 0x70;

    pub const SIZEOF_IF_MSGHDR_FREE_BSD7: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD8: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD9: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD10: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD11: usize = 0xa8;

    pub const SIZEOF_IF_DATA_FREE_BSD7: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD8: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD9: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD10: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD11: usize = 0x98;

    pub const SIZEOF_IF_MSGHDRL_FREE_BSD10_EMU: usize = 0xb0;
    pub const SIZEOF_IFA_MSGHDR_FREE_BSD10_EMU: usize = 0x14;
    pub const SIZEOF_IFA_MSGHDRL_FREE_BSD10_EMU: usize = 0xb0;
    pub const SIZEOF_IFMA_MSGHDR_FREE_BSD10_EMU: usize = 0x10;
    pub const SIZEOF_IF_ANNOUNCEMSGHDR_FREE_BSD10_EMU: usize = 0x18;

    pub const SIZEOF_RT_MSGHDR_FREE_BSD10_EMU: usize = 0x98;
    pub const SIZEOF_RT_METRICS_FREE_BSD10_EMU: usize = 0x70;

    pub const SIZEOF_IF_MSGHDR_FREE_BSD7_EMU: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD8_EMU: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD9_EMU: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD10_EMU: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD11_EMU: usize = 0xa8;

    pub const SIZEOF_IF_DATA_FREE_BSD7_EMU: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD8_EMU: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD9_EMU: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD10_EMU: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD11_EMU: usize = 0x98;

    pub const SIZEOF_SOCKADDR_STORAGE: usize = 0x80;
    pub const SIZEOF_SOCKADDR_INET: usize = 0x10;
    pub const SIZEOF_SOCKADDR_INET6: usize = 0x1c;
}

// Hardcoded based on the generated values here: https://cs.opensource.google/go/x/net/+/master:route/zsys_freebsd_386.go
#[cfg(target_arch = "x86")]
pub use self::i686::*;
#[cfg(target_arch = "x86")]
mod i686 {
    pub const SIZEOF_IF_MSGHDRL_FREE_BSD10: usize = 0x68;
    pub const SIZEOF_IFA_MSGHDR_FREE_BSD10: usize = 0x14;
    pub const SIZEOF_IFA_MSGHDRL_FREE_BSD10: usize = 0x6c;
    pub const SIZEOF_IFMA_MSGHDR_FREE_BSD10: usize = 0x10;
    pub const SIZEOF_IF_ANNOUNCEMSGHDR_FREE_BSD10: usize = 0x18;

    pub const SIZEOF_RT_MSGHDR_FREE_BSD10: usize = 0x5c;
    pub const SIZEOF_RT_METRICS_FREE_BSD10: usize = 0x38;

    pub const SIZEOF_IF_MSGHDR_FREE_BSD7: usize = 0x60;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD8: usize = 0x60;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD9: usize = 0x60;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD10: usize = 0x64;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD11: usize = 0xa8;

    pub const SIZEOF_IF_DATA_FREE_BSD7: usize = 0x50;
    pub const SIZEOF_IF_DATA_FREE_BSD8: usize = 0x50;
    pub const SIZEOF_IF_DATA_FREE_BSD9: usize = 0x50;
    pub const SIZEOF_IF_DATA_FREE_BSD10: usize = 0x54;
    pub const SIZEOF_IF_DATA_FREE_BSD11: usize = 0x98;

    // MODIFIED BY HAND FOR 386 EMULATION ON AMD64
    // 386 EMULATION USES THE UNDERLYING RAW DATA LAYOUT

    pub const SIZEOF_IF_MSGHDRL_FREE_BSD10_EMU: usize = 0xb0;
    pub const SIZEOF_IFA_MSGHDR_FREE_BSD10_EMU: usize = 0x14;
    pub const SIZEOF_IFA_MSGHDRL_FREE_BSD10_EMU: usize = 0xb0;
    pub const SIZEOF_IFMA_MSGHDR_FREE_BSD10_EMU: usize = 0x10;
    pub const SIZEOF_IF_ANNOUNCEMSGHDR_FREE_BSD10_EMU: usize = 0x18;

    pub const SIZEOF_RT_MSGHDR_FREE_BSD10_EMU: usize = 0x98;
    pub const SIZEOF_RT_METRICS_FREE_BSD10_EMU: usize = 0x70;

    pub const SIZEOF_IF_MSGHDR_FREE_BSD7_EMU: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD8_EMU: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD9_EMU: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD10_EMU: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD11_EMU: usize = 0xa8;

    pub const SIZEOF_IF_DATA_FREE_BSD7_EMU: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD8_EMU: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD9_EMU: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD10_EMU: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD11_EMU: usize = 0x98;

    pub const SIZEOF_SOCKADDR_STORAGE: usize = 0x80;
    pub const SIZEOF_SOCKADDR_INET: usize = 0x10;
    pub const SIZEOF_SOCKADDR_INET6: usize = 0x1c;
}

// Hardcoded based on the generated values here: https://cs.opensource.google/go/x/net/+/master:route/zsys_freebsd_arm.go
#[cfg(target_arch = "arm")]
pub use self::arm::*;
#[cfg(target_arch = "arm")]
mod arm {
    pub const SIZEOF_IF_MSGHDRL_FREE_BSD10: usize = 0x68;
    pub const SIZEOF_IFA_MSGHDR_FREE_BSD10: usize = 0x14;
    pub const SIZEOF_IFA_MSGHDRL_FREE_BSD10: usize = 0x6c;
    pub const SIZEOF_IFMA_MSGHDR_FREE_BSD10: usize = 0x10;
    pub const SIZEOF_IF_ANNOUNCEMSGHDR_FREE_BSD10: usize = 0x18;

    pub const SIZEOF_RT_MSGHDR_FREE_BSD10: usize = 0x5c;
    pub const SIZEOF_RT_METRICS_FREE_BSD10: usize = 0x38;

    pub const SIZEOF_IF_MSGHDR_FREE_BSD7: usize = 0x70;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD8: usize = 0x70;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD9: usize = 0x70;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD10: usize = 0x70;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD11: usize = 0xa8;

    pub const SIZEOF_IF_DATA_FREE_BSD7: usize = 0x60;
    pub const SIZEOF_IF_DATA_FREE_BSD8: usize = 0x60;
    pub const SIZEOF_IF_DATA_FREE_BSD9: usize = 0x60;
    pub const SIZEOF_IF_DATA_FREE_BSD10: usize = 0x60;
    pub const SIZEOF_IF_DATA_FREE_BSD11: usize = 0x98;

    pub const SIZEOF_IF_MSGHDRL_FREE_BSD10_EMU: usize = 0x68;
    pub const SIZEOF_IFA_MSGHDR_FREE_BSD10_EMU: usize = 0x14;
    pub const SIZEOF_IFA_MSGHDRL_FREE_BSD10_EMU: usize = 0x6c;
    pub const SIZEOF_IFMA_MSGHDR_FREE_BSD10_EMU: usize = 0x10;
    pub const SIZEOF_IF_ANNOUNCEMSGHDR_FREE_BSD10_EMU: usize = 0x18;

    pub const SIZEOF_RT_MSGHDR_FREE_BSD10_EMU: usize = 0x5c;
    pub const SIZEOF_RT_METRICS_FREE_BSD10_EMU: usize = 0x38;

    pub const SIZEOF_IF_MSGHDR_FREE_BSD7_EMU: usize = 0x70;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD8_EMU: usize = 0x70;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD9_EMU: usize = 0x70;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD10_EMU: usize = 0x70;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD11_EMU: usize = 0xa8;

    pub const SIZEOF_IF_DATA_FREE_BSD7_EMU: usize = 0x60;
    pub const SIZEOF_IF_DATA_FREE_BSD8_EMU: usize = 0x60;
    pub const SIZEOF_IF_DATA_FREE_BSD9_EMU: usize = 0x60;
    pub const SIZEOF_IF_DATA_FREE_BSD10_EMU: usize = 0x60;
    pub const SIZEOF_IF_DATA_FREE_BSD11_EMU: usize = 0x98;

    pub const SIZEOF_SOCKADDR_STORAGE: usize = 0x80;
    pub const SIZEOF_SOCKADDR_INET: usize = 0x10;
    pub const SIZEOF_SOCKADDR_INET6: usize = 0x1c;
}

// Hardcoded based on the generated values here: https://cs.opensource.google/go/x/net/+/master:route/zsys_freebsd_arm.go
#[cfg(target_arch = "aarch64")]
pub use self::arm64::*;
#[cfg(target_arch = "aarch64")]
mod arm64 {
    pub const SIZEOF_IF_MSGHDRL_FREE_BSD10: usize = 0xb0;
    pub const SIZEOF_IFA_MSGHDR_FREE_BSD10: usize = 0x14;
    pub const SIZEOF_IFA_MSGHDRL_FREE_BSD10: usize = 0xb0;
    pub const SIZEOF_IFMA_MSGHDR_FREE_BSD10: usize = 0x10;
    pub const SIZEOF_IF_ANNOUNCEMSGHDR_FREE_BSD10: usize = 0x18;

    pub const SIZEOF_RT_MSGHDR_FREE_BSD10: usize = 0x98;
    pub const SIZEOF_RT_METRICS_FREE_BSD10: usize = 0x70;

    pub const SIZEOF_IF_MSGHDR_FREE_BSD7: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD8: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD9: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD10: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD11: usize = 0xa8;

    pub const SIZEOF_IF_DATA_FREE_BSD7: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD8: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD9: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD10: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD11: usize = 0x98;

    pub const SIZEOF_IF_MSGHDRL_FREE_BSD10_EMU: usize = 0xb0;
    pub const SIZEOF_IFA_MSGHDR_FREE_BSD10_EMU: usize = 0x14;
    pub const SIZEOF_IFA_MSGHDRL_FREE_BSD10_EMU: usize = 0xb0;
    pub const SIZEOF_IFMA_MSGHDR_FREE_BSD10_EMU: usize = 0x10;
    pub const SIZEOF_IF_ANNOUNCEMSGHDR_FREE_BSD10_EMU: usize = 0x18;

    pub const SIZEOF_RT_MSGHDR_FREE_BSD10_EMU: usize = 0x98;
    pub const SIZEOF_RT_METRICS_FREE_BSD10_EMU: usize = 0x70;

    pub const SIZEOF_IF_MSGHDR_FREE_BSD7_EMU: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD8_EMU: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD9_EMU: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD10_EMU: usize = 0xa8;
    pub const SIZEOF_IF_MSGHDR_FREE_BSD11_EMU: usize = 0xa8;

    pub const SIZEOF_IF_DATA_FREE_BSD7_EMU: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD8_EMU: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD9_EMU: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD10_EMU: usize = 0x98;
    pub const SIZEOF_IF_DATA_FREE_BSD11_EMU: usize = 0x98;

    pub const SIZEOF_SOCKADDR_STORAGE: usize = 0x80;
    pub const SIZEOF_SOCKADDR_INET: usize = 0x10;
    pub const SIZEOF_SOCKADDR_INET6: usize = 0x1c;
}

/// 386 emulation on amd64
fn detect_compat_freebsd32() -> bool {
    // TODO: implement detection when someone actually needs it
    false
}

pub(super) fn probe_routing_stack() -> RoutingStack {
    let rtm_version = RTM_VERSION;

    // Currently only BSD11 support is implemented.
    // At the time of this writing rust supports 10 and 11, if this is a problem
    // please file an issue.

    let (rtm, ifm, ifam, ifmam, ifanm) = if detect_compat_freebsd32() {
        unimplemented!()
    } else {
        let rtm = WireFormat {
            ext_off: SIZEOF_RT_MSGHDR_FREE_BSD10 - SIZEOF_RT_METRICS_FREE_BSD10,
            body_off: SIZEOF_RT_MSGHDR_FREE_BSD10,
            typ: MessageType::Route,
        };
        let ifm = WireFormat {
            ext_off: 16,
            body_off: SIZEOF_IF_MSGHDR_FREE_BSD11,
            typ: MessageType::Interface,
        };
        let ifam = WireFormat {
            ext_off: SIZEOF_IFA_MSGHDR_FREE_BSD10,
            body_off: SIZEOF_IFA_MSGHDR_FREE_BSD10,
            typ: MessageType::InterfaceAddr,
        };
        let ifmam = WireFormat {
            ext_off: SIZEOF_IFMA_MSGHDR_FREE_BSD10,
            body_off: SIZEOF_IFMA_MSGHDR_FREE_BSD10,
            typ: MessageType::InterfaceMulticastAddr,
        };
        let ifanm = WireFormat {
            ext_off: SIZEOF_IF_ANNOUNCEMSGHDR_FREE_BSD10,
            body_off: SIZEOF_IF_ANNOUNCEMSGHDR_FREE_BSD10,
            typ: MessageType::InterfaceAnnounce,
        };
        (rtm, ifm, ifam, ifmam, ifanm)
    };

    let wire_formats = [
        (RTM_ADD, rtm),
        (RTM_DELETE, rtm),
        (RTM_CHANGE, rtm),
        (RTM_GET, rtm),
        (RTM_LOSING, rtm),
        (RTM_REDIRECT, rtm),
        (RTM_MISS, rtm),
        (RTM_LOCK, rtm),
        (RTM_RESOLVE, rtm),
        (RTM_NEWADDR, ifam),
        (RTM_DELADDR, ifam),
        (RTM_IFINFO, ifm),
        (RTM_NEWMADDR, ifmam),
        (RTM_DELMADDR, ifmam),
        (RTM_IFANNOUNCE, ifanm),
        (RTM_IEEE80211, ifanm),
    ]
    .into_iter()
    .collect();
    RoutingStack {
        rtm_version,
        wire_formats,
        kernel_align: 4,
    }
}