[PATCH i-g-t 1/2] igt_core: igt_hook_get_pointer() for external hooks

[Gustavo Sousa]

Quoting Peter Senna Tschudin (2025-07-03 12:03:03-03:00)
>Previously, all igt_hooks were defined, initialized, and freed within
>lib/igt_core.c, limiting hook creation to this file. To enable other
>libraries to add hooks, introduce a function that returns a pointer to
>the main hook structure.
>
>This change allows hooks to be created from external libraries without
>requiring separate initialization or teardown of the hook
>infrastructure.
>
>Cc: Gustavo Sousa <gustavo.sousa at linux.intel.com>
>Cc: Lucas de Marchi <lucas.demarchi at linux.intel.com>
>Signed-off-by: Peter Senna Tschudin <peter.senna at linux.intel.com>
>---
> lib/igt_core.c | 12 ++++++++++++
> lib/igt_core.h |  9 +++++++++
> 2 files changed, 21 insertions(+)
>
>diff --git a/lib/igt_core.c b/lib/igt_core.c
>index c2674a272..f7a1ee36c 100644
>--- a/lib/igt_core.c
>+++ b/lib/igt_core.c
>@@ -3604,3 +3604,15 @@ unsigned int igt_measured_usleep(unsigned int usec)
> 
>         return igt_nsec_elapsed(&ts) / NSEC_PER_USEC;
> }
>+
>+/**
>+ * igt_hook_get_pointer: To allow for using hooks from other libraries, this
>+ * function returns the pointer to the struct that is likely already
>+ * initialized.
>+ *
>+ * Returns: Pointer to the igt_hook structure.
>+ */
>+struct igt_hook *igt_hook_get_pointer(void)
>+{
>+        return igt_hook;
>+}

Perhaps the name of the function should be changed?

I would expect functions starting with "igt_hook_" to belong to the
igt_hook library, but this one is specific to the pointer that is
initialized by core.

What about igt_core_get_igt_hook()?

Not sure I like we repeating "igt" in this one, but I think
igt_core_get_hook() is not very good either. So, between the two, I
prefer igt_core_get_igt_hook(), which is more precise.

>diff --git a/lib/igt_core.h b/lib/igt_core.h
>index 2db579423..2e65c89dd 100644
>--- a/lib/igt_core.h
>+++ b/lib/igt_core.h
>@@ -1601,4 +1601,13 @@ void igt_pci_system_cleanup(void);
> void igt_emit_ignore_dmesg_regex(const char *ignore_dmesg_regex);
> 
> unsigned int igt_measured_usleep(unsigned int usec);
>+
>+/**
>+ * igt_hook_get_pointer: To allow for using hooks from other libraries, this
>+ * function returns the pointer to the struct that is likely already
>+ * initialized.
>+ *
>+ * Returns: Pointer to the igt_hook structure.
>+ */

We can drop this duplicated documentation.

--
Gustavo Sousa

>+struct igt_hook *igt_hook_get_pointer(void);
> #endif /* IGT_CORE_H */
>-- 
>2.43.0
>