// 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\scmdatasave.cpp

// 

//

#define __INCLUDE_REG_OFFSETS__  // for SP_R13U in nk_plat.h

#include <omap_dbg.h>

#include "arm_mem.h"

#include "nk_plat.h"

#include <omap_assp.h>

#include <scmonitor.h>

#include <scmdatasave.h> 

/**

 * @file

 * @internal technology

 */

/**

 * SCMDataSave constructor

 * @param aMonitor - the monitor which has caught the syetem crash this object is saving data for 

 * @param aFlash - the flash memory data will be written to, note the CrashFlash interface is

 * 				   rather limited and does not support partial block writes

 * @param aFlashInfo - data describing the structure of the flash data

 */

EXPORT_C SCMDataSave::SCMDataSave(Monitor* aMonitor, CrashFlash* aFlash)

	: iMonitor(aMonitor)

		,iFlash(aFlash)

		,iByteCount(0)	

#ifdef SCM_COMM_OUTPUT	

		,iWriteSelect(EWriteComm)  // write data to debug port	

#else	

		,iWriteSelect(EWriteFlash)  // write data to flash

#endif

		,iPerformChecksum(ETrue)			 // checksum data 

		,iStartingPointForCrash(0)

	{  		

	const TInt KCacheSize = 128;

	iFlashCache = HBuf8::New(KCacheSize);

	CLTRACE1("(SCMDataSave) Creating writer with cache size = %d", KCacheSize);

	iWriter = new TCachedByteStreamWriter(const_cast<TUint8*>(iFlashCache->Ptr()), KCacheSize);

	iWriter->SetWriterImpl(this);

	}

/**

 * Destructor

 */

SCMDataSave::~SCMDataSave()

	{

	delete iFlashCache;

	}

/**

 * Getter for the current byte count. This is the amount of data that has currently 

 * been written to given media for this crash log

 * @return The number of bytes written already to given media

 */

TInt SCMDataSave::GetByteCount()

	{

	return iByteCount;

	}

/**

 * Logs the user stack for a given DThread object if it is available

 * @param aThread - thread whose stack we wish to log

 * @param aSizeDumped Holds the size of the data dumped

 * @return one of the OS codes

 */

TInt SCMDataSave::LogThreadUserStack(DThread* aThread, TBool aFullStack, TUint& aSizeDumped)

	{

	LOG_CONTEXT

	aSizeDumped = 0;

	TUint memDumped = 0;	

	TUint svSp, usrSp;

	iMonitor->GetStackPointers(&(aThread->iNThread), svSp, usrSp );	

	//first we check for a user stack...

	if (aThread->iUserStackRunAddress && aThread->iUserStackSize)

		{		

		//Get data together

		TThreadStack usrStack;

		usrStack.iStackType = TThreadStack::EUsrStack;

		usrStack.iThreadId = (TUint64)aThread->iId;					

		//map in the user stack

		TUint8* usrStart = (TUint8*)iMonitor->MapAndLocateUserStack(aThread); //What about Demand paging??

		TUint8* usrEnd = (TUint8*)(usrStart + aThread->iUserStackSize);

		if(usrStart) 

			{

			TUint8* stackPointer = (TUint8*)usrSp;			

			//check the stack pointer is in the range of the stack...

			if (stackPointer < usrStart || stackPointer >= usrEnd)

				{

				stackPointer = usrStart;

				}

			//log the size of the stack we are dumping

			usrStack.iStackSize = aFullStack || (stackPointer == usrStart) ? usrEnd - usrStart : usrEnd - stackPointer;

			TUint8* dumpFrom = aFullStack ? usrStart : stackPointer;

			//write the stack

			aSizeDumped+= usrStack.GetSize();

			usrStack.Serialize(*iWriter);					

			//now we dump the actual stack

			//if there is a memErr when we read, there isnt much we can do - possibly a bit in the struct to say available/not available?

			//-1 because we dont want to write the byte at usrEnd			

			MTRAPD(memErr, LogMemory(dumpFrom, usrStack.iStackSize, aThread, memDumped));			

			if(KErrNone != memErr)

				{

				CLTRACE("Failed to log usr stack");

				}

			aSizeDumped+= memDumped;					

			}

		else

			{

			//write the struct

			aSizeDumped+=usrStack.GetSize();

			usrStack.Serialize(*iWriter);

			}

		}	

	return KErrNone;

	}

