powerpc/papr_scm: Add support for reporting nvdimm health
v8 cover powerpc/papr_scm: Add support for reporting nvdimm health
Changes since v7 [1]:
* Addressed various review comments from Aneesh, Ira and Mpe.
* Removed the 'payload_offset' field from 'struct nd_pdsm_cmd_pkg' and replaced it with some reserved fields [ Aneesh ].
* Updated the doc and description for patch that fetches dimm health information from PHYP clarifying bit-ordering [ Mpe and Ira ].
* Updated the patch title & description for patch exporting 'seq_buf_printf'. [ Christoph Hellwig ]
* Fix types of various newly introduced vars in papr_scm.c [ Ira ].
* Fixed a typo in 'papr_scm_pdsm.h' [ Ira ]
[1] https://lore.kernel.org/linux-nvdimm/[email protected]
---
The PAPR standard[2][4] provides mechanisms to query the health and performance stats of an NVDIMM via various hcalls as described in Ref[3]. Until now these stats were never available nor exposed to the user-space tools like 'ndctl'. This is partly due to PAPR platform not having support for ACPI and NFIT. Hence 'ndctl' is unable to query and report the dimm health status and a user had no way to determine the current health status of a NDVIMM.
To overcome this limitation, this patch-set updates papr_scm kernel module to query and fetch NVDIMM health stats using hcalls described in Ref[3]. This health and performance stats are then exposed to userspace via sysfs and PAPR-NVDIMM-Specific-Methods(PDSM) issued by libndctl.
These changes coupled with proposed ndtcl changes located at Ref[5] should provide a way for the user to retrieve NVDIMM health status using ndtcl.
Below is a sample output using proposed kernel + ndctl for PAPR NVDIMM in a emulation environment:
# ndctl list -DH
[
{
"dev":"nmem0",
"health":{
"health_state":"fatal",
"shutdown_state":"dirty"
}
}
]Dimm health report output on a pseries guest lpar with vPMEM or HMS based NVDIMMs that are in perfectly healthy conditions:
# ndctl list -d nmem0 -H
[
{
"dev":"nmem0",
"health":{
"health_state":"ok",
"shutdown_state":"clean"
}
}
]PAPR NVDIMM-Specific-Methods(PDSM)
==================================
PDSM requests are issued by vendor specific code in libndctl to execute certain operations or fetch information from NVDIMMS. PDSMs requests can be sent to papr_scm module via libndctl(userspace) and libnvdimm (kernel) using the ND_CMD_CALL ioctl command which can be handled in the dimm control function papr_scm_ndctl(). Current patchset proposes a single PDSM to retrieve NVDIMM health, defined in the newly introduced uapi header named 'papr_scm_pdsm.h'. Support for more PDSMs will be added in future.
Structure of the patch-set
==========================
The patch-set starts with a doc patch documenting details of hcall H_SCM_HEALTH. Second patch exports kernel symbol seq_buf_printf() thats used in subsequent patches to generate sysfs attribute content.
Third patch implements support for fetching NVDIMM health information from PHYP and partially exposing it to user-space via a NVDIMM sysfs flag.
Fourth patches deal with implementing support for servicing PDSM commands in papr_scm module.
Finally the last patch implements support for servicing PDSM 'PAPR_SCM_PDSM_HEALTH' that returns the NVDIMM health information to libndctl.
References:
[2] "Power Architecture Platform Reference"
https://en.wikipedia.org/wiki/Power_Architecture_Platform_Reference
[3] commit 58b278f568f0
("powerpc: Provide initial documentation for PAPR hcalls")
[4] "Linux on Power Architecture Platform Reference"
https://members.openpowerfoundation.org/document/dl/469
[5] https://github.com/vaibhav92/ndctl/tree/papr_scm_health_v8
---
Vaibhav Jain (5):
powerpc: Document details on H_SCM_HEALTH hcall
seq_buf: Export seq_buf_printf
powerpc/papr_scm: Fetch nvdimm health information from PHYP ndctl/papr_scm,uapi: Add support for PAPR nvdimm specific methods powerpc/papr_scm: Implement support for PAPR_SCM_PDSM_HEALTH
Documentation/ABI/testing/sysfs-bus-papr-scm | 27 ++ Documentation/powerpc/papr_hcalls.rst | 45 ++- arch/powerpc/include/uapi/asm/papr_scm_pdsm.h | 175 +++++++++ arch/powerpc/platforms/pseries/papr_scm.c | 363 +++++++++++++++++- include/uapi/linux/ndctl.h | 1 + lib/seq_buf.c | 1 + 6 files changed, 599 insertions(+), 13 deletions(-) create mode 100644 Documentation/ABI/testing/sysfs-bus-papr-scm create mode 100644 arch/powerpc/include/uapi/asm/papr_scm_pdsm.h
Signature · 4 lines
2.26.2 _______________________________________________ Linux-nvdimm mailing list -- [email protected] To unsubscribe send an email to [email protected]
PATCH v8 1/5 powerpc: Document details on H_SCM_HEALTH hcall
Add documentation to 'papr_hcalls.rst' describing the bitmap flags that are returned from H_SCM_HEALTH hcall as per the PAPR-SCM specification.
---
Changelog:
v7..v8:
* Added a clarification on bit-ordering of Health Bitmap
Resend:
* None
v6..v7:
* None
v5..v6:
* New patch in the series
--- Documentation/powerpc/papr_hcalls.rst | 45 ++++++++++++++++++++++++--- 1 file changed, 41 insertions(+), 4 deletions(-)
Documentation/powerpc/papr_hcalls.rst +41 -4
@@ -220,13 +220,50 @@ from the LPAR memory. **H_SCM_HEALTH** | Input: drcIndex -| Out: *health-bitmap, health-bit-valid-bitmap* +| Out: *health-bitmap (r4), health-bit-valid-bitmap (r5)* | Return Value: *H_Success, H_Parameter, H_Hardware* Given a DRC Index return the info on predictive failure and overall health of -the NVDIMM. The asserted bits in the health-bitmap indicate a single predictive -failure and health-bit-valid-bitmap indicate which bits in health-bitmap are -valid. +the NVDIMM. The asserted bits in the health-bitmap indicate one or more states +(described in table below) of the NVDIMM and health-bit-valid-bitmap indicate +which bits in health-bitmap are valid. The bits are reported in +reverse bit ordering for example a value of 0xC400000000000000 +indicates bits 0, 1, and 5 are valid. + +Health Bitmap Flags: + ++------+-----------------------------------------------------------------------+ +| Bit | Definition | ++======+=======================================================================+ +| 00 | SCM device is unable to persist memory contents. | +| | If the system is powered down, nothing will be saved. | ++------+-----------------------------------------------------------------------+ +| 01 | SCM device failed to persist memory contents. Either contents were not| +| | saved successfully on power down or were not restored properly on | +| | power up. | ++------+-----------------------------------------------------------------------+ +| 02 | SCM device contents are persisted from previous IPL. The data from | +| | the last boot were successfully restored. | ++------+-----------------------------------------------------------------------+ +| 03 | SCM device contents are not persisted from previous IPL. There was no | +| | data to restore from the last boot. | ++------+-----------------------------------------------------------------------+ +| 04 | SCM device memory life remaining is critically low | ++------+-----------------------------------------------------------------------+ +| 05 | SCM device will be garded off next IPL due to failure | ++------+-----------------------------------------------------------------------+ +| 06 | SCM contents cannot persist due to current platform health status. A | +| | hardware failure may prevent data from being saved or restored. | ++------+-----------------------------------------------------------------------+ +| 07 | SCM device is unable to persist memory contents in certain conditions | ++------+-----------------------------------------------------------------------+ +| 08 | SCM device is encrypted | ++------+-----------------------------------------------------------------------+ +| 09 | SCM device has successfully completed a requested erase or secure | +| | erase procedure. | ++------+-----------------------------------------------------------------------+ +|10:63 | Reserved / Unused | ++------+-----------------------------------------------------------------------+ **H_SCM_PERFORMANCE_STATS**
Signature · 4 lines
2.26.2 _______________________________________________ Linux-nvdimm mailing list -- [email protected] To unsubscribe send an email to [email protected]
Re: [PATCH v8 1/5] powerpc: Document details on H_SCM_HEALTH hcall
Quoted 5 lines · Vaibhav Jain
Add documentation to '
papr_hcalls.rst' describing the bitmap flags that are returned fromH_SCM_HEALTHhcall as per the PAPR-SCM specification.
Please do a global s/SCM/PMEM/ or s/SCM/NVDIMM/. It's unfortunate that we already have 2 ways to describe persistent memory devices, let's not perpetuate a third so that "grep" has a chance to find interrelated code across architectures. Other than that this looks good to me.
Quoted 84 lines
Cc "Aneesh Kumar K . V" <[email protected]>Cc Dan Williams <[email protected]>Cc Michael Ellerman <[email protected]>Cc Ira Weiny <[email protected]>Signed-off-by Vaibhav Jain <[email protected]>---
Changelog:
v7..v8:
* Added a clarification on bit-ordering of Health BitmapResend:
* Nonev6..v7:
* Nonev5..v6:
* New patch in the series--- Documentation/powerpc/papr_hcalls.rst | 45 ++++++++++++++++++++++++--- 1 file changed, 41 insertions(+), 4 deletions(-)Documentation/powerpc/papr_hcalls.rst +41
-5@@ -220,13 +220,50 @@ from the LPAR memory. **H_SCM_HEALTH** | Input: drcIndex -| Out: *health-bitmap, health-bit-valid-bitmap* +| Out: *health-bitmap (r4), health-bit-valid-bitmap (r5)* | Return Value: *H_Success, H_Parameter, H_Hardware* Given a DRC Index return the info on predictive failure and overall health of -the NVDIMM. The asserted bits in the health-bitmap indicate a single predictive -failure and health-bit-valid-bitmap indicate which bits in health-bitmap are -valid. +the NVDIMM. The asserted bits in the health-bitmap indicate one or more states +(described in table below) of the NVDIMM and health-bit-valid-bitmap indicate +which bits in health-bitmap are valid. The bits are reported in +reverse bit ordering for example a value of 0xC400000000000000 +indicates bits 0, 1, and 5 are valid. + +Health Bitmap Flags: + ++------+-----------------------------------------------------------------------+ +| Bit | Definition | ++======+=======================================================================+ +| 00 | SCM device is unable to persist memory contents. | +| | If the system is powered down, nothing will be saved. | ++------+-----------------------------------------------------------------------+ +| 01 | SCM device failed to persist memory contents. Either contents were not| +| | saved successfully on power down or were not restored properly on | +| | power up. | ++------+-----------------------------------------------------------------------+ +| 02 | SCM device contents are persisted from previous IPL. The data from | +| | the last boot were successfully restored. | ++------+-----------------------------------------------------------------------+ +| 03 | SCM device contents are not persisted from previous IPL. There was no | +| | data to restore from the last boot. | ++------+-----------------------------------------------------------------------+ +| 04 | SCM device memory life remaining is critically low | ++------+-----------------------------------------------------------------------+ +| 05 | SCM device will be garded off next IPL due to failure | ++------+-----------------------------------------------------------------------+ +| 06 | SCM contents cannot persist due to current platform health status. A | +| | hardware failure may prevent data from being saved or restored. | ++------+-----------------------------------------------------------------------+ +| 07 | SCM device is unable to persist memory contents in certain conditions | ++------+-----------------------------------------------------------------------+ +| 08 | SCM device is encrypted | ++------+-----------------------------------------------------------------------+ +| 09 | SCM device has successfully completed a requested erase or secure | +| | erase procedure. | ++------+-----------------------------------------------------------------------+ +|10:63 | Reserved / Unused | ++------+-----------------------------------------------------------------------+ **H_SCM_PERFORMANCE_STATS** --2.26.2
Re: [PATCH v8 1/5] powerpc: Document details on H_SCM_HEALTH hcall
Thanks for looking into this patchset Dan,
Quoted 7 lines · Dan Williams
Quoted 5 lines · Vaibhav Jain
Add documentation to '
papr_hcalls.rst' describing the bitmap flags that are returned fromH_SCM_HEALTHhcall as per the PAPR-SCM specification.
Quoted 5 lines
Please do a global s/SCM/PMEM/ or s/SCM/NVDIMM/. It's unfortunate that we already have 2 ways to describe persistent memory devices, let's not perpetuate a third so that "grep" has a chance to find interrelated code across architectures. Other than that this looks good to me.
Sure, will use PAPR_NVDIMM instead of PAPR_SCM for new code being introduced. However certain identifiers like H_SCM_HEALTH are taken from the papr specificiation hence need to use the same name.
Quoted 85 lines
Quoted 85 lines
Cc "Aneesh Kumar K . V" <[email protected]>Cc Dan Williams <[email protected]>Cc Michael Ellerman <[email protected]>Cc Ira Weiny <[email protected]>Signed-off-by Vaibhav Jain <[email protected]>---
Changelog:
v7..v8:
* Added a clarification on bit-ordering of Health BitmapResend:
* Nonev6..v7:
* Nonev5..v6:
* New patch in the series--- Documentation/powerpc/papr_hcalls.rst | 45 ++++++++++++++++++++++++--- 1 file changed, 41 insertions(+), 4 deletions(-)Documentation/powerpc/papr_hcalls.rst +41
-5@@ -220,13 +220,50 @@ from the LPAR memory. **H_SCM_HEALTH** | Input: drcIndex -| Out: *health-bitmap, health-bit-valid-bitmap* +| Out: *health-bitmap (r4), health-bit-valid-bitmap (r5)* | Return Value: *H_Success, H_Parameter, H_Hardware* Given a DRC Index return the info on predictive failure and overall health of -the NVDIMM. The asserted bits in the health-bitmap indicate a single predictive -failure and health-bit-valid-bitmap indicate which bits in health-bitmap are -valid. +the NVDIMM. The asserted bits in the health-bitmap indicate one or more states +(described in table below) of the NVDIMM and health-bit-valid-bitmap indicate +which bits in health-bitmap are valid. The bits are reported in +reverse bit ordering for example a value of 0xC400000000000000 +indicates bits 0, 1, and 5 are valid. + +Health Bitmap Flags: + ++------+-----------------------------------------------------------------------+ +| Bit | Definition | ++======+=======================================================================+ +| 00 | SCM device is unable to persist memory contents. | +| | If the system is powered down, nothing will be saved. | ++------+-----------------------------------------------------------------------+ +| 01 | SCM device failed to persist memory contents. Either contents were not| +| | saved successfully on power down or were not restored properly on | +| | power up. | ++------+-----------------------------------------------------------------------+ +| 02 | SCM device contents are persisted from previous IPL. The data from | +| | the last boot were successfully restored. | ++------+-----------------------------------------------------------------------+ +| 03 | SCM device contents are not persisted from previous IPL. There was no | +| | data to restore from the last boot. | ++------+-----------------------------------------------------------------------+ +| 04 | SCM device memory life remaining is critically low | ++------+-----------------------------------------------------------------------+ +| 05 | SCM device will be garded off next IPL due to failure | ++------+-----------------------------------------------------------------------+ +| 06 | SCM contents cannot persist due to current platform health status. A | +| | hardware failure may prevent data from being saved or restored. | ++------+-----------------------------------------------------------------------+ +| 07 | SCM device is unable to persist memory contents in certain conditions | ++------+-----------------------------------------------------------------------+ +| 08 | SCM device is encrypted | ++------+-----------------------------------------------------------------------+ +| 09 | SCM device has successfully completed a requested erase or secure | +| | erase procedure. | ++------+-----------------------------------------------------------------------+ +|10:63 | Reserved / Unused | ++------+-----------------------------------------------------------------------+ **H_SCM_PERFORMANCE_STATS** --2.26.2
Signature · 5 lines
Cheers ~ Vaibhav _______________________________________________ Linux-nvdimm mailing list -- [email protected] To unsubscribe send an email to [email protected]
PATCH v8 2/5 seq_buf: Export seq_buf_printf
In reply to Vaibhav Jain'seq_buf' provides a very useful abstraction for writing to a string buffer without needing to worry about it over-flowing. However even though the API has been stable for couple of years now its still not exported to kernel loadable modules limiting its usage.
Hence this patch proposes update to 'seq_buf.c' to mark seq_buf_printf() which is part of the seq_buf API to be exported to kernel loadable GPL modules. This symbol will be used in later parts of this patch-set to simplify content creation for a sysfs attribute.
---
Changelog:
v7..v8:
* Updated the patch title [ Christoph Hellwig ]
* Updated patch description to replace confusing term 'external kernel modules' to 'kernel lodable modules'.
Resend:
* Added ack from Steven Rostedt
v6..v7:
* New patch in the series
--- lib/seq_buf.c | 1 + 1 file changed, 1 insertion(+)
lib/seq_buf.c +1 -0
@@ -91,6 +91,7 @@ int seq_buf_printf(struct seq_buf *s, const char *fmt, ...)return ret; } +EXPORT_SYMBOL_GPL (seq_buf_printf);#ifdef CONFIG_BINARY_PRINTF /**
Signature · 4 lines
2.26.2 _______________________________________________ Linux-nvdimm mailing list -- [email protected] To unsubscribe send an email to [email protected]
Re: [PATCH v8 2/5] seq_buf: Export seq_buf_printf
Hi Christoph and Steven,
Have addressed your review comment to update the patch description and title for this patch. Can you please provide your ack to this patch.
Thanks,
~ Vaibhav
Quoted 48 lines · Vaibhav Jain
'
seq_buf' provides a very useful abstraction for writing to a string buffer without needing to worry about it over-flowing. However even though the API has been stable for couple of years now its still not exported to kernel loadable modules limiting its usage.Hence this patch proposes update to '
seq_buf.c' to markseq_buf_printf()which is part of theseq_bufAPI to be exported to kernel loadable GPL modules. This symbol will be used in later parts of this patch-set to simplify content creation for a sysfs attribute.Cc Piotr Maziarz <[email protected]>Cc Cezary Rojewski <[email protected]>Cc Christoph Hellwig <[email protected]>Cc Steven Rostedt <[email protected]>Cc Borislav Petkov <[email protected]>Signed-off-by Vaibhav Jain <[email protected]>---
Changelog:v7..v8:
* Updated the patch title [ Christoph Hellwig ]
* Updated patch description to replace confusing term 'external kernel modules' to 'kernel lodable modules'.Resend:
* Added ack from Steven Rostedtv6..v7:
* New patch in the series--- lib/seq_buf.c | 1 + 1 file changed, 1 insertion(+)lib/seq_buf.c +1
-0@@ -91,6 +91,7 @@ int seq_buf_printf(struct seq_buf *s, const char *fmt, ...)return ret; } +EXPORT_SYMBOL_GPL (seq_buf_printf);#ifdef CONFIG_BINARY_PRINTF /** Signature · 1 line
2.26.2
Signature · 3 lines
_______________________________________________ Linux-nvdimm mailing list -- [email protected] To unsubscribe send an email to [email protected]
Steven Rostedt
Acked-byRe: [PATCH v8 2/5] seq_buf: Export seq_buf_printf
Quoted 6 lines · On Mon, 01 Jun 2020 17:31:31 +0530 Vaibhav Jain <[email protected]> wrote:
Hi Christoph and Steven,
Have addressed your review comment to update the patch description and title for this patch. Can you please provide your ack to this patch.
I thought I already did, but it appears it was a reply to a private email you sent to me. I didn't realize it was off list.
Anyway:
-- Steve
Re: [PATCH v8 2/5] seq_buf: Export seq_buf_printf
Quoted 10 lines · Steven Rostedt
Quoted 6 lines · On Mon, 01 Jun 2020 17:31:31 +0530 Vaibhav Jain <[email protected]> wrote:
Hi Christoph and Steven,
Have addressed your review comment to update the patch description and title for this patch. Can you please provide your ack to this patch.
Quoted 6 lines
I thought I already did, but it appears it was a reply to a private email you sent to me. I didn't realize it was off list.
Anyway:
Thanks Steven,
Had added your ack to Resend-v7 of this patch at [1] on which Christoph Hellwig requested an update of patch title. Hence needed your re-ack for this version of the patch
[1] : https://lore.kernel.org/linux-nvdimm/[email protected]/
Quoted 2 lines
-- Steve
Cheers
~ Vaibhav
_______________________________________________
Linux-nvdimm mailing list -- [email protected] To unsubscribe send an email to [email protected]
PATCH v8 3/5 powerpc/papr_scm: Fetch nvdimm health information from PHYP
In reply to Vaibhav JainImplement support for fetching nvdimm health information via H_SCM_HEALTH hcall as documented in Ref[1]. The hcall returns a pair of 64-bit bitmap, bitwise-and of which is then stored in 'struct papr_scm_priv' and subsequently partially exposed to user-space via newly introduced dimm specific attribute 'papr/flags'. Since the hcall is costly, the health information is cached and only re-queried, 60s after the previous successful hcall.
The patch also adds a documentation text describing flags reported by the the new sysfs attribute 'papr/flags' is also introduced at Documentation/ABI/testing/sysfs-bus-papr-scm.
[1] commit 58b278f568f0 ("powerpc: Provide initial documentation for PAPR hcalls")
---
Changelog:
v7..v8:
* Update type of variable 'rc' in __drc_pmem_query_health() and drc_pmem_query_health() to long and int respectively. [ Ira ]
* Updated the patch description to s/64 bit Big Endian Number/64-bit bitmap/ [ Ira, Aneesh ].
Resend:
* None
v6..v7 :
* Used the exported buf_seq_printf() function to generate content for 'papr/flags'
* Moved the PAPR_SCM_DIMM_* bit-flags macro definitions to papr_scm.c and removed the papr_scm.h file [Mpe]
* Some minor consistency issued in sysfs-bus-papr-scm documentation. [Mpe]
* s/dimm_mutex/health_mutex/g [Mpe]
* Split drc_pmem_query_health() into two function one of which takes care of caching and locking. [Mpe]
* Fixed a local copy creation of dimm health information using READ_ONCE(). [Mpe]
v5..v6 :
* Change the flags sysfs attribute from 'papr_flags' to 'papr/flags' [Dan Williams]
* Include documentation for 'papr/flags' attr [Dan Williams]
* Change flag 'save_fail' to 'flush_fail' [Dan Williams]
* Caching of health bitmap to reduce expensive hcalls [Dan Williams]
* Removed usage of PPC_BIT from 'papr-scm.h' header [Mpe]
* Replaced two __be64 integers from papr_scm_priv to a single u64 integer [Mpe]
* Updated patch description to reflect the changes made in this version.
* Removed avoidable usage of 'papr_scm_priv.dimm_mutex' from flags_show() [Dan Williams]
v4..v5 :
* None
v3..v4 :
* None
v2..v3 :
* Removed PAPR_SCM_DIMM_HEALTH_NON_CRITICAL as a condition for NVDIMM unarmed [Aneesh]
v1..v2 :
* New patch in the series.
--- Documentation/ABI/testing/sysfs-bus-papr-scm | 27 +++ arch/powerpc/platforms/pseries/papr_scm.c | 169 ++++++++++++++++++- 2 files changed, 194 insertions(+), 2 deletions(-) create mode 100644 Documentation/ABI/testing/sysfs-bus-papr-scm
Documentation/ABI/testing/sysfs-bus-papr-scm new file +27 -0
@@ -0,0 +1,27 @@ +What: /sys/bus/nd/devices/nmemX/papr/flags +Date: Apr, 2020 +KernelVersion: v5.8 +Contact: linuxppc-dev <[email protected]>, [email protected], +Description: + (RO) Report flags indicating various states of a + papr-scm NVDIMM device. Each flag maps to a one or + more bits set in the dimm-health-bitmap retrieved in + response to H_SCM_HEALTH hcall. The details of the bit + flags returned in response to this hcall is available + at 'Documentation/powerpc/papr_hcalls.rst' . Below are + the flags reported in this sysfs file: + + * "not_armed" : Indicates that NVDIMM contents will not + survive a power cycle. + * "flush_fail" : Indicates that NVDIMM contents + couldn't be flushed during last + shut-down event. + * "restore_fail": Indicates that NVDIMM contents + couldn't be restored during NVDIMM + initialization. + * "encrypted" : NVDIMM contents are encrypted. + * "smart_notify": There is health event for the NVDIMM. + * "scrubbed" : Indicating that contents of the + NVDIMM have been scrubbed. + * "locked" : Indicating that NVDIMM contents cant + be modified until next power cycle.
arch/powerpc/platforms/pseries/papr_scm.c +167 -2
211 lines not on this page · raw message
Signature · 4 lines
2.26.2 _______________________________________________ Linux-nvdimm mailing list -- [email protected] To unsubscribe send an email to [email protected]
Re: [PATCH v8 3/5] powerpc/papr_scm: Fetch nvdimm health information from PHYP
Quoted 8 lines · Vaibhav Jain
Implement support for fetching nvdimm health information via
H_SCM_HEALTHhcall as documented in Ref[1]. The hcall returns a pair of 64-bit bitmap, bitwise-and of which is then stored in 'structpapr_scm_priv' and subsequently partially exposed to user-space via newly introduced dimm specific attribute 'papr/flags'. Since the hcall is costly, the health information is cached and only re-queried, 60s after the previous successful hcall.
Quoted 7 lines
The patch also adds a documentation text describing flags reported by the the new sysfs attribute 'papr/flags' is also introduced at
Documentation/ABI/testing/sysfs-bus-papr-scm.[1] commit
58b278f568f0("powerpc: Provide initial documentation for PAPR hcalls")
Quoted 5 lines
Cc "Aneesh Kumar K . V" <[email protected]>Cc Dan Williams <[email protected]>Cc Michael Ellerman <[email protected]>Cc Ira Weiny <[email protected]>Signed-off-by Vaibhav Jain <[email protected]>
_______________________________________________
Linux-nvdimm mailing list -- [email protected] To unsubscribe send an email to [email protected]
PATCH v8 4/5 ndctl/papr_scm,uapi: Add support for PAPR nvdimm specific methods
In reply to Vaibhav JainIntroduce support for PAPR NVDIMM Specific Methods (PDSM) in papr_scm module and add the command family to the white list of NVDIMM command sets. Also advertise support for ND_CMD_CALL for the nvdimm command mask and implement necessary scaffolding in the module to handle ND_CMD_CALL ioctl and PDSM requests that we receive.
The layout of the PDSM request as we expect from libnvdimm/libndctl is described in newly introduced uapi header 'papr_scm_pdsm.h' which defines a new 'struct nd_pdsm_cmd_pkg' header. This header is used to communicate the PDSM request via member 'nd_pkg_papr_scm->nd_command' and size of payload that need to be sent/received for servicing the PDSM.
A new function is_cmd_valid() is implemented that reads the args to papr_scm_ndctl() and performs sanity tests on them. A new function papr_scm_service_pdsm() is introduced and is called from papr_scm_ndctl() in case of a PDSM request is received via ND_CMD_CALL command from libnvdimm.
---
Changelog:
v7..v8:
* Removed the 'payload_offset' field from 'struct nd_pdsm_cmd_pkg'. Instead command payload is always assumed to start at 'nd_pdsm_cmd_pkg.payload'. [ Aneesh ]
* To enable introducing new fields to 'struct nd_pdsm_cmd_pkg', 'reserved' field of 10-bytes is introduced. [ Aneesh ]
* Fixed a typo in "Backward Compatibility" section of papr_scm_pdsm.h [ Ira ]
Resend:
* None
v6..v7 :
* Removed the re-definitions of __packed macro from papr_scm_pdsm.h [Mpe].
* Removed the usage of __KERNEL__ macros in papr_scm_pdsm.h [Mpe].
* Removed macros that were unused in papr_scm.c from papr_scm_pdsm.h [Mpe].
* Made functions defined in papr_scm_pdsm.h as static inline. [Mpe]
v5..v6 :
* Changed the usage of the term DSM to PDSM to distinguish it from the ACPI term [ Dan Williams ]
* Renamed papr_scm_dsm.h to papr_scm_pdsm.h and updated various struct to reflect the new terminology.
* Updated the patch description and title to reflect the new terminology.
* Squashed patch to introduce new command family in 'ndctl.h' with this patch [ Dan Williams ]
* Updated the papr_scm_pdsm method starting index from 0x10000 to 0x0 [ Dan Williams ]
* Removed redundant license text from the papr_scm_psdm.h file. [ Dan Williams ]
* s/envelop/envelope/ at various places [ Dan Williams ]
* Added '__packed' attribute to command package header to gaurd against different compiler adding paddings between the fields. [ Dan Williams]
* Converted various pr_debug to dev_debug [ Dan Williams ]
v4..v5 :
* None
v3..v4 :
* None
v2..v3 :
* Updated the patch prefix to 'ndctl/uapi' [Aneesh]
v1..v2 :
* None
--- arch/powerpc/include/uapi/asm/papr_scm_pdsm.h | 136 ++++++++++++++++++ arch/powerpc/platforms/pseries/papr_scm.c | 101 ++++++++++++- include/uapi/linux/ndctl.h | 1 + 3 files changed, 232 insertions(+), 6 deletions(-) create mode 100644 arch/powerpc/include/uapi/asm/papr_scm_pdsm.h
arch/powerpc/include/uapi/asm/papr_scm_pdsm.h new file +136 -0
@@ -0,0 +1,136 @@ +/* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */ +/* +* PAPR-SCM Dimm specific methods (PDSM) and structs for libndctl +* +* (C) Copyright IBM 2020 +* +* Author: Vaibhav Jain <vaibhav at linux.ibm.com> +*/ + +#ifndef _UAPI_ASM_POWERPC_PAPR_SCM_PDSM_H_ +#define _UAPI_ASM_POWERPC_PAPR_SCM_PDSM_H_ + +#include <linux/types.h> + +/* +* PDSM Envelope: +* +* The ioctl ND_CMD_CALL transfers data between user-space and kernel via +* envelope which consists of a header and user-defined payload sections. +* The header is described by 'struct nd_pdsm_cmd_pkg' which expects a +* payload following it and accessible via 'nd_pdsm_cmd_pkg.payload' field. +* There is reserved field that can used to introduce new fields to the +* structure in future. It also tries to ensure that 'nd_pdsm_cmd_pkg.payload' +* lies at a 8-byte boundary. +* +* +-------------+---------------------+---------------------------+ +* | 64-Bytes | 16-Bytes | Max 176-Bytes | +* +-------------+---------------------+---------------------------+ +* | nd_pdsm_cmd_pkg | | +* |-------------+ | | +* | nd_cmd_pkg | | | +* +-------------+---------------------+---------------------------+ +* | nd_family | | | +* | nd_size_out | cmd_status | | +* | nd_size_in | payload_version | payload | +* | nd_command | reserved | | +* | nd_fw_size | | | +* +-------------+---------------------+---------------------------+ +* +* PDSM Header: +* +* The header is defined as 'struct nd_pdsm_cmd_pkg' which embeds a +* 'struct nd_cmd_pkg' instance. The PDSM command is assigned to member +* 'nd_cmd_pkg.nd_command'. Apart from size information of the envelope which is +* contained in 'struct nd_cmd_pkg', the header also has members following +* members: +* +* 'cmd_status' : (Out) Errors if any encountered while servicing PDSM. +* 'payload_version' : (In/Out) Version number associated with the payload. +* 'reserved' : Not used and reserved for future. +* +* PDSM Payload: +* +* The layout of the PDSM Payload is defined by various structs shared between +* papr_scm and libndctl so that contents of payload can be interpreted. During +* servicing of a PDSM the papr_scm module will read input args from the payload +* field by casting its contents to an appropriate struct pointer based on the +* PDSM command. Similarly the output of servicing the PDSM command will be +* copied to the payload field using the same struct. +* +* 'libnvdimm' enforces a hard limit of 256 bytes on the envelope size, which +* leaves around 176 bytes for the envelope payload (ignoring any padding that +* the compiler may silently introduce). +* +* Payload Version: +* +* A 'payload_version' field is present in PDSM header that indicates a specific +* version of the structure present in PDSM Payload for a given PDSM command. +* This provides backward compatibility in case the PDSM Payload structure +* evolves and different structures are supported by 'papr_scm' and 'libndctl'. +* +* When sending a PDSM Payload to 'papr_scm', 'libndctl' should send the version +* of the payload struct it supports via 'payload_version' field. The 'papr_scm' +* module when servicing the PDSM envelope checks the 'payload_version' and then +* uses 'payload struct version' == MIN('payload_version field', +* 'max payload-struct-version supported by papr_scm') to service the PDSM. +* After servicing the PDSM, 'papr_scm' put the negotiated version of payload +* struct in returned 'payload_version' field. +* +* Libndctl on receiving the envelope back from papr_scm again checks the +* 'payload_version' field and based on it use the appropriate version dsm +* struct to parse the results. +* +* Backward Compatibility: +* +* Above scheme of exchanging different versioned PDSM struct between libndctl +* and papr_scm should provide backward compatibility until following two +* assumptions/conditions when defining new PDSM structs hold: +* +* Let T(X) = { set of attributes in PDSM struct 'T' versioned X } +* +* 1. T(X) is a proper subset of T(Y) if Y > X. +* i.e Each new version of PDSM struct should retain existing struct +* attributes from previous version +* +* 2. If an entity (libndctl or papr_scm) supports a PDSM struct T(X) then +* it should also support T(1), T(2)...T(X - 1). +* i.e When adding support for new version of a PDSM struct, libndctl +* and papr_scm should retain support of the existing PDSM struct +* version they support. +*/ + +/* Papr-scm-header + payload expected with ND_CMD_CALL ioctl from libnvdimm */ +struct nd_pdsm_cmd_pkg { +struct nd_cmd_pkg hdr;/* Package header containing sub-cmd */ +__s32 cmd_status;/* Out: Sub-cmd status returned back */ +__u16 reserved[5 ];/* Ignored and to be used in future */ +__u16 payload_version;/* In/Out: version of the payload */ +__u8 payload[];/* In/Out: Sub-cmd data buffer */ +} __packed; + +/* +* Methods to be embedded in ND_CMD_CALL request. These are sent to the kernel +* via 'nd_pdsm_cmd_pkg.hdr.nd_command' member of the ioctl struct +*/ +enum papr_scm_pdsm { +PAPR_SCM_PDSM_MIN =0x0 , +PAPR_SCM_PDSM_MAX , +}; + +/* Convert a libnvdimm nd_cmd_pkg to pdsm specific pkg */ +static inline struct nd_pdsm_cmd_pkg *nd_to_pdsm_cmd_pkg (struct nd_cmd_pkg *cmd) +{ +return (struct nd_pdsm_cmd_pkg *) cmd; +} + +/* Return the payload pointer for a given pcmd */ +static inline void *pdsm_cmd_to_payload (struct nd_pdsm_cmd_pkg *pcmd) +{ +if (pcmd->hdr.nd_size_in ==0 && pcmd->hdr.nd_size_out ==0 ) +return NULL ; +else +return (void *)(pcmd->payload); +} + +#endif /* _UAPI_ASM_POWERPC_PAPR_SCM_PDSM_H_ */
arch/powerpc/platforms/pseries/papr_scm.c +95 -6
137 lines not on this page · raw message
include/uapi/linux/ndctl.h +1 -0
@@ -244,6 +244,7 @@ struct nd_cmd_pkg {#define NVDIMM_FAMILY_HPE2 2#define NVDIMM_FAMILY_MSFT 3#define NVDIMM_FAMILY_HYPERV 4 +#define NVDIMM_FAMILY_PAPR_SCM 5#define ND_IOCTL_CALL _IOWR(ND_IOCTL, ND_CMD_CALL,\ struct nd_cmd_pkg)
Signature · 4 lines
2.26.2 _______________________________________________ Linux-nvdimm mailing list -- [email protected] To unsubscribe send an email to [email protected]
Re: [PATCH v8 4/5] ndctl/papr_scm,uapi: Add support for PAPR nvdimm specific methods
Quoted 13 lines · Vaibhav Jain
Introduce support for PAPR NVDIMM Specific Methods (PDSM) in
papr_scmmodule and add the command family to the white list of NVDIMM command sets. Also advertise support forND_CMD_CALLfor the nvdimm command mask and implement necessary scaffolding in the module to handleND_CMD_CALLioctl and PDSM requests that we receive.The layout of the PDSM request as we expect from libnvdimm/libndctl is described in newly introduced uapi header '
papr_scm_pdsm.h' which defines a new 'structnd_pdsm_cmd_pkg' header. This header is used to communicate the PDSM request via member 'nd_pkg_papr_scm->nd_command' and size of payload that need to be sent/received for servicing the PDSM.
Quoted 6 lines
A new function
is_cmd_valid()is implemented that reads the args topapr_scm_ndctl()and performs sanity tests on them. A new functionpapr_scm_service_pdsm()is introduced and is called frompapr_scm_ndctl()in case of a PDSM request is received viaND_CMD_CALLcommand from libnvdimm.
Quoted 6 lines
Cc "Aneesh Kumar K . V" <[email protected]>Cc Dan Williams <[email protected]>Cc Michael Ellerman <[email protected]>Cc Ira Weiny <[email protected]>Signed-off-by Vaibhav Jain <[email protected]>---
-aneesh
_______________________________________________
Linux-nvdimm mailing list -- [email protected] To unsubscribe send an email to [email protected]
PATCH v8 5/5 powerpc/papr_scm: Implement support for PAPR_SCM_PDSM_HEALTH
In reply to Vaibhav JainThis patch implements support for PDSM request 'PAPR_SCM_PDSM_HEALTH' that returns a newly introduced 'struct nd_papr_pdsm_health' instance containing dimm health information back to user space in response to ND_CMD_CALL. This functionality is implemented in newly introduced papr_scm_get_health() that queries the scm-dimm health information and then copies this information to the package payload whose layout is defined by 'struct nd_papr_pdsm_health'.
The patch also introduces a new member 'struct papr_scm_priv.health' thats an instance of 'struct nd_papr_pdsm_health' to cache the health information of a nvdimm. As a result functions drc_pmem_query_health() and flags_show() are updated to populate and use this new struct instead of a u64 integer that was earlier used.
---
Changelog:
v7..v8:
* None
Resend:
* None
v6..v7:
* Updated flags_show() to use seq_buf_printf(). [Mpe]
* Updated papr_scm_get_health() to use newly introduced __drc_pmem_query_health() bypassing the cache [Mpe].
v5..v6:
* Added attribute '__packed' to 'struct nd_papr_pdsm_health_v1' to gaurd against possibility of different compilers adding different paddings to the struct [ Dan Williams ]
* Updated 'struct nd_papr_pdsm_health_v1' to use __u8 instead of 'bool' and also updated drc_pmem_query_health() to take this into account. [ Dan Williams ]
v4..v5:
* None
v3..v4:
* Call the DSM_PAPR_SCM_HEALTH service function from papr_scm_service_dsm() instead of papr_scm_ndctl(). [Aneesh]
v2..v3:
* Updated struct nd_papr_scm_dimm_health_stat_v1 to use '__xx' types as its exported to the userspace [Aneesh]
* Changed the constants DSM_PAPR_SCM_DIMM_XX indicating dimm health from enum to #defines [Aneesh]
v1..v2:
* New patch in the series
--- arch/powerpc/include/uapi/asm/papr_scm_pdsm.h | 39 ++++++ arch/powerpc/platforms/pseries/papr_scm.c | 125 +++++++++++++++--- 2 files changed, 147 insertions(+), 17 deletions(-)
arch/powerpc/include/uapi/asm/papr_scm_pdsm.h +39 -0
@@ -115,6 +115,7 @@ struct nd_pdsm_cmd_pkg {*/ enum papr_scm_pdsm {PAPR_SCM_PDSM_MIN =0x0 , +PAPR_SCM_PDSM_HEALTH ,PAPR_SCM_PDSM_MAX , };
@@ -133,4 +134,42 @@ static inline void *pdsm_cmd_to_payload(struct nd_pdsm_cmd_pkg *pcmd) return (void *)(pcmd->payload); } +/* Various scm-dimm health indicators */ +#define PAPR_PDSM_DIMM_HEALTHY 0 +#define PAPR_PDSM_DIMM_UNHEALTHY 1 +#define PAPR_PDSM_DIMM_CRITICAL 2 +#define PAPR_PDSM_DIMM_FATAL 3 + +/* +* Struct exchanged between kernel & ndctl in for PAPR_SCM_PDSM_HEALTH +* Various flags indicate the health status of the dimm. +* +* dimm_unarmed : Dimm not armed. So contents wont persist. +* dimm_bad_shutdown : Previous shutdown did not persist contents. +* dimm_bad_restore : Contents from previous shutdown werent restored. +* dimm_scrubbed : Contents of the dimm have been scrubbed. +* dimm_locked : Contents of the dimm cant be modified until CEC reboot +* dimm_encrypted : Contents of dimm are encrypted. +* dimm_health : Dimm health indicator. One of PAPR_PDSM_DIMM_XXXX +*/ +struct nd_papr_pdsm_health_v1 { +__u8 dimm_unarmed; +__u8 dimm_bad_shutdown; +__u8 dimm_bad_restore; +__u8 dimm_scrubbed; +__u8 dimm_locked; +__u8 dimm_encrypted; +__u16 dimm_health; +} __packed; + +/* +* Typedef the current struct for dimm_health so that any application +* or kernel recompiled after introducing a new version automatically +* supports the new version. +*/ +#define nd_papr_pdsm_health nd_papr_pdsm_health_v1 + +/* Current version number for the dimm health struct */ +#define ND_PAPR_PDSM_HEALTH_VERSION 1 +#endif /* _UAPI_ASM_POWERPC_PAPR_SCM_PDSM_H_ */
arch/powerpc/platforms/pseries/papr_scm.c +108 -17
185 lines not on this page · raw message
Signature · 4 lines
2.26.2 _______________________________________________ Linux-nvdimm mailing list -- [email protected] To unsubscribe send an email to [email protected]
Re: [PATCH v8 5/5] powerpc/papr_scm: Implement support for PAPR_SCM_PDSM_HEALTH
Quoted 8 lines · Vaibhav Jain
This patch implements support for PDSM request '
PAPR_SCM_PDSM_HEALTH' that returns a newly introduced 'structnd_papr_pdsm_health' instance containing dimm health information back to user space in response toND_CMD_CALL. This functionality is implemented in newly introducedpapr_scm_get_health()that queries the scm-dimm health information and then copies this information to the package payload whose layout is defined by 'structnd_papr_pdsm_health'.
Quoted 6 lines
The patch also introduces a new member 'struct papr_scm_priv.health' thats an instance of 'struct
nd_papr_pdsm_health' to cache the health information of a nvdimm. As a result functionsdrc_pmem_query_health()andflags_show()are updated to populate and use this new struct instead of a u64 integer that was earlier used.
Quoted 5 lines
Cc "Aneesh Kumar K . V" <[email protected]>Cc Dan Williams <[email protected]>Cc Michael Ellerman <[email protected]>Cc Ira Weiny <[email protected]>Signed-off-by Vaibhav Jain <[email protected]>
-aneesh
_______________________________________________
Linux-nvdimm mailing list -- [email protected] To unsubscribe send an email to [email protected]