// Copyright (c) 2008-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:

// e32\debug\crashMonitor\src\scmonitor.cpp

// Core dump server - Kernel side crash monitor

// 

//

/**

 @file

 @internalTechnology

*/

#include <scmonitor.h>

#include <kernel/monitor.h>

#include <assp.h>

#include <drivers/crashflash.h>

#include <kernel/klib.h>

#include <crashlogwalker.h>

#include <scmconfigitem.h>

#include "scmdatasave.h"

GLDEF_D SCMonitor TheSCMonitor; //global definition of SCMonitor

//keep things 4 byte aligned

const TInt KRestartType = SCMonitor::ESoftRestart;

/**

SCMonitor constructor

*/

SCMonitor::SCMonitor()

	: iMultiCrashInfo(NULL)

	{

	}

SCMonitor::~SCMonitor()

	{

	delete iMultiCrashInfo;

	}

/**

 Print data to the corresponding output channel. Derived from monitor

 @param aDes the buffer containing the data

 */

void SCMonitor::Print (const TDesC8& aDes )

	{

	//intended to do nothing

	}

/**

 * Allocates resources for SCMonitor

 * cant fully construct in constructor as we are a kernel extension and resources are limited when we are created

 */

void SCMonitor::StableConstruction()

	{

	LOG_CONTEXT

	iDataSave = new SCMDataSave(this, TheSCMonitor.iFlash);	

	//Configuration object for use upon crash

	iScmConfig = new SCMConfiguration();

	TInt err = iScmConfig->SetDefaultConfig();	

	if(KErrNone != err)

		{

		CLTRACE1("SCMonitor::StableConstruction - Unable to set default config err = %d", err);

		}

#ifdef NO_MULTICRASHINFO	

	iMultiCrashInfo = NULL;

#else	

	//We need to take a look at the flash map from variant_norflash_layout.h

	iMultiCrashInfo = new SCMMultiCrashInfo();

	TUint numberBlocks = KCrashLogSize / KCrashLogBlockSize;

	for(TUint32 cnt = 0; cnt < numberBlocks; cnt++)

		{

		iMultiCrashInfo->AddBlock(new SCMCrashBlockEntry(cnt, cnt * KCrashLogBlockSize, KCrashLogBlockSize));

		}

#endif

	}

/**

 * Start a secondary DFC queue for the Flash and Init the flash in the variant(h4)

 * @param aAny

 */

void StartSecondary (TAny* )

	{

	LOG_CONTEXT

	//InitFlash is implemented in the variant as it creates a variant

	//specific derived CrashFlash

	TheSCMonitor.InitFlash ( );

	TheSCMonitor.StableConstruction();

	}

/**

 * Global method to create a dfc queue

 * @param Method to intialise the flash.

 * @param Null

 * @param Gets the address of the supervisor thread DFC queue

 * @param TDfcQ priority number

 * @return a DFC object

 */

GLDEF_C TDfc StartSecondaryDfc(&StartSecondary, NULL, Kern::SvMsgQue(), KMaxDfcPriority-1);

/**

 * Kernel Main module entry - Own implementation( similar to crash logger)

 * @param aReason reason to enter to the method

 * @return One of the system wide codes

 */

GLDEF_C TInt KernelModuleEntry(TInt aReason)

	{	

	if(aReason==KModuleEntryReasonVariantInit0)

		{

		new(&TheSCMonitor) SCMonitor;

		// We are going to register the system Crash monitor here so that the order

		// the monitor modules are placed in rom is preserved.  

		// The monitor is not fully intialised here.

		//the variant target is missing as we still have to finalise on the crash flash 

		//implementation. H2 & H4 doesnt support currently.

		LOG_CONTEXT		

		CLTRACE("Installing System Crash Monitor");

		Monitor::RegisterMonitorImpl (&TheSCMonitor );

		return KErrNone;

		}

	else if (aReason==KModuleEntryReasonExtensionInit0 )

		{

		return KErrNone;

		}

	else if (aReason==KModuleEntryReasonExtensionInit1 )

		{

		LOG_CONTEXT

		CLTRACE("Enqueing dfc to init crash flash for System Crash Monitor after all modules loaded");

		StartSecondaryDfc.Enque ( );

		return KErrNone;

		}

	return KErrArgument;

	}

/**

 Method to intialize the system crash monitor

 @param aCategory the fault category type

 @param aReason the reason for crash

 @return restart type

 */

TInt SCMonitor::Init2 (TAny* aCategory, TInt aReason )

	{

	LOG_CONTEXT

	__KTRACE_OPT(KALWAYS, Kern::Printf("\n\nSystem Crash Monitor Launched: To Analyse Crash Produced Use Core Dump Server\n"));

	//Start logging the data:	

	//Need to lock kernel to access object containers (it technically is anyway, but flag isnt set)

	NKern::Lock();

	DoCrash(aCategory, aReason);	

	NKern::Unlock();		

	__KTRACE_OPT(KALWAYS, Kern::Printf("System Crash Monitor Finished: Log Size = [%d]\n", iDataSave->iCrashInf.iLogSize));

	return KRestartType;

	}

