poky-gen-tapdevs: script to create a 'bank' of tap interfaces

This script can be used to create and configure a 'bank' of tap
interfaces that can be used by the poky-qemu script.

It is useful in locked-down enterprise environments where developers
do not have sudo access, but need to be able to run QEMU with
networking. A sysadmin would then use this script to bring up a
number of tap interfaces for the user to make use of.

This fixes [BUGID #391]

Signed-off-by: Scott Garman <scott.a.garman@intel.com>

2 files changed, 96 insertions, 0 deletions

diff --git a/scripts/poky-gen-tapdevs b/scripts/poky-gen-tapdevs
new file mode 100755
index 0000000000..2117a7b08e
--- /dev/null
+++ b/scripts/poky-gen-tapdevs
@@ -0,0 +1,85 @@
+#!/bin/bash
+#
+# Create a "bank" of tap network devices that can be used by the
+# poky-qemu script. This script needs to be run as root, and will
+# use the tunctl binary from a Poky sysroot. Note: many Linux distros
+# these days still use an older version of tunctl which does not
+# support the group permissions option, hence the need to use Poky's
+# version.
+#
+# Copyright (C) 2010 Intel Corp.
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 as
+# published by the Free Software Foundation.
+#
+# 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+usage() {
+        echo "Usage: sudo $0 <gid> <num> <native-sysroot-basedir>"
+        echo "Where <gid> is the numeric group id the tap devices will be owned by"
+        echo "<num> is the number of tap devices to create (0 to remove all)"
+        echo "<native-sysroot-basedir> is the path to Poky's native sysroot"
+        exit 1
+}
+
+if [ $EUID -ne 0 ]; then
+        echo "Error: This script must be run with root privileges"
+        exit
+fi
+
+if [ $# -ne 3 ]; then
+        echo "Error: Incorrect number of arguments"
+        usage
+fi
+
+GID=$1
+COUNT=$2
+SYSROOT=$3
+
+TUNCTL=$SYSROOT/usr/bin/tunctl
+if [[ ! -x "$TUNCTL" || -d "$TUNCTL" ]]; then
+        echo "Error: $TUNCTL is not an executable"
+        usage
+fi
+
+SCRIPT_DIR=`dirname $0`
+POKY_QEMU_IFUP="$SCRIPT_DIR/poky-qemu-ifup"
+if [ ! -x "$POKY_QEMU_IFUP" ]; then
+        echo "Error: Unable to find the poky-qemu-ifup script in $SCRIPT_DIR"
+        exit 1
+fi
+
+IFCONFIG=`which ifconfig`
+if [ -z "$IFCONFIG" ]; then
+        # Is it ever anywhere else?
+        IFCONFIG=/sbin/ifconfig
+fi
+
+# Ensure we start with a clean slate
+for tap in `$IFCONFIG | grep ^tap | awk '{ print \$1 }'`; do
+        echo "Note: Destroying pre-existing tap interface $tap..."
+        $TUNCTL -d $tap
+done
+
+echo "Creating $COUNT tap devices for GID $GID..."
+for ((index=0; index < $COUNT; index++)); do
+        echo "Creating tap$index"
+        ifup=`$POKY_QEMU_IFUP $GID $SYSROOT 2>&1`
+        if [ $? -ne 0 ]; then
+                echo "Error running tunctl: $ifup"
+                exit 1
+        fi
+done
+
+# The poky-qemu script will check for this file, and if it exists,
+# will use the existing bank of tap devices without creating
+# additional ones via sudo.
+touch /etc/poky-nosudo
diff --git a/scripts/poky-qemu-internal b/scripts/poky-qemu-internal
index c3720d9ce2..0ea38eef60 100755
--- a/scripts/poky-qemu-internal
+++ b/scripts/poky-qemu-internal
@@ -50,6 +50,10 @@ if [ -z "$QEMU_MEMORY" ]; then
 
 fi
 
+# This flag file is created when poky-gen-tapdevs creates a bank of
+# tap devices, indicating that the user does not have sudo privs.
+NOSUDO_FLAG="/etc/poky-nosudo"
+
 QEMUIFUP=`which poky-qemu-ifup`
 QEMUIFDOWN=`which poky-qemu-ifdown`
 
@@ -81,6 +85,13 @@ for tap in $POSSIBLE; do
 done
 
 if [ "$TAP" = "" ]; then
+    if [ -e "$NOSUDO_FLAG" ]; then
+        echo "Error: There are no available tap devices to use for networking,"
+        echo "and I see $NOSUDO_FLAG exists, so I am not going to try creating"
+        echo "a new one with sudo."
+        exit 1
+    fi
+
     GROUPID=`id -g`
     echo 'Setting up tap interface under sudo'
     tap=`sudo $QEMUIFUP $GROUPID $POKY_NATIVE_SYSROOT`