./0000755000000000000000000000000013320062075007707 5ustar rootroot./pkgs/0000755000000000000000000000000013320062075010653 5ustar rootroot./pkgs/VRTSvcsdctm.rte.bff0000755000000000000000000113000013320062075014303 0ustar rootroot k('K'Kby nameby nameisvbuildd k'K'K'K ./lpp_nameem4 R I VRTSvcsdctm.rte { VRTSvcsdctm.rte 5.1.0.0 1 N U en_US Veritas High Availability Agent 5.1 for Documentum by Symantec [ % /opt/VRTSvcs 584 /etc/VRTSvcs 32 /usr/lpp 24 % ] } k/'K'K'K /./usr/lpp/VRTSvcsdctm.rte/liblpp.a/p 11926 0 0 128 7806 0 900 1160 0 1260905670 0 0 644 18 VRTSvcsdctm.rte.al` ./etc ./etc/VRTSvcs ./etc/VRTSvcs/conf ./etc/VRTSvcs/conf/sample_ConnectionBroker ./etc/VRTSvcs/conf/sample_ContentServer ./opt ./opt/VRTSvcs ./opt/VRTSvcs/bin ./opt/VRTSvcs/bin/ConnectionBroker ./opt/VRTSvcs/bin/ContentServer ./opt/VRTSvcs/messages ./opt/VRTSvcs/messages/en ./etc/VRTSvcs/conf/sample_ConnectionBroker/DocumentumTypes.cf ./etc/VRTSvcs/conf/sample_ConnectionBroker/main.cf ./etc/VRTSvcs/conf/sample_ContentServer/DocumentumTypes.cf ./etc/VRTSvcs/conf/sample_ContentServer/main.cf ./opt/VRTSvcs/bin/ConnectionBroker/ConnectionBroker.pm ./opt/VRTSvcs/bin/ConnectionBroker/ConnectionBroker.xml ./opt/VRTSvcs/bin/ConnectionBroker/monitor ./opt/VRTSvcs/bin/ContentServer/ContentServer.pm ./opt/VRTSvcs/bin/ContentServer/ContentServer.xml ./opt/VRTSvcs/bin/ContentServer/monitor ./opt/VRTSvcs/messages/en/VRTSvcsAIXConnectionBroker.bmc ./opt/VRTSvcs/messages/en/VRTSvcsAIXContentServer.bmc 895 2196 128 1260905670 0 0 555 25 VRTSvcsdctm.rte.copyright` Copyright: Copyright (c) 2009 Symantec Corporation. All rights reserved. THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF SYMANTEC CORPORATION. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SYMANTEC CORPORATION. The Licensed Software and Documentation are deemed to be commercial computer software as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19 "Commercial Computer Software - Restricted Rights" and DFARS 227.7202, "Rights in Commercial Computer Software or Commercial Computer Software Documentation", as applicable, and any successor regulations. Any use, modification, reproduction release, performance, display or disclosure of the Licensed Software and Documentation by the U.S. Government shall be solely in accordance with the terms of this Agreement. 4363 6700 1160 1260905670 0 0 644 25 VRTSvcsdctm.rte.inventory` /etc: class=apply,inventory,VRTSvcsdctm owner=root group=system type=DIRECTORY /etc/VRTSvcs: class=apply,inventory,VRTSvcsdctm owner=root group=system type=DIRECTORY /etc/VRTSvcs/conf: class=apply,inventory,VRTSvcsdctm owner=root group=system type=DIRECTORY /etc/VRTSvcs/conf/sample_ConnectionBroker: class=apply,inventory,VRTSvcsdctm owner=root group=system type=DIRECTORY /etc/VRTSvcs/conf/sample_ContentServer: class=apply,inventory,VRTSvcsdctm owner=root group=system type=DIRECTORY /opt: class=apply,inventory,VRTSvcsdctm owner=root group=system type=DIRECTORY /opt/VRTSvcs: class=apply,inventory,VRTSvcsdctm owner=root group=system type=DIRECTORY /opt/VRTSvcs/bin: class=apply,inventory,VRTSvcsdctm owner=root group=system type=DIRECTORY /opt/VRTSvcs/bin/ConnectionBroker: class=apply,inventory,VRTSvcsdctm owner=root group=system type=DIRECTORY /opt/VRTSvcs/bin/ContentServer: class=apply,inventory,VRTSvcsdctm owner=root group=system type=DIRECTORY /opt/VRTSvcs/messages: class=apply,inventory,VRTSvcsdctm owner=root group=system type=DIRECTORY /opt/VRTSvcs/messages/en: class=apply,inventory,VRTSvcsdctm owner=root group=system type=DIRECTORY /etc/VRTSvcs/conf/sample_ConnectionBroker/DocumentumTypes.cf: class=apply,inventory,VRTSvcsdctm owner=root group=system type=FILE size=810 checksum=20919 1 /etc/VRTSvcs/conf/sample_ConnectionBroker/main.cf: class=apply,inventory,VRTSvcsdctm owner=root group=system type=FILE size=3038 checksum=49500 3 /etc/VRTSvcs/conf/sample_ContentServer/DocumentumTypes.cf: class=apply,inventory,VRTSvcsdctm owner=root group=system type=FILE size=835 checksum=05554 1 /etc/VRTSvcs/conf/sample_ContentServer/main.cf: class=apply,inventory,VRTSvcsdctm owner=root group=system type=FILE size=3038 checksum=49500 3 /opt/VRTSvcs/bin/ConnectionBroker/ConnectionBroker.pm: class=apply,inventory,VRTSvcsdctm owner=root group=system type=FILE size=95087 checksum=41805 93 /opt/VRTSvcs/bin/ConnectionBroker/ConnectionBroker.xml: class=apply,inventory,VRTSvcsdctm owner=root group=system type=FILE size=11308 checksum=06564 12 /opt/VRTSvcs/bin/ConnectionBroker/monitor: class=apply,inventory,VRTSvcsdctm owner=root group=system type=FILE size=18306 checksum=10872 18 /opt/VRTSvcs/bin/ConnectionBroker/online: class=apply,inventory,VRTSvcsdctm owner=root group=system type=SYMLINK target=/opt/VRTSvcs/bin/ConnectionBroker/monitor /opt/VRTSvcs/bin/ConnectionBroker/offline: class=apply,inventory,VRTSvcsdctm owner=root group=system type=SYMLINK target=/opt/VRTSvcs/bin/ConnectionBroker/monitor /opt/VRTSvcs/bin/ConnectionBroker/clean: class=apply,inventory,VRTSvcsdctm owner=root group=system type=SYMLINK target=/opt/VRTSvcs/bin/ConnectionBroker/monitor /opt/VRTSvcs/bin/ContentServer/ContentServer.pm: class=apply,inventory,VRTSvcsdctm owner=root group=system type=FILE size=107090 checksum=43410 105 /opt/VRTSvcs/bin/ContentServer/ContentServer.xml: class=apply,inventory,VRTSvcsdctm owner=root group=system type=FILE size=9753 checksum=39502 10 /opt/VRTSvcs/bin/ContentServer/monitor: class=apply,inventory,VRTSvcsdctm owner=root group=system type=FILE size=17908 checksum=59817 18 /opt/VRTSvcs/bin/ContentServer/online: class=apply,inventory,VRTSvcsdctm owner=root group=system type=SYMLINK target=/opt/VRTSvcs/bin/ContentServer/monitor /opt/VRTSvcs/bin/ContentServer/offline: class=apply,inventory,VRTSvcsdctm owner=root group=system type=SYMLINK target=/opt/VRTSvcs/bin/ContentServer/monitor /opt/VRTSvcs/bin/ContentServer/clean: class=apply,inventory,VRTSvcsdctm owner=root group=system type=SYMLINK target=/opt/VRTSvcs/bin/ContentServer/monitor /opt/VRTSvcs/messages/en/VRTSvcsAIXConnectionBroker.bmc: class=apply,inventory,VRTSvcsdctm owner=root group=system type=FILE size=6406 checksum=43477 7 /opt/VRTSvcs/messages/en/VRTSvcsAIXContentServer.bmc: class=apply,inventory,VRTSvcsdctm owner=root group=system type=FILE size=6691 checksum=47715 7 /opt/VRTSvcs/bin/ConnectionBroker/ConnectionBrokerAgent: class=apply,inventory,VRTSvcsdctm owner=root group=system type=SYMLINK target=/opt/VRTSvcs/bin/ScriptAgent /opt/VRTSvcs/bin/ContentServer/ContentServerAgent: class=apply,inventory,VRTSvcsdctm owner=root group=system type=SYMLINK target=/opt/VRTSvcs/bin/ScriptAgent 970 7806 2196 1260905670 0 0 555 22 VRTSvcsdctm.rte.post_i` #!/bin/sh # # $Id: # #------------------------- # Set VCS base directories #------------------------- if [ ! -d "${VCS_HOME}" ]; then VCS_HOME=/opt/VRTSvcs fi if [ ! -d "${VCS_ETC}" ]; then VCS_ETC=/etc/VRTSvcs fi #-------------------------------------------------------- # Re-create the BMC map with the newly installed messages #-------------------------------------------------------- cd ${VCS_HOME}/messages/en ${VCS_HOME}/bin/bmcmap -create en HAD -path ${VCS_HOME}/messages/en # # $Id: # #------------------------- # Set VCS base directories #------------------------- if [ ! -d "${VCS_HOME}" ]; then VCS_HOME=/opt/VRTSvcs fi if [ ! -d "${VCS_ETC}" ]; then VCS_ETC=/etc/VRTSvcs fi #-------------------------------------------------------- # Re-create the BMC map with the newly installed messages #-------------------------------------------------------- cd ${VCS_HOME}/messages/en ${VCS_HOME}/bin/bmcmap -create en HAD -path ${VCS_HOME}/messages/en 3981 11926 6700 1260905670 0 0 555 23 VRTSvcsdctm.rte.unpre_i` #!/bin/sh # # $Id: # #---------------------------------- # Configurable settings: # Define agent name #---------------------------------- AgentName=ConnectionBroker #------------------------- # Set VCS base directories #------------------------- if [ ! -d "${VCS_HOME}" ]; then VCS_HOME=/opt/VRTSvcs fi if [ ! -d "${VCS_ETC}" ]; then VCS_ETC=/etc/VRTSvcs fi #---------------------- # Set Agent directories #---------------------- AgentDirectories="${VCS_HOME}/bin/${AgentName} ${VCS_ETC}/conf/sample_${AgentName}" #------------------------- # Set Agent symbolic links #------------------------- AgentFilesToRemove="${AgentName}Agent online offline clean core" #----------------------------------------------------------------------------- # ****** No further configurable settings ****** #----------------------------------------------------------------------------- #-------------------------------------------- # Define full paths to commands and constants #-------------------------------------------- RM=/bin/rm RMDIR=/bin/rmdir LS=/bin/ls #------------------- # Update the BMC map #------------------- cd ${VCS_HOME}/messages/en ${VCS_HOME}/bin/bmcmap -create en HAD -path ${VCS_HOME}/messages/en #----------------------------------------------------------- # Remove the agent's symbolic links if they are still around #----------------------------------------------------------- for AgentFileToRemove in ${AgentFilesToRemove} do ${RM} -f ${VCS_HOME}/bin/${AgentName}/${AgentFileToRemove} done #----------------------------- # Remove the agent directories #----------------------------- for AgentDir in ${AgentDirectories} do if [ -d ${AgentDir} ]; then AgentDirContentList=`${LS} ${AgentDir}` if [ -z "${AgentDirContentList}" ]; then ${RMDIR} ${AgentDir} || echo "Warning: Problems removing directory [${AgentDir}]" else echo "Notice: Directory [${AgentDir}] is not empty and will not be removed." fi fi done # # $Id: # #---------------------------------- # Configurable settings: # Define agent name #---------------------------------- AgentName=ContentServer #------------------------- # Set VCS base directories #------------------------- if [ ! -d "${VCS_HOME}" ]; then VCS_HOME=/opt/VRTSvcs fi if [ ! -d "${VCS_ETC}" ]; then VCS_ETC=/etc/VRTSvcs fi #---------------------- # Set Agent directories #---------------------- AgentDirectories="${VCS_HOME}/bin/${AgentName} ${VCS_ETC}/conf/sample_${AgentName}" #------------------------- # Set Agent symbolic links #------------------------- AgentFilesToRemove="${AgentName}Agent online offline clean core" #----------------------------------------------------------------------------- # ****** No further configurable settings ****** #----------------------------------------------------------------------------- #-------------------------------------------- # Define full paths to commands and constants #-------------------------------------------- RM=/bin/rm RMDIR=/bin/rmdir LS=/bin/ls #------------------- # Update the BMC map #------------------- cd ${VCS_HOME}/messages/en ${VCS_HOME}/bin/bmcmap -create en HAD -path ${VCS_HOME}/messages/en #----------------------------------------------------------- # Remove the agent's symbolic links if they are still around #----------------------------------------------------------- for AgentFileToRemove in ${AgentFilesToRemove} do ${RM} -f ${VCS_HOME}/bin/${AgentName}/${AgentFileToRemove} done #----------------------------- # Remove the agent directories #----------------------------- for AgentDir in ${AgentDirectories} do if [ -d ${AgentDir} ]; then AgentDirContentList=`${LS} ${AgentDir}` if [ -z "${AgentDirContentList}" ]; then ${RMDIR} ${AgentDir} || echo "Warning: Problems removing directory [${AgentDir}]" else echo "Notice: Directory [${AgentDir}] is not empty and will not be removed." fi fi done 238 0 7806 0 0 0 0 0 ` 5 128 1160 2196 6700 7806 VRTSvcsdctm.rte.alVRTSvcsdctm.rte.copyrightVRTSvcsdctm.rte.inventoryVRTSvcsdctm.rte.post_iVRTSvcsdctm.rte.unpre_i-- k7A'K'K'K ./etclpA kNkA'K'K'K ./etc/VRTSvcsvcSTA kn A'K'K'K ./etc/VRTSvcs/conftm.rtSTA krNA'K'K'K ./etc/VRTSvcs/conf/sample_ConnectionBrokerSTA kA'K'K'K ./etc/VRTSvcs/conf/sample_ContentServerSTA kx%A'K'K'K ./optVRA kA'K'K'K ./opt/VRTSvcscoSTA kA'K'K'K ./opt/VRTSvcs/bin/samplSTA k2gA'K'K'K ./opt/VRTSvcs/bin/ConnectionBrokerrverSTA kЛA'K'K'K ./opt/VRTSvcs/bin/ContentServerSTA kA'K'K'K ./opt/VRTSvcs/messagesnSTA kpOA'K'K'K ./opt/VRTSvcs/messages/enerverSTA k*'K'K'K *./etc/VRTSvcs/conf/sample_ConnectionBroker/DocumentumTypes.cfSTtype ContentServer ( static str ArgList[] = { ResLogLevel, State, IState, DocbaseName, DMBase, InitFile, DMUser, EnvFile, JavaHome, MonitorProgram, SecondLevelMonitor } str ResLogLevel = INFO str DocbaseName str DMBase str InitFile str DMUser str EnvFile = "/dev/null" str JavaHome str MonitorProgram int SecondLevelMonitor = 0 ) type ConnectionBroker ( static str ArgList[] = { ResLogLevel, State, IState, CBName, DMHome, DMBase, CBHost, CBPort, InitFile, DMUser, Password, EnvFile, MonitorProgram, SecondLevelMonitor } str ResLogLevel = INFO str CBName str DMHome str DMBase str CBHost int CBPort = 1489 str InitFile str DMUser str Password str EnvFile = "/dev/null" str MonitorProgram int SecondLevelMonitor = 0 ) rm RMD kf 'K'K'K  ./etc/VRTSvcs/conf/sample_ConnectionBroker/main.cfumTypSTinclude "types.cf" include "DocumentumTypes.cf" cluster VCS_Cluster ( UserNames = { admin = user1 } Administrators = { admin } ) system vcshost1 ( ) system vcshost2 ( ) group DCM652-CVRCS1 ( SystemList = { vcshost1 = 0 } ClusterList = { abc = 0, bcd = 1 } Authority = 1 ClusterFailOverPolicy = Auto ) ContentServer DCM652-CVRCS1_cs ( Critical = 0 DocbaseName = REPCVR DMBase = "/documentum/dba" InitFile = "/documentum/dba/config/REPCVR/server.ini" DMUser = cvradm EnvFile = "/home/cvradm/.profile" ) DiskGroup DCM652-CVRCS1_dg ( Critical = 0 DiskGroup = dcm652cvr_dg ) IP DCM652-CVRCS1_ip ( Critical = 0 Device = bge0 Address = "100.2.162.198" NetMask = "255.255.255.0" ) Mount DCM652-CVRCS1_mnt ( Critical = 0 MountPoint = "/documentum/data" BlockDevice = "/dev/vx/dsk/dcm652cvr_dg/dcm652cvr_vol" FSType = vxfs FsckOpt = "-y" ) NIC DCM652-CVRCS1_nic ( Critical = 1 Device = beg0 NetworkHosts = { "231.29.68.21" } ) requires group DCM652-CVRCB1 online global soft DCM652-CVRCS1_cs requires DCM652-CVRCS1_ip DCM652-CVRCS1_cs requires DCM652-CVRCS1_mnt DCM652-CVRCS1_ip requires DCM652-CVRCS1_nic DCM652-CVRCS1_mnt requires DCM652-CVRCS1_dg // resource dependency tree // // group DCM652-CVRCS1 // { // ContentServer DCM652-CVRCS1_cs // { // IP DCM652-CVRCS1_ip // { // NIC DCM652-CVRCS1_nic // } // Mount DCM652-CVRCS1_mnt // { // DiskGroup DCM652-CVRCS1_dg // } // } // } group DCM652-CVRCB1 ( SystemList = { vcshost1 = 0 } ) ConnectionBroker DCM652-CVRCB1_broker ( Critical = 0 CBName = Docbroker DMHome = "/documentum/product/6.5/" DMBase = "/documentum/dba" CBHost = vcsax014 InitFile = "/documentum/dba/Docbroker.ini" DMUser = cvradm Password = aogMdoDkpGbgCgdGe EnvFile = "/home/cvradm/.bashrc" ) IP DCM652-CVRCB1_ip ( Critical = 0 Device = bge0 Address = "100.2.162.198" NetMask = "255.255.255.0" ) NIC DCM652-CVRCB1_nic ( Critical = 1 Device = beg0 NetworkHosts = { "231.29.68.21" } ) DCM652-CVRCB1_broker requires DCM652-CVRCB1_ip DCM652-CVRCB1_ip requires DCM652-CVRCB1_nic // resource dependency tree // // group DCM652-CVRCB1 // { // ConnetionBroker DCM652-CVRCB1_broker // { // IP DCM652-CVRCB1_ip // { // NIC DCM652-CVRCB1_nic // } // } // } -- khC'K'K'K C./etc/VRTSvcs/conf/sample_ContentServer/DocumentumTypes.cfcfSTtype ConnectionBroker ( static str ArgList[] = { ResLogLevel, State, IState, CBName, DMHome, DMBase, CBHost, CBPort, InitFile, DMUser, Password, EnvFile, MonitorProgram, SecondLevelMonitor } str ResLogLevel = INFO str CBName str DMHome str DMBase str CBHost int CBPort = 1489 str InitFile str DMUser str Password str EnvFile = "/dev/null" str MonitorProgram int SecondLevelMonitor = 0 ) type ContentServer ( static str ArgList[] = { ResLogLevel, State, IState, DocbaseName, DMBase, InitFile, DMUser, EnvFile, JavaHome, MonitorProgram, SecondLevelMonitor } str ResLogLevel = INFO str DocbaseName str DMBase str InitFile str DMUser str EnvFile = "/dev/null" str JavaHome str MonitorProgram int SecondLevelMonitor = 0 ) Blo kX 'K'K'K  ./etc/VRTSvcs/conf/sample_ContentServer/main.cfSTinclude "types.cf" include "DocumentumTypes.cf" cluster VCS_Cluster ( UserNames = { admin = user1 } Administrators = { admin } ) system vcshost1 ( ) system vcshost2 ( ) group DCM652-CVRCS1 ( SystemList = { vcshost1 = 0 } ClusterList = { abc = 0, bcd = 1 } Authority = 1 ClusterFailOverPolicy = Auto ) ContentServer DCM652-CVRCS1_cs ( Critical = 0 DocbaseName = REPCVR DMBase = "/documentum/dba" InitFile = "/documentum/dba/config/REPCVR/server.ini" DMUser = cvradm EnvFile = "/home/cvradm/.profile" ) DiskGroup DCM652-CVRCS1_dg ( Critical = 0 DiskGroup = dcm652cvr_dg ) IP DCM652-CVRCS1_ip ( Critical = 0 Device = bge0 Address = "100.2.162.198" NetMask = "255.255.255.0" ) Mount DCM652-CVRCS1_mnt ( Critical = 0 MountPoint = "/documentum/data" BlockDevice = "/dev/vx/dsk/dcm652cvr_dg/dcm652cvr_vol" FSType = vxfs FsckOpt = "-y" ) NIC DCM652-CVRCS1_nic ( Critical = 1 Device = beg0 NetworkHosts = { "231.29.68.21" } ) requires group DCM652-CVRCB1 online global soft DCM652-CVRCS1_cs requires DCM652-CVRCS1_ip DCM652-CVRCS1_cs requires DCM652-CVRCS1_mnt DCM652-CVRCS1_ip requires DCM652-CVRCS1_nic DCM652-CVRCS1_mnt requires DCM652-CVRCS1_dg // resource dependency tree // // group DCM652-CVRCS1 // { // ContentServer DCM652-CVRCS1_cs // { // IP DCM652-CVRCS1_ip // { // NIC DCM652-CVRCS1_nic // } // Mount DCM652-CVRCS1_mnt // { // DiskGroup DCM652-CVRCS1_dg // } // } // } group DCM652-CVRCB1 ( SystemList = { vcshost1 = 0 } ) ConnectionBroker DCM652-CVRCB1_broker ( Critical = 0 CBName = Docbroker DMHome = "/documentum/product/6.5/" DMBase = "/documentum/dba" CBHost = vcsax014 InitFile = "/documentum/dba/Docbroker.ini" DMUser = cvradm Password = aogMdoDkpGbgCgdGe EnvFile = "/home/cvradm/.bashrc" ) IP DCM652-CVRCB1_ip ( Critical = 0 Device = bge0 Address = "100.2.162.198" NetMask = "255.255.255.0" ) NIC DCM652-CVRCB1_nic ( Critical = 1 Device = beg0 NetworkHosts = { "231.29.68.21" } ) DCM652-CVRCB1_broker requires DCM652-CVRCB1_ip DCM652-CVRCB1_ip requires DCM652-CVRCB1_nic // resource dependency tree // // group DCM652-CVRCB1 // { // ConnetionBroker DCM652-CVRCB1_broker // { // IP DCM652-CVRCB1_ip // { // NIC DCM652-CVRCB1_nic // } // } // } -- k<os'K'K'K os./opt/VRTSvcs/bin/ConnectionBroker/ConnectionBroker.pm.ST#------------------------------------------------------------------ # $Copyright: Copyright (c) 2009 Symantec Corporation. # All rights reserved. # # THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF # SYMANTEC CORPORATION. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED # WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SYMANTEC CORPORATION. # # The Licensed Software and Documentation are deemed to be commercial # computer software as defined in FAR 12.212 and subject to restricted # rights as defined in FAR Section 52.227-19 "Commercial Computer # Software - Restricted Rights" and DFARS 227.7202, "Rights in # Commercial Computer Software or Commercial Computer Software # Documentation", as applicable, and any successor regulations. Any use, # modification, reproduction release, performance, display or disclosure # of the Licensed Software and Documentation by the U.S. Government # shall be solely in accordance with the terms of this Agreement. $ # # $Header: /project/isv-agent/VProAgents/ConnectionBroker/ConnectionBroker.pm,v 1.2 2009/12/10 09:30:09 rkumar Exp $ # # $sAuthor: $ # # $Date: 2009/12/10 09:30:09 $ # $Revision: 1.2 $ # # Provides: ConnectionBroker # Author: rajeevk # crAgent Build: 1.91 2009/09/07 08:42:27 # crAgent Run Date: 12 Nov, 2009 # Modification History: # Known bugs/caveats: #------------------------------------------------------------------ #------------ # Be strict.. #------------ use strict; #---------------------- # Declare the package.. #---------------------- package ConnectionBroker; use ag_i18n_inc; #------------------------------------- # Include required framework modules.. #------------------------------------- use Sys; # Support generalized UNIX commands use Proc; # For calls to the process routines use Comms; # For calls to socket(3C) routines use Version; # Version display generator use VCSagentFW; # Primary Agent Interface to the ACC Library use VCSDefines; # This contains constants that VCS uses #-------------------------------- # Include standard PERL modules.. #-------------------------------- use Fcntl; use Socket; use File::Path qw ( mkpath ); use File::stat; my ( $CLUS_HOME, $sPrefix ) = (); #------------------------ # Setup VCS/VCSone home.. #------------------------ if ( $ENV { CLUSTER_HOME } ) { # VCS 5.x/VCSOne.. $CLUS_HOME ||= $ENV { CLUSTER_HOME } ||= "/opt/VRTSvcsone"; } else { # VCS 4.x.. $CLUS_HOME ||= $ENV { VCS_HOME } ||= "/opt/VRTSvcs"; } ( $sPrefix ) = $CLUS_HOME =~ /.*(vad|vcs(|one))$/; #----------------------------------------- # Define module-vendor specific commands.. #----------------------------------------- my $sCmdHares = $HARES ||= "$CLUS_HOME/bin/hares"; my $sCmdHatype = $HATYPE ||= "$CLUS_HOME/bin/hatype"; my $sCmdVcsDecrypt = "$CLUS_HOME/sbin/${sPrefix}decrypt"; my @liRunningProcs = (); # Global.. #----------------------------------------------------------------------- # Add our version number to the version hash and check if versions are # requested.. #----------------------------------------------------------------------- my $sVer = "\$Id: ConnectionBroker.pm,v 1.2 2009/12/10 09:30:09 rkumar Exp $::ETVHeader"; Version::TellVersion ( $sVer ); #-------------------------------- # Define ConnectionBroker subroutines.. #-------------------------------- =pod ------------------------------------------------------------------------------------------------------ Function : bool ArgsValid ( IN String EntryPointName, IN String CBName, IN String DMHome, IN String DMBase, IN String CBHost, IN Integer CBPort, IN String InitFile, IN String DMUser, IN String Password, IN String EnvFile, IN String MonitorProgram, IN Integer SecondLevelMonitor ); Description : Validates the ArgList passed to the entry point. Parameters : $sEntryPointName Entry point name $localCBName Documentum connection broker name managed by cluster server agent $localDMHome Absolute path of documentum product installation $localDMBase Absolute path of documentum connection broker binaries $localCBHost Hostname of virtual host for Documentum connection broker $localCBPort The port on which the Documentum connection broker listens $localInitFile The server initialization file for the Documentum connection broker $localDMUser Unix user owner for Documentum connection broker $localPassword Encrypted password for teh documentum user. $localEnvFile Absolute path to environment file to source $localMonitorProgram Full path to external monitor program $localSecondLevelMonitor Cycle count to run in-depth monitoring Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------------ =cut sub ArgsValid { #---------------------------------------- # Set up local vars from passed in ones.. #---------------------------------------- my ( $sEntryPointName, $localCBName, $localDMHome, $localDMBase, $localCBHost, $localCBPort, $localInitFile, $localDMUser, $localPassword, $localEnvFile, $localMonitorProgram, $localSecondLevelMonitor ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20001, "Subroutine <%s> called with: EntryPointName [%s] CBName [%s] DMHome [%s] DMBase [%s] CBHost [%s] CBPort [%s] InitFile [%s] DMUser [%s] Password [%s] EnvFile [%s] MonitorProgram [%s] SecondLevelMonitor [%s]", $sMyName, $sEntryPointName, $localCBName, $localDMHome, $localDMBase, $localCBHost, $localCBPort, $localInitFile, $localDMUser, $localPassword, $localEnvFile, $localMonitorProgram, $localSecondLevelMonitor ); #------------------------------------- # Set return code to hopeful success.. #------------------------------------- my $iReturnCode = 1; #-------------------------------------------- # Create hash to weed out empty args values.. #-------------------------------------------- my ( @lsMissing, %hsArgList ) = (); my @lsArgs = qw ( EntryPointName CBName DMHome DMBase CBHost CBPort InitFile DMUser Password EnvFile MonitorProgram SecondLevelMonitor ); @hsArgList { @lsArgs } = @_; # Assign.. #---------------------------------------- # Reqd. attributes based on entry point.. #---------------------------------------- my @lsOnlineArgs = qw ( CBName DMBase DMUser EnvFile InitFile ); my @lsOfflineArgs = qw ( CBName DMBase DMUser EnvFile ); my @lsMonitorArgs = qw ( CBName DMUser InitFile ); my @lsCleanArgs = qw ( CBName DMUser InitFile ); my %hlsNeeded = ( 'online' => \@lsOnlineArgs, 'offline' => \@lsOfflineArgs, 'monitor' => \@lsMonitorArgs, 'clean' => \@lsCleanArgs ); my @lsReqdArgs = @{ $hlsNeeded { $sEntryPointName } }; #----------------------- # Check what's missing.. #----------------------- if ( @lsMissing = grep { $hsArgList { $_ } !~ /\S/o } @lsReqdArgs ) { &logError ( 20002, "<%s> The following mandatory fields were not set [%s], Total [%s]", $sMyName, join ( ' ', @lsMissing ), scalar @lsMissing ); $iReturnCode = 0; # Failure.. } $iReturnCode || return $iReturnCode; # Return, if failed.. #----------------------------- # Remove SLM file, if exists.. #----------------------------- if ( $sEntryPointName ne 'monitor' ) { VCSagentFW::RunSecondLevelMonitor ( 1 ); # Delete.. } #------------------------------- # Individual validation starts.. #------------------------------- #----------------------------------------------- # Validation for online offline entry point(s).. #----------------------------------------------- if ( $sEntryPointName =~ /^(online|offline)$/o ) { #----------------------------- # Validate parameter EnvFile.. #----------------------------- if ( ! -e $localEnvFile ) { &logError ( 20003, "<%s> EnvFile [%s] file does not exist", $sMyName, $localEnvFile ); $iReturnCode = 0; # Failure.. } if ( ! -e $localDMBase ) { &logError ( 20004, "<%s> DMBase [%s] does not exist", $sMyName, $localDMBase ); $iReturnCode = 0; # Failure.. } #-------------------------- # Validate parameter DMUser.. #-------------------------- if ( ! defined getpwnam $localDMUser ) { &logError ( 20005, "<%s> DMUser [%s] is not a valid UNIX login", $sMyName, $localDMUser ); $iReturnCode = 0; # Failure.. } } #--------------------------------------- # Validation for online entry point(s).. #--------------------------------------- if ( $sEntryPointName eq "online" ) { #------------------------------------ # Validate parameter MonitorProgram.. #------------------------------------ if ( ! -e $localInitFile ) { &logError ( 20006, "<%s> Init File [%s] for connection broker does not exist", $sMyName, $localInitFile ); $iReturnCode = 0; # Failure.. } if ( $localMonitorProgram =~ /(\S+)/ && # Defined.. ! -x $1 ) { &logError ( 20007, "<%s> MonitorProgram [%s] is not executable", $sMyName, $1 ); $iReturnCode = 0; # Failure.. } } $iReturnCode || &logWarn ( 20008, "<%s> Some of the attributes could not be validated. Returning [%s]", $sMyName, $iReturnCode ); return $iReturnCode ; } =pod ------------------------------------------------------------------------------------------------------ Function : bool Start ( IN String CBHost, IN String CBName, IN Integer CBPort, IN String DMBase, IN String DMHome, IN String DMUser, IN String EnvFile, IN String InitFile, IN String MonitorProgram, IN Integer SecondLevelMonitor ); Description : Start logic needed for online entry piont Parameters : $sCBHost Hostname of virtual host for Documentum connection broker $sCBName Documentum connection broker name managed by cluster server agent $iCBPort The port on which the Documentum connection broker listens $sDMBase Absolute path of documentum connection broker binaries $sDMHome Absolute path of documentum product installation $sDMUser Unix user owner for Documentum connection broker $sEnvFile Absolute path to environment file to source $sInitFile The server initialization file for the Documentum connection broker $sMonitorProgram Full path to external monitor program $iSecondLevelMonitor Cycle count to run in-depth monitoring Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------------ =cut sub Start { #---------------- # Get Arguments.. #---------------- my ( $sCBHost, $sCBName, $iCBPort, $sDMBase, $sDMHome, $sDMUser, $sEnvFile, $sInitFile, $sMonitorProgram, $iSecondLevelMonitor ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20009, "Subroutine <%s> called with: CBHost [%s] CBName [%s] CBPort [%s] DMBase [%s] DMHome [%s] DMUser [%s] EnvFile [%s] InitFile [%s] SecondLevelMonitor [%s]", $sMyName, $sCBHost, $sCBName, $iCBPort, $sDMBase, $sDMHome, $sDMUser, $sEnvFile, $sInitFile, $iSecondLevelMonitor ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; #------------------------- # Define local variables.. #------------------------- my ( $sCommand, $sCommandArgs, $iTillWhen, $iExitCode, $iTimeout, @lsCmdout, @liPids ) = (); #----------------------------------------- # Whack any preexisting ConnectionBroker processes.. #----------------------------------------- &logTrace ( 20010, "<%s> Killing ConnectionBroker processes for this instance", $sMyName ); if ( ConnectionBroker::KillConnectionBrokerProcesses ( $sDMUser, $sInitFile ) ) { &logTrace ( 20011, "<%s> Processes for this instance do not exist before start-up", $sMyName ); } else { &logError ( 20012, "<%s> Could not remove all processes for this instance. Exiting", $sMyName ); $iReturnCode = 0; # Failure.. } #-------------------- # Return, if failed.. #-------------------- $iReturnCode || return $iReturnCode; #--------------------------------------------------------------------- # Upper bound.. Time in EPOCH when entry pt started + VCS time limit.. #--------------------------------------------------------------------- $iTillWhen = $^T + ConnectionBroker::GetEngineTimeout ( 1 ); #------------------------------------------ # Define start command and args variables.. #------------------------------------------ $sCommand = "$sDMBase/dm_launch_$sCBName"; $sCommandArgs = "-init_file $sInitFile"; ( @lsCmdout, $iExitCode, $iTimeout ) = (); &logTrace ( 20013, "<%s> Starting ConnectionBroker instance with Cmd [%s] Args [%s]", $sMyName, $sCommand, $sCommandArgs ); #------------------ # Request startup.. #------------------ if ( ( $iTimeout = $iTillWhen - time ) <= 10 ) { # Get time bearings.. &logError ( 20014, "<%s> Insufficient time to continue boot up. Short by [%s] sec", $sMyName, abs ( $iTimeout ) ); $iReturnCode = 0; # Failure.. } elsif ( $iReturnCode = ConnectionBroker::ExecLocalCmd ( $sDMUser, $sEnvFile, $sCommand, $sCommandArgs, \$iExitCode, $iTimeout, \@lsCmdout ) ) { &logTrace ( 20015, "<%s> Cmd [%s] with args [%s] executed successfully", $sMyName, $sCommand, $sCommandArgs ); } #------------------- # Return if failed.. #------------------- $iReturnCode || return $iReturnCode; #-------------------- # Delay entry point.. #-------------------- my $iSleepTime = 10; # Secs.. while ( ( $iTimeout = $iTillWhen - time ) > 10 ) { @liPids = (); # Initialise.. sleep $iSleepTime; # Sec.. &logTrace ( 20016, "<%s> Confirming start-up with [%s] sec in hand", $sMyName, $iTimeout - $iSleepTime ); #--------- # Do FLM.. #--------- if ( VCSDef_MonitorExit::ONLINE == ConnectionBroker::GetProcState ( \@liPids, $sDMUser, $sInitFile, 1 ) ) { #--------------------- # Start-up confirmed.. #--------------------- &logInfo ( 20017, "<%s> Process check confirmed start-up of this instance of ConnectionBroker server", $sMyName ); $iReturnCode = 1; # Success.. last; } else { &logTrace ( 20018, "<%s> Process check could not confirm start-up. Sleeping for [%s] sec", $sMyName, $iSleepTime ); $iReturnCode = 0; # Failure.. } } if ( $iSecondLevelMonitor ) { # If enabled.. while ( ( $iTimeout = $iTillWhen - time ) > 10 ) { &logTrace ( 20019, "<%s> Confirming start-up with [%s] sec in hand by health check", $sMyName, $iTimeout - $iSleepTime ); #-------- # Do SLM #-------- if ( VCSDef_MonitorExit::ONLINE == # Online after.. ConnectionBroker::SecondLevelMonitor ( $sCBHost, # Running SLM.. $iCBPort, $sDMHome, $sDMUser, $sEnvFile, $iTillWhen ) ) { #--------------------- # Start-up confirmed.. #--------------------- &logInfo ( 20020, "<%s> Second Level Monitor Confirmed start-up of this instance of ConnectionBroker server", $sMyName ); $iReturnCode = 1; # Success.. last; } else { &logTrace ( 20021, "<%s> Could not confirm start-up. Sleeping for [%s] sec", $sMyName, $iSleepTime ); sleep $iSleepTime; # Sec.. $iReturnCode = 0; # Failure.. } } } #------------------------------------------------------ # MonitorProgram defined.. # Delay the entry point for monitorprogram to succedd.. #------------------------------------------------------ if ( $sMonitorProgram =~ /\S+/ ) { my ( $sExtCmd, $sExtCmdArgs ) = $sMonitorProgram # Separate =~ /(\S+)\s*(.*)/; # Cmd and args.. $sExtCmdArgs = '' unless defined $sExtCmdArgs; # Prevent undefs.. if ( $sExtCmd ) { # Defined.. while ( ( $iTimeout = $iTillWhen - time ) > 10 ) { if ( VCSDef_MonitorExit::ONLINE == # and found online.. ConnectionBroker::ExternalMonitor ( $sDMUser, $sEnvFile, $sExtCmd, $sExtCmdArgs, $iTillWhen ) ) { &logTrace ( 20022, "<%s> ConnectionBroker instance found online after executing external monitor [%s] with args [%s]", $sMyName, $sExtCmd, $sExtCmdArgs ); $iReturnCode = 1; # Success.. last; } else { &logTrace ( 20023, "<%s> ConnectionBroker instance NOT online after executing external monitor [%s] with args [%s]. Sleeping for [%s] sec", $sMyName, $sExtCmd, $sExtCmdArgs, $iSleepTime ); sleep $iSleepTime; # Sec.. $iReturnCode = 0; # Failure.. } } } } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : bool Stop ( IN String CBName, IN String DMBase, IN String DMUser, IN String EnvFile, IN String InitFile, IN String Password ); Description : Stop logic needed for offline entry point Parameters : $sCBName Documentum connection broker name managed by cluster server agent $sDMBase Absolute path of documentum connection broker binaries $sDMUser Unix user owner for Documentum connection broker $sEnvFile Absolute path to environment file to source $sInitFile The server initialization file for the Documentum connection broker $sPassword Encrypted password for teh documentum user. Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------------ =cut sub Stop { #---------------- # Get Arguments.. #---------------- my ( $sCBName, $sDMBase, $sDMUser, $sEnvFile, $sInitFile, $sPassword ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20024, "Subroutine <%s> called with: CBName [%s] DMBase [%s] DMUser [%s] EnvFile [%s] InitFile [%s] Password [%s]", $sMyName, $sCBName, $sDMBase, $sDMUser, $sEnvFile, $sInitFile, $sPassword ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; # Success.. #--------------------------------------------------------------------- # Upper bound.. Time in EPOCH when entry pt started + VCS time limit.. #--------------------------------------------------------------------- my $iTillWhen = $^T + ConnectionBroker::GetEngineTimeout ( 1 ); # With margin.. #------------------------------------------ # Declare stop command and args variables.. #------------------------------------------ my ( $sCommand, $sCommandArgs, $iTimeout, $iExitCode, $iSleepTime, @lsCmdout, @liPids ) = (); #------------------------------------ # Define stop command and arguments.. #------------------------------------ $sCommand = "$sDMBase/dm_stop_$sCBName"; $sCommandArgs = "-P$sPassword"; ( $iExitCode, $iTimeout, @lsCmdout ) = (); # Truncate.. &logTrace ( 20025, "<%s> Stopping ConnectionBroker with Command [%s] Args [%s]", $sMyName, $sCommand, $sCommandArgs ); #------------------------ # Request shutdown.. #------------------------ if ( ( $iTimeout = $iTillWhen - time ) <= 10 ) { # Get time bearings.. &logError ( 20026, "<%s> Insufficient time to continue shutdown. Short by [%s] sec", $sMyName, abs ( $iTimeout ) ); $iReturnCode = 0; # Failure.. } elsif ( $iReturnCode = ConnectionBroker::ExecLocalCmd ( $sDMUser, $sEnvFile, $sCommand, $sCommandArgs, \$iExitCode, $iTimeout, \@lsCmdout, $sPassword ) ) { &logTrace ( 20027, "<%s> Cmd [%s] with args [%s] executed successfully", $sMyName, $sCommand, $sCommandArgs ); } #-------------------- # Delay entry point.. #-------------------- if ( $iReturnCode ) { # Success.. #----------------- # Set sleep time.. #----------------- $iSleepTime = 10; # Sec.. &logInfo ( 20028, "<%s> Delaying exit to confirm shutdown..", $sMyName ); #-------------------- # Delay entry point.. #-------------------- while ( ( $iTimeout = $iTillWhen - time ) > 20 ) { #----------------------- # Wait before retrying.. #----------------------- sleep $iSleepTime; # Secs.. ConnectionBroker::GetProcState ( \@liPids, $sDMUser, $sInitFile, 0 ); # Request regular.. #------------------------------ # Check for pending processes.. #------------------------------ if ( scalar @liPids ) { &logTrace ( 20029, "<%s> Could not confirm shutdown. Retrying in [%s] sec. Delaying kill with [%s] sec in hand", $sMyName, $iSleepTime, $iTimeout - $iSleepTime ); } else { &logInfo ( 20030, "<%s> Confirmed shutdown of ConnectionBroker instance", $sMyName ); last; # Get out.. } } } #----------------------------------------- # Whack any persisting ConnectionBroker processes.. #----------------------------------------- &logTrace ( 20031, "<%s> Killing ConnectionBroker processes for this instance", $sMyName ); if ( ConnectionBroker::KillConnectionBrokerProcesses ( $sDMUser, $sInitFile ) ) { &logTrace ( 20032, "<%s> Processes for this instance do not exist after shutdown", $sMyName ); } else { &logError ( 20033, "<%s> Could not remove all processes for this instance. Exiting", $sMyName ); $iReturnCode = 0; # Failure.. } my $sResourceName = $ENV { VCS_LOG_RESOURCE_NAME }; ConnectionBroker::DeletePidFile ( $sResourceName ); return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : bool Kill ( IN String CBName, IN Integer CleanReason, IN String DMBase, IN String DMUser, IN String EnvFile, IN String InitFile, IN String Password ); Description : Forces shutdown of resource needed for clean entry point Parameters : $sCBName Documentum connection broker name managed by cluster server agent $iCleanReason Why clean was called $sDMBase Absolute path of documentum connection broker binaries $sDMUser Unix user owner for Documentum connection broker $sEnvFile Absolute path to environment file to source $sInitFile The server initialization file for the Documentum connection broker $sPassword Encrypted password for teh documentum user. Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------------ =cut sub Kill { #---------------- # Get Arguments.. #---------------- my ( $sCBName, $iCleanReason, $sDMBase, $sDMUser, $sEnvFile, $sInitFile, $sPassword ) = @_; #----------------------------- # Figure out why were called.. #----------------------------- my ( $sCleanReason, %hsCleanReasons ) = (); my @lsCleanStrings = qw ( Offline_timed_out Offline_was_ineffective Online_timed_out Online_was_ineffective Found_offline_unexpectedly Monitor_timed_out ); @hsCleanReasons { 0 .. $#lsCleanStrings } = @lsCleanStrings; # Populate.. ( $sCleanReason = $hsCleanReasons { $iCleanReason } || # Reason.. $iCleanReason ) =~ s/_/ /g; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20034, "Subroutine <%s> called with: CBName [%s] CleanReason [%s] DMBase [%s] DMUser [%s] EnvFile [%s] InitFile [%s] Password [%s]", $sMyName, $sCBName, $sCleanReason, $sDMBase, $sDMUser, $sEnvFile, $sInitFile, $sPassword ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; #--------------------------------------------------------------------- # Upper bound.. Time in EPOCH when entry pt started + VCS time limit.. #--------------------------------------------------------------------- my $iTillWhen = $^T + ConnectionBroker::GetEngineTimeout ( 1 ); # With margin.. #-------------------------- # Declare local variables.. #-------------------------- my ( $sCommand, $sCommandArgs, $iTimeout, $iExitCode, @lsFiles, @lsCmdout ) = (); #------------------------------------- # Define clean command and arguments.. #------------------------------------- $sCommand = "$sDMBase/dm_stop_$sCBName"; $sCommandArgs = "-P$sPassword"; unless ( $hsCleanReasons { $iCleanReason } eq 'Offline_timed_out' || $hsCleanReasons { $iCleanReason } eq 'Offline_was_ineffective' ) { #------------------- # Try to be gentle.. #------------------- &logInfo ( 20035, "<%s> Attempting to stop ConnectionBroker with Command [%s] Args [%s]", $sMyName, $sCommand, $sCommandArgs ); #------------------------ # Request shutdown.. #------------------------ if ( ( $iTimeout = $iTillWhen - time ) <= 10 ) { # Get time bearings.. &logError ( 20036, "<%s> Insufficient time to continue shutdown. Short by [%s] sec", $sMyName, abs ( $iTimeout ) ); $iReturnCode = 0; # Failure.. } elsif ( ConnectionBroker::ExecLocalCmd ( $sDMUser, $sEnvFile, $sCommand, $sCommandArgs, \$iExitCode, $iTimeout, \@lsCmdout, $sPassword ) ) { &logTrace ( 20037, "<%s> Cmd [%s] with args [%s] executed successfully", $sMyName, $sCommand, $sCommandArgs ); } } #----------------------------------------- # Whack any persisting ConnectionBroker processes.. #----------------------------------------- &logTrace ( 20038, "<%s> Killing ConnectionBroker processes for this instance", $sMyName ); if ( ConnectionBroker::KillConnectionBrokerProcesses ( $sDMUser, $sInitFile ) ) { &logTrace ( 20039, "<%s> Processes for this instance do not exist after shutdown", $sMyName ); } else { &logError ( 20040, "<%s> Could not remove all processes for this instance. Exiting", $sMyName ); $iReturnCode = 0; # Failure.. } my $sResourceName = $ENV { VCS_LOG_RESOURCE_NAME }; ConnectionBroker::DeletePidFile ( $sResourceName ); return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : int GetResourceState ( IN String CBHost, IN String DMUser, IN String InitFile ); Description : First level monitor to determine state of resource. Parameters : $sCBHost Hostname of virtual host for Documentum connection broker $sDMUser Unix user owner for Documentum connection broker $sInitFile The server initialization file for the Documentum connection broker Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 105 ONLINE with confidence level 50 VCSDef_MonitorExit::PARTIAL_ONLINE 110 ONLINE with confidence level 100 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ------------------------------------------------------------------------------------------------------ =cut sub GetResourceState { #---------------- # Get Arguments.. #---------------- my ( $sCBHost, $sDMUser, $sInitFile ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20041, "Subroutine <%s> called: CBHost [%s] DMUser [%s] InitFile [%s]", $sMyName, $sCBHost, $sDMUser, $sInitFile ); my @liDummyPids = (); my $iReturnCode = ConnectionBroker::GetProcState ( \@liDummyPids, $sDMUser, $sInitFile, 1 ); # Use FFLM.. if ( VCSDef_MonitorExit::ONLINE == $iReturnCode ) { &logTrace ( 20042, "<%s> Found all required processes. Return code set to [%s]", $sMyName, $iReturnCode ); } else { &logTrace ( 20043, "<%s> Did not find all required processes. Returning [%s]", $sMyName, $iReturnCode ); } #-------------------------------- # Populate the global PID array.. #-------------------------------- @liRunningProcs = @liDummyPids; &logTrace ( 20044, "<%s> Populating global running proclist with [%s] PIDs [%s]", $sMyName, scalar @liRunningProcs, join ( ' ', @liRunningProcs ) ); return ( $iReturnCode ); } =pod ------------------------------------------------------------------------------------------------------ Function : int GetProcState ( OUT ListReference OnlinePids, IN String DMUser, IN String InitFile, IN Integer UseFFLM ); Description : First level monitor to determine state of resource. Parameters : $rliOnlinePids PIDs of relevant running processes $sDMUser Unix user owner for Documentum connection broker $sInitFile The server initialization file for the Documentum connection broker $iUseFFLM Filtering procedure Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 105 ONLINE with confidence level 50 VCSDef_MonitorExit::PARTIAL_ONLINE 110 ONLINE with confidence level 100 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ------------------------------------------------------------------------------------------------------ =cut sub GetProcState { #---------------- # Get Arguments.. #---------------- my ( $rliOnlinePids, $sDMUser, $sInitFile, $iUseFFLM ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20045, "Subroutine <%s> called with: OnlinePids [%s] DMUser [%s] InitFile [%s] UseFFLM [%s]", $sMyName, $rliOnlinePids, $sDMUser, $sInitFile, $iUseFFLM ); #----------------------------- # Set return code to success.. #----------------------------- my $iReturnCode = VCSDef_MonitorExit::ONLINE; # Success.. #---------------------- # Initialise Variables.. #---------------------- my ( $iProcessCount, $iUseRFLM, $iFound, $iUid, $iPid, $sLang, $sKey, $rhlProc, $sPidFile, $sProc, $sTemp, @hProcListHash, @lsUpdates, @lsValues, %hiProcPids, %hsSrvrDetails, %hsCopy ) = (); @$rliOnlinePids = (); #------------------------------------ # Attempt to get monitoring details.. #------------------------------------ if ( $iUseFFLM != 2 ) { # Called for first level check.. if ( ConnectionBroker::GetSrvrDetails ( $sInitFile, \%hsSrvrDetails ) ) { &logTrace ( 20046, "<%s> Got details for monitoring ConnectionBroker instance", $sMyName ); %hsCopy = %hsSrvrDetails; # Backup.. $iUseRFLM = scalar keys %hsCopy; # Set to entire count.. } else { &logError ( 20047, "<%s> Failed to get details for monitoring ConnectionBroker instance", $sMyName ); return VCSDef_MonitorExit::UNKNOWN; } #--------------------------------- # Check if we attempt to be fast.. #--------------------------------- if ( $iUseFFLM ) { # FFLM.. $iUseRFLM = 0; # Hopefully skip.. foreach $sKey ( keys %hsCopy ) { # Use copy.. @lsUpdates = (); # Reset.. @lsValues = @{ $hsCopy { $sKey } }; # Get values.. $sTemp .= "\nConnectionBroker process [$sKey]\n"; # Display string.. #---------------- # Read in pairs.. #---------------- while ( ( $sPidFile, $sProc ) = splice ( @lsValues, 0, 2 ) ) { #----------- # Run FFLM.. #----------- $iFound = ConnectionBroker::FFLMStatus ( $sPidFile, $sProc, \$iPid ); #---------------- # Update status.. #---------------- push ( @lsUpdates, $sPidFile, $sProc, $iFound ); $sTemp .= "PID File [$sPidFile]\n"; $sTemp .= "Srch Process [$sProc]\n"; $sTemp .= "FFLM Status [$iFound]\n\n"; } @{ $hsCopy { $sKey } } = @lsUpdates; #------------------------ # Handle monitor status.. #------------------------ if ( VCSDef_MonitorExit::ONLINE == $iFound ) { push ( @$rliOnlinePids, $iPid ); # Push.. } else { ++ $iUseRFLM; # Mark it for RFLM.. } } #---------------- # Print summary.. #---------------- &logTrace ( 20048, "<%s> ConnectionBroker instance process details ---%s\n\n", $sMyName, $sTemp ); ( $sTemp, $sPidFile, $sProc ) = (); # Release memory.. } else { # Use RLFM.. #----------------------------------------- # Mark status of each service as offline.. #----------------------------------------- $iFound = VCSDef_MonitorExit::OFFLINE; # Set to offline.. foreach $sKey ( keys %hsCopy ) { @lsUpdates = (); # Reset.. @lsValues = @{ $hsCopy { $sKey } }; # Get values.. while ( scalar @lsValues ) { push ( @lsUpdates, splice ( @lsValues, 0, 2 ), $iFound ); } @{ $hsCopy { $sKey } } = @lsUpdates; # Update.. } } } else { # Called for Kill.. &logTrace ( 20049, "<%s> Called to get processes for User [%s] User [%s]", $sMyName, $sDMUser ); ++ $iUseRFLM; } #----------------------- # Regular slow :-( FLM.. #----------------------- if ( $iUseRFLM ) { &logTrace ( 20050, "<%s> Running regular first level monitor", $sMyName ); #---------------------------------- # Set LANG for better performance.. #---------------------------------- $sLang = $ENV { LANG }; # Backup.. $ENV { LANG } = 'C'; # Now set.. #----------------------------------- # Call processes and store in hash.. #----------------------------------- $iProcessCount = Proc::GetLongProcessListHash ( \@hProcListHash ); #---------- # Restore.. #---------- defined $sLang ? $ENV { LANG } = $sLang : delete $ENV { LANG }; # Restore.. #---------------------- # Check if we got any.. #---------------------- if ( $iProcessCount ) { &logTrace ( 20051, "<%s> Got [%s] processes from proc table for filtering", $sMyName, $iProcessCount ); } else { &logError ( 20052, "<%s> Call to get process list did not return any processes", $sMyName ); return VCSDef_MonitorExit::OFFLINE; # Offline.. } #----------------------- # Search for processes.. #----------------------- foreach $rhlProc ( @hProcListHash ) { #-------------------------------------------------------------- # Each $rhlProc is a ref. to a hash with the following keys.. # "UID" => # "PID" => # "PPID" => # "COMMAND" => #-------------------------------------------------------------- next unless defined $$rhlProc { UID }; # Bug in Proc::GetLongProcessListHash.. next if $$rhlProc { PID } == $$; # Skip self.. $iPid = $$rhlProc { PID }; # Assign.. &logTrace ( 20053, "<%s> Searching UID [%s] PID [%s] PPID [%s] CMD [%s]", $sMyName, $$rhlProc { UID }, $$rhlProc { PID }, $$rhlProc { PPID }, $$rhlProc { COMMAND } ); #----------------------------------------------- # Look for processes that were offline in FFLM.. #----------------------------------------------- if ( $iUseFFLM != 2 ) { # Request to filter.. foreach $sKey ( keys %hsCopy ) { @lsUpdates = (); # Reset.. @lsValues = @{ $hsCopy { $sKey } }; # Get values.. #-------------------------------------------------- # Should have details per three elements of array.. # #-------------------------------------------------- while ( ( $sPidFile, $sProc, $iFound ) = splice ( @lsValues, 0, 3 ) ) { if ( VCSDef_MonitorExit::OFFLINE == $iFound ) { # Earlier marked offline.. if ( $$rhlProc { COMMAND } =~ /$sProc/ ) { # Now found.. unshift ( @$rliOnlinePids, $iPid ); # Store.. &logTrace ( 20054, "<%s> Found PID [%s] PPID [%s] CMD [%s] with filter [%s]", $sMyName, $iPid, $$rhlProc { PPID }, $$rhlProc { COMMAND }, $sProc ); $hiProcPids { $sKey } = $iPid; # Store.. $iFound = VCSDef_MonitorExit::ONLINE; # Mark online.. } } #---------------- # Update status.. #---------------- push ( @lsUpdates, $sPidFile, $sProc, $iFound ); } @{ $hsCopy { $sKey } } = @lsUpdates; # Update.. } } else { # Request for kill.. &logTrace ( 20055, "<%s> Pushing PID [%s] with PPID [%s] Cmd [%s] on stack", $sMyName, $iPid, $$rhlProc { PPID }, $$rhlProc { COMMAND } ); push ( @$rliOnlinePids, $iPid ); # Store.. } } } #------------------------------------ # Set final status for each process.. #------------------------------------ my ( $iOnline, $iOffline, $sEntryPointName ) = (); ( $sEntryPointName = $0 ) =~ s#.*/##; # Basename.. $sTemp = ''; # Ensure.. foreach $sKey ( keys %hsCopy ) { @lsValues = @{ $hsCopy { $sKey } }; # Get values.. $sTemp .= "\nProcess [$sKey]\n"; while ( ( $sPidFile, $sProc, $iFound ) = splice ( @lsValues, 0, 3 ) ) { #----------------------------------- # Create PID files for use in FFLM.. #----------------------------------- if ( $iUseRFLM && # In RFLM.. $iUseFFLM != 2 && # Asked to filter.. $hiProcPids { $sKey } && # PID populated.. ( $sEntryPointName =~ /^(monitor|online)$/o ) ) { # In monitor or online.. &logTrace ( 20056, "<%s> Creating PID file [%s] with PID [%s]", $sMyName, $sPidFile, $hiProcPids { $sKey } ); #--------- # Create.. #--------- if ( ConnectionBroker::CreatePidFile ( $sPidFile, $hiProcPids { $sKey } ) ) { &logTrace ( 20057, "<%s> Successfully created PID file [%s]", $sMyName, $sPidFile ); } else { &logError ( 20058, "<%s> Could not create PID file [%s] successfully", $sMyName, $sPidFile ); } } #------------- # Set status.. #------------- if ( VCSDef_MonitorExit::ONLINE == $iFound ) { $iOnline = $iFound; } elsif ( VCSDef_MonitorExit::OFFLINE == $iFound ) { $iOffline = $iFound; } $sTemp .= "Srch Process [$sProc]\n"; $sTemp .= "FLM Status [$iFound]\n\n"; } $sTemp .= "--------------------"; } #------------------- # Set final status.. #------------------- $iReturnCode = $iOffline || $iOnline || VCSDef_MonitorExit::UNKNOWN; #------------------------------------------------ # Reset status based on PIDs, if not in monitor.. #------------------------------------------------ if ( $sEntryPointName ne 'monitor' && ( VCSDef_MonitorExit::OFFLINE == $iReturnCode ) && scalar @$rliOnlinePids ) { $iReturnCode = VCSDef_MonitorExit::PARTIAL_ONLINE; &logTrace ( 20059, "<%s> Found [%s] PIDs [%s] for this instance of ConnectionBroker. Resetting return code to [%s]", $sMyName, scalar @$rliOnlinePids, join ( ' ', @$rliOnlinePids ), $iReturnCode ); } #----------------------- # Report on FLM status.. #----------------------- if ( $iUseFFLM != 2 ) { # Request to filter.. &logTrace ( 20060, "<%s> ConnectionBroker process details ---\n%s\nReturn code is [%s]", $sMyName, $sTemp, $iReturnCode ); $sTemp = undef; # Release.. } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : int Monitor ( IN String CBHost, IN Integer CBPort, IN String DMHome, IN String DMUser, IN String EnvFile, IN String MonitorProgram, IN Integer SecondLevelMonitor ); Description: Performs the in-depth monitoring Parameters : $sCBHost Hostname of virtual host for Documentum connection broker $iCBPort The port on which the Documentum connection broker listens $sDMHome Absolute path of documentum product installation $sDMUser Unix user owner for Documentum connection broker $sEnvFile Absolute path to environment file to source $sMonitorProgram Full path to external monitor program $iSecondLevelMonitor Cycle count to run in-depth monitoring Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 110 ONLINE with confidence level 100 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ?? HUNG: External monitor timed out VCSDef_MonitorExit::TIMEOUT The entry point hangs if in-depth monitoring cannot be completed. ------------------------------------------------------------------------------------------------------ =cut sub Monitor { #---------------- # Get Arguments.. #---------------- my ( $sCBHost, $iCBPort, $sDMHome, $sDMUser, $sEnvFile, $sMonitorProgram, $iSecondLevelMonitor ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20061, "Subroutine <%s> called with: CBHost [%s] CBPort [%s] DMHome [%s] DMUser [%s] EnvFile [%s] MonitorProgram [%s] SecondLevelMonitor [%s]", $sMyName, $sCBHost, $iCBPort, $sDMHome, $sDMUser, $sEnvFile, $sMonitorProgram, $iSecondLevelMonitor ); #----------------------------- # Set return code to success.. #----------------------------- my $iReturnCode = VCSDef_MonitorExit::ONLINE; # Success.. my $iTillWhen = undef; #---------------------------------------------- # In-depth monitoring, if correct time to run.. #---------------------------------------------- if ( VCSagentFW::RunSecondLevelMonitor ( $iSecondLevelMonitor ) ) { #-------------------------- # Just In Time Validation.. #-------------------------- if ( VCSDef_MonitorExit::ONLINE == ( $iReturnCode = ConnectionBroker::DelayedAttributeCheck ( $sCBHost, $iCBPort, $sDMHome, $sDMUser, $sEnvFile ) ) ) { &logTrace ( 20062, "<%s> Delayed attribute check completed successfully", $sMyName ); } else { &logError ( 20063, "<%s> Attribute validation failed. Returning [%s]", $sMyName, $iReturnCode ); return $iReturnCode; } &logTrace ( 20064, "<%s> Proceeding with second level monitoring", $sMyName ); #------------------------------------------------------- # Upper bound.. # Time in EPOCH when entry pt started + VCS time limit.. #------------------------------------------------------- $iTillWhen = $^T + ConnectionBroker::GetEngineTimeout ( 1 ); if ( VCSDef_MonitorExit::ONLINE == ( $iReturnCode = ConnectionBroker::SecondLevelMonitor ( $sCBHost, $iCBPort, $sDMHome, $sDMUser, $sEnvFile, $iTillWhen ) ) ) { &logTrace ( 20065, "<%s> ConnectionBroker instance online with status [%s] after SLM", $sMyName, $iReturnCode ); } else { &logError ( 20066, "<%s> ConnectionBroker instance NOT online after SLM. Status [%s]", $sMyName, $iReturnCode ); return $iReturnCode; } } #------------------------------------------------ # Exit if external monitor has not been defined.. #------------------------------------------------ return $iReturnCode unless defined $sMonitorProgram; #--------------------------------------- # MonitorProgram defined.. # Separate the executable and the args.. #--------------------------------------- my ( $sExtCmd, $sExtCmdArgs ) = $sMonitorProgram # Separate =~ /(\S+)\s*(.*)/; # Cmd and args.. $sExtCmdArgs = '' unless defined $sExtCmdArgs; # Prevent undefs.. if ( $sExtCmd ) { # Defined.. #---------------------------------------- # Get time bearings, if not got earlier.. #---------------------------------------- $iTillWhen ||= $^T + ConnectionBroker::GetEngineTimeout ( 1 ); if ( VCSDef_MonitorExit::ONLINE == # and found online.. ( $iReturnCode = # by the status.. ConnectionBroker::ExternalMonitor ( $sDMUser, $sEnvFile, $sExtCmd, $sExtCmdArgs, $iTillWhen ) ) ) { &logTrace ( 20067, "<%s> ConnectionBroker instance found online with status [%s] after executing external monitor [%s] with args [%s]", $sMyName, $iReturnCode, $sExtCmd, $sExtCmdArgs ); } else { &logError ( 20068, "<%s> ConnectionBroker instance NOT online after executing external monitor [%s] with args [%s]. Status [%s]", $sMyName, $sExtCmd, $sExtCmdArgs, $iReturnCode ); } } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : int DelayedAttributeCheck ( IN String CBHost, IN Integer CBPort, IN String DMHome, IN String DMUser, IN String EnvFile ); Description : Just In Time Validation Parameters : $sCBHost Hostname of virtual host for Documentum connection broker $iCBPort The port on which the Documentum connection broker listens $sDMHome Absolute path of documentum product installation $sDMUser Unix user owner for Documentum connection broker $sEnvFile Absolute path to environment file to source Returns : Integer value as defined below: 110 ONLINE with confidence level 110 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ------------------------------------------------------------------------------------------------------ =cut sub DelayedAttributeCheck { #---------------- # Get Arguments.. #---------------- my ( $sCBHost, $iCBPort, $sDMHome, $sDMUser, $sEnvFile ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20069, "Subroutine <%s> called with: CBHost [%s] CBPort [%s] DMHome [%s] DMUser [%s] EnvFile [%s]", $sMyName, $sCBHost, $iCBPort, $sDMHome, $sDMUser, $sEnvFile ); #----------------------------- # Set return code to success.. #----------------------------- my $iReturnCode = VCSDef_MonitorExit::ONLINE; # Success.. #-------------------------------------------- # Create hash to weed out empty args values.. #-------------------------------------------- my @lsArgs = qw ( CBHost CBPort DMHome DMUser EnvFile ); my @lsReqdArgs = qw ( CBHost CBPort DMHome DMUser EnvFile ); my ( @lsMissing, %hsArgList ) = (); @hsArgList { @lsArgs } = @_; # Assign.. #----------------------- # Check what's missing.. #----------------------- if ( @lsMissing = grep { $hsArgList { $_ } !~ /\S/o } @lsReqdArgs ) { &logError ( 20070, "<%s> The following mandatory fields were not set [%s], Total [%s]", $sMyName, join ( ' ', @lsMissing ), scalar @lsMissing ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; # Failure.. } #-------------------- # Return, if failed.. #-------------------- if ( VCSDef_MonitorExit::ONLINE != $iReturnCode ) { return $iReturnCode; } #------------------------------ # Validate parameter EnvFile.. #------------------------------ if ( ! -e $sEnvFile ) { &logError ( 20071, "<%s> EnvFile [%s] file does not exist", $sMyName, $sEnvFile ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; # Failure.. } if ( ! -e $sDMHome ) { &logError ( 20072, "<%s> DMHome [%s] does not exist", $sMyName, $sDMHome ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; # Failure.. } #----------------------------- # Validate parameter DMUser.. #----------------------------- return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : int SecondLevelMonitor ( IN String CBHost, IN Integer CBPort, IN String DMHome, IN String DMUser, IN String EnvFile, IN Integer TillWhen ); Description : Does in-depth monitoring, if enabled. Parameters : $sCBHost Hostname of virtual host for Documentum connection broker $iCBPort The port on which the Documentum connection broker listens $sDMHome Absolute path of documentum product installation $sDMUser Unix user owner for Documentum connection broker $sEnvFile Absolute path to environment file to source $iTillWhen Time in EPOCH left for IInd level monitoring Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 110 ONLINE with confidence level 110 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ?? HUNG: External monitor timed out VCSDef_MonitorExit::TIMEOUT The entry point hangs if the command cannot be completed. ------------------------------------------------------------------------------------------------------ =cut sub SecondLevelMonitor { #---------------- # Get Arguments.. #---------------- my ( $sCBHost, $iCBPort, $sDMHome, $sDMUser, $sEnvFile, $iTillWhen ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20073, "Subroutine <%s> called with: CBHost [%s] CBPort [%s] DMHome [%s] DMUser [%s] EnvFile [%s] TillWhen [%s]", $sMyName, $sCBHost, $iCBPort, $sDMHome, $sDMUser, $sEnvFile, $iTillWhen ); #------------------ # Hopeful success.. #------------------ my $iReturnCode = VCSDef_MonitorExit::ONLINE; #------------------------- # Define local variables.. #------------------------- my ( $iTimeout, $iExitCode, $sCommand, $sCommandArgs, @lsCmdout ) = (); #------------------------------------ # Check if port can be connected to.. #------------------------------------ if ( Comms::CheckPort ( $sCBHost, $iCBPort ) ) { &logTrace ( 20074, "<%s> Server listening on Host [%s] Port [%s]: Socket method", $sMyName, $sCBHost, $iCBPort ); } else { &logError ( 20075, "<%s> Server NOT listening on Host [%s] Port [%s]: Socket method", $sMyName, $sCBHost, $iCBPort ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } #------------------------ # Return, unless online.. #------------------------ unless ( VCSDef_MonitorExit::ONLINE == $iReturnCode ) { return $iReturnCode; } #--------------------------------------------- # Declare monitor command and args variables.. #--------------------------------------------- $sCommand = "$sDMHome/bin/dmqdocbroker"; $sCommandArgs = "-t $sCBHost -p $iCBPort -c ping"; #------------------------------- # Validate and execute command.. #------------------------------- if ( ( $iTimeout = $iTillWhen - time ) <= 10 ) { # Get time bearings.. &logError ( 20076, "<%s> Insufficient time to continue in-depth monitoring. Short by [%s] sec", $sMyName, abs ( $iTimeout ) ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; # Failure.. } elsif ( ConnectionBroker::ExecLocalCmd ( $sDMUser, $sEnvFile, $sCommand, $sCommandArgs, \$iExitCode, $iTimeout, \@lsCmdout ) ) { &logTrace ( 20077, "<%s> Cmd [%s] with args [%s] executed successfully", $sMyName, $sCommand, $sCommandArgs ); } elsif ( ! defined $iExitCode ) { $lsCmdout [0] ||= 'undef'; # Set if not defined.. $iReturnCode = $lsCmdout [0] eq 'timeout'? VCSDef_MonitorExit::TIMEOUT: # Timeout.. VCSDef_MonitorExit::UNKNOWN; # Failure.. } else { $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : int ExternalMonitor ( IN String DMUser, IN String EnvFile, IN String Cmd, IN String CmdArgs, IN Integer TillWhen ); Description : Handles user defined external monitor program Parameters : $sDMUser Unix user owner for Documentum connection broker $sEnvFile Absolute path to environment file to source $sCmd User defined utilty to execute $sCmdArgs Command line arguments $iTillWhen Time in EPOCH left for IInd level monitoring Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 110 ONLINE with confidence level 110 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ?? HUNG: External monitor timed out VCSDef_MonitorExit::TIMEOUT The entry point hangs if the command cannot be completed. ------------------------------------------------------------------------------------------------------ =cut sub ExternalMonitor { #---------------- # Get Arguments.. #---------------- my ( $sDMUser, $sEnvFile, $sCmd, $sCmdArgs, $iTillWhen ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20078, "Subroutine <%s> called with: DMUser [%s] EnvFile [%s] Cmd [%s] CmdArgs [%s] TillWhen [%s]", $sMyName, $sDMUser, $sEnvFile, $sCmd, $sCmdArgs, $iTillWhen ); #------------------ # Hopeful success.. #------------------ my $iReturnCode = VCSDef_MonitorExit::ONLINE; #------------------------ # Setup local variables.. #------------------------ my ( $iExitCode, $iTimeout, @lsCmdout ) = (); my $iBuf = 5; # Secs.. #------------------------- # Handled exit code hash.. #------------------------- my %hiExitCodes = ( 0, VCSDef_MonitorExit::ONLINE, 110, VCSDef_MonitorExit::ONLINE, 1, VCSDef_MonitorExit::OFFLINE, 100, VCSDef_MonitorExit::OFFLINE, VCSDef_MonitorExit::TIMEOUT, VCSDef_MonitorExit::TIMEOUT ); #--------------------------------------------- # Check if command can be found and executed.. #--------------------------------------------- if ( ! -e $sCmd ) { &logError ( 20079, "<%s> External monitor [%s] does not exist", $sMyName, $sCmd ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; } elsif ( ! -x $sCmd ) { &logError ( 20080, "<%s> External monitor [%s] not executable.", $sMyName, $sCmd ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; } elsif ( $sEnvFile =~ /\S/ && ! -e $sEnvFile ) { &logError ( 20081, "<%s> EnvFile [%s] does not exist", $sMyName, $sEnvFile ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; } elsif ( ( $iTimeout = $iTillWhen - ( time + $iBuf ) ) <= 5 ) { # Lack of time.. &logError ( 20082, "<%s> Insufficient time to proceed with external monitor [%s]. Short by [%s] sec", $sMyName, $sCmd, abs ( $iTimeout ) ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; } #-------------------------------------------- # Return if validation failed at this point.. #-------------------------------------------- unless ( VCSDef_MonitorExit::ONLINE == $iReturnCode ) { return $iReturnCode; } &logTrace ( 20083, "<%s> Executing external monitor with Command [%s] Args [%s] in [%s] secs", $sMyName, $sCmd, $sCmdArgs, $iTimeout ); #---------------------- # Execute the command.. #---------------------- ConnectionBroker::ExecLocalCmd ( $sDMUser, $sEnvFile, $sCmd, $sCmdArgs, \$iExitCode, $iTimeout, \@lsCmdout ); #------------------------ # Report on exit status.. #------------------------ if ( ! defined $iExitCode ) { $lsCmdout [0] ||= 'undef'; # Set if not defined.. $iExitCode = $lsCmdout [0] eq 'timeout'? VCSDef_MonitorExit::TIMEOUT: # Timeout.. VCSDef_MonitorExit::UNKNOWN; # Failure.. } elsif ( $hiExitCodes { $iExitCode } && VCSDef_MonitorExit::ONLINE == $hiExitCodes { $iExitCode } ) { &logTrace ( 20084, "<%s> Command [%s] with args [%s] executed successfully with exit code [%s]. Cmd output [%s]", $sMyName, $sCmd, $sCmdArgs, $iExitCode, join ( chr 012, @lsCmdout ) ); } else { &logWarn ( 20085, "<%s> Command [%s] with args [%s] execution failed with exit code [%s]. Cmd output [%s]", $sMyName, $sCmd, $sCmdArgs, $iExitCode, join ( chr 012, @lsCmdout ) ); } #-------------------------------- # Setup appropriate return code.. #-------------------------------- $iReturnCode = $hiExitCodes { $iExitCode } || VCSDef_MonitorExit::UNKNOWN; return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : bool CreatePidFile ( IN String PidFile, In Integer Pid ); Description : Creates PID file with given PID Parameters : $sPidFile File to create $iPid PID to store Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------------ =cut sub CreatePidFile { #---------------- # Get Arguments.. #---------------- my ( $sPidFile, $iPid ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20086, "Subroutine <%s> called with: PidFile [%s] Pid [%s]", $sMyName, $sPidFile, $iPid ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; #----------------------- # Check against undefs.. #----------------------- unless ( defined $iPid && $iPid =~ /^\d+$/o) { $iPid ||= 'undef'; # Prevent undefs. &logError ( 20087, "<%s> PID [%s] is not a valid positive number", $sMyName, $iPid ); return 0; # Proceed no further.. } #------------------ # Create PID file.. #------------------ &logTrace ( 20088, "<%s> Creating PID file [%s] with PID [%s]", $sMyName, $sPidFile, $iPid ); if ( sysopen ( PIDFILE, $sPidFile, O_WRONLY|O_SYNC|O_CREAT|O_TRUNC, 0600 ) ) { print PIDFILE $iPid, "\n"; # Update.. unless ( close ( PIDFILE ) ) { &logWarn ( 20089, "<%s> Failed to close PidFile [%s] after update: [%s]", $sMyName, $sPidFile, $! ); $iReturnCode = 0; } } else { &logWarn ( 20090, "<%s> Failed to create PID file [%s] with PID [%s]", $sMyName, $sPidFile, $iPid ); $iReturnCode = 0; } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : bool DeletePidFile ( IN String ResourceName ); Description : Deletes PID files for the VCS resource. Parameters : $sResourceName ResourceName for which the PID files needs to be deleted. Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------ =cut sub DeletePidFile { #---------------- # Get Arguments.. #---------------- my ( $sResourceName ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20091, "Subroutine <%s> called with: ResourceName [%s]", $sMyName, $sResourceName ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; my ( $sPidFileDir, $iRet ) = (); #------------------- # Delete PID files.. #------------------- &logTrace ( 20092, "<%s> Deleting PID files for VCS resource [%s]", $sMyName, $sResourceName ); $sPidFileDir = "/tmp/.VRTSConnectionBroker/" . $sResourceName . "/PID" ; if ( -d $sPidFileDir ) { $iRet = system("/bin/rm -rf $sPidFileDir") ; if ( $iRet == 0 ) { &logTrace ( 20093, "<%s> Successfully deleted PID files in the directory [%s].", $sMyName, $sPidFileDir ); $iReturnCode = 0; } else { &logWarn ( 20094, "<%s> Failed to delete PID files in directory [%s]. Remove the files manually.", $sMyName, $sPidFileDir ); $iReturnCode = 1; } } else { &logTrace ( 20095, "<%s> PID files for VCS resource [%s] doesn't exist.", $sMyName, $sResourceName ); } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : int FFLMStatus ( IN String PidFile, IN String Proc, OUT RefInt Pid ); Description: Checks status of Process listed in PidFile, if running Parameters : $sPidFile Absolute path to PID file of service $sProc Process string to search for in proc table $riPid Reference to existing PID Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 110 ONLINE with confidence level 100 VCSDef_MonitorExit::ONLINE ------------------------------------------------------------------------------------------------------ =cut sub FFLMStatus { #---------------- # Get Arguments.. #---------------- my ( $sPidFile, $sProc, $riPid ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20096, "Subroutine <%s> called with: PidFile [%s] Proc [%s] riPid [%s]", $sMyName, $sPidFile, $sProc, $riPid ); #----------------------------- # Set return code to success.. #----------------------------- my $iReturnCode = VCSDef_MonitorExit::ONLINE; # Success.. $$riPid = 0; # Reset.. #------------------------- # Define local variables.. #------------------------- my ( $iPid, $rhlProc, @lProcessHash ) = (); #---------------------------------- # Start by testing the attributes.. #---------------------------------- if ( $sProc !~ /\S/ ) { &logError ( 20097, "<%s> Called with empty [%s] process string", $sMyName, $sProc ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } elsif ( ! -e $sPidFile ) { &logTrace ( 20098, "<%s> PID file [%s] does not exist", $sMyName, $sPidFile ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } elsif ( ! -s $sPidFile ) { &logWarn ( 20099, "<%s> PID file [%s] is of zero bytes", $sMyName, $sPidFile ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } #--------------------- # Return, if offline.. #--------------------- return $iReturnCode unless VCSDef_MonitorExit::ONLINE == $iReturnCode; if ( open ( PIDFILE, $sPidFile ) ) { ( $iPid ) = grep { ( s/\n// || 1 ) && # Chomp.. s/.*?(\d+)$/$1/ # Get PID.. } ; $iPid = '' unless defined $iPid; # Avoid undefs.. close ( PIDFILE ) || # Close file.. &logWarn ( 20100, "<%s> Could not close PID file [%s] after read [%s]", $sMyName, $sPidFile, $! ); } else { &logError ( 20101, "<%s> Failed to open PID file [%s] for read: [%s]", $sMyName, $sPidFile, $! ); return VCSDef_MonitorExit::OFFLINE; # Failure.. } #------------------------ # Check if PID is valid.. #------------------------ if ( $iPid =~ /\d+/ && # If the valid number.. kill ( 0, $iPid ) ) { # is a PID that's alive.. &logTrace ( 20102, "<%s> PID [%s] from PID file [%s] exists", $sMyName, $iPid, $sPidFile ); #----------------------- # Search in proc table.. #----------------------- if ( ConnectionBroker::GetPidDetails ( $iPid, \@lProcessHash ) ) { #-------------- # Got details.. #-------------- foreach $rhlProc ( @lProcessHash ) { &logTrace ( 20103, "<%s> Process details: UID [%s] PID [%s] PPID [%s] ARGS [%s]", $sMyName, $$rhlProc { UID }, $$rhlProc { PID }, $$rhlProc { PPID }, $$rhlProc { COMMAND } ); #-------------- # Now compare.. #-------------- if ( $$rhlProc { COMMAND } =~ /$sProc/ ) { # Filter match.. &logTrace ( 20104, "<%s> PID [%s] owned by UID [%s] with ARGS [%s] contains [%s]", $sMyName, $iPid, $$rhlProc { UID }, $$rhlProc { COMMAND }, $sProc ); $$riPid = $iPid; # Store.. } else { &logTrace ( 20105, "<%s> Ignoring PID [%s] owned by UID [%s] with ARGS [%s] with string [%s]", $sMyName, $iPid, $$rhlProc { UID }, $$rhlProc { COMMAND }, $sProc ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } } } else { &logTrace ( 20106, "<%s> Could not get details for PID [%s]", $sMyName, $iPid ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } } else { &logTrace ( 20107, "<%s> PID [$iPid] does not exist", $sMyName, $sPidFile ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } @lProcessHash = (); # Truncate.. return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : bool KillConnectionBrokerProcesses ( IN String DMUser, IN String InitFile ); Description : Kills processes for this instance of ConnectionBroker Parameters : $sDMUser Unix user owner for Documentum connection broker $sInitFile The server initialization file for the Documentum connection broker Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------------ =cut sub KillConnectionBrokerProcesses { #---------------- # Get Arguments.. #---------------- my ( $sDMUser, $sInitFile ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20108, "Subroutine <%s> called with: DMUser [%s] InitFile [%s]", $sMyName, $sDMUser, $sInitFile ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; # Success.. #------------------------- # Set up local variables.. #------------------------- my ( @liGoners, @liUnDead ) = (); #--------------------------------------------- # Get list of processes running for this Uid.. #--------------------------------------------- if ( ( caller 1 )[3] eq 'ConnectionBroker::Start' ) { # During online.. @liGoners = @liRunningProcs; # Get PIDs to kill.. } else { ConnectionBroker::GetProcState ( \@liGoners, $sDMUser, $sInitFile, 0 ); # Set filtering choice.. } #-------------------------- # Sort in ascending order.. #-------------------------- @liGoners = sort { $a <=> $b } @liGoners; #------------------------------------------------------------------ # We do a two level kill. The SIGINQ ensures that the PID is a # valid process before we actually issue the SIGKILL. We don't want # to report a failure for SIGKILL in case of defunct or missing # processes. #------------------------------------------------------------------ if ( scalar @liGoners ) { #---------------------- # Failed to kill some.. #---------------------- if ( @liUnDead = grep { kill ( 0, $_ ) && # Valid.. ! kill ( 9, $_ ) # and could NOT be killed.. } @liGoners ) { # From what's found.. &logError ( 20109, "<%s> PIDs not killed [%s] Total not killed [%s]", $sMyName, join ( ' ', @liUnDead ), scalar @liUnDead ); $iReturnCode = 0; # Failure.. } else { # All killed.. &logInfo ( 20110, "<%s> Killed PIDs [%s] Total killed: [%s]", $sMyName, join ( ' ', @liGoners ), scalar @liGoners ); } } else { &logTrace ( 20111, "<%s> Could not locate any process this instance of ConnectionBroker", $sMyName ); } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : bool ExecLocalCmd ( IN String User, IN String EnvFile, IN String Command, IN String CommandArgs, OUT RefInt ExitCode, IN Integer Timeout, OUT ListReference Cmdout IN String HideString ); Description : Wrapper function for Sys::RunWithEnvCmdWithOutputWithTimeOut to collect output of the command. Parameters : $sUser UNIX user to run the command as $sEnvFile Absolute path to location of EnvFile to source $sCommand Absolute path to location of command $sCommandArgs Arguments to command $riExitCode Reference to collect exit code of command $iTimeout Time limit to execute the command $rlsCmdout Stores o/p from command if successful $sHideString String in CommandArgs to hide Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------------ =cut sub ExecLocalCmd { #---------------- # Get Arguments.. #---------------- my ( $sUser, $sEnvFile, $sCommand, $sCommandArgs, $riExitCode, $iTimeout, $rlsCmdout, $sHideString ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20112, "Subroutine <%s> called with: User [%s] EnvFile [%s] Command [%s] CommandArgs [%s] riExitCode [%s] Timeout [%s] rlsCmdout [%s]", $sMyName, $sUser, $sEnvFile, $sCommand, $sCommandArgs, $riExitCode, $iTimeout, $rlsCmdout ); #--------------------------------------- # Setup return code to hopeful success.. #--------------------------------------- my $iReturnCode = 1; my ( $sDeCrPasswd, $sCmdDeCr, $iExitCode ) = (); #------------------------- # Get decrypted password.. #------------------------- if ( ( defined $sHideString ) && ( $sHideString =~ /\S+/ ) ) { #----------- # Validate.. #----------- if ( ! -x $sCmdVcsDecrypt ) { &logError ( 20113, "<%s> Command [%s] is not executable", $sMyName, $sCmdVcsDecrypt ); return 0; # Failure.. } $sCmdDeCr = $sCmdVcsDecrypt; # Get global.. ( $sDeCrPasswd ) = grep { s/([^\w])/\\$1/g || 1 } readpipe ( "$sCmdDeCr $sHideString" ); #-------------------- # Collect exit code.. #-------------------- if ( $iExitCode = $? >> 8 ) { &logError ( 20114, "<%s> Failed to decrypt crypted string [%s]", $sMyName, $sHideString ); return 0; # Failure.. } $sCommandArgs =~ s/$sHideString/$sDeCrPasswd/g; } #------------------- # Set up arguments.. #------------------- my $bSourceUserEnv = 0; # Do not source.. my $bTimedOut = 0; # Timeout variable.. @$rlsCmdout = (); # Reset.. #----------- # Validate.. #----------- if ( ! -e $sCommand ) { &logError ( 20115, "<%s> Cmd [%s] does not exist", $sMyName, $sCommand ); $iReturnCode = 0; # Failure.. } elsif ( ! -x $sCommand ) { &logError ( 20116, "<%s> Cmd [%s] is not executable", $sMyName, $sCommand ); $iReturnCode = 0; # Failure.. } elsif ( $iTimeout <= 1 ) { &logError ( 20117, "<%s> Insufficient time [%s] to execute Cmd [%s] with Args [%s].", $sMyName, $iTimeout, $sCommand, $sCommandArgs ); $iReturnCode = 0; # Failure.. } $iReturnCode || return $iReturnCode; # Return if failed.. #---------------------- # Set LOGNAME to user.. #---------------------- my $sOldLogName = $ENV { LOGNAME }; # Backup.. $ENV { LOGNAME } = $sUser; # Now set.. &logTrace ( 20118, "<%s> Executing Command [%s] with Args [%s]", $sMyName, $sCommand, $sCommandArgs ); $iReturnCode = Sys::RunWithEnvCmdWithOutputWithTimeOut ( $sEnvFile, $bSourceUserEnv, $sCommand, $sCommandArgs, $riExitCode, $sUser, $rlsCmdout, \$bTimedOut, $iTimeout, undef, undef, $sDeCrPasswd ); #--------------------------- # Remove trailing newlines.. #--------------------------- chomp @$rlsCmdout; #-------------------- # Check return code.. #-------------------- if ( $iReturnCode ) { # No error with command execution.. if ( $$riExitCode ) { # Failure.. &logTrace ( 20119, "<%s> Command [%s] with args [%s] returned exit code [%s]", $sMyName, $sCommand, $sCommandArgs, $$riExitCode ); $iReturnCode = 0; # Failure.. } else { &logTrace ( 20120, "<%s> Command [%s] with args [%s] executed successfully with exit code [%s]", $sMyName, $sCommand, $sCommandArgs, $$riExitCode ); } } else { # Execution error.. @$rlsCmdout = (); # Reset.. if ( $bTimedOut ) { # We timed out.. &logError ( 20121, "<%s> Command [%s] with args [%s] did not complete within [%s] seconds", $sMyName, $sCommand, $sCommandArgs, $iTimeout ); $$rlsCmdout [0] = 'timeout'; # Timeout.. } else { # Failure due to something else.. &logError ( 20122, "<%s> Failed in call to RunWithEnvCmdWithOutputWithTimeOut", $sMyName ); } } #---------- # Restore.. #---------- defined $sOldLogName ? $ENV { LOGNAME } = $sOldLogName : delete $ENV { LOGNAME }; return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : bool GetPidDetails ( IN Integer Pid, OUT RefList ProcList ); Description : Gets long process details for a known Pid if running Parameters : $iPid PID whose details are requested $rlProcList Ref to List to store details Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------------ =cut sub GetPidDetails { #---------------- # Get Arguments.. #---------------- my ( $iPid, $rlProcList ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20123, "Subroutine <%s> called with: Pid [%s] rlProcList [%s]", $sMyName, $iPid, $rlProcList ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; #--------------- # Validate PID.. #--------------- unless ( defined $iPid && # Catch undefs.. $iPid =~ /^\d+$/ && # And invalid PIDs.. kill ( 0, $iPid ) ) { # And defunct ones.. &logError ( 20124, "<%s> PID [%s] is invalid", $sMyName, $iPid ); return 0; } #------------------------- # Define local variables.. #------------------------- my ( $sPsCmd, $sPsCmdArgs, $sLang, $sFmt, $sUnix95, $sSwitch, $iExitCode, %hsProc ) = (); $sSwitch = $^O; # Get OS.. @$rlProcList = (); # Truncate.. #------------- # Store LANG.. #------------- $sLang = $ENV { LANG }; $ENV { LANG } = 'C'; #--------------------------- # Switch to the correct OS.. #--------------------------- goto $sSwitch; { solaris: $sPsCmd = "/usr/ucb/ps"; $sPsCmdArgs = "axwwl $iPid"; $sFmt = '[\da-z]+\s+([\d]+)\s+([\d]+)\s+([\d]+)\s+.*?[\d]:[\d]{2}\s(.*)'; last; hpux: #----------------------- # Force XPG4 behaviour.. #----------------------- $sUnix95 = $ENV { UNIX95 }; $ENV { UNIX95 } = 'XPG4'; $sPsCmd = "/usr/bin/ps"; $sPsCmdArgs = "-p $iPid -xxlo uid,pid,ppid,args"; $sFmt = '([\d]+)\s+([\d]+)\s+([\d]+)\s+(.*)'; last; aix: $sPsCmd = "/usr/bin/ps"; $sPsCmdArgs = "axwwl $iPid"; $sFmt = '[\da-e]+\s+[A-Z]\s+([\d]+)\s+([\d]+)\s+([\d]+)\s+.*?[\d]:[\d]{2}\s(.*)'; last; linux: $sPsCmd = "/bin/ps"; $sPsCmdArgs = "wwo uid,pid,ppid,args $iPid"; $sFmt = '([\d]+)\s+([\d]+)\s+([\d]+)\s+(.*)'; last; } &logTrace ( 20125, "<%s> OS [%s] PsCmd [%s] PsCmdArgs [%s]", $sMyName, $sSwitch, $sPsCmd, $sPsCmdArgs ); #------------------- # Validate command.. #------------------- if ( ! -x $sPsCmd ) { &logError ( 20126, "<%s> ps(1b) command [%s] is not executable", $sMyName, $sPsCmd ); return 0; # Failure.. } #------------------------------- # Fire command and get details.. #------------------------------- @hsProc { qw ( UID PID PPID COMMAND ) } = map { s/\n//; # Chomp.. s/^\s+//; # Strip leading spaces.. /^$sFmt$/o; # Extract fields.. } readpipe ( "$sPsCmd $sPsCmdArgs" ); # From the command.. $iExitCode = $? >> 8; # Get exit code.. #------------------------ # Restore env variables.. #------------------------ defined $sLang ? $ENV { LANG } = $sLang : delete $ENV { LANG }; defined $sUnix95 ? $ENV { UNIX95 } = $sUnix95 : delete $ENV { UNIX95 }; #------------------ # Check exit code.. #------------------ if ( $iExitCode ) { &logError ( 20127, "<%s> Cmd [%s] with args [%s] failed with exit code [%s]", $sMyName, $sPsCmd, $sPsCmdArgs, $iExitCode ); %hsProc = (); # Truncate.. return 0; } #--------------------- # Fill up the bucket.. #--------------------- push ( @$rlProcList, \%hsProc ); # Update.. return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : bool GetSrvrDetails ( IN String InitFile, OUT RefHashList SrvrDetails ); Description : Gives PID file and process string for given server type Parameters : $sInitFile The server initialization file for the Documentum connection broker $rhlSrvrDetails Stores details of PID file and process string Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------------ =cut sub GetSrvrDetails { #---------------- # Get Arguments.. #---------------- my ( $sInitFile, $rhlSrvrDetails ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20128, "Subroutine <%s> called with: InitFile [%s] SrvrDetails [%s]", $sMyName, $sInitFile, $rhlSrvrDetails ); #----------------------------- # Set return code to success.. #----------------------------- my $iReturnCode = 1; # Set to true.. #------------------- # Define variables.. #------------------- my ( $sKey, $sProc, $sPidFile, $sPIDDir, $sResourceType, $sResourceName, $iPat ) = (); #------------------------------------- # List of search patterns to monitor.. #------------------------------------- my @lsSrchPatterns = ( qr!dmdocbroker(.)*-init_file $sInitFile! ); #---------------------------------------------- # Derive our resource type and resource names.. #---------------------------------------------- $sResourceType = ( $0 =~ m@([^/]+)@g ) [-2]; $sResourceName = $ENV { VCS_LOG_RESOURCE_NAME }; $sPIDDir = "/tmp/.VRTS$sResourceType/$sResourceName/PID"; #------------------------------ # Create PID folder if needed.. #------------------------------ if ( -d $sPIDDir ) { &logTrace ( 20129, "<%s> PID folder [%s] exists", $sMyName, $sPIDDir ); } elsif ( ! mkpath ( $sPIDDir, 0, 0700 ) ) { &logWarn ( 20130, "<%s> Failed to create PID folder [%s]", $sMyName, $sPIDDir ); return 0; # Cannot proceed.. } %$rhlSrvrDetails = (); # Truncate.. #----------------------------------------------- # Set appropriate filter strings and PID files.. #----------------------------------------------- foreach $sProc ( @lsSrchPatterns ) { $sKey = 'srchstr_' . ++ $iPat; $sPidFile = "$sPIDDir/pidfile.$sKey"; @{ $$rhlSrvrDetails { $sKey } } = ( $sPidFile, $sProc ); # Store.. } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------------ Function : int GetEngineTimeout ( IN Bool UseMargin ); Description : Calculates engine timeout for entry point Parameters : $bUseMargin Flag to indicate if safety margin is requested boolean value in the set of {0,1} where 0 No safety margin needed 1 Safety margin to be used Returns: Time in secs. ------------------------------------------------------------------------------------------------------ =cut sub GetEngineTimeout { #---------------- # Get Arguments.. #---------------- my ( $bUseMargin ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20131, "Subroutine <%s> called with: UseMargin [%s]", $sMyName, $bUseMargin ); #------------------------- # Define local variables.. #------------------------- my ( $sAttribute, $sCommand, $sCommandArgs, $iEngineTimeout, $iExitCode ) = (); #---------------------------------- # Grace margins from VCS timeouts.. #---------------------------------- my %hiGraceMargin = ( 'MonitorTimeout', 10, # Seconds.. 'OnlineTimeout', 10, 'OfflineTimeout', 10, 'CleanTimeout', 20 ); #-------------------------------------------------- # Attempt to get resource level overridden values.. #-------------------------------------------------- my $sResourceName = $ENV { VCS_LOG_RESOURCE_NAME }; my ( $sEntryPointName, $sResourceType ) = reverse $0 =~ m@([^/]+)@g; ( $sAttribute = $sEntryPointName ) =~ s/(.*)/\u$1Timeout/; #----------------------------------- # Query if it has already been set.. #----------------------------------- if ( defined $::giEPTimeout && # Defined.. $::giEPTimeout =~ /^\d+/ ) { # to an integer.. $iEngineTimeout = $::giEPTimeout; &logTrace ( 20132, "<%s> Using AEPTimeout [%s] as EP timeout value", $sMyName, $iEngineTimeout ); } else { #----------------------------------------- # Form query string based on entry point.. #----------------------------------------- $sCommand = $sCmdHares; # Get global.. $sCommandArgs = "-value $sResourceName $sAttribute"; #---------------------------------- # Fire command and collect output.. #---------------------------------- ( $iEngineTimeout = readpipe ( "$sCommand $sCommandArgs 2>/dev/null" ) ) =~ s/\n//; #-------------------- # Check exit status.. #-------------------- if ( $iExitCode = $? >> 8 ) { &logTrace ( 20133, "<%s> Command [%s] with Args [%s] failed with exitcode [%s]", $sMyName, $sCommand, $sCommandArgs, $iExitCode ); } elsif ( ! $iEngineTimeout ) { # Undefined value.. &logTrace ( 20134, "<%s> Could not get [%s] from engine", $sMyName, $sAttribute ); } else { # Success.. &logTrace ( 20135, "<%s> Got [%s] as [%s] sec from engine", $sMyName, $sAttribute, $iEngineTimeout ); } #----------------------------------------- # Form query string based on entry point.. #----------------------------------------- unless ( $iEngineTimeout ) { $sCommand = $sCmdHatype; # Get global.. ( $sAttribute = $sEntryPointName ) =~ s/(.*)/\u$1Timeout/; $sResourceType = "ConnectionBroker" if $sResourceType !~ /\w/; # Ensure.. $sCommandArgs = "-value $sResourceType $sAttribute"; #---------------------------------- # Fire command and collect output.. #---------------------------------- ( $iEngineTimeout = readpipe ( "$sCommand $sCommandArgs" ) ) =~ s/\n//; #-------------------- # Check exit status.. #-------------------- if ( $iExitCode = $? >> 8 ) { &logTrace ( 20136, "<%s> Command [%s] with Args [%s] failed with exitcode [%s]", $sMyName, $sCommand, $sCommandArgs, $iExitCode ); $iEngineTimeout = $bUseMargin ? $hiGraceMargin { $sAttribute } : 0; } elsif ( ! $iEngineTimeout ) { # Empty value.. &logTrace ( 20137, "<%s> Could not get [%s] from engine", $sMyName, $sAttribute ); $iEngineTimeout = $bUseMargin ? $hiGraceMargin { $sAttribute } : 0; } else { # Success.. &logTrace ( 20138, "<%s> Got [%s] as [%s] sec from engine", $sMyName, $sAttribute, $iEngineTimeout ); } } } #---------------------------- # Apply margin if requested.. #---------------------------- if ( $bUseMargin && # Margin requested.. $iEngineTimeout >= $hiGraceMargin { $sAttribute } ) { # And valid.. $iEngineTimeout -= $hiGraceMargin { $sAttribute }; # Apply.. &logTrace ( 20139, "<%s> Setting up [%s] sec margin. Returning [%s]", $sMyName, $hiGraceMargin { $sAttribute }, $iEngineTimeout ); } return ( $iEngineTimeout ); # Secs.. } 1; # So PERL knows its included.. e k,,'K'K'K ,,./opt/VRTSvcs/bin/ConnectionBroker/ConnectionBroker.xmlST Veritas High Availability Agent 5.1 for Documentum Connection Broker UNIX Script 4.1 Symantec Specifies the logging detail performed by the agent for the resource. Valid values are: ERROR - Only logs error messages. WARN - Logs above plus warning messages. INFO - Logs above plus informational messages. TRACE - Logs above plus trace messages. This is very verbose and should only be used during initial configuration or for troubleshooting and diagnostic operations. Example: INFO Default Value: INFO INFO WARN ERROR TRACE Used to enable second-level monitoring and specify how often it is run. Second-level monitoring is a deeper, more thorough state check of the configured ConnectionBroker instance. The numeric value specifies how often that the second-level monitoring routines are run. Zero (0) means never run the second-level monitoring routines. One (1) would mean to run it every monitor interval. Two (2) means to run the second-level monitoring routines every second monitor interval, and so on. Care should be taken when setting this attribute to large numbers. For example, if the MonitorInterval is set to 60 seconds, and the SecondLevelMonitor is set to 100, then the second level check would only get performed every 100 minutes, which may not be as often as intended. In order to provide maximum flexibility, the value set is not checked for an upper limit. Thus, you could cause the second level check to occur once a month, if that is what is desired. Example: 1 Default Value: 0 Full path and file name of an external, user-supplied monitor program. If specified, the monitor entry point will execute this file to perform an additional server state check. There are no restrictions for what actions the external monitor program performs to determine the state of a ConnectionBroker instance server. The only constraint is that the external monitor program must return one of the following integer values: 0 (server is online) 110 (server is online) 100 (server is offline) 1 (server is offline) All other (server state is unknown) Symantec recommends storing the external monitor utility on the shared disk directory to ensure the file is always available on the online system. Arguments are supported. Example: 1. $ServerRoot/bin/myMonitor.pl 2. $ServerRoot/bin/myMonitor.sh arg1 arg2 Default Value: "" Documentum connection broker name which is managed by cluster server agent. Agent will use the CBName to start, stop and monitor the connection broker instance. Example: RPSCVR Default: "" The absolute path of Documentum installation directory. Example: /documentum/product/6.5 Default: "" The absolute path of directory where all the Documentum connection broker scripts ( dm_launch_CBName, dm_stop__CBName ) resides. Example: /documentum/dba Default: "" Virtual host name for this Documentum connection broker instance. Host name is used by monitor entry point to determine if the server is responding to connection requests. Specifying this attribute is required when second level monitor is enabled. Example: DMConBrk.veritas.com Default Value: "" Port number on which this Documentum connection broker instance is listening. The value specified by attribute Port is used by the monitor entry point to determine if the connection broker is responding to connection requests. Specifying this attribute is required when second level monitor is enabled. Example: 1489 Default Value: 1489 The Documentum connection broker init file which will be used by VHA agent to uniquely identify the running connection broker. Example: /documentum/dba/Docbroker.ini Default: "" UNIX user name of the owner of the Documentum directories and executables. The agent operations use this name to execute all Documentum connection broker commands. This user name also owns the Documentum connection broker processes. This user name have to be unique within a cluster. The login shell for this user must be Bourne, Korn, or C-shell. Example: dmcsadm Default: "" Encrypted password for the documentum user. Use the vcsencrypt -agent command to encrypt the password. If you are using the VCS GUI, the GUI automatically encrypts the password. Example: codOeoFidIeiFig Default: "" Full path to the file that the Agent for Documentum connection broker agent sources to set the environment variables. Example: /documentum/setEnv.sh Default: /dev/null onne kG'K'K'K G./opt/VRTSvcs/bin/ConnectionBroker/monitoronBroST#------------------------------------------------------------------ # $Copyright: Copyright (c) 2009 Symantec Corporation. # All rights reserved. # # THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF # SYMANTEC CORPORATION. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED # WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SYMANTEC CORPORATION. # # The Licensed Software and Documentation are deemed to be commercial # computer software as defined in FAR 12.212 and subject to restricted # rights as defined in FAR Section 52.227-19 "Commercial Computer # Software - Restricted Rights" and DFARS 227.7202, "Rights in # Commercial Computer Software or Commercial Computer Software # Documentation", as applicable, and any successor regulations. Any use, # modification, reproduction release, performance, display or disclosure # of the Licensed Software and Documentation by the U.S. Government # shall be solely in accordance with the terms of this Agreement. $ # # $Header: /project/isv-agent/VProAgents/ConnectionBroker/monitor.pl,v 1.2 2009/12/10 09:30:09 rkumar Exp $ # # $sAuthor: $ # # $Date: 2009/12/10 09:30:09 $ # $Revision: 1.2 $ # # Provides: ConnectionBroker # Author: rajeevk # crAgent Build: 1.91 2009/09/07 08:42:27 # crAgent Run Date: 12 Nov, 2009 # Modification History: # Known bugs/caveats: #------------------------------------------------------------------ eval 'exec /opt/VRTSperl/bin/perl -Sw $0 ${1+"$@"}' if 0; #--------------------------------------------------------- # Define the exact order to look for our agent framework.. #--------------------------------------------------------- BEGIN { my $sVCSperl = undef; my $sVCSagntfwHome = "/opt/VRTS/.ACCLib"; ( my $sDirName = $0 ) =~ s#(.*)/.*$#$1#; if ( $ENV { CLUSTER_HOME } ) { # VCS 5.0/VCSOne.. $sVCSperl = "$ENV{CLUSTER_HOME}/lib"; } else { # VCS.. $sVCSperl = "/opt/VRTSperl/lib/site_perl"; } unshift ( @INC, $sDirName, "$sVCSagntfwHome/vcs", "$sVCSagntfwHome/system", "$sVCSagntfwHome/network", $sVCSperl ); } #------------ # Be strict.. #------------ use strict 'refs'; use strict 'vars'; #------------------------------------- # Include required framework modules.. #------------------------------------- use Sys; # For call to RunCmdArgsAsUser use Version; # ACC Library version display generator use VCSagentFW; # Primary Agent Interface to the ACC Library use VCSDefines; # This contains constants that VCS uses #----------------------------------------- # Include the required ConnectionBroker module.. #----------------------------------------- use ConnectionBroker; #----------------------------------------------------------------------- # Add our version number to the version hash and check if versions are # requested.. #----------------------------------------------------------------------- my $sVer = "\$Id: monitor.pl,v 1.2 2009/12/10 09:30:09 rkumar Exp $::ETVHeader"; Version::TellVersion ( $sVer ); #---------------------------------------------------------------------- # If versions are requested, print all of the framework module versions # to stdout, then exit 0.. #---------------------------------------------------------------------- if ( 1 == Version::CheckForVersionRequest ( $ARGV [0] ) ) { #------------------------------------------------------------------ # Found the request to display all versions -- did that, now quit.. #------------------------------------------------------------------ exit 0; } #----------------------------------- # Work out entry point information.. #----------------------------------- my $sResourceName = shift; my ( $sEntryPointName, $sResourceType ) = reverse $0 =~ m@([^/]+)@g; $sResourceType = 'ConnectionBroker' if $sResourceType !~ /\w/; #--------------------------------------------------------- # Set up the return code here (this gets over written once # the entry point is called). #--------------------------------------------------------- my $iAgentReturnCode = 0; if ( $sEntryPointName eq "monitor" ) { $iAgentReturnCode = VCSDef_MonitorExit::UNKNOWN; } elsif ( $sEntryPointName eq "clean") { $iAgentReturnCode = VCSDef_CleanExit::FAILED; } #------------------------------------ # Setup Category ID for UMI logging.. #------------------------------------ my $iCategoryID = 55030; my $iCleanReason = undef; #---------------------------- # Get clean reason, if sent.. #---------------------------- $iCleanReason = shift if ( $sEntryPointName eq 'clean' ); #----------------------------------------- # Use Script50Agent style attribute list.. #----------------------------------------- my ( $argResLogLevel, # For ACCLib.. $argState, # Dummy attribute for FFDC.., $argIState, # Dummy attribute for FFDC.., $argCBName, $argDMHome, $argDMBase, $argCBHost, $argCBPort, $argInitFile, $argDMUser, $argPassword, $argEnvFile, $argMonitorProgram, $argSecondLevelMonitor ) = (); my $iCnt = 0; my ( $sKey, @lsArgVals, %hsAttribs ) = (); my @lsAttrs = qw ( ResLogLevel State IState CBName DMHome DMBase CBHost CBPort InitFile DMUser Password EnvFile MonitorProgram SecondLevelMonitor ); if ( $ENV { CLUSTER_HOME } ) { # VCS One/ #---------------------------------------- # Use Script50Agent style attribute list # Code specific to 5.0 and VCSOne. #---------------------------------------- #-------------- # Get vectors.. #-------------- do { push @{ $hsAttribs { $ARGV [$iCnt] } }, @ARGV [ $iCnt + 2 .. $iCnt + 1 + $ARGV [$iCnt + 1] ]; } while ( ( $iCnt += $ARGV [$iCnt + 1] + 2 ) <= $#ARGV ); #------------------------------------------------------------------ # ArgList for type ConnectionBroker: # ResLogLevel CBName DMHome DMBase CBHost CBPort InitFile DMUser # Password EnvFile MonitorProgram SecondLevelMonitor #------------------------------------------------------------------ ( $argResLogLevel, # For ACCLib.. $argState, # Dummy attribute for FFDC.., $argIState, # Dummy attribute for FFDC.., $argCBName, $argDMHome, $argDMBase, $argCBHost, $argCBPort, $argInitFile, $argDMUser, $argPassword, $argEnvFile, $argMonitorProgram, $argSecondLevelMonitor ) = @lsArgVals = map { @$_ } @hsAttribs { @lsAttrs }; if ( defined $hsAttribs { AEPTimeout } ) { $::giEPTimeout = ${ $hsAttribs { AEPTimeout } }[0]; } } else { #---------------------------- # Get values VCS 4.1 style #---------------------------- ( $argResLogLevel, # For ACCLib.. $argState, # Dummy attribute for FFDC.., $argIState, # Dummy attribute for FFDC.., $argCBName, $argDMHome, $argDMBase, $argCBHost, $argCBPort, $argInitFile, $argDMUser, $argPassword, $argEnvFile, $argMonitorProgram, $argSecondLevelMonitor ) = @ARGV; @lsArgVals = @ARGV; } #--------------------------------- # Populate FFDC helper variables.. #--------------------------------- $::gsUser = $argDMUser; $::gsEnvFile = $argEnvFile; #--------------------- # Handle clean again.. #--------------------- if ( $sEntryPointName eq 'clean' ) { unshift ( @lsArgVals, $iCleanReason ) } unshift ( @lsArgVals, $sResourceName ); unless ( VCSagentFW::SetupEntry ( $sEntryPointName, $iCategoryID, \$iCleanReason, \@lsArgVals ) ) { #------------------------------------------------------------------ # Some number of the "Standard Agent" arguments failed the # validation. Note that the validation subroutine has already # logged the attributes that failed the validation criteria. Exit # now with the earlier defined value of $iAgentReturnCode. #------------------------------------------------------------------ &entryPointExit ( $iAgentReturnCode ); } #------------------------------------- # Send the parameters for validation.. #------------------------------------- if ( ConnectionBroker::ArgsValid ( $sEntryPointName, $argCBName, $argDMHome, $argDMBase, $argCBHost, $argCBPort, $argInitFile, $argDMUser, $argPassword, $argEnvFile, $argMonitorProgram, $argSecondLevelMonitor ) ) { &logTrace ( 20140, "<%s> All arguments validated successfully!", $sEntryPointName ); } else { #--------------------------------------------------------------- # Some number of the arguments failed the validation.. # Exit now with the earlier defined value of iAgentReturnCode.. #--------------------------------------------------------------- &entryPointExit ( $iAgentReturnCode ); } #----------------------------------- # Args checked out ok, so continue.. #----------------------------------- #------------------------------------------ # Declare routines to handle entry points.. #------------------------------------------ my %routines = ( "monitor" => \&MonitorEntryPoint, "online" => \&OnlineEntryPoint, "offline" => \&OfflineEntryPoint, "clean" => \&CleanEntryPoint ); #---------------------------------------------------------- # Depending on our entry point, call the correct function.. #---------------------------------------------------------- if ( $routines { $sEntryPointName } ) { $iAgentReturnCode = $routines { $sEntryPointName }->(); } else { # Unknown entry pt.. &logError ( 20141, "Agent called with unsupported entry point specification of [%s]", $sEntryPointName ); ++ $iAgentReturnCode; } #------------------------------------------------------------------ # Exit the entry point, using the iAgentReturnCode we have set up.. #------------------------------------------------------------------ &entryPointExit ( $iAgentReturnCode ); #------------------------------------------------------------- # End of &main(), IE: no more execution logic; only subroutine # definitions follow.. #------------------------------------------------------------- =pod #------------------------------------------------------------- Function : int MonitorEntryPoint ( void ); Description : Monitors resource of type ConnectionBroker Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 110 ONLINE with confidence level 100 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ?? HUNG: External monitor timed out VCSDef_MonitorExit::TIMEOUT The entry point hangs if in-depth monitoring cannot be completed. #------------------------------------------------------------- =cut sub MonitorEntryPoint { #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20142, "Subroutine <%s> called", $sMyName ); #----------------------------------------- # Check if at least the processes are up.. #----------------------------------------- my $ConnectionBroker_Status = ConnectionBroker::GetResourceState ( $argCBHost, $argDMUser, $argInitFile ); #------------------------ # Discard partial cases.. #------------------------ if ( VCSDef_MonitorExit::PARTIAL_ONLINE == $ConnectionBroker_Status ) { $ConnectionBroker_Status = VCSDef_MonitorExit::OFFLINE; } #------------------------------------------------ # Exit if, not online after a superficial check.. #------------------------------------------------ if ( VCSDef_MonitorExit::ONLINE == $ConnectionBroker_Status ) { &logTrace ( 20143, "<%s> Resource [%s] online with state [%s] after first level check.", $sMyName, $sResourceName, $ConnectionBroker_Status ); } else { &logTrace ( 20144, "<%s> Resource [%s] NOT online with state [%s] after first level check.", $sMyName, $sResourceName, $ConnectionBroker_Status ); return $ConnectionBroker_Status; } #-------------------------------- # Start monitoring the resource.. #-------------------------------- $ConnectionBroker_Status = ConnectionBroker::Monitor ( $argCBHost, $argCBPort, $argDMHome, $argDMUser, $argEnvFile, $argMonitorProgram, $argSecondLevelMonitor ); return $ConnectionBroker_Status; } =pod #--------------------------------------------------------------- Function : int OnlineEntryPoint ( void ); Description : Attempts to online a resource of type ConnectionBroker Returns : Time in seconds to delay run of monitor entry point #--------------------------------------------------------------- =cut sub OnlineEntryPoint { #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20145, "Subroutine <%s> called", $sMyName ); my $iReturnCode = ConnectionBroker::GetResourceState ( $argCBHost, $argDMUser, $argInitFile ); #------------------------ # Discard partial cases.. #------------------------ if ( VCSDef_MonitorExit::PARTIAL_ONLINE == $iReturnCode ) { $iReturnCode = VCSDef_MonitorExit::OFFLINE; } #------------------------ # Start only if offline.. #------------------------ if ( VCSDef_MonitorExit::OFFLINE == $iReturnCode ) { if ( ConnectionBroker::Start ( $argCBHost, $argCBName, $argCBPort, $argDMBase, $argDMHome, $argDMUser, $argEnvFile, $argInitFile, $argMonitorProgram, $argSecondLevelMonitor ) ) { &logInfo ( 20146, "<%s> Resource [%s] started up successfully.", $sMyName, $sResourceName ); } else { #------------------------------------------------------------------ # Here, the ConnectionBroker::Start routine informed us that the online # did not work; however, all we can do is to return zero, # effectively telling the VCS engine not to wait at all before # invoking the monitor Entry Point, which is THE mechanism used by # VCS to determine a resource's state. #------------------------------------------------------------------ &logError( 20147, "<%s> Failed to online resource", $sMyName ); } } elsif ( VCSDef_MonitorExit::ONLINE == $iReturnCode ) { &logInfo ( 20148, "<%s> Processes for resource instance already up", $sMyName ); } else { # Unknown.. &logError ( 20149, "<%s> Attempt to online resource instance in invalid state", $sMyName ); } return 0; # Seconds to pause before calling monitor.. } =pod #--------------------------------------------------------------- Function : int OfflineEntryPoint ( void ); Description : Attempts to offline a resource of type ConnectionBroker Returns : Time in seconds to delay run of monitor entry point #--------------------------------------------------------------- =cut sub OfflineEntryPoint { #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20150, "Subroutine <%s> called", $sMyName ); #---------------------------------------------- # Offline the resource if not offline already.. #---------------------------------------------- if ( VCSDef_MonitorExit::OFFLINE == ConnectionBroker::GetResourceState ( $argCBHost, $argDMUser, $argInitFile ) ) { &logInfo ( 20151, "<%s> Processes for resource instance down already.", $sMyName ); } elsif ( ConnectionBroker::Stop ( $argCBName, $argDMBase, $argDMUser, $argEnvFile, $argInitFile, $argPassword ) ) { &logInfo ( 20152, "<%s> Shutdown resource [%s] successfully.", $sMyName, $sResourceName ); } else { &logError ( 20153, "<%s> Failed to offline resource", $sMyName ); } return 0; # Seconds to pause before calling monitor.. } =pod #--------------------------------------------------------------- Function : bool CleanEntryPoint ( void ); Description : Attempts to clean up a resource of type ConnectionBroker Returns : boolean value in the set of {0,1} where 0 true 1 false #--------------------------------------------------------------- =cut sub CleanEntryPoint { #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20154, "Subroutine <%s> called", $sMyName ); #----------------- # Clean resource.. #----------------- if ( ConnectionBroker::Kill ( $argCBName, $iCleanReason, $argDMBase, $argDMUser, $argEnvFile, $argInitFile, $argPassword ) ) { #-------------- # Kill worked.. #-------------- return VCSDef_CleanExit::PASSED; } else { #-------------- # Kill failed.. #-------------- &logError ( 20155, "<%s> Failed to clean resource", $sMyName ); return VCSDef_CleanExit::FAILED; } } CBHost k3R'K'K'K R./opt/VRTSvcs/bin/ContentServer/ContentServer.pmer.xmlST#------------------------------------------------------------------ # $Copyright: Copyright (c) 2009 Symantec Corporation. # All rights reserved. # # THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF # SYMANTEC CORPORATION. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED # WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SYMANTEC CORPORATION. # # The Licensed Software and Documentation are deemed to be commercial # computer software as defined in FAR 12.212 and subject to restricted # rights as defined in FAR Section 52.227-19 "Commercial Computer # Software - Restricted Rights" and DFARS 227.7202, "Rights in # Commercial Computer Software or Commercial Computer Software # Documentation", as applicable, and any successor regulations. Any use, # modification, reproduction release, performance, display or disclosure # of the Licensed Software and Documentation by the U.S. Government # shall be solely in accordance with the terms of this Agreement. $ # # $Header: /project/isv-agent/VProAgents/ContentServer/ContentServer.pm,v 1.8 2009/12/10 09:30:10 rkumar Exp $ # # $sAuthor: $ # # $Date: 2009/12/10 09:30:10 $ # $Revision: 1.8 $ # # Provides: ContentServer # Author: rajeevk # crAgent Build: 1.91 2009/09/07 08:42:27 # crAgent Run Date: 12 Nov, 2009 # Modification History: # Known bugs/caveats: #------------------------------------------------------------------ #------------ # Be strict.. #------------ use strict; #---------------------- # Declare the package.. #---------------------- package ContentServer; use ag_i18n_inc; #------------------------------------- # Include required framework modules.. #------------------------------------- use Sys; # Support generalized UNIX commands use Proc; # For calls to the process routines use Comms; # For calls to socket(3C) routines use Version; # Version display generator use VCSagentFW; # Primary Agent Interface to the ACC Library use VCSDefines; # This contains constants that VCS uses #-------------------------------- # Include standard PERL modules.. #-------------------------------- use Fcntl; use Socket; use File::Path qw ( mkpath ); use File::stat; use IPC::SysV qw ( IPC_STAT IPC_RMID ); my ( $CLUS_HOME, $sPrefix ) = (); #------------------------ # Setup VCS/VCSone home.. #------------------------ if ( $ENV { CLUSTER_HOME } ) { # VCS 5.x/VCSOne.. $CLUS_HOME ||= $ENV { CLUSTER_HOME } ||= "/opt/VRTSvcsone"; } else { # VCS 4.x.. $CLUS_HOME ||= $ENV { VCS_HOME } ||= "/opt/VRTSvcs"; } ( $sPrefix ) = $CLUS_HOME =~ /.*vcs(|one)$/; #----------------------------------------- # Define module-vendor specific commands.. #----------------------------------------- my $sCmdHares = $HARES ||= "$CLUS_HOME/bin/hares"; my $sCmdHatype = $HATYPE ||= "$CLUS_HOME/bin/hatype"; my @liRunningProcs = (); # Global.. #----------------------------------------------------------------------- # Add our version number to the version hash and check if versions are # requested.. #----------------------------------------------------------------------- my $sVer = "\$Id: ContentServer.pm,v 1.8 2009/12/10 09:30:10 rkumar Exp $::ETVHeader"; Version::TellVersion ( $sVer ); #-------------------------------- # Define ContentServer subroutines.. #-------------------------------- =pod ------------------------------------------------------------------------------------------------ Function : bool ArgsValid ( IN String EntryPointName, IN String DocbaseName, IN String DMBase, IN String InitFile, IN String DMUser, IN String EnvFile, IN String MonitorProgram, IN Integer SecondLevelMonitor ); Description : Validates the ArgList passed to the entry point. Parameters : $sEntryPointName Entry pt name $localDocbaseName Docbase repository name managed by Documentum content server $localDMBase Absolute path of documentum binaries $localInitFile The server initialization file for the Documentum content server $localDMUser Unix user owner for Documentum content server $localEnvFile Absolute path to environment file to source $localMonitorProgram Full path to external monitor program $localSecondLevelMonitor Cycle count to run in-depth monitoring Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------ =cut sub ArgsValid { #---------------------------------------- # Set up local vars from passed in ones.. #---------------------------------------- my ( $sEntryPointName, $localDocbaseName, $localDMBase, $localInitFile, $localDMUser, $localEnvFile, $localMonitorProgram, $localSecondLevelMonitor ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20001, "Subroutine <%s> called with: EntryPointName [%s] DocbaseName [%s] DMBase [%s] InitFile [%s] DMUser [%s] EnvFile [%s] MonitorProgram [%s] SecondLevelMonitor [%s]", $sMyName, $sEntryPointName, $localDocbaseName, $localDMBase, $localInitFile, $localDMUser, $localEnvFile, $localMonitorProgram, $localSecondLevelMonitor ); #------------------------------------- # Set return code to hopeful success.. #------------------------------------- my $iReturnCode = 1; #-------------------------------------------- # Create hash to weed out empty args values.. #-------------------------------------------- my ( @lsMissing, %hsArgList ) = (); my @lsArgs = qw ( EntryPointName DocbaseName DMBase InitFile DMUser EnvFile MonitorProgram SecondLevelMonitor ); @hsArgList { @lsArgs } = @_; # Assign.. #---------------------------------------- # Reqd. attributes based on entry point.. #---------------------------------------- my @lsOnlineArgs = qw ( DMBase DMUser DocbaseName EnvFile ); my @lsOfflineArgs = qw ( DMBase DMUser DocbaseName EnvFile ); my @lsMonitorArgs = qw ( DMUser DocbaseName InitFile ); my @lsCleanArgs = qw ( DMUser DocbaseName InitFile ); my %hlsNeeded = ( 'online' => \@lsOnlineArgs, 'offline' => \@lsOfflineArgs, 'monitor' => \@lsMonitorArgs, 'clean' => \@lsCleanArgs ); my @lsReqdArgs = @{ $hlsNeeded { $sEntryPointName } }; #----------------------- # Check what's missing.. #----------------------- if ( @lsMissing = grep { $hsArgList { $_ } !~ /\S/o } @lsReqdArgs ) { &logError ( 20002, "<%s> The following mandatory fields were not set [%s], Total [%s]", $sMyName, join ( ' ', @lsMissing ), scalar @lsMissing ); $iReturnCode = 0; # Failure.. } $iReturnCode || return $iReturnCode; # Return, if failed.. #----------------------------- # Remove SLM file, if exists.. #----------------------------- if ( $sEntryPointName ne 'monitor' ) { VCSagentFW::RunSecondLevelMonitor ( 1 ); # Delete.. } #------------------------------- # Individual validation starts.. #------------------------------- #----------------------------------------------- # Validation for online offline entry point(s).. #----------------------------------------------- if ( $sEntryPointName =~ /^(online|offline)$/o ) { #----------------------------- # Validate parameter EnvFile.. #----------------------------- if ( ! -e $localEnvFile ) { &logError ( 20003, "<%s> EnvFile [%s] file does not exist", $sMyName, $localEnvFile ); $iReturnCode = 0; # Failure.. } if ( ! -e $localDMBase ) { &logError ( 20004, "<%s> DMBase [%s] directory does not exist", $sMyName, $localDMBase ); $iReturnCode = 0; # Failure.. } #-------------------------- # Validate parameter DMUser.. #-------------------------- if ( ! defined getpwnam $localDMUser ) { &logError ( 20005, "<%s> DMUser [%s] is not a valid UNIX login", $sMyName, $localDMUser ); $iReturnCode = 0; # Failure.. } if ( $localDocbaseName =~ /[^A-Za-z0-9_]/ || ! ( $localDocbaseName =~ /^[A-Za-z]/ ) || ( $localDocbaseName eq "docu" ) ) { &logError ( 20006, "<%s> DocbaseName [%s] is not a valid", $sMyName, $localDocbaseName ); $iReturnCode = 0; # Failure.. } } #--------------------------------------- # Validation for online entry point(s).. #--------------------------------------- if ( $sEntryPointName eq "online" ) { #------------------------------------ # Validate parameter MonitorProgram.. #------------------------------------ if ( $localMonitorProgram =~ /(\S+)/ && # Defined.. ! -x $1 ) { &logError ( 20007, "<%s> MonitorProgram [%s] is not executable", $sMyName, $1 ); $iReturnCode = 0; # Failure.. } } $iReturnCode || &logWarn ( 20008, "<%s> Some of the attributes could not be validated. Returning [%s]", $sMyName, $iReturnCode ); return $iReturnCode ; } =pod ------------------------------------------------------------------------------------------------ Function : bool Start ( IN String DMBase, IN String DMUser, IN String DocbaseName, IN String EnvFile, IN String JavaHome, IN String InitFile, IN String MonitorProgram, IN Integer SecondLevelMonitor ); Description : Start logic needed for online entry pt Parameters : $sDMBase Absolute path of documentum binaries $sDMUser Unix user owner for Documentum content server $sDocbaseName Docbase repository name managed by Documentum content server $sEnvFile Absolute path to environment file to source $sJavaHome Absolute path of documentum java home $sInitFile The server initialization file for the Documentum content server $sMonitorProgram Full path to external monitor program $iSecondLevelMonitor Cycle count to run in-depth monitoring Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------ =cut sub Start { #---------------- # Get Arguments.. #---------------- my ( $sDMBase, $sDMUser, $sDocbaseName, $sEnvFile, $sJavaHome, $sInitFile, $sMonitorProgram, $iSecondLevelMonitor ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20009, "Subroutine <%s> called with: DMBase [%s] DMUser [%s] DocbaseName [%s] EnvFile [%s] JavaHome [%s] InitFile [%s] MonitorProgram [%s] SecondLevelMonitor [%s]", $sMyName, $sDMBase, $sDMUser, $sDocbaseName, $sEnvFile, $sJavaHome, $sInitFile, $sMonitorProgram, $iSecondLevelMonitor ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; #------------------------- # Define local variables.. #------------------------- my ( $sCommand, $sCommandArgs, $iTillWhen, $iExitCode, $iTimeout, @lsCmdout, @liPids ) = (); #----------------------------------------- # Whack any preexisting ContentServer processes.. #----------------------------------------- &logTrace ( 20010, "<%s> Killing ContentServer processes for this instance", $sMyName ); if ( ContentServer::KillContentServerProcesses ( $sDMUser, $sDocbaseName, $sInitFile ) ) { &logTrace ( 20011, "<%s> Processes for this instance do not exist before start-up", $sMyName ); } else { &logError ( 20012, "<%s> Could not remove all processes for this instance. Exiting", $sMyName ); $iReturnCode = 0; # Failure.. } #----------------------------------- # Remove preexisting IPC resources.. #----------------------------------- if ( ContentServer::RemoveIPCResourcesForUser ( $sDMUser, O_IPCSHM ) ) { &logTrace ( 20013, "<%s> IPC resources for User [%s] do not exist before startup", $sMyName, $sDMUser ); } else { &logError ( 20014, "<%s> Could not remove all IPC resources for User [%s]", $sMyName, $sDMUser ); $iReturnCode = 0; # Failure.. } #-------------------- # Return, if failed.. #-------------------- $iReturnCode || return $iReturnCode; #--------------------------------------------------------------------- # Upper bound.. Time in EPOCH when entry pt started + VCS time limit.. #--------------------------------------------------------------------- $iTillWhen = $^T + ContentServer::GetEngineTimeout ( 1 ); #------------------------------------------ # Define start command and args variables.. #------------------------------------------ $sCommand = "$sDMBase/dm_start_$sDocbaseName"; $sCommandArgs = ""; ( @lsCmdout, $iExitCode, $iTimeout ) = (); &logTrace ( 20015, "<%s> Starting ContentServer instance with Cmd [%s] Args [%s]", $sMyName, $sCommand, $sCommandArgs ); #------------------ # Request startup.. #------------------ if ( ( $iTimeout = $iTillWhen - time ) <= 10 ) { # Get time bearings.. &logError ( 20016, "<%s> Insufficient time to continue boot up. Short by [%s] sec", $sMyName, abs ( $iTimeout ) ); $iReturnCode = 0; # Failure.. } elsif ( $iReturnCode = ContentServer::ExecLocalCmd ( $sDMUser, $sEnvFile, $sCommand, $sCommandArgs, \$iExitCode, $iTimeout, \@lsCmdout ) ) { &logTrace ( 20017, "<%s> Cmd [%s] with args [%s] executed successfully", $sMyName, $sCommand, $sCommandArgs ); } #------------------- # Return if failed.. #------------------- $iReturnCode || return $iReturnCode; #-------------------- # Delay entry point.. #-------------------- my $iSleepTime = 10; # Secs.. while ( ( $iTimeout = $iTillWhen - time ) > 10 ) { @liPids = (); # Initialise.. sleep $iSleepTime; # Sec.. &logTrace ( 20018, "<%s> Confirming start-up with [%s] sec in hand", $sMyName, $iTimeout - $iSleepTime ); #--------- # Do FLM.. #--------- if ( VCSDef_MonitorExit::ONLINE == ContentServer::GetProcState ( \@liPids, $sDMUser, $sDocbaseName, $sInitFile, 1 ) ) { #--------------------- # Start-up confirmed.. #--------------------- &logInfo ( 20019, "<%s> Confirmed start-up of Content server after FLM", $sMyName ); $iReturnCode = 1; # Success.. last; } else { &logTrace ( 20020, "<%s> Could not confirm start-up. Sleeping for [%s] sec", $sMyName, $iSleepTime ); $iReturnCode = 0; # Failure.. } } if ( $iSecondLevelMonitor ) { # If enabled.. while ( ( $iTimeout = $iTillWhen - time ) > 10 ) { &logTrace ( 20021, "<%s> Confirming start-up with [%s] sec in hand by SLM health check", $sMyName, $iTimeout - $iSleepTime ); #-------- # Do SLM #-------- if ( VCSDef_MonitorExit::ONLINE == # Online after.. ContentServer::SecondLevelMonitor ( $sDMUser, # Running SLM.. $sDocbaseName, $sEnvFile, $sJavaHome, $iTillWhen ) ) { #--------------------- # Start-up confirmed.. #--------------------- &logInfo ( 20022, "<%s> Confirmed start-up of Content server after SLM", $sMyName ); $iReturnCode = 1; # Success.. last; } else { &logTrace ( 20023, "<%s> Could not confirm start-up. Sleeping for [%s] sec", $sMyName, $iSleepTime ); sleep $iSleepTime; # Sec.. $iReturnCode = 0; # Failure.. } } } #---------------------------------------------------------- # MonitorProgram defined.. # Delay Entry proint to confirm startup by external monitor #---------------------------------------------------------- if ( $sMonitorProgram =~ /\S+/ ) { my ( $sExtCmd, $sExtCmdArgs ) = $sMonitorProgram # Separate =~ /(\S+)\s*(.*)/; # Cmd and args.. $sExtCmdArgs = '' unless defined $sExtCmdArgs; # Prevent undefs.. if ( $sExtCmd ) { # Defined.. while ( ( $iTimeout = $iTillWhen - time ) > 10 ) { if ( VCSDef_MonitorExit::ONLINE == # and found online.. ContentServer::ExternalMonitor ( $sDMUser, $sEnvFile, $sExtCmd, $sExtCmdArgs, $iTillWhen ) ) { &logTrace ( 20024, "<%s> Confirmed start-up of Content Server after external monitor [%s] with args [%s]", $sMyName, $sExtCmd, $sExtCmdArgs ); $iReturnCode = 1; # Success.. last; } else { &logError ( 20025, "<%s> Could not confirm start-up after executing external monitor [%s] with args [%s]. Sleeping for [%s] sec", $sMyName, $sExtCmd, $sExtCmdArgs, $iSleepTime ); sleep $iSleepTime; # Sec.. $iReturnCode = 0; # Failure.. } } } } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : bool Stop ( IN String DMBase, IN String DMUser, IN String DocbaseName, IN String EnvFile, IN String InitFile ); Description : Stop logic needed for offline entry pt Parameters : $sDMBase Absolute path of documentum binaries $sDMUser Unix user owner for Documentum content server $sDocbaseName Docbase repository name managed by Documentum content server $sEnvFile Absolute path to environment file to source $sInitFile The server initialization file for the Documentum content server Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------ =cut sub Stop { #---------------- # Get Arguments.. #---------------- my ( $sDMBase, $sDMUser, $sDocbaseName, $sEnvFile, $sInitFile ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20026, "Subroutine <%s> called with: DMBase [%s] DMUser [%s] DocbaseName [%s] EnvFile [%s] InitFile [%s]", $sMyName, $sDMBase, $sDMUser, $sDocbaseName, $sEnvFile, $sInitFile ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; # Success.. #--------------------------------------------------------------------- # Upper bound.. Time in EPOCH when entry pt started + VCS time limit.. #--------------------------------------------------------------------- my $iTillWhen = $^T + ContentServer::GetEngineTimeout ( 1 ); # With margin.. #------------------------------------------ # Declare stop command and args variables.. #------------------------------------------ my ( $sCommand, $sCommandArgs, $iTimeout, $iExitCode, $iSleepTime, @lsCmdout, @liPids ) = (); #------------------------------------ # Define stop command and arguments.. #------------------------------------ $sCommand = "$sDMBase/dm_shutdown_$sDocbaseName"; $sCommandArgs = ""; ( $iExitCode, $iTimeout, @lsCmdout ) = (); # Truncate.. &logTrace ( 20027, "<%s> Stopping ContentServer with Command [%s] Args [%s]", $sMyName, $sCommand, $sCommandArgs ); #------------------------ # Request shutdown.. #------------------------ if ( ( $iTimeout = $iTillWhen - time ) <= 10 ) { # Get time bearings.. &logError ( 20028, "<%s> Insufficient time to continue shutdown. Short by [%s] sec", $sMyName, abs ( $iTimeout ) ); $iReturnCode = 0; # Failure.. } elsif ( $iReturnCode = ContentServer::ExecLocalCmd ( $sDMUser, $sEnvFile, $sCommand, $sCommandArgs, \$iExitCode, $iTimeout, \@lsCmdout ) ) { &logTrace ( 20029, "<%s> Cmd [%s] with args [%s] executed successfully", $sMyName, $sCommand, $sCommandArgs ); } #-------------------- # Delay entry point.. #-------------------- if ( $iReturnCode ) { # Success.. #----------------- # Set sleep time.. #----------------- $iSleepTime = 10; # Sec.. &logInfo ( 20030, "<%s> Delaying exit to confirm shutdown..", $sMyName ); #-------------------- # Delay entry point.. #-------------------- while ( ( $iTimeout = $iTillWhen - time ) > 20 ) { #----------------------- # Wait before retrying.. #----------------------- sleep $iSleepTime; # Secs.. ContentServer::GetProcState ( \@liPids, $sDMUser, $sDocbaseName, $sInitFile, 0 ); # Request regular.. #------------------------------ # Check for pending processes.. #------------------------------ if ( scalar @liPids ) { &logTrace ( 20031, "<%s> Could not confirm shutdown. Retrying in [%s] sec. Delaying kill with [%s] sec in hand", $sMyName, $iSleepTime, $iTimeout - $iSleepTime ); } else { &logInfo ( 20032, "<%s> Confirmed shutdown of ContentServer instance", $sMyName ); last; # Get out.. } } } #----------------------------------------------- # Whack any persisting ContentServer processes.. #----------------------------------------------- &logTrace ( 20033, "<%s> Killing ContentServer processes for this instance", $sMyName ); if ( ContentServer::KillContentServerProcesses ( $sDMUser, $sDocbaseName, $sInitFile ) ) { &logTrace ( 20034, "<%s> Processes for this instance do not exist after shutdown", $sMyName ); } else { &logError ( 20035, "<%s> Could not remove all processes for this instance. Exiting", $sMyName ); $iReturnCode = 0; # Failure.. } #----------------------- # Remove IPC resources.. #----------------------- if ( ContentServer::RemoveIPCResourcesForUser ( $sDMUser, O_IPCSHM ) ) { &logTrace ( 20036, "<%s> IPC resources for User [%s] do not exist before startup", $sMyName, $sDMUser ); } else { &logError ( 20037, "<%s> Could not remove all IPC resources for User [%s]", $sMyName, $sDMUser ); $iReturnCode = 0; # Failure.. } my $sResourceName = $ENV { VCS_LOG_RESOURCE_NAME }; ContentServer::DeletePidFile ( $sResourceName ); return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : bool Kill ( IN Integer CleanReason, IN String DMBase, IN String DMUser, IN String DocbaseName, IN String EnvFile, IN String InitFile ); Description : Forces shutdown of resource needed for clean entry point Parameters : $iCleanReason Why clean was called $sDMBase Absolute path of documentum binaries $sDMUser Unix user owner for Documentum content server $sDocbaseName Docbase repository name managed by Documentum content server $sEnvFile Absolute path to environment file to source $sInitFile The server initialization file for the Documentum content server Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------ =cut sub Kill { #---------------- # Get Arguments.. #---------------- my ( $iCleanReason, $sDMBase, $sDMUser, $sDocbaseName, $sEnvFile, $sInitFile ) = @_; #----------------------------- # Figure out why were called.. #----------------------------- my ( $sCleanReason, %hsCleanReasons ) = (); my @lsCleanStrings = qw ( Offline_timed_out Offline_was_ineffective Online_timed_out Online_was_ineffective Found_offline_unexpectedly Monitor_timed_out ); @hsCleanReasons { 0 .. $#lsCleanStrings } = @lsCleanStrings; # Populate.. ( $sCleanReason = $hsCleanReasons { $iCleanReason } || # Reason.. $iCleanReason ) =~ s/_/ /g; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20038, "Subroutine <%s> called with: CleanReason [%s] DMBase [%s] DMUser [%s] DocbaseName [%s] EnvFile [%s] InitFile [%s]", $sMyName, $sCleanReason, $sDMBase, $sDMUser, $sDocbaseName, $sEnvFile, $sInitFile ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; #--------------------------------------------------------------------- # Upper bound.. Time in EPOCH when entry pt started + VCS time limit.. #--------------------------------------------------------------------- my $iTillWhen = $^T + ContentServer::GetEngineTimeout ( 1 ); # With margin.. #-------------------------- # Declare local variables.. #-------------------------- my ( $sCommand, $sCommandArgs, $iTimeout, $iExitCode, @lsFiles, @lsCmdout ) = (); #------------------------------------- # Define clean command and arguments.. #------------------------------------- $sCommand = "$sDMBase/dm_shutdown_$sDocbaseName"; $sCommandArgs = "-k"; unless ( $hsCleanReasons { $iCleanReason } eq 'Offline_timed_out' || $hsCleanReasons { $iCleanReason } eq 'Offline_was_ineffective' ) { #------------------- # Try to be gentle.. #------------------- &logInfo ( 20039, "<%s> Attempting to stop ContentServer with Command [%s] Args [%s]", $sMyName, $sCommand, $sCommandArgs ); #------------------------ # Request shutdown.. #------------------------ if ( ( $iTimeout = $iTillWhen - time ) <= 10 ) { # Get time bearings.. &logError ( 20040, "<%s> Insufficient time to continue shutdown. Short by [%s] sec", $sMyName, abs ( $iTimeout ) ); $iReturnCode = 0; # Failure.. } elsif ( ContentServer::ExecLocalCmd ( $sDMUser, $sEnvFile, $sCommand, $sCommandArgs, \$iExitCode, $iTimeout, \@lsCmdout ) ) { &logTrace ( 20041, "<%s> Cmd [%s] with args [%s] executed successfully", $sMyName, $sCommand, $sCommandArgs ); } } #----------------------------------------- # Whack any persisting ContentServer processes.. #----------------------------------------- &logTrace ( 20042, "<%s> Killing ContentServer processes for this instance", $sMyName ); if ( ContentServer::KillContentServerProcesses ( $sDMUser, $sDocbaseName, $sInitFile ) ) { &logTrace ( 20043, "<%s> Processes for this instance do not exist after shutdown", $sMyName ); } else { &logError ( 20044, "<%s> Could not remove all processes for this instance. Exiting", $sMyName ); $iReturnCode = 0; # Failure.. } #----------------------- # Remove IPC resources.. #----------------------- if ( ContentServer::RemoveIPCResourcesForUser ( $sDMUser, O_IPCSHM ) ) { &logTrace ( 20045, "<%s> IPC resources for User [%s] do not exist before startup", $sMyName, $sDMUser ); } else { &logError ( 20046, "<%s> Could not remove all IPC resources for User [%s]", $sMyName, $sDMUser ); $iReturnCode = 0; # Failure.. } my $sResourceName = $ENV { VCS_LOG_RESOURCE_NAME }; ContentServer::DeletePidFile ( $sResourceName ); return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : int GetResourceState ( IN String DMUser, IN String DocbaseName, IN String InitFile ); Description : First level monitor to determine state of resource. Parameters : $sDMUser Unix user owner for Documentum content server $sDocbaseName Docbase repository name managed by Documentum content server $sInitFile The server initialization file for the Documentum content server Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 105 ONLINE with confidence level 50 VCSDef_MonitorExit::PARTIAL_ONLINE 110 ONLINE with confidence level 100 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ------------------------------------------------------------------------------------------------ =cut sub GetResourceState { #---------------- # Get Arguments.. #---------------- my ( $sDMUser, $sDocbaseName, $sInitFile ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20047, "Subroutine <%s> called: DMUser [%s] DocbaseName [%s] InitFile [%s]", $sMyName, $sDMUser, $sDocbaseName, $sInitFile ); my @liDummyPids = (); my $iReturnCode = ContentServer::GetProcState ( \@liDummyPids, $sDMUser, $sDocbaseName, $sInitFile, 1 ); # Use FFLM.. if ( VCSDef_MonitorExit::ONLINE == $iReturnCode ) { &logTrace ( 20048, "<%s> Found all required processes. Return code set to [%s]", $sMyName, $iReturnCode ); } else { &logTrace ( 20049, "<%s> Did not find all required processes. Returning [%s]", $sMyName, $iReturnCode ); } #-------------------------------- # Populate the global PID array.. #-------------------------------- @liRunningProcs = @liDummyPids; &logTrace ( 20050, "<%s> Populating global running proclist with [%s] PIDs [%s]", $sMyName, scalar @liRunningProcs, join ( ' ', @liRunningProcs ) ); return ( $iReturnCode ); } =pod ------------------------------------------------------------------------------------------------ Function : int GetProcState ( OUT ListReference OnlinePids, IN String DMUser, IN String DocbaseName, IN String InitFile, IN Integer UseFFLM ); Description : First level monitor to determine state of resource. Parameters : $rliOnlinePids PIDs of relevant running processes $sDMUser Unix user owner for Documentum content server $sDocbaseName Docbase repository name managed by Documentum content server $sInitFile The server initialization file for the Documentum content server $iUseFFLM Filtering procedure Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 105 ONLINE with confidence level 50 VCSDef_MonitorExit::PARTIAL_ONLINE 110 ONLINE with confidence level 100 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ------------------------------------------------------------------------------------------------ =cut sub GetProcState { #---------------- # Get Arguments.. #---------------- my ( $rliOnlinePids, $sDMUser, $sDocbaseName, $sInitFile, $iUseFFLM ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20051, "Subroutine <%s> called with: OnlinePids [%s] DMUser [%s] DocbaseName [%s] InitFile [%s] UseFFLM [%s]", $sMyName, $rliOnlinePids, $sDMUser, $sDocbaseName, $sInitFile, $iUseFFLM ); #----------------------------- # Set return code to success.. #----------------------------- my $iReturnCode = VCSDef_MonitorExit::ONLINE; # Success.. #---------------------- # Initialise Variables.. #---------------------- my ( $iProcessCount, $iUseRFLM, $iFound, $iUid, $iPid, $sLang, $iZonePid, $sKey, $rhlProc, $sPidFile, $sProc, $sTemp, @liOnlineMasterMthdsrv, @hProcListHash, @lsUpdates, @lsValues, $iPPid , @liOnlineChildProcess, %hiProcPids, @liProcPidsOfPPIDOne, %hsSrvrDetails, %hsCopy ) = (); my ( $bParentFound, $bChildFound, $bAgtExecFound, $bMasterMthdFound, $bWorkerMthdFound, $sFoundProcKey, %hFoundProc ) = (); @$rliOnlinePids = (); ( $bParentFound, $bChildFound, $bAgtExecFound, $bMasterMthdFound, $bWorkerMthdFound ) = ( '0' x 5 ); #------------------------------------ # Attempt to get monitoring details.. #------------------------------------ if ( $iUseFFLM != 2 ) { # Called for first level check.. if ( ContentServer::GetSrvrDetails ( $sDMUser, $sDocbaseName, $sInitFile, \%hsSrvrDetails ) ) { &logTrace ( 20052, "<%s> Got details for monitoring ContentServer instance", $sMyName ); %hsCopy = %hsSrvrDetails; # Backup.. $iUseRFLM = scalar keys %hsCopy; # Set to entire count.. } else { &logError ( 20053, "<%s> Failed to get details for monitoring ContentServer instance", $sMyName ); return VCSDef_MonitorExit::UNKNOWN; } #--------------------------------- # Check if we attempt to be fast.. #--------------------------------- if ( $iUseFFLM ) { # FFLM.. $iUseRFLM = 0; # Hopefully skip.. foreach $sKey ( keys %hsCopy ) { # Use copy.. @lsUpdates = (); # Reset.. @lsValues = @{ $hsCopy { $sKey } }; # Get values.. $sTemp .= "\nContentServer process [$sKey]\n"; # Display string.. #---------------- # Read in pairs.. #---------------- while ( ( $sPidFile, $sProc ) = splice ( @lsValues, 0, 2 ) ) { #----------- # Run FFLM.. #----------- $iFound = ContentServer::FFLMStatus ( $sPidFile, $sProc, \$iPid ); #---------------- # Update status.. #---------------- if ( $sPidFile =~ /master/ && VCSDef_MonitorExit::ONLINE == $iFound ) { push ( @liProcPidsOfPPIDOne, $iPid ); } elsif ( $sProc =~ /documentum(.)*-docbase_name $sDocbaseName(.)*-init_file $sInitFile/ && VCSDef_MonitorExit::ONLINE == $iFound ) { push ( @liOnlineChildProcess, $iPid ); } push ( @lsUpdates, $sPidFile, $sProc, $iFound ); $sTemp .= "PID File [$sPidFile]\n"; $sTemp .= "Srch Process [$sProc]\n"; $sTemp .= "FFLM Status [$iFound]\n\n"; } @{ $hsCopy { $sKey } } = @lsUpdates; #------------------------ # Handle monitor status.. #------------------------ if ( VCSDef_MonitorExit::ONLINE == $iFound ) { push ( @$rliOnlinePids, $iPid ); # Push.. } else { ++ $iUseRFLM; # Mark it for RFLM.. } } #---------------- # Print summary.. #---------------- &logTrace ( 20054, "<%s> ContentServer instance process details ---%s\n\n", $sMyName, $sTemp ); ( $sTemp, $sPidFile, $sProc ) = (); # Release memory.. } else { # Use RLFM.. #----------------------------------------- # Mark status of each service as offline.. #----------------------------------------- $iFound = VCSDef_MonitorExit::OFFLINE; # Set to offline.. foreach $sKey ( keys %hsCopy ) { @lsUpdates = (); # Reset.. @lsValues = @{ $hsCopy { $sKey } }; # Get values.. while ( scalar @lsValues ) { push ( @lsUpdates, splice ( @lsValues, 0, 2 ), $iFound ); } @{ $hsCopy { $sKey } } = @lsUpdates; # Update.. } } } else { # Called for Kill.. &logTrace ( 20055, "<%s> Called to get processes for User [%s] ", $sMyName, $sDMUser ); ++ $iUseRFLM; } #----------------------- # Regular slow :-( FLM.. #----------------------- if ( $iUseRFLM ) { &logTrace ( 20056, "<%s> Running regular first level monitor", $sMyName ); #---------------------------------- # Set LANG for better performance.. #---------------------------------- $sLang = $ENV { LANG }; # Backup.. $ENV { LANG } = 'C'; # Now set.. #----------------------------------- # Call processes and store in hash.. #----------------------------------- $iProcessCount = Proc::GetLongProcessListHash ( \@hProcListHash ); #---------- # Restore.. #---------- defined $sLang ? $ENV { LANG } = $sLang : delete $ENV { LANG }; # Restore.. #---------------------- # Check if we got any.. #---------------------- if ( $iProcessCount ) { &logTrace ( 20057, "<%s> Got [%s] processes from proc table for filtering", $sMyName, $iProcessCount ); } else { &logError ( 20058, "<%s> Call to get process list did not return any processes", $sMyName ); return VCSDef_MonitorExit::OFFLINE; # Offline.. } #----------------------- # Search for processes.. #----------------------- foreach $rhlProc ( @hProcListHash ) { #-------------------------------------------------------------- # Each $rhlProc is a ref. to a hash with the following keys.. # "UID" => # "PID" => # "PPID" => # "COMMAND" => #-------------------------------------------------------------- next unless defined $$rhlProc { UID }; # Bug in Proc::GetLongProcessListHash.. next if $$rhlProc { PID } == $$; # Skip self.. $iPid = $$rhlProc { PID }; # Assign.. $iPPid = $$rhlProc { PPID }; &logTrace ( 20059, "<%s> Searching UID [%s] PID [%s] PPID [%s] CMD [%s]", $sMyName, $$rhlProc { UID }, $$rhlProc { PID }, $$rhlProc { PPID }, $$rhlProc { COMMAND } ); #------------------------ # Get zone schedular pid #------------------------ if ( $iPid == $iPPid ) { $iZonePid = $iPid; &logTrace ( 20060, "<%s> Got the Zone schedular PID [%s]", $sMyName, $iPid ); next; } #----------------------------------------------- # Look for processes that were offline in FFLM.. #----------------------------------------------- if ( $iUseFFLM != 2 ) { # Request to filter.. foreach $sKey ( keys %hsCopy ) { @lsUpdates = (); # Reset.. @lsValues = @{ $hsCopy { $sKey } }; # Get values.. #-------------------------------------------------- # Should have details per three elements of array.. # #-------------------------------------------------- while ( ( $sPidFile, $sProc, $iFound ) = splice ( @lsValues, 0, 3 ) ) { if ( VCSDef_MonitorExit::OFFLINE == $iFound ) { # Earlier marked offline.. if ( $$rhlProc { COMMAND } =~ /$sProc/ ) { # Now found.. &logTrace ( 20061, "<%s> Found PID [%s] PPID [%s] CMD [%s] with filter [%s]", $sMyName, $iPid, $$rhlProc { PPID }, $$rhlProc { COMMAND }, $sProc ); $hFoundProc { $sProc } -> { $iPid } = $iPPid ; $hiProcPids { $sKey } = $iPid; # Store.. if ( ( $iPPid == 1 && $sPidFile =~ /master/ ) || ( $iZonePid && $iZonePid == $iPPid && $sPidFile =~ /master/ ) ) { push ( @liProcPidsOfPPIDOne, $iPid ); $iFound = VCSDef_MonitorExit::ONLINE; # Mark online.. $bParentFound = 1; &logTrace ( 20062, "<%s> Found Documentum Parent process with PID[%s] and PPID [%s] ", $sMyName, $iPid, $iPPid ); } elsif ( $#liProcPidsOfPPIDOne == 0 && $liProcPidsOfPPIDOne[0] == $iPPid ) { if ( $sProc =~ /documentum(.)*-docbase_name $sDocbaseName(.)*-init_file $sInitFile/ ) { push ( @liOnlineChildProcess, $iPid ); $iFound = VCSDef_MonitorExit::ONLINE; # Mark online.. $bChildFound = 1; &logTrace ( 20063, "<%s> Found Documentum child process with PID[%s] and PPID [%s] ", $sMyName, $iPid, $iPPid ); } elsif ( $sProc =~ /mthdsvr(.)*master(.)*$sDocbaseName/ ) { push ( @liOnlineMasterMthdsrv, $iPid ); $iFound = VCSDef_MonitorExit::ONLINE; # Mark online.. $bMasterMthdFound = 1; &logTrace ( 20064, "<%s> Found Method Server master process with PID[%s] and PPID [%s] ", $sMyName, $iPid, $iPPid ); } elsif ( ( $sProc =~ /dm_agent_exec(.)*-docbase_name(.)*$sDocbaseName.$sDocbaseName/ ) ) { $iFound = VCSDef_MonitorExit::ONLINE; $bAgtExecFound = 1; &logTrace ( 20065, "<%s> Found Agent exec process with PID[%s] and PPID [%s] ", $sMyName, $iPid, $iPPid ); } } elsif ( scalar @liOnlineMasterMthdsrv && $liOnlineMasterMthdsrv[0] == $iPPid && ( $sProc =~ /mthdsvr(.)*worker(.)*$sDocbaseName/ ) ) { $iFound = VCSDef_MonitorExit::ONLINE; $bWorkerMthdFound = 1; &logTrace ( 20066, "<%s> Found Method server worker process with PID[%s] and PPID [%s] ", $sMyName, $iPid, $iPPid ); } else { $hFoundProc { $sProc } -> { $iPid } = $iPPid ; } } } elsif ( $$rhlProc { COMMAND } =~ /$sProc/ ) { $hFoundProc { $sProc } -> { $iPid } = $iPPid ; } #---------------- # Update status.. #---------------- push ( @lsUpdates, $sPidFile, $sProc, $iFound ); } @{ $hsCopy { $sKey } } = @lsUpdates; # Update.. } } else { # Request for kill.. &logTrace ( 20067, "<%s> Pushing PID [%s] with PPID [%s] Cmd [%s] on stack", $sMyName, $iPid, $$rhlProc { PPID }, $$rhlProc { COMMAND } ); push ( @$rliOnlinePids, $iPid ); # Store.. } } if ( scalar keys %hFoundProc ) { foreach $sKey ( keys %hsCopy ) { @lsUpdates = (); # Reset.. @lsValues = @{ $hsCopy { $sKey } }; # Get values.. #-------------------------------------------------- # Should have details per three elements of array.. # #-------------------------------------------------- while ( ( $sPidFile, $sProc, $iFound ) = splice ( @lsValues, 0, 3 ) ) { if ( $hFoundProc { $sProc } ) { my %iFoundPidPPid = %{$hFoundProc { $sProc } }; my $iVal = (); if ( scalar keys %iFoundPidPPid ) { foreach $iVal ( keys %iFoundPidPPid ) { if ( $iZonePid && $iZonePid == $iFoundPidPPid { $iVal } && ! scalar @liProcPidsOfPPIDOne ) { unshift ( @liProcPidsOfPPIDOne , $iVal ); $iFound = VCSDef_MonitorExit::ONLINE; # Mark online.. $bParentFound = 1; &logTrace ( 20068, "<%s> Found Documentum Parent process with PID[%s] and PPID [%s] ", $sMyName, $iPid, $iPPid ); } if ( ( scalar @liProcPidsOfPPIDOne && $iFoundPidPPid { $iVal } == $liProcPidsOfPPIDOne[0] ) ) { if ( $sProc =~ /documentum(.)*-docbase_name $sDocbaseName(.)*-init_file $sInitFile/ ) { push ( @liOnlineChildProcess, $iPid ); $iFound = VCSDef_MonitorExit::ONLINE; # Mark online.. $bChildFound = 1; &logTrace ( 20069, "<%s> Found Documentum child process with PID[%s] and PPID [%s] ", $sMyName, $iPid, $iPPid ); } elsif ( $sProc =~ /mthdsvr(.)*master(.)*$sDocbaseName/ ) { push ( @liOnlineMasterMthdsrv, $iPid ); $iFound = VCSDef_MonitorExit::ONLINE; # Mark online.. $bMasterMthdFound = 1; &logTrace ( 20070, "<%s> Found Method Server master process with PID[%s] and PPID [%s] ", $sMyName, $iPid, $iPPid ); } elsif ( ( $sProc =~ /dm_agent_exec(.)*-docbase_name(.)*$sDocbaseName.$sDocbaseName/ ) ) { $iFound = VCSDef_MonitorExit::ONLINE; $bAgtExecFound = 1; &logTrace ( 20071, "<%s> Found Agent exec process with PID[%s] and PPID [%s] ", $sMyName, $iPid, $iPPid ); } if ( ! ( scalar @$rliOnlinePids && scalar grep ( /\b$iVal\b/, @$rliOnlinePids ) ) ) { push ( @$rliOnlinePids, $iVal ); # Store.. } } if ( scalar @liOnlineMasterMthdsrv && $liOnlineMasterMthdsrv[0] == $iFoundPidPPid { $iVal } && ( $sProc =~ /mthdsvr(.)*worker(.)*$sDocbaseName/ ) ) { $iFound = VCSDef_MonitorExit::ONLINE; $bWorkerMthdFound = 1; &logTrace ( 20072, "<%s> Found Method server worker process with PID[%s] and PPID [%s] ", $sMyName, $iPid, $iPPid ); if ( ! ( scalar @$rliOnlinePids && scalar grep ( /\b$iVal\b/, @$rliOnlinePids ) ) ) { push ( @$rliOnlinePids, $iVal ); # Store.. } } if ( ( $iFoundPidPPid { $iVal } == 1 ) || ( $iZonePid && $iFoundPidPPid { $iVal } == $iZonePid ) ) { if ( ! ( scalar @$rliOnlinePids && scalar grep ( /\b$iVal\b/, @$rliOnlinePids ) ) ) { unshift ( @$rliOnlinePids, $iVal ); # Store.. } &logTrace ( 20073, "<%s> Found Documentum process[%s] with PID [%s] PPID [%s]", $sMyName, $sProc, $iVal, $iFoundPidPPid { $iVal } ); } } } } push ( @lsUpdates, $sPidFile, $sProc, $iFound ); } @{ $hsCopy { $sKey } } = @lsUpdates; # Update.. } } } #------------------------------------ # Set final status for each process.. #------------------------------------ my ( $iOnline, $iOffline, $sEntryPointName ) = (); ( $sEntryPointName = $0 ) =~ s#.*/##; # Basename.. $sTemp = ''; # Ensure.. if ( $iUseRFLM && ( $#liProcPidsOfPPIDOne != 0 || $#liOnlineChildProcess < 0 ) ) { &logTrace ( 20074, "<%s> Parent or Child processes are missing or not identifiable NoOfProcWithPPIDOne [%s] NoOfOnlineChildProcess [%s]", $sMyName, $#liProcPidsOfPPIDOne, $#liOnlineChildProcess ); $iOffline = VCSDef_MonitorExit::OFFLINE; } else { foreach $sKey ( keys %hsCopy ) { @lsValues = @{ $hsCopy { $sKey } }; # Get values.. $sTemp .= "\nProcess [$sKey]\n"; while ( ( $sPidFile, $sProc, $iFound ) = splice ( @lsValues, 0, 3 ) ) { #----------------------------------- # Create PID files for use in FFLM.. #----------------------------------- if ( $iUseRFLM && # In RFLM.. $iUseFFLM != 2 && # Asked to filter.. $hiProcPids { $sKey } && # PID populated.. ( $sEntryPointName =~ /^(monitor|online)$/o ) ) { # In monitor or online.. &logTrace ( 20075, "<%s> Creating PID file [%s] with PID [%s]", $sMyName, $sPidFile, $hiProcPids { $sKey } ); #--------- # Create.. #--------- if ( ContentServer::CreatePidFile ( $sPidFile, $hiProcPids { $sKey } ) ) { &logTrace ( 20076, "<%s> Successfully created PID file [%s]", $sMyName, $sPidFile ); } else { &logError ( 20077, "<%s> Could not create PID file [%s] successfully", $sMyName, $sPidFile ); } } #------------- # Set status.. #------------- if ( VCSDef_MonitorExit::OFFLINE == $iFound && $sEntryPointName =~ /(monitor|online)/ && ( $sProc =~ /dm_agent_exec(.)*-docbase_name(.)*$sDocbaseName.$sDocbaseName/ ) ) { &logInfo ( 20078, "<%s> agent_exec process for the content server instance is not up", $sMyName ); $iFound = VCSDef_MonitorExit::ONLINE; } if ( VCSDef_MonitorExit::ONLINE == $iFound ) { $iOnline = $iFound; } elsif ( VCSDef_MonitorExit::OFFLINE == $iFound ) { $iOffline = $iFound; } $sTemp .= "Srch Process [$sProc]\n"; $sTemp .= "FLM Status [$iFound]\n\n"; } $sTemp .= "--------------------"; } } #------------------- # Set final status.. #------------------- $iReturnCode = $iOffline || $iOnline || VCSDef_MonitorExit::UNKNOWN; #------------------------------------------------ # Reset status based on PIDs, if not in monitor.. #------------------------------------------------ if ( $sEntryPointName ne 'monitor' && ( VCSDef_MonitorExit::OFFLINE == $iReturnCode ) && scalar @$rliOnlinePids ) { $iReturnCode = VCSDef_MonitorExit::PARTIAL_ONLINE; &logTrace ( 20079, "<%s> Found [%s] PIDs [%s] for this instance of ContentServer. Resetting return code to [%s]", $sMyName, scalar @$rliOnlinePids, join ( ' ', @$rliOnlinePids ), $iReturnCode ); } #----------------------- # Report on FLM status.. #----------------------- if ( $iUseFFLM != 2 ) { # Request to filter.. &logTrace ( 20080, "<%s> ContentServer process details ---\n%s\nReturn code is [%s]", $sMyName, $sTemp, $iReturnCode ); $sTemp = undef; # Release.. } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : int Monitor ( IN String DMUser, IN String DocbaseName, IN String EnvFile, IN String JavaHome, IN String MonitorProgram, IN Integer SecondLevelMonitor ); Description: Performs the in-depth monitoring Parameters : $sDMUser Unix user owner for Documentum content server $sDocbaseName Docbase repository name managed by Documentum content server $sEnvFile Absolute path to environment file to source $sJavaHome Absolute path of documentum java home $sMonitorProgram Full path to external monitor program $iSecondLevelMonitor Cycle count to run in-depth monitoring Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 110 ONLINE with confidence level 100 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ?? HUNG: External monitor timed out VCSDef_MonitorExit::TIMEOUT The entry point hangs if in-depth monitoring cannot be completed. ------------------------------------------------------------------------------------------------ =cut sub Monitor { #---------------- # Get Arguments.. #---------------- my ( $sDMUser, $sDocbaseName, $sEnvFile, $sJavaHome, $sMonitorProgram, $iSecondLevelMonitor ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20081, "Subroutine <%s> called with: DMUser [%s] DocbaseName [%s] EnvFile [%s] JavaHome [%s] MonitorProgram [%s] SecondLevelMonitor [%s]", $sMyName, $sDMUser, $sDocbaseName, $sEnvFile, $sJavaHome, $sMonitorProgram, $iSecondLevelMonitor ); #----------------------------- # Set return code to success.. #----------------------------- my $iReturnCode = VCSDef_MonitorExit::ONLINE; # Success.. my $iTillWhen = undef; #---------------------------------------------- # In-depth monitoring, if correct time to run.. #---------------------------------------------- if ( VCSagentFW::RunSecondLevelMonitor ( $iSecondLevelMonitor ) ) { #-------------------------- # Just In Time Validation.. #-------------------------- if ( VCSDef_MonitorExit::ONLINE == ( $iReturnCode = ContentServer::DelayedAttributeCheck ( $sDMUser, $sDocbaseName, $sEnvFile, $sJavaHome ) ) ) { &logTrace ( 20082, "<%s> Delayed attribute check completed successfully", $sMyName ); } else { &logError ( 20083, "<%s> Attribute validation failed. Returning [%s]", $sMyName, $iReturnCode ); return $iReturnCode; } &logTrace ( 20084, "<%s> Proceeding with second level monitoring", $sMyName ); #------------------------------------------------------- # Upper bound.. # Time in EPOCH when entry pt started + VCS time limit.. #------------------------------------------------------- $iTillWhen = $^T + ContentServer::GetEngineTimeout ( 1 ); if ( VCSDef_MonitorExit::ONLINE == ( $iReturnCode = ContentServer::SecondLevelMonitor ( $sDMUser, $sDocbaseName, $sEnvFile, $sJavaHome, $iTillWhen ) ) ) { &logTrace ( 20085, "<%s> ContentServer instance online with status [%s] after SLM", $sMyName, $iReturnCode ); } else { &logError ( 20086, "<%s> ContentServer instance NOT online after SLM. Status [%s]", $sMyName, $iReturnCode ); return $iReturnCode; } } #------------------------------------------------ # Exit if external monitor has not been defined.. #------------------------------------------------ return $iReturnCode unless defined $sMonitorProgram; #--------------------------------------- # MonitorProgram defined.. # Separate the executable and the args.. #--------------------------------------- my ( $sExtCmd, $sExtCmdArgs ) = $sMonitorProgram # Separate =~ /(\S+)\s*(.*)/; # Cmd and args.. $sExtCmdArgs = '' unless defined $sExtCmdArgs; # Prevent undefs.. if ( $sExtCmd ) { # Defined.. #---------------------------------------- # Get time bearings, if not got earlier.. #---------------------------------------- $iTillWhen ||= $^T + ContentServer::GetEngineTimeout ( 1 ); if ( VCSDef_MonitorExit::ONLINE == # and found online.. ( $iReturnCode = # by the status.. ContentServer::ExternalMonitor ( $sDMUser, $sEnvFile, $sExtCmd, $sExtCmdArgs, $iTillWhen ) ) ) { &logTrace ( 20087, "<%s> ContentServer instance found online with status [%s] after executing external monitor [%s] with args [%s]", $sMyName, $iReturnCode, $sExtCmd, $sExtCmdArgs ); } else { &logError ( 20088, "<%s> ContentServer instance NOT online after executing external monitor [%s] with args [%s]. Status [%s]", $sMyName, $sExtCmd, $sExtCmdArgs, $iReturnCode ); } } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : int DelayedAttributeCheck ( IN String DMUser, IN String DocbaseName, IN String EnvFile, IN String JavaHome ); Description : Just In Time Validation Parameters : $sDMUser Unix user owner for Documentum content server $sDocbaseName Docbase repository name managed by Documentum content server $sEnvFile Absolute path to environment file to source $sJavaHome Absolute path of documentum java home Returns : Integer value as defined below: 110 ONLINE with confidence level 110 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ------------------------------------------------------------------------------------------------ =cut sub DelayedAttributeCheck { #---------------- # Get Arguments.. #---------------- my ( $sDMUser, $sDocbaseName, $sEnvFile, $sJavaHome ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20089, "Subroutine <%s> called with: DMUser [%s] DocbaseName [%s] EnvFile [%s] JavaHome [%s]", $sMyName, $sDMUser, $sDocbaseName, $sEnvFile, $sJavaHome ); #----------------------------- # Set return code to success.. #----------------------------- my $iReturnCode = VCSDef_MonitorExit::ONLINE; # Success.. #-------------------------------------------- # Create hash to weed out empty args values.. #-------------------------------------------- my @lsArgs = qw ( DMUser DocbaseName EnvFile JavaHome ); my @lsReqdArgs = qw ( DMUser DocbaseName EnvFile JavaHome ); my ( @lsMissing, %hsArgList ) = (); @hsArgList { @lsArgs } = @_; # Assign.. #----------------------- # Check what's missing.. #----------------------- if ( @lsMissing = grep { $hsArgList { $_ } !~ /\S/o } @lsReqdArgs ) { &logError ( 20090, "<%s> The following mandatory fields were not set [%s], Total [%s]", $sMyName, join ( ' ', @lsMissing ), scalar @lsMissing ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; # Failure.. } #-------------------- # Return, if failed.. #-------------------- if ( VCSDef_MonitorExit::ONLINE != $iReturnCode ) { return $iReturnCode; } #------------------------------ # Validate parameter EnvFile.. #------------------------------ if ( ! -e $sEnvFile ) { &logError ( 20091, "<%s> EnvFile [%s] file does not exist", $sMyName, $sEnvFile ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; # Failure.. } #------------------------------- # Validate parameter JavaHome... #------------------------------- if ( ! -e "$sJavaHome/bin/java" ) { &logError ( 20092, "<%s> JavaHome [%s] does not contain java binary in bin folder", $sMyName, $sJavaHome ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; # Failure.. } #---------------------------------- # Validate DocbaseName paremeter... #---------------------------------- if ( $sDocbaseName =~ /[^A-Za-z0-9_]/ || ! ( $sDocbaseName =~ /^[A-Za-z]/ ) || ( $sDocbaseName eq "docu" ) ) { &logError ( 20093, "<%s> DocbaseName [%s] is not a valid", $sMyName, $sDocbaseName ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; # Failure.. } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : int SecondLevelMonitor ( IN String DMUser, IN String DocbaseName, IN String EnvFile, IN String JavaHome, IN Integer TillWhen ); Description : Does in-depth monitoring, if enabled. Parameters : $sDMUser Unix user owner for Documentum content server $sDocbaseName Docbase repository name managed by Documentum content server $sEnvFile Absolute path to environment file to source $sJavaHome Absolute path of documentum java home $iTillWhen Time in EPOCH left for IInd level monitoring Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 110 ONLINE with confidence level 110 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ?? HUNG: External monitor timed out VCSDef_MonitorExit::TIMEOUT The entry point hangs if the command cannot be completed. ------------------------------------------------------------------------------------------------ =cut sub SecondLevelMonitor { #---------------- # Get Arguments.. #---------------- my ( $sDMUser, $sDocbaseName, $sEnvFile, $sJavaHome, $iTillWhen ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20094, "Subroutine <%s> called with: DMUser [%s] DocbaseName [%s] EnvFile [%s] JavaHome [%s] TillWhen [%s]", $sMyName, $sDMUser, $sDocbaseName, $sEnvFile, $sJavaHome, $iTillWhen ); #------------------ # Hopeful success.. #------------------ my $iReturnCode = VCSDef_MonitorExit::ONLINE; #------------------------- # Define local variables.. #------------------------- my ( $iTimeout, $iExitCode, $sCommand, $sCommandArgs, @lsCmdout ) = (); #--------------------------------------------- # Declare monitor command and args variables.. #--------------------------------------------- $sCommand = $sJavaHome; $sCommand = $sCommand."/bin/java"; $sCommandArgs = "com.documentum.server.impl.utils.ContentServerStatus -docbase_name $sDocbaseName -user_name $sDMUser"; #------------------------------- # Validate and execute command.. #------------------------------- if ( ( $iTimeout = $iTillWhen - time ) <= 10 ) { # Get time bearings.. &logError ( 20095, "<%s> Insufficient time to continue in-depth monitoring. Short by [%s] sec", $sMyName, abs ( $iTimeout ) ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; # Failure.. } elsif ( ContentServer::ExecLocalCmd ( $sDMUser, $sEnvFile, $sCommand, $sCommandArgs, \$iExitCode, $iTimeout, \@lsCmdout ) ) { &logTrace ( 20096, "<%s> Cmd [%s] with args [%s] executed successfully", $sMyName, $sCommand, $sCommandArgs ); } elsif ( ! defined $iExitCode ) { $lsCmdout [0] ||= 'undef'; # Set if not defined.. $iReturnCode = $lsCmdout [0] eq 'timeout'? VCSDef_MonitorExit::TIMEOUT: # Timeout.. VCSDef_MonitorExit::UNKNOWN; # Failure.. } else { $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : int ExternalMonitor ( IN String DMUser, IN String EnvFile, IN String Cmd, IN String CmdArgs, IN Integer TillWhen ); Description : Handles user defined external monitor program Parameters : $sDMUser Unix user owner for Documentum content server $sEnvFile Absolute path to environment file to source $sCmd User defined utilty to execute $sCmdArgs Command line arguments $iTillWhen Time in EPOCH left for IInd level monitoring Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 110 ONLINE with confidence level 110 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ?? HUNG: External monitor timed out VCSDef_MonitorExit::TIMEOUT The entry point hangs if the command cannot be completed. ------------------------------------------------------------------------------------------------ =cut sub ExternalMonitor { #---------------- # Get Arguments.. #---------------- my ( $sDMUser, $sEnvFile, $sCmd, $sCmdArgs, $iTillWhen ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20097, "Subroutine <%s> called with: DMUser [%s] EnvFile [%s] Cmd [%s] CmdArgs [%s] TillWhen [%s]", $sMyName, $sDMUser, $sEnvFile, $sCmd, $sCmdArgs, $iTillWhen ); #------------------ # Hopeful success.. #------------------ my $iReturnCode = VCSDef_MonitorExit::ONLINE; #------------------------ # Setup local variables.. #------------------------ my ( $iExitCode, $iTimeout, @lsCmdout ) = (); my $iBuf = 5; # Secs.. #------------------------- # Handled exit code hash.. #------------------------- my %hiExitCodes = ( 0, VCSDef_MonitorExit::ONLINE, 110, VCSDef_MonitorExit::ONLINE, 1, VCSDef_MonitorExit::OFFLINE, 100, VCSDef_MonitorExit::OFFLINE, VCSDef_MonitorExit::TIMEOUT, VCSDef_MonitorExit::TIMEOUT ); #--------------------------------------------- # Check if command can be found and executed.. #--------------------------------------------- if ( ! -e $sCmd ) { &logError ( 20098, "<%s> External monitor [%s] does not exist", $sMyName, $sCmd ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; } elsif ( ! -x $sCmd ) { &logError ( 20099, "<%s> External monitor [%s] not executable.", $sMyName, $sCmd ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; } elsif ( $sEnvFile =~ /\S/ && ! -e $sEnvFile ) { &logError ( 20100, "<%s> EnvFile [%s] does not exist", $sMyName, $sEnvFile ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; } elsif ( ( $iTimeout = $iTillWhen - ( time + $iBuf ) ) <= 5 ) { # Lack of time.. &logError ( 20101, "<%s> Insufficient time to proceed with external monitor [%s]. Short by [%s] sec", $sMyName, $sCmd, abs ( $iTimeout ) ); $iReturnCode = VCSDef_MonitorExit::UNKNOWN; } #-------------------------------------------- # Return if validation failed at this point.. #-------------------------------------------- unless ( VCSDef_MonitorExit::ONLINE == $iReturnCode ) { return $iReturnCode; } &logTrace ( 20102, "<%s> Executing external monitor with Command [%s] Args [%s] in [%s] secs", $sMyName, $sCmd, $sCmdArgs, $iTimeout ); #---------------------- # Execute the command.. #---------------------- ContentServer::ExecLocalCmd ( $sDMUser, $sEnvFile, $sCmd, $sCmdArgs, \$iExitCode, $iTimeout, \@lsCmdout ); #------------------------ # Report on exit status.. #------------------------ if ( ! defined $iExitCode ) { $lsCmdout [0] ||= 'undef'; # Set if not defined.. $iExitCode = $lsCmdout [0] eq 'timeout'? VCSDef_MonitorExit::TIMEOUT: # Timeout.. VCSDef_MonitorExit::UNKNOWN; # Failure.. } elsif ( $hiExitCodes { $iExitCode } && VCSDef_MonitorExit::ONLINE == $hiExitCodes { $iExitCode } ) { &logTrace ( 20103, "<%s> Command [%s] with args [%s] executed successfully with exit code [%s]. Cmd output [%s]", $sMyName, $sCmd, $sCmdArgs, $iExitCode, join ( chr 012, @lsCmdout ) ); } else { &logWarn ( 20104, "<%s> Command [%s] with args [%s] execution failed with exit code [%s]. Cmd output [%s]", $sMyName, $sCmd, $sCmdArgs, $iExitCode, join ( chr 012, @lsCmdout ) ); } #-------------------------------- # Setup appropriate return code.. #-------------------------------- $iReturnCode = $hiExitCodes { $iExitCode } || VCSDef_MonitorExit::UNKNOWN; return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : bool CreatePidFile ( IN String PidFile, In Integer Pid ); Description : Creates PID file with given PID Parameters : $sPidFile File to create $iPid PID to store Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------ =cut sub CreatePidFile { #---------------- # Get Arguments.. #---------------- my ( $sPidFile, $iPid ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20105, "Subroutine <%s> called with: PidFile [%s] Pid [%s]", $sMyName, $sPidFile, $iPid ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; #----------------------- # Check against undefs.. #----------------------- unless ( defined $iPid && $iPid =~ /^\d+$/o) { $iPid ||= 'undef'; # Prevent undefs. &logError ( 20106, "<%s> PID [%s] is not a valid positive number", $sMyName, $iPid ); return 0; # Proceed no further.. } #------------------ # Create PID file.. #------------------ &logTrace ( 20107, "<%s> Creating PID file [%s] with PID [%s]", $sMyName, $sPidFile, $iPid ); if ( sysopen ( PIDFILE, $sPidFile, O_WRONLY|O_SYNC|O_CREAT|O_TRUNC, 0600 ) ) { print PIDFILE $iPid, "\n"; # Update.. unless ( close ( PIDFILE ) ) { &logWarn ( 20108, "<%s> Failed to close PidFile [%s] after update: [%s]", $sMyName, $sPidFile, $! ); $iReturnCode = 0; } } else { &logWarn ( 20109, "<%s> Failed to create PID file [%s] with PID [%s]", $sMyName, $sPidFile, $iPid ); $iReturnCode = 0; } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : bool DeletePidFile ( IN String ResourceName ); Description : Deletes PID files for the VCS resource. Parameters : $sResourceName ResourceName for which the PID files needs to be deleted. Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------ =cut sub DeletePidFile { #---------------- # Get Arguments.. #---------------- my ( $sResourceName ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20110, "Subroutine <%s> called with: ResourceName [%s]", $sMyName, $sResourceName ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; my ( $sPidFileDir, $iRet ) = (); #------------------- # Delete PID files.. #------------------- &logTrace ( 20111, "<%s> Deleting PID files for VCS resource [%s]", $sMyName, $sResourceName ); $sPidFileDir = "/tmp/.VRTSContentServer/" . $sResourceName . "/PID" ; if ( -d $sPidFileDir ) { $iRet = system("/bin/rm -rf $sPidFileDir") ; if ( $iRet == 0 ) { &logTrace ( 20112, "<%s> Successfully deleted PID files in the directory [%s].", $sMyName, $sPidFileDir ); $iReturnCode = 0; } else { &logWarn ( 20113, "<%s> Failed to delete PID files in directory [%s]. Remove the files manually.", $sMyName, $sPidFileDir ); $iReturnCode = 1; } } else { &logTrace ( 20114, "<%s> PID files for VCS resource [%s] doesn't exist.", $sMyName, $sResourceName ); } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : int FFLMStatus ( IN String PidFile, IN String Proc, IN Integer Uid, OUT RefInt Pid ); Description: Checks status of Process listed in PidFile, if running Parameters : $sPidFile Absolute path to PID file of service $sProc Process string to search for in proc table $riPid Reference to existing PID Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 110 ONLINE with confidence level 100 VCSDef_MonitorExit::ONLINE ------------------------------------------------------------------------------------------------ =cut sub FFLMStatus { #---------------- # Get Arguments.. #---------------- my ( $sPidFile, $sProc, $riPid ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20115, "Subroutine <%s> called with: PidFile [%s] Proc [%s] riPid [%s]", $sMyName, $sPidFile, $sProc, $riPid ); #----------------------------- # Set return code to success.. #----------------------------- my $iReturnCode = VCSDef_MonitorExit::ONLINE; # Success.. $$riPid = 0; # Reset.. #------------------------- # Define local variables.. #------------------------- my ( $iPid, $rhlProc, @lProcessHash ) = (); #---------------------------------- # Start by testing the attributes.. #---------------------------------- if ( $sProc !~ /\S/ ) { &logError ( 20116, "<%s> Called with empty [%s] process string", $sMyName, $sProc ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } elsif ( ! -e $sPidFile ) { &logTrace ( 20117, "<%s> PID file [%s] does not exist", $sMyName, $sPidFile ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } elsif ( ! -s $sPidFile ) { &logWarn ( 20118, "<%s> PID file [%s] is of zero bytes", $sMyName, $sPidFile ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } #--------------------- # Return, if offline.. #--------------------- return $iReturnCode unless VCSDef_MonitorExit::ONLINE == $iReturnCode; if ( open ( PIDFILE, $sPidFile ) ) { ( $iPid ) = grep { ( s/\n// || 1 ) && # Chomp.. s/.*?(\d+)$/$1/ # Get PID.. } ; $iPid = '' unless defined $iPid; # Avoid undefs.. close ( PIDFILE ) || # Close file.. &logWarn ( 20119, "<%s> Could not close PID file [%s] after read [%s]", $sMyName, $sPidFile, $! ); } else { &logError ( 20120, "<%s> Failed to open PID file [%s] for read: [%s]", $sMyName, $sPidFile, $! ); return VCSDef_MonitorExit::OFFLINE; # Failure.. } #------------------------ # Check if PID is valid.. #------------------------ if ( $iPid =~ /\d+/ && # If the valid number.. kill ( 0, $iPid ) ) { # is a PID that's alive.. &logTrace ( 20121, "<%s> PID [%s] from PID file [%s] exists", $sMyName, $iPid, $sPidFile ); #----------------------- # Search in proc table.. #----------------------- if ( ContentServer::GetPidDetails ( $iPid, \@lProcessHash ) ) { #-------------- # Got details.. #-------------- foreach $rhlProc ( @lProcessHash ) { &logTrace ( 20122, "<%s> Process details: UID [%s] PID [%s] PPID [%s] ARGS [%s]", $sMyName, $$rhlProc { UID }, $$rhlProc { PID }, $$rhlProc { PPID }, $$rhlProc { COMMAND } ); #-------------- # Now compare.. #-------------- if ( $$rhlProc { COMMAND } =~ /$sProc/ ) { # Filter match.. &logTrace ( 20123, "<%s> PID [%s] owned by UID [%s] with ARGS [%s] contains [%s]", $sMyName, $iPid, $$rhlProc { UID }, $$rhlProc { COMMAND }, $sProc ); $$riPid = $iPid; # Store.. } else { &logTrace ( 20124, "<%s> Ignoring PID [%s] owned by UID [%s] with ARGS [%s] with string [%s]", $sMyName, $iPid, $$rhlProc { UID }, $$rhlProc { COMMAND }, $sProc ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } } } else { &logTrace ( 20125, "<%s> Could not get details for PID [%s]", $sMyName, $iPid ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } } else { &logTrace ( 20126, "<%s> PID [$iPid] does not exist", $sMyName, $sPidFile ); $iReturnCode = VCSDef_MonitorExit::OFFLINE; # Failure.. } @lProcessHash = (); # Truncate.. return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : bool KillContentServerProcesses ( IN String DMUser, IN String DocbaseName, IN String InitFile ); Description : Kills processes for this instance of ContentServer Parameters : $sDMUser Unix user owner for Documentum content server $sDocbaseName Docbase repository name managed by Documentum content server $sInitFile The server initialization file for the Documentum content server Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------ =cut sub KillContentServerProcesses { #---------------- # Get Arguments.. #---------------- my ( $sDMUser, $sDocbaseName, $sInitFile ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20127, "Subroutine <%s> called with: DMUser [%s] DocbaseName [%s] InitFile [%s]", $sMyName, $sDMUser, $sDocbaseName, $sInitFile ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; # Success.. #------------------------- # Set up local variables.. #------------------------- my ( @liGoners, @liUnDead ) = (); #--------------------------------------------- # Get list of processes running for this Uid.. #--------------------------------------------- if ( ( caller 1 )[3] eq 'ContentServer::Start' ) { # During online.. @liGoners = @liRunningProcs; # Get PIDs to kill.. } else { ContentServer::GetProcState ( \@liGoners, $sDMUser, $sDocbaseName, $sInitFile, 0 ); # Set filtering choice.. } #-------------------------- # Sort in ascending order.. #-------------------------- # @liGoners = sort { $a <=> $b } @liGoners; #------------------------------------------------------------------ # We do a two level kill. The SIGINQ ensures that the PID is a # valid process before we actually issue the SIGKILL. We don't want # to report a failure for SIGKILL in case of defunct or missing # processes. #------------------------------------------------------------------ if ( scalar @liGoners ) { #---------------------- # Failed to kill some.. #---------------------- if ( @liUnDead = grep { kill ( 0, $_ ) && # Valid.. ! kill ( 9, $_ ) # and could NOT be killed.. } @liGoners ) { # From what's found.. &logError ( 20128, "<%s> PIDs not killed [%s] Total not killed [%s]", $sMyName, join ( ' ', @liUnDead ), scalar @liUnDead ); $iReturnCode = 0; # Failure.. } else { # All killed.. &logInfo ( 20129, "<%s> Killed PIDs [%s] Total killed: [%s]", $sMyName, join ( ' ', @liGoners ), scalar @liGoners ); } } else { &logTrace ( 20130, "<%s> Could not locate any process this instance of ContentServer", $sMyName ); } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : bool ExecLocalCmd ( IN String User, IN String EnvFile, IN String Command, IN String CommandArgs, OUT RefInt ExitCode, IN Integer Timeout, OUT ListReference Cmdout ); Description : Wrapper function for Sys::RunWithEnvCmdWithOutputWithTimeOut to collect output of the command. Parameters : $sUser UNIX user to run the command as $sEnvFile Absolute path to location of EnvFile to source $sCommand Absolute path to location of command $sCommandArgs Arguments to command $riExitCode Reference to collect exit code of command $iTimeout Time limit to execute the command $rlsCmdout Stores o/p from command if successful Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------ =cut sub ExecLocalCmd { #---------------- # Get Arguments.. #---------------- my ( $sUser, $sEnvFile, $sCommand, $sCommandArgs, $riExitCode, $iTimeout, $rlsCmdout ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20131, "Subroutine <%s> called with: User [%s] EnvFile [%s] Command [%s] CommandArgs [%s] riExitCode [%s] Timeout [%s] rlsCmdout [%s]", $sMyName, $sUser, $sEnvFile, $sCommand, $sCommandArgs, $riExitCode, $iTimeout, $rlsCmdout ); #--------------------------------------- # Setup return code to hopeful success.. #--------------------------------------- my $iReturnCode = 1; #------------------- # Set up arguments.. #------------------- my $bSourceUserEnv = 0; # Do not source.. my $bTimedOut = 0; # Timeout variable.. @$rlsCmdout = (); # Reset.. #----------- # Validate.. #----------- if ( ! -e $sCommand ) { &logError ( 20132, "<%s> Cmd [%s] does not exist", $sMyName, $sCommand ); $iReturnCode = 0; # Failure.. } elsif ( ! -x $sCommand ) { &logError ( 20133, "<%s> Cmd [%s] is not executable", $sMyName, $sCommand ); $iReturnCode = 0; # Failure.. } elsif ( $iTimeout <= 1 ) { &logError ( 20134, "<%s> Insufficient time [%s] to execute Cmd [%s] with Args [%s].", $sMyName, $iTimeout, $sCommand, $sCommandArgs ); $iReturnCode = 0; # Failure.. } $iReturnCode || return $iReturnCode; # Return if failed.. #---------------------- # Set LOGNAME to user.. #---------------------- my $sOldLogName = $ENV { LOGNAME }; # Backup.. $ENV { LOGNAME } = $sUser; # Now set.. &logTrace ( 20135, "<%s> Executing Command [%s] with Args [%s]", $sMyName, $sCommand, $sCommandArgs ); $iReturnCode = Sys::RunWithEnvCmdWithOutputWithTimeOut ( $sEnvFile, $bSourceUserEnv, $sCommand, $sCommandArgs, $riExitCode, $sUser, $rlsCmdout, \$bTimedOut, $iTimeout ); #--------------------------- # Remove trailing newlines.. #--------------------------- chomp @$rlsCmdout; #-------------------- # Check return code.. #-------------------- if ( $iReturnCode ) { # No error with command execution.. if ( $$riExitCode ) { # Failure.. &logTrace ( 20136, "<%s> Command [%s] with args [%s] returned exit code [%s]", $sMyName, $sCommand, $sCommandArgs, $$riExitCode ); $iReturnCode = 0; # Failure.. } else { &logTrace ( 20137, "<%s> Command [%s] with args [%s] executed successfully with exit code [%s]", $sMyName, $sCommand, $sCommandArgs, $$riExitCode ); } } else { # Execution error.. @$rlsCmdout = (); # Reset.. if ( $bTimedOut ) { # We timed out.. &logError ( 20138, "<%s> Command [%s] with args [%s] did not complete within [%s] seconds", $sMyName, $sCommand, $sCommandArgs, $iTimeout ); $$rlsCmdout [0] = 'timeout'; # Timeout.. } else { # Failure due to something else.. &logError ( 20139, "<%s> Failed in call to RunWithEnvCmdWithOutputWithTimeOut", $sMyName ); } } #---------- # Restore.. #---------- defined $sOldLogName ? $ENV { LOGNAME } = $sOldLogName : delete $ENV { LOGNAME }; return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : bool GetPidDetails ( IN Integer Pid, OUT RefList ProcList ); Description : Gets long process details for a known Pid if running Parameters : $iPid PID whose details are requested $rlProcList Ref to List to store details Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------ =cut sub GetPidDetails { #---------------- # Get Arguments.. #---------------- my ( $iPid, $rlProcList ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20140, "Subroutine <%s> called with: Pid [%s] rlProcList [%s]", $sMyName, $iPid, $rlProcList ); #-------------------------------------- # Set Return Code Optimistically to 1.. #-------------------------------------- my $iReturnCode = 1; #--------------- # Validate PID.. #--------------- unless ( defined $iPid && # Catch undefs.. $iPid =~ /^\d+$/ && # And invalid PIDs.. kill ( 0, $iPid ) ) { # And defunct ones.. &logError ( 20141, "<%s> PID [%s] is invalid", $sMyName, $iPid ); return 0; } #------------------------- # Define local variables.. #------------------------- my ( $sPsCmd, $sPsCmdArgs, $sLang, $sFmt, $sUnix95, $sSwitch, $iExitCode, %hsProc ) = (); $sSwitch = $^O; # Get OS.. @$rlProcList = (); # Truncate.. #------------- # Store LANG.. #------------- $sLang = $ENV { LANG }; $ENV { LANG } = 'C'; #--------------------------- # Switch to the correct OS.. #--------------------------- goto $sSwitch; { solaris: $sPsCmd = "/usr/ucb/ps"; $sPsCmdArgs = "axwwl $iPid"; $sFmt = '[\da-z]+\s+([\d]+)\s+([\d]+)\s+([\d]+)\s+.*?[\d]:[\d]{2}\s(.*)'; last; hpux: #----------------------- # Force XPG4 behaviour.. #----------------------- $sUnix95 = $ENV { UNIX95 }; $ENV { UNIX95 } = 'XPG4'; $sPsCmd = "/usr/bin/ps"; $sPsCmdArgs = "-p $iPid -xxlo uid,pid,ppid,args"; $sFmt = '([\d]+)\s+([\d]+)\s+([\d]+)\s+(.*)'; last; aix: $sPsCmd = "/usr/bin/ps"; $sPsCmdArgs = "axwwl $iPid"; $sFmt = '[\da-e]+\s+[A-Z]\s+([\d]+)\s+([\d]+)\s+([\d]+)\s+.*?[\d]:[\d]{2}\s(.*)'; last; linux: $sPsCmd = "/bin/ps"; $sPsCmdArgs = "wwo uid,pid,ppid,args $iPid"; $sFmt = '([\d]+)\s+([\d]+)\s+([\d]+)\s+(.*)'; last; } &logTrace ( 20142, "<%s> OS [%s] PsCmd [%s] PsCmdArgs [%s]", $sMyName, $sSwitch, $sPsCmd, $sPsCmdArgs ); #------------------- # Validate command.. #------------------- if ( ! -x $sPsCmd ) { &logError ( 20143, "<%s> ps(1b) command [%s] is not executable", $sMyName, $sPsCmd ); return 0; # Failure.. } #------------------------------- # Fire command and get details.. #------------------------------- @hsProc { qw ( UID PID PPID COMMAND ) } = map { s/\n//; # Chomp.. s/^\s+//; # Strip leading spaces.. /^$sFmt$/o; # Extract fields.. } readpipe ( "$sPsCmd $sPsCmdArgs" ); # From the command.. $iExitCode = $? >> 8; # Get exit code.. #------------------------ # Restore env variables.. #------------------------ defined $sLang ? $ENV { LANG } = $sLang : delete $ENV { LANG }; defined $sUnix95 ? $ENV { UNIX95 } = $sUnix95 : delete $ENV { UNIX95 }; #------------------ # Check exit code.. #------------------ if ( $iExitCode ) { &logError ( 20144, "<%s> Cmd [%s] with args [%s] failed with exit code [%s]", $sMyName, $sPsCmd, $sPsCmdArgs, $iExitCode ); %hsProc = (); # Truncate.. return 0; } #--------------------- # Fill up the bucket.. #--------------------- push ( @$rlProcList, \%hsProc ); # Update.. return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : bool GetSrvrDetails ( IN String DMUser, IN String DocbaseName, IN String InitFile, OUT RefHashList SrvrDetails ); Description : Gives PID file and process string for given server type Parameters : $sDMUser Unix user owner for Documentum content server $sDocbaseName Docbase repository name managed by Documentum content server $sInitFile The server initialization file for the Documentum content server $rhlSrvrDetails Stores details of PID file and process string Returns : boolean value in the set of {0,1} where 0 false 1 true ------------------------------------------------------------------------------------------------ =cut sub GetSrvrDetails { #---------------- # Get Arguments.. #---------------- my ( $sDMUser, $sDocbaseName, $sInitFile, $rhlSrvrDetails ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20145, "Subroutine <%s> called with: DMUser [%s] DocbaseName [%s] InitFile [%s] SrvrDetails [%s]", $sMyName, $sDMUser, $sDocbaseName, $sInitFile, $rhlSrvrDetails ); #----------------------------- # Set return code to success.. #----------------------------- my $iReturnCode = 1; # Set to true.. #------------------- # Define variables.. #------------------- my ( $sKey, $sProc, $sPidFile, $sPIDDir, $sResourceType, $sResourceName, $iPat ) = (); #------------------------------------- # List of search patterns to monitor.. #------------------------------------- my @lsSrchPatterns = ( qr!documentum(.)*-docbase_name $sDocbaseName(.)*-init_file $sInitFile!, qr!dm_agent_exec(.*)-docbase_name(.)*$sDocbaseName.$sDocbaseName!, qr!bin/mthdsvr(.)*master(.)*$sDocbaseName!, qr!bin/mthdsvr(.)*worker(.)*$sDocbaseName! ); #---------------------------------------------- # Derive our resource type and resource names.. #---------------------------------------------- $sResourceType = ( $0 =~ m@([^/]+)@g ) [-2]; $sResourceName = $ENV { VCS_LOG_RESOURCE_NAME }; $sPIDDir = "/tmp/.VRTS$sResourceType/$sResourceName/PID"; #------------------------------ # Create PID folder if needed.. #------------------------------ if ( -d $sPIDDir ) { &logTrace ( 20146, "<%s> PID folder [%s] exists", $sMyName, $sPIDDir ); } elsif ( ! mkpath ( $sPIDDir, 0, 0700 ) ) { &logWarn ( 20147, "<%s> Failed to create PID folder [%s]", $sMyName, $sPIDDir ); return 0; # Cannot proceed.. } %$rhlSrvrDetails = (); # Truncate.. #----------------------------------------------- # Set appropriate filter strings and PID files.. #----------------------------------------------- $sKey = 'srchstr_' . ++ $iPat; $sPidFile = "$sPIDDir/pidfile.$sKey"."_master"; @{ $$rhlSrvrDetails { $sKey } } = ( $sPidFile, $lsSrchPatterns[0] ); # Store.. foreach $sProc ( @lsSrchPatterns ) { $sKey = 'srchstr_' . ++ $iPat; $sPidFile = "$sPIDDir/pidfile.$sKey"; @{ $$rhlSrvrDetails { $sKey } } = ( $sPidFile, $sProc ); # Store.. } return $iReturnCode; } =pod -------------------------------------------------------------------------- Function : Boolean RemoveIPCResourcesForUser ( IN String User, IN Integer IpcFlags, Description : Removes IPC resources for specified UNIX user, Creator PIDs IPC IDs, if given. Parameters : $sUser : UNIX user whose IPC resources are to be removed $iIpcFlags : Behaviour flag Values for Behaviour flag: O_IPCSHM : Shared Memory O_IPCSEM : Semaphore O_IPCALL : All of the above Return Value: boolean value in the set of {0,1} where 0 false 1 true -------------------------------------------------------------------------- =cut sub RemoveIPCResourcesForUser { #---------------- # Get Arguments.. #---------------- my ( $sUser, $iIpcFlags ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20148, "Subroutine <%s> called with: User [%s] IPC Flags [%s]", $sMyName, $sUser, $iIpcFlags ); #------------------------- # Define local variables.. #------------------------- my $sIpcCommand = "/usr/bin/ipcs -mp"; my ( $sResourceType, $sResourceName, $sPidFile, $iPid, $iCPid, $iPosition, $iID, $sLine, $iExitCode, @lsData, @liMemIds, $rliIds ) = (); #------------------------------------- # Set return code to hopeful success.. #------------------------------------- my $iReturnCode = 1; #---------------------------------------------- # Derive our resource type and resource names.. #---------------------------------------------- $sResourceType = ( $0 =~ m@([^/]+)@g ) [-2]; $sResourceName = $ENV { VCS_LOG_RESOURCE_NAME }; $sPidFile = "/tmp/.VRTS$sResourceType/$sResourceName/PID/pidfile.srchstr_1_master"; #------------------------------ # Get the Pid if PidFile exist #------------------------------ if ( -e $sPidFile ) { &logTrace ( 20149, "<%s> PID file [%s] exists", $sMyName, $sPidFile ); if ( open ( PIDFILE, $sPidFile ) ) { ( $iPid ) = grep { ( s/\n// || 1 ) && # Chomp.. s/.*?(\d+)$/$1/ # Get PID.. } ; $iPid = '' unless defined $iPid; # Avoid undefs.. close ( PIDFILE ) || # Close file.. &logTrace ( 20150, "<%s> Could not close PID file [%s] after read [%s]", $sMyName, $sPidFile, $! ); } else { &logTrace ( 20151, "<%s> Failed to open PID file [%s] for read: [%s]", $sMyName, $sPidFile, $! ); $iPid = ''; } } else { $iPid = ''; &logTrace ( 20152, "<%s> PID file [%s] does not exists", $sMyName, $sPidFile ); } if ( $iPid =~ /\d+/ ) { #------------------------------------------------------------------- # Get the Shared Memory IDs created by the process with PID obtained #------------------------------------------------------------------- $iPosition = $^O eq 'linux' ? 0 : 1; @lsData = readpipe ( $sIpcCommand ); if ( $iExitCode = $? >> 8 ) { &logWarn ( 20153, "<%s> Command [%s] failed with exit code [%s]", $sMyName, $sIpcCommand, $iExitCode ); return 0; } foreach $sLine ( @lsData ) { chomp ( $sLine ); next unless ( $sLine =~ /\d+\s+\d+\s*$/ ); ( $iID, $iCPid ) = ( $sLine =~ /[^\s]+/g ) [ $iPosition, -2 ]; push @liMemIds, $iID if ( $iCPid == $iPid ); } if ( scalar @liMemIds ) { $rliIds = \@liMemIds; if ( Proc::RemoveIPCResourcesForUser ( $sUser, O_IPCSHM, $rliIds ) ) { &logTrace ( 20154, "<%s> IPC resources for User [ %s ] with CPID [ %s ] removed successfully", $sMyName, $sUser, $iPid ); } else { &logError ( 20155, "<%s> Could not remove all IPC resources for User [%s]", $sMyName, $sUser ); $iReturnCode = 0; # Failure.. } } } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : int GetEngineTimeout ( IN Bool UseMargin ); Description : Calculates engine timeout for entry point Parameters : $bUseMargin Flag to indicate if safety margin is requested boolean value in the set of {0,1} where 0 No safety margin needed 1 Safety margin to be used Returns: Time in secs. ------------------------------------------------------------------------------------------------ =cut sub GetEngineTimeout { #---------------- # Get Arguments.. #---------------- my ( $bUseMargin ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20156, "Subroutine <%s> called with: UseMargin [%s]", $sMyName, $bUseMargin ); #------------------------- # Define local variables.. #------------------------- my ( $sAttribute, $sCommand, $sCommandArgs, $iEngineTimeout, $iExitCode ) = (); #---------------------------------- # Grace margins from VCS timeouts.. #---------------------------------- my %hiGraceMargin = ( 'MonitorTimeout', 10, # Seconds.. 'OnlineTimeout', 10, 'OfflineTimeout', 10, 'CleanTimeout', 20 ); #-------------------------------------------------- # Attempt to get resource level overridden values.. #-------------------------------------------------- my $sResourceName = $ENV { VCS_LOG_RESOURCE_NAME }; my ( $sEntryPointName, $sResourceType ) = reverse $0 =~ m@([^/]+)@g; ( $sAttribute = $sEntryPointName ) =~ s/(.*)/\u$1Timeout/; #----------------------------------- # Query if it has already been set.. #----------------------------------- if ( defined $::giEPTimeout && # Defined.. $::giEPTimeout =~ /^\d+/ ) { # to an integer.. $iEngineTimeout = $::giEPTimeout; &logTrace ( 20157, "<%s> Using AEPTimeout [%s] as EP timeout value", $sMyName, $iEngineTimeout ); } else { #----------------------------------------- # Form query string based on entry point.. #----------------------------------------- $sCommand = $sCmdHares; # Get global.. $sCommandArgs = "-value $sResourceName $sAttribute"; #---------------------------------- # Fire command and collect output.. #---------------------------------- ( $iEngineTimeout = readpipe ( "$sCommand $sCommandArgs 2>/dev/null" ) ) =~ s/\n//; #-------------------- # Check exit status.. #-------------------- if ( $iExitCode = $? >> 8 ) { &logTrace ( 20158, "<%s> Command [%s] with Args [%s] failed with exitcode [%s]", $sMyName, $sCommand, $sCommandArgs, $iExitCode ); } elsif ( ! $iEngineTimeout ) { # Undefined value.. &logTrace ( 20159, "<%s> Could not get [%s] from engine", $sMyName, $sAttribute ); } else { # Success.. &logTrace ( 20160, "<%s> Got [%s] as [%s] sec from engine", $sMyName, $sAttribute, $iEngineTimeout ); } #----------------------------------------- # Form query string based on entry point.. #----------------------------------------- unless ( $iEngineTimeout ) { $sCommand = $sCmdHatype; # Get global.. ( $sAttribute = $sEntryPointName ) =~ s/(.*)/\u$1Timeout/; $sResourceType = "ContentServer" if $sResourceType !~ /\w/; # Ensure.. $sCommandArgs = "-value $sResourceType $sAttribute"; #---------------------------------- # Fire command and collect output.. #---------------------------------- ( $iEngineTimeout = readpipe ( "$sCommand $sCommandArgs" ) ) =~ s/\n//; #-------------------- # Check exit status.. #-------------------- if ( $iExitCode = $? >> 8 ) { &logTrace ( 20161, "<%s> Command [%s] with Args [%s] failed with exitcode [%s]", $sMyName, $sCommand, $sCommandArgs, $iExitCode ); $iEngineTimeout = $bUseMargin ? $hiGraceMargin { $sAttribute } : 0; } elsif ( ! $iEngineTimeout ) { # Empty value.. &logTrace ( 20162, "<%s> Could not get [%s] from engine", $sMyName, $sAttribute ); $iEngineTimeout = $bUseMargin ? $hiGraceMargin { $sAttribute } : 0; } else { # Success.. &logTrace ( 20163, "<%s> Got [%s] as [%s] sec from engine", $sMyName, $sAttribute, $iEngineTimeout ); } } } #---------------------------- # Apply margin if requested.. #---------------------------- if ( $bUseMargin && # Margin requested.. $iEngineTimeout >= $hiGraceMargin { $sAttribute } ) { # And valid.. $iEngineTimeout -= $hiGraceMargin { $sAttribute }; # Apply.. &logTrace ( 20164, "<%s> Setting up [%s] sec margin. Returning [%s]", $sMyName, $hiGraceMargin { $sAttribute }, $iEngineTimeout ); } return ( $iEngineTimeout ); # Secs.. } 1; # So PERL knows its included.. gineTi k9&'K'K'K &./opt/VRTSvcs/bin/ContentServer/ContentServer.xmlr.xmlST Veritas High Availability Agent 5.1 for Documentum Content Server UNIX Script 4.1 Symantec Specifies the logging detail performed by the agent for the resource. Valid values are: ERROR - Only logs error messages. WARN - Logs above plus warning messages. INFO - Logs above plus informational messages. TRACE - Logs above plus trace messages. This is very verbose and should only be used during initial configuration or for troubleshooting and diagnostic operations. Example: INFO Default Value: INFO INFO WARN ERROR TRACE Used to enable second-level monitoring and specify how often it is run. Second-level monitoring is a deeper, more thorough state check of the configured ContentServer instance. The numeric value specifies how often that the second-level monitoring routines are run. Zero (0) means never run the second-level monitoring routines. One (1) would mean to run it every monitor interval. Two (2) means to run the second-level monitoring routines every second monitor interval, and so on. Care should be taken when setting this attribute to large numbers. For example, if the MonitorInterval is set to 60 seconds, and the SecondLevelMonitor is set to 100, then the second level check would only get performed every 100 minutes, which may not be as often as intended. In order to provide maximum flexibility, the value set is not checked for an upper limit. Thus, you could cause the second level check to occur once a month, if that is what is desired. Example: 1 Default Value: 0 Full path and file name of an external, user-supplied monitor program. If specified, the monitor entry point will execute this file to perform an additional server state check. There are no restrictions for what actions the external monitor program performs to determine the state of a ContentServer instance server. The only constraint is that the external monitor program must return one of the following integer values: 0 (server is online) 110 (server is online) 100 (server is offline) 1 (server is offline) All other (server state is unknown) Symantec recommends storing the external monitor utility on the shared disk directory to ensure the file is always available on the online system. Arguments are supported. Example: 1. $ServerRoot/bin/myMonitor.pl 2. $ServerRoot/bin/myMonitor.sh arg1 arg2 Default Value: "" Docbase repository name which is managed by Documentum content server. Agent will use the DocbaseName to start, stop and monitor the content server instance. Example: RPSCVR Default: "" The absolute path of directory where all the Documentum content server scripts ( dm_start_DocbaseName, dm_shutdown_DocbaseName ) resides. Example: /documentum/dba Default: "" The Documentum content server init file which will be used by VHA agent to uniquely identify the running content server. Example: /documentum/dba/config/REPCVR/server.ini Default: "" UNIX user name of the owner of the Documentum content server directories and executables. The agent operations use this name to execute all Documentum content server commands. This user name also owns the Documentum content server processes. This user name does not have to be unique within a cluster. The login shell for this user must be Bourne, Korn, or C-shell. Example: dmcsadm Default: "" Full path to the file that the Agent for Documentum content server sources to set the environment variables. Example: /documentum/setEnv.sh Default: /dev/null Absolute path of the directory which conatins the Java binaries of the documentum installation. The JavaHome/bin/java will be used by the agent to run the second level monitoring utility. Example: /documentum/shared/java/1.5.0_12 Default: "" ion="Sc k@E'K'K'K E./opt/VRTSvcs/bin/ContentServer/monitorST#------------------------------------------------------------------ # $Copyright: Copyright (c) 2009 Symantec Corporation. # All rights reserved. # # THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF # SYMANTEC CORPORATION. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED # WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SYMANTEC CORPORATION. # # The Licensed Software and Documentation are deemed to be commercial # computer software as defined in FAR 12.212 and subject to restricted # rights as defined in FAR Section 52.227-19 "Commercial Computer # Software - Restricted Rights" and DFARS 227.7202, "Rights in # Commercial Computer Software or Commercial Computer Software # Documentation", as applicable, and any successor regulations. Any use, # modification, reproduction release, performance, display or disclosure # of the Licensed Software and Documentation by the U.S. Government # shall be solely in accordance with the terms of this Agreement. $ # # $Header: /project/isv-agent/VProAgents/ContentServer/monitor.pl,v 1.3 2009/12/10 09:30:10 rkumar Exp $ # # $sAuthor: $ # # $Date: 2009/12/10 09:30:10 $ # $Revision: 1.3 $ # # Provides: ContentServer # Author: rajeevk # crAgent Build: 1.91 2009/09/07 08:42:27 # crAgent Run Date: 12 Nov, 2009 # Modification History: # Known bugs/caveats: #------------------------------------------------------------------ eval 'exec /opt/VRTSperl/bin/perl -Sw $0 ${1+"$@"}' if 0; #--------------------------------------------------------- # Define the exact order to look for our agent framework.. #--------------------------------------------------------- BEGIN { my $sVCSperl = undef; my $sVCSagntfwHome = "/opt/VRTS/.ACCLib"; ( my $sDirName = $0 ) =~ s#(.*)/.*$#$1#; if ( $ENV { CLUSTER_HOME } ) { # VCS 5.0/VCSOne.. $sVCSperl = "$ENV{CLUSTER_HOME}/lib"; } else { # VCS.. $sVCSperl = "/opt/VRTSperl/lib/site_perl"; } unshift ( @INC, $sDirName, "$sVCSagntfwHome/vcs", "$sVCSagntfwHome/system", "$sVCSagntfwHome/network", $sVCSperl ); } #------------ # Be strict.. #------------ use strict 'refs'; use strict 'vars'; #------------------------------------- # Include required framework modules.. #------------------------------------- use Sys; # For call to RunCmdArgsAsUser use Version; # ACC Library version display generator use VCSagentFW; # Primary Agent Interface to the ACC Library use VCSDefines; # This contains constants that VCS uses #----------------------------------------- # Include the required ContentServer module.. #----------------------------------------- use ContentServer; #----------------------------------------------------------------------- # Add our version number to the version hash and check if versions are # requested.. #----------------------------------------------------------------------- my $sVer = "\$Id: monitor.pl,v 1.3 2009/12/10 09:30:10 rkumar Exp $::ETVHeader"; Version::TellVersion ( $sVer ); #---------------------------------------------------------------------- # If versions are requested, print all of the framework module versions # to stdout, then exit 0.. #---------------------------------------------------------------------- if ( 1 == Version::CheckForVersionRequest ( $ARGV [0] ) ) { #------------------------------------------------------------------ # Found the request to display all versions -- did that, now quit.. #------------------------------------------------------------------ exit 0; } #----------------------------------- # Work out entry point information.. #----------------------------------- my $sResourceName = shift; my ( $sEntryPointName, $sResourceType ) = reverse $0 =~ m@([^/]+)@g; $sResourceType = 'ContentServer' if $sResourceType !~ /\w/; #--------------------------------------------------------- # Set up the return code here (this gets over written once # the entry point is called). #--------------------------------------------------------- my $iAgentReturnCode = 0; if ( $sEntryPointName eq "monitor" ) { $iAgentReturnCode = VCSDef_MonitorExit::UNKNOWN; } elsif ( $sEntryPointName eq "clean") { $iAgentReturnCode = VCSDef_CleanExit::FAILED; } #------------------------------------ # Setup Category ID for UMI logging.. #------------------------------------ my $iCategoryID = 55029; my $iCleanReason = undef; #---------------------------- # Get clean reason, if sent.. #---------------------------- $iCleanReason = shift if ( $sEntryPointName eq 'clean' ); #----------------------------------------- # Use Script50Agent style attribute list.. #----------------------------------------- my ( $argResLogLevel, # For ACCLib.. $argState, # Dummy attribute for FFDC.., $argIState, # Dummy attribute for FFDC.., $argDocbaseName, $argDMBase, $argInitFile, $argDMUser, $argEnvFile, $argJavaHome, $argMonitorProgram, $argSecondLevelMonitor ) = (); my $iCnt = 0; my ( $sKey, @lsArgVals, %hsAttribs ) = (); my @lsAttrs = qw ( ResLogLevel State IState DocbaseName DMBase InitFile DMUser EnvFile JavaHome MonitorProgram SecondLevelMonitor ); if ( $ENV { CLUSTER_HOME } ) { # VCS One/ #---------------------------------------- # Use Script50Agent style attribute list # Code specific to 5.0 and VCSOne. #---------------------------------------- #-------------- # Get vectors.. #-------------- do { push @{ $hsAttribs { $ARGV [$iCnt] } }, @ARGV [ $iCnt + 2 .. $iCnt + 1 + $ARGV [$iCnt + 1] ]; } while ( ( $iCnt += $ARGV [$iCnt + 1] + 2 ) <= $#ARGV ); #------------------------------------------------------------------ # ArgList for type ContentServer: # ResLogLevel DocbaseName DMBase InitFile DMUser EnvFile # MonitorProgram SecondLevelMonitor #------------------------------------------------------------------ ( $argResLogLevel, # For ACCLib.. $argState, # Dummy attribute for FFDC.., $argIState, # Dummy attribute for FFDC.., $argDocbaseName, $argDMBase, $argInitFile, $argDMUser, $argEnvFile, $argJavaHome, $argMonitorProgram, $argSecondLevelMonitor ) = @lsArgVals = map { @$_ } @hsAttribs { @lsAttrs }; if ( defined $hsAttribs { AEPTimeout } ) { $::giEPTimeout = ${ $hsAttribs { AEPTimeout } }[0]; } } else { #---------------------------- # Get values VCS 4.1 style #---------------------------- ( $argResLogLevel, # For ACCLib.. $argState, # Dummy attribute for FFDC.., $argIState, # Dummy attribute for FFDC.., $argDocbaseName, $argDMBase, $argInitFile, $argDMUser, $argEnvFile, $argJavaHome, $argMonitorProgram, $argSecondLevelMonitor ) = @ARGV; @lsArgVals = @ARGV; } #--------------------------------- # Populate FFDC helper variables.. #--------------------------------- $::gsUser = $argDMUser; $::gsEnvFile = $argEnvFile; #--------------------- # Handle clean again.. #--------------------- if ( $sEntryPointName eq 'clean' ) { unshift ( @lsArgVals, $iCleanReason ) } unshift ( @lsArgVals, $sResourceName ); unless ( VCSagentFW::SetupEntry ( $sEntryPointName, $iCategoryID, \$iCleanReason, \@lsArgVals ) ) { #------------------------------------------------------------------ # Some number of the "Standard Agent" arguments failed the # validation. Note that the validation subroutine has already # logged the attributes that failed the validation criteria. Exit # now with the earlier defined value of $iAgentReturnCode. #------------------------------------------------------------------ &entryPointExit ( $iAgentReturnCode ); } #------------------------------------- # Send the parameters for validation.. #------------------------------------- if ( ContentServer::ArgsValid ( $sEntryPointName, $argDocbaseName, $argDMBase, $argInitFile, $argDMUser, $argEnvFile, $argMonitorProgram, $argSecondLevelMonitor ) ) { &logTrace ( 20165, "<%s> All arguments validated successfully!", $sEntryPointName ); } else { #--------------------------------------------------------------- # Some number of the arguments failed the validation.. # Exit now with the earlier defined value of iAgentReturnCode.. #--------------------------------------------------------------- &entryPointExit ( $iAgentReturnCode ); } #----------------------------------- # Args checked out ok, so continue.. #----------------------------------- #------------------------------------------ # Declare routines to handle entry points.. #------------------------------------------ my %routines = ( "monitor" => \&MonitorEntryPoint, "online" => \&OnlineEntryPoint, "offline" => \&OfflineEntryPoint, "clean" => \&CleanEntryPoint ); #---------------------------------------------------------- # Depending on our entry point, call the correct function.. #---------------------------------------------------------- if ( $routines { $sEntryPointName } ) { $iAgentReturnCode = $routines { $sEntryPointName }->(); } else { # Unknown entry pt.. &logError ( 20166, "Agent called with unsupported entry point specification of [%s]", $sEntryPointName ); ++ $iAgentReturnCode; } #------------------------------------------------------------------ # Exit the entry point, using the iAgentReturnCode we have set up.. #------------------------------------------------------------------ &entryPointExit ( $iAgentReturnCode ); #------------------------------------------------------------- # End of &main(), IE: no more execution logic; only subroutine # definitions follow.. #------------------------------------------------------------- =pod #------------------------------------------------------------------------- Function : int MonitorEntryPoint ( void ); Description : Monitors resource of type ContentServer Returns : Integer value as defined below: 100 OFFLINE VCSDef_MonitorExit::OFFLINE 110 ONLINE with confidence level 100 VCSDef_MonitorExit::ONLINE 99 UNKNOWN; State couldn't be determined VCSDef_MonitorExit::UNKNOWN ?? HUNG: External monitor timed out VCSDef_MonitorExit::TIMEOUT The entry point hangs if in-depth monitoring cannot be completed. #-------------------------------------------------------------------------- =cut sub MonitorEntryPoint { #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20167, "Subroutine <%s> called", $sMyName ); #----------------------------------------- # Check if at least the processes are up.. #----------------------------------------- my $ContentServer_Status = ContentServer::GetResourceState ( $argDMUser, $argDocbaseName, $argInitFile ); #------------------------ # Discard partial cases.. #------------------------ if ( VCSDef_MonitorExit::PARTIAL_ONLINE == $ContentServer_Status ) { $ContentServer_Status = VCSDef_MonitorExit::OFFLINE; } #------------------------------------------------ # Exit if, not online after a superficial check.. #------------------------------------------------ if ( VCSDef_MonitorExit::ONLINE == $ContentServer_Status ) { &logTrace ( 20168, "<%s> Resource [%s] online with state [%s] after first level check.", $sMyName, $sResourceName, $ContentServer_Status ); } else { &logTrace ( 20169, "<%s> Resource [%s] NOT online with state [%s] after first level check.", $sMyName, $sResourceName, $ContentServer_Status ); return $ContentServer_Status; } #-------------------------------- # Start monitoring the resource.. #-------------------------------- $ContentServer_Status = ContentServer::Monitor ( $argDMUser, $argDocbaseName, $argEnvFile, $argJavaHome, $argMonitorProgram, $argSecondLevelMonitor ); return $ContentServer_Status; } =pod #--------------------------------------------------------------- Function : int OnlineEntryPoint ( void ); Description : Attempts to online a resource of type ContentServer Returns : Time in seconds to delay run of monitor entry point #--------------------------------------------------------------- =cut sub OnlineEntryPoint { #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20170, "Subroutine <%s> called", $sMyName ); my $iReturnCode = ContentServer::GetResourceState ( $argDMUser, $argDocbaseName, $argInitFile ); #------------------------ # Discard partial cases.. #------------------------ if ( VCSDef_MonitorExit::PARTIAL_ONLINE == $iReturnCode ) { $iReturnCode = VCSDef_MonitorExit::OFFLINE; } #------------------------ # Start only if offline.. #------------------------ if ( VCSDef_MonitorExit::OFFLINE == $iReturnCode ) { if ( ContentServer::Start ( $argDMBase, $argDMUser, $argDocbaseName, $argEnvFile, $argJavaHome, $argInitFile, $argMonitorProgram, $argSecondLevelMonitor ) ) { &logInfo ( 20171, "<%s> Resource [%s] started up successfully.", $sMyName, $sResourceName ); } else { #------------------------------------------------------------------ # Here, the ContentServer::Start routine informed us that the online # did not work; however, all we can do is to return zero, # effectively telling the VCS engine not to wait at all before # invoking the monitor Entry Point, which is THE mechanism used by # VCS to determine a resource's state. #------------------------------------------------------------------ &logError( 20172, "<%s> Failed to online resource", $sMyName ); } } elsif ( VCSDef_MonitorExit::ONLINE == $iReturnCode ) { &logInfo ( 20173, "<%s> Processes for resource instance already up", $sMyName ); } else { # Unknown.. &logError ( 20174, "<%s> Attempt to online resource instance in invalid state", $sMyName ); } return 0; # Seconds to pause before calling monitor.. } =pod #----------------------------------------------------------------- Function : int OfflineEntryPoint ( void ); Description : Attempts to offline a resource of type ContentServer Returns : Time in seconds to delay run of monitor entry point #------------------------------------------------------------------ =cut sub OfflineEntryPoint { #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20175, "Subroutine <%s> called", $sMyName ); #---------------------------------------------- # Offline the resource if not offline already.. #---------------------------------------------- if ( VCSDef_MonitorExit::OFFLINE == ContentServer::GetResourceState ( $argDMUser, $argDocbaseName, $argInitFile ) ) { &logInfo ( 20176, "<%s> Processes for resource instance down already.", $sMyName ); } elsif ( ContentServer::Stop ( $argDMBase, $argDMUser, $argDocbaseName, $argEnvFile, $argInitFile ) ) { &logInfo ( 20177, "<%s> Shutdown resource [%s] successfully.", $sMyName, $sResourceName ); } else { &logError ( 20178, "<%s> Failed to offline resource", $sMyName ); } return 0; # Seconds to pause before calling monitor.. } =pod #--------------------------------------------------------------- Function : bool CleanEntryPoint ( void ); Description : Attempts to clean up a resource of type ContentServer Returns : boolean value in the set of {0,1} where 0 true 1 false #--------------------------------------------------------------- =cut sub CleanEntryPoint { #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20179, "Subroutine <%s> called", $sMyName ); #----------------- # Clean resource.. #----------------- if ( ContentServer::Kill ( $iCleanReason, $argDMBase, $argDMUser, $argDocbaseName, $argEnvFile, $argInitFile ) ) { #-------------- # Kill worked.. #-------------- return VCSDef_CleanExit::PASSED; } else { #-------------- # Kill failed.. #-------------- &logError ( 20180, "<%s> Failed to clean resource", $sMyName ); return VCSDef_CleanExit::FAILED; } } orEx kk'K'K'K ./opt/VRTSvcs/messages/en/VRTSvcsAIXConnectionBroker.bmcfcfSTGK'enHADN"N@p|N"NHpNON NNNN@|.s!q=Go 7 V  U n  SDG SV=)1)#x/~cVCS:20002:ConnectionBroker:%s:%s:<%s> The following mandatory fields were not set [%s], Total [%s]GVCS:20003:ConnectionBroker:%s:%s:<%s> EnvFile [%s] file does not existAVCS:20004:ConnectionBroker:%s:%s:<%s> DMBase [%s] does not existLVCS:20005:ConnectionBroker:%s:%s:<%s> DMUser [%s] is not a valid UNIX loginZVCS:20006:ConnectionBroker:%s:%s:<%s> Init File [%s] for connection broker does not existLVCS:20007:ConnectionBroker:%s:%s:<%s> MonitorProgram [%s] is not executabledVCS:20008:ConnectionBroker:%s:%s:<%s> Some of the attributes could not be validated. Returning [%s]`VCS:20012:ConnectionBroker:%s:%s:<%s> Could not remove all processes for this instance. Exiting_VCS:20014:ConnectionBroker:%s:%s:<%s> Insufficient time to continue boot up. Short by [%s] secsVCS:20017:ConnectionBroker:%s:%s:<%s> Process check confirmed start-up of this instance of ConnectionBroker serverzVCS:20020:ConnectionBroker:%s:%s:<%s> Second Level Monitor Confirmed start-up of this instance of ConnectionBroker server`VCS:20026:ConnectionBroker:%s:%s:<%s> Insufficient time to continue shutdown. Short by [%s] secJVCS:20028:ConnectionBroker:%s:%s:<%s> Delaying exit to confirm shutdown..VVCS:20030:ConnectionBroker:%s:%s:<%s> Confirmed shutdown of ConnectionBroker instance`VCS:20033:ConnectionBroker:%s:%s:<%s> Could not remove all processes for this instance. ExitingfVCS:20035:ConnectionBroker:%s:%s:<%s> Attempting to stop ConnectionBroker with Command [%s] Args [%s]`VCS:20036:ConnectionBroker:%s:%s:<%s> Insufficient time to continue shutdown. Short by [%s] sec`VCS:20040:ConnectionBroker:%s:%s:<%s> Could not remove all processes for this instance. ExitingeVCS:20047:ConnectionBroker:%s:%s:<%s> Failed to get details for monitoring ConnectionBroker instance\VCS:20052:ConnectionBroker:%s:%s:<%s> Call to get process list did not return any processesRVCS:20058:ConnectionBroker:%s:%s:<%s> Could not create PID file [%s] successfullyRVCS:20063:ConnectionBroker:%s:%s:<%s> Attribute validation failed. Returning [%s]bVCS:20066:ConnectionBroker:%s:%s:<%s> ConnectionBroker instance NOT online after SLM. Status [%s]VCS:20068:ConnectionBroker:%s:%s:<%s> ConnectionBroker instance NOT online after executing external monitor [%s] with args [%s]. Status [%s]cVCS:20070:ConnectionBroker:%s:%s:<%s> The following mandatory fields were not set [%s], Total [%s]GVCS:20071:ConnectionBroker:%s:%s:<%s> EnvFile [%s] file does not existAVCS:20072:ConnectionBroker:%s:%s:<%s> DMHome [%s] does not existaVCS:20075:ConnectionBroker:%s:%s:<%s> Server NOT listening on Host [%s] Port [%s]: Socket methodkVCS:20076:ConnectionBroker:%s:%s:<%s> Insufficient time to continue in-depth monitoring. Short by [%s] secKVCS:20079:ConnectionBroker:%s:%s:<%s> External monitor [%s] does not existLVCS:20080:ConnectionBroker:%s:%s:<%s> External monitor [%s] not executable.BVCS:20081:ConnectionBroker:%s:%s:<%s> EnvFile [%s] does not existqVCS:20082:ConnectionBroker:%s:%s:<%s> Insufficient time to proceed with external monitor [%s]. Short by [%s] secxVCS:20085:ConnectionBroker:%s:%s:<%s> Command [%s] with args [%s] execution failed with exit code [%s]. Cmd output [%s]NVCS:20087:ConnectionBroker:%s:%s:<%s> PID [%s] is not a valid positive numberVVCS:20089:ConnectionBroker:%s:%s:<%s> Failed to close PidFile [%s] after update: [%s]SVCS:20090:ConnectionBroker:%s:%s:<%s> Failed to create PID file [%s] with PID [%s]oVCS:20094:ConnectionBroker:%s:%s:<%s> Failed to delete PID files in directory [%s]. Remove the files manually.LVCS:20097:ConnectionBroker:%s:%s:<%s> Called with empty [%s] process stringEVCS:20099:ConnectionBroker:%s:%s:<%s> PID file [%s] is of zero bytesTVCS:20100:ConnectionBroker:%s:%s:<%s> Could not close PID file [%s] after read [%s]RVCS:20101:ConnectionBroker:%s:%s:<%s> Failed to open PID file [%s] for read: [%s]QVCS:20109:ConnectionBroker:%s:%s:<%s> PIDs not killed [%s] Total not killed [%s]JVCS:20110:ConnectionBroker:%s:%s:<%s> Killed PIDs [%s] Total killed: [%s]EVCS:20113:ConnectionBroker:%s:%s:<%s> Command [%s] is not executableLVCS:20114:ConnectionBroker:%s:%s:<%s> Failed to decrypt crypted string [%s]>VCS:20115:ConnectionBroker:%s:%s:<%s> Cmd [%s] does not existAVCS:20116:ConnectionBroker:%s:%s:<%s> Cmd [%s] is not executableaVCS:20117:ConnectionBroker:%s:%s:<%s> Insufficient time [%s] to execute Cmd [%s] with Args [%s].gVCS:20121:ConnectionBroker:%s:%s:<%s> Command [%s] with args [%s] did not complete within [%s] seconds[VCS:20122:ConnectionBroker:%s:%s:<%s> Failed in call to RunWithEnvCmdWithOutputWithTimeOut:VCS:20124:ConnectionBroker:%s:%s:<%s> PID [%s] is invalidLVCS:20126:ConnectionBroker:%s:%s:<%s> ps(1b) command [%s] is not executableYVCS:20127:ConnectionBroker:%s:%s:<%s> Cmd [%s] with args [%s] failed with exit code [%s]GVCS:20130:ConnectionBroker:%s:%s:<%s> Failed to create PID folder [%s]aVCS:20141:ConnectionBroker:%s:%s:Agent called with unsupported entry point specification of [%s]MVCS:20146:ConnectionBroker:%s:%s:<%s> Resource [%s] started up successfully.@VCS:20147:ConnectionBroker:%s:%s:<%s> Failed to online resourceQVCS:20148:ConnectionBroker:%s:%s:<%s> Processes for resource instance already up[VCS:20149:ConnectionBroker:%s:%s:<%s> Attempt to online resource instance in invalid stateTVCS:20151:ConnectionBroker:%s:%s:<%s> Processes for resource instance down already.KVCS:20152:ConnectionBroker:%s:%s:<%s> Shutdown resource [%s] successfully.AVCS:20153:ConnectionBroker:%s:%s:<%s> Failed to offline resource?VCS:20155:ConnectionBroker:%s:%s:<%s> Failed to clean resource r k#'K'K'K #./opt/VRTSvcs/messages/en/VRTSvcsAIXContentServer.bmcmcSTGK'enHADN"N@|N"NN|NUNZ0NmNHNNNNhP0}CQ55 R  l ,  6 ! -t,y.M^L(j4r aRU`VCS:20002:ContentServer:%s:%s:<%s> The following mandatory fields were not set [%s], Total [%s]DVCS:20003:ContentServer:%s:%s:<%s> EnvFile [%s] file does not existHVCS:20004:ContentServer:%s:%s:<%s> DMBase [%s] directory does not existIVCS:20005:ContentServer:%s:%s:<%s> DMUser [%s] is not a valid UNIX loginCVCS:20006:ContentServer:%s:%s:<%s> DocbaseName [%s] is not a validIVCS:20007:ContentServer:%s:%s:<%s> MonitorProgram [%s] is not executableaVCS:20008:ContentServer:%s:%s:<%s> Some of the attributes could not be validated. Returning [%s]]VCS:20012:ContentServer:%s:%s:<%s> Could not remove all processes for this instance. ExitingTVCS:20014:ContentServer:%s:%s:<%s> Could not remove all IPC resources for User [%s]\VCS:20016:ContentServer:%s:%s:<%s> Insufficient time to continue boot up. Short by [%s] secRVCS:20019:ContentServer:%s:%s:<%s> Confirmed start-up of Content server after FLMRVCS:20022:ContentServer:%s:%s:<%s> Confirmed start-up of Content server after SLMVCS:20025:ContentServer:%s:%s:<%s> Could not confirm start-up after executing external monitor [%s] with args [%s]. Sleeping for [%s] sec]VCS:20028:ContentServer:%s:%s:<%s> Insufficient time to continue shutdown. Short by [%s] secGVCS:20030:ContentServer:%s:%s:<%s> Delaying exit to confirm shutdown..PVCS:20032:ContentServer:%s:%s:<%s> Confirmed shutdown of ContentServer instance]VCS:20035:ContentServer:%s:%s:<%s> Could not remove all processes for this instance. ExitingTVCS:20037:ContentServer:%s:%s:<%s> Could not remove all IPC resources for User [%s]`VCS:20039:ContentServer:%s:%s:<%s> Attempting to stop ContentServer with Command [%s] Args [%s]]VCS:20040:ContentServer:%s:%s:<%s> Insufficient time to continue shutdown. Short by [%s] sec]VCS:20044:ContentServer:%s:%s:<%s> Could not remove all processes for this instance. ExitingTVCS:20046:ContentServer:%s:%s:<%s> Could not remove all IPC resources for User [%s]_VCS:20053:ContentServer:%s:%s:<%s> Failed to get details for monitoring ContentServer instanceYVCS:20058:ContentServer:%s:%s:<%s> Call to get process list did not return any processesOVCS:20077:ContentServer:%s:%s:<%s> Could not create PID file [%s] successfully`VCS:20078:ContentServer:%s:%s:<%s> agent_exec process for the content server instance is not upOVCS:20083:ContentServer:%s:%s:<%s> Attribute validation failed. Returning [%s]\VCS:20086:ContentServer:%s:%s:<%s> ContentServer instance NOT online after SLM. Status [%s]VCS:20088:ContentServer:%s:%s:<%s> ContentServer instance NOT online after executing external monitor [%s] with args [%s]. Status [%s]`VCS:20090:ContentServer:%s:%s:<%s> The following mandatory fields were not set [%s], Total [%s]DVCS:20091:ContentServer:%s:%s:<%s> EnvFile [%s] file does not exist\VCS:20092:ContentServer:%s:%s:<%s> JavaHome [%s] does not contain java binary in bin folderCVCS:20093:ContentServer:%s:%s:<%s> DocbaseName [%s] is not a validhVCS:20095:ContentServer:%s:%s:<%s> Insufficient time to continue in-depth monitoring. Short by [%s] secHVCS:20098:ContentServer:%s:%s:<%s> External monitor [%s] does not existIVCS:20099:ContentServer:%s:%s:<%s> External monitor [%s] not executable.?VCS:20100:ContentServer:%s:%s:<%s> EnvFile [%s] does not existnVCS:20101:ContentServer:%s:%s:<%s> Insufficient time to proceed with external monitor [%s]. Short by [%s] secuVCS:20104:ContentServer:%s:%s:<%s> Command [%s] with args [%s] execution failed with exit code [%s]. Cmd output [%s]KVCS:20106:ContentServer:%s:%s:<%s> PID [%s] is not a valid positive numberSVCS:20108:ContentServer:%s:%s:<%s> Failed to close PidFile [%s] after update: [%s]PVCS:20109:ContentServer:%s:%s:<%s> Failed to create PID file [%s] with PID [%s]lVCS:20113:ContentServer:%s:%s:<%s> Failed to delete PID files in directory [%s]. Remove the files manually.IVCS:20116:ContentServer:%s:%s:<%s> Called with empty [%s] process stringBVCS:20118:ContentServer:%s:%s:<%s> PID file [%s] is of zero bytesQVCS:20119:ContentServer:%s:%s:<%s> Could not close PID file [%s] after read [%s]OVCS:20120:ContentServer:%s:%s:<%s> Failed to open PID file [%s] for read: [%s]NVCS:20128:ContentServer:%s:%s:<%s> PIDs not killed [%s] Total not killed [%s]GVCS:20129:ContentServer:%s:%s:<%s> Killed PIDs [%s] Total killed: [%s];VCS:20132:ContentServer:%s:%s:<%s> Cmd [%s] does not exist>VCS:20133:ContentServer:%s:%s:<%s> Cmd [%s] is not executable^VCS:20134:ContentServer:%s:%s:<%s> Insufficient time [%s] to execute Cmd [%s] with Args [%s].dVCS:20138:ContentServer:%s:%s:<%s> Command [%s] with args [%s] did not complete within [%s] secondsXVCS:20139:ContentServer:%s:%s:<%s> Failed in call to RunWithEnvCmdWithOutputWithTimeOut7VCS:20141:ContentServer:%s:%s:<%s> PID [%s] is invalidIVCS:20143:ContentServer:%s:%s:<%s> ps(1b) command [%s] is not executableVVCS:20144:ContentServer:%s:%s:<%s> Cmd [%s] with args [%s] failed with exit code [%s]DVCS:20147:ContentServer:%s:%s:<%s> Failed to create PID folder [%s]KVCS:20153:ContentServer:%s:%s:<%s> Command [%s] failed with exit code [%s]TVCS:20155:ContentServer:%s:%s:<%s> Could not remove all IPC resources for User [%s]^VCS:20166:ContentServer:%s:%s:Agent called with unsupported entry point specification of [%s]JVCS:20171:ContentServer:%s:%s:<%s> Resource [%s] started up successfully.=VCS:20172:ContentServer:%s:%s:<%s> Failed to online resourceNVCS:20173:ContentServer:%s:%s:<%s> Processes for resource instance already upXVCS:20174:ContentServer:%s:%s:<%s> Attempt to online resource instance in invalid stateQVCS:20176:ContentServer:%s:%s:<%s> Processes for resource instance down already.HVCS:20177:ContentServer:%s:%s:<%s> Shutdown resource [%s] successfully.>VCS:20178:ContentServer:%s:%s:<%s> Failed to offline resource Failed to clean resourceontenk  $sMyName, $sPIDDir ); return 0; # Cannot proceed.. } %$rhlSrvrDetails = (); # Truncate.. #----------------------------------------------- # Set appropriate filter strings and PID files.. #----------------------------------------------- $sKey = 'srchstr_' . ++ $iPat; $sPidFile = "$sPIDDir/pidfile.$sKey"."_master"; @{ $$rhlSrvrDetails { $sKey } } = ( $sPidFile, $lsSrchPatterns[0] ); # Store.. foreach $sProc ( @lsSrchPatterns ) { $sKey = 'srchstr_' . ++ $iPat; $sPidFile = "$sPIDDir/pidfile.$sKey"; @{ $$rhlSrvrDetails { $sKey } } = ( $sPidFile, $sProc ); # Store.. } return $iReturnCode; } =pod -------------------------------------------------------------------------- Function : Boolean RemoveIPCResourcesForUser ( IN String User, IN Integer IpcFlags, Description : Removes IPC resources for specified UNIX user, Creator PIDs IPC IDs, if given. Parameters : $sUser : UNIX user whose IPC resources are to be removed $iIpcFlags : Behaviour flag Values for Behaviour flag: O_IPCSHM : Shared Memory O_IPCSEM : Semaphore O_IPCALL : All of the above Return Value: boolean value in the set of {0,1} where 0 false 1 true -------------------------------------------------------------------------- =cut sub RemoveIPCResourcesForUser { #---------------- # Get Arguments.. #---------------- my ( $sUser, $iIpcFlags ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20148, "Subroutine <%s> called with: User [%s] IPC Flags [%s]", $sMyName, $sUser, $iIpcFlags ); #------------------------- # Define local variables.. #------------------------- my $sIpcCommand = "/usr/bin/ipcs -mp"; my ( $sResourceType, $sResourceName, $sPidFile, $iPid, $iCPid, $iPosition, $iID, $sLine, $iExitCode, @lsData, @liMemIds, $rliIds ) = (); #------------------------------------- # Set return code to hopeful success.. #------------------------------------- my $iReturnCode = 1; #---------------------------------------------- # Derive our resource type and resource names.. #---------------------------------------------- $sResourceType = ( $0 =~ m@([^/]+)@g ) [-2]; $sResourceName = $ENV { VCS_LOG_RESOURCE_NAME }; $sPidFile = "/tmp/.VRTS$sResourceType/$sResourceName/PID/pidfile.srchstr_1_master"; #------------------------------ # Get the Pid if PidFile exist #------------------------------ if ( -e $sPidFile ) { &logTrace ( 20149, "<%s> PID file [%s] exists", $sMyName, $sPidFile ); if ( open ( PIDFILE, $sPidFile ) ) { ( $iPid ) = grep { ( s/\n// || 1 ) && # Chomp.. s/.*?(\d+)$/$1/ # Get PID.. } ; $iPid = '' unless defined $iPid; # Avoid undefs.. close ( PIDFILE ) || # Close file.. &logTrace ( 20150, "<%s> Could not close PID file [%s] after read [%s]", $sMyName, $sPidFile, $! ); } else { &logTrace ( 20151, "<%s> Failed to open PID file [%s] for read: [%s]", $sMyName, $sPidFile, $! ); $iPid = ''; } } else { $iPid = ''; &logTrace ( 20152, "<%s> PID file [%s] does not exists", $sMyName, $sPidFile ); } if ( $iPid =~ /\d+/ ) { #------------------------------------------------------------------- # Get the Shared Memory IDs created by the process with PID obtained #------------------------------------------------------------------- $iPosition = $^O eq 'linux' ? 0 : 1; @lsData = readpipe ( $sIpcCommand ); if ( $iExitCode = $? >> 8 ) { &logWarn ( 20153, "<%s> Command [%s] failed with exit code [%s]", $sMyName, $sIpcCommand, $iExitCode ); return 0; } foreach $sLine ( @lsData ) { chomp ( $sLine ); next unless ( $sLine =~ /\d+\s+\d+\s*$/ ); ( $iID, $iCPid ) = ( $sLine =~ /[^\s]+/g ) [ $iPosition, -2 ]; push @liMemIds, $iID if ( $iCPid == $iPid ); } if ( scalar @liMemIds ) { $rliIds = \@liMemIds; if ( Proc::RemoveIPCResourcesForUser ( $sUser, O_IPCSHM, $rliIds ) ) { &logTrace ( 20154, "<%s> IPC resources for User [ %s ] with CPID [ %s ] removed successfully", $sMyName, $sUser, $iPid ); } else { &logError ( 20155, "<%s> Could not remove all IPC resources for User [%s]", $sMyName, $sUser ); $iReturnCode = 0; # Failure.. } } } return $iReturnCode; } =pod ------------------------------------------------------------------------------------------------ Function : int GetEngineTimeout ( IN Bool UseMargin ); Description : Calculates engine timeout for entry point Parameters : $bUseMargin Flag to indicate if safety margin is requested boolean value in the set of {0,1} where 0 No safety margin needed 1 Safety margin to be used Returns: Time in secs. ------------------------------------------------------------------------------------------------ =cut sub GetEngineTimeout { #---------------- # Get Arguments.. #---------------- my ( $bUseMargin ) = @_; #----------------- # Announce Entry.. #----------------- my $sMyName = ( caller 0 )[3]; &logTrace ( 20156, "Subroutine <%s> called with: UseMargin [%s]", $sMyName, $bUseMargin ); #------------------------- # Define local variables.. #------------------------- my ( $sAttribute, $sCommand, $sCommandArgs, $iEngineTimeout, $iExitCode ) = (); #---------------------------------- # Grace margins from VCS timeouts.. #---------------------------------- my %hiGraceMargin = ( 'MonitorTimeout', 10, # Seconds.. 'OnlineTimeout', 10, 'OfflineTimeout', 10, 'CleanTimeout', 20 ); #-------------------------------------------------- # Attempt to get resource level overridden values.. #-------------------------------------------------- my $sResourceName = $ENV { VCS_LOG_RESOURCE_NAME }; my ( $sEntryPointName, $sResourceType ) = reverse $0 =~ m@([^/]+)@g; ( $sAttribute = $sEntryPointName ) =~ s/(.*)/\u$1Timeout/; #----------------------------------- # Query if it has already been set.. #----------------------------------- if ( defined $::giEPTimeout && # Defined.. $::giEPTimeout =~ /^\d+/ ) { # to an integer.. $iEngineTimeout = $::giEPTimeout; &logTrace ( 20157, "<%s> Using AEPTimeout [%s] as EP timeout value", $sMyName, $iEngineTimeout ); } else { #----------------------------------------- # Form query string based on entry point.. #----------------------------------------- $sCommand = $sCmdHares; # Get global.. $sCommandArgs = "-value $sResourceName $sAttribute"; #---------------------------------- # Fire command and collect output.. #---------------------------------- ( $iEngineTimeout = readpipe ( "$sCommand $sCommandArgs 2>/dev/null" ) ) =~ s/\n//; #-------------------- # Check exit status.. #-------------------- if ( $iExitCode = $? >> 8 ) { &logTrace ( 20158, "<%s> Command [%s] with Args [%s] failed with exitcode [%s]", $sMyName, $sCommand, $sCommandArgs, $iExitCode ); } elsif ( ! $iEngineTimeout ) { # Undefined value.. &logTrace ( 20159, "<%s> Could not get [%s] from engine", $sMyName, $sAttribute ); } else { # Success.. &logTrace ( 20160, "<%s> Got [%s] as [%s] sec from engine", $sMyName, $sAttribute, $iEngineTimeout ); } #----------------------------------------- # Form query string based on entry point.. #----------------------------------------- unless ( $iEngineTimeout ) { $sCommand = $sCmdHatype; # Get global.. ( $sAttribute = $sEntryPointName ) =~ s/(.*)/\u$1Timeout/; $sResourceType = "ContentServer" if $sResourceType !~ /\w/; # Ensure.. $sCommandArgs = "-value $sResourceType $sAttribute"; #---------------------------------- # Fire command and collect output.. #---------------------------------- ( $iEngineTimeout = readpipe ( "$sCommand $sCommandArgs" ) ) =~ s/\n//; #-------------------- # Check exit status.. #-------------------- if ( $iExitCode = $? >> 8 ) { &logTrace ( 20161, "<%s> Command [%s] with Args [%s] failed with exitcode [%s]", $sMyName, $sCommand, $sCommandArgs, $iExitCode ); $iEngineTimeout = $bUseMargin ? $hiGraceMargin { $sAttribute } : 0; } elsif ( ! $iEngineTimeout ) { # Empty value.. &logTrace ( 20162, "<%s> Could not get [%s] from engine", $sMyName, $sAttribute ); $iEngineTimeout = $bUseMargin ? $hiGraceMargin { $sAttribute } : 0; } else { # Success.. &logTrace ( 20163, "<%s> Got [%s] as [%s] sec from engine", $sMyName, $sAttribute, $iEngineTimeout ); } } } #---------------------------- # Apply margin if requested.. #---------------------------- if ( $bUseMargin && # Margin requested.. $iEngineTimeout >= $hiGraceMargin { $sAttribute } ) { # And valid.. $iEngineTimeout -= $hiGraceMargin { $sAttribute }; # Apply.. &logTrace ( 20164, "<%s> Setting up [%s] sec margin. Returning [%s]", $sMyName, $hiGraceMargin { $sAttribute }, $iEngineTimeout ); } return ( $iEngineTimeout ); # Secs.. } 1; # So PERL knows its included.. gineTi k9&'K'K'K &./opt/VRTSvcs/bin/ContentServer/ContentServer.xmlr.xmlST