memspy/MemSpyClient/inc/memspysession.h
author hgs
Thu, 13 May 2010 23:59:27 +0300
changeset 20 a71a3e32a2ae
child 30 86a2e675b80a
permissions -rw-r--r--
201019
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/engine/memspyprocessdata.h> //for Processes
hgs
parents:
diff changeset
    29
#include <memspy/api/memspyapiprocess.h>
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
#include <memspy/engine/memspythreaddata.h> //for Threads
hgs
parents:
diff changeset
    32
#include <memspy/api/memspyapithread.h>
hgs
parents:
diff changeset
    33
#include <memspy/api/memspyapithreadinfoitem.h>
hgs
parents:
diff changeset
    34
#include <memspy/engine/memspythreadinfoitemdata.h>
hgs
parents:
diff changeset
    35
#include <memspy/engine/memspyengineobjectthreadinfoobjects.h>
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
#include <memspy/engine/memspykernelobjectdata.h> //for KernelObjects
hgs
parents:
diff changeset
    38
#include <memspy/api/memspyapikernelobject.h>
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
#include <memspy/api/memspyapikernelobjectitem.h> //for KernelObjectItems
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
#include <memspy/engine/memspyheapdata.h> //for Heap
hgs
parents:
diff changeset
    43
#include <memspy/api/memspyapiheap.h>
hgs
parents:
diff changeset
    44
hgs
parents:
diff changeset
    45
#include <memspyengineclientinterface.h>
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
// Constants
hgs
parents:
diff changeset
    48
