Patch Detail
Show a patch.
GET /api/1.1/patches/23547/?format=api
{ "id": 23547, "url": "https://patchwork.libcamera.org/api/1.1/patches/23547/?format=api", "web_url": "https://patchwork.libcamera.org/patch/23547/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/1.1/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": "<20250611142431.33306-5-mzamazal@redhat.com>", "date": "2025-06-11T14:24:20", "name": "[v9,04/13] config: Add configuration retrieval helpers", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "d2c1ed928448fed20e18db715c83516bbf7e9c84", "submitter": { "id": 177, "url": "https://patchwork.libcamera.org/api/1.1/people/177/?format=api", "name": "Milan Zamazal", "email": "mzamazal@redhat.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/23547/mbox/", "series": [ { "id": 5215, "url": "https://patchwork.libcamera.org/api/1.1/series/5215/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=5215", "date": "2025-06-11T14:24:16", "name": "Add global configuration file", "version": 9, "mbox": "https://patchwork.libcamera.org/series/5215/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/23547/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/23547/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 93C89C3240\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 11 Jun 2025 14:24:56 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 6F90368DC4;\n\tWed, 11 Jun 2025 16:24:55 +0200 (CEST)", "from us-smtp-delivery-124.mimecast.com\n\t(us-smtp-delivery-124.mimecast.com [170.10.129.124])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id A456768DC9\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 11 Jun 2025 16:24:53 +0200 (CEST)", "from mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com\n\t(ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97])\n\tby relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,\n\tcipher=TLS_AES_256_GCM_SHA384) id us-mta-517-xh7BUl7RNGiTNGIMF_1Iww-1;\n\tWed, 11 Jun 2025 10:24:49 -0400", "from mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com\n\t(mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com\n\t[10.30.177.111])\n\t(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n\tkey-exchange X25519 server-signature RSA-PSS (2048 bits)\n\tserver-digest SHA256) (No client certificate requested)\n\tby mx-prod-mc-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTPS id 5CB891801BD8; Wed, 11 Jun 2025 14:24:48 +0000 (UTC)", "from mzamazal-thinkpadp1gen7.tpbc.com (unknown [10.44.33.76])\n\tby mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTP id 445BF18003FC; Wed, 11 Jun 2025 14:24:46 +0000 (UTC)" ], "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=redhat.com header.i=@redhat.com\n\theader.b=\"DiDyPBtu\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n\ts=mimecast20190719; t=1749651892;\n\th=from:from:reply-to:subject:subject:date:date:message-id:message-id:\n\tto:to:cc:cc:mime-version:mime-version:content-type:content-type:\n\tcontent-transfer-encoding:content-transfer-encoding:\n\tin-reply-to:in-reply-to:references:references;\n\tbh=SN0Ccq5YV1NrfzJKANaIZ8pRYPooZ6g4Mm09kCNtDmI=;\n\tb=DiDyPBtuVKtGTxAwlYK/lMaSnXaMuT9+FsbLlzZNeM3CLKTPYi/emyPblDYgiU+Y542Bc8\n\tHYSBIj5DOYrR8zdvtq4Ms6zzlcnOt9uRFvwBYFpnrxeTpqYOzPnj6yTf9CCsUdctxADxE5\n\tqcIU1u4D7jSTKt7+eLP5/8BdIij6PSU=", "X-MC-Unique": "xh7BUl7RNGiTNGIMF_1Iww-1", "X-Mimecast-MFC-AGG-ID": "xh7BUl7RNGiTNGIMF_1Iww_1749651888", "From": "Milan Zamazal <mzamazal@redhat.com>", "To": "libcamera-devel@lists.libcamera.org", "Cc": "Milan Zamazal <mzamazal@redhat.com>, Kieran Bingham\n\t<kieran.bingham@ideasonboard.com>, =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?=\n\t<pobrn@protonmail.com>, Laurent Pinchart\n\t<laurent.pinchart@ideasonboard.com>", "Subject": "[PATCH v9 04/13] config: Add configuration retrieval helpers", "Date": "Wed, 11 Jun 2025 16:24:20 +0200", "Message-ID": "<20250611142431.33306-5-mzamazal@redhat.com>", "In-Reply-To": "<20250611142431.33306-1-mzamazal@redhat.com>", "References": "<20250611142431.33306-1-mzamazal@redhat.com>", "MIME-Version": "1.0", "X-Scanned-By": "MIMEDefang 3.4.1 on 10.30.177.111", "X-Mimecast-Spam-Score": "0", "X-Mimecast-MFC-PROC-ID": "qn3jpc_-7KZhp3obfH81NawxH9LyIqEVxOH6hwsyoUA_1749651888", "X-Mimecast-Originator": "redhat.com", "Content-Transfer-Encoding": "8bit", "content-type": "text/plain; charset=\"US-ASCII\"; x-default=true", "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": "Let's add some helpers to make accessing simple configuration values\nsimpler.\n\nGlobalConfiguration::option must check for the key presence before\nretrieving the value using operator[] because if the key is not present\nthen YamlObject::empty may be returned as a regular value.\n\nSigned-off-by: Milan Zamazal <mzamazal@redhat.com>\n---\n .../libcamera/internal/global_configuration.h | 5 ++\n src/libcamera/base/global_configuration.cpp | 52 +++++++++++++++++++\n 2 files changed, 57 insertions(+)", "diff": "diff --git a/include/libcamera/internal/global_configuration.h b/include/libcamera/internal/global_configuration.h\nindex 8d0410ac2..5d9531158 100644\n--- a/include/libcamera/internal/global_configuration.h\n+++ b/include/libcamera/internal/global_configuration.h\n@@ -8,6 +8,8 @@\n #pragma once\n \n #include <filesystem>\n+#include <optional>\n+#include <string>\n \n #include \"libcamera/internal/yaml_parser.h\"\n \n@@ -22,6 +24,9 @@ public:\n \n \tunsigned int version() const;\n \tConfiguration configuration() const;\n+\tstd::optional<std::string> option(const std::string &confPath) const;\n+\tstd::optional<std::string> envOption(const char *const envVariable,\n+\t\t\t\t\t const std::string &confPath) const;\n \n private:\n \tbool loadFile(const std::filesystem::path &fileName);\ndiff --git a/src/libcamera/base/global_configuration.cpp b/src/libcamera/base/global_configuration.cpp\nindex 1ddf5bc33..1ef63750c 100644\n--- a/src/libcamera/base/global_configuration.cpp\n+++ b/src/libcamera/base/global_configuration.cpp\n@@ -8,6 +8,8 @@\n #include \"libcamera/internal/global_configuration.h\"\n \n #include <filesystem>\n+#include <memory>\n+#include <string>\n #include <string_view>\n #include <sys/types.h>\n \n@@ -40,6 +42,11 @@ LOG_DEFINE_CATEGORY(Configuration)\n * is not found then in system-wide configuration directories. If multiple\n * configuration files exist then only the first one found is used and no\n * configuration merging is performed.\n+ *\n+ * The configuration can be accessed using the provided helpers. Namely\n+ * GlobalConfiguration::option() or GlobalConfiguration::envOption() to access\n+ * individual options or GlobalConfiguration::configuration() to access the\n+ * whole configuration.\n */\n \n bool GlobalConfiguration::loadFile(const std::filesystem::path &fileName)\n@@ -112,6 +119,51 @@ GlobalConfiguration::GlobalConfiguration()\n * the underlying type.\n */\n \n+/**\n+ * \\brief Return value of the configuration option identified by \\a confPath\n+ * \\param[in] confPath Sequence of the YAML section names (excluding\n+ * `configuration') leading to the requested option separated by dots\n+ * \\return A value if an item corresponding to \\a confPath exists in the\n+ * configuration file, no value otherwise\n+ */\n+std::optional<std::string> GlobalConfiguration::option(const std::string &confPath) const\n+{\n+\tconst YamlObject *c = &configuration();\n+\tfor (auto part : utils::split(confPath, \".\")) {\n+\t\tc = &(*c)[part];\n+\t\tif (!*c)\n+\t\t\treturn {};\n+\t}\n+\treturn c->get<std::string>();\n+}\n+\n+/**\n+ * \\brief Return value of the configuration option from a file or environment\n+ * \\param[in] envVariable Environment variable to get the value from\n+ * \\param[in] confPath The same as in GlobalConfiguration::option\n+ *\n+ * This helper looks first at the given environment variable and if it is\n+ * defined then it returns its value (even if it is empty). Otherwise it looks\n+ * for \\a confPath the same way as in GlobalConfiguration::option. Only string\n+ * values are supported.\n+ *\n+ * \\note Support for using environment variables to configure libcamera behavior\n+ * is provided here mostly for backward compatibility reasons. Introducing new\n+ * configuration environment variables is discouraged.\n+ *\n+ * \\return A value retrieved from the given environment option or configuration\n+ * file or no value if not found\n+ */\n+std::optional<std::string> GlobalConfiguration::envOption(\n+\tconst char *const envVariable,\n+\tconst std::string &confPath) const\n+{\n+\tconst char *envValue = utils::secure_getenv(envVariable);\n+\tif (envValue)\n+\t\treturn std::optional{ std::string{ envValue } };\n+\treturn option(confPath);\n+}\n+\n /**\n * \\brief Return configuration version\n *\n", "prefixes": [ "v9", "04/13" ] }