p4p_base #2

  • //
  • guest/
  • russell_jackson/
  • sdp/
  • Server/
  • Unix/
  • p4/
  • common/
  • bin/
  • p4p_base
  • View
  • Commits
  • Open Download .zip Download (2 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 Proxy base init script

# Do nothing unless $SDP_INSTANCE is defined.
export SDP_INSTANCE=${1:-Unset}

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

# Load SDP controlled shell environment.
source /p4/common/bin/p4_vars "$SDP_INSTANCE"
if [[ $? -ne 0 ]]; then
   echo -e "\nError: Failed to load SDP environment for instance $SDP_INSTANCE.\n"
   exit 1
fi

source $P4CBIN/ps_functions.sh
if [[ $? -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 $P4PBIN ]]; then
   echo -e "\nError: $P4PBIN is not executable."
   exit 2;
fi

# Add and override values from p4_vars
export P4LOG=$LOGS/p4p.log
export P4P_FLAGS="-d -v proxy.monitor.level=$PROXY_MON_LEVEL -p $PROXY_PORT -r $P4PCACHE -t $PROXY_TARGET -u $P4SERVICEUSER -e 3072 -L $P4LOG"

case "${2:-status}" in
   start)
      echo "Starting ${P4PBIN} ${P4P_FLAGS}"
      ${P4PBIN} ${P4P_FLAGS}
   ;;

   status)
      p4p_pids=$(get_pids "$P4PBIN")
      if [[ -n "$p4p_pids" ]]; then
         echo "${P4PBIN} is running as pids: $p4p_pids."
         exit 0
      else
         echo "${P4PBIN} is NOT running."
         exit 1
      fi
   ;;

   stop)
      p4p_pids=$(get_pids "$P4PBIN")

      if [[ -n "$p4p_pids" ]]; then
         while [[ -n "$p4p_pids" ]]; do
            echo "Shutting down ${P4PBIN} pids: $p4p_pids."
            kill $p4p_pids 2>&1 | $GREP -v -i "No such"
            sleep 1
            p4p_pids=$(get_pids "$P4PBIN")
         done
         echo "${P4PBIN} stopped."
         exit 0
      else
         echo "${P4PBIN} was NOT running."
         exit 1
      fi
   ;;
   restart)
      $0 $SDP_INSTANCE stop
      $0 $SDP_INSTANCE start
   ;;
   *)
      echo -e "\nUsage: $0 SDP_INSTANCE {start|stop|status|restart}\n"
      exit 1
   ;;
esac
# Change User Description Committed
#2 22981 Russell C. Jackson (Rusty) Made files writeable so they are easier to update once on the server.
#1 22693 Russell C. Jackson (Rusty) Branched a Unix only version of the SDP.
Removed extra items to create a cleaner tree.
Moved a few items around to make more sense without Windows in the mix.
//guest/perforce_software/sdp/dev/Server/Unix/p4/common/bin/p4p_base
#11 21808 C. Thomas Tyler Routine merge down to dev from main, picking up change from akwan:

update p4p_base to incorporate proxy monitoring and set default value in p4_vars
#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 16458 C. Thomas Tyler Routine Merge Down to dev from main using:
p4 merge -b perforce_software-sdp-dev
#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 10852 Domenic Base proxy script updates.
- Remove p4broker references.
- Fix "stop" command for the service to get p4p_pids instead of p4broker_pids.
#1 10638 C. Thomas Tyler Populate perforce_software-sdp-dev.
//guest/perforce_software/sdp/main/Server/Unix/p4/common/bin/p4p_base
#1 10148 C. Thomas Tyler Promoted the Perforce Server Deployment Package to The Workshop.