1 // Copyright (c) 2017 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 logger "github.com/sirupsen/logrus"
27 ErrNotConnected = errors.New("not connected to VPP, ignoring the request")
28 ErrProbeTimeout = errors.New("probe reply not received within timeout period")
31 // watchRequests watches for requests on the request API channel and forwards them as messages to VPP.
32 func (c *Connection) watchRequests(ch *Channel) {
35 case req, ok := <-ch.reqChan:
36 // new request on the request channel
38 // after closing the request channel, release API channel and return
39 c.releaseAPIChannel(ch)
42 if err := c.processRequest(ch, req); err != nil {
43 sendReplyError(ch, req, err)
49 // processRequest processes a single request received on the request channel.
50 func (c *Connection) processRequest(ch *Channel, req *vppRequest) error {
51 // check whether we are connected to VPP
52 if atomic.LoadUint32(&c.vppConnected) == 0 {
53 err := ErrNotConnected
54 log.Errorf("processing request failed: %v", err)
58 // retrieve message ID
59 msgID, err := c.GetMessageID(req.msg)
61 log.WithFields(logger.Fields{
62 "msg_name": req.msg.GetMessageName(),
63 "msg_crc": req.msg.GetCrcString(),
64 "seq_num": req.seqNum,
66 }).Errorf("failed to retrieve message ID")
67 return fmt.Errorf("unable to retrieve message ID: %v", err)
70 // encode the message into binary
71 data, err := c.codec.EncodeMsg(req.msg, msgID)
73 log.WithFields(logger.Fields{
76 "msg_name": req.msg.GetMessageName(),
77 "seq_num": req.seqNum,
79 }).Errorf("failed to encode message: %#v", req.msg)
80 return fmt.Errorf("unable to encode the message: %v", err)
83 context := packRequestContext(ch.id, req.multi, req.seqNum)
85 if log.Level == logger.DebugLevel { // for performance reasons - logrus does some processing even if debugs are disabled
86 log.WithFields(logger.Fields{
89 "is_multi": req.multi,
91 "msg_name": req.msg.GetMessageName(),
92 "msg_size": len(data),
93 "seq_num": req.seqNum,
94 }).Debug(" -> Sending a message to VPP.")
97 // send the request to VPP
98 err = c.vppClient.SendMsg(context, data)
100 err = fmt.Errorf("unable to send the message: %v", err)
101 log.WithFields(logger.Fields{
104 "seq_num": req.seqNum,
110 // send a control ping to determine end of the multipart response
111 pingData, _ := c.codec.EncodeMsg(msgControlPing, c.pingReqID)
113 log.WithFields(logger.Fields{
116 "msg_id": c.pingReqID,
117 "msg_size": len(pingData),
118 "seq_num": req.seqNum,
119 }).Debug(" -> Sending a control ping to VPP.")
121 if err := c.vppClient.SendMsg(context, pingData); err != nil {
122 log.WithFields(logger.Fields{
125 "seq_num": req.seqNum,
126 }).Warnf("unable to send control ping: %v", err)
133 // msgCallback is called whenever any binary API message comes from VPP.
134 func (c *Connection) msgCallback(msgID uint16, data []byte) {
136 log.Warn("Already disconnected, ignoring the message.")
140 msg, ok := c.msgMap[msgID]
142 log.Warnf("Unknown message received, ID: %d", msgID)
146 // decode message context to fix for special cases of messages,
148 // - replies that don't have context as first field (comes as zero)
149 // - events that don't have context at all (comes as non zero)
151 context, err := c.codec.DecodeMsgContext(data, msg)
153 log.Errorf("decoding context failed: %v", err)
156 chanID, isMulti, seqNum := unpackRequestContext(context)
157 if log.Level == logger.DebugLevel { // for performance reasons - logrus does some processing even if debugs are disabled
158 log.WithFields(logger.Fields{
161 "msg_name": msg.GetMessageName(),
162 "msg_size": len(data),
166 }).Debug(" <- Received a message from VPP.")
169 if context == 0 || c.isNotificationMessage(msgID) {
170 // process the message as a notification
171 c.sendNotifications(msgID, data)
175 // match ch according to the context
176 c.channelsLock.RLock()
177 ch, ok := c.channels[chanID]
178 c.channelsLock.RUnlock()
180 log.WithFields(logger.Fields{
183 }).Error("Channel ID not known, ignoring the message.")
187 // if this is a control ping reply to a multipart request,
188 // treat this as a last part of the reply
189 lastReplyReceived := isMulti && msgID == c.pingReplyID
191 // send the data to the channel, it needs to be copied,
192 // because it will be freed after this function returns
193 sendReply(ch, &vppReply{
196 data: append([]byte(nil), data...),
197 lastReceived: lastReplyReceived,
200 // store actual time of this reply
201 c.lastReplyLock.Lock()
202 c.lastReply = time.Now()
203 c.lastReplyLock.Unlock()
206 // sendReply sends the reply into the go channel, if it cannot be completed without blocking, otherwise
207 // it logs the error and do not send the message.
208 func sendReply(ch *Channel, reply *vppReply) {
210 case ch.replyChan <- reply:
211 // reply sent successfully
212 case <-time.After(time.Millisecond * 100):
213 // receiver still not ready
214 log.WithFields(logger.Fields{
216 "msg_id": reply.msgID,
217 "seq_num": reply.seqNum,
218 }).Warn("Unable to send the reply, reciever end not ready.")
222 func sendReplyError(ch *Channel, req *vppRequest, err error) {
223 sendReply(ch, &vppReply{seqNum: req.seqNum, err: err})
226 // isNotificationMessage returns true if someone has subscribed to provided message ID.
227 func (c *Connection) isNotificationMessage(msgID uint16) bool {
228 c.subscriptionsLock.RLock()
229 defer c.subscriptionsLock.RUnlock()
231 _, exists := c.subscriptions[msgID]
235 // sendNotifications send a notification message to all subscribers subscribed for that message.
236 func (c *Connection) sendNotifications(msgID uint16, data []byte) {
237 c.subscriptionsLock.RLock()
238 defer c.subscriptionsLock.RUnlock()
242 // send to notification to each subscriber
243 for _, sub := range c.subscriptions[msgID] {
244 log.WithFields(logger.Fields{
245 "msg_name": sub.event.GetMessageName(),
247 "msg_size": len(data),
248 }).Debug("Sending a notification to the subscription channel.")
250 event := sub.msgFactory()
251 if err := c.codec.DecodeMsg(data, event); err != nil {
252 log.WithFields(logger.Fields{
253 "msg_name": sub.event.GetMessageName(),
255 "msg_size": len(data),
256 }).Errorf("Unable to decode the notification message: %v", err)
260 // send the message into the go channel of the subscription
262 case sub.notifChan <- event:
263 // message sent successfully
265 // unable to write into the channel without blocking
266 log.WithFields(logger.Fields{
267 "msg_name": sub.event.GetMessageName(),
269 "msg_size": len(data),
270 }).Warn("Unable to deliver the notification, reciever end not ready.")
277 log.WithFields(logger.Fields{
279 "msg_size": len(data),
280 }).Info("No subscription found for the notification message.")
284 // +------------------+-------------------+-----------------------+
285 // | 15b = channel ID | 1b = is multipart | 16b = sequence number |
286 // +------------------+-------------------+-----------------------+
287 func packRequestContext(chanID uint16, isMultipart bool, seqNum uint16) uint32 {
288 context := uint32(chanID) << 17
292 context |= uint32(seqNum)
296 func unpackRequestContext(context uint32) (chanID uint16, isMulipart bool, seqNum uint16) {
297 chanID = uint16(context >> 17)
298 if ((context >> 16) & 0x1) != 0 {
301 seqNum = uint16(context & 0xffff)
305 // compareSeqNumbers returns -1, 0, 1 if sequence number <seqNum1> precedes, equals to,
306 // or succeeds seq. number <seqNum2>.
307 // Since sequence numbers cycle in the finite set of size 2^16, the function
308 // must assume that the distance between compared sequence numbers is less than
309 // (2^16)/2 to determine the order.
310 func compareSeqNumbers(seqNum1, seqNum2 uint16) int {
311 // calculate distance from seqNum1 to seqNum2
313 if seqNum1 <= seqNum2 {
314 dist = seqNum2 - seqNum1
316 dist = 0xffff - (seqNum1 - seqNum2 - 1)
320 } else if dist <= 0x8000 {