Patch Detail
Show a patch.
GET /api/patches/23312/?format=api
{ "id": 23312, "url": "https://patchwork.libcamera.org/api/patches/23312/?format=api", "web_url": "https://patchwork.libcamera.org/patch/23312/", "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": "<20250430121449.39910-5-mzamazal@redhat.com>", "date": "2025-04-30T12:14:37", "name": "[v8,04/15] config: Add configuration retrieval helpers", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": false, "hash": "bc9dc9c55bbd9bffc0001a30646c3388ac573e8b", "submitter": { "id": 177, "url": "https://patchwork.libcamera.org/api/people/177/?format=api", "name": "Milan Zamazal", "email": "mzamazal@redhat.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/23312/mbox/", "series": [ { "id": 5156, "url": "https://patchwork.libcamera.org/api/series/5156/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=5156", "date": "2025-04-30T12:14:33", "name": "Add global configuration file", "version": 8, "mbox": "https://patchwork.libcamera.org/series/5156/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/23312/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/23312/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 56D38BE08B\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 30 Apr 2025 12:15:17 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id DA19068B31;\n\tWed, 30 Apr 2025 14:15:16 +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 153A468B2B\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 30 Apr 2025 14:15:13 +0200 (CEST)", "from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com\n\t(ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63])\n\tby relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,\n\tcipher=TLS_AES_256_GCM_SHA384) id us-mta-339-J6-mHiy4O8-zZH7aS82odw-1;\n\tWed, 30 Apr 2025 08:15:08 -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-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTPS id 105951956078; Wed, 30 Apr 2025 12:15:07 +0000 (UTC)", "from mzamazal-thinkpadp1gen7.tpbc.com (unknown [10.44.32.120])\n\tby mx-prod-int-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTP id 5A11418001DA; Wed, 30 Apr 2025 12:15:05 +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=\"MWqBwU/+\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n\ts=mimecast20190719; t=1746015312;\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=MEtJ2CtjD2VcvcPVZilYKbxVAks0RybmyFHYAgXCuC0=;\n\tb=MWqBwU/+K1PfanoB/KjyjtVod8oX2J170K2XSWzSmCJIxtJtU7F39msUx3l7Dq8L37+OxB\n\tp7Fuv9XOnDohcQuiQJZw9MlWXygeiESuwUuv73wypTRcu2zcFffYzV/Q7x9bla66bByb9L\n\t11DqxYE8ojGQnrc4j1udRIYYAYPae5U=", "X-MC-Unique": "J6-mHiy4O8-zZH7aS82odw-1", "X-Mimecast-MFC-AGG-ID": "J6-mHiy4O8-zZH7aS82odw_1746015307", "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 v8 04/15] config: Add configuration retrieval helpers", "Date": "Wed, 30 Apr 2025 14:14:37 +0200", "Message-ID": "<20250430121449.39910-5-mzamazal@redhat.com>", "In-Reply-To": "<20250430121449.39910-1-mzamazal@redhat.com>", "References": "<20250430121449.39910-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": "VrTGCVYm4d4gq0FqQ9hSW26iq_KecYSDAZBAPFHxWtM_1746015307", "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 | 6 +++\n src/libcamera/base/global_configuration.cpp | 52 ++++++++++++++++++-\n src/libcamera/base/log.cpp | 13 ++---\n 3 files changed, 62 insertions(+), 9 deletions(-)", "diff": "diff --git a/include/libcamera/internal/global_configuration.h b/include/libcamera/internal/global_configuration.h\nindex bed88279..07062145 100644\n--- a/include/libcamera/internal/global_configuration.h\n+++ b/include/libcamera/internal/global_configuration.h\n@@ -7,6 +7,9 @@\n \n #pragma once\n \n+#include <optional>\n+#include <string>\n+\n #include \"libcamera/internal/yaml_parser.h\"\n \n namespace libcamera {\n@@ -19,6 +22,9 @@ void initialize();\n \n unsigned int version();\n Configuration configuration();\n+std::optional<std::string> option(const std::string &confPath);\n+std::optional<std::string> envOption(const char *const envVariable,\n+\t\t\t\t const std::string &confPath);\n \n } /* namespace GlobalConfiguration */\n \ndiff --git a/src/libcamera/base/global_configuration.cpp b/src/libcamera/base/global_configuration.cpp\nindex 8d823b98..84821f26 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 <sys/types.h>\n \n #include <libcamera/base/file.h>\n@@ -126,7 +128,10 @@ void initialize()\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 GlobalConfiguration::configuration().\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 /**\n@@ -137,6 +142,51 @@ void initialize()\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> option(const std::string &confPath)\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> envOption(\n+\tconst char *const envVariable,\n+\tconst std::string &confPath)\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 *\ndiff --git a/src/libcamera/base/log.cpp b/src/libcamera/base/log.cpp\nindex 4b287af0..3cda7c57 100644\n--- a/src/libcamera/base/log.cpp\n+++ b/src/libcamera/base/log.cpp\n@@ -624,14 +624,11 @@ void Logger::parseLogFile()\n */\n void Logger::parseLogLevels()\n {\n-\tconst char *debug = utils::secure_getenv(\"LIBCAMERA_LOG_LEVELS\");\n-\tif (!debug) {\n-\t\tconst std::optional<std::string> confDebug =\n-\t\t\tGlobalConfiguration::configuration()[\"log\"][\"levels\"].get<std::string>();\n-\t\tif (!confDebug.has_value())\n-\t\t\treturn;\n-\t\tdebug = confDebug.value().c_str();\n-\t}\n+\tconst std::optional<std::string> confDebug =\n+\t\tGlobalConfiguration::envOption(\"LIBCAMERA_LOG_LEVELS\", \"log.levels\");\n+\tif (!confDebug.has_value())\n+\t\treturn;\n+\tconst char *debug = confDebug.value().c_str();\n \n \tfor (const char *pair = debug; *debug != '\\0'; pair = debug) {\n \t\tconst char *comma = strchrnul(debug, ',');\n", "prefixes": [ "v8", "04/15" ] }