pfvar.h revision 240233
1/*	$OpenBSD: pfvar.h,v 1.282 2009/01/29 15:12:28 pyr Exp $ */
2
3/*
4 * Copyright (c) 2001 Daniel Hartmeier
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 *    - Redistributions of source code must retain the above copyright
12 *      notice, this list of conditions and the following disclaimer.
13 *    - Redistributions in binary form must reproduce the above
14 *      copyright notice, this list of conditions and the following
15 *      disclaimer in the documentation and/or other materials provided
16 *      with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
26 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
28 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 *
31 */
32
33#ifndef _NET_PFVAR_H_
34#define _NET_PFVAR_H_
35
36#include <sys/param.h>
37#include <sys/queue.h>
38#include <sys/refcount.h>
39#include <sys/tree.h>
40
41#include <net/radix.h>
42#include <netinet/in.h>
43
44#include <net/pf_mtag.h>
45
46#define	PF_TCPS_PROXY_SRC	((TCP_NSTATES)+0)
47#define	PF_TCPS_PROXY_DST	((TCP_NSTATES)+1)
48
49#define	PF_MD5_DIGEST_LENGTH	16
50#ifdef MD5_DIGEST_LENGTH
51#if PF_MD5_DIGEST_LENGTH != MD5_DIGEST_LENGTH
52#error
53#endif
54#endif
55
56enum	{ PF_INOUT, PF_IN, PF_OUT };
57enum	{ PF_PASS, PF_DROP, PF_SCRUB, PF_NOSCRUB, PF_NAT, PF_NONAT,
58	  PF_BINAT, PF_NOBINAT, PF_RDR, PF_NORDR, PF_SYNPROXY_DROP, PF_DEFER };
59enum	{ PF_RULESET_SCRUB, PF_RULESET_FILTER, PF_RULESET_NAT,
60	  PF_RULESET_BINAT, PF_RULESET_RDR, PF_RULESET_MAX };
61enum	{ PF_OP_NONE, PF_OP_IRG, PF_OP_EQ, PF_OP_NE, PF_OP_LT,
62	  PF_OP_LE, PF_OP_GT, PF_OP_GE, PF_OP_XRG, PF_OP_RRG };
63enum	{ PF_DEBUG_NONE, PF_DEBUG_URGENT, PF_DEBUG_MISC, PF_DEBUG_NOISY };
64enum	{ PF_CHANGE_NONE, PF_CHANGE_ADD_HEAD, PF_CHANGE_ADD_TAIL,
65	  PF_CHANGE_ADD_BEFORE, PF_CHANGE_ADD_AFTER,
66	  PF_CHANGE_REMOVE, PF_CHANGE_GET_TICKET };
67enum	{ PF_GET_NONE, PF_GET_CLR_CNTR };
68enum	{ PF_SK_WIRE, PF_SK_STACK, PF_SK_BOTH };
69
70/*
71 * Note about PFTM_*: real indices into pf_rule.timeout[] come before
72 * PFTM_MAX, special cases afterwards. See pf_state_expires().
73 */
74enum	{ PFTM_TCP_FIRST_PACKET, PFTM_TCP_OPENING, PFTM_TCP_ESTABLISHED,
75	  PFTM_TCP_CLOSING, PFTM_TCP_FIN_WAIT, PFTM_TCP_CLOSED,
76	  PFTM_UDP_FIRST_PACKET, PFTM_UDP_SINGLE, PFTM_UDP_MULTIPLE,
77	  PFTM_ICMP_FIRST_PACKET, PFTM_ICMP_ERROR_REPLY,
78	  PFTM_OTHER_FIRST_PACKET, PFTM_OTHER_SINGLE,
79	  PFTM_OTHER_MULTIPLE, PFTM_FRAG, PFTM_INTERVAL,
80	  PFTM_ADAPTIVE_START, PFTM_ADAPTIVE_END, PFTM_SRC_NODE,
81	  PFTM_TS_DIFF, PFTM_MAX, PFTM_PURGE, PFTM_UNLINKED,
82	  PFTM_UNTIL_PACKET };
83
84/* PFTM default values */
85#define PFTM_TCP_FIRST_PACKET_VAL	120	/* First TCP packet */
86#define PFTM_TCP_OPENING_VAL		30	/* No response yet */
87#define PFTM_TCP_ESTABLISHED_VAL	24*60*60/* Established */
88#define PFTM_TCP_CLOSING_VAL		15 * 60	/* Half closed */
89#define PFTM_TCP_FIN_WAIT_VAL		45	/* Got both FINs */
90#define PFTM_TCP_CLOSED_VAL		90	/* Got a RST */
91#define PFTM_UDP_FIRST_PACKET_VAL	60	/* First UDP packet */
92#define PFTM_UDP_SINGLE_VAL		30	/* Unidirectional */
93#define PFTM_UDP_MULTIPLE_VAL		60	/* Bidirectional */
94#define PFTM_ICMP_FIRST_PACKET_VAL	20	/* First ICMP packet */
95#define PFTM_ICMP_ERROR_REPLY_VAL	10	/* Got error response */
96#define PFTM_OTHER_FIRST_PACKET_VAL	60	/* First packet */
97#define PFTM_OTHER_SINGLE_VAL		30	/* Unidirectional */
98#define PFTM_OTHER_MULTIPLE_VAL		60	/* Bidirectional */
99#define PFTM_FRAG_VAL			30	/* Fragment expire */
100#define PFTM_INTERVAL_VAL		10	/* Expire interval */
101#define PFTM_SRC_NODE_VAL		0	/* Source tracking */
102#define PFTM_TS_DIFF_VAL		30	/* Allowed TS diff */
103
104enum	{ PF_NOPFROUTE, PF_FASTROUTE, PF_ROUTETO, PF_DUPTO, PF_REPLYTO };
105enum	{ PF_LIMIT_STATES, PF_LIMIT_SRC_NODES, PF_LIMIT_FRAGS,
106	  PF_LIMIT_TABLE_ENTRIES, PF_LIMIT_MAX };
107#define PF_POOL_IDMASK		0x0f
108enum	{ PF_POOL_NONE, PF_POOL_BITMASK, PF_POOL_RANDOM,
109	  PF_POOL_SRCHASH, PF_POOL_ROUNDROBIN };
110enum	{ PF_ADDR_ADDRMASK, PF_ADDR_NOROUTE, PF_ADDR_DYNIFTL,
111	  PF_ADDR_TABLE, PF_ADDR_URPFFAILED,
112	  PF_ADDR_RANGE };
113#define PF_POOL_TYPEMASK	0x0f
114#define PF_POOL_STICKYADDR	0x20
115#define	PF_WSCALE_FLAG		0x80
116#define	PF_WSCALE_MASK		0x0f
117
118#define	PF_LOG			0x01
119#define	PF_LOG_ALL		0x02
120#define	PF_LOG_SOCKET_LOOKUP	0x04
121
122struct pf_addr {
123	union {
124		struct in_addr		v4;
125		struct in6_addr		v6;
126		u_int8_t		addr8[16];
127		u_int16_t		addr16[8];
128		u_int32_t		addr32[4];
129	} pfa;		    /* 128-bit address */
130#define v4	pfa.v4
131#define v6	pfa.v6
132#define addr8	pfa.addr8
133#define addr16	pfa.addr16
134#define addr32	pfa.addr32
135};
136
137#define	PF_TABLE_NAME_SIZE	 32
138
139#define PFI_AFLAG_NETWORK	0x01
140#define PFI_AFLAG_BROADCAST	0x02
141#define PFI_AFLAG_PEER		0x04
142#define PFI_AFLAG_MODEMASK	0x07
143#define PFI_AFLAG_NOALIAS	0x08
144
145struct pf_addr_wrap {
146	union {
147		struct {
148			struct pf_addr		 addr;
149			struct pf_addr		 mask;
150		}			 a;
151		char			 ifname[IFNAMSIZ];
152		char			 tblname[PF_TABLE_NAME_SIZE];
153	}			 v;
154	union {
155		struct pfi_dynaddr	*dyn;
156		struct pfr_ktable	*tbl;
157		int			 dyncnt;
158		int			 tblcnt;
159	}			 p;
160	u_int8_t		 type;		/* PF_ADDR_* */
161	u_int8_t		 iflags;	/* PFI_AFLAG_* */
162};
163
164#ifdef _KERNEL
165
166struct pfi_dynaddr {
167	TAILQ_ENTRY(pfi_dynaddr)	 entry;
168	struct pf_addr			 pfid_addr4;
169	struct pf_addr			 pfid_mask4;
170	struct pf_addr			 pfid_addr6;
171	struct pf_addr			 pfid_mask6;
172	struct pfr_ktable		*pfid_kt;
173	struct pfi_kif			*pfid_kif;
174	int				 pfid_net;	/* mask or 128 */
175	int				 pfid_acnt4;	/* address count IPv4 */
176	int				 pfid_acnt6;	/* address count IPv6 */
177	sa_family_t			 pfid_af;	/* rule af */
178	u_int8_t			 pfid_iflags;	/* PFI_AFLAG_* */
179};
180
181/*
182 * Address manipulation macros
183 */
184#define	HTONL(x)	(x) = htonl((__uint32_t)(x))
185#define	HTONS(x)	(x) = htons((__uint16_t)(x))
186#define	NTOHL(x)	(x) = ntohl((__uint32_t)(x))
187#define	NTOHS(x)	(x) = ntohs((__uint16_t)(x))
188
189#define	PF_NAME		"pf"
190
191#define	PF_HASHROW_ASSERT(h)	mtx_assert(&(h)->lock, MA_OWNED)
192#define	PF_HASHROW_LOCK(h)	mtx_lock(&(h)->lock)
193#define	PF_HASHROW_UNLOCK(h)	mtx_unlock(&(h)->lock)
194
195#define	PF_STATE_LOCK(s)						\
196	do {								\
197		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)];	\
198		PF_HASHROW_LOCK(_ih);					\
199	} while (0)
200
201#define	PF_STATE_UNLOCK(s)						\
202	do {								\
203		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH((s))];	\
204		PF_HASHROW_UNLOCK(_ih);					\
205	} while (0)
206
207#ifdef INVARIANTS
208#define	PF_STATE_LOCK_ASSERT(s)						\
209	do {								\
210		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)];	\
211		PF_HASHROW_ASSERT(_ih);					\
212	} while (0)
213#else /* !INVARIANTS */
214#define	PF_STATE_LOCK_ASSERT(s)		do {} while (0)
215#endif /* INVARIANTS */
216
217extern struct mtx pf_unlnkdrules_mtx;
218#define	PF_UNLNKDRULES_LOCK()	mtx_lock(&pf_unlnkdrules_mtx)
219#define	PF_UNLNKDRULES_UNLOCK()	mtx_unlock(&pf_unlnkdrules_mtx)
220
221extern struct rwlock pf_rules_lock;
222#define	PF_RULES_RLOCK()	rw_rlock(&pf_rules_lock)
223#define	PF_RULES_RUNLOCK()	rw_runlock(&pf_rules_lock)
224#define	PF_RULES_WLOCK()	rw_wlock(&pf_rules_lock)
225#define	PF_RULES_WUNLOCK()	rw_wunlock(&pf_rules_lock)
226#define	PF_RULES_ASSERT()	rw_assert(&pf_rules_lock, RA_LOCKED)
227#define	PF_RULES_RASSERT()	rw_assert(&pf_rules_lock, RA_RLOCKED)
228#define	PF_RULES_WASSERT()	rw_assert(&pf_rules_lock, RA_WLOCKED)
229
230#define	PF_MODVER	1
231#define	PFLOG_MODVER	1
232#define	PFSYNC_MODVER	1
233
234#define	PFLOG_MINVER	1
235#define	PFLOG_PREFVER	PFLOG_MODVER
236#define	PFLOG_MAXVER	1
237#define	PFSYNC_MINVER	1
238#define	PFSYNC_PREFVER	PFSYNC_MODVER
239#define	PFSYNC_MAXVER	1
240
241#ifdef INET
242#ifndef INET6
243#define	PF_INET_ONLY
244#endif /* ! INET6 */
245#endif /* INET */
246
247#ifdef INET6
248#ifndef INET
249#define	PF_INET6_ONLY
250#endif /* ! INET */
251#endif /* INET6 */
252
253#ifdef INET
254#ifdef INET6
255#define	PF_INET_INET6
256#endif /* INET6 */
257#endif /* INET */
258
259#else
260
261#define	PF_INET_INET6
262
263#endif /* _KERNEL */
264
265/* Both IPv4 and IPv6 */
266#ifdef PF_INET_INET6
267
268#define PF_AEQ(a, b, c) \
269	((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
270	((a)->addr32[3] == (b)->addr32[3] && \
271	(a)->addr32[2] == (b)->addr32[2] && \
272	(a)->addr32[1] == (b)->addr32[1] && \
273	(a)->addr32[0] == (b)->addr32[0])) \
274
275#define PF_ANEQ(a, b, c) \
276	((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
277	((a)->addr32[3] != (b)->addr32[3] || \
278	(a)->addr32[2] != (b)->addr32[2] || \
279	(a)->addr32[1] != (b)->addr32[1] || \
280	(a)->addr32[0] != (b)->addr32[0])) \
281
282#define PF_AZERO(a, c) \
283	((c == AF_INET && !(a)->addr32[0]) || \
284	(!(a)->addr32[0] && !(a)->addr32[1] && \
285	!(a)->addr32[2] && !(a)->addr32[3] )) \
286
287#define PF_MATCHA(n, a, m, b, f) \
288	pf_match_addr(n, a, m, b, f)
289
290#define PF_ACPY(a, b, f) \
291	pf_addrcpy(a, b, f)
292
293#define PF_AINC(a, f) \
294	pf_addr_inc(a, f)
295
296#define PF_POOLMASK(a, b, c, d, f) \
297	pf_poolmask(a, b, c, d, f)
298
299#else
300
301/* Just IPv6 */
302
303#ifdef PF_INET6_ONLY
304
305#define PF_AEQ(a, b, c) \
306	((a)->addr32[3] == (b)->addr32[3] && \
307	(a)->addr32[2] == (b)->addr32[2] && \
308	(a)->addr32[1] == (b)->addr32[1] && \
309	(a)->addr32[0] == (b)->addr32[0]) \
310
311#define PF_ANEQ(a, b, c) \
312	((a)->addr32[3] != (b)->addr32[3] || \
313	(a)->addr32[2] != (b)->addr32[2] || \
314	(a)->addr32[1] != (b)->addr32[1] || \
315	(a)->addr32[0] != (b)->addr32[0]) \
316
317#define PF_AZERO(a, c) \
318	(!(a)->addr32[0] && \
319	!(a)->addr32[1] && \
320	!(a)->addr32[2] && \
321	!(a)->addr32[3] ) \
322
323#define PF_MATCHA(n, a, m, b, f) \
324	pf_match_addr(n, a, m, b, f)
325
326#define PF_ACPY(a, b, f) \
327	pf_addrcpy(a, b, f)
328
329#define PF_AINC(a, f) \
330	pf_addr_inc(a, f)
331
332#define PF_POOLMASK(a, b, c, d, f) \
333	pf_poolmask(a, b, c, d, f)
334
335#else
336
337/* Just IPv4 */
338#ifdef PF_INET_ONLY
339
340#define PF_AEQ(a, b, c) \
341	((a)->addr32[0] == (b)->addr32[0])
342
343#define PF_ANEQ(a, b, c) \
344	((a)->addr32[0] != (b)->addr32[0])
345
346#define PF_AZERO(a, c) \
347	(!(a)->addr32[0])
348
349#define PF_MATCHA(n, a, m, b, f) \
350	pf_match_addr(n, a, m, b, f)
351
352#define PF_ACPY(a, b, f) \
353	(a)->v4.s_addr = (b)->v4.s_addr
354
355#define PF_AINC(a, f) \
356	do { \
357		(a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
358	} while (0)
359
360#define PF_POOLMASK(a, b, c, d, f) \
361	do { \
362		(a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
363		(((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
364	} while (0)
365
366#endif /* PF_INET_ONLY */
367#endif /* PF_INET6_ONLY */
368#endif /* PF_INET_INET6 */
369
370/*
371 * XXX callers not FIB-aware in our version of pf yet.
372 * OpenBSD fixed it later it seems, 2010/05/07 13:33:16 claudio.
373 */
374#define	PF_MISMATCHAW(aw, x, af, neg, ifp, rtid)			\
375	(								\
376		(((aw)->type == PF_ADDR_NOROUTE &&			\
377		    pf_routable((x), (af), NULL, (rtid))) ||		\
378		(((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&	\
379		    pf_routable((x), (af), (ifp), (rtid))) ||		\
380		((aw)->type == PF_ADDR_TABLE &&				\
381		    !pfr_match_addr((aw)->p.tbl, (x), (af))) ||		\
382		((aw)->type == PF_ADDR_DYNIFTL &&			\
383		    !pfi_match_addr((aw)->p.dyn, (x), (af))) ||		\
384		((aw)->type == PF_ADDR_RANGE &&				\
385		    !pf_match_addr_range(&(aw)->v.a.addr,		\
386		    &(aw)->v.a.mask, (x), (af))) ||			\
387		((aw)->type == PF_ADDR_ADDRMASK &&			\
388		    !PF_AZERO(&(aw)->v.a.mask, (af)) &&			\
389		    !PF_MATCHA(0, &(aw)->v.a.addr,			\
390		    &(aw)->v.a.mask, (x), (af))))) !=			\
391		(neg)							\
392	)
393
394
395struct pf_rule_uid {
396	uid_t		 uid[2];
397	u_int8_t	 op;
398};
399
400struct pf_rule_gid {
401	uid_t		 gid[2];
402	u_int8_t	 op;
403};
404
405struct pf_rule_addr {
406	struct pf_addr_wrap	 addr;
407	u_int16_t		 port[2];
408	u_int8_t		 neg;
409	u_int8_t		 port_op;
410};
411
412struct pf_pooladdr {
413	struct pf_addr_wrap		 addr;
414	TAILQ_ENTRY(pf_pooladdr)	 entries;
415	char				 ifname[IFNAMSIZ];
416	struct pfi_kif			*kif;
417};
418
419TAILQ_HEAD(pf_palist, pf_pooladdr);
420
421struct pf_poolhashkey {
422	union {
423		u_int8_t		key8[16];
424		u_int16_t		key16[8];
425		u_int32_t		key32[4];
426	} pfk;		    /* 128-bit hash key */
427#define key8	pfk.key8
428#define key16	pfk.key16
429#define key32	pfk.key32
430};
431
432struct pf_pool {
433	struct pf_palist	 list;
434	struct pf_pooladdr	*cur;
435	struct pf_poolhashkey	 key;
436	struct pf_addr		 counter;
437	int			 tblidx;
438	u_int16_t		 proxy_port[2];
439	u_int8_t		 opts;
440};
441
442
443/* A packed Operating System description for fingerprinting */
444typedef u_int32_t pf_osfp_t;
445#define PF_OSFP_ANY	((pf_osfp_t)0)
446#define PF_OSFP_UNKNOWN	((pf_osfp_t)-1)
447#define PF_OSFP_NOMATCH	((pf_osfp_t)-2)
448
449struct pf_osfp_entry {
450	SLIST_ENTRY(pf_osfp_entry) fp_entry;
451	pf_osfp_t		fp_os;
452	int			fp_enflags;
453#define PF_OSFP_EXPANDED	0x001		/* expanded entry */
454#define PF_OSFP_GENERIC		0x002		/* generic signature */
455#define PF_OSFP_NODETAIL	0x004		/* no p0f details */
456#define PF_OSFP_LEN	32
457	char			fp_class_nm[PF_OSFP_LEN];
458	char			fp_version_nm[PF_OSFP_LEN];
459	char			fp_subtype_nm[PF_OSFP_LEN];
460};
461#define PF_OSFP_ENTRY_EQ(a, b) \
462    ((a)->fp_os == (b)->fp_os && \
463    memcmp((a)->fp_class_nm, (b)->fp_class_nm, PF_OSFP_LEN) == 0 && \
464    memcmp((a)->fp_version_nm, (b)->fp_version_nm, PF_OSFP_LEN) == 0 && \
465    memcmp((a)->fp_subtype_nm, (b)->fp_subtype_nm, PF_OSFP_LEN) == 0)
466
467/* handle pf_osfp_t packing */
468#define _FP_RESERVED_BIT	1  /* For the special negative #defines */
469#define _FP_UNUSED_BITS		1
470#define _FP_CLASS_BITS		10 /* OS Class (Windows, Linux) */
471#define _FP_VERSION_BITS	10 /* OS version (95, 98, NT, 2.4.54, 3.2) */
472#define _FP_SUBTYPE_BITS	10 /* patch level (NT SP4, SP3, ECN patch) */
473#define PF_OSFP_UNPACK(osfp, class, version, subtype) do { \
474	(class) = ((osfp) >> (_FP_VERSION_BITS+_FP_SUBTYPE_BITS)) & \
475	    ((1 << _FP_CLASS_BITS) - 1); \
476	(version) = ((osfp) >> _FP_SUBTYPE_BITS) & \
477	    ((1 << _FP_VERSION_BITS) - 1);\
478	(subtype) = (osfp) & ((1 << _FP_SUBTYPE_BITS) - 1); \
479} while(0)
480#define PF_OSFP_PACK(osfp, class, version, subtype) do { \
481	(osfp) = ((class) & ((1 << _FP_CLASS_BITS) - 1)) << (_FP_VERSION_BITS \
482	    + _FP_SUBTYPE_BITS); \
483	(osfp) |= ((version) & ((1 << _FP_VERSION_BITS) - 1)) << \
484	    _FP_SUBTYPE_BITS; \
485	(osfp) |= (subtype) & ((1 << _FP_SUBTYPE_BITS) - 1); \
486} while(0)
487
488/* the fingerprint of an OSes TCP SYN packet */
489typedef u_int64_t	pf_tcpopts_t;
490struct pf_os_fingerprint {
491	SLIST_HEAD(pf_osfp_enlist, pf_osfp_entry) fp_oses; /* list of matches */
492	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
493	u_int16_t		fp_wsize;	/* TCP window size */
494	u_int16_t		fp_psize;	/* ip->ip_len */
495	u_int16_t		fp_mss;		/* TCP MSS */
496	u_int16_t		fp_flags;
497#define PF_OSFP_WSIZE_MOD	0x0001		/* Window modulus */
498#define PF_OSFP_WSIZE_DC	0x0002		/* Window don't care */
499#define PF_OSFP_WSIZE_MSS	0x0004		/* Window multiple of MSS */
500#define PF_OSFP_WSIZE_MTU	0x0008		/* Window multiple of MTU */
501#define PF_OSFP_PSIZE_MOD	0x0010		/* packet size modulus */
502#define PF_OSFP_PSIZE_DC	0x0020		/* packet size don't care */
503#define PF_OSFP_WSCALE		0x0040		/* TCP window scaling */
504#define PF_OSFP_WSCALE_MOD	0x0080		/* TCP window scale modulus */
505#define PF_OSFP_WSCALE_DC	0x0100		/* TCP window scale dont-care */
506#define PF_OSFP_MSS		0x0200		/* TCP MSS */
507#define PF_OSFP_MSS_MOD		0x0400		/* TCP MSS modulus */
508#define PF_OSFP_MSS_DC		0x0800		/* TCP MSS dont-care */
509#define PF_OSFP_DF		0x1000		/* IPv4 don't fragment bit */
510#define PF_OSFP_TS0		0x2000		/* Zero timestamp */
511#define PF_OSFP_INET6		0x4000		/* IPv6 */
512	u_int8_t		fp_optcnt;	/* TCP option count */
513	u_int8_t		fp_wscale;	/* TCP window scaling */
514	u_int8_t		fp_ttl;		/* IPv4 TTL */
515#define PF_OSFP_MAXTTL_OFFSET	40
516/* TCP options packing */
517#define PF_OSFP_TCPOPT_NOP	0x0		/* TCP NOP option */
518#define PF_OSFP_TCPOPT_WSCALE	0x1		/* TCP window scaling option */
519#define PF_OSFP_TCPOPT_MSS	0x2		/* TCP max segment size opt */
520#define PF_OSFP_TCPOPT_SACK	0x3		/* TCP SACK OK option */
521#define PF_OSFP_TCPOPT_TS	0x4		/* TCP timestamp option */
522#define PF_OSFP_TCPOPT_BITS	3		/* bits used by each option */
523#define PF_OSFP_MAX_OPTS \
524    (sizeof(((struct pf_os_fingerprint *)0)->fp_tcpopts) * 8) \
525    / PF_OSFP_TCPOPT_BITS
526
527	SLIST_ENTRY(pf_os_fingerprint)	fp_next;
528};
529
530struct pf_osfp_ioctl {
531	struct pf_osfp_entry	fp_os;
532	pf_tcpopts_t		fp_tcpopts;	/* packed TCP options */
533	u_int16_t		fp_wsize;	/* TCP window size */
534	u_int16_t		fp_psize;	/* ip->ip_len */
535	u_int16_t		fp_mss;		/* TCP MSS */
536	u_int16_t		fp_flags;
537	u_int8_t		fp_optcnt;	/* TCP option count */
538	u_int8_t		fp_wscale;	/* TCP window scaling */
539	u_int8_t		fp_ttl;		/* IPv4 TTL */
540
541	int			fp_getnum;	/* DIOCOSFPGET number */
542};
543
544
545union pf_rule_ptr {
546	struct pf_rule		*ptr;
547	u_int32_t		 nr;
548};
549
550#define	PF_ANCHOR_NAME_SIZE	 64
551
552struct pf_rule {
553	struct pf_rule_addr	 src;
554	struct pf_rule_addr	 dst;
555#define PF_SKIP_IFP		0
556#define PF_SKIP_DIR		1
557#define PF_SKIP_AF		2
558#define PF_SKIP_PROTO		3
559#define PF_SKIP_SRC_ADDR	4
560#define PF_SKIP_SRC_PORT	5
561#define PF_SKIP_DST_ADDR	6
562#define PF_SKIP_DST_PORT	7
563#define PF_SKIP_COUNT		8
564	union pf_rule_ptr	 skip[PF_SKIP_COUNT];
565#define PF_RULE_LABEL_SIZE	 64
566	char			 label[PF_RULE_LABEL_SIZE];
567#define PF_QNAME_SIZE		 64
568	char			 ifname[IFNAMSIZ];
569	char			 qname[PF_QNAME_SIZE];
570	char			 pqname[PF_QNAME_SIZE];
571#define	PF_TAG_NAME_SIZE	 64
572	char			 tagname[PF_TAG_NAME_SIZE];
573	char			 match_tagname[PF_TAG_NAME_SIZE];
574
575	char			 overload_tblname[PF_TABLE_NAME_SIZE];
576
577	TAILQ_ENTRY(pf_rule)	 entries;
578	struct pf_pool		 rpool;
579
580	u_int64_t		 evaluations;
581	u_int64_t		 packets[2];
582	u_int64_t		 bytes[2];
583
584	struct pfi_kif		*kif;
585	struct pf_anchor	*anchor;
586	struct pfr_ktable	*overload_tbl;
587
588	pf_osfp_t		 os_fingerprint;
589
590	int			 rtableid;
591	u_int32_t		 timeout[PFTM_MAX];
592	u_int32_t		 states_cur;
593	u_int32_t		 states_tot;
594	u_int32_t		 max_states;
595	u_int32_t		 src_nodes;
596	u_int32_t		 max_src_nodes;
597	u_int32_t		 max_src_states;
598	u_int32_t		 spare1;			/* netgraph */
599	u_int32_t		 max_src_conn;
600	struct {
601		u_int32_t		limit;
602		u_int32_t		seconds;
603	}			 max_src_conn_rate;
604	u_int32_t		 qid;
605	u_int32_t		 pqid;
606	u_int32_t		 rt_listid;
607	u_int32_t		 nr;
608	u_int32_t		 prob;
609	uid_t			 cuid;
610	pid_t			 cpid;
611
612	u_int16_t		 return_icmp;
613	u_int16_t		 return_icmp6;
614	u_int16_t		 max_mss;
615	u_int16_t		 tag;
616	u_int16_t		 match_tag;
617	u_int16_t		 spare2;			/* netgraph */
618
619	struct pf_rule_uid	 uid;
620	struct pf_rule_gid	 gid;
621
622	u_int32_t		 rule_flag;
623	u_int8_t		 action;
624	u_int8_t		 direction;
625	u_int8_t		 log;
626	u_int8_t		 logif;
627	u_int8_t		 quick;
628	u_int8_t		 ifnot;
629	u_int8_t		 match_tag_not;
630	u_int8_t		 natpass;
631
632#define PF_STATE_NORMAL		0x1
633#define PF_STATE_MODULATE	0x2
634#define PF_STATE_SYNPROXY	0x3
635	u_int8_t		 keep_state;
636	sa_family_t		 af;
637	u_int8_t		 proto;
638	u_int8_t		 type;
639	u_int8_t		 code;
640	u_int8_t		 flags;
641	u_int8_t		 flagset;
642	u_int8_t		 min_ttl;
643	u_int8_t		 allow_opts;
644	u_int8_t		 rt;
645	u_int8_t		 return_ttl;
646	u_int8_t		 tos;
647	u_int8_t		 set_tos;
648	u_int8_t		 anchor_relative;
649	u_int8_t		 anchor_wildcard;
650
651#define PF_FLUSH		0x01
652#define PF_FLUSH_GLOBAL		0x02
653	u_int8_t		 flush;
654
655	struct {
656		struct pf_addr		addr;
657		u_int16_t		port;
658	}			divert;
659};
660
661/* rule flags */
662#define	PFRULE_DROP		0x0000
663#define	PFRULE_RETURNRST	0x0001
664#define	PFRULE_FRAGMENT		0x0002
665#define	PFRULE_RETURNICMP	0x0004
666#define	PFRULE_RETURN		0x0008
667#define	PFRULE_NOSYNC		0x0010
668#define PFRULE_SRCTRACK		0x0020  /* track source states */
669#define PFRULE_RULESRCTRACK	0x0040  /* per rule */
670#define	PFRULE_REFS		0x0080	/* rule has references */
671
672/* scrub flags */
673#define	PFRULE_NODF		0x0100
674#define	PFRULE_FRAGCROP		0x0200	/* non-buffering frag cache */
675#define	PFRULE_FRAGDROP		0x0400	/* drop funny fragments */
676#define PFRULE_RANDOMID		0x0800
677#define PFRULE_REASSEMBLE_TCP	0x1000
678#define PFRULE_SET_TOS		0x2000
679
680/* rule flags again */
681#define PFRULE_IFBOUND		0x00010000	/* if-bound */
682#define PFRULE_STATESLOPPY	0x00020000	/* sloppy state tracking */
683
684#define PFSTATE_HIWAT		10000	/* default state table size */
685#define PFSTATE_ADAPT_START	6000	/* default adaptive timeout start */
686#define PFSTATE_ADAPT_END	12000	/* default adaptive timeout end */
687
688
689struct pf_threshold {
690	u_int32_t	limit;
691#define	PF_THRESHOLD_MULT	1000
692#define PF_THRESHOLD_MAX	0xffffffff / PF_THRESHOLD_MULT
693	u_int32_t	seconds;
694	u_int32_t	count;
695	u_int32_t	last;
696};
697
698struct pf_src_node {
699	LIST_ENTRY(pf_src_node) entry;
700	struct pf_addr	 addr;
701	struct pf_addr	 raddr;
702	union pf_rule_ptr rule;
703	struct pfi_kif	*kif;
704	u_int64_t	 bytes[2];
705	u_int64_t	 packets[2];
706	u_int32_t	 states;
707	u_int32_t	 conn;
708	struct pf_threshold	conn_rate;
709	u_int32_t	 creation;
710	u_int32_t	 expire;
711	sa_family_t	 af;
712	u_int8_t	 ruletype;
713};
714
715#define PFSNODE_HIWAT		10000	/* default source node table size */
716
717struct pf_state_scrub {
718	struct timeval	pfss_last;	/* time received last packet	*/
719	u_int32_t	pfss_tsecr;	/* last echoed timestamp	*/
720	u_int32_t	pfss_tsval;	/* largest timestamp		*/
721	u_int32_t	pfss_tsval0;	/* original timestamp		*/
722	u_int16_t	pfss_flags;
723#define PFSS_TIMESTAMP	0x0001		/* modulate timestamp		*/
724#define PFSS_PAWS	0x0010		/* stricter PAWS checks		*/
725#define PFSS_PAWS_IDLED	0x0020		/* was idle too long.  no PAWS	*/
726#define PFSS_DATA_TS	0x0040		/* timestamp on data packets	*/
727#define PFSS_DATA_NOTS	0x0080		/* no timestamp on data packets	*/
728	u_int8_t	pfss_ttl;	/* stashed TTL			*/
729	u_int8_t	pad;
730	u_int32_t	pfss_ts_mod;	/* timestamp modulation		*/
731};
732
733struct pf_state_host {
734	struct pf_addr	addr;
735	u_int16_t	port;
736	u_int16_t	pad;
737};
738
739struct pf_state_peer {
740	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
741	u_int32_t	seqlo;		/* Max sequence number sent	*/
742	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
743	u_int32_t	seqdiff;	/* Sequence number modulator	*/
744	u_int16_t	max_win;	/* largest window (pre scaling)	*/
745	u_int16_t	mss;		/* Maximum segment size option	*/
746	u_int8_t	state;		/* active state level		*/
747	u_int8_t	wscale;		/* window scaling factor	*/
748	u_int8_t	tcp_est;	/* Did we reach TCPS_ESTABLISHED */
749	u_int8_t	pad[1];
750};
751
752/* Keep synced with struct pf_state_key. */
753struct pf_state_key_cmp {
754	struct pf_addr	 addr[2];
755	u_int16_t	 port[2];
756	sa_family_t	 af;
757	u_int8_t	 proto;
758	u_int8_t	 pad[2];
759};
760
761struct pf_state_key {
762	struct pf_addr	 addr[2];
763	u_int16_t	 port[2];
764	sa_family_t	 af;
765	u_int8_t	 proto;
766	u_int8_t	 pad[2];
767
768	LIST_ENTRY(pf_state_key) entry;
769	TAILQ_HEAD(, pf_state)	 states[2];
770};
771
772/* Keep synced with struct pf_state. */
773struct pf_state_cmp {
774	u_int64_t		 id;
775	u_int32_t		 creatorid;
776	u_int8_t		 direction;
777	u_int8_t		 pad[3];
778};
779
780struct pf_state {
781	u_int64_t		 id;
782	u_int32_t		 creatorid;
783	u_int8_t		 direction;
784	u_int8_t		 pad[3];
785
786	u_int			 refs;
787	TAILQ_ENTRY(pf_state)	 sync_list;
788	TAILQ_ENTRY(pf_state)	 key_list[2];
789	LIST_ENTRY(pf_state)	 entry;
790	struct pf_state_peer	 src;
791	struct pf_state_peer	 dst;
792	union pf_rule_ptr	 rule;
793	union pf_rule_ptr	 anchor;
794	union pf_rule_ptr	 nat_rule;
795	struct pf_addr		 rt_addr;
796	struct pf_state_key	*key[2];	/* addresses stack and wire  */
797	struct pfi_kif		*kif;
798	struct pfi_kif		*rt_kif;
799	struct pf_src_node	*src_node;
800	struct pf_src_node	*nat_src_node;
801	u_int64_t		 packets[2];
802	u_int64_t		 bytes[2];
803	u_int32_t		 creation;
804	u_int32_t	 	 expire;
805	u_int32_t		 pfsync_time;
806	u_int16_t		 tag;
807	u_int8_t		 log;
808	u_int8_t		 state_flags;
809#define	PFSTATE_ALLOWOPTS	0x01
810#define	PFSTATE_SLOPPY		0x02
811/*  was	PFSTATE_PFLOW		0x04 */
812#define	PFSTATE_NOSYNC		0x08
813#define	PFSTATE_ACK		0x10
814	u_int8_t		 timeout;
815	u_int8_t		 sync_state; /* PFSYNC_S_x */
816
817	/* XXX */
818	u_int8_t		 sync_updates;
819	u_int8_t		_tail[3];
820};
821
822/*
823 * Unified state structures for pulling states out of the kernel
824 * used by pfsync(4) and the pf(4) ioctl.
825 */
826struct pfsync_state_scrub {
827	u_int16_t	pfss_flags;
828	u_int8_t	pfss_ttl;	/* stashed TTL		*/
829#define PFSYNC_SCRUB_FLAG_VALID		0x01
830	u_int8_t	scrub_flag;
831	u_int32_t	pfss_ts_mod;	/* timestamp modulation	*/
832} __packed;
833
834struct pfsync_state_peer {
835	struct pfsync_state_scrub scrub;	/* state is scrubbed	*/
836	u_int32_t	seqlo;		/* Max sequence number sent	*/
837	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
838	u_int32_t	seqdiff;	/* Sequence number modulator	*/
839	u_int16_t	max_win;	/* largest window (pre scaling)	*/
840	u_int16_t	mss;		/* Maximum segment size option	*/
841	u_int8_t	state;		/* active state level		*/
842	u_int8_t	wscale;		/* window scaling factor	*/
843	u_int8_t	pad[6];
844} __packed;
845
846struct pfsync_state_key {
847	struct pf_addr	 addr[2];
848	u_int16_t	 port[2];
849};
850
851struct pfsync_state {
852	u_int64_t	 id;
853	char		 ifname[IFNAMSIZ];
854	struct pfsync_state_key	key[2];
855	struct pfsync_state_peer src;
856	struct pfsync_state_peer dst;
857	struct pf_addr	 rt_addr;
858	u_int32_t	 rule;
859	u_int32_t	 anchor;
860	u_int32_t	 nat_rule;
861	u_int32_t	 creation;
862	u_int32_t	 expire;
863	u_int32_t	 packets[2][2];
864	u_int32_t	 bytes[2][2];
865	u_int32_t	 creatorid;
866	sa_family_t	 af;
867	u_int8_t	 proto;
868	u_int8_t	 direction;
869	u_int8_t	 __spare[2];
870	u_int8_t	 log;
871	u_int8_t	 state_flags;
872	u_int8_t	 timeout;
873	u_int8_t	 sync_flags;
874	u_int8_t	 updates;
875} __packed;
876
877#ifdef _KERNEL
878/* pfsync */
879typedef int		pfsync_state_import_t(struct pfsync_state *, u_int8_t);
880typedef	void		pfsync_insert_state_t(struct pf_state *);
881typedef	void		pfsync_update_state_t(struct pf_state *);
882typedef	void		pfsync_delete_state_t(struct pf_state *);
883typedef void		pfsync_clear_states_t(u_int32_t, const char *);
884typedef int		pfsync_defer_t(struct pf_state *, struct mbuf *);
885
886extern pfsync_state_import_t	*pfsync_state_import_ptr;
887extern pfsync_insert_state_t	*pfsync_insert_state_ptr;
888extern pfsync_update_state_t	*pfsync_update_state_ptr;
889extern pfsync_delete_state_t	*pfsync_delete_state_ptr;
890extern pfsync_clear_states_t	*pfsync_clear_states_ptr;
891extern pfsync_defer_t		*pfsync_defer_ptr;
892
893void			pfsync_state_export(struct pfsync_state *,
894			    struct pf_state *);
895
896/* pflog */
897struct pf_ruleset;
898struct pf_pdesc;
899typedef int pflog_packet_t(struct pfi_kif *, struct mbuf *, sa_family_t,
900    u_int8_t, u_int8_t, struct pf_rule *, struct pf_rule *,
901    struct pf_ruleset *, struct pf_pdesc *, int);
902extern pflog_packet_t		*pflog_packet_ptr;
903
904#define	V_pf_end_threads	VNET(pf_end_threads)
905#endif /* _KERNEL */
906
907#define	PFSYNC_FLAG_SRCNODE	0x04
908#define	PFSYNC_FLAG_NATSRCNODE	0x08
909
910/* for copies to/from network byte order */
911/* ioctl interface also uses network byte order */
912#define pf_state_peer_hton(s,d) do {		\
913	(d)->seqlo = htonl((s)->seqlo);		\
914	(d)->seqhi = htonl((s)->seqhi);		\
915	(d)->seqdiff = htonl((s)->seqdiff);	\
916	(d)->max_win = htons((s)->max_win);	\
917	(d)->mss = htons((s)->mss);		\
918	(d)->state = (s)->state;		\
919	(d)->wscale = (s)->wscale;		\
920	if ((s)->scrub) {						\
921		(d)->scrub.pfss_flags = 				\
922		    htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP);	\
923		(d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl;		\
924		(d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
925		(d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID;	\
926	}								\
927} while (0)
928
929#define pf_state_peer_ntoh(s,d) do {		\
930	(d)->seqlo = ntohl((s)->seqlo);		\
931	(d)->seqhi = ntohl((s)->seqhi);		\
932	(d)->seqdiff = ntohl((s)->seqdiff);	\
933	(d)->max_win = ntohs((s)->max_win);	\
934	(d)->mss = ntohs((s)->mss);		\
935	(d)->state = (s)->state;		\
936	(d)->wscale = (s)->wscale;		\
937	if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID && 	\
938	    (d)->scrub != NULL) {					\
939		(d)->scrub->pfss_flags =				\
940		    ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP;	\
941		(d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl;		\
942		(d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
943	}								\
944} while (0)
945
946#define pf_state_counter_hton(s,d) do {				\
947	d[0] = htonl((s>>32)&0xffffffff);			\
948	d[1] = htonl(s&0xffffffff);				\
949} while (0)
950
951#define pf_state_counter_from_pfsync(s)				\
952	(((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
953
954#define pf_state_counter_ntoh(s,d) do {				\
955	d = ntohl(s[0]);					\
956	d = d<<32;						\
957	d += ntohl(s[1]);					\
958} while (0)
959
960TAILQ_HEAD(pf_rulequeue, pf_rule);
961
962struct pf_anchor;
963
964struct pf_ruleset {
965	struct {
966		struct pf_rulequeue	 queues[2];
967		struct {
968			struct pf_rulequeue	*ptr;
969			struct pf_rule		**ptr_array;
970			u_int32_t		 rcount;
971			u_int32_t		 ticket;
972			int			 open;
973		}			 active, inactive;
974	}			 rules[PF_RULESET_MAX];
975	struct pf_anchor	*anchor;
976	u_int32_t		 tticket;
977	int			 tables;
978	int			 topen;
979};
980
981RB_HEAD(pf_anchor_global, pf_anchor);
982RB_HEAD(pf_anchor_node, pf_anchor);
983struct pf_anchor {
984	RB_ENTRY(pf_anchor)	 entry_global;
985	RB_ENTRY(pf_anchor)	 entry_node;
986	struct pf_anchor	*parent;
987	struct pf_anchor_node	 children;
988	char			 name[PF_ANCHOR_NAME_SIZE];
989	char			 path[MAXPATHLEN];
990	struct pf_ruleset	 ruleset;
991	int			 refcnt;	/* anchor rules */
992	int			 match;
993};
994RB_PROTOTYPE(pf_anchor_global, pf_anchor, entry_global, pf_anchor_compare);
995RB_PROTOTYPE(pf_anchor_node, pf_anchor, entry_node, pf_anchor_compare);
996
997#define PF_RESERVED_ANCHOR	"_pf"
998
999#define PFR_TFLAG_PERSIST	0x00000001
1000#define PFR_TFLAG_CONST		0x00000002
1001#define PFR_TFLAG_ACTIVE	0x00000004
1002#define PFR_TFLAG_INACTIVE	0x00000008
1003#define PFR_TFLAG_REFERENCED	0x00000010
1004#define PFR_TFLAG_REFDANCHOR	0x00000020
1005#define PFR_TFLAG_COUNTERS	0x00000040
1006/* Adjust masks below when adding flags. */
1007#define PFR_TFLAG_USRMASK	(PFR_TFLAG_PERSIST	| \
1008				 PFR_TFLAG_CONST	| \
1009				 PFR_TFLAG_COUNTERS)
1010#define PFR_TFLAG_SETMASK	(PFR_TFLAG_ACTIVE	| \
1011				 PFR_TFLAG_INACTIVE	| \
1012				 PFR_TFLAG_REFERENCED	| \
1013				 PFR_TFLAG_REFDANCHOR)
1014#define PFR_TFLAG_ALLMASK	(PFR_TFLAG_PERSIST	| \
1015				 PFR_TFLAG_CONST	| \
1016				 PFR_TFLAG_ACTIVE	| \
1017				 PFR_TFLAG_INACTIVE	| \
1018				 PFR_TFLAG_REFERENCED	| \
1019				 PFR_TFLAG_REFDANCHOR	| \
1020				 PFR_TFLAG_COUNTERS)
1021
1022struct pfr_table {
1023	char			 pfrt_anchor[MAXPATHLEN];
1024	char			 pfrt_name[PF_TABLE_NAME_SIZE];
1025	u_int32_t		 pfrt_flags;
1026	u_int8_t		 pfrt_fback;
1027};
1028
1029enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
1030	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
1031	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
1032
1033struct pfr_addr {
1034	union {
1035		struct in_addr	 _pfra_ip4addr;
1036		struct in6_addr	 _pfra_ip6addr;
1037	}		 pfra_u;
1038	u_int8_t	 pfra_af;
1039	u_int8_t	 pfra_net;
1040	u_int8_t	 pfra_not;
1041	u_int8_t	 pfra_fback;
1042};
1043#define	pfra_ip4addr	pfra_u._pfra_ip4addr
1044#define	pfra_ip6addr	pfra_u._pfra_ip6addr
1045
1046enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
1047enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
1048#define PFR_OP_XPASS	PFR_OP_ADDR_MAX
1049
1050struct pfr_astats {
1051	struct pfr_addr	 pfras_a;
1052	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1053	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1054	long		 pfras_tzero;
1055};
1056
1057enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
1058
1059struct pfr_tstats {
1060	struct pfr_table pfrts_t;
1061	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1062	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
1063	u_int64_t	 pfrts_match;
1064	u_int64_t	 pfrts_nomatch;
1065	long		 pfrts_tzero;
1066	int		 pfrts_cnt;
1067	int		 pfrts_refcnt[PFR_REFCNT_MAX];
1068};
1069#define	pfrts_name	pfrts_t.pfrt_name
1070#define pfrts_flags	pfrts_t.pfrt_flags
1071
1072#ifndef _SOCKADDR_UNION_DEFINED
1073#define	_SOCKADDR_UNION_DEFINED
1074union sockaddr_union {
1075	struct sockaddr		sa;
1076	struct sockaddr_in	sin;
1077	struct sockaddr_in6	sin6;
1078};
1079#endif /* _SOCKADDR_UNION_DEFINED */
1080
1081struct pfr_kcounters {
1082	u_int64_t		 pfrkc_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1083	u_int64_t		 pfrkc_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
1084};
1085
1086SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
1087struct pfr_kentry {
1088	struct radix_node	 pfrke_node[2];
1089	union sockaddr_union	 pfrke_sa;
1090	SLIST_ENTRY(pfr_kentry)	 pfrke_workq;
1091	struct pfr_kcounters	*pfrke_counters;
1092	long			 pfrke_tzero;
1093	u_int8_t		 pfrke_af;
1094	u_int8_t		 pfrke_net;
1095	u_int8_t		 pfrke_not;
1096	u_int8_t		 pfrke_mark;
1097};
1098
1099SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
1100RB_HEAD(pfr_ktablehead, pfr_ktable);
1101struct pfr_ktable {
1102	struct pfr_tstats	 pfrkt_ts;
1103	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
1104	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
1105	struct radix_node_head	*pfrkt_ip4;
1106	struct radix_node_head	*pfrkt_ip6;
1107	struct pfr_ktable	*pfrkt_shadow;
1108	struct pfr_ktable	*pfrkt_root;
1109	struct pf_ruleset	*pfrkt_rs;
1110	long			 pfrkt_larg;
1111	int			 pfrkt_nflags;
1112};
1113#define pfrkt_t		pfrkt_ts.pfrts_t
1114#define pfrkt_name	pfrkt_t.pfrt_name
1115#define pfrkt_anchor	pfrkt_t.pfrt_anchor
1116#define pfrkt_ruleset	pfrkt_t.pfrt_ruleset
1117#define pfrkt_flags	pfrkt_t.pfrt_flags
1118#define pfrkt_cnt	pfrkt_ts.pfrts_cnt
1119#define pfrkt_refcnt	pfrkt_ts.pfrts_refcnt
1120#define pfrkt_packets	pfrkt_ts.pfrts_packets
1121#define pfrkt_bytes	pfrkt_ts.pfrts_bytes
1122#define pfrkt_match	pfrkt_ts.pfrts_match
1123#define pfrkt_nomatch	pfrkt_ts.pfrts_nomatch
1124#define pfrkt_tzero	pfrkt_ts.pfrts_tzero
1125
1126/* keep synced with pfi_kif, used in RB_FIND */
1127struct pfi_kif_cmp {
1128	char				 pfik_name[IFNAMSIZ];
1129};
1130
1131struct pfi_kif {
1132	char				 pfik_name[IFNAMSIZ];
1133	union {
1134		RB_ENTRY(pfi_kif)	 _pfik_tree;
1135		LIST_ENTRY(pfi_kif)	 _pfik_list;
1136	} _pfik_glue;
1137#define	pfik_tree	_pfik_glue._pfik_tree
1138#define	pfik_list	_pfik_glue._pfik_list
1139	u_int64_t			 pfik_packets[2][2][2];
1140	u_int64_t			 pfik_bytes[2][2][2];
1141	u_int32_t			 pfik_tzero;
1142	u_int				 pfik_flags;
1143	struct ifnet			*pfik_ifp;
1144	struct ifg_group		*pfik_group;
1145	u_int				 pfik_rulerefs;
1146	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
1147};
1148
1149#define	PFI_IFLAG_REFS		0x0001	/* has state references */
1150#define PFI_IFLAG_SKIP		0x0100	/* skip filtering on interface */
1151
1152struct pf_pdesc {
1153	struct {
1154		int	 done;
1155		uid_t	 uid;
1156		gid_t	 gid;
1157	}		 lookup;
1158	u_int64_t	 tot_len;	/* Make Mickey money */
1159	union {
1160		struct tcphdr		*tcp;
1161		struct udphdr		*udp;
1162		struct icmp		*icmp;
1163#ifdef INET6
1164		struct icmp6_hdr	*icmp6;
1165#endif /* INET6 */
1166		void			*any;
1167	} hdr;
1168
1169	struct pf_rule	*nat_rule;	/* nat/rdr rule applied to packet */
1170	struct pf_addr	*src;		/* src address */
1171	struct pf_addr	*dst;		/* dst address */
1172	u_int16_t *sport;
1173	u_int16_t *dport;
1174	struct pf_mtag	*pf_mtag;
1175
1176	u_int32_t	 p_len;		/* total length of payload */
1177
1178	u_int16_t	*ip_sum;
1179	u_int16_t	*proto_sum;
1180	u_int16_t	 flags;		/* Let SCRUB trigger behavior in
1181					 * state code. Easier than tags */
1182#define PFDESC_TCP_NORM	0x0001		/* TCP shall be statefully scrubbed */
1183#define PFDESC_IP_REAS	0x0002		/* IP frags would've been reassembled */
1184	sa_family_t	 af;
1185	u_int8_t	 proto;
1186	u_int8_t	 tos;
1187	u_int8_t	 dir;		/* direction */
1188	u_int8_t	 sidx;		/* key index for source */
1189	u_int8_t	 didx;		/* key index for destination */
1190};
1191
1192/* flags for RDR options */
1193#define PF_DPORT_RANGE	0x01		/* Dest port uses range */
1194#define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
1195
1196/* Reasons code for passing/dropping a packet */
1197#define PFRES_MATCH	0		/* Explicit match of a rule */
1198#define PFRES_BADOFF	1		/* Bad offset for pull_hdr */
1199#define PFRES_FRAG	2		/* Dropping following fragment */
1200#define PFRES_SHORT	3		/* Dropping short packet */
1201#define PFRES_NORM	4		/* Dropping by normalizer */
1202#define PFRES_MEMORY	5		/* Dropped due to lacking mem */
1203#define PFRES_TS	6		/* Bad TCP Timestamp (RFC1323) */
1204#define PFRES_CONGEST	7		/* Congestion (of ipintrq) */
1205#define PFRES_IPOPTIONS 8		/* IP option */
1206#define PFRES_PROTCKSUM 9		/* Protocol checksum invalid */
1207#define PFRES_BADSTATE	10		/* State mismatch */
1208#define PFRES_STATEINS	11		/* State insertion failure */
1209#define PFRES_MAXSTATES	12		/* State limit */
1210#define PFRES_SRCLIMIT	13		/* Source node/conn limit */
1211#define PFRES_SYNPROXY	14		/* SYN proxy */
1212#define PFRES_MAX	15		/* total+1 */
1213
1214#define PFRES_NAMES { \
1215	"match", \
1216	"bad-offset", \
1217	"fragment", \
1218	"short", \
1219	"normalize", \
1220	"memory", \
1221	"bad-timestamp", \
1222	"congestion", \
1223	"ip-option", \
1224	"proto-cksum", \
1225	"state-mismatch", \
1226	"state-insert", \
1227	"state-limit", \
1228	"src-limit", \
1229	"synproxy", \
1230	NULL \
1231}
1232
1233/* Counters for other things we want to keep track of */
1234#define LCNT_STATES		0	/* states */
1235#define LCNT_SRCSTATES		1	/* max-src-states */
1236#define LCNT_SRCNODES		2	/* max-src-nodes */
1237#define LCNT_SRCCONN		3	/* max-src-conn */
1238#define LCNT_SRCCONNRATE	4	/* max-src-conn-rate */
1239#define LCNT_OVERLOAD_TABLE	5	/* entry added to overload table */
1240#define LCNT_OVERLOAD_FLUSH	6	/* state entries flushed */
1241#define LCNT_MAX		7	/* total+1 */
1242
1243#define LCNT_NAMES { \
1244	"max states per rule", \
1245	"max-src-states", \
1246	"max-src-nodes", \
1247	"max-src-conn", \
1248	"max-src-conn-rate", \
1249	"overload table insertion", \
1250	"overload flush states", \
1251	NULL \
1252}
1253
1254/* UDP state enumeration */
1255#define PFUDPS_NO_TRAFFIC	0
1256#define PFUDPS_SINGLE		1
1257#define PFUDPS_MULTIPLE		2
1258
1259#define PFUDPS_NSTATES		3	/* number of state levels */
1260
1261#define PFUDPS_NAMES { \
1262	"NO_TRAFFIC", \
1263	"SINGLE", \
1264	"MULTIPLE", \
1265	NULL \
1266}
1267
1268/* Other protocol state enumeration */
1269#define PFOTHERS_NO_TRAFFIC	0
1270#define PFOTHERS_SINGLE		1
1271#define PFOTHERS_MULTIPLE	2
1272
1273#define PFOTHERS_NSTATES	3	/* number of state levels */
1274
1275#define PFOTHERS_NAMES { \
1276	"NO_TRAFFIC", \
1277	"SINGLE", \
1278	"MULTIPLE", \
1279	NULL \
1280}
1281
1282#define FCNT_STATE_SEARCH	0
1283#define FCNT_STATE_INSERT	1
1284#define FCNT_STATE_REMOVALS	2
1285#define FCNT_MAX		3
1286
1287#define SCNT_SRC_NODE_SEARCH	0
1288#define SCNT_SRC_NODE_INSERT	1
1289#define SCNT_SRC_NODE_REMOVALS	2
1290#define SCNT_MAX		3
1291
1292#define ACTION_SET(a, x) \
1293	do { \
1294		if ((a) != NULL) \
1295			*(a) = (x); \
1296	} while (0)
1297
1298#define REASON_SET(a, x) \
1299	do { \
1300		if ((a) != NULL) \
1301			*(a) = (x); \
1302		if (x < PFRES_MAX) \
1303			V_pf_status.counters[x]++; \
1304	} while (0)
1305
1306struct pf_status {
1307	u_int64_t	counters[PFRES_MAX];
1308	u_int64_t	lcounters[LCNT_MAX];	/* limit counters */
1309	u_int64_t	fcounters[FCNT_MAX];
1310	u_int64_t	scounters[SCNT_MAX];
1311	u_int64_t	pcounters[2][2][3];
1312	u_int64_t	bcounters[2][2];
1313	u_int32_t	running;
1314	u_int32_t	states;
1315	u_int32_t	src_nodes;
1316	u_int32_t	since;
1317	u_int32_t	debug;
1318	u_int32_t	hostid;
1319	char		ifname[IFNAMSIZ];
1320	u_int8_t	pf_chksum[PF_MD5_DIGEST_LENGTH];
1321};
1322
1323struct cbq_opts {
1324	u_int		minburst;
1325	u_int		maxburst;
1326	u_int		pktsize;
1327	u_int		maxpktsize;
1328	u_int		ns_per_byte;
1329	u_int		maxidle;
1330	int		minidle;
1331	u_int		offtime;
1332	int		flags;
1333};
1334
1335struct priq_opts {
1336	int		flags;
1337};
1338
1339struct hfsc_opts {
1340	/* real-time service curve */
1341	u_int		rtsc_m1;	/* slope of the 1st segment in bps */
1342	u_int		rtsc_d;		/* the x-projection of m1 in msec */
1343	u_int		rtsc_m2;	/* slope of the 2nd segment in bps */
1344	/* link-sharing service curve */
1345	u_int		lssc_m1;
1346	u_int		lssc_d;
1347	u_int		lssc_m2;
1348	/* upper-limit service curve */
1349	u_int		ulsc_m1;
1350	u_int		ulsc_d;
1351	u_int		ulsc_m2;
1352	int		flags;
1353};
1354
1355struct pf_altq {
1356	char			 ifname[IFNAMSIZ];
1357
1358	void			*altq_disc;	/* discipline-specific state */
1359	TAILQ_ENTRY(pf_altq)	 entries;
1360
1361	/* scheduler spec */
1362	u_int8_t		 scheduler;	/* scheduler type */
1363	u_int16_t		 tbrsize;	/* tokenbucket regulator size */
1364	u_int32_t		 ifbandwidth;	/* interface bandwidth */
1365
1366	/* queue spec */
1367	char			 qname[PF_QNAME_SIZE];	/* queue name */
1368	char			 parent[PF_QNAME_SIZE];	/* parent name */
1369	u_int32_t		 parent_qid;	/* parent queue id */
1370	u_int32_t		 bandwidth;	/* queue bandwidth */
1371	u_int8_t		 priority;	/* priority */
1372	u_int8_t		 local_flags;	/* dynamic interface */
1373#define	PFALTQ_FLAG_IF_REMOVED		0x01
1374
1375	u_int16_t		 qlimit;	/* queue size limit */
1376	u_int16_t		 flags;		/* misc flags */
1377	union {
1378		struct cbq_opts		 cbq_opts;
1379		struct priq_opts	 priq_opts;
1380		struct hfsc_opts	 hfsc_opts;
1381	} pq_u;
1382
1383	u_int32_t		 qid;		/* return value */
1384};
1385
1386struct pf_divert {
1387	union {
1388		struct in_addr	ipv4;
1389		struct in6_addr	ipv6;
1390	}		addr;
1391	u_int16_t	port;
1392};
1393
1394#define PFFRAG_FRENT_HIWAT	5000	/* Number of fragment entries */
1395#define PFR_KENTRY_HIWAT	200000	/* Number of table entries */
1396
1397/*
1398 * ioctl parameter structures
1399 */
1400
1401struct pfioc_pooladdr {
1402	u_int32_t		 action;
1403	u_int32_t		 ticket;
1404	u_int32_t		 nr;
1405	u_int32_t		 r_num;
1406	u_int8_t		 r_action;
1407	u_int8_t		 r_last;
1408	u_int8_t		 af;
1409	char			 anchor[MAXPATHLEN];
1410	struct pf_pooladdr	 addr;
1411};
1412
1413struct pfioc_rule {
1414	u_int32_t	 action;
1415	u_int32_t	 ticket;
1416	u_int32_t	 pool_ticket;
1417	u_int32_t	 nr;
1418	char		 anchor[MAXPATHLEN];
1419	char		 anchor_call[MAXPATHLEN];
1420	struct pf_rule	 rule;
1421};
1422
1423struct pfioc_natlook {
1424	struct pf_addr	 saddr;
1425	struct pf_addr	 daddr;
1426	struct pf_addr	 rsaddr;
1427	struct pf_addr	 rdaddr;
1428	u_int16_t	 sport;
1429	u_int16_t	 dport;
1430	u_int16_t	 rsport;
1431	u_int16_t	 rdport;
1432	sa_family_t	 af;
1433	u_int8_t	 proto;
1434	u_int8_t	 direction;
1435};
1436
1437struct pfioc_state {
1438	struct pfsync_state	state;
1439};
1440
1441struct pfioc_src_node_kill {
1442	sa_family_t psnk_af;
1443	struct pf_rule_addr psnk_src;
1444	struct pf_rule_addr psnk_dst;
1445	u_int		    psnk_killed;
1446};
1447
1448struct pfioc_state_kill {
1449	struct pf_state_cmp	psk_pfcmp;
1450	sa_family_t		psk_af;
1451	int			psk_proto;
1452	struct pf_rule_addr	psk_src;
1453	struct pf_rule_addr	psk_dst;
1454	char			psk_ifname[IFNAMSIZ];
1455	char			psk_label[PF_RULE_LABEL_SIZE];
1456	u_int			psk_killed;
1457};
1458
1459struct pfioc_states {
1460	int	ps_len;
1461	union {
1462		caddr_t			 psu_buf;
1463		struct pfsync_state	*psu_states;
1464	} ps_u;
1465#define ps_buf		ps_u.psu_buf
1466#define ps_states	ps_u.psu_states
1467};
1468
1469struct pfioc_src_nodes {
1470	int	psn_len;
1471	union {
1472		caddr_t		 psu_buf;
1473		struct pf_src_node	*psu_src_nodes;
1474	} psn_u;
1475#define psn_buf		psn_u.psu_buf
1476#define psn_src_nodes	psn_u.psu_src_nodes
1477};
1478
1479struct pfioc_if {
1480	char		 ifname[IFNAMSIZ];
1481};
1482
1483struct pfioc_tm {
1484	int		 timeout;
1485	int		 seconds;
1486};
1487
1488struct pfioc_limit {
1489	int		 index;
1490	unsigned	 limit;
1491};
1492
1493struct pfioc_altq {
1494	u_int32_t	 action;
1495	u_int32_t	 ticket;
1496	u_int32_t	 nr;
1497	struct pf_altq	 altq;
1498};
1499
1500struct pfioc_qstats {
1501	u_int32_t	 ticket;
1502	u_int32_t	 nr;
1503	void		*buf;
1504	int		 nbytes;
1505	u_int8_t	 scheduler;
1506};
1507
1508struct pfioc_ruleset {
1509	u_int32_t	 nr;
1510	char		 path[MAXPATHLEN];
1511	char		 name[PF_ANCHOR_NAME_SIZE];
1512};
1513
1514#define PF_RULESET_ALTQ		(PF_RULESET_MAX)
1515#define PF_RULESET_TABLE	(PF_RULESET_MAX+1)
1516struct pfioc_trans {
1517	int		 size;	/* number of elements */
1518	int		 esize; /* size of each element in bytes */
1519	struct pfioc_trans_e {
1520		int		rs_num;
1521		char		anchor[MAXPATHLEN];
1522		u_int32_t	ticket;
1523	}		*array;
1524};
1525
1526#define PFR_FLAG_ATOMIC		0x00000001	/* unused */
1527#define PFR_FLAG_DUMMY		0x00000002
1528#define PFR_FLAG_FEEDBACK	0x00000004
1529#define PFR_FLAG_CLSTATS	0x00000008
1530#define PFR_FLAG_ADDRSTOO	0x00000010
1531#define PFR_FLAG_REPLACE	0x00000020
1532#define PFR_FLAG_ALLRSETS	0x00000040
1533#define PFR_FLAG_ALLMASK	0x0000007F
1534#ifdef _KERNEL
1535#define PFR_FLAG_USERIOCTL	0x10000000
1536#endif
1537
1538struct pfioc_table {
1539	struct pfr_table	 pfrio_table;
1540	void			*pfrio_buffer;
1541	int			 pfrio_esize;
1542	int			 pfrio_size;
1543	int			 pfrio_size2;
1544	int			 pfrio_nadd;
1545	int			 pfrio_ndel;
1546	int			 pfrio_nchange;
1547	int			 pfrio_flags;
1548	u_int32_t		 pfrio_ticket;
1549};
1550#define	pfrio_exists	pfrio_nadd
1551#define	pfrio_nzero	pfrio_nadd
1552#define	pfrio_nmatch	pfrio_nadd
1553#define pfrio_naddr	pfrio_size2
1554#define pfrio_setflag	pfrio_size2
1555#define pfrio_clrflag	pfrio_nadd
1556
1557struct pfioc_iface {
1558	char	 pfiio_name[IFNAMSIZ];
1559	void	*pfiio_buffer;
1560	int	 pfiio_esize;
1561	int	 pfiio_size;
1562	int	 pfiio_nzero;
1563	int	 pfiio_flags;
1564};
1565
1566
1567/*
1568 * ioctl operations
1569 */
1570
1571#define DIOCSTART	_IO  ('D',  1)
1572#define DIOCSTOP	_IO  ('D',  2)
1573#define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
1574#define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
1575#define DIOCGETRULE	_IOWR('D',  7, struct pfioc_rule)
1576/* XXX cut 8 - 17 */
1577#define DIOCCLRSTATES	_IOWR('D', 18, struct pfioc_state_kill)
1578#define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
1579#define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1580#define DIOCGETSTATUS	_IOWR('D', 21, struct pf_status)
1581#define DIOCCLRSTATUS	_IO  ('D', 22)
1582#define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
1583#define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
1584#define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
1585#define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
1586/* XXX cut 26 - 28 */
1587#define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
1588#define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
1589#define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
1590#define DIOCCLRRULECTRS	_IO  ('D', 38)
1591#define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
1592#define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
1593#define DIOCKILLSTATES	_IOWR('D', 41, struct pfioc_state_kill)
1594#define DIOCSTARTALTQ	_IO  ('D', 42)
1595#define DIOCSTOPALTQ	_IO  ('D', 43)
1596#define DIOCADDALTQ	_IOWR('D', 45, struct pfioc_altq)
1597#define DIOCGETALTQS	_IOWR('D', 47, struct pfioc_altq)
1598#define DIOCGETALTQ	_IOWR('D', 48, struct pfioc_altq)
1599#define DIOCCHANGEALTQ	_IOWR('D', 49, struct pfioc_altq)
1600#define DIOCGETQSTATS	_IOWR('D', 50, struct pfioc_qstats)
1601#define DIOCBEGINADDRS	_IOWR('D', 51, struct pfioc_pooladdr)
1602#define DIOCADDADDR	_IOWR('D', 52, struct pfioc_pooladdr)
1603#define DIOCGETADDRS	_IOWR('D', 53, struct pfioc_pooladdr)
1604#define DIOCGETADDR	_IOWR('D', 54, struct pfioc_pooladdr)
1605#define DIOCCHANGEADDR	_IOWR('D', 55, struct pfioc_pooladdr)
1606/* XXX cut 55 - 57 */
1607#define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
1608#define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
1609#define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
1610#define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
1611#define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
1612#define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
1613#define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
1614#define DIOCRCLRTSTATS	_IOWR('D', 65, struct pfioc_table)
1615#define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
1616#define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
1617#define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
1618#define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
1619#define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
1620#define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
1621#define	DIOCRCLRASTATS	_IOWR('D', 72, struct pfioc_table)
1622#define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
1623#define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
1624#define	DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
1625#define	DIOCOSFPFLUSH	_IO('D', 78)
1626#define	DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
1627#define	DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
1628#define	DIOCXBEGIN	_IOWR('D', 81, struct pfioc_trans)
1629#define	DIOCXCOMMIT	_IOWR('D', 82, struct pfioc_trans)
1630#define	DIOCXROLLBACK	_IOWR('D', 83, struct pfioc_trans)
1631#define	DIOCGETSRCNODES	_IOWR('D', 84, struct pfioc_src_nodes)
1632#define	DIOCCLRSRCNODES	_IO('D', 85)
1633#define	DIOCSETHOSTID	_IOWR('D', 86, u_int32_t)
1634#define	DIOCIGETIFACES	_IOWR('D', 87, struct pfioc_iface)
1635#define	DIOCSETIFFLAG	_IOWR('D', 89, struct pfioc_iface)
1636#define	DIOCCLRIFFLAG	_IOWR('D', 90, struct pfioc_iface)
1637#define	DIOCKILLSRCNODES	_IOWR('D', 91, struct pfioc_src_node_kill)
1638struct pf_ifspeed {
1639	char			ifname[IFNAMSIZ];
1640	u_int32_t		baudrate;
1641};
1642#define	DIOCGIFSPEED	_IOWR('D', 92, struct pf_ifspeed)
1643
1644#ifdef _KERNEL
1645struct pf_srchash {
1646	LIST_HEAD(, pf_src_node)	nodes;
1647	struct mtx			lock;
1648};
1649
1650struct pf_keyhash {
1651	LIST_HEAD(, pf_state_key)	keys;
1652	struct mtx			lock;
1653};
1654
1655struct pf_idhash {
1656	LIST_HEAD(, pf_state)		states;
1657	struct mtx			lock;
1658};
1659
1660#define	PF_HASHSIZ	(32768)
1661VNET_DECLARE(struct pf_keyhash *, pf_keyhash);
1662VNET_DECLARE(struct pf_idhash *, pf_idhash);
1663VNET_DECLARE(u_long, pf_hashmask);
1664#define V_pf_keyhash	VNET(pf_keyhash)
1665#define	V_pf_idhash	VNET(pf_idhash)
1666#define	V_pf_hashmask	VNET(pf_hashmask)
1667VNET_DECLARE(struct pf_srchash *, pf_srchash);
1668VNET_DECLARE(u_long, pf_srchashmask);
1669#define	V_pf_srchash	VNET(pf_srchash)
1670#define V_pf_srchashmask VNET(pf_srchashmask)
1671
1672#define PF_IDHASH(s)	(be64toh((s)->id) % (V_pf_hashmask + 1))
1673
1674VNET_DECLARE(void *, pf_swi_cookie);
1675#define V_pf_swi_cookie	VNET(pf_swi_cookie)
1676
1677VNET_DECLARE(uint64_t, pf_stateid[MAXCPU]);
1678#define	V_pf_stateid	VNET(pf_stateid)
1679
1680TAILQ_HEAD(pf_altqqueue, pf_altq);
1681VNET_DECLARE(struct pf_altqqueue,	 pf_altqs[2]);
1682#define	V_pf_altqs			 VNET(pf_altqs)
1683VNET_DECLARE(struct pf_palist,		 pf_pabuf);
1684#define	V_pf_pabuf			 VNET(pf_pabuf)
1685
1686VNET_DECLARE(u_int32_t,			 ticket_altqs_active);
1687#define	V_ticket_altqs_active		 VNET(ticket_altqs_active)
1688VNET_DECLARE(u_int32_t,			 ticket_altqs_inactive);
1689#define	V_ticket_altqs_inactive		 VNET(ticket_altqs_inactive)
1690VNET_DECLARE(int,			 altqs_inactive_open);
1691#define	V_altqs_inactive_open		 VNET(altqs_inactive_open)
1692VNET_DECLARE(u_int32_t,			 ticket_pabuf);
1693#define	V_ticket_pabuf			 VNET(ticket_pabuf)
1694VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_active);
1695#define	V_pf_altqs_active		 VNET(pf_altqs_active)
1696VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_inactive);
1697#define	V_pf_altqs_inactive		 VNET(pf_altqs_inactive)
1698
1699VNET_DECLARE(struct pf_rulequeue, pf_unlinked_rules);
1700#define	V_pf_unlinked_rules	VNET(pf_unlinked_rules)
1701
1702void				 pf_initialize(void);
1703void				 pf_cleanup(void);
1704
1705struct pf_mtag			*pf_get_mtag(struct mbuf *);
1706
1707extern void			 pf_calc_skip_steps(struct pf_rulequeue *);
1708#ifdef ALTQ
1709extern	void			 pf_altq_ifnet_event(struct ifnet *, int);
1710#endif
1711VNET_DECLARE(uma_zone_t,	 pf_state_z);
1712#define	V_pf_state_z		 VNET(pf_state_z)
1713VNET_DECLARE(uma_zone_t,	 pf_state_key_z);
1714#define	V_pf_state_key_z	 VNET(pf_state_key_z)
1715VNET_DECLARE(uma_zone_t,	 pf_state_scrub_z);
1716#define	V_pf_state_scrub_z	 VNET(pf_state_scrub_z)
1717
1718extern void			 pf_purge_thread(void *);
1719extern void			 pf_intr(void *);
1720extern void			 pf_purge_expired_src_nodes(void);
1721
1722extern int			 pf_unlink_state(struct pf_state *, u_int);
1723#define	PF_ENTER_LOCKED		0x00000001
1724#define	PF_RETURN_LOCKED	0x00000002
1725extern int			 pf_state_insert(struct pfi_kif *,
1726				    struct pf_state_key *,
1727				    struct pf_state_key *,
1728				    struct pf_state *);
1729extern void			 pf_free_state(struct pf_state *);
1730
1731static __inline u_int
1732pf_hashsrc(struct pf_addr *addr, sa_family_t af)
1733{
1734	u_int h;
1735
1736#define	ADDR_HASH(a)	((a) ^ ((a) >> 16))
1737
1738	switch (af) {
1739	case AF_INET:
1740		h = ADDR_HASH(addr->v4.s_addr);
1741		break;
1742	case AF_INET6:
1743		h = ADDR_HASH(addr->v6.__u6_addr.__u6_addr32[3]);
1744	default:
1745		panic("%s: unknown address family %u", __func__, af);
1746	}
1747#undef ADDR_HASH
1748
1749	return (h & V_pf_srchashmask);
1750}
1751
1752static __inline void
1753pf_ref_state(struct pf_state *s)
1754{
1755
1756	refcount_acquire(&s->refs);
1757}
1758
1759static __inline int
1760pf_release_state(struct pf_state *s)
1761{
1762
1763	if (refcount_release(&s->refs)) {
1764		pf_free_state(s);
1765		return (1);
1766	} else
1767		return (0);
1768}
1769
1770extern struct pf_state		*pf_find_state_byid(uint64_t, uint32_t);
1771extern struct pf_state		*pf_find_state_all(struct pf_state_key_cmp *,
1772				    u_int, int *);
1773struct pf_src_node		*pf_find_src_node(struct pf_addr *, struct pf_rule *,
1774				    sa_family_t, int);
1775extern void			 pf_print_state(struct pf_state *);
1776extern void			 pf_print_flags(u_int8_t);
1777extern u_int16_t		 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1778				    u_int8_t);
1779
1780VNET_DECLARE(struct ifnet *,		 sync_ifp);
1781#define	V_sync_ifp		 	 VNET(sync_ifp);
1782VNET_DECLARE(struct pf_rule,		 pf_default_rule);
1783#define	V_pf_default_rule		  VNET(pf_default_rule)
1784extern void			 pf_addrcpy(struct pf_addr *, struct pf_addr *,
1785				    u_int8_t);
1786void				pf_free_rule(struct pf_rule *);
1787
1788#ifdef INET
1789int	pf_test(int, struct ifnet *, struct mbuf **, struct inpcb *);
1790#endif /* INET */
1791
1792#ifdef INET6
1793int	pf_test6(int, struct ifnet *, struct mbuf **, struct inpcb *);
1794void	pf_poolmask(struct pf_addr *, struct pf_addr*,
1795	    struct pf_addr *, struct pf_addr *, u_int8_t);
1796void	pf_addr_inc(struct pf_addr *, sa_family_t);
1797#endif /* INET6 */
1798
1799u_int32_t	pf_new_isn(struct pf_state *);
1800void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1801	    sa_family_t);
1802void	pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1803void	pf_send_deferred_syn(struct pf_state *);
1804int	pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1805	    struct pf_addr *, sa_family_t);
1806int	pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1807	    struct pf_addr *, sa_family_t);
1808int	pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1809
1810void	pf_normalize_init(void);
1811void	pf_normalize_cleanup(void);
1812int	pf_normalize_ip(struct mbuf **, int, struct pfi_kif *, u_short *,
1813	    struct pf_pdesc *);
1814int	pf_normalize_ip6(struct mbuf **, int, struct pfi_kif *, u_short *,
1815	    struct pf_pdesc *);
1816int	pf_normalize_tcp(int, struct pfi_kif *, struct mbuf *, int, int, void *,
1817	    struct pf_pdesc *);
1818void	pf_normalize_tcp_cleanup(struct pf_state *);
1819int	pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1820	    struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1821int	pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1822	    u_short *, struct tcphdr *, struct pf_state *,
1823	    struct pf_state_peer *, struct pf_state_peer *, int *);
1824u_int32_t
1825	pf_state_expires(const struct pf_state *);
1826void	pf_purge_expired_fragments(void);
1827int	pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kif *,
1828	    int);
1829int	pf_socket_lookup(int, struct pf_pdesc *, struct mbuf *);
1830struct pf_state_key *pf_alloc_state_key(int);
1831void	pfr_initialize(void);
1832void	pfr_cleanup(void);
1833int	pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1834void	pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1835	    u_int64_t, int, int, int);
1836int	pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *, sa_family_t);
1837void	pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1838struct pfr_ktable *
1839	pfr_attach_table(struct pf_ruleset *, char *);
1840void	pfr_detach_table(struct pfr_ktable *);
1841int	pfr_clr_tables(struct pfr_table *, int *, int);
1842int	pfr_add_tables(struct pfr_table *, int, int *, int);
1843int	pfr_del_tables(struct pfr_table *, int, int *, int);
1844int	pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1845int	pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1846int	pfr_clr_tstats(struct pfr_table *, int, int *, int);
1847int	pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1848int	pfr_clr_addrs(struct pfr_table *, int *, int);
1849int	pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1850int	pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1851	    int);
1852int	pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1853	    int);
1854int	pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1855	    int *, int *, int *, int, u_int32_t);
1856int	pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1857int	pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1858int	pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1859	    int);
1860int	pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1861	    int);
1862int	pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1863int	pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1864int	pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1865int	pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1866	    int *, u_int32_t, int);
1867
1868MALLOC_DECLARE(PFI_MTYPE);
1869VNET_DECLARE(struct pfi_kif *,		 pfi_all);
1870#define	V_pfi_all	 		 VNET(pfi_all)
1871
1872void		 pfi_initialize(void);
1873void		 pfi_cleanup(void);
1874void		 pfi_kif_ref(struct pfi_kif *);
1875void		 pfi_kif_unref(struct pfi_kif *);
1876struct pfi_kif	*pfi_kif_find(const char *);
1877struct pfi_kif	*pfi_kif_attach(struct pfi_kif *, const char *);
1878int		 pfi_kif_match(struct pfi_kif *, struct pfi_kif *);
1879void		 pfi_kif_purge(void);
1880int		 pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1881		    sa_family_t);
1882int		 pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1883void		 pfi_dynaddr_remove(struct pfi_dynaddr *);
1884void		 pfi_dynaddr_copyout(struct pf_addr_wrap *);
1885void		 pfi_update_status(const char *, struct pf_status *);
1886void		 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1887int		 pfi_set_flags(const char *, int);
1888int		 pfi_clear_flags(const char *, int);
1889
1890int		 pf_match_tag(struct mbuf *, struct pf_rule *, int *, int);
1891int		 pf_tag_packet(struct mbuf *, struct pf_pdesc *, int);
1892void		 pf_qid2qname(u_int32_t, char *);
1893
1894VNET_DECLARE(struct pf_status,		 pf_status);
1895#define	V_pf_status			 VNET(pf_status)
1896
1897struct pf_limit {
1898	uma_zone_t	zone;
1899	u_int		limit;
1900};
1901VNET_DECLARE(struct pf_limit, pf_limits[PF_LIMIT_MAX]);
1902#define	V_pf_limits VNET(pf_limits)
1903
1904#endif /* _KERNEL */
1905
1906#ifdef _KERNEL
1907VNET_DECLARE(struct pf_anchor_global,		 pf_anchors);
1908#define	V_pf_anchors				 VNET(pf_anchors)
1909VNET_DECLARE(struct pf_anchor,			 pf_main_anchor);
1910#define	V_pf_main_anchor			 VNET(pf_main_anchor)
1911#define pf_main_ruleset	V_pf_main_anchor.ruleset
1912#endif
1913
1914/* these ruleset functions can be linked into userland programs (pfctl) */
1915int			 pf_get_ruleset_number(u_int8_t);
1916void			 pf_init_ruleset(struct pf_ruleset *);
1917int			 pf_anchor_setup(struct pf_rule *,
1918			    const struct pf_ruleset *, const char *);
1919int			 pf_anchor_copyout(const struct pf_ruleset *,
1920			    const struct pf_rule *, struct pfioc_rule *);
1921void			 pf_anchor_remove(struct pf_rule *);
1922void			 pf_remove_if_empty_ruleset(struct pf_ruleset *);
1923struct pf_ruleset	*pf_find_ruleset(const char *);
1924struct pf_ruleset	*pf_find_or_create_ruleset(const char *);
1925void			 pf_rs_initialize(void);
1926
1927/* The fingerprint functions can be linked into userland programs (tcpdump) */
1928int	pf_osfp_add(struct pf_osfp_ioctl *);
1929#ifdef _KERNEL
1930struct pf_osfp_enlist *
1931	pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1932	    const struct tcphdr *);
1933#endif /* _KERNEL */
1934void	pf_osfp_flush(void);
1935int	pf_osfp_get(struct pf_osfp_ioctl *);
1936int	pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1937
1938#ifdef _KERNEL
1939void			 pf_print_host(struct pf_addr *, u_int16_t, u_int8_t);
1940
1941void			 pf_step_into_anchor(int *, struct pf_ruleset **, int,
1942			    struct pf_rule **, struct pf_rule **, int *);
1943int			 pf_step_out_of_anchor(int *, struct pf_ruleset **,
1944			    int, struct pf_rule **, struct pf_rule **,
1945			    int *);
1946
1947int			 pf_map_addr(u_int8_t, struct pf_rule *,
1948			    struct pf_addr *, struct pf_addr *,
1949			    struct pf_addr *, struct pf_src_node **);
1950struct pf_rule		*pf_get_translation(struct pf_pdesc *, struct mbuf *,
1951			    int, int, struct pfi_kif *, struct pf_src_node **,
1952			    struct pf_state_key **, struct pf_state_key **,
1953			    struct pf_addr *, struct pf_addr *,
1954			    u_int16_t, u_int16_t);
1955
1956struct pf_state_key	*pf_state_key_setup(struct pf_pdesc *, struct pf_addr *,
1957			    struct pf_addr *, u_int16_t, u_int16_t);
1958struct pf_state_key	*pf_state_key_clone(struct pf_state_key *);
1959#endif /* _KERNEL */
1960
1961#endif /* _NET_PFVAR_H_ */
1962