/* * memif VAT support * * Copyright (c) 2017 Cisco and/or its affiliates. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at: * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #include #include #include #include #include #include #include #include #define __plugin_msg_base memif_test_main.msg_id_base #include /* declare message IDs */ #include /* Get CRC codes of the messages defined outside of this plugin */ #define vl_msg_name_crc_list #include #undef vl_msg_name_crc_list /* define message structures */ #define vl_typedefs #include #include #undef vl_typedefs /* declare message handlers for each api */ #define vl_endianfun /* define message structures */ #include #undef vl_endianfun /* instantiate all the print functions we know about */ #define vl_print(handle, ...) #define vl_printfun #include #undef vl_printfun /* Get the API version number. */ #define vl_api_version(n,v) static u32 api_version=(v); #include #undef vl_api_version typedef struct { /* API message ID base */ u16 msg_id_base; u32 ping_id; vat_main_t *vat_main; } memif_test_main_t; memif_test_main_t memif_test_main; /* standard reply handlers */ #define foreach_standard_reply_retval_handler \ _(memif_delete_reply) #define _(n) \ static void vl_api_##n##_t_handler \ (vl_api_##n##_t * mp) \ { \ vat_main_t * vam = memif_test_main.vat_main; \ i32 retval = ntohl(mp->retval); \ if (vam->async_mode) { \ vam->async_errors += (retval < 0); \ } else { \ vam->retval = retval; \ vam->result_ready = 1; \ } \ } foreach_standard_reply_retval_handler; #undef _ /* * Table of message reply handlers, must include boilerplate handlers * we just generated */ #define foreach_vpe_api_reply_msg \ _(MEMIF_CREATE_REPLY, memif_create_reply) \ _(MEMIF_DELETE_REPLY, memif_delete_reply) \ _(MEMIF_DETAILS, memif_details) \ _(MEMIF_SOCKET_FILENAME_DETAILS, memif_socket_filename_details) \ _(MEMIF_SOCKET_FILENAME_ADD_DEL_REPLY, memif_socket_filename_add_del_reply) static uword unformat_memif_queues (unformat_input_t * input, va_list * args) { u32 *rx_queues = va_arg (*args, u32 *); u32 *tx_queues = va_arg (*args, u32 *); if (unformat (input, "rx-queues %u", rx_queues)) ; if (unformat (input, "tx-queues %u", tx_queues)) ; return 1; } /* memif_socket_filename_add_del API */ static int api_memif_socket_filename_add_del (vat_main_t * vam) { unformat_input_t *i = vam->input; vl_api_memif_socket_filename_add_del_t *mp; u8 is_add; u32 socket_id; u8 *socket_filename; int ret; is_add = 1; socket_id = ~0; socket_filename = 0; while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT) { if (unformat (i, "id %u", &socket_id)) ; else if (unformat (i, "filename %s", &socket_filename)) ; else if (unformat (i, "del")) is_add = 0; else if (unformat (i, "add")) is_add = 1; else { vec_free (socket_filename); clib_warning ("unknown input `%U'", format_unformat_error, i); return -99; } } if (socket_id == 0 || socket_id == ~0) { vec_free (socket_filename); errmsg ("Invalid socket id"); return -99; } if (is_add && (!socket_filename || *socket_filename == 0)) { vec_free (socket_filename); errmsg ("Invalid socket filename"); return -99; } M (MEMIF_SOCKET_FILENAME_ADD_DEL, mp); mp->is_add = is_add; mp->socket_id = htonl (socket_id); strncpy ((char *) mp->socket_filename, (char *) socket_filename, sizeof (mp->socket_filename) - 1); vec_free (socket_filename); S (mp); W (ret); return ret; } /* memif_socket_filename_add_del reply handler */ static void vl_api_memif_socket_filename_add_del_reply_t_handler (vl_api_memif_socket_filename_add_del_reply_t * mp) { vat_main_t *vam = memif_test_main.vat_main; i32 retval = ntohl (mp->retval); vam->retval = retval; vam->result_ready = 1; vam->regenerate_interface_table = 1; } /* memif-create API */ static int api_memif_create (vat_main_t * vam) { unformat_input_t *i = vam->input; vl_api_memif_create_t *mp; u32 id = 0; u32 socket_id = 0; u8 *secret = 0; u8 role = 1; u32 ring_size = 0; u32 buffer_size = 0; u8 hw_addr[6] = { 0 }; u32 rx_queues = MEMIF_DEFAULT_RX_QUEUES; u32 tx_queues = MEMIF_DEFAULT_TX_QUEUES; int ret; u8 mode = MEMIF_INTERFACE_MODE_ETHERNET; while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT) { if (unformat (i, "id %u", &id)) ; else if (unformat (i, "socket-id %u", &socket_id)) ; else if (unformat (i, "secret %s", &secret)) ; else if (unformat (i, "ring_size %u", &ring_size)) ; else if (unformat (i, "buffer_size %u", &buffer_size)) ; else if (unformat (i, "master")) role = 0; else if (unformat (i, "slave %U", unformat_memif_queues, &rx_queues, &tx_queues)) role = 1; else if (unformat (i, "mode ip")) mode = MEMIF_INTERFACE_MODE_IP; else if (unformat (i, "hw_addr %U", unformat_ethernet_address, hw_addr)) ; else { clib_warning ("unknow
## Build Instructions    {#libmemif_build_doc}

#### Install dependencies
```
# sudo apt-get install -y git cmake autoconf pkg_config libtool check
```

Libmemif is now part of VPP repository. Follow fd.io wiki to pull source code from VPP repository.
[https://wiki.fd.io/view/VPP/Pulling,_Building,_Running,_Hacking_and_Pushing_VPP_Code#Pushing_Patches](https://wiki.fd.io/view/VPP/Pulling,_Building,_Running,_Hacking_and_Pushing_VPP_Code#Pushing_Patches)

Libmemif is located under extras/libmemif. From extras/libmemif:
```
# mkdir build
# cd build
# cmake ..
# make install
```

#### Verify installation:
```
build# ./examples/icmpr-epoll
```
Use _help_ command to display build information and commands:
```
LIBMEMIF EXAMPLE APP: ICMP_Responder
==============================
libmemif version: 3.0
memif version: 512
	use CTRL+C to exit
MEMIF DETAILS
==============================
	interface name: memif_connection
	app name: ICMP_Responder
	remote interface name:
	remote app name:
	id: 0
	secret: (null)
	role: slave
	mode: ethernet
	socket filename: /run/vpp/memif.sock
	socket filename: /run/vpp/memif.sock
	rx queues:
	tx queues:
	link: down
```

#### Examples

Once the library is built/installed, refer to @ref libmemif_examples_doc and @ref libmemif_gettingstarted_doc for additional information on basic use cases and API usage.