xref: /freebsd/sys/net/pfvar.h (revision 79ac3c12a714bcd3f2354c52d948aed9575c46d6)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
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  *	$OpenBSD: pfvar.h,v 1.282 2009/01/29 15:12:28 pyr Exp $
32  *	$FreeBSD$
33  */
34 
35 #ifndef _NET_PFVAR_H_
36 #define _NET_PFVAR_H_
37 
38 #include <sys/param.h>
39 #include <sys/queue.h>
40 #include <sys/counter.h>
41 #include <sys/cpuset.h>
42 #include <sys/malloc.h>
43 #include <sys/nv.h>
44 #include <sys/refcount.h>
45 #include <sys/sdt.h>
46 #include <sys/sysctl.h>
47 #include <sys/lock.h>
48 #include <sys/rmlock.h>
49 #include <sys/tree.h>
50 #include <vm/uma.h>
51 
52 #include <net/radix.h>
53 #include <netinet/in.h>
54 #ifdef _KERNEL
55 #include <netinet/ip.h>
56 #include <netinet/tcp.h>
57 #include <netinet/udp.h>
58 #include <netinet/ip_icmp.h>
59 #include <netinet/icmp6.h>
60 #endif
61 
62 #include <netpfil/pf/pf.h>
63 #include <netpfil/pf/pf_altq.h>
64 #include <netpfil/pf/pf_mtag.h>
65 
66 #ifdef _KERNEL
67 
68 SYSCTL_DECL(_net_pf);
69 MALLOC_DECLARE(M_PFHASH);
70 
71 SDT_PROVIDER_DECLARE(pf);
72 
73 struct pfi_dynaddr {
74 	TAILQ_ENTRY(pfi_dynaddr)	 entry;
75 	struct pf_addr			 pfid_addr4;
76 	struct pf_addr			 pfid_mask4;
77 	struct pf_addr			 pfid_addr6;
78 	struct pf_addr			 pfid_mask6;
79 	struct pfr_ktable		*pfid_kt;
80 	struct pfi_kkif			*pfid_kif;
81 	int				 pfid_net;	/* mask or 128 */
82 	int				 pfid_acnt4;	/* address count IPv4 */
83 	int				 pfid_acnt6;	/* address count IPv6 */
84 	sa_family_t			 pfid_af;	/* rule af */
85 	u_int8_t			 pfid_iflags;	/* PFI_AFLAG_* */
86 };
87 
88 /*
89  * Address manipulation macros
90  */
91 #define	HTONL(x)	(x) = htonl((__uint32_t)(x))
92 #define	HTONS(x)	(x) = htons((__uint16_t)(x))
93 #define	NTOHL(x)	(x) = ntohl((__uint32_t)(x))
94 #define	NTOHS(x)	(x) = ntohs((__uint16_t)(x))
95 
96 #define	PF_NAME		"pf"
97 
98 #define	PF_HASHROW_ASSERT(h)	mtx_assert(&(h)->lock, MA_OWNED)
99 #define	PF_HASHROW_LOCK(h)	mtx_lock(&(h)->lock)
100 #define	PF_HASHROW_UNLOCK(h)	mtx_unlock(&(h)->lock)
101 
102 #define	PF_STATE_LOCK(s)						\
103 	do {								\
104 		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)];	\
105 		PF_HASHROW_LOCK(_ih);					\
106 	} while (0)
107 
108 #define	PF_STATE_UNLOCK(s)						\
109 	do {								\
110 		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH((s))];	\
111 		PF_HASHROW_UNLOCK(_ih);					\
112 	} while (0)
113 
114 #ifdef INVARIANTS
115 #define	PF_STATE_LOCK_ASSERT(s)						\
116 	do {								\
117 		struct pf_idhash *_ih = &V_pf_idhash[PF_IDHASH(s)];	\
118 		PF_HASHROW_ASSERT(_ih);					\
119 	} while (0)
120 #else /* !INVARIANTS */
121 #define	PF_STATE_LOCK_ASSERT(s)		do {} while (0)
122 #endif /* INVARIANTS */
123 
124 extern struct mtx pf_unlnkdrules_mtx;
125 #define	PF_UNLNKDRULES_LOCK()	mtx_lock(&pf_unlnkdrules_mtx)
126 #define	PF_UNLNKDRULES_UNLOCK()	mtx_unlock(&pf_unlnkdrules_mtx)
127 
128 extern struct rmlock pf_rules_lock;
129 #define	PF_RULES_RLOCK_TRACKER	struct rm_priotracker _pf_rules_tracker
130 #define	PF_RULES_RLOCK()	rm_rlock(&pf_rules_lock, &_pf_rules_tracker)
131 #define	PF_RULES_RUNLOCK()	rm_runlock(&pf_rules_lock, &_pf_rules_tracker)
132 #define	PF_RULES_WLOCK()	rm_wlock(&pf_rules_lock)
133 #define	PF_RULES_WUNLOCK()	rm_wunlock(&pf_rules_lock)
134 #define	PF_RULES_ASSERT()	rm_assert(&pf_rules_lock, RA_LOCKED)
135 #define	PF_RULES_RASSERT()	rm_assert(&pf_rules_lock, RA_RLOCKED)
136 #define	PF_RULES_WASSERT()	rm_assert(&pf_rules_lock, RA_WLOCKED)
137 
138 extern struct sx pf_end_lock;
139 
140 #define	PF_MODVER	1
141 #define	PFLOG_MODVER	1
142 #define	PFSYNC_MODVER	1
143 
144 #define	PFLOG_MINVER	1
145 #define	PFLOG_PREFVER	PFLOG_MODVER
146 #define	PFLOG_MAXVER	1
147 #define	PFSYNC_MINVER	1
148 #define	PFSYNC_PREFVER	PFSYNC_MODVER
149 #define	PFSYNC_MAXVER	1
150 
151 #ifdef INET
152 #ifndef INET6
153 #define	PF_INET_ONLY
154 #endif /* ! INET6 */
155 #endif /* INET */
156 
157 #ifdef INET6
158 #ifndef INET
159 #define	PF_INET6_ONLY
160 #endif /* ! INET */
161 #endif /* INET6 */
162 
163 #ifdef INET
164 #ifdef INET6
165 #define	PF_INET_INET6
166 #endif /* INET6 */
167 #endif /* INET */
168 
169 #else
170 
171 #define	PF_INET_INET6
172 
173 #endif /* _KERNEL */
174 
175 /* Both IPv4 and IPv6 */
176 #ifdef PF_INET_INET6
177 
178 #define PF_AEQ(a, b, c) \
179 	((c == AF_INET && (a)->addr32[0] == (b)->addr32[0]) || \
180 	(c == AF_INET6 && (a)->addr32[3] == (b)->addr32[3] && \
181 	(a)->addr32[2] == (b)->addr32[2] && \
182 	(a)->addr32[1] == (b)->addr32[1] && \
183 	(a)->addr32[0] == (b)->addr32[0])) \
184 
185 #define PF_ANEQ(a, b, c) \
186 	((c == AF_INET && (a)->addr32[0] != (b)->addr32[0]) || \
187 	(c == AF_INET6 && ((a)->addr32[0] != (b)->addr32[0] || \
188 	(a)->addr32[1] != (b)->addr32[1] || \
189 	(a)->addr32[2] != (b)->addr32[2] || \
190 	(a)->addr32[3] != (b)->addr32[3]))) \
191 
192 #define PF_AZERO(a, c) \
193 	((c == AF_INET && !(a)->addr32[0]) || \
194 	(c == AF_INET6 && !(a)->addr32[0] && !(a)->addr32[1] && \
195 	!(a)->addr32[2] && !(a)->addr32[3] )) \
196 
197 #define PF_MATCHA(n, a, m, b, f) \
198 	pf_match_addr(n, a, m, b, f)
199 
200 #define PF_ACPY(a, b, f) \
201 	pf_addrcpy(a, b, f)
202 
203 #define PF_AINC(a, f) \
204 	pf_addr_inc(a, f)
205 
206 #define PF_POOLMASK(a, b, c, d, f) \
207 	pf_poolmask(a, b, c, d, f)
208 
209 #else
210 
211 /* Just IPv6 */
212 
213 #ifdef PF_INET6_ONLY
214 
215 #define PF_AEQ(a, b, c) \
216 	((a)->addr32[3] == (b)->addr32[3] && \
217 	(a)->addr32[2] == (b)->addr32[2] && \
218 	(a)->addr32[1] == (b)->addr32[1] && \
219 	(a)->addr32[0] == (b)->addr32[0]) \
220 
221 #define PF_ANEQ(a, b, c) \
222 	((a)->addr32[3] != (b)->addr32[3] || \
223 	(a)->addr32[2] != (b)->addr32[2] || \
224 	(a)->addr32[1] != (b)->addr32[1] || \
225 	(a)->addr32[0] != (b)->addr32[0]) \
226 
227 #define PF_AZERO(a, c) \
228 	(!(a)->addr32[0] && \
229 	!(a)->addr32[1] && \
230 	!(a)->addr32[2] && \
231 	!(a)->addr32[3] ) \
232 
233 #define PF_MATCHA(n, a, m, b, f) \
234 	pf_match_addr(n, a, m, b, f)
235 
236 #define PF_ACPY(a, b, f) \
237 	pf_addrcpy(a, b, f)
238 
239 #define PF_AINC(a, f) \
240 	pf_addr_inc(a, f)
241 
242 #define PF_POOLMASK(a, b, c, d, f) \
243 	pf_poolmask(a, b, c, d, f)
244 
245 #else
246 
247 /* Just IPv4 */
248 #ifdef PF_INET_ONLY
249 
250 #define PF_AEQ(a, b, c) \
251 	((a)->addr32[0] == (b)->addr32[0])
252 
253 #define PF_ANEQ(a, b, c) \
254 	((a)->addr32[0] != (b)->addr32[0])
255 
256 #define PF_AZERO(a, c) \
257 	(!(a)->addr32[0])
258 
259 #define PF_MATCHA(n, a, m, b, f) \
260 	pf_match_addr(n, a, m, b, f)
261 
262 #define PF_ACPY(a, b, f) \
263 	(a)->v4.s_addr = (b)->v4.s_addr
264 
265 #define PF_AINC(a, f) \
266 	do { \
267 		(a)->addr32[0] = htonl(ntohl((a)->addr32[0]) + 1); \
268 	} while (0)
269 
270 #define PF_POOLMASK(a, b, c, d, f) \
271 	do { \
272 		(a)->addr32[0] = ((b)->addr32[0] & (c)->addr32[0]) | \
273 		(((c)->addr32[0] ^ 0xffffffff ) & (d)->addr32[0]); \
274 	} while (0)
275 
276 #endif /* PF_INET_ONLY */
277 #endif /* PF_INET6_ONLY */
278 #endif /* PF_INET_INET6 */
279 
280 /*
281  * XXX callers not FIB-aware in our version of pf yet.
282  * OpenBSD fixed it later it seems, 2010/05/07 13:33:16 claudio.
283  */
284 #define	PF_MISMATCHAW(aw, x, af, neg, ifp, rtid)			\
285 	(								\
286 		(((aw)->type == PF_ADDR_NOROUTE &&			\
287 		    pf_routable((x), (af), NULL, (rtid))) ||		\
288 		(((aw)->type == PF_ADDR_URPFFAILED && (ifp) != NULL &&	\
289 		    pf_routable((x), (af), (ifp), (rtid))) ||		\
290 		((aw)->type == PF_ADDR_TABLE &&				\
291 		    !pfr_match_addr((aw)->p.tbl, (x), (af))) ||		\
292 		((aw)->type == PF_ADDR_DYNIFTL &&			\
293 		    !pfi_match_addr((aw)->p.dyn, (x), (af))) ||		\
294 		((aw)->type == PF_ADDR_RANGE &&				\
295 		    !pf_match_addr_range(&(aw)->v.a.addr,		\
296 		    &(aw)->v.a.mask, (x), (af))) ||			\
297 		((aw)->type == PF_ADDR_ADDRMASK &&			\
298 		    !PF_AZERO(&(aw)->v.a.mask, (af)) &&			\
299 		    !PF_MATCHA(0, &(aw)->v.a.addr,			\
300 		    &(aw)->v.a.mask, (x), (af))))) !=			\
301 		(neg)							\
302 	)
303 
304 #define PF_ALGNMNT(off) (((off) % 2) == 0)
305 
306 #ifdef _KERNEL
307 
308 struct pf_kpooladdr {
309 	struct pf_addr_wrap		 addr;
310 	TAILQ_ENTRY(pf_kpooladdr)	 entries;
311 	char				 ifname[IFNAMSIZ];
312 	struct pfi_kkif			*kif;
313 };
314 
315 TAILQ_HEAD(pf_kpalist, pf_kpooladdr);
316 
317 struct pf_kpool {
318 	struct pf_kpalist	 list;
319 	struct pf_kpooladdr	*cur;
320 	struct pf_poolhashkey	 key;
321 	struct pf_addr		 counter;
322 	struct pf_mape_portset	 mape;
323 	int			 tblidx;
324 	u_int16_t		 proxy_port[2];
325 	u_int8_t		 opts;
326 };
327 
328 union pf_krule_ptr {
329 	struct pf_krule		*ptr;
330 	u_int32_t		 nr;
331 };
332 
333 struct pf_krule {
334 	struct pf_rule_addr	 src;
335 	struct pf_rule_addr	 dst;
336 	union pf_krule_ptr	 skip[PF_SKIP_COUNT];
337 	char			 label[PF_RULE_MAX_LABEL_COUNT][PF_RULE_LABEL_SIZE];
338 	char			 ifname[IFNAMSIZ];
339 	char			 qname[PF_QNAME_SIZE];
340 	char			 pqname[PF_QNAME_SIZE];
341 	char			 tagname[PF_TAG_NAME_SIZE];
342 	char			 match_tagname[PF_TAG_NAME_SIZE];
343 
344 	char			 overload_tblname[PF_TABLE_NAME_SIZE];
345 
346 	TAILQ_ENTRY(pf_krule)	 entries;
347 	struct pf_kpool		 rpool;
348 
349 	counter_u64_t		 evaluations;
350 	counter_u64_t		 packets[2];
351 	counter_u64_t		 bytes[2];
352 
353 	struct pfi_kkif		*kif;
354 	struct pf_kanchor	*anchor;
355 	struct pfr_ktable	*overload_tbl;
356 
357 	pf_osfp_t		 os_fingerprint;
358 
359 	int			 rtableid;
360 	u_int32_t		 timeout[PFTM_MAX];
361 	u_int32_t		 max_states;
362 	u_int32_t		 max_src_nodes;
363 	u_int32_t		 max_src_states;
364 	u_int32_t		 max_src_conn;
365 	struct {
366 		u_int32_t		limit;
367 		u_int32_t		seconds;
368 	}			 max_src_conn_rate;
369 	u_int32_t		 qid;
370 	u_int32_t		 pqid;
371 	u_int32_t		 nr;
372 	u_int32_t		 prob;
373 	uid_t			 cuid;
374 	pid_t			 cpid;
375 
376 	counter_u64_t		 states_cur;
377 	counter_u64_t		 states_tot;
378 	counter_u64_t		 src_nodes;
379 
380 	u_int16_t		 return_icmp;
381 	u_int16_t		 return_icmp6;
382 	u_int16_t		 max_mss;
383 	u_int16_t		 tag;
384 	u_int16_t		 match_tag;
385 	u_int16_t		 scrub_flags;
386 
387 	struct pf_rule_uid	 uid;
388 	struct pf_rule_gid	 gid;
389 
390 	u_int32_t		 rule_flag;
391 	uint32_t		 rule_ref;
392 	u_int8_t		 action;
393 	u_int8_t		 direction;
394 	u_int8_t		 log;
395 	u_int8_t		 logif;
396 	u_int8_t		 quick;
397 	u_int8_t		 ifnot;
398 	u_int8_t		 match_tag_not;
399 	u_int8_t		 natpass;
400 
401 	u_int8_t		 keep_state;
402 	sa_family_t		 af;
403 	u_int8_t		 proto;
404 	u_int8_t		 type;
405 	u_int8_t		 code;
406 	u_int8_t		 flags;
407 	u_int8_t		 flagset;
408 	u_int8_t		 min_ttl;
409 	u_int8_t		 allow_opts;
410 	u_int8_t		 rt;
411 	u_int8_t		 return_ttl;
412 	u_int8_t		 tos;
413 	u_int8_t		 set_tos;
414 	u_int8_t		 anchor_relative;
415 	u_int8_t		 anchor_wildcard;
416 
417 	u_int8_t		 flush;
418 	u_int8_t		 prio;
419 	u_int8_t		 set_prio[2];
420 
421 	struct {
422 		struct pf_addr		addr;
423 		u_int16_t		port;
424 	}			divert;
425 };
426 
427 struct pf_ksrc_node {
428 	LIST_ENTRY(pf_ksrc_node) entry;
429 	struct pf_addr	 addr;
430 	struct pf_addr	 raddr;
431 	union pf_krule_ptr rule;
432 	struct pfi_kkif	*kif;
433 	counter_u64_t	 bytes[2];
434 	counter_u64_t	 packets[2];
435 	u_int32_t	 states;
436 	u_int32_t	 conn;
437 	struct pf_threshold	conn_rate;
438 	u_int32_t	 creation;
439 	u_int32_t	 expire;
440 	sa_family_t	 af;
441 	u_int8_t	 ruletype;
442 };
443 #endif
444 
445 struct pf_state_scrub {
446 	struct timeval	pfss_last;	/* time received last packet	*/
447 	u_int32_t	pfss_tsecr;	/* last echoed timestamp	*/
448 	u_int32_t	pfss_tsval;	/* largest timestamp		*/
449 	u_int32_t	pfss_tsval0;	/* original timestamp		*/
450 	u_int16_t	pfss_flags;
451 #define PFSS_TIMESTAMP	0x0001		/* modulate timestamp		*/
452 #define PFSS_PAWS	0x0010		/* stricter PAWS checks		*/
453 #define PFSS_PAWS_IDLED	0x0020		/* was idle too long.  no PAWS	*/
454 #define PFSS_DATA_TS	0x0040		/* timestamp on data packets	*/
455 #define PFSS_DATA_NOTS	0x0080		/* no timestamp on data packets	*/
456 	u_int8_t	pfss_ttl;	/* stashed TTL			*/
457 	u_int8_t	pad;
458 	u_int32_t	pfss_ts_mod;	/* timestamp modulation		*/
459 };
460 
461 struct pf_state_host {
462 	struct pf_addr	addr;
463 	u_int16_t	port;
464 	u_int16_t	pad;
465 };
466 
467 struct pf_state_peer {
468 	struct pf_state_scrub	*scrub;	/* state is scrubbed		*/
469 	u_int32_t	seqlo;		/* Max sequence number sent	*/
470 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
471 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
472 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
473 	u_int16_t	mss;		/* Maximum segment size option	*/
474 	u_int8_t	state;		/* active state level		*/
475 	u_int8_t	wscale;		/* window scaling factor	*/
476 	u_int8_t	tcp_est;	/* Did we reach TCPS_ESTABLISHED */
477 	u_int8_t	pad[1];
478 };
479 
480 /* Keep synced with struct pf_state_key. */
481 struct pf_state_key_cmp {
482 	struct pf_addr	 addr[2];
483 	u_int16_t	 port[2];
484 	sa_family_t	 af;
485 	u_int8_t	 proto;
486 	u_int8_t	 pad[2];
487 };
488 
489 struct pf_state_key {
490 	struct pf_addr	 addr[2];
491 	u_int16_t	 port[2];
492 	sa_family_t	 af;
493 	u_int8_t	 proto;
494 	u_int8_t	 pad[2];
495 
496 	LIST_ENTRY(pf_state_key) entry;
497 	TAILQ_HEAD(, pf_state)	 states[2];
498 };
499 
500 /* Keep synced with struct pf_state. */
501 struct pf_state_cmp {
502 	u_int64_t		 id;
503 	u_int32_t		 creatorid;
504 	u_int8_t		 direction;
505 	u_int8_t		 pad[3];
506 };
507 
508 #define	PFSTATE_ALLOWOPTS	0x01
509 #define	PFSTATE_SLOPPY		0x02
510 /*  was	PFSTATE_PFLOW		0x04 */
511 #define	PFSTATE_NOSYNC		0x08
512 #define	PFSTATE_ACK		0x10
513 #define	PFSTATE_SETPRIO		0x0200
514 #define	PFSTATE_SETMASK   (PFSTATE_SETPRIO)
515 
516 #ifdef _KERNEL
517 struct pf_state {
518 	u_int64_t		 id;
519 	u_int32_t		 creatorid;
520 	u_int8_t		 direction;
521 	u_int8_t		 pad[3];
522 
523 	u_int			 refs;
524 	TAILQ_ENTRY(pf_state)	 sync_list;
525 	TAILQ_ENTRY(pf_state)	 key_list[2];
526 	LIST_ENTRY(pf_state)	 entry;
527 	struct pf_state_peer	 src;
528 	struct pf_state_peer	 dst;
529 	union pf_krule_ptr	 rule;
530 	union pf_krule_ptr	 anchor;
531 	union pf_krule_ptr	 nat_rule;
532 	struct pf_addr		 rt_addr;
533 	struct pf_state_key	*key[2];	/* addresses stack and wire  */
534 	struct pfi_kkif		*kif;
535 	struct pfi_kkif		*orig_kif;	/* The real kif, even if we're a floating state (i.e. if == V_pfi_all). */
536 	struct pfi_kkif		*rt_kif;
537 	struct pf_ksrc_node	*src_node;
538 	struct pf_ksrc_node	*nat_src_node;
539 	counter_u64_t		 packets[2];
540 	counter_u64_t		 bytes[2];
541 	u_int32_t		 creation;
542 	u_int32_t	 	 expire;
543 	u_int32_t		 pfsync_time;
544 	u_int16_t		 tag;
545 	u_int8_t		 log;
546 	u_int8_t		 state_flags;
547 	u_int8_t		 timeout;
548 	u_int8_t		 sync_state; /* PFSYNC_S_x */
549 
550 	/* XXX */
551 	u_int8_t		 sync_updates;
552 	u_int8_t		_tail[3];
553 };
554 #endif
555 
556 /*
557  * Unified state structures for pulling states out of the kernel
558  * used by pfsync(4) and the pf(4) ioctl.
559  */
560 struct pfsync_state_scrub {
561 	u_int16_t	pfss_flags;
562 	u_int8_t	pfss_ttl;	/* stashed TTL		*/
563 #define PFSYNC_SCRUB_FLAG_VALID		0x01
564 	u_int8_t	scrub_flag;
565 	u_int32_t	pfss_ts_mod;	/* timestamp modulation	*/
566 } __packed;
567 
568 struct pfsync_state_peer {
569 	struct pfsync_state_scrub scrub;	/* state is scrubbed	*/
570 	u_int32_t	seqlo;		/* Max sequence number sent	*/
571 	u_int32_t	seqhi;		/* Max the other end ACKd + win	*/
572 	u_int32_t	seqdiff;	/* Sequence number modulator	*/
573 	u_int16_t	max_win;	/* largest window (pre scaling)	*/
574 	u_int16_t	mss;		/* Maximum segment size option	*/
575 	u_int8_t	state;		/* active state level		*/
576 	u_int8_t	wscale;		/* window scaling factor	*/
577 	u_int8_t	pad[6];
578 } __packed;
579 
580 struct pfsync_state_key {
581 	struct pf_addr	 addr[2];
582 	u_int16_t	 port[2];
583 };
584 
585 struct pfsync_state {
586 	u_int64_t	 id;
587 	char		 ifname[IFNAMSIZ];
588 	struct pfsync_state_key	key[2];
589 	struct pfsync_state_peer src;
590 	struct pfsync_state_peer dst;
591 	struct pf_addr	 rt_addr;
592 	u_int32_t	 rule;
593 	u_int32_t	 anchor;
594 	u_int32_t	 nat_rule;
595 	u_int32_t	 creation;
596 	u_int32_t	 expire;
597 	u_int32_t	 packets[2][2];
598 	u_int32_t	 bytes[2][2];
599 	u_int32_t	 creatorid;
600 	sa_family_t	 af;
601 	u_int8_t	 proto;
602 	u_int8_t	 direction;
603 	u_int8_t	 __spare[2];
604 	u_int8_t	 log;
605 	u_int8_t	 state_flags;
606 	u_int8_t	 timeout;
607 	u_int8_t	 sync_flags;
608 	u_int8_t	 updates;
609 } __packed;
610 
611 #ifdef _KERNEL
612 /* pfsync */
613 typedef int		pfsync_state_import_t(struct pfsync_state *, u_int8_t);
614 typedef	void		pfsync_insert_state_t(struct pf_state *);
615 typedef	void		pfsync_update_state_t(struct pf_state *);
616 typedef	void		pfsync_delete_state_t(struct pf_state *);
617 typedef void		pfsync_clear_states_t(u_int32_t, const char *);
618 typedef int		pfsync_defer_t(struct pf_state *, struct mbuf *);
619 typedef void		pfsync_detach_ifnet_t(struct ifnet *);
620 
621 VNET_DECLARE(pfsync_state_import_t *, pfsync_state_import_ptr);
622 #define V_pfsync_state_import_ptr	VNET(pfsync_state_import_ptr)
623 VNET_DECLARE(pfsync_insert_state_t *, pfsync_insert_state_ptr);
624 #define V_pfsync_insert_state_ptr	VNET(pfsync_insert_state_ptr)
625 VNET_DECLARE(pfsync_update_state_t *, pfsync_update_state_ptr);
626 #define V_pfsync_update_state_ptr	VNET(pfsync_update_state_ptr)
627 VNET_DECLARE(pfsync_delete_state_t *, pfsync_delete_state_ptr);
628 #define V_pfsync_delete_state_ptr	VNET(pfsync_delete_state_ptr)
629 VNET_DECLARE(pfsync_clear_states_t *, pfsync_clear_states_ptr);
630 #define V_pfsync_clear_states_ptr	VNET(pfsync_clear_states_ptr)
631 VNET_DECLARE(pfsync_defer_t *, pfsync_defer_ptr);
632 #define V_pfsync_defer_ptr		VNET(pfsync_defer_ptr)
633 extern pfsync_detach_ifnet_t	*pfsync_detach_ifnet_ptr;
634 
635 void			pfsync_state_export(struct pfsync_state *,
636 			    struct pf_state *);
637 
638 /* pflog */
639 struct pf_kruleset;
640 struct pf_pdesc;
641 typedef int pflog_packet_t(struct pfi_kkif *, struct mbuf *, sa_family_t,
642     u_int8_t, u_int8_t, struct pf_krule *, struct pf_krule *,
643     struct pf_kruleset *, struct pf_pdesc *, int);
644 extern pflog_packet_t		*pflog_packet_ptr;
645 
646 #endif /* _KERNEL */
647 
648 #define	PFSYNC_FLAG_SRCNODE	0x04
649 #define	PFSYNC_FLAG_NATSRCNODE	0x08
650 
651 /* for copies to/from network byte order */
652 /* ioctl interface also uses network byte order */
653 #define pf_state_peer_hton(s,d) do {		\
654 	(d)->seqlo = htonl((s)->seqlo);		\
655 	(d)->seqhi = htonl((s)->seqhi);		\
656 	(d)->seqdiff = htonl((s)->seqdiff);	\
657 	(d)->max_win = htons((s)->max_win);	\
658 	(d)->mss = htons((s)->mss);		\
659 	(d)->state = (s)->state;		\
660 	(d)->wscale = (s)->wscale;		\
661 	if ((s)->scrub) {						\
662 		(d)->scrub.pfss_flags = 				\
663 		    htons((s)->scrub->pfss_flags & PFSS_TIMESTAMP);	\
664 		(d)->scrub.pfss_ttl = (s)->scrub->pfss_ttl;		\
665 		(d)->scrub.pfss_ts_mod = htonl((s)->scrub->pfss_ts_mod);\
666 		(d)->scrub.scrub_flag = PFSYNC_SCRUB_FLAG_VALID;	\
667 	}								\
668 } while (0)
669 
670 #define pf_state_peer_ntoh(s,d) do {		\
671 	(d)->seqlo = ntohl((s)->seqlo);		\
672 	(d)->seqhi = ntohl((s)->seqhi);		\
673 	(d)->seqdiff = ntohl((s)->seqdiff);	\
674 	(d)->max_win = ntohs((s)->max_win);	\
675 	(d)->mss = ntohs((s)->mss);		\
676 	(d)->state = (s)->state;		\
677 	(d)->wscale = (s)->wscale;		\
678 	if ((s)->scrub.scrub_flag == PFSYNC_SCRUB_FLAG_VALID && 	\
679 	    (d)->scrub != NULL) {					\
680 		(d)->scrub->pfss_flags =				\
681 		    ntohs((s)->scrub.pfss_flags) & PFSS_TIMESTAMP;	\
682 		(d)->scrub->pfss_ttl = (s)->scrub.pfss_ttl;		\
683 		(d)->scrub->pfss_ts_mod = ntohl((s)->scrub.pfss_ts_mod);\
684 	}								\
685 } while (0)
686 
687 #define pf_state_counter_hton(s,d) do {				\
688 	d[0] = htonl((s>>32)&0xffffffff);			\
689 	d[1] = htonl(s&0xffffffff);				\
690 } while (0)
691 
692 #define pf_state_counter_from_pfsync(s)				\
693 	(((u_int64_t)(s[0])<<32) | (u_int64_t)(s[1]))
694 
695 #define pf_state_counter_ntoh(s,d) do {				\
696 	d = ntohl(s[0]);					\
697 	d = d<<32;						\
698 	d += ntohl(s[1]);					\
699 } while (0)
700 
701 TAILQ_HEAD(pf_krulequeue, pf_krule);
702 
703 struct pf_kanchor;
704 
705 struct pf_kruleset {
706 	struct {
707 		struct pf_krulequeue	 queues[2];
708 		struct {
709 			struct pf_krulequeue	*ptr;
710 			struct pf_krule		**ptr_array;
711 			u_int32_t		 rcount;
712 			u_int32_t		 ticket;
713 			int			 open;
714 		}			 active, inactive;
715 	}			 rules[PF_RULESET_MAX];
716 	struct pf_kanchor	*anchor;
717 	u_int32_t		 tticket;
718 	int			 tables;
719 	int			 topen;
720 };
721 
722 RB_HEAD(pf_kanchor_global, pf_kanchor);
723 RB_HEAD(pf_kanchor_node, pf_kanchor);
724 struct pf_kanchor {
725 	RB_ENTRY(pf_kanchor)	 entry_global;
726 	RB_ENTRY(pf_kanchor)	 entry_node;
727 	struct pf_kanchor	*parent;
728 	struct pf_kanchor_node	 children;
729 	char			 name[PF_ANCHOR_NAME_SIZE];
730 	char			 path[MAXPATHLEN];
731 	struct pf_kruleset	 ruleset;
732 	int			 refcnt;	/* anchor rules */
733 	int			 match;	/* XXX: used for pfctl black magic */
734 };
735 RB_PROTOTYPE(pf_kanchor_global, pf_kanchor, entry_global, pf_anchor_compare);
736 RB_PROTOTYPE(pf_kanchor_node, pf_kanchor, entry_node, pf_kanchor_compare);
737 
738 #define PF_RESERVED_ANCHOR	"_pf"
739 
740 #define PFR_TFLAG_PERSIST	0x00000001
741 #define PFR_TFLAG_CONST		0x00000002
742 #define PFR_TFLAG_ACTIVE	0x00000004
743 #define PFR_TFLAG_INACTIVE	0x00000008
744 #define PFR_TFLAG_REFERENCED	0x00000010
745 #define PFR_TFLAG_REFDANCHOR	0x00000020
746 #define PFR_TFLAG_COUNTERS	0x00000040
747 /* Adjust masks below when adding flags. */
748 #define PFR_TFLAG_USRMASK	(PFR_TFLAG_PERSIST	| \
749 				 PFR_TFLAG_CONST	| \
750 				 PFR_TFLAG_COUNTERS)
751 #define PFR_TFLAG_SETMASK	(PFR_TFLAG_ACTIVE	| \
752 				 PFR_TFLAG_INACTIVE	| \
753 				 PFR_TFLAG_REFERENCED	| \
754 				 PFR_TFLAG_REFDANCHOR)
755 #define PFR_TFLAG_ALLMASK	(PFR_TFLAG_PERSIST	| \
756 				 PFR_TFLAG_CONST	| \
757 				 PFR_TFLAG_ACTIVE	| \
758 				 PFR_TFLAG_INACTIVE	| \
759 				 PFR_TFLAG_REFERENCED	| \
760 				 PFR_TFLAG_REFDANCHOR	| \
761 				 PFR_TFLAG_COUNTERS)
762 
763 struct pf_kanchor_stackframe;
764 
765 struct pfr_table {
766 	char			 pfrt_anchor[MAXPATHLEN];
767 	char			 pfrt_name[PF_TABLE_NAME_SIZE];
768 	u_int32_t		 pfrt_flags;
769 	u_int8_t		 pfrt_fback;
770 };
771 
772 enum { PFR_FB_NONE, PFR_FB_MATCH, PFR_FB_ADDED, PFR_FB_DELETED,
773 	PFR_FB_CHANGED, PFR_FB_CLEARED, PFR_FB_DUPLICATE,
774 	PFR_FB_NOTMATCH, PFR_FB_CONFLICT, PFR_FB_NOCOUNT, PFR_FB_MAX };
775 
776 struct pfr_addr {
777 	union {
778 		struct in_addr	 _pfra_ip4addr;
779 		struct in6_addr	 _pfra_ip6addr;
780 	}		 pfra_u;
781 	u_int8_t	 pfra_af;
782 	u_int8_t	 pfra_net;
783 	u_int8_t	 pfra_not;
784 	u_int8_t	 pfra_fback;
785 };
786 #define	pfra_ip4addr	pfra_u._pfra_ip4addr
787 #define	pfra_ip6addr	pfra_u._pfra_ip6addr
788 
789 enum { PFR_DIR_IN, PFR_DIR_OUT, PFR_DIR_MAX };
790 enum { PFR_OP_BLOCK, PFR_OP_PASS, PFR_OP_ADDR_MAX, PFR_OP_TABLE_MAX };
791 enum { PFR_TYPE_PACKETS, PFR_TYPE_BYTES, PFR_TYPE_MAX };
792 #define	PFR_NUM_COUNTERS	(PFR_DIR_MAX * PFR_OP_ADDR_MAX * PFR_TYPE_MAX)
793 #define PFR_OP_XPASS	PFR_OP_ADDR_MAX
794 
795 struct pfr_astats {
796 	struct pfr_addr	 pfras_a;
797 	u_int64_t	 pfras_packets[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
798 	u_int64_t	 pfras_bytes[PFR_DIR_MAX][PFR_OP_ADDR_MAX];
799 	long		 pfras_tzero;
800 };
801 
802 enum { PFR_REFCNT_RULE, PFR_REFCNT_ANCHOR, PFR_REFCNT_MAX };
803 
804 struct pfr_tstats {
805 	struct pfr_table pfrts_t;
806 	u_int64_t	 pfrts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
807 	u_int64_t	 pfrts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
808 	u_int64_t	 pfrts_match;
809 	u_int64_t	 pfrts_nomatch;
810 	long		 pfrts_tzero;
811 	int		 pfrts_cnt;
812 	int		 pfrts_refcnt[PFR_REFCNT_MAX];
813 };
814 
815 struct pfr_ktstats {
816 	struct pfr_table pfrts_t;
817 	counter_u64_t	 pfrkts_packets[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
818 	counter_u64_t	 pfrkts_bytes[PFR_DIR_MAX][PFR_OP_TABLE_MAX];
819 	counter_u64_t	 pfrkts_match;
820 	counter_u64_t	 pfrkts_nomatch;
821 	long		 pfrkts_tzero;
822 	int		 pfrkts_cnt;
823 	int		 pfrkts_refcnt[PFR_REFCNT_MAX];
824 };
825 #define	pfrts_name	pfrts_t.pfrt_name
826 #define pfrts_flags	pfrts_t.pfrt_flags
827 
828 #ifndef _SOCKADDR_UNION_DEFINED
829 #define	_SOCKADDR_UNION_DEFINED
830 union sockaddr_union {
831 	struct sockaddr		sa;
832 	struct sockaddr_in	sin;
833 	struct sockaddr_in6	sin6;
834 };
835 #endif /* _SOCKADDR_UNION_DEFINED */
836 
837 struct pfr_kcounters {
838 	counter_u64_t		 pfrkc_counters;
839 	long			 pfrkc_tzero;
840 };
841 #define	pfr_kentry_counter(kc, dir, op, t)		\
842 	((kc)->pfrkc_counters +				\
843 	    (dir) * PFR_OP_ADDR_MAX * PFR_TYPE_MAX + (op) * PFR_TYPE_MAX + (t))
844 
845 #ifdef _KERNEL
846 SLIST_HEAD(pfr_kentryworkq, pfr_kentry);
847 struct pfr_kentry {
848 	struct radix_node	 pfrke_node[2];
849 	union sockaddr_union	 pfrke_sa;
850 	SLIST_ENTRY(pfr_kentry)	 pfrke_workq;
851 	struct pfr_kcounters	 pfrke_counters;
852 	u_int8_t		 pfrke_af;
853 	u_int8_t		 pfrke_net;
854 	u_int8_t		 pfrke_not;
855 	u_int8_t		 pfrke_mark;
856 };
857 
858 SLIST_HEAD(pfr_ktableworkq, pfr_ktable);
859 RB_HEAD(pfr_ktablehead, pfr_ktable);
860 struct pfr_ktable {
861 	struct pfr_ktstats	 pfrkt_kts;
862 	RB_ENTRY(pfr_ktable)	 pfrkt_tree;
863 	SLIST_ENTRY(pfr_ktable)	 pfrkt_workq;
864 	struct radix_node_head	*pfrkt_ip4;
865 	struct radix_node_head	*pfrkt_ip6;
866 	struct pfr_ktable	*pfrkt_shadow;
867 	struct pfr_ktable	*pfrkt_root;
868 	struct pf_kruleset	*pfrkt_rs;
869 	long			 pfrkt_larg;
870 	int			 pfrkt_nflags;
871 };
872 #define pfrkt_t		pfrkt_kts.pfrts_t
873 #define pfrkt_name	pfrkt_t.pfrt_name
874 #define pfrkt_anchor	pfrkt_t.pfrt_anchor
875 #define pfrkt_ruleset	pfrkt_t.pfrt_ruleset
876 #define pfrkt_flags	pfrkt_t.pfrt_flags
877 #define pfrkt_cnt	pfrkt_kts.pfrkts_cnt
878 #define pfrkt_refcnt	pfrkt_kts.pfrkts_refcnt
879 #define pfrkt_packets	pfrkt_kts.pfrkts_packets
880 #define pfrkt_bytes	pfrkt_kts.pfrkts_bytes
881 #define pfrkt_match	pfrkt_kts.pfrkts_match
882 #define pfrkt_nomatch	pfrkt_kts.pfrkts_nomatch
883 #define pfrkt_tzero	pfrkt_kts.pfrkts_tzero
884 #endif
885 
886 #ifdef _KERNEL
887 struct pfi_kkif {
888 	char				 pfik_name[IFNAMSIZ];
889 	union {
890 		RB_ENTRY(pfi_kkif)	 _pfik_tree;
891 		LIST_ENTRY(pfi_kkif)	 _pfik_list;
892 	} _pfik_glue;
893 #define	pfik_tree	_pfik_glue._pfik_tree
894 #define	pfik_list	_pfik_glue._pfik_list
895 	counter_u64_t			 pfik_packets[2][2][2];
896 	counter_u64_t			 pfik_bytes[2][2][2];
897 	u_int32_t			 pfik_tzero;
898 	u_int				 pfik_flags;
899 	struct ifnet			*pfik_ifp;
900 	struct ifg_group		*pfik_group;
901 	u_int				 pfik_rulerefs;
902 	TAILQ_HEAD(, pfi_dynaddr)	 pfik_dynaddrs;
903 };
904 #endif
905 
906 #define	PFI_IFLAG_REFS		0x0001	/* has state references */
907 #define PFI_IFLAG_SKIP		0x0100	/* skip filtering on interface */
908 
909 #ifdef _KERNEL
910 struct pf_pdesc {
911 	struct {
912 		int	 done;
913 		uid_t	 uid;
914 		gid_t	 gid;
915 	}		 lookup;
916 	u_int64_t	 tot_len;	/* Make Mickey money */
917 	union pf_headers {
918 		struct tcphdr		tcp;
919 		struct udphdr		udp;
920 		struct icmp		icmp;
921 #ifdef INET6
922 		struct icmp6_hdr	icmp6;
923 #endif /* INET6 */
924 		char any[0];
925 	} hdr;
926 
927 	struct pf_krule	*nat_rule;	/* nat/rdr rule applied to packet */
928 	struct pf_addr	*src;		/* src address */
929 	struct pf_addr	*dst;		/* dst address */
930 	u_int16_t *sport;
931 	u_int16_t *dport;
932 	struct pf_mtag	*pf_mtag;
933 
934 	u_int32_t	 p_len;		/* total length of payload */
935 
936 	u_int16_t	*ip_sum;
937 	u_int16_t	*proto_sum;
938 	u_int16_t	 flags;		/* Let SCRUB trigger behavior in
939 					 * state code. Easier than tags */
940 #define PFDESC_TCP_NORM	0x0001		/* TCP shall be statefully scrubbed */
941 #define PFDESC_IP_REAS	0x0002		/* IP frags would've been reassembled */
942 	sa_family_t	 af;
943 	u_int8_t	 proto;
944 	u_int8_t	 tos;
945 	u_int8_t	 dir;		/* direction */
946 	u_int8_t	 sidx;		/* key index for source */
947 	u_int8_t	 didx;		/* key index for destination */
948 };
949 #endif
950 
951 /* flags for RDR options */
952 #define PF_DPORT_RANGE	0x01		/* Dest port uses range */
953 #define PF_RPORT_RANGE	0x02		/* RDR'ed port uses range */
954 
955 /* UDP state enumeration */
956 #define PFUDPS_NO_TRAFFIC	0
957 #define PFUDPS_SINGLE		1
958 #define PFUDPS_MULTIPLE		2
959 
960 #define PFUDPS_NSTATES		3	/* number of state levels */
961 
962 #define PFUDPS_NAMES { \
963 	"NO_TRAFFIC", \
964 	"SINGLE", \
965 	"MULTIPLE", \
966 	NULL \
967 }
968 
969 /* Other protocol state enumeration */
970 #define PFOTHERS_NO_TRAFFIC	0
971 #define PFOTHERS_SINGLE		1
972 #define PFOTHERS_MULTIPLE	2
973 
974 #define PFOTHERS_NSTATES	3	/* number of state levels */
975 
976 #define PFOTHERS_NAMES { \
977 	"NO_TRAFFIC", \
978 	"SINGLE", \
979 	"MULTIPLE", \
980 	NULL \
981 }
982 
983 #define ACTION_SET(a, x) \
984 	do { \
985 		if ((a) != NULL) \
986 			*(a) = (x); \
987 	} while (0)
988 
989 #define REASON_SET(a, x) \
990 	do { \
991 		if ((a) != NULL) \
992 			*(a) = (x); \
993 		if (x < PFRES_MAX) \
994 			counter_u64_add(V_pf_status.counters[x], 1); \
995 	} while (0)
996 
997 struct pf_kstatus {
998 	counter_u64_t	counters[PFRES_MAX]; /* reason for passing/dropping */
999 	counter_u64_t	lcounters[LCNT_MAX]; /* limit counters */
1000 	counter_u64_t	fcounters[FCNT_MAX]; /* state operation counters */
1001 	counter_u64_t	scounters[SCNT_MAX]; /* src_node operation counters */
1002 	uint32_t	states;
1003 	uint32_t	src_nodes;
1004 	uint32_t	running;
1005 	uint32_t	since;
1006 	uint32_t	debug;
1007 	uint32_t	hostid;
1008 	char		ifname[IFNAMSIZ];
1009 	uint8_t		pf_chksum[PF_MD5_DIGEST_LENGTH];
1010 	bool		keep_counters;
1011 };
1012 
1013 struct pf_divert {
1014 	union {
1015 		struct in_addr	ipv4;
1016 		struct in6_addr	ipv6;
1017 	}		addr;
1018 	u_int16_t	port;
1019 };
1020 
1021 #define PFFRAG_FRENT_HIWAT	5000	/* Number of fragment entries */
1022 #define PFR_KENTRY_HIWAT	200000	/* Number of table entries */
1023 
1024 /*
1025  * Limit the length of the fragment queue traversal.  Remember
1026  * search entry points based on the fragment offset.
1027  */
1028 #define PF_FRAG_ENTRY_POINTS		16
1029 
1030 /*
1031  * The number of entries in the fragment queue must be limited
1032  * to avoid DoS by linear seaching.  Instead of a global limit,
1033  * use a limit per entry point.  For large packets these sum up.
1034  */
1035 #define PF_FRAG_ENTRY_LIMIT		64
1036 
1037 /*
1038  * ioctl parameter structures
1039  */
1040 
1041 struct pfioc_pooladdr {
1042 	u_int32_t		 action;
1043 	u_int32_t		 ticket;
1044 	u_int32_t		 nr;
1045 	u_int32_t		 r_num;
1046 	u_int8_t		 r_action;
1047 	u_int8_t		 r_last;
1048 	u_int8_t		 af;
1049 	char			 anchor[MAXPATHLEN];
1050 	struct pf_pooladdr	 addr;
1051 };
1052 
1053 struct pfioc_rule {
1054 	u_int32_t	 action;
1055 	u_int32_t	 ticket;
1056 	u_int32_t	 pool_ticket;
1057 	u_int32_t	 nr;
1058 	char		 anchor[MAXPATHLEN];
1059 	char		 anchor_call[MAXPATHLEN];
1060 	struct pf_rule	 rule;
1061 };
1062 
1063 struct pfioc_natlook {
1064 	struct pf_addr	 saddr;
1065 	struct pf_addr	 daddr;
1066 	struct pf_addr	 rsaddr;
1067 	struct pf_addr	 rdaddr;
1068 	u_int16_t	 sport;
1069 	u_int16_t	 dport;
1070 	u_int16_t	 rsport;
1071 	u_int16_t	 rdport;
1072 	sa_family_t	 af;
1073 	u_int8_t	 proto;
1074 	u_int8_t	 direction;
1075 };
1076 
1077 struct pfioc_state {
1078 	struct pfsync_state	state;
1079 };
1080 
1081 struct pfioc_src_node_kill {
1082 	sa_family_t psnk_af;
1083 	struct pf_rule_addr psnk_src;
1084 	struct pf_rule_addr psnk_dst;
1085 	u_int		    psnk_killed;
1086 };
1087 
1088 #ifdef _KERNEL
1089 struct pf_kstate_kill {
1090 	struct pf_state_cmp	psk_pfcmp;
1091 	sa_family_t		psk_af;
1092 	int			psk_proto;
1093 	struct pf_rule_addr	psk_src;
1094 	struct pf_rule_addr	psk_dst;
1095 	struct pf_rule_addr	psk_rt_addr;
1096 	char			psk_ifname[IFNAMSIZ];
1097 	char			psk_label[PF_RULE_LABEL_SIZE];
1098 	u_int			psk_killed;
1099 	bool			psk_kill_match;
1100 };
1101 #endif
1102 
1103 struct pfioc_state_kill {
1104 	struct pf_state_cmp	psk_pfcmp;
1105 	sa_family_t		psk_af;
1106 	int			psk_proto;
1107 	struct pf_rule_addr	psk_src;
1108 	struct pf_rule_addr	psk_dst;
1109 	char			psk_ifname[IFNAMSIZ];
1110 	char			psk_label[PF_RULE_LABEL_SIZE];
1111 	u_int			psk_killed;
1112 };
1113 
1114 struct pfioc_states {
1115 	int	ps_len;
1116 	union {
1117 		caddr_t			 psu_buf;
1118 		struct pfsync_state	*psu_states;
1119 	} ps_u;
1120 #define ps_buf		ps_u.psu_buf
1121 #define ps_states	ps_u.psu_states
1122 };
1123 
1124 struct pfioc_src_nodes {
1125 	int	psn_len;
1126 	union {
1127 		caddr_t		 psu_buf;
1128 		struct pf_src_node	*psu_src_nodes;
1129 	} psn_u;
1130 #define psn_buf		psn_u.psu_buf
1131 #define psn_src_nodes	psn_u.psu_src_nodes
1132 };
1133 
1134 struct pfioc_if {
1135 	char		 ifname[IFNAMSIZ];
1136 };
1137 
1138 struct pfioc_tm {
1139 	int		 timeout;
1140 	int		 seconds;
1141 };
1142 
1143 struct pfioc_limit {
1144 	int		 index;
1145 	unsigned	 limit;
1146 };
1147 
1148 struct pfioc_altq_v0 {
1149 	u_int32_t	 action;
1150 	u_int32_t	 ticket;
1151 	u_int32_t	 nr;
1152 	struct pf_altq_v0 altq;
1153 };
1154 
1155 struct pfioc_altq_v1 {
1156 	u_int32_t	 action;
1157 	u_int32_t	 ticket;
1158 	u_int32_t	 nr;
1159 	/*
1160 	 * Placed here so code that only uses the above parameters can be
1161 	 * written entirely in terms of the v0 or v1 type.
1162 	 */
1163 	u_int32_t	 version;
1164 	struct pf_altq_v1 altq;
1165 };
1166 
1167 /*
1168  * Latest version of struct pfioc_altq_vX.  This must move in lock-step with
1169  * the latest version of struct pf_altq_vX as it has that struct as a
1170  * member.
1171  */
1172 #define PFIOC_ALTQ_VERSION	PF_ALTQ_VERSION
1173 
1174 struct pfioc_qstats_v0 {
1175 	u_int32_t	 ticket;
1176 	u_int32_t	 nr;
1177 	void		*buf;
1178 	int		 nbytes;
1179 	u_int8_t	 scheduler;
1180 };
1181 
1182 struct pfioc_qstats_v1 {
1183 	u_int32_t	 ticket;
1184 	u_int32_t	 nr;
1185 	void		*buf;
1186 	int		 nbytes;
1187 	u_int8_t	 scheduler;
1188 	/*
1189 	 * Placed here so code that only uses the above parameters can be
1190 	 * written entirely in terms of the v0 or v1 type.
1191 	 */
1192 	u_int32_t	 version;  /* Requested version of stats struct */
1193 };
1194 
1195 /* Latest version of struct pfioc_qstats_vX */
1196 #define PFIOC_QSTATS_VERSION	1
1197 
1198 struct pfioc_ruleset {
1199 	u_int32_t	 nr;
1200 	char		 path[MAXPATHLEN];
1201 	char		 name[PF_ANCHOR_NAME_SIZE];
1202 };
1203 
1204 #define PF_RULESET_ALTQ		(PF_RULESET_MAX)
1205 #define PF_RULESET_TABLE	(PF_RULESET_MAX+1)
1206 struct pfioc_trans {
1207 	int		 size;	/* number of elements */
1208 	int		 esize; /* size of each element in bytes */
1209 	struct pfioc_trans_e {
1210 		int		rs_num;
1211 		char		anchor[MAXPATHLEN];
1212 		u_int32_t	ticket;
1213 	}		*array;
1214 };
1215 
1216 #define PFR_FLAG_ATOMIC		0x00000001	/* unused */
1217 #define PFR_FLAG_DUMMY		0x00000002
1218 #define PFR_FLAG_FEEDBACK	0x00000004
1219 #define PFR_FLAG_CLSTATS	0x00000008
1220 #define PFR_FLAG_ADDRSTOO	0x00000010
1221 #define PFR_FLAG_REPLACE	0x00000020
1222 #define PFR_FLAG_ALLRSETS	0x00000040
1223 #define PFR_FLAG_ALLMASK	0x0000007F
1224 #ifdef _KERNEL
1225 #define PFR_FLAG_USERIOCTL	0x10000000
1226 #endif
1227 
1228 struct pfioc_table {
1229 	struct pfr_table	 pfrio_table;
1230 	void			*pfrio_buffer;
1231 	int			 pfrio_esize;
1232 	int			 pfrio_size;
1233 	int			 pfrio_size2;
1234 	int			 pfrio_nadd;
1235 	int			 pfrio_ndel;
1236 	int			 pfrio_nchange;
1237 	int			 pfrio_flags;
1238 	u_int32_t		 pfrio_ticket;
1239 };
1240 #define	pfrio_exists	pfrio_nadd
1241 #define	pfrio_nzero	pfrio_nadd
1242 #define	pfrio_nmatch	pfrio_nadd
1243 #define pfrio_naddr	pfrio_size2
1244 #define pfrio_setflag	pfrio_size2
1245 #define pfrio_clrflag	pfrio_nadd
1246 
1247 struct pfioc_iface {
1248 	char	 pfiio_name[IFNAMSIZ];
1249 	void	*pfiio_buffer;
1250 	int	 pfiio_esize;
1251 	int	 pfiio_size;
1252 	int	 pfiio_nzero;
1253 	int	 pfiio_flags;
1254 };
1255 
1256 /*
1257  * ioctl operations
1258  */
1259 
1260 #define DIOCSTART	_IO  ('D',  1)
1261 #define DIOCSTOP	_IO  ('D',  2)
1262 #define DIOCADDRULE	_IOWR('D',  4, struct pfioc_rule)
1263 #define DIOCADDRULENV	_IOWR('D',  4, struct pfioc_nv)
1264 #define DIOCGETRULES	_IOWR('D',  6, struct pfioc_rule)
1265 #define DIOCGETRULE	_IOWR('D',  7, struct pfioc_rule)
1266 #define DIOCGETRULENV	_IOWR('D',  7, struct pfioc_nv)
1267 /* XXX cut 8 - 17 */
1268 #define DIOCCLRSTATES	_IOWR('D', 18, struct pfioc_state_kill)
1269 #define DIOCCLRSTATESNV	_IOWR('D', 18, struct pfioc_nv)
1270 #define DIOCGETSTATE	_IOWR('D', 19, struct pfioc_state)
1271 #define DIOCGETSTATENV	_IOWR('D', 19, struct pfioc_nv)
1272 #define DIOCSETSTATUSIF _IOWR('D', 20, struct pfioc_if)
1273 #define DIOCGETSTATUS	_IOWR('D', 21, struct pf_status)
1274 #define DIOCCLRSTATUS	_IO  ('D', 22)
1275 #define DIOCNATLOOK	_IOWR('D', 23, struct pfioc_natlook)
1276 #define DIOCSETDEBUG	_IOWR('D', 24, u_int32_t)
1277 #define DIOCGETSTATES	_IOWR('D', 25, struct pfioc_states)
1278 #define DIOCGETSTATESNV	_IOWR('D', 25, struct pfioc_nv)
1279 #define DIOCCHANGERULE	_IOWR('D', 26, struct pfioc_rule)
1280 /* XXX cut 26 - 28 */
1281 #define DIOCSETTIMEOUT	_IOWR('D', 29, struct pfioc_tm)
1282 #define DIOCGETTIMEOUT	_IOWR('D', 30, struct pfioc_tm)
1283 #define DIOCADDSTATE	_IOWR('D', 37, struct pfioc_state)
1284 #define DIOCCLRRULECTRS	_IO  ('D', 38)
1285 #define DIOCGETLIMIT	_IOWR('D', 39, struct pfioc_limit)
1286 #define DIOCSETLIMIT	_IOWR('D', 40, struct pfioc_limit)
1287 #define DIOCKILLSTATES	_IOWR('D', 41, struct pfioc_state_kill)
1288 #define DIOCKILLSTATESNV	_IOWR('D', 41, struct pfioc_nv)
1289 #define DIOCSTARTALTQ	_IO  ('D', 42)
1290 #define DIOCSTOPALTQ	_IO  ('D', 43)
1291 #define DIOCADDALTQV0	_IOWR('D', 45, struct pfioc_altq_v0)
1292 #define DIOCADDALTQV1	_IOWR('D', 45, struct pfioc_altq_v1)
1293 #define DIOCGETALTQSV0	_IOWR('D', 47, struct pfioc_altq_v0)
1294 #define DIOCGETALTQSV1	_IOWR('D', 47, struct pfioc_altq_v1)
1295 #define DIOCGETALTQV0	_IOWR('D', 48, struct pfioc_altq_v0)
1296 #define DIOCGETALTQV1	_IOWR('D', 48, struct pfioc_altq_v1)
1297 #define DIOCCHANGEALTQV0 _IOWR('D', 49, struct pfioc_altq_v0)
1298 #define DIOCCHANGEALTQV1 _IOWR('D', 49, struct pfioc_altq_v1)
1299 #define DIOCGETQSTATSV0	_IOWR('D', 50, struct pfioc_qstats_v0)
1300 #define DIOCGETQSTATSV1	_IOWR('D', 50, struct pfioc_qstats_v1)
1301 #define DIOCBEGINADDRS	_IOWR('D', 51, struct pfioc_pooladdr)
1302 #define DIOCADDADDR	_IOWR('D', 52, struct pfioc_pooladdr)
1303 #define DIOCGETADDRS	_IOWR('D', 53, struct pfioc_pooladdr)
1304 #define DIOCGETADDR	_IOWR('D', 54, struct pfioc_pooladdr)
1305 #define DIOCCHANGEADDR	_IOWR('D', 55, struct pfioc_pooladdr)
1306 /* XXX cut 55 - 57 */
1307 #define	DIOCGETRULESETS	_IOWR('D', 58, struct pfioc_ruleset)
1308 #define	DIOCGETRULESET	_IOWR('D', 59, struct pfioc_ruleset)
1309 #define	DIOCRCLRTABLES	_IOWR('D', 60, struct pfioc_table)
1310 #define	DIOCRADDTABLES	_IOWR('D', 61, struct pfioc_table)
1311 #define	DIOCRDELTABLES	_IOWR('D', 62, struct pfioc_table)
1312 #define	DIOCRGETTABLES	_IOWR('D', 63, struct pfioc_table)
1313 #define	DIOCRGETTSTATS	_IOWR('D', 64, struct pfioc_table)
1314 #define DIOCRCLRTSTATS	_IOWR('D', 65, struct pfioc_table)
1315 #define	DIOCRCLRADDRS	_IOWR('D', 66, struct pfioc_table)
1316 #define	DIOCRADDADDRS	_IOWR('D', 67, struct pfioc_table)
1317 #define	DIOCRDELADDRS	_IOWR('D', 68, struct pfioc_table)
1318 #define	DIOCRSETADDRS	_IOWR('D', 69, struct pfioc_table)
1319 #define	DIOCRGETADDRS	_IOWR('D', 70, struct pfioc_table)
1320 #define	DIOCRGETASTATS	_IOWR('D', 71, struct pfioc_table)
1321 #define	DIOCRCLRASTATS	_IOWR('D', 72, struct pfioc_table)
1322 #define	DIOCRTSTADDRS	_IOWR('D', 73, struct pfioc_table)
1323 #define	DIOCRSETTFLAGS	_IOWR('D', 74, struct pfioc_table)
1324 #define	DIOCRINADEFINE	_IOWR('D', 77, struct pfioc_table)
1325 #define	DIOCOSFPFLUSH	_IO('D', 78)
1326 #define	DIOCOSFPADD	_IOWR('D', 79, struct pf_osfp_ioctl)
1327 #define	DIOCOSFPGET	_IOWR('D', 80, struct pf_osfp_ioctl)
1328 #define	DIOCXBEGIN	_IOWR('D', 81, struct pfioc_trans)
1329 #define	DIOCXCOMMIT	_IOWR('D', 82, struct pfioc_trans)
1330 #define	DIOCXROLLBACK	_IOWR('D', 83, struct pfioc_trans)
1331 #define	DIOCGETSRCNODES	_IOWR('D', 84, struct pfioc_src_nodes)
1332 #define	DIOCCLRSRCNODES	_IO('D', 85)
1333 #define	DIOCSETHOSTID	_IOWR('D', 86, u_int32_t)
1334 #define	DIOCIGETIFACES	_IOWR('D', 87, struct pfioc_iface)
1335 #define	DIOCSETIFFLAG	_IOWR('D', 89, struct pfioc_iface)
1336 #define	DIOCCLRIFFLAG	_IOWR('D', 90, struct pfioc_iface)
1337 #define	DIOCKILLSRCNODES	_IOWR('D', 91, struct pfioc_src_node_kill)
1338 #define	DIOCKEEPCOUNTERS	_IOWR('D', 92, struct pfioc_nv)
1339 
1340 struct pf_ifspeed_v0 {
1341 	char			ifname[IFNAMSIZ];
1342 	u_int32_t		baudrate;
1343 };
1344 
1345 struct pf_ifspeed_v1 {
1346 	char			ifname[IFNAMSIZ];
1347 	u_int32_t		baudrate32;
1348 	/* layout identical to struct pf_ifspeed_v0 up to this point */
1349 	u_int64_t		baudrate;
1350 };
1351 
1352 /* Latest version of struct pf_ifspeed_vX */
1353 #define PF_IFSPEED_VERSION	1
1354 
1355 #define	DIOCGIFSPEEDV0	_IOWR('D', 92, struct pf_ifspeed_v0)
1356 #define	DIOCGIFSPEEDV1	_IOWR('D', 92, struct pf_ifspeed_v1)
1357 
1358 /*
1359  * Compatibility and convenience macros
1360  */
1361 #ifndef _KERNEL
1362 #ifdef PFIOC_USE_LATEST
1363 /*
1364  * Maintaining in-tree consumers of the ioctl interface is easier when that
1365  * code can be written in terms old names that refer to the latest interface
1366  * version as that reduces the required changes in the consumers to those
1367  * that are functionally necessary to accommodate a new interface version.
1368  */
1369 #define	pfioc_altq	__CONCAT(pfioc_altq_v, PFIOC_ALTQ_VERSION)
1370 #define	pfioc_qstats	__CONCAT(pfioc_qstats_v, PFIOC_QSTATS_VERSION)
1371 #define	pf_ifspeed	__CONCAT(pf_ifspeed_v, PF_IFSPEED_VERSION)
1372 
1373 #define	DIOCADDALTQ	__CONCAT(DIOCADDALTQV, PFIOC_ALTQ_VERSION)
1374 #define	DIOCGETALTQS	__CONCAT(DIOCGETALTQSV, PFIOC_ALTQ_VERSION)
1375 #define	DIOCGETALTQ	__CONCAT(DIOCGETALTQV, PFIOC_ALTQ_VERSION)
1376 #define	DIOCCHANGEALTQ	__CONCAT(DIOCCHANGEALTQV, PFIOC_ALTQ_VERSION)
1377 #define	DIOCGETQSTATS	__CONCAT(DIOCGETQSTATSV, PFIOC_QSTATS_VERSION)
1378 #define	DIOCGIFSPEED	__CONCAT(DIOCGIFSPEEDV, PF_IFSPEED_VERSION)
1379 #else
1380 /*
1381  * When building out-of-tree code that is written for the old interface,
1382  * such as may exist in ports for example, resolve the old struct tags and
1383  * ioctl command names to the v0 versions.
1384  */
1385 #define	pfioc_altq	__CONCAT(pfioc_altq_v, 0)
1386 #define	pfioc_qstats	__CONCAT(pfioc_qstats_v, 0)
1387 #define	pf_ifspeed	__CONCAT(pf_ifspeed_v, 0)
1388 
1389 #define	DIOCADDALTQ	__CONCAT(DIOCADDALTQV, 0)
1390 #define	DIOCGETALTQS	__CONCAT(DIOCGETALTQSV, 0)
1391 #define	DIOCGETALTQ	__CONCAT(DIOCGETALTQV, 0)
1392 #define	DIOCCHANGEALTQ	__CONCAT(DIOCCHANGEALTQV, 0)
1393 #define	DIOCGETQSTATS	__CONCAT(DIOCGETQSTATSV, 0)
1394 #define	DIOCGIFSPEED	__CONCAT(DIOCGIFSPEEDV, 0)
1395 #endif /* PFIOC_USE_LATEST */
1396 #endif /* _KERNEL */
1397 
1398 #ifdef _KERNEL
1399 LIST_HEAD(pf_ksrc_node_list, pf_ksrc_node);
1400 struct pf_srchash {
1401 	struct pf_ksrc_node_list		nodes;
1402 	struct mtx			lock;
1403 };
1404 
1405 struct pf_keyhash {
1406 	LIST_HEAD(, pf_state_key)	keys;
1407 	struct mtx			lock;
1408 };
1409 
1410 struct pf_idhash {
1411 	LIST_HEAD(, pf_state)		states;
1412 	struct mtx			lock;
1413 };
1414 
1415 extern u_long		pf_hashmask;
1416 extern u_long		pf_srchashmask;
1417 #define	PF_HASHSIZ	(131072)
1418 #define	PF_SRCHASHSIZ	(PF_HASHSIZ/4)
1419 VNET_DECLARE(struct pf_keyhash *, pf_keyhash);
1420 VNET_DECLARE(struct pf_idhash *, pf_idhash);
1421 #define V_pf_keyhash	VNET(pf_keyhash)
1422 #define	V_pf_idhash	VNET(pf_idhash)
1423 VNET_DECLARE(struct pf_srchash *, pf_srchash);
1424 #define	V_pf_srchash	VNET(pf_srchash)
1425 
1426 #define PF_IDHASH(s)	(be64toh((s)->id) % (pf_hashmask + 1))
1427 
1428 VNET_DECLARE(void *, pf_swi_cookie);
1429 #define V_pf_swi_cookie	VNET(pf_swi_cookie)
1430 VNET_DECLARE(struct intr_event *, pf_swi_ie);
1431 #define	V_pf_swi_ie	VNET(pf_swi_ie)
1432 
1433 VNET_DECLARE(uint64_t, pf_stateid[MAXCPU]);
1434 #define	V_pf_stateid	VNET(pf_stateid)
1435 
1436 TAILQ_HEAD(pf_altqqueue, pf_altq);
1437 VNET_DECLARE(struct pf_altqqueue,	 pf_altqs[4]);
1438 #define	V_pf_altqs			 VNET(pf_altqs)
1439 VNET_DECLARE(struct pf_kpalist,		 pf_pabuf);
1440 #define	V_pf_pabuf			 VNET(pf_pabuf)
1441 
1442 VNET_DECLARE(u_int32_t,			 ticket_altqs_active);
1443 #define	V_ticket_altqs_active		 VNET(ticket_altqs_active)
1444 VNET_DECLARE(u_int32_t,			 ticket_altqs_inactive);
1445 #define	V_ticket_altqs_inactive		 VNET(ticket_altqs_inactive)
1446 VNET_DECLARE(int,			 altqs_inactive_open);
1447 #define	V_altqs_inactive_open		 VNET(altqs_inactive_open)
1448 VNET_DECLARE(u_int32_t,			 ticket_pabuf);
1449 #define	V_ticket_pabuf			 VNET(ticket_pabuf)
1450 VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_active);
1451 #define	V_pf_altqs_active		 VNET(pf_altqs_active)
1452 VNET_DECLARE(struct pf_altqqueue *,	 pf_altq_ifs_active);
1453 #define	V_pf_altq_ifs_active		 VNET(pf_altq_ifs_active)
1454 VNET_DECLARE(struct pf_altqqueue *,	 pf_altqs_inactive);
1455 #define	V_pf_altqs_inactive		 VNET(pf_altqs_inactive)
1456 VNET_DECLARE(struct pf_altqqueue *,	 pf_altq_ifs_inactive);
1457 #define	V_pf_altq_ifs_inactive		 VNET(pf_altq_ifs_inactive)
1458 
1459 VNET_DECLARE(struct pf_krulequeue, pf_unlinked_rules);
1460 #define	V_pf_unlinked_rules	VNET(pf_unlinked_rules)
1461 
1462 void				 pf_initialize(void);
1463 void				 pf_mtag_initialize(void);
1464 void				 pf_mtag_cleanup(void);
1465 void				 pf_cleanup(void);
1466 
1467 struct pf_mtag			*pf_get_mtag(struct mbuf *);
1468 
1469 extern void			 pf_calc_skip_steps(struct pf_krulequeue *);
1470 #ifdef ALTQ
1471 extern	void			 pf_altq_ifnet_event(struct ifnet *, int);
1472 #endif
1473 VNET_DECLARE(uma_zone_t,	 pf_state_z);
1474 #define	V_pf_state_z		 VNET(pf_state_z)
1475 VNET_DECLARE(uma_zone_t,	 pf_state_key_z);
1476 #define	V_pf_state_key_z	 VNET(pf_state_key_z)
1477 VNET_DECLARE(uma_zone_t,	 pf_state_scrub_z);
1478 #define	V_pf_state_scrub_z	 VNET(pf_state_scrub_z)
1479 
1480 extern void			 pf_purge_thread(void *);
1481 extern void			 pf_unload_vnet_purge(void);
1482 extern void			 pf_intr(void *);
1483 extern void			 pf_purge_expired_src_nodes(void);
1484 
1485 extern int			 pf_unlink_state(struct pf_state *, u_int);
1486 #define	PF_ENTER_LOCKED		0x00000001
1487 #define	PF_RETURN_LOCKED	0x00000002
1488 extern int			 pf_state_insert(struct pfi_kkif *,
1489 				    struct pfi_kkif *,
1490 				    struct pf_state_key *,
1491 				    struct pf_state_key *,
1492 				    struct pf_state *);
1493 extern void			 pf_free_state(struct pf_state *);
1494 
1495 static __inline void
1496 pf_ref_state(struct pf_state *s)
1497 {
1498 
1499 	refcount_acquire(&s->refs);
1500 }
1501 
1502 static __inline int
1503 pf_release_state(struct pf_state *s)
1504 {
1505 
1506 	if (refcount_release(&s->refs)) {
1507 		pf_free_state(s);
1508 		return (1);
1509 	} else
1510 		return (0);
1511 }
1512 
1513 extern struct pf_state		*pf_find_state_byid(uint64_t, uint32_t);
1514 extern struct pf_state		*pf_find_state_all(struct pf_state_key_cmp *,
1515 				    u_int, int *);
1516 extern struct pf_ksrc_node	*pf_find_src_node(struct pf_addr *,
1517 				    struct pf_krule *, sa_family_t, int);
1518 extern void			 pf_unlink_src_node(struct pf_ksrc_node *);
1519 extern u_int			 pf_free_src_nodes(struct pf_ksrc_node_list *);
1520 extern void			 pf_print_state(struct pf_state *);
1521 extern void			 pf_print_flags(u_int8_t);
1522 extern u_int16_t		 pf_cksum_fixup(u_int16_t, u_int16_t, u_int16_t,
1523 				    u_int8_t);
1524 extern u_int16_t		 pf_proto_cksum_fixup(struct mbuf *, u_int16_t,
1525 				    u_int16_t, u_int16_t, u_int8_t);
1526 
1527 VNET_DECLARE(struct ifnet *,		 sync_ifp);
1528 #define	V_sync_ifp		 	 VNET(sync_ifp);
1529 VNET_DECLARE(struct pf_krule,		 pf_default_rule);
1530 #define	V_pf_default_rule		  VNET(pf_default_rule)
1531 extern void			 pf_addrcpy(struct pf_addr *, struct pf_addr *,
1532 				    u_int8_t);
1533 void				pf_free_rule(struct pf_krule *);
1534 
1535 #ifdef INET
1536 int	pf_test(int, int, struct ifnet *, struct mbuf **, struct inpcb *);
1537 int	pf_normalize_ip(struct mbuf **, int, struct pfi_kkif *, u_short *,
1538 	    struct pf_pdesc *);
1539 #endif /* INET */
1540 
1541 #ifdef INET6
1542 int	pf_test6(int, int, struct ifnet *, struct mbuf **, struct inpcb *);
1543 int	pf_normalize_ip6(struct mbuf **, int, struct pfi_kkif *, u_short *,
1544 	    struct pf_pdesc *);
1545 void	pf_poolmask(struct pf_addr *, struct pf_addr*,
1546 	    struct pf_addr *, struct pf_addr *, u_int8_t);
1547 void	pf_addr_inc(struct pf_addr *, sa_family_t);
1548 int	pf_refragment6(struct ifnet *, struct mbuf **, struct m_tag *);
1549 #endif /* INET6 */
1550 
1551 u_int32_t	pf_new_isn(struct pf_state *);
1552 void   *pf_pull_hdr(struct mbuf *, int, void *, int, u_short *, u_short *,
1553 	    sa_family_t);
1554 void	pf_change_a(void *, u_int16_t *, u_int32_t, u_int8_t);
1555 void	pf_change_proto_a(struct mbuf *, void *, u_int16_t *, u_int32_t,
1556 	    u_int8_t);
1557 void	pf_change_tcp_a(struct mbuf *, void *, u_int16_t *, u_int32_t);
1558 void	pf_patch_16_unaligned(struct mbuf *, u_int16_t *, void *, u_int16_t,
1559 	    bool, u_int8_t);
1560 void	pf_patch_32_unaligned(struct mbuf *, u_int16_t *, void *, u_int32_t,
1561     bool, u_int8_t);
1562 void	pf_send_deferred_syn(struct pf_state *);
1563 int	pf_match_addr(u_int8_t, struct pf_addr *, struct pf_addr *,
1564 	    struct pf_addr *, sa_family_t);
1565 int	pf_match_addr_range(struct pf_addr *, struct pf_addr *,
1566 	    struct pf_addr *, sa_family_t);
1567 int	pf_match_port(u_int8_t, u_int16_t, u_int16_t, u_int16_t);
1568 
1569 void	pf_normalize_init(void);
1570 void	pf_normalize_cleanup(void);
1571 int	pf_normalize_tcp(int, struct pfi_kkif *, struct mbuf *, int, int, void *,
1572 	    struct pf_pdesc *);
1573 void	pf_normalize_tcp_cleanup(struct pf_state *);
1574 int	pf_normalize_tcp_init(struct mbuf *, int, struct pf_pdesc *,
1575 	    struct tcphdr *, struct pf_state_peer *, struct pf_state_peer *);
1576 int	pf_normalize_tcp_stateful(struct mbuf *, int, struct pf_pdesc *,
1577 	    u_short *, struct tcphdr *, struct pf_state *,
1578 	    struct pf_state_peer *, struct pf_state_peer *, int *);
1579 u_int32_t
1580 	pf_state_expires(const struct pf_state *);
1581 void	pf_purge_expired_fragments(void);
1582 void	pf_purge_fragments(uint32_t);
1583 int	pf_routable(struct pf_addr *addr, sa_family_t af, struct pfi_kkif *,
1584 	    int);
1585 int	pf_socket_lookup(int, struct pf_pdesc *, struct mbuf *);
1586 struct pf_state_key *pf_alloc_state_key(int);
1587 void	pfr_initialize(void);
1588 void	pfr_cleanup(void);
1589 int	pfr_match_addr(struct pfr_ktable *, struct pf_addr *, sa_family_t);
1590 void	pfr_update_stats(struct pfr_ktable *, struct pf_addr *, sa_family_t,
1591 	    u_int64_t, int, int, int);
1592 int	pfr_pool_get(struct pfr_ktable *, int *, struct pf_addr *, sa_family_t);
1593 void	pfr_dynaddr_update(struct pfr_ktable *, struct pfi_dynaddr *);
1594 struct pfr_ktable *
1595 	pfr_attach_table(struct pf_kruleset *, char *);
1596 void	pfr_detach_table(struct pfr_ktable *);
1597 int	pfr_clr_tables(struct pfr_table *, int *, int);
1598 int	pfr_add_tables(struct pfr_table *, int, int *, int);
1599 int	pfr_del_tables(struct pfr_table *, int, int *, int);
1600 int	pfr_table_count(struct pfr_table *, int);
1601 int	pfr_get_tables(struct pfr_table *, struct pfr_table *, int *, int);
1602 int	pfr_get_tstats(struct pfr_table *, struct pfr_tstats *, int *, int);
1603 int	pfr_clr_tstats(struct pfr_table *, int, int *, int);
1604 int	pfr_set_tflags(struct pfr_table *, int, int, int, int *, int *, int);
1605 int	pfr_clr_addrs(struct pfr_table *, int *, int);
1606 int	pfr_insert_kentry(struct pfr_ktable *, struct pfr_addr *, long);
1607 int	pfr_add_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1608 	    int);
1609 int	pfr_del_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1610 	    int);
1611 int	pfr_set_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1612 	    int *, int *, int *, int, u_int32_t);
1613 int	pfr_get_addrs(struct pfr_table *, struct pfr_addr *, int *, int);
1614 int	pfr_get_astats(struct pfr_table *, struct pfr_astats *, int *, int);
1615 int	pfr_clr_astats(struct pfr_table *, struct pfr_addr *, int, int *,
1616 	    int);
1617 int	pfr_tst_addrs(struct pfr_table *, struct pfr_addr *, int, int *,
1618 	    int);
1619 int	pfr_ina_begin(struct pfr_table *, u_int32_t *, int *, int);
1620 int	pfr_ina_rollback(struct pfr_table *, u_int32_t, int *, int);
1621 int	pfr_ina_commit(struct pfr_table *, u_int32_t, int *, int *, int);
1622 int	pfr_ina_define(struct pfr_table *, struct pfr_addr *, int, int *,
1623 	    int *, u_int32_t, int);
1624 
1625 MALLOC_DECLARE(PFI_MTYPE);
1626 VNET_DECLARE(struct pfi_kkif *,		 pfi_all);
1627 #define	V_pfi_all	 		 VNET(pfi_all)
1628 
1629 void		 pfi_initialize(void);
1630 void		 pfi_initialize_vnet(void);
1631 void		 pfi_cleanup(void);
1632 void		 pfi_cleanup_vnet(void);
1633 void		 pfi_kkif_ref(struct pfi_kkif *);
1634 void		 pfi_kkif_unref(struct pfi_kkif *);
1635 struct pfi_kkif	*pfi_kkif_find(const char *);
1636 struct pfi_kkif	*pfi_kkif_attach(struct pfi_kkif *, const char *);
1637 int		 pfi_kkif_match(struct pfi_kkif *, struct pfi_kkif *);
1638 void		 pfi_kkif_purge(void);
1639 int		 pfi_match_addr(struct pfi_dynaddr *, struct pf_addr *,
1640 		    sa_family_t);
1641 int		 pfi_dynaddr_setup(struct pf_addr_wrap *, sa_family_t);
1642 void		 pfi_dynaddr_remove(struct pfi_dynaddr *);
1643 void		 pfi_dynaddr_copyout(struct pf_addr_wrap *);
1644 void		 pfi_update_status(const char *, struct pf_status *);
1645 void		 pfi_get_ifaces(const char *, struct pfi_kif *, int *);
1646 int		 pfi_set_flags(const char *, int);
1647 int		 pfi_clear_flags(const char *, int);
1648 
1649 int		 pf_match_tag(struct mbuf *, struct pf_krule *, int *, int);
1650 int		 pf_tag_packet(struct mbuf *, struct pf_pdesc *, int);
1651 int		 pf_addr_cmp(struct pf_addr *, struct pf_addr *,
1652 		    sa_family_t);
1653 void		 pf_qid2qname(u_int32_t, char *);
1654 
1655 VNET_DECLARE(struct pf_kstatus, pf_status);
1656 #define	V_pf_status	VNET(pf_status)
1657 
1658 struct pf_limit {
1659 	uma_zone_t	zone;
1660 	u_int		limit;
1661 };
1662 VNET_DECLARE(struct pf_limit, pf_limits[PF_LIMIT_MAX]);
1663 #define	V_pf_limits VNET(pf_limits)
1664 
1665 #endif /* _KERNEL */
1666 
1667 #ifdef _KERNEL
1668 VNET_DECLARE(struct pf_kanchor_global,		 pf_anchors);
1669 #define	V_pf_anchors				 VNET(pf_anchors)
1670 VNET_DECLARE(struct pf_kanchor,			 pf_main_anchor);
1671 #define	V_pf_main_anchor			 VNET(pf_main_anchor)
1672 #define pf_main_ruleset	V_pf_main_anchor.ruleset
1673 
1674 void			 pf_init_kruleset(struct pf_kruleset *);
1675 int			 pf_kanchor_setup(struct pf_krule *,
1676 			    const struct pf_kruleset *, const char *);
1677 int			 pf_kanchor_nvcopyout(const struct pf_kruleset *,
1678 			    const struct pf_krule *, nvlist_t *);
1679 int			 pf_kanchor_copyout(const struct pf_kruleset *,
1680 			    const struct pf_krule *, struct pfioc_rule *);
1681 void			 pf_kanchor_remove(struct pf_krule *);
1682 void			 pf_remove_if_empty_kruleset(struct pf_kruleset *);
1683 struct pf_kruleset	*pf_find_kruleset(const char *);
1684 struct pf_kruleset	*pf_find_or_create_kruleset(const char *);
1685 void			 pf_rs_initialize(void);
1686 
1687 void			 pf_krule_free(struct pf_krule *);
1688 #endif
1689 
1690 /* The fingerprint functions can be linked into userland programs (tcpdump) */
1691 int	pf_osfp_add(struct pf_osfp_ioctl *);
1692 #ifdef _KERNEL
1693 struct pf_osfp_enlist *
1694 	pf_osfp_fingerprint(struct pf_pdesc *, struct mbuf *, int,
1695 	    const struct tcphdr *);
1696 #endif /* _KERNEL */
1697 void	pf_osfp_flush(void);
1698 int	pf_osfp_get(struct pf_osfp_ioctl *);
1699 int	pf_osfp_match(struct pf_osfp_enlist *, pf_osfp_t);
1700 
1701 #ifdef _KERNEL
1702 void			 pf_print_host(struct pf_addr *, u_int16_t, u_int8_t);
1703 
1704 void			 pf_step_into_anchor(struct pf_kanchor_stackframe *, int *,
1705 			    struct pf_kruleset **, int, struct pf_krule **,
1706 			    struct pf_krule **, int *);
1707 int			 pf_step_out_of_anchor(struct pf_kanchor_stackframe *, int *,
1708 			    struct pf_kruleset **, int, struct pf_krule **,
1709 			    struct pf_krule **, int *);
1710 
1711 int			 pf_map_addr(u_int8_t, struct pf_krule *,
1712 			    struct pf_addr *, struct pf_addr *,
1713 			    struct pf_addr *, struct pf_ksrc_node **);
1714 struct pf_krule		*pf_get_translation(struct pf_pdesc *, struct mbuf *,
1715 			    int, int, struct pfi_kkif *, struct pf_ksrc_node **,
1716 			    struct pf_state_key **, struct pf_state_key **,
1717 			    struct pf_addr *, struct pf_addr *,
1718 			    uint16_t, uint16_t, struct pf_kanchor_stackframe *);
1719 
1720 struct pf_state_key	*pf_state_key_setup(struct pf_pdesc *, struct pf_addr *,
1721 			    struct pf_addr *, u_int16_t, u_int16_t);
1722 struct pf_state_key	*pf_state_key_clone(struct pf_state_key *);
1723 
1724 struct pfi_kkif		*pf_kkif_create(int);
1725 void			 pf_kkif_free(struct pfi_kkif *);
1726 void			 pf_kkif_zero(struct pfi_kkif *);
1727 #endif /* _KERNEL */
1728 
1729 #endif /* _NET_PFVAR_H_ */
1730