/**

 * This is responsible for setting up any structures required for processing of the crash

 * @param aCategory the fault category type

 * @param aReason 

 */

void SCMonitor::DoCrash(TAny* aCategory, TInt aReason )

	{

	// get debug mask

	TInt dbgMask = Kern::SuperPage().iDebugMask[0];

	// if we are writing to the comm port then we need to turn off other debug messages

	if( iDataSave->GetWriteSelect() == SCMDataSave::EWriteComm)

		{

		Kern::SuperPage().iDebugMask[0] = 0;

		}

	if(!aCategory)

		{

		CLTRACE("\tNULL category retrieved and returning");

		TheSCMonitor.iFlash->EndTransaction();

		return;

		}

	iFrame = NULL;

	CLTRACE("\tAbout to set category -- note: can occasionaly crash board");	

	iFaultCategory = *(const TDesC8*)aCategory;  // this crashes the board sometimes		

	iFaultReason = aReason;

	Epoc::SetMonitorExceptionHandler ((TLinAddr)HandleException );

	// get the first start block

	// will retieve start of flash by default

	SCMCrashBlockEntry block;

	TInt err = GetNextCrashStartPoint(block);  // will also attempt to read iScmConfig

	if(KErrNone == err)

		{

		CLTRACE2("SCMonitor::DoCrash next crash will be written at blocknumber = %d offset  %d"

				, block.iBlockNumber, block.iBlockOffset);

		}

	else

		{

		CLTRACE1("SCMonitor::DoCrash Failed to find a valid block to write to, can not continue. err = [%d]", err);

		return;

		}

	TUint crashId = block.iBlockNumber;	

	iDataSave->iWriter->ResetBytesWritten();		

	//Write the crash (1st pass is to gather header data)

	TInt spaceRequired = ProcessCrash(block, crashId, EFalse);					

	// now do the real write	

	// prepare flash for data	

	TheSCMonitor.iFlash->StartTransaction();	

	TheSCMonitor.iFlash->SetWritePos(block.iBlockOffset);

	//write the crash this time

	ProcessCrash(block, crashId, ETrue);

	TheSCMonitor.iFlash->EndTransaction();	

	// restore debug mask

	Kern::SuperPage().iDebugMask[0] = dbgMask;

	}

/**

 * This walks the existing crash log and finds out where current crashes finish

 * @param aBlockEntry Block to use. Only valid if KErrNone is returned.

 * @return One of the OS wide codes

 */

TInt SCMonitor::GetNextCrashStartPoint(SCMCrashBlockEntry& aBlockEntry)

	{

	LOG_CONTEXT	

	//First thing is to try and read the config

	TBool configFound = (iDataSave->ReadConfig(*iScmConfig) == KErrNone);

	if( iMultiCrashInfo)	

		{				

		/**

		 * data save has been configured to use multicrash info to find the next block we are on we need to scan each

		 * block to see if it contains a valid header. if we find an empty block in our block list then that is the

		 * one we will use if we find no empty blocks then we have no room left	

		 */

		iMultiCrashInfo->Reset();

		SCMCrashBlockEntry* block = iMultiCrashInfo->GetNextBlock();

		TBool blockFound = EFalse;				

		//For any crashes in flash, we need to record where they end, so that we can then go to the next

		//block after the one in which it ends

		TInt crashEndPoint = 0;		

		while(block)

			{	

			CLTRACE1("SCMonitor::GetNextCrashStartPoint Processing block number %d", block->iBlockNumber );			

			//If we have already found our block, we should erase subsequent ones for use

			if(blockFound)

				{

				TInt err = EraseFlashBlock(*block);

				if(err != KErrNone)

					{					

					return err;

					}

				block = iMultiCrashInfo->GetNextBlock(); 

				continue;

				}	

			//is this block before a crash end? if it is, we cant use it as a crash can span multiple blocks

			if(block->iBlockOffset >= crashEndPoint)

				{

				//special condition if we have a config

				TUint startPos = block->iBlockOffset;

				TUint skipBytes = 0;

				if(configFound && block->iBlockOffset == 0)

					{

					startPos+=iScmConfig->GetSize();

					//must align to flash for read

					skipBytes = startPos % KFlashAlignment;	

					startPos -= skipBytes;

					}

				// try and read an info header at these flash coords

				TBuf8<TCrashInfoHeader::KSCMCrashInfoMaxSize + KFlashAlignment> buf;

				buf.SetLength(TCrashInfoHeader::KSCMCrashInfoMaxSize + KFlashAlignment);

				CLTRACE1("(SCMonitor::GetNextCrashStartPoint) reading at offset %d", block->iBlockOffset);

				TheSCMonitor.iFlash->SetReadPos(startPos);

				TheSCMonitor.iFlash->Read(buf);

				// create the buffer applying the offset of bytes skipped

				TByteStreamReader reader(const_cast<TUint8*> (buf.Ptr() + skipBytes));

				TCrashInfoHeader header;								

				TInt err = header.Deserialize(reader);

				if(err == KErrCorrupt)

					{

					CLTRACE2("(SCMonitor::GetNextCrashStartPoint) Found empty block blocknumber %d blockoffset = %d"

							, block->iBlockNumber, block->iBlockOffset);

					blockFound = ETrue;

					aBlockEntry = *block;

					continue; //Dont get next block, as next run will erase this current block for use

					}

				else

					{					

					crashEndPoint = header.iLogSize + startPos;

					CLTRACE3("(SCMonitor::GetNextCrashStartPoint) In block [%d] we found a valid crash header. This crash finishes at [%d] [0x%X]", block->iBlockNumber, crashEndPoint, crashEndPoint);

					}

				}

			block = iMultiCrashInfo->GetNextBlock();

			}									

		if(blockFound)

			{

			return KErrNone;

			}

		else

			{

			//CLTRACE("(SCMonitor::GetNextCrashStartPoint) No available blocks TREATING as NO MULTICRASH INFO will write to default block");

			//In this case should we just overwrite old crashes and return the first block as the comment above suggests

			//return blockFound;

			}

		}

	// no multi crash info supplied - use default first block settings

	TInt err = EraseEntireFlashPartition();

	if(err != KErrNone)

		{

		CLTRACE1("Unable to delete area required to log to flash. Aborting. Error - [%d]", err);

		return err;

		}

	aBlockEntry = SCMCrashBlockEntry(0,0,0);

	return KErrNone;

	}

