session: add app ns index to ns create api
[vpp.git] / src / vnet / session / session.api
index 992a063..358103a 100644 (file)
@@ -21,12 +21,16 @@ vl_api_version 1.0.0
     @param initial_segment_size - size of the initial shm segment to be 
                                                          allocated
     @param options - segment size, fifo sizes, etc.
+    @param namespace_id_len - length of the namespace id c-string
+    @param namespace_id - 0 terminted c-string
 */
  define application_attach {
     u32 client_index;
     u32 context;
     u32 initial_segment_size;
     u64 options[16];
+    u8 namespace_id_len;
+    u8 namespace_id [64];
  };
  
  /** \brief Application attach reply
@@ -99,20 +103,19 @@ autoreply define unbind_uri {
 /** \brief Connect to a given URI
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param accept_cookie - sender accept cookie, to identify this bind flavor
-    @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80"
-                 "tcp6://::/0/80" [ipv6], etc.
-    @param options - socket options, fifo sizes, etc. passed by vpp to the
-                                server when redirecting connects 
     @param client_queue_address - binary API client queue address. Used by 
                                                          local server when connect was redirected.
+    @param options - socket options, fifo sizes, etc. passed by vpp to the
+                                server when redirecting connects 
+    @param uri - a URI, e.g. "tcp4://0.0.0.0/0/80"
+                 "tcp6://::/0/80" [ipv6], etc.
 */
 autoreply define connect_uri {
   u32 client_index;
   u32 context;
-  u8 uri[128];
   u64 client_queue_address;
   u64 options[16];
+  u8 uri[128];
 };
 
 /** \brief vpp->client, accept this session
@@ -240,26 +243,25 @@ autoreply define unbind_sock {
 /** \brief Connect to a remote peer
     @param client_index - opaque cookie to identify the sender
     @param context - sender context, to match reply w/ request
-    @param app_connect - application connection id to be returned in reply
+    @param client_queue_address - client's API queue address. Non-zero when 
+                                  used to perform redirects
+    @param options - socket options, fifo sizes, etc. when doing redirects
     @param vrf - connection namespace
     @param is_ip4 - flag that is 1 if ip address family is IPv4
     @param ip - ip address
     @param port - port 
     @param proto - protocol 0 - TCP 1 - UDP
-    @param client_queue_address - client's API queue address. Non-zero when 
-                                  used to perform redirects
-    @param options - socket options, fifo sizes, etc. when doing redirects
 */
 autoreply define connect_sock {
   u32 client_index;
   u32 context;
+  u64 client_queue_address;
+  u64 options[16];
   u32 vrf;
   u8 is_ip4;
   u8 ip[16];
   u16 port;
   u8 proto;
-  u64 client_queue_address;
-  u64 options[16];
 };
 
 /** \brief Bind reply
@@ -301,6 +303,9 @@ define connect_session {
     @param segment_name_length - non-zero if the client needs to attach to 
                                  the fifo segment
     @param segment_name - set if the client needs to attach to the segment
+    @param lcl_ip - local ip for connection
+    @param is_ip4 - flag to indicate if ip is v4 or v6
+    @param lcl_port - local port
 */
 define connect_session_reply {
   u32 context;
@@ -312,6 +317,9 @@ define connect_session_reply {
   u32 segment_size;
   u8 segment_name_length;
   u8 segment_name[128];
+  u8 lcl_ip[16];
+  u8 is_ip4;
+  u16 lcl_port;
 };
 
 /** \brief enable/disable session layer
@@ -326,6 +334,127 @@ autoreply define session_enable_disable {
   u8 is_enable;
 };
 
+/** \brief add/del application namespace
+    @param client_index - opaque cookie to identify the sender
+                          client to vpp direction only
+    @param context - sender context, to match reply w/ request
+    @param secret - secret shared between app and vpp 
+    @param sw_if_index - local interface that "supports" namespace. Set to
+                                               ~0 if no preference
+    @param ip4_fib_id - id of ip4 fib that "supports" the namespace. Ignored 
+                                               if sw_if_index set.
+    @param ip6_fib_id - id of ip6 fib that "supports" the namespace. Ignored 
+                                               if sw_if_index set.
+    @param namespace_id_len - length of namespace id lower
+    @param namespace_id - namespace id
+*/
+define app_namespace_add_del {
+  u32 client_index;
+  u32 context;
+  u64 secret;
+  u32 sw_if_index;
+  u32 ip4_fib_id;
+  u32 ip6_fib_id;
+  u8 namespace_id_len;
+  u8 namespace_id[64];
+};
+
+/** \brief Reply for app namespace add/del
+    @param context - returned sender context, to match reply w/ request
+    @param retval - return code
+    @param appns_index - app namespace index
+*/
+define app_namespace_add_del_reply
+{
+  u32 context;
+  i32 retval;
+  u32 appns_index;
+};
+
+/** \brief add/del session rule
+    @param client_index - opaque cookie to identify the sender
+                          client to vpp direction only
+    @param context - sender context, to match reply w/ request
+    @param transport_proto - transport protocol (0 - tcp 1 - udp)
+    @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
+    @param lcl_ip - local ip
+    @param lcl_plen - local prefix length
+    @param rmt_ip - remote ip
+    @param rmt_ple - remote prefix length
+    @param lcl_port - local port
+    @param rmt_port - remote port
+    @param action_index - the only action defined now is forward to 
+                                                 application with index action_index
+       @param is_add - flag to indicate if add or del
+       @param appns_index - application namespace where rule is to be applied
+                                                to
+       @param scope - flag that indicates scope of the rule: global or local.
+                                  If 0, default is global, 1 is global 2 is local, 3 is
+                                  both
+*/
+autoreply define session_rule_add_del {
+  u32 client_index;
+  u32 context;
+  u8 transport_proto;
+  u8 is_ip4;
+  u8 lcl_ip[16];
+  u8 lcl_plen;
+  u8 rmt_ip[16];
+  u8 rmt_plen;
+  u16 lcl_port;
+  u16 rmt_port;
+  u32 action_index;
+  u8 is_add;
+  u32 appns_index;
+  u8 scope;
+  u8 tag[64];
+};
+
+/** \brief Dump session rules
+    @param client_index - opaque cookie to identify the sender
+    @param context - sender context, to match reply w/ request
+ */
+define session_rules_dump
+{
+  u32 client_index;
+  u32 context;
+};
+
+/** \brief Session rules details
+       @param context - sender context, to match reply w/ request
+    @param transport_proto - transport protocol (0 - tcp 1 - udp)
+    @param is_ip4 - flag to indicate if ip addresses are ip4 or 6
+    @param lcl_ip - local ip
+    @param lcl_plen - local prefix length
+    @param rmt_ip - remote ip
+    @param rmt_ple - remote prefix length
+    @param lcl_port - local port
+    @param rmt_port - remote port
+    @param action_index - the only action defined now is forward to
+                                                 application with index action_index
+       @param appns_index - application namespace where rule is to be applied
+                                                to
+       @param scope - flag that indicates scope of the rule: global or local.
+                                  If 0, default is global, 1 is global 2 is local, 3 is
+                                  both
+  */
+define session_rules_details
+{
+  u32 context;
+  u8 transport_proto;
+  u8 is_ip4;
+  u8 lcl_ip[16];
+  u8 lcl_plen;
+  u8 rmt_ip[16];
+  u8 rmt_plen;
+  u16 lcl_port;
+  u16 rmt_port;
+  u32 action_index;
+  u32 appns_index;
+  u8 scope;
+  u8 tag[64];
+};
+
 /*
  * Local Variables:
  * eval: (c-set-style "gnu")