os/kernelhwsrv/kerneltest/e32utils/trace/btrace.cpp
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of the License "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
// e32utils\trace\btrace.cpp
sl@0
    15
// 
sl@0
    16
//
sl@0
    17
sl@0
    18
#include <e32cons.h>
sl@0
    19
#include <f32file.h>
sl@0
    20
#include <d32btrace.h>
sl@0
    21
sl@0
    22
CConsoleBase* Console;
sl@0
    23
extern RBTrace Trace;
sl@0
    24
sl@0
    25
#undef ASSERT
sl@0
    26
#define ASSERT(c) (void)((c)||(AssertFailed(__LINE__)))
sl@0
    27
sl@0
    28
TInt AssertFailed(TInt aLine)
sl@0
    29
	{
sl@0
    30
	_LIT(KPanicCategory,"ASSERT");
sl@0
    31
	User::Panic(KPanicCategory,aLine);
sl@0
    32
	return 0;
sl@0
    33
	}
sl@0
    34
sl@0
    35
sl@0
    36
int strlen(const char* string)
sl@0
    37
	{
sl@0
    38
	int len=0;
sl@0
    39
	while(string[len]) ++len;
sl@0
    40
	return len;
sl@0
    41
	}
sl@0
    42
sl@0
    43
sl@0
    44
class TDesTruncate : public TDes8Overflow { void Overflow(TDes8&) {}; } IgnoreOverflow;
sl@0
    45
sl@0
    46
void printf(const char* aFormat,...)
sl@0
    47
	{
sl@0
    48
	TPtrC8 formatDes((TUint8*)aFormat,strlen(aFormat));
sl@0
    49
	VA_LIST list;
sl@0
    50
	VA_START(list, aFormat);
sl@0
    51
	TBuf16<0x100> buffer;
sl@0
    52
	// coverity[uninit_use_in_call]
sl@0
    53
	((TDes8&)buffer).AppendFormatList(formatDes, list, &IgnoreOverflow);
sl@0
    54
	Console->Write(((TDes8&)buffer).Expand());
sl@0
    55
	}
sl@0
    56
sl@0
    57
sl@0
    58
TInt getch()
sl@0
    59
	{
sl@0
    60
	TRequestStatus keyStat;
sl@0
    61
	Console->Read(keyStat);
sl@0
    62
	User::WaitForRequest(keyStat);
sl@0
    63
	return Console->KeyCode();
sl@0
    64
	}
sl@0
    65
sl@0
    66
sl@0
    67
TInt getch(TInt aTimeout)
sl@0
    68
	{
sl@0
    69
	TRequestStatus keyStat;
sl@0
    70
	Console->Read(keyStat);
sl@0
    71
	RTimer timer;
sl@0
    72
	TInt r=timer.CreateLocal();
sl@0
    73
	ASSERT(r==KErrNone);
sl@0
    74
	TRequestStatus timerStat;
sl@0
    75
	timer.After(timerStat,aTimeout*1000000);
sl@0
    76
	User::WaitForRequest(timerStat,keyStat);
sl@0
    77
	TInt key = -1;
sl@0
    78
	if(keyStat!=KRequestPending)
sl@0
    79
		key = Console->KeyCode();
sl@0
    80
	timer.Cancel();
sl@0
    81
	Console->ReadCancel();
sl@0
    82
	User::WaitForAnyRequest();
sl@0
    83
	return key;
sl@0
    84
	}
sl@0
    85
sl@0
    86
sl@0
    87
int Main(int argc, char** argv);
sl@0
    88
sl@0
    89
sl@0
    90
void exit_btrace(int result)
sl@0
    91
	{
sl@0
    92
	User::Exit(result);
sl@0
    93
	}
sl@0
    94
sl@0
    95
sl@0
    96
