commands/memsampler/memsampler.cif
author Tom Sutcliffe <thomas.sutcliffe@accenture.com>
Sun, 17 Oct 2010 18:43:12 +0100
changeset 69 849a0b46c767
parent 0 7f656887cf89
permissions -rw-r--r--
Fixed lots of issues with installing a low-caps version of fshell from SIS file. * Fixed issue in CCommandFactory whereby some APIs like GetCommandInfoL could trigger allocations on the wrong heap or signals to the wrong thread. The symptoms were often seen as a crash in the which_00 thread when running ciftest. * Lots of build fixes for when FSHELL_PROTECTED_UIDS isn't defined and when all capabilities aren't available. * Added new platform.mmh macro FSHELL_OPEN_SIGNED. * Open signing of fshell SIS files is now supported for production S60 handsets. Build fshell with the FSHELL_OPEN_SIGNED macro defined (and without defining FSHELL_CAP_ALL or FSHELL_PROTECTED_UIDS) in your platform.mmh and submit \epoc32\fshell\fshell.unsigned.sis to https://www.symbiansigned.com/app/page/public/openSignedOnline.do . The following commands are not available when using Open Signing due to Platform Security restrictions: fdb; kerninfo; chunkinfo; svrinfo; objinfo; sudo; fsck; localdrive; ramdefrag; readmem; reboot; setcritical; setpriority. Others such as chkdeps, e32header, ps, and fshell itself will run but in a restricted capacity (for example, fshell will no longer allow you to modify files in the \sys\bin directory). * Removed commands objinfo, svrinfo, chunkinfo, readmem, fsck completely when memory access isn't present - previously they would still appear in the help but would give an error if you tried to run them.

# memsampler.cif
# 
# Copyright (c) 2010 Accenture. All rights reserved.
# This component and the accompanying materials are made available
# under the terms of the "Eclipse Public License v1.0"
# which accompanies this distribution, and is available
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
# 
# Initial Contributors:
# Accenture - Initial contribution
#

==name memsampler

==short-description

Gather statistics about memory usage.

==long-description

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:

=over 5

=item C<u>

Display the most recently updated chunks first.

=item C<n>

Sort by chunk name.

=item C<c>

Sort by current chunk size.

=item C<m>

Sort by maximum chunk size.

=item C<p>

Sort by peak chunk size.

=back

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:

  c:\>memsampler --console rcons.dll --console-size 100,60

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>.

==see-also

L<meminfo>

==option uint r rate

The rate at which to sample memory usage (in milliseconds). Defaults to 1000 ms (1 second).

==option bool n no-btrace-config

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.

==option bool d debug

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.

==option bool H human

Display sizes in human readable form.

==option filename f file

Capture raw btrace data to the specified file.

==option bool l no-live-view

Don't display a live view of memory usage. Only sensible in conjunction with C<--file> or C<--dedbug>.

==copyright

Copyright (c) 2008-2010 Accenture. All rights reserved.