LCOV - code coverage report
Current view: top level - libbpfilter - rule.c (source / functions) Coverage Total Hit
Test: coverage.lcov Lines: 85.2 % 108 92
Test Date: 2026-05-09 09:49:18 Functions: 100.0 % 8 8
Branches: 43.4 % 136 59

             Branch data     Line data    Source code
       1                 :             : /* SPDX-License-Identifier: GPL-2.0-only */
       2                 :             : /*
       3                 :             :  * Copyright (c) 2022 Meta Platforms, Inc. and affiliates.
       4                 :             :  */
       5                 :             : 
       6                 :             : #include "bpfilter/rule.h"
       7                 :             : 
       8                 :             : #include <errno.h>
       9                 :             : #include <inttypes.h>
      10                 :             : #include <stdlib.h>
      11                 :             : #include <string.h>
      12                 :             : 
      13                 :             : #include "bpfilter/core/list.h"
      14                 :             : #include "bpfilter/dump.h"
      15                 :             : #include "bpfilter/helper.h"
      16                 :             : #include "bpfilter/logger.h"
      17                 :             : #include "bpfilter/matcher.h"
      18                 :             : #include "bpfilter/pack.h"
      19                 :             : #include "bpfilter/runtime.h"
      20                 :             : #include "bpfilter/verdict.h"
      21                 :             : 
      22                 :             : static const char *_bf_log_opt_strs[] = {
      23                 :             :     [BF_LOG_OPT_LINK] = "link",
      24                 :             :     [BF_LOG_OPT_INTERNET] = "internet",
      25                 :             :     [BF_LOG_OPT_TRANSPORT] = "transport",
      26                 :             : };
      27                 :             : static_assert_enum_mapping(_bf_log_opt_strs, _BF_LOG_OPT_MAX);
      28                 :             : 
      29                 :           9 : const char *bf_log_opt_to_str(enum bf_log_opt hdr)
      30                 :             : {
      31         [ +  + ]:           9 :     if (hdr < 0 || hdr >= _BF_LOG_OPT_MAX)
      32                 :             :         return "<bf_log_opt unknown>";
      33                 :             : 
      34                 :           7 :     return _bf_log_opt_strs[hdr];
      35                 :             : }
      36                 :             : 
      37                 :          64 : int bf_log_opt_from_str(const char *str, enum bf_log_opt *hdr)
      38                 :             : {
      39                 :             :     assert(hdr);
      40                 :             : 
      41         [ +  + ]:         126 :     for (int i = 0; i < _BF_LOG_OPT_MAX; ++i) {
      42         [ +  + ]:         121 :         if (bf_streq_i(str, _bf_log_opt_strs[i])) {
      43                 :          59 :             *hdr = (enum bf_log_opt)i;
      44                 :          59 :             return 0;
      45                 :             :         }
      46                 :             :     }
      47                 :             : 
      48                 :             :     return -EINVAL;
      49                 :             : }
      50                 :             : 
      51                 :        9066 : int bf_rule_new(struct bf_rule **rule)
      52                 :             : {
      53                 :             :     struct bf_rule *_rule;
      54                 :             : 
      55                 :             :     assert(rule);
      56                 :             : 
      57                 :        9066 :     _rule = calloc(1, sizeof(*_rule));
      58         [ +  - ]:        9066 :     if (!_rule)
      59                 :             :         return -ENOMEM;
      60                 :             : 
      61                 :        9066 :     _rule->matchers = bf_list_default(bf_matcher_free, bf_matcher_pack);
      62                 :             : 
      63                 :        9066 :     *rule = _rule;
      64                 :             : 
      65                 :        9066 :     return 0;
      66                 :             : }
      67                 :             : 
      68                 :        6879 : int bf_rule_new_from_pack(struct bf_rule **rule, bf_rpack_node_t node)
      69                 :             : {
      70                 :        6879 :     _free_bf_rule_ struct bf_rule *_rule = NULL;
      71                 :             :     bf_rpack_node_t m_nodes, m_node;
      72                 :             :     bool has_counters;
      73                 :             :     int r;
      74                 :             : 
      75                 :             :     assert(rule);
      76                 :             : 
      77                 :        6879 :     r = bf_rule_new(&_rule);
      78         [ -  + ]:        6879 :     if (r)
      79         [ #  # ]:           0 :         return bf_err_r(r, "failed to create bf_rule from pack");
      80                 :             : 
      81                 :        6879 :     r = bf_rpack_kv_u32(node, "index", &_rule->index);
      82         [ -  + ]:        6879 :     if (r)
      83         [ #  # ]:           0 :         return bf_rpack_key_err(r, "bf_rule.index");
      84                 :             : 
      85                 :        6879 :     r = bf_rpack_kv_u8(node, "log", &_rule->log);
      86         [ +  + ]:        6879 :     if (r)
      87         [ +  - ]:           1 :         return bf_rpack_key_err(r, "bf_rule.log");
      88                 :             : 
      89         [ +  - ]:        6878 :     if (bf_rpack_kv_contains(node, "has_counters")) {
      90                 :        6878 :         r = bf_rpack_kv_bool(node, "has_counters", &has_counters);
      91         [ -  + ]:        6878 :         if (r)
      92         [ #  # ]:           0 :             return bf_rpack_key_err(r, "bf_rule.has_counters");
      93         [ #  # ]:           0 :     } else if (bf_rpack_kv_contains(node, "counters")) {
      94                 :           0 :         r = bf_rpack_kv_bool(node, "counters", &has_counters);
      95         [ #  # ]:           0 :         if (r)
      96         [ #  # ]:           0 :             return bf_rpack_key_err(r, "bf_rule.counters");
      97                 :             :     } else {
      98         [ #  # ]:           0 :         return bf_err_r(-ENOENT, "missing bf_rule counters flag in pack");
      99                 :             :     }
     100                 :        6878 :     _rule->has_counters = has_counters;
     101                 :             : 
     102                 :        6878 :     r = bf_rpack_kv_u64(node, "mark", &_rule->mark);
     103         [ -  + ]:        6878 :     if (r)
     104         [ #  # ]:           0 :         return bf_rpack_key_err(r, "bf_rule.mark");
     105                 :             : 
     106   [ -  +  -  +  :        6878 :     r = bf_rpack_kv_enum(node, "verdict", &_rule->verdict, 0, _BF_VERDICT_MAX);
                   -  - ]
     107                 :             :     if (r)
     108         [ #  # ]:           0 :         return bf_rpack_key_err(r, "bf_rule.verdict");
     109                 :             : 
     110         [ +  - ]:        6878 :     if (bf_rpack_kv_contains(node, "redirect_ifindex")) {
     111                 :        6878 :         r = bf_rpack_kv_u32(node, "redirect_ifindex", &_rule->redirect_ifindex);
     112         [ -  + ]:        6878 :         if (r)
     113         [ #  # ]:           0 :             return bf_rpack_key_err(r, "bf_rule.redirect_ifindex");
     114                 :             :     }
     115                 :             : 
     116         [ +  - ]:        6878 :     if (bf_rpack_kv_contains(node, "redirect_dir")) {
     117   [ -  +  -  +  :        6878 :         r = bf_rpack_kv_enum(node, "redirect_dir", &_rule->redirect_dir, 0,
                   -  - ]
     118                 :             :                              _BF_REDIRECT_DIR_MAX);
     119                 :             :         if (r)
     120         [ #  # ]:           0 :             return bf_rpack_key_err(r, "bf_rule.redirect_dir");
     121                 :             :     }
     122                 :             : 
     123                 :        6878 :     r = bf_rpack_kv_array(node, "matchers", &m_nodes);
     124         [ -  + ]:        6878 :     if (r)
     125         [ #  # ]:           0 :         return bf_rpack_key_err(r, "bf_rule.matchers");
     126   [ +  -  +  +  :       29984 :     bf_rpack_array_foreach (m_nodes, m_node) {
                   +  + ]
     127                 :       16228 :         _free_bf_matcher_ struct bf_matcher *matcher = NULL;
     128                 :             : 
     129   [ +  -  +  -  :        8114 :         r = bf_list_emplace(&_rule->matchers, bf_matcher_new_from_pack, matcher,
             -  -  -  - ]
     130                 :             :                             m_node);
     131                 :             :         if (r) {
     132         [ #  # ]:           0 :             return bf_err_r(
     133                 :             :                 r, "failed to unpack bf_matcher into bf_rule.matchers");
     134                 :             :         }
     135                 :             :     }
     136                 :             : 
     137                 :        6878 :     *rule = TAKE_PTR(_rule);
     138                 :             : 
     139                 :        6878 :     return 0;
     140                 :             : }
     141                 :             : 
     142                 :       23885 : void bf_rule_free(struct bf_rule **rule)
     143                 :             : {
     144                 :             :     assert(rule);
     145                 :             : 
     146         [ +  + ]:       23885 :     if (!*rule)
     147                 :             :         return;
     148                 :             : 
     149                 :        9066 :     bf_list_clean(&(*rule)->matchers);
     150                 :             : 
     151                 :        9066 :     free(*rule);
     152                 :        9066 :     *rule = NULL;
     153                 :             : }
     154                 :             : 
     155                 :        3169 : int bf_rule_pack(const struct bf_rule *rule, bf_wpack_t *pack)
     156                 :             : {
     157                 :             :     assert(rule);
     158                 :             :     assert(pack);
     159                 :             : 
     160                 :        3169 :     bf_wpack_kv_u32(pack, "index", rule->index);
     161                 :        3169 :     bf_wpack_kv_u8(pack, "log", rule->log);
     162                 :        3169 :     bf_wpack_kv_bool(pack, "has_counters", rule->has_counters);
     163                 :        3169 :     bf_wpack_kv_u64(pack, "mark", rule->mark);
     164                 :        3169 :     bf_wpack_kv_int(pack, "verdict", rule->verdict);
     165                 :        3169 :     bf_wpack_kv_u32(pack, "redirect_ifindex", rule->redirect_ifindex);
     166                 :        3169 :     bf_wpack_kv_int(pack, "redirect_dir", rule->redirect_dir);
     167                 :             : 
     168                 :        3169 :     bf_wpack_kv_list(pack, "matchers", &rule->matchers);
     169                 :             : 
     170         [ -  + ]:        3169 :     return bf_wpack_is_valid(pack) ? 0 : -EINVAL;
     171                 :             : }
     172                 :             : 
     173                 :          14 : void bf_rule_dump(const struct bf_rule *rule, prefix_t *prefix)
     174                 :             : {
     175                 :             :     assert(rule);
     176                 :             :     assert(prefix);
     177                 :             : 
     178         [ -  + ]:          14 :     DUMP(prefix, "struct bf_rule at %p", rule);
     179                 :             : 
     180                 :          14 :     bf_dump_prefix_push(prefix);
     181                 :             : 
     182         [ -  + ]:          14 :     DUMP(prefix, "index: %u", rule->index);
     183                 :             : 
     184                 :             :     // Matchers
     185         [ -  + ]:          14 :     DUMP(prefix, "matchers: %lu", bf_list_size(&rule->matchers));
     186                 :          14 :     bf_dump_prefix_push(prefix);
     187   [ +  +  +  +  :          96 :     bf_list_foreach (&rule->matchers, matcher_node) {
                   +  + ]
     188                 :             :         struct bf_matcher *matcher = bf_list_node_get_data(matcher_node);
     189                 :             : 
     190         [ +  + ]:          34 :         if (bf_list_is_tail(&rule->matchers, matcher_node))
     191                 :          13 :             bf_dump_prefix_last(prefix);
     192                 :             : 
     193                 :          34 :         bf_matcher_dump(matcher, prefix);
     194                 :             :     }
     195                 :          14 :     bf_dump_prefix_pop(prefix);
     196                 :             : 
     197         [ -  + ]:          14 :     DUMP(prefix, "log: %02x", rule->log);
     198                 :             : 
     199   [ -  +  -  - ]:          14 :     DUMP(prefix, "has_counters: %s", rule->has_counters ? "yes" : "no");
     200         [ +  + ]:          14 :     if (rule->has_counters) {
     201         [ -  + ]:          10 :         DUMP(prefix, "counters: struct bf_counter");
     202                 :          10 :         bf_dump_prefix_push(prefix);
     203         [ -  + ]:          10 :         DUMP(prefix, "count: %lu", rule->counters.count);
     204         [ -  + ]:          10 :         DUMP(prefix, "size: %lu", rule->counters.size);
     205                 :          10 :         bf_dump_prefix_pop(prefix);
     206                 :             :     }
     207                 :             : 
     208   [ -  +  -  - ]:          14 :     DUMP(prefix, "disabled: %s", rule->disabled ? "yes" : "no");
     209         [ -  + ]:          14 :     DUMP(prefix, "mark: 0x%" PRIx64, rule->mark);
     210         [ -  + ]:          14 :     DUMP(prefix, "verdict: %s", bf_verdict_to_str(rule->verdict));
     211         [ -  + ]:          14 :     if (bf_rule_has_redirect(rule)) {
     212         [ #  # ]:           0 :         DUMP(prefix, "redirect_ifindex: %u", rule->redirect_ifindex);
     213         [ #  # ]:           0 :         DUMP(bf_dump_prefix_last(prefix), "redirect_dir: %s",
     214                 :             :              bf_redirect_dir_to_str(rule->redirect_dir));
     215                 :             :     } else {
     216         [ -  + ]:          14 :         DUMP(prefix, "redirect_ifindex: <not set>");
     217         [ -  + ]:          14 :         DUMP(bf_dump_prefix_last(prefix), "redirect_dir: <not set>");
     218                 :             :     }
     219                 :             : 
     220                 :          14 :     bf_dump_prefix_pop(prefix);
     221                 :          14 : }
     222                 :             : 
     223                 :        1167 : int bf_rule_add_matcher(struct bf_rule *rule, enum bf_matcher_type type,
     224                 :             :                         enum bf_matcher_op op, const void *payload,
     225                 :             :                         size_t payload_len, bool negate)
     226                 :             : {
     227                 :        1167 :     _free_bf_matcher_ struct bf_matcher *matcher = NULL;
     228                 :             :     int r;
     229                 :             : 
     230                 :             :     assert(rule);
     231                 :             : 
     232                 :        1167 :     r = bf_matcher_new(&matcher, type, op, payload, payload_len, negate);
     233         [ +  - ]:        1167 :     if (r)
     234                 :             :         return r;
     235                 :             : 
     236                 :        1167 :     r = bf_list_add_tail(&rule->matchers, matcher);
     237         [ +  - ]:        1167 :     if (r)
     238                 :             :         return r;
     239                 :             : 
     240                 :        1167 :     TAKE_PTR(matcher);
     241                 :             : 
     242                 :        1167 :     return 0;
     243                 :             : }
        

Generated by: LCOV version 2.0-1