1/* $NetBSD: pfctl_optimize.c,v 1.8 2018/02/04 08:44:36 mrg Exp $ */ 2/* $OpenBSD: pfctl_optimize.c,v 1.13 2006/10/31 14:17:45 mcbride Exp $ */ 3 4/* 5 * Copyright (c) 2004 Mike Frantzen <frantzen@openbsd.org> 6 * 7 * Permission to use, copy, modify, and distribute this software for any 8 * purpose with or without fee is hereby granted, provided that the above 9 * copyright notice and this permission notice appear in all copies. 10 * 11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 18 */ 19 20#include <sys/types.h> 21#include <sys/ioctl.h> 22#include <sys/socket.h> 23 24#include <net/if.h> 25#include <net/pfvar.h> 26 27#include <netinet/in.h> 28#include <arpa/inet.h> 29 30#include <assert.h> 31#include <ctype.h> 32#include <err.h> 33#include <errno.h> 34#include <stddef.h> 35#include <stdio.h> 36#include <stdlib.h> 37#include <string.h> 38 39#include "pfctl_parser.h" 40#include "pfctl.h" 41 42/* The size at which a table becomes faster than individual rules */ 43#define TABLE_THRESHOLD 6 44 45 46/* #define OPT_DEBUG 1 */ 47#ifdef OPT_DEBUG 48# define DEBUG(str, v...) \ 49 printf("%s: " str "\n", __FUNCTION__ , ## v) 50#else 51# define DEBUG(str, v...) ((void)0) 52#endif 53 54 55/* 56 * A container that lets us sort a superblock to optimize the skip step jumps 57 */ 58struct pf_skip_step { 59 int ps_count; /* number of items */ 60 TAILQ_HEAD( , pf_opt_rule) ps_rules; 61 TAILQ_ENTRY(pf_skip_step) ps_entry; 62}; 63 64 65/* 66 * A superblock is a block of adjacent rules of similar action. If there 67 * are five PASS rules in a row, they all become members of a superblock. 68 * Once we have a superblock, we are free to re-order any rules within it 69 * in order to improve performance; if a packet is passed, it doesn't matter 70 * who passed it. 71 */ 72struct superblock { 73 TAILQ_HEAD( , pf_opt_rule) sb_rules; 74 TAILQ_ENTRY(superblock) sb_entry; 75 struct superblock *sb_profiled_block; 76 TAILQ_HEAD(skiplist, pf_skip_step) sb_skipsteps[PF_SKIP_COUNT]; 77}; 78TAILQ_HEAD(superblocks, superblock); 79 80 81/* 82 * Description of the PF rule structure. 83 */ 84enum { 85 BARRIER, /* the presence of the field puts the rule in it's own block */ 86 BREAK, /* the field may not differ between rules in a superblock */ 87 NOMERGE, /* the field may not differ between rules when combined */ 88 COMBINED, /* the field may itself be combined with other rules */ 89 DC, /* we just don't care about the field */ 90 NEVER}; /* we should never see this field set?!? */ 91struct pf_rule_field { 92 const char *prf_name; 93 int prf_type; 94 size_t prf_offset; 95 size_t prf_size; 96} pf_rule_desc[] = { 97#define PF_RULE_FIELD(field, ty) \ 98 {#field, \ 99 ty, \ 100 offsetof(struct pf_rule, field), \ 101 sizeof(((struct pf_rule *)0)->field)} 102 103 104 /* 105 * The presence of these fields in a rule put the rule in it's own 106 * superblock. Thus it will not be optimized. It also prevents the 107 * rule from being re-ordered at all. 108 */ 109 PF_RULE_FIELD(label, BARRIER), 110 PF_RULE_FIELD(prob, BARRIER), 111 PF_RULE_FIELD(max_states, BARRIER), 112 PF_RULE_FIELD(max_src_nodes, BARRIER), 113 PF_RULE_FIELD(max_src_states, BARRIER), 114 PF_RULE_FIELD(max_src_conn, BARRIER), 115 PF_RULE_FIELD(max_src_conn_rate, BARRIER), 116 PF_RULE_FIELD(anchor, BARRIER), /* for now */ 117 118 /* 119 * These fields must be the same between all rules in the same superblock. 120 * These rules are allowed to be re-ordered but only among like rules. 121 * For instance we can re-order all 'tag "foo"' rules because they have the 122 * same tag. But we can not re-order between a 'tag "foo"' and a 123 * 'tag "bar"' since that would change the meaning of the ruleset. 124 */ 125 PF_RULE_FIELD(tagname, BREAK), 126 PF_RULE_FIELD(keep_state, BREAK), 127 PF_RULE_FIELD(qname, BREAK), 128 PF_RULE_FIELD(pqname, BREAK), 129 PF_RULE_FIELD(rt, BREAK), 130 PF_RULE_FIELD(allow_opts, BREAK), 131 PF_RULE_FIELD(rule_flag, BREAK), 132 PF_RULE_FIELD(action, BREAK), 133 PF_RULE_FIELD(log, BREAK), 134 PF_RULE_FIELD(quick, BREAK), 135 PF_RULE_FIELD(return_ttl, BREAK), 136 PF_RULE_FIELD(overload_tblname, BREAK), 137 PF_RULE_FIELD(flush, BREAK), 138 PF_RULE_FIELD(rpool, BREAK), 139 PF_RULE_FIELD(logif, BREAK), 140 141 /* 142 * Any fields not listed in this structure act as BREAK fields 143 */ 144 145 146 /* 147 * These fields must not differ when we merge two rules together but 148 * their difference isn't enough to put the rules in different superblocks. 149 * There are no problems re-ordering any rules with these fields. 150 */ 151 PF_RULE_FIELD(af, NOMERGE), 152 PF_RULE_FIELD(ifnot, NOMERGE), 153 PF_RULE_FIELD(ifname, NOMERGE), /* hack for IF groups */ 154 PF_RULE_FIELD(match_tag_not, NOMERGE), 155 PF_RULE_FIELD(match_tagname, NOMERGE), 156 PF_RULE_FIELD(os_fingerprint, NOMERGE), 157 PF_RULE_FIELD(timeout, NOMERGE), 158 PF_RULE_FIELD(return_icmp, NOMERGE), 159 PF_RULE_FIELD(return_icmp6, NOMERGE), 160 PF_RULE_FIELD(uid, NOMERGE), 161 PF_RULE_FIELD(gid, NOMERGE), 162 PF_RULE_FIELD(direction, NOMERGE), 163 PF_RULE_FIELD(proto, NOMERGE), 164 PF_RULE_FIELD(type, NOMERGE), 165 PF_RULE_FIELD(code, NOMERGE), 166 PF_RULE_FIELD(flags, NOMERGE), 167 PF_RULE_FIELD(flagset, NOMERGE), 168 PF_RULE_FIELD(tos, NOMERGE), 169 PF_RULE_FIELD(src.port, NOMERGE), 170 PF_RULE_FIELD(dst.port, NOMERGE), 171 PF_RULE_FIELD(src.port_op, NOMERGE), 172 PF_RULE_FIELD(dst.port_op, NOMERGE), 173 PF_RULE_FIELD(src.neg, NOMERGE), 174 PF_RULE_FIELD(dst.neg, NOMERGE), 175 176 /* These fields can be merged */ 177 PF_RULE_FIELD(src.addr, COMBINED), 178 PF_RULE_FIELD(dst.addr, COMBINED), 179 180 /* We just don't care about these fields. They're set by the kernel */ 181 PF_RULE_FIELD(skip, DC), 182 PF_RULE_FIELD(evaluations, DC), 183 PF_RULE_FIELD(packets, DC), 184 PF_RULE_FIELD(bytes, DC), 185 PF_RULE_FIELD(kif, DC), 186 PF_RULE_FIELD(states, DC), 187 PF_RULE_FIELD(src_nodes, DC), 188 PF_RULE_FIELD(nr, DC), 189 PF_RULE_FIELD(entries, DC), 190 PF_RULE_FIELD(qid, DC), 191 PF_RULE_FIELD(pqid, DC), 192 PF_RULE_FIELD(anchor_relative, DC), 193 PF_RULE_FIELD(anchor_wildcard, DC), 194 PF_RULE_FIELD(tag, DC), 195 PF_RULE_FIELD(match_tag, DC), 196 PF_RULE_FIELD(overload_tbl, DC), 197 198 /* These fields should never be set in a PASS/BLOCK rule */ 199 PF_RULE_FIELD(natpass, NEVER), 200 PF_RULE_FIELD(max_mss, NEVER), 201 PF_RULE_FIELD(min_ttl, NEVER), 202}; 203 204 205 206int add_opt_table(struct pfctl *, struct pf_opt_tbl **, sa_family_t, 207 struct pf_rule_addr *); 208int addrs_combineable(struct pf_rule_addr *, struct pf_rule_addr *); 209int addrs_equal(struct pf_rule_addr *, struct pf_rule_addr *); 210int block_feedback(struct pfctl *, struct superblock *); 211int combine_rules(struct pfctl *, struct superblock *); 212void comparable_rule(struct pf_rule *, const struct pf_rule *, int); 213int construct_superblocks(struct pfctl *, struct pf_opt_queue *, 214 struct superblocks *); 215void exclude_supersets(struct pf_rule *, struct pf_rule *); 216int interface_group(const char *); 217int load_feedback_profile(struct pfctl *, struct superblocks *); 218int optimize_superblock(struct pfctl *, struct superblock *); 219int pf_opt_create_table(struct pfctl *, struct pf_opt_tbl *); 220void remove_from_skipsteps(struct skiplist *, struct superblock *, 221 struct pf_opt_rule *, struct pf_skip_step *); 222int remove_identical_rules(struct pfctl *, struct superblock *); 223int reorder_rules(struct pfctl *, struct superblock *, int); 224int rules_combineable(struct pf_rule *, struct pf_rule *); 225void skip_append(struct superblock *, int, struct pf_skip_step *, 226 struct pf_opt_rule *); 227int skip_compare(int, struct pf_skip_step *, struct pf_opt_rule *); 228void skip_init(void); 229int skip_cmp_af(struct pf_rule *, struct pf_rule *); 230int skip_cmp_dir(struct pf_rule *, struct pf_rule *); 231int skip_cmp_dst_addr(struct pf_rule *, struct pf_rule *); 232int skip_cmp_dst_port(struct pf_rule *, struct pf_rule *); 233int skip_cmp_ifp(struct pf_rule *, struct pf_rule *); 234int skip_cmp_proto(struct pf_rule *, struct pf_rule *); 235int skip_cmp_src_addr(struct pf_rule *, struct pf_rule *); 236int skip_cmp_src_port(struct pf_rule *, struct pf_rule *); 237int superblock_inclusive(struct superblock *, struct pf_opt_rule *); 238void superblock_free(struct pfctl *, struct superblock *); 239 240 241int (*skip_comparitors[PF_SKIP_COUNT])(struct pf_rule *, struct pf_rule *); 242const char *skip_comparitors_names[PF_SKIP_COUNT]; 243#define PF_SKIP_COMPARITORS { \ 244 { "ifp", PF_SKIP_IFP, skip_cmp_ifp }, \ 245 { "dir", PF_SKIP_DIR, skip_cmp_dir }, \ 246 { "af", PF_SKIP_AF, skip_cmp_af }, \ 247 { "proto", PF_SKIP_PROTO, skip_cmp_proto }, \ 248 { "saddr", PF_SKIP_SRC_ADDR, skip_cmp_src_addr }, \ 249 { "sport", PF_SKIP_SRC_PORT, skip_cmp_src_port }, \ 250 { "daddr", PF_SKIP_DST_ADDR, skip_cmp_dst_addr }, \ 251 { "dport", PF_SKIP_DST_PORT, skip_cmp_dst_port } \ 252} 253 254struct pfr_buffer table_buffer; 255int table_identifier; 256 257 258int 259pfctl_optimize_ruleset(struct pfctl *pf, struct pf_ruleset *rs) 260{ 261 struct superblocks superblocks; 262 struct pf_opt_queue opt_queue; 263 struct superblock *block; 264 struct pf_opt_rule *por; 265 struct pf_rule *r; 266 struct pf_rulequeue *old_rules; 267 268 DEBUG("optimizing ruleset"); 269 memset(&table_buffer, 0, sizeof(table_buffer)); 270 skip_init(); 271 TAILQ_INIT(&opt_queue); 272 273 old_rules = rs->rules[PF_RULESET_FILTER].active.ptr; 274 rs->rules[PF_RULESET_FILTER].active.ptr = 275 rs->rules[PF_RULESET_FILTER].inactive.ptr; 276 rs->rules[PF_RULESET_FILTER].inactive.ptr = old_rules; 277 278 /* 279 * XXX expanding the pf_opt_rule format throughout pfctl might allow 280 * us to avoid all this copying. 281 */ 282 while ((r = TAILQ_FIRST(rs->rules[PF_RULESET_FILTER].inactive.ptr)) 283 != NULL) { 284 TAILQ_REMOVE(rs->rules[PF_RULESET_FILTER].inactive.ptr, r, 285 entries); 286 if ((por = calloc(1, sizeof(*por))) == NULL) 287 err(1, "calloc"); 288 memcpy(&por->por_rule, r, sizeof(*r)); 289 if (TAILQ_FIRST(&r->rpool.list) != NULL) { 290 TAILQ_INIT(&por->por_rule.rpool.list); 291 pfctl_move_pool(&r->rpool, &por->por_rule.rpool); 292 } else 293 bzero(&por->por_rule.rpool, 294 sizeof(por->por_rule.rpool)); 295 296 297 TAILQ_INSERT_TAIL(&opt_queue, por, por_entry); 298 } 299 300 TAILQ_INIT(&superblocks); 301 if (construct_superblocks(pf, &opt_queue, &superblocks)) 302 goto error; 303 304 if (pf->optimize & PF_OPTIMIZE_PROFILE) { 305 if (load_feedback_profile(pf, &superblocks)) 306 goto error; 307 } 308 309 TAILQ_FOREACH(block, &superblocks, sb_entry) { 310 if (optimize_superblock(pf, block)) 311 goto error; 312 } 313 314 rs->anchor->refcnt = 0; 315 while ((block = TAILQ_FIRST(&superblocks))) { 316 TAILQ_REMOVE(&superblocks, block, sb_entry); 317 318 while ((por = TAILQ_FIRST(&block->sb_rules))) { 319 TAILQ_REMOVE(&block->sb_rules, por, por_entry); 320 por->por_rule.nr = rs->anchor->refcnt++; 321 if ((r = calloc(1, sizeof(*r))) == NULL) 322 err(1, "calloc"); 323 memcpy(r, &por->por_rule, sizeof(*r)); 324 TAILQ_INIT(&r->rpool.list); 325 pfctl_move_pool(&por->por_rule.rpool, &r->rpool); 326 TAILQ_INSERT_TAIL( 327 rs->rules[PF_RULESET_FILTER].active.ptr, 328 r, entries); 329 free(por); 330 } 331 free(block); 332 } 333 334 return (0); 335 336error: 337 while ((por = TAILQ_FIRST(&opt_queue))) { 338 TAILQ_REMOVE(&opt_queue, por, por_entry); 339 if (por->por_src_tbl) { 340 pfr_buf_clear(por->por_src_tbl->pt_buf); 341 free(por->por_src_tbl->pt_buf); 342 free(por->por_src_tbl); 343 } 344 if (por->por_dst_tbl) { 345 pfr_buf_clear(por->por_dst_tbl->pt_buf); 346 free(por->por_dst_tbl->pt_buf); 347 free(por->por_dst_tbl); 348 } 349 free(por); 350 } 351 while ((block = TAILQ_FIRST(&superblocks))) { 352 TAILQ_REMOVE(&superblocks, block, sb_entry); 353 superblock_free(pf, block); 354 } 355 return (1); 356} 357 358 359/* 360 * Go ahead and optimize a superblock 361 */ 362int 363optimize_superblock(struct pfctl *pf, struct superblock *block) 364{ 365#ifdef OPT_DEBUG 366 struct pf_opt_rule *por; 367#endif /* OPT_DEBUG */ 368 369 /* We have a few optimization passes: 370 * 1) remove duplicate rules or rules that are a subset of other 371 * rules 372 * 2) combine otherwise identical rules with different IP addresses 373 * into a single rule and put the addresses in a table. 374 * 3) re-order the rules to improve kernel skip steps 375 * 4) re-order the 'quick' rules based on feedback from the 376 * active ruleset statistics 377 * 378 * XXX combine_rules() doesn't combine v4 and v6 rules. would just 379 * have to keep af in the table container, make af 'COMBINE' and 380 * twiddle the af on the merged rule 381 * XXX maybe add a weighting to the metric on skipsteps when doing 382 * reordering. sometimes two sequential tables will be better 383 * that four consecutive interfaces. 384 * XXX need to adjust the skipstep count of everything after PROTO, 385 * since they aren't actually checked on a proto mismatch in 386 * pf_test_{tcp, udp, icmp}() 387 * XXX should i treat proto=0, af=0 or dir=0 special in skepstep 388 * calculation since they are a DC? 389 * XXX keep last skiplist of last superblock to influence this 390 * superblock. '5 inet6 log' should make '3 inet6' come before '4 391 * inet' in the next superblock. 392 * XXX would be useful to add tables for ports 393 * XXX we can also re-order some mutually exclusive superblocks to 394 * try merging superblocks before any of these optimization passes. 395 * for instance a single 'log in' rule in the middle of non-logging 396 * out rules. 397 */ 398 399 /* shortcut. there will be alot of 1-rule superblocks */ 400 if (!TAILQ_NEXT(TAILQ_FIRST(&block->sb_rules), por_entry)) 401 return (0); 402 403#ifdef OPT_DEBUG 404 printf("--- Superblock ---\n"); 405 TAILQ_FOREACH(por, &block->sb_rules, por_entry) { 406 printf(" "); 407 print_rule(&por->por_rule, por->por_rule.anchor ? 408 por->por_rule.anchor->name : "", 1); 409 } 410#endif /* OPT_DEBUG */ 411 412 413 if (remove_identical_rules(pf, block)) 414 return (1); 415 if (combine_rules(pf, block)) 416 return (1); 417 if ((pf->optimize & PF_OPTIMIZE_PROFILE) && 418 TAILQ_FIRST(&block->sb_rules)->por_rule.quick && 419 block->sb_profiled_block) { 420 if (block_feedback(pf, block)) 421 return (1); 422 } else if (reorder_rules(pf, block, 0)) { 423 return (1); 424 } 425 426 /* 427 * Don't add any optimization passes below reorder_rules(). It will 428 * have divided superblocks into smaller blocks for further refinement 429 * and doesn't put them back together again. What once was a true 430 * superblock might have been split into multiple superblocks. 431 */ 432 433#ifdef OPT_DEBUG 434 printf("--- END Superblock ---\n"); 435#endif /* OPT_DEBUG */ 436 return (0); 437} 438 439 440/* 441 * Optimization pass #1: remove identical rules 442 */ 443int 444remove_identical_rules(struct pfctl *pf, struct superblock *block) 445{ 446 struct pf_opt_rule *por1, *por2, *por_next, *por2_next; 447 struct pf_rule a, a2, b, b2; 448 449 for (por1 = TAILQ_FIRST(&block->sb_rules); por1; por1 = por_next) { 450 por_next = TAILQ_NEXT(por1, por_entry); 451 for (por2 = por_next; por2; por2 = por2_next) { 452 por2_next = TAILQ_NEXT(por2, por_entry); 453 comparable_rule(&a, &por1->por_rule, DC); 454 comparable_rule(&b, &por2->por_rule, DC); 455 memcpy(&a2, &a, sizeof(a2)); 456 memcpy(&b2, &b, sizeof(b2)); 457 458 exclude_supersets(&a, &b); 459 exclude_supersets(&b2, &a2); 460 if (memcmp(&a, &b, sizeof(a)) == 0) { 461 DEBUG("removing identical rule nr%d = *nr%d*", 462 por1->por_rule.nr, por2->por_rule.nr); 463 TAILQ_REMOVE(&block->sb_rules, por2, por_entry); 464 if (por_next == por2) 465 por_next = TAILQ_NEXT(por1, por_entry); 466 free(por2); 467 } else if (memcmp(&a2, &b2, sizeof(a2)) == 0) { 468 DEBUG("removing identical rule *nr%d* = nr%d", 469 por1->por_rule.nr, por2->por_rule.nr); 470 TAILQ_REMOVE(&block->sb_rules, por1, por_entry); 471 free(por1); 472 break; 473 } 474 } 475 } 476 477 return (0); 478} 479 480 481/* 482 * Optimization pass #2: combine similar rules with different addresses 483 * into a single rule and a table 484 */ 485int 486combine_rules(struct pfctl *pf, struct superblock *block) 487{ 488 struct pf_opt_rule *p1, *p2, *por_next; 489 int src_eq, dst_eq; 490 491 if ((pf->loadopt & PFCTL_FLAG_TABLE) == 0) { 492 warnx("Must enable table loading for optimizations"); 493 return (1); 494 } 495 496 /* First we make a pass to combine the rules. O(n log n) */ 497 TAILQ_FOREACH(p1, &block->sb_rules, por_entry) { 498 for (p2 = TAILQ_NEXT(p1, por_entry); p2; p2 = por_next) { 499 por_next = TAILQ_NEXT(p2, por_entry); 500 501 src_eq = addrs_equal(&p1->por_rule.src, 502 &p2->por_rule.src); 503 dst_eq = addrs_equal(&p1->por_rule.dst, 504 &p2->por_rule.dst); 505 506 if (src_eq && !dst_eq && p1->por_src_tbl == NULL && 507 p2->por_dst_tbl == NULL && 508 p2->por_src_tbl == NULL && 509 rules_combineable(&p1->por_rule, &p2->por_rule) && 510 addrs_combineable(&p1->por_rule.dst, 511 &p2->por_rule.dst)) { 512 DEBUG("can combine rules nr%d = nr%d", 513 p1->por_rule.nr, p2->por_rule.nr); 514 if (p1->por_dst_tbl == NULL && 515 add_opt_table(pf, &p1->por_dst_tbl, 516 p1->por_rule.af, &p1->por_rule.dst)) 517 return (1); 518 if (add_opt_table(pf, &p1->por_dst_tbl, 519 p1->por_rule.af, &p2->por_rule.dst)) 520 return (1); 521 p2->por_dst_tbl = p1->por_dst_tbl; 522 if (p1->por_dst_tbl->pt_rulecount >= 523 TABLE_THRESHOLD) { 524 TAILQ_REMOVE(&block->sb_rules, p2, 525 por_entry); 526 free(p2); 527 } 528 } else if (!src_eq && dst_eq && p1->por_dst_tbl == NULL 529 && p2->por_src_tbl == NULL && 530 p2->por_dst_tbl == NULL && 531 rules_combineable(&p1->por_rule, &p2->por_rule) && 532 addrs_combineable(&p1->por_rule.src, 533 &p2->por_rule.src)) { 534 DEBUG("can combine rules nr%d = nr%d", 535 p1->por_rule.nr, p2->por_rule.nr); 536 if (p1->por_src_tbl == NULL && 537 add_opt_table(pf, &p1->por_src_tbl, 538 p1->por_rule.af, &p1->por_rule.src)) 539 return (1); 540 if (add_opt_table(pf, &p1->por_src_tbl, 541 p1->por_rule.af, &p2->por_rule.src)) 542 return (1); 543 p2->por_src_tbl = p1->por_src_tbl; 544 if (p1->por_src_tbl->pt_rulecount >= 545 TABLE_THRESHOLD) { 546 TAILQ_REMOVE(&block->sb_rules, p2, 547 por_entry); 548 free(p2); 549 } 550 } 551 } 552 } 553 554 555 /* 556 * Then we make a final pass to create a valid table name and 557 * insert the name into the rules. 558 */ 559 for (p1 = TAILQ_FIRST(&block->sb_rules); p1; p1 = por_next) { 560 por_next = TAILQ_NEXT(p1, por_entry); 561 assert(p1->por_src_tbl == NULL || p1->por_dst_tbl == NULL); 562 563 if (p1->por_src_tbl && p1->por_src_tbl->pt_rulecount >= 564 TABLE_THRESHOLD) { 565 if (p1->por_src_tbl->pt_generated) { 566 /* This rule is included in a table */ 567 TAILQ_REMOVE(&block->sb_rules, p1, por_entry); 568 free(p1); 569 continue; 570 } 571 p1->por_src_tbl->pt_generated = 1; 572 573 if ((pf->opts & PF_OPT_NOACTION) == 0 && 574 pf_opt_create_table(pf, p1->por_src_tbl)) 575 return (1); 576 577 pf->tdirty = 1; 578 579 if (pf->opts & PF_OPT_VERBOSE) 580 print_tabledef(p1->por_src_tbl->pt_name, 581 PFR_TFLAG_CONST, 1, 582 &p1->por_src_tbl->pt_nodes); 583 584 memset(&p1->por_rule.src.addr, 0, 585 sizeof(p1->por_rule.src.addr)); 586 p1->por_rule.src.addr.type = PF_ADDR_TABLE; 587 strlcpy(p1->por_rule.src.addr.v.tblname, 588 p1->por_src_tbl->pt_name, 589 sizeof(p1->por_rule.src.addr.v.tblname)); 590 591 pfr_buf_clear(p1->por_src_tbl->pt_buf); 592 free(p1->por_src_tbl->pt_buf); 593 p1->por_src_tbl->pt_buf = NULL; 594 } 595 if (p1->por_dst_tbl && p1->por_dst_tbl->pt_rulecount >= 596 TABLE_THRESHOLD) { 597 if (p1->por_dst_tbl->pt_generated) { 598 /* This rule is included in a table */ 599 TAILQ_REMOVE(&block->sb_rules, p1, por_entry); 600 free(p1); 601 continue; 602 } 603 p1->por_dst_tbl->pt_generated = 1; 604 605 if ((pf->opts & PF_OPT_NOACTION) == 0 && 606 pf_opt_create_table(pf, p1->por_dst_tbl)) 607 return (1); 608 pf->tdirty = 1; 609 610 if (pf->opts & PF_OPT_VERBOSE) 611 print_tabledef(p1->por_dst_tbl->pt_name, 612 PFR_TFLAG_CONST, 1, 613 &p1->por_dst_tbl->pt_nodes); 614 615 memset(&p1->por_rule.dst.addr, 0, 616 sizeof(p1->por_rule.dst.addr)); 617 p1->por_rule.dst.addr.type = PF_ADDR_TABLE; 618 strlcpy(p1->por_rule.dst.addr.v.tblname, 619 p1->por_dst_tbl->pt_name, 620 sizeof(p1->por_rule.dst.addr.v.tblname)); 621 622 pfr_buf_clear(p1->por_dst_tbl->pt_buf); 623 free(p1->por_dst_tbl->pt_buf); 624 p1->por_dst_tbl->pt_buf = NULL; 625 } 626 } 627 628 return (0); 629} 630 631 632/* 633 * Optimization pass #3: re-order rules to improve skip steps 634 */ 635int 636reorder_rules(struct pfctl *pf, struct superblock *block, int depth) 637{ 638 struct superblock *newblock; 639 struct pf_skip_step *skiplist; 640 struct pf_opt_rule *por; 641 int i, largest, largest_list = -1, rule_count = 0; 642 TAILQ_HEAD( , pf_opt_rule) head; 643 644 /* 645 * Calculate the best-case skip steps. We put each rule in a list 646 * of other rules with common fields 647 */ 648 for (i = 0; i < PF_SKIP_COUNT; i++) { 649 TAILQ_FOREACH(por, &block->sb_rules, por_entry) { 650 TAILQ_FOREACH(skiplist, &block->sb_skipsteps[i], 651 ps_entry) { 652 if (skip_compare(i, skiplist, por) == 0) 653 break; 654 } 655 if (skiplist == NULL) { 656 if ((skiplist = calloc(1, sizeof(*skiplist))) == 657 NULL) 658 err(1, "calloc"); 659 TAILQ_INIT(&skiplist->ps_rules); 660 TAILQ_INSERT_TAIL(&block->sb_skipsteps[i], 661 skiplist, ps_entry); 662 } 663 skip_append(block, i, skiplist, por); 664 } 665 } 666 667 TAILQ_FOREACH(por, &block->sb_rules, por_entry) 668 rule_count++; 669 670 /* 671 * Now we're going to ignore any fields that are identical between 672 * all of the rules in the superblock and those fields which differ 673 * between every rule in the superblock. 674 */ 675 largest = 0; 676 for (i = 0; i < PF_SKIP_COUNT; i++) { 677 skiplist = TAILQ_FIRST(&block->sb_skipsteps[i]); 678 if (skiplist->ps_count == rule_count) { 679 DEBUG("(%d) original skipstep '%s' is all rules", 680 depth, skip_comparitors_names[i]); 681 skiplist->ps_count = 0; 682 } else if (skiplist->ps_count == 1) { 683 skiplist->ps_count = 0; 684 } else { 685 DEBUG("(%d) original skipstep '%s' largest jump is %d", 686 depth, skip_comparitors_names[i], 687 skiplist->ps_count); 688 if (skiplist->ps_count > largest) 689 largest = skiplist->ps_count; 690 } 691 } 692 if (largest == 0) { 693 /* Ugh. There is NO commonality in the superblock on which 694 * optimize the skipsteps optimization. 695 */ 696 goto done; 697 } 698 699 /* 700 * Now we're going to empty the superblock rule list and re-create 701 * it based on a more optimal skipstep order. 702 */ 703 TAILQ_INIT(&head); 704 while ((por = TAILQ_FIRST(&block->sb_rules))) { 705 TAILQ_REMOVE(&block->sb_rules, por, por_entry); 706 TAILQ_INSERT_TAIL(&head, por, por_entry); 707 } 708 709 710 while (!TAILQ_EMPTY(&head)) { 711 largest = 1; 712 713 /* 714 * Find the most useful skip steps remaining 715 */ 716 for (i = 0; i < PF_SKIP_COUNT; i++) { 717 skiplist = TAILQ_FIRST(&block->sb_skipsteps[i]); 718 if (skiplist->ps_count > largest) { 719 largest = skiplist->ps_count; 720 largest_list = i; 721 } 722 } 723 724 if (largest <= 1) { 725 /* 726 * Nothing useful left. Leave remaining rules in order. 727 */ 728 DEBUG("(%d) no more commonality for skip steps", depth); 729 while ((por = TAILQ_FIRST(&head))) { 730 TAILQ_REMOVE(&head, por, por_entry); 731 TAILQ_INSERT_TAIL(&block->sb_rules, por, 732 por_entry); 733 } 734 } else { 735 /* 736 * There is commonality. Extract those common rules 737 * and place them in the ruleset adjacent to each 738 * other. 739 */ 740 skiplist = TAILQ_FIRST(&block->sb_skipsteps[ 741 largest_list]); 742 DEBUG("(%d) skipstep '%s' largest jump is %d @ #%d", 743 depth, skip_comparitors_names[largest_list], 744 largest, TAILQ_FIRST(&TAILQ_FIRST(&block-> 745 sb_skipsteps [largest_list])->ps_rules)-> 746 por_rule.nr); 747 TAILQ_REMOVE(&block->sb_skipsteps[largest_list], 748 skiplist, ps_entry); 749 750 751 /* 752 * There may be further commonality inside these 753 * rules. So we'll split them off into they're own 754 * superblock and pass it back into the optimizer. 755 */ 756 if (skiplist->ps_count > 2) { 757 if ((newblock = calloc(1, sizeof(*newblock))) 758 == NULL) { 759 warn("calloc"); 760 return (1); 761 } 762 TAILQ_INIT(&newblock->sb_rules); 763 for (i = 0; i < PF_SKIP_COUNT; i++) 764 TAILQ_INIT(&newblock->sb_skipsteps[i]); 765 TAILQ_INSERT_BEFORE(block, newblock, sb_entry); 766 DEBUG("(%d) splitting off %d rules from superblock @ #%d", 767 depth, skiplist->ps_count, 768 TAILQ_FIRST(&skiplist->ps_rules)-> 769 por_rule.nr); 770 } else { 771 newblock = block; 772 } 773 774 while ((por = TAILQ_FIRST(&skiplist->ps_rules))) { 775 TAILQ_REMOVE(&head, por, por_entry); 776 TAILQ_REMOVE(&skiplist->ps_rules, por, 777 por_skip_entry[largest_list]); 778 TAILQ_INSERT_TAIL(&newblock->sb_rules, por, 779 por_entry); 780 781 /* Remove this rule from all other skiplists */ 782 remove_from_skipsteps(&block->sb_skipsteps[ 783 largest_list], block, por, skiplist); 784 } 785 free(skiplist); 786 if (newblock != block) 787 if (reorder_rules(pf, newblock, depth + 1)) 788 return (1); 789 } 790 } 791 792done: 793 for (i = 0; i < PF_SKIP_COUNT; i++) { 794 while ((skiplist = TAILQ_FIRST(&block->sb_skipsteps[i]))) { 795 TAILQ_REMOVE(&block->sb_skipsteps[i], skiplist, 796 ps_entry); 797 free(skiplist); 798 } 799 } 800 801 return (0); 802} 803 804 805/* 806 * Optimization pass #4: re-order 'quick' rules based on feedback from the 807 * currently running ruleset 808 */ 809int 810block_feedback(struct pfctl *pf, struct superblock *block) 811{ 812 TAILQ_HEAD( , pf_opt_rule) queue; 813 struct pf_opt_rule *por1, *por2; 814 u_int64_t total_count = 0; 815 struct pf_rule a, b; 816 817 818 /* 819 * Walk through all of the profiled superblock's rules and copy 820 * the counters onto our rules. 821 */ 822 TAILQ_FOREACH(por1, &block->sb_profiled_block->sb_rules, por_entry) { 823 comparable_rule(&a, &por1->por_rule, DC); 824 total_count += por1->por_rule.packets[0] + 825 por1->por_rule.packets[1]; 826 TAILQ_FOREACH(por2, &block->sb_rules, por_entry) { 827 if (por2->por_profile_count) 828 continue; 829 comparable_rule(&b, &por2->por_rule, DC); 830 if (memcmp(&a, &b, sizeof(a)) == 0) { 831 por2->por_profile_count = 832 por1->por_rule.packets[0] + 833 por1->por_rule.packets[1]; 834 break; 835 } 836 } 837 } 838 superblock_free(pf, block->sb_profiled_block); 839 block->sb_profiled_block = NULL; 840 841 /* 842 * Now we pull all of the rules off the superblock and re-insert them 843 * in sorted order. 844 */ 845 846 TAILQ_INIT(&queue); 847 while ((por1 = TAILQ_FIRST(&block->sb_rules)) != NULL) { 848 TAILQ_REMOVE(&block->sb_rules, por1, por_entry); 849 TAILQ_INSERT_TAIL(&queue, por1, por_entry); 850 } 851 852 while ((por1 = TAILQ_FIRST(&queue)) != NULL) { 853 TAILQ_REMOVE(&queue, por1, por_entry); 854/* XXX I should sort all of the unused rules based on skip steps */ 855 TAILQ_FOREACH(por2, &block->sb_rules, por_entry) { 856 if (por1->por_profile_count > por2->por_profile_count) { 857 TAILQ_INSERT_BEFORE(por2, por1, por_entry); 858 break; 859 } 860 } 861 if (por2 == TAILQ_END(&block->sb_rules)) 862 TAILQ_INSERT_TAIL(&block->sb_rules, por1, por_entry); 863 } 864 865 return (0); 866} 867 868 869/* 870 * Load the current ruleset from the kernel and try to associate them with 871 * the ruleset we're optimizing. 872 */ 873int 874load_feedback_profile(struct pfctl *pf, struct superblocks *superblocks) 875{ 876 struct superblock *block, *blockcur; 877 struct superblocks prof_superblocks; 878 struct pf_opt_rule *por; 879 struct pf_opt_queue queue; 880 struct pfioc_rule pr; 881 struct pf_rule a, b; 882 int nr, mnr; 883 884 TAILQ_INIT(&queue); 885 TAILQ_INIT(&prof_superblocks); 886 887 memset(&pr, 0, sizeof(pr)); 888 pr.rule.action = PF_PASS; 889 if (ioctl(pf->dev, DIOCGETRULES, &pr)) { 890 warn("DIOCGETRULES"); 891 return (1); 892 } 893 mnr = pr.nr; 894 895 DEBUG("Loading %d active rules for a feedback profile", mnr); 896 for (nr = 0; nr < mnr; ++nr) { 897 struct pf_ruleset *rs; 898 if ((por = calloc(1, sizeof(*por))) == NULL) { 899 warn("calloc"); 900 return (1); 901 } 902 pr.nr = nr; 903 if (ioctl(pf->dev, DIOCGETRULE, &pr)) { 904 warn("DIOCGETRULES"); 905 free(por); 906 return (1); 907 } 908 memcpy(&por->por_rule, &pr.rule, sizeof(por->por_rule)); 909 rs = pf_find_or_create_ruleset(pr.anchor_call); 910 por->por_rule.anchor = rs->anchor; 911 if (TAILQ_EMPTY(&por->por_rule.rpool.list)) 912 memset(&por->por_rule.rpool, 0, 913 sizeof(por->por_rule.rpool)); 914 TAILQ_INSERT_TAIL(&queue, por, por_entry); 915 916 /* XXX pfctl_get_pool(pf->dev, &pr.rule.rpool, nr, pr.ticket, 917 * PF_PASS, pf->anchor) ??? 918 * ... pfctl_clear_pool(&pr.rule.rpool) 919 */ 920 } 921 922 if (construct_superblocks(pf, &queue, &prof_superblocks)) 923 return (1); 924 925 926 /* 927 * Now we try to associate the active ruleset's superblocks with 928 * the superblocks we're compiling. 929 */ 930 block = TAILQ_FIRST(superblocks); 931 blockcur = TAILQ_FIRST(&prof_superblocks); 932 while (block && blockcur) { 933 comparable_rule(&a, &TAILQ_FIRST(&block->sb_rules)->por_rule, 934 BREAK); 935 comparable_rule(&b, &TAILQ_FIRST(&blockcur->sb_rules)->por_rule, 936 BREAK); 937 if (memcmp(&a, &b, sizeof(a)) == 0) { 938 /* The two superblocks lined up */ 939 block->sb_profiled_block = blockcur; 940 } else { 941 DEBUG("superblocks don't line up between #%d and #%d", 942 TAILQ_FIRST(&block->sb_rules)->por_rule.nr, 943 TAILQ_FIRST(&blockcur->sb_rules)->por_rule.nr); 944 break; 945 } 946 block = TAILQ_NEXT(block, sb_entry); 947 blockcur = TAILQ_NEXT(blockcur, sb_entry); 948 } 949 950 951 952 /* Free any superblocks we couldn't link */ 953 while (blockcur) { 954 block = TAILQ_NEXT(blockcur, sb_entry); 955 superblock_free(pf, blockcur); 956 blockcur = block; 957 } 958 return (0); 959} 960 961 962/* 963 * Compare a rule to a skiplist to see if the rule is a member 964 */ 965int 966skip_compare(int skipnum, struct pf_skip_step *skiplist, 967 struct pf_opt_rule *por) 968{ 969 struct pf_rule *a, *b; 970 if (skipnum >= PF_SKIP_COUNT || skipnum < 0) 971 errx(1, "skip_compare() out of bounds"); 972 a = &por->por_rule; 973 b = &TAILQ_FIRST(&skiplist->ps_rules)->por_rule; 974 975 return ((skip_comparitors[skipnum])(a, b)); 976} 977 978 979/* 980 * Add a rule to a skiplist 981 */ 982void 983skip_append(struct superblock *superblock, int skipnum, 984 struct pf_skip_step *skiplist, struct pf_opt_rule *por) 985{ 986 struct pf_skip_step *prev; 987 988 skiplist->ps_count++; 989 TAILQ_INSERT_TAIL(&skiplist->ps_rules, por, por_skip_entry[skipnum]); 990 991 /* Keep the list of skiplists sorted by whichever is larger */ 992 while ((prev = TAILQ_PREV(skiplist, skiplist, ps_entry)) && 993 prev->ps_count < skiplist->ps_count) { 994 TAILQ_REMOVE(&superblock->sb_skipsteps[skipnum], 995 skiplist, ps_entry); 996 TAILQ_INSERT_BEFORE(prev, skiplist, ps_entry); 997 } 998} 999 1000 1001/* 1002 * Remove a rule from the other skiplist calculations. 1003 */ 1004void 1005remove_from_skipsteps(struct skiplist *head, struct superblock *block, 1006 struct pf_opt_rule *por, struct pf_skip_step *active_list) 1007{ 1008 struct pf_skip_step *sk, *next; 1009 struct pf_opt_rule *p2; 1010 int i, found; 1011 1012 for (i = 0; i < PF_SKIP_COUNT; i++) { 1013 sk = TAILQ_FIRST(&block->sb_skipsteps[i]); 1014 if (sk == NULL || sk == active_list || sk->ps_count <= 1) 1015 continue; 1016 found = 0; 1017 do { 1018 TAILQ_FOREACH(p2, &sk->ps_rules, por_skip_entry[i]) 1019 if (p2 == por) { 1020 TAILQ_REMOVE(&sk->ps_rules, p2, 1021 por_skip_entry[i]); 1022 found = 1; 1023 sk->ps_count--; 1024 break; 1025 } 1026 } while (!found && (sk = TAILQ_NEXT(sk, ps_entry))); 1027 if (found && sk) { 1028 /* Does this change the sorting order? */ 1029 while ((next = TAILQ_NEXT(sk, ps_entry)) && 1030 next->ps_count > sk->ps_count) { 1031 TAILQ_REMOVE(head, sk, ps_entry); 1032 TAILQ_INSERT_AFTER(head, next, sk, ps_entry); 1033 } 1034#ifdef OPT_DEBUG 1035 next = TAILQ_NEXT(sk, ps_entry); 1036 assert(next == NULL || next->ps_count <= sk->ps_count); 1037#endif /* OPT_DEBUG */ 1038 } 1039 } 1040} 1041 1042 1043/* Compare two rules AF field for skiplist construction */ 1044int 1045skip_cmp_af(struct pf_rule *a, struct pf_rule *b) 1046{ 1047 if (a->af != b->af || a->af == 0) 1048 return (1); 1049 return (0); 1050} 1051 1052/* Compare two rules DIRECTION field for skiplist construction */ 1053int 1054skip_cmp_dir(struct pf_rule *a, struct pf_rule *b) 1055{ 1056 if (a->direction == 0 || a->direction != b->direction) 1057 return (1); 1058 return (0); 1059} 1060 1061/* Compare two rules DST Address field for skiplist construction */ 1062int 1063skip_cmp_dst_addr(struct pf_rule *a, struct pf_rule *b) 1064{ 1065 if (a->dst.neg != b->dst.neg || 1066 a->dst.addr.type != b->dst.addr.type) 1067 return (1); 1068 /* XXX if (a->proto != b->proto && a->proto != 0 && b->proto != 0 1069 * && (a->proto == IPPROTO_TCP || a->proto == IPPROTO_UDP || 1070 * a->proto == IPPROTO_ICMP 1071 * return (1); 1072 */ 1073 switch (a->dst.addr.type) { 1074 case PF_ADDR_ADDRMASK: 1075 if (memcmp(&a->dst.addr.v.a.addr, &b->dst.addr.v.a.addr, 1076 sizeof(a->dst.addr.v.a.addr)) || 1077 memcmp(&a->dst.addr.v.a.mask, &b->dst.addr.v.a.mask, 1078 sizeof(a->dst.addr.v.a.mask)) || 1079 (a->dst.addr.v.a.addr.addr32[0] == 0 && 1080 a->dst.addr.v.a.addr.addr32[1] == 0 && 1081 a->dst.addr.v.a.addr.addr32[2] == 0 && 1082 a->dst.addr.v.a.addr.addr32[3] == 0)) 1083 return (1); 1084 return (0); 1085 case PF_ADDR_DYNIFTL: 1086 if (strcmp(a->dst.addr.v.ifname, b->dst.addr.v.ifname) != 0 || 1087 a->dst.addr.iflags != b->dst.addr.iflags || 1088 memcmp(&a->dst.addr.v.a.mask, &b->dst.addr.v.a.mask, 1089 sizeof(a->dst.addr.v.a.mask))) 1090 return (1); 1091 return (0); 1092 case PF_ADDR_NOROUTE: 1093 case PF_ADDR_URPFFAILED: 1094 return (0); 1095 case PF_ADDR_TABLE: 1096 return (strcmp(a->dst.addr.v.tblname, b->dst.addr.v.tblname)); 1097 } 1098 return (1); 1099} 1100 1101/* Compare two rules DST port field for skiplist construction */ 1102int 1103skip_cmp_dst_port(struct pf_rule *a, struct pf_rule *b) 1104{ 1105 /* XXX if (a->proto != b->proto && a->proto != 0 && b->proto != 0 1106 * && (a->proto == IPPROTO_TCP || a->proto == IPPROTO_UDP || 1107 * a->proto == IPPROTO_ICMP 1108 * return (1); 1109 */ 1110 if (a->dst.port_op == PF_OP_NONE || a->dst.port_op != b->dst.port_op || 1111 a->dst.port[0] != b->dst.port[0] || 1112 a->dst.port[1] != b->dst.port[1]) 1113 return (1); 1114 return (0); 1115} 1116 1117/* Compare two rules IFP field for skiplist construction */ 1118int 1119skip_cmp_ifp(struct pf_rule *a, struct pf_rule *b) 1120{ 1121 if (strcmp(a->ifname, b->ifname) || a->ifname[0] == '\0') 1122 return (1); 1123 return (a->ifnot != b->ifnot); 1124} 1125 1126/* Compare two rules PROTO field for skiplist construction */ 1127int 1128skip_cmp_proto(struct pf_rule *a, struct pf_rule *b) 1129{ 1130 return (a->proto != b->proto || a->proto == 0); 1131} 1132 1133/* Compare two rules SRC addr field for skiplist construction */ 1134int 1135skip_cmp_src_addr(struct pf_rule *a, struct pf_rule *b) 1136{ 1137 if (a->src.neg != b->src.neg || 1138 a->src.addr.type != b->src.addr.type) 1139 return (1); 1140 /* XXX if (a->proto != b->proto && a->proto != 0 && b->proto != 0 1141 * && (a->proto == IPPROTO_TCP || a->proto == IPPROTO_UDP || 1142 * a->proto == IPPROTO_ICMP 1143 * return (1); 1144 */ 1145 switch (a->src.addr.type) { 1146 case PF_ADDR_ADDRMASK: 1147 if (memcmp(&a->src.addr.v.a.addr, &b->src.addr.v.a.addr, 1148 sizeof(a->src.addr.v.a.addr)) || 1149 memcmp(&a->src.addr.v.a.mask, &b->src.addr.v.a.mask, 1150 sizeof(a->src.addr.v.a.mask)) || 1151 (a->src.addr.v.a.addr.addr32[0] == 0 && 1152 a->src.addr.v.a.addr.addr32[1] == 0 && 1153 a->src.addr.v.a.addr.addr32[2] == 0 && 1154 a->src.addr.v.a.addr.addr32[3] == 0)) 1155 return (1); 1156 return (0); 1157 case PF_ADDR_DYNIFTL: 1158 if (strcmp(a->src.addr.v.ifname, b->src.addr.v.ifname) != 0 || 1159 a->src.addr.iflags != b->src.addr.iflags || 1160 memcmp(&a->src.addr.v.a.mask, &b->src.addr.v.a.mask, 1161 sizeof(a->src.addr.v.a.mask))) 1162 return (1); 1163 return (0); 1164 case PF_ADDR_NOROUTE: 1165 case PF_ADDR_URPFFAILED: 1166 return (0); 1167 case PF_ADDR_TABLE: 1168 return (strcmp(a->src.addr.v.tblname, b->src.addr.v.tblname)); 1169 } 1170 return (1); 1171} 1172 1173/* Compare two rules SRC port field for skiplist construction */ 1174int 1175skip_cmp_src_port(struct pf_rule *a, struct pf_rule *b) 1176{ 1177 if (a->src.port_op == PF_OP_NONE || a->src.port_op != b->src.port_op || 1178 a->src.port[0] != b->src.port[0] || 1179 a->src.port[1] != b->src.port[1]) 1180 return (1); 1181 /* XXX if (a->proto != b->proto && a->proto != 0 && b->proto != 0 1182 * && (a->proto == IPPROTO_TCP || a->proto == IPPROTO_UDP || 1183 * a->proto == IPPROTO_ICMP 1184 * return (1); 1185 */ 1186 return (0); 1187} 1188 1189 1190void 1191skip_init(void) 1192{ 1193 struct { 1194 char *name; 1195 int skipnum; 1196 int (*func)(struct pf_rule *, struct pf_rule *); 1197 } comps[] = PF_SKIP_COMPARITORS; 1198 int skipnum, i; 1199 1200 for (skipnum = 0; skipnum < PF_SKIP_COUNT; skipnum++) { 1201 for (i = 0; i < sizeof(comps)/sizeof(*comps); i++) 1202 if (comps[i].skipnum == skipnum) { 1203 skip_comparitors[skipnum] = comps[i].func; 1204 skip_comparitors_names[skipnum] = comps[i].name; 1205 } 1206 } 1207 for (skipnum = 0; skipnum < PF_SKIP_COUNT; skipnum++) 1208 if (skip_comparitors[skipnum] == NULL) 1209 errx(1, "Need to add skip step comparitor to pfctl?!"); 1210} 1211 1212/* 1213 * Add a host/netmask to a table 1214 */ 1215int 1216add_opt_table(struct pfctl *pf, struct pf_opt_tbl **tbl, sa_family_t af, 1217 struct pf_rule_addr *addr) 1218{ 1219#ifdef OPT_DEBUG 1220 char buf[128]; 1221#endif /* OPT_DEBUG */ 1222 static int tablenum = 0; 1223 struct node_host node_host; 1224 1225 if (*tbl == NULL) { 1226 if ((*tbl = calloc(1, sizeof(**tbl))) == NULL || 1227 ((*tbl)->pt_buf = calloc(1, sizeof(*(*tbl)->pt_buf))) == 1228 NULL) 1229 err(1, "calloc"); 1230 (*tbl)->pt_buf->pfrb_type = PFRB_ADDRS; 1231 SIMPLEQ_INIT(&(*tbl)->pt_nodes); 1232 1233 /* This is just a temporary table name */ 1234 snprintf((*tbl)->pt_name, sizeof((*tbl)->pt_name), "%s%d", 1235 PF_OPT_TABLE_PREFIX, tablenum++); 1236 DEBUG("creating table <%s>", (*tbl)->pt_name); 1237 } 1238 1239 memset(&node_host, 0, sizeof(node_host)); 1240 node_host.af = af; 1241 node_host.addr = addr->addr; 1242 1243#ifdef OPT_DEBUG 1244 DEBUG("<%s> adding %s/%d", (*tbl)->pt_name, inet_ntop(af, 1245 &node_host.addr.v.a.addr, buf, sizeof(buf)), 1246 unmask(&node_host.addr.v.a.mask, af)); 1247#endif /* OPT_DEBUG */ 1248 1249 if (append_addr_host((*tbl)->pt_buf, &node_host, 0, 0)) { 1250 warn("failed to add host"); 1251 return (1); 1252 } 1253 if (pf->opts & PF_OPT_VERBOSE) { 1254 struct node_tinit *ti; 1255 1256 if ((ti = calloc(1, sizeof(*ti))) == NULL) 1257 err(1, "malloc"); 1258 if ((ti->host = malloc(sizeof(*ti->host))) == NULL) 1259 err(1, "malloc"); 1260 memcpy(ti->host, &node_host, sizeof(*ti->host)); 1261 SIMPLEQ_INSERT_TAIL(&(*tbl)->pt_nodes, ti, entries); 1262 } 1263 1264 (*tbl)->pt_rulecount++; 1265 if ((*tbl)->pt_rulecount == TABLE_THRESHOLD) 1266 DEBUG("table <%s> now faster than skip steps", (*tbl)->pt_name); 1267 1268 return (0); 1269} 1270 1271 1272/* 1273 * Do the dirty work of choosing an unused table name and creating it. 1274 * (be careful with the table name, it might already be used in another anchor) 1275 */ 1276int 1277pf_opt_create_table(struct pfctl *pf, struct pf_opt_tbl *tbl) 1278{ 1279 static int tablenum; 1280 struct pfr_table *t; 1281 1282 if (table_buffer.pfrb_type == 0) { 1283 /* Initialize the list of tables */ 1284 table_buffer.pfrb_type = PFRB_TABLES; 1285 for (;;) { 1286 pfr_buf_grow(&table_buffer, table_buffer.pfrb_size); 1287 table_buffer.pfrb_size = table_buffer.pfrb_msize; 1288 if (pfr_get_tables(NULL, table_buffer.pfrb_caddr, 1289 &table_buffer.pfrb_size, PFR_FLAG_ALLRSETS)) 1290 err(1, "pfr_get_tables"); 1291 if (table_buffer.pfrb_size <= table_buffer.pfrb_msize) 1292 break; 1293 } 1294 table_identifier = arc4random(); 1295 } 1296 1297 /* XXX would be *really* nice to avoid duplicating identical tables */ 1298 1299 /* Now we have to pick a table name that isn't used */ 1300again: 1301 DEBUG("translating temporary table <%s> to <%s%x_%d>", tbl->pt_name, 1302 PF_OPT_TABLE_PREFIX, table_identifier, tablenum); 1303 snprintf(tbl->pt_name, sizeof(tbl->pt_name), "%s%x_%d", 1304 PF_OPT_TABLE_PREFIX, table_identifier, tablenum); 1305 PFRB_FOREACH(t, &table_buffer) { 1306 if (strcasecmp(t->pfrt_name, tbl->pt_name) == 0) { 1307 /* Collision. Try again */ 1308 DEBUG("wow, table <%s> in use. trying again", 1309 tbl->pt_name); 1310 table_identifier = arc4random(); 1311 goto again; 1312 } 1313 } 1314 tablenum++; 1315 1316 1317 if (pfctl_define_table(tbl->pt_name, PFR_TFLAG_CONST, 1, 1318 pf->anchor->name, tbl->pt_buf, pf->anchor->ruleset.tticket)) { 1319 warn("failed to create table %s", tbl->pt_name); 1320 return (1); 1321 } 1322 return (0); 1323} 1324 1325/* 1326 * Partition the flat ruleset into a list of distinct superblocks 1327 */ 1328int 1329construct_superblocks(struct pfctl *pf, struct pf_opt_queue *opt_queue, 1330 struct superblocks *superblocks) 1331{ 1332 struct superblock *block = NULL; 1333 struct pf_opt_rule *por; 1334 int i; 1335 1336 while (!TAILQ_EMPTY(opt_queue)) { 1337 por = TAILQ_FIRST(opt_queue); 1338 TAILQ_REMOVE(opt_queue, por, por_entry); 1339 if (block == NULL || !superblock_inclusive(block, por)) { 1340 if ((block = calloc(1, sizeof(*block))) == NULL) { 1341 warn("calloc"); 1342 return (1); 1343 } 1344 TAILQ_INIT(&block->sb_rules); 1345 for (i = 0; i < PF_SKIP_COUNT; i++) 1346 TAILQ_INIT(&block->sb_skipsteps[i]); 1347 TAILQ_INSERT_TAIL(superblocks, block, sb_entry); 1348 } 1349 TAILQ_INSERT_TAIL(&block->sb_rules, por, por_entry); 1350 } 1351 1352 return (0); 1353} 1354 1355 1356/* 1357 * Compare two rule addresses 1358 */ 1359int 1360addrs_equal(struct pf_rule_addr *a, struct pf_rule_addr *b) 1361{ 1362 if (a->neg != b->neg) 1363 return (0); 1364 return (memcmp(&a->addr, &b->addr, sizeof(a->addr)) == 0); 1365} 1366 1367 1368/* 1369 * The addresses are not equal, but can we combine them into one table? 1370 */ 1371int 1372addrs_combineable(struct pf_rule_addr *a, struct pf_rule_addr *b) 1373{ 1374 if (a->addr.type != PF_ADDR_ADDRMASK || 1375 b->addr.type != PF_ADDR_ADDRMASK) 1376 return (0); 1377 if (a->neg != b->neg || a->port_op != b->port_op || 1378 a->port[0] != b->port[0] || a->port[1] != b->port[1]) 1379 return (0); 1380 return (1); 1381} 1382 1383 1384/* 1385 * Are we allowed to combine these two rules 1386 */ 1387int 1388rules_combineable(struct pf_rule *p1, struct pf_rule *p2) 1389{ 1390 struct pf_rule a, b; 1391 1392 comparable_rule(&a, p1, COMBINED); 1393 comparable_rule(&b, p2, COMBINED); 1394 return (memcmp(&a, &b, sizeof(a)) == 0); 1395} 1396 1397 1398/* 1399 * Can a rule be included inside a superblock 1400 */ 1401int 1402superblock_inclusive(struct superblock *block, struct pf_opt_rule *por) 1403{ 1404 struct pf_rule a, b; 1405 int i, j; 1406 1407 /* First check for hard breaks */ 1408 for (i = 0; i < sizeof(pf_rule_desc)/sizeof(*pf_rule_desc); i++) { 1409 if (pf_rule_desc[i].prf_type == BARRIER) { 1410 for (j = 0; j < pf_rule_desc[i].prf_size; j++) 1411 if (((char *)&por->por_rule)[j + 1412 pf_rule_desc[i].prf_offset] != 0) 1413 return (0); 1414 } 1415 } 1416 1417 /* per-rule src-track is also a hard break */ 1418 if (por->por_rule.rule_flag & PFRULE_RULESRCTRACK) 1419 return (0); 1420 1421 /* 1422 * Have to handle interface groups seperately. Consider the following 1423 * rules: 1424 * block on EXTIFS to any port 22 1425 * pass on em0 to any port 22 1426 * (where EXTIFS is an arbitrary interface group) 1427 * The optimizer may decide to re-order the pass rule in front of the 1428 * block rule. But what if EXTIFS includes em0??? Such a reordering 1429 * would change the meaning of the ruleset. 1430 * We can't just lookup the EXTIFS group and check if em0 is a member 1431 * because the user is allowed to add interfaces to a group during 1432 * runtime. 1433 * Ergo interface groups become a defacto superblock break :-( 1434 */ 1435 if (interface_group(por->por_rule.ifname) || 1436 interface_group(TAILQ_FIRST(&block->sb_rules)->por_rule.ifname)) { 1437 if (strcasecmp(por->por_rule.ifname, 1438 TAILQ_FIRST(&block->sb_rules)->por_rule.ifname) != 0) 1439 return (0); 1440 } 1441 1442 comparable_rule(&a, &TAILQ_FIRST(&block->sb_rules)->por_rule, NOMERGE); 1443 comparable_rule(&b, &por->por_rule, NOMERGE); 1444 if (memcmp(&a, &b, sizeof(a)) == 0) 1445 return (1); 1446 1447#ifdef OPT_DEBUG 1448 for (i = 0; i < sizeof(por->por_rule); i++) { 1449 int closest = -1; 1450 if (((u_int8_t *)&a)[i] != ((u_int8_t *)&b)[i]) { 1451 for (j = 0; j < sizeof(pf_rule_desc) / 1452 sizeof(*pf_rule_desc); j++) { 1453 if (i >= pf_rule_desc[j].prf_offset && 1454 i < pf_rule_desc[j].prf_offset + 1455 pf_rule_desc[j].prf_size) { 1456 DEBUG("superblock break @ %d due to %s", 1457 por->por_rule.nr, 1458 pf_rule_desc[j].prf_name); 1459 return (0); 1460 } 1461 if (i > pf_rule_desc[j].prf_offset) { 1462 if (closest == -1 || 1463 i-pf_rule_desc[j].prf_offset < 1464 i-pf_rule_desc[closest].prf_offset) 1465 closest = j; 1466 } 1467 } 1468 1469 if (closest >= 0) 1470 DEBUG("superblock break @ %d on %s+%xh", 1471 por->por_rule.nr, 1472 pf_rule_desc[closest].prf_name, 1473 i - pf_rule_desc[closest].prf_offset - 1474 pf_rule_desc[closest].prf_size); 1475 else 1476 DEBUG("superblock break @ %d on field @ %d", 1477 por->por_rule.nr, i); 1478 return (0); 1479 } 1480 } 1481#endif /* OPT_DEBUG */ 1482 1483 return (0); 1484} 1485 1486 1487/* 1488 * Figure out if an interface name is an actual interface or actually a 1489 * group of interfaces. 1490 */ 1491int 1492interface_group(const char *ifname) 1493{ 1494 if (ifname == NULL || !ifname[0]) 1495 return (0); 1496 1497 /* Real interfaces must end in a number, interface groups do not */ 1498 if (isdigit((unsigned char)ifname[strlen(ifname) - 1])) 1499 return (0); 1500 else 1501 return (1); 1502} 1503 1504 1505/* 1506 * Make a rule that can directly compared by memcmp() 1507 */ 1508void 1509comparable_rule(struct pf_rule *dst, const struct pf_rule *src, int type) 1510{ 1511 int i; 1512 /* 1513 * To simplify the comparison, we just zero out the fields that are 1514 * allowed to be different and then do a simple memcmp() 1515 */ 1516 memcpy(dst, src, sizeof(*dst)); 1517 for (i = 0; i < sizeof(pf_rule_desc)/sizeof(*pf_rule_desc); i++) 1518 if (pf_rule_desc[i].prf_type >= type) { 1519#ifdef OPT_DEBUG 1520 assert(pf_rule_desc[i].prf_type != NEVER || 1521 *(((char *)dst) + pf_rule_desc[i].prf_offset) == 0); 1522#endif /* OPT_DEBUG */ 1523 memset(((char *)dst) + pf_rule_desc[i].prf_offset, 0, 1524 pf_rule_desc[i].prf_size); 1525 } 1526} 1527 1528 1529/* 1530 * Remove superset information from two rules so we can directly compare them 1531 * with memcmp() 1532 */ 1533void 1534exclude_supersets(struct pf_rule *super, struct pf_rule *sub) 1535{ 1536 if (super->ifname[0] == '\0') 1537 memset(sub->ifname, 0, sizeof(sub->ifname)); 1538 if (super->direction == PF_INOUT) 1539 sub->direction = PF_INOUT; 1540 if ((super->proto == 0 || super->proto == sub->proto) && 1541 super->flags == 0 && super->flagset == 0 && (sub->flags || 1542 sub->flagset)) { 1543 sub->flags = super->flags; 1544 sub->flagset = super->flagset; 1545 } 1546 if (super->proto == 0) 1547 sub->proto = 0; 1548 1549 if (super->src.port_op == 0) { 1550 sub->src.port_op = 0; 1551 sub->src.port[0] = 0; 1552 sub->src.port[1] = 0; 1553 } 1554 if (super->dst.port_op == 0) { 1555 sub->dst.port_op = 0; 1556 sub->dst.port[0] = 0; 1557 sub->dst.port[1] = 0; 1558 } 1559 1560 if (super->src.addr.type == PF_ADDR_ADDRMASK && !super->src.neg && 1561 !sub->src.neg && super->src.addr.v.a.mask.addr32[0] == 0 && 1562 super->src.addr.v.a.mask.addr32[1] == 0 && 1563 super->src.addr.v.a.mask.addr32[2] == 0 && 1564 super->src.addr.v.a.mask.addr32[3] == 0) 1565 memset(&sub->src.addr, 0, sizeof(sub->src.addr)); 1566 else if (super->src.addr.type == PF_ADDR_ADDRMASK && 1567 sub->src.addr.type == PF_ADDR_ADDRMASK && 1568 super->src.neg == sub->src.neg && 1569 super->af == sub->af && 1570 unmask(&super->src.addr.v.a.mask, super->af) < 1571 unmask(&sub->src.addr.v.a.mask, sub->af) && 1572 super->src.addr.v.a.addr.addr32[0] == 1573 (sub->src.addr.v.a.addr.addr32[0] & 1574 super->src.addr.v.a.mask.addr32[0]) && 1575 super->src.addr.v.a.addr.addr32[1] == 1576 (sub->src.addr.v.a.addr.addr32[1] & 1577 super->src.addr.v.a.mask.addr32[1]) && 1578 super->src.addr.v.a.addr.addr32[2] == 1579 (sub->src.addr.v.a.addr.addr32[2] & 1580 super->src.addr.v.a.mask.addr32[2]) && 1581 super->src.addr.v.a.addr.addr32[3] == 1582 (sub->src.addr.v.a.addr.addr32[3] & 1583 super->src.addr.v.a.mask.addr32[3])) { 1584 /* sub->src.addr is a subset of super->src.addr/mask */ 1585 memcpy(&sub->src.addr, &super->src.addr, sizeof(sub->src.addr)); 1586 } 1587 1588 if (super->dst.addr.type == PF_ADDR_ADDRMASK && !super->dst.neg && 1589 !sub->dst.neg && super->dst.addr.v.a.mask.addr32[0] == 0 && 1590 super->dst.addr.v.a.mask.addr32[1] == 0 && 1591 super->dst.addr.v.a.mask.addr32[2] == 0 && 1592 super->dst.addr.v.a.mask.addr32[3] == 0) 1593 memset(&sub->dst.addr, 0, sizeof(sub->dst.addr)); 1594 else if (super->dst.addr.type == PF_ADDR_ADDRMASK && 1595 sub->dst.addr.type == PF_ADDR_ADDRMASK && 1596 super->dst.neg == sub->dst.neg && 1597 super->af == sub->af && 1598 unmask(&super->dst.addr.v.a.mask, super->af) < 1599 unmask(&sub->dst.addr.v.a.mask, sub->af) && 1600 super->dst.addr.v.a.addr.addr32[0] == 1601 (sub->dst.addr.v.a.addr.addr32[0] & 1602 super->dst.addr.v.a.mask.addr32[0]) && 1603 super->dst.addr.v.a.addr.addr32[1] == 1604 (sub->dst.addr.v.a.addr.addr32[1] & 1605 super->dst.addr.v.a.mask.addr32[1]) && 1606 super->dst.addr.v.a.addr.addr32[2] == 1607 (sub->dst.addr.v.a.addr.addr32[2] & 1608 super->dst.addr.v.a.mask.addr32[2]) && 1609 super->dst.addr.v.a.addr.addr32[3] == 1610 (sub->dst.addr.v.a.addr.addr32[3] & 1611 super->dst.addr.v.a.mask.addr32[3])) { 1612 /* sub->dst.addr is a subset of super->dst.addr/mask */ 1613 memcpy(&sub->dst.addr, &super->dst.addr, sizeof(sub->dst.addr)); 1614 } 1615 1616 if (super->af == 0) 1617 sub->af = 0; 1618} 1619 1620 1621void 1622superblock_free(struct pfctl *pf, struct superblock *block) 1623{ 1624 struct pf_opt_rule *por; 1625 while ((por = TAILQ_FIRST(&block->sb_rules))) { 1626 TAILQ_REMOVE(&block->sb_rules, por, por_entry); 1627 if (por->por_src_tbl) { 1628 if (por->por_src_tbl->pt_buf) { 1629 pfr_buf_clear(por->por_src_tbl->pt_buf); 1630 free(por->por_src_tbl->pt_buf); 1631 } 1632 free(por->por_src_tbl); 1633 } 1634 if (por->por_dst_tbl) { 1635 if (por->por_dst_tbl->pt_buf) { 1636 pfr_buf_clear(por->por_dst_tbl->pt_buf); 1637 free(por->por_dst_tbl->pt_buf); 1638 } 1639 free(por->por_dst_tbl); 1640 } 1641 free(por); 1642 } 1643 if (block->sb_profiled_block) 1644 superblock_free(pf, block->sb_profiled_block); 1645 free(block); 1646} 1647 1648