1 // Code generated by GoVPP's binapi-generator. DO NOT EDIT.
3 // binapi-generator: v0.5.0-dev
5 // source: .vppapi/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
36 VersionCrc = 0x80424562
39 // AddressFamily defines enum 'address_family'.
40 type AddressFamily uint32
43 ADDRESS_IP4 AddressFamily = 0
44 ADDRESS_IP6 AddressFamily = 1
48 AddressFamily_name = map[uint32]string{
52 AddressFamily_value = map[string]uint32{
58 func (x AddressFamily) String() string {
59 s, ok := AddressFamily_name[uint32(x)]
63 return "AddressFamily(" + strconv.Itoa(int(x)) + ")"
66 // IPDscp defines enum 'ip_dscp'.
70 IP_API_DSCP_CS0 IPDscp = 0
71 IP_API_DSCP_CS1 IPDscp = 8
72 IP_API_DSCP_AF11 IPDscp = 10
73 IP_API_DSCP_AF12 IPDscp = 12
74 IP_API_DSCP_AF13 IPDscp = 14
75 IP_API_DSCP_CS2 IPDscp = 16
76 IP_API_DSCP_AF21 IPDscp = 18
77 IP_API_DSCP_AF22 IPDscp = 20
78 IP_API_DSCP_AF23 IPDscp = 22
79 IP_API_DSCP_CS3 IPDscp = 24
80 IP_API_DSCP_AF31 IPDscp = 26
81 IP_API_DSCP_AF32 IPDscp = 28
82 IP_API_DSCP_AF33 IPDscp = 30
83 IP_API_DSCP_CS4 IPDscp = 32
84 IP_API_DSCP_AF41 IPDscp = 34
85 IP_API_DSCP_AF42 IPDscp = 36
86 IP_API_DSCP_AF43 IPDscp = 38
87 IP_API_DSCP_CS5 IPDscp = 40
88 IP_API_DSCP_EF IPDscp = 46
89 IP_API_DSCP_CS6 IPDscp = 48
90 IP_API_DSCP_CS7 IPDscp = 50
94 IPDscp_name = map[uint8]string{
97 10: "IP_API_DSCP_AF11",
98 12: "IP_API_DSCP_AF12",
99 14: "IP_API_DSCP_AF13",
100 16: "IP_API_DSCP_CS2",
101 18: "IP_API_DSCP_AF21",
102 20: "IP_API_DSCP_AF22",
103 22: "IP_API_DSCP_AF23",
104 24: "IP_API_DSCP_CS3",
105 26: "IP_API_DSCP_AF31",
106 28: "IP_API_DSCP_AF32",
107 30: "IP_API_DSCP_AF33",
108 32: "IP_API_DSCP_CS4",
109 34: "IP_API_DSCP_AF41",
110 36: "IP_API_DSCP_AF42",
111 38: "IP_API_DSCP_AF43",
112 40: "IP_API_DSCP_CS5",
113 46: "IP_API_DSCP_EF",
114 48: "IP_API_DSCP_CS6",
115 50: "IP_API_DSCP_CS7",
117 IPDscp_value = map[string]uint8{
118 "IP_API_DSCP_CS0": 0,
119 "IP_API_DSCP_CS1": 8,
120 "IP_API_DSCP_AF11": 10,
121 "IP_API_DSCP_AF12": 12,
122 "IP_API_DSCP_AF13": 14,
123 "IP_API_DSCP_CS2": 16,
124 "IP_API_DSCP_AF21": 18,
125 "IP_API_DSCP_AF22": 20,
126 "IP_API_DSCP_AF23": 22,
127 "IP_API_DSCP_CS3": 24,
128 "IP_API_DSCP_AF31": 26,
129 "IP_API_DSCP_AF32": 28,
130 "IP_API_DSCP_AF33": 30,
131 "IP_API_DSCP_CS4": 32,
132 "IP_API_DSCP_AF41": 34,
133 "IP_API_DSCP_AF42": 36,
134 "IP_API_DSCP_AF43": 38,
135 "IP_API_DSCP_CS5": 40,
136 "IP_API_DSCP_EF": 46,
137 "IP_API_DSCP_CS6": 48,
138 "IP_API_DSCP_CS7": 50,
142 func (x IPDscp) String() string {
143 s, ok := IPDscp_name[uint8(x)]
147 return "IPDscp(" + strconv.Itoa(int(x)) + ")"
150 // IPEcn defines enum 'ip_ecn'.
154 IP_API_ECN_NONE IPEcn = 0
155 IP_API_ECN_ECT0 IPEcn = 1
156 IP_API_ECN_ECT1 IPEcn = 2
157 IP_API_ECN_CE IPEcn = 3
161 IPEcn_name = map[uint8]string{
162 0: "IP_API_ECN_NONE",
163 1: "IP_API_ECN_ECT0",
164 2: "IP_API_ECN_ECT1",
167 IPEcn_value = map[string]uint8{
168 "IP_API_ECN_NONE": 0,
169 "IP_API_ECN_ECT0": 1,
170 "IP_API_ECN_ECT1": 2,
175 func (x IPEcn) String() string {
176 s, ok := IPEcn_name[uint8(x)]
180 return "IPEcn(" + strconv.Itoa(int(x)) + ")"
183 // IPProto defines enum 'ip_proto'.
187 IP_API_PROTO_HOPOPT IPProto = 0
188 IP_API_PROTO_ICMP IPProto = 1
189 IP_API_PROTO_IGMP IPProto = 2
190 IP_API_PROTO_TCP IPProto = 6
191 IP_API_PROTO_UDP IPProto = 17
192 IP_API_PROTO_GRE IPProto = 47
193 IP_API_PROTO_AH IPProto = 50
194 IP_API_PROTO_ESP IPProto = 51
195 IP_API_PROTO_EIGRP IPProto = 88
196 IP_API_PROTO_OSPF IPProto = 89
197 IP_API_PROTO_SCTP IPProto = 132
198 IP_API_PROTO_RESERVED IPProto = 255
202 IPProto_name = map[uint32]string{
203 0: "IP_API_PROTO_HOPOPT",
204 1: "IP_API_PROTO_ICMP",
205 2: "IP_API_PROTO_IGMP",
206 6: "IP_API_PROTO_TCP",
207 17: "IP_API_PROTO_UDP",
208 47: "IP_API_PROTO_GRE",
209 50: "IP_API_PROTO_AH",
210 51: "IP_API_PROTO_ESP",
211 88: "IP_API_PROTO_EIGRP",
212 89: "IP_API_PROTO_OSPF",
213 132: "IP_API_PROTO_SCTP",
214 255: "IP_API_PROTO_RESERVED",
216 IPProto_value = map[string]uint32{
217 "IP_API_PROTO_HOPOPT": 0,
218 "IP_API_PROTO_ICMP": 1,
219 "IP_API_PROTO_IGMP": 2,
220 "IP_API_PROTO_TCP": 6,
221 "IP_API_PROTO_UDP": 17,
222 "IP_API_PROTO_GRE": 47,
223 "IP_API_PROTO_AH": 50,
224 "IP_API_PROTO_ESP": 51,
225 "IP_API_PROTO_EIGRP": 88,
226 "IP_API_PROTO_OSPF": 89,
227 "IP_API_PROTO_SCTP": 132,
228 "IP_API_PROTO_RESERVED": 255,
232 func (x IPProto) String() string {
233 s, ok := IPProto_name[uint32(x)]
237 return "IPProto(" + strconv.Itoa(int(x)) + ")"
240 // AddressWithPrefix defines alias 'address_with_prefix'.
241 type AddressWithPrefix Prefix
243 func ParseAddressWithPrefix(s string) (AddressWithPrefix, error) {
244 prefix, err := ParsePrefix(s)
246 return AddressWithPrefix{}, err
248 return AddressWithPrefix(prefix), nil
251 func (x AddressWithPrefix) String() string {
252 return Prefix(x).String()
255 func (x *AddressWithPrefix) MarshalText() ([]byte, error) {
256 return []byte(x.String()), nil
259 func (x *AddressWithPrefix) UnmarshalText(text []byte) error {
260 prefix, err := ParseAddressWithPrefix(string(text))
268 // IP4Address defines alias 'ip4_address'.
269 type IP4Address [4]uint8
271 func ParseIP4Address(s string) (IP4Address, error) {
272 ip := net.ParseIP(s).To4()
274 return IP4Address{}, fmt.Errorf("invalid IP address: %s", s)
276 var ipaddr IP4Address
277 copy(ipaddr[:], ip.To4())
281 func (x IP4Address) ToIP() net.IP {
282 return net.IP(x[:]).To4()
285 func (x IP4Address) String() string {
286 return x.ToIP().String()
289 func (x *IP4Address) MarshalText() ([]byte, error) {
290 return []byte(x.String()), nil
293 func (x *IP4Address) UnmarshalText(text []byte) error {
294 ipaddr, err := ParseIP4Address(string(text))
302 // IP4AddressWithPrefix defines alias 'ip4_address_with_prefix'.
303 type IP4AddressWithPrefix IP4Prefix
305 // IP6Address defines alias 'ip6_address'.
306 type IP6Address [16]uint8
308 func ParseIP6Address(s string) (IP6Address, error) {
309 ip := net.ParseIP(s).To16()
311 return IP6Address{}, fmt.Errorf("invalid IP address: %s", s)
313 var ipaddr IP6Address
314 copy(ipaddr[:], ip.To16())
318 func (x IP6Address) ToIP() net.IP {
319 return net.IP(x[:]).To16()
322 func (x IP6Address) String() string {
323 return x.ToIP().String()
326 func (x *IP6Address) MarshalText() ([]byte, error) {
327 return []byte(x.String()), nil
330 func (x *IP6Address) UnmarshalText(text []byte) error {
331 ipaddr, err := ParseIP6Address(string(text))
339 // IP6AddressWithPrefix defines alias 'ip6_address_with_prefix'.
340 type IP6AddressWithPrefix IP6Prefix
342 // Address defines type 'address'.
343 type Address struct {
344 Af AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
345 Un AddressUnion `binapi:"address_union,name=un" json:"un,omitempty"`
348 func ParseAddress(s string) (Address, error) {
351 return Address{}, fmt.Errorf("invalid address: %s", s)
353 return AddressFromIP(ip), nil
356 func AddressFromIP(ip net.IP) Address {
359 addr.Af = ADDRESS_IP6
361 copy(ip6[:], ip.To16())
364 addr.Af = ADDRESS_IP4
366 copy(ip4[:], ip.To4())
372 func (x Address) ToIP() net.IP {
373 if x.Af == ADDRESS_IP6 {
375 return net.IP(ip6[:]).To16()
378 return net.IP(ip4[:]).To4()
382 func (x Address) String() string {
383 return x.ToIP().String()
386 func (x *Address) MarshalText() ([]byte, error) {
387 return []byte(x.String()), nil
390 func (x *Address) UnmarshalText(text []byte) error {
391 addr, err := ParseAddress(string(text))
399 // IP4Prefix defines type 'ip4_prefix'.
400 type IP4Prefix struct {
401 Address IP4Address `binapi:"ip4_address,name=address" json:"address,omitempty"`
402 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
405 func ParseIP4Prefix(s string) (prefix IP4Prefix, err error) {
406 hasPrefix := strings.Contains(s, "/")
408 ip, network, err := net.ParseCIDR(s)
410 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
412 maskSize, _ := network.Mask.Size()
413 prefix.Len = byte(maskSize)
414 prefix.Address, err = ParseIP4Address(ip.String())
416 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
420 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
422 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
424 prefix.Len = byte(defaultMaskSize)
425 prefix.Address, err = ParseIP4Address(ip.String())
427 return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
433 func (x IP4Prefix) ToIPNet() *net.IPNet {
434 mask := net.CIDRMask(int(x.Len), 32)
435 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
439 func (x IP4Prefix) String() string {
440 ip := x.Address.String()
441 return ip + "/" + strconv.Itoa(int(x.Len))
444 func (x *IP4Prefix) MarshalText() ([]byte, error) {
445 return []byte(x.String()), nil
448 func (x *IP4Prefix) UnmarshalText(text []byte) error {
449 prefix, err := ParseIP4Prefix(string(text))
457 // IP6Prefix defines type 'ip6_prefix'.
458 type IP6Prefix struct {
459 Address IP6Address `binapi:"ip6_address,name=address" json:"address,omitempty"`
460 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
463 func ParseIP6Prefix(s string) (prefix IP6Prefix, err error) {
464 hasPrefix := strings.Contains(s, "/")
466 ip, network, err := net.ParseCIDR(s)
468 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
470 maskSize, _ := network.Mask.Size()
471 prefix.Len = byte(maskSize)
472 prefix.Address, err = ParseIP6Address(ip.String())
474 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
478 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
480 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
482 prefix.Len = byte(defaultMaskSize)
483 prefix.Address, err = ParseIP6Address(ip.String())
485 return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
491 func (x IP6Prefix) ToIPNet() *net.IPNet {
492 mask := net.CIDRMask(int(x.Len), 128)
493 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
497 func (x IP6Prefix) String() string {
498 ip := x.Address.String()
499 return ip + "/" + strconv.Itoa(int(x.Len))
502 func (x *IP6Prefix) MarshalText() ([]byte, error) {
503 return []byte(x.String()), nil
506 func (x *IP6Prefix) UnmarshalText(text []byte) error {
507 prefix, err := ParseIP6Prefix(string(text))
515 // Mprefix defines type 'mprefix'.
516 type Mprefix struct {
517 Af AddressFamily `binapi:"address_family,name=af" json:"af,omitempty"`
518 GrpAddressLength uint16 `binapi:"u16,name=grp_address_length" json:"grp_address_length,omitempty"`
519 GrpAddress AddressUnion `binapi:"address_union,name=grp_address" json:"grp_address,omitempty"`
520 SrcAddress AddressUnion `binapi:"address_union,name=src_address" json:"src_address,omitempty"`
523 // Prefix defines type 'prefix'.
525 Address Address `binapi:"address,name=address" json:"address,omitempty"`
526 Len uint8 `binapi:"u8,name=len" json:"len,omitempty"`
529 func ParsePrefix(ip string) (prefix Prefix, err error) {
530 hasPrefix := strings.Contains(ip, "/")
532 netIP, network, err := net.ParseCIDR(ip)
534 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
536 maskSize, _ := network.Mask.Size()
537 prefix.Len = byte(maskSize)
538 prefix.Address, err = ParseAddress(netIP.String())
540 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
543 netIP := net.ParseIP(ip)
544 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
545 if netIP.To4() == nil {
546 defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
548 prefix.Len = byte(defaultMaskSize)
549 prefix.Address, err = ParseAddress(netIP.String())
551 return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
557 func (x Prefix) ToIPNet() *net.IPNet {
559 if x.Address.Af == ADDRESS_IP4 {
560 mask = net.CIDRMask(int(x.Len), 32)
562 mask = net.CIDRMask(int(x.Len), 128)
564 ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
568 func (x Prefix) String() string {
569 ip := x.Address.String()
570 return ip + "/" + strconv.Itoa(int(x.Len))
573 func (x *Prefix) MarshalText() ([]byte, error) {
574 return []byte(x.String()), nil
577 func (x *Prefix) UnmarshalText(text []byte) error {
578 prefix, err := ParsePrefix(string(text))
586 // PrefixMatcher defines type 'prefix_matcher'.
587 type PrefixMatcher struct {
588 Le uint8 `binapi:"u8,name=le" json:"le,omitempty"`
589 Ge uint8 `binapi:"u8,name=ge" json:"ge,omitempty"`
592 // AddressUnion defines union 'address_union'.
593 type AddressUnion struct {
594 // AddressUnion can be one of:
597 XXX_UnionData [16]byte
600 func AddressUnionIP4(a IP4Address) (u AddressUnion) {
604 func (u *AddressUnion) SetIP4(a IP4Address) {
605 buf := codec.NewBuffer(u.XXX_UnionData[:])
606 buf.EncodeBytes(a[:], 4)
608 func (u *AddressUnion) GetIP4() (a IP4Address) {
609 buf := codec.NewBuffer(u.XXX_UnionData[:])
610 copy(a[:], buf.DecodeBytes(4))
614 func AddressUnionIP6(a IP6Address) (u AddressUnion) {
618 func (u *AddressUnion) SetIP6(a IP6Address) {
619 buf := codec.NewBuffer(u.XXX_UnionData[:])
620 buf.EncodeBytes(a[:], 16)
622 func (u *AddressUnion) GetIP6() (a IP6Address) {
623 buf := codec.NewBuffer(u.XXX_UnionData[:])
624 copy(a[:], buf.DecodeBytes(16))