memspy/Driver/Kernel/Source/SubChannels/MemSpyDriverLogChanHeapData.cpp
changeset 0 a03f92240627
child 20 ca8a1b6995f6
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/memspy/Driver/Kernel/Source/SubChannels/MemSpyDriverLogChanHeapData.cpp	Tue Feb 02 01:57:15 2010 +0200
@@ -0,0 +1,450 @@
+/*
+* 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 "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:
+*
+*/
+
+#include "MemSpyDriverLogChanHeapData.h"
+
+// System includes
+#include <u32hal.h>
+#include <e32rom.h>
+#include <memspy/driver/memspydriverobjectsshared.h>
+#include <memspy/driver/memspydriverconstants.h>
+
+// Shared includes
+#include "MemSpyDriverOpCodes.h"
+#include "MemSpyDriverObjectsInternal.h"
+
+// User includes
+#include "MemSpyDriverHeap.h"
+#include "MemSpyDriverUtils.h"
+#include "MemSpyDriverDevice.h"
+#include "MemSpyDriverOSAdaption.h"
+#include "MemSpyDriverHeapWalker.h"
+#include "MemSpyDriverUserEventMonitor.h"
+#include "MemSpyDriverSuspensionManager.h"
+
+
+
+
+DMemSpyDriverLogChanHeapData::DMemSpyDriverLogChanHeapData( DMemSpyDriverDevice& aDevice, DThread& aThread )
+:	DMemSpyDriverLogChanHeapBase( aDevice, aThread ), iKernelHeap( aDevice.OSAdaption() )
+    {
+    TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::DMemSpyDriverLogChanHeapData() - this: 0x%08x", this ));
+    }
+
+
+DMemSpyDriverLogChanHeapData::~DMemSpyDriverLogChanHeapData()
+	{
+	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::~DMemSpyDriverLogChanHeapData() - START - this: 0x%08x", this ));
+
+	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::~DMemSpyDriverLogChanHeapData() - END - this: 0x%08x", this ));
+	}
+
+
+
+
+
+
+
+TInt DMemSpyDriverLogChanHeapData::Request( TInt aFunction, TAny* a1, TAny* a2 )
+	{
+	TInt r = DMemSpyDriverLogChanHeapBase::Request( aFunction, a1, a2 );
+    if  ( r == KErrNone )
+        {
+	    switch( aFunction )
+		    {
+        case EMemSpyDriverOpCodeHeapDataGetUser:
+            r = GetHeapDataUser( (TMemSpyDriverInternalHeapDataParams*) a1 );
+            break;
+        case EMemSpyDriverOpCodeHeapDataGetKernelInit:
+            r = GetHeapDataKernelInit( (TMemSpyHeapInfo*) a1, (TDes8*) a2 );
+            break;
+        case EMemSpyDriverOpCodeHeapDataGetKernelFetch:
+            r = GetHeapDataKernelFetch( (TDes8*) a1 );
+            break;
+
+        default:
+            r = KErrNotSupported;
+		    break;
+		    }
+        }
+    //
+    return r;
+	}
+
+
+TBool DMemSpyDriverLogChanHeapData::IsHandler( TInt aFunction ) const
+    {
+    return ( aFunction > EMemSpyDriverOpCodeHeapDataBase && aFunction < EMemSpyDriverOpCodeHeapDataEnd );
+    }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+TInt DMemSpyDriverLogChanHeapData::GetHeapDataUser( TMemSpyDriverInternalHeapDataParams* aParams )
+    {
+    TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser() - START"));
+
+	TMemSpyDriverInternalHeapDataParams params;
+    TInt r = Kern::ThreadRawRead( &ClientThread(), aParams, &params, sizeof(TMemSpyDriverInternalHeapDataParams) );
+    //
+    if  ( r == KErrNone )
+        {
+	    TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - thread id: %d, remaining: %8d, vtable: 0x%08x", params.iTid, params.iRemaining, params.iRHeapVTable));
+
+        // Work out if we need to read the user or kernel heap data. 
+        //
+        // NB: The two 'get heap data' functions return either an error ( < KErrNone ) or then
+        // return the length of the descriptor data that was written to the client's address
+        // space.
+        //
+        r = GetHeapDataUser( params );
+
+        // Write back to user space if everything went okay. Remember that the 
+        // return value above will be the length of data that was written to the
+        // client if there was no error.
+        if  ( r >= KErrNone )
+            {
+            const TInt clientDescriptorLength = r;
+
+            // Make sure we update client's remaining data
+            r = Kern::ThreadRawWrite( &ClientThread(), aParams, &params, sizeof(TMemSpyDriverInternalHeapDataParams) );
+            
+            // ... and if that went okay, then we return the length of the descriptor data
+            // back to the client.
+            if  ( r == KErrNone )
+                {
+                r = clientDescriptorLength;
+                }
+            }
+        }
+    else
+        {
+    	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - params read error: %d", r));
+        }
+
+    // Done
+    TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser() - END - ret: %d", r));
+    return r;
+    }
+
+
+TInt DMemSpyDriverLogChanHeapData::GetHeapDataKernelInit( TMemSpyHeapInfo* aInfo, TDes8* aFreeCells )
+    {
+    // First phase is to 
+    //
+    // a) Open kernel heap
+    // b) Make a copy of the heap data
+    // c) Walk copy in order to extract statistics (meta data, i.e. TMemSpyHeapInfo)
+    //
+    // The driver leaves kernel context with the copy of the kernel heap still associated with MemSpy's process.
+    // The second driver call will copy the chunk data to user side and release the kernel side chunk.
+    const TBool isInit = iKernelHeap.ChunkIsInitialised();
+    TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelInit() - START - isInit: %d", isInit ));
+    __ASSERT_ALWAYS( !isInit, MemSpyDriverUtils::PanicThread( ClientThread(), EPanicKernelHeapDataInitError ) );
+
+    iKernelHeap.Reset();
+    NKern::ThreadEnterCS();
+
+    // We must identify if we have a debug kernel allocator
+    const TBool debugAllocator = IsDebugKernel();
+    TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelInit() - debugAllocator: %d", debugAllocator ) );
+
+    TFullName heapChunkName;
+    TInt r = OpenKernelHeap( iKernelHeap, &heapChunkName );
+    TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelInit() - open err: %d", r));
+
+    if  ( r == KErrNone )
+        {
+        r = GetHeapInfoKernel( iKernelHeap, debugAllocator, heapChunkName, aInfo, aFreeCells );
+        TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoKernel() - base class get heap info: %d", r) );
+
+        // If everything was okay, we can now return back to user-side, indicating the amount of heap data
+        // that they must prepare to read (in the next operation).
+        if  ( r == KErrNone )
+            {
+            // Indicate how big a buffer the user-side must prepare.
+            r = OSAdaption().DChunk().GetSize( iKernelHeap.Chunk() );
+            TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoKernel() - user side buffer needs to be: %d", r) );
+            }
+        else if ( iKernelHeap.ChunkIsInitialised() )
+            {
+            // Error scenario - must close heap
+            iKernelHeap.DisassociateWithKernelChunk();
+            }
+        }
+
+    NKern::ThreadLeaveCS();
+
+    TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelInit() - END - ret: %d", r));
+    return r;
+    }
+
+
+TInt DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch( TDes8* aSink )
+    {
+    TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch() - START"));
+
+    NKern::ThreadEnterCS();
+
+    // We should already have an initialised copy of the kernel heap
+    const TBool isInit = iKernelHeap.ChunkIsInitialised();
+    TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch() - isInit: %d", isInit ));
+    __ASSERT_ALWAYS( isInit, MemSpyDriverUtils::PanicThread( ClientThread(), EPanicKernelHeapDataFetchError ) );
+
+    // Get user side (MemSpy) descriptor length info
+    TInt destLen;
+    TInt destMax;
+    TUint8* destPtr = NULL;
+    TInt r = Kern::ThreadGetDesInfo( &ClientThread(), aSink, destLen, destMax, destPtr, ETrue );
+    TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - user side descriptor: 0x%08x (0x%08x), len: %8d, maxLen: %8d, r: %d", aSink, destPtr, destLen, destMax, r ));
+
+    if  ( r == KErrNone )
+        {
+        // Calculate start of real heap data (skipping over embedded RHeap object)
+        const TUint8* startOfHeapOffset = iKernelHeap.Base();
+        TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - startOfHeapOffset:    0x%08x", startOfHeapOffset));
+        const TUint heapSize = iKernelHeap.Size();
+        TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - heapSize:               %8d", heapSize));
+
+        if ( destMax >= heapSize )
+            {
+            }
+        else
+            {
+            // Not enough space
+            r = KErrOverflow;
+            TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - not enough space in client descriptor" ));
+            }
+
+        // The remaining number of bytes should allow us to calculate the position
+        // to read from.
+        const TInt amountToRead = Min( heapSize, destMax );
+        const TAny* readAddress = startOfHeapOffset;
+        TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - amountToRead:         %d", amountToRead));
+        TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - readAddress:          0x%08x", readAddress));
+        const TPtrC8 pKernelHeapData( (const TUint8*) readAddress, amountToRead );
+
+        // Copy kernel heap data to MemSpy
+        TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - about to do write to user-space..."));
+        r = Kern::ThreadDesWrite( &ClientThread(), aSink, pKernelHeapData, 0, KChunkShiftBy0 | KTruncateToMaxLength, &ClientThread() );
+        TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - write result: %d", r));
+        }
+
+    // Free heap resource
+    iKernelHeap.DisassociateWithKernelChunk();
+
+    NKern::ThreadLeaveCS();
+
+	TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch() - END - ret: %d", r));
+    return r;
+    }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+TInt DMemSpyDriverLogChanHeapData::GetHeapDataUser( TMemSpyDriverInternalHeapDataParams& aParams )
+    {
+    TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser() - START") );
+
+	TInt r = OpenTempObject( aParams.iTid, EThread );
+	if  ( r != KErrNone )
+		{
+    	Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser() - END - thread not found");
+		return r;
+		}
+    else 
+        {
+        const DMemSpyDriverLogChanHeapBase::TDrmMatchType drmMatchType = IsDrmThread( TempObjectAsThread() );
+
+        if  ( drmMatchType != DMemSpyDriverLogChanHeapBase::EMatchTypeNone )
+            {
+            // Check whether it's a DRM thread...
+            DThread* thread = (DThread*) TempObject();
+    	    Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser() - END - Not allowing dump of DRM heap - matchType: %d, thread: %O", drmMatchType, thread );
+            CloseTempObject();
+		    return KErrAccessDenied;
+            }
+        }
+    
+    // Check that the process' thread's are suspended
+    DThread* thread = (DThread*) TempObject();
+    if  ( SuspensionManager().IsSuspended( *thread ) )
+        {
+        // Find the chunk with the correct handle
+	    TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - thread: %O", thread) );
+        RMemSpyDriverRHeapUser heap( OSAdaption() );
+        const TBool allocatorIsReallyRHeap = GetUserHeapHandle( *thread, heap, aParams.iRHeapVTable );
+        if  ( allocatorIsReallyRHeap )
+            {
+            const TInt chunkHandle = heap.iChunkHandle;
+	        TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - chunkHandle: 0x%08x, thread: %O", chunkHandle, thread) );
+
+  	        NKern::ThreadEnterCS();
+ 	        NKern::LockSystem();
+            DChunk* chunk = (DChunk*) Kern::ObjectFromHandle( thread, chunkHandle, EChunk );
+            NKern::UnlockSystem();
+	        TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - chunk: 0x%08x", chunk ) );
+  	        NKern::ThreadLeaveCS();
+
+            if  ( chunk != NULL )
+                {
+                TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - chunkBase: 0x%08x, size: %8d, maxLen: %8d, chunk: %O", chunk->iBase, chunk->iSize, chunk->iMaxSize, chunk) );
+
+                // If the client specified a checksum value, then we must walk the heap just to make sure
+                // it hasn't changed. Expensive operation, but good for paranoia purposes...
+                if  ( aParams.iChecksum != 0 )
+                    {
+                    TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - checksum validation requested - expecting: 0x%08x", aParams.iChecksum ) );
+
+                    RMemSpyDriverRHeapUser rHeap( OSAdaption() );
+                    DChunk* userHeapChunk = NULL;
+                    r = OpenUserHeap( *thread, aParams.iRHeapVTable, rHeap, userHeapChunk );
+                    TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - opening client heap returned: %d", r) );
+                    if  ( r == KErrNone )
+                        {
+                        TMemSpyHeapWalkerNullObserver observer; 
+                        RMemSpyDriverHeapWalker heapWalker( rHeap, aParams.iDebugAllocator );
+                        heapWalker.SetObserver( &observer );
+                        
+                        TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - starting traversal..." ));
+#if ( defined( TRACE_TYPE_USERHEAP ) && defined( TRACE_TYPE_HEAPWALK ) )
+                        heapWalker.SetPrintDebug();
+#endif
+                        r = heapWalker.Traverse();
+                        const TUint32 calculatedChecksum = heapWalker.Stats().iFreeCellCRC;
+                        TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - finished traversal - err: %d, checksum: 0x%08x", r, calculatedChecksum ));
+
+                        // Release resources
+                        rHeap.DisassociateWithKernelChunk();
+
+                        TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - comparing CALCULATED: 0x%08x vs EXPECTED: 0x%08x", calculatedChecksum, aParams.iChecksum ));
+                        if  ( calculatedChecksum != aParams.iChecksum )
+                            {
+                            Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - comparing CALCULATED: 0x%08x vs EXPECTED: 0x%08x for thread %O", calculatedChecksum, aParams.iChecksum, thread );
+                            r = KErrCorrupt;
+                            }
+                        }
+                    else
+                        {
+                        // Couldn't verify checksum in this situation...
+                        }
+                    }
+
+                // Get user side (MemSpy) descriptor length info
+                if  ( r == KErrNone )
+                    {
+                    TInt destLen;
+                    TInt destMax;
+                    TUint8* destPtr = NULL;
+                    r = Kern::ThreadGetDesInfo( &ClientThread(), aParams.iDes, destLen, destMax, destPtr, ETrue );
+                    TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - user side descriptor: 0x%08x (0x%08x), len: %8d, maxLen: %8d, r: %d", aParams.iDes, destPtr, destLen, destMax, r ));
+
+                    if  ( r == KErrNone )
+                        {
+                        // Calculate start of real heap data (skipping over embedded RHeap object)
+                        const TUint8* startOfHeapOffset = heap.iBase;
+        	            TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - startOfHeapOffset:    0x%08x", startOfHeapOffset) );
+            
+                        // Deal with initial case
+                        const TUint heapSize = heap.Size();
+        	            TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - heapSize:               %8d", heapSize) );
+                        if  ( aParams.iRemaining < 0 )
+                            {
+                            // Initial case, remaining initialised to -1
+                            aParams.iRemaining = heapSize;
+                            }
+
+                        // The remaining number of bytes should allow us to calculate the position
+                        // to read from.
+                        const TInt amountToRead = Min( aParams.iRemaining, destMax );
+        	            TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - amountToRead:           %8d", amountToRead) );
+                        const TInt readOffset = ( heapSize - aParams.iRemaining );
+        	            TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - readOffset:             %8d", readOffset) );
+                        const TAny* readAddress = startOfHeapOffset + readOffset;
+        	            TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - readAddress:          0x%08x", readAddress) );
+            
+                        // Do the read from the heap we are spying on into MemSpy's address space
+                        r = Kern::ThreadRawRead( thread, readAddress, destPtr, amountToRead );
+        	            TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - read result: %d", r) );
+                        //
+                        if  (r == KErrNone)
+                            {
+                            // Client takes care of updating descriptor length.
+                            r = amountToRead;
+                            }
+                        else if ( r == KErrBadDescriptor )
+                            {
+                            MemSpyDriverUtils::PanicThread( ClientThread(), EPanicBadDescriptor );
+                            }
+            
+                        // Update remaining bytes
+                        aParams.iRemaining -= amountToRead;
+                        aParams.iReadAddress = (TUint) readAddress;
+                        }
+                    }
+                }
+            else
+                {
+    	        Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - chunk not found! thread: %O", thread );
+                r = KErrNotFound;
+                }
+            }
+        else
+            {
+    	    Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - couldnt find heap - vtable mis-match? thread: %O", thread );
+            r = KErrNotSupported;
+            }
+        }
+    else
+        {
+        Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - parent process not suspended => KErrAccessDenied - thread: %O", thread );
+        r = KErrAccessDenied;
+        }
+
+	CloseTempObject();
+
+	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser() - END - ret: %d", r) );
+    return r;
+    }
+
+
+