base-files: add macaddr_{add,2bin,setbit_la} helpers
[openwrt/openwrt.git] / package / base-files / files / lib / functions.sh
1 #!/bin/sh
2 # Copyright (C) 2006-2011 OpenWrt.org
3 # Copyright (C) 2006 Fokus Fraunhofer <carsten.tittel@fokus.fraunhofer.de>
4
5
6 debug () {
7 ${DEBUG:-:} "$@"
8 }
9
10 # newline
11 N="
12 "
13
14 _C=0
15 NO_EXPORT=1
16 LOAD_STATE=1
17 LIST_SEP=" "
18
19 hotplug_dev() {
20 env -i ACTION=$1 INTERFACE=$2 /sbin/hotplug-call net
21 }
22
23 append() {
24 local var="$1"
25 local value="$2"
26 local sep="${3:- }"
27
28 eval "export ${NO_EXPORT:+-n} -- \"$var=\${$var:+\${$var}\${value:+\$sep}}\$value\""
29 }
30
31 list_contains() {
32 local var="$1"
33 local str="$2"
34 local val
35
36 eval "val=\" \${$var} \""
37 [ "${val%% $str *}" != "$val" ]
38 }
39
40 list_remove() {
41 local var="$1"
42 local remove="$2"
43 local val
44
45 eval "val=\" \${$var} \""
46 val1="${val%% $remove *}"
47 [ "$val1" = "$val" ] && return
48 val2="${val##* $remove }"
49 [ "$val2" = "$val" ] && return
50 val="${val1## } ${val2%% }"
51 val="${val%% }"
52 eval "export ${NO_EXPORT:+-n} -- \"$var=\$val\""
53 }
54
55 config_load() {
56 [ -n "$IPKG_INSTROOT" ] && return 0
57 uci_load "$@"
58 }
59
60 reset_cb() {
61 config_cb() { return 0; }
62 option_cb() { return 0; }
63 list_cb() { return 0; }
64 }
65 reset_cb
66
67 package() {
68 return 0
69 }
70
71 config () {
72 local cfgtype="$1"
73 local name="$2"
74
75 export ${NO_EXPORT:+-n} CONFIG_NUM_SECTIONS=$(($CONFIG_NUM_SECTIONS + 1))
76 name="${name:-cfg$CONFIG_NUM_SECTIONS}"
77 append CONFIG_SECTIONS "$name"
78 [ -n "$NO_CALLBACK" ] || config_cb "$cfgtype" "$name"
79 export ${NO_EXPORT:+-n} CONFIG_SECTION="$name"
80 export ${NO_EXPORT:+-n} "CONFIG_${CONFIG_SECTION}_TYPE=$cfgtype"
81 }
82
83 option () {
84 local varname="$1"; shift
85 local value="$*"
86
87 export ${NO_EXPORT:+-n} "CONFIG_${CONFIG_SECTION}_${varname}=$value"
88 [ -n "$NO_CALLBACK" ] || option_cb "$varname" "$*"
89 }
90
91 list() {
92 local varname="$1"; shift
93 local value="$*"
94 local len
95
96 config_get len "$CONFIG_SECTION" "${varname}_LENGTH" 0
97 [ $len = 0 ] && append CONFIG_LIST_STATE "${CONFIG_SECTION}_${varname}"
98 len=$(($len + 1))
99 config_set "$CONFIG_SECTION" "${varname}_ITEM$len" "$value"
100 config_set "$CONFIG_SECTION" "${varname}_LENGTH" "$len"
101 append "CONFIG_${CONFIG_SECTION}_${varname}" "$value" "$LIST_SEP"
102 list_cb "$varname" "$*"
103 }
104
105 config_rename() {
106 local OLD="$1"
107 local NEW="$2"
108 local oldvar
109 local newvar
110
111 [ -n "$OLD" -a -n "$NEW" ] || return
112 for oldvar in `set | grep ^CONFIG_${OLD}_ | \
113 sed -e 's/\(.*\)=.*$/\1/'` ; do
114 newvar="CONFIG_${NEW}_${oldvar##CONFIG_${OLD}_}"
115 eval "export ${NO_EXPORT:+-n} \"$newvar=\${$oldvar}\""
116 unset "$oldvar"
117 done
118 export ${NO_EXPORT:+-n} CONFIG_SECTIONS="$(echo " $CONFIG_SECTIONS " | sed -e "s, $OLD , $NEW ,")"
119
120 [ "$CONFIG_SECTION" = "$OLD" ] && export ${NO_EXPORT:+-n} CONFIG_SECTION="$NEW"
121 }
122
123 config_unset() {
124 config_set "$1" "$2" ""
125 }
126
127 config_clear() {
128 local SECTION="$1"
129 local oldvar
130
131 list_remove CONFIG_SECTIONS "$SECTION"
132 export ${NO_EXPORT:+-n} CONFIG_SECTIONS="${SECTION:+$CONFIG_SECTIONS}"
133
134 for oldvar in `set | grep ^CONFIG_${SECTION:+${SECTION}_} | \
135 sed -e 's/\(.*\)=.*$/\1/'` ; do
136 unset $oldvar
137 done
138 }
139
140 # config_get <variable> <section> <option> [<default>]
141 # config_get <section> <option>
142 config_get() {
143 case "$3" in
144 "") eval echo "\${CONFIG_${1}_${2}:-\${4}}";;
145 *) eval export ${NO_EXPORT:+-n} -- "${1}=\${CONFIG_${2}_${3}:-\${4}}";;
146 esac
147 }
148
149 # config_get_bool <variable> <section> <option> [<default>]
150 config_get_bool() {
151 local _tmp
152 config_get _tmp "$2" "$3" "$4"
153 case "$_tmp" in
154 1|on|true|enabled) _tmp=1;;
155 0|off|false|disabled) _tmp=0;;
156 *) _tmp="$4";;
157 esac
158 export ${NO_EXPORT:+-n} "$1=$_tmp"
159 }
160
161 config_set() {
162 local section="$1"
163 local option="$2"
164 local value="$3"
165 local old_section="$CONFIG_SECTION"
166
167 CONFIG_SECTION="$section"
168 option "$option" "$value"
169 CONFIG_SECTION="$old_section"
170 }
171
172 config_foreach() {
173 local ___function="$1"
174 [ "$#" -ge 1 ] && shift
175 local ___type="$1"
176 [ "$#" -ge 1 ] && shift
177 local section cfgtype
178
179 [ -z "$CONFIG_SECTIONS" ] && return 0
180 for section in ${CONFIG_SECTIONS}; do
181 config_get cfgtype "$section" TYPE
182 [ -n "$___type" -a "x$cfgtype" != "x$___type" ] && continue
183 eval "$___function \"\$section\" \"\$@\""
184 done
185 }
186
187 config_list_foreach() {
188 [ "$#" -ge 3 ] || return 0
189 local section="$1"; shift
190 local option="$1"; shift
191 local function="$1"; shift
192 local val
193 local len
194 local c=1
195
196 config_get len "${section}" "${option}_LENGTH"
197 [ -z "$len" ] && return 0
198 while [ $c -le "$len" ]; do
199 config_get val "${section}" "${option}_ITEM$c"
200 eval "$function \"\$val\" \"\$@\""
201 c="$(($c + 1))"
202 done
203 }
204
205 load_modules() {
206 [ -d /etc/modules.d ] && {
207 cd /etc/modules.d
208 sed 's/^[^#]/insmod &/' $* | ash 2>&- || :
209 }
210 }
211
212 include() {
213 local file
214
215 for file in $(ls $1/*.sh 2>/dev/null); do
216 . $file
217 done
218 }
219
220 find_mtd_index() {
221 local PART="$(grep "\"$1\"" /proc/mtd | awk -F: '{print $1}')"
222 local INDEX="${PART##mtd}"
223
224 echo ${INDEX}
225 }
226
227 find_mtd_part() {
228 local INDEX=$(find_mtd_index "$1")
229 local PREFIX=/dev/mtdblock
230
231 [ -d /dev/mtdblock ] && PREFIX=/dev/mtdblock/
232 echo "${INDEX:+$PREFIX$INDEX}"
233 }
234
235 find_mtd_chardev() {
236 local INDEX=$(find_mtd_index "$1")
237 local PREFIX=/dev/mtd
238
239 [ -d /dev/mtd ] && PREFIX=/dev/mtd/
240 echo "${INDEX:+$PREFIX$INDEX}"
241 }
242
243 mtd_get_mac_ascii()
244 {
245 local mtdname="$1"
246 local key="$2"
247 local part
248 local mac_dirty
249
250 . /lib/functions.sh
251
252 part=$(find_mtd_part "$mtdname")
253 if [ -z "$part" ]; then
254 echo "mtd_get_mac_ascii: partition $mtdname not found!" >&2
255 return
256 fi
257
258 mac_dirty=$(strings "$part" | sed -n 's/'"$key"'=//p')
259 # "canonicalize" mac
260 printf "%02x:%02x:%02x:%02x:%02x:%02x" 0x${mac_dirty//:/ 0x}
261 }
262
263 mtd_get_mac_binary() {
264 local mtdname="$1"
265 local offset="$2"
266 local part
267
268 part=$(find_mtd_part "$mtdname")
269 if [ -z "$part" ]; then
270 echo "mtd_get_mac_binary: partition $mtdname not found!" >&2
271 return
272 fi
273
274 dd bs=1 skip=$offset count=6 if=$part 2>/dev/null | hexdump -v -n 6 -e '5/1 "%02x:" 1/1 "%02x"'
275 }
276
277 macaddr_add() {
278 local mac=$1
279 local val=$2
280 local oui=${mac%:*:*:*}
281 local nic=${mac#*:*:*:}
282
283 nic=$(printf "%06x" $((0x${nic//:/} + $val & 0xffffff)) | sed 's/^\(.\{2\}\)\(.\{2\}\)\(.\{2\}\)/\1:\2:\3/')
284 echo $oui:$nic
285 }
286
287 macaddr_setbit_la()
288 {
289 local mac=$1
290
291 printf "%02x:%s" $((0x${mac%%:*} | 0x02)) ${mac#*:}
292 }
293
294 macaddr_2bin()
295 {
296 local mac=$1
297
298 echo -ne \\x${mac//:/\\x}
299 }
300
301 strtok() { # <string> { <variable> [<separator>] ... }
302 local tmp
303 local val="$1"
304 local count=0
305
306 shift
307
308 while [ $# -gt 1 ]; do
309 tmp="${val%%$2*}"
310
311 [ "$tmp" = "$val" ] && break
312
313 val="${val#$tmp$2}"
314
315 export ${NO_EXPORT:+-n} "$1=$tmp"; count=$((count+1))
316 shift 2
317 done
318
319 if [ $# -gt 0 -a -n "$val" ]; then
320 export ${NO_EXPORT:+-n} "$1=$val"; count=$((count+1))
321 fi
322
323 return $count
324 }
325
326
327 jffs2_mark_erase() {
328 local part="$(find_mtd_part "$1")"
329 [ -z "$part" ] && {
330 echo Partition not found.
331 return 1
332 }
333 echo -e "\xde\xad\xc0\xde" | mtd -qq write - "$1"
334 }
335
336 uci_apply_defaults() {
337 cd /etc/uci-defaults || return 0
338 files="$(ls)"
339 [ -z "$files" ] && return 0
340 mkdir -p /tmp/.uci
341 for file in $files; do
342 ( . "./$(basename $file)" ) && rm -f "$file"
343 done
344 uci commit
345 }
346
347 group_add() {
348 local name="$1"
349 local gid="$2"
350 local rc
351 [ -f "${IPKG_INSTROOT}/etc/group" ] || return 1
352 [ -n "$IPKG_INSTROOT" ] || lock /var/lock/group
353 echo "${name}:x:${gid}:" >> ${IPKG_INSTROOT}/etc/group
354 rc=$?
355 [ -n "$IPKG_INSTROOT" ] || lock -u /var/lock/group
356 return $rc
357 }
358
359 group_exists() {
360 grep -qs "^${1}:" ${IPKG_INSTROOT}/etc/group
361 }
362
363 user_add() {
364 local name="${1}"
365 local uid="${2}"
366 local gid="${3:-$2}"
367 local desc="${4:-$1}"
368 local home="${5:-/var/run/$1}"
369 local shell="${6:-/bin/false}"
370 local rc
371 [ -f "${IPKG_INSTROOT}/etc/passwd" ] || return 1
372 [ -n "$IPKG_INSTROOT" ] || lock /var/lock/passwd
373 echo "${name}:x:${uid}:${gid}:${desc}:${home}:${shell}" >> ${IPKG_INSTROOT}/etc/passwd
374 echo "${name}:x:0:0:99999:7:::" >> ${IPKG_INSTROOT}/etc/shadow
375 rc=$?
376 [ -n "$IPKG_INSTROOT" ] || lock -u /var/lock/passwd
377 return $rc
378 }
379
380 user_exists() {
381 grep -qs "^${1}:" ${IPKG_INSTROOT}/etc/passwd
382 }
383
384
385 pi_include() {
386 if [ -f "/tmp/overlay/$1" ]; then
387 . "/tmp/overlay/$1"
388 elif [ -f "$1" ]; then
389 . "$1"
390 elif [ -d "/tmp/overlay/$1" ]; then
391 if [ -n "$(ls /tmp/overlay/$1/*.sh 2>/dev/null)" ]; then
392 for src_script in /tmp/overlay/$1/*.sh; do
393 . "$src_script"
394 done
395 fi
396 elif [ -d "$1" ]; then
397 if [ -n "$(ls $1/*.sh 2>/dev/null)" ]; then
398 for src_script in $1/*.sh; do
399 . "$src_script"
400 done
401 fi
402 else
403 echo "WARNING: $1 not found"
404 return 1
405 fi
406 return 0
407 }
408
409 #!/bin/sh
410 # Copyright (C) 2006-2010 OpenWrt.org
411 # Copyright (C) 2010 Vertical Communications
412
413 boot_hook_splice_start() {
414 export -n PI_HOOK_SPLICE=1
415 }
416
417 boot_hook_splice_finish() {
418 local hook
419 for hook in $PI_STACK_LIST; do
420 local v; eval "v=\${${hook}_splice:+\$${hook}_splice }$hook"
421 export -n "${hook}=${v% }"
422 export -n "${hook}_splice="
423 done
424 export -n PI_HOOK_SPLICE=
425 }
426
427 boot_hook_init() {
428 local hook="${1}_hook"
429 export -n "PI_STACK_LIST=${PI_STACK_LIST:+$PI_STACK_LIST }$hook"
430 export -n "$hook="
431 }
432
433 boot_hook_add() {
434 local hook="${1}_hook${PI_HOOK_SPLICE:+_splice}"
435 local func="${2}"
436
437 [ -n "$func" ] && {
438 local v; eval "v=\$$hook"
439 export -n "$hook=${v:+$v }$func"
440 }
441 }
442
443 boot_hook_shift() {
444 local hook="${1}_hook"
445 local rvar="${2}"
446
447 local v; eval "v=\$$hook"
448 [ -n "$v" ] && {
449 local first="${v%% *}"
450
451 [ "$v" != "${v#* }" ] && \
452 export -n "$hook=${v#* }" || \
453 export -n "$hook="
454
455 export -n "$rvar=$first"
456 return 0
457 }
458
459 return 1
460 }
461
462 boot_run_hook() {
463 local hook="$1"
464 local func
465
466 while boot_hook_shift "$hook" func; do
467 local ran; eval "ran=\$PI_RAN_$func"
468 [ -n "$ran" ] || {
469 export -n "PI_RAN_$func=1"
470 $func "$1" "$2"
471 }
472 done
473 }
474
475 jffs2_ready () {
476 mtdpart="$(find_mtd_part rootfs_data)"
477 [ -z "$mtdpart" ] && return 1
478 magic=$(hexdump $mtdpart -n 4 -e '4/1 "%02x"')
479 [ "$magic" != "deadc0de" ]
480 }
481
482 dupe() { # <new_root> <old_root>
483 cd $1
484 echo -n "creating directories... "
485 {
486 cd $2
487 find . -xdev -type d
488 echo "./dev ./overlay ./mnt ./proc ./tmp"
489 # xdev skips mounted directories
490 cd $1
491 } | xargs mkdir -p
492 echo "done"
493
494 echo -n "setting up symlinks... "
495 for file in $(cd $2; find . -xdev -type f;); do
496 case "$file" in
497 ./rom/note) ;; #nothing
498 ./etc/config*|\
499 ./usr/lib/opkg/info/*) cp -af $2/$file $file;;
500 *) ln -sf /rom/${file#./*} $file;;
501 esac
502 done
503 for file in $(cd $2; find . -xdev -type l;); do
504 cp -af $2/${file#./*} $file
505 done
506 echo "done"
507 }
508
509 pivot() { # <new_root> <old_root>
510 mount -o noatime,move /proc $1/proc && \
511 pivot_root $1 $1$2 && {
512 mount -o noatime,move $2/dev /dev
513 mount -o noatime,move $2/tmp /tmp
514 mount -o noatime,move $2/sys /sys 2>&-
515 mount -o noatime,move $2/overlay /overlay 2>&-
516 return 0
517 }
518 }
519
520 fopivot() { # <rw_root> <ro_root> <dupe?>
521 root=$1
522 {
523 if grep -q overlay /proc/filesystems; then
524 mount -o noatime,lowerdir=/,upperdir=$1 -t overlayfs "overlayfs:$1" /mnt && root=/mnt
525 elif grep -q mini_fo /proc/filesystems; then
526 mount -t mini_fo -o noatime,base=/,sto=$1 "mini_fo:$1" /mnt 2>&- && root=/mnt
527 else
528 mount --bind -o noatime / /mnt
529 mount --bind -o noatime,union "$1" /mnt && root=/mnt
530 fi
531 } || {
532 [ "$3" = "1" ] && {
533 mount | grep "on $1 type" 2>&- 1>&- || mount -o noatime,bind $1 $1
534 dupe $1 $rom
535 }
536 }
537 pivot $root $2
538 }
539
540 ramoverlay() {
541 mkdir -p /tmp/root
542 mount -t tmpfs -o noatime,mode=0755 root /tmp/root
543 fopivot /tmp/root /rom 1
544 }
545
546 [ -z "$IPKG_INSTROOT" -a -f /lib/config/uci.sh ] && . /lib/config/uci.sh