/**

 * Logs the supervisor stack for a given DThread object

 * @param aThread - thread whose stack we wish to log

 * @param aSizeDumped Holds the size of the data dumped

 * @return one of the system wide codes

 */

TInt SCMDataSave::LogThreadSupervisorStack(DThread* aThread, TBool aFullStack, TUint& aSizeDumped)

	{	

	LOG_CONTEXT

	aSizeDumped = 0;

	TUint memDumped;	

	TUint svSp, usrSp;

	iMonitor->GetStackPointers(&(aThread->iNThread), svSp, usrSp );

	//now we dump the supervisor stack

	TThreadStack svrStack;

	svrStack.iStackType = TThreadStack::ESvrStack;

	svrStack.iThreadId = (TUint64)aThread->iId;

	if (aThread->iSupervisorStack && aThread->iSupervisorStackSize)

		{

		TUint8* svrStart = (TUint8*)aThread->iSupervisorStack;

		TUint8* svrEnd = (TUint8*)(svrStart + aThread->iSupervisorStackSize);

		TUint8* svrStackPointer = (TUint8*)svSp;

		//size of stack we are to dump

		svrStack.iStackSize = aFullStack || (svrStackPointer == svrStart) ? svrEnd - svrStart  : svrEnd - svrStackPointer;					

		if(svrStart)

			{

			//check the stack pointer is in the range of the stack...

			if (svrStackPointer < svrStart || svrStackPointer >= svrEnd)

				{

				svrStackPointer = svrStart;

				}

			//write struct to flash

			aSizeDumped+=svrStack.GetSize();

			svrStack.Serialize(*iWriter);

			//now we dump the actual stack

			//if there is a memErr when we read, there isnt much we can do - possibly a bit in the struct to say available/not available?

			MTRAPD(memErr, LogMemory(svrStart, svrStack.iStackSize, aThread, memDumped));

			aSizeDumped+=memDumped;

			if(KErrNone != memErr)

				{

				CLTRACE("Failed to log supervisor stack");

				}						

			}

		else

			{

			//write the struct

			aSizeDumped+=svrStack.GetSize();

			svrStack.Serialize(*iWriter);

			}

		}

	return KErrNone;

	}

/**

 * Takes a DProcess kernel object and logs its corrosponding code segments

 * @param aProcess

 * @param aSizeDumped Holds the size of the data dumped

 * @return one of the OS wide error codes

 */

TInt SCMDataSave::LogCodeSegments(DProcess* aProc, TUint& aSizeDumped)

	{	

	LOG_CONTEXT

	aSizeDumped = 0;	

	//the code segment set for this process

	TCodeSegmentSet segSet;

	segSet.iPid = (TUint64)aProc->iId;

	//make sure list mutex is ok

	if(Kern::CodeSegLock()->iHoldCount)

		{

		return KErrCorrupt;

		}

	//get code seg list

	SDblQue queue;		

	aProc->TraverseCodeSegs(&queue, NULL, DCodeSeg::EMarkDebug, DProcess::ETraverseFlagAdd);

	//iterate through the list

	TInt codeSegCnt = 0;

	for(SDblQueLink* codeSegPtr= queue.First(); codeSegPtr!=(SDblQueLink*) (&queue); codeSegPtr=codeSegPtr->iNext)

		{

		//get the code seg

		DEpocCodeSeg* codeSeg = (DEpocCodeSeg*)_LOFF(codeSegPtr,DCodeSeg, iTempLink);

		if(codeSeg)

			{

			codeSegCnt++;

			}

		}

	if(codeSegCnt == 0)

		{

		return KErrNone;

		}	

	segSet.iNumSegs = codeSegCnt;

	segSet.Serialize(*iWriter);	

	aSizeDumped+=segSet.GetSize();

	TModuleMemoryInfo memoryInfo;

	//now we write each code segment

	for(SDblQueLink* codeSegPtr= queue.First(); codeSegPtr!=(SDblQueLink*) (&queue); codeSegPtr=codeSegPtr->iNext)

		{

		//get the code seg

		DEpocCodeSeg* codeSeg = (DEpocCodeSeg*)_LOFF(codeSegPtr,DCodeSeg, iTempLink);

		if(codeSeg)

			{			

			TCodeSegment seg;									

			seg.iXip = (codeSeg->iXIP) ? ETrue : EFalse;

			//Get the code seg type

			if(codeSeg->IsExe())

				{

				seg.iCodeSegType = EExeCodeSegType;

				}

			else if(codeSeg->IsDll())

				{

				seg.iCodeSegType = EDllCodeSegType;

				}

			TInt err = codeSeg->GetMemoryInfo(memoryInfo, NULL);

			if(KErrNone == err)

				{

				seg.iCodeSegMemInfo = memoryInfo;

				}

			else

				{

				seg.iCodeSegMemInfo.iCodeSize = 0; 

				// Still need to indicate it wasnt available somehow

				}

			//Get filename			

			seg.iNameLength = codeSeg->iFileName->Length();

			seg.iName = *(codeSeg->iFileName);

			aSizeDumped+=seg.GetSize();

			seg.Serialize(*iWriter);						

			}

		}

	//Empty this queue and clear marks

	DCodeSeg::EmptyQueue(queue, DCodeSeg::EMarkDebug);

	return KErrNone;

	}

