finished converting nrl services to config service format

daemon/core/configservices/nrlservices/services.py

@@ -154,3 +154,95 @@ class NrlOlsr(ConfigService):
             ifname = ifc.name
             break
         return dict(has_smf=has_smf, has_zebra=has_zebra, ifname=ifname)
+
+
+class NrlOlsrv2(ConfigService):
+    name = "OLSRv2"
+    group = GROUP
+    directories = []
+    files = ["nrlolsrv2.sh"]
+    executables = ["nrlolsrv2"]
+    dependencies = []
+    startup = ["sh nrlolsrv2.sh"]
+    validate = ["pidof nrlolsrv2"]
+    shutdown = ["killall nrlolsrv2"]
+    validation_mode = ConfigServiceMode.BLOCKING
+    default_configs = []
+    modes = {}
+
+    def data(self) -> Dict[str, Any]:
+        has_smf = "SMF" in self.node.config_services
+        ifnames = []
+        for ifc in self.node.netifs():
+            if hasattr(ifc, "control") and ifc.control is True:
+                continue
+            ifnames.append(ifc.name)
+        return dict(has_smf=has_smf, ifnames=ifnames)
+
+
+class OlsrOrg(ConfigService):
+    name = "OLSRORG"
+    group = GROUP
+    directories = ["/etc/olsrd"]
+    files = ["olsrd.sh", "/etc/olsrd/olsrd.conf"]
+    executables = ["olsrd"]
+    dependencies = []
+    startup = ["sh olsrd.sh"]
+    validate = ["pidof olsrd"]
+    shutdown = ["killall olsrd"]
+    validation_mode = ConfigServiceMode.BLOCKING
+    default_configs = []
+    modes = {}
+
+    def data(self) -> Dict[str, Any]:
+        has_smf = "SMF" in self.node.config_services
+        ifnames = []
+        for ifc in self.node.netifs():
+            if hasattr(ifc, "control") and ifc.control is True:
+                continue
+            ifnames.append(ifc.name)
+        return dict(has_smf=has_smf, ifnames=ifnames)
+
+
+class MgenActor(NrlService):
+    name = "MgenActor"
+    group = GROUP
+    directories = []
+    files = ["start_mgen_actor.sh"]
+    executables = ["mgen"]
+    dependencies = []
+    startup = ["sh start_mgen_actor.sh"]
+    validate = ["pidof mgen"]
+    shutdown = ["killall mgen"]
+    validation_mode = ConfigServiceMode.BLOCKING
+    default_configs = []
+    modes = {}
+
+
+class Arouted(ConfigService):
+    name = "arouted"
+    group = GROUP
+    directories = []
+    files = ["startarouted.sh"]
+    executables = ["arouted"]
+    dependencies = []
+    startup = ["sh startarouted.sh"]
+    validate = ["pidof arouted"]
+    shutdown = ["pkill arouted"]
+    validation_mode = ConfigServiceMode.BLOCKING
+    default_configs = []
+    modes = {}
+
+    def data(self) -> Dict[str, Any]:
+        ip4_prefix = None
+        for ifc in self.node.netifs():
+            if hasattr(ifc, "control") and ifc.control is True:
+                continue
+            if ip4_prefix:
+                continue
+            for a in ifc.addrlist:
+                a = a.split("/")[0]
+                if netaddr.valid_ipv4(a):
+                    ip4_prefix = f"{a}/{24}"
+                    break
+        return dict(ip4_prefix=ip4_prefix)

daemon/core/configservices/nrlservices/templates/nrlolsrv2.sh

@@ -0,0 +1,7 @@
+<%
+  interfaces = "-i " + " -i ".join(ifnames)
+  smf = ""
+  if has_smf:
+    smf = "-flooding ecds -smfClient %s_smf" % node.name
+%>
+nrlolsrv2 -l /var/log/nrlolsrv2.log -rpipe ${node.name}_olsrv2 -p olsr ${smf} ${interfaces}

daemon/core/configservices/nrlservices/templates/olsrd.conf

