memspy/MemSpyClient/inc/memspysession.h
author hgs
Mon, 28 Jun 2010 15:36:07 +0300
changeset 30 86a2e675b80a
parent 20 a71a3e32a2ae
permissions -rw-r--r--
201025
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
20
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef MEMSPYSESSION_H
hgs
parents:
diff changeset
    20
#define MEMSPYSESSION_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
// System includes
hgs
parents:
diff changeset
    24
#include <e32base.h>
hgs
parents:
diff changeset
    25
#include <u32std.h>
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
//user includes
hgs
parents:
diff changeset
    28
#include <memspy/api/memspyapiprocess.h>
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
#include <memspy/api/memspyapithread.h>
hgs
parents:
diff changeset
    31
#include <memspy/api/memspyapithreadinfoitem.h>
hgs
parents:
diff changeset
    32
#include <memspy/engine/memspythreadinfoitemdata.h>
hgs
parents:
diff changeset
    33
#include <memspy/engine/memspyengineobjectthreadinfoobjects.h>
30
hgs
parents: 20
diff changeset
    34
#include <memspy/engine/memspydevicewideoperations.h>
20
hgs
parents:
diff changeset
    35
hgs
parents:
diff changeset
    36
#include <memspy/api/memspyapikernelobject.h>
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
#include <memspy/api/memspyapikernelobjectitem.h> //for KernelObjectItems
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
#include <memspy/api/memspyapiheap.h>
hgs
parents:
diff changeset
    41
30
hgs
parents: 20
diff changeset
    42
#include <memspy/api/memspyapimemorytrackingcycle.h>
hgs
parents: 20
diff changeset
    43
20
hgs
parents:
diff changeset
    44
#include <memspyengineclientinterface.h>
30
hgs
parents: 20
diff changeset
    45
#include <memspy/engine/memspyengineoutputsinktype.h>
hgs
parents: 20
diff changeset
    46
hgs
parents: 20
diff changeset
    47
#include <memspy/engine/memspyenginehelpersysmemtrackerconfig.h>
20
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
// Constants
hgs
parents:
diff changeset
    50
const TInt KMemSpyVersion           = 2;
hgs
parents:
diff changeset
    51
hgs
parents:
diff changeset
    52
enum TSortType
hgs
parents:
diff changeset
    53
	{
hgs
parents:
diff changeset
    54
	ESortProcById,
hgs
parents:
diff changeset
    55
	ESortProcByName,
hgs
parents:
diff changeset
    56
	ESortProcByThreadCount,
hgs
parents:
diff changeset
    57
	ESortProcByCodeSegs,
hgs
parents:
diff changeset
    58
	ESortProcByHeapUsage,
hgs
parents:
diff changeset
    59
	ESortProcByStackUsage
hgs
parents:
diff changeset
    60
	};
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
enum TMemSpyOutputType
hgs
parents:
diff changeset
    63
    {
hgs
parents:
diff changeset
    64
    EOutputTypeDebug = 0,
hgs
parents:
diff changeset
    65
    EOutputTypeFile
hgs
parents:
diff changeset
    66
    };
hgs
parents:
diff changeset
    67
30
hgs
parents: 20
diff changeset
    68
class TMemSpyDeviceWideOperationProgress 
hgs
parents: 20
diff changeset
    69
	{
hgs
parents: 20
diff changeset
    70
public:
hgs
parents: 20
diff changeset
    71
	IMPORT_C TInt Progress() const;
hgs
parents: 20
diff changeset
    72
	IMPORT_C const TDesC& Description() const;
hgs
parents: 20
diff changeset
    73
	
hgs
parents: 20
diff changeset
    74
private:
hgs
parents: 20
diff changeset
    75
	TPckgBuf<TInt> iProgress;
hgs
parents: 20
diff changeset
    76
	TFullName iDescription;
hgs
parents: 20
diff changeset
    77
	
hgs
parents: 20
diff changeset
    78
friend class RMemSpySession;
hgs
parents: 20
diff changeset
    79
	};
hgs
parents: 20
diff changeset
    80
