summaryrefslogtreecommitdiffstats
path: root/binapi_generator/generator.go
blob: 43f9edef35b5c6bdf7dac7cbf581950d4b819816 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
// Copyright (c) 2017 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 (
	"bufio"
	"bytes"
	"encoding/json"
	"errors"
	"flag"
	"fmt"
	"io"
	"io/ioutil"
	"os"
	"os/exec"
	"path/filepath"
	"strings"
	"time"
	"unicode"

	"github.com/bennyscetbun/jsongo"
)

// MessageType represents the type of a VPP message.
type messageType int

const (
	requestMessage messageType = iota // VPP request message
	replyMessage                      // VPP reply message
	otherMessage                      // other VPP message
)

const (
	apiImportPath = "git.fd.io/govpp.git/api" // import path of the govpp API
	inputFileExt  = ".json"                                               // filename extension of files that should be processed as the input
)

// context is a structure storing details of a particular code generation task
type context struct {
	inputFile   string            // file with input JSON data
	inputBuff   *bytes.Buffer     // contents of the input file
	inputLine   int               // currently processed line in the input file
	outputFile  string            // file with output data
	packageName string            // name of the Go package being generated
	packageDir  string            // directory where the package source files are located
	types       map[string]string // map of the VPP typedef names to generated Go typedef names
}

func main() {
	inputFile := flag.String("input-file", "", "Input JSON file.")
	inputDir := flag.String("input-dir", ".", "Input directory with JSON files.")
	outputDir := flag.String("output-dir", ".", "Output directory where package folders will be generated.")
	flag.Parse()

	if *inputFile == "" && *inputDir == "" {
		fmt.Fprintln(os.Stderr, "ERROR: input-file or input-dir must be specified")
		os.Exit(1)
	}

	var err, tmpErr error
	if *inputFile != "" {
		// process one input file
		err = generateFromFile(*inputFile, *outputDir)
		if err != nil {
			fmt.Fprintf(os.Stderr, "ERROR: code generation from %s failed: %v\n", *inputFile, err)
		}
	} else {
		// process all files in specified directory
		files, err := getInputFiles(*inputDir)
		if err != nil {
			fmt.Fprintf(os.Stderr, "ERROR: code generation failed: %v\n", err)
		}
		for _, file := range files {
			tmpErr = generateFromFile(file, *outputDir)
			if tmpErr != nil {
				fmt.Fprintf(os.Stderr, "ERROR: code generation from %s failed: %v\n", file, err)
				err = tmpErr // remember that the error occurred
			}
		}
	}
	if err != nil {
		os.Exit(1)
	}
}

// getInputFiles returns all input files located in specified directory
func getInputFiles(inputDir string) ([]string, error) {
	files, err := ioutil.ReadDir(inputDir)
	if err != nil {
		return nil, fmt.Errorf("reading directory %s failed: %v", inputDir, err)
	}
	res := make([]string, 0)
	for _, f := range files {
		if strings.HasSuffix(f.Name(), inputFileExt) {
			res = append(res, inputDir+"/"+f.Name())
		}
	}
	return res, nil
}

// generateFromFile generates Go bindings from one input JSON file
func generateFromFile(inputFile, outputDir string) error {
	ctx, err := getContext(inputFile, outputDir)
	if err != nil {
		return err
	}
	// read the file
	inputData, err := readFile(inputFile)
	if err != nil {
		return err
	}
	ctx.inputBuff = bytes.NewBuffer(inputData)

	// parse JSON
	jsonRoot, err := parseJSON(inputData)
	if err != nil {
		return err
	}

	// create output directory
	err = os.MkdirAll(ctx.packageDir, 0777)
	if err != nil {
		return fmt.Errorf("creating output directory %s failed: %v", ctx.packageDir, err)
	}

	// open output file
	f, err := os.Create(ctx.outputFile)
	defer f.Close()
	if err != nil {
		return fmt.Errorf("creating output file %s failed: %v", ctx.outputFile, err)
	}
	w := bufio.NewWriter(f)

	// generate Go package code
	err = generatePackage(ctx, w, jsonRoot)
	if err != nil {
		return err
	}

	// go format the output file (non-fatal if fails)
	exec.Command("gofmt", "-w", ctx.outputFile).Run()

	return nil
}