@@ -0,0 +1,312 @@
+#
+# OLSR.org routing daemon config file
+# This file contains the usual options for an ETX based
+# stationary network without fisheye
+# (for other options see olsrd.conf.default.full)
+#
+# Lines starting with a # are discarded
+#
+
+#### ATTENTION for IPv6 users ####
+# Because of limitations in the parser IPv6 addresses must NOT
+# begin with a ":", so please add a "0" as a prefix.
+
+###########################
+### Basic configuration ###
+###########################
+# keep this settings at the beginning of your first configuration file
+
+# Debug level (0-9)
+# If set to 0 the daemon runs in the background, unless "NoFork" is set to true
+# (Default is 1)
+
+# DebugLevel  1
+
+# IP version to use (4 or 6)
+# (Default is 4)
+
+# IpVersion 4
+
+#################################
+### OLSRd agent configuration ###
+#################################
+# this parameters control the settings of the routing agent which are not
+# related to the OLSR protocol and it's extensions
+
+# FIBMetric controls the metric value of the host-routes OLSRd sets.
+# - "flat" means that the metric value is always 2. This is the preferred value
+#   because it helps the linux kernel routing to clean up older routes
+# - "correct" use the hopcount as the metric value.
+# - "approx" use the hopcount as the metric value too, but does only update the
+#   hopcount if the nexthop changes too
+# (Default is "flat")
+
+# FIBMetric "flat"
+
+#######################################
+### Linux specific OLSRd extensions ###
+#######################################
+# these parameters are only working on linux at the moment
+
+# SrcIpRoutes tells OLSRd to set the Src flag of host routes to the originator-ip
+# of the node. In addition to this an additional localhost device is created
+# to make sure the returning traffic can be received.
+# (Default is "no")
+
+# SrcIpRoutes no
+
+# Specify the proto tag to be used for routes olsr inserts into kernel
+# currently only implemented for linux
+# valid values under linux are 1 .. 254
+# 1 gets remapped by olsrd to 0 UNSPECIFIED (1 is reserved for ICMP redirects)
+# 2 KERNEL routes (not very wise to use)
+# 3 BOOT (should in fact not be used by routing daemons)
+# 4 STATIC
+# 8 .. 15 various routing daemons (gated, zebra, bird, & co)
+# (defaults to 0 which gets replaced by an OS-specific default value
+# under linux 3 (BOOT) (for backward compatibility)
+
+# RtProto 0
+
+# Activates (in IPv6 mode) the automatic use of NIIT
+# (see README-Olsr-Extensions)
+# (default is "yes")
+
+# UseNiit yes
+
+# Activates the smartgateway ipip tunnel feature.
+# See README-Olsr-Extensions for a description of smartgateways.
+# (default is "no")
+
+# SmartGateway no
+
+# Signals that the server tunnel must always be removed on shutdown,
+# irrespective of the interface up/down state during startup.
+# (default is "no")
+
+# SmartGatewayAlwaysRemoveServerTunnel no
+
+# Determines the maximum number of gateways that can be in use at any given
+# time. This setting is used to mitigate the effects of breaking connections
+# (due to the selection of a new gateway) on a dynamic network.
+# (default is 1)
+
+# SmartGatewayUseCount 1
+
+# Determines the take-down percentage for a non-current smart gateway tunnel.
+# If the cost of the current smart gateway tunnel is less than this percentage
+# of the cost of the non-current smart gateway tunnel, then the non-current smart
+# gateway tunnel is taken down because it is then presumed to be 'too expensive'.
+# This setting is only relevant when SmartGatewayUseCount is larger than 1;
+# a value of 0 will result in the tunnels not being taken down proactively.
+# (default is 0)
+
+# SmartGatewayTakeDownPercentage 0
+
+# Determines the policy routing script that is executed during startup and
+# shutdown of olsrd. The script is only executed when SmartGatewayUseCount
+# is set to a value larger than 1. The script must setup policy routing
+# rules such that multi-gateway mode works. A sample script is included.
+# (default is not set)
+
+# SmartGatewayPolicyRoutingScript ""
+
+# Determines the egress interfaces that are part of the multi-gateway setup and
+# therefore only relevant when SmartGatewayUseCount is larger than 1 (in which
+# case it must be explicitly set).
+# (default is not set)
+
+# SmartGatewayEgressInterfaces ""
+
+# Determines the routing tables offset for multi-gateway policy routing tables
+# See the policy routing script for an explanation.
+# (default is 90)
+
+# SmartGatewayTablesOffset 90
+
+# Determines the policy routing rules offset for multi-gateway policy routing
+# rules. See the policy routing script for an explanation.
+# (default is 0, which indicates that the rules and tables should be aligned and
+# puts this value at SmartGatewayTablesOffset - # egress interfaces -
+# # olsr interfaces)
+
+# SmartGatewayRulesOffset 87
+
+# Allows the selection of a smartgateway with NAT (only for IPv4)
+# (default is "yes")
+
+# SmartGatewayAllowNAT yes
+
+# Determines the period (in milliseconds) on which a new smart gateway
+# selection is performed.
+# (default is 10000 milliseconds)
+
+# SmartGatewayPeriod 10000
+
+# Determines the number of times the link state database must be stable
+# before a new smart gateway is selected.
+# (default is 6)
+
+# SmartGatewayStableCount 6
+
+# When another gateway than the current one has a cost of less than the cost
+# of the current gateway multiplied by SmartGatewayThreshold then the smart
+# gateway is switched to the other gateway. The unit is percentage.
+# (defaults to 0)
+
+# SmartGatewayThreshold 0
+
+# The weighing factor for the gateway uplink bandwidth (exit link, uplink).
+# See README-Olsr-Extensions for a description of smart gateways.
+# (default is 1)
+
+# SmartGatewayWeightExitLinkUp 1
+
+# The weighing factor for the gateway downlink bandwidth (exit link, downlink).
+# See README-Olsr-Extensions for a description of smart gateways.
+# (default is 1)
+
+# SmartGatewayWeightExitLinkDown 1
+
+# The weighing factor for the ETX costs.
+# See README-Olsr-Extensions for a description of smart gateways.
+# (default is 1)
+
+# SmartGatewayWeightEtx 1
+
+# The divider for the ETX costs.
+# See README-Olsr-Extensions for a description of smart gateways.
+# (default is 0)
+
+# SmartGatewayDividerEtx 0
+
+# Defines what kind of Uplink this node will publish as a
+# smartgateway. The existence of the uplink is detected by
+# a route to 0.0.0.0/0, ::ffff:0:0/96 and/or 2000::/3.
+# possible values are "none", "ipv4", "ipv6", "both"
+# (default is "both")
+
+# SmartGatewayUplink "both"
+
+# Specifies if the local ipv4 uplink use NAT
+# (default is "yes")
+
+# SmartGatewayUplinkNAT yes
+
+# Specifies the speed of the uplink in kilobit/s.
+# First parameter is upstream, second parameter is downstream
+# (default is 128/1024)
+
+# SmartGatewaySpeed 128 1024
+
+# Specifies the EXTERNAL ipv6 prefix of the uplink. A prefix
+# length of more than 64 is not allowed.
+# (default is 0::/0
+
+# SmartGatewayPrefix 0::/0
+
+##############################
+### OLSR protocol settings ###
+##############################
+
+# HNA (Host network association) allows the OLSR to announce
+# additional IPs or IP subnets to the net that are reachable
+# through this node.
+# Syntax for HNA4 is "network-address    network-mask"
+# Syntax for HNA6 is "network-address    prefix-length"
+# (default is no HNA)
+Hna4
+{
+# Internet gateway
+# 0.0.0.0   0.0.0.0
+# specific small networks reachable through this node
+# 15.15.0.0 255.255.255.0
+}
+Hna6
+{
+# Internet gateway
+#   0::                     0
+# specific small networks reachable through this node
+#   fec0:2200:106:0:0:0:0:0 48
+}
+
+################################
+### OLSR protocol extensions ###
+################################
+
+# Link quality algorithm (only for lq level 2)
+# (see README-Olsr-Extensions)
+# - "etx_float", a floating point  ETX with exponential aging
+# - "etx_fpm", same as ext_float, but with integer arithmetic
+# - "etx_ff" (ETX freifunk), an etx variant which use all OLSR
+#   traffic (instead of only hellos) for ETX calculation
+# - "etx_ffeth", an incompatible variant of etx_ff that allows
+#   ethernet links with ETX 0.1.
+# (defaults to "etx_ff")
+
+# LinkQualityAlgorithm    "etx_ff"
+
+# Fisheye mechanism for TCs (0 meansoff, 1 means on)
+# (default is 1)
+
+LinkQualityFishEye  0
+
+#####################################
+### Example plugin configurations ###
+#####################################
+# Olsrd plugins to load
+# This must be the absolute path to the file
+# or the loader will use the following scheme:
+# - Try the paths in the LD_LIBRARY_PATH
+#   environment variable.
+# - The list of libraries cached in /etc/ld.so.cache
+# - /lib, followed by /usr/lib
+#
+# the examples in this list are for linux, so check if the plugin is
+# available if you use windows.
+# each plugin should have a README file in it's lib subfolder
+
+# LoadPlugin "olsrd_txtinfo.dll"
+#LoadPlugin "olsrd_txtinfo.so.0.1"
+#{
+    # the default port is 2006 but you can change it like this:
+    #PlParam     "port"   "8080"
+
+    # You can set a "accept" single address to allow to connect to
+    # txtinfo. If no address is specified, then localhost (127.0.0.1)
+    # is allowed by default.  txtinfo will only use the first "accept"
+    # parameter specified and will ignore the rest.
+
+    # to allow a specific host:
+    #PlParam      "accept" "172.29.44.23"
+    # if you set it to 0.0.0.0, it will accept all connections
+    #PlParam      "accept" "0.0.0.0"
+#}
+
+#############################################
+### OLSRD default interface configuration ###
+#############################################
+# the default interface section can have the same values as the following
+# interface configuration. It will allow you so set common options for all
+# interfaces.
+
+InterfaceDefaults {
+    Ip4Broadcast      255.255.255.255
+}
+
+######################################
+### OLSRd Interfaces configuration ###
+######################################
+# multiple interfaces can be specified for a single configuration block
+# multiple configuration blocks can be specified
+
+# WARNING, don't forget to insert your interface names here !
+#Interface "<OLSRd-Interface1>" "<OLSRd-Interface2>"
+#{
+    # Interface Mode is used to prevent unnecessary
+    # packet forwarding on switched ethernet interfaces
+    # valid Modes are "mesh" and "ether"
+    # (default is "mesh")
+
+    # Mode "mesh"
+#}

