src/vnet/session/application_interface.h

   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>
  22 #include <vnet/session/application.h>
  23 #include <vnet/session/transport.h>
  24
  25 typedef enum _session_api_proto
  26 {
  27   SESSION_PROTO_TCP,
  28   SESSION_PROTO_UDP
  29 } session_api_proto_t;
  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;
  53 } vnet_app_attach_args_t;
  54
  55 typedef struct _vnet_app_detach_args_t
  56 {
  57   u32 app_index;
  58 } vnet_app_detach_args_t;
  59
  60 typedef struct _vnet_bind_args_t
  61 {
  62   union
  63   {
  64     char *uri;
  65     struct
  66     {
  67       transport_endpoint_t tep;
  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;
  81 } vnet_bind_args_t;
  82
  83 typedef struct _vnet_unbind_args_t
  84 {
  85   union
  86   {
  87     char *uri;
  88     u64 handle;
  89   };
  90   u32 app_index;
  91 } vnet_unbind_args_t;
  92
  93 typedef struct _vnet_connect_args
  94 {
  95   union
  96   {
  97     char *uri;
  98     struct
  99     {
 100       transport_endpoint_t tep;
 101       session_api_proto_t proto;
 102     };
 103   };
 104   u32 app_index;
 105   u32 api_context;
 106
 107   /* Used for redirects */
 108   void *mp;
 109 } vnet_connect_args_t;
 110
 111 typedef struct _vnet_disconnect_args_t
 112 {
 113   u64 handle;
 114   u32 app_index;
 115 } vnet_disconnect_args_t;
 116
 117 /* Application attach options */
 118 typedef enum
 119 {
 120   APP_EVT_QUEUE_SIZE,
 121   APP_OPTIONS_FLAGS,
 122   SESSION_OPTIONS_SEGMENT_SIZE,
 123   SESSION_OPTIONS_ADD_SEGMENT_SIZE,
 124   SESSION_OPTIONS_RX_FIFO_SIZE,
 125   SESSION_OPTIONS_TX_FIFO_SIZE,
 126   SESSION_OPTIONS_ACCEPT_COOKIE,
 127   SESSION_OPTIONS_N_OPTIONS
 128 } app_attach_options_index_t;
 129
 130 #define foreach_app_options_flags                               \
 131   _(USE_FIFO, "Use FIFO with redirects")                        \
 132   _(ADD_SEGMENT, "Add segment and signal app if needed")        \
 133   _(BUILTIN_APP, "Application is builtin")                      \
 134
 135 typedef enum _app_options
 136 {
 137 #define _(sym, str) APP_OPTIONS_##sym,
 138   foreach_app_options_flags
 139 #undef _
 140 } app_options_t;
 141
 142 typedef enum _app_options_flags
 143 {
 144 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
 145   foreach_app_options_flags
 146 #undef _
 147 } app_options_flags_t;
 148
 149 ///** Server can handle delegated connect requests from local clients */
 150 //#define APP_OPTIONS_FLAGS_USE_FIFO    (1<<0)
 151 //
 152 ///** Server wants vpp to add segments when out of memory for fifos */
 153 //#define APP_OPTIONS_FLAGS_ADD_SEGMENT   (1<<1)
 154
 155 #define VNET_CONNECT_REDIRECTED 123
 156
 157 int vnet_application_attach (vnet_app_attach_args_t * a);
 158 int vnet_application_detach (vnet_app_detach_args_t * a);
 159
 160 int vnet_bind_uri (vnet_bind_args_t *);
 161 int vnet_unbind_uri (vnet_unbind_args_t * a);
 162 int vnet_connect_uri (vnet_connect_args_t * a);
 163 int vnet_disconnect_session (vnet_disconnect_args_t * a);
 164
 165 int vnet_bind (vnet_bind_args_t * a);
 166 int vnet_connect (vnet_connect_args_t * a);
 167 int vnet_unbind (vnet_unbind_args_t * a);
 168
 169 int
 170 api_parse_session_handle (u64 handle, u32 * session_index,
 171                           u32 * thread_index);
 172
 173 #endif /* __included_uri_h__ */
 174
 175 /*
 176  * fd.io coding-style-patch-verification: ON
 177  *
 178  * Local Variables:
 179  * eval: (c-set-style "gnu")
 180  * End:
 181  */