// getContext returns context details of the code generation task
func getContext(inputFile, outputDir string) (*context, error) {
	if !strings.HasSuffix(inputFile, inputFileExt) {
		return nil, fmt.Errorf("invalid input file name %s", inputFile)
	}

	ctx := &context{inputFile: inputFile}
	inputFileName := filepath.Base(inputFile)

	ctx.packageName = inputFileName[0:strings.Index(inputFileName, ".")]
	if ctx.packageName == "interface" {
		// 'interface' cannot be a package name, it is a go keyword
		ctx.packageName = "interfaces"
	}

	ctx.packageDir = outputDir + "/" + ctx.packageName + "/"
	ctx.outputFile = ctx.packageDir + ctx.packageName + ".go"

	return ctx, nil
}

// readFile reads content of a file into memory
func readFile(inputFile string) ([]byte, error) {

	inputData, err := ioutil.ReadFile(inputFile)

	if err != nil {
		return nil, fmt.Errorf("reading data from file failed: %v", err)
	}

	return inputData, nil
}

// parseJSON parses a JSON data into an in-memory tree
func parseJSON(inputData []byte) (*jsongo.JSONNode, error) {
	root := jsongo.JSONNode{}

	err := json.Unmarshal(inputData, &root)
	if err != nil {
		return nil, fmt.Errorf("JSON unmarshall failed: %v", err)
	}

	return &root, nil

}

// generatePackage generates Go code of a package from provided JSON
func generatePackage(ctx *context, w *bufio.Writer, jsonRoot *jsongo.JSONNode) error {
	// generate file header
	generatePackageHeader(ctx, w, jsonRoot)

	// generate data types
	ctx.types = make(map[string]string)
	types := jsonRoot.Map("types")
	for i := 0; i < types.Len(); i++ {
		typ := types.At(i)
		err := generateMessage(ctx, w, typ, true)
		if err != nil {
			return err
		}
	}

	// generate messages
	messages := jsonRoot.Map("messages")
	for i := 0; i < messages.Len(); i++ {
		msg := messages.At(i)
		err := generateMessage(ctx, w, msg, false)
		if err != nil {
			return err
		}
	}

	// flush the data:
	err := w.Flush()
	if err != nil {
		return fmt.Errorf("flushing data to %s failed: %v", ctx.outputFile, err)
	}

	return nil
}

// generateMessage generates Go code of one VPP message encoded in JSON into provided writer
func generateMessage(ctx *context, w io.Writer, msg *jsongo.JSONNode, isType bool) error {
	if msg.Len() == 0 || msg.At(0).GetType() != jsongo.TypeValue {
		return errors.New("invalid JSON for message specified")
	}

	msgName, ok := msg.At(0).Get().(string)
	if !ok {
		return fmt.Errorf("invalid JSON for message specified, message name is %T, not a string", msg.At(0).Get())
	}
	structName := camelCaseName(strings.Title(msgName))

	// generate struct fields into the slice & determine message type
	fields := make([]string, 0)
	msgType := otherMessage
	for j := 0; j < msg.Len(); j++ {
		if jsongo.TypeArray == msg.At(j).GetType() {
			fld := msg.At(j)
			err := processMessageField(ctx, &fields, fld)
			if err != nil {
				return err
			}
			// determine whether ths is a request / reply / other message
			if j == 2 {
				fieldName, ok := fld.At(1).Get().(string)
				if ok {
					if fieldName == "client_index" {
						msgType = requestMessage
					} else if fieldName == "context" {
						msgType = replyMessage
					} else {
						msgType = otherMessage
					}
				}
			}
		}
	}

	// generate struct comment
	generateMessageComment(ctx, w, structName, msgName, isType)

	// generate struct header
	fmt.Fprintln(w, "type", structName, "struct {")

	// print out the fields
	for _, field := range fields {
		fmt.Fprintln(w, field)
	}

	// generate end of the struct
	fmt.Fprintln(w, "}")

	// generate name getter
	if isType {
		generateTypeNameGetter(w, structName, msgName)
	} else {
		generateMessageNameGetter(w, structName, msgName)
	}

	// generate message type getter method
	if !isType {
		generateMessageTypeGetter(w, structName, msgType)
	}

	// generate CRC getter
	crcIf := msg.At(msg.Len() - 1).At("crc").Get()
	if crc, ok := crcIf.(string); ok {
		generateCrcGetter(w, structName, crc)
	}

	// generate message factory
	if !isType {
		generateMessageFactory(w, structName)
	}

	// if this is a type, save it in the map for later use
	if isType {
		ctx.types[fmt.Sprintf("vl_api_%s_t", msgName)] = structName
	}

	return nil
}

