Re: [PATCH v3 24/25] tools/testing/cxl: Make event logs dynamic

Dave Jiang
2024-08-20T23:30:12Z

On 8/16/24 7:44 AM, Ira Weiny wrote:
> The test event logs were created as static arrays as an easy way to mock
> events. Dynamic Capacity Device (DCD) test support requires events be
> generated dynamically when extents are created or destroyed.
>
> Modify the event log storage to be dynamically allocated. Reuse the
> static event data to create the dynamic events in the new logs without
> inventing complex event injection for the previous tests. Simplify the
> processing of the logs by using the event log array index as the handle.
> Add a lock to manage concurrency required when user space is allowed to
> control DCD extents
>
> Signed-off-by: Ira Weiny <ira.weiny@intel.com>

Reviewed-by: Dave Jiang <dave.jiang@intel.com>
>
> ---
> Changes:
> [iweiny: rebase]
> ---
> tools/testing/cxl/test/mem.c | 278 ++++++++++++++++++++++++++-----------------
> 1 file changed, 171 insertions(+), 107 deletions(-)
>
> diff --git a/tools/testing/cxl/test/mem.c b/tools/testing/cxl/test/mem.c
> index 129f179b0ac5..674fc7f086cd 100644
> --- a/tools/testing/cxl/test/mem.c
> +++ b/tools/testing/cxl/test/mem.c
> @@ -125,18 +125,27 @@ static struct {
>
> #define PASS_TRY_LIMIT 3
>
> -#define CXL_TEST_EVENT_CNT_MAX 15
> +#define CXL_TEST_EVENT_CNT_MAX 17
>
> /* Set a number of events to return at a time for simulation. */
> #define CXL_TEST_EVENT_RET_MAX 4
>
> +/*
> + * @next_handle: next handle (index) to be stored to
> + * @cur_handle: current handle (index) to be returned to the user on get_event
> + * @nr_events: total events in this log
> + * @nr_overflow: number of events added past the log size
> + * @lock: protect these state variables
> + * @events: array of pending events to be returned.
> + */
> struct mock_event_log {
> - u16 clear_idx;
> - u16 cur_idx;
> + u16 next_handle;
> + u16 cur_handle;
> u16 nr_events;
> u16 nr_overflow;
> - u16 overflow_reset;
> - struct cxl_event_record_raw *events[CXL_TEST_EVENT_CNT_MAX];
> + rwlock_t lock;
> + /* 1 extra slot to accommodate that handles can't be 0 */
> + struct cxl_event_record_raw *events[CXL_TEST_EVENT_CNT_MAX + 1];
> };
>
> struct mock_event_store {
> @@ -171,56 +180,68 @@ static struct mock_event_log *event_find_log(struct device *dev, int log_type)
> return &mdata->mes.mock_logs[log_type];
> }
>
> -static struct cxl_event_record_raw *event_get_current(struct mock_event_log *log)
> -{
> - return log->events[log->cur_idx];
> -}
> -
> -static void event_reset_log(struct mock_event_log *log)
> -{
> - log->cur_idx = 0;
> - log->clear_idx = 0;
> - log->nr_overflow = log->overflow_reset;
> -}
> -
> /* Handle can never be 0 use 1 based indexing for handle */
> -static u16 event_get_clear_handle(struct mock_event_log *log)
> +static void event_inc_handle(u16 *handle)
> {
> - return log->clear_idx + 1;
> + *handle = (*handle + 1) % CXL_TEST_EVENT_CNT_MAX;
> + if (!*handle)
> + *handle = *handle + 1;
> }
>
> -/* Handle can never be 0 use 1 based indexing for handle */
> -static __le16 event_get_cur_event_handle(struct mock_event_log *log)
> -{
> - u16 cur_handle = log->cur_idx + 1;
> -
> - return cpu_to_le16(cur_handle);
> -}
> -
> -static bool event_log_empty(struct mock_event_log *log)
> -{
> - return log->cur_idx == log->nr_events;
> -}
> -
> -static void mes_add_event(struct mock_event_store *mes,
> +/* Add the event or free it on 'overflow' */
> +static void mes_add_event(struct cxl_mockmem_data *mdata,
> enum cxl_event_log_type log_type,
> struct cxl_event_record_raw *event)
> {
> + struct device *dev = mdata->mds->cxlds.dev;
> struct mock_event_log *log;
> + u16 handle;
>
> if (WARN_ON(log_type >= CXL_EVENT_TYPE_MAX))
> return;
>
> - log = &mes->mock_logs[log_type];
> + log = &mdata->mes.mock_logs[log_type];
>
> - if ((log->nr_events + 1) > CXL_TEST_EVENT_CNT_MAX) {
> + write_lock(&log->lock);
> +
> + handle = log->next_handle;
> + if ((handle + 1) == log->cur_handle) {
> log->nr_overflow++;
> - log->overflow_reset = log->nr_overflow;
> - return;
> + dev_dbg(dev, "Overflowing %d\n", log_type);
> + devm_kfree(dev, event);
> + goto unlock;
> }
>
> - log->events[log->nr_events] = event;
> + dev_dbg(dev, "Log %d; handle %u\n", log_type, handle);
> + event->event.generic.hdr.handle = cpu_to_le16(handle);
> + log->events[handle] = event;
> + event_inc_handle(&log->next_handle);
> log->nr_events++;
> +
> +unlock:
> + write_unlock(&log->lock);
> +}
> +
> +static void mes_del_event(struct device *dev,
> + struct mock_event_log *log,
> + u16 handle)
> +{
> + struct cxl_event_record_raw *cur;
> +
> + lockdep_assert(lockdep_is_held(&log->lock));
> +
> + dev_dbg(dev, "Clearing event %u; cur %u\n", handle, log->cur_handle);
> + cur = log->events[handle];
> + if (!cur) {
> + dev_err(dev, "Mock event index %u empty? nr_events %u",
> + handle, log->nr_events);
> + return;
> + }
> + log->events[handle] = NULL;
> +
> + event_inc_handle(&log->cur_handle);
> + log->nr_events--;
> + devm_kfree(dev, cur);
> }
>
> /*
> @@ -233,8 +254,8 @@ static int mock_get_event(struct device *dev, struct cxl_mbox_cmd *cmd)
> {
> struct cxl_get_event_payload *pl;
> struct mock_event_log *log;
> - u16 nr_overflow;
> u8 log_type;
> + u16 handle;
> int i;
>
> if (cmd->size_in != sizeof(log_type))
> @@ -254,29 +275,39 @@ static int mock_get_event(struct device *dev, struct cxl_mbox_cmd *cmd)
> memset(cmd->payload_out, 0, struct_size(pl, records, 0));
>
> log = event_find_log(dev, log_type);
> - if (!log || event_log_empty(log))
> + if (!log)
> return 0;
>
> pl = cmd->payload_out;
>
> - for (i = 0; i < ret_limit && !event_log_empty(log); i++) {
> - memcpy(&pl->records[i], event_get_current(log),
> - sizeof(pl->records[i]));
> - pl->records[i].event.generic.hdr.handle =
> - event_get_cur_event_handle(log);
> - log->cur_idx++;
> + read_lock(&log->lock);
> +
> + handle = log->cur_handle;
> + dev_dbg(dev, "Get log %d handle %u next %u\n",
> + log_type, handle, log->next_handle);
> + for (i = 0;
> + i < ret_limit && handle != log->next_handle;
> + i++, event_inc_handle(&handle)) {
> + struct cxl_event_record_raw *cur;
> +
> + cur = log->events[handle];
> + dev_dbg(dev, "Sending event log %d handle %d idx %u\n",
> + log_type, le16_to_cpu(cur->event.generic.hdr.handle),
> + handle);
> + memcpy(&pl->records[i], cur, sizeof(pl->records[i]));
> + pl->records[i].event.generic.hdr.handle = cpu_to_le16(handle);
> }
>
> cmd->size_out = struct_size(pl, records, i);
> pl->record_count = cpu_to_le16(i);
> - if (!event_log_empty(log))
> + if (log->nr_events > i)
> pl->flags |= CXL_GET_EVENT_FLAG_MORE_RECORDS;
>
> if (log->nr_overflow) {
> u64 ns;
>
> pl->flags |= CXL_GET_EVENT_FLAG_OVERFLOW;
> - pl->overflow_err_count = cpu_to_le16(nr_overflow);
> + pl->overflow_err_count = cpu_to_le16(log->nr_overflow);
> ns = ktime_get_real_ns();
> ns -= 5000000000; /* 5s ago */
> pl->first_overflow_timestamp = cpu_to_le64(ns);
> @@ -285,16 +316,17 @@ static int mock_get_event(struct device *dev, struct cxl_mbox_cmd *cmd)
> pl->last_overflow_timestamp = cpu_to_le64(ns);
> }
>
> + read_unlock(&log->lock);
> return 0;
> }
>
> static int mock_clear_event(struct device *dev, struct cxl_mbox_cmd *cmd)
> {
> struct cxl_mbox_clear_event_payload *pl = cmd->payload_in;
> - struct mock_event_log *log;
> u8 log_type = pl->event_log;
> + struct mock_event_log *log;
> + int nr, rc = 0;
> u16 handle;
> - int nr;
>
> if (log_type >= CXL_EVENT_TYPE_MAX)
> return -EINVAL;
> @@ -303,24 +335,23 @@ static int mock_clear_event(struct device *dev, struct cxl_mbox_cmd *cmd)
> if (!log)
> return 0; /* No mock data in this log */
>
> - /*
> - * This check is technically not invalid per the specification AFAICS.
> - * (The host could 'guess' handles and clear them in order).
> - * However, this is not good behavior for the host so test it.
> - */
> - if (log->clear_idx + pl->nr_recs > log->cur_idx) {
> - dev_err(dev,
> - "Attempting to clear more events than returned!\n");
> - return -EINVAL;
> - }
> + write_lock(&log->lock);
>
> /* Check handle order prior to clearing events */
> - for (nr = 0, handle = event_get_clear_handle(log);
> - nr < pl->nr_recs;
> - nr++, handle++) {
> + handle = log->cur_handle;
> + for (nr = 0;
> + nr < pl->nr_recs && handle != log->next_handle;
> + nr++, event_inc_handle(&handle)) {
> +
> + dev_dbg(dev, "Checking clear of %d handle %u plhandle %u\n",
> + log_type, handle,
> + le16_to_cpu(pl->handles[nr]));
> +
> if (handle != le16_to_cpu(pl->handles[nr])) {
> - dev_err(dev, "Clearing events out of order\n");
> - return -EINVAL;
> + dev_err(dev, "Clearing events out of order %u %u\n",
> + handle, le16_to_cpu(pl->handles[nr]));
> + rc = -EINVAL;
> + goto unlock;
> }
> }
>
> @@ -328,25 +359,12 @@ static int mock_clear_event(struct device *dev, struct cxl_mbox_cmd *cmd)
> log->nr_overflow = 0;
>
> /* Clear events */
> - log->clear_idx += pl->nr_recs;
> - return 0;
> -}
> -
> -static void cxl_mock_event_trigger(struct device *dev)
> -{
> - struct cxl_mockmem_data *mdata = dev_get_drvdata(dev);
> - struct mock_event_store *mes = &mdata->mes;
> - int i;
> -
> - for (i = CXL_EVENT_TYPE_INFO; i < CXL_EVENT_TYPE_MAX; i++) {
> - struct mock_event_log *log;
> -
> - log = event_find_log(dev, i);
> - if (log)
> - event_reset_log(log);
> - }
> + for (nr = 0; nr < pl->nr_recs; nr++)
> + mes_del_event(dev, log, le16_to_cpu(pl->handles[nr]));
>
> - cxl_mem_get_event_records(mdata->mds, mes->ev_status);
> +unlock:
> + write_unlock(&log->lock);
> + return rc;
> }
>
> struct cxl_event_record_raw maint_needed = {
> @@ -475,8 +493,27 @@ static int mock_set_timestamp(struct cxl_dev_state *cxlds,
> return 0;
> }
>
> -static void cxl_mock_add_event_logs(struct mock_event_store *mes)
> +/* Create a dynamically allocated event out of a statically defined event. */
> +static void add_event_from_static(struct cxl_mockmem_data *mdata,
> + enum cxl_event_log_type log_type,
> + struct cxl_event_record_raw *raw)
> +{
> + struct device *dev = mdata->mds->cxlds.dev;
> + struct cxl_event_record_raw *rec;
> +
> + rec = devm_kmemdup(dev, raw, sizeof(*rec), GFP_KERNEL);
> + if (!rec) {
> + dev_err(dev, "Failed to alloc event for log\n");
> + return;
> + }
> + mes_add_event(mdata, log_type, rec);
> +}
> +
> +static void cxl_mock_add_event_logs(struct cxl_mockmem_data *mdata)
> {
> + struct mock_event_store *mes = &mdata->mes;
> + struct device *dev = mdata->mds->cxlds.dev;
> +
> put_unaligned_le16(CXL_GMER_VALID_CHANNEL | CXL_GMER_VALID_RANK,
> &gen_media.rec.media_hdr.validity_flags);
>
> @@ -484,43 +521,60 @@ static void cxl_mock_add_event_logs(struct mock_event_store *mes)
> CXL_DER_VALID_BANK | CXL_DER_VALID_COLUMN,
> &dram.rec.media_hdr.validity_flags);
>
> - mes_add_event(mes, CXL_EVENT_TYPE_INFO, &maint_needed);
> - mes_add_event(mes, CXL_EVENT_TYPE_INFO,
> + dev_dbg(dev, "Generating fake event logs %d\n",
> + CXL_EVENT_TYPE_INFO);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_INFO, &maint_needed);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_INFO,
> (struct cxl_event_record_raw *)&gen_media);
> - mes_add_event(mes, CXL_EVENT_TYPE_INFO,
> + add_event_from_static(mdata, CXL_EVENT_TYPE_INFO,
> (struct cxl_event_record_raw *)&mem_module);
> mes->ev_status |= CXLDEV_EVENT_STATUS_INFO;
>
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &maint_needed);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL,
> + dev_dbg(dev, "Generating fake event logs %d\n",
> + CXL_EVENT_TYPE_FAIL);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &maint_needed);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL,
> + (struct cxl_event_record_raw *)&mem_module);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL,
> (struct cxl_event_record_raw *)&dram);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL,
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL,
> (struct cxl_event_record_raw *)&gen_media);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL,
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL,
> (struct cxl_event_record_raw *)&mem_module);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL,
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL,
> (struct cxl_event_record_raw *)&dram);
> /* Overflow this log */
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> - mes_add_event(mes, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FAIL, &hardware_replace);
> mes->ev_status |= CXLDEV_EVENT_STATUS_FAIL;
>
> - mes_add_event(mes, CXL_EVENT_TYPE_FATAL, &hardware_replace);
> - mes_add_event(mes, CXL_EVENT_TYPE_FATAL,
> + dev_dbg(dev, "Generating fake event logs %d\n",
> + CXL_EVENT_TYPE_FATAL);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FATAL, &hardware_replace);
> + add_event_from_static(mdata, CXL_EVENT_TYPE_FATAL,
> (struct cxl_event_record_raw *)&dram);
> mes->ev_status |= CXLDEV_EVENT_STATUS_FATAL;
> }
>
> +static void cxl_mock_event_trigger(struct device *dev)
> +{
> + struct cxl_mockmem_data *mdata = dev_get_drvdata(dev);
> + struct mock_event_store *mes = &mdata->mes;
> +
> + cxl_mock_add_event_logs(mdata);
> + cxl_mem_get_event_records(mdata->mds, mes->ev_status);
> +}
> +
> static int mock_gsl(struct cxl_mbox_cmd *cmd)
> {
> if (cmd->size_out < sizeof(mock_gsl_payload))
> @@ -1453,6 +1507,14 @@ static ssize_t event_trigger_store(struct device *dev,
> }
> static DEVICE_ATTR_WO(event_trigger);
>
> +static void init_event_log(struct mock_event_log *log)
> +{
> + rwlock_init(&log->lock);
> + /* Handle can never be 0 use 1 based indexing for handle */
> + log->cur_handle = 1;
> + log->next_handle = 1;
> +}
> +
> static int cxl_mock_mem_probe(struct platform_device *pdev)
> {
> struct device *dev = &pdev->dev;
> @@ -1519,7 +1581,9 @@ static int cxl_mock_mem_probe(struct platform_device *pdev)
> if (rc)
> return rc;
>
> - cxl_mock_add_event_logs(&mdata->mes);
> + for (int i = 0; i < CXL_EVENT_TYPE_MAX; i++)
> + init_event_log(&mdata->mes.mock_logs[i]);
> + cxl_mock_add_event_logs(mdata);
>
> cxlmd = devm_cxl_add_memdev(&pdev->dev, cxlds);
> if (IS_ERR(cxlmd))
>