Commit bad3fbb2 authored by Dylan Yudaken's avatar Dylan Yudaken Committed by Jonathan Corbet
Browse files

docs: fault-injection: fix defaults 



ignore-gfp-wait and ignore-gfp-highmem defaults are actually true (Y) in
both failslab and fail_page_alloc, not false as the docs suggest. See
page_alloc.c:3762 and failslab.c:13

At the same time use 'Y' instead of '1' in the example scripts just for
consistency. (though 1 would work)

Signed-off-by: default avatarDylan Yudaken <dylany@fb.com>
Reviewed-by: default avatarAkinobu Mita <akinobu.mita@gmail.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent e01159c7

Documentation/fault-injection/fault-injection.rst

+7 −7
Original line number Diff line number Diff line
@@ -132,16 +132,16 @@ configuration of fault-injection capabilities. 


	Format: { 'Y' | 'N' }



	default is 'N', setting it to 'Y' won't inject failures into

	highmem/user allocations.

	default is 'Y', setting it to 'N' will also inject failures into

	highmem/user allocations (__GFP_HIGHMEM allocations).



- /sys/kernel/debug/failslab/ignore-gfp-wait:

- /sys/kernel/debug/fail_page_alloc/ignore-gfp-wait:



	Format: { 'Y' | 'N' }



	default is 'N', setting it to 'Y' will inject failures

	only into non-sleep allocations (GFP_ATOMIC allocations).

	default is 'Y', setting it to 'N' will also inject failures

	into allocations that can sleep (__GFP_DIRECT_RECLAIM allocations).



- /sys/kernel/debug/fail_page_alloc/min-order:
@@ -280,7 +280,7 @@ Application Examples 
    printf %#x -1 > /sys/kernel/debug/$FAILTYPE/times

    echo 0 > /sys/kernel/debug/$FAILTYPE/space

    echo 2 > /sys/kernel/debug/$FAILTYPE/verbose

    echo 1 > /sys/kernel/debug/$FAILTYPE/ignore-gfp-wait

    echo Y > /sys/kernel/debug/$FAILTYPE/ignore-gfp-wait



    faulty_system()

    {
@@ -334,8 +334,8 @@ Application Examples 
    printf %#x -1 > /sys/kernel/debug/$FAILTYPE/times

    echo 0 > /sys/kernel/debug/$FAILTYPE/space

    echo 2 > /sys/kernel/debug/$FAILTYPE/verbose

    echo 1 > /sys/kernel/debug/$FAILTYPE/ignore-gfp-wait

    echo 1 > /sys/kernel/debug/$FAILTYPE/ignore-gfp-highmem

    echo Y > /sys/kernel/debug/$FAILTYPE/ignore-gfp-wait

    echo Y > /sys/kernel/debug/$FAILTYPE/ignore-gfp-highmem

    echo 10 > /sys/kernel/debug/$FAILTYPE/stacktrace-depth



    trap "echo 0 > /sys/kernel/debug/$FAILTYPE/probability" SIGINT SIGTERM EXIT