From 496e127c58466969ddcab65b6f67bb2eb20a70bb Mon Sep 17 00:00:00 2001 From: Dave Barach Date: Wed, 7 Dec 2016 09:15:58 -0500 Subject: Refactor tap binary APIs, VPP-550 Change-Id: I1599b3659411b5f4451c364cc5ada63cfa8e0a6b Signed-off-by: Dave Barach --- vnet/Makefile.am | 9 +- vnet/vnet/unix/tap.api | 123 ++++++++++++++++++++++ vnet/vnet/unix/tap_api.c | 257 +++++++++++++++++++++++++++++++++++++++++++++ vnet/vnet/vnet_all_api_h.h | 1 + 4 files changed, 388 insertions(+), 2 deletions(-) create mode 100644 vnet/vnet/unix/tap.api create mode 100644 vnet/vnet/unix/tap_api.c (limited to 'vnet') diff --git a/vnet/Makefile.am b/vnet/Makefile.am index 930d6bb9278..eb7f8ef1a01 100644 --- a/vnet/Makefile.am +++ b/vnet/Makefile.am @@ -25,7 +25,9 @@ BUILT_SOURCES = \ vnet/map/map.api.h \ vnet/map/map.api.json \ vnet/span/span.api.h \ - vnet/span/span.api.json + vnet/span/span.api.json \ + vnet/unix/tap.api.h \ + vnet/unix/tap.api.json libvnet_la_SOURCES = libvnetplugin_la_SOURCES = @@ -787,12 +789,14 @@ nobase_include_HEADERS += \ libvnet_la_SOURCES += \ vnet/unix/gdb_funcs.c \ vnet/unix/pcap.c \ + vnet/unix/tap_api.c \ vnet/unix/tapcli.c \ vnet/unix/tuntap.c nobase_include_HEADERS += \ vnet/unix/pcap.h \ vnet/unix/tuntap.h \ + vnet/unix/tap.api.h \ vnet/unix/tapcli.h ######################################## @@ -918,7 +922,8 @@ api_DATA = \ vnet/ip/ip.api.json \ vnet/l2/l2.api.json \ vnet/map/map.api.json \ - vnet/span/span.api.json + vnet/span/span.api.json \ + vnet/unix/tap.api.json # The actual %.api.h rule is in .../build-data/packages/suffix-rules.mk # and requires a symbolic link at the top of the vnet source tree diff --git a/vnet/vnet/unix/tap.api b/vnet/vnet/unix/tap.api new file mode 100644 index 00000000000..9b16eadbf86 --- /dev/null +++ b/vnet/vnet/unix/tap.api @@ -0,0 +1,123 @@ +/* + * Copyright (c) 2015-2016 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. + */ + +/** \file + + This file defines vpe control-plane API messages for + the Linux kernel TAP device driver +*/ + +/** \brief Initialize a new tap interface with the given paramters + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param use_random_mac - let the system generate a unique mac address + @param tap_name - name to associate with the new interface + @param mac_address - mac addr to assign to the interface if use_radom not set +*/ +define tap_connect +{ + u32 client_index; + u32 context; + u8 use_random_mac; + u8 tap_name[64]; + u8 mac_address[6]; + u8 renumber; + u32 custom_dev_instance; + u8 tag[64]; +}; + +/** \brief Reply for tap connect request + @param context - returned sender context, to match reply w/ request + @param retval - return code + @param sw_if_index - software index allocated for the new tap interface +*/ +define tap_connect_reply +{ + u32 context; + i32 retval; + u32 sw_if_index; +}; + +/** \brief Modify a tap interface with the given paramters + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param sw_if_index - interface index of existing tap interface + @param use_random_mac - let the system generate a unique mac address + @param tap_name - name to associate with the new interface + @param mac_address - mac addr to assign to the interface if use_radom not set +*/ +define tap_modify +{ + u32 client_index; + u32 context; + u32 sw_if_index; + u8 use_random_mac; + u8 tap_name[64]; + u8 mac_address[6]; + u8 renumber; + u32 custom_dev_instance; +}; + +/** \brief Reply for tap modify request + @param context - returned sender context, to match reply w/ request + @param retval - return code + @param sw_if_index - software index if the modified tap interface +*/ +define tap_modify_reply +{ + u32 context; + i32 retval; + u32 sw_if_index; +}; + +/** \brief Delete tap interface + @param client_index - opaque cookie to identify the sender + @param context - sender context, to match reply w/ request + @param sw_if_index - interface index of existing tap interface +*/ +define tap_delete +{ + u32 client_index; + u32 context; + u32 sw_if_index; +}; + +/** \brief Reply for tap delete request + @param context - returned sender context, to match reply w/ request + @param retval - return code +*/ +define tap_delete_reply +{ + u32 context; + i32 retval; +}; + +/** \brief Dump tap interfaces request */ +define sw_interface_tap_dump +{ + u32 client_index; + u32 context; +}; + +/** \brief Reply for tap dump request + @param sw_if_index - software index of tap interface + @param dev_name - Linux tap device name +*/ +define sw_interface_tap_details +{ + u32 context; + u32 sw_if_index; + u8 dev_name[64]; +}; diff --git a/vnet/vnet/unix/tap_api.c b/vnet/vnet/unix/tap_api.c new file mode 100644 index 00000000000..99b79ba2e70 --- /dev/null +++ b/vnet/vnet/unix/tap_api.c @@ -0,0 +1,257 @@ +/* + *------------------------------------------------------------------ + * tap_api.c - vnet tap device driver API support + * + * Copyright (c) 2016 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 + +#include + +#define vl_typedefs /* define message structures */ +#include +#undef vl_typedefs + +#define vl_endianfun /* define message structures */ +#include +#undef vl_endianfun + +/* instantiate all the print functions we know about */ +#define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__) +#define vl_printfun +#include +#undef vl_printfun + +#include + +#define foreach_tap_api_msg \ +_(TAP_CONNECT, tap_connect) \ +_(TAP_MODIFY, tap_modify) \ +_(TAP_DELETE, tap_delete) \ +_(SW_INTERFACE_TAP_DUMP, sw_interface_tap_dump) + +#define vl_msg_name_crc_list +#include +#undef vl_msg_name_crc_list + +/* + * WARNING: replicated pending api refactor completion + */ +static void +send_sw_interface_flags_deleted (vpe_api_main_t * am, + unix_shared_memory_queue_t * q, + u32 sw_if_index) +{ + vl_api_sw_interface_set_flags_t *mp; + + mp = vl_msg_api_alloc (sizeof (*mp)); + memset (mp, 0, sizeof (*mp)); + mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_SET_FLAGS); + mp->sw_if_index = ntohl (sw_if_index); + + mp->admin_up_down = 0; + mp->link_up_down = 0; + mp->deleted = 1; + vl_msg_api_send_shmem (q, (u8 *) & mp); +} + +static void +vl_api_tap_connect_t_handler (vl_api_tap_connect_t * mp) +{ + vlib_main_t *vm = vlib_get_main (); + int rv; + vl_api_tap_connect_reply_t *rmp; + vnet_main_t *vnm = vnet_get_main (); + unix_shared_memory_queue_t *q; + u32 sw_if_index = (u32) ~ 0; + u8 *tag; + + rv = vnet_tap_connect_renumber (vm, mp->tap_name, + mp->use_random_mac ? 0 : mp->mac_address, + &sw_if_index, mp->renumber, + ntohl (mp->custom_dev_instance)); + + /* Add tag if supplied */ + if (rv == 0 && mp->tag[0]) + { + mp->tag[ARRAY_LEN (mp->tag) - 1] = 0; + tag = format (0, "%s%c", mp->tag, 0); + vnet_set_sw_interface_tag (vnm, tag, sw_if_index); + } + + q = vl_api_client_index_to_input_queue (mp->client_index); + if (!q) + return; + + rmp = vl_msg_api_alloc (sizeof (*rmp)); + rmp->_vl_msg_id = ntohs (VL_API_TAP_CONNECT_REPLY); + rmp->context = mp->context; + rmp->retval = ntohl (rv); + rmp->sw_if_index = ntohl (sw_if_index); + + vl_msg_api_send_shmem (q, (u8 *) & rmp); +} + +static void +vl_api_tap_modify_t_handler (vl_api_tap_modify_t * mp) +{ + int rv; + vl_api_tap_modify_reply_t *rmp; + unix_shared_memory_queue_t *q; + u32 sw_if_index = (u32) ~ 0; + vlib_main_t *vm = vlib_get_main (); + + rv = vnet_tap_modify (vm, ntohl (mp->sw_if_index), mp->tap_name, + mp->use_random_mac ? 0 : mp->mac_address, + &sw_if_index, mp->renumber, + ntohl (mp->custom_dev_instance)); + + q = vl_api_client_index_to_input_queue (mp->client_index); + if (!q) + return; + + rmp = vl_msg_api_alloc (sizeof (*rmp)); + rmp->_vl_msg_id = ntohs (VL_API_TAP_MODIFY_REPLY); + rmp->context = mp->context; + rmp->retval = ntohl (rv); + rmp->sw_if_index = ntohl (sw_if_index); + + vl_msg_api_send_shmem (q, (u8 *) & rmp); +} + +static void +vl_api_tap_delete_t_handler (vl_api_tap_delete_t * mp) +{ + vlib_main_t *vm = vlib_get_main (); + int rv; + vpe_api_main_t *vam = &vpe_api_main; + vl_api_tap_delete_reply_t *rmp; + unix_shared_memory_queue_t *q; + u32 sw_if_index = ntohl (mp->sw_if_index); + + rv = vnet_tap_delete (vm, sw_if_index); + if (!rv) + { + vnet_main_t *vnm = vnet_get_main (); + vnet_clear_sw_interface_tag (vnm, sw_if_index); + } + + q = vl_api_client_index_to_input_queue (mp->client_index); + if (!q) + return; + + rmp = vl_msg_api_alloc (sizeof (*rmp)); + rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_REPLY); + rmp->context = mp->context; + rmp->retval = ntohl (rv); + + vl_msg_api_send_shmem (q, (u8 *) & rmp); + + if (!rv) + send_sw_interface_flags_deleted (vam, q, sw_if_index); +} + +static void +send_sw_interface_tap_details (vpe_api_main_t * am, + unix_shared_memory_queue_t * q, + tapcli_interface_details_t * tap_if, + u32 context) +{ + vl_api_sw_interface_tap_details_t *mp; + mp = vl_msg_api_alloc (sizeof (*mp)); + memset (mp, 0, sizeof (*mp)); + mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_TAP_DETAILS); + mp->sw_if_index = ntohl (tap_if->sw_if_index); + strncpy ((char *) mp->dev_name, + (char *) tap_if->dev_name, ARRAY_LEN (mp->dev_name) - 1); + mp->context = context; + + vl_msg_api_send_shmem (q, (u8 *) & mp); +} + +static void +vl_api_sw_interface_tap_dump_t_handler (vl_api_sw_interface_tap_dump_t * mp) +{ + int rv = 0; + vpe_api_main_t *am = &vpe_api_main; + unix_shared_memory_queue_t *q; + tapcli_interface_details_t *tapifs = NULL; + tapcli_interface_details_t *tap_if = NULL; + + q = vl_api_client_index_to_input_queue (mp->client_index); + if (q == 0) + return; + + rv = vnet_tap_dump_ifs (&tapifs); + if (rv) + return; + + vec_foreach (tap_if, tapifs) + { + send_sw_interface_tap_details (am, q, tap_if, mp->context); + } + + vec_free (tapifs); +} + +static void +setup_message_id_table (api_main_t * am) +{ +#define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id); + foreach_vl_msg_name_crc_tap; +#undef _ +} + +static clib_error_t * +tap_api_hookup (vlib_main_t * vm) +{ + api_main_t *am = &api_main; + +#define _(N,n) \ + vl_msg_api_set_handlers(VL_API_##N, #n, \ + vl_api_##n##_t_handler, \ + vl_noop_handler, \ + vl_api_##n##_t_endian, \ + vl_api_##n##_t_print, \ + sizeof(vl_api_##n##_t), 1); + foreach_tap_api_msg; +#undef _ + + /* + * Set up the (msg_name, crc, message-id) table + */ + setup_message_id_table (am); + + return 0; +} + +VLIB_API_INIT_FUNCTION (tap_api_hookup); + +/* + * fd.io coding-style-patch-verification: ON + * + * Local Variables: + * eval: (c-set-style "gnu") + * End: + */ diff --git a/vnet/vnet/vnet_all_api_h.h b/vnet/vnet/vnet_all_api_h.h index 4f14ab2112b..dfc27239e89 100644 --- a/vnet/vnet/vnet_all_api_h.h +++ b/vnet/vnet/vnet_all_api_h.h @@ -34,6 +34,7 @@ #include #include #include +#include /* * fd.io coding-style-patch-verification: ON -- cgit 1.2.3-korg