{"id":22240,"url":"https://patchwork.libcamera.org/api/patches/22240/?format=json","web_url":"https://patchwork.libcamera.org/patch/22240/","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":"<20241206171148.1189292-5-mzamazal@redhat.com>","date":"2024-12-06T17:11:35","name":"[v6,04/16] 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=json","name":"Milan Zamazal","email":"mzamazal@redhat.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/22240/mbox/","series":[{"id":4861,"url":"https://patchwork.libcamera.org/api/series/4861/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4861","date":"2024-12-06T17:11:31","name":"Add global configuration file","version":6,"mbox":"https://patchwork.libcamera.org/series/4861/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/22240/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/22240/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 39AF7BF415\n\tfor ;\n\tFri, 6 Dec 2024 17:12:22 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id EBEE767E2E;\n\tFri, 6 Dec 2024 18:12:21 +0100 (CET)","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 14C0C67E30\n\tfor ;\n\tFri, 6 Dec 2024 18:12:19 +0100 (CET)","from mx-prod-mc-02.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-517-a0LkBHsuNBKplZKaPz0Z4g-1;\n\tFri, 06 Dec 2024 12:12:14 -0500","from mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com\n\t(mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.4])\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-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTPS id C84101956056; Fri, 6 Dec 2024 17:12:13 +0000 (UTC)","from nuthatch.redhat.com (unknown [10.45.224.27])\n\tby mx-prod-int-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTP id 390E7300019E; Fri, 6 Dec 2024 17:12:10 +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=\"S9f8oO7j\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n\ts=mimecast20190719; t=1733505137;\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=8yYo1benTvlMAA50SviUQ+PNgqjAduQH1Vhl8ZFiUBo=;\n\tb=S9f8oO7jOdMBO9niRiYI62uQHmCuZhVRtniG5TchnB55qPaQuzvn20IP3dHwYipJRmWCRu\n\tCSit0JokCkPT+cMdrldQdyWZYfd7J4z4l8FlL/fiIUZS1TjUbbXPp6jOWsI5Aj9XQcrWMX\n\thNjox0EFvGW3KCMr3QAgnMhAgC7A6PI=","X-MC-Unique":"a0LkBHsuNBKplZKaPz0Z4g-1","X-Mimecast-MFC-AGG-ID":"a0LkBHsuNBKplZKaPz0Z4g","From":"Milan Zamazal ","To":"libcamera-devel@lists.libcamera.org","Cc":"Milan Zamazal , Kieran Bingham\n\t, Naushir Patuck\n\t, =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?=\n\t, Laurent Pinchart\n\t","Subject":"[PATCH v6 04/16] config: Add configuration retrieval helpers","Date":"Fri, 6 Dec 2024 18:11:35 +0100","Message-ID":"<20241206171148.1189292-5-mzamazal@redhat.com>","In-Reply-To":"<20241206171148.1189292-1-mzamazal@redhat.com>","References":"<20241206171148.1189292-1-mzamazal@redhat.com>","MIME-Version":"1.0","X-Scanned-By":"MIMEDefang 3.4.1 on 10.30.177.4","X-Mimecast-Spam-Score":"0","X-Mimecast-MFC-PROC-ID":"-qv9sL9RjO2GIw02qQa9ThYlaUnATsOCdwSoUOL7Q1Q_1733505133","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":"They make accessing simple configuration values simpler.\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 \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 \n+#include \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 option(const std::string &confPath);\n+std::optional 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 \n+#include \n+#include \n #include \n \n #include \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 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();\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 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 0f676710..891b4ae9 100644\n--- a/src/libcamera/base/log.cpp\n+++ b/src/libcamera/base/log.cpp\n@@ -628,14 +628,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 confDebug =\n-\t\t\tGlobalConfiguration::configuration()[\"log\"][\"levels\"].get();\n-\t\tif (!confDebug.has_value())\n-\t\t\treturn;\n-\t\tdebug = confDebug.value().c_str();\n-\t}\n+\tconst std::optional 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":["v6","04/16"]}