#!/bin/bash
# BEGIN_ICS_COPYRIGHT8 ****************************************
#
# Copyright (c) 2015-2020, Intel Corporation
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
#     * Redistributions of source code must retain the above copyright notice,
#       this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above copyright
#       notice, this list of conditions and the following disclaimer in the
#       documentation and/or other materials provided with the distribution.
#     * Neither the name of Intel Corporation nor the names of its contributors
#       may be used to endorse or promote products derived from this software
#       without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# END_ICS_COPYRIGHT8   ****************************************

# [ICS VERSION STRING: unknown]

# Run opareport -o errors with topology XML, then:
#   Extract values (including port statistics) for both ports of each link
#   Remove redundant information for each link and combine link port information

## Local functions:

# Usage()
#
# Description:
#   Output information about program usage and parameters
#
# Inputs:
#   none
#
# Outputs:
#   Information about program usage and parameters



usage()
{
    echo "Usage:  ${cmd} topology_file [opareport options]" >&2
    echo "       or  ${cmd} --help" >&2
    echo "   --help - produce full help text" >&2
    echo "   [opareport options] - options will be passed to opareport." >&2
    echo >&2
    exit 2
}

Usage_full()
{
    echo "Usage: ${cmd} topology_file [opareport options]" >&2
    echo "       or  ${cmd} --help" >&2
    echo "   --help - produce full help text" >&2
    echo "   [opareport options] - options will be passed to opareport." >&2
    echo >&2
    echo "${cmd} is a front end to the opareport and opaxmlextract tools that" >&2
    echo "performs an error analysis of a fabric and provides augmented information" >&2
    echo "from a topology file including all error counters." >&2
    echo "The output is in a CSV format suitable for importing into a spreadsheet or" >&2
    echo "parsed by other scripts." >&2
    echo >&2
    echo "for example" >&2
    echo "	${cmd} topology_file" >&2
    echo >&2
    echo "	${cmd} topology_file -c my_opamon.conf" >&2
    echo >&2
    echo "See the man page for \"opareport\" for the full set of options." >&2
    echo "By design, the tool ignores \"-o/--output\" report option." >&2
    echo >&2
	exit 0

}

## Main function:

cmd=`basename $0`
if [ x"$1" = "x--help" ]
then
	Usage_full
fi

if [[ $# -lt 1 || "$1" == -* ]]
then
    usage
fi


# NOTE: opareport -o errors generates XML output of this general form:
#  <Link>
#     <Rate>....
#     <LinkDetails>....
#     <Cable>
#       ... cable information from topology.xml
#     </Cable>
#     <Port>
#       .. information about 1st port excluding its CableInfo
#     </Port>
#     <Port>
#       .. information about 2nd port excluding its CableInfo
#     </Port>
#     <CableInfo>
#       .. information about the CableInfo for the cable between the two ports
#     </CableInfo>
#  </Link>
  # opaxmlextract produces the following CSV format on each line:
  #    1 Link ID (CSV 1) LinkID
  #    3 Link values (CSV 2-4) (Rate, Internal, LinkDetails)
  #    3 Cable values (CSV 5-7) (CableLength, CableLabel, CableDetails)
  #    Port values (CSV 8-) (port details and error stats)
  # due to the nesting of tags, opaxmlextract will output the following
  #    All lines have LinkID and Rate and one set of Cable values or Port Values

# Combine 2 ports for each link onto 1 line, removing redundant Link and Cable values
EMPTY_PORT_STR=";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"
link1=0
link2=0
printHeader=1
curLinkID=""
prevLinkID=""
RateDetailsStr=";;"
CableValuesStr=";;"
Port1ValuesStr=$EMPTY_PORT_STR
Port2ValuesStr=$EMPTY_PORT_STR
while read line
do
  curLinkID=`echo $line | cut -d \; -f 1`

  # When Link_ID changes, print previous link and start new one
  if [ "$curLinkID" != "$prevLinkID" ]
  then
    # Display header first time
    if [ $printHeader -eq 1 ]
    then
      echo `echo $line | cut -d \; -f 2-`";"`echo $line | cut -d \; -f 8-`
      printHeader=0
      continue
    fi

    # Display the previous link before starting this new one
    if [ "$prevLinkID" != "" ]
    then
      echo $RateDetailsStr";"$CableValuesStr";"$Port1ValuesStr";"$Port2ValuesStr
    fi

    # Reset for the next set of data
    link1=0
    link2=0
    RateDetailsStr=";;"
    CableValuesStr=";;"
    Port1ValuesStr=$EMPTY_PORT_STR
    Port2ValuesStr=$EMPTY_PORT_STR
    prevLinkID=$curLinkID
  fi

  if [ "$RateDetailsStr" == ";;" ]
  then
    RateDetailsStr=`echo $line | cut -d \; -f 2-4`
  fi

  if [ "$CableValuesStr" == ";;" ]
  then
    CableValuesStr=`echo $line | cut -d \; -f 5-7`
  fi

  if [ $link1 -eq 0 ]
  then
    if [ "$Port1ValuesStr" == "$EMPTY_PORT_STR" ]
    then
      Port1ValuesStr=`echo $line | cut -d \; -f 8-`
    fi
    if [ "$Port1ValuesStr" != "$EMPTY_PORT_STR" ]
    then
      link1=1
    fi
  elif [ $link2 -eq 0 ]
  then
    if [ "$Port2ValuesStr" == "$EMPTY_PORT_STR" ]
    then
      Port2ValuesStr=`echo $line | cut -d \; -f 8-`
    fi
    if [ "$Port2ValuesStr" != "$EMPTY_PORT_STR" ]
    then
      link2=1
    fi
  fi

done < <(/usr/sbin/opareport -x -Q -d 10 -s -o errors -T "$@" | \
        /usr/sbin/opaxmlextract -d \; -e Link:id -e Rate -e Internal -e LinkDetails \
        -e CableLength -e CableLabel -e CableDetails -e Port.NodeGUID \
        -e Port.PortGUID -e Port.PortNum -e Port.NodeType -e Port.NodeDesc \
        -e Port.PortDetails \
        -e XmitDataValue -e XmitPktsValue -e PortMulticastXmitPktsValue \
        -e RcvDataValue -e RcvPktsValue -e MulticastRcvPktsValue \
        -e XmitWaitValue -e CongDiscardsValue -e XmitTimeCongValue \
        -e MarkFECNValue -e RcvFECNValue -e RcvBECNValue \
        -e RcvBubbleValue -e XmitWastedBWValue -e XmitWaitDataValue \
        -e LinkQualityIndicatorValue -e LocalLinkIntegrityErrorsValue \
        -e RcvErrorsValue -e ExcessiveBufferOverrunsValue \
        -e LinkErrorRecoveryValue -e LinkDownedValue -e UncorrectableErrorsValue \
        -e FMConfigErrorsValue -e XmitConstraintErrorsValue \
        -e RcvConstraintErrorsValue -e RcvSwitchRelayErrorsValue \
        -e XmitDiscardsValue -e RcvRemotePhysicalErrorsValue)

# print the last link record
if [ "$prevLinkID" != "" ]
then
  echo $RateDetailsStr";"$CableValuesStr";"$Port1ValuesStr";"$Port2ValuesStr
fi

exit 0

