src/vnet/ipfix-export/flow_api.c

   1 /*
   2  *------------------------------------------------------------------
   3  * flow_api.c - flow api
   4  *
   5  * Copyright (c) 2016 Cisco and/or its affiliates.
   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  */
  19
  20 #include <vnet/vnet.h>
  21 #include <vlibmemory/api.h>
  22 #include <vnet/ip/ip_types_api.h>
  23 #include <vnet/udp/udp_local.h>
  24
  25 #include <vnet/interface.h>
  26 #include <vnet/api_errno.h>
  27
  28 #include <vnet/fib/fib_table.h>
  29 #include <vnet/ipfix-export/flow_report.h>
  30 #include <vnet/ipfix-export/flow_report_classify.h>
  31
  32 #include <vnet/format_fns.h>
  33 #include <vnet/ipfix-export/ipfix_export.api_enum.h>
  34 #include <vnet/ipfix-export/ipfix_export.api_types.h>
  35
  36 #define REPLY_MSG_ID_BASE frm->msg_id_base
  37 #include <vlibapi/api_helper_macros.h>
  38
  39 ipfix_exporter_t *
  40 vnet_ipfix_exporter_lookup (ip4_address_t *ipfix_collector)
  41 {
  42   flow_report_main_t *frm = &flow_report_main;
  43   ipfix_exporter_t *exp;
  44
  45   pool_foreach (exp, frm->exporters)
  46     {
  47       if (exp->ipfix_collector.as_u32 == ipfix_collector->as_u32)
  48         return exp;
  49     }
  50
  51   return NULL;
  52 }
  53
  54 /*
  55  * For backwards compatibility reasons index 0 in the set of exporters
  56  * is alwyas used for the exporter created via the set_ipfix_exporter
  57  * API.
  58  */
  59 #define USE_INDEX_0   true
  60 #define USE_ANY_INDEX false
  61
  62 static int
  63 vl_api_set_ipfix_exporter_t_internal (
  64   u32 client_index, vl_api_address_t *mp_collector_address,
  65   u16 mp_collector_port, vl_api_address_t *mp_src_address, u32 mp_vrf_id,
  66   u32 mp_path_mtu, u32 mp_template_interval, bool mp_udp_checksum,
  67   bool use_index_0, bool is_create)
  68 {
  69   vlib_main_t *vm = vlib_get_main ();
  70   flow_report_main_t *frm = &flow_report_main;
  71   ipfix_exporter_t *exp;
  72   vl_api_registration_t *reg;
  73   ip4_address_t collector, src;
  74   u16 collector_port = UDP_DST_PORT_ipfix;
  75   u32 path_mtu;
  76   u32 template_interval;
  77   u8 udp_checksum;
  78   u32 fib_id;
  79   u32 fib_index = ~0;
  80
  81   reg = vl_api_client_index_to_registration (client_index);
  82   if (!reg)
  83     return VNET_API_ERROR_UNIMPLEMENTED;
  84
  85   /* Collector address is the key for the exporter lookup */
  86   ip4_address_decode (mp_collector_address->un.ip4, &collector);
  87
  88   if (use_index_0)
  89     /*
  90      * In this case we update the existing exporter. There is no delete
  91      * for exp[0]
  92      */
  93     exp = &frm->exporters[0];
  94   else
  95     {
  96       if (is_create)
  97         {
  98           exp = vnet_ipfix_exporter_lookup (&collector);
  99           if (!exp)
 100             {
 101               /* Create a new exporter instead of updating an existing one */
 102               if (pool_elts (frm->exporters) >= IPFIX_EXPORTERS_MAX)
 103                 return VNET_API_ERROR_INVALID_VALUE;
 104               pool_get (frm->exporters, exp);
 105               if (!exp)
 106                 return VNET_API_ERROR_INVALID_VALUE;
 107             }
 108         }
 109       else
 110         {
 111           /* Delete the exporter */
 112           exp = vnet_ipfix_exporter_lookup (&collector);
 113           if (!exp)
 114             return VNET_API_ERROR_NO_SUCH_ENTRY;
 115
 116           pool_put (frm->exporters, exp);
 117           return 0;
 118         }
 119     }
 120
 121   if (mp_src_address->af == ADDRESS_IP6 ||
 122       mp_collector_address->af == ADDRESS_IP6)
 123     {
 124       return VNET_API_ERROR_UNIMPLEMENTED;
 125     }
 126
 127   collector_port = ntohs (mp_collector_port);
 128   if (collector_port == (u16) ~ 0)
 129     collector_port = UDP_DST_PORT_ipfix;
 130   ip4_address_decode (mp_src_address->un.ip4, &src);
 131   fib_id = ntohl (mp_vrf_id);
 132
 133   ip4_main_t *im = &ip4_main;
 134   if (fib_id == ~0)
 135     {
 136       fib_index = ~0;
 137     }
 138   else
 139     {
 140       uword *p = hash_get (im->fib_index_by_table_id, fib_id);
 141       if (!p)
 142         return VNET_API_ERROR_NO_SUCH_FIB;
 143       fib_index = p[0];
 144     }
 145
 146   path_mtu = ntohl (mp_path_mtu);
 147   if (path_mtu == ~0)
 148     path_mtu = 512;             // RFC 7011 section 10.3.3.
 149   template_interval = ntohl (mp_template_interval);
 150   if (template_interval == ~0)
 151     template_interval = 20;
 152   udp_checksum = mp_udp_checksum;
 153
 154   if (collector.as_u32 != 0 && src.as_u32 == 0)
 155     return VNET_API_ERROR_INVALID_VALUE;
 156
 157   if (path_mtu > 1450 /* vpp does not support fragmentation */ )
 158     return VNET_API_ERROR_INVALID_VALUE;
 159
 160   if (path_mtu < 68)
 161     return VNET_API_ERROR_INVALID_VALUE;
 162
 163   /* Reset report streams if we are reconfiguring IP addresses */
 164   if (exp->ipfix_collector.as_u32 != collector.as_u32 ||
 165       exp->src_address.as_u32 != src.as_u32 ||
 166       exp->collector_port != collector_port)
 167     vnet_flow_reports_reset (exp);
 168
 169   exp->ipfix_collector.as_u32 = collector.as_u32;
 170   exp->collector_port = collector_port;
 171   exp->src_address.as_u32 = src.as_u32;
 172   exp->fib_index = fib_index;
 173   exp->path_mtu = path_mtu;
 174   exp->template_interval = template_interval;
 175   exp->udp_checksum = udp_checksum;
 176
 177   /* Turn on the flow reporting process */
 178   vlib_process_signal_event (vm, flow_report_process_node.index, 1, 0);
 179
 180   return 0;
 181 }
 182
 183 static void
 184 vl_api_set_ipfix_exporter_t_handler (vl_api_set_ipfix_exporter_t *mp)
 185 {
 186   vl_api_set_ipfix_exporter_reply_t *rmp;
 187   flow_report_main_t *frm = &flow_report_main;
 188   int rv = vl_api_set_ipfix_exporter_t_internal (
 189     mp->client_index, &mp->collector_address, mp->collector_port,
 190     &mp->src_address, mp->vrf_id, mp->path_mtu, mp->template_interval,
 191     mp->udp_checksum, USE_INDEX_0, 0);
 192
 193   REPLY_MACRO (VL_API_SET_IPFIX_EXPORTER_REPLY);
 194 }
 195
 196 static void
 197 vl_api_ipfix_exporter_create_delete_t_handler (
 198   vl_api_ipfix_exporter_create_delete_t *mp)
 199 {
 200   vl_api_ipfix_exporter_create_delete_reply_t *rmp;
 201   flow_report_main_t *frm = &flow_report_main;
 202   int rv = vl_api_set_ipfix_exporter_t_internal (
 203     mp->client_index, &mp->collector_address, mp->collector_port,
 204     &mp->src_address, mp->vrf_id, mp->path_mtu, mp->template_interval,
 205     mp->udp_checksum, USE_ANY_INDEX, mp->is_create);
 206
 207   REPLY_MACRO (VL_API_IPFIX_EXPORTER_CREATE_DELETE_REPLY);
 208 }
 209
 210 static void
 211 vl_api_ipfix_exporter_dump_t_handler (vl_api_ipfix_exporter_dump_t * mp)
 212 {
 213   flow_report_main_t *frm = &flow_report_main;
 214   ipfix_exporter_t *exp = pool_elt_at_index (flow_report_main.exporters, 0);
 215   vl_api_registration_t *reg;
 216   vl_api_ipfix_exporter_details_t *rmp;
 217   ip4_main_t *im = &ip4_main;
 218   ip46_address_t collector = {.as_u64[0] = 0,.as_u64[1] = 0 };
 219   ip46_address_t src = {.as_u64[0] = 0,.as_u64[1] = 0 };
 220   u32 vrf_id;
 221
 222   reg = vl_api_client_index_to_registration (mp->client_index);
 223   if (!reg)
 224     return;
 225
 226   rmp = vl_msg_api_alloc (sizeof (*rmp));
 227   clib_memset (rmp, 0, sizeof (*rmp));
 228   rmp->_vl_msg_id =
 229     ntohs ((REPLY_MSG_ID_BASE) + VL_API_IPFIX_EXPORTER_DETAILS);
 230   rmp->context = mp->context;
 231
 232   memcpy (&collector.ip4, &exp->ipfix_collector, sizeof (ip4_address_t));
 233   ip_address_encode (&collector, IP46_TYPE_IP4, &rmp->collector_address);
 234
 235   rmp->collector_port = htons (exp->collector_port);
 236
 237   memcpy (&src.ip4, &exp->src_address, sizeof (ip4_address_t));
 238   ip_address_encode (&src, IP46_TYPE_IP4, &rmp->src_address);
 239
 240   if (exp->fib_index == ~0)
 241     vrf_id = ~0;
 242   else
 243     vrf_id = im->fibs[exp->fib_index].ft_table_id;
 244   rmp->vrf_id = htonl (vrf_id);
 245   rmp->path_mtu = htonl (exp->path_mtu);
 246   rmp->template_interval = htonl (exp->template_interval);
 247   rmp->udp_checksum = (exp->udp_checksum != 0);
 248
 249   vl_api_send_msg (reg, (u8 *) rmp);
 250 }
 251
 252 static void
 253   vl_api_set_ipfix_classify_stream_t_handler
 254   (vl_api_set_ipfix_classify_stream_t * mp)
 255 {
 256   vl_api_set_ipfix_classify_stream_reply_t *rmp;
 257   flow_report_classify_main_t *fcm = &flow_report_classify_main;
 258   flow_report_main_t *frm = &flow_report_main;
 259   ipfix_exporter_t *exp = &frm->exporters[0];
 260   u32 domain_id = 0;
 261   u32 src_port = UDP_DST_PORT_ipfix;
 262   int rv = 0;
 263
 264   domain_id = ntohl (mp->domain_id);
 265   src_port = ntohs (mp->src_port);
 266
 267   if (fcm->src_port != 0 &&
 268       (fcm->domain_id != domain_id || fcm->src_port != (u16) src_port))
 269     {
 270       int rv = vnet_stream_change (exp, fcm->domain_id, fcm->src_port,
 271                                    domain_id, (u16) src_port);
 272       ASSERT (rv == 0);
 273     }
 274
 275   fcm->domain_id = domain_id;
 276   fcm->src_port = (u16) src_port;
 277
 278   REPLY_MACRO (VL_API_SET_IPFIX_CLASSIFY_STREAM_REPLY);
 279 }
 280
 281 static void
 282   vl_api_ipfix_classify_stream_dump_t_handler
 283   (vl_api_ipfix_classify_stream_dump_t * mp)
 284 {
 285   flow_report_classify_main_t *fcm = &flow_report_classify_main;
 286   vl_api_registration_t *reg;
 287   vl_api_ipfix_classify_stream_details_t *rmp;
 288
 289   reg = vl_api_client_index_to_registration (mp->client_index);
 290   if (!reg)
 291     return;
 292
 293   rmp = vl_msg_api_alloc (sizeof (*rmp));
 294   clib_memset (rmp, 0, sizeof (*rmp));
 295   rmp->_vl_msg_id = ntohs (VL_API_IPFIX_CLASSIFY_STREAM_DETAILS);
 296   rmp->context = mp->context;
 297   rmp->domain_id = htonl (fcm->domain_id);
 298   rmp->src_port = htons (fcm->src_port);
 299
 300   vl_api_send_msg (reg, (u8 *) rmp);
 301 }
 302
 303 static void
 304   vl_api_ipfix_classify_table_add_del_t_handler
 305   (vl_api_ipfix_classify_table_add_del_t * mp)
 306 {
 307   vl_api_ipfix_classify_table_add_del_reply_t *rmp;
 308   vl_api_registration_t *reg;
 309   flow_report_classify_main_t *fcm = &flow_report_classify_main;
 310   flow_report_main_t *frm = &flow_report_main;
 311   ipfix_exporter_t *exp = &frm->exporters[0];
 312   vnet_flow_report_add_del_args_t args;
 313   ipfix_classify_table_t *table;
 314   int is_add;
 315   u32 classify_table_index;
 316   u8 ip_version;
 317   u8 transport_protocol;
 318   int rv = 0;
 319
 320   reg = vl_api_client_index_to_registration (mp->client_index);
 321   if (!reg)
 322     return;
 323
 324   classify_table_index = ntohl (mp->table_id);
 325   ip_version = (mp->ip_version == ADDRESS_IP4) ? 4 : 6;
 326   transport_protocol = mp->transport_protocol;
 327   is_add = mp->is_add;
 328
 329   if (fcm->src_port == 0)
 330     {
 331       /* call set_ipfix_classify_stream first */
 332       rv = VNET_API_ERROR_UNSPECIFIED;
 333       goto out;
 334     }
 335
 336   clib_memset (&args, 0, sizeof (args));
 337
 338   table = 0;
 339   int i;
 340   for (i = 0; i < vec_len (fcm->tables); i++)
 341     if (ipfix_classify_table_index_valid (i))
 342       if (fcm->tables[i].classify_table_index == classify_table_index)
 343         {
 344           table = &fcm->tables[i];
 345           break;
 346         }
 347
 348   if (is_add)
 349     {
 350       if (table)
 351         {
 352           rv = VNET_API_ERROR_VALUE_EXIST;
 353           goto out;
 354         }
 355       table = ipfix_classify_add_table ();
 356       table->classify_table_index = classify_table_index;
 357     }
 358   else
 359     {
 360       if (!table)
 361         {
 362           rv = VNET_API_ERROR_NO_SUCH_ENTRY;
 363           goto out;
 364         }
 365     }
 366
 367   table->ip_version = ip_version;
 368   table->transport_protocol = transport_protocol;
 369
 370   args.opaque.as_uword = table - fcm->tables;
 371   args.rewrite_callback = ipfix_classify_template_rewrite;
 372   args.flow_data_callback = ipfix_classify_send_flows;
 373   args.is_add = is_add;
 374   args.domain_id = fcm->domain_id;
 375   args.src_port = fcm->src_port;
 376
 377   rv = vnet_flow_report_add_del (exp, &args, NULL);
 378
 379   /* If deleting, or add failed */
 380   if (is_add == 0 || (rv && is_add))
 381     ipfix_classify_delete_table (table - fcm->tables);
 382
 383 out:
 384   REPLY_MACRO (VL_API_SET_IPFIX_CLASSIFY_STREAM_REPLY);
 385 }
 386
 387 static void
 388 send_ipfix_classify_table_details (u32 table_index,
 389                                    vl_api_registration_t * reg, u32 context)
 390 {
 391   flow_report_classify_main_t *fcm = &flow_report_classify_main;
 392   vl_api_ipfix_classify_table_details_t *mp;
 393
 394   ipfix_classify_table_t *table = &fcm->tables[table_index];
 395
 396   mp = vl_msg_api_alloc (sizeof (*mp));
 397   clib_memset (mp, 0, sizeof (*mp));
 398   mp->_vl_msg_id = ntohs (VL_API_IPFIX_CLASSIFY_TABLE_DETAILS);
 399   mp->context = context;
 400   mp->table_id = htonl (table->classify_table_index);
 401   mp->ip_version = (table->ip_version == 4) ? ADDRESS_IP4 : ADDRESS_IP6;
 402   mp->transport_protocol = table->transport_protocol;
 403
 404   vl_api_send_msg (reg, (u8 *) mp);
 405 }
 406
 407 static void
 408   vl_api_ipfix_classify_table_dump_t_handler
 409   (vl_api_ipfix_classify_table_dump_t * mp)
 410 {
 411   flow_report_classify_main_t *fcm = &flow_report_classify_main;
 412   vl_api_registration_t *reg;
 413   u32 i;
 414
 415   reg = vl_api_client_index_to_registration (mp->client_index);
 416   if (!reg)
 417     return;
 418
 419   for (i = 0; i < vec_len (fcm->tables); i++)
 420     if (ipfix_classify_table_index_valid (i))
 421       send_ipfix_classify_table_details (i, reg, mp->context);
 422 }
 423
 424 static void
 425 vl_api_ipfix_flush_t_handler (vl_api_ipfix_flush_t * mp)
 426 {
 427   flow_report_main_t *frm = &flow_report_main;
 428   vl_api_ipfix_flush_reply_t *rmp;
 429   vl_api_registration_t *reg;
 430   vlib_main_t *vm = vlib_get_main ();
 431   int rv = 0;
 432
 433   reg = vl_api_client_index_to_registration (mp->client_index);
 434   if (!reg)
 435     return;
 436
 437   /* poke the flow reporting process */
 438   vlib_process_signal_event (vm, flow_report_process_node.index,
 439                              1 /* type_opaque */ , 0 /* data */ );
 440
 441   REPLY_MACRO (VL_API_IPFIX_FLUSH_REPLY);
 442 }
 443
 444 #include <vnet/ipfix-export/ipfix_export.api.c>
 445 static clib_error_t *
 446 flow_api_hookup (vlib_main_t * vm)
 447 {
 448   flow_report_main_t *frm = &flow_report_main;
 449   /*
 450    * Set up the (msg_name, crc, message-id) table
 451    */
 452   REPLY_MSG_ID_BASE = setup_message_id_table ();
 453
 454   return 0;
 455 }
 456
 457 VLIB_API_INIT_FUNCTION (flow_api_hookup);
 458
 459 /*
 460  * fd.io coding-style-patch-verification: ON
 461  *
 462  * Local Variables:
 463  * eval: (c-set-style "gnu")
 464  * End:
 465  */