FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
application_namespace.h
Go to the documentation of this file.
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>
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  */
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  * Linux netns if one was provided
55  */
56  u8 *netns;
57 
58  /**
59  * Name of socket applications can use to attach to session layer
60  */
61  u8 *sock_name;
62 
63  /**
64  * Pool of active application sockets
65  */
66  clib_socket_t *app_sockets;
68 
69 typedef struct _vnet_app_namespace_add_del_args
70 {
71  u8 *ns_id;
72  u8 *netns;
73  u8 *sock_name;
74  u64 secret;
76  u32 ip4_fib_id;
77  u32 ip6_fib_id;
78  u8 is_add;
80 
81 #define APP_NAMESPACE_INVALID_INDEX ((u32)~0)
82 
83 app_namespace_t *app_namespace_alloc (const u8 *ns_id);
87 const u8 *app_namespace_id (app_namespace_t * app_ns);
89 u32 app_namespace_index_from_id (const u8 *ns_id);
90 void app_namespaces_init (void);
94 
97 {
98  return app_namespace_get (0);
99 }
100 
101 typedef struct app_ns_api_handle_
102 {
103  union
104  {
105  struct
106  {
107  /** app_ns index for files and app_index for sockets */
109  /** socket index for files and clib file index for sockets */
111  };
113  };
114 #define aah_app_ns_index l_index
115 #define aah_app_wrk_index l_index
116 #define aah_sock_index u_index
117 #define aah_file_index u_index
118 } __attribute__ ((aligned (sizeof (u64)))) app_ns_api_handle_t;
119 
120 STATIC_ASSERT (sizeof (app_ns_api_handle_t) == sizeof (u64), "not u64");
121 
122 static inline clib_socket_t *
124 {
125  clib_socket_t *cs;
126  pool_get_zero (app_ns->app_sockets, cs);
127  return cs;
128 }
129 
130 static inline clib_socket_t *
132 {
133  if (pool_is_free_index (app_ns->app_sockets, sock_index))
134  return 0;
135  return pool_elt_at_index (app_ns->app_sockets, sock_index);
136 }
137 
138 static inline void
140 {
141  pool_put (app_ns->app_sockets, cs);
142 }
143 
144 static inline u32
146 {
147  return (cs - app_ns->app_sockets);
148 }
149 
150 static inline u32
152 {
153  return app_namespace_index (app_ns) << 16 | (cs - app_ns->app_sockets);
154 }
155 
156 static inline u32
158 {
159  return sapi_sock_handle & 0xffff;
160 }
161 
164 u8 appns_sapi_enabled (void);
165 void appns_sapi_enable (void);
166 
167 #endif /* SRC_VNET_SESSION_APPLICATION_NAMESPACE_H_ */
168 
169 /*
170  * fd.io coding-style-patch-verification: ON
171  *
172  * Local Variables:
173  * eval: (c-set-style "gnu")
174  * End:
175  */
app_namespaces_init
void app_namespaces_init(void)
Definition: application_namespace.c:238
app_ns_api_handle_t
struct app_ns_api_handle_ app_ns_api_handle_t
appns_sapi_enabled
u8 appns_sapi_enabled(void)
Definition: application_namespace.c:232
STATIC_ASSERT
STATIC_ASSERT(sizeof(app_ns_api_handle_t)==sizeof(u64), "not u64")
vnet_app_namespace_add_del_args_t
struct _vnet_app_namespace_add_del_args vnet_app_namespace_add_del_args_t
app_namespace_id_from_index
const u8 * app_namespace_id_from_index(u32 index)
Definition: application_namespace.c:204
pool_elt_at_index
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:549
app_namespace_t
struct _app_namespace app_namespace_t
app_namespace_alloc
app_namespace_t * app_namespace_alloc(const u8 *ns_id)
Definition: application_namespace.c:68
appns_sapi_enable
void appns_sapi_enable(void)
Definition: application_namespace.c:226
appns_sapi_add_ns_socket
int appns_sapi_add_ns_socket(app_namespace_t *app_ns)
Definition: session_api.c:1783
pool_put
#define pool_put(P, E)
Free an object E in pool P.
Definition: pool.h:305
appns_sapi_get_socket
static clib_socket_t * appns_sapi_get_socket(app_namespace_t *app_ns, u32 sock_index)
Definition: application_namespace.h:131
app_ns_api_handle_
Definition: application_namespace.h:101
app_namespace_get
app_namespace_t * app_namespace_get(u32 index)
Definition: application_namespace.c:38
appns_sapi_socket_index
static u32 appns_sapi_socket_index(app_namespace_t *app_ns, clib_socket_t *cs)
Definition: application_namespace.h:145
pool_is_free_index
#define pool_is_free_index(P, I)
Use free bitmap to query whether given index is free.
Definition: pool.h:302
appns_sapi_del_ns_socket
void appns_sapi_del_ns_socket(app_namespace_t *app_ns)
Definition: session_api.c:1766
appns_sapi_alloc_socket
static clib_socket_t * appns_sapi_alloc_socket(app_namespace_t *app_ns)
Definition: application_namespace.h:123
app_ns_api_handle_::l_index
u32 l_index
app_ns index for files and app_index for sockets
Definition: application_namespace.h:108
app_namespace_get_default
static app_namespace_t * app_namespace_get_default(void)
Definition: application_namespace.h:96
app_namespace_index
u32 app_namespace_index(app_namespace_t *app_ns)
Definition: application_namespace.c:53
app_namespace_get_fib_index
u32 app_namespace_get_fib_index(app_namespace_t *app_ns, u8 fib_proto)
Definition: application_namespace.c:213
appns_sapi_handle_sock_index
static u32 appns_sapi_handle_sock_index(u32 sapi_sock_handle)
Definition: application_namespace.h:157
index
u32 index
Definition: flow_types.api:221
always_inline
#define always_inline
Definition: rdma_mlx5dv.h:23
u64
unsigned long u64
Definition: types.h:89
u32
unsigned int u32
Definition: types.h:88
appns_sapi_socket_handle
static u32 appns_sapi_socket_handle(app_namespace_t *app_ns, clib_socket_t *cs)
Definition: application_namespace.h:151
app_namespace_get_local_table
session_table_t * app_namespace_get_local_table(app_namespace_t *app_ns)
Definition: application_namespace.c:220
appns_sapi_free_socket
static void appns_sapi_free_socket(app_namespace_t *app_ns, clib_socket_t *cs)
Definition: application_namespace.h:139
app_namespace_index_from_id
u32 app_namespace_index_from_id(const u8 *ns_id)
Definition: application_namespace.c:188
app_ns_api_handle_::as_u64
u64 as_u64
Definition: application_namespace.h:112
vnet_app_namespace_add_del
int vnet_app_namespace_add_del(vnet_app_namespace_add_del_args_t *a)
Definition: application_namespace.c:85
app_namespace_id
const u8 * app_namespace_id(app_namespace_t *app_ns)
Definition: application_namespace.c:182
pool_get_zero
#define pool_get_zero(P, E)
Allocate an object E from a pool P and zero it.
Definition: pool.h:258
u8
unsigned char u8
Definition: types.h:56
a
a
Definition: bitmap.h:525
session_table.h
socket.h
vnet.h
clib_socket_t
struct _socket_t clib_socket_t
app_namespace_get_from_id
app_namespace_t * app_namespace_get_from_id(const u8 *ns_id)
Definition: application_namespace.c:44
sw_if_index
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
app_ns_api_handle_::u_index
u32 u_index
socket index for files and clib file index for sockets
Definition: application_namespace.h:110
session_table_t
struct _session_lookup_table session_table_t