1 // Code generated by GoVPP's binapi-generator. DO NOT EDIT.
3 // binapi-generator: v0.4.0-dev
6 // Package ip_types contains generated bindings for API file ip_types.api.
22 api "git.fd.io/govpp.git/api"
23 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 uint8
36 ADDRESS_IP4 AddressFamily = 0
37 ADDRESS_IP6 AddressFamily = 1
41 AddressFamily_name = map[uint8]string{
45 AddressFamily_value = map[string]uint8{
51 func (x AddressFamily) String() string {
52 s, ok := AddressFamily_name[uint8(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_ESP IPProto = 50
187 IP_API_PROTO_AH IPProto = 51
188 IP_API_PROTO_ICMP6 IPProto = 58
189 IP_API_PROTO_EIGRP IPProto = 88
190 IP_API_PROTO_OSPF IPProto = 89
191 IP_API_PROTO_SCTP IPProto = 132
192 IP_API_PROTO_RESERVED IPProto = 255
196 IPProto_name = map[uint8]string{
197 0: "IP_API_PROTO_HOPOPT",
198 1: "IP_API_PROTO_ICMP",
199 2: "IP_API_PROTO_IGMP",
200 6: "IP_API_PROTO_TCP",
201 17: "IP_API_PROTO_UDP",
202 47: "IP_API_PROTO_GRE",
203 50: "IP_API_PROTO_ESP",
204 51: "IP_API_PROTO_AH",
205 58: "IP_API_PROTO_ICMP6",
206 88: "IP_API_PROTO_EIGRP",
207 89: "IP_API_PROTO_OSPF",
208 132: "IP_API_PROTO_SCTP",
209 255: "IP_API_PROTO_RESERVED",
211 IPProto_value = map[string]uint8{
212 "IP_API_PROTO_HOPOPT": 0,
213 "IP_API_PROTO_ICMP": 1,
214 "IP_API_PROTO_IGMP": 2,
215 "IP_API_PROTO_TCP": 6,
216 "IP_API_PROTO_UDP": 17,
217 "IP_API_PROTO_GRE": 47,
218 "IP_API_PROTO_ESP": 50,
219 "IP_API_PROTO_AH": 51,
220 "IP_API_PROTO_ICMP6": 58,
221 "IP_API_PROTO_EIGRP": 88,
222 "IP_API_PROTO_OSPF": 89,
223 "IP_API_PROTO_SCTP": 132,
224 "IP_API_PROTO_RESERVED": 255,
228 func (x IPProto) String() string {
229 s, ok := IPProto_name[uint8(x)]
233 return "IPProto(" + strconv.Itoa(int(x)) + ")"
236 // AddressWithPrefix defines alias 'address_with_prefix'.
237 type AddressWithPrefix Prefix
239 func ParseAddressWithPrefix(s string) (AddressWithPrefix, error) {
240 prefix, err := ParsePrefix(s)
242 return AddressWithPrefix{}, err
244 return AddressWithPrefix(prefix), nil
246 func (x AddressWithPrefix) String() string {
247 return Prefix(x).String()
249 func (x *AddressWithPrefix) MarshalText() ([]byte, error) {
250 return []byte(x.String()), nil
252 func (x *AddressWithPrefix) UnmarshalText(text []byte) error {
253 prefix, err := ParseAddressWithPrefix(string(text))
261 // IP4Address defines alias 'ip4_address'.
262 type IP4Address [4]uint8
264 func ParseIP4Address(s string) (IP4Address, error) {
265 ip := net.ParseIP(s).To4()
267 return IP4Address{}, fmt.Errorf("invalid IP address: %s", s)
269 var ipaddr IP4Address
270 copy(ipaddr[:], ip.To4())
274 func (x IP4Address) ToIP() net.IP {
275 return net.IP(x[:]).To4()
277 func (x IP4Address) String() string {
278 return x.ToIP().String()
280 func (x *IP4Address) MarshalText() ([]byte, error) {
281 return []byte(x.String()), nil
283 func (x *IP4Address) UnmarshalText(text []byte) error {
284 ipaddr, err := ParseIP4Address(string(text))
292 // IP4AddressWithPrefix defines alias 'ip4_address_with_prefix'.
293 type IP4AddressWithPrefix IP4Prefix
295 // IP6Address defines alias 'ip6_address'.
296 type IP6Address [16]uint8
298 func ParseIP6Address(s string) (IP6Address, error) {
299 ip := net.ParseIP(s).To16()
301 return IP6Address{}, fmt.Errorf("invalid IP address: %s", s)
303 var ipaddr IP6Address
304 copy(ipaddr[:], ip.To16())
308 func (x IP6Address) ToIP() net.IP {
309 return net.IP(x[:]).To16()
311 func (x IP6Address) String() string {
312 return x.ToIP().String()
314 func (x *IP6Address) MarshalText() ([]byte, error) {
315 return []byte(x.String()), nil
317 func (x *IP6Address) UnmarshalText(text []byte) error {
318 ipaddr, err := ParseIP6Address(string(text))
326 // IP6AddressWithPrefix defines alias 'ip6_address_with_prefix'.
327 type IP6AddressWithPrefix IP6Prefix
329 // Address defines type 'address'.
330 type Address struct {
331 Af AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
332 Un AddressUnion `binapi:"address_union,name=un" json:"un,omitempty"`
335 func ParseAddress(s string) (Address, error) {
338 return Address{}, fmt.Errorf("invalid address: %s", s)
342 addr.Af = ADDRESS_IP6
344 copy(ip6[:], ip.To16())
347 addr.Af = ADDRESS_IP4
349 copy(ip4[:], ip.To4())
354 func (x Address) ToIP() net.IP {
355 if x.Af == ADDRESS_IP6 {
357 return net.IP(ip6[:]).To16()
360 return net.IP(ip4[:]).To4()
363 func (x Address) String() string {
364 return x.ToIP().String()
366 func (x *Address) MarshalText() ([]byte, error) {
367 return []byte(x.String()), nil
369 func (x *Address) UnmarshalText(text []byte) error {
370 addr, err := ParseAddress(string(text))
378 // IP4Prefix defines type 'ip4_prefix'.
379 type IP4Prefix struct {
380 Address IP4Address `binapi:"ip4_address,name=address" json:"address,omitempty"`
381 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
384 func ParseIP4Prefix(s string) (prefix IP4Prefix, err error) {
385 hasPrefix := strings.Contains(s, "/")
387 ip, network, err := net.ParseCIDR(s)
389 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
391 maskSize, _ := network.Mask.Size()
392 prefix.Len = byte(maskSize)
393 prefix.Address, err = ParseIP4Address(ip.String())
395 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
399 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
401 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
403 prefix.Len = byte(defaultMaskSize)
404 prefix.Address, err = ParseIP4Address(ip.String())
406 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
411 func (x IP4Prefix) ToIPNet() *net.IPNet {
412 mask := net.CIDRMask(int(x.Len), 32)
413 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
416 func (x IP4Prefix) String() string {
417 ip := x.Address.String()
418 return ip + "/" + strconv.Itoa(int(x.Len))
420 func (x *IP4Prefix) MarshalText() ([]byte, error) {
421 return []byte(x.String()), nil
423 func (x *IP4Prefix) UnmarshalText(text []byte) error {
424 prefix, err := ParseIP4Prefix(string(text))
432 // IP6Prefix defines type 'ip6_prefix'.
433 type IP6Prefix struct {
434 Address IP6Address `binapi:"ip6_address,name=address" json:"address,omitempty"`
435 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
438 func ParseIP6Prefix(s string) (prefix IP6Prefix, err error) {
439 hasPrefix := strings.Contains(s, "/")
441 ip, network, err := net.ParseCIDR(s)
443 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
445 maskSize, _ := network.Mask.Size()
446 prefix.Len = byte(maskSize)
447 prefix.Address, err = ParseIP6Address(ip.String())
449 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
453 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
455 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
457 prefix.Len = byte(defaultMaskSize)
458 prefix.Address, err = ParseIP6Address(ip.String())
460 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
465 func (x IP6Prefix) ToIPNet() *net.IPNet {
466 mask := net.CIDRMask(int(x.Len), 128)
467 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
470 func (x IP6Prefix) String() string {
471 ip := x.Address.String()
472 return ip + "/" + strconv.Itoa(int(x.Len))
474 func (x *IP6Prefix) MarshalText() ([]byte, error) {
475 return []byte(x.String()), nil
477 func (x *IP6Prefix) UnmarshalText(text []byte) error {
478 prefix, err := ParseIP6Prefix(string(text))
486 // Mprefix defines type 'mprefix'.
487 type Mprefix struct {
488 Af AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
489 GrpAddressLength uint16 `binapi:"u16,name=grp_address_length" json:"grp_address_length,omitempty"`
490 GrpAddress AddressUnion `binapi:"address_union,name=grp_address" json:"grp_address,omitempty"`
491 SrcAddress AddressUnion `binapi:"address_union,name=src_address" json:"src_address,omitempty"`
494 // Prefix defines type 'prefix'.
496 Address Address `binapi:"address,name=address" json:"address,omitempty"`
497 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
500 func ParsePrefix(ip string) (prefix Prefix, err error) {
501 hasPrefix := strings.Contains(ip, "/")
503 netIP, network, err := net.ParseCIDR(ip)
505 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
507 maskSize, _ := network.Mask.Size()
508 prefix.Len = byte(maskSize)
509 prefix.Address, err = ParseAddress(netIP.String())
511 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
514 netIP := net.ParseIP(ip)
515 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
516 if netIP.To4() == nil {
517 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
519 prefix.Len = byte(defaultMaskSize)
520 prefix.Address, err = ParseAddress(netIP.String())
522 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
527 func (x Prefix) ToIPNet() *net.IPNet {
529 if x.Address.Af == ADDRESS_IP4 {
530 mask = net.CIDRMask(int(x.Len), 32)
532 mask = net.CIDRMask(int(x.Len), 128)
534 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
537 func (x Prefix) String() string {
538 ip := x.Address.String()
539 return ip + "/" + strconv.Itoa(int(x.Len))
541 func (x *Prefix) MarshalText() ([]byte, error) {
542 return []byte(x.String()), nil
544 func (x *Prefix) UnmarshalText(text []byte) error {
545 prefix, err := ParsePrefix(string(text))
553 // PrefixMatcher defines type 'prefix_matcher'.
554 type PrefixMatcher struct {
555 Le uint8 `binapi:"u8,name=le" json:"le,omitempty"`
556 Ge uint8 `binapi:"u8,name=ge" json:"ge,omitempty"`
559 // AddressUnion defines union 'address_union'.
560 type AddressUnion struct {
563 XXX_UnionData [16]byte
566 func AddressUnionIP4(a IP4Address) (u AddressUnion) {
570 func (u *AddressUnion) SetIP4(a IP4Address) {
571 buf := codec.NewBuffer(u.XXX_UnionData[:])
572 buf.EncodeBytes(a[:], 4)
574 func (u *AddressUnion) GetIP4() (a IP4Address) {
575 buf := codec.NewBuffer(u.XXX_UnionData[:])
576 copy(a[:], buf.DecodeBytes(4))
580 func AddressUnionIP6(a IP6Address) (u AddressUnion) {
584 func (u *AddressUnion) SetIP6(a IP6Address) {
585 buf := codec.NewBuffer(u.XXX_UnionData[:])
586 buf.EncodeBytes(a[:], 16)
588 func (u *AddressUnion) GetIP6() (a IP6Address) {
589 buf := codec.NewBuffer(u.XXX_UnionData[:])
590 copy(a[:], buf.DecodeBytes(16))