summaryrefslogtreecommitdiff
path: root/Documentation/Profiling/davbr-blog-archive/samples/PlugInToYourProfiler.cpp
blob: 561f5916635f811cdf259acc8696a23cb0a245bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
// This blog post originally appeared on David Broman's blog on 10/13/2005

#include "SigFormat.cpp"
 
 
 // ---------------------------------------------------------------------
 // ---------------------------------------------------------------------
 // This file does not compile on its own. It contains snippets of code you can add
 // to a working profiler, so that your profiler will invoke instances of the SigFormat
 // object to parse and pretty-print all the types in all modules as they're loaded.
 //
 // The functions are ordered from callees to callers (so no forward declarations are
 // necessary). If you prefer a top-down approach to learning code, then start
 // at the bottom of the file.
 // ---------------------------------------------------------------------
 // ---------------------------------------------------------------------
 
 
 // ****************************************************************
 // HELPERS TO READ THROUGH METADATA, FIND SIGNATURES, AND INVOKE THE PARSER
 // ****************************************************************
 
 // Simple wrapper to create an instance of SigFormat and invoke it
HRESULT DoParse(sig_byte * sig, ULONG cbSig)
{
    SigFormat sf;
    HRESULT hr;
    bool fRet = sf.Parse(sig, cbSig);
    if (!fRet)
    {
        hr = E_FAIL;
        goto Error;
    }

    hr = S_OK;

    Cleanup:
    return hr;

    Error:
    goto Cleanup;
}

 // Takes an mdProperty, prints an intro line, then invokes the parser / printer
HRESULT PrintProperty(ModuleID moduleID, IMetaDataImport* pMDImport, LPCWSTR wszClassName, mdProperty md)
{
    HRESULT hr;
    mdTypeDef td;
    WCHAR wszName[500];
    ULONG cchName;
    PCCOR_SIGNATURE sigMember;
    ULONG cbSigMember;
    DWORD dwAttr;
    DWORD dwCPlusTypeFlag;
    UVCP_CONSTANT pValue;
    ULONG cchValue;
    mdMethodDef mdSetter;
    mdMethodDef mdGetter;
    mdMethodDef aOtherMethods[100];
    ULONG cOtherMethods;

    hr = pMDImport->GetPropertyProps(md, // The member for which to get props. 
                                     &td, // Put member's class here. 
                                     wszName, // Put member's name here. 
                                     dimensionof(wszName), // Size of szMember buffer in wide chars. 
                                     &cchName, // Put actual size here 
                                     &dwAttr, // Put flags here. 
                                     &sigMember, // [OUT] point to the blob value of meta data 
                                     &cbSigMember, // [OUT] actual size of signature blob 
                                     &dwCPlusTypeFlag, // [OUT] flag for value type. selected ELEMENT_TYPE_* 
                                     &pValue, // [OUT] constant value 
                                     &cchValue,
                                     &mdSetter, // [OUT] setter method of the property 
                                     &mdGetter, // [OUT] getter method of the property 
                                     aOtherMethods, // [OUT] other method of the property 
                                     dimensionof(aOtherMethods), // [IN] size of rmdOtherMethod
                                     &cOtherMethods); // [OUT] total number of other method of this property
    if (FAILED(hr))
    {
        goto Error;
    }

    printf("\n%S.%S (0x%x)\n", wszClassName, wszName, md);
    DoParse((sig_byte *) sigMember, cbSigMember);

    hr = S_OK;

    Cleanup:
    return hr;

    Error:
    goto Cleanup;

}


 // Takes a field token, prints an intro line, then invokes the parser / printer
HRESULT PrintField(ModuleID moduleID, IMetaDataImport* pMDImport, LPCWSTR wszClassName, mdToken md)
{
    HRESULT hr;
    mdTypeDef td;
    WCHAR wszName[500];
    ULONG cchName;
    PCCOR_SIGNATURE sigMember;
    ULONG cbSigMember;
    DWORD dwAttr;
    DWORD dwCPlusTypeFlag;
    UVCP_CONSTANT pValue;
    ULONG cchValue;

    hr = pMDImport->GetFieldProps(md, // The member for which to get props. 
                                  &td, // Put member's class here. 
                                  wszName, // Put member's name here. 
                                  dimensionof(wszName), // Size of szMember buffer in wide chars. 
                                  &cchName, // Put actual size here 
                                  &dwAttr, // Put flags here. 
                                  &sigMember, // [OUT] point to the blob value of meta data 
                                  &cbSigMember, // [OUT] actual size of signature blob 
                                  &dwCPlusTypeFlag, // [OUT] flag for value type. selected ELEMENT_TYPE_* 
                                  &pValue, // [OUT] constant value 
                                  &cchValue); // [OUT] size of constant string in chars, 0 for non-strings.
    if (FAILED(hr))
    {
        goto Error;
    }

    printf("\n%S.%S (0x%x)\n", wszClassName, wszName, md);
    DoParse((sig_byte *) sigMember, cbSigMember);

    hr = S_OK;

    Cleanup:
    return hr;

    Error:
    goto Cleanup;

}

 // Takes an mdMethodDef, prints an intro line, then invokes the parser / printer on its signature and its locals
