p4broker_base #20

  • //
  • guest/
  • perforce_software/
  • sdp/
  • dev/
  • Server/
  • Unix/
  • p4/
  • common/
  • bin/
  • p4broker_base
  • View
  • Commits
  • Open Download .zip Download (7 KB)
#!/bin/bash
#==============================================================================
# Copyright and license info is available in the LICENSE file included with
# the Server Deployment Package (SDP), and also available online:
# https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/LICENSE
#------------------------------------------------------------------------------

# Helix Broker base init script

# Do nothing unless $SDP_INSTANCE is defined.
export SDP_INSTANCE="${1:-Unset}"
export OS_INIT_MECHANISM="${OS_INIT_MECHANISM:-Unset}"
declare ThisScript=${0##*/}
declare Version=5.0.1
declare CmdLine="$0 $*"
declare -i StartDelay="${SDP_START_DELAY:-2}"
declare -i ExitCode=0
declare -i UseSystemd=0
declare ServiceName=
declare P4BrokerFlags=
declare TargetPort=
declare ListenPort=

if [[ $SDP_INSTANCE == Unset ]]; then
   echo -e "\\nError: The SDP_INSTANCE is not defined.\n."
   exit 1
fi

# Load SDP controlled shell environment.
# shellcheck disable=SC1091
source /p4/common/bin/p4_vars "$SDP_INSTANCE"
ExitCode="$?"

if [[ "$ExitCode" -ne 0 ]]; then
   echo -e "\\nError: Failed to load SDP environment for instance $SDP_INSTANCE.\n"
   exit 1
fi

# shellcheck disable=SC1090 disable=SC1091
source "$P4CBIN/ps_functions.sh"
ExitCode="$?"

if [[ "$ExitCode" -ne 0 ]]; then
   echo -e "\\nError: Failed to load SDP ps_functions.sh lib.\n"
   exit 1
fi

if [[ $(id -u) -eq 0 ]]; then
   exec su - "$OSUSER" -c "$0 $*"
elif [[ $(id -u -n) != "$OSUSER" ]]; then
   echo "$0 can only be run by root or $OSUSER"
   exit 1
fi

if [[ ! -x "$P4BROKERBIN" ]]; then
   echo -e "\\nError: $P4BROKERBIN is not executable."
   exit 2;
fi

declare OpMode=${2:-usage}
declare ConfigTag=${3:-default}
declare ConfigTagList=
declare -i ExitStatus=0

if [[ "$ConfigTag" == "all" ]]; then
   # shellcheck disable=SC2164 disable=SC2012
   ConfigTagList="default $(cd "${P4CCFG}"; ls "${P4SERVER}".broker.*.cfg 2>/dev/null | cut -d '.' -f 3)"
   # shellcheck disable=SC2116
   ConfigTagList=$(echo "$ConfigTagList")
else
   ConfigTagList=$ConfigTag
fi

for tag in $ConfigTagList; do
   if [[ "$tag" == "default" ]]; then
      ServiceName="${P4BROKERBIN##*/}"
      if [[ -r "/p4/common/config/${P4SERVER}.broker.${HOSTNAME%%.*}.cfg" ]]; then
         export P4BROKERCFG="${P4CCFG}/${P4SERVER}.broker.${HOSTNAME%%.*}.cfg"
      else
         export P4BROKERCFG="${P4CCFG}/${P4SERVER}.broker.cfg"
      fi
   else
      ServiceName="${P4BROKERBIN##*/}_${tag}"
      export P4BROKERCFG="${P4CCFG}/${P4SERVER}.broker.${tag}.cfg"
   fi

   # Determine if systemd is configured for this instance and config.
   if [[ -n "$(command -v systemctl)" ]]; then
      if [[ -n "$(systemctl is-enabled "$ServiceName" 2>/dev/null)" ]]; then
         UseSystemd=1
         MustUseSystemdMsg="\\nError: It appears an attempt was made to start or stop the $ServiceName\\nservice without using systemd. When a systemd unit file is configured, only the\\nsystemd init mechanism can be used to start and stop the service, so that\\nsystemd maintains a more reliable indication of the status of the service. Run\\nas root or as $OSUSER with sudo. For example:\\n\\n\\tsudo systemctl start $ServiceName\\n\\tsudo systemctl stop $ServiceName\\n\\tsystemctl status $ServiceName\\n\\nNote that the 'status' check does not require sudo.\\n\\nThe systemd unit file is:\\n\\n$(sudo systemctl cat "$ServiceName")"
      else
         UseSystemd=0
      fi
   fi

   if [[ ! -r "$P4BROKERCFG" ]]; then
      echo -e "\\nError: Missing broker config file $P4BROKERCFG.\n"
      ExitStatus=1
      continue
   fi

   # Set flags to start the broker referencing the config file.
   P4BrokerFlags="-d -c $P4BROKERCFG"

   # If running with systemd, we drop the '-d' flag and let systemd handle the
   # process forking.
   if [[ "$UseSystemd" -eq 1 ]]; then
      P4BrokerFlags="${P4BrokerFlags/-d / }"
   fi

   case "$OpMode" in
      start)
         if [[ "$UseSystemd" -eq 1 && "$OS_INIT_MECHANISM" != "systemd" ]]; then
            echo -e "$MustUseSystemdMsg"
            exit 1
         fi

         # Delay start $StartDelay seconds.
         sleep "$StartDelay"

         # Grab the first target port from the broker config file.
         TargetPort=$(grep -E '^\s*target\s*=' "$P4BROKERCFG"|head -1)
         TargetPort=${TargetPort#*=}
         TargetPort=${TargetPort%;}
         TargetPort=${TargetPort// /}

         if [[ "$TargetPort" =~ ^ssl[46]*: ]]; then
            # Quietly attempt a trust of the target server. This might fail if the
            # target server is not reachable, but it doesn't hurt to try.
            "${P4BIN}" -p "$TargetPort" trust -f -y > /dev/null 2>&1
         fi

         # shellcheck disable=SC2164
         cd "$LOGS"
         if [[ -n "$(command -v ulimit)" && "$(ulimit -c)" != "0" ]]; then
            ulimit -c unlimited
         fi

         echo -e "\\n$(date) Called $ThisScript v$Version with command line:\\n$CmdLine"
         echo "Starting ${P4BROKERBIN} ($tag config) using ${P4BROKERCFG}."
         # shellcheck disable=SC2086
         "${P4BROKERBIN}" $P4BrokerFlags
      ;;

      status)
         p4broker_pids=$(get_pids "$P4BROKERCFG")
         if [[ -n "$p4broker_pids" ]]; then
            echo "${P4BROKERBIN} ($tag config) is running as pids: $p4broker_pids."

            # Grab the listen port from the broker config file.
            ListenPort=$(grep -E '^\s*listen\s*=' "$P4BROKERCFG"|head -1)
            ListenPort=${ListenPort#*=}
            ListenPort=${ListenPort%;}
            ListenPort=${ListenPort// /}

            if [[ "$ListenPort" =~ ^ssl[46]*: ]]; then
               # Quietly attempt a trust of the local broker.
               "${P4BIN}" -p "$ListenPort" trust -f -y > /dev/null 2>&1
            fi

            ExitStatus=0
         else
            echo "${P4BROKERBIN} ($tag config) is NOT running."
            ExitStatus=1
         fi
      ;;

      stop)
         p4broker_pids=$(get_pids "$P4BROKERCFG")

         if [[ -n "$p4broker_pids" ]]; then
            if [[ "$UseSystemd" -eq 1 && "$OS_INIT_MECHANISM" != "systemd" ]]; then
               echo -e "$MustUseSystemdMsg"
               exit 1
            fi

            while [[ -n "$p4broker_pids" ]]; do
               echo "Shutting down ${P4BROKERBIN} ($tag config) pids $p4broker_pids."
               # shellcheck disable=SC2086
               kill $p4broker_pids 2>&1 | $GREP -v -i "No such"
               sleep 1
               p4broker_pids=$(get_pids "$P4BROKERCFG")
            done
            echo "${P4BROKERBIN} ($tag config) stopped."
            ExitStatus=0
         else
            echo "${P4BROKERBIN} ($tag config) was NOT running."
            ExitStatus=1
         fi
      ;;
      restart)
         $0 "$SDP_INSTANCE" stop "$tag"
         $0 "$SDP_INSTANCE" start "$tag"
      ;;
      *)
         echo -e "\nUsage: $0 SDP_INSTANCE {start|stop|status|restart} [<ConfigTag>|all]\n"
         ExitStatus=1
      ;;
   esac
