{"id":23792,"url":"https://patchwork.libcamera.org/api/patches/23792/?format=json","web_url":"https://patchwork.libcamera.org/patch/23792/","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":"<20250711201232.129264-4-mzamazal@redhat.com>","date":"2025-07-11T20:12:22","name":"[v13,03/12] config: Add configuration retrieval helpers","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"a210ae32aa333e1799014f7852199a0b1e893235","submitter":{"id":177,"url":"https://patchwork.libcamera.org/api/people/177/?format=json","name":"Milan Zamazal","email":"mzamazal@redhat.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/23792/mbox/","series":[{"id":5282,"url":"https://patchwork.libcamera.org/api/series/5282/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=5282","date":"2025-07-11T20:12:19","name":"Add global configuration file","version":13,"mbox":"https://patchwork.libcamera.org/series/5282/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/23792/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/23792/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 4C9A6C3237\n\tfor ;\n\tFri, 11 Jul 2025 20:12:53 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id BB97F68F2E;\n\tFri, 11 Jul 2025 22:12:52 +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 2B4C768F1B\n\tfor ;\n\tFri, 11 Jul 2025 22:12:51 +0200 (CEST)","from mx-prod-mc-05.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-491-vjajVzWuNHaSOoQnIo2iBg-1;\n\tFri, 11 Jul 2025 16:12:47 -0400","from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com\n\t(mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com\n\t[10.30.177.40])\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-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTPS id B1BCA1956080; Fri, 11 Jul 2025 20:12:46 +0000 (UTC)","from mzamazal-thinkpadp1gen7.tpbc.com (unknown [10.45.224.49])\n\tby mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTP id DB41E1955F21; Fri, 11 Jul 2025 20:12:44 +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=\"fyBybspw\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n\ts=mimecast20190719; t=1752264770;\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=ouQbv2pcbCE2MzfIO37pQwExN3Dc7Q1tLUEjAlu5KFo=;\n\tb=fyBybspw8voFpewYvIp2DnCynFtAek3Kl//xPUIWJBLUE0Z2M67PZ1csMryoQONeWB75qP\n\thtd9dijVTD1FX4YR/bcHIK5kZEr8OD9WGzOuQf2jNv1b5D00YgaZbr/4V6EbrmX2YAb74l\n\tnZLtNcpaT4ChmJ3aBPuHGKkcVZRGAaY=","X-MC-Unique":"vjajVzWuNHaSOoQnIo2iBg-1","X-Mimecast-MFC-AGG-ID":"vjajVzWuNHaSOoQnIo2iBg_1752264766","From":"Milan Zamazal ","To":"libcamera-devel@lists.libcamera.org","Cc":"Milan Zamazal , Kieran Bingham\n\t, =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?=\n\t, Laurent Pinchart\n\t","Subject":"[PATCH v13 03/12] config: Add configuration retrieval helpers","Date":"Fri, 11 Jul 2025 22:12:22 +0200","Message-ID":"<20250711201232.129264-4-mzamazal@redhat.com>","In-Reply-To":"<20250711201232.129264-1-mzamazal@redhat.com>","References":"<20250711201232.129264-1-mzamazal@redhat.com>","MIME-Version":"1.0","X-Scanned-By":"MIMEDefang 3.0 on 10.30.177.40","X-Mimecast-Spam-Score":"0","X-Mimecast-MFC-PROC-ID":"GQM4pORfUXUEGM7u-RXiLIKQj6UAq87goWoWNEw7QEo_1752264766","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":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"Let's add some helpers to make accessing simple configuration values\nsimpler.\n\nGlobalConfiguration::option ensures that no value is returned rather\nthan a value of YamlObject::empty.\n\nSigned-off-by: Milan Zamazal \n---\n .../libcamera/internal/global_configuration.h | 8 +++\n src/libcamera/global_configuration.cpp | 53 +++++++++++++++++++\n 2 files changed, 61 insertions(+)","diff":"diff --git a/include/libcamera/internal/global_configuration.h b/include/libcamera/internal/global_configuration.h\nindex 3eaf39c94..4a9b1efd6 100644\n--- a/include/libcamera/internal/global_configuration.h\n+++ b/include/libcamera/internal/global_configuration.h\n@@ -8,6 +8,9 @@\n #pragma once\n \n #include \n+#include \n+#include \n+#include \n \n #include \"libcamera/internal/yaml_parser.h\"\n \n@@ -22,6 +25,11 @@ public:\n \n \tunsigned int version() const;\n \tConfiguration configuration() const;\n+\tstd::optional option(\n+\t\tconst std::initializer_list confPath) const;\n+\tstd::optional envOption(\n+\t\tconst char *const envVariable,\n+\t\tconst std::initializer_list confPath) const;\n \n private:\n \tbool loadFile(const std::filesystem::path &fileName);\ndiff --git a/src/libcamera/global_configuration.cpp b/src/libcamera/global_configuration.cpp\nindex 9a798ba63..f98744200 100644\n--- a/src/libcamera/global_configuration.cpp\n+++ b/src/libcamera/global_configuration.cpp\n@@ -8,6 +8,8 @@\n #include \"libcamera/internal/global_configuration.h\"\n \n #include \n+#include \n+#include \n #include \n #include \n \n@@ -39,6 +41,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@@ -107,6 +114,52 @@ 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\n+ * \\return A value if an item corresponding to \\a confPath exists in the\n+ * configuration file, no value otherwise\n+ */\n+std::optional GlobalConfiguration::option(\n+\tconst std::initializer_list confPath) const\n+{\n+\tconst YamlObject *c = &configuration();\n+\tfor (auto part : confPath) {\n+\t\tc = &(*c)[part];\n+\t\tif (!*c)\n+\t\t\treturn {};\n+\t}\n+\treturn c->get();\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 GlobalConfiguration::envOption(\n+\tconst char *envVariable,\n+\tconst std::initializer_list 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":["v13","03/12"]}