From 4eb0f16e252dd76fa7009e85aba0f17fd69f445a Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Mon, 21 Dec 2020 12:34:46 +0100 Subject: fsm: Add osmo_fsm_inst_broadcast_children() This is a helper function to broadcast an event to all of the siblings of a specified FSM instance. Change-Id: I2ce398741a8672d7b7c4058d056f46e2fe7353c1 --- include/osmocom/core/fsm.h | 11 +++++++++++ src/fsm.c | 20 ++++++++++++++++++++ 2 files changed, 31 insertions(+) diff --git a/include/osmocom/core/fsm.h b/include/osmocom/core/fsm.h index 7b262c71..77ebe7c1 100644 --- a/include/osmocom/core/fsm.h +++ b/include/osmocom/core/fsm.h @@ -326,4 +326,15 @@ void _osmo_fsm_inst_term_children(struct osmo_fsm_inst *fi, void *data, const char *file, int line); +/*! dispatch an event to all children of an osmocom finite state machine instance + * + * This is a macro that calls _osmo_fsm_inst_broadcast_children() with the given + * parameters as well as the caller's source file and line number for logging + * purposes. See there for documentation. + */ +#define osmo_fsm_inst_broadcast_children(fi, cause, data) \ + _osmo_fsm_inst_broadcast_children(fi, cause, data, __FILE__, __LINE__) +void _osmo_fsm_inst_broadcast_children(struct osmo_fsm_inst *fi, uint32_t event, + void *data, const char *file, int line); + /*! @} */ diff --git a/src/fsm.c b/src/fsm.c index 1e8909ec..f1dbb412 100644 --- a/src/fsm.c +++ b/src/fsm.c @@ -1016,6 +1016,26 @@ void _osmo_fsm_inst_term_children(struct osmo_fsm_inst *fi, } } +/*! Broadcast an event to all the FSMs children. + * + * Iterate over all children and send them the specified event. + * + * \param[in] fi FSM instance of the parent + * \param[in] event Event to send to children of FSM instance + * \param[in] data Data to pass along with the event + * \param[in] file Calling source file (from osmo_fsm_inst_dispatch macro) + * \param[in] line Calling source line (from osmo_fsm_inst_dispatch macro) + */ +void _osmo_fsm_inst_broadcast_children(struct osmo_fsm_inst *fi, + uint32_t event, void *data, + const char *file, int line) +{ + struct osmo_fsm_inst *child, *tmp; + llist_for_each_entry_safe(child, tmp, &fi->proc.children, proc.child) { + _osmo_fsm_inst_dispatch(child, event, data, file, line); + } +} + const struct value_string osmo_fsm_term_cause_names[] = { OSMO_VALUE_STRING(OSMO_FSM_TERM_PARENT), OSMO_VALUE_STRING(OSMO_FSM_TERM_REQUEST), -- cgit v1.2.3