src/plugins/mactime/mactime.h

   1
   2 /*
   3  * mactime.h - time-based src mac address filtration
   4  *
   5  * Copyright (c) <current-year> <your-organization>
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 #ifndef __included_mactime_h__
  19 #define __included_mactime_h__
  20
  21 #include <vnet/vnet.h>
  22 #include <vnet/ip/ip.h>
  23 #include <vnet/ethernet/ethernet.h>
  24 #include <vnet/ethernet/arp_packet.h>
  25 #include <vlib/counter.h>
  26
  27 #include <vppinfra/hash.h>
  28 #include <vppinfra/error.h>
  29 #include <vppinfra/time_range.h>
  30 #include <vppinfra/bihash_8_8.h>
  31
  32 #define MACTIME_RANGE_TYPE_DROP 0
  33 #define MACTIME_RANGE_TYPE_ALLOW 1
  34
  35 typedef struct
  36 {
  37   u8 *device_name;
  38   u8 mac_address[6];
  39   u32 flags;
  40   clib_timebase_range_t *ranges;
  41 } mactime_device_t;
  42
  43 /** Always drop packets from this device */
  44 #define MACTIME_DEVICE_FLAG_STATIC_DROP         (1<<0)
  45 #define MACTIME_DEVICE_FLAG_STATIC_ALLOW        (1<<1)
  46 #define MACTIME_DEVICE_FLAG_DYNAMIC_DROP        (1<<2)
  47 #define MACTIME_DEVICE_FLAG_DYNAMIC_ALLOW       (1<<3)
  48
  49 typedef struct
  50 {
  51   union
  52   {
  53     u8 mac_address[6];
  54     u64 as_u64;
  55   };
  56 } mactime_key_t;
  57
  58 typedef struct
  59 {
  60   /* API message ID base */
  61   u16 msg_id_base;
  62
  63   /* Timebase */
  64   clib_timebase_t timebase;
  65
  66   /* cached sunday midnight */
  67   f64 sunday_midnight;
  68
  69   /* Lookup table */
  70   clib_bihash_8_8_t lookup_table;
  71
  72   /* Device table */
  73   mactime_device_t *devices;
  74
  75   /* Counters */
  76   vlib_combined_counter_main_t allow_counters;
  77   vlib_combined_counter_main_t drop_counters;
  78
  79   /* config parameters */
  80   u32 lookup_table_num_buckets;
  81   uword lookup_table_memory_size;
  82   i32 timezone_offset;
  83
  84   /* Once-only data structure create flag */
  85   int feature_initialized;
  86
  87   /* arp cache copy, for "show mactime" */
  88   ethernet_arp_ip4_entry_t *arp_cache_copy;
  89
  90   /* convenience */
  91   vlib_main_t *vlib_main;
  92   vnet_main_t *vnet_main;
  93   ethernet_main_t *ethernet_main;
  94 } mactime_main_t;
  95
  96 /* size for an hgw use-case */
  97 #define MACTIME_NUM_BUCKETS     128
  98 #define MACTIME_MEMORY_SIZE     (256<<10)
  99
 100 extern mactime_main_t mactime_main;
 101
 102 extern vlib_node_registration_t mactime_node;
 103 extern vlib_node_registration_t mactime_tx_node;
 104
 105 void mactime_send_create_entry_message (u8 * mac_address);
 106
 107 static inline u8 *
 108 format_mac_address (u8 * s, va_list * args)
 109 {
 110   u8 *a = va_arg (*args, u8 *);
 111   return format (s, "%02x:%02x:%02x:%02x:%02x:%02x",
 112                  a[0], a[1], a[2], a[3], a[4], a[5]);
 113 }
 114
 115 /* Periodic function events */
 116 #define MACTIME_EVENT1 1
 117 #define MACTIME_EVENT2 2
 118 #define MACTIME_EVENT_PERIODIC_ENABLE_DISABLE 3
 119
 120 #endif /* __included_mactime_h__ */
 121
 122 /*
 123  * fd.io coding-style-patch-verification: ON
 124  *
 125  * Local Variables:
 126  * eval: (c-set-style "gnu")
 127  * End:
 128  */