Use argument structure for NVMe reservation commands

Use an argument structure for NVMe reservation commands like
nvme_resv_acquire() or nvme_resv_release() instead of passing all
arguments one by one.
This allows for a future expansion of the argument list without having
to change the library ABI.

Signed-off-by: Hannes Reinecke <hare@suse.de>

diff --git a/src/nvme/ioctl.c b/src/nvme/ioctl.c
index 7e3ff18cdd84d139756a9a444172f9445ceec3cf..9973919de4b9bda954a65bcdd85df7b89dff073e 100644 (file)
--- a/src/nvme/ioctl.c
+++ b/src/nvme/ioctl.c
@@ -1629,78 +1629,90 @@ int nvme_copy(struct nvme_copy_args *args)
        return nvme_submit_io_passthru(args->fd, &cmd, args->result);
 }
 
-int nvme_resv_acquire(int fd, __u32 nsid, enum nvme_resv_rtype rtype,
-                     enum nvme_resv_racqa racqa, bool iekey,
-                     __u64 crkey, __u64 nrkey, __u32 timeout, __u32 *result)
+int nvme_resv_acquire(struct nvme_resv_acquire_args *args)
 {
-       __le64 payload[2] = { cpu_to_le64(crkey), cpu_to_le64(nrkey) };
-       __u32 cdw10 = (racqa & 0x7) | (iekey ? 1 << 3 : 0) | rtype << 8;
+       __le64 payload[2] = {
+               cpu_to_le64(args->crkey),
+               cpu_to_le64(args->nrkey)
+       };
+       __u32 cdw10 = (args->racqa & 0x7) |
+               (args->iekey ? 1 << 3 : 0) |
+               (args->rtype << 8);
 
        struct nvme_passthru_cmd cmd = {
                .opcode         = nvme_cmd_resv_acquire,
-               .nsid           = nsid,
+               .nsid           = args->nsid,
                .cdw10          = cdw10,
                .data_len       = sizeof(payload),
                .addr           = (__u64)(uintptr_t)(payload),
-               .timeout_ms     = timeout,
+               .timeout_ms     = args->timeout,
        };
 
-       return nvme_submit_io_passthru(fd, &cmd, result);
+       if (args->args_size < sizeof(*args))
+               return -EINVAL;
+       return nvme_submit_io_passthru(args->fd, &cmd, args->result);
 }
 
-int nvme_resv_register(int fd, __u32 nsid, enum nvme_resv_rrega rrega,
-                      enum nvme_resv_cptpl cptpl, bool iekey,
-                      __u64 crkey, __u64 nrkey, __u32 timeout, __u32 *result)
+int nvme_resv_register(struct nvme_resv_register_args *args)
 {
-       __le64 payload[2] = { cpu_to_le64(crkey), cpu_to_le64(nrkey) };
-       __u32 cdw10 = (rrega & 0x7) | (iekey ? 1 << 3 : 0) | cptpl << 30;
+       __le64 payload[2] = {
+               cpu_to_le64(args->crkey),
+               cpu_to_le64(args->nrkey)
+       };
+       __u32 cdw10 = (args->rrega & 0x7) |
+               (args->iekey ? 1 << 3 : 0) |
+               (args->cptpl << 30);
 
        struct nvme_passthru_cmd cmd = {
                .opcode         = nvme_cmd_resv_register,
-               .nsid           = nsid,
+               .nsid           = args->nsid,
                .cdw10          = cdw10,
                .data_len       = sizeof(payload),
                .addr           = (__u64)(uintptr_t)(payload),
-               .timeout_ms     = timeout,
+               .timeout_ms     = args->timeout,
        };
 
-       return nvme_submit_io_passthru(fd, &cmd, result);
+       if (args->args_size < sizeof(*args))
+               return -EINVAL;
+       return nvme_submit_io_passthru(args->fd, &cmd, args->result);
 }
 
