vnet/vnet/ip/ip6_hop_by_hop.h

   1 /*
   2  * Copyright (c) 2016 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 #ifndef __included_ip6_hop_by_hop_ioam_h__
  16 #define __included_ip6_hop_by_hop_ioam_h__
  17
  18 #include <vnet/ip/ip6_hop_by_hop_packet.h>
  19 #include <vnet/ip/ip.h>
  20
  21
  22 #define MAX_IP6_HBH_OPTION      256
  23
  24 /* To determine whether a node is decap MS bit is set */
  25 #define IOAM_DECAP_BIT 0x80000000
  26
  27 #define IOAM_DEAP_ENABLED(opaque_data) (opaque_data & IOAM_DECAP_BIT)
  28
  29 #define IOAM_SET_DECAP(opaque_data) \
  30     (opaque_data |= IOAM_DECAP_BIT)
  31
  32 #define IOAM_MASK_DECAP_BIT(x) (x & ~IOAM_DECAP_BIT)
  33
  34 /*
  35  * Stores the run time flow data of hbh options
  36  */
  37 typedef struct
  38 {
  39   u32 ctx[MAX_IP6_HBH_OPTION];
  40   u8 flow_name[64];
  41 } flow_data_t;
  42
  43 typedef struct
  44 {
  45   /* The current rewrite we're using */
  46   u8 *rewrite;
  47
  48   /* Trace data processing callback */
  49   void *ioam_end_of_path_cb;
  50   /* Configuration data */
  51   /* Adjacency */
  52   ip6_address_t adj;
  53 #define IOAM_HBYH_ADD  0
  54 #define IOAM_HBYH_MOD  1
  55 #define IOAM_HBYH_POP  2
  56   u8 ioam_flag;
  57   /* time scale transform. Joy. */
  58   u32 unix_time_0;
  59   f64 vlib_time_0;
  60
  61
  62   /* Trace option */
  63   u8 has_trace_option;
  64
  65   /* Pot option */
  66   u8 has_pot_option;
  67
  68   /* Per Packet Counter option */
  69   u8 has_seqno_option;
  70
  71   /* Enabling analyis of iOAM data on decap node */
  72   u8 has_analyse_option;
  73
  74   /* Array of function pointers to ADD and POP HBH option handling routines */
  75   u8 options_size[MAX_IP6_HBH_OPTION];
  76   int (*add_options[MAX_IP6_HBH_OPTION]) (u8 * rewrite_string,
  77                                           u8 * rewrite_size);
  78   int (*pop_options[MAX_IP6_HBH_OPTION]) (vlib_buffer_t * b,
  79                                           ip6_header_t * ip,
  80                                           ip6_hop_by_hop_option_t * opt);
  81   int (*get_sizeof_options[MAX_IP6_HBH_OPTION]) (u32 * rewrite_size);
  82   int (*config_handler[MAX_IP6_HBH_OPTION]) (void *data, u8 disable);
  83
  84   /* Array of function pointers to handle hbh options being used with classifier */
  85     u32 (*flow_handler[MAX_IP6_HBH_OPTION]) (u32 flow_ctx, u8 add);
  86   flow_data_t *flows;
  87
  88   /* convenience */
  89   vlib_main_t *vlib_main;
  90   vnet_main_t *vnet_main;
  91 } ip6_hop_by_hop_ioam_main_t;
  92
  93 extern ip6_hop_by_hop_ioam_main_t ip6_hop_by_hop_ioam_main;
  94
  95 extern u8 *format_path_map (u8 * s, va_list * args);
  96
  97 extern clib_error_t *ip6_ioam_enable (int has_trace_option,
  98                                       int has_pot_option,
  99                                       int has_seqno_option,
 100                                       int has_analyse_option);
 101
 102 extern int ip6_ioam_set_destination (ip6_address_t * addr, u32 mask_width,
 103                                      u32 vrf_id, int is_add, int is_pop,
 104                                      int is_none);
 105
 106 extern clib_error_t *clear_ioam_rewrite_fn (void);
 107
 108 static inline u8
 109 is_zero_ip4_address (ip4_address_t * a)
 110 {
 111   return (a->as_u32 == 0);
 112 }
 113
 114 static inline void
 115 copy_ip6_address (ip6_address_t * dst, ip6_address_t * src)
 116 {
 117   dst->as_u64[0] = src->as_u64[0];
 118   dst->as_u64[1] = src->as_u64[1];
 119 }
 120
 121 static inline void
 122 set_zero_ip6_address (ip6_address_t * a)
 123 {
 124   a->as_u64[0] = 0;
 125   a->as_u64[1] = 0;
 126 }
 127
 128 static inline u8
 129 cmp_ip6_address (ip6_address_t * a1, ip6_address_t * a2)
 130 {
 131   return ((a1->as_u64[0] == a2->as_u64[0])
 132           && (a1->as_u64[1] == a2->as_u64[1]));
 133 }
 134
 135 static inline u8
 136 is_zero_ip6_address (ip6_address_t * a)
 137 {
 138   return ((a->as_u64[0] == 0) && (a->as_u64[1] == 0));
 139 }
 140
 141 int ip6_hbh_add_register_option (u8 option,
 142                                  u8 size,
 143                                  int rewrite_options (u8 * rewrite_string,
 144                                                       u8 * size));
 145 int ip6_hbh_add_unregister_option (u8 option);
 146
 147 int ip6_hbh_pop_register_option (u8 option,
 148                                  int options (vlib_buffer_t * b,
 149                                               ip6_header_t * ip,
 150                                               ip6_hop_by_hop_option_t * opt));
 151 int ip6_hbh_pop_unregister_option (u8 option);
 152
 153 int
 154 ip6_hbh_get_sizeof_register_option (u8 option,
 155                                     int get_sizeof_hdr_options (u32 *
 156                                                                 rewrite_size));
 157
 158 int
 159 ip6_ioam_set_rewrite (u8 ** rwp, int has_trace_option,
 160                       int has_pot_option, int has_seq_no);
 161
 162 int
 163 ip6_hbh_config_handler_register (u8 option,
 164                                  int config_handler (void *data, u8 disable));
 165
 166 int ip6_hbh_config_handler_unregister (u8 option);
 167
 168 int ip6_hbh_flow_handler_register (u8 option,
 169                                    u32 ioam_flow_handler (u32 flow_ctx,
 170                                                           u8 add));
 171
 172 int ip6_hbh_flow_handler_unregister (u8 option);
 173
 174 u8 *get_flow_name_from_flow_ctx (u32 flow_ctx);
 175
 176 static inline flow_data_t *
 177 get_flow (u32 index)
 178 {
 179   flow_data_t *flow = NULL;
 180   ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
 181
 182   if (pool_is_free_index (hm->flows, index))
 183     return NULL;
 184
 185   flow = pool_elt_at_index (hm->flows, index);
 186   return flow;
 187 }
 188
 189 static inline u32
 190 get_flow_data_from_flow_ctx (u32 flow_ctx, u8 option)
 191 {
 192   flow_data_t *flow = NULL;
 193   ip6_hop_by_hop_ioam_main_t *hm = &ip6_hop_by_hop_ioam_main;
 194   u32 index;
 195
 196   index = IOAM_MASK_DECAP_BIT (flow_ctx);
 197   //flow = pool_elt_at_index (hm->flows, index);
 198   flow = &hm->flows[index];
 199   return (flow->ctx[option]);
 200 }
 201
 202 static inline u8
 203 is_seqno_enabled (void)
 204 {
 205   return (ip6_hop_by_hop_ioam_main.has_seqno_option);
 206 }
 207
 208 int ip6_trace_profile_setup ();
 209 #endif /* __included_ip6_hop_by_hop_ioam_h__ */
 210
 211 /*
 212  * fd.io coding-style-patch-verification: ON
 213  *
 214  * Local Variables:
 215  * eval: (c-set-style "gnu")
 216  * End:
 217  */