src/vpp-api/python/vpp_papi/vpp_transport_shmem.py

   1 #
   2 # A transport class. With two implementations.
   3 # One for socket and one for shared memory.
   4 #
   5
   6 from cffi import FFI
   7 import cffi
   8
   9 ffi = FFI()
  10 ffi.cdef("""
  11 typedef void (*vac_callback_t)(unsigned char * data, int len);
  12 typedef void (*vac_error_callback_t)(void *, unsigned char *, int);
  13 int vac_connect(char * name, char * chroot_prefix, vac_callback_t cb,
  14     int rx_qlen);
  15 int vac_disconnect(void);
  16 int vac_read(char **data, int *l, unsigned short timeout);
  17 int vac_write(char *data, int len);
  18 void vac_free(void * msg);
  19
  20 int vac_get_msg_index(unsigned char * name);
  21 int vac_msg_table_size(void);
  22 int vac_msg_table_max_index(void);
  23
  24 void vac_rx_suspend (void);
  25 void vac_rx_resume (void);
  26 void vac_set_error_handler(vac_error_callback_t);
  27  """)
  28
  29 vpp_object = None
  30
  31 # Barfs on failure, no need to check success.
  32 vpp_api = ffi.dlopen('libvppapiclient.so')
  33
  34
  35 @ffi.callback("void(unsigned char *, int)")
  36 def vac_callback_sync(data, len):
  37     vpp_object.msg_handler_sync(ffi.buffer(data, len))
  38
  39
  40 @ffi.callback("void(unsigned char *, int)")
  41 def vac_callback_async(data, len):
  42     vpp_object.msg_handler_async(ffi.buffer(data, len))
  43
  44
  45 @ffi.callback("void(void *, unsigned char *, int)")
  46 def vac_error_handler(arg, msg, msg_len):
  47     vpp_object.logger.warning("VPP API client:: %s", ffi.string(msg, msg_len))
  48
  49
  50 class VppTransport:
  51     def __init__(self, parent, read_timeout, server_address):
  52         self.connected = False
  53         self.read_timeout = read_timeout
  54         self.parent = parent
  55         global vpp_object
  56         vpp_object = parent
  57
  58         # Register error handler
  59         vpp_api.vac_set_error_handler(vac_error_handler)
  60
  61         # Support legacy CFFI
  62         # from_buffer supported from 1.8.0
  63         (major, minor, patch) = [int(s) for s in
  64                                  cffi.__version__.split('.', 3)]
  65         if major >= 1 and minor >= 8:
  66             self.write = self._write_new_cffi
  67         else:
  68             self.write = self._write_legacy_cffi
  69
  70     def connect(self, name, pfx, msg_handler, rx_qlen):
  71         self.connected = True
  72         if not pfx:
  73             pfx = ffi.NULL
  74         return vpp_api.vac_connect(name, pfx, msg_handler, rx_qlen)
  75
  76     def disconnect(self):
  77         self.connected = False
  78         vpp_api.vac_disconnect()
  79
  80     def suspend(self):
  81         vpp_api.vac_rx_suspend()
  82
  83     def resume(self):
  84         vpp_api.vac_rx_resume()
  85
  86     def get_callback(self, async):
  87         return vac_callback_sync if not async else vac_callback_async
  88
  89     def get_msg_index(self, name):
  90         return vpp_api.vac_get_msg_index(name)
  91
  92     def msg_table_max_index(self):
  93         return vpp_api.vac_msg_table_max_index()
  94
  95     def _write_new_cffi(self, buf):
  96         """Send a binary-packed message to VPP."""
  97         if not self.connected:
  98             raise IOError(1, 'Not connected')
  99         return vpp_api.vac_write(ffi.from_buffer(buf), len(buf))
 100
 101     def _write_legacy_cffi(self, buf):
 102         """Send a binary-packed message to VPP."""
 103         if not self.connected:
 104             raise IOError(1, 'Not connected')
 105         return vpp_api.vac_write(bytes(buf), len(buf))
 106
 107     def read(self):
 108         if not self.connected:
 109             raise IOError(1, 'Not connected')
 110         mem = ffi.new("char **")
 111         size = ffi.new("int *")
 112         rv = vpp_api.vac_read(mem, size, self.read_timeout)
 113         if rv:
 114             raise IOError(rv, 'vac_read failed')
 115         msg = bytes(ffi.buffer(mem[0], size[0]))
 116         vpp_api.vac_free(mem[0])
 117         return msg