done

exit $ExitStatus
# Change User Description Committed
#20 30266 C. Thomas Tyler Added logic surrounding 'ulimit -c unlimited' to avoid calling 'ulimit'
on systems on which it is doomed to fail with an 'Operation not permitted'
error.
#19 30127 C. Thomas Tyler Enhanced p4d_base to start p4d from the P4ROOT directory and to
set 'ulimit -c unlimited' to enable core dumps.  Similar was
done for p4p_base and p4broker_base.

For best results, combine this with doing the following as root
on p4d server machines:
bash -c "echo 'core.%e.%p.%s' > /proc/sys/kernel/core_pattern"

This wll generate core files for p4d in $P4ROOT, something like this:
/p4/1/root/core.p4d_1.2351279.11

For p4p, core dumps appear in the $P4PCACHE dir.

For p4broker, core dumps appear in the $LOGS dir.

Also added version identifier that is captured in systemctl status
output.

#review-30128
#18 29101 C. Thomas Tyler Added implicit trust of target servers for p4p/p4broker on 'start',
and added trust of local proxy/broker ports on 'status'.

#review-29102
#17 29100 C. Thomas Tyler Removed requirement for systemd *.service files to have open perms
in *_base scripts and templates.

Removed checks for open perms on *.service files in verify_sdp.sh.

