raphael/secs-gem
Public Access
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Table/YAML-driven refactor (Layer 1 start)

Browse Source 
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>
This commit is contained in:
Raphael Maenle
2026-06-02 08:57:38 +02:00
parent 96b02f8b50
commit b871cd9da2
28 changed files with 1141 additions and 682 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/secsgem/secs2/item.hpp
+41 -3
View File
@@ -28,12 +28,48 @@ enum class Format : uint8_t {
U4 = 054, // 44
};
const char* format_name(Format f);
inline const char* format_name(Format f) {
switch (f) {
case Format::List: return "L";
case Format::Binary: return "B";
case Format::Boolean: return "BOOLEAN";
case Format::ASCII: return "A";
case Format::I8: return "I8";
case Format::I1: return "I1";
case Format::I2: return "I2";
case Format::I4: return "I4";
case Format::F8: return "F8";
case Format::F4: return "F4";
case Format::U8: return "U8";
case Format::U1: return "U1";
case Format::U2: return "U2";
case Format::U4: return "U4";
}
return "?";
}
// Number of bytes one element of the given format occupies on the wire.
// Lists are special (their length is an element count, not a byte count) and
// return 0 here.
std::size_t element_size(Format f);
inline std::size_t element_size(Format f) {
switch (f) {
case Format::List: return 0;
case Format::ASCII:
case Format::Binary:
case Format::Boolean:
case Format::U1:
case Format::I1: return 1;
case Format::U2:
case Format::I2: return 2;
case Format::U4:
case Format::I4:
case Format::F4: return 4;
case Format::U8:
case Format::I8:
case Format::F8: return 8;
}
return 0;
}
// A SECS-II data item: a typed, possibly nested value. Lists hold child items;
// every other format holds a homogeneous array of scalars (a single scalar is
@@ -64,7 +100,9 @@ class Item {
// Number of elements: child count for lists, character count for ASCII,
// array length for numeric/binary formats.
std::size_t size() const;
std::size_t size() const {
return std::visit([](const auto& v) { return v.size(); }, data_);
}
// --- Factory functions -------------------------------------------------
static Item list(List items) { return Item(Format::List, std::move(items)); }
include/secsgem/secs2/message.hpp
+22 -7
View File
@@ -5,6 +5,7 @@
#include <string>
#include <vector>
#include "secsgem/secs2/codec.hpp"
#include "secsgem/secs2/item.hpp"
namespace secsgem::secs2 {
@@ -22,16 +23,30 @@ struct Message {
Message(uint8_t s, uint8_t f, bool w, std::optional<Item> b = std::nullopt)
: stream(s), function(f), reply_expected(w), body(std::move(b)) {}
// Encode the body item to bytes (empty if there is no body).
std::vector<uint8_t> encode_body() const;
std::vector<uint8_t> encode_body() const {
if (!body) return {};
return encode(*body);
}
// Build a Message from stream/function/W and raw body bytes (empty -> no body).
static Message from_body(uint8_t stream, uint8_t function, bool reply_expected,
const std::vector<uint8_t>& body_bytes);
const std::vector<uint8_t>& body_bytes) {
Message m(stream, function, reply_expected);
if (!body_bytes.empty()) m.body = decode(body_bytes);
return m;
}
// e.g. S1F2 W
// <L [2] <A "MDLN"> <A "1.0"> >
std::string sml() const;
// e.g. S1F2
// <L [2] <A "MDLN"> <A "1.0"> > .
std::string sml() const {
std::string out = "S" + std::to_string(stream) + "F" + std::to_string(function);
if (reply_expected) out += " W";
if (body) {
out += "\n ";
out += to_sml(*body);
}
out += " .";
return out;
}
};
} // namespace secsgem::secs2