Skip to content

Controller refactors: Clean up controld_execd_state.c and add Doxygen - #4159

Open
nrwahl2 wants to merge 54 commits into
ClusterLabs:mainfrom
nrwahl2:nrwahl2-controller_first
Open

Controller refactors: Clean up controld_execd_state.c and add Doxygen#4159
nrwahl2 wants to merge 54 commits into
ClusterLabs:mainfrom
nrwahl2:nrwahl2-controller_first

Conversation

@nrwahl2

@nrwahl2 nrwahl2 commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

I've tried to avoid making big substantive changes here. This PR is about adding Doxygen, following best practices, and renaming functions to follow conventions (including moving away from "lrm" and toward "execd"). The idea is to make the logic easier to understand at a glance.

More to come. This covers all of controld_execd_state.c.

Incidentally, I understand why we wanted to break up controld_execd.c since it was (and is) so large -- but which functions are placed in controld_execd_state.c often seems pretty arbitrary. Maybe we can find a better way to organize all this code after we understand it better and untangle it somewhat.

nrwahl2 added 5 commits August 5, 2026 12:12
@nrwahl2
Doc: sysconfig: Drop G_SLICE from /etc/sysconfig/pacemaker boilerplate
583b044 
It's been ignored since GLib 2.76. We only require GLib >= 2.42
currently, but this option doesn't seem very useful anyway.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Document some GDestroyNotify funcs for execd
61d8065 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Doc: controller: Document lrm_state_t:active_ops
a29d03d 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Clean up fail_pending_op()
675d860 
* Add Doxygen.
* Add call_key variable.
* Drop hyphen from "Pre-emptively."
* Set fields in the order in which they're defined for
  lrmd_event_data_t.
