FD.io VPP  v20.05-21-gb1500e9ff
Vector Packet Processing
pg_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * pg_api.c - vnet pg 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/pg/pg.h>
24 
25 #include <vnet/vnet_msg_enum.h>
26 
27 #define vl_typedefs /* define message structures */
28 #include <vnet/vnet_all_api_h.h>
29 #undef vl_typedefs
30 
31 #define vl_endianfun /* define message structures */
32 #include <vnet/vnet_all_api_h.h>
33 #undef vl_endianfun
34 
35 /* instantiate all the print functions we know about */
36 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
37 #define vl_printfun
38 #include <vnet/vnet_all_api_h.h>
39 #undef vl_printfun
40 
42 
43 
44 #define foreach_pg_api_msg \
45 _(PG_CREATE_INTERFACE, pg_create_interface) \
46 _(PG_CAPTURE, pg_capture) \
47 _(PG_ENABLE_DISABLE, pg_enable_disable)
48 
49 static void
51 {
53  int rv = 0;
54 
55  pg_main_t *pg = &pg_main;
56  u32 pg_if_id = pg_interface_add_or_get (pg, ntohl (mp->interface_id),
57  mp->gso_enabled,
58  ntohl (mp->gso_size));
59  pg_interface_t *pi = pool_elt_at_index (pg->interfaces, pg_if_id);
60 
61  /* *INDENT-OFF* */
62  REPLY_MACRO2(VL_API_PG_CREATE_INTERFACE_REPLY,
63  ({
64  rmp->sw_if_index = ntohl(pi->sw_if_index);
65  }));
66  /* *INDENT-ON* */
67 }
68 
69 static void
71 {
72  vl_api_pg_capture_reply_t *rmp;
73  int rv = 0;
74 
75  vnet_main_t *vnm = vnet_get_main ();
78 
79  u8 *intf_name = format (0, "pg%d", ntohl (mp->interface_id), 0);
80  vec_terminate_c_string (intf_name);
81  u32 hw_if_index = ~0;
82  uword *p = hash_get_mem (im->hw_interface_by_name, intf_name);
83  if (p)
84  hw_if_index = *p;
85  vec_free (intf_name);
86 
87  if (hw_if_index != ~0)
88  {
89  pg_capture_args_t _a, *a = &_a;
90  char *pcap_file_name =
92 
93  hi = vnet_get_sup_hw_interface (vnm, hw_if_index);
94  a->hw_if_index = hw_if_index;
95  a->dev_instance = hi->dev_instance;
96  a->is_enabled = mp->is_enabled;
97  a->pcap_file_name = pcap_file_name;
98  a->count = ntohl (mp->count);
99 
100  clib_error_t *e = pg_capture (a);
101  if (e)
102  {
103  clib_error_report (e);
104  rv = VNET_API_ERROR_CANNOT_CREATE_PCAP_FILE;
105  }
106 
107  vec_free (pcap_file_name);
108  }
109  REPLY_MACRO (VL_API_PG_CAPTURE_REPLY);
110 }
111 
112 static void
114 {
115  vl_api_pg_enable_disable_reply_t *rmp;
116  int rv = 0;
117 
118  pg_main_t *pg = &pg_main;
119  u32 stream_index = ~0;
120 
121  int is_enable = mp->is_enabled != 0;
122 
123  if (vl_api_string_len (&mp->stream_name) > 0)
124  {
125  u8 *stream_name = vl_api_from_api_to_new_vec (mp, &mp->stream_name);
126  uword *p = hash_get_mem (pg->stream_index_by_name, stream_name);
127  if (p)
128  stream_index = *p;
129  vec_free (stream_name);
130  }
131 
132  pg_enable_disable (stream_index, is_enable);
133 
134  REPLY_MACRO (VL_API_PG_ENABLE_DISABLE_REPLY);
135 }
136 
137 #define vl_msg_name_crc_list
138 #include <vnet/pg/pg.api.h>
139 #undef vl_msg_name_crc_list
140 
141 static void
143 {
144 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
145  foreach_vl_msg_name_crc_pg;
146 #undef _
147 }
148 
149 static clib_error_t *
151 {
152  api_main_t *am = vlibapi_get_main ();
153 
154 #define _(N,n) \
155  vl_msg_api_set_handlers(VL_API_##N, #n, \
156  vl_api_##n##_t_handler, \
157  vl_noop_handler, \
158  vl_api_##n##_t_endian, \
159  vl_api_##n##_t_print, \
160  sizeof(vl_api_##n##_t), 1);
162 #undef _
163 
164  /*
165  * Set up the (msg_name, crc, message-id) table
166  */
168 
169  return 0;
170 }
171 
173 
174 /*
175  * fd.io coding-style-patch-verification: ON
176  *
177  * Local Variables:
178  * eval: (c-set-style "gnu")
179  * End:
180  */
u32 sw_if_index
Definition: pg.h:303
#define foreach_pg_api_msg
Definition: pg_api.c:44
vl_api_interface_index_t sw_if_index
Definition: pg.api:49
a
Definition: bitmap.h:538
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
static vnet_hw_interface_t * vnet_get_sup_hw_interface(vnet_main_t *vnm, u32 sw_if_index)
Definition: pg.h:321
vnet_interface_main_t interface_main
Definition: vnet.h:56
#define REPLY_MACRO2(t, body)
char * pcap_file_name
Definition: pg.h:385
uword * stream_index_by_name
Definition: pg.h:330
#define vec_terminate_c_string(V)
(If necessary) NULL terminate a vector containing a c-string.
Definition: vec.h:1088
VLIB_API_INIT_FUNCTION(pg_api_hookup)
u32 hw_if_index
Definition: pg.h:382
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
string stream_name[]
Definition: pg.api:81
Enable / disable packet generator request.
Definition: pg.api:76
u32 pg_interface_add_or_get(pg_main_t *pg, uword stream_index, u8 gso_enabled, u32 gso_size)
Definition: stream.c:182
static void vl_api_pg_enable_disable_t_handler(vl_api_pg_enable_disable_t *mp)
Definition: pg_api.c:113
unsigned char u8
Definition: types.h:56
PacketGenerator capture packets on given interface request.
Definition: pg.api:60
unsigned int u32
Definition: types.h:88
vl_api_interface_index_t interface_id
Definition: pg.api:36
static clib_error_t * pg_api_hookup(vlib_main_t *vm)
Definition: pg_api.c:150
uword * hw_interface_by_name
Definition: interface.h:847
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:534
#define REPLY_MACRO(t)
clib_error_t * pg_capture(pg_capture_args_t *a)
Definition: cli.c:81
u32 vl_api_string_len(vl_api_string_t *astr)
Definition: api_shared.c:1138
vlib_main_t * vm
Definition: in2out_ed.c:1599
string pcap_file_name[]
Definition: pg.api:67
vl_api_interface_index_t interface_id
Definition: pg.api:64
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:226
PacketGenerator create interface request.
Definition: pg.api:32
bool is_enabled[default=true]
Definition: pg.api:65
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:380
static void setup_message_id_table(api_main_t *am)
Definition: pg_api.c:142
char * vl_api_from_api_to_new_c_string(vl_api_string_t *astr)
Definition: api_shared.c:1172
bool is_enabled[default=true]
Definition: pg.api:80
static void vl_api_pg_create_interface_t_handler(vl_api_pg_create_interface_t *mp)
Definition: pg_api.c:50
#define clib_error_report(e)
Definition: error.h:113
vl_api_ip4_address_t hi
Definition: arp.api:37
u64 uword
Definition: types.h:112
PacketGenerator create interface response.
Definition: pg.api:45
static void vl_api_pg_capture_t_handler(vl_api_pg_capture_t *mp)
Definition: pg_api.c:70
u32 dev_instance
Definition: pg.h:383
#define hash_get_mem(h, key)
Definition: hash.h:269
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:379
pg_main_t pg_main
Definition: init.c:44
u8 is_enabled
Definition: pg.h:384
void pg_enable_disable(u32 stream_index, int is_enable)
Definition: cli.c:58
u8 * vl_api_from_api_to_new_vec(void *mp, vl_api_string_t *astr)
Definition: api_shared.c:1156
pg_interface_t * interfaces
Definition: pg.h:333