1NDCTL-START-SCRUB(1)             ndctl Manual             NDCTL-START-SCRUB(1)
2
3
4

NAME

6       ndctl-start-scrub - start an Address Range Scrub (ARS) operation
7

SYNOPSIS

9       ndctl start-scrub [<bus-id> <bus-id2> ... <bus-idN>] [<options>]
10

DESCRIPTION

12       NVDIMM Address Range Scrub is a capability provided by platform
13       firmware that allows for the discovery of memory errors by system
14       software. It enables system software to pre-emptively avoid accesses
15       that could lead to uncorrectable memory error handling events, and it
16       otherwise allows memory errors to be enumerated.
17
18       The kernel provides a sysfs file (scrub) that when written with the
19       string "1\n" initiates an ARS operation. The ndctl start-scrub
20       operation starts an ARS, across all specified buses, and the kernel in
21       turn proceeds to scrub every persistent memory address region on the
22       specified buses.
23

EXAMPLE

25       Start a scrub on all nvdimm buses in the system. The json listing
26       report only includes the buses that support ARS operations.
27
28
29           .ft C
30           # ndctl start-scrub
31           [
32             {
33               "provider":"nfit_test.1",
34               "dev":"ndbus3",
35               "scrub_state":"active"
36             },
37             {
38               "provider":"nfit_test.0",
39               "dev":"ndbus2",
40               "scrub_state":"active"
41             }
42           ]
43           .ft
44
45
46       When specifying an individual bus, or if there is only one bus in the
47       system, the command reports whether ARS support is available.
48
49
50           .ft C
51           # ndctl start-scrub e820
52           error starting scrub: Operation not supported
53           .ft
54
55

OPTIONS

57       -v, --verbose
58           Emit debug messages for the ARS start process
59

61       Copyright © 2016 - 2020, Intel Corporation. License GPLv2: GNU GPL
62       version 2 http://gnu.org/licenses/gpl.html. This is free software: you
63       are free to change and redistribute it. There is NO WARRANTY, to the
64       extent permitted by law.
65

SEE ALSO

67       ndctl-wait-scrub(1), ACPI 6.2 Specification Section 9.20.7.2 Address
68       Range Scrubbing (ARS) Overview[1]
69

NOTES

71        1. ACPI 6.2 Specification Section 9.20.7.2 Address Range Scrubbing
72           (ARS) Overview
73           http://www.uefi.org/sites/default/files/resources/ACPI%206_2_A_Sept29.pdf
74
75
76
77ndctl 71.1                        01/26/2021              NDCTL-START-SCRUB(1)
Impressum