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