mirror of https://github.com/pvnis/srsRAN_4G.git
implement fsm based on choice type
Francisco Paisana
5 years ago
committed by
Francisco Paisana
parent
018f9e7db2
commit
6675e92806
@ -0,0 +1,239 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2013-2020 Software Radio Systems Limited
|
||||||
|
*
|
||||||
|
* This file is part of srsLTE.
|
||||||
|
*
|
||||||
|
* srsLTE is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of
|
||||||
|
* the License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* srsLTE is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* A copy of the GNU Affero General Public License can be found in
|
||||||
|
* the LICENSE file in the top-level directory of this distribution
|
||||||
|
* and at http://www.gnu.org/licenses/.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#ifndef SRSLTE_FSM_H
|
||||||
|
#define SRSLTE_FSM_H
|
||||||
|
|
||||||
|
#include "choice_type.h"
|
||||||
|
#include <cassert>
|
||||||
|
#include <cstdio>
|
||||||
|
#include <cstring>
|
||||||
|
#include <limits>
|
||||||
|
#include <memory>
|
||||||
|
#include <tuple>
|
||||||
|
|
||||||
|
namespace srslte {
|
||||||
|
|
||||||
|
// using same_state = mpark::monostate;
|
||||||
|
struct same_state {
|
||||||
|
};
|
||||||
|
template <typename... Args>
|
||||||
|
using state_list = choice_t<Args...>;
|
||||||
|
|
||||||
|
namespace fsm_details {
|
||||||
|
|
||||||
|
//! Visitor to get a state's name string
|
||||||
|
struct state_name_visitor {
|
||||||
|
template <typename State>
|
||||||
|
void operator()(State&& s)
|
||||||
|
{
|
||||||
|
name = s.name();
|
||||||
|
}
|
||||||
|
const char* name = "invalid state";
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename TargetVariant, typename PrevState>
|
||||||
|
struct variant_convert {
|
||||||
|
template <typename State>
|
||||||
|
void operator()(State&& s)
|
||||||
|
{
|
||||||
|
static_assert(not std::is_same<typename std::decay<State>::type, typename std::decay<PrevState>::type>::value,
|
||||||
|
"State cannot transition to itself.\n");
|
||||||
|
*v = s;
|
||||||
|
}
|
||||||
|
TargetVariant* v;
|
||||||
|
PrevState* p;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct fsm_helper {
|
||||||
|
//! Stayed in same state
|
||||||
|
template <typename FSM, typename PrevState>
|
||||||
|
static void handle_state_transition(FSM* f, same_state s, PrevState* p)
|
||||||
|
{
|
||||||
|
// do nothing
|
||||||
|
}
|
||||||
|
//! TargetState is type-erased. Apply its stored type to the fsm current state
|
||||||
|
template <typename FSM, typename... Args, typename PrevState>
|
||||||
|
static void handle_state_transition(FSM* f, choice_t<Args...>& s, PrevState* p)
|
||||||
|
{
|
||||||
|
fsm_details::variant_convert<decltype(f->states), PrevState> visitor{.v = &f->states, .p = p};
|
||||||
|
s.visit(visitor);
|
||||||
|
}
|
||||||
|
//! Simple state transition in FSM
|
||||||
|
template <typename FSM, typename State, typename PrevState>
|
||||||
|
static auto handle_state_transition(FSM* f, State& s, PrevState* p) -> decltype(f->states = s, void())
|
||||||
|
{
|
||||||
|
static_assert(not std::is_same<State, PrevState>::value, "State cannot transition to itself.\n");
|
||||||
|
f->states = s;
|
||||||
|
}
|
||||||
|
//! State not present in current FSM. Attempt state transition in parent FSM in the case of NestedFSM
|
||||||
|
template <typename FSM, typename... Args>
|
||||||
|
static void handle_state_transition(FSM* f, Args&&... args)
|
||||||
|
{
|
||||||
|
static_assert(FSM::is_nested, "State is not present in the FSM list of valid states");
|
||||||
|
handle_state_transition(f->parent_fsm()->derived(), args...);
|
||||||
|
}
|
||||||
|
|
||||||
|
//! Trigger Event, that will result in a state transition
|
||||||
|
template <typename FSM, typename Event>
|
||||||
|
struct trigger_visitor {
|
||||||
|
trigger_visitor(FSM* f_, Event&& ev_) : f(f_), ev(std::forward<Event>(ev_)) {}
|
||||||
|
|
||||||
|
template <typename State>
|
||||||
|
void operator()(State& s)
|
||||||
|
{
|
||||||
|
call_trigger(s);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename State>
|
||||||
|
using NextState = decltype(std::declval<FSM>().react(std::declval<State&>(), std::declval<Event>()));
|
||||||
|
|
||||||
|
template <typename State>
|
||||||
|
auto call_trigger(State& s) -> NextState<State>
|
||||||
|
{
|
||||||
|
using next_state = NextState<State>;
|
||||||
|
static_assert(not std::is_same<next_state, State>::value, "State cannot transition to itself.\n");
|
||||||
|
auto target_state = f->react(s, std::move(ev));
|
||||||
|
fsm_helper::handle_state_transition(f, target_state, &s);
|
||||||
|
return target_state;
|
||||||
|
}
|
||||||
|
template <typename State>
|
||||||
|
auto call_trigger(State& s) -> decltype(std::declval<State>().trigger(std::declval<Event>()))
|
||||||
|
{
|
||||||
|
s.trigger(std::move(ev));
|
||||||
|
}
|
||||||
|
same_state call_trigger(...)
|
||||||
|
{
|
||||||
|
// do nothing if no react was found
|
||||||
|
return same_state{};
|
||||||
|
}
|
||||||
|
|
||||||
|
FSM* f;
|
||||||
|
Event ev;
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace fsm_details
|
||||||
|
|
||||||
|
//! Base class for states and FSMs
|
||||||
|
class state_t
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
state_t() = default;
|
||||||
|
// // forbid copies, allow move
|
||||||
|
// state_t(const state_t&) = delete;
|
||||||
|
// state_t(state_t&&) noexcept = default;
|
||||||
|
// state_t& operator=(const state_t&) = delete;
|
||||||
|
// state_t& operator=(state_t&&) noexcept = default;
|
||||||
|
|
||||||
|
virtual const char* name() const = 0;
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename Derived>
|
||||||
|
class fsm_t
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
// get access to derived protected members from the base
|
||||||
|
class derived_view : public Derived
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
using Derived::react;
|
||||||
|
using Derived::states;
|
||||||
|
};
|
||||||
|
|
||||||
|
static const bool is_nested = false;
|
||||||
|
|
||||||
|
virtual const char* name() const = 0;
|
||||||
|
|
||||||
|
// Push Events to FSM
|
||||||
|
template <typename Ev>
|
||||||
|
void trigger(Ev&& e)
|
||||||
|
{
|
||||||
|
fwd_trigger(std::forward<Ev>(e));
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename State>
|
||||||
|
bool is_in_state() const
|
||||||
|
{
|
||||||
|
return derived()->states.template is<State>();
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename State>
|
||||||
|
const State* get_state() const
|
||||||
|
{
|
||||||
|
return srslte::get_if<State>(derived()->states);
|
||||||
|
}
|
||||||
|
|
||||||
|
const char* get_state_name() const
|
||||||
|
{
|
||||||
|
fsm_details::state_name_visitor visitor{};
|
||||||
|
derived()->states.visit(visitor);
|
||||||
|
return visitor.name;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected:
|
||||||
|
friend struct fsm_details::fsm_helper;
|
||||||
|
|
||||||
|
// Forward an event to FSM states and handle transition return
|
||||||
|
template <typename Ev>
|
||||||
|
void fwd_trigger(Ev&& e)
|
||||||
|
{
|
||||||
|
fsm_details::fsm_helper::trigger_visitor<derived_view, Ev> visitor{derived(), std::forward<Ev>(e)};
|
||||||
|
derived()->states.visit(visitor);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename State>
|
||||||
|
void change_state(State& s)
|
||||||
|
{
|
||||||
|
derived()->states = std::move(s);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Access to CRTP derived class
|
||||||
|
derived_view* derived() { return static_cast<derived_view*>(this); }
|
||||||
|
const derived_view* derived() const { return static_cast<const derived_view*>(this); }
|
||||||
|
};
|
||||||
|
|
||||||
|
template <typename Derived, typename ParentFSM>
|
||||||
|
class nested_fsm_t : public fsm_t<Derived>
|
||||||
|
{
|
||||||
|
using base_t = fsm_t<Derived>;
|
||||||
|
using parent_t = ParentFSM;
|
||||||
|
using parent_view = typename parent_t::derived_view;
|
||||||
|
|
||||||
|
public:
|
||||||
|
static const bool is_nested = true;
|
||||||
|
|
||||||
|
explicit nested_fsm_t(ParentFSM* parent_fsm_) : fsm_ptr(parent_fsm_) {}
|
||||||
|
|
||||||
|
// Get pointer to outer FSM in case of HSM
|
||||||
|
const parent_t* parent_fsm() const { return fsm_ptr; }
|
||||||
|
parent_t* parent_fsm() { return fsm_ptr; }
|
||||||
|
|
||||||
|
protected:
|
||||||
|
friend struct fsm_details::fsm_helper;
|
||||||
|
using parent_fsm_t = ParentFSM;
|
||||||
|
|
||||||
|
ParentFSM* fsm_ptr = nullptr;
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace srslte
|
||||||
|
|
||||||
|
#endif // SRSLTE_FSM_H
|
||||||
@ -0,0 +1,183 @@
|
|||||||
|
/*
|
||||||
|
* Copyright 2013-2020 Software Radio Systems Limited
|
||||||
|
*
|
||||||
|
* This file is part of srsLTE.
|
||||||
|
*
|
||||||
|
* srsLTE is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU Affero General Public License as
|
||||||
|
* published by the Free Software Foundation, either version 3 of
|
||||||
|
* the License, or (at your option) any later version.
|
||||||
|
*
|
||||||
|
* srsLTE is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU Affero General Public License for more details.
|
||||||
|
*
|
||||||
|
* A copy of the GNU Affero General Public License can be found in
|
||||||
|
* the LICENSE file in the top-level directory of this distribution
|
||||||
|
* and at http://www.gnu.org/licenses/.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
|
#include "srslte/common/fsm.h"
|
||||||
|
#include "srslte/common/test_common.h"
|
||||||
|
|
||||||
|
srslte::log_ref test_log{"TEST"};
|
||||||
|
|
||||||
|
/////////////////////////////
|
||||||
|
|
||||||
|
// Events
|
||||||
|
struct ev1 {
|
||||||
|
};
|
||||||
|
struct ev2 {
|
||||||
|
};
|
||||||
|
|
||||||
|
class fsm1 : public srslte::fsm_t<fsm1>
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
uint32_t idle_enter_counter = 0, state1_enter_counter = 0;
|
||||||
|
uint32_t foo_counter = 0;
|
||||||
|
|
||||||
|
fsm1() : states(idle_st{this}) {}
|
||||||
|
|
||||||
|
const char* name() const override { return "fsm1"; }
|
||||||
|
|
||||||
|
// idle state
|
||||||
|
struct idle_st : srslte::state_t {
|
||||||
|
idle_st(fsm1* f)
|
||||||
|
{
|
||||||
|
test_log->info("fsm1::%s::enter called\n", name());
|
||||||
|
f->idle_enter_counter++;
|
||||||
|
}
|
||||||
|
~idle_st() { test_log->info("fsm1::%s::exit called\n", name()); }
|
||||||
|
const char* name() const final { return "idle"; }
|
||||||
|
};
|
||||||
|
|
||||||
|
// simple state
|
||||||
|
class state1 : public srslte::state_t
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
state1(fsm1* f)
|
||||||
|
{
|
||||||
|
test_log->info("fsm1::%s::enter called\n", name());
|
||||||
|
f->state1_enter_counter++;
|
||||||
|
}
|
||||||
|
const char* name() const final { return "state1"; }
|
||||||
|
};
|
||||||
|
|
||||||
|
// this state is another FSM
|
||||||
|
class fsm2 : public srslte::nested_fsm_t<fsm2, fsm1>
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
struct state_inner : public srslte::state_t {
|
||||||
|
const char* name() const final { return "state_inner"; }
|
||||||
|
state_inner() { test_log->info("fsm2::%s::enter called\n", name()); }
|
||||||
|
~state_inner() { test_log->info("fsm2::%s::exit called\n", name()); }
|
||||||
|
};
|
||||||
|
|
||||||
|
fsm2(fsm1* f_) : nested_fsm_t(f_) { test_log->info("%s::enter called\n", name()); }
|
||||||
|
~fsm2() { test_log->info("%s::exit called\n", name()); }
|
||||||
|
const char* name() const final { return "fsm2"; }
|
||||||
|
|
||||||
|
protected:
|
||||||
|
// FSM2 transitions
|
||||||
|
auto react(state_inner& s, ev1 e) -> srslte::same_state;
|
||||||
|
auto react(state_inner& s, ev2 e) -> state1;
|
||||||
|
|
||||||
|
// list of states
|
||||||
|
srslte::state_list<state_inner> states;
|
||||||
|
};
|
||||||
|
|
||||||
|
protected:
|
||||||
|
// transitions
|
||||||
|
auto react(idle_st& s, ev1 e) -> state1;
|
||||||
|
auto react(state1& s, ev1 e) -> fsm2;
|
||||||
|
auto react(state1& s, ev2 e) -> srslte::state_list<idle_st, fsm2>;
|
||||||
|
|
||||||
|
void foo(ev1 e) { foo_counter++; }
|
||||||
|
|
||||||
|
// list of states
|
||||||
|
srslte::state_list<idle_st, state1, fsm2> states{idle_st{this}};
|
||||||
|
};
|
||||||
|
|
||||||
|
// FSM event handlers
|
||||||
|
auto fsm1::fsm2::react(state_inner& s, ev1 e) -> srslte::same_state
|
||||||
|
{
|
||||||
|
test_log->info("fsm2::state_inner::react called\n");
|
||||||
|
return {};
|
||||||
|
}
|
||||||
|
|
||||||
|
auto fsm1::fsm2::react(state_inner& s, ev2 e) -> state1
|
||||||
|
{
|
||||||
|
test_log->info("fsm2::state_inner::react called\n");
|
||||||
|
return state1{parent_fsm()};
|
||||||
|
}
|
||||||
|
|
||||||
|
auto fsm1::react(idle_st& s, ev1 e) -> state1
|
||||||
|
{
|
||||||
|
test_log->info("fsm1::%s::react called\n", s.name());
|
||||||
|
foo(e);
|
||||||
|
return state1{this};
|
||||||
|
}
|
||||||
|
auto fsm1::react(state1& s, ev1 e) -> fsm2
|
||||||
|
{
|
||||||
|
test_log->info("fsm1::%s::react called\n", s.name());
|
||||||
|
return fsm2{this};
|
||||||
|
}
|
||||||
|
auto fsm1::react(state1& s, ev2 e) -> srslte::state_list<idle_st, fsm2>
|
||||||
|
{
|
||||||
|
test_log->info("fsm1::%s::react called\n", s.name());
|
||||||
|
return idle_st{this};
|
||||||
|
}
|
||||||
|
|
||||||
|
int test_hsm()
|
||||||
|
{
|
||||||
|
test_log->set_level(srslte::LOG_LEVEL_INFO);
|
||||||
|
|
||||||
|
fsm1 f;
|
||||||
|
TESTASSERT(std::string{f.name()} == "fsm1");
|
||||||
|
TESTASSERT(std::string{f.get_state_name()} == "idle");
|
||||||
|
TESTASSERT(f.is_in_state<fsm1::idle_st>());
|
||||||
|
TESTASSERT(f.foo_counter == 0);
|
||||||
|
TESTASSERT(f.idle_enter_counter == 1);
|
||||||
|
|
||||||
|
// Moving Idle -> State1
|
||||||
|
ev1 e;
|
||||||
|
f.trigger(e);
|
||||||
|
TESTASSERT(std::string{f.get_state_name()} == "state1");
|
||||||
|
TESTASSERT(f.is_in_state<fsm1::state1>());
|
||||||
|
|
||||||
|
// Moving State1 -> fsm2
|
||||||
|
f.trigger(e);
|
||||||
|
TESTASSERT(std::string{f.get_state_name()} == "fsm2");
|
||||||
|
TESTASSERT(f.is_in_state<fsm1::fsm2>());
|
||||||
|
TESTASSERT(std::string{f.get_state<fsm1::fsm2>()->get_state_name()} == "state_inner");
|
||||||
|
|
||||||
|
// Fsm2 does not listen to ev1
|
||||||
|
f.trigger(e);
|
||||||
|
TESTASSERT(std::string{f.get_state_name()} == "fsm2");
|
||||||
|
TESTASSERT(f.is_in_state<fsm1::fsm2>());
|
||||||
|
TESTASSERT(std::string{f.get_state<fsm1::fsm2>()->get_state_name()} == "state_inner");
|
||||||
|
|
||||||
|
// Moving fsm2 -> state1
|
||||||
|
f.trigger(ev2{});
|
||||||
|
TESTASSERT(std::string{f.get_state_name()} == "state1");
|
||||||
|
TESTASSERT(f.is_in_state<fsm1::state1>());
|
||||||
|
TESTASSERT(f.state1_enter_counter == 2);
|
||||||
|
|
||||||
|
// Moving state1 -> idle
|
||||||
|
f.trigger(ev2{});
|
||||||
|
TESTASSERT(std::string{f.get_state_name()} == "idle");
|
||||||
|
TESTASSERT(f.is_in_state<fsm1::idle_st>());
|
||||||
|
TESTASSERT(f.foo_counter == 1);
|
||||||
|
TESTASSERT(f.idle_enter_counter == 2);
|
||||||
|
|
||||||
|
return SRSLTE_SUCCESS;
|
||||||
|
}
|
||||||
|
|
||||||
|
int main()
|
||||||
|
{
|
||||||
|
TESTASSERT(test_hsm() == SRSLTE_SUCCESS);
|
||||||
|
|
||||||
|
return SRSLTE_SUCCESS;
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue