FD.io VPP  v21.01.1
Vector Packet Processing
span_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * span_api.c - span mirroring 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 
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/span/span.h>
26 
27 #include <vnet/vnet_msg_enum.h>
28 
29 #define vl_typedefs /* define message structures */
30 #include <vnet/vnet_all_api_h.h>
31 #undef vl_typedefs
32 
33 #define vl_endianfun /* define message structures */
34 #include <vnet/vnet_all_api_h.h>
35 #undef vl_endianfun
36 
37 /* instantiate all the print functions we know about */
38 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
39 #define vl_printfun
40 #include <vnet/vnet_all_api_h.h>
41 #undef vl_printfun
42 
44 
45 #define foreach_vpe_api_msg \
46 _(SW_INTERFACE_SPAN_ENABLE_DISABLE, sw_interface_span_enable_disable) \
47 _(SW_INTERFACE_SPAN_DUMP, sw_interface_span_dump) \
48 
49 static void
52 {
53  vl_api_sw_interface_span_enable_disable_reply_t *rmp;
54  int rv;
55 
57 
58  rv = span_add_delete_entry (vm, ntohl (mp->sw_if_index_from),
59  ntohl (mp->sw_if_index_to), ntohl (mp->state),
61 
62  REPLY_MACRO (VL_API_SW_INTERFACE_SPAN_ENABLE_DISABLE_REPLY);
63 }
64 
65 static void
67 {
68 
72  span_main_t *sm = &span_main;
73 
75  if (!reg)
76  return;
77 
79  /* *INDENT-OFF* */
80  vec_foreach (si, sm->interfaces)
81  {
82  span_mirror_t * rxm = &si->mirror_rxtx[sf][VLIB_RX];
83  span_mirror_t * txm = &si->mirror_rxtx[sf][VLIB_TX];
84  if (rxm->num_mirror_ports || txm->num_mirror_ports)
85  {
87  u32 i;
89  clib_bitmap_foreach (i, b)
90  {
91  rmp = vl_msg_api_alloc (sizeof (*rmp));
92  clib_memset (rmp, 0, sizeof (*rmp));
93  rmp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_SPAN_DETAILS);
94  rmp->context = mp->context;
95 
96  rmp->sw_if_index_from = htonl (si - sm->interfaces);
97  rmp->sw_if_index_to = htonl (i);
98  rmp->state = htonl ((clib_bitmap_get (rxm->mirror_ports, i) +
99  clib_bitmap_get (txm->mirror_ports, i) * 2));
100  rmp->is_l2 = mp->is_l2;
101 
102  vl_api_send_msg (reg, (u8 *) rmp);
103  }
104  clib_bitmap_free (b);
105  }
106  }
107  /* *INDENT-ON* */
108 }
109 
110 /*
111  * vpe_api_hookup
112  * Add vpe's API message handlers to the table.
113  * vlib has already mapped shared memory and
114  * added the client registration handlers.
115  * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
116  */
117 #define vl_msg_name_crc_list
118 #include <vnet/vnet_all_api_h.h>
119 #undef vl_msg_name_crc_list
120 
121 static void
123 {
124 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
125  foreach_vl_msg_name_crc_span;
126 #undef _
127 }
128 
129 static clib_error_t *
131 {
132  api_main_t *am = vlibapi_get_main ();
133 
134 #define _(N,n) \
135  vl_msg_api_set_handlers(VL_API_##N, #n, \
136  vl_api_##n##_t_handler, \
137  vl_noop_handler, \
138  vl_api_##n##_t_endian, \
139  vl_api_##n##_t_print, \
140  sizeof(vl_api_##n##_t), 1);
142 #undef _
143 
144  /*
145  * Set up the (msg_name, crc, message-id) table
146  */
148 
149  return 0;
150 }
151 
153 
154 /*
155  * fd.io coding-style-patch-verification: ON
156  *
157  * Local Variables:
158  * eval: (c-set-style "gnu")
159  * End:
160  */
span_main_t span_main
Definition: span.c:24
vl_api_interface_index_t sw_if_index_from
Definition: span.api:66
static void setup_message_id_table(api_main_t *am)
Definition: span_api.c:122
VLIB_API_INIT_FUNCTION(span_api_hookup)
span_mirror_t mirror_rxtx[SPAN_FEAT_N][VLIB_N_RX_TX]
Definition: span.h:38
#define ntohs(x)
Definition: af_xdp.bpf.c:29
#define foreach_vpe_api_msg
Definition: span_api.c:45
static clib_error_t * span_api_hookup(vlib_main_t *vm)
Definition: span_api.c:130
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:35
#define clib_bitmap_foreach(i, ai)
Macro to iterate across set bits in a bitmap.
Definition: bitmap.h:361
static void vl_api_sw_interface_span_dump_t_handler(vl_api_sw_interface_span_dump_t *mp)
Definition: span_api.c:66
u32 num_mirror_ports
Definition: span.h:33
vlib_main_t * vm
Definition: in2out_ed.c:1580
void * vl_msg_api_alloc(int nbytes)
unsigned char u8
Definition: types.h:56
clib_bitmap_t * mirror_ports
Definition: span.h:32
const cJSON *const b
Definition: cJSON.h:255
unsigned int u32
Definition: types.h:88
Enable/Disable span to mirror traffic from one interface to another.
Definition: span.api:37
span_interface_t * interfaces
Definition: span.h:48
#define REPLY_MACRO(t)
vl_api_interface_index_t sw_if_index_to
Definition: span.api:41
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:227
An API client registration, only in vpp/vlib.
Definition: api_common.h:47
vl_api_span_state_t state
Definition: span.api:68
static void vl_api_sw_interface_span_enable_disable_t_handler(vl_api_sw_interface_span_enable_disable_t *mp)
Definition: span_api.c:51
int span_add_delete_entry(vlib_main_t *vm, u32 src_sw_if_index, u32 dst_sw_if_index, u8 state, span_feat_t sf)
Definition: span.c:52
sll srl srl sll sra u16x4 i
Definition: vector_sse42.h:317
static uword * clib_bitmap_dup_or(uword *ai, uword *bi)
Logical operator across two bitmaps which duplicates the first bitmap.
SPAN dump request.
Definition: span.api:51
static uword clib_bitmap_get(uword *ai, uword i)
Gets the ith bit value from a bitmap.
Definition: bitmap.h:197
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:79
vl_api_interface_index_t sw_if_index_to
Definition: span.api:67
vl_api_interface_index_t sw_if_index_from
Definition: span.api:40
#define clib_bitmap_free(v)
Free a bitmap.
Definition: bitmap.h:92
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
Definition: defs.h:47
span_feat_t
Definition: span.h:23
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:389
uword clib_bitmap_t
Definition: bitmap.h:50
#define vec_foreach(var, vec)
Vector iterator.
u8 si
Definition: lisp_types.api:47
Definition: defs.h:46
Reply to SPAN dump request.
Definition: span.api:64