@ndn/dpdkmgmt

@ndn/dpdkmgmt

This package is part of NDNts, Named Data Networking libraries for the modern web.

This package enables interaction with the NDN-DPDK high-speed forwarder. It can create faces (either UDP or memif) for the NDNts application and perform prefix registrations.

Currently, there are several limitations when using this package:

• Prefix registration replaces a FIB entry, and does not preserve other prefix registrations on the same prefix.
• If the application crashes, the face will not be closed on NDN-DPDK side.

To start a minimal NDN-DPDK forwarder for this demo, run this script:

bash ./pkg/dpdkmgmt/fw.sh

import { openFace } from "@ndn/dpdkmgmt";

// other imports for examples
import { consume, produce } from "@ndn/endpoint";
import { Forwarder } from "@ndn/fw";
import { Name, Interest, Data } from "@ndn/packet";
import { delay, fromUtf8, toUtf8 } from "@ndn/util";
import assert from "node:assert/strict";

const gqlServer = process.env.DEMO_DPDKMGMT_GQLSERVER;
const localHost = process.env.DEMO_DPDKMGMT_LOCAL;
const scheme = process.env.DEMO_DPDKMGMT_MEMIF === "1" ? "memif" : "udp";
if (!gqlServer) {
  console.log(`
To run @ndn/dpdkmgmt demo, set the following environment variables:
DEMO_DPDKMGMT_GQLSERVER= NDN-DPDK forwarder management endpoint (required)
DEMO_DPDKMGMT_LOCAL= IP address to reach local host from NDN-DPDK (optional)
DEMO_DPDKMGMT_MEMIF=1 use memif instead of UDP (optional)
`);
  process.exit(0);
}

// Topology of this demo
//
// producer                      consumer
//    |                              |
//   fwP                            fwC
//    \---------- NDN-DPDK ----------/
//       uplinkP            uplinkC

// Create two logical forwarders, one as consumer and one as producer.
const fwC = Forwarder.create();
const fwP = Forwarder.create();

// Connect to NDN-DPDK.
const uplinkC = await openFace({
  fw: fwC,
  gqlServer,
  localHost,
  scheme,
});
const uplinkP = await openFace({
  fw: fwP,
  gqlServer,
  localHost,
  scheme,
});
console.log(`uplinkC=${uplinkC}`, `uplinkP=${uplinkP}`, `transport=${scheme}`);

// Start a producer.
let t0 = 0;
const producer = produce("/P", async (interest) => {
  console.log(`producing Data, latency=${Date.now() - t0}ms`);
  return new Data(interest.name, Data.FreshnessPeriod(1000), toUtf8("NDNts + NDN-DPDK"));
}, { fw: fwP });
await delay(500);

// Start a consumer, fetching Data from the producer via NDN-DPDK.
t0 = Date.now();
const data = await consume(
  new Interest(`/P/${Math.trunc(Math.random() * 1e8)}`, Interest.MustBeFresh),
  { fw: fwC },
);
const t1 = Date.now();
const payloadText = fromUtf8(data.content);
console.log(`received ${data.name} ${payloadText}, rtt=${t1 - t0}ms`);
assert.equal(payloadText, "NDNts + NDN-DPDK");

// Close faces.
producer.close();
await delay(500);
uplinkC.close();
uplinkP.close();