#

# Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

# All rights reserved.

# This component and the accompanying materials are made available

# under the terms of the License "Eclipse Public License v1.0"

# which accompanies this distribution, and is available

# at the URL "http://www.eclipse.org/legal/epl-v10.html".

#

# Initial Contributors:

# Nokia Corporation - initial contribution.

#

# Contributors:

#

# Description:

#

#!/usr/bin/perl

use File::Find;

use File::Spec::Functions;

	my $TraceFileName;

	my $PrintFlagFilePos = 0;

	my $PrintFlagHdrLen = 0;

	my $PrintFlagHdrFlags = 0;

	my $PrintFlagFormatString = 0;

	my $VerboseMode = 0;

	my $RawMode = 0;

	my $FormatIdIsSubCategory = 0;

	my $OutputSawDictionaryMode = 0;

	# for the category range 0-191, the format string is indexed by the category & subcategory

	%FormatTables = 

		(

		0 => 			# ERDebugPrintf

			{

			0 => "ThreadId %h, %s",

			},

		1 => 			# ERKernPrintf

			{

			0 => "ThreadId %h, %s",

			},

		3 =>			# EThreadIdentification

			{	

			0 => "ENanoThreadCreate, NThread %x",

			1 => "ENanoThreadDestroy, NThread %x",

			2 => "EThreadCreate, NThread %x, DProcess %x, name %s",

			3 => "EThreadDestroy, NThread %x, DProcess %x, Id %x",

			4 => "EThreadName, NThread %x, DProcess %x, name %s",

			5 => "EProcessName, NThread %x, DProcess %x, name %s",

			6 => "EThreadId, NThread %x, DProcess %x, Id %x",

			7 => "EProcessCreate, DProcess %x",

			8 => "EProcessDestroy, DProcess %x",

			},

		);

	my @typedefs;

	my @members;

	my %values	= (

#		UTF::KInitialClientFormat		=>	{type=>"TFormatId", size=>2, value=>512}

		KMaxTUint8						=> {type=>"TUint8", size=>1, value=>255},

		KMaxTUint16						=> {type=>"TUint16", size=>2, value=>65535}

	);

	my %macros;

	my @classes;

	my @enums;

	my %formatStrings;		# each enum may have it's own format string

	my %formatCategories;	# each enum may have it's own format category

	my %filescope;

	$filescope{file}=1;

	undef $filescope{name};	

	$filescope{typedefs}=\@typedefs;

	$filescope{members}=\@members;

	$filescope{values}=\%values;

	$filescope{macros} = \%macros;

	$filescope{FormatTables} = \%FormatTables;

	$filescope{classes} = \@classes;

	$filescope{enums} = \@enums;

	$filescope{formatStrings} =\%formatStrings;

	$filescope{formatCategories} = \%formatCategories;

	if (@ARGV == 0)

  		{

  		print "BTraceVw.pl \n";

  		print "An unsupported utility which extracts UTrace-style format-strings\n";

  		print "from header files & uses these to decode a BTrace output file\n";

  		print "Syntax : BTraceVw.pl [-v] [-r] [-sd] [-i <IncFilePath>] [<BTrace file>]\n";

  		print "where  : -v  = verbose mode\n";

  		print "       : -r  = raw output mode\n";

  		print "       : -sd = produce SAW trace viewer dictionary file\n";

  		print "       :       this file then needs to be merged into the 'com.symbian.analysis.trace.ui.prefs' file\n";

  		print "       :       located under the carbide workspace directory\n";

		print "\n";

		print "e.g. (this decodes a trace file & produces a comma-separated output file) : \n";

		print "btracevw.pl -i /os/kernelhwsrv/userlibandfileserver/fileserver/inc/f32tracedef.h -i /os/kernelhwsrv/userlibandfileserver/fileserver/inc/utraceefsrv.h -i /os/kernelhwsrv/userlibandfileserver/fileserver/inc/utraceefile.h trace.utf >trace.csv\n";

		print "\n";

		print "e.g. (this overwrites the SAW dictioany file) : \n";

		print "btracevw.pl -sd -i /os/kernelhwsrv/userlibandfileserver/fileserver/inc/f32tracedef.h -i /os/kernelhwsrv/userlibandfileserver/fileserver/inc/utraceefsrv.h -i /os/kernelhwsrv/userlibandfileserver/fileserver/inc/utraceefile.h >com.symbian.analysis.trace.ui.prefs\n";

		exit;

		}

	while (@ARGV > 0)

		{

		if ($ARGV[0] eq "-i")

	        {

	        shift @ARGV;

		    ($FilePath) = @ARGV;

	        shift @ARGV;

	        undef @incFiles;

		    @incFiles;

		    find sub { push @incFiles, $File::Find::name if m/\.h$/i;}, $FilePath ;

		    foreach $incFile (@incFiles)

		        {

				H2Trace($incFile, \%filescope);

		        }

	        }

		elsif ($ARGV[0] eq "-r")

	        {

		    $RawMode = 1;

   	        shift @ARGV;

	        }

		elsif ($ARGV[0] eq "-sd")

	        {

		    $OutputSawDictionaryMode = 1;

   	        shift @ARGV;

	        }

		elsif ($ARGV[0] eq "-v")

	        {

		    $VerboseMode = 1;

   	        shift @ARGV;

	        }

	    else

	    	{

			$TraceFileName = "$ARGV[0]";

	        shift @ARGV;

	    	}

        }

	if ($VerboseMode)

		{

		dump_scope(\%filescope);

		PrintFormatTables(\%FormatTables);

		}

	if ($OutputSawDictionaryMode)

		{

		OutputSawDictionary(\%FormatTables);

		}

    if (defined ($TraceFileName))

        {

        ReadTraceFile($RawMode);

        }

