leonarski_fandClaude Opus 5
41983ca589
A writer refusing to overwrite an existing file was reported badly, and the
earlier fix only covered half of it. The commit message of a6a715703 states the
assumption that broke: "SendStartMessage precedes every std::async in the
receiver constructor". That is true of JFJochReceiverFPGA, where the start
message goes out from the constructor body, and false of JFJochReceiverLite,
where it goes out from MeasurementThread - launched by std::async from the
constructor, which waits only on data_analysis_started. On the DECTRIS path the
writer's refusal therefore cannot reach services.Start(); it arrives from
services.Stop(), i.e. the second try-block of the state machine's
MeasurementThread, which never touched start_exception. /wait_till_done answered
200 for a run that never wrote anything.
Two changes, in front of the problem and behind it.
In front: a PREFLIGHT frame (TCP protocol version 3 -> 4), sent to every writer
before the receiver is built and before the detector is armed. It carries the
same CBOR start message a START does and asks one question: could this run be
written? The writer runs FileWriter::Preflight - the first three statements of
the FileWriter constructor, stopping short of the only one that creates
anything - and answers with an ACK. Shared code, so a pre-flight that passes
cannot be contradicted by the start behind it. A refusal is not fatal: nothing
was started, the connection stays usable, and above all no series is left armed
waiting for a trigger that will not come. Both ends already reject a frame of
another protocol version, so the bump costs no compatibility.
The check now covers the data files, not only the master. A stale
_data_000001.h5 used to sail through and fail when the file was renamed into
place at the end of the run, after the whole dataset had been collected. The
writer holding the master file checks for all of them - they share a directory
by construction, the master linking them by relative name - so the siblings do
not race each other statting files the others are creating.
Behind: /wait_till_done maps an Idle state to 200 or 500 by the severity of the
end-of-run message, so a collection that lost packets, or whose writer could not
write, is no longer indistinguishable from a good one to a script. A cancelled
collection is not affected - MeasurementThread checks the cancel before it looks
at the completeness of the data, and reports it with Info severity - and a
warning is still a 200. start_exception is untouched.
The PREFLIGHT payload is built from FillMessage alone, which is what keeps it
small: the per-pixel arrays are added by SendStartMessage and are not in it.
Measured on a JUNGFRAU 9M, 1.4 kB against 543 kB for the start message. It is
deliberately the whole of FillMessage rather than the fields the check reads
today - a hand-picked subset would answer for a different set of file names the
day the check learns to read one more field, and would do it silently.
Three defects found on the way:
TCPImagePuller republished a PREFLIGHT as a real start message, announcing to
downstream consumers a run that was not going to happen.
TCPStreamPusher::run_number was a plain uint64_t written by the control thread
and read by every ACK thread; Preflight adds a second writer to it.
StreamWriter::CollectImages reprocessed the last frame whenever WaitForImage
returned false - run is only tested at the top of the loop - so an abort wrote
the last image a second time. Pre-existing; the new branch made it visible.
Verified against a running broker on the local configuration: a colliding master
file and a colliding data file are both refused by /start, /wait_until_running
and /wait_till_done with the writer's own message, and the log shows the receiver
was never started for either; a cancelled collection still answers 200.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016WmryXe8ASbNi632sUMfsa
81 lines
2.5 KiB
C++
81 lines
2.5 KiB
C++
// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
|
|
// SPDX-License-Identifier: GPL-3.0-only
|
|
|
|
#pragma once
|
|
|
|
#include <future>
|
|
|
|
#include "../common/Logger.h"
|
|
#include "../image_puller/ImagePuller.h"
|
|
#include "HDF5DataFile.h"
|
|
#include "FileWriter.h"
|
|
|
|
enum class StreamWriterState {Idle, Started, Receiving, Error, Finalized};
|
|
|
|
struct StreamWriterStatistics {
|
|
uint64_t processed_images;
|
|
float performance_MBs;
|
|
float performance_Hz;
|
|
std::string file_prefix;
|
|
std::string run_name;
|
|
uint64_t run_number;
|
|
uint64_t socket_number;
|
|
StreamWriterState state;
|
|
size_t max_puller_fifo_utilization;
|
|
};
|
|
|
|
struct StreamWriterOutput {
|
|
StreamWriterStatistics stats;
|
|
std::vector<HDF5DataFileStatistics> data_file_stats;
|
|
};
|
|
|
|
class StreamWriter {
|
|
std::atomic<bool> abort = false;
|
|
const bool verbose;
|
|
std::string file_done_address;
|
|
|
|
StreamWriterState state = StreamWriterState::Idle;
|
|
|
|
ImagePullerOutput image_puller_output;
|
|
std::unique_ptr<FileWriter> file_writer;
|
|
|
|
std::atomic<uint64_t> processed_images;
|
|
std::atomic<uint64_t> processed_image_size;
|
|
std::chrono::time_point<std::chrono::system_clock> start_time;
|
|
std::chrono::time_point<std::chrono::system_clock> end_time;
|
|
std::string file_prefix;
|
|
std::string run_name;
|
|
uint64_t run_number;
|
|
uint64_t socket_number;
|
|
uint64_t max_image_number;
|
|
std::string writer_notification_zmq_addr;
|
|
std::string err;
|
|
bool mute_data_msg_in_idle = false;
|
|
std::vector<HDF5DataFileStatistics> hdf5_data_file_statistics;
|
|
|
|
bool debug_skip_write_notification = false;
|
|
bool tcp_data_fatal_sent = false;
|
|
|
|
ImagePuller &image_puller;
|
|
Logger &logger;
|
|
void CollectImages();
|
|
bool WaitForImage();
|
|
void NotifyReceiverOnFinalizedWrite(const std::string &detector_update_zmq_addr);
|
|
void NotifyTcpAck(TCPFrameType ack_for, bool ok, bool fatal, TCPAckCode code, const std::string &error_text = "");
|
|
void ProcessStartMessage();
|
|
void ProcessPreflight();
|
|
void ProcessEndMessage();
|
|
void ProcessDataImage();
|
|
void ProcessCalibrationImage();
|
|
void FinalizeDataCollection();
|
|
public:
|
|
StreamWriter(Logger &in_logger,
|
|
ImagePuller &in_image_puller,
|
|
std::string in_file_done_address = "",
|
|
bool verbose = false);
|
|
StreamWriterOutput Run();
|
|
void Cancel();
|
|
StreamWriterStatistics GetStatistics() const;
|
|
void DebugSkipWriteNotification(bool input);
|
|
};
|