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

    14 

    15 ==short-description

    16 

    17 Consumes CPU cycles up to the loading you specify.

    18 

    19 ==long-description

    20 

    21 Press CTRL-C or use the C<--duration> option to stop it.

    22 

    23 ==see-also

    24 

    25 L<sleep|sleep>

    26 

    27 ==argument int load optional

    28 

    29 The amount of CPU to consume. This number is the same order of magnitude as a percentage, but it isn't calibrated that precisely. So a number less than 10 generally produces a CPU load of a few percent, a value in the hundreds will generally max the CPU out. If omitted it will spin as fast as possible with no attempt at calibration.

    30 

    31 ==option int s start-after

    32 

    33 Wait this number of seconds before starting to consume CPU. If not specified start immediately.

    34 

    35 ==option int d duration

    36 

    37 Run for this number of seconds. If not specifed run indefinitely.

    38 

    39 ==option int p priority

    40 

    41 Run the spinloop at this kernel priority. If not specified, use default priority 12 (C<EPriorityForeground+EPriorityNormal>).

    42 

    43 ==copyright

    44 

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

    46