* Use true instead of TRUE.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop lrm_state_is_local()
8d4bd38 
It doesn't seem to simplify things much.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
nrwahl2 requested a review from clumens August 5, 2026 19:18
@nrwahl2
nrwahl2 force-pushed the nrwahl2-controller_first branch from f64c53d to 82e7290 Compare August 5, 2026 19:32
nrwahl2
nrwahl2 commented Aug 5, 2026
View reviewed changes
Comment thread daemons/controld/controld_execd_state.c
} else {
/* Ignored for remote connections.
*
* @TODO Do we even need to set this in this function?

@nrwahl2 nrwahl2 Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I address this in a later commit (not in this PR). Short answer: no.

@nrwahl2

nrwahl2 commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

RemoteBasic and RemoteMigrate have seg faulted for some reason. There are a few more tests still waiting to run.

@nrwahl2
nrwahl2 marked this pull request as draft August 5, 2026 20:56
@nrwahl2
nrwahl2 marked this pull request as ready for review August 5, 2026 21:03
@nrwahl2
nrwahl2 force-pushed the nrwahl2-controller_first branch from 82e7290 to 31e360e Compare August 5, 2026 21:03
nrwahl2 added 18 commits August 5, 2026 14:35
@nrwahl2
Refactor: controller: Drop lrm_state_is_connected()
6c68695 
It doesn't seem to simplify things much.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop lrm_state_poke_connection()
65739c1 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop lrm_state_disconnect()
d96c2eb 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Rename lrm_state_disconnect_only()
15b3016 
...to controld_execd_state_disconnect().

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop lrm_state_reset_tables reset_metadata arg
c65d16a 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Rename active_op_t:user_data to transition_key
f5013bc 
This is the only thing it ever holds, so rename it to clarify intent. We
can't rename lrmd_event_data_t:user_data in a straightforward way,
because it's public API.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Return void from verify_stopped()
5f23bd5 
This should have been done in e79c5b3. Nothing checks the return value.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Expose cancel_op() within daemon
7e81d50 
Also rename it to controld_execd_cancel_op() and return bool instead of
gboolean. An upcoming commit will call it within controld_execd_state.c.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Move lrm_state_verify_stopped()
894bc13 
...and its helpers to controld_execd_state.c. This seems like the more
appropriate place.

For ease of review, no code changes in this commit; it only moves.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Best practices in stop_recurring_actions()
fc07458 
* Add Doxygen.
* Rename to cancel_recurring_op.
* Drop "remove" variable.
* Add a "call_key" variable.
* Use const where possible.
* Unindent recurring case.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Some best practices in is_rsc_active()
0972f27 
* Add Doxygen.
* Use bool instead of gboolean.
* Improve whitespace.
* Drop unnecessary elses.
* Compare op_type case-sensitively.
* Use a new "last" variable for readability.
* Use const where appropriate. (lrm_state->resource_history is passed as
  non-const to g_hash_table_lookup(), but it shouldn't get modified.
  Unfortunate GLib function signature.)

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Reorganize and document cases of is_rsc_active()
bc2aab3 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: lrm_state_verify_stopped() returns bool
ae84a30 
...instead of gboolean.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop rc variable from lrm_state_verify_stopped()
664fbc5 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Some lrm_state_verify_stopped() best practices
bff57bc 
* Use const where appropriate.
* Make counter an unsigned int and rename to count.
* Rename gIter and hIter to iter and iter2, respectively.
* Rename key to call_key for consistency with some other functions.
* Improve whitespace.
* Compare explicitly against 0.
* Use pcmk__plural_alt().

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Merge two blocks of lrm_state_verify_stopped()
92a237d 
Both blocks require lrm_state->active_ops != NULL, and both of them do
nothing if the size of lrm_state->active_ops is zero.

We drop the nremaining variable because it's the original size minus the
number of items removed. Also, the condition
"(removed > 0) || (nremaining > 0)" is equivalent to the condition that
the original size is nonzero. So we drop that check when we add the
nonzero size check at the beginning of the block.

Clarify the notice message.

Use g_hash_table_foreach() with a new function count_non_recurring_op()
to count the non-recurring operations. For me, this is more readable.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: New log_pending_op()
c306dd4 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Don't NULL-check lrm_state_t hash tables
d31a9bd 
It shouldn't be necessary to assert non-NULL on these either. GLib does
its own equivalents of pcmk__assert() and CRM_CHECK().

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@clumens clumens added the review: in progress PRs that are currently being reviewed label Aug 21, 2026
clumens
clumens reviewed Aug 21, 2026
View reviewed changes
Comment thread daemons/controld/controld_execd_state.c
Comment thread daemons/controld/controld_execd_state.c Outdated
Comment thread daemons/controld/controld_execd.c
Comment thread daemons/controld/controld_execd_state.c Outdated
nrwahl2 added 26 commits August 21, 2026 14:20
@nrwahl2
Refactor: controller: Light cleanup of lrm_state_create()
4be5466 
The sole caller always passes non-NULL for node_name.

Insert the newly allocated state object into the table in the caller, as
this seems clearer to me.

Drop free_rsc_info() as a wrapper and use a cast instead.

The reorderings are just to match the order in the struct definition.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Assert before deref in controld_execd_state.c
44a5dea 
Do this for GDestroyNotifys, GHFuncs, and GHRFuncs as well. Usually we
don't NULL-check arguments of a static function with only one caller.
However, for these, the arguments are the items in a GHashTable. We
haven't NULL-checked them since they were inserted, so these assertions
act as sanity checks of the tables' contents.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Light cleanup of internal_lrm_state_destroy()
74fe93f 
The deleted comment is redundant due to a similar comment in
controld_remote_proxy_disconnect_node().

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Light cleanup of lrm_state_reset_tables()
0c49ec6 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Doc: controller: Doxygen for controld_execd_state_table_{init,free}()
98ac72b 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Light cleanup of controld_get_executor_state()
8fe9221 
And rename it to controld_execd_state_get().

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop NULL checks for mainloop_del_ipc_client()
fd3f253 
It NULL-checks the argument itself.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Light cleanup of controld_lrm_state_disconnect()
0981a58 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Light cleanup of controld_connect_local_executor()
7dab5ee 
...and controld_connect_remote_executor().

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop lrm_state_get_metadata() options argument
061ad28 
The sole caller passes 0.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Clean up lrm_state_get_metadata()
39a92a0 
Regarding the lrm_state argument being const: its conn field is passed
as non-const to the get_metadata_params() method. However, that method
completely ignores that argument.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop remote_ra_cancel() lrm_state argument
15fbac2 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop two is_remote_lrmd_ra() arguments
d85dbee 
They're always NULL except for one caller.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Light cleanup of lrm_state_cancel().
bd16e25 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop lrm_state_get_rsc_info() options argument
2489e42 
All callers pass 0.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop remote_ra_get_rsc_info() lrm_state argument
08fadda 
It's ignored.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Light cleanup of lrm_state_get_rsc_info()
6ba9089 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: liblrmd: New lrmd__key_value_add_from_hash()
60d7d15 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Light cleanup of controld_execute_resource_agent()
9216b06 
The action vs. operation terminology in the updated Doxygen takes cues
from T781.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop lrm_state_register_rsc() options argument
cd263a5 
The sole caller passed lrmd_opt_drop_recurring.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: get_lrm_resource() returns standard code
c6095c8 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Light cleanup of lrm_state_register_rsc()
16600ca 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Drop lrm_state_unregister_rsc() options argument
194b000 
The sole caller passed 0.

Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: notify_deleted() takes standard code for rc arg
969462a 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: delete_rsc_entry() takes standard code for rc arg
325f778 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
Refactor: controller: Light cleanup of lrm_state_unregister_rsc()
1857b1f 
Signed-off-by: Reid Wahl <nrwahl@protonmail.com>
@nrwahl2
nrwahl2 force-pushed the nrwahl2-controller_first branch from 4f2e241 to 1857b1f Compare August 21, 2026 21:25
@nrwahl2

nrwahl2 commented Aug 22, 2026

Copy link
Copy Markdown
Contributor Author

@clumens Should be good to go on my end. Anything to add or any more review to do?

I posted and deleted a comment saying I was gonna go ahead and merge it. I realized I don't have anything to gain by doing so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@clumens clumens clumens left review comments

Assignees

No one assigned

Labels

review: in progress PRs that are currently being reviewed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@nrwahl2 @clumens