internal/testbinapi/binapi2001/ip_types/ip_types.ba.go

   1 // Code generated by GoVPP's binapi-generator. DO NOT EDIT.
   2 // versions:
   3 //  binapi-generator: v0.4.0-dev
   4 //  VPP:              20.01
   5 // source: .vppapi/core/ip_types.api.json
   6
   7 // Package ip_types contains generated bindings for API file ip_types.api.
   8 //
   9 // Contents:
  10 //   5 aliases
  11 //   4 enums
  12 //   6 structs
  13 //   1 union
  14 //
  15 package ip_types
  16
  17 import (
  18         "fmt"
  19         api "git.fd.io/govpp.git/api"
  20         codec "git.fd.io/govpp.git/codec"
  21         "net"
  22         "strconv"
  23         "strings"
  24 )
  25
  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
  31
  32 // AddressFamily defines enum 'address_family'.
  33 type AddressFamily uint32
  34
  35 const (
  36         ADDRESS_IP4 AddressFamily = 0
  37         ADDRESS_IP6 AddressFamily = 1
  38 )
  39
  40 var (
  41         AddressFamily_name = map[uint32]string{
  42                 0: "ADDRESS_IP4",
  43                 1: "ADDRESS_IP6",
  44         }
  45         AddressFamily_value = map[string]uint32{
  46                 "ADDRESS_IP4": 0,
  47                 "ADDRESS_IP6": 1,
  48         }
  49 )
  50
  51 func (x AddressFamily) String() string {
  52         s, ok := AddressFamily_name[uint32(x)]
  53         if ok {
  54                 return s
  55         }
  56         return "AddressFamily(" + strconv.Itoa(int(x)) + ")"
  57 }
  58
  59 // IPDscp defines enum 'ip_dscp'.
  60 type IPDscp uint8
  61
  62 const (
  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
  84 )
  85
  86 var (
  87         IPDscp_name = map[uint8]string{
  88                 0:  "IP_API_DSCP_CS0",
  89                 8:  "IP_API_DSCP_CS1",
  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",
 109         }
 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,
 132         }
 133 )
 134
 135 func (x IPDscp) String() string {
 136         s, ok := IPDscp_name[uint8(x)]
 137         if ok {
 138                 return s
 139         }
 140         return "IPDscp(" + strconv.Itoa(int(x)) + ")"
 141 }
 142
 143 // IPEcn defines enum 'ip_ecn'.
 144 type IPEcn uint8
 145
 146 const (
 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
 151 )
 152
 153 var (
 154         IPEcn_name = map[uint8]string{
 155                 0: "IP_API_ECN_NONE",
 156                 1: "IP_API_ECN_ECT0",
 157                 2: "IP_API_ECN_ECT1",
 158                 3: "IP_API_ECN_CE",
 159         }
 160         IPEcn_value = map[string]uint8{
 161                 "IP_API_ECN_NONE": 0,
 162                 "IP_API_ECN_ECT0": 1,
 163                 "IP_API_ECN_ECT1": 2,
 164                 "IP_API_ECN_CE":   3,
 165         }
 166 )
 167
 168 func (x IPEcn) String() string {
 169         s, ok := IPEcn_name[uint8(x)]
 170         if ok {
 171                 return s
 172         }
 173         return "IPEcn(" + strconv.Itoa(int(x)) + ")"
 174 }
 175
 176 // IPProto defines enum 'ip_proto'.
 177 type IPProto uint32
 178
 179 const (
 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
 192 )
 193
 194 var (
 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",
 208         }
 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,
 222         }
 223 )
 224
 225 func (x IPProto) String() string {
 226         s, ok := IPProto_name[uint32(x)]
 227         if ok {
 228                 return s
 229         }
 230         return "IPProto(" + strconv.Itoa(int(x)) + ")"
 231 }
 232
 233 // AddressWithPrefix defines alias 'address_with_prefix'.
 234 type AddressWithPrefix Prefix
 235
 236 func ParseAddressWithPrefix(s string) (AddressWithPrefix, error) {
 237         prefix, err := ParsePrefix(s)
 238         if err != nil {
 239                 return AddressWithPrefix{}, err
 240         }
 241         return AddressWithPrefix(prefix), nil
 242 }
 243 func (x AddressWithPrefix) String() string {
 244         return Prefix(x).String()
 245 }
 246 func (x *AddressWithPrefix) MarshalText() ([]byte, error) {
 247         return []byte(x.String()), nil
 248 }
 249 func (x *AddressWithPrefix) UnmarshalText(text []byte) error {
 250         prefix, err := ParseAddressWithPrefix(string(text))
 251         if err != nil {
 252                 return err
 253         }
 254         *x = prefix
 255         return nil
 256 }
 257
 258 // IP4Address defines alias 'ip4_address'.
 259 type IP4Address [4]uint8
 260
 261 func ParseIP4Address(s string) (IP4Address, error) {
 262         ip := net.ParseIP(s).To4()
 263         if ip == nil {
 264                 return IP4Address{}, fmt.Errorf("invalid IP address: %s", s)
 265         }
 266         var ipaddr IP4Address
 267         copy(ipaddr[:], ip.To4())
 268         return ipaddr, nil
 269 }
 270
 271 func (x IP4Address) ToIP() net.IP {
 272         return net.IP(x[:]).To4()
 273 }
 274 func (x IP4Address) String() string {
 275         return x.ToIP().String()
 276 }
 277 func (x *IP4Address) MarshalText() ([]byte, error) {
 278         return []byte(x.String()), nil
 279 }
 280 func (x *IP4Address) UnmarshalText(text []byte) error {
 281         ipaddr, err := ParseIP4Address(string(text))
 282         if err != nil {
 283                 return err
 284         }
 285         *x = ipaddr
 286         return nil
 287 }
 288
 289 // IP4AddressWithPrefix defines alias 'ip4_address_with_prefix'.
 290 type IP4AddressWithPrefix IP4Prefix
 291
 292 // IP6Address defines alias 'ip6_address'.
 293 type IP6Address [16]uint8
 294
 295 func ParseIP6Address(s string) (IP6Address, error) {
 296         ip := net.ParseIP(s).To16()
 297         if ip == nil {
 298                 return IP6Address{}, fmt.Errorf("invalid IP address: %s", s)
 299         }
 300         var ipaddr IP6Address
 301         copy(ipaddr[:], ip.To16())
 302         return ipaddr, nil
 303 }
 304
 305 func (x IP6Address) ToIP() net.IP {
 306         return net.IP(x[:]).To16()
 307 }
 308 func (x IP6Address) String() string {
 309         return x.ToIP().String()
 310 }
 311 func (x *IP6Address) MarshalText() ([]byte, error) {
 312         return []byte(x.String()), nil
 313 }
 314 func (x *IP6Address) UnmarshalText(text []byte) error {
 315         ipaddr, err := ParseIP6Address(string(text))
 316         if err != nil {
 317                 return err
 318         }
 319         *x = ipaddr
 320         return nil
 321 }
 322
 323 // IP6AddressWithPrefix defines alias 'ip6_address_with_prefix'.
 324 type IP6AddressWithPrefix IP6Prefix
 325
 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"`
 330 }
 331
 332 func ParseAddress(s string) (Address, error) {
 333         ip := net.ParseIP(s)
 334         if ip == nil {
 335                 return Address{}, fmt.Errorf("invalid address: %s", s)
 336         }
 337         var addr Address
 338         if ip.To4() == nil {
 339                 addr.Af = ADDRESS_IP6
 340                 var ip6 IP6Address
 341                 copy(ip6[:], ip.To16())
 342                 addr.Un.SetIP6(ip6)
 343         } else {
 344                 addr.Af = ADDRESS_IP4
 345                 var ip4 IP4Address
 346                 copy(ip4[:], ip.To4())
 347                 addr.Un.SetIP4(ip4)
 348         }
 349         return addr, nil
 350 }
 351 func (x Address) ToIP() net.IP {
 352         if x.Af == ADDRESS_IP6 {
 353                 ip6 := x.Un.GetIP6()
 354                 return net.IP(ip6[:]).To16()
 355         } else {
 356                 ip4 := x.Un.GetIP4()
 357                 return net.IP(ip4[:]).To4()
 358         }
 359 }
 360 func (x Address) String() string {
 361         return x.ToIP().String()
 362 }
 363 func (x *Address) MarshalText() ([]byte, error) {
 364         return []byte(x.String()), nil
 365 }
 366 func (x *Address) UnmarshalText(text []byte) error {
 367         addr, err := ParseAddress(string(text))
 368         if err != nil {
 369                 return err
 370         }
 371         *x = addr
 372         return nil
 373 }
 374
 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"`
 379 }
 380
 381 func ParseIP4Prefix(s string) (prefix IP4Prefix, err error) {
 382         hasPrefix := strings.Contains(s, "/")
 383         if hasPrefix {
 384                 ip, network, err := net.ParseCIDR(s)
 385                 if err != nil {
 386                         return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
 387                 }
 388                 maskSize, _ := network.Mask.Size()
 389                 prefix.Len = byte(maskSize)
 390                 prefix.Address, err = ParseIP4Address(ip.String())
 391                 if err != nil {
 392                         return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
 393                 }
 394         } else {
 395                 ip := net.ParseIP(s)
 396                 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
 397                 if ip.To4() == nil {
 398                         defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
 399                 }
 400                 prefix.Len = byte(defaultMaskSize)
 401                 prefix.Address, err = ParseIP4Address(ip.String())
 402                 if err != nil {
 403                         return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
 404                 }
 405         }
 406         return prefix, nil
 407 }
 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}
 411         return ipnet
 412 }
 413 func (x IP4Prefix) String() string {
 414         ip := x.Address.String()
 415         return ip + "/" + strconv.Itoa(int(x.Len))
 416 }
 417 func (x *IP4Prefix) MarshalText() ([]byte, error) {
 418         return []byte(x.String()), nil
 419 }
 420 func (x *IP4Prefix) UnmarshalText(text []byte) error {
 421         prefix, err := ParseIP4Prefix(string(text))
 422         if err != nil {
 423                 return err
 424         }
 425         *x = prefix
 426         return nil
 427 }
 428
 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"`
 433 }
 434
 435 func ParseIP6Prefix(s string) (prefix IP6Prefix, err error) {
 436         hasPrefix := strings.Contains(s, "/")
 437         if hasPrefix {
 438                 ip, network, err := net.ParseCIDR(s)
 439                 if err != nil {
 440                         return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
 441                 }
 442                 maskSize, _ := network.Mask.Size()
 443                 prefix.Len = byte(maskSize)
 444                 prefix.Address, err = ParseIP6Address(ip.String())
 445                 if err != nil {
 446                         return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
 447                 }
 448         } else {
 449                 ip := net.ParseIP(s)
 450                 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
 451                 if ip.To4() == nil {
 452                         defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
 453                 }
 454                 prefix.Len = byte(defaultMaskSize)
 455                 prefix.Address, err = ParseIP6Address(ip.String())
 456                 if err != nil {
 457                         return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
 458                 }
 459         }
 460         return prefix, nil
 461 }
 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}
 465         return ipnet
 466 }
 467 func (x IP6Prefix) String() string {
 468         ip := x.Address.String()
 469         return ip + "/" + strconv.Itoa(int(x.Len))
 470 }
 471 func (x *IP6Prefix) MarshalText() ([]byte, error) {
 472         return []byte(x.String()), nil
 473 }
 474 func (x *IP6Prefix) UnmarshalText(text []byte) error {
 475         prefix, err := ParseIP6Prefix(string(text))
 476         if err != nil {
 477                 return err
 478         }
 479         *x = prefix
 480         return nil
 481 }
 482
 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"`
 489 }
 490
 491 // Prefix defines type 'prefix'.
 492 type Prefix struct {
 493         Address Address `binapi:"address,name=address" json:"address,omitempty"`
 494         Len     uint8   `binapi:"u8,name=len" json:"len,omitempty"`
 495 }
 496
 497 func ParsePrefix(ip string) (prefix Prefix, err error) {
 498         hasPrefix := strings.Contains(ip, "/")
 499         if hasPrefix {
 500                 netIP, network, err := net.ParseCIDR(ip)
 501                 if err != nil {
 502                         return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
 503                 }
 504                 maskSize, _ := network.Mask.Size()
 505                 prefix.Len = byte(maskSize)
 506                 prefix.Address, err = ParseAddress(netIP.String())
 507                 if err != nil {
 508                         return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
 509                 }
 510         } else {
 511                 netIP := net.ParseIP(ip)
 512                 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
 513                 if netIP.To4() == nil {
 514                         defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
 515                 }
 516                 prefix.Len = byte(defaultMaskSize)
 517                 prefix.Address, err = ParseAddress(netIP.String())
 518                 if err != nil {
 519                         return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
 520                 }
 521         }
 522         return prefix, nil
 523 }
 524 func (x Prefix) ToIPNet() *net.IPNet {
 525         var mask net.IPMask
 526         if x.Address.Af == ADDRESS_IP4 {
 527                 mask = net.CIDRMask(int(x.Len), 32)
 528         } else {
 529                 mask = net.CIDRMask(int(x.Len), 128)
 530         }
 531         ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
 532         return ipnet
 533 }
 534 func (x Prefix) String() string {
 535         ip := x.Address.String()
 536         return ip + "/" + strconv.Itoa(int(x.Len))
 537 }
 538 func (x *Prefix) MarshalText() ([]byte, error) {
 539         return []byte(x.String()), nil
 540 }
 541 func (x *Prefix) UnmarshalText(text []byte) error {
 542         prefix, err := ParsePrefix(string(text))
 543         if err != nil {
 544                 return err
 545         }
 546         *x = prefix
 547         return nil
 548 }
 549
 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"`
 554 }
 555
 556 // AddressUnion defines union 'address_union'.
 557 type AddressUnion struct {
 558         // IP4 *IP4Address
 559         // IP6 *IP6Address
 560         XXX_UnionData [16]byte
 561 }
 562
 563 func AddressUnionIP4(a IP4Address) (u AddressUnion) {
 564         u.SetIP4(a)
 565         return
 566 }
 567 func (u *AddressUnion) SetIP4(a IP4Address) {
 568         buf := codec.NewBuffer(u.XXX_UnionData[:])
 569         buf.EncodeBytes(a[:], 4)
 570 }
 571 func (u *AddressUnion) GetIP4() (a IP4Address) {
 572         buf := codec.NewBuffer(u.XXX_UnionData[:])
 573         copy(a[:], buf.DecodeBytes(4))
 574         return
 575 }
 576
 577 func AddressUnionIP6(a IP6Address) (u AddressUnion) {
 578         u.SetIP6(a)
 579         return
 580 }
 581 func (u *AddressUnion) SetIP6(a IP6Address) {
 582         buf := codec.NewBuffer(u.XXX_UnionData[:])
 583         buf.EncodeBytes(a[:], 16)
 584 }
 585 func (u *AddressUnion) GetIP6() (a IP6Address) {
 586         buf := codec.NewBuffer(u.XXX_UnionData[:])
 587         copy(a[:], buf.DecodeBytes(16))
 588         return
 589 }