summaryrefslogtreecommitdiffstats
path: root/vpp-api/python
diff options
context:
space:
mode:
Diffstat (limited to 'vpp-api/python')
-rw-r--r--vpp-api/python/Makefile.am51
-rw-r--r--vpp-api/python/README.rst0
-rw-r--r--vpp-api/python/pneum/pneum.c259
-rw-r--r--vpp-api/python/pneum/pneum.h31
-rw-r--r--vpp-api/python/pneum/test_pneum.c143
-rw-r--r--vpp-api/python/setup.cfg5
-rw-r--r--vpp-api/python/setup.py34
-rwxr-xr-xvpp-api/python/tests/test_cli.py52
-rwxr-xr-xvpp-api/python/tests/test_modules.py18
-rwxr-xr-xvpp-api/python/tests/test_papi.py119
-rwxr-xr-xvpp-api/python/tests/test_version.py35
-rwxr-xr-xvpp-api/python/tests/test_vpp_papi2.py487
-rw-r--r--vpp-api/python/vpp_papi/__init__.py3
-rw-r--r--vpp-api/python/vpp_papi/pneum_wrap.c200
-rw-r--r--vpp-api/python/vpp_papi/vpp_papi.py450
15 files changed, 0 insertions, 1887 deletions
diff --git a/vpp-api/python/Makefile.am b/vpp-api/python/Makefile.am
deleted file mode 100644
index 2a578464d0f..00000000000
--- a/vpp-api/python/Makefile.am
+++ /dev/null
@@ -1,51 +0,0 @@
-# Copyright (c) 2016 Cisco and/or its affiliates.
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at:
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-AUTOMAKE_OPTIONS = foreign subdir-objects
-ACLOCAL_AMFLAGS = -I m4
-AM_CFLAGS = -Wall
-
-BUILT_SOURCES =
-bin_PROGRAMS =
-CLEANFILES =
-lib_LTLIBRARIES =
-noinst_PROGRAMS = test_pneum
-nobase_include_HEADERS = pneum/pneum.h
-
-#
-# Python / C extension
-#
-lib_LTLIBRARIES += libpneum.la
-libpneum_la_SOURCES = pneum/pneum.c
-libpneum_la_LIBADD = -lvlibmemoryclient -lvlibapi -lsvm -lvppinfra -lpthread \
- -lm -lrt
-libpneum_la_LDFLAGS = -module
-libpneum_la_CPPFLAGS =
-
-# TODO: Support both Python 2 and 3.
-install-exec-local:
- cd $(srcdir); \
- mkdir -p $(prefix)/lib/python2.7/site-packages; \
- PYTHONUSERBASE=$(prefix) \
- python setup.py build_ext -L $(prefix)/lib64 \
- -I $(prefix)/../vppinfra/include/ install --user
-
-#
-# Test client
-#
-noinst_PROGRAMS += test_pneum
-test_pneum_SOURCES = pneum/pneum.c pneum/test_pneum.c
-test_pneum_LDADD = -lvlibmemoryclient -lvlibapi -lsvm -lvppinfra -lpthread \
- -lm -lrt
-
-
diff --git a/vpp-api/python/README.rst b/vpp-api/python/README.rst
deleted file mode 100644
index e69de29bb2d..00000000000
--- a/vpp-api/python/README.rst
+++ /dev/null
diff --git a/vpp-api/python/pneum/pneum.c b/vpp-api/python/pneum/pneum.c
deleted file mode 100644
index 6918cc9b404..00000000000
--- a/vpp-api/python/pneum/pneum.c
+++ /dev/null
@@ -1,259 +0,0 @@
-/*
- * Copyright (c) 2016 Cisco and/or its affiliates.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at:
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-#include <stdio.h>
-#include <stdlib.h>
-#include <stddef.h>
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <sys/mman.h>
-#include <sys/stat.h>
-#include <netinet/in.h>
-#include <netdb.h>
-#include <signal.h>
-#include <setjmp.h>
-#include <stdbool.h>
-
-#include <vnet/vnet.h>
-#include <vlib/vlib.h>
-#include <vlib/unix/unix.h>
-#include <vlibapi/api.h>
-#include <vlibmemory/api.h>
-
-#include <vpp-api/vpe_msg_enum.h>
-
-#include "pneum.h"
-
-#define vl_typedefs /* define message structures */
-#include <vpp-api/vpe_all_api_h.h>
-#undef vl_typedefs
-
-#define vl_endianfun /* define message structures */
-#include <vpp-api/vpe_all_api_h.h>
-#undef vl_endianfun
-
-vlib_main_t vlib_global_main;
-vlib_main_t **vlib_mains;
-
-typedef struct {
- u8 rx_thread_jmpbuf_valid;
- u8 connected_to_vlib;
- jmp_buf rx_thread_jmpbuf;
- pthread_t rx_thread_handle;
-} pneum_main_t;
-
-pneum_main_t pneum_main;
-
-pneum_callback_t pneum_callback;
-
-/*
- * Satisfy external references when -lvlib is not available.
- */
-void vlib_cli_output (struct vlib_main_t * vm, char * fmt, ...)
-{
- clib_warning ("vlib_cli_output called...");
-}
-
-void
-pneum_free (void * msg)
-{
- vl_msg_api_free (msg);
-}
-
-static void
-pneum_api_handler (void *msg)
-{
- u16 id = ntohs(*((u16 *)msg));
- if (id == VL_API_RX_THREAD_EXIT) {
- pneum_main_t *pm = &pneum_main;
- vl_msg_api_free(msg);
- longjmp(pm->rx_thread_jmpbuf, 1);
- }
- msgbuf_t *msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
- int l = ntohl(msgbuf->data_len);
- if (l == 0)
- clib_warning("Message ID %d has wrong length: %d\n", id, l);
-
- /* Call Python callback */
- ASSERT(pneum_callback);
- (pneum_callback)(msg, l);
- pneum_free(msg);
-}
-
-static void *
-pneum_rx_thread_fn (void *arg)
-{
- unix_shared_memory_queue_t *q;
- pneum_main_t *pm = &pneum_main;
- api_main_t *am = &api_main;
- uword msg;
-
- q = am->vl_input_queue;
-
- /* So we can make the rx thread terminate cleanly */
- if (setjmp(pm->rx_thread_jmpbuf) == 0) {
- pm->rx_thread_jmpbuf_valid = 1;
- while (1)
- while (!unix_shared_memory_queue_sub(q, (u8 *)&msg, 0))
- pneum_api_handler((void *)msg);
- }
- pthread_exit(0);
-}
-
-uword *
-pneum_msg_table_get_hash (void)
-{
- api_main_t *am = &api_main;
- return (am->msg_index_by_name_and_crc);
-}
-
-int
-pneum_msg_table_size(void)
-{
- api_main_t *am = &api_main;
- return hash_elts(am->msg_index_by_name_and_crc);
-}
-
-int
-pneum_connect (char * name, char * chroot_prefix, pneum_callback_t cb)
-{
- int rv = 0;
- pneum_main_t *pm = &pneum_main;
-
- if (chroot_prefix != NULL)
- vl_set_memory_root_path (chroot_prefix);
-
- if ((rv = vl_client_api_map("/vpe-api"))) {
- clib_warning ("vl_client_api map rv %d", rv);
- return rv;
- }
-
- if (vl_client_connect(name, 0, 32) < 0) {
- vl_client_api_unmap();
- return (-1);
- }
-
- if (cb) {
- /* Start the rx queue thread */
- rv = pthread_create(&pm->rx_thread_handle, NULL, pneum_rx_thread_fn, 0);
- if (rv) {
- clib_warning("pthread_create returned %d", rv);
- vl_client_api_unmap();
- return (-1);
- }
- pneum_callback = cb;
- }
-
- pm->connected_to_vlib = 1;
-
- return (0);
-}
-
-int
-pneum_disconnect (void)
-{
- api_main_t *am = &api_main;
- pneum_main_t *pm = &pneum_main;
-
- if (pm->rx_thread_jmpbuf_valid) {
- vl_api_rx_thread_exit_t *ep;
- uword junk;
- ep = vl_msg_api_alloc (sizeof (*ep));
- ep->_vl_msg_id = ntohs(VL_API_RX_THREAD_EXIT);
- vl_msg_api_send_shmem(am->vl_input_queue, (u8 *)&ep);
- pthread_join(pm->rx_thread_handle, (void **) &junk);
- }
- if (pm->connected_to_vlib) {
- vl_client_disconnect();
- vl_client_api_unmap();
- pneum_callback = 0;
- }
- memset (pm, 0, sizeof (*pm));
-
- return (0);
-}
-
-int
-pneum_read (char **p, int *l)
-{
- unix_shared_memory_queue_t *q;
- api_main_t *am = &api_main;
- pneum_main_t *pm = &pneum_main;
- uword msg;
-
- if (!pm->connected_to_vlib) return -1;
-
- *l = 0;
-
- if (am->our_pid == 0) return (-1);
-
- q = am->vl_input_queue;
- int rv = unix_shared_memory_queue_sub(q, (u8 *)&msg, 0);
- if (rv == 0) {
- u16 msg_id = ntohs(*((u16 *)msg));
- msgbuf_t *msgbuf = (msgbuf_t *)(((u8 *)msg) - offsetof(msgbuf_t, data));
- *l = ntohl(msgbuf->data_len);
- if (*l == 0) {
- printf("Unregistered API message: %d\n", msg_id);
- return (-1);
- }
- *p = (char *)msg;
- } else {
- printf("Read failed with %d\n", rv);
- }
- return (rv);
-}
-
-/*
- * XXX: Makes the assumption that client_index is the first member
- */
-typedef VL_API_PACKED(struct _vl_api_header {
- u16 _vl_msg_id;
- u32 client_index;
-}) vl_api_header_t;
-
-static unsigned int
-pneum_client_index (void)
-{
- return (api_main.my_client_index);
-}
-
-int
-pneum_write (char *p, int l)
-{
- int rv = -1;
- api_main_t *am = &api_main;
- vl_api_header_t *mp = vl_msg_api_alloc(l);
- unix_shared_memory_queue_t *q;
- pneum_main_t *pm = &pneum_main;
-
- if (!pm->connected_to_vlib) return -1;
- if (!mp) return (-1);
- memcpy(mp, p, l);
- mp->client_index = pneum_client_index();
- q = am->shmem_hdr->vl_input_queue;
- rv = unix_shared_memory_queue_add(q, (u8 *)&mp, 0);
- if (rv != 0) {
- printf("vpe_api_write fails: %d\n", rv);
- /* Clear message */
- pneum_free(mp);
- }
- return (rv);
-}
-
-uint32_t
-pneum_get_msg_index (unsigned char * name)
-{
- return vl_api_get_msg_index (name);
-}
diff --git a/vpp-api/python/pneum/pneum.h b/vpp-api/python/pneum/pneum.h
deleted file mode 100644
index a347bd25f62..00000000000
--- a/vpp-api/python/pneum/pneum.h
+++ /dev/null
@@ -1,31 +0,0 @@
-/*
- * Copyright (c) 2016 Cisco and/or its affiliates.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at:
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-#ifndef included_pneum_h
-#define included_pneum_h
-
-#include <stdint.h>
-#include <vppinfra/types.h>
-
-typedef void (*pneum_callback_t)(unsigned char * data, int len);
-int pneum_connect(char * name, char * chroot_prefix, pneum_callback_t cb);
-int pneum_disconnect(void);
-int pneum_read(char **data, int *l);
-int pneum_write(char *data, int len);
-void pneum_free(void * msg);
-uword * pneum_msg_table_get_hash (void);
-int pneum_msg_table_size(void);
-uint32_t pneum_get_msg_index(unsigned char * name);
-
-#endif
diff --git a/vpp-api/python/pneum/test_pneum.c b/vpp-api/python/pneum/test_pneum.c
deleted file mode 100644
index e873114fab9..00000000000
--- a/vpp-api/python/pneum/test_pneum.c
+++ /dev/null
@@ -1,143 +0,0 @@
-/*
- *------------------------------------------------------------------
- * test_pneum.c
- *
- * Copyright (c) 2016 Cisco and/or its affiliates.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at:
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *------------------------------------------------------------------
- */
-#include <stdio.h>
-#include <stdlib.h>
-#include <sys/types.h>
-#include <sys/socket.h>
-#include <sys/mman.h>
-#include <sys/stat.h>
-#include <netinet/in.h>
-#include <netdb.h>
-
-#include <time.h> /* time_t, time (for timestamp in second) */
-#include <sys/timeb.h> /* ftime, timeb (for timestamp in millisecond) */
-#include <sys/time.h> /* gettimeofday, timeval (for timestamp in microsecond) */
-
-#include <vnet/vnet.h>
-#include <vlib/vlib.h>
-#include <vlib/unix/unix.h>
-#include <vlibapi/api.h>
-#include <vlibmemory/api.h>
-#include <vnet/ip/ip.h>
-
-#include <vpp-api/vpe_msg_enum.h>
-#include <signal.h>
-#include <setjmp.h>
-#include "pneum.h"
-
-#define vl_typedefs /* define message structures */
-#include <vpp-api/vpe_all_api_h.h>
-#undef vl_typedefs
-
-/* we are not linking with vlib */
-vlib_main_t vlib_global_main;
-vlib_main_t **vlib_mains;
-
-volatile int sigterm_received = 0;
-volatile u32 result_ready;
-volatile u16 result_msg_id;
-
-/* M_NOALLOC: construct, but don't yet send a message */
-
-#define M_NOALLOC(T,t) \
- do { \
- result_ready = 0; \
- memset (mp, 0, sizeof (*mp)); \
- mp->_vl_msg_id = ntohs (VL_API_##T); \
- mp->client_index = am->my_client_index; \
- } while(0);
-
-
-
-int
-wrap_pneum_callback (char *data, int len)
-{
- //printf("Callback %d\n", len);
- result_ready = 1;
- result_msg_id = ntohs(*((u16 *)data));
- return (0);
-}
-
-int main (int argc, char ** argv)
-{
- api_main_t * am = &api_main;
- vl_api_show_version_t message;
- vl_api_show_version_t *mp;
- int async = 1;
- int rv = pneum_connect("pneum_client", NULL, NULL);
-
- if (rv != 0) {
- printf("Connect failed: %d\n", rv);
- exit(rv);
- }
-
- struct timeb timer_msec;
- long long int timestamp_msec_start; /* timestamp in millisecond. */
- if (!ftime(&timer_msec)) {
- timestamp_msec_start = ((long long int) timer_msec.time) * 1000ll +
- (long long int) timer_msec.millitm;
- }
- else {
- timestamp_msec_start = -1;
- }
-
-
- /*
- * Test vpe_api_write and vpe_api_read to send and recv message for an
- * API
- */
- int i;
- long int no_msgs = 10000;
- mp = &message;
-
- for (i = 0; i < no_msgs; i++) {
- /* Construct the API message */
- M_NOALLOC(SHOW_VERSION, show_version);
- pneum_write((char *)mp, sizeof(*mp));
-#ifndef __COVERITY__
- /* As given, async is always 1. Shut up Coverity about it */
- if (!async)
- while (result_ready == 0);
-#endif
- }
- if (async) {
- vl_api_control_ping_t control;
- vl_api_control_ping_t *mp;
- mp = &control;
- M_NOALLOC(CONTROL_PING, control_ping);
- pneum_write((char *)mp, sizeof(*mp));
-
- while (result_msg_id != VL_API_CONTROL_PING_REPLY);
- }
-
- long long int timestamp_msec_end; /* timestamp in millisecond. */
- if (!ftime(&timer_msec)) {
- timestamp_msec_end = ((long long int) timer_msec.time) * 1000ll +
- (long long int) timer_msec.millitm;
- }
- else {
- timestamp_msec_end = -1;
- }
-
- printf("Took %lld msec, %lld msgs/msec \n", (timestamp_msec_end - timestamp_msec_start),
- no_msgs/(timestamp_msec_end - timestamp_msec_start));
- fformat(stdout, "Exiting...\n");
- pneum_disconnect();
- exit (0);
-}
diff --git a/vpp-api/python/setup.cfg b/vpp-api/python/setup.cfg
deleted file mode 100644
index d645be77604..00000000000
--- a/vpp-api/python/setup.cfg
+++ /dev/null
@@ -1,5 +0,0 @@
-[bdist_wheel]
-# This flag says that the code is written to work on both Python 2 and Python
-# 3. If at all possible, it is good practice to do this. If you cannot, you
-# will need to generate wheels for each Python version that you support.
-universal=0
diff --git a/vpp-api/python/setup.py b/vpp-api/python/setup.py
deleted file mode 100644
index 99a0147a56f..00000000000
--- a/vpp-api/python/setup.py
+++ /dev/null
@@ -1,34 +0,0 @@
-#
-# Copyright (c) 2016 Cisco and/or its affiliates.
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at:
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-try:
- from setuptools import setup, Extension
-except ImportError:
- from distutils.core import setup, Extension
-
-setup (name = 'vpp_papi',
- version = '1.3',
- description = 'VPP Python binding',
- author = 'Ole Troan',
- author_email = 'ot@cisco.com',
- test_suite = 'tests',
- packages=['vpp_papi'],
- ext_modules = [
- Extension(
- 'vpp_api',
- sources = ['vpp_papi/pneum_wrap.c'],
- libraries = ['pneum'],
- )],
- long_description = '''VPP Python language binding.''',
-)
diff --git a/vpp-api/python/tests/test_cli.py b/vpp-api/python/tests/test_cli.py
deleted file mode 100755
index 66fb6943e70..00000000000
--- a/vpp-api/python/tests/test_cli.py
+++ /dev/null
@@ -1,52 +0,0 @@
-#!/usr/bin/env python
-
-from __future__ import print_function
-import unittest, sys, time, threading, struct
-import test_base
-import vpp_papi
-from ipaddress import *
-
-import glob, subprocess
-class TestPAPI(unittest.TestCase):
- @classmethod
- def setUpClass(cls):
- #
- # Start main VPP process
- cls.vpp_bin = glob.glob(test_base.scriptdir+'/../../../build-root/install-vpp*-native/vpp/bin/vpp')[0]
- print("VPP BIN:", cls.vpp_bin)
- cls.vpp = subprocess.Popen([cls.vpp_bin, "unix", "nodaemon"], stderr=subprocess.PIPE)
- print('Started VPP')
- # For some reason unless we let VPP start up the API cannot connect.
- time.sleep(0.3)
- @classmethod
- def tearDownClass(cls):
- cls.vpp.terminate()
-
- def setUp(self):
- print("Connecting API")
- r = vpp_papi.connect("test_papi")
- self.assertEqual(r, 0)
-
- def tearDown(self):
- r = vpp_papi.disconnect()
- self.assertEqual(r, 0)
-
- #
- # The tests themselves
- #
-
- #
- # Basic request / reply
- #
- def test_cli_request(self):
- print(vpp_papi.cli_exec('show version verbose'))
- #t = vpp_papi.cli_inband_request(len(cmd), cmd)
- #print('T:',t)
- #reply = t.reply[0].decode().rstrip('\x00')
- #print(reply)
- #program = t.program.decode().rstrip('\x00')
- #self.assertEqual('vpe', program)
-
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/vpp-api/python/tests/test_modules.py b/vpp-api/python/tests/test_modules.py
deleted file mode 100755
index fdcd092c927..00000000000
--- a/vpp-api/python/tests/test_modules.py
+++ /dev/null
@@ -1,18 +0,0 @@
-from __future__ import print_function
-import unittest
-import vpp_papi
-import pot, snat
-print('Plugins:')
-vpp_papi.plugin_show()
-r = vpp_papi.connect('ole')
-
-r = vpp_papi.show_version()
-print('R:', r)
-
-r = snat.snat_interface_add_del_feature(1, 1, 1)
-print('R:', r)
-
-list_name = 'foobar'
-r = pot.pot_profile_add(0, 1, 123, 123, 0, 12, 0, 23, len(list_name), list_name)
-print('R:', r)
-vpp_papi.disconnect()
diff --git a/vpp-api/python/tests/test_papi.py b/vpp-api/python/tests/test_papi.py
deleted file mode 100755
index 8cbbfc59e03..00000000000
--- a/vpp-api/python/tests/test_papi.py
+++ /dev/null
@@ -1,119 +0,0 @@
-from __future__ import print_function
-import unittest, sys, time, threading, struct, logging, os
-import vpp_papi
-from ipaddress import *
-scriptdir = os.path.dirname(os.path.realpath(__file__))
-papi_event = threading.Event()
-print(vpp_papi.vpe.VL_API_SW_INTERFACE_SET_FLAGS)
-def papi_event_handler(result):
- if result.vl_msg_id == vpp_papi.vpe.VL_API_SW_INTERFACE_SET_FLAGS:
- return
- if result.vl_msg_id == vpp_papi.vpe.VL_API_VNET_INTERFACE_COUNTERS:
- print('Interface counters', result)
- return
- if result.vl_msg_id == vpp_papi.vpe.VL_API_VNET_IP6_FIB_COUNTERS:
- print('IPv6 FIB counters', result)
- papi_event.set()
- return
-
- print('Unknown message id:', result.vl_msg_id)
-
-import glob, subprocess
-class TestPAPI(unittest.TestCase):
- @classmethod
- def setUpClass(cls):
- #
- # Start main VPP process
- cls.vpp_bin = glob.glob(scriptdir+'/../../../build-root/install-vpp*-native/vpp/bin/vpp')[0]
- print("VPP BIN:", cls.vpp_bin)
- cls.vpp = subprocess.Popen([cls.vpp_bin, "unix", "nodaemon"], stderr=subprocess.PIPE)
- print('Started VPP')
- # For some reason unless we let VPP start up the API cannot connect.
- time.sleep(0.3)
- @classmethod
- def tearDownClass(cls):
- cls.vpp.terminate()
-
- def setUp(self):
- print("Connecting API")
- r = vpp_papi.connect("test_papi")
- self.assertEqual(r, 0)
-
- def tearDown(self):
- r = vpp_papi.disconnect()
- self.assertEqual(r, 0)
-
- #
- # The tests themselves
- #
-
- #
- # Basic request / reply
- #
- def test_show_version(self):
- t = vpp_papi.show_version()
- print('T', t);
- program = t.program.decode().rstrip('\x00')
- self.assertEqual('vpe', program)
-
- #
- # Details / Dump
- #
- def test_details_dump(self):
- t = vpp_papi.sw_interface_dump(0, b'')
- print('Dump/details T', t)
-
- #
- # Arrays
- #
- def test_arrays(self):
- t = vpp_papi.vnet_get_summary_stats()
- print('Summary stats', t)
- print('Packets:', t.total_pkts[0])
- print('Packets:', t.total_pkts[1])
- #
- # Variable sized arrays and counters
- #
- #@unittest.skip("stats")
- def test_want_stats(self):
- pid = 123
- vpp_papi.register_event_callback(papi_event_handler)
- papi_event.clear()
-
- # Need to configure IPv6 to get som IPv6 FIB stats
- t = vpp_papi.create_loopback('')
- print(t)
- self.assertEqual(t.retval, 0)
-
- ifindex = t.sw_if_index
- addr = str(IPv6Address(u'1::1').packed)
- t = vpp_papi.sw_interface_add_del_address(ifindex, 1, 1, 0, 16, addr)
- print(t)
- self.assertEqual(t.retval, 0)
-
- # Check if interface is up
- # XXX: Add new API to query interface state based on ifindex, instead of dump all.
- t = vpp_papi.sw_interface_set_flags(ifindex, 1, 1, 0)
- self.assertEqual(t.retval, 0)
-
- t = vpp_papi.want_stats(True, pid)
-
- print (t)
-
- #
- # Wait for some stats
- #
- self.assertEqual(papi_event.wait(15), True)
- t = vpp_papi.want_stats(False, pid)
- print (t)
-
-
- #
- # Plugins?
- #
-
-if __name__ == '__main__':
- #logging.basicConfig(level=logging.DEBUG)
- unittest.main()
-def test_papi():
- print('test')
diff --git a/vpp-api/python/tests/test_version.py b/vpp-api/python/tests/test_version.py
deleted file mode 100755
index de39cc24ebd..00000000000
--- a/vpp-api/python/tests/test_version.py
+++ /dev/null
@@ -1,35 +0,0 @@
-from __future__ import print_function
-import unittest, sys, time, threading, struct
-
-import vpp_papi
-from ipaddress import *
-import glob, subprocess
-class TestPAPI(unittest.TestCase):
- def setUp(self):
- print("Connecting API")
- r = vpp_papi.connect("test_papi")
- self.assertEqual(r, 0)
-
- def tearDown(self):
- r = vpp_papi.disconnect()
- self.assertEqual(r, 0)
-
- #
- # The tests themselves
- #
-
- #
- # Basic request / reply
- #
- def test_show_version(self):
- print(vpp_papi.show_version())
-
- #
- # Details / Dump
- #
- def test_details_dump(self):
- t = vpp_papi.sw_interface_dump(0, b'')
- print('Dump/details T', t)
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/vpp-api/python/tests/test_vpp_papi2.py b/vpp-api/python/tests/test_vpp_papi2.py
deleted file mode 100755
index f45f791e627..00000000000
--- a/vpp-api/python/tests/test_vpp_papi2.py
+++ /dev/null
@@ -1,487 +0,0 @@
-#!/usr/bin/env python
-
-from __future__ import print_function
-import unittest, sys, threading, struct, logging, os
-from vpp_papi import VPP
-from ipaddress import *
-import glob, json
-
-papi_event = threading.Event()
-import glob
-
-import fnmatch
-import os
-
-jsonfiles = []
-for root, dirnames, filenames in os.walk('../../../build-root/'):
- if root.find('install-') == -1: continue
- for filename in fnmatch.filter(filenames, '*.api.json'):
- jsonfiles.append(os.path.join(root, filename))
-
-class TestPAPI(unittest.TestCase):
- show_version_msg = '''["show_version",
- ["u16", "_vl_msg_id"],
- ["u32", "client_index"],
- ["u32", "context"],
- {"crc" : "0xf18f9480"}
- ]'''
-
- ip_address_details_msg = '''["ip_address_details",
- ["u16", "_vl_msg_id"],
- ["u32", "client_index"],
- ["u32", "context"],
- ["u8", "ip", 16],
- ["u8", "prefix_length"],
- {"crc" : "0x87d522a1"}
- ]'''
-
- cli_inband_msg = '''["cli_inband",
- ["u16", "_vl_msg_id"],
- ["u32", "client_index"],
- ["u32", "context"],
- ["u32", "length"],
- ["u8", "cmd", 0, "length"],
- {"crc" : "0x22345937"}
- ]'''
-
- def test_adding_new_message_object(self):
- p = json.loads(TestPAPI.show_version_msg)
- msglist = VPP(testmode=json)
- msgdef = msglist.add_message(p[0], p[1:])
-
- # Verify that message can be retrieved
- self.assertTrue(msglist['show_version'])
- self.assertFalse(msglist['foobar'])
-
- # Test duplicate
- self.assertRaises(ValueError, msglist.add_message, p[0], p[1:])
-
- # Look at return tuple
- self.assertTrue(msglist.ret_tup('show_version'))
-
- def test_adding_new_message_object_with_array(self):
- p = json.loads(TestPAPI.ip_address_details_msg)
- msglist = VPP(testmode=True)
- msglist.add_message(p[0], p[1:])
-
- self.assertTrue(msglist['ip_address_details'])
-
- def test_message_to_bytes(self):
- msglist = VPP(testmode=True)
- p = json.loads(TestPAPI.show_version_msg)
- msgdef = msglist.add_message(p[0], p[1:])
-
- # Give me a byte string for given message and given arguments
-
- b = msglist.encode(msgdef, {'_vl_msg_id' : 50, 'context' : 123 })
- self.assertEqual(10, len(b))
- rv = msglist.decode(msgdef, b)
- self.assertEqual(rv._0, 50)
- self.assertEqual(rv.context, 123)
-
-
- p = json.loads(TestPAPI.ip_address_details_msg)
- msgdef = msglist.add_message(p[0], p[1:])
-
- # Give me a byte string for given message and given arguments
- b = msglist.encode(msgdef, {'_vl_msg_id' : 50, 'context' : 123,
- 'ip' : b'\xf0\xf1\xf2',
- 'prefix_length' : 12})
- self.assertEqual(27, len(b))
- rv = msglist.decode(msgdef, b)
-
- self.assertEqual(rv.context, 123)
- self.assertEqual(rv.ip, b'\xf0\xf1\xf2\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
- self.assertEqual(rv.prefix_length, 12)
-
- p = json.loads(TestPAPI.cli_inband_msg)
- msgdef = msglist.add_message(p[0], p[1:])
-
- # Give me a byte string for given message and given arguments
- b = msglist.encode(msgdef, { '_vl_msg_id' : 50, 'context' : 123,
- 'length' : 20, 'cmd' : 'show version verbose'})
- self.assertEqual(34, len(b))
- rv = msglist.decode(msgdef, b)
- self.assertEqual(rv._0, 50)
- self.assertEqual(rv.context, 123)
- self.assertEqual(rv.cmd.decode('ascii'), 'show version verbose')
-
- variable_array_16_msg = '''["variable_array_16",
- ["u32", "length"],
- ["u16", "list", 0, "length"]
- ]'''
-
- p = json.loads(variable_array_16_msg)
- msgdef = msglist.add_message(p[0], p[1:])
-
- # Give me a byte string for given message and given arguments
- b = msglist.encode(msgdef, { 'list' : [1, 2], 'length' :2})
- self.assertEqual(8, len(b))
- rv = msglist.decode(msgdef, b)
- self.assertEqual(2, rv.length)
- self.assertEqual([1,2], rv.list)
-
- def test_add_new_types(self):
- counter_type = '''["ip4_fib_counter",
- ["u32", "address"],
- ["u8", "address_length"],
- ["u64", "packets"],
- ["u64", "bytes"],
- {"crc" : "0xb2739495"}
- ]'''
-
- with_type_msg = '''["with_type_msg",
- ["u32", "length"],
- ["u16", "list", 0, "length"],
- ["vl_api_ip4_fib_counter_t", "counter"]
- ]'''
-
- # Add new type
- msglist = VPP(testmode=True)
- p = json.loads(counter_type)
- msglist.add_type(p[0], p[1:])
- p = json.loads(with_type_msg)
- msgdef = msglist.add_message(p[0], p[1:])
- b = msglist.encode(msgdef, {'length' : 2, 'list' : [1,2],
- 'counter' : { 'address' : 4, 'address_length' : 12,
- 'packets': 1235, 'bytes' : 5678}})
- self.assertEqual(29, len(b)) # feil
- rv = msglist.decode(msgdef, b)
- self.assertEqual(2, rv.length)
- self.assertEqual(5678, rv.counter.bytes)
-
- def test_add_new_compound_type_with_array(self):
- counter_type = '''["ip4_fib_counter",
- ["u32", "address"],
- ["u8", "address_length"],
- ["u64", "packets"],
- ["u64", "bytes"],
- {"crc" : "0xb2739495"}
- ]'''
-
- with_type_msg = '''["with_type_msg",
- ["u32", "length"],
- ["u16", "list", 0, "length"],
- ["vl_api_ip4_fib_counter_t", "counter", 2]
-
- ]'''
-
- # Add new type
- msglist = VPP(testmode=True)
- p = json.loads(counter_type)
- msglist.add_type(p[0], p[1:])
- p = json.loads(with_type_msg)
- msgdef = msglist.add_message(p[0], p[1:])
- b = msglist.encode(msgdef, {'length' : 2, 'list' : [1,2],
- 'counter' : [{ 'address' : 4, 'address_length' : 12,
- 'packets': 1235, 'bytes' : 5678},
- { 'address' : 111, 'address_length' : 222,
- 'packets': 333, 'bytes' : 444}]})
- self.assertEqual(50, len(b))
- rv = msglist.decode(msgdef, b)
- self.assertEqual([1,2], rv.list)
- self.assertEqual(1235, rv.counter[0].packets)
-
- with_type_variable_msg = '''["with_type_variable_msg",
- ["u32", "length"],
- ["vl_api_ip4_fib_counter_t", "counter", 0, "length"]
-
- ]'''
-
- p = json.loads(with_type_variable_msg)
- msgdef = msglist.add_message(p[0], p[1:])
- b = msglist.encode(msgdef, {'length' : 2,
- 'counter' : [{ 'address' : 4, 'address_length' : 12,
- 'packets': 1235, 'bytes' : 5678},
- { 'address' : 111, 'address_length' : 222,
- 'packets': 333, 'bytes' : 444}]})
- self.assertEqual(46, len(b))
- rv = msglist.decode(msgdef, b)
- self.assertEqual(2, rv.length)
- self.assertEqual(1235, rv.counter[0].packets)
- self.assertEqual(333, rv.counter[1].packets)
-
- def test_simple_array(self):
- msglist = VPP(testmode=True)
-
- simple_byte_array = '''["simple_byte_array",
- ["u32", "length"],
- ["u8", "namecommand", 64]
-
- ]'''
- p = json.loads(simple_byte_array)
- msgdef = msglist.add_message(p[0], p[1:])
- b = msglist.encode(msgdef, {'length': 2, 'namecommand': 'foobar'})
- self.assertEqual(68, len(b))
- rv = msglist.decode(msgdef, b)
- self.assertEqual(2, rv.length)
-
- simple_array = '''["simple_array",
- ["u32", "length"],
- ["u32", "list", 2]
-
- ]'''
- p = json.loads(simple_array)
- msgdef = msglist.add_message(p[0], p[1:])
- b = msglist.encode(msgdef, {'length': 2, 'list': [1,2]})
- self.assertEqual(12, len(b))
- rv = msglist.decode(msgdef, b)
- self.assertEqual(2, rv.length)
- self.assertEqual([1,2], rv.list)
-
- simple_variable_array = '''["simple_variable_array",
- ["u32", "length"],
- ["u32", "list", 0, "length"]
-
- ]'''
- p = json.loads(simple_variable_array)
- msgdef = msglist.add_message(p[0], p[1:])
- b = msglist.encode(msgdef, {'length':2, 'list': [1,2]})
- self.assertEqual(12, len(b))
- rv = msglist.decode(msgdef, b)
- self.assertEqual(2, rv.length)
- self.assertEqual([1,2], rv.list)
-
- simple_variable_byte_array = '''["simple_variable_byte_array",
- ["u32", "length"],
- ["u8", "list", 0, "length"]
- ]'''
- p = json.loads(simple_variable_byte_array)
- msgdef =msglist.add_message(p[0], p[1:])
- b = msglist.encode(msgdef, {'length': 6, 'list' : 'foobar'})
- self.assertEqual(10, len(b))
- rv = msglist.decode(msgdef, b)
- self.assertEqual(6, rv.length)
- self.assertEqual('foobar', rv.list)
-
- def test_old_vla_array(self):
- msglist = VPP(testmode = True)
-
- # VLA
- vla_byte_array = '''["vla_byte_array",
- ["u32", "foobar"],
- ["u32", "list", 2],
- ["u32", "propercount"],
- ["u8", "propermask", 0, "propercount"],
- ["u8", "oldmask", 0],
- {"crc" : "0xb2739495"}
- ]'''
- p = json.loads(vla_byte_array)
- msgdef = msglist.add_message(p[0], p[1:])
- b = msglist.encode(msgdef, {'list' : [123, 456], 'oldmask': b'foobar',
- 'propercount' : 2,
- 'propermask' : [8,9]})
- self.assertEqual(24, len(b))
- rv = msglist.decode(msgdef, b)
- self.assertEqual(b'foobar', rv.oldmask)
-
- def test_old_vla_array_not_last_member(self):
- msglist = VPP(testmode = True)
-
- # VLA
- vla_byte_array = '''["vla_byte_array",
- ["u8", "oldmask", 0],
- ["u32", "foobar"],
- {"crc" : "0xb2739495"}
- ]'''
- p = json.loads(vla_byte_array)
- self.assertRaises(ValueError, msglist.add_message, p[0], p[1:])
-
- def test_old_vla_array_u32(self):
- msglist = VPP(testmode = True)
-
- # VLA
- vla_byte_array = '''["vla_byte_array",
- ["u32", "foobar"],
- ["u32", "oldmask", 0],
- {"crc" : "0xb2739495"}
- ]'''
- p = json.loads(vla_byte_array)
- msgdef = msglist.add_message(p[0], p[1:])
- b = msglist.encode(msgdef, {'foobar' : 123, 'oldmask': [123, 456, 789]})
- self.assertEqual(16, len(b))
- rv = msglist.decode(msgdef, b)
- self.assertEqual([123, 456, 789], rv.oldmask)
-
- def test_old_vla_array_compound(self):
- msglist = VPP(testmode = True)
-
- # VLA
- counter_type = '''["ip4_fib_counter",
- ["u32", "address"],
- ["u8", "address_length"],
- ["u64", "packets"],
- ["u64", "bytes"],
- {"crc" : "0xb2739495"}
- ]'''
-
- vla_byte_array = '''["vla_byte_array",
- ["vl_api_ip4_fib_counter_t", "counter", 0],
- {"crc" : "0xb2739495"}
- ]'''
-
- p = json.loads(counter_type)
- msglist.add_type(p[0], p[1:])
-
- p = json.loads(vla_byte_array)
- with self.assertRaises(NotImplementedError):
- msgdef = msglist.add_message(p[0], p[1:])
-
- def test_array_count_not_previous(self):
- msglist = VPP(testmode = True)
-
- # VLA
- vla_byte_array = '''["vla_byte_array",
- ["u32", "count"],
- ["u32", "filler"],
- ["u32", "lst", 0, "count"],
- {"crc" : "0xb2739495"}
- ]'''
-
- p = json.loads(vla_byte_array)
- msgdef = msglist.add_message(p[0], p[1:])
- b = msglist.encode(msgdef, {'count': 3, 'lst': [1,2,3], 'filler' : 1 })
- rv = msglist.decode(msgdef, b)
- self.assertEqual(rv.lst, [1,2,3])
-
- def test_argument_name(self):
- msglist = VPP(testmode=True)
-
-
- simple_name = '''["simple_name",
- ["u32", "length"],
- ["u8", "name"]
- ]'''
- p = json.loads(simple_name)
- msgdef = msglist.add_message(p[0], p[1:])
- b = msglist.encode(msgdef, {'length': 6, 'name': 1})
- self.assertEqual(5, len(b))
- rv = msglist.decode(msgdef, b)
- self.assertEqual(6, rv.length)
- self.assertEqual(1, rv.name)
-
-class TestConnectedPAPI(unittest.TestCase):
- def test_request_reply_function(self):
- vpp = VPP(jsonfiles)
-
- vpp.connect('test_vpp_papi2')
-
- rv = vpp.show_version()
- self.assertEqual(0, rv.retval)
- self.assertEqual('vpe', rv.program.decode().rstrip('\0x00'))
- vpp.disconnect()
-
-
- def test_dump_details_function(self):
- vpp = VPP(jsonfiles)
- vpp.connect('test_vpp_papi3')
-
- rv = vpp.sw_interface_dump()
- #self.assertEqual(0, rv.retval)
- print('RV', rv)
- vpp.disconnect()
-
- def test_vla(self):
- vpp = VPP(jsonfiles)
-
- vpp.connect('test_vpp_papi3')
-
- cmd = 'show version verbose'
- rv = vpp.cli_inband(length=len(cmd), cmd=cmd)
- self.assertEqual(0, rv.retval)
- print('RV', rv.reply)
-
- cmd = 'show vlib graph'
- rv = vpp.cli_inband(length=len(cmd), cmd=cmd)
- self.assertEqual(0, rv.retval)
- print('RV', rv.reply)
- vpp.disconnect()
-
- def test_events(self):
- vpp = VPP(jsonfiles)
-
- vpp.connect('test_vpp_papi3')
-
- vpp.register_event_callback(event_handler)
-
- rv = vpp.want_interface_events(enable_disable = True)
- self.assertEqual(0, rv.retval)
- print('RV', rv)
-
- rv = vpp.create_loopback()
- print('RV', rv)
- self.assertEqual(0, rv.retval)
-
- rv = vpp.sw_interface_set_flags(sw_if_index = 1, admin_up_down = 1)
- print('RV', rv)
- self.assertEqual(0, rv.retval)
- rv = vpp.sw_interface_set_flags(sw_if_index = 1, admin_up_down = 0)
- print('RV', rv)
- self.assertEqual(0, rv.retval)
- self.assertEqual(papi_event.wait(10), True)
-
- vpp.disconnect()
-
-def event_handler(msgname, result):
- print('IN EVENT HANDLER:', msgname, result)
- papi_event.set()
-
-class TestACL(unittest.TestCase):
- def test_acl_create(self):
- vpp = VPP(jsonfiles)
-
- vpp.connect('acl-test')
-
- rv = vpp.acl_plugin_get_version()
- print('RV', rv)
- self.assertEqual(rv.major, 1)
- self.assertEqual(rv.minor, 1)
-
- rv = vpp.acl_add_replace(acl_index = 0xFFFFFFFF,
- r = [{
- "is_permit" : 1,
- "is_ipv6" : 0,
- "proto" : 6,
- "srcport_or_icmptype_first" : 80,
- }],
- count = 1)
- print ('RV', rv)
- rv = vpp.acl_add_replace(acl_index = 0xFFFFFFFF,
- r = [{
- "is_permit" : 1,
- "is_ipv6" : 0,
- "proto" : 6,
- "srcport_or_icmptype_first" : 81,
- }],
- count = 1)
- self.assertEqual(rv.retval, 0)
- print ('RV', rv)
- ai = rv.acl_index
- rv = vpp.acl_dump()
- print ('RV', rv)
-
- #rv = vpp.acl_del(acl_index = ai)
- #self.assertEqual(rv.retval, 0)
-
- #rv = vpp.acl_dump()
- #self.assertEqual([], vpp.acl_dump())
-
- vpp.disconnect()
-
- def test_status(self):
- vpp = VPP(jsonfiles)
- vpp.status()
-
- def test_acl_interface_get(self):
- vpp = VPP(jsonfiles)
-
- vpp.connect('test_vpp_papi2')
-
- rv = vpp.macip_acl_interface_get()
-
- print('RV', rv)
-
- vpp.disconnect()
-
-if __name__ == '__main__':
- unittest.main()
diff --git a/vpp-api/python/vpp_papi/__init__.py b/vpp-api/python/vpp_papi/__init__.py
deleted file mode 100644
index 6688ffb8ced..00000000000
--- a/vpp-api/python/vpp_papi/__init__.py
+++ /dev/null
@@ -1,3 +0,0 @@
-__import__('pkg_resources').declare_namespace(__name__)
-from . vpp_papi import *
-
diff --git a/vpp-api/python/vpp_papi/pneum_wrap.c b/vpp-api/python/vpp_papi/pneum_wrap.c
deleted file mode 100644
index 5763707b517..00000000000
--- a/vpp-api/python/vpp_papi/pneum_wrap.c
+++ /dev/null
@@ -1,200 +0,0 @@
-/*
- * Copyright (c) 2016 Cisco and/or its affiliates.
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at:
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-#include <Python.h>
-#include "../pneum/pneum.h"
-#include <vppinfra/hash.h>
-
-static PyObject *pneum_callback = NULL;
-
-static void
-wrap_pneum_callback (unsigned char * data, int len)
-{
- PyGILState_STATE gstate;
- PyObject *result;//, *arglist;
-
- gstate = PyGILState_Ensure();
-
- /* Time to call the callback */
-#if PY_VERSION_HEX >= 0x03000000
- result = PyObject_CallFunction(pneum_callback, "y#", data, len);
-#else
- result = PyObject_CallFunction(pneum_callback, "s#", data, len);
-#endif
- if (result)
- Py_DECREF(result);
- else
- PyErr_Print();
-
- PyGILState_Release(gstate);
-}
-
-static PyObject *
-wrap_connect (PyObject *self, PyObject *args)
-{
- char * name, * chroot_prefix = NULL;
- int rv;
- PyObject * temp = NULL;
- pneum_callback_t cb = NULL;
-
- if (!PyArg_ParseTuple(args, "s|Os:wrap_connect",
- &name, &temp, &chroot_prefix))
- return (NULL);
-
- if (temp)
- {
- if (!PyCallable_Check(temp))
- {
- PyErr_SetString(PyExc_TypeError, "parameter must be callable");
- return NULL;
- }
-
- Py_XINCREF(temp); /* Add a reference to new callback */
- Py_XDECREF(pneum_callback); /* Dispose of previous callback */
- pneum_callback = temp; /* Remember new callback */
- cb = wrap_pneum_callback;
- }
- Py_BEGIN_ALLOW_THREADS
- rv = pneum_connect(name, chroot_prefix, cb);
- Py_END_ALLOW_THREADS
- return PyLong_FromLong(rv);
-}
-
-static PyObject *
-wrap_disconnect (PyObject *self, PyObject *args)
-{
- int rv;
- Py_BEGIN_ALLOW_THREADS
- rv = pneum_disconnect();
- Py_END_ALLOW_THREADS
- return PyLong_FromLong(rv);
-}
-static PyObject *
-wrap_write (PyObject *self, PyObject *args)
-{
- char *data;
- int len, rv;
-
- if (!PyArg_ParseTuple(args, "s#", &data, &len))
- return NULL;
- Py_BEGIN_ALLOW_THREADS
- rv = pneum_write(data, len);
- Py_END_ALLOW_THREADS
-
- return PyLong_FromLong(rv);
-}
-
-static PyObject *
-wrap_read (PyObject *self, PyObject *args)
-{
- char *data;
- int len, rv;
-
- Py_BEGIN_ALLOW_THREADS
- rv = pneum_read(&data, &len);
- Py_END_ALLOW_THREADS
-
- if (rv != 0) { Py_RETURN_NONE; }
-#if PY_VERSION_HEX >= 0x03000000
- PyObject *ret = Py_BuildValue("y#", data, len);
-#else
- PyObject *ret = Py_BuildValue("s#", data, len);
-#endif
- if (!ret) { Py_RETURN_NONE; }
-
- pneum_free(data);
- return ret;
-}
-
-static PyObject *
-wrap_msg_table (PyObject *self, PyObject *args)
-{
- int i = 0, rv = 0;
- hash_pair_t *hp;
- uword *h = pneum_msg_table_get_hash();
- PyObject *ret = PyList_New(pneum_msg_table_size());
- if (!ret) goto error;
- hash_foreach_pair (hp, h,
- ({
- PyObject *item = PyTuple_New(2);
- if (!item) goto error;
- rv = PyTuple_SetItem(item, 0, PyLong_FromLong((u32)hp->value[0]));
- if (rv) goto error;
- rv = PyTuple_SetItem(item, 1, PyString_FromString((char *)hp->key));
- if (rv) goto error;
- PyList_SetItem(ret, i, item);
- i++;
- }));
-
- return ret;
-
- error:
- /* TODO: Raise exception */
- printf("msg_table failed");
- Py_RETURN_NONE;
-}
-
-static PyMethodDef vpp_api_Methods[] = {
- {"connect", wrap_connect, METH_VARARGS, "Connect to the VPP API."},
- {"disconnect", wrap_disconnect, METH_VARARGS, "Disconnect from the VPP API."},
- {"write", wrap_write, METH_VARARGS, "Write data to the VPP API."},
- {"read", wrap_read, METH_VARARGS, "Read data from the VPP API."},
- {"msg_table", wrap_msg_table, METH_VARARGS, "Get API dictionary."},
- {NULL, NULL, 0, NULL} /* Sentinel */
-};
-
-#if PY_VERSION_HEX >= 0x03000000
-PyMODINIT_FUNC
-PyInit_vpp_api (void)
-#else
-void
-initvpp_api (void)
-#endif
-{
-#if PY_VERSION_HEX >= 0x03000000
- static struct PyModuleDef vpp_api_module = {
-#if PY_VERSION_HEX >= 0x03020000
- PyModuleDef_HEAD_INIT,
-#else
- {
- PyObject_HEAD_INIT(NULL)
- NULL, /* m_init */
- 0, /* m_index */
- NULL, /* m_copy */
- },
-#endif
- (char *) "vpp_api",
- NULL,
- -1,
- vpp_api_Methods,
- NULL,
- NULL,
- NULL,
- NULL
- };
-#endif
-
- /* Ensure threading is initialised */
- if (!PyEval_ThreadsInitialized()) {
- PyEval_InitThreads();
- }
-
-#if PY_VERSION_HEX >= 0x03000000
- return PyModule_Create(&vpp_api_module);
-#else
- Py_InitModule((char *) "vpp_api", vpp_api_Methods);
- return;
-#endif
-}
diff --git a/vpp-api/python/vpp_papi/vpp_papi.py b/vpp-api/python/vpp_papi/vpp_papi.py
deleted file mode 100644
index 6b6b79fd70b..00000000000
--- a/vpp-api/python/vpp_papi/vpp_papi.py
+++ /dev/null
@@ -1,450 +0,0 @@
-#!/usr/bin/env python
-#
-# Copyright (c) 2016 Cisco and/or its affiliates.
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at:
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-from __future__ import print_function
-import sys, os, logging, collections, struct, json, threading, glob
-logging.basicConfig(level=logging.DEBUG)
-import vpp_api
-
-def eprint(*args, **kwargs):
- print(*args, file=sys.stderr, **kwargs)
-
-class VPP():
- def __init__(self, apifiles = None, testmode = False):
- self.messages = {}
- self.id_names = []
- self.id_msgdef = []
- self.buffersize = 10000
- self.connected = False
- self.header = struct.Struct('>HI')
- self.results = {}
- self.timeout = 5
- self.apifile = []
-
- if not apifiles:
- # Pick up API definitions from default directory
- apifiles = glob.glob('/usr/share/vpp/api/*.api.json')
-
- for file in apifiles:
- self.apifile.append(file)
- with open(file) as apidef_file:
- api = json.load(apidef_file)
- for t in api['types']:
- self.add_type(t[0], t[1:])
-
- for m in api['messages']:
- self.add_message(m[0], m[1:])
-
- # Basic sanity check
- if len(self.messages) == 0 and not testmode:
- raise ValueError(1, 'Missing JSON message definitions')
-
-
- class ContextId(object):
- def __init__(self):
- self.context = 0
- def __call__(self):
- self.context += 1
- return self.context
- get_context = ContextId()
-
- def status(self):
- print('Connected') if self.connected else print('Not Connected')
- print('Read API definitions from', self.apifile)
-
- def __struct (self, t, n = None, e = -1, vl = None):
- base_types = { 'u8' : 'B',
- 'u16' : 'H',
- 'u32' : 'I',
- 'i32' : 'i',
- 'u64' : 'Q',
- 'f64' : 'd',
- }
- pack = None
- if t in base_types:
- pack = base_types[t]
- if not vl:
- if e > 0 and t == 'u8':
- # Fixed byte array
- return struct.Struct('>' + str(e) + 's')
- if e > 0:
- # Fixed array of base type
- return [e, struct.Struct('>' + base_types[t])]
- elif e == 0:
- # Old style variable array
- return [-1, struct.Struct('>' + base_types[t])]
- else:
- # Variable length array
- return [vl, struct.Struct('>s')] if t == 'u8' else \
- [vl, struct.Struct('>' + base_types[t])]
-
- return struct.Struct('>' + base_types[t])
-
- if t in self.messages:
- ### Return a list in case of array ###
- if e > 0 and not vl:
- return [e, lambda self, encode, buf, offset, args: (
- self.__struct_type(encode, self.messages[t], buf, offset,
- args))]
- if vl:
- return [vl, lambda self, encode, buf, offset, args: (
- self.__struct_type(encode, self.messages[t], buf, offset,
- args))]
- elif e == 0:
- # Old style VLA
- raise NotImplementedError(1, 'No support for compound types ' + t)
- return lambda self, encode, buf, offset, args: (
- self.__struct_type(encode, self.messages[t], buf, offset, args)
- )
-
- raise ValueError(1, 'Invalid message type: ' + t)
-
- def __struct_type(self, encode, msgdef, buf, offset, kwargs):
- if encode:
- return self.__struct_type_encode(msgdef, buf, offset, kwargs)
- else:
- return self.__struct_type_decode(msgdef, buf, offset)
-
- def __struct_type_encode(self, msgdef, buf, offset, kwargs):
- off = offset
- size = 0
-
- for k in kwargs:
- if k not in msgdef['args']:
- raise ValueError(1, 'Invalid field-name in message call ' + k)
-
- for k,v in msgdef['args'].iteritems():
- off += size
- if k in kwargs:
- if type(v) is list:
- if callable(v[1]):
- e = kwargs[v[0]] if v[0] in kwargs else v[0]
- size = 0
- for i in range(e):
- size += v[1](self, True, buf, off + size,
- kwargs[k][i])
- else:
- if v[0] in kwargs:
- l = kwargs[v[0]]
- else:
- l = len(kwargs[k])
- if v[1].size == 1:
- buf[off:off + l] = bytearray(kwargs[k])
- size = l
- else:
- size = 0
- for i in kwargs[k]:
- v[1].pack_into(buf, off + size, i)
- size += v[1].size
- else:
- if callable(v):
- size = v(self, True, buf, off, kwargs[k])
- else:
- v.pack_into(buf, off, kwargs[k])
- size = v.size
- else:
- size = v.size if not type(v) is list else 0
-
- return off + size - offset
-
-
- def __getitem__(self, name):
- if name in self.messages:
- return self.messages[name]
- return None
-
- def encode(self, msgdef, kwargs):
- # Make suitably large buffer
- buf = bytearray(self.buffersize)
- offset = 0
- size = self.__struct_type(True, msgdef, buf, offset, kwargs)
- return buf[:offset + size]
-
- def decode(self, msgdef, buf):
- return self.__struct_type(False, msgdef, buf, 0, None)[1]
-
- def __struct_type_decode(self, msgdef, buf, offset):
- res = []
- off = offset
- size = 0
- for k,v in msgdef['args'].iteritems():
- off += size
- if type(v) is list:
- lst = []
- if callable(v[1]): # compound type
- size = 0
- if v[0] in msgdef['args']: # vla
- e = res[v[2]]
- else: # fixed array
- e = v[0]
- res.append(lst)
- for i in range(e):
- (s,l) = v[1](self, False, buf, off + size, None)
- lst.append(l)
- size += s
- continue
- if v[1].size == 1:
- if type(v[0]) is int:
- size = len(buf) - off
- else:
- size = res[v[2]]
- res.append(buf[off:off + size])
- else:
- e = v[0] if type(v[0]) is int else res[v[2]]
- if e == -1:
- e = (len(buf) - off) / v[1].size
- lst = []
- res.append(lst)
- size = 0
- for i in range(e):
- lst.append(v[1].unpack_from(buf, off + size)[0])
- size += v[1].size
- else:
- if callable(v):
- (s,l) = v(self, False, buf, off, None)
- res.append(l)
- size += s
- else:
- res.append(v.unpack_from(buf, off)[0])
- size = v.size
-
- return off + size - offset, msgdef['return_tuple']._make(res)
-
- def ret_tup(self, name):
- if name in self.messages and 'return_tuple' in self.messages[name]:
- return self.messages[name]['return_tuple']
- return None
-
- def add_message(self, name, msgdef):
- if name in self.messages:
- raise ValueError('Duplicate message name: ' + name)
-
- args = collections.OrderedDict()
- argtypes = collections.OrderedDict()
- fields = []
- msg = {}
- for i, f in enumerate(msgdef):
- if type(f) is dict and 'crc' in f:
- msg['crc'] = f['crc']
- continue
- field_type = f[0]
- field_name = f[1]
- if len(f) == 3 and f[2] == 0 and i != len(msgdef) - 2:
- raise ValueError('Variable Length Array must be last: ' + name)
- args[field_name] = self.__struct(*f)
- argtypes[field_name] = field_type
- if len(f) == 4: # Find offset to # elements field
- args[field_name].append(args.keys().index(f[3]) - i)
- fields.append(field_name)
- msg['return_tuple'] = collections.namedtuple(name, fields,
- rename = True)
- self.messages[name] = msg
- self.messages[name]['args'] = args
- self.messages[name]['argtypes'] = argtypes
- return self.messages[name]
-
- def add_type(self, name, typedef):
- return self.add_message('vl_api_' + name + '_t', typedef)
-
- def make_function(self, name, i, msgdef, multipart, async):
- if (async):
- f = lambda **kwargs: (self._call_vpp_async(i, msgdef, multipart, **kwargs))
- else:
- f = lambda **kwargs: (self._call_vpp(i, msgdef, multipart, **kwargs))
- args = self.messages[name]['args']
- argtypes = self.messages[name]['argtypes']
- f.__name__ = str(name)
- f.__doc__ = ", ".join(["%s %s" % (argtypes[k], k) for k in args.keys()])
- return f
-
- def _register_functions(self, async=False):
- self.id_names = [None] * (self.vpp_dictionary_maxid + 1)
- self.id_msgdef = [None] * (self.vpp_dictionary_maxid + 1)
- for name, msgdef in self.messages.iteritems():
- if name in self.vpp_dictionary:
- if self.messages[name]['crc'] != self.vpp_dictionary[name]['crc']:
- raise ValueError(3, 'Failed CRC checksum ' + name +
- ' ' + self.messages[name]['crc'] +
- ' ' + self.vpp_dictionary[name]['crc'])
- i = self.vpp_dictionary[name]['id']
- self.id_msgdef[i] = msgdef
- self.id_names[i] = name
- multipart = True if name.find('_dump') > 0 else False
- setattr(self, name, self.make_function(name, i, msgdef, multipart, async))
-
- def _write (self, buf):
- if not self.connected:
- raise IOError(1, 'Not connected')
- return vpp_api.write(str(buf))
-
- def _load_dictionary(self):
- self.vpp_dictionary = {}
- self.vpp_dictionary_maxid = 0
- d = vpp_api.msg_table()
-
- if not d:
- raise IOError(3, 'Cannot get VPP API dictionary')
- for i,n in d:
- name, crc = n.rsplit('_', 1)
- crc = '0x' + crc
- self.vpp_dictionary[name] = { 'id' : i, 'crc' : crc }
- self.vpp_dictionary_maxid = max(self.vpp_dictionary_maxid, i)
-
- def connect(self, name, chroot_prefix = None, async = False):
- msg_handler = self.msg_handler if not async else self.msg_handler_async
- if not chroot_prefix:
- rv = vpp_api.connect(name, msg_handler)
- else:
- rv = vpp_api.connect(name, msg_handler, chroot_prefix)
-
- if rv != 0:
- raise IOError(2, 'Connect failed')
- self.connected = True
-
- self._load_dictionary()
- self._register_functions(async=async)
-
- # Initialise control ping
- self.control_ping_index = self.vpp_dictionary['control_ping']['id']
- self.control_ping_msgdef = self.messages['control_ping']
-
- def disconnect(self):
- rv = vpp_api.disconnect()
- return rv
-
- def results_wait(self, context):
- return (self.results[context]['e'].wait(self.timeout))
-
- def results_prepare(self, context):
- self.results[context] = {}
- self.results[context]['e'] = threading.Event()
- self.results[context]['e'].clear()
- self.results[context]['r'] = []
-
- def results_clean(self, context):
- del self.results[context]
-
- def msg_handler(self, msg):
- if not msg:
- eprint('vpp_api.read failed')
- return
-
- i, ci = self.header.unpack_from(msg, 0)
- if self.id_names[i] == 'rx_thread_exit':
- return;
-
- #
- # Decode message and returns a tuple.
- #
- msgdef = self.id_msgdef[i]
- if not msgdef:
- raise IOError(2, 'Reply message undefined')
-
- r = self.decode(msgdef, msg)
- if 'context' in r._asdict():
- if r.context > 0:
- context = r.context
-
- msgname = type(r).__name__
-
- #
- # XXX: Call provided callback for event
- # Are we guaranteed to not get an event during processing of other messages?
- # How to differentiate what's a callback message and what not? Context = 0?
- #
- #if not is_waiting_for_reply():
- if r.context == 0 and self.event_callback:
- self.event_callback(msgname, r)
- return
-
- #
- # Collect results until control ping
- #
- if msgname == 'control_ping_reply':
- self.results[context]['e'].set()
- return
-
- if not context in self.results:
- eprint('Not expecting results for this context', context, r)
- return
-
- if 'm' in self.results[context]:
- self.results[context]['r'].append(r)
- return
-
- self.results[context]['r'] = r
- self.results[context]['e'].set()
-
- def msg_handler_async(self, msg):
- if not msg:
- eprint('vpp_api.read failed')
- return
-
- i, ci = self.header.unpack_from(msg, 0)
- if self.id_names[i] == 'rx_thread_exit':
- return;
-
- #
- # Decode message and returns a tuple.
- #
- msgdef = self.id_msgdef[i]
- if not msgdef:
- raise IOError(2, 'Reply message undefined')
-
- r = self.decode(msgdef, msg)
- msgname = type(r).__name__
-
- self.event_callback(msgname, r)
-
- def _control_ping(self, context):
- self._write(self.encode(self.control_ping_msgdef,
- { '_vl_msg_id' : self.control_ping_index,
- 'context' : context}))
-
- def _call_vpp(self, i, msgdef, multipart, **kwargs):
- if not 'context' in kwargs:
- context = self.get_context()
- kwargs['context'] = context
- else:
- context = kwargs['context']
- kwargs['_vl_msg_id'] = i
- b = self.encode(msgdef, kwargs)
-
- self.results_prepare(context)
- self._write(b)
-
- if multipart:
- self.results[context]['m'] = True
- self._control_ping(context)
- self.results_wait(context)
- r = self.results[context]['r']
- self.results_clean(context)
- return r
-
- def _call_vpp_async(self, i, msgdef, multipart, **kwargs):
- if not 'context' in kwargs:
- context = self.get_context()
- kwargs['context'] = context
- else:
- context = kwargs['context']
- kwargs['_vl_msg_id'] = i
- b = self.encode(msgdef, kwargs)
-
- self._write(b)
-
- def register_event_callback(self, callback):
- self.event_callback = callback
-