src/vnet/session/session.api

   1 /*
   2  * Copyright (c) 2015-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
  16 vl_api_version 1.0.0
  17
  18 /** \brief client->vpp, attach application to session layer
  19     @param client_index - opaque cookie to identify the sender
  20     @param context - sender context, to match reply w/ request
  21     @param initial_segment_size - size of the initial shm segment to be
  22                                                           allocated
  23     @param options - segment size, fifo sizes, etc.
  24     @param namespace_id_len - length of the namespace id c-string
  25     @param namespace_id - 0 terminted c-string
  26 */
  27  define application_attach {
  28     u32 client_index;
  29     u32 context;
  30     u32 initial_segment_size;
  31     u64 options[16];
  32     u8 namespace_id_len;
  33     u8 namespace_id [64];
  34  };
  35
  36  /** \brief Application attach reply
  37     @param context - sender context, to match reply w/ request
  38     @param retval - return code for the request
  39     @param app_event_queue_address - vpp event queue address or 0 if this
  40                                          connection shouldn't send events
  41     @param segment_size - size of first shm segment
  42     @param segment_name_length - length of segment name
  43     @param segment_name - name of segment client needs to attach to
  44 */
  45 define application_attach_reply {
  46     u32 context;
  47     i32 retval;
  48     u64 app_event_queue_address;
  49     u32 segment_size;
  50     u8 segment_name_length;
  51     u8 segment_name[128];
  52 };
  53
  54  /** \brief client->vpp, attach application to session layer
  55     @param client_index - opaque cookie to identify the sender
  56     @param context - sender context, to match reply w/ request
  57 */
  58 autoreply define application_detach {
  59     u32 client_index;
  60     u32 context;
  61  };
  62
  63 /** \brief vpp->client, please map an additional shared memory segment
  64     @param client_index - opaque cookie to identify the sender
  65     @param context - sender context, to match reply w/ request
  66     @param segment_name -
  67 */
  68 autoreply define map_another_segment {
  69     u32 client_index;
  70     u32 context;
  71     u32 segment_size;
  72     u8 segment_name[128];
  73 };
  74
  75  /** \brief Bind to a given URI
  76     @param client_index - opaque cookie to identify the sender
  77     @param context - sender context, to match reply w/ request
  78     @param accept_cookie - sender accept cookie, to identify this bind flavor
  79     @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
  80                  "tcp://::/0/80" [ipv6] etc.
  81     @param options - socket options, fifo sizes, etc.
  82 */
  83 autoreply define bind_uri {
  84   u32 client_index;
  85   u32 context;
  86   u32 accept_cookie;
  87   u8 uri[128];
  88 };
  89
  90 /** \brief Unbind a given URI
  91     @param client_index - opaque cookie to identify the sender
  92     @param context - sender context, to match reply w/ request
  93     @param uri - a URI, e.g. "tcp://0.0.0.0/0/80" [ipv4]
  94                  "tcp://::/0/80" [ipv6], etc.
  95     @param options - socket options, fifo sizes, etc.
  96 */
  97 autoreply define unbind_uri {
  98   u32 client_index;
  99   u32 context;
 100   u8 uri[128];
 101 };
 102
 103 /** \brief Connect to a given URI
 104     @param client_index - opaque cookie to identify the sender
 105     @param context - sender context, to match reply w/ request
 106     @param client_queue_address - binary API client queue address. Used by
 107                                                           local server when connect was redirected.
 108     @param options - socket options, fifo sizes, etc. passed by vpp to the
 109                                  server when redirecting connects
 110     @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80"
 111                  "tcp6://::/0/80" [ipv6], etc.
 112 */
 113 autoreply define connect_uri {
 114   u32 client_index;
 115   u32 context;
 116   u64 client_queue_address;
 117   u64 options[16];
 118   u8 uri[128];
 119 };
 120
 121 /** \brief vpp->client, accept this session
 122     @param context - sender context, to match reply w/ request
 123     @param listener_handle - tells client which listener this pertains to
 124     @param handle - unique session identifier
 125     @param session_thread_index - thread index of new session
 126     @param rx_fifo_address - rx (vpp -> vpp-client) fifo address
 127     @param tx_fifo_address - tx (vpp-client -> vpp) fifo address
 128     @param vpp_event_queue_address - vpp's event queue address
 129     @param port - remote port
 130     @param is_ip4 - 1 if the ip is ip4
 131     @param ip - remote ip
 132 */
 133 define accept_session {
 134   u32 client_index;
 135   u32 context;
 136   u64 listener_handle;
 137   u64 handle;
 138   u64 server_rx_fifo;
 139   u64 server_tx_fifo;
 140   u64 vpp_event_queue_address;
 141   u16 port;
 142   u8 is_ip4;
 143   u8 ip[16];
 144 };
 145
 146 /** \brief client->vpp, reply to an accept message
 147     @param context - sender context, to match reply w/ request
 148     @param retval - return code for the request
 149     @param session_index - session index from accept_session / connect_reply
 150     @param session_thread_index - thread index from accept_session /
 151                                   connect_reply
 152 */
 153 define accept_session_reply {
 154   u32 context;
 155   i32 retval;
 156   u64 handle;
 157 };
 158
 159 /** \brief bidirectional disconnect API
 160     @param client_index - opaque cookie to identify the sender
 161                           client to vpp direction only
 162     @param context - sender context, to match reply w/ request
 163     @param handle - session handle obtained from accept/connect
 164 */
 165 define disconnect_session {
 166   u32 client_index;
 167   u32 context;
 168   u64 handle;
 169 };
 170
 171 /** \brief bidirectional disconnect reply API
 172     @param client_index - opaque cookie to identify the sender
 173                           client to vpp direction only
 174     @param context - sender context, to match reply w/ request
 175     @param retval - return code for the request
 176     @param handle - session handle
 177 */
 178 define disconnect_session_reply {
 179   u32 client_index;
 180   u32 context;
 181   i32 retval;
 182   u64 handle;
 183 };
 184
 185 /** \brief vpp->client reset session API
 186     @param client_index - opaque cookie to identify the sender
 187                           client to vpp direction only
 188     @param context - sender context, to match reply w/ request
 189     @param handle - session handle obtained via accept/connects
 190 */
 191 define reset_session {
 192   u32 client_index;
 193   u32 context;
 194   u64 handle;
 195 };
 196
 197 /** \brief client->vpp reset session reply
 198     @param client_index - opaque cookie to identify the sender
 199                           client to vpp direction only
 200     @param context - sender context, to match reply w/ request
 201     @param retval - return code for the request
 202     @param handle - session handle obtained via accept/connect
 203 */
 204 define reset_session_reply {
 205   u32 client_index;
 206   u32 context;
 207   i32 retval;
 208   u64 handle;
 209 };
 210
 211 /** \brief Bind to an ip:port pair for a given transport protocol
 212     @param client_index - opaque cookie to identify the sender
 213     @param context - sender context, to match reply w/ request
 214     @param vrf - bind namespace
 215     @param is_ip4 - flag that is 1 if ip address family is IPv4
 216     @param ip - ip address
 217     @param port - port
 218     @param proto - protocol 0 - TCP 1 - UDP
 219     @param options - socket options, fifo sizes, etc.
 220 */
 221 define bind_sock {
 222   u32 client_index;
 223   u32 context;
 224   u32 vrf;
 225   u8 is_ip4;
 226   u8 ip[16];
 227   u16 port;
 228   u8 proto;
 229   u64 options[16];
 230 };
 231
 232 /** \brief Unbind
 233     @param client_index - opaque cookie to identify the sender
 234     @param context - sender context, to match reply w/ request
 235     @param handle - bind handle obtained from bind reply
 236 */
 237 autoreply define unbind_sock {
 238   u32 client_index;
 239   u32 context;
 240   u64 handle;
 241 };
 242
 243 /** \brief Connect to a remote peer
 244     @param client_index - opaque cookie to identify the sender
 245     @param context - sender context, to match reply w/ request
 246     @param client_queue_address - client's API queue address. Non-zero when
 247                                   used to perform redirects
 248     @param options - socket options, fifo sizes, etc. when doing redirects
 249     @param vrf - connection namespace
 250     @param is_ip4 - flag that is 1 if ip address family is IPv4
 251     @param ip - ip address
 252     @param port - port
 253     @param proto - protocol 0 - TCP 1 - UDP
 254 */
 255 autoreply define connect_sock {
 256   u32 client_index;
 257   u32 context;
 258   u64 client_queue_address;
 259   u64 options[16];
 260   u32 vrf;
 261   u8 is_ip4;
 262   u8 ip[16];
 263   u16 port;
 264   u8 proto;
 265 };
 266
 267 /** \brief Bind reply
 268     @param context - sender context, to match reply w/ request
 269     @param handle - bind handle
 270     @param retval - return code for the request
 271     @param event_queue_address - vpp event queue address or 0 if this
 272                                  connection shouldn't send events
 273     @param segment_name_length - length of segment name
 274     @param segment_name - name of segment client needs to attach to
 275 */
 276 define bind_sock_reply {
 277   u32 context;
 278   u64 handle;
 279   i32 retval;
 280   u64 server_event_queue_address;
 281   u8 lcl_is_ip4;
 282   u8 lcl_ip[16];
 283   u16 lcl_port;
 284   u32 segment_size;
 285   u8 segment_name_length;
 286   u8 segment_name[128];
 287 };
 288
 289 /* Dummy connect message -- needed to satisfy api generators
 290 *
 291 *  NEVER USED, doxygen tags elided on purpose.
 292 */
 293 define connect_session {
 294   u32 client_index;
 295   u32 context;
 296 };
 297
 298 /** \brief vpp/server->client, connect reply -- used for all connect_* messages
 299     @param context - sender context, to match reply w/ request
 300     @param retval - return code for the request
 301     @param handle - connection handle
 302     @param server_rx_fifo - rx (vpp -> vpp-client) fifo address
 303     @param server_tx_fifo - tx (vpp-client -> vpp) fifo address
 304     @param vpp_event_queue_address - vpp's event queue address
 305     @param segment_size - size of segment to be attached. Only for redirects.
 306     @param segment_name_length - non-zero if the client needs to attach to
 307                                  the fifo segment
 308     @param segment_name - set if the client needs to attach to the segment
 309     @param lcl_ip - local ip for connection
 310     @param is_ip4 - flag to indicate if ip is v4 or v6
 311     @param lcl_port - local port
 312 */
 313 define connect_session_reply {
 314   u32 context;
 315   i32 retval;
 316   u64 handle;
 317   u64 server_rx_fifo;
 318   u64 server_tx_fifo;
 319   u64 vpp_event_queue_address;
 320   u32 segment_size;
 321   u8 segment_name_length;
 322   u8 segment_name[128];
 323   u8 lcl_ip[16];
 324   u8 is_ip4;
 325   u16 lcl_port;
 326 };
 327
 328 /** \brief enable/disable session layer
 329     @param client_index - opaque cookie to identify the sender
 330                           client to vpp direction only
 331     @param context - sender context, to match reply w/ request
 332     @param is_enable - disable session layer if 0, enable otherwise
 333 */
 334 autoreply define session_enable_disable {
 335   u32 client_index;
 336   u32 context;
 337   u8 is_enable;
 338 };
 339
 340 /** \brief add/del application namespace
 341     @param client_index - opaque cookie to identify the sender
 342                           client to vpp direction only
 343     @param context - sender context, to match reply w/ request
 344     @param secret - secret shared between app and vpp
 345     @param sw_if_index - local interface that "supports" namespace. Set to
 346                                                 ~0 if no preference
 347     @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored
 348                                                 if sw_if_index set.
 349     @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored
 350                                                 if sw_if_index set.
 351     @param namespace_id_len - length of namespace id lower
 352     @param namespace_id - namespace id
 353 */
 354 define app_namespace_add_del {
 355   u32 client_index;
 356   u32 context;
 357   u64 secret;
 358   u32 sw_if_index;
 359   u32 ip4_fib_id;
 360   u32 ip6_fib_id;
 361   u8 namespace_id_len;
 362   u8 namespace_id[64];
 363 };
 364
 365 /** \brief Reply for app namespace add/del
 366     @param context - returned sender context, to match reply w/ request
 367     @param retval - return code
 368     @param appns_index - app namespace index
 369 */
 370 define app_namespace_add_del_reply
 371 {
 372   u32 context;
 373   i32 retval;
 374   u32 appns_index;
 375 };
 376
 377 /** \brief add/del session rule
 378     @param client_index - opaque cookie to identify the sender
 379                           client to vpp direction only
 380     @param context - sender context, to match reply w/ request
 381     @param transport_proto - transport protocol (0 - tcp 1 - udp)
 382     @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
 383     @param lcl_ip - local ip
 384     @param lcl_plen - local prefix length
 385     @param rmt_ip - remote ip
 386     @param rmt_ple - remote prefix length
 387     @param lcl_port - local port
 388     @param rmt_port - remote port
 389     @param action_index - the only action defined now is forward to
 390                                                   application with index action_index
 391         @param is_add - flag to indicate if add or del
 392         @param appns_index - application namespace where rule is to be applied
 393                                                  to
 394         @param scope - flag that indicates scope of the rule: global or local.
 395                                    If 0, default is global, 1 is global 2 is local, 3 is
 396                                    both
 397 */
 398 autoreply define session_rule_add_del {
 399   u32 client_index;
 400   u32 context;
 401   u8 transport_proto;
 402   u8 is_ip4;
 403   u8 lcl_ip[16];
 404   u8 lcl_plen;
 405   u8 rmt_ip[16];
 406   u8 rmt_plen;
 407   u16 lcl_port;
 408   u16 rmt_port;
 409   u32 action_index;
 410   u8 is_add;
 411   u32 appns_index;
 412   u8 scope;
 413   u8 tag[64];
 414 };
 415
 416 /** \brief Dump session rules
 417     @param client_index - opaque cookie to identify the sender
 418     @param context - sender context, to match reply w/ request
 419  */
 420 define session_rules_dump
 421 {
 422   u32 client_index;
 423   u32 context;
 424 };
 425
 426 /** \brief Session rules details
 427         @param context - sender context, to match reply w/ request
 428     @param transport_proto - transport protocol (0 - tcp 1 - udp)
 429     @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
 430     @param lcl_ip - local ip
 431     @param lcl_plen - local prefix length
 432     @param rmt_ip - remote ip
 433     @param rmt_ple - remote prefix length
 434     @param lcl_port - local port
 435     @param rmt_port - remote port
 436     @param action_index - the only action defined now is forward to
 437                                                   application with index action_index
 438         @param appns_index - application namespace where rule is to be applied
 439                                                  to
 440         @param scope - flag that indicates scope of the rule: global or local.
 441                                    If 0, default is global, 1 is global 2 is local, 3 is
 442                                    both
 443   */
 444 define session_rules_details
 445 {
 446   u32 context;
 447   u8 transport_proto;
 448   u8 is_ip4;
 449   u8 lcl_ip[16];
 450   u8 lcl_plen;
 451   u8 rmt_ip[16];
 452   u8 rmt_plen;
 453   u16 lcl_port;
 454   u16 rmt_port;
 455   u32 action_index;
 456   u32 appns_index;
 457   u8 scope;
 458   u8 tag[64];
 459 };
 460
 461 /*
 462  * Local Variables:
 463  * eval: (c-set-style "gnu")
 464  * End:
 465  */