src/hooks/ports/batman-adv

   1 #!/bin/bash
   2 ###############################################################################
   3 #                                                                             #
   4 # IPFire.org - A linux based firewall                                         #
   5 # Copyright (C) 2013 Michael Tremer                                           #
   6 #                                                                             #
   7 # This program is free software: you can redistribute it and/or modify        #
   8 # it under the terms of the GNU General Public License as published by        #
   9 # the Free Software Foundation, either version 3 of the License, or           #
  10 # (at your option) any later version.                                         #
  11 #                                                                             #
  12 # This program is distributed in the hope that it will be useful,             #
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of              #
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
  15 # GNU General Public License for more details.                                #
  16 #                                                                             #
  17 # You should have received a copy of the GNU General Public License           #
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
  19 #                                                                             #
  20 ###############################################################################
  21
  22 . /usr/lib/network/header-port
  23
  24 HOOK_SETTINGS="HOOK ADDRESS SLAVES"
  25
  26 PORT_CHILDREN_VAR="SLAVES"
  27
  28 ADDRESS=$(mac_generate)
  29 SLAVES=
  30
  31 function hook_check_settings() {
  32         assert isset ADDRESS
  33         assert ismac ADDRESS
  34 }
  35
  36 function hook_new() {
  37         while [ $# -gt 0 ]; do
  38                 case "${1}" in
  39                         --address=*)
  40                                 ADDRESS="$(cli_get_val ${1})"
  41                                 ;;
  42                         --slaves=*)
  43                                 SLAVES="$(cli_get_val ${1})"
  44                                 ;;
  45                         *)
  46                                 warning "Ignoring unknown argument '${1}'"
  47                                 ;;
  48                 esac
  49                 shift
  50         done
  51
  52         local port=$(port_find_free ${PORT_PATTERN_BATMAN_ADV})
  53         assert isset port
  54
  55         port_settings_write "${port}" ${HOOK_SETTINGS}
  56
  57         exit ${EXIT_OK}
  58 }
  59
  60 function hook_edit() {
  61         local port=${1}
  62         assert isset port
  63         shift
  64
  65         port_settings_read "${port}"
  66
  67         while [ $# -gt 0 ]; do
  68                 case "${1}" in
  69                         --address=*)
  70                                 ADDRESS="$(cli_get_val ${1})"
  71                                 ;;
  72                         --add-slave=*)
  73                                 SLAVES="${SLAVES} $(cli_get_val ${1})"
  74                                 ;;
  75                         --del-slave=*)
  76                                 local slave="$(cli_get_val ${1})"
  77
  78                                 local s slaves
  79                                 for s in ${SLAVES}; do
  80                                         [ "${slave}" = "${s}" ] && continue
  81                                         slaves="${slaves} ${s}"
  82                                 done
  83                                 SLAVES="${slaves}"
  84                                 ;;
  85                         *)
  86                                 warning "Unknown argument '${1}'"
  87                                 ;;
  88                 esac
  89                 shift
  90         done
  91
  92         port_settings_write "${port}" ${HOOK_SETTINGS}
  93
  94         exit ${EXIT_OK}
  95 }
  96
  97 function hook_create() {
  98         local port="${1}"
  99         assert isset port
 100
 101         port_settings_read "${port}" ${HOOK_SETTINGS}
 102
 103         # Create a new batman-adv device
 104         batman_adv_add "${port}" || exit ${?}
 105
 106         # Set the address.
 107         device_set_address "${port}" "${ADDRESS}"
 108
 109         exit ${EXIT_OK}
 110 }
 111
 112 function hook_remove() {
 113         local port="${1}"
 114         assert isset port
 115
 116         port_settings_read "${port}" ${HOOK_SETTINGS}
 117
 118         # Remove the batman-adv device
 119         batman_adv_delete "${port}"
 120
 121         exit ${EXIT_OK}
 122 }
 123
 124 function hook_hotplug() {
 125         local port="${1}"
 126         assert isset port
 127
 128         case "$(hotplug_action)" in
 129                 add)
 130                         # Handle events of the same interface
 131                         if hotplug_event_port_is_interface "${port}"; then
 132                                 # Bring up all slaves
 133                                 # They will be attached by their own hotplug event
 134                                 local slave
 135                                 for slave in $(port_get_slaves "${port}"); do
 136                                         port_create "${slave}"
 137                                 done
 138
 139                                 exit ${EXIT_OK}
 140
 141                         # Handle slave devices that have just been created and
 142                         # attach them.
 143                         elif hotplug_event_interface_is_slave_of_port "${port}"; then
 144                                 batman_adv_attach "${port}" "${INTERFACE}"
 145
 146                                 # If the batman-adv is already up, we will bring
 147                                 # up the slave we just added as well.
 148                                 if port_is_up "${port}"; then
 149                                         port_up "${INTERFACE}"
 150                                 fi
 151                         fi
 152
 153                         exit ${EXIT_OK}
 154                         ;;
 155
 156                 remove)
 157                         if hotplug_event_port_is_interface "${port}"; then
 158                                 # Bring down all slaves when the batman device went down
 159                                 local slave
 160                                 for slave in $(port_get_slaves "${port}"); do
 161                                         port_remove "${slave}"
 162                                 done
 163
 164                                 exit ${EXIT_OK}
 165                         fi
 166                         ;;
 167         esac
 168         exit ${EXIT_NOT_HANDLED}
 169 }
 170
 171 function hook_status() {
 172         local port=${1}
 173         assert isset port
 174
 175         cli_device_headline "${port}" --long
 176
 177         cli_headline 2 "B.A.T.M.A.N."
 178
 179         # Routing algorithm
 180         cli_print_fmt1 2 "Routing Algorithm" \
 181                 "$(batman_adv_get_routing_algorithm "${port}")"
 182
 183         # Space
 184         cli_space
 185
 186         # Originator interval
 187         cli_print_fmt1 2 "Originator Interval" \
 188                 "$(batman_adv_get_originator_interval "${port}") ms"
 189
 190         # Aggregated originator messages
 191         batman_adv_get_aggregated_ogms "${port}"
 192         cli_print_fmt1 2 "Aggregated Originator Messages" "$(cli_print_bool $?)"
 193
 194         # AP isolation
 195         batman_adv_get_ap_isolation "${port}"
 196         cli_print_fmt1 2 "Access Point Isolation" "$(cli_print_bool $?)"
 197
 198         # Bonding mode
 199         batman_adv_get_bonding_mode "${port}"
 200         cli_print_fmt1 2 "Bonding Mode" "$(cli_print_bool $?)"
 201
 202         # Bridge loop avoidance
 203         batman_adv_get_bridge_loop_avoidance "${port}"
 204         cli_print_fmt1 2 "Bridge Loop Avoidance" "$(cli_print_bool $?)"
 205
 206         # Distributed ARP table
 207         batman_adv_get_distributed_arp_table "${port}"
 208         cli_print_fmt1 2 "Distributed ARP Table" "$(cli_print_bool $?)"
 209
 210         # Fragmentation
 211         batman_adv_get_fragmentation "${port}"
 212         cli_print_fmt1 2 "Fragmentation" "$(cli_print_bool $?)"
 213
 214         # Hop penalty
 215         cli_print_fmt1 2 "Hop Penalty" \
 216                 "$(batman_adv_get_hop_penalty "${port}")"
 217         cli_space
 218
 219         # Gateway
 220         cli_headline 3 "Gateway"
 221
 222         # Gateway mode
 223         batman_adv_get_gateway_mode "${port}"
 224         local gw_enabled=$?
 225
 226         cli_print_fmt1 3 "Enabled" "$(cli_print_bool ${gw_enabled})"
 227
 228         if [ ${gw_enabled} -eq ${EXIT_TRUE} ]; then
 229                 cli_print_fmt1 3 "Bandwidth" \
 230                         "$(batman_adv_get_gateway_bandwidth "${port}")"
 231                 cli_print_fmt1 3 "Selection Class" \
 232                         "$(batman_adv_get_gateway_selection_class "${port}")"
 233         fi
 234
 235         cli_space
 236
 237         exit ${EXIT_OK}
 238 }