TInt E32Main()
sl@0
    97
	{
sl@0
    98
	// create console...
sl@0
    99
	TFileName exeFile = RProcess().FileName();
sl@0
   100
	TRAPD(r, Console = Console::NewL(exeFile,TSize(KConsFullScreen,KConsFullScreen)));
sl@0
   101
	ASSERT(r==KErrNone);
sl@0
   102
sl@0
   103
	// get command-line...
sl@0
   104
	RBuf clDes;
sl@0
   105
	ASSERT(clDes.Create(User::CommandLineLength()+1)==KErrNone);
sl@0
   106
	User::CommandLine(clDes);
sl@0
   107
	char* cl = (char*)clDes.Collapse().PtrZ(); // convert to null terminated C string
sl@0
   108
sl@0
   109
	// split up args...
sl@0
   110
	RPointerArray<TAny> argArray;
sl@0
   111
	ASSERT(KErrNone==argArray.Append(exeFile.Collapse().Ptr())); // first arg is program name
sl@0
   112
	for(;;)
sl@0
   113
		{
sl@0
   114
		while((unsigned)(*cl-1)<(unsigned)' ') ++cl; // skip whitespace
sl@0
   115
		if(!*cl) break;
sl@0
   116
		ASSERT(KErrNone==argArray.Append(cl));
sl@0
   117
		while(*++cl>' ') {}; // skip non-whitespace
sl@0
   118
		if(!*cl) break;
sl@0
   119
		*cl++ = 0; // add null terminator to arg
sl@0
   120
		}
sl@0
   121
sl@0
   122
	// call main...
sl@0
   123
	return Main(argArray.Count(),(char**)&argArray[0]);
sl@0
   124
	}
sl@0
   125
sl@0
   126
sl@0
   127
int Error()
sl@0
   128
	{
sl@0
   129
	getch(5); // pause for a while
sl@0
   130
	exit_btrace(-1);
sl@0
   131
	return 0;
sl@0
   132
	}
sl@0
   133
sl@0
   134
sl@0
   135
char* FileName = 0;
sl@0
   136
char* PrimaryFilterArg = NULL;
sl@0
   137
bool SetFilter2 = false;
sl@0
   138
RArray<TUint32> Filter2;
sl@0
   139
bool SetMode = false;
sl@0
   140
unsigned Mode = 0;
sl@0
   141
bool SetBufferSize = false;
sl@0
   142
unsigned BufferSize = 0;
sl@0
   143
bool DumpToDebugPort = false;
sl@0
   144
TInt AnalysisLevel = 0;
sl@0
   145
bool Analyse = false;
sl@0
   146
bool DiscardOldData = true;
sl@0
   147
sl@0
   148
RFs Fs;
sl@0
   149
RFile File;
sl@0
   150
void RePrime();
sl@0
   151
sl@0
   152
void Dump()
sl@0
   153
	{
sl@0
   154
	TUint oldMode = Trace.Mode();
sl@0
   155
	Trace.SetMode(0); // turn off trace capture while we dump
sl@0
   156
sl@0
   157
	TUint8* data;
sl@0
   158
	TInt size;
sl@0
   159
	while((size=Trace.GetData(data))!=0)
sl@0
   160
		{
sl@0
   161
		if(FileName)
sl@0
   162
			{
sl@0
   163
			TInt r=File.Write(TPtrC8(data,size));
sl@0
   164
			if(r!=KErrNone)
sl@0
   165
				{
sl@0
   166
				printf("Error writing to file (1). (Code %d)",r);
sl@0
   167
				Error();
sl@0
   168
				}
sl@0
   169
			}
sl@0
   170
		if(DumpToDebugPort)
sl@0
   171
			{
sl@0
   172
			do
sl@0
   173
				{
sl@0
   174
				int s = size;
sl@0
   175
				if(s>256) s=256;
sl@0
   176
				RDebug::RawPrint(TPtrC8(data,s));
sl@0
   177
				data += s;
sl@0
   178
				size -= s;
sl@0
   179
				}
sl@0
   180
			while(size);
sl@0
   181
			}
sl@0
   182
		Trace.DataUsed();
sl@0
   183
		}
sl@0
   184
	// Flush the file here so we can be sure to detect whether the btrace data 
sl@0
   185
	// has been written successfully to the file.
sl@0
   186
	if (FileName)
sl@0
   187
		{
sl@0
   188
		// Flush the file here so we can be sure to detect whether the btrace data 
sl@0
   189
		// has been written successfully to the file.
sl@0
   190
		TInt r = File.Flush();
sl@0
   191
		if (r != KErrNone)
sl@0
   192
			{
sl@0
   193
			printf("Error writing to file (2). (Code %d)",r);
sl@0
   194
			Error();
sl@0
   195
			}
sl@0
   196
		File.Close();
sl@0
   197
		}
sl@0
   198
sl@0
   199
	Trace.SetMode(oldMode);
sl@0
   200
	RePrime();
sl@0
   201
	}