const TInt KMemSpyVersion           = 2;
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
enum TSortType
hgs
parents:
diff changeset
    51
	{
hgs
parents:
diff changeset
    52
	ESortProcById,
hgs
parents:
diff changeset
    53
	ESortProcByName,
hgs
parents:
diff changeset
    54
	ESortProcByThreadCount,
hgs
parents:
diff changeset
    55
	ESortProcByCodeSegs,
hgs
parents:
diff changeset
    56
	ESortProcByHeapUsage,
hgs
parents:
diff changeset
    57
	ESortProcByStackUsage
hgs
parents:
diff changeset
    58
	};
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
enum TMemSpyOutputType
hgs
parents:
diff changeset
    61
    {
hgs
parents:
diff changeset
    62
    EOutputTypeDebug = 0,
hgs
parents:
diff changeset
    63
    EOutputTypeFile
hgs
parents:
diff changeset
    64
    };
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
NONSHARABLE_CLASS( RMemSpySession ) : public RSessionBase
hgs
parents:
diff changeset
    68
    {
hgs
parents:
diff changeset
    69
public:
hgs
parents:
diff changeset
    70
    IMPORT_C RMemSpySession();
hgs
parents:
diff changeset
    71
    IMPORT_C TInt Connect();
hgs
parents:
diff changeset
    72
    
hgs
parents:
diff changeset
    73
public:	//API
hgs
parents:
diff changeset
    74
    IMPORT_C void OutputKernelHeapDataL(TMemSpyOutputType aOutputType); //EMemSpyClientServerOpHeapData
hgs
parents:
diff changeset
    75
    IMPORT_C void OutputThreadHeapDataL(TMemSpyOutputType aOutputType, TThreadId aThreadId); //EMemSpyClientServerOpHeapData
hgs
parents:
diff changeset
    76
    IMPORT_C void OutputThreadCellListL(TMemSpyOutputType aOutputType, TThreadId aThreadId);//EMemSpyClientServerOpHeapCellListing
hgs
parents:
diff changeset
    77
    IMPORT_C void OutputKernelObjectsL(TMemSpyOutputType aOutputType);// EMemSpyClientServerOpEnumerateKernelContainerAll
hgs
parents:
diff changeset
    78
    IMPORT_C void OutputCompactStackInfoL(TMemSpyOutputType aOutputType);// EMemSpyClientServerOpStackInfoCompact
hgs
parents:
diff changeset
    79
    IMPORT_C void OutputCompactHeapInfoL(TMemSpyOutputType aOutputType);// EMemSpyClientServerOpHeapInfoCompact
hgs
parents:
diff changeset
    80
    
hgs
parents:
diff changeset
    81
    IMPORT_C void GetProcessesL(RArray<CMemSpyApiProcess*> &aProcesses, TSortType aSortType = ESortProcById);
hgs
parents:
diff changeset
    82
    
hgs
parents:
diff changeset
    83
    IMPORT_C TProcessId GetProcessIdByNameL(const TDesC& aProcessName);
hgs
parents:
diff changeset
    84
    
hgs
parents:
diff changeset
    85
    IMPORT_C void GetThreadsL(TProcessId aProcessId, RArray<CMemSpyApiThread*> &aThreads, TSortType aSortType = ESortProcById);
hgs
parents:
diff changeset
    86
    
hgs
parents:
diff changeset
    87
    IMPORT_C TInt ProcessSystemPermanentOrCritical( TProcessId aId, TBool aValue ); //aValue -> return value
hgs
parents:
diff changeset
    88
    
hgs
parents:
diff changeset
    89
    IMPORT_C void SetThreadPriorityL(TThreadId aId, TInt aPriority);
hgs
parents:
diff changeset
    90
    IMPORT_C TInt EndProcess( TProcessId aId, TMemSpyEndType aType );
hgs
parents:
diff changeset
    91
    
hgs
parents:
diff changeset
    92
    IMPORT_C TInt SwitchToProcess( TProcessId aId, TBool aBrought  );
hgs
parents:
diff changeset
    93
    
hgs
parents:
diff changeset
    94
    
hgs
parents:
diff changeset
    95
    //Threads operations
hgs
parents:
diff changeset
    96
    /**
hgs
parents:
diff changeset
    97
     * 
hgs
parents:
diff changeset
    98
     */
hgs
parents:
diff changeset
    99
    IMPORT_C void GetThreadsL(TProcessId aProcessId, RArray<CMemSpyApiProcess*> &aThreads, TSortType aSortType = ESortProcById);
hgs
parents:
diff changeset
   100
    
hgs
parents:
diff changeset
   101
    IMPORT_C TInt ThreadSystemPermanentOrCritical( TThreadId aId, TBool aValue );
hgs
parents:
diff changeset
   102
        
hgs
parents:
diff changeset
   103
    IMPORT_C TInt EndThread( TThreadId aId, TMemSpyEndType aType );
hgs
parents:
diff changeset
   104
    
hgs
parents:
diff changeset
   105
    IMPORT_C TInt SwitchToThread( TThreadId aId, TBool aBrought );
hgs
parents:
diff changeset
   106
    
hgs
parents:
diff changeset
   107
    IMPORT_C TInt GetInfoItemType( TInt aIndex, TThreadId aId, TMemSpyThreadInfoItemType &aType );
hgs
parents:
diff changeset
   108
    
hgs
parents:
diff changeset
   109
    IMPORT_C void GetThreadInfoItems( RArray<CMemSpyApiThreadInfoItem*> &aInfoItems, TThreadId aId, TMemSpyThreadInfoItemType aType );
hgs
parents:
diff changeset
   110
    
hgs
parents:
diff changeset
   111
    //KernelObjects operations    
hgs
parents:
diff changeset
   112
    /**
hgs
parents:
diff changeset
   113
     * 
hgs
parents:
diff changeset
   114
     */
hgs
parents:
diff changeset
   115
    IMPORT_C TInt GetKernelObjects( RArray<CMemSpyApiKernelObject*> &aKernelObjects );
hgs
parents:
diff changeset
   116
    
hgs
parents:
diff changeset
   117
    IMPORT_C TInt GetKernelObjectItems( RArray<CMemSpyApiKernelObjectItem*> &aKernelObjectItems, TMemSpyDriverContainerType aForContainer );
hgs
parents:
diff changeset
   118
    
hgs
parents:
diff changeset
   119
    IMPORT_C void OutputAllContainerContents();
hgs
parents:
diff changeset
   120
    
hgs
parents:
diff changeset
   121
    /**
hgs
parents:
diff changeset
   122
     * 
hgs
parents:
diff changeset
   123
     */    
hgs
parents:
diff changeset
   124
	IMPORT_C CMemSpyApiHeap* GetHeap();
hgs
parents:
diff changeset
   125
	
hgs
parents:
diff changeset
   126
	IMPORT_C void DumpKernelHeap();
hgs
parents:
diff changeset
   127
    
hgs
parents:
diff changeset
   128
private:
hgs
parents:
diff changeset
   129
    TInt StartServer();
hgs
parents:
diff changeset
   130
    
hgs
parents:
diff changeset
   131
    void SetOutputTypeL(TMemSpyOutputType aOutputType);
hgs
parents:
diff changeset
   132
    };
hgs
parents:
diff changeset
   133
hgs
parents:
diff changeset
   134
#endif // MEMSPYSESSION_H