src/plugins/mactime/node.c

   1 /*
   2  * node.c - skeleton vpp engine plug-in dual-loop node skeleton
   3  *
   4  * Copyright (c) <current-year> <your-organization>
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17 #include <vlib/vlib.h>
  18 #include <vnet/vnet.h>
  19 #include <vnet/pg/pg.h>
  20 #include <vppinfra/error.h>
  21 #include <mactime/mactime.h>
  22 #include <vnet/ip/ip4.h>
  23
  24 typedef struct
  25 {
  26   u32 next_index;
  27   u32 device_index;
  28   u8 src_mac[6];
  29   u8 device_name[64];
  30 } mactime_trace_t;
  31
  32 vlib_node_registration_t mactime_node;
  33 vlib_node_registration_t mactime_tx_node;
  34
  35 #define foreach_mactime_error                   \
  36 _(OK, "Permitted packets")                      \
  37 _(STATIC_DROP, "Static drop packets")           \
  38 _(RANGE_DROP, "Range drop packets")             \
  39 _(QUOTA_DROP, "Data quota drop packets")        \
  40 _(DROP_10001, "Dropped UDP DST-port 10001")
  41
  42 typedef enum
  43 {
  44 #define _(sym,str) MACTIME_ERROR_##sym,
  45   foreach_mactime_error
  46 #undef _
  47     MACTIME_N_ERROR,
  48 } mactime_error_t;
  49
  50 static char *mactime_error_strings[] = {
  51 #define _(sym,string) string,
  52   foreach_mactime_error
  53 #undef _
  54 };
  55
  56 typedef enum
  57 {
  58   MACTIME_NEXT_DROP,
  59   MACTIME_NEXT_ETHERNET_INPUT,
  60   MACTIME_N_NEXT,
  61 } mactime_next_t;
  62
  63 /* packet trace format function */
  64 static u8 *
  65 format_mactime_trace (u8 * s, va_list * args)
  66 {
  67   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  68   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  69   mactime_trace_t *t = va_arg (*args, mactime_trace_t *);
  70
  71   s = format (s, "MACTIME: src mac %U device %s result %s\n",
  72               format_mac_address, t->src_mac,
  73               (t->device_index != ~0) ? t->device_name : (u8 *) "unknown",
  74               t->next_index == MACTIME_NEXT_DROP ? "drop" : "pass");
  75   return s;
  76 }
  77
  78 static uword
  79 mactime_node_inline (vlib_main_t * vm,
  80                      vlib_node_runtime_t * node, vlib_frame_t * frame,
  81                      int is_tx)
  82 {
  83   u32 n_left_from, *from, *to_next;
  84   mactime_next_t next_index;
  85   mactime_main_t *mm = &mactime_main;
  86   mactime_device_t *dp;
  87   clib_bihash_kv_8_8_t kv;
  88   clib_bihash_8_8_t *lut = &mm->lookup_table;
  89   u32 packets_ok = 0;
  90   f64 now;
  91   u32 thread_index = vm->thread_index;
  92   vnet_main_t *vnm = vnet_get_main ();
  93   vnet_interface_main_t *im = &vnm->interface_main;
  94   u8 arc = im->output_feature_arc_index;
  95   vnet_feature_config_main_t *fcm;
  96
  97   if (is_tx)
  98     fcm = vnet_feature_get_config_main (arc);
  99
 100   now = clib_timebase_now (&mm->timebase);
 101
 102   if (PREDICT_FALSE ((now - mm->sunday_midnight) > 86400.0 * 7.0))
 103     mm->sunday_midnight = clib_timebase_find_sunday_midnight (now);
 104
 105   from = vlib_frame_vector_args (frame);
 106   n_left_from = frame->n_vectors;
 107   next_index = node->cached_next_index;
 108
 109   while (n_left_from > 0)
 110     {
 111       u32 n_left_to_next;
 112
 113       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
 114
 115       while (n_left_from > 0 && n_left_to_next > 0)
 116         {
 117           u32 bi0;
 118           vlib_buffer_t *b0;
 119           u32 next0;
 120           u32 device_index0;
 121           u32 len0;
 122           ethernet_header_t *en0;
 123           int has_dynamic_range_allow = 0;
 124           int i;
 125
 126           /* speculatively enqueue b0 to the current next frame */
 127           bi0 = from[0];
 128           to_next[0] = bi0;
 129           from += 1;
 130           to_next += 1;
 131           n_left_from -= 1;
 132           n_left_to_next -= 1;
 133
 134           b0 = vlib_get_buffer (vm, bi0);
 135
 136           /* Set next0 to e.g. interface-tx */
 137           if (is_tx)
 138             vnet_get_config_data (&fcm->config_main,
 139                                   &b0->current_config_index, &next0,
 140                                   /* # bytes of config data */ 0);
 141           else
 142             next0 = MACTIME_NEXT_ETHERNET_INPUT;
 143
 144           vlib_buffer_advance (b0, -(word) vnet_buffer (b0)->l2_hdr_offset);
 145
 146           len0 = vlib_buffer_length_in_chain (vm, b0);
 147           en0 = vlib_buffer_get_current (b0);
 148           kv.key = 0;
 149           if (is_tx)
 150             clib_memcpy_fast (&kv.key, en0->dst_address, 6);
 151           else
 152             clib_memcpy_fast (&kv.key, en0->src_address, 6);
 153
 154           /* Lookup the src/dst mac address */
 155           if (clib_bihash_search_8_8 (lut, &kv, &kv) < 0)
 156             {
 157               /* Create a table entry... */
 158               mactime_send_create_entry_message
 159                 (is_tx ? en0->dst_address : en0->src_address);
 160
 161               /* and let this packet pass */
 162               device_index0 = ~0;
 163               dp = 0;
 164               packets_ok++;
 165               goto trace0;
 166             }
 167           else
 168             device_index0 = kv.value;
 169
 170           dp = pool_elt_at_index (mm->devices, device_index0);
 171
 172           /* Known device, check for an always-on traffic quota */
 173           if ((dp->flags & MACTIME_DEVICE_FLAG_DYNAMIC_ALLOW)
 174               && PREDICT_FALSE (dp->data_quota))
 175             {
 176               vlib_counter_t device_current_count;
 177               vlib_get_combined_counter (&mm->allow_counters,
 178                                          dp - mm->devices,
 179                                          &device_current_count);
 180               if (device_current_count.bytes >= dp->data_quota)
 181                 {
 182                   next0 = MACTIME_NEXT_DROP;
 183                   b0->error = node->errors[MACTIME_ERROR_QUOTA_DROP];
 184                   vlib_increment_combined_counter
 185                     (&mm->drop_counters, thread_index, dp - mm->devices, 1,
 186                      len0);
 187                   goto trace0;
 188                 }
 189             }
 190
 191           /* Static drop / allow? */
 192           if (PREDICT_FALSE
 193               (dp->flags &
 194                (MACTIME_DEVICE_FLAG_STATIC_DROP
 195                 | MACTIME_DEVICE_FLAG_STATIC_ALLOW)))
 196             {
 197               if (dp->flags & MACTIME_DEVICE_FLAG_STATIC_DROP)
 198                 {
 199                   next0 = MACTIME_NEXT_DROP;
 200                   b0->error = node->errors[MACTIME_ERROR_STATIC_DROP];
 201                   vlib_increment_combined_counter
 202                     (&mm->drop_counters, thread_index, dp - mm->devices, 1,
 203                      len0);
 204                 }
 205               else              /* note next0 set to allow */
 206                 {
 207                   /*
 208                    * Special-case mini-ACL for a certain species of
 209                    * home security DVR which likes to "call home."
 210                    */
 211                   if (PREDICT_FALSE
 212                       (dp->flags & MACTIME_DEVICE_FLAG_DROP_UDP_10001))
 213                     {
 214                       ip4_header_t *ip = (void *) (((u8 *) en0) + 14);
 215                       udp_header_t *udp = (udp_header_t *) (ip + 1);
 216                       if (ip->protocol != IP_PROTOCOL_UDP)
 217                         goto pass;
 218                       if (clib_net_to_host_u16 (udp->dst_port) == 10001 ||
 219                           clib_net_to_host_u16 (udp->dst_port) == 9603)
 220                         {
 221                           next0 = MACTIME_NEXT_DROP;
 222                           b0->error = node->errors[MACTIME_ERROR_DROP_10001];
 223                         }
 224                       else
 225                         goto pass;
 226                     }
 227                   else
 228                     {
 229                     pass:
 230                       vlib_increment_combined_counter
 231                         (&mm->allow_counters, thread_index, dp - mm->devices,
 232                          1, len0);
 233                       packets_ok++;
 234                     }
 235                 }
 236               goto trace0;
 237             }
 238
 239           /* Known device, see if traffic allowed at the moment */
 240           for (i = 0; i < vec_len (dp->ranges); i++)
 241             {
 242               clib_timebase_range_t *r = dp->ranges + i;
 243               f64 start0, end0;
 244
 245               start0 = r->start + mm->sunday_midnight;
 246               end0 = r->end + mm->sunday_midnight;
 247               if (dp->flags & MACTIME_DEVICE_FLAG_DYNAMIC_ALLOW_QUOTA)
 248                 has_dynamic_range_allow = 1;
 249
 250               /* Packet within time range */
 251               if (now >= start0 && now <= end0)
 252                 {
 253                   /* And it's a drop range, drop it */
 254                   if (dp->flags & MACTIME_DEVICE_FLAG_DYNAMIC_DROP)
 255                     {
 256                       vlib_increment_combined_counter
 257                         (&mm->drop_counters, thread_index,
 258                          dp - mm->devices, 1, len0);
 259                       next0 = MACTIME_NEXT_DROP;
 260                       b0->error = node->errors[MACTIME_ERROR_RANGE_DROP];
 261                       goto trace0;
 262                     }
 263                   /* Quota-check allow range? */
 264                   else if (has_dynamic_range_allow)
 265                     {
 266                       if (dp->data_used_in_range + len0 >= dp->data_quota)
 267                         {
 268                           next0 = MACTIME_NEXT_DROP;
 269                           b0->error = node->errors[MACTIME_ERROR_QUOTA_DROP];
 270                           vlib_increment_combined_counter
 271                             (&mm->drop_counters, thread_index,
 272                              dp - mm->devices, 1, len0);
 273                           goto trace0;
 274                         }
 275                       else
 276                         {
 277                           dp->data_used_in_range += len0;
 278                           goto allow0;
 279                         }
 280                     }
 281                   else
 282                     {           /* it's an allow range, allow it */
 283                     allow0:
 284                       vlib_increment_combined_counter
 285                         (&mm->allow_counters, thread_index,
 286                          dp - mm->devices, 1, len0);
 287                       packets_ok++;
 288                       goto trace0;
 289                     }
 290                 }
 291             }
 292           /*
 293            * Didn't hit a range, so *drop* if allow configured, or
 294            * *allow* if drop configured.
 295            */
 296           if (dp->flags & MACTIME_DEVICE_FLAG_DYNAMIC_ALLOW)
 297             {
 298               next0 = MACTIME_NEXT_DROP;
 299               b0->error = node->errors[MACTIME_ERROR_STATIC_DROP];
 300               vlib_increment_combined_counter
 301                 (&mm->drop_counters, thread_index, dp - mm->devices, 1, len0);
 302             }
 303           else                  /* DYNAMIC_DROP, DYNAMIC_RANGE_ALLOW_QUOTA */
 304             {
 305               vlib_increment_combined_counter
 306                 (&mm->allow_counters, thread_index, dp - mm->devices, 1,
 307                  len0);
 308               /* Clear the data quota accumulater */
 309               dp->data_used_in_range = 0;
 310               packets_ok++;
 311             }
 312
 313         trace0:
 314           if (PREDICT_FALSE ((node->flags & VLIB_NODE_FLAG_TRACE)
 315                              && (b0->flags & VLIB_BUFFER_IS_TRACED)))
 316             {
 317               mactime_trace_t *t = vlib_add_trace (vm, node, b0, sizeof (*t));
 318               clib_memcpy_fast (t->src_mac, en0->src_address,
 319                                 sizeof (t->src_mac));
 320
 321               t->next_index = next0;
 322               t->device_index = device_index0;
 323
 324               if (dp)
 325                 {
 326                   clib_memcpy_fast (t->device_name, dp->device_name,
 327                                     ARRAY_LEN (t->device_name));
 328                   t->device_name[ARRAY_LEN (t->device_name) - 1] = 0;
 329                 }
 330             }
 331
 332           /* verify speculative enqueue, maybe switch current next frame */
 333           vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
 334                                            to_next, n_left_to_next,
 335                                            bi0, next0);
 336         }
 337
 338       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
 339     }
 340
 341   vlib_node_increment_counter (vm, node->node_index,
 342                                MACTIME_ERROR_OK, packets_ok);
 343   return frame->n_vectors;
 344 }
 345
 346 static uword
 347 mactime_node_fn (vlib_main_t * vm,
 348                  vlib_node_runtime_t * node, vlib_frame_t * frame)
 349 {
 350   return mactime_node_inline (vm, node, frame, 0 /* is_tx */ );
 351 }
 352
 353 /* *INDENT-OFF* */
 354 VLIB_REGISTER_NODE (mactime_node) =
 355 {
 356   .function = mactime_node_fn,
 357   .name = "mactime",
 358   .vector_size = sizeof (u32),
 359   .format_trace = format_mactime_trace,
 360   .type = VLIB_NODE_TYPE_INTERNAL,
 361
 362   .n_errors = ARRAY_LEN(mactime_error_strings),
 363   .error_strings = mactime_error_strings,
 364
 365   .n_next_nodes = MACTIME_N_NEXT,
 366
 367   /* edit / add dispositions here */
 368   .next_nodes =
 369   {
 370     [MACTIME_NEXT_ETHERNET_INPUT] = "ethernet-input",
 371     [MACTIME_NEXT_DROP] = "error-drop",
 372   },
 373 };
 374 /* *INDENT-ON* */
 375
 376 static uword
 377 mactime_tx_node_fn (vlib_main_t * vm,
 378                     vlib_node_runtime_t * node, vlib_frame_t * frame)
 379 {
 380   return mactime_node_inline (vm, node, frame, 1 /* is_tx */ );
 381 }
 382
 383 /* *INDENT-OFF* */
 384 VLIB_REGISTER_NODE (mactime_tx_node) =
 385 {
 386   .function = mactime_tx_node_fn,
 387   .name = "mactime-tx",
 388   .vector_size = sizeof (u32),
 389   .format_trace = format_mactime_trace,
 390   .type = VLIB_NODE_TYPE_INTERNAL,
 391
 392   .n_errors = ARRAY_LEN(mactime_error_strings),
 393   .error_strings = mactime_error_strings,
 394
 395   .n_next_nodes = MACTIME_N_NEXT,
 396
 397   /* edit / add dispositions here */
 398   .next_nodes =
 399   {
 400     [MACTIME_NEXT_DROP] = "error-drop",
 401     [MACTIME_NEXT_ETHERNET_INPUT] = "ethernet-input", /* notused */
 402   },
 403 };
 404 /* *INDENT-ON* */
 405
 406 /*
 407  * fd.io coding-style-patch-verification: ON
 408  *
 409  * Local Variables:
 410  * eval: (c-set-style "gnu")
 411  * End:
 412  */