Adding linux-ice script.

Signed-off-by: Daniel Baumann <daniel.baumann@open-infrastructure.net>

4 files changed, 260 insertions, 0 deletions

diff --git a/linux/bin/linux-ice b/linux/bin/linux-ice
new file mode 100755
index 0000000..6a25aa8
--- /dev/null
+++ b/linux/bin/linux-ice
@@ -0,0 +1,156 @@
+#!/bin/sh
+
+# Open Infrastructure: service-tools
+
+# Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+#
+# SPDX-License-Identifier: GPL-3.0+
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+set -e
+
+PROGRAM="$(basename "${0}")"
+
+RED="\033[1;33;31m"
+GREEN="\033[1;33;32m"
+NORMAL="\033[0m"
+
+Ethtool_get ()
+{
+	DEVICE="${1}"
+	FLAG="${2}"
+	TARGET_VALUE="${3}"
+
+	if ethtool --show-priv-flags "${DEVICE}" | awk '{ print $1 }' | grep -qs "^${FLAG}$"
+	then
+		CURRENT_VALUE="$(ethtool --show-priv-flags "${DEVICE}" | awk "/^${FLAG} / { print \$3 }")"
+
+		if [ "${CURRENT_VALUE}" = "${TARGET_VALUE}" ]
+		then
+			echo -n " ${FLAG}=${GREEN}${CURRENT_VALUE}${NORMAL}"
+		else
+			echo -n " ${FLAG}=${RED}${CURRENT_VALUE}${NORMAL}"
+		fi
+	fi
+}
+
+Ethtool_set ()
+{
+	DEVICE="${1}"
+	FLAG="${2}"
+	VALUE="${3}"
+
+	if ethtool --show-priv-flags "${DEVICE}" | awk '{ print $1 }' | grep -qs "^${FLAG}$"
+	then
+		echo -n " ${FLAG}"
+		ethtool --set-priv-flags "${DEVICE}" "${FLAG}" "${VALUE}"
+		echo -n "=${VALUE}"
+	fi
+}
+
+Test_root ()
+{
+	case "$(id -u)" in
+		0)
+			;;
+
+		*)
+			echo "'${PROGRAM}': must be run as root (or use sudo)" >&2
+			exit 1
+			;;
+	esac
+}
+
+Start ()
+{
+	Test_root
+
+	for DEVICE in ${DEVICES}
+	do
+		echo -n "Configuring ${DEVICE}:"
+		Ethtool_set "${DEVICE}" disable-fw-lldp on
+		Ethtool_set "${DEVICE}" link-down-on-close on
+		echo
+	done
+}
+
+Stop ()
+{
+	Test_root
+
+	for DEVICE in ${DEVICES}
+	do
+		echo -n "Deconfiguring ${DEVICE}:"
+		Ethtool_set "${DEVICE}" disable-fw-lldp off
+		Ethtool_set "${DEVICE}" link-down-on-close off
+		echo
+	done
+}
+
+Status ()
+{
+	for DEVICE in ${DEVICES}
+	do
+		echo -n "${DEVICE}:"
+		Ethtool_get "${DEVICE}" disable-fw-lldp on
+		Ethtool_get "${DEVICE}" link-down-on-close on
+		echo
+	done
+}
+
+Usage ()
+{
+	echo "Usage: ${PROGRAM} {start|stop|status}" >&2
+	echo >&2
+	echo "See ${PROGRAM}(1) for more information." >&2
+
+	exit 1
+}
+
+if [ -z "${1}" ]
+then
+	Usage
+fi
+
+if [ ! -x /usr/sbin/ethtool ]
+then
+	echo "'${PROGRAM}': /usr/sbin/ethtool - no such file." >&2
+	exit 1
+fi
+
+DEVICES="$(grep -s '^DRIVER=ice' /sys/class/net/*/device/uevent | awk -F/ '{ print $5 }' | grep -v eno | sort -V)"
+
+if [ -z "${DEVICES}" ]
+then
+	echo "'${PROGRAM}': no network devices available with ice driver" >&2
+fi
+
+case "${1}" in
+	start)
+		Start
+		;;
+
+	stop)
+		Stop
+		;;
+
+	status)
+		Status
+		;;
+
+	*)
+		Usage
+		;;
+esac
diff --git a/linux/share/man/linux-i40e.1.rst b/linux/share/man/linux-i40e.1.rst
index f4c2eb7..b1f8c30 100644
--- a/linux/share/man/linux-i40e.1.rst
+++ b/linux/share/man/linux-i40e.1.rst
@@ -59,6 +59,7 @@ Recommended options
 See also
 ========
 