// processMessageField process JSON describing one message field into Go code emitted into provided slice of message fields
func processMessageField(ctx *context, fields *[]string, fld *jsongo.JSONNode) error {
	if fld.Len() < 2 || fld.At(0).GetType() != jsongo.TypeValue || fld.At(1).GetType() != jsongo.TypeValue {
		return errors.New("invalid JSON for message field specified")
	}
	fieldVppType, ok := fld.At(0).Get().(string)
	if !ok {
		return fmt.Errorf("invalid JSON for message specified, field type is %T, not a string", fld.At(0).Get())
	}
	fieldName, ok := fld.At(1).Get().(string)
	if !ok {
		return fmt.Errorf("invalid JSON for message specified, field name is %T, not a string", fld.At(1).Get())
	}

	// skip internal fields
	fieldNameLower := strings.ToLower(fieldName)
	if fieldNameLower == "crc" || fieldNameLower == "_vl_msg_id" {
		return nil
	}
	if len(*fields) == 0 && (fieldNameLower == "client_index" || fieldNameLower == "context") {
		return nil
	}

	fieldName = strings.TrimPrefix(fieldName, "_")
	fieldName = camelCaseName(strings.Title(fieldName))

	fieldStr := ""
	isArray := false
	arraySize := 0

	fieldStr += "\t" + fieldName + " "
	if fld.Len() > 2 {
		isArray = true
		arraySize = int(fld.At(2).Get().(float64))
		fieldStr += "[]"
	}

	dataType := translateVppType(ctx, fieldVppType, isArray)
	fieldStr += dataType

	if isArray {
		if arraySize == 0 {
			// variable sized array
			if fld.Len() > 3 {
				// array size is specified by another field
				arraySizeField := string(fld.At(3).Get().(string))
				arraySizeField = camelCaseName(strings.Title(arraySizeField))
				// find & update the field that specifies the array size
				for i, f := range *fields {
					if strings.Contains(f, fmt.Sprintf("\t%s ", arraySizeField)) {
						(*fields)[i] += fmt.Sprintf("\t`struc:\"sizeof=%s\"`", fieldName)
					}
				}
			}
		} else {
			// fixed size array
			fieldStr += fmt.Sprintf("\t`struc:\"[%d]%s\"`", arraySize, dataType)
		}
	}

	*fields = append(*fields, fieldStr)
	return nil
}

// generatePackageHeader generates package header into provider writer
func generatePackageHeader(ctx *context, w io.Writer, rootNode *jsongo.JSONNode) {
	fmt.Fprintln(w, "// Package "+ctx.packageName+" represents the VPP binary API of the '"+ctx.packageName+"' VPP module.")
	fmt.Fprintln(w, "// DO NOT EDIT. Generated from '"+ctx.inputFile+"' on "+time.Now().Format(time.RFC1123)+".")

	fmt.Fprintln(w, "package "+ctx.packageName)

	fmt.Fprintln(w, "import \""+apiImportPath+"\"")

	fmt.Fprintln(w)
	fmt.Fprintln(w, "// VlApiVersion contains version of the API.")
	vlAPIVersion := rootNode.Map("vl_api_version")
	if vlAPIVersion != nil {
		fmt.Fprintln(w, "const VlAPIVersion = ", vlAPIVersion.Get())
	}
	fmt.Fprintln(w)
}

