net/mwan3/files/usr/sbin/mwan3track

   1 #!/bin/sh
   2
   3 . /lib/functions.sh
   4 . /lib/mwan3/common.sh
   5
   6 LOG="logger -t $(basename "$0")[$$] -p"
   7 INTERFACE=""
   8 DEVICE=""
   9
  10 IFDOWN_EVENT=0
  11
  12 clean_up() {
  13         $LOG notice "Stopping mwan3track for interface \"${INTERFACE}\""
  14         exit 0
  15 }
  16
  17 if_down() {
  18         $LOG info "Detect ifdown event on interface ${INTERFACE} (${DEVICE})"
  19         IFDOWN_EVENT=1
  20 }
  21
  22 validate_track_method() {
  23         case "$1" in
  24                 ping)
  25                         which ping 1>/dev/null 2>&1 || {
  26                                 $LOG warn "Missing ping. Please install iputils-ping package or enable ping util and recompile busybox."
  27                                 return 1
  28                         }
  29                         ;;
  30                 arping)
  31                         which arping 1>/dev/null 2>&1 || {
  32                                 $LOG warn "Missing arping. Please install iputils-arping package."
  33                                 return 1
  34                         }
  35                         ;;
  36                 httping)
  37                         which httping 1>/dev/null 2>&1 || {
  38                                 $LOG warn "Missing httping. Please install httping package."
  39                                 return 1
  40                         }
  41                         [ -n "$2" -a "$2" != "0.0.0.0" -a "$2" != "::" ] || {
  42                                 $LOG warn "Cannot determine source IP for the interface which is required by httping."
  43                                 return 1
  44                         }
  45                         ;;
  46                 nping-*)
  47                         which nping 1>/dev/null 2>&1 || {
  48                                 $LOG warn "Missing nping. Please install nping package."
  49                                 return 1
  50                         }
  51                         ;;
  52                 *)
  53                         $LOG warn "Unsupported tracking method: $track_method"
  54                         return 2
  55                         ;;
  56         esac
  57 }
  58
  59 main() {
  60         local reliability count timeout interval failure_interval
  61         local recovery_interval down up size
  62         local keep_failure_interval check_quality failure_latency
  63         local recovery_latency failure_loss recovery_loss
  64         local max_ttl httping_ssl
  65
  66         [ -z "$5" ] && echo "Error: should not be started manually" && exit 0
  67
  68         INTERFACE=$1
  69         DEVICE=$2
  70         STATUS=$3
  71         SRC_IP=$4
  72         mkdir -p /var/run/mwan3track/$1
  73         trap clean_up TERM
  74         trap if_down USR1
  75
  76         config_load mwan3
  77         config_get track_method $1 track_method ping
  78         config_get_bool httping_ssl $1 httping_ssl 0
  79         validate_track_method $track_method $SRC_IP || {
  80                 track_method=ping
  81                 if validate_track_method $track_method; then
  82                         $LOG warn "Using ping to track interface $INTERFACE avaliability"
  83                 else
  84                         $LOG err "No track method avaliable"
  85                         exit 1
  86                 fi
  87         }
  88         config_get reliability $1 reliability 1
  89         config_get count $1 count 1
  90         config_get timeout $1 timeout 4
  91         config_get interval $1 interval 10
  92         config_get down $1 down 5
  93         config_get up $1 up 5
  94         config_get size $1 size 56
  95         config_get max_ttl $1 max_ttl 60
  96         config_get failure_interval $1 failure_interval $interval
  97         config_get_bool keep_failure_interval $1 keep_failure_interval 0
  98         config_get recovery_interval $1 recovery_interval $interval
  99         config_get_bool check_quality $1 check_quality 0
 100         config_get failure_latency $1 failure_latency 1000
 101         config_get recovery_latency $1 recovery_latency 500
 102         config_get failure_loss $1 failure_loss 40
 103         config_get recovery_loss $1 recovery_loss 10
 104
 105         local score=$(($down+$up))
 106         local track_ips=$(echo $* | cut -d ' ' -f 5-99)
 107         local host_up_count=0
 108         local lost=0
 109         local sleep_time=0
 110         local turn=0
 111         local result
 112         local ping_result
 113         local loss=0
 114         local latency=0
 115
 116         if [ "$STATUS" = "offline" ]; then
 117                 echo "offline" > /var/run/mwan3track/$1/STATUS
 118                 echo "0" > /var/run/mwan3track/$1/ONLINE
 119                 echo "$(get_uptime)" > /var/run/mwan3track/$1/OFFLINE
 120                 score=0
 121         else
 122                 echo "online" > /var/run/mwan3track/$1/STATUS
 123                 echo "0" > /var/run/mwan3track/$1/OFFLINE
 124                 echo "$(get_uptime)" > /var/run/mwan3track/$1/ONLINE
 125                 env -i ACTION="connected" INTERFACE="$1" DEVICE="$2" /sbin/hotplug-call iface
 126         fi
 127         while true; do
 128
 129                 sleep_time=$interval
 130
 131                 for track_ip in $track_ips; do
 132                         if [ $host_up_count -lt $reliability ]; then
 133                                 case "$track_method" in
 134                                         ping)
 135                                                 # pinging IPv6 hosts with an interface is troublesome
 136                                                 # https://bugs.openwrt.org/index.php?do=details&task_id=2897
 137                                                 # so get the IP address of the interface and use that instead
 138                                                 if echo $track_ip | grep -q ':'; then
 139                                                         ADDR=$(ip -6 addr ls dev "$DEVICE" | sed -ne '/\/128/d' -e 's/ *inet6 \([^ \/]*\).* scope global.*/\1/p')
 140                                                 fi
 141                                                 if [ $check_quality -eq 0 ]; then
 142                                                         ping -I ${ADDR:-$DEVICE} -c $count -W $timeout -s $size -t $max_ttl -q $track_ip &> /dev/null
 143                                                         result=$?
 144                                                 else
 145                                                         ping_result="$(ping -I ${ADDR:-$DEVICE} -c $count -W $timeout -s $size -t $max_ttl -q $track_ip | tail -2)"
 146                                                         loss="$(echo "$ping_result" | grep "packet loss" |  cut -d "," -f3 | awk '{print $1}' | sed -e 's/%//')"
 147                                                         if [ "$loss" -eq 100 ]; then
 148                                                                 latency=999999
 149                                                         else
 150                                                                 latency="$(echo "$ping_result" | grep -E 'rtt|round-trip' | cut -d "=" -f2 | cut -d "/" -f2 | cut -d "." -f1)"
 151                                                         fi
 152                                                 fi
 153                                         ;;
 154                                         arping)
 155                                                 arping -I $DEVICE -c $count -w $timeout -q $track_ip &> /dev/null
 156                                                 result=$?
 157                                         ;;
 158                                         httping)
 159                                                 if [ "$httping_ssl" -eq 1 ]; then
 160                                                         httping -y $SRC_IP -c $count -t $timeout -q "https://$track_ip" &> /dev/null
 161                                                 else
 162                                                         httping -y $SRC_IP -c $count -t $timeout -q "http://$track_ip" &> /dev/null
 163                                                 fi
 164                                                 result=$?
 165                                         ;;
 166                                         nping-tcp)
 167                                                 result=$(nping -e $DEVICE -c $count $track_ip --tcp | grep Lost | awk '{print $12}')
 168                                         ;;
 169                                         nping-udp)
 170                                                 result=$(nping -e $DEVICE -c $count $track_ip --udp | grep Lost | awk '{print $12}')
 171                                         ;;
 172                                         nping-icmp)
 173                                                 result=$(nping -e $DEVICE -c $count $track_ip --icmp | grep Lost | awk '{print $12}')
 174                                         ;;
 175                                         nping-arp)
 176                                                 result=$(nping -e $DEVICE -c $count $track_ip --arp | grep Lost | awk '{print $12}')
 177                                         ;;
 178                                 esac
 179                                 if [ $check_quality -eq 0 ]; then
 180                                         if [ $result -eq 0 ]; then
 181                                                 let host_up_count++
 182                                                 echo "up" > /var/run/mwan3track/$1/TRACK_${track_ip}
 183                                                 if [ $score -le $up ]; then
 184                                                         $LOG info "Check ($track_method) success for target \"$track_ip\" on interface $1 ($2)"
 185                                                 fi
 186                                         else
 187                                                 let lost++
 188                                                 echo "down" > /var/run/mwan3track/$1/TRACK_${track_ip}
 189                                                 if [ $score -gt $up ]; then
 190                                                         $LOG info "Check ($track_method) failed for target \"$track_ip\" on interface $1 ($2)"
 191                                                 fi
 192                                         fi
 193                                 else
 194                                         if [ "$loss" -ge "$failure_loss" -o "$latency" -ge "$failure_latency" ]; then
 195                                                 let lost++
 196                                                 echo "down" > /var/run/mwan3track/$1/TRACK_${track_ip}
 197                                                 echo "$latency" > /var/run/mwan3track/$1/LATENCY_${track_ip}
 198                                                 echo "$loss" > /var/run/mwan3track/$1/LOSS_${track_ip}
 199
 200                                                 if [ $score -gt $up ]; then
 201                                                         $LOG info "Check (${track_method}: latency=${latency}ms loss=${loss}%) failed for target \"$track_ip\" on interface $1 ($2)"
 202                                                 fi
 203                                         elif [ "$loss" -le "$recovery_loss" -a "$latency" -le "$recovery_latency" ]; then
 204                                                 let host_up_count++
 205                                                 echo "up" > /var/run/mwan3track/$1/TRACK_${track_ip}
 206                                                 echo "$latency" > /var/run/mwan3track/$1/LATENCY_${track_ip}
 207                                                 echo "$loss" > /var/run/mwan3track/$1/LOSS_${track_ip}
 208
 209                                                 if [ $score -le $up ]; then
 210                                                         $LOG info "Check (${track_method}: latency=${latency}ms loss=${loss}%) success for target \"$track_ip\" on interface $1 ($2)"
 211                                                 fi
 212                                         else
 213                                                 echo "skipped" > /var/run/mwan3track/$1/TRACK_${track_ip}
 214                                         fi
 215                                 fi
 216                         else
 217                                 echo "skipped" > /var/run/mwan3track/$1/TRACK_${track_ip}
 218                         fi
 219                 done
 220
 221                 if [ $host_up_count -lt $reliability ]; then
 222                         let score--
 223
 224                         if [ $score -lt $up ]; then
 225                                 score=0
 226                                 [ ${keep_failure_interval} -eq 1 ] && {
 227                                         sleep_time=$failure_interval
 228                                 }
 229                         else
 230                                 sleep_time=$failure_interval
 231                         fi
 232
 233                         if [ $score -eq $up ]; then
 234                                 echo "offline" > /var/run/mwan3track/$1/STATUS
 235                                 env -i ACTION=ifdown INTERFACE=$1 DEVICE=$2 /sbin/hotplug-call iface
 236                                 score=0
 237                         fi
 238                 else
 239                         if [ $score -lt $(($down+$up)) ] && [ $lost -gt 0 ]; then
 240                                 $LOG info "Lost $(($lost*$count)) ping(s) on interface $1 ($2)"
 241                         fi
 242
 243                         let score++
 244                         lost=0
 245
 246                         if [ $score -gt $up ]; then
 247                                 echo "online" > /var/run/mwan3track/$1/STATUS
 248                                 score=$(($down+$up))
 249                         elif [ $score -le $up ]; then
 250                                 sleep_time=$recovery_interval
 251                         fi
 252
 253                         if [ $score -eq $up ]; then
 254                                 $LOG notice "Interface $1 ($2) is online"
 255                                 echo "online" > /var/run/mwan3track/$1/STATUS
 256                                 env -i ACTION=ifup INTERFACE=$1 DEVICE=$2 /sbin/hotplug-call iface
 257                                 exit 0
 258                         fi
 259                 fi
 260
 261                 let turn++
 262                 mkdir -p "/var/run/mwan3track/${1}"
 263                 echo "${lost}" > /var/run/mwan3track/$1/LOST
 264                 echo "${score}" > /var/run/mwan3track/$1/SCORE
 265                 echo "${turn}" > /var/run/mwan3track/$1/TURN
 266                 echo "$(get_uptime)" > /var/run/mwan3track/$1/TIME
 267
 268                 host_up_count=0
 269                 sleep "${sleep_time}" &
 270                 wait
 271
 272                 if [ "${IFDOWN_EVENT}" -eq 1 ]; then
 273                         echo "offline" > /var/run/mwan3track/$1/STATUS
 274                         echo "$(get_uptime)" > /var/run/mwan3track/$1/OFFLINE
 275                         echo "0" > /var/run/mwan3track/$1/ONLINE
 276                         $LOG notice "Interface $1 ($2) is offline"
 277                         env -i ACTION="disconnected" INTERFACE="$1" DEVICE="$2" /sbin/hotplug-call iface
 278                         score=0
 279                         IFDOWN_EVENT=0
 280                 fi
 281         done
 282 }
 283
 284 main "$@"