src/plugins/adl/adl.h

   1 /*
   2  * Copyright (c) 2016,2020 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 #ifndef __vnet_adl_h__
  17 #define __vnet_adl_h__
  18
  19 #include <vlib/vlib.h>
  20 #include <vnet/vnet.h>
  21
  22 #include <vppinfra/error.h>
  23 #include <vppinfra/hash.h>
  24 #include <vnet/vnet.h>
  25 #include <vnet/ip/ip.h>
  26 #include <vnet/l2/l2_input.h>
  27 #include <vnet/ethernet/ethernet.h>
  28 #include <vnet/ip/ip4_packet.h>
  29 #include <vnet/ip/ip6_packet.h>
  30
  31 typedef enum {
  32   VNET_ADL_IP4,
  33   VNET_ADL_IP6,
  34   VNET_ADL_DEFAULT,
  35   VNET_N_ADLS,
  36 } vnet_adl_t;
  37
  38 typedef enum {
  39   /* First check src address against allowlist */
  40   IP4_RX_ADL_ALLOWLIST,
  41   IP6_RX_ADL_ALLOWLIST,
  42   DEFAULT_RX_ADL_ALLOWLIST,
  43
  44   /* Pkts not otherwise dropped go to xxx-input */
  45   IP4_RX_ADL_INPUT,
  46   IP6_RX_ADL_INPUT,
  47   DEFAULT_RX_ADL_INPUT,
  48
  49   /* Going, going, gone... */
  50   RX_ADL_DROP,
  51
  52   ADL_RX_N_FEATURES,
  53 } adl_feature_type_t;
  54
  55 typedef struct {
  56   vnet_config_main_t config_main;
  57   u32 * config_index_by_sw_if_index;
  58 } adl_config_main_t;
  59
  60 typedef struct {
  61   u32 fib_index;
  62 } adl_config_data_t;
  63
  64 typedef struct {
  65   adl_config_main_t adl_config_mains[VNET_N_ADLS];
  66
  67   u16 msg_id_base;
  68
  69   /* convenience */
  70   vlib_main_t * vlib_main;
  71   vnet_main_t * vnet_main;
  72 } adl_main_t;
  73
  74 extern adl_main_t adl_main;
  75
  76 extern vlib_node_registration_t adl_input_node;
  77
  78 int adl_interface_enable_disable (u32 sw_if_index, int enable_disable);
  79
  80 typedef struct {
  81   u32 sw_if_index;
  82   u8 ip4;
  83   u8 ip6;
  84   u8 default_adl;
  85   u32 fib_id;
  86 } adl_allowlist_enable_disable_args_t;
  87
  88 int adl_allowlist_enable_disable (adl_allowlist_enable_disable_args_t *a);
  89
  90 /* Plugin private opaque union type */
  91 typedef struct {
  92     /* MUST be in sync with .../src/vnet/buffer.h */
  93     u32 sw_if_index[VLIB_N_RX_TX];
  94     i16 l2_hdr_offset;
  95     i16 l3_hdr_offset;
  96     i16 l4_hdr_offset;
  97     u8 feature_arc_index;
  98     u8 dont_waste_me;
  99     /* end of must be in sync with .../src/vnet/buffer.h */
 100     union
 101     {
 102         /* COP - configurable junk filter(s) */
 103         struct
 104         {
 105             /* Current configuration index. */
 106             u32 current_config_index;
 107         } adl;
 108     };
 109 } adl_buffer_opaque_t;
 110
 111 #define adl_buffer(b) ((adl_buffer_opaque_t *) (b)->opaque)
 112
 113 #endif /* __vnet_adl_h__ */