f95b3844162e18065af2b0942accedaded041590
[platform/kernel/linux-starfive.git] / net / netfilter / nft_set_pipapo.c
1 // SPDX-License-Identifier: GPL-2.0-only
2
3 /* PIPAPO: PIle PAcket POlicies: set for arbitrary concatenations of ranges
4  *
5  * Copyright (c) 2019-2020 Red Hat GmbH
6  *
7  * Author: Stefano Brivio <sbrivio@redhat.com>
8  */
9
10 /**
11  * DOC: Theory of Operation
12  *
13  *
14  * Problem
15  * -------
16  *
17  * Match packet bytes against entries composed of ranged or non-ranged packet
18  * field specifiers, mapping them to arbitrary references. For example:
19  *
20  * ::
21  *
22  *               --- fields --->
23  *      |    [net],[port],[net]... => [reference]
24  *   entries [net],[port],[net]... => [reference]
25  *      |    [net],[port],[net]... => [reference]
26  *      V    ...
27  *
28  * where [net] fields can be IP ranges or netmasks, and [port] fields are port
29  * ranges. Arbitrary packet fields can be matched.
30  *
31  *
32  * Algorithm Overview
33  * ------------------
34  *
35  * This algorithm is loosely inspired by [Ligatti 2010], and fundamentally
36  * relies on the consideration that every contiguous range in a space of b bits
37  * can be converted into b * 2 netmasks, from Theorem 3 in [Rottenstreich 2010],
38  * as also illustrated in Section 9 of [Kogan 2014].
39  *
40  * Classification against a number of entries, that require matching given bits
41  * of a packet field, is performed by grouping those bits in sets of arbitrary
42  * size, and classifying packet bits one group at a time.
43  *
44  * Example:
45  *   to match the source port (16 bits) of a packet, we can divide those 16 bits
46  *   in 4 groups of 4 bits each. Given the entry:
47  *      0000 0001 0101 1001
48  *   and a packet with source port:
49  *      0000 0001 1010 1001
50  *   first and second groups match, but the third doesn't. We conclude that the
51  *   packet doesn't match the given entry.
52  *
53  * Translate the set to a sequence of lookup tables, one per field. Each table
54  * has two dimensions: bit groups to be matched for a single packet field, and
55  * all the possible values of said groups (buckets). Input entries are
56  * represented as one or more rules, depending on the number of composing
57  * netmasks for the given field specifier, and a group match is indicated as a
58  * set bit, with number corresponding to the rule index, in all the buckets
59  * whose value matches the entry for a given group.
60  *
61  * Rules are mapped between fields through an array of x, n pairs, with each
62  * item mapping a matched rule to one or more rules. The position of the pair in
63  * the array indicates the matched rule to be mapped to the next field, x
64  * indicates the first rule index in the next field, and n the amount of
65  * next-field rules the current rule maps to.
66  *
67  * The mapping array for the last field maps to the desired references.
68  *
69  * To match, we perform table lookups using the values of grouped packet bits,
70  * and use a sequence of bitwise operations to progressively evaluate rule
71  * matching.
72  *
73  * A stand-alone, reference implementation, also including notes about possible
74  * future optimisations, is available at:
75  *    https://pipapo.lameexcu.se/
76  *
77  * Insertion
78  * ---------
79  *
80  * - For each packet field:
81  *
82  *   - divide the b packet bits we want to classify into groups of size t,
83  *     obtaining ceil(b / t) groups
84  *
85  *      Example: match on destination IP address, with t = 4: 32 bits, 8 groups
86  *      of 4 bits each
87  *
88  *   - allocate a lookup table with one column ("bucket") for each possible
89  *     value of a group, and with one row for each group
90  *
91  *      Example: 8 groups, 2^4 buckets:
92  *
93  * ::
94  *
95  *                     bucket
96  *      group  0   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15
97  *        0
98  *        1
99  *        2
100  *        3
101  *        4
102  *        5
103  *        6
104  *        7
105  *
106  *   - map the bits we want to classify for the current field, for a given
107  *     entry, to a single rule for non-ranged and netmask set items, and to one
108  *     or multiple rules for ranges. Ranges are expanded to composing netmasks
109  *     by pipapo_expand().
110  *
111  *      Example: 2 entries, 10.0.0.5:1024 and 192.168.1.0-192.168.2.1:2048
112  *      - rule #0: 10.0.0.5
113  *      - rule #1: 192.168.1.0/24
114  *      - rule #2: 192.168.2.0/31
115  *
116  *   - insert references to the rules in the lookup table, selecting buckets
117  *     according to bit values of a rule in the given group. This is done by
118  *     pipapo_insert().
119  *
120  *      Example: given:
121  *      - rule #0: 10.0.0.5 mapping to buckets
122  *        < 0 10  0 0   0 0  0 5 >
123  *      - rule #1: 192.168.1.0/24 mapping to buckets
124  *        < 12 0  10 8  0 1  < 0..15 > < 0..15 > >
125  *      - rule #2: 192.168.2.0/31 mapping to buckets
126  *        < 12 0  10 8  0 2  0 < 0..1 > >
127  *
128  *      these bits are set in the lookup table:
129  *
130  * ::
131  *
132  *                     bucket
133  *      group  0   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15
134  *        0    0                                              1,2
135  *        1   1,2                                      0
136  *        2    0                                      1,2
137  *        3    0                              1,2
138  *        4  0,1,2
139  *        5    0   1   2
140  *        6  0,1,2 1   1   1   1   1   1   1   1   1   1   1   1   1   1   1
141  *        7   1,2 1,2  1   1   1  0,1  1   1   1   1   1   1   1   1   1   1
142  *
143  *   - if this is not the last field in the set, fill a mapping array that maps
144  *     rules from the lookup table to rules belonging to the same entry in
145  *     the next lookup table, done by pipapo_map().
146  *
147  *     Note that as rules map to contiguous ranges of rules, given how netmask
148  *     expansion and insertion is performed, &union nft_pipapo_map_bucket stores
149  *     this information as pairs of first rule index, rule count.
150  *
151  *      Example: 2 entries, 10.0.0.5:1024 and 192.168.1.0-192.168.2.1:2048,
152  *      given lookup table #0 for field 0 (see example above):
153  *
154  * ::
155  *
156  *                     bucket
157  *      group  0   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15
158  *        0    0                                              1,2
159  *        1   1,2                                      0
160  *        2    0                                      1,2
161  *        3    0                              1,2
162  *        4  0,1,2
163  *        5    0   1   2
164  *        6  0,1,2 1   1   1   1   1   1   1   1   1   1   1   1   1   1   1
165  *        7   1,2 1,2  1   1   1  0,1  1   1   1   1   1   1   1   1   1   1
166  *
167  *      and lookup table #1 for field 1 with:
168  *      - rule #0: 1024 mapping to buckets
169  *        < 0  0  4  0 >
170  *      - rule #1: 2048 mapping to buckets
171  *        < 0  0  5  0 >
172  *
173  * ::
174  *
175  *                     bucket
176  *      group  0   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15
177  *        0   0,1
178  *        1   0,1
179  *        2                    0   1
180  *        3   0,1
181  *
182  *      we need to map rules for 10.0.0.5 in lookup table #0 (rule #0) to 1024
183  *      in lookup table #1 (rule #0) and rules for 192.168.1.0-192.168.2.1
184  *      (rules #1, #2) to 2048 in lookup table #2 (rule #1):
185  *
186  * ::
187  *
188  *       rule indices in current field: 0    1    2
189  *       map to rules in next field:    0    1    1
190  *
191  *   - if this is the last field in the set, fill a mapping array that maps
192  *     rules from the last lookup table to element pointers, also done by
193  *     pipapo_map().
194  *
195  *     Note that, in this implementation, we have two elements (start, end) for
196  *     each entry. The pointer to the end element is stored in this array, and
197  *     the pointer to the start element is linked from it.
198  *
199  *      Example: entry 10.0.0.5:1024 has a corresponding &struct nft_pipapo_elem
200  *      pointer, 0x66, and element for 192.168.1.0-192.168.2.1:2048 is at 0x42.
201  *      From the rules of lookup table #1 as mapped above:
202  *
203  * ::
204  *
205  *       rule indices in last field:    0    1
206  *       map to elements:             0x66  0x42
207  *
208  *
209  * Matching
210  * --------
211  *
212  * We use a result bitmap, with the size of a single lookup table bucket, to
213  * represent the matching state that applies at every algorithm step. This is
214  * done by pipapo_lookup().
215  *
216  * - For each packet field:
217  *
218  *   - start with an all-ones result bitmap (res_map in pipapo_lookup())
219  *
220  *   - perform a lookup into the table corresponding to the current field,
221  *     for each group, and at every group, AND the current result bitmap with
222  *     the value from the lookup table bucket
223  *
224  * ::
225  *
226  *      Example: 192.168.1.5 < 12 0  10 8  0 1  0 5 >, with lookup table from
227  *      insertion examples.
228  *      Lookup table buckets are at least 3 bits wide, we'll assume 8 bits for
229  *      convenience in this example. Initial result bitmap is 0xff, the steps
230  *      below show the value of the result bitmap after each group is processed:
231  *
232  *                     bucket
233  *      group  0   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15
234  *        0    0                                              1,2
235  *        result bitmap is now: 0xff & 0x6 [bucket 12] = 0x6
236  *
237  *        1   1,2                                      0
238  *        result bitmap is now: 0x6 & 0x6 [bucket 0] = 0x6
239  *
240  *        2    0                                      1,2
241  *        result bitmap is now: 0x6 & 0x6 [bucket 10] = 0x6
242  *
243  *        3    0                              1,2
244  *        result bitmap is now: 0x6 & 0x6 [bucket 8] = 0x6
245  *
246  *        4  0,1,2
247  *        result bitmap is now: 0x6 & 0x7 [bucket 0] = 0x6
248  *
249  *        5    0   1   2
250  *        result bitmap is now: 0x6 & 0x2 [bucket 1] = 0x2
251  *
252  *        6  0,1,2 1   1   1   1   1   1   1   1   1   1   1   1   1   1   1
253  *        result bitmap is now: 0x2 & 0x7 [bucket 0] = 0x2
254  *
255  *        7   1,2 1,2  1   1   1  0,1  1   1   1   1   1   1   1   1   1   1
256  *        final result bitmap for this field is: 0x2 & 0x3 [bucket 5] = 0x2
257  *
258  *   - at the next field, start with a new, all-zeroes result bitmap. For each
259  *     bit set in the previous result bitmap, fill the new result bitmap
260  *     (fill_map in pipapo_lookup()) with the rule indices from the
261  *     corresponding buckets of the mapping field for this field, done by
262  *     pipapo_refill()
263  *
264  *      Example: with mapping table from insertion examples, with the current
265  *      result bitmap from the previous example, 0x02:
266  *
267  * ::
268  *
269  *       rule indices in current field: 0    1    2
270  *       map to rules in next field:    0    1    1
271  *
272  *      the new result bitmap will be 0x02: rule 1 was set, and rule 1 will be
273  *      set.
274  *
275  *      We can now extend this example to cover the second iteration of the step
276  *      above (lookup and AND bitmap): assuming the port field is
277  *      2048 < 0  0  5  0 >, with starting result bitmap 0x2, and lookup table
278  *      for "port" field from pre-computation example:
279  *
280  * ::
281  *
282  *                     bucket
283  *      group  0   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15
284  *        0   0,1
285  *        1   0,1
286  *        2                    0   1
287  *        3   0,1
288  *
289  *       operations are: 0x2 & 0x3 [bucket 0] & 0x3 [bucket 0] & 0x2 [bucket 5]
290  *       & 0x3 [bucket 0], resulting bitmap is 0x2.
291  *
292  *   - if this is the last field in the set, look up the value from the mapping
293  *     array corresponding to the final result bitmap
294  *
295  *      Example: 0x2 resulting bitmap from 192.168.1.5:2048, mapping array for
296  *      last field from insertion example:
297  *
298  * ::
299  *
300  *       rule indices in last field:    0    1
301  *       map to elements:             0x66  0x42
302  *
303  *      the matching element is at 0x42.
304  *
305  *
306  * References
307  * ----------
308  *
309  * [Ligatti 2010]
310  *      A Packet-classification Algorithm for Arbitrary Bitmask Rules, with
311  *      Automatic Time-space Tradeoffs
312  *      Jay Ligatti, Josh Kuhn, and Chris Gage.
313  *      Proceedings of the IEEE International Conference on Computer
314  *      Communication Networks (ICCCN), August 2010.
315  *      https://www.cse.usf.edu/~ligatti/papers/grouper-conf.pdf
316  *
317  * [Rottenstreich 2010]
318  *      Worst-Case TCAM Rule Expansion
319  *      Ori Rottenstreich and Isaac Keslassy.
320  *      2010 Proceedings IEEE INFOCOM, San Diego, CA, 2010.
321  *      http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.212.4592&rep=rep1&type=pdf
322  *
323  * [Kogan 2014]
324  *      SAX-PAC (Scalable And eXpressive PAcket Classification)
325  *      Kirill Kogan, Sergey Nikolenko, Ori Rottenstreich, William Culhane,
326  *      and Patrick Eugster.
327  *      Proceedings of the 2014 ACM conference on SIGCOMM, August 2014.
328  *      https://www.sigcomm.org/sites/default/files/ccr/papers/2014/August/2619239-2626294.pdf
329  */
330
331 #include <linux/kernel.h>
332 #include <linux/init.h>
333 #include <linux/module.h>
334 #include <linux/netlink.h>
335 #include <linux/netfilter.h>
336 #include <linux/netfilter/nf_tables.h>
337 #include <net/netfilter/nf_tables_core.h>
338 #include <uapi/linux/netfilter/nf_tables.h>
339 #include <linux/bitmap.h>
340 #include <linux/bitops.h>
341
342 #include "nft_set_pipapo_avx2.h"
343 #include "nft_set_pipapo.h"
344
345 /* Current working bitmap index, toggled between field matches */
346 static DEFINE_PER_CPU(bool, nft_pipapo_scratch_index);
347
348 /**
349  * pipapo_refill() - For each set bit, set bits from selected mapping table item
350  * @map:        Bitmap to be scanned for set bits
351  * @len:        Length of bitmap in longs
352  * @rules:      Number of rules in field
353  * @dst:        Destination bitmap
354  * @mt:         Mapping table containing bit set specifiers
355  * @match_only: Find a single bit and return, don't fill
356  *
357  * Iteration over set bits with __builtin_ctzl(): Daniel Lemire, public domain.
358  *
359  * For each bit set in map, select the bucket from mapping table with index
360  * corresponding to the position of the bit set. Use start bit and amount of
361  * bits specified in bucket to fill region in dst.
362  *
363  * Return: -1 on no match, bit position on 'match_only', 0 otherwise.
364  */
365 int pipapo_refill(unsigned long *map, int len, int rules, unsigned long *dst,
366                   union nft_pipapo_map_bucket *mt, bool match_only)
367 {
368         unsigned long bitset;
369         int k, ret = -1;
370
371         for (k = 0; k < len; k++) {
372                 bitset = map[k];
373                 while (bitset) {
374                         unsigned long t = bitset & -bitset;
375                         int r = __builtin_ctzl(bitset);
376                         int i = k * BITS_PER_LONG + r;
377
378                         if (unlikely(i >= rules)) {
379                                 map[k] = 0;
380                                 return -1;
381                         }
382
383                         if (match_only) {
384                                 bitmap_clear(map, i, 1);
385                                 return i;
386                         }
387
388                         ret = 0;
389
390                         bitmap_set(dst, mt[i].to, mt[i].n);
391
392                         bitset ^= t;
393                 }
394                 map[k] = 0;
395         }
396
397         return ret;
398 }
399
400 /**
401  * nft_pipapo_lookup() - Lookup function
402  * @net:        Network namespace
403  * @set:        nftables API set representation
404  * @key:        nftables API element representation containing key data
405  * @ext:        nftables API extension pointer, filled with matching reference
406  *
407  * For more details, see DOC: Theory of Operation.
408  *
409  * Return: true on match, false otherwise.
410  */
411 bool nft_pipapo_lookup(const struct net *net, const struct nft_set *set,
412                        const u32 *key, const struct nft_set_ext **ext)
413 {
414         struct nft_pipapo *priv = nft_set_priv(set);
415         unsigned long *res_map, *fill_map;
416         u8 genmask = nft_genmask_cur(net);
417         const u8 *rp = (const u8 *)key;
418         struct nft_pipapo_match *m;
419         struct nft_pipapo_field *f;
420         bool map_index;
421         int i;
422
423         local_bh_disable();
424
425         map_index = raw_cpu_read(nft_pipapo_scratch_index);
426
427         m = rcu_dereference(priv->match);
428
429         if (unlikely(!m || !*raw_cpu_ptr(m->scratch)))
430                 goto out;
431
432         res_map  = *raw_cpu_ptr(m->scratch) + (map_index ? m->bsize_max : 0);
433         fill_map = *raw_cpu_ptr(m->scratch) + (map_index ? 0 : m->bsize_max);
434
435         memset(res_map, 0xff, m->bsize_max * sizeof(*res_map));
436
437         nft_pipapo_for_each_field(f, i, m) {
438                 bool last = i == m->field_count - 1;
439                 int b;
440
441                 /* For each bit group: select lookup table bucket depending on
442                  * packet bytes value, then AND bucket value
443                  */
444                 if (likely(f->bb == 8))
445                         pipapo_and_field_buckets_8bit(f, res_map, rp);
446                 else
447                         pipapo_and_field_buckets_4bit(f, res_map, rp);
448                 NFT_PIPAPO_GROUP_BITS_ARE_8_OR_4;
449
450                 rp += f->groups / NFT_PIPAPO_GROUPS_PER_BYTE(f);
451
452                 /* Now populate the bitmap for the next field, unless this is
453                  * the last field, in which case return the matched 'ext'
454                  * pointer if any.
455                  *
456                  * Now res_map contains the matching bitmap, and fill_map is the
457                  * bitmap for the next field.
458                  */
459 next_match:
460                 b = pipapo_refill(res_map, f->bsize, f->rules, fill_map, f->mt,
461                                   last);
462                 if (b < 0) {
463                         raw_cpu_write(nft_pipapo_scratch_index, map_index);
464                         local_bh_enable();
465
466                         return false;
467                 }
468
469                 if (last) {
470                         *ext = &f->mt[b].e->ext;
471                         if (unlikely(nft_set_elem_expired(*ext) ||
472                                      !nft_set_elem_active(*ext, genmask)))
473                                 goto next_match;
474
475                         /* Last field: we're just returning the key without
476                          * filling the initial bitmap for the next field, so the
477                          * current inactive bitmap is clean and can be reused as
478                          * *next* bitmap (not initial) for the next packet.
479                          */
480                         raw_cpu_write(nft_pipapo_scratch_index, map_index);
481                         local_bh_enable();
482
483                         return true;
484                 }
485
486                 /* Swap bitmap indices: res_map is the initial bitmap for the
487                  * next field, and fill_map is guaranteed to be all-zeroes at
488                  * this point.
489                  */
490                 map_index = !map_index;
491                 swap(res_map, fill_map);
492
493                 rp += NFT_PIPAPO_GROUPS_PADDING(f);
494         }
495
496 out:
497         local_bh_enable();
498         return false;
499 }
500
501 /**
502  * pipapo_get() - Get matching element reference given key data
503  * @net:        Network namespace
504  * @set:        nftables API set representation
505  * @data:       Key data to be matched against existing elements
506  * @genmask:    If set, check that element is active in given genmask
507  *
508  * This is essentially the same as the lookup function, except that it matches
509  * key data against the uncommitted copy and doesn't use preallocated maps for
510  * bitmap results.
511  *
512  * Return: pointer to &struct nft_pipapo_elem on match, error pointer otherwise.
513  */
514 static struct nft_pipapo_elem *pipapo_get(const struct net *net,
515                                           const struct nft_set *set,
516                                           const u8 *data, u8 genmask)
517 {
518         struct nft_pipapo_elem *ret = ERR_PTR(-ENOENT);
519         struct nft_pipapo *priv = nft_set_priv(set);
520         struct nft_pipapo_match *m = priv->clone;
521         unsigned long *res_map, *fill_map = NULL;
522         struct nft_pipapo_field *f;
523         int i;
524
525         res_map = kmalloc_array(m->bsize_max, sizeof(*res_map), GFP_ATOMIC);
526         if (!res_map) {
527                 ret = ERR_PTR(-ENOMEM);
528                 goto out;
529         }
530
531         fill_map = kcalloc(m->bsize_max, sizeof(*res_map), GFP_ATOMIC);
532         if (!fill_map) {
533                 ret = ERR_PTR(-ENOMEM);
534                 goto out;
535         }
536
537         memset(res_map, 0xff, m->bsize_max * sizeof(*res_map));
538
539         nft_pipapo_for_each_field(f, i, m) {
540                 bool last = i == m->field_count - 1;
541                 int b;
542
543                 /* For each bit group: select lookup table bucket depending on
544                  * packet bytes value, then AND bucket value
545                  */
546                 if (f->bb == 8)
547                         pipapo_and_field_buckets_8bit(f, res_map, data);
548                 else if (f->bb == 4)
549                         pipapo_and_field_buckets_4bit(f, res_map, data);
550                 else
551                         BUG();
552
553                 data += f->groups / NFT_PIPAPO_GROUPS_PER_BYTE(f);
554
555                 /* Now populate the bitmap for the next field, unless this is
556                  * the last field, in which case return the matched 'ext'
557                  * pointer if any.
558                  *
559                  * Now res_map contains the matching bitmap, and fill_map is the
560                  * bitmap for the next field.
561                  */
562 next_match:
563                 b = pipapo_refill(res_map, f->bsize, f->rules, fill_map, f->mt,
564                                   last);
565                 if (b < 0)
566                         goto out;
567
568                 if (last) {
569                         if ((genmask &&
570                              !nft_set_elem_active(&f->mt[b].e->ext, genmask)))
571                                 goto next_match;
572
573                         ret = f->mt[b].e;
574                         goto out;
575                 }
576
577                 data += NFT_PIPAPO_GROUPS_PADDING(f);
578
579                 /* Swap bitmap indices: fill_map will be the initial bitmap for
580                  * the next field (i.e. the new res_map), and res_map is
581                  * guaranteed to be all-zeroes at this point, ready to be filled
582                  * according to the next mapping table.
583                  */
584                 swap(res_map, fill_map);
585         }
586
587 out:
588         kfree(fill_map);
589         kfree(res_map);
590         return ret;
591 }
592
593 /**
594  * nft_pipapo_get() - Get matching element reference given key data
595  * @net:        Network namespace
596  * @set:        nftables API set representation
597  * @elem:       nftables API element representation containing key data
598  * @flags:      Unused
599  */
600 static void *nft_pipapo_get(const struct net *net, const struct nft_set *set,
601                             const struct nft_set_elem *elem, unsigned int flags)
602 {
603         struct nft_pipapo_elem *ret;
604
605         ret = pipapo_get(net, set, (const u8 *)elem->key.val.data,
606                          nft_genmask_cur(net));
607         if (IS_ERR(ret))
608                 return ret;
609
610         if (nft_set_elem_expired(&ret->ext))
611                 return ERR_PTR(-ENOENT);
612
613         return ret;
614 }
615
616 /**
617  * pipapo_resize() - Resize lookup or mapping table, or both
618  * @f:          Field containing lookup and mapping tables
619  * @old_rules:  Previous amount of rules in field
620  * @rules:      New amount of rules
621  *
622  * Increase, decrease or maintain tables size depending on new amount of rules,
623  * and copy data over. In case the new size is smaller, throw away data for
624  * highest-numbered rules.
625  *
626  * Return: 0 on success, -ENOMEM on allocation failure.
627  */
628 static int pipapo_resize(struct nft_pipapo_field *f, int old_rules, int rules)
629 {
630         long *new_lt = NULL, *new_p, *old_lt = f->lt, *old_p;
631         union nft_pipapo_map_bucket *new_mt, *old_mt = f->mt;
632         size_t new_bucket_size, copy;
633         int group, bucket;
634
635         new_bucket_size = DIV_ROUND_UP(rules, BITS_PER_LONG);
636 #ifdef NFT_PIPAPO_ALIGN
637         new_bucket_size = roundup(new_bucket_size,
638                                   NFT_PIPAPO_ALIGN / sizeof(*new_lt));
639 #endif
640
641         if (new_bucket_size == f->bsize)
642                 goto mt;
643
644         if (new_bucket_size > f->bsize)
645                 copy = f->bsize;
646         else
647                 copy = new_bucket_size;
648
649         new_lt = kvzalloc(f->groups * NFT_PIPAPO_BUCKETS(f->bb) *
650                           new_bucket_size * sizeof(*new_lt) +
651                           NFT_PIPAPO_ALIGN_HEADROOM,
652                           GFP_KERNEL);
653         if (!new_lt)
654                 return -ENOMEM;
655
656         new_p = NFT_PIPAPO_LT_ALIGN(new_lt);
657         old_p = NFT_PIPAPO_LT_ALIGN(old_lt);
658
659         for (group = 0; group < f->groups; group++) {
660                 for (bucket = 0; bucket < NFT_PIPAPO_BUCKETS(f->bb); bucket++) {
661                         memcpy(new_p, old_p, copy * sizeof(*new_p));
662                         new_p += copy;
663                         old_p += copy;
664
665                         if (new_bucket_size > f->bsize)
666                                 new_p += new_bucket_size - f->bsize;
667                         else
668                                 old_p += f->bsize - new_bucket_size;
669                 }
670         }
671
672 mt:
673         new_mt = kvmalloc(rules * sizeof(*new_mt), GFP_KERNEL);
674         if (!new_mt) {
675                 kvfree(new_lt);
676                 return -ENOMEM;
677         }
678
679         memcpy(new_mt, f->mt, min(old_rules, rules) * sizeof(*new_mt));
680         if (rules > old_rules) {
681                 memset(new_mt + old_rules, 0,
682                        (rules - old_rules) * sizeof(*new_mt));
683         }
684
685         if (new_lt) {
686                 f->bsize = new_bucket_size;
687                 NFT_PIPAPO_LT_ASSIGN(f, new_lt);
688                 kvfree(old_lt);
689         }
690
691         f->mt = new_mt;
692         kvfree(old_mt);
693
694         return 0;
695 }
696
697 /**
698  * pipapo_bucket_set() - Set rule bit in bucket given group and group value
699  * @f:          Field containing lookup table
700  * @rule:       Rule index
701  * @group:      Group index
702  * @v:          Value of bit group
703  */
704 static void pipapo_bucket_set(struct nft_pipapo_field *f, int rule, int group,
705                               int v)
706 {
707         unsigned long *pos;
708
709         pos = NFT_PIPAPO_LT_ALIGN(f->lt);
710         pos += f->bsize * NFT_PIPAPO_BUCKETS(f->bb) * group;
711         pos += f->bsize * v;
712
713         __set_bit(rule, pos);
714 }
715
716 /**
717  * pipapo_lt_4b_to_8b() - Switch lookup table group width from 4 bits to 8 bits
718  * @old_groups: Number of current groups
719  * @bsize:      Size of one bucket, in longs
720  * @old_lt:     Pointer to the current lookup table
721  * @new_lt:     Pointer to the new, pre-allocated lookup table
722  *
723  * Each bucket with index b in the new lookup table, belonging to group g, is
724  * filled with the bit intersection between:
725  * - bucket with index given by the upper 4 bits of b, from group g, and
726  * - bucket with index given by the lower 4 bits of b, from group g + 1
727  *
728  * That is, given buckets from the new lookup table N(x, y) and the old lookup
729  * table O(x, y), with x bucket index, and y group index:
730  *
731  *      N(b, g) := O(b / 16, g) & O(b % 16, g + 1)
732  *
733  * This ensures equivalence of the matching results on lookup. Two examples in
734  * pictures:
735  *
736  *              bucket
737  *  group  0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 ... 254 255
738  *    0                ^
739  *    1                |                                                 ^
740  *   ...             ( & )                                               |
741  *                  /     \                                              |
742  *                 /       \                                         .-( & )-.
743  *                /  bucket \                                        |       |
744  *      group  0 / 1   2   3 \ 4   5   6   7   8   9  10  11  12  13 |14  15 |
745  *        0     /             \                                      |       |
746  *        1                    \                                     |       |
747  *        2                                                          |     --'
748  *        3                                                          '-
749  *       ...
750  */
751 static void pipapo_lt_4b_to_8b(int old_groups, int bsize,
752                                unsigned long *old_lt, unsigned long *new_lt)
753 {
754         int g, b, i;
755
756         for (g = 0; g < old_groups / 2; g++) {
757                 int src_g0 = g * 2, src_g1 = g * 2 + 1;
758
759                 for (b = 0; b < NFT_PIPAPO_BUCKETS(8); b++) {
760                         int src_b0 = b / NFT_PIPAPO_BUCKETS(4);
761                         int src_b1 = b % NFT_PIPAPO_BUCKETS(4);
762                         int src_i0 = src_g0 * NFT_PIPAPO_BUCKETS(4) + src_b0;
763                         int src_i1 = src_g1 * NFT_PIPAPO_BUCKETS(4) + src_b1;
764
765                         for (i = 0; i < bsize; i++) {
766                                 *new_lt = old_lt[src_i0 * bsize + i] &
767                                           old_lt[src_i1 * bsize + i];
768                                 new_lt++;
769                         }
770                 }
771         }
772 }
773
774 /**
775  * pipapo_lt_8b_to_4b() - Switch lookup table group width from 8 bits to 4 bits
776  * @old_groups: Number of current groups
777  * @bsize:      Size of one bucket, in longs
778  * @old_lt:     Pointer to the current lookup table
779  * @new_lt:     Pointer to the new, pre-allocated lookup table
780  *
781  * Each bucket with index b in the new lookup table, belonging to group g, is
782  * filled with the bit union of:
783  * - all the buckets with index such that the upper four bits of the lower byte
784  *   equal b, from group g, with g odd
785  * - all the buckets with index such that the lower four bits equal b, from
786  *   group g, with g even
787  *
788  * That is, given buckets from the new lookup table N(x, y) and the old lookup
789  * table O(x, y), with x bucket index, and y group index:
790  *
791  *      - with g odd:  N(b, g) := U(O(x, g) for each x : x = (b & 0xf0) >> 4)
792  *      - with g even: N(b, g) := U(O(x, g) for each x : x = b & 0x0f)
793  *
794  * where U() denotes the arbitrary union operation (binary OR of n terms). This
795  * ensures equivalence of the matching results on lookup.
796  */
797 static void pipapo_lt_8b_to_4b(int old_groups, int bsize,
798                                unsigned long *old_lt, unsigned long *new_lt)
799 {
800         int g, b, bsrc, i;
801
802         memset(new_lt, 0, old_groups * 2 * NFT_PIPAPO_BUCKETS(4) * bsize *
803                           sizeof(unsigned long));
804
805         for (g = 0; g < old_groups * 2; g += 2) {
806                 int src_g = g / 2;
807
808                 for (b = 0; b < NFT_PIPAPO_BUCKETS(4); b++) {
809                         for (bsrc = NFT_PIPAPO_BUCKETS(8) * src_g;
810                              bsrc < NFT_PIPAPO_BUCKETS(8) * (src_g + 1);
811                              bsrc++) {
812                                 if (((bsrc & 0xf0) >> 4) != b)
813                                         continue;
814
815                                 for (i = 0; i < bsize; i++)
816                                         new_lt[i] |= old_lt[bsrc * bsize + i];
817                         }
818
819                         new_lt += bsize;
820                 }
821
822                 for (b = 0; b < NFT_PIPAPO_BUCKETS(4); b++) {
823                         for (bsrc = NFT_PIPAPO_BUCKETS(8) * src_g;
824                              bsrc < NFT_PIPAPO_BUCKETS(8) * (src_g + 1);
825                              bsrc++) {
826                                 if ((bsrc & 0x0f) != b)
827                                         continue;
828
829                                 for (i = 0; i < bsize; i++)
830                                         new_lt[i] |= old_lt[bsrc * bsize + i];
831                         }
832
833                         new_lt += bsize;
834                 }
835         }
836 }
837
838 /**
839  * pipapo_lt_bits_adjust() - Adjust group size for lookup table if needed
840  * @f:          Field containing lookup table
841  */
842 static void pipapo_lt_bits_adjust(struct nft_pipapo_field *f)
843 {
844         unsigned long *new_lt;
845         int groups, bb;
846         size_t lt_size;
847
848         lt_size = f->groups * NFT_PIPAPO_BUCKETS(f->bb) * f->bsize *
849                   sizeof(*f->lt);
850
851         if (f->bb == NFT_PIPAPO_GROUP_BITS_SMALL_SET &&
852             lt_size > NFT_PIPAPO_LT_SIZE_HIGH) {
853                 groups = f->groups * 2;
854                 bb = NFT_PIPAPO_GROUP_BITS_LARGE_SET;
855
856                 lt_size = groups * NFT_PIPAPO_BUCKETS(bb) * f->bsize *
857                           sizeof(*f->lt);
858         } else if (f->bb == NFT_PIPAPO_GROUP_BITS_LARGE_SET &&
859                    lt_size < NFT_PIPAPO_LT_SIZE_LOW) {
860                 groups = f->groups / 2;
861                 bb = NFT_PIPAPO_GROUP_BITS_SMALL_SET;
862
863                 lt_size = groups * NFT_PIPAPO_BUCKETS(bb) * f->bsize *
864                           sizeof(*f->lt);
865
866                 /* Don't increase group width if the resulting lookup table size
867                  * would exceed the upper size threshold for a "small" set.
868                  */
869                 if (lt_size > NFT_PIPAPO_LT_SIZE_HIGH)
870                         return;
871         } else {
872                 return;
873         }
874
875         new_lt = kvzalloc(lt_size + NFT_PIPAPO_ALIGN_HEADROOM, GFP_KERNEL);
876         if (!new_lt)
877                 return;
878
879         NFT_PIPAPO_GROUP_BITS_ARE_8_OR_4;
880         if (f->bb == 4 && bb == 8) {
881                 pipapo_lt_4b_to_8b(f->groups, f->bsize,
882                                    NFT_PIPAPO_LT_ALIGN(f->lt),
883                                    NFT_PIPAPO_LT_ALIGN(new_lt));
884         } else if (f->bb == 8 && bb == 4) {
885                 pipapo_lt_8b_to_4b(f->groups, f->bsize,
886                                    NFT_PIPAPO_LT_ALIGN(f->lt),
887                                    NFT_PIPAPO_LT_ALIGN(new_lt));
888         } else {
889                 BUG();
890         }
891
892         f->groups = groups;
893         f->bb = bb;
894         kvfree(f->lt);
895         NFT_PIPAPO_LT_ASSIGN(f, new_lt);
896 }
897
898 /**
899  * pipapo_insert() - Insert new rule in field given input key and mask length
900  * @f:          Field containing lookup table
901  * @k:          Input key for classification, without nftables padding
902  * @mask_bits:  Length of mask; matches field length for non-ranged entry
903  *
904  * Insert a new rule reference in lookup buckets corresponding to k and
905  * mask_bits.
906  *
907  * Return: 1 on success (one rule inserted), negative error code on failure.
908  */
909 static int pipapo_insert(struct nft_pipapo_field *f, const uint8_t *k,
910                          int mask_bits)
911 {
912         int rule = f->rules++, group, ret, bit_offset = 0;
913
914         ret = pipapo_resize(f, f->rules - 1, f->rules);
915         if (ret)
916                 return ret;
917
918         for (group = 0; group < f->groups; group++) {
919                 int i, v;
920                 u8 mask;
921
922                 v = k[group / (BITS_PER_BYTE / f->bb)];
923                 v &= GENMASK(BITS_PER_BYTE - bit_offset - 1, 0);
924                 v >>= (BITS_PER_BYTE - bit_offset) - f->bb;
925
926                 bit_offset += f->bb;
927                 bit_offset %= BITS_PER_BYTE;
928
929                 if (mask_bits >= (group + 1) * f->bb) {
930                         /* Not masked */
931                         pipapo_bucket_set(f, rule, group, v);
932                 } else if (mask_bits <= group * f->bb) {
933                         /* Completely masked */
934                         for (i = 0; i < NFT_PIPAPO_BUCKETS(f->bb); i++)
935                                 pipapo_bucket_set(f, rule, group, i);
936                 } else {
937                         /* The mask limit falls on this group */
938                         mask = GENMASK(f->bb - 1, 0);
939                         mask >>= mask_bits - group * f->bb;
940                         for (i = 0; i < NFT_PIPAPO_BUCKETS(f->bb); i++) {
941                                 if ((i & ~mask) == (v & ~mask))
942                                         pipapo_bucket_set(f, rule, group, i);
943                         }
944                 }
945         }
946
947         pipapo_lt_bits_adjust(f);
948
949         return 1;
950 }
951
952 /**
953  * pipapo_step_diff() - Check if setting @step bit in netmask would change it
954  * @base:       Mask we are expanding
955  * @step:       Step bit for given expansion step
956  * @len:        Total length of mask space (set and unset bits), bytes
957  *
958  * Convenience function for mask expansion.
959  *
960  * Return: true if step bit changes mask (i.e. isn't set), false otherwise.
961  */
962 static bool pipapo_step_diff(u8 *base, int step, int len)
963 {
964         /* Network order, byte-addressed */
965 #ifdef __BIG_ENDIAN__
966         return !(BIT(step % BITS_PER_BYTE) & base[step / BITS_PER_BYTE]);
967 #else
968         return !(BIT(step % BITS_PER_BYTE) &
969                  base[len - 1 - step / BITS_PER_BYTE]);
970 #endif
971 }
972
973 /**
974  * pipapo_step_after_end() - Check if mask exceeds range end with given step
975  * @base:       Mask we are expanding
976  * @end:        End of range
977  * @step:       Step bit for given expansion step, highest bit to be set
978  * @len:        Total length of mask space (set and unset bits), bytes
979  *
980  * Convenience function for mask expansion.
981  *
982  * Return: true if mask exceeds range setting step bits, false otherwise.
983  */
984 static bool pipapo_step_after_end(const u8 *base, const u8 *end, int step,
985                                   int len)
986 {
987         u8 tmp[NFT_PIPAPO_MAX_BYTES];
988         int i;
989
990         memcpy(tmp, base, len);
991
992         /* Network order, byte-addressed */
993         for (i = 0; i <= step; i++)
994 #ifdef __BIG_ENDIAN__
995                 tmp[i / BITS_PER_BYTE] |= BIT(i % BITS_PER_BYTE);
996 #else
997                 tmp[len - 1 - i / BITS_PER_BYTE] |= BIT(i % BITS_PER_BYTE);
998 #endif
999
1000         return memcmp(tmp, end, len) > 0;
1001 }
1002
1003 /**
1004  * pipapo_base_sum() - Sum step bit to given len-sized netmask base with carry
1005  * @base:       Netmask base
1006  * @step:       Step bit to sum
1007  * @len:        Netmask length, bytes
1008  */
1009 static void pipapo_base_sum(u8 *base, int step, int len)
1010 {
1011         bool carry = false;
1012         int i;
1013
1014         /* Network order, byte-addressed */
1015 #ifdef __BIG_ENDIAN__
1016         for (i = step / BITS_PER_BYTE; i < len; i++) {
1017 #else
1018         for (i = len - 1 - step / BITS_PER_BYTE; i >= 0; i--) {
1019 #endif
1020                 if (carry)
1021                         base[i]++;
1022                 else
1023                         base[i] += 1 << (step % BITS_PER_BYTE);
1024
1025                 if (base[i])
1026                         break;
1027
1028                 carry = true;
1029         }
1030 }
1031
1032 /**
1033  * pipapo_expand() - Expand to composing netmasks, insert into lookup table
1034  * @f:          Field containing lookup table
1035  * @start:      Start of range
1036  * @end:        End of range
1037  * @len:        Length of value in bits
1038  *
1039  * Expand range to composing netmasks and insert corresponding rule references
1040  * in lookup buckets.
1041  *
1042  * Return: number of inserted rules on success, negative error code on failure.
1043  */
1044 static int pipapo_expand(struct nft_pipapo_field *f,
1045                          const u8 *start, const u8 *end, int len)
1046 {
1047         int step, masks = 0, bytes = DIV_ROUND_UP(len, BITS_PER_BYTE);
1048         u8 base[NFT_PIPAPO_MAX_BYTES];
1049
1050         memcpy(base, start, bytes);
1051         while (memcmp(base, end, bytes) <= 0) {
1052                 int err;
1053
1054                 step = 0;
1055                 while (pipapo_step_diff(base, step, bytes)) {
1056                         if (pipapo_step_after_end(base, end, step, bytes))
1057                                 break;
1058
1059                         step++;
1060                         if (step >= len) {
1061                                 if (!masks) {
1062                                         pipapo_insert(f, base, 0);
1063                                         masks = 1;
1064                                 }
1065                                 goto out;
1066                         }
1067                 }
1068
1069                 err = pipapo_insert(f, base, len - step);
1070
1071                 if (err < 0)
1072                         return err;
1073
1074                 masks++;
1075                 pipapo_base_sum(base, step, bytes);
1076         }
1077 out:
1078         return masks;
1079 }
1080
1081 /**
1082  * pipapo_map() - Insert rules in mapping tables, mapping them between fields
1083  * @m:          Matching data, including mapping table
1084  * @map:        Table of rule maps: array of first rule and amount of rules
1085  *              in next field a given rule maps to, for each field
1086  * @e:          For last field, nft_set_ext pointer matching rules map to
1087  */
1088 static void pipapo_map(struct nft_pipapo_match *m,
1089                        union nft_pipapo_map_bucket map[NFT_PIPAPO_MAX_FIELDS],
1090                        struct nft_pipapo_elem *e)
1091 {
1092         struct nft_pipapo_field *f;
1093         int i, j;
1094
1095         for (i = 0, f = m->f; i < m->field_count - 1; i++, f++) {
1096                 for (j = 0; j < map[i].n; j++) {
1097                         f->mt[map[i].to + j].to = map[i + 1].to;
1098                         f->mt[map[i].to + j].n = map[i + 1].n;
1099                 }
1100         }
1101
1102         /* Last field: map to ext instead of mapping to next field */
1103         for (j = 0; j < map[i].n; j++)
1104                 f->mt[map[i].to + j].e = e;
1105 }
1106
1107 /**
1108  * pipapo_realloc_scratch() - Reallocate scratch maps for partial match results
1109  * @clone:      Copy of matching data with pending insertions and deletions
1110  * @bsize_max:  Maximum bucket size, scratch maps cover two buckets
1111  *
1112  * Return: 0 on success, -ENOMEM on failure.
1113  */
1114 static int pipapo_realloc_scratch(struct nft_pipapo_match *clone,
1115                                   unsigned long bsize_max)
1116 {
1117         int i;
1118
1119         for_each_possible_cpu(i) {
1120                 unsigned long *scratch;
1121 #ifdef NFT_PIPAPO_ALIGN
1122                 unsigned long *scratch_aligned;
1123 #endif
1124
1125                 scratch = kzalloc_node(bsize_max * sizeof(*scratch) * 2 +
1126                                        NFT_PIPAPO_ALIGN_HEADROOM,
1127                                        GFP_KERNEL, cpu_to_node(i));
1128                 if (!scratch) {
1129                         /* On failure, there's no need to undo previous
1130                          * allocations: this means that some scratch maps have
1131                          * a bigger allocated size now (this is only called on
1132                          * insertion), but the extra space won't be used by any
1133                          * CPU as new elements are not inserted and m->bsize_max
1134                          * is not updated.
1135                          */
1136                         return -ENOMEM;
1137                 }
1138
1139                 kfree(*per_cpu_ptr(clone->scratch, i));
1140
1141                 *per_cpu_ptr(clone->scratch, i) = scratch;
1142
1143 #ifdef NFT_PIPAPO_ALIGN
1144                 scratch_aligned = NFT_PIPAPO_LT_ALIGN(scratch);
1145                 *per_cpu_ptr(clone->scratch_aligned, i) = scratch_aligned;
1146 #endif
1147         }
1148
1149         return 0;
1150 }
1151
1152 /**
1153  * nft_pipapo_insert() - Validate and insert ranged elements
1154  * @net:        Network namespace
1155  * @set:        nftables API set representation
1156  * @elem:       nftables API element representation containing key data
1157  * @ext2:       Filled with pointer to &struct nft_set_ext in inserted element
1158  *
1159  * Return: 0 on success, error pointer on failure.
1160  */
1161 static int nft_pipapo_insert(const struct net *net, const struct nft_set *set,
1162                              const struct nft_set_elem *elem,
1163                              struct nft_set_ext **ext2)
1164 {
1165         const struct nft_set_ext *ext = nft_set_elem_ext(set, elem->priv);
1166         union nft_pipapo_map_bucket rulemap[NFT_PIPAPO_MAX_FIELDS];
1167         const u8 *start = (const u8 *)elem->key.val.data, *end;
1168         struct nft_pipapo_elem *e = elem->priv, *dup;
1169         struct nft_pipapo *priv = nft_set_priv(set);
1170         struct nft_pipapo_match *m = priv->clone;
1171         u8 genmask = nft_genmask_next(net);
1172         struct nft_pipapo_field *f;
1173         const u8 *start_p, *end_p;
1174         int i, bsize_max, err = 0;
1175
1176         if (nft_set_ext_exists(ext, NFT_SET_EXT_KEY_END))
1177                 end = (const u8 *)nft_set_ext_key_end(ext)->data;
1178         else
1179                 end = start;
1180
1181         dup = pipapo_get(net, set, start, genmask);
1182         if (!IS_ERR(dup)) {
1183                 /* Check if we already have the same exact entry */
1184                 const struct nft_data *dup_key, *dup_end;
1185
1186                 dup_key = nft_set_ext_key(&dup->ext);
1187                 if (nft_set_ext_exists(&dup->ext, NFT_SET_EXT_KEY_END))
1188                         dup_end = nft_set_ext_key_end(&dup->ext);
1189                 else
1190                         dup_end = dup_key;
1191
1192                 if (!memcmp(start, dup_key->data, sizeof(*dup_key->data)) &&
1193                     !memcmp(end, dup_end->data, sizeof(*dup_end->data))) {
1194                         *ext2 = &dup->ext;
1195                         return -EEXIST;
1196                 }
1197
1198                 return -ENOTEMPTY;
1199         }
1200
1201         if (PTR_ERR(dup) == -ENOENT) {
1202                 /* Look for partially overlapping entries */
1203                 dup = pipapo_get(net, set, end, nft_genmask_next(net));
1204         }
1205
1206         if (PTR_ERR(dup) != -ENOENT) {
1207                 if (IS_ERR(dup))
1208                         return PTR_ERR(dup);
1209                 *ext2 = &dup->ext;
1210                 return -ENOTEMPTY;
1211         }
1212
1213         /* Validate */
1214         start_p = start;
1215         end_p = end;
1216         nft_pipapo_for_each_field(f, i, m) {
1217                 if (f->rules >= (unsigned long)NFT_PIPAPO_RULE0_MAX)
1218                         return -ENOSPC;
1219
1220                 if (memcmp(start_p, end_p,
1221                            f->groups / NFT_PIPAPO_GROUPS_PER_BYTE(f)) > 0)
1222                         return -EINVAL;
1223
1224                 start_p += NFT_PIPAPO_GROUPS_PADDED_SIZE(f);
1225                 end_p += NFT_PIPAPO_GROUPS_PADDED_SIZE(f);
1226         }
1227
1228         /* Insert */
1229         priv->dirty = true;
1230
1231         bsize_max = m->bsize_max;
1232
1233         nft_pipapo_for_each_field(f, i, m) {
1234                 int ret;
1235
1236                 rulemap[i].to = f->rules;
1237
1238                 ret = memcmp(start, end,
1239                              f->groups / NFT_PIPAPO_GROUPS_PER_BYTE(f));
1240                 if (!ret)
1241                         ret = pipapo_insert(f, start, f->groups * f->bb);
1242                 else
1243                         ret = pipapo_expand(f, start, end, f->groups * f->bb);
1244
1245                 if (f->bsize > bsize_max)
1246                         bsize_max = f->bsize;
1247
1248                 rulemap[i].n = ret;
1249
1250                 start += NFT_PIPAPO_GROUPS_PADDED_SIZE(f);
1251                 end += NFT_PIPAPO_GROUPS_PADDED_SIZE(f);
1252         }
1253
1254         if (!*get_cpu_ptr(m->scratch) || bsize_max > m->bsize_max) {
1255                 put_cpu_ptr(m->scratch);
1256
1257                 err = pipapo_realloc_scratch(m, bsize_max);
1258                 if (err)
1259                         return err;
1260
1261                 m->bsize_max = bsize_max;
1262         } else {
1263                 put_cpu_ptr(m->scratch);
1264         }
1265
1266         *ext2 = &e->ext;
1267
1268         pipapo_map(m, rulemap, e);
1269
1270         return 0;
1271 }
1272
1273 /**
1274  * pipapo_clone() - Clone matching data to create new working copy
1275  * @old:        Existing matching data
1276  *
1277  * Return: copy of matching data passed as 'old', error pointer on failure
1278  */
1279 static struct nft_pipapo_match *pipapo_clone(struct nft_pipapo_match *old)
1280 {
1281         struct nft_pipapo_field *dst, *src;
1282         struct nft_pipapo_match *new;
1283         int i;
1284
1285         new = kmalloc(struct_size(new, f, old->field_count), GFP_KERNEL);
1286         if (!new)
1287                 return ERR_PTR(-ENOMEM);
1288
1289         new->field_count = old->field_count;
1290         new->bsize_max = old->bsize_max;
1291
1292         new->scratch = alloc_percpu(*new->scratch);
1293         if (!new->scratch)
1294                 goto out_scratch;
1295
1296 #ifdef NFT_PIPAPO_ALIGN
1297         new->scratch_aligned = alloc_percpu(*new->scratch_aligned);
1298         if (!new->scratch_aligned)
1299                 goto out_scratch;
1300 #endif
1301         for_each_possible_cpu(i)
1302                 *per_cpu_ptr(new->scratch, i) = NULL;
1303
1304         if (pipapo_realloc_scratch(new, old->bsize_max))
1305                 goto out_scratch_realloc;
1306
1307         rcu_head_init(&new->rcu);
1308
1309         src = old->f;
1310         dst = new->f;
1311
1312         for (i = 0; i < old->field_count; i++) {
1313                 unsigned long *new_lt;
1314
1315                 memcpy(dst, src, offsetof(struct nft_pipapo_field, lt));
1316
1317                 new_lt = kvzalloc(src->groups * NFT_PIPAPO_BUCKETS(src->bb) *
1318                                   src->bsize * sizeof(*dst->lt) +
1319                                   NFT_PIPAPO_ALIGN_HEADROOM,
1320                                   GFP_KERNEL);
1321                 if (!new_lt)
1322                         goto out_lt;
1323
1324                 NFT_PIPAPO_LT_ASSIGN(dst, new_lt);
1325
1326                 memcpy(NFT_PIPAPO_LT_ALIGN(new_lt),
1327                        NFT_PIPAPO_LT_ALIGN(src->lt),
1328                        src->bsize * sizeof(*dst->lt) *
1329                        src->groups * NFT_PIPAPO_BUCKETS(src->bb));
1330
1331                 dst->mt = kvmalloc(src->rules * sizeof(*src->mt), GFP_KERNEL);
1332                 if (!dst->mt)
1333                         goto out_mt;
1334
1335                 memcpy(dst->mt, src->mt, src->rules * sizeof(*src->mt));
1336                 src++;
1337                 dst++;
1338         }
1339
1340         return new;
1341
1342 out_mt:
1343         kvfree(dst->lt);
1344 out_lt:
1345         for (dst--; i > 0; i--) {
1346                 kvfree(dst->mt);
1347                 kvfree(dst->lt);
1348                 dst--;
1349         }
1350 out_scratch_realloc:
1351         for_each_possible_cpu(i)
1352                 kfree(*per_cpu_ptr(new->scratch, i));
1353 #ifdef NFT_PIPAPO_ALIGN
1354         free_percpu(new->scratch_aligned);
1355 #endif
1356 out_scratch:
1357         free_percpu(new->scratch);
1358         kfree(new);
1359
1360         return ERR_PTR(-ENOMEM);
1361 }
1362
1363 /**
1364  * pipapo_rules_same_key() - Get number of rules originated from the same entry
1365  * @f:          Field containing mapping table
1366  * @first:      Index of first rule in set of rules mapping to same entry
1367  *
1368  * Using the fact that all rules in a field that originated from the same entry
1369  * will map to the same set of rules in the next field, or to the same element
1370  * reference, return the cardinality of the set of rules that originated from
1371  * the same entry as the rule with index @first, @first rule included.
1372  *
1373  * In pictures:
1374  *                              rules
1375  *      field #0                0    1    2    3    4
1376  *              map to:         0    1   2-4  2-4  5-9
1377  *                              .    .    .......   . ...
1378  *                              |    |    |    | \   \
1379  *                              |    |    |    |  \   \
1380  *                              |    |    |    |   \   \
1381  *                              '    '    '    '    '   \
1382  *      in field #1             0    1    2    3    4    5 ...
1383  *
1384  * if this is called for rule 2 on field #0, it will return 3, as also rules 2
1385  * and 3 in field 0 map to the same set of rules (2, 3, 4) in the next field.
1386  *
1387  * For the last field in a set, we can rely on associated entries to map to the
1388  * same element references.
1389  *
1390  * Return: Number of rules that originated from the same entry as @first.
1391  */
1392 static int pipapo_rules_same_key(struct nft_pipapo_field *f, int first)
1393 {
1394         struct nft_pipapo_elem *e = NULL; /* Keep gcc happy */
1395         int r;
1396
1397         for (r = first; r < f->rules; r++) {
1398                 if (r != first && e != f->mt[r].e)
1399                         return r - first;
1400
1401                 e = f->mt[r].e;
1402         }
1403
1404         if (r != first)
1405                 return r - first;
1406
1407         return 0;
1408 }
1409
1410 /**
1411  * pipapo_unmap() - Remove rules from mapping tables, renumber remaining ones
1412  * @mt:         Mapping array
1413  * @rules:      Original amount of rules in mapping table
1414  * @start:      First rule index to be removed
1415  * @n:          Amount of rules to be removed
1416  * @to_offset:  First rule index, in next field, this group of rules maps to
1417  * @is_last:    If this is the last field, delete reference from mapping array
1418  *
1419  * This is used to unmap rules from the mapping table for a single field,
1420  * maintaining consistency and compactness for the existing ones.
1421  *
1422  * In pictures: let's assume that we want to delete rules 2 and 3 from the
1423  * following mapping array:
1424  *
1425  *                 rules
1426  *               0      1      2      3      4
1427  *      map to:  4-10   4-10   11-15  11-15  16-18
1428  *
1429  * the result will be:
1430  *
1431  *                 rules
1432  *               0      1      2
1433  *      map to:  4-10   4-10   11-13
1434  *
1435  * for fields before the last one. In case this is the mapping table for the
1436  * last field in a set, and rules map to pointers to &struct nft_pipapo_elem:
1437  *
1438  *                      rules
1439  *                        0      1      2      3      4
1440  *  element pointers:  0x42   0x42   0x33   0x33   0x44
1441  *
1442  * the result will be:
1443  *
1444  *                      rules
1445  *                        0      1      2
1446  *  element pointers:  0x42   0x42   0x44
1447  */
1448 static void pipapo_unmap(union nft_pipapo_map_bucket *mt, int rules,
1449                          int start, int n, int to_offset, bool is_last)
1450 {
1451         int i;
1452
1453         memmove(mt + start, mt + start + n, (rules - start - n) * sizeof(*mt));
1454         memset(mt + rules - n, 0, n * sizeof(*mt));
1455
1456         if (is_last)
1457                 return;
1458
1459         for (i = start; i < rules - n; i++)
1460                 mt[i].to -= to_offset;
1461 }
1462
1463 /**
1464  * pipapo_drop() - Delete entry from lookup and mapping tables, given rule map
1465  * @m:          Matching data
1466  * @rulemap:    Table of rule maps, arrays of first rule and amount of rules
1467  *              in next field a given entry maps to, for each field
1468  *
1469  * For each rule in lookup table buckets mapping to this set of rules, drop
1470  * all bits set in lookup table mapping. In pictures, assuming we want to drop
1471  * rules 0 and 1 from this lookup table:
1472  *
1473  *                     bucket
1474  *      group  0   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15
1475  *        0    0                                              1,2
1476  *        1   1,2                                      0
1477  *        2    0                                      1,2
1478  *        3    0                              1,2
1479  *        4  0,1,2
1480  *        5    0   1   2
1481  *        6  0,1,2 1   1   1   1   1   1   1   1   1   1   1   1   1   1   1
1482  *        7   1,2 1,2  1   1   1  0,1  1   1   1   1   1   1   1   1   1   1
1483  *
1484  * rule 2 becomes rule 0, and the result will be:
1485  *
1486  *                     bucket
1487  *      group  0   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15
1488  *        0                                                    0
1489  *        1    0
1490  *        2                                            0
1491  *        3                                    0
1492  *        4    0
1493  *        5            0
1494  *        6    0
1495  *        7    0   0
1496  *
1497  * once this is done, call unmap() to drop all the corresponding rule references
1498  * from mapping tables.
1499  */
1500 static void pipapo_drop(struct nft_pipapo_match *m,
1501                         union nft_pipapo_map_bucket rulemap[])
1502 {
1503         struct nft_pipapo_field *f;
1504         int i;
1505
1506         nft_pipapo_for_each_field(f, i, m) {
1507                 int g;
1508
1509                 for (g = 0; g < f->groups; g++) {
1510                         unsigned long *pos;
1511                         int b;
1512
1513                         pos = NFT_PIPAPO_LT_ALIGN(f->lt) + g *
1514                               NFT_PIPAPO_BUCKETS(f->bb) * f->bsize;
1515
1516                         for (b = 0; b < NFT_PIPAPO_BUCKETS(f->bb); b++) {
1517                                 bitmap_cut(pos, pos, rulemap[i].to,
1518                                            rulemap[i].n,
1519                                            f->bsize * BITS_PER_LONG);
1520
1521                                 pos += f->bsize;
1522                         }
1523                 }
1524
1525                 pipapo_unmap(f->mt, f->rules, rulemap[i].to, rulemap[i].n,
1526                              rulemap[i + 1].n, i == m->field_count - 1);
1527                 if (pipapo_resize(f, f->rules, f->rules - rulemap[i].n)) {
1528                         /* We can ignore this, a failure to shrink tables down
1529                          * doesn't make tables invalid.
1530                          */
1531                         ;
1532                 }
1533                 f->rules -= rulemap[i].n;
1534
1535                 pipapo_lt_bits_adjust(f);
1536         }
1537 }
1538
1539 static void nft_pipapo_gc_deactivate(struct net *net, struct nft_set *set,
1540                                      struct nft_pipapo_elem *e)
1541
1542 {
1543         struct nft_set_elem elem = {
1544                 .priv   = e,
1545         };
1546
1547         nft_setelem_data_deactivate(net, set, &elem);
1548 }
1549
1550 /**
1551  * pipapo_gc() - Drop expired entries from set, destroy start and end elements
1552  * @_set:       nftables API set representation
1553  * @m:          Matching data
1554  */
1555 static void pipapo_gc(const struct nft_set *_set, struct nft_pipapo_match *m)
1556 {
1557         struct nft_set *set = (struct nft_set *) _set;
1558         struct nft_pipapo *priv = nft_set_priv(set);
1559         struct net *net = read_pnet(&set->net);
1560         int rules_f0, first_rule = 0;
1561         struct nft_pipapo_elem *e;
1562         struct nft_trans_gc *gc;
1563
1564         gc = nft_trans_gc_alloc(set, 0, GFP_KERNEL);
1565         if (!gc)
1566                 return;
1567
1568         while ((rules_f0 = pipapo_rules_same_key(m->f, first_rule))) {
1569                 union nft_pipapo_map_bucket rulemap[NFT_PIPAPO_MAX_FIELDS];
1570                 struct nft_pipapo_field *f;
1571                 int i, start, rules_fx;
1572
1573                 start = first_rule;
1574                 rules_fx = rules_f0;
1575
1576                 nft_pipapo_for_each_field(f, i, m) {
1577                         rulemap[i].to = start;
1578                         rulemap[i].n = rules_fx;
1579
1580                         if (i < m->field_count - 1) {
1581                                 rules_fx = f->mt[start].n;
1582                                 start = f->mt[start].to;
1583                         }
1584                 }
1585
1586                 /* Pick the last field, and its last index */
1587                 f--;
1588                 i--;
1589                 e = f->mt[rulemap[i].to].e;
1590
1591                 /* synchronous gc never fails, there is no need to set on
1592                  * NFT_SET_ELEM_DEAD_BIT.
1593                  */
1594                 if (nft_set_elem_expired(&e->ext)) {
1595                         priv->dirty = true;
1596
1597                         gc = nft_trans_gc_queue_sync(gc, GFP_ATOMIC);
1598                         if (!gc)
1599                                 break;
1600
1601                         nft_pipapo_gc_deactivate(net, set, e);
1602                         pipapo_drop(m, rulemap);
1603                         nft_trans_gc_elem_add(gc, e);
1604
1605                         /* And check again current first rule, which is now the
1606                          * first we haven't checked.
1607                          */
1608                 } else {
1609                         first_rule += rules_f0;
1610                 }
1611         }
1612
1613         gc = nft_trans_gc_catchall(gc, 0);
1614         if (gc) {
1615                 nft_trans_gc_queue_sync_done(gc);
1616                 priv->last_gc = jiffies;
1617         }
1618 }
1619
1620 /**
1621  * pipapo_free_fields() - Free per-field tables contained in matching data
1622  * @m:          Matching data
1623  */
1624 static void pipapo_free_fields(struct nft_pipapo_match *m)
1625 {
1626         struct nft_pipapo_field *f;
1627         int i;
1628
1629         nft_pipapo_for_each_field(f, i, m) {
1630                 kvfree(f->lt);
1631                 kvfree(f->mt);
1632         }
1633 }
1634
1635 static void pipapo_free_match(struct nft_pipapo_match *m)
1636 {
1637         int i;
1638
1639         for_each_possible_cpu(i)
1640                 kfree(*per_cpu_ptr(m->scratch, i));
1641
1642 #ifdef NFT_PIPAPO_ALIGN
1643         free_percpu(m->scratch_aligned);
1644 #endif
1645         free_percpu(m->scratch);
1646
1647         pipapo_free_fields(m);
1648
1649         kfree(m);
1650 }
1651
1652 /**
1653  * pipapo_reclaim_match - RCU callback to free fields from old matching data
1654  * @rcu:        RCU head
1655  */
1656 static void pipapo_reclaim_match(struct rcu_head *rcu)
1657 {
1658         struct nft_pipapo_match *m;
1659
1660         m = container_of(rcu, struct nft_pipapo_match, rcu);
1661         pipapo_free_match(m);
1662 }
1663
1664 /**
1665  * nft_pipapo_commit() - Replace lookup data with current working copy
1666  * @set:        nftables API set representation
1667  *
1668  * While at it, check if we should perform garbage collection on the working
1669  * copy before committing it for lookup, and don't replace the table if the
1670  * working copy doesn't have pending changes.
1671  *
1672  * We also need to create a new working copy for subsequent insertions and
1673  * deletions.
1674  */
1675 static void nft_pipapo_commit(const struct nft_set *set)
1676 {
1677         struct nft_pipapo *priv = nft_set_priv(set);
1678         struct nft_pipapo_match *new_clone, *old;
1679
1680         if (time_after_eq(jiffies, priv->last_gc + nft_set_gc_interval(set)))
1681                 pipapo_gc(set, priv->clone);
1682
1683         if (!priv->dirty)
1684                 return;
1685
1686         new_clone = pipapo_clone(priv->clone);
1687         if (IS_ERR(new_clone))
1688                 return;
1689
1690         priv->dirty = false;
1691
1692         old = rcu_access_pointer(priv->match);
1693         rcu_assign_pointer(priv->match, priv->clone);
1694         if (old)
1695                 call_rcu(&old->rcu, pipapo_reclaim_match);
1696
1697         priv->clone = new_clone;
1698 }
1699
1700 static bool nft_pipapo_transaction_mutex_held(const struct nft_set *set)
1701 {
1702 #ifdef CONFIG_PROVE_LOCKING
1703         const struct net *net = read_pnet(&set->net);
1704
1705         return lockdep_is_held(&nft_pernet(net)->commit_mutex);
1706 #else
1707         return true;
1708 #endif
1709 }
1710
1711 static void nft_pipapo_abort(const struct nft_set *set)
1712 {
1713         struct nft_pipapo *priv = nft_set_priv(set);
1714         struct nft_pipapo_match *new_clone, *m;
1715
1716         if (!priv->dirty)
1717                 return;
1718
1719         m = rcu_dereference_protected(priv->match, nft_pipapo_transaction_mutex_held(set));
1720
1721         new_clone = pipapo_clone(m);
1722         if (IS_ERR(new_clone))
1723                 return;
1724
1725         priv->dirty = false;
1726
1727         pipapo_free_match(priv->clone);
1728         priv->clone = new_clone;
1729 }
1730
1731 /**
1732  * nft_pipapo_activate() - Mark element reference as active given key, commit
1733  * @net:        Network namespace
1734  * @set:        nftables API set representation
1735  * @elem:       nftables API element representation containing key data
1736  *
1737  * On insertion, elements are added to a copy of the matching data currently
1738  * in use for lookups, and not directly inserted into current lookup data. Both
1739  * nft_pipapo_insert() and nft_pipapo_activate() are called once for each
1740  * element, hence we can't purpose either one as a real commit operation.
1741  */
1742 static void nft_pipapo_activate(const struct net *net,
1743                                 const struct nft_set *set,
1744                                 const struct nft_set_elem *elem)
1745 {
1746         struct nft_pipapo_elem *e;
1747
1748         e = pipapo_get(net, set, (const u8 *)elem->key.val.data, 0);
1749         if (IS_ERR(e))
1750                 return;
1751
1752         nft_set_elem_change_active(net, set, &e->ext);
1753 }
1754
1755 /**
1756  * pipapo_deactivate() - Check that element is in set, mark as inactive
1757  * @net:        Network namespace
1758  * @set:        nftables API set representation
1759  * @data:       Input key data
1760  * @ext:        nftables API extension pointer, used to check for end element
1761  *
1762  * This is a convenience function that can be called from both
1763  * nft_pipapo_deactivate() and nft_pipapo_flush(), as they are in fact the same
1764  * operation.
1765  *
1766  * Return: deactivated element if found, NULL otherwise.
1767  */
1768 static void *pipapo_deactivate(const struct net *net, const struct nft_set *set,
1769                                const u8 *data, const struct nft_set_ext *ext)
1770 {
1771         struct nft_pipapo_elem *e;
1772
1773         e = pipapo_get(net, set, data, nft_genmask_next(net));
1774         if (IS_ERR(e))
1775                 return NULL;
1776
1777         nft_set_elem_change_active(net, set, &e->ext);
1778
1779         return e;
1780 }
1781
1782 /**
1783  * nft_pipapo_deactivate() - Call pipapo_deactivate() to make element inactive
1784  * @net:        Network namespace
1785  * @set:        nftables API set representation
1786  * @elem:       nftables API element representation containing key data
1787  *
1788  * Return: deactivated element if found, NULL otherwise.
1789  */
1790 static void *nft_pipapo_deactivate(const struct net *net,
1791                                    const struct nft_set *set,
1792                                    const struct nft_set_elem *elem)
1793 {
1794         const struct nft_set_ext *ext = nft_set_elem_ext(set, elem->priv);
1795
1796         return pipapo_deactivate(net, set, (const u8 *)elem->key.val.data, ext);
1797 }
1798
1799 /**
1800  * nft_pipapo_flush() - Call pipapo_deactivate() to make element inactive
1801  * @net:        Network namespace
1802  * @set:        nftables API set representation
1803  * @elem:       nftables API element representation containing key data
1804  *
1805  * This is functionally the same as nft_pipapo_deactivate(), with a slightly
1806  * different interface, and it's also called once for each element in a set
1807  * being flushed, so we can't implement, strictly speaking, a flush operation,
1808  * which would otherwise be as simple as allocating an empty copy of the
1809  * matching data.
1810  *
1811  * Note that we could in theory do that, mark the set as flushed, and ignore
1812  * subsequent calls, but we would leak all the elements after the first one,
1813  * because they wouldn't then be freed as result of API calls.
1814  *
1815  * Return: true if element was found and deactivated.
1816  */
1817 static bool nft_pipapo_flush(const struct net *net, const struct nft_set *set,
1818                              void *elem)
1819 {
1820         struct nft_pipapo_elem *e = elem;
1821
1822         return pipapo_deactivate(net, set, (const u8 *)nft_set_ext_key(&e->ext),
1823                                  &e->ext);
1824 }
1825
1826 /**
1827  * pipapo_get_boundaries() - Get byte interval for associated rules
1828  * @f:          Field including lookup table
1829  * @first_rule: First rule (lowest index)
1830  * @rule_count: Number of associated rules
1831  * @left:       Byte expression for left boundary (start of range)
1832  * @right:      Byte expression for right boundary (end of range)
1833  *
1834  * Given the first rule and amount of rules that originated from the same entry,
1835  * build the original range associated with the entry, and calculate the length
1836  * of the originating netmask.
1837  *
1838  * In pictures:
1839  *
1840  *                     bucket
1841  *      group  0   1   2   3   4   5   6   7   8   9  10  11  12  13  14  15
1842  *        0                                                   1,2
1843  *        1   1,2
1844  *        2                                           1,2
1845  *        3                                   1,2
1846  *        4   1,2
1847  *        5        1   2
1848  *        6   1,2  1   1   1   1   1   1   1   1   1   1   1   1   1   1   1
1849  *        7   1,2 1,2  1   1   1   1   1   1   1   1   1   1   1   1   1   1
1850  *
1851  * this is the lookup table corresponding to the IPv4 range
1852  * 192.168.1.0-192.168.2.1, which was expanded to the two composing netmasks,
1853  * rule #1: 192.168.1.0/24, and rule #2: 192.168.2.0/31.
1854  *
1855  * This function fills @left and @right with the byte values of the leftmost
1856  * and rightmost bucket indices for the lowest and highest rule indices,
1857  * respectively. If @first_rule is 1 and @rule_count is 2, we obtain, in
1858  * nibbles:
1859  *   left:  < 12, 0, 10, 8, 0, 1, 0, 0 >
1860  *   right: < 12, 0, 10, 8, 0, 2, 2, 1 >
1861  * corresponding to bytes:
1862  *   left:  < 192, 168, 1, 0 >
1863  *   right: < 192, 168, 2, 1 >
1864  * with mask length irrelevant here, unused on return, as the range is already
1865  * defined by its start and end points. The mask length is relevant for a single
1866  * ranged entry instead: if @first_rule is 1 and @rule_count is 1, we ignore
1867  * rule 2 above: @left becomes < 192, 168, 1, 0 >, @right becomes
1868  * < 192, 168, 1, 255 >, and the mask length, calculated from the distances
1869  * between leftmost and rightmost bucket indices for each group, would be 24.
1870  *
1871  * Return: mask length, in bits.
1872  */
1873 static int pipapo_get_boundaries(struct nft_pipapo_field *f, int first_rule,
1874                                  int rule_count, u8 *left, u8 *right)
1875 {
1876         int g, mask_len = 0, bit_offset = 0;
1877         u8 *l = left, *r = right;
1878
1879         for (g = 0; g < f->groups; g++) {
1880                 int b, x0, x1;
1881
1882                 x0 = -1;
1883                 x1 = -1;
1884                 for (b = 0; b < NFT_PIPAPO_BUCKETS(f->bb); b++) {
1885                         unsigned long *pos;
1886
1887                         pos = NFT_PIPAPO_LT_ALIGN(f->lt) +
1888                               (g * NFT_PIPAPO_BUCKETS(f->bb) + b) * f->bsize;
1889                         if (test_bit(first_rule, pos) && x0 == -1)
1890                                 x0 = b;
1891                         if (test_bit(first_rule + rule_count - 1, pos))
1892                                 x1 = b;
1893                 }
1894
1895                 *l |= x0 << (BITS_PER_BYTE - f->bb - bit_offset);
1896                 *r |= x1 << (BITS_PER_BYTE - f->bb - bit_offset);
1897
1898                 bit_offset += f->bb;
1899                 if (bit_offset >= BITS_PER_BYTE) {
1900                         bit_offset %= BITS_PER_BYTE;
1901                         l++;
1902                         r++;
1903                 }
1904
1905                 if (x1 - x0 == 0)
1906                         mask_len += 4;
1907                 else if (x1 - x0 == 1)
1908                         mask_len += 3;
1909                 else if (x1 - x0 == 3)
1910                         mask_len += 2;
1911                 else if (x1 - x0 == 7)
1912                         mask_len += 1;
1913         }
1914
1915         return mask_len;
1916 }
1917
1918 /**
1919  * pipapo_match_field() - Match rules against byte ranges
1920  * @f:          Field including the lookup table
1921  * @first_rule: First of associated rules originating from same entry
1922  * @rule_count: Amount of associated rules
1923  * @start:      Start of range to be matched
1924  * @end:        End of range to be matched
1925  *
1926  * Return: true on match, false otherwise.
1927  */
1928 static bool pipapo_match_field(struct nft_pipapo_field *f,
1929                                int first_rule, int rule_count,
1930                                const u8 *start, const u8 *end)
1931 {
1932         u8 right[NFT_PIPAPO_MAX_BYTES] = { 0 };
1933         u8 left[NFT_PIPAPO_MAX_BYTES] = { 0 };
1934
1935         pipapo_get_boundaries(f, first_rule, rule_count, left, right);
1936
1937         return !memcmp(start, left,
1938                        f->groups / NFT_PIPAPO_GROUPS_PER_BYTE(f)) &&
1939                !memcmp(end, right, f->groups / NFT_PIPAPO_GROUPS_PER_BYTE(f));
1940 }
1941
1942 /**
1943  * nft_pipapo_remove() - Remove element given key, commit
1944  * @net:        Network namespace
1945  * @set:        nftables API set representation
1946  * @elem:       nftables API element representation containing key data
1947  *
1948  * Similarly to nft_pipapo_activate(), this is used as commit operation by the
1949  * API, but it's called once per element in the pending transaction, so we can't
1950  * implement this as a single commit operation. Closest we can get is to remove
1951  * the matched element here, if any, and commit the updated matching data.
1952  */
1953 static void nft_pipapo_remove(const struct net *net, const struct nft_set *set,
1954                               const struct nft_set_elem *elem)
1955 {
1956         struct nft_pipapo *priv = nft_set_priv(set);
1957         struct nft_pipapo_match *m = priv->clone;
1958         struct nft_pipapo_elem *e = elem->priv;
1959         int rules_f0, first_rule = 0;
1960         const u8 *data;
1961
1962         data = (const u8 *)nft_set_ext_key(&e->ext);
1963
1964         e = pipapo_get(net, set, data, 0);
1965         if (IS_ERR(e))
1966                 return;
1967
1968         while ((rules_f0 = pipapo_rules_same_key(m->f, first_rule))) {
1969                 union nft_pipapo_map_bucket rulemap[NFT_PIPAPO_MAX_FIELDS];
1970                 const u8 *match_start, *match_end;
1971                 struct nft_pipapo_field *f;
1972                 int i, start, rules_fx;
1973
1974                 match_start = data;
1975
1976                 if (nft_set_ext_exists(&e->ext, NFT_SET_EXT_KEY_END))
1977                         match_end = (const u8 *)nft_set_ext_key_end(&e->ext)->data;
1978                 else
1979                         match_end = data;
1980
1981                 start = first_rule;
1982                 rules_fx = rules_f0;
1983
1984                 nft_pipapo_for_each_field(f, i, m) {
1985                         if (!pipapo_match_field(f, start, rules_fx,
1986                                                 match_start, match_end))
1987                                 break;
1988
1989                         rulemap[i].to = start;
1990                         rulemap[i].n = rules_fx;
1991
1992                         rules_fx = f->mt[start].n;
1993                         start = f->mt[start].to;
1994
1995                         match_start += NFT_PIPAPO_GROUPS_PADDED_SIZE(f);
1996                         match_end += NFT_PIPAPO_GROUPS_PADDED_SIZE(f);
1997                 }
1998
1999                 if (i == m->field_count) {
2000                         priv->dirty = true;
2001                         pipapo_drop(m, rulemap);
2002                         return;
2003                 }
2004
2005                 first_rule += rules_f0;
2006         }
2007 }
2008
2009 /**
2010  * nft_pipapo_walk() - Walk over elements
2011  * @ctx:        nftables API context
2012  * @set:        nftables API set representation
2013  * @iter:       Iterator
2014  *
2015  * As elements are referenced in the mapping array for the last field, directly
2016  * scan that array: there's no need to follow rule mappings from the first
2017  * field.
2018  */
2019 static void nft_pipapo_walk(const struct nft_ctx *ctx, struct nft_set *set,
2020                             struct nft_set_iter *iter)
2021 {
2022         struct nft_pipapo *priv = nft_set_priv(set);
2023         struct net *net = read_pnet(&set->net);
2024         struct nft_pipapo_match *m;
2025         struct nft_pipapo_field *f;
2026         int i, r;
2027
2028         rcu_read_lock();
2029         if (iter->genmask == nft_genmask_cur(net))
2030                 m = rcu_dereference(priv->match);
2031         else
2032                 m = priv->clone;
2033
2034         if (unlikely(!m))
2035                 goto out;
2036
2037         for (i = 0, f = m->f; i < m->field_count - 1; i++, f++)
2038                 ;
2039
2040         for (r = 0; r < f->rules; r++) {
2041                 struct nft_pipapo_elem *e;
2042                 struct nft_set_elem elem;
2043
2044                 if (r < f->rules - 1 && f->mt[r + 1].e == f->mt[r].e)
2045                         continue;
2046
2047                 if (iter->count < iter->skip)
2048                         goto cont;
2049
2050                 e = f->mt[r].e;
2051
2052                 elem.priv = e;
2053
2054                 iter->err = iter->fn(ctx, set, iter, &elem);
2055                 if (iter->err < 0)
2056                         goto out;
2057
2058 cont:
2059                 iter->count++;
2060         }
2061
2062 out:
2063         rcu_read_unlock();
2064 }
2065
2066 /**
2067  * nft_pipapo_privsize() - Return the size of private data for the set
2068  * @nla:        netlink attributes, ignored as size doesn't depend on them
2069  * @desc:       Set description, ignored as size doesn't depend on it
2070  *
2071  * Return: size of private data for this set implementation, in bytes
2072  */
2073 static u64 nft_pipapo_privsize(const struct nlattr * const nla[],
2074                                const struct nft_set_desc *desc)
2075 {
2076         return sizeof(struct nft_pipapo);
2077 }
2078
2079 /**
2080  * nft_pipapo_estimate() - Set size, space and lookup complexity
2081  * @desc:       Set description, element count and field description used
2082  * @features:   Flags: NFT_SET_INTERVAL needs to be there
2083  * @est:        Storage for estimation data
2084  *
2085  * Return: true if set description is compatible, false otherwise
2086  */
2087 static bool nft_pipapo_estimate(const struct nft_set_desc *desc, u32 features,
2088                                 struct nft_set_estimate *est)
2089 {
2090         if (!(features & NFT_SET_INTERVAL) ||
2091             desc->field_count < NFT_PIPAPO_MIN_FIELDS)
2092                 return false;
2093
2094         est->size = pipapo_estimate_size(desc);
2095         if (!est->size)
2096                 return false;
2097
2098         est->lookup = NFT_SET_CLASS_O_LOG_N;
2099
2100         est->space = NFT_SET_CLASS_O_N;
2101
2102         return true;
2103 }
2104
2105 /**
2106  * nft_pipapo_init() - Initialise data for a set instance
2107  * @set:        nftables API set representation
2108  * @desc:       Set description
2109  * @nla:        netlink attributes
2110  *
2111  * Validate number and size of fields passed as NFTA_SET_DESC_CONCAT netlink
2112  * attributes, initialise internal set parameters, current instance of matching
2113  * data and a copy for subsequent insertions.
2114  *
2115  * Return: 0 on success, negative error code on failure.
2116  */
2117 static int nft_pipapo_init(const struct nft_set *set,
2118                            const struct nft_set_desc *desc,
2119                            const struct nlattr * const nla[])
2120 {
2121         struct nft_pipapo *priv = nft_set_priv(set);
2122         struct nft_pipapo_match *m;
2123         struct nft_pipapo_field *f;
2124         int err, i, field_count;
2125
2126         field_count = desc->field_count ? : 1;
2127
2128         if (field_count > NFT_PIPAPO_MAX_FIELDS)
2129                 return -EINVAL;
2130
2131         m = kmalloc(struct_size(m, f, field_count), GFP_KERNEL);
2132         if (!m)
2133                 return -ENOMEM;
2134
2135         m->field_count = field_count;
2136         m->bsize_max = 0;
2137
2138         m->scratch = alloc_percpu(unsigned long *);
2139         if (!m->scratch) {
2140                 err = -ENOMEM;
2141                 goto out_scratch;
2142         }
2143         for_each_possible_cpu(i)
2144                 *per_cpu_ptr(m->scratch, i) = NULL;
2145
2146 #ifdef NFT_PIPAPO_ALIGN
2147         m->scratch_aligned = alloc_percpu(unsigned long *);
2148         if (!m->scratch_aligned) {
2149                 err = -ENOMEM;
2150                 goto out_free;
2151         }
2152         for_each_possible_cpu(i)
2153                 *per_cpu_ptr(m->scratch_aligned, i) = NULL;
2154 #endif
2155
2156         rcu_head_init(&m->rcu);
2157
2158         nft_pipapo_for_each_field(f, i, m) {
2159                 int len = desc->field_len[i] ? : set->klen;
2160
2161                 f->bb = NFT_PIPAPO_GROUP_BITS_INIT;
2162                 f->groups = len * NFT_PIPAPO_GROUPS_PER_BYTE(f);
2163
2164                 priv->width += round_up(len, sizeof(u32));
2165
2166                 f->bsize = 0;
2167                 f->rules = 0;
2168                 NFT_PIPAPO_LT_ASSIGN(f, NULL);
2169                 f->mt = NULL;
2170         }
2171
2172         /* Create an initial clone of matching data for next insertion */
2173         priv->clone = pipapo_clone(m);
2174         if (IS_ERR(priv->clone)) {
2175                 err = PTR_ERR(priv->clone);
2176                 goto out_free;
2177         }
2178
2179         priv->dirty = false;
2180
2181         rcu_assign_pointer(priv->match, m);
2182
2183         return 0;
2184
2185 out_free:
2186 #ifdef NFT_PIPAPO_ALIGN
2187         free_percpu(m->scratch_aligned);
2188 #endif
2189         free_percpu(m->scratch);
2190 out_scratch:
2191         kfree(m);
2192
2193         return err;
2194 }
2195
2196 /**
2197  * nft_set_pipapo_match_destroy() - Destroy elements from key mapping array
2198  * @ctx:        context
2199  * @set:        nftables API set representation
2200  * @m:          matching data pointing to key mapping array
2201  */
2202 static void nft_set_pipapo_match_destroy(const struct nft_ctx *ctx,
2203                                          const struct nft_set *set,
2204                                          struct nft_pipapo_match *m)
2205 {
2206         struct nft_pipapo_field *f;
2207         int i, r;
2208
2209         for (i = 0, f = m->f; i < m->field_count - 1; i++, f++)
2210                 ;
2211
2212         for (r = 0; r < f->rules; r++) {
2213                 struct nft_pipapo_elem *e;
2214
2215                 if (r < f->rules - 1 && f->mt[r + 1].e == f->mt[r].e)
2216                         continue;
2217
2218                 e = f->mt[r].e;
2219
2220                 nf_tables_set_elem_destroy(ctx, set, e);
2221         }
2222 }
2223
2224 /**
2225  * nft_pipapo_destroy() - Free private data for set and all committed elements
2226  * @ctx:        context
2227  * @set:        nftables API set representation
2228  */
2229 static void nft_pipapo_destroy(const struct nft_ctx *ctx,
2230                                const struct nft_set *set)
2231 {
2232         struct nft_pipapo *priv = nft_set_priv(set);
2233         struct nft_pipapo_match *m;
2234         int cpu;
2235
2236         m = rcu_dereference_protected(priv->match, true);
2237         if (m) {
2238                 rcu_barrier();
2239
2240                 nft_set_pipapo_match_destroy(ctx, set, m);
2241
2242 #ifdef NFT_PIPAPO_ALIGN
2243                 free_percpu(m->scratch_aligned);
2244 #endif
2245                 for_each_possible_cpu(cpu)
2246                         kfree(*per_cpu_ptr(m->scratch, cpu));
2247                 free_percpu(m->scratch);
2248                 pipapo_free_fields(m);
2249                 kfree(m);
2250                 priv->match = NULL;
2251         }
2252
2253         if (priv->clone) {
2254                 m = priv->clone;
2255
2256                 if (priv->dirty)
2257                         nft_set_pipapo_match_destroy(ctx, set, m);
2258
2259 #ifdef NFT_PIPAPO_ALIGN
2260                 free_percpu(priv->clone->scratch_aligned);
2261 #endif
2262                 for_each_possible_cpu(cpu)
2263                         kfree(*per_cpu_ptr(priv->clone->scratch, cpu));
2264                 free_percpu(priv->clone->scratch);
2265
2266                 pipapo_free_fields(priv->clone);
2267                 kfree(priv->clone);
2268                 priv->clone = NULL;
2269         }
2270 }
2271
2272 /**
2273  * nft_pipapo_gc_init() - Initialise garbage collection
2274  * @set:        nftables API set representation
2275  *
2276  * Instead of actually setting up a periodic work for garbage collection, as
2277  * this operation requires a swap of matching data with the working copy, we'll
2278  * do that opportunistically with other commit operations if the interval is
2279  * elapsed, so we just need to set the current jiffies timestamp here.
2280  */
2281 static void nft_pipapo_gc_init(const struct nft_set *set)
2282 {
2283         struct nft_pipapo *priv = nft_set_priv(set);
2284
2285         priv->last_gc = jiffies;
2286 }
2287
2288 const struct nft_set_type nft_set_pipapo_type = {
2289         .features       = NFT_SET_INTERVAL | NFT_SET_MAP | NFT_SET_OBJECT |
2290                           NFT_SET_TIMEOUT,
2291         .ops            = {
2292                 .lookup         = nft_pipapo_lookup,
2293                 .insert         = nft_pipapo_insert,
2294                 .activate       = nft_pipapo_activate,
2295                 .deactivate     = nft_pipapo_deactivate,
2296                 .flush          = nft_pipapo_flush,
2297                 .remove         = nft_pipapo_remove,
2298                 .walk           = nft_pipapo_walk,
2299                 .get            = nft_pipapo_get,
2300                 .privsize       = nft_pipapo_privsize,
2301                 .estimate       = nft_pipapo_estimate,
2302                 .init           = nft_pipapo_init,
2303                 .destroy        = nft_pipapo_destroy,
2304                 .gc_init        = nft_pipapo_gc_init,
2305                 .commit         = nft_pipapo_commit,
2306                 .abort          = nft_pipapo_abort,
2307                 .elemsize       = offsetof(struct nft_pipapo_elem, ext),
2308         },
2309 };
2310
2311 #if defined(CONFIG_X86_64) && !defined(CONFIG_UML)
2312 const struct nft_set_type nft_set_pipapo_avx2_type = {
2313         .features       = NFT_SET_INTERVAL | NFT_SET_MAP | NFT_SET_OBJECT |
2314                           NFT_SET_TIMEOUT,
2315         .ops            = {
2316                 .lookup         = nft_pipapo_avx2_lookup,
2317                 .insert         = nft_pipapo_insert,
2318                 .activate       = nft_pipapo_activate,
2319                 .deactivate     = nft_pipapo_deactivate,
2320                 .flush          = nft_pipapo_flush,
2321                 .remove         = nft_pipapo_remove,
2322                 .walk           = nft_pipapo_walk,
2323                 .get            = nft_pipapo_get,
2324                 .privsize       = nft_pipapo_privsize,
2325                 .estimate       = nft_pipapo_avx2_estimate,
2326                 .init           = nft_pipapo_init,
2327                 .destroy        = nft_pipapo_destroy,
2328                 .gc_init        = nft_pipapo_gc_init,
2329                 .commit         = nft_pipapo_commit,
2330                 .abort          = nft_pipapo_abort,
2331                 .elemsize       = offsetof(struct nft_pipapo_elem, ext),
2332         },
2333 };
2334 #endif