colin/wireplumber
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

component-loader: make wp_core_load_component() API asynchronous

Browse Source 
This change completely refactors the way components are loaded in wireplumber:
- The module_init() function must return a GObject now. This object is either
a WpPlugin or a WpSiFactory in the current modules.
- When the component loader initializes a module, it automatically registers
the WpPlugin or WpSiFactory with their respective methods. There is no need
to register the WpPlugin or WpSiFactory in the module now.
- The wp_core_load_component() API has been refactored to be asynchronows. This
allows the component loader to automatically activate WpPlugin objects, and
therefore allows the application to directly get the WpPlugin without having
to find it. This simplifies a lot of things.
- The 'ifexists' and 'nofail' component flags now work even if the respective
WpPlugin could not be activated.
- The code that loads components in main.c has also been simplified a lot,
and the option to load dangling components has also been removed.
This commit is contained in:
Julian Bouzas
2023-02-09 13:11:14 -05:00
parent ad940b6efc
commit c61d1e4245
28 changed files with 519 additions and 703 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
modules/module-lua-scripting/api/require.c
View File

@@ -17,8 +17,7 @@ struct _WpRequireApiTransition
};
enum {
STEP_LOAD_MODULES = WP_TRANSITION_STEP_CUSTOM_START,
STEP_ACTIVATE_PLUGINS,
STEP_LOAD_PLUGINS = WP_TRANSITION_STEP_CUSTOM_START,
};
G_DECLARE_FINAL_TYPE (WpRequireApiTransition, wp_require_api_transition,
@@ -47,23 +46,24 @@ wp_require_api_transition_get_next_step (WpTransition * transition, guint step)
WpRequireApiTransition *self = WP_REQUIRE_API_TRANSITION (transition);
switch (step) {
case WP_TRANSITION_STEP_NONE: return STEP_LOAD_MODULES;
case STEP_LOAD_MODULES: return STEP_ACTIVATE_PLUGINS;
case STEP_ACTIVATE_PLUGINS:
case WP_TRANSITION_STEP_NONE: return STEP_LOAD_PLUGINS;
case STEP_LOAD_PLUGINS:
return (self->pending_plugins > 0) ?
STEP_ACTIVATE_PLUGINS : WP_TRANSITION_STEP_NONE;
STEP_LOAD_PLUGINS : WP_TRANSITION_STEP_NONE;
default:
g_return_val_if_reached (WP_TRANSITION_STEP_ERROR);
}
}
static void
on_plugin_activated (WpObject * p, GAsyncResult * res,
on_plugin_loaded (WpCore * core, GAsyncResult * res,
WpRequireApiTransition *self)
{
g_autoptr (GObject) o = NULL;
GError *error = NULL;
if (!wp_object_activate_finish (p, res, &error)) {
o = wp_core_load_component_finish (core, res, &error);
if (!o) {
wp_transition_return_error (WP_TRANSITION (self), error);
return;
}
@@ -79,49 +79,24 @@ wp_require_api_transition_execute_step (WpTransition * transition, guint step)
WpCore *core = wp_transition_get_source_object (transition);
switch (step) {
case STEP_LOAD_MODULES:
{
case STEP_LOAD_PLUGINS:
wp_debug_object (self, "Loading plugins...");
for (guint i = 0; i < self->apis->len; i++) {
const gchar *api_name = g_ptr_array_index (self->apis, i);
g_autoptr (WpPlugin) plugin = wp_plugin_find (core, api_name);
if (!plugin) {
GError *error = NULL;
gchar module_name[50];
g_snprintf (module_name, sizeof (module_name),
"libwireplumber-module-%s", api_name);
if (!wp_core_load_component (core, module_name, "module", NULL, &error)) {
wp_transition_return_error (transition, error);
return;
}
plugin = wp_plugin_find (core, api_name);
if (!plugin) {
wp_transition_return_error (transition, g_error_new (
WP_DOMAIN_LIBRARY, WP_LIBRARY_ERROR_INVALID_ARGUMENT,
"API '%s' was not found in module '%s'", api_name, module_name));
return;
}
self->pending_plugins++;
wp_core_load_component (core, module_name, "module", NULL,
(GAsyncReadyCallback) on_plugin_loaded, self);
}
}
wp_transition_advance (transition);
break;
}
case STEP_ACTIVATE_PLUGINS:
wp_debug_object (self, "Activating plugins...");
for (guint i = 0; i < self->apis->len; i++) {
const gchar *api_name = g_ptr_array_index (self->apis, i);
g_autoptr (WpPlugin) plugin = wp_plugin_find (core, api_name);
self->pending_plugins++;
wp_object_activate (WP_OBJECT (plugin), WP_PLUGIN_FEATURE_ENABLED, NULL,
(GAsyncReadyCallback) on_plugin_activated, self);
}
wp_transition_advance (transition);
break;
case WP_TRANSITION_STEP_ERROR:
break;

107
modules/module-lua-scripting/module.c
View File

@@ -18,7 +18,6 @@ struct _WpLuaScriptingPlugin
{
WpComponentLoader parent;
GPtrArray *scripts; /* element-type: WpPlugin* */
lua_State *L;
};
@@ -90,17 +89,6 @@ G_DEFINE_TYPE (WpLuaScriptingPlugin, wp_lua_scripting_plugin,
static void
wp_lua_scripting_plugin_init (WpLuaScriptingPlugin * self)
{
self->scripts = g_ptr_array_new_with_free_func (g_object_unref);
}
static void
wp_lua_scripting_plugin_finalize (GObject * object)
{
WpLuaScriptingPlugin * self = WP_LUA_SCRIPTING_PLUGIN (object);
g_clear_pointer (&self->scripts, g_ptr_array_unref);
G_OBJECT_CLASS (wp_lua_scripting_plugin_parent_class)->finalize (object);
}
static void
@@ -129,14 +117,6 @@ wp_lua_scripting_plugin_enable (WpPlugin * plugin, WpTransition * transition)
wp_lua_scripting_enable_package_searcher (self->L);
wplua_enable_sandbox (self->L, WP_LUA_SANDBOX_ISOLATE_ENV);
/* register scripts that were queued in for loading */
for (guint i = 0; i < self->scripts->len; i++) {
WpPlugin *script = g_ptr_array_index (self->scripts, i);
g_object_set (script, "lua-engine", self->L, NULL);
wp_plugin_register (g_object_ref (script));
}
g_ptr_array_set_size (self->scripts, 0);
wp_object_update_features (WP_OBJECT (self), WP_PLUGIN_FEATURE_ENABLED, 0);
}
@@ -144,6 +124,7 @@ static void
wp_lua_scripting_plugin_disable (WpPlugin * plugin)
{
WpLuaScriptingPlugin * self = WP_LUA_SCRIPTING_PLUGIN (plugin);
g_clear_pointer (&self->L, wplua_unref);
}
@@ -165,7 +146,6 @@ find_script (const gchar * script, WpCore *core)
g_file_test (script, G_FILE_TEST_IS_REGULAR))
return g_strdup (script);
return wp_find_file (WP_LOOKUP_DIR_ENV_DATA |
WP_LOOKUP_DIR_ENV_TEST_SRCDIR |
WP_LOOKUP_DIR_XDG_CONFIG_HOME |
@@ -174,71 +154,79 @@ find_script (const gchar * script, WpCore *core)
script, "scripts");
}
static gboolean
static void
on_script_loaded (WpObject *object, GAsyncResult *res, gpointer data)
{
g_autoptr (GTask) task = G_TASK (data);
g_autoptr (GError) error = NULL;
if (!wp_object_activate_finish (object, res, &error)) {
g_task_return_error (task, g_steal_pointer (&error));
return;
}
g_task_return_pointer (task, g_object_ref (object), g_object_unref);
}
static void
wp_lua_scripting_plugin_load (WpComponentLoader * cl, const gchar * component,
const gchar * type, GVariant * args, GError ** error)
const gchar * type, GVariant * args, GAsyncReadyCallback callback,
gpointer data)
{
WpLuaScriptingPlugin * self = WP_LUA_SCRIPTING_PLUGIN (cl);
g_autoptr (WpCore) core = NULL;
g_autoptr (WpCore) core = wp_object_get_core (WP_OBJECT (cl));
g_autoptr (GTask) task = task = g_task_new (core, NULL, callback, data);
g_autofree gchar *filepath = NULL;
g_autofree gchar *pluginname = NULL;
g_autoptr (WpPlugin) script = NULL;
/* make sure the component loader is activated */
if (!self->L) {
g_task_return_new_error (task, G_IO_ERROR, G_IO_ERROR_NOT_FOUND,
"Lua script component loader cannot load Lua scripts if not enabled");
return;
}
/* make sure the type is supported */
if (!g_str_equal (type, "script/lua")) {
g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND,
g_task_return_new_error (task, G_IO_ERROR, G_IO_ERROR_NOT_FOUND,
"Could not load script '%s' as its type is not 'script/lua'",
component);
return FALSE;
}
core = wp_object_get_core (WP_OBJECT (cl));
if (g_file_test (component, G_FILE_TEST_EXISTS)) {
/* dangling components come with full path */
g_autofree gchar *filename = g_path_get_basename (component);
filepath = g_strdup (component);
pluginname = g_strdup_printf ("script:%s", filename);
} else {
filepath = find_script (component, core);
pluginname = g_strdup_printf ("script:%s", component);
return;
}
/* find the script */
filepath = find_script (component, core);
if (!filepath) {
g_set_error (error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND,
g_task_return_new_error (task, G_IO_ERROR, G_IO_ERROR_NOT_FOUND,
"Could not locate script '%s'", component);
return FALSE;
return;
}
pluginname = g_strdup_printf ("script:%s", component);
script = g_object_new (WP_TYPE_LUA_SCRIPT,
"core", core,
"name", pluginname,
"lua-engine", self->L,
"filename", filepath,
"arguments", args,
NULL);
if (self->L) {
wp_debug_object (core, "loading script(%s) plugin name(%s)",
filepath, pluginname);
g_object_set (script, "lua-engine", self->L, NULL);
wp_plugin_register (g_steal_pointer (&script));
} else {
/* keep in a list and delay registering until the plugin is enabled */
wp_debug ("queuing script %s", filepath);
g_ptr_array_add (self->scripts, g_steal_pointer (&script));
}
/* register the script */
wp_plugin_register (g_object_ref (script));
return TRUE;
/* enable script */
wp_object_activate (WP_OBJECT (script), WP_OBJECT_FEATURES_ALL, NULL,
(GAsyncReadyCallback) on_script_loaded, g_object_ref (task));
}
static void
wp_lua_scripting_plugin_class_init (WpLuaScriptingPluginClass * klass)
{
GObjectClass *object_class = (GObjectClass *) klass;
WpPluginClass *plugin_class = (WpPluginClass *) klass;
WpComponentLoaderClass *cl_class = (WpComponentLoaderClass *) klass;
object_class->finalize = wp_lua_scripting_plugin_finalize;
plugin_class->enable = wp_lua_scripting_plugin_enable;
plugin_class->disable = wp_lua_scripting_plugin_disable;
@@ -246,12 +234,11 @@ wp_lua_scripting_plugin_class_init (WpLuaScriptingPluginClass * klass)
cl_class->load = wp_lua_scripting_plugin_load;
}
WP_PLUGIN_EXPORT gboolean
WP_PLUGIN_EXPORT GObject *
wireplumber__module_init (WpCore * core, GVariant * args, GError ** error)
{
wp_plugin_register (g_object_new (wp_lua_scripting_plugin_get_type (),
"name", "lua-scripting",
"core", core,
NULL));
return TRUE;
return G_OBJECT (g_object_new (wp_lua_scripting_plugin_get_type (),
"name", "lua-scripting",
"core", core,
NULL));
}

2
modules/module-lua-scripting/script.c
View File

@@ -272,7 +272,7 @@ wp_lua_script_class_init (WpLuaScriptClass * klass)
g_object_class_install_property (object_class, PROP_LUA_ENGINE,
g_param_spec_pointer ("lua-engine", "lua-engine", "lua-engine",
G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
g_object_class_install_property (object_class, PROP_FILENAME,
g_param_spec_string ("filename", "filename", "filename", NULL,