Line data    Source code

       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             :   u8 *sock_name;
      68             :   u64 secret;
      69             :   u32 sw_if_index;
      70             :   u32 ip4_fib_id;
      71             :   u32 ip6_fib_id;
      72             :   u8 is_add;
      73             : } vnet_app_namespace_add_del_args_t;
      74             : 
      75             : #define APP_NAMESPACE_INVALID_INDEX ((u32)~0)
      76             : 
      77             : app_namespace_t *app_namespace_alloc (const u8 *ns_id);
      78             : app_namespace_t *app_namespace_get (u32 index);
      79             : app_namespace_t *app_namespace_get_from_id (const u8 *ns_id);
      80             : u32 app_namespace_index (app_namespace_t * app_ns);
      81             : const u8 *app_namespace_id (app_namespace_t * app_ns);
      82             : const u8 *app_namespace_id_from_index (u32 index);
      83             : u32 app_namespace_index_from_id (const u8 *ns_id);
      84             : void app_namespaces_init (void);
      85             : int vnet_app_namespace_add_del (vnet_app_namespace_add_del_args_t * a);
      86             : u32 app_namespace_get_fib_index (app_namespace_t * app_ns, u8 fib_proto);
      87             : session_table_t *app_namespace_get_local_table (app_namespace_t * app_ns);
      88             : 
      89             : always_inline app_namespace_t *
      90           2 : app_namespace_get_default (void)
      91             : {
      92           2 :   return app_namespace_get (0);
      93             : }
      94             : 
      95             : typedef struct app_ns_api_handle_
      96             : {
      97             :   union
      98             :   {
      99             :     struct
     100             :     {
     101             :       /** app_ns index for files and app_index for sockets */
     102             :       u32 l_index;
     103             :       /** socket index for files and clib file index for sockets */
     104             :       u32 u_index;
     105             :     };
     106             :     u64 as_u64;
     107             :   };
     108             : #define aah_app_ns_index l_index
     109             : #define aah_app_wrk_index l_index
     110             : #define aah_sock_index u_index
     111             : #define aah_file_index u_index
     112             : } __attribute__ ((aligned (sizeof (u64)))) app_ns_api_handle_t;
     113             : 
     114             : STATIC_ASSERT (sizeof (app_ns_api_handle_t) == sizeof (u64), "not u64");
     115             : 
     116             : static inline clib_socket_t *
     117          49 : appns_sapi_alloc_socket (app_namespace_t * app_ns)
     118             : {
     119             :   clib_socket_t *cs;
     120          49 :   pool_get_zero (app_ns->app_sockets, cs);
     121          49 :   return cs;
     122             : }
     123             : 
     124             : static inline clib_socket_t *
     125          73 : appns_sapi_get_socket (app_namespace_t * app_ns, u32 sock_index)
     126             : {
     127          73 :   if (pool_is_free_index (app_ns->app_sockets, sock_index))
     128           0 :     return 0;
     129          73 :   return pool_elt_at_index (app_ns->app_sockets, sock_index);
     130             : }
     131             : 
     132             : static inline void
     133          14 : appns_sapi_free_socket (app_namespace_t * app_ns, clib_socket_t * cs)
     134             : {
     135          14 :   pool_put (app_ns->app_sockets, cs);
     136          14 : }
     137             : 
     138             : static inline u32
     139          49 : appns_sapi_socket_index (app_namespace_t * app_ns, clib_socket_t * cs)
     140             : {
     141          49 :   return (cs - app_ns->app_sockets);
     142             : }
     143             : 
     144             : static inline u32
     145          24 : appns_sapi_socket_handle (app_namespace_t * app_ns, clib_socket_t * cs)
     146             : {
     147          24 :   return app_namespace_index (app_ns) << 16 | (cs - app_ns->app_sockets);
     148             : }
     149             : 
     150             : static inline u32
     151           9 : appns_sapi_handle_sock_index (u32 sapi_sock_handle)
     152             : {
     153           9 :   return sapi_sock_handle & 0xffff;
     154             : }
     155             : 
     156             : int appns_sapi_add_ns_socket (app_namespace_t * app_ns);
     157             : void appns_sapi_del_ns_socket (app_namespace_t *app_ns);
     158             : u8 appns_sapi_enabled (void);
     159             : int appns_sapi_enable_disable (int is_enable);
     160             : 
     161             : #endif /* SRC_VNET_SESSION_APPLICATION_NAMESPACE_H_ */
     162             : 
     163             : /*
     164             :  * fd.io coding-style-patch-verification: ON
     165             :  *
     166             :  * Local Variables:
     167             :  * eval: (c-set-style "gnu")
     168             :  * End:
     169             :  */