core/builtins/chunkinfo.cif
changeset 0 7f656887cf89
child 66 2a78c4ff2eab
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # chunkinfo.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 chunkinfo
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Print information about memory chunks.
       
    18 
       
    19 ==long-description
       
    20 
       
    21 If no arguments are given, lists the address and name of each DChunk object currently present in the kernel. The chunk list includes local and anonymous chunks. If a chunk address is specified, more detailed information about the specific chunk is printed. If the chunk appears to contain a heap (according to the criteria of C<LtkUtils::RAllocatorHelper>), then the detailed info includes heap statistics as well.
       
    22 
       
    23 ==argument uint chunk_address optional
       
    24 
       
    25 The address of the C<DChunk> object to display information about. If not specified, lists a summary of all chunks. Note chunk addresses can be found either by running C<chunkinfo> with no arguments, or by using C<ps --chunks> (note though that L<ps|ps> only finds globally named chunks).
       
    26 
       
    27 ==option uint r rate
       
    28 
       
    29 The rate (in milliseconds) at which to update the information.  If not specified (or specified as zero) the current information will be displayed and the tool will exit.
       
    30 
       
    31 ==option bool H human
       
    32 
       
    33 Display sizes in human readable form.
       
    34 
       
    35 ==option string o owning-process
       
    36 
       
    37 If specified, limits the chunk summary list to just those chunks belonging to the named process. Note, the process name may contain C<?> and C<*> wild characters. Note also that global chunks don't have an explicit owner. If you want to find all the chunks that were created by a particular process, then use C<--controlling-process> instead.
       
    38 
       
    39 ==option uint c controlling-process
       
    40 
       
    41 If specified, limits the chunk summary list to just those chunks that were created by the specified process identifier. Note, this option will find global and local chunks that were created by the process.
       
    42 
       
    43 ==option bool s size
       
    44 
       
    45 Include current chunk size in the chunk summary list.
       
    46 
       
    47 ==copyright
       
    48 
       
    49 Copyright (c) 2006-2010 Accenture. All rights reserved.
       
    50