sl@0
   202
sl@0
   203
bool SetFilter(char* args);
sl@0
   204
void DoAnalyse(TInt aAnalysisLevel);
sl@0
   205
sl@0
   206
int DoCommand()
sl@0
   207
	{
sl@0
   208
sl@0
   209
	if(SetBufferSize)
sl@0
   210
		Trace.ResizeBuffer(BufferSize*1024);
sl@0
   211
sl@0
   212
	if(SetMode)
sl@0
   213
		Trace.SetMode(Mode);
sl@0
   214
sl@0
   215
	if (PrimaryFilterArg)
sl@0
   216
		SetFilter(PrimaryFilterArg);
sl@0
   217
sl@0
   218
	if(SetFilter2)
sl@0
   219
		{
sl@0
   220
		TInt r = Trace.SetFilter2(&Filter2[0], Filter2.Count());
sl@0
   221
		if(r<0)
sl@0
   222
			{
sl@0
   223
			printf("Error setting secondary filter. (%d)",r);
sl@0
   224
			Error();
sl@0
   225
			}
sl@0
   226
		if (DiscardOldData)
sl@0
   227
			Trace.Empty(); // discard old data
sl@0
   228
		}
sl@0
   229
sl@0
   230
	if(FileName || DumpToDebugPort)
sl@0
   231
		Dump();
sl@0
   232
sl@0
   233
	if(Analyse)
sl@0
   234
		DoAnalyse(AnalysisLevel);
sl@0
   235
sl@0
   236
	return 0;
sl@0
   237
	}
sl@0
   238
sl@0
   239
sl@0
   240
unsigned int ParseDecimal(char*& args)
sl@0
   241
	{
sl@0
   242
	unsigned int i=0;
sl@0
   243
	unsigned int d;
sl@0
   244
	while((d=*args-'0')<10u)
sl@0
   245
		{
sl@0
   246
		++args;
sl@0
   247
		i = i*10+d;
sl@0
   248
		}
sl@0
   249
	return i;
sl@0
   250
	}
sl@0
   251
sl@0
   252
sl@0
   253
bool SetFilter(char* args)
sl@0
   254
	{
sl@0
   255
	unsigned i;
sl@0
   256
	// Turn everything off and discard old data
sl@0
   257
	for(i=0; i<256; i++)
sl@0
   258
		{			
sl@0
   259
		Trace.SetFilter(i,0); 
sl@0
   260
		}
sl@0
   261
	if (DiscardOldData)
sl@0
   262
		Trace.Empty();
sl@0
   263
sl@0
   264
	// Iterate over comma-seperated filter numbers
sl@0
   265
	bool set_metatrace = false;
sl@0
   266
	while((unsigned)(*args-'0')<10u)
sl@0
   267
		{
sl@0
   268
		unsigned int i = ParseDecimal(args);
sl@0
   269
		if(i>=256)
sl@0
   270
			{
sl@0
   271
			printf("Primary filter value out of range");
sl@0
   272
			Error();
sl@0
   273
			}
sl@0
   274
		if (!set_metatrace) 
sl@0
   275
			{
sl@0
   276
			set_metatrace = true;
sl@0
   277
			Trace.SetFilter(BTrace::EMetaTrace,1);
sl@0
   278
			}
sl@0
   279
		Trace.SetFilter(i,1);
sl@0
   280
		if(*args==',')
sl@0
   281
			++args;
sl@0
   282
		}
sl@0
   283
	return (*args==0);
sl@0
   284
	}
