devel.sh

gehe zur Dokumentation dieser Datei

## @defgroup devel Entwicklungswerkzeuge
## @brief Funktionen, die lediglich für die Firmware-Entwicklung, nicht jedoch zur Laufzeit nützlich sind.
# Beginn der Doku-Gruppe
## @{


# Ablage fuer profiling-Ergebnisse
PROFILING_DIR=/var/run/on-profiling
GIT_REPOSITORY_COMMIT_URL_FMT="https://dev.opennet-initiative.de/changeset/%s/on_firmware?format=diff"

# erzeuge das Profiling-Verzeichnis (vorsorglich - es wird wohl unbenutzt bleiben)
mkdir -p "$PROFILING_DIR"


## @fn list_installed_packages_by_size()
## @brief Zeige alle installierten Pakete und ihren Größenbedarf an.
## @details Dies erlaubt die Analyse des Flash-Bedarfs.
list_installed_packages_by_size() {
    local fname
    find /usr/lib/opkg/info/ -type f -name "*.control" | while read -r fname; do
        grep "Installed-Size:" "$fname" \
            | awk '{print $2, "\t", "'"$(basename "${fname%.control}")"'" }'
    done | sort -n | awk 'BEGIN { summe=0 } { summe+=$1; print $0 } END { print summe }'
}


## @fn clean_luci_restart()
## @brief Starte den Webserver neu und lösche alle luci-Cache-Dateien und Kompilate.
## @details Diese Funktion sollte nach Änderungen von luci-Templates oder -Code ausgeführt werden.
clean_luci_restart() {
    local rc_path="/etc/init.d/uhttpd"
    [ -e "$rc_path" ] || return 0
    "$rc_path" stop
    rm -rf /var/luci-*
    "$rc_path" start
}


## @fn run_httpd_debug()
## @brief Starte den Webserver im Debug-Modus zur Beobachtung von lua/luci-Ausgaben.
## @details
run_httpd_debug() {
    /etc/init.d/uhttpd stop 2>/dev/null || true
    rm -rf /var/luci-*
    # ignoriere CTRL-C (wir ueberlassen das INT-Signal dem uhttpd-Prozess)
    trap "" INT
    local uhttpd_args="-f -h /www -x /cgi-bin -t 60 -T 30 -k 20 -A 1 -n 3 -N 100 -R -p 0.0.0.0:80 -s 0.0.0.0:443 -q"
    [ -e /etc/uhttpd.crt ] && uhttpd_args="$uhttpd_args -C /etc/uhttpd.crt -K /etc/uhttpd.key"
    # shellcheck disable=SC2086
    uhttpd $uhttpd_args
    /etc/init.d/uhttpd start
}


## @fn get_function_names()
## @brief Liefere die Namen aller Funktionen zurück.
get_function_names() {
    grep -h "^[^_][a-z0-9_]*(" "${IPKG_INSTROOT:-}"/usr/lib/opennet/*.sh | sed 's/(.*//' | sort
}


## @fn enable_profiling()
## @brief Manipuliere die Funktionsheader in allen shell-Skripten der opennet-Pakete für das Sammeln von profiling-Informationen.
## @details Diese Operation ist irreversibel - eine erneute Installation der Pakete ist der einzige saubere Weg zurück.
##   Die Ergebnisse sind anschließend im PROFILING_DIR verfügbar.
## @see summary_profiling
enable_profiling() {
    local message=
    command -v bash >/dev/null || message="Failed to enable profiling - due to missing bash"
    [ -e /usr/bin/date ] || message="Failed to enable profiling - due to missing coreutils-date"
    if [ -z "$message" ]; then
        # ersetze das shebang in allen Opennet-Skripten
        # eventuell fehlen ein paar Dateien (Umbennungen usw. im Vergleich zum installierten Paket) -> überspringen
        cat /usr/lib/opkg/info/on-*.list | grep -E '(bin/|\.sh$|etc/cron\.|/etc/hotplug\.d/|lib/opennet)' \
            | while read -r fname; do [ -e "$fname" ] && echo "$fname"; true; done \
            | xargs -n 200 -r sed -i -f "${IPKG_INSTROOT:-}/usr/lib/opennet/profiling.sed"
        clear_caches
    else
        logger -t "on-profile" "$message"
        echo >&2 "$message"
        return 1
    fi
}


## @fn summary_profiling()
## @brief Werte gesammelte profiling-Informationen aus.
## @returns Jede Zeile beschreibt das kumulative Profiling einer Funktion:
##   Gesamtzeit, Anzahl der Aufrufe, durchschnittliche Verarbeitungszeit, Funktionsname
##   Die Zeiten sind jeweils in Millisekunden angegeben.
## @details Als Verarbeitungszeit einer Funktion gilt dabei der gesamte Zeitunterschied zwischen Funktionseintritt und -ende.
## @see enable_profiling
summary_profiling() {
    local fname
    # Kopfzeile
    printf '%16s %16s %16s %s\n' "Duration [ms]" "Call count" "avgDuration [ms]" "Name"
    find "$PROFILING_DIR" -type f | while read -r fname; do
        # filtere Fehlmessungen (irgendwie tauchen dort Zahlen wie "27323677987" auf)
        grep -v '^27[0-9]\{9\}$' "$fname" | awk '
            BEGIN { summe=0; counter=0 }
            { summe+=($1/1000); counter+=1 }
            END { printf "%16d %16d %16d %s\n", summe, counter, int(summe/counter), "'"$(basename "$fname")"'"}'
    done | sort -n
}


## @fn apply_repository_patch()
## @brief Wende einen commit aus dem Firmware-Repository als Patch an.
## @param Eine oder mehrere Commit-IDs.
## @details Dies kann die punktuelle Fehlerbehebung nach einem Release erleichtern.
##    Die Umgebungsvariable "ON_PATCH_ARGS" wird als Parameter für "patch" verwendet (z.B. "--reverse").
apply_repository_patch() {
    # Patch-Argumente können beim Aufruf gesetzt werden - z.B. "--reverse"
    local patch_args="${ON_PATCH_ARGS:-}"
    # wir benötigen das Paket "patch"
    is_package_installed "patch" || { opkg update && opkg install "patch"; }
    local commit
    local patch
    for commit in "$@"; do
        # Currently the git repository server uses the Opennet CA for its webserver
        # certificate.
        # shellcheck disable=SC2059,SC2086
        patch=$(http_request "$(printf "$GIT_REPOSITORY_COMMIT_URL_FMT" "$commit")")
        echo "$patch" | patch $patch_args -p4 --directory --dry-run /
        echo "$patch" | patch $patch_args -p4 --directory /
    done
    clear_caches
    clean_luci_restart
}

# Ende der Doku-Gruppe
## @}