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