src/plugins/acl/hash_lookup.md

   1 ACL plugin constant-time lookup design
   2 ======================================
   3
   4 The initial implementation of ACL plugin performs a trivial for() cycle,
   5 going through the assigned ACLs on a per-packet basis. This is not very
   6 efficient, even if for very short ACLs due to its simplicity it can beat
   7 more advanced methods.
   8
   9 However, to cover the case of longer ACLs with acceptable performance,
  10 we need to have a better way of matching. This write-up proposes
  11 a mechanism to make a lookup from O(M) where M is number of entries
  12 to O(N) where N is number of different mask combinations.
  13
  14 Preparation of ACL(s)
  15 ---------------------
  16
  17 The ACL plugin will maintain a global list of "mask types", i.e. the specific
  18 configurations of "do not care" bits within the ACEs.
  19 Upon the creation of a new ACL, a pass will be made through all the
  20 ACEs, to assign and possibly allocate the "mask type number".
  21
  22 Each ACL has a structure *hash_acl_info_t* representing the "hash-based"
  23 parts of information related to that ACL, primarily the array of
  24 *hash_ace_info_t* structures - each of the members of that array
  25 corresponding to one of the rules (ACEs) in the original ACL,
  26 for this they have a pair of *(acl_index, ace_index)* to keep track,
  27 predominantly for the debugging.
  28
  29 Why do we need a whole separate structure, and are not adding new fields
  30 to the existing rile structure ? First, encapsulation, to minimize
  31 the pollution of the main ACL code with the hash-based lookup artifacts.
  32
  33 Second, one rule may correspond to more than one "hash-based" ACE.
  34 In fact, most of the rules do correspond to two of those. Why ?
  35
  36 Consider that the current ACL lookup logic is that if a packet
  37 is not the initial fragment, and there is an L4 entry acting on the packet,
  38 the comparison will be made only on the L4 protocol field value rather
  39 than on the protocol and port values. This beaviour is governed by
  40 *l4_match_nonfirst_fragment* flag in the *acl_main*, and was needed to
  41 maintain the compatibility with the existing software switch implementation.
  42
  43 While for the sequential check in *single_acl_match_5tuple()*
  44 it is very easy to implement by just breaking out at the right moment,
  45 in case of hash-based matching this cost us two checks:
  46 one on full 5-tuple and the flag *pkt.is_nonfirst_fragment* being zero,
  47 the second on 3-tuple and the flag *pkt.is_nonfirst_fragment* being one,
  48 with the second check triggered by the *acl_main.l4_match_nonfirst_fragment*
  49 setting being the default 1. This dictates the necessity of having a "match"
  50 field in a given *hash_ace_info_t* element, which would reflect the value
  51 we are supposed to match after applying the mask.
  52
  53 There can be other circumstances when it might be beneficial to expand
  54 the given rule in the original ACL into multiple - for example, as an
  55 optimization within the port range handling for small port ranges
  56 (this is not done as of the time of writing).
  57
  58 Assigning ACLs to an interface
  59 ------------------------------
  60
  61 Once the ACL list is assigned to an interface, or, rather, a new ACL
  62 is added to the list of the existing ACLs applied to the interface,
  63 we need to update the bihash accelerating the lookup.
  64
  65 All the entries for the lookups are stored within a single *48_8* bihash,
  66 which captures the 5-tuple from the packet as well as the miscellaneous
  67 per-packet information flags, e.g. *l4_valid*, *is_non_first_fragment*,
  68 and so on. To facilitate the use of the single bihash by all the interfaces,
  69 the *is_ip6*, *is_input*, *sw_if_index* are part of the key,
  70 as well as *mask_type_index* - the latter being necessary because
  71 there can be entries with the same value but different masks, e.g.:
  72 `permit ::/0, permit::/128`.
  73
  74 At the moment of an ACL being applied to an interface, we need to
  75 walk the list of *hash_ace_info_t* entries corresponding to that ACL,
  76 and update the bihash with the keys corresponding to the match
  77 values in these entries.
  78
  79 The value of the hash match contains the index into a per-*sw_if_index* vector
  80 of *applied_ace_hash_entry_t* elements, as well as a couple of flags:
  81 *shadowed* (optimization: if this flag on a matched entry is zero, means
  82 we can stop the lookup early and declare a match - see below),
  83 and *need_portrange_check* - meaning that what matched was a superset
  84 of the actual match, and we need to perform an extra check.
  85
  86 Also, upon insertion, we must keep in mind there can be
  87 multiple *applied_ace_hash_entry_t* for the same key and must keep
  88 a list of those. This is necessary to incrementally apply/unapply
  89 the ACLs as part of the ACL vector: say, two ACLs have
  90 "permit 2001:db8::1/128 any" - we should be able to retain the entry
  91 for the second ACL even if we have deleted the first one.
  92 Also, in case there are two entries with the same key but
  93 different port ranges, say 0..42 and 142..65535 - we need
  94 to be able to sequentially match on those if we decide not
  95 to expand them into individual port-specific entries.
  96
  97 Per-packet lookup
  98 -----------------
  99
 100 The simple single-packet lookup is defined in
 101 *multi_acl_match_get_applied_ace_index*, which returns the index
 102 of the applied hash ACE if there was a match, or ~0 if there wasn't.
 103
 104 The future optimized per-packet lookup may be batched in three phases:
 105
 106 1. Prepare the keys in the per-worker vector by doing logical AND of
 107    original 5-tuple record with the elements of the mask vector.
 108 2. Lookup the keys in the bihash in a batch manner, collecting the
 109    result with lowest u64 (acl index within vector, ACE index) from
 110    the hash lookup value, and performing the list walk if necessary
 111    (for portranges)
 112 3. Take the action from the ACL record as defined by (ACL#, ACE#) from the
 113    resulting lookup winner, or, if no match found, then perform default deny.
 114
 115 Shadowed/independent/redundant ACEs
 116 ------------------------------------
 117
 118 During the phase of combining multiple ACLs into one rulebase, when they
 119 are applied to interface, we also can perform several optimizations.
 120
 121 If a given ACE is a strict subset of another ACE located up in the linear
 122 search order, we can ignore this ACE completely - because by definition
 123 it will never match. We will call such an ACE *redundant*. Here is an example:
 124
 125 ```
 126 permit 2001:db8:1::/48 2001:db8:2::/48   (B)
 127 deny 2001:d8b:1:1::/64 2001:db8:2:1::/64 (A)
 128 ```
 129
 130 A bit more formally, we can define this relationship of an ACE A to ACE B as:
 131
 132 ```
 133 redundant(aceA, aceB) := (contains(protoB, protoA) && contains(srcB, srcA)
 134                           && contains(dstB, dstA) && is_after(A, B))
 135 ```
 136
 137 Here as "contains" we define an operation operating on the sets defined by
 138 the protocol, (srcIP, srcPortDefinition) and (dstIP, dstPortDefinition)
 139 respectively, and returning true if all the elements represented by
 140 the second argument are represented by the first argument. The "is_after"
 141 is true if A is located below B in the ruleset.
 142
 143 If a given ACE does not intersect at all with any other ACE
 144 in front of it, we can mark it as such.
 145
 146 Then during the sequence of the lookups the successful hit on this ACE means
 147 we do not need to look up other mask combinations - thus potentially
 148 significantly speeding up the match process. Here is an example,
 149 assuming we have the following ACL:
 150
 151 ```
 152 permit 2001:db8:1::/48 2001:db8:2::/48    (B)
 153 deny 2001:db8:3::/48 2001:db8:2:1::/64    (A)
 154 ```
 155
 156 In this case if we match the second entry, we do not need to check whether
 157 we have matched the first one - the source addresses are completely
 158 different. We call such an ACE *independent* from another.
 159
 160 We can define this as
 161
 162 ```
 163 independent(aceA, aceB) := (!intersect(protoA, protoB) ||
 164                             !intersect(srcA, srcB) ||
 165                             !intersect(dstA, dstB))
 166 ```
 167
 168 where intersect is defined as operation returning true if there are
 169 elements belonging to the sets of both arguments.
 170
 171 If the entry A is neither redundant nor independent from B, and is below
 172 B in the ruleset, we call such an entry *shadowed* by B, here is an example:
 173
 174 ```
 175 deny tcp 2001:db8:1::/48 2001:db8:2::/48         (B)
 176 permit 2001:d8b:1:1::/64 2001:db8:2:1::/64    (A)
 177 ```
 178
 179 This means the earlier rule "carves out" a subset of A, thus leaving
 180 a "shadow". (Evidently, the action needs to be different for the shadow
 181 to have an effect, but for for the terminology sake we do not care).
 182
 183 The more formal definition:
 184
 185 ```
 186 shadowed(aceA, aceB) := !redundante(aceA, aceB) &&
 187                         !independent(aceA, aceB) &&
 188                         is_after(aceA, aceB)
 189 ```
 190
 191 Using this terminology, any ruleset can be represented as
 192 a DAG (Directed Acyclic Graph), with the bottom being the implicit
 193 "deny any", pointing to the set of rules shadowing it or the ones
 194 it is redundant for.
 195
 196 These rules may in turn be shadowing each other. There is no cycles in
 197 this graph because of the natural order of the rules - the rule located
 198 closer to the end of the ruleset can never shadow or make redundant a rule
 199 higher up.
 200
 201 The optimization that enables can allow for is to skip matching certain
 202 masks on a per-lookup basis - if a given rule has matched,
 203 the only adjustments that can happen is the match with one of
 204 the shadowing rules.
 205
 206 Also, another avenue for the optimization can be starting the lookup process
 207 with the mask type that maximizes the chances of the independent ACE match,
 208 thus resulting in an ACE lookup being a single hash table hit.
 209
 210
 211 Plumbing
 212 --------
 213
 214 All the new routines are located in a separate file,
 215 so we can cleanly experiment with a different approach if this
 216 does not fit all of the use cases.
 217
 218 The constant-time lookup within the data path has the API with
 219 the same signature as:
 220
 221 ```
 222 u8
 223 multi_acl_match_5tuple (u32 sw_if_index, fa_5tuple_t * pkt_5tuple, int is_l2,
 224                        int is_ip6, int is_input, u32 * acl_match_p,
 225                        u32 * rule_match_p, u32 * trace_bitmap)
 226 ```
 227
 228 There should be a new upper-level function with the same signature, which
 229 will make a decision whether to use a linear lookup, or to use the
 230 constant-time lookup implemented by this work, or to add some other
 231 optimizations (e.g. by keeping the cache of the last N lookups).
 232
 233 The calls to the routine doing preparatory work should happen
 234 in `acl_add_list()` after creating the linear-lookup structures,
 235 and the routine doing the preparatory work populating the hashtable
 236 should be called from `acl_interface_add_del_inout_acl()` or its callees.
 237
 238 The initial implementation will be geared towards looking up a single
 239 match at a time, with the subsequent optimizations possible to make
 240 the lookup for more than one packet.
 241