- Problem Statement: 

Enabling debug messages in SMS for troubleshooting 

- Symptoms:

        If you are having problems with troubleshooting and need more verbose
        information for a particular daemon, you may need to enable the debug
        mode for that daemon.

        You can also debug the SMS command for more verbose messages.

        See file $SMSLOGGER/platform/messages for the output from the debug option.
            

- Troubleshooting:

        There are four ways you can enable debug mode on any of the SMS daemons or command.

        Note: Logging output can be very, very verbose. Usage of debug messages should
only be used
        as part of a targeted troubleshooting procedure.
        
        1.  If the daemon is already running, send the process a signal to toggle on/off debug 
        messaging. For most of the SMS daemons, a USR2 signal will toggle between enabling and	
        disabling of debug mode. (See table below for proper signals)

        Example: Enable debug mode on the "hwad" daemon

	Type "pkill -USR2 hwad".
        
        Note: Issuing a second kill command (pkill -USR2 hwad) will disable debug mode. You may
        need to become root to use the pkill command.  This is the preferred method for debugging
        as you can disable the debug option within a short time.

        Here is the table for all SMS daemons and debug options:
	
 	  Daemon   		Enable Debug   	Disable Debug
	  ------   		------------   	-------------
	  osd      		USR1           	USR2
	  dxs     		USR1           	USR2
	  ssd     		 -	       	-	*** see Warning
	  All other daemons     USR2           	USR2
	 
	 
	WARNING: USR2 signal to ssd will shut down itself and all software components 
	under its control. It is same as restarting SMS. Do not use USR2 signal on ssd daemon.	
	There is no user signal to debug the ssd daemon.

        2.  You can enable debug mode on a SMS command by adding "-L debug" on command line.
	
        Example :

	showboards -L debug
	
	Note : This will create verbose messages only while command is in process.

         
        3.  You can enable debug mode at the startup of the daemon by passing the
        '-L debug' flag at start time. To accomplish this, edit the $SMSETC/startup/ssd_start
        file.  
        
        Example: Enable debug mode on the "pcd" daemon
        
	Change the $SMSETC/startup/ssd_start file from:
         
	pcd::0:1:0:1:4:4:sms-pcd:1:1
        
	to:
        
	pcd:-L debug:0:1:0:1:4:4:sms-pcd:1:1
        
        Note: $SMSETC/startup/ssd_start should only be edited when debugging a 
        startup issue.  This option may fill up the platform messages files.
        
        
        4.  Edit $SMSVAR/adm/.logger to debug all daemons.

        Change 'level' value to debug.  See example below.  All SMS daemons will log 
        debug level information.
       
        #
        # SMS message log configuration file
        #
        file:msgdaemon
        level:debug
        mode:verbose

        Restart the ssd daemon using the command "pkill -USR2 ssd".

        NOTE:  This option will create a huge amount of data in the log
        and is therefore not a preferred choice.

- Resolution:

        The file $SMSLOGGER/platform/messages will have entries similar to the examples 
        shown below:

        Example of pkill -USER2 hwad:
	
	Jul 31 08:06:25 2002 mufasa-sc0 hwad[19436]: [0 65852891484932 DEBUG PciComm.cc 461] 
	PciComm :: setByte offset : 0
	Jul 31 08:06:25 2002 mufasa-sc0 hwad[19436]: [0 65852892535208 DEBUG PciComm.cc 462] 
	PciComm :: setByte data : 3b
	Jul 31 08:06:25 2002 mufasa-sc0 hwad[19436]: [0 65852894010875 DEBUG PciComm.cc 465] 
	PciComm :: setByte stat : 0
	Jul 31 08:06:25 2002 mufasa-sc0 hwad[19436]: [0 65852895065351 DEBUG PciComm.cc 630]
	PciComm :: setInt offset : c0
	Jul 31 08:06:25 2002 mufasa-sc0 hwad[19436]: [0 65852895808664 DEBUG PciComm.cc 631]
	PciComm :: setInt data : 304ac000
	
        Example of showboards -L debug output:
	
	Sep  9 08:59:43 2002 xc46-sc0 showboards[16998]: [0 330612526071543 DEBUG 
	LockManager.cc 611] LM.getClientMode:Client found in list
	Sep  9 08:59:43 2002 xc46-sc0 showboards[16998]: [0 330612526862057 DEBUG 
	AutoLock.cc 153] newMode != oldMode, lets change mode
	Sep  9 08:59:43 2002 xc46-sc0 showboards[16998]: [0 330612527599677 DEBUG 
	LockManager.cc 681] LM.setClientMode:Client found in list
	Sep  9 08:59:43 2002 xc46-sc0 showboards[16998]: [0 330612528457617 DEBUG 
	LockManager.cc 647] LM.getClientTimeout:Client found in list
	Sep  9 08:59:43 2002 xc46-sc0 showboards[16998]: [0 330612529248608 DEBUG 
	AutoLock.cc 175] set timeout = -1
	Sep  9 08:59:43 2002 xc46-sc0 showboards[16998]: [0 330612529982124 DEBUG 
	LockManager.cc 710] LM.setClientTimeout:Client found in list
	Sep  9 08:59:43 2002 xc46-sc0 showboards[16998]: [0 330612530884016 DEBUG 
	ShowBoard.cc 855] getHPCIPresenceAndPower status= 0

        Example of messages after second pkill command to disable debug option for hwad:

	Jul 31 08:13:09 2002 mufasa-sc0 hwad[19436]: [50024 66257408592832 INFO 
	Application.cc 104] signal caught: handler=Application::signalHandler, sig=17
	Jul 31 08:13:09 2002 mufasa-sc0 hwad[19436]: [0 66257409821761 DEBUG 
	Application.cc 1031] In Application :: handleSIGUSR2().       
                          

- Summary of part number and patch ID's 

        None
        
- References and bug IDs

        None
        
- Additional background information:

        No

- Meta-Data/Problem categorization:

Product/Platform: SF12K/SF15K   
Category:

- Keywords

Debug SMS daemon starcat 15K 12K SF15K SF12K