1 # leak.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 leak

    14 

    15 ==short-description

    16 

    17 A tool for purposefully wasting memory.

    18 

    19 ==long-description

    20 

    21 Sits in a loop allocating memory. This continues until either the specified amount of memory has been consumed, or an error occurs. The allocations can be configured to come from a raw RChunk, or via an RHeap (C<User::ChunkHeap()>). The command waits for a keypress before exiting and freeing the memory.

    22 

    23 ==see-also

    24 

    25 L<gobble|gobble>

    26 

    27 ==argument int amount optional

    28 

    29 The target amount of memory to consume (in bytes). If not specified attempts to consumes all available memory.

    30 

    31 ==option bool v verbose

    32 

    33 Display more detailed output.

    34 

    35 ==option int i increment-amount

    36 

    37 The number of bytes to leak on each increment. If not specified and a target amount is specified, tries to allocate the entire target amount in one go. If not specified and a target amount isn't specified either, defaults to 4096 bytes. Note that unless C<--heap> is used, the increment amount must be a multiple of 4096 bytes.

    38 

    39 ==option uint r rate

    40 

    41 The amount of time (in milliseconds) to wait between each increment. Defaults to zero (i.e. no wait).

    42 

    43 ==option uint a address

    44 

    45 The address of a heap to leak into. The value should be in the address space of the process given by the C<--processid> option.

    46 

    47 ==option bool H heap

    48 

    49 Use a ChunkHeap to consume the memory rather than a straight RChunk.

    50 

    51 ==option bool t retry

    52 

    53 If specified, when an allocation fails retry using a smaller increment amount.

    54 

    55 ==copyright

    56 

    57 Copyright (c) 2007-2010 Accenture. All rights reserved.

    58