Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 1 | /* |
| 2 | *------------------------------------------------------------------ |
| 3 | * socksvr_vlib.c |
| 4 | * |
| 5 | * Copyright (c) 2009 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 <sys/types.h> |
| 21 | #include <sys/socket.h> |
| 22 | #include <netinet/in.h> |
| 23 | #include <sys/ioctl.h> |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 24 | #include <fcntl.h> |
| 25 | #include <sys/stat.h> |
| 26 | |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 27 | #include <vppinfra/byte_order.h> |
| 28 | #include <svm/memfd.h> |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 29 | #include <vlibmemory/api.h> |
| 30 | |
| 31 | #include <vlibmemory/vl_memory_msg_enum.h> |
| 32 | |
| 33 | #define vl_typedefs /* define message structures */ |
| 34 | #include <vlibmemory/vl_memory_api_h.h> |
| 35 | #undef vl_typedefs |
| 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 <vlibmemory/vl_memory_api_h.h> |
| 41 | #undef vl_printfun |
| 42 | |
| 43 | /* instantiate all the endian swap functions we know about */ |
| 44 | #define vl_endianfun |
| 45 | #include <vlibmemory/vl_memory_api_h.h> |
| 46 | #undef vl_endianfun |
| 47 | |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 48 | socket_main_t socket_main; |
| 49 | |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 50 | void |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 51 | vl_sock_api_dump_clients (vlib_main_t * vm, api_main_t * am) |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 52 | { |
| 53 | vl_api_registration_t *reg; |
| 54 | socket_main_t *sm = &socket_main; |
| 55 | clib_file_main_t *fm = &file_main; |
| 56 | clib_file_t *f; |
| 57 | |
| 58 | /* |
| 59 | * Must have at least one active client, not counting the |
| 60 | * REGISTRATION_TYPE_SOCKET_LISTEN bind/accept socket |
| 61 | */ |
| 62 | if (pool_elts (sm->registration_pool) < 2) |
| 63 | return; |
| 64 | |
| 65 | vlib_cli_output (vm, "Socket clients"); |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 66 | vlib_cli_output (vm, "%20s %8s", "Name", "Fildesc"); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 67 | /* *INDENT-OFF* */ |
| 68 | pool_foreach (reg, sm->registration_pool, |
| 69 | ({ |
| 70 | if (reg->registration_type == REGISTRATION_TYPE_SOCKET_SERVER) { |
| 71 | f = pool_elt_at_index (fm->file_pool, reg->clib_file_index); |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 72 | vlib_cli_output (vm, "%20s %8d", |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 73 | reg->name, f->file_descriptor); |
| 74 | } |
| 75 | })); |
| 76 | /* *INDENT-ON* */ |
| 77 | } |
| 78 | |
| 79 | void |
| 80 | vl_socket_api_send (vl_api_registration_t * rp, u8 * elem) |
| 81 | { |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 82 | #if CLIB_DEBUG > 1 |
| 83 | u32 output_length; |
| 84 | #endif |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 85 | socket_main_t *sm = &socket_main; |
| 86 | u16 msg_id = ntohs (*(u16 *) elem); |
| 87 | api_main_t *am = &api_main; |
| 88 | msgbuf_t *mb = (msgbuf_t *) (elem - offsetof (msgbuf_t, data)); |
| 89 | clib_file_t *cf = clib_file_get (&file_main, rp->clib_file_index); |
| 90 | vl_api_registration_t *sock_rp; |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 91 | |
| 92 | ASSERT (rp->registration_type > REGISTRATION_TYPE_SHMEM); |
| 93 | |
| 94 | if (msg_id >= vec_len (am->api_trace_cfg)) |
| 95 | { |
| 96 | clib_warning ("id out of range: %d", msg_id); |
| 97 | vl_msg_api_free ((void *) elem); |
| 98 | return; |
| 99 | } |
| 100 | |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 101 | sock_rp = pool_elt_at_index (sm->registration_pool, |
| 102 | rp->vl_api_registration_pool_index); |
| 103 | ASSERT (sock_rp); |
| 104 | |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 105 | /* Add the msgbuf_t to the output vector */ |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 106 | vl_socket_add_pending_output_no_flush (cf, sock_rp, (u8 *) mb, |
| 107 | sizeof (*mb)); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 108 | /* Send the message */ |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 109 | vl_socket_add_pending_output (cf, sock_rp, elem, ntohl (mb->data_len)); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 110 | |
| 111 | #if CLIB_DEBUG > 1 |
| 112 | output_length = sizeof (*mb) + ntohl (mb->data_len); |
| 113 | clib_warning ("wrote %u bytes to fd %d", output_length, |
| 114 | cf->file_descriptor); |
| 115 | #endif |
| 116 | |
| 117 | vl_msg_api_free ((void *) elem); |
| 118 | } |
| 119 | |
| 120 | void |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 121 | vl_socket_free_registration_index (u32 pool_index) |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 122 | { |
| 123 | int i; |
| 124 | vl_api_registration_t *rp; |
| 125 | if (pool_is_free_index (socket_main.registration_pool, pool_index)) |
| 126 | { |
| 127 | clib_warning ("main pool index %d already free", pool_index); |
| 128 | return; |
| 129 | } |
| 130 | rp = pool_elt_at_index (socket_main.registration_pool, pool_index); |
| 131 | |
| 132 | ASSERT (rp->registration_type != REGISTRATION_TYPE_FREE); |
| 133 | for (i = 0; i < vec_len (rp->additional_fds_to_close); i++) |
| 134 | if (close (rp->additional_fds_to_close[i]) < 0) |
| 135 | clib_unix_warning ("close"); |
| 136 | vec_free (rp->additional_fds_to_close); |
| 137 | vec_free (rp->name); |
| 138 | vec_free (rp->unprocessed_input); |
| 139 | vec_free (rp->output_vector); |
| 140 | rp->registration_type = REGISTRATION_TYPE_FREE; |
| 141 | pool_put (socket_main.registration_pool, rp); |
| 142 | } |
| 143 | |
| 144 | void |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 145 | vl_socket_process_api_msg (clib_file_t * uf, vl_api_registration_t * rp, |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 146 | i8 * input_v) |
| 147 | { |
| 148 | msgbuf_t *mbp = (msgbuf_t *) input_v; |
| 149 | |
| 150 | u8 *the_msg = (u8 *) (mbp->data); |
| 151 | socket_main.current_uf = uf; |
| 152 | socket_main.current_rp = rp; |
| 153 | vl_msg_api_socket_handler (the_msg); |
| 154 | socket_main.current_uf = 0; |
| 155 | socket_main.current_rp = 0; |
| 156 | } |
| 157 | |
| 158 | clib_error_t * |
| 159 | vl_socket_read_ready (clib_file_t * uf) |
| 160 | { |
| 161 | clib_file_main_t *fm = &file_main; |
| 162 | vlib_main_t *vm = vlib_get_main (); |
| 163 | vl_api_registration_t *rp; |
| 164 | int n; |
| 165 | i8 *msg_buffer = 0; |
| 166 | u8 *data_for_process; |
| 167 | u32 msg_len; |
| 168 | u32 save_input_buffer_length = vec_len (socket_main.input_buffer); |
| 169 | vl_socket_args_for_process_t *a; |
| 170 | msgbuf_t *mbp; |
| 171 | int mbp_set = 0; |
| 172 | |
| 173 | rp = pool_elt_at_index (socket_main.registration_pool, uf->private_data); |
| 174 | |
| 175 | n = read (uf->file_descriptor, socket_main.input_buffer, |
| 176 | vec_len (socket_main.input_buffer)); |
| 177 | |
| 178 | if (n <= 0 && errno != EAGAIN) |
| 179 | { |
| 180 | clib_file_del (fm, uf); |
| 181 | |
| 182 | if (!pool_is_free (socket_main.registration_pool, rp)) |
| 183 | { |
| 184 | u32 index = rp - socket_main.registration_pool; |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 185 | vl_socket_free_registration_index (index); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 186 | } |
| 187 | else |
| 188 | { |
| 189 | clib_warning ("client index %d already free?", |
| 190 | rp->vl_api_registration_pool_index); |
| 191 | } |
| 192 | return 0; |
| 193 | } |
| 194 | |
| 195 | _vec_len (socket_main.input_buffer) = n; |
| 196 | |
| 197 | /* |
| 198 | * Look for bugs here. This code is tricky because |
| 199 | * data read from a stream socket does not honor message |
| 200 | * boundaries. In the case of a long message (>4K bytes) |
| 201 | * we have to do (at least) 2 reads, etc. |
| 202 | */ |
| 203 | do |
| 204 | { |
| 205 | if (vec_len (rp->unprocessed_input)) |
| 206 | { |
| 207 | vec_append (rp->unprocessed_input, socket_main.input_buffer); |
| 208 | msg_buffer = rp->unprocessed_input; |
| 209 | } |
| 210 | else |
| 211 | { |
| 212 | msg_buffer = socket_main.input_buffer; |
| 213 | mbp_set = 0; |
| 214 | } |
| 215 | |
| 216 | if (mbp_set == 0) |
| 217 | { |
| 218 | /* Any chance that we have a complete message? */ |
| 219 | if (vec_len (msg_buffer) <= sizeof (msgbuf_t)) |
| 220 | goto save_and_split; |
| 221 | |
| 222 | mbp = (msgbuf_t *) msg_buffer; |
| 223 | msg_len = ntohl (mbp->data_len); |
| 224 | mbp_set = 1; |
| 225 | } |
| 226 | |
| 227 | /* We don't have the entire message yet. */ |
| 228 | if (mbp_set == 0 |
| 229 | || (msg_len + sizeof (msgbuf_t)) > vec_len (msg_buffer)) |
| 230 | { |
| 231 | save_and_split: |
| 232 | /* if we were using the input buffer save the fragment */ |
| 233 | if (msg_buffer == socket_main.input_buffer) |
| 234 | { |
| 235 | ASSERT (vec_len (rp->unprocessed_input) == 0); |
| 236 | vec_validate (rp->unprocessed_input, vec_len (msg_buffer) - 1); |
| 237 | clib_memcpy (rp->unprocessed_input, msg_buffer, |
| 238 | vec_len (msg_buffer)); |
| 239 | _vec_len (rp->unprocessed_input) = vec_len (msg_buffer); |
| 240 | } |
| 241 | _vec_len (socket_main.input_buffer) = save_input_buffer_length; |
| 242 | return 0; |
| 243 | } |
| 244 | |
| 245 | data_for_process = (u8 *) vec_dup (msg_buffer); |
| 246 | _vec_len (data_for_process) = (msg_len + sizeof (msgbuf_t)); |
| 247 | pool_get (socket_main.process_args, a); |
| 248 | a->clib_file = uf; |
| 249 | a->regp = rp; |
| 250 | a->data = data_for_process; |
| 251 | |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 252 | vlib_process_signal_event (vm, vl_api_clnt_node.index, |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 253 | SOCKET_READ_EVENT, |
| 254 | a - socket_main.process_args); |
| 255 | if (n > (msg_len + sizeof (*mbp))) |
| 256 | vec_delete (msg_buffer, msg_len + sizeof (*mbp), 0); |
| 257 | else |
| 258 | _vec_len (msg_buffer) = 0; |
| 259 | n -= msg_len + sizeof (msgbuf_t); |
| 260 | msg_len = 0; |
| 261 | mbp_set = 0; |
| 262 | } |
| 263 | while (n > 0); |
| 264 | |
| 265 | _vec_len (socket_main.input_buffer) = save_input_buffer_length; |
| 266 | |
| 267 | return 0; |
| 268 | } |
| 269 | |
| 270 | void |
| 271 | vl_socket_add_pending_output (clib_file_t * uf, |
| 272 | vl_api_registration_t * rp, |
| 273 | u8 * buffer, uword buffer_bytes) |
| 274 | { |
| 275 | clib_file_main_t *fm = &file_main; |
| 276 | |
| 277 | vec_add (rp->output_vector, buffer, buffer_bytes); |
| 278 | if (vec_len (rp->output_vector) > 0) |
| 279 | { |
| 280 | int skip_update = 0 != (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE); |
| 281 | uf->flags |= UNIX_FILE_DATA_AVAILABLE_TO_WRITE; |
| 282 | if (!skip_update) |
| 283 | fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY); |
| 284 | } |
| 285 | } |
| 286 | |
| 287 | void |
| 288 | vl_socket_add_pending_output_no_flush (clib_file_t * uf, |
| 289 | vl_api_registration_t * rp, |
| 290 | u8 * buffer, uword buffer_bytes) |
| 291 | { |
| 292 | vec_add (rp->output_vector, buffer, buffer_bytes); |
| 293 | } |
| 294 | |
| 295 | static void |
| 296 | socket_del_pending_output (clib_file_t * uf, |
| 297 | vl_api_registration_t * rp, uword n_bytes) |
| 298 | { |
| 299 | clib_file_main_t *fm = &file_main; |
| 300 | |
| 301 | vec_delete (rp->output_vector, n_bytes, 0); |
| 302 | if (vec_len (rp->output_vector) <= 0) |
| 303 | { |
| 304 | int skip_update = 0 == (uf->flags & UNIX_FILE_DATA_AVAILABLE_TO_WRITE); |
| 305 | uf->flags &= ~UNIX_FILE_DATA_AVAILABLE_TO_WRITE; |
| 306 | if (!skip_update) |
| 307 | fm->file_update (uf, UNIX_FILE_UPDATE_MODIFY); |
| 308 | } |
| 309 | } |
| 310 | |
| 311 | clib_error_t * |
| 312 | vl_socket_write_ready (clib_file_t * uf) |
| 313 | { |
| 314 | clib_file_main_t *fm = &file_main; |
| 315 | vl_api_registration_t *rp; |
| 316 | int n; |
| 317 | |
| 318 | rp = pool_elt_at_index (socket_main.registration_pool, uf->private_data); |
| 319 | |
| 320 | /* Flush output vector. */ |
| 321 | n = write (uf->file_descriptor, |
| 322 | rp->output_vector, vec_len (rp->output_vector)); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 323 | if (n < 0) |
| 324 | { |
| 325 | #if DEBUG > 2 |
| 326 | clib_warning ("write error, close the file...\n"); |
| 327 | #endif |
| 328 | clib_file_del (fm, uf); |
| 329 | |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 330 | vl_socket_free_registration_index (rp - socket_main.registration_pool); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 331 | return 0; |
| 332 | } |
| 333 | |
| 334 | else if (n > 0) |
| 335 | socket_del_pending_output (uf, rp, n); |
| 336 | |
| 337 | return 0; |
| 338 | } |
| 339 | |
| 340 | clib_error_t * |
| 341 | vl_socket_error_ready (clib_file_t * uf) |
| 342 | { |
| 343 | vl_api_registration_t *rp; |
| 344 | clib_file_main_t *fm = &file_main; |
| 345 | |
| 346 | rp = pool_elt_at_index (socket_main.registration_pool, uf->private_data); |
| 347 | clib_file_del (fm, uf); |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 348 | vl_socket_free_registration_index (rp - socket_main.registration_pool); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 349 | |
| 350 | return 0; |
| 351 | } |
| 352 | |
| 353 | void |
| 354 | socksvr_file_add (clib_file_main_t * fm, int fd) |
| 355 | { |
| 356 | vl_api_registration_t *rp; |
| 357 | clib_file_t template = { 0 }; |
| 358 | |
| 359 | pool_get (socket_main.registration_pool, rp); |
| 360 | memset (rp, 0, sizeof (*rp)); |
| 361 | |
| 362 | template.read_function = vl_socket_read_ready; |
| 363 | template.write_function = vl_socket_write_ready; |
| 364 | template.error_function = vl_socket_error_ready; |
| 365 | template.file_descriptor = fd; |
| 366 | template.private_data = rp - socket_main.registration_pool; |
| 367 | |
| 368 | rp->registration_type = REGISTRATION_TYPE_SOCKET_SERVER; |
| 369 | rp->vl_api_registration_pool_index = rp - socket_main.registration_pool; |
| 370 | rp->clib_file_index = clib_file_add (fm, &template); |
| 371 | } |
| 372 | |
| 373 | static clib_error_t * |
| 374 | socksvr_accept_ready (clib_file_t * uf) |
| 375 | { |
| 376 | clib_file_main_t *fm = &file_main; |
| 377 | socket_main_t *sm = &socket_main; |
| 378 | clib_socket_t *sock = &sm->socksvr_listen_socket; |
| 379 | clib_socket_t client; |
| 380 | clib_error_t *error; |
| 381 | |
| 382 | error = clib_socket_accept (sock, &client); |
| 383 | |
| 384 | if (error) |
| 385 | return error; |
| 386 | |
| 387 | socksvr_file_add (fm, client.fd); |
| 388 | return 0; |
| 389 | } |
| 390 | |
| 391 | static clib_error_t * |
| 392 | socksvr_bogus_write (clib_file_t * uf) |
| 393 | { |
| 394 | clib_warning ("why am I here?"); |
| 395 | return 0; |
| 396 | } |
| 397 | |
| 398 | /* |
| 399 | * vl_api_sockclnt_create_t_handler |
| 400 | */ |
| 401 | void |
| 402 | vl_api_sockclnt_create_t_handler (vl_api_sockclnt_create_t * mp) |
| 403 | { |
| 404 | vl_api_registration_t *regp; |
| 405 | vl_api_sockclnt_create_reply_t *rp; |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 406 | int rv = 0; |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 407 | |
| 408 | regp = socket_main.current_rp; |
| 409 | |
| 410 | ASSERT (regp->registration_type == REGISTRATION_TYPE_SOCKET_SERVER); |
| 411 | |
| 412 | regp->name = format (0, "%s%c", mp->name, 0); |
| 413 | |
| 414 | rp = vl_msg_api_alloc (sizeof (*rp)); |
| 415 | rp->_vl_msg_id = htons (VL_API_SOCKCLNT_CREATE_REPLY); |
| 416 | rp->handle = (uword) regp; |
| 417 | rp->index = (uword) regp->vl_api_registration_pool_index; |
| 418 | rp->context = mp->context; |
| 419 | rp->response = htonl (rv); |
| 420 | |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 421 | vl_api_send_msg (regp, (u8 *) rp); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 422 | } |
| 423 | |
| 424 | /* |
| 425 | * vl_api_sockclnt_delete_t_handler |
| 426 | */ |
| 427 | void |
| 428 | vl_api_sockclnt_delete_t_handler (vl_api_sockclnt_delete_t * mp) |
| 429 | { |
| 430 | vl_api_registration_t *regp; |
| 431 | vl_api_sockclnt_delete_reply_t *rp; |
| 432 | |
| 433 | if (!pool_is_free_index (socket_main.registration_pool, mp->index)) |
| 434 | { |
| 435 | regp = pool_elt_at_index (socket_main.registration_pool, mp->index); |
| 436 | |
| 437 | rp = vl_msg_api_alloc (sizeof (*rp)); |
| 438 | rp->_vl_msg_id = htons (VL_API_SOCKCLNT_DELETE_REPLY); |
| 439 | rp->handle = mp->handle; |
| 440 | rp->response = htonl (1); |
| 441 | |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 442 | vl_api_send_msg (regp, (u8 *) rp); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 443 | |
| 444 | clib_file_del (&file_main, file_main.file_pool + regp->clib_file_index); |
| 445 | |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 446 | vl_socket_free_registration_index (mp->index); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 447 | } |
| 448 | else |
| 449 | { |
| 450 | clib_warning ("unknown client ID %d", mp->index); |
| 451 | } |
| 452 | } |
| 453 | |
| 454 | static clib_error_t * |
| 455 | send_fd_msg (int socket_fd, int fd_to_share) |
| 456 | { |
| 457 | struct msghdr mh = { 0 }; |
| 458 | struct iovec iov[1]; |
| 459 | char ctl[CMSG_SPACE (sizeof (int))]; |
| 460 | char *msg = "memfd"; |
| 461 | int rv; |
| 462 | |
| 463 | iov[0].iov_base = msg; |
| 464 | iov[0].iov_len = strlen (msg); |
| 465 | mh.msg_iov = iov; |
| 466 | mh.msg_iovlen = 1; |
| 467 | |
| 468 | struct cmsghdr *cmsg; |
| 469 | memset (&ctl, 0, sizeof (ctl)); |
| 470 | mh.msg_control = ctl; |
| 471 | mh.msg_controllen = sizeof (ctl); |
| 472 | cmsg = CMSG_FIRSTHDR (&mh); |
| 473 | cmsg->cmsg_len = CMSG_LEN (sizeof (int)); |
| 474 | cmsg->cmsg_level = SOL_SOCKET; |
| 475 | cmsg->cmsg_type = SCM_RIGHTS; |
| 476 | memcpy (CMSG_DATA (cmsg), &fd_to_share, sizeof (int)); |
| 477 | |
| 478 | rv = sendmsg (socket_fd, &mh, 0); |
| 479 | if (rv < 0) |
| 480 | return clib_error_return_unix (0, "sendmsg"); |
| 481 | return 0; |
| 482 | } |
| 483 | |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 484 | vl_api_shm_elem_config_t * |
| 485 | vl_api_make_shm_config (vl_api_sock_init_shm_t * mp) |
| 486 | { |
| 487 | vl_api_shm_elem_config_t *config = 0, *c; |
| 488 | u64 cfg; |
| 489 | int i; |
| 490 | |
| 491 | if (!mp->nitems) |
| 492 | { |
| 493 | vec_validate (config, 3); |
| 494 | config[0].type = VL_API_VLIB_RING; |
| 495 | config[0].count = 128; |
| 496 | config[0].size = 256; |
| 497 | config[1].type = VL_API_CLIENT_RING; |
| 498 | config[1].count = 128; |
| 499 | config[1].size = 1024; |
| 500 | config[2].type = VL_API_CLIENT_RING; |
| 501 | config[2].count = 8; |
| 502 | config[2].size = 4096; |
| 503 | config[3].type = VL_API_QUEUE; |
| 504 | config[3].count = 128; |
| 505 | config[3].size = sizeof (uword); |
| 506 | } |
| 507 | else |
| 508 | { |
| 509 | vec_validate (config, mp->nitems - 1); |
| 510 | for (i = 0; i < mp->nitems; i++) |
| 511 | { |
| 512 | cfg = mp->configs[i]; |
| 513 | /* Pretty much a hack but it avoids defining our own api type |
| 514 | * in memclnt.api */ |
| 515 | c = (vl_api_shm_elem_config_t *) & cfg; |
| 516 | config[i].type = c->type; |
| 517 | config[i].count = c->count; |
| 518 | config[i].size = c->size; |
| 519 | } |
| 520 | } |
| 521 | return config; |
| 522 | } |
| 523 | |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 524 | /* |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 525 | * Bootstrap shm api using the socket api |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 526 | */ |
| 527 | void |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 528 | vl_api_sock_init_shm_t_handler (vl_api_sock_init_shm_t * mp) |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 529 | { |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 530 | vl_api_sock_init_shm_reply_t *rmp; |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 531 | memfd_private_t _memfd_private, *memfd = &_memfd_private; |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 532 | svm_map_region_args_t _args, *a = &_args; |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 533 | vl_api_registration_t *regp; |
| 534 | api_main_t *am = &api_main; |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 535 | svm_region_t *vlib_rp; |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 536 | clib_file_t *cf; |
| 537 | vl_api_shm_elem_config_t *config = 0; |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 538 | int rv; |
| 539 | |
| 540 | regp = vl_api_client_index_to_registration (mp->client_index); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 541 | if (regp == 0) |
| 542 | { |
| 543 | clib_warning ("API client disconnected"); |
| 544 | return; |
| 545 | } |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 546 | if (regp->registration_type != REGISTRATION_TYPE_SOCKET_SERVER) |
| 547 | { |
| 548 | rv = -31; /* VNET_API_ERROR_INVALID_REGISTRATION */ |
| 549 | goto reply; |
| 550 | } |
| 551 | |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 552 | /* |
| 553 | * Set up a memfd segment of the requested size wherein the |
| 554 | * shmem data structures will be initialized |
| 555 | */ |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 556 | memset (memfd, 0, sizeof (*memfd)); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 557 | memfd->memfd_size = mp->requested_size; |
| 558 | memfd->requested_va = 0ULL; |
| 559 | memfd->i_am_master = 1; |
| 560 | memfd->name = format (0, "%s%c", regp->name, 0); |
| 561 | |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 562 | if ((rv = memfd_master_init (memfd, mp->client_index))) |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 563 | goto reply; |
| 564 | |
| 565 | /* Remember to close this fd when the socket connection goes away */ |
| 566 | vec_add1 (regp->additional_fds_to_close, memfd->fd); |
| 567 | |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 568 | /* |
| 569 | * Create a plausible svm_region in the memfd backed segment |
| 570 | */ |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 571 | memset (a, 0, sizeof (*a)); |
| 572 | a->baseva = memfd->sh->memfd_va + MMAP_PAGESIZE; |
| 573 | a->size = memfd->memfd_size - MMAP_PAGESIZE; |
| 574 | /* $$$$ might want a different config parameter */ |
| 575 | a->pvt_heap_size = am->api_pvt_heap_size; |
| 576 | a->flags = SVM_FLAGS_MHEAP; |
| 577 | svm_region_init_mapped_region (a, (svm_region_t *) a->baseva); |
| 578 | |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 579 | /* |
| 580 | * Part deux, initialize the svm_region_t shared-memory header |
| 581 | * api allocation rings, and so on. |
| 582 | */ |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 583 | config = vl_api_make_shm_config (mp); |
| 584 | vlib_rp = (svm_region_t *) a->baseva; |
| 585 | vl_init_shmem (vlib_rp, config, 1 /* is_vlib (dont-care) */ , |
| 586 | 1 /* is_private */ ); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 587 | vec_add1 (am->vlib_private_rps, vlib_rp); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 588 | memfd->sh->ready = 1; |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 589 | vec_free (config); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 590 | |
| 591 | /* Recompute the set of input queues to poll in memclnt_process */ |
| 592 | vec_reset_length (vl_api_queue_cursizes); |
| 593 | |
| 594 | reply: |
| 595 | |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 596 | rmp = vl_msg_api_alloc (sizeof (*rmp)); |
| 597 | rmp->_vl_msg_id = htons (VL_API_SOCK_INIT_SHM_REPLY); |
| 598 | rmp->context = mp->context; |
| 599 | rmp->retval = htonl (rv); |
| 600 | |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 601 | vl_api_send_msg (regp, (u8 *) rmp); |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 602 | |
| 603 | if (rv != 0) |
| 604 | return; |
| 605 | |
| 606 | /* |
| 607 | * We need the reply message to make it out the back door |
| 608 | * before we send the magic fd message so force a flush |
| 609 | */ |
| 610 | cf = clib_file_get (&file_main, regp->clib_file_index); |
| 611 | cf->write_function (cf); |
| 612 | |
| 613 | /* Send the magic "here's your sign (aka fd)" socket message */ |
| 614 | send_fd_msg (cf->file_descriptor, memfd->fd); |
| 615 | } |
| 616 | |
| 617 | /* |
| 618 | * Create a memory-fd segment. |
| 619 | */ |
| 620 | void |
| 621 | vl_api_memfd_segment_create_t_handler (vl_api_memfd_segment_create_t * mp) |
| 622 | { |
| 623 | vl_api_memfd_segment_create_reply_t *rmp; |
| 624 | clib_file_t *cf; |
| 625 | memfd_private_t _memfd_private, *memfd = &_memfd_private; |
| 626 | vl_api_registration_t *regp; |
| 627 | int rv; |
| 628 | |
| 629 | regp = vl_api_client_index_to_registration (mp->client_index); |
| 630 | if (regp == 0) |
| 631 | { |
| 632 | clib_warning ("API client disconnected"); |
| 633 | return; |
| 634 | } |
| 635 | |
| 636 | memset (memfd, 0, sizeof (*memfd)); |
| 637 | memfd->memfd_size = mp->requested_size; |
| 638 | memfd->requested_va = 0ULL; |
| 639 | memfd->i_am_master = 1; |
| 640 | memfd->name = format (0, "%s%c", regp->name, 0); |
| 641 | |
| 642 | /* Set up a memfd segment of the requested size */ |
| 643 | if ((rv = memfd_master_init (memfd, mp->client_index))) |
| 644 | goto reply; |
| 645 | |
| 646 | /* Remember to close this fd when the socket connection goes away */ |
| 647 | vec_add1 (regp->additional_fds_to_close, memfd->fd); |
| 648 | |
| 649 | reply: |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 650 | |
| 651 | rmp = vl_msg_api_alloc (sizeof (*rmp)); |
| 652 | rmp->_vl_msg_id = htons (VL_API_MEMFD_SEGMENT_CREATE_REPLY); |
| 653 | rmp->context = mp->context; |
| 654 | rmp->retval = htonl (rv); |
| 655 | |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 656 | vl_api_send_msg (regp, (u8 *) rmp); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 657 | |
| 658 | if (rv != 0) |
| 659 | return; |
| 660 | |
| 661 | /* |
| 662 | * We need the reply message to make it out the back door |
| 663 | * before we send the magic fd message. |
| 664 | */ |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 665 | cf = file_main.file_pool + regp->clib_file_index; |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 666 | cf->write_function (cf); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 667 | |
| 668 | /* send the magic "here's your sign (aka fd)" socket message */ |
| 669 | send_fd_msg (cf->file_descriptor, memfd->fd); |
| 670 | } |
| 671 | |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 672 | #define foreach_vlib_api_msg \ |
| 673 | _(SOCKCLNT_CREATE, sockclnt_create) \ |
| 674 | _(SOCKCLNT_DELETE, sockclnt_delete) \ |
| 675 | _(SOCK_INIT_SHM, sock_init_shm) \ |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 676 | _(MEMFD_SEGMENT_CREATE, memfd_segment_create) |
| 677 | |
| 678 | clib_error_t * |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 679 | vl_sock_api_init (vlib_main_t * vm) |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 680 | { |
| 681 | clib_file_main_t *fm = &file_main; |
| 682 | clib_file_t template = { 0 }; |
| 683 | vl_api_registration_t *rp; |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 684 | socket_main_t *sm = &socket_main; |
| 685 | clib_socket_t *sock = &sm->socksvr_listen_socket; |
| 686 | clib_error_t *error; |
| 687 | |
| 688 | /* If not explicitly configured, do not bind/enable, etc. */ |
| 689 | if (sm->socket_name == 0) |
| 690 | return 0; |
| 691 | |
Florin Coras | 90a6398 | 2017-12-19 04:50:01 -0800 | [diff] [blame] | 692 | #define _(N,n) \ |
| 693 | vl_msg_api_set_handlers(VL_API_##N, #n, \ |
| 694 | vl_api_##n##_t_handler, \ |
| 695 | vl_noop_handler, \ |
| 696 | vl_api_##n##_t_endian, \ |
| 697 | vl_api_##n##_t_print, \ |
| 698 | sizeof(vl_api_##n##_t), 1); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 699 | foreach_vlib_api_msg; |
| 700 | #undef _ |
| 701 | |
| 702 | vec_resize (sm->input_buffer, 4096); |
| 703 | |
| 704 | sock->config = (char *) sm->socket_name; |
| 705 | |
| 706 | /* mkdir of file socket, only under /run */ |
| 707 | if (strncmp (sock->config, "/run", 4) == 0) |
| 708 | { |
| 709 | u8 *tmp = format (0, "%s", sock->config); |
| 710 | int i = vec_len (tmp); |
| 711 | while (i && tmp[--i] != '/') |
| 712 | ; |
| 713 | |
| 714 | tmp[i] = 0; |
| 715 | |
| 716 | if (i) |
| 717 | vlib_unix_recursive_mkdir ((char *) tmp); |
| 718 | vec_free (tmp); |
| 719 | } |
| 720 | |
| 721 | sock->flags = CLIB_SOCKET_F_IS_SERVER | CLIB_SOCKET_F_SEQPACKET | |
| 722 | CLIB_SOCKET_F_ALLOW_GROUP_WRITE; |
| 723 | error = clib_socket_init (sock); |
| 724 | if (error) |
| 725 | return error; |
| 726 | |
| 727 | pool_get (sm->registration_pool, rp); |
| 728 | memset (rp, 0, sizeof (*rp)); |
| 729 | |
| 730 | rp->registration_type = REGISTRATION_TYPE_SOCKET_LISTEN; |
| 731 | |
| 732 | template.read_function = socksvr_accept_ready; |
| 733 | template.write_function = socksvr_bogus_write; |
| 734 | template.file_descriptor = sock->fd; |
| 735 | template.private_data = rp - sm->registration_pool; |
| 736 | |
| 737 | rp->clib_file_index = clib_file_add (fm, &template); |
| 738 | return 0; |
| 739 | } |
| 740 | |
| 741 | static clib_error_t * |
| 742 | socket_exit (vlib_main_t * vm) |
| 743 | { |
| 744 | clib_file_main_t *fm = &file_main; |
| 745 | socket_main_t *sm = &socket_main; |
| 746 | vl_api_registration_t *rp; |
| 747 | |
| 748 | /* Defensive driving in case something wipes out early */ |
| 749 | if (sm->registration_pool) |
| 750 | { |
| 751 | u32 index; |
| 752 | /* *INDENT-OFF* */ |
| 753 | pool_foreach (rp, sm->registration_pool, ({ |
| 754 | clib_file_del (fm, fm->file_pool + rp->clib_file_index); |
| 755 | index = rp->vl_api_registration_pool_index; |
Florin Coras | e86a8ed | 2018-01-05 03:20:25 -0800 | [diff] [blame^] | 756 | vl_socket_free_registration_index (index); |
Dave Barach | 59b2565 | 2017-09-10 15:04:27 -0400 | [diff] [blame] | 757 | })); |
| 758 | /* *INDENT-ON* */ |
| 759 | } |
| 760 | |
| 761 | return 0; |
| 762 | } |
| 763 | |
| 764 | VLIB_MAIN_LOOP_EXIT_FUNCTION (socket_exit); |
| 765 | |
| 766 | static clib_error_t * |
| 767 | socksvr_config (vlib_main_t * vm, unformat_input_t * input) |
| 768 | { |
| 769 | socket_main_t *sm = &socket_main; |
| 770 | |
| 771 | while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT) |
| 772 | { |
| 773 | if (unformat (input, "socket-name %s", &sm->socket_name)) |
| 774 | ; |
| 775 | else if (unformat (input, "default")) |
| 776 | { |
| 777 | sm->socket_name = format (0, "%s%c", API_SOCKET_FILE, 0); |
| 778 | } |
| 779 | else |
| 780 | { |
| 781 | return clib_error_return (0, "unknown input '%U'", |
| 782 | format_unformat_error, input); |
| 783 | } |
| 784 | } |
| 785 | return 0; |
| 786 | } |
| 787 | |
| 788 | VLIB_CONFIG_FUNCTION (socksvr_config, "socksvr"); |
| 789 | |
| 790 | clib_error_t * |
| 791 | vlibsocket_init (vlib_main_t * vm) |
| 792 | { |
| 793 | return 0; |
| 794 | } |
| 795 | |
| 796 | VLIB_INIT_FUNCTION (vlibsocket_init); |
| 797 | |
| 798 | /* |
| 799 | * fd.io coding-style-patch-verification: ON |
| 800 | * |
| 801 | * Local Variables: |
| 802 | * eval: (c-set-style "gnu") |
| 803 | * End: |
| 804 | */ |