codec/msg_codec.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 codec
  16
  17 import (
  18         "bytes"
  19         "errors"
  20         "fmt"
  21         "reflect"
  22
  23         "git.fd.io/govpp.git/api"
  24         "github.com/lunixbochs/struc"
  25 )
  26
  27 // MsgCodec provides encoding and decoding functionality of `api.Message` structs into/from
  28 // binary format as accepted by VPP.
  29 type MsgCodec struct{}
  30
  31 // VppRequestHeader struct contains header fields implemented by all VPP requests.
  32 type VppRequestHeader struct {
  33         VlMsgID     uint16
  34         ClientIndex uint32
  35         Context     uint32
  36 }
  37
  38 // VppReplyHeader struct contains header fields implemented by all VPP replies.
  39 type VppReplyHeader struct {
  40         VlMsgID uint16
  41         Context uint32
  42 }
  43
  44 // VppEventHeader struct contains header fields implemented by all VPP events.
  45 type VppEventHeader struct {
  46         VlMsgID     uint16
  47         ClientIndex uint32
  48 }
  49
  50 // VppOtherHeader struct contains header fields implemented by other VPP messages (not requests nor replies).
  51 type VppOtherHeader struct {
  52         VlMsgID uint16
  53 }
  54
  55 // EncodeMsg encodes provided `Message` structure into its binary-encoded data representation.
  56 func (*MsgCodec) EncodeMsg(msg api.Message, msgID uint16) ([]byte, error) {
  57         if msg == nil {
  58                 return nil, errors.New("nil message passed in")
  59         }
  60
  61         var header interface{}
  62
  63         // encode message header
  64         switch msg.GetMessageType() {
  65         case api.RequestMessage:
  66                 header = &VppRequestHeader{VlMsgID: msgID}
  67
  68         case api.ReplyMessage:
  69                 header = &VppReplyHeader{VlMsgID: msgID}
  70
  71         case api.EventMessage:
  72                 header = &VppEventHeader{VlMsgID: msgID}
  73
  74         default:
  75                 header = &VppOtherHeader{VlMsgID: msgID}
  76         }
  77
  78         buf := new(bytes.Buffer)
  79
  80         // encode message header
  81         if err := struc.Pack(buf, header); err != nil {
  82                 return nil, fmt.Errorf("unable to encode message header: %v, error %v", header, err)
  83         }
  84
  85         // encode message content
  86         if reflect.TypeOf(msg).Elem().NumField() > 0 {
  87                 if err := struc.Pack(buf, msg); err != nil {
  88                         return nil, fmt.Errorf("unable to encode message data: %v, error %v", header, err)
  89                 }
  90         }
  91
  92         return buf.Bytes(), nil
  93 }
  94
  95 // DecodeMsg decodes binary-encoded data of a message into provided `Message` structure.
  96 func (*MsgCodec) DecodeMsg(data []byte, msg api.Message) error {
  97         if msg == nil {
  98                 return errors.New("nil message passed in")
  99         }
 100
 101         var header interface{}
 102
 103         // check which header is expected
 104         switch msg.GetMessageType() {
 105         case api.RequestMessage:
 106                 header = new(VppRequestHeader)
 107
 108         case api.ReplyMessage:
 109                 header = new(VppReplyHeader)
 110
 111         case api.EventMessage:
 112                 header = new(VppEventHeader)
 113
 114         default:
 115                 header = new(VppOtherHeader)
 116         }
 117
 118         buf := bytes.NewReader(data)
 119
 120         // decode message header
 121         if err := struc.Unpack(buf, header); err != nil {
 122                 return fmt.Errorf("unable to decode message header: %+v, error %v", data, err)
 123         }
 124
 125         // decode message content
 126         if err := struc.Unpack(buf, msg); err != nil {
 127                 return fmt.Errorf("unable to decode message data: %+v, error %v", data, err)
 128         }
 129
 130         return nil
 131 }
 132
 133 func (*MsgCodec) DecodeMsgContext(data []byte, msg api.Message) (uint32, error) {
 134         if msg == nil {
 135                 return 0, errors.New("nil message passed in")
 136         }
 137
 138         var header interface{}
 139         var getContext func() uint32
 140
 141         // check which header is expected
 142         switch msg.GetMessageType() {
 143         case api.RequestMessage:
 144                 header = new(VppRequestHeader)
 145                 getContext = func() uint32 { return header.(*VppRequestHeader).Context }
 146
 147         case api.ReplyMessage:
 148                 header = new(VppReplyHeader)
 149                 getContext = func() uint32 { return header.(*VppReplyHeader).Context }
 150
 151         default:
 152                 return 0, nil
 153         }
 154
 155         buf := bytes.NewReader(data)
 156
 157         // decode message header
 158         if err := struc.Unpack(buf, header); err != nil {
 159                 return 0, fmt.Errorf("decoding message header failed: %v", err)
 160         }
 161
 162         return getContext(), nil
 163 }