]> git.ipfire.org Git - people/arne_f/network.git/blame - functions.device
network: STP: Make protocol version configureable.
[people/arne_f/network.git] / functions.device
CommitLineData
1848564d
MT
1#!/bin/bash
2###############################################################################
3# #
4# IPFire.org - A linux based firewall #
5# Copyright (C) 2010 Michael Tremer & Christian Schmidt #
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
1b7a1578 22function devicify() {
1848564d
MT
23 local device=${1}
24
711ffac1
MT
25 assert isset device
26
1848564d
MT
27 if device_exists ${device}; then
28 echo "${device}"
29 return ${EXIT_OK}
30 fi
31
32 local d
33 for d in $(devices_get_all); do
34 if [ "$(device_get_address ${d})" = "${device}" ]; then
35 echo "${d}"
36 return ${EXIT_OK}
37 fi
38 done
39
40 return ${EXIT_ERROR}
41}
42
43function macify() {
44 local device=${1}
45
711ffac1
MT
46 assert isset device
47
1848564d
MT
48 if mac_is_valid ${device}; then
49 echo "${device}"
50 return ${EXIT_OK}
51 fi
52
53 if device_exists ${device}; then
54 device_get_address ${device}
55 return ${EXIT_OK}
56 fi
57
58 return ${EXIT_ERROR}
59}
60
61# Check if the device exists
62function device_exists() {
63 local device=${1}
64
65 # If device name was not found, exit.
66 [ -n "${device}" ] || return ${EXIT_ERROR}
67
68 [ -d "${SYS_CLASS_NET}/${device}" ]
69}
70
71# Check if the device is up
72function device_is_up() {
73 local device=${1}
74
75 device_exists ${device} || return ${EXIT_ERROR}
76
77 ip link show ${device} 2>/dev/null | grep -qE "<.*UP.*>"
78}
79
80# Check if the device is a bonding device
81function device_is_bonding() {
82 [ -d "/sys/class/net/${1}/bonding" ]
83}
84
85# Check if the device bonded in a bonding device
86function device_is_bonded() {
711ffac1 87 local device=${1}
1848564d 88
711ffac1 89 [ -d "${SYS_CLASS_NET}/${device}/master" ]
1848564d
MT
90}
91
92# Check if the device is a bridge
93function device_is_bridge() {
94 [ -d "/sys/class/net/${1}/bridge" ]
95}
96
81ed640c
MT
97function device_is_bridge_attached() {
98 local device=${1}
99
100 [ -d "${SYS_CLASS_NET}/${device}/brport" ]
101}
102
1848564d
MT
103# Check if the device is a virtual device
104function device_is_virtual() {
105 local device=${1}
106
107 [ -e "/proc/net/vlan/${device}" ]
108}
109
110# Check if the device has virtual devices
111function device_has_virtuals() {
fb02e543
MT
112 local device=${1}
113
114 if device_is_virtual ${device}; then
115 return 1
116 fi
117
1848564d
MT
118 if [ ! -e "/proc/net/vlan/config" ]; then
119 return 1
120 fi
121 grep -q "${1}$" /proc/net/vlan/config
122}
123
1848564d
MT
124# Check if the device is a ppp device
125function device_is_ppp() {
126 local device=${1}
127
128 ip link show ${device} 2>/dev/null | grep -qE "<.*POINTOPOINT.*>"
129}
130
131# Check if the device is a loopback device
132function device_is_loopback() {
133 local device=$(devicify ${1})
134 [ "${device}" = "lo" ]
135}
136
137# Check if the device is a physical network interface
138function device_is_real() {
139 local device=${1}
140
141 device_is_loopback ${device} && \
142 return ${EXIT_ERROR}
143
144 device_is_bonding ${device} && \
145 return ${EXIT_ERROR}
146
147 device_is_bridge ${device} && \
148 return ${EXIT_ERROR}
149
150 device_is_ppp ${device} && \
151 return ${EXIT_ERROR}
152
153 device_is_virtual ${device} && \
154 return ${EXIT_ERROR}
155
156 return ${EXIT_OK}
157}
158
159# Get the device type
160function device_get_type() {
161 local device=$(devicify ${1})
162
8c6a8966 163 if device_is_virtual ${device}; then
1848564d
MT
164 echo "vlan"
165
166 elif device_is_bonding ${device}; then
167 echo "bonding"
168
169 elif device_is_bridge ${device}; then
170 echo "bridge"
171
172 elif device_is_ppp ${device}; then
173 echo "ppp"
174
175 elif device_is_loopback ${device}; then
176 echo "loopback"
177
178 elif device_is_real ${device}; then
179 echo "real"
180
181 else
182 echo "unknown"
183 fi
184}
185
711ffac1
MT
186function device_get_status() {
187 local device=${1}
188
189 assert isset device
190
191 local status=${STATUS_UNKNOWN}
192
193 if ! device_has_carrier ${device}; then
194 status=${STATUS_NOCARRIER}
195 elif device_is_up ${device}; then
196 status=${STATUS_UP}
197 elif device_is_down ${device}; then
198 status=${STATUS_DOWN}
199 fi
200
201 assert isset status
202
203 echo "${status}"
204}
205
1848564d
MT
206function device_get_address() {
207 local device=${1}
208
209 cat ${SYS_CLASS_NET}/${device}/address 2>/dev/null
210}
211
212function device_set_address() {
1b7a1578
MT
213 local device=${1}
214 local addr=${2}
215
216 if ! device_exists ${device}; then
217 error "Device '${device}' does not exist."
218 return ${EXIT_ERROR}
219 fi
220
221 log INFO "Setting address of '${device}' to '${addr}' - was $(device_get_address ${device})."
222
223 local up
224 if device_is_up ${device}; then
225 device_set_down ${device}
226 up=1
227 fi
228
229 ip link set ${device} address ${addr}
230 local ret=$?
231
232 if [ "${up}" = "1" ]; then
233 device_set_up ${device}
234 fi
235
236 if [ "${ret}" != "0" ]; then
237 error_log "Could not set address '${addr}' on device '${device}'."
238 fi
239
240 return ${ret}
1848564d
MT
241}
242
711ffac1 243function device_get() {
2ae0fb8d 244 local device
711ffac1
MT
245 local devices
246
2ae0fb8d
MT
247 for device in ${SYS_CLASS_NET}/*; do
248 device=$(basename ${device})
711ffac1 249
2ae0fb8d
MT
250 # bonding_masters is no device
251 [ "${device}" = "bonding_masters" ] && continue
252
253 devices="${devices} ${device}"
254 done
711ffac1
MT
255
256 echo ${devices}
257 return ${EXIT_OK}
258}
259
1848564d 260function devices_get_all() {
711ffac1 261 device_get
1848564d
MT
262}
263
264# Check if a device has a cable plugged in
265function device_has_carrier() {
266 local device=$(devicify ${1})
267 [ "$(<${SYS_CLASS_NET}/${device}/carrier)" = "1" ]
268}
269
1e4c26a4
MT
270function device_is_promisc() {
271 local device=${1}
272
273 ip link show ${device} | grep -qE "<.*PROMISC.*>"
274}
275
1848564d
MT
276# Check if the device is free
277function device_is_free() {
81ed640c 278 ! device_is_used $@
1848564d
MT
279}
280
281# Check if the device is used
282function device_is_used() {
283 local device=$(devicify ${1})
284
fb02e543
MT
285 device_has_virtuals ${device} && \
286 return ${EXIT_OK}
1848564d 287 device_is_bonded ${device} && \
fb02e543 288 return ${EXIT_OK}
81ed640c
MT
289 device_is_bridge_attached ${device} && \
290 return ${EXIT_OK}
1848564d 291
fb02e543 292 return ${EXIT_ERROR}
1848564d
MT
293}
294
295# XXX to be removed I think
296function device_get_free() {
297 local destination=${1}
298
299 # Replace + by a valid number
300 if grep -q "+$" <<<${destination}; then
301 local number=0
302 destination=$(sed -e "s/+//" <<<$destination)
303 while [ "${number}" -le "100" ]; do
304 if ! device_exists "${destination}${number}"; then
305 destination="${destination}${number}"
306 break
307 fi
308 number=$(($number + 1))
309 done
310 fi
311 echo "${destination}"
312}
313
1b7a1578
MT
314function device_hash() {
315 local device=${1}
316
37e4ec8b
MT
317 # Get mac address of device and remove all colons (:)
318 # that will result in a hash.
319 device=$(macify ${device})
320
321 echo "${device//:/}"
1b7a1578
MT
322}
323
324# Give the device a new name
325function device_set_name() {
1848564d
MT
326 local source=$1
327 local destination=$(device_get_free ${2})
328
329 # Check if devices exists
330 if ! device_exists ${source} || device_exists ${destination}; then
331 return 4
332 fi
333
334 local up
335 if device_is_up ${source}; then
336 ip link set ${source} down
337 up=1
338 fi
339
340 ip link set ${source} name ${destination}
341
342 if [ "${up}" = "1" ]; then
343 ip link set ${destination} up
344 fi
345}
346
1848564d
MT
347# Set device up
348function device_set_up() {
349 local device=$(devicify ${1})
350
711ffac1
MT
351 # Silently fail if device was not found
352 [ -z "${device}" ] && return ${EXIT_ERROR}
353
1848564d
MT
354 # Do nothing if device is already up
355 device_is_up ${device} && return ${EXIT_OK}
356
81ed640c
MT
357 device_set_parent_up ${device}
358
359 log DEBUG "Setting up device '${device}'"
360
1848564d
MT
361 ip link set ${device} up
362}
363
81ed640c
MT
364function device_set_parent_up() {
365 local device=${1}
366 local parent
367
368 if device_is_virtual ${device}; then
8c6a8966 369 parent=$(virtual_get_parent ${device})
81ed640c
MT
370
371 device_is_up ${parent} && return ${EXIT_OK}
372
373 log DEBUG "Setting up parent device '${parent}' of '${device}'"
374
375 device_set_up ${parent}
376 return $?
377 fi
378
379 return ${EXIT_OK}
380}
381
1848564d
MT
382# Set device down
383function device_set_down() {
384 local device=$(devicify ${1})
385
81ed640c
MT
386 local ret=${EXIT_OK}
387
388 if device_is_up ${device}; then
389 log DEBUG "Tearing down device '${device}'"
390
391 ip link set ${device} down
392 ret=$?
393 fi
394
395 device_set_parent_down ${device}
1848564d 396
81ed640c
MT
397 return ${ret}
398}
399
400function device_set_parent_down() {
401 local device=${1}
402 local parent
403
404 if device_is_virtual ${device}; then
8c6a8966 405 parent=$(virtual_get_parent ${device})
81ed640c
MT
406
407 device_is_up ${parent} || return ${EXIT_OK}
408
409 if device_is_free ${parent}; then
410 log DEBUG "Tearing down parent device '${parent}' of '${device}'"
411
412 device_set_down ${parent}
413 fi
414 fi
415
416 return ${EXIT_OK}
1848564d
MT
417}
418
1848564d
MT
419function device_get_mtu() {
420 local device=${1}
421
422 if ! device_exists ${device}; then
423 error "Device '${device}' does not exist."
424 return ${EXIT_ERROR}
425 fi
426
f3e6fe50 427 echo $(<${SYS_CLASS_NET}/${device}/mtu)
1848564d
MT
428}
429
430# Set mtu to a device
431function device_set_mtu() {
1b7a1578 432 local device=${1}
1848564d
MT
433 local mtu=${2}
434
1b7a1578
MT
435 if ! device_exists ${device}; then
436 error "Device '${device}' does not exist."
437 return ${EXIT_ERROR}
438 fi
439
440 local oldmtu=$(device_get_mtu ${device})
441
442 if [ "${oldmtu}" = "${mtu}" ]; then
443 # No need to set mtu.
444 return ${EXIT_OK}
445 fi
446
447 log INFO "Setting mtu of '${device}' to '${mtu}' - was ${oldmtu}."
448
1848564d 449 local up
1b7a1578
MT
450 if device_is_up ${device}; then
451 device_set_down ${device}
1848564d
MT
452 up=1
453 fi
454
1b7a1578 455 ip link set ${device} mtu ${mtu}
1848564d
MT
456 local ret=$?
457
458 if [ "${up}" = "1" ]; then
1b7a1578
MT
459 device_set_up ${device}
460 fi
461
462 if [ "${ret}" != "0" ]; then
463 error_log "Could not set mtu '${mtu}' on device '${device}'."
1848564d
MT
464 fi
465
466 return ${ret}
467}
468
469function device_discover() {
470 local device=${1}
471
1b7a1578
MT
472 log INFO "Running discovery process on device '${device}'."
473
1848564d 474 local hook
d61a01d4
MT
475 for hook in $(hook_zone_get_all); do
476 hook_zone_exec ${hook} discover ${device}
1848564d
MT
477 done
478}
479
1848564d
MT
480function device_has_ipv4() {
481 local device=${1}
482 local addr=${2}
483
484 if ! device_exists ${device}; then
485 error "Device '${device}' does not exist."
486 return ${EXIT_ERROR}
487 fi
488
489 ip addr show ${device} | grep -q -e "inet " -e "${addr}"
490}
4231f419
MT
491
492function device_has_ipv6() {
493 local device=${1}
494 local addr=${2}
495
496 if ! device_exists ${device}; then
497 error "Device '${device}' does not exist."
498 return ${EXIT_ERROR}
499 fi
500
501 local prefix=${addr##*/}
502 addr=$(ipv6_implode ${addr%%/*})
503
504 if [ -n "${prefix}" ]; then
505 addr="${addr}/${prefix}"
506 fi
507
508 ip addr show ${device} | grep -q "inet6 ${addr}"
509}
711ffac1 510
711ffac1
MT
511function __device_get_file() {
512 local device=${1}
513 local file=${2}
514
515 assert isset device
516 assert isset file
517
518 cat ${SYS_CLASS_NET}/${device}/${file}
519}
520
521function device_get_rx_bytes() {
522 local device=${1}
523
524 __device_get_file ${device} statistics/rx_bytes
525}
526
527function device_get_tx_bytes() {
528 local device=${1}
529
530 __device_get_file ${device} statistics/tx_bytes
531}
532
533function device_get_rx_packets() {
534 local device=${1}
535
536 __device_get_file ${device} statistics/rx_packets
537}
538
539function device_get_tx_packets() {
540 local device=${1}
541
542 __device_get_file ${device} statistics/tx_packets
543}
544
545function device_get_rx_errors() {
546 local device=${1}
547
548 __device_get_file ${device} statistics/rx_errors
549}
550
551function device_get_tx_errors() {
552 local device=${1}
553
554 __device_get_file ${device} statistics/tx_errors
555}