1NDCTL-WAIT-SCRUB(1)                                        NDCTL-WAIT-SCRUB(1)
2
3
4

NAME

6       ndctl-wait-scrub - wait for an Address Range Scrub (ARS) operation to
7       complete
8

SYNOPSIS

10       ndctl wait-scrub [<bus-id> <bus-id2> ... <bus-idN>] [<options>]
11

DESCRIPTION

13       NVDIMM Address Range Scrub is a capability provided by platform
14       firmware that allows for the discovery of memory errors by system
15       software. It enables system software to pre-emptively avoid accesses
16       that could lead to uncorrectable memory error handling events, and it
17       otherwise allows memory errors to be enumerated.
18
19       The kernel provides a POLL(2) capable sysfs file (scrub) to indicate
20       the state of ARS. The scrub file maintains a running count of ARS runs
21       that have taken place. While a current run is in progress a + character
22       is emitted along with the current count. The ndctl wait-scrub operation
23       waits for scrub, across all specified buses, to indicate not
24       in-progress at least once.
25

EXAMPLE

27       Wait for scrub on all nvdimm buses in the system. The json listing
28       report at the end only includes the buses that support ARS operations.
29
30           # ndctl wait-scrub
31           [
32             {
33               "provider":"nfit_test.1",
34               "dev":"ndbus3",
35               "scrub_state":"idle"
36             },
37             {
38               "provider":"nfit_test.0",
39               "dev":"ndbus2",
40               "scrub_state":"idle"
41             }
42           ]
43
44       When specifying an individual bus, or if there is only one bus in the
45       system, the command reports whether ARS support is available.
46
47           # ndctl wait-scrub e820
48           error waiting for scrub completion: Operation not supported
49

OPTIONS

51       -v, --verbose
52           Emit debug messages for the ARS wait process
53

55       Copyright © 2016 - 2022, Intel Corporation. License GPLv2: GNU GPL
56       version 2 http://gnu.org/licenses/gpl.html. This is free software: you
57       are free to change and redistribute it. There is NO WARRANTY, to the
58       extent permitted by law.
59

SEE ALSO

61       linkndctl:ndctl-start-scrub[1], ACPI 6.2 Specification Section 9.20.7.2
62       Address Range Scrubbing (ARS) Overview[1]
63

NOTES

65        1. ACPI 6.2 Specification Section 9.20.7.2 Address Range Scrubbing
66           (ARS) Overview
67           http://www.uefi.org/sites/default/files/resources/ACPI%206_2_A_Sept29.pdf
68
69
70
71                                  08/03/2023               NDCTL-WAIT-SCRUB(1)
Impressum