Fixed minor ShellCheck compliance issue.

See also: HI-101: https://swarm.workshop.perforce.com/jobs/HI-101

[Submitting, then re-opening for post-commit final review].
#16 27206 C. Thomas Tyler More minor message refinements.
#15 27205 C. Thomas Tyler Cosmetic refinement to error message.
#14 27109 C. Thomas Tyler Refined logic so that if a shutdown is attempted and there is no
server.pid file, the 'fallback/2nd pass/assured shutdown' logic
to do a 'p4 admin stop' files only if a 'p4 info' command can
reach the server. Otherwise, the stop command is silently
ignored.

Refined exit code handling and fixed log interaciton issues.
Fixed issue with systemd status not indicating successful startup.

The systemd unit files now specify the Type as simple rather than
forking, and defer to systemd to handle the forking. When systemd is
used, the -d/--daemonsafe flags are removed from service start commands
for p4p/p4broker/p4d, and for p4dtg the & is removed so the process is
not started in the background. For compatibility with non-systemd systems,
the -d/--daemonsafe flags are still applied when systemd is not in use.

With this change, systemd's concept of whether the service is running should
now be reliable.  If you try to start without using systemd on a system for
which a systemd unit file exists, an error is displayed -- a big, hopefully
useful and informative error message.

#review
#13 26399 C. Thomas Tyler Shellcheck compliance tweaks.

Fixed quoting bug in unrelease dev branch version.

Added startDelay to p4broker_base and p4p_base.
#12 23040 C. Thomas Tyler Enhancements to p4d_base:
* Added $LOGS/p4d_init.log to track calls to init.
* Increased verbosity somewhat, though the 'p4d -xvu' output still
goes only to the p4d_init.log, with an error message referencing
that log in event of error.
* Replaced old preflight log with standard LOGFILE for all tracking.
* Fixed issue starting server due to LOGFILE not being defined;
  not documented as a bug since it is a fix to unreleased behavior
  in the last change in the dev branch.
* Enhanced to automatically replace '-d' with '--daemonsafe' if p4d
  2017.1+
* Enhanced to call p4login rather than duplicating logic in p4login.

No rotation is provided for p4d_init.log; it is continuously appended
and is expected to grow only a few M per year with typical usage
(the bigger the server, the less the growth).

Enhancements to all *_base scripts:
* Enhanced so default behvaior, with no args, is to show a usage
message (rather than doing 'status').
#11 20572 C. Thomas Tyler Cosmetic fix: Eliminated harmless error from 'ls' in case where
'p4broker_N_init status all' is done when there are no
p4_N.broker.*.config files (i.e. those other than the default).
#10 20559 C. Thomas Tyler Fixed recent regression with 'restart' option in init scripts;
they now need to pass in the SDP_INSTANCE parameter.  Also
corrected usage messages.
#9 20491 C. Thomas Tyler Fixed an environment insulation bug in init scripts.

More testing (and thinking) revealed that the only way to truly
provide a guarantee of insulation from user-set defaults in
~perforce/.bashrc (etc.) is to pass SDP_INSTANCE as a parameter to
the *_base scripts, so that the instance name is explicitly passed
into the su/exec call (when run as root).

This change also includes minor cleanup in init scripts and *_base
scripts.
#8 20448 C. Thomas Tyler Fixed env bug seen when running init scripts as root.

Updated *_base scripts and *_init script templates to a new
standard.  Goals:

1. Init scripts that use corresponding *_base scripts are
minimized so that do nothing more than set SDP_INSTANCE and
then call the corresponding *_base script.

