sl@0: // Copyright (c) 1996-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // e32test\system\t_exc.cpp
sl@0: // In WINS T_EXC should be run from the command line only.
sl@0: // T_EXC will not complete when run under the MSDEV debugger.
sl@0: // Overview:
sl@0: // Test and verify exception handling.
sl@0: // API Information:
sl@0: // User::SetExceptionHandler, User::RaiseException
sl@0: // Details:
sl@0: // - Create a global semaphore, verify success.
sl@0: // - Test exceptions with no handlers: verify that divide by zero and 
sl@0: // User::RaiseException() panic as expected.
sl@0: // - Test exceptions with handlers: verify that divide by zero and
sl@0: // User::RaiseException() call their exception handlers as expected.
sl@0: // - Test exception raised in exception handler: verify divide by zero
sl@0: // causes exception and an exception in the exception handler causes 
sl@0: // a panic.
sl@0: // - Verify the results are as expected when a thread causes a divide
sl@0: // by zero exception.
sl@0: // - Get context of interrupted thread, get context of thread waiting 
sl@0: // for request, get context of suspended thread. Verify results are
sl@0: // as expected.
sl@0: // Platforms/Drives/Compatibility:
sl@0: // All.
sl@0: // Assumptions/Requirement/Pre-requisites:
sl@0: // Failures and causes:
sl@0: // Base Port information:
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include <e32test.h>
sl@0: #include <e32svr.h>
sl@0: #include "u32std.h"
sl@0: 
sl@0: #pragma warning( disable : 4723 ) // disable divide by zero warnings
sl@0: 
sl@0: #ifdef __MARM__
sl@0: void UndefinedInstruction();
sl@0: #endif
sl@0: 
sl@0: LOCAL_D RTest test(_L("T_EXC"));
sl@0: RDebug debug;
sl@0: 
sl@0: TInt gCount=0;
sl@0: RSemaphore gSem;
sl@0: TBool outsideExcSupported=ETrue;
sl@0: 
sl@0: void excHandler(TExcType /*aType*/)
sl@0: //
sl@0: // An exception handler that does nothing
sl@0: //
sl@0: 	{
sl@0: 
sl@0: 	gCount++;
sl@0: 	}
sl@0: 
sl@0: void excHandlerFault(TExcType aType)
sl@0: //
sl@0: // An exception handler that causes an exception
sl@0: //
sl@0: 	{
sl@0: 	debug.Print(_L("Handling exception %d and causing exception in handler"), aType);
sl@0: 	gCount++;
sl@0: 
sl@0: #ifdef __MARM__
sl@0: 	// There is no Divide By Zero exception on the Arm
sl@0: 	// Use undefined instruction instead
sl@0: 	UndefinedInstruction();
sl@0: #else
sl@0: 	// Cause a div by zero exception
sl@0: 	volatile int i=0;
sl@0: 	volatile int j=10;
sl@0: 	int l=j/i;
sl@0: 	for (i=0; i<l; i++)
sl@0: 		;
sl@0: #endif
sl@0: 	}
sl@0: 
sl@0: TInt waitSemaphore(TAny *)
sl@0: //
sl@0: // Sleep
sl@0: //
sl@0: 	{
sl@0: 	RSemaphore s;
sl@0: 	TInt r=s.OpenGlobal(_L("A SEMAPHORE"));
sl@0: 	test(r==KErrNone);
sl@0: 	s.Wait();
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: TInt garfield(TAny *)
sl@0: //
sl@0: // Sleep for a long time
sl@0: //
sl@0: 	{
sl@0: 
sl@0: 	User::After(10000000);
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: TInt odie(TAny *)
sl@0: //
sl@0: // Run round in circles
sl@0: //
sl@0: 	{
sl@0: 	FOREVER
sl@0: 		;
sl@0: 	}
sl@0: 
sl@0: TInt divideByZero(TAny *)
sl@0: //
sl@0: // Divide by zero
sl@0: //
sl@0: 	{
sl@0: #ifdef __MARM__
sl@0: 	// There is no Divide By Zero exception on the Arm
sl@0: 	// Use undefined instruction instead
sl@0: 	UndefinedInstruction();
sl@0: 	return(KErrNone);
sl@0: #else
sl@0: #ifdef __WINS__
sl@0: #pragma warning( disable : 4189 )	// local variable is initialized but not referenced
sl@0: #endif
sl@0: 	volatile int i=0, j=10;
sl@0: 	volatile int l=j/i;
sl@0: 	FOREVER
sl@0: 		;
sl@0: #endif
sl@0: 	}
sl@0: #pragma warning( default : 4723 )
sl@0: 
sl@0: TInt raiseException(TAny *)
sl@0: //
sl@0: // Raise an exception
sl@0: //
sl@0: 	{
sl@0: 
sl@0: 	User::RaiseException(EExcIntegerDivideByZero);
sl@0: 	User::After(500000);
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: void test1()
sl@0: 	{
sl@0: 
sl@0: 	test.Start(_L("Create a thread (divideByZero)"));
sl@0: 	User::SetJustInTime(EFalse);
sl@0: 	RThread t;
sl@0: 	TRequestStatus s;
sl@0: 	TInt r;
sl@0: 	r=t.Create(_L("divideByZero"),divideByZero,KDefaultStackSize,KDefaultStackSize,KDefaultStackSize,NULL);
sl@0: 	test(r==KErrNone);
sl@0: 	t.Logon(s);
sl@0: 	test.Next(_L("Resume and wait for div by zero exception"));
sl@0: 	t.Resume();
sl@0: 	User::WaitForRequest(s);
sl@0: 	test.Printf(_L("Exit Type %d\r\n"),(TInt)t.ExitType());
sl@0: 	test(t.ExitType()==EExitPanic);
sl@0: 	test(t.ExitReason()==ECausedException);
sl@0: 	CLOSE_AND_WAIT(t);
sl@0: //
sl@0: 	
sl@0: 	test.Next(_L("Create a thread (raiseException)"));
sl@0: 	r=t.Create(_L("raiseException"),raiseException,KDefaultStackSize,KDefaultStackSize,KDefaultStackSize,NULL);
sl@0: 	test(r==KErrNone);
sl@0: 	t.Logon(s);
sl@0: 	test.Next(_L("Resume, and wait for raise exception"));
sl@0: 	t.Resume();
sl@0: 	User::WaitForRequest(s);
sl@0: 	test(t.ExitType()==EExitPanic);
sl@0: 	test(t.ExitReason()==ECausedException);
sl@0: 	CLOSE_AND_WAIT(t);
sl@0: 
sl@0: 	test.End();
sl@0: 	}
sl@0: 
sl@0: TInt divideByZero2(TAny *)
sl@0: 	{
sl@0: #ifdef __MARM__
sl@0: 	// There is no Div By Zero exception on the Arm so we use a data abort instead
sl@0: 	User::SetExceptionHandler(&excHandler, KExceptionAbort|KExceptionFault|KExceptionUserInterrupt);
sl@0: #else
sl@0: 	User::SetExceptionHandler(&excHandler, KExceptionInteger);
sl@0: #endif
sl@0: 	return divideByZero(0);
sl@0: 	}
sl@0: 
sl@0: TInt raiseException2(TAny *)
sl@0: 	{
sl@0: 	User::SetExceptionHandler(&excHandler, KExceptionInteger);
sl@0: 	return raiseException(0);
sl@0: 	}
sl@0: 
sl@0: void test2()
sl@0: 	{
sl@0: 
sl@0: 	test.Start(_L("Create a thread (odie)"));
sl@0: 	RThread t;
sl@0: 	TRequestStatus s;
sl@0: 	TInt r;
sl@0: 
sl@0: 	test.Next(_L("Create a thread (divideByZero)"));
sl@0: 	r=t.Create(_L("divideByZero"),divideByZero2,KDefaultStackSize,KDefaultStackSize,KDefaultStackSize,NULL);
sl@0: 	test(r==KErrNone);
sl@0: 	t.Logon(s);
sl@0: 	gCount=0;
sl@0: 
sl@0: 	test.Next(_L("Resume, and wait for 10 divide by zero exceptions"));
sl@0: 	t.Resume();
sl@0: 	while (gCount<10)
sl@0: 		User::After(500000);
sl@0: 	test(gCount>=10);
sl@0: 	test.Next(_L("Kill the thread"));
sl@0: 	t.Kill(666);
sl@0: 	User::WaitForRequest(s);
sl@0: 	test(t.ExitType()==EExitKill);
sl@0: 	test(t.ExitReason()==666);
sl@0: 	CLOSE_AND_WAIT(t);
sl@0: //
sl@0: 	test.Next(_L("Create a thread (raiseException2)"));
sl@0: 	r=t.Create(_L("raiseException2"),raiseException2,KDefaultStackSize,KDefaultStackSize,KDefaultStackSize,NULL);
sl@0: 	test(r==KErrNone);
sl@0: 	t.Logon(s);
sl@0: 	gCount=0;
sl@0: 	test.Next(_L("Resume"));
sl@0: 	t.Resume();
sl@0: 	test.Next(_L("Wait for thread to finish"));
sl@0: 	User::WaitForRequest(s);
sl@0: 	test.Next(_L("Test thread raised an exception on itself"));
sl@0: 	test(gCount==1);
sl@0: 	test(t.ExitType()==EExitKill);
sl@0: 	test(t.ExitReason()==KErrNone);
sl@0: 	CLOSE_AND_WAIT(t);
sl@0: 
sl@0: 	test.End();
sl@0: 	}
sl@0: 
sl@0: TInt divideByZero3(TAny *)
sl@0: 	{
sl@0: #ifdef __MARM__
sl@0: 	User::SetExceptionHandler(&excHandlerFault, KExceptionAbort|KExceptionFault|KExceptionUserInterrupt);
sl@0: #else
sl@0: 	User::SetExceptionHandler(&excHandlerFault, KExceptionInteger);
sl@0: #endif
sl@0: 	return divideByZero(0);
sl@0: 	}
sl@0: 
sl@0: void test3()
sl@0: 	{
sl@0: 	test.Start(_L("Create a thread (divideByZero3)"));
sl@0: 	RThread t;
sl@0: 	TRequestStatus s;
sl@0: 	TInt r;
sl@0: 	r=t.Create(_L("divideByZero3"),divideByZero3,KDefaultStackSize,KDefaultStackSize,KDefaultStackSize,NULL);
sl@0: 	test(r==KErrNone);
sl@0: 	t.Logon(s);
sl@0: 	gCount=0;
sl@0: 	test.Next(_L("Resume, and wait for thread to die"));
sl@0: 	t.Resume();
sl@0: 	User::WaitForRequest(s);
sl@0: 	test.Next(_L("Test thread raised one exception"));
sl@0: 	test(gCount==1);
sl@0: 	test.Next(_L("Test thread paniced on double exception"));
sl@0: 	test(t.ExitType()==EExitPanic);
sl@0: 	test(t.ExitReason()==ECausedException);
sl@0: 	CLOSE_AND_WAIT(t);
sl@0: //
sl@0: 	test.End();
sl@0: 	}
sl@0: 
sl@0: extern TInt dividebyzeroFn(TInt x)
sl@0: 	{
sl@0: 	volatile int i=x, j=10;
sl@0: 	volatile int l=j/i;
sl@0: 	for (i=0; i<l; i++)
sl@0: 		;
sl@0: 	return KErrNone;
sl@0: 	}
sl@0: 
sl@0: TInt dividebyzeroThread(TAny *)
sl@0: 	{
sl@0: 	return dividebyzeroFn(0);
sl@0: 	}
sl@0: 
sl@0: void testDivException()
sl@0: 	{
sl@0: 	RThread t;
sl@0: 	TRequestStatus s;
sl@0: 	test.Next(_L("Create divide by zero thread"));
sl@0: 	TInt r=t.Create(_L("drop dead"),dividebyzeroThread,KDefaultStackSize,KDefaultStackSize,KDefaultStackSize,NULL);
sl@0: 	test(r==KErrNone);
sl@0: 	t.Logon(s);
sl@0: 	test.Next(_L("Resume"));
sl@0: 	t.Resume();
sl@0: 	User::WaitForRequest(s);
sl@0: 	test.Next(_L("Test thread died because of EExcDivideByZero"));
sl@0: 	test(t.ExitType()==EExitPanic);
sl@0: 	test(t.ExitReason()==ECausedException);
sl@0: 	CLOSE_AND_WAIT(t);
sl@0: 	}
sl@0: 
sl@0: #ifndef __EPOC32__
sl@0: TInt ContextThread0(TAny *)
sl@0: 	{
sl@0: 	FOREVER;
sl@0: 	}
sl@0: #else
sl@0: TInt ContextThread0(TAny *);
sl@0: #endif
sl@0: 
sl@0: #ifndef __EPOC32__
sl@0: TInt ContextThread1(TAny *)
sl@0: 	{
sl@0: 	FOREVER;
sl@0: 	}
sl@0: #else
sl@0: TInt ContextThread1(TAny *);
sl@0: #endif
sl@0: 
sl@0: #ifndef __EPOC32__
sl@0: TInt ContextThread2(TAny *)
sl@0: 	{
sl@0: 	FOREVER;
sl@0: 	}
sl@0: #else
sl@0: TInt ContextThread2(TAny *);
sl@0: #endif
sl@0: 
sl@0: TUint32 RunContextThread(TThreadFunction aFunction, TUint32* aRegs)
sl@0: 	{
sl@0: #ifdef __EPOC32__
sl@0: 	TUint32 pc = (TUint32)aFunction((TAny*)0x80000000);
sl@0: #else
sl@0: 	TUint32 pc = 0;
sl@0: #endif
sl@0: 	RThread t;
sl@0: 	TRequestStatus s;
sl@0: 	TInt r=t.Create(_L("Context"),aFunction,KDefaultStackSize,NULL,NULL);
sl@0: 	test(r==KErrNone);
sl@0: 	t.Logon(s);
sl@0: 	t.Resume();
sl@0: 	User::After(100000);
sl@0: 
sl@0: 	TPtr8 buf((TUint8*)aRegs, 32*4, 32*4);
sl@0: 	TInt i;
sl@0: 	for (i=0; i<32; i++)
sl@0: 		aRegs[i]=0xbad00bad;
sl@0: 	t.Context(buf);
sl@0: 	if (buf.Length()==0)
sl@0: 		pc = 0;	// not supported
sl@0: 	t.Kill(KErrNone);
sl@0: 	User::WaitForRequest(s);
sl@0: 	CLOSE_AND_WAIT(t);
sl@0: 	return pc;
sl@0: 	}
sl@0: 
sl@0: struct SRegValues
sl@0: 	{
sl@0: 	TUint32		iValidMask;
sl@0: 	TUint32		iValues[32];
sl@0: 	};
sl@0: 
sl@0: const TInt KNumContextTests = 3;
sl@0: 
sl@0: static const TThreadFunction ContextTestFn[KNumContextTests] =
sl@0: 	{
sl@0: 	&ContextThread0,
sl@0: 	&ContextThread1,
sl@0: 	&ContextThread2
sl@0: 	};
sl@0: 
sl@0: #if defined(__CPU_ARM)
sl@0: const TInt KPCIndex = 15;
sl@0: static const SRegValues ExpectedRegs[KNumContextTests] =
sl@0: 	{
sl@0: 		{0x1ffff,
sl@0: 			{	0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0x00,
sl@0: 				0xa0000010, 0, 0, 0,	0, 0, 0, 0,		0, 0, 0, 0,		0, 0, 0, 0
sl@0: 			}
sl@0: 		},
sl@0: 		{0x0eff0,
sl@0: 			{	0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0x00,
sl@0: 				0xa0000010, 0, 0, 0,	0, 0, 0, 0,		0, 0, 0, 0,		0, 0, 0, 0
sl@0: 			}
sl@0: 		},
sl@0: 		{0x0eff0,
sl@0: 			{	0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99, 0xaa, 0xbb, 0xcc, 0xdd, 0xee, 0x00,
sl@0: 				0xa0000010, 0, 0, 0,	0, 0, 0, 0,		0, 0, 0, 0,		0, 0, 0, 0
sl@0: 			}
sl@0: 		}
sl@0: 	};
sl@0: 
sl@0: static const TUint32 KRegValidBitsMask[32] =
sl@0: 	{
sl@0: 		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu,		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu,
sl@0: 		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu,		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu,
sl@0: 		0xf00000ffu, 0xffffffffu, 0xffffffffu, 0xffffffffu,		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu,
sl@0: 		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu,		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu
sl@0: 	};
sl@0: 
sl@0: #elif defined(__CPU_X86)
sl@0: const TInt KPCIndex = 15;
sl@0: static const SRegValues ExpectedRegs[KNumContextTests] =
sl@0: 	{
sl@0: 		{0xe7ff,
sl@0: 			{	0xaaaaaaaa, 0xbbbbbbbb, 0xcccccccc, 0xdddddddd, 0xe50e50e5, 0xeb0eb0eb, 0xe51e51e5, 0xed1ed1ed,
sl@0: 				0x0000001b, 0x00000023, 0x00000023, 0x00000023, 0x00000023, 0x00000023, 0x00000cd5, 0x00000000,
sl@0: 				0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
sl@0: 				0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000
sl@0: 			}
sl@0: 		},
sl@0: 		{0xe7ff,
sl@0: 			{	0x00000000, 0xbbbbbbbb, 0xcccccccc, 0xdddddddd, 0xe50e50e5, 0xeb0eb0eb, 0xe51e51e5, 0xed1ed1ed,
sl@0: 				0x0000001b, 0x00000023, 0x00000023, 0x00000023, 0x00000023, 0x00000023, 0x00000cd5, 0x00000000,
sl@0: 				0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
sl@0: 				0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000
sl@0: 			}
sl@0: 		},
sl@0: 		{0xe7fa,	// EAX=exec number, ECX trashed by preprocess handler
sl@0: 			{	0xaaaaaaaa, 0xbbbbbbbb, 0xffff8001, 0xdddddddd, 0xe50e50e5, 0xeb0eb0eb, 0xe51e51e5, 0xed1ed1ed,
sl@0: 				0x0000001b, 0x00000023, 0x00000023, 0x00000023, 0x00000023, 0x00000023, 0x00000cd5, 0x00000000,
sl@0: 				0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000,
sl@0: 				0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000, 0x00000000
sl@0: 			}
sl@0: 		}
sl@0: 	};
sl@0: 
sl@0: static const TUint32 KRegValidBitsMask[32] =
sl@0: 	{
sl@0: 		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu,		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu,
sl@0: 		0x0000ffffu, 0x0000ffffu, 0x0000ffffu, 0x0000ffffu,		0x0000ffffu, 0x0000ffffu, 0x00000cd5u, 0xffffffffu,
sl@0: 		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu,		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu,
sl@0: 		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu,		0xffffffffu, 0xffffffffu, 0xffffffffu, 0xffffffffu
sl@0: 	};
sl@0: 
sl@0: #endif
sl@0: 
sl@0: void CheckContextValues(TUint32* aRegs, const SRegValues& aExpected, TUint32 aPC)
sl@0: 	{
sl@0: 	test.Printf(_L("PC=%08x Context returned:\n"), aPC);
sl@0: 	TInt i;
sl@0: 	const TUint32* s = aRegs;
sl@0: 	for (i=0; i<8; ++i, s+=4)
sl@0: 		test.Printf(_L("%08x %08x %08x %08x\n"), s[0], s[1], s[2], s[3]);
sl@0: 	TUint32 v = aExpected.iValidMask;
sl@0: 	TBool ok = ETrue;
sl@0: 	for (i=0; i<32; ++i, v>>=1)
sl@0: 		{
sl@0: 		if (!(v&1))
sl@0: 			continue;
sl@0: 		TUint32 mask = KRegValidBitsMask[i];
sl@0: 		TUint32 actual = aRegs[i] & mask;
sl@0: 		TUint32 exp = (i == KPCIndex) ? aPC&mask : aExpected.iValues[i];
sl@0: 		if (actual != exp)
sl@0: 			{
sl@0: 			test.Printf(_L("%d: Expected %08x but got %08x\n"), i, exp, actual);
sl@0: 			ok = EFalse;
sl@0: 			}
sl@0: 		}
sl@0: 	test(ok);
sl@0: 	}
sl@0: 
sl@0: void testContext()
sl@0: 	{
sl@0: 
sl@0: 	TUint32 regs[32];
sl@0: 
sl@0: 	test.Next(_L("Get context of interrupted thread"));
sl@0: 	TInt tn;
sl@0: 	for (tn=0; tn<KNumContextTests; ++tn)
sl@0: 		{
sl@0: 		test.Printf(_L("Context test %d\n"), tn);
sl@0: 		TUint32 pc = RunContextThread(ContextTestFn[tn], regs);
sl@0: 		if (pc)
sl@0: 			{
sl@0: 			CheckContextValues(regs, ExpectedRegs[tn], pc);
sl@0: 			}
sl@0: 		}
sl@0: 	}
sl@0: 
sl@0: GLDEF_C TInt E32Main()
sl@0: //
sl@0: // __KHEAP_SETFAIL etc. not available in release mode, so don't test
sl@0: //
sl@0: 	{
sl@0: 
sl@0: 	test.Title();
sl@0: 	test.Start(_L("Create a semaphore"));
sl@0: 	TInt r=gSem.CreateGlobal(_L("A SEMAPHORE"),0);
sl@0: 	test(r==KErrNone);
sl@0: 	test.Next(_L("Test exceptions with no handlers"));
sl@0: 	test1();
sl@0: 	test.Next(_L("Test exceptions with handlers"));
sl@0: 	test2();
sl@0: 	test.Next(_L("Test exception raised in exception handler"));
sl@0: 	test3();
sl@0: 	test.Next(_L("Divide by zero exception"));
sl@0: 	testDivException();
sl@0: 	test.Next(_L("Test Context"));
sl@0: 	testContext();
sl@0: 	test.End();
sl@0: 	return(KErrNone);
sl@0: 	}