src/plugins/nat/pnat/pnat_api.c

   1 /*
   2  * Copyright (c) 2021 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #include "pnat.h"
  16 #include <vnet/vnet.h>
  17 #include <pnat/pnat.api_enum.h>
  18 #include <pnat/pnat.api_types.h>
  19 #include <vlibmemory/api.h>
  20 #include <vnet/fib/fib_table.h>
  21 #include <vnet/ip/ip.h>
  22 #include <vnet/ip/ip_types_api.h>
  23 #include <vnet/ip/reass/ip4_sv_reass.h>
  24 #include <vnet/ip/reass/ip6_full_reass.h>
  25 #include <vnet/ip/reass/ip6_sv_reass.h>
  26 #include <vpp/app/version.h>
  27
  28 /*
  29  * This file contains the API handlers for the pnat.api
  30  */
  31
  32 #define REPLY_MSG_ID_BASE pm->msg_id_base
  33 #include <vlibapi/api_helper_macros.h>
  34
  35 static void vl_api_pnat_binding_add_t_handler(vl_api_pnat_binding_add_t *mp) {
  36     pnat_main_t *pm = &pnat_main;
  37     vl_api_pnat_binding_add_reply_t *rmp;
  38     u32 binding_index;
  39     int rv = pnat_binding_add(&mp->match, &mp->rewrite, &binding_index);
  40     REPLY_MACRO2_END(VL_API_PNAT_BINDING_ADD_REPLY,
  41                      ({ rmp->binding_index = binding_index; }));
  42 }
  43
  44 static void
  45 vl_api_pnat_binding_attach_t_handler(vl_api_pnat_binding_attach_t *mp) {
  46     pnat_main_t *pm = &pnat_main;
  47     vl_api_pnat_binding_attach_reply_t *rmp;
  48     int rv;
  49
  50     VALIDATE_SW_IF_INDEX_END(mp);
  51
  52     rv =
  53         pnat_binding_attach(mp->sw_if_index, mp->attachment, mp->binding_index);
  54
  55 bad_sw_if_index:
  56     REPLY_MACRO_END(VL_API_PNAT_BINDING_ATTACH_REPLY);
  57 }
  58
  59 static void
  60 vl_api_pnat_binding_detach_t_handler(vl_api_pnat_binding_detach_t *mp) {
  61     pnat_main_t *pm = &pnat_main;
  62     vl_api_pnat_binding_detach_reply_t *rmp;
  63     int rv;
  64
  65     VALIDATE_SW_IF_INDEX_END(mp);
  66
  67     rv =
  68         pnat_binding_detach(mp->sw_if_index, mp->attachment, mp->binding_index);
  69
  70 bad_sw_if_index:
  71     REPLY_MACRO_END(VL_API_PNAT_BINDING_DETACH_REPLY);
  72 }
  73
  74 static void vl_api_pnat_binding_del_t_handler(vl_api_pnat_binding_del_t *mp) {
  75     pnat_main_t *pm = &pnat_main;
  76     vl_api_pnat_binding_del_reply_t *rmp;
  77     int rv = pnat_binding_del(mp->binding_index);
  78     REPLY_MACRO_END(VL_API_PNAT_BINDING_DEL_REPLY);
  79 }
  80
  81 /*
  82  * Workaround for a bug in vppapigen that doesn't register the endian handler
  83  * for _details messages. When that's fixed it should be possible to use
  84  * REPLY_MACRO_DETAILS4_END and not have to care about endian-ness in the
  85  * handler itself.
  86  */
  87 #define vl_endianfun
  88 #include <pnat/pnat.api.h>
  89 #undef vl_endianfun
  90 static void send_bindings_details(u32 index, vl_api_registration_t *rp,
  91                                   u32 context) {
  92     pnat_main_t *pm = &pnat_main;
  93     vl_api_pnat_bindings_details_t *rmp;
  94     pnat_translation_t *t = pool_elt_at_index(pm->translations, index);
  95
  96     /* Make sure every field is initiated (or don't skip the clib_memset()) */
  97
  98     REPLY_MACRO_DETAILS4(VL_API_PNAT_BINDINGS_DETAILS, rp, context, ({
  99                              rmp->match = t->match;
 100                              rmp->rewrite = t->rewrite;
 101
 102                              /* Endian hack until apigen registers _details
 103                               * endian functions */
 104                              vl_api_pnat_bindings_details_t_endian(rmp);
 105                              rmp->_vl_msg_id = htons(rmp->_vl_msg_id);
 106                              rmp->context = htonl(rmp->context);
 107                          }));
 108 }
 109
 110 static void vl_api_pnat_bindings_get_t_handler(vl_api_pnat_bindings_get_t *mp) {
 111     pnat_main_t *pm = &pnat_main;
 112     vl_api_pnat_bindings_get_reply_t *rmp;
 113
 114     i32 rv = 0;
 115
 116     if (pool_elts(pm->translations) == 0) {
 117         REPLY_MACRO(VL_API_PNAT_BINDINGS_GET_REPLY);
 118         return;
 119     }
 120
 121     /*
 122      * "cursor" comes from the get call, and allows client to continue a dump
 123      */
 124     REPLY_AND_DETAILS_MACRO(VL_API_PNAT_BINDINGS_GET_REPLY, pm->translations, ({
 125                                 send_bindings_details(cursor, rp, mp->context);
 126                             }));
 127 }
 128
 129 static void send_interfaces_details(u32 index, vl_api_registration_t *rp,
 130                                     u32 context) {
 131     pnat_main_t *pm = &pnat_main;
 132     vl_api_pnat_interfaces_details_t *rmp;
 133     pnat_interface_t *i = pool_elt_at_index(pm->interfaces, index);
 134
 135     /* Make sure every field is initiated (or don't skip the clib_memset()) */
 136
 137     REPLY_MACRO_DETAILS4(
 138         VL_API_PNAT_INTERFACES_DETAILS, rp, context, ({
 139             rmp->sw_if_index = i->sw_if_index;
 140             clib_memcpy(rmp->enabled, i->enabled, sizeof(rmp->enabled));
 141             clib_memcpy(rmp->lookup_mask, i->lookup_mask,
 142                         sizeof(rmp->lookup_mask));
 143
 144             /* Endian hack until apigen registers _details
 145              * endian functions */
 146             vl_api_pnat_interfaces_details_t_endian(rmp);
 147             rmp->_vl_msg_id = htons(rmp->_vl_msg_id);
 148             rmp->context = htonl(rmp->context);
 149         }));
 150 }
 151
 152 static void
 153 vl_api_pnat_interfaces_get_t_handler(vl_api_pnat_interfaces_get_t *mp) {
 154     pnat_main_t *pm = &pnat_main;
 155     vl_api_pnat_interfaces_get_reply_t *rmp;
 156
 157     i32 rv = 0;
 158
 159     if (pool_elts(pm->interfaces) == 0) {
 160         REPLY_MACRO(VL_API_PNAT_INTERFACES_GET_REPLY);
 161         return;
 162     }
 163
 164     /*
 165      * "cursor" comes from the get call, and allows client to continue a dump
 166      */
 167     REPLY_AND_DETAILS_MACRO(
 168         VL_API_PNAT_INTERFACES_GET_REPLY, pm->interfaces,
 169         ({ send_interfaces_details(cursor, rp, mp->context); }));
 170 }
 171
 172 /* API definitions */
 173 #include <vnet/format_fns.h>
 174 #include <pnat/pnat.api.c>
 175
 176 /* Set up the API message handling tables */
 177 clib_error_t *pnat_plugin_api_hookup(vlib_main_t *vm) {
 178     pnat_main_t *pm = &pnat_main;
 179
 180     pm->msg_id_base = setup_message_id_table();
 181
 182     return 0;
 183 }
 184
 185 /*
 186  * Register the plugin and hook up the API
 187  */
 188 #include <vnet/plugin/plugin.h>
 189 VLIB_PLUGIN_REGISTER() = {
 190     .version = VPP_BUILD_VER,
 191     .description = "Policy 1:1 NAT",
 192 };
 193
 194 clib_error_t *pnat_init(vlib_main_t *vm) {
 195     pnat_main_t *pm = &pnat_main;
 196     memset(pm, 0, sizeof(*pm));
 197
 198     return pnat_plugin_api_hookup(vm);
 199 }
 200
 201 VLIB_INIT_FUNCTION(pnat_init);