2. The 'su' commands always pass $* instead of $1, deferring
all processing to the *_base script.

3. The shell environment is now guaranteeds to have the same
results regardless of whether it is called as 'root' or as
the defined OSUSER.

4. The p4_vars file is always sourced exactly once.  Two
calls to 'source p4_vars' appear in some cases, one
immediatley before the su/exec call, and another after the
after the 'su/exec'.  Only one or the other is sourced.

5. All init scripts have a reasonably consistent usage message.

6. All init scripts accept a 'status' argument.

This change fixes a bug where 'p4broker_N_init status' run as the
'perforce' user would report many pids unrelated to Perforce
if run as root, e.g. doing 'service p4broker_N_init status'.

This also eliminates a potential issue where the 'perforce'
user might source a p4_vars with a default instance in ~/.profile
or ~/.bashrc, thus invalidating the instance specified when the
user ran the init script as root.
#7 18921 C. Thomas Tyler Enhanced broker init script to support multiple broker configs.
This can be used to easily shutdown a production broker and
replace it with a preconfigured "Down For Maintenance" broker
config file.

This change is backward-compatible with current typical usage.
#6 16029 C. Thomas Tyler Routine merge to dev from main using:
p4 merge -b perforce_software-sdp-dev
#5 15778 C. Thomas Tyler Routine Merge Down to dev from main.
#4 13906 C. Thomas Tyler Normalized P4INSTANCE to SDP_INSTANCE to get Unix/Windows
implementations in sync.

Reasons:
1. Things that interact with SDP in both Unix and Windows
environments shoudn't have to account for this obscure
SDP difference between Unix and Windows.  (I came across
this doing CBD work).

2. The Windows and Unix scripts have different variable
names for defining the same concept, the SDP instance.
Unix uses P4INSTANCE, while Windows uses SDP_INSTANCE.

3. This instance tag, a data set identifier, is an SDP concept.
I prefer the SDP_INSTANCE name over P4INSTANCE, so I prpose
to normalize to SDP_INSTANCE.

4. The P4INSTANCE name makes it look like a setting that might be
recognized by the p4d itself, which it is not.  (There are other
such things such as P4SERVER that could perhaps be renamed as
a separate task; but I'm not sure we want to totally disallow
the P4 prefix for variable names. It looks too right to be wrong
in same cases, like P4BIN and P4DBIN.  That's a discussion for
another day, outside the scope of this task).

Meanwhile:
* Fixed a bug in the Windows 2013.3 upgrade script that
was referencing undefined P4INSTANCE, as the Windows
environment defined only SDP_INSTANCE.

* Had P4INSTANCE been removed completely, this change would
likely cause trouble for users doing updates for existing
SDP installations.  So, though it involves slight technical debt,
I opted to keep a redundant definition of P4INSTANCE
in p4_vars.template, with comments indicating SDP_INSTANCE should be
used in favor of P4INSTANCE, with a warning that P4INSTANCE
may go away in a future release.  This should avoid unnecessary
upgrade pain.

* In mkdirs.sh, the varialbe name was INSTANCE rather than
SDP_INSTANCE.  I changed that as well.  That required manual
change rather than sub/replace to avoid corrupting other similar
varialbe names (e.g.  MASTERINSTANCE).

This is a trivial change technically (a substitute/replace, plus
tweaks in p4_vars.template), but impacts many files.
#3 12169 Russell C. Jackson (Rusty) Updated copyright date to 2015

 Updated shell scripts to require an instance parameter to eliminate the need
 for calling p4master_run.    Python and Perl still need it since you have to set the
environment for them to run in.

 Incorporated comments from reviewers. Left the . instead of source as that seems
more common in the field and has the same functionality.
#2 11469 Russell C. Jackson (Rusty) Changed CFG to P4BROKERCFG and moved it to the p4broker init script.
 Changed get_pids to look for P4BROKERCFG rather than P4BROKERBIN so
 that it only kills the broker instances running the config specified
 by the init script.

 This change makes it easy to just copy the p4broker_instance_init script
 and change the config file name to be able to run more than one broker
 per instance of Perforce. Useful to have one ssl and one non ssl broker.
#1 10638 C. Thomas Tyler Populate perforce_software-sdp-dev.
//guest/perforce_software/sdp/main/Server/Unix/p4/common/bin/p4broker_base
#1 10148 C. Thomas Tyler Promoted the Perforce Server Deployment Package to The Workshop.