b871cd9da2
Move equipment capabilities and the E30 control state machine out of C++
code and into YAML data files; introduce a Router for SECS dispatch;
consolidate small files.
Behavioural changes: none. Demo identical (15 SxFy transactions +
3 equipment-initiated primaries), 67 test cases / 384 assertions still
all green. Structural changes only.
Why
---
The previous server.cpp held the equipment data dictionary (3 SVIDs,
2 ECIDs, 3 CEIDs, 2 alarms, 2 recipes, 4 host commands) as imperative
C++ in a 50-line `populate()` function, and routed inbound messages
through a 150-line if-ladder. Adding a new SVID required a recompile.
Adding a new state transition required editing two switch statements
(`operator_*` and `on_host_request_*`). The control state machine's
behavioural rules were spread across imperative code in two methods.
This is exactly what implementation_plan.md calls out as the wrong
shape: behavioural rules should live in versioned data, and every
runtime/test/analyzer should read from that data rather than re-encode
it. This commit starts that move.
What's new
----------
data/equipment.yaml
Equipment data dictionary. Declarative SVIDs / ECIDs / CEIDs /
alarms / recipes / host commands. Host commands carry their HCACK
ack code plus optional `emit_ceid` and `set_alarm` side-effects.
Adding a new SVID or command is a YAML edit, no recompile.
data/control_state.yaml
The E30 §6.2 control state transition table as data. Each row is
(from, on) -> (to [, then] [, ack]). `then` chains an auto-advance
through the transient AttemptOnline state. The previous
imperative switch is gone.
include/secsgem/config/loader.hpp + src/config/loader.cpp
yaml-cpp-backed loader. `load_control_state(path)` returns a
ControlTransitionTable + initial state; `load_equipment(path, model)`
populates the EquipmentDataModel and returns the device descriptor
(id, MDLN, SOFTREV, optional auto-emit CEID). Surfaces config
errors with file path + field name via ConfigError.
include/secsgem/gem/router.hpp (header-only)
Small (stream, function) -> handler map. Server registers all
handlers once at startup, then the Connection's message handler is
just `router.dispatch(msg)`. Unhandled primaries with W set get
SxF0 by default. Replaces the if-ladder in secs_server.cpp.
include/secsgem/gem/control_state.hpp + .cpp
ControlTransitionTable is the new pure data type. ControlStateMachine
is now a thin engine over the table: `fire(event)` looks up the row,
optionally transitions, optionally chains a `then` transition, returns
the ack code. Behaviour rules no longer live in C++ switches.
The default in-code table matches data/control_state.yaml row for row;
tests rely on it so they don't need the YAML file.
include/secsgem/gem/data_model.hpp + .cpp
`register_command(rcmd, CommandSpec)` replaces the function-handler
signature. CommandSpec = (HostCmdAck, optional emit_ceid, optional
set_alarm). `dispatch_command` returns a CommandResult so the server
can fire the side-effects after S2F42 is sent.
apps/secs_server.cpp
No populate(), no if-ladder. Loads equipment.yaml + control_state.yaml
at startup (clean error on bad config), wires the Router once,
delegates dispatch. Sm change handler reads emit_on_control_change
from the YAML. Welcome S10F3 removed for parity with config (a future
YAML rule could re-introduce it declaratively).
tests/test_loader.cpp (new)
Verifies the YAML loader produces the same shape as the in-code
default table, and that equipment.yaml populates every section
(SVIDs/ECIDs/CEIDs/alarms/recipes/commands). SECSGEM_DATA_DIR
CMake define points at ${CMAKE_SOURCE_DIR}/data so tests don't
depend on cwd.
CMakeLists.txt, Dockerfile
find_package(yaml-cpp) and link. libyaml-cpp-dev added to the
Ubuntu base image (yaml-cpp 0.8 ships the modern target name).
File consolidation
------------------
Five small files removed; their content lives in fewer headers:
- secs2/item.cpp -> inline in secs2/item.hpp
- secs2/message.cpp -> inline in secs2/message.hpp
- hsms/types.hpp -> merged into hsms/header.hpp
- hsms/frame.hpp -> merged into hsms/header.hpp
- hsms/frame.cpp -> merged into hsms/header.cpp
hsms/header.hpp is now "the HSMS wire format" in one place: SType + status
enums + Timers + Header + Frame + constants. All includers updated.
Net effect
----------
Before: equipment data dictionary lived in 50 lines of imperative
populate() inside secs_server.cpp; dispatch in a 20-branch if-ladder.
After: equipment data dictionary lives in 47 lines of YAML; dispatch
is a Router built once. Adding a new capability is now a YAML edit
in the common case.
Test count up to 67 cases / 384 assertions (+4 cases / +106 assertions)
covering the loader and the new table-driven SM paths.
What's NOT changed
------------------
The per-SxFy reply construction still lives in C++ (each message has a
unique body shape). Moving those into YAML/JSON message-shape
definitions is the next refactor step but requires a generic typed
encoder/decoder driven by shape descriptors; out of scope here.
Spooling, the S9 error stream, S1F19/F20, and the other gaps in
COMPLIANCE.md remain unchanged.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
139 lines
4.4 KiB
C++
139 lines
4.4 KiB
C++
#pragma once
|
|
|
|
#include <asio.hpp>
|
|
#include <array>
|
|
#include <cstdint>
|
|
#include <deque>
|
|
#include <functional>
|
|
#include <map>
|
|
#include <memory>
|
|
#include <optional>
|
|
#include <string>
|
|
#include <system_error>
|
|
|
|
#include "secsgem/hsms/header.hpp"
|
|
#include "secsgem/secs2/message.hpp"
|
|
|
|
namespace secsgem::hsms {
|
|
|
|
// One HSMS session over a connected TCP socket. Drives the connection state
|
|
// machine (NOT_SELECTED -> SELECTED), runs the SELECT/LINKTEST/SEPARATE control
|
|
// handshakes and the T3/T6/T7/T8 timers, and correlates data replies by system
|
|
// bytes. Single-threaded: all work runs on the socket's executor.
|
|
class Connection : public std::enable_shared_from_this<Connection> {
|
|
public:
|
|
enum class Mode { Active, Passive };
|
|
enum class State { NotSelected, Selected };
|
|
|
|
// Handler for an inbound primary (request) message. Return a reply Message to
|
|
// send it back (system bytes are filled in automatically), or nullopt for none.
|
|
using MessageHandler = std::function<std::optional<secs2::Message>(const secs2::Message&)>;
|
|
using SelectedHandler = std::function<void()>;
|
|
using ClosedHandler = std::function<void(const std::string& reason)>;
|
|
using ReplyHandler = std::function<void(std::error_code, const secs2::Message&)>;
|
|
using LogHandler = std::function<void(const std::string&)>;
|
|
|
|
Connection(asio::ip::tcp::socket socket, Mode mode, uint16_t device_id, Timers timers);
|
|
|
|
void set_message_handler(MessageHandler h) { on_message_ = std::move(h); }
|
|
void set_selected_handler(SelectedHandler h) { on_selected_ = std::move(h); }
|
|
void set_closed_handler(ClosedHandler h) { on_closed_ = std::move(h); }
|
|
void set_log_handler(LogHandler h) { on_log_ = std::move(h); }
|
|
|
|
// Begin the read loop. Active mode also initiates the SELECT handshake;
|
|
// Passive mode arms the T7 not-selected timer and waits for Select.req.
|
|
void start();
|
|
|
|
// Send a primary data message (W-bit set) and invoke `cb` with the reply or a
|
|
// timeout/error. Must be SELECTED.
|
|
void send_request(secs2::Message msg, ReplyHandler cb);
|
|
|
|
// Send a data message with no reply expected.
|
|
void send_data(secs2::Message msg);
|
|
|
|
// Graceful teardown: send Separate.req and close.
|
|
void separate();
|
|
|
|
// Hard close.
|
|
void close(const std::string& reason);
|
|
|
|
State state() const { return state_; }
|
|
bool selected() const { return state_ == State::Selected; }
|
|
|
|
private:
|
|
// --- read path ---
|
|
void read_length();
|
|
void on_length(std::error_code ec, std::size_t n);
|
|
void on_payload(std::error_code ec, std::size_t n);
|
|
void handle_frame(Frame frame);
|
|
void handle_data(const Frame& frame);
|
|
void handle_control(const Frame& frame);
|
|
|
|
// --- write path ---
|
|
void send_frame(Frame frame);
|
|
void write_next();
|
|
|
|
// --- handshakes & timers ---
|
|
void send_select_req();
|
|
void send_linktest_req();
|
|
void enter_selected();
|
|
void arm_t7();
|
|
void arm_linktest();
|
|
void start_control_transaction(SType expected_response, uint32_t system_bytes,
|
|
const char* what);
|
|
void clear_control_transaction();
|
|
|
|
uint32_t next_system_bytes();
|
|
void log(const std::string& msg);
|
|
|
|
asio::ip::tcp::socket socket_;
|
|
asio::steady_timer t6_timer_; // control transaction timeout
|
|
asio::steady_timer t7_timer_; // not-selected timeout (passive)
|
|
asio::steady_timer t8_timer_; // intercharacter timeout (during a read)
|
|
asio::steady_timer linktest_timer_; // periodic linktest interval
|
|
|
|
Mode mode_;
|
|
uint16_t device_id_;
|
|
Timers timers_;
|
|
State state_ = State::NotSelected;
|
|
bool closed_ = false;
|
|
|
|
std::array<uint8_t, kLengthPrefixSize> len_buf_{};
|
|
std::vector<uint8_t> payload_;
|
|
|
|
std::deque<std::vector<uint8_t>> write_queue_;
|
|
bool writing_ = false;
|
|
bool close_after_flush_ = false;
|
|
std::string close_reason_;
|
|
|
|
uint32_t next_system_bytes_ = 1;
|
|
|
|
// outstanding data request transactions, keyed by system bytes
|
|
struct PendingRequest {
|
|
ReplyHandler cb;
|
|
std::shared_ptr<asio::steady_timer> t3;
|
|
};
|
|
std::map<uint32_t, PendingRequest> pending_requests_;
|
|
|
|
// single outstanding control transaction (select / linktest)
|
|
struct PendingControl {
|
|
SType expected_response;
|
|
uint32_t system_bytes;
|
|
};
|
|
std::optional<PendingControl> pending_control_;
|
|
|
|
MessageHandler on_message_;
|
|
SelectedHandler on_selected_;
|
|
ClosedHandler on_closed_;
|
|
LogHandler on_log_;
|
|
};
|
|
|
|
// Error category for HSMS protocol-level failures surfaced through ReplyHandler.
|
|
enum class Error {
|
|
Timeout = 1,
|
|
Closed = 2,
|
|
};
|
|
std::error_code make_error(Error e);
|
|
|
|
} // namespace secsgem::hsms
|