From nobody Tue Aug 27 01:06:50 2024 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4Wt8Wv5wKMz5TjZL; Tue, 27 Aug 2024 01:06:51 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R11" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4Wt8Wt5fjbz4m9J; Tue, 27 Aug 2024 01:06:50 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1724720810; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=hRWeO6/MfCKWRRWEp5+n74tVlxizUYi2HoOfBnJ+clo=; b=nA2OkyDWHMtwL3JGDqthqswd6leJLLycO8B6FPRVxz8n4dl4e5Yfkn/H7DayGy/nFu2+gR kdQNwsdxGpnJbE9can/VISqNsYI7aFtax/Jy7TvAHrOSpNncxXEPqtjJHP5ZpkS7ukCwkf 5Plyl+FWXxMXToUlrzHH89oDTDEOkbS/w0s3Q9WB0AW+XUM58VmWyqYNxjS+hFPXE3YMmW eGDfnDZuuukehQH6AMr3MY/aSBzNaje1TERclYGh+TAr8lBKWNs79wZ88LsO+0VzNFnhS4 a0l9R4UN2NLV0fwwd3zskUYZnkOy8X2mqVj7BhlS5JkxsSWc367u5UL3G8zcZQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1724720810; a=rsa-sha256; cv=none; b=Qif4XlMO3FQsjSjPUqlPe6cNk3czK1/gkfkAEpa8g1i2Hnqw9TmJNjKltPrLFR7IDolXfr 08/v4kgmo4mn5UfXkkFkAp8FftobFEKBdL2khYdG0MDfRJqy/3z9Ocix+mzFFGNL/7btK9 2vxifvnLfLRAXhIN2y9PmoCIEg1Jb/M4gwAmxyZ/m1Wil9dS0UGFnC58pGFOZWzKjSMMg6 hdDe6NPFicYsAf8ZpymGje9blI9lyDaAJEEPAYLVCC5qrzdDsNGia68hBpNt1QrzjxJets n2TIjWDkRkIu5t5kYRJIlZu/jSYk7CBskkMf21MO/axS7eMUZ5b1lCgMMb1wYA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1724720810; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=hRWeO6/MfCKWRRWEp5+n74tVlxizUYi2HoOfBnJ+clo=; b=vAGfbTea2rGTRJj0P1mI4cvNwaxKa8XszwNWmhOqUeWLabNDuKW/S9Y2/GNCFzKkzEN0kz 2JKcSmpO7gM8ZZ7FezpFoyzf4sge0IqpSfhFTo9zvmf2Zb9iyMQCGzdeG1hM3gybkFOADs 7/s6P7ijrmpY+Te689+1a0zWwWqbQ5vW+vFzsEI6g1gDx5KSFk718zmCyXyngxACTyFNiY vQiajS/5V0rgKZz+e7TJ4VnqkvXwFPS7c/HwBqg9ZxIf9dOXJyIF99svov6fMmCqCYotGm +BQ+WhZM28Dw1Ko7L1/Y7p+tPbxB9BaS7mLvPluzFCM/G8+//7ki1fyVgag8Dw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4Wt8Wt5FXWzTf8; Tue, 27 Aug 2024 01:06:50 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 47R16o4c057636; Tue, 27 Aug 2024 01:06:50 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 47R16oTk057633; Tue, 27 Aug 2024 01:06:50 GMT (envelope-from git) Date: Tue, 27 Aug 2024 01:06:50 GMT Message-Id: <202408270106.47R16oTk057633@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: John Baldwin Subject: git: aaac429c1259 - stable/14 - nvmecontrol: Preliminary namespace documentation List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: jhb X-Git-Repository: src X-Git-Refname: refs/heads/stable/14 X-Git-Reftype: branch X-Git-Commit: aaac429c1259555fa990c1a97df8de7fda5f60f8 Auto-Submitted: auto-generated The branch stable/14 has been updated by jhb: URL: https://cgit.FreeBSD.org/src/commit/?id=aaac429c1259555fa990c1a97df8de7fda5f60f8 commit aaac429c1259555fa990c1a97df8de7fda5f60f8 Author: Warner Losh AuthorDate: 2024-04-16 22:37:02 +0000 Commit: John Baldwin CommitDate: 2024-08-26 18:31:03 +0000 nvmecontrol: Preliminary namespace documentation Provide preliminary namespace subcommand documentation, along with some basic definitions from the NVM standards relating to namespaces. Sponsored by: Netflix Reviewed by: jhb Differential Revision: https://reviews.freebsd.org/D44682 (cherry picked from commit 383a44fc0bcb36bf67127856f0c5fabfea522bab) --- sbin/nvmecontrol/nvmecontrol.8 | 43 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/sbin/nvmecontrol/nvmecontrol.8 b/sbin/nvmecontrol/nvmecontrol.8 index edeeb9afa10f..b812149b5c7d 100644 --- a/sbin/nvmecontrol/nvmecontrol.8 +++ b/sbin/nvmecontrol/nvmecontrol.8 @@ -33,7 +33,7 @@ .\" .\" Author: Jim Harris .\" -.Dd February 28, 2022 +.Dd April 17, 2024 .Dt NVMECONTROL 8 .Os .Sh NAME @@ -302,6 +302,47 @@ will set Retain Asynchronous Event. Various namespace management commands. If namespace management is supported by device, allow list, create and delete namespaces, list, attach and detach controllers to namespaces. +Each NVM device consists of one or more NVM subsystems. +Each NVM subsystem has one or more NVM ports. +Each NVM port is attached to one or more NVM controllers (though typically 1). +Each NVM controller is attached to one or more namespaces. +.Pp +After a namespace is created, it is considered +.Dq allocated . +All namespaces that have not been created are unallocated. +An allocated namespace may be active or inactive. +An active namespace is attached to the controller and may be interacted with. +A namespace can move from active to inactive when detached. +An allocated namespace may be deleted to become unallocated. +For more details on the nuances of NVM namespaces, please see section 2 +.Em Theory of Operation +and section 3 +.Em NVM Express Architecture +of the latest NVM standard. +.Ss ns active +Provide a list of active namespace identifiers for the givne NVM controller. +.Ss ns allocated +Provide a list of allocated namespace identifiers for the givne NVM controller. +.Ss ns attach +Attach an nsid to a controller. +The primary controller is used if one is not specified. +.Ss ns attached +Provide a list of controllers attached to a nsid. +If only a nvme controller argument is provided, a nsid must also be specified. +.Ss ns controllers +Provide a list of all controllers in the NVM subsystem. +.Ss ns create +Creates a new namespace. +.Ss ns delete +Delete a namespace. +It must be currently inactive. +.Ss ns detach +Detach a namespace from a controller. +The namespace will become inaccessible, but its contents will remain if it is +.Em activated +again. +.Ss ns identify +Print detailed information about the namespace. .Ss nsid Reports the namespace id and controller device associated with the .Aq Ar namespace-id