-int nvme_resv_release(int fd, __u32 nsid, enum nvme_resv_rtype rtype,
-                     enum nvme_resv_rrela rrela, bool iekey,
-                     __u64 crkey, __u32 timeout, __u32 *result)
+int nvme_resv_release(struct nvme_resv_release_args *args)
 {
-       __le64 payload[1] = { cpu_to_le64(crkey) };
-       __u32 cdw10 = (rrela & 0x7) | (iekey ? 1 << 3 : 0) | rtype << 8;
+       __le64 payload[1] = { cpu_to_le64(args->crkey) };
+       __u32 cdw10 = (args->rrela & 0x7) |
+               (args->iekey ? 1 << 3 : 0) |
+               (args->rtype << 8);
 
        struct nvme_passthru_cmd cmd = {
                .opcode         = nvme_cmd_resv_release,
-               .nsid           = nsid,
+               .nsid           = args->nsid,
                .cdw10          = cdw10,
                .addr           = (__u64)(uintptr_t)(payload),
                .data_len       = sizeof(payload),
-               .timeout_ms     = timeout,
+               .timeout_ms     = args->timeout,
        };
 
-       return nvme_submit_io_passthru(fd, &cmd, result);
+       if (args->args_size < sizeof(*args))
+               return -EINVAL;
+       return nvme_submit_io_passthru(args->fd, &cmd, args->result);
 }
 
