{"id":19917,"url":"https://patchwork.libcamera.org/api/patches/19917/?format=json","web_url":"https://patchwork.libcamera.org/patch/19917/","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":"<20240423103034.364150-4-mzamazal@redhat.com>","date":"2024-04-23T10:30:18","name":"[v2,03/13] config: Look up logging levels in the configuration file","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"613020213f254271b98d1c77360b233bbb7f9a84","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/19917/mbox/","series":[{"id":4267,"url":"https://patchwork.libcamera.org/api/series/4267/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4267","date":"2024-04-23T10:30:15","name":"Add global configuration file","version":2,"mbox":"https://patchwork.libcamera.org/series/4267/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/19917/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/19917/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 3DAE4BE08B\n\tfor ;\n\tTue, 23 Apr 2024 10:31:24 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id D7A3C633ED;\n\tTue, 23 Apr 2024 12:31:23 +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 EFC5761B3D\n\tfor ;\n\tTue, 23 Apr 2024 12:31:21 +0200 (CEST)","from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com\n\t[66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS\n\t(version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id\n\tus-mta-609-l24x3RVgM0ioKpSfBTFiSw-1; Tue, 23 Apr 2024 06:31:19 -0400","from smtp.corp.redhat.com\n\t(int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7])\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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id F01DE800CA2;\n\tTue, 23 Apr 2024 10:31:18 +0000 (UTC)","from nuthatch.redhat.com (unknown [10.45.225.63])\n\tby smtp.corp.redhat.com (Postfix) with ESMTP id 07DA71C0654B;\n\tTue, 23 Apr 2024 10:31:17 +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=\"BTealilz\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n\ts=mimecast20190719; t=1713868281;\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=fP4E6jc5dGCpe9/ZUllkgi5x75IviwFPZInRlJ1lYv4=;\n\tb=BTealilzBRDJJGzVb/9Xdd2/OSSScdQWAoyPkFZx6qxLC45YKRbr8cWgMRac+qz9Az+02N\n\tNOyST0AWoVAXHKmdAjM6pgbJTuv3E2HJbY/w06uRlQMCHQeX2XyGucX5LZEJUeK8/xm6rr\n\tmp+L8ygp7toc9l9VfvEFbaAjbo2Thuc=","X-MC-Unique":"l24x3RVgM0ioKpSfBTFiSw-1","From":"Milan Zamazal ","To":"libcamera-devel@lists.libcamera.org","Cc":"Milan Zamazal ,\n\tNaushir Patuck ","Subject":"[PATCH v2 03/13] config: Look up logging levels in the configuration\n\tfile","Date":"Tue, 23 Apr 2024 12:30:18 +0200","Message-ID":"<20240423103034.364150-4-mzamazal@redhat.com>","In-Reply-To":"<20240423103034.364150-1-mzamazal@redhat.com>","References":"<20240423103034.364150-1-mzamazal@redhat.com>","MIME-Version":"1.0","X-Scanned-By":"MIMEDefang 3.4.1 on 10.11.54.7","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":"In addition to LIBCAMERA_LOG_LEVELS environment variable, expose the\nsame configuration in the configuration file.\n\nBecause logging asks for configuration and configuration loading uses\nlogging, extra care is needed. We must prevent calling any log function\nbefore configuration is loaded. Otherwise the log function would ask\nfor configuration, it would load the configuration files and would try\nto log the results, which would cause mutex deadlock due to calling\nlogging inside logging. Not logging in configuration is not an option,\nat least without introducing complicated mechanism such as delayed\nlogging, because we need to log at least errors when reading the\nconfiguration.\n\nWe must also prevent logging in configuration loading before the\nconfiguration is loaded and available (or there is an error in loading\nthe configuration). Otherwise logging would see an empty configuration\nand wouldn't be configured as asked.\n\nPreventing logging before configuration is loaded is ensured by asking\nfor configuration in CameraManager constructor and in IPAManager\nconstructor (which is mysteriously loaded from CameraManager constructor\nbefore its body is executed). This seems to be sufficient at least for\nsoftware ISP.\n\nThe configuration snippet for logging looks as follows:\n\n configuration:\n log:\n levels: LIBCAMERA_LOG_LEVELS\n\nSigned-off-by: Milan Zamazal \n---\n src/libcamera/base/global_configuration.cpp | 18 +++++++++++++++++-\n src/libcamera/base/log.cpp | 12 ++++++++++--\n src/libcamera/camera_manager.cpp | 9 +++++++++\n src/libcamera/ipa_manager.cpp | 12 ++++++++++++\n 4 files changed, 48 insertions(+), 3 deletions(-)","diff":"diff --git a/src/libcamera/base/global_configuration.cpp b/src/libcamera/base/global_configuration.cpp\nindex 96088b36..b45fd341 100644\n--- a/src/libcamera/base/global_configuration.cpp\n+++ b/src/libcamera/base/global_configuration.cpp\n@@ -29,6 +29,13 @@ LOG_DEFINE_CATEGORY(Configuration)\n * The configuration file is a YAML file and the configuration itself is stored\n * under `configuration' top-level item.\n *\n+ * Example configuration file content:\n+ * \\code{.yaml}\n+ * configuration:\n+ * log:\n+ * levels: 'IPAManager:DEBUG'\n+ * \\endcode\n+ *\n * The configuration file is looked up in user's home directory first and if it\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@@ -57,6 +64,11 @@ const std::vector\n \t\tstd::filesystem::path(\"/etc/libcamera/configuration.yaml\"),\n \t};\n \n+/*\n+ * Care is needed here to not log anything before the configuration is\n+ * loaded otherwise the logger would be initialized with empty configuration.\n+ */\n+\n void GlobalConfiguration::load()\n {\n \tstd::filesystem::path userConfigurationDirectory;\n@@ -87,10 +99,15 @@ void GlobalConfiguration::load()\n \n bool GlobalConfiguration::loadFile(const std::filesystem::path &fileName)\n {\n+\t/*\n+\t * initialized_ must be set to true before any logging is called!\n+\t */\n+\n \tFile file(fileName);\n \tif (!file.exists()) {\n \t\treturn false;\n \t}\n+\tinitialized_ = true;\n \n \tif (!file.open(File::OpenModeFlag::ReadOnly)) {\n \t\tLOG(Configuration, Warning)\n@@ -105,7 +122,6 @@ bool GlobalConfiguration::loadFile(const std::filesystem::path &fileName)\n \t\treturn true;\n \t}\n \tconfiguration_ = std::move(root);\n-\tinitialized_ = true;\n \tLOG(Configuration, Info) << \"Configuration file \" << fileName << \"loaded\";\n \n \treturn true;\ndiff --git a/src/libcamera/base/log.cpp b/src/libcamera/base/log.cpp\nindex c8045ef7..0564306d 100644\n--- a/src/libcamera/base/log.cpp\n+++ b/src/libcamera/base/log.cpp\n@@ -14,6 +14,7 @@\n #include \n #include \n #include \n+#include \n #include \n #include \n #include \n@@ -25,6 +26,8 @@\n #include \n #include \n \n+#include \"libcamera/internal/global_configuration.h\"\n+\n /**\n * \\file base/log.h\n * \\brief Logging infrastructure\n@@ -626,8 +629,13 @@ void Logger::parseLogFile()\n void Logger::parseLogLevels()\n {\n \tconst char *debug = utils::secure_getenv(\"LIBCAMERA_LOG_LEVELS\");\n-\tif (!debug)\n-\t\treturn;\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 \n \tfor (const char *pair = debug; *debug != '\\0'; pair = debug) {\n \t\tconst char *comma = strchrnul(debug, ',');\ndiff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp\nindex 355f3ada..cff8e80c 100644\n--- a/src/libcamera/camera_manager.cpp\n+++ b/src/libcamera/camera_manager.cpp\n@@ -15,6 +15,7 @@\n \n #include \"libcamera/internal/camera.h\"\n #include \"libcamera/internal/device_enumerator.h\"\n+#include \"libcamera/internal/global_configuration.h\"\n #include \"libcamera/internal/pipeline_handler.h\"\n \n /**\n@@ -37,6 +38,14 @@ LOG_DEFINE_CATEGORY(Camera)\n CameraManager::Private::Private()\n \t: initialized_(false)\n {\n+\t/*\n+\t * This is needed to initialize global configuration\n+\t * before any logging is called. Actually, IPAManager\n+\t * constructor is called before this, so the configuration\n+\t * call is superfluous here, but the initialization belongs\n+\t * here.\n+\t */\n+\tGlobalConfiguration::configuration();\n }\n \n int CameraManager::Private::start()\ndiff --git a/src/libcamera/ipa_manager.cpp b/src/libcamera/ipa_manager.cpp\nindex 7a4515d9..5104b930 100644\n--- a/src/libcamera/ipa_manager.cpp\n+++ b/src/libcamera/ipa_manager.cpp\n@@ -16,6 +16,7 @@\n #include \n #include \n \n+#include \"libcamera/internal/global_configuration.h\"\n #include \"libcamera/internal/ipa_module.h\"\n #include \"libcamera/internal/ipa_proxy.h\"\n #include \"libcamera/internal/pipeline_handler.h\"\n@@ -105,6 +106,17 @@ IPAManager *IPAManager::self_ = nullptr;\n */\n IPAManager::IPAManager()\n {\n+\t/*\n+\t * Make sure configuration is loaded early.\n+\t * Otherwise there would be problems with mutual\n+\t * configuration-logging dependencies.\n+\t *\n+\t * This is needed to be here in addition to CameraManager constructor\n+\t * because logging is called before CameraManager constructor body is\n+\t * executed.\n+\t */\n+\tGlobalConfiguration::configuration();\n+\n \tif (self_)\n \t\tLOG(IPAManager, Fatal)\n \t\t\t<< \"Multiple IPAManager objects are not allowed\";\n","prefixes":["v2","03/13"]}