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:  Common declarations/definitions for Analyze Tool.

    15 *

    16 */

    17 

    18 

    19 #ifndef ATCOMMON_H_

    20 #define ATCOMMON_H_

    21 

    22 // CONSTANTS

    23 const TInt KATMaxCallstackLength = 256;

    24 const TInt KATMaxFreeCallstackLength = 256;

    25 const TInt KATMaxSubtestIdLength = 256;

    26 

    27 // The following constants only limit the configuration UI.

    28 // The bigger the number is, the more space will be allocated run-time

    29 // by the client. So, change with care.

    30 const TInt KATMaxProcesses = 20;

    31 const TInt KATMaxDlls = 30;

    32 

    33 // Constants defining call stack address range in multiple memory model.

    34 const TInt32 KATMultipleMemoryModelLowLimit = 0x70000000;

    35 const TInt32 KATMultipleMemoryModelHighLimit = 0x90000000;

    36 

    37 

    38 // CLASS DECLARATIONS

    39 

    40 /**

    41 *  A class for storing process information

    42 */

    43 class TATProcessInfo

    44     {

    45     public:

    46     

    47         /** The ID of the process. */

    48         TUint iProcessId;

    49         

    50         /** The name of the process. */

    51         TBuf8<KMaxProcessName> iProcessName;

    52         

    53         /** The starting time of the process. */

    54         TInt64 iStartTime;

    55     };

    56 

    57 

    58 // ENUMERATIONS

    59 

    60 /**

    61 *  Enumeration for different logging modes of Analyze Tool 

    62 */

    63 enum TATLogOption

    64     {

    65     /** Using the default. */

    66     EATUseDefault = 0,

    67     

    68     /** Logging to a file in S60. */

    69     EATLogToFile,

    70     

    71     /** Logging to debug channel. */

    72     EATLogToTrace,

    73     

    74     /** Logging to debug channel bypassing storage server. */

    75     EATLogToTraceFast,

    76     

    77     /** Logging switched off. */

    78     EATLoggingOff

    79     };

    80 

    81 /**

    82 *  Class which supports interfacing with AnalyzeTool exported

    83 *  functions. Mainly meant for STIF integration.

    84 */

    85 class AnalyzeToolInterface

    86     {

    87     public:

    88 

    89         /**

    90         * This function starts subtest with a given name.

    91         * @param aSubtestId The name identifying this particular sub test. The length

    92         *   of this descriptor must not be greater than KATMaxSubtestIdLength, or

    93         *   otherwise the method raises a STSEClient: 2 panic.

    94         */

    95         IMPORT_C static void StartSubTest( const TDesC8& aSubtestId );

    96 

    97         /**

    98         * This function stops a subtest with a given name.

    99         * @param aSubtestId The name identifying this particular sub test. The length

   100         *   of this descriptor must not be greater than KATMaxSubtestIdLength, or

   101         *   otherwise the method raises a STSEClient: 2 panic. 

   102         */   

   103         IMPORT_C static void StopSubTest( const TDesC8& aSubtestId );

   104 

   105     };

   106     

   107 

   108 #endif /*ATCOMMON_H_*/