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: Tracing macros, 2nd generation

    15  *

    16  */

    17 

    18 #ifndef TRACE_H

    19 #define TRACE_H

    20 

    21 #include <e32base.h> // TCleanupItem

    22 #include "traceconfiguration.hrh"

    23 

    24 #ifdef TRACE_INTO_FILE

    25 #include <flogger.h> // RFileLogger

    26 #else

    27 #include <e32debug.h> // RDebug

    28 #endif

    29 

    30 //-----------------------------------------------------------------------------

    31 // Constants

    32 //-----------------------------------------------------------------------------

    33 //

    34 

    35 /**

    36 * Prefix trace macro to complete tracing with component name.

    37 * Returns TDesC which can be used directly with RDebug or RFileLogger.

    38 */

    39 #define _PREFIX_TRACE( aMsg ) TPtrC( (const TText*)L"[PDEngine]: " L##aMsg )

    40 

    41 /**

    42 * Prefix error trace

    43 */

    44 #define _PREFIX_ERROR( aMsg ) _PREFIX_TRACE( "[ERROR: %d]: " L##aMsg )

    45 

    46 /**

    47 * Prefix info trace.

    48 */

    49 #define _PREFIX_INFO( aMsg ) _PREFIX_TRACE( "[INFO]: " L##aMsg )

    50 

    51 /**

    52 * Prefix macro for strings

    53 */

    54 #define _PREFIX_CHAR( aMsg ) (const char*)"[PDEngine]: " ##aMsg

    55 

    56 /**

    57 * Define needed directories if TRACE_INTO_FILE macro in use

    58 */

    59 #ifdef TRACE_INTO_FILE

    60 

    61     _LIT( KDir, "PDEngine" );

    62     _LIT( KFile, "PDEngine_log.txt" );

    63     _LIT( KFullPath, "c:\\logs\\PDEngine\\" );

    64 

    65 #endif

    66 

    67 //-----------------------------------------------------------------------------

    68 // Error trace macros

    69 //-----------------------------------------------------------------------------

    70 //

    71 #ifdef ERROR_TRACE

    72 

    73     /**

    74     * Error trace definitions.

    75     */

    76     #ifdef TRACE_INTO_FILE

    77 

    78         #define ERROR( aErr, aMsg )\

    79             {\

    80             if( aErr < KErrNone )\

    81                 {\

    82                 RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_ERROR( aMsg ), aErr );\

    83                 }\

    84             }

    85         #define ERROR_1( aErr, aMsg, aP1 )\

    86             {\

    87             if( aErr < KErrNone )\

    88                 {\

    89                 RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_ERROR( aMsg ), aErr, aP1 );\

    90                 }\

    91             }

    92         #define ERROR_2( aErr, aMsg, aP1, aP2 )\

    93             {\

    94             if( aErr < KErrNone )\

    95                 {\

    96                 RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_ERROR( aMsg ), aErr, aP1, aP2 );\

    97                 }\

    98             }

    99         #define ERROR_3( aErr, aMsg, aP1, aP2, aP3 )\

   100             {\

   101             if( aErr < KErrNone )\

   102                 {\

   103                 RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_ERROR( aMsg ), aErr, aP1, aP2, aP3 );\

   104                 }\

   105             }

   106         #define ERROR_4( aErr, aMsg, aP1, aP2, aP3, aP4 )\

   107             {\

   108             if( aErr < KErrNone )\

   109                 {\

   110                 RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_ERROR( aMsg ), aErr, aP1, aP2, aP3, aP4 );\

   111                 }\

   112             }

   113         #define ERROR_5( aErr, aMsg, aP1, aP2, aP3, aP4, aP5 )\

   114             {\

   115             if( aErr < KErrNone )\

   116                 {\

   117                 RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_ERROR( aMsg ), aErr, aP1, aP2, aP3, aP4, aP5 );\

   118                 }\

   119             }

   120         #define ERROR_6( aErr, aMsg, aP1, aP2, aP3, aP4, aP5, aP6 )\

   121             {\

   122             if( aErr < KErrNone )\

   123                 {\

   124                 RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_ERROR( aMsg ), aErr, aP1, aP2, aP3, aP4, aP5 );\

   125                 }\

   126             }

   127             

   128     #else//TRACE_INTO_FILE not defined

   129     

   130         #define ERROR( aErr, aMsg )\

   131             {\

   132             if( aErr < KErrNone )\

   133                 {\

   134                 RDebug::Print( _PREFIX_ERROR( aMsg ), aErr );\

   135                 }\

   136             }

   137         #define ERROR_1( aErr, aMsg, aP1 )\

   138             {\

   139             if( aErr < KErrNone )\

   140                 {\

   141                 RDebug::Print( _PREFIX_ERROR( aMsg ), aErr, aP1 );\

   142                 }\

   143             }

   144         #define ERROR_2( aErr, aMsg, aP1, aP2 )\

   145             {\

   146             if( aErr < KErrNone )\

   147                 {\

   148                 RDebug::Print( _PREFIX_ERROR( aMsg ), aErr, aP1, aP2 );\

   149                 }\

   150             }

   151         #define ERROR_3( aErr, aMsg, aP1, aP2, aP3 )\

   152             {\

   153             if( aErr < KErrNone )\

   154                 {\

   155                 RDebug::Print( _PREFIX_ERROR( aMsg ), aErr, aP1, aP2, aP3 );\

   156                 }\

   157             }

   158         #define ERROR_4( aErr, aMsg, aP1, aP2, aP3, aP4 )\

   159             {\

   160             if( aErr < KErrNone )\

   161                 {\

   162                 RDebug::Print( _PREFIX_ERROR( aMsg ), aErr, aP1, aP2, aP3, aP4 );\

   163                 }\

   164             }

   165         #define ERROR_5( aErr, aMsg, aP1, aP2, aP3, aP4, aP5 )\

   166             {\

   167             if( aErr < KErrNone )\

   168                 {\

   169                 RDebug::Print( _PREFIX_ERROR( aMsg ), aErr, aP1, aP2, aP3, aP4, aP5 );\

   170                 }\

   171             }

   172         #define ERROR_6( aErr, aMsg, aP1, aP2, aP3, aP4, aP5, aP6 )\

   173             {\

   174             if( aErr < KErrNone )\

   175                 {\

   176                 RDebug::Print( _PREFIX_ERROR( aMsg ), aErr, aP1, aP2, aP3, aP4, aP5, aP6 );\

   177                 }\

   178             }

   179     

   180     #endif//TRACE_INTO_FILE

   181 

   182     #define ERROR_GEN( aMsg ) ERROR( KErrGeneral, aMsg )

   183     #define ERROR_GEN_1( aMsg, aP1 ) ERROR_1( KErrGeneral, aMsg, aP1 )

   184     #define ERROR_GEN_2( aMsg, aP1, aP2 ) ERROR_2( KErrGeneral, aMsg, aP1, aP2 )

   185     #define ERROR_GEN_3( aMsg, aP1, aP2, aP3 ) ERROR_3( KErrGeneral, aMsg, aP1, aP3 )

   186     #define ERROR_GEN_4( aMsg, aP1, aP2, aP3, aP4 ) ERROR_4( KErrGeneral, aMsg, aP1, aP3, aP4 )

   187     #define ERROR_GEN_5( aMsg, aP1, aP2, aP3, aP4, aP5 ) ERROR_5( KErrGeneral, aMsg, aP1, aP3, aP4, aP5 )

   188     #define ERROR_GEN_6( aMsg, aP1, aP2, aP3, aP4, aP5, aP6 ) ERROR_6( KErrGeneral, aMsg, aP1, aP3, aP4, aP5, aP6 )

   189 

   190 #else//ERROR_TRACE not defined

   191 

   192     #define ERROR( aErr, aMsg )

   193     #define ERROR_1( aErr, aMsg, aP1 )

   194     #define ERROR_2( aErr, aMsg, aP1, aP2 )

   195     #define ERROR_3( aErr, aMsg, aP1, aP2, aP3 )

   196     #define ERROR_4( aErr, aMsg, aP1, aP2, aP3, aP4 )

   197     #define ERROR_5( aErr, aMsg, aP1, aP2, aP3, aP4, aP5 )

   198     #define ERROR_6( aErr, aMsg, aP1, aP2, aP3, aP4, aP5, aP6 )

   199 

   200     #define ERROR_GEN( aMsg )

   201     #define ERROR_GEN_1( aMsg, aP1 )

   202     #define ERROR_GEN_2( aMsg, aP1, aP2 )

   203     #define ERROR_GEN_3( aMsg, aP1, aP2, aP3 )

   204     #define ERROR_GEN_4( aMsg, aP1, aP2, aP3, aP4 )

   205     #define ERROR_GEN_5( aMsg, aP1, aP2, aP3, aP4, aP5 )

   206     #define ERROR_GEN_6( aMsg, aP1, aP2, aP3, aP4, aP5, aP6 )

   207 

   208 #endif//ERROR_TRACE

   209 

   210 //-----------------------------------------------------------------------------

   211 // TRAP and trace with error macro

   212 //-----------------------------------------------------------------------------

   213 //

   214 #define TRAP_ERROR( aErr, aFunction )\

   215     {\

   216     TRAP( aErr, aFunction );\

   217     TPtrC8 file( ( TText8* )__FILE__ );\

   218     ERROR_2( aErr, "Trapped leave in '%S' line %d", &file, __LINE__);\

   219     }

   220 

   221 //-----------------------------------------------------------------------------

   222 // Info trace macros

   223 //-----------------------------------------------------------------------------

   224 //

   225 #ifdef INFO_TRACE

   226 

   227     /**

   228     * Info log message definitions.

   229     */

   230     #ifdef TRACE_INTO_FILE

   231     

   232         #define INFO( aMsg )\

   233             {\

   234             RFileLogger::Write( KDir, KFile, EFileLoggingModeAppend, _PREFIX_INFO( aMsg ) );\

   235             }

   236         #define INFO_1( aMsg, aP1 )\

   237             {\

   238             RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_INFO( aMsg ), aP1 );\

   239             }

   240         #define INFO_2( aMsg, aP1, aP2 )\

   241             {\

   242             RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_INFO( aMsg ), aP1, aP2 );\

   243             }

   244         #define INFO_3( aMsg, aP1, aP2, aP3 )\

   245             {\

   246             RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_INFO( aMsg ), aP1, aP2, aP3 );\

   247             }

   248         #define INFO_4( aMsg, aP1, aP2, aP3, aP4 )\

   249             {\

   250             RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_INFO( aMsg ), aP1, aP2, aP3, aP4 );\

   251             }

   252         #define INFO_5( aMsg, aP1, aP2, aP3, aP4, aP5 )\

   253             {\

   254             RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_INFO( aMsg ), aP1, aP2, aP3, aP4, aP5 );\

   255             }

   256         #define INFO_6( aMsg, aP1, aP2, aP3, aP4, aP5, aP6 )\

   257             {\

   258             RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, _PREFIX_INFO( aMsg ), aP1, aP2, aP3, aP4, aP5, aP6 );\

   259             }

   260 

   261     #else//TRACE_INTO_FILE not defined

   262 

   263         #define INFO( aMsg )\

   264             {\

   265             RDebug::Print( _PREFIX_INFO( aMsg ) );\

   266             }

   267         #define INFO_1( aMsg, aP1 )\

   268             {\

   269             RDebug::Print( _PREFIX_INFO( aMsg ), aP1 );\

   270             }

   271         #define INFO_2( aMsg, aP1, aP2 )\

   272             {\

   273             RDebug::Print( _PREFIX_INFO( aMsg ), aP1, aP2 );\

   274             }

   275         #define INFO_3( aMsg, aP1, aP2, aP3 )\

   276             {\

   277             RDebug::Print( _PREFIX_INFO( aMsg ), aP1, aP2, aP3 );\

   278             }

   279         #define INFO_4( aMsg, aP1, aP2, aP3, aP4 )\

   280             {\

   281             RDebug::Print( _PREFIX_INFO( aMsg ), aP1, aP2, aP3, aP4 );\

   282             }

   283         #define INFO_5( aMsg, aP1, aP2, aP3, aP4, aP5 )\

   284             {\

   285             RDebug::Print( _PREFIX_INFO( aMsg ), aP1, aP2, aP3, aP4, aP5 );\

   286             }

   287         #define INFO_6( aMsg, aP1, aP2, aP3, aP4, aP5, aP6 )\

   288             {\

   289             RDebug::Print( _PREFIX_INFO( aMsg ), aP1, aP2, aP3, aP4, aP5, aP6 );\

   290             }

   291 

   292     #endif//TRACE_INTO_FILE

   293         

   294 #else//INFO_TRACE not defined

   295 

   296     #define INFO( aMsg )

   297     #define INFO_1( aMsg, aP1 )

   298     #define INFO_2( aMsg, aP1, aP2 )

   299     #define INFO_3( aMsg, aP1, aP2, aP3 )

   300     #define INFO_4( aMsg, aP1, aP2, aP3, aP4 )

   301     #define INFO_5( aMsg, aP1, aP2, aP3, aP4, aP5 )

   302     #define INFO_6( aMsg, aP1, aP2, aP3, aP4, aP5, aP6 )

   303 

   304 #endif//INFO_TRACE

   305 

   306 //-----------------------------------------------------------------------------

   307 // Trace current client thread name and process id

   308 //-----------------------------------------------------------------------------

   309 //

   310 #ifdef CLIENT_TRACE

   311 

   312     #define CLIENT_PROCESS\

   313         {\

   314         CLIENT_PROCESS_PREFIX( "" );\

   315         }        

   316 

   317     #define CLIENT_PROCESS_PREFIX( aPrefix )\

   318         {\

   319         RProcess process;\

   320         TPtrC name( process.Name() );\

   321         TSecureId sid( process.SecureId() );\

   322         TPtrC prefix( _S( aPrefix ) );\

   323         if( prefix.Length() )\

   324             {\

   325             INFO_3( "%S: CLIENT - Name: [%S], Sid: [0x%x]", &prefix, &name, sid.iId );\

   326             }\

   327         else\

   328             {\

   329             INFO_2( "CLIENT - Name: [%S], Sid: [0x%x]", &name, sid.iId );\

   330             }\

   331         process.Close();\

   332         }        

   333 

   334     #define CLIENT_MESSAGE( aMsg )\

   335         {\

   336         CLIENT_MESSAGE_PREFIX( "", aMsg );\

   337         }

   338 

   339     #define CLIENT_MESSAGE_PREFIX( aPrefix, aMsg )\

   340         {\

   341         RThread thread;\

   342         TInt err = aMsg.Client( thread );\

   343         if( err == KErrNone )\

   344             {\

   345             RProcess process;\

   346             err = thread.Process( process );\

   347             if( err == KErrNone )\

   348                 {\

   349                 TPtrC threadName( thread.Name() );\

   350                 TUid processUid( process.SecureId() );\

   351                 TPtrC prefix( _S( aPrefix ) );\

   352                 if( prefix.Length() )\

   353                     {\

   354                     INFO_4( "%S: MSG - Name: [%S], Sid: [0x%x], Message ID: [%d]",\

   355                         &prefix,\

   356                         &threadName,\

   357                         processUid,\

   358                         aMsg.Function() );\

   359                     }\

   360                 else\

   361                     {\

   362                     INFO_3( "MSG - Name: [%S], Sid: [0x%x], Message ID: [%d]",\

   363                         &threadName,\

   364                         processUid,\

   365                         aMsg.Function() );\

   366                     }\

   367                 }\

   368             process.Close();\

   369             }\

   370         thread.Close();\

   371         }

   372 

   373 #else

   374 

   375     #define CLIENT_PROCESS

   376     #define CLIENT_PROCESS_PREFIX( aPrefix )

   377     #define CLIENT_MESSAGE( aMsg )

   378     #define CLIENT_MESSAGE_PREFIX( aPrefix, aMsg )

   379 

   380 #endif

   381 

   382 //-----------------------------------------------------------------------------

   383 // Function trace macros

   384 //-----------------------------------------------------------------------------

   385 //

   386 #ifdef FUNC_TRACE

   387 

   388     /**

   389     * Function logging definitions.

   390     */

   391     #ifdef TRACE_INTO_FILE

   392     

   393         #define FUNC( aMsg, aP1 )\

   394             {\

   395             TPtrC8 trace( _S8( aMsg ) );\

   396             RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend, trace, aP1 );\

   397             }\

   398     

   399     #else//TRACE_INTO_FILE not defined

   400     

   401         #define FUNC( aMsg, aP1 )\

   402             {\

   403             RDebug::Printf( aMsg, aP1 );\

   404             }\

   405     

   406     #endif//TRACE_INTO_FILE

   407         

   408     /**

   409     * Function trace helper class.

   410     * 

   411     * NOTE:

   412     * LC -methods cannot be trapped. Therefore if LC -method leaves

   413     * END trace is used instead of LEAVE trace.

   414     * If you have an idea how to round this problem please tell.

   415     */

   416     _LIT8( KFuncNameTerminator, "(" );

   417     _LIT8( KFuncLeavePatternL, "L" );

   418     class TFuncLog

   419         {

   420         public:

   421             static void Cleanup( TAny* aPtr )

   422                 {

   423                 TFuncLog* self = static_cast< TFuncLog* >( aPtr );

   424                 self->iLeft = ETrue;

   425                 FUNC( _PREFIX_CHAR("%S-LEAVE"), &self->iFunc ); // Leave detected

   426                 }

   427             inline TFuncLog( const char* aFunc ) :

   428                     iFunc( aFunc ? _S8( aFunc ) : _S8("") ),

   429                     iLeft( EFalse ),

   430                     iCleanupItem( Cleanup, this ),

   431                     iCanLeave( EFalse )

   432                 {

   433                 TInt pos( iFunc.Find( KFuncNameTerminator ) );

   434                 if( pos != KErrNotFound )

   435                     {

   436                     iFunc.Set( iFunc.Left( pos ) );

   437                     iCanLeave = !iFunc.Right( KFuncLeavePatternL().Length() ).Compare( KFuncLeavePatternL );

   438                     if ( iCanLeave )

   439                         {

   440                         CleanupStack::PushL( iCleanupItem ); // Ignore warnings

   441                         }

   442                     }

   443                 FUNC( _PREFIX_CHAR("%S-START"), &iFunc );

   444                 }

   445 

   446             inline ~TFuncLog()

   447                 {

   448                 if ( !iLeft )

   449                     {

   450                     if ( iCanLeave )

   451                         {

   452                         CleanupStack::Pop( this ); // Pop the cleanup item

   453                         }

   454                     FUNC( _PREFIX_CHAR("%S-END"), &iFunc ); // Normally finished

   455                     }

   456                 }

   457 

   458         private: // Data

   459             TPtrC8 iFunc;

   460             TBool iLeft;

   461             TCleanupItem iCleanupItem;

   462             TBool iCanLeave;

   463         };

   464     #define FUNC_LOG TFuncLog _fl( __PRETTY_FUNCTION__ );

   465     

   466 #else//FUNC_TRACE not defined

   467 

   468     #define FUNC_LOG

   469 

   470 #endif//FUNC_TRACE

   471 

   472 //-----------------------------------------------------------------------------

   473 // Timestamp trace macros

   474 //-----------------------------------------------------------------------------

   475 //

   476 #ifdef TIMESTAMP_TRACE

   477 

   478     #ifdef TRACE_INTO_FILE

   479     

   480         #define TIMESTAMP( aCaption )\

   481             {\

   482             TTime t;\

   483             t.HomeTime();\

   484             TDateTime dt = t.DateTime();\

   485             _LIT( KCaption, aCaption );\

   486             RFileLogger::WriteFormat( KDir, KFile, EFileLoggingModeAppend,\

   487                 _PREFIX_TRACE("[TIMESTAMP] %S %d:%02d:%02d.%d us"),\

   488                     &KCaption, dt.Hour(), dt.Minute(), dt.Second(), dt.MicroSecond() );\

   489             }

   490 

   491     #else//TRACE_INTO_FILE not defined

   492     

   493         #define TIMESTAMP( aCaption )\

   494             {\

   495             TTime t;\

   496             t.HomeTime();\

   497             TDateTime dt = t.DateTime();\

   498             _LIT( KCaption, aCaption );\

   499             RDebug::Print( _PREFIX_TRACE("[TIMESTAMP] %S %d:%02d:%02d.%d us"),\

   500                 &KCaption, dt.Hour(), dt.Minute(), dt.Second(), dt.MicroSecond() );\

   501             }

   502 

   503     #endif//TRACE_INTO_FILE

   504 

   505 #else//TIMESTAMP_TRACE not defined

   506 

   507     #define TIMESTAMP( aCaption )

   508 

   509 #endif//TIMESTAMP_TRACE

   510 

   511 #endif