FD.io VPP  v16.12-rc0-308-g931be3a
Vector Packet Processing
ioam_export.c
Go to the documentation of this file.
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 /*
16  *------------------------------------------------------------------
17  * ioam_export.c - ioam export API / debug CLI handling
18  *------------------------------------------------------------------
19  */
20 
21 #include <vnet/vnet.h>
22 #include <vnet/plugin/plugin.h>
24 
25 #include <vlibapi/api.h>
26 #include <vlibmemory/api.h>
27 #include <vlibsocket/api.h>
28 #include <vnet/ip/ip6_hop_by_hop.h>
29 
30 #include "ioam_export.h"
31 
32 /* define message IDs */
34 
35 /* define message structures */
36 #define vl_typedefs
38 #undef vl_typedefs
39 
40 /* define generated endian-swappers */
41 #define vl_endianfun
43 #undef vl_endianfun
44 
45 /* instantiate all the print functions we know about */
46 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
47 #define vl_printfun
49 #undef vl_printfun
50 
51 /* Get the API version number */
52 #define vl_api_version(n,v) static u32 api_version=(v);
54 #undef vl_api_version
55 
56 /*
57  * A handy macro to set up a message reply.
58  * Assumes that the following variables are available:
59  * mp - pointer to request message
60  * rmp - pointer to reply message type
61  * rv - return value
62  */
63 
64 #define REPLY_MACRO(t) \
65 do { \
66  unix_shared_memory_queue_t * q = \
67  vl_api_client_index_to_input_queue (mp->client_index); \
68  if (!q) \
69  return; \
70  \
71  rmp = vl_msg_api_alloc (sizeof (*rmp)); \
72  rmp->_vl_msg_id = ntohs((t)+sm->msg_id_base); \
73  rmp->context = mp->context; \
74  rmp->retval = ntohl(rv); \
75  \
76  vl_msg_api_send_shmem (q, (u8 *)&rmp); \
77 } while(0);
78 
79 
80 /* List of message types that this plugin understands */
81 
82 #define foreach_ioam_export_plugin_api_msg \
83 _(IOAM_EXPORT_IP6_ENABLE_DISABLE, ioam_export_ip6_enable_disable)
84 
85 /*
86  * This routine exists to convince the vlib plugin framework that
87  * we haven't accidentally copied a random .dll into the plugin directory.
88  *
89  * Also collects global variable pointers passed from the vpp engine
90  */
91 
94  int from_early_init)
95 {
97  clib_error_t *error = 0;
98 
99  em->vlib_main = vm;
100  em->vnet_main = h->vnet_main;
101  em->ethernet_main = h->ethernet_main;
102 
103  return error;
104 }
105 
106 /* Action function shared between message handler and debug CLI */
107 
108 int
110  u8 is_disable,
111  ip4_address_t * collector_address,
112  ip4_address_t * src_address)
113 {
114  vlib_main_t *vm = em->vlib_main;
115 
116  if (is_disable == 0)
117  {
118  if (1 == ioam_export_header_create (collector_address, src_address))
119  {
122  /* Turn on the export buffer check process */
124 
125  }
126  else
127  {
128  return (-2);
129  }
130  }
131  else
132  {
134  ioam_export_header_cleanup (collector_address, src_address);
136  /* Turn off the export buffer check process */
138 
139  }
140 
141  return 0;
142 }
143 
144 /* API message handler */
147 {
150  int rv;
151 
152  rv = ioam_export_ip6_enable_disable (sm, (int) (mp->is_disable),
153  (ip4_address_t *) mp->
154  collector_address,
155  (ip4_address_t *) mp->src_address);
156 
157  REPLY_MACRO (VL_API_IOAM_EXPORT_IP6_ENABLE_DISABLE_REPLY);
158 }
159 
160 /* Set up the API message handling tables */
161 static clib_error_t *
163 {
165 #define _(N,n) \
166  vl_msg_api_set_handlers((VL_API_##N + sm->msg_id_base), \
167  #n, \
168  vl_api_##n##_t_handler, \
169  vl_noop_handler, \
170  vl_api_##n##_t_endian, \
171  vl_api_##n##_t_print, \
172  sizeof(vl_api_##n##_t), 1);
174 #undef _
175 
176  return 0;
177 }
178 
179 static clib_error_t *
181  unformat_input_t * input,
182  vlib_cli_command_t * cmd)
183 {
185  ip4_address_t collector, src;
186  u8 is_disable = 0;
187 
188  collector.as_u32 = 0;
189  src.as_u32 = 0;
190 
192  {
193  if (unformat (input, "collector %U", unformat_ip4_address, &collector))
194  ;
195  else if (unformat (input, "src %U", unformat_ip4_address, &src))
196  ;
197  else if (unformat (input, "disable"))
198  is_disable = 1;
199  else
200  break;
201  }
202 
203  if (collector.as_u32 == 0)
204  return clib_error_return (0, "collector address required");
205 
206  if (src.as_u32 == 0)
207  return clib_error_return (0, "src address required");
208 
209  em->ipfix_collector.as_u32 = collector.as_u32;
210  em->src_address.as_u32 = src.as_u32;
211 
212  vlib_cli_output (vm, "Collector %U, src address %U",
215 
216  /* Turn on the export timer process */
217  // vlib_process_signal_event (vm, flow_report_process_node.index,
218  //1, 0);
219  ioam_export_ip6_enable_disable (em, is_disable, &collector, &src);
220 
221  return 0;
222 }
223 
224 VLIB_CLI_COMMAND (set_ipfix_command, static) =
225 {
226 .path = "set ioam export ipfix",.short_help =
227  "set ioam export ipfix collector <ip4-address> src <ip4-address>",.
229 
230 
231 static clib_error_t *
233 {
235  clib_error_t *error = 0;
236  u8 *name;
237  u32 node_index = export_node.index;
238  vlib_node_t *ip6_hbyh_node = NULL;
239 
240  name = format (0, "ioam_export_%08x%c", api_version, 0);
241 
242  /* Ask for a correctly-sized block of API message decode slots */
244  ((char *) name, VL_MSG_FIRST_AVAILABLE);
245  em->unix_time_0 = (u32) time (0); /* Store starting time */
246  em->vlib_time_0 = vlib_time_now (vm);
247 
248  error = ioam_export_plugin_api_hookup (vm);
249 
250  /* Hook this export node to ip6-hop-by-hop */
251  ip6_hbyh_node = vlib_get_node_by_name (vm, (u8 *) "ip6-hop-by-hop");
252  em->my_hbh_slot = vlib_node_add_next (vm, ip6_hbyh_node->index, node_index);
253  vec_free (name);
254 
255  return error;
256 }
257 
uword unformat(unformat_input_t *i, char *fmt,...)
Definition: unformat.c:966
void ip6_hbh_set_next_override(uword next)
Definition: ip6_forward.c:2594
u32 export_process_node_index
Definition: ioam_export.h:72
#define UNFORMAT_END_OF_INPUT
Definition: format.h:143
#define NULL
Definition: clib.h:55
u32 index
Definition: node.h:237
static f64 vlib_time_now(vlib_main_t *vm)
Definition: main.h:182
vlib_node_registration_t export_node
(constructor) VLIB_REGISTER_NODE (export_node)
Definition: ioam_export.h:77
format_function_t format_ip4_address
Definition: format.h:78
ip4_address_t ipfix_collector
Definition: ioam_export.h:51
int ioam_export_ip6_enable_disable(ioam_export_main_t *em, u8 is_disable, ip4_address_t *collector_address, ip4_address_t *src_address)
Definition: ioam_export.c:109
static uword vlib_node_add_next(vlib_main_t *vm, uword node, uword next_node)
Definition: node_funcs.h:1063
static clib_error_t * set_ioam_export_ipfix_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: ioam_export.c:180
ethernet_main_t * ethernet_main
Definition: plugin.h:27
#define VLIB_INIT_FUNCTION(x)
Definition: init.h:111
#define foreach_ioam_export_plugin_api_msg
Definition: ioam_export.c:82
unformat_function_t unformat_ip4_address
Definition: format.h:75
static int ioam_export_header_create(ip4_address_t *collector_address, ip4_address_t *src_address)
Definition: ioam_export.h:210
static void vlib_process_signal_event(vlib_main_t *vm, uword node_index, uword type_opaque, uword data)
Definition: node_funcs.h:931
#define REPLY_MACRO(t)
Definition: ioam_export.c:64
static clib_error_t * ioam_export_init(vlib_main_t *vm)
Definition: ioam_export.c:232
vnet_main_t * vnet_main
Definition: ioam_export.h:67
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:575
vlib_main_t * vlib_main
Definition: ioam_export.h:66
static clib_error_t * ioam_export_plugin_api_hookup(vlib_main_t *vm)
Definition: ioam_export.c:162
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:300
ip4_address_t src_address
Definition: ioam_export.h:52
static void ioam_export_header_cleanup(ip4_address_t *collector_address, ip4_address_t *src_address)
Definition: ioam_export.h:202
clib_error_t * vlib_plugin_register(vlib_main_t *vm, vnet_plugin_handoff_t *h, int from_early_init)
Definition: ioam_export.c:93
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:154
unsigned int u32
Definition: types.h:88
ethernet_main_t * ethernet_main
Definition: ioam_export.h:68
vlib_node_t * vlib_get_node_by_name(vlib_main_t *vm, u8 *name)
Definition: node.c:45
static int ioam_export_thread_buffer_init(vlib_main_t *vm)
Definition: ioam_export.h:146
unsigned char u8
Definition: types.h:56
static void vl_api_ioam_export_ip6_enable_disable_t_handler(vl_api_ioam_export_ip6_enable_disable_t *mp)
Definition: ioam_export.c:146
vnet_main_t * vnet_main
Definition: plugin.h:26
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:169
static void ioam_export_thread_buffer_free(void)
Definition: ioam_export.h:124
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:418
u16 vl_msg_api_get_msg_ids(char *name, int n)
Definition: api_shared.c:1269
#define clib_error_return(e, args...)
Definition: error.h:111
struct _unformat_input_t unformat_input_t
ioam_export_main_t ioam_export_main
Definition: ioam_export.h:75