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"
24 "github.com/sirupsen/logrus"
30 objMessages = "messages"
33 objServices = "services"
34 objAliases = "aliases"
35 vlAPIVersion = "vl_api_version"
36 objOptions = "options"
39 // various object fields
42 msgIdField = "_vl_msg_id"
44 clientIndexField = "client_index"
45 contextField = "context"
47 aliasLengthField = "length"
48 aliasTypeField = "type"
51 streamField = "stream"
52 eventsField = "events"
57 serviceEventPrefix = "want_"
58 serviceDumpSuffix = "_dump"
59 serviceDetailsSuffix = "_details"
60 serviceReplySuffix = "_reply"
61 serviceNoReply = "null"
66 fieldMetaLimit = "limit"
71 versionOption = "version"
74 // parsePackage parses provided JSON data into objects prepared for code generation
75 func parsePackage(ctx *context, jsonRoot *jsongo.JSONNode) (*Package, error) {
77 Name: ctx.packageName,
78 RefMap: make(map[string]string),
81 // parse CRC for API version
82 if crc := jsonRoot.At(vlAPIVersion); crc.GetType() == jsongo.TypeValue {
83 pkg.CRC = crc.Get().(string)
86 // parse version string
87 if opt := jsonRoot.Map(objOptions); opt.GetType() == jsongo.TypeMap {
88 if ver := opt.Map(versionOption); ver.GetType() == jsongo.TypeValue {
89 pkg.Version = ver.Get().(string)
93 logf("parsing package %s (version: %s, CRC: %s)", pkg.Name, pkg.Version, pkg.CRC)
95 for _, key := range jsonRoot.GetKeys() {
96 logf(" - %d %s", jsonRoot.At(key).Len(), key)
100 enums := jsonRoot.Map(objEnums)
101 pkg.Enums = make([]Enum, 0)
102 for i := 0; i < enums.Len(); i++ {
103 enumNode := enums.At(i)
105 enum, err := parseEnum(ctx, enumNode)
110 enumApi := toApiType(enum.Name)
111 if _, ok := pkg.RefMap[enumApi]; ok {
112 logf("enum %v already known", enumApi)
115 pkg.RefMap[enumApi] = enum.Name
116 pkg.Enums = append(pkg.Enums, *enum)
119 sort.SliceStable(pkg.Enums, func(i, j int) bool {
120 return pkg.Enums[i].Name < pkg.Enums[j].Name
124 aliases := jsonRoot.Map(objAliases)
125 if aliases.GetType() == jsongo.TypeMap {
126 pkg.Aliases = make([]Alias, 0)
127 for _, key := range aliases.GetKeys() {
128 aliasNode := aliases.At(key)
130 alias, err := parseAlias(ctx, key.(string), aliasNode)
135 aliasApi := toApiType(alias.Name)
136 if _, ok := pkg.RefMap[aliasApi]; ok {
137 logf("alias %v already known", aliasApi)
140 pkg.RefMap[aliasApi] = alias.Name
141 pkg.Aliases = append(pkg.Aliases, *alias)
144 // sort aliases to ensure consistent order
145 sort.Slice(pkg.Aliases, func(i, j int) bool {
146 return pkg.Aliases[i].Name < pkg.Aliases[j].Name
150 types := jsonRoot.Map(objTypes)
151 pkg.Types = make([]Type, 0)
152 for i := 0; i < types.Len(); i++ {
153 typNode := types.At(i)
155 typ, err := parseType(ctx, typNode)
160 typApi := toApiType(typ.Name)
161 if _, ok := pkg.RefMap[typApi]; ok {
162 logf("type %v already known", typApi)
165 pkg.RefMap[typApi] = typ.Name
166 pkg.Types = append(pkg.Types, *typ)
169 sort.SliceStable(pkg.Types, func(i, j int) bool {
170 return pkg.Types[i].Name < pkg.Types[j].Name
174 unions := jsonRoot.Map(objUnions)
175 pkg.Unions = make([]Union, 0)
176 for i := 0; i < unions.Len(); i++ {
177 unionNode := unions.At(i)
179 union, err := parseUnion(ctx, unionNode)
184 unionApi := toApiType(union.Name)
185 if _, ok := pkg.RefMap[unionApi]; ok {
186 logf("union %v already known", unionApi)
189 pkg.RefMap[unionApi] = union.Name
190 pkg.Unions = append(pkg.Unions, *union)
193 sort.SliceStable(pkg.Unions, func(i, j int) bool {
194 return pkg.Unions[i].Name < pkg.Unions[j].Name
198 messages := jsonRoot.Map(objMessages)
199 pkg.Messages = make([]Message, messages.Len())
200 for i := 0; i < messages.Len(); i++ {
201 msgNode := messages.At(i)
203 msg, err := parseMessage(ctx, msgNode)
207 pkg.Messages[i] = *msg
210 sort.SliceStable(pkg.Messages, func(i, j int) bool {
211 return pkg.Messages[i].Name < pkg.Messages[j].Name
215 services := jsonRoot.Map(objServices)
216 if services.GetType() == jsongo.TypeMap {
217 pkg.Services = make([]Service, services.Len())
218 for i, key := range services.GetKeys() {
219 svcNode := services.At(key)
221 svc, err := parseService(ctx, key.(string), svcNode)
225 pkg.Services[i] = *svc
229 sort.Slice(pkg.Services, func(i, j int) bool {
231 if pkg.Services[i].Stream != pkg.Services[j].Stream {
232 return pkg.Services[i].Stream
234 return pkg.Services[i].RequestType < pkg.Services[j].RequestType
242 // parseEnum parses VPP binary API enum object from JSON node
243 func parseEnum(ctx *context, enumNode *jsongo.JSONNode) (*Enum, error) {
244 if enumNode.Len() == 0 || enumNode.At(0).GetType() != jsongo.TypeValue {
245 return nil, errors.New("invalid JSON for enum specified")
248 enumName, ok := enumNode.At(0).Get().(string)
250 return nil, fmt.Errorf("enum name is %T, not a string", enumNode.At(0).Get())
252 enumType, ok := enumNode.At(enumNode.Len() - 1).At("enumtype").Get().(string)
254 return nil, fmt.Errorf("enum type invalid or missing")
262 // loop through enum entries, skip first (name) and last (enumtype)
263 for j := 1; j < enumNode.Len()-1; j++ {
264 if enumNode.At(j).GetType() == jsongo.TypeArray {
265 entry := enumNode.At(j)
267 if entry.Len() < 2 || entry.At(0).GetType() != jsongo.TypeValue || entry.At(1).GetType() != jsongo.TypeValue {
268 return nil, errors.New("invalid JSON for enum entry specified")
271 entryName, ok := entry.At(0).Get().(string)
273 return nil, fmt.Errorf("enum entry name is %T, not a string", entry.At(0).Get())
275 entryVal := entry.At(1).Get()
277 enum.Entries = append(enum.Entries, EnumEntry{
287 // parseUnion parses VPP binary API union object from JSON node
288 func parseUnion(ctx *context, unionNode *jsongo.JSONNode) (*Union, error) {
289 if unionNode.Len() == 0 || unionNode.At(0).GetType() != jsongo.TypeValue {
290 return nil, errors.New("invalid JSON for union specified")
293 unionName, ok := unionNode.At(0).Get().(string)
295 return nil, fmt.Errorf("union name is %T, not a string", unionNode.At(0).Get())
298 if unionNode.At(unionNode.Len()-1).GetType() == jsongo.TypeMap {
299 unionCRC = unionNode.At(unionNode.Len() - 1).At(crcField).Get().(string)
307 // loop through union fields, skip first (name)
308 for j := 1; j < unionNode.Len(); j++ {
309 if unionNode.At(j).GetType() == jsongo.TypeArray {
310 fieldNode := unionNode.At(j)
312 field, err := parseField(ctx, fieldNode)
317 union.Fields = append(union.Fields, *field)
324 // parseType parses VPP binary API type object from JSON node
325 func parseType(ctx *context, typeNode *jsongo.JSONNode) (*Type, error) {
326 if typeNode.Len() == 0 || typeNode.At(0).GetType() != jsongo.TypeValue {
327 return nil, errors.New("invalid JSON for type specified")
330 typeName, ok := typeNode.At(0).Get().(string)
332 return nil, fmt.Errorf("type name is %T, not a string", typeNode.At(0).Get())
335 if lastField := typeNode.At(typeNode.Len() - 1); lastField.GetType() == jsongo.TypeMap {
336 typeCRC = lastField.At(crcField).Get().(string)
344 // loop through type fields, skip first (name)
345 for j := 1; j < typeNode.Len(); j++ {
346 if typeNode.At(j).GetType() == jsongo.TypeArray {
347 fieldNode := typeNode.At(j)
349 field, err := parseField(ctx, fieldNode)
354 typ.Fields = append(typ.Fields, *field)
361 // parseAlias parses VPP binary API alias object from JSON node
362 func parseAlias(ctx *context, aliasName string, aliasNode *jsongo.JSONNode) (*Alias, error) {
363 if aliasNode.Len() == 0 || aliasNode.At(aliasTypeField).GetType() != jsongo.TypeValue {
364 return nil, errors.New("invalid JSON for alias specified")
371 if typeNode := aliasNode.At(aliasTypeField); typeNode.GetType() == jsongo.TypeValue {
372 typ, ok := typeNode.Get().(string)
374 return nil, fmt.Errorf("alias type is %T, not a string", typeNode.Get())
381 if lengthNode := aliasNode.At(aliasLengthField); lengthNode.GetType() == jsongo.TypeValue {
382 length, ok := lengthNode.Get().(float64)
384 return nil, fmt.Errorf("alias length is %T, not a float64", lengthNode.Get())
386 alias.Length = int(length)
392 // parseMessage parses VPP binary API message object from JSON node
393 func parseMessage(ctx *context, msgNode *jsongo.JSONNode) (*Message, error) {
394 if msgNode.Len() == 0 || msgNode.At(0).GetType() != jsongo.TypeValue {
395 return nil, errors.New("invalid JSON for message specified")
398 msgName, ok := msgNode.At(0).Get().(string)
400 return nil, fmt.Errorf("message name is %T, not a string", msgNode.At(0).Get())
402 msgCRC, ok := msgNode.At(msgNode.Len() - 1).At(crcField).Get().(string)
405 return nil, fmt.Errorf("message crc invalid or missing")
413 // loop through message fields, skip first (name) and last (crc)
414 for j := 1; j < msgNode.Len()-1; j++ {
415 if msgNode.At(j).GetType() == jsongo.TypeArray {
416 fieldNode := msgNode.At(j)
418 field, err := parseField(ctx, fieldNode)
423 msg.Fields = append(msg.Fields, *field)
430 // parseField parses VPP binary API object field from JSON node
431 func parseField(ctx *context, field *jsongo.JSONNode) (*Field, error) {
432 if field.Len() < 2 || field.At(0).GetType() != jsongo.TypeValue || field.At(1).GetType() != jsongo.TypeValue {
433 return nil, errors.New("invalid JSON for field specified")
436 fieldType, ok := field.At(0).Get().(string)
438 return nil, fmt.Errorf("field type is %T, not a string", field.At(0).Get())
440 fieldName, ok := field.At(1).Get().(string)
442 return nil, fmt.Errorf("field name is %T, not a string", field.At(1).Get())
450 if field.Len() >= 3 {
451 if field.At(2).GetType() == jsongo.TypeValue {
452 fieldLength, ok := field.At(2).Get().(float64)
454 return nil, fmt.Errorf("field length is %T, not float64", field.At(2).Get())
456 f.Length = int(fieldLength)
457 } else if field.At(2).GetType() == jsongo.TypeMap {
458 fieldMeta := field.At(2)
460 for _, key := range fieldMeta.GetKeys() {
461 metaNode := fieldMeta.At(key)
463 switch metaName := key.(string); metaName {
465 f.Meta.Limit = int(metaNode.Get().(float64))
467 logrus.Warnf("unknown meta info (%s) for field (%s)", metaName, fieldName)
471 return nil, errors.New("invalid JSON for field specified")
474 if field.Len() >= 4 {
475 fieldLengthFrom, ok := field.At(3).Get().(string)
477 return nil, fmt.Errorf("field length from is %T, not a string", field.At(3).Get())
479 f.SizeFrom = fieldLengthFrom
485 // parseService parses VPP binary API service object from JSON node
486 func parseService(ctx *context, svcName string, svcNode *jsongo.JSONNode) (*Service, error) {
487 if svcNode.Len() == 0 || svcNode.At(replyField).GetType() != jsongo.TypeValue {
488 return nil, errors.New("invalid JSON for service specified")
493 RequestType: svcName,
496 if replyNode := svcNode.At(replyField); replyNode.GetType() == jsongo.TypeValue {
497 reply, ok := replyNode.Get().(string)
499 return nil, fmt.Errorf("service reply is %T, not a string", replyNode.Get())
501 if reply != serviceNoReply {
502 svc.ReplyType = reply
506 // stream service (dumps)
507 if streamNode := svcNode.At(streamField); streamNode.GetType() == jsongo.TypeValue {
509 svc.Stream, ok = streamNode.Get().(bool)
511 return nil, fmt.Errorf("service stream is %T, not a string", streamNode.Get())
515 // events service (event subscription)
516 if eventsNode := svcNode.At(eventsField); eventsNode.GetType() == jsongo.TypeArray {
517 for j := 0; j < eventsNode.Len(); j++ {
518 event := eventsNode.At(j).Get().(string)
519 svc.Events = append(svc.Events, event)
524 if len(svc.Events) > 0 {
526 if !strings.HasPrefix(svc.RequestType, serviceEventPrefix) {
527 logrus.Debugf("unusual EVENTS service: %+v\n"+
528 "- events service %q does not have %q prefix in request.",
529 svc, svc.Name, serviceEventPrefix)
531 } else if svc.Stream {
533 if !strings.HasSuffix(svc.RequestType, serviceDumpSuffix) ||
534 !strings.HasSuffix(svc.ReplyType, serviceDetailsSuffix) {
535 logrus.Debugf("unusual STREAM service: %+v\n"+
536 "- stream service %q does not have %q suffix in request or reply does not have %q suffix.",
537 svc, svc.Name, serviceDumpSuffix, serviceDetailsSuffix)
539 } else if svc.ReplyType != "" && svc.ReplyType != serviceNoReply {
541 // some messages might have `null` reply (for example: memclnt)
542 if !strings.HasSuffix(svc.ReplyType, serviceReplySuffix) {
543 logrus.Debugf("unusual REQUEST service: %+v\n"+
544 "- service %q does not have %q suffix in reply.",
545 svc, svc.Name, serviceReplySuffix)