HRESULT PrintMethodDef(ModuleID moduleID, IMetaDataImport* pMDImport, LPCWSTR wszClassName, mdMethodDef md)
{
    HRESULT hr;
    mdTypeDef td;
    WCHAR wszMethod[500];
    ULONG cchMethod;
    DWORD dwAttr;
    PCCOR_SIGNATURE sigParam;
    PCCOR_SIGNATURE sigLocal;
    ULONG cbSigParam;
    ULONG cbSigLocal;
    ULONG ulCodeRVA;
    DWORD dwImplFlags;
    BOOL fMore;
    LPCBYTE pMethodHeader = NULL;
    ULONG cbMethodSize;
    IMAGE_COR_ILMETHOD_TINY* pimt = NULL;
    IMAGE_COR_ILMETHOD_FAT* pimf = NULL;

    hr = pMDImport->GetMethodProps(md, // The method for which to get props. 
                                   &td, // Put method's class here. 
                                   wszMethod, // Put method's name here. 
                                   dimensionof(wszMethod), // Size of szMethod buffer in wide chars. 
                                   &cchMethod, // Put actual size here 
                                   &dwAttr, // Put flags here. 
                                   &sigParam, // [OUT] point to the blob value of meta data 
                                   &cbSigParam, // [OUT] actual size of signature blob 
                                   &ulCodeRVA, // [OUT] codeRVA 
                                   &dwImplFlags); // [OUT] Impl. Flags 
    if (FAILED(hr))
    {
        goto Error;
    }

    printf("\n%S.%S (0x%x)\n", wszClassName, wszMethod, md);

     // Method prototype signature parse
    DoParse((sig_byte *) sigParam, cbSigParam);

     // Method locals signature parse
    hr = g_pProfilerInfo->GetILFunctionBody(moduleID,
                                            md,
                                            &pMethodHeader,
                                            &cbMethodSize);
    if (FAILED(hr))
    {
        goto EndLocal;
    }

    // The following odd-looking lines of code decode the method header, ensure
    // it is in a format that contains local variables, and then grabs the local
    // variable signature out of the header.

    pimt = (IMAGE_COR_ILMETHOD_TINY*) pMethodHeader;
    if ((pimt->Flags_CodeSize & (CorILMethod_FormatMask >> 1)) != CorILMethod_FatFormat)
    {
        goto EndLocal;
    }

    pimf = (IMAGE_COR_ILMETHOD_FAT*) pMethodHeader;
    if (pimf->LocalVarSigTok == 0)
    {
        goto EndLocal;
    }

    hr = pMDImport->GetSigFromToken(pimf->LocalVarSigTok,
                                    &sigLocal,
                                    &cbSigLocal);

    DoParse((sig_byte *) sigLocal, cbSigLocal);

    EndLocal:

    hr = S_OK;

    Cleanup:
    return hr;

    Error:
    goto Cleanup;
}


 // Simple helper to print an intro line for a class
void PrintHeader(LPCWSTR wszClassName, mdTypeDef td, LPCSTR szCategory)
{
    printf("\n--------------------------------------------\n");
    printf("%S (0x%x):\t%s\n", wszClassName, td, szCategory);
    printf("--------------------------------------------\n\n");
}


 // Combines above functions to print the methods, properties, and fields of a class