sub ReadTraceFile($)

    {

	(my $RawMode) = @_;

#	print "Trace file is $TraceFileName, RawMode $RawMode, VerboseMode $VerboseMode\n\n";

	open (LOGFILE, "<$TraceFileName") or die "Can't open $TraceFileName: $!\n";

	binmode (LOGFILE);

	my $val = 0;

	# enum TFlags from e32btrace.h

	$EHeader2Present	= 1<<0;

	$ETimestampPresent	= 1<<1;

	$ETimestamp2Present	= 1<<2;

	$EContextIdPresent	= 1<<3;

	$EPcPresent			= 1<<4;

	$EExtraPresent		= 1<<5;

	$ERecordTruncated	= 1<<6;

	$EMissingRecord		= 1<<7;

	# enum TFlags2 from e32btrace.h

	$EMultipartFlagMask	= 3<<0;

	$ECpuIdMask			= 0xfff<<20;

	# enum TMultiPart from e32btrace.h

	$EMultipartFirst	= 1;

	$EMultipartMiddle	= 2;

	$EMultipartLast		= 3;

	$EMaxBTraceDataArray = 80;

	# enum TCategory from e32btrace.h

	$EThreadIdentification = 3;

	# enum TThreadIdentification from e32btrace.h

	$EThreadCreate = 2;

	$EThreadName = 4;

	$EProcessName = 5;

	$EThreadId = 6;

	# Context Id bits from e32btrace.h

	$EContextIdMask = 0x00000003;

	$EContextIdThread = 0;

	$EContextIdFIQ = 0x1;

	$EContextIdIRQ = 0x2;

	$EContextIdIDFC = 0x3;

	# enum TClassificationRange from e32btraceu.h

	$EAllRangeFirst = 192;

	$EAllRangeLast = 222;

	%TCategoryIdToString = 

		(

		0 => "ERDebugPrintf",

		1 => "EKernPrintf",

		2 => "EPlatsecPrintf",

		3 => "EThreadIdentification",

		4 => "ECpuUsage",

        5 => "EKernPerfLog",

        6 => "EClientServer",

        7 => "ERequests",

        8 => "EChunks",

        9 => "ECodeSegs",

		10 => "EPaging",

		11 => "EThreadPriority",

		12 => "EPagingMedia",

		13 => "EKernelMemory",

		14 => "EHeap",

		15 => "EMetaTrace",

		16 => "ERamAllocator",

		17 => "EFastMutex",

		18 => "EProfiling", 

        19 => "EResourceManager",

        20 => "EResourceManagerUs",

		21 => "ERawEvent ",

		128 => "EPlatformSpecificFirst",

		191 => "EPlatformSpecificLast",

		192 => "ESymbianExtentionsFirst",

		# UTrace "ALL" range 

		192 => "EPanic",

		193 => "EError",

		194 => "EWarning", 

		195 => "EBorder", 

		196 => "EState", 

		197 => "EInternals", 

		198 => "EDump", 

		199 => "EFlow", 

		200 => "ESystemCharacteristicMetrics", 

		201 => "EAdhoc",

		253 => "ESymbianExtentionsLast",

		254 => "ETest1",

		255 => "ETest2",

		);

	%ProcessNames;

	%ThreadNames;

	%ThreadIds;

	# print column titles

	if ($PrintFlagFilePos) {printf "FilePos, ";}	# col #0

	if ($PrintFlagHdrLen) {	printf "Len, ";}		# col #1

	if ($PrintFlagHdrFlags) {printf "Flags, "; }	# col #2

	printf "Category, ";			# col #3

	printf "TimeStamp, ";			# col #4

	printf "Delta, ";				# col #5

	printf "context Id, ";			# col #6

	printf "PC, ";					# col #7

	printf "UID, ";					# col #8

	if ($PrintFlagFormatString){printf "Format string, ";}	# col #9

	printf "Formatted text, ";		# col #10

	print "\n\n";

	while (1)

		{

		my $pos = tell (LOGFILE);

		# print file pos (col #0)

		if ($PrintFlagFilePos){	printf ("0x%08X, ", $pos);}

		my $category;

		my $subCategory;

		my $multipartFlags = 0;

		my $recordData = "";

		my $recordLen;

		my $recordPos = 0;

		$recordLen = ReadRecord(LOGFILE, \$pos, \$recordData, \$category, \$subCategory, \$multipartFlags, $RawMode);

		if ($recordLen == -1)

			{last;}

		if (!$RawMode && ($multipartFlags == $EMultipartMiddle || $multipartFlags == $EMultipartLast))

			{next;}

#		print record contents

#		my $buf;

#					for (my $i=0; $i < $recordLen; $i+=4)

#						{

#		$buf.= sprintf ("%08X ", unpack("V", substr($recordData, $recordPos+$i, 4)));

#						}

#		printf "\n[$buf\n]";				

		# for UTrace "ALL" range, read UID 

		if ($category >= $EAllRangeFirst && $category <= $EAllRangeLast && 

			(!$RawMode) && $multipartFlags != $EMultipartMiddle && $multipartFlags != $EMultipartLast)

			{

			$uid = unpack("V", substr($recordData, $recordPos, 4));

			$recordPos+= 4;	

			# then read formatID			

			$FormatIdIsSubCategory = ($subCategory != 0) ? 1 : 0;

			if ($FormatIdIsSubCategory)

				{

				$formatId = $subCategory

				}

			else				

				{

				$formatId = unpack("V", substr($recordData, $recordPos, 4));

  				$recordPos+= 4;

				}

			}

		# print UID (col #8)

		printf "0x%08X, ", $uid;

		my $formatTable;

		my $formatString;

		if ($category >= $EAllRangeFirst && $category <= $EAllRangeLast)

			{

			$formatString = $FormatTables{$uid}{$formatId};

			}

		else

			{

			$formatString = $FormatTables{$category}{$subCategory};

			}

		# Get thread names

		if ($category == $EThreadIdentification)

			{

			if ($subCategory == $EProcessName)

				{

				my $process = unpack("V", substr($recordData, 4, 4));

				my $processName = substr($recordData, 8, $recordLen - 8);	

#				printf ("\nprocess [%08X] processName [$processName]\n", $process);

				$ProcessNames{$process} = $processName;

				}

			elsif ($subCategory == $EThreadCreate || $subCategory == $EThreadName)

				{

				my $thread = unpack("V", substr($recordData, 0, 4));

				my $process = unpack("V", substr($recordData, 4, 4));

				my $threadName = substr($recordData, 8, $recordLen - 8);	

#				printf ("\nprocess [%08X] thread [%08X] threadName [$threadName]\n", $process, $thread, $threadName);

				$ThreadNames{$thread} = $ProcessNames{$process} . "::" . $threadName;

				}

			elsif ($subCategory == $EThreadId)

				{

				my $thread = unpack("V", substr($recordData, 0, 4));

				my $process = unpack("V", substr($recordData, 4, 4));

				my $threadId = unpack("V", substr($recordData, 8, 4));

#				printf ("\nprocess [%08X] thread [%08X] threadId [%08X]\n", $process, $thread, $threadId);

				$ThreadIds{$thread} = $threadId;

				}

			}

		# print Format string (col #9)

		if ($PrintFlagFormatString)

			{

			my $formatStringWithoutCommas = $formatString;

			$formatStringWithoutCommas=~ s/,/ /g;

			printf "%s, ", $formatStringWithoutCommas;

			}

		my $formattedText;

		my $lenFormatString = length($formatString);

		if ($lenFormatString && !$RawMode && $multipartFlags != $EMultipartMiddle && $multipartFlags != $EMultipartLast)

			{

			for (my $i=0; $i<$lenFormatString; $i++)

				{

				my $c = (substr ($formatString, $i, 1));

#				printf "$c\n";

				if ($c eq "%")

					{

					undef my $fieldLen;

					$i++;

	        		$c = (substr ($formatString, $i, 1));

					if ($c eq "%")

						{

						$formattedText.= substr ($formatString, $i, 1);

						next;

						}

					if ($c eq "*")	## take length from buffer

						{

						$fieldLen = unpack("V", substr($recordData, $recordPos, 4));

						if ($fieldLen > $recordLen-$recordPos)

							{

							$formattedText.= "*** Invalid field length ***";

							last;

							}

						$recordPos+= 4;

						$i++;

		        		$c = (substr ($formatString, $i, 1));

						}

					if (lc $c eq "x" || $c eq "h")

						{

						if (defined $fieldLen)

							{

							if (($fieldLen & 3) == 0)

								{

								for (my $i=0; $i< $fieldLen; $i+= 4)

									{

									$formattedText.= sprintf ("%08X ", unpack("V", substr($recordData, $recordPos, 4)));

									$recordPos+= 4;

									}

								}

							else

								{

								for (my $i=0; $i< $fieldLen; $i++)

									{

									$formattedText.= sprintf ("%02X ", unpack("C", substr($recordData, $recordPos, 1)));

									$recordPos++;

									}

								}

							}

						else

							{

							$formattedText.= sprintf ("0x%08X", unpack("V", substr($recordData, $recordPos, 4)));

							$recordPos+= 4;

							}

						$recordPos = ($recordPos + 3) & ~3;

						next;

						}

					# display "%ld" as hex for now as don't know how to get perl to use or display a 64 decimal value

					elsif (lc $c eq "l" && substr ($formatString, $i+1, 1) eq "d")

						{

						$i++;

						my $loWord = unpack("V", substr($recordData, $recordPos, 4));

						$recordPos+= 4;

						my $hiWord = unpack("V", substr($recordData, $recordPos, 4));

						$recordPos+= 4;

						$formattedText.= sprintf ("0x%X:%08X", $hiWord, $loWord);

						}

					elsif (lc $c eq "l" && substr ($formatString, $i+1, 1) eq "x")

						{

						$i++;

						my $loWord = unpack("V", substr($recordData, $recordPos, 4));

						$recordPos+= 4;

						my $hiWord = unpack("V", substr($recordData, $recordPos, 4));

						$recordPos+= 4;

						$formattedText.= sprintf ("0x%X:%08X", $hiWord, $loWord);

						}

					elsif (lc $c eq "d")

						{

						$formattedText.= sprintf ("%d", unpack("V", substr($recordData, $recordPos, 4)));

						$recordPos+= 4;

						$recordPos = ($recordPos + 3) & ~3;

						next;

						}

					elsif ($c eq "s")

						{

						if (!defined $fieldLen) 

							{$fieldLen = $recordLen - $recordPos;}

						$formattedText.= substr($recordData, $recordPos, $fieldLen);

						$recordPos+= $fieldLen; 

						$recordPos = ($recordPos + 3) & ~3;

						next;

						}

					elsif ($c eq "S")

						{

						if (!defined $fieldLen) 

							{$fieldLen = $recordLen-$recordPos;}

						for (my $j=0; $j < $fieldLen; $j+=2)

							{

					        my $byte = unpack("c", substr ($recordData, $recordPos+$j, 1));

 							$formattedText.= sprintf ("%c", $byte);

							}

						$recordPos+= $fieldLen; 

						$recordPos = ($recordPos + 3) & ~3;

						next;

						}

					elsif ($c eq "c")

						{

				        my $byte = unpack("c", substr ($recordData, $recordPos, 1));

						$formattedText.= sprintf ("%c", $byte);

						}

					}

				else

					{

					$formattedText.= $c;

					}

				}

			}

		else	# no format string : print as hex

			{

			for (my $i=0; $i < $recordLen; $i+=4)

				{

				$formattedText.= sprintf ("%08X ", unpack("V", substr($recordData, $i, 4)));

				}

			$recordPos+= $recordLen; $recordLen = 0;

			}

		# print Formatted text (col #10)

		$formattedText=~ s/,/;/g;

		$formattedText=~ s/\r//g;