{"id":10358,"url":"https://patchwork.libcamera.org/api/1.1/patches/10358/?format=json","web_url":"https://patchwork.libcamera.org/patch/10358/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/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":"<20201106103707.49660-11-paul.elder@ideasonboard.com>","date":"2020-11-06T10:36:40","name":"[libcamera-devel,v4,10/37] libcamera: Add IPAIPC implementation based on unix socket","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"2806bb4dc34fe8e18aa69bd94a8d370fcf1c1e55","submitter":{"id":17,"url":"https://patchwork.libcamera.org/api/1.1/people/17/?format=json","name":"Paul Elder","email":"paul.elder@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/10358/mbox/","series":[{"id":1448,"url":"https://patchwork.libcamera.org/api/1.1/series/1448/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=1448","date":"2020-11-06T10:36:30","name":"IPA isolation implementation","version":4,"mbox":"https://patchwork.libcamera.org/series/1448/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/10358/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/10358/checks/","tags":{},"headers":{"Return-Path":"","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 D149BBDB89\n\tfor ;\n\tFri, 6 Nov 2020 10:37:45 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 9BFC862D29;\n\tFri, 6 Nov 2020 11:37:45 +0100 (CET)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 7E70B62D2E\n\tfor ;\n\tFri, 6 Nov 2020 11:37:44 +0100 (CET)","from pyrite.rasen.tech (unknown\n\t[IPv6:2400:4051:61:600:2c71:1b79:d06d:5032])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 0F11DA19;\n\tFri, 6 Nov 2020 11:37:42 +0100 (CET)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"TSBPsYzD\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1604659064;\n\tbh=9ngIqmU1QclTEZEMxfF4ymMKMxUOrGQPvF/Pin7MxaM=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=TSBPsYzDwnkzcck32Og1bizN4jpF1kyTYkeCE+iu7oWpYwW0tKkTDFWIEUQEPwYFX\n\tE7skRGZuFDrWHDxLjIJA2kytz0eFOrfTiKLovT06ssuBPSKMrLrKuYs439J3SuxAOj\n\tzQwgrklYBr3M119JBNszCH2SpyorlATUMv79Jx/c=","From":"Paul Elder ","To":"libcamera-devel@lists.libcamera.org","Date":"Fri, 6 Nov 2020 19:36:40 +0900","Message-Id":"<20201106103707.49660-11-paul.elder@ideasonboard.com>","X-Mailer":"git-send-email 2.27.0","In-Reply-To":"<20201106103707.49660-1-paul.elder@ideasonboard.com>","References":"<20201106103707.49660-1-paul.elder@ideasonboard.com>","MIME-Version":"1.0","Subject":"[libcamera-devel] [PATCH v4 10/37] libcamera: Add IPAIPC\n\timplementation based on unix socket","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"Add an implementation of IPAIPC using unix socket.\n\nSigned-off-by: Paul Elder \n\n---\nChanges in v4:\n- change snake_case to camelCase\n- change proc_ and socket_ to unique pointers\n- move inclusion of corresponding header to first in the include list\n- reserve message data and fds size (for sending)\n\nChanges in v3:\n- remove unused writeUInt32() and readUInt32()\n- remove redundant definition of IPAIPCUnixSocket::isValid()\n- remove & 0xff in writeHeader()\n- make readHeader, writeHeader, and eraseHeader static class functions\n of IPAIPCUnixSocket instead of globals\n\nChanges in v2:\n- specify in doxygen to skip generating documentation for\n IPAIPCUnixSocket\n---\n Documentation/Doxyfile.in | 2 +\n .../libcamera/internal/ipa_ipc_unixsocket.h | 62 +++++\n src/libcamera/ipa_ipc_unixsocket.cpp | 213 ++++++++++++++++++\n src/libcamera/meson.build | 1 +\n 4 files changed, 278 insertions(+)\n create mode 100644 include/libcamera/internal/ipa_ipc_unixsocket.h\n create mode 100644 src/libcamera/ipa_ipc_unixsocket.cpp","diff":"diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in\nindex a6754a47..20fa1349 100644\n--- a/Documentation/Doxyfile.in\n+++ b/Documentation/Doxyfile.in\n@@ -837,8 +837,10 @@ RECURSIVE = YES\n EXCLUDE = @TOP_SRCDIR@/include/libcamera/span.h \\\n \t\t\t @TOP_SRCDIR@/include/libcamera/internal/device_enumerator_sysfs.h \\\n \t\t\t @TOP_SRCDIR@/include/libcamera/internal/device_enumerator_udev.h \\\n+\t\t\t @TOP_SRCDIR@/include/libcamera/internal/ipa_ipc_unixsocket.h \\\n \t\t\t @TOP_SRCDIR@/src/libcamera/device_enumerator_sysfs.cpp \\\n \t\t\t @TOP_SRCDIR@/src/libcamera/device_enumerator_udev.cpp \\\n+\t\t\t @TOP_SRCDIR@/src/libcamera/ipa_ipc_unixsocket.cpp \\\n \t\t\t @TOP_SRCDIR@/src/libcamera/pipeline/ \\\n \t\t\t @TOP_SRCDIR@/src/libcamera/proxy/ \\\n \t\t\t @TOP_SRCDIR@/src/libcamera/tracepoints.cpp \\\ndiff --git a/include/libcamera/internal/ipa_ipc_unixsocket.h b/include/libcamera/internal/ipa_ipc_unixsocket.h\nnew file mode 100644\nindex 00000000..f7248ca0\n--- /dev/null\n+++ b/include/libcamera/internal/ipa_ipc_unixsocket.h\n@@ -0,0 +1,62 @@\n+/* SPDX-License-Identifier: LGPL-2.1-or-later */\n+/*\n+ * Copyright (C) 2020, Google Inc.\n+ *\n+ * ipa_ipc_unixsocket.h - Image Processing Algorithm IPC module using unix socket\n+ */\n+#ifndef __LIBCAMERA_INTERNAL_IPA_IPC_UNIXSOCKET_H__\n+#define __LIBCAMERA_INTERNAL_IPA_IPC_UNIXSOCKET_H__\n+\n+#include \n+\n+#include \n+\n+#include \"libcamera/internal/ipa_ipc.h\"\n+#include \"libcamera/internal/ipa_module.h\"\n+#include \"libcamera/internal/ipc_unixsocket.h\"\n+\n+namespace libcamera {\n+\n+class Process;\n+\n+class IPAIPCUnixSocket : public IPAIPC\n+{\n+public:\n+\tIPAIPCUnixSocket(const char *ipaModulePath, const char *ipaProxyWorkerPath);\n+\t~IPAIPCUnixSocket();\n+\n+\tint sendSync(uint32_t cmd,\n+\t\t const std::vector &dataIn,\n+\t\t const std::vector &fdsIn,\n+\t\t std::vector *dataOut = nullptr,\n+\t\t std::vector *fdsOut = nullptr) override;\n+\n+\tint sendAsync(uint32_t cmd,\n+\t\t const std::vector &dataIn,\n+\t\t const std::vector &fdsIn) override;\n+\n+\tstatic void writeHeader(IPCUnixSocket::Payload &payload, uint32_t cmd, uint32_t seq);\n+\tstatic std::tuple readHeader(IPCUnixSocket::Payload &payload);\n+\tstatic void eraseHeader(IPCUnixSocket::Payload &payload);\n+\n+private:\n+\tstruct CallData {\n+\t\tIPCUnixSocket::Payload *response;\n+\t\tbool done;\n+\t};\n+\n+\tvoid readyRead(IPCUnixSocket *socket);\n+\tint call(const IPCUnixSocket::Payload &message, IPCUnixSocket::Payload *response, uint32_t seq);\n+\n+\tuint32_t seq_;\n+\n+\tstd::unique_ptr proc_;\n+\n+\tstd::unique_ptr socket_;\n+\n+\tstd::map callData_;\n+};\n+\n+} /* namespace libcamera */\n+\n+#endif /* __LIBCAMERA_INTERNAL_IPA_IPC_UNIXSOCKET_H__ */\ndiff --git a/src/libcamera/ipa_ipc_unixsocket.cpp b/src/libcamera/ipa_ipc_unixsocket.cpp\nnew file mode 100644\nindex 00000000..eebb39fd\n--- /dev/null\n+++ b/src/libcamera/ipa_ipc_unixsocket.cpp\n@@ -0,0 +1,213 @@\n+/* SPDX-License-Identifier: LGPL-2.1-or-later */\n+/*\n+ * Copyright (C) 2020, Google Inc.\n+ *\n+ * ipa_ipc_unixsocket.cpp - Image Processing Algorithm IPC module using unix socket\n+ */\n+\n+#include \"libcamera/internal/ipa_ipc_unixsocket.h\"\n+\n+#include \n+\n+#include \"libcamera/internal/ipa_ipc.h\"\n+#include \"libcamera/internal/ipc_unixsocket.h\"\n+#include \"libcamera/internal/log.h\"\n+#include \"libcamera/internal/process.h\"\n+#include \"libcamera/internal/thread.h\"\n+\n+#include \n+#include \n+\n+namespace libcamera {\n+\n+LOG_DECLARE_CATEGORY(IPAIPC)\n+\n+IPAIPCUnixSocket::IPAIPCUnixSocket(const char *ipaModulePath,\n+\t\t\t\t const char *ipaProxyWorkerPath)\n+\t: IPAIPC(), seq_(0),\n+\t proc_(nullptr), socket_(nullptr)\n+{\n+\tstd::vector fds;\n+\tstd::vector args;\n+\targs.push_back(ipaModulePath);\n+\n+\tsocket_ = std::make_unique();\n+\tint fd = socket_->create();\n+\tif (fd < 0) {\n+\t\tLOG(IPAIPC, Error) << \"Failed to create socket\";\n+\t\treturn;\n+\t}\n+\tsocket_->readyRead.connect(this, &IPAIPCUnixSocket::readyRead);\n+\targs.push_back(std::to_string(fd));\n+\tfds.push_back(fd);\n+\n+\tproc_ = std::make_unique();\n+\tint ret = proc_->start(ipaProxyWorkerPath, args, fds);\n+\tif (ret) {\n+\t\tLOG(IPAIPC, Error)\n+\t\t\t<< \"Failed to start proxy worker process\";\n+\t\treturn;\n+\t}\n+\n+\tvalid_ = true;\n+}\n+\n+IPAIPCUnixSocket::~IPAIPCUnixSocket()\n+{\n+}\n+\n+int IPAIPCUnixSocket::sendSync(uint32_t cmd,\n+\t\t\t const std::vector &dataIn,\n+\t\t\t const std::vector &fdsIn,\n+\t\t\t std::vector *dataOut,\n+\t\t\t std::vector *fdsOut)\n+{\n+\tIPCUnixSocket::Payload message, response;\n+\tint ret;\n+\n+\tmessage.data.reserve(8 + dataIn.size());\n+\tmessage.fds.reserve(fdsIn.size());\n+\n+\t/* It's fine if seq_ overflows; that'll just be the new epoch. */\n+\tseq_++;\n+\twriteHeader(message, cmd, seq_);\n+\tmessage.data.insert(message.data.end(), dataIn.begin(), dataIn.end());\n+\n+\tmessage.fds = const_cast &>(fdsIn);\n+\n+\tret = call(message, &response, seq_);\n+\tif (ret) {\n+\t\tLOG(IPAIPC, Error) << \"Failed to call sync\";\n+\t\tcallData_.erase(seq_);\n+\t\treturn ret;\n+\t}\n+\n+\tif (dataOut)\n+\t\tdataOut->insert(dataOut->end(), response.data.begin(), response.data.end());\n+\n+\tif (fdsOut)\n+\t\tfdsOut->insert(fdsOut->end(), response.fds.begin(), response.fds.end());\n+\n+\treturn 0;\n+}\n+\n+int IPAIPCUnixSocket::sendAsync(uint32_t cmd,\n+\t\t\t\tconst std::vector &dataIn,\n+\t\t\t\tconst std::vector &fdsIn)\n+{\n+\tIPCUnixSocket::Payload message;\n+\tint ret;\n+\n+\tmessage.data.reserve(8 + dataIn.size());\n+\tmessage.fds.reserve(fdsIn.size());\n+\n+\twriteHeader(message, cmd, 0);\n+\tmessage.data.insert(message.data.end(), dataIn.begin(), dataIn.end());\n+\n+\tmessage.fds = const_cast &>(fdsIn);\n+\n+\tret = socket_->send(message);\n+\tif (ret) {\n+\t\tLOG(IPAIPC, Error) << \"Failed to call async\";\n+\t\treturn ret;\n+\t}\n+\n+\treturn 0;\n+}\n+\n+void IPAIPCUnixSocket::writeHeader(IPCUnixSocket::Payload &payload,\n+\t\t\t\t uint32_t cmd, uint32_t seq)\n+{\n+\tuint8_t cmd_arr[] = {static_cast(cmd),\n+\t\tstatic_cast((cmd >> 8)),\n+\t\tstatic_cast((cmd >> 16)),\n+\t\tstatic_cast((cmd >> 24))};\n+\tuint8_t seq_arr[] = {static_cast(seq),\n+\t\tstatic_cast((seq >> 8)),\n+\t\tstatic_cast((seq >> 16)),\n+\t\tstatic_cast((seq >> 24))};\n+\tpayload.data.insert(payload.data.begin(), cmd_arr, cmd_arr+4);\n+\tpayload.data.insert(payload.data.begin() + 4, seq_arr, seq_arr+4);\n+}\n+\n+std::tuple\n+IPAIPCUnixSocket::readHeader(IPCUnixSocket::Payload &payload)\n+{\n+\tuint32_t cmd = payload.data[0] |\n+\t\t(payload.data[1] << 8) |\n+\t\t(payload.data[2] << 16) |\n+\t\t(payload.data[3] << 24);\n+\tuint32_t seq = payload.data[4] |\n+\t\t(payload.data[5] << 8) |\n+\t\t(payload.data[6] << 16) |\n+\t\t(payload.data[7] << 24);\n+\n+\treturn {cmd, seq};\n+}\n+\n+void IPAIPCUnixSocket::eraseHeader(IPCUnixSocket::Payload &payload)\n+{\n+\tpayload.data.erase(payload.data.begin(), payload.data.begin() + 8);\n+}\n+\n+void IPAIPCUnixSocket::readyRead(IPCUnixSocket *socket)\n+{\n+\tIPCUnixSocket::Payload message;\n+\tint ret = socket->receive(&message);\n+\tif (ret) {\n+\t\tLOG(IPAIPC, Error) << \"Receive message failed\" << ret;\n+\t\treturn;\n+\t}\n+\n+\tuint32_t cmd, seq;\n+\tstd::tie(cmd, seq) = readHeader(message);\n+\n+\tauto callData = callData_.find(seq);\n+\tif (callData != callData_.end()) {\n+\t\teraseHeader(message);\n+\t\t/* Is there any way to avoid this copy? */\n+\t\t*callData->second.response = message;\n+\t\tcallData->second.done = true;\n+\t\treturn;\n+\t}\n+\n+\t/*\n+\t * Received unexpected data, this means it's a call from the IPA.\n+\t * We can't return anything to the IPA (gotta keep them under *our*\n+\t * control, plus returning would require blocking the caller, and we\n+\t * can't afford to do that). Let the proxy do switch-case on cmd.\n+\t */\n+\trecvIPC.emit(message.data, message.fds);\n+\n+\treturn;\n+}\n+\n+int IPAIPCUnixSocket::call(const IPCUnixSocket::Payload &message, IPCUnixSocket::Payload *response, uint32_t seq)\n+{\n+\tTimer timeout;\n+\tint ret;\n+\n+\tcallData_[seq].response = response;\n+\tcallData_[seq].done = false;\n+\n+\tret = socket_->send(message);\n+\tif (ret)\n+\t\treturn ret;\n+\n+\ttimeout.start(200);\n+\twhile (!callData_[seq].done) {\n+\t\tif (!timeout.isRunning()) {\n+\t\t\tLOG(IPAIPC, Error) << \"Call timeout!\";\n+\t\t\tcallData_.erase(seq);\n+\t\t\treturn -ETIMEDOUT;\n+\t\t}\n+\n+\t\tThread::current()->eventDispatcher()->processEvents();\n+\t}\n+\n+\tcallData_.erase(seq);\n+\n+\treturn 0;\n+}\n+\n+} /* namespace libcamera */\ndiff --git a/src/libcamera/meson.build b/src/libcamera/meson.build\nindex 85f3a202..d6bd9a05 100644\n--- a/src/libcamera/meson.build\n+++ b/src/libcamera/meson.build\n@@ -26,6 +26,7 @@ libcamera_sources = files([\n 'ipa_controls.cpp',\n 'ipa_data_serializer.cpp',\n 'ipa_ipc.cpp',\n+ 'ipa_ipc_unixsocket.cpp',\n 'ipa_interface.cpp',\n 'ipa_manager.cpp',\n 'ipa_module.cpp',\n","prefixes":["libcamera-devel","v4","10/37"]}