1 // Copyright (c) 2019 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.
22 "git.fd.io/govpp.git/adapter/socketclient/binapi/memclnt"
31 "github.com/fsnotify/fsnotify"
32 "github.com/sirupsen/logrus"
34 "git.fd.io/govpp.git/adapter"
35 "git.fd.io/govpp.git/codec"
39 // DefaultSocketName is default VPP API socket file path.
40 DefaultSocketName = "/run/vpp/api.sock"
41 // DefaultClientName is used for identifying client in socket registration
42 DefaultClientName = "govppsock"
47 // DefaultConnectTimeout is default timeout for connecting
48 DefaultConnectTimeout = time.Second * 3
49 // DefaultDisconnectTimeout is default timeout for discconnecting
50 DefaultDisconnectTimeout = time.Millisecond * 100
51 // MaxWaitReady defines maximum duration of waiting for socket file
52 MaxWaitReady = time.Second * 10
56 debug = strings.Contains(os.Getenv("DEBUG_GOVPP"), "socketclient")
57 debugMsgIds = strings.Contains(os.Getenv("DEBUG_GOVPP"), "msgtable")
60 log = logger.WithField("logger", "govpp/socketclient")
63 // init initializes global logger
66 logger.Level = logrus.DebugLevel
67 log.Debug("govpp: debug level enabled for socketclient")
71 const socketMissing = `
72 ------------------------------------------------------------
73 No socket file found at: %s
74 VPP binary API socket file is missing!
76 - is VPP running with socket for binapi enabled?
77 - is the correct socket name configured?
79 To enable it add following section to your VPP config:
83 ------------------------------------------------------------
86 var warnOnce sync.Once
88 func (c *socketClient) printMissingSocketMsg() {
89 fmt.Fprintf(os.Stderr, socketMissing, c.sockAddr)
92 type socketClient struct {
100 connectTimeout time.Duration
101 disconnectTimeout time.Duration
103 msgCallback adapter.MsgCallback
105 msgTable map[string]uint16
109 headerPool *sync.Pool
115 func NewVppClient(sockAddr string) *socketClient {
117 sockAddr = DefaultSocketName
119 return &socketClient{
121 clientName: DefaultClientName,
122 connectTimeout: DefaultConnectTimeout,
123 disconnectTimeout: DefaultDisconnectTimeout,
124 headerPool: &sync.Pool{New: func() interface{} {
125 return make([]byte, 16)
127 msgCallback: func(msgID uint16, data []byte) {
128 log.Debugf("no callback set, dropping message: ID=%v len=%d", msgID, len(data))
133 // SetClientName sets a client name used for identification.
134 func (c *socketClient) SetClientName(name string) {
138 // SetConnectTimeout sets timeout used during connecting.
139 func (c *socketClient) SetConnectTimeout(t time.Duration) {
143 // SetDisconnectTimeout sets timeout used during disconnecting.
144 func (c *socketClient) SetDisconnectTimeout(t time.Duration) {
145 c.disconnectTimeout = t
148 func (c *socketClient) SetMsgCallback(cb adapter.MsgCallback) {
149 log.Debug("SetMsgCallback")
153 const legacySocketName = "/run/vpp-api.sock"
155 func (c *socketClient) checkLegacySocket() bool {
156 if c.sockAddr == legacySocketName {
159 log.Debugf("checking legacy socket: %s", legacySocketName)
160 // check if socket exists
161 if _, err := os.Stat(c.sockAddr); err == nil {
162 return false // socket exists
163 } else if !os.IsNotExist(err) {
164 return false // some other error occurred
166 // check if legacy socket exists
167 if _, err := os.Stat(legacySocketName); err == nil {
168 // legacy socket exists, update sockAddr
169 c.sockAddr = legacySocketName
172 // no socket socket found
176 // WaitReady checks socket file existence and waits for it if necessary
177 func (c *socketClient) WaitReady() error {
178 // check if socket already exists
179 if _, err := os.Stat(c.sockAddr); err == nil {
180 return nil // socket exists, we are ready
181 } else if !os.IsNotExist(err) {
182 return err // some other error occurred
185 if c.checkLegacySocket() {
189 // socket does not exist, watch for it
190 watcher, err := fsnotify.NewWatcher()
195 if err := watcher.Close(); err != nil {
196 log.Debugf("failed to close file watcher: %v", err)
200 // start directory watcher
201 if err := watcher.Add(filepath.Dir(c.sockAddr)); err != nil {
205 timeout := time.NewTimer(MaxWaitReady)
209 if c.checkLegacySocket() {
212 return fmt.Errorf("timeout waiting (%s) for socket file: %s", MaxWaitReady, c.sockAddr)
214 case e := <-watcher.Errors:
217 case ev := <-watcher.Events:
218 log.Debugf("watcher event: %+v", ev)
219 if ev.Name == c.sockAddr && (ev.Op&fsnotify.Create) == fsnotify.Create {
220 // socket created, we are ready
227 func (c *socketClient) Connect() error {
228 c.checkLegacySocket()
230 // check if socket exists
231 if _, err := os.Stat(c.sockAddr); os.IsNotExist(err) {
232 warnOnce.Do(c.printMissingSocketMsg)
233 return fmt.Errorf("VPP API socket file %s does not exist", c.sockAddr)
234 } else if err != nil {
235 return fmt.Errorf("VPP API socket error: %v", err)
238 if err := c.connect(c.sockAddr); err != nil {
242 if err := c.open(); err != nil {
247 c.quit = make(chan struct{})
254 func (c *socketClient) Disconnect() error {
258 log.Debugf("Disconnecting..")
262 if err := c.conn.CloseRead(); err != nil {
263 log.Debugf("closing readMsg failed: %v", err)
266 // wait for readerLoop to return
269 if err := c.close(); err != nil {
270 log.Debugf("closing failed: %v", err)
273 if err := c.disconnect(); err != nil {
280 const defaultBufferSize = 4096
282 func (c *socketClient) connect(sockAddr string) error {
283 addr := &net.UnixAddr{Name: sockAddr, Net: "unix"}
285 log.Debugf("Connecting to: %v", c.sockAddr)
287 conn, err := net.DialUnix("unix", nil, addr)
289 // we try different type of socket for backwards compatbility with VPP<=19.04
290 if strings.Contains(err.Error(), "wrong type for socket") {
291 addr.Net = "unixpacket"
292 log.Debugf("%s, retrying connect with type unixpacket", err)
293 conn, err = net.DialUnix("unixpacket", nil, addr)
296 log.Debugf("Connecting to socket %s failed: %s", addr, err)
302 log.Debugf("Connected to socket (local addr: %v)", c.conn.LocalAddr().(*net.UnixAddr))
304 c.reader = bufio.NewReaderSize(c.conn, defaultBufferSize)
305 c.writer = bufio.NewWriterSize(c.conn, defaultBufferSize)
310 func (c *socketClient) disconnect() error {
311 log.Debugf("Closing socket")
312 if err := c.conn.Close(); err != nil {
313 log.Debugln("Closing socket failed:", err)
320 sockCreateMsgId = 15 // hard-coded sockclnt_create message ID
321 createMsgContext = byte(123)
322 deleteMsgContext = byte(124)
325 func (c *socketClient) open() error {
326 var msgCodec = codec.DefaultCodec
328 // Request socket client create
329 req := &memclnt.SockclntCreate{
332 msg, err := msgCodec.EncodeMsg(req, sockCreateMsgId)
334 log.Debugln("Encode error:", err)
338 msg[5] = createMsgContext
340 if err := c.writeMsg(msg); err != nil {
341 log.Debugln("Write error: ", err)
344 msgReply, err := c.readMsgTimeout(nil, c.connectTimeout)
346 log.Println("Read error:", err)
350 reply := new(memclnt.SockclntCreateReply)
351 if err := msgCodec.DecodeMsg(msgReply, reply); err != nil {
352 log.Println("Decoding sockclnt_create_reply failed:", err)
354 } else if reply.Response != 0 {
355 return fmt.Errorf("sockclnt_create_reply: response error (%d)", reply.Response)
358 log.Debugf("SockclntCreateReply: Response=%v Index=%v Count=%v",
359 reply.Response, reply.Index, reply.Count)
361 c.clientIndex = reply.Index
362 c.msgTable = make(map[string]uint16, reply.Count)
363 for _, x := range reply.MessageTable {
364 msgName := strings.Split(x.Name, "\x00")[0]
365 name := strings.TrimSuffix(msgName, "\x13")
366 c.msgTable[name] = x.Index
367 if strings.HasPrefix(name, "sockclnt_delete_") {
368 c.sockDelMsgId = x.Index
371 log.Debugf(" - %4d: %q", x.Index, name)
378 func (c *socketClient) close() error {
379 var msgCodec = codec.DefaultCodec
381 req := &memclnt.SockclntDelete{
382 Index: c.clientIndex,
384 msg, err := msgCodec.EncodeMsg(req, c.sockDelMsgId)
386 log.Debugln("Encode error:", err)
390 msg[5] = deleteMsgContext
392 log.Debugf("sending socklntDel (%d bytes): % 0X", len(msg), msg)
394 if err := c.writeMsg(msg); err != nil {
395 log.Debugln("Write error: ", err)
399 msgReply, err := c.readMsgTimeout(nil, c.disconnectTimeout)
401 if nerr, ok := err.(net.Error); ok && nerr.Timeout() {
402 // we accept timeout for reply
405 log.Debugln("Read error:", err)
409 reply := new(memclnt.SockclntDeleteReply)
410 if err := msgCodec.DecodeMsg(msgReply, reply); err != nil {
411 log.Debugln("Decoding sockclnt_delete_reply failed:", err)
413 } else if reply.Response != 0 {
414 return fmt.Errorf("sockclnt_delete_reply: response error (%d)", reply.Response)
420 func (c *socketClient) GetMsgID(msgName string, msgCrc string) (uint16, error) {
421 if msgID, ok := c.msgTable[msgName+"_"+msgCrc]; ok {
424 return 0, &adapter.UnknownMsgError{
430 func (c *socketClient) SendMsg(context uint32, data []byte) error {
432 return fmt.Errorf("invalid message data, length must be at least 10 bytes")
434 setMsgRequestHeader(data, c.clientIndex, context)
437 log.Debugf("sendMsg (%d) context=%v client=%d: % 02X", len(data), context, c.clientIndex, data)
440 if err := c.writeMsg(data); err != nil {
441 log.Debugln("writeMsg error: ", err)
448 // setMsgRequestHeader sets client index and context in the message request header
450 // Message request has following structure:
452 // type msgRequestHeader struct {
454 // ClientIndex uint32
458 func setMsgRequestHeader(data []byte, clientIndex, context uint32) {
459 // message ID is already set
460 binary.BigEndian.PutUint32(data[2:6], clientIndex)
461 binary.BigEndian.PutUint32(data[6:10], context)
464 func (c *socketClient) writeMsg(msg []byte) error {
465 // we lock to prevent mixing multiple message writes
467 defer c.writeMu.Unlock()
469 header := c.headerPool.Get().([]byte)
470 err := writeMsgHeader(c.writer, header, len(msg))
474 c.headerPool.Put(header)
476 if err := writeMsgData(c.writer, msg, c.writer.Size()); err != nil {
480 if err := c.writer.Flush(); err != nil {
484 log.Debugf(" -- writeMsg done")
489 func writeMsgHeader(w io.Writer, header []byte, dataLen int) error {
490 binary.BigEndian.PutUint32(header[8:12], uint32(dataLen))
492 n, err := w.Write(header)
497 log.Debugf(" - header sent (%d/%d): % 0X", n, len(header), header)
503 func writeMsgData(w io.Writer, msg []byte, writerSize int) error {
504 for i := 0; i <= len(msg)/writerSize; i++ {
505 x := i*writerSize + writerSize
510 log.Debugf(" - x=%v i=%v len=%v mod=%v", x, i, len(msg), len(msg)/writerSize)
512 n, err := w.Write(msg[i*writerSize : x])
517 log.Debugf(" - data sent x=%d (%d/%d): % 0X", x, n, len(msg), msg)
523 func (c *socketClient) readerLoop() {
525 defer log.Debugf("reader loop done")
536 msg, err := c.readMsg(buf[:])
538 if isClosedError(err) {
541 log.Debugf("readMsg error: %v", err)
545 msgID, context := getMsgReplyHeader(msg)
547 log.Debugf("recvMsg (%d) msgID=%d context=%v", len(msg), msgID, context)
550 c.msgCallback(msgID, msg)
554 // getMsgReplyHeader gets message ID and context from the message reply header
556 // Message reply has following structure:
558 // type msgReplyHeader struct {
563 func getMsgReplyHeader(msg []byte) (msgID uint16, context uint32) {
564 msgID = binary.BigEndian.Uint16(msg[0:2])
565 context = binary.BigEndian.Uint32(msg[2:6])
569 func (c *socketClient) readMsgTimeout(buf []byte, timeout time.Duration) ([]byte, error) {
571 readDeadline := time.Now().Add(timeout)
572 if err := c.conn.SetReadDeadline(readDeadline); err != nil {
577 msgReply, err := c.readMsg(buf)
582 // reset read deadline
583 if err := c.conn.SetReadDeadline(time.Time{}); err != nil {
590 func (c *socketClient) readMsg(buf []byte) ([]byte, error) {
591 log.Debug("reading msg..")
593 header := c.headerPool.Get().([]byte)
594 msgLen, err := readMsgHeader(c.reader, header)
598 c.headerPool.Put(header)
600 msg, err := readMsgData(c.reader, buf, msgLen)
602 log.Debugf(" -- readMsg done (buffered: %d)", c.reader.Buffered())
607 func readMsgHeader(r io.Reader, header []byte) (int, error) {
608 n, err := io.ReadAtLeast(r, header, 16)
613 log.Debugln("zero bytes header")
616 log.Debugf("invalid header (%d bytes): % 0X", n, header[:n])
617 return 0, fmt.Errorf("invalid header (expected 16 bytes, got %d)", n)
620 dataLen := binary.BigEndian.Uint32(header[8:12])
622 return int(dataLen), nil
625 func readMsgData(r io.Reader, buf []byte, dataLen int) ([]byte, error) {
627 if buf == nil || len(buf) < dataLen {
628 msg = make([]byte, dataLen)
633 n, err := r.Read(msg)
638 log.Debugf(" - read data (%d bytes): % 0X", n, msg[:n])
642 remain := dataLen - n
643 log.Debugf("continue reading remaining %d bytes", remain)
647 nbytes, err := r.Read(view)
650 } else if nbytes == 0 {
651 return nil, fmt.Errorf("zero nbytes")
655 log.Debugf("another data received: %d bytes (remain: %d)", nbytes, remain)
664 func isClosedError(err error) bool {
665 if errors.Is(err, io.EOF) {
668 return strings.HasSuffix(err.Error(), "use of closed network connection")