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