1.3.0-RC1 -- Switch mode is here!

  Provide packet inspection byte-code to get payload addressing,
  and MiniPlex can route packets to branches based on src/dst.

  Included DNP3 example src/SwitchDNP3.s -> switch.bpf

  Supported bytecode is a subset of eBPF.
  May change to RISC-V in future for better assembler support (and/or 3rd party interpreter).

Author: neilstephens

CMakeLists.txt

@@ -10,7 +10,7 @@ if(NOT WIN32)
 endif()
 
 project(MiniPlex LANGUAGES CXX)
-add_definitions(-DMP_VERSION="1.2.0")
+add_definitions(-DMP_VERSION="1.3.0")
 
 file(GLOB ${PROJECT_NAME}_SRC src/*.cpp src/*.h)
 

README.md

@@ -11,18 +11,19 @@ ProtoConv: Protocol adapter to convert between a stream and datagrams.
 
 USAGE: 
 
-   ./MiniPlex  {-H|-T|-P} -p <port> [-l <localaddr>] [-Z <rcv buf size>]
-               [-o <timeout>] [-r <trunkhost>] [-t <trunkport>] [-B
-               <branchhost>] ... [-b <branchport>] ... [-c <console log
-               level>] [-f <file log level>] [-F <log filename>] [-S <size
-               in kB>] [-N <number of files>] [-x <numthreads>] [-M] [-m
-               <milliseconds>] [--] [--version] [-h]
+   ./MiniPlex  {-H|-T|-P|-X} -p <port> [-l <localaddr>] [-Z <rcv buf size>]
+               [-o <timeout>] [-r <trunk host>] [-t <trunk port>] [-B
+               <branch host>] ... [-b <branch port>] ... [-C <switchmode
+               bytecode file>] [-c <console log level>] [-f <file log
+               level>] [-F <log filename>] [-S <size in kB>] [-N <number of
+               files>] [-x <num threads>] [-M] [-m <milliseconds>] [--]
+               [--version] [-h]
 
 
 Where: 
 
    -H,  --hub
-     (OR required)  Hub/Star mode: Forward datagrams from/to all endpoints.
+     (OR required)  Hub mode: Forward datagrams from/to all endpoints.
          -- OR --
    -T,  --trunk
      (OR required)  Trunk mode: Forward frames from a 'trunk' to other
@@ -31,6 +32,10 @@ Where:
    -P,  --prune
      (OR required)  Like Trunk mode, but limits flow to one (first in best
      dressed) branch
+         -- OR --
+   -X,  --switch
+     (OR required)  Switch mode: forward datagrams based on application
+     addresses.
 
 
    -p <port>,  --port <port>
@@ -45,20 +50,28 @@ Where:
    -o <timeout>,  --timeout <timeout>
      Milliseconds to keep an idle endpoint cached
 
-   -r <trunkhost>,  --trunk_ip <trunkhost>
+   -r <trunk host>,  --trunk_ip <trunk host>
      Remote trunk ip address.
 
-   -t <trunkport>,  --trunk_port <trunkport>
+   -t <trunk port>,  --trunk_port <trunk port>
      Remote trunk port.
 
-   -B <branchhost>,  --branch_ip <branchhost>  (accepted multiple times)
+   -B <branch host>,  --branch_ip <branch host>  (accepted multiple times)
      Remote endpoint addresses to permanently cache. Use -b to provide
      respective ports in the same order.
 
-   -b <branchport>,  --branch_port <branchport>  (accepted multiple times)
+   -b <branch port>,  --branch_port <branch port>  (accepted multiple
+      times)
      Remote endpoint port to permanently cache. Use -B to provide
      respective addresses in the same order.
 
+   -C <switchmode bytecode file>,  --byte_code <switchmode bytecode file>
+     eBPF (subset) byte code file. Switch mode code for extracting src and
+     dst addrs from packet data.
+
+     Pre-conditions: r0 = &buf, r1 = buf_size. Post-execution: result = r0
+     (success==0), src = r2, dst = r3.
+
    -c <console log level>,  --console_logging <console log level>
      Console log level: off, critical, error, warn, info, debug, or trace.
      Default critical.
@@ -76,7 +89,7 @@ Where:
    -N <number of files>,  --log_num <number of files>
      Keep this many log files when rolling the log. Defaults to 3
 
-   -x <numthreads>,  --concurrency <numthreads>
+   -x <num threads>,  --concurrency <num threads>
      A hint for the number of threads in thread pool. Defaults to detected
      hardware concurrency.
 

RELEASE_NOTES

@@ -1,4 +1,10 @@
-# MiniPlex version 1.2.0
+# MiniPlex version 1.3.0-RC1
+
+## 1.3.0-RC1
+  * MiniPlex 'Switch' mode
+    * Provide packet inspection byte-code to get payload addressing,
+    * and MiniPlex can route packets to branches based on src/dst.
+    * Included DNP3 example src/SwitchDNP3.s -> switch.bpf
 
 ## 1.2.0
   * ProtoConv options for max out-of-order frames and timeout

src/CmdArgs.h

@@ -27,23 +27,26 @@ struct CmdArgs
 {
 	CmdArgs(int argc, char* argv[]):
 		cmd("A minimal UDP multiplexer/hub/broker. A simple way to bolt-on rudimentary multi-cast/multi-path or combine connections.",' ',MP_VERSION),
-		Hub("H", "hub", "Hub/Star mode: Forward datagrams from/to all endpoints."),
+		Hub("H", "hub", "Hub mode: Forward datagrams from/to all endpoints."),
 		Trunk("T", "trunk", "Trunk mode: Forward frames from a 'trunk' to other endpoints. Forward datagrams from other endpoints to the trunk."),
 		Prune("P", "prune", "Like Trunk mode, but limits flow to one (first in best dressed) branch"),
+		Switch("X", "switch", "Switch mode: forward datagrams based on application addresses."),
 		LocalAddr("l", "local", "Local ip address. Defaults to 0.0.0.0 for all ipv4 interfaces.", false, "0.0.0.0", "localaddr"),
 		LocalPort("p", "port", "Local port to listen/receive on.", true, 0, "port"),
 		SoRcvBuf("Z", "so_rcvbuf", "Datagram socket receive buffer size.", false, 512L*1024, "rcv buf size"),
 		CacheTimeout("o", "timeout", "Milliseconds to keep an idle endpoint cached",false,10000,"timeout"),
-		TrunkAddr("r", "trunk_ip", "Remote trunk ip address.", false, "", "trunkhost"),
-		TrunkPort("t", "trunk_port", "Remote trunk port.", false, 0, "trunkport"),
-		BranchAddrs("B", "branch_ip", "Remote endpoint addresses to permanently cache. Use -b to provide respective ports in the same order.", false, "branchhost"),
-		BranchPorts("b", "branch_port", "Remote endpoint port to permanently cache. Use -B to provide respective addresses in the same order.", false, "branchport"),
+		TrunkAddr("r", "trunk_ip", "Remote trunk ip address.", false, "", "trunk host"),
+		TrunkPort("t", "trunk_port", "Remote trunk port.", false, 0, "trunk port"),
+		BranchAddrs("B", "branch_ip", "Remote endpoint addresses to permanently cache. Use -b to provide respective ports in the same order.", false, "branch host"),
+		BranchPorts("b", "branch_port", "Remote endpoint port to permanently cache. Use -B to provide respective addresses in the same order.", false, "branch port"),
+		ByteCodeFile("C", "byte_code", "eBPF (subset) byte code file. Switch mode code for extracting src and dst addrs from packet data.\n"
+							 "Pre-conditions: r0 = &buf, r1 = buf_size. Post-execution: result = r0 (success==0), src = r2, dst = r3.", false, "switch.bpf", "switchmode bytecode file"),
 		ConsoleLevel("c", "console_logging", "Console log level: off, critical, error, warn, info, debug, or trace. Default critical.", false, "critical", "console log level"),
 		FileLevel("f", "file_logging", "File log level: off, critical, error, warn, info, debug, or trace. Default error.", false, "error", "file log level"),
 		LogFile("F", "log_file", "Log filename. Defaults to ./MiniPlex.log", false, "MiniPlex.log", "log filename"),
 		LogSize("S", "log_size", "Roll the log file at this many kB. Defaults to 5000", false, 5000, "size in kB"),
 		LogNum("N", "log_num", "Keep this many log files when rolling the log. Defaults to 3", false, 3, "number of files"),
-		ConcurrencyHint("x", "concurrency", "A hint for the number of threads in thread pool. Defaults to detected hardware concurrency.",false,std::thread::hardware_concurrency(),"numthreads"),
+		ConcurrencyHint("x", "concurrency", "A hint for the number of threads in thread pool. Defaults to detected hardware concurrency.",false,std::thread::hardware_concurrency(),"num threads"),
 		Benchmark("M", "benchmark", "Run a loopback test for fixed duration (see -m) and exit."),
 		BenchDuration("m", "benchmark_duration", "Number of milliseconds to run the loopback benchmark test. Defaults to 10000.",false,10000,"milliseconds")
 	{
@@ -55,6 +58,7 @@ struct CmdArgs
 		cmd.add(LogFile);
 		cmd.add(FileLevel);
 		cmd.add(ConsoleLevel);
+		cmd.add(ByteCodeFile);
 		cmd.add(BranchPorts);
 		cmd.add(BranchAddrs);
 		cmd.add(TrunkPort);
@@ -63,22 +67,24 @@ struct CmdArgs
 		cmd.add(SoRcvBuf);
 		cmd.add(LocalAddr);
 		cmd.add(LocalPort);
-		cmd.xorAdd({&Hub,&Trunk,&Prune});
+		cmd.xorAdd({&Hub,&Trunk,&Prune,&Switch});
 		cmd.parse(argc, argv);
 
-		if(!Hub && (TrunkAddr.getValue() == "" || TrunkPort.getValue() == 0))
-			throw std::invalid_argument("Trunk ip and port required when not in Hub mode.");
+		if((Prune || Trunk) && (TrunkAddr.getValue() == "" || TrunkPort.getValue() == 0))
+			throw std::invalid_argument("Trunk ip and port required in Trunk or Prune mode.");
 
 		asio::error_code err;
 		asio::ip::address::from_string(LocalAddr.getValue(),err);
 		if(err)
 			throw std::invalid_argument("Invalid Local IP address: "+LocalAddr.getValue());
-		if(!Hub)
+
+		if(Prune || Trunk)
 		{
 			asio::ip::address::from_string(TrunkAddr.getValue(),err);
 			if(err)
 				throw std::invalid_argument("Invalid Trunk IP address: "+TrunkAddr.getValue());
 		}
+
 		for(const auto& B : BranchAddrs.getValue())
 		{
 			asio::ip::address::from_string(B,err);
@@ -92,6 +98,7 @@ struct CmdArgs
 	TCLAP::SwitchArg Hub;
 	TCLAP::SwitchArg Trunk;
 	TCLAP::SwitchArg Prune;
+	TCLAP::SwitchArg Switch;
 	TCLAP::ValueArg<std::string> LocalAddr;
 	TCLAP::ValueArg<uint16_t> LocalPort;
 	TCLAP::ValueArg<size_t> SoRcvBuf;
@@ -100,6 +107,7 @@ struct CmdArgs
 	TCLAP::ValueArg<uint16_t> TrunkPort;
 	TCLAP::MultiArg<std::string> BranchAddrs;
 	TCLAP::MultiArg<uint16_t> BranchPorts;
+	TCLAP::ValueArg<std::string> ByteCodeFile;
 	TCLAP::ValueArg<std::string> ConsoleLevel;
 	TCLAP::ValueArg<std::string> FileLevel;
 	TCLAP::ValueArg<std::string> LogFile;