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.

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

doc: Add some documentation around a new pthread call #15287

Merged
merged 1 commit into from
Feb 6, 2024
Merged
Changes from all commits
Commits
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
9 changes: 9 additions & 0 deletions doc/developer/rcu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,15 @@ Internals
that case, either all of the library's threads must be registered for RCU,
or the code must instead pass a (non-RCU) copy of the data to the library.
.. c:function:: int frr_pthread_non_controlled_startup(pthread_t thread, const char *name, const char *os_name)
If a pthread is started outside the control of normal pthreads in frr
then frr_pthread_non_controlled_startup should be called. This will
properly setup both the pthread with rcu usage as well as some data
structures pertaining to the name of the pthread. This is especially
important if the pthread created ends up calling back into FRR and
one of the various zlog_XXX functions is called.
.. c:function:: void rcu_shutdown(void)
Stop the RCU sweeper thread and make sure all cleanup has finished.
Expand Down
Loading