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.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   u64 data_quota;
  40   u64 data_used_in_range;
  41   u32 flags;
  42   clib_timebase_range_t *ranges;
  43 } mactime_device_t;
  44
  45 /** Always drop packets from this device */
  46 #define MACTIME_DEVICE_FLAG_STATIC_DROP         (1<<0)
  47 #define MACTIME_DEVICE_FLAG_STATIC_ALLOW        (1<<1)
  48 #define MACTIME_DEVICE_FLAG_DYNAMIC_DROP        (1<<2)
  49 #define MACTIME_DEVICE_FLAG_DYNAMIC_ALLOW       (1<<3)
  50 #define MACTIME_DEVICE_FLAG_DYNAMIC_ALLOW_QUOTA (1<<4)
  51 #define MACTIME_DEVICE_FLAG_DROP_UDP_10001      (1<<5)
  52
  53 typedef struct
  54 {
  55   union
  56   {
  57     u8 mac_address[6];
  58     u64 as_u64;
  59   };
  60 } mactime_key_t;
  61
  62 typedef struct
  63 {
  64   /* API message ID base */
  65   u16 msg_id_base;
  66
  67   /* Timebase */
  68   clib_timebase_t timebase;
  69
  70   /* cached sunday midnight */
  71   f64 sunday_midnight;
  72
  73   /* Lookup table */
  74   clib_bihash_8_8_t lookup_table;
  75
  76   /* Device table */
  77   mactime_device_t *devices;
  78
  79   /* Counters */
  80   vlib_combined_counter_main_t allow_counters;
  81   vlib_combined_counter_main_t drop_counters;
  82
  83   /* config parameters */
  84   u32 lookup_table_num_buckets;
  85   uword lookup_table_memory_size;
  86   i32 timezone_offset;
  87
  88   /* Once-only data structure create flag */
  89   int feature_initialized;
  90
  91   /* arp cache copy, for "show mactime" */
  92   ethernet_arp_ip4_entry_t *arp_cache_copy;
  93
  94   /* convenience */
  95   vlib_main_t *vlib_main;
  96   vnet_main_t *vnet_main;
  97   ethernet_main_t *ethernet_main;
  98 } mactime_main_t;
  99
 100 /* size for an hgw use-case */
 101 #define MACTIME_NUM_BUCKETS     128
 102 #define MACTIME_MEMORY_SIZE     (256<<10)
 103
 104 extern mactime_main_t mactime_main;
 105
 106 extern vlib_node_registration_t mactime_node;
 107 extern vlib_node_registration_t mactime_tx_node;
 108
 109 void mactime_send_create_entry_message (u8 * mac_address);
 110
 111 /* Periodic function events */
 112 #define MACTIME_EVENT1 1
 113 #define MACTIME_EVENT2 2
 114 #define MACTIME_EVENT_PERIODIC_ENABLE_DISABLE 3
 115
 116 #endif /* __included_mactime_h__ */
 117
 118 /*
 119  * fd.io coding-style-patch-verification: ON
 120  *
 121  * Local Variables:
 122  * eval: (c-set-style "gnu")
 123  * End:
 124  */