FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
punt_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * punt_api.c - Punt 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/punt.h>
23 
24 #include <vnet/vnet_msg_enum.h>
25 
26 #define vl_typedefs /* define message structures */
27 #include <vnet/vnet_all_api_h.h>
28 #undef vl_typedefs
29 
30 #define vl_endianfun /* define message structures */
31 #include <vnet/vnet_all_api_h.h>
32 #undef vl_endianfun
33 
34 /* instantiate all the print functions we know about */
35 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
36 #define vl_printfun
37 #include <vnet/vnet_all_api_h.h>
38 #undef vl_printfun
39 
41 
42 #define foreach_punt_api_msg \
43 _(SET_PUNT, set_punt) \
44 _(PUNT_SOCKET_REGISTER, punt_socket_register) \
45 _(PUNT_SOCKET_DEREGISTER, punt_socket_deregister) \
46 _(PUNT_DUMP, punt_dump) \
47 _(PUNT_SOCKET_DUMP, punt_socket_dump)
48 
49 static void
51 {
52  vl_api_set_punt_reply_t *rmp;
54  int rv = 0;
55  clib_error_t *error;
56 
57  error = vnet_punt_add_del (vm, mp->punt.ipv, mp->punt.l4_protocol,
58  ntohs (mp->punt.l4_port), mp->is_add);
59  if (error)
60  {
61  rv = -1;
62  clib_error_report (error);
63  }
64 
65  REPLY_MACRO (VL_API_SET_PUNT_REPLY);
66 }
67 
68 static void
70 {
71 
72 }
73 
74 static void
76 {
79  int rv = 0;
80  clib_error_t *error;
82 
83  error = vnet_punt_socket_add (vm, ntohl (mp->header_version),
84  mp->punt.ipv, mp->punt.l4_protocol,
85  ntohs (mp->punt.l4_port),
86  (char *) mp->pathname);
87  if (error)
88  {
89  rv = -1;
90  clib_error_report (error);
91  }
92 
94  if (!reg)
95  return;
96 
97  rmp = vl_msg_api_alloc (sizeof (*rmp));
98  rmp->_vl_msg_id = htons (VL_API_PUNT_SOCKET_REGISTER_REPLY);
99  rmp->context = mp->context;
100  rmp->retval = htonl (rv);
101  char *p = vnet_punt_get_server_pathname ();
102  /* Abstract pathnames start with \0 */
103  memcpy ((char *) rmp->pathname, p, sizeof (rmp->pathname));
104  vl_api_send_msg (reg, (u8 *) rmp);
105 }
106 
107 void
110 {
112 
113  mp = vl_msg_api_alloc (sizeof (*mp));
114  if (!mp)
115  return;
116 
117  clib_memset (mp, 0, sizeof (*mp));
118  mp->_vl_msg_id = ntohs (VL_API_PUNT_SOCKET_DETAILS);
119  mp->context = context;
120  mp->punt.ipv = p->ipv;
121  mp->punt.l4_protocol = p->l4_protocol;
122  mp->punt.l4_port = htons (p->l4_port);
123  memcpy (mp->pathname, p->pathname, sizeof (p->pathname));
124 
125  vl_api_send_msg (reg, (u8 *) mp);
126 }
127 
128 static void
130 {
132  punt_socket_detail_t *p, *ps;
133  int rv __attribute__ ((unused)) = 0;
134 
136  if (!reg)
137  return;
138 
139  ps = punt_socket_entries (mp->is_ipv6);
140  /* *INDENT-OFF* */
141  vec_foreach (p, ps)
142  {
143  send_punt_socket_details (reg, mp->context, p);
144  }
145  /* *INDENT-ON* */
146  vec_free (ps);
147 }
148 
149 static void
151 {
152  vl_api_punt_socket_deregister_reply_t *rmp;
154  int rv = 0;
155  clib_error_t *error;
157 
158  error = vnet_punt_socket_del (vm, mp->punt.ipv, mp->punt.l4_protocol,
159  ntohs (mp->punt.l4_port));
160  if (error)
161  {
162  rv = -1;
163  clib_error_report (error);
164  }
165 
167  if (!reg)
168  return;
169 
170  rmp = vl_msg_api_alloc (sizeof (*rmp));
171  rmp->_vl_msg_id = htons (VL_API_PUNT_SOCKET_DEREGISTER_REPLY);
172  rmp->context = mp->context;
173  rmp->retval = htonl (rv);
174  vl_api_send_msg (reg, (u8 *) rmp);
175 }
176 
177 #define vl_msg_name_crc_list
178 #include <vnet/ip/punt.api.h>
179 #undef vl_msg_name_crc_list
180 
181 static void
183 {
184 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
185  foreach_vl_msg_name_crc_punt;
186 #undef _
187 }
188 
189 static clib_error_t *
191 {
192  api_main_t *am = &api_main;
193 
194 #define _(N,n) \
195  vl_msg_api_set_handlers(VL_API_##N, #n, \
196  vl_api_##n##_t_handler, \
197  vl_noop_handler, \
198  vl_api_##n##_t_endian, \
199  vl_api_##n##_t_print, \
200  sizeof(vl_api_##n##_t), 1);
202 #undef _
203 
204  /*
205  * Set up the (msg_name, crc, message-id) table
206  */
208 
209  return 0;
210 }
211 
213 
214 
215 /*
216  * fd.io coding-style-patch-verification: ON
217  *
218  * Local Variables:
219  * eval: (c-set-style "gnu")
220  * End:
221  */
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:34
clib_error_t * vnet_punt_add_del(vlib_main_t *vm, u8 ipv, u8 protocol, u16 port, bool is_add)
Request IP traffic punt to the local TCP/IP stack.
Definition: punt.c:708
punt_socket_detail_t * punt_socket_entries(u8 ipv)
Definition: punt.c:952
static void vl_api_punt_socket_register_t_handler(vl_api_punt_socket_register_t *mp)
Definition: punt_api.c:75
void * vl_msg_api_alloc(int nbytes)
unsigned char u8
Definition: types.h:56
static void vl_api_set_punt_t_handler(vl_api_set_punt_t *mp)
Definition: punt_api.c:50
static void setup_message_id_table(api_main_t *am)
Definition: punt_api.c:182
unsigned int u32
Definition: types.h:88
vl_api_punt_t punt
Definition: punt.api:87
clib_error_t * vnet_punt_socket_del(vlib_main_t *vm, bool is_ip4, u8 l4_protocol, u16 port)
Definition: punt.c:678
void send_punt_socket_details(vl_api_registration_t *reg, u32 context, punt_socket_detail_t *p)
Definition: punt_api.c:108
static void vl_api_punt_socket_dump_t_handler(vl_api_punt_socket_dump_t *mp)
Definition: punt_api.c:129
static void vl_api_punt_socket_deregister_t_handler(vl_api_punt_socket_deregister_t *mp)
Definition: punt_api.c:150
#define REPLY_MACRO(t)
u8 l4_protocol
Definition: punt.api:26
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:202
An API client registration, only in vpp/vlib.
Definition: api_common.h:45
vlib_main_t * vm
Definition: buffer.c:312
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
u32 context
Definition: ipsec_gre.api:33
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
static void vl_api_punt_dump_t_handler(vl_api_punt_dump_t *mp)
Definition: punt_api.c:69
VLIB_API_INIT_FUNCTION(punt_api_hookup)
static clib_error_t * punt_api_hookup(vlib_main_t *vm)
Definition: punt_api.c:190
u16 l4_port
Definition: punt.api:27
#define clib_error_report(e)
Definition: error.h:113
Punt traffic to the host.
Definition: punt.api:36
Punt traffic to the host via socket.
Definition: punt.api:62
#define foreach_punt_api_msg
Definition: punt_api.c:42
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
vl_api_punt_t punt
Definition: punt.api:40
clib_error_t * vnet_punt_socket_add(vlib_main_t *vm, u32 header_version, bool is_ip4, u8 protocol, u16 port, char *client_pathname)
Definition: punt.c:642
u8 pathname[108]
Definition: punt.h:97
#define vec_foreach(var, vec)
Vector iterator.
api_main_t api_main
Definition: api_shared.c:35
char * vnet_punt_get_server_pathname(void)
Definition: punt.c:75
Definitions for punt infrastructure.