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