-int nvme_resv_report(int fd, __u32 nsid, bool eds, __u32 len,
-                    struct nvme_resv_status *report, __u32 timeout,
-                    __u32 *result)
+int nvme_resv_report(struct nvme_resv_report_args *args)
 {
        struct nvme_passthru_cmd cmd = {
                .opcode         = nvme_cmd_resv_report,
-               .nsid           = nsid,
-               .cdw10          = (len >> 2) - 1,
-               .cdw11          = eds ? 1 : 0,
-               .addr           = (__u64)(uintptr_t)report,
-               .data_len       = len,
-               .timeout_ms     = timeout,
+               .nsid           = args->nsid,
+               .cdw10          = (args->len >> 2) - 1,
+               .cdw11          = args->eds ? 1 : 0,
+               .addr           = (__u64)(uintptr_t)args->report,
+               .data_len       = args->len,
+               .timeout_ms     = args->timeout,
        };
 
-       return nvme_submit_io_passthru(fd, &cmd, result);
+       if (args->args_size < sizeof(*args))
+               return -EINVAL;
+       return nvme_submit_io_passthru(args->fd, &cmd, args->result);
 }
 
 int nvme_zns_mgmt_send(int fd, __u32 nsid, __u64 slba,

diff --git a/src/nvme/ioctl.h b/src/nvme/ioctl.h
index f8de15169ee2d58ad01cb4e3cef4f8300b1d4567..3f52887288a034ce143743334f29151d519d7394 100644 (file)
--- a/src/nvme/ioctl.h
+++ b/src/nvme/ioctl.h
@@ -3799,7 +3799,7 @@ struct nvme_copy_args {
 int nvme_copy(struct nvme_copy_args *args);
 
 /**
- * nvme_resv_acquire() - Send an nvme reservation acquire
+ * nvme_resv_acquire_args - Arguments for the NVMe Reservation Acquire Comand
  * @fd:                File descriptor of nvme device
  * @nsid:      Namespace identifier
  * @rtype:     The type of reservation to be create, see &enum nvme_resv_rtype
@@ -3810,6 +3810,23 @@ int nvme_copy(struct nvme_copy_args *args);
  *             the action is preempt
  * @timeout:   Timeout in ms
  * @result:    The command completion result from CQE dword0
+ */
+struct nvme_resv_acquire_args {
+       int args_size;
+       int fd;
+       __u32 nsid;
+       enum nvme_resv_rtype rtype;
+       enum nvme_resv_racqa racqa;
+       bool iekey;
+       __u64 crkey;
+       __u64 nrkey;
+       __u32 timeout;
+       __u32 *result;
+};
+
+/**
+ * nvme_resv_acquire() - Send an nvme reservation acquire
+ * @args:      &struct nvme_resv_acquire argument structure
  *
  * The Reservation Acquire command acquires a reservation on a namespace,
  * preempt a reservation held on a namespace, and abort a reservation held on a
@@ -3818,12 +3835,10 @@ int nvme_copy(struct nvme_copy_args *args);
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
-int nvme_resv_acquire(int fd, __u32 nsid, enum nvme_resv_rtype rtype,
-                     enum nvme_resv_racqa racqa, bool iekey,
-                     __u64 crkey, __u64 nrkey, __u32 timeout, __u32 *result);
+int nvme_resv_acquire(struct nvme_resv_acquire_args *args);
 
 /**
- * nvme_resv_register() - Send an nvme reservation register
+ * nvme_resv_register_args - Arguments for the NVMe Reservation Register command
  * @fd:                File descriptor of nvme device
  * @nsid:      Namespace identifier
  * @rrega:     The registration action, see &enum nvme_resv_rrega
@@ -3833,6 +3848,23 @@ int nvme_resv_acquire(int fd, __u32 nsid, enum nvme_resv_rtype rtype,
  * @nrkey:     The new reservation key to be register if action is register or
  *             replace
  * @timeout:   Timeout in ms
+ */
+struct nvme_resv_register_args {
+       int args_size;
+       int fd;
+       __u32 nsid;
+       enum nvme_resv_rrega rrega;
+       enum nvme_resv_cptpl cptpl;
+       bool iekey;
+       __u64 crkey;
+       __u64 nrkey;
+       __u32 timeout;
+       __u32 *result;
+};
+
+/**
+ * nvme_resv_register() - Send an nvme reservation register
+ * @args:      &struct nvme_resv_register_args argument structure
  *
  * The Reservation Register command registers, unregisters, or replaces a
  * reservation key.
@@ -3840,12 +3872,10 @@ int nvme_resv_acquire(int fd, __u32 nsid, enum nvme_resv_rtype rtype,
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
-int nvme_resv_register(int fd, __u32 nsid, enum nvme_resv_rrega rrega,
-                      enum nvme_resv_cptpl cptpl, bool iekey,
-                      __u64 crkey, __u64 nrkey, __u32 timeout, __u32 *result);
+int nvme_resv_register(struct nvme_resv_register_args *args);
 
 /**
- * nvme_resv_release() - Send an nvme reservation release
+ * nvme_resv_release_args - Arguments for the NVMe Reservation Release Command
  * @fd:                File descriptor of nvme device
  * @nsid:      Namespace identifier
  * @rtype:     The type of reservation to be create, see &enum nvme_resv_rtype
@@ -3854,16 +3884,30 @@ int nvme_resv_register(int fd, __u32 nsid, enum nvme_resv_rrega rrega,
  * @crkey:     The current reservation key to release
  * @timeout:   Timeout in ms
  * @result:    The command completion result from CQE dword0
+ */
+struct nvme_resv_release_args {
+       int args_size;
+       int fd;
+       __u32 nsid;
+       enum nvme_resv_rtype rtype;
+       enum nvme_resv_rrela rrela;
+       bool iekey;
+       __u64 crkey;
+       __u32 timeout;
+       __u32 *result;
+};
+
+/**
+ * nvme_resv_release() - Send an nvme reservation release
+ * @args:      &struct nvme_resv_release_args argument structure
  *
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
-int nvme_resv_release(int fd, __u32 nsid, enum nvme_resv_rtype rtype,
-                     enum nvme_resv_rrela rrela, bool iekey,
-                     __u64 crkey, __u32 timeout, __u32 *result);
+int nvme_resv_release(struct nvme_resv_release_args *args);
 
 /**
- * nvme_resv_report() - Send an nvme reservation report
+ * nvme_resv_report_args - Arguments for the NVMe Reservation Report command
  * @fd:                File descriptor of nvme device
  * @nsid:      Namespace identifier
  * @eds:       Request extended Data Structure
@@ -3872,6 +3916,21 @@ int nvme_resv_release(int fd, __u32 nsid, enum nvme_resv_rtype rtype,
  *             report
  * @timeout:   Timeout in ms
  * @result:    The command completion result from CQE dword0
+ */
+struct nvme_resv_report_args {
+       int args_size;
+       int fd;
+       __u32 nsid;
+       bool eds;
+       __u32 len;
+       struct nvme_resv_status *report;
+       __u32 timeout;
+       __u32 *result;
+};
+
+/**
+ * nvme_resv_report() - Send an nvme reservation report
+ * @args:      struct nvme_resv_report_args argument structure
  *
  * Returns a Reservation Status data structure to memory that describes the
  * registration and reservation status of a namespace. See the defintion for
@@ -3880,9 +3939,7 @@ int nvme_resv_release(int fd, __u32 nsid, enum nvme_resv_rtype rtype,
  * Return: The nvme command status if a response was received (see
  * &enum nvme_status_field) or -1 with errno set otherwise.
  */
-int nvme_resv_report(int fd, __u32 nsid, bool eds, __u32 len,
-                    struct nvme_resv_status *report,
-                    __u32 timeout, __u32 *result);
+int nvme_resv_report(struct nvme_resv_report_args *args);
 
 /**
  * nvme_zns_mgmt_send() -