Merge pull request #17265 from TDT-AG/pr/20211203-modemmanager

modemmanager: refactoring procd init script

diff --git a/net/modemmanager/Makefile b/net/modemmanager/Makefile
index ce87b0a36ab2ac0256702f36098dc50a2ffdeca1..db59989b203453402ffd9a50c0f701187c0bb875 100644 (file)
--- a/net/modemmanager/Makefile
+++ b/net/modemmanager/Makefile
@@ -98,6 +98,7 @@ define Package/modemmanager/install
 
        $(INSTALL_DIR) $(1)/usr/sbin
        $(INSTALL_BIN) $(PKG_INSTALL_DIR)/usr/sbin/ModemManager $(1)/usr/sbin
+       $(INSTALL_BIN) ./files/usr/sbin/ModemManager-wrapper $(1)/usr/sbin
 
        $(INSTALL_DIR) $(1)/usr/bin
        $(INSTALL_BIN) $(PKG_INSTALL_DIR)/usr/bin/mmcli $(1)/usr/bin

diff --git a/net/modemmanager/files/modemmanager.common b/net/modemmanager/files/modemmanager.common
index b4139abadb1bfec43ba7174d57c031ec7b983d62..6367eb32bb51186dd45e20a0a9f4ab75e9268e56 100644 (file)
--- a/net/modemmanager/files/modemmanager.common
+++ b/net/modemmanager/files/modemmanager.common
@@ -20,7 +20,8 @@ MODEMMANAGER_EVENTS_CACHE="${MODEMMANAGER_RUNDIR}/events.cache"
 # Common logging
 
 mm_log() {
-       logger -t "ModemManager" "hotplug: $*"
+       local level="$1"; shift
+       logger -p "daemon.${level}" -t "ModemManager[$$]" "hotplug: $*"
 }
 
 ################################################################################
@@ -169,7 +170,7 @@ mm_wait_for_modem() {
 
        while [ $n -ge 0 ]; do
                [ -d "${sysfspath}" ] || {
-                       mm_log "error: ignoring modem detection request: no device at ${sysfspath}"
+                       mm_log "error" "ignoring modem detection request: no device at ${sysfspath}"
                        proto_set_available "${cfg}" 0
                        return 1
                }
@@ -177,10 +178,10 @@ mm_wait_for_modem() {
                # Check if the modem exists at the given sysfs path
                if ! mmcli -m "${sysfspath}" > /dev/null 2>&1
                then
-                       mm_log "error: modem not detected at sysfs path"
+                       mm_log "error" "modem not detected at sysfs path"
                else
-                       mm_log "modem exported successfully at ${sysfspath}"
-                       mm_log "setting interface '${cfg}' as available"
+                       mm_log "info" "modem exported successfully at ${sysfspath}"
+                       mm_log "info" "setting interface '${cfg}' as available"
                        proto_set_available "${cfg}" 1
                        return 0
                fi
@@ -189,7 +190,7 @@ mm_wait_for_modem() {
                n=$((n-step))
        done
 
-       mm_log "error: timed out waiting for the modem to get exported at ${sysfspath}"
+       mm_log "error" "timed out waiting for the modem to get exported at ${sysfspath}"
        proto_set_available "${cfg}" 0
        return 2
 }
@@ -201,7 +202,7 @@ mm_report_modem_wait() {
 
        parent_sysfspath=$(mm_find_physdev_sysfs_path "$sysfspath")
        [ -n "${parent_sysfspath}" ] || {
-               mm_log "error: parent device sysfspath not found"
+               mm_log "error" "parent device sysfspath not found"
                return
        }
 
@@ -212,23 +213,23 @@ mm_report_modem_wait() {
 
                        cfg=$(mm_get_modem_config "${parent_sysfspath}")
                        if [ -n "${cfg}" ]; then
-                               mm_log "interface '${cfg}' is set to configure device '${parent_sysfspath}'"
-                               mm_log "now waiting for modem at sysfs path ${parent_sysfspath}"
+                               mm_log "info" "interface '${cfg}' is set to configure device '${parent_sysfspath}'"
+                               mm_log "info" "now waiting for modem at sysfs path ${parent_sysfspath}"
                                mm_set_modem_wait_status "${parent_sysfspath}" "processed"
                                # Launch subshell for the explicit wait
                                ( mm_wait_for_modem "${cfg}" "${parent_sysfspath}" ) > /dev/null 2>&1 &
                        else
-                               mm_log "no need to wait for modem at sysfs path ${parent_sysfspath}"
+                               mm_log "info" "no need to wait for modem at sysfs path ${parent_sysfspath}"
                                mm_set_modem_wait_status "${parent_sysfspath}" "ignored"
                        fi
                        ;;
                "processed")
-                       mm_log "already waiting for modem at sysfs path ${parent_sysfspath}"
+                       mm_log "info" "already waiting for modem at sysfs path ${parent_sysfspath}"
                        ;;
                "ignored")
                        ;;
                *)
-                       mm_log "error: unknown status read for device at sysfs path ${parent_sysfspath}"
+                       mm_log "error" "unknown status read for device at sysfs path ${parent_sysfspath}"
                        ;;
        esac
 }
