mirror of
https://github.com/freebsd/freebsd-src
synced 2024-07-22 10:48:02 +00:00
aa3b7a2fbc
Debugging boot issues can be helped by logging each rc.d script as it is run and being able to selectively enable/disable set -x debug.sh provides an elaborate framework for debugging shell scripts. For secure systems, we want to be paranoid about what we read during boot. dot() simply reads (.) arg file if it exists vdot() if mac_veriexec is active, ignore unverified files otherwise behaves much the same as dot() safe_dot() in safe_eval.sh allows reading an untrusted file; limiting the input to simple variable assignments. In load_rc_config allow caller to provide an option to indicate how to handle its arg: -v use vdot() -s use sdot() which will try to use vdot() and fallback to safe_dot() The default is to read using dot() rc_run_scripts() encapsulate the running of rc.d scripts so that we can easily call it more than twice. We vdot local.rc.subr to pick up extensions (like run_rc_scripts_final) and overrides. We also allow rc.subr.local or rc.conf to set rc_config_xtra eg (rc_config_xtra=XXX for historic compatibility) rc use set -o verify around the reading in of rc.subr This has no effect if mac_veriexec is not active, but if it is; ensures rc.subr has not been tampered with. Reviewed by: imp Sponsored by: Juniper Networks, Inc. Differential Revision: https://reviews.freebsd.org/D43671
279 lines
6.3 KiB
Bash
Executable file
279 lines
6.3 KiB
Bash
Executable file
:
|
|
# SPDX-License-Identifier: BSD-2-Clause
|
|
|
|
# NAME:
|
|
# debug.sh - selectively debug scripts
|
|
#
|
|
# SYNOPSIS:
|
|
# $_DEBUG_SH . debug.sh
|
|
# DebugOn [-eo] "tag" ...
|
|
# DebugOff [-eo] [rc="rc"] "tag" ...
|
|
# Debugging
|
|
# DebugEcho ...
|
|
# DebugLog ...
|
|
# DebugShell "tag" ...
|
|
# DebugTrace ...
|
|
# Debug "tag" ...
|
|
#
|
|
# $DEBUG_SKIP echo skipped when Debug "tag" is true.
|
|
# $DEBUG_DO echo only done when Debug "tag" is true.
|
|
#
|
|
# DESCRIPTION:
|
|
# debug.sh provides the following functions to facilitate
|
|
# flexible run-time tracing of complicated shell scripts.
|
|
#
|
|
# DebugOn turns tracing on if any "tag" is found in "DEBUG_SH".
|
|
# It turns tracing off if "!tag" is found in "DEBUG_SH".
|
|
# It also sets "DEBUG_ON" to the "tag" that caused tracing to be
|
|
# enabled, or "DEBUG_OFF" if we matched "!tag".
|
|
# If '-e' option given returns 1 if no "tag" matched.
|
|
# If the '-o' flag is given, tracing is turned off unless there
|
|
# was a matched "tag", useful for functions too noisy to tace.
|
|
#
|
|
# DebugOff turns tracing on if any "tag" matches "DEBUG_OFF" or
|
|
# off if any "tag" matches "DEBUG_ON". This allows nested
|
|
# functions to not interfere with each other.
|
|
#
|
|
# DebugOff accepts but ignores the '-e' and '-o' options.
|
|
# The optional "rc" value will be returned rather than the
|
|
# default of 0. Thus if DebugOff is the last operation in a
|
|
# function, "rc" will be the return code of that function.
|
|
#
|
|
# DebugEcho is just shorthand for:
|
|
#.nf
|
|
# $DEBUG_DO echo "$@"
|
|
#.fi
|
|
#
|
|
# Debugging returns true if tracing is enabled.
|
|
# It is useful for bounding complex debug actions, rather than
|
|
# using lots of "DEBUG_DO" lines.
|
|
#
|
|
# DebugShell runs an interactive shell if any "tag" is found in
|
|
# "DEBUG_INTERACTIVE", and there is a tty available.
|
|
# The shell used is defined by "DEBUG_SHELL" or "SHELL" and
|
|
# defaults to '/bin/sh'.
|
|
#
|
|
# Debug calls DebugOn and if that does not turn tracing on, it
|
|
# calls DebugOff to turn it off.
|
|
#
|
|
# The variables "DEBUG_SKIP" and "DEBUG_DO" are set so as to
|
|
# enable/disable code that should be skipped/run when debugging
|
|
# is turned on. "DEBUGGING" is the same as "DEBUG_SKIP" for
|
|
# backwards compatability.
|
|
#
|
|
# The use of $_DEBUG_SH is to prevent multiple inclusion, though
|
|
# it does no harm in this case.
|
|
#
|
|
# BUGS:
|
|
# Does not work with some versions of ksh.
|
|
# If a function turns tracing on, ksh turns it off when the
|
|
# function returns - useless.
|
|
# PD ksh works ok ;-)
|
|
#
|
|
# AUTHOR:
|
|
# Simon J. Gerraty <sjg@crufty.net>
|
|
|
|
# RCSid:
|
|
# $Id: debug.sh,v 1.35 2024/02/03 19:04:47 sjg Exp $
|
|
#
|
|
# @(#) Copyright (c) 1994-2024 Simon J. Gerraty
|
|
#
|
|
# This file is provided in the hope that it will
|
|
# be of use. There is absolutely NO WARRANTY.
|
|
# Permission to copy, redistribute or otherwise
|
|
# use this file is hereby granted provided that
|
|
# the above copyright notice and this notice are
|
|
# left intact.
|
|
#
|
|
# Please send copies of changes and bug-fixes to:
|
|
# sjg@crufty.net
|
|
#
|
|
|
|
_DEBUG_SH=:
|
|
|
|
Myname=${Myname:-`basename $0 .sh`}
|
|
|
|
DEBUGGING=
|
|
DEBUG_DO=:
|
|
DEBUG_SKIP=
|
|
export DEBUGGING DEBUG_DO DEBUG_SKIP
|
|
|
|
_debugOn() {
|
|
DEBUG_OFF=
|
|
DEBUG_DO=
|
|
DEBUG_SKIP=:
|
|
DEBUG_X=-x
|
|
set -x
|
|
DEBUG_ON=$1
|
|
}
|
|
|
|
_debugOff() {
|
|
DEBUG_OFF=$1
|
|
set +x
|
|
DEBUG_ON=$2
|
|
DEBUG_DO=:
|
|
DEBUG_SKIP=
|
|
DEBUG_X=
|
|
}
|
|
|
|
DebugEcho() {
|
|
$DEBUG_DO echo "$@"
|
|
}
|
|
|
|
Debugging() {
|
|
test "$DEBUG_SKIP"
|
|
}
|
|
|
|
DebugLog() {
|
|
$DEBUG_SKIP return 0
|
|
echo `date '+@ %s [%Y-%m-%d %H:%M:%S %Z]'` "$@"
|
|
}
|
|
|
|
# something hard to miss when wading through huge -x output
|
|
DebugTrace() {
|
|
$DEBUG_SKIP return 0
|
|
set +x
|
|
echo "@ ==================== [ $DEBUG_ON ] ===================="
|
|
DebugLog "$@"
|
|
echo "@ ==================== [ $DEBUG_ON ] ===================="
|
|
set -x
|
|
}
|
|
|
|
# Turn on debugging if appropriate
|
|
DebugOn() {
|
|
_rc=0 # avoid problems with set -e
|
|
_off=:
|
|
while :
|
|
do
|
|
case "$1" in
|
|
-e) _rc=1; shift;; # caller ok with return 1
|
|
-o) _off=; shift;; # off unless we have a match
|
|
*) break;;
|
|
esac
|
|
done
|
|
case ",${DEBUG_SH:-$DEBUG}," in
|
|
,,) return $_rc;;
|
|
*,[Dd]ebug,*) ;;
|
|
*) $DEBUG_DO set +x;; # reduce the noise
|
|
esac
|
|
_match=
|
|
# if debugging is off because of a !e
|
|
# don't add 'all' to the On list.
|
|
case "$_off$DEBUG_OFF" in
|
|
:) _e=all;;
|
|
*) _e=;;
|
|
esac
|
|
for _e in ${*:-$Myname} $_e
|
|
do
|
|
: $_e in ,${DEBUG_SH:-$DEBUG},
|
|
case ",${DEBUG_SH:-$DEBUG}," in
|
|
*,!$_e,*|*,!$Myname:$_e,*)
|
|
# only turn it off if it was on
|
|
_rc=0
|
|
$DEBUG_DO _debugOff $_e $DEBUG_ON
|
|
break
|
|
;;
|
|
*,$_e,*|*,$Myname:$_e,*)
|
|
# only turn it on if it was off
|
|
_rc=0
|
|
_match=$_e
|
|
$DEBUG_SKIP _debugOn $_e
|
|
break
|
|
;;
|
|
esac
|
|
done
|
|
if test -z "$_off$_match"; then
|
|
# off unless explicit match, but
|
|
# only turn it off if it was on
|
|
$DEBUG_DO _debugOff $_e $DEBUG_ON
|
|
fi
|
|
DEBUGGING=$DEBUG_SKIP # backwards compatability
|
|
$DEBUG_DO set -x # back on if needed
|
|
$DEBUG_DO set -x # make sure we see it in trace
|
|
return $_rc
|
|
}
|
|
|
|
# Only turn debugging off if one of our args was the reason it
|
|
# was turned on.
|
|
# We normally return 0, but caller can pass rc=$? as first arg
|
|
# so that we preserve the status of last statement.
|
|
DebugOff() {
|
|
case ",${DEBUG_SH:-$DEBUG}," in
|
|
*,[Dd]ebug,*) ;;
|
|
*) $DEBUG_DO set +x;; # reduce the noise
|
|
esac
|
|
_rc=0 # always happy
|
|
while :
|
|
do
|
|
case "$1" in
|
|
-[eo]) shift;; # ignore it
|
|
rc=*) eval "_$1"; shift;;
|
|
*) break;;
|
|
esac
|
|
done
|
|
for _e in $*
|
|
do
|
|
: $_e==$DEBUG_OFF DEBUG_OFF
|
|
case "$DEBUG_OFF" in
|
|
"") break;;
|
|
$_e) _debugOn $DEBUG_ON; return $_rc;;
|
|
esac
|
|
done
|
|
for _e in $*
|
|
do
|
|
: $_e==$DEBUG_ON DEBUG_ON
|
|
case "$DEBUG_ON" in
|
|
"") break;;
|
|
$_e) _debugOff; return $_rc;;
|
|
esac
|
|
done
|
|
DEBUGGING=$DEBUG_SKIP # backwards compatability
|
|
$DEBUG_DO set -x # back on if needed
|
|
$DEBUG_DO set -x # make sure we see it in trace
|
|
return $_rc
|
|
}
|
|
|
|
_TTY=${_TTY:-`test -t 0 && tty`}; export _TTY
|
|
|
|
# override this if you like
|
|
_debugShell() {
|
|
{
|
|
echo DebugShell "$@"
|
|
echo "Type 'exit' to continue..."
|
|
} > $_TTY
|
|
${DEBUG_SHELL:-${SHELL:-/bin/sh}} < $_TTY > $_TTY 2>&1
|
|
}
|
|
|
|
# Run an interactive shell if appropriate
|
|
# Note: you can use $DEBUG_SKIP DebugShell ... to skip unless debugOn
|
|
DebugShell() {
|
|
case "$_TTY%${DEBUG_INTERACTIVE}" in
|
|
*%|%*) return 0;; # no tty or no spec
|
|
esac
|
|
for _e in ${*:-$Myname} all
|
|
do
|
|
case ",${DEBUG_INTERACTIVE}," in
|
|
*,!$_e,*|*,!$Myname:$_e,*)
|
|
return 0
|
|
;;
|
|
*,$_e,*|*,$Myname:$_e,*)
|
|
# Provide clues as to why/where
|
|
_debugShell "$_e: $@"
|
|
return $?
|
|
;;
|
|
esac
|
|
done
|
|
return 0
|
|
}
|
|
|
|
# For backwards compatability
|
|
Debug() {
|
|
case "${DEBUG_SH:-$DEBUG}" in
|
|
"") ;;
|
|
*) DEBUG_ON=${DEBUG_ON:-_Debug}
|
|
DebugOn -e $* || DebugOff $DEBUG_LAST
|
|
DEBUGGING=$DEBUG_SKIP
|
|
;;
|
|
esac
|
|
}
|