1 // Copyright (c) 2018 Cisco and/or its affiliates.
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:
7 // http://www.apache.org/licenses/LICENSE-2.0
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.
23 "github.com/bennyscetbun/jsongo"
29 objMessages = "messages"
32 objServices = "services"
33 objAliases = "aliases"
34 vlAPIVersion = "vl_api_version"
37 // various object fields
40 msgIdField = "_vl_msg_id"
42 clientIndexField = "client_index"
43 contextField = "context"
45 aliasLengthField = "length"
46 aliasTypeField = "type"
49 streamField = "stream"
50 eventsField = "events"
55 serviceEventPrefix = "want_"
56 serviceDumpSuffix = "_dump"
57 serviceDetailsSuffix = "_details"
58 serviceReplySuffix = "_reply"
59 serviceNoReply = "null"
64 fieldMetaLimit = "limit"
67 // parsePackage parses provided JSON data into objects prepared for code generation
68 func parsePackage(ctx *context, jsonRoot *jsongo.JSONNode) (*Package, error) {
69 logf(" %s (version: %s) contains: %d services, %d messages, %d types, %d enums, %d unions, %d aliases",
71 jsonRoot.Map(vlAPIVersion).Get(),
72 jsonRoot.Map(objServices).Len(),
73 jsonRoot.Map(objMessages).Len(),
74 jsonRoot.Map(objTypes).Len(),
75 jsonRoot.Map(objEnums).Len(),
76 jsonRoot.Map(objUnions).Len(),
77 jsonRoot.Map(objAliases).Len(),
81 APIVersion: jsonRoot.Map(vlAPIVersion).Get().(string),
82 RefMap: make(map[string]string),
86 enums := jsonRoot.Map(objEnums)
87 pkg.Enums = make([]Enum, enums.Len())
88 for i := 0; i < enums.Len(); i++ {
89 enumNode := enums.At(i)
91 enum, err := parseEnum(ctx, enumNode)
96 pkg.RefMap[toApiType(enum.Name)] = enum.Name
99 sort.SliceStable(pkg.Enums, func(i, j int) bool {
100 return pkg.Enums[i].Name < pkg.Enums[j].Name
104 aliases := jsonRoot.Map(objAliases)
105 if aliases.GetType() == jsongo.TypeMap {
106 pkg.Aliases = make([]Alias, aliases.Len())
107 for i, key := range aliases.GetKeys() {
108 aliasNode := aliases.At(key)
110 alias, err := parseAlias(ctx, key.(string), aliasNode)
114 pkg.Aliases[i] = *alias
115 pkg.RefMap[toApiType(alias.Name)] = alias.Name
118 // sort aliases to ensure consistent order
119 sort.Slice(pkg.Aliases, func(i, j int) bool {
120 return pkg.Aliases[i].Name < pkg.Aliases[j].Name
124 types := jsonRoot.Map(objTypes)
125 pkg.Types = make([]Type, types.Len())
126 for i := 0; i < types.Len(); i++ {
127 typNode := types.At(i)
129 typ, err := parseType(ctx, typNode)
134 pkg.RefMap[toApiType(typ.Name)] = typ.Name
137 sort.SliceStable(pkg.Types, func(i, j int) bool {
138 return pkg.Types[i].Name < pkg.Types[j].Name
142 unions := jsonRoot.Map(objUnions)
143 pkg.Unions = make([]Union, unions.Len())
144 for i := 0; i < unions.Len(); i++ {
145 unionNode := unions.At(i)
147 union, err := parseUnion(ctx, unionNode)
151 pkg.Unions[i] = *union
152 pkg.RefMap[toApiType(union.Name)] = union.Name
155 sort.SliceStable(pkg.Unions, func(i, j int) bool {
156 return pkg.Unions[i].Name < pkg.Unions[j].Name
160 messages := jsonRoot.Map(objMessages)
161 pkg.Messages = make([]Message, messages.Len())
162 for i := 0; i < messages.Len(); i++ {
163 msgNode := messages.At(i)
165 msg, err := parseMessage(ctx, msgNode)
169 pkg.Messages[i] = *msg
172 sort.SliceStable(pkg.Messages, func(i, j int) bool {
173 return pkg.Messages[i].Name < pkg.Messages[j].Name
177 services := jsonRoot.Map(objServices)
178 if services.GetType() == jsongo.TypeMap {
179 pkg.Services = make([]Service, services.Len())
180 for i, key := range services.GetKeys() {
181 svcNode := services.At(key)
183 svc, err := parseService(ctx, key.(string), svcNode)
187 pkg.Services[i] = *svc
191 sort.Slice(pkg.Services, func(i, j int) bool {
193 if pkg.Services[i].Stream != pkg.Services[j].Stream {
194 return pkg.Services[i].Stream
196 return pkg.Services[i].RequestType < pkg.Services[j].RequestType
204 // printPackage prints all loaded objects for package
205 func printPackage(pkg *Package) {
206 if len(pkg.Enums) > 0 {
207 logf("loaded %d enums:", len(pkg.Enums))
208 for k, enum := range pkg.Enums {
209 logf(" - enum #%d\t%+v", k, enum)
212 if len(pkg.Unions) > 0 {
213 logf("loaded %d unions:", len(pkg.Unions))
214 for k, union := range pkg.Unions {
215 logf(" - union #%d\t%+v", k, union)
218 if len(pkg.Types) > 0 {
219 logf("loaded %d types:", len(pkg.Types))
220 for _, typ := range pkg.Types {
221 logf(" - type: %q (%d fields)", typ.Name, len(typ.Fields))
224 if len(pkg.Messages) > 0 {
225 logf("loaded %d messages:", len(pkg.Messages))
226 for _, msg := range pkg.Messages {
227 logf(" - message: %q (%d fields)", msg.Name, len(msg.Fields))
230 if len(pkg.Services) > 0 {
231 logf("loaded %d services:", len(pkg.Services))
232 for _, svc := range pkg.Services {
236 } else if len(svc.Events) > 0 {
237 info = fmt.Sprintf("(EVENTS: %v)", svc.Events)
239 logf(" - service: %q -> %q %s", svc.RequestType, svc.ReplyType, info)
244 // parseEnum parses VPP binary API enum object from JSON node
245 func parseEnum(ctx *context, enumNode *jsongo.JSONNode) (*Enum, error) {
246 if enumNode.Len() == 0 || enumNode.At(0).GetType() != jsongo.TypeValue {
247 return nil, errors.New("invalid JSON for enum specified")
250 enumName, ok := enumNode.At(0).Get().(string)
252 return nil, fmt.Errorf("enum name is %T, not a string", enumNode.At(0).Get())
254 enumType, ok := enumNode.At(enumNode.Len() - 1).At("enumtype").Get().(string)
256 return nil, fmt.Errorf("enum type invalid or missing")
264 // loop through enum entries, skip first (name) and last (enumtype)
265 for j := 1; j < enumNode.Len()-1; j++ {
266 if enumNode.At(j).GetType() == jsongo.TypeArray {
267 entry := enumNode.At(j)
269 if entry.Len() < 2 || entry.At(0).GetType() != jsongo.TypeValue || entry.At(1).GetType() != jsongo.TypeValue {
270 return nil, errors.New("invalid JSON for enum entry specified")
273 entryName, ok := entry.At(0).Get().(string)
275 return nil, fmt.Errorf("enum entry name is %T, not a string", entry.At(0).Get())
277 entryVal := entry.At(1).Get()
279 enum.Entries = append(enum.Entries, EnumEntry{
289 // parseUnion parses VPP binary API union object from JSON node
290 func parseUnion(ctx *context, unionNode *jsongo.JSONNode) (*Union, error) {
291 if unionNode.Len() == 0 || unionNode.At(0).GetType() != jsongo.TypeValue {
292 return nil, errors.New("invalid JSON for union specified")
295 unionName, ok := unionNode.At(0).Get().(string)
297 return nil, fmt.Errorf("union name is %T, not a string", unionNode.At(0).Get())
299 unionCRC, ok := unionNode.At(unionNode.Len() - 1).At(crcField).Get().(string)
301 return nil, fmt.Errorf("union crc invalid or missing")
309 // loop through union fields, skip first (name) and last (crc)
310 for j := 1; j < unionNode.Len()-1; j++ {
311 if unionNode.At(j).GetType() == jsongo.TypeArray {
312 fieldNode := unionNode.At(j)
314 field, err := parseField(ctx, fieldNode)
319 union.Fields = append(union.Fields, *field)
326 // parseType parses VPP binary API type object from JSON node
327 func parseType(ctx *context, typeNode *jsongo.JSONNode) (*Type, error) {
328 if typeNode.Len() == 0 || typeNode.At(0).GetType() != jsongo.TypeValue {
329 return nil, errors.New("invalid JSON for type specified")
332 typeName, ok := typeNode.At(0).Get().(string)
334 return nil, fmt.Errorf("type name is %T, not a string", typeNode.At(0).Get())
336 typeCRC, ok := typeNode.At(typeNode.Len() - 1).At(crcField).Get().(string)
338 return nil, fmt.Errorf("type crc invalid or missing")
346 // loop through type fields, skip first (name) and last (crc)
347 for j := 1; j < typeNode.Len()-1; j++ {
348 if typeNode.At(j).GetType() == jsongo.TypeArray {
349 fieldNode := typeNode.At(j)
351 field, err := parseField(ctx, fieldNode)
356 typ.Fields = append(typ.Fields, *field)
363 // parseAlias parses VPP binary API alias object from JSON node
364 func parseAlias(ctx *context, aliasName string, aliasNode *jsongo.JSONNode) (*Alias, error) {
365 if aliasNode.Len() == 0 || aliasNode.At(aliasTypeField).GetType() != jsongo.TypeValue {
366 return nil, errors.New("invalid JSON for alias specified")
373 if typeNode := aliasNode.At(aliasTypeField); typeNode.GetType() == jsongo.TypeValue {
374 typ, ok := typeNode.Get().(string)
376 return nil, fmt.Errorf("alias type is %T, not a string", typeNode.Get())
383 if lengthNode := aliasNode.At(aliasLengthField); lengthNode.GetType() == jsongo.TypeValue {
384 length, ok := lengthNode.Get().(float64)
386 return nil, fmt.Errorf("alias length is %T, not a float64", lengthNode.Get())
388 alias.Length = int(length)
394 // parseMessage parses VPP binary API message object from JSON node
395 func parseMessage(ctx *context, msgNode *jsongo.JSONNode) (*Message, error) {
396 if msgNode.Len() == 0 || msgNode.At(0).GetType() != jsongo.TypeValue {
397 return nil, errors.New("invalid JSON for message specified")
400 msgName, ok := msgNode.At(0).Get().(string)
402 return nil, fmt.Errorf("message name is %T, not a string", msgNode.At(0).Get())
404 msgCRC, ok := msgNode.At(msgNode.Len() - 1).At(crcField).Get().(string)
407 return nil, fmt.Errorf("message crc invalid or missing")
415 // loop through message fields, skip first (name) and last (crc)
416 for j := 1; j < msgNode.Len()-1; j++ {
417 if msgNode.At(j).GetType() == jsongo.TypeArray {
418 fieldNode := msgNode.At(j)
420 field, err := parseField(ctx, fieldNode)
425 msg.Fields = append(msg.Fields, *field)
432 // parseField parses VPP binary API object field from JSON node
433 func parseField(ctx *context, field *jsongo.JSONNode) (*Field, error) {
434 if field.Len() < 2 || field.At(0).GetType() != jsongo.TypeValue || field.At(1).GetType() != jsongo.TypeValue {
435 return nil, errors.New("invalid JSON for field specified")
438 fieldType, ok := field.At(0).Get().(string)
440 return nil, fmt.Errorf("field type is %T, not a string", field.At(0).Get())
442 fieldName, ok := field.At(1).Get().(string)
444 return nil, fmt.Errorf("field name is %T, not a string", field.At(1).Get())
452 if field.Len() >= 3 {
453 if field.At(2).GetType() == jsongo.TypeValue {
454 fieldLength, ok := field.At(2).Get().(float64)
456 return nil, fmt.Errorf("field length is %T, not float64", field.At(2).Get())
458 f.Length = int(fieldLength)
459 } else if field.At(2).GetType() == jsongo.TypeMap {
460 fieldMeta := field.At(2)
462 for _, key := range fieldMeta.GetKeys() {
463 metaNode := fieldMeta.At(key)
465 switch metaName := key.(string); metaName {
467 f.Meta.Limit = int(metaNode.Get().(float64))
469 log.Warnf("unknown meta info (%s) for field (%s)", metaName, fieldName)
473 return nil, errors.New("invalid JSON for field specified")
476 if field.Len() >= 4 {
477 fieldLengthFrom, ok := field.At(3).Get().(string)
479 return nil, fmt.Errorf("field length from is %T, not a string", field.At(3).Get())
481 f.SizeFrom = fieldLengthFrom
487 // parseService parses VPP binary API service object from JSON node
488 func parseService(ctx *context, svcName string, svcNode *jsongo.JSONNode) (*Service, error) {
489 if svcNode.Len() == 0 || svcNode.At(replyField).GetType() != jsongo.TypeValue {
490 return nil, errors.New("invalid JSON for service specified")
494 Name: ctx.moduleName + "." + svcName,
495 RequestType: svcName,
498 if replyNode := svcNode.At(replyField); replyNode.GetType() == jsongo.TypeValue {
499 reply, ok := replyNode.Get().(string)
501 return nil, fmt.Errorf("service reply is %T, not a string", replyNode.Get())
503 if reply != serviceNoReply {
504 svc.ReplyType = reply
508 // stream service (dumps)
509 if streamNode := svcNode.At(streamField); streamNode.GetType() == jsongo.TypeValue {
511 svc.Stream, ok = streamNode.Get().(bool)
513 return nil, fmt.Errorf("service stream is %T, not a string", streamNode.Get())
517 // events service (event subscription)
518 if eventsNode := svcNode.At(eventsField); eventsNode.GetType() == jsongo.TypeArray {
519 for j := 0; j < eventsNode.Len(); j++ {
520 event := eventsNode.At(j).Get().(string)
521 svc.Events = append(svc.Events, event)
526 if len(svc.Events) > 0 {
528 if !strings.HasPrefix(svc.RequestType, serviceEventPrefix) {
529 log.Debugf("unusual EVENTS service: %+v\n"+
530 "- events service %q does not have %q prefix in request.",
531 svc, svc.Name, serviceEventPrefix)
533 } else if svc.Stream {
535 if !strings.HasSuffix(svc.RequestType, serviceDumpSuffix) ||
536 !strings.HasSuffix(svc.ReplyType, serviceDetailsSuffix) {
537 log.Debugf("unusual STREAM service: %+v\n"+
538 "- stream service %q does not have %q suffix in request or reply does not have %q suffix.",
539 svc, svc.Name, serviceDumpSuffix, serviceDetailsSuffix)
541 } else if svc.ReplyType != "" && svc.ReplyType != serviceNoReply {
543 // some messages might have `null` reply (for example: memclnt)
544 if !strings.HasSuffix(svc.ReplyType, serviceReplySuffix) {
545 log.Debugf("unusual REQUEST service: %+v\n"+
546 "- service %q does not have %q suffix in reply.",
547 svc, svc.Name, serviceReplySuffix)