+| linux-ice(1),
 | ethtool(8),
 | https://www.kernel.org/doc/Documentation/networking/i40e.txt
 
diff --git a/linux/share/man/linux-ice.1.rst b/linux/share/man/linux-ice.1.rst
new file mode 100644
index 0000000..60b718e
--- /dev/null
+++ b/linux/share/man/linux-ice.1.rst
@@ -0,0 +1,86 @@
+.. Open Infrastructure: service-tools
+
+.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+..
+.. SPDX-License-Identifier: GPL-3.0+
+..
+.. This program is free software: you can redistribute it and/or modify
+.. it under the terms of the GNU General Public License as published by
+.. the Free Software Foundation, either version 3 of the License, or
+.. (at your option) any later version.
+..
+.. This program is distributed in the hope that it will be useful,
+.. but WITHOUT ANY WARRANTY; without even the implied warranty of
+.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.. GNU General Public License for more details.
+..
+.. You should have received a copy of the GNU General Public License
+.. along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+=========
+linux-ice
+=========
+
+------------------------------------------------------------
+setting recommended options for the Linux ice device driver
+------------------------------------------------------------
+
+:manual section: 1
+:manual group: Open Infrastructure
+
+Synopsis
+========
+
+| **linux-ice** start|stop|status
+
+Description
+===========
+
+**linux-ice** sets all recommended options for the Linux ice device driver.
+
+Recommended options
+===================
+
+| **Enabling disable-fw-lldp**
+| Many Intel network cards such as the X700 Series drop LLDP pakets by default.
+| When using LACP (802.1ad) this has the effect that after a reboot of one switch,
+| the bond interfaces do not recover. Disabling the firewalling of LLDP pakets on
+| the network card allows the operating system (= Linux kernel) to actually recieve
+| the pakets and re-establish the bonded connection.
+
+| **Enabling link-down-on-close**
+| Many Intel network cards such as the X700 Series do not take down the link
+| when the corresponding interface is deconfigured. This is in contrast to the
+| consumer (Intel) network cards that usually do this. Therefore, without enabling
+| the link-down-on-close, most assumptions of HA stacks (e.g. pacemaker/corosync)
+| are not met and can lead to various unwanted effects. Enabling this options
+| restores the usual behaviour.
+
+See also
+========
+
+| linux-i40e(1),
+| ethtool(8),
+| https://www.kernel.org/doc/Documentation/networking/ice.txt
+
+Homepage
+========
+
+More information about service-tools and the Open Infrastructure project can be
+found on the homepage (https://open-infrastructure.net).
+
+Contact
+=======
+
+Bug reports, feature requests, help, patches, support and everything else are
+welcome on the Open Infrastructure Software Mailing List
+<software@lists.open-infrastructure.net>.
+
+Debian specific bugs can also be reported in the Debian Bug Tracking System
+(https://bugs.debian.org).
+
+Authors
+=======
+
+service-tools were written by Daniel Baumann
+<daniel.baumann@open-infrastructure.net> and others.
diff --git a/linux/share/systemd/linux-ice.service b/linux/share/systemd/linux-ice.service
new file mode 100644
index 0000000..ee8a727
--- /dev/null
+++ b/linux/share/systemd/linux-ice.service
@@ -0,0 +1,17 @@
+# Open Infrastructure: service-tools
+
+[Unit]
+Description=setting recommended options for the Linux ice device driver
+Documentation=man:linux-ice
+Before=network.target
+
+[Service]
+Type=oneshot
+RemainAfterExit=yes
+ExecStart=/usr/bin/linux-ice start
+ExecStop=/usr/bin/linux-ice stop
+StandardOutput=journal
+StandardError=journal
+
+[Install]
+WantedBy=multi-user.target