1NDCTL-START-SCRUB(1)                                      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           # ndctl start-scrub
29           [
30             {
31               "provider":"nfit_test.1",
32               "dev":"ndbus3",
33               "scrub_state":"active"
34             },
35             {
36               "provider":"nfit_test.0",
37               "dev":"ndbus2",
38               "scrub_state":"active"
39             }
40           ]
41
42       When specifying an individual bus, or if there is only one bus in the
43       system, the command reports whether ARS support is available.
44
45           # ndctl start-scrub e820
46           error starting scrub: Operation not supported
47

OPTIONS

49       -v, --verbose
50           Emit debug messages for the ARS start process
51

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

SEE ALSO

59       linkndctl:ndctl-wait-scrub[1], ACPI 6.2 Specification Section 9.20.7.2
60       Address Range Scrubbing (ARS) Overview[1]
61

NOTES

63        1. ACPI 6.2 Specification Section 9.20.7.2 Address Range Scrubbing
64           (ARS) Overview
65           http://www.uefi.org/sites/default/files/resources/ACPI%206_2_A_Sept29.pdf
66
67
68
69                                  01/13/2023              NDCTL-START-SCRUB(1)
Impressum