Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[5.0] more robust chain_api_plugin check in producer_plugin #2106

Merged
merged 2 commits into from
Jan 19, 2024
Merged

[5.0] more robust chain_api_plugin check in producer_plugin #2106

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
576984b
different approach to detecting if chain_api_plugin enabled
spoonincode Jan 18, 2024
bb8400d
don't assume chain_api_plugin is linked
spoonincode Jan 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions plugins/producer_plugin/producer_plugin.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1212,14 +1212,12 @@ void producer_plugin_impl::plugin_initialize(const boost::program_options::varia
if (options.count("read-only-threads")) {
_ro_thread_pool_size = options.at("read-only-threads").as<uint32_t>();
} else if (_producers.empty()) {
if (options.count("plugin")) {
const auto& v = options.at("plugin").as<std::vector<std::string>>();
auto i = std::find_if(v.cbegin(), v.cend(), [](const std::string& p) { return p == "eosio::chain_api_plugin"; });
if (i != v.cend()) {
// default to 3 threads for non producer nodes running chain_api_plugin if not specified
_ro_thread_pool_size = 3;
ilog("chain_api_plugin configured, defaulting read-only-threads to ${t}", ("t", _ro_thread_pool_size));
}
//appbase initializes configured plugins before auto-start plugins, so if chain_api_plugin is enabled it's
// initialized before producer_plugin (i.e. before this code here)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/AntelopeIO/appbase/blob/b75b31e14f966fa3de6246e120dcba36c6ce5264/application_base.cpp#L397-L416

if (abstract_plugin* capi = app().find_plugin("eosio::chain_api_plugin"); capi && capi->get_state() == abstract_plugin::initialized) {
// default to 3 threads for non producer nodes running chain_api_plugin if not specified
_ro_thread_pool_size = 3;
ilog("chain_api_plugin configured, defaulting read-only-threads to ${t}", ("t", _ro_thread_pool_size));
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another approach would have been to change the previous check from == to find(), but I like asking appbase more directly instead of fishing in config items that this plugin doesn't "own".

The downside is that the check is reliant on plugin initialization ordering semantics that are arguably an implementation detail of appbase, and that producer_plugin will always remain an auto-start plugin. (Not for 5.0 but possibly in main) appbase might should have a new plugin state: enabled, and all plugins get marked enabled before they get initalize()ed, to avoid this dependency on ordering. (It's possible this isn't a plugin state() but rather some other new is_enabled() property on the plugin)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about adding (producer_plugin) to APPBASE_PLUGIN_REQUIRES((chain_plugin)(http_plugin)) of chain_api_plugin.hpp.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would require adding producer_plugin as a build dependency of chain_api_plugin -- target_link_libraries() etc. kinda gnarly when they really don't depend on each other.

}
}
EOS_ASSERT(producer_plugin::test_mode_ || _ro_thread_pool_size == 0 || _producers.empty(), plugin_config_exception,
Expand Down