xref: /xnu-10002.1.13/bsd/net/bpf.h (revision 1031c584a5e37aff177559b9f69dbd3c8c3fd30a)
1 /*
2  * Copyright (c) 2000-2022 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /*
29  * Copyright (c) 1990, 1991, 1993
30  *	The Regents of the University of California.  All rights reserved.
31  *
32  * This code is derived from the Stanford/CMU enet packet filter,
33  * (net/enet.c) distributed as part of 4.3BSD, and code contributed
34  * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
35  * Berkeley Laboratory.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. All advertising materials mentioning features or use of this software
46  *    must display the following acknowledgement:
47  *	This product includes software developed by the University of
48  *	California, Berkeley and its contributors.
49  * 4. Neither the name of the University nor the names of its contributors
50  *    may be used to endorse or promote products derived from this software
51  *    without specific prior written permission.
52  *
53  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
54  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
55  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
56  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
57  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
58  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
59  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
61  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
62  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63  * SUCH DAMAGE.
64  *
65  *      @(#)bpf.h	8.1 (Berkeley) 6/10/93
66  *	@(#)bpf.h	1.34 (LBL)     6/16/96
67  *
68  * $FreeBSD: src/sys/net/bpf.h,v 1.21.2.3 2001/08/01 00:23:13 fenner Exp $
69  */
70 /*
71  * NOTICE: This file was modified by SPARTA, Inc. in 2006 to introduce
72  * support for mandatory and extensible security protections.  This notice
73  * is included in support of clause 2.2 (b) of the Apple Public License,
74  * Version 2.0.
75  */
76 
77 #ifndef _NET_BPF_H_
78 #define _NET_BPF_H_
79 
80 #include <stdint.h>
81 
82 #if !defined(DRIVERKIT)
83 #include <sys/param.h>
84 #include <sys/appleapiopts.h>
85 #include <sys/types.h>
86 #include <sys/time.h>
87 #include <sys/cdefs.h>
88 
89 #ifdef PRIVATE
90 #include <net/if_var.h>
91 #include <uuid/uuid.h>
92 
93 struct bpf_setup_args {
94 	uuid_t  bsa_uuid;
95 	char    bsa_ifname[IFNAMSIZ];
96 };
97 #endif /* PRIVATE */
98 
99 #ifdef KERNEL
100 #include <sys/kernel_types.h>
101 
102 #if !defined(__i386__) && !defined(__x86_64__)
103 #define BPF_ALIGN 1
104 #else /* defined(__i386__) || defined(__x86_64__) */
105 #define BPF_ALIGN 0
106 #endif /* defined(__i386__) || defined(__x86_64__) */
107 
108 #if !BPF_ALIGN
109 #define EXTRACT_SHORT(p)        ((u_int16_t)ntohs(*(u_int16_t *)(void *)p))
110 #define EXTRACT_LONG(p)         (ntohl(*(u_int32_t *)(void *)p))
111 #else
112 #define EXTRACT_SHORT(p) \
113 	((u_int16_t)\
114 	        ((u_int16_t)*((u_char *)p+0)<<8|\
115 	         (u_int16_t)*((u_char *)p+1)<<0))
116 #define EXTRACT_LONG(p) \
117 	        ((u_int32_t)*((u_char *)p+0)<<24|\
118 	         (u_int32_t)*((u_char *)p+1)<<16|\
119 	         (u_int32_t)*((u_char *)p+2)<<8|\
120 	         (u_int32_t)*((u_char *)p+3)<<0)
121 #endif
122 
123 #endif /* KERNEL */
124 
125 /* BSD style release date */
126 #define BPF_RELEASE 199606
127 
128 typedef int32_t   bpf_int32;
129 typedef u_int32_t bpf_u_int32;
130 
131 /*
132  * Alignment macros.  BPF_WORDALIGN rounds up to the next
133  * even multiple of BPF_ALIGNMENT.
134  */
135 #define BPF_ALIGNMENT sizeof(int32_t)
136 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
137 
138 #define BPF_MAXINSNS 512
139 #define BPF_MAXBUFSIZE 0x80000
140 #define BPF_MINBUFSIZE 32
141 
142 /*
143  *  Structure for BIOCSETF.
144  */
145 struct bpf_program {
146 	u_int bf_len;
147 	struct bpf_insn *bf_insns;
148 };
149 
150 #ifdef KERNEL_PRIVATE
151 /*
152  * LP64 version of bpf_program.  all pointers
153  * grow when we're dealing with a 64-bit process.
154  * WARNING - keep in sync with bpf_program
155  */
156 struct bpf_program64 {
157 	u_int           bf_len;
158 	user64_addr_t   bf_insns __attribute__((aligned(8)));
159 };
160 
161 struct bpf_program32 {
162 	u_int           bf_len;
163 	user32_addr_t   bf_insns;
164 };
165 #endif /* KERNEL_PRIVATE */
166 
167 /*
168  * Struct returned by BIOCGSTATS.
169  */
170 struct bpf_stat {
171 	u_int bs_recv;          /* number of packets received */
172 	u_int bs_drop;          /* number of packets dropped */
173 };
174 
175 /*
176  * Struct return by BIOCVERSION.  This represents the version number of
177  * the filter language described by the instruction encodings below.
178  * bpf understands a program iff kernel_major == filter_major &&
179  * kernel_minor >= filter_minor, that is, if the value returned by the
180  * running kernel has the same major number and a minor number equal
181  * equal to or less than the filter being downloaded.  Otherwise, the
182  * results are undefined, meaning an error may be returned or packets
183  * may be accepted haphazardly.
184  * It has nothing to do with the source code version.
185  */
186 struct bpf_version {
187 	u_short bv_major;
188 	u_short bv_minor;
189 };
190 
191 #ifdef PRIVATE
192 struct bpf_comp_stats {
193 	uint64_t bcs_total_read; /* number of packets read from device */
194 	uint64_t bcs_total_size; /* total size of filtered packets */
195 	uint64_t bcs_total_hdr_size; /* total header size of captured packets */
196 	uint64_t bcs_count_no_common_prefix; /* count of packets not compressible */
197 	uint64_t bcs_count_compressed_prefix; /* count of compressed packets */
198 	uint64_t bcs_total_compressed_prefix_size; /* total size of compressed data */
199 	uint64_t bcs_max_compressed_prefix_size; /* max compressed data size */
200 };
201 #endif /* PRIVATE */
202 
203 #if defined(__LP64__)
204 #include <sys/_types/_timeval32.h>
205 
206 #define BPF_TIMEVAL timeval32
207 #else
208 #define BPF_TIMEVAL timeval
209 #endif /* __LP64__ */
210 /* Current version number of filter architecture. */
211 #define BPF_MAJOR_VERSION 1
212 #define BPF_MINOR_VERSION 1
213 
214 #define BIOCGBLEN       _IOR('B',102, u_int)
215 #define BIOCSBLEN       _IOWR('B',102, u_int)
216 #define BIOCSETF        _IOW('B',103, struct bpf_program)
217 #ifdef KERNEL_PRIVATE
218 #define BIOCSETF64      _IOW('B',103, struct bpf_program64)
219 #define BIOCSETF32      _IOW('B',103, struct bpf_program32)
220 #endif /* KERNEL_PRIVATE */
221 #define BIOCFLUSH       _IO('B',104)
222 #define BIOCPROMISC     _IO('B',105)
223 #define BIOCGDLT        _IOR('B',106, u_int)
224 #define BIOCGETIF       _IOR('B',107, struct ifreq)
225 #define BIOCSETIF       _IOW('B',108, struct ifreq)
226 #define BIOCSRTIMEOUT   _IOW('B',109, struct timeval)
227 #ifdef KERNEL_PRIVATE
228 #define BIOCSRTIMEOUT64 _IOW('B',109, struct user64_timeval)
229 #define BIOCSRTIMEOUT32 _IOW('B',109, struct user32_timeval)
230 #endif /* KERNEL_PRIVATE */
231 #define BIOCGRTIMEOUT   _IOR('B',110, struct timeval)
232 #ifdef KERNEL_PRIVATE
233 #define BIOCGRTIMEOUT64 _IOR('B',110, struct user64_timeval)
234 #define BIOCGRTIMEOUT32 _IOR('B',110, struct user32_timeval)
235 #endif /* KERNEL_PRIVATE */
236 #define BIOCGSTATS      _IOR('B',111, struct bpf_stat)
237 #define BIOCIMMEDIATE   _IOW('B',112, u_int)
238 #define BIOCVERSION     _IOR('B',113, struct bpf_version)
239 #define BIOCGRSIG       _IOR('B',114, u_int)
240 #define BIOCSRSIG       _IOW('B',115, u_int)
241 #define BIOCGHDRCMPLT   _IOR('B',116, u_int)
242 #define BIOCSHDRCMPLT   _IOW('B',117, u_int)
243 #define BIOCGSEESENT    _IOR('B',118, u_int)
244 #define BIOCSSEESENT    _IOW('B',119, u_int)
245 #define BIOCSDLT        _IOW('B',120, u_int)
246 #define BIOCGDLTLIST    _IOWR('B',121, struct bpf_dltlist)
247 #ifdef PRIVATE
248 #define BIOCGETTC       _IOR('B', 122, int)
249 #define BIOCSETTC       _IOW('B', 123, int)
250 #define BIOCSEXTHDR     _IOW('B', 124, u_int)
251 #define BIOCGIFATTACHCOUNT      _IOWR('B', 125, struct ifreq)
252 #endif /* PRIVATE */
253 #define BIOCSETFNR      _IOW('B', 126, struct bpf_program)
254 #ifdef KERNEL_PRIVATE
255 #define BIOCSETFNR64    _IOW('B',126, struct bpf_program64)
256 #define BIOCSETFNR32    _IOW('B',126, struct bpf_program32)
257 #endif /* KERNEL_PRIVATE */
258 #ifdef PRIVATE
259 #define BIOCGWANTPKTAP  _IOR('B', 127, u_int)
260 #define BIOCSWANTPKTAP  _IOWR('B', 127, u_int)
261 #define BIOCSHEADDROP   _IOW('B', 128, int)
262 #define BIOCGHEADDROP   _IOR('B', 128, int)
263 #define BIOCSTRUNCATE   _IOW('B', 129, u_int)
264 #define BIOCGETUUID     _IOR('B', 130, uuid_t)
265 #define BIOCSETUP       _IOW('B', 131, struct bpf_setup_args)
266 #define BIOCSPKTHDRV2   _IOW('B', 132, int)
267 #define BIOCGPKTHDRV2   _IOW('B', 133, int)
268 #define BIOCGHDRCOMP    _IOR('B', 134, int)
269 #define BIOCSHDRCOMP    _IOW('B', 135, int)
270 #define BIOCGHDRCOMPSTATS    _IOR('B', 136, struct bpf_comp_stats)
271 #define BIOCGHDRCOMPON  _IOR('B', 137, int)
272 #define BIOCGDIRECTION  _IOR('B', 138, int)
273 #define BIOCSDIRECTION  _IOW('B', 139, int)
274 #endif /* PRIVATE */
275 /*
276  * Structure prepended to each packet.
277  */
278 struct bpf_hdr {
279 	struct BPF_TIMEVAL bh_tstamp;   /* time stamp */
280 	bpf_u_int32     bh_caplen;      /* length of captured portion */
281 	bpf_u_int32     bh_datalen;     /* original length of packet */
282 	u_short         bh_hdrlen;      /* length of bpf header (this struct
283 	                                 *  plus alignment padding) */
284 };
285 #ifdef KERNEL
286 /*
287  * Because the structure above is not a multiple of 4 bytes, some compilers
288  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
289  * Only the kernel needs to know about it; applications use bh_hdrlen.
290  */
291 #define SIZEOF_BPF_HDR  (sizeof(struct bpf_hdr) <= 20 ? 18 : \
292     sizeof(struct bpf_hdr))
293 #endif
294 #ifdef PRIVATE
295 /*
296  * This structure must be a multiple of 4 bytes.
297  * It includes padding and spare fields that we can use later if desired.
298  */
299 struct bpf_hdr_ext {
300 	struct BPF_TIMEVAL bh_tstamp;   /* time stamp */
301 	bpf_u_int32     bh_caplen;      /* length of captured portion */
302 	bpf_u_int32     bh_datalen;     /* original length of packet */
303 	u_short         bh_hdrlen;      /* length of bpf header */
304 	u_char          bh_complen;
305 	u_char          bh_flags;
306 #define BPF_HDR_EXT_FLAGS_DIR_IN        0x00
307 #define BPF_HDR_EXT_FLAGS_DIR_OUT       0x01
308 #ifdef BSD_KERNEL_PRIVATE
309 #define BPF_HDR_EXT_FLAGS_TCP           0x02
310 #define BPF_HDR_EXT_FLAGS_UDP           0x04
311 #endif /* BSD_KERNEL_PRIVATE */
312 	pid_t           bh_pid;         /* process PID */
313 	char            bh_comm[MAXCOMLEN + 1]; /* process command */
314 	u_char          bh_pktflags;
315 #define BPF_PKTFLAGS_TCP_REXMT  0x01
316 #define BPF_PKTFLAGS_START_SEQ  0x02
317 #define BPF_PKTFLAGS_LAST_PKT   0x04
318 #define BPF_PKTFLAGS_WAKE_PKT   0x08
319 	uint16_t        bh_trace_tag;
320 	bpf_u_int32     bh_svc;         /* service class */
321 	bpf_u_int32     bh_flowid;      /* kernel reserved; 0 in userland */
322 	bpf_u_int32     bh_unsent_bytes; /* unsent bytes at interface */
323 	bpf_u_int32     bh_unsent_snd; /* unsent bytes at socket buffer */
324 };
325 
326 #define BPF_HDR_EXT_HAS_TRACE_TAG 1
327 
328 /*
329  * External representation of the bpf descriptor
330  */
331 struct xbpf_d {
332 	uint32_t        bd_structsize;  /* Size of this structure. */
333 	int32_t         bd_dev_minor;
334 	int32_t         bd_sig;
335 	uint32_t        bd_slen;
336 	uint32_t        bd_hlen;
337 	uint32_t        bd_bufsize;
338 	pid_t           bd_pid;
339 
340 	uint8_t         bd_promisc;
341 	uint8_t         bd_immediate;
342 	uint8_t         bd_hdrcmplt;
343 	uint8_t         bd_async;
344 
345 	uint8_t         bd_headdrop;
346 	uint8_t         bd_direction;
347 	uint8_t         bh_compreq;
348 	uint8_t         bh_compenabled;
349 
350 	uint8_t         bd_exthdr;
351 	uint8_t         bd_trunc;
352 	uint8_t         bd_pkthdrv2;
353 	uint8_t         bd_pad;
354 
355 	uint64_t        bd_rcount;
356 	uint64_t        bd_dcount;
357 	uint64_t        bd_fcount;
358 	uint64_t        bd_wcount;
359 	uint64_t        bd_wdcount;
360 
361 	char            bd_ifname[IFNAMSIZ];
362 
363 	uint64_t        bd_comp_count;
364 	uint64_t        bd_comp_size;
365 
366 	uint32_t        bd_scnt;        /* number of packets in store buffer */
367 	uint32_t        bd_hcnt;        /* number of packets in hold buffer */
368 
369 	uint64_t        bd_read_count;
370 	uint64_t        bd_fsize;
371 };
372 
373 #ifndef bd_seesent
374 /*
375  * Code compatibility workaround so that old versions of network_cmds will continue to build
376  * even if netstat -B shows an incorrect value.
377  */
378 #define bd_seesent bd_direction
379 #endif /* bd_seesent */
380 
381 #define _HAS_STRUCT_XBPF_D_ 2
382 
383 struct bpf_comp_hdr {
384 	struct BPF_TIMEVAL bh_tstamp;   /* time stamp */
385 	bpf_u_int32     bh_caplen;      /* length of captured portion */
386 	bpf_u_int32     bh_datalen;     /* original length of packet */
387 	u_short         bh_hdrlen;      /* length of bpf header (this struct
388 	                                 *  plus alignment padding) */
389 	u_char          bh_complen;     /* data portion compressed */
390 	u_char          bh_padding;     /* data portion compressed */
391 };
392 
393 #define HAS_BPF_HDR_COMP 1
394 #define BPF_HDR_COMP_LEN_MAX 255
395 
396 /*
397  * Packet tap directions
398  */
399 #define BPF_D_NONE      0x0     /* See no packet (for writing only) */
400 #define BPF_D_IN        0x1     /* See incoming packets */
401 #define BPF_D_OUT       0x2     /* See outgoing packets */
402 #define BPF_D_INOUT     0x3     /* See incoming and outgoing packets */
403 
404 #endif /* PRIVATE */
405 #endif /* !defined(DRIVERKIT) */
406 
407 /*
408  * Data-link level type codes.
409  */
410 #define DLT_NULL        0       /* no link-layer encapsulation */
411 #define DLT_EN10MB      1       /* Ethernet (10Mb) */
412 #define DLT_EN3MB       2       /* Experimental Ethernet (3Mb) */
413 #define DLT_AX25        3       /* Amateur Radio AX.25 */
414 #define DLT_PRONET      4       /* Proteon ProNET Token Ring */
415 #define DLT_CHAOS       5       /* Chaos */
416 #define DLT_IEEE802     6       /* IEEE 802 Networks */
417 #define DLT_ARCNET      7       /* ARCNET */
418 #define DLT_SLIP        8       /* Serial Line IP */
419 #define DLT_PPP         9       /* Point-to-point Protocol */
420 #define DLT_FDDI        10      /* FDDI */
421 #define DLT_ATM_RFC1483 11      /* LLC/SNAP encapsulated atm */
422 #define DLT_RAW         12      /* raw IP */
423 
424 /*
425  * These are values from BSD/OS's "bpf.h".
426  * These are not the same as the values from the traditional libpcap
427  * "bpf.h"; however, these values shouldn't be generated by any
428  * OS other than BSD/OS, so the correct values to use here are the
429  * BSD/OS values.
430  *
431  * Platforms that have already assigned these values to other
432  * DLT_ codes, however, should give these codes the values
433  * from that platform, so that programs that use these codes will
434  * continue to compile - even though they won't correctly read
435  * files of these types.
436  */
437 #define DLT_SLIP_BSDOS  15      /* BSD/OS Serial Line IP */
438 #define DLT_PPP_BSDOS   16      /* BSD/OS Point-to-point Protocol */
439 
440 /*
441  * 17 was used for DLT_PFLOG in OpenBSD; it no longer is.
442  *
443  * It was DLT_LANE8023 in SuSE 6.3, so we defined LINKTYPE_PFLOG
444  * as 117 so that pflog captures would use a link-layer header type
445  * value that didn't collide with any other values.  On all
446  * platforms other than OpenBSD, we defined DLT_PFLOG as 117,
447  * and we mapped between LINKTYPE_PFLOG and DLT_PFLOG.
448  *
449  * OpenBSD eventually switched to using 117 for DLT_PFLOG as well.
450  *
451  * Don't use 17 for anything else.
452  */
453 
454 /*
455  * 18 is used for DLT_PFSYNC in OpenBSD, NetBSD, DragonFly BSD and
456  * Mac OS X; don't use it for anything else.  (FreeBSD uses 121,
457  * which collides with DLT_HHDLC, even though it doesn't use 18
458  * for anything and doesn't appear to have ever used it for anything.)
459  *
460  * We define it as 18 on those platforms; it is, unfortunately, used
461  * for DLT_CIP in Suse 6.3, so we don't define it as DLT_PFSYNC
462  * in general.  As the packet format for it, like that for
463  * DLT_PFLOG, is not only OS-dependent but OS-version-dependent,
464  * we don't support printing it in tcpdump except on OSes that
465  * have the relevant header files, so it's not that useful on
466  * other platforms.
467  */
468 #define DLT_PFSYNC      18      /* Packet filter state syncing */
469 
470 #define DLT_ATM_CLIP    19      /* Linux Classical-IP over ATM */
471 
472 /*
473  * These values are defined by NetBSD; other platforms should refrain from
474  * using them for other purposes, so that NetBSD savefiles with link
475  * types of 50 or 51 can be read as this type on all platforms.
476  */
477 #define DLT_PPP_SERIAL  50      /* PPP over serial with HDLC encapsulation */
478 #define DLT_PPP_ETHER   51      /* PPP over Ethernet */
479 
480 /*
481  * The Axent Raptor firewall - now the Symantec Enterprise Firewall - uses
482  * a link-layer type of 99 for the tcpdump it supplies.  The link-layer
483  * header has 6 bytes of unknown data, something that appears to be an
484  * Ethernet type, and 36 bytes that appear to be 0 in at least one capture
485  * I've seen.
486  */
487 #define DLT_SYMANTEC_FIREWALL   99
488 
489 /*
490  * Values between 100 and 103 are used in capture file headers as
491  * link-layer header type LINKTYPE_ values corresponding to DLT_ types
492  * that differ between platforms; don't use those values for new DLT_
493  * new types.
494  */
495 
496 /*
497  * Values starting with 104 are used for newly-assigned link-layer
498  * header type values; for those link-layer header types, the DLT_
499  * value returned by pcap_datalink() and passed to pcap_open_dead(),
500  * and the LINKTYPE_ value that appears in capture files, are the
501  * same.
502  *
503  * DLT_MATCHING_MIN is the lowest such value; DLT_MATCHING_MAX is
504  * the highest such value.
505  */
506 #define DLT_MATCHING_MIN        104
507 
508 /*
509  * This value was defined by libpcap 0.5; platforms that have defined
510  * it with a different value should define it here with that value -
511  * a link type of 104 in a save file will be mapped to DLT_C_HDLC,
512  * whatever value that happens to be, so programs will correctly
513  * handle files with that link type regardless of the value of
514  * DLT_C_HDLC.
515  *
516  * The name DLT_C_HDLC was used by BSD/OS; we use that name for source
517  * compatibility with programs written for BSD/OS.
518  *
519  * libpcap 0.5 defined it as DLT_CHDLC; we define DLT_CHDLC as well,
520  * for source compatibility with programs written for libpcap 0.5.
521  */
522 #define DLT_C_HDLC      104     /* Cisco HDLC */
523 #define DLT_CHDLC       DLT_C_HDLC
524 
525 #define DLT_IEEE802_11  105     /* IEEE 802.11 wireless */
526 
527 /*
528  * Values between 106 and 107 are used in capture file headers as
529  * link-layer types corresponding to DLT_ types that might differ
530  * between platforms; don't use those values for new DLT_ new types.
531  */
532 
533 /*
534  * Frame Relay; BSD/OS has a DLT_FR with a value of 11, but that collides
535  * with other values.
536  * DLT_FR and DLT_FRELAY packets start with the Q.922 Frame Relay header
537  * (DLCI, etc.).
538  */
539 #define DLT_FRELAY      107
540 
541 /*
542  * OpenBSD DLT_LOOP, for loopback devices; it's like DLT_NULL, except
543  * that the AF_ type in the link-layer header is in network byte order.
544  *
545  * OpenBSD defines it as 12, but that collides with DLT_RAW, so we
546  * define it as 108 here.  If OpenBSD picks up this file, it should
547  * define DLT_LOOP as 12 in its version, as per the comment above -
548  * and should not use 108 for any purpose.
549  */
550 #define DLT_LOOP        108
551 
552 /*
553  * Values between 109 and 112 are used in capture file headers as
554  * link-layer types corresponding to DLT_ types that might differ
555  * between platforms; don't use those values for new DLT_ new types.
556  */
557 
558 /*
559  * Encapsulated packets for IPsec; DLT_ENC is 13 in OpenBSD, but that's
560  * DLT_SLIP_BSDOS in NetBSD, so we don't use 13 for it in OSes other
561  * than OpenBSD.
562  */
563 #define DLT_ENC 109
564 
565 /*
566  * This is for Linux cooked sockets.
567  */
568 #define DLT_LINUX_SLL   113
569 
570 /*
571  * Apple LocalTalk hardware.
572  */
573 #define DLT_LTALK       114
574 
575 /*
576  * Acorn Econet.
577  */
578 #define DLT_ECONET      115
579 
580 /*
581  * Reserved for use with OpenBSD ipfilter.
582  */
583 #define DLT_IPFILTER    116
584 
585 /*
586  * For use in capture-file headers as a link-layer type corresponding
587  * to OpenBSD PF (Packet Filter) log.
588  */
589 #define DLT_PFLOG       117
590 
591 /*
592  * Registered for Cisco-internal use.
593  */
594 #define DLT_CISCO_IOS   118
595 
596 /*
597  * Reserved for 802.11 cards using the Prism II chips, with a link-layer
598  * header including Prism monitor mode information plus an 802.11
599  * header.
600  */
601 #define DLT_PRISM_HEADER        119
602 
603 /*
604  * Reserved for Aironet 802.11 cards, with an Aironet link-layer header
605  * (see Doug Ambrisko's FreeBSD patches).
606  */
607 #define DLT_AIRONET_HEADER      120
608 
609 /*
610  * Reserved for Siemens HiPath HDLC. XXX
611  */
612 #define DLT_HHDLC       121
613 
614 /*
615  * Reserved for RFC 2625 IP-over-Fibre Channel.
616  */
617 #define DLT_IP_OVER_FC  122
618 
619 /*
620  * Reserved for Full Frontal ATM on Solaris.
621  */
622 #define DLT_SUNATM      123
623 
624 /*
625  * Reserved as per request from Kent Dahlgren <[email protected]>
626  * for private use.
627  */
628 #define DLT_RIO         124     /* RapidIO */
629 #define DLT_PCI_EXP     125     /* PCI Express */
630 #define DLT_AURORA      126     /* Xilinx Aurora link layer */
631 
632 /*
633  * BSD header for 802.11 plus a number of bits of link-layer information
634  * including radio information.
635  */
636 #ifndef DLT_IEEE802_11_RADIO
637 #define DLT_IEEE802_11_RADIO    127
638 #endif
639 
640 /*
641  * Reserved for TZSP encapsulation.
642  */
643 #define DLT_TZSP                128     /* Tazmen Sniffer Protocol */
644 
645 /*
646  * Reserved for Linux ARCNET.
647  */
648 #define DLT_ARCNET_LINUX        129
649 
650 /*
651  * Juniper-private data link types.
652  */
653 #define DLT_JUNIPER_MLPPP       130
654 #define DLT_JUNIPER_MLFR        131
655 #define DLT_JUNIPER_ES          132
656 #define DLT_JUNIPER_GGSN        133
657 #define DLT_JUNIPER_MFR         134
658 #define DLT_JUNIPER_ATM2        135
659 #define DLT_JUNIPER_SERVICES    136
660 #define DLT_JUNIPER_ATM1        137
661 
662 /*
663  * Apple IP-over-IEEE 1394, as per a request from Dieter Siegmund
664  * <[email protected]>.  The header that's presented is an Ethernet-like
665  * header:
666  *
667  *	#define FIREWIRE_EUI64_LEN	8
668  *	struct firewire_header {
669  *		u_char  firewire_dhost[FIREWIRE_EUI64_LEN];
670  *		u_char  firewire_shost[FIREWIRE_EUI64_LEN];
671  *		u_short firewire_type;
672  *	};
673  *
674  * with "firewire_type" being an Ethernet type value, rather than,
675  * for example, raw GASP frames being handed up.
676  */
677 #define DLT_APPLE_IP_OVER_IEEE1394      138
678 
679 /*
680  * Various SS7 encapsulations, as per a request from Jeff Morriss
681  * <jeff.morriss[AT]ulticom.com> and subsequent discussions.
682  */
683 #define DLT_MTP2_WITH_PHDR      139     /* pseudo-header with various info, followed by MTP2 */
684 #define DLT_MTP2                140     /* MTP2, without pseudo-header */
685 #define DLT_MTP3                141     /* MTP3, without pseudo-header or MTP2 */
686 #define DLT_SCCP                142     /* SCCP, without pseudo-header or MTP2 or MTP3 */
687 
688 /*
689  * Reserved for DOCSIS.
690  */
691 #define DLT_DOCSIS      143
692 
693 /*
694  * Reserved for Linux IrDA.
695  */
696 #define DLT_LINUX_IRDA  144
697 
698 /*
699  * Reserved for IBM SP switch and IBM Next Federation switch.
700  */
701 #define DLT_IBM_SP      145
702 #define DLT_IBM_SN      146
703 
704 /*
705  * Reserved for private use.  If you have some link-layer header type
706  * that you want to use within your organization, with the capture files
707  * using that link-layer header type not ever be sent outside your
708  * organization, you can use these values.
709  *
710  * No libpcap release will use these for any purpose, nor will any
711  * tcpdump release use them, either.
712  *
713  * Do *NOT* use these in capture files that you expect anybody not using
714  * your private versions of capture-file-reading tools to read; in
715  * particular, do *NOT* use them in products, otherwise you may find that
716  * people won't be able to use tcpdump, or snort, or Ethereal, or... to
717  * read capture files from your firewall/intrusion detection/traffic
718  * monitoring/etc. appliance, or whatever product uses that DLT_ value,
719  * and you may also find that the developers of those applications will
720  * not accept patches to let them read those files.
721  *
722  * Also, do not use them if somebody might send you a capture using them
723  * for *their* private type and tools using them for *your* private type
724  * would have to read them.
725  *
726  * Instead, ask "[email protected]" for a new DLT_ value,
727  * as per the comment above, and use the type you're given.
728  */
729 #define DLT_USER0               147
730 #define DLT_USER1               148
731 #define DLT_USER2               149
732 #define DLT_USER3               150
733 #define DLT_USER4               151
734 #define DLT_USER5               152
735 #define DLT_USER6               153
736 #define DLT_USER7               154
737 #define DLT_USER8               155
738 #define DLT_USER9               156
739 #define DLT_USER10              157
740 #define DLT_USER11              158
741 #define DLT_USER12              159
742 #define DLT_USER13              160
743 #define DLT_USER14              161
744 #define DLT_USER15              162
745 
746 #ifdef PRIVATE
747 /*
748  * For Apple private usage
749  */
750 #define DLT_USER0_APPLE_INTERNAL        DLT_USER0       /* rdar://12019509 */
751 #define DLT_USER1_APPLE_INTERNAL        DLT_USER1       /* rdar://12019509 */
752 #define DLT_PKTAP                       DLT_USER2       /* rdar://11779467 */
753 #define DLT_USER3_APPLE_INTERNAL        DLT_USER3       /* rdar://19614531 */
754 #define DLT_USER4_APPLE_INTERNAL        DLT_USER4       /* rdar://19614531 */
755 #endif /* PRIVATE */
756 
757 /*
758  * For future use with 802.11 captures - defined by AbsoluteValue
759  * Systems to store a number of bits of link-layer information
760  * including radio information:
761  *
762  *	http://www.shaftnet.org/~pizza/software/capturefrm.txt
763  *
764  * but it might be used by some non-AVS drivers now or in the
765  * future.
766  */
767 #define DLT_IEEE802_11_RADIO_AVS 163    /* 802.11 plus AVS radio header */
768 
769 /*
770  * Juniper-private data link type, as per request from
771  * Hannes Gredler <[email protected]>.  The DLT_s are used
772  * for passing on chassis-internal metainformation such as
773  * QOS profiles, etc..
774  */
775 #define DLT_JUNIPER_MONITOR     164
776 
777 /*
778  * Reserved for BACnet MS/TP.
779  */
780 #define DLT_BACNET_MS_TP        165
781 
782 /*
783  * Another PPP variant as per request from Karsten Keil <[email protected]>.
784  *
785  * This is used in some OSes to allow a kernel socket filter to distinguish
786  * between incoming and outgoing packets, on a socket intended to
787  * supply pppd with outgoing packets so it can do dial-on-demand and
788  * hangup-on-lack-of-demand; incoming packets are filtered out so they
789  * don't cause pppd to hold the connection up (you don't want random
790  * input packets such as port scans, packets from old lost connections,
791  * etc. to force the connection to stay up).
792  *
793  * The first byte of the PPP header (0xff03) is modified to accomodate
794  * the direction - 0x00 = IN, 0x01 = OUT.
795  */
796 #define DLT_PPP_PPPD            166
797 
798 /*
799  * Names for backwards compatibility with older versions of some PPP
800  * software; new software should use DLT_PPP_PPPD.
801  */
802 #define DLT_PPP_WITH_DIRECTION  DLT_PPP_PPPD
803 #define DLT_LINUX_PPP_WITHDIRECTION     DLT_PPP_PPPD
804 
805 /*
806  * Juniper-private data link type, as per request from
807  * Hannes Gredler <[email protected]>.  The DLT_s are used
808  * for passing on chassis-internal metainformation such as
809  * QOS profiles, cookies, etc..
810  */
811 #define DLT_JUNIPER_PPPOE       167
812 #define DLT_JUNIPER_PPPOE_ATM   168
813 
814 #define DLT_GPRS_LLC            169     /* GPRS LLC */
815 #define DLT_GPF_T               170     /* GPF-T (ITU-T G.7041/Y.1303) */
816 #define DLT_GPF_F               171     /* GPF-F (ITU-T G.7041/Y.1303) */
817 
818 /*
819  * Requested by Oolan Zimmer <[email protected]> for use in Gcom's T1/E1 line
820  * monitoring equipment.
821  */
822 #define DLT_GCOM_T1E1           172
823 #define DLT_GCOM_SERIAL         173
824 
825 /*
826  * Juniper-private data link type, as per request from
827  * Hannes Gredler <[email protected]>.  The DLT_ is used
828  * for internal communication to Physical Interface Cards (PIC)
829  */
830 #define DLT_JUNIPER_PIC_PEER    174
831 
832 /*
833  * Link types requested by Gregor Maier <[email protected]> of Endace
834  * Measurement Systems.  They add an ERF header (see
835  * http://www.endace.com/support/EndaceRecordFormat.pdf) in front of
836  * the link-layer header.
837  */
838 #define DLT_ERF_ETH             175     /* Ethernet */
839 #define DLT_ERF_POS             176     /* Packet-over-SONET */
840 
841 /*
842  * Requested by Daniele Orlandi <[email protected]> for raw LAPD
843  * for vISDN (http://www.orlandi.com/visdn/).  Its link-layer header
844  * includes additional information before the LAPD header, so it's
845  * not necessarily a generic LAPD header.
846  */
847 #define DLT_LINUX_LAPD          177
848 
849 /*
850  * Juniper-private data link type, as per request from
851  * Hannes Gredler <[email protected]>.
852  * The DLT_ are used for prepending meta-information
853  * like interface index, interface name
854  * before standard Ethernet, PPP, Frelay & C-HDLC Frames
855  */
856 #define DLT_JUNIPER_ETHER       178
857 #define DLT_JUNIPER_PPP         179
858 #define DLT_JUNIPER_FRELAY      180
859 #define DLT_JUNIPER_CHDLC       181
860 
861 /*
862  * Multi Link Frame Relay (FRF.16)
863  */
864 #define DLT_MFR                 182
865 
866 /*
867  * Juniper-private data link type, as per request from
868  * Hannes Gredler <[email protected]>.
869  * The DLT_ is used for internal communication with a
870  * voice Adapter Card (PIC)
871  */
872 #define DLT_JUNIPER_VP          183
873 
874 /*
875  * Arinc 429 frames.
876  * DLT_ requested by Gianluca Varenni <[email protected]>.
877  * Every frame contains a 32bit A429 label.
878  * More documentation on Arinc 429 can be found at
879  * http://www.condoreng.com/support/downloads/tutorials/ARINCTutorial.pdf
880  */
881 #define DLT_A429                184
882 
883 /*
884  * Arinc 653 Interpartition Communication messages.
885  * DLT_ requested by Gianluca Varenni <[email protected]>.
886  * Please refer to the A653-1 standard for more information.
887  */
888 #define DLT_A653_ICM            185
889 
890 /*
891  * USB packets, beginning with a USB setup header; requested by
892  * Paolo Abeni <[email protected]>.
893  */
894 #define DLT_USB                 186
895 
896 /*
897  * Bluetooth HCI UART transport layer (part H:4); requested by
898  * Paolo Abeni.
899  */
900 #define DLT_BLUETOOTH_HCI_H4    187
901 
902 /*
903  * IEEE 802.16 MAC Common Part Sublayer; requested by Maria Cruz
904  * <[email protected]>.
905  */
906 #define DLT_IEEE802_16_MAC_CPS  188
907 
908 /*
909  * USB packets, beginning with a Linux USB header; requested by
910  * Paolo Abeni <[email protected]>.
911  */
912 #define DLT_USB_LINUX           189
913 
914 /*
915  * Controller Area Network (CAN) v. 2.0B packets.
916  * DLT_ requested by Gianluca Varenni <[email protected]>.
917  * Used to dump CAN packets coming from a CAN Vector board.
918  * More documentation on the CAN v2.0B frames can be found at
919  * http://www.can-cia.org/downloads/?269
920  */
921 #define DLT_CAN20B              190
922 
923 /*
924  * IEEE 802.15.4, with address fields padded, as is done by Linux
925  * drivers; requested by Juergen Schimmer.
926  */
927 #define DLT_IEEE802_15_4_LINUX  191
928 
929 /*
930  * Per Packet Information encapsulated packets.
931  * DLT_ requested by Gianluca Varenni <[email protected]>.
932  */
933 #define DLT_PPI                 192
934 
935 /*
936  * Header for 802.16 MAC Common Part Sublayer plus a radiotap radio header;
937  * requested by Charles Clancy.
938  */
939 #define DLT_IEEE802_16_MAC_CPS_RADIO    193
940 
941 /*
942  * Juniper-private data link type, as per request from
943  * Hannes Gredler <[email protected]>.
944  * The DLT_ is used for internal communication with a
945  * integrated service module (ISM).
946  */
947 #define DLT_JUNIPER_ISM         194
948 
949 /*
950  * IEEE 802.15.4, exactly as it appears in the spec (no padding, no
951  * nothing); requested by Mikko Saarnivala <[email protected]>.
952  */
953 #define DLT_IEEE802_15_4        195
954 
955 /*
956  * Various link-layer types, with a pseudo-header, for SITA
957  * (http://www.sita.aero/); requested by Fulko Hew ([email protected]).
958  */
959 #define DLT_SITA                196
960 
961 /*
962  * Various link-layer types, with a pseudo-header, for Endace DAG cards;
963  * encapsulates Endace ERF records.  Requested by Stephen Donnelly
964  * <[email protected]>.
965  */
966 #define DLT_ERF                 197
967 
968 /*
969  * Special header prepended to Ethernet packets when capturing from a
970  * u10 Networks board.  Requested by Phil Mulholland
971  * <[email protected]>.
972  */
973 #define DLT_RAIF1               198
974 
975 /*
976  * IPMB packet for IPMI, beginning with the I2C slave address, followed
977  * by the netFn and LUN, etc..  Requested by Chanthy Toeung
978  * <[email protected]>.
979  */
980 #define DLT_IPMB                199
981 
982 /*
983  * Juniper-private data link type, as per request from
984  * Hannes Gredler <[email protected]>.
985  * The DLT_ is used for capturing data on a secure tunnel interface.
986  */
987 #define DLT_JUNIPER_ST          200
988 
989 /*
990  * Bluetooth HCI UART transport layer (part H:4), with pseudo-header
991  * that includes direction information; requested by Paolo Abeni.
992  */
993 #define DLT_BLUETOOTH_HCI_H4_WITH_PHDR  201
994 
995 /*
996  * AX.25 packet with a 1-byte KISS header; see
997  *
998  *      http://www.ax25.net/kiss.htm
999  *
1000  * as per Richard Stearn <[email protected]>.
1001  */
1002 #define DLT_AX25_KISS           202
1003 
1004 /*
1005  * LAPD packets from an ISDN channel, starting with the address field,
1006  * with no pseudo-header.
1007  * Requested by Varuna De Silva <[email protected]>.
1008  */
1009 #define DLT_LAPD                203
1010 
1011 /*
1012  * Variants of various link-layer headers, with a one-byte direction
1013  * pseudo-header prepended - zero means "received by this host",
1014  * non-zero (any non-zero value) means "sent by this host" - as per
1015  * Will Barker <[email protected]>.
1016  */
1017 #define DLT_PPP_WITH_DIR        204     /* PPP - don't confuse with DLT_PPP_WITH_DIRECTION */
1018 #define DLT_C_HDLC_WITH_DIR     205     /* Cisco HDLC */
1019 #define DLT_FRELAY_WITH_DIR     206     /* Frame Relay */
1020 #define DLT_LAPB_WITH_DIR       207     /* LAPB */
1021 
1022 /*
1023  * 208 is reserved for an as-yet-unspecified proprietary link-layer
1024  * type, as requested by Will Barker.
1025  */
1026 
1027 /*
1028  * IPMB with a Linux-specific pseudo-header; as requested by Alexey Neyman
1029  * <[email protected]>.
1030  */
1031 #define DLT_IPMB_LINUX          209
1032 
1033 /*
1034  * FlexRay automotive bus - http://www.flexray.com/ - as requested
1035  * by Hannes Kaelber <[email protected]>.
1036  */
1037 #define DLT_FLEXRAY             210
1038 
1039 /*
1040  * Media Oriented Systems Transport (MOST) bus for multimedia
1041  * transport - http://www.mostcooperation.com/ - as requested
1042  * by Hannes Kaelber <[email protected]>.
1043  */
1044 #define DLT_MOST                211
1045 
1046 /*
1047  * Local Interconnect Network (LIN) bus for vehicle networks -
1048  * http://www.lin-subbus.org/ - as requested by Hannes Kaelber
1049  * <[email protected]>.
1050  */
1051 #define DLT_LIN                 212
1052 
1053 /*
1054  * X2E-private data link type used for serial line capture,
1055  * as requested by Hannes Kaelber <[email protected]>.
1056  */
1057 #define DLT_X2E_SERIAL          213
1058 
1059 /*
1060  * X2E-private data link type used for the Xoraya data logger
1061  * family, as requested by Hannes Kaelber <[email protected]>.
1062  */
1063 #define DLT_X2E_XORAYA          214
1064 
1065 /*
1066  * IEEE 802.15.4, exactly as it appears in the spec (no padding, no
1067  * nothing), but with the PHY-level data for non-ASK PHYs (4 octets
1068  * of 0 as preamble, one octet of SFD, one octet of frame length+
1069  * reserved bit, and then the MAC-layer data, starting with the
1070  * frame control field).
1071  *
1072  * Requested by Max Filippov <[email protected]>.
1073  */
1074 #define DLT_IEEE802_15_4_NONASK_PHY     215
1075 
1076 /*
1077  * David Gibson <[email protected]> requested this for
1078  * captures from the Linux kernel /dev/input/eventN devices. This
1079  * is used to communicate keystrokes and mouse movements from the
1080  * Linux kernel to display systems, such as Xorg.
1081  */
1082 #define DLT_LINUX_EVDEV         216
1083 
1084 /*
1085  * GSM Um and Abis interfaces, preceded by a "gsmtap" header.
1086  *
1087  * Requested by Harald Welte <[email protected]>.
1088  */
1089 #define DLT_GSMTAP_UM           217
1090 #define DLT_GSMTAP_ABIS         218
1091 
1092 /*
1093  * MPLS, with an MPLS label as the link-layer header.
1094  * Requested by Michele Marchetto <[email protected]> on behalf
1095  * of OpenBSD.
1096  */
1097 #define DLT_MPLS                219
1098 
1099 /*
1100  * USB packets, beginning with a Linux USB header, with the USB header
1101  * padded to 64 bytes; required for memory-mapped access.
1102  */
1103 #define DLT_USB_LINUX_MMAPPED   220
1104 
1105 /*
1106  * DECT packets, with a pseudo-header; requested by
1107  * Matthias Wenzel <[email protected]>.
1108  */
1109 #define DLT_DECT                221
1110 
1111 /*
1112  * From: "Lidwa, Eric (GSFC-582.0)[SGT INC]" <[email protected]>
1113  * Date: Mon, 11 May 2009 11:18:30 -0500
1114  *
1115  * DLT_AOS. We need it for AOS Space Data Link Protocol.
1116  *   I have already written dissectors for but need an OK from
1117  *   legal before I can submit a patch.
1118  *
1119  */
1120 #define DLT_AOS                 222
1121 
1122 /*
1123  * Wireless HART (Highway Addressable Remote Transducer)
1124  * From the HART Communication Foundation
1125  * IES/PAS 62591
1126  *
1127  * Requested by Sam Roberts <[email protected]>.
1128  */
1129 #define DLT_WIHART              223
1130 
1131 /*
1132  * Fibre Channel FC-2 frames, beginning with a Frame_Header.
1133  * Requested by Kahou Lei <[email protected]>.
1134  */
1135 #define DLT_FC_2                224
1136 
1137 /*
1138  * Fibre Channel FC-2 frames, beginning with an encoding of the
1139  * SOF, and ending with an encoding of the EOF.
1140  *
1141  * The encodings represent the frame delimiters as 4-byte sequences
1142  * representing the corresponding ordered sets, with K28.5
1143  * represented as 0xBC, and the D symbols as the corresponding
1144  * byte values; for example, SOFi2, which is K28.5 - D21.5 - D1.2 - D21.2,
1145  * is represented as 0xBC 0xB5 0x55 0x55.
1146  *
1147  * Requested by Kahou Lei <[email protected]>.
1148  */
1149 #define DLT_FC_2_WITH_FRAME_DELIMS      225
1150 
1151 /*
1152  * Solaris ipnet pseudo-header; requested by Darren Reed <[email protected]>.
1153  *
1154  * The pseudo-header starts with a one-byte version number; for version 2,
1155  * the pseudo-header is:
1156  *
1157  * struct dl_ipnetinfo {
1158  *     u_int8_t   dli_version;
1159  *     u_int8_t   dli_family;
1160  *     u_int16_t  dli_htype;
1161  *     u_int32_t  dli_pktlen;
1162  *     u_int32_t  dli_ifindex;
1163  *     u_int32_t  dli_grifindex;
1164  *     u_int32_t  dli_zsrc;
1165  *     u_int32_t  dli_zdst;
1166  * };
1167  *
1168  * dli_version is 2 for the current version of the pseudo-header.
1169  *
1170  * dli_family is a Solaris address family value, so it's 2 for IPv4
1171  * and 26 for IPv6.
1172  *
1173  * dli_htype is a "hook type" - 0 for incoming packets, 1 for outgoing
1174  * packets, and 2 for packets arriving from another zone on the same
1175  * machine.
1176  *
1177  * dli_pktlen is the length of the packet data following the pseudo-header
1178  * (so the captured length minus dli_pktlen is the length of the
1179  * pseudo-header, assuming the entire pseudo-header was captured).
1180  *
1181  * dli_ifindex is the interface index of the interface on which the
1182  * packet arrived.
1183  *
1184  * dli_grifindex is the group interface index number (for IPMP interfaces).
1185  *
1186  * dli_zsrc is the zone identifier for the source of the packet.
1187  *
1188  * dli_zdst is the zone identifier for the destination of the packet.
1189  *
1190  * A zone number of 0 is the global zone; a zone number of 0xffffffff
1191  * means that the packet arrived from another host on the network, not
1192  * from another zone on the same machine.
1193  *
1194  * An IPv4 or IPv6 datagram follows the pseudo-header; dli_family indicates
1195  * which of those it is.
1196  */
1197 #define DLT_IPNET               226
1198 
1199 /*
1200  * CAN (Controller Area Network) frames, with a pseudo-header as supplied
1201  * by Linux SocketCAN.  See Documentation/networking/can.txt in the Linux
1202  * source.
1203  *
1204  * Requested by Felix Obenhuber <[email protected]>.
1205  */
1206 #define DLT_CAN_SOCKETCAN       227
1207 
1208 /*
1209  * Raw IPv4/IPv6; different from DLT_RAW in that the DLT_ value specifies
1210  * whether it's v4 or v6.  Requested by Darren Reed <[email protected]>.
1211  */
1212 #define DLT_IPV4                228
1213 #define DLT_IPV6                229
1214 
1215 /*
1216  * IEEE 802.15.4, exactly as it appears in the spec (no padding, no
1217  * nothing), and with no FCS at the end of the frame; requested by
1218  * Jon Smirl <[email protected]>.
1219  */
1220 #define DLT_IEEE802_15_4_NOFCS  230
1221 
1222 /*
1223  * Raw D-Bus:
1224  *
1225  *	http://www.freedesktop.org/wiki/Software/dbus
1226  *
1227  * messages:
1228  *
1229  *	http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-messages
1230  *
1231  * starting with the endianness flag, followed by the message type, etc.,
1232  * but without the authentication handshake before the message sequence:
1233  *
1234  *	http://dbus.freedesktop.org/doc/dbus-specification.html#auth-protocol
1235  *
1236  * Requested by Martin Vidner <[email protected]>.
1237  */
1238 #define DLT_DBUS                231
1239 
1240 /*
1241  * Juniper-private data link type, as per request from
1242  * Hannes Gredler <[email protected]>.
1243  */
1244 #define DLT_JUNIPER_VS                  232
1245 #define DLT_JUNIPER_SRX_E2E             233
1246 #define DLT_JUNIPER_FIBRECHANNEL        234
1247 
1248 /*
1249  * DVB-CI (DVB Common Interface for communication between a PC Card
1250  * module and a DVB receiver).  See
1251  *
1252  *	http://www.kaiser.cx/pcap-dvbci.html
1253  *
1254  * for the specification.
1255  *
1256  * Requested by Martin Kaiser <[email protected]>.
1257  */
1258 #define DLT_DVB_CI              235
1259 
1260 /*
1261  * Variant of 3GPP TS 27.010 multiplexing protocol (similar to, but
1262  * *not* the same as, 27.010).  Requested by Hans-Christoph Schemmel
1263  * <[email protected]>.
1264  */
1265 #define DLT_MUX27010            236
1266 
1267 /*
1268  * STANAG 5066 D_PDUs.  Requested by M. Baris Demiray
1269  * <[email protected]>.
1270  */
1271 #define DLT_STANAG_5066_D_PDU   237
1272 
1273 /*
1274  * Juniper-private data link type, as per request from
1275  * Hannes Gredler <[email protected]>.
1276  */
1277 #define DLT_JUNIPER_ATM_CEMIC   238
1278 
1279 /*
1280  * NetFilter LOG messages
1281  * (payload of netlink NFNL_SUBSYS_ULOG/NFULNL_MSG_PACKET packets)
1282  *
1283  * Requested by Jakub Zawadzki <[email protected]>
1284  */
1285 #define DLT_NFLOG               239
1286 
1287 /*
1288  * Hilscher Gesellschaft fuer Systemautomation mbH link-layer type
1289  * for Ethernet packets with a 4-byte pseudo-header and always
1290  * with the payload including the FCS, as supplied by their
1291  * netANALYZER hardware and software.
1292  *
1293  * Requested by Holger P. Frommer <[email protected]>
1294  */
1295 #define DLT_NETANALYZER         240
1296 
1297 /*
1298  * Hilscher Gesellschaft fuer Systemautomation mbH link-layer type
1299  * for Ethernet packets with a 4-byte pseudo-header and FCS and
1300  * with the Ethernet header preceded by 7 bytes of preamble and
1301  * 1 byte of SFD, as supplied by their netANALYZER hardware and
1302  * software.
1303  *
1304  * Requested by Holger P. Frommer <[email protected]>
1305  */
1306 #define DLT_NETANALYZER_TRANSPARENT     241
1307 
1308 /*
1309  * IP-over-Infiniband, as specified by RFC 4391.
1310  *
1311  * Requested by Petr Sumbera <[email protected]>.
1312  */
1313 #define DLT_IPOIB               242
1314 
1315 /*
1316  * MPEG-2 transport stream (ISO 13818-1/ITU-T H.222.0).
1317  *
1318  * Requested by Guy Martin <[email protected]>.
1319  */
1320 #define DLT_MPEG_2_TS           243
1321 
1322 /*
1323  * ng4T GmbH's UMTS Iub/Iur-over-ATM and Iub/Iur-over-IP format as
1324  * used by their ng40 protocol tester.
1325  *
1326  * Requested by Jens Grimmer <[email protected]>.
1327  */
1328 #define DLT_NG40                244
1329 
1330 /*
1331  * Pseudo-header giving adapter number and flags, followed by an NFC
1332  * (Near-Field Communications) Logical Link Control Protocol (LLCP) PDU,
1333  * as specified by NFC Forum Logical Link Control Protocol Technical
1334  * Specification LLCP 1.1.
1335  *
1336  * Requested by Mike Wakerly <[email protected]>.
1337  */
1338 #define DLT_NFC_LLCP            245
1339 
1340 /*
1341  * USB packets, beginning with a Darwin (macOS, etc.) USB header.
1342  */
1343 #define DLT_USB_DARWIN          266
1344 
1345 #define DLT_MATCHING_MAX        266     /* highest value in the "matching" range */
1346 
1347 #if !defined(DRIVERKIT)
1348 /*
1349  * The instruction encodings.
1350  */
1351 /* instruction classes */
1352 #define BPF_CLASS(code) ((code) & 0x07)
1353 #define         BPF_LD          0x00
1354 #define         BPF_LDX         0x01
1355 #define         BPF_ST          0x02
1356 #define         BPF_STX         0x03
1357 #define         BPF_ALU         0x04
1358 #define         BPF_JMP         0x05
1359 #define         BPF_RET         0x06
1360 #define         BPF_MISC        0x07
1361 
1362 /* ld/ldx fields */
1363 #define BPF_SIZE(code)  ((code) & 0x18)
1364 #define         BPF_W           0x00
1365 #define         BPF_H           0x08
1366 #define         BPF_B           0x10
1367 #define BPF_MODE(code)  ((code) & 0xe0)
1368 #define         BPF_IMM         0x00
1369 #define         BPF_ABS         0x20
1370 #define         BPF_IND         0x40
1371 #define         BPF_MEM         0x60
1372 #define         BPF_LEN         0x80
1373 #define         BPF_MSH         0xa0
1374 
1375 /* alu/jmp fields */
1376 #define BPF_OP(code)    ((code) & 0xf0)
1377 #define         BPF_ADD         0x00
1378 #define         BPF_SUB         0x10
1379 #define         BPF_MUL         0x20
1380 #define         BPF_DIV         0x30
1381 #define         BPF_OR          0x40
1382 #define         BPF_AND         0x50
1383 #define         BPF_LSH         0x60
1384 #define         BPF_RSH         0x70
1385 #define         BPF_NEG         0x80
1386 #define         BPF_JA          0x00
1387 #define         BPF_JEQ         0x10
1388 #define         BPF_JGT         0x20
1389 #define         BPF_JGE         0x30
1390 #define         BPF_JSET        0x40
1391 #define BPF_SRC(code)   ((code) & 0x08)
1392 #define         BPF_K           0x00
1393 #define         BPF_X           0x08
1394 
1395 /* ret - BPF_K and BPF_X also apply */
1396 #define BPF_RVAL(code)  ((code) & 0x18)
1397 #define         BPF_A           0x10
1398 
1399 /* misc */
1400 #define BPF_MISCOP(code) ((code) & 0xf8)
1401 #define         BPF_TAX         0x00
1402 #define         BPF_TXA         0x80
1403 
1404 /*
1405  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
1406  */
1407 #define BPF_MEMWORDS 16
1408 
1409 /*
1410  * The instruction data structure.
1411  */
1412 struct bpf_insn {
1413 	u_short         code;
1414 	u_char          jt;
1415 	u_char          jf;
1416 	bpf_u_int32     k;
1417 };
1418 
1419 /*
1420  * Macros for insn array initializers.
1421  */
1422 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
1423 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
1424 
1425 #pragma pack(4)
1426 
1427 /*
1428  * Structure to retrieve available DLTs for the interface.
1429  */
1430 struct bpf_dltlist {
1431 	u_int32_t               bfl_len;        /* number of bfd_list array */
1432 	union {
1433 		u_int32_t       *bflu_list;     /* array of DLTs */
1434 		u_int64_t       bflu_pad;
1435 	} bfl_u;
1436 };
1437 #define bfl_list bfl_u.bflu_list
1438 
1439 #pragma pack()
1440 
1441 #ifdef KERNEL_PRIVATE
1442 #define BPF_MIN_PKT_SIZE 40
1443 #define PORT_DNS 53
1444 #define PORT_BOOTPS 67
1445 #define PORT_BOOTPC 68
1446 #define PORT_ISAKMP 500
1447 #define PORT_ISAKMP_NATT 4500   /* rfc3948 */
1448 
1449 /* Forward declerations */
1450 struct ifnet;
1451 struct mbuf;
1452 
1453 #define BPF_PACKET_TYPE_MBUF    0
1454 #if SKYWALK
1455 #define BPF_PACKET_TYPE_PKT     1
1456 #include <skywalk/os_skywalk.h>
1457 #endif /* SKYWALK */
1458 
1459 struct bpf_packet {
1460 	int     bpfp_type;
1461 	void *  bpfp_header;            /* optional */
1462 	size_t  bpfp_header_length;
1463 	union {
1464 		struct mbuf     *bpfpu_mbuf;
1465 		void *          bpfpu_ptr;
1466 #if SKYWALK
1467 		kern_packet_t   bpfpu_pkt;
1468 #define bpfp_pkt        bpfp_u.bpfpu_pkt
1469 #endif /* SKYWALK */
1470 	} bpfp_u;
1471 #define bpfp_mbuf       bpfp_u.bpfpu_mbuf
1472 #define bpfp_ptr        bpfp_u.bpfpu_ptr
1473 	size_t  bpfp_total_length;      /* length including optional header */
1474 };
1475 
1476 extern int      bpf_validate(const struct bpf_insn *, int);
1477 extern void     bpfdetach(struct ifnet *);
1478 extern void     bpfilterattach(int);
1479 extern u_int    bpf_filter(const struct bpf_insn *, u_char *, u_int, u_int);
1480 #endif /* KERNEL_PRIVATE */
1481 
1482 #endif /* !defined(DRIVERKIT) */
1483 
1484 #if defined(DRIVERKIT) || defined(KERNEL)
1485 #ifndef BPF_TAP_MODE_T
1486 #define BPF_TAP_MODE_T
1487 /*!
1488  *       @enum BPF tap mode
1489  *       @abstract Constants defining interface families.
1490  *       @constant BPF_MODE_DISABLED Disable bpf.
1491  *       @constant BPF_MODE_INPUT Enable input only.
1492  *       @constant BPF_MODE_OUTPUT Enable output only.
1493  *       @constant BPF_MODE_INPUT_OUTPUT Enable input and output.
1494  */
1495 
1496 enum {
1497 	BPF_MODE_DISABLED       = 0,
1498 	BPF_MODE_INPUT          = 1,
1499 	BPF_MODE_OUTPUT         = 2,
1500 	BPF_MODE_INPUT_OUTPUT   = 3
1501 };
1502 /*!
1503  *       @typedef bpf_tap_mode
1504  *       @abstract Mode for tapping. BPF_MODE_DISABLED/BPF_MODE_INPUT_OUTPUT etc.
1505  */
1506 typedef uint32_t bpf_tap_mode;
1507 #endif /* !BPF_TAP_MODE_T */
1508 #endif /* defined(DRIVERKIT) || defined(KERNEL) */
1509 
1510 #ifdef KERNEL
1511 /*!
1512  *       @typedef bpf_send_func
1513  *       @discussion bpf_send_func is called when a bpf file descriptor is
1514  *               used to send a raw packet on the interface. The mbuf and data
1515  *               link type are specified. The callback is responsible for
1516  *               releasing the mbuf whether or not it returns an error.
1517  *       @param interface The interface the packet is being sent on.
1518  *       @param data_link_type The data link type the bpf device is attached to.
1519  *       @param packet The packet to be sent.
1520  */
1521 typedef errno_t (*bpf_send_func)(ifnet_t interface, u_int32_t data_link_type,
1522     mbuf_t packet);
1523 
1524 /*!
1525  *       @typedef bpf_tap_func
1526  *       @discussion bpf_tap_func is called when the tap state of the
1527  *               interface changes. This happens when a bpf device attaches to an
1528  *               interface or detaches from an interface. The tap mode will join
1529  *               together (bit or) the modes of all bpf devices using that
1530  *               interface for that dlt. If you return an error from this
1531  *               function, the bpf device attach attempt that triggered the tap
1532  *               will fail. If this function was called bacuse the tap state was
1533  *               decreasing (tap in or out is stopping), the error will be
1534  *               ignored.
1535  *       @param interface The interface being tapped.
1536  *       @param data_link_type The data link type being tapped.
1537  *       @param direction The direction of the tap.
1538  */
1539 typedef errno_t (*bpf_tap_func)(ifnet_t interface, u_int32_t data_link_type,
1540     bpf_tap_mode direction);
1541 
1542 /*!
1543  *       @function bpfattach
1544  *       @discussion Registers an interface with BPF. This allows bpf devices
1545  *               to attach to your interface to capture packets. Your interface
1546  *               will be unregistered automatically when your interface is
1547  *               detached.
1548  *       @param interface The interface to register with BPF.
1549  *       @param data_link_type The data link type of the interface. See the
1550  *               DLT_* defines in bpf.h.
1551  *       @param header_length The length, in bytes, of the data link header.
1552  */
1553 extern void  bpfattach(ifnet_t interface, u_int data_link_type,
1554     u_int header_length);
1555 
1556 /*!
1557  *       @function bpf_attach
1558  *       @discussion Registers an interface with BPF. This allows bpf devices
1559  *               to attach to your interface to capture and transmit packets.
1560  *               Your interface will be unregistered automatically when your
1561  *               interface is detached. You may register multiple times with
1562  *               different data link types. An 802.11 interface would use this to
1563  *               allow clients to pick whether they want just an ethernet style
1564  *               frame or the 802.11 wireless headers as well. The first dlt you
1565  *               register will be considered the default. Any bpf device attaches
1566  *               that do not specify a data link type will use the default.
1567  *       @param interface The interface to register with BPF.
1568  *       @param data_link_type The data link type of the interface. See the
1569  *               DLT_* defines in bpf.h.
1570  *       @param header_length The length, in bytes, of the data link header.
1571  *       @param send See the bpf_send_func described above.
1572  *       @param tap See the bpf_tap_func described above.
1573  */
1574 extern errno_t  bpf_attach(ifnet_t interface, u_int32_t data_link_type,
1575     u_int32_t header_length, bpf_send_func send, bpf_tap_func tap);
1576 
1577 /*!
1578  *       @function bpf_tap_in
1579  *       @discussion Call this function when your interface receives a
1580  *               packet. This function will check if any bpf devices need a
1581  *               a copy of the packet.
1582  *       @param interface The interface the packet was received on.
1583  *       @param dlt The data link type of the packet.
1584  *       @param packet The packet received.
1585  *       @param header An optional pointer to a header that will be prepended.
1586  *       @param header_len If the header was specified, the length of the header.
1587  */
1588 extern void bpf_tap_in(ifnet_t interface, u_int32_t dlt, mbuf_t packet,
1589     void *header, size_t header_len);
1590 
1591 /*!
1592  *       @function bpf_tap_out
1593  *       @discussion Call this function when your interface transmits a
1594  *               packet. This function will check if any bpf devices need a
1595  *               a copy of the packet.
1596  *       @param interface The interface the packet was or will be transmitted on.
1597  *       @param dlt The data link type of the packet.
1598  *       @param packet The packet received.
1599  *       @param header An optional pointer to a header that will be prepended.
1600  *       @param header_len If the header was specified, the length of the header.
1601  */
1602 extern void bpf_tap_out(ifnet_t interface, u_int32_t dlt, mbuf_t packet,
1603     void *header, size_t header_len);
1604 
1605 #if SKYWALK
1606 /*!
1607  *       @function bpf_tap_packet_in
1608  *       @discussion Call this function when your interface receives a
1609  *               packet. This function will check if any bpf devices need a
1610  *               a copy of the packet.
1611  *       @param interface The interface the packet was received on.
1612  *       @param dlt The data link type of the packet.
1613  *       @param packet The packet received.
1614  *       @param header An optional pointer to a header that will be prepended.
1615  *       @param header_len If the header was specified, the length of the header.
1616  */
1617 extern void bpf_tap_packet_in(ifnet_t interface, u_int32_t dlt,
1618     kern_packet_t packet, void *header, size_t header_len);
1619 
1620 /*!
1621  *       @function bpf_tap_packet_out
1622  *       @discussion Call this function when your interface transmits a
1623  *               packet. This function will check if any bpf devices need a
1624  *               a copy of the packet.
1625  *       @param interface The interface the packet was or will be transmitted on.
1626  *       @param dlt The data link type of the packet.
1627  *       @param packet The packet received.
1628  *       @param header An optional pointer to a header that will be prepended.
1629  *       @param header_len If the header was specified, the length of the header.
1630  */
1631 extern void bpf_tap_packet_out(ifnet_t interface, u_int32_t dlt,
1632     kern_packet_t packet, void *header, size_t header_len);
1633 
1634 #endif /* SKYWALK */
1635 #endif /* KERNEL */
1636 
1637 #endif /* _NET_BPF_H_ */
1638