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