{"id":21358,"url":"https://patchwork.libcamera.org/api/1.1/patches/21358/?format=json","web_url":"https://patchwork.libcamera.org/patch/21358/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/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":"<20240925095850.348259-6-mzamazal@redhat.com>","date":"2024-09-25T09:58:37","name":"[v4,05/15] config: Add configuration retrieval helpers","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"4c80076ba4ddba96123a5ea8cedbc6ed78a85a4c","submitter":{"id":177,"url":"https://patchwork.libcamera.org/api/1.1/people/177/?format=json","name":"Milan Zamazal","email":"mzamazal@redhat.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/21358/mbox/","series":[{"id":4623,"url":"https://patchwork.libcamera.org/api/1.1/series/4623/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4623","date":"2024-09-25T09:58:32","name":"Add global configuration file","version":4,"mbox":"https://patchwork.libcamera.org/series/4623/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/21358/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/21358/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 BF731C32D4\n\tfor ;\n\tWed, 25 Sep 2024 09:59:26 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 25DED6351D;\n\tWed, 25 Sep 2024 11:59:26 +0200 (CEST)","from us-smtp-delivery-124.mimecast.com\n\t(us-smtp-delivery-124.mimecast.com [170.10.133.124])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 77E1C63519\n\tfor ;\n\tWed, 25 Sep 2024 11:59:17 +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-294-3K4sir5SPe-7_iFbdSyCQg-1;\n\tWed, 25 Sep 2024 05:59:15 -0400","from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (unknown\n\t[10.30.177.12])\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 2B6131944D3F; Wed, 25 Sep 2024 09:59:14 +0000 (UTC)","from nuthatch.redhat.com (unknown [10.45.225.29])\n\tby mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTP id 816A719560AA; Wed, 25 Sep 2024 09:59:12 +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=\"cPA0vlJy\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n\ts=mimecast20190719; t=1727258356;\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=Jaf7vo8z00Ws93dllP/mMPDDGRvXqCIEo6X3HLXdaQc=;\n\tb=cPA0vlJym3YsMvFmVo6JuIuscWGqwNBqN4wGX00xi7E71Yn3W40vQxp5p3/vWnq6BLtklP\n\tqJ7GmoANanRE/AEFCSJgy8iVpt/uKoFF+qLIHeXQy8up6fB4sqrnJ9fUnuON9wdIsD1zPo\n\t8bYG5tS4pSFYOj6DQxd4ZkaGOZhBy6o=","X-MC-Unique":"3K4sir5SPe-7_iFbdSyCQg-1","From":"Milan Zamazal ","To":"libcamera-devel@lists.libcamera.org","Cc":"Milan Zamazal ,\n\tKieran Bingham ,\n\tNaushir Patuck ","Subject":"[PATCH v4 05/15] config: Add configuration retrieval helpers","Date":"Wed, 25 Sep 2024 11:58:37 +0200","Message-ID":"<20240925095850.348259-6-mzamazal@redhat.com>","In-Reply-To":"<20240925095850.348259-1-mzamazal@redhat.com>","References":"<20240925095850.348259-1-mzamazal@redhat.com>","MIME-Version":"1.0","X-Scanned-By":"MIMEDefang 3.0 on 10.30.177.12","X-Mimecast-Spam-Score":"0","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\nDue to the restrictions of YamlObject class, ugly type casting dance is\nneeded. Also, GlobalConfiguration::option must check for the key\npresence before retrieving the value using operator[] because if the key\nis not present then YamlObject::empty may be returned as a regular value.\n\nSigned-off-by: Milan Zamazal \n---\n .../libcamera/internal/global_configuration.h | 4 ++\n src/libcamera/base/global_configuration.cpp | 53 ++++++++++++++++++-\n src/libcamera/base/log.cpp | 13 ++---\n 3 files changed, 60 insertions(+), 10 deletions(-)","diff":"diff --git a/include/libcamera/internal/global_configuration.h b/include/libcamera/internal/global_configuration.h\nindex 2f38056a1..7c39c969a 100644\n--- a/include/libcamera/internal/global_configuration.h\n+++ b/include/libcamera/internal/global_configuration.h\n@@ -8,6 +8,7 @@\n #pragma once\n \n #include \n+#include \n #include \n \n #include \"libcamera/internal/yaml_parser.h\"\n@@ -21,6 +22,9 @@ public:\n \n \tstatic unsigned int version();\n \tstatic Configuration configuration();\n+\tstatic std::optional option(const std::string &confPath);\n+\tstatic std::optional envOption(const char *const envVariable,\n+\t\t\t\t\t\t const std::string &confPath);\n \n private:\n \tstatic const std::vector globalConfigurationFiles;\ndiff --git a/src/libcamera/base/global_configuration.cpp b/src/libcamera/base/global_configuration.cpp\nindex b45fd3419..b202cef9b 100644\n--- a/src/libcamera/base/global_configuration.cpp\n+++ b/src/libcamera/base/global_configuration.cpp\n@@ -10,6 +10,7 @@\n #include \n #include \n #include \n+#include \n #include \n \n #include \n@@ -41,8 +42,10 @@ LOG_DEFINE_CATEGORY(Configuration)\n * configuration files exist then only the first one found is used and no\n * configuration merging is performed.\n *\n- * The class is used as a private singleton and the configuration can be\n- * accessed usingGlobalConfiguration::configuration().\n+ * The class is used as a private singleton accessed by the provided\n+ * helpers. Namely GlobalConfiguration::option or GlobalConfiguration::envOption\n+ * to access individual options or GlobalConfiguration::configuration() to\n+ * access the whole configuration.\n */\n \n /**\n@@ -141,6 +144,52 @@ GlobalConfiguration::Configuration GlobalConfiguration::get()\n \treturn (*instance().configuration_);\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 GlobalConfiguration::option(\n+\tconst std::string &confPath)\n+{\n+\tYamlObject *c = &const_cast(configuration());\n+\tfor (auto part : utils::details::StringSplitter(confPath, \".\"))\n+\t\tif (c->contains(part))\n+\t\t\tc = &const_cast((*c)[part]);\n+\t\telse\n+\t\t\treturn std::optional();\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 *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 0f6767107..891b4ae9d 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":["v4","05/15"]}