base-files: allow users to delect debug level during boot
[openwrt.git] / package / base-files / files / lib / functions.sh
index 82e8932..6f23e0b 100755 (executable)
@@ -1,14 +1,12 @@
 #!/bin/sh
-# Copyright (C) 2006 OpenWrt.org
+# Copyright (C) 2006-2013 OpenWrt.org
 # Copyright (C) 2006 Fokus Fraunhofer <carsten.tittel@fokus.fraunhofer.de>
+# Copyright (C) 2010 Vertical Communications
 
 
 debug () {
        ${DEBUG:-:} "$@"
 }
-mount() {
-       busybox mount "$@"
-}
 
 # newline
 N="
@@ -27,7 +25,7 @@ append() {
        local var="$1"
        local value="$2"
        local sep="${3:- }"
-       
+
        eval "export ${NO_EXPORT:+-n} -- \"$var=\${$var:+\${$var}\${value:+\$sep}}\$value\""
 }
 
@@ -74,7 +72,7 @@ package() {
 config () {
        local cfgtype="$1"
        local name="$2"
-       
+
        export ${NO_EXPORT:+-n} CONFIG_NUM_SECTIONS=$(($CONFIG_NUM_SECTIONS + 1))
        name="${name:-cfg$CONFIG_NUM_SECTIONS}"
        append CONFIG_SECTIONS "$name"
@@ -110,7 +108,7 @@ config_rename() {
        local NEW="$2"
        local oldvar
        local newvar
-       
+
        [ -n "$OLD" -a -n "$NEW" ] || return
        for oldvar in `set | grep ^CONFIG_${OLD}_ | \
                sed -e 's/\(.*\)=.*$/\1/'` ; do
@@ -119,7 +117,7 @@ config_rename() {
                unset "$oldvar"
        done
        export ${NO_EXPORT:+-n} CONFIG_SECTIONS="$(echo " $CONFIG_SECTIONS " | sed -e "s, $OLD , $NEW ,")"
-       
+
        [ "$CONFIG_SECTION" = "$OLD" ] && export ${NO_EXPORT:+-n} CONFIG_SECTION="$NEW"
 }
 
@@ -135,8 +133,8 @@ config_clear() {
        export ${NO_EXPORT:+-n} CONFIG_SECTIONS="${SECTION:+$CONFIG_SECTIONS}"
 
        for oldvar in `set | grep ^CONFIG_${SECTION:+${SECTION}_} | \
-               sed -e 's/\(.*\)=.*$/\1/'` ; do 
-               unset $oldvar 
+               sed -e 's/\(.*\)=.*$/\1/'` ; do
+               unset $oldvar
        done
 }
 
@@ -173,17 +171,17 @@ config_set() {
 }
 
 config_foreach() {
-       local function="$1"
+       local ___function="$1"
        [ "$#" -ge 1 ] && shift
-       local type="$1"
+       local ___type="$1"
        [ "$#" -ge 1 ] && shift
        local section cfgtype
-       
+
        [ -z "$CONFIG_SECTIONS" ] && return 0
        for section in ${CONFIG_SECTIONS}; do
                config_get cfgtype "$section" TYPE
-               [ -n "$type" -a "x$cfgtype" != "x$type" ] && continue
-               eval "$function \"\$section\" \"\$@\""
+               [ -n "$___type" -a "x$cfgtype" != "x$___type" ] && continue
+               eval "$___function \"\$section\" \"\$@\""
        done
 }
 
@@ -200,12 +198,12 @@ config_list_foreach() {
        [ -z "$len" ] && return 0
        while [ $c -le "$len" ]; do
                config_get val "${section}" "${option}_ITEM$c"
-               eval "$function \"\$val\" \"$@\""
+               eval "$function \"\$val\" \"\$@\""
                c="$(($c + 1))"
        done
 }
 
-load_modules() {
+insert_modules() {
        [ -d /etc/modules.d ] && {
                cd /etc/modules.d
                sed 's/^[^#]/insmod &/' $* | ash 2>&- || :
@@ -214,19 +212,155 @@ load_modules() {
 
 include() {
        local file
-       
+
        for file in $(ls $1/*.sh 2>/dev/null); do
                . $file
        done
 }
 
-find_mtd_part() {
+find_mtd_index() {
        local PART="$(grep "\"$1\"" /proc/mtd | awk -F: '{print $1}')"
+       local INDEX="${PART##mtd}"
+
+       echo ${INDEX}
+}
+
+find_mtd_part() {
+       local INDEX=$(find_mtd_index "$1")
        local PREFIX=/dev/mtdblock
-       
-       PART="${PART##mtd}"
+
        [ -d /dev/mtdblock ] && PREFIX=/dev/mtdblock/
-       echo "${PART:+$PREFIX$PART}"
+       echo "${INDEX:+$PREFIX$INDEX}"
+}
+
+find_mtd_chardev() {
+       local INDEX=$(find_mtd_index "$1")
+       local PREFIX=/dev/mtd
+
+       [ -d /dev/mtd ] && PREFIX=/dev/mtd/
+       echo "${INDEX:+$PREFIX$INDEX}"
+}
+
+mtd_get_mac_ascii()
+{
+       local mtdname="$1"
+       local key="$2"
+       local part
+       local mac_dirty
+
+       part=$(find_mtd_part "$mtdname")
+       if [ -z "$part" ]; then
+               echo "mtd_get_mac_ascii: partition $mtdname not found!" >&2
+               return
+       fi
+
+       mac_dirty=$(strings "$part" | sed -n 's/^'"$key"'=//p')
+
+       # "canonicalize" mac
+       [ -n "$mac_dirty" ] && macaddr_canonicalize "$mac_dirty"
+}
+
+mtd_get_blob()
+{
+       local mtdname="$1"
+       local offset="$2"
+       local count="$3"
+       local firmware="$4"
+       local part
+
+       part=$(find_mtd_part "$mtdname")
+       if [ -z "$part" ]; then
+               echo "mtd_get_blob: partition $mtdname not found!" >&2
+               return 1
+       fi
+
+       dd if=$part of=$firmware bs=1 skip=$offset count=$count 2>/dev/null || {
+               echo "mtd_get_blob: failed to extract $firmware from $part" >&2
+               return 1
+       }
+}
+
+mtd_get_mac_binary() {
+       local mtdname="$1"
+       local offset="$2"
+       local part
+
+       part=$(find_mtd_part "$mtdname")
+       if [ -z "$part" ]; then
+               echo "mtd_get_mac_binary: partition $mtdname not found!" >&2
+               return
+       fi
+
+       dd bs=1 skip=$offset count=6 if=$part 2>/dev/null | hexdump -v -n 6 -e '5/1 "%02x:" 1/1 "%02x"'
+}
+
+mtd_get_part_size() {
+       local part_name=$1
+       local first dev size erasesize name
+       while read dev size erasesize name; do
+               name=${name#'"'}; name=${name%'"'}
+               if [ "$name" = "$part_name" ]; then
+                       echo $((0x$size))
+                       break
+               fi
+       done < /proc/mtd
+}
+
+macaddr_add() {
+       local mac=$1
+       local val=$2
+       local oui=${mac%:*:*:*}
+       local nic=${mac#*:*:*:}
+
+       nic=$(printf "%06x" $((0x${nic//:/} + $val & 0xffffff)) | sed 's/^\(.\{2\}\)\(.\{2\}\)\(.\{2\}\)/\1:\2:\3/')
+       echo $oui:$nic
+}
+
+macaddr_setbit_la()
+{
+       local mac=$1
+
+       printf "%02x:%s" $((0x${mac%%:*} | 0x02)) ${mac#*:}
+}
+
+macaddr_2bin()
+{
+       local mac=$1
+
+       echo -ne \\x${mac//:/\\x}
+}
+
+macaddr_canonicalize()
+{
+       local mac="$1"
+       local canon=""
+
+       [ ${#mac} -gt 17 ] && return
+       [ -n "${mac//[a-fA-F0-9\.: -]/}" ] && return
+
+       for octet in ${mac//[\.:-]/ }; do
+               case "${#octet}" in
+               1)
+                       octet="0${octet}"
+                       ;;
+               2)
+                       ;;
+               4)
+                       octet="${octet:0:2} ${octet:2:2}"
+                       ;;
+               12)
+                       octet="${octet:0:2} ${octet:2:2} ${octet:4:2} ${octet:6:2} ${octet:8:2} ${octet:10:2}"
+                       ;;
+               *)
+                       return
+                       ;;
+               esac
+               canon=${canon}${canon:+ }${octet}
+       done
+
+       [ ${#canon} -ne 17 ] && return
+
+       printf "%02x:%02x:%02x:%02x:%02x:%02x" 0x${canon// / 0x} 2>/dev/null
 }
 
 strtok() { # <string> { <variable> [<separator>] ... }
@@ -275,103 +409,41 @@ uci_apply_defaults() {
        uci commit
 }
 
-#
-# service: simple wrapper around start-stop-daemon
-#
-# Usage: service ACTION EXEC ARGS...
-#
-# Action:
-#   -S,--start           start EXEC, passing it ARGS as its arguments
-#   -K,--stop            stop EXEC (send it a $SERVICE_SIG_STOP signal)
-#   -R,--reload          reload EXEC (send it a $SERVICE_SIG_RELOAD signal)
-#
-# Environment variables used:
-#   SERVICE_DAEMONIZE    run EXEC in background
-#   SERVICE_WRITE_PID    create a pid file and use it
-#   SERVICE_USE_PID      assume EXEC creates its own pid file and use it
-#   SERVICE_PID_FILE     pid file to use (default to /var/run/EXEC.pid)
-#   SERVICE_SIG_RELOAD   signal used for reloading
-#   SERVICE_SIG_STOP     signal used for stopping
-#   SERVICE_UID          user EXEC should be run as
-#   SERVICE_GID          group EXEC should be run as
-#
-#   SERVICE_DEBUG        don't do anything, but show what would be done
-#   SERVICE_QUIET        don't print anything
-#
-
-SERVICE_QUIET=1
-SERVICE_SIG_RELOAD="HUP"
-SERVICE_SIG_STOP="TERM"
-
-service() {
-       local ssd
-       local ssd_pid_file
-       local ssd_sig
-       local ssd_start
-       ssd="${SERVICE_DEBUG:+echo }start-stop-daemon${SERVICE_QUIET:+ -q}"
-       case "$1" in
-         -S|--start|start)
-               ssd="$ssd -S"
-               ssd_start=1
-               ;;
-         -K|--stop|stop)
-               ssd="$ssd -K"
-               ssd_sig="$SERVICE_SIG_STOP"
-               ;;
-         -R|--reload|reload)
-               ssd="$ssd -K"
-               ssd_sig="$SERVICE_SIG_RELOAD"
-               ;;
-         *)
-               echo "ssd: unknow action '$1'" 1>&2
-               return 1
-       esac
-       shift
-       if [ -z "$1" ]; then
-               echo "ssd: missing arguments" 1>&2
-               return 1
-       fi
-       ssd="$ssd -x $1"
-       if [ -n "$SERVICE_PID_FILE$SERVICE_USE_PID$SERVICE_WRITE_PID" ]; then
-               ssd="$ssd -p ${SERVICE_PID_FILE:-/var/run/${1##*/}.pid}"
-       fi
-       ssd="$ssd${SERVICE_UID:+ -c $SERVICE_UID${SERVICE_GID:+:$SERVICE_GID}}"
-       if [ -n "$ssd_start" ]; then
-               ssd="$ssd${SERVICE_DAEMONIZE:+ -b}${SERVICE_WRITE_PID:+ -m}"
-       else
-               ssd="$ssd${ssd_sig:+ -s $ssd_sig}"
-       fi
-       shift
-       $ssd${1:+ -- "$@"}
-}
-
-service_start() {
-       service -S "$@"
+group_add() {
+       local name="$1"
+       local gid="$2"
+       local rc
+       [ -f "${IPKG_INSTROOT}/etc/group" ] || return 1
+       [ -n "$IPKG_INSTROOT" ] || lock /var/lock/group
+       echo "${name}:x:${gid}:" >> ${IPKG_INSTROOT}/etc/group
+       rc=$?
+       [ -n "$IPKG_INSTROOT" ] || lock -u /var/lock/group
+       return $rc
 }
 
-service_stop() {
-       service -K "$@"
+group_exists() {
+       grep -qs "^${1}:" ${IPKG_INSTROOT}/etc/group
 }
 
-service_reload() {
-       service -R "$@"
+user_add() {
+       local name="${1}"
+       local uid="${2}"
+       local gid="${3:-$2}"
+       local desc="${4:-$1}"
+       local home="${5:-/var/run/$1}"
+       local shell="${6:-/bin/false}"
+       local rc
+       [ -f "${IPKG_INSTROOT}/etc/passwd" ] || return 1
+       [ -n "$IPKG_INSTROOT" ] || lock /var/lock/passwd
+       echo "${name}:x:${uid}:${gid}:${desc}:${home}:${shell}" >> ${IPKG_INSTROOT}/etc/passwd
+       echo "${name}:x:0:0:99999:7:::" >> ${IPKG_INSTROOT}/etc/shadow
+       rc=$?
+       [ -n "$IPKG_INSTROOT" ] || lock -u /var/lock/passwd
+       return $rc
 }
 
-service_kill() {
-       local name="${1}"
-       local pid="${2:-$(pidof "$name")}"
-       local grace="${3:-5}"
-
-       [ -f "$pid" ] && pid="$(head -n1 "$pid" 2>/dev/null)"
-
-       for pid in $pid; do
-               [ -d "/proc/$pid" ] || continue
-               local try=0
-               kill -TERM $pid 2>/dev/null && \
-                       while grep -qs "$name" "/proc/$pid/cmdline" && [ $((try++)) -lt $grace ]; do sleep 1; done
-               kill -KILL $pid 2>/dev/null && \
-                       while grep -qs "$name" "/proc/$pid/cmdline"; do sleep 1; done
-       done
+user_exists() {
+       grep -qs "^${1}:" ${IPKG_INSTROOT}/etc/passwd
 }
 
 
@@ -399,4 +471,137 @@ pi_include() {
        return 0
 }
 
+boot_hook_splice_start() {
+       export -n PI_HOOK_SPLICE=1
+}
+
+boot_hook_splice_finish() {
+       local hook
+       for hook in $PI_STACK_LIST; do
+               local v; eval "v=\${${hook}_splice:+\$${hook}_splice }$hook"
+               export -n "${hook}=${v% }"
+               export -n "${hook}_splice="
+       done
+       export -n PI_HOOK_SPLICE=
+}
+
+boot_hook_init() {
+       local hook="${1}_hook"
+       export -n "PI_STACK_LIST=${PI_STACK_LIST:+$PI_STACK_LIST }$hook"
+       export -n "$hook="
+}
+
+boot_hook_add() {
+       local hook="${1}_hook${PI_HOOK_SPLICE:+_splice}"
+       local func="${2}"
+
+       [ -n "$func" ] && {
+               local v; eval "v=\$$hook"
+               export -n "$hook=${v:+$v }$func"
+       }
+}
+
+boot_hook_shift() {
+       local hook="${1}_hook"
+       local rvar="${2}"
+
+       local v; eval "v=\$$hook"
+       [ -n "$v" ] && {
+               local first="${v%% *}"
+
+               [ "$v" != "${v#* }" ] && \
+                       export -n "$hook=${v#* }" || \
+                       export -n "$hook="
+
+               export -n "$rvar=$first"
+               return 0
+       }
+
+       return 1
+}
+
+boot_run_hook() {
+       local hook="$1"
+       local func
+
+       while boot_hook_shift "$hook" func; do
+               local ran; eval "ran=\$PI_RAN_$func"
+               [ -n "$ran" ] || {
+                       export -n "PI_RAN_$func=1"
+                       $func "$1" "$2"
+               }
+       done
+}
+
+jffs2_ready() {
+       mtdpart="$(find_mtd_part rootfs_data)"
+       [ -z "$mtdpart" ] && return 1
+       magic=$(hexdump $mtdpart -n 4 -e '4/1 "%02x"')
+       [ "$magic" != "deadc0de" ]
+}
+
+dupe() { # <new_root> <old_root>
+       cd $1
+       echo -n "creating directories... "
+       {
+               cd $2
+               find . -xdev -type d
+               echo "./dev ./overlay ./mnt ./proc ./tmp"
+               # xdev skips mounted directories
+               cd $1
+       } | xargs mkdir -p
+       echo "done"
+
+       echo -n "setting up symlinks... "
+       for file in $(cd $2; find . -xdev -type f;); do
+               case "$file" in
+               ./rom/note) ;; #nothing
+               ./etc/config*|\
+               ./usr/lib/opkg/info/*) cp -af $2/$file $file;;
+               *) ln -sf /rom/${file#./*} $file;;
+               esac
+       done
+       for file in $(cd $2; find . -xdev -type l;); do
+               cp -af $2/${file#./*} $file
+       done
+       echo "done"
+}
+
+pivot() { # <new_root> <old_root>
+       mount -o noatime,move /proc $1/proc && \
+       pivot_root $1 $1$2 && {
+               mount -o noatime,move $2/dev /dev
+               mount -o noatime,move $2/tmp /tmp
+               mount -o noatime,move $2/sys /sys 2>&-
+               mount -o noatime,move $2/overlay /overlay 2>&-
+               return 0
+       }
+}
+
+fopivot() { # <rw_root> <ro_root> <dupe?>
+       root=$1
+       {
+               if grep -q overlay /proc/filesystems; then
+                       mount -o noatime,lowerdir=/,upperdir=$1 -t overlayfs "overlayfs:$1" /mnt && root=/mnt
+               elif grep -q mini_fo /proc/filesystems; then
+                       mount -t mini_fo -o noatime,base=/,sto=$1 "mini_fo:$1" /mnt 2>&- && root=/mnt
+               else
+                       mount --bind -o noatime / /mnt
+                       mount --bind -o noatime,union "$1" /mnt && root=/mnt
+               fi
+       } || {
+               [ "$3" = "1" ] && {
+               mount | grep "on $1 type" 2>&- 1>&- || mount -o noatime,bind $1 $1
+               dupe $1 $rom
+               }
+       }
+       pivot $root $2
+}
+
+ramoverlay() {
+       mkdir -p /tmp/root
+       mount -t tmpfs -o noatime,mode=0755 root /tmp/root
+       fopivot /tmp/root /rom 1
+}
+
 [ -z "$IPKG_INSTROOT" -a -f /lib/config/uci.sh ] && . /lib/config/uci.sh