]> git.ipfire.org Git - thirdparty/bird.git/blobdiff - filter/trie.c
Merge branch 'master' into mq-filter-stack
[thirdparty/bird.git] / filter / trie.c
index ffb9b99fbd99415905a1982633bcbfb24603df51..3038f5ecf2aca9f4f53ea01cefd4c10feebd7a8b 100644 (file)
  * indicates the index of the bit in the address that is used to
  * branch at the node. If we need to represent just a set of
  * prefixes, it would be simple, but we have to represent a
- * set of prefix pattern. Each prefix pattern consists of
+ * set of prefix patterns. Each prefix pattern consists of
  * &ppaddr/&pplen and two integers: &low and &high, and a prefix
  * &paddr/&plen matches that pattern if the first MIN(&plen, &pplen)
  * bits of &paddr and &ppaddr are the same and &low <= &plen <= &high.
  *
  * We use a bitmask (&accept) to represent accepted prefix lengths
  * at a node. As there are 33 prefix lengths (0..32 for IPv4), but
- * there is just one prefix of zero length in the whole trie so we 
+ * there is just one prefix of zero length in the whole trie so we
  * have &zero flag in &f_trie (indicating whether the trie accepts
  * prefix 0.0.0.0/0) as a special case, and &accept bitmask
  * represents accepted prefix lengths from 1 to 32.
  * - we are beyond the end of path (node length > &plen)
  * - we are still on path and keep walking (node length < &plen)
  *
- * The walking code in add_node_to_trie() and trie_match_prefix()
- * is structured according to these cases.
+ * The walking code in trie_match_prefix() is structured according to
+ * these cases.
  */
 
 #include "nest/bird.h"
+#include "lib/string.h"
 #include "conf/conf.h"
 #include "filter/filter.h"
+#include "filter/data.h"
+
+
+/*
+ * In the trie code, the prefix length is internally treated as for the whole
+ * ip_addr, regardless whether it contains an IPv4 or IPv6 address. Therefore,
+ * remaining definitions make sense.
+ */
+
+#define ipa_mkmask(x) ip6_mkmask(x)
+#define ipa_masklen(x) ip6_masklen(&x)
+#define ipa_pxlen(x,y) ip6_pxlen(x,y)
+#define ipa_getbit(x,n) ip6_getbit(x,n)
+
 
 /**
- * f_new_trie
- *
- * Allocates and returns a new empty trie.
+ * f_new_trie - allocates and returns a new empty trie
+ * @lp: linear pool to allocate items from
+ * @node_size: node size to be used (&f_trie_node and user data)
  */
 struct f_trie *
-f_new_trie(void)
+f_new_trie(linpool *lp, uint node_size)
 {
   struct f_trie * ret;
-  ret = cfg_allocz(sizeof(struct f_trie));
+  ret = lp_allocz(lp, sizeof(struct f_trie) + node_size);
+  ret->lp = lp;
+  ret->node_size = node_size;
   return ret;
 }
 
 static inline struct f_trie_node *
-new_node(int plen, ip_addr paddr, ip_addr pmask, ip_addr amask)
+new_node(struct f_trie *t, int plen, ip_addr paddr, ip_addr pmask, ip_addr amask)
 {
-  struct f_trie_node *n = cfg_allocz(sizeof(struct f_trie_node));
+  struct f_trie_node *n = lp_allocz(t->lp, t->node_size);
   n->plen = plen;
   n->addr = paddr;
   n->mask = pmask;
@@ -103,15 +120,51 @@ attach_node(struct f_trie_node *parent, struct f_trie_node *child)
   parent->c[ipa_getbit(child->addr, parent->plen) ? 1 : 0] = child;
 }
 
