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
  40     // for backward compatibility
  41     if (mp->match.proto == 0)
  42         mp->match.mask |= PNAT_PROTO;
  43
  44     int rv = pnat_binding_add(&mp->match, &mp->rewrite, &binding_index);
  45     REPLY_MACRO2_END(VL_API_PNAT_BINDING_ADD_REPLY,
  46                      ({ rmp->binding_index = binding_index; }));
  47 }
  48
  49 static void
  50 vl_api_pnat_binding_add_v2_t_handler(vl_api_pnat_binding_add_t *mp) {
  51     pnat_main_t *pm = &pnat_main;
  52     vl_api_pnat_binding_add_reply_t *rmp;
  53     u32 binding_index;
  54     int rv = pnat_binding_add(&mp->match, &mp->rewrite, &binding_index);
  55     REPLY_MACRO2_END(VL_API_PNAT_BINDING_ADD_V2_REPLY,
  56                      ({ rmp->binding_index = binding_index; }));
  57 }
  58
  59 static void
  60 vl_api_pnat_binding_attach_t_handler(vl_api_pnat_binding_attach_t *mp) {
  61     pnat_main_t *pm = &pnat_main;
  62     vl_api_pnat_binding_attach_reply_t *rmp;
  63     int rv;
  64
  65     VALIDATE_SW_IF_INDEX_END(mp);
  66
  67     rv =
  68         pnat_binding_attach(mp->sw_if_index, mp->attachment, mp->binding_index);
  69
  70 bad_sw_if_index:
  71     REPLY_MACRO_END(VL_API_PNAT_BINDING_ATTACH_REPLY);
  72 }
  73
  74 static void
  75 vl_api_pnat_binding_detach_t_handler(vl_api_pnat_binding_detach_t *mp) {
  76     pnat_main_t *pm = &pnat_main;
  77     vl_api_pnat_binding_detach_reply_t *rmp;
  78     int rv;
  79
  80     VALIDATE_SW_IF_INDEX_END(mp);
  81
  82     rv =
  83         pnat_binding_detach(mp->sw_if_index, mp->attachment, mp->binding_index);
  84
  85 bad_sw_if_index:
  86     REPLY_MACRO_END(VL_API_PNAT_BINDING_DETACH_REPLY);
  87 }
  88
  89 static void vl_api_pnat_binding_del_t_handler(vl_api_pnat_binding_del_t *mp) {
  90     pnat_main_t *pm = &pnat_main;
  91     vl_api_pnat_binding_del_reply_t *rmp;
  92     int rv = pnat_binding_del(mp->binding_index);
  93     REPLY_MACRO_END(VL_API_PNAT_BINDING_DEL_REPLY);
  94 }
  95
  96 /*
  97  * Workaround for a bug in vppapigen that doesn't register the endian handler
  98  * for _details messages. When that's fixed it should be possible to use
  99  * REPLY_MACRO_DETAILS4_END and not have to care about endian-ness in the
 100  * handler itself.
 101  */
 102 #define vl_endianfun
 103 #include <pnat/pnat.api.h>
 104 #undef vl_endianfun
 105 static void send_bindings_details(u32 index, vl_api_registration_t *rp,
 106                                   u32 context) {
 107     pnat_main_t *pm = &pnat_main;
 108     vl_api_pnat_bindings_details_t *rmp;
 109     pnat_translation_t *t = pool_elt_at_index(pm->translations, index);
 110
 111     /* Make sure every field is initiated (or don't skip the clib_memset()) */
 112
 113     REPLY_MACRO_DETAILS4(VL_API_PNAT_BINDINGS_DETAILS, rp, context, ({
 114                              rmp->match = t->match;
 115                              rmp->rewrite = t->rewrite;
 116
 117                              /* Endian hack until apigen registers _details
 118                               * endian functions */
 119                              vl_api_pnat_bindings_details_t_endian(
 120                                  rmp, 1 /* to network */);
 121                              rmp->_vl_msg_id = htons(rmp->_vl_msg_id);
 122                              rmp->context = htonl(rmp->context);
 123                          }));
 124 }
 125
 126 static void vl_api_pnat_bindings_get_t_handler(vl_api_pnat_bindings_get_t *mp) {
 127     pnat_main_t *pm = &pnat_main;
 128     vl_api_pnat_bindings_get_reply_t *rmp;
 129
 130     i32 rv = 0;
 131
 132     if (pool_elts(pm->translations) == 0) {
 133         REPLY_MACRO(VL_API_PNAT_BINDINGS_GET_REPLY);
 134         return;
 135     }
 136
 137     /*
 138      * "cursor" comes from the get call, and allows client to continue a dump
 139      */
 140     REPLY_AND_DETAILS_MACRO(VL_API_PNAT_BINDINGS_GET_REPLY, pm->translations, ({
 141                                 send_bindings_details(cursor, rp, mp->context);
 142                             }));
 143 }
 144
 145 static void send_interfaces_details(u32 index, vl_api_registration_t *rp,
 146                                     u32 context) {
 147     pnat_main_t *pm = &pnat_main;
 148     vl_api_pnat_interfaces_details_t *rmp;
 149     pnat_interface_t *i = pool_elt_at_index(pm->interfaces, index);
 150
 151     /* Make sure every field is initiated (or don't skip the clib_memset()) */
 152
 153     REPLY_MACRO_DETAILS4(
 154         VL_API_PNAT_INTERFACES_DETAILS, rp, context, ({
 155             rmp->sw_if_index = i->sw_if_index;
 156             clib_memcpy(rmp->enabled, i->enabled, sizeof(rmp->enabled));
 157             clib_memcpy(rmp->lookup_mask, i->lookup_mask,
 158                         sizeof(rmp->lookup_mask));
 159
 160             /* Endian hack until apigen registers _details
 161              * endian functions */
 162             vl_api_pnat_interfaces_details_t_endian(rmp, 1 /* to network */);
 163             rmp->_vl_msg_id = htons(rmp->_vl_msg_id);
 164             rmp->context = htonl(rmp->context);
 165         }));
 166 }
 167
 168 static void
 169 vl_api_pnat_interfaces_get_t_handler(vl_api_pnat_interfaces_get_t *mp) {
 170     pnat_main_t *pm = &pnat_main;
 171     vl_api_pnat_interfaces_get_reply_t *rmp;
 172
 173     i32 rv = 0;
 174
 175     if (pool_elts(pm->interfaces) == 0) {
 176         REPLY_MACRO(VL_API_PNAT_INTERFACES_GET_REPLY);
 177         return;
 178     }
 179
 180     /*
 181      * "cursor" comes from the get call, and allows client to continue a dump
 182      */
 183     REPLY_AND_DETAILS_MACRO(
 184         VL_API_PNAT_INTERFACES_GET_REPLY, pm->interfaces,
 185         ({ send_interfaces_details(cursor, rp, mp->context); }));
 186 }
 187
 188 /* API definitions */
 189 #include <vnet/format_fns.h>
 190 #include <pnat/pnat.api.c>
 191
 192 /* Set up the API message handling tables */
 193 clib_error_t *pnat_plugin_api_hookup(vlib_main_t *vm) {
 194     pnat_main_t *pm = &pnat_main;
 195
 196     pm->msg_id_base = setup_message_id_table();
 197
 198     return 0;
 199 }
 200
 201 /*
 202  * Register the plugin and hook up the API
 203  */
 204 #include <vnet/plugin/plugin.h>
 205 VLIB_PLUGIN_REGISTER() = {
 206     .version = VPP_BUILD_VER,
 207     .description = "Policy 1:1 NAT",
 208 };
 209
 210 clib_error_t *pnat_init(vlib_main_t *vm) {
 211     pnat_main_t *pm = &pnat_main;
 212     memset(pm, 0, sizeof(*pm));
 213
 214     return pnat_plugin_api_hookup(vm);
 215 }
 216
 217 VLIB_INIT_FUNCTION(pnat_init);