/**

 * This logs the rom version and header information to the crash media

 * @param aSizeDumped amount of data occupied

 * @return one of the OS wide codes

 */

TInt SCMDataSave::LogRomInfo(TUint& aSizeDumped)	

	{

	aSizeDumped = 0;

	TRomHeaderData romData;

	TRomHeader rHdr = Epoc::RomHeader();

	romData.iMajorVersion = rHdr.iVersion.iMajor;

	romData.iMinorVersion = rHdr.iVersion.iMinor;

	romData.iBuildNumber = rHdr.iVersion.iBuild;

	romData.iTime = rHdr.iTime;

	TInt err = romData.Serialize(*iWriter);

	if(KErrNone != err)

		{

		return err;

		}

	aSizeDumped += romData.GetSize();

	return KErrNone;

	}

/**

 * Takes a DProcess kernel object and logs to flash

 * @param aProc

 * @param aSizeDumped Holds the size of the data dumped

 * @return one of the OS wide error codes

 */

TInt SCMDataSave::LogProcessData(DProcess* aProc, TUint& aSizeDumped)

	{	

	LOG_CONTEXT

	aSizeDumped = 0;	

	TProcessData procData;

	DCodeSeg* codeSeg = aProc->iCodeSeg;

	procData.iPriority = aProc->iPriority;

	procData.iPid = (TUint64)aProc->iId;

	//the code segment is not always available

	if(codeSeg)

		{

		procData.iNamesize = codeSeg->iFileName->Length();

		procData.iName = *(codeSeg->iFileName);

		}

	aSizeDumped += procData.GetSize();

	procData.Serialize(*iWriter);

	return KErrNone;

	}

/**

 * Creates meta data about the crash such as time of crash, exit reason etc. to be logged

 * later on when we have log size.

 * @param aCategory - crash category

 * @param aReason - crash reason

 * @param aSizeDumped Holds the size of the data dumped

 * @return one of the OS wide codes

 */

TInt SCMDataSave::LogCrashHeader(const TDesC8& aCategory, TInt aReason, TInt aCrashId, TUint& aSizeDumped)

	{

	LOG_CONTEXT

	aSizeDumped = 0;

	//the thread that crashed is the context in which we are running

	DThread* crashedThread = &Kern::CurrentThread();

	iCrashInf.iPid = crashedThread->iOwningProcess->iId; 

	iCrashInf.iTid = crashedThread->iId;

	iCrashInf.iCrashTime = CrashTime();

	iCrashInf.iExitType = 0; // Not yet done: Exception or Fault - should be in category

	iCrashInf.iExitReason = aReason;

	iCrashInf.iFlashAlign = KFlashAlignment; //record the flash alignment (word aligned for now)

	iCrashInf.iCachedWriterSize = iWriter->GetCacheSize();

	iCrashInf.iCategorySize = aCategory.Length();

	iCrashInf.iCategory = aCategory;	

	iCrashInf.iCrashId = aCrashId;

	iCrashInf.iFlashBlockSize = KCrashLogBlockSize;;

	iCrashInf.iFlashPartitionSize = KCrashLogSize;;

	TSuperPage& sp=Kern::SuperPage();

	iCrashInf.iExcCode = sp.iKernelExcId;

	//These will be updated with more info at end of crash

	aSizeDumped+=iCrashInf.GetSize();

	iCrashInf.Serialize(*iWriter);

	aSizeDumped+=iHdr.GetSize();

	iHdr.Serialize(*iWriter);		

	CLTRACE1("(SCMDataSave::LogCrashHeader) finished bytes written= %d", iWriter->GetBytesWritten());

	return KErrNone;

	}

