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