proxysql

Commit Graph

Author	SHA1	Message	Date
Rene Cannao	f104116926	fix(plugin-mgr): serialize lifecycle and always reset manager on stop Add g_plugin_lifecycle_mutex to serialize load/start/stop transitions so two reload paths cannot race on g_registry_target and the registration-failure globals. g_active_plugin_manager_mutex remains the pointer-read guard for the dispatch path; the new mutex is held only for the duration of a lifecycle transition. In proxysql_stop_configured_plugins, always call manager.reset() so the .so is unmapped and no stale function pointers remain reachable, even when stop_all() reports a failure. stop_all() is idempotent across failure (each plugin is marked stopped after one attempt) so the destructor's stop_all() will be a no-op. Also fix the log-level table in PLUGIN_API.md: numeric levels are 3 (Error), 4 (Warning), and any-other (Info), matching the internal proxy_* severity scheme — not 1/2/3 as previously documented.	2 months ago
Rene Cannao	cd11df3a7f	doc: add Plugin API documentation for external users ProxySQL's plugin system was previously undocumented except for the header file (include/ProxySQL_Plugin.h) and the mysqlx reference implementation. A developer wanting to write a plugin had to reverse-engineer the contract from those sources. Add doc/PLUGIN_API.md covering: - How plugins are loaded (plugins= directive in proxysql.cnf) - Startup/shutdown lifecycle sequence - The ProxySQL_PluginDescriptor contract (name, abi_version, init/start/stop/status_json) - The proxysql_plugin_descriptor_v1 entry point - ProxySQL_PluginServices callbacks (register_table, register_command, log_message, get_admindb/configdb/statsdb, snapshots) - ProxySQL_PluginCommandContext and ProxySQL_PluginCommandResult types - Complete minimal plugin example - Build requirements and compiler compatibility notes - Admin integration patterns (three-tier config model, table registration) - Current limitations (no hot-loading, no dependency resolution, compiler coupling) - Pointer to the mysqlx reference implementation	2 months ago

Author

SHA1

Message

Date

Rene Cannao

f104116926

fix(plugin-mgr): serialize lifecycle and always reset manager on stop

Add g_plugin_lifecycle_mutex to serialize load/start/stop transitions
so two reload paths cannot race on g_registry_target and the
registration-failure globals. g_active_plugin_manager_mutex remains the
pointer-read guard for the dispatch path; the new mutex is held only
for the duration of a lifecycle transition.

In proxysql_stop_configured_plugins, always call manager.reset() so the
.so is unmapped and no stale function pointers remain reachable, even
when stop_all() reports a failure. stop_all() is idempotent across
failure (each plugin is marked stopped after one attempt) so the
destructor's stop_all() will be a no-op.

Also fix the log-level table in PLUGIN_API.md: numeric levels are 3
(Error), 4 (Warning), and any-other (Info), matching the internal
proxy_* severity scheme — not 1/2/3 as previously documented.

Rene Cannao

cd11df3a7f

doc: add Plugin API documentation for external users

ProxySQL's plugin system was previously undocumented except for the
header file (include/ProxySQL_Plugin.h) and the mysqlx reference
implementation. A developer wanting to write a plugin had to
reverse-engineer the contract from those sources.

Add doc/PLUGIN_API.md covering:
- How plugins are loaded (plugins= directive in proxysql.cnf)
- Startup/shutdown lifecycle sequence
- The ProxySQL_PluginDescriptor contract (name, abi_version, init/start/stop/status_json)
- The proxysql_plugin_descriptor_v1 entry point
- ProxySQL_PluginServices callbacks (register_table, register_command, log_message, get_admindb/configdb/statsdb, snapshots)
- ProxySQL_PluginCommandContext and ProxySQL_PluginCommandResult types
- Complete minimal plugin example
- Build requirements and compiler compatibility notes
- Admin integration patterns (three-tier config model, table registration)
- Current limitations (no hot-loading, no dependency resolution, compiler coupling)
- Pointer to the mysqlx reference implementation

2 Commits (a2e99eed5096d305366a3ce88c170839790c1921)