FD.io VPP  v18.01-8-g0eacf49
Vector Packet Processing
application_interface.h
Go to the documentation of this file.
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 #ifndef __included_uri_h__
16 #define __included_uri_h__
17 
18 #include <vlib/vlib.h>
19 #include <vnet/vnet.h>
20 #include <svm/svm_fifo_segment.h>
21 #include <vnet/session/session.h>
23 #include <vnet/session/transport.h>
24 
25 typedef struct _vnet_app_attach_args_t
26 {
27  /** Binary API client index */
28  u32 api_client_index;
29 
30  /** Application and segment manager options */
31  u64 *options;
32 
33  /* Namespace id */
34  u8 *namespace_id;
35 
36  /** Session to application callback functions */
38 
39  /*
40  * Results
41  */
42  u8 *segment_name;
43  u32 segment_name_length;
44  u32 segment_size;
45  u64 app_event_queue_address;
46  u32 app_index;
48 
49 typedef struct _vnet_app_detach_args_t
50 {
51  u32 app_index;
53 
54 typedef struct _vnet_bind_args_t
55 {
56  union
57  {
58  char *uri;
60  };
61 
62  u32 app_index;
63 
64  /*
65  * Results
66  */
67  char *segment_name;
68  u32 segment_name_length;
69  u64 server_event_queue_address;
70  u64 handle;
72 
73 typedef struct _vnet_unbind_args_t
74 {
75  union
76  {
77  char *uri;
78  u64 handle;
79  };
80  u32 app_index;
82 
83 typedef struct _vnet_connect_args
84 {
85  char *uri;
87  u32 app_index;
88  u32 api_context;
89 
90  /* Used for redirects */
91  void *mp;
94 
95 typedef struct _vnet_disconnect_args_t
96 {
97  u64 handle;
98  u32 app_index;
100 
101 /* Application attach options */
102 typedef enum
103 {
118 
119 #define foreach_app_options_flags \
120  _(ACCEPT_REDIRECT, "Use FIFO with redirects") \
121  _(ADD_SEGMENT, "Add segment and signal app if needed") \
122  _(IS_BUILTIN, "Application is builtin") \
123  _(IS_PROXY, "Application is proxying") \
124  _(USE_GLOBAL_SCOPE, "App can use global session scope") \
125  _(USE_LOCAL_SCOPE, "App can use local session scope")
126 
127 typedef enum _app_options
128 {
129 #define _(sym, str) APP_OPTIONS_##sym,
131 #undef _
132 } app_options_t;
133 
134 typedef enum _app_options_flags
135 {
136 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
138 #undef _
140 
143 
148 
152 
153 int
154 api_parse_session_handle (u64 handle, u32 * session_index,
155  u32 * thread_index);
156 
157 #endif /* __included_uri_h__ */
158 
159 /*
160  * fd.io coding-style-patch-verification: ON
161  *
162  * Local Variables:
163  * eval: (c-set-style "gnu")
164  * End:
165  */
clib_error_t * vnet_connect_uri(vnet_connect_args_t *a)
a
Definition: bitmap.h:516
struct _vnet_connect_args vnet_connect_args_t
clib_error_t * vnet_unbind(vnet_unbind_args_t *a)
clib_error_t * vnet_connect(vnet_connect_args_t *a)
struct _vnet_disconnect_args_t vnet_disconnect_args_t
struct _stream_session_cb_vft session_cb_vft_t
struct _vnet_unbind_args_t vnet_unbind_args_t
unsigned long u64
Definition: types.h:89
struct _vnet_app_attach_args_t vnet_app_attach_args_t
int api_parse_session_handle(u64 handle, u32 *session_index, u32 *thread_index)
static session_cb_vft_t session_cb_vft
Definition: session_api.c:290
int vnet_unbind_uri(vnet_unbind_args_t *a)
struct _session_endpoint session_endpoint_t
clib_error_t * vnet_bind(vnet_bind_args_t *a)
int vnet_bind_uri(vnet_bind_args_t *)
clib_error_t * vnet_application_attach(vnet_app_attach_args_t *a)
Attach application to vpp.
enum _app_options_flags app_options_flags_t
int vnet_disconnect_session(vnet_disconnect_args_t *a)
enum _app_options app_options_t
unsigned int u32
Definition: types.h:88
app_attach_options_index_t
int vnet_application_detach(vnet_app_detach_args_t *a)
Detach application from vpp.
static int app_index
struct _vnet_app_detach_args_t vnet_app_detach_args_t
static u64 session_handle(stream_session_t *s)
Definition: session.h:249
unsigned char u8
Definition: types.h:56
#define foreach_app_options_flags
struct _vnet_bind_args_t vnet_bind_args_t