Refactor GoVPP

Squashed commit of the following:

commit 348930db31575e9f59b3834d9fec07411f011e05
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Wed Aug 15 11:30:13 2018 +0200

    Use debug level for log about different context

commit 9fc963c559cea67a41b85c6cdadc322fb3b1fc7c
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Wed Aug 15 11:22:03 2018 +0200

    Remove annoying logs and add env vars for debugging

commit fdc9fd624d13feadb602e0d03d58f8a44b7a565f
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Wed Aug 15 11:18:47 2018 +0200

    Fix printing unknown VPPApiError

commit 8f968be36a91de4d4a8ea17593ba314f82aa9583
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Tue Aug 14 17:25:10 2018 +0200

    Refactor entire GoVPP

    - fix some cases with inconsistent VPP messages, causing messages
      to be incorrectly identified as event or request
    - simplify API, remove direct access to internal Go channels
    - add module name with message to registration of messages
    - start watching filesystem only when vpe-api file does not exist
    - simplify code in message codec and remove unneeded parts
    - retrieve IDs of all registered messages after connect to VPP
    - define fallback for control ping in core to avoid duplicate registration
    - add SetLogLevel function to set logger level more easily
    - remove lot of unused code

commit 34dd1b7e10ef0324aa8c4e4cc42375bd6021c6cb
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Mon Aug 13 11:29:54 2018 +0200

    Rename VnetError to VPPApiError

commit c6549d6f77847a1367a12ff47fb716e2955e973a
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Mon Aug 13 10:23:43 2018 +0200

    Fix examples and regenerate binapi

commit 4612e36b416779771f5efab4fc654c2766d2cb1c
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Mon Aug 13 09:51:22 2018 +0200

    Add parsing and generation for services

commit ac9c5280c5aa27e325f327609e2364cc66f3723f
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Fri Aug 10 14:30:15 2018 +0200

    Fix exit status on error and add continue-onerror flag

commit 9b3f4ef9fc7c8c62037fa107085eae18a8725314
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 15:20:56 2018 +0200

    Return VnetError when Retval != 0

commit 8fd21a907b5e628ec4d2026215b83d15da96c297
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 14:59:05 2018 +0200

    Add all missing errors from api_errno.h

commit 08450f288d3046ebaecf40203174ae342a07f1eb
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 14:29:27 2018 +0200

    Update README

commit d8dced0728dd62243539be741868fb7d9b8de4cc
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 13:59:59 2018 +0200

    Regenerate vpe in core

commit 254da7592cdbf634cf7aa46ae36ce7bb6d4ee555
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 13:37:00 2018 +0200

    Add VnetError type for Retvals

commit 4475c1087fb53ab4c788e530bc7fef7cfc89d2cd
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 13:36:07 2018 +0200

    Add registration API

commit 892a3ea5a2c703e2f7c29331663f6a6fa706bff5
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 13:30:43 2018 +0200

    Generate registration for messages and check all IDs on connect

commit 389ed03b6e7082260281866c3449d72d72347c99
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 11:32:41 2018 +0200

    Show error for empty adapter (on Darwin/Windows)

commit ef1ea040d656ade64242432dc5f06810ed8dcde6
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 11:31:37 2018 +0200

    Improve logged info

commit d4adae3b14ed54c8d693060dd857fa9ba5ec8e06
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 11:27:48 2018 +0200

    Update examples

commit 63921e1346014701a22639a2611129563bb1eb78
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Thu Aug 9 11:02:56 2018 +0200

    Generate unions and fix some issues

    - add comments between sections
    - define structs on single line if it has no fields
    - generate unions with setters/getters for each field
    - fix detection of message type

commit 6ab3e3fa590b245898306a6ffaf32c7721eab60c
Author: Ondrej Fabry <ofabry@cisco.com>
Date:   Wed Aug 8 15:37:10 2018 +0200

    Refactor binapi-generator

    - split JSON parsing from code generation
    - parse and generate enums
    - parse unions (no generation yet)
    - change output file suffix to '.ba.go'
    - cleanup and simplify code
    - split code into files
    - add flag for debug mode

Change-Id: I58f685e0d4c7a38e9a7b6ea0a1f47792d95d7399
Signed-off-by: Ondrej Fabry <ofabry@cisco.com>

1 files changed, 176 insertions, 0 deletions

