From patchwork Sat Jul 27 01:52:09 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Verma, Vishal L" X-Patchwork-Id: 11062151 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 044516C5 for ; Sat, 27 Jul 2019 01:52:32 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id ED13B28B70 for ; Sat, 27 Jul 2019 01:52:31 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id E194E28B89; Sat, 27 Jul 2019 01:52:31 +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 7087E28B70 for ; Sat, 27 Jul 2019 01:52:31 +0000 (UTC) Received: from [127.0.0.1] (localhost [IPv6:::1]) by ml01.01.org (Postfix) with ESMTP id B1AC1212E15BF; Fri, 26 Jul 2019 18:54:50 -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.88; helo=mga01.intel.com; envelope-from=vishal.l.verma@intel.com; receiver=linux-nvdimm@lists.01.org Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) (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 185D4212E15B3 for ; Fri, 26 Jul 2019 18:54:47 -0700 (PDT) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by fmsmga101.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 26 Jul 2019 18:52:20 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.64,313,1559545200"; d="scan'208";a="369715483" Received: from vverma7-desk1.lm.intel.com ([10.232.112.185]) by fmsmga005.fm.intel.com with ESMTP; 26 Jul 2019 18:52:19 -0700 From: Vishal Verma To: Subject: [ndctl PATCH v8 10/13] Documentation: Add man pages for daxctl-{on, off}line-memory Date: Fri, 26 Jul 2019 19:52:09 -0600 Message-Id: <20190727015212.27092-11-vishal.l.verma@intel.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190727015212.27092-1-vishal.l.verma@intel.com> References: <20190727015212.27092-1-vishal.l.verma@intel.com> MIME-Version: 1.0 X-BeenThere: linux-nvdimm@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Linux-nvdimm developer list." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Dave Hansen , Pavel Tatashin Errors-To: linux-nvdimm-bounces@lists.01.org Sender: "Linux-nvdimm" X-Virus-Scanned: ClamAV using ClamSMTP Add man pages for the two new commands: daxctl-online-memory, and daxctl-offline-memory. Cc: Dan Williams Cc: Dave Hansen Reviewed-by: Dan Williams Signed-off-by: Vishal Verma --- Documentation/daxctl/Makefile.am | 4 +- .../daxctl/daxctl-offline-memory.txt | 72 +++++++++++++++++ Documentation/daxctl/daxctl-online-memory.txt | 80 +++++++++++++++++++ 3 files changed, 155 insertions(+), 1 deletion(-) create mode 100644 Documentation/daxctl/daxctl-offline-memory.txt create mode 100644 Documentation/daxctl/daxctl-online-memory.txt diff --git a/Documentation/daxctl/Makefile.am b/Documentation/daxctl/Makefile.am index 715fbad..37c3bde 100644 --- a/Documentation/daxctl/Makefile.am +++ b/Documentation/daxctl/Makefile.am @@ -29,7 +29,9 @@ man1_MANS = \ daxctl.1 \ daxctl-list.1 \ daxctl-migrate-device-model.1 \ - daxctl-reconfigure-device.1 + daxctl-reconfigure-device.1 \ + daxctl-online-memory.1 \ + daxctl-offline-memory.1 CLEANFILES = $(man1_MANS) diff --git a/Documentation/daxctl/daxctl-offline-memory.txt b/Documentation/daxctl/daxctl-offline-memory.txt new file mode 100644 index 0000000..ba06287 --- /dev/null +++ b/Documentation/daxctl/daxctl-offline-memory.txt @@ -0,0 +1,72 @@ +// SPDX-License-Identifier: GPL-2.0 + +daxctl-offline-memory(1) +======================== + +NAME +---- +daxctl-offline-memory - Offline the memory for a device that is in system-ram mode + +SYNOPSIS +-------- +[verse] +'daxctl offline-memory' [...] [] + +EXAMPLES +-------- + +* Reconfigure dax0.0 to system-ram mode +---- +# daxctl reconfigure-device --mode=system-ram --human dax0.0 +{ + "chardev":"dax0.0", + "size":"7.87 GiB (8.45 GB)", + "target_node":2, + "mode":"system-ram" +} +---- + +* Offline the memory +---- +# daxctl offline-memory dax0.0 +dax0.0: 62 sections offlined +offlined memory for 1 device +---- + +DESCRIPTION +----------- + +Offline the memory sections associated with a device that has been converted +to the system-ram mode. If one or more blocks are already offline, attempt to +offline the remaining blocks. If all blocks were already offline, print a +message and return success without actually doing anything. + +This is complementary to the 'daxctl-online-memory' command, and may be used +when it is wished to offline the memory sections, but not convert the device +back to 'devdax' mode. + +OPTIONS +------- +-r:: +--region=:: + Restrict the operation to devices belonging to the specified region(s). + A device-dax region is a contiguous range of memory that hosts one or + more /dev/daxX.Y devices, where X is the region id and Y is the device + instance id. + +-u:: +--human:: + By default the command will output machine-friendly raw-integer + data. Instead, with this flag, numbers representing storage size + will be formatted as human readable strings with units, other + fields are converted to hexadecimal strings. + +-v:: +--verbose:: + Emit more debug messages + +include::../copyright.txt[] + +SEE ALSO +-------- +linkdaxctl:daxctl-reconfigure-device[1],daxctl-online-memory[1] diff --git a/Documentation/daxctl/daxctl-online-memory.txt b/Documentation/daxctl/daxctl-online-memory.txt new file mode 100644 index 0000000..5ac1cbf --- /dev/null +++ b/Documentation/daxctl/daxctl-online-memory.txt @@ -0,0 +1,80 @@ +// SPDX-License-Identifier: GPL-2.0 + +daxctl-online-memory(1) +======================= + +NAME +---- +daxctl-online-memory - Online the memory for a device that is in system-ram mode + +SYNOPSIS +-------- +[verse] +'daxctl online-memory' [...] [] + +EXAMPLES +-------- + +* Reconfigure dax0.0 to system-ram mode, don't online the memory +---- +# daxctl reconfigure-device --mode=system-ram --no-online --human dax0.0 +{ + "chardev":"dax0.0", + "size":"7.87 GiB (8.45 GB)", + "target_node":2, + "mode":"system-ram" +} +---- + +* Online the memory separately +---- +# daxctl online-memory dax0.0 +dax0.0: 62 new sections onlined +onlined memory for 1 device +---- + +* Onlining memory when some sections were already online +---- +# daxctl online-memory dax0.0 +dax0.0: 1 section already online +dax0.0: 61 new sections onlined +onlined memory for 1 device +---- + +DESCRIPTION +----------- + +Online the memory sections associated with a device that has been converted +to the system-ram mode. If one or more blocks are already online, print a +message about them, and attempt to online the remaining blocks. + +This is complementary to the 'daxctl-reconfigure-device' command, when used with +the '--no-online' option to skip onlining memory sections immediately after the +reconfigure. In these scenarios, the memory can be onlined at a later time using +'daxctl-online-memory'. + +OPTIONS +------- +-r:: +--region=:: + Restrict the operation to devices belonging to the specified region(s). + A device-dax region is a contiguous range of memory that hosts one or + more /dev/daxX.Y devices, where X is the region id and Y is the device + instance id. + +-u:: +--human:: + By default the command will output machine-friendly raw-integer + data. Instead, with this flag, numbers representing storage size + will be formatted as human readable strings with units, other + fields are converted to hexadecimal strings. + +-v:: +--verbose:: + Emit more debug messages + +include::../copyright.txt[] + +SEE ALSO +-------- +linkdaxctl:daxctl-reconfigure-device[1],daxctl-offline-memory[1]