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

    14 

    15 ==short-description

    16 

    17 Initiates RAM defragmentation.

    18 

    19 ==long-description

    20 

    21 Triggers a RAM defrag by getting C<memoryaccess> to call C<TRamDefragRequest>. Returns once the defrag is complete. Also can be used to get RAM zone statistics or to call C<EmptyRamZone>.

    22 

    23 ==argument enum command optional

    24 

    25 The command to execute. If not specified, defaults to C<defrag>.

    26 

    27 ==enum-value defrag

    28 

    29 Calls C<TRamDefragRequest::DefragRam>.

    30 

    31 ==enum-value empty

    32 

    33 Calls C<EmptyRamZone> on the given zone(s).

    34 

    35 ==enum-value info

    36 

    37 Prints some statistics about the given zone.

    38 

    39 ==argument uint zone multiple optional

    40 

    41 Zone to operate on. Only applicable for C<empty> or C<info> commands. Zone IDs are different for each baseport and hardware variant so don't use this option unless you really know what you're doing.

    42 

    43 ==option int p priority

    44 

    45 The thread priority at which to run the defrag. If not specified, defaults to the priority of the C<memoryaccess> DFC thread (currently 27).

    46 

    47 ==option bool c csv

    48 

    49 Print zone info statistics in CSV format.

    50 

    51 ==copyright

    52 

    53 Copyright (c) 2009-2010 Accenture. All rights reserved.

    54