vlan: Add support for 802.1ad (QinQ)

[people/stevee/network.git] / src / functions / functions.vlan

#!/bin/bash
###############################################################################
#                                                                             #
# IPFire.org - A linux based firewall                                         #
# Copyright (C) 2012  IPFire Network Development Team                         #
#                                                                             #
# 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 <http://www.gnu.org/licenses/>.       #
#                                                                             #
###############################################################################

PROC_NET_VLAN="/proc/net/vlan"
PROC_NET_VLAN_CONFIG="${PROC_NET_VLAN}/config"

VLAN_SUPPORTED_PROTOCOLS=(
	"802.1Q"	# default
	"802.1ad"
)

VLAN_PORT_INTERFIX="v"

vlan_valid_id() {
	local id="${1}"

	# Must be an integer
	if ! isinteger id; then
		return ${EXIT_FALSE}
	fi

	# Must be between 1 and 4095
	if [ ${id} -ge 1 ] && [ ${id} -le 4096 ]; then
		return ${EXIT_TRUE}
	fi

	# Otherwise this is invalid
	return ${EXIT_FALSE}
}

vlan_supported_protocol() {
	local proto="${1}"
	assert isset proto

	list_match "${proto}" "${VLAN_SUPPORTED_PROTOCOLS[@]}"
}

vlan_create() {
	local device="${1}"
	shift

	assert isset device

	local address
	local id=1
	local parent
	local protocol="${VLAN_SUPPORTED_PROTOCOLS[0]}"

	# Parse command line arguments
	while [ $# -gt 0 ]; do
		case "${1}" in
			--address=*)
				address=$(cli_get_val "${1}")
				;;
			--id=*)
				id=$(cli_get_val "${1}")
				;;
			--parent=*)
				parent=$(cli_get_val "${1}")
				;;
			--protocol=*)
				protocol=$(cli_get_val "${1}")
				;;
			*)
				error "Unrecognized argument: ${1}"
				return ${EXIT_ERROR}
				;;
		esac
		shift
	done

	# Generate a random MAC address if none was passed
	if ! isset address; then
		address="$(mac_generate)"
	fi

	# Check if address is valid
	if ! ismac address; then
		log ERROR "Invalid mac address: ${address}"
		return ${EXIT_ERROR}
	fi

	# Check protocol
	if ! vlan_supported_protocol "${protocol}"; then
		log ERROR "Invalid protocol: ${protocol}"
		return ${EXIT_ERROR}
	fi

	# Check VLAN ID
	if ! vlan_valid_id "${id}"; then
		log ERROR "Invalid VLAN ID: ${id}"
		return ${EXIT_ERROR}
	fi

	# Check if a device with the name does already exist
	if device_exists "${device}"; then
		log ERROR "Device '${device}' already exists"
		return ${EXIT_ERROR}
	fi

	# Check if the parent device exists
	if ! device_exists "${parent}"; then
		log ERROR "Parent device '${parent}' does not exist"
		return ${EXIT_ERROR}
	fi

	# Make the command
	local command=(
		ip link add link "${parent}" name "${device}"
			address "${address}" type vlan proto "${protocol}" id "${id}"
	)

	# Run the command
	if ! cmd_quiet "${command[*]}"; then
		log ERROR "Could not create VLAN device ${device}: $?"
		return ${EXIT_ERROR}
	fi

	log DEBUG "Created VLAN device ${device} (parent = ${parent}, id = ${id})"

	return ${EXIT_OK}
}

vlan_remove() {
	device_delete "$@"
}

vlan_get_parent() {
	local device=${1}
	assert isset device

	# Nothing to do, if 8021q module is not loaded.
	[ -r "${PROC_NET_VLAN_CONFIG}" ] || return ${EXIT_OK}

	local dev spacer1 id spacer2 parent
	while read dev spacer1 id spacer2 parent; do
		[ "${device}" = "${dev}" ] || continue

		print "${parent}"
		return ${EXIT_OK}
	done < ${PROC_NET_VLAN_CONFIG}

	return ${EXIT_ERROR}
}

vlan_get_id() {
	local device=${1}
	assert isset device

	# Nothing to do, if 8021q module is not loaded.
	[ -r "${PROC_NET_VLAN_CONFIG}" ] || return ${EXIT_OK}

	local dev spacer1 id spacer2 parent
	while read dev spacer1 id spacer2 parent; do
		[ "${device}" = "${dev}" ] || continue

		print "${id}"
		return ${EXIT_OK}
	done < ${PROC_NET_VLAN_CONFIG}

	return ${EXIT_ERROR}
}

vlan_get_by_parent_and_vid() {
	local parent=${1}
	assert isset parent

	local vid=${2}
	assert isset vid

	# Nothing to do, if 8021q module is not loaded.
	[ -r "${PROC_NET_VLAN_CONFIG}" ] || return ${EXIT_OK}

	local dev spacer1 id spacer2 par
	while read dev spacer1 id spacer2 par; do
		[ "${parent}" = "${par}" ] || continue
		[ "${vid}" = "${id}" ] || continue

		print "${dev}"
		return ${EXIT_OK}
	done < ${PROC_NET_VLAN_CONFIG}

	return ${EXIT_ERROR}
}