perfsrv/memspy/Driver/Kernel/Source/SubChannels/MemSpyDriverLogChanHeapData.cpp
changeset 55 f2950aff7424
parent 48 516af714ebb4
equal deleted inserted replaced
48:516af714ebb4 55:f2950aff7424
     1 /*
       
     2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:
       
    15 *
       
    16 */
       
    17 
       
    18 #include "MemSpyDriverLogChanHeapData.h"
       
    19 
       
    20 // System includes
       
    21 #include <u32hal.h>
       
    22 #include <e32rom.h>
       
    23 #include <memspy/driver/memspydriverobjectsshared.h>
       
    24 #include <memspy/driver/memspydriverconstants.h>
       
    25 
       
    26 // Shared includes
       
    27 #include "MemSpyDriverOpCodes.h"
       
    28 #include "MemSpyDriverObjectsInternal.h"
       
    29 
       
    30 // User includes
       
    31 #include "MemSpyDriverHeap.h"
       
    32 #include "MemSpyDriverUtils.h"
       
    33 #include "MemSpyDriverDevice.h"
       
    34 #include "MemSpyDriverOSAdaption.h"
       
    35 #include "MemSpyDriverHeapWalker.h"
       
    36 #include "MemSpyDriverUserEventMonitor.h"
       
    37 #include "MemSpyDriverSuspensionManager.h"
       
    38 
       
    39 
       
    40 
       
    41 
       
    42 DMemSpyDriverLogChanHeapData::DMemSpyDriverLogChanHeapData( DMemSpyDriverDevice& aDevice, DThread& aThread )
       
    43 :	DMemSpyDriverLogChanHeapBase( aDevice, aThread ), iKernelHeap( aDevice.OSAdaption() )
       
    44     {
       
    45     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::DMemSpyDriverLogChanHeapData() - this: 0x%08x", this ));
       
    46     }
       
    47 
       
    48 
       
    49 DMemSpyDriverLogChanHeapData::~DMemSpyDriverLogChanHeapData()
       
    50 	{
       
    51 	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::~DMemSpyDriverLogChanHeapData() - START - this: 0x%08x", this ));
       
    52 
       
    53 	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::~DMemSpyDriverLogChanHeapData() - END - this: 0x%08x", this ));
       
    54 	}
       
    55 
       
    56 
       
    57 
       
    58 
       
    59 
       
    60 
       
    61 
       
    62 TInt DMemSpyDriverLogChanHeapData::Request( TInt aFunction, TAny* a1, TAny* a2 )
       
    63 	{
       
    64 	TInt r = DMemSpyDriverLogChanHeapBase::Request( aFunction, a1, a2 );
       
    65     if  ( r == KErrNone )
       
    66         {
       
    67 	    switch( aFunction )
       
    68 		    {
       
    69         case EMemSpyDriverOpCodeHeapDataGetUser:
       
    70             r = GetHeapDataUser( (TMemSpyDriverInternalHeapDataParams*) a1 );
       
    71             break;
       
    72         case EMemSpyDriverOpCodeHeapDataGetKernelInit:
       
    73             r = GetHeapDataKernelInit( (TMemSpyHeapInfo*) a1, (TDes8*) a2 );
       
    74             break;
       
    75         case EMemSpyDriverOpCodeHeapDataGetKernelFetch:
       
    76             r = GetHeapDataKernelFetch( (TDes8*) a1 );
       
    77             break;
       
    78 
       
    79         default:
       
    80             r = KErrNotSupported;
       
    81 		    break;
       
    82 		    }
       
    83         }
       
    84     //
       
    85     return r;
       
    86 	}
       
    87 
       
    88 
       
    89 TBool DMemSpyDriverLogChanHeapData::IsHandler( TInt aFunction ) const
       
    90     {
       
    91     return ( aFunction > EMemSpyDriverOpCodeHeapDataBase && aFunction < EMemSpyDriverOpCodeHeapDataEnd );
       
    92     }
       
    93 
       
    94 
       
    95 
       
    96 
       
    97 
       
    98 
       
    99 
       
   100 
       
   101 
       
   102 
       
   103 
       
   104 
       
   105 
       
   106 
       
   107 TInt DMemSpyDriverLogChanHeapData::GetHeapDataUser( TMemSpyDriverInternalHeapDataParams* aParams )
       
   108     {
       
   109     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser() - START"));
       
   110 
       
   111 	TMemSpyDriverInternalHeapDataParams params;
       
   112     TInt r = Kern::ThreadRawRead( &ClientThread(), aParams, &params, sizeof(TMemSpyDriverInternalHeapDataParams) );
       
   113     //
       
   114     if  ( r == KErrNone )
       
   115         {
       
   116 	    TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - thread id: %d, remaining: %8d, vtable: 0x%08x", params.iTid, params.iRemaining, params.iRHeapVTable));
       
   117 
       
   118         // Work out if we need to read the user or kernel heap data. 
       
   119         //
       
   120         // NB: The two 'get heap data' functions return either an error ( < KErrNone ) or then
       
   121         // return the length of the descriptor data that was written to the client's address
       
   122         // space.
       
   123         //
       
   124         r = GetHeapDataUser( params );
       
   125 
       
   126         // Write back to user space if everything went okay. Remember that the 
       
   127         // return value above will be the length of data that was written to the
       
   128         // client if there was no error.
       
   129         if  ( r >= KErrNone )
       
   130             {
       
   131             const TInt clientDescriptorLength = r;
       
   132 
       
   133             // Make sure we update client's remaining data
       
   134             r = Kern::ThreadRawWrite( &ClientThread(), aParams, &params, sizeof(TMemSpyDriverInternalHeapDataParams) );
       
   135             
       
   136             // ... and if that went okay, then we return the length of the descriptor data
       
   137             // back to the client.
       
   138             if  ( r == KErrNone )
       
   139                 {
       
   140                 r = clientDescriptorLength;
       
   141                 }
       
   142             }
       
   143         }
       
   144     else
       
   145         {
       
   146     	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - params read error: %d", r));
       
   147         }
       
   148 
       
   149     // Done
       
   150     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser() - END - ret: %d", r));
       
   151     return r;
       
   152     }
       
   153 
       
   154 
       
   155 TInt DMemSpyDriverLogChanHeapData::GetHeapDataKernelInit( TMemSpyHeapInfo* aInfo, TDes8* aFreeCells )
       
   156     {
       
   157     // First phase is to 
       
   158     //
       
   159     // a) Open kernel heap
       
   160     // b) Make a copy of the heap data
       
   161     // c) Walk copy in order to extract statistics (meta data, i.e. TMemSpyHeapInfo)
       
   162     //
       
   163     // The driver leaves kernel context with the copy of the kernel heap still associated with MemSpy's process.
       
   164     // The second driver call will copy the chunk data to user side and release the kernel side chunk.
       
   165     //const TBool isInit = iKernelHeap.ChunkIsInitialised();
       
   166     //TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelInit() - START - isInit: %d", isInit ));
       
   167     //__ASSERT_ALWAYS( !isInit, MemSpyDriverUtils::PanicThread( ClientThread(), EPanicKernelHeapDataInitError ) );
       
   168 
       
   169     iKernelHeap.Reset();
       
   170     NKern::ThreadEnterCS();
       
   171 
       
   172     TFullName heapChunkName;
       
   173     TInt r = OpenKernelHeap( iKernelHeap, &heapChunkName );
       
   174     TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelInit() - open err: %d", r));
       
   175 
       
   176     if  ( r == KErrNone )
       
   177         {
       
   178         r = GetHeapInfoKernel( iKernelHeap, aInfo, aFreeCells );
       
   179         TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapDataKernelInit() - base class get heap info: %d", r) );
       
   180 
       
   181         // If everything was okay, we can now return back to user-side, indicating the amount of heap data
       
   182         // that they must prepare to read (in the next operation).
       
   183         if  ( r == KErrNone )
       
   184             {
       
   185             // Indicate how big a buffer the user-side must prepare.
       
   186             r = OSAdaption().DChunk().GetSize( iKernelHeap.Chunk() );
       
   187             TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapDataKernelInit() - user side buffer needs to be: %d", r) );
       
   188             }
       
   189         else
       
   190             {
       
   191             // Error scenario - must close heap
       
   192             iKernelHeap.Close();
       
   193             }
       
   194         }
       
   195 
       
   196     NKern::ThreadLeaveCS();
       
   197 
       
   198     TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelInit() - END - ret: %d", r));
       
   199     return r;
       
   200     }
       
   201 
       
   202 
       
   203 TInt DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch( TDes8* aSink )
       
   204     {
       
   205 	//TOMSCI TODO this function is fundamentally flawed
       
   206 	return KErrNotSupported;
       
   207 	/*
       
   208     TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch() - START"));
       
   209 
       
   210     NKern::ThreadEnterCS();
       
   211 
       
   212     // We should already have an initialised copy of the kernel heap
       
   213     const TBool isInit = iKernelHeap.Helper() != NULL;
       
   214     TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch() - isInit: %d", isInit ));
       
   215     __ASSERT_ALWAYS( isInit, MemSpyDriverUtils::PanicThread( ClientThread(), EPanicKernelHeapDataFetchError ) );
       
   216 
       
   217     // Get user side (MemSpy) descriptor length info
       
   218     TInt destLen;
       
   219     TInt destMax;
       
   220     TUint8* destPtr = NULL;
       
   221     TInt r = Kern::ThreadGetDesInfo( &ClientThread(), aSink, destLen, destMax, destPtr, ETrue );
       
   222     TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - user side descriptor: 0x%08x (0x%08x), len: %8d, maxLen: %8d, r: %d", aSink, destPtr, destLen, destMax, r ));
       
   223 
       
   224     if  ( r == KErrNone )
       
   225         {
       
   226         // Calculate start of real heap data (skipping over embedded RHeap object)
       
   227         const TUint8* startOfHeapOffset = iKernelHeap.Base();
       
   228         TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - startOfHeapOffset:    0x%08x", startOfHeapOffset));
       
   229         const TUint heapSize = iKernelHeap.Size();
       
   230         TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - heapSize:               %8d", heapSize));
       
   231 
       
   232         if ( destMax >= heapSize )
       
   233             {
       
   234             }
       
   235         else
       
   236             {
       
   237             // Not enough space
       
   238             r = KErrOverflow;
       
   239             TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - not enough space in client descriptor" ));
       
   240             }
       
   241 
       
   242         // The remaining number of bytes should allow us to calculate the position
       
   243         // to read from.
       
   244         const TInt amountToRead = Min( heapSize, destMax );
       
   245         const TAny* readAddress = startOfHeapOffset;
       
   246         TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - amountToRead:         %d", amountToRead));
       
   247         TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - readAddress:          0x%08x", readAddress));
       
   248         const TPtrC8 pKernelHeapData( (const TUint8*) readAddress, amountToRead );
       
   249 
       
   250         // Copy kernel heap data to MemSpy
       
   251         TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - about to do write to user-space..."));
       
   252         r = Kern::ThreadDesWrite( &ClientThread(), aSink, pKernelHeapData, 0, KChunkShiftBy0 | KTruncateToMaxLength, &ClientThread() );
       
   253         TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch - write result: %d", r));
       
   254         }
       
   255 
       
   256     // Free heap resource
       
   257     iKernelHeap.DisassociateWithKernelChunk();
       
   258 
       
   259     NKern::ThreadLeaveCS();
       
   260 
       
   261 	TRACE_KH( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataKernelFetch() - END - ret: %d", r));
       
   262     return r;
       
   263 	*/
       
   264     }
       
   265 
       
   266 
       
   267 
       
   268 
       
   269 
       
   270 
       
   271 
       
   272 
       
   273 
       
   274 
       
   275 
       
   276 
       
   277 
       
   278 
       
   279 
       
   280 
       
   281 
       
   282 const TInt KPageSize = 4096;
       
   283 
       
   284 TInt DMemSpyDriverLogChanHeapData::GetHeapDataUser( TMemSpyDriverInternalHeapDataParams& aParams )
       
   285     {
       
   286     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser() - START") );
       
   287 
       
   288 	TInt r = OpenTempObject( aParams.iTid, EThread );
       
   289 	if  ( r != KErrNone )
       
   290 		{
       
   291     	Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser() - END - thread not found");
       
   292 		return r;
       
   293 		}
       
   294     else 
       
   295         {
       
   296         const DMemSpyDriverLogChanHeapBase::TDrmMatchType drmMatchType = IsDrmThread( TempObjectAsThread() );
       
   297 
       
   298         if  ( drmMatchType != DMemSpyDriverLogChanHeapBase::EMatchTypeNone )
       
   299             {
       
   300             // Check whether it's a DRM thread...
       
   301             DThread* thread = (DThread*) TempObject();
       
   302     	    Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser() - END - Not allowing dump of DRM heap - matchType: %d, thread: %O", drmMatchType, thread );
       
   303             CloseTempObject();
       
   304 		    return KErrAccessDenied;
       
   305             }
       
   306         }
       
   307 
       
   308     // Check that the process' thread's are suspended
       
   309     DThread* thread = (DThread*) TempObject();
       
   310     if  ( SuspensionManager().IsSuspended( *thread ) )
       
   311         {
       
   312         // Open the heap
       
   313 	    TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - thread: %O", thread) );
       
   314         RMemSpyDriverRHeapUser heap( OSAdaption() );
       
   315 		r = heap.OpenUserHeap(*thread, aParams.iDebugAllocator);
       
   316 		TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - opening heap returned: %d", r) );
       
   317         if  (r == KErrNone)
       
   318             {
       
   319             if  ( aParams.iChecksum != 0 )
       
   320                 {
       
   321                 TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - checksum validation requested - expecting: 0x%08x", aParams.iChecksum ) );
       
   322                 RMemSpyDriverHeapWalker heapWalker(heap);
       
   323                 
       
   324                 TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - starting traversal..." ));
       
   325 #if ( defined( TRACE_TYPE_USERHEAP ) && defined( TRACE_TYPE_HEAPWALK ) )
       
   326                 heapWalker.SetPrintDebug();
       
   327 #endif
       
   328                 r = heapWalker.Traverse();
       
   329                 const TUint32 calculatedChecksum = heapWalker.Stats().iFreeCellCRC;
       
   330                 TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - finished traversal - err: %d, checksum: 0x%08x", r, calculatedChecksum ));
       
   331 
       
   332                 TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - comparing CALCULATED: 0x%08x vs EXPECTED: 0x%08x", calculatedChecksum, aParams.iChecksum ));
       
   333                 if  ( calculatedChecksum != aParams.iChecksum )
       
   334                     {
       
   335                     Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - comparing CALCULATED: 0x%08x vs EXPECTED: 0x%08x for thread %O", calculatedChecksum, aParams.iChecksum, thread );
       
   336                     r = KErrCorrupt;
       
   337                     }
       
   338                 }
       
   339 
       
   340             // Get user side (MemSpy) descriptor length info
       
   341             if  ( r == KErrNone )
       
   342                 {
       
   343                 TInt destLen = 0;
       
   344                 TInt destMax = 0;
       
   345                 TUint8* destPtr = NULL;
       
   346                 r = Kern::ThreadGetDesInfo( &ClientThread(), aParams.iDes, destLen, destMax, destPtr, ETrue );
       
   347                 TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - user side descriptor: 0x%08x (0x%08x), len: %8d, maxLen: %8d, r: %d", aParams.iDes, destPtr, destLen, destMax, r ));
       
   348 				destMax = destMax & ~(KPageSize-1); // Round down dest max to page size
       
   349 				if (destMax <= 0 || (aParams.iReadAddress & (KPageSize-1))) r = KErrArgument; // If destMax is less than a page or the read address isn't a multiple of page size then we don't want to know
       
   350 
       
   351                 if  ( r == KErrNone )
       
   352                     {
       
   353 					const TLinAddr chunkBase = (TLinAddr)OSAdaption().DChunk().GetBase(heap.Chunk());
       
   354 					const TLinAddr chunkMaxAddr = chunkBase + OSAdaption().DChunk().GetMaxSize(heap.Chunk());
       
   355         	        TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - chunkBase:    0x%08x", chunkBase) );
       
   356         
       
   357 					TLinAddr readAddress = aParams.iReadAddress;
       
   358                     if (aParams.iRemaining < 0 )
       
   359                         {
       
   360                         // Initial case, start from the bottom
       
   361                         readAddress = chunkBase;
       
   362 						aParams.iRemaining = heap.Helper()->CommittedSize();
       
   363                         }
       
   364 
       
   365                     // The remaining number of bytes should allow us to calculate the position
       
   366                     // to read from.
       
   367                     TInt amountToRead = Min( aParams.iRemaining, destMax );
       
   368         	        TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - amountToRead:           %8d", amountToRead) );
       
   369         
       
   370                     // Do the read from the heap we are spying on into MemSpy's address space
       
   371 					// TomS: I didn't know you could do this - you live and learn
       
   372 					do
       
   373 						{
       
   374 						r = Kern::ThreadRawRead( thread, (const void*)readAddress, destPtr, amountToRead );
       
   375         				TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - read result: %d", r) );
       
   376 
       
   377 						if (r == KErrBadDescriptor)
       
   378 							{
       
   379 							// This is not necessarily an error - it could be we've hit an unmapped page
       
   380 							if (amountToRead > KPageSize)
       
   381 								{
       
   382 								// retry reading a single page instead
       
   383 								amountToRead = KPageSize;
       
   384 								}
       
   385 							else
       
   386 								{
       
   387 								// Try the next page
       
   388 								readAddress += KPageSize;
       
   389 								}
       
   390 							}
       
   391 						} while (r == KErrBadDescriptor && readAddress < chunkMaxAddr);
       
   392                     //
       
   393                     if  (r == KErrNone)
       
   394                         {
       
   395                         // Client takes care of updating descriptor length.
       
   396                         r = amountToRead;
       
   397                         }
       
   398         
       
   399                     // Update remaining bytes
       
   400                     aParams.iRemaining -= amountToRead;
       
   401                     aParams.iReadAddress = readAddress;
       
   402                     }
       
   403                 }
       
   404 			}
       
   405         else
       
   406             {
       
   407     	    Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - couldnt open heap for thread %O, err=%d", thread, r);
       
   408             r = KErrNotSupported;
       
   409             }
       
   410 		heap.Close();
       
   411         }
       
   412     else
       
   413         {
       
   414         Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser - parent process not suspended => KErrAccessDenied - thread: %O", thread );
       
   415         r = KErrAccessDenied;
       
   416         }
       
   417 
       
   418 	CloseTempObject();
       
   419 
       
   420 	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapData::GetHeapDataUser() - END - ret: %d", r) );
       
   421     return r;
       
   422     }
       
   423 
       
   424 
       
   425