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_ipv6 - 1 for IPv6 neighbor, 0 for IPv4
 132     @param is_static - A static neighbor Entry - there are not flushed
 133                        If the interface goes down.
 134     @param is_no_adj_fib - Do not create a corresponding entry in the FIB
 135                            table for the neighbor.
 136     @param mac_address - l2 address of the neighbor
 137     @param dst_address - ip4 or ip6 address of the neighbor
 138 */
 139 define ip_neighbor_add_del
 140 {
 141   u32 client_index;
 142   u32 context;
 143   u32 sw_if_index;
 144   /* 1 = add, 0 = delete */
 145   u8 is_add;
 146   u8 is_ipv6;
 147   u8 is_static;
 148   u8 is_no_adj_fib;
 149   u8 mac_address[6];
 150   u8 dst_address[16];
 151 };
 152
 153 /** \brief Reply for IP Neighbor add / delete request
 154     @param context - returned sender context, to match reply w/ request
 155     @param retval - return code
 156 */
 157 define ip_neighbor_add_del_reply
 158 {
 159   u32 context;
 160   i32 retval;
 161 };
 162
 163 /** \brief Set the ip flow hash config for a fib request
 164     @param client_index - opaque cookie to identify the sender
 165     @param context - sender context, to match reply w/ request
 166     @param vrf_id - vrf/fib id
 167     @param is_ipv6 - if non-zero the fib is ip6, else ip4
 168     @param src - if non-zero include src in flow hash
 169     @param dst - if non-zero include dst in flow hash
 170     @param sport - if non-zero include sport in flow hash
 171     @param dport - if non-zero include dport in flow hash
 172     @param proto -if non-zero include proto in flow hash
 173     @param reverse - if non-zero include reverse in flow hash
 174 */
 175 define set_ip_flow_hash
 176 {
 177   u32 client_index;
 178   u32 context;
 179   u32 vrf_id;
 180   u8 is_ipv6;
 181   u8 src;
 182   u8 dst;
 183   u8 sport;
 184   u8 dport;
 185   u8 proto;
 186   u8 reverse;
 187 };
 188
 189 /** \brief Set the ip flow hash config for a fib response
 190     @param context - sender context, to match reply w/ request
 191     @param retval - return code for the request
 192 */
 193 define set_ip_flow_hash_reply
 194 {
 195   u32 context;
 196   i32 retval;
 197 };
 198
 199 /** \brief IPv6 router advertisement config request
 200     @param client_index - opaque cookie to identify the sender
 201     @param context - sender context, to match reply w/ request
 202     @param suppress -
 203     @param managed -
 204     @param other -
 205     @param ll_option -
 206     @param send_unicast -
 207     @param cease -
 208     @param is_no -
 209     @param default_router -
 210     @param max_interval -
 211     @param min_interval -
 212     @param lifetime -
 213     @param initial_count -
 214     @param initial_interval -
 215 */
 216 define sw_interface_ip6nd_ra_config
 217 {
 218   u32 client_index;
 219   u32 context;
 220   u32 sw_if_index;
 221   u8 suppress;
 222   u8 managed;
 223   u8 other;
 224   u8 ll_option;
 225   u8 send_unicast;
 226   u8 cease;
 227   u8 is_no;
 228   u8 default_router;
 229   u32 max_interval;
 230   u32 min_interval;
 231   u32 lifetime;
 232   u32 initial_count;
 233   u32 initial_interval;
 234 };
 235
 236 /** \brief IPv6 router advertisement config response
 237     @param context - sender context, to match reply w/ request
 238     @param retval - return code for the request
 239 */
 240 define sw_interface_ip6nd_ra_config_reply
 241 {
 242   u32 context;
 243   i32 retval;
 244 };
 245
 246 /** \brief IPv6 router advertisement prefix config request
 247     @param client_index - opaque cookie to identify the sender
 248     @param context - sender context, to match reply w/ request
 249     @param sw_if_index - The interface the RA prefix information is for
 250     @param address[] - The prefix to advertise
 251     @param address_length - the prefix length
 252     @param use_default - Revert to default settings
 253     @param no_advertise - Do not advertise this prefix
 254     @param off_link - The prefix is off link (it is not configured on the interface)
 255                       Configures the L-flag, When set, indicates that this
 256                       prefix can be used for on-link determination.
 257     @param no_autoconfig - Setting for the A-flag. When
 258                            set indicates that this prefix can be used for
 259                           stateless address configuration.
 260     @param no_onlink - The prefix is not on link. Make sure this is consistent
 261                        with the off_link parameter else YMMV
 262     @param is_no - add/delete
 263     @param val_lifetime - The length of time in
 264                      seconds (relative to the time the packet is sent)
 265                      that the prefix is valid for the purpose of on-link
 266                      determination.  A value of all one bits
 267                      (0xffffffff) represents infinity
 268     @param pref_lifetime - The length of time in
 269                      seconds (relative to the time the packet is sent)
 270                      that addresses generated from the prefix via
 271                      stateless address autoconfiguration remain
 272                      preferred [ADDRCONF].  A value of all one bits
 273                      (0xffffffff) represents infinity.
 274 */
 275 define sw_interface_ip6nd_ra_prefix
 276 {
 277   u32 client_index;
 278   u32 context;
 279   u32 sw_if_index;
 280   u8 address[16];
 281   u8 address_length;
 282   u8 use_default;
 283   u8 no_advertise;
 284   u8 off_link;
 285   u8 no_autoconfig;
 286   u8 no_onlink;
 287   u8 is_no;
 288   u32 val_lifetime;
 289   u32 pref_lifetime;
 290 };
 291
 292 /** \brief IPv6 router advertisement prefix config response
 293     @param context - sender context, to match reply w/ request
 294     @param retval - return code for the request
 295 */
 296 define sw_interface_ip6nd_ra_prefix_reply
 297 {
 298   u32 context;
 299   i32 retval;
 300 };
 301
 302 /** \brief IPv6 ND proxy config
 303     @param client_index - opaque cookie to identify the sender
 304     @param context - sender context, to match reply w/ request
 305     @param sw_if_index - The interface the host is on
 306     @param address - The address of the host for which to proxy for
 307     @param is_add - Adding or deleting
 308 */
 309 define ip6nd_proxy_add_del
 310 {
 311   u32 client_index;
 312   u32 context;
 313   u32 sw_if_index;
 314   u8 is_del;
 315   u8 address[16];
 316 };
 317
 318 /** \brief IPv6 ND proxy response
 319     @param context - sender context, to match reply w/ request
 320     @param retval - return code for the request
 321 */
 322 define ip6nd_proxy_add_del_reply
 323 {
 324   u32 context;
 325   i32 retval;
 326 };
 327
 328 /** \brief IPv6 ND proxy details returned after request
 329     @param context - sender context, to match reply w/ request
 330     @param retval - return code for the request
 331 */
 332 define ip6nd_proxy_details
 333 {
 334   u32 client_index;
 335   u32 context;
 336   u32 sw_if_index;
 337   u8 address[16];
 338 };
 339
 340 /** \brief IPv6 ND proxy dump request
 341     @param context - sender context, to match reply w/ request
 342     @param retval - return code for the request
 343     @param sw_if_index - The interface the host is on
 344     @param address - The address of the host for which to proxy for
 345 */
 346 define ip6nd_proxy_dump
 347 {
 348   u32 client_index;
 349   u32 context;
 350 };
 351
 352 /** \brief IPv6 interface enable / disable request
 353     @param client_index - opaque cookie to identify the sender
 354     @param context - sender context, to match reply w/ request
 355     @param sw_if_index - interface used to reach neighbor
 356     @param enable - if non-zero enable ip6 on interface, else disable
 357 */
 358 define sw_interface_ip6_enable_disable
 359 {
 360   u32 client_index;
 361   u32 context;
 362   u32 sw_if_index;
 363   u8 enable;                    /* set to true if enable */
 364 };
 365
 366 /** \brief IPv6 interface enable / disable response
 367     @param context - sender context, to match reply w/ request
 368     @param retval - return code for the request
 369 */
 370 define sw_interface_ip6_enable_disable_reply
 371 {
 372   u32 context;
 373   i32 retval;
 374 };
 375
 376 /** \brief IPv6 set link local address on interface request
 377     @param client_index - opaque cookie to identify the sender
 378     @param context - sender context, to match reply w/ request
 379     @param sw_if_index - interface to set link local on
 380     @param address[] - the new link local address
 381 */
 382 define sw_interface_ip6_set_link_local_address
 383 {
 384   u32 client_index;
 385   u32 context;
 386   u32 sw_if_index;
 387   u8 address[16];
 388 };
 389
 390 /** \brief IPv6 set link local address on interface response
 391     @param context - sender context, to match reply w/ request
 392     @param retval - error code for the request
 393 */
 394 define sw_interface_ip6_set_link_local_address_reply
 395 {
 396   u32 context;
 397   i32 retval;
 398 };
 399
 400 /** \brief Add / del route request
 401     @param client_index - opaque cookie to identify the sender
 402     @param context - sender context, to match reply w/ request
 403     @param sw_if_index - software index of the new vlan's parent interface
 404     @param vrf_id - fib table /vrf associated with the route
 405     @param lookup_in_vrf -
 406     @param classify_table_index -
 407     @param create_vrf_if_needed -
 408     @param is_add - 1 if adding the route, 0 if deleting
 409     @param is_drop - Drop the packet
 410     @param is_unreach - Drop the packet and rate limit send ICMP unreachable
 411     @param is_prohibit - Drop the packet and rate limit send ICMP prohibited
 412     @param is_ipv6 - 0 if an ip4 route, else ip6
 413     @param is_local -
 414     @param is_classify -
 415     @param is_multipath - Set to 1 if this is a multipath route, else 0
 416     @param not_last - Is last or not last msg in group of multiple add/del msgs
 417     @param next_hop_weight -
 418     @param dst_address_length -
 419     @param dst_address[16] -
 420     @param next_hop_address[16] -
 421     @param next_hop_n_out_labels - the number of labels in the label stack
 422     @param next_hop_out_label_stack - the next-hop output label stack, outer most first
 423     @param next_hop_via_label - The next-hop is a resolved via a local label
 424 */
 425 define ip_add_del_route
 426 {
 427   u32 client_index;
 428   u32 context;
 429   u32 next_hop_sw_if_index;
 430   u32 table_id;
 431   u32 classify_table_index;
 432   u32 next_hop_table_id;
 433   u8 create_vrf_if_needed;
 434   u8 is_add;
 435   u8 is_drop;
 436   u8 is_unreach;
 437   u8 is_prohibit;
 438   u8 is_ipv6;
 439   u8 is_local;
 440   u8 is_classify;
 441   u8 is_multipath;
 442   u8 is_resolve_host;
 443   u8 is_resolve_attached;
 444   /* Is last/not-last message in group of multiple add/del messages. */
 445   u8 not_last;
 446   u8 next_hop_weight;
 447   u8 dst_address_length;
 448   u8 dst_address[16];
 449   u8 next_hop_address[16];
 450   u8 next_hop_n_out_labels;
 451   u32 next_hop_via_label;
 452   u32 next_hop_out_label_stack[next_hop_n_out_labels];
 453 };
 454
 455 /** \brief Reply for add / del route request
 456     @param context - returned sender context, to match reply w/ request
 457     @param retval - return code
 458 */
 459 define ip_add_del_route_reply
 460 {
 461   u32 context;
 462   i32 retval;
 463 };
 464
 465 /** \brief Add / del route request
 466     @param client_index - opaque cookie to identify the sender
 467     @param context - sender context, to match reply w/ request
 468     @param sw_if_index - software index of the new vlan's parent interface
 469     @param vrf_id - fib table /vrf associated with the route
 470
 471     FIXME
 472 */
 473 define ip_mroute_add_del
 474 {
 475   u32 client_index;
 476   u32 context;
 477   u32 next_hop_sw_if_index;
 478   u32 table_id;
 479   u32 entry_flags;
 480   u32 itf_flags;
 481   u16 grp_address_length;
 482   u8 create_vrf_if_needed;
 483   u8 is_add;
 484   u8 is_ipv6;
 485   u8 is_local;
 486   u8 grp_address[16];
 487   u8 src_address[16];
 488 };
 489
 490 /** \brief Reply for add / del mroute request
 491     @param context - returned sender context, to match reply w/ request
 492     @param retval - return code
 493 */
 494 define ip_mroute_add_del_reply
 495 {
 496   u32 context;
 497   i32 retval;
 498 };
 499
 500 /** \brief Dump IP multicast fib table
 501     @param client_index - opaque cookie to identify the sender
 502 */
 503 define ip_mfib_dump
 504 {
 505   u32 client_index;
 506   u32 context;
 507 };
 508
 509 /** \brief IP Multicast FIB table response
 510     @param table_id - IP fib table id
 511     @address_length - mask length
 512     @grp_address - Group address/prefix
 513     @src_address - Source address
 514     @param count - the number of fib_path in path
 515     @param path  - array of of fib_path structures
 516 */
 517 manual_endian manual_print define ip_mfib_details
 518 {
 519   u32 context;
 520   u32 table_id;
 521   u8  address_length;
 522   u8  grp_address[4];
 523   u8  src_address[4];
 524   u32 count;
 525   vl_api_fib_path_t path[count];
 526 };
 527
 528 /** \brief Dump IP6 multicast fib table
 529     @param client_index - opaque cookie to identify the sender
 530 */
 531 define ip6_mfib_dump
 532 {
 533   u32 client_index;
 534   u32 context;
 535 };
 536
 537 /** \brief IP6 Multicast FIB table response
 538     @param table_id - IP fib table id
 539     @address_length - mask length
 540     @grp_address - Group address/prefix
 541     @src_address - Source address
 542     @param count - the number of fib_path in path
 543     @param path  - array of of fib_path structures
 544 */
 545 manual_endian manual_print define ip6_mfib_details
 546 {
 547   u32 context;
 548   u32 table_id;
 549   u8  address_length;
 550   u8  grp_address[16];
 551   u8  src_address[16];
 552   u32 count;
 553   vl_api_fib_path_t path[count];
 554 };
 555
 556 define ip_address_details
 557 {
 558   u32 client_index;
 559   u32 context;
 560   u8 ip[16];
 561   u8 prefix_length;
 562   u32 sw_if_index;
 563   u8 is_ipv6;
 564 };
 565
 566 define ip_address_dump
 567 {
 568   u32 client_index;
 569   u32 context;
 570   u32 sw_if_index;
 571   u8 is_ipv6;
 572 };
 573
 574 define ip_details
 575 {
 576   u32 sw_if_index;
 577   u32 context;
 578   u8 is_ipv6;
 579 };
 580
 581 define ip_dump
 582 {
 583   u32 client_index;
 584   u32 context;
 585   u8 is_ipv6;
 586 };
 587
 588 define mfib_signal_dump
 589 {
 590   u32 client_index;
 591   u32 context;
 592 };
 593
 594 define mfib_signal_details
 595 {
 596   u32 client_index;
 597   u32 context;
 598   u32 sw_if_index;
 599   u32 table_id;
 600   u16 grp_address_len;
 601   u8 grp_address[16];
 602   u8 src_address[16];
 603   u16 ip_packet_len;
 604   u8 ip_packet_data[256];
 605 };
 606
 607 /*
 608  * Local Variables:
 609  * eval: (c-set-style "gnu")
 610  * End:
 611  */