src/plugins/acl/lookup_context.c

   1 /*
   2  * Copyright (c) 2018 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #include <plugins/acl/acl.h>
  17 #include <plugins/acl/fa_node.h>
  18 #include <vlib/unix/plugin.h>
  19 #include <plugins/acl/public_inlines.h>
  20 #include "hash_lookup.h"
  21 #include "elog_acl_trace.h"
  22
  23 /* check if a given ACL exists */
  24 static u8
  25 acl_plugin_acl_exists (u32 acl_index)
  26 {
  27   acl_main_t *am = &acl_main;
  28
  29   if (pool_is_free_index (am->acls, acl_index))
  30     return 0;
  31
  32   return 1;
  33 }
  34
  35
  36 static u32 get_acl_user_id(acl_main_t *am, char *user_module_name, char *val1_label, char *val2_label)
  37 {
  38     acl_lookup_context_user_t *auser;
  39
  40     pool_foreach (auser, am->acl_users,
  41     ({
  42       if (0 == strcmp(auser->user_module_name, user_module_name)) {
  43         return (auser - am->acl_users);
  44       }
  45     }));
  46
  47     pool_get(am->acl_users, auser);
  48     auser->user_module_name = user_module_name;
  49     auser->val1_label = val1_label;
  50     auser->val2_label = val2_label;
  51     return (auser - am->acl_users);
  52 }
  53
  54 static int acl_user_id_valid(acl_main_t *am, u32 acl_user_id)
  55 {
  56
  57   if (pool_is_free_index (am->acl_users, acl_user_id))
  58     return 0;
  59
  60   return 1;
  61 }
  62
  63 static int acl_lc_index_valid(acl_main_t *am, u32 lc_index)
  64 {
  65
  66   if (pool_is_free_index (am->acl_lookup_contexts, lc_index))
  67     return 0;
  68
  69   return 1;
  70 }
  71
  72 /*
  73  * If you are using ACL plugin, get this unique ID first,
  74  * so you can identify yourself when creating the lookup contexts.
  75  */
  76
  77 static u32 acl_plugin_register_user_module (char *user_module_name, char *val1_label, char *val2_label)
  78 {
  79   acl_main_t *am = &acl_main;
  80   void *oldheap = acl_plugin_set_heap();
  81   u32 user_id = get_acl_user_id(am, user_module_name, val1_label, val2_label);
  82   clib_mem_set_heap (oldheap);
  83   return user_id;
  84 }
  85
  86 /*
  87  * Allocate a new lookup context index.
  88  * Supply the id assigned to your module during registration,
  89  * and two values of your choice identifying instances
  90  * of use within your module. They are useful for debugging.
  91  * If >= 0 - context id. If < 0 - error code.
  92  */
  93
  94 static int acl_plugin_get_lookup_context_index (u32 acl_user_id, u32 val1, u32 val2)
  95 {
  96   acl_main_t *am = &acl_main;
  97   acl_lookup_context_t *acontext;
  98
  99   if (!acl_user_id_valid(am, acl_user_id))
 100     return VNET_API_ERROR_INVALID_REGISTRATION;
 101
 102   void *oldheap = acl_plugin_set_heap ();
 103
 104
 105   pool_get(am->acl_lookup_contexts, acontext);
 106   acontext->acl_indices = 0;
 107   acontext->context_user_id = acl_user_id;
 108   acontext->user_val1 = val1;
 109   acontext->user_val2 = val2;
 110
 111   u32 new_context_id = acontext - am->acl_lookup_contexts;
 112   vec_add1(am->acl_users[acl_user_id].lookup_contexts, new_context_id);
 113
 114   clib_mem_set_heap (oldheap);
 115   return new_context_id;
 116 }
 117
 118 static void
 119 lock_acl(acl_main_t *am, u32 acl, u32 lc_index)
 120 {
 121   vec_validate(am->lc_index_vec_by_acl, acl);
 122   elog_acl_cond_trace_X2(am, (am->trace_acl), "lock acl %d in lc_index %d", "i4i4", acl, lc_index);
 123   vec_add1(am->lc_index_vec_by_acl[acl], lc_index);
 124 }
 125
 126 static void
 127 lock_acl_vec(u32 lc_index, u32 *acls)
 128 {
 129   int i;
 130   acl_main_t *am = &acl_main;
 131   for(i=0; i<vec_len(acls); i++) {
 132     lock_acl(am, acls[i], lc_index);
 133   }
 134 }
 135
 136 static void
 137 unlock_acl(acl_main_t *am, u32 acl, u32 lc_index)
 138 {
 139   vec_validate(am->lc_index_vec_by_acl, acl);
 140   elog_acl_cond_trace_X2(am, (am->trace_acl), "unlock acl %d in lc_index %d", "i4i4", acl, lc_index);
 141   u32 index = vec_search(am->lc_index_vec_by_acl[acl], lc_index);
 142   if (index != ~0)
 143     vec_del1(am->lc_index_vec_by_acl[acl], index);
 144   else
 145     clib_warning("BUG: can not unlock acl %d lc_index %d", acl, lc_index);
 146 }
 147
 148 static void
 149 unlock_acl_vec(u32 lc_index, u32 *acls)
 150 {
 151   int i;
 152   acl_main_t *am = &acl_main;
 153   for(i=0; i<vec_len(acls); i++)
 154   unlock_acl(am, acls[i], lc_index);
 155 }
 156
 157
 158 static void
 159 apply_acl_vec(u32 lc_index, u32 *acls)
 160 {
 161   int i;
 162   acl_main_t *am = &acl_main;
 163
 164   for(i=0; i<vec_len(acls); i++)
 165     hash_acl_apply(am, lc_index, acls[i], i);
 166 }
 167
 168
 169 static void
 170 unapply_acl_vec(u32 lc_index, u32 *acls)
 171 {
 172   int i;
 173   acl_main_t *am = &acl_main;
 174   if (vec_len(acls) == 0)
 175     return;
 176   for(i=vec_len(acls); i > 0; i--)
 177     hash_acl_unapply(am, lc_index, acls[i-1]);
 178 }
 179
 180 /*
 181  * Release the lookup context index and destroy
 182  * any associated data structures.
 183  */
 184 static void acl_plugin_put_lookup_context_index (u32 lc_index)
 185 {
 186   acl_main_t *am = &acl_main;
 187
 188   elog_acl_cond_trace_X1(am, (am->trace_acl), "LOOKUP-CONTEXT: put-context lc_index %d", "i4", lc_index);
 189   if (!acl_lc_index_valid(am, lc_index)) {
 190     clib_warning("BUG: lc_index %d is not valid", lc_index);
 191     return;
 192   }
 193
 194   void *oldheap = acl_plugin_set_heap ();
 195   acl_lookup_context_t *acontext = pool_elt_at_index(am->acl_lookup_contexts, lc_index);
 196
 197   u32 index = vec_search(am->acl_users[acontext->context_user_id].lookup_contexts, lc_index);
 198   ASSERT(index != ~0);
 199
 200   vec_del1(am->acl_users[acontext->context_user_id].lookup_contexts, index);
 201   unapply_acl_vec(lc_index, acontext->acl_indices);
 202   unlock_acl_vec(lc_index, acontext->acl_indices);
 203   vec_free(acontext->acl_indices);
 204   pool_put(am->acl_lookup_contexts, acontext);
 205   clib_mem_set_heap (oldheap);
 206 }
 207
 208 /*
 209  * Prepare the sequential vector of ACL#s to lookup within a given context.
 210  * Any existing list will be overwritten. acl_list is a vector.
 211  */
 212 static int acl_plugin_set_acl_vec_for_context (u32 lc_index, u32 *acl_list)
 213 {
 214   int rv = 0;
 215   uword *seen_acl_bitmap = 0;
 216   u32 *pacln = 0;
 217   acl_main_t *am = &acl_main;
 218   acl_lookup_context_t *acontext;
 219   if (am->trace_acl) {
 220     u32 i;
 221     elog_acl_cond_trace_X1(am, (1), "LOOKUP-CONTEXT: set-acl-list lc_index %d", "i4", lc_index);
 222     for(i=0; i<vec_len(acl_list); i++) {
 223       elog_acl_cond_trace_X2(am, (1), "   acl-list[%d]: %d", "i4i4", i, acl_list[i]);
 224     }
 225   }
 226   if (!acl_lc_index_valid(am, lc_index)) {
 227     clib_warning("BUG: lc_index %d is not valid", lc_index);
 228     return -1;
 229   }
 230   void *oldheap = acl_plugin_set_heap ();
 231
 232   vec_foreach (pacln, acl_list)
 233   {
 234     if (pool_is_free_index (am->acls, *pacln))
 235       {
 236         /* ACL is not defined. Can not apply */
 237         clib_warning ("ERROR: ACL %d not defined", *pacln);
 238         rv = VNET_API_ERROR_NO_SUCH_ENTRY;
 239         goto done;
 240       }
 241     if (clib_bitmap_get (seen_acl_bitmap, *pacln))
 242       {
 243         /* ACL being applied twice within the list. error. */
 244         clib_warning ("ERROR: ACL %d being applied twice", *pacln);
 245         rv = VNET_API_ERROR_ENTRY_ALREADY_EXISTS;
 246         goto done;
 247       }
 248     seen_acl_bitmap = clib_bitmap_set (seen_acl_bitmap, *pacln, 1);
 249   }
 250
 251   acontext = pool_elt_at_index(am->acl_lookup_contexts, lc_index);
 252   u32 *old_acl_vector = acontext->acl_indices;
 253   acontext->acl_indices = vec_dup(acl_list);
 254
 255   unapply_acl_vec(lc_index, old_acl_vector);
 256   unlock_acl_vec(lc_index, old_acl_vector);
 257   lock_acl_vec(lc_index, acontext->acl_indices);
 258   apply_acl_vec(lc_index, acontext->acl_indices);
 259
 260   vec_free(old_acl_vector);
 261
 262 done:
 263   clib_bitmap_free (seen_acl_bitmap);
 264   clib_mem_set_heap (oldheap);
 265   return rv;
 266 }
 267
 268
 269 void acl_plugin_lookup_context_notify_acl_change(u32 acl_num)
 270 {
 271   acl_main_t *am = &acl_main;
 272   if (acl_plugin_acl_exists(acl_num)) {
 273     if (hash_acl_exists(am, acl_num)) {
 274         /* this is a modification, clean up the older entries */
 275         hash_acl_delete(am, acl_num);
 276     }
 277     hash_acl_add(am, acl_num);
 278   } else {
 279     /* this is a deletion notification */
 280     hash_acl_delete(am, acl_num);
 281   }
 282 }
 283
 284
 285 /* Fill the 5-tuple from the packet */
 286
 287 static void acl_plugin_fill_5tuple (u32 lc_index, vlib_buffer_t * b0, int is_ip6, int is_input,
 288                                 int is_l2_path, fa_5tuple_opaque_t * p5tuple_pkt)
 289 {
 290   acl_plugin_fill_5tuple_inline(&acl_main, lc_index, b0, is_ip6, is_input, is_l2_path, p5tuple_pkt);
 291 }
 292
 293 static int acl_plugin_match_5tuple (u32 lc_index,
 294                                            fa_5tuple_opaque_t * pkt_5tuple,
 295                                            int is_ip6, u8 * r_action,
 296                                            u32 * r_acl_pos_p,
 297                                            u32 * r_acl_match_p,
 298                                            u32 * r_rule_match_p,
 299                                            u32 * trace_bitmap)
 300 {
 301   return acl_plugin_match_5tuple_inline (&acl_main, lc_index, pkt_5tuple, is_ip6, r_action, r_acl_pos_p, r_acl_match_p, r_rule_match_p, trace_bitmap);
 302 }
 303
 304
 305 void
 306 acl_plugin_show_lookup_user (u32 user_index)
 307 {
 308     acl_main_t *am = &acl_main;
 309     vlib_main_t *vm = am->vlib_main;
 310     acl_lookup_context_user_t *auser;
 311
 312     pool_foreach (auser, am->acl_users,
 313     ({
 314       u32 curr_user_index = (auser - am->acl_users);
 315       if (user_index == ~0 || (curr_user_index == user_index)) {
 316         vlib_cli_output (vm, "index %d:%s:%s:%s", curr_user_index, auser->user_module_name, auser->val1_label, auser->val2_label);
 317       }
 318     }));
 319 }
 320
 321
 322 void
 323 acl_plugin_show_lookup_context (u32 lc_index)
 324 {
 325   acl_main_t *am = &acl_main;
 326   vlib_main_t *vm = am->vlib_main;
 327   acl_lookup_context_t *acontext;
 328   // clib_warning("LOOKUP-CONTEXT: lc_index %d acl_list [ %U ]", lc_index, format_vec32, acl_list, "%d");
 329   if (!am->acl_lookup_contexts)
 330   {
 331     vlib_cli_output(vm, "ACL lookup contexts are not initialized");
 332     return;
 333   }
 334
 335   pool_foreach (acontext, am->acl_lookup_contexts,
 336   ({
 337     u32 curr_lc_index = (acontext - am->acl_lookup_contexts);
 338     if ((lc_index == ~0) || (curr_lc_index == lc_index)) {
 339       if (acl_user_id_valid(am, acontext->context_user_id)) {
 340         acl_lookup_context_user_t *auser = pool_elt_at_index(am->acl_users, acontext->context_user_id);
 341         vlib_cli_output (vm, "index %d:%s %s: %d %s: %d, acl_indices: %U",
 342                        curr_lc_index, auser->user_module_name, auser->val1_label,
 343                        acontext->user_val1, auser->val2_label, acontext->user_val2,
 344                        format_vec32, acontext->acl_indices, "%d");
 345       } else {
 346         vlib_cli_output (vm, "index %d: user_id: %d user_val1: %d user_val2: %d, acl_indices: %U",
 347                        curr_lc_index, acontext->context_user_id,
 348                        acontext->user_val1, acontext->user_val2,
 349                        format_vec32, acontext->acl_indices, "%d");
 350       }
 351     }
 352   }));
 353 }
 354
 355 void *
 356 acl_plugin_get_p_acl_main(void)
 357 {
 358   return &acl_main;
 359 }
 360
 361 clib_error_t *acl_plugin_methods_vtable_init(acl_plugin_methods_t *m)
 362 {
 363   m->p_acl_main = &acl_main;
 364 #define _(name) m->name = acl_plugin_ ## name;
 365   foreach_acl_plugin_exported_method_name
 366 #undef _
 367   return 0;
 368 }