|
1 # memsampler.cif |
|
2 # |
|
3 # Copyright (c) 2010 Accenture. All rights reserved. |
|
4 # This component and the accompanying materials are made available |
|
5 # under the terms of the "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 # Accenture - Initial contribution |
|
11 # |
|
12 |
|
13 ==name memsampler |
|
14 |
|
15 ==short-description |
|
16 |
|
17 Gather statistics about memory usage. |
|
18 |
|
19 ==long-description |
|
20 |
|
21 A tool that (by default) presents a live view of system memory usage. Memory usage is sampled using a device driver and presented in the form of a table. The order of the table can be changed using the following keys: |
|
22 |
|
23 =over 5 |
|
24 |
|
25 =item C<u> |
|
26 |
|
27 Display the most recently updated chunks first. |
|
28 |
|
29 =item C<n> |
|
30 |
|
31 Sort by chunk name. |
|
32 |
|
33 =item C<c> |
|
34 |
|
35 Sort by current chunk size. |
|
36 |
|
37 =item C<m> |
|
38 |
|
39 Sort by maximum chunk size. |
|
40 |
|
41 =item C<p> |
|
42 |
|
43 Sort by peak chunk size. |
|
44 |
|
45 =back |
|
46 |
|
47 If the same sort order key is pressed more than once, the direction of the sort is toggled. The tool can be exited cleanly by pressing C<q>. If you're using the C<rcons> remote console implementation, it is recommented that you run C<memsampler> in a larger than default window. For example: |
|
48 |
|
49 c:\>memsampler --console rcons.dll --console-size 100,60 |
|
50 |
|
51 Note, if the raw data is capture to a file (using the C<--file> option) this data can be converted into comma separated value data (suitable for importing into a spreadsheet) using the tool F<\epoc32\tools\dmemsampler>. |
|
52 |
|
53 ==see-also |
|
54 |
|
55 L<meminfo> |
|
56 |
|
57 ==option uint r rate |
|
58 |
|
59 The rate at which to sample memory usage (in milliseconds). Defaults to 1000 ms (1 second). |
|
60 |
|
61 ==option bool n no-btrace-config |
|
62 |
|
63 Don't attempt to configure the BTrace buffer before running the memory sampler. If this option is not specified then BTrace will be configured to only contain traces relating to memory sampling. |
|
64 |
|
65 ==option bool d debug |
|
66 |
|
67 Enable debug output to the underlying console. It only makes sense to use this option if you redirect the main console to a separate window by adding something like C<--console rcons.dll> to your command line. |
|
68 |
|
69 ==option bool H human |
|
70 |
|
71 Display sizes in human readable form. |
|
72 |
|
73 ==option filename f file |
|
74 |
|
75 Capture raw btrace data to the specified file. |
|
76 |
|
77 ==option bool l no-live-view |
|
78 |
|
79 Don't display a live view of memory usage. Only sensible in conjunction with C<--file> or C<--dedbug>. |
|
80 |
|
81 ==copyright |
|
82 |
|
83 Copyright (c) 2008-2010 Accenture. All rights reserved. |
|
84 |