Files
Jungfraujoch/rugnux/BrokerFeed.cpp
T
leonarski_fandFilip Leonarski 19b135186d
Build Packages / Create release (push) Successful in 7s
Build Packages / build:portable:macos-arm64:nocuda (push) Successful in 4m56s
Build Packages / build:rugnux:linux-aarch64:cuda (push) Successful in 9m10s
Build Packages / build:portable:linux-x86_64:nocuda (push) Successful in 13m51s
Build Packages / build:portable:linux-x86_64:cuda (push) Successful in 16m56s
Build Packages / build:jfjoch:rocky8:nocuda (push) Successful in 20m59s
Build Packages / build:portable:windows-x86_64:nocuda (push) Successful in 21m25s
Build Packages / build:jfjoch:rocky9:nocuda (push) Successful in 21m17s
Build Packages / build:jfjoch:ubuntu2204:nocuda (push) Successful in 14m14s
Build Packages / HDF5 consumer tests (DIALS, XDS) (push) Successful in 25m59s
Build Packages / build:portable:windows-x86_64:cuda (push) Successful in 25m48s
Build Packages / build:jfjoch:ubuntu2404:nocuda (push) Successful in 15m52s
Build Packages / build:jfjoch:rocky8:cuda-sls9 (push) Successful in 19m33s
Build Packages / Generate python client (push) Successful in 29s
Build Packages / Build documentation (push) Successful in 1m19s
Build Packages / build:jfjoch:ubuntu2204:cuda (push) Successful in 20m49s
Build Packages / build:jfjoch:rocky9:cuda-sls9 (push) Successful in 25m31s
Build Packages / build:jfjoch:rocky8:cuda (push) Successful in 25m24s
Build Packages / build:jfjoch:rocky9:cuda (push) Successful in 26m5s
Build Packages / build:jfjoch:ubuntu2404:cuda (push) Successful in 22m19s
Build Packages / Unit tests (push) Failing after 2h28m24s
Build Packages / Validation Battery (push) Successful in 40m33s
v1.0.0-rc.175 (#85)
* Rugnux: Processes a collection live while jfjoch_broker writes it (`rugnux <master.h5> <broker URL>`).
* Rugnux: Processing starts on the first images and confirms its choices once all are in, so analysis can begin during collection.
* Rugnux: Faster processing, especially on servers with several GPUs and CPU sockets and on computers without a GPU (`--no-gpu`, macOS).
* Rugnux: Uses much less GPU memory, so large data sets stay on the GPU of smaller cards, and a data set too large for the card is processed on the CPU instead.
* Rugnux: On macOS, Bragg integration runs on the Apple GPU.
* Rugnux: Better handling of twinning and pseudo-symmetry, with the twin hypothesis written as `<prefix>_twin_<SG>.mtz`, and a wrong `--model` no longer confirms the data or decides the hand.
* Rugnux: `--model` accepts predicted (AlphaFold) models and falls back to molecular replacement when the model is not placed as a rigid body (experimental `--mr` forces it), settling space group, hand and twinning and writing a different answer as `<prefix>_mr.mtz`.
* Rugnux: Molecular replacement is faster and settles the space group in more cases with several copies in the asymmetric unit.
* Rugnux: Deposition-ready mmCIF, a richer report, and numbered steps on the terminal with the full log in `<prefix>_log.txt`; `_P1.mtz`, `--estimate-beam-center` and `--beam-center-search` are removed.
* Rugnux: The beam-stop shadow is found correctly on tilted detectors.
* Rugnux: Stills files that record a stationary goniometer axis get the default stills geometry refinement.
* jfjoch_viewer: "Analyze dataset" uses the same defaults as a bare `rugnux <file>`, and shows the results of processed CBF, marCCD and SMV sweeps.
* jfjoch_viewer: The Files panel refreshes on F5 and every few seconds, and the plot type and other selections stay put during live collection.
* jfjoch_writer: Memory stays bounded and old data files are closed efficiently on long runs, any failure ends the run in an error state the broker is told about, and the master file appears only after its data files; the ZeroMQ pusher logs when a stalled writer makes it drop images.
* Fixes: The TCP image pusher no longer blocks the broker's receiver, GPU out-of-memory failures stop with a clear message, and the XDS plugin masks module and chip edges.

---------

Co-authored-by: Filip Leonarski <jungfrau@filips-mac-mini.home>
Reviewed-on: #85
Co-authored-by: Filip Leonarski <filip.leonarski@psi.ch>
2026-10-16 15:34:43 +02:00

172 lines
6.8 KiB
C++

// SPDX-FileCopyrightText: 2026 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
#include "BrokerFeed.h"
#include <base64/Base64.h>
#include <httplib.h>
#include <nlohmann/json.hpp>
#include "../common/JFJochException.h"
#include "../common/Logger.h"
#include "../frame_serialize/CBORStream2Deserializer.h"
std::vector<ServerSentEvent> ServerSentEventParser::Feed(const char *bytes, size_t size) {
pending.append(bytes, size);
std::vector<ServerSentEvent> events;
size_t end;
while ((end = pending.find("\n\n")) != std::string::npos) {
const std::string block = pending.substr(0, end);
pending.erase(0, end + 2);
ServerSentEvent e;
size_t pos = 0;
while (pos <= block.size()) {
size_t eol = block.find('\n', pos);
if (eol == std::string::npos)
eol = block.size();
const std::string line = block.substr(pos, eol - pos);
if (line.starts_with("event: "))
e.event = line.substr(7);
else if (line.starts_with("data: "))
e.data = line.substr(6);
pos = eol + 1;
}
if (!e.event.empty())
events.push_back(std::move(e));
}
return events;
}
namespace {
httplib::Headers Authorization(const std::string &token) {
return {{"Authorization", "Bearer " + token}};
}
std::vector<uint8_t> DecodeBase64(const std::string &s) {
size_t n = s.size() / 4 * 3;
if (!s.empty() && s.back() == '=')
n--;
if (s.size() > 1 && s[s.size() - 2] == '=')
n--;
std::vector<uint8_t> out(n);
macaron::Decode(s, out);
return out;
}
}
BrokerFeed::BrokerFeed(const std::string &url, std::string in_token) : token(std::move(in_token)) {
if (url.starts_with("https://"))
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
"Following a collection over https is not supported by this build - use http://");
if (!url.starts_with("http://"))
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
"The broker address must start with http://");
const size_t path = url.find('/', 7);
host = url.substr(0, path);
if (host.find('@') != std::string::npos)
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
"The broker address must not carry credentials");
if (path != std::string::npos)
prefix = url.substr(path);
while (prefix.ends_with('/'))
prefix.pop_back();
thread = std::thread([this] { Run(); });
}
BrokerFeed::~BrokerFeed() {
stop = true;
if (thread.joinable())
thread.join();
}
StartMessage BrokerFeed::WaitForStart() {
std::unique_lock ul(m);
cv.wait(ul, [&] { return start.has_value() || done; });
if (start)
return start.value();
throw JFJochException(JFJochExceptionCategory::InputParameterInvalid,
lost.empty() ? "The broker at " + host + " sent no start message" : lost);
}
void BrokerFeed::Attach(JFJochStartMessageReader &in_reader) {
std::unique_lock ul(m);
reader = &in_reader;
for (const auto &[file_number, images]: files)
reader->FileClosed(file_number, images);
if (ended)
reader->Ended();
else if (done)
reader->Lost(lost);
}
void BrokerFeed::Run() {
Logger logger("BrokerFeed");
httplib::Client client(host);
// The broker writes at least a keepalive every 10 s; three missed ones mean it is gone.
client.set_read_timeout(std::chrono::seconds(30));
ServerSentEventParser parser;
int status = 0;
std::string error;
client.Get(prefix + "/live/events", Authorization(token),
[&](const httplib::Response &response) {
status = response.status;
return status == 200;
},
[&](const char *data, size_t size) {
for (const auto &e: parser.Feed(data, size)) {
const auto j = nlohmann::json::parse(e.data);
std::unique_lock ul(m);
if (e.event == "start") {
auto msg = CBORStream2Deserialize(DecodeBase64(j.at("cbor").get<std::string>()));
if (msg && msg->start_message)
start = msg->start_message.value();
else
error = "the broker sent no readable start message";
} else if (e.event == "file") {
files.emplace_back(j.at("file_number").get<uint64_t>(), j.at("image_count").get<uint64_t>());
if (reader)
reader->FileClosed(files.back().first, files.back().second);
} else if (e.event == "end") {
if (j.contains("error"))
logger.Warning("The collection ended with an error: {}", j.at("error").get<std::string>());
if (!start)
error = "The collection at " + host + " ended before it started"
+ (j.contains("error") ? ": " + j.at("error").get<std::string>() : "");
else {
logger.Info("The collection ended with {} images in {} data files",
j.at("images").get<uint64_t>(), files.size());
ended = true;
}
} else if (e.event == "superseded") {
error = "a new collection began before this one ended";
}
cv.notify_all();
if (!error.empty())
return false;
}
return !stop;
});
std::unique_lock ul(m);
if (!ended) {
if (!error.empty())
lost = error;
else if (status == 401)
lost = "Following the collection at " + host + ": the broker refused the token in JUNGFRAUJOCH_HTTP_TOKEN";
else if (status == 404)
lost = "No collection to follow at " + host;
else if (status == 409)
lost = "Following the collection at " + host + ": another reader is following it, or its writer "
"does not report closed data files";
else if (status != 200)
lost = "No answer from the broker at " + host;
else
lost = "Lost the broker at " + host + " before the collection ended";
if (reader)
reader->Lost(lost);
} else if (reader)
reader->Ended();
done = true;
cv.notify_all();
}