{"id":15145,"url":"https://patchwork.libcamera.org/api/patches/15145/?format=json","web_url":"https://patchwork.libcamera.org/patch/15145/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20211211165714.23067-11-jacopo@jmondi.org>","date":"2021-12-11T16:57:13","name":"[libcamera-devel,v6,10/11] test: fence: Add test for the Fence class","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"baec991231d9bd24327fb283eab3761ed12440ea","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/?format=json","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/15145/mbox/","series":[{"id":2838,"url":"https://patchwork.libcamera.org/api/series/2838/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=2838","date":"2021-12-11T16:57:03","name":"libcamera: Add Fence support","version":6,"mbox":"https://patchwork.libcamera.org/series/2838/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/15145/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/15145/checks/","tags":{},"headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 50FD4C3259\n\tfor <parsemail@patchwork.libcamera.org>;\n\tSat, 11 Dec 2021 16:56:39 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id E5893608A4;\n\tSat, 11 Dec 2021 17:56:38 +0100 (CET)","from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net\n\t[217.70.183.200])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id CD1A56089D\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tSat, 11 Dec 2021 17:56:32 +0100 (CET)","(Authenticated sender: jacopo@jmondi.org)\n\tby relay7-d.mail.gandi.net (Postfix) with ESMTPSA id 236252000B;\n\tSat, 11 Dec 2021 16:56:31 +0000 (UTC)"],"From":"Jacopo Mondi <jacopo@jmondi.org>","To":"libcamera-devel@lists.libcamera.org","Date":"Sat, 11 Dec 2021 17:57:13 +0100","Message-Id":"<20211211165714.23067-11-jacopo@jmondi.org>","X-Mailer":"git-send-email 2.33.1","In-Reply-To":"<20211211165714.23067-1-jacopo@jmondi.org>","References":"<20211211165714.23067-1-jacopo@jmondi.org>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH v6 10/11] test: fence: Add test for the\n\tFence class","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"},"content":"Add a test for the Fence class by testing a Fence failure case, and\nby testing a successfully signalled fence capture cycle.\n\nSigned-off-by: Jacopo Mondi <jacopo@jmondi.org>\nReviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n test/fence.cpp   | 335 +++++++++++++++++++++++++++++++++++++++++++++++\n test/meson.build |   1 +\n 2 files changed, 336 insertions(+)\n create mode 100644 test/fence.cpp\n\n--\n2.33.1","diff":"diff --git a/test/fence.cpp b/test/fence.cpp\nnew file mode 100644\nindex 000000000000..343189b91c3d\n--- /dev/null\n+++ b/test/fence.cpp\n@@ -0,0 +1,335 @@\n+/* SPDX-License-Identifier: GPL-2.0-or-later */\n+/*\n+ * Copyright (C) 2021, Google Inc.\n+ *\n+ * fence.cpp - Fence test\n+ */\n+\n+#include <iostream>\n+#include <memory>\n+#include <sys/eventfd.h>\n+#include <unistd.h>\n+\n+#include <libcamera/base/event_dispatcher.h>\n+#include <libcamera/base/thread.h>\n+#include <libcamera/base/timer.h>\n+#include <libcamera/base/unique_fd.h>\n+#include <libcamera/base/utils.h>\n+\n+#include <libcamera/fence.h>\n+#include <libcamera/framebuffer_allocator.h>\n+\n+#include \"camera_test.h\"\n+#include \"test.h\"\n+\n+using namespace std::chrono_literals;\n+using namespace libcamera;\n+using namespace std;\n+\n+class FenceTest : public CameraTest, public Test\n+{\n+public:\n+\tFenceTest();\n+\n+protected:\n+\tint init() override;\n+\tint run() override;\n+\n+private:\n+\tint validateExpiredRequest(Request *request);\n+\tint validateRequest(Request *request);\n+\tvoid requestComplete(Request *request);\n+\tvoid requestRequeue(Request *request);\n+\n+\tvoid signalFence();\n+\n+\tstd::unique_ptr<Fence> fence_;\n+\tEventDispatcher *dispatcher_;\n+\tUniqueFD eventFd_;\n+\tUniqueFD eventFd2_;\n+\tTimer fenceTimer_;\n+\n+\tstd::vector<std::unique_ptr<Request>> requests_;\n+\tstd::unique_ptr<CameraConfiguration> config_;\n+\tstd::unique_ptr<FrameBufferAllocator> allocator_;\n+\n+\tStream *stream_;\n+\n+\tbool expectedCompletionResult_ = true;\n+\n+\tunsigned int completedRequest_;\n+\n+\tunsigned int signalledRequestId_;\n+\tunsigned int expiredRequestId_;\n+\tunsigned int nbuffers_;\n+\n+\tint efd2_;\n+\tint efd_;\n+};\n+\n+FenceTest::FenceTest()\n+\t: CameraTest(\"platform/vimc.0 Sensor B\")\n+{\n+}\n+\n+int FenceTest::init()\n+{\n+\t/* Make sure the CameraTest constructor succeeded. */\n+\tif (status_ != TestPass)\n+\t\treturn status_;\n+\n+\tdispatcher_ = Thread::current()->eventDispatcher();\n+\n+\t/*\n+\t * Create two eventfds to model the fences. This is enough to support the\n+\t * needs of libcamera which only needs to wait for read events through\n+\t * poll(). Once native support for fences will be available in the\n+\t * backend kernel APIs this will need to be replaced by a sw_sync fence,\n+\t * but that requires debugfs.\n+\t */\n+\teventFd_ = UniqueFD(eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK));\n+\teventFd2_ = UniqueFD(eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK));\n+\tif (!eventFd_.isValid() || !eventFd2_.isValid()) {\n+\t\tcerr << \"Unable to create eventfd\" << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\tefd_ = eventFd_.get();\n+\tefd2_ = eventFd2_.get();\n+\n+\tconfig_ = camera_->generateConfiguration({ StreamRole::Viewfinder });\n+\tif (!config_ || config_->size() != 1) {\n+\t\tcerr << \"Failed to generate default configuration\" << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\tif (camera_->acquire()) {\n+\t\tcerr << \"Failed to acquire the camera\" << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\tif (camera_->configure(config_.get())) {\n+\t\tcerr << \"Failed to set default configuration\" << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\tStreamConfiguration &cfg = config_->at(0);\n+\tstream_ = cfg.stream();\n+\n+\tallocator_ = std::make_unique<FrameBufferAllocator>(camera_);\n+\tif (allocator_->allocate(stream_) < 0)\n+\t\treturn TestFail;\n+\n+\tnbuffers_ = allocator_->buffers(stream_).size();\n+\tif (nbuffers_ < 2) {\n+\t\tcerr << \"Not enough buffers available\" << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\tsignalledRequestId_ = nbuffers_ - 2;\n+\texpiredRequestId_ = nbuffers_ - 1;\n+\n+\treturn TestPass;\n+}\n+\n+int FenceTest::validateExpiredRequest(Request *request)\n+{\n+\t/* The last request is expected to fail. */\n+\tif (request->status() != Request::RequestCancelled) {\n+\t\tcerr << \"The last request should have failed: \" << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\tFrameBuffer *buffer = request->buffers().begin()->second;\n+\tstd::unique_ptr<Fence> fence = buffer->releaseFence();\n+\tif (!fence) {\n+\t\tcerr << \"The expired fence should be present\" << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\tif (!fence->isValid()) {\n+\t\tcerr << \"The expired fence should be valid\" << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\tUniqueFD fd = fence->release();\n+\tif (fd.get() != efd_) {\n+\t\tcerr << \"The expired fence file descriptor should not change\" << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\treturn TestPass;\n+}\n+\n+int FenceTest::validateRequest(Request *request)\n+{\n+\tuint64_t cookie = request->cookie();\n+\n+\t/* All requests but the last are expected to succeed. */\n+\tif (request->status() != Request::RequestComplete) {\n+\t\tcerr << \"Unexpected request failure: \" << cookie << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\t/* A successfully completed request should have the Fence closed. */\n+\tconst Request::BufferMap &buffers = request->buffers();\n+\tFrameBuffer *buffer = buffers.begin()->second;\n+\n+\tstd::unique_ptr<Fence> bufferFence = buffer->releaseFence();\n+\tif (bufferFence) {\n+\t\tcerr << \"Unexpected valid fence in completed request\" << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\treturn TestPass;\n+}\n+\n+void FenceTest::requestRequeue(Request *request)\n+{\n+\tconst Request::BufferMap &buffers = request->buffers();\n+\tconst Stream *stream = buffers.begin()->first;\n+\tFrameBuffer *buffer = buffers.begin()->second;\n+\tuint64_t cookie = request->cookie();\n+\n+\trequest->reuse();\n+\n+\tif (cookie == signalledRequestId_) {\n+\t\t/*\n+\t\t * The second time this request is queued add a fence to it.\n+\t\t *\n+\t\t * The main loop signals it by using a timer to write to the\n+\t\t * efd2_ file descriptor before the fence expires.\n+\t\t */\n+\t\tstd::unique_ptr<Fence> fence =\n+\t\t\tstd::make_unique<Fence>(std::move(eventFd2_));\n+\t\trequest->addBuffer(stream, buffer, std::move(fence));\n+\t} else {\n+\t\t/* All the other requests continue to operate without fences. */\n+\t\trequest->addBuffer(stream, buffer);\n+\t}\n+\n+\tcamera_->queueRequest(request);\n+}\n+\n+void FenceTest::requestComplete(Request *request)\n+{\n+\tuint64_t cookie = request->cookie();\n+\tcompletedRequest_ = cookie;\n+\n+\t/*\n+\t * The last request is expected to fail as its fence has not been\n+\t * signaled.\n+\t *\n+\t * Validate the fence status but do not re-queue it.\n+\t */\n+\tif (cookie == expiredRequestId_) {\n+\t\tif (validateExpiredRequest(request) != TestPass)\n+\t\t\texpectedCompletionResult_ = false;\n+\n+\t\tdispatcher_->interrupt();\n+\t\treturn;\n+\t}\n+\n+\t/* Validate all requests but the last. */\n+\tif (validateRequest(request) != TestPass) {\n+\t\texpectedCompletionResult_ = false;\n+\n+\t\tdispatcher_->interrupt();\n+\t\treturn;\n+\t}\n+\n+\trequestRequeue(request);\n+\n+\t/*\n+\t * Interrupt the dispatcher to return control to the main loop and\n+\t * activate the fenceTimer.\n+\t */\n+\tdispatcher_->interrupt();\n+}\n+\n+/* Callback to signal a fence waiting on the eventfd file descriptor. */\n+void FenceTest::signalFence()\n+{\n+\tuint64_t value = 1;\n+\twrite(efd2_, &value, sizeof(value));\n+\tdispatcher_->processEvents();\n+}\n+\n+int FenceTest::run()\n+{\n+\tfor (const auto &[i, buffer] : utils::enumerate(allocator_->buffers(stream_))) {\n+\t\tstd::unique_ptr<Request> request = camera_->createRequest(i);\n+\t\tif (!request) {\n+\t\t\tcerr << \"Failed to create request\" << endl;\n+\t\t\treturn TestFail;\n+\t\t}\n+\n+\t\tint ret;\n+\t\tif (i == expiredRequestId_) {\n+\t\t\t/* This request will have a fence, and it will expire. */\n+\t\t\tfence_ = std::make_unique<Fence>(std::move(eventFd_));\n+\t\t\tif (!fence_->isValid()) {\n+\t\t\t\tcerr << \"Fence should be valid\" << endl;\n+\t\t\t\treturn TestFail;\n+\t\t\t}\n+\n+\t\t\tret = request->addBuffer(stream_, buffer.get(), std::move(fence_));\n+\t\t} else {\n+\t\t\t/* All other requests will have no Fence. */\n+\t\t\tret = request->addBuffer(stream_, buffer.get());\n+\t\t}\n+\n+\t\tif (ret) {\n+\t\t\tcerr << \"Failed to associate buffer with request\" << endl;\n+\t\t\treturn TestFail;\n+\t\t}\n+\n+\t\trequests_.push_back(std::move(request));\n+\t}\n+\n+\tcamera_->requestCompleted.connect(this, &FenceTest::requestComplete);\n+\n+\tif (camera_->start()) {\n+\t\tcerr << \"Failed to start camera\" << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\tfor (std::unique_ptr<Request> &request : requests_) {\n+\t\tif (camera_->queueRequest(request.get())) {\n+\t\t\tcerr << \"Failed to queue request\" << endl;\n+\t\t\treturn TestFail;\n+\t\t}\n+\t}\n+\n+\texpectedCompletionResult_ = true;\n+\n+\t/* This timer serves to signal fences associated with \"signalledRequestId_\" */\n+\tTimer fenceTimer;\n+\tfenceTimer.timeout.connect(this, &FenceTest::signalFence);\n+\n+\t/* Loop for one second. */\n+\tTimer timer;\n+\ttimer.start(1000);\n+\twhile (timer.isRunning() && expectedCompletionResult_) {\n+\t\tif (completedRequest_ == signalledRequestId_)\n+\t\t\t/*\n+\t\t\t * signalledRequestId_ has just completed and it has\n+\t\t\t * been re-queued with a fence. Start the timer to\n+\t\t\t * signal the fence in 10 msec.\n+\t\t\t */\n+\t\t\tfenceTimer.start(10);\n+\n+\t\tdispatcher_->processEvents();\n+\t}\n+\n+\tcamera_->requestCompleted.disconnect();\n+\n+\tif (camera_->stop()) {\n+\t\tcerr << \"Failed to stop camera\" << endl;\n+\t\treturn TestFail;\n+\t}\n+\n+\treturn expectedCompletionResult_ ? TestPass : TestFail;\n+}\n+\n+TEST_REGISTER(FenceTest)\ndiff --git a/test/meson.build b/test/meson.build\nindex daaa3862cdd6..2c9487e203e2 100644\n--- a/test/meson.build\n+++ b/test/meson.build\n@@ -39,6 +39,7 @@ internal_tests = [\n     ['event',                           'event.cpp'],\n     ['event-dispatcher',                'event-dispatcher.cpp'],\n     ['event-thread',                    'event-thread.cpp'],\n+    ['fence',                           'fence.cpp'],\n     ['file',                            'file.cpp'],\n     ['flags',                           'flags.cpp'],\n     ['hotplug-cameras',                 'hotplug-cameras.cpp'],\n","prefixes":["libcamera-devel","v6","10/11"]}