"fmt"
"reflect"
- "git.fd.io/govpp.git/api"
"github.com/lunixbochs/struc"
+
+ "git.fd.io/govpp.git/api"
)
// MsgCodec provides encoding and decoding functionality of `api.Message` structs into/from
// VppEventHeader struct contains header fields implemented by all VPP events.
type VppEventHeader struct {
- VlMsgID uint16
- Context uint32
+ VlMsgID uint16
+ ClientIndex uint32
}
// VppOtherHeader struct contains header fields implemented by other VPP messages (not requests nor replies).
VlMsgID uint16
}
-const (
- vppRequestHeaderSize = 10 // size of a VPP request header
- vppReplyHeaderSize = 6 // size of a VPP reply header
- vppEventHeaderSize = 6 // size of a VPP event header
- vppOtherHeaderSize = 2 // size of the header of other VPP messages
-)
-
// EncodeMsg encodes provided `Message` structure into its binary-encoded data representation.
-func (*MsgCodec) EncodeMsg(msg api.Message, msgID uint16) ([]byte, error) {
+func (*MsgCodec) EncodeMsg(msg api.Message, msgID uint16) (data []byte, err error) {
if msg == nil {
return nil, errors.New("nil message passed in")
}
- buf := new(bytes.Buffer)
+ // try to recover panic which might possibly occur in struc.Pack call
+ defer func() {
+ if r := recover(); r != nil {
+ var ok bool
+ if err, ok = r.(error); !ok {
+ err = fmt.Errorf("%v", r)
+ }
+ err = fmt.Errorf("panic occurred during encoding message %s: %v", msg.GetMessageName(), err)
+ }
+ }()
- // encode message header
var header interface{}
- if msg.GetMessageType() == api.RequestMessage {
+
+ // encode message header
+ switch msg.GetMessageType() {
+ case api.RequestMessage:
header = &VppRequestHeader{VlMsgID: msgID}
- } else if msg.GetMessageType() == api.ReplyMessage {
+ case api.ReplyMessage:
header = &VppReplyHeader{VlMsgID: msgID}
- } else if msg.GetMessageType() == api.EventMessage {
+ case api.EventMessage:
header = &VppEventHeader{VlMsgID: msgID}
- } else {
+ default:
header = &VppOtherHeader{VlMsgID: msgID}
}
- err := struc.Pack(buf, header)
- if err != nil {
- return nil, fmt.Errorf("unable to encode message: header: %v, error %v", header, err)
+
+ buf := new(bytes.Buffer)
+
+ // encode message header
+ if err := struc.Pack(buf, header); err != nil {
+ return nil, fmt.Errorf("failed to encode message header: %+v, error: %v", header, err)
}
// encode message content
- if reflect.Indirect(reflect.ValueOf(msg)).NumField() > 0 {
- err := struc.Pack(buf, msg)
- if err != nil {
- return nil, fmt.Errorf("unable to encode message: header %v, error %v", header, err)
+ if reflect.TypeOf(msg).Elem().NumField() > 0 {
+ if err := struc.Pack(buf, msg); err != nil {
+ return nil, fmt.Errorf("failed to encode message data: %+v, error: %v", data, err)
}
}
}
// DecodeMsg decodes binary-encoded data of a message into provided `Message` structure.
-func (*MsgCodec) DecodeMsg(data []byte, msg api.Message) error {
+func (*MsgCodec) DecodeMsg(data []byte, msg api.Message) (err error) {
if msg == nil {
return errors.New("nil message passed in")
}
- buf := bytes.NewReader(data)
+ // try to recover panic which might possibly occur
+ defer func() {
+ if r := recover(); r != nil {
+ var ok bool
+ if err, ok = r.(error); !ok {
+ err = fmt.Errorf("%v", r)
+ }
+ err = fmt.Errorf("panic occurred during decoding message %s: %v", msg.GetMessageName(), err)
+ }
+ }()
- // check which header is expected
var header interface{}
- if msg.GetMessageType() == api.RequestMessage {
- header = &VppRequestHeader{}
- } else if msg.GetMessageType() == api.ReplyMessage {
- header = &VppReplyHeader{}
- } else if msg.GetMessageType() == api.EventMessage {
- header = &VppEventHeader{}
- } else {
- header = &VppOtherHeader{}
- }
- // decode message header
- err := struc.Unpack(buf, header)
- if err != nil {
- return fmt.Errorf("unable to decode message: data %v, error %v", data, err)
+ // check which header is expected
+ switch msg.GetMessageType() {
+ case api.RequestMessage:
+ header = new(VppRequestHeader)
+ case api.ReplyMessage:
+ header = new(VppReplyHeader)
+ case api.EventMessage:
+ header = new(VppEventHeader)
+ default:
+ header = new(VppOtherHeader)
}
- // get rid of the message header
- if msg.GetMessageType() == api.RequestMessage {
- buf = bytes.NewReader(data[vppRequestHeaderSize:])
- } else if msg.GetMessageType() == api.ReplyMessage {
- buf = bytes.NewReader(data[vppReplyHeaderSize:])
- } else if msg.GetMessageType() == api.EventMessage {
- buf = bytes.NewReader(data[vppEventHeaderSize:])
- } else {
- buf = bytes.NewReader(data[vppOtherHeaderSize:])
+ buf := bytes.NewReader(data)
+
+ // decode message header
+ if err = struc.Unpack(buf, header); err != nil {
+ return fmt.Errorf("failed to decode message header: %+v, error: %v", header, err)
}
// decode message content
- err = struc.Unpack(buf, msg)
- if err != nil {
- return fmt.Errorf("unable to decode message: data %v, error %v", data, err)
+ if err := struc.Unpack(buf, msg); err != nil {
+ return fmt.Errorf("failed to decode message data: %+v, error: %v", data, err)
}
return nil
}
+
+func (*MsgCodec) DecodeMsgContext(data []byte, msg api.Message) (uint32, error) {
+ if msg == nil {
+ return 0, errors.New("nil message passed in")
+ }
+
+ var header interface{}
+ var getContext func() uint32
+
+ // check which header is expected
+ switch msg.GetMessageType() {
+ case api.RequestMessage:
+ header = new(VppRequestHeader)
+ getContext = func() uint32 { return header.(*VppRequestHeader).Context }
+
+ case api.ReplyMessage:
+ header = new(VppReplyHeader)
+ getContext = func() uint32 { return header.(*VppReplyHeader).Context }
+
+ default:
+ return 0, nil
+ }
+
+ buf := bytes.NewReader(data)
+
+ // decode message header
+ if err := struc.Unpack(buf, header); err != nil {
+ return 0, fmt.Errorf("decoding message header failed: %v", err)
+ }
+
+ return getContext(), nil
+}
Code Review / govpp.git / blobdiff