daemon/core/configservices/nrlservices/templates/olsrd.sh

@@ -0,0 +1,4 @@
+<%
+  interfaces = "-i " + " -i ".join(ifnames)
+%>
+olsrd ${interfaces}

daemon/core/configservices/nrlservices/templates/start_mgen_actor.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+# auto-generated by MgenActor service
+mgenBasicActor.py -n ${node.name} -a 0.0.0.0  < /dev/null > /dev/null 2>&1 &

daemon/core/configservices/nrlservices/templates/startarouted.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+for f in "/tmp/${node.name}_smf"; do
+    count=1
+    until [ -e "$f" ]; do
+        if [ $count -eq 10 ]; then
+            echo "ERROR: nrlmsf pipe not found: $f" >&2
+            exit 1
+        fi
+        sleep 0.1
+        count=$(($count + 1))
+    done
+done
+
+ip route add ${ip4_prefix} dev lo
+arouted instance ${node.name}_smf tap ${node.name}_tap stability 10 2>&1 > /var/log/arouted.log &

daemon/core/configservices/nrlservices/templates/startsmf.sh

@@ -1,19 +1,15 @@
-#!/bin/sh
-# auto-generated by nrl.py:NrlSmf.generateconfig()
-% if ifnames:
-nrlsmf instance ${node.name}_smf \\
-% if has_arouted:
-  tap ${node.name}_tap unicast %s push lo,${ifnames[0]} resequence on \\
-% endif
-% if has_nhdp:
-  ecds \\
-% elif has_olsr:
-  smpr \\
-% else:
-  cf \\
-% endif
 <%
   interfaces = ",".join(ifnames)
+  arouted = ""
+  if has_arouted:
+    arouted = "tap %s_tap unicast %s push lo,%s resequence on" % (node.name, ip4_prefix, ifnames[0])
+  if has_nhdp:
+    flood = "ecds"
+  elif has_olsr:
+    flood = "smpr"
+  else:
+    flood = "cf"
 %>
-  ${interfaces} hash MD5 log /var/log/nrlsmf.log < /dev/null > /dev/null 2>&1 &
-% endif
+#!/bin/sh
+# auto-generated by NrlSmf service
+nrlsmf instance ${node.name}_smf ${interfaces} ${arouted} ${flood} hash MD5 log /var/log/nrlsmf.log < /dev/null > /dev/null 2>&1 &