Replace nnpy with pynng.

Signed-off-by: fruffy <fruffy@nyu.edu>

Author: fruffy

.github/workflows/build.yml

@@ -53,9 +53,7 @@ jobs:
         python3 -m pip install --upgrade pip setuptools nose2 wheel
         python -m pip install scapy==${{ matrix.scapy_version }}
 
-        bash CI/install-nanomsg.sh
-        sudo ldconfig
-        bash CI/install-nnpy.sh
+        bash CI/install-pynng.sh
 
     - name: Install
       run: |
@@ -71,5 +69,5 @@ jobs:
       run: |
         source $HOME/ptf-test-venv/bin/activate
         pip --verbose list
-        python3 CI/check-nnpy.py
+        python3 CI/check-pynng.py
         ./CI/run_tests.sh

CI/check-nnpy.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python
+
+import sys
+import time
+
+import pynng
+
+address = "inproc://foo"
+
+pub = pynng.Pub0(listen=address)
+sub = pynng.Sub0(dial=address, recv_timeout=500)
+sub.subscribe("")
+
+ok = False
+for _ in range(5):
+    pub.send(b"hello, world")
+    try:
+        recv = sub.recv()
+    except pynng.Timeout:
+        time.sleep(0.05)
+        continue
+    if recv == b"hello, world":
+        ok = True
+        break
+
+pub.close()
+sub.close()
+
+if not ok:
+    sys.exit(1)

CI/check-pynng.py

@@ -0,0 +1,3 @@
+#!/bin/sh
+set -e
+python3 -m pip install --upgrade pynng

CI/install-nnpy.sh

@@ -315,12 +315,12 @@ NICs on the host running PTF, like so:
 
 ### `nn`
 
-We introduce a new platform, `nn`, which uses [nanomsg] (http://nanomsg.org/) to
-send and receive packet to the switch. We support IPC and TCP nanomsg
-sockets. When using this platform, you need to make sure that the Python package
-[nnpy] (https://github.com/nanomsg/nnpy) is installed. With `nn`, do not use
+We introduce a new platform, `nn`, which uses [NNG] (https://nng.nanomsg.org/)
+to send and receive packet to the switch. We support IPC and TCP sockets. When
+using this platform, you need to make sure that the Python package
+[pynng] (https://github.com/codypiersall/pynng) is installed. With `nn`, do not use
 `--interface`, instead use `--device-socket`. For each device, you need to
-provide a list of enabled ports and a nanomsg socket address. For example:
+provide a list of enabled ports and a socket address. For example:
 
     --device-socket 0-{1,2,5-8}@ipc:///tmp/bmv2_packets_1.ipc
 

CI/install-pynng.sh

@@ -824,9 +824,9 @@ logging.info("Importing platform: " + platform_name)
 # TODO(antonin): put this check in platforms/nn.py ?
 if platform_name == "nn":
     try:
-        import nnpy
+        import pynng
     except:
-        die("Cannot use 'nn' platform if nnpy package is not installed")
+        die("Cannot use 'nn' platform if pynng package is not installed")
 
 platform_mod = None
 try:

README.md

@@ -10,18 +10,17 @@ the host running PTF).
 
 ## Dependencies
 
-We rely on [nanomsg](http://nanomsg.org/) (a messaging library) to forward
+We rely on [NNG](https://nng.nanomsg.org/) (a messaging library and modern
+successor to nanomsg) to forward
 packets between the PTF agent and the PTF test runner. You will therefore need
 to install the following:
 
-  - [nanomsg](https://github.com/nanomsg/nanomsg/releases): we recommend
-    installing the `1.0.0` production release.
-  - [nnpy](https://github.com/nanomsg/nnpy): these are the Python bindings for
-    nanomsg. You may use the provided (install-nnpy.sh)[install-nnpy.sh] script
-    to install nnpy. It will install a version of nnpy that we have tested.
+  - [pynng](https://github.com/codypiersall/pynng): these are the Python
+    bindings for NNG. You may use the provided
+    [install-pynng.sh](../CI/install-pynng.sh) script to install pynng.
 
-We provide a [check-nnpy.py](check-nnpy.py) script that you can run to check
-that nanomsg and nnpy are running properly.
+We provide a [check-pynng.py](../CI/check-pynng.py) script that you can run to
+check that pynng is running properly.
 
 ## Overview
 
@@ -34,7 +33,7 @@ tester. Packets received on an interface (from the switch) will be tagged with
 the port number and forwarded to the PTF tester. Packets received from the PTF
 tester will be forwarded to the switch using the appropriate
 interface. Communications between the PTF tester and each agent are done over
-TCP using the nanomsg messaging library.
+TCP using the NNG messaging library.
 
 ## Demo
 
@@ -64,7 +63,7 @@ runs on the PTF host. The second PTF agent runs on the remote host. For each
 host we need to use a separate device id (0 for the PTF host, 1 for the remote
 host). The "switch" is connected to the PTF host through veth0-veth1 and to the
 remote host through veth2-veth3. When running `ptf`, we need to use the `nn`
-platform and provide the nanomsg TCP address for each of the 2 devices.
+platform and provide the NNG TCP address for each of the 2 devices.
 
 In our test, we send a packet to port 1 of device 0 and receive the exact same
 packet on port 1 of device 1, as expected.

ptf

@@ -28,9 +28,9 @@
 import socket
 
 try:
-    import nnpy
+    import pynng
 except ImportError:
-    print("Cannot find nnpy package, please install")
+    print("Cannot find pynng package, please install")
     sys.exit(1)
 import threading
 import os
@@ -369,20 +369,17 @@ def __init__(self, dev, socket_addr, nn_rcv_buf=0, nn_snd_buf=0):
         self.daemon = True
         self.dev = dev
         self.socket_addr = socket_addr
-        self.socket = nnpy.Socket(nnpy.AF_SP, nnpy.PAIR)
+        self.socket = pynng.Pair0()
         if nn_rcv_buf != 0:
-            self.socket.setsockopt(nnpy.SOL_SOCKET, nnpy.RCVBUF, nn_rcv_buf)
+            self.socket.recv_buffer_size = nn_rcv_buf
         if nn_snd_buf != 0:
-            self.socket.setsockopt(nnpy.SOL_SOCKET, nnpy.SNDBUF, nn_snd_buf)
-        self.socket.bind(socket_addr)
+            self.socket.send_buffer_size = nn_snd_buf
+        self.socket.listen(socket_addr)
 
     def forward(self, p, port):
         msg = struct.pack(
             "<iii{}s".format(len(p)), self.MSG_TYPE_PACKET_OUT, port, len(p), p
         )
-        # because nnpy expects unicode when using str
-        msg = bytearray(msg)
-
         self.socket.send(msg)
 
     def handle_info_req(self, port_number, info_id, msg):

ptf_nn/README.md

@@ -20,7 +20,7 @@
 #
 #
 
-import nnpy
+import pynng
 import struct
 import argparse
 
@@ -49,16 +49,14 @@ def receive(socket):
 
 
 def main():
-    socket = nnpy.Socket(nnpy.AF_SP, nnpy.PAIR)
-    socket.connect(args.socket)
+    socket = pynng.Pair0()
+    socket.dial(args.socket)
     if args.receive:
         receive(socket)
     else:  # send one
-        p = "ab" * 20
+        p = b"ab" * 20
         port = 1
         msg = struct.pack("<iii{}s".format(len(p)), MSG_TYPE_PACKET_IN, port, len(p), p)
-        # because nnpy expects unicode when using str
-        msg = list(msg)
         socket.send(msg)