mx/Jungfraujoch
3
2 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 92 Wiki Activity
Files
rc184
Jungfraujoch/tests/ImageBufferTest.cpp
T
leonarski_fandClaude Opus 5.5 9137f28939 ImageBuffer::GetSlotStatus: the slot counters without scanning the buffer, for every image 
JFJochReceiverFPGA and JFJochReceiverRugnuxStills read three slot counters for each image through
GetStatus, which walks every slot under the buffer mutex, lists the image numbers and sorts them. With a
buffer sized for 2 kHz (thousands of slots) that is about a core of CPU and time on the mutex every
other buffer user needs. GetSlotStatus returns only the counters; GetStatus stays for the HTTP status.

On rc184 the per-image readers are JFJochReceiverFPGA's FrameTransformationThread and its GPUSink (the live-stills path).

(ported from rc184-2 4907014e4)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HVeDQsU5a8AJUdJPgWevAK
2026-11-08 20:08:00 +01:00

339 lines
10 KiB
C++
Raw Permalink Blame History

// SPDX-FileCopyrightText: 2024 Filip Leonarski, Paul Scherrer Institute <filip.leonarski@psi.ch>
// SPDX-License-Identifier: GPL-3.0-only
#include <catch2/catch_all.hpp>
#include "../common/ImageBuffer.h"
#include "../common/ZeroCopyReturnValue.h"
TEST_CASE("ImageBuffer_Location size") {
ImageBuffer buf(2*1024*1024);
REQUIRE_THROWS(buf.StartMeasurement(4 * 1024 * 1024));
REQUIRE_NOTHROW(buf.StartMeasurement(1024 * 1024));
REQUIRE(buf.GetStatus().total_slots == 2);
REQUIRE(buf.GetStatus().available_slots == 2);
}
TEST_CASE("ImageBuffer") {
DiffractionExperiment experiment(DetJF(18,3,8,36));
ImageBuffer buf_ctrl(4*experiment.GetImageBufferLocationSize());
buf_ctrl.StartMeasurement(experiment);
REQUIRE(buf_ctrl.GetAvailSlots() == 4);
ZeroCopyReturnValue *ret0 = buf_ctrl.GetImageSlot();
REQUIRE(ret0 != nullptr);
REQUIRE(buf_ctrl.GetAvailSlots() == 3);
ZeroCopyReturnValue *ret1 = buf_ctrl.GetImageSlot();
REQUIRE(ret1 != nullptr);
ZeroCopyReturnValue *ret2 = buf_ctrl.GetImageSlot();
REQUIRE(ret2 != nullptr);
ZeroCopyReturnValue *ret3 = buf_ctrl.GetImageSlot();
REQUIRE(ret3 != nullptr);
REQUIRE(buf_ctrl.GetAvailSlots() == 0);
ZeroCopyReturnValue *ret4 = buf_ctrl.GetImageSlot();
REQUIRE(ret4 == nullptr);
REQUIRE(buf_ctrl.GetStatus().preparation_slots == 4);
REQUIRE(buf_ctrl.GetStatus().sending_slots == 0);
REQUIRE(buf_ctrl.GetStatus().available_slots == 0);
ret0->ReadyToSend();
ret1->ReadyToSend();
REQUIRE(buf_ctrl.GetStatus().preparation_slots == 2);
REQUIRE(buf_ctrl.GetStatus().sending_slots == 2);
REQUIRE(buf_ctrl.GetStatus().available_slots == 0);
REQUIRE(buf_ctrl.GetSlotStatus().total_slots == 4);
REQUIRE(buf_ctrl.GetSlotStatus().preparation_slots == 2);
REQUIRE(buf_ctrl.GetSlotStatus().sending_slots == 2);
REQUIRE(buf_ctrl.GetSlotStatus().available_slots == 0);
ret2->ReadyToSend();
ret3->ReadyToSend();
REQUIRE(buf_ctrl.GetStatus().preparation_slots == 0);
REQUIRE(buf_ctrl.GetStatus().sending_slots == 4);
REQUIRE(buf_ctrl.GetStatus().available_slots == 0);
ret0->release();
ret1->release();
ret2->release();
ret3->release();
REQUIRE(buf_ctrl.GetStatus().available_slots == 4);
REQUIRE(buf_ctrl.GetAvailSlots() == 4);
REQUIRE(buf_ctrl.CheckIfBufferReturned(std::chrono::microseconds(1)));
}
TEST_CASE("ImageBuffer_Preview_Access") {
DiffractionExperiment experiment(DetJF(18,3,8,36));
ImageBuffer buf_ctrl(4*experiment.GetImageBufferLocationSize());
buf_ctrl.StartMeasurement(experiment);
REQUIRE(buf_ctrl.GetAvailSlots() == 4);
ZeroCopyReturnValue *ret0 = buf_ctrl.GetImageSlot();
REQUIRE(ret0 != nullptr);
ret0->SetImageNumber(0);
ret0->release();
ZeroCopyReturnValue *ret1 = buf_ctrl.GetImageSlot();
REQUIRE(ret1 != nullptr);
ret1->SetImageNumber(1);
ret1->release();
ZeroCopyReturnValue *ret2 = buf_ctrl.GetImageSlot();
REQUIRE(ret2 != nullptr);
ret2->SetImageNumber(2);
ret2->SetImageSize(3456);
ret2->SetIndexed(true);
ret2->release();
ZeroCopyReturnValue *ret3 = buf_ctrl.GetImageSlot();
REQUIRE(ret3 != nullptr);
ret3->SetImageNumber(15);
ret3->SetImageSize(1234);
ret3->SetIndexed(false);
ret3->release();
REQUIRE(buf_ctrl.GetAvailSlots() == 4);
auto v = buf_ctrl.GetStatus().images_in_the_buffer;
REQUIRE(v.size() == 4);
REQUIRE(v[0] == 0);
REQUIRE(v[3] == 15);
std::vector<uint8_t> image_2, image_2_2, image_12, image_max, image_max_indexed;
REQUIRE(buf_ctrl.GetImage(image_2, 2));
REQUIRE(image_2.size() == 3456);
REQUIRE(!buf_ctrl.GetImage(image_12, 12));
REQUIRE(buf_ctrl.Finalize(std::chrono::microseconds(1)));
// After finalize was run, there should be no preview
REQUIRE(!buf_ctrl.GetImage(image_2_2, 2));
}
TEST_CASE("ImageBuffer_Counter") {
DiffractionExperiment experiment(DetJF(18,3,8,36));
ImageBuffer buf_ctrl(4*experiment.GetImageBufferLocationSize());
auto cnt_1 = buf_ctrl.GetStatus().current_counter;
buf_ctrl.StartMeasurement(experiment);
auto cnt_2 = buf_ctrl.GetStatus().current_counter;
ZeroCopyReturnValue *ret0 = buf_ctrl.GetImageSlot();
REQUIRE(ret0 != nullptr);
ret0->SetImageNumber(0);
ret0->ReadyToSend();
auto cnt_3 = buf_ctrl.GetStatus().current_counter;
ZeroCopyReturnValue *ret1 = buf_ctrl.GetImageSlot();
REQUIRE(ret1 != nullptr);
ret1->SetImageNumber(1);
ret1->ReadyToSend();
auto cnt_4 = buf_ctrl.GetStatus().current_counter;
ret0->release();
ret1->release();
REQUIRE(buf_ctrl.Finalize(std::chrono::microseconds(1)));
auto cnt_5 = buf_ctrl.GetStatus().current_counter;
CHECK(cnt_1 != cnt_2);
CHECK(cnt_1 != cnt_3);
CHECK(cnt_1 != cnt_4);
CHECK(cnt_1 != cnt_5);
CHECK(cnt_2 != cnt_3);
CHECK(cnt_2 != cnt_4);
CHECK(cnt_2 != cnt_5);
CHECK(cnt_3 != cnt_4);
CHECK(cnt_3 != cnt_5);
CHECK(cnt_4 != cnt_5);
}
TEST_CASE("ImageBuffer_Preview_Access_GetImage_MaxImage") {
DiffractionExperiment experiment(DetJF(18,3,8,36));
ImageBuffer buf_ctrl(4*experiment.GetImageBufferLocationSize());
buf_ctrl.StartMeasurement(experiment);
REQUIRE(buf_ctrl.GetAvailSlots() == 4);
ZeroCopyReturnValue *ret0 = buf_ctrl.GetImageSlot();
REQUIRE(ret0 != nullptr);
ret0->SetImageNumber(0);
ret0->release();
ZeroCopyReturnValue *ret1 = buf_ctrl.GetImageSlot();
REQUIRE(ret1 != nullptr);
ret1->SetImageNumber(1);
ret1->release();
ZeroCopyReturnValue *ret2 = buf_ctrl.GetImageSlot();
REQUIRE(ret2 != nullptr);
ret2->SetImageNumber(2);
ret2->SetImageSize(3456);
ret2->SetIndexed(true);
ret2->release();
ZeroCopyReturnValue *ret3 = buf_ctrl.GetImageSlot();
REQUIRE(ret3 != nullptr);
ret3->SetImageNumber(15);
ret3->SetImageSize(1234);
ret3->SetIndexed(false);
ret3->release();
std::vector<uint8_t> image_max, image_max_indexed;
REQUIRE(buf_ctrl.GetImage(image_max, ImageBuffer::MaxImage));
REQUIRE(image_max.size() == 1234);
REQUIRE(buf_ctrl.GetImage(image_max_indexed, ImageBuffer::MaxIndexedImage));
REQUIRE(image_max_indexed.size() == 3456);
REQUIRE(buf_ctrl.Finalize(std::chrono::microseconds(1)));
}
TEST_CASE("ImageBuffer_Restart") {
DiffractionExperiment experiment(DetJF(18,3,8,36));
ImageBuffer buf_ctrl(4*experiment.GetImageBufferLocationSize());
buf_ctrl.StartMeasurement(experiment);
ZeroCopyReturnValue *ret0 = buf_ctrl.GetImageSlot();
REQUIRE(ret0 != nullptr);
ret0->SetImageNumber(0);
ret0->release();
REQUIRE(buf_ctrl.GetStatus().images_in_the_buffer.size() == 1);
// Restart measurement
REQUIRE_NOTHROW(buf_ctrl.StartMeasurement(experiment));
REQUIRE(buf_ctrl.GetAvailSlots() == 4);
REQUIRE(buf_ctrl.GetStatus().images_in_the_buffer.empty());
ret0 = buf_ctrl.GetImageSlot();
REQUIRE(ret0 != nullptr);
ret0->SetImageNumber(0);
ret0->release();
REQUIRE_NOTHROW(buf_ctrl.StartMeasurement(experiment));
}
TEST_CASE("ImageBuffer_BuffersNotReturned") {
DiffractionExperiment experiment(DetJF(18,3,8,36));
ImageBuffer buf_ctrl(4*experiment.GetImageBufferLocationSize());
buf_ctrl.StartMeasurement(experiment);
REQUIRE(buf_ctrl.GetAvailSlots() == 4);
ZeroCopyReturnValue *ret0 = buf_ctrl.GetImageSlot();
REQUIRE(ret0 != nullptr);
REQUIRE(buf_ctrl.GetAvailSlots() == 3);
REQUIRE(!buf_ctrl.CheckIfBufferReturned(std::chrono::microseconds(1)));
}
TEST_CASE("ImageBuffer_SlotReuse") {
DiffractionExperiment experiment(DetJF(18,3,8,36));
// Only 1 slot so reuse is guaranteed
ImageBuffer buf_ctrl(experiment.GetImageBufferLocationSize());
buf_ctrl.StartMeasurement(experiment);
REQUIRE(buf_ctrl.GetStatus().total_slots == 1);
REQUIRE(buf_ctrl.GetAvailSlots() == 1);
// First cycle: acquire -> ReadyToSend -> release
ZeroCopyReturnValue *ret = buf_ctrl.GetImageSlot();
REQUIRE(ret != nullptr);
REQUIRE(buf_ctrl.GetAvailSlots() == 0);
ret->SetImageNumber(0);
ret->SetImageSize(100);
ret->SetIndexed(false);
ret->ReadyToSend();
REQUIRE(buf_ctrl.GetStatus().sending_slots == 1);
REQUIRE(buf_ctrl.GetStatus().preparation_slots == 0);
ret->release();
REQUIRE(buf_ctrl.GetAvailSlots() == 1);
REQUIRE(buf_ctrl.GetStatus().sending_slots == 0);
// Second cycle: reuse the same slot — this is where the bug manifested
ZeroCopyReturnValue *ret2 = buf_ctrl.GetImageSlot();
REQUIRE(ret2 != nullptr);
REQUIRE(buf_ctrl.GetAvailSlots() == 0);
REQUIRE(buf_ctrl.GetStatus().preparation_slots == 1);
ret2->SetImageNumber(1);
ret2->SetImageSize(200);
ret2->SetIndexed(true);
REQUIRE_NOTHROW(ret2->ReadyToSend());
REQUIRE(buf_ctrl.GetStatus().sending_slots == 1);
REQUIRE(buf_ctrl.GetStatus().preparation_slots == 0);
REQUIRE_NOTHROW(ret2->release());
REQUIRE(buf_ctrl.GetAvailSlots() == 1);
REQUIRE(buf_ctrl.GetStatus().sending_slots == 0);
// Third cycle: verify it keeps working
ZeroCopyReturnValue *ret3 = buf_ctrl.GetImageSlot();
REQUIRE(ret3 != nullptr);
ret3->SetImageNumber(2);
ret3->SetImageSize(300);
ret3->SetIndexed(false);
REQUIRE_NOTHROW(ret3->ReadyToSend());
REQUIRE_NOTHROW(ret3->release());
REQUIRE(buf_ctrl.GetAvailSlots() == 1);
REQUIRE(buf_ctrl.Finalize(std::chrono::microseconds(1)));
}
TEST_CASE("ImageBuffer_SlotReuse_ReleaseFromInPreparation") {
DiffractionExperiment experiment(DetJF(18,3,8,36));
ImageBuffer buf_ctrl(experiment.GetImageBufferLocationSize());
buf_ctrl.StartMeasurement(experiment);
// First cycle: acquire -> release directly (skipping explicit ReadyToSend)
ZeroCopyReturnValue *ret = buf_ctrl.GetImageSlot();
REQUIRE(ret != nullptr);
ret->SetImageNumber(0);
ret->SetImageSize(100);
ret->release();
REQUIRE(buf_ctrl.GetAvailSlots() == 1);
// Second cycle: reuse after release-from-InPreparation path
ZeroCopyReturnValue *ret2 = buf_ctrl.GetImageSlot();
REQUIRE(ret2 != nullptr);
ret2->SetImageNumber(1);
ret2->SetImageSize(200);
REQUIRE_NOTHROW(ret2->ReadyToSend());
REQUIRE_NOTHROW(ret2->release());
REQUIRE(buf_ctrl.GetAvailSlots() == 1);
REQUIRE(buf_ctrl.Finalize(std::chrono::microseconds(1)));
}
Reference in new issue View Git Blame Copy Permalink