src/vnet/ip/punt.h

   1 /*
   2  * Copyright (c) 2016 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
  16 /**
  17  * @file
  18  * @brief Definitions for punt infrastructure.
  19  */
  20 #ifndef included_punt_h
  21 #define included_punt_h
  22
  23 #include <linux/un.h>
  24 #include <stdbool.h>
  25 #include <vnet/ip/ip.h>
  26
  27 #define foreach_punt_type                       \
  28   _(L4, "l4")                                   \
  29   _(EXCEPTION, "exception")                     \
  30   _(IP_PROTO, "ip-proto")
  31
  32 typedef enum punt_type_t_
  33 {
  34 #define _(v, s) PUNT_TYPE_##v,
  35   foreach_punt_type
  36 #undef _
  37 } punt_type_t;
  38
  39 typedef struct punt_l4_t_
  40 {
  41   ip_address_family_t af;
  42   ip_protocol_t protocol;
  43   u16 port;
  44 } punt_l4_t;
  45
  46 typedef struct punt_ip_proto_t_
  47 {
  48   ip_address_family_t af;
  49   ip_protocol_t protocol;
  50 } punt_ip_proto_t;
  51
  52 typedef struct punt_exception_t_
  53 {
  54   vlib_punt_reason_t reason;
  55 } punt_exception_t;
  56
  57 typedef struct punt_union_t_
  58 {
  59   punt_exception_t exception;
  60   punt_l4_t l4;
  61   punt_ip_proto_t ip_proto;
  62 } punt_union_t;
  63
  64 typedef struct punt_reg_t_
  65 {
  66   punt_type_t type;
  67   punt_union_t punt;
  68 } punt_reg_t;
  69
  70
  71 clib_error_t *vnet_punt_add_del (vlib_main_t * vm,
  72                                  const punt_reg_t * pr, bool is_add);
  73 clib_error_t *vnet_punt_socket_add (vlib_main_t * vm,
  74                                     u32 header_version,
  75                                     const punt_reg_t * pr,
  76                                     char *client_pathname);
  77 clib_error_t *vnet_punt_socket_del (vlib_main_t * vm, const punt_reg_t * pr);
  78 char *vnet_punt_get_server_pathname (void);
  79
  80 enum punt_action_e
  81 {
  82   PUNT_L2 = 0,
  83   PUNT_IP4_ROUTED,
  84   PUNT_IP6_ROUTED,
  85 };
  86
  87 /*
  88  * Packet descriptor header. Version 1
  89  * If this header changes, the version must also change to notify clients.
  90  */
  91 #define PUNT_PACKETDESC_VERSION 1
  92 typedef struct __attribute__ ((packed))
  93 {
  94   u32 sw_if_index;              /* RX or TX interface */
  95   enum punt_action_e action;
  96 } punt_packetdesc_t;
  97
  98 /*
  99  * Client registration
 100  */
 101 typedef struct
 102 {
 103   punt_reg_t reg;
 104   struct sockaddr_un caddr;
 105 } punt_client_t;
 106
 107 typedef struct punt_client_db_t_
 108 {
 109   void *clients_by_l4_port;
 110   u32 *clients_by_exception;
 111   void *clients_by_ip_proto;
 112 } punt_client_db_t;
 113
 114 typedef struct
 115 {
 116   int socket_fd;
 117   char sun_path[sizeof (struct sockaddr_un)];
 118   punt_client_db_t db;
 119   punt_client_t *punt_client_pool;
 120   u32 clib_file_index;
 121   bool is_configured;
 122   vlib_node_t *interface_output_node;
 123   u32 *ready_fds;
 124   u32 *rx_buffers;
 125   vlib_punt_hdl_t hdl;
 126 } punt_main_t;
 127
 128 extern punt_main_t punt_main;
 129
 130 typedef walk_rc_t (*punt_client_walk_cb_t) (const punt_client_t * pc,
 131                                             void *ctx);
 132 extern void punt_client_walk (punt_type_t pt,
 133                               punt_client_walk_cb_t cb, void *ctx);
 134
 135 /*
 136  * inlines for the data-plane
 137  */
 138 static_always_inline u32
 139 punt_client_l4_mk_key (ip_address_family_t af, u16 port)
 140 {
 141   return (af << BITS (port) | port);
 142 }
 143
 144 static_always_inline punt_client_t *
 145 punt_client_l4_get (ip_address_family_t af, u16 port)
 146 {
 147   punt_main_t *pm = &punt_main;
 148   uword *p;
 149
 150   p = hash_get (pm->db.clients_by_l4_port, punt_client_l4_mk_key (af, port));
 151
 152   if (p)
 153     return (pool_elt_at_index (pm->punt_client_pool, p[0]));
 154
 155   return (NULL);
 156 }
 157
 158 static_always_inline u32
 159 punt_client_ip_proto_mk_key (ip_address_family_t af, ip_protocol_t proto)
 160 {
 161   return (af << 16 | proto);
 162 }
 163
 164 static_always_inline punt_client_t *
 165 punt_client_ip_proto_get (ip_address_family_t af, ip_protocol_t proto)
 166 {
 167   punt_main_t *pm = &punt_main;
 168   uword *p;
 169
 170   p =
 171     hash_get (pm->db.clients_by_ip_proto,
 172               punt_client_ip_proto_mk_key (af, proto));
 173
 174   if (p)
 175     return (pool_elt_at_index (pm->punt_client_pool, p[0]));
 176
 177   return (NULL);
 178 }
 179
 180 static_always_inline punt_client_t *
 181 punt_client_exception_get (vlib_punt_reason_t reason)
 182 {
 183   punt_main_t *pm = &punt_main;
 184   u32 pci;
 185
 186   if (reason >= vec_len (pm->db.clients_by_exception))
 187     return (NULL);
 188
 189   pci = pm->db.clients_by_exception[reason];
 190
 191   if (~0 != pci)
 192     return (pool_elt_at_index (pm->punt_client_pool, pci));
 193
 194   return (NULL);
 195 }
 196
 197 extern vlib_node_registration_t udp4_punt_node;
 198 extern vlib_node_registration_t udp6_punt_node;
 199 extern vlib_node_registration_t udp4_punt_socket_node;
 200 extern vlib_node_registration_t udp6_punt_socket_node;
 201 extern vlib_node_registration_t ip4_proto_punt_socket_node;
 202 extern vlib_node_registration_t ip6_proto_punt_socket_node;
 203 extern vlib_node_registration_t punt_socket_rx_node;
 204
 205 #endif
 206
 207 /*
 208  * fd.io coding-style-patch-verification: ON
 209  *
 210  * Local Variables:
 211  * eval: (c-set-style "gnu")
 212  * End:
 213  */