src/vnet/ip/ip.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 /** \file
  17
  18     This file defines vpp IP control-plane API messages which are generally
  19     called through a shared memory interface.
  20 */
  21
  22 /** \brief Dump IP fib table
  23     @param client_index - opaque cookie to identify the sender
  24 */
  25 define ip_fib_dump
  26 {
  27   u32 client_index;
  28   u32 context;
  29 };
  30
  31 /** \brief FIB path
  32     @param sw_if_index - index of the interface
  33     @param weight - The weight, for UCMP
  34     @param is_local - local if non-zero, else remote
  35     @param is_drop - Drop the packet
  36     @param is_unreach - Drop the packet and rate limit send ICMP unreachable
  37     @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
  38     @param afi - the afi of the next hop, IP46_TYPE_IP4=1, IP46_TYPE_IP6=2
  39     @param next_hop[16] - the next hop address
  40
  41     WARNING: this type is replicated, pending cleanup completion
  42 */
  43 typeonly manual_print manual_endian define fib_path
  44 {
  45   u32 sw_if_index;
  46   u32 weight;
  47   u8 is_local;
  48   u8 is_drop;
  49   u8 is_unreach;
  50   u8 is_prohibit;
  51   u8 afi;
  52   u8 next_hop[16];
  53 };
  54
  55 /** \brief IP FIB table response
  56     @param table_id - IP fib table id
  57     @address_length - mask length
  58     @address - ip4 prefix
  59     @param count - the number of fib_path in path
  60     @param path  - array of of fib_path structures
  61 */
  62 manual_endian manual_print define ip_fib_details
  63 {
  64   u32 context;
  65   u32 table_id;
  66   u8  address_length;
  67   u8  address[4];
  68   u32 count;
  69   vl_api_fib_path_t path[count];
  70 };
  71
  72 /** \brief Dump IP6 fib table
  73     @param client_index - opaque cookie to identify the sender
  74 */
  75 define ip6_fib_dump
  76 {
  77   u32 client_index;
  78   u32 context;
  79 };
  80
  81 /** \brief IP6 FIB table response
  82     @param table_id - IP6 fib table id
  83     @address_length - mask length
  84     @address - ip6 prefix
  85     @param count - the number of fib_path in path
  86     @param path  - array of of fib_path structures
  87 */
  88 manual_endian manual_print define ip6_fib_details
  89 {
  90   u32 context;
  91   u32 table_id;
  92   u8  address_length;
  93   u8  address[16];
  94   u32 count;
  95   vl_api_fib_path_t path[count];
  96 };
  97
  98 /** \brief Dump IP neighboors
  99     @param client_index - opaque cookie to identify the sender
 100     @param context - sender context, to match reply w/ request
 101     @param sw_if_index - the interface to dump neighboors
 102     @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
 103 */
 104 define ip_neighbor_dump
 105 {
 106     u32 client_index;
 107     u32 context;
 108     u32 sw_if_index;
 109     u8  is_ipv6;
 110 };
 111
 112 /** \brief IP neighboors dump response
 113     @param context - sender context which was passed in the request
 114     @param is_static - [1|0] to indicate if neighbor is statically configured
 115     @param is_ipv6 - [1|0] to indicate if address family is ipv[6|4]
 116 */
 117 define ip_neighbor_details {
 118     u32 context;
 119     u8  is_static;
 120     u8  is_ipv6;
 121     u8  mac_address[6];
 122     u8  ip_address[16];
 123 };
 124
 125 /** \brief IP neighbor add / del request
 126     @param client_index - opaque cookie to identify the sender
 127     @param context - sender context, to match reply w/ request
 128     @param sw_if_index - interface used to reach neighbor
 129     @param is_add - 1 to add neighbor, 0 to delete
 130     @param is_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 131     @param is_static -
 132     @param mac_address - l2 address of the neighbor
 133     @param dst_address - ip4 or ip6 address of the neighbor
 134 */
 135 define ip_neighbor_add_del
 136 {
 137   u32 client_index;
 138   u32 context;
 139   u32 sw_if_index;
 140   /* 1 = add, 0 = delete */
 141   u8 is_add;
 142   u8 is_ipv6;
 143   u8 is_static;
 144   u8 mac_address[6];
 145   u8 dst_address[16];
 146 };
 147
 148 /** \brief Reply for IP Neighbor add / delete request
 149     @param context - returned sender context, to match reply w/ request
 150     @param retval - return code
 151 */
 152 define ip_neighbor_add_del_reply
 153 {
 154   u32 context;
 155   i32 retval;
 156 };
 157
 158 /** \brief Set the ip flow hash config for a fib request
 159     @param client_index - opaque cookie to identify the sender
 160     @param context - sender context, to match reply w/ request
 161     @param vrf_id - vrf/fib id
 162     @param is_ipv6 - if non-zero the fib is ip6, else ip4
 163     @param src - if non-zero include src in flow hash
 164     @param dst - if non-zero include dst in flow hash
 165     @param sport - if non-zero include sport in flow hash
 166     @param dport - if non-zero include dport in flow hash
 167     @param proto -if non-zero include proto in flow hash
 168     @param reverse - if non-zero include reverse in flow hash
 169 */
 170 define set_ip_flow_hash
 171 {
 172   u32 client_index;
 173   u32 context;
 174   u32 vrf_id;
 175   u8 is_ipv6;
 176   u8 src;
 177   u8 dst;
 178   u8 sport;
 179   u8 dport;
 180   u8 proto;
 181   u8 reverse;
 182 };
 183
 184 /** \brief Set the ip flow hash config for a fib response
 185     @param context - sender context, to match reply w/ request
 186     @param retval - return code for the request
 187 */
 188 define set_ip_flow_hash_reply
 189 {
 190   u32 context;
 191   i32 retval;
 192 };
 193
 194 /** \brief IPv6 router advertisement config request
 195     @param client_index - opaque cookie to identify the sender
 196     @param context - sender context, to match reply w/ request
 197     @param suppress -
 198     @param managed -
 199     @param other -
 200     @param ll_option -
 201     @param send_unicast -
 202     @param cease -
 203     @param is_no -
 204     @param default_router -
 205     @param max_interval -
 206     @param min_interval -
 207     @param lifetime -
 208     @param initial_count -
 209     @param initial_interval -
 210 */
 211 define sw_interface_ip6nd_ra_config
 212 {
 213   u32 client_index;
 214   u32 context;
 215   u32 sw_if_index;
 216   u8 suppress;
 217   u8 managed;
 218   u8 other;
 219   u8 ll_option;
 220   u8 send_unicast;
 221   u8 cease;
 222   u8 is_no;
 223   u8 default_router;
 224   u32 max_interval;
 225   u32 min_interval;
 226   u32 lifetime;
 227   u32 initial_count;
 228   u32 initial_interval;
 229 };
 230
 231 /** \brief IPv6 router advertisement config response
 232     @param context - sender context, to match reply w/ request
 233     @param retval - return code for the request
 234 */
 235 define sw_interface_ip6nd_ra_config_reply
 236 {
 237   u32 context;
 238   i32 retval;
 239 };
 240
 241 /** \brief IPv6 router advertisement prefix config request
 242     @param client_index - opaque cookie to identify the sender
 243     @param context - sender context, to match reply w/ request
 244     @param sw_if_index -
 245     @param address[] -
 246     @param address_length -
 247     @param use_default -
 248     @param no_advertise -
 249     @param off_link -
 250     @param no_autoconfig -
 251     @param no_onlink -
 252     @param is_no -
 253     @param val_lifetime -
 254     @param pref_lifetime -
 255 */
 256 define sw_interface_ip6nd_ra_prefix
 257 {
 258   u32 client_index;
 259   u32 context;
 260   u32 sw_if_index;
 261   u8 address[16];
 262   u8 address_length;
 263   u8 use_default;
 264   u8 no_advertise;
 265   u8 off_link;
 266   u8 no_autoconfig;
 267   u8 no_onlink;
 268   u8 is_no;
 269   u32 val_lifetime;
 270   u32 pref_lifetime;
 271 };
 272
 273 /** \brief IPv6 router advertisement prefix config response
 274     @param context - sender context, to match reply w/ request
 275     @param retval - return code for the request
 276 */
 277 define sw_interface_ip6nd_ra_prefix_reply
 278 {
 279   u32 context;
 280   i32 retval;
 281 };
 282
 283 /** \brief IPv6 interface enable / disable request
 284     @param client_index - opaque cookie to identify the sender
 285     @param context - sender context, to match reply w/ request
 286     @param sw_if_index - interface used to reach neighbor
 287     @param enable - if non-zero enable ip6 on interface, else disable
 288 */
 289 define sw_interface_ip6_enable_disable
 290 {
 291   u32 client_index;
 292   u32 context;
 293   u32 sw_if_index;
 294   u8 enable;                    /* set to true if enable */
 295 };
 296
 297 /** \brief IPv6 interface enable / disable response
 298     @param context - sender context, to match reply w/ request
 299     @param retval - return code for the request
 300 */
 301 define sw_interface_ip6_enable_disable_reply
 302 {
 303   u32 context;
 304   i32 retval;
 305 };
 306
 307 /** \brief IPv6 set link local address on interface request
 308     @param client_index - opaque cookie to identify the sender
 309     @param context - sender context, to match reply w/ request
 310     @param sw_if_index - interface to set link local on
 311     @param address[] - the new link local address
 312 */
 313 define sw_interface_ip6_set_link_local_address
 314 {
 315   u32 client_index;
 316   u32 context;
 317   u32 sw_if_index;
 318   u8 address[16];
 319 };
 320
 321 /** \brief IPv6 set link local address on interface response
 322     @param context - sender context, to match reply w/ request
 323     @param retval - error code for the request
 324 */
 325 define sw_interface_ip6_set_link_local_address_reply
 326 {
 327   u32 context;
 328   i32 retval;
 329 };
 330
 331 /** \brief Add / del route request
 332     @param client_index - opaque cookie to identify the sender
 333     @param context - sender context, to match reply w/ request
 334     @param sw_if_index - software index of the new vlan's parent interface
 335     @param vrf_id - fib table /vrf associated with the route
 336     @param lookup_in_vrf -
 337     @param classify_table_index -
 338     @param create_vrf_if_needed -
 339     @param is_add - 1 if adding the route, 0 if deleting
 340     @param is_drop - Drop the packet
 341     @param is_unreach - Drop the packet and rate limit send ICMP unreachable
 342     @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
 343     @param is_ipv6 - 0 if an ip4 route, else ip6
 344     @param is_local -
 345     @param is_classify -
 346     @param is_multipath - Set to 1 if this is a multipath route, else 0
 347     @param not_last - Is last or not last msg in group of multiple add/del msgs
 348     @param next_hop_weight -
 349     @param dst_address_length -
 350     @param dst_address[16] -
 351     @param next_hop_address[16] -
 352     @param next_hop_n_out_labels - the number of labels in the label stack
 353     @param next_hop_out_label_stack - the next-hop output label stack, outer most first
 354     @param next_hop_via_label - The next-hop is a resolved via a local label
 355 */
 356 define ip_add_del_route
 357 {
 358   u32 client_index;
 359   u32 context;
 360   u32 next_hop_sw_if_index;
 361   u32 table_id;
 362   u32 classify_table_index;
 363   u32 next_hop_table_id;
 364   u8 create_vrf_if_needed;
 365   u8 is_add;
 366   u8 is_drop;
 367   u8 is_unreach;
 368   u8 is_prohibit;
 369   u8 is_ipv6;
 370   u8 is_local;
 371   u8 is_classify;
 372   u8 is_multipath;
 373   u8 is_resolve_host;
 374   u8 is_resolve_attached;
 375   /* Is last/not-last message in group of multiple add/del messages. */
 376   u8 not_last;
 377   u8 next_hop_weight;
 378   u8 dst_address_length;
 379   u8 dst_address[16];
 380   u8 next_hop_address[16];
 381   u8 next_hop_n_out_labels;
 382   u32 next_hop_via_label;
 383   u32 next_hop_out_label_stack[next_hop_n_out_labels];
 384 };
 385
 386 /** \brief Reply for add / del route request
 387     @param context - returned sender context, to match reply w/ request
 388     @param retval - return code
 389 */
 390 define ip_add_del_route_reply
 391 {
 392   u32 context;
 393   i32 retval;
 394 };
 395
 396 /** \brief Add / del route request
 397     @param client_index - opaque cookie to identify the sender
 398     @param context - sender context, to match reply w/ request
 399     @param sw_if_index - software index of the new vlan's parent interface
 400     @param vrf_id - fib table /vrf associated with the route
 401
 402     FIXME
 403 */
 404 define ip_mroute_add_del
 405 {
 406   u32 client_index;
 407   u32 context;
 408   u32 next_hop_sw_if_index;
 409   u32 table_id;
 410   u32 entry_flags;
 411   u32 itf_flags;
 412   u16 grp_address_length;
 413   u8 create_vrf_if_needed;
 414   u8 is_add;
 415   u8 is_ipv6;
 416   u8 is_local;
 417   u8 grp_address[16];
 418   u8 src_address[16];
 419 };
 420
 421 /** \brief Reply for add / del mroute request
 422     @param context - returned sender context, to match reply w/ request
 423     @param retval - return code
 424 */
 425 define ip_mroute_add_del_reply
 426 {
 427   u32 context;
 428   i32 retval;
 429 };
 430
 431 /** \brief Dump IP multicast fib table
 432     @param client_index - opaque cookie to identify the sender
 433 */
 434 define ip_mfib_dump
 435 {
 436   u32 client_index;
 437   u32 context;
 438 };
 439
 440 /** \brief IP Multicast FIB table response
 441     @param table_id - IP fib table id
 442     @address_length - mask length
 443     @grp_address - Group address/prefix
 444     @src_address - Source address
 445     @param count - the number of fib_path in path
 446     @param path  - array of of fib_path structures
 447 */
 448 manual_endian manual_print define ip_mfib_details
 449 {
 450   u32 context;
 451   u32 table_id;
 452   u8  address_length;
 453   u8  grp_address[4];
 454   u8  src_address[4];
 455   u32 count;
 456   vl_api_fib_path_t path[count];
 457 };
 458
 459 /** \brief Dump IP6 multicast fib table
 460     @param client_index - opaque cookie to identify the sender
 461 */
 462 define ip6_mfib_dump
 463 {
 464   u32 client_index;
 465   u32 context;
 466 };
 467
 468 /** \brief IP6 Multicast FIB table response
 469     @param table_id - IP fib table id
 470     @address_length - mask length
 471     @grp_address - Group address/prefix
 472     @src_address - Source address
 473     @param count - the number of fib_path in path
 474     @param path  - array of of fib_path structures
 475 */
 476 manual_endian manual_print define ip6_mfib_details
 477 {
 478   u32 context;
 479   u32 table_id;
 480   u8  address_length;
 481   u8  grp_address[16];
 482   u8  src_address[16];
 483   u32 count;
 484   vl_api_fib_path_t path[count];
 485 };
 486
 487 define ip_address_details
 488 {
 489   u32 client_index;
 490   u32 context;
 491   u8 ip[16];
 492   u8 prefix_length;
 493   u32 sw_if_index;
 494   u8 is_ipv6;
 495 };
 496
 497 define ip_address_dump
 498 {
 499   u32 client_index;
 500   u32 context;
 501   u32 sw_if_index;
 502   u8 is_ipv6;
 503 };
 504
 505 define ip_details
 506 {
 507   u32 sw_if_index;
 508   u32 context;
 509   u8 is_ipv6;
 510 };
 511
 512 define ip_dump
 513 {
 514   u32 client_index;
 515   u32 context;
 516   u8 is_ipv6;
 517 };
 518
 519 define mfib_signal_dump
 520 {
 521   u32 client_index;
 522   u32 context;
 523 };
 524
 525 define mfib_signal_details
 526 {
 527   u32 client_index;
 528   u32 context;
 529   u32 sw_if_index;
 530   u32 table_id;
 531   u16 grp_address_len;
 532   u8 grp_address[16];
 533   u8 src_address[16];
 534   u16 ip_packet_len;
 535   u8 ip_packet_data[256];
 536 };
 537
 538 /*
 539  * Local Variables:
 540  * eval: (c-set-style "gnu")
 541  * End:
 542  */