1 // Code generated by GoVPP's binapi-generator. DO NOT EDIT.
3 // binapi-generator: v0.4.0
4 // VPP: 20.05.1-release
5 // source: /usr/share/vpp/api/core/ip_types.api.json
7 // Package ip_types contains generated bindings for API file ip_types.api.
23 api "git.fd.io/govpp.git/api"
24 codec "git.fd.io/govpp.git/codec"
27 // This is a compile-time assertion to ensure that this generated file
28 // is compatible with the GoVPP api package it is being compiled against.
29 // A compilation error at this line likely means your copy of the
30 // GoVPP api package needs to be updated.
31 const _ = api.GoVppAPIPackageIsVersion2
33 // AddressFamily defines enum 'address_family'.
34 type AddressFamily uint8
37 ADDRESS_IP4 AddressFamily = 0
38 ADDRESS_IP6 AddressFamily = 1
42 AddressFamily_name = map[uint8]string{
46 AddressFamily_value = map[string]uint8{
52 func (x AddressFamily) String() string {
53 s, ok := AddressFamily_name[uint8(x)]
57 return "AddressFamily(" + strconv.Itoa(int(x)) + ")"
60 // IPDscp defines enum 'ip_dscp'.
64 IP_API_DSCP_CS0 IPDscp = 0
65 IP_API_DSCP_CS1 IPDscp = 8
66 IP_API_DSCP_AF11 IPDscp = 10
67 IP_API_DSCP_AF12 IPDscp = 12
68 IP_API_DSCP_AF13 IPDscp = 14
69 IP_API_DSCP_CS2 IPDscp = 16
70 IP_API_DSCP_AF21 IPDscp = 18
71 IP_API_DSCP_AF22 IPDscp = 20
72 IP_API_DSCP_AF23 IPDscp = 22
73 IP_API_DSCP_CS3 IPDscp = 24
74 IP_API_DSCP_AF31 IPDscp = 26
75 IP_API_DSCP_AF32 IPDscp = 28
76 IP_API_DSCP_AF33 IPDscp = 30
77 IP_API_DSCP_CS4 IPDscp = 32
78 IP_API_DSCP_AF41 IPDscp = 34
79 IP_API_DSCP_AF42 IPDscp = 36
80 IP_API_DSCP_AF43 IPDscp = 38
81 IP_API_DSCP_CS5 IPDscp = 40
82 IP_API_DSCP_EF IPDscp = 46
83 IP_API_DSCP_CS6 IPDscp = 48
84 IP_API_DSCP_CS7 IPDscp = 50
88 IPDscp_name = map[uint8]string{
91 10: "IP_API_DSCP_AF11",
92 12: "IP_API_DSCP_AF12",
93 14: "IP_API_DSCP_AF13",
94 16: "IP_API_DSCP_CS2",
95 18: "IP_API_DSCP_AF21",
96 20: "IP_API_DSCP_AF22",
97 22: "IP_API_DSCP_AF23",
98 24: "IP_API_DSCP_CS3",
99 26: "IP_API_DSCP_AF31",
100 28: "IP_API_DSCP_AF32",
101 30: "IP_API_DSCP_AF33",
102 32: "IP_API_DSCP_CS4",
103 34: "IP_API_DSCP_AF41",
104 36: "IP_API_DSCP_AF42",
105 38: "IP_API_DSCP_AF43",
106 40: "IP_API_DSCP_CS5",
107 46: "IP_API_DSCP_EF",
108 48: "IP_API_DSCP_CS6",
109 50: "IP_API_DSCP_CS7",
111 IPDscp_value = map[string]uint8{
112 "IP_API_DSCP_CS0": 0,
113 "IP_API_DSCP_CS1": 8,
114 "IP_API_DSCP_AF11": 10,
115 "IP_API_DSCP_AF12": 12,
116 "IP_API_DSCP_AF13": 14,
117 "IP_API_DSCP_CS2": 16,
118 "IP_API_DSCP_AF21": 18,
119 "IP_API_DSCP_AF22": 20,
120 "IP_API_DSCP_AF23": 22,
121 "IP_API_DSCP_CS3": 24,
122 "IP_API_DSCP_AF31": 26,
123 "IP_API_DSCP_AF32": 28,
124 "IP_API_DSCP_AF33": 30,
125 "IP_API_DSCP_CS4": 32,
126 "IP_API_DSCP_AF41": 34,
127 "IP_API_DSCP_AF42": 36,
128 "IP_API_DSCP_AF43": 38,
129 "IP_API_DSCP_CS5": 40,
130 "IP_API_DSCP_EF": 46,
131 "IP_API_DSCP_CS6": 48,
132 "IP_API_DSCP_CS7": 50,
136 func (x IPDscp) String() string {
137 s, ok := IPDscp_name[uint8(x)]
141 return "IPDscp(" + strconv.Itoa(int(x)) + ")"
144 // IPEcn defines enum 'ip_ecn'.
148 IP_API_ECN_NONE IPEcn = 0
149 IP_API_ECN_ECT0 IPEcn = 1
150 IP_API_ECN_ECT1 IPEcn = 2
151 IP_API_ECN_CE IPEcn = 3
155 IPEcn_name = map[uint8]string{
156 0: "IP_API_ECN_NONE",
157 1: "IP_API_ECN_ECT0",
158 2: "IP_API_ECN_ECT1",
161 IPEcn_value = map[string]uint8{
162 "IP_API_ECN_NONE": 0,
163 "IP_API_ECN_ECT0": 1,
164 "IP_API_ECN_ECT1": 2,
169 func (x IPEcn) String() string {
170 s, ok := IPEcn_name[uint8(x)]
174 return "IPEcn(" + strconv.Itoa(int(x)) + ")"
177 // IPProto defines enum 'ip_proto'.
181 IP_API_PROTO_HOPOPT IPProto = 0
182 IP_API_PROTO_ICMP IPProto = 1
183 IP_API_PROTO_IGMP IPProto = 2
184 IP_API_PROTO_TCP IPProto = 6
185 IP_API_PROTO_UDP IPProto = 17
186 IP_API_PROTO_GRE IPProto = 47
187 IP_API_PROTO_ESP IPProto = 50
188 IP_API_PROTO_AH IPProto = 51
189 IP_API_PROTO_ICMP6 IPProto = 58
190 IP_API_PROTO_EIGRP IPProto = 88
191 IP_API_PROTO_OSPF IPProto = 89
192 IP_API_PROTO_SCTP IPProto = 132
193 IP_API_PROTO_RESERVED IPProto = 255
197 IPProto_name = map[uint8]string{
198 0: "IP_API_PROTO_HOPOPT",
199 1: "IP_API_PROTO_ICMP",
200 2: "IP_API_PROTO_IGMP",
201 6: "IP_API_PROTO_TCP",
202 17: "IP_API_PROTO_UDP",
203 47: "IP_API_PROTO_GRE",
204 50: "IP_API_PROTO_ESP",
205 51: "IP_API_PROTO_AH",
206 58: "IP_API_PROTO_ICMP6",
207 88: "IP_API_PROTO_EIGRP",
208 89: "IP_API_PROTO_OSPF",
209 132: "IP_API_PROTO_SCTP",
210 255: "IP_API_PROTO_RESERVED",
212 IPProto_value = map[string]uint8{
213 "IP_API_PROTO_HOPOPT": 0,
214 "IP_API_PROTO_ICMP": 1,
215 "IP_API_PROTO_IGMP": 2,
216 "IP_API_PROTO_TCP": 6,
217 "IP_API_PROTO_UDP": 17,
218 "IP_API_PROTO_GRE": 47,
219 "IP_API_PROTO_ESP": 50,
220 "IP_API_PROTO_AH": 51,
221 "IP_API_PROTO_ICMP6": 58,
222 "IP_API_PROTO_EIGRP": 88,
223 "IP_API_PROTO_OSPF": 89,
224 "IP_API_PROTO_SCTP": 132,
225 "IP_API_PROTO_RESERVED": 255,
229 func (x IPProto) String() string {
230 s, ok := IPProto_name[uint8(x)]
234 return "IPProto(" + strconv.Itoa(int(x)) + ")"
237 // AddressWithPrefix defines alias 'address_with_prefix'.
238 type AddressWithPrefix Prefix
240 func ParseAddressWithPrefix(s string) (AddressWithPrefix, error) {
241 prefix, err := ParsePrefix(s)
243 return AddressWithPrefix{}, err
245 return AddressWithPrefix(prefix), nil
247 func (x AddressWithPrefix) String() string {
248 return Prefix(x).String()
250 func (x *AddressWithPrefix) MarshalText() ([]byte, error) {
251 return []byte(x.String()), nil
253 func (x *AddressWithPrefix) UnmarshalText(text []byte) error {
254 prefix, err := ParseAddressWithPrefix(string(text))
262 // IP4Address defines alias 'ip4_address'.
263 type IP4Address [4]uint8
265 func ParseIP4Address(s string) (IP4Address, error) {
266 ip := net.ParseIP(s).To4()
268 return IP4Address{}, fmt.Errorf("invalid IP address: %s", s)
270 var ipaddr IP4Address
271 copy(ipaddr[:], ip.To4())
275 func (x IP4Address) ToIP() net.IP {
276 return net.IP(x[:]).To4()
278 func (x IP4Address) String() string {
279 return x.ToIP().String()
281 func (x *IP4Address) MarshalText() ([]byte, error) {
282 return []byte(x.String()), nil
284 func (x *IP4Address) UnmarshalText(text []byte) error {
285 ipaddr, err := ParseIP4Address(string(text))
293 // IP4AddressWithPrefix defines alias 'ip4_address_with_prefix'.
294 type IP4AddressWithPrefix IP4Prefix
296 // IP6Address defines alias 'ip6_address'.
297 type IP6Address [16]uint8
299 func ParseIP6Address(s string) (IP6Address, error) {
300 ip := net.ParseIP(s).To16()
302 return IP6Address{}, fmt.Errorf("invalid IP address: %s", s)
304 var ipaddr IP6Address
305 copy(ipaddr[:], ip.To16())
309 func (x IP6Address) ToIP() net.IP {
310 return net.IP(x[:]).To16()
312 func (x IP6Address) String() string {
313 return x.ToIP().String()
315 func (x *IP6Address) MarshalText() ([]byte, error) {
316 return []byte(x.String()), nil
318 func (x *IP6Address) UnmarshalText(text []byte) error {
319 ipaddr, err := ParseIP6Address(string(text))
327 // IP6AddressWithPrefix defines alias 'ip6_address_with_prefix'.
328 type IP6AddressWithPrefix IP6Prefix
330 // Address defines type 'address'.
331 type Address struct {
332 Af AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
333 Un AddressUnion `binapi:"address_union,name=un" json:"un,omitempty"`
336 func ParseAddress(s string) (Address, error) {
339 return Address{}, fmt.Errorf("invalid address: %s", s)
343 addr.Af = ADDRESS_IP6
345 copy(ip6[:], ip.To16())
348 addr.Af = ADDRESS_IP4
350 copy(ip4[:], ip.To4())
355 func (x Address) ToIP() net.IP {
356 if x.Af == ADDRESS_IP6 {
358 return net.IP(ip6[:]).To16()
361 return net.IP(ip4[:]).To4()
364 func (x Address) String() string {
365 return x.ToIP().String()
367 func (x *Address) MarshalText() ([]byte, error) {
368 return []byte(x.String()), nil
370 func (x *Address) UnmarshalText(text []byte) error {
371 addr, err := ParseAddress(string(text))
379 // IP4Prefix defines type 'ip4_prefix'.
380 type IP4Prefix struct {
381 Address IP4Address `binapi:"ip4_address,name=address" json:"address,omitempty"`
382 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
385 func ParseIP4Prefix(s string) (prefix IP4Prefix, err error) {
386 hasPrefix := strings.Contains(s, "/")
388 ip, network, err := net.ParseCIDR(s)
390 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
392 maskSize, _ := network.Mask.Size()
393 prefix.Len = byte(maskSize)
394 prefix.Address, err = ParseIP4Address(ip.String())
396 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
400 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
402 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
404 prefix.Len = byte(defaultMaskSize)
405 prefix.Address, err = ParseIP4Address(ip.String())
407 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
412 func (x IP4Prefix) ToIPNet() *net.IPNet {
413 mask := net.CIDRMask(int(x.Len), 32)
414 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
417 func (x IP4Prefix) String() string {
418 ip := x.Address.String()
419 return ip + "/" + strconv.Itoa(int(x.Len))
421 func (x *IP4Prefix) MarshalText() ([]byte, error) {
422 return []byte(x.String()), nil
424 func (x *IP4Prefix) UnmarshalText(text []byte) error {
425 prefix, err := ParseIP4Prefix(string(text))
433 // IP6Prefix defines type 'ip6_prefix'.
434 type IP6Prefix struct {
435 Address IP6Address `binapi:"ip6_address,name=address" json:"address,omitempty"`
436 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
439 func ParseIP6Prefix(s string) (prefix IP6Prefix, err error) {
440 hasPrefix := strings.Contains(s, "/")
442 ip, network, err := net.ParseCIDR(s)
444 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
446 maskSize, _ := network.Mask.Size()
447 prefix.Len = byte(maskSize)
448 prefix.Address, err = ParseIP6Address(ip.String())
450 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
454 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
456 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
458 prefix.Len = byte(defaultMaskSize)
459 prefix.Address, err = ParseIP6Address(ip.String())
461 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
466 func (x IP6Prefix) ToIPNet() *net.IPNet {
467 mask := net.CIDRMask(int(x.Len), 128)
468 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
471 func (x IP6Prefix) String() string {
472 ip := x.Address.String()
473 return ip + "/" + strconv.Itoa(int(x.Len))
475 func (x *IP6Prefix) MarshalText() ([]byte, error) {
476 return []byte(x.String()), nil
478 func (x *IP6Prefix) UnmarshalText(text []byte) error {
479 prefix, err := ParseIP6Prefix(string(text))
487 // Mprefix defines type 'mprefix'.
488 type Mprefix struct {
489 Af AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
490 GrpAddressLength uint16 `binapi:"u16,name=grp_address_length" json:"grp_address_length,omitempty"`
491 GrpAddress AddressUnion `binapi:"address_union,name=grp_address" json:"grp_address,omitempty"`
492 SrcAddress AddressUnion `binapi:"address_union,name=src_address" json:"src_address,omitempty"`
495 // Prefix defines type 'prefix'.
497 Address Address `binapi:"address,name=address" json:"address,omitempty"`
498 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
501 func ParsePrefix(ip string) (prefix Prefix, err error) {
502 hasPrefix := strings.Contains(ip, "/")
504 netIP, network, err := net.ParseCIDR(ip)
506 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
508 maskSize, _ := network.Mask.Size()
509 prefix.Len = byte(maskSize)
510 prefix.Address, err = ParseAddress(netIP.String())
512 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
515 netIP := net.ParseIP(ip)
516 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
517 if netIP.To4() == nil {
518 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
520 prefix.Len = byte(defaultMaskSize)
521 prefix.Address, err = ParseAddress(netIP.String())
523 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
528 func (x Prefix) ToIPNet() *net.IPNet {
530 if x.Address.Af == ADDRESS_IP4 {
531 mask = net.CIDRMask(int(x.Len), 32)
533 mask = net.CIDRMask(int(x.Len), 128)
535 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
538 func (x Prefix) String() string {
539 ip := x.Address.String()
540 return ip + "/" + strconv.Itoa(int(x.Len))
542 func (x *Prefix) MarshalText() ([]byte, error) {
543 return []byte(x.String()), nil
545 func (x *Prefix) UnmarshalText(text []byte) error {
546 prefix, err := ParsePrefix(string(text))
554 // PrefixMatcher defines type 'prefix_matcher'.
555 type PrefixMatcher struct {
556 Le uint8 `binapi:"u8,name=le" json:"le,omitempty"`
557 Ge uint8 `binapi:"u8,name=ge" json:"ge,omitempty"`
560 // AddressUnion defines union 'address_union'.
561 type AddressUnion struct {
562 // AddressUnion can be one of:
565 XXX_UnionData [16]byte
568 func AddressUnionIP4(a IP4Address) (u AddressUnion) {
572 func (u *AddressUnion) SetIP4(a IP4Address) {
573 buf := codec.NewBuffer(u.XXX_UnionData[:])
574 buf.EncodeBytes(a[:], 4)
576 func (u *AddressUnion) GetIP4() (a IP4Address) {
577 buf := codec.NewBuffer(u.XXX_UnionData[:])
578 copy(a[:], buf.DecodeBytes(4))
582 func AddressUnionIP6(a IP6Address) (u AddressUnion) {
586 func (u *AddressUnion) SetIP6(a IP6Address) {
587 buf := codec.NewBuffer(u.XXX_UnionData[:])
588 buf.EncodeBytes(a[:], 16)
590 func (u *AddressUnion) GetIP6() (a IP6Address) {
591 buf := codec.NewBuffer(u.XXX_UnionData[:])
592 copy(a[:], buf.DecodeBytes(16))