1 /* Hey Emacs use -*- mode: C -*- */
3 * Copyright (c) 2018 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 option version = "3.0.0";
18 manual_print typedef u8 ip4_address[4];
19 manual_print typedef u8 ip6_address[16];
21 enum address_family : u8 {
26 /* ECN code points - RFC 3168
27 https://tools.ietf.org/html/rfc3168
36 /* DSCP code points - RFC 2474
37 https://tools.ietf.org/html/rfc2474
38 Values other than these RFC defined values are accepted.
43 IP_API_DSCP_AF11 = 10,
44 IP_API_DSCP_AF12 = 12,
45 IP_API_DSCP_AF13 = 14,
47 IP_API_DSCP_AF21 = 18,
48 IP_API_DSCP_AF22 = 20,
49 IP_API_DSCP_AF23 = 22,
51 IP_API_DSCP_AF31 = 26,
52 IP_API_DSCP_AF32 = 28,
53 IP_API_DSCP_AF33 = 30,
55 IP_API_DSCP_AF41 = 34,
56 IP_API_DSCP_AF42 = 36,
57 IP_API_DSCP_AF43 = 38,
65 IP_API_PROTO_HOPOPT = 0,
66 IP_API_PROTO_ICMP = 1,
67 IP_API_PROTO_IGMP = 2,
69 IP_API_PROTO_UDP = 17,
70 IP_API_PROTO_GRE = 47,
71 IP_API_PROTO_ESP = 50,
73 IP_API_PROTO_ICMP6 = 58,
74 IP_API_PROTO_EIGRP = 88,
75 IP_API_PROTO_OSPF = 89,
76 IP_API_PROTO_SCTP = 132,
77 IP_API_PROTO_RESERVED = 255,
81 vl_api_ip4_address_t ip4;
82 vl_api_ip6_address_t ip6;
85 manual_print typedef address {
86 vl_api_address_family_t af;
87 vl_api_address_union_t un;
90 manual_print typedef prefix {
91 vl_api_address_t address;
96 vl_api_address_family_t af;
97 u16 grp_address_length;
98 vl_api_address_union_t grp_address;
99 vl_api_address_union_t src_address;
102 manual_print typedef ip6_prefix {
103 vl_api_ip6_address_t address;
107 manual_print typedef ip4_prefix {
108 vl_api_ip4_address_t address;
114 * The vl_api_[ip4|ip6]_address_with_prefix_t types are used as a type to denote
115 * both an IP address and a prefix. I.e. in CIDR notation
116 * '192.168.10.1/24' the address is 192.168.10.1 and the network
117 * prefix is 192.168.10.0/24.
119 * If only an address is needed use: vl_api_address_t types and if
120 * only a network prefix is needed (i.e. no hosts bits), then use the
121 * vl_api_prefix_t types.
125 manual_print typedef vl_api_prefix_t address_with_prefix;
126 manual_print typedef vl_api_ip4_prefix_t ip4_address_with_prefix;
127 manual_print typedef vl_api_ip6_prefix_t ip6_address_with_prefix;
129 /** \brief A context for matching prefixes against. (Think ip prefix list.)
130 The meaning (exact match / want subnets) of an unset matcher is left to the implementer.
131 @param le - le mut be <= to prefix.len. Default: 255 (not set).
132 @param ge - ge must be greater than le and <= max_size of prefix. Default: 255 (not set).
135 typedef prefix_matcher {
136 u8 le; /* [default=255] */
137 u8 ge; /* [default=255] */