/**

 * Logs meta data about a given DThread object

 * @param aThread Thread to dump

 * @param aSizeDumped Holds the size of the data dumped

 * @return

 */

TInt SCMDataSave::LogThreadData(DThread* aThread, TUint& aSizeDumped)

	{

	LOG_CONTEXT

	aSizeDumped = 0;	

	//struct to hold data that gets written to flash

	TThreadData threadData;

	threadData.iTid = (TUint64)aThread->iId;

	threadData.iOwnerId = (TUint64)aThread->iOwningProcess->iId;

	threadData.iPriority = aThread->iThreadPriority;

	//Get the stack pointers	

	TUint svSp, usrSp;

	iMonitor->GetStackPointers(&(aThread->iNThread), svSp, usrSp );

	threadData.iUsrSP = usrSp;

	threadData.iSvcSP = svSp;

	//supervisor and user stack details

	threadData.iSvcStack = (TInt32)aThread->iSupervisorStack;

	threadData.iSvcStacksize = aThread->iSupervisorStackSize;

	threadData.iUsrStack = aThread->iUserStackRunAddress;

	threadData.iUsrStacksize = aThread->iUserStackSize;	

	//currently we can only get the kernels heap

	if(aThread == &Kern::CurrentThread())

		{

		TInt32 heapLoc = 0;

		TInt32 heapSz = 0;

		TInt err = FindKernelHeap(heapLoc,heapSz);

		if(KErrNone == err)

			{

			threadData.iSvcHeap = heapLoc;

			threadData.iSvcHeapSize = heapSz;

			}

		else

			{

			CLTRACE("\tError: Unable to get kernel heap");

			}

		}	

	//get filename	

	TFileName filename;

	aThread->TraceAppendFullName(filename, EFalse);

	threadData.iName.Copy(filename);

	threadData.iNamesize = threadData.iName.Length();

#ifdef __INCLUDE_NTHREADBASE_DEFINES__

	threadData.iLastCpu = aThread->iNThread.iLastCpu;

#else	

	threadData.iLastCpu = aThread->iNThread.iSpare3;	

#endif	

	threadData.Serialize(*iWriter);

	aSizeDumped+=threadData.GetSize();

	return KErrNone;

	}

/**

 * Logs the arm exception stacks 

 * @param aSizeDumped Holds the size of the data dumped 

 * @return one of the OS wide codes

 */

TInt SCMDataSave::LogExceptionStacks(TUint& aSizeDumped)

	{

	LOG_CONTEXT

	aSizeDumped = 0;

	TUint memDumped = 0;

	#if defined(__EPOC32__) && !defined(__CPU_X86)

	TStackInfo& stackInfo = Kern::SuperPage().iStackInfo;

	TThreadStack irqStack;

	irqStack.iStackType = TThreadStack::EIRQStack;

	irqStack.iStackSize = stackInfo.iIrqStackSize;

	aSizeDumped+=irqStack.GetSize();

	irqStack.Serialize(*iWriter);

	//now dump the IRQ memory - not much we can do in the event of an error

	MTRAPD(irqErr, LogMemory((TUint8*)stackInfo.iIrqStackBase, stackInfo.iIrqStackSize, &Kern::CurrentThread(), memDumped));	

	if(KErrNone != irqErr)

		{

		CLTRACE("*****Failed to log IRQ stack");

		}

	aSizeDumped+=memDumped;

	//Next, we do the FIQ stack

	TThreadStack fiqStack;

	fiqStack.iStackType = TThreadStack::EFIQStack;

	fiqStack.iStackSize = stackInfo.iFiqStackSize;

	aSizeDumped+=fiqStack.GetSize();

	fiqStack.Serialize(*iWriter);

	//Now dump the stack itself

	MTRAPD(fiqErr, LogMemory((TUint8*)stackInfo.iFiqStackBase, stackInfo.iFiqStackSize, &Kern::CurrentThread(), memDumped));

	if(KErrNone != fiqErr )

		{

		CLTRACE("*****Failed to log FIQ stack");

		}

	aSizeDumped+=memDumped;

	#endif

	return KErrNone;

	}

/**

 * Logs the CPU Registers at the time of crash

 * @param aSizeDumped Holds the size of the data dumped

 * @return system wide OS code

 */