28 Commits

Author SHA1 Message Date
Martino Ferrari bceab8607c Improved all axpect of tracing / forcing arrays
Improved ui and tree export
2026-05-21 06:20:22 +02:00
Martino Ferrari 58abf98eea minor improvement: filtering service logs 2026-05-20 17:39:53 +02:00
Martino Ferrari 74816028a8 major improvements for big apps 2026-05-20 17:21:33 +02:00
Martino Ferrari f6eb0a7056 Updated without Vector 2026-05-20 11:30:05 +02:00
Martino Ferrari d967098ead Added go webui for minimal c dependencies 2026-05-19 16:39:12 +02:00
Martino Ferrari 242b1c4406 ignore claude files 2026-05-19 14:35:44 +02:00
Martino Ferrari 1af42f5475 minor cleanup 2026-05-19 14:09:25 +02:00
Martino Ferrari e9f25f5867 Implemented common base for debug services 2026-05-07 12:12:14 +02:00
Martino Ferrari 774808a054 interface added and web ui created 2026-05-07 10:49:24 +02:00
Martino Ferrari 340b024ae4 removed obsolete code 2026-04-15 14:48:31 +02:00
martino 4be38cf57b Merge pull request 'Merging new feature to MAIN Branch' (#1) from scope into main
Reviewed-on: #1
2026-04-15 14:23:16 +02:00
Martino Ferrari 3a1ecd3aba Major functionality implemented (missing reconfig). 2026-04-14 01:40:43 +02:00
Martino Ferrari 96d98dfc3d Implemented DebugService with TCPLogger injection 2026-04-09 22:22:39 +02:00
Martino Ferrari b86ede99b9 Fixed issues with config and tracing 2026-04-08 23:44:01 +02:00
Martino Ferrari 7adbecdb6e Added custom Message functionality 2026-03-04 10:08:43 +01:00
Martino Ferrari d3077e78ec implemented array support on client and server 2026-03-03 21:58:32 +01:00
Martino Ferrari a941563749 Improved overall features 2026-03-03 21:41:59 +01:00
Martino Ferrari e6102ba433 Project fixes and correct MARTe style makefile and source structure 2026-03-03 15:15:52 +01:00
Martino Ferrari 631417ef10 fixed remove forcing 2026-03-03 15:15:32 +01:00
Martino Ferrari ad532419fb working again 2026-02-25 21:20:06 +01:00
Martino Ferrari dfb399bbba better perf 2026-02-25 16:51:07 +01:00
Martino Ferrari aaf69c0949 Added record to file 2026-02-24 22:59:37 +01:00
Martino Ferrari ec29bd5148 Scope like ui start 2026-02-23 18:01:24 +01:00
Martino Ferrari 56bb3536fc Implemented all basic features 2026-02-23 13:17:16 +01:00
Martino Ferrari 6b1fc59fc0 Implemetned better buffering and high frequency tracing 2026-02-23 12:00:14 +01:00
Martino Ferrari 253a4989f9 Testing HF data 2026-02-23 11:24:32 +01:00
Martino Ferrari 04fb98bc74 Fixed ui for high frequency data 2026-02-23 11:17:11 +01:00
Martino Ferrari 3ad581d13b Removede scheduler 2026-02-23 10:25:58 +01:00
87 changed files with 15773 additions and 3803 deletions
+1
View File
@@ -7,3 +7,4 @@ bin/
dependency/ dependency/
.cache/ .cache/
target/ target/
CLAUDE.md
+273 -53
View File
@@ -1,61 +1,281 @@
# API Documentation # API Documentation
## 1. TCP Control Interface (Port 8080) This document covers both transport implementations. The command text protocol is identical
for both; only the carrier differs.
### 1.1 `TREE`
Retrieves the full object hierarchy.
- **Request:** `TREE
`
- **Response:** `JSON_OBJECT
OK TREE
`
### 1.2 `DISCOVER`
Lists all registrable signals and their metadata.
- **Request:** `DISCOVER
`
- **Response:** `{"Signals": [...]}
OK DISCOVER
`
### 1.3 `TRACE <path> <state>`
Enables/disables telemetry for a signal.
- **Example:** `TRACE App.Data.Timer.Counter 1
`
- **Response:** `OK TRACE <match_count>
`
### 1.4 `FORCE <path> <value>`
Overrides a signal value in memory.
- **Example:** `FORCE App.Data.DDB.Signal 123.4
`
- **Response:** `OK FORCE <match_count>
`
### 1.5 `PAUSE` / `RESUME`
Controls global execution state via the Scheduler.
- **Request:** `PAUSE
`
- **Response:** `OK
`
--- ---
## 2. UDP Telemetry Format (Port 8081) ## 1. DebugService — TCP Command Interface (default port 8080)
Telemetry packets are Little-Endian and use `#pragma pack(1)`. Commands are newline-terminated (`\n`) UTF-8 text strings sent over a persistent TCP
connection. One client is served at a time; concurrent connections queue.
### 2.1 TraceHeader (20 Bytes) A client sending more than **100 commands per second** is disconnected (rate limit).
| Offset | Type | Name | Description | A client that sends no data for **30 seconds** is disconnected (idle timeout).
| :--- | :--- | :--- | :--- |
| 0 | uint32 | magic | Always `0xDA7A57AD` |
| 4 | uint32 | seq | Incremental sequence number |
| 8 | uint64 | timestamp | High-resolution timestamp |
| 16 | uint32 | count | Number of samples in payload |
### 2.2 Sample Entry ### 1.1 `DISCOVER`
| Offset | Type | Name | Description | List all registered signals with full metadata.
| :--- | :--- | :--- | :--- |
| 0 | uint32 | id | Internal Signal ID (from `DISCOVER`) | - **Request:** `DISCOVER\n`
| 4 | uint32 | size | Data size in bytes | - **Response:**
| 8 | Bytes | data | Raw signal memory | ```
{"Signals":[{"id":<n>,"name":"…","alias":"…","type":"…","elements":<n>},...]}
OK DISCOVER
```
### 1.2 `TREE`
Return the full live `ObjectRegistryDatabase` hierarchy as JSON.
- **Request:** `TREE\n`
- **Response:**
```json
{"name":"Root","children":[…]}
OK TREE
```
### 1.3 `INFO <path>`
Return metadata for a specific ORD node. Response is enriched with config fields
(Frequency, Units, PVNames, …) when a full config has been provided via `SetFullConfig`.
- **Request:** `INFO App.Functions.GAM1\n`
- **Response:**
```
{"path":"…","class":"…","signals":[…],"config":{…}}
OK INFO
```
### 1.4 `LS [path]`
List the immediate children of an ORD node.
- **Request:** `LS App.Data\n`
- **Response:**
```
{"nodes":["Timer","DDB"]}
OK LS
```
### 1.5 `TRACE <name> <0|1> [decimation]`
Enable or disable high-speed tracing for a signal. Optional `decimation` controls
how many RT cycles are skipped between samples (default 1 = every cycle).
- **Request:** `TRACE App.Data.DDB.Counter 1\n`
- **Request:** `TRACE App.Data.DDB.Counter 1 10\n` *(every 10th sample)*
- **Response:** `OK TRACE <match_count>\n`
### 1.6 `FORCE <name> <value>`
Inject a persistent value into a signal's memory location. The RT broker will copy
the forced value on every cycle until `UNFORCE` is called.
- **Request:** `FORCE App.Data.DDB.Counter 9999\n`
- **Response:** `OK FORCE <match_count>\n`
### 1.7 `UNFORCE <name>`
Remove a forced value; the signal resumes its normal data-flow value.
- **Request:** `UNFORCE App.Data.DDB.Counter\n`
- **Response:** `OK UNFORCE <match_count>\n`
### 1.8 `BREAK <name> <op> <threshold>`
Set a conditional breakpoint on a signal. When the condition fires, the application
pauses and execution stepping becomes available. Supported operators:
| `op` string | Condition |
|---|---|
| `>` | signal > threshold |
| `<` | signal < threshold |
| `==` | signal == threshold |
| `>=` | signal >= threshold |
| `<=` | signal <= threshold |
| `!=` | signal != threshold |
| `OFF` | disable break (same as `BREAK <name> OFF`) |
- **Request:** `BREAK App.Data.DDB.Counter > 1000\n`
- **Response:** `OK BREAK <match_count>\n`
### 1.9 `BREAK <name> OFF`
Clear the breakpoint on a signal (equivalent to `BREAK <name> OFF 0`).
- **Request:** `BREAK App.Data.DDB.Counter OFF\n`
- **Response:** `OK BREAK <match_count>\n`
### 1.10 `PAUSE`
Halt all patched RT threads at the start of their next Execute cycle.
- **Request:** `PAUSE\n`
- **Response:** `OK\n`
### 1.11 `RESUME`
Release paused RT threads.
- **Request:** `RESUME\n`
- **Response:** `OK\n`
### 1.12 `STEP <n> [thread]`
Resume execution for exactly `n` RT output-broker cycles then pause again.
Optional `thread` (OS thread name) restricts counting to one thread.
- **Request:** `STEP 5\n`
- **Request:** `STEP 1 RealTimeThread1\n`
- **Response:** `OK STEP\n`
### 1.13 `STEP_STATUS`
Query current pause and stepping state.
- **Request:** `STEP_STATUS\n`
- **Response:**
```json
{"paused":true,"gam":"App.Functions.GAM1","remaining":3}
OK STEP_STATUS
```
### 1.14 `VALUE <name>`
Read the current raw value of a signal from its memory address. Arrays are
capped at 256 elements; larger signals include `"truncated":true`.
- **Request:** `VALUE App.Data.DDB.Counter\n`
- **Response:**
```json
{"name":"App.Data.DDB.Counter","type":"uint32","elements":1,"values":[42]}
OK VALUE
```
### 1.15 `MONITOR SIGNAL <name> <periodMs>`
Register a signal for slow-rate polling. The service reads the signal directly
from its `DataSourceI` and sends the value at the specified period.
- **Request:** `MONITOR SIGNAL App.Data.DDB.Counter 500\n`
- **Response:** `OK MONITOR <id>\n`
On `DebugService`, monitored values are pushed over UDP with signal ID = internal monitor ID.
On `WebDebugService`, they are broadcast as `{"type":"monitor",…}` SSE events.
### 1.16 `UNMONITOR SIGNAL <name>`
Stop polling a monitored signal.
- **Request:** `UNMONITOR SIGNAL App.Data.DDB.Counter\n`
- **Response:** `OK UNMONITOR\n`
### 1.17 `CONFIG`
Return the full application configuration as JSON. Requires that `SetFullConfig()` was
called after `ConfigureApplication()`.
- **Request:** `CONFIG\n`
- **Response:**
```json
{"App":{"Class":"RealTimeApplication",…}}
OK CONFIG
```
### 1.18 `MSG <object> <function> [key=value …]`
Send a MARTe2 `Message` to any object in the ORD.
- **Request:** `MSG App.Functions.GAM1 Reset\n`
- **Request:** `MSG App.StateMachine GOTOSTATE NewState=Running\n`
- **Response:** `OK MSG\n` or `ERROR MSG <reason>\n`
### 1.19 `SERVICE_INFO`
Return metadata about the debug service itself.
- **Request:** `SERVICE_INFO\n`
- **Response:**
```json
{"transport":"TCP","controlPort":8080,"udpPort":8081,"logPort":8082}
```
---
## 2. WebDebugService — HTTP Interface (default port 8090)
### 2.1 `GET /`
Returns the embedded single-page application. Open in any web browser.
### 2.2 `POST /api/command`
Execute any command from Section 1. The request body is the command text
(without a trailing newline). CORS headers are included.
- **Request headers:** `Content-Type: text/plain`
- **Request body:** e.g. `TRACE App.Data.DDB.Counter 1`
- **Response:** Plain text; same content as the TCP response.
### 2.3 `GET /api/events`
Long-lived Server-Sent Events stream. Up to 8 simultaneous clients.
Each event is formatted as:
```
event: message
data: <json>
```
(blank line terminates each event per SSE spec)
#### SSE event types
| `type` field | Additional fields | Description |
|---|---|---|
| `trace` | `name`, `ts` (ns), `value` (f64) | One traced signal sample |
| `monitor` | `name`, `ts` (ns), `value` (f64) | One slow-rate monitor sample |
| `log` | `level`, `msg` | Forwarded `REPORT_ERROR` log entry |
| `status` | `paused` (bool), `gam`, `remaining` | Pause/step state heartbeat (every 500 ms) |
| `discover` | `signals` (array) | Full signal list (sent on SSE connect) |
| `tree` | `tree` (object) | Full ORD tree (sent on SSE connect) |
Example trace event:
```
event: message
data: {"type":"trace","name":"App.Data.DDB.Counter","ts":1234567890,"value":42.0}
```
---
## 3. UDP Telemetry Format (DebugService, default port 8081)
Packets are little-endian and packed (`#pragma pack(1)`).
### 3.1 `TraceHeader` (20 bytes)
| Offset | Type | Field | Description |
|---|---|---|---|
| 0 | uint32 | `magic` | Always `0xDA7A57AD` |
| 4 | uint32 | `seq` | Monotonically incrementing sequence number |
| 8 | uint64 | `timestamp` | High-resolution hardware timestamp |
| 16 | uint32 | `count` | Number of samples in this datagram |
### 3.2 Sample Entry (per signal)
| Offset | Type | Field | Description |
|---|---|---|---|
| 0 | uint32 | `id` | Signal ID from `DISCOVER` |
| 4 | uint64 | `timestamp` | Per-sample RT timestamp |
| 12 | uint32 | `size` | Payload size in bytes |
| 16 | bytes | `data` | Raw signal memory (`size` bytes) |
Multiple samples may be packed into one datagram up to `STREAMER_MTU = 1400` bytes.
A new datagram is started when the next sample would overflow the MTU.
---
## 4. Log Forwarding (DebugService, default port 8082)
The `TcpLogger` component (`Source/Components/Interfaces/TCPLogger/`) connects to the
MARTe2 global `LoggerI` and forwards every `REPORT_ERROR` call as a text line:
```
<level>|<object>|<function>|<message>\n
```
Up to 8 simultaneous log clients are supported. If no client is connected, log events
are silently discarded.
To enable:
```text
+Logger = {
Class = TcpLogger
Port = 8082
MaxClients = 8
}
```
On `WebDebugService`, logs are forwarded to SSE clients as `{"type":"log","level":"…","msg":"…"}`
events — no separate `TcpLogger` instance is required.
+257 -32
View File
@@ -1,44 +1,269 @@
# System Architecture # System Architecture
## 1. Overview ## 1. Overview
The suite consists of a C++ server library (`libmarte_dev.so`) that instrument MARTe2 applications at runtime, and a native Rust client for visualization.
The MARTe2 Debug Suite is a C++ server library that instruments running MARTe2 applications
without modifying their source code. It exposes an abstract `DebugServiceI` interface that
decouples the broker injection layer from the communication transport, allowing multiple
transport backends to coexist (currently TCP/UDP and HTTP/SSE).
```
┌────────────────────────────────────────────────────────────────────┐
│ MARTe2 Application │
│ ┌──────────┐ ┌───────────────────────┐ ┌──────────────────┐ │
│ │ GAM(s) │ │ DebugBrokerWrapper │ │ FastScheduler │ │
│ │ │◄──│ (Registry-patched) │ │ (unmodified) │ │
│ └──────────┘ └──────────┬────────────┘ └──────────────────┘ │
│ │ RT-path API │
└────────────────────────────┼───────────────────────────────────────┘
┌────────▼────────┐
│ DebugServiceI │ ← Abstract interface (singleton)
└────────┬────────┘
┌─────────────┴──────────────┐
│ │
┌────────▼────────┐ ┌─────────▼────────┐
│ DebugService │ │ WebDebugService │
│ TCP/UDP │ │ HTTP/SSE │
└────────┬────────┘ └─────────┬─────────┘
│ │
┌──────────┼──────────┐ ┌──────────┼──────────┐
│TCP 8080 │UDP 8081 │ │HTTP 8090 │SSE stream │
│(commands)│(telemetry│ │(commands)│(telemetry)│
└────┬─────┴────┬─────┘ └─────┬────┴────┬──────┘
│ │ │ │
┌────▼──────────▼─────┐ ┌─────────▼─────────▼──────┐
│ Rust/egui GUI │ │ Web Browser (built-in UI)│
│ (Tools/gui_client) │ │ http://localhost:8090 │
└─────────────────────┘ └───────────────────────────┘
```
---
## 2. Core Mechanism: Registry Patching ## 2. Core Mechanism: Registry Patching
The "Zero-Code-Change" requirement is met by intercepting the MARTe2 `ClassRegistryDatabase`. When the `DebugService` initializes, it replaces the standard object builders for critical classes:
1. **Broker Injection:** Standard Brokers (e.g., `MemoryMapInputBroker`) are replaced with `DebugBrokerWrapper`. This captures data every time a GAM reads or writes a signal. The "Zero-Code-Change" requirement is met by intercepting the MARTe2 `ClassRegistryDatabase`.
2. **Scheduler Injection:** The `FastScheduler` is replaced with `DebugFastScheduler`. This provides hooks at the start/end of each real-time cycle for execution control (pausing). When `DebugService` or `WebDebugService` initialises, `PatchRegistry()` replaces the
`ObjectBuilder` for every standard `MemoryMap*Broker` class in the registry. When
`RealTimeApplication::ConfigureApplication()` runs afterward it instantiates wrapped broker
objects instead of the originals — the application sees no difference.
## 3. Communication Layer Patched broker types:
The system uses three distinct channels:
### 3.1 Command & Control (TCP Port 8080) | Class | Wrapper |
- **Protocol:** Text-based over TCP. |---|---|
- **Role:** Object tree discovery (`TREE`), signal metadata (`DISCOVER`), and trace activation (`TRACE`). | `MemoryMapInputBroker` | `DebugBrokerWrapper<MemoryMapInputBroker>` |
- **Response Format:** JSON for complex data, `OK/ERROR` for status. | `MemoryMapOutputBroker` | `DebugBrokerWrapper<MemoryMapOutputBroker>` |
| `MemoryMapSynchronisedInputBroker` | `DebugBrokerWrapper<MemoryMapSynchronisedInputBroker>` |
| `MemoryMapSynchronisedOutputBroker` | `DebugBrokerWrapper<MemoryMapSynchronisedOutputBroker>` |
| `MemoryMapMultiBufferBroker` | `DebugBrokerWrapper<MemoryMapMultiBufferBroker>` |
| `MemoryMapMultiBufferOutputBroker` | `DebugBrokerWrapper<MemoryMapMultiBufferOutputBroker>` |
| `MemoryMapAsynchronousInputBroker` | `DebugBrokerWrapperAsync<MemoryMapAsynchronousInputBroker>` |
| `MemoryMapAsynchronousOutputBroker` | `DebugBrokerWrapperAsync<MemoryMapAsynchronousOutputBroker>` |
| `MemoryMapInterpolatedInputBroker` | `DebugBrokerWrapper<MemoryMapInterpolatedInputBroker>` |
| `MemoryMapStatefulOutputBroker` | `DebugBrokerWrapper<MemoryMapStatefulOutputBroker>` |
| `MemoryMapStatefulInputBroker` | `DebugBrokerWrapper<MemoryMapStatefulInputBroker>` |
### 3.2 High-Speed Telemetry (UDP Port 8081) ---
- **Protocol:** Binary over UDP.
- **Format:** Packed C-structs.
- **Header:** `[Magic:4][Seq:4][TS:8][Count:4]` (Packed, 20 bytes).
- **Payload:** `[ID:4][Size:4][Data:N]` (Repeated for each traced signal).
### 3.3 Log Streaming (TCP Port 8082) ## 3. DebugServiceI Abstraction Layer
- **Protocol:** Real-time event streaming.
- **Service:** `TcpLogger` (Standalone component).
- **Role:** Forwards global `REPORT_ERROR` calls and `stdout` messages to the GUI client.
## 4. Component Diagram `Source/Components/Interfaces/DebugService/DebugServiceI.h` defines the abstract singleton
```text interface. It has two logical groups:
[ MARTe2 App ] <--- [ DebugFastScheduler ] (Registry Patch)
| | ### 3.1 RT-path API
+ <--- [ DebugBrokerWrapper ] (Registry Patch) Called from broker threads on every RT cycle. Must be as cheap as possible; the only
| | permissible synchronisation primitive is `FastPollingMutexSem`.
+---------------------+
| | | Method | Purpose |
[ DebugService ] [ TcpLogger ] |---|---|
| | | `RegisterSignal(addr, type, name, …)` | Called once per signal during broker `Init()` |
+--- (TCP 8080) ------+-----> [ Rust GUI Client ] | `ProcessSignal(info, size, timestamp)` | Apply forcing, check break, push trace sample |
+--- (UDP 8081) ------+-----> [ (Oscilloscope) ] | `RegisterBroker(…)` | Cache broker metadata for active/break index updates |
+--- (TCP 8082) ------+-----> [ (Log Terminal) ] | `IsPaused() / SetPaused(bool)` | Query / set global pause state |
| `ConsumeStepIfNeeded(gamName, thread)` | Decrement step counter on output-broker Execute |
### 3.2 Control-path API
Called from server/command-handler threads; latency acceptable.
| Method | Purpose |
|---|---|
| `ForceSignal / UnforceSignal` | Persistent value injection |
| `TraceSignal(name, enable, decimation)` | Enable/disable ring-buffer tracing |
| `SetBreak / ClearBreak` | Conditional breakpoints |
| `IsInstrumented(path, …)` | Query whether a signal is reachable |
| `RegisterMonitorSignal / UnmonitorSignal` | Slow-rate signal polling |
### 3.3 Static singleton pattern
```cpp
// Concrete implementation registers itself:
DebugServiceI::SetInstance(this); // in Initialise()
DebugServiceI::SetInstance(NULL_PTR()); // in destructor
// Broker wrappers retrieve it (no ORD search on the hot path):
DebugServiceI *svc = DebugServiceI::GetInstance();
if (svc != NULL_PTR(DebugServiceI*)) { ... }
```
Shared data structures (`SignalAlias`, `BrokerInfo`) are also defined in `DebugServiceI.h`
so both transport implementations can use them without a circular dependency.
---
## 4. Transport Implementations
### 4.1 DebugService (TCP/UDP)
`Source/Components/Interfaces/DebugService/DebugService.h/.cpp`
Runs two `SingleThreadService` threads:
| Thread | Role |
|---|---|
| `Server()` | Accepts one TCP client at a time; reads text commands; writes JSON/text responses |
| `Streamer()` | Drains `TraceRingBuffer`; assembles and sends UDP datagrams; polls monitored signals |
Communication ports (all configurable):
| Port | Protocol | Purpose |
|---|---|---|
| `ControlPort` (default 8080) | TCP text | Commands and responses |
| `UdpPort` (default 8081) | UDP binary | High-speed telemetry (`TraceHeader` + samples) |
| `LogPort` (default 8082) | TCP stream | Log forwarding via `TcpLogger` sidecar |
### 4.2 WebDebugService (HTTP/SSE)
`Source/Components/Interfaces/WebDebugService/WebDebugService.h/.cpp`
Serves a single HTTP port (default 8090) with an embedded browser UI. Runs two
`SingleThreadService` threads:
| Thread | Role |
|---|---|
| `HttpServer()` | Accepts TCP connections; routes GET/POST/OPTIONS; upgrades SSE clients |
| `Streamer()` | Drains `TraceRingBuffer` → SSE events; polls monitored signals; heartbeat |
HTTP endpoints:
| Endpoint | Method | Purpose |
|---|---|---|
| `/` | GET | Serves embedded single-page application (HTML/CSS/JS) |
| `/api/command` | POST | Execute a debug command; returns text response |
| `/api/events` | GET | Server-Sent Events stream for real-time telemetry (up to 8 clients) |
The embedded web UI (`Source/Components/Interfaces/WebDebugService/WebUI.h`) is a
self-contained single-page application using Chart.js for real-time signal plots and a
Catppuccin Mocha dark theme. No install or server-side tooling required.
---
## 5. Signal Flow
### 5.1 Registration (startup, single-threaded)
```
ConfigureApplication()
└─► DebugBrokerWrapper::Init()
└─► DebugBrokerHelper::InitSignals()
├─► DebugServiceI::RegisterSignal() (canonical name + GAM alias)
└─► DebugServiceI::RegisterBroker()
```
### 5.2 RT loop (hot path, multi-threaded)
```
RealTimeThread::Execute()
└─► DebugBrokerWrapper::Execute()
├─► Base::Execute() (data moved in/out of GAM memory)
└─► DebugBrokerHelper::Process()
├─► For each active signal:
│ └─► DebugServiceI::ProcessSignal()
│ ├─► if isForcing: memcpy forcedValue → signal memory
│ ├─► if isTracing & decimation fires:
│ │ └─► tracePushMutex → TraceRingBuffer::Push()
│ └─► if breakOp set: evaluate condition → SetPaused(true)
└─► (output brokers only) DebugServiceI::ConsumeStepIfNeeded()
```
### 5.3 Telemetry delivery
**DebugService (UDP)**
```
Streamer thread
└─► TraceRingBuffer::Pop()
└─► assemble into streamerPacketBuffer (MTU=1400)
└─► BasicUDPSocket::Write() → client
```
**WebDebugService (SSE)**
```
Streamer thread
└─► TraceRingBuffer::Pop()
└─► BroadcastSse("message", {"type":"trace","name":…,"value":…})
└─► write "event: message\ndata: {…}\n\n" to each SSE socket
```
---
## 6. TraceRingBuffer
Single-producer / single-consumer circular byte buffer defined in `DebugCore.h`.
```
Buffer layout per entry: [ID:4][Timestamp:8][Size:4][Data:N]
```
- `Push()` is serialised by `tracePushMutex` (multiple RT threads write; one Streamer reads).
- `Pop()` is called exclusively by the Streamer thread.
- Ring is initialised to 4 MB in both transport implementations.
- On corrupt `size` field (`size >= bufferSize`): discards all entries to prevent cascading
bad reads (Fix #5).
---
## 7. Performance Hardening
The following fixes were applied after initial implementation to improve correctness and
real-time safety.
| Fix | Area | Change |
|---|---|---|
| **#1** | UDP streamer | Named constants `STREAMER_MTU = 1400` and `STREAMER_BUFFER_SIZE = 4096`; removed magic numbers |
| **#2** | Multi-producer ring | `tracePushMutex` serialises `TraceRingBuffer::Push()` from concurrent RT threads |
| **#3** | Break evaluation | Break indices copied to stack-local array while holding `activeMutex`; condition evaluated outside the lock |
| **#4** | Decimation counter | `Atomic::Add` used for lock-free per-signal decimation in multi-producer `ProcessSignal` |
| **#5** | Ring corruption | `Pop()` skips only the current corrupt entry; falls back to full discard only when `size >= bufferSize` |
| **#6** | TCP rate limit | Server disconnects clients sending > 100 commands/second (`CMD_RATE_LIMIT = 100`) |
| **#7** | Broker index swap | `Vec::Swap` inside spinlock followed by free outside; avoids holding the lock during deallocation |
| **#8** | Idle timeout | Active TCP client disconnected after 30 s of silence (`CLIENT_IDLE_TIMEOUT_MS = 30000`) |
| **#9** | VALUE output size | `GetSignalValue` caps output at 256 elements (`GET_VALUE_MAX_ELEMENTS`); includes `"Truncated"` flag |
| **#10** | TCP framing | `inputBuffer` accumulates partial commands across `Read()` calls; bounded at 8 KiB (`INPUT_BUFFER_MAX`) |
| **#11** | CDB cursor | `Initialise()` never calls `MoveToRoot()` on the CDB passed by the framework; avoids corrupting `ReferenceContainer` traversal |
---
## 8. Repository Layout
```
Source/
Core/Types/
Vec/ — RT-safe dynamic array (no STL)
Result/ — Error-carrying return type
Components/Interfaces/
DebugService/
DebugCore.h — DebugSignalInfo, TraceRingBuffer, BreakOp
DebugServiceI.h — Abstract interface + SignalAlias, BrokerInfo
DebugBrokerWrapper.h — DebugBrokerHelper, wrapper templates, registry builder
DebugService.h/.cpp — TCP/UDP transport implementation
WebDebugService/
WebUI.h — Embedded single-page HTML/CSS/JS application
WebDebugService.h/.cpp — HTTP/SSE transport implementation
TCPLogger/
TcpLogger.h/.cpp — LoggerConsumerI forwarding logs to TCP clients
Test/
Integration/ — Integration test suite (180 s SIGALRM guard)
UnitTests/ — Unit test suite
Tools/
gui_client/ — Rust/egui native GUI (DebugService TCP/UDP transport)
``` ```
-60
View File
@@ -1,60 +0,0 @@
cmake_minimum_required(VERSION 3.10)
project(marte_dev)
if(NOT DEFINED ENV{MARTe2_DIR})
message(FATAL_ERROR "MARTe2_DIR not set. Please source env.sh")
endif()
set(MARTe2_DIR $ENV{MARTe2_DIR})
set(MARTe2_Components_DIR $ENV{MARTe2_Components_DIR})
set(TARGET $ENV{TARGET})
# Define Architecture macros
add_definitions(-DARCHITECTURE=x86_gcc)
add_definitions(-DENVIRONMENT=Linux)
add_definitions(-DMARTe2_TEST_ENVIRONMENT=GTest) # Optional
add_definitions(-DUSE_PTHREAD)
# Add -pthread flag
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -pthread")
include_directories(
${MARTe2_DIR}/Source/Core/BareMetal/L0Types
${MARTe2_DIR}/Source/Core/BareMetal/L1Portability
${MARTe2_DIR}/Source/Core/BareMetal/L2Objects
${MARTe2_DIR}/Source/Core/BareMetal/L3Streams
${MARTe2_DIR}/Source/Core/BareMetal/L4Configuration
${MARTe2_DIR}/Source/Core/BareMetal/L4Events
${MARTe2_DIR}/Source/Core/BareMetal/L4Logger
${MARTe2_DIR}/Source/Core/BareMetal/L4Messages
${MARTe2_DIR}/Source/Core/BareMetal/L5FILES
${MARTe2_DIR}/Source/Core/BareMetal/L5GAMs
${MARTe2_DIR}/Source/Core/BareMetal/L6App
${MARTe2_DIR}/Source/Core/Scheduler/L1Portability
${MARTe2_DIR}/Source/Core/Scheduler/L3Services
${MARTe2_DIR}/Source/Core/Scheduler/L4LoggerService
${MARTe2_DIR}/Source/Core/FileSystem/L1Portability
${MARTe2_DIR}/Source/Core/FileSystem/L3Streams
${MARTe2_DIR}/Source/Core/Scheduler/L5GAMs
${MARTe2_Components_DIR}/Source/Components/DataSources/EpicsDataSource
${MARTe2_Components_DIR}/Source/Components/DataSources/FileDataSource
${MARTe2_Components_DIR}/Source/Components/GAMs/IOGAM
Source
Headers
)
file(GLOB_RECURSE SOURCES "Source/*.cpp")
add_library(${PROJECT_NAME} SHARED ${SOURCES})
# Target MARTe2 library
set(MARTe2_LIB ${MARTe2_DIR}/Build/${TARGET}/Core/libMARTe2.so)
set(IOGAM_LIB ${MARTe2_Components_DIR}/Build/${TARGET}/Components/GAMs/IOGAM/libIOGAM.so)
set(LinuxTimer_LIB ${MARTe2_Components_DIR}/Build/${TARGET}/Components/DataSources/LinuxTimer/libLinuxTimer.so)
target_link_libraries(${PROJECT_NAME}
${MARTe2_LIB}
)
add_subdirectory(Test/UnitTests)
add_subdirectory(Test/Integration)
+68 -19
View File
@@ -1,32 +1,81 @@
# Demo Walkthrough: High-Speed Tracing # Demo Walkthrough: High-Speed Tracing
This demo demonstrates tracing a `Timer.Counter` signal at 100Hz and verifying its consistency. This demo traces a `Timer.Counter` signal at 100 Hz, tests execution control, and verifies
signal forcing. It works with either transport — choose the option that matches your setup.
---
## 1. Build and Launch the Test Environment
### 1. Launch the Test Environment
Start the validation environment which simulates a real-time app:
```bash ```bash
./Build/Test/Integration/ValidationTest source env.sh
make -f Makefile.gcc
./Build/x86-linux/Test/Integration/IntegrationTests
``` ```
*Note: The test will wait for a trace command before finishing.*
### 2. Connect the GUI The integration test starts a MARTe2 application with `DebugService` or `WebDebugService`
In another terminal: already configured and waits for client interaction.
---
## 2. Connect a Client
### Option A — Web Browser (`WebDebugService`)
Open `http://localhost:8090` in any browser. The UI appears instantly with the live
object tree already loaded.
### Option B — Rust GUI (`DebugService`)
```bash ```bash
cd Tools/gui_client cd Tools/gui_client
cargo run --release cargo run --release
``` ```
### 3. Explore the Tree ---
1. On the left panel (**Application Tree**), expand `Root.App.Data.Timer`.
2. Click the ` Info` button on the `Timer` node to see its configuration (e.g., `SleepTime: 10000`).
### 4. Activate Trace ## 3. Explore the Tree
1. Locate the `Counter` signal under the `Timer` node.
2. Click the **📈 Trace** button.
3. The **Oscilloscope** in the center will immediately begin plotting the incremental counter.
4. Verify the **UDP Packets** counter in the top bar is increasing rapidly.
### 5. Test Execution Control 1. In the **Application Tree**, expand `Root → App → Data → Timer`.
1. Click the **⏸ Pause** button in the top bar. 2. Click **Info** (web UI) or ** Info** (Rust GUI) on the `Timer` node.
2. Observe that the plot stops updating and the counter value holds steady. 3. Verify the config panel shows `SleepTime: 10000` (100 Hz cycle).
3. Click **▶ Resume** to continue execution.
---
## 4. Activate Trace
1. Locate the `Counter` signal under `Timer`.
2. Click **Trace** (web UI) or **📈 Trace** (Rust GUI).
3. The real-time plot begins with a monotonically increasing counter.
4. Confirm telemetry is flowing:
- **Web UI:** `{"type":"trace",…}` events appear in the browser DevTools Network tab.
- **Rust GUI:** The **UDP Packets** counter in the top bar increments rapidly.
---
## 5. Test Execution Control
1. Click **Pause** (⏸).
2. Observe that the plot freezes and the counter holds steady.
3. Click **Step** with count = 5.
4. The counter advances exactly 5 units then stops.
5. Click **Resume** (▶) to continue normal execution.
---
## 6. Test Signal Forcing
1. Locate `Root.App.Data.DDB.Counter`.
2. Click **Force** and enter `99999`.
3. Observe the oscilloscope plot jump to and hold at `99999`.
4. Click **Unforce** to release — the counter resumes its normal value.
---
## 7. Test a Breakpoint
1. Click **Break** on `Root.App.Data.DDB.Counter`.
2. Set operator `>` and threshold `500`.
3. Wait for the counter to exceed 500 — the application pauses automatically.
4. The status shows **PAUSED** at the GAM that triggered the break.
5. Click **Break OFF** then **Resume** to continue.
-165
View File
@@ -1,165 +0,0 @@
#ifndef DEBUGBROKERWRAPPER_H
#define DEBUGBROKERWRAPPER_H
#include "DebugService.h"
#include "BrokerI.h"
#include "MemoryMapBroker.h"
#include "ObjectRegistryDatabase.h"
#include "ObjectBuilder.h"
// Original broker headers
#include "MemoryMapInputBroker.h"
#include "MemoryMapOutputBroker.h"
#include "MemoryMapSynchronisedInputBroker.h"
#include "MemoryMapSynchronisedOutputBroker.h"
#include "MemoryMapInterpolatedInputBroker.h"
#include "MemoryMapMultiBufferInputBroker.h"
#include "MemoryMapMultiBufferOutputBroker.h"
#include "MemoryMapSynchronisedMultiBufferInputBroker.h"
#include "MemoryMapSynchronisedMultiBufferOutputBroker.h"
namespace MARTe {
/**
* @brief Base implementation for all debug brokers.
*/
class DebugBrokerHelper {
public:
static void Process(BrokerI* broker, DebugService* service, DebugSignalInfo** signalInfoPointers, uint32 numSignals) {
if (service == NULL_PTR(DebugService*)) return;
while (service->IsPaused()) {
Sleep::MSec(10);
}
if (signalInfoPointers != NULL_PTR(DebugSignalInfo**)) {
for (uint32 i = 0; i < numSignals; i++) {
DebugSignalInfo *s = signalInfoPointers[i];
if (s != NULL_PTR(DebugSignalInfo*)) {
if (s->isTracing || s->isForcing) {
uint32 size = broker->GetCopyByteSize(i);
service->ProcessSignal(s, size);
}
}
}
}
}
static void InitSignals(MemoryMapBroker* broker, DataSourceI &dataSourceIn, DebugService* &service, DebugSignalInfo** &signalInfoPointers, uint32 &numSignals, MemoryMapBrokerCopyTableEntry* copyTable, const char8* functionName, SignalDirection direction) {
numSignals = broker->GetNumberOfCopies();
if (numSignals > 0) {
signalInfoPointers = new DebugSignalInfo*[numSignals];
for (uint32 i=0; i<numSignals; i++) signalInfoPointers[i] = NULL_PTR(DebugSignalInfo*);
}
ReferenceContainer *root = ObjectRegistryDatabase::Instance();
Reference serviceRef = root->Find("DebugService");
if (serviceRef.IsValid()) {
service = dynamic_cast<DebugService*>(serviceRef.operator->());
}
if (service && (copyTable != NULL_PTR(MemoryMapBrokerCopyTableEntry*))) {
StreamString dsPath;
DebugService::GetFullObjectName(dataSourceIn, dsPath);
for (uint32 i = 0; i < numSignals; i++) {
void *addr = copyTable[i].dataSourcePointer;
TypeDescriptor type = copyTable[i].type;
uint32 dsIdx = broker->GetDSCopySignalIndex(i);
StreamString signalName;
if (!dataSourceIn.GetSignalName(dsIdx, signalName)) signalName = "Unknown";
// 1. Register canonical DataSource name (Absolute, No Root prefix)
StreamString dsFullName;
dsFullName.Printf("%s.%s", dsPath.Buffer(), signalName.Buffer());
service->RegisterSignal(addr, type, dsFullName.Buffer());
// 2. Also register absolute GAM alias
if (functionName != NULL_PTR(const char8*)) {
StreamString gamFullName;
const char8* dirStr = (direction == InputSignals) ? "In" : "Out";
Reference gamRef = ObjectRegistryDatabase::Instance()->Find(functionName);
if (gamRef.IsValid()) {
StreamString absGamPath;
DebugService::GetFullObjectName(*(gamRef.operator->()), absGamPath);
gamFullName.Printf("%s.%s.%s", absGamPath.Buffer(), dirStr, signalName.Buffer());
} else {
gamFullName.Printf("%s.%s.%s", functionName, dirStr, signalName.Buffer());
}
signalInfoPointers[i] = service->RegisterSignal(addr, type, gamFullName.Buffer());
} else {
signalInfoPointers[i] = service->RegisterSignal(addr, type, dsFullName.Buffer());
}
}
}
}
};
#define DECLARE_DEBUG_BROKER_COMMON(BaseClass) \
Debug##BaseClass() : BaseClass() { \
service = NULL_PTR(DebugService*); \
signalInfoPointers = NULL_PTR(DebugSignalInfo**); \
numSignals = 0; \
} \
virtual ~Debug##BaseClass() { \
if (signalInfoPointers) delete[] signalInfoPointers; \
} \
virtual bool Execute() { \
bool ret = BaseClass::Execute(); \
if (ret) DebugBrokerHelper::Process(this, service, signalInfoPointers, numSignals); \
return ret; \
} \
private: \
DebugService *service; \
DebugSignalInfo **signalInfoPointers; \
uint32 numSignals;
#define DECLARE_DEBUG_BROKER(BaseClass) \
class Debug##BaseClass : public BaseClass { \
public: \
DECLARE_DEBUG_BROKER_COMMON(BaseClass) \
virtual bool Init(SignalDirection direction, DataSourceI &ds, const char8 *const name, void *gamMem) { \
bool ret = BaseClass::Init(direction, ds, name, gamMem); \
if (ret) DebugBrokerHelper::InitSignals(this, ds, service, signalInfoPointers, numSignals, this->copyTable, name, direction); \
return ret; \
} \
virtual bool Init(SignalDirection direction, DataSourceI &ds, const char8 *const name, void *gamMem, const bool optim) { \
bool ret = BaseClass::Init(direction, ds, name, gamMem, optim); \
if (ret) DebugBrokerHelper::InitSignals(this, ds, service, signalInfoPointers, numSignals, this->copyTable, name, direction); \
return ret; \
} \
}; \
class Debug##BaseClass##Builder : public ObjectBuilder { \
public: \
virtual Object *Build(HeapI* const heap) const { return new (heap) Debug##BaseClass(); } \
};
#define DECLARE_DEBUG_BROKER_NO_OPTIM(BaseClass) \
class Debug##BaseClass : public BaseClass { \
public: \
DECLARE_DEBUG_BROKER_COMMON(BaseClass) \
virtual bool Init(SignalDirection direction, DataSourceI &ds, const char8 *const name, void *gamMem) { \
bool ret = BaseClass::Init(direction, ds, name, gamMem); \
if (ret) DebugBrokerHelper::InitSignals(this, ds, service, signalInfoPointers, numSignals, this->copyTable, name, direction); \
return ret; \
} \
}; \
class Debug##BaseClass##Builder : public ObjectBuilder { \
public: \
virtual Object *Build(HeapI* const heap) const { return new (heap) Debug##BaseClass(); } \
};
DECLARE_DEBUG_BROKER(MemoryMapInputBroker)
DECLARE_DEBUG_BROKER(MemoryMapOutputBroker)
DECLARE_DEBUG_BROKER(MemoryMapSynchronisedInputBroker)
DECLARE_DEBUG_BROKER(MemoryMapSynchronisedOutputBroker)
DECLARE_DEBUG_BROKER_NO_OPTIM(MemoryMapInterpolatedInputBroker)
DECLARE_DEBUG_BROKER(MemoryMapMultiBufferInputBroker)
DECLARE_DEBUG_BROKER(MemoryMapMultiBufferOutputBroker)
DECLARE_DEBUG_BROKER(MemoryMapSynchronisedMultiBufferInputBroker)
DECLARE_DEBUG_BROKER(MemoryMapSynchronisedMultiBufferOutputBroker)
}
#endif
-132
View File
@@ -1,132 +0,0 @@
#ifndef DEBUGCORE_H
#define DEBUGCORE_H
#include "CompilerTypes.h"
#include "TypeDescriptor.h"
#include "StreamString.h"
namespace MARTe {
struct DebugSignalInfo {
void* memoryAddress;
TypeDescriptor type;
StreamString name;
volatile bool isTracing;
volatile bool isForcing;
uint8 forcedValue[1024];
uint32 internalID;
volatile uint32 decimationFactor;
volatile uint32 decimationCounter;
};
#pragma pack(push, 1)
struct TraceHeader {
uint32 magic; // 0xDA7A57AD
uint32 seq; // Sequence number
uint64 timestamp; // HighRes timestamp
uint32 count; // Number of samples in payload
};
#pragma pack(pop)
class TraceRingBuffer {
public:
TraceRingBuffer() {
bufferSize = 0;
buffer = NULL_PTR(uint8*);
readIndex = 0;
writeIndex = 0;
}
~TraceRingBuffer() {
if (buffer != NULL_PTR(uint8*)) {
delete[] buffer;
}
}
bool Init(uint32 size) {
if (buffer != NULL_PTR(uint8*)) {
delete[] buffer;
}
bufferSize = size;
buffer = new uint8[bufferSize];
readIndex = 0;
writeIndex = 0;
return (buffer != NULL_PTR(uint8*));
}
bool Push(uint32 signalID, void* data, uint32 size) {
uint32 packetSize = 4 + 4 + size;
uint32 read = readIndex;
uint32 write = writeIndex;
uint32 available = (read <= write) ? (bufferSize - (write - read) - 1) : (read - write - 1);
if (available < packetSize) return false;
// Use temporary write index to ensure atomic update
uint32 tempWrite = write;
WriteToBuffer(&tempWrite, &signalID, 4);
WriteToBuffer(&tempWrite, &size, 4);
WriteToBuffer(&tempWrite, data, size);
// Final atomic update
writeIndex = tempWrite;
return true;
}
bool Pop(uint32 &signalID, void* dataBuffer, uint32 &size, uint32 maxSize) {
uint32 read = readIndex;
uint32 write = writeIndex;
if (read == write) return false;
uint32 tempRead = read;
uint32 tempId, tempSize;
ReadFromBuffer(&tempRead, &tempId, 4);
ReadFromBuffer(&tempRead, &tempSize, 4);
if (tempSize > maxSize) {
// Error case: drop data up to writeIndex
readIndex = write;
return false;
}
ReadFromBuffer(&tempRead, dataBuffer, tempSize);
signalID = tempId;
size = tempSize;
readIndex = tempRead;
return true;
}
uint32 Count() {
uint32 read = readIndex;
uint32 write = writeIndex;
if (write >= read) return write - read;
return bufferSize - (read - write);
}
private:
void WriteToBuffer(uint32 *idx, void* src, uint32 count) {
uint8* s = (uint8*)src;
for (uint32 i=0; i<count; i++) {
buffer[*idx] = s[i];
*idx = (*idx + 1) % bufferSize;
}
}
void ReadFromBuffer(uint32 *idx, void* dst, uint32 count) {
uint8* d = (uint8*)dst;
for (uint32 i=0; i<count; i++) {
d[i] = buffer[*idx];
*idx = (*idx + 1) % bufferSize;
}
}
volatile uint32 readIndex;
volatile uint32 writeIndex;
uint32 bufferSize;
uint8 *buffer;
};
}
#endif
-32
View File
@@ -1,32 +0,0 @@
#ifndef DEBUGFASTSCHEDULER_H
#define DEBUGFASTSCHEDULER_H
#include "FastScheduler.h"
#include "DebugService.h"
namespace MARTe {
class DebugFastScheduler : public FastScheduler {
public:
CLASS_REGISTER_DECLARATION()
DebugFastScheduler();
virtual ~DebugFastScheduler();
virtual bool Initialise(StructuredDataI & data);
ErrorManagement::ErrorType Execute(ExecutionInfo &information);
protected:
virtual void CustomPrepareNextState();
private:
ErrorManagement::ErrorType DebugSetupThreadMap();
EmbeddedServiceMethodBinderT<DebugFastScheduler> debugBinder;
DebugService *debugService;
};
}
#endif
-108
View File
@@ -1,108 +0,0 @@
#ifndef DEBUGSERVICE_H
#define DEBUGSERVICE_H
#include "MessageI.h"
#include "StreamString.h"
#include "BasicUDPSocket.h"
#include "BasicTCPSocket.h"
#include "ReferenceContainer.h"
#include "SingleThreadService.h"
#include "EmbeddedServiceMethodBinderI.h"
#include "Object.h"
#include "DebugCore.h"
namespace MARTe {
struct SignalAlias {
StreamString name;
uint32 signalIndex;
};
class DebugService : public ReferenceContainer, public MessageI, public EmbeddedServiceMethodBinderI {
public:
CLASS_REGISTER_DECLARATION()
DebugService();
virtual ~DebugService();
virtual bool Initialise(StructuredDataI & data);
DebugSignalInfo* RegisterSignal(void* memoryAddress, TypeDescriptor type, const char8* name);
void ProcessSignal(DebugSignalInfo* signalInfo, uint32 size);
virtual ErrorManagement::ErrorType Execute(ExecutionInfo & info);
bool IsPaused() const { return isPaused; }
void SetPaused(bool paused) { isPaused = paused; }
static bool GetFullObjectName(const Object &obj, StreamString &fullPath);
uint32 ForceSignal(const char8* name, const char8* valueStr);
uint32 UnforceSignal(const char8* name);
uint32 TraceSignal(const char8* name, bool enable, uint32 decimation = 1);
void Discover(BasicTCPSocket *client);
void ListNodes(const char8* path, BasicTCPSocket *client);
void InfoNode(const char8* path, BasicTCPSocket *client);
private:
void HandleCommand(StreamString cmd, BasicTCPSocket *client);
uint32 ExportTree(ReferenceContainer *container, StreamString &json);
void PatchRegistry();
ErrorManagement::ErrorType Server(ExecutionInfo & info);
ErrorManagement::ErrorType Streamer(ExecutionInfo & info);
uint16 controlPort;
uint16 streamPort;
StreamString streamIP;
bool isServer;
bool suppressTimeoutLogs;
volatile bool isPaused;
BasicTCPSocket tcpServer;
BasicUDPSocket udpSocket;
class ServiceBinder : public EmbeddedServiceMethodBinderI {
public:
enum ServiceType { ServerType, StreamerType };
ServiceBinder(DebugService *parent, ServiceType type) : parent(parent), type(type) {}
virtual ErrorManagement::ErrorType Execute(ExecutionInfo & info) {
if (type == StreamerType) return parent->Streamer(info);
return parent->Server(info);
}
private:
DebugService *parent;
ServiceType type;
};
ServiceBinder binderServer;
ServiceBinder binderStreamer;
SingleThreadService threadService;
SingleThreadService streamerService;
ThreadIdentifier serverThreadId;
ThreadIdentifier streamerThreadId;
static const uint32 MAX_SIGNALS = 4096;
DebugSignalInfo signals[MAX_SIGNALS];
uint32 numberOfSignals;
static const uint32 MAX_ALIASES = 8192;
SignalAlias aliases[MAX_ALIASES];
uint32 numberOfAliases;
FastPollingMutexSem mutex;
TraceRingBuffer traceBuffer;
static const uint32 MAX_CLIENTS = 16;
BasicTCPSocket* activeClients[MAX_CLIENTS];
FastPollingMutexSem clientsMutex;
static DebugService* instance;
};
}
#endif
-10
View File
@@ -1,10 +0,0 @@
all: build
build:
mkdir -p Build && cd Build && . ../env.sh && cmake -DCMAKE_BUILD_TYPE=Debug .. && make
ln -sf libmarte_dev.so Build/DebugService.so
clean:
rm -rf Build
.PHONY: all build clean
+26
View File
@@ -0,0 +1,26 @@
#############################################################
#
# Copyright 2015 F4E | European Joint Undertaking for ITER
# and the Development of Fusion Energy ('Fusion for Energy')
#
# Licensed under the EUPL, Version 1.1 or - as soon they
# will be approved by the European Commission - subsequent
# versions of the EUPL (the "Licence");
# You may not use this work except in compliance with the
# Licence.
# You may obtain a copy of the Licence at:
#
# http://ec.europa.eu/idabc/eupl
#
# Unless required by applicable law or agreed to in
# writing, software distributed under the Licence is
# distributed on an "AS IS" basis,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
# express or implied.
# See the Licence for the specific language governing
# permissions and limitations under the Licence.
#
#############################################################
export TARGET=x86-linux
include Makefile.inc
+76
View File
@@ -0,0 +1,76 @@
#############################################################
#
# Copyright 2015 F4E | European Joint Undertaking for ITER
# and the Development of Fusion Energy ('Fusion for Energy')
#
# Licensed under the EUPL, Version 1.1 or - as soon they
# will be approved by the European Commission - subsequent
# versions of the EUPL (the "Licence");
# You may not use this work except in compliance with the
# Licence.
# You may obtain a copy of the Licence at:
#
# http://ec.europa.eu/idabc/eupl
#
# Unless required by applicable law or agreed to in
# writing, software distributed under the Licence is
# distributed on an "AS IS" basis,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
# express or implied.
# See the Licence for the specific language governing
# permissions and limitations under the Licence.
#
# $Id: Makefile.inc 3 2012-01-15 16:26:07Z aneto $
#
#############################################################
#Subprojects w.r.t. the main directory only (important to allow setting SPBM as an export variable).
#If SPB is directly exported as an environment variable it will also be evaluated as part of the subprojects SPB, thus
#potentially overriding its value
#Main target subprojects. May be overridden by shell definition.
SPBM?=Source/Components/Interfaces.x
SPBMT?=Test.x
#This really has to be defined locally.
SUBPROJMAIN=$(SPBM:%.x=%.spb)
SUBPROJMAINTEST=$(SPBMT:%.x=%.spb)
SUBPROJMAINCLEAN=$(SPBM:%.x=%.spc)
SUBPROJMAINTESTCLEAN=$(SPBMT:%.x=%.spc)
MAKEDEFAULTDIR=$(MARTe2_DIR)/MakeDefaults
ROOT_DIR=.
include $(MAKEDEFAULTDIR)/MakeStdLibDefs.$(TARGET)
all: $(OBJS) core test
echo $(OBJS)
compile_commands.json:
bear -- make -f Makefile.gcc
core: $(SUBPROJMAIN) check-env
echo $(SUBPROJMAIN)
test: $(SUBPROJMAINTEST)
echo $(SUBPROJMAINTEST)
clean:: $(SUBPROJMAINCLEAN) $(SUBPROJMAINTESTCLEAN) clean_wipe_old
#clean:: $(SUBPROJMAINCLEAN) $(SUBPROJMAINTESTCLEAN) clean_wipe_old
include $(MAKEDEFAULTDIR)/MakeStdLibRules.$(TARGET)
check-marte:
ifndef MARTe2_DIR
$(error MARTe2_DIR is undefined)
endif
check-env:
ifndef MARTe2_DIR
$(error MARTe2_DIR is undefined)
endif
+88 -29
View File
@@ -1,51 +1,110 @@
# MARTe2 Debug Suite # MARTe2 Debug Suite
An interactive observability and debugging suite for the MARTe2 real-time framework. An interactive observability and debugging suite for the MARTe2 real-time framework. Instruments any running application **without modifying its source code**, providing real-time signal tracing, forced-value injection, breakpoints, execution stepping, and log forwarding.
---
## Quick Start ## Quick Start
### 1. Build the project ### 1. Build
```bash ```bash
. ./env.sh source env.sh
cd Build make -f Makefile.gcc
cmake ..
make -j$(nproc)
``` ```
### 2. Run Integration Tests ### 2. Run Integration Tests
```bash ```bash
./Test/Integration/ValidationTest # Verifies 100Hz tracing source env.sh
./Test/Integration/SchedulerTest # Verifies execution control ./Build/x86-linux/Test/Integration/Integration/IntegrationTests.ex
``` ```
### 3. Launch GUI ### 3. Choose Your Client
**Option A — Web UI (no install required)**
Add `WebDebugService` to your application config and open `http://localhost:8090` in any browser:
```text
+WebDebugService = {
Class = WebDebugService
HttpPort = 8090
}
```
**Option B — Rust Native GUI**
Add `DebugService` to your application config, then launch the GUI:
```bash ```bash
cd Tools/gui_client cd Tools/gui_client
cargo run --release cargo run --release
``` ```
## Features
- **Live Tree:** Explore the MARTe2 object database in real-time.
- **Oscilloscope:** Trace any signal at high frequency (100Hz+) with automatic scaling.
- **Signal Forcing:** Inject values directly into the real-time memory map.
- **Log Forwarding:** Integrated framework log viewer with regex filtering.
- **Execution Control:** Global pause/resume via scheduler-level hooks.
## Usage
To enable debugging in your application, add the following to your `.cfg`:
```text ```text
+DebugService = { +DebugService = {
Class = DebugService Class = DebugService
ControlPort = 8080 ControlPort = 8080
UdpPort = 8081 UdpPort = 8081
} LogPort = 8082
+LoggerService = {
Class = LoggerService
+DebugConsumer = {
Class = TcpLogger
Port = 8082
}
} }
``` ```
The suite automatically patches the registry to instrument your existing Brokers and Schedulers.
---
## Features
| Feature | Description |
|---|---|
| **Zero-code-change** | Registry patching replaces standard brokers at runtime — no application changes needed |
| **Signal tracing** | Stream any signal at full RT rate over UDP (DebugService) or SSE (WebDebugService) |
| **Signal forcing** | Persistent value injection directly into the RT memory map |
| **Breakpoints** | Halt execution when a signal crosses a threshold (`> < == >= <= !=`) |
| **Execution stepping** | Step N RT cycles then pause; optionally filter by thread |
| **Live object tree** | Browse the full `ObjectRegistryDatabase` hierarchy with signal metadata |
| **Config serving** | Retrieve the complete application CDB as JSON |
| **Log forwarding** | All `REPORT_ERROR` events forwarded to the client in real time |
| **Signal monitoring** | Poll any `DataSourceI` signal at a configurable period |
| **MARTe2 messaging** | Send `Message` objects to any ORD object from the debug client |
---
## Transports at a Glance
| | `DebugService` | `WebDebugService` |
|---|---|---|
| **Client** | Rust native GUI or any TCP tool | Any web browser |
| **Commands** | Text over TCP (port 8080) | HTTP POST `/api/command` |
| **Telemetry** | Binary UDP (port 8081) | Server-Sent Events `/api/events` |
| **Logs** | TcpLogger TCP (port 8082) | SSE event stream |
| **Install** | Rust + Cargo | None |
Both transports implement the same `DebugServiceI` interface and register themselves as the global singleton — they are mutually exclusive (one per application).
---
## Repository Layout
```
Source/
Core/Types/
Vec/ — RT-safe dynamic array (no STL)
Result/ — Error-carrying return type
Components/Interfaces/
DebugService/
DebugCore.h — DebugSignalInfo, TraceRingBuffer, break op codes
DebugServiceI.h — Abstract interface + SignalAlias, BrokerInfo structs
DebugBrokerWrapper.h — Broker wrapper templates + registry builder helpers
DebugService.h/.cpp — TCP/UDP implementation
WebDebugService/
WebUI.h — Embedded single-page HTML/CSS/JS application
WebDebugService.h/.cpp — HTTP/SSE implementation
TCPLogger/
TcpLogger.h/.cpp — LoggerConsumerI forwarding logs to TCP clients
Test/
Integration/ — Integration test suite (180 s SIGALRM guard)
UnitTests/ — Unit test suite (COVERAGE V34)
Tools/
gui_client/ — Rust/egui native GUI (DebugService transport only)
```
+138 -17
View File
@@ -1,24 +1,145 @@
# MARTe2 Debug Suite Specifications # MARTe2 Debug Suite Specifications
## 1. Goal **Version:** 2.0
Implement a "Zero-Code-Change" observability layer for the MARTe2 real-time framework, providing live telemetry, signal forcing, and execution control without modifying existing application source code. **Status:** Active / Implemented
## 2. Requirements ---
### 2.1 Functional Requirements (FR)
- **FR-01 (Discovery):** Discover the full MARTe2 object hierarchy at runtime. ## 1. Executive Summary
- **FR-02 (Telemetry):** Stream high-frequency signal data (verified up to 100Hz) to a remote client.
This project implements a "Zero-Code-Change" observability and debugging layer for the
MARTe2 real-time framework. Developers can trace, force, and monitor any signal in a
running MARTe2 application without modifying existing source code.
The suite ships two interchangeable transport backends sharing a common abstract interface:
- **`DebugService`** — TCP command channel + binary UDP telemetry + `TcpLogger` sidecar.
Paired with a native Rust/egui GUI.
- **`WebDebugService`** — HTTP command endpoint + Server-Sent Events telemetry, with an
embedded single-page browser UI. No additional client software required.
---
## 2. System Architecture
- **`DebugServiceI` (Abstract Interface):** Singleton that decouples the broker injection
layer from the transport. Defined in `DebugServiceI.h`.
- **`DebugService` (TCP/UDP Transport):** TCP text command channel (port 8080), binary UDP
telemetry (port 8081), `TcpLogger` log sidecar (port 8082).
- **`WebDebugService` (HTTP/SSE Transport):** Single HTTP port (default 8090) serving the
embedded web UI, command API, and SSE telemetry stream.
- **`DebugBrokerWrapper` (Injection Layer):** C++ template wrappers injected via registry
patching. Depend only on `DebugServiceI`; transport-agnostic.
- **`TcpLogger` (Log Sidecar):** Optional standalone component forwarding `REPORT_ERROR`
events to TCP clients on a dedicated port (used with `DebugService` only).
---
## 3. Requirements
### 3.1 Functional Requirements (FR)
- **FR-01 (Discovery):** Discover the full MARTe2 object hierarchy at runtime. The client
SHALL request the full application tree and display it hierarchically.
- **FR-02 (Telemetry):** Stream high-frequency signal data (verified > 100 Hz) to a remote
client. `DebugService` uses binary UDP; `WebDebugService` uses SSE.
- **FR-03 (Forcing):** Allow manual override of signal values in memory during execution. - **FR-03 (Forcing):** Allow manual override of signal values in memory during execution.
- **FR-04 (Logs):** Stream global framework logs to a dedicated terminal via a standalone `TcpLogger` service. The override SHALL persist across RT cycles until explicitly released.
- **FR-05 (Execution Control):** Pause and resume the real-time execution threads via scheduler injection. - **FR-04 (Logs):** Forward all `REPORT_ERROR` events to a connected client in real time.
- **FR-06 (UI):** Provide a native, immediate-mode GUI for visualization (Oscilloscope). `DebugService` uses `TcpLogger` on a dedicated TCP port. `WebDebugService` embeds logs
in the SSE stream.
- **FR-05 (Log Filtering):** The client SHOULD support filtering log output by level and
by content.
- **FR-06 (Execution Control):** Provide pause and resume for all patched RT threads,
allowing static inspection of the system state.
- **FR-07 (Breakpoints):** Halt execution when a signal crosses a threshold. Supported
operators: `>`, `<`, `==`, `>=`, `<=`, `!=`.
- **FR-08 (Execution Stepping):** After a pause or breakpoint, allow resuming for exactly
N output-broker cycles then pausing again. Optional per-thread filter.
- **FR-09 (Decoupled Tracing):** Activating a trace SHALL only stream data; displaying
the data (plot, sidebar) is the client's responsibility.
- **FR-10 (Signal Monitoring):** Poll any `DataSourceI` signal at a configurable period
without requiring that signal to be traced at full RT rate.
- **FR-11 (Config Awareness):** The service SHALL accept and store a full copy of the
application's CDB (`SetFullConfig`). `INFO` and `DISCOVER` responses SHALL be enriched
with additional metadata fields from this CDB.
- **FR-12 (Config Serving):** Provide a `CONFIG` command returning the full stored
configuration as JSON.
- **FR-13 (MARTe2 Messaging):** Allow sending `Message` objects to any ORD object via an
`MSG` command.
- **FR-14 (Dual Transport):** Both `DebugService` and `WebDebugService` SHALL implement
the identical `DebugServiceI` interface and be mutually exclusive singletons. Switching
transport SHALL require only a config change (different class name, different port).
- **FR-15 (Embedded Web UI):** `WebDebugService` SHALL serve a self-contained single-page
application with real-time plotting (Chart.js), signal tree, force/break/monitor dialogs,
and an integrated log viewer — without any external server or build tooling.
### 3.2 Technical Constraints (TC)
### 2.2 Technical Constraints (TC)
- **TC-01:** No modifications allowed to the MARTe2 core library or component source code. - **TC-01:** No modifications allowed to the MARTe2 core library or component source code.
- **TC-02:** Instrumentation must use Runtime Class Registry Patching. - **TC-02:** Instrumentation MUST use runtime class registry patching (`ClassRegistryDatabase`).
- **TC-03:** Real-time threads must remain lock-free; use `FastPollingMutexSem` or atomic operations for synchronization. - **TC-03:** RT-path methods (`ProcessSignal`, `IsPaused`) MUST be lock-free or use only
- **TC-04:** Telemetry must be delivered via UDP to minimize impact on real-time jitter. `FastPollingMutexSem`; no heap allocation on the RT path.
- **TC-04:** `DebugService` telemetry MUST use UDP to minimise jitter impact.
- **TC-05:** No STL — use `Vec<T>` and `StreamString` throughout.
- **TC-06:** C++98 compatibility for all source files (no `auto`, no range-for, no raw
string literals).
- **TC-07:** The `DebugServiceI` abstract interface MUST be the only dependency of
`DebugBrokerWrapper`. Concrete transport headers MUST NOT be included by broker code.
## 3. Performance Metrics ---
- **Latency:** Telemetry dispatch overhead < 5 microseconds per signal.
- **Throughput:** Support for 100Hz+ sampling rates with zero packet loss on local networks. ## 4. Performance Requirements
- **Scalability:** Handle up to 4096 unique signals and 16 simultaneous client connections.
- **Latency:** `ProcessSignal` overhead < 5 µs per signal when tracing is inactive.
- **Throughput:** Support > 100 Hz signal tracing with zero sample loss on local networks
(UDP transport).
- **Scalability:** Handle up to 4096 unique signals.
- **Ring buffer size:** `TraceRingBuffer` initialised to 4 MB in both transports.
- **SSE clients:** `WebDebugService` supports up to 8 simultaneous SSE clients.
- **TCP rate limit:** Server disconnects clients sending > 100 commands/s.
- **VALUE output cap:** `GetSignalValue` returns at most 256 elements per call.
---
## 5. Performance Hardening Log
| Fix | Category | Description |
|---|---|---|
| **#1** | Naming | `STREAMER_MTU = 1400`, `STREAMER_BUFFER_SIZE = 4096` replace magic numbers |
| **#2** | Concurrency | `tracePushMutex` serialises multi-producer `TraceRingBuffer::Push()` |
| **#3** | Concurrency | Break indices copied under `activeMutex`; condition evaluated outside lock |
| **#4** | Concurrency | `Atomic::Add` for lock-free per-signal decimation counter |
| **#5** | Robustness | `TraceRingBuffer::Pop` skips corrupt entry; full discard only when unrecoverable |
| **#6** | Security | TCP command rate-limit: > 100 cmd/s → client disconnect |
| **#7** | Latency | `Vec::Swap` inside spinlock; deallocation outside — shorter lock hold time |
| **#8** | Robustness | 30-second idle timeout on active TCP client |
| **#9** | Safety | `VALUE` output capped at 256 elements; `"truncated":true` flag included |
| **#10** | Correctness | `inputBuffer` reassembles split TCP commands; bounded at 8 KiB |
| **#11** | Correctness | `Initialise()` never calls `MoveToRoot()` on the framework-supplied CDB |
---
## 6. Command Protocol Summary
| Command | Transport | Description |
|---|---|---|
| `DISCOVER` | Both | Full signal list with metadata |
| `TREE` | Both | Live ORD hierarchy as JSON |
| `INFO <path>` | Both | Node metadata enriched from CDB |
| `LS [path]` | Both | Immediate children of ORD node |
| `TRACE <name> <0\|1> [dec]` | Both | Enable/disable signal tracing |
| `FORCE <name> <value>` | Both | Persistent signal value injection |
| `UNFORCE <name>` | Both | Remove forced value |
| `BREAK <name> <op> <thr>` | Both | Set conditional breakpoint |
| `BREAK <name> OFF` | Both | Clear breakpoint |
| `PAUSE` | Both | Halt all RT threads |
| `RESUME` | Both | Release paused RT threads |
| `STEP <n> [thread]` | Both | Run N cycles then pause |
| `STEP_STATUS` | Both | Query pause/step state |
| `VALUE <name>` | Both | Read current signal value |
| `MONITOR SIGNAL <name> <ms>` | Both | Register slow-rate polling |
| `UNMONITOR SIGNAL <name>` | Both | Stop slow-rate polling |
| `CONFIG` | Both | Full CDB as JSON |
| `MSG <obj> <fn> [k=v …]` | Both | Send MARTe2 Message |
| `SERVICE_INFO` | Both | Transport metadata |
@@ -0,0 +1,590 @@
#ifndef DEBUGBROKERWRAPPER_H
#define DEBUGBROKERWRAPPER_H
#include "BrokerI.h"
#include "DataSourceI.h"
#include "DebugServiceI.h"
#include "FastPollingMutexSem.h"
#include "HighResolutionTimer.h"
#include "MemoryMapBroker.h"
#include "ObjectBuilder.h"
#include "ObjectRegistryDatabase.h"
#include "Threads.h"
// Original broker headers
#include "MemoryMapAsyncOutputBroker.h"
#include "MemoryMapAsyncTriggerOutputBroker.h"
#include "MemoryMapInputBroker.h"
#include "MemoryMapInterpolatedInputBroker.h"
#include "MemoryMapMultiBufferInputBroker.h"
#include "MemoryMapMultiBufferOutputBroker.h"
#include "MemoryMapOutputBroker.h"
#include "MemoryMapSynchronisedInputBroker.h"
#include "MemoryMapSynchronisedMultiBufferInputBroker.h"
#include "MemoryMapSynchronisedMultiBufferOutputBroker.h"
#include "MemoryMapSynchronisedOutputBroker.h"
namespace MARTe {
// Recursive search for any object with a given name anywhere in the registry.
// Used to find GAMs regardless of nesting level.
static Reference FindByNameRecursive(ReferenceContainer *container,
const char8 *name) {
if (container == NULL_PTR(ReferenceContainer *))
return Reference();
uint32 n = container->Size();
for (uint32 i = 0; i < n; i++) {
Reference child = container->Get(i);
if (!child.IsValid())
continue;
if (StringHelper::Compare(child->GetName(), name) == 0)
return child;
ReferenceContainer *sub =
dynamic_cast<ReferenceContainer *>(child.operator->());
if (sub != NULL_PTR(ReferenceContainer *)) {
Reference found = FindByNameRecursive(sub, name);
if (found.IsValid())
return found;
}
}
return Reference();
}
/**
* @brief Helper for optimized signal processing within brokers.
*/
class DebugBrokerHelper {
public:
// Evaluate a break condition against the current live value of a signal.
// Returns true if the condition is met and execution should be paused.
// Only called when signal->breakOp != BREAK_OFF; reads memoryAddress directly.
static bool EvaluateBreak(const DebugSignalInfo *s) {
if (s->memoryAddress == NULL_PTR(void *)) return false;
float64 val = 0.0;
const TypeDescriptor &t = s->type;
if (t == Float64Bit) val = *static_cast<const float64 *>(s->memoryAddress);
else if (t == Float32Bit) val = *static_cast<const float32 *>(s->memoryAddress);
else if (t == UnsignedInteger32Bit) val = *static_cast<const uint32 *>(s->memoryAddress);
else if (t == SignedInteger32Bit) val = *static_cast<const int32 *>(s->memoryAddress);
else if (t == UnsignedInteger64Bit) val = static_cast<float64>(*static_cast<const uint64 *>(s->memoryAddress));
else if (t == SignedInteger64Bit) val = static_cast<float64>(*static_cast<const int64 *>(s->memoryAddress));
else if (t == UnsignedInteger16Bit) val = *static_cast<const uint16 *>(s->memoryAddress);
else if (t == SignedInteger16Bit) val = *static_cast<const int16 *>(s->memoryAddress);
else if (t == UnsignedInteger8Bit) val = *static_cast<const uint8 *>(s->memoryAddress);
else if (t == SignedInteger8Bit) val = *static_cast<const int8 *>(s->memoryAddress);
else return false; // unsupported type — skip
const float64 thr = s->breakThreshold;
switch (s->breakOp) {
case BREAK_GT: return val > thr;
case BREAK_LT: return val < thr;
case BREAK_EQ: return val == thr;
case BREAK_GEQ: return val >= thr;
case BREAK_LEQ: return val <= thr;
case BREAK_NEQ: return val != thr;
default: return false;
}
}
// Spin-wait point for output brokers — called from Execute() AFTER Process().
// Spins while paused, then consumes one step counter tick (if stepping).
// Input brokers must NOT call this — they complete normally to avoid blocking
// cross-thread EventSem posts (RealTimeThreadSynchBroker would time out).
static void OutputPauseAndStep(DebugServiceI *service, const char8 *gamName) {
if (service == NULL_PTR(DebugServiceI *)) return;
// Fast path: nothing to do when neither paused nor stepping.
// Avoids Threads::Name() lookup (and its mutex) on every 1000 Hz cycle.
if (!service->IsPaused() && !service->IsStepPending()) return;
// Wait if already paused (manual PAUSE or breakpoint from a previous cycle)
while (service->IsPaused()) Sleep::MSec(10);
// Pass the OS thread name so per-thread step filtering works.
const char8 *tName = Threads::Name(Threads::Id());
service->ConsumeStepIfNeeded(gamName, tName);
while (service->IsPaused()) Sleep::MSec(10);
}
static void Process(DebugServiceI *service,
DebugSignalInfo **signalInfoPointers,
Vector<uint32> &activeIndices, Vector<uint32> &activeSizes,
FastPollingMutexSem &activeMutex,
volatile bool *anyBreakFlag,
Vector<uint32> *breakIndices) {
if (service == NULL_PTR(DebugServiceI *))
return;
// NOTE: No spin here. Spinning for paused state is handled in Execute() of
// OUTPUT brokers only (see OutputPauseAndStep). Input brokers must not block
// because that prevents cross-thread EventSem posts from completing.
activeMutex.FastLock();
uint32 n = activeIndices.GetNumberOfElements();
if (n > 0 && signalInfoPointers != NULL_PTR(DebugSignalInfo **)) {
// Capture timestamp ONCE per broker cycle for lowest impact
uint64 ts = (uint64)((float64)HighResolutionTimer::Counter() *
HighResolutionTimer::Period() * 1.0e9);
for (uint32 i = 0; i < n; i++) {
uint32 idx = activeIndices[i];
uint32 size = activeSizes[i];
DebugSignalInfo *s = signalInfoPointers[idx];
if (s != NULL_PTR(DebugSignalInfo *)) {
service->ProcessSignal(s, size, ts);
}
}
}
// FIX #3: copy break indices under lock into a local stack array, then
// release activeMutex BEFORE evaluating. EvaluateBreak reads signal
// memory which can stall (cache miss); holding activeMutex during that
// stall would block UpdateBrokersBreakStatus() in the Server thread and
// cause unnecessary priority inversion on the RT path.
bool shouldCheckBreak = (*anyBreakFlag && !service->IsPaused() &&
breakIndices != NULL_PTR(Vector<uint32> *) &&
signalInfoPointers != NULL_PTR(DebugSignalInfo **));
static const uint32 MAX_BREAK_INDICES = 64u;
uint32 localBreakIdx[MAX_BREAK_INDICES];
uint32 nb = 0u;
if (shouldCheckBreak) {
nb = breakIndices->GetNumberOfElements();
if (nb > MAX_BREAK_INDICES) nb = MAX_BREAK_INDICES;
for (uint32 i = 0; i < nb; i++) {
localBreakIdx[i] = (*breakIndices)[i];
}
}
activeMutex.FastUnLock();
// Evaluate break conditions outside the lock — safe because
// EvaluateBreak only reads signalInfoPointers[idx]->memoryAddress,
// which is RT data-bus memory and is never freed during the RT cycle.
if (shouldCheckBreak && nb > 0u) {
for (uint32 i = 0; i < nb; i++) {
uint32 idx = localBreakIdx[i];
DebugSignalInfo *s = signalInfoPointers[idx];
if (s != NULL_PTR(DebugSignalInfo *) && s->breakOp != BREAK_OFF &&
EvaluateBreak(s)) {
service->SetPaused(true);
break;
}
}
}
}
// Pass numCopies explicitly so we can mock it
static void
InitSignals(BrokerI *broker, DataSourceI &dataSourceIn,
DebugServiceI *&service, DebugSignalInfo **&signalInfoPointers,
uint32 numCopies, MemoryMapBrokerCopyTableEntry *copyTable,
const char8 *functionName, SignalDirection direction,
volatile bool *anyActiveFlag, Vector<uint32> *activeIndices,
Vector<uint32> *activeSizes, FastPollingMutexSem *activeMutex,
volatile bool *anyBreakFlag, Vector<uint32> *breakIndices) {
if (numCopies > 0) {
signalInfoPointers = new DebugSignalInfo *[numCopies];
for (uint32 i = 0; i < numCopies; i++)
signalInfoPointers[i] = NULL_PTR(DebugSignalInfo *);
}
// Use the singleton registered by DebugService::Initialise() — no ORD
// search on the Init path, and no dependency on a concrete type.
service = DebugServiceI::GetInstance();
if (service && (copyTable != NULL_PTR(MemoryMapBrokerCopyTableEntry *))) {
StreamString dsPath;
DebugServiceI::GetFullObjectName(dataSourceIn, dsPath);
fprintf(stderr, ">> %s broker for %s [%d]\n",
direction == InputSignals ? "Input" : "Output", dsPath.Buffer(),
numCopies);
MemoryMapBroker *mmb = dynamic_cast<MemoryMapBroker *>(broker);
if (mmb == NULL_PTR(MemoryMapBroker *)) {
fprintf(stderr, ">> Impossible to get broker pointer!!\n");
}
for (uint32 i = 0; i < numCopies; i++) {
void *addr = copyTable[i].dataSourcePointer;
TypeDescriptor type = copyTable[i].type;
uint32 dsIdx = i;
if (mmb != NULL_PTR(MemoryMapBroker *)) {
dsIdx = mmb->GetDSCopySignalIndex(i);
}
StreamString signalName;
if (!dataSourceIn.GetSignalName(dsIdx, signalName))
signalName = "Unknown";
fprintf(stderr, ">> registering %s.%s [%p]\n", dsPath.Buffer(),
signalName.Buffer(), mmb);
uint8 dims = 0;
uint32 elems = 1;
(void)dataSourceIn.GetSignalNumberOfDimensions(dsIdx, dims);
(void)dataSourceIn.GetSignalNumberOfElements(dsIdx, elems);
// Register canonical name
StreamString dsFullName;
dsFullName.Printf("%s.%s", dsPath.Buffer(), signalName.Buffer());
service->RegisterSignal(addr, type, dsFullName.Buffer(), dims, elems);
// Register alias
if (functionName != NULL_PTR(const char8 *)) {
StreamString gamFullName;
const char8 *dirStr =
(direction == InputSignals) ? "InputSignals" : "OutputSignals";
const char8 *dirStrShort = (direction == InputSignals) ? "In" : "Out";
// Search recursively through the entire registry for the GAM by name.
// Direct Find("GAM1") only checks top-level; the GAM may be nested
// several levels deep inside a RealTimeApplication container.
Reference gamRef =
FindByNameRecursive(ObjectRegistryDatabase::Instance(),
functionName);
fprintf(stderr, ">> GAM lookup '%s': %s\n", functionName,
gamRef.IsValid() ? "FOUND" : "NOT FOUND");
if (gamRef.IsValid()) {
StreamString absGamPath;
DebugServiceI::GetFullObjectName(*(gamRef.operator->()), absGamPath);
// Register short path (In/Out) for GUI compatibility
gamFullName.Printf("%s.%s.%s", absGamPath.Buffer(), dirStrShort,
signalName.Buffer());
signalInfoPointers[i] =
service->RegisterSignal(addr, type, gamFullName.Buffer(), dims, elems);
} else {
// Fallback to short form
gamFullName.Printf("%s.%s.%s", functionName, dirStrShort,
signalName.Buffer());
signalInfoPointers[i] =
service->RegisterSignal(addr, type, gamFullName.Buffer(), dims, elems);
}
} else {
signalInfoPointers[i] =
service->RegisterSignal(addr, type, dsFullName.Buffer(), dims, elems);
}
}
// Register broker in DebugService for optimized control
bool isOutputBroker = (direction == OutputSignals);
service->RegisterBroker(signalInfoPointers, numCopies, mmb, anyActiveFlag,
activeIndices, activeSizes, activeMutex,
anyBreakFlag, breakIndices,
(functionName != NULL_PTR(const char8 *)) ? functionName : dsPath.Buffer(),
isOutputBroker);
}
}
};
/**
* @brief Template class to instrument any MARTe2 Broker.
*/
template <typename BaseClass> class DebugBrokerWrapper : public BaseClass {
public:
DebugBrokerWrapper() : BaseClass() {
service = NULL_PTR(DebugServiceI *);
signalInfoPointers = NULL_PTR(DebugSignalInfo **);
numSignals = 0;
anyActive = false;
anyBreakActive = false;
isOutput = false;
gamName[0] = '\0';
}
virtual ~DebugBrokerWrapper() {
if (signalInfoPointers)
delete[] signalInfoPointers;
}
virtual bool Execute() {
bool ret = BaseClass::Execute();
if (ret && (anyActive || anyBreakActive)) {
DebugBrokerHelper::Process(service, signalInfoPointers, activeIndices,
activeSizes, activeMutex,
&anyBreakActive, &breakIndices);
}
// Output brokers are the safe pause point: base Execute has already
// committed data / posted any cross-thread EventSems.
if (ret && isOutput) {
DebugBrokerHelper::OutputPauseAndStep(service, gamName);
}
return ret;
}
virtual bool Init(SignalDirection direction, DataSourceI &ds,
const char8 *const name, void *gamMem) {
bool ret = BaseClass::Init(direction, ds, name, gamMem);
fprintf(stderr, ">> INIT BROKER %s %s\n", name,
direction == InputSignals ? "In" : "Out");
if (ret) {
numSignals = this->GetNumberOfCopies();
isOutput = (direction == OutputSignals);
StringHelper::CopyN(gamName, name, 255u);
DebugBrokerHelper::InitSignals(this, ds, service, signalInfoPointers,
numSignals, this->copyTable, name,
direction, &anyActive, &activeIndices,
&activeSizes, &activeMutex,
&anyBreakActive, &breakIndices);
}
return ret;
}
virtual bool Init(SignalDirection direction, DataSourceI &ds,
const char8 *const name, void *gamMem, const bool optim) {
bool ret = BaseClass::Init(direction, ds, name, gamMem, false);
fprintf(stderr, ">> INIT optimized BROKER %s %s\n", name,
direction == InputSignals ? "In" : "Out");
if (ret) {
numSignals = this->GetNumberOfCopies();
isOutput = (direction == OutputSignals);
StringHelper::CopyN(gamName, name, 255u);
DebugBrokerHelper::InitSignals(this, ds, service, signalInfoPointers,
numSignals, this->copyTable, name,
direction, &anyActive, &activeIndices,
&activeSizes, &activeMutex,
&anyBreakActive, &breakIndices);
}
return ret;
}
DebugServiceI *service;
DebugSignalInfo **signalInfoPointers;
uint32 numSignals;
volatile bool anyActive;
volatile bool anyBreakActive;
bool isOutput;
char8 gamName[256];
Vector<uint32> activeIndices;
Vector<uint32> activeSizes;
Vector<uint32> breakIndices;
FastPollingMutexSem activeMutex;
};
template <typename BaseClass>
class DebugBrokerWrapperNoOptim : public BaseClass {
public:
DebugBrokerWrapperNoOptim() : BaseClass() {
service = NULL_PTR(DebugServiceI *);
signalInfoPointers = NULL_PTR(DebugSignalInfo **);
numSignals = 0;
anyActive = false;
anyBreakActive = false;
isOutput = false;
gamName[0] = '\0';
}
virtual ~DebugBrokerWrapperNoOptim() {
if (signalInfoPointers)
delete[] signalInfoPointers;
}
virtual bool Execute() {
bool ret = BaseClass::Execute();
if (ret && (anyActive || anyBreakActive)) {
DebugBrokerHelper::Process(service, signalInfoPointers, activeIndices,
activeSizes, activeMutex,
&anyBreakActive, &breakIndices);
}
if (ret && isOutput) {
DebugBrokerHelper::OutputPauseAndStep(service, gamName);
}
return ret;
}
virtual bool Init(SignalDirection direction, DataSourceI &ds,
const char8 *const name, void *gamMem) {
bool ret = BaseClass::Init(direction, ds, name, gamMem);
if (ret) {
numSignals = this->GetNumberOfCopies();
isOutput = (direction == OutputSignals);
StringHelper::CopyN(gamName, name, 255u);
DebugBrokerHelper::InitSignals(this, ds, service, signalInfoPointers,
numSignals, this->copyTable, name,
direction, &anyActive, &activeIndices,
&activeSizes, &activeMutex,
&anyBreakActive, &breakIndices);
}
return ret;
}
DebugServiceI *service;
DebugSignalInfo **signalInfoPointers;
uint32 numSignals;
volatile bool anyActive;
volatile bool anyBreakActive;
bool isOutput;
char8 gamName[256];
Vector<uint32> activeIndices;
Vector<uint32> activeSizes;
Vector<uint32> breakIndices;
FastPollingMutexSem activeMutex;
};
class DebugMemoryMapAsyncOutputBroker : public MemoryMapAsyncOutputBroker {
public:
DebugMemoryMapAsyncOutputBroker() : MemoryMapAsyncOutputBroker() {
service = NULL_PTR(DebugServiceI *);
signalInfoPointers = NULL_PTR(DebugSignalInfo **);
numSignals = 0;
anyActive = false;
anyBreakActive = false;
gamName[0] = '\0';
}
virtual ~DebugMemoryMapAsyncOutputBroker() {
if (signalInfoPointers)
delete[] signalInfoPointers;
}
virtual bool Execute() {
bool ret = MemoryMapAsyncOutputBroker::Execute();
if (ret && (anyActive || anyBreakActive)) {
DebugBrokerHelper::Process(service, signalInfoPointers, activeIndices,
activeSizes, activeMutex,
&anyBreakActive, &breakIndices);
}
// Async output brokers are always output direction
if (ret) {
DebugBrokerHelper::OutputPauseAndStep(service, gamName);
}
return ret;
}
virtual bool InitWithBufferParameters(const SignalDirection direction,
DataSourceI &dataSourceIn,
const char8 *const functionName,
void *const gamMemoryAddress,
const uint32 numberOfBuffersIn,
const ProcessorType &cpuMaskIn,
const uint32 stackSizeIn) {
bool ret = MemoryMapAsyncOutputBroker::InitWithBufferParameters(
direction, dataSourceIn, functionName, gamMemoryAddress,
numberOfBuffersIn, cpuMaskIn, stackSizeIn);
if (ret) {
numSignals = this->GetNumberOfCopies();
StringHelper::CopyN(gamName, (functionName != NULL_PTR(const char8 *)) ? functionName : "", 255u);
DebugBrokerHelper::InitSignals(
this, dataSourceIn, service, signalInfoPointers, numSignals,
this->copyTable, functionName, direction, &anyActive, &activeIndices,
&activeSizes, &activeMutex, &anyBreakActive, &breakIndices);
}
return ret;
}
DebugServiceI *service;
DebugSignalInfo **signalInfoPointers;
uint32 numSignals;
volatile bool anyActive;
volatile bool anyBreakActive;
char8 gamName[256];
Vector<uint32> activeIndices;
Vector<uint32> activeSizes;
Vector<uint32> breakIndices;
FastPollingMutexSem activeMutex;
};
class DebugMemoryMapAsyncTriggerOutputBroker
: public MemoryMapAsyncTriggerOutputBroker {
public:
DebugMemoryMapAsyncTriggerOutputBroker()
: MemoryMapAsyncTriggerOutputBroker() {
service = NULL_PTR(DebugServiceI *);
signalInfoPointers = NULL_PTR(DebugSignalInfo **);
numSignals = 0;
anyActive = false;
anyBreakActive = false;
gamName[0] = '\0';
}
virtual ~DebugMemoryMapAsyncTriggerOutputBroker() {
if (signalInfoPointers)
delete[] signalInfoPointers;
}
virtual bool Execute() {
bool ret = MemoryMapAsyncTriggerOutputBroker::Execute();
if (ret && (anyActive || anyBreakActive)) {
DebugBrokerHelper::Process(service, signalInfoPointers, activeIndices,
activeSizes, activeMutex,
&anyBreakActive, &breakIndices);
}
if (ret) {
DebugBrokerHelper::OutputPauseAndStep(service, gamName);
}
return ret;
}
virtual bool InitWithTriggerParameters(
const SignalDirection direction, DataSourceI &dataSourceIn,
const char8 *const functionName, void *const gamMemoryAddress,
const uint32 numberOfBuffersIn, const uint32 preTriggerBuffersIn,
const uint32 postTriggerBuffersIn, const ProcessorType &cpuMaskIn,
const uint32 stackSizeIn) {
bool ret = MemoryMapAsyncTriggerOutputBroker::InitWithTriggerParameters(
direction, dataSourceIn, functionName, gamMemoryAddress,
numberOfBuffersIn, preTriggerBuffersIn, postTriggerBuffersIn, cpuMaskIn,
stackSizeIn);
if (ret) {
numSignals = this->GetNumberOfCopies();
StringHelper::CopyN(gamName, (functionName != NULL_PTR(const char8 *)) ? functionName : "", 255u);
DebugBrokerHelper::InitSignals(
this, dataSourceIn, service, signalInfoPointers, numSignals,
this->copyTable, functionName, direction, &anyActive, &activeIndices,
&activeSizes, &activeMutex, &anyBreakActive, &breakIndices);
}
return ret;
}
DebugServiceI *service;
DebugSignalInfo **signalInfoPointers;
uint32 numSignals;
volatile bool anyActive;
volatile bool anyBreakActive;
char8 gamName[256];
Vector<uint32> activeIndices;
Vector<uint32> activeSizes;
Vector<uint32> breakIndices;
FastPollingMutexSem activeMutex;
};
template <typename T> class DebugBrokerBuilder : public ObjectBuilder {
public:
virtual Object *Build(HeapI *const heap) const { return new (heap) T(); }
};
typedef DebugBrokerWrapper<MemoryMapInputBroker> DebugMemoryMapInputBroker;
// LCOV_EXCL_START
typedef DebugBrokerWrapper<MemoryMapOutputBroker> DebugMemoryMapOutputBroker;
typedef DebugBrokerWrapper<MemoryMapSynchronisedInputBroker>
DebugMemoryMapSynchronisedInputBroker;
typedef DebugBrokerWrapper<MemoryMapSynchronisedOutputBroker>
DebugMemoryMapSynchronisedOutputBroker;
typedef DebugBrokerWrapperNoOptim<MemoryMapInterpolatedInputBroker>
DebugMemoryMapInterpolatedInputBroker;
typedef DebugBrokerWrapper<MemoryMapMultiBufferInputBroker>
DebugMemoryMapMultiBufferInputBroker;
typedef DebugBrokerWrapper<MemoryMapMultiBufferOutputBroker>
DebugMemoryMapMultiBufferOutputBroker;
typedef DebugBrokerWrapper<MemoryMapSynchronisedMultiBufferInputBroker>
DebugMemoryMapSynchronisedMultiBufferInputBroker;
typedef DebugBrokerWrapper<MemoryMapSynchronisedMultiBufferOutputBroker>
DebugMemoryMapSynchronisedMultiBufferOutputBroker;
// LCOV_EXCL_STOP
typedef DebugBrokerBuilder<DebugMemoryMapInputBroker>
DebugMemoryMapInputBrokerBuilder;
// LCOV_EXCL_START
typedef DebugBrokerBuilder<DebugMemoryMapOutputBroker>
DebugMemoryMapOutputBrokerBuilder;
typedef DebugBrokerBuilder<DebugMemoryMapSynchronisedInputBroker>
DebugMemoryMapSynchronisedInputBrokerBuilder;
typedef DebugBrokerBuilder<DebugMemoryMapSynchronisedOutputBroker>
DebugMemoryMapSynchronisedOutputBrokerBuilder;
typedef DebugBrokerBuilder<DebugMemoryMapInterpolatedInputBroker>
DebugMemoryMapInterpolatedInputBrokerBuilder;
typedef DebugBrokerBuilder<DebugMemoryMapMultiBufferInputBroker>
DebugMemoryMapMultiBufferInputBrokerBuilder;
typedef DebugBrokerBuilder<DebugMemoryMapMultiBufferOutputBroker>
DebugMemoryMapMultiBufferOutputBrokerBuilder;
typedef DebugBrokerBuilder<DebugMemoryMapSynchronisedMultiBufferInputBroker>
DebugMemoryMapSynchronisedMultiBufferInputBrokerBuilder;
typedef DebugBrokerBuilder<DebugMemoryMapSynchronisedMultiBufferOutputBroker>
DebugMemoryMapSynchronisedMultiBufferOutputBrokerBuilder;
typedef DebugBrokerBuilder<DebugMemoryMapAsyncOutputBroker>
DebugMemoryMapAsyncOutputBrokerBuilder;
typedef DebugBrokerBuilder<DebugMemoryMapAsyncTriggerOutputBroker>
DebugMemoryMapAsyncTriggerOutputBrokerBuilder;
// LCOV_EXCL_STOP
} // namespace MARTe
#endif
@@ -0,0 +1,188 @@
#ifndef DEBUGCORE_H
#define DEBUGCORE_H
#include "CompilerTypes.h"
#include "TypeDescriptor.h"
#include "StreamString.h"
#include <string.h>
namespace MARTe {
// Break condition operators stored in DebugSignalInfo::breakOp
enum BreakOp {
BREAK_OFF = 0,
BREAK_GT = 1, // >
BREAK_LT = 2, // <
BREAK_EQ = 3, // ==
BREAK_GEQ = 4, // >=
BREAK_LEQ = 5, // <=
BREAK_NEQ = 6 // !=
};
struct DebugSignalInfo {
void* memoryAddress;
TypeDescriptor type;
StreamString name;
uint8 numberOfDimensions;
uint32 numberOfElements;
volatile bool isTracing;
volatile bool isForcing;
uint8 forcedValue[1024];
uint8 forcedMask[32]; // bit e set → element e is forced; supports up to 256 elements
uint32 internalID;
volatile uint32 decimationFactor;
volatile uint32 decimationCounter;
// Conditional break fields (zero-cost when breakOp == BREAK_OFF)
volatile uint8 breakOp; // BreakOp enum value
float64 breakThreshold; // comparison threshold
};
#pragma pack(push, 1)
struct TraceHeader {
uint32 magic; // 0xDA7A57AD
uint32 seq; // Sequence number
uint64 timestamp; // HighRes timestamp
uint32 count; // Number of samples in payload
};
#pragma pack(pop)
/**
* @brief Ring buffer for high-frequency signal tracing.
* @details New format per sample: [ID:4][Timestamp:8][Size:4][Data:N]
*/
class TraceRingBuffer {
public:
TraceRingBuffer() {
bufferSize = 0;
buffer = NULL_PTR(uint8*);
readIndex = 0;
writeIndex = 0;
}
~TraceRingBuffer() {
if (buffer != NULL_PTR(uint8*)) {
delete[] buffer;
}
}
bool Init(uint32 size) {
if (buffer != NULL_PTR(uint8*)) {
delete[] buffer;
}
bufferSize = size;
buffer = new uint8[bufferSize];
readIndex = 0;
writeIndex = 0;
return (buffer != NULL_PTR(uint8*));
}
bool Push(uint32 signalID, uint64 timestamp, void* data, uint32 size) {
uint32 packetSize = 4 + 8 + 4 + size; // ID + TS + Size + Data
uint32 read = readIndex;
uint32 write = writeIndex;
uint32 available = 0;
if (read <= write) {
available = bufferSize - (write - read) - 1;
} else {
available = read - write - 1;
}
if (available < packetSize) return false;
uint32 tempWrite = write;
WriteToBuffer(&tempWrite, &signalID, 4);
WriteToBuffer(&tempWrite, &timestamp, 8);
WriteToBuffer(&tempWrite, &size, 4);
WriteToBuffer(&tempWrite, data, size);
writeIndex = tempWrite;
return true;
}
bool Pop(uint32 &signalID, uint64 &timestamp, void* dataBuffer, uint32 &size, uint32 maxSize) {
uint32 read = readIndex;
uint32 write = writeIndex;
if (read == write) return false;
uint32 tempRead = read;
uint32 tempId = 0;
uint64 tempTs = 0;
uint32 tempSize = 0;
ReadFromBuffer(&tempRead, &tempId, 4);
ReadFromBuffer(&tempRead, &tempTs, 8);
ReadFromBuffer(&tempRead, &tempSize, 4);
if (tempSize > maxSize) {
// FIX #5: Skip only the current entry rather than discarding the
// entire ring buffer. tempRead is already past the 16-byte header;
// advancing by tempSize lands at the start of the next entry.
//
// Safety fallback: if tempSize >= bufferSize the stored size field
// is corrupt (it can never be that large). In that case we cannot
// locate the next entry safely, so fall back to discarding everything
// to avoid reading garbage as sample headers on future Pop() calls.
if (tempSize >= bufferSize) {
readIndex = write; // corrupt ring — discard all
} else {
readIndex = (tempRead + tempSize) % bufferSize;
}
return false;
}
ReadFromBuffer(&tempRead, dataBuffer, tempSize);
signalID = tempId;
timestamp = tempTs;
size = tempSize;
readIndex = tempRead;
return true;
}
uint32 Count() {
uint32 read = readIndex;
uint32 write = writeIndex;
if (write >= read) return write - read;
return bufferSize - (read - write);
}
private:
void WriteToBuffer(uint32 *idx, void* src, uint32 count) {
uint32 current = *idx;
uint32 spaceToEnd = bufferSize - current;
if (count <= spaceToEnd) {
memcpy(&buffer[current], src, count);
*idx = (current + count) % bufferSize;
} else {
memcpy(&buffer[current], src, spaceToEnd);
uint32 remaining = count - spaceToEnd;
memcpy(&buffer[0], (uint8*)src + spaceToEnd, remaining);
*idx = remaining;
}
}
void ReadFromBuffer(uint32 *idx, void* dst, uint32 count) {
uint32 current = *idx;
uint32 spaceToEnd = bufferSize - current;
if (count <= spaceToEnd) {
memcpy(dst, &buffer[current], count);
*idx = (current + count) % bufferSize;
} else {
memcpy(dst, &buffer[current], spaceToEnd);
uint32 remaining = count - spaceToEnd;
memcpy((uint8*)dst + spaceToEnd, &buffer[0], remaining);
*idx = remaining;
}
}
volatile uint32 readIndex;
volatile uint32 writeIndex;
uint32 bufferSize;
uint8 *buffer;
};
}
#endif
@@ -0,0 +1,477 @@
#include "BasicTCPSocket.h"
#include "ConfigurationDatabase.h"
#include "DebugService.h"
#include "GlobalObjectsDatabase.h"
#include "HighResolutionTimer.h"
#include "LoggerService.h"
#include "Message.h"
#include "ObjectRegistryDatabase.h"
#include "ReferenceT.h"
#include "Sleep.h"
#include "StreamString.h"
#include "TcpLogger.h"
#include "Threads.h"
#include "TimeoutType.h"
namespace MARTe {
CLASS_REGISTER(DebugService, "1.0")
// C++98 ODR definitions for static constants
const uint32 DebugService::STREAMER_MTU;
const uint32 DebugService::STREAMER_BUFFER_SIZE;
const uint32 DebugService::CMD_RATE_LIMIT;
const uint32 DebugService::CLIENT_IDLE_TIMEOUT_MS;
const uint32 DebugService::INPUT_BUFFER_MAX;
// Maximum data bytes that fit in one sample entry inside a datagram:
// STREAMER_BUFFER_SIZE(65535) - TraceHeader(20) - entry_header(16) = 65499
static const uint32 MAX_SAMPLE_DATA_SIZE = 65499u;
// ---------------------------------------------------------------------------
// Constructor / Destructor
// ---------------------------------------------------------------------------
DebugService::DebugService()
: DebugServiceBase(),
EmbeddedServiceMethodBinderI(),
binderServer(this, ServiceBinder::ServerType),
binderStreamer(this, ServiceBinder::StreamerType),
threadService(binderServer),
streamerService(binderStreamer) {
controlPort = 0u;
streamPort = 8081u;
logPort = 8082u;
streamIP = "127.0.0.1";
isServer = false;
suppressTimeoutLogs = true;
activeClient = NULL_PTR(BasicTCPSocket *);
streamerPacketOffset = 0u;
streamerSequenceNumber = 0u;
cmdCountInWindow = 0u;
cmdWindowStartMs = 0u;
lastDataTimeMs = 0u;
inputBuffer = "";
}
DebugService::~DebugService() {
if (DebugServiceI::GetInstance() == this) {
DebugServiceI::SetInstance(NULL_PTR(DebugServiceI *));
}
threadService.Stop();
streamerService.Stop();
tcpServer.Close();
udpSocket.Close();
if (activeClient != NULL_PTR(BasicTCPSocket *)) {
activeClient->Close();
delete activeClient;
activeClient = NULL_PTR(BasicTCPSocket *);
}
// signals owned by DebugServiceBase destructor
}
// ---------------------------------------------------------------------------
// Initialise
// ---------------------------------------------------------------------------
bool DebugService::Initialise(StructuredDataI &data) {
if (!ReferenceContainer::Initialise(data)) return false;
uint32 port = 0u;
if (data.Read("ControlPort", port)) {
controlPort = (uint16)port;
} else {
(void)data.Read("TcpPort", port);
controlPort = (uint16)port;
}
if (controlPort > 0u) {
isServer = true;
DebugServiceI::SetInstance(this);
}
port = 8081u;
if (data.Read("StreamPort", port)) {
streamPort = (uint16)port;
} else {
(void)data.Read("UdpPort", port);
streamPort = (uint16)port;
}
port = 8082u;
if (data.Read("LogPort", port)) {
logPort = (uint16)port;
} else {
(void)data.Read("TcpLogPort", port);
logPort = (uint16)port;
}
StreamString tempIP;
if (data.Read("StreamIP", tempIP)) {
streamIP = tempIP;
} else {
streamIP = "127.0.0.1";
}
uint32 suppress = 1u;
if (data.Read("SuppressTimeoutLogs", suppress)) {
suppressTimeoutLogs = (suppress == 1u);
}
// Capture only the local subtree — do NOT call MoveToRoot() on the shared CDB.
(void)data.Copy(fullConfig);
if (isServer) {
if (!traceBuffer.Init(8 * 1024 * 1024)) return false;
PatchRegistry();
ConfigurationDatabase threadData;
threadData.Write("Timeout", (uint32)1000);
threadService.Initialise(threadData);
streamerService.Initialise(threadData);
if (!tcpServer.Open()) return false;
if (!tcpServer.Listen(controlPort)) return false;
if (!udpSocket.Open()) return false;
if (threadService.Start() != ErrorManagement::NoError) return false;
if (streamerService.Start() != ErrorManagement::NoError) return false;
}
return true;
}
// ---------------------------------------------------------------------------
// Transport config hook (called by RebuildConfigFromRegistry in base)
// ---------------------------------------------------------------------------
void DebugService::RebuildTransportConfig() {
const char8 *myName = GetName();
if (myName != NULL_PTR(const char8 *)) {
if (fullConfig.MoveRelative(myName)) {
(void)fullConfig.Write("ControlPort", static_cast<uint32>(controlPort));
(void)fullConfig.Write("UdpPort", static_cast<uint32>(streamPort));
(void)fullConfig.Write("LogPort", static_cast<uint32>(logPort));
if (streamIP.Size() > 0u)
(void)fullConfig.Write("StreamIP", streamIP.Buffer());
(void)fullConfig.MoveToAncestor(1u);
}
}
}
// ---------------------------------------------------------------------------
// SERVICE_INFO hook
// ---------------------------------------------------------------------------
void DebugService::GetServiceInfo(StreamString &out) {
out.Printf("OK SERVICE_INFO TCP_CTRL:%u UDP_STREAM:%u TCP_LOG:%u STATE:%s\n",
controlPort, streamPort, logPort,
isPaused ? "PAUSED" : "RUNNING");
}
// ---------------------------------------------------------------------------
// Execute / HandleMessage (framework boilerplate)
// ---------------------------------------------------------------------------
ErrorManagement::ErrorType DebugService::Execute(ExecutionInfo &info) {
(void)info;
return ErrorManagement::FatalError;
}
ErrorManagement::ErrorType DebugService::HandleMessage(ReferenceT<Message> &data) {
(void)data;
return ErrorManagement::NoError;
}
// ---------------------------------------------------------------------------
// InjectTcpLoggerIfNeeded
// ---------------------------------------------------------------------------
void DebugService::InjectTcpLoggerIfNeeded() {
if (logPort == 0u) return;
Reference existing = ObjectRegistryDatabase::Instance()->Find("LoggerService");
if (existing.IsValid()) {
ReferenceContainer *rc =
dynamic_cast<ReferenceContainer *>(existing.operator->());
if (rc != NULL_PTR(ReferenceContainer *)) {
for (uint32 i = 0u; i < rc->Size(); i++) {
ReferenceT<TcpLogger> child = rc->Get(i);
if (child.IsValid()) return; // already has a TcpLogger
}
}
}
ConfigurationDatabase lsCdb;
(void)lsCdb.Write("Class", "LoggerService");
uint32 cpus = 1u;
(void)lsCdb.Write("CPUs", cpus);
if (lsCdb.CreateRelative("+DebugConsumer")) {
(void)lsCdb.Write("Class", "TcpLogger");
uint32 p = static_cast<uint32>(logPort);
(void)lsCdb.Write("Port", p);
(void)lsCdb.MoveToAncestor(1u);
}
(void)lsCdb.MoveToRoot();
ReferenceT<LoggerService> ls(
"LoggerService", GlobalObjectsDatabase::Instance()->GetStandardHeap());
if (!ls.IsValid()) return;
ls->SetName("LoggerService");
if (!ls->Initialise(lsCdb)) return;
(void)ObjectRegistryDatabase::Instance()->Insert(ls);
}
// ---------------------------------------------------------------------------
// Server thread
// ---------------------------------------------------------------------------
ErrorManagement::ErrorType DebugService::Server(ExecutionInfo &info) {
if (info.GetStage() == ExecutionInfo::TerminationStage)
return ErrorManagement::NoError;
if (info.GetStage() == ExecutionInfo::StartupStage) {
serverThreadId = Threads::Id();
Sleep::MSec(500u);
InjectTcpLoggerIfNeeded();
return ErrorManagement::NoError;
}
uint64 nowMs = (uint64)((float64)HighResolutionTimer::Counter() *
HighResolutionTimer::Period() * 1000.0);
if (activeClient == NULL_PTR(BasicTCPSocket *)) {
BasicTCPSocket *newClient = tcpServer.WaitConnection(TimeoutType(100));
if (newClient != NULL_PTR(BasicTCPSocket *)) {
clientMutex.FastLock();
activeClient = newClient;
clientMutex.FastUnLock();
cmdCountInWindow = 0u;
cmdWindowStartMs = nowMs;
lastDataTimeMs = nowMs;
}
} else {
if (nowMs - lastDataTimeMs > CLIENT_IDLE_TIMEOUT_MS) {
REPORT_ERROR_STATIC(ErrorManagement::Warning,
"Server: TCP client idle for >%u ms — closing connection.",
CLIENT_IDLE_TIMEOUT_MS);
inputBuffer = "";
clientMutex.FastLock();
activeClient->Close();
delete activeClient;
activeClient = NULL_PTR(BasicTCPSocket *);
clientMutex.FastUnLock();
cmdCountInWindow = 0u;
} else if (!activeClient->IsConnected()) {
inputBuffer = "";
clientMutex.FastLock();
activeClient->Close();
delete activeClient;
activeClient = NULL_PTR(BasicTCPSocket *);
clientMutex.FastUnLock();
} else {
char buffer[1024];
uint32 size = 1024u;
if (activeClient->Read(buffer, size)) {
if (size > 0u) {
lastDataTimeMs = nowMs;
if (nowMs - cmdWindowStartMs >= 1000u) {
cmdWindowStartMs = nowMs;
cmdCountInWindow = 0u;
}
if (inputBuffer.Size() + (uint32)size > INPUT_BUFFER_MAX) {
REPORT_ERROR_STATIC(ErrorManagement::Warning,
"Server: input buffer overflow (>%u bytes without newline) "
"— disconnecting.", INPUT_BUFFER_MAX);
inputBuffer = "";
clientMutex.FastLock();
activeClient->Close();
delete activeClient;
activeClient = NULL_PTR(BasicTCPSocket *);
clientMutex.FastUnLock();
cmdCountInWindow = 0u;
} else {
(void)inputBuffer.Seek(inputBuffer.Size());
uint32 writeSize = (uint32)size;
inputBuffer.Write(buffer, writeSize);
const char8 *raw = inputBuffer.Buffer();
uint32 total = (uint32)inputBuffer.Size();
uint32 lineStart = 0u;
bool rateLimitExceeded = false;
for (uint32 pos = 0u; pos < total && !rateLimitExceeded; pos++) {
if (raw[pos] != '\n') continue;
uint32 len = pos - lineStart;
if (len > 0u && raw[lineStart + len - 1u] == '\r') len--;
if (len > 0u) {
cmdCountInWindow++;
if (cmdCountInWindow > CMD_RATE_LIMIT) {
REPORT_ERROR_STATIC(ErrorManagement::Warning,
"Server: client exceeded rate limit (%u cmd/s) "
"— disconnecting.", CMD_RATE_LIMIT);
rateLimitExceeded = true;
break;
}
StreamString command;
uint32 cmdLen = len;
command.Write(raw + lineStart, cmdLen);
// Dispatch via base HandleCommand, write response to socket.
// Loop to handle partial writes for large responses.
StreamString out;
HandleCommand(command, out);
if (out.Size() > 0u) {
const char8 *wPtr = out.Buffer();
uint32 remaining = (uint32)out.Size();
lastDataTimeMs = (uint64)((float64)HighResolutionTimer::Counter() *
HighResolutionTimer::Period() * 1000.0);
while (remaining > 0u) {
uint32 wrote = remaining;
if (!activeClient->Write(wPtr, wrote) || wrote == 0u) {
break;
}
wPtr += wrote;
remaining -= wrote;
lastDataTimeMs = (uint64)((float64)HighResolutionTimer::Counter() *
HighResolutionTimer::Period() * 1000.0);
}
}
}
lineStart = pos + 1u;
}
if (rateLimitExceeded) {
inputBuffer = "";
clientMutex.FastLock();
activeClient->Close();
delete activeClient;
activeClient = NULL_PTR(BasicTCPSocket *);
clientMutex.FastUnLock();
cmdCountInWindow = 0u;
} else {
StreamString newInputBuffer;
if (lineStart < total) {
uint32 remLen = total - lineStart;
newInputBuffer.Write(raw + lineStart, remLen);
}
inputBuffer = newInputBuffer;
}
}
}
} else {
inputBuffer = "";
clientMutex.FastLock();
activeClient->Close();
delete activeClient;
activeClient = NULL_PTR(BasicTCPSocket *);
clientMutex.FastUnLock();
}
}
}
return ErrorManagement::NoError;
}
// ---------------------------------------------------------------------------
// Streamer thread (UDP binary telemetry)
// ---------------------------------------------------------------------------
ErrorManagement::ErrorType DebugService::Streamer(ExecutionInfo &info) {
if (info.GetStage() == ExecutionInfo::TerminationStage)
return ErrorManagement::NoError;
if (info.GetStage() == ExecutionInfo::StartupStage) {
streamerThreadId = Threads::Id();
return ErrorManagement::NoError;
}
InternetHost dest(streamPort, streamIP.Buffer());
(void)udpSocket.SetDestination(dest);
// Poll monitored signals and push to trace ring buffer
uint64 currentTimeMs = (uint64)((float64)HighResolutionTimer::Counter() *
HighResolutionTimer::Period() * 1000.0);
mutex.FastLock();
for (uint32 i = 0u; i < monitoredSignals.GetNumberOfElements(); i++) {
if (currentTimeMs >= (monitoredSignals[i].lastPollTime +
monitoredSignals[i].periodMs)) {
monitoredSignals[i].lastPollTime = currentTimeMs;
uint64 ts = (uint64)((float64)HighResolutionTimer::Counter() *
HighResolutionTimer::Period() * 1000000.0);
void *address = NULL_PTR(void *);
if (monitoredSignals[i].dataSource->GetSignalMemoryBuffer(
monitoredSignals[i].signalIdx, 0u, address)) {
tracePushMutex.FastLock();
traceBuffer.Push(monitoredSignals[i].internalID, ts,
(uint8 *)address, monitoredSignals[i].size);
tracePushMutex.FastUnLock();
}
}
}
mutex.FastUnLock();
// Drain ring buffer into UDP packet(s).
//
// Batching strategy:
// - Normal samples (entry ≤ STREAMER_MTU): accumulate into a packet and
// flush when the next sample would push it past STREAMER_MTU.
// - Oversized samples (entry > STREAMER_MTU): flush any pending packet
// first, then send the oversized sample as its own datagram (up to
// STREAMER_BUFFER_SIZE bytes; handled transparently by IP fragmentation
// on loopback / internal networks).
// - MAX_SAMPLE_DATA_SIZE (65499 bytes) is the hard cap; larger entries
// in the ring buffer are skipped by Pop() and discarded.
bool hasData = false;
uint32 id, size;
uint64 ts;
while (traceBuffer.Pop(id, ts, streamerSampleBuffer, size, MAX_SAMPLE_DATA_SIZE)) {
hasData = true;
const uint32 entryBytes = 16u + size; // [id:4][ts:8][size:4][data:size]
// If this entry would push the current packet past the MTU target,
// flush what we have before appending (unless the buffer is empty).
if (streamerPacketOffset > 0u &&
streamerPacketOffset + entryBytes > STREAMER_MTU) {
uint32 toWrite = streamerPacketOffset;
(void)udpSocket.Write((char8 *)streamerPacketBuffer, toWrite);
streamerPacketOffset = 0u;
}
// Open a new packet header if the buffer is empty.
if (streamerPacketOffset == 0u) {
TraceHeader hdr;
hdr.magic = 0xDA7A57ADu;
hdr.seq = streamerSequenceNumber++;
hdr.timestamp = HighResolutionTimer::Counter();
hdr.count = 0u;
memcpy(streamerPacketBuffer, &hdr, sizeof(TraceHeader));
streamerPacketOffset = (uint32)sizeof(TraceHeader);
}
// Append the sample entry.
memcpy(&streamerPacketBuffer[streamerPacketOffset], &id, 4u);
memcpy(&streamerPacketBuffer[streamerPacketOffset + 4u], &ts, 8u);
memcpy(&streamerPacketBuffer[streamerPacketOffset + 12u], &size, 4u);
memcpy(&streamerPacketBuffer[streamerPacketOffset + 16u], streamerSampleBuffer, size);
streamerPacketOffset += entryBytes;
((TraceHeader *)streamerPacketBuffer)->count++;
// Oversized single sample: send immediately rather than accumulating.
if (streamerPacketOffset > STREAMER_MTU) {
uint32 toWrite = streamerPacketOffset;
(void)udpSocket.Write((char8 *)streamerPacketBuffer, toWrite);
streamerPacketOffset = 0u;
}
}
// Flush any remaining partial packet.
if (streamerPacketOffset > 0u) {
uint32 toWrite = streamerPacketOffset;
(void)udpSocket.Write((char8 *)streamerPacketBuffer, toWrite);
streamerPacketOffset = 0u;
}
if (!hasData) Sleep::MSec(1u);
return ErrorManagement::NoError;
}
} // namespace MARTe
@@ -0,0 +1,113 @@
#ifndef DEBUGSERVICE_H
#define DEBUGSERVICE_H
#include "BasicTCPSocket.h"
#include "BasicUDPSocket.h"
#include "DebugServiceBase.h"
#include "EmbeddedServiceMethodBinderI.h"
#include "MessageI.h"
#include "ReferenceT.h"
#include "SingleThreadService.h"
namespace MARTe {
/**
* @brief TCP/UDP implementation of DebugServiceI (via DebugServiceBase).
*
* Provides signal tracing (UDP), forced-value injection, break conditions,
* and a text command channel (TCP) with a log-forwarding sidecar (TcpLogger).
* All signal management and command dispatch logic lives in DebugServiceBase.
*/
class DebugService : public DebugServiceBase,
public MessageI,
public EmbeddedServiceMethodBinderI {
public:
friend class DebugServiceTest;
CLASS_REGISTER_DECLARATION()
DebugService();
virtual ~DebugService();
virtual bool Initialise(StructuredDataI &data);
virtual ErrorManagement::ErrorType Execute(ExecutionInfo &info);
virtual ErrorManagement::ErrorType HandleMessage(ReferenceT<Message> &data);
protected:
// Transport-specific overrides of DebugServiceBase hooks
virtual void GetServiceInfo(StreamString &out);
virtual void RebuildTransportConfig();
private:
void InjectTcpLoggerIfNeeded();
ErrorManagement::ErrorType Server (ExecutionInfo &info);
ErrorManagement::ErrorType Streamer(ExecutionInfo &info);
// TCP/UDP-specific configuration
uint16 controlPort;
uint16 streamPort;
uint16 logPort;
StreamString streamIP;
bool isServer;
bool suppressTimeoutLogs;
BasicTCPSocket tcpServer;
BasicUDPSocket udpSocket;
class ServiceBinder : public EmbeddedServiceMethodBinderI {
public:
enum ServiceType { ServerType, StreamerType };
ServiceBinder(DebugService *parent, ServiceType type)
: parent(parent), type(type) {}
virtual ErrorManagement::ErrorType Execute(ExecutionInfo &info) {
if (type == StreamerType) return parent->Streamer(info);
return parent->Server(info);
}
private:
DebugService *parent;
ServiceType type;
};
ServiceBinder binderServer;
ServiceBinder binderStreamer;
SingleThreadService threadService;
SingleThreadService streamerService;
ThreadIdentifier serverThreadId;
ThreadIdentifier streamerThreadId;
// activeClient — exclusively owned by Server thread
FastPollingMutexSem clientMutex;
BasicTCPSocket *activeClient;
// Streamer assembly buffer
// STREAMER_MTU: target packet size for batching small signals (network-friendly).
// STREAMER_BUFFER_SIZE: maximum UDP datagram payload; large single-signal samples
// can exceed STREAMER_MTU and are sent as their own datagram up to this limit.
static const uint32 STREAMER_MTU = 1400u;
static const uint32 STREAMER_BUFFER_SIZE = 65535u;
uint8 streamerPacketBuffer[STREAMER_BUFFER_SIZE]; // assembled outgoing packet
uint8 streamerSampleBuffer[STREAMER_BUFFER_SIZE]; // staging for one popped sample
uint32 streamerPacketOffset;
uint32 streamerSequenceNumber;
// Rate-limiting and idle-timeout constants / state
static const uint32 CMD_RATE_LIMIT = 100u;
// Idle timeout: time with no incoming bytes before the connection is closed.
// Large applications (1000+ signals) can take >30 s to process a DISCOVER/TREE
// response, during which no commands are sent — use a generous default.
static const uint32 CLIENT_IDLE_TIMEOUT_MS = 120000u;
static const uint32 INPUT_BUFFER_MAX = 8192u;
uint32 cmdCountInWindow;
uint64 cmdWindowStartMs;
uint64 lastDataTimeMs;
// Carry-over buffer for multi-segment TCP commands
StreamString inputBuffer;
};
} // namespace MARTe
#endif // DEBUGSERVICE_H
File diff suppressed because it is too large Load Diff
@@ -0,0 +1,214 @@
#ifndef DEBUGSERVICEBASE_H
#define DEBUGSERVICEBASE_H
/**
* @file DebugServiceBase.h
* @brief Shared base class for DebugService and WebDebugService.
*
* Extracts all signal-management, command-handling and config logic that is
* common to both the TCP/UDP transport (DebugService) and the HTTP/SSE
* transport (WebDebugService), eliminating the previous code duplication.
*/
#include "ConfigurationDatabase.h"
#include "DataSourceI.h"
#include "DebugServiceI.h"
#include "FastPollingMutexSem.h"
#include "ReferenceContainer.h"
#include "ReferenceT.h"
#include "StreamString.h"
namespace MARTe {
/**
* @brief Intermediate base class that holds all shared debugging logic.
*
* Inherits from ReferenceContainer (to be a MARTe2 Object) and DebugServiceI
* (to expose the RT-path / control-path interface). Transport subclasses
* (DebugService, WebDebugService) inherit from this class and add only their
* transport-specific threading and socket logic.
*/
class DebugServiceBase : public ReferenceContainer, public DebugServiceI {
public:
friend class DebugServiceTest;
DebugServiceBase();
virtual ~DebugServiceBase();
// =========================================================================
// DebugServiceI RT-path overrides (shared implementation)
// =========================================================================
virtual DebugSignalInfo *RegisterSignal(void *memoryAddress,
TypeDescriptor type,
const char8 *name,
uint8 numberOfDimensions = 0,
uint32 numberOfElements = 1);
virtual void ProcessSignal(DebugSignalInfo *signalInfo, uint32 size,
uint64 timestamp);
virtual void RegisterBroker(DebugSignalInfo **signalPointers,
uint32 numSignals,
MemoryMapBroker *broker,
volatile bool *anyActiveFlag,
Vector<uint32> *activeIndices,
Vector<uint32> *activeSizes,
FastPollingMutexSem *activeMutex,
volatile bool *anyBreakFlag,
Vector<uint32> *breakIndices,
const char8 *gamName = NULL_PTR(const char8 *),
bool isOutput = false);
virtual bool IsPaused() const { return isPaused; }
virtual void SetPaused(bool paused) { isPaused = paused; }
virtual bool IsStepPending() const { return stepRemaining > 0u; }
virtual void ConsumeStepIfNeeded(const char8 *gamName,
const char8 *threadName = NULL_PTR(const char8 *));
// =========================================================================
// DebugServiceI control-path overrides (shared implementation)
// =========================================================================
virtual uint32 ForceSignal (const char8 *name, const char8 *valueStr);
virtual uint32 UnforceSignal(const char8 *name);
virtual uint32 TraceSignal (const char8 *name, bool enable, uint32 decimation = 1);
virtual uint32 SetBreak (const char8 *name, uint8 op, float64 threshold);
virtual uint32 ClearBreak (const char8 *name);
virtual bool IsInstrumented(const char8 *fullPath, bool &traceable, bool &forcable);
virtual uint32 RegisterMonitorSignal(const char8 *path, uint32 periodMs);
virtual uint32 UnmonitorSignal (const char8 *path);
// =========================================================================
// Shared control-path methods (used by transport subclasses)
// =========================================================================
/**
* @brief Parse and dispatch a debug command; write text response to @p out.
*
* Handles: TRACE, FORCE, UNFORCE, BREAK, PAUSE, RESUME, STEP, STEP_STATUS,
* VALUE, DISCOVER, TREE, INFO, LS, CONFIG, MONITOR, UNMONITOR,
* SERVICE_INFO, MSG.
*
* SERVICE_INFO delegates to GetServiceInfo() so each transport can fill in
* its own port/state information.
*/
void HandleCommand(const StreamString &cmdIn, StreamString &out);
void GetStepStatus(StreamString &out);
void GetSignalValue(const char8 *name, StreamString &out);
void Discover (StreamString &out);
void InfoNode (const char8 *path, StreamString &out);
void ListNodes (const char8 *path, StreamString &out);
void ServeConfig (StreamString &out);
void SetFullConfig(ConfigurationDatabase &config);
void RebuildConfigFromRegistry();
// =========================================================================
// Struct shared by both transports
// =========================================================================
struct MonitoredSignal {
ReferenceT<DataSourceI> dataSource;
uint32 signalIdx;
uint32 internalID;
uint32 periodMs;
uint64 lastPollTime;
uint32 size;
StreamString path;
};
// =========================================================================
// Constants
// =========================================================================
static const uint32 GET_VALUE_MAX_ELEMENTS = 256u;
/**
* @brief Pre-build DISCOVER and TREE response caches.
*
* Called automatically by SetFullConfig() once the application is fully
* initialised. After this point, DISCOVER and TREE are served from the
* pre-built string with no mutex contention and no JSON generation cost.
* Both caches are invalidated whenever a new signal is registered (which
* normally only happens during broker init, before SetFullConfig).
*/
void BuildDiscoverCache();
void BuildTreeCache();
// Number of signals per DISCOVER_PART TCP chunk. Responses larger than
// this are split so the Go client can start parsing immediately.
static const uint32 DISCOVER_CHUNK_SIGNALS = 256u;
protected:
// =========================================================================
// Virtual hooks for transport subclasses
// =========================================================================
/**
* @brief Fill the SERVICE_INFO response text (transport-specific).
*
* Called by HandleCommand when the SERVICE_INFO command is received.
* The base implementation writes nothing; subclasses override to append
* e.g. "OK SERVICE_INFO TCP_CTRL:8080 UDP_STREAM:8081 STATE:RUNNING\n".
*/
virtual void GetServiceInfo(StreamString &out) = 0;
/**
* @brief Write back transport-specific config keys after RebuildConfigFromRegistry().
*
* Called at the end of RebuildConfigFromRegistry() so that port numbers
* and other transport parameters that were read in Initialise() are
* reflected back into fullConfig (ExportData on ReferenceContainers
* doesn't re-emit config-file parameters).
*/
virtual void RebuildTransportConfig() {}
// =========================================================================
// Shared protected helpers
// =========================================================================
void Step(uint32 n, const char8 *threadName = NULL_PTR(const char8 *));
void UpdateBrokersActiveStatus();
void UpdateBrokersBreakStatus();
void PatchRegistry();
uint32 ExportTree(ReferenceContainer *container, StreamString &json,
const char8 *pathPrefix);
void ExportTreeNode(const char8 *path, StreamString &out);
void EnrichWithConfig(const char8 *path, StreamString &json);
static void JsonifyDatabase(ConfigurationDatabase &db, StreamString &json);
// =========================================================================
// Shared data members
// =========================================================================
Vector<DebugSignalInfo *> signals;
Vector<SignalAlias> aliases;
Vector<BrokerInfo> brokers;
Vector<MonitoredSignal> monitoredSignals;
FastPollingMutexSem mutex;
FastPollingMutexSem tracePushMutex;
TraceRingBuffer traceBuffer;
volatile bool isPaused;
volatile uint32 stepRemaining;
StreamString pausedAtGam;
StreamString stepThreadFilter;
ConfigurationDatabase fullConfig;
bool manualConfigSet;
// Pre-built response caches. Guarded by mutex (brief lock for swap,
// none needed for reads once cacheValid is true and construction is done).
StreamString discoverCache; // full chunked DISCOVER_PART+DISCOVER payload
StreamString treeCache; // full TREE payload including sentinel
volatile bool discoverCacheValid;
volatile bool treeCacheValid;
};
} // namespace MARTe
#endif // DEBUGSERVICEBASE_H
@@ -0,0 +1,188 @@
#ifndef DEBUGSERVICEI_H
#define DEBUGSERVICEI_H
/**
* @file DebugServiceI.h
* @brief Abstract interface for the MARTe2 debug/instrumentation service.
*
* All broker wrappers (DebugBrokerWrapper) depend solely on this interface,
* decoupling them from the concrete TCP/UDP implementation. Alternative
* transports — TTY, WebSocket, shared-memory ring, etc. — can be plugged in
* by providing a new concrete implementation without touching any broker or
* application code.
*
* The interface is split into two logical groups:
*
* RT-path API
* Called from broker threads on every RT cycle. Implementations must
* keep these methods as cheap as possible; the only permissible
* synchronisation primitive is a fast spinlock (FastPollingMutexSem).
*
* Control-path API
* Called from server / command-handler threads (TCP, TTY, Web …).
* Latency here is acceptable; correctness and thread-safety matter.
*
* Concrete implementations register themselves during Initialise() via
* SetInstance(). Broker wrappers retrieve the active instance via
* GetInstance(); there is no ORD search on the hot path.
*/
#include "DebugCore.h"
#include "FastPollingMutexSem.h"
#include "Object.h"
#include "StreamString.h"
#include "TypeDescriptor.h"
namespace MARTe {
// Forward declarations — concrete types are only needed in the implementation.
class MemoryMapBroker;
struct SignalAlias {
StreamString name;
uint32 signalIndex;
};
struct BrokerInfo {
DebugSignalInfo **signalPointers;
uint32 numSignals;
MemoryMapBroker *broker;
volatile bool *anyActiveFlag;
Vector<uint32> *activeIndices;
Vector<uint32> *activeSizes;
FastPollingMutexSem *activeMutex;
volatile bool *anyBreakFlag;
Vector<uint32> *breakIndices;
StreamString gamName;
bool isOutput;
};
/**
* @brief Abstract debug-service interface.
*/
class DebugServiceI {
public:
// -------------------------------------------------------------------------
// Static instance registry
// -------------------------------------------------------------------------
/**
* @brief Return the currently registered debug-service instance, or NULL.
*
* Called on every broker Init() path and from OutpautPauseAndStep().
* Returns NULL when no debug service has been initialised, in which case
* all instrumentation is a no-op.
*/
static DebugServiceI *GetInstance() { return instance; }
/**
* @brief Register @p inst as the global debug-service.
*
* Concrete implementations call this from their Initialise() method.
* Passing NULL deregisters the current instance (called from the
* destructor so dangling pointers are never visible to broker threads).
*/
static void SetInstance(DebugServiceI *inst) { instance = inst; }
virtual ~DebugServiceI() {}
// =========================================================================
// RT-path API (called from broker execute threads every cycle)
// =========================================================================
/**
* @brief Register a signal memory region with the debug service.
*
* Called once per signal during broker Init(). Returns a pointer to the
* internal DebugSignalInfo that the broker caches for use on the hot path.
* Thread-safe; must not be called after the RT loop has started.
*/
virtual DebugSignalInfo *RegisterSignal(void *memoryAddress,
TypeDescriptor type,
const char8 *name,
uint8 numberOfDimensions = 0,
uint32 numberOfElements = 1) = 0;
/**
* @brief Process one signal on the RT path.
*
* Applies forced values (memcpy into signal memory) and, when tracing is
* enabled and the decimation counter fires, pushes a sample to the trace
* ring buffer. Called under the broker's activeMutex; implementations
* must not acquire any lock that is also held by the Server thread.
*/
virtual void ProcessSignal(DebugSignalInfo *signalInfo,
uint32 size,
uint64 timestamp) = 0;
/**
* @brief Register a broker so the service can push active/break index
* updates to it without iterating every signal.
*/
virtual void RegisterBroker(DebugSignalInfo **signalPointers,
uint32 numSignals,
MemoryMapBroker *broker,
volatile bool *anyActiveFlag,
Vector<uint32> *activeIndices,
Vector<uint32> *activeSizes,
FastPollingMutexSem *activeMutex,
volatile bool *anyBreakFlag,
Vector<uint32> *breakIndices,
const char8 *gamName = NULL_PTR(const char8 *),
bool isOutput = false) = 0;
/** @brief Return true if the RT loop is currently held at a pause/breakpoint. */
virtual bool IsPaused() const = 0;
/** @brief Set or clear the paused state (called by break-condition logic). */
virtual void SetPaused(bool paused) = 0;
/** @brief Return true if a step count is pending (stepRemaining > 0). */
virtual bool IsStepPending() const = 0;
/**
* @brief Consume one step credit for the current output-broker cycle.
*
* Called by every output broker after Execute(). No-op when stepRemaining
* is zero (the common case); only acquires a mutex when stepping is active.
*/
virtual void ConsumeStepIfNeeded(
const char8 *gamName,
const char8 *threadName = NULL_PTR(const char8 *)) = 0;
// =========================================================================
// Control-path API (called from server / command-handler threads)
// =========================================================================
virtual uint32 ForceSignal (const char8 *name, const char8 *valueStr) = 0;
virtual uint32 UnforceSignal(const char8 *name) = 0;
virtual uint32 TraceSignal (const char8 *name, bool enable, uint32 decimation = 1) = 0;
virtual uint32 SetBreak (const char8 *name, uint8 op, float64 threshold) = 0;
virtual uint32 ClearBreak (const char8 *name) = 0;
virtual bool IsInstrumented(const char8 *fullPath,
bool &traceable, bool &forcable) = 0;
virtual uint32 RegisterMonitorSignal(const char8 *path, uint32 periodMs) = 0;
virtual uint32 UnmonitorSignal (const char8 *path) = 0;
// =========================================================================
// Utility (implementation-agnostic, defined in DebugService.cpp)
// =========================================================================
/**
* @brief Resolve the fully-qualified ORD path of @p obj into @p fullPath.
*
* Static so it can be called without a service instance. All concrete
* implementations (and InitSignals in DebugBrokerWrapper.h) use this
* to build canonical signal names. The definition lives in
* DebugService.cpp alongside FindPathInContainer().
*/
static bool GetFullObjectName(const Object &obj, StreamString &fullPath);
protected:
/** Pointer to the single active debug-service instance. */
static DebugServiceI *instance;
};
} // namespace MARTe
#endif // DEBUGSERVICEI_H
@@ -0,0 +1,28 @@
#############################################################
#
# Copyright 2015 F4E | European Joint Undertaking for ITER
# and the Development of Fusion Energy ('Fusion for Energy')
#
# Licensed under the EUPL, Version 1.1 or - as soon they
# will be approved by the European Commission - subsequent
# versions of the EUPL (the "Licence");
# You may not use this work except in compliance with the
# Licence.
# You may obtain a copy of the Licence at:
#
# http://ec.europa.eu/idabc/eupl
#
# Unless required by applicable law or agreed to in
# writing, software distributed under the Licence is
# distributed on an "AS IS" basis,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
# express or implied.
# See the Licence for the specific language governing
# permissions and limitations under the Licence.
#
# $Id: Makefile.gcc 3 2015-01-15 16:26:07Z aneto $
#
#############################################################
include Makefile.inc
@@ -0,0 +1,59 @@
#############################################################
#
# Copyright 2015 F4E | European Joint Undertaking for ITER
# and the Development of Fusion Energy ('Fusion for Energy')
#
# Licensed under the EUPL, Version 1.1 or - as soon they
# will be approved by the European Commission - subsequent
# versions of the EUPL (the "Licence");
# You may not use this work except in compliance with the
# Licence.
# You may obtain a copy of the Licence at:
#
# http://ec.europa.eu/idabc/eupl
#
# Unless required by applicable law or agreed to in
# writing, software distributed under the Licence is
# distributed on an "AS IS" basis,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
# express or implied.
# See the Licence for the specific language governing
# permissions and limitations under the Licence.
#
# $Id: Makefile.inc 3 2012-01-15 16:26:07Z aneto $
#
#############################################################
OBJSX=DebugService.x DebugServiceBase.x
PACKAGE=Components/Interfaces
ROOT_DIR=../../../../
MAKEDEFAULTDIR=$(MARTe2_DIR)/MakeDefaults
include $(MAKEDEFAULTDIR)/MakeStdLibDefs.$(TARGET)
INCLUDES += -I$(ROOT_DIR)/Source/Core/Types/Result
INCLUDES += -I$(ROOT_DIR)/Source/Core/Types/Vec
INCLUDES += -I$(ROOT_DIR)/Source/Components/Interfaces/TCPLogger
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L0Types
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L2Objects
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L3Streams
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Messages
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Logger
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Configuration
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L5GAMs
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L3Services
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L4Messages
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L4LoggerService
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L5GAMs
INCLUDES += -I$(MARTe2_DIR)/Source/Core/FileSystem/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/FileSystem/L3Streams
all: $(OBJS) $(SUBPROJ) \
$(BUILD_DIR)/DebugService$(LIBEXT) \
$(BUILD_DIR)/DebugService$(DLLEXT)
echo $(OBJS)
include $(MAKEDEFAULTDIR)/MakeStdLibRules.$(TARGET)
+26
View File
@@ -0,0 +1,26 @@
#############################################################
#
# Copyright 2015 F4E | European Joint Undertaking for ITER
# and the Development of Fusion Energy ('Fusion for Energy')
#
# Licensed under the EUPL, Version 1.1 or - as soon they
# will be approved by the European Commission - subsequent
# versions of the EUPL (the "Licence");
# You may not use this work except in compliance with the
# Licence.
# You may obtain a copy of the Licence at:
#
# http://ec.europa.eu/idabc/eupl
#
# Unless required by applicable law or agreed to in
# writing, software distributed under the Licence is
# distributed on an "AS IS" basis,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
# express or implied.
# See the Licence for the specific language governing
# permissions and limitations under the Licence.
#
#############################################################
include Makefile.inc
+43
View File
@@ -0,0 +1,43 @@
#############################################################
#
# Copyright 2015 F4E | European Joint Undertaking for ITER
# and the Development of Fusion Energy ('Fusion for Energy')
#
# Licensed under the EUPL, Version 1.1 or - as soon they
# will be approved by the European Commission - subsequent
# versions of the EUPL (the "Licence");
# You may not use this work except in compliance with the
# Licence.
# You may obtain a copy of the Licence at:
#
# http://ec.europa.eu/idabc/eupl
#
# Unless required by applicable law or agreed to in
# writing, software distributed under the Licence is
# distributed on an "AS IS" basis,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
# express or implied.
# See the Licence for the specific language governing
# permissions and limitations under the Licence.
#
#############################################################
OBJSX=
SPB = TCPLogger.x DebugService.x WebDebugService.x
ROOT_DIR=../../..
PACKAGE=Components
ROOT_DIR=../../..
ABS_ROOT_DIR=$(abspath $(ROOT_DIR))
MAKEDEFAULTDIR=$(MARTe2_DIR)/MakeDefaults
include $(MAKEDEFAULTDIR)/MakeStdLibDefs.$(TARGET)
all: $(OBJS) $(SUBPROJ)
echo $(OBJS)
include $(MAKEDEFAULTDIR)/MakeStdLibRules.$(TARGET)
@@ -0,0 +1 @@
include Makefile.inc
@@ -0,0 +1,31 @@
OBJSX=TcpLogger.x
PACKAGE=Components/Interfaces
ROOT_DIR=../../../../
MAKEDEFAULTDIR=$(MARTe2_DIR)/MakeDefaults
include $(MAKEDEFAULTDIR)/MakeStdLibDefs.$(TARGET)
INCLUDES += -I.
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L0Types
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L2Objects
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L3Streams
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Messages
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Logger
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Configuration
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L5GAMs
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L3Services
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L4Messages
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L4LoggerService
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L5GAMs
INCLUDES += -I$(MARTe2_DIR)/Source/Core/FileSystem/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/FileSystem/L3Streams
all: $(OBJS) $(SUBPROJ) \
$(BUILD_DIR)/TcpLogger$(LIBEXT) \
$(BUILD_DIR)/TcpLogger$(DLLEXT)
echo $(OBJS)
include $(MAKEDEFAULTDIR)/MakeStdLibRules.$(TARGET)
@@ -35,6 +35,11 @@ TcpLogger::~TcpLogger() {
clientsMutex.FastUnLock(); clientsMutex.FastUnLock();
} }
bool TcpLogger::ExportData(StructuredDataI & data) {
bool ok = data.Write("Port", static_cast<uint32>(port));
return ok;
}
bool TcpLogger::Initialise(StructuredDataI & data) { bool TcpLogger::Initialise(StructuredDataI & data) {
if (!ReferenceContainer::Initialise(data)) return false; if (!ReferenceContainer::Initialise(data)) return false;
@@ -92,64 +97,66 @@ ErrorManagement::ErrorType TcpLogger::Execute(ExecutionInfo & info) {
return ErrorManagement::NoError; return ErrorManagement::NoError;
} }
while (info.GetStage() == ExecutionInfo::MainStage) { // Each Execute() call does one cycle. The MARTe2 framework loops Execute()
// 1. Check for new connections // so we must NOT spin in an infinite internal loop here — doing so prevents
BasicTCPSocket *newClient = server.WaitConnection(1); // the framework from ever delivering the TerminationStage and causes
if (newClient != NULL_PTR(BasicTCPSocket *)) { // Stop() to time out, leaving threads running after the destructor.
clientsMutex.FastLock();
bool added = false; // 1. Check for new connections (1 ms timeout → returns promptly)
for (uint32 i=0; i<MAX_CLIENTS; i++) { BasicTCPSocket *newClient = server.WaitConnection(1);
if (activeClients[i] == NULL_PTR(BasicTCPSocket*)) { if (newClient != NULL_PTR(BasicTCPSocket *)) {
activeClients[i] = newClient; clientsMutex.FastLock();
added = true; bool added = false;
break; for (uint32 i=0; i<MAX_CLIENTS; i++) {
} if (activeClients[i] == NULL_PTR(BasicTCPSocket*)) {
} activeClients[i] = newClient;
clientsMutex.FastUnLock(); added = true;
if (!added) { break;
newClient->Close();
delete newClient;
} else {
(void)newClient->SetBlocking(false);
} }
} }
clientsMutex.FastUnLock();
// 2. Stream data to clients if (!added) {
bool hadData = false; newClient->Close();
while (readIdx != writeIdx) { delete newClient;
hadData = true;
uint32 idx = readIdx % QUEUE_SIZE;
TcpLogEntry &entry = queue[idx];
StreamString level;
ErrorManagement::ErrorCodeToStream(entry.info.header.errorType, level);
StreamString packet;
packet.Printf("LOG %s %s\n", level.Buffer(), entry.description);
uint32 size = packet.Size();
clientsMutex.FastLock();
for (uint32 j=0; j<MAX_CLIENTS; j++) {
if (activeClients[j] != NULL_PTR(BasicTCPSocket*)) {
uint32 s = size;
if (!activeClients[j]->Write(packet.Buffer(), s)) {
activeClients[j]->Close();
delete activeClients[j];
activeClients[j] = NULL_PTR(BasicTCPSocket*);
}
}
}
clientsMutex.FastUnLock();
readIdx = (readIdx + 1) % QUEUE_SIZE;
}
if (!hadData) {
(void)eventSem.Wait(TimeoutType(100));
eventSem.Reset();
} else { } else {
Sleep::MSec(1); (void)newClient->SetBlocking(false);
} }
} }
// 2. Stream queued entries to clients
bool hadData = false;
while (readIdx != writeIdx) {
hadData = true;
uint32 idx = readIdx % QUEUE_SIZE;
TcpLogEntry &entry = queue[idx];
StreamString level;
ErrorManagement::ErrorCodeToStream(entry.info.header.errorType, level);
StreamString packet;
packet.Printf("LOG %s %s\n", level.Buffer(), entry.description);
uint32 size = packet.Size();
clientsMutex.FastLock();
for (uint32 j=0; j<MAX_CLIENTS; j++) {
if (activeClients[j] != NULL_PTR(BasicTCPSocket*)) {
uint32 s = size;
if (!activeClients[j]->Write(packet.Buffer(), s)) {
activeClients[j]->Close();
delete activeClients[j];
activeClients[j] = NULL_PTR(BasicTCPSocket*);
}
}
}
clientsMutex.FastUnLock();
readIdx = (readIdx + 1) % QUEUE_SIZE;
}
if (!hadData) {
// Brief wait so we don't busy-spin; return so Stop() can take effect
(void)eventSem.Wait(TimeoutType(10));
eventSem.Reset();
}
return ErrorManagement::NoError; return ErrorManagement::NoError;
} }
@@ -29,6 +29,8 @@ public:
virtual bool Initialise(StructuredDataI & data); virtual bool Initialise(StructuredDataI & data);
virtual bool ExportData(StructuredDataI & data);
/** /**
* @brief Implementation of LoggerConsumerI. * @brief Implementation of LoggerConsumerI.
* Called by LoggerService. * Called by LoggerService.
@@ -0,0 +1,3 @@
export TARGET=x86-linux
include Makefile.inc
@@ -0,0 +1,39 @@
OBJSX=WebDebugService.x DebugServiceBase.x
PACKAGE=Components/Interfaces
ROOT_DIR=../../../../
MAKEDEFAULTDIR=$(MARTe2_DIR)/MakeDefaults
include $(MAKEDEFAULTDIR)/MakeStdLibDefs.$(TARGET)
INCLUDES += -I$(ROOT_DIR)/Source/Components/Interfaces/TCPLogger
INCLUDES += -I$(ROOT_DIR)/Source/Components/Interfaces/DebugService
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L0Types
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L2Objects
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L3Streams
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Messages
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Logger
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Configuration
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L5GAMs
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L3Services
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L4Messages
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L4LoggerService
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L5GAMs
INCLUDES += -I$(MARTe2_DIR)/Source/Core/FileSystem/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/FileSystem/L3Streams
DEBUGSERVICE_SRC=$(ROOT_DIR)/Source/Components/Interfaces/DebugService
all: $(OBJS) $(SUBPROJ) \
$(BUILD_DIR)/WebDebugService$(LIBEXT) \
$(BUILD_DIR)/WebDebugService$(DLLEXT)
echo $(OBJS)
include $(MAKEDEFAULTDIR)/MakeStdLibRules.$(TARGET)
# Explicit rule to compile DebugServiceBase.cpp from the DebugService directory
$(BUILD_DIR)/DebugServiceBase.o: $(DEBUGSERVICE_SRC)/DebugServiceBase.cpp
$(COMPILER) -c $(OPTIM) $(INCLUDES) $(CPPFLAGS) $(CFLAGSPEC) $(DEBUG) \
$(DEBUGSERVICE_SRC)/DebugServiceBase.cpp -o $(BUILD_DIR)/DebugServiceBase.o
@@ -0,0 +1,564 @@
#include "Atomic.h"
#include "Logger.h"
#include "BasicTCPSocket.h"
#include "ConfigurationDatabase.h"
#include "DebugBrokerWrapper.h"
#include "GAM.h"
#include "HighResolutionTimer.h"
#include "ObjectRegistryDatabase.h"
#include "ReferenceT.h"
#include "Sleep.h"
#include "StreamString.h"
#include "Threads.h"
#include "TimeoutType.h"
#include "TypeConversion.h"
#include "WebDebugService.h"
#include "WebUI.h"
namespace MARTe {
// ---------------------------------------------------------------------------
// CLASS_REGISTER
// ---------------------------------------------------------------------------
CLASS_REGISTER(WebDebugService, "1.0")
// ---------------------------------------------------------------------------
// Helper: convert raw bytes to float64 for SSE JSON
// ---------------------------------------------------------------------------
static float64 WDS_ToFloat64(const uint8 *data, TypeDescriptor td) {
float64 v = 0.0;
if (td == Float32Bit) { float32 f; memcpy(&f, data, 4u); v = (float64)f; }
else if (td == Float64Bit) { memcpy(&v, data, 8u); }
else if (td == SignedInteger8Bit) { int8 x; memcpy(&x, data, 1u); v = (float64)x; }
else if (td == UnsignedInteger8Bit) { uint8 x; memcpy(&x, data, 1u); v = (float64)x; }
else if (td == SignedInteger16Bit) { int16 x; memcpy(&x, data, 2u); v = (float64)x; }
else if (td == UnsignedInteger16Bit){ uint16 x; memcpy(&x, data, 2u); v = (float64)x; }
else if (td == SignedInteger32Bit) { int32 x; memcpy(&x, data, 4u); v = (float64)x; }
else if (td == UnsignedInteger32Bit){ uint32 x; memcpy(&x, data, 4u); v = (float64)x; }
else if (td == SignedInteger64Bit) { int64 x; memcpy(&x, data, 8u); v = (float64)x; }
else if (td == UnsignedInteger64Bit){ uint64 x; memcpy(&x, data, 8u); v = (float64)(int64)x; }
return v;
}
static void WDS_EscapeJson(const char8 *src, StreamString &dst) {
if (src == NULL_PTR(const char8 *)) return;
while (*src != '\0') {
if (*src == '"') dst += "\\\"";
else if (*src == '\\') dst += "\\\\";
else if (*src == '\n') dst += "\\n";
else if (*src == '\r') dst += "\\r";
else if (*src == '\t') dst += "\\t";
else dst += *src;
src++;
}
}
// ---------------------------------------------------------------------------
// Constructor / Destructor
// ---------------------------------------------------------------------------
WebDebugService::WebDebugService()
: DebugServiceBase(),
EmbeddedServiceMethodBinderI(),
binderHttp(this, WdsBinder::Http),
binderStream(this, WdsBinder::Stream),
httpService(binderHttp),
streamerService(binderStream) {
httpPort = 8090u;
streamerSeq = 0u;
streamerT0Ns = 0u;
logHistoryWriteIdx = 0u;
logHistoryFill = 0u;
memset(logHistory, 0, sizeof(logHistory));
for (uint32 i = 0u; i < MAX_SSE_CLIENTS; i++) {
sseClients[i] = NULL_PTR(BasicTCPSocket *);
}
}
WebDebugService::~WebDebugService() {
if (DebugServiceI::GetInstance() == this) {
DebugServiceI::SetInstance(NULL_PTR(DebugServiceI *));
}
httpService.Stop();
streamerService.Stop();
tcpServer.Close();
sseMutex.FastLock();
for (uint32 i = 0u; i < MAX_SSE_CLIENTS; i++) {
if (sseClients[i] != NULL_PTR(BasicTCPSocket *)) {
sseClients[i]->Close();
delete sseClients[i];
sseClients[i] = NULL_PTR(BasicTCPSocket *);
}
}
sseMutex.FastUnLock();
// signals owned by DebugServiceBase destructor
}
// ---------------------------------------------------------------------------
// Initialise
// ---------------------------------------------------------------------------
bool WebDebugService::Initialise(StructuredDataI &data) {
if (!ReferenceContainer::Initialise(data)) return false;
uint32 port = 8090u;
(void)data.Read("HttpPort", port);
httpPort = (uint16)port;
if (!traceBuffer.Init(4 * 1024 * 1024)) return false;
DebugServiceI::SetInstance(this);
PatchRegistry();
// Initialise Logger early so REPORT_ERROR calls are captured.
(void)Logger::Instance();
REPORT_ERROR(ErrorManagement::Information,
"WebDebugService initialised on port %d", (int)httpPort);
// Record time origin for relative SSE timestamps.
streamerT0Ns = (uint64)((float64)HighResolutionTimer::Counter() *
HighResolutionTimer::Period() * 1.0e9);
ConfigurationDatabase threadData;
threadData.Write("Timeout", (uint32)1000);
httpService.Initialise(threadData);
streamerService.Initialise(threadData);
if (!tcpServer.Open()) return false;
if (!tcpServer.Listen(httpPort)) return false;
if (httpService.Start() != ErrorManagement::NoError) return false;
if (streamerService.Start() != ErrorManagement::NoError) return false;
return true;
}
// ---------------------------------------------------------------------------
// EmbeddedServiceMethodBinderI — never actually called (sub-binders used)
// ---------------------------------------------------------------------------
ErrorManagement::ErrorType WebDebugService::Execute(ExecutionInfo &info) {
(void)info;
return ErrorManagement::FatalError;
}
// ---------------------------------------------------------------------------
// SERVICE_INFO hook
// ---------------------------------------------------------------------------
void WebDebugService::GetServiceInfo(StreamString &out) {
out.Printf("OK SERVICE_INFO HTTP:%u STATE:%s\n",
(uint32)httpPort, isPaused ? "PAUSED" : "RUNNING");
}
// ---------------------------------------------------------------------------
// SSE broadcast
// ---------------------------------------------------------------------------
void WebDebugService::BroadcastSse(const char8 *eventType,
const StreamString &data) {
StreamString pkt;
pkt.Printf("event: %s\ndata: ", eventType);
pkt += data;
pkt += "\n\n";
sseMutex.FastLock();
for (uint32 i = 0u; i < MAX_SSE_CLIENTS; i++) {
if (sseClients[i] != NULL_PTR(BasicTCPSocket *)) {
uint32 sz = pkt.Size();
if (!sseClients[i]->Write(pkt.Buffer(), sz)) {
sseClients[i]->Close();
delete sseClients[i];
sseClients[i] = NULL_PTR(BasicTCPSocket *);
}
}
}
sseMutex.FastUnLock();
}
void WebDebugService::RemoveDeadSseClients() {
sseMutex.FastLock();
for (uint32 i = 0u; i < MAX_SSE_CLIENTS; i++) {
if (sseClients[i] != NULL_PTR(BasicTCPSocket *) &&
!sseClients[i]->IsConnected()) {
sseClients[i]->Close();
delete sseClients[i];
sseClients[i] = NULL_PTR(BasicTCPSocket *);
}
}
sseMutex.FastUnLock();
}
void WebDebugService::UpgradeToSse(BasicTCPSocket *client) {
const char8 *hdr =
"HTTP/1.1 200 OK\r\n"
"Content-Type: text/event-stream\r\n"
"Cache-Control: no-cache\r\n"
"Connection: keep-alive\r\n"
"Access-Control-Allow-Origin: *\r\n"
"\r\n";
uint32 sz = StringHelper::Length(hdr);
(void)client->Write(hdr, sz);
// Send an initial status event
mutex.FastLock();
bool paused = isPaused;
StreamString gam = pausedAtGam;
uint32 rem = stepRemaining;
mutex.FastUnLock();
StreamString initEv;
initEv.Printf(
"{\"type\":\"status\",\"paused\":%s,\"gam\":\"%s\",\"remaining\":%u}",
paused ? "true" : "false", gam.Buffer(), rem);
StreamString initPkt;
initPkt += "event: message\ndata: ";
initPkt += initEv;
initPkt += "\n\n";
uint32 isz = initPkt.Size();
(void)client->Write(initPkt.Buffer(), isz);
// Replay log history so the browser sees messages emitted before it connected
logHistoryMutex.FastLock();
{
uint32 startIdx = (logHistoryFill >= LOG_HISTORY_SIZE)
? logHistoryWriteIdx : 0u;
uint32 count = logHistoryFill;
for (uint32 i = 0u; i < count; i++) {
uint32 idx = (startIdx + i) % LOG_HISTORY_SIZE;
if (logHistory[idx][0] != '\0') {
StreamString histPkt;
histPkt += "event: message\ndata: ";
histPkt += logHistory[idx];
histPkt += "\n\n";
uint32 hsz = histPkt.Size();
(void)client->Write(histPkt.Buffer(), hsz);
}
}
}
logHistoryMutex.FastUnLock();
// Register in the SSE client slot array
sseMutex.FastLock();
bool registered = false;
for (uint32 i = 0u; i < MAX_SSE_CLIENTS; i++) {
if (sseClients[i] == NULL_PTR(BasicTCPSocket *)) {
sseClients[i] = client;
registered = true;
break;
}
}
sseMutex.FastUnLock();
if (!registered) {
client->Close();
delete client;
}
}
// ---------------------------------------------------------------------------
// HTTP request parsing
// ---------------------------------------------------------------------------
bool WebDebugService::ParseRequest(BasicTCPSocket *client,
StreamString &method, StreamString &path,
StreamString &body) {
static const uint32 MAX_HEADER = 8192u;
char8 buf[MAX_HEADER + 1];
uint32 total = 0u;
uint32 headerEnd = 0u;
bool foundEnd = false;
while (total < MAX_HEADER && !foundEnd) {
uint32 sz = MAX_HEADER - total;
if (!client->Read(buf + total, sz) || sz == 0u) break;
total += sz;
buf[total] = '\0';
for (uint32 i = 0u; i + 3u < total; i++) {
if (buf[i] == '\r' && buf[i+1] == '\n' &&
buf[i+2] == '\r' && buf[i+3] == '\n') {
headerEnd = i + 4u;
foundEnd = true;
break;
}
}
}
if (!foundEnd) return false;
const char8 *line = buf;
const char8 *sp1 = StringHelper::SearchChar(line, ' ');
if (sp1 == NULL_PTR(const char8 *)) return false;
method = "";
{ uint32 mLen = (uint32)(sp1 - line); (void)method.Write(line, mLen); }
const char8 *sp2 = StringHelper::SearchChar(sp1 + 1, ' ');
if (sp2 == NULL_PTR(const char8 *)) return false;
path = "";
{ uint32 pLen = (uint32)(sp2 - sp1 - 1); (void)path.Write(sp1 + 1, pLen); }
uint32 contentLength = 0u;
const char8 *cl = StringHelper::SearchString(buf, "Content-Length:");
if (cl != NULL_PTR(const char8 *)) {
cl += 15u;
while (*cl == ' ') cl++;
AnyType cv(UnsignedInteger32Bit, 0u, &contentLength);
AnyType cs(CharString, 0u, cl);
(void)TypeConvert(cv, cs);
}
body = "";
if (contentLength > 0u) {
uint32 alreadyRead = (total > headerEnd) ? (total - headerEnd) : 0u;
if (alreadyRead > 0u) (void)body.Write(buf + headerEnd, alreadyRead);
static const uint32 MAX_BODY = 16384u;
if (contentLength > alreadyRead && contentLength <= MAX_BODY) {
char8 bodyBuf[MAX_BODY];
uint32 toRead = contentLength - alreadyRead;
uint32 sz = toRead;
if (client->Read(bodyBuf, sz) && sz > 0u) {
(void)body.Write(bodyBuf, sz);
}
}
}
return true;
}
void WebDebugService::SendHttp(BasicTCPSocket *client, uint32 code,
const char8 *ct, StreamString &body) {
StreamString resp;
resp.Printf("HTTP/1.1 %u %s\r\n"
"Content-Type: %s\r\n"
"Content-Length: %u\r\n"
"Cache-Control: no-cache\r\n"
"Access-Control-Allow-Origin: *\r\n"
"Connection: close\r\n"
"\r\n",
code, (code == 200u) ? "OK" : "Error",
ct, (uint32)body.Size());
resp += body;
uint32 sz = resp.Size();
(void)client->Write(resp.Buffer(), sz);
}
void WebDebugService::HandleRequest(BasicTCPSocket *client,
const StreamString &method,
const StreamString &path,
const StreamString &body) {
if (method == "GET" && (path == "/" || path == "/index.html")) {
StreamString html = WEB_UI_HTML;
SendHttp(client, 200u, "text/html; charset=utf-8", html);
} else if (method == "GET" && path == "/api/events") {
UpgradeToSse(client);
return; // socket ownership transferred
} else if (method == "POST" && path == "/api/command") {
StreamString out;
HandleCommand(body, out);
SendHttp(client, 200u, "text/plain; charset=utf-8", out);
} else if (method == "OPTIONS") {
const char8 *hdr =
"HTTP/1.1 204 No Content\r\n"
"Access-Control-Allow-Origin: *\r\n"
"Access-Control-Allow-Methods: GET, POST, OPTIONS\r\n"
"Access-Control-Allow-Headers: Content-Type\r\n"
"Connection: close\r\n"
"\r\n";
uint32 sz = StringHelper::Length(hdr);
(void)client->Write(hdr, sz);
} else {
StreamString body404 = "Not Found";
SendHttp(client, 404u, "text/plain", body404);
}
client->Close();
delete client;
}
// ---------------------------------------------------------------------------
// HTTP server thread
// ---------------------------------------------------------------------------
ErrorManagement::ErrorType WebDebugService::HttpServer(ExecutionInfo &info) {
if (info.GetStage() == ExecutionInfo::TerminationStage)
return ErrorManagement::NoError;
if (info.GetStage() == ExecutionInfo::StartupStage) {
Sleep::MSec(500u); // wait for ORD to finish
return ErrorManagement::NoError;
}
BasicTCPSocket *client = tcpServer.WaitConnection(TimeoutType(100u));
if (client == NULL_PTR(BasicTCPSocket *))
return ErrorManagement::NoError;
StreamString method, path, body;
if (ParseRequest(client, method, path, body)) {
HandleRequest(client, method, path, body);
// For SSE, HandleRequest transferred ownership — don't touch client here
} else {
client->Close();
delete client;
}
return ErrorManagement::NoError;
}
// ---------------------------------------------------------------------------
// Streamer thread — drains log, polls monitors, drains trace buffer, heartbeat
// ---------------------------------------------------------------------------
ErrorManagement::ErrorType WebDebugService::Streamer(ExecutionInfo &info) {
if (info.GetStage() == ExecutionInfo::TerminationStage)
return ErrorManagement::NoError;
if (info.GetStage() == ExecutionInfo::StartupStage)
return ErrorManagement::NoError;
uint64 nowNs = (uint64)((float64)HighResolutionTimer::Counter() *
HighResolutionTimer::Period() * 1.0e9);
uint64 nowMs = (nowNs >= streamerT0Ns) ? (nowNs - streamerT0Ns) / 1000000u : 0u;
// -----------------------------------------------------------------
// Drain MARTe2 log pages → SSE log events
// -----------------------------------------------------------------
{
static const uint32 MAX_LOGS_PER_CYCLE = 32u;
uint32 logCount = 0u;
LoggerPage *logPage = Logger::Instance()->GetLogEntry();
while (logPage != NULL_PTR(LoggerPage *) && logCount < MAX_LOGS_PER_CYCLE) {
StreamString levelStr;
ErrorManagement::ErrorCodeToStream(
logPage->errorInfo.header.errorType, levelStr);
StreamString msgEsc;
WDS_EscapeJson(logPage->errorStrBuffer, msgEsc);
StreamString ev;
ev.Printf("{\"type\":\"log\",\"level\":\"%s\",\"msg\":\"%s\"}",
levelStr.Buffer(), msgEsc.Buffer());
Logger::Instance()->ReturnPage(logPage);
logHistoryMutex.FastLock();
{
uint32 evSz = ev.Size();
if (evSz >= LOG_ENTRY_MAX_SIZE) evSz = LOG_ENTRY_MAX_SIZE - 1u;
(void)StringHelper::CopyN(logHistory[logHistoryWriteIdx],
ev.Buffer(), evSz);
logHistory[logHistoryWriteIdx][evSz] = '\0';
logHistoryWriteIdx = (logHistoryWriteIdx + 1u) % LOG_HISTORY_SIZE;
if (logHistoryFill < LOG_HISTORY_SIZE) logHistoryFill++;
}
logHistoryMutex.FastUnLock();
BroadcastSse("message", ev);
logPage = Logger::Instance()->GetLogEntry();
logCount++;
}
}
// -----------------------------------------------------------------
// Poll monitored signals → SSE monitor events
// -----------------------------------------------------------------
mutex.FastLock();
for (uint32 i = 0u; i < monitoredSignals.GetNumberOfElements(); i++) {
if (nowMs >= (monitoredSignals[i].lastPollTime +
monitoredSignals[i].periodMs)) {
monitoredSignals[i].lastPollTime = nowMs;
uint32 tsMs = (uint32)nowMs;
void *addr = NULL_PTR(void *);
if (monitoredSignals[i].dataSource->GetSignalMemoryBuffer(
monitoredSignals[i].signalIdx, 0u, addr) &&
addr != NULL_PTR(void *)) {
uint32 sz = monitoredSignals[i].size;
if (sz > 1024u) sz = 1024u;
uint8 lb[1024]; memcpy(lb, addr, sz);
TypeDescriptor td = monitoredSignals[i].dataSource->GetSignalType(
monitoredSignals[i].signalIdx);
float64 val = WDS_ToFloat64(lb, td);
StreamString sigName;
for (uint32 j = 0u; j < aliases.GetNumberOfElements(); j++) {
if (signals[aliases[j].signalIndex]->internalID ==
monitoredSignals[i].internalID) {
sigName = aliases[j].name;
break;
}
}
if (sigName.Size() == 0u) sigName = monitoredSignals[i].path;
char8 valBuf[64] = { '\0' };
{
AnyType vdst(CharString, 0u, valBuf);
vdst.SetNumberOfElements(0u, 63u);
AnyType vsrc(Float64Bit, 0u, &val);
(void)TypeConvert(vdst, vsrc);
}
StreamString ev;
ev.Printf(
"{\"type\":\"monitor\",\"name\":\"%s\",\"ts\":%u,\"value\":%s}",
sigName.Buffer(), tsMs, valBuf);
mutex.FastUnLock();
BroadcastSse("message", ev);
mutex.FastLock();
}
}
}
mutex.FastUnLock();
// -----------------------------------------------------------------
// Drain ring buffer → SSE trace events
// -----------------------------------------------------------------
static const uint32 MAX_TRACE_CYCLE = 50u;
uint32 id, size;
uint64 sampleTs;
bool hasData = false;
uint32 traceCount = 0u;
while (traceCount < MAX_TRACE_CYCLE &&
traceBuffer.Pop(id, sampleTs, traceSampleBuffer, size, TRACE_SAMPLE_MAX)) {
hasData = true;
traceCount++;
StreamString sigName;
TypeDescriptor sigType = UnsignedInteger32Bit;
mutex.FastLock();
for (uint32 i = 0u; i < signals.GetNumberOfElements(); i++) {
if (signals[i]->internalID == id) {
sigName = signals[i]->name;
sigType = signals[i]->type;
break;
}
}
mutex.FastUnLock();
uint32 tsMs = (sampleTs >= streamerT0Ns)
? (uint32)((sampleTs - streamerT0Ns) / 1000000u) : 0u;
float64 val = WDS_ToFloat64(traceSampleBuffer, sigType);
char8 valBuf[64] = { '\0' };
{
AnyType vdst(CharString, 0u, valBuf); vdst.SetNumberOfElements(0u, 63u);
AnyType vsrc(Float64Bit, 0u, &val);
(void)TypeConvert(vdst, vsrc);
}
StreamString ev;
ev.Printf("{\"type\":\"trace\",\"name\":\"%s\",\"ts\":%u,\"value\":%s}",
sigName.Buffer(), tsMs, valBuf);
BroadcastSse("message", ev);
}
// -----------------------------------------------------------------
// Periodic status heartbeat (every 500 ms)
// -----------------------------------------------------------------
static uint64 lastStatusMs = 0u;
if (nowMs - lastStatusMs >= 500u) {
lastStatusMs = nowMs;
mutex.FastLock();
bool paused = isPaused;
StreamString gam = pausedAtGam;
uint32 rem = stepRemaining;
mutex.FastUnLock();
StreamString ev;
ev.Printf(
"{\"type\":\"status\",\"paused\":%s,\"gam\":\"%s\",\"remaining\":%u}",
paused ? "true" : "false", gam.Buffer(), rem);
BroadcastSse("message", ev);
}
RemoveDeadSseClients();
(void)hasData;
Sleep::MSec(10u);
return ErrorManagement::NoError;
}
} // namespace MARTe
@@ -0,0 +1,108 @@
#ifndef WEBDEBUGSERVICE_H
#define WEBDEBUGSERVICE_H
#include "BasicTCPSocket.h"
#include "DebugServiceBase.h"
#include "EmbeddedServiceMethodBinderI.h"
#include "ReferenceT.h"
#include "SingleThreadService.h"
namespace MARTe {
/**
* @brief HTTP/SSE implementation of DebugServiceI (via DebugServiceBase).
*
* Serves a single-page web UI on httpPort (default 8090).
* Endpoints:
* GET / — embedded HTML application
* POST /api/command — execute a debug command; returns text response
* GET /api/events — Server-Sent Events stream for real-time telemetry
*
* All signal management and command dispatch logic lives in DebugServiceBase.
* This class adds only the HTTP/SSE transport.
*/
class WebDebugService : public DebugServiceBase,
public EmbeddedServiceMethodBinderI {
public:
friend class WebDebugServiceTest;
CLASS_REGISTER_DECLARATION()
WebDebugService();
virtual ~WebDebugService();
virtual bool Initialise(StructuredDataI &data);
// EmbeddedServiceMethodBinderI (framework dispatches to sub-binders)
virtual ErrorManagement::ErrorType Execute(ExecutionInfo &info);
protected:
// Transport-specific overrides of DebugServiceBase hooks
virtual void GetServiceInfo(StreamString &out);
virtual void RebuildTransportConfig() {} // no transport-specific keys
private:
// HTTP server helpers
bool ParseRequest(BasicTCPSocket *client, StreamString &method,
StreamString &path, StreamString &body);
void SendHttp(BasicTCPSocket *client, uint32 code, const char8 *ct,
StreamString &body);
void HandleRequest(BasicTCPSocket *client, const StreamString &method,
const StreamString &path, const StreamString &body);
void UpgradeToSse(BasicTCPSocket *client);
// SSE broadcast
void BroadcastSse(const char8 *eventType, const StreamString &data);
void RemoveDeadSseClients();
// Service thread entry points
ErrorManagement::ErrorType HttpServer(ExecutionInfo &info);
ErrorManagement::ErrorType Streamer (ExecutionInfo &info);
// Sub-binder so the framework can dispatch to two separate threads
class WdsBinder : public EmbeddedServiceMethodBinderI {
public:
enum ServiceType { Http, Stream };
WdsBinder(WebDebugService *p, ServiceType t) : parent(p), stype(t) {}
virtual ErrorManagement::ErrorType Execute(ExecutionInfo &info) {
return (stype == Stream) ? parent->Streamer(info)
: parent->HttpServer(info);
}
private:
WebDebugService *parent;
ServiceType stype;
};
uint16 httpPort;
BasicTCPSocket tcpServer;
WdsBinder binderHttp;
WdsBinder binderStream;
SingleThreadService httpService;
SingleThreadService streamerService;
// SSE client list
static const uint32 MAX_SSE_CLIENTS = 8u;
BasicTCPSocket *sseClients[MAX_SSE_CLIENTS];
FastPollingMutexSem sseMutex;
// Streamer packet state
uint32 streamerSeq;
uint64 streamerT0Ns; // nanosecond origin for relative timestamps sent over SSE
// Log history buffer — replayed to newly connecting SSE clients
static const uint32 LOG_HISTORY_SIZE = 64u;
static const uint32 LOG_ENTRY_MAX_SIZE = 512u;
char8 logHistory[64][512];
uint32 logHistoryWriteIdx;
uint32 logHistoryFill;
FastPollingMutexSem logHistoryMutex;
// Staging buffer for trace ring-buffer pops (max UDP datagram payload).
static const uint32 TRACE_SAMPLE_MAX = 65499u;
uint8 traceSampleBuffer[TRACE_SAMPLE_MAX];
};
} // namespace MARTe
#endif // WEBDEBUGSERVICE_H
@@ -0,0 +1,611 @@
#ifndef WEBUI_H
#define WEBUI_H
#include "CompilerTypes.h"
namespace MARTe {
// clang-format off
static const char8 *const WEB_UI_HTML =
"<!DOCTYPE html>\n"
"<html lang='en'>\n"
"<head>\n"
"<meta charset='UTF-8'>\n"
"<meta name='viewport' content='width=device-width,initial-scale=1'>\n"
"<title>MARTe2 Debug</title>\n"
"<script src='https://cdn.jsdelivr.net/npm/chart.js@4.4.0/dist/chart.umd.min.js'></script>\n"
"<style>\n"
":root{--base:#1e1e2e;--mantle:#181825;--crust:#11111b;--text:#cdd6f4;--sub:#a6adc8;\n"
" --ov:#6c7086;--s0:#313244;--s1:#45475a;--s2:#585b70;--blue:#89b4fa;\n"
" --green:#a6e3a1;--yellow:#f9e2af;--red:#f38ba8;--mauve:#cba6f7;--peach:#fab387;\n"
" --teal:#94e2d5;--sky:#89dceb;}\n"
"*{box-sizing:border-box;margin:0;padding:0;}\n"
"body{background:var(--base);color:var(--text);font-family:'JetBrains Mono','Fira Code',monospace;\n"
" font-size:12px;height:100vh;display:flex;flex-direction:column;overflow:hidden;}\n"
"#toolbar{background:var(--mantle);border-bottom:1px solid var(--s0);padding:5px 8px;\n"
" display:flex;align-items:center;gap:6px;flex-shrink:0;flex-wrap:wrap;}\n"
".dot{width:9px;height:9px;border-radius:50%;background:var(--red);flex-shrink:0;}\n"
".dot.ok{background:var(--green);}\n"
".dot.pause{background:var(--yellow);animation:blink 1s infinite;}\n"
"@keyframes blink{0%,100%{opacity:1}50%{opacity:.3}}\n"
"button{background:var(--s0);color:var(--text);border:1px solid var(--s1);border-radius:3px;\n"
" padding:2px 7px;cursor:pointer;font-size:11px;font-family:inherit;}\n"
"button:hover{background:var(--s1);}\n"
"button.act{background:var(--blue);color:var(--base);border-color:var(--blue);}\n"
"button.danger{background:var(--red);color:var(--base);border-color:var(--red);}\n"
"input[type=text],input[type=number]{background:var(--s0);color:var(--text);\n"
" border:1px solid var(--s1);border-radius:3px;padding:2px 5px;font-size:11px;font-family:inherit;}\n"
"input:focus{outline:none;border-color:var(--blue);}\n"
"label{color:var(--sub);font-size:11px;}\n"
"select{background:var(--s0);color:var(--text);border:1px solid var(--s1);border-radius:3px;\n"
" padding:2px 5px;font-size:11px;font-family:inherit;}\n"
".sep{width:1px;height:18px;background:var(--s1);flex-shrink:0;}\n"
"#main{display:flex;flex:1;overflow:hidden;}\n"
"#left{width:255px;background:var(--mantle);border-right:1px solid var(--s0);\n"
" display:flex;flex-direction:column;overflow:hidden;flex-shrink:0;}\n"
"#center{flex:1;display:flex;flex-direction:column;overflow:hidden;}\n"
"#right{width:215px;background:var(--mantle);border-left:1px solid var(--s0);\n"
" display:flex;flex-direction:column;overflow:hidden;flex-shrink:0;}\n"
"#bottom{height:135px;background:var(--mantle);border-top:1px solid var(--s0);\n"
" display:flex;flex-direction:column;flex-shrink:0;}\n"
".ph{background:var(--crust);padding:4px 7px;font-size:11px;color:var(--sub);\n"
" display:flex;align-items:center;justify-content:space-between;flex-shrink:0;\n"
" border-bottom:1px solid var(--s0);}\n"
".ph span{font-weight:bold;color:var(--blue);}\n"
"#tree{flex:1;overflow-y:auto;padding:3px;}\n"
".tr{display:flex;align-items:center;padding:2px 3px;border-radius:3px;gap:2px;cursor:default;}\n"
".tr:hover{background:var(--s0);}\n"
".tog{width:13px;text-align:center;cursor:pointer;color:var(--ov);font-size:10px;flex-shrink:0;}\n"
".ico{flex-shrink:0;font-size:10px;}\n"
".tn{flex:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-size:11px;}\n"
".sig{color:var(--green);}\n"
".tbtns{display:none;gap:2px;}\n"
".tr:hover .tbtns{display:flex;}\n"
".tb{background:none;border:none;padding:1px 3px;font-size:10px;cursor:pointer;\n"
" border-radius:2px;color:var(--sub);}\n"
".tb:hover{background:var(--s1);color:var(--text);}\n"
".tch{padding-left:13px;}\n"
"#ctrls{padding:4px 7px;display:flex;align-items:center;gap:5px;background:var(--crust);\n"
" border-bottom:1px solid var(--s0);flex-shrink:0;flex-wrap:wrap;}\n"
"#ca{flex:1;padding:6px;overflow:hidden;position:relative;}\n"
"#mc{display:block;width:100%;height:100%;}\n"
"#traced{flex:1;overflow-y:auto;padding:3px;}\n"
".ti{display:flex;align-items:center;gap:3px;padding:2px 4px;border-radius:3px;margin-bottom:1px;}\n"
".ti:hover{background:var(--s0);}\n"
".tc{width:7px;height:7px;border-radius:2px;flex-shrink:0;}\n"
".tnm{flex:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-size:11px;}\n"
".tv{font-size:10px;color:var(--yellow);min-width:55px;text-align:right;flex-shrink:0;}\n"
".titbs{display:none;gap:2px;}\n"
".ti:hover .titbs{display:flex;}\n"
"#ltb{padding:3px 5px;display:flex;gap:6px;align-items:center;background:var(--crust);\n"
" border-bottom:1px solid var(--s0);flex-shrink:0;}\n"
"#lc{flex:1;overflow-y:auto;padding:2px 5px;}\n"
".le{font-size:10px;line-height:1.4;font-family:monospace;white-space:pre-wrap;word-break:break-all;}\n"
".lDEBUG{color:var(--ov);}\n"
".lINFO{color:var(--text);}\n"
".lWARNING{color:var(--yellow);}\n"
".lERROR{color:var(--red);}\n"
".mo{display:none;position:fixed;top:0;left:0;right:0;bottom:0;background:rgba(0,0,0,.7);\n"
" z-index:100;align-items:center;justify-content:center;}\n"
".mo.show{display:flex;}\n"
".mb{background:var(--mantle);border:1px solid var(--s1);border-radius:7px;padding:15px;min-width:290px;}\n"
".mb h3{color:var(--blue);margin-bottom:11px;font-size:13px;}\n"
".fr{display:flex;align-items:center;gap:7px;margin-bottom:7px;}\n"
".fr label{min-width:75px;color:var(--sub);}\n"
".fr input,.fr select,.fr textarea{flex:1;}\n"
"textarea{background:var(--s0);color:var(--text);border:1px solid var(--s1);border-radius:3px;\n"
" padding:2px 5px;font-size:11px;font-family:inherit;resize:vertical;}\n"
"textarea:focus{outline:none;border-color:var(--blue);}\n"
".mbtns{display:flex;gap:7px;justify-content:flex-end;margin-top:11px;}\n"
"::-webkit-scrollbar{width:5px;height:5px;}\n"
"::-webkit-scrollbar-track{background:var(--mantle);}\n"
"::-webkit-scrollbar-thumb{background:var(--s1);border-radius:3px;}\n"
"</style>\n"
"</head>\n"
"<body>\n"
"<div id='toolbar'>\n"
" <div id='sdot' class='dot'></div>\n"
" <span id='stxt' style='color:var(--sub);font-size:11px'>Connecting\xe2\x80\xa6</span>\n"
" <div class='sep'></div>\n"
" <button onclick='cmd(\"DISCOVER\")'>Discover</button>\n"
" <button onclick='cmd(\"TREE\")'>Tree</button>\n"
" <div class='sep'></div>\n"
" <button id='pbtn' onclick='togglePause()'>Pause</button>\n"
" <div class='sep'></div>\n"
" <label>Step:</label>\n"
" <input type='number' id='sn' value='1' min='1' style='width:45px'>\n"
" <input type='text' id='sthr' list='thrnodes' placeholder='thread' style='width:90px'>\n"
" <datalist id='thrnodes'></datalist>\n"
" <button onclick='doStep()'>Step</button>\n"
" <button onclick='openMsg()'>Msg</button>\n"
" <div class='sep'></div>\n"
" <label>Win:</label>\n"
" <input type='number' id='winms' value='5000' min='100' style='width:60px' onchange='winMs=+this.value'>\n"
" <button onclick='clearChart()'>Clear</button>\n"
" <span id='ss' style='color:var(--yellow);font-size:11px'></span>\n"
"</div>\n"
"<div id='main'>\n"
" <div id='left'>\n"
" <div class='ph'><span>App Tree</span><button onclick='cmd(\"TREE\")' style='font-size:10px'>&#8635;</button></div>\n"
" <div id='tree'><div style='color:var(--ov);padding:7px;font-size:11px'>Click Tree or Discover\xe2\x80\xa6</div></div>\n"
" </div>\n"
" <div id='center'>\n"
" <div id='ctrls'>\n"
" <label>Signal:</label>\n"
" <select id='sigsel' style='width:150px'><option value=''>-- pick --</option></select>\n"
" <button onclick='addToChart()'>+ Plot</button>\n"
" <button onclick='toggleFollow()' id='fbtn' class='act'>Follow</button>\n"
" </div>\n"
" <div id='ca' ondragover='event.preventDefault()' ondrop='dropOnChart(event)'><canvas id='mc'></canvas></div>\n"
" </div>\n"
" <div id='right'>\n"
" <div class='ph'><span>Traced</span></div>\n"
" <div id='traced'></div>\n"
" </div>\n"
"</div>\n"
"<div id='bottom'>\n"
" <div class='ph'>\n"
" <span>Log</span>\n"
" <div style='display:flex;gap:5px;align-items:center'>\n"
" <label><input type='checkbox' id='fdbg' checked> D</label>\n"
" <label><input type='checkbox' id='finf' checked> I</label>\n"
" <label><input type='checkbox' id='fwrn' checked> W</label>\n"
" <label><input type='checkbox' id='ferr' checked> E</label>\n"
" <button onclick='document.getElementById(\"lc\").innerHTML=\"\"'>Clr</button>\n"
" </div>\n"
" </div>\n"
" <div id='lc'></div>\n"
"</div>\n"
"<!-- Modals -->\n"
"<div class='mo' id='frcm'>\n"
" <div class='mb'>\n"
" <h3>Force Signal</h3>\n"
" <div class='fr'><label>Signal:</label><span id='frcn' style='color:var(--green);font-size:11px;flex:1;overflow:hidden;text-overflow:ellipsis'></span></div>\n"
" <div class='fr'><label>Value:</label><input type='text' id='frcv'></div>\n"
" <div class='mbtns'>\n"
" <button onclick='closeM(\"frcm\")'>Cancel</button>\n"
" <button onclick='doUnforce()'>Unforce</button>\n"
" <button class='act' onclick='doForce()'>Force</button>\n"
" </div>\n"
" </div>\n"
"</div>\n"
"<div class='mo' id='brkm'>\n"
" <div class='mb'>\n"
" <h3>Break Condition</h3>\n"
" <div class='fr'><label>Signal:</label><span id='brkn' style='color:var(--green);font-size:11px;flex:1;overflow:hidden;text-overflow:ellipsis'></span></div>\n"
" <div class='fr'><label>Op:</label><select id='brkop'><option>></option><option><</option><option>==</option><option>>=</option><option><=</option><option>!=</option></select></div>\n"
" <div class='fr'><label>Threshold:</label><input type='number' id='brkthr' step='any' value='0'></div>\n"
" <div class='mbtns'>\n"
" <button onclick='closeM(\"brkm\")'>Cancel</button>\n"
" <button onclick='doClrBreak()'>Clear</button>\n"
" <button class='act' onclick='doBreak()'>Set</button>\n"
" </div>\n"
" </div>\n"
"</div>\n"
"<div class='mo' id='monm'>\n"
" <div class='mb'>\n"
" <h3>Monitor Signal</h3>\n"
" <div class='fr'><label>Signal:</label><span id='monn' style='color:var(--green);font-size:11px;flex:1;overflow:hidden;text-overflow:ellipsis'></span></div>\n"
" <div class='fr'><label>Period ms:</label><input type='number' id='monp' value='100' min='10'></div>\n"
" <div class='mbtns'>\n"
" <button onclick='closeM(\"monm\")'>Cancel</button>\n"
" <button onclick='doUnmonitor()'>Unmonitor</button>\n"
" <button class='act' onclick='doMonitor()'>Monitor</button>\n"
" </div>\n"
" </div>\n"
"</div>\n"
"<div class='mo' id='msgm'>\n"
" <div class='mb'>\n"
" <h3>Send Message</h3>\n"
" <div class='fr'><label>Dest:</label><input type='text' id='msgd' list='msgnodes' autocomplete='off'></div>\n"
" <datalist id='msgnodes'></datalist>\n"
" <div class='fr'><label>Function:</label><input type='text' id='msgf'></div>\n"
" <div class='fr'><label>Payload:</label><textarea id='msgp' rows='3' placeholder='key=val&#10;key2=val2'></textarea></div>\n"
" <div class='mbtns'>\n"
" <button onclick='closeM(\"msgm\")'>Cancel</button>\n"
" <button class='act' onclick='doMsg()'>Send</button>\n"
" </div>\n"
" </div>\n"
"</div>\n"
"<script>\n"
"var sigs=[],td={},isPaused=false,chart=null,cds={},winMs=5000,follow=true,curSig='',tnodes=[],threads=[];\n"
"var lc=document.getElementById('lc');\n"
"var COLS=['#89b4fa','#a6e3a1','#fab387','#cba6f7','#f38ba8','#94e2d5','#f9e2af','#89dceb'];\n"
"var ci=0;\n"
"function nc(){return COLS[ci++%COLS.length];}\n"
"\n"
"// --- SSE ---\n"
"function connect(){\n"
" var es=new EventSource('/api/events');\n"
" es.onopen=function(){\n"
" document.getElementById('sdot').className='dot ok';\n"
" document.getElementById('stxt').textContent='Connected';\n"
" cmd('TREE');cmd('DISCOVER');\n"
" };\n"
" es.onerror=function(){\n"
" document.getElementById('sdot').className='dot';\n"
" document.getElementById('stxt').textContent='Reconnecting\xe2\x80\xa6';\n"
" es.close();setTimeout(connect,3000);\n"
" };\n"
" es.onmessage=function(e){\n"
" try{handle(JSON.parse(e.data));}catch(x){}\n"
" };\n"
"}\n"
"\n"
"function handle(ev){\n"
" if(ev.type==='trace'||ev.type==='monitor'){\n"
" var n=ev.name,ts=ev.ts,v=ev.value;\n"
" var isNew=!td[n];\n"
" if(isNew){td[n]={pts:[],last:0,col:nc(),inC:false,tracing:false,forced:false};addOpt(n);updTraced();}\n"
" td[n].pts.push({x:ts,y:v});\n"
" if(td[n].pts.length>10000)td[n].pts.shift();\n"
" td[n].last=v;\n"
" } else if(ev.type==='log'){\n"
" appLog(ev.level,ev.msg);\n"
" } else if(ev.type==='status'){\n"
" isPaused=ev.paused;\n"
" updPause();\n"
" var ss=document.getElementById('ss');\n"
" if(ev.paused){\n"
" ss.textContent='PAUSED'+(ev.gam?' at '+ev.gam:'')+(ev.remaining?' ('+ev.remaining+'step)':'');\n"
" document.getElementById('sdot').className='dot pause';\n"
" } else {\n"
" ss.textContent='';\n"
" document.getElementById('sdot').className='dot ok';\n"
" }\n"
" } else if(ev.type==='discover'){\n"
" sigs=ev.signals||[];\n"
" buildSel();\n"
" } else if(ev.type==='tree'){\n"
" renderTree(ev.tree);\n"
" }\n"
"}\n"
"\n"
"// --- Chart ---\n"
"function initChart(){\n"
" var ctx=document.getElementById('mc').getContext('2d');\n"
" chart=new Chart(ctx,{\n"
" type:'line',\n"
" data:{datasets:[]},\n"
" options:{\n"
" animation:false,responsive:true,maintainAspectRatio:false,parsing:false,\n"
" plugins:{legend:{display:true,position:'bottom',\n"
" labels:{color:'#a6adc8',boxWidth:12,font:{size:10},\n"
" generateLabels:function(ch){return ch.data.datasets.map(function(ds,i){\n"
" return {text:ds.label.split('.').pop(),fillStyle:ds.borderColor,\n"
" strokeStyle:ds.borderColor,lineWidth:0,datasetIndex:i};});}},\n"
" onClick:function(e,li){remFromChart(chart.data.datasets[li.datasetIndex].label);}\n"
" }},\n"
" scales:{\n"
" x:{type:'linear',ticks:{color:'#6c7086',maxTicksLimit:8,\n"
" callback:function(v){return (v/1000).toFixed(1)+'s';}},\n"
" grid:{color:'#313244'}},\n"
" y:{ticks:{color:'#6c7086'},grid:{color:'#313244'}}\n"
" }\n"
" }\n"
" });\n"
" resizeChart();\n"
" window.addEventListener('resize',resizeChart);\n"
"}\n"
"\n"
"function resizeChart(){\n"
" var a=document.getElementById('ca');\n"
" var c=document.getElementById('mc');\n"
" c.width=a.clientWidth;c.height=a.clientHeight;\n"
" if(chart)chart.resize();\n"
"}\n"
"\n"
"function updChart(){\n"
" if(!chart)return;\n"
" var keys=Object.keys(cds);\n"
" if(keys.length===0)return;\n"
" // Find the latest timestamp across all charted signals for follow mode\n"
" var latestTs=0;\n"
" for(var i=0;i<keys.length;i++){\n"
" var t=td[keys[i]];\n"
" if(t&&t.pts.length>0){var lt=t.pts[t.pts.length-1].x;if(lt>latestTs)latestTs=lt;}\n"
" }\n"
" for(var i=0;i<keys.length;i++){\n"
" var n=keys[i],d=cds[n],t=td[n];\n"
" if(!t)continue;\n"
" if(follow){\n"
" var pts=[],minT=latestTs-winMs;\n"
" for(var j=0;j<t.pts.length;j++){if(t.pts[j].x>=minT)pts.push(t.pts[j]);}\n"
" chart.data.datasets[d].data=pts;\n"
" } else {\n"
" chart.data.datasets[d].data=t.pts.slice();\n"
" }\n"
" }\n"
" chart.update('none');\n"
"}\n"
"setInterval(function(){if(Object.keys(cds).length>0)updChart();tickValues();},100);\n"
"\n"
"function addToChart(){\n"
" var n=document.getElementById('sigsel').value;\n"
" if(!n||cds.hasOwnProperty(n))return;\n"
" if(!td[n])td[n]={pts:[],last:0,col:nc(),inC:false,tracing:false,forced:false};\n"
" var col=td[n].col,idx=chart.data.datasets.length;\n"
" cds[n]=idx;td[n].inC=true;td[n].tracing=true;\n"
" chart.data.datasets.push({label:n,data:[],borderColor:col,\n"
" backgroundColor:col+'20',borderWidth:1.5,pointRadius:0,tension:0});\n"
" chart.update('none');updTraced();\n"
" cmd('TRACE '+n+' 1');\n"
"}\n"
"\n"
"function addByName(n){\n"
" if(!n||cds.hasOwnProperty(n))return;\n"
" if(!td[n])td[n]={pts:[],last:0,col:nc(),inC:false,tracing:false,forced:false};\n"
" var col=td[n].col,idx=chart.data.datasets.length;\n"
" cds[n]=idx;td[n].inC=true;td[n].tracing=true;\n"
" chart.data.datasets.push({label:n,data:[],borderColor:col,\n"
" backgroundColor:col+'20',borderWidth:1.5,pointRadius:0,tension:0});\n"
" chart.update('none');updTraced();\n"
" cmd('TRACE '+n+' 1');\n"
"}\n"
"\n"
"function dragStart(ev,n){ev.dataTransfer.setData('text',n);}\n"
"function dropOnChart(ev){ev.preventDefault();var n=ev.dataTransfer.getData('text');if(n)addByName(n);}\n"
"\n"
"function remFromChart(n){\n"
" if(!cds.hasOwnProperty(n))return;\n"
" var idx=cds[n];\n"
" chart.data.datasets.splice(idx,1);\n"
" delete cds[n];\n"
" var ks=Object.keys(cds);\n"
" for(var i=0;i<ks.length;i++){if(cds[ks[i]]>idx)cds[ks[i]]--;}\n"
" if(td[n])td[n].inC=false;\n"
" chart.update('none');updTraced();\n"
"}\n"
"\n"
"function clearChart(){\n"
" var ks=Object.keys(cds);\n"
" for(var i=0;i<ks.length;i++){if(td[ks[i]])td[ks[i]].inC=false;}\n"
" chart.data.datasets=[];cds={};\n"
" chart.update('none');updTraced();\n"
"}\n"
"\n"
"function toggleFollow(){\n"
" follow=!follow;\n"
" document.getElementById('fbtn').className=follow?'act':'';\n"
"}\n"
"\n"
"// --- Traced list ---\n"
"function escId(s){return String(s).replace(/[^a-zA-Z0-9]/g,'_');}\n"
"function updTraced(){\n"
" var h='',ks=Object.keys(td);\n"
" for(var i=0;i<ks.length;i++){\n"
" var n=ks[i],t=td[n];\n"
" var v=typeof t.last==='number'?t.last.toPrecision(5):String(t.last);\n"
" var sn=n.split('.').pop();\n"
" h+='<div class=\"ti\" draggable=\"true\" ondragstart=\"dragStart(event,\\''+escJ(n)+'\\')\">'\n"
" h+='<div class=\"tc\" style=\"background:'+t.col+'\"></div>';\n"
" h+='<div class=\"tnm\" title=\"'+escH(n)+'\">'+escH(sn)+'</div>';\n"
" h+='<div class=\"tv\" id=\"tv_'+escId(n)+'\">'+escH(v)+'</div>';\n"
" h+='<div class=\"titbs\">';\n"
" if(t.inC)h+='<button class=\"tb\" onclick=\"remFromChart(\\''+escJ(n)+'\\')\">&#10005;</button>';\n"
" else h+='<button class=\"tb\" onclick=\"addByName(\\''+escJ(n)+'\\')\">&#9654;</button>';\n"
" if(t.tracing)h+='<button class=\"tb\" title=\"Untrace\" onclick=\"untraceN(\\''+escJ(n)+'\\')\">T&#215;</button>';\n"
" if(t.forced) h+='<button class=\"tb\" title=\"Unforce\" onclick=\"doUnforceN(\\''+escJ(n)+'\\')\">F&#215;</button>';\n"
" else h+='<button class=\"tb\" onclick=\"openFrc(\\''+escJ(n)+'\\')\">F</button>';\n"
" h+='</div></div>';\n"
" }\n"
" document.getElementById('traced').innerHTML=h;\n"
"}\n"
"function untraceN(n){cmd('TRACE '+n+' 0');if(td[n])td[n].tracing=false;updTraced();}\n"
"function doUnforceN(n){cmd('UNFORCE '+n);if(td[n])td[n].forced=false;updTraced();}\n"
"function tickValues(){\n"
" var ks=Object.keys(td);\n"
" for(var i=0;i<ks.length;i++){\n"
" var n=ks[i],t=td[n];\n"
" var el=document.getElementById('tv_'+escId(n));\n"
" if(el){var v=typeof t.last==='number'?t.last.toPrecision(5):String(t.last);el.textContent=v;}\n"
" }\n"
"}\n"
"\n"
"// --- Signal select ---\n"
"function buildSel(){\n"
" var s=document.getElementById('sigsel');\n"
" s.innerHTML='<option value=\"\">-- pick --</option>';\n"
" for(var i=0;i<sigs.length;i++){\n"
" s.innerHTML+='<option value=\"'+escH(sigs[i].name)+'\">'+escH(sigs[i].name)+'</option>';\n"
" }\n"
"}\n"
"function addOpt(n){\n"
" var s=document.getElementById('sigsel');\n"
" for(var i=0;i<s.options.length;i++){if(s.options[i].value===n)return;}\n"
" s.innerHTML+='<option value=\"'+escH(n)+'\">'+escH(n)+'</option>';\n"
"}\n"
"\n"
"// --- Log ---\n"
"function appLog(lv,msg){\n"
" var f={DEBUG:document.getElementById('fdbg').checked,\n"
" INFO:document.getElementById('finf').checked,\n"
" WARNING:document.getElementById('fwrn').checked,\n"
" ERROR:document.getElementById('ferr').checked};\n"
" if(lv==='Information')lv='INFO';\n"
" else if(lv==='Warning')lv='WARNING';\n"
" else if(lv==='Debug')lv='DEBUG';\n"
" else if(lv==='FatalError'||lv==='Error'||lv==='WARN')lv='ERROR';\n"
" if(!f[lv])return;\n"
" var d=document.createElement('div');\n"
" d.className='le l'+lv;\n"
" var now=new Date();\n"
" var ts=now.toTimeString().split(' ')[0]+'.'+String(now.getMilliseconds()).padStart(3,'0');\n"
" d.textContent='['+ts+']['+lv.substring(0,4)+'] '+msg;\n"
" lc.appendChild(d);\n"
" if(lc.children.length>500)lc.removeChild(lc.firstChild);\n"
" lc.scrollTop=lc.scrollHeight;\n"
"}\n"
"\n"
"// --- Tree ---\n"
"function renderTree(node){\n"
" tnodes=[];threads=[];\n"
" var c=document.getElementById('tree');\n"
" c.innerHTML='';\n"
" if(!node)return;\n"
" renderNode(node,c,0,'');\n"
" var dl=document.getElementById('thrnodes');\n"
" dl.innerHTML='';\n"
" for(var i=0;i<threads.length;i++){\n"
" var op=document.createElement('option');op.value=threads[i];dl.appendChild(op);\n"
" }\n"
"}\n"
"function renderNode(node,parent,depth,pathPfx){\n"
" var fullPath=pathPfx?(pathPfx+'.'+node.Name):node.Name;\n"
" var isRoot=(node.Class==='ObjectRegistryDatabase');\n"
" if(isRoot)fullPath='';\n"
" var isSig=node.IsTraceable||node.IsForcable;\n"
" if(!isRoot&&fullPath&&!isSig)tnodes.push(fullPath);\n"
" if(node.Class==='RealTimeThread'&&node.Name)threads.push(node.Name);\n"
" var div=document.createElement('div');\n"
" div.className='tn-node';\n"
" var row=document.createElement('div');\n"
" row.className='tr';\n"
" row.style.paddingLeft=(3+depth*13)+'px';\n"
" var hasCh=node.Children&&node.Children.length>0;\n"
" var tog=document.createElement('span');\n"
" tog.className='tog';\n"
" if(hasCh){\n"
" tog.textContent='\\u25b8';\n"
" tog.onclick=function(){\n"
" var ch=div.querySelector('.tch');\n"
" if(ch){ch.style.display=ch.style.display==='none'?'':'none';\n"
" tog.textContent=ch.style.display==='none'?'\\u25b8':'\\u25be';}\n"
" };\n"
" }\n"
" var ico=document.createElement('span');\n"
" ico.className='ico';\n"
" ico.textContent=isSig?'\\u25c6':(hasCh?'\\u25c9':'\\u25cb');\n"
" ico.style.color=isSig?'var(--green)':(hasCh?'var(--blue)':'var(--ov)');\n"
" var nm=document.createElement('span');\n"
" nm.className='tn'+(isSig?' sig':'');\n"
" nm.textContent=node.Name;\n"
" nm.title=(node.Class||'')+(node.Type?' ['+node.Type+']':'');\n"
" row.appendChild(tog);row.appendChild(ico);row.appendChild(nm);\n"
" if(isSig){\n"
" var btns=document.createElement('span');\n"
" btns.className='tbtns';\n"
" var fp=fullPath;\n"
" if(node.IsTraceable){\n"
" addBtn(btns,'T','Trace',function(){if(!td[fp])td[fp]={pts:[],last:0,col:nc(),inC:false,tracing:false,forced:false};td[fp].tracing=true;cmd('TRACE '+fp+' 1');updTraced();});\n"
" addBtn(btns,'\\u25b6','Plot',function(){addByName(fp);});\n"
" }\n"
" if(node.IsForcable){\n"
" addBtn(btns,'F','Force',function(){openFrc(fp);});\n"
" addBtn(btns,'B','Break',function(){openBrk(fp);});\n"
" }\n"
" addBtn(btns,'M','Monitor',function(){openMon(fp);});\n"
" row.appendChild(btns);\n"
" }\n"
" div.appendChild(row);\n"
" if(hasCh){\n"
" var chDiv=document.createElement('div');\n"
" chDiv.className='tch';\n"
" for(var i=0;i<node.Children.length;i++){\n"
" renderNode(node.Children[i],chDiv,depth+1,isRoot?'':fullPath);\n"
" }\n"
" div.appendChild(chDiv);\n"
" }\n"
" parent.appendChild(div);\n"
"}\n"
"function addBtn(parent,lbl,title,fn){\n"
" var b=document.createElement('button');\n"
" b.className='tb';b.textContent=lbl;b.title=title;\n"
" b.onclick=fn;parent.appendChild(b);\n"
"}\n"
"\n"
"// --- Commands ---\n"
"function cmd(c){\n"
" fetch('/api/command',{method:'POST',headers:{'Content-Type':'text/plain'},body:c})\n"
" .then(function(r){return r.text();})\n"
" .then(function(txt){\n"
" if(c.indexOf('DISCOVER')===0){\n"
" try{\n"
" var clean=txt.replace(/\\nOK DISCOVER\\n?$/,'');\n"
" var r=JSON.parse(clean);\n"
" if(r.Signals){sigs=r.Signals;buildSel();}\n"
" }catch(e){}\n"
" } else if(c.indexOf('TREE')===0){\n"
" try{renderTree(JSON.parse(txt.replace(/\\nOK TREE\\n?$/,'')));}\n"
" catch(e){appLog('ERROR','Tree parse: '+e);}\n"
" } else if(c.indexOf('STEP_STATUS')===0){\n"
" try{\n"
" var clean=txt.replace(/\\nOK STEP_STATUS\\n?$/,'');\n"
" var st=JSON.parse(clean);\n"
" var ev={type:'status',paused:st.Paused,gam:st.PausedAtGam,remaining:st.StepRemaining};\n"
" handle(ev);\n"
" }catch(e){}\n"
" }\n"
" })\n"
" .catch(function(e){appLog('ERROR','cmd failed: '+e);});\n"
"}\n"
"\n"
"function togglePause(){\n"
" cmd(isPaused?'RESUME':'PAUSE');\n"
"}\n"
"function updPause(){\n"
" var b=document.getElementById('pbtn');\n"
" b.textContent=isPaused?'Resume':'Pause';\n"
" b.className=isPaused?'danger':'';\n"
"}\n"
"function doStep(){\n"
" var n=document.getElementById('sn').value||'1';\n"
" var t=document.getElementById('sthr').value;\n"
" var c='STEP '+n;if(t)c+=' '+t;\n"
" cmd(c);\n"
"}\n"
"\n"
"// --- Modals ---\n"
"function openFrc(n){curSig=n;document.getElementById('frcn').textContent=n;\n"
" document.getElementById('frcv').value='';showM('frcm');}\n"
"function doForce(){var v=document.getElementById('frcv').value;\n"
" if(v!==''){cmd('FORCE '+curSig+' '+v);if(td[curSig])td[curSig].forced=true;}\n"
" closeM('frcm');updTraced();}\n"
"function doUnforce(){cmd('UNFORCE '+curSig);if(td[curSig])td[curSig].forced=false;closeM('frcm');updTraced();}\n"
"\n"
"function openBrk(n){curSig=n;document.getElementById('brkn').textContent=n;showM('brkm');}\n"
"function doBreak(){var op=document.getElementById('brkop').value;\n"
" var t=document.getElementById('brkthr').value;\n"
" cmd('BREAK '+curSig+' '+op+' '+t);closeM('brkm');}\n"
"function doClrBreak(){cmd('BREAK '+curSig+' OFF');closeM('brkm');}\n"
"\n"
"function openMon(n){curSig=n;document.getElementById('monn').textContent=n;showM('monm');}\n"
"function doMonitor(){var p=document.getElementById('monp').value||'100';\n"
" cmd('MONITOR SIGNAL '+curSig+' '+p);closeM('monm');}\n"
"function doUnmonitor(){cmd('UNMONITOR SIGNAL '+curSig);closeM('monm');}\n"
"\n"
"function openMsg(){\n"
" var dl=document.getElementById('msgnodes');\n"
" dl.innerHTML='';\n"
" for(var i=0;i<tnodes.length;i++){\n"
" var op=document.createElement('option');op.value=tnodes[i];dl.appendChild(op);\n"
" }\n"
" showM('msgm');\n"
"}\n"
"function doMsg(){var d=document.getElementById('msgd').value;\n"
" var f=document.getElementById('msgf').value;\n"
" var p=document.getElementById('msgp').value;\n"
" var c='MSG '+d+' '+f+' 0';if(p)c+=' '+p.replace(/\\n/g,' ');\n"
" cmd(c);closeM('msgm');}\n"
"\n"
"function showM(id){document.getElementById(id).className='mo show';}\n"
"function closeM(id){document.getElementById(id).className='mo';}\n"
"document.querySelectorAll('.mo').forEach(function(el){\n"
" el.addEventListener('click',function(e){if(e.target===el)closeM(el.id);});\n"
"});\n"
"\n"
"// --- Utils ---\n"
"function escH(s){return String(s).replace(/&/g,'&amp;').replace(/</g,'&lt;').replace(/>/g,'&gt;').replace(/\"/g,'&quot;');}\n"
"function escJ(s){return String(s).replace(/\\\\/g,'\\\\\\\\').replace(/'/g,\"\\\\'\");}\n"
"\n"
"// Init\n"
"initChart();\n"
"connect();\n"
"</script>\n"
"</body>\n"
"</html>\n";
// clang-format on
} // namespace MARTe
#endif // WEBUI_H
-151
View File
@@ -1,151 +0,0 @@
#include "DebugFastScheduler.h"
#include "AdvancedErrorManagement.h"
#include "ExecutionInfo.h"
#include "MemoryOperationsHelper.h"
#include "ObjectRegistryDatabase.h"
namespace MARTe {
const uint64 ALL_CPUS = 0xFFFFFFFFFFFFFFFFull;
DebugFastScheduler::DebugFastScheduler() :
FastScheduler(),
debugBinder(*this, &DebugFastScheduler::Execute)
{
debugService = NULL_PTR(DebugService*);
}
DebugFastScheduler::~DebugFastScheduler() {
}
bool DebugFastScheduler::Initialise(StructuredDataI & data) {
bool ret = FastScheduler::Initialise(data);
if (ret) {
ReferenceContainer *root = ObjectRegistryDatabase::Instance();
Reference serviceRef = root->Find("DebugService");
if (serviceRef.IsValid()) {
debugService = dynamic_cast<DebugService*>(serviceRef.operator->());
}
}
return ret;
}
ErrorManagement::ErrorType DebugFastScheduler::DebugSetupThreadMap() {
ErrorManagement::ErrorType err;
ComputeMaxNThreads();
REPORT_ERROR(ErrorManagement::Information, "DebugFastScheduler: Max Threads=%!", maxNThreads);
multiThreadService = new (NULL) MultiThreadService(debugBinder);
multiThreadService->SetNumberOfPoolThreads(maxNThreads);
err = multiThreadService->CreateThreads();
if (err.ErrorsCleared()) {
rtThreadInfo[0] = new RTThreadParam[maxNThreads];
rtThreadInfo[1] = new RTThreadParam[maxNThreads];
for (uint32 i = 0u; i < numberOfStates; i++) {
cpuMap[i] = new uint64[maxNThreads];
for (uint32 j = 0u; j < maxNThreads; j++) {
cpuMap[i][j] = ALL_CPUS;
}
}
if (countingSem.Create(maxNThreads)) {
for (uint32 i = 0u; i < numberOfStates; i++) {
uint32 nThreads = states[i].numberOfThreads;
cpuThreadMap[i] = new uint32[nThreads];
for (uint32 j = 0u; j < nThreads; j++) {
uint64 cpu = static_cast<uint64>(states[i].threads[j].cpu.GetProcessorMask());
CreateThreadMap(cpu, i, j);
}
}
}
}
return err;
}
void DebugFastScheduler::CustomPrepareNextState() {
ErrorManagement::ErrorType err;
err = !realTimeApplicationT.IsValid();
if (err.ErrorsCleared()) {
uint8 nextBuffer = static_cast<uint8>(realTimeApplicationT->GetIndex());
nextBuffer++;
nextBuffer &= 0x1u;
if (!initialised) {
cpuMap = new uint64*[numberOfStates];
cpuThreadMap = new uint32*[numberOfStates];
err = DebugSetupThreadMap();
}
if (err.ErrorsCleared()) {
for (uint32 j = 0u; j < maxNThreads; j++) {
rtThreadInfo[nextBuffer][j].executables = NULL_PTR(ExecutableI **);
rtThreadInfo[nextBuffer][j].numberOfExecutables = 0u;
rtThreadInfo[nextBuffer][j].cycleTime = NULL_PTR(uint32 *);
rtThreadInfo[nextBuffer][j].lastCycleTimeStamp = 0u;
}
ScheduledState *nextState = GetSchedulableStates()[nextBuffer];
uint32 numberOfThreads = nextState->numberOfThreads;
for (uint32 i = 0u; i < numberOfThreads; i++) {
rtThreadInfo[nextBuffer][cpuThreadMap[nextStateIdentifier][i]].executables = nextState->threads[i].executables;
rtThreadInfo[nextBuffer][cpuThreadMap[nextStateIdentifier][i]].numberOfExecutables = nextState->threads[i].numberOfExecutables;
rtThreadInfo[nextBuffer][cpuThreadMap[nextStateIdentifier][i]].cycleTime = nextState->threads[i].cycleTime;
rtThreadInfo[nextBuffer][cpuThreadMap[nextStateIdentifier][i]].lastCycleTimeStamp = 0u;
}
}
}
}
ErrorManagement::ErrorType DebugFastScheduler::Execute(ExecutionInfo & information) {
ErrorManagement::ErrorType ret;
if (information.GetStage() == MARTe::ExecutionInfo::StartupStage) {
}
else if (information.GetStage() == MARTe::ExecutionInfo::MainStage) {
uint32 threadNumber = information.GetThreadNumber();
(void) eventSem.Wait(TTInfiniteWait);
if (superFast == 0u) {
(void) countingSem.WaitForAll(TTInfiniteWait);
}
uint32 idx = static_cast<uint32>(realTimeApplicationT->GetIndex());
if (rtThreadInfo[idx] != NULL_PTR(RTThreadParam *)) {
if (rtThreadInfo[idx][threadNumber].numberOfExecutables > 0u) {
// EXECUTION CONTROL HOOK
if (debugService != NULL_PTR(DebugService*)) {
while (debugService->IsPaused()) {
Sleep::MSec(1);
}
}
bool ok = ExecuteSingleCycle(rtThreadInfo[idx][threadNumber].executables, rtThreadInfo[idx][threadNumber].numberOfExecutables);
if (!ok) {
if (errorMessage.IsValid()) {
(void)MessageI::SendMessage(errorMessage, this);
}
}
uint32 absTime = 0u;
if (rtThreadInfo[idx][threadNumber].lastCycleTimeStamp != 0u) {
uint64 tmp = (HighResolutionTimer::Counter() - rtThreadInfo[idx][threadNumber].lastCycleTimeStamp);
float64 ticksToTime = (static_cast<float64>(tmp) * clockPeriod) * 1e6;
absTime = static_cast<uint32>(ticksToTime);
}
uint32 sizeToCopy = static_cast<uint32>(sizeof(uint32));
(void)MemoryOperationsHelper::Copy(rtThreadInfo[idx][threadNumber].cycleTime, &absTime, sizeToCopy);
rtThreadInfo[idx][threadNumber].lastCycleTimeStamp = HighResolutionTimer::Counter();
}
else {
(void) unusedThreadsSem.Wait(TTInfiniteWait);
}
}
}
return ret;
}
CLASS_REGISTER(DebugFastScheduler, "1.0")
}
-766
View File
@@ -1,766 +0,0 @@
#include "DebugService.h"
#include "AdvancedErrorManagement.h"
#include "StreamString.h"
#include "DebugBrokerWrapper.h"
#include "DebugFastScheduler.h"
#include "ObjectRegistryDatabase.h"
#include "ClassRegistryItem.h"
#include "ObjectBuilder.h"
#include "TypeConversion.h"
#include "HighResolutionTimer.h"
#include "ConfigurationDatabase.h"
#include "GAM.h"
// Explicitly include target brokers for templating
namespace MARTe {
DebugService* DebugService::instance = NULL_PTR(DebugService*);
static void EscapeJson(const char8* src, StreamString &dst) {
if (src == NULL_PTR(const char8*)) return;
while (*src != '\0') {
if (*src == '"') dst += "\\\"";
else if (*src == '\\') dst += "\\\\";
else if (*src == '\n') dst += "\\n";
else if (*src == '\r') dst += "\\r";
else if (*src == '\t') dst += "\\t";
else dst += *src;
src++;
}
}
CLASS_REGISTER(DebugService, "1.0")
DebugService::DebugService() :
ReferenceContainer(), EmbeddedServiceMethodBinderI(),
binderServer(this, ServiceBinder::ServerType),
binderStreamer(this, ServiceBinder::StreamerType),
threadService(binderServer),
streamerService(binderStreamer)
{
controlPort = 0;
streamPort = 8081;
streamIP = "127.0.0.1";
numberOfSignals = 0;
numberOfAliases = 0;
isServer = false;
suppressTimeoutLogs = true;
isPaused = false;
for (uint32 i=0; i<MAX_CLIENTS; i++) {
activeClients[i] = NULL_PTR(BasicTCPSocket*);
}
serverThreadId = InvalidThreadIdentifier;
streamerThreadId = InvalidThreadIdentifier;
}
DebugService::~DebugService() {
if (instance == this) {
instance = NULL_PTR(DebugService*);
}
threadService.Stop();
streamerService.Stop();
tcpServer.Close();
udpSocket.Close();
for (uint32 i=0; i<MAX_CLIENTS; i++) {
if (activeClients[i] != NULL_PTR(BasicTCPSocket*)) {
activeClients[i]->Close();
delete activeClients[i];
}
}
}
bool DebugService::Initialise(StructuredDataI & data) {
if (!ReferenceContainer::Initialise(data)) return false;
if (!data.Read("ControlPort", controlPort)) {
(void)data.Read("TcpPort", controlPort);
}
if (controlPort > 0) {
isServer = true;
instance = this;
}
if (!data.Read("StreamPort", streamPort)) {
(void)data.Read("UdpPort", streamPort);
}
StreamString tempIP;
if (data.Read("StreamIP", tempIP)) {
streamIP = tempIP;
} else {
streamIP = "127.0.0.1";
}
uint32 suppress = 1;
if (data.Read("SuppressTimeoutLogs", suppress)) {
suppressTimeoutLogs = (suppress == 1);
}
if (isServer) {
if (!traceBuffer.Init(1024 * 1024)) return false;
PatchRegistry();
ConfigurationDatabase threadData;
threadData.Write("Timeout", (uint32)1000);
threadService.Initialise(threadData);
streamerService.Initialise(threadData);
if (!tcpServer.Open()) {
REPORT_ERROR(ErrorManagement::FatalError, "DebugService: Failed to open TCP Server Socket");
return false;
}
if (!tcpServer.Listen(controlPort)) {
REPORT_ERROR(ErrorManagement::FatalError, "DebugService: Failed to Listen on port %u", controlPort);
return false;
}
printf("[DebugService] TCP Server listening on port %u\n", controlPort);
if (!udpSocket.Open()) {
REPORT_ERROR(ErrorManagement::FatalError, "DebugService: Failed to open UDP Socket");
return false;
}
printf("[DebugService] UDP Streamer socket opened\n");
if (threadService.Start() != ErrorManagement::NoError) {
REPORT_ERROR(ErrorManagement::FatalError, "DebugService: Failed to start Server thread");
return false;
}
if (streamerService.Start() != ErrorManagement::NoError) {
REPORT_ERROR(ErrorManagement::FatalError, "DebugService: Failed to start Streamer thread");
return false;
}
printf("[DebugService] Worker threads started.\n");
}
return true;
}
void PatchItemInternal(const char8* className, ObjectBuilder* builder) {
ClassRegistryDatabase *db = ClassRegistryDatabase::Instance();
ClassRegistryItem *item = (ClassRegistryItem*)db->Find(className);
if (item != NULL_PTR(ClassRegistryItem*)) {
item->SetObjectBuilder(builder);
}
}
void DebugService::PatchRegistry() {
static DebugMemoryMapInputBrokerBuilder b1;
PatchItemInternal("MemoryMapInputBroker", &b1);
static DebugMemoryMapOutputBrokerBuilder b2;
PatchItemInternal("MemoryMapOutputBroker", &b2);
static DebugMemoryMapSynchronisedInputBrokerBuilder b3;
PatchItemInternal("MemoryMapSynchronisedInputBroker", &b3);
static DebugMemoryMapSynchronisedOutputBrokerBuilder b4;
PatchItemInternal("MemoryMapSynchronisedOutputBroker", &b4);
static DebugMemoryMapInterpolatedInputBrokerBuilder b5;
PatchItemInternal("MemoryMapInterpolatedInputBroker", &b5);
static DebugMemoryMapMultiBufferInputBrokerBuilder b6;
PatchItemInternal("MemoryMapMultiBufferInputBroker", &b6);
static DebugMemoryMapMultiBufferOutputBrokerBuilder b7;
PatchItemInternal("MemoryMapMultiBufferOutputBroker", &b7);
static DebugMemoryMapSynchronisedMultiBufferInputBrokerBuilder b8;
PatchItemInternal("MemoryMapSynchronisedMultiBufferInputBroker", &b8);
static DebugMemoryMapSynchronisedMultiBufferOutputBrokerBuilder b9;
PatchItemInternal("MemoryMapSynchronisedMultiBufferOutputBroker", &b9);
// Patch Scheduler
static ObjectBuilderT<DebugFastScheduler> schedBuilder;
PatchItemInternal("FastScheduler", &schedBuilder);
}
void DebugService::ProcessSignal(DebugSignalInfo* s, uint32 size) {
if (s != NULL_PTR(DebugSignalInfo*)) {
if (s->isForcing) {
MemoryOperationsHelper::Copy(s->memoryAddress, s->forcedValue, size);
}
if (s->isTracing) {
if (s->decimationFactor <= 1) {
(void)traceBuffer.Push(s->internalID, s->memoryAddress, size);
}
else {
if (s->decimationCounter == 0) {
(void)traceBuffer.Push(s->internalID, s->memoryAddress, size);
s->decimationCounter = s->decimationFactor - 1;
}
else {
s->decimationCounter--;
}
}
}
}
}
DebugSignalInfo* DebugService::RegisterSignal(void* memoryAddress, TypeDescriptor type, const char8* name) {
mutex.FastLock();
DebugSignalInfo* res = NULL_PTR(DebugSignalInfo*);
uint32 sigIdx = 0xFFFFFFFF;
for(uint32 i=0; i<numberOfSignals; i++) {
if(signals[i].memoryAddress == memoryAddress) {
res = &signals[i];
sigIdx = i;
break;
}
}
if (res == NULL_PTR(DebugSignalInfo*) && numberOfSignals < MAX_SIGNALS) {
sigIdx = numberOfSignals;
res = &signals[numberOfSignals];
res->memoryAddress = memoryAddress;
res->type = type;
res->name = name;
res->isTracing = false;
res->isForcing = false;
res->internalID = numberOfSignals;
res->decimationFactor = 1;
res->decimationCounter = 0;
numberOfSignals++;
}
if (sigIdx != 0xFFFFFFFF && numberOfAliases < MAX_ALIASES) {
bool foundAlias = false;
for (uint32 i=0; i<numberOfAliases; i++) {
if (aliases[i].name == name) { foundAlias = true; break; }
}
if (!foundAlias) {
aliases[numberOfAliases].name = name;
aliases[numberOfAliases].signalIndex = sigIdx;
numberOfAliases++;
}
}
mutex.FastUnLock();
return res;
}
static bool RecursiveGetFullObjectName(ReferenceContainer *container, const Object &obj, StreamString &path) {
uint32 size = container->Size();
for (uint32 i=0; i<size; i++) {
Reference child = container->Get(i);
if (child.IsValid()) {
if (child.operator->() == &obj) {
path = child->GetName();
return true;
}
ReferenceContainer *inner = dynamic_cast<ReferenceContainer*>(child.operator->());
if (inner) {
if (RecursiveGetFullObjectName(inner, obj, path)) {
StreamString prefix = child->GetName();
prefix += ".";
prefix += path;
path = prefix;
return true;
}
}
}
}
return false;
}
bool DebugService::GetFullObjectName(const Object &obj, StreamString &fullPath) {
fullPath = "";
if (RecursiveGetFullObjectName(ObjectRegistryDatabase::Instance(), obj, fullPath)) {
return true;
}
return false;
}
ErrorManagement::ErrorType DebugService::Execute(ExecutionInfo & info) {
return ErrorManagement::FatalError;
}
ErrorManagement::ErrorType DebugService::Server(ExecutionInfo & info) {
if (info.GetStage() == ExecutionInfo::TerminationStage) return ErrorManagement::NoError;
if (info.GetStage() == ExecutionInfo::StartupStage) {
serverThreadId = Threads::Id();
return ErrorManagement::NoError;
}
while (info.GetStage() == ExecutionInfo::MainStage) {
BasicTCPSocket *newClient = tcpServer.WaitConnection(1);
if (newClient != NULL_PTR(BasicTCPSocket *)) {
clientsMutex.FastLock();
bool added = false;
for (uint32 i=0; i<MAX_CLIENTS; i++) {
if (activeClients[i] == NULL_PTR(BasicTCPSocket*)) {
activeClients[i] = newClient;
added = true;
break;
}
}
clientsMutex.FastUnLock();
if (!added) {
newClient->Close();
delete newClient;
}
}
for (uint32 i=0; i<MAX_CLIENTS; i++) {
BasicTCPSocket *client = NULL_PTR(BasicTCPSocket*);
clientsMutex.FastLock();
client = activeClients[i];
clientsMutex.FastUnLock();
if (client != NULL_PTR(BasicTCPSocket*)) {
char buffer[1024];
uint32 size = 1024;
TimeoutType timeout(0);
bool ok = client->Read(buffer, size, timeout);
if (ok && size > 0) {
StreamString command;
command.Write(buffer, size);
HandleCommand(command, client);
} else if (!ok) {
if (!client->IsValid()) {
clientsMutex.FastLock();
client->Close();
delete client;
activeClients[i] = NULL_PTR(BasicTCPSocket*);
clientsMutex.FastUnLock();
}
}
}
}
Sleep::MSec(10);
}
return ErrorManagement::NoError;
}
ErrorManagement::ErrorType DebugService::Streamer(ExecutionInfo & info) {
if (info.GetStage() == ExecutionInfo::TerminationStage) return ErrorManagement::NoError;
if (info.GetStage() == ExecutionInfo::StartupStage) {
streamerThreadId = Threads::Id();
return ErrorManagement::NoError;
}
InternetHost dest(streamPort, streamIP.Buffer());
udpSocket.SetDestination(dest);
uint8 packetBuffer[4096];
uint32 packetOffset = 0;
uint32 sequenceNumber = 0;
while (info.GetStage() == ExecutionInfo::MainStage) {
uint32 id;
uint32 size;
uint8 sampleData[1024];
bool hasData = false;
while ((info.GetStage() == ExecutionInfo::MainStage) && traceBuffer.Pop(id, sampleData, size, 1024)) {
hasData = true;
if (packetOffset == 0) {
TraceHeader header;
header.magic = 0xDA7A57AD;
header.seq = sequenceNumber++;
header.timestamp = HighResolutionTimer::Counter();
header.count = 0;
MemoryOperationsHelper::Copy(packetBuffer, &header, sizeof(TraceHeader));
packetOffset = sizeof(TraceHeader);
}
if (packetOffset + 8 + size > 1400) {
uint32 toWrite = packetOffset;
udpSocket.Write((char8*)packetBuffer, toWrite);
packetOffset = 0;
TraceHeader header;
header.magic = 0xDA7A57AD;
header.seq = sequenceNumber++;
header.timestamp = HighResolutionTimer::Counter();
header.count = 0;
MemoryOperationsHelper::Copy(packetBuffer, &header, sizeof(TraceHeader));
packetOffset = sizeof(TraceHeader);
}
MemoryOperationsHelper::Copy(&packetBuffer[packetOffset], &id, 4);
MemoryOperationsHelper::Copy(&packetBuffer[packetOffset + 4], &size, 4);
MemoryOperationsHelper::Copy(&packetBuffer[packetOffset + 8], sampleData, size);
packetOffset += (8 + size);
TraceHeader *h = (TraceHeader*)packetBuffer;
h->count++;
}
if (packetOffset > 0) {
uint32 toWrite = packetOffset;
udpSocket.Write((char8*)packetBuffer, toWrite);
packetOffset = 0;
}
if (!hasData) Sleep::MSec(1);
}
return ErrorManagement::NoError;
}
static bool SuffixMatch(const char8* target, const char8* pattern) {
uint32 tLen = StringHelper::Length(target);
uint32 pLen = StringHelper::Length(pattern);
if (pLen > tLen) return false;
const char8* suffix = target + (tLen - pLen);
if (StringHelper::Compare(suffix, pattern) == 0) {
if (tLen == pLen || *(suffix - 1) == '.') return true;
}
return false;
}
void DebugService::HandleCommand(StreamString cmd, BasicTCPSocket *client) {
StreamString token;
cmd.Seek(0);
char8 term;
const char8* delims = " \r\n";
if (cmd.GetToken(token, delims, term)) {
if (token == "FORCE") {
StreamString name, val;
if (cmd.GetToken(name, delims, term) && cmd.GetToken(val, delims, term)) {
uint32 count = ForceSignal(name.Buffer(), val.Buffer());
if (client) {
StreamString resp; resp.Printf("OK FORCE %u\n", count);
uint32 s = resp.Size(); client->Write(resp.Buffer(), s);
}
}
}
else if (token == "UNFORCE") {
StreamString name;
if (cmd.GetToken(name, delims, term)) {
uint32 count = UnforceSignal(name.Buffer());
if (client) {
StreamString resp; resp.Printf("OK UNFORCE %u\n", count);
uint32 s = resp.Size(); client->Write(resp.Buffer(), s);
}
}
}
else if (token == "TRACE") {
StreamString name, state, decim;
if (cmd.GetToken(name, delims, term) && cmd.GetToken(state, delims, term)) {
bool enable = (state == "1");
uint32 d = 1;
if (cmd.GetToken(decim, delims, term)) {
AnyType decimVal(UnsignedInteger32Bit, 0u, &d);
AnyType decimStr(CharString, 0u, decim.Buffer());
TypeConvert(decimVal, decimStr);
}
uint32 count = TraceSignal(name.Buffer(), enable, d);
if (client) {
StreamString resp; resp.Printf("OK TRACE %u\n", count);
uint32 s = resp.Size(); client->Write(resp.Buffer(), s);
}
}
}
else if (token == "DISCOVER") Discover(client);
else if (token == "PAUSE") {
SetPaused(true);
if (client) { uint32 s = 3; client->Write("OK\n", s); }
}
else if (token == "RESUME") {
SetPaused(false);
if (client) { uint32 s = 3; client->Write("OK\n", s); }
}
else if (token == "TREE") {
StreamString json;
json = "{\"Name\": \"Root\", \"Class\": \"ObjectRegistryDatabase\", \"Children\": [\n";
ExportTree(ObjectRegistryDatabase::Instance(), json);
json += "\n]}\nOK TREE\n";
uint32 s = json.Size();
client->Write(json.Buffer(), s);
}
else if (token == "INFO") {
StreamString path;
if (cmd.GetToken(path, delims, term)) InfoNode(path.Buffer(), client);
}
else if (token == "LS") {
StreamString path;
if (cmd.GetToken(path, delims, term)) ListNodes(path.Buffer(), client);
else ListNodes(NULL_PTR(const char8*), client);
}
else if (client) {
const char* msg = "ERROR: Unknown command\n";
uint32 s = StringHelper::Length(msg);
client->Write(msg, s);
}
}
}
void DebugService::InfoNode(const char8* path, BasicTCPSocket *client) {
if (!client) return;
Reference ref = ObjectRegistryDatabase::Instance()->Find(path);
StreamString json = "{";
if (ref.IsValid()) {
json += "\"Name\": \""; EscapeJson(ref->GetName(), json);
json += "\", \"Class\": \""; EscapeJson(ref->GetClassProperties()->GetName(), json); json += "\"";
ConfigurationDatabase db;
if (ref->ExportData(db)) {
json += ", \"Config\": {";
db.MoveToRoot();
uint32 nChildren = db.GetNumberOfChildren();
for (uint32 i=0; i<nChildren; i++) {
const char8* cname = db.GetChildName(i);
AnyType at = db.GetType(cname);
char8 valBuf[1024];
AnyType strType(CharString, 0u, valBuf);
strType.SetNumberOfElements(0, 1024);
if (TypeConvert(strType, at)) {
json += "\""; EscapeJson(cname, json); json += "\": \"";
EscapeJson(valBuf, json); json += "\"";
if (i < nChildren - 1) json += ", ";
}
}
json += "}";
}
} else {
mutex.FastLock();
bool found = false;
for (uint32 i=0; i<numberOfAliases; i++) {
if (aliases[i].name == path || SuffixMatch(aliases[i].name.Buffer(), path)) {
DebugSignalInfo &s = signals[aliases[i].signalIndex];
const char8* tname = TypeDescriptor::GetTypeNameFromTypeDescriptor(s.type);
json.Printf("\"Name\": \"%s\", \"Class\": \"Signal\", \"Type\": \"%s\", \"ID\": %d",
s.name.Buffer(), tname ? tname : "Unknown", s.internalID);
found = true;
break;
}
}
mutex.FastUnLock();
if (!found) json += "\"Error\": \"Object not found\"";
}
json += "}\nOK INFO\n";
uint32 s = json.Size();
client->Write(json.Buffer(), s);
}
uint32 DebugService::ExportTree(ReferenceContainer *container, StreamString &json) {
if (container == NULL_PTR(ReferenceContainer*)) return 0;
uint32 size = container->Size();
uint32 validCount = 0;
for (uint32 i = 0u; i < size; i++) {
Reference child = container->Get(i);
if (child.IsValid()) {
if (validCount > 0u) json += ",\n";
StreamString nodeJson;
const char8* cname = child->GetName();
if (cname == NULL_PTR(const char8*)) cname = "unnamed";
const char8* clsname = child->GetClassProperties()->GetName();
nodeJson += "{\"Name\": \""; EscapeJson(cname, nodeJson);
nodeJson += "\", \"Class\": \""; EscapeJson(clsname, nodeJson); nodeJson += "\"";
ReferenceContainer *inner = dynamic_cast<ReferenceContainer*>(child.operator->());
DataSourceI *ds = dynamic_cast<DataSourceI*>(child.operator->());
GAM *gam = dynamic_cast<GAM*>(child.operator->());
if ((inner != NULL_PTR(ReferenceContainer*)) || (ds != NULL_PTR(DataSourceI*)) || (gam != NULL_PTR(GAM*))) {
nodeJson += ", \"Children\": [\n";
uint32 subCount = 0u;
if (inner != NULL_PTR(ReferenceContainer*)) subCount += ExportTree(inner, nodeJson);
if (ds != NULL_PTR(DataSourceI*)) {
uint32 nSignals = ds->GetNumberOfSignals();
for (uint32 j = 0u; j < nSignals; j++) {
if (subCount > 0u) nodeJson += ",\n";
subCount++;
StreamString sname; (void)ds->GetSignalName(j, sname);
const char8* stype = TypeDescriptor::GetTypeNameFromTypeDescriptor(ds->GetSignalType(j));
uint8 dims = 0u; (void)ds->GetSignalNumberOfDimensions(j, dims);
uint32 elems = 0u; (void)ds->GetSignalNumberOfElements(j, elems);
nodeJson += "{\"Name\": \""; EscapeJson(sname.Buffer(), nodeJson);
nodeJson += "\", \"Class\": \"Signal\", \"Type\": \""; EscapeJson(stype ? stype : "Unknown", nodeJson);
nodeJson.Printf("\", \"Dimensions\": %d, \"Elements\": %u}", dims, elems);
}
}
if (gam != NULL_PTR(GAM*)) {
uint32 nIn = gam->GetNumberOfInputSignals();
for (uint32 j = 0u; j < nIn; j++) {
if (subCount > 0u) nodeJson += ",\n";
subCount++;
StreamString sname; (void)gam->GetSignalName(InputSignals, j, sname);
const char8* stype = TypeDescriptor::GetTypeNameFromTypeDescriptor(gam->GetSignalType(InputSignals, j));
uint32 dims = 0u; (void)gam->GetSignalNumberOfDimensions(InputSignals, j, dims);
uint32 elems = 0u; (void)gam->GetSignalNumberOfElements(InputSignals, j, elems);
nodeJson += "{\"Name\": \"In."; EscapeJson(sname.Buffer(), nodeJson);
nodeJson += "\", \"Class\": \"InputSignal\", \"Type\": \""; EscapeJson(stype ? stype : "Unknown", nodeJson);
nodeJson.Printf("\", \"Dimensions\": %u, \"Elements\": %u}", dims, elems);
}
uint32 nOut = gam->GetNumberOfOutputSignals();
for (uint32 j = 0u; j < nOut; j++) {
if (subCount > 0u) nodeJson += ",\n";
subCount++;
StreamString sname; (void)gam->GetSignalName(OutputSignals, j, sname);
const char8* stype = TypeDescriptor::GetTypeNameFromTypeDescriptor(gam->GetSignalType(OutputSignals, j));
uint32 dims = 0u; (void)gam->GetSignalNumberOfDimensions(OutputSignals, j, dims);
uint32 elems = 0u; (void)gam->GetSignalNumberOfElements(OutputSignals, j, elems);
nodeJson += "{\"Name\": \"Out."; EscapeJson(sname.Buffer(), nodeJson);
nodeJson += "\", \"Class\": \"OutputSignal\", \"Type\": \""; EscapeJson(stype ? stype : "Unknown", nodeJson);
nodeJson.Printf("\", \"Dimensions\": %u, \"Elements\": %u}", dims, elems);
}
}
nodeJson += "\n]";
}
nodeJson += "}";
json += nodeJson;
validCount++;
}
}
return validCount;
}
uint32 DebugService::ForceSignal(const char8* name, const char8* valueStr) {
mutex.FastLock();
uint32 count = 0;
for (uint32 i = 0; i < numberOfAliases; i++) {
if (aliases[i].name == name || SuffixMatch(aliases[i].name.Buffer(), name)) {
DebugSignalInfo &s = signals[aliases[i].signalIndex];
s.isForcing = true;
AnyType dest(s.type, 0u, s.forcedValue);
AnyType source(CharString, 0u, valueStr);
(void)TypeConvert(dest, source);
count++;
}
}
mutex.FastUnLock();
return count;
}
uint32 DebugService::UnforceSignal(const char8* name) {
mutex.FastLock();
uint32 count = 0;
for (uint32 i = 0; i < numberOfAliases; i++) {
if (aliases[i].name == name || SuffixMatch(aliases[i].name.Buffer(), name)) {
signals[aliases[i].signalIndex].isForcing = false;
count++;
}
}
mutex.FastUnLock();
return count;
}
uint32 DebugService::TraceSignal(const char8* name, bool enable, uint32 decimation) {
mutex.FastLock();
uint32 count = 0;
for (uint32 i = 0; i < numberOfAliases; i++) {
if (aliases[i].name == name || SuffixMatch(aliases[i].name.Buffer(), name)) {
DebugSignalInfo &s = signals[aliases[i].signalIndex];
s.isTracing = enable;
s.decimationFactor = decimation;
s.decimationCounter = 0;
count++;
printf("[Debug] Tracing state for %s (ID: %u) set to %d\n", aliases[i].name.Buffer(), s.internalID, enable);
}
}
mutex.FastUnLock();
return count;
}
void DebugService::Discover(BasicTCPSocket *client) {
if (client) {
StreamString header = "{\n \"Signals\": [\n";
uint32 s = header.Size();
client->Write(header.Buffer(), s);
mutex.FastLock();
for (uint32 i = 0; i < numberOfAliases; i++) {
StreamString line;
DebugSignalInfo &sig = signals[aliases[i].signalIndex];
const char8* typeName = TypeDescriptor::GetTypeNameFromTypeDescriptor(sig.type);
if (typeName == NULL_PTR(const char8*)) typeName = "Unknown";
line.Printf(" {\"name\": \"%s\", \"id\": %d, \"type\": \"%s\"}", aliases[i].name.Buffer(), sig.internalID, typeName);
if (i < numberOfAliases - 1) line += ",";
line += "\n";
s = line.Size();
client->Write(line.Buffer(), s);
}
mutex.FastUnLock();
StreamString footer = " ]\n}\nOK DISCOVER\n";
s = footer.Size();
client->Write(footer.Buffer(), s);
}
}
void DebugService::ListNodes(const char8* path, BasicTCPSocket *client) {
if (!client) return;
Reference ref;
if (path == NULL_PTR(const char8*) || StringHelper::Length(path) == 0 || StringHelper::Compare(path, "/") == 0) {
ref = ObjectRegistryDatabase::Instance();
} else {
ref = ObjectRegistryDatabase::Instance()->Find(path);
}
if (ref.IsValid()) {
StreamString header;
header.Printf("Nodes under %s:\n", path ? path : "/");
uint32 s = header.Size();
client->Write(header.Buffer(), s);
ReferenceContainer *container = dynamic_cast<ReferenceContainer*>(ref.operator->());
if (container) {
uint32 size = container->Size();
for (uint32 i=0; i<size; i++) {
Reference child = container->Get(i);
if (child.IsValid()) {
StreamString line;
line.Printf(" %s [%s]\n", child->GetName(), child->GetClassProperties()->GetName());
s = line.Size();
client->Write(line.Buffer(), s);
}
}
}
DataSourceI *ds = dynamic_cast<DataSourceI*>(ref.operator->());
if (ds) {
StreamString dsHeader = " Signals:\n";
s = dsHeader.Size(); client->Write(dsHeader.Buffer(), s);
uint32 nSignals = ds->GetNumberOfSignals();
for (uint32 i=0; i<nSignals; i++) {
StreamString sname, line;
ds->GetSignalName(i, sname);
TypeDescriptor stype = ds->GetSignalType(i);
const char8* stypeName = TypeDescriptor::GetTypeNameFromTypeDescriptor(stype);
line.Printf(" %s [%s]\n", sname.Buffer(), stypeName ? stypeName : "Unknown");
s = line.Size(); client->Write(line.Buffer(), s);
}
}
GAM *gam = dynamic_cast<GAM*>(ref.operator->());
if (gam) {
uint32 nIn = gam->GetNumberOfInputSignals();
uint32 nOut = gam->GetNumberOfOutputSignals();
StreamString gamHeader;
gamHeader.Printf(" Input Signals (%d):\n", nIn);
s = gamHeader.Size(); client->Write(gamHeader.Buffer(), s);
for (uint32 i=0; i<nIn; i++) {
StreamString sname, line;
gam->GetSignalName(InputSignals, i, sname);
line.Printf(" %s\n", sname.Buffer());
s = line.Size(); client->Write(line.Buffer(), s);
}
gamHeader.SetSize(0);
gamHeader.Printf(" Output Signals (%d):\n", nOut);
s = gamHeader.Size(); client->Write(gamHeader.Buffer(), s);
for (uint32 i=0; i<nOut; i++) {
StreamString sname, line;
gam->GetSignalName(OutputSignals, i, sname);
line.Printf(" %s\n", sname.Buffer());
s = line.Size(); client->Write(line.Buffer(), s);
}
}
const char* okMsg = "OK LS\n";
s = StringHelper::Length(okMsg);
client->Write(okMsg, s);
} else {
const char* msg = "ERROR: Path not found\n";
uint32 s = StringHelper::Length(msg);
client->Write(msg, s);
}
}
}
+200 -37
View File
@@ -1,56 +1,219 @@
# Tutorial: High-Speed Observability with MARTe2 Debug GUI # Tutorial: Observability and Debugging with the MARTe2 Debug Suite
This guide will walk you through the process of tracing and forcing signals in a real-time MARTe2 application using the native Rust GUI client. This guide covers both transport options. Choose the one that fits your workflow:
## 1. Environment Setup | | `WebDebugService` | `DebugService` |
|---|---|---|
| **Client** | Any web browser | Rust native GUI |
| **Setup** | Config only | Config + `cargo run` |
| **Best for** | Quick inspection, remote access | High-performance plots, scripted tooling |
---
## Part A — Web UI (`WebDebugService`)
### A.1 Environment Setup
### Launch the MARTe2 Application
First, start your application using the provided debug runner. This script launches the standard `MARTeApp.ex` while injecting the debugging layer:
```bash ```bash
./run_debug_app.sh cd /path/to/your/marte2/project
source /path/to/marte_debug/env.sh
``` ```
*Note: You should see logs indicating the `DebugService` has started on port 8080 and `TcpLogger` on port 8082.*
### Start the GUI Client ### A.2 Add `WebDebugService` to Your Config
In a new terminal window, navigate to the client directory and run the GUI:
Add the service as a **sibling** of the `+App` node (not inside it):
```text
+WebDebugService = {
Class = WebDebugService
HttpPort = 8090
}
+App = {
Class = RealTimeApplication
...
}
```
Restart your application. You should see:
```
[WebDebugService] HTTP server listening on port 8090
```
### A.3 Open the Web UI
Navigate to `http://localhost:8090` in any browser. The UI connects automatically via SSE.
---
### A.4 Exploring the Object Tree
The **Application Tree** panel on the left mirrors your live ORD hierarchy.
1. Expand `Root → App → Data` to find data sources.
2. Click **Info** next to any node to see its class, config, and signals in the details panel.
3. Click **List** to expand just the immediate children without recursing.
---
### A.5 Real-Time Signal Tracing
1. Locate a signal in the tree, e.g. `Root.App.Data.Timer.Counter`.
2. Click **Trace** next to the signal. The signal appears in the **Traced Signals** list with
its live last value.
3. Click **Plot** to open it in the real-time Chart.js graph. Use the **Follow** toggle to
keep the time axis scrolling.
4. To set the sampling decimation (e.g. every 10th sample), use the command box at the bottom
of the page:
```
TRACE App.Data.Timer.Counter 1 10
```
5. Click **Trace** again (or send `TRACE … 0`) to stop.
---
### A.6 Signal Forcing
1. Find a GAM output signal, e.g. `Root.App.Data.DDB.Counter`.
2. Click **Force**. A modal dialog appears.
3. Enter a value (e.g. `9999`) and click **Apply**.
4. The signal is locked at that value every RT cycle.
5. Click **Unforce** (or use the **Active Controls** panel) to release.
---
### A.7 Breakpoints
1. Click **Break** next to a signal.
2. Select an operator (`>`, `<`, `==`, etc.) and enter a threshold.
3. When the condition fires, the application pauses automatically. The status bar shows
**PAUSED** and the GAM name where execution stopped.
4. Use **Step** to advance one cycle at a time, or **Resume** to continue.
5. Click **Break OFF** to clear the breakpoint.
---
### A.8 Execution Stepping
While paused (after a breakpoint or manual **Pause**):
1. Enter a step count in the **Step** box (e.g. `5`) and click **Step**.
2. The RT loop runs exactly 5 output-broker cycles, then pauses again.
3. The status SSE event (`{"type":"status","remaining":…}`) keeps the UI updated.
---
### A.9 Signal Monitoring
Monitoring polls a signal at a slow rate without using the RT trace path — useful for
`DataSourceI` signals not connected to any GAM.
1. Click **Monitor** next to a signal.
2. Enter a poll period in milliseconds (e.g. `500`).
3. The signal's current value arrives via SSE every 500 ms as a `{"type":"monitor",…}` event.
---
### A.10 Log Viewer
The **Logs** panel at the bottom shows every `REPORT_ERROR` call forwarded as SSE events.
Use the level buttons (D / I / W / E) to filter by severity, or type a keyword to search.
---
## Part B — Rust Native GUI (`DebugService`)
### B.1 Environment Setup
```bash
source /path/to/marte_debug/env.sh
```
### B.2 Add `DebugService` to Your Config
```text
+DebugService = {
Class = DebugService
ControlPort = 8080
UdpPort = 8081
LogPort = 8082
}
+App = {
Class = RealTimeApplication
...
}
```
### B.3 Start the GUI Client
```bash ```bash
cd Tools/gui_client cd Tools/gui_client
cargo run --release cargo run --release
``` ```
## 2. Exploring the Object Tree The GUI connects to `localhost:8080` automatically and requests the tree on startup.
Once connected, the left panel (**Application Tree**) displays the live hierarchy of your application.
1. **Navigate to Data:** Expand `Root` -> `App` -> `Data`. ---
2. **Inspect Nodes:** Click the ** Info** button next to any node (like `Timer` or `DDB`).
3. **View Metadata:** The bottom-left pane will display the full JSON configuration of that object, including its class, parameters, and signals.
## 3. Real-Time Signal Tracing (Oscilloscope) ### B.4 Exploring the Object Tree
Tracing allows you to see signal values exactly as they exist in the real-time memory map.
1. **Find a Signal:** In the tree, locate `Root.App.Data.Timer.Counter`. The **Application Tree** panel on the left shows the live ORD.
2. **Activate Trace:** Click the **📈 Trace** button.
3. **Monitor the Scope:** The central **Oscilloscope** panel will begin plotting the signal.
4. **Verify Data Flow:** Check the **UDP Packets** counter in the top bar; it should be increasing rapidly, confirming high-speed data reception (Port 8081).
5. **Multi-Signal Trace:** You can click **📈 Trace** on other signals (like `Time`) to overlay multiple plots.
## 4. Signal Forcing (Manual Override) 1. Expand `Root → App → Data`.
Forcing allows you to bypass the framework logic and manually set a signal's value in memory. 2. Click ** Info** next to any node to see its JSON config in the bottom-left pane.
1. **Locate Target:** Find a signal that is being written by a GAM, such as `Root.App.Data.DDB.Counter`. ---
2. **Open Force Dialog:** Click the **⚡ Force** button next to the signal.
3. **Inject Value:** In the popup dialog, enter a new value (e.g., `9999`) and click **Apply Force**.
4. **Observe Effect:** If you are tracing the same signal, the oscilloscope plot will immediately jump to and hold at `9999`.
5. **Release Control:** To stop forcing, click the **❌** button in the **Active Controls** (Right Panel) under "Forced Signals". The framework will resume writing its own values to that memory location.
## 5. Advanced Controls ### B.5 Real-Time Signal Tracing (Oscilloscope)
### Global Pause 1. Locate `Root.App.Data.Timer.Counter`.
If you need to "freeze" the entire application to inspect a specific state: 2. Click **📈 Trace**. The **Oscilloscope** panel begins plotting.
- Click **⏸ Pause** in the top bar. The real-time threads will halt at the start of their next cycle. 3. The **UDP Packets** counter in the top bar increments — confirming high-speed telemetry
- Click **▶ Resume** to restart the execution. on port 8081.
4. Drag additional signals from the **Traced Signals** list into the oscilloscope panel for
multi-signal overlay.
### Log Terminal ---
The bottom panel displays every `REPORT_ERROR` event from the C++ framework, powered by the standalone `TcpLogger` service.
- **Regex Filter:** Type a keyword like `Timer` in the filter box to isolate relevant events. ### B.6 Signal Forcing
- **Pause Logs:** Toggle **⏸ Pause Logs** to stop the scrolling view while data continues to be captured in the background.
1. Find `Root.App.Data.DDB.Counter`.
2. Click **⚡ Force**.
3. Enter a value (e.g. `9999`) and click **Apply Force**.
4. The oscilloscope plot immediately jumps to and holds at `9999`.
5. Click **❌** in the **Active Controls** panel to release the force.
---
### B.7 Global Pause and Resume
- Click **⏸ Pause** in the top bar to halt all RT threads.
- Click **▶ Resume** to continue.
---
### B.8 Log Terminal
The bottom panel shows all `REPORT_ERROR` events forwarded from `TcpLogger` (port 8082).
- **Regex Filter:** Type a keyword (e.g. `Timer`) to isolate events.
- **⏸ Pause Logs:** Stop scrolling while continuing to capture.
---
## Part C — Scripted / Programmatic Access
Both transports accept plain text commands. You can use `nc` or any TCP client:
```bash
# DebugService
echo -e "DISCOVER\nTRACE App.Data.DDB.Counter 1" | nc localhost 8080
# WebDebugService
curl -s -X POST http://localhost:8090/api/command \
-H "Content-Type: text/plain" \
-d "DISCOVER"
```
For the full command reference see [API.md](API.md).
+99 -12
View File
@@ -8,7 +8,7 @@
Counter = { Counter = {
DataSource = Timer DataSource = Timer
Type = uint32 Type = uint32
Frequency = 1 Frequency = 1000
} }
Time = { Time = {
DataSource = Timer DataSource = Timer
@@ -17,22 +17,100 @@
} }
OutputSignals = { OutputSignals = {
Counter = { Counter = {
DataSource = DDB DataSource = SyncDB
Type = uint32 Type = uint32
} }
Time = { Time = {
DataSource = Logger DataSource = DDB
Type = uint32 Type = uint32
} }
} }
} }
+CGAM = {
Class = ConstantGAM
OutputSignals = {
Test = {
DataSource = DDB2
Type = float32
Default = 0.123
}
}
}
+GAM2 = {
Class = IOGAM
InputSignals = {
Counter = {
DataSource = TimerSlow
Frequency = 1
}
Time = {
DataSource = TimerSlow
}
Test = {
DataSource = DDB2
Type = float32
}
}
OutputSignals = {
Counter = {
Type = uint32
DataSource = Logger
}
Time = {
Type = uint32
DataSource = Logger
}
ConstOut = {
DataSource = Logger
Type = float32
}
}
}
+GAM3 = {
Class = IOGAM
InputSignals = {
Counter = {
Frequency = 1
Samples = 100
Type = uint32
DataSource = SyncDB
}
}
OutputSignals = {
Counter = {
DataSource = DDB3
NumberOfElements = 100
Type = uint32
}
}
}
} }
+Data = { +Data = {
Class = ReferenceContainer Class = ReferenceContainer
DefaultDataSource = DDB DefaultDataSource = DDB
+SyncDB = {
Class = RealTimeThreadSynchronisation
Timeout = 200
Signals = {
Counter = {
Type = uint32
}
}
}
+Timer = { +Timer = {
Class = LinuxTimer Class = LinuxTimer
SleepTime = 1000000 Signals = {
Counter = {
Type = uint32
}
Time = {
Type = uint32
}
}
}
+TimerSlow = {
Class = LinuxTimer
Signals = { Signals = {
Counter = { Counter = {
Type = uint32 Type = uint32
@@ -62,6 +140,14 @@
} }
} }
} }
+DDB2 = {
AllowNoProducer = 1
Class = GAMDataSource
}
+DDB3 = {
AllowNoProducer = 1
Class = GAMDataSource
}
+DAMS = { +DAMS = {
Class = TimingDataSource Class = TimingDataSource
} }
@@ -76,6 +162,14 @@
Class = RealTimeThread Class = RealTimeThread
Functions = {GAM1} Functions = {GAM1}
} }
+Thread2 = {
Class = RealTimeThread
Functions = {GAM2 CGAM}
}
+Thread3 = {
Class = RealTimeThread
Functions = {GAM3}
}
} }
} }
} }
@@ -89,14 +183,7 @@
Class = DebugService Class = DebugService
ControlPort = 8080 ControlPort = 8080
UdpPort = 8081 UdpPort = 8081
LogPort = 8082
StreamIP = "127.0.0.1" StreamIP = "127.0.0.1"
} }
+LoggerService = {
Class = LoggerService
CPUs = 0x1
+DebugConsumer = {
Class = TcpLogger
Port = 8082
}
}
+186
View File
@@ -0,0 +1,186 @@
+App = {
Class = RealTimeApplication
+Functions = {
Class = ReferenceContainer
+GAM1 = {
Class = IOGAM
InputSignals = {
Counter = {
DataSource = Timer
Type = uint32
Frequency = 1000
}
Time = {
DataSource = Timer
Type = uint32
}
}
OutputSignals = {
Counter = {
DataSource = SyncDB
Type = uint32
}
Time = {
DataSource = DDB
Type = uint32
}
}
}
+CGAM = {
Class = ConstantGAM
OutputSignals = {
Test = {
DataSource = DDB2
Type = float32
Default = 0.123
}
}
}
+GAM2 = {
Class = IOGAM
InputSignals = {
Counter = {
DataSource = TimerSlow
Frequency = 1
}
Time = {
DataSource = TimerSlow
}
Test = {
DataSource = DDB2
Type = float32
}
}
OutputSignals = {
Counter = {
Type = uint32
DataSource = Logger
}
Time = {
Type = uint32
DataSource = Logger
}
ConstOut = {
DataSource = Logger
Type = float32
}
}
}
+GAM3 = {
Class = IOGAM
InputSignals = {
Counter = {
Frequency = 1
Samples = 100
Type = uint32
DataSource = SyncDB
}
}
OutputSignals = {
Counter = {
DataSource = DDB3
NumberOfElements = 100
Type = uint32
}
}
}
}
+Data = {
Class = ReferenceContainer
DefaultDataSource = DDB
+SyncDB = {
Class = RealTimeThreadSynchronisation
Timeout = 200
Signals = {
Counter = {
Type = uint32
}
}
}
+Timer = {
Class = LinuxTimer
Signals = {
Counter = {
Type = uint32
}
Time = {
Type = uint32
}
}
}
+TimerSlow = {
Class = LinuxTimer
Signals = {
Counter = {
Type = uint32
}
Time = {
Type = uint32
}
}
}
+Logger = {
Class = LoggerDataSource
Signals = {
CounterCopy = {
Type = uint32
}
TimeCopy = {
Type = uint32
}
}
}
+DDB = {
AllowNoProducer = 1
Class = GAMDataSource
Signals = {
Counter= {
Type = uint32
}
}
}
+DDB2 = {
AllowNoProducer = 1
Class = GAMDataSource
}
+DDB3 = {
AllowNoProducer = 1
Class = GAMDataSource
}
+DAMS = {
Class = TimingDataSource
}
}
+States = {
Class = ReferenceContainer
+State1 = {
Class = RealTimeState
+Threads = {
Class = ReferenceContainer
+Thread1 = {
Class = RealTimeThread
Functions = {GAM1}
}
+Thread2 = {
Class = RealTimeThread
Functions = {GAM2 CGAM}
}
+Thread3 = {
Class = RealTimeThread
Functions = {GAM3}
}
}
}
}
+Scheduler = {
Class = GAMScheduler
TimingDataSource = DAMS
}
}
+DebugService = {
Class = WebDebugService
HttpPort = 8090
}
-11
View File
@@ -1,11 +0,0 @@
add_executable(IntegrationTest main.cpp)
target_link_libraries(IntegrationTest marte_dev ${MARTe2_LIB})
add_executable(TraceTest TraceTest.cpp)
target_link_libraries(TraceTest marte_dev ${MARTe2_LIB})
add_executable(ValidationTest ValidationTest.cpp)
target_link_libraries(ValidationTest marte_dev ${MARTe2_LIB} ${IOGAM_LIB} ${LinuxTimer_LIB})
add_executable(SchedulerTest SchedulerTest.cpp)
target_link_libraries(SchedulerTest marte_dev ${MARTe2_LIB} ${IOGAM_LIB} ${LinuxTimer_LIB})
+161
View File
@@ -0,0 +1,161 @@
#include "BasicTCPSocket.h"
#include "DebugService.h"
#include "ObjectRegistryDatabase.h"
#include "StandardParser.h"
#include "StreamString.h"
#include "GlobalObjectsDatabase.h"
#include "RealTimeApplication.h"
#include <assert.h>
#include <stdio.h>
using namespace MARTe;
const char8 * const config_command_text =
"DebugService = {"
" Class = DebugService "
" ControlPort = 8100 "
" UdpPort = 8101 "
" StreamIP = \"127.0.0.1\" "
" MyCustomField = \"HelloConfig\" "
"}"
"App = {"
" Class = RealTimeApplication "
" +Functions = {"
" Class = ReferenceContainer "
" +GAM1 = {"
" Class = IOGAM "
" CustomGAMField = \"GAMValue\" "
" InputSignals = {"
" Counter = { DataSource = Timer Type = uint32 Frequency = 1000 PVName = \"PROC:VAR:1\" }"
" Time = { DataSource = Timer Type = uint32 }"
" }"
" OutputSignals = {"
" Counter = { DataSource = DDB Type = uint32 }"
" Time = { DataSource = DDB Type = uint32 }"
" }"
" }"
" }"
" +Data = {"
" Class = ReferenceContainer "
" +Timer = { Class = LinuxTimer SleepTime = 1000 Signals = { Counter = { Type = uint32 } Time = { Type = uint32 } } }"
" +DDB = { Class = GAMDataSource Signals = { Counter = { Type = uint32 } Time = { Type = uint32 } } }"
" +DAMS = { Class = TimingDataSource }"
" }"
" +States = {"
" Class = ReferenceContainer "
" +State1 = { Class = RealTimeState +Threads = { Class = ReferenceContainer +Thread1 = { Class = RealTimeThread Functions = {GAM1} } } }"
" }"
" +Scheduler = { Class = GAMScheduler TimingDataSource = DAMS }"
"}";
static bool SendCommandAndGetReply(uint16 port, const char8* cmd, StreamString &reply) {
BasicTCPSocket client;
if (!client.Open()) return false;
if (!client.Connect("127.0.0.1", port)) return false;
uint32 s = StringHelper::Length(cmd);
if (!client.Write(cmd, s)) return false;
char buffer[4096];
uint32 size = 4096;
TimeoutType timeout(2000000); // 2s
if (client.Read(buffer, size, timeout)) {
reply.Write(buffer, size);
client.Close();
return true;
}
client.Close();
return false;
}
void TestConfigCommands() {
printf("--- MARTe2 Config & Metadata Enrichment Test ---\n");
ObjectRegistryDatabase::Instance()->Purge();
ConfigurationDatabase cdb;
StreamString ss = config_command_text;
ss.Seek(0);
StandardParser parser(ss, cdb);
assert(parser.Parse());
cdb.MoveToRoot();
uint32 n = cdb.GetNumberOfChildren();
for (uint32 i=0; i<n; i++) {
const char8* name = cdb.GetChildName(i);
ConfigurationDatabase child;
cdb.MoveRelative(name);
cdb.Copy(child);
cdb.MoveToAncestor(1u);
StreamString className;
child.Read("Class", className);
Reference ref(className.Buffer(), GlobalObjectsDatabase::Instance()->GetStandardHeap());
ref->SetName(name);
assert(ref->Initialise(child));
ObjectRegistryDatabase::Instance()->Insert(ref);
}
printf("Application and DebugService (port 8100) initialised.\n");
// Start the application to trigger broker execution and signal registration
ReferenceT<RealTimeApplication> app = ObjectRegistryDatabase::Instance()->Find("App");
assert(app.IsValid());
assert(app->ConfigureApplication());
assert(app->PrepareNextState("State1") == ErrorManagement::NoError);
assert(app->StartNextStateExecution() == ErrorManagement::NoError);
printf("Application started (for signal registration).\n");
Sleep::MSec(500); // Wait for some cycles
ReferenceT<DebugService> service = ObjectRegistryDatabase::Instance()->Find("DebugService");
if (service.IsValid()) {
service->SetFullConfig(cdb);
}
Sleep::MSec(1000);
// 1. Test CONFIG command
{
printf("Testing CONFIG command...\n");
StreamString reply;
assert(SendCommandAndGetReply(8100, "CONFIG\n", reply));
printf("\n%s\n", reply.Buffer());
// Verify it contains some key parts of the config
assert(StringHelper::SearchString(reply.Buffer(), "MyCustomField") != NULL_PTR(const char8*));
assert(StringHelper::SearchString(reply.Buffer(), "HelloConfig") != NULL_PTR(const char8*));
assert(StringHelper::SearchString(reply.Buffer(), "PROC:VAR:1") != NULL_PTR(const char8*));
assert(StringHelper::SearchString(reply.Buffer(), "OK CONFIG") != NULL_PTR(const char8*));
printf("SUCCESS: CONFIG command validated.\n");
}
// 2. Test INFO on object with enrichment
{
printf("Testing INFO on App.Functions.GAM1...\n");
StreamString reply;
assert(SendCommandAndGetReply(8100, "INFO App.Functions.GAM1\n", reply));
// Check standard MARTe fields (Name, Class)
assert(StringHelper::SearchString(reply.Buffer(), "\"Name\": \"GAM1\"") != NULL_PTR(const char8*));
// Check enriched fields from fullConfig
assert(StringHelper::SearchString(reply.Buffer(), "\"CustomGAMField\": \"GAMValue\"") != NULL_PTR(const char8*));
assert(StringHelper::SearchString(reply.Buffer(), "OK INFO") != NULL_PTR(const char8*));
printf("SUCCESS: Object metadata enrichment validated.\n");
}
// 3. Test INFO on signal with enrichment
{
printf("Testing INFO on App.Functions.GAM1.In.Counter...\n");
StreamString reply;
assert(SendCommandAndGetReply(8100, "INFO App.Functions.GAM1.In.Counter\n", reply));
// Check enriched fields from signal configuration
assert(StringHelper::SearchString(reply.Buffer(), "\"Frequency\": \"1000\"") != NULL_PTR(const char8*));
assert(StringHelper::SearchString(reply.Buffer(), "\"PVName\": \"PROC:VAR:1\"") != NULL_PTR(const char8*));
assert(StringHelper::SearchString(reply.Buffer(), "OK INFO") != NULL_PTR(const char8*));
printf("SUCCESS: Signal metadata enrichment validated.\n");
}
if (app.IsValid()) {
app->StopCurrentStateExecution();
}
ObjectRegistryDatabase::Instance()->Purge();
}
+252
View File
@@ -0,0 +1,252 @@
#include "ClassRegistryDatabase.h"
#include "ConfigurationDatabase.h"
#include "DebugService.h"
#include "ObjectRegistryDatabase.h"
#include "ErrorManagement.h"
#include "BasicTCPSocket.h"
#include "BasicUDPSocket.h"
#include "RealTimeApplication.h"
#include "StandardParser.h"
#include "TestCommon.h"
#include <stdio.h>
using namespace MARTe;
#include <signal.h>
#include <unistd.h>
void timeout_handler(int sig) {
printf("Test timed out!\n");
_exit(1);
}
void ErrorProcessFunction(const MARTe::ErrorManagement::ErrorInformation &errorInfo, const char8 * const errorDescription) {
printf("[MARTe Error] %s: %s\n", errorInfo.className, errorDescription);
}
// Forward declarations of other tests
void TestSchedulerControl();
void TestFullTracePipeline();
void RunValidationTest();
void TestConfigCommands();
void TestGAMSignalTracing();
void TestTreeCommand();
int main() {
signal(SIGALRM, timeout_handler);
alarm(180);
MARTe::ErrorManagement::SetErrorProcessFunction(&ErrorProcessFunction);
printf("MARTe2 Debug Suite Integration Tests\n");
printf("\n--- Test 1: Registry Patching ---\n");
{
ObjectRegistryDatabase::Instance()->Purge();
DebugService service;
ConfigurationDatabase serviceData;
serviceData.Write("ControlPort", (uint32)9090);
service.Initialise(serviceData);
printf("DebugService initialized and Registry Patched.\n");
ClassRegistryItem *item =
ClassRegistryDatabase::Instance()->Find("MemoryMapInputBroker");
if (item != NULL_PTR(ClassRegistryItem *)) {
Object *obj = item->GetObjectBuilder()->Build(
GlobalObjectsDatabase::Instance()->GetStandardHeap());
if (obj != NULL_PTR(Object *)) {
printf("Instantiated Broker Class: %s\n",
obj->GetClassProperties()->GetName());
printf("Success: Broker patched and instantiated.\n");
} else {
printf("Failed to build broker\n");
}
} else {
printf("MemoryMapInputBroker not found in registry\n");
}
}
Sleep::MSec(1000);
printf("\n--- Test 2: Full Trace Pipeline ---\n");
TestFullTracePipeline();
Sleep::MSec(1000);
printf("\n--- Test 3: Scheduler Control ---\n");
TestSchedulerControl();
Sleep::MSec(1000);
printf("\n--- Test 4: 1kHz Lossless Trace Validation ---\n");
RunValidationTest();
Sleep::MSec(1000);
printf("\n--- Test 5: Config & Metadata Enrichment ---\n");
TestConfigCommands();
Sleep::MSec(1000);
printf("\n--- Test 6: TREE Command Enhancement ---\n");
TestTreeCommand();
Sleep::MSec(1000);
printf("\n--- Test 7: Custom MARTe Message (MSG) ---\n");
TestMessageCommand();
Sleep::MSec(1000);
printf("\nAll Integration Tests Finished.\n");
return 0;
}
// --- Test Implementation ---
void TestGAMSignalTracing() {
printf("--- Test: GAM Signal Tracing Issue ---\n");
ObjectRegistryDatabase::Instance()->Purge();
ConfigurationDatabase cdb;
StreamString ss = debug_test_config;
ss.Seek(0);
StandardParser parser(ss, cdb);
if (!parser.Parse()) {
printf("ERROR: Failed to parse config\n");
return;
}
cdb.MoveToRoot();
uint32 n = cdb.GetNumberOfChildren();
for (uint32 i=0; i<n; i++) {
const char8* name = cdb.GetChildName(i);
ConfigurationDatabase child;
cdb.MoveRelative(name);
cdb.Copy(child);
cdb.MoveToAncestor(1u);
StreamString className;
child.Read("Class", className);
Reference ref(className.Buffer(), GlobalObjectsDatabase::Instance()->GetStandardHeap());
if (!ref.IsValid()) {
printf("ERROR: Could not create object %s of class %s\n", name, className.Buffer());
continue;
}
ref->SetName(name);
if (!ref->Initialise(child)) {
printf("ERROR: Failed to initialise object %s\n", name);
continue;
}
ObjectRegistryDatabase::Instance()->Insert(ref);
}
ReferenceT<DebugService> service = ObjectRegistryDatabase::Instance()->Find("DebugService");
if (!service.IsValid()) {
printf("ERROR: DebugService not found\n");
return;
}
service->SetFullConfig(cdb);
ReferenceT<RealTimeApplication> app = ObjectRegistryDatabase::Instance()->Find("App");
if (!app.IsValid()) {
printf("ERROR: App not found\n");
return;
}
if (!app->ConfigureApplication()) {
printf("ERROR: ConfigureApplication failed.\n");
return;
}
if (app->PrepareNextState("State1") != ErrorManagement::NoError) {
printf("ERROR: PrepareNextState failed.\n");
return;
}
if (app->StartNextStateExecution() != ErrorManagement::NoError) {
printf("ERROR: StartNextStateExecution failed.\n");
return;
}
printf("Application started.\n");
Sleep::MSec(1000);
// Step 1: Discover signals
{
StreamString reply;
if (SendCommandGAM(8095, "DISCOVER\n", reply)) {
printf("DISCOVER response received (len=%llu)\n", reply.Size());
} else {
printf("ERROR: DISCOVER failed\n");
}
}
Sleep::MSec(500);
// Step 2: Trace a DataSource signal (Timer.Counter)
printf("\n--- Step 1: Trace DataSource signal (Timer.Counter) ---\n");
{
StreamString reply;
if (SendCommandGAM(8095, "TRACE App.Data.Timer.Counter 1\n", reply)) {
printf("TRACE response: %s", reply.Buffer());
} else {
printf("ERROR: TRACE failed\n");
}
}
Sleep::MSec(500);
// Step 3: Trace a GAM input signal (GAM1.In.Counter)
printf("\n--- Step 2: Trace GAM input signal (GAM1.In.Counter) ---\n");
{
StreamString reply;
if (SendCommandGAM(8095, "TRACE App.Functions.GAM1.In.Counter 1\n", reply)) {
printf("TRACE response: %s", reply.Buffer());
} else {
printf("ERROR: TRACE failed\n");
}
}
Sleep::MSec(500);
// Step 4: Try to trace another DataSource signal (TimerSlow.Counter)
printf("\n--- Step 3: Try to trace another signal (TimerSlow.Counter) ---\n");
{
StreamString reply;
if (SendCommandGAM(8095, "TRACE App.Data.TimerSlow.Counter 1\n", reply)) {
printf("TRACE response: %s", reply.Buffer());
} else {
printf("ERROR: TRACE failed\n");
}
}
Sleep::MSec(500);
// Step 5: Check if we can still trace more signals
printf("\n--- Step 4: Try to trace Logger.Counter ---\n");
{
StreamString reply;
if (SendCommandGAM(8095, "TRACE App.Data.Logger.Counter 1\n", reply)) {
printf("TRACE response: %s", reply.Buffer());
} else {
printf("ERROR: TRACE failed\n");
}
}
Sleep::MSec(500);
// Verify UDP is still receiving data
BasicUDPSocket listener;
listener.Open();
listener.Listen(8096);
char buffer[1024];
uint32 size = 1024;
TimeoutType timeout(1000);
int packetCount = 0;
while (listener.Read(buffer, size, timeout)) {
packetCount++;
size = 1024;
}
printf("\n--- Results ---\n");
if (packetCount > 0) {
printf("SUCCESS: Received %d UDP packets.\n", packetCount);
} else {
printf("FAILURE: No UDP packets received. Possible deadlock or crash.\n");
}
app->StopCurrentStateExecution();
}
+1
View File
@@ -0,0 +1 @@
include Makefile.inc
+44
View File
@@ -0,0 +1,44 @@
OBJSX = SchedulerTest.x TraceTest.x ValidationTest.x ConfigCommandTest.x TreeCommandTest.x MessageCommandTest.x TestCommon.x
PACKAGE = Test/Integration
ROOT_DIR = ../..
MAKEDEFAULTDIR=$(MARTe2_DIR)/MakeDefaults
include $(MAKEDEFAULTDIR)/MakeStdLibDefs.$(TARGET)
INCLUDES += -I$(ROOT_DIR)/Source/Core/Types/Result
INCLUDES += -I$(ROOT_DIR)/Source/Core/Types/Vec
INCLUDES += -I$(ROOT_DIR)/Source/Components/Interfaces/DebugService
INCLUDES += -I$(ROOT_DIR)/Source/Components/Interfaces/TCPLogger
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L0Types
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L2Objects
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L3Streams
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Messages
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Logger
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Configuration
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L5GAMs
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L6App
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L3Services
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L4Messages
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L4LoggerService
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L5GAMs
INCLUDES += -I$(MARTe2_DIR)/Source/Core/FileSystem/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/FileSystem/L3Streams
INCLUDES += -I$(MARTe2_Components_DIR)/Source/Components/GAMs/IOGAM
INCLUDES += -I$(MARTe2_Components_DIR)/Source/Components/DataSources/LinuxTimer
LIBRARIES += -L$(MARTe2_DIR)/Build/$(TARGET)/Core -lMARTe2
LIBRARIES += -L$(MARTe2_Components_DIR)/Build/$(TARGET)/Components/DataSources/LinuxTimer -lLinuxTimer
LIBRARIES += -L$(MARTe2_Components_DIR)/Build/$(TARGET)/Components/GAMs/IOGAM -lIOGAM
LIBRARIES += -L$(ROOT_DIR)/Build/$(TARGET)/Components/Interfaces/DebugService -lDebugService
LIBRARIES += -L$(ROOT_DIR)/Build/$(TARGET)/Components/Interfaces/TCPLogger -lTcpLogger
all: $(OBJS) $(BUILD_DIR)/IntegrationTests$(EXEEXT)
echo $(OBJS)
include $(MAKEDEFAULTDIR)/MakeStdLibRules.$(TARGET)
+72
View File
@@ -0,0 +1,72 @@
#include "TestCommon.h"
#include "ObjectRegistryDatabase.h"
#include "DebugService.h"
#include "StandardParser.h"
#include "GlobalObjectsDatabase.h"
#include <stdio.h>
using namespace MARTe;
namespace MARTe {
void TestMessageCommand() {
printf("--- Test: Custom MARTe Message (MSG) ---\n");
ObjectRegistryDatabase::Instance()->Purge();
Sleep::MSec(1000);
ConfigurationDatabase cdb;
const char8 * const msg_test_config =
"DebugService = {"
" Class = DebugService "
" ControlPort = 8120 "
" UdpPort = 8121 "
" StreamIP = \"127.0.0.1\" "
"}";
StreamString ss = msg_test_config;
ss.Seek(0);
StandardParser parser(ss, cdb);
if (!parser.Parse()) {
printf("ERROR: Failed to parse config\n");
return;
}
// Initialize Service
ReferenceT<DebugService> service("DebugService", GlobalObjectsDatabase::Instance()->GetStandardHeap());
service->SetName("DebugService");
cdb.MoveToRoot();
if (cdb.MoveRelative("DebugService")) {
if (!service->Initialise(cdb)) {
printf("ERROR: Failed to initialize DebugService\n");
return;
}
}
ObjectRegistryDatabase::Instance()->Insert(service);
if (ObjectRegistryDatabase::Instance()->Find("DebugService").IsValid()) {
printf("DebugService successfully registered in ORD.\n");
} else {
printf("ERROR: DebugService NOT found in ORD.\n");
}
printf("Service initialized on port 8120.\n");
Sleep::MSec(500);
StreamString reply;
if (SendCommandGAM(8120, "MSG DebugService UnknownFunc 0 Key1=Val1\\nKey2=Val2\n", reply)) {
printf("MSG response received: %s", reply.Buffer());
if (StringHelper::SearchString(reply.Buffer(), "OK MSG") != NULL_PTR(const char8 *)) {
printf("SUCCESS: Asynchronous message dispatched correctly.\n");
} else {
printf("FAILURE: MSG command returned error.\n");
}
} else {
printf("ERROR: MSG command communication failed\n");
}
ObjectRegistryDatabase::Instance()->Purge();
}
} // namespace MARTe
+197 -146
View File
@@ -1,202 +1,253 @@
#include "BasicTCPSocket.h"
#include "BasicUDPSocket.h"
#include "DebugService.h" #include "DebugService.h"
#include "DebugCore.h"
#include "ObjectRegistryDatabase.h" #include "ObjectRegistryDatabase.h"
#include "RealTimeApplication.h"
#include "StandardParser.h" #include "StandardParser.h"
#include "StreamString.h" #include "StreamString.h"
#include "BasicUDPSocket.h"
#include "BasicTCPSocket.h"
#include "RealTimeApplication.h"
#include "GlobalObjectsDatabase.h" #include "GlobalObjectsDatabase.h"
#include "MessageI.h"
#include <assert.h> #include <assert.h>
#include <stdio.h> #include <stdio.h>
using namespace MARTe; using namespace MARTe;
const char8 * const config_text = const char8 * const scheduler_config_text =
"+DebugService = {" "DebugService = {"
" Class = DebugService " " Class = DebugService "
" ControlPort = 8080 " " ControlPort = 8098 "
" UdpPort = 8081 " " UdpPort = 8099 "
" StreamIP = \"127.0.0.1\" " " StreamIP = \"127.0.0.1\" "
"}" "}"
"+App = {" "App = {"
" Class = RealTimeApplication " " Class = RealTimeApplication "
" +Functions = {" " +Functions = {"
" Class = ReferenceContainer " " Class = ReferenceContainer "
" +GAM1 = {" " +GAM1 = {"
" Class = IOGAM " " Class = IOGAM "
" InputSignals = {" " InputSignals = {"
" Counter = {" " Counter = { DataSource = Timer Type = uint32 Frequency = 1000 }"
" DataSource = Timer " " Time = { DataSource = Timer Type = uint32 }"
" Type = uint32 "
" }"
" }" " }"
" OutputSignals = {" " OutputSignals = {"
" Counter = {" " Counter = { DataSource = DDB Type = uint32 }"
" DataSource = DDB " " Time = { DataSource = DDB Type = uint32 }"
" Type = uint32 "
" }"
" }" " }"
" }" " }"
" }" " }"
" +Data = {" " +Data = {"
" Class = ReferenceContainer " " Class = ReferenceContainer "
" DefaultDataSource = DDB " " DefaultDataSource = DDB "
" +Timer = {" " +Timer = { Class = LinuxTimer SleepTime = 1000 Signals = { Counter = { Type = uint32 } Time = { Type = uint32 } } }"
" Class = LinuxTimer " " +DDB = { Class = GAMDataSource Signals = { Counter = { Type = uint32 } Time = { Type = uint32 } } }"
" SleepTime = 100000 " // 100ms
" Signals = {"
" Counter = { Type = uint32 }"
" }"
" }"
" +DDB = {"
" Class = GAMDataSource "
" Signals = { Counter = { Type = uint32 } }"
" }"
" +DAMS = { Class = TimingDataSource }" " +DAMS = { Class = TimingDataSource }"
" }" " }"
" +States = {" " +States = {"
" Class = ReferenceContainer " " Class = ReferenceContainer "
" +State1 = {" " +State1 = { Class = RealTimeState +Threads = { Class = ReferenceContainer +Thread1 = { Class = RealTimeThread Functions = {GAM1} } } }"
" Class = RealTimeState "
" +Threads = {"
" Class = ReferenceContainer "
" +Thread1 = {"
" Class = RealTimeThread "
" Functions = {GAM1} "
" }"
" }"
" }"
" }"
" +Scheduler = {"
" Class = FastScheduler "
" TimingDataSource = DAMS "
" }" " }"
" +Scheduler = { Class = GAMScheduler TimingDataSource = DAMS }"
"}"; "}";
void TestSchedulerControl() { void TestSchedulerControl() {
printf("--- MARTe2 Scheduler Control Test ---\n"); printf("--- MARTe2 Scheduler Control Test ---\n");
ConfigurationDatabase cdb; ObjectRegistryDatabase::Instance()->Purge();
StreamString ss = config_text;
ss.Seek(0);
StandardParser parser(ss, cdb);
assert(parser.Parse());
assert(ObjectRegistryDatabase::Instance()->Initialise(cdb));
ReferenceT<DebugService> service = ObjectRegistryDatabase::Instance()->Find("DebugService"); ConfigurationDatabase cdb;
assert(service.IsValid()); StreamString ss = scheduler_config_text;
ss.Seek(0);
ReferenceT<RealTimeApplication> app = ObjectRegistryDatabase::Instance()->Find("App"); StandardParser parser(ss, cdb);
assert(app.IsValid()); if (!parser.Parse()) {
printf("ERROR: Failed to parse configuration\n");
if (app->PrepareNextState("State1") != ErrorManagement::NoError) { return;
printf("ERROR: Failed to prepare State1\n"); }
return;
} cdb.MoveToRoot();
uint32 n = cdb.GetNumberOfChildren();
if (app->StartNextStateExecution() != ErrorManagement::NoError) { for (uint32 i=0; i<n; i++) {
printf("ERROR: Failed to start execution\n"); const char8* name = cdb.GetChildName(i);
return; ConfigurationDatabase child;
} cdb.MoveRelative(name);
cdb.Copy(child);
cdb.MoveToAncestor(1u);
StreamString className;
child.Read("Class", className);
Reference ref(className.Buffer(), GlobalObjectsDatabase::Instance()->GetStandardHeap());
if (!ref.IsValid()) {
printf("ERROR: Could not create object %s of class %s\n", name, className.Buffer());
continue;
}
ref->SetName(name);
if (!ref->Initialise(child)) {
printf("ERROR: Failed to initialise object %s\n", name);
continue;
}
ObjectRegistryDatabase::Instance()->Insert(ref);
}
printf("Application started. Waiting for cycles...\n"); ReferenceT<DebugService> service =
Sleep::MSec(1000); ObjectRegistryDatabase::Instance()->Find("DebugService");
if (!service.IsValid()) {
printf("ERROR: DebugService not found in registry\n");
return;
}
service->SetFullConfig(cdb);
// Enable Trace First ReferenceT<RealTimeApplication> app =
{ ObjectRegistryDatabase::Instance()->Find("App");
if (!app.IsValid()) {
printf("ERROR: App not found in registry\n");
return;
}
if (!app->ConfigureApplication()) {
printf("ERROR: ConfigureApplication failed.\n");
return;
}
if (app->PrepareNextState("State1") != ErrorManagement::NoError) {
printf("ERROR: Failed to prepare State1\n");
return;
}
if (app->StartNextStateExecution() != ErrorManagement::NoError) {
printf("ERROR: Failed to start execution\n");
return;
}
printf("Application started. Waiting for cycles...\n");
Sleep::MSec(2000);
// Enable Trace First - with retry logic
{
bool connected = false;
for (int retry=0; retry<10 && !connected; retry++) {
BasicTCPSocket tClient; BasicTCPSocket tClient;
if (tClient.Connect("127.0.0.1", 8080)) { if (tClient.Open()) {
const char* cmd = "TRACE Root.App.Data.Timer.Counter 1\n"; if (tClient.Connect("127.0.0.1", 8098)) {
uint32 s = StringHelper::Length(cmd); connected = true;
tClient.Write(cmd, s); const char *cmd = "TRACE App.Data.Timer.Counter 1\n";
tClient.Close(); uint32 s = StringHelper::Length(cmd);
tClient.Write(cmd, s);
tClient.Close();
} else {
printf("[SchedulerTest] Connect failed (retry %d)\n", retry);
Sleep::MSec(500);
}
} else { } else {
printf("WARNING: Could not connect to DebugService to enable trace.\n"); printf("[SchedulerTest] Open failed (retry %d)\n", retry);
Sleep::MSec(500);
} }
} }
BasicUDPSocket listener; if (!connected) {
listener.Open(); printf("WARNING: Could not connect to DebugService to enable trace.\n");
listener.Listen(8081);
// Read current value
uint32 valBeforePause = 0;
char buffer[2048];
uint32 size = 2048;
TimeoutType timeout(500);
if (listener.Read(buffer, size, timeout)) {
// [Header][ID][Size][Value]
valBeforePause = *(uint32*)(&buffer[28]);
printf("Value before/at pause: %u\n", valBeforePause);
} else {
printf("WARNING: No data received before pause.\n");
} }
}
// Send PAUSE BasicUDPSocket listener;
printf("Sending PAUSE command...\n"); listener.Open();
BasicTCPSocket client; listener.Listen(8099);
if (client.Connect("127.0.0.1", 8080)) {
const char* cmd = "PAUSE\n"; // Read current value
uint32 s = StringHelper::Length(cmd); uint32 valBeforePause = 0;
client.Write(cmd, s); char buffer[2048];
client.Close(); uint32 size = 2048;
} else { TimeoutType timeout(1000);
if (listener.Read(buffer, size, timeout)) {
// [Header][ID][Size][Value]
valBeforePause = *(uint32 *)(&buffer[sizeof(TraceHeader) + 16]);
printf("Value before/at pause: %u\n", valBeforePause);
} else {
printf("WARNING: No data received before pause.\n");
}
// Send PAUSE
printf("Sending PAUSE command...\n");
{
bool connected = false;
for (int retry=0; retry<10 && !connected; retry++) {
BasicTCPSocket client;
if (client.Open()) {
if (client.Connect("127.0.0.1", 8098)) {
connected = true;
const char *cmd = "PAUSE\n";
uint32 s = StringHelper::Length(cmd);
client.Write(cmd, s);
client.Close();
} else {
Sleep::MSec(200);
}
} else {
Sleep::MSec(200);
}
}
if (!connected) {
printf("ERROR: Could not connect to DebugService to send PAUSE.\n"); printf("ERROR: Could not connect to DebugService to send PAUSE.\n");
} }
}
Sleep::MSec(2000); // Wait 2 seconds Sleep::MSec(2000); // Wait 2 seconds
// Read again - should be same or very close if paused // Read again - should be same or very close if paused
uint32 valAfterWait = 0; uint32 valAfterWait = 0;
size = 2048; // Reset size size = 2048; // Reset size
while(listener.Read(buffer, size, TimeoutType(10))) { while (listener.Read(buffer, size, TimeoutType(100))) {
valAfterWait = *(uint32*)(&buffer[28]); valAfterWait = *(uint32 *)(&buffer[sizeof(TraceHeader) + 16]);
size = 2048; size = 2048;
} }
printf("Value after 2s wait (drained): %u\n", valAfterWait);
// Check if truly paused
if (valAfterWait > valBeforePause + 5) {
printf("FAILURE: Counter increased significantly while paused! (%u -> %u)\n", valBeforePause, valAfterWait);
} else {
printf("SUCCESS: Counter held steady (or close) during pause.\n");
}
// Resume printf("Value after 2s wait (drained): %u\n", valAfterWait);
printf("Sending RESUME command...\n");
{ // Check if truly paused
if (valAfterWait > valBeforePause + 10) {
printf(
"FAILURE: Counter increased significantly while paused! (%u -> %u)\n",
valBeforePause, valAfterWait);
} else {
printf("SUCCESS: Counter held steady (or close) during pause.\n");
}
// Resume
printf("Sending RESUME command...\n");
{
bool connected = false;
for (int retry=0; retry<10 && !connected; retry++) {
BasicTCPSocket rClient; BasicTCPSocket rClient;
if (rClient.Connect("127.0.0.1", 8080)) { if (rClient.Open()) {
const char* cmd = "RESUME\n"; if (rClient.Connect("127.0.0.1", 8098)) {
uint32 s = StringHelper::Length(cmd); connected = true;
rClient.Write(cmd, s); const char *cmd = "RESUME\n";
rClient.Close(); uint32 s = StringHelper::Length(cmd);
rClient.Write(cmd, s);
rClient.Close();
} else {
Sleep::MSec(200);
}
} else {
Sleep::MSec(200);
} }
} }
}
Sleep::MSec(1000);
// Check if increasing
uint32 valAfterResume = 0;
size = 2048;
if (listener.Read(buffer, size, timeout)) {
valAfterResume = *(uint32*)(&buffer[28]);
printf("Value after resume: %u\n", valAfterResume);
}
if (valAfterResume > valAfterWait) {
printf("SUCCESS: Execution resumed.\n");
} else {
printf("FAILURE: Execution did not resume.\n");
}
app->StopCurrentStateExecution(); Sleep::MSec(1000);
}
int main() { // Check if increasing
TestSchedulerControl(); uint32 valAfterResume = 0;
return 0; size = 2048;
if (listener.Read(buffer, size, timeout)) {
valAfterResume = *(uint32 *)(&buffer[sizeof(TraceHeader) + 16]);
printf("Value after resume: %u\n", valAfterResume);
}
if (valAfterResume > valAfterWait) {
printf("SUCCESS: Execution resumed.\n");
} else {
printf("FAILURE: Execution did not resume.\n");
}
app->StopCurrentStateExecution();
} }
+74
View File
@@ -0,0 +1,74 @@
#include "TestCommon.h"
#include "BasicTCPSocket.h"
#include "StringHelper.h"
#include "TimeoutType.h"
namespace MARTe {
const char8 * const debug_test_config =
"DebugService = {"
" Class = DebugService "
" ControlPort = 8095 "
" UdpPort = 8096 "
" StreamIP = \"127.0.0.1\" "
"}"
"App = {"
" Class = RealTimeApplication "
" +Functions = {"
" Class = ReferenceContainer "
" +GAM1 = {"
" Class = IOGAM "
" InputSignals = {"
" Counter = { DataSource = Timer Type = uint32 Frequency = 1000 }"
" }"
" OutputSignals = {"
" Counter = { DataSource = DDB Type = uint32 }"
" }"
" }"
" +GAM2 = {"
" Class = IOGAM "
" InputSignals = {"
" Counter = { DataSource = TimerSlow Type = uint32 Frequency = 10 }"
" }"
" OutputSignals = {"
" Counter = { DataSource = Logger Type = uint32 }"
" }"
" }"
" }"
" +Data = {"
" Class = ReferenceContainer "
" DefaultDataSource = DDB "
" +Timer = { Class = LinuxTimer SleepTime = 1000 Signals = { Counter = { Type = uint32 } } }"
" +TimerSlow = { Class = LinuxTimer SleepTime = 100000 Signals = { Counter = { Type = uint32 } } }"
" +Logger = { Class = LoggerDataSource Signals = { Counter = { Type = uint32 } } }"
" +DDB = { Class = GAMDataSource Signals = { Counter = { Type = uint32 } } }"
" +DAMS = { Class = TimingDataSource }"
" }"
" +States = {"
" Class = ReferenceContainer "
" +State1 = { Class = RealTimeState +Threads = { Class = ReferenceContainer +Thread1 = { Class = RealTimeThread Functions = {GAM1 GAM2} } } }"
" }"
" +Scheduler = { Class = GAMScheduler TimingDataSource = DAMS }"
"}";
bool SendCommandGAM(uint16 port, const char8* cmd, StreamString &reply) {
BasicTCPSocket client;
if (!client.Open()) return false;
if (!client.Connect("127.0.0.1", port)) return false;
uint32 s = StringHelper::Length(cmd);
if (!client.Write(cmd, s)) return false;
char buffer[16384];
uint32 size = 16384;
TimeoutType timeout(5000);
if (client.Read(buffer, size, timeout)) {
reply.Write(buffer, size);
client.Close();
return true;
}
client.Close();
return false;
}
}
+13
View File
@@ -0,0 +1,13 @@
#ifndef TESTCOMMON_H
#define TESTCOMMON_H
#include "CompilerTypes.h"
#include "StreamString.h"
namespace MARTe {
extern const char8 * const debug_test_config;
bool SendCommandGAM(uint16 port, const char8* cmd, StreamString &reply);
void TestMessageCommand();
}
#endif
+20 -26
View File
@@ -1,9 +1,10 @@
#include "BasicTCPSocket.h"
#include "BasicUDPSocket.h"
#include "DebugService.h" #include "DebugService.h"
#include "DebugCore.h"
#include "ObjectRegistryDatabase.h" #include "ObjectRegistryDatabase.h"
#include "StandardParser.h" #include "StandardParser.h"
#include "StreamString.h" #include "StreamString.h"
#include "BasicUDPSocket.h" #include "HighResolutionTimer.h"
#include <assert.h> #include <assert.h>
#include <stdio.h> #include <stdio.h>
@@ -11,20 +12,22 @@ using namespace MARTe;
void TestFullTracePipeline() { void TestFullTracePipeline() {
printf("Starting Full Trace Pipeline Test...\n"); printf("Starting Full Trace Pipeline Test...\n");
printf("sizeof(TraceHeader) = %lu\n", sizeof(TraceHeader));
ObjectRegistryDatabase::Instance()->Purge();
// 1. Setup Service // 1. Setup Service
DebugService service; DebugService service;
ConfigurationDatabase config; ConfigurationDatabase config;
config.Write("ControlPort", (uint16)8080); config.Write("ControlPort", (uint16)8082);
config.Write("StreamPort", (uint16)8081); config.Write("StreamPort", (uint16)8083);
config.Write("LogPort", (uint16)8082); config.Write("LogPort", (uint16)8084);
config.Write("StreamIP", "127.0.0.1"); config.Write("StreamIP", "127.0.0.1");
assert(service.Initialise(config)); assert(service.Initialise(config));
Sleep::MSec(500);
// 2. Register a mock signal // 2. Register a mock signal
uint32 mockValue = 0; uint32 mockValue = 0;
DebugSignalInfo* sig = service.RegisterSignal(&mockValue, UnsignedInteger32Bit, "Test.Signal"); DebugSignalInfo* sig = service.RegisterSignal(&mockValue, UnsignedInteger32Bit, "TraceTest.Signal", 0, 1);
assert(sig != NULL_PTR(DebugSignalInfo*)); assert(sig != NULL_PTR(DebugSignalInfo*));
printf("Signal registered with ID: %u\n", sig->internalID); printf("Signal registered with ID: %u\n", sig->internalID);
@@ -35,13 +38,14 @@ void TestFullTracePipeline() {
// 4. Setup a local UDP listener // 4. Setup a local UDP listener
BasicUDPSocket listener; BasicUDPSocket listener;
assert(listener.Open()); assert(listener.Open());
assert(listener.Listen(8081)); assert(listener.Listen(8083));
// 5. Simulate cycles // 5. Simulate cycles
printf("Simulating cycles...\n"); printf("Simulating cycles...\n");
for (int i=0; i<50; i++) { for (int i=0; i<50; i++) {
mockValue = 1000 + i; mockValue = 1000 + i;
service.ProcessSignal(sig, sizeof(uint32)); uint64 ts = (uint64)((float64)HighResolutionTimer::Counter() * HighResolutionTimer::Period() * 1000000.0);
service.ProcessSignal(sig, sizeof(uint32), ts);
Sleep::MSec(10); Sleep::MSec(10);
} }
@@ -51,24 +55,19 @@ void TestFullTracePipeline() {
TimeoutType timeout(1000); // 1s TimeoutType timeout(1000); // 1s
if (listener.Read(buffer, size, timeout)) { if (listener.Read(buffer, size, timeout)) {
printf("SUCCESS: Received %u bytes over UDP!\n", size); printf("SUCCESS: Received %u bytes over UDP!\n", size);
for(uint32 i=0; i<size; i++) {
printf("%02X ", (uint8)buffer[i]);
if((i+1)%4 == 0) printf("| ");
if((i+1)%16 == 0) printf("\n");
}
printf("\n");
TraceHeader *h = (TraceHeader*)buffer; TraceHeader *h = (TraceHeader*)buffer;
printf("Header: Magic=0x%X, Count=%u, Seq=%u\n", h->magic, h->count, h->seq); printf("Header: Magic=0x%X, Count=%u, Seq=%u\n", h->magic, h->count, h->seq);
uint32 offset = sizeof(TraceHeader); uint32 offset = sizeof(TraceHeader);
if (size >= offset + 8) { if (size >= offset + 16) {
uint32 recId = *(uint32*)(&buffer[offset]); uint32 recId = *(uint32*)(&buffer[offset]);
uint32 recSize = *(uint32*)(&buffer[offset + 4]); uint64 recTs = *(uint64*)(&buffer[offset + 4]);
printf("Data: ID=%u, Size=%u\n", recId, recSize); uint32 recSize = *(uint32*)(&buffer[offset + 12]);
if (size >= offset + 8 + recSize) { printf("Data: ID=%u, TS=%llu, Size=%u\n", recId, (unsigned long long)recTs, recSize);
if (size >= offset + 16 + recSize) {
if (recSize == 4) { if (recSize == 4) {
uint32 recVal = *(uint32*)(&buffer[offset + 8]); uint32 recVal = *(uint32*)(&buffer[offset + 16]);
printf("Value=%u\n", recVal); printf("Value=%u\n", recVal);
} }
} }
@@ -79,8 +78,3 @@ void TestFullTracePipeline() {
listener.Close(); listener.Close();
} }
int main() {
TestFullTracePipeline();
return 0;
}
+178
View File
@@ -0,0 +1,178 @@
#include "BasicTCPSocket.h"
#include "ConfigurationDatabase.h"
#include "DebugService.h"
#include "GlobalObjectsDatabase.h"
#include "ObjectRegistryDatabase.h"
#include "RealTimeApplication.h"
#include "StandardParser.h"
#include "StreamString.h"
#include "TestCommon.h"
#include "IOGAM.h"
#include "LinuxTimer.h"
#include "GAMDataSource.h"
#include "TimingDataSource.h"
#include "GAMScheduler.h"
#include <stdio.h>
using namespace MARTe;
void TestTreeCommand() {
printf("--- Test: TREE Command Enhancement ---\n");
ObjectRegistryDatabase::Instance()->Purge();
Sleep::MSec(2000); // Wait for sockets from previous tests to clear
ConfigurationDatabase cdb;
// Use unique ports to avoid conflict with other tests
const char8 * const tree_test_config =
"DebugService = {"
" Class = DebugService "
" ControlPort = 8110 "
" UdpPort = 8111 "
" StreamIP = \"127.0.0.1\" "
"}"
"App = {"
" Class = RealTimeApplication "
" +Functions = {"
" Class = ReferenceContainer "
" +GAM1 = {"
" Class = IOGAM "
" InputSignals = {"
" Counter = { DataSource = Timer Type = uint32 Frequency = 1000 }"
" Time = { DataSource = Timer Type = uint32 }"
" }"
" OutputSignals = {"
" Counter = { DataSource = DDB Type = uint32 }"
" Time = { DataSource = DDB Type = uint32 }"
" }"
" }"
" }"
" +Data = {"
" Class = ReferenceContainer "
" DefaultDataSource = DDB "
" +Timer = { Class = LinuxTimer SleepTime = 1000 Signals = { Counter = { Type = uint32 } Time = { Type = uint32 } } }"
" +DDB = { Class = GAMDataSource Signals = { Counter = { Type = uint32 } Time = { Type = uint32 } } }"
" +DAMS = { Class = TimingDataSource }"
" }"
" +States = {"
" Class = ReferenceContainer "
" +State1 = { Class = RealTimeState +Threads = { Class = ReferenceContainer +Thread1 = { Class = RealTimeThread Functions = {GAM1} } } }"
" }"
" +Scheduler = { Class = GAMScheduler TimingDataSource = DAMS }"
"}";
StreamString ss = tree_test_config;
ss.Seek(0);
StandardParser parser(ss, cdb);
if (!parser.Parse()) {
printf("ERROR: Failed to parse config\n");
return;
}
cdb.MoveToRoot();
uint32 n = cdb.GetNumberOfChildren();
for (uint32 i = 0; i < n; i++) {
const char8 *name = cdb.GetChildName(i);
ConfigurationDatabase child;
cdb.MoveRelative(name);
cdb.Copy(child);
cdb.MoveToAncestor(1u);
StreamString className;
child.Read("Class", className);
Reference ref(className.Buffer(),
GlobalObjectsDatabase::Instance()->GetStandardHeap());
if (!ref.IsValid()) {
printf("ERROR: Could not create object %s of class %s\n", name,
className.Buffer());
continue;
}
ref->SetName(name);
if (!ref->Initialise(child)) {
printf("ERROR: Failed to initialise object %s\n", name);
continue;
}
ObjectRegistryDatabase::Instance()->Insert(ref);
}
ReferenceT<DebugService> service =
ObjectRegistryDatabase::Instance()->Find("DebugService");
if (!service.IsValid()) {
printf("ERROR: DebugService not found\n");
return;
}
service->SetFullConfig(cdb);
ReferenceT<RealTimeApplication> app =
ObjectRegistryDatabase::Instance()->Find("App");
if (!app.IsValid()) {
printf("ERROR: App not found\n");
return;
}
if (!app->ConfigureApplication()) {
printf("ERROR: ConfigureApplication failed.\n");
return;
}
if (app->PrepareNextState("State1") != ErrorManagement::NoError) {
printf("ERROR: PrepareNextState failed.\n");
return;
}
if (app->StartNextStateExecution() != ErrorManagement::NoError) {
printf("ERROR: StartNextStateExecution failed.\n");
return;
}
printf("Application started.\n");
Sleep::MSec(1000);
// Step 1: Request TREE
StreamString reply;
if (SendCommandGAM(8110, "TREE\n", reply)) {
printf("TREE response received (len=%llu)\n", reply.Size());
// ...
}
// Step 2: SERVICE_INFO
printf("\n--- Step 2: SERVICE_INFO ---\n");
reply = "";
if (SendCommandGAM(8110, "SERVICE_INFO\n", reply)) {
printf("SERVICE_INFO response: %s", reply.Buffer());
if (StringHelper::SearchString(reply.Buffer(), "TCP_CTRL:8110") != NULL_PTR(const char8 *) &&
StringHelper::SearchString(reply.Buffer(), "UDP_STREAM:8111") != NULL_PTR(const char8 *)) {
printf("SUCCESS: SERVICE_INFO returned correct ports.\n");
} else {
printf("FAILURE: SERVICE_INFO returned incorrect data.\n");
}
}
// Step 3: MONITOR
printf("\n--- Step 3: MONITOR SIGNAL ---\n");
reply = "";
if (SendCommandGAM(8110, "MONITOR SIGNAL App.Data.Timer.Counter 10\n", reply)) {
printf("MONITOR response: %s", reply.Buffer());
if (StringHelper::SearchString(reply.Buffer(), "OK MONITOR 1") != NULL_PTR(const char8 *)) {
printf("SUCCESS: Signal monitored.\n");
} else {
printf("FAILURE: Could not monitor signal.\n");
}
}
// Step 4: UNMONITOR
printf("\n--- Step 4: UNMONITOR SIGNAL ---\n");
reply = "";
if (SendCommandGAM(8110, "UNMONITOR SIGNAL App.Data.Timer.Counter\n", reply)) {
printf("UNMONITOR response: %s", reply.Buffer());
if (StringHelper::SearchString(reply.Buffer(), "OK UNMONITOR 1") != NULL_PTR(const char8 *)) {
printf("SUCCESS: Signal unmonitored.\n");
} else {
printf("FAILURE: Could not unmonitor signal.\n");
}
}
app->StopCurrentStateExecution();
ObjectRegistryDatabase::Instance()->Purge();
}
+99 -149
View File
@@ -1,211 +1,161 @@
#include "BasicTCPSocket.h"
#include "BasicUDPSocket.h"
#include "DebugService.h" #include "DebugService.h"
#include "DebugCore.h"
#include "ObjectRegistryDatabase.h" #include "ObjectRegistryDatabase.h"
#include "RealTimeApplication.h"
#include "StandardParser.h" #include "StandardParser.h"
#include "StreamString.h" #include "StreamString.h"
#include "BasicUDPSocket.h"
#include "BasicTCPSocket.h"
#include "RealTimeApplication.h"
#include "GlobalObjectsDatabase.h" #include "GlobalObjectsDatabase.h"
#include <assert.h> #include <assert.h>
#include <stdio.h> #include <stdio.h>
using namespace MARTe; using namespace MARTe;
const char8 * const config_text = const char8 * const validation_config =
"+DebugService = {" "DebugService = {"
" Class = DebugService " " Class = DebugService "
" ControlPort = 8080 " " ControlPort = 8085 "
" UdpPort = 8081 " " UdpPort = 8086 "
" StreamIP = \"127.0.0.1\" " " StreamIP = \"127.0.0.1\" "
"}" "}"
"+App = {" "App = {"
" Class = RealTimeApplication " " Class = RealTimeApplication "
" +Functions = {" " +Functions = {"
" Class = ReferenceContainer " " Class = ReferenceContainer "
" +GAM1 = {" " +GAM1 = {"
" Class = IOGAM " " Class = IOGAM "
" InputSignals = {" " InputSignals = {"
" Counter = {" " Counter = { DataSource = Timer Type = uint32 Frequency = 1000 }"
" DataSource = Timer " " Time = { DataSource = Timer Type = uint32 }"
" Type = uint32 "
" Frequency = 100 "
" }"
" }" " }"
" OutputSignals = {" " OutputSignals = {"
" Counter = {" " Counter = { DataSource = DDB Type = uint32 }"
" DataSource = DDB " " Time = { DataSource = DDB Type = uint32 }"
" Type = uint32 "
" }"
" }" " }"
" }" " }"
" }" " }"
" +Data = {" " +Data = {"
" Class = ReferenceContainer " " Class = ReferenceContainer "
" DefaultDataSource = DDB " " DefaultDataSource = DDB "
" +Timer = {" " +Timer = { Class = LinuxTimer SleepTime = 1000 Signals = { Counter = { Type = uint32 } Time = { Type = uint32 } } }"
" Class = LinuxTimer " " +DDB = { Class = GAMDataSource Signals = { Counter = { Type = uint32 } Time = { Type = uint32 } } }"
" SleepTime = 10000 "
" Signals = {"
" Counter = { Type = uint32 }"
" Time = { Type = uint32 }"
" }"
" }"
" +DDB = {"
" Class = GAMDataSource "
" Signals = { Counter = { Type = uint32 } }"
" }"
" +DAMS = { Class = TimingDataSource }" " +DAMS = { Class = TimingDataSource }"
" }" " }"
" +States = {" " +States = {"
" Class = ReferenceContainer " " Class = ReferenceContainer "
" +State1 = {" " +State1 = { Class = RealTimeState +Threads = { Class = ReferenceContainer +Thread1 = { Class = RealTimeThread Functions = {GAM1} } } }"
" Class = RealTimeState "
" +Threads = {"
" Class = ReferenceContainer "
" +Thread1 = {"
" Class = RealTimeThread "
" Functions = {GAM1} "
" }"
" }"
" }"
" }"
" +Scheduler = {"
" Class = GAMScheduler "
" TimingDataSource = DAMS "
" }" " }"
" +Scheduler = { Class = GAMScheduler TimingDataSource = DAMS }"
"}"; "}";
void RunValidationTest() { void RunValidationTest() {
printf("--- MARTe2 100Hz Trace Validation Test ---\n"); printf("--- MARTe2 1kHz Lossless Trace Validation Test ---\n");
ObjectRegistryDatabase::Instance()->Purge(); ObjectRegistryDatabase::Instance()->Purge();
ConfigurationDatabase cdb; ConfigurationDatabase cdb;
StreamString ss = config_text; StreamString ss = validation_config;
ss.Seek(0); ss.Seek(0);
StandardParser parser(ss, cdb); StandardParser parser(ss, cdb);
if (!parser.Parse()) { assert(parser.Parse());
printf("ERROR: Failed to parse configuration\n");
return;
}
if (!ObjectRegistryDatabase::Instance()->Initialise(cdb)) { cdb.MoveToRoot();
printf("ERROR: Failed to initialise ObjectRegistryDatabase.\n"); uint32 n = cdb.GetNumberOfChildren();
for (uint32 i=0; i<n; i++) {
const char8* name = cdb.GetChildName(i);
ConfigurationDatabase child;
cdb.MoveRelative(name);
cdb.Copy(child);
cdb.MoveToAncestor(1u);
StreamString className;
child.Read("Class", className);
Reference ref(className.Buffer(), GlobalObjectsDatabase::Instance()->GetStandardHeap());
ref->SetName(name);
assert(ref->Initialise(child));
ObjectRegistryDatabase::Instance()->Insert(ref);
}
Reference serviceGeneric = ObjectRegistryDatabase::Instance()->Find("DebugService");
Reference appGeneric = ObjectRegistryDatabase::Instance()->Find("App");
if (!serviceGeneric.IsValid() || !appGeneric.IsValid()) {
printf("ERROR: Objects NOT FOUND in ValidationTest\n");
return; return;
} }
ReferenceT<DebugService> service = ObjectRegistryDatabase::Instance()->Find("DebugService"); DebugService *service = dynamic_cast<DebugService*>(serviceGeneric.operator->());
if (!service.IsValid()) { RealTimeApplication *app = dynamic_cast<RealTimeApplication*>(appGeneric.operator->());
printf("ERROR: DebugService not found\n");
return;
}
ReferenceT<RealTimeApplication> app = ObjectRegistryDatabase::Instance()->Find("App"); assert(service);
if (!app.IsValid()) { assert(app);
printf("ERROR: App not found\n");
return;
}
service->SetFullConfig(cdb);
if (!app->ConfigureApplication()) { if (!app->ConfigureApplication()) {
printf("ERROR: Failed to configure application\n"); printf("ERROR: ConfigureApplication failed in ValidationTest.\n");
return;
}
if (app->PrepareNextState("State1") != ErrorManagement::NoError) {
printf("ERROR: Failed to prepare state State1\n");
return; return;
} }
if (app->StartNextStateExecution() != ErrorManagement::NoError) { assert(app->PrepareNextState("State1") == ErrorManagement::NoError);
printf("ERROR: Failed to start execution\n"); assert(app->StartNextStateExecution() == ErrorManagement::NoError);
return;
}
printf("Application and DebugService are active.\n"); printf("Application started at 1kHz. Enabling Traces...\n");
Sleep::MSec(1000); Sleep::MSec(1000);
// DIRECT ACTIVATION: Use the public TraceSignal method if (service->TraceSignal("App.Data.Timer.Counter", true, 1) == 0) {
printf("Activating trace directly...\n"); printf("ERROR: Failed to enable trace for App.Data.Timer.Counter\n");
// We try multiple potential paths to be safe
uint32 traceCount = 0;
traceCount += service->TraceSignal("App.Data.Timer.Counter", true, 1);
traceCount += service->TraceSignal("Timer.Counter", true, 1);
traceCount += service->TraceSignal("Counter", true, 1);
printf("Trace enabled (Matched Aliases: %u)\n", traceCount);
// 4. Setup UDP Listener
BasicUDPSocket listener;
if (!listener.Open()) { printf("ERROR: Failed to open UDP socket\n"); return; }
if (!listener.Listen(8081)) { printf("ERROR: Failed to listen on UDP 8081\n"); return; }
// 5. Validate for 10 seconds
printf("Validating telemetry for 10 seconds...\n");
uint32 lastVal = 0;
bool first = true;
uint32 packetCount = 0;
uint32 discontinuityCount = 0;
float64 startTime = HighResolutionTimer::Counter() * HighResolutionTimer::Period();
float64 globalTimeout = startTime + 30.0;
while ((HighResolutionTimer::Counter() * HighResolutionTimer::Period() - startTime) < 10.0) {
if (HighResolutionTimer::Counter() * HighResolutionTimer::Period() > globalTimeout) {
printf("CRITICAL ERROR: Global test timeout reached.\n");
break;
}
char buffer[2048];
uint32 size = 2048;
TimeoutType timeout(200);
if (listener.Read(buffer, size, timeout)) {
TraceHeader *h = (TraceHeader*)buffer;
if (h->magic == 0xDA7A57AD && h->count > 0) {
uint32 offset = sizeof(TraceHeader);
// Packet format: [Header][ID:4][Size:4][Value:N]
uint32 val = *(uint32*)(&buffer[offset + 8]);
if (!first) {
if (val != lastVal + 1) {
discontinuityCount++;
}
}
lastVal = val;
first = false;
packetCount++;
if (packetCount % 200 == 0) {
printf("Received %u packets... Current Value: %u\n", packetCount, val);
}
}
}
} }
printf("Test Finished.\n"); BasicUDPSocket listener;
printf("Total Packets Received: %u (Expected ~1000)\n", packetCount); listener.Open();
printf("Discontinuities: %u\n", discontinuityCount); listener.Listen(8086);
float64 actualFreq = (float64)packetCount / 10.0;
printf("Average Frequency: %.2f Hz\n", actualFreq);
if (packetCount < 100) { printf("Validating for 10 seconds...\n");
printf("FAILURE: Almost no packets received. Telemetry is broken.\n"); uint32 totalPackets = 0;
} else if (packetCount < 800) { uint32 totalSamples = 0;
printf("WARNING: Too few packets received (Expected 1000, Got %u).\n", packetCount); uint32 discontinuities = 0;
} else if (discontinuityCount > 20) { uint32 lastValue = 0xFFFFFFFF;
printf("FAILURE: Too many discontinuities (%u).\n", discontinuityCount);
uint64 start = HighResolutionTimer::Counter();
float64 elapsed = 0;
while (elapsed < 10.0) {
char buffer[2048];
uint32 size = 2048;
if (listener.Read(buffer, size, TimeoutType(100))) {
totalPackets++;
TraceHeader *h = (TraceHeader*)buffer;
uint32 offset = sizeof(TraceHeader);
for (uint32 i=0; i<h->count; i++) {
uint32 recId = *(uint32*)(&buffer[offset]);
uint32 recSize = *(uint32*)(&buffer[offset + 12]);
if (recSize == 4) {
uint32 val = *(uint32*)(&buffer[offset + 16]);
totalSamples++;
if (lastValue != 0xFFFFFFFF && val != lastValue + 1) {
discontinuities++;
}
lastValue = val;
}
offset += (16 + recSize);
}
}
elapsed = (float64)(HighResolutionTimer::Counter() - start) * HighResolutionTimer::Period();
}
printf("\n--- Test Results ---\n");
printf("Total UDP Packets: %u\n", totalPackets);
printf("Total Counter Samples: %u\n", totalSamples);
printf("Counter Discontinuities: %u\n", discontinuities);
if (totalSamples < 9000) {
printf("FAILURE: Underflow - samples missing (%u).\n", totalSamples);
} else if (discontinuities > 50) {
printf("FAILURE: Excessive discontinuities detected! (%u)\n", discontinuities);
} else { } else {
printf("VALIDATION SUCCESSFUL!\n"); printf("VALIDATION SUCCESSFUL: 1kHz Lossless Tracing Verified.\n");
} }
app->StopCurrentStateExecution(); app->StopCurrentStateExecution();
listener.Close();
ObjectRegistryDatabase::Instance()->Purge();
}
int main() {
RunValidationTest();
return 0;
} }
-50
View File
@@ -1,50 +0,0 @@
#include <stdio.h>
#include "DebugService.h"
#include "MemoryMapInputBroker.h"
#include "ConfigurationDatabase.h"
#include "ObjectRegistryDatabase.h"
#include "ClassRegistryDatabase.h"
using namespace MARTe;
#include <unistd.h>
#include <signal.h>
void timeout_handler(int sig) {
printf("Test timed out!\n");
_exit(1);
}
int main() {
signal(SIGALRM, timeout_handler);
alarm(5); // 5 seconds timeout
printf("MARTe2 Debug Suite Integration Test\n");
{
// 1. Manually trigger Registry Patching
DebugService service;
ConfigurationDatabase serviceData;
serviceData.Write("ControlPort", (uint16)9090);
service.Initialise(serviceData);
printf("DebugService initialized and Registry Patched.\n");
// 2. Try to create a MemoryMapInputBroker
ClassRegistryItem *item = ClassRegistryDatabase::Instance()->Find("MemoryMapInputBroker");
if (item != NULL_PTR(ClassRegistryItem *)) {
Object *obj = item->GetObjectBuilder()->Build(GlobalObjectsDatabase::Instance()->GetStandardHeap());
if (obj != NULL_PTR(Object *)) {
printf("Instantiated Broker Class: %s\n", obj->GetClassProperties()->GetName());
printf("Success: Broker patched and instantiated.\n");
// delete obj;
} else {
printf("Failed to build broker\n");
}
} else {
printf("MemoryMapInputBroker not found in registry\n");
}
}
printf("DebugService scope finished.\n");
return 0;
}
+1
View File
@@ -0,0 +1 @@
include Makefile.inc
+14
View File
@@ -0,0 +1,14 @@
SPB = UnitTests.x Integration.x
PACKAGE = Test
ROOT_DIR = ..
MAKEDEFAULTDIR=$(MARTe2_DIR)/MakeDefaults
include $(MAKEDEFAULTDIR)/MakeStdLibDefs.$(TARGET)
all: $(SUBPROJ)
echo $(SUBPROJ)
include $(MAKEDEFAULTDIR)/MakeStdLibRules.$(TARGET)
-19
View File
@@ -1,19 +0,0 @@
cmake_minimum_required(VERSION 3.10)
project(marte_dev_tests)
include_directories(
${MARTe2_DIR}/Source/Core/BareMetal/L0Types
${MARTe2_DIR}/Source/Core/BareMetal/L1Portability
# ... more ...
../../Source
../../Headers
)
file(GLOB SOURCES "*.cpp")
add_executable(UnitTests ${SOURCES})
target_link_libraries(UnitTests
marte_dev
${MARTe2_DIR}/Build/${TARGET}/Core/libMARTe2.so
)
+1
View File
@@ -0,0 +1 @@
include Makefile.inc
+39
View File
@@ -0,0 +1,39 @@
OBJSX =
PACKAGE = Test/UnitTests
ROOT_DIR = ../..
MAKEDEFAULTDIR=$(MARTe2_DIR)/MakeDefaults
include $(MAKEDEFAULTDIR)/MakeStdLibDefs.$(TARGET)
INCLUDES += -I$(ROOT_DIR)/Source/Core/Types/Result
INCLUDES += -I$(ROOT_DIR)/Source/Core/Types/Vec
INCLUDES += -I$(ROOT_DIR)/Source/Components/Interfaces/DebugService
INCLUDES += -I$(ROOT_DIR)/Source/Components/Interfaces/TCPLogger
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L0Types
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L2Objects
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L3Streams
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Messages
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Logger
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L4Configuration
INCLUDES += -I$(MARTe2_DIR)/Source/Core/BareMetal/L5GAMs
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L3Services
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L4Messages
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L4LoggerService
INCLUDES += -I$(MARTe2_DIR)/Source/Core/Scheduler/L5GAMs
INCLUDES += -I$(MARTe2_DIR)/Source/Core/FileSystem/L1Portability
INCLUDES += -I$(MARTe2_DIR)/Source/Core/FileSystem/L3Streams
LIBRARIES += -L$(MARTe2_DIR)/Build/$(TARGET)/Core -lMARTe2
LIBRARIES += -L$(ROOT_DIR)/Build/$(TARGET)/Components/Interfaces/DebugService -lDebugService
LIBRARIES += -L$(ROOT_DIR)/Build/$(TARGET)/Components/Interfaces/TCPLogger -lTcpLogger
all: $(OBJS) $(BUILD_DIR)/UnitTests$(EXEEXT)
echo $(OBJS)
include $(MAKEDEFAULTDIR)/MakeStdLibRules.$(TARGET)
+717
View File
@@ -0,0 +1,717 @@
#include <stdio.h>
#include <assert.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>
#include "DebugCore.h"
#include "DebugService.h"
#include "DebugBrokerWrapper.h"
#include "TcpLogger.h"
#include "ConfigurationDatabase.h"
#include "ObjectRegistryDatabase.h"
namespace MARTe {
void TestTcpLogger() {
printf("Stability Logger Tests...\n");
TcpLogger logger;
ConfigurationDatabase config;
config.Write("Port", (uint32)0); // Random port
assert(logger.Initialise(config));
}
class DebugServiceTest {
public:
static void TestAll() {
printf("Stability Logic Tests...\n");
ObjectRegistryDatabase::Instance()->Purge();
DebugService service;
assert(service.traceBuffer.Init(1024 * 1024));
ConfigurationDatabase cfg;
cfg.Write("ControlPort", (uint32)0);
cfg.Write("StreamPort", (uint32)0);
cfg.Write("SuppressTimeoutLogs", (uint32)1);
assert(service.Initialise(cfg));
// 1. Signal logic
uint32 val = 0;
service.RegisterSignal(&val, UnsignedInteger32Bit, "X.Y.Z", 0, 1);
assert(service.TraceSignal("Z", true) == 1);
assert(service.ForceSignal("Z", "123") == 1);
uint64 ts = (uint64)((float64)HighResolutionTimer::Counter() * HighResolutionTimer::Period() * 1.0e9);
service.ProcessSignal(service.signals[0], 4, ts);
assert(val == 123);
service.UnforceSignal("Z");
// 2. Commands
{ StreamString out; service.HandleCommand("TREE", out); }
{ StreamString out; service.HandleCommand("DISCOVER", out); }
{ StreamString out; service.HandleCommand("CONFIG", out); }
{ StreamString out; service.HandleCommand("PAUSE", out); }
{ StreamString out; service.HandleCommand("RESUME", out); }
{ StreamString out; service.HandleCommand("LS /", out); }
{ StreamString out; service.HandleCommand("INFO X.Y.Z", out); }
{ StreamString out; service.HandleCommand("MSG DebugService DummyFunc 0 K=V", out); }
// 3. Broker Active Status
volatile bool active = false;
Vec<uint32> indices;
Vec<uint32> sizes;
FastPollingMutexSem mutex;
DebugSignalInfo* ptrs[1] = { service.signals[0] };
volatile bool anyBreak = false;
Vec<uint32> breakIdx;
service.RegisterBroker(ptrs, 1, NULL_PTR(MemoryMapBroker*), &active, &indices, &sizes, &mutex, &anyBreak, &breakIdx);
service.UpdateBrokersActiveStatus();
assert(active == true);
assert(indices.Size() == 1);
assert(indices[0] == 0);
// Helper Process
DebugBrokerHelper::Process(&service, ptrs, indices, sizes, mutex, &anyBreak, &breakIdx);
// 4. Step / per-thread filter
// STEP with no thread filter — all threads can consume
service.Step(2u, NULL_PTR(const char8 *));
assert(!service.IsPaused());
assert(service.stepRemaining == 2u);
service.ConsumeStepIfNeeded("GAM1", "ThreadA");
assert(service.stepRemaining == 1u);
assert(!service.IsPaused());
service.ConsumeStepIfNeeded("GAM1", "ThreadB");
assert(service.stepRemaining == 0u);
assert(service.IsPaused());
assert(service.pausedAtGam == "GAM1");
// STEP with a thread filter — only matching thread consumes
service.Step(2u, "ThreadA");
assert(!service.IsPaused());
assert(service.stepThreadFilter == "ThreadA");
// ThreadB should be ignored
service.ConsumeStepIfNeeded("GAMB", "ThreadB");
assert(service.stepRemaining == 2u); // unchanged
assert(!service.IsPaused());
// ThreadA consumes both credits
service.ConsumeStepIfNeeded("GAMA1", "ThreadA");
assert(service.stepRemaining == 1u);
assert(!service.IsPaused());
service.ConsumeStepIfNeeded("GAMA2", "ThreadA");
assert(service.stepRemaining == 0u);
assert(service.IsPaused());
assert(service.pausedAtGam == "GAMA2");
// STEP with unknown thread (NULL threadName arg to ConsumeStep) is also filtered out
service.Step(1u, "ThreadA");
service.ConsumeStepIfNeeded("X", NULL_PTR(const char8 *));
assert(service.stepRemaining == 1u); // not consumed
service.SetPaused(false);
service.Step(0u, NULL_PTR(const char8 *));
// 5. VALUE command — smoke test, no crash
{ StreamString out; service.HandleCommand("VALUE X.Y.Z", out); }
{ StreamString out; service.HandleCommand("VALUE NoSuchSignal", out); }
{ StreamString out; service.HandleCommand("STEP 1 ThreadA", out); }
assert(service.stepThreadFilter == "ThreadA");
{ StreamString out; service.HandleCommand("STEP 3", out); }
assert(service.stepThreadFilter.Size() == 0u);
}
// -------------------------------------------------------------------------
// FIX #4: ForceSignal overflow guard
// -------------------------------------------------------------------------
static void TestForceSignalOversizeRejected() {
printf("FIX #4: ForceSignal oversized signal rejected...\n");
ObjectRegistryDatabase::Instance()->Purge();
DebugService service;
assert(service.traceBuffer.Init(1024 * 1024));
ConfigurationDatabase cfg;
cfg.Write("ControlPort", (uint32)0);
cfg.Write("StreamPort", (uint32)0);
cfg.Write("SuppressTimeoutLogs", (uint32)1);
assert(service.Initialise(cfg));
// A 256-element float64 array requires 2048 bytes — exceeds forcedValue[1024].
// RegisterSignal itself is fine; the overflow guard is in ForceSignal.
float64 bigArray[256];
memset(bigArray, 0, sizeof(bigArray));
service.RegisterSignal(bigArray, Float64Bit, "Big.Array", 1, 256);
// ForceSignal must reject the request and return 0 matches applied.
// (The signal IS found by alias but the size check must veto it.)
uint32 forced = service.ForceSignal("Array", "1.0");
assert(forced == 0); // rejected — not forced
printf(" -> PASS: oversized force correctly rejected\n");
// A normal scalar float64 (8 bytes) must still be forceable.
float64 scalarVal = 0.0;
service.RegisterSignal(&scalarVal, Float64Bit, "Small.Scalar", 0, 1);
uint32 forcedSmall = service.ForceSignal("Scalar", "3.14");
assert(forcedSmall == 1); // accepted
printf(" -> PASS: normal scalar force accepted\n");
}
// -------------------------------------------------------------------------
// FIX #1: Streamer buffer bounds — Pop maxSize respected
// -------------------------------------------------------------------------
static void TestStreamerPopMaxSize() {
printf("FIX #1: TraceRingBuffer Pop respects maxSize...\n");
TraceRingBuffer rb;
assert(rb.Init(4096));
// Push a 512-byte sample
uint8 bigSample[512];
memset(bigSample, 0xAB, sizeof(bigSample));
assert(rb.Push(42u, 999u, bigSample, 512u));
// Pop with a maxSize smaller than the pushed size — must return false
// and not overflow the destination buffer.
uint8 smallBuf[64];
uint32 id = 0, size = 0;
uint64 ts = 0;
bool ok = rb.Pop(id, ts, smallBuf, size, 64u);
assert(!ok); // must be rejected, not a buffer overrun
printf(" -> PASS: Pop with insufficient maxSize correctly rejected\n");
// After skipping the oversized sample the buffer is empty (only one
// sample was pushed), so a second Pop must also return false.
ok = rb.Pop(id, ts, smallBuf, size, 64u);
assert(!ok);
printf(" -> PASS: Ring buffer empty after oversized pop skipped\n");
}
// -------------------------------------------------------------------------
// FIX #5: TraceRingBuffer Pop skips only the oversized entry, not all data
// -------------------------------------------------------------------------
static void TestRingBufferSkipOversizedEntry() {
printf("FIX #5: Oversized Pop skips only that entry, not all data...\n");
TraceRingBuffer rb;
assert(rb.Init(4096));
// Push sample A (oversized for a 64-byte receiver)
uint8 bigSample[512];
memset(bigSample, 0xAA, sizeof(bigSample));
assert(rb.Push(1u, 100u, bigSample, 512u));
// Push sample B (fits in 64-byte receiver)
uint8 smallSample[4] = {0xDE, 0xAD, 0xBE, 0xEF};
assert(rb.Push(2u, 200u, smallSample, 4u));
uint8 dst[64];
uint32 id = 0, sz = 0;
uint64 rts = 0;
// Pop with maxSize=64: sample A (512 bytes) must be skipped, not crash
bool ok1 = rb.Pop(id, rts, dst, sz, 64u);
assert(!ok1); // A skipped
printf(" -> PASS: oversized sample A correctly skipped\n");
// Sample B (4 bytes) must still be readable — before the fix the whole
// ring was discarded so this would also return false.
bool ok2 = rb.Pop(id, rts, dst, sz, 64u);
assert(ok2);
assert(id == 2u);
assert(sz == 4u);
assert(dst[0] == 0xDE && dst[3] == 0xEF);
printf(" -> PASS: subsequent sample B retrieved after A was skipped\n");
// Buffer should now be empty
bool ok3 = rb.Pop(id, rts, dst, sz, 64u);
assert(!ok3);
printf(" -> PASS: no further samples (buffer empty)\n");
}
// -------------------------------------------------------------------------
// FIX #3: signalPointers null guard in UpdateBrokers*
// -------------------------------------------------------------------------
static void TestUpdateBrokersNullSignalPointers() {
printf("FIX #3: UpdateBrokers* with null signalPointers — no crash...\n");
ObjectRegistryDatabase::Instance()->Purge();
DebugService service;
assert(service.traceBuffer.Init(1024 * 1024));
ConfigurationDatabase cfg;
cfg.Write("ControlPort", (uint32)0);
cfg.Write("StreamPort", (uint32)0);
cfg.Write("SuppressTimeoutLogs", (uint32)1);
assert(service.Initialise(cfg));
// Register a broker whose signalPointers is NULL but numSignals > 0.
// Before the fix this dereferenced NULL → segfault.
volatile bool active = false;
Vec<uint32> indices;
Vec<uint32> sizes;
FastPollingMutexSem mutex;
volatile bool anyBreak = false;
Vec<uint32> breakIdx;
service.RegisterBroker(NULL_PTR(DebugSignalInfo**), 1u,
NULL_PTR(MemoryMapBroker*),
&active, &indices, &sizes, &mutex,
&anyBreak, &breakIdx);
// These must not crash
service.UpdateBrokersActiveStatus();
service.UpdateBrokersBreakStatus();
printf(" -> PASS: no crash on null signalPointers\n");
}
// -------------------------------------------------------------------------
// FIX #9: GetSignalValue — large array truncated at GET_VALUE_MAX_ELEMENTS
// -------------------------------------------------------------------------
static void TestGetSignalValueTruncation() {
printf("FIX #9: GetSignalValue large array capped at %u elements...\n",
(unsigned)DebugService::GET_VALUE_MAX_ELEMENTS);
ObjectRegistryDatabase::Instance()->Purge();
DebugService service;
assert(service.traceBuffer.Init(1024 * 1024));
ConfigurationDatabase cfg;
cfg.Write("ControlPort", (uint32)0);
cfg.Write("StreamPort", (uint32)0);
cfg.Write("SuppressTimeoutLogs", (uint32)1);
assert(service.Initialise(cfg));
// Register a 512-element uint8 array (> GET_VALUE_MAX_ELEMENTS = 256)
static uint8 bigBuf[512];
for (uint32 i = 0; i < 512; i++) bigBuf[i] = (uint8)(i & 0xFF);
service.RegisterSignal(bigBuf, UnsignedInteger8Bit, "Big.Signal", 1, 512);
// VALUE command — smoke test, must not crash or loop
{ StreamString out; service.HandleCommand("VALUE Signal", out); }
printf(" -> PASS: VALUE on large array completed without hang\n");
// Verify directly: nElem is capped before the byte limit
// The signal has 512 uint8 elements; after fix nElem must be <= 256
DebugSignalInfo *sig = service.signals[0];
assert(sig->numberOfElements == 512u); // original unchanged
// We can't call GetSignalValue with a real socket here, but we can
// verify the constant is properly visible and correctly set
assert(DebugService::GET_VALUE_MAX_ELEMENTS == 256u);
printf(" -> PASS: GET_VALUE_MAX_ELEMENTS constant is %u\n",
(unsigned)DebugService::GET_VALUE_MAX_ELEMENTS);
}
// -------------------------------------------------------------------------
// FIX #6/#8: rate-limit and idle-timeout constants exist and are sane
// -------------------------------------------------------------------------
static void TestServerConstantsSane() {
printf("FIX #6/#8: server protection constants are valid...\n");
assert(DebugService::CMD_RATE_LIMIT > 0u);
assert(DebugService::CLIENT_IDLE_TIMEOUT_MS > 0u);
// Idle timeout must be large enough to not disconnect a healthy client
// in a single polling cycle (which is ~100 ms)
assert(DebugService::CLIENT_IDLE_TIMEOUT_MS >= 1000u);
printf(" -> PASS: CMD_RATE_LIMIT=%u, CLIENT_IDLE_TIMEOUT_MS=%u\n",
(unsigned)DebugService::CMD_RATE_LIMIT,
(unsigned)DebugService::CLIENT_IDLE_TIMEOUT_MS);
}
// -------------------------------------------------------------------------
// FIX #7: MSG key overflow — oversized key line is skipped, no buffer overrun
// -------------------------------------------------------------------------
static void TestMsgKeyBoundsCheck() {
printf("FIX #7: MSG command oversized key is skipped without crash...\n");
ObjectRegistryDatabase::Instance()->Purge();
DebugService service;
assert(service.traceBuffer.Init(1024 * 1024));
ConfigurationDatabase cfg;
cfg.Write("ControlPort", (uint32)0);
cfg.Write("StreamPort", (uint32)0);
cfg.Write("SuppressTimeoutLogs", (uint32)1);
assert(service.Initialise(cfg));
// Build a MSG command whose key is 300 characters long (> keyBuf[256]).
// Before the fix the Read() would overflow the 256-byte stack buffer.
StreamString cmd = "MSG DebugService DummyFunc 0 ";
for (uint32 i = 0; i < 300u; i++) cmd += 'K';
cmd += "=value";
// Must not crash or assert
{ StreamString out; service.HandleCommand(cmd, out); }
printf(" -> PASS: oversized key handled without buffer overflow\n");
// A normal-length key should still be accepted (regression check)
{ StreamString out; service.HandleCommand("MSG DebugService DummyFunc 0 NormalKey=NormalValue", out); }
printf(" -> PASS: normal key not rejected by bounds check\n");
}
// -------------------------------------------------------------------------
// FIX #10: Multi-segment TCP command buffering via inputBuffer
// -------------------------------------------------------------------------
static void TestServerInputBuffering() {
printf("FIX #10: Multi-segment TCP command buffering...\n");
ObjectRegistryDatabase::Instance()->Purge();
DebugService service;
assert(service.traceBuffer.Init(1024 * 1024));
ConfigurationDatabase cfg;
cfg.Write("ControlPort", (uint32)0);
cfg.Write("StreamPort", (uint32)0);
cfg.Write("SuppressTimeoutLogs", (uint32)1);
assert(service.Initialise(cfg));
// Verify inputBuffer is initialised empty
assert(service.inputBuffer.Size() == 0u);
printf(" -> PASS: inputBuffer initialised to empty\n");
// Simulate fragment 1 arriving: "FORCE Signal " (no newline yet)
// In the real Server() this would be written via Read(); here we
// directly manipulate the carry-over buffer (friend-class access).
{
(void)service.inputBuffer.Seek(service.inputBuffer.Size());
uint32 f1Len = 13u; // length of "FORCE Signal "
service.inputBuffer.Write("FORCE Signal ", f1Len);
}
assert(service.inputBuffer.Size() == 13u);
printf(" -> PASS: partial command held in inputBuffer after fragment 1\n");
// Simulate fragment 2 completing the command: "123\n"
{
(void)service.inputBuffer.Seek(service.inputBuffer.Size());
uint32 f2Len = 4u;
service.inputBuffer.Write("123\n", f2Len);
}
// Now scan inputBuffer for complete lines — mirrors the Server() loop
const char8 *raw = service.inputBuffer.Buffer();
uint32 total = (uint32)service.inputBuffer.Size();
uint32 lineStart = 0u;
uint32 cmdsFound = 0u;
char8 cmdBuf[64];
memset(cmdBuf, 0, sizeof(cmdBuf));
for (uint32 pos = 0u; pos < total; pos++) {
if (raw[pos] != '\n') continue;
uint32 len = pos - lineStart;
if (len > 0u && raw[lineStart + len - 1u] == '\r') len--;
if (len > 0u) {
cmdsFound++;
uint32 cp = (len < 63u) ? len : 63u;
memcpy(cmdBuf, raw + lineStart, cp);
cmdBuf[cp] = '\0';
}
lineStart = pos + 1u;
}
assert(cmdsFound == 1u);
// The two fragments assembled into "FORCE Signal 123"
assert(strncmp(cmdBuf, "FORCE Signal 123", 16) == 0);
printf(" -> PASS: fragmented command reassembled to '%s'\n", cmdBuf);
// Remainder after the last '\n' should be empty (no trailing bytes)
assert(lineStart == total);
printf(" -> PASS: no partial remainder after complete command\n");
// Verify INPUT_BUFFER_MAX constant is reachable
assert(DebugService::INPUT_BUFFER_MAX > 4096u);
printf(" -> PASS: INPUT_BUFFER_MAX=%u\n",
(unsigned)DebugService::INPUT_BUFFER_MAX);
}
// -------------------------------------------------------------------------
// FIX #11: Streamer monitored-signal Push protected by tracePushMutex
// -------------------------------------------------------------------------
static void TestStreamerMonitoredPushSerialised() {
printf("FIX #11: Streamer monitored-signal Push uses tracePushMutex...\n");
ObjectRegistryDatabase::Instance()->Purge();
DebugService service;
assert(service.traceBuffer.Init(1024 * 1024));
ConfigurationDatabase cfg;
cfg.Write("ControlPort", (uint32)0);
cfg.Write("StreamPort", (uint32)0);
cfg.Write("SuppressTimeoutLogs", (uint32)1);
assert(service.Initialise(cfg));
uint32 val = 0xDEADBEEF;
service.RegisterSignal(&val, UnsignedInteger32Bit, "Mon.Val", 0, 1);
assert(service.TraceSignal("Val", true) == 1);
uint64 ts = (uint64)((float64)HighResolutionTimer::Counter() *
HighResolutionTimer::Period() * 1000000.0);
// Push via ProcessSignal (uses tracePushMutex internally — broker path)
service.ProcessSignal(service.signals[0], 4u, ts);
// Push directly via tracePushMutex (simulates the Streamer monitored-
// signal path after FIX #11 — it now also acquires tracePushMutex so
// both push paths are serialised with respect to each other).
uint32 monId = 0x80000001u;
uint32 monVal = 0x12345678u;
service.tracePushMutex.FastLock();
(void)service.traceBuffer.Push(monId, ts + 1u, &monVal, 4u);
service.tracePushMutex.FastUnLock();
// Both samples must be present in FIFO order — if there were a race
// one or both would be corrupt or missing.
uint32 id = 0, sz = 0; uint64 rts = 0; uint8 dst[64];
assert(service.traceBuffer.Pop(id, rts, dst, sz, 64u));
assert(id == service.signals[0]->internalID);
assert(sz == 4u);
assert(service.traceBuffer.Pop(id, rts, dst, sz, 64u));
assert(id == monId);
assert(sz == 4u);
assert(!service.traceBuffer.Pop(id, rts, dst, sz, 64u)); // buffer empty
printf(" -> PASS: broker and monitored-signal pushes both retrieved in order\n");
}
// -------------------------------------------------------------------------
// FIX #2: tracePushMutex — concurrent Push from two logical threads
// (single-threaded simulation: verify no data corruption across two pushes
// that would race without the mutex)
// -------------------------------------------------------------------------
static void TestTracePushSerialised() {
printf("FIX #2: Concurrent ProcessSignal serialised via tracePushMutex...\n");
ObjectRegistryDatabase::Instance()->Purge();
DebugService service;
assert(service.traceBuffer.Init(1024 * 1024));
ConfigurationDatabase cfg;
cfg.Write("ControlPort", (uint32)0);
cfg.Write("StreamPort", (uint32)0);
cfg.Write("SuppressTimeoutLogs", (uint32)1);
assert(service.Initialise(cfg));
uint32 valA = 0xAABBCCDD;
uint32 valB = 0x11223344;
service.RegisterSignal(&valA, UnsignedInteger32Bit, "P.A", 0, 1);
service.RegisterSignal(&valB, UnsignedInteger32Bit, "P.B", 0, 1);
assert(service.TraceSignal("A", true) == 1);
assert(service.TraceSignal("B", true) == 1);
uint64 ts = (uint64)((float64)HighResolutionTimer::Counter() *
HighResolutionTimer::Period() * 1000000.0);
// Simulate two sequential calls as would happen from two RT threads.
// Without tracePushMutex they could interleave and corrupt the ring.
service.ProcessSignal(service.signals[0], 4, ts);
service.ProcessSignal(service.signals[1], 4, ts + 1u);
// Both samples must be retrievable in FIFO order with correct IDs.
uint32 id, size;
uint64 rts;
uint8 buf[64];
uint32 id0 = service.signals[0]->internalID;
uint32 id1 = service.signals[1]->internalID;
assert(service.traceBuffer.Pop(id, rts, buf, size, 64u));
assert(id == id0);
assert(size == 4u);
assert(service.traceBuffer.Pop(id, rts, buf, size, 64u));
assert(id == id1);
assert(size == 4u);
printf(" -> PASS: Both samples intact after serialised push\n");
}
// -------------------------------------------------------------------------
// Fix #2 (Swap): UpdateBrokersActiveStatus publishes all active-signal
// indices correctly when multiple signals are tracing/forcing.
// -------------------------------------------------------------------------
static void TestUpdateBrokersSwapPublishesAllIndices() {
printf("Fix #2 (Swap): UpdateBrokersActiveStatus publishes all active indices...\n");
ObjectRegistryDatabase::Instance()->Purge();
DebugService service;
assert(service.traceBuffer.Init(1024 * 1024));
ConfigurationDatabase cfg;
cfg.Write("ControlPort", (uint32)0);
cfg.Write("StreamPort", (uint32)0);
cfg.Write("SuppressTimeoutLogs", (uint32)1);
assert(service.Initialise(cfg));
uint32 v0 = 0, v1 = 0, v2 = 0;
service.RegisterSignal(&v0, UnsignedInteger32Bit, "S.X", 0, 1);
service.RegisterSignal(&v1, UnsignedInteger32Bit, "S.Y", 0, 1);
service.RegisterSignal(&v2, UnsignedInteger32Bit, "S.Z", 0, 1);
// Enable tracing on X and Z (not Y)
assert(service.TraceSignal("X", true) == 1);
assert(service.TraceSignal("Z", true) == 1);
volatile bool active = false;
Vec<uint32> indices;
Vec<uint32> sizes;
FastPollingMutexSem mutex;
volatile bool anyBreak = false;
Vec<uint32> breakIdx;
DebugSignalInfo *ptrs[3] = {
service.signals[0], service.signals[1], service.signals[2]
};
service.RegisterBroker(ptrs, 3u, NULL_PTR(MemoryMapBroker *),
&active, &indices, &sizes, &mutex,
&anyBreak, &breakIdx);
service.UpdateBrokersActiveStatus();
// After Swap the broker's activeIndices must hold exactly indices 0 and 2
assert(active == true);
assert(indices.Size() == 2u);
// indices are in order of signal position in the broker (0 then 2)
assert(indices[0] == 0u);
assert(indices[1] == 2u);
printf(" -> PASS: Swap correctly published 2 active indices out of 3\n");
// Disable one; Swap again — only index 0 should remain
assert(service.TraceSignal("Z", false) == 1);
service.UpdateBrokersActiveStatus();
assert(indices.Size() == 1u);
assert(indices[0] == 0u);
printf(" -> PASS: After disabling Z, only index 0 remains\n");
}
// -------------------------------------------------------------------------
// Fix #3 (copy-before-unlock): break evaluation still works after the
// copy-indices-then-unlock refactor in DebugBrokerHelper::Process().
// -------------------------------------------------------------------------
static void TestBreakEvaluationAfterLockRelease() {
printf("Fix #3 (copy-before-unlock): break evaluation works after lock release...\n");
ObjectRegistryDatabase::Instance()->Purge();
DebugService service;
assert(service.traceBuffer.Init(1024 * 1024));
ConfigurationDatabase cfg;
cfg.Write("ControlPort", (uint32)0);
cfg.Write("StreamPort", (uint32)0);
cfg.Write("SuppressTimeoutLogs", (uint32)1);
assert(service.Initialise(cfg));
uint32 val = 5u;
service.RegisterSignal(&val, UnsignedInteger32Bit, "Brk.Val", 0, 1);
// Set break: pause when Val > 3
assert(service.SetBreak("Val", BREAK_GT, 3.0) == 1u);
service.UpdateBrokersBreakStatus();
volatile bool active = false;
Vec<uint32> indices;
Vec<uint32> sizes;
FastPollingMutexSem mutex;
volatile bool anyBreak = false;
Vec<uint32> breakIdx;
DebugSignalInfo *ptrs[1] = { service.signals[0] };
service.RegisterBroker(ptrs, 1u, NULL_PTR(MemoryMapBroker *),
&active, &indices, &sizes, &mutex,
&anyBreak, &breakIdx);
// UpdateBrokersBreakStatus must propagate the break flag to the broker
service.UpdateBrokersBreakStatus();
assert(anyBreak == true);
assert(breakIdx.Size() == 1u);
// Process() copies break indices, releases lock, evaluates break.
// val = 5 > 3 — service must become paused.
DebugBrokerHelper::Process(&service, ptrs, indices, sizes, mutex,
&anyBreak, &breakIdx);
assert(service.IsPaused());
printf(" -> PASS: break condition triggered correctly via copy-before-unlock path\n");
// Reset; change value below threshold — must NOT pause.
service.SetPaused(false);
val = 1u;
DebugBrokerHelper::Process(&service, ptrs, indices, sizes, mutex,
&anyBreak, &breakIdx);
assert(!service.IsPaused());
printf(" -> PASS: value below threshold does not trigger break\n");
}
// -------------------------------------------------------------------------
// Fix #4 (atomic decimation): decimationFactor > 1 causes exactly one Push
// after factor calls to ProcessSignal.
// -------------------------------------------------------------------------
static void TestDecimationCounterAtomic() {
printf("Fix #4 (atomic decimation): one push per decimation factor...\n");
ObjectRegistryDatabase::Instance()->Purge();
DebugService service;
assert(service.traceBuffer.Init(1024 * 1024));
ConfigurationDatabase cfg;
cfg.Write("ControlPort", (uint32)0);
cfg.Write("StreamPort", (uint32)0);
cfg.Write("SuppressTimeoutLogs", (uint32)1);
assert(service.Initialise(cfg));
uint32 val = 0x42424242u;
service.RegisterSignal(&val, UnsignedInteger32Bit, "Dec.Val", 0, 1);
// TraceSignal with decimation = 3
assert(service.TraceSignal("Val", true, 3u) == 1u);
assert(service.signals[0]->decimationFactor == 3u);
uint64 ts = (uint64)((float64)HighResolutionTimer::Counter() *
HighResolutionTimer::Period() * 1000000.0);
// Calls 1 and 2 — counter advances but no push
service.ProcessSignal(service.signals[0], 4u, ts);
service.ProcessSignal(service.signals[0], 4u, ts + 1u);
uint32 id, sz; uint64 rts; uint8 buf[64];
bool hasData = service.traceBuffer.Pop(id, rts, buf, sz, 64u);
assert(!hasData); // no sample yet
printf(" -> PASS: no push after 2 calls with decimation=3\n");
// Call 3 — counter reaches factor, one push occurs
service.ProcessSignal(service.signals[0], 4u, ts + 2u);
hasData = service.traceBuffer.Pop(id, rts, buf, sz, 64u);
assert(hasData);
assert(id == service.signals[0]->internalID);
assert(sz == 4u);
printf(" -> PASS: exactly one push after %u calls with decimation=3\n", 3u);
// Call 4 and 5 — no push again
service.ProcessSignal(service.signals[0], 4u, ts + 3u);
service.ProcessSignal(service.signals[0], 4u, ts + 4u);
hasData = service.traceBuffer.Pop(id, rts, buf, sz, 64u);
assert(!hasData);
printf(" -> PASS: no push for calls 4 and 5 (decimation reset)\n");
// Call 6 — second push
service.ProcessSignal(service.signals[0], 4u, ts + 5u);
hasData = service.traceBuffer.Pop(id, rts, buf, sz, 64u);
assert(hasData);
printf(" -> PASS: second push on call 6\n");
}
};
}
#include <signal.h>
void timeout_handler(int sig) {
printf("Test timed out!\n");
_exit(1);
}
int main() {
signal(SIGALRM, timeout_handler);
alarm(10);
printf("--- MARTe2 Debug Suite COVERAGE V34 ---\n");
MARTe::TestTcpLogger();
MARTe::DebugServiceTest::TestAll();
// FIX #1, #2, #4
MARTe::DebugServiceTest::TestForceSignalOversizeRejected();
MARTe::DebugServiceTest::TestStreamerPopMaxSize();
MARTe::DebugServiceTest::TestTracePushSerialised();
// FIX #3, #6, #7, #8, #9
MARTe::DebugServiceTest::TestUpdateBrokersNullSignalPointers();
MARTe::DebugServiceTest::TestGetSignalValueTruncation();
MARTe::DebugServiceTest::TestServerConstantsSane();
MARTe::DebugServiceTest::TestMsgKeyBoundsCheck();
// FIX #5, #10, #11
MARTe::DebugServiceTest::TestRingBufferSkipOversizedEntry();
MARTe::DebugServiceTest::TestServerInputBuffering();
MARTe::DebugServiceTest::TestStreamerMonitoredPushSerialised();
// Fix #2 (Swap), Fix #3 (copy-before-unlock), Fix #4 (atomic decimation)
MARTe::DebugServiceTest::TestUpdateBrokersSwapPublishesAllIndices();
MARTe::DebugServiceTest::TestBreakEvaluationAfterLockRelease();
MARTe::DebugServiceTest::TestDecimationCounterAtomic();
printf("\nCOVERAGE V34 PASSED!\n");
return 0;
}
-108
View File
@@ -1,108 +0,0 @@
#include <stdio.h>
#include <assert.h>
#include "DebugCore.h"
#include "DebugService.h"
#include "TcpLogger.h"
#include "ConfigurationDatabase.h"
#include "ObjectRegistryDatabase.h"
#include "StandardParser.h"
using namespace MARTe;
void TestRingBuffer() {
printf("Testing TraceRingBuffer...\n");
TraceRingBuffer rb;
// Each entry is 4(ID) + 4(Size) + 4(Val) = 12 bytes.
// 100 entries = 1200 bytes.
assert(rb.Init(2048));
// Fill buffer to test wrap-around
uint32 id = 1;
uint32 val = 0xAAAAAAAA;
uint32 size = 4;
for (int i=0; i<100; i++) {
id = i;
val = 0xBBBB0000 | i;
if (!rb.Push(id, &val, size)) {
printf("Failed at iteration %d\n", i);
assert(false);
}
}
assert(rb.Count() == 100 * (4 + 4 + 4));
uint32 pId, pVal, pSize;
for (int i=0; i<100; i++) {
assert(rb.Pop(pId, &pVal, pSize, 4));
assert(pId == (uint32)i);
assert(pVal == (0xBBBB0000 | (uint32)i));
}
assert(rb.Count() == 0);
printf("TraceRingBuffer test passed.\n");
}
void TestSuffixMatch() {
printf("Testing SuffixMatch...\n");
DebugService service;
uint32 mock = 0;
service.RegisterSignal(&mock, UnsignedInteger32Bit, "App.Data.Timer.Counter");
// Should match
assert(service.TraceSignal("App.Data.Timer.Counter", true) == 1);
assert(service.TraceSignal("Timer.Counter", true) == 1);
assert(service.TraceSignal("Counter", true) == 1);
// Should NOT match
assert(service.TraceSignal("App.Timer", true) == 0);
assert(service.TraceSignal("unt", true) == 0);
printf("SuffixMatch test passed.\n");
}
void TestTcpLogger() {
printf("Testing TcpLogger...\n");
TcpLogger logger;
ConfigurationDatabase config;
config.Write("Port", (uint16)9999);
assert(logger.Initialise(config));
REPORT_ERROR_STATIC(ErrorManagement::Information, "Unit Test Log Message");
printf("TcpLogger basic test passed.\n");
}
void TestDebugServiceRegistration() {
printf("Testing DebugService Signal Registration...\n");
DebugService service;
uint32 val1 = 10;
float32 val2 = 20.0;
DebugSignalInfo* s1 = service.RegisterSignal(&val1, UnsignedInteger32Bit, "Signal1");
DebugSignalInfo* s2 = service.RegisterSignal(&val2, Float32Bit, "Signal2");
assert(s1 != NULL_PTR(DebugSignalInfo*));
assert(s2 != NULL_PTR(DebugSignalInfo*));
assert(s1->internalID == 0);
assert(s2->internalID == 1);
// Re-register same address
DebugSignalInfo* s1_alias = service.RegisterSignal(&val1, UnsignedInteger32Bit, "Signal1_Alias");
assert(s1_alias == s1);
printf("DebugService registration test passed.\n");
}
int main(int argc, char **argv) {
printf("Running MARTe2 Debug Suite Unit Tests...\n");
TestRingBuffer();
TestDebugServiceRegistration();
TestSuffixMatch();
TestTcpLogger();
printf("\nALL UNIT TESTS PASSED!\n");
return 0;
}
Binary file not shown.
-17
View File
@@ -1,17 +0,0 @@
module marte_debug_cli
go 1.25.7
require (
github.com/gdamore/tcell/v2 v2.13.8
github.com/rivo/tview v0.42.0
)
require (
github.com/gdamore/encoding v1.0.1 // indirect
github.com/lucasb-eyer/go-colorful v1.3.0 // indirect
github.com/rivo/uniseg v0.4.7 // indirect
golang.org/x/sys v0.38.0 // indirect
golang.org/x/term v0.37.0 // indirect
golang.org/x/text v0.31.0 // indirect
)
-47
View File
@@ -1,47 +0,0 @@
github.com/gdamore/encoding v1.0.1 h1:YzKZckdBL6jVt2Gc+5p82qhrGiqMdG/eNs6Wy0u3Uhw=
github.com/gdamore/encoding v1.0.1/go.mod h1:0Z0cMFinngz9kS1QfMjCP8TY7em3bZYeeklsSDPivEo=
github.com/gdamore/tcell/v2 v2.13.8 h1:Mys/Kl5wfC/GcC5Cx4C2BIQH9dbnhnkPgS9/wF3RlfU=
github.com/gdamore/tcell/v2 v2.13.8/go.mod h1:+Wfe208WDdB7INEtCsNrAN6O2m+wsTPk1RAovjaILlo=
github.com/lucasb-eyer/go-colorful v1.3.0 h1:2/yBRLdWBZKrf7gB40FoiKfAWYQ0lqNcbuQwVHXptag=
github.com/lucasb-eyer/go-colorful v1.3.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
github.com/rivo/tview v0.42.0 h1:b/ftp+RxtDsHSaynXTbJb+/n/BxDEi+W3UfF5jILK6c=
github.com/rivo/tview v0.42.0/go.mod h1:cSfIYfhpSGCjp3r/ECJb+GKS7cGJnqV8vfjQPwoXyfY=
github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.38.0 h1:3yZWxaJjBmCWXqhN1qh02AkOnCQ1poK6oF+a7xWL6Gc=
golang.org/x/sys v0.38.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
golang.org/x/term v0.37.0 h1:8EGAD0qCmHYZg6J17DvsMy9/wJ7/D/4pV/wfnld5lTU=
golang.org/x/term v0.37.0/go.mod h1:5pB4lxRNYYVZuTLmy8oR2BH8dflOR+IbTYFD8fi3254=
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
golang.org/x/text v0.31.0 h1:aC8ghyu4JhP8VojJ2lEHBnochRno1sgL6nEi9WGFGMM=
golang.org/x/text v0.31.0/go.mod h1:tKRAlv61yKIjGGHX/4tP1LTbc13YSec1pxVEWXzfoeM=
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
-498
View File
@@ -1,498 +0,0 @@
package main
import (
"encoding/binary"
"encoding/json"
"fmt"
"net"
"sort"
"strings"
"sync"
"time"
"github.com/gdamore/tcell/v2"
"github.com/rivo/tview"
)
// --- Models ---
type Signal struct {
Name string `json:"name"`
ID uint32 `json:"id"`
Type string `json:"type"`
}
type DiscoverResponse struct {
Signals []Signal `json:"Signals"`
}
type TraceValue struct {
Value string
LastUpdate time.Time
}
type AppState struct {
Signals map[string]Signal
IDToSignal map[uint32]string
ForcedSignals map[string]string
TracedSignals map[string]TraceValue
mu sync.RWMutex
}
var state = AppState{
Signals: make(map[string]Signal),
IDToSignal: make(map[uint32]string),
ForcedSignals: make(map[string]string),
TracedSignals: make(map[string]TraceValue),
}
// --- UI Components ---
var (
app *tview.Application
forcedPane *tview.Table
tracedPane *tview.Table
statusPane *tview.TextView
frameworkLogPane *tview.TextView
cmdInput *tview.InputField
mainFlex *tview.Flex
)
// logToStatus prints command output WITHOUT timestamp
func logToStatus(msg string) {
fmt.Fprintf(statusPane, "%s\n", msg)
}
// logToFramework prints framework logs WITH timestamp
func logToFramework(level, msg string) {
color := "white"
switch level {
case "FatalError", "OSError", "ParametersError":
color = "red"
case "Warning":
color = "yellow"
case "Information":
color = "green"
case "Debug":
color = "blue"
}
fmt.Fprintf(frameworkLogPane, "[%s] [[%s]%s[-]] %s\n", time.Now().Format("15:04:05.000"), color, level, msg)
}
// --- Network Logic ---
var (
tcpConn net.Conn
tcpMu sync.Mutex
responseChan = make(chan string, 2000)
connected = false
)
func connectAndMonitor(addr string) {
for {
conn, err := net.Dial("tcp", addr)
if err != nil {
app.QueueUpdateDraw(func() { statusPane.SetText("[red]Connection failed, retrying...\n") })
connected = false
time.Sleep(2 * time.Second)
continue
}
if tc, ok := conn.(*net.TCPConn); ok {
tc.SetNoDelay(true)
}
tcpConn = conn
connected = true
app.QueueUpdateDraw(func() { logToStatus("[green]Connected to DebugService (TCP 8080)") })
go discover()
buf := make([]byte, 4096)
var line strings.Builder
for {
n, err := conn.Read(buf)
if err != nil {
app.QueueUpdateDraw(func() { logToStatus("[red]TCP Disconnected: " + err.Error()) })
connected = false
break
}
for i := 0; i < n; i++ {
if buf[i] == '\n' {
fullLine := strings.TrimSpace(line.String())
line.Reset()
if strings.HasPrefix(fullLine, "LOG ") {
parts := strings.SplitN(fullLine[4:], " ", 2)
if len(parts) == 2 {
app.QueueUpdateDraw(func() { logToFramework(parts[0], parts[1]) })
}
} else if fullLine != "" {
select {
case responseChan <- fullLine:
default:
}
}
} else {
line.WriteByte(buf[i])
}
}
}
tcpConn.Close()
time.Sleep(2 * time.Second)
}
}
func startUDPListener(port int) {
addr, _ := net.ResolveUDPAddr("udp", fmt.Sprintf(":%d", port))
udpConn, err := net.ListenUDP("udp", addr)
if err != nil {
app.QueueUpdateDraw(func() { logToStatus(fmt.Sprintf("UDP Error: %v", err)) })
return
}
defer udpConn.Close()
buf := make([]byte, 2048)
for {
n, _, err := udpConn.ReadFromUDP(buf)
if err != nil || n < 20 {
continue
}
magic := binary.LittleEndian.Uint32(buf[0:4])
if magic != 0xDA7A57AD {
continue
}
count := binary.LittleEndian.Uint32(buf[16:20])
offset := 20
now := time.Now()
for i := uint32(0); i < count; i++ {
if offset+8 > n {
break
}
id := binary.LittleEndian.Uint32(buf[offset : offset+4])
size := binary.LittleEndian.Uint32(buf[offset+4 : offset+8])
offset += 8
if offset+int(size) > n {
break
}
data := buf[offset : offset+int(size)]
offset += int(size)
state.mu.Lock()
if name, ok := state.IDToSignal[id]; ok {
valStr := ""
if size == 4 {
valStr = fmt.Sprintf("%d", binary.LittleEndian.Uint32(data))
} else if size == 8 {
valStr = fmt.Sprintf("%d", binary.LittleEndian.Uint64(data))
} else {
valStr = fmt.Sprintf("%X", data)
}
state.TracedSignals[name] = TraceValue{Value: valStr, LastUpdate: now}
}
state.mu.Unlock()
}
app.QueueUpdateDraw(func() { updateTracedPane() })
}
}
func discover() {
tcpMu.Lock()
defer tcpMu.Unlock()
if !connected {
return
}
app.QueueUpdateDraw(func() { logToStatus("Discovering signals...") })
// Drain old responses
for len(responseChan) > 0 {
<-responseChan
}
fmt.Fprintf(tcpConn, "DISCOVER\n")
var jsonBlock strings.Builder
timeout := time.After(5 * time.Second)
for {
select {
case line := <-responseChan:
if line == "OK DISCOVER" {
goto parsed
}
jsonBlock.WriteString(line)
case <-timeout:
app.QueueUpdateDraw(func() { logToStatus("[red]Discovery Timeout") })
return
}
}
parsed:
var resp DiscoverResponse
if err := json.Unmarshal([]byte(jsonBlock.String()), &resp); err == nil {
state.mu.Lock()
state.IDToSignal = make(map[uint32]string)
for _, s := range resp.Signals {
state.Signals[s.Name] = s
state.IDToSignal[s.ID] = s.Name
}
state.mu.Unlock()
app.QueueUpdateDraw(func() { logToStatus(fmt.Sprintf("Discovered %d signals", len(resp.Signals))) })
}
}
// --- UI Updates ---
func updateForcedPane() {
forcedPane.Clear()
forcedPane.SetCell(0, 0, tview.NewTableCell("Signal").SetTextColor(tcell.ColorYellow).SetAttributes(tcell.AttrBold))
forcedPane.SetCell(0, 1, tview.NewTableCell("Value").SetTextColor(tcell.ColorYellow).SetAttributes(tcell.AttrBold))
state.mu.RLock()
defer state.mu.RUnlock()
keys := make([]string, 0, len(state.ForcedSignals))
for k := range state.ForcedSignals {
keys = append(keys, k)
}
sort.Strings(keys)
for i, k := range keys {
forcedPane.SetCell(i+1, 0, tview.NewTableCell(k))
forcedPane.SetCell(i+1, 1, tview.NewTableCell(state.ForcedSignals[k]).SetTextColor(tcell.ColorGreen))
}
}
func updateTracedPane() {
tracedPane.Clear()
tracedPane.SetCell(0, 0, tview.NewTableCell("Signal").SetTextColor(tcell.ColorBlue).SetAttributes(tcell.AttrBold))
tracedPane.SetCell(0, 1, tview.NewTableCell("Value").SetTextColor(tcell.ColorBlue).SetAttributes(tcell.AttrBold))
tracedPane.SetCell(0, 2, tview.NewTableCell("Last Update").SetTextColor(tcell.ColorBlue).SetAttributes(tcell.AttrBold))
state.mu.RLock()
defer state.mu.RUnlock()
keys := make([]string, 0, len(state.TracedSignals))
for k := range state.TracedSignals {
keys = append(keys, k)
}
sort.Strings(keys)
for i, k := range keys {
tv := state.TracedSignals[k]
tracedPane.SetCell(i+1, 0, tview.NewTableCell(k))
tracedPane.SetCell(i+1, 1, tview.NewTableCell(tv.Value))
tracedPane.SetCell(i+1, 2, tview.NewTableCell(tv.LastUpdate.Format("15:04:05.000")))
}
}
// --- Command Handler ---
func handleInput(text string) {
parts := strings.Fields(text)
if len(parts) == 0 {
return
}
cmd := strings.ToUpper(parts[0])
args := parts[1:]
if !connected && cmd != "EXIT" && cmd != "QUIT" && cmd != "CLEAR" {
logToStatus("[red]Not connected to server")
return
}
switch cmd {
case "LS":
path := ""
if len(args) > 0 {
path = args[0]
}
go func() {
tcpMu.Lock()
defer tcpMu.Unlock()
for len(responseChan) > 0 {
<-responseChan
}
fmt.Fprintf(tcpConn, "LS %s\n", path)
app.QueueUpdateDraw(func() { logToStatus(fmt.Sprintf("Listing nodes under %s...", path)) })
timeout := time.After(2 * time.Second)
for {
select {
case line := <-responseChan:
if line == "OK LS" {
return
}
app.QueueUpdateDraw(func() { logToStatus(line) })
case <-timeout:
app.QueueUpdateDraw(func() { logToStatus("[red]LS Timeout") })
return
}
}
}()
case "FORCE":
if len(args) < 2 {
return
}
path, val := args[0], args[1]
go func() {
tcpMu.Lock()
defer tcpMu.Unlock()
fmt.Fprintf(tcpConn, "FORCE %s %s\n", path, val)
select {
case resp := <-responseChan:
app.QueueUpdateDraw(func() {
logToStatus("Server: " + resp)
state.mu.Lock()
state.ForcedSignals[path] = val
state.mu.Unlock()
updateForcedPane()
})
case <-time.After(1 * time.Second):
app.QueueUpdateDraw(func() { logToStatus("[red]Server Timeout") })
}
}()
case "UNFORCE":
if len(args) < 1 {
return
}
path := args[0]
go func() {
tcpMu.Lock()
defer tcpMu.Unlock()
fmt.Fprintf(tcpConn, "UNFORCE %s\n", path)
select {
case resp := <-responseChan:
app.QueueUpdateDraw(func() {
logToStatus("Server: " + resp)
state.mu.Lock()
delete(state.ForcedSignals, path)
state.mu.Unlock()
updateForcedPane()
})
case <-time.After(1 * time.Second):
app.QueueUpdateDraw(func() { logToStatus("[red]Server Timeout") })
}
}()
case "TRACE":
if len(args) < 1 {
return
}
path := args[0]
decim := "1"
if len(args) > 1 {
decim = args[1]
}
go func() {
tcpMu.Lock()
defer tcpMu.Unlock()
fmt.Fprintf(tcpConn, "TRACE %s 1 %s\n", path, decim)
select {
case resp := <-responseChan:
app.QueueUpdateDraw(func() {
logToStatus("Server: " + resp)
state.mu.Lock()
state.TracedSignals[path] = TraceValue{Value: "...", LastUpdate: time.Now()}
state.mu.Unlock()
updateTracedPane()
})
case <-time.After(1 * time.Second):
app.QueueUpdateDraw(func() { logToStatus("[red]Server Timeout") })
}
}()
case "UNTRACE":
if len(args) < 1 {
return
}
path := args[0]
go func() {
tcpMu.Lock()
defer tcpMu.Unlock()
fmt.Fprintf(tcpConn, "UNTRACE %s\n", path)
select {
case resp := <-responseChan:
app.QueueUpdateDraw(func() {
logToStatus("Server: " + resp)
state.mu.Lock()
delete(state.TracedSignals, path)
state.mu.Unlock()
updateTracedPane()
})
case <-time.After(1 * time.Second):
app.QueueUpdateDraw(func() { logToStatus("[red]Server Timeout") })
}
}()
case "DISCOVER":
go discover()
case "CLEAR":
statusPane.Clear()
frameworkLogPane.Clear()
case "EXIT", "QUIT":
app.Stop()
default:
logToStatus("Unknown command: " + cmd)
}
}
func main() {
app = tview.NewApplication()
forcedPane = tview.NewTable()
forcedPane.SetBorders(true)
forcedPane.SetTitle(" Forced Signals ")
forcedPane.SetBorder(true)
tracedPane = tview.NewTable()
tracedPane.SetBorders(true)
tracedPane.SetTitle(" Traced Signals (Live) ")
tracedPane.SetBorder(true)
statusPane = tview.NewTextView()
statusPane.SetDynamicColors(true)
statusPane.SetRegions(true)
statusPane.SetWordWrap(true)
statusPane.SetChangedFunc(func() {
statusPane.ScrollToEnd()
app.Draw()
})
statusPane.SetTitle(" CLI Status / Command Output ")
statusPane.SetBorder(true)
frameworkLogPane = tview.NewTextView()
frameworkLogPane.SetDynamicColors(true)
frameworkLogPane.SetRegions(true)
frameworkLogPane.SetWordWrap(true)
frameworkLogPane.SetChangedFunc(func() {
frameworkLogPane.ScrollToEnd()
app.Draw()
})
frameworkLogPane.SetTitle(" MARTe2 Framework Logs ")
frameworkLogPane.SetBorder(true)
cmdInput = tview.NewInputField()
cmdInput.SetLabel("marte_debug> ")
cmdInput.SetFieldWidth(0)
cmdInput.SetDoneFunc(func(key tcell.Key) {
if key == tcell.KeyEnter {
text := cmdInput.GetText()
if text != "" {
handleInput(text)
cmdInput.SetText("")
}
}
})
flexTop := tview.NewFlex()
flexTop.SetDirection(tview.FlexColumn)
flexTop.AddItem(forcedPane, 0, 1, false)
flexTop.AddItem(tracedPane, 0, 1, false)
flexTop.AddItem(statusPane, 0, 1, false)
mainFlex = tview.NewFlex()
mainFlex.SetDirection(tview.FlexRow)
mainFlex.AddItem(flexTop, 0, 2, false)
mainFlex.AddItem(frameworkLogPane, 0, 1, false)
mainFlex.AddItem(cmdInput, 1, 0, true)
go connectAndMonitor("127.0.0.1:8080")
go startUDPListener(8081)
if err := app.SetRoot(mainFlex, true).EnableMouse(true).Run(); err != nil {
panic(err)
}
}
Binary file not shown.
+16
View File
@@ -0,0 +1,16 @@
BINARY := marte2-web-client
GIT_HASH := $(shell git rev-parse --short HEAD 2>/dev/null || echo unknown)
TIMESTAMP := $(shell date -u +%Y%m%d-%H%M%S)
VERSION := $(GIT_HASH)-$(TIMESTAMP)
LDFLAGS := -X main.buildVersion=$(VERSION)
.PHONY: all build clean
all: build
build:
CGO_ENABLED=0 go build -ldflags "$(LDFLAGS)" -o $(BINARY) .
clean:
rm -f $(BINARY)
+7
View File
@@ -0,0 +1,7 @@
module marte2-web-client
go 1.21
require github.com/gorilla/websocket v1.5.1
require golang.org/x/net v0.17.0 // indirect
+4
View File
@@ -0,0 +1,4 @@
github.com/gorilla/websocket v1.5.1 h1:gmztn0JnHVt9JZquRuzLw3g4wouNVzKL15iLr/zn/QY=
github.com/gorilla/websocket v1.5.1/go.mod h1:x3kM2JMyaluk02fnUJpQuwD2dCS5NDG2ZHL0uE0tcaY=
golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM=
golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE=
+245
View File
@@ -0,0 +1,245 @@
package main
import (
"embed"
"encoding/json"
"flag"
"io/fs"
"log"
"net/http"
"sync"
"time"
"github.com/gorilla/websocket"
)
// buildVersion is injected at link time:
//
// go build -ldflags "-X main.buildVersion=$(git rev-parse --short HEAD)"
var buildVersion = "dev"
//go:embed static
var staticFiles embed.FS
var upgrader = websocket.Upgrader{
CheckOrigin: func(r *http.Request) bool { return true },
}
// ---------------------------------------------------------------------------
// Wire message types
// ---------------------------------------------------------------------------
type InMsg struct {
Type string `json:"type"`
Data json.RawMessage `json:"data,omitempty"`
}
type ConnectData struct {
Host string `json:"host"`
Port int `json:"port"`
UDPPort int `json:"udp_port"`
LogPort int `json:"log_port"`
}
type CmdData struct {
Cmd string `json:"cmd"`
}
// ---------------------------------------------------------------------------
// Hub fan-out WS messages to all connected browsers
// ---------------------------------------------------------------------------
type Hub struct {
mu sync.RWMutex
clients map[*WSClient]struct{}
marte *MarteClient
}
func newHub() *Hub {
return &Hub{clients: make(map[*WSClient]struct{})}
}
func (h *Hub) add(c *WSClient) {
h.mu.Lock()
h.clients[c] = struct{}{}
h.mu.Unlock()
}
func (h *Hub) remove(c *WSClient) {
h.mu.Lock()
delete(h.clients, c)
h.mu.Unlock()
}
func (h *Hub) broadcast(msg []byte) {
h.mu.RLock()
defer h.mu.RUnlock()
for c := range h.clients {
select {
case c.send <- msg:
default:
}
}
}
// ---------------------------------------------------------------------------
// WSClient one browser tab
// ---------------------------------------------------------------------------
type WSClient struct {
hub *Hub
conn *websocket.Conn
send chan []byte
}
func (c *WSClient) writePump() {
ticker := time.NewTicker(30 * time.Second)
defer func() {
ticker.Stop()
c.conn.Close()
}()
for {
select {
case msg, ok := <-c.send:
c.conn.SetWriteDeadline(time.Now().Add(10 * time.Second))
if !ok {
c.conn.WriteMessage(websocket.CloseMessage, []byte{})
return
}
if err := c.conn.WriteMessage(websocket.TextMessage, msg); err != nil {
return
}
case <-ticker.C:
c.conn.SetWriteDeadline(time.Now().Add(10 * time.Second))
if err := c.conn.WriteMessage(websocket.PingMessage, nil); err != nil {
return
}
}
}
}
func (c *WSClient) readPump() {
defer func() {
c.hub.remove(c)
c.conn.Close()
}()
c.conn.SetReadLimit(256 * 1024)
c.conn.SetReadDeadline(time.Now().Add(60 * time.Second))
c.conn.SetPongHandler(func(string) error {
c.conn.SetReadDeadline(time.Now().Add(60 * time.Second))
return nil
})
for {
_, raw, err := c.conn.ReadMessage()
if err != nil {
break
}
c.conn.SetReadDeadline(time.Now().Add(60 * time.Second))
var in InMsg
if err := json.Unmarshal(raw, &in); err != nil {
continue
}
c.handleIncoming(in)
}
}
func (c *WSClient) handleIncoming(in InMsg) {
m := c.hub.marte
switch in.Type {
case "connect":
var d ConnectData
if err := json.Unmarshal(in.Data, &d); err != nil {
return
}
if d.Host == "" {
d.Host = "127.0.0.1"
}
if d.Port == 0 {
d.Port = 8080
}
if d.UDPPort == 0 {
d.UDPPort = 8081
}
if d.LogPort == 0 {
d.LogPort = 8082
}
log.Printf("[WS] connect request host=%s cmd=%d udp=%d log=%d",
d.Host, d.Port, d.UDPPort, d.LogPort)
m.Connect(d.Host, d.Port, d.UDPPort, d.LogPort)
case "disconnect":
log.Printf("[WS] disconnect request")
m.Disconnect()
case "cmd":
var d CmdData
if err := json.Unmarshal(in.Data, &d); err != nil {
return
}
m.SendCommand(d.Cmd)
}
}
// ---------------------------------------------------------------------------
// HTTP handler
// ---------------------------------------------------------------------------
func wsHandler(hub *Hub, w http.ResponseWriter, r *http.Request) {
conn, err := upgrader.Upgrade(w, r, nil)
if err != nil {
log.Println("upgrade:", err)
return
}
c := &WSClient{hub: hub, conn: conn, send: make(chan []byte, 256)}
hub.add(c)
// Send current connection status to newly joined client.
if hub.marte.IsConnected() {
b, _ := json.Marshal(map[string]any{"type": "connected"})
c.send <- b
// Also push current signal list if already discovered.
hub.marte.SendCachedState(c)
}
go c.writePump()
c.readPump() // blocks until client disconnects
}
// ---------------------------------------------------------------------------
// main
// ---------------------------------------------------------------------------
func main() {
addr := flag.String("addr", ":7777", "HTTP listen address")
flag.Parse()
hub := newHub()
hub.marte = newMarteClient(hub)
sub, err := fs.Sub(staticFiles, "static")
if err != nil {
log.Fatal(err)
}
fileServer := http.FileServer(http.FS(sub))
http.HandleFunc("/ws", func(w http.ResponseWriter, r *http.Request) {
wsHandler(hub, w, r)
})
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
// Serve index.html for the root path explicitly.
if r.URL.Path == "/" {
data, err := staticFiles.ReadFile("static/index.html")
if err != nil {
http.Error(w, "not found", http.StatusNotFound)
return
}
w.Header().Set("Content-Type", "text/html; charset=utf-8")
w.Write(data)
return
}
fileServer.ServeHTTP(w, r)
})
log.Printf("MARTe2 Web Debug Client build=%s listening on %s", buildVersion, *addr)
log.Fatal(http.ListenAndServe(*addr, nil))
}
Binary file not shown.
+681
View File
@@ -0,0 +1,681 @@
package main
import (
"bufio"
"encoding/binary"
"encoding/json"
"fmt"
"log"
"math"
"net"
"strings"
"sync"
"sync/atomic"
"time"
)
// ---------------------------------------------------------------------------
// Signal metadata (populated by DISCOVER)
// ---------------------------------------------------------------------------
type SignalMeta struct {
Name string `json:"name"`
ID uint32 `json:"id"`
Type string `json:"type"`
Dimensions uint8 `json:"dimensions"`
Elements uint32 `json:"elements"`
Names []string // canonical + alias names mapping to this ID
}
// ---------------------------------------------------------------------------
// Outbound WS message helpers
// ---------------------------------------------------------------------------
type TelemetrySample struct {
ID uint32 `json:"id"`
Names []string `json:"names"`
Ts float64 `json:"ts"`
Values []float64 `json:"values"`
}
func broadcast(hub *Hub, v any) {
b, err := json.Marshal(v)
if err != nil {
return
}
hub.broadcast(b)
}
// ---------------------------------------------------------------------------
// MarteClient
// ---------------------------------------------------------------------------
type MarteClient struct {
hub *Hub
mu sync.Mutex
tcpConn net.Conn
writer *bufio.Writer
cmdMu sync.Mutex // serialise TCP writes
sigMu sync.RWMutex
signals map[uint32]*SignalMeta // id -> meta
baseTs uint64
baseTsSet bool
basesMu sync.Mutex
connected int32 // atomic bool
lastWriteMs int64 // atomic; updated on every TCP write, used by keepalive
stopCh chan struct{}
// accumulates signals across DISCOVER_PART chunks; merged on final DISCOVER
discoverAcc []discoverSignalJSON
// cached last-known ports (updated by SERVICE_INFO)
host string
cmdPort int
udpPort int
logPort int
}
func newMarteClient(hub *Hub) *MarteClient {
return &MarteClient{
hub: hub,
signals: make(map[uint32]*SignalMeta),
stopCh: make(chan struct{}),
}
}
func (m *MarteClient) IsConnected() bool {
return atomic.LoadInt32(&m.connected) == 1
}
// SendCachedState sends the current signal list to a freshly connected browser.
func (m *MarteClient) SendCachedState(c *WSClient) {
m.sigMu.RLock()
defer m.sigMu.RUnlock()
if len(m.signals) == 0 {
return
}
sigs := make([]*SignalMeta, 0, len(m.signals))
for _, s := range m.signals {
sigs = append(sigs, s)
}
b, _ := json.Marshal(map[string]any{"type": "signal_cache", "signals": sigs})
select {
case c.send <- b:
default:
}
}
// ---------------------------------------------------------------------------
// Connect / Disconnect
// ---------------------------------------------------------------------------
func (m *MarteClient) Connect(host string, cmdPort, udpPort, logPort int) {
m.Disconnect()
m.mu.Lock()
m.host = host
m.cmdPort = cmdPort
m.udpPort = udpPort
m.logPort = logPort
m.stopCh = make(chan struct{})
m.mu.Unlock()
go m.runTCP(host, cmdPort)
go m.runUDP(host, udpPort)
go m.runLog(host, logPort)
}
func (m *MarteClient) Disconnect() {
m.mu.Lock()
select {
case <-m.stopCh:
// already closed
default:
close(m.stopCh)
}
if m.tcpConn != nil {
m.tcpConn.Close()
m.tcpConn = nil
}
m.mu.Unlock()
atomic.StoreInt32(&m.connected, 0)
m.basesMu.Lock()
m.baseTsSet = false
m.basesMu.Unlock()
m.discoverAcc = nil
}
func (m *MarteClient) stopped() bool {
select {
case <-m.stopCh:
return true
default:
return false
}
}
// ---------------------------------------------------------------------------
// TCP command channel
// ---------------------------------------------------------------------------
func (m *MarteClient) runTCP(host string, port int) {
addr := fmt.Sprintf("%s:%d", host, port)
for !m.stopped() {
conn, err := net.DialTimeout("tcp", addr, 5*time.Second)
if err != nil {
time.Sleep(2 * time.Second)
continue
}
conn.(*net.TCPConn).SetNoDelay(true)
m.mu.Lock()
m.tcpConn = conn
m.writer = bufio.NewWriter(conn)
m.mu.Unlock()
atomic.StoreInt32(&m.connected, 1)
broadcast(m.hub, map[string]any{"type": "connected"})
// Send SERVICE_INFO to auto-discover ports
m.writeCmd("SERVICE_INFO")
go m.runKeepalive()
m.readLoop(conn)
atomic.StoreInt32(&m.connected, 0)
broadcast(m.hub, map[string]any{"type": "disconnected"})
m.mu.Lock()
m.tcpConn = nil
m.writer = nil
m.mu.Unlock()
if !m.stopped() {
time.Sleep(2 * time.Second)
}
}
}
func (m *MarteClient) writeCmd(cmd string) {
m.cmdMu.Lock()
defer m.cmdMu.Unlock()
m.mu.Lock()
w := m.writer
m.mu.Unlock()
if w == nil {
return
}
log.Printf("[→MARTe] %s", cmd)
broadcast(m.hub, map[string]any{
"type": "log", "time": time.Now().Format("15:04:05.000"),
"level": "CMD", "message": fmt.Sprintf("→ %s", cmd),
})
w.WriteString(cmd + "\n")
w.Flush()
atomic.StoreInt64(&m.lastWriteMs, time.Now().UnixMilli())
}
// runKeepalive sends INFO every 20 s when no other command has been written
// in the last 20 s, keeping the DebugService 30 s idle timer from firing.
func (m *MarteClient) runKeepalive() {
ticker := time.NewTicker(20 * time.Second)
defer ticker.Stop()
for {
select {
case <-m.stopCh:
return
case <-ticker.C:
if !m.IsConnected() {
continue
}
idleMs := time.Now().UnixMilli() - atomic.LoadInt64(&m.lastWriteMs)
if idleMs >= 20_000 {
m.writeCmd("INFO")
}
}
}
}
func (m *MarteClient) SendCommand(cmd string) {
m.writeCmd(cmd)
}
func (m *MarteClient) readLoop(conn net.Conn) {
scanner := bufio.NewScanner(conn)
scanner.Buffer(make([]byte, 8*1024*1024), 8*1024*1024)
var jsonAcc strings.Builder
inJSON := false
for scanner.Scan() {
if m.stopped() {
return
}
line := scanner.Text()
trimmed := strings.TrimSpace(line)
if trimmed == "" {
continue
}
// Detect start of JSON block
if !inJSON && strings.HasPrefix(trimmed, "{") {
inJSON = true
jsonAcc.Reset()
}
if inJSON {
jsonAcc.WriteString(trimmed)
tag, done := detectJSONDone(trimmed)
if done {
inJSON = false
raw := jsonAcc.String()
// Strip trailing sentinel
idx := strings.Index(raw, "OK "+tag)
if idx >= 0 {
raw = strings.TrimSpace(raw[:idx])
}
m.handleJSONResponse(tag, raw)
jsonAcc.Reset()
}
} else {
m.handleTextLine(trimmed)
}
}
}
// detectJSONDone returns (tag, true) when the line is exactly "OK <TAG>".
// DISCOVER_PART must appear before DISCOVER so partial chunks are not mistaken
// for the final chunk (though with exact matching this is not strictly
// necessary; kept for clarity).
func detectJSONDone(line string) (string, bool) {
tags := []string{
"DISCOVER_PART", "DISCOVER", "TREE", "INFO", "CONFIG", "STEP_STATUS",
"VALUE", "MSG", "TRACE", "FORCE", "UNFORCE", "BREAK",
"PAUSE", "RESUME", "STEP", "MONITOR", "UNMONITOR", "LS",
}
for _, t := range tags {
if line == "OK "+t {
return t, true
}
}
return "", false
}
func (m *MarteClient) handleJSONResponse(tag, data string) {
log.Printf("[←MARTe] %s %d bytes", tag, len(data))
broadcast(m.hub, map[string]any{
"type": "log", "time": time.Now().Format("15:04:05.000"),
"level": "RESP", "message": fmt.Sprintf("← %s (%d B)", tag, len(data)),
})
switch tag {
case "DISCOVER_PART":
// Accumulate this chunk; do NOT broadcast — we wait for the final chunk.
var resp discoverResp
if err := json.Unmarshal([]byte(data), &resp); err != nil {
log.Printf("[DISCOVER_PART] parse error: %v", err)
return
}
m.discoverAcc = append(m.discoverAcc, resp.Signals...)
log.Printf("[DISCOVER_PART] accumulated %d signals (total so far: %d)",
len(resp.Signals), len(m.discoverAcc))
return
case "DISCOVER":
// Merge any previously accumulated part-chunks with this final chunk.
var resp discoverResp
if err := json.Unmarshal([]byte(data), &resp); err != nil {
log.Printf("[DISCOVER] parse error: %v", err)
return
}
all := append(m.discoverAcc, resp.Signals...)
m.discoverAcc = nil
m.parseDiscoverSignals(all)
// Re-marshal the merged list so the browser gets a single consistent blob.
merged, _ := json.Marshal(discoverResp{Signals: all})
broadcast(m.hub, map[string]any{
"type": "response", "tag": "DISCOVER", "data": string(merged),
})
return
case "TREE":
// Per-node response — forward to browser as-is.
broadcast(m.hub, map[string]any{
"type": "tree_node",
"data": data,
})
return
}
broadcast(m.hub, map[string]any{
"type": "response",
"tag": tag,
"data": data,
})
}
func (m *MarteClient) handleTextLine(line string) {
if strings.HasPrefix(line, "OK SERVICE_INFO") {
// OK SERVICE_INFO TCP_CTRL:8110 UDP_STREAM:8111 TCP_LOG:8082 STATE:RUNNING
parts := strings.Fields(line)
newUDP, newLog := 0, 0
for _, p := range parts {
if strings.HasPrefix(p, "UDP_STREAM:") {
fmt.Sscanf(p[11:], "%d", &newUDP)
}
if strings.HasPrefix(p, "TCP_LOG:") {
fmt.Sscanf(p[8:], "%d", &newLog)
}
}
// Always forward as a response so the browser can display it.
broadcast(m.hub, map[string]any{
"type": "response",
"tag": "SERVICE_INFO",
"data": line[len("OK SERVICE_INFO "):],
})
if newUDP > 0 || newLog > 0 {
broadcast(m.hub, map[string]any{
"type": "service_config",
"udp_port": newUDP,
"log_port": newLog,
})
// Restart UDP/log workers with updated ports if they differ
m.mu.Lock()
host := m.host
oldUDP := m.udpPort
oldLog := m.logPort
if newUDP > 0 {
m.udpPort = newUDP
}
if newLog > 0 {
m.logPort = newLog
}
m.mu.Unlock()
if newUDP > 0 && newUDP != oldUDP {
go m.runUDP(host, newUDP)
}
if newLog > 0 && newLog != oldLog {
go m.runLog(host, newLog)
}
}
}
// Forward all text lines to browsers.
broadcast(m.hub, map[string]any{
"type": "text_line",
"data": line,
})
}
// ---------------------------------------------------------------------------
// DISCOVER parsing
// ---------------------------------------------------------------------------
type discoverSignalJSON struct {
Name string `json:"name"`
ID uint32 `json:"id"`
Type string `json:"type"`
Dimensions uint8 `json:"dimensions"`
Elements uint32 `json:"elements"`
}
type discoverResp struct {
Signals []discoverSignalJSON `json:"Signals"`
}
func (m *MarteClient) parseDiscoverSignals(sigs []discoverSignalJSON) {
m.sigMu.Lock()
defer m.sigMu.Unlock()
m.signals = make(map[uint32]*SignalMeta, len(sigs))
for _, s := range sigs {
el := s.Elements
if el == 0 {
el = 1
}
// Multiple DISCOVER entries can share the same ID (canonical DataSource
// path + one GAM alias per broker). Merge them into one SignalMeta so
// that Names carries every alias. This is required for the telemetry
// receiver to match whichever name the user traced.
if existing, ok := m.signals[s.ID]; ok {
existing.Names = append(existing.Names, s.Name)
continue
}
meta := &SignalMeta{
Name: s.Name,
ID: s.ID,
Type: s.Type,
Dimensions: s.Dimensions,
Elements: el,
Names: []string{s.Name},
}
m.signals[s.ID] = meta
}
log.Printf("[DISCOVER] registered %d unique signals from %d entries", len(m.signals), len(sigs))
}
// ---------------------------------------------------------------------------
// UDP telemetry
// ---------------------------------------------------------------------------
const udpMagic uint32 = 0xDA7A57AD
func (m *MarteClient) runUDP(host string, port int) {
addr := fmt.Sprintf("0.0.0.0:%d", port)
udpAddr, err := net.ResolveUDPAddr("udp4", addr)
if err != nil {
return
}
conn, err := net.ListenUDP("udp4", udpAddr)
if err != nil {
return
}
defer conn.Close()
conn.SetReadBuffer(10 * 1024 * 1024)
conn.SetReadDeadline(time.Now().Add(500 * time.Millisecond))
buf := make([]byte, 65535)
var lastSeq uint32
var hasLastSeq bool
var totalPkts uint64
var dropped uint64
for !m.stopped() {
conn.SetReadDeadline(time.Now().Add(500 * time.Millisecond))
n, _, err := conn.ReadFromUDP(buf)
if err != nil {
continue
}
if n < 20 {
continue
}
if binary.LittleEndian.Uint32(buf[0:4]) != udpMagic {
continue
}
seq := binary.LittleEndian.Uint32(buf[4:8])
if hasLastSeq && seq > lastSeq+1 {
dropped += uint64(seq - lastSeq - 1)
}
lastSeq = seq
hasLastSeq = true
totalPkts++
if totalPkts%500 == 0 {
broadcast(m.hub, map[string]any{
"type": "udp_stats",
"packets": totalPkts,
"dropped": dropped,
})
}
count := binary.LittleEndian.Uint32(buf[16:20])
offset := 20
// Resolve base timestamp once per packet.
m.basesMu.Lock()
if !m.baseTsSet && n >= 20+12 {
m.baseTs = binary.LittleEndian.Uint64(buf[20+4 : 20+12])
m.baseTsSet = true
}
baseTs := m.baseTs
baseTsSet := m.baseTsSet
m.basesMu.Unlock()
m.sigMu.RLock()
samples := make([]TelemetrySample, 0, count)
for i := uint32(0); i < count; i++ {
if offset+16 > n {
break
}
id := binary.LittleEndian.Uint32(buf[offset : offset+4])
tsRaw := binary.LittleEndian.Uint64(buf[offset+4 : offset+12])
size := binary.LittleEndian.Uint32(buf[offset+12 : offset+16])
offset += 16
if offset+int(size) > n {
break
}
dataSlice := buf[offset : offset+int(size)]
offset += int(size)
tsS := 0.0
if baseTsSet && tsRaw >= baseTs {
tsS = float64(tsRaw-baseTs) / 1_000_000.0
}
meta, ok := m.signals[id]
if !ok {
continue
}
elements := meta.Elements
if elements == 0 {
elements = 1
}
typeSize := uint32(size)
if elements > 0 {
typeSize = uint32(size) / elements
}
vals := make([]float64, 0, elements)
t := meta.Type
for e := uint32(0); e < elements; e++ {
off := e * typeSize
if off+typeSize > uint32(len(dataSlice)) {
break
}
elem := dataSlice[off : off+typeSize]
vals = append(vals, parseTypedValue(elem, typeSize, t))
}
samples = append(samples, TelemetrySample{
ID: id,
Names: meta.Names,
Ts: tsS,
Values: vals,
})
}
m.sigMu.RUnlock()
if len(samples) > 0 {
broadcast(m.hub, map[string]any{
"type": "telemetry",
"seq": seq,
"signals": samples,
})
}
}
}
func parseTypedValue(data []byte, size uint32, t string) float64 {
switch size {
case 1:
if strings.Contains(t, "u") {
return float64(data[0])
}
return float64(int8(data[0]))
case 2:
if len(data) < 2 {
return 0
}
v := binary.LittleEndian.Uint16(data[:2])
if strings.Contains(t, "u") {
return float64(v)
}
return float64(int16(v))
case 4:
if len(data) < 4 {
return 0
}
v := binary.LittleEndian.Uint32(data[:4])
if strings.Contains(t, "float") || strings.Contains(t, "float32") {
return float64(math.Float32frombits(v))
}
if strings.Contains(t, "u") {
return float64(v)
}
return float64(int32(v))
case 8:
if len(data) < 8 {
return 0
}
v := binary.LittleEndian.Uint64(data[:8])
if strings.Contains(t, "float") || strings.Contains(t, "float64") || strings.Contains(t, "double") {
return math.Float64frombits(v)
}
if strings.Contains(t, "u") {
return float64(v)
}
return float64(int64(v))
}
return 0
}
// ---------------------------------------------------------------------------
// TCP log channel
// ---------------------------------------------------------------------------
func (m *MarteClient) runLog(host string, port int) {
addr := fmt.Sprintf("%s:%d", host, port)
for !m.stopped() {
conn, err := net.DialTimeout("tcp", addr, 5*time.Second)
if err != nil {
time.Sleep(2 * time.Second)
continue
}
scanner := bufio.NewScanner(conn)
for scanner.Scan() {
if m.stopped() {
conn.Close()
return
}
line := strings.TrimSpace(scanner.Text())
if strings.HasPrefix(line, "LOG ") {
rest := line[4:]
idx := strings.Index(rest, " ")
if idx < 0 {
continue
}
level := rest[:idx]
msg := rest[idx+1:]
broadcast(m.hub, map[string]any{
"type": "log",
"time": time.Now().Format("15:04:05.000"),
"level": level,
"message": msg,
})
}
}
conn.Close()
if !m.stopped() {
time.Sleep(2 * time.Second)
}
}
}
File diff suppressed because it is too large Load Diff
+13
View File
@@ -0,0 +1,13 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
<rect width="32" height="32" rx="5" fill="#1e1e2e"/>
<!-- oscilloscope grid lines -->
<line x1="2" y1="16" x2="30" y2="16" stroke="#313244" stroke-width="0.8"/>
<line x1="16" y1="3" x2="16" y2="29" stroke="#313244" stroke-width="0.8"/>
<!-- waveform -->
<polyline points="2,16 7,16 9,7 12,25 16,7 20,25 23,16 25,16 27,11 30,11"
fill="none" stroke="#89b4fa" stroke-width="2"
stroke-linejoin="round" stroke-linecap="round"/>
<!-- scope bezel -->
<rect x="1" y="1" width="30" height="30" rx="4"
fill="none" stroke="#45475a" stroke-width="1.5"/>
</svg>

After

Width:  |  Height:  |  Size: 638 B

+503
View File
@@ -0,0 +1,503 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>MARTe2 Debug Client</title>
<link rel="icon" type="image/svg+xml" href="favicon.svg">
<link rel="stylesheet" href="uplot.min.css">
<style>
*{box-sizing:border-box;margin:0;padding:0}
html,body{height:100%;overflow:hidden;font-family:'Segoe UI',system-ui,sans-serif;font-size:12px;background:#1e1e2e;color:#cdd6f4}
/* ── layout ── */
#app{display:flex;flex-direction:column;height:100vh}
#toolbar{display:flex;align-items:center;gap:6px;padding:4px 8px;background:#181825;border-bottom:1px solid #313244;flex-shrink:0;flex-wrap:wrap}
#main{display:flex;flex:1;overflow:hidden}
#left-panel{width:240px;flex-shrink:0;display:flex;flex-direction:column;border-right:1px solid #313244;overflow:hidden}
#center-panel{flex:1;overflow:hidden;display:flex;flex-direction:column;gap:6px;padding:6px}
#right-panel{width:260px;flex-shrink:0;display:flex;flex-direction:column;border-left:1px solid #313244;overflow:hidden}
#log-panel{height:160px;flex-shrink:0;border-top:1px solid #313244;display:flex;flex-direction:column;overflow:hidden}
/* ── toolbar ── */
.tb-group{display:flex;align-items:center;gap:4px;padding:0 6px;border-right:1px solid #313244}
.tb-group:last-child{border-right:none}
input[type=text],input[type=number]{background:#313244;border:1px solid #45475a;color:#cdd6f4;padding:2px 6px;border-radius:4px;width:100px}
input[type=number]{width:60px}
button{background:#313244;border:1px solid #45475a;color:#cdd6f4;padding:2px 8px;border-radius:4px;cursor:pointer;white-space:nowrap}
button:hover{background:#45475a}
button.active{background:#89b4fa;color:#1e1e2e;border-color:#89b4fa}
button.danger{background:#f38ba8;color:#1e1e2e;border-color:#f38ba8}
button.warn{background:#fab387;color:#1e1e2e;border-color:#fab387}
button.ok{background:#a6e3a1;color:#1e1e2e;border-color:#a6e3a1}
label{color:#a6adc8;user-select:none}
#conn-status{width:8px;height:8px;border-radius:50%;background:#f38ba8;display:inline-block;flex-shrink:0;vertical-align:middle}
#conn-status.ok{background:#a6e3a1}
#udp-stats{color:#585b70;font-size:11px;margin-left:4px}
/* ── dropdown menus ── */
.menu-wrap{position:relative}
.dropdown{position:absolute;top:calc(100% + 4px);left:0;z-index:200;background:#1e1e2e;border:1px solid #45475a;border-radius:6px;padding:8px;min-width:260px;display:none;flex-direction:column;gap:6px;box-shadow:0 4px 16px rgba(0,0,0,.5)}
.dropdown.open{display:flex}
.menu-sep{border:none;border-top:1px solid #313244;margin:2px 0}
.menu-row{display:flex;gap:6px;align-items:center}
.menu-row input[type=text]{flex:1;min-width:0;width:auto}
.menu-row input[type=number]{width:64px}
.menu-btn-row{display:flex;gap:6px}
.menu-btn-row button{flex:1}
/* ── panels ── */
.panel-header{padding:4px 8px;background:#181825;border-bottom:1px solid #313244;font-weight:600;color:#89b4fa;display:flex;align-items:center;justify-content:space-between;flex-shrink:0}
.panel-search{padding:4px;border-bottom:1px solid #313244;flex-shrink:0}
.panel-search input{width:100%;background:#313244;border:1px solid #45475a;color:#cdd6f4;padding:3px 6px;border-radius:4px}
.panel-body{flex:1;overflow-y:auto}
.panel-toggle{background:transparent;border:none;color:#585b70;cursor:pointer;padding:0 2px;font-size:11px;line-height:1}
.panel-toggle:hover{color:#cdd6f4;background:transparent}
/* ── collapsible panels ── */
#left-panel{transition:width .15s;position:relative}
#left-panel.collapsed{width:0!important;border:none;overflow:hidden}
#right-panel{transition:width .15s;position:relative}
#right-panel.collapsed{width:0!important;border:none;overflow:hidden}
#log-panel{transition:height .15s}
#log-panel.collapsed{height:28px;overflow:hidden}
/* collapse/resize strips */
.panel-strip{width:6px;flex-shrink:0;display:flex;align-items:center;justify-content:center;cursor:col-resize;background:#181825;border:none;color:#585b70;font-size:9px;user-select:none;position:relative}
.panel-strip::after{content:'';position:absolute;top:50%;left:50%;transform:translate(-50%,-50%);width:2px;height:32px;background:#45475a;border-radius:1px;pointer-events:none}
.panel-strip:hover{background:#313244}
.panel-strip:hover::after{background:#89b4fa}
#left-strip{border-right:1px solid #313244}
#right-strip{border-left:1px solid #313244}
/* ── tree ── */
.tree-node{padding:1px 0}
.tree-leaf{display:flex;align-items:center;gap:2px;padding:1px 4px;cursor:default;user-select:none}
.tree-leaf:hover{background:#313244}
.tree-leaf.selected{background:#45475a}
.tree-name{flex:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}
.tree-class{color:#585b70;font-size:10px;flex-shrink:0}
details>summary{list-style:none;cursor:pointer;padding:1px 4px;display:flex;align-items:center;gap:4px;user-select:none}
details>summary:hover{background:#313244}
details>summary::before{content:'▶';font-size:9px;color:#585b70;width:10px;flex-shrink:0}
details[open]>summary::before{content:'▼'}
details>.children{padding-left:14px}
.tree-loading{padding:2px 4px;color:#585b70;font-size:10px;font-style:italic}
.tree-btn{background:transparent;border:1px solid #45475a;color:#a6adc8;padding:0 4px;border-radius:3px;cursor:pointer;font-size:10px;line-height:14px}
.tree-btn:hover{background:#45475a;color:#cdd6f4}
.tree-btn.t{border-color:#89b4fa;color:#89b4fa}
.tree-btn.f{border-color:#a6e3a1;color:#a6e3a1}
.tree-btn.b{border-color:#fab387;color:#fab387}
/* ── right panel tabs ── */
.tabs{display:flex;border-bottom:1px solid #313244;flex-shrink:0}
.tab{flex:1;padding:4px;text-align:center;cursor:pointer;color:#585b70;border-bottom:2px solid transparent}
.tab.active{color:#89b4fa;border-bottom-color:#89b4fa}
.tab-content{display:none;flex:1;overflow-y:auto;flex-direction:column}
.tab-content.active{display:flex}
/* ── signal items (right panel) ── */
.sig-item{display:flex;align-items:center;gap:4px;padding:3px 6px;border-bottom:1px solid #181825}
.sig-item:hover{background:#313244}
.sig-name{flex:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-size:11px}
.sig-val{color:#a6e3a1;font-size:11px;min-width:60px;text-align:right;font-family:monospace}
.sig-dot{width:8px;height:8px;border-radius:50%;flex-shrink:0}
/* ── plots ── */
.plot-card{background:#181825;border:1px solid #313244;border-radius:6px;overflow:hidden;flex:1;min-height:160px;display:flex;flex-direction:column}
.plot-card.drop-active{border-color:#89b4fa}
.plot-header{display:flex;align-items:center;gap:6px;padding:4px 8px;background:#11111b;border-bottom:1px solid #313244;flex-shrink:0}
.plot-title{font-weight:600;color:#89b4fa;flex:1}
.plot-series-bar{display:flex;flex-wrap:wrap;gap:4px;padding:3px 8px;background:#11111b;border-bottom:1px solid #313244;flex-shrink:0}
.plot-series-bar:empty{display:none;padding:0;border:none}
.series-chip{display:inline-flex;align-items:center;gap:3px;background:#1e1e2e;border:1px solid #45475a;border-radius:10px;padding:1px 3px 1px 6px;font-size:10px}
.series-chip-dot{width:7px;height:7px;border-radius:50%;flex-shrink:0}
.series-chip-name{max-width:130px;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;color:#cdd6f4}
.series-chip-rm{background:transparent;border:none;color:#585b70;cursor:pointer;padding:0 2px;font-size:12px;line-height:1}
.series-chip-rm:hover{color:#f38ba8;background:transparent}
.plot-drop{flex:1;display:flex;align-items:center;justify-content:center;color:#45475a;border:2px dashed #313244;margin:8px;border-radius:4px}
.plot-drop.over{border-color:#89b4fa;color:#89b4fa}
.uplot-wrap{flex:1;min-height:0;padding:2px 4px 4px;display:flex;flex-direction:column}
/* ── logs ── */
#log-toolbar{display:flex;align-items:center;gap:6px;padding:3px 8px;background:#181825;border-bottom:1px solid #313244;flex-shrink:0}
#log-body{flex:1;overflow-y:auto;font-family:monospace;font-size:11px;padding:2px 0}
.log-line{padding:1px 8px;display:flex;gap:8px}
.log-time{color:#585b70;flex-shrink:0}
.log-lvl{flex-shrink:0;min-width:50px;font-weight:600}
.log-msg{overflow:hidden;text-overflow:ellipsis;white-space:nowrap;flex:1}
.log-line.DEBUG .log-lvl{color:#89b4fa}
.log-line.INFO .log-lvl{color:#a6e3a1}
.log-line.WARNING .log-lvl{color:#fab387}
.log-line.ERROR,.log-line.FatalError,.log-line.FATAL{background:#2d1b1b}
.log-line.ERROR .log-lvl,.log-line.FatalError .log-lvl,.log-line.FATAL .log-lvl{color:#f38ba8}
.log-hidden{display:none}
/* ── dialogs ── */
.dialog-overlay{position:fixed;inset:0;background:rgba(0,0,0,.6);display:flex;align-items:center;justify-content:center;z-index:100}
.dialog{background:#1e1e2e;border:1px solid #45475a;border-radius:8px;padding:16px;min-width:320px;max-width:500px}
.dialog h3{margin-bottom:12px;color:#89b4fa}
.dialog label{display:block;margin-bottom:4px;color:#a6adc8}
.dialog input,.dialog select,.dialog textarea{width:100%;background:#313244;border:1px solid #45475a;color:#cdd6f4;padding:4px 8px;border-radius:4px;margin-bottom:10px}
.dialog textarea{height:80px;resize:vertical;font-family:monospace}
.dialog .btns{display:flex;gap:8px;justify-content:flex-end;margin-top:4px}
.dialog select option{background:#1e1e2e}
.form-row{display:flex;gap:8px}
.form-row>*{flex:1}
.form-check{display:flex;align-items:center;gap:8px;margin-bottom:10px}
.form-check input[type=checkbox]{width:auto;margin:0}
.form-check label{margin:0;color:#a6adc8}
/* ── step status bar ── */
#step-bar{background:#2d2b45;border-bottom:1px solid #313244;padding:4px 8px;display:none;align-items:center;gap:8px;flex-shrink:0}
#step-bar.visible{display:flex}
/* ── scrollbars ── */
::-webkit-scrollbar{width:6px;height:6px}
::-webkit-scrollbar-track{background:#181825}
::-webkit-scrollbar-thumb{background:#45475a;border-radius:3px}
::-webkit-scrollbar-thumb:hover{background:#585b70}
/* ── grouped array signal in trace list ── */
.sig-group{display:flex;align-items:center;gap:4px;padding:3px 6px;border-bottom:1px solid #1e1e2e;user-select:none;cursor:grab}
.sig-group:hover{background:#313244}
.sig-group-exp{color:#585b70;font-size:10px;width:14px;text-align:center;flex-shrink:0;cursor:pointer}
.sig-group-exp:hover{color:#89b4fa}
.sig-item-sub{padding-left:24px;background:#11111b;border-left:2px solid #313244;margin-left:2px}
.sig-item-sub:hover{background:#1e1e2e}
/* ── array selection toggle ── */
.arr-seg{display:flex;gap:0;margin-bottom:12px;border-radius:4px;overflow:hidden;border:1px solid #45475a}
.arr-seg button{flex:1;border:none;border-radius:0;border-right:1px solid #45475a;color:#a6adc8;background:#313244;padding:4px 0;font-size:11px}
.arr-seg button:last-child{border-right:none}
.arr-seg button.active{background:#89b4fa;color:#1e1e2e}
.arr-seg button:hover:not(.active){background:#45475a;color:#cdd6f4}
/* ── misc ── */
.empty-hint{padding:16px;color:#45475a;text-align:center}
.break-item{padding:3px 6px;border-bottom:1px solid #181825;display:flex;align-items:center;gap:4px;font-size:11px}
.break-sig{flex:1;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;color:#fab387}
.msg-item{padding:3px 6px;border-bottom:1px solid #181825;font-size:11px}
.msg-status{width:14px;text-align:center;flex-shrink:0}
select{background:#313244;border:1px solid #45475a;color:#cdd6f4;padding:2px 4px;border-radius:4px}
</style>
</head>
<body>
<div id="app">
<!-- ═══ TOOLBAR ═══ -->
<div id="toolbar">
<!-- Connection menu -->
<div class="menu-wrap tb-group">
<button id="conn-menu-btn" onclick="toggleMenu('conn-dropdown')">
<span id="conn-status"></span>
Connection ▾
</button>
<div class="dropdown" id="conn-dropdown">
<div class="menu-row">
<input type="text" id="host" value="127.0.0.1" placeholder="host" style="flex:2">
<input type="number" id="port" value="8080" placeholder="ctrl" style="width:60px">
<button id="btn-connect" onclick="toggleConnect()">Connect</button>
</div>
<div class="menu-row" id="port-manual-row" style="display:none">
<label style="color:#a6adc8;font-size:11px;flex-shrink:0">UDP:</label>
<input type="number" id="udp-port" value="8081" placeholder="udp" style="width:72px">
<label style="color:#a6adc8;font-size:11px;flex-shrink:0">Log:</label>
<input type="number" id="log-port" value="8082" placeholder="log" style="width:72px">
</div>
<div class="menu-row">
<label class="form-check" style="margin:0;font-size:11px">
<input type="checkbox" id="auto-ports" checked onchange="toggleAutoPorts(this.checked)">
<span style="color:#a6adc8">Auto ports (SERVICE_INFO)</span>
</label>
</div>
<hr class="menu-sep">
<div class="menu-btn-row">
<button onclick="discoverCmd()">Discover</button>
<button onclick="treeCmd()">Tree</button>
<button onclick="serviceInfoCmd()">Info</button>
</div>
</div>
</div>
<div class="tb-group">
<button id="btn-pause" onclick="togglePause()">⏸ Pause</button>
<button onclick="openStepDialog()">⚙ Step</button>
</div>
<div class="tb-group">
<button onclick="addPlot()">+ Plot</button>
</div>
<div class="tb-group">
<button onclick="openForceDialog()">⚡ Force</button>
<button onclick="openBreakDialog()">🔴 Break</button>
<button onclick="openMsgDialog()">✉ Msg</button>
</div>
<div class="tb-group" style="border:none;margin-left:auto">
<span id="udp-stats" style="color:#585b70;font-size:11px">0 pkts</span>
</div>
</div>
<!-- ═══ STEP STATUS BAR ═══ -->
<div id="step-bar">
<span>⏹ PAUSED at
<b id="paused-gam"></b></span>
<span id="step-remaining"></span>
<select id="step-thread" style="width:120px"></select>
<button onclick="step(1)">Step 1</button>
<button onclick="step(5)">Step 5</button>
<button onclick="step(20)">Step 20</button>
<button class="ok" onclick="togglePause()">▶ Resume</button>
</div>
<!-- ═══ MAIN ═══ -->
<div id="main">
<!-- LEFT: object tree -->
<div id="left-panel">
<div class="panel-header">
<span>Object Tree</span>
<button style="font-size:10px;padding:1px 6px" onclick="sendCmd('TREE')"></button>
</div>
<div class="panel-search"><input id="tree-search" oninput="filterTree(this.value)" placeholder="Search…"></div>
<div class="panel-body" id="tree-body">
<div class="empty-hint">Connect to MARTe2 then click Tree</div>
</div>
</div>
<!-- Left resize/collapse strip -->
<div id="left-strip" class="panel-strip" title="Drag to resize · Click to collapse"></div>
<!-- CENTER: plots -->
<div id="center-panel">
<div class="empty-hint" id="no-plots-hint">Add a plot panel to begin — drag signals from the tree or traced list</div>
</div>
<!-- Right resize/collapse strip -->
<div id="right-strip" class="panel-strip" title="Drag to resize · Click to collapse"></div>
<!-- RIGHT: tabs -->
<div id="right-panel">
<div class="tabs">
<div class="tab active" onclick="switchTab('traced')">Traced</div>
<div class="tab" onclick="switchTab('forced')">Forced</div>
<div class="tab" onclick="switchTab('breaks')">Breaks</div>
<div class="tab" onclick="switchTab('msgs')">Msgs</div>
</div>
<div class="tab-content active" id="tab-traced">
<div class="empty-hint" id="no-traced-hint">No signals traced</div>
</div>
<div class="tab-content" id="tab-forced">
<div class="empty-hint" id="no-forced-hint">No signals forced</div>
</div>
<div class="tab-content" id="tab-breaks">
<div class="empty-hint" id="no-breaks-hint">No breakpoints set</div>
</div>
<div class="tab-content" id="tab-msgs">
<div class="empty-hint" id="no-msgs-hint">No messages sent</div>
</div>
</div>
</div>
<!-- ═══ LOGS ═══ -->
<div id="log-panel">
<div id="log-toolbar">
<button class="panel-toggle" title="Collapse logs" onclick="togglePanel('log-panel','▼','▲',this)" id="log-toggle-btn"></button>
<span style="font-weight:600;color:#89b4fa">Logs</span>
<label><input type="checkbox" id="lf-service" onchange="renderLogs()">
Service</label>
<label><input type="checkbox" id="lf-debug" checked onchange="renderLogs()">
Debug</label>
<label><input type="checkbox" id="lf-info" checked onchange="renderLogs()">
Info</label>
<label><input type="checkbox" id="lf-warn" checked onchange="renderLogs()">
Warn</label>
<label><input type="checkbox" id="lf-error" checked onchange="renderLogs()">
Error</label>
<input type="text" id="log-filter" placeholder="Filter…" oninput="renderLogs()" style="width:150px">
<button onclick="logs=[];renderLogs()" style="margin-left:auto">Clear</button>
<label><input type="checkbox" id="log-autoscroll" checked>
Auto-scroll</label>
</div>
<div id="log-body"></div>
</div>
</div><!-- #app -->
<!-- ═══ DIALOGS ═══ -->
<!-- Force dialog -->
<div class="dialog-overlay" id="dlg-force" style="display:none" onclick="if(event.target===this)closeDlg('dlg-force')">
<div class="dialog">
<h3>⚡ Force Signal</h3>
<label>Signal</label>
<input id="force-sig" list="force-sig-list" placeholder="Signal path…">
<datalist id="force-sig-list"></datalist>
<label>Value</label>
<input id="force-val" placeholder="e.g. 42">
<div class="btns">
<button onclick="closeDlg('dlg-force')">Cancel</button>
<button class="active" onclick="doForce()">Force</button>
</div>
</div>
</div>
<!-- Unforce confirm -->
<div class="dialog-overlay" id="dlg-unforce" style="display:none" onclick="if(event.target===this)closeDlg('dlg-unforce')">
<div class="dialog">
<h3>Remove Force</h3>
<p id="unforce-msg" style="margin-bottom:12px;color:#cdd6f4"></p>
<div class="btns">
<button onclick="closeDlg('dlg-unforce')">Cancel</button>
<button class="danger" onclick="doUnforce()">Unforce</button>
</div>
</div>
</div>
<!-- Break dialog -->
<div class="dialog-overlay" id="dlg-break" style="display:none" onclick="if(event.target===this)closeDlg('dlg-break')">
<div class="dialog">
<h3>🔴 Set Breakpoint</h3>
<label>Signal</label>
<input id="break-sig" list="break-sig-list" placeholder="Signal path…">
<datalist id="break-sig-list"></datalist>
<div class="form-row">
<div>
<label>Operator</label>
<select id="break-op">
<option>></option><option>&gt;=</option>
<option>&lt;</option><option>&lt;=</option>
<option>==</option><option>!=</option>
</select>
</div>
<div>
<label>Threshold</label>
<input id="break-thresh" placeholder="0">
</div>
</div>
<div class="btns">
<button onclick="closeDlg('dlg-break')">Cancel</button>
<button class="active" onclick="doBreak()">Set Break</button>
</div>
</div>
</div>
<!-- Message dialog -->
<div class="dialog-overlay" id="dlg-msg" style="display:none" onclick="if(event.target===this)closeDlg('dlg-msg')">
<div class="dialog">
<h3>✉ Send Message</h3>
<label>Destination</label>
<input id="msg-dest" list="msg-dest-list" placeholder="e.g. App.Functions.GAM1">
<datalist id="msg-dest-list"></datalist>
<label>Function</label>
<input id="msg-func" placeholder="FunctionName">
<label>Payload (key=value lines)</label>
<textarea id="msg-payload" placeholder="Key = Value&#10;Key2 = Value2"></textarea>
<div class="form-check">
<input type="checkbox" id="msg-wait">
<label for="msg-wait">Wait for reply</label>
</div>
<div class="btns">
<button onclick="closeDlg('dlg-msg')">Cancel</button>
<button class="active" onclick="doSendMsg()">Send</button>
</div>
</div>
</div>
<!-- Array signal dialog (Trace / Force / Break with index/range selection) -->
<div class="dialog-overlay" id="dlg-array" style="display:none" onclick="if(event.target===this)closeDlg('dlg-array')">
<div class="dialog" style="min-width:360px">
<h3 id="arr-dlg-title">Array Signal</h3>
<p style="font-size:11px;color:#a6adc8;margin-bottom:14px">
<b id="arr-dlg-sig" style="color:#cdd6f4"></b>
&nbsp;·&nbsp;<span id="arr-dlg-n" style="color:#89b4fa"></span> elements
</p>
<!-- Segmented selection toggle -->
<label style="margin-bottom:6px">Apply to</label>
<div class="arr-seg">
<button id="arr-sel-all" class="active" onclick="setArrSel('all')">All</button>
<button id="arr-sel-idx" onclick="setArrSel('idx')">Index</button>
<button id="arr-sel-rng" onclick="setArrSel('rng')">Range</button>
</div>
<!-- Index mode: single number input -->
<div id="arr-idx-sect" style="display:none">
<label>Element index &nbsp;<span style="color:#585b70;font-weight:normal">(0 <span id="arr-idx-max"></span>)</span></label>
<input id="arr-idx" type="number" min="0" value="0">
</div>
<!-- Range mode: start / end -->
<div id="arr-rng-sect" style="display:none">
<div class="form-row">
<div>
<label>From index</label>
<input id="arr-r0" type="number" min="0" value="0">
</div>
<div>
<label>To index <span style="color:#585b70;font-weight:normal">inclusive</span></label>
<input id="arr-r1" type="number" min="0" value="0">
</div>
</div>
</div>
<!-- Force value (shown only for Force action) -->
<div id="arr-force-sect" style="display:none">
<label>Force value</label>
<input id="arr-force-val" placeholder="e.g. 0">
</div>
<!-- Break condition (shown only for Break action) -->
<div id="arr-break-sect" style="display:none">
<div class="form-row">
<div>
<label>Condition</label>
<select id="arr-break-op">
<option>></option><option>>=</option>
<option>&lt;</option><option>&lt;=</option>
<option>==</option><option>!=</option>
</select>
</div>
<div>
<label>Threshold</label>
<input id="arr-break-thr" placeholder="0">
</div>
</div>
</div>
<div class="btns">
<button onclick="closeDlg('dlg-array')">Cancel</button>
<button id="arr-ok-btn" class="active" onclick="doArrayOp()">Apply</button>
</div>
</div>
</div>
<!-- Array → plot mode dialog (Sequential / Waterfall) -->
<div class="dialog-overlay" id="dlg-arr-plot" style="display:none" onclick="if(event.target===this)closeDlg('dlg-arr-plot')">
<div class="dialog" style="min-width:360px">
<h3>Plot Array Signal</h3>
<p style="font-size:11px;color:#a6adc8;margin-bottom:14px">
<b id="arrp-name" style="color:#cdd6f4"></b>
&nbsp;·&nbsp;<span id="arrp-n" style="color:#89b4fa"></span>
elements
</p>
<div class="arr-seg" style="margin-bottom:8px">
<button id="arrp-sel-sequential" class="active" onclick="setArrpMode('sequential')">Sequential</button>
<button id="arrp-sel-waterfall" onclick="setArrpMode('waterfall')">Waterfall</button>
</div>
<p id="arrp-desc" style="font-size:10px;color:#a6adc8;margin-bottom:16px;min-height:28px"></p>
<div class="btns">
<button onclick="closeDlg('dlg-arr-plot')">Cancel</button>
<button class="active" onclick="doArrayPlotMode()">Add</button>
</div>
</div>
</div>
<!-- Info dialog -->
<div class="dialog-overlay" id="dlg-info" style="display:none" onclick="if(event.target===this)closeDlg('dlg-info')">
<div class="dialog" style="max-width:600px;width:90vw">
<h3 id="info-title">Info</h3>
<pre id="info-body" style="background:#11111b;padding:8px;border-radius:4px;overflow:auto;max-height:400px;font-size:11px;color:#cdd6f4;white-space:pre-wrap"></pre>
<div class="btns" style="margin-top:12px">
<button onclick="closeDlg('dlg-info')">Close</button>
</div>
</div>
</div>
<!-- Step dialog -->
<div class="dialog-overlay" id="dlg-step" style="display:none" onclick="if(event.target===this)closeDlg('dlg-step')">
<div class="dialog">
<h3>⚙ Step Execution</h3>
<div class="form-row">
<div>
<label>Count</label>
<input type="number" id="step-count" value="1" min="1">
</div>
<div>
<label>Thread (optional)</label>
<input id="step-thread-inp" list="step-thread-list" placeholder="all">
<datalist id="step-thread-list"></datalist>
</div>
</div>
<div class="btns">
<button onclick="closeDlg('dlg-step')">Cancel</button>
<button class="active" onclick="doStep()">Step</button>
</div>
</div>
</div>
<script src="uplot.min.js"></script>
<script src="app.js"></script>
</body>
</html>
+1
View File
@@ -0,0 +1 @@
.uplot, .uplot *, .uplot *::before, .uplot *::after {box-sizing: border-box;}.uplot {font-family: system-ui, -apple-system, "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji";line-height: 1.5;width: min-content;}.u-title {text-align: center;font-size: 18px;font-weight: bold;}.u-wrap {position: relative;user-select: none;}.u-over, .u-under {position: absolute;}.u-under {overflow: hidden;}.uplot canvas {display: block;position: relative;width: 100%;height: 100%;}.u-axis {position: absolute;}.u-legend {font-size: 14px;margin: auto;text-align: center;}.u-inline {display: block;}.u-inline * {display: inline-block;}.u-inline tr {margin-right: 16px;}.u-legend th {font-weight: 600;}.u-legend th > * {vertical-align: middle;display: inline-block;}.u-legend .u-marker {width: 1em;height: 1em;margin-right: 4px;background-clip: padding-box !important;}.u-inline.u-live th::after {content: ":";vertical-align: middle;}.u-inline:not(.u-live) .u-value {display: none;}.u-series > * {padding: 4px;}.u-series th {cursor: pointer;}.u-legend .u-off > * {opacity: 0.3;}.u-select {background: rgba(0,0,0,0.07);position: absolute;pointer-events: none;}.u-cursor-x, .u-cursor-y {position: absolute;left: 0;top: 0;pointer-events: none;will-change: transform;}.u-hz .u-cursor-x, .u-vt .u-cursor-y {height: 100%;border-right: 1px dashed #607D8B;}.u-hz .u-cursor-y, .u-vt .u-cursor-x {width: 100%;border-bottom: 1px dashed #607D8B;}.u-cursor-pt {position: absolute;top: 0;left: 0;border-radius: 50%;border: 0 solid;pointer-events: none;will-change: transform;/*this has to be !important since we set inline "background" shorthand */background-clip: padding-box !important;}.u-axis.u-off, .u-select.u-off, .u-cursor-x.u-off, .u-cursor-y.u-off, .u-cursor-pt.u-off {display: none;}
File diff suppressed because one or more lines are too long
+890 -87
View File
File diff suppressed because it is too large Load Diff
+6 -4
View File
@@ -5,12 +5,14 @@ edition = "2021"
[dependencies] [dependencies]
eframe = "0.31.0" eframe = "0.31.0"
egui = "0.31.0"
egui_plot = "0.31.0" egui_plot = "0.31.0"
tokio = { version = "1.0", features = ["full"] }
serde = { version = "1.0", features = ["derive"] } serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0" serde_json = "1.0"
byteorder = "1.4"
chrono = "0.4" chrono = "0.4"
crossbeam-channel = "0.5" crossbeam-channel = "0.5"
regex = "1.12.3" regex = "1.10"
socket2 = { version = "0.5", features = ["all"] }
once_cell = "1.21"
rfd = "0.15"
parquet = { version = "53.0", features = ["arrow"] }
arrow = "53.0"
+2604 -380
View File
File diff suppressed because it is too large Load Diff
-150
View File
@@ -1,150 +0,0 @@
MARTe2 Environment Set (MARTe2_DIR=/home/martino/Projects/marte_debug/dependency/MARTe2)
MARTe2 Components Environment Set (MARTe2_Components_DIR=/home/martino/Projects/marte_debug/dependency/MARTe2-components)
Cleaning up lingering processes...
Launching standard MARTeApp.ex with debug_test.cfg...
[Debug - Bootstrap.cpp:79]: Arguments:
-f = "Test/Configurations/debug_test.cfg"
-l = "RealTimeLoader"
-s = "State1"
[Information - Bootstrap.cpp:207]: Loader parameters:
-f = "Test/Configurations/debug_test.cfg"
-l = "RealTimeLoader"
-s = "State1"
Loader = "RealTimeLoader"
Filename = "Test/Configurations/debug_
[Information - Loader.cpp:67]: DefaultCPUs set to 1
[Information - Loader.cpp:74]: SchedulerGranularity is 10000
[Debug - Loader.cpp:189]: Purging ObjectRegistryDatabase with 0 objects
[Debug - Loader.cpp:192]: Purge ObjectRegistryDatabase. Number of objects left: 0
[Information - LinuxTimer.cpp:117]: SleepNature was not set. Using Default.
[Information - LinuxTimer.cpp:127]: Phase was not configured, using default 0
[Warning - LinuxTimer.cpp:164]: ExecutionMode not specified using: IndependentThread
[Warning - LinuxTimer.cpp:185]: CPUMask not specified using: 255
[Warning - LinuxTimer.cpp:191]: StackSize not specified using: 262144
[Information - LinuxTimer.cpp:236]: No timer provider specified. Falling back to HighResolutionTimeProvider
[Information - HighResolutionTimeProvider.cpp:163]: Sleep nature was not specified, falling back to default (Sleep::NoMore mode)
[Information - HighResolutionTimeProvider.cpp:61]: Inner initialization succeeded
[Information - LinuxTimer.cpp:267]: Backward compatibility parameters injection unnecessary
[Information - RealTimeThread.cpp:190]: No CPUs defined for the RealTimeThread Thread1
[Information - RealTimeThread.cpp:193]: No StackSize defined for the RealTimeThread Thread1
[DebugService] TCP Server listening on port 8080
[DebugService] UDP Streamer socket opened
[ParametersError - StringHelper.cpp:60]: Error: invalid input arguments
[Warning - Threads.cpp:173]: Requested a thread priority that is higher than the one supported by the selected policy - clipping to the maximum value supported by the policy.
[Warning - Threads.cpp:173]: Requested a thread priority that is higher than the one supported by the selected policy - clipping to the maximum value supported by the policy.
[ParametersError - StringHelper.cpp:60]: Error: invalid input arguments
[Warning - Threads.cpp:173]: Requested a thread priority that is higher than the one supported by the selected policy - clipping to the maximum value supported by the policy.
[Warning - Threads.cpp:173]: Requested a thread priority that is higher than the one supported by the selected policy - clipping to the maximum value supported by the policy.
[DebugService] Worker threads started.
[TcpLogger] Listening on port 8082
[ParametersError - StringHelper.cpp:60]: Error: invalid input arguments
[Warning - Threads.cpp:173]: Requested a thread priority that is higher than the one supported by the selected policy - clipping to the maximum value supported by the policy.
[Warning - Threads.cpp:173]: Requested a thread priority that is higher than the one supported by the selected policy - clipping to the maximum value supported by the policy.
[Warning] Requested a thread priority that is higher than the one supported by the selected policy - clipping to the maximum value supported by the policy.
[Warning] Requested a thread priority that is higher than the one supported by the selected policy - clipping to the maximum value supported by the policy.
[Information] LoaderPostInit not set
[Information] Going to rtAppBuilder.ConfigureAfterInitialisation()
[Information] Going to InitialiseSignalsDatabase
[Information] Going to FlattenSignalsDatabases
[Information] Caching introspection signals
[Information] Flattening functions input signals
[Debug] Updating the signal database
[Debug] Finished updating the signal database
[Information] Flattening functions output signals
[Debug] Updating the signal database
[Debug] Finished updating the signal database
[Information] Flattening data sources signals
[Debug] Updating the signal database
[Debug] Finished updating the signal database
[Debug] Updating the signal database
[Debug] Finished updating the signal database
[Debug] Updating the signal database
[Debug] Finished updating the signal database
[Information] Going to VerifyDataSourcesSignals
[Debug] Updating the signal database
[Information] Verifying signals for Timer
[Debug] Finished updating the signal database
[Information] Going to ResolveStates
[Information] Resolving state State1
[Information] Resolving thread container Threads
[Information] Resolving thread State1.Thread1
[Information] Resolving GAM1
[Information] Going to ResolveDataSources
[Information] Verifying signals for Logger
[Information] Resolving for function GAM1 [idx: 0]
[Information] Resolving 2 signals
[Information] Resolving 2 signals
[Information] Verifying signals for DDB
[Information] Verifying signals for DAMS
[Information] Going to VerifyConsumersAndProducers
[Information] Started application in state State1
[Information] Application starting
[Information] Verifying consumers and producers for Timer
[Information] Verifying consumers and producers for Logger
[Information] Verifying consumers and producers for DDB
[Information] Verifying consumers and producers for DAMS
[Information] Going to CleanCaches
[Debug] Purging dataSourcesIndexesCache. Number of children:3
[Debug] Purging functionsIndexesCache. Number of children:1
[Debug] Purging dataSourcesSignalIndexCache. Number of children:3
[Debug] Purging dataSourcesFunctionIndexesCache. Number of children:1
[Debug] Purging functionsMemoryIndexesCache. Number of children:2
[Debug] Purged functionsMemoryIndexesCache. Number of children:0
[Debug] Purged cachedIntrospections. Number of children:0
[Information] Going to rtAppBuilder.PostConfigureDataSources()
[Information] Going to rtAppBuilder.PostConfigureFunctions()
[Information] Going to rtAppBuilder.Copy()
[Information] Going to AllocateGAMMemory
[Information] Going to AllocateDataSourceMemory()
[Information] Going to AddBrokersToFunctions
[Information] Creating broker MemoryMapSynchronisedInputBroker for GAM1 and signal Counter(0)
[Information] Creating broker MemoryMapInputBroker for GAM1 and signal Time(1)
[Information] Getting input brokers for Timer
[Information] Getting output brokers for Timer
[Information] Getting input brokers for Logger
[Information] Getting output brokers for Logger
[Information] Getting input brokers for DDB
[Information] Getting output brokers for DDB
[Information] Getting input brokers for DAMS
[Information] Getting output brokers for DAMS
[Information] Going to FindStatefulDataSources
[Information] Going to configure scheduler
[Information] Preparing state State1
[Information] Frequency found = 1.000000
[Information] Frequency found = 1.000000
[Information] The timer will be set using a frequency of 1.000000 Hz
[ParametersError] Error: invalid input arguments
[Warning] Requested a thread priority that is higher than the one supported by the selected policy - clipping to the maximum value supported by the policy.
[Warning] Failed to change the thread priority (likely due to insufficient permissions)
[Information] LinuxTimer::Prepared = true
[Warning] Requested a thread priority that is higher than the one supported by the selected policy - clipping to the maximum value supported by the policy.
[Warning] Failed to change the thread priority (likely due to insufficient permissions)
[Information] Time [0:0]:0
[Information] Time [0:0]:2000000
[Information] Time [0:0]:3000000
[Information] Time [0:0]:4000000
[Information] Time [0:0]:5000000
[Information] Time [0:0]:6000000
[Information] Time [0:0]:7000000
[Information] Time [0:0]:8000000
[Information] Time [0:0]:9000000
[Information] Time [0:0]:10000000
[Information] Time [0:0]:11000000
[Information] Time [0:0]:12000000
[Information] Time [0:0]:13000000
[Information] Time [0:0]:14000000
[Information] Time [0:0]:15000000
[Information] Time [0:0]:16000000
[Information] Time [0:0]:17000000
[Information] Time [0:0]:18000000
[Information] Time [0:0]:19000000
[Information] Time [0:0]:20000000
[Information] Time [0:0]:21000000
[Information] Time [0:0]:22000000
[Information] Time [0:0]:23000000
[Information] Time [0:0]:24000000
[Information] Time [0:0]:25000000
[Information] Time [0:0]:26000000
[Information] Time [0:0]:27000000
[Information] Time [0:0]:28000000
+151 -376
View File
@@ -1,412 +1,187 @@
[ [
{ {
"file": "CMakeCCompilerId.c", "file": "TcpLogger.cpp",
"arguments": [ "arguments": [
"cc", "/usr/bin/g++",
"CMakeCCompilerId.c"
],
"directory": "/home/martino/Projects/marte_debug/Build/CMakeFiles/4.2.3/CompilerIdC"
},
{
"file": "CMakeCXXCompilerId.cpp",
"arguments": [
"c++",
"CMakeCXXCompilerId.cpp"
],
"directory": "/home/martino/Projects/marte_debug/Build/CMakeFiles/4.2.3/CompilerIdCXX"
},
{
"file": "/usr/share/cmake/Modules/CMakeCCompilerABI.c",
"arguments": [
"cc",
"-v",
"-o",
"CMakeFiles/cmTC_a4cfb.dir/CMakeCCompilerABI.c.o",
"-c", "-c",
"/usr/share/cmake/Modules/CMakeCCompilerABI.c" "-I.",
], "-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L0Types",
"directory": "/home/martino/Projects/marte_debug/Build/CMakeFiles/CMakeScratch/TryCompile-xo4CnB", "-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L1Portability",
"output": "CMakeFiles/cmTC_a4cfb.dir/CMakeCCompilerABI.c.o" "-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L2Objects",
}, "-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L3Streams",
{ "-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L4Messages",
"file": "/usr/share/cmake/Modules/CMakeCXXCompilerABI.cpp", "-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L4Logger",
"arguments": [ "-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L4Configuration",
"c++", "-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L5GAMs",
"-v", "-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L1Portability",
"-o", "-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L3Services",
"CMakeFiles/cmTC_f4fc4.dir/CMakeCXXCompilerABI.cpp.o", "-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L4Messages",
"-c", "-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L4LoggerService",
"/usr/share/cmake/Modules/CMakeCXXCompilerABI.cpp" "-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L5GAMs",
], "-I/home/martino/workspace/MARTe2/Source/Core/FileSystem/L1Portability",
"directory": "/home/martino/Projects/marte_debug/Build/CMakeFiles/CMakeScratch/TryCompile-tgsqrG", "-I/home/martino/workspace/MARTe2/Source/Core/FileSystem/L3Streams",
"output": "CMakeFiles/cmTC_f4fc4.dir/CMakeCXXCompilerABI.cpp.o"
},
{
"file": "/home/martino/Projects/marte_debug/Source/DebugFastScheduler.cpp",
"arguments": [
"c++",
"-DARCHITECTURE=x86_gcc",
"-DENVIRONMENT=Linux",
"-DMARTe2_TEST_ENVIRONMENT=GTest",
"-DUSE_PTHREAD",
"-Dmarte_dev_EXPORTS",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L0Types",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L2Objects",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Configuration",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Events",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Logger",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Messages",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5FILES",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L6App",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L3Services",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L4LoggerService",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/EpicsDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/FileDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/GAMs/IOGAM",
"-I/home/martino/Projects/marte_debug/Source",
"-I/home/martino/Projects/marte_debug/Headers",
"-pthread",
"-g",
"-fPIC", "-fPIC",
"-MD", "-Wall",
"-MT", "-std=c++98",
"CMakeFiles/marte_dev.dir/Source/DebugFastScheduler.cpp.o", "-Werror",
"-MF", "-Wno-invalid-offsetof",
"CMakeFiles/marte_dev.dir/Source/DebugFastScheduler.cpp.o.d", "-Wno-unused-variable",
"-o", "-fno-strict-aliasing",
"CMakeFiles/marte_dev.dir/Source/DebugFastScheduler.cpp.o", "-frtti",
"-c", "-DMARTe2_TEST_ENVIRONMENT=GTest",
"/home/martino/Projects/marte_debug/Source/DebugFastScheduler.cpp"
],
"directory": "/home/martino/Projects/marte_debug/Build",
"output": "CMakeFiles/marte_dev.dir/Source/DebugFastScheduler.cpp.o"
},
{
"file": "/home/martino/Projects/marte_debug/Source/DebugService.cpp",
"arguments": [
"c++",
"-DARCHITECTURE=x86_gcc", "-DARCHITECTURE=x86_gcc",
"-DENVIRONMENT=Linux", "-DENVIRONMENT=Linux",
"-DMARTe2_TEST_ENVIRONMENT=GTest",
"-DUSE_PTHREAD", "-DUSE_PTHREAD",
"-Dmarte_dev_EXPORTS",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L0Types",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L2Objects",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Configuration",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Events",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Logger",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Messages",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5FILES",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L6App",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L3Services",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L4LoggerService",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/EpicsDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/FileDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/GAMs/IOGAM",
"-I/home/martino/Projects/marte_debug/Source",
"-I/home/martino/Projects/marte_debug/Headers",
"-pthread", "-pthread",
"-Wno-deprecated-declarations",
"-Wno-unused-value",
"-g", "-g",
"-ggdb",
"TcpLogger.cpp",
"-o",
"../../../..//Build/x86-linux/Components/Interfaces/TCPLogger/TcpLogger.o"
],
"directory": "/home/martino/Projects/marte_debug/Source/Components/Interfaces/TCPLogger",
"output": "../../../..//Build/x86-linux/Components/Interfaces/TCPLogger/TcpLogger.o"
},
{
"file": "DebugService.cpp",
"arguments": [
"/usr/bin/g++",
"-c",
"-I../../../..//Source/Core/Types/Result",
"-I../../../..//Source/Core/Types/Vec",
"-I../../../..//Source/Components/Interfaces/TCPLogger",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L0Types",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L1Portability",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L2Objects",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L3Streams",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L4Messages",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L4Logger",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L4Configuration",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L5GAMs",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L1Portability",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L3Services",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L4Messages",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L4LoggerService",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L5GAMs",
"-I/home/martino/workspace/MARTe2/Source/Core/FileSystem/L1Portability",
"-I/home/martino/workspace/MARTe2/Source/Core/FileSystem/L3Streams",
"-fPIC", "-fPIC",
"-MD", "-Wall",
"-MT", "-std=c++98",
"CMakeFiles/marte_dev.dir/Source/DebugService.cpp.o", "-Werror",
"-MF", "-Wno-invalid-offsetof",
"CMakeFiles/marte_dev.dir/Source/DebugService.cpp.o.d", "-Wno-unused-variable",
"-o", "-fno-strict-aliasing",
"CMakeFiles/marte_dev.dir/Source/DebugService.cpp.o", "-frtti",
"-c", "-DMARTe2_TEST_ENVIRONMENT=GTest",
"/home/martino/Projects/marte_debug/Source/DebugService.cpp"
],
"directory": "/home/martino/Projects/marte_debug/Build",
"output": "CMakeFiles/marte_dev.dir/Source/DebugService.cpp.o"
},
{
"file": "/home/martino/Projects/marte_debug/Source/TcpLogger.cpp",
"arguments": [
"c++",
"-DARCHITECTURE=x86_gcc", "-DARCHITECTURE=x86_gcc",
"-DENVIRONMENT=Linux", "-DENVIRONMENT=Linux",
"-DMARTe2_TEST_ENVIRONMENT=GTest",
"-DUSE_PTHREAD", "-DUSE_PTHREAD",
"-Dmarte_dev_EXPORTS",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L0Types",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L2Objects",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Configuration",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Events",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Logger",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Messages",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5FILES",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L6App",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L3Services",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L4LoggerService",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/EpicsDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/FileDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/GAMs/IOGAM",
"-I/home/martino/Projects/marte_debug/Source",
"-I/home/martino/Projects/marte_debug/Headers",
"-pthread", "-pthread",
"-Wno-deprecated-declarations",
"-Wno-unused-value",
"-g", "-g",
"-ggdb",
"DebugService.cpp",
"-o",
"../../../..//Build/x86-linux/Components/Interfaces/DebugService/DebugService.o"
],
"directory": "/home/martino/Projects/marte_debug/Source/Components/Interfaces/DebugService",
"output": "../../../..//Build/x86-linux/Components/Interfaces/DebugService/DebugService.o"
},
{
"file": "DebugServiceBase.cpp",
"arguments": [
"/usr/bin/g++",
"-c",
"-I../../../..//Source/Core/Types/Result",
"-I../../../..//Source/Core/Types/Vec",
"-I../../../..//Source/Components/Interfaces/TCPLogger",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L0Types",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L1Portability",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L2Objects",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L3Streams",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L4Messages",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L4Logger",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L4Configuration",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L5GAMs",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L1Portability",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L3Services",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L4Messages",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L4LoggerService",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L5GAMs",
"-I/home/martino/workspace/MARTe2/Source/Core/FileSystem/L1Portability",
"-I/home/martino/workspace/MARTe2/Source/Core/FileSystem/L3Streams",
"-fPIC", "-fPIC",
"-MD", "-Wall",
"-MT", "-std=c++98",
"CMakeFiles/marte_dev.dir/Source/TcpLogger.cpp.o", "-Werror",
"-MF", "-Wno-invalid-offsetof",
"CMakeFiles/marte_dev.dir/Source/TcpLogger.cpp.o.d", "-Wno-unused-variable",
"-o", "-fno-strict-aliasing",
"CMakeFiles/marte_dev.dir/Source/TcpLogger.cpp.o", "-frtti",
"-c", "-DMARTe2_TEST_ENVIRONMENT=GTest",
"/home/martino/Projects/marte_debug/Source/TcpLogger.cpp"
],
"directory": "/home/martino/Projects/marte_debug/Build",
"output": "CMakeFiles/marte_dev.dir/Source/TcpLogger.cpp.o"
},
{
"file": "/home/martino/Projects/marte_debug/Test/UnitTests/main.cpp",
"arguments": [
"c++",
"-DARCHITECTURE=x86_gcc", "-DARCHITECTURE=x86_gcc",
"-DENVIRONMENT=Linux", "-DENVIRONMENT=Linux",
"-DMARTe2_TEST_ENVIRONMENT=GTest",
"-DUSE_PTHREAD", "-DUSE_PTHREAD",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L0Types",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L2Objects",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Configuration",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Events",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Logger",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Messages",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5FILES",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L6App",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L3Services",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L4LoggerService",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/EpicsDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/FileDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/GAMs/IOGAM",
"-I/home/martino/Projects/marte_debug/Source",
"-I/home/martino/Projects/marte_debug/Headers",
"-I/home/martino/Projects/marte_debug/Test/UnitTests/../../Source",
"-I/home/martino/Projects/marte_debug/Test/UnitTests/../../Headers",
"-pthread", "-pthread",
"-Wno-deprecated-declarations",
"-Wno-unused-value",
"-g", "-g",
"-MD", "-ggdb",
"-MT", "DebugServiceBase.cpp",
"Test/UnitTests/CMakeFiles/UnitTests.dir/main.cpp.o",
"-MF",
"CMakeFiles/UnitTests.dir/main.cpp.o.d",
"-o", "-o",
"CMakeFiles/UnitTests.dir/main.cpp.o", "../../../..//Build/x86-linux/Components/Interfaces/DebugService/DebugServiceBase.o"
"-c",
"/home/martino/Projects/marte_debug/Test/UnitTests/main.cpp"
], ],
"directory": "/home/martino/Projects/marte_debug/Build/Test/UnitTests", "directory": "/home/martino/Projects/marte_debug/Source/Components/Interfaces/DebugService",
"output": "CMakeFiles/UnitTests.dir/main.cpp.o" "output": "../../../..//Build/x86-linux/Components/Interfaces/DebugService/DebugServiceBase.o"
}, },
{ {
"file": "/home/martino/Projects/marte_debug/Test/Integration/main.cpp", "file": "WebDebugService.cpp",
"arguments": [ "arguments": [
"c++", "/usr/bin/g++",
"-c",
"-I../../../..//Source/Components/Interfaces/TCPLogger",
"-I../../../..//Source/Components/Interfaces/DebugService",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L0Types",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L1Portability",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L2Objects",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L3Streams",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L4Messages",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L4Logger",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L4Configuration",
"-I/home/martino/workspace/MARTe2/Source/Core/BareMetal/L5GAMs",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L1Portability",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L3Services",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L4Messages",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L4LoggerService",
"-I/home/martino/workspace/MARTe2/Source/Core/Scheduler/L5GAMs",
"-I/home/martino/workspace/MARTe2/Source/Core/FileSystem/L1Portability",
"-I/home/martino/workspace/MARTe2/Source/Core/FileSystem/L3Streams",
"-fPIC",
"-Wall",
"-std=c++98",
"-Werror",
"-Wno-invalid-offsetof",
"-Wno-unused-variable",
"-fno-strict-aliasing",
"-frtti",
"-DMARTe2_TEST_ENVIRONMENT=GTest",
"-DARCHITECTURE=x86_gcc", "-DARCHITECTURE=x86_gcc",
"-DENVIRONMENT=Linux", "-DENVIRONMENT=Linux",
"-DMARTe2_TEST_ENVIRONMENT=GTest",
"-DUSE_PTHREAD", "-DUSE_PTHREAD",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L0Types",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L2Objects",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Configuration",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Events",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Logger",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Messages",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5FILES",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L6App",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L3Services",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L4LoggerService",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/EpicsDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/FileDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/GAMs/IOGAM",
"-I/home/martino/Projects/marte_debug/Source",
"-I/home/martino/Projects/marte_debug/Headers",
"-pthread", "-pthread",
"-Wno-deprecated-declarations",
"-Wno-unused-value",
"-g", "-g",
"-MD", "-ggdb",
"-MT", "WebDebugService.cpp",
"Test/Integration/CMakeFiles/IntegrationTest.dir/main.cpp.o",
"-MF",
"CMakeFiles/IntegrationTest.dir/main.cpp.o.d",
"-o", "-o",
"CMakeFiles/IntegrationTest.dir/main.cpp.o", "../../../..//Build/x86-linux/Components/Interfaces/WebDebugService/WebDebugService.o"
"-c",
"/home/martino/Projects/marte_debug/Test/Integration/main.cpp"
], ],
"directory": "/home/martino/Projects/marte_debug/Build/Test/Integration", "directory": "/home/martino/Projects/marte_debug/Source/Components/Interfaces/WebDebugService",
"output": "CMakeFiles/IntegrationTest.dir/main.cpp.o" "output": "../../../..//Build/x86-linux/Components/Interfaces/WebDebugService/WebDebugService.o"
},
{
"file": "/home/martino/Projects/marte_debug/Test/Integration/TraceTest.cpp",
"arguments": [
"c++",
"-DARCHITECTURE=x86_gcc",
"-DENVIRONMENT=Linux",
"-DMARTe2_TEST_ENVIRONMENT=GTest",
"-DUSE_PTHREAD",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L0Types",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L2Objects",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Configuration",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Events",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Logger",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Messages",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5FILES",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L6App",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L3Services",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L4LoggerService",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/EpicsDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/FileDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/GAMs/IOGAM",
"-I/home/martino/Projects/marte_debug/Source",
"-I/home/martino/Projects/marte_debug/Headers",
"-pthread",
"-g",
"-MD",
"-MT",
"Test/Integration/CMakeFiles/TraceTest.dir/TraceTest.cpp.o",
"-MF",
"CMakeFiles/TraceTest.dir/TraceTest.cpp.o.d",
"-o",
"CMakeFiles/TraceTest.dir/TraceTest.cpp.o",
"-c",
"/home/martino/Projects/marte_debug/Test/Integration/TraceTest.cpp"
],
"directory": "/home/martino/Projects/marte_debug/Build/Test/Integration",
"output": "CMakeFiles/TraceTest.dir/TraceTest.cpp.o"
},
{
"file": "/home/martino/Projects/marte_debug/Test/Integration/ValidationTest.cpp",
"arguments": [
"c++",
"-DARCHITECTURE=x86_gcc",
"-DENVIRONMENT=Linux",
"-DMARTe2_TEST_ENVIRONMENT=GTest",
"-DUSE_PTHREAD",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L0Types",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L2Objects",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Configuration",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Events",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Logger",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Messages",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5FILES",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L6App",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L3Services",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L4LoggerService",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/EpicsDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/FileDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/GAMs/IOGAM",
"-I/home/martino/Projects/marte_debug/Source",
"-I/home/martino/Projects/marte_debug/Headers",
"-pthread",
"-g",
"-MD",
"-MT",
"Test/Integration/CMakeFiles/ValidationTest.dir/ValidationTest.cpp.o",
"-MF",
"CMakeFiles/ValidationTest.dir/ValidationTest.cpp.o.d",
"-o",
"CMakeFiles/ValidationTest.dir/ValidationTest.cpp.o",
"-c",
"/home/martino/Projects/marte_debug/Test/Integration/ValidationTest.cpp"
],
"directory": "/home/martino/Projects/marte_debug/Build/Test/Integration",
"output": "CMakeFiles/ValidationTest.dir/ValidationTest.cpp.o"
},
{
"file": "/home/martino/Projects/marte_debug/Test/Integration/SchedulerTest.cpp",
"arguments": [
"c++",
"-DARCHITECTURE=x86_gcc",
"-DENVIRONMENT=Linux",
"-DMARTe2_TEST_ENVIRONMENT=GTest",
"-DUSE_PTHREAD",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L0Types",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L2Objects",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Configuration",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Events",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Logger",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L4Messages",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5FILES",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/BareMetal/L6App",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L3Services",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L4LoggerService",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L1Portability",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/FileSystem/L3Streams",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2/Source/Core/Scheduler/L5GAMs",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/EpicsDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/DataSources/FileDataSource",
"-I/home/martino/Projects/marte_debug/dependency/MARTe2-components/Source/Components/GAMs/IOGAM",
"-I/home/martino/Projects/marte_debug/Source",
"-I/home/martino/Projects/marte_debug/Headers",
"-pthread",
"-g",
"-MD",
"-MT",
"Test/Integration/CMakeFiles/SchedulerTest.dir/SchedulerTest.cpp.o",
"-MF",
"CMakeFiles/SchedulerTest.dir/SchedulerTest.cpp.o.d",
"-o",
"CMakeFiles/SchedulerTest.dir/SchedulerTest.cpp.o",
"-c",
"/home/martino/Projects/marte_debug/Test/Integration/SchedulerTest.cpp"
],
"directory": "/home/martino/Projects/marte_debug/Build/Test/Integration",
"output": "CMakeFiles/SchedulerTest.dir/SchedulerTest.cpp.o"
} }
] ]
+22
View File
@@ -0,0 +1,22 @@
# Get the directory of this script
set -l DIR (dirname (realpath (status -f)))
set -gx MARTe2_DIR $DIR/dependency/MARTe2
set -gx MARTe2_Components_DIR $DIR/dependency/MARTe2-components
set -gx TARGET x86-linux
# Update LD_LIBRARY_PATH
if not set -q LD_LIBRARY_PATH
set -gx LD_LIBRARY_PATH ""
end
set -gx LD_LIBRARY_PATH "$LD_LIBRARY_PATH:$MARTe2_DIR/Build/$TARGET/Core"
set -gx LD_LIBRARY_PATH "$LD_LIBRARY_PATH:$MARTe2_Components_DIR/Build/$TARGET/Components"
set -gx LD_LIBRARY_PATH "$LD_LIBRARY_PATH:$DIR/Build/$TARGET/Components/Interfaces/DebugService"
set -gx LD_LIBRARY_PATH "$LD_LIBRARY_PATH:$DIR/Build/$TARGET/Components/Interfaces/TCPLogger"
set -gx LD_LIBRARY_PATH "$LD_LIBRARY_PATH:$MARTe2_Components_DIR/Build/$TARGET/Components/DataSources/LinuxTimer"
set -gx LD_LIBRARY_PATH "$LD_LIBRARY_PATH:$MARTe2_Components_DIR/Build/$TARGET/Components/DataSources/LoggerDataSource"
set -gx LD_LIBRARY_PATH "$LD_LIBRARY_PATH:$MARTe2_Components_DIR/Build/$TARGET/Components/GAMs/IOGAM"
echo "MARTe2 Environment Set (MARTe2_DIR=$MARTe2_DIR)"
echo "MARTe2 Components Environment Set (MARTe2_Components_DIR=$MARTe2_Components_DIR)"
+7 -2
View File
@@ -2,10 +2,15 @@
# Get the directory of this script # Get the directory of this script
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
export MARTe2_DIR=$DIR/dependency/MARTe2 export MARTe2_DIR=$HOME/workspace/MARTe2
export MARTe2_Components_DIR=$DIR/dependency/MARTe2-components export MARTe2_Components_DIR=$HOME/workspace/MARTe2-components
export TARGET=x86-linux export TARGET=x86-linux
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$MARTe2_DIR/Build/$TARGET/Core export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$MARTe2_DIR/Build/$TARGET/Core
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$MARTe2_Components_DIR/Build/$TARGET/Components export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$MARTe2_Components_DIR/Build/$TARGET/Components
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$DIR/Build/$TARGET/Components/Interfaces/DebugService
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$DIR/Build/$TARGET/Components/Interfaces/TCPLogger
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$MARTe2_Components_DIR/Build/$TARGET/Components/DataSources/LinuxTimer
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$MARTe2_Components_DIR/Build/$TARGET/Components/DataSources/LoggerDataSource
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$MARTe2_Components_DIR/Build/$TARGET/Components/GAMs/IOGAM
echo "MARTe2 Environment Set (MARTe2_DIR=$MARTe2_DIR)" echo "MARTe2 Environment Set (MARTe2_DIR=$MARTe2_DIR)"
echo "MARTe2 Components Environment Set (MARTe2_Components_DIR=$MARTe2_Components_DIR)" echo "MARTe2 Components Environment Set (MARTe2_Components_DIR=$MARTe2_Components_DIR)"
+34 -7
View File
@@ -11,13 +11,16 @@ fi
# 2. Paths # 2. Paths
MARTE_EX="${MARTe2_DIR}/Build/${TARGET}/App/MARTeApp.ex" MARTE_EX="${MARTe2_DIR}/Build/${TARGET}/App/MARTeApp.ex"
DEBUG_LIB="$(pwd)/Build/libmarte_dev.so" BUILD_DIR="$(pwd)/Build/${TARGET}"
# Our plugin libraries
DEBUG_LIB="${BUILD_DIR}/Components/Interfaces/DebugService/libDebugService.so"
TCPLOGGER_LIB="${BUILD_DIR}/Components/Interfaces/TCPLogger/libTcpLogger.so"
# Component library base search path # Component library base search path
COMPONENTS_BUILD_DIR="${MARTe2_Components_DIR}/Build/${TARGET}/Components" COMPONENTS_BUILD_DIR="${MARTe2_Components_DIR}/Build/${TARGET}/Components"
# DYNAMICALLY FIND ALL COMPONENT DIRS # DYNAMICALLY FIND ALL COMPONENT DIRS and add to LD_LIBRARY_PATH
# MARTe2 Loader needs the specific directories containing .so files in LD_LIBRARY_PATH
ALL_COMPONENT_DIRS=$(find "$COMPONENTS_BUILD_DIR" -type d) ALL_COMPONENT_DIRS=$(find "$COMPONENTS_BUILD_DIR" -type d)
for dir in $ALL_COMPONENT_DIRS; do for dir in $ALL_COMPONENT_DIRS; do
if ls "$dir"/*.so >/dev/null 2>&1; then if ls "$dir"/*.so >/dev/null 2>&1; then
@@ -26,15 +29,39 @@ for dir in $ALL_COMPONENT_DIRS; do
done done
# Ensure our build dir and core dir are included # Ensure our build dir and core dir are included
export LD_LIBRARY_PATH="$(pwd)/Build:${MARTe2_DIR}/Build/${TARGET}/Core:${LD_LIBRARY_PATH}" export LD_LIBRARY_PATH="${BUILD_DIR}/Components/Interfaces/DebugService:${BUILD_DIR}/Components/Interfaces/TCPLogger:${MARTe2_DIR}/Build/${TARGET}/Core:${LD_LIBRARY_PATH}"
# 3. Cleanup # 3. Cleanup
echo "Cleaning up lingering processes..." echo "Cleaning up lingering processes..."
pkill -9 MARTeApp.ex pkill -9 MARTeApp.ex
sleep 1 sleep 1
# 4. Launch Application # 4. Validate libraries exist
for lib in "$DEBUG_LIB" "$TCPLOGGER_LIB"; do
if [ ! -f "$lib" ]; then
echo "ERROR: Library not found: $lib"
echo "Run: make -f Makefile.gcc core"
exit 1
fi
done
# 5. Launch Application
echo "Launching standard MARTeApp.ex with debug_test.cfg..." echo "Launching standard MARTeApp.ex with debug_test.cfg..."
# PRELOAD ensures our DebugService class is available to the registry early # LD_PRELOAD ensures our classes are registered before the config is parsed.
export LD_PRELOAD="${DEBUG_LIB}" # MARTeApp.ex does not use dlopen for plugins — preloading is the standard approach.
# All required component .so files are collected via the find loop into LD_PRELOAD too.
PRELOAD_LIBS="${DEBUG_LIB}:${TCPLOGGER_LIB}"
# Collect any additional component .so files referenced by the config
for lib in \
"${COMPONENTS_BUILD_DIR}/DataSources/RealTimeThreadSynchronisation/RealTimeThreadSynchronisation.so" \
"${COMPONENTS_BUILD_DIR}/DataSources/LinuxTimer/LinuxTimer.so" \
"${COMPONENTS_BUILD_DIR}/DataSources/LoggerDataSource/LoggerDataSource.so" \
"${COMPONENTS_BUILD_DIR}/GAMs/IOGAM/IOGAM.so"; do
if [ -f "$lib" ]; then
PRELOAD_LIBS="${PRELOAD_LIBS}:${lib}"
fi
done
export LD_PRELOAD="${PRELOAD_LIBS}"
"$MARTE_EX" -f Test/Configurations/debug_test.cfg -l RealTimeLoader -s State1 "$MARTE_EX" -f Test/Configurations/debug_test.cfg -l RealTimeLoader -s State1
+11 -9
View File
@@ -1,14 +1,16 @@
#!/bin/bash #!/bin/bash
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:. # Get the directory of this script
export MARTe2_DIR=/home/martino/Projects/marte_debug/dependency/MARTe2 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
export TARGET=x86-linux source $DIR/env.sh
echo "Cleaning up old instances..." echo "Cleaning up old instances..."
pkill -9 IntegrationTest pkill -9 IntegrationTests
pkill -9 ValidationTest pkill -9 UnitTests
pkill -9 SchedulerTest sleep 1
pkill -9 main
sleep 2
echo "Starting MARTe2 Unit Tests..."
$DIR/Build/$TARGET/Test/UnitTests/UnitTests/UnitTests.ex
echo ""
echo "Starting MARTe2 Integration Tests..." echo "Starting MARTe2 Integration Tests..."
./Build/Test/Integration/ValidationTest $DIR/Build/$TARGET/Test/Integration/Integration/IntegrationTests.ex
+67
View File
@@ -0,0 +1,67 @@
#!/bin/bash
# run_debug_app.sh - Launch the MARTe2 Debugging Environment using standard MARTeApp.ex
# 1. Environment Setup
if [ -f "./env.sh" ]; then
source ./env.sh
else
echo "ERROR: env.sh not found. Ensure you are in the project root."
exit 1
fi
# 2. Paths
MARTE_EX="${MARTe2_DIR}/Build/${TARGET}/App/MARTeApp.ex"
BUILD_DIR="$(pwd)/Build/${TARGET}"
# Our plugin libraries
WEB_DEBUG_LIB="${BUILD_DIR}/Components/Interfaces/WebDebugService/libWebDebugService.so"
TCPLOGGER_LIB="${BUILD_DIR}/Components/Interfaces/TCPLogger/libTcpLogger.so"
# Component library base search path
COMPONENTS_BUILD_DIR="${MARTe2_Components_DIR}/Build/${TARGET}/Components"
# DYNAMICALLY FIND ALL COMPONENT DIRS and add to LD_LIBRARY_PATH
ALL_COMPONENT_DIRS=$(find "$COMPONENTS_BUILD_DIR" -type d)
for dir in $ALL_COMPONENT_DIRS; do
if ls "$dir"/*.so >/dev/null 2>&1; then
export LD_LIBRARY_PATH="$dir:$LD_LIBRARY_PATH"
fi
done
# Ensure our build dir and core dir are included
export LD_LIBRARY_PATH="${BUILD_DIR}/Components/Interfaces/WebDebugService:${BUILD_DIR}/Components/Interfaces/TCPLogger:${MARTe2_DIR}/Build/${TARGET}/Core:${LD_LIBRARY_PATH}"
# 3. Cleanup
echo "Cleaning up lingering processes..."
pkill -9 MARTeApp.ex
sleep 1
# 4. Validate libraries exist
for lib in "$WEB_DEBUG_LIB" "$TCPLOGGER_LIB"; do
if [ ! -f "$lib" ]; then
echo "ERROR: Library not found: $lib"
echo "Run: make -f Makefile.gcc core"
exit 1
fi
done
# 5. Launch Application
echo "Launching standard MARTeApp.ex with webdebug_test.cfg (WebDebugService on port 8090)..."
# LD_PRELOAD ensures our classes are registered before the config is parsed.
# MARTeApp.ex does not use dlopen for plugins — preloading is the standard approach.
# All required component .so files are collected via the find loop into LD_PRELOAD too.
PRELOAD_LIBS="${WEB_DEBUG_LIB}:${TCPLOGGER_LIB}"
# Collect any additional component .so files referenced by the config
for lib in \
"${COMPONENTS_BUILD_DIR}/DataSources/RealTimeThreadSynchronisation/RealTimeThreadSynchronisation.so" \
"${COMPONENTS_BUILD_DIR}/DataSources/LinuxTimer/LinuxTimer.so" \
"${COMPONENTS_BUILD_DIR}/DataSources/LoggerDataSource/LoggerDataSource.so" \
"${COMPONENTS_BUILD_DIR}/GAMs/IOGAM/IOGAM.so"; do
if [ -f "$lib" ]; then
PRELOAD_LIBS="${PRELOAD_LIBS}:${lib}"
fi
done
export LD_PRELOAD="${PRELOAD_LIBS}"
"$MARTE_EX" -f Test/Configurations/webdebug_test.cfg -l RealTimeLoader -s State1
-41
View File
@@ -1,41 +0,0 @@
Project Specification: MARTe2 Universal Observability & Debugging Suite
Version: 1.1
Date: 2023-10-27
Status: Active / Implemented
1. Executive Summary
This project implements a "Zero-Code-Change" observability and debugging layer for the MARTe2 real-time framework. The system allows developers to Trace, Force, and Monitor any signal in a running MARTe2 application without modifying existing source code.
2. System Architecture
- The Universal Debug Service (C++ Core): A singleton MARTe2 Object that patches the registry and manages communication.
- The Broker Injection Layer (C++ Templates): Templated wrappers that intercept Copy() calls for tracing, forcing, and execution control.
- The Remote Analyser (Rust/egui): A high-performance, multi-threaded GUI for visualization and control.
3. Functional Requirements
3.1 Execution Control
- REQ-25: Execution Control (Pause/Resume): The system SHALL provide a mechanism to pause and resume the execution of all patched real-time threads (via Brokers), allowing for static inspection of the system state.
3.2 Discovery
- REQ-24: Tree Exploration: The GUI client SHALL request the full application tree upon connection and display it in a hierarchical tree view.
- TREE Command: Returns a recursive JSON structure representing the entire application tree, including signal metadata (Type, Dimensions, Elements).
3.3 Multi-Threaded Client (REQ-23)
- Port 8080 (TCP): Commands and Metadata.
- Port 8082 (TCP): Independent Real-Time Log Stream.
- Port 8081 (UDP): High-Speed Telemetry for Oscilloscope.
4. Communication Protocol
- LS [Path]: List nodes.
- TREE: Full recursive JSON application map.
- PAUSE / RESUME: Execution control.
- TRACE <Signal> <1/0> [Decimation]: Telemetry control.
- FORCE <Signal> <Value>: Persistent signal override.
- UNFORCE <Signal>: Remove override.
- LOG <Level> <Msg>: Port 8082 streaming format.
+52
View File
@@ -0,0 +1,52 @@
#!/usr/bin/env python3
import socket
import time
import subprocess
import os
import signal
# Start server
print("Starting server...")
proc = subprocess.Popen(
["./run_debug_app.sh"],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
cwd="/home/martino/Projects/marte_debug",
env=os.environ,
)
time.sleep(5) # Wait for server to start
print("Connecting to server...")
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.settimeout(3)
s.connect(("127.0.0.1", 8080))
# Send TREE
s.sendall(b"TREE\n")
print("Sent TREE")
# Send DISCOVER immediately (like GUI does)
s.sendall(b"DISCOVER\n")
print("Sent DISCOVER")
# Wait and read
time.sleep(1)
data = b""
while True:
try:
chunk = s.recv(4096)
if not chunk:
break
data += chunk
except:
break
print(f"Got {len(data)} bytes")
print("Contains OK TREE:", b"OK TREE" in data)
print("Contains OK DISCOVER:", b"OK DISCOVER" in data)
s.close()
proc.terminate()
proc.wait()
print("Done")