[U-Boot,06/10] efi_selftest: provide unit test for event services

This unit test uses timer events to check the implementation
of the following boottime services:
CreateEvent, CloseEvent, WaitForEvent, CheckEvent, SetTimer

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 lib/efi_selftest/Makefile              |   5 +-
 lib/efi_selftest/efi_selftest_events.c | 195 +++++++++++++++++++++++++++++++++
 2 files changed, 199 insertions(+), 1 deletion(-)
 create mode 100644 lib/efi_selftest/efi_selftest_events.c

On 15 September 2017 at 02:06, Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
> This unit test uses timer events to check the implementation
> of the following boottime services:
> CreateEvent, CloseEvent, WaitForEvent, CheckEvent, SetTimer
>
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
> ---
>  lib/efi_selftest/Makefile              |   5 +-
>  lib/efi_selftest/efi_selftest_events.c | 195 +++++++++++++++++++++++++++++++++
>  2 files changed, 199 insertions(+), 1 deletion(-)
>  create mode 100644 lib/efi_selftest/efi_selftest_events.c
>
> diff --git a/lib/efi_selftest/Makefile b/lib/efi_selftest/Makefile
> index 34f5ff1838..a71c8bf937 100644
> --- a/lib/efi_selftest/Makefile
> +++ b/lib/efi_selftest/Makefile
> @@ -11,7 +11,10 @@ CFLAGS_efi_selftest.o := $(CFLAGS_EFI)
>  CFLAGS_REMOVE_efi_selftest.o := $(CFLAGS_NON_EFI)
>  CFLAGS_efi_selftest_console.o := $(CFLAGS_EFI)
>  CFLAGS_REMOVE_efi_selftest_console.o := $(CFLAGS_NON_EFI)
> +CFLAGS_efi_selftest_events.o := $(CFLAGS_EFI)
> +CFLAGS_REMOVE_efi_selftest_events.o := $(CFLAGS_NON_EFI)
>
>  obj-$(CONFIG_CMD_BOOTEFI_SELFTEST) += \
>  efi_selftest.o \
> -efi_selftest_console.o
> +efi_selftest_console.o \
> +efi_selftest_events.o
> diff --git a/lib/efi_selftest/efi_selftest_events.c b/lib/efi_selftest/efi_selftest_events.c
> new file mode 100644
> index 0000000000..c4f66952b9
> --- /dev/null
> +++ b/lib/efi_selftest/efi_selftest_events.c
> @@ -0,0 +1,195 @@
> +/*
> + * efi_selftest_events
> + *
> + * Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de>
> + *
> + * SPDX-License-Identifier:     GPL-2.0+
> + *
> + * This unit test uses timer events to check the implementation
> + * of the following boottime services:
> + * CreateEvent, CloseEvent, WaitForEvent, CheckEvent, SetTimer.
> + */
> +
> +#include <efi_selftest.h>
> +
> +static struct efi_event *event_notify;
> +static struct efi_event *event_wait;
> +static unsigned int counter;
> +static struct efi_boot_services *boottime;
> +
> +/*
> + * Notification function, increments a counter.
> + *
> + * @event      notified event
> + * @context    pointer to the counter
> + */
> +static void EFIAPI notify(struct efi_event *event, void *context)
> +{
> +       if (!context)
> +               return;
> +       ++*(unsigned int *)context;

This is pretty ugly I think. Instead can you create a struct with a
single int member and do something like:

struct notify_contact *ctx = context;

ctx->counter++;

(a better name for counter, too if you can think of one)

> +}
> +
> +/*
> + * Setup unit test.
> + *
> + * Create two timer events.
> + * One with EVT_NOTIFY_SIGNAL, the other with EVT_NOTIFY_WAIT.
> + *
> + * @handle:    handle of the loaded image
> + * @systable:  system table
> + */
> +static int setup(const efi_handle_t handle,
> +                const struct efi_system_table *systable)
> +{
> +       efi_status_t ret;
> +
> +       boottime = systable->boottime;
> +
> +       ret = boottime->create_event(EVT_TIMER | EVT_NOTIFY_SIGNAL,
> +                                    TPL_CALLBACK, notify, (void *)&counter,
> +                                    &event_notify);
> +       if (ret != EFI_SUCCESS) {
> +               efi_st_error("could not create event\n");
> +               return 1;
> +       }
> +       ret = boottime->create_event(EVT_TIMER | EVT_NOTIFY_WAIT,
> +                                    TPL_CALLBACK, notify, NULL, &event_wait);
> +       if (ret != EFI_SUCCESS) {
> +               efi_st_error("could not create event\n");
> +               return 1;
> +       }
> +       return 0;
> +}
> +
> +/*
> + * Tear down unit test.
> + *
> + * Close the events created in setup.
> + */
> +static int teardown(void)
> +{
> +       efi_status_t ret;
> +
> +       if (event_notify) {
> +               ret = boottime->close_event(event_notify);
> +               event_notify = NULL;
> +               if (ret != EFI_SUCCESS) {
> +                       efi_st_error("could not close event\n");
> +                       return 1;
> +               }
> +       }
> +       if (event_wait) {
> +               ret = boottime->close_event(event_wait);
> +               event_wait = NULL;
> +               if (ret != EFI_SUCCESS) {
> +                       efi_st_error("could not close event\n");
> +                       return 1;
> +               }
> +       }
> +       return 0;
> +}
> +
> +/*
> + * Execute unit test.
> + *
> + * Run a 10 ms periodic timer and check that it is called 10 times
> + * while waiting for 100 ms single shot timer.
> + *
> + * Run a 100 ms single shot timer and check that it is called once
> + * while waiting for 100 ms periodic timer for two periods.
> + */
> +static int execute(void)
> +{
> +       unsigned long index;
> +       efi_status_t ret;
> +
> +       /* Set 10 ms timer */
> +       counter = 0;
> +       ret = boottime->set_timer(event_notify, EFI_TIMER_PERIODIC, 100000);
> +       if (ret != EFI_SUCCESS) {
> +               efi_st_error("Could not set timer\n");
> +               return 1;
> +       }
> +       /* Set 100 ms timer */
> +       ret = boottime->set_timer(event_wait, EFI_TIMER_RELATIVE, 1000000);
> +       if (ret != EFI_SUCCESS) {
> +               efi_st_error("Could not set timer\n");
> +               return 1;
> +       }
> +
> +       index = 5;

Is this an non-zero arbitrary value? Please add a comment.

> +       ret = boottime->wait_for_event(1, &event_wait, &index);
> +       if (ret != EFI_SUCCESS) {
> +               efi_st_error("Could not wait for event\n");
> +               return 1;
> +       }
> +       ret = boottime->check_event(event_wait);
> +       if (ret != EFI_NOT_READY) {
> +               efi_st_error("Signaled state was not cleared.\n");
> +               efi_st_printf("ret = %u\n", (unsigned int)ret);
> +               return 1;
> +       }
> +       if (index != 0) {
> +               efi_st_error("WaitForEvent returned wrong index\n");
> +               return 1;
> +       }
> +       efi_st_printf("Counter periodic: %u\n", counter);
> +       if (counter < 8 || counter > 12) {
> +               efi_st_error("Incorrect timing of events\n");
> +               return 1;
> +       }
> +       ret = boottime->set_timer(event_notify, EFI_TIMER_STOP, 0);
> +       if (index != 0) {
> +               efi_st_error("Could not cancel timer\n");
> +               return 1;
> +       }
> +       /* Set 10 ms timer */
> +       counter = 0;
> +       ret = boottime->set_timer(event_notify, EFI_TIMER_RELATIVE, 100000);
> +       if (index != 0) {
> +               efi_st_error("Could not set timer\n");
> +               return 1;
> +       }
> +       /* Set 100 ms timer */
> +       ret = boottime->set_timer(event_wait, EFI_TIMER_PERIODIC, 1000000);
> +       if (index != 0) {
> +               efi_st_error("Could not set timer\n");
> +               return 1;
> +       }
> +       ret = boottime->wait_for_event(1, &event_wait, &index);
> +       if (ret != EFI_SUCCESS) {
> +               efi_st_error("Could not wait for event\n");
> +               return 1;
> +       }

One problem with this test is that it takes 100ms to run. I don't know
if the EFI API has any test facilities, but with sandbox we can update
the timer to make the test take no time.

(that's just a comment, no change needed here)

> +       efi_st_printf("Counter single shot: %u\n", counter);
> +       if (counter != 1) {
> +               efi_st_error("Single shot timer failed\n");
> +               return 1;
> +       }
> +       ret = boottime->wait_for_event(1, &event_wait, &index);
> +       if (ret != EFI_SUCCESS) {
> +               efi_st_error("Could not wait for event\n");
> +               return 1;
> +       }
> +       efi_st_printf("Stopped counter: %u\n", counter);
> +       if (counter != 1) {
> +               efi_st_error("Stopped timer fired\n");
> +               return 1;
> +       }
> +       ret = boottime->set_timer(event_wait, EFI_TIMER_STOP, 0);
> +       if (index != 0) {
> +               efi_st_error("Could not cancel timer\n");
> +               return 1;
> +       }
> +
> +       return 0;
> +}
> +
> +EFI_UNIT_TEST(events) = {
> +       .name = "event services",
> +       .phase = EFI_EXECUTE_BEFORE_BOOTTIME_EXIT,
> +       .setup = setup,
> +       .execute = execute,
> +       .teardown = teardown,
> +};
> --
> 2.11.0
>

Regards,
Simon