diff --git a/cmd/binapi-generator/definitions.go b/cmd/binapi-generator/definitions.go
new file mode 100644
index 0000000..3ad782f
--- /dev/null
+++ b/cmd/binapi-generator/definitions.go
@@ -0,0 +1,176 @@
+// Copyright (c) 2018 Cisco and/or its affiliates.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at:
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package main
+
+import (
+	"strconv"
+	"strings"
+	"unicode"
+)
+
+func getBinapiTypeSize(binapiType string) int {
+	if _, ok := binapiTypes[binapiType]; ok {
+		b, err := strconv.Atoi(strings.TrimLeft(binapiType, "uif"))
+		if err == nil {
+			return b / 8
+		}
+	}
+	return -1
+}
+
+// binapiTypes is a set of types used VPP binary API for translation to Go types
+var binapiTypes = map[string]string{
+	"u8":  "uint8",
+	"i8":  "int8",
+	"u16": "uint16",
+	"i16": "int16",
+	"u32": "uint32",
+	"i32": "int32",
+	"u64": "uint64",
+	"i64": "int64",
+	"f64": "float64",
+}
+
+func usesInitialism(s string) string {
+	if u := strings.ToUpper(s); commonInitialisms[u] {
+		return u
+	} else if su, ok := specialInitialisms[u]; ok {
+		return su
+	}
+	return ""
+}
+
+// commonInitialisms is a set of common initialisms that need to stay in upper case.
+var commonInitialisms = map[string]bool{
+	"ACL": true,
+	"API": true,
+	//"ASCII": true, // there are only two use cases for ASCII which already have initialism before and after
+	"CPU":   true,
+	"CSS":   true,
+	"DNS":   true,
+	"DHCP":  true,
+	"EOF":   true,
+	"GUID":  true,
+	"HTML":  true,
+	"HTTP":  true,
+	"HTTPS": true,
+	"ID":    true,
+	"IP":    true,
+	"ICMP":  true,
+	"JSON":  true,
+	"LHS":   true,
+	"QPS":   true,
+	"PID":   true,
+	"RAM":   true,
+	"RHS":   true,
+	"RPC":   true,
+	"SLA":   true,
+	"SMTP":  true,
+	"SQL":   true,
+	"SSH":   true,
+	"TCP":   true,
+	"TLS":   true,
+	"TTL":   true,
+	"UDP":   true,
+	"UI":    true,
+	"UID":   true,
+	"UUID":  true,
+	"URI":   true,
+	"URL":   true,
+	"UTF8":  true,
+	"VM":    true,
+	"VPN":   true,
+	"XML":   true,
+	"XMPP":  true,
+	"XSRF":  true,
+	"XSS":   true,
+}
+
+// specialInitialisms is a set of special initialisms that need part to stay in upper case.
+var specialInitialisms = map[string]string{
+	"IPV": "IPv",
+	//"IPV4": "IPv4",
+	//"IPV6": "IPv6",
+}
+
+// camelCaseName returns correct name identifier (camelCase).
+func camelCaseName(name string) (should string) {
+	name = strings.Title(name)
+
+	// Fast path for simple cases: "_" and all lowercase.
+	if name == "_" {
+		return name
+	}
+	allLower := true
+	for _, r := range name {
+		if !unicode.IsLower(r) {
+			allLower = false
+			break
+		}
+	}
+	if allLower {
+		return name
+	}
+
+	// Split camelCase at any lower->upper transition, and split on underscores.
+	// Check each word for common initialisms.
+	runes := []rune(name)
+	w, i := 0, 0 // index of start of word, scan
+	for i+1 <= len(runes) {
+		eow := false // whether we hit the end of a word
+		if i+1 == len(runes) {
+			eow = true
+		} else if runes[i+1] == '_' {
+			// underscore; shift the remainder forward over any run of underscores
+			eow = true
+			n := 1
+			for i+n+1 < len(runes) && runes[i+n+1] == '_' {
+				n++
+			}
+
+			// Leave at most one underscore if the underscore is between two digits
+			if i+n+1 < len(runes) && unicode.IsDigit(runes[i]) && unicode.IsDigit(runes[i+n+1]) {
+				n--
+			}
+
+			copy(runes[i+1:], runes[i+n+1:])
+			runes = runes[:len(runes)-n]
+		} else if unicode.IsLower(runes[i]) && !unicode.IsLower(runes[i+1]) {
+			// lower->non-lower
+			eow = true
+		}
+		i++
+		if !eow {
+			continue
+		}
+
+		// [w,i) is a word.
+		word := string(runes[w:i])
+		if u := usesInitialism(word); u != "" {
+			// Keep consistent case, which is lowercase only at the start.
+			if w == 0 && unicode.IsLower(runes[w]) {
+				u = strings.ToLower(u)
+			}
+			// All the common initialisms are ASCII,
+			// so we can replace the bytes exactly.
+			copy(runes[w:], []rune(u))
+		} else if w > 0 && strings.ToLower(word) == word {
+			// already all lowercase, and not the first word, so uppercase the first character.
+			runes[w] = unicode.ToUpper(runes[w])
+		}
+		w = i
+	}
+	return string(runes)
+}