Files
secs-gem/include/secsgem/gem/runtime.hpp
T
raphael 8a48ffeed4 feat(gem): multi-observer state-change handlers via HandlerSlot
The single-slot set_*_handler pattern was a structural blocker, hit twice:
the daemon could not observe control-state changes because
register_default_handlers owns the slot, forcing GetControlState to read the
FSM cross-thread (a data race), and blocking WatchHealth and the Subscribe
stream's ControlStateChange variant.

HandlerSlot<Args...> keeps a primary slot with exact legacy semantics
(set_ replaces — one existing test depends on replacement) plus an
append-only observer list (add_) that survives set_ calls. Fire sites are
textually unchanged (operator bool / operator() / assign-from-function).

Applied to ControlStateMachine + ProcessJobStore + ControlJobStore (the
roadmap-critical three; the remaining single-slot classes follow the same
3-line pattern as needed). EquipmentRuntime gains an atomic control-state
mirror registered as an observer — control_state() is now safe from any
thread, retiring the GetControlState race — plus add_control_state_observer
and add_link_observer (selected/closed fan-out), the hooks WatchHealth and
Subscribe need.

Tests: observer ordering, set-replaces-primary-but-observers-survive,
observers-without-primary, PJ-store coexistence, and the runtime scenario
that was previously impossible (mirror + observer + default-handlers set_).
Core 464/464 (2816 assertions), daemon 16/16, live GEM300 demo passes with
single-fire control-state transitions.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-10 18:57:53 +02:00

127 lines
5.3 KiB
C++

#pragma once
#include <asio.hpp>
#include <atomic>
#include <cstdint>
#include <functional>
#include <memory>
#include <optional>
#include <string>
#include <thread>
#include <utility>
#include <vector>
#include "secsgem/config/loader.hpp"
#include "secsgem/endpoint.hpp"
#include "secsgem/gem/control_state.hpp"
#include "secsgem/gem/data_model.hpp"
#include "secsgem/gem/router.hpp"
#include "secsgem/gem/store/host_commands.hpp"
#include "secsgem/secs2/item.hpp"
#include "secsgem/secs2/message.hpp"
namespace secsgem::gem {
// Owns the SECS/GEM engine — io_context, the passive HSMS Server, the data
// model, the E30 control-state machine, and the Router — as one reusable
// object. It is the foundation both the demo `secs_server` app and the gRPC
// daemon build on, replacing a hand-wired main() with a class.
//
// Threading contract (unchanged from the engine's existing design): a single
// io_context thread owns the model and the connection. The outbound methods
// (set_variable / emit_event / set_alarm / clear_alarm) are safe to call from
// any thread — each posts onto the io_context, exactly like the established
// emit_* pattern. Router handlers and the command hook run on the io thread.
class EquipmentRuntime {
public:
struct Config {
std::string equipment_yaml;
std::string control_state_yaml;
std::string process_job_yaml;
std::string control_job_yaml;
uint16_t port = 5000;
std::string spool_dir; // empty = no persistence
std::function<void(const std::string&)> log; // empty = silent
};
explicit EquipmentRuntime(const Config& cfg);
~EquipmentRuntime();
EquipmentRuntime(const EquipmentRuntime&) = delete;
EquipmentRuntime& operator=(const EquipmentRuntime&) = delete;
// ---- access --------------------------------------------------------------
EquipmentDataModel& model() { return *model_; }
const EquipmentDataModel& model() const { return *model_; }
Router& router() { return router_; }
ControlStateMachine& control() { return *sm_; }
asio::io_context& io() { return io_; }
uint16_t device_id() const { return descriptor_.device_id; }
void log(const std::string& m) const { if (log_) log_(m); }
// Shared-pointer / reference accessors used when wiring handlers and
// emitters that capture the engine pieces by value (see register handlers).
std::shared_ptr<EquipmentDataModel> model_ptr() { return model_; }
std::shared_ptr<ControlStateMachine> control_ptr() { return sm_; }
const config::EquipmentDescriptor& descriptor() const { return descriptor_; }
std::shared_ptr<std::weak_ptr<Connection>> active_conn() { return active_conn_; }
// ---- outbound: report state to the host (thread-safe; each posts) --------
void set_variable(uint32_t vid, secs2::Item value);
void emit_event(uint32_t ceid);
void set_alarm(uint32_t alid);
void clear_alarm(uint32_t alid);
// ---- host-command behaviour hook -----------------------------------------
void on_command(std::string rcmd, HostCommandRegistry::Handler h) {
model_->commands.set_handler(std::move(rcmd), std::move(h));
}
// ---- control state -------------------------------------------------------
// Safe from any thread: reads an atomic mirror updated by a state-machine
// observer, so gRPC threads never touch the FSM the io thread owns.
ControlState control_state() const { return control_state_cache_.load(std::memory_order_relaxed); }
// Observe control-state transitions (fires on the io thread). Survives the
// primary set_state_change_handler that register_default_handlers installs.
// Register before run()/run_async().
void add_control_state_observer(ControlStateMachine::StateChangeHandler h) {
sm_->add_state_change_handler(std::move(h));
}
// Observe HSMS link state: fires on the io thread with true when a session
// reaches SELECTED, false when the connection closes. Register before
// run()/run_async(). Foundation for the daemon's WatchHealth stream.
using LinkObserver = std::function<void(bool selected)>;
void add_link_observer(LinkObserver h) { link_observers_.push_back(std::move(h)); }
// Deliver a primary to the host, or spool it if there's no SELECTED session.
// Call on the io thread (e.g. from a router handler or a posted emitter).
// Returns false if dropped (stream not spoolable and no host).
bool deliver_or_spool(secs2::Message msg, const std::string& what);
// ---- lifecycle -----------------------------------------------------------
void run(); // start accepting + run the io_context (blocks)
void run_async(); // run the io_context on a background thread
void poll(); // drain ready handlers without blocking (tests)
void stop();
private:
void wire_connection();
asio::io_context io_;
std::shared_ptr<EquipmentDataModel> model_;
std::function<void(const std::string&)> log_;
std::shared_ptr<std::weak_ptr<Connection>> active_conn_;
std::shared_ptr<ControlStateMachine> sm_;
config::EquipmentDescriptor descriptor_;
std::unique_ptr<Server> server_;
Router router_;
std::atomic<ControlState> control_state_cache_{ControlState::HostOffline};
std::vector<LinkObserver> link_observers_;
std::optional<asio::executor_work_guard<asio::io_context::executor_type>> work_;
std::thread io_thread_;
};
} // namespace secsgem::gem