1 // Code generated by GoVPP's binapi-generator. DO NOT EDIT.
3 // binapi-generator: v0.4.0-dev
5 // source: .vppapi/core/ip_types.api.json
7 // Package ip_types contains generated bindings for API file ip_types.api.
19 api "git.fd.io/govpp.git/api"
20 codec "git.fd.io/govpp.git/codec"
26 // This is a compile-time assertion to ensure that this generated file
27 // is compatible with the GoVPP api package it is being compiled against.
28 // A compilation error at this line likely means your copy of the
29 // GoVPP api package needs to be updated.
30 const _ = api.GoVppAPIPackageIsVersion2
32 // AddressFamily defines enum 'address_family'.
33 type AddressFamily uint32
36 ADDRESS_IP4 AddressFamily = 0
37 ADDRESS_IP6 AddressFamily = 1
41 AddressFamily_name = map[uint32]string{
45 AddressFamily_value = map[string]uint32{
51 func (x AddressFamily) String() string {
52 s, ok := AddressFamily_name[uint32(x)]
56 return "AddressFamily(" + strconv.Itoa(int(x)) + ")"
59 // IPDscp defines enum 'ip_dscp'.
63 IP_API_DSCP_CS0 IPDscp = 0
64 IP_API_DSCP_CS1 IPDscp = 8
65 IP_API_DSCP_AF11 IPDscp = 10
66 IP_API_DSCP_AF12 IPDscp = 12
67 IP_API_DSCP_AF13 IPDscp = 14
68 IP_API_DSCP_CS2 IPDscp = 16
69 IP_API_DSCP_AF21 IPDscp = 18
70 IP_API_DSCP_AF22 IPDscp = 20
71 IP_API_DSCP_AF23 IPDscp = 22
72 IP_API_DSCP_CS3 IPDscp = 24
73 IP_API_DSCP_AF31 IPDscp = 26
74 IP_API_DSCP_AF32 IPDscp = 28
75 IP_API_DSCP_AF33 IPDscp = 30
76 IP_API_DSCP_CS4 IPDscp = 32
77 IP_API_DSCP_AF41 IPDscp = 34
78 IP_API_DSCP_AF42 IPDscp = 36
79 IP_API_DSCP_AF43 IPDscp = 38
80 IP_API_DSCP_CS5 IPDscp = 40
81 IP_API_DSCP_EF IPDscp = 46
82 IP_API_DSCP_CS6 IPDscp = 48
83 IP_API_DSCP_CS7 IPDscp = 50
87 IPDscp_name = map[uint8]string{
90 10: "IP_API_DSCP_AF11",
91 12: "IP_API_DSCP_AF12",
92 14: "IP_API_DSCP_AF13",
93 16: "IP_API_DSCP_CS2",
94 18: "IP_API_DSCP_AF21",
95 20: "IP_API_DSCP_AF22",
96 22: "IP_API_DSCP_AF23",
97 24: "IP_API_DSCP_CS3",
98 26: "IP_API_DSCP_AF31",
99 28: "IP_API_DSCP_AF32",
100 30: "IP_API_DSCP_AF33",
101 32: "IP_API_DSCP_CS4",
102 34: "IP_API_DSCP_AF41",
103 36: "IP_API_DSCP_AF42",
104 38: "IP_API_DSCP_AF43",
105 40: "IP_API_DSCP_CS5",
106 46: "IP_API_DSCP_EF",
107 48: "IP_API_DSCP_CS6",
108 50: "IP_API_DSCP_CS7",
110 IPDscp_value = map[string]uint8{
111 "IP_API_DSCP_CS0": 0,
112 "IP_API_DSCP_CS1": 8,
113 "IP_API_DSCP_AF11": 10,
114 "IP_API_DSCP_AF12": 12,
115 "IP_API_DSCP_AF13": 14,
116 "IP_API_DSCP_CS2": 16,
117 "IP_API_DSCP_AF21": 18,
118 "IP_API_DSCP_AF22": 20,
119 "IP_API_DSCP_AF23": 22,
120 "IP_API_DSCP_CS3": 24,
121 "IP_API_DSCP_AF31": 26,
122 "IP_API_DSCP_AF32": 28,
123 "IP_API_DSCP_AF33": 30,
124 "IP_API_DSCP_CS4": 32,
125 "IP_API_DSCP_AF41": 34,
126 "IP_API_DSCP_AF42": 36,
127 "IP_API_DSCP_AF43": 38,
128 "IP_API_DSCP_CS5": 40,
129 "IP_API_DSCP_EF": 46,
130 "IP_API_DSCP_CS6": 48,
131 "IP_API_DSCP_CS7": 50,
135 func (x IPDscp) String() string {
136 s, ok := IPDscp_name[uint8(x)]
140 return "IPDscp(" + strconv.Itoa(int(x)) + ")"
143 // IPEcn defines enum 'ip_ecn'.
147 IP_API_ECN_NONE IPEcn = 0
148 IP_API_ECN_ECT0 IPEcn = 1
149 IP_API_ECN_ECT1 IPEcn = 2
150 IP_API_ECN_CE IPEcn = 3
154 IPEcn_name = map[uint8]string{
155 0: "IP_API_ECN_NONE",
156 1: "IP_API_ECN_ECT0",
157 2: "IP_API_ECN_ECT1",
160 IPEcn_value = map[string]uint8{
161 "IP_API_ECN_NONE": 0,
162 "IP_API_ECN_ECT0": 1,
163 "IP_API_ECN_ECT1": 2,
168 func (x IPEcn) String() string {
169 s, ok := IPEcn_name[uint8(x)]
173 return "IPEcn(" + strconv.Itoa(int(x)) + ")"
176 // IPProto defines enum 'ip_proto'.
180 IP_API_PROTO_HOPOPT IPProto = 0
181 IP_API_PROTO_ICMP IPProto = 1
182 IP_API_PROTO_IGMP IPProto = 2
183 IP_API_PROTO_TCP IPProto = 6
184 IP_API_PROTO_UDP IPProto = 17
185 IP_API_PROTO_GRE IPProto = 47
186 IP_API_PROTO_AH IPProto = 50
187 IP_API_PROTO_ESP IPProto = 51
188 IP_API_PROTO_EIGRP IPProto = 88
189 IP_API_PROTO_OSPF IPProto = 89
190 IP_API_PROTO_SCTP IPProto = 132
191 IP_API_PROTO_RESERVED IPProto = 255
195 IPProto_name = map[uint32]string{
196 0: "IP_API_PROTO_HOPOPT",
197 1: "IP_API_PROTO_ICMP",
198 2: "IP_API_PROTO_IGMP",
199 6: "IP_API_PROTO_TCP",
200 17: "IP_API_PROTO_UDP",
201 47: "IP_API_PROTO_GRE",
202 50: "IP_API_PROTO_AH",
203 51: "IP_API_PROTO_ESP",
204 88: "IP_API_PROTO_EIGRP",
205 89: "IP_API_PROTO_OSPF",
206 132: "IP_API_PROTO_SCTP",
207 255: "IP_API_PROTO_RESERVED",
209 IPProto_value = map[string]uint32{
210 "IP_API_PROTO_HOPOPT": 0,
211 "IP_API_PROTO_ICMP": 1,
212 "IP_API_PROTO_IGMP": 2,
213 "IP_API_PROTO_TCP": 6,
214 "IP_API_PROTO_UDP": 17,
215 "IP_API_PROTO_GRE": 47,
216 "IP_API_PROTO_AH": 50,
217 "IP_API_PROTO_ESP": 51,
218 "IP_API_PROTO_EIGRP": 88,
219 "IP_API_PROTO_OSPF": 89,
220 "IP_API_PROTO_SCTP": 132,
221 "IP_API_PROTO_RESERVED": 255,
225 func (x IPProto) String() string {
226 s, ok := IPProto_name[uint32(x)]
230 return "IPProto(" + strconv.Itoa(int(x)) + ")"
233 // AddressWithPrefix defines alias 'address_with_prefix'.
234 type AddressWithPrefix Prefix
236 func ParseAddressWithPrefix(s string) (AddressWithPrefix, error) {
237 prefix, err := ParsePrefix(s)
239 return AddressWithPrefix{}, err
241 return AddressWithPrefix(prefix), nil
243 func (x AddressWithPrefix) String() string {
244 return Prefix(x).String()
246 func (x *AddressWithPrefix) MarshalText() ([]byte, error) {
247 return []byte(x.String()), nil
249 func (x *AddressWithPrefix) UnmarshalText(text []byte) error {
250 prefix, err := ParseAddressWithPrefix(string(text))
258 // IP4Address defines alias 'ip4_address'.
259 type IP4Address [4]uint8
261 func ParseIP4Address(s string) (IP4Address, error) {
262 ip := net.ParseIP(s).To4()
264 return IP4Address{}, fmt.Errorf("invalid IP address: %s", s)
266 var ipaddr IP4Address
267 copy(ipaddr[:], ip.To4())
271 func (x IP4Address) ToIP() net.IP {
272 return net.IP(x[:]).To4()
274 func (x IP4Address) String() string {
275 return x.ToIP().String()
277 func (x *IP4Address) MarshalText() ([]byte, error) {
278 return []byte(x.String()), nil
280 func (x *IP4Address) UnmarshalText(text []byte) error {
281 ipaddr, err := ParseIP4Address(string(text))
289 // IP4AddressWithPrefix defines alias 'ip4_address_with_prefix'.
290 type IP4AddressWithPrefix IP4Prefix
292 // IP6Address defines alias 'ip6_address'.
293 type IP6Address [16]uint8
295 func ParseIP6Address(s string) (IP6Address, error) {
296 ip := net.ParseIP(s).To16()
298 return IP6Address{}, fmt.Errorf("invalid IP address: %s", s)
300 var ipaddr IP6Address
301 copy(ipaddr[:], ip.To16())
305 func (x IP6Address) ToIP() net.IP {
306 return net.IP(x[:]).To16()
308 func (x IP6Address) String() string {
309 return x.ToIP().String()
311 func (x *IP6Address) MarshalText() ([]byte, error) {
312 return []byte(x.String()), nil
314 func (x *IP6Address) UnmarshalText(text []byte) error {
315 ipaddr, err := ParseIP6Address(string(text))
323 // IP6AddressWithPrefix defines alias 'ip6_address_with_prefix'.
324 type IP6AddressWithPrefix IP6Prefix
326 // Address defines type 'address'.
327 type Address struct {
328 Af AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
329 Un AddressUnion `binapi:"address_union,name=un" json:"un,omitempty"`
332 func ParseAddress(s string) (Address, error) {
335 return Address{}, fmt.Errorf("invalid address: %s", s)
339 addr.Af = ADDRESS_IP6
341 copy(ip6[:], ip.To16())
344 addr.Af = ADDRESS_IP4
346 copy(ip4[:], ip.To4())
351 func (x Address) ToIP() net.IP {
352 if x.Af == ADDRESS_IP6 {
354 return net.IP(ip6[:]).To16()
357 return net.IP(ip4[:]).To4()
360 func (x Address) String() string {
361 return x.ToIP().String()
363 func (x *Address) MarshalText() ([]byte, error) {
364 return []byte(x.String()), nil
366 func (x *Address) UnmarshalText(text []byte) error {
367 addr, err := ParseAddress(string(text))
375 // IP4Prefix defines type 'ip4_prefix'.
376 type IP4Prefix struct {
377 Address IP4Address `binapi:"ip4_address,name=address" json:"address,omitempty"`
378 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
381 func ParseIP4Prefix(s string) (prefix IP4Prefix, err error) {
382 hasPrefix := strings.Contains(s, "/")
384 ip, network, err := net.ParseCIDR(s)
386 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
388 maskSize, _ := network.Mask.Size()
389 prefix.Len = byte(maskSize)
390 prefix.Address, err = ParseIP4Address(ip.String())
392 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
396 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
398 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
400 prefix.Len = byte(defaultMaskSize)
401 prefix.Address, err = ParseIP4Address(ip.String())
403 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
408 func (x IP4Prefix) ToIPNet() *net.IPNet {
409 mask := net.CIDRMask(int(x.Len), 32)
410 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
413 func (x IP4Prefix) String() string {
414 ip := x.Address.String()
415 return ip + "/" + strconv.Itoa(int(x.Len))
417 func (x *IP4Prefix) MarshalText() ([]byte, error) {
418 return []byte(x.String()), nil
420 func (x *IP4Prefix) UnmarshalText(text []byte) error {
421 prefix, err := ParseIP4Prefix(string(text))
429 // IP6Prefix defines type 'ip6_prefix'.
430 type IP6Prefix struct {
431 Address IP6Address `binapi:"ip6_address,name=address" json:"address,omitempty"`
432 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
435 func ParseIP6Prefix(s string) (prefix IP6Prefix, err error) {
436 hasPrefix := strings.Contains(s, "/")
438 ip, network, err := net.ParseCIDR(s)
440 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
442 maskSize, _ := network.Mask.Size()
443 prefix.Len = byte(maskSize)
444 prefix.Address, err = ParseIP6Address(ip.String())
446 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
450 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
452 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
454 prefix.Len = byte(defaultMaskSize)
455 prefix.Address, err = ParseIP6Address(ip.String())
457 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
462 func (x IP6Prefix) ToIPNet() *net.IPNet {
463 mask := net.CIDRMask(int(x.Len), 128)
464 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
467 func (x IP6Prefix) String() string {
468 ip := x.Address.String()
469 return ip + "/" + strconv.Itoa(int(x.Len))
471 func (x *IP6Prefix) MarshalText() ([]byte, error) {
472 return []byte(x.String()), nil
474 func (x *IP6Prefix) UnmarshalText(text []byte) error {
475 prefix, err := ParseIP6Prefix(string(text))
483 // Mprefix defines type 'mprefix'.
484 type Mprefix struct {
485 Af AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
486 GrpAddressLength uint16 `binapi:"u16,name=grp_address_length" json:"grp_address_length,omitempty"`
487 GrpAddress AddressUnion `binapi:"address_union,name=grp_address" json:"grp_address,omitempty"`
488 SrcAddress AddressUnion `binapi:"address_union,name=src_address" json:"src_address,omitempty"`
491 // Prefix defines type 'prefix'.
493 Address Address `binapi:"address,name=address" json:"address,omitempty"`
494 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
497 func ParsePrefix(ip string) (prefix Prefix, err error) {
498 hasPrefix := strings.Contains(ip, "/")
500 netIP, network, err := net.ParseCIDR(ip)
502 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
504 maskSize, _ := network.Mask.Size()
505 prefix.Len = byte(maskSize)
506 prefix.Address, err = ParseAddress(netIP.String())
508 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
511 netIP := net.ParseIP(ip)
512 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
513 if netIP.To4() == nil {
514 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
516 prefix.Len = byte(defaultMaskSize)
517 prefix.Address, err = ParseAddress(netIP.String())
519 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
524 func (x Prefix) ToIPNet() *net.IPNet {
526 if x.Address.Af == ADDRESS_IP4 {
527 mask = net.CIDRMask(int(x.Len), 32)
529 mask = net.CIDRMask(int(x.Len), 128)
531 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
534 func (x Prefix) String() string {
535 ip := x.Address.String()
536 return ip + "/" + strconv.Itoa(int(x.Len))
538 func (x *Prefix) MarshalText() ([]byte, error) {
539 return []byte(x.String()), nil
541 func (x *Prefix) UnmarshalText(text []byte) error {
542 prefix, err := ParsePrefix(string(text))
550 // PrefixMatcher defines type 'prefix_matcher'.
551 type PrefixMatcher struct {
552 Le uint8 `binapi:"u8,name=le" json:"le,omitempty"`
553 Ge uint8 `binapi:"u8,name=ge" json:"ge,omitempty"`
556 // AddressUnion defines union 'address_union'.
557 type AddressUnion struct {
560 XXX_UnionData [16]byte
563 func AddressUnionIP4(a IP4Address) (u AddressUnion) {
567 func (u *AddressUnion) SetIP4(a IP4Address) {
568 buf := codec.NewBuffer(u.XXX_UnionData[:])
569 buf.EncodeBytes(a[:], 4)
571 func (u *AddressUnion) GetIP4() (a IP4Address) {
572 buf := codec.NewBuffer(u.XXX_UnionData[:])
573 copy(a[:], buf.DecodeBytes(4))
577 func AddressUnionIP6(a IP6Address) (u AddressUnion) {
581 func (u *AddressUnion) SetIP6(a IP6Address) {
582 buf := codec.NewBuffer(u.XXX_UnionData[:])
583 buf.EncodeBytes(a[:], 16)
585 func (u *AddressUnion) GetIP6() (a IP6Address) {
586 buf := codec.NewBuffer(u.XXX_UnionData[:])
587 copy(a[:], buf.DecodeBytes(16))