libosmocore  0.12.1
Osmocom core library
fsm.h
Go to the documentation of this file.
1 
5 #pragma once
6 
7 #include <stdint.h>
8 #include <stdbool.h>
9 
10 #include <osmocom/core/linuxlist.h>
11 #include <osmocom/core/timer.h>
12 #include <osmocom/core/utils.h>
13 
18 struct osmo_fsm_inst;
19 
31 };
32 
33 extern const struct value_string osmo_fsm_term_cause_names[];
34 static inline const char *osmo_fsm_term_cause_name(enum osmo_fsm_term_cause cause)
35 {
37 }
38 
39 
43  uint32_t in_event_mask;
45  uint32_t out_state_mask;
47  const char *name;
49  void (*action)(struct osmo_fsm_inst *fi, uint32_t event, void *data);
51  void (*onenter)(struct osmo_fsm_inst *fi, uint32_t prev_state);
53  void (*onleave)(struct osmo_fsm_inst *fi, uint32_t next_state);
54 };
55 
57 struct osmo_fsm {
59  struct llist_head list;
61  struct llist_head instances;
63  const char *name;
65  const struct osmo_fsm_state *states;
67  unsigned int num_states;
71  void (*allstate_action)(struct osmo_fsm_inst *fi, uint32_t event, void *data);
73  void (*cleanup)(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause);
76  int (*timer_cb)(struct osmo_fsm_inst *fi);
80  const struct value_string *event_names;
82  void (*pre_term)(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause);
83 };
84 
86 struct osmo_fsm_inst {
88  struct llist_head list;
90  struct osmo_fsm *fsm;
92  const char *id;
94  const char *name;
96  void *priv;
98  int log_level;
100  uint32_t state;
101 
103  int T;
105  struct osmo_timer_list timer;
106 
108  struct {
114  struct llist_head children;
116  struct llist_head child;
117  } proc;
118 };
119 
120 void osmo_fsm_log_addr(bool log_addr);
121 
122 #define LOGPFSML(fi, level, fmt, args...) \
123  LOGP((fi)->fsm->log_subsys, OSMO_MAX(level, (fi)->log_level), \
124  "%s{%s}: " fmt, \
125  osmo_fsm_inst_name(fi), \
126  osmo_fsm_state_name((fi)->fsm, (fi)->state), ## args)
127 
128 #define LOGPFSM(fi, fmt, args...) \
129  LOGPFSML(fi, (fi)->log_level, fmt, ## args)
130 
131 #define LOGPFSMLSRC(fi, level, caller_file, caller_line, fmt, args...) \
132  LOGPSRC((fi)->fsm->log_subsys, level, \
133  caller_file, caller_line, \
134  "%s{%s}: " fmt, \
135  osmo_fsm_inst_name(fi), \
136  osmo_fsm_state_name((fi)->fsm, (fi)->state), \
137  ## args)
138 
139 #define LOGPFSMSRC(fi, caller_file, caller_line, fmt, args...) \
140  LOGPFSMLSRC(fi, (fi)->log_level, \
141  caller_file, caller_line, \
142  fmt, ## args)
143 
144 int osmo_fsm_register(struct osmo_fsm *fsm);
145 void osmo_fsm_unregister(struct osmo_fsm *fsm);
146 struct osmo_fsm *osmo_fsm_find_by_name(const char *name);
148  const char *name);
149 struct osmo_fsm_inst *osmo_fsm_inst_find_by_id(const struct osmo_fsm *fsm,
150  const char *id);
151 struct osmo_fsm_inst *osmo_fsm_inst_alloc(struct osmo_fsm *fsm, void *ctx, void *priv,
152  int log_level, const char *id);
154  struct osmo_fsm_inst *parent,
155  uint32_t parent_term_event);
156 void osmo_fsm_inst_unlink_parent(struct osmo_fsm_inst *fi, void *ctx);
158  struct osmo_fsm_inst *new_parent,
159  uint32_t new_parent_term_event);
160 void osmo_fsm_inst_free(struct osmo_fsm_inst *fi);
161 
162 int osmo_fsm_inst_update_id(struct osmo_fsm_inst *fi, const char *id);
163 int osmo_fsm_inst_update_id_f(struct osmo_fsm_inst *fi, const char *fmt, ...);
164 
165 const char *osmo_fsm_event_name(struct osmo_fsm *fsm, uint32_t event);
166 const char *osmo_fsm_inst_name(struct osmo_fsm_inst *fi);
167 const char *osmo_fsm_state_name(struct osmo_fsm *fsm, uint32_t state);
168 
170 static inline const char *osmo_fsm_inst_state_name(struct osmo_fsm_inst *fi)
171 { return osmo_fsm_state_name(fi->fsm, fi->state); }
172 
179 #define osmo_fsm_inst_state_chg(fi, new_state, timeout_secs, T) \
180  _osmo_fsm_inst_state_chg(fi, new_state, timeout_secs, T, \
181  __BASE_FILE__, __LINE__)
182 int _osmo_fsm_inst_state_chg(struct osmo_fsm_inst *fi, uint32_t new_state,
183  unsigned long timeout_secs, int T,
184  const char *file, int line);
185 
195 #define osmo_fsm_inst_state_chg_keep_timer(fi, new_state) \
196  _osmo_fsm_inst_state_chg_keep_timer(fi, new_state, \
197  __BASE_FILE__, __LINE__)
198 int _osmo_fsm_inst_state_chg_keep_timer(struct osmo_fsm_inst *fi, uint32_t new_state,
199  const char *file, int line);
200 
207 #define osmo_fsm_inst_dispatch(fi, event, data) \
208  _osmo_fsm_inst_dispatch(fi, event, data, __BASE_FILE__, __LINE__)
209 int _osmo_fsm_inst_dispatch(struct osmo_fsm_inst *fi, uint32_t event, void *data,
210  const char *file, int line);
211 
218 #define osmo_fsm_inst_term(fi, cause, data) \
219  _osmo_fsm_inst_term(fi, cause, data, __BASE_FILE__, __LINE__)
220 void _osmo_fsm_inst_term(struct osmo_fsm_inst *fi,
221  enum osmo_fsm_term_cause cause, void *data,
222  const char *file, int line);
223 
230 #define osmo_fsm_inst_term_children(fi, cause, data) \
231  _osmo_fsm_inst_term_children(fi, cause, data, __BASE_FILE__, __LINE__)
233  enum osmo_fsm_term_cause cause,
234  void *data,
235  const char *file, int line);
236 
uint32_t state
current state of the FSM
Definition: fsm.h:100
struct osmo_fsm_inst * parent
the parent FSM that has created us
Definition: fsm.h:110
int log_subsys
logging sub-system for this FSM
Definition: fsm.h:78
uint32_t out_state_mask
bit-mask to which other states this state may transiton
Definition: fsm.h:45
const char * name
human-readable name of this state
Definition: fsm.h:47
struct osmo_fsm_inst * osmo_fsm_inst_find_by_name(const struct osmo_fsm *fsm, const char *name)
Definition: fsm.c:117
int _osmo_fsm_inst_dispatch(struct osmo_fsm_inst *fi, uint32_t event, void *data, const char *file, int line)
dispatch an event to an osmocom finite state machine instance
Definition: fsm.c:546
const char * name
human readable fully-qualified name
Definition: fsm.h:94
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)
perform a state change of the given FSM instance
Definition: fsm.c:497
uint32_t allstate_event_mask
bit-mask of events permitted in all states
Definition: fsm.h:69
const char * get_value_string(const struct value_string *vs, uint32_t val)
get human-readable string for given value
Definition: utils.c:55
void osmo_fsm_inst_free(struct osmo_fsm_inst *fi)
delete a given instance of a FSM
Definition: fsm.c:379
void osmo_fsm_log_addr(bool log_addr)
specify if FSM instance addresses should be logged or not
Definition: fsm.c:102
osmo_fsm_term_cause
Definition: fsm.h:20
const struct value_string osmo_fsm_term_cause_names[]
Definition: fsm.c:684
int T
timer number for states with time-out
Definition: fsm.h:103
void osmo_fsm_unregister(struct osmo_fsm *fsm)
unregister a FSM from the core
Definition: fsm.c:177
struct osmo_fsm * fsm
back-pointer to the FSM of which we are an instance
Definition: fsm.h:90
struct osmo_fsm_inst * osmo_fsm_inst_find_by_id(const struct osmo_fsm *fsm, const char *id)
Definition: fsm.c:134
int _osmo_fsm_inst_state_chg_keep_timer(struct osmo_fsm_inst *fi, uint32_t new_state, const char *file, int line)
perform a state change while keeping the current timer running.
Definition: fsm.c:523
static const char * osmo_fsm_inst_state_name(struct osmo_fsm_inst *fi)
return the name of the state the FSM instance is currently in.
Definition: fsm.h:170
void _osmo_fsm_inst_term(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause, void *data, const char *file, int line)
Terminate FSM instance with given cause.
Definition: fsm.c:601
struct osmo_fsm * osmo_fsm_find_by_name(const char *name)
Definition: fsm.c:107
const char * osmo_fsm_event_name(struct osmo_fsm *fsm, uint32_t event)
get human-readable name of FSM event
Definition: fsm.c:392
const char * id
human readable identifier
Definition: fsm.h:92
A mapping between human-readable string and numeric value.
Definition: utils.h:38
uint32_t parent_term_event
the event we should send upon termination
Definition: fsm.h:112
void(* onleave)(struct osmo_fsm_inst *fi, uint32_t next_state)
function to be called just before leaving the state
Definition: fsm.h:53
void _osmo_fsm_inst_term_children(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause, void *data, const char *file, int line)
Terminate all child FSM instances of an FSM instance.
Definition: fsm.c:653
erroneous termination of process
Definition: fsm.h:28
unsigned int num_states
number of entries in states
Definition: fsm.h:67
struct osmo_fsm_inst * osmo_fsm_inst_alloc(struct osmo_fsm *fsm, void *ctx, void *priv, int log_level, const char *id)
allocate a new instance of a specified FSM
Definition: fsm.c:280
Osmocom timer handling routines.
const char * name
human readable name
Definition: fsm.h:63
static const char * osmo_fsm_term_cause_name(enum osmo_fsm_term_cause cause)
Definition: fsm.h:34
void * priv
some private data of this instance
Definition: fsm.h:96
void osmo_fsm_inst_change_parent(struct osmo_fsm_inst *fi, struct osmo_fsm_inst *new_parent, uint32_t new_parent_term_event)
change parent instance of an FSM.
Definition: fsm.c:360
a single instanceof an osmocom finite state machine
Definition: fsm.h:86
int log_level
logging level for this FSM
Definition: fsm.h:98
Simple doubly linked list implementation.
(double) linked list header structure
Definition: linuxlist.h:46
const char * osmo_fsm_inst_name(struct osmo_fsm_inst *fi)
get human-readable name of FSM instance
Definition: fsm.c:406
a description of an osmocom finite state machine
Definition: fsm.h:57
void(* action)(struct osmo_fsm_inst *fi, uint32_t event, void *data)
function to be called for events arriving in this state
Definition: fsm.h:49
description of a rule in the FSM
Definition: fsm.h:41
const struct osmo_fsm_state * states
table of state transition rules
Definition: fsm.h:65
void(* onenter)(struct osmo_fsm_inst *fi, uint32_t prev_state)
function to be called just after entering the state
Definition: fsm.h:51
const struct value_string * event_names
human-readable names of events
Definition: fsm.h:80
void osmo_fsm_inst_unlink_parent(struct osmo_fsm_inst *fi, void *ctx)
unlink child FSM from its parent FSM.
Definition: fsm.c:343
terminate because parent terminated
Definition: fsm.h:22
int osmo_fsm_inst_update_id_f(struct osmo_fsm_inst *fi, const char *fmt,...)
Change id of the FSM instance using a string format.
Definition: fsm.c:244
const char * osmo_fsm_state_name(struct osmo_fsm *fsm, uint32_t state)
get human-readable name of FSM instance
Definition: fsm.c:422
A structure representing a single instance of a timer.
Definition: timer.h:55
int osmo_fsm_register(struct osmo_fsm *fsm)
register a FSM with the core
Definition: fsm.c:154
int osmo_fsm_inst_update_id(struct osmo_fsm_inst *fi, const char *id)
Change id of the FSM instance.
Definition: fsm.c:212
uint32_t in_event_mask
bit-mask of permitted input events for this state
Definition: fsm.h:43
struct osmo_fsm_inst * osmo_fsm_inst_alloc_child(struct osmo_fsm *fsm, struct osmo_fsm_inst *parent, uint32_t parent_term_event)
allocate a new instance of a specified FSM as child of other FSM instance
Definition: fsm.c:315
regular termination of process
Definition: fsm.h:26
termination due to time-out
Definition: fsm.h:30
terminate on explicit user request
Definition: fsm.h:24