src/plugins/map/map.api

   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
  16 option version = "4.0.0";
  17
  18 import "vnet/ip/ip_types.api";
  19
  20 /** \brief Add MAP domains
  21     @param client_index - opaque cookie to identify the sender
  22     @param context - sender context, to match reply w/ request
  23     @param ip6_prefix - Rule IPv6 prefix
  24     @param ip4_prefix - Rule IPv4 prefix
  25     @param ip6_src - MAP domain IPv6 BR address / Tunnel source
  26     @param ea_bits_len - Embedded Address bits length
  27     @param psid_offset - Port Set Identifier (PSID) offset
  28     @param psid_length - PSID length
  29     @param mtu - MTU
  30     @param tag - A user field stored with the MAP
  31 */
  32 define map_add_domain
  33 {
  34   u32 client_index;
  35   u32 context;
  36   vl_api_ip6_prefix_t ip6_prefix;
  37   vl_api_ip4_prefix_t ip4_prefix;
  38   vl_api_ip6_prefix_t ip6_src;
  39   u8 ea_bits_len;
  40   u8 psid_offset;
  41   u8 psid_length;
  42   u16 mtu;
  43   string tag[limit=64];
  44 };
  45
  46 /** \brief Reply for MAP domain add
  47     @param context - returned sender context, to match reply w/ request
  48     @param index - MAP domain index
  49     @param retval - return code
  50 */
  51 define map_add_domain_reply
  52 {
  53   u32 context;
  54   u32 index;
  55   i32 retval;
  56 };
  57
  58 /** \brief Delete MAP domain
  59     @param client_index - opaque cookie to identify the sender
  60     @param context - sender context, to match reply w/ request
  61     @param index - MAP Domain index
  62 */
  63 autoreply define map_del_domain
  64 {
  65   u32 client_index;
  66   u32 context;
  67   u32 index;
  68 };
  69
  70
  71 /** \brief Add or Delete MAP rule from a domain (Only used for shared IPv4 per subscriber)
  72     @param client_index - opaque cookie to identify the sender
  73     @param context - sender context, to match reply w/ request
  74     @param index - MAP Domain index
  75     @param is_add - If 1 add rule, if 0 delete rule
  76     @param ip6_dst - MAP CE IPv6 address
  77     @param psid - Rule PSID
  78 */
  79 autoreply define map_add_del_rule
  80 {
  81   u32 client_index;
  82   u32 context;
  83   u32 index;
  84   bool is_add;
  85   vl_api_ip6_address_t ip6_dst;
  86   u16 psid;
  87 };
  88
  89
  90 /** \brief Get list of map domains
  91     @param client_index - opaque cookie to identify the sender
  92 */
  93 define map_domain_dump
  94 {
  95   u32 client_index;
  96   u32 context;
  97 };
  98
  99 /** \brief Details about a single MAP domain
 100     @param context - returned sender context, to match reply w/ request
 101     @param domain_index - MAP domain index
 102     @param ip6_prefix - Rule IPv6 prefix
 103     @param ip4_prefix - Rule IPv4 prefix
 104     @param ip6_src - MAP domain IPv6 BR address / Tunnel source
 105     @param ea_bits_len - Embedded Address bits length
 106     @param psid_offset - Port Set Identifier (PSID) offset
 107     @param psid_length - PSID length
 108     @param flags -
 109     @param mtu - MTU
 110     @param tag - The user field stored with the MAP at creation time
 111 */
 112 define map_domain_details
 113 {
 114   u32 context;
 115   u32 domain_index;
 116   vl_api_ip6_prefix_t ip6_prefix;
 117   vl_api_ip4_prefix_t ip4_prefix;
 118   vl_api_ip6_prefix_t ip6_src;
 119   u8 ea_bits_len;
 120   u8 psid_offset;
 121   u8 psid_length;
 122   u8 flags;
 123   u16 mtu;
 124   string tag[limit=64];
 125 };
 126
 127 define map_rule_dump
 128 {
 129   u32 client_index;
 130   u32 context;
 131   u32 domain_index;
 132 };
 133
 134 define map_rule_details
 135 {
 136   u32 context;
 137   vl_api_ip6_address_t ip6_dst;
 138   u16 psid;
 139 };
 140
 141 /** \brief Enable or disable a MAP interface
 142     @param client_index - opaque cookie to identify the sender
 143     @param context - sender context, to match reply w/ request
 144     @param sw_if_index -
 145     @param is_enable - 0=disable, 1=enable interface
 146     @param is_translation -  0=encapsulation, 1=translation
 147 */
 148 autoreply define map_if_enable_disable
 149 {
 150   u32 client_index;
 151   u32 context;
 152   u32 sw_if_index;
 153   bool is_enable;
 154   bool is_translation; /* 0 - encapsulation, 1 - translation */
 155 };
 156
 157 /** \brief Request for a single block of summary stats
 158     @param client_index - opaque cookie to identify the sender
 159     @param context - sender context, to match reply w/ request
 160 */
 161 define map_summary_stats
 162 {
 163   u32 client_index;
 164   u32 context;
 165 };
 166
 167 /** \brief Reply for map_summary_stats request
 168     @param context - sender context, to match reply w/ request
 169     @param retval - return code for request
 170     @param total_bindings -
 171     @param total_pkts -
 172     @param total_ip4_fragments -
 173     @param total_security_check -
 174 */
 175 define map_summary_stats_reply
 176 {
 177   u32 context;
 178   i32 retval;
 179   u64 total_bindings;
 180   u64 total_pkts[2];
 181   u64 total_bytes[2];
 182   u64 total_ip4_fragments;
 183   u64 total_security_check[2];
 184 };
 185
 186
 187 /** \brief Set MAP fragmentation parameters
 188     @param client_index - opaque cookie to identify the sender
 189     @param context - sender context, to match reply w/ request
 190     @param inner - 1=frag inner packet, 0=frag tunnel packets
 191     @param ignore_df - 1=IP4 fragment despite DF bit, 0=honor DF
 192 */
 193 autoreply define map_param_set_fragmentation
 194 {
 195   u32 client_index;
 196   u32 context;
 197   bool inner;
 198   bool ignore_df;
 199 };
 200
 201
 202 /** \brief Set MAP ICMP parameters
 203     @param client_index - opaque cookie to identify the sender
 204     @param context - sender context, to match reply w/ request
 205     @param icmp4_err_relay_src - IPv4 ICMP err relay src address
 206 */
 207 autoreply define map_param_set_icmp
 208 {
 209   u32 client_index;
 210   u32 context;
 211   vl_api_ip4_address_t ip4_err_relay_src;
 212 };
 213
 214
 215 /** \brief Set MAP ICMP6 parameters
 216     @param client_index - opaque cookie to identify the sender
 217     @param context - sender context, to match reply w/ request
 218     @param enable_unreachable - 1 = send ICMP unreachable err msgs
 219 */
 220 autoreply define map_param_set_icmp6
 221 {
 222   u32 client_index;
 223   u32 context;
 224   bool enable_unreachable;
 225 };
 226
 227
 228 /** \brief Add/delete MAP pre-resolve IP addresses parameters
 229     @param client_index - opaque cookie to identify the sender
 230     @param context - sender context, to match reply w/ request
 231     @param is_add - 1 = Add non-zero IP addresses, 0 = delete
 232     @param ip4_nh_address - direct IP4 next-hop address
 233     @param ip6_nh_address - direct IP6 next-hop address
 234 */
 235 autoreply define map_param_add_del_pre_resolve
 236 {
 237   u32 client_index;
 238   u32 context;
 239   bool is_add;
 240   vl_api_ip4_address_t ip4_nh_address;
 241   vl_api_ip6_address_t ip6_nh_address;
 242 };
 243
 244
 245 /** \brief Set MAP reassembly parameters
 246     @param client_index - opaque cookie to identify the sender
 247     @param context - sender context, to match reply w/ request
 248     @param is_ip6 - 1 = params apply to IPv6, 0 = params apply to IPv4
 249     @param lifetime_ms - reassembly valid lifetime, or ~0
 250     @param pool_size - max number of reassemblies, or ~0
 251     @param buffers -  max number of reassembly buffers, or ~0
 252     @param ht_ratio - hash-table size factor, or ~0
 253 */
 254 autoreply define map_param_set_reassembly
 255 {
 256   u32 client_index;
 257   u32 context;
 258   bool is_ip6;
 259   u16 lifetime_ms;
 260   u16 pool_size;
 261   u32 buffers;
 262   f64 ht_ratio;
 263 };
 264
 265
 266 /** \brief Set MAP security-check parameters
 267     @param client_index - opaque cookie to identify the sender
 268     @param context - sender context, to match reply w/ request
 269     @param enable - 1=enable security check on first inbound packet
 270     @param fragments - 1=enable check on (subsequent) fragments too
 271 */
 272 autoreply define map_param_set_security_check
 273 {
 274   u32 client_index;
 275   u32 context;
 276   bool enable;
 277   bool fragments;
 278 };
 279
 280
 281 /** \brief Set MAP traffic class parameters
 282     @param client_index - opaque cookie to identify the sender
 283     @param context - sender context, to match reply w/ request
 284     @param copy - 1 = copy packet class/TOS field, 0 = use tc_class instead
 285     @param tc_class - class field value when copy == 0
 286 */
 287 autoreply define map_param_set_traffic_class
 288 {
 289   u32 client_index;
 290   u32 context;
 291   bool copy;
 292   u8 tc_class;
 293 };
 294
 295
 296 /** \brief Set MAP TCP parameters
 297     @param client_index - opaque cookie to identify the sender
 298     @param context - sender context, to match reply w/ request
 299     @parma tcp_mss - TCP MSS clamping value
 300 */
 301 autoreply define map_param_set_tcp
 302 {
 303   u32 client_index;
 304   u32 context;
 305   u16 tcp_mss;
 306 };
 307
 308
 309 /** \brief Request for a single block of MAP parameters
 310     @param client_index - opaque cookie to identify the sender
 311     @param context - sender context, to match reply w/ request
 312 */
 313 define map_param_get
 314 {
 315   u32 client_index;
 316   u32 context;
 317 };
 318
 319
 320 /** \brief Reply for map_param_get request
 321     @param context - sender context, to match reply w/ request
 322     @param retval - return code for request
 323     @param inner - 1=frag inner packet, 0=frag tunnel packets, ~0=untouched
 324     @param ignore_df - 1=IP4 fragm despite DF bit, 0=honor DF, ~0=untouched
 325     @param icmp_ip4_err_relay_src - IPv4 ICMP err relay src address
 326     @param icmp6_enable_unreachable - 1 = send ICMP unreachable err msgs
 327     @param ip4_nh_address - direct IP4 next-hop address
 328     @param ip6_nh_address - direct IP6 next-hop address
 329     @param ip4_lifetime_ms - reassembly valid lifetime, or ~0
 330     @param ip4_pool_size - max number of reassemblies, or ~0
 331     @param ip4_buffers -  max number of reassembly buffers, or ~0
 332     @param ip4_ht_ratio - reassembly valid lifetime, or ~0
 333     @param ip6_lifetime_ms - max number of reassemblies, or ~0
 334     @param ip6_pool_size - max number of reassemblies, or ~0
 335     @param ip6_buffers -  max number of reassembly buffers, or ~0
 336     @param ip6_ht_ratio - hash-table size factor, or ~0
 337     @param sec_check_enable - 1=enable security check on first inbound packet
 338     @param sec_check_fragments - 1=enable check on (subsequent) fragments too
 339     @param tc_copy - 1 = copy packet class/TOS field, 0 = use class instead
 340     @param tc_class - class field value when copy == 0
 341 */
 342 define map_param_get_reply
 343 {
 344   u32 context;
 345   i32 retval;
 346   u8 frag_inner;
 347   u8 frag_ignore_df;
 348   vl_api_ip4_address_t icmp_ip4_err_relay_src;
 349   bool icmp6_enable_unreachable;
 350   vl_api_ip4_address_t ip4_nh_address;
 351   vl_api_ip6_address_t ip6_nh_address;
 352   u16 ip4_lifetime_ms;
 353   u16 ip4_pool_size;
 354   u32 ip4_buffers;
 355   f64 ip4_ht_ratio;
 356   u16 ip6_lifetime_ms;
 357   u16 ip6_pool_size;
 358   u32 ip6_buffers;
 359   f64 ip6_ht_ratio;
 360   bool sec_check_enable;
 361   bool sec_check_fragments;
 362   bool tc_copy;
 363   u8 tc_class;
 364 };