2017-06-20 02:35:06 +00:00
|
|
|
/*! \file fsm.h
|
|
|
|
* Finite State Machine
|
|
|
|
*/
|
|
|
|
|
2016-05-29 01:53:17 +00:00
|
|
|
#pragma once
|
|
|
|
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <stdbool.h>
|
|
|
|
|
|
|
|
#include <osmocom/core/linuxlist.h>
|
|
|
|
#include <osmocom/core/timer.h>
|
|
|
|
#include <osmocom/core/utils.h>
|
|
|
|
|
|
|
|
/*! \defgroup fsm Finite State Machine abstraction
|
|
|
|
* @{
|
2017-06-20 02:35:06 +00:00
|
|
|
* \file fsm.h */
|
2016-05-29 01:53:17 +00:00
|
|
|
|
|
|
|
struct osmo_fsm_inst;
|
|
|
|
|
|
|
|
enum osmo_fsm_term_cause {
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! terminate because parent terminated */
|
2016-05-29 01:53:17 +00:00
|
|
|
OSMO_FSM_TERM_PARENT,
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! terminate on explicit user request */
|
2016-05-29 01:53:17 +00:00
|
|
|
OSMO_FSM_TERM_REQUEST,
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! regular termination of process */
|
2016-05-29 01:53:17 +00:00
|
|
|
OSMO_FSM_TERM_REGULAR,
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! erroneous termination of process */
|
2016-05-29 01:53:17 +00:00
|
|
|
OSMO_FSM_TERM_ERROR,
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! termination due to time-out */
|
2016-06-18 08:36:25 +00:00
|
|
|
OSMO_FSM_TERM_TIMEOUT,
|
2016-05-29 01:53:17 +00:00
|
|
|
};
|
|
|
|
|
2016-12-14 17:35:47 +00:00
|
|
|
extern const struct value_string osmo_fsm_term_cause_names[];
|
|
|
|
static inline const char *osmo_fsm_term_cause_name(enum osmo_fsm_term_cause cause)
|
|
|
|
{
|
|
|
|
return get_value_string(osmo_fsm_term_cause_names, cause);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! description of a rule in the FSM */
|
2016-05-29 01:53:17 +00:00
|
|
|
struct osmo_fsm_state {
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! bit-mask of permitted input events for this state */
|
2016-05-29 01:53:17 +00:00
|
|
|
uint32_t in_event_mask;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! bit-mask to which other states this state may transiton */
|
2016-05-29 01:53:17 +00:00
|
|
|
uint32_t out_state_mask;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! human-readable name of this state */
|
2016-05-29 01:53:17 +00:00
|
|
|
const char *name;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! function to be called for events arriving in this state */
|
2016-05-29 01:53:17 +00:00
|
|
|
void (*action)(struct osmo_fsm_inst *fi, uint32_t event, void *data);
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! function to be called just after entering the state */
|
2016-05-29 01:53:17 +00:00
|
|
|
void (*onenter)(struct osmo_fsm_inst *fi, uint32_t prev_state);
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! function to be called just before leaving the state */
|
2016-05-29 01:53:17 +00:00
|
|
|
void (*onleave)(struct osmo_fsm_inst *fi, uint32_t next_state);
|
|
|
|
};
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! a description of an osmocom finite state machine */
|
2016-05-29 01:53:17 +00:00
|
|
|
struct osmo_fsm {
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! global list */
|
2016-05-29 01:53:17 +00:00
|
|
|
struct llist_head list;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! list of instances of this FSM */
|
2016-05-29 01:53:17 +00:00
|
|
|
struct llist_head instances;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! human readable name */
|
2016-05-29 01:53:17 +00:00
|
|
|
const char *name;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! table of state transition rules */
|
2016-05-29 01:53:17 +00:00
|
|
|
const struct osmo_fsm_state *states;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! number of entries in \ref states */
|
2016-05-29 01:53:17 +00:00
|
|
|
unsigned int num_states;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! bit-mask of events permitted in all states */
|
2016-05-29 01:53:17 +00:00
|
|
|
uint32_t allstate_event_mask;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! function pointer to be called for allstate events */
|
2016-05-29 01:53:17 +00:00
|
|
|
void (*allstate_action)(struct osmo_fsm_inst *fi, uint32_t event, void *data);
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! clean-up function, called during termination */
|
2016-05-29 01:53:17 +00:00
|
|
|
void (*cleanup)(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause);
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! timer call-back for states with time-out.
|
2016-12-09 15:10:34 +00:00
|
|
|
* \returns 1 to request termination, 0 to keep running. */
|
2016-06-18 08:36:25 +00:00
|
|
|
int (*timer_cb)(struct osmo_fsm_inst *fi);
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! logging sub-system for this FSM */
|
2016-05-29 01:53:17 +00:00
|
|
|
int log_subsys;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! human-readable names of events */
|
2016-05-29 01:53:17 +00:00
|
|
|
const struct value_string *event_names;
|
|
|
|
};
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! a single instanceof an osmocom finite state machine */
|
2016-05-29 01:53:17 +00:00
|
|
|
struct osmo_fsm_inst {
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! member in the fsm->instances list */
|
2016-05-29 01:53:17 +00:00
|
|
|
struct llist_head list;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! back-pointer to the FSM of which we are an instance */
|
2016-05-29 01:53:17 +00:00
|
|
|
struct osmo_fsm *fsm;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! human readable identifier */
|
2016-05-29 01:53:17 +00:00
|
|
|
const char *id;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! human readable fully-qualified name */
|
2016-05-29 01:53:17 +00:00
|
|
|
const char *name;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! some private data of this instance */
|
2016-05-29 01:53:17 +00:00
|
|
|
void *priv;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! logging level for this FSM */
|
2016-05-29 01:53:17 +00:00
|
|
|
int log_level;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! current state of the FSM */
|
2016-05-29 01:53:17 +00:00
|
|
|
uint32_t state;
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! timer number for states with time-out */
|
2016-05-29 01:53:17 +00:00
|
|
|
int T;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! timer back-end for states with time-out */
|
2016-05-29 01:53:17 +00:00
|
|
|
struct osmo_timer_list timer;
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! support for fsm-based procedures */
|
2016-05-29 01:53:17 +00:00
|
|
|
struct {
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! the parent FSM that has created us */
|
2016-05-29 01:53:17 +00:00
|
|
|
struct osmo_fsm_inst *parent;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! the event we should send upon termination */
|
2016-05-29 01:53:17 +00:00
|
|
|
uint32_t parent_term_event;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! a list of children processes */
|
2016-05-29 01:53:17 +00:00
|
|
|
struct llist_head children;
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! \ref llist_head linked to parent->proc.children */
|
2016-05-29 01:53:17 +00:00
|
|
|
struct llist_head child;
|
|
|
|
} proc;
|
|
|
|
};
|
|
|
|
|
|
|
|
void osmo_fsm_log_addr(bool log_addr);
|
|
|
|
|
2016-12-14 16:37:34 +00:00
|
|
|
#define LOGPFSML(fi, level, fmt, args...) \
|
|
|
|
LOGP((fi)->fsm->log_subsys, level, "%s{%s}: " fmt, \
|
2016-05-29 01:53:17 +00:00
|
|
|
osmo_fsm_inst_name(fi), \
|
|
|
|
osmo_fsm_state_name((fi)->fsm, (fi)->state), ## args)
|
|
|
|
|
2016-12-14 16:37:34 +00:00
|
|
|
#define LOGPFSM(fi, fmt, args...) \
|
|
|
|
LOGPFSML(fi, (fi)->log_level, fmt, ## args)
|
|
|
|
|
2016-12-23 00:00:13 +00:00
|
|
|
#define LOGPFSMLSRC(fi, level, caller_file, caller_line, fmt, args...) \
|
|
|
|
LOGPSRC((fi)->fsm->log_subsys, level, \
|
|
|
|
caller_file, caller_line, \
|
|
|
|
"%s{%s}: " fmt, \
|
|
|
|
osmo_fsm_inst_name(fi), \
|
|
|
|
osmo_fsm_state_name((fi)->fsm, (fi)->state), \
|
|
|
|
## args)
|
|
|
|
|
|
|
|
#define LOGPFSMSRC(fi, caller_file, caller_line, fmt, args...) \
|
|
|
|
LOGPFSMLSRC(fi, (fi)->log_level, \
|
|
|
|
caller_file, caller_line, \
|
|
|
|
fmt, ## args)
|
|
|
|
|
2016-05-29 01:53:17 +00:00
|
|
|
int osmo_fsm_register(struct osmo_fsm *fsm);
|
2016-11-01 10:02:17 +00:00
|
|
|
void osmo_fsm_unregister(struct osmo_fsm *fsm);
|
2017-01-07 10:11:03 +00:00
|
|
|
struct osmo_fsm *osmo_fsm_find_by_name(const char *name);
|
2017-04-16 15:23:56 +00:00
|
|
|
struct osmo_fsm_inst *osmo_fsm_inst_find_by_name(const struct osmo_fsm *fsm,
|
|
|
|
const char *name);
|
|
|
|
struct osmo_fsm_inst *osmo_fsm_inst_find_by_id(const struct osmo_fsm *fsm,
|
|
|
|
const char *id);
|
2016-05-29 01:53:17 +00:00
|
|
|
struct osmo_fsm_inst *osmo_fsm_inst_alloc(struct osmo_fsm *fsm, void *ctx, void *priv,
|
|
|
|
int log_level, const char *id);
|
|
|
|
struct osmo_fsm_inst *osmo_fsm_inst_alloc_child(struct osmo_fsm *fsm,
|
|
|
|
struct osmo_fsm_inst *parent,
|
|
|
|
uint32_t parent_term_event);
|
2018-01-16 17:45:56 +00:00
|
|
|
void osmo_fsm_inst_unlink_parent(struct osmo_fsm_inst *fi, void *ctx);
|
|
|
|
void osmo_fsm_inst_change_parent(struct osmo_fsm_inst *fi,
|
|
|
|
struct osmo_fsm_inst *new_parent,
|
|
|
|
uint32_t new_parent_term_event);
|
2016-05-29 01:53:17 +00:00
|
|
|
void osmo_fsm_inst_free(struct osmo_fsm_inst *fi);
|
|
|
|
|
|
|
|
const char *osmo_fsm_event_name(struct osmo_fsm *fsm, uint32_t event);
|
|
|
|
const char *osmo_fsm_inst_name(struct osmo_fsm_inst *fi);
|
|
|
|
const char *osmo_fsm_state_name(struct osmo_fsm *fsm, uint32_t state);
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! return the name of the state the FSM instance is currently in. */
|
2017-02-28 02:38:38 +00:00
|
|
|
static inline const char *osmo_fsm_inst_state_name(struct osmo_fsm_inst *fi)
|
|
|
|
{ return osmo_fsm_state_name(fi->fsm, fi->state); }
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! perform a state change of the given FSM instance
|
fsm: log caller's source for events and state changes, not fsm.c lines
When looking at log output, it is not interesting to see that a state
transition's petty details are implemented in fsm.c. Rather log the *caller's*
source file and line that caused an event, state change and cascading events.
To that end, introduce LOGPSRC() absorbing the guts of LOGP(), to be able to
explicitly pass the source file and line information.
Prepend an underscore to the function names of osmo_fsm_inst_state_chg(),
osmo_fsm_inst_dispatch() and osmo_fsm_inst_term(), and add file and line
arguments to them. Provide the previous names as macros that insert the
caller's __BASE_FILE__ and __LINE__ constants for the new arguments. Hence no
calling code needs to be changed.
In fsm.c, add LOGPFSMSRC to call LOGPSRC, and add LOGPFSMLSRC, and use them in
above _osmo_fsm_inst_* functions.
In addition, in _osmo_fsm_inst_term(), pass the caller's source file and line
on to nested event dispatches, so showing where a cascade originated from.
Change-Id: Iae72aba7bbf99e19dd584ccabea5867210650dcd
2016-12-14 16:24:54 +00:00
|
|
|
*
|
|
|
|
* This is a macro that calls _osmo_fsm_inst_state_chg() 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_state_chg(fi, new_state, timeout_secs, T) \
|
|
|
|
_osmo_fsm_inst_state_chg(fi, new_state, timeout_secs, T, \
|
|
|
|
__BASE_FILE__, __LINE__)
|
|
|
|
int _osmo_fsm_inst_state_chg(struct osmo_fsm_inst *fi, uint32_t new_state,
|
|
|
|
unsigned long timeout_secs, int T,
|
|
|
|
const char *file, int line);
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! dispatch an event to an osmocom finite state machine instance
|
fsm: log caller's source for events and state changes, not fsm.c lines
When looking at log output, it is not interesting to see that a state
transition's petty details are implemented in fsm.c. Rather log the *caller's*
source file and line that caused an event, state change and cascading events.
To that end, introduce LOGPSRC() absorbing the guts of LOGP(), to be able to
explicitly pass the source file and line information.
Prepend an underscore to the function names of osmo_fsm_inst_state_chg(),
osmo_fsm_inst_dispatch() and osmo_fsm_inst_term(), and add file and line
arguments to them. Provide the previous names as macros that insert the
caller's __BASE_FILE__ and __LINE__ constants for the new arguments. Hence no
calling code needs to be changed.
In fsm.c, add LOGPFSMSRC to call LOGPSRC, and add LOGPFSMLSRC, and use them in
above _osmo_fsm_inst_* functions.
In addition, in _osmo_fsm_inst_term(), pass the caller's source file and line
on to nested event dispatches, so showing where a cascade originated from.
Change-Id: Iae72aba7bbf99e19dd584ccabea5867210650dcd
2016-12-14 16:24:54 +00:00
|
|
|
*
|
|
|
|
* This is a macro that calls _osmo_fsm_inst_dispatch() 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_dispatch(fi, event, data) \
|
|
|
|
_osmo_fsm_inst_dispatch(fi, event, data, __BASE_FILE__, __LINE__)
|
|
|
|
int _osmo_fsm_inst_dispatch(struct osmo_fsm_inst *fi, uint32_t event, void *data,
|
|
|
|
const char *file, int line);
|
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Terminate FSM instance with given cause
|
fsm: log caller's source for events and state changes, not fsm.c lines
When looking at log output, it is not interesting to see that a state
transition's petty details are implemented in fsm.c. Rather log the *caller's*
source file and line that caused an event, state change and cascading events.
To that end, introduce LOGPSRC() absorbing the guts of LOGP(), to be able to
explicitly pass the source file and line information.
Prepend an underscore to the function names of osmo_fsm_inst_state_chg(),
osmo_fsm_inst_dispatch() and osmo_fsm_inst_term(), and add file and line
arguments to them. Provide the previous names as macros that insert the
caller's __BASE_FILE__ and __LINE__ constants for the new arguments. Hence no
calling code needs to be changed.
In fsm.c, add LOGPFSMSRC to call LOGPSRC, and add LOGPFSMLSRC, and use them in
above _osmo_fsm_inst_* functions.
In addition, in _osmo_fsm_inst_term(), pass the caller's source file and line
on to nested event dispatches, so showing where a cascade originated from.
Change-Id: Iae72aba7bbf99e19dd584ccabea5867210650dcd
2016-12-14 16:24:54 +00:00
|
|
|
*
|
|
|
|
* This is a macro that calls _osmo_fsm_inst_term() 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_term(fi, cause, data) \
|
|
|
|
_osmo_fsm_inst_term(fi, cause, data, __BASE_FILE__, __LINE__)
|
|
|
|
void _osmo_fsm_inst_term(struct osmo_fsm_inst *fi,
|
|
|
|
enum osmo_fsm_term_cause cause, void *data,
|
|
|
|
const char *file, int line);
|
2016-05-29 01:53:17 +00:00
|
|
|
|
2017-06-19 22:17:59 +00:00
|
|
|
/*! Terminate all child FSM instances of an FSM instance.
|
fsm: factor out osmo_fsm_inst_term_children() from osmo_fsm_inst_term()
osmo_fsm_inst_term() has code for safe child removal, publish that part as
osmo_fsm_inst_term_children(); also use from osmo_fsm_inst_term().
As with osmo_fsm_inst_term(), add osmo_fsm_inst_term_children() macro to pass
the caller's source file and line to new _osmo_fsm_inst_term_children().
Rationale: in openbsc's VLR, I want to discard child FSMs when certain events
are handled. I could keep a pointer to each one, or simply iterate all
children, making the code a lot simpler in some places.
(Unfortunately, the patch may be displayed subobtimally. This really only moves
the children-loop to a new function, replaces it with a call to
_osmo_fsm_inst_term_children(fi, OSMO_FSM_TERM_PARENT, NULL, file, line) and
drops two local iterator variables. No other code changes are made, even though
the diff may show large removal + addition chunks)
Change-Id: I8dac1206259cbd251660f793ad023aaa1dc705a2
2016-12-23 03:26:39 +00:00
|
|
|
*
|
|
|
|
* This is a macro that calls _osmo_fsm_inst_term_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_term_children(fi, cause, data) \
|
|
|
|
_osmo_fsm_inst_term_children(fi, cause, data, __BASE_FILE__, __LINE__)
|
|
|
|
void _osmo_fsm_inst_term_children(struct osmo_fsm_inst *fi,
|
|
|
|
enum osmo_fsm_term_cause cause,
|
|
|
|
void *data,
|
|
|
|
const char *file, int line);
|
|
|
|
|
2016-05-29 01:53:17 +00:00
|
|
|
/*! @} */
|