linux-kernel - [PATCH] cxl/mem: Clarify UAPI documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20210413143247.546256-1-ben.widawsky@intel.com>
Date:   Tue, 13 Apr 2021 07:32:47 -0700
From:   Ben Widawsky <ben.widawsky@...el.com>
To:     linux-cxl@...r.kernel.org
Cc:     Ben Widawsky <ben.widawsky@...el.com>, linux-pci@...r.kernel.org,
        linux-acpi@...r.kernel.org, ira.weiny@...el.com,
        vishal.l.verma@...el.com, alison.schofield@...el.com,
        dan.j.williams@...el.com, linux-kernel@...r.kernel.org
Subject: [PATCH] cxl/mem: Clarify UAPI documentation

Signed-off-by: Ben Widawsky <ben.widawsky@...el.com>
---
 include/uapi/linux/cxl_mem.h | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/include/uapi/linux/cxl_mem.h b/include/uapi/linux/cxl_mem.h
index f6e8a005b113..8dd516ddb098 100644
--- a/include/uapi/linux/cxl_mem.h
+++ b/include/uapi/linux/cxl_mem.h
@@ -81,6 +81,13 @@ static const struct {
  *  - @size_in = -1
  *  - @size_out = 0
  *
+ * Commands which have a variable length input likely have a minimum length.
+ * This is not enforced by the UAPI, and therefore might look like the command
+ * succeeded when sending too small of an input payload. Caution should be taken
+ * by checking the @cxl_send_command.retval for such cases. For commands with a
+ * variable length output, the caller is free to consume as little or as much as
+ * they want.
+ *
  * See struct cxl_mem_query_commands.
  */
 struct cxl_command_info {
-- 
2.31.1