X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=src%2Fvnet%2Fip%2Fip_types.api;h=30cb75a946f5e3fe2d7e17bbe29099c4a448261c;hb=8f5fef2c78b95de1a636ce27111722b71702212a;hp=af8f6231285eec21b4a69f634b03de47c28829c9;hpb=515eed42583a52d4783ff4906afa01244899e030;p=vpp.git diff --git a/src/vnet/ip/ip_types.api b/src/vnet/ip/ip_types.api index af8f6231285..30cb75a946f 100644 --- a/src/vnet/ip/ip_types.api +++ b/src/vnet/ip/ip_types.api @@ -14,14 +14,26 @@ * limitations under the License. */ -typedef u8 ip4_address[4]; -typedef u8 ip6_address[16]; +option version = "3.0.0"; +manual_print typedef u8 ip4_address[4]; +manual_print typedef u8 ip6_address[16]; -enum address_family { +enum address_family : u8 { ADDRESS_IP4 = 0, ADDRESS_IP6, }; +/** + * @brief The location at which to apply a feature + */ +enum ip_feature_location: u8 { + IP_API_FEATURE_INPUT = 0, + IP_API_FEATURE_OUTPUT, + IP_API_FEATURE_LOCAL, + IP_API_FEATURE_PUNT, + IP_API_FEATURE_DROP, +}; + /* ECN code points - RFC 3168 https://tools.ietf.org/html/rfc3168 */ @@ -60,15 +72,16 @@ enum ip_dscp : u8 { IP_API_DSCP_CS7 = 50, }; -enum ip_proto { +enum ip_proto : u8 { IP_API_PROTO_HOPOPT = 0, IP_API_PROTO_ICMP = 1, IP_API_PROTO_IGMP = 2, IP_API_PROTO_TCP = 6, IP_API_PROTO_UDP = 17, IP_API_PROTO_GRE = 47, - IP_API_PROTO_AH = 50, - IP_API_PROTO_ESP = 51, + IP_API_PROTO_ESP = 50, + IP_API_PROTO_AH = 51, + IP_API_PROTO_ICMP6 = 58, IP_API_PROTO_EIGRP = 88, IP_API_PROTO_OSPF = 89, IP_API_PROTO_SCTP = 132, @@ -80,16 +93,28 @@ union address_union { vl_api_ip6_address_t ip6; }; -typedef address { +manual_print typedef address { vl_api_address_family_t af; vl_api_address_union_t un; }; -typedef prefix { +manual_print typedef prefix { vl_api_address_t address; u8 len; }; +typedef ip4_address_and_mask +{ + vl_api_ip4_address_t addr; + vl_api_ip4_address_t mask; +}; + +typedef ip6_address_and_mask +{ + vl_api_ip6_address_t addr; + vl_api_ip6_address_t mask; +}; + typedef mprefix { vl_api_address_family_t af; u16 grp_address_length; @@ -97,16 +122,33 @@ typedef mprefix { vl_api_address_union_t src_address; }; -typedef ip6_prefix { +manual_print typedef ip6_prefix { vl_api_ip6_address_t address; u8 len; }; -typedef ip4_prefix { +manual_print typedef ip4_prefix { vl_api_ip4_address_t address; u8 len; }; +/** \brief + * + * The vl_api_[ip4|ip6]_address_with_prefix_t types are used as a type to denote + * both an IP address and a prefix. I.e. in CIDR notation + * '192.168.10.1/24' the address is 192.168.10.1 and the network + * prefix is 192.168.10.0/24. + * + * If only an address is needed use: vl_api_address_t types and if + * only a network prefix is needed (i.e. no hosts bits), then use the + * vl_api_prefix_t types. + * + **/ + +manual_print typedef vl_api_prefix_t address_with_prefix; +manual_print typedef vl_api_ip4_prefix_t ip4_address_with_prefix; +manual_print typedef vl_api_ip6_prefix_t ip6_address_with_prefix; + /** \brief A context for matching prefixes against. (Think ip prefix list.) The meaning (exact match / want subnets) of an unset matcher is left to the implementer. @param le - le mut be <= to prefix.len. Default: 255 (not set).