/**

 * Handles the processing of the crash

 * @return The size of the crash log (including header) that has been/will be written

 */

TInt SCMonitor::ProcessCrash(const SCMCrashBlockEntry& aBlock, TUint aCrashId, TBool aCommit)

	{	

	LOG_CONTEXT

	CLTRACE5("aBlock.iBlockOffset = [%d]  [0x%X] aBlock.iBlockNumber = %d aBlock.iBlockSize = [%d]  [0x%X]",

			aBlock.iBlockOffset, aBlock.iBlockOffset, aBlock.iBlockNumber, aBlock.iBlockSize, aBlock.iBlockSize);		

	// reset writer for start of each crash

	iDataSave->iWriter->ResetBytesWritten();

	TInt logLevel = 0;

	if(aCommit)

		{

		logLevel = KALWAYS;

		iDataSave->iWriter->EnablePhysicalWriting();	

		}

	else

		{

#if defined(_DEBUG)

		logLevel = KDEBUGGER;

#else

		logLevel = KALWAYS; //Doesnt matter, KTRACE OPT is empty for rel builds 

		if(logLevel != KALWAYS)

			{

			//This is to avoid warning

			}

#endif

		iDataSave->iWriter->DisablePhysicalWriting();	

		}

	iDataSave->SetByteCount(aBlock.iBlockOffset);	

	if(aBlock.iBlockOffset == 0 && aBlock.iBlockNumber == 0)

		{	

		// this is the first crash - we need to save the config here first

		CLTRACE("(SCMonitor::ProcessCrash) - this is block 0 - WRITING CONFIG");

		iDataSave->LogConfig(*iScmConfig);	

		//Config is not part of crash so reset bytes written			

		iDataSave->SetCrashStartingPoint(iDataSave->iWriter->GetBytesWritten());		

		}	

	else

		{

		iDataSave->SetCrashStartingPoint(aBlock.iBlockOffset);

		}	

	iDataSave->iWriter->ResetBytesWritten();

	TUint32 logSize = 0;

	TUint sizeOfObjectDumped = 0;

	TInt err = iDataSave->LogCrashHeader(iFaultCategory, iFaultReason, aCrashId, sizeOfObjectDumped);		

	if(KErrNone != err)

		{

		CLTRACE("System Crash Monitor: Failed to create crash info header - (TCrashInfo)"); 

		return KRestartType;

		}	

	logSize += sizeOfObjectDumped;

	//Now we must read the configuration to use. This is held at the start of our flash partition

	//and managed by the iConfig object

	iScmConfig->ResetToHighestPriority();	

	//Always want the crash context

	iDataSave->iHdr.iCTFullRegOffset = logSize + iDataSave->GetCrashStartingPoint();

	err = iDataSave->LogCPURegisters(sizeOfObjectDumped);

	if(KErrNone != err)

		{

		CLTRACE1("\tError logging full registers = %d", err);

		}	

	logSize += sizeOfObjectDumped;

	CLTRACE("\tAbout to enter processing loop");		

	SCMDataSave::TDataToDump dump;

	for(;;)		

		{		

		//now we get each item by priority from the configuration

		TConfigItem* configItem = iScmConfig->GetNextItem();

		if(!configItem)

			{

			// end of list

			break;

			}

		CLTRACE1("\nLooking at item type [%d]", configItem->GetDataType());

		if(configItem->GetSpaceRequired() > iDataSave->SpaceRemaining())

			{

			__KTRACE_OPT(logLevel, Kern::Printf("\t\tFor Item Type [%d]: Unable to log [0x%X] [%d] bytes because we only have [0x%X] [%d] bytes left", configItem->GetDataType(), configItem->GetSpaceRequired(), configItem->GetSpaceRequired(), iDataSave->SpaceRemaining(), iDataSave->SpaceRemaining()));

			continue;

			}

		else

			{

			CLTRACE1("Will require [%d] bytes for this item", configItem->GetSpaceRequired());

			}

		// only interested in logging items with priority > 0

		if( configItem->GetPriority() <= 0)

			{

			CLTRACE1("\tIgnored config item type %d priority 0", configItem->GetDataType());

			continue;

			}

		//there are a lot of TUints in the hdr to record where we wrote this item. 

		//This will point to the one of interest for this configItem

		TUint32* offsetPointer = NULL;				

		//now we check the type of data we wish to dump

		switch(configItem->GetDataType())

			{

			case TConfigItem::ECrashedThreadMetaData:			

				{

				__KTRACE_OPT(logLevel, Kern::Printf("\tDoing: ECrashedThreadMetaData at [%d] offset from [%d]", iDataSave->iWriter->GetBytesWritten(), iDataSave->GetCrashStartingPoint()));

				err = LogThreadMetaData(SCMDataSave::EThreadSpecific, sizeOfObjectDumped);

				offsetPointer = &(iDataSave->iHdr.iCTMetaOffset);

				break;

				}

			case TConfigItem::EThreadsMetaData:			

				{

				__KTRACE_OPT(logLevel, Kern::Printf("\tDoing: EThreadsMetaData at [%d] offset from [%d]", iDataSave->iWriter->GetBytesWritten(), iDataSave->GetCrashStartingPoint()));

				//record location we are writing to in the header

				iDataSave->iHdr.iTLstOffset = iDataSave->iWriter->GetBytesWritten();

				err = LogThreadMetaData(SCMDataSave::ESystemWide, sizeOfObjectDumped);

				offsetPointer = &(iDataSave->iHdr.iTLstOffset);

				break;

				}

			case TConfigItem::ECrashedProcessMetaData:			

				{

				__KTRACE_OPT(logLevel, Kern::Printf("\tDoing: ECrashedProcessMetaData at [%d] offset from [%d]", iDataSave->iWriter->GetBytesWritten(), iDataSave->GetCrashStartingPoint()));

				err = LogProcessMetaData(SCMDataSave::EProcessSpecific, sizeOfObjectDumped);

				offsetPointer = &(iDataSave->iHdr.iCPMetaOffset);

				break;

				}

			case TConfigItem::EProcessMetaData:		

				{

				__KTRACE_OPT(logLevel, Kern::Printf("\tDoing: EProcessMetaData at [%d] offset from [%d]", iDataSave->iWriter->GetBytesWritten(), iDataSave->GetCrashStartingPoint()));

				err = LogProcessMetaData(SCMDataSave::ESystemWide, sizeOfObjectDumped);

				offsetPointer = &(iDataSave->iHdr.iPLstOffset);

				break;

				}

			case TConfigItem::ECrashedProcessUsrStacks:			

				{

				__KTRACE_OPT(logLevel, Kern::Printf("\tDoing: ECrashedProcessUsrStacks at [%d] offset from [%d]", iDataSave->iWriter->GetBytesWritten(), iDataSave->GetCrashStartingPoint()));

				//define what we wish to dump

				dump.iMetaData = EFalse;

				dump.iCodeSegs = EFalse;

				dump.iStk = SCMDataSave::EUsrStack;

				dump.iReg = SCMDataSave::ERegSetNone;	

				err = LogObjectContainers(EThread, SCMDataSave::EProcessSpecific, dump, sizeOfObjectDumped);	

				offsetPointer = &(iDataSave->iHdr.iCTUsrStkOffset);

				break;

				}

			case TConfigItem::EThreadsUsrStack:			

				{

				__KTRACE_OPT(logLevel, Kern::Printf("\tDoing: EThreadsUsrStack at [%d] offset from [%d]", iDataSave->iWriter->GetBytesWritten(), iDataSave->GetCrashStartingPoint()));