src/vnet/session/application_namespace.h

   1 /*
   2  * Copyright (c) 2017-2019 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 #include <vppinfra/socket.h>
  17 #include <vnet/vnet.h>
  18 #include <vnet/session/session_table.h>
  19
  20 #ifndef SRC_VNET_SESSION_APPLICATION_NAMESPACE_H_
  21 #define SRC_VNET_SESSION_APPLICATION_NAMESPACE_H_
  22
  23 typedef struct _app_namespace
  24 {
  25   /**
  26    * Local sw_if_index that supports transport connections for this namespace
  27    */
  28   u32 sw_if_index;
  29
  30   /**
  31    * Network namespace (e.g., fib_index associated to the sw_if_index)
  32    * wherein connections are to be established. Since v4 and v6 fibs are
  33    * separate, we actually need to keep pointers to both.
  34    */
  35   u32 ip4_fib_index;
  36   u32 ip6_fib_index;
  37
  38   /**
  39    * Local session table associated to ns
  40    */
  41   u32 local_table_index;
  42
  43   /**
  44    * Secret apps need to provide to authorize attachment to the namespace
  45    */
  46   u64 ns_secret;
  47
  48   /**
  49    * Application namespace id
  50    */
  51   u8 *ns_id;
  52
  53   /**
  54    * Name of socket applications can use to attach to session layer
  55    */
  56   u8 *sock_name;
  57
  58   /**
  59    * Pool of active application sockets
  60    */
  61   clib_socket_t *app_sockets;
  62 } app_namespace_t;
  63
  64 typedef struct _vnet_app_namespace_add_del_args
  65 {
  66   u8 *ns_id;
  67   u64 secret;
  68   u32 sw_if_index;
  69   u32 ip4_fib_id;
  70   u32 ip6_fib_id;
  71   u8 is_add;
  72 } vnet_app_namespace_add_del_args_t;
  73
  74 #define APP_NAMESPACE_INVALID_INDEX ((u32)~0)
  75
  76 app_namespace_t *app_namespace_alloc (u8 * ns_id);
  77 app_namespace_t *app_namespace_get (u32 index);
  78 app_namespace_t *app_namespace_get_from_id (const u8 * ns_id);
  79 u32 app_namespace_index (app_namespace_t * app_ns);
  80 const u8 *app_namespace_id (app_namespace_t * app_ns);
  81 const u8 *app_namespace_id_from_index (u32 index);
  82 u32 app_namespace_index_from_id (const u8 * ns_id);
  83 void app_namespaces_init (void);
  84 int vnet_app_namespace_add_del (vnet_app_namespace_add_del_args_t * a);
  85 u32 app_namespace_get_fib_index (app_namespace_t * app_ns, u8 fib_proto);
  86 session_table_t *app_namespace_get_local_table (app_namespace_t * app_ns);
  87
  88 always_inline app_namespace_t *
  89 app_namespace_get_default (void)
  90 {
  91   return app_namespace_get (0);
  92 }
  93
  94 typedef struct app_ns_api_handle_
  95 {
  96   union
  97   {
  98     struct
  99     {
 100       /** app_ns index for files and app_index for sockets */
 101       u32 l_index;
 102       /** socket index for files and clib file index for sockets */
 103       u32 u_index;
 104     };
 105     uword as_uword;
 106   };
 107 #define aah_app_ns_index l_index
 108 #define aah_app_wrk_index l_index
 109 #define aah_sock_index u_index
 110 #define aah_file_index u_index
 111 } __attribute__ ((aligned (sizeof (uword)))) app_ns_api_handle_t;
 112
 113 STATIC_ASSERT (sizeof (app_ns_api_handle_t) == sizeof (uword), "not uword");
 114
 115 static inline clib_socket_t *
 116 appns_sapi_alloc_socket (app_namespace_t * app_ns)
 117 {
 118   clib_socket_t *cs;
 119   pool_get_zero (app_ns->app_sockets, cs);
 120   return cs;
 121 }
 122
 123 static inline clib_socket_t *
 124 appns_sapi_get_socket (app_namespace_t * app_ns, u32 sock_index)
 125 {
 126   if (pool_is_free_index (app_ns->app_sockets, sock_index))
 127     return 0;
 128   return pool_elt_at_index (app_ns->app_sockets, sock_index);
 129 }
 130
 131 static inline void
 132 appns_sapi_free_socket (app_namespace_t * app_ns, clib_socket_t * cs)
 133 {
 134   pool_put (app_ns->app_sockets, cs);
 135 }
 136
 137 static inline u32
 138 appns_sapi_socket_index (app_namespace_t * app_ns, clib_socket_t * cs)
 139 {
 140   return (cs - app_ns->app_sockets);
 141 }
 142
 143 static inline u32
 144 appns_sapi_socket_handle (app_namespace_t * app_ns, clib_socket_t * cs)
 145 {
 146   return app_namespace_index (app_ns) << 16 | (cs - app_ns->app_sockets);
 147 }
 148
 149 static inline u32
 150 appns_sapi_handle_sock_index (u32 sapi_sock_handle)
 151 {
 152   return sapi_sock_handle & 0xffff;
 153 }
 154
 155 int appns_sapi_add_ns_socket (app_namespace_t * app_ns);
 156 u8 appns_sapi_enabled (void);
 157 void appns_sapi_enable (void);
 158
 159 #endif /* SRC_VNET_SESSION_APPLICATION_NAMESPACE_H_ */
 160
 161 /*
 162  * fd.io coding-style-patch-verification: ON
 163  *
 164  * Local Variables:
 165  * eval: (c-set-style "gnu")
 166  * End:
 167  */