FD.io VPP  v17.07.01-10-g3be13f0
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 enum _session_api_proto
26 {
30 
31 typedef struct _vnet_app_attach_args_t
32 {
33  /** Binary API client index */
34  u32 api_client_index;
35 
36  /** Application and segment manager options */
37  u64 *options;
38 
39  /** Session to application callback functions */
40  session_cb_vft_t *session_cb_vft;
41 
42  /** Flag that indicates if app is builtin */
43  u8 builtin;
44 
45  /*
46  * Results
47  */
48  u8 *segment_name;
49  u32 segment_name_length;
50  u32 segment_size;
51  u64 app_event_queue_address;
52  u32 app_index;
54 
55 typedef struct _vnet_app_detach_args_t
56 {
57  u32 app_index;
59 
60 typedef struct _vnet_bind_args_t
61 {
62  union
63  {
64  char *uri;
65  struct
66  {
68  session_api_proto_t proto;
69  };
70  };
71 
72  u32 app_index;
73 
74  /*
75  * Results
76  */
77  char *segment_name;
78  u32 segment_name_length;
79  u64 server_event_queue_address;
80  u64 handle;
82 
83 typedef struct _vnet_unbind_args_t
84 {
85  union
86  {
87  char *uri;
88  u64 handle;
89  };
90  u32 app_index;
92 
93 typedef struct _vnet_connect_args
94 {
95  union
96  {
97  char *uri;
98  struct
99  {
101  session_api_proto_t proto;
102  };
103  };
104  u32 app_index;
105  u32 api_context;
106 
107  /* Used for redirects */
108  void *mp;
110 
111 typedef struct _vnet_disconnect_args_t
112 {
113  u64 handle;
114  u32 app_index;
116 
117 /* Application attach options */
118 typedef enum
119 {
131 
132 #define foreach_app_options_flags \
133  _(USE_FIFO, "Use FIFO with redirects") \
134  _(ADD_SEGMENT, "Add segment and signal app if needed") \
135  _(BUILTIN_APP, "Application is builtin") \
136 
137 typedef enum _app_options
138 {
139 #define _(sym, str) APP_OPTIONS_##sym,
141 #undef _
142 } app_options_t;
143 
144 typedef enum _app_options_flags
145 {
146 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
148 #undef _
150 
151 ///** Server can handle delegated connect requests from local clients */
152 //#define APP_OPTIONS_FLAGS_USE_FIFO (1<<0)
153 //
154 ///** Server wants vpp to add segments when out of memory for fifos */
155 //#define APP_OPTIONS_FLAGS_ADD_SEGMENT (1<<1)
156 
157 #define VNET_CONNECT_REDIRECTED 123
158 
161 
166 
170 
171 int
172 api_parse_session_handle (u64 handle, u32 * session_index,
173  u32 * thread_index);
174 
175 #endif /* __included_uri_h__ */
176 
177 /*
178  * fd.io coding-style-patch-verification: ON
179  *
180  * Local Variables:
181  * eval: (c-set-style "gnu")
182  * End:
183  */
a
Definition: bitmap.h:516
struct _vnet_connect_args vnet_connect_args_t
int vnet_bind(vnet_bind_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)
int vnet_unbind_uri(vnet_unbind_args_t *a)
enum _session_api_proto session_api_proto_t
int vnet_bind_uri(vnet_bind_args_t *)
int vnet_application_attach(vnet_app_attach_args_t *a)
Attaches application.
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)
struct _vnet_app_detach_args_t vnet_app_detach_args_t
int vnet_connect(vnet_connect_args_t *a)
int vnet_connect_uri(vnet_connect_args_t *a)
unsigned char u8
Definition: types.h:56
struct _transport_endpoint transport_endpoint_t
#define foreach_app_options_flags
struct _vnet_bind_args_t vnet_bind_args_t
int vnet_unbind(vnet_unbind_args_t *a)