From patchwork Tue Aug 7 22:26:55 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Keith Busch X-Patchwork-Id: 10559293 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 92FDC174A for ; Tue, 7 Aug 2018 22:26:28 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 836022A5A7 for ; Tue, 7 Aug 2018 22:26:28 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 76A4F2A5DF; Tue, 7 Aug 2018 22:26:28 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 Received: from ml01.01.org (ml01.01.org [198.145.21.10]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id E17F22A5A3 for ; Tue, 7 Aug 2018 22:26:27 +0000 (UTC) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id B7E43210DF5DA; Tue, 7 Aug 2018 15:26:27 -0700 (PDT) X-Original-To: linux-nvdimm@lists.01.org Delivered-To: linux-nvdimm@lists.01.org Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=192.55.52.115; helo=mga14.intel.com; envelope-from=keith.busch@intel.com; receiver=linux-nvdimm@lists.01.org Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 8B126210DF5D1 for ; Tue, 7 Aug 2018 15:26:26 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 07 Aug 2018 15:26:26 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.51,456,1526367600"; d="scan'208";a="61412781" Received: from unknown (HELO localhost.lm.intel.com) ([10.232.112.44]) by fmsmga008.fm.intel.com with ESMTP; 07 Aug 2018 15:26:25 -0700 From: Keith Busch To: Vishal Verma , Dave Jiang , linux-nvdimm@lists.01.org Subject: [PATCH 1/2] Create Intel pmem shutdown latch rule Date: Tue, 7 Aug 2018 16:26:55 -0600 Message-Id: <20180807222656.14346-1-keith.busch@intel.com> X-Mailer: git-send-email 2.13.6 X-BeenThere: linux-nvdimm@lists.01.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: "Linux-nvdimm developer list." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: linux-nvdimm-bounces@lists.01.org Sender: "Linux-nvdimm" X-Virus-Scanned: ClamAV using ClamSMTP This patch provides a udev rule and the program it runs for Intel nvdimms. The program the rule executes runs two commands to allow applications to manage unsafe shutdowns. The first command enables the shutdown latch. Without this, the last shutdown status will remain fixed to the status set when the latch was last enabled. The second command retrieves the unclean shutdown counts and saves it in a known location. Only root can access the health's shutdown count, so we have to stash it somewhere accessible to non-privileged users. A successful execution of the rule will write USC to the run time tmpfs location. By default, the location will be set to: /run/ndctl//usc A distro may change this location using the '--with-tmpfsdir=[DIR]'. Reading the file will report the count observed when the dimm was added. Signed-off-by: Keith Busch --- .gitignore | 1 + Makefile.am | 3 + configure.ac | 10 ++++ contrib/80-intel-pmem.rules | 1 + ndctl.spec.in | 5 +- ndctl/Makefile.am | 5 ++ ndctl/latch-shutdown.c | 140 ++++++++++++++++++++++++++++++++++++++++++++ 7 files changed, 164 insertions(+), 1 deletion(-) create mode 100644 contrib/80-intel-pmem.rules create mode 100644 ndctl/latch-shutdown.c diff --git a/.gitignore b/.gitignore index 1016b3b..1601738 100644 --- a/.gitignore +++ b/.gitignore @@ -25,6 +25,7 @@ daxctl/lib/libdaxctl.pc *.a ndctl/lib/libndctl.pc ndctl/ndctl +ndctl/latch-shutdown rhel/ sles/ndctl.spec util/log.lo diff --git a/Makefile.am b/Makefile.am index e0c463a..9d3913e 100644 --- a/Makefile.am +++ b/Makefile.am @@ -42,6 +42,9 @@ bashcompletiondir = $(BASH_COMPLETION_DIR) dist_bashcompletion_DATA = contrib/ndctl endif +udevrulesdir = $(UDEVDIR)/rules.d +dist_udevrules_DATA = contrib/80-intel-pmem.rules + noinst_LIBRARIES = libccan.a libccan_a_SOURCES = \ ccan/str/str.h \ diff --git a/configure.ac b/configure.ac index cf44260..15f336b 100644 --- a/configure.ac +++ b/configure.ac @@ -143,7 +143,16 @@ AC_CHECK_FUNCS([ \ secure_getenv\ ]) +AC_ARG_WITH([tmpfsdir], + [AS_HELP_STRING([--with-tmpfsdir=DIR], [Directory for temporary runtime files])], + [tmpfsdir=$withval], + [tmpfsdir="/run"]) + +UDEVDIR="$(pkg-config udev --variable=udevdir)" +AC_SUBST([UDEVDIR]) + my_CFLAGS="\ +-D DEF_TMPFS_DIR='\"${tmpfsdir}/ndctl\"' \ -Wall \ -Wchar-subscripts \ -Wformat-security \ @@ -182,6 +191,7 @@ AC_MSG_RESULT([ prefix: ${prefix} sysconfdir: ${sysconfdir} + tmpfsdir: ${tmpfsdir} libdir: ${libdir} includedir: ${includedir} diff --git a/contrib/80-intel-pmem.rules b/contrib/80-intel-pmem.rules new file mode 100644 index 0000000..20fcef9 --- /dev/null +++ b/contrib/80-intel-pmem.rules @@ -0,0 +1 @@ +ACTION=="add", KERNEL=="nmem*", RUN+="latch-shutdown $kernel" diff --git a/ndctl.spec.in b/ndctl.spec.in index e2c879c..25edf7e 100644 --- a/ndctl.spec.in +++ b/ndctl.spec.in @@ -90,7 +90,7 @@ control API for these devices. %build echo %{version} > version ./autogen.sh -%configure --disable-static --disable-silent-rules +%configure --disable-static --disable-silent-rules --with-tmpfsdir=%{_tmpfilesdir} make %{?_smp_mflags} %install @@ -109,6 +109,7 @@ make check %postun -n DAX_LNAME -p /sbin/ldconfig %define bashcompdir %(pkg-config --variable=completionsdir bash-completion) +%define udevdir %(pkg-config --variable=udevdir udev) %files %defattr(-,root,root) @@ -116,6 +117,8 @@ make check %{_bindir}/ndctl %{_mandir}/man1/ndctl* %{bashcompdir}/ +%{_udevrulesdir}/80-intel-pmem.rules +%{udevdir}/latch-shutdown %files -n daxctl %defattr(-,root,root) diff --git a/ndctl/Makefile.am b/ndctl/Makefile.am index 0f56871..155179b 100644 --- a/ndctl/Makefile.am +++ b/ndctl/Makefile.am @@ -41,3 +41,8 @@ ndctl_SOURCES += ../test/libndctl.c \ ../test/core.c \ test.c endif + +latch_shutdowndir = $(UDEVDIR) +latch_shutdown_PROGRAMS = latch-shutdown +latch_shutdown_SOURCES = latch-shutdown.c +latch_shutdown_LDADD = lib/libndctl.la diff --git a/ndctl/latch-shutdown.c b/ndctl/latch-shutdown.c new file mode 100644 index 0000000..704fb8f --- /dev/null +++ b/ndctl/latch-shutdown.c @@ -0,0 +1,140 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* Copyright(c) 2018 Intel Corporation. All rights reserved. */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/** + * mkdir_p + * + * Copied from util-linux lib/fileutils.c + */ +static int mkdir_p(const char *path, mode_t mode) +{ + char *p, *dir; + int rc = 0; + + if (!path || !*path) + return -EINVAL; + + dir = p = strdup(path); + if (!dir) + return -ENOMEM; + + if (*p == '/') + p++; + + while (p && *p) { + char *e = strchr(p, '/'); + if (e) + *e = '\0'; + if (*p) { + rc = mkdir(dir, mode); + if (rc && errno != EEXIST) + break; + rc = 0; + } + if (!e) + break; + *e = '/'; + p = e + 1; + } + + free(dir); + return rc; +} + +static struct ndctl_dimm *find_dimm(struct ndctl_ctx *ctx, char *devname) +{ + struct ndctl_bus *bus; + struct ndctl_dimm *dimm; + + ndctl_bus_foreach(ctx, bus) { + ndctl_dimm_foreach(bus, dimm) { + if (strcmp(ndctl_dimm_get_devname(dimm), devname) == 0) + return dimm; + } + } + return NULL; +} + +int main(int argc, char *argv[]) +{ + struct ndctl_ctx *ctx; + struct ndctl_cmd *cmd; + struct ndctl_dimm *dimm = NULL; + char *path, *usc, count[16]; + const char *id; + unsigned int shutdown; + int rc, fd; + + if (argc < 2) + return EINVAL; + + rc = ndctl_new(&ctx); + if (rc) + return ENOMEM; + + dimm = find_dimm(ctx, argv[1]); + if (!dimm) + return ENODEV; + + cmd = ndctl_dimm_cmd_new_ack_shutdown_count(dimm); + if (!cmd) + return ENOMEM; + + rc = ndctl_cmd_submit(cmd); + if (rc) + return rc; + ndctl_cmd_unref(cmd); + + id = ndctl_dimm_get_unique_id(dimm); + if (!id) + return ENXIO; + + cmd = ndctl_dimm_cmd_new_smart(dimm); + if (!cmd) + return ENOMEM; + + rc = ndctl_cmd_submit(cmd); + if (rc) + return rc; + + shutdown = ndctl_cmd_smart_get_shutdown_count(cmd); + ndctl_cmd_unref(cmd); + + rc = asprintf(&path, DEF_TMPFS_DIR "/%s", id); + if (rc < 0) + return ENOMEM; + ndctl_unref(ctx); + + rc = mkdir_p(path, 0755); + if (rc) + return rc; + + rc = asprintf(&usc, "%s/usc", path); + if (rc < 0) + return ENOMEM; + free(path); + + fd = open(usc, O_WRONLY | O_CREAT, 0644); + if (!fd) + return errno; + free(usc); + + rc = snprintf(count, sizeof(count), "%u\n", shutdown); + if (rc < 0) + return rc; + + if (write(fd, count, strlen(count))) + return errno; + return 0; +} From patchwork Tue Aug 7 22:26:56 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Keith Busch X-Patchwork-Id: 10559291 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 6435D157D for ; Tue, 7 Aug 2018 22:26:28 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 51CA22A5DF for ; Tue, 7 Aug 2018 22:26:28 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 436DC2A5EF; Tue, 7 Aug 2018 22:26:28 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.9 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 Received: from ml01.01.org (ml01.01.org [198.145.21.10]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id E852D2A5AB for ; Tue, 7 Aug 2018 22:26:27 +0000 (UTC) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id CCD6A210DF5DE; Tue, 7 Aug 2018 15:26:27 -0700 (PDT) X-Original-To: linux-nvdimm@lists.01.org Delivered-To: linux-nvdimm@lists.01.org Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=192.55.52.115; helo=mga14.intel.com; envelope-from=keith.busch@intel.com; receiver=linux-nvdimm@lists.01.org Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id AFB55210DF5D3 for ; Tue, 7 Aug 2018 15:26:26 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga103.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 07 Aug 2018 15:26:26 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.51,456,1526367600"; d="scan'208";a="61412785" Received: from unknown (HELO localhost.lm.intel.com) ([10.232.112.44]) by fmsmga008.fm.intel.com with ESMTP; 07 Aug 2018 15:26:26 -0700 From: Keith Busch To: Vishal Verma , Dave Jiang , linux-nvdimm@lists.01.org Subject: [PATCH 2/2] ndctl, intel: Fallback to smart cached shutdown_count Date: Tue, 7 Aug 2018 16:26:56 -0600 Message-Id: <20180807222656.14346-2-keith.busch@intel.com> X-Mailer: git-send-email 2.13.6 In-Reply-To: <20180807222656.14346-1-keith.busch@intel.com> References: <20180807222656.14346-1-keith.busch@intel.com> X-BeenThere: linux-nvdimm@lists.01.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: "Linux-nvdimm developer list." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: linux-nvdimm-bounces@lists.01.org Sender: "Linux-nvdimm" X-Virus-Scanned: ClamAV using ClamSMTP A user space rule saves the unsafe shutdown count to a fixed location for Intel dimms so that non-root users can read it. If the smart command submission fails, this patch uses that saved value in a newly added ndctl_cmd "handle_error" callback. If the cached value is available, the error handler will override the command status to success, and set the valid flags for the shutdown count. Signed-off-by: Keith Busch --- ndctl/lib/intel.c | 34 +++++++++++++++++++++++++++++++++- ndctl/lib/libndctl.c | 2 ++ ndctl/lib/private.h | 1 + 3 files changed, 36 insertions(+), 1 deletion(-) diff --git a/ndctl/lib/intel.c b/ndctl/lib/intel.c index 0abea1e..83f8203 100644 --- a/ndctl/lib/intel.c +++ b/ndctl/lib/intel.c @@ -56,6 +56,38 @@ static struct ndctl_cmd *alloc_intel_cmd(struct ndctl_dimm *dimm, return cmd; } +/* + * If provided, read the cached shutdown count in case the user does not have + * access rights to run the smart command, and pretend the command was + * successful with only the shutdown_count valid. + */ +static int intel_smart_handle_error(struct ndctl_cmd *cmd) +{ + struct ndctl_dimm *dimm = cmd->dimm; + char *path = NULL, shutdown_count[16] = {}; + int fd, rc = cmd->status; + + if (asprintf(&path, DEF_TMPFS_DIR "/%s/usc", + ndctl_dimm_get_unique_id(dimm)) < 0) + return rc; + + fd = open(path, O_RDONLY); + if (fd < 0) + goto free_path; + + if (read(fd, shutdown_count, sizeof(shutdown_count)) < 0) + goto close; + + cmd->intel->smart.flags = ND_INTEL_SMART_SHUTDOWN_COUNT_VALID; + cmd->intel->smart.shutdown_count = strtoull(shutdown_count, NULL, 0); + rc = cmd->status = 0; + close: + close (fd); + free_path: + free(path); + return rc; +} + static struct ndctl_cmd *intel_dimm_cmd_new_smart(struct ndctl_dimm *dimm) { struct ndctl_cmd *cmd; @@ -67,7 +99,7 @@ static struct ndctl_cmd *intel_dimm_cmd_new_smart(struct ndctl_dimm *dimm) if (!cmd) return NULL; cmd->firmware_status = &cmd->intel->smart.status; - + cmd->handle_error = intel_smart_handle_error; return cmd; } diff --git a/ndctl/lib/libndctl.c b/ndctl/lib/libndctl.c index 47e005e..d94321e 100644 --- a/ndctl/lib/libndctl.c +++ b/ndctl/lib/libndctl.c @@ -2651,6 +2651,8 @@ NDCTL_EXPORT int ndctl_cmd_submit(struct ndctl_cmd *cmd) close(fd); out: cmd->status = rc; + if (rc && cmd->handle_error) + rc = cmd->handle_error(cmd); return rc; } diff --git a/ndctl/lib/private.h b/ndctl/lib/private.h index a94f894..5812c85 100644 --- a/ndctl/lib/private.h +++ b/ndctl/lib/private.h @@ -255,6 +255,7 @@ struct ndctl_cmd { int dir; } iter; struct ndctl_cmd *source; + int (*handle_error)(struct ndctl_cmd *cmd); union { struct nd_cmd_ars_cap ars_cap[0]; struct nd_cmd_ars_start ars_start[0];