{"id":9719,"url":"https://patchwork.libcamera.org/api/patches/9719/?format=json","web_url":"https://patchwork.libcamera.org/patch/9719/","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":"<20200922133537.258098-16-paul.elder@ideasonboard.com>","date":"2020-09-22T13:35:14","name":"[libcamera-devel,15/38] libcamera: Add IPAIPC implementation based on unix socket","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"6c589e5a9ce2b8f4039ddfb5a8974518d666fbc1","submitter":{"id":17,"url":"https://patchwork.libcamera.org/api/people/17/?format=json","name":"Paul Elder","email":"paul.elder@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/9719/mbox/","series":[{"id":1309,"url":"https://patchwork.libcamera.org/api/series/1309/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=1309","date":"2020-09-22T13:34:59","name":"IPA isolation implementation","version":1,"mbox":"https://patchwork.libcamera.org/series/1309/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/9719/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/9719/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 5D3E3BF01C\n\tfor ;\n\tTue, 22 Sep 2020 13:37:41 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 27AA562FDA;\n\tTue, 22 Sep 2020 15:37:41 +0200 (CEST)","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 DA54460576\n\tfor ;\n\tTue, 22 Sep 2020 15:37:39 +0200 (CEST)","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 DA78C2D7;\n\tTue, 22 Sep 2020 15:37:32 +0200 (CEST)"],"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=\"mkih9vp/\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1600781854;\n\tbh=Sl8/ekM00ZsZJyK1R41zw9qroT8C0+eQEFj2coOYeTQ=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=mkih9vp/qgzl6MxYFc6cj96eDBTmwy/WWHojrkfGTCeh3/cdo85DSda2OcF9qoIdP\n\tXtuVNxFegvCGqsYM8370xcDOhck0d1A/VmKWRz8ABoVQBluUPAQKZlLvR/IGO2oKa5\n\tYshMLuINfVeeeVTm70Xp9p/I1xQVhLH6lR6TknEk=","From":"Paul Elder ","To":"libcamera-devel@lists.libcamera.org","Date":"Tue, 22 Sep 2020 22:35:14 +0900","Message-Id":"<20200922133537.258098-16-paul.elder@ideasonboard.com>","X-Mailer":"git-send-email 2.27.0","In-Reply-To":"<20200922133537.258098-1-paul.elder@ideasonboard.com>","References":"<20200922133537.258098-1-paul.elder@ideasonboard.com>","MIME-Version":"1.0","Subject":"[libcamera-devel] [PATCH 15/38] 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 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 | 115 ++++++++++++\n src/libcamera/ipa_ipc_unixsocket.cpp | 175 ++++++++++++++++++\n src/libcamera/meson.build | 1 +\n 4 files changed, 293 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 598eca9b..71509ff7 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_BUILDDIR@/include/libcamera/ipa/ \\\ndiff --git a/include/libcamera/internal/ipa_ipc_unixsocket.h b/include/libcamera/internal/ipa_ipc_unixsocket.h\nnew file mode 100644\nindex 00000000..de8af35b\n--- /dev/null\n+++ b/include/libcamera/internal/ipa_ipc_unixsocket.h\n@@ -0,0 +1,115 @@\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+inline void writeHeader(IPCUnixSocket::Payload &payload, uint32_t cmd, uint32_t seq)\n+{\n+\tuint8_t cmd_arr[] = {static_cast(cmd & 0xff),\n+\t\t\t static_cast((cmd >> 8 ) & 0xff),\n+\t\t\t static_cast((cmd >> 16) & 0xff),\n+\t\t\t static_cast((cmd >> 24) & 0xff)};\n+\tuint8_t seq_arr[] = {static_cast(seq & 0xff),\n+\t\t\t static_cast((seq >> 8 ) & 0xff),\n+\t\t\t static_cast((seq >> 16) & 0xff),\n+\t\t\t static_cast((seq >> 24) & 0xff)};\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+inline std::tuple readHeader(IPCUnixSocket::Payload &payload)\n+{\n+\tuint32_t cmd = (payload.data[0] & 0xff) |\n+\t\t ((payload.data[1] & 0xff) << 8) |\n+\t\t ((payload.data[2] & 0xff) << 16) |\n+\t\t ((payload.data[3] & 0xff) << 24);\n+\tuint32_t seq = (payload.data[4] & 0xff) |\n+\t\t ((payload.data[5] & 0xff) << 8) |\n+\t\t ((payload.data[6] & 0xff) << 16) |\n+\t\t ((payload.data[7] & 0xff) << 24);\n+\n+\treturn {cmd, seq};\n+}\n+\n+inline void eraseHeader(IPCUnixSocket::Payload &payload)\n+{\n+\tpayload.data.erase(payload.data.begin(), payload.data.begin() + 8);\n+}\n+\n+inline void writeUInt32(IPCUnixSocket::Payload &payload, uint32_t val, uint32_t pos)\n+{\n+\tif (pos + 4 > payload.data.size())\n+\t\treturn;\n+\n+\tuint8_t arr[] = {static_cast(val & 0xff),\n+\t\t\t static_cast(val & (0xff << 8)),\n+\t\t\t static_cast(val & (0xff << 16)),\n+\t\t\t static_cast(val & (0xff << 24))};\n+\tstd::copy(arr, arr + 4, payload.data.begin() + pos);\n+}\n+\n+inline uint32_t readUInt32(IPCUnixSocket::Payload &payload, uint32_t pos)\n+{\n+\tif (pos + 4 > payload.data.size())\n+\t\treturn 0;\n+\n+\treturn payload.data[pos] & (payload.data[pos + 1] << 8) &\n+\t (payload.data[pos + 2] << 16) & (payload.data[pos + 3] << 24);\n+}\n+\n+\n+class IPAIPCUnixSocket : public IPAIPC\n+{\n+public:\n+\tIPAIPCUnixSocket(const char *ipa_module_path, const char *ipa_proxy_worker_path);\n+\t~IPAIPCUnixSocket();\n+\n+\tbool isValid() const { return valid_; }\n+\n+\tint sendSync(uint32_t cmd,\n+\t\t const std::vector &data_in,\n+\t\t const std::vector &fds_in,\n+\t\t std::vector *data_out = nullptr,\n+\t\t std::vector *fds_out = nullptr) override;\n+\n+\tint sendAsync(uint32_t cmd,\n+\t\t const std::vector &data_in,\n+\t\t const std::vector &fds_in) override;\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+\tProcess *proc_;\n+\n+\tIPCUnixSocket *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..c1997e96\n--- /dev/null\n+++ b/src/libcamera/ipa_ipc_unixsocket.cpp\n@@ -0,0 +1,175 @@\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 \n+\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+#include \"libcamera/internal/ipa_ipc.h\"\n+#include \"libcamera/internal/ipa_ipc_unixsocket.h\"\n+\n+namespace libcamera {\n+\n+LOG_DECLARE_CATEGORY(IPAIPC)\n+\n+IPAIPCUnixSocket::IPAIPCUnixSocket(const char *ipa_module_path,\n+\t\t\t\t const char *ipa_proxy_worker_path)\n+\t: IPAIPC(ipa_module_path, ipa_proxy_worker_path), seq_(0),\n+\t proc_(nullptr), socket_(nullptr)\n+{\n+\tstd::vector fds;\n+\tstd::vector args;\n+\targs.push_back(ipa_module_path);\n+\n+\tsocket_ = new IPCUnixSocket();\n+\tint fd = socket_->create();\n+\tif (fd < 0) {\n+\t\tLOG(IPAIPC, Error)\n+\t\t\t<< \"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_ = new Process();\n+\tint ret = proc_->start(ipa_proxy_worker_path, 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+\tdelete proc_;\n+\tdelete socket_;\n+}\n+\n+int IPAIPCUnixSocket::sendSync(uint32_t cmd,\n+\t\t\t const std::vector &data_in,\n+\t\t\t const std::vector &fds_in,\n+\t\t\t std::vector *data_out,\n+\t\t\t std::vector *fds_out)\n+{\n+\tIPCUnixSocket::Payload message, response;\n+\tint ret;\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(), data_in.begin(), data_in.end());\n+\n+\tmessage.fds = const_cast &>(fds_in);\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 (data_out)\n+\t\tdata_out->insert(data_out->end(), response.data.begin(), response.data.end());\n+\n+\tif (fds_out)\n+\t\tfds_out->insert(fds_out->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 &data_in,\n+\t\t\t\tconst std::vector &fds_in)\n+{\n+\tIPCUnixSocket::Payload message;\n+\tint ret;\n+\n+\twriteHeader(message, cmd, 0);\n+\tmessage.data.insert(message.data.end(), data_in.begin(), data_in.end());\n+\n+\tmessage.fds = const_cast &>(fds_in);\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::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 e3eade57..24f32815 100644\n--- a/src/libcamera/meson.build\n+++ b/src/libcamera/meson.build\n@@ -25,6 +25,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","15/38"]}