qos-scripts: Allow classification by the traffic's source interface
[openwrt/openwrt.git] / package / network / config / qos-scripts / files / usr / lib / qos / generate.sh
1 #!/bin/sh
2 [ -e /lib/functions.sh ] && . /lib/functions.sh || . ./functions.sh
3 [ -x /sbin/modprobe ] && {
4 insmod="modprobe"
5 rmmod="$insmod -r"
6 } || {
7 insmod="insmod"
8 rmmod="rmmod"
9 }
10
11 add_insmod() {
12 eval "export isset=\${insmod_$1}"
13 case "$isset" in
14 1) ;;
15 *) {
16 [ "$2" ] && append INSMOD "$rmmod $1 >&- 2>&-" "$N"
17 append INSMOD "$insmod $* >&- 2>&-" "$N"; export insmod_$1=1
18 };;
19 esac
20 }
21
22 [ -e /etc/config/network ] && {
23 # only try to parse network config on openwrt
24
25 find_ifname() {(
26 reset_cb
27 include /lib/network
28 scan_interfaces
29 config_get "$1" ifname
30 )}
31 } || {
32 find_ifname() {
33 echo "Interface not found."
34 exit 1
35 }
36 }
37
38 parse_matching_rule() {
39 local var="$1"
40 local section="$2"
41 local options="$3"
42 local prefix="$4"
43 local suffix="$5"
44 local proto="$6"
45 local mport=""
46 local ports=""
47
48 append "$var" "$prefix" "$N"
49 for option in $options; do
50 case "$option" in
51 proto) config_get value "$section" proto; proto="${proto:-$value}";;
52 esac
53 done
54 config_get type "$section" TYPE
55 case "$type" in
56 classify) unset pkt; append "$var" "-m mark --mark 0/0x0f";;
57 default) pkt=1; append "$var" "-m mark --mark 0/0xf0";;
58 reclassify) pkt=1;;
59 esac
60 append "$var" "${proto:+-p $proto}"
61 for option in $options; do
62 config_get value "$section" "$option"
63
64 case "$pkt:$option" in
65 *:srchost)
66 append "$var" "-s $value"
67 ;;
68 *:dsthost)
69 append "$var" "-d $value"
70 ;;
71 *:ports|*:srcports|*:dstports)
72 value="$(echo "$value" | sed -e 's,-,:,g')"
73 lproto=${lproto:-tcp}
74 case "$proto" in
75 ""|tcp|udp) append "$var" "-m ${proto:-tcp -p tcp} -m multiport";;
76 *) unset "$var"; return 0;;
77 esac
78 case "$option" in
79 ports)
80 config_set "$section" srcports ""
81 config_set "$section" dstports ""
82 config_set "$section" portrange ""
83 append "$var" "--ports $value"
84 ;;
85 srcports)
86 config_set "$section" ports ""
87 config_set "$section" dstports ""
88 config_set "$section" portrange ""
89 append "$var" "--sports $value"
90 ;;
91 dstports)
92 config_set "$section" ports ""
93 config_set "$section" srcports ""
94 config_set "$section" portrange ""
95 append "$var" "--dports $value"
96 ;;
97 esac
98 ports=1
99 ;;
100 *:portrange)
101 config_set "$section" ports ""
102 config_set "$section" srcports ""
103 config_set "$section" dstports ""
104 value="$(echo "$value" | sed -e 's,-,:,g')"
105 case "$proto" in
106 ""|tcp|udp) append "$var" "-m ${proto:-tcp -p tcp} --sport $value --dport $value";;
107 *) unset "$var"; return 0;;
108 esac
109 ports=1
110 ;;
111 *:connbytes)
112 value="$(echo "$value" | sed -e 's,-,:,g')"
113 add_insmod xt_connbytes
114 append "$var" "-m connbytes --connbytes $value --connbytes-dir both --connbytes-mode bytes"
115 ;;
116 *:comment)
117 add_insmod xt_comment
118 append "$var" "-m comment --comment '$value'"
119 ;;
120 *:tos)
121 add_insmod xt_dscp
122 case "$value" in
123 !*) append "$var" "-m tos ! --tos $value";;
124 *) append "$var" "-m tos --tos $value"
125 esac
126 ;;
127 *:dscp)
128 add_insmod xt_dscp
129 dscp_option="--dscp"
130 [ -z "${value%%[EBCA]*}" ] && dscp_option="--dscp-class"
131 case "$value" in
132 !*) append "$var" "-m dscp ! $dscp_option $value";;
133 *) append "$var" "-m dscp $dscp_option $value"
134 esac
135 ;;
136 *:direction)
137 value="$(echo "$value" | sed -e 's,-,:,g')"
138 if [ "$value" = "out" ]; then
139 append "$var" "-o $device"
140 elif [ "$value" = "in" ]; then
141 append "$var" "-i $device"
142 fi
143 ;;
144 *:srciface)
145 append "$var" "-i $value"
146 ;;
147 1:pktsize)
148 value="$(echo "$value" | sed -e 's,-,:,g')"
149 add_insmod xt_length
150 append "$var" "-m length --length $value"
151 ;;
152 1:limit)
153 add_insmod xt_limit
154 append "$var" "-m limit --limit $value"
155 ;;
156 1:tcpflags)
157 case "$proto" in
158 tcp) append "$var" "-m tcp --tcp-flags ALL $value";;
159 *) unset $var; return 0;;
160 esac
161 ;;
162 1:mark)
163 config_get class "${value##!}" classnr
164 [ -z "$class" ] && continue;
165 case "$value" in
166 !*) append "$var" "-m mark ! --mark $class/0x0f";;
167 *) append "$var" "-m mark --mark $class/0x0f";;
168 esac
169 ;;
170 1:TOS)
171 add_insmod xt_DSCP
172 config_get TOS "$rule" 'TOS'
173 suffix="-j TOS --set-tos "${TOS:-"Normal-Service"}
174 ;;
175 1:DSCP)
176 add_insmod xt_DSCP
177 config_get DSCP "$rule" 'DSCP'
178 [ -z "${DSCP%%[EBCA]*}" ] && set_value="--set-dscp-class $DSCP" \
179 || set_value="--set-dscp $DSCP"
180 suffix="-j DSCP $set_value"
181 ;;
182 esac
183 done
184 append "$var" "$suffix"
185 case "$ports:$proto" in
186 1:) parse_matching_rule "$var" "$section" "$options" "$prefix" "$suffix" "udp";;
187 esac
188 }
189
190 config_cb() {
191 option_cb() {
192 return 0
193 }
194
195 # Section start
196 case "$1" in
197 interface)
198 config_set "$2" "classgroup" "Default"
199 config_set "$2" "upload" "128"
200 ;;
201 classify|default|reclassify)
202 option_cb() {
203 append options "$1"
204 }
205 ;;
206 esac
207
208 # Section end
209 config_get TYPE "$CONFIG_SECTION" TYPE
210 case "$TYPE" in
211 interface)
212 config_get_bool enabled "$CONFIG_SECTION" enabled 1
213 [ 1 -eq "$enabled" ] || return 0
214 config_get classgroup "$CONFIG_SECTION" classgroup
215 config_set "$CONFIG_SECTION" ifbdev "$C"
216 C=$(($C+1))
217 append INTERFACES "$CONFIG_SECTION"
218 config_set "$classgroup" enabled 1
219 config_get device "$CONFIG_SECTION" device
220 [ -z "$device" ] && {
221 device="$(find_ifname ${CONFIG_SECTION})"
222 config_set "$CONFIG_SECTION" device "$device"
223 }
224 ;;
225 classgroup) append CG "$CONFIG_SECTION";;
226 classify|default|reclassify)
227 case "$TYPE" in
228 classify) var="ctrules";;
229 *) var="rules";;
230 esac
231 config_get target "$CONFIG_SECTION" target
232 config_set "$CONFIG_SECTION" options "$options"
233 append "$var" "$CONFIG_SECTION"
234 unset options
235 ;;
236 esac
237 }
238
239
240 enum_classes() {
241 local c="0"
242 config_get classes "$1" classes
243 config_get default "$1" default
244 for class in $classes; do
245 c="$(($c + 1))"
246 config_set "${class}" classnr $c
247 case "$class" in
248 $default) class_default=$c;;
249 esac
250 done
251 class_default="${class_default:-$c}"
252 }
253
254 cls_var() {
255 local varname="$1"
256 local class="$2"
257 local name="$3"
258 local type="$4"
259 local default="$5"
260 local tmp tmp1 tmp2
261 config_get tmp1 "$class" "$name"
262 config_get tmp2 "${class}_${type}" "$name"
263 tmp="${tmp2:-$tmp1}"
264 tmp="${tmp:-$tmp2}"
265 export ${varname}="${tmp:-$default}"
266 }
267
268 tcrules() {
269 _dir=/usr/lib/qos
270 [ -e $_dir/tcrules.awk ] || _dir=.
271 echo "$cstr" | awk \
272 -v device="$dev" \
273 -v linespeed="$rate" \
274 -v direction="$dir" \
275 -f $_dir/tcrules.awk
276 }
277
278 start_interface() {
279 local iface="$1"
280 local num_ifb="$2"
281 config_get device "$iface" device
282 config_get_bool enabled "$iface" enabled 1
283 [ -z "$device" -o 1 -ne "$enabled" ] && {
284 return 1
285 }
286 config_get upload "$iface" upload
287 config_get_bool halfduplex "$iface" halfduplex
288 config_get download "$iface" download
289 config_get classgroup "$iface" classgroup
290 config_get_bool overhead "$iface" overhead 0
291
292 download="${download:-${halfduplex:+$upload}}"
293 enum_classes "$classgroup"
294 for dir in ${halfduplex:-up} ${download:+down}; do
295 case "$dir" in
296 up)
297 [ "$overhead" = 1 ] && upload=$(($upload * 98 / 100 - (15 * 128 / $upload)))
298 dev="$device"
299 rate="$upload"
300 dl_mode=""
301 prefix="cls"
302 ;;
303 down)
304 [ "$(ls -d /proc/sys/net/ipv4/conf/ifb* 2>&- | wc -l)" -ne "$num_ifb" ] && add_insmod ifb numifbs="$num_ifb"
305 config_get ifbdev "$iface" ifbdev
306 [ "$overhead" = 1 ] && download=$(($download * 98 / 100 - (80 * 1024 / $download)))
307 dev="ifb$ifbdev"
308 rate="$download"
309 dl_mode=1
310 prefix="d_cls"
311 ;;
312 *) continue;;
313 esac
314 cstr=
315 for class in $classes; do
316 cls_var pktsize "$class" packetsize $dir 1500
317 cls_var pktdelay "$class" packetdelay $dir 0
318 cls_var maxrate "$class" limitrate $dir 100
319 cls_var prio "$class" priority $dir 1
320 cls_var avgrate "$class" avgrate $dir 0
321 cls_var qdisc "$class" qdisc $dir ""
322 cls_var filter "$class" filter $dir ""
323 config_get classnr "$class" classnr
324 append cstr "$classnr:$prio:$avgrate:$pktsize:$pktdelay:$maxrate:$qdisc:$filter" "$N"
325 done
326 append ${prefix}q "$(tcrules)" "$N"
327 export dev_${dir}="ifconfig $dev up >&- 2>&-
328 tc qdisc del dev $dev root >&- 2>&-
329 tc qdisc add dev $dev root handle 1: hfsc default ${class_default}0
330 tc class add dev $dev parent 1: classid 1:1 hfsc sc rate ${rate}kbit ul rate ${rate}kbit"
331 done
332 [ -n "$download" ] && {
333 add_insmod cls_u32
334 add_insmod em_u32
335 add_insmod act_connmark
336 add_insmod act_mirred
337 add_insmod sch_ingress
338 }
339 if [ -n "$halfduplex" ]; then
340 export dev_up="tc qdisc del dev $device root >&- 2>&-
341 tc qdisc add dev $device root handle 1: hfsc
342 tc filter add dev $device parent 1: protocol ip prio 10 u32 match u32 0 0 flowid 1:1 action mirred egress redirect dev ifb$ifbdev"
343 elif [ -n "$download" ]; then
344 append dev_${dir} "tc qdisc del dev $device ingress >&- 2>&-
345 tc qdisc add dev $device ingress
346 tc filter add dev $device parent ffff: protocol ip prio 1 u32 match u32 0 0 flowid 1:1 action connmark action mirred egress redirect dev ifb$ifbdev" "$N"
347 fi
348 add_insmod cls_fw
349 add_insmod sch_hfsc
350 add_insmod sch_fq_codel
351
352 cat <<EOF
353 ${INSMOD:+$INSMOD$N}${dev_up:+$dev_up
354 $clsq
355 }${ifbdev:+$dev_down
356 $d_clsq
357 $d_clsl
358 $d_clsf
359 }
360 EOF
361 unset INSMOD clsq clsf clsl d_clsq d_clsl d_clsf dev_up dev_down
362 }
363
364 start_interfaces() {
365 local C="$1"
366 for iface in $INTERFACES; do
367 start_interface "$iface" "$C"
368 done
369 }
370
371 add_rules() {
372 local var="$1"
373 local rules="$2"
374 local prefix="$3"
375
376 for rule in $rules; do
377 unset iptrule
378 config_get target "$rule" target
379 config_get target "$target" classnr
380 config_get options "$rule" options
381
382 ## If we want to override the TOS field, let's clear the DSCP field first.
383 [ ! -z "$(echo $options | grep 'TOS')" ] && {
384 s_options=${options%%TOS}
385 add_insmod xt_DSCP
386 parse_matching_rule iptrule "$rule" "$s_options" "$prefix" "-j DSCP --set-dscp 0"
387 append "$var" "$iptrule" "$N"
388 unset iptrule
389 }
390
391 target=$(($target | ($target << 4)))
392 parse_matching_rule iptrule "$rule" "$options" "$prefix" "-j MARK --set-mark $target/0xff"
393 append "$var" "$iptrule" "$N"
394 done
395 }
396
397 start_cg() {
398 local cg="$1"
399 local iptrules
400 local pktrules
401 local sizerules
402 enum_classes "$cg"
403 add_rules iptrules "$ctrules" "iptables -t mangle -A qos_${cg}_ct"
404 config_get classes "$cg" classes
405 for class in $classes; do
406 config_get mark "$class" classnr
407 config_get maxsize "$class" maxsize
408 [ -z "$maxsize" -o -z "$mark" ] || {
409 add_insmod xt_length
410 append pktrules "iptables -t mangle -A qos_${cg} -m mark --mark $mark/0x0f -m length --length $maxsize: -j MARK --set-mark 0/0xff" "$N"
411 }
412 done
413 add_rules pktrules "$rules" "iptables -t mangle -A qos_${cg}"
414 for iface in $INTERFACES; do
415 config_get classgroup "$iface" classgroup
416 config_get device "$iface" device
417 config_get ifbdev "$iface" ifbdev
418 config_get upload "$iface" upload
419 config_get download "$iface" download
420 config_get halfduplex "$iface" halfduplex
421 download="${download:-${halfduplex:+$upload}}"
422 append up "iptables -t mangle -A OUTPUT -o $device -j qos_${cg}" "$N"
423 append up "iptables -t mangle -A FORWARD -o $device -j qos_${cg}" "$N"
424 done
425 cat <<EOF
426 $INSMOD
427 iptables -t mangle -N qos_${cg} >&- 2>&-
428 iptables -t mangle -N qos_${cg}_ct >&- 2>&-
429 ${iptrules:+${iptrules}${N}iptables -t mangle -A qos_${cg}_ct -j CONNMARK --save-mark --mask 0xff}
430 iptables -t mangle -A qos_${cg} -j CONNMARK --restore-mark --mask 0x0f
431 iptables -t mangle -A qos_${cg} -m mark --mark 0/0x0f -j qos_${cg}_ct
432 $pktrules
433 ${iptrules:+${iptrules}${N}iptables -t mangle -A qos_${cg} -j CONNMARK --save-mark --mask 0xff}
434 $up$N${down:+${down}$N}
435 EOF
436 unset INSMOD
437 }
438
439 start_firewall() {
440 add_insmod xt_multiport
441 add_insmod xt_CONNMARK
442 stop_firewall
443 for group in $CG; do
444 start_cg $group
445 done
446 }
447
448 stop_firewall() {
449 # Builds up a list of iptables commands to flush the qos_* chains,
450 # remove rules referring to them, then delete them
451
452 # Print rules in the mangle table, like iptables-save
453 iptables -t mangle -S |
454 # Find rules for the qos_* chains
455 grep '^-N qos_\|-j qos_' |
456 # Exclude rules in qos_* chains (inter-qos_* refs)
457 grep -v '^-A qos_' |
458 # Replace -N with -X and hold, with -F and print
459 # Replace -A with -D
460 # Print held lines at the end (note leading newline)
461 sed -e '/^-N/{s/^-N/-X/;H;s/^-X/-F/}' \
462 -e 's/^-A/-D/' \
463 -e '${p;g}' |
464 # Make into proper iptables calls
465 # Note: awkward in previous call due to hold space usage
466 sed -n -e 's/^./iptables -t mangle &/p'
467 }
468
469 C="0"
470 INTERFACES=""
471 [ -e ./qos.conf ] && {
472 . ./qos.conf
473 config_cb
474 } || config_load qos
475
476 C="0"
477 for iface in $INTERFACES; do
478 export C="$(($C + 1))"
479 done
480
481 case "$1" in
482 all)
483 start_interfaces "$C"
484 start_firewall
485 ;;
486 interface)
487 start_interface "$2" "$C"
488 ;;
489 interfaces)
490 start_interfaces
491 ;;
492 firewall)
493 case "$2" in
494 stop)
495 stop_firewall
496 ;;
497 start|"")
498 start_firewall
499 ;;
500 esac
501 ;;
502 esac