// generateMessageComment generates comment for a message into provider writer
func generateMessageComment(ctx *context, w io.Writer, structName string, msgName string, isType bool) {
	fmt.Fprintln(w)
	if isType {
		fmt.Fprintln(w, "// "+structName+" represents the VPP binary API data type '"+msgName+"'.")
	} else {
		fmt.Fprintln(w, "// "+structName+" represents the VPP binary API message '"+msgName+"'.")
	}

	// print out the source of the generated message - the JSON
	msgFound := false
	for {
		lineBuff, err := ctx.inputBuff.ReadBytes('\n')
		if err != nil {
			break
		}
		ctx.inputLine++
		line := string(lineBuff)

		if !msgFound {
			if strings.Contains(line, msgName) {
				fmt.Fprintf(w, "// Generated from '%s', line %d:\n", ctx.inputFile, ctx.inputLine)
				fmt.Fprintln(w, "//")
				fmt.Fprint(w, "//", line)
				msgFound = true
			}
		} else {
			fmt.Fprint(w, "//", line)
			if len(strings.Trim(line, " ")) < 4 {
				break // end of the message in JSON
			}
		}
	}
	fmt.Fprintln(w, "//")
}

// generateMessageNameGetter generates getter for original VPP message name into the provider writer
func generateMessageNameGetter(w io.Writer, structName string, msgName string) {
	fmt.Fprintln(w, "func (*"+structName+") GetMessageName() string {")
	fmt.Fprintln(w, "\treturn \""+msgName+"\"")
	fmt.Fprintln(w, "}")
}

// generateTypeNameGetter generates getter for original VPP type name into the provider writer
func generateTypeNameGetter(w io.Writer, structName string, msgName string) {
	fmt.Fprintln(w, "func (*"+structName+") GetTypeName() string {")
	fmt.Fprintln(w, "\treturn \""+msgName+"\"")
	fmt.Fprintln(w, "}")
}

// generateMessageTypeGetter generates message factory for the generated message into the provider writer
func generateMessageTypeGetter(w io.Writer, structName string, msgType messageType) {
	fmt.Fprintln(w, "func (*"+structName+") GetMessageType() api.MessageType {")
	if msgType == requestMessage {
		fmt.Fprintln(w, "\treturn api.RequestMessage")
	} else if msgType == replyMessage {
		fmt.Fprintln(w, "\treturn api.ReplyMessage")
	} else {
		fmt.Fprintln(w, "\treturn api.OtherMessage")
	}
	fmt.Fprintln(w, "}")
}

// generateCrcGetter generates getter for CRC checksum of the message definition into the provider writer
func generateCrcGetter(w io.Writer, structName string, crc string) {
	crc = strings.TrimPrefix(crc, "0x")
	fmt.Fprintln(w, "func (*"+structName+") GetCrcString() string {")
	fmt.Fprintln(w, "\treturn \""+crc+"\"")
	fmt.Fprintln(w, "}")
}

// generateMessageFactory generates message factory for the generated message into the provider writer
func generateMessageFactory(w io.Writer, structName string) {
	fmt.Fprintln(w, "func New"+structName+"() api.Message {")
	fmt.Fprintln(w, "\treturn &"+structName+"{}")
	fmt.Fprintln(w, "}")
}

// translateVppType translates the VPP data type into Go data type
func translateVppType(ctx *context, vppType string, isArray bool) string {
	// basic types
	switch vppType {
	case "u8":
		if isArray {
			return "byte"
		}
		return "uint8"
	case "i8":
		return "int8"
	case "u16":
		return "uint16"
	case "i16":
		return "int16"
	case "u32":
		return "uint32"
	case "i32":
		return "int32"
	case "u64":
		return "uint64"
	case "i64":
		return "int64"
	case "f64":
		return "float64"
	}

	// typedefs
	typ, ok := ctx.types[vppType]
	if ok {
		return typ
	}

	panic(fmt.Sprintf("Unknown VPP type %s", vppType))
}

// camelCaseName returns correct name identifier (camelCase).
func camelCaseName(name string) (should string) {
	// 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 := strings.ToUpper(word); commonInitialisms[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)
}

// 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,
	"CPU":   true,
	"CSS":   true,
	"DNS":   true,
	"EOF":   true,
	"GUID":  true,
	"HTML":  true,
	"HTTP":  true,
	"HTTPS": true,
	"ID":    true,
	"IP":    true,
	"ICMP":  true,
	"JSON":  true,
	"LHS":   true,
	"QPS":   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,
	"XML":   true,
	"XMPP":  true,
	"XSRF":  true,
	"XSS":   true,
}