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