sl@0
   285
sl@0
   286
sl@0
   287
bool ParseFilter2(char* args)
sl@0
   288
	{
sl@0
   289
	while((unsigned)(*args-'0') < 10u)
sl@0
   290
		{
sl@0
   291
		unsigned int i = ParseDecimal(args);
sl@0
   292
		TInt r = Filter2.Append(i);
sl@0
   293
		if(r<0)
sl@0
   294
			{
sl@0
   295
			printf("Error parsing secondary filter. (%d)",r);
sl@0
   296
			Error();
sl@0
   297
			}
sl@0
   298
		if(*args==',')
sl@0
   299
			{
sl@0
   300
			++args;
sl@0
   301
			}
sl@0
   302
		}
sl@0
   303
	return SetFilter2=(*args==0);
sl@0
   304
	}
sl@0
   305
sl@0
   306
sl@0
   307
bool ParseMode(char* args)
sl@0
   308
	{
sl@0
   309
	Mode = ParseDecimal(args);
sl@0
   310
	return SetMode=(*args==0);
sl@0
   311
	}
sl@0
   312
sl@0
   313
sl@0
   314
bool ParseBufferSize(char* args)
sl@0
   315
	{
sl@0
   316
	BufferSize = ParseDecimal(args);
sl@0
   317
	return SetBufferSize=(*args==0);
sl@0
   318
	}
sl@0
   319
sl@0
   320
sl@0
   321
bool ParseAnalyse(char* args)
sl@0
   322
	{
sl@0
   323
	AnalysisLevel = ParseDecimal(args);
sl@0
   324
	return Analyse=(*args==0);
sl@0
   325
	}
sl@0
   326
sl@0
   327
sl@0
   328
int CreateFile(char* name)
sl@0
   329
	{
sl@0
   330
	if(FileName)
sl@0
   331
		{
sl@0
   332
		printf("Too many arguments");
sl@0
   333
		return Error();
sl@0
   334
		}
sl@0
   335
sl@0
   336
	FileName = name;
sl@0
   337
	unsigned nameLen = strlen(name);
sl@0
   338
	if(nameLen>(unsigned)KMaxFileName)
sl@0
   339
		{
sl@0
   340
		printf("File name too long.\n");
sl@0
   341
		return Error();
sl@0
   342
		}
sl@0
   343
sl@0
   344
	TInt r;
sl@0
   345
	if(!Fs.Handle())
sl@0
   346
		{
sl@0
   347
		r = Fs.Connect();
sl@0
   348
		if(r!=KErrNone)
sl@0
   349
			{
sl@0
   350
			printf("Couldn't connect to file server. (%d)\n",r);
sl@0
   351
			return Error();
sl@0
   352
			}
sl@0
   353
		}
sl@0
   354
sl@0
   355
	TBuf8<KMaxFileName*2> fn = TPtrC8((TUint8*)name,nameLen);
sl@0
   356
	r = File.Replace(Fs,fn.Expand(),EFileWrite);
sl@0
   357
	if(r!=KErrNone)
sl@0
   358
		{
sl@0
   359
		printf("Couldn't create file: %s. (%d)\n",name,r);
sl@0
   360
		return Error();
sl@0
   361
		}
sl@0
   362
sl@0
   363
	return 0;
sl@0
   364
	}
sl@0
   365
sl@0
   366
sl@0
   367
