adapter/vppapiclient/vppapiclient_adapter.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 // +build !windows,!darwin
  16
  17 // Package vppapiclient is the default VPP adapter being used for the connection with VPP via shared memory.
  18 // It is based on the communication with the vppapiclient VPP library written in C via CGO.
  19 package vppapiclient
  20
  21 /*
  22 #cgo CFLAGS: -DPNG_DEBUG=1
  23 #cgo LDFLAGS: -lvppapiclient
  24
  25 #include <stdlib.h>
  26 #include <stdio.h>
  27 #include <stdint.h>
  28 #include <arpa/inet.h>
  29 #include <vpp-api/client/vppapiclient.h>
  30
  31 extern void go_msg_callback(uint16_t, uint32_t, void*, size_t);
  32
  33 typedef struct __attribute__((__packed__)) _req_header {
  34     uint16_t msg_id;
  35     uint32_t client_index;
  36     uint32_t context;
  37 } req_header_t;
  38
  39 typedef struct __attribute__((__packed__)) _reply_header {
  40     uint16_t msg_id;
  41     uint32_t context;
  42 } reply_header_t;
  43
  44 static void
  45 govpp_msg_callback (unsigned char *data, int size)
  46 {
  47     reply_header_t *header = ((reply_header_t *)data);
  48     go_msg_callback(ntohs(header->msg_id), ntohl(header->context), data, size);
  49 }
  50
  51 static int
  52 govpp_connect()
  53 {
  54     return vac_connect("govpp", NULL, govpp_msg_callback, 32);
  55 }
  56
  57 static int
  58 govvp_disconnect()
  59 {
  60     return vac_disconnect();
  61 }
  62
  63 static int
  64 govpp_send(uint32_t context, void *data, size_t size)
  65 {
  66         req_header_t *header = ((req_header_t *)data);
  67         header->context = htonl(context);
  68     return vac_write(data, size);
  69 }
  70
  71 static uint32_t
  72 govpp_get_msg_index(char *name_and_crc)
  73 {
  74     return vac_get_msg_index(name_and_crc);
  75 }
  76 */
  77 import "C"
  78
  79 import (
  80         "fmt"
  81         "os"
  82         "reflect"
  83         "unsafe"
  84
  85         "git.fd.io/govpp.git/adapter"
  86         "github.com/fsnotify/fsnotify"
  87 )
  88
  89 const (
  90         // watchedFolder is a folder where vpp's shared memory is supposed to be created.
  91         // File system events are monitored in this folder.
  92         watchedFolder = "/dev/shm/"
  93         // watchedFile is a name of the file in the watchedFolder. Once the file is present
  94         // the vpp is ready to accept a new connection.
  95         watchedFile = watchedFolder + "vpe-api"
  96 )
  97
  98 // vppAPIClientAdapter is the opaque context of the adapter.
  99 type vppAPIClientAdapter struct {
 100         callback func(context uint32, msgId uint16, data []byte)
 101 }
 102
 103 var vppClient *vppAPIClientAdapter // global vpp API client adapter context
 104
 105 // NewVppAdapter returns a new vpp API client adapter.
 106 func NewVppAdapter() adapter.VppAdapter {
 107         return &vppAPIClientAdapter{}
 108 }
 109
 110 // Connect connects the process to VPP.
 111 func (a *vppAPIClientAdapter) Connect() error {
 112         vppClient = a
 113         rc := C.govpp_connect()
 114         if rc != 0 {
 115                 return fmt.Errorf("unable to connect to VPP (error=%d)", rc)
 116         }
 117         return nil
 118 }
 119
 120 // Disconnect disconnects the process from VPP.
 121 func (a *vppAPIClientAdapter) Disconnect() {
 122         C.govvp_disconnect()
 123 }
 124
 125 // GetMsgID returns a runtime message ID for the given message name and CRC.
 126 func (a *vppAPIClientAdapter) GetMsgID(msgName string, msgCrc string) (uint16, error) {
 127         nameAndCrc := C.CString(msgName + "_" + msgCrc)
 128         defer C.free(unsafe.Pointer(nameAndCrc))
 129
 130         msgID := uint16(C.govpp_get_msg_index(nameAndCrc))
 131         if msgID == ^uint16(0) {
 132                 return msgID, fmt.Errorf("unknown message: %v (crc: %v)", msgName, msgCrc)
 133         }
 134
 135         return msgID, nil
 136 }
 137
 138 // SendMsg sends a binary-encoded message to VPP.
 139 func (a *vppAPIClientAdapter) SendMsg(clientID uint32, data []byte) error {
 140         rc := C.govpp_send(C.uint32_t(clientID), unsafe.Pointer(&data[0]), C.size_t(len(data)))
 141         if rc != 0 {
 142                 return fmt.Errorf("unable to send the message (error=%d)", rc)
 143         }
 144         return nil
 145 }
 146
 147 // SetMsgCallback sets a callback function that will be called by the adapter whenever a message comes from VPP.
 148 func (a *vppAPIClientAdapter) SetMsgCallback(cb func(context uint32, msgID uint16, data []byte)) {
 149         a.callback = cb
 150 }
 151
 152 // WaitReady blocks until shared memory for sending
 153 // binary api calls is present on the file system.
 154 func (a *vppAPIClientAdapter) WaitReady() error {
 155         watcher, err := fsnotify.NewWatcher()
 156         if err != nil {
 157                 return err
 158         }
 159         defer watcher.Close()
 160
 161         err = watcher.Add(watchedFolder)
 162         if err != nil {
 163                 return err
 164         }
 165
 166         if fileExists(watchedFile) {
 167                 return nil
 168         }
 169
 170         for {
 171                 ev := <-watcher.Events
 172                 if ev.Name == watchedFile && (ev.Op&fsnotify.Create) == fsnotify.Create {
 173                         break
 174                 }
 175         }
 176         return nil
 177 }
 178
 179 func fileExists(name string) bool {
 180         if _, err := os.Stat(name); err != nil {
 181                 if os.IsNotExist(err) {
 182                         return false
 183                 }
 184         }
 185         return true
 186 }
 187
 188 //export go_msg_callback
 189 func go_msg_callback(msgID C.uint16_t, context C.uint32_t, data unsafe.Pointer, size C.size_t) {
 190         // convert unsafe.Pointer to byte slice
 191         slice := &reflect.SliceHeader{Data: uintptr(data), Len: int(size), Cap: int(size)}
 192         byteArr := *(*[]byte)(unsafe.Pointer(slice))
 193
 194         vppClient.callback(uint32(context), uint16(msgID), byteArr)
 195 }