@@ -258,7 +259,7 @@ mm_cleanup_interface_by_sysfspath() {
        cfg=$(mm_get_modem_config "$dev")
        [ -n "${cfg}" ] || return
 
-       mm_log "setting interface '$cfg' as unavailable"
+       mm_log "info" "setting interface '$cfg' as unavailable"
        proto_set_available "${cfg}" 0
 }
 
@@ -286,7 +287,7 @@ mm_report_event() {
        esac
 
        # Report the event
-       mm_log "event reported: action=${action}, name=${name}, subsystem=${subsystem}"
+       mm_log "debug" "event reported: action=${action}, name=${name}, subsystem=${subsystem}"
        mmcli --report-kernel-event="action=${action},name=${name},subsystem=${subsystem}" 1>/dev/null 2>&1 &
 
        # Wait for added modem if a sysfspath is given
@@ -302,7 +303,7 @@ mm_report_event_from_cache_line() {
        subsystem=$(echo "${event_line}" | awk -F ',' '{ print $3 }')
        sysfspath=$(echo "${event_line}" | awk -F ',' '{ print $4 }')
 
-       mm_log "cached event found: action=${action}, name=${name}, subsystem=${subsystem}, sysfspath=${sysfspath}"
+       mm_log "debug" "cached event found: action=${action}, name=${name}, subsystem=${subsystem}, sysfspath=${sysfspath}"
        mm_report_event "${action}" "${name}" "${subsystem}" "${sysfspath}"
 }
 
@@ -317,11 +318,11 @@ mm_report_events_from_cache() {
        # Wait for ModemManager to be available in the bus
        while [ $n -ge 0 ]; do
                sleep $step
-               mm_log "checking if ModemManager is available..."
+               mm_log "info" "checking if ModemManager is available..."
 
                if ! mmcli -L >/dev/null 2>&1
                then
-                       mm_log "ModemManager not yet available"
+                       mm_log "info" "ModemManager not yet available"
                else
                        mmrunning=1
                        break
@@ -330,7 +331,7 @@ mm_report_events_from_cache() {
        done
 
        [ ${mmrunning} -eq 1 ] || {
-               mm_log "error: couldn't report initial kernel events: ModemManager not running"
+               mm_log "error" "couldn't report initial kernel events: ModemManager not running"
                return
        }
 

diff --git a/net/modemmanager/files/modemmanager.init b/net/modemmanager/files/modemmanager.init
index b3f9f92901b6c8a7aeb0be61ba936d07319f16b5..7f014dc56ecb64746e71083b86b5ec2873579d88 100755 (executable)
--- a/net/modemmanager/files/modemmanager.init
+++ b/net/modemmanager/files/modemmanager.init
@@ -4,6 +4,8 @@
 USE_PROCD=1
 START=70
 
+LOG_LEVEL="INFO"
+
 stop_service() {
        # Load common utils
        . /usr/share/ModemManager/modemmanager.common
@@ -22,14 +24,14 @@ start_service() {
        # it starts.
        #
        # All these commands need to be executed on every MM start, even after
-       # procd-triggered respawns, which is why they're all included as instance command
+       # procd-triggered respawns, which is why this is wrapped in a startup
+       # wrapper script called '/usr/sbin/ModemManager-wrapper'.
        #
+       . /usr/share/ModemManager/modemmanager.common
        procd_open_instance
-       procd_set_param command sh -c ". /usr/share/ModemManager/modemmanager.common;    \
-                                      mkdir -m 0755 -p ${MODEMMANAGER_RUNDIR};          \
-                                      mm_cleanup_interfaces;                            \
-                                      ( mm_report_events_from_cache ) >/dev/null 2>&1 & \
-                                      /usr/sbin/ModemManager"
+       procd_set_param command /usr/sbin/ModemManager-wrapper
+       procd_append_param command --log-level="$LOG_LEVEL"
+       [ "$LOG_LEVEL" = "DEBUG" ] && procd_append_param command --debug
        procd_set_param respawn "${respawn_threshold:-3600}" "${respawn_timeout:-5}" "${respawn_retry:-5}"
        procd_set_param pidfile "${MODEMMANAGER_PID_FILE}"
        procd_close_instance

diff --git a/net/modemmanager/files/usr/sbin/ModemManager-wrapper b/net/modemmanager/files/usr/sbin/ModemManager-wrapper
new file mode 100644 (file)
index 0000000..f5fb6d1
--- /dev/null
+++ b/net/modemmanager/files/usr/sbin/ModemManager-wrapper
@@ -0,0 +1,33 @@
+#!/bin/sh
+
+trap_with_arg() {
+       func="$1" ; shift
+       for sig ; do
+               # shellcheck disable=SC2064
+               trap "$func $sig" "$sig"
+       done
+}
+
+func_trap() {
+       logger "ModemManager-wrapper[$$]" "Sending signal ${1}..."
+       kill "-${1}" "$CHILD" 2>/dev/null
+}
+
+main() {
+       . /usr/share/ModemManager/modemmanager.common
+
+       trap_with_arg func_trap INT TERM KILL
+
+       mkdir -p "${MODEMMANAGER_RUNDIR}"
+       chmod 0755 "${MODEMMANAGER_RUNDIR}"
+       mm_cleanup_interfaces
+
+       /usr/sbin/ModemManager "$@" 1>/dev/null 2>/dev/null &
+       CHILD="$!"
+       sleep 2
+       mm_report_events_from_cache
+
+       wait "$CHILD"
+}
+
+main "$@"