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 "MemSpyDriverLogChanHeapInfo.h"

    19 

    20 // System includes

    21 #include <u32hal.h>

    22 #include <e32rom.h>

    23 #include <memspy/driver/memspydriverconstants.h>

    24 #include <memspy/driver/memspydriverobjectsshared.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 "MemSpyDriverOSAdaption.h"

    34 #include "MemSpyDriverHeapWalker.h"

    35 #include "MemSpyDriverSuspensionManager.h"

    36 

    37 

    38 

    39 DMemSpyDriverLogChanHeapInfo::DMemSpyDriverLogChanHeapInfo( DMemSpyDriverDevice& aDevice, DThread& aThread )

    40 :	DMemSpyDriverLogChanHeapBase( aDevice, aThread )

    41     {

    42     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::DMemSpyDriverLogChanHeapInfo() - this: 0x%08x", this ));

    43     }

    44 

    45 

    46 DMemSpyDriverLogChanHeapInfo::~DMemSpyDriverLogChanHeapInfo()

    47 	{

    48 	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::~DMemSpyDriverLogChanHeapInfo() - START - this: 0x%08x", this ));

    49 	ReleaseCellList();

    50 	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::~DMemSpyDriverLogChanHeapInfo() - END - this: 0x%08x", this ));

    51 	}

    52 

    53 TInt DMemSpyDriverLogChanHeapInfo::Request( TInt aFunction, TAny* a1, TAny* a2 )

    54 	{

    55 	TInt r = DMemSpyDriverLogChanHeapBase::Request( aFunction, a1, a2 );

    56     if  ( r == KErrNone )

    57         {

    58         if  ( aFunction != EMemSpyDriverOpCodeHeapInfoFetchCellList )

    59             {

    60             ReleaseCellList();

    61             }

    62         //

    63         switch( aFunction )

    64 		    {

    65         case EMemSpyDriverOpCodeHeapInfoGetUser:

    66             r = GetHeapInfoUser( (TMemSpyDriverInternalHeapRequestParameters*) a1 );

    67             break;

    68 	    case EMemSpyDriverOpCodeHeapInfoGetKernel:

    69             r = GetHeapInfoKernel( (TMemSpyDriverInternalHeapRequestParameters*) a1, (TDes8*) a2 );

    70             break;

    71         case EMemSpyDriverOpCodeHeapInfoGetIsDebugKernel:

    72             r = GetIsDebugKernel(a1);

    73             break;

    74         case EMemSpyDriverOpCodeHeapInfoFetchCellList:

    75             r = FetchCellList( (TDes8*) a1 );

    76             break;

    77 

    78         default:

    79             r = KErrNotSupported;

    80 		    break;

    81             }

    82         }

    83     //

    84     return r;

    85 	}

    86 

    87 

    88 TBool DMemSpyDriverLogChanHeapInfo::IsHandler( TInt aFunction ) const

    89     {

    90     return ( aFunction > EMemSpyDriverOpCodeHeapInfoBase && aFunction < EMemSpyDriverOpCodeHeapInfoEnd );

    91     }

    92 

    93 

    94 

    95 

    96 

    97 

    98 

    99 

   100 

   101 

   102 

   103 

   104 

   105 TInt DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser( TMemSpyDriverInternalHeapRequestParameters* aParams )

   106     {

   107     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser() - START" ) );

   108 

   109     TInt r = Kern::ThreadRawRead( &ClientThread(), aParams, &iHeapInfoParams, sizeof(TMemSpyDriverInternalHeapRequestParameters) );

   110     if  ( r != KErrNone )

   111         {

   112     	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser - params read error: %d", r));

   113         }

   114     else

   115         {

   116         TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser - thread id: %d, vtable: 0x%08x, debugAllocator: %d", iHeapInfoParams.iTid, iHeapInfoParams.iRHeapVTable, iHeapInfoParams.iDebugAllocator) );

   117 

   118 	    r = OpenTempObject( iHeapInfoParams.iTid, EThread );

   119 	    if  ( r != KErrNone )

   120 		    {

   121     	    TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser - thread not found") );

   122             }

   123         else

   124             {

   125             // Check that the process' thread's are suspended

   126             DThread* thread = (DThread*) TempObject();

   127             if  ( SuspensionManager().IsSuspended( *thread ) )

   128                 {

   129                 // Open client's heap

   130                 RMemSpyDriverRHeapUser rHeap( OSAdaption() );

   131 				r = rHeap.OpenUserHeap(*thread, iHeapInfoParams.iDebugAllocator);

   132                 TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser - opening client heap returned: %d", r) );

   133 

   134                 if  ( r == KErrNone )

   135                     {

   136                     // This object holds all of the info we will accumulate for the client.

   137                     TMemSpyHeapInfo masterHeapInfo;

   138                     masterHeapInfo.SetType(rHeap.GetTypeFromHelper());

   139                     masterHeapInfo.SetTid( iHeapInfoParams.iTid );

   140                     masterHeapInfo.SetPid( OSAdaption().DThread().GetOwningProcessId( *thread ) );

   141 

   142                     // This is the RHeap-specific object that contains all RHeap info

   143                     TMemSpyHeapInfoRHeap& rHeapInfo = masterHeapInfo.AsRHeap();

   144 

   145 

   146                     // We must walk the client's heap in order to build statistics

   147                     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser - calling heap walker constructor..."));

   148 					RMemSpyDriverHeapWalker heapWalker(rHeap);

   149                     if  (iHeapInfoParams.iBuildFreeCellList || iHeapInfoParams.iBuildAllocCellList)

   150                         {

   151                         heapWalker.SetObserver( this );

   152                         TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser - collecting cells"));

   153                         }

   154                     else

   155                         {

   156                         TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser - not collecting cells"));

   157                         }

   158 

   159                     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser - starting traversal openerr: %d...", r));

   160 

   161 #if ( defined( TRACE_TYPE_USERHEAP ) && defined( TRACE_TYPE_HEAPWALK ) )

   162                     heapWalker.SetPrintDebug();

   163 #endif

   164                     if (r == KErrNone) r = heapWalker.Traverse();

   165                     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser - finished traversal - err: %d", r ));

   166 

   167                     TMemSpyHeapStatisticsRHeap& rHeapStats = rHeapInfo.Statistics();

   168                     heapWalker.CopyStatsTo( rHeapStats );

   169 

   170                     // Get remaining meta data that isn't stored elsewhere

   171                     TMemSpyHeapMetaDataRHeap& rHeapMetaData = rHeapInfo.MetaData();

   172 					DChunk& userHeapChunk = rHeap.Chunk();

   173 					TFullName chunkName;

   174 					userHeapChunk.FullName(chunkName);

   175 					rHeapMetaData.SetChunkName( chunkName );

   176 		            rHeapMetaData.SetChunkSize( (TUint) OSAdaption().DChunk().GetSize( userHeapChunk ) );

   177 					rHeapMetaData.SetChunkHandle( &userHeapChunk );

   178 					rHeapMetaData.SetChunkBaseAddress( OSAdaption().DChunk().GetBase( userHeapChunk ) );

   179                     rHeapMetaData.SetDebugAllocator(rHeap.Helper()->AllocatorIsUdeb());

   180                     rHeapMetaData.SetUserThread( ETrue );

   181 					rHeapMetaData.iHeapSize = rHeap.Helper()->CommittedSize();

   182 					rHeapMetaData.iAllocatorAddress = (TAny*)rHeap.Helper()->AllocatorAddress();

   183 					rHeapMetaData.iMinHeapSize = rHeap.Helper()->MinCommittedSize();

   184 					rHeapMetaData.iMaxHeapSize = rHeap.Helper()->MaxCommittedSize();

   185 

   186                     PrintHeapInfo( masterHeapInfo );

   187 

   188                     // Write free cells if requested

   189                     if  ( r == KErrNone && (iHeapInfoParams.iBuildFreeCellList || iHeapInfoParams.iBuildAllocCellList))

   190                         {

   191                         r = PrepareCellListTransferBuffer();

   192                         }

   193 

   194                     // Update info ready for writing back to the user-side

   195                     if  ( r >= KErrNone )

   196                         {

   197                         // Write results back to user-side

   198                         TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser - writing to user-side..."));

   199                         TMemSpyHeapInfo* userMasterInfo = iHeapInfoParams.iMasterInfo;

   200                         const TInt error = Kern::ThreadRawWrite( &ClientThread(), userMasterInfo, &masterHeapInfo, sizeof(TMemSpyHeapInfo) );

   201                         if  ( error < 0 )

   202                             {

   203                             r = error;

   204                             }

   205                         }

   206 

   207                     // Release resources

   208 					rHeap.Close();

   209                     }

   210                 }

   211             else

   212                 {

   213                 r = KErrAccessDenied;

   214                 TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser - parent process not suspended => KErrAccessDenied"));

   215                 }

   216 

   217 	        CloseTempObject();

   218             }

   219         }

   220 

   221 	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoUser() - END - ret: %d", r));

   222     return r;

   223     }

   224 

   225 

   226 

   227 

   228 

   229 

   230 

   231 TInt DMemSpyDriverLogChanHeapInfo::GetHeapInfoKernel( TMemSpyDriverInternalHeapRequestParameters* aParams, TDes8* aTransferBuffer )

   232     {

   233     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoKernel() - START - aTransferBuffer: 0x%08x", aTransferBuffer ) );

   234 

   235     TMemSpyDriverInternalHeapRequestParameters params;

   236     TInt r = Kern::ThreadRawRead( &ClientThread(), aParams, &params, sizeof(TMemSpyDriverInternalHeapRequestParameters) );

   237     if  ( r == KErrNone )

   238         {

   239         // Open kernel heap

   240         RMemSpyDriverRHeapKernelInPlace rHeap;

   241         r = rHeap.OpenKernelHeap();

   242         TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoKernel() - open err: %d", r ) );

   243 

   244         if  ( r == KErrNone )

   245             {

   246             r = DMemSpyDriverLogChanHeapBase::GetHeapInfoKernel(rHeap, params.iMasterInfo, aTransferBuffer);

   247             TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoKernel() - base class get heap info: %d", r) );

   248             }

   249         else 

   250             {

   251             TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoKernel() - open err: %d", r ) );

   252             }

   253         }

   254     else

   255         {

   256         TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoKernel() - params read error: %d", r) );

   257         }

   258 

   259 	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetHeapInfoKernel() - END - ret: %d", r) );

   260     return r;

   261     }

   262 

   263 

   264 

   265 

   266 

   267 

   268 TInt DMemSpyDriverLogChanHeapInfo::GetIsDebugKernel(TAny* aResult)

   269     {

   270     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetIsDebugKernel() - START") );

   271     

   272     TInt r = KErrNone;

   273     TBool debugKernel = EFalse;

   274 

   275     NKern::ThreadEnterCS();

   276     

   277     RMemSpyDriverRHeapKernelInPlace rHeap;

   278     r = rHeap.OpenKernelHeap();

   279     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetIsDebugKernel() - open kernel heap returned: %d", r) );

   280 

   281     if  ( r == KErrNone )

   282         {

   283         debugKernel = rHeap.Helper()->AllocatorIsUdeb();

   284 

   285         // Tidy up

   286         rHeap.Close();

   287         }

   288 

   289     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetIsDebugKernel() - debugKernel: %d", debugKernel) );

   290 

   291     // Write back to user-land

   292     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetIsDebugKernel() - writing to user-side...") );

   293     r = Kern::ThreadRawWrite( &ClientThread(), aResult, &debugKernel, sizeof(TBool) );

   294 

   295     NKern::ThreadLeaveCS();

   296 

   297  	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::GetIsDebugKernel() - END - ret: %d", r) );

   298     return r;

   299     }

   300 

   301 TInt DMemSpyDriverLogChanHeapInfo::PrepareCellListTransferBuffer()

   302     {

   303     // Transfer free cells immediately from xfer stream

   304     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::PrepareCellListTransferBuffer() - START - iHeapStream: 0x%08x", iHeapStream ));

   305     __ASSERT_ALWAYS( !iHeapStream, MemSpyDriverUtils::PanicThread( ClientThread(), EPanicHeapFreeCellStreamNotClosed ) );

   306     //

   307     TInt r = KErrNoMemory;

   308     //

   309     NKern::ThreadEnterCS();

   310     //

   311     iHeapStream = new RMemSpyMemStreamWriter();

   312     if  ( iHeapStream )

   313         {

   314         const TInt requiredMemory = CalculateCellListBufferSize();

   315         r = OpenXferStream( *iHeapStream, requiredMemory );

   316         TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::PrepareCellListTransferBuffer() - requested %d bytes for free cell list, r: %d", requiredMemory, r ));

   317 

   318         if  ( r == KErrNone )

   319             {

   320             const TInt count = iCellList.Count();

   321             TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::PrepareCellListTransferBuffer() - cell count: %d", count ));

   322             //

   323             iHeapStream->WriteInt32( count );

   324             for( TInt i=0; i<count; i++ )

   325                 {

   326                 const TMemSpyDriverCell& cell = iCellList[ i ];

   327                 TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::PrepareCellListTransferBuffer() - storing entry: %d", i ));

   328                 //

   329                 iHeapStream->WriteInt32( cell.iType );

   330                 iHeapStream->WriteUint32( reinterpret_cast<TUint32>( cell.iAddress ) );

   331                 iHeapStream->WriteInt32( cell.iLength );

   332                 }

   333 

   334             // Finished with the array now

   335             iCellList.Reset();

   336 

   337             // We return the amount of client-side memory that needs to be allocated to hold the buffer

   338             r = requiredMemory;

   339             }

   340         }

   341     //

   342     NKern::ThreadLeaveCS();

   343                

   344     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::PrepareCellListTransferBuffer() - END - r: %d", r));

   345 	return r;

   346     }

   347 

   348 

   349 TInt DMemSpyDriverLogChanHeapInfo::FetchCellList( TDes8* aBufferSink )

   350     {

   351     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::FetchCellList() - START - iHeapStream: 0x%08x", iHeapStream ));

   352     __ASSERT_ALWAYS( iHeapStream, MemSpyDriverUtils::PanicThread( ClientThread(), EPanicHeapFreeCellStreamNotOpen ) );

   353 

   354     TInt r = KErrNone;

   355 

   356     // Write buffer to client

   357     NKern::ThreadEnterCS();

   358     r = iHeapStream->WriteAndClose( aBufferSink );

   359 

   360     // Tidy up

   361     ReleaseCellList();

   362 

   363     NKern::ThreadLeaveCS();

   364     //

   365     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::FetchCellList() - END - r: %d", r));

   366 	return r;

   367     }

   368 

   369 

   370 

   371 TInt DMemSpyDriverLogChanHeapInfo::CalculateCellListBufferSize() const

   372     {

   373     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::CalculateCellListBufferSize() - START" ));

   374 

   375     const TInt count = iCellList.Count();

   376     const TInt entrySize = sizeof( TInt32 ) + sizeof( TInt32 ) + sizeof( TUint32 );

   377     const TInt r = ( count * entrySize ) + sizeof( TInt ); // Extra TInt to hold count

   378                 

   379     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::CalculateCellListBufferSize() - END - r: %d, count: %d, entrySize: %d", r, count, entrySize ));

   380 	return r;

   381     }

   382 

   383 

   384 

   385 void DMemSpyDriverLogChanHeapInfo::ReleaseCellList()

   386     {

   387 	TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::ReleaseCellList() - START - this: 0x%08x", this ));

   388 

   389     NKern::ThreadEnterCS();

   390     iCellList.Reset();

   391     delete iHeapStream;

   392     iHeapStream = NULL;

   393     NKern::ThreadLeaveCS();

   394 

   395     TRACE( Kern::Printf("DMemSpyDriverLogChanHeapInfo::ReleaseCellList() - END - this: 0x%08x", this ));

   396     }

   397 

   398 TBool DMemSpyDriverLogChanHeapInfo::HandleHeapCell(TMemSpyDriverCellType aCellType, TAny* aCellAddress, TInt aLength, TInt /*aNestingLevel*/, TInt /*aAllocNumber*/)

   399     {

   400 	TInt err = KErrNone;

   401     if (((aCellType & EMemSpyDriverFreeCellMask) && iHeapInfoParams.iBuildFreeCellList) || 

   402         ((aCellType & EMemSpyDriverAllocatedCellMask) && iHeapInfoParams.iBuildAllocCellList))

   403 		{

   404 		TMemSpyDriverCell cell;

   405 		cell.iType = aCellType;

   406 		cell.iAddress = aCellAddress;

   407 		cell.iLength = aLength;

   408 

   409 		NKern::ThreadEnterCS();

   410 		err = iCellList.Append(cell);

   411 		NKern::ThreadLeaveCS();

   412 		}

   413 	return err == KErrNone;

   414 	}

   415 

   416 void DMemSpyDriverLogChanHeapInfo::HandleHeapWalkInit()

   417 	{

   418 	}