-static void
-add_node_to_trie(struct f_trie *t, int plen, ip_addr ip, ip_addr amask)
+/**
+ * trie_add_prefix
+ * @t: trie to add to
+ * @net: IP network prefix
+ * @l: prefix lower bound
+ * @h: prefix upper bound
+ *
+ * Adds prefix (prefix pattern) @n to trie @t.  @l and @h are lower
+ * and upper bounds on accepted prefix lengths, both inclusive.
+ * 0 <= l, h <= 32 (128 for IPv6).
+ *
+ * Returns a pointer to the allocated node. The function can return a pointer to
+ * an existing node if @px and @plen are the same. If px/plen == 0/0 (or ::/0),
+ * a pointer to the root node is returned.
+ */
+
+void *
+trie_add_prefix(struct f_trie *t, const net_addr *net, uint l, uint h)
 {
+  ip_addr px = net_prefix(net);
+  uint plen = net_pxlen(net);
+
+  if (net->type == NET_IP4)
+  {
+    const uint delta = IP6_MAX_PREFIX_LENGTH - IP4_MAX_PREFIX_LENGTH;
+    plen += delta;
+    l += delta;
+    h += delta;
+  }
+
+  if (l == 0)
+    t->zero = 1;
+  else
+    l--;
+
+  if (h < plen)
+    plen = h;
+
+  ip_addr amask = ipa_xor(ipa_mkmask(l), ipa_mkmask(h));
   ip_addr pmask = ipa_mkmask(plen);
-  ip_addr paddr = ipa_and(ip, pmask);
+  ip_addr paddr = ipa_and(px, pmask);
   struct f_trie_node *o = NULL;
-  struct f_trie_node *n = &t->root;
+  struct f_trie_node *n = t->root;
 
-  while(n)
+  while (n)
     {
       ip_addr cmask = ipa_and(n->mask, pmask);
 
@@ -122,98 +175,62 @@ add_node_to_trie(struct f_trie *t, int plen, ip_addr ip, ip_addr amask)
             as the other child of 'b'. */
          int blen = ipa_pxlen(paddr, n->addr);
          ip_addr bmask = ipa_mkmask(blen);
-         ip_addr baddr = ipa_and(ip, bmask);
+         ip_addr baddr = ipa_and(px, bmask);
 
          /* Merge accept masks from children to get accept mask for node 'b' */
          ip_addr baccm = ipa_and(ipa_or(amask, n->accept), bmask);
 
-         struct f_trie_node *a = new_node(plen, paddr, pmask, amask);
-         struct f_trie_node *b = new_node(blen, baddr, bmask, baccm);
+         struct f_trie_node *a = new_node(t, plen, paddr, pmask, amask);
+         struct f_trie_node *b = new_node(t, blen, baddr, bmask, baccm);
          attach_node(o, b);
          attach_node(b, n);
          attach_node(b, a);
-         return;
+         return a;
        }
 
       if (plen < n->plen)
        {
          /* We add new node 'a' between node 'o' and node 'n' */
          amask = ipa_or(amask, ipa_and(n->accept, pmask));
-         struct f_trie_node *a = new_node(plen, paddr, pmask, amask);
+         struct f_trie_node *a = new_node(t, plen, paddr, pmask, amask);
          attach_node(o, a);
          attach_node(a, n);
-         return;
+         return a;
        }
-       
+
       if (plen == n->plen)
        {
          /* We already found added node in trie. Just update accept mask */
          n->accept = ipa_or(n->accept, amask);
-         return;
+         return n;
        }
 
       /* Update accept mask part M2 and go deeper */
       n->accept = ipa_or(n->accept, ipa_and(amask, n->mask));
 
-      /* n->plen < plen and plen <= 32 */
+      /* n->plen < plen and plen <= 32 (128) */
       o = n;
       n = n->c[ipa_getbit(paddr, n->plen) ? 1 : 0];
     }
 
   /* We add new tail node 'a' after node 'o' */
-  struct f_trie_node *a = new_node(plen, paddr, pmask, amask);
+  struct f_trie_node *a = new_node(t, plen, paddr, pmask, amask);
   attach_node(o, a);
-}
-
-/**
- * trie_add_prefix
- * @t: trie to add to
- * @px: prefix to add
- *
- * Adds prefix (prefix pattern) @px to trie @t.
- */
-void
-trie_add_prefix(struct f_trie *t, struct f_prefix *px)
-{
-  int l, h;
-  int plen = px->len & LEN_MASK;
-  ip_addr pmask = ipa_mkmask(plen);
-
-  /* 'l' and 'h' are lower and upper bounds on accepted
-     prefix lengths, both inclusive. 0 <= l, h <= 32 */
-  f_prefix_get_bounds(px, &l, &h);
-
-  if (l == 0)
-    t->zero = 1;
-  else
-    l--;
 
-  ip_addr amask = ipa_xor(ipa_mkmask(l), ipa_mkmask(h));
-  /* MIN(plen, h) instead of just plen is a little trick. */
-  add_node_to_trie(t, MIN(plen, h), px->ip, amask);
+  return a;
 }
 
