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 #include <vnet/tls/tls.h>
  25
  26 typedef struct _vnet_app_attach_args_t
  27 {
  28   /** Binary API client index */
  29   u32 api_client_index;
  30
  31   /** Application name. Used by builtin apps */
  32   u8 *name;
  33
  34   /** Application and segment manager options */
  35   u64 *options;
  36
  37   /** ID of the namespace the app has access to */
  38   u8 *namespace_id;
  39
  40   /** Session to application callback functions */
  41   session_cb_vft_t *session_cb_vft;
  42
  43   /*
  44    * Results
  45    */
  46   ssvm_private_t *segment;
  47   u64 app_event_queue_address;
  48   u32 app_index;
  49 } vnet_app_attach_args_t;
  50
  51 typedef struct _vnet_app_detach_args_t
  52 {
  53   u32 app_index;
  54 } vnet_app_detach_args_t;
  55
  56 typedef struct _vnet_bind_args_t
  57 {
  58   union
  59   {
  60     char *uri;
  61     session_endpoint_t sep;
  62   };
  63
  64   u32 app_index;
  65
  66   /*
  67    * Results
  68    */
  69   char *segment_name;
  70   u32 segment_name_length;
  71   u64 server_event_queue_address;
  72   u64 handle;
  73 } vnet_bind_args_t;
  74
  75 typedef struct _vnet_unbind_args_t
  76 {
  77   union
  78   {
  79     char *uri;
  80     u64 handle;
  81   };
  82   u32 app_index;
  83 } vnet_unbind_args_t;
  84
  85 typedef struct _vnet_connect_args
  86 {
  87   union
  88   {
  89     char *uri;
  90     session_endpoint_extended_t sep;
  91   };
  92   u32 app_index;
  93   u32 api_context;
  94
  95   session_handle_t session_handle;
  96 } vnet_connect_args_t;
  97
  98 typedef struct _vnet_disconnect_args_t
  99 {
 100   session_handle_t handle;
 101   u32 app_index;
 102 } vnet_disconnect_args_t;
 103
 104 typedef struct _vnet_application_add_tls_cert_args_t
 105 {
 106   u32 app_index;
 107   u8 *cert;
 108 } vnet_app_add_tls_cert_args_t;
 109
 110 typedef struct _vnet_application_add_tls_key_args_t
 111 {
 112   u32 app_index;
 113   u8 *key;
 114 } vnet_app_add_tls_key_args_t;
 115
 116 /* Application attach options */
 117 typedef enum
 118 {
 119   APP_OPTIONS_FLAGS,
 120   APP_OPTIONS_EVT_QUEUE_SIZE,
 121   APP_OPTIONS_SEGMENT_SIZE,
 122   APP_OPTIONS_ADD_SEGMENT_SIZE,
 123   APP_OPTIONS_PRIVATE_SEGMENT_COUNT,
 124   APP_OPTIONS_RX_FIFO_SIZE,
 125   APP_OPTIONS_TX_FIFO_SIZE,
 126   APP_OPTIONS_PREALLOC_FIFO_PAIRS,
 127   APP_OPTIONS_NAMESPACE,
 128   APP_OPTIONS_NAMESPACE_SECRET,
 129   APP_OPTIONS_PROXY_TRANSPORT,
 130   APP_OPTIONS_ACCEPT_COOKIE,
 131   APP_OPTIONS_TLS_ENGINE,
 132   APP_OPTIONS_N_OPTIONS
 133 } app_attach_options_index_t;
 134
 135 #define foreach_app_options_flags                               \
 136   _(ACCEPT_REDIRECT, "Use FIFO with redirects")                 \
 137   _(ADD_SEGMENT, "Add segment and signal app if needed")        \
 138   _(IS_BUILTIN, "Application is builtin")                       \
 139   _(IS_PROXY, "Application is proxying")                                \
 140   _(USE_GLOBAL_SCOPE, "App can use global session scope")       \
 141   _(USE_LOCAL_SCOPE, "App can use local session scope")
 142
 143 typedef enum _app_options
 144 {
 145 #define _(sym, str) APP_OPTIONS_##sym,
 146   foreach_app_options_flags
 147 #undef _
 148 } app_options_t;
 149
 150 typedef enum _app_options_flags
 151 {
 152 #define _(sym, str) APP_OPTIONS_FLAGS_##sym = 1 << APP_OPTIONS_##sym,
 153   foreach_app_options_flags
 154 #undef _
 155 } app_options_flags_t;
 156
 157 int vnet_bind_uri (vnet_bind_args_t *);
 158 int vnet_unbind_uri (vnet_unbind_args_t * a);
 159 clib_error_t *vnet_connect_uri (vnet_connect_args_t * a);
 160
 161 clib_error_t *vnet_application_attach (vnet_app_attach_args_t * a);
 162 clib_error_t *vnet_bind (vnet_bind_args_t * a);
 163 clib_error_t *vnet_connect (vnet_connect_args_t * a);
 164 clib_error_t *vnet_unbind (vnet_unbind_args_t * a);
 165 int vnet_application_detach (vnet_app_detach_args_t * a);
 166 int vnet_disconnect_session (vnet_disconnect_args_t * a);
 167
 168 clib_error_t *vnet_app_add_tls_cert (vnet_app_add_tls_cert_args_t * a);
 169 clib_error_t *vnet_app_add_tls_key (vnet_app_add_tls_key_args_t * a);
 170
 171 extern const char test_srv_crt_rsa[];
 172 extern const u32 test_srv_crt_rsa_len;
 173 extern const char test_srv_key_rsa[];
 174 extern const u32 test_srv_key_rsa_len;
 175
 176 #endif /* __included_uri_h__ */
 177
 178 /*
 179  * fd.io coding-style-patch-verification: ON
 180  *
 181  * Local Variables:
 182  * eval: (c-set-style "gnu")
 183  * End:
 184  */