cmd/binapi-generator/generate.go

   1 // Copyright (c) 2017 Cisco and/or its affiliates.
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at:
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 package main
  16
  17 import (
  18         "bufio"
  19         "bytes"
  20         "fmt"
  21         "io"
  22         "path/filepath"
  23         "strings"
  24         "unicode"
  25 )
  26
  27 const (
  28         govppApiImportPath = "git.fd.io/govpp.git/api" // import path of the govpp API package
  29         inputFileExt       = ".api.json"               // file extension of the VPP binary API files
  30         outputFileExt      = ".ba.go"                  // file extension of the Go generated files
  31 )
  32
  33 // context is a structure storing data for code generation
  34 type context struct {
  35         inputFile  string // input file with VPP API in JSON
  36         outputFile string // output file with generated Go package
  37
  38         inputData []byte        // contents of the input file
  39         inputBuff *bytes.Buffer // contents of the input file currently being read
  40         inputLine int           // currently processed line in the input file
  41
  42         moduleName  string // name of the source VPP module
  43         packageName string // name of the Go package being generated
  44
  45         packageData *Package // parsed package data
  46 }
  47
  48 // getContext returns context details of the code generation task
  49 func getContext(inputFile, outputDir string) (*context, error) {
  50         if !strings.HasSuffix(inputFile, inputFileExt) {
  51                 return nil, fmt.Errorf("invalid input file name: %q", inputFile)
  52         }
  53
  54         ctx := &context{
  55                 inputFile: inputFile,
  56         }
  57
  58         // package name
  59         inputFileName := filepath.Base(inputFile)
  60         ctx.moduleName = inputFileName[:strings.Index(inputFileName, ".")]
  61
  62         // alter package names for modules that are reserved keywords in Go
  63         switch ctx.moduleName {
  64         case "interface":
  65                 ctx.packageName = "interfaces"
  66         case "map":
  67                 ctx.packageName = "maps"
  68         default:
  69                 ctx.packageName = ctx.moduleName
  70         }
  71
  72         // output file
  73         packageDir := filepath.Join(outputDir, ctx.packageName)
  74         outputFileName := ctx.packageName + outputFileExt
  75         ctx.outputFile = filepath.Join(packageDir, outputFileName)
  76
  77         return ctx, nil
  78 }
  79
  80 // generatePackage generates code for the parsed package data and writes it into w
  81 func generatePackage(ctx *context, w *bufio.Writer) error {
  82         logf("generating package %q", ctx.packageName)
  83
  84         // generate file header
  85         generateHeader(ctx, w)
  86         generateImports(ctx, w)
  87
  88         if *includeAPIVer {
  89                 const APIVerConstName = "VlAPIVersion"
  90                 fmt.Fprintf(w, "// %s represents version of the API.\n", APIVerConstName)
  91                 fmt.Fprintf(w, "const %s = %v\n", APIVerConstName, ctx.packageData.APIVersion)
  92                 fmt.Fprintln(w)
  93         }
  94
  95         // generate enums
  96         if len(ctx.packageData.Enums) > 0 {
  97                 fmt.Fprintf(w, "/* Enums */\n\n")
  98
  99                 ctx.inputBuff = bytes.NewBuffer(ctx.inputData)
 100                 ctx.inputLine = 0
 101                 for _, enum := range ctx.packageData.Enums {
 102                         generateEnum(ctx, w, &enum)
 103                 }
 104         }
 105
 106         // generate types
 107         if len(ctx.packageData.Types) > 0 {
 108                 fmt.Fprintf(w, "/* Types */\n\n")
 109
 110                 ctx.inputBuff = bytes.NewBuffer(ctx.inputData)
 111                 ctx.inputLine = 0
 112                 for _, typ := range ctx.packageData.Types {
 113                         generateType(ctx, w, &typ)
 114                 }
 115         }
 116
 117         // generate unions
 118         if len(ctx.packageData.Unions) > 0 {
 119                 fmt.Fprintf(w, "/* Unions */\n\n")
 120
 121                 ctx.inputBuff = bytes.NewBuffer(ctx.inputData)
 122                 ctx.inputLine = 0
 123                 for _, union := range ctx.packageData.Unions {
 124                         generateUnion(ctx, w, &union)
 125                 }
 126         }
 127
 128         // generate messages
 129         if len(ctx.packageData.Messages) > 0 {
 130                 fmt.Fprintf(w, "/* Messages */\n\n")
 131
 132                 ctx.inputBuff = bytes.NewBuffer(ctx.inputData)
 133                 ctx.inputLine = 0
 134                 for _, msg := range ctx.packageData.Messages {
 135                         generateMessage(ctx, w, &msg)
 136                 }
 137         }
 138
 139         // generate services
 140         if len(ctx.packageData.Services) > 0 {
 141                 fmt.Fprintf(w, "/* Services */\n\n")
 142
 143                 ctx.inputBuff = bytes.NewBuffer(ctx.inputData)
 144                 ctx.inputLine = 0
 145                 fmt.Fprintf(w, "type %s interface {\n", "Services")
 146                 for _, svc := range ctx.packageData.Services {
 147                         generateService(ctx, w, &svc)
 148                 }
 149                 fmt.Fprintln(w, "}")
 150         }
 151
 152         // TODO: generate implementation for Services interface
 153
 154         // generate message registrations
 155         fmt.Fprintln(w)
 156         fmt.Fprintln(w, "func init() {")
 157         for _, msg := range ctx.packageData.Messages {
 158                 name := camelCaseName(msg.Name)
 159                 fmt.Fprintf(w, "\tapi.RegisterMessage((*%s)(nil), \"%s\")\n", name, ctx.moduleName+"."+name)
 160         }
 161         fmt.Fprintln(w, "}")
 162
 163         // flush the data:
 164         if err := w.Flush(); err != nil {
 165                 return fmt.Errorf("flushing data to %s failed: %v", ctx.outputFile, err)
 166         }
 167
 168         return nil
 169 }
 170
 171 // generateHeader writes generated package header into w
 172 func generateHeader(ctx *context, w io.Writer) {
 173         fmt.Fprintln(w, "// Code generated by GoVPP binapi-generator. DO NOT EDIT.")
 174         fmt.Fprintf(w, "//  source: %s\n", ctx.inputFile)
 175         fmt.Fprintln(w)
 176
 177         fmt.Fprintln(w, "/*")
 178         fmt.Fprintf(w, " Package %s is a generated from VPP binary API module '%s'.\n", ctx.packageName, ctx.moduleName)
 179         fmt.Fprintln(w)
 180         fmt.Fprintln(w, " It contains following objects:")
 181         var printObjNum = func(obj string, num int) {
 182                 if num > 0 {
 183                         if num > 1 {
 184                                 obj += "s"
 185                         }
 186                         fmt.Fprintf(w, "\t%3d %s\n", num, obj)
 187                 }
 188         }
 189         printObjNum("message", len(ctx.packageData.Messages))
 190         printObjNum("type", len(ctx.packageData.Types))
 191         printObjNum("enum", len(ctx.packageData.Enums))
 192         printObjNum("union", len(ctx.packageData.Unions))
 193         printObjNum("service", len(ctx.packageData.Services))
 194         fmt.Fprintln(w)
 195         fmt.Fprintln(w, "*/")
 196         fmt.Fprintf(w, "package %s\n", ctx.packageName)
 197         fmt.Fprintln(w)
 198 }
 199
 200 // generateImports writes generated package imports into w
 201 func generateImports(ctx *context, w io.Writer) {
 202         fmt.Fprintf(w, "import \"%s\"\n", govppApiImportPath)
 203         fmt.Fprintf(w, "import \"%s\"\n", "github.com/lunixbochs/struc")
 204         fmt.Fprintf(w, "import \"%s\"\n", "bytes")
 205         fmt.Fprintln(w)
 206
 207         fmt.Fprintf(w, "// Reference imports to suppress errors if they are not otherwise used.\n")
 208         fmt.Fprintf(w, "var _ = api.RegisterMessage\n")
 209         fmt.Fprintf(w, "var _ = struc.Pack\n")
 210         fmt.Fprintf(w, "var _ = bytes.NewBuffer\n")
 211         fmt.Fprintln(w)
 212 }
 213
 214 // generateComment writes generated comment for the object into w
 215 func generateComment(ctx *context, w io.Writer, goName string, vppName string, objKind string) {
 216         fmt.Fprintf(w, "// %s represents the VPP binary API %s '%s'.\n", goName, objKind, vppName)
 217
 218         var isNotSpace = func(r rune) bool {
 219                 return !unicode.IsSpace(r)
 220         }
 221
 222         // print out the source of the generated object
 223         objFound := false
 224         objTitle := fmt.Sprintf(`"%s",`, vppName)
 225         var indent int
 226         for {
 227                 line, err := ctx.inputBuff.ReadString('\n')
 228                 if err != nil {
 229                         break
 230                 }
 231                 ctx.inputLine++
 232
 233                 if !objFound {
 234                         indent = strings.Index(line, objTitle)
 235                         if indent == -1 {
 236                                 continue
 237                         }
 238                         // If no other non-whitespace character then we are at the message header.
 239                         if trimmed := strings.TrimSpace(line); trimmed == objTitle {
 240                                 objFound = true
 241                                 fmt.Fprintln(w, "//")
 242                         }
 243                 } else {
 244                         if strings.IndexFunc(line, isNotSpace) < indent {
 245                                 break // end of the object definition in JSON
 246                         }
 247                 }
 248                 fmt.Fprint(w, "//", line)
 249         }
 250
 251         fmt.Fprintln(w, "//")
 252 }
 253
 254 // generateEnum writes generated code for the enum into w
 255 func generateEnum(ctx *context, w io.Writer, enum *Enum) {
 256         name := camelCaseName(enum.Name)
 257         typ := binapiTypes[enum.Type]
 258
 259         logf(" writing enum %q (%s) with %d entries", enum.Name, name, len(enum.Entries))
 260
 261         // generate enum comment
 262         generateComment(ctx, w, name, enum.Name, "enum")
 263
 264         // generate enum definition
 265         fmt.Fprintf(w, "type %s %s\n", name, typ)
 266         fmt.Fprintln(w)
 267
 268         fmt.Fprintln(w, "const (")
 269
 270         // generate enum entries
 271         for _, entry := range enum.Entries {
 272                 fmt.Fprintf(w, "\t%s %s = %v\n", entry.Name, name, entry.Value)
 273         }
 274
 275         fmt.Fprintln(w, ")")
 276
 277         fmt.Fprintln(w)
 278 }
 279
 280 // generateType writes generated code for the type into w
 281 func generateType(ctx *context, w io.Writer, typ *Type) {
 282         name := camelCaseName(typ.Name)
 283
 284         logf(" writing type %q (%s) with %d fields", typ.Name, name, len(typ.Fields))
 285
 286         // generate struct comment
 287         generateComment(ctx, w, name, typ.Name, "type")
 288
 289         // generate struct definition
 290         fmt.Fprintf(w, "type %s struct {\n", name)
 291
 292         // generate struct fields
 293         for i, field := range typ.Fields {
 294                 // skip internal fields
 295                 switch strings.ToLower(field.Name) {
 296                 case "crc", "_vl_msg_id":
 297                         continue
 298                 }
 299
 300                 generateField(ctx, w, typ.Fields, i)
 301         }
 302
 303         // generate end of the struct
 304         fmt.Fprintln(w, "}")
 305
 306         // generate name getter
 307         generateTypeNameGetter(w, name, typ.Name)
 308
 309         // generate CRC getter
 310         generateCrcGetter(w, name, typ.CRC)
 311
 312         fmt.Fprintln(w)
 313 }
 314
 315 // generateUnion writes generated code for the union into w
 316 func generateUnion(ctx *context, w io.Writer, union *Union) {
 317         name := camelCaseName(union.Name)
 318
 319         logf(" writing union %q (%s) with %d fields", union.Name, name, len(union.Fields))
 320
 321         // generate struct comment
 322         generateComment(ctx, w, name, union.Name, "union")
 323
 324         // generate struct definition
 325         fmt.Fprintln(w, "type", name, "struct {")
 326
 327         // maximum size for union
 328         maxSize := getUnionSize(ctx, union)
 329
 330         // generate data field
 331         fieldName := "Union_data"
 332         fmt.Fprintf(w, "\t%s [%d]byte\n", fieldName, maxSize)
 333
 334         // generate end of the struct
 335         fmt.Fprintln(w, "}")
 336
 337         // generate name getter
 338         generateTypeNameGetter(w, name, union.Name)
 339
 340         // generate CRC getter
 341         generateCrcGetter(w, name, union.CRC)
 342
 343         // generate getters for fields
 344         for _, field := range union.Fields {
 345                 fieldName := camelCaseName(field.Name)
 346                 fieldType := convertToGoType(ctx, field.Type)
 347                 generateUnionGetterSetter(w, name, fieldName, fieldType)
 348         }
 349
 350         // generate union methods
 351         //generateUnionMethods(w, name)
 352
 353         fmt.Fprintln(w)
 354 }
 355
 356 // generateUnionMethods generates methods that implement struc.Custom
 357 // interface to allow having Union_data field unexported
 358 // TODO: do more testing when unions are actually used in some messages
 359 func generateUnionMethods(w io.Writer, structName string) {
 360         // generate struc.Custom implementation for union
 361         fmt.Fprintf(w, `
 362 func (u *%[1]s) Pack(p []byte, opt *struc.Options) (int, error) {
 363         var b = new(bytes.Buffer)
 364         if err := struc.PackWithOptions(b, u.union_data, opt); err != nil {
 365                 return 0, err
 366         }
 367         copy(p, b.Bytes())
 368         return b.Len(), nil
 369 }
 370 func (u *%[1]s) Unpack(r io.Reader, length int, opt *struc.Options) error {
 371         return struc.UnpackWithOptions(r, u.union_data[:], opt)
 372 }
 373 func (u *%[1]s) Size(opt *struc.Options) int {
 374         return len(u.union_data)
 375 }
 376 func (u *%[1]s) String() string {
 377         return string(u.union_data[:])
 378 }
 379 `, structName)
 380 }
 381
 382 func generateUnionGetterSetter(w io.Writer, structName string, getterField, getterStruct string) {
 383         fmt.Fprintf(w, `
 384 func (u *%[1]s) Set%[2]s(a %[3]s) {
 385         var b = new(bytes.Buffer)
 386         if err := struc.Pack(b, &a); err != nil {
 387                 return
 388         }
 389         copy(u.Union_data[:], b.Bytes())
 390 }
 391 func (u *%[1]s) Get%[2]s() (a %[3]s) {
 392         var b = bytes.NewReader(u.Union_data[:])
 393         struc.Unpack(b, &a)
 394         return
 395 }
 396 `, structName, getterField, getterStruct)
 397 }
 398
 399 // generateMessage writes generated code for the message into w
 400 func generateMessage(ctx *context, w io.Writer, msg *Message) {
 401         name := camelCaseName(msg.Name)
 402
 403         logf(" writing message %q (%s) with %d fields", msg.Name, name, len(msg.Fields))
 404
 405         // generate struct comment
 406         generateComment(ctx, w, name, msg.Name, "message")
 407
 408         // generate struct definition
 409         fmt.Fprintf(w, "type %s struct {", name)
 410
 411         msgType := otherMessage
 412         wasClientIndex := false
 413
 414         // generate struct fields
 415         n := 0
 416         for i, field := range msg.Fields {
 417                 if i == 1 {
 418                         if field.Name == "client_index" {
 419                                 // "client_index" as the second member, this might be an event message or a request
 420                                 msgType = eventMessage
 421                                 wasClientIndex = true
 422                         } else if field.Name == "context" {
 423                                 // reply needs "context" as the second member
 424                                 msgType = replyMessage
 425                         }
 426                 } else if i == 2 {
 427                         if wasClientIndex && field.Name == "context" {
 428                                 // request needs "client_index" as the second member and "context" as the third member
 429                                 msgType = requestMessage
 430                         }
 431                 }
 432
 433                 // skip internal fields
 434                 switch strings.ToLower(field.Name) {
 435                 case "crc", "_vl_msg_id":
 436                         continue
 437                 case "client_index", "context":
 438                         if n == 0 {
 439                                 continue
 440                         }
 441                 }
 442                 n++
 443                 if n == 1 {
 444                         fmt.Fprintln(w)
 445                 }
 446
 447                 generateField(ctx, w, msg.Fields, i)
 448         }
 449
 450         // generate end of the struct
 451         fmt.Fprintln(w, "}")
 452
 453         // generate name getter
 454         generateMessageNameGetter(w, name, msg.Name)
 455
 456         // generate CRC getter
 457         generateCrcGetter(w, name, msg.CRC)
 458
 459         // generate message type getter method
 460         generateMessageTypeGetter(w, name, msgType)
 461 }
 462
 463 // generateField writes generated code for the field into w
 464 func generateField(ctx *context, w io.Writer, fields []Field, i int) {
 465         field := fields[i]
 466
 467         fieldName := strings.TrimPrefix(field.Name, "_")
 468         fieldName = camelCaseName(fieldName)
 469
 470         dataType := convertToGoType(ctx, field.Type)
 471
 472         fieldType := dataType
 473         if field.IsArray() {
 474                 if dataType == "uint8" {
 475                         dataType = "byte"
 476                 }
 477                 fieldType = "[]" + dataType
 478         }
 479         fmt.Fprintf(w, "\t%s %s", fieldName, fieldType)
 480
 481         if field.Length > 0 {
 482                 // fixed size array
 483                 fmt.Fprintf(w, "\t`struc:\"[%d]%s\"`", field.Length, dataType)
 484         } else {
 485                 for _, f := range fields {
 486                         if f.SizeFrom == field.Name {
 487                                 // variable sized array
 488                                 sizeOfName := camelCaseName(f.Name)
 489                                 fmt.Fprintf(w, "\t`struc:\"sizeof=%s\"`", sizeOfName)
 490                         }
 491                 }
 492         }
 493
 494         fmt.Fprintln(w)
 495 }
 496
 497 // generateService writes generated code for the service into w
 498 func generateService(ctx *context, w io.Writer, svc *Service) {
 499         reqTyp := camelCaseName(svc.RequestType)
 500
 501         // method name is same as parameter type name by default
 502         method := svc.MethodName()
 503         params := fmt.Sprintf("*%s", reqTyp)
 504         returns := "error"
 505         if replyTyp := camelCaseName(svc.ReplyType); replyTyp != "" {
 506                 returns = fmt.Sprintf("(*%s, error)", replyTyp)
 507         }
 508
 509         fmt.Fprintf(w, "\t%s(%s) %s\n", method, params, returns)
 510 }
 511
 512 // generateMessageNameGetter generates getter for original VPP message name into the provider writer
 513 func generateMessageNameGetter(w io.Writer, structName, msgName string) {
 514         fmt.Fprintf(w, `func (*%s) GetMessageName() string {
 515         return %q
 516 }
 517 `, structName, msgName)
 518 }
 519
 520 // generateTypeNameGetter generates getter for original VPP type name into the provider writer
 521 func generateTypeNameGetter(w io.Writer, structName, msgName string) {
 522         fmt.Fprintf(w, `func (*%s) GetTypeName() string {
 523         return %q
 524 }
 525 `, structName, msgName)
 526 }
 527
 528 // generateCrcGetter generates getter for CRC checksum of the message definition into the provider writer
 529 func generateCrcGetter(w io.Writer, structName, crc string) {
 530         crc = strings.TrimPrefix(crc, "0x")
 531         fmt.Fprintf(w, `func (*%s) GetCrcString() string {
 532         return %q
 533 }
 534 `, structName, crc)
 535 }
 536
 537 // generateMessageTypeGetter generates message factory for the generated message into the provider writer
 538 func generateMessageTypeGetter(w io.Writer, structName string, msgType MessageType) {
 539         fmt.Fprintln(w, "func (*"+structName+") GetMessageType() api.MessageType {")
 540         if msgType == requestMessage {
 541                 fmt.Fprintln(w, "\treturn api.RequestMessage")
 542         } else if msgType == replyMessage {
 543                 fmt.Fprintln(w, "\treturn api.ReplyMessage")
 544         } else if msgType == eventMessage {
 545                 fmt.Fprintln(w, "\treturn api.EventMessage")
 546         } else {
 547                 fmt.Fprintln(w, "\treturn api.OtherMessage")
 548         }
 549         fmt.Fprintln(w, "}")
 550 }