HRESULT PrintTypedef(ModuleID moduleID, IMetaDataImport* pMDImport, mdTypeDef td)
{
    HRESULT hr;
    HCORENUM hEnum = NULL;
    mdMethodDef aMethods[100];
    mdFieldDef aFields[100];
    mdFieldDef aProperties[100];
    ULONG cMethodDefs;
    ULONG cFields;
    ULONG cProperties;
    ULONG i;
    WCHAR wszTdName[200];
    ULONG cchTdName;
    DWORD dwTypeDefFlags;
    mdToken tkExtends;
    BOOL fMore;

    hr = pMDImport->GetTypeDefProps(td, // [IN] TypeDef token for inquiry.
                                    wszTdName, // [OUT] Put name here.
                                    dimensionof(wszTdName), // [IN] size of name buffer in wide chars.
                                    &cchTdName, // [OUT] put size of name (wide chars) here.
                                    &dwTypeDefFlags, // [OUT] Put flags here.
                                    &tkExtends); // [OUT] Put base class TypeDef/TypeRef here.
    if (FAILED(hr))
    {
        goto Error;
    }

    PrintHeader(wszTdName, td, "METHODDEFS");
    fMore = TRUE;
    while (fMore)
    {
        hr = pMDImport->EnumMethods(&hEnum,
                                    td, // [IN] TypeDef to scope the enumeration. 
                                    aMethods, // [OUT] Put MethodDefs here. 
                                    dimensionof(aMethods), // [IN] Max MethodDefs to put. 
                                    &cMethodDefs); // [OUT] Put # put here. 
        if (FAILED(hr))
        {
            goto Error;
        }

        if (hr == S_FALSE)
        {
            fMore = FALSE;
        }

        for (i=0; i < cMethodDefs; i++)
        {
            hr = PrintMethodDef(moduleID, pMDImport, wszTdName, aMethods[i]);
            if (FAILED(hr))
            {
                 // do you care? If so, do something about this.
            }
        }
    }

    pMDImport->CloseEnum(hEnum);
    hEnum = NULL;

    PrintHeader(wszTdName, td, "FIELDS");
    fMore = TRUE;
    while (fMore)
    {
        hr = pMDImport->EnumFields(&hEnum,
                                   td, 
                                   Fields, 
                                   dimensionof(aFields),
                                   &cFields);

        if (FAILED(hr))
        {
            goto Error;
        }

        if (hr == S_FALSE)
        {
            fMore = FALSE;
        }

        for (i=0; i < cFields; i++)
        {
            hr = PrintField(moduleID, pMDImport, wszTdName, aFields[i]);
            if (FAILED(hr))
            {
 				// do you care? If so, do something about this.
            }
        }
    }

    pMDImport->CloseEnum(hEnum);
    hEnum = NULL;

    PrintHeader(wszTdName, td, "PROPERTIES");
    fMore = TRUE;
    while (fMore)
    {
        hr = pMDImport->EnumProperties(&hEnum,
									   td, 
									   aProperties, 
									   dimensionof(aProperties),
									   &cProperties); 
        if (FAILED(hr))
        {
            goto Error;
        }

        if (hr == S_FALSE)
        {
            fMore = FALSE;
        }

        for (i=0; i < cProperties; i++)
        {
            hr = PrintProperty(moduleID, pMDImport, wszTdName, aProperties[i]);
            if (FAILED(hr))
            {
 				// do you care? If so, do something about this.
            }
        }
    }

    pMDImport->CloseEnum(hEnum);
    hEnum = NULL;

    hr = S_OK;

    Cleanup:
    if (hEnum != NULL)
    {
        pMDImport->CloseEnum(hEnum);
    }
    return hr;

    Error:
    goto Cleanup;
}


 // Enumerates the typedefs in a module via the metadata interface, and calls PrintTypedef
 // on each one
HRESULT PrintMetadata(ModuleID moduleID, IMetaDataImport* pMDImport)
{
    HRESULT hr;
    HCORENUM hEnum = NULL;
    mdTypeDef aTypeDefs[100];
    ULONG cTypeDefs;
    ULONG i;
    BOOL fMoreTypeDefs = TRUE;

    while (fMoreTypeDefs)
    {
        hr = pMDImport->EnumTypeDefs(&hEnum,
							         aTypeDefs,
							         dimensionof(aTypeDefs),
							         &cTypeDefs);
        if (FAILED(hr))
        {
            goto Error;
        }

        if (hr == S_FALSE)
        {
            fMoreTypeDefs = FALSE;
        }

        for (i=0; i < cTypeDefs; i++)
        {
            hr = PrintTypedef(moduleID, pMDImport, aTypeDefs[i]);
            if (FAILED(hr))
            {
 				// do you care? If so, do something about this.
            }
        }
    }

    hr = S_OK;

    Cleanup:
    if (hEnum != NULL)
    {
        pMDImport->CloseEnum(hEnum);
    }
    return hr;

    Error:
    goto Cleanup;
}


 // ****************************************************************
 // Add this to your profiler's ICorProfilerCallback2::ModuleLoadFinished implementation.
 // It is assumed your copy of the ICorProfilerInfo2 interface may be accessed via
 // g_pProfilerInfo. Change the code to fit your profiler as appropriate.
 // ****************************************************************
 //
 // As a module gets loaded, this callback implementation initiates the pretty-printer to
 // log all the types to stdout.
HRESULT CYourProfImpl::ModuleLoadFinished( ModuleID moduleID, HRESULT hrStatus )
{
    HRESULT hr;
    LPCBYTE pbBaseLoadAddr;
    WCHAR wszName[300];
    ULONG cchNameIn = dimensionof(wszName);
    ULONG cchNameOut;
    AssemblyID assemblyID;

    hr = g_pProfilerInfo->GetModuleInfo(moduleID,
									    &pbBaseLoadAddr,
									    cchNameIn,
									    &cchNameOut,
									    wszName,
									    &assemblyID);
    if (FAILED(hr))
    {
        return hr;
    }

    printf("MODULE LOAD FINISHED: %S\n", wszName);

    IMetaDataImport *pMDImport = NULL;
    hr = g_pProfilerInfo->GetModuleMetaData(moduleID,
									        ofRead,
									        IID_IMetaDataImport,
									        (IUnknown **)&pMDImport );
    if (FAILED(hr))
    {
        return hr;
    }

    hr = PrintMetadata(moduleID, pMDImport);
    if (FAILED(hr))
    {
 		// Do any error handling as appropriate
    }

    hr = S_OK;

    Cleanup:
    return hr;

    Error:
    goto Cleanup;
}