Patch Detail
Show a patch.
GET /api/patches/3557/?format=api
{ "id": 3557, "url": "https://patchwork.libcamera.org/api/patches/3557/?format=api", "web_url": "https://patchwork.libcamera.org/patch/3557/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/projects/1/?format=api", "name": "libcamera", "link_name": "libcamera", "list_id": "libcamera_core", "list_email": "libcamera-devel@lists.libcamera.org", "web_url": "", "scm_url": "", "webscm_url": "" }, "msgid": "<20200427031713.14013-6-laurent.pinchart@ideasonboard.com>", "date": "2020-04-27T03:17:07", "name": "[libcamera-devel,05/11] libcamera: ipa_proxy: Provide suport for IPA configuration files", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "bc4dd1f50d3e1b847faa5febcb4ef325da94cdbd", "submitter": { "id": 2, "url": "https://patchwork.libcamera.org/api/people/2/?format=api", "name": "Laurent Pinchart", "email": "laurent.pinchart@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/3557/mbox/", "series": [ { "id": 831, "url": "https://patchwork.libcamera.org/api/series/831/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=831", "date": "2020-04-27T03:17:02", "name": "libcamera: Add support for IPA configuration", "version": 1, "mbox": "https://patchwork.libcamera.org/series/831/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/3557/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/3557/checks/", "tags": {}, "headers": { "Return-Path": "<laurent.pinchart@ideasonboard.com>", "Received": [ "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 B8DBB601B8\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 27 Apr 2020 05:17:34 +0200 (CEST)", "from pendragon.bb.dnainternet.fi (81-175-216-236.bb.dnainternet.fi\n\t[81.175.216.236])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 5B1F272C\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tMon, 27 Apr 2020 05:17:34 +0200 (CEST)" ], "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"oczknb41\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1587957454;\n\tbh=+bCKeeRKlKKGlXKTgM0sj3xdHdjbiWTrb31gXoU4oec=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=oczknb41AkpwEg+nYadkrL+8nR7N7oTlQmK0Ar+9t8suIf9vI6GoyXWI/HTjf2Ahk\n\trB1rKDovBaY4xNA1R+SSMFw3mIpqJrQ8GUwbjOlzq3jN3jU48zcnafgr6bzTzUoZEf\n\tfcCkYoQb2ye7eVkeuyCVkbRYoI5xG6zB5NIdqzAM=", "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Date": "Mon, 27 Apr 2020 06:17:07 +0300", "Message-Id": "<20200427031713.14013-6-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.25.3", "In-Reply-To": "<20200427031713.14013-1-laurent.pinchart@ideasonboard.com>", "References": "<20200427031713.14013-1-laurent.pinchart@ideasonboard.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[libcamera-devel] [PATCH 05/11] libcamera: ipa_proxy: Provide\n\tsuport for IPA configuration files", "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>", "X-List-Received-Date": "Mon, 27 Apr 2020 03:17:34 -0000" }, "content": "IPA modules may require configuration files, which may be stored in\ndifferent locations in the file system. To standardize file locations\nbetween all IPAs and pipeline handlers, provide a helper function to\nlocate a configuration file by searching in the following directories:\n\n- All directories specified in the LIBCAMERA_IPA_CONFIG_PATH environment\n variable ; or\n- In the build tree if libcamera is not installed ; otherwise\n- In standard system locations (etc and share directories).\n\nMore locations, or extensions to the mechanism, may be implemented\nlater.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n src/ipa/meson.build | 6 ++\n src/libcamera/include/ipa_proxy.h | 11 ++-\n src/libcamera/ipa_proxy.cpp | 91 +++++++++++++++++++++++-\n src/libcamera/proxy/ipa_proxy_linux.cpp | 2 +-\n src/libcamera/proxy/ipa_proxy_thread.cpp | 2 +-\n 5 files changed, 105 insertions(+), 7 deletions(-)", "diff": "diff --git a/src/ipa/meson.build b/src/ipa/meson.build\nindex cb4e3ab3388f..145bf8105af7 100644\n--- a/src/ipa/meson.build\n+++ b/src/ipa/meson.build\n@@ -1,10 +1,16 @@\n ipa_install_dir = join_paths(get_option('libdir'), 'libcamera')\n+ipa_data_dir = join_paths(get_option('datadir'), 'libcamera', 'ipa')\n+ipa_sysconf_dir = join_paths(get_option('sysconfdir'), 'libcamera', 'ipa')\n \n ipa_includes = [\n libcamera_includes,\n libcamera_internal_includes,\n ]\n \n+config_h.set('IPA_CONFIG_DIR',\n+ '\"' + join_paths(get_option('prefix'), ipa_sysconf_dir) +\n+ ':' + join_paths(get_option('prefix'), ipa_data_dir) + '\"')\n+\n config_h.set('IPA_MODULE_DIR',\n '\"' + join_paths(get_option('prefix'), ipa_install_dir) + '\"')\n \ndiff --git a/src/libcamera/include/ipa_proxy.h b/src/libcamera/include/ipa_proxy.h\nindex e696551af39f..1111065b36a7 100644\n--- a/src/libcamera/include/ipa_proxy.h\n+++ b/src/libcamera/include/ipa_proxy.h\n@@ -13,22 +13,27 @@\n \n #include <ipa/ipa_interface.h>\n \n-#include \"ipa_module.h\"\n-\n namespace libcamera {\n \n+class IPAModule;\n+\n class IPAProxy : public IPAInterface\n {\n public:\n-\tIPAProxy();\n+\tIPAProxy(IPAModule *ipam);\n \t~IPAProxy();\n \n \tbool isValid() const { return valid_; }\n \n+\tstd::string configurationFile(const std::string &file) const;\n+\n protected:\n \tstd::string resolvePath(const std::string &file) const;\n \n \tbool valid_;\n+\n+private:\n+\tIPAModule *ipam_;\n };\n \n class IPAProxyFactory\ndiff --git a/src/libcamera/ipa_proxy.cpp b/src/libcamera/ipa_proxy.cpp\nindex 43ac9afc25cb..ea69e63d6bb8 100644\n--- a/src/libcamera/ipa_proxy.cpp\n+++ b/src/libcamera/ipa_proxy.cpp\n@@ -8,8 +8,11 @@\n #include \"ipa_proxy.h\"\n \n #include <string.h>\n+#include <sys/stat.h>\n+#include <sys/types.h>\n #include <unistd.h>\n \n+#include \"ipa_module.h\"\n #include \"log.h\"\n #include \"utils.h\"\n \n@@ -34,12 +37,13 @@ LOG_DEFINE_CATEGORY(IPAProxy)\n \n /**\n * \\brief Construct an IPAProxy instance\n+ * \\param[in] ipam The IPA module\n *\n * IPAProxy instances shall be constructed through the IPAProxyFactory::create()\n * method implemented by the respective factories.\n */\n-IPAProxy::IPAProxy()\n-\t: valid_(false)\n+IPAProxy::IPAProxy(IPAModule *ipam)\n+\t: valid_(false), ipam_(ipam)\n {\n }\n \n@@ -57,6 +61,89 @@ IPAProxy::~IPAProxy()\n * \\return True if the IPAProxy is valid, false otherwise\n */\n \n+/**\n+ * \\brief Retrieve the absolute path to an IPA configuration file\n+ * \\param[in] name The configuration name\n+ *\n+ * This function locates the configuration file for an IPA and returns its\n+ * absolute path. It searches the following directories, in order:\n+ *\n+ * - All directories specified in the colon-separated LIBCAMERA_IPA_CONFIG_PATH\n+ * environment variable ; or\n+ * - If libcamera is not installed, the src/ipa/ directory within the source\n+ * tree ; otherwise\n+ * - The system sysconf (etc/libcamera/ipa) and the data (share/libcamera/ipa/)\n+ * directories.\n+ *\n+ * The system directories are not searched if libcamera is not installed.\n+ *\n+ * Within each of those directories, the function looks for a subdirectory\n+ * named after the IPA module name, as reported in IPAModuleInfo::name, and for\n+ * a file named \\a name within that directory. The \\a name is IPA-specific.\n+ *\n+ * \\return The full path to the IPA configuration file, or an empty string if\n+ * no configuration file can be found\n+ */\n+std::string IPAProxy::configurationFile(const std::string &name) const\n+{\n+\tstruct stat statbuf;\n+\tint ret;\n+\n+\t/*\n+\t * The IPA module name can be used as-is to build directory names as it\n+\t * has been validated when loading the module.\n+\t */\n+\tstd::string ipaName = ipam_->info().name;\n+\n+\t/* Check the environment variable first. */\n+\tconst char *confPaths = utils::secure_getenv(\"LIBCAMERA_IPA_CONFIG_PATH\");\n+\tif (confPaths) {\n+\t\tfor (const auto &dir : utils::split(confPaths, \":\")) {\n+\t\t\tif (dir.empty())\n+\t\t\t\tcontinue;\n+\n+\t\t\tstd::string confPath = dir + \"/\" + ipaName + \"/\" + name;\n+\t\t\tret = stat(confPath.c_str(), &statbuf);\n+\t\t\tif (ret == 0 && (statbuf.st_mode & S_IFMT) == S_IFREG)\n+\t\t\t\treturn confPath;\n+\t\t}\n+\t}\n+\n+\t/*\n+\t * When libcamera is used before it is installed, load configuration\n+\t * files from the source directory. The configuration files are then\n+\t * located in the 'data' subdirectory of the corresponding IPA module.\n+\t */\n+\tstd::string root = utils::libcameraSourcePath();\n+\tif (!root.empty()) {\n+\t\tstd::string ipaConfDir = root + \"src/ipa/\" + ipaName + \"/data\";\n+\n+\t\tLOG(IPAProxy, Info)\n+\t\t\t<< \"libcamera is not installed. Loading IPA configuration from '\"\n+\t\t\t<< ipaConfDir << \"'\";\n+\n+\t\tstd::string confPath = ipaConfDir + \"/\" + name;\n+\t\tret = stat(confPath.c_str(), &statbuf);\n+\t\tif (ret == 0 && (statbuf.st_mode & S_IFMT) == S_IFREG)\n+\t\t\treturn confPath;\n+\n+\t\treturn std::string();\n+\t}\n+\n+\t/* Else look in the system locations. */\n+\tfor (const auto &dir : utils::split(IPA_CONFIG_DIR, \":\")) {\n+\t\tif (dir.empty())\n+\t\t\tcontinue;\n+\n+\t\tstd::string confPath = dir + \"/\" + ipaName + \"/\" + name;\n+\t\tret = stat(confPath.c_str(), &statbuf);\n+\t\tif (ret == 0 && (statbuf.st_mode & S_IFMT) == S_IFREG)\n+\t\t\treturn confPath;\n+\t}\n+\n+\treturn std::string();\n+}\n+\n /**\n * \\brief Find a valid full path for a proxy worker for a given executable name\n * \\param[in] file File name of proxy worker executable\ndiff --git a/src/libcamera/proxy/ipa_proxy_linux.cpp b/src/libcamera/proxy/ipa_proxy_linux.cpp\nindex 2aa80b946704..89f5cb54687b 100644\n--- a/src/libcamera/proxy/ipa_proxy_linux.cpp\n+++ b/src/libcamera/proxy/ipa_proxy_linux.cpp\n@@ -44,7 +44,7 @@ private:\n };\n \n IPAProxyLinux::IPAProxyLinux(IPAModule *ipam)\n-\t: proc_(nullptr), socket_(nullptr)\n+\t: IPAProxy(ipam), proc_(nullptr), socket_(nullptr)\n {\n \tLOG(IPAProxy, Debug)\n \t\t<< \"initializing dummy proxy: loading IPA from \"\ndiff --git a/src/libcamera/proxy/ipa_proxy_thread.cpp b/src/libcamera/proxy/ipa_proxy_thread.cpp\nindex 368ccca1cf60..1ebb9b6a6c9d 100644\n--- a/src/libcamera/proxy/ipa_proxy_thread.cpp\n+++ b/src/libcamera/proxy/ipa_proxy_thread.cpp\n@@ -73,7 +73,7 @@ private:\n };\n \n IPAProxyThread::IPAProxyThread(IPAModule *ipam)\n-\t: running_(false)\n+\t: IPAProxy(ipam), running_(false)\n {\n \tif (!ipam->load())\n \t\treturn;\n", "prefixes": [ "libcamera-devel", "05/11" ] }