MCL/sf/os/kernelhwsrv: kerneltest/e32test/mmu/freeram.h@c1f20ce4abcf (annotated)

0 a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	1	// Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	2	// All rights reserved.
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	3	// This component and the accompanying materials are made available
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	4	// under the terms of the License "Eclipse Public License v1.0"
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	5	// which accompanies this distribution, and is available
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	6	// at the URL "http://www.eclipse.org/legal/epl-v10.html".
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	7	//
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	8	// Initial Contributors:
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	9	// Nokia Corporation - initial contribution.
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	10	//
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	11	// Contributors:
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	12	//
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	13	// Description:
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	14	// e32test\mmu\freeram.h
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	15	//
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	16	//
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	17
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	18	#ifndef __FREERAM_H__
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	19	#define __FREERAM_H__
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	20
43 c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	21	/**
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	22	Get the amount of free RAM in the system in bytes.
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	23
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	24	This calls the kernel HAL supervisor barrier to ensure that asynchronous cleanup in the supervisor
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	25	happens before the amount of free RAM is measured.
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	26
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	27	There is also the option to wait for upto a specified timeout for the system to become idle.
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	28
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	29	@param aIdleTimeoutMs If non-zero, the number of milliseconds to wait for the system to become idle.
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	30
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	31	@return On sucess returns the amount of free RAM in bytes, KErrTimedOut if the timeout expired
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	32	without the system becoming idle, or one of the other system-wide error codes.
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	33	*/
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	34	TInt FreeRam(TInt aIdleTimeoutMs = 0)
0 a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	35	{
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	36	// wait for any async cleanup in the supervisor to finish first...
43 c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	37	TInt r = UserSvr::HalFunction(EHalGroupKernel, EKernelHalSupervisorBarrier,
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	38	(TAny*)aIdleTimeoutMs, 0);
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	39	if (r != KErrNone)
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	40	return r;
0 a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	41
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	42	TMemoryInfoV1Buf meminfo;
43 c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	43	r = UserHal::MemoryInfo(meminfo);
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	44	if (r != KErrNone)
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	45	return r;
c1f20ce4abcf Revision: 201035 Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com> parents: 0 diff changeset	46
0 a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	47	return meminfo().iFreeRamInBytes;
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	48	}
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	49
a41df078684a Convert Kernelhwsrv package from SFL to EPL John Imhofe parents: diff changeset	50	#endif

author	Dremov Kirill (Nokia-D-MSW/Tampere) <kirill.dremov@nokia.com>
	Tue, 31 Aug 2010 16:34:26 +0300
branch	RCL_3
changeset 43	c1f20ce4abcf
parent 0	a41df078684a
child 44	3e88ff8f41d5
permissions	-rw-r--r--