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 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 */
  37   session_cb_vft_t *session_cb_vft;
  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;
  47 } vnet_app_attach_args_t;
  48
  49 typedef struct _vnet_app_detach_args_t
  50 {
  51   u32 app_index;
  52 } vnet_app_detach_args_t;
  53
  54 typedef struct _vnet_bind_args_t
  55 {
  56   union
  57   {
  58     char *uri;
  59     struct
  60     {
  61       session_endpoint_t sep;
  62       transport_proto_t proto;
  63     };
  64   };
  65
  66   u32 app_index;
  67
  68   /*
  69    * Results
  70    */
  71   char *segment_name;
  72   u32 segment_name_length;
  73   u64 server_event_queue_address;
  74   u64 handle;
  75 } vnet_bind_args_t;
  76
  77 typedef struct _vnet_unbind_args_t
  78 {
  79   union
  80   {
  81     char *uri;
  82     u64 handle;
  83   };
  84   u32 app_index;
  85 } vnet_unbind_args_t;
  86
  87 typedef struct _vnet_connect_args
  88 {
  89   union
  90   {
  91     char *uri;
  92     struct
  93     {
  94       session_endpoint_t sep;
  95       transport_proto_t proto;
  96     };
  97   };
  98   u32 app_index;
  99   u32 api_context;
 100
 101   /* Used for redirects */
 102   void *mp;
 103
 104   /* used for proxy connections */
 105   u64 server_handle;
 106 } vnet_connect_args_t;
 107
 108 typedef struct _vnet_disconnect_args_t
 109 {
 110   u64 handle;
 111   u32 app_index;
 112 } vnet_disconnect_args_t;
 113
 114 /* Application attach options */
 115 typedef enum
 116 {
 117   APP_EVT_QUEUE_SIZE,
 118   APP_OPTIONS_FLAGS,
 119   APP_OPTIONS_PREALLOC_FIFO_PAIRS,
 120   APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
 121   APP_OPTIONS_PRIVATE_SEGMENT_SIZE,
 122   APP_OPTIONS_NAMESPACE,
 123   APP_OPTIONS_NAMESPACE_SECRET,
 124   SESSION_OPTIONS_SEGMENT_SIZE,
 125   SESSION_OPTIONS_ADD_SEGMENT_SIZE,
 126   SESSION_OPTIONS_RX_FIFO_SIZE,
 127   SESSION_OPTIONS_TX_FIFO_SIZE,
 128   SESSION_OPTIONS_PREALLOCATED_FIFO_PAIRS,
 129   SESSION_OPTIONS_ACCEPT_COOKIE,
 130   SESSION_OPTIONS_N_OPTIONS
 131 } app_attach_options_index_t;
 132
 133 #define foreach_app_options_flags                               \
 134   _(ACCEPT_REDIRECT, "Use FIFO with redirects")                 \
 135   _(ADD_SEGMENT, "Add segment and signal app if needed")        \
 136   _(BUILTIN_APP, "Application is builtin")                      \
 137   _(IS_PROXY, "Application is proxying")                                \
 138   _(USE_GLOBAL_SCOPE, "App can use global session scope")       \
 139   _(USE_LOCAL_SCOPE, "App can use local session scope")
 140
 141 typedef enum _app_options
 142 {
 143 #define _(sym, str) APP_OPTIONS_##sym,
 144   foreach_app_options_flags
 145 #undef _
 146 } app_options_t;
 147
 148 typedef enum _app_options_flags
 149 {
 150 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
 151   foreach_app_options_flags
 152 #undef _
 153 } app_options_flags_t;
 154
 155 clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a);
 156 int vnet_application_detach (vnet_app_detach_args_t * a);
 157
 158 int vnet_bind_uri (vnet_bind_args_t *);
 159 int vnet_unbind_uri (vnet_unbind_args_t * a);
 160 clib_error_t *vnet_connect_uri (vnet_connect_args_t * a);
 161 int vnet_disconnect_session (vnet_disconnect_args_t * a);
 162
 163 clib_error_t *vnet_bind (vnet_bind_args_t * a);
 164 clib_error_t *vnet_connect (vnet_connect_args_t * a);
 165 clib_error_t *vnet_unbind (vnet_unbind_args_t * a);
 166
 167 int
 168 api_parse_session_handle (u64 handle, u32 * session_index,
 169                           u32 * thread_index);
 170
 171 #endif /* __included_uri_h__ */
 172
 173 /*
 174  * fd.io coding-style-patch-verification: ON
 175  *
 176  * Local Variables:
 177  * eval: (c-set-style "gnu")
 178  * End:
 179  */