-/**
- * trie_match_prefix
- * @t: trie
- * @px: prefix
- *
- * Tries to find a matching prefix pattern in the trie such that
- * prefix @px matches that prefix pattern. Returns 1 if there
- * is such prefix pattern in the trie.
- */
-int
-trie_match_prefix(struct f_trie *t, struct f_prefix *px)
+static int
+trie_match_prefix(const struct f_trie *t, ip_addr px, uint plen)
 {
-  int plen = px->len & LEN_MASK;
   ip_addr pmask = ipa_mkmask(plen);
-  ip_addr paddr = ipa_and(px->ip, pmask);
+  ip_addr paddr = ipa_and(px, pmask);
 
   if (plen == 0)
     return t->zero;
 
   int plentest = plen - 1;
-  struct f_trie_node *n = &t->root;
+  const struct f_trie_node *n = t->root;
 
   while(n)
     {
@@ -238,8 +255,32 @@ trie_match_prefix(struct f_trie *t, struct f_prefix *px)
   return 0;
 }
 
+/**
+ * trie_match_net
+ * @t: trie
+ * @n: net address
+ *
+ * Tries to find a matching net in the trie such that
+ * prefix @n matches that prefix pattern. Returns 1 if there
+ * is such prefix pattern in the trie.
+ */
+int
+trie_match_net(const struct f_trie *t, const net_addr *n)
+{
+  uint add = 0;
+
+  switch (n->type) {
+    case NET_IP4:
+    case NET_VPN4:
+    case NET_ROA4:
+      add = IP6_MAX_PREFIX_LENGTH - IP4_MAX_PREFIX_LENGTH;
+  }
+
+  return trie_match_prefix(t, net_prefix(n), net_pxlen(n) + add);
+}
+
 static int
-trie_node_same(struct f_trie_node *t1, struct f_trie_node *t2)
+trie_node_same(const struct f_trie_node *t1, const struct f_trie_node *t2)
 {
   if ((t1 == NULL) && (t2 == NULL))
     return 1;
@@ -263,58 +304,46 @@ trie_node_same(struct f_trie_node *t1, struct f_trie_node *t2)
  * Compares two tries and returns 1 if they are same
  */
 int
-trie_same(struct f_trie *t1, struct f_trie *t2)
+trie_same(const struct f_trie *t1, const struct f_trie *t2)
 {
-  return (t1->zero == t2->zero) && trie_node_same(&t1->root, &t2->root);
+  return (t1->zero == t2->zero) && trie_node_same(t1->root, t2->root);
 }
 
-static int
-trie_node_print(struct f_trie_node *t, char *buf, int blen)
+static void
+trie_node_format(const struct f_trie_node *t, buffer *buf)
 {
   if (t == NULL)
     return;
 
-  int old_blen = blen;
-  int wb = 0; // bsnprintf(buf, blen, "%I/%d accept %I\n", t->addr, t->plen, t->accept);
-debug("%I/%d accept %I\n", t->addr, t->plen, t->accept);
-
-  if ((wb < 0) || ((blen - wb) < 10))
-    {
-      bsnprintf(buf, blen, "...\n");
-      return -1;
-    }
-
-  buf += wb;
-  blen -= wb;
-
-  wb = trie_node_print(t->c[0], buf, blen);
-  if (wb < 0)
-    return -1;
-
-  buf += wb;
-  blen -= wb;
+  if (ipa_nonzero(t->accept))
+    buffer_print(buf, "%I/%d{%I}, ", t->addr, t->plen, t->accept);
 
-  wb = trie_node_print(t->c[1], buf, blen);
-  if (wb < 0)
-    return -1;
-
-  blen -= wb;
-
-  return (old_blen - blen);
+  trie_node_format(t->c[0], buf);
+  trie_node_format(t->c[1], buf);
 }
 
 /**
- * trie_print
- * @t: trie to be printed
- * @buf: buffer
- * @blen: buffer length
+ * trie_format
+ * @t: trie to be formatted
+ * @buf: destination buffer
  *
- * Prints the trie to the buffer, using at most blen bytes.
- * Returns the number of used bytes, or -1 if there is not
- * enough space in the buffer.
+ * Prints the trie to the supplied buffer.
  */
-int
-trie_print(struct f_trie *t, char *buf, int blen)
+void
+trie_format(const struct f_trie *t, buffer *buf)
 {
-  return trie_node_print(&t->root, buf, blen);
+  buffer_puts(buf, "[");
+
+  if (t->zero)
+    buffer_print(buf, "%I/%d, ", IPA_NONE, 0);
+  trie_node_format(t->root, buf);
+
+  if (buf->pos == buf->end)
+    return;
+
+  /* Undo last separator */
+  if (buf->pos[-1] != '[')
+    buf->pos -= 2;
+
+  buffer_puts(buf, "]");
 }