# TMssd.ctl: Analyzes System State Dumps
# $Id: TMssd.ctl,v 1.7 2014/05/12 16:33:50 RDA Exp $
# ARCS: $Header: /home/cvs/cvs/RDA_8/src/scripting/lib/collect/DB/TMssd.ctl,v 1.7 2014/05/12 16:33:50 RDA Exp $
#
# Change History
# 20140512  JJU  Extend the tool to collected files.

=head1 NAME

DB:TMssd - Analyzes System State Dumps

=head1 DESCRIPTION

This test module analyzes all system state dumps contained in a specified trace
file and provides a summary as a report. The trace file can be specified in two
ways:

=over 3

=item a)

Runs interactively. It requests the user to input the absolute path of the
trace file.

 <rda> -vT ssd

 <sdci> -v run ssd

=item b)

Runs from the command line. The input can be given in the command line using
the following syntax:

 <rda> -vT ssd:absolute_path_of_trace_file

 <sdci> -v run ssd absolute_path_of_trace_file

=back

=cut

options 'p:z:'

section tool
call unshift(@{CUR.W_NEXT},'test')

section test

echo tput('bold'),'Analyzing system state dumps ...',tput('off')

# Initialization
var $TOC = '%TOC%'
var $TOP = '[[#Top][Back to top]]'

# Load the common macros
run DB:DBssd()

# When requested, set a virtual context
if isArchived($opt{'z'})
 call selectIndex(last,$opt{'p'})

# Set the abbreviation
call setAbbr('DB_SSD_')

# Obtain the input trace file
if $arg[0]
 var $fil = last
else
{call requestInput('TMssd')
 var $fil = ${RUN.REQUEST.F_DUMP}
}

# Treat the file
if !length($fil)
 echo 'Missing input file'
elsif !?testVirtualFile('r',$fil)
 echo 'The input file does not exist or is not readable'
else
{report system_state
 call analyze_ssd($fil)
 if isCreated()
 {call getGroupFile('D_CWD',renderFile())
  echo 'Result file: ',last
 }
 else
  echo 'The input file does not contain a valid system state dump'
}

=head1 SEE ALSO

L<DB:DBssd|collect::DB:DBssd>

=begin credits

=over 10

=item RDA 4.6:  Kevin Quinn.

=back

=end credits

=head1 COPYRIGHT NOTICE

Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.

=head1 TRADEMARK NOTICE

Oracle and Java are registered trademarks of Oracle and/or its
affiliates. Other names may be trademarks of their respective owners.

=cut