20
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
NONSHARABLE_CLASS( RMemSpySession ) : public RSessionBase
hgs
parents:
diff changeset
    83
    {
hgs
parents:
diff changeset
    84
public:
hgs
parents:
diff changeset
    85
    IMPORT_C RMemSpySession();
hgs
parents:
diff changeset
    86
    IMPORT_C TInt Connect();
hgs
parents:
diff changeset
    87
    
hgs
parents:
diff changeset
    88
public:	//API
30
hgs
parents: 20
diff changeset
    89
    //Thread speciifc operations
hgs
parents: 20
diff changeset
    90
    IMPORT_C void OutputKernelHeapDataL(); //EMemSpyClientServerOpHeapData
hgs
parents: 20
diff changeset
    91
    
hgs
parents: 20
diff changeset
    92
    IMPORT_C void OutputKernelHeapData(TRequestStatus& aStatus); //EMemSpyClientServerOpHeapData
hgs
parents: 20
diff changeset
    93
    
hgs
parents: 20
diff changeset
    94
    IMPORT_C void OutputThreadHeapDataL(TThreadId aThreadId); //EMemSpyClientServerOpHeapData
hgs
parents: 20
diff changeset
    95
    
hgs
parents: 20
diff changeset
    96
    IMPORT_C void OutputThreadHeapDataL(const TDesC& aThreadName); //EMemSpyClientServerOpHeapData
hgs
parents: 20
diff changeset
    97
    
hgs
parents: 20
diff changeset
    98
    IMPORT_C void OutputThreadCellListL(TThreadId aThreadId);//EMemSpyClientServerOpHeapCellListing    
hgs
parents: 20
diff changeset
    99
    
hgs
parents: 20
diff changeset
   100
    IMPORT_C void OutputHeapInfoUserL(TThreadId aThreadId);	//EMemSpyClientServerOpHeapInfo
hgs
parents: 20
diff changeset
   101
    
hgs
parents: 20
diff changeset
   102
    IMPORT_C void SwitchOutputSinkL( TMemSpySinkType aType); //EMemSpyClientServerOpSwitchOutputSinkFile / EMemSpyClientServerOpSwitchOutputSinkTrace
hgs
parents: 20
diff changeset
   103
    
hgs
parents: 20
diff changeset
   104
    IMPORT_C void SwitchOutputToTraceL(); // EMemSpyClientServerOpSwitchOutputSinkTrace
hgs
parents: 20
diff changeset
   105
    
hgs
parents: 20
diff changeset
   106
    IMPORT_C void SwitchOutputToFileL(const TDesC& aRootFolder); // EMemSpyClientServerOpSwitchOutputSinkFile
hgs
parents: 20
diff changeset
   107
    
hgs
parents: 20
diff changeset
   108
    IMPORT_C void OutputStackInfoL(TThreadId aThreadId); //EMemSpyClientServerOpStackInfo
hgs
parents: 20
diff changeset
   109
    
hgs
parents: 20
diff changeset
   110
    IMPORT_C void OutputStackDataL(TThreadId aThreadId, TMemSpyDriverDomainType aType ); //EMemSpyClientServerOpStackDataUser / EMemSpyClientServerOpStackDataKernel    
hgs
parents: 20
diff changeset
   111
    
hgs
parents: 20
diff changeset
   112
    IMPORT_C void OutputThreadInfoHandlesL(TThreadId aThreadId); //EMemSpyClientServerOpOutputInfoHandles
hgs
parents: 20
diff changeset
   113
    
hgs
parents: 20
diff changeset
   114
    IMPORT_C void OutputAOListL(TThreadId aId, TMemSpyThreadInfoItemType aType);	//EMemSpyClientServerOpOutputAOList    
hgs
parents: 20
diff changeset
   115
    
hgs
parents: 20
diff changeset
   116
    IMPORT_C void OutputKernelObjectsL();// EMemSpyClientServerOpEnumerateKernelContainerAll
hgs
parents: 20
diff changeset
   117
    
hgs
parents: 20
diff changeset
   118
    IMPORT_C void OutputCompactStackInfoL();// EMemSpyClientServerOpStackInfoCompact
hgs
parents: 20
diff changeset
   119
    
hgs
parents: 20
diff changeset
   120
    IMPORT_C void OutputCompactHeapInfoL();// EMemSpyClientServerOpHeapInfoCompact
hgs
parents: 20
diff changeset
   121
    
hgs
parents: 20
diff changeset
   122
    // Device Wide Operations
hgs
parents: 20
diff changeset
   123
    // Synchronous operations - for CLI
hgs
parents: 20
diff changeset
   124
    IMPORT_C void OutputHeapData();
hgs
parents: 20
diff changeset
   125
    
hgs
parents: 20
diff changeset
   126
    // Asynchronous operations
hgs
parents: 20
diff changeset
   127
    IMPORT_C void OutputPhoneInfo(TRequestStatus& aStatus);
hgs
parents: 20
diff changeset
   128
    
hgs
parents: 20
diff changeset
   129
    IMPORT_C void OutputDetailedPhoneInfo(TRequestStatus& aStatus);
hgs
parents: 20
diff changeset
   130
    
hgs
parents: 20
diff changeset
   131
    IMPORT_C void OutputHeapInfo(TRequestStatus& aStatus);
hgs
parents: 20
diff changeset
   132
    
hgs
parents: 20
diff changeset
   133
    IMPORT_C void OutputCompactHeapInfo(TRequestStatus &aStatus);
hgs
parents: 20
diff changeset
   134
    
hgs
parents: 20
diff changeset
   135
    IMPORT_C void OutputHeapCellListing(TRequestStatus& aStatus);
hgs
parents: 20
diff changeset
   136
    
hgs
parents: 20
diff changeset
   137
    IMPORT_C void OutputHeapData(TRequestStatus& aStatus);
hgs
parents: 20
diff changeset
   138
    
hgs
parents: 20
diff changeset
   139
    IMPORT_C void OutputStackInfo(TRequestStatus& aStatus);
hgs
parents: 20
diff changeset
   140
    
hgs
parents: 20
diff changeset
   141
    IMPORT_C void OutputCompactStackInfo(TRequestStatus &aStatus);
hgs
parents: 20
diff changeset
   142
    
hgs
parents: 20
diff changeset
   143
    IMPORT_C void OutputUserStackData(TRequestStatus& aStatus);
hgs
parents: 20
diff changeset
   144
    
hgs
parents: 20
diff changeset
   145
    IMPORT_C void OutputKernelStackData(TRequestStatus& aStatus);
hgs
parents: 20
diff changeset
   146
    
hgs
parents: 20
diff changeset
   147
    IMPORT_C void NotifyDeviceWideOperationProgress(TMemSpyDeviceWideOperationProgress &aProgress, TRequestStatus &aStatus);
hgs
parents: 20
diff changeset
   148
    
hgs
parents: 20
diff changeset
   149
    IMPORT_C void CancelDeviceWideOperationL();
hgs
parents: 20
diff changeset
   150
    
hgs
parents: 20
diff changeset
   151
    // Synchronous operations for MemSpyLauncher
hgs
parents: 20
diff changeset
   152
    IMPORT_C void OutputPhoneInfo();
hgs
parents: 20
diff changeset
   153
    
hgs
parents: 20
diff changeset
   154
    // "Ui" operations 
20
hgs
parents:
diff changeset
   155
    
hgs
parents:
diff changeset
   156
    IMPORT_C void GetProcessesL(RArray<CMemSpyApiProcess*> &aProcesses, TSortType aSortType = ESortProcById);
hgs
parents:
diff changeset
   157
    
hgs
parents:
diff changeset
   158
    IMPORT_C TProcessId GetProcessIdByNameL(const TDesC& aProcessName);
hgs
parents:
diff changeset
   159
    
hgs
parents:
diff changeset
   160
    IMPORT_C void GetThreadsL(TProcessId aProcessId, RArray<CMemSpyApiThread*> &aThreads, TSortType aSortType = ESortProcById);
hgs
parents:
diff changeset
   161
    
hgs
parents:
diff changeset
   162
    IMPORT_C TInt ProcessSystemPermanentOrCritical( TProcessId aId, TBool aValue ); //aValue -> return value
hgs
parents:
diff changeset
   163
    
hgs
parents:
diff changeset
   164
    IMPORT_C void SetThreadPriorityL(TThreadId aId, TInt aPriority);
30
hgs
parents: 20
diff changeset
   165
    
20
hgs
parents:
diff changeset
   166
    IMPORT_C TInt EndProcess( TProcessId aId, TMemSpyEndType aType );
hgs
parents:
diff changeset
   167
    
hgs
parents:
diff changeset
   168
    IMPORT_C TInt SwitchToProcess( TProcessId aId, TBool aBrought  );
hgs
parents:
diff changeset
   169
    
30
hgs
parents: 20
diff changeset
   170
    //SWMT operations
hgs
parents: 20
diff changeset
   171
    
hgs
parents: 20
diff changeset
   172
    IMPORT_C void GetMemoryTrackingCyclesL(RArray<CMemSpyApiMemoryTrackingCycle*>& aCycles);
hgs
parents: 20
diff changeset
   173
    
hgs
parents: 20
diff changeset
   174
    IMPORT_C void SetSwmtConfig( TMemSpyEngineHelperSysMemTrackerConfig aConfig );    
hgs
parents: 20
diff changeset
   175
    
hgs
parents: 20
diff changeset
   176
    IMPORT_C void SetSwmtAutoStartProcessList( CArrayFixFlat<TUid>* aList );
hgs
parents: 20
diff changeset
   177
    
hgs
parents: 20
diff changeset
   178
    IMPORT_C void SetSwmtFilter( const TDesC& aFilter );            
hgs
parents: 20
diff changeset
   179
    
hgs
parents: 20
diff changeset
   180
    IMPORT_C void SetSwmtCategoriesL(TInt aCategories);
hgs
parents: 20
diff changeset
   181
hgs
parents: 20
diff changeset
   182
    IMPORT_C void SetSwmtHeapDumpsEnabledL(TBool aEnabled);
hgs
parents: 20
diff changeset
   183
    
hgs
parents: 20
diff changeset
   184
    IMPORT_C void SwmtResetTracking();
hgs
parents: 20
diff changeset
   185
    
hgs
parents: 20
diff changeset
   186
    IMPORT_C void GetOutputSink( TMemSpySinkType aType );
hgs
parents: 20
diff changeset
   187
           
hgs
parents: 20
diff changeset
   188
    IMPORT_C TBool IsSwmtRunningL();
hgs
parents: 20
diff changeset
   189
    
hgs
parents: 20
diff changeset
   190
    IMPORT_C void StartSwmtTimerL(TInt aPeriod);
hgs
parents: 20
diff changeset
   191
    
hgs
parents: 20
diff changeset
   192
    IMPORT_C void StartSwmtTimerL(); // for CLI
hgs
parents: 20
diff changeset
   193
    
hgs
parents: 20
diff changeset
   194
    IMPORT_C void SetSwmtTimerIntervalL(TInt aPeriod); //for CLI
hgs
parents: 20
diff changeset
   195
    
hgs
parents: 20
diff changeset
   196
    IMPORT_C void StopSwmtTimerL();
hgs
parents: 20
diff changeset
   197
    
hgs
parents: 20
diff changeset
   198
    IMPORT_C void ForceSwmtUpdateL();
hgs
parents: 20
diff changeset
   199
    
hgs
parents: 20
diff changeset
   200
    IMPORT_C void ForceSwmtUpdate(TRequestStatus& aStatus);
20
hgs
parents:
diff changeset
   201
    
hgs
parents:
diff changeset
   202
    //Threads operations
hgs
parents:
diff changeset
   203
    /**
hgs
parents:
diff changeset
   204
     * 
hgs
parents:
diff changeset
   205
     */
hgs
parents:
diff changeset
   206
    IMPORT_C void GetThreadsL(TProcessId aProcessId, RArray<CMemSpyApiProcess*> &aThreads, TSortType aSortType = ESortProcById);
hgs
parents:
diff changeset
   207
    
hgs
parents:
diff changeset
   208
    IMPORT_C TInt ThreadSystemPermanentOrCritical( TThreadId aId, TBool aValue );
hgs
parents:
diff changeset
   209
        
hgs
parents:
diff changeset
   210
    IMPORT_C TInt EndThread( TThreadId aId, TMemSpyEndType aType );
hgs
parents:
diff changeset
   211
    
hgs
parents:
diff changeset
   212
    IMPORT_C TInt SwitchToThread( TThreadId aId, TBool aBrought );
hgs
parents:
diff changeset
   213
    
hgs
parents:
diff changeset
   214
    IMPORT_C TInt GetInfoItemType( TInt aIndex, TThreadId aId, TMemSpyThreadInfoItemType &aType );
hgs
parents:
diff changeset
   215
    
30
hgs
parents: 20
diff changeset
   216
    IMPORT_C TInt GetThreadInfoItems( RArray<CMemSpyApiThreadInfoItem*> &aInfoItems, TThreadId aId, TMemSpyThreadInfoItemType aType );
hgs
parents: 20
diff changeset
   217
    
hgs
parents: 20
diff changeset
   218
    IMPORT_C void GetThreadInfoItemsL( RArray<CMemSpyApiThreadInfoItem*> &aInfoItems, TThreadId aId, TMemSpyThreadInfoItemType aType );
hgs
parents: 20
diff changeset
   219
        
20
hgs
parents:
diff changeset
   220
    
30
hgs
parents: 20
diff changeset
   221
    //KernelObjects operations
hgs
parents: 20
diff changeset
   222
    
hgs
parents: 20
diff changeset
   223
    IMPORT_C void GetKernelObjectsL( RArray<CMemSpyApiKernelObject*> &aKernelObjects );
hgs
parents: 20
diff changeset
   224
    
20
hgs
parents:
diff changeset
   225
    IMPORT_C TInt GetKernelObjects( RArray<CMemSpyApiKernelObject*> &aKernelObjects );
hgs
parents:
diff changeset
   226
    
30
hgs
parents: 20
diff changeset
   227
    IMPORT_C void GetKernelObjectItemsL( RArray<CMemSpyApiKernelObjectItem*> &aKernelObjectItems, TMemSpyDriverContainerType aForContainer );
hgs
parents: 20
diff changeset
   228
    
20
hgs
parents:
diff changeset
   229
    IMPORT_C TInt GetKernelObjectItems( RArray<CMemSpyApiKernelObjectItem*> &aKernelObjectItems, TMemSpyDriverContainerType aForContainer );
hgs
parents:
diff changeset
   230
    
hgs
parents:
diff changeset
   231
    IMPORT_C void OutputAllContainerContents();
hgs
parents:
diff changeset
   232
    
30
hgs
parents: 20
diff changeset
   233
    // Heap 
hgs
parents: 20
diff changeset
   234
    
hgs
parents: 20
diff changeset
   235
    IMPORT_C CMemSpyApiHeap* GetHeapL();
hgs
parents: 20
diff changeset
   236
    
20
hgs
parents:
diff changeset
   237
	IMPORT_C CMemSpyApiHeap* GetHeap();
hgs
parents:
diff changeset
   238
	
30
hgs
parents: 20
diff changeset
   239
	IMPORT_C void DumpKernelHeap();	
hgs
parents: 20
diff changeset
   240
	
20
hgs
parents:
diff changeset
   241
private:
30
hgs
parents: 20
diff changeset
   242
    TInt StartServer();       
20
hgs
parents:
diff changeset
   243
    
hgs
parents:
diff changeset
   244
    void SetOutputTypeL(TMemSpyOutputType aOutputType);
30
hgs
parents: 20
diff changeset
   245
    
20
hgs
parents:
diff changeset
   246
    };
hgs
parents:
diff changeset
   247
hgs
parents:
diff changeset
   248
#endif // MEMSPYSESSION_H