binapi/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.05-release
   5
   6 // Package ip_types contains generated bindings for API file ip_types.api.
   7 //
   8 // Contents:
   9 //   5 aliases
  10 //   4 enums
  11 //   6 structs
  12 //   1 union
  13 //
  14 package ip_types
  15
  16 import (
  17         "fmt"
  18         "net"
  19         "strconv"
  20         "strings"
  21
  22         api "git.fd.io/govpp.git/api"
  23         codec "git.fd.io/govpp.git/codec"
  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 uint8
  34
  35 const (
  36         ADDRESS_IP4 AddressFamily = 0
  37         ADDRESS_IP6 AddressFamily = 1
  38 )
  39
  40 var (
  41         AddressFamily_name = map[uint8]string{
  42                 0: "ADDRESS_IP4",
  43                 1: "ADDRESS_IP6",
  44         }
  45         AddressFamily_value = map[string]uint8{
  46                 "ADDRESS_IP4": 0,
  47                 "ADDRESS_IP6": 1,
  48         }
  49 )
  50
  51 func (x AddressFamily) String() string {
  52         s, ok := AddressFamily_name[uint8(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 uint8
 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_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
 193 )
 194
 195 var (
 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",
 210         }
 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,
 225         }
 226 )
 227
 228 func (x IPProto) String() string {
 229         s, ok := IPProto_name[uint8(x)]
 230         if ok {
 231                 return s
 232         }
 233         return "IPProto(" + strconv.Itoa(int(x)) + ")"
 234 }
 235
 236 // AddressWithPrefix defines alias 'address_with_prefix'.
 237 type AddressWithPrefix Prefix
 238
 239 func ParseAddressWithPrefix(s string) (AddressWithPrefix, error) {
 240         prefix, err := ParsePrefix(s)
 241         if err != nil {
 242                 return AddressWithPrefix{}, err
 243         }
 244         return AddressWithPrefix(prefix), nil
 245 }
 246 func (x AddressWithPrefix) String() string {
 247         return Prefix(x).String()
 248 }
 249 func (x *AddressWithPrefix) MarshalText() ([]byte, error) {
 250         return []byte(x.String()), nil
 251 }
 252 func (x *AddressWithPrefix) UnmarshalText(text []byte) error {
 253         prefix, err := ParseAddressWithPrefix(string(text))
 254         if err != nil {
 255                 return err
 256         }
 257         *x = prefix
 258         return nil
 259 }
 260
 261 // IP4Address defines alias 'ip4_address'.
 262 type IP4Address [4]uint8
 263
 264 func ParseIP4Address(s string) (IP4Address, error) {
 265         ip := net.ParseIP(s).To4()
 266         if ip == nil {
 267                 return IP4Address{}, fmt.Errorf("invalid IP address: %s", s)
 268         }
 269         var ipaddr IP4Address
 270         copy(ipaddr[:], ip.To4())
 271         return ipaddr, nil
 272 }
 273
 274 func (x IP4Address) ToIP() net.IP {
 275         return net.IP(x[:]).To4()
 276 }
 277 func (x IP4Address) String() string {
 278         return x.ToIP().String()
 279 }
 280 func (x *IP4Address) MarshalText() ([]byte, error) {
 281         return []byte(x.String()), nil
 282 }
 283 func (x *IP4Address) UnmarshalText(text []byte) error {
 284         ipaddr, err := ParseIP4Address(string(text))
 285         if err != nil {
 286                 return err
 287         }
 288         *x = ipaddr
 289         return nil
 290 }
 291
 292 // IP4AddressWithPrefix defines alias 'ip4_address_with_prefix'.
 293 type IP4AddressWithPrefix IP4Prefix
 294
 295 // IP6Address defines alias 'ip6_address'.
 296 type IP6Address [16]uint8
 297
 298 func ParseIP6Address(s string) (IP6Address, error) {
 299         ip := net.ParseIP(s).To16()
 300         if ip == nil {
 301                 return IP6Address{}, fmt.Errorf("invalid IP address: %s", s)
 302         }
 303         var ipaddr IP6Address
 304         copy(ipaddr[:], ip.To16())
 305         return ipaddr, nil
 306 }
 307
 308 func (x IP6Address) ToIP() net.IP {
 309         return net.IP(x[:]).To16()
 310 }
 311 func (x IP6Address) String() string {
 312         return x.ToIP().String()
 313 }
 314 func (x *IP6Address) MarshalText() ([]byte, error) {
 315         return []byte(x.String()), nil
 316 }
 317 func (x *IP6Address) UnmarshalText(text []byte) error {
 318         ipaddr, err := ParseIP6Address(string(text))
 319         if err != nil {
 320                 return err
 321         }
 322         *x = ipaddr
 323         return nil
 324 }
 325
 326 // IP6AddressWithPrefix defines alias 'ip6_address_with_prefix'.
 327 type IP6AddressWithPrefix IP6Prefix
 328
 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"`
 333 }
 334
 335 func ParseAddress(s string) (Address, error) {
 336         ip := net.ParseIP(s)
 337         if ip == nil {
 338                 return Address{}, fmt.Errorf("invalid address: %s", s)
 339         }
 340         var addr Address
 341         if ip.To4() == nil {
 342                 addr.Af = ADDRESS_IP6
 343                 var ip6 IP6Address
 344                 copy(ip6[:], ip.To16())
 345                 addr.Un.SetIP6(ip6)
 346         } else {
 347                 addr.Af = ADDRESS_IP4
 348                 var ip4 IP4Address
 349                 copy(ip4[:], ip.To4())
 350                 addr.Un.SetIP4(ip4)
 351         }
 352         return addr, nil
 353 }
 354 func (x Address) ToIP() net.IP {
 355         if x.Af == ADDRESS_IP6 {
 356                 ip6 := x.Un.GetIP6()
 357                 return net.IP(ip6[:]).To16()
 358         } else {
 359                 ip4 := x.Un.GetIP4()
 360                 return net.IP(ip4[:]).To4()
 361         }
 362 }
 363 func (x Address) String() string {
 364         return x.ToIP().String()
 365 }
 366 func (x *Address) MarshalText() ([]byte, error) {
 367         return []byte(x.String()), nil
 368 }
 369 func (x *Address) UnmarshalText(text []byte) error {
 370         addr, err := ParseAddress(string(text))
 371         if err != nil {
 372                 return err
 373         }
 374         *x = addr
 375         return nil
 376 }
 377
 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"`
 382 }
 383
 384 func ParseIP4Prefix(s string) (prefix IP4Prefix, err error) {
 385         hasPrefix := strings.Contains(s, "/")
 386         if hasPrefix {
 387                 ip, network, err := net.ParseCIDR(s)
 388                 if err != nil {
 389                         return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
 390                 }
 391                 maskSize, _ := network.Mask.Size()
 392                 prefix.Len = byte(maskSize)
 393                 prefix.Address, err = ParseIP4Address(ip.String())
 394                 if err != nil {
 395                         return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
 396                 }
 397         } else {
 398                 ip := net.ParseIP(s)
 399                 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
 400                 if ip.To4() == nil {
 401                         defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
 402                 }
 403                 prefix.Len = byte(defaultMaskSize)
 404                 prefix.Address, err = ParseIP4Address(ip.String())
 405                 if err != nil {
 406                         return IP4Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
 407                 }
 408         }
 409         return prefix, nil
 410 }
 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}
 414         return ipnet
 415 }
 416 func (x IP4Prefix) String() string {
 417         ip := x.Address.String()
 418         return ip + "/" + strconv.Itoa(int(x.Len))
 419 }
 420 func (x *IP4Prefix) MarshalText() ([]byte, error) {
 421         return []byte(x.String()), nil
 422 }
 423 func (x *IP4Prefix) UnmarshalText(text []byte) error {
 424         prefix, err := ParseIP4Prefix(string(text))
 425         if err != nil {
 426                 return err
 427         }
 428         *x = prefix
 429         return nil
 430 }
 431
 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"`
 436 }
 437
 438 func ParseIP6Prefix(s string) (prefix IP6Prefix, err error) {
 439         hasPrefix := strings.Contains(s, "/")
 440         if hasPrefix {
 441                 ip, network, err := net.ParseCIDR(s)
 442                 if err != nil {
 443                         return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
 444                 }
 445                 maskSize, _ := network.Mask.Size()
 446                 prefix.Len = byte(maskSize)
 447                 prefix.Address, err = ParseIP6Address(ip.String())
 448                 if err != nil {
 449                         return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
 450                 }
 451         } else {
 452                 ip := net.ParseIP(s)
 453                 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
 454                 if ip.To4() == nil {
 455                         defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
 456                 }
 457                 prefix.Len = byte(defaultMaskSize)
 458                 prefix.Address, err = ParseIP6Address(ip.String())
 459                 if err != nil {
 460                         return IP6Prefix{}, fmt.Errorf("invalid IP %s: %s", s, err)
 461                 }
 462         }
 463         return prefix, nil
 464 }
 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}
 468         return ipnet
 469 }
 470 func (x IP6Prefix) String() string {
 471         ip := x.Address.String()
 472         return ip + "/" + strconv.Itoa(int(x.Len))
 473 }
 474 func (x *IP6Prefix) MarshalText() ([]byte, error) {
 475         return []byte(x.String()), nil
 476 }
 477 func (x *IP6Prefix) UnmarshalText(text []byte) error {
 478         prefix, err := ParseIP6Prefix(string(text))
 479         if err != nil {
 480                 return err
 481         }
 482         *x = prefix
 483         return nil
 484 }
 485
 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"`
 492 }
 493
 494 // Prefix defines type 'prefix'.
 495 type Prefix struct {
 496         Address Address `binapi:"address,name=address" json:"address,omitempty"`
 497         Len     uint8   `binapi:"u8,name=len" json:"len,omitempty"`
 498 }
 499
 500 func ParsePrefix(ip string) (prefix Prefix, err error) {
 501         hasPrefix := strings.Contains(ip, "/")
 502         if hasPrefix {
 503                 netIP, network, err := net.ParseCIDR(ip)
 504                 if err != nil {
 505                         return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
 506                 }
 507                 maskSize, _ := network.Mask.Size()
 508                 prefix.Len = byte(maskSize)
 509                 prefix.Address, err = ParseAddress(netIP.String())
 510                 if err != nil {
 511                         return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
 512                 }
 513         } else {
 514                 netIP := net.ParseIP(ip)
 515                 defaultMaskSize, _ := net.CIDRMask(32, 32).Size()
 516                 if netIP.To4() == nil {
 517                         defaultMaskSize, _ = net.CIDRMask(128, 128).Size()
 518                 }
 519                 prefix.Len = byte(defaultMaskSize)
 520                 prefix.Address, err = ParseAddress(netIP.String())
 521                 if err != nil {
 522                         return Prefix{}, fmt.Errorf("invalid IP %s: %s", ip, err)
 523                 }
 524         }
 525         return prefix, nil
 526 }
 527 func (x Prefix) ToIPNet() *net.IPNet {
 528         var mask net.IPMask
 529         if x.Address.Af == ADDRESS_IP4 {
 530                 mask = net.CIDRMask(int(x.Len), 32)
 531         } else {
 532                 mask = net.CIDRMask(int(x.Len), 128)
 533         }
 534         ipnet := &net.IPNet{IP: x.Address.ToIP(), Mask: mask}
 535         return ipnet
 536 }
 537 func (x Prefix) String() string {
 538         ip := x.Address.String()
 539         return ip + "/" + strconv.Itoa(int(x.Len))
 540 }
 541 func (x *Prefix) MarshalText() ([]byte, error) {
 542         return []byte(x.String()), nil
 543 }
 544 func (x *Prefix) UnmarshalText(text []byte) error {
 545         prefix, err := ParsePrefix(string(text))
 546         if err != nil {
 547                 return err
 548         }
 549         *x = prefix
 550         return nil
 551 }
 552
 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"`
 557 }
 558
 559 // AddressUnion defines union 'address_union'.
 560 type AddressUnion struct {
 561         // IP4 *IP4Address
 562         // IP6 *IP6Address
 563         XXX_UnionData [16]byte
 564 }
 565
 566 func AddressUnionIP4(a IP4Address) (u AddressUnion) {
 567         u.SetIP4(a)
 568         return
 569 }
 570 func (u *AddressUnion) SetIP4(a IP4Address) {
 571         buf := codec.NewBuffer(u.XXX_UnionData[:])
 572         buf.EncodeBytes(a[:], 4)
 573 }
 574 func (u *AddressUnion) GetIP4() (a IP4Address) {
 575         buf := codec.NewBuffer(u.XXX_UnionData[:])
 576         copy(a[:], buf.DecodeBytes(4))
 577         return
 578 }
 579
 580 func AddressUnionIP6(a IP6Address) (u AddressUnion) {
 581         u.SetIP6(a)
 582         return
 583 }
 584 func (u *AddressUnion) SetIP6(a IP6Address) {
 585         buf := codec.NewBuffer(u.XXX_UnionData[:])
 586         buf.EncodeBytes(a[:], 16)
 587 }
 588 func (u *AddressUnion) GetIP6() (a IP6Address) {
 589         buf := codec.NewBuffer(u.XXX_UnionData[:])
 590         copy(a[:], buf.DecodeBytes(16))
 591         return
 592 }