The APIs that iterate over the information contained in an ars_atatus command require a prior, successfully completed ars_status command struct. We were neglecting to verify that the firmware status too indicates a success. We were also incorrectly requiring that ars_status->status be zero, where as a positive status only indicates an underrun. The underrun is fine as the firmware is not expected to completely fill the max_ars_out sized buffer. Refactor this checking to mimic validate_ars_cap() which checks the firmware status, and fixes the check for the cmd status. Use this for ndctl_cmd_ars_in_progress as well which had the same (incorrect) cmd->status check. Reported-by: Tomasz Rochumski <tomasz.rochumski(a)intel.com&gt; Cc: Dan Williams <dan.j.williams(a)intel.com&gt; Signed-off-by: Vishal Verma <vishal.l.verma(a)intel.com&gt; --- ndctl/lib/ars.c | 65 +++++++++++++++++++++++++++++++------------------ 1 file changed, 41 insertions(+), 24 deletions(-) diff --git a/ndctl/lib/ars.c b/ndctl/lib/ars.c index 1ff6cf7..b199646 100644 --- a/ndctl/lib/ars.c +++ b/ndctl/lib/ars.c @@ -195,24 +195,44 @@ NDCTL_EXPORT unsigned int ndctl_cmd_ars_cap_get_clear_unit( return 0; } +static bool __validate_ars_stat(struct ndctl_cmd *ars_stat) +{ + /* + * A positive status indicates an underrun, but that is fine since + * the firmware is not expected to completely fill the max_ars_out + * sized buffer. + */ + if (ars_stat->type != ND_CMD_ARS_STATUS || ars_stat->status < 0) + return false; + if ((ndctl_cmd_get_firmware_status(ars_stat) & ARS_STATUS_MASK) != 0) + return false; + return true; +} + +#define validate_ars_stat(ctx, ars_stat) \ +({ \ + bool __valid = __validate_ars_stat(ars_stat); \ + if (!__valid) \ + dbg(ctx, "expected sucessfully completed ars_stat command\n"); \ + __valid; \ +}) + NDCTL_EXPORT int ndctl_cmd_ars_in_progress(struct ndctl_cmd *cmd) { struct ndctl_ctx *ctx = ndctl_bus_get_ctx(cmd_to_bus(cmd)); - if (cmd->type == ND_CMD_ARS_STATUS && cmd->status == 0) { - if (cmd->ars_status->status == 1 << 16) { - /* - * If in-progress, invalidate the ndctl_cmd, so - * that if we're called again without a fresh - * ars_status command, we fail. - */ - cmd->status = 1; - return 1; - } + if (!validate_ars_stat(ctx, cmd)) return 0; - } - dbg(ctx, "invalid ars_status\n"); + if (ndctl_cmd_get_firmware_status(cmd) == 1 << 16) { + /* + * If in-progress, invalidate the ndctl_cmd, so + * that if we're called again without a fresh + * ars_status command, we fail. + */ + cmd->status = 1; + return 1; + } return 0; } @@ -220,11 +240,10 @@ NDCTL_EXPORT unsigned int ndctl_cmd_ars_num_records(struct ndctl_cmd *ars_stat) { struct ndctl_ctx *ctx = ndctl_bus_get_ctx(cmd_to_bus(ars_stat)); - if (ars_stat->type == ND_CMD_ARS_STATUS && ars_stat->status == 0) - return ars_stat->ars_status->num_records; + if (!validate_ars_stat(ctx, ars_stat)) + return 0; - dbg(ctx, "invalid ars_status\n"); - return 0; + return ars_stat->ars_status->num_records; } NDCTL_EXPORT unsigned long long ndctl_cmd_ars_get_record_addr( @@ -237,11 +256,10 @@ NDCTL_EXPORT unsigned long long ndctl_cmd_ars_get_record_addr( return 0; } - if (ars_stat->type == ND_CMD_ARS_STATUS && ars_stat->status == 0) - return ars_stat->ars_status->records[rec_index].err_address; + if (!validate_ars_stat(ctx, ars_stat)) + return 0; - dbg(ctx, "invalid ars_status\n"); - return 0; + return ars_stat->ars_status->records[rec_index].err_address; } NDCTL_EXPORT unsigned long long ndctl_cmd_ars_get_record_len( @@ -254,11 +272,10 @@ NDCTL_EXPORT unsigned long long ndctl_cmd_ars_get_record_len( return 0; } - if (ars_stat->type == ND_CMD_ARS_STATUS && ars_stat->status == 0) - return ars_stat->ars_status->records[rec_index].length; + if (!validate_ars_stat(ctx, ars_stat)) + return 0; - dbg(ctx, "invalid ars_status\n"); - return 0; + return ars_stat->ars_status->records[rec_index].length; } NDCTL_EXPORT struct ndctl_cmd *ndctl_bus_cmd_new_clear_error( -- 2.17.0