FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
application.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 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 #ifndef SRC_VNET_SESSION_APPLICATION_H_
17 #define SRC_VNET_SESSION_APPLICATION_H_
18 
19 #include <vnet/vnet.h>
20 #include <vnet/session/session.h>
23 typedef enum
24 {
29 
30 typedef struct _stream_session_cb_vft
31 {
32  /** Notify server of new segment */
33  int (*add_segment_callback) (u32 api_client_index, const u8 * seg_name,
34  u32 seg_size);
35 
36  /** Notify server of newly accepted session */
37  int (*session_accept_callback) (stream_session_t * new_session);
38 
39  /** Connection request callback */
40  int (*session_connected_callback) (u32 app_index, u32 opaque,
41  stream_session_t * s, u8 code);
42 
43  /** Notify app that session is closing */
44  void (*session_disconnect_callback) (stream_session_t * s);
45 
46  /** Notify app that session was reset */
47  void (*session_reset_callback) (stream_session_t * s);
48 
49  /** Direct RX callback, for built-in servers */
51 
52  /** Redirect connection to local server */
53  int (*redirect_connect_callback) (u32 api_client_index, void *mp);
55 
56 typedef struct _application
57 {
58  /** Index in server pool */
59  u32 index;
60 
61  /** Flags */
62  u32 flags;
63 
64  /*
65  * Binary API interface to external app
66  */
67 
68  /** Binary API connection index, ~0 if internal */
69  u32 api_client_index;
70 
71  /** Namespace the application belongs to */
72  u32 ns_index;
73 
74  /** Application listens for events on this svm queue */
75  unix_shared_memory_queue_t *event_queue;
76 
77  /*
78  * Callbacks: shoulder-taps for the server/client
79  */
80 
81  session_cb_vft_t cb_fns;
82 
83  /*
84  * svm segment management
85  */
86  u32 connects_seg_manager;
87 
88  /** Lookup tables for listeners. Value is segment manager index */
89  uword *listeners_table;
90 
91  /**
92  * First segment manager has in the the first segment the application's
93  * event fifo. Depending on what the app does, it may be either used for
94  * a listener or for connects.
95  */
96  u32 first_segment_manager;
97  u8 first_segment_manager_in_use;
98 
99  /** Segment manager properties. Shared by all segment managers */
100  u32 sm_properties;
101 
102  u16 proxied_transports;
103 } application_t;
104 
105 #define APP_INVALID_INDEX ((u32)~0)
106 #define APP_DROP_INDEX (((u32)~0) - 1)
107 #define APP_NS_INVALID_INDEX ((u32)~0)
108 #define APP_INVALID_SEGMENT_MANAGER_INDEX ((u32) ~0)
109 
111 int application_init (application_t * app, u32 api_client_index,
112  u64 * options, session_cb_vft_t * cb_fns);
113 void application_del (application_t * app);
116 application_t *application_lookup (u32 api_client_index);
118 
120  session_endpoint_t * tep, u64 * handle);
121 int application_stop_listen (application_t * srv, u64 handle);
123  u32 api_context);
125 
127  app,
129  s);
131  app);
135 int application_add_segment_notify (u32 app_index, u32 fifo_segment_index);
136 u32 application_session_table (application_t * app, u8 fib_proto);
139 
144  u8 fib_proto,
145  u8 transport_proto);
148 
149 #endif /* SRC_VNET_SESSION_APPLICATION_H_ */
150 
151 /*
152  * fd.io coding-style-patch-verification: ON
153  *
154  * Local Variables:
155  * eval: (c-set-style "gnu")
156  * End:
157  */
segment_manager_t * application_get_listen_segment_manager(application_t *app, stream_session_t *s)
Definition: application.c:450
application_t * application_get_if_valid(u32 index)
Definition: application.c:305
int application_start_listen(application_t *app, session_endpoint_t *tep, u64 *handle)
Start listening local transport endpoint for requested transport.
Definition: application.c:347
void application_remove_proxy(application_t *app)
Definition: application.c:670
u32 application_n_listeners(application_t *app)
Definition: application.c:505
application_t * application_lookup(u32 api_client_index)
Definition: application.c:122
application_type_t
Definition: application.h:23
struct _stream_session_cb_vft session_cb_vft_t
unsigned long u64
Definition: types.h:89
struct _stream_session_t stream_session_t
application_t * application_new()
Definition: application.c:133
struct _session_endpoint session_endpoint_t
int application_is_builtin(application_t *app)
Definition: application.c:466
stream_session_t * application_first_listener(application_t *app, u8 fib_proto, u8 transport_proto)
Definition: application.c:511
segment_manager_t * application_get_connect_segment_manager(application_t *app)
Definition: application.c:443
u32 application_get_index(application_t *app)
Definition: application.c:314
static int redirect_connect_callback(u32 server_api_client_index, void *mp_arg)
Redirect a connect_uri message to the indicated server.
Definition: session_api.c:221
struct _application application_t
int application_add_segment_notify(u32 app_index, u32 fifo_segment_index)
Definition: application.c:478
u8 * application_name_from_index(u32 app_index)
Returns app name.
Definition: application.c:101
int application_init(application_t *app, u32 api_client_index, u64 *options, session_cb_vft_t *cb_fns)
Definition: application.c:231
int application_open_session(application_t *app, session_endpoint_t *tep, u32 api_context)
Definition: application.c:421
u8 application_has_global_scope(application_t *app)
Definition: application.c:499
unsigned int u32
Definition: types.h:88
application_t * application_get(u32 index)
Definition: application.c:297
int builtin_server_rx_callback(stream_session_t *s)
int application_is_proxy(application_t *app)
Definition: application.c:460
u32 application_session_table(application_t *app, u8 fib_proto)
Definition: application.c:52
static int app_index
u64 uword
Definition: types.h:112
u32 application_local_session_table(application_t *app)
Definition: application.c:67
unsigned short u16
Definition: types.h:57
unsigned char u8
Definition: types.h:56
struct _segment_manager segment_manager_t
u8 application_has_local_scope(application_t *app)
Definition: application.c:493
int application_is_builtin_proxy(application_t *app)
Definition: application.c:472
int application_api_queue_is_full(application_t *app)
Definition: application.c:77
u32 flags
Definition: vhost-user.h:77
void application_setup_proxy(application_t *app)
Definition: application.c:652
void application_del(application_t *app)
Definition: application.c:147
int application_stop_listen(application_t *srv, u64 handle)
Stop listening on session associated to handle.
Definition: application.c:385
struct _unix_shared_memory_queue unix_shared_memory_queue_t