1 // Code generated by GoVPP's binapi-generator. DO NOT EDIT.
3 // binapi-generator: v0.4.0-dev
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 // IPFeatureLocation defines enum 'ip_feature_location'.
178 type IPFeatureLocation uint8
181 IP_API_FEATURE_INPUT IPFeatureLocation = 0
182 IP_API_FEATURE_OUTPUT IPFeatureLocation = 1
183 IP_API_FEATURE_LOCAL IPFeatureLocation = 2
184 IP_API_FEATURE_PUNT IPFeatureLocation = 3
185 IP_API_FEATURE_DROP IPFeatureLocation = 4
189 IPFeatureLocation_name = map[uint8]string{
190 0: "IP_API_FEATURE_INPUT",
191 1: "IP_API_FEATURE_OUTPUT",
192 2: "IP_API_FEATURE_LOCAL",
193 3: "IP_API_FEATURE_PUNT",
194 4: "IP_API_FEATURE_DROP",
196 IPFeatureLocation_value = map[string]uint8{
197 "IP_API_FEATURE_INPUT": 0,
198 "IP_API_FEATURE_OUTPUT": 1,
199 "IP_API_FEATURE_LOCAL": 2,
200 "IP_API_FEATURE_PUNT": 3,
201 "IP_API_FEATURE_DROP": 4,
205 func (x IPFeatureLocation) String() string {
206 s, ok := IPFeatureLocation_name[uint8(x)]
210 return "IPFeatureLocation(" + strconv.Itoa(int(x)) + ")"
213 // IPProto defines enum 'ip_proto'.
217 IP_API_PROTO_HOPOPT IPProto = 0
218 IP_API_PROTO_ICMP IPProto = 1
219 IP_API_PROTO_IGMP IPProto = 2
220 IP_API_PROTO_TCP IPProto = 6
221 IP_API_PROTO_UDP IPProto = 17
222 IP_API_PROTO_GRE IPProto = 47
223 IP_API_PROTO_ESP IPProto = 50
224 IP_API_PROTO_AH IPProto = 51
225 IP_API_PROTO_ICMP6 IPProto = 58
226 IP_API_PROTO_EIGRP IPProto = 88
227 IP_API_PROTO_OSPF IPProto = 89
228 IP_API_PROTO_SCTP IPProto = 132
229 IP_API_PROTO_RESERVED IPProto = 255
233 IPProto_name = map[uint8]string{
234 0: "IP_API_PROTO_HOPOPT",
235 1: "IP_API_PROTO_ICMP",
236 2: "IP_API_PROTO_IGMP",
237 6: "IP_API_PROTO_TCP",
238 17: "IP_API_PROTO_UDP",
239 47: "IP_API_PROTO_GRE",
240 50: "IP_API_PROTO_ESP",
241 51: "IP_API_PROTO_AH",
242 58: "IP_API_PROTO_ICMP6",
243 88: "IP_API_PROTO_EIGRP",
244 89: "IP_API_PROTO_OSPF",
245 132: "IP_API_PROTO_SCTP",
246 255: "IP_API_PROTO_RESERVED",
248 IPProto_value = map[string]uint8{
249 "IP_API_PROTO_HOPOPT": 0,
250 "IP_API_PROTO_ICMP": 1,
251 "IP_API_PROTO_IGMP": 2,
252 "IP_API_PROTO_TCP": 6,
253 "IP_API_PROTO_UDP": 17,
254 "IP_API_PROTO_GRE": 47,
255 "IP_API_PROTO_ESP": 50,
256 "IP_API_PROTO_AH": 51,
257 "IP_API_PROTO_ICMP6": 58,
258 "IP_API_PROTO_EIGRP": 88,
259 "IP_API_PROTO_OSPF": 89,
260 "IP_API_PROTO_SCTP": 132,
261 "IP_API_PROTO_RESERVED": 255,
265 func (x IPProto) String() string {
266 s, ok := IPProto_name[uint8(x)]
270 return "IPProto(" + strconv.Itoa(int(x)) + ")"
273 // AddressWithPrefix defines alias 'address_with_prefix'.
274 type AddressWithPrefix Prefix
276 func ParseAddressWithPrefix(s string) (AddressWithPrefix, error) {
277 prefix, err := ParsePrefix(s)
279 return AddressWithPrefix{}, err
281 return AddressWithPrefix(prefix), nil
283 func (x AddressWithPrefix) String() string {
284 return Prefix(x).String()
286 func (x *AddressWithPrefix) MarshalText() ([]byte, error) {
287 return []byte(x.String()), nil
289 func (x *AddressWithPrefix) UnmarshalText(text []byte) error {
290 prefix, err := ParseAddressWithPrefix(string(text))
298 // IP4Address defines alias 'ip4_address'.
299 type IP4Address [4]uint8
301 func ParseIP4Address(s string) (IP4Address, error) {
302 ip := net.ParseIP(s).To4()
304 return IP4Address{}, fmt.Errorf("invalid IP address: %s", s)
306 var ipaddr IP4Address
307 copy(ipaddr[:], ip.To4())
311 func (x IP4Address) ToIP() net.IP {
312 return net.IP(x[:]).To4()
314 func (x IP4Address) String() string {
315 return x.ToIP().String()
317 func (x *IP4Address) MarshalText() ([]byte, error) {
318 return []byte(x.String()), nil
320 func (x *IP4Address) UnmarshalText(text []byte) error {
321 ipaddr, err := ParseIP4Address(string(text))
329 // IP4AddressWithPrefix defines alias 'ip4_address_with_prefix'.
330 type IP4AddressWithPrefix IP4Prefix
332 // IP6Address defines alias 'ip6_address'.
333 type IP6Address [16]uint8
335 func ParseIP6Address(s string) (IP6Address, error) {
336 ip := net.ParseIP(s).To16()
338 return IP6Address{}, fmt.Errorf("invalid IP address: %s", s)
340 var ipaddr IP6Address
341 copy(ipaddr[:], ip.To16())
345 func (x IP6Address) ToIP() net.IP {
346 return net.IP(x[:]).To16()
348 func (x IP6Address) String() string {
349 return x.ToIP().String()
351 func (x *IP6Address) MarshalText() ([]byte, error) {
352 return []byte(x.String()), nil
354 func (x *IP6Address) UnmarshalText(text []byte) error {
355 ipaddr, err := ParseIP6Address(string(text))
363 // IP6AddressWithPrefix defines alias 'ip6_address_with_prefix'.
364 type IP6AddressWithPrefix IP6Prefix
366 // Address defines type 'address'.
367 type Address struct {
368 Af AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
369 Un AddressUnion `binapi:"address_union,name=un" json:"un,omitempty"`
372 func ParseAddress(s string) (Address, error) {
375 return Address{}, fmt.Errorf("invalid address: %s", s)
379 addr.Af = ADDRESS_IP6
381 copy(ip6[:], ip.To16())
384 addr.Af = ADDRESS_IP4
386 copy(ip4[:], ip.To4())
391 func (x Address) ToIP() net.IP {
392 if x.Af == ADDRESS_IP6 {
394 return net.IP(ip6[:]).To16()
397 return net.IP(ip4[:]).To4()
400 func (x Address) String() string {
401 return x.ToIP().String()
403 func (x *Address) MarshalText() ([]byte, error) {
404 return []byte(x.String()), nil
406 func (x *Address) UnmarshalText(text []byte) error {
407 addr, err := ParseAddress(string(text))
415 // IP4AddressAndMask defines type 'ip4_address_and_mask'.
416 type IP4AddressAndMask struct {
417 Addr IP4Address `binapi:"ip4_address,name=addr" json:"addr,omitempty"`
418 Mask IP4Address `binapi:"ip4_address,name=mask" json:"mask,omitempty"`
421 // IP4Prefix defines type 'ip4_prefix'.
422 type IP4Prefix struct {
423 Address IP4Address `binapi:"ip4_address,name=address" json:"address,omitempty"`
424 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
427 func ParseIP4Prefix(s string) (prefix IP4Prefix, err error) {
428 hasPrefix := strings.Contains(s, "/")
430 ip, network, err := net.ParseCIDR(s)
432 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
434 maskSize, _ := network.Mask.Size()
435 prefix.Len = byte(maskSize)
436 prefix.Address, err = ParseIP4Address(ip.String())
438 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
442 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
444 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
446 prefix.Len = byte(defaultMaskSize)
447 prefix.Address, err = ParseIP4Address(ip.String())
449 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
454 func (x IP4Prefix) ToIPNet() *net.IPNet {
455 mask := net.CIDRMask(int(x.Len), 32)
456 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
459 func (x IP4Prefix) String() string {
460 ip := x.Address.String()
461 return ip + "/" + strconv.Itoa(int(x.Len))
463 func (x *IP4Prefix) MarshalText() ([]byte, error) {
464 return []byte(x.String()), nil
466 func (x *IP4Prefix) UnmarshalText(text []byte) error {
467 prefix, err := ParseIP4Prefix(string(text))
475 // IP6AddressAndMask defines type 'ip6_address_and_mask'.
476 type IP6AddressAndMask struct {
477 Addr IP6Address `binapi:"ip6_address,name=addr" json:"addr,omitempty"`
478 Mask IP6Address `binapi:"ip6_address,name=mask" json:"mask,omitempty"`
481 // IP6Prefix defines type 'ip6_prefix'.
482 type IP6Prefix struct {
483 Address IP6Address `binapi:"ip6_address,name=address" json:"address,omitempty"`
484 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
487 func ParseIP6Prefix(s string) (prefix IP6Prefix, err error) {
488 hasPrefix := strings.Contains(s, "/")
490 ip, network, err := net.ParseCIDR(s)
492 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
494 maskSize, _ := network.Mask.Size()
495 prefix.Len = byte(maskSize)
496 prefix.Address, err = ParseIP6Address(ip.String())
498 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
502 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
504 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
506 prefix.Len = byte(defaultMaskSize)
507 prefix.Address, err = ParseIP6Address(ip.String())
509 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
514 func (x IP6Prefix) ToIPNet() *net.IPNet {
515 mask := net.CIDRMask(int(x.Len), 128)
516 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
519 func (x IP6Prefix) String() string {
520 ip := x.Address.String()
521 return ip + "/" + strconv.Itoa(int(x.Len))
523 func (x *IP6Prefix) MarshalText() ([]byte, error) {
524 return []byte(x.String()), nil
526 func (x *IP6Prefix) UnmarshalText(text []byte) error {
527 prefix, err := ParseIP6Prefix(string(text))
535 // Mprefix defines type 'mprefix'.
536 type Mprefix struct {
537 Af AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
538 GrpAddressLength uint16 `binapi:"u16,name=grp_address_length" json:"grp_address_length,omitempty"`
539 GrpAddress AddressUnion `binapi:"address_union,name=grp_address" json:"grp_address,omitempty"`
540 SrcAddress AddressUnion `binapi:"address_union,name=src_address" json:"src_address,omitempty"`
543 // Prefix defines type 'prefix'.
545 Address Address `binapi:"address,name=address" json:"address,omitempty"`
546 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
549 func ParsePrefix(ip string) (prefix Prefix, err error) {
550 hasPrefix := strings.Contains(ip, "/")
552 netIP, network, err := net.ParseCIDR(ip)
554 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
556 maskSize, _ := network.Mask.Size()
557 prefix.Len = byte(maskSize)
558 prefix.Address, err = ParseAddress(netIP.String())
560 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
563 netIP := net.ParseIP(ip)
564 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
565 if netIP.To4() == nil {
566 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
568 prefix.Len = byte(defaultMaskSize)
569 prefix.Address, err = ParseAddress(netIP.String())
571 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
576 func (x Prefix) ToIPNet() *net.IPNet {
578 if x.Address.Af == ADDRESS_IP4 {
579 mask = net.CIDRMask(int(x.Len), 32)
581 mask = net.CIDRMask(int(x.Len), 128)
583 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
586 func (x Prefix) String() string {
587 ip := x.Address.String()
588 return ip + "/" + strconv.Itoa(int(x.Len))
590 func (x *Prefix) MarshalText() ([]byte, error) {
591 return []byte(x.String()), nil
593 func (x *Prefix) UnmarshalText(text []byte) error {
594 prefix, err := ParsePrefix(string(text))
602 // PrefixMatcher defines type 'prefix_matcher'.
603 type PrefixMatcher struct {
604 Le uint8 `binapi:"u8,name=le" json:"le,omitempty"`
605 Ge uint8 `binapi:"u8,name=ge" json:"ge,omitempty"`
608 // AddressUnion defines union 'address_union'.
609 type AddressUnion struct {
610 // AddressUnion can be one of:
613 XXX_UnionData [16]byte
616 func AddressUnionIP4(a IP4Address) (u AddressUnion) {
620 func (u *AddressUnion) SetIP4(a IP4Address) {
621 buf := codec.NewBuffer(u.XXX_UnionData[:])
622 buf.EncodeBytes(a[:], 4)
624 func (u *AddressUnion) GetIP4() (a IP4Address) {
625 buf := codec.NewBuffer(u.XXX_UnionData[:])
626 copy(a[:], buf.DecodeBytes(4))
630 func AddressUnionIP6(a IP6Address) (u AddressUnion) {
634 func (u *AddressUnion) SetIP6(a IP6Address) {
635 buf := codec.NewBuffer(u.XXX_UnionData[:])
636 buf.EncodeBytes(a[:], 16)
638 func (u *AddressUnion) GetIP6() (a IP6Address) {
639 buf := codec.NewBuffer(u.XXX_UnionData[:])
640 copy(a[:], buf.DecodeBytes(16))