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.
30 "github.com/fsnotify/fsnotify"
31 "github.com/sirupsen/logrus"
33 "git.fd.io/govpp.git/adapter"
34 "git.fd.io/govpp.git/binapi/memclnt"
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")
59 log logrus.FieldLogger
62 // SetLogger sets global logger.
63 func SetLogger(logger logrus.FieldLogger) {
68 logger := logrus.New()
70 logger.Level = logrus.DebugLevel
71 logger.Debug("govpp: debug level enabled for socketclient")
73 log = logger.WithField("logger", "govpp/socketclient")
76 const socketMissing = `
77 ------------------------------------------------------------
78 No socket file found at: %s
79 VPP binary API socket file is missing!
81 - is VPP running with socket for binapi enabled?
82 - is the correct socket name configured?
84 To enable it add following section to your VPP config:
86 socket-name /run/vpp/api.sock
88 ------------------------------------------------------------
91 var warnOnce sync.Once
93 func (c *socketClient) printMissingSocketMsg() {
94 fmt.Fprintf(os.Stderr, socketMissing, c.sockAddr)
97 type socketClient struct {
105 connectTimeout time.Duration
106 disconnectTimeout time.Duration
108 msgCallback adapter.MsgCallback
110 msgTable map[string]uint16
114 headerPool *sync.Pool
120 func NewVppClient(sockAddr string) *socketClient {
122 sockAddr = DefaultSocketName
124 return &socketClient{
126 clientName: DefaultClientName,
127 connectTimeout: DefaultConnectTimeout,
128 disconnectTimeout: DefaultDisconnectTimeout,
129 headerPool: &sync.Pool{New: func() interface{} {
130 return make([]byte, 16)
132 msgCallback: func(msgID uint16, data []byte) {
133 log.Debugf("no callback set, dropping message: ID=%v len=%d", msgID, len(data))
138 // SetClientName sets a client name used for identification.
139 func (c *socketClient) SetClientName(name string) {
143 // SetConnectTimeout sets timeout used during connecting.
144 func (c *socketClient) SetConnectTimeout(t time.Duration) {
148 // SetDisconnectTimeout sets timeout used during disconnecting.
149 func (c *socketClient) SetDisconnectTimeout(t time.Duration) {
150 c.disconnectTimeout = t
153 func (c *socketClient) SetMsgCallback(cb adapter.MsgCallback) {
154 log.Debug("SetMsgCallback")
158 const legacySocketName = "/run/vpp-api.sock"
160 func (c *socketClient) checkLegacySocket() bool {
161 if c.sockAddr == legacySocketName {
164 log.Debugf("checking legacy socket: %s", legacySocketName)
165 // check if socket exists
166 if _, err := os.Stat(c.sockAddr); err == nil {
167 return false // socket exists
168 } else if !os.IsNotExist(err) {
169 return false // some other error occurred
171 // check if legacy socket exists
172 if _, err := os.Stat(legacySocketName); err == nil {
173 // legacy socket exists, update sockAddr
174 c.sockAddr = legacySocketName
177 // no socket socket found
181 // WaitReady checks socket file existence and waits for it if necessary
182 func (c *socketClient) WaitReady() error {
183 // check if socket already exists
184 if _, err := os.Stat(c.sockAddr); err == nil {
185 return nil // socket exists, we are ready
186 } else if !os.IsNotExist(err) {
187 return err // some other error occurred
190 if c.checkLegacySocket() {
194 // socket does not exist, watch for it
195 watcher, err := fsnotify.NewWatcher()
200 if err := watcher.Close(); err != nil {
201 log.Debugf("failed to close file watcher: %v", err)
205 // start directory watcher
206 if err := watcher.Add(filepath.Dir(c.sockAddr)); err != nil {
210 timeout := time.NewTimer(MaxWaitReady)
214 if c.checkLegacySocket() {
217 return fmt.Errorf("timeout waiting (%s) for socket file: %s", MaxWaitReady, c.sockAddr)
219 case e := <-watcher.Errors:
222 case ev := <-watcher.Events:
223 log.Debugf("watcher event: %+v", ev)
224 if ev.Name == c.sockAddr && (ev.Op&fsnotify.Create) == fsnotify.Create {
225 // socket created, we are ready
232 func (c *socketClient) Connect() error {
233 c.checkLegacySocket()
235 // check if socket exists
236 if _, err := os.Stat(c.sockAddr); os.IsNotExist(err) {
237 warnOnce.Do(c.printMissingSocketMsg)
238 return fmt.Errorf("VPP API socket file %s does not exist", c.sockAddr)
239 } else if err != nil {
240 return fmt.Errorf("VPP API socket error: %v", err)
243 if err := c.connect(c.sockAddr); err != nil {
247 if err := c.open(); err != nil {
252 c.quit = make(chan struct{})
259 func (c *socketClient) Disconnect() error {
263 log.Debugf("Disconnecting..")
267 if err := c.conn.CloseRead(); err != nil {
268 log.Debugf("closing readMsg failed: %v", err)
271 // wait for readerLoop to return
274 // Don't bother sending a vl_api_sockclnt_delete_t message,
275 // just close the socket.
277 if err := c.disconnect(); err != nil {
284 const defaultBufferSize = 4096
286 func (c *socketClient) connect(sockAddr string) error {
287 addr := &net.UnixAddr{Name: sockAddr, Net: "unix"}
289 log.Debugf("Connecting to: %v", c.sockAddr)
291 conn, err := net.DialUnix("unix", nil, addr)
293 // we try different type of socket for backwards compatbility with VPP<=19.04
294 if strings.Contains(err.Error(), "wrong type for socket") {
295 addr.Net = "unixpacket"
296 log.Debugf("%s, retrying connect with type unixpacket", err)
297 conn, err = net.DialUnix("unixpacket", nil, addr)
300 log.Debugf("Connecting to socket %s failed: %s", addr, err)
306 log.Debugf("Connected to socket (local addr: %v)", c.conn.LocalAddr().(*net.UnixAddr))
308 c.reader = bufio.NewReaderSize(c.conn, defaultBufferSize)
309 c.writer = bufio.NewWriterSize(c.conn, defaultBufferSize)
314 func (c *socketClient) disconnect() error {
315 log.Debugf("Closing socket")
316 if err := c.conn.Close(); err != nil {
317 log.Debugln("Closing socket failed:", err)
324 sockCreateMsgId = 15 // hard-coded sockclnt_create message ID
325 createMsgContext = byte(123)
326 deleteMsgContext = byte(124)
329 func (c *socketClient) open() error {
330 var msgCodec = codec.DefaultCodec
332 // Request socket client create
333 req := &memclnt.SockclntCreate{
336 msg, err := msgCodec.EncodeMsg(req, sockCreateMsgId)
338 log.Debugln("Encode error:", err)
342 msg[5] = createMsgContext
344 if err := c.writeMsg(msg); err != nil {
345 log.Debugln("Write error: ", err)
348 msgReply, err := c.readMsgTimeout(nil, c.connectTimeout)
350 log.Println("Read error:", err)
354 reply := new(memclnt.SockclntCreateReply)
355 if err := msgCodec.DecodeMsg(msgReply, reply); err != nil {
356 log.Println("Decoding sockclnt_create_reply failed:", err)
358 } else if reply.Response != 0 {
359 return fmt.Errorf("sockclnt_create_reply: response error (%d)", reply.Response)
362 log.Debugf("SockclntCreateReply: Response=%v Index=%v Count=%v",
363 reply.Response, reply.Index, reply.Count)
365 c.clientIndex = reply.Index
366 c.msgTable = make(map[string]uint16, reply.Count)
367 for _, x := range reply.MessageTable {
368 msgName := strings.Split(x.Name, "\x00")[0]
369 name := strings.TrimSuffix(msgName, "\x13")
370 c.msgTable[name] = x.Index
371 if strings.HasPrefix(name, "sockclnt_delete_") {
372 c.sockDelMsgId = x.Index
375 log.Debugf(" - %4d: %q", x.Index, name)
382 func (c *socketClient) GetMsgID(msgName string, msgCrc string) (uint16, error) {
383 if msgID, ok := c.msgTable[msgName+"_"+msgCrc]; ok {
386 return 0, &adapter.UnknownMsgError{
392 func (c *socketClient) SendMsg(context uint32, data []byte) error {
394 return fmt.Errorf("invalid message data, length must be at least 10 bytes")
396 setMsgRequestHeader(data, c.clientIndex, context)
399 log.Debugf("sendMsg (%d) context=%v client=%d: % 02X", len(data), context, c.clientIndex, data)
402 if err := c.writeMsg(data); err != nil {
403 log.Debugln("writeMsg error: ", err)
410 // setMsgRequestHeader sets client index and context in the message request header
412 // Message request has following structure:
414 // type msgRequestHeader struct {
416 // ClientIndex uint32
420 func setMsgRequestHeader(data []byte, clientIndex, context uint32) {
421 // message ID is already set
422 binary.BigEndian.PutUint32(data[2:6], clientIndex)
423 binary.BigEndian.PutUint32(data[6:10], context)
426 func (c *socketClient) writeMsg(msg []byte) error {
427 // we lock to prevent mixing multiple message writes
429 defer c.writeMu.Unlock()
431 header := c.headerPool.Get().([]byte)
432 err := writeMsgHeader(c.writer, header, len(msg))
436 c.headerPool.Put(header)
438 if err := writeMsgData(c.writer, msg, c.writer.Size()); err != nil {
442 if err := c.writer.Flush(); err != nil {
446 log.Debugf(" -- writeMsg done")
451 func writeMsgHeader(w io.Writer, header []byte, dataLen int) error {
452 binary.BigEndian.PutUint32(header[8:12], uint32(dataLen))
454 n, err := w.Write(header)
459 log.Debugf(" - header sent (%d/%d): % 0X", n, len(header), header)
465 func writeMsgData(w io.Writer, msg []byte, writerSize int) error {
466 for i := 0; i <= len(msg)/writerSize; i++ {
467 x := i*writerSize + writerSize
472 log.Debugf(" - x=%v i=%v len=%v mod=%v", x, i, len(msg), len(msg)/writerSize)
474 n, err := w.Write(msg[i*writerSize : x])
479 log.Debugf(" - data sent x=%d (%d/%d): % 0X", x, n, len(msg), msg)
485 func (c *socketClient) readerLoop() {
487 defer log.Debugf("reader loop done")
498 msg, err := c.readMsg(buf[:])
500 if isClosedError(err) {
503 log.Debugf("readMsg error: %v", err)
507 msgID, context := getMsgReplyHeader(msg)
509 log.Debugf("recvMsg (%d) msgID=%d context=%v", len(msg), msgID, context)
512 c.msgCallback(msgID, msg)
516 // getMsgReplyHeader gets message ID and context from the message reply header
518 // Message reply has following structure:
520 // type msgReplyHeader struct {
525 func getMsgReplyHeader(msg []byte) (msgID uint16, context uint32) {
526 msgID = binary.BigEndian.Uint16(msg[0:2])
527 context = binary.BigEndian.Uint32(msg[2:6])
531 func (c *socketClient) readMsgTimeout(buf []byte, timeout time.Duration) ([]byte, error) {
533 readDeadline := time.Now().Add(timeout)
534 if err := c.conn.SetReadDeadline(readDeadline); err != nil {
539 msgReply, err := c.readMsg(buf)
544 // reset read deadline
545 if err := c.conn.SetReadDeadline(time.Time{}); err != nil {
552 func (c *socketClient) readMsg(buf []byte) ([]byte, error) {
553 log.Debug("reading msg..")
555 header := c.headerPool.Get().([]byte)
556 msgLen, err := readMsgHeader(c.reader, header)
560 c.headerPool.Put(header)
562 msg, err := readMsgData(c.reader, buf, msgLen)
564 log.Debugf(" -- readMsg done (buffered: %d)", c.reader.Buffered())
569 func readMsgHeader(r io.Reader, header []byte) (int, error) {
570 n, err := io.ReadAtLeast(r, header, 16)
575 log.Debugln("zero bytes header")
578 log.Debugf("invalid header (%d bytes): % 0X", n, header[:n])
579 return 0, fmt.Errorf("invalid header (expected 16 bytes, got %d)", n)
582 dataLen := binary.BigEndian.Uint32(header[8:12])
584 return int(dataLen), nil
587 func readMsgData(r io.Reader, buf []byte, dataLen int) ([]byte, error) {
589 if buf == nil || len(buf) < dataLen {
590 msg = make([]byte, dataLen)
595 n, err := r.Read(msg)
600 log.Debugf(" - read data (%d bytes): % 0X", n, msg[:n])
604 remain := dataLen - n
605 log.Debugf("continue reading remaining %d bytes", remain)
609 nbytes, err := r.Read(view)
612 } else if nbytes == 0 {
613 return nil, fmt.Errorf("zero nbytes")
617 log.Debugf("another data received: %d bytes (remain: %d)", nbytes, remain)
626 func isClosedError(err error) bool {
627 if errors.Is(err, io.EOF) {
630 return strings.HasSuffix(err.Error(), "use of closed network connection")