int Help()
sl@0
   368
	{
sl@0
   369
	printf("Usage: BTRACE [options] [filename]\n");
sl@0
   370
	printf("\n");
sl@0
   371
	printf("Options:\n");
sl@0
   372
	printf("-fLIST   Set primary filter to a LIST of comma separated category numbers.\n");
sl@0
   373
	printf("         This argument may be used more than once e.g. -f1,22,3 -f44 \n");
sl@0
   374
	printf("-sLIST   Set secondary filter to a LIST of comma separated UID values.\n");
sl@0
   375
	printf("         This argument may be used more than once e.g. -s1221,22,343243 -s3242344 \n");
sl@0
   376
	printf("-mN      Set capture mode to value N (See RBTrace::TMode)\n");
sl@0
   377
	printf("-bN      Set capture buffer size to N kBytes\n");
sl@0
   378
	printf("-d       Dump contents of trace buffer to debug port\n");
sl@0
   379
	printf("-tsNAME  Output a test measurement start trace with text NAME. This text\n");
sl@0
   380
	printf("         may be between 0 and 80 non-whitespace characters.\n");
sl@0
   381
	printf("-te      Output a test measurement end trace\n");
sl@0
   382
	printf("-aLEVEL  Analyse trace buffer and produce a report. UNSUPPORTED!\n");
sl@0
   383
	printf("-k       Keep old contents of trace buffer when enabling a new filter\n");
sl@0
   384
	printf("filename File to dump contents of trace buffer to.\n");
sl@0
   385
	getch();
sl@0
   386
	return 0;
sl@0
   387
	}
sl@0
   388
sl@0
   389
sl@0
   390
int Main(int argc, char** argv)
sl@0
   391
	{
sl@0
   392
	if(argc<=1)
sl@0
   393
		return Help();
sl@0
   394
sl@0
   395
	TInt r = Trace.Open();
sl@0
   396
	if(r!=KErrNone)
sl@0
   397
		{
sl@0
   398
		printf("Couldn't open BTrace driver. (Code %d)",r);
sl@0
   399
		Error();
sl@0
   400
		return r;
sl@0
   401
		}
sl@0
   402
sl@0
   403
	char* a;
sl@0
   404
	while(--argc)
sl@0
   405
		{
sl@0
   406
		a = *++argv;
sl@0
   407
		if(a[0]!='-')
sl@0
   408
			{
sl@0
   409
			CreateFile(a);
sl@0
   410
			continue;
sl@0
   411
			}
sl@0
   412
sl@0
   413
		int r=0;
sl@0
   414
		switch(a[1])
sl@0
   415
			{
sl@0
   416
		case 'f': PrimaryFilterArg = a+2; r = true; break;
sl@0
   417
		case 's': r=ParseFilter2(a+2); break;
sl@0
   418
		case 'm': r=ParseMode(a+2); break;
sl@0
   419
		case 'b': r=ParseBufferSize(a+2); break;
sl@0
   420
		case 'd': r=a[2]==0; DumpToDebugPort = true; break;
sl@0
   421
		case 't': 
sl@0
   422
			{
sl@0
   423
			if (a[2]=='s') 
sl@0
   424
				{
sl@0
   425
				TUint cch=strlen(a);
sl@0
   426
				if (cch > KMaxBTraceDataArray)
sl@0
   427
					cch = KMaxBTraceDataArray;
sl@0
   428
				int buff[KMaxBTraceDataArray/sizeof(int)];
sl@0
   429
				a+=3;
sl@0
   430
				memcpy(buff, a, cch);
sl@0
   431
				BTraceContextN(BTrace::EMetaTrace, BTrace::EMetaTraceMeasurementStart, 0,0, buff, cch);
sl@0
   432
				r=1;
sl@0
   433
				}
sl@0
   434
			else if (a[2]=='e')
sl@0
   435
				{
sl@0
   436
				BTraceContext8(BTrace::EMetaTrace, BTrace::EMetaTraceMeasurementEnd, 0,0);
sl@0
   437
				r=1;
sl@0
   438
				}
sl@0
   439
			}
sl@0
   440
			break;
sl@0
   441
		case 'a': r=ParseAnalyse(a+2); break;
sl@0
   442
		case 'k': DiscardOldData = false; r = true; break;
sl@0
   443
		default: break;
sl@0
   444
			}
sl@0
   445
sl@0
   446
		if(!r)
sl@0
   447
			{
sl@0
   448
			printf("Bad command line argument: %s",a);
sl@0
   449
			Error();
sl@0
   450
			}
sl@0
   451
		}
sl@0
   452
sl@0
   453
	return DoCommand();
sl@0
   454
	}
sl@0
   455