[{"id":20877,"web_url":"https://patchwork.libcamera.org/comment/20877/","msgid":"","date":"2021-11-11T17:22:24","subject":"Re: [libcamera-devel] [RFC PATCH 4/6] android: camera_stream: Add\n\tthread safety annotation","submitter":{"id":86,"url":"https://patchwork.libcamera.org/api/people/86/","name":"Umang Jain","email":"umang.jain@ideasonboard.com"},"content":"Hi Hiro,\n\nthank you for the patch\n\nOn 10/29/21 9:44 AM, Hirokazu Honda wrote:\n> This applies clang thread safety annotation to CameraStream.\n> Mutex and MutexLocker there are replaced with Mutex2 and\n> MutexLocer2.\ns/MutexLocer2/MutexLocker2/  here as well as in rest of patches' commit \nmessage\n>\n> Signed-off-by: Hirokazu Honda \n> ---\n> src/android/camera_stream.cpp | 22 ++++++++++++----------\n> src/android/camera_stream.h | 13 +++++++------\n> 2 files changed, 19 insertions(+), 16 deletions(-)\n>\n> diff --git a/src/android/camera_stream.cpp b/src/android/camera_stream.cpp\n> index 9023c13c..c5272445 100644\n> --- a/src/android/camera_stream.cpp\n> +++ b/src/android/camera_stream.cpp\n> @@ -119,12 +119,13 @@ int CameraStream::configure()\n> \n> \tif (type_ == Type::Internal) {\n> \t\tallocator_ = std::make_unique(cameraDevice_->camera());\n> -\t\tmutex_ = std::make_unique();\n> +\t\tmutex_ = std::make_unique();\n> \n> \t\tint ret = allocator_->allocate(stream());\n> \t\tif (ret < 0)\n> \t\t\treturn ret;\n> \n> +\t\tMutexLocker2 lock(*mutex_);\n> \t\t/* Save a pointer to the reserved frame buffers */\n> \t\tfor (const auto &frameBuffer : allocator_->buffers(stream()))\n> \t\t\tbuffers_.push_back(frameBuffer.get());\n> @@ -208,7 +209,7 @@ FrameBuffer *CameraStream::getBuffer()\n> \tif (!allocator_)\n> \t\treturn nullptr;\n> \n> -\tstd::lock_guard locker(*mutex_);\n> +\tMutexLocker2 lock(*mutex_);\n> \n> \tif (buffers_.empty()) {\n> \t\tLOG(HAL, Error) << \"Buffer underrun\";\n> @@ -226,20 +227,21 @@ void CameraStream::putBuffer(FrameBuffer *buffer)\n> \tif (!allocator_)\n> \t\treturn;\n> \n> -\tstd::lock_guard locker(*mutex_);\n> +\tMutexLocker2 lock(*mutex_);\n> \n> \tbuffers_.push_back(buffer);\n> }\n> \n> CameraStream::PostProcessorWorker::PostProcessorWorker(PostProcessor *postProcessor)\n> -\t: postProcessor_(postProcessor)\n> +\t: postProcessor_(postProcessor),\n> +\t state_(State::Stopped)\n\n\nwhy this unrelated change? Also state_ is member initialized in \nPostProcessorWorker class definition\n\n> {\n> }\n> \n> CameraStream::PostProcessorWorker::~PostProcessorWorker()\n> {\n> \t{\n> -\t\tlibcamera::MutexLocker lock(mutex_);\n> +\t\tlibcamera::MutexLocker2 lock(mutex_);\n> \t\tstate_ = State::Stopped;\n> \t}\n> \n> @@ -250,7 +252,7 @@ CameraStream::PostProcessorWorker::~PostProcessorWorker()\n> void CameraStream::PostProcessorWorker::start()\n> {\n> \t{\n> -\t\tlibcamera::MutexLocker lock(mutex_);\n> +\t\tlibcamera::MutexLocker2 lock(mutex_);\n> \t\tASSERT(state_ != State::Running);\n> \t\tstate_ = State::Running;\n> \t}\n> @@ -261,7 +263,7 @@ void CameraStream::PostProcessorWorker::start()\n> void CameraStream::PostProcessorWorker::queueRequest(Camera3RequestDescriptor::StreamBuffer *dest)\n> {\n> \t{\n> -\t\tMutexLocker lock(mutex_);\n> +\t\tMutexLocker2 lock(mutex_);\n> \t\tASSERT(state_ == State::Running);\n> \t\trequests_.push(dest);\n> \t}\n> @@ -271,10 +273,10 @@ void CameraStream::PostProcessorWorker::queueRequest(Camera3RequestDescriptor::S\n> \n> void CameraStream::PostProcessorWorker::run()\n> {\n> -\tMutexLocker locker(mutex_);\n> +\tMutexLocker2 locker(mutex_);\n> \n> \twhile (1) {\n> -\t\tcv_.wait(locker, [&] {\n> +\t\tcv_.wait(locker.get(), [&]() REQUIRES(mutex_) {\n\n\nah nice spot!\n\n> \t\t\treturn state_ != State::Running || !requests_.empty();\n> \t\t});\n> \n> @@ -308,7 +310,7 @@ void CameraStream::PostProcessorWorker::run()\n> \n> void CameraStream::PostProcessorWorker::flush()\n> {\n> -\tlibcamera::MutexLocker lock(mutex_);\n> +\tMutexLocker2 lock(mutex_);\n> \tstate_ = State::Flushing;\n> \tlock.unlock();\n> \n> diff --git a/src/android/camera_stream.h b/src/android/camera_stream.h\n> index 0c402deb..665bdf5c 100644\n> --- a/src/android/camera_stream.h\n> +++ b/src/android/camera_stream.h\n> @@ -9,13 +9,14 @@\n> \n> #include \n> #include \n> -#include \n> #include \n> #include \n> \n> #include \n> \n> +#include \n> #include \n> +#include \n> \n> #include \n> #include \n> @@ -153,11 +154,11 @@ private:\n> \tprivate:\n> \t\tPostProcessor *postProcessor_;\n> \n> -\t\tlibcamera::Mutex mutex_;\n> +\t\tlibcamera::Mutex2 mutex_;\n> \t\tstd::condition_variable cv_;\n> \n> -\t\tstd::queue requests_;\n> -\t\tState state_ = State::Stopped;\n> +\t\tstd::queue requests_ GUARDED_BY(mutex_);\n> +\t\tState state_ GUARDED_BY(mutex_);\n\n\nah so that's why you have introduced setting the state_ via constructor. \nGUARDED_BY syntax can handle member - initialization?\n\nPatch seems on the right track so,\n\nReviewed-by: Umang Jain \n\n> \t};\n> \n> \tint waitFence(int fence);\n> @@ -169,12 +170,12 @@ private:\n> \tconst unsigned int index_;\n> \n> \tstd::unique_ptr allocator_;\n> -\tstd::vector buffers_;\n> +\tstd::vector buffers_ GUARDED_BY(mutex_);\n> \t/*\n> \t * The class has to be MoveConstructible as instances are stored in\n> \t * an std::vector in CameraDevice.\n> \t */\n> -\tstd::unique_ptr mutex_;\n> +\tstd::unique_ptr mutex_;\n> \tstd::unique_ptr postProcessor_;\n> \n> \tstd::unique_ptr worker_;","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 8232EBDB1C\n\tfor ;\n\tThu, 11 Nov 2021 17:22:32 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 734466035A;\n\tThu, 11 Nov 2021 18:22:31 +0100 (CET)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 134AF600B5\n\tfor ;\n\tThu, 11 Nov 2021 18:22:30 +0100 (CET)","from [192.168.1.106] (unknown [103.251.226.254])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id D1BDF5D;\n\tThu, 11 Nov 2021 18:22:28 +0100 (CET)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"dJfe7qZm\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1636651349;\n\tbh=704L6ylvrKWKuovhBQmusroD4zmDDoVarovNpNERpfI=;\n\th=Subject:To:References:From:Date:In-Reply-To:From;\n\tb=dJfe7qZmMRoUkMSUSAnblom9ITMJSpPU2xovSyqVT3uirTSDZKSBV8ktDBWnguuEp\n\to4iDpD6GGJ5KiEag/EqJEqkz6q/NaFMmeaV6jODohvHMn+qva5rMWci9DkMDp7Hg5h\n\trm6RlKqynstikA3YxWBZQLOqWIW1/KTLaoVi3IU0=","To":"Hirokazu Honda , libcamera-devel@lists.libcamera.org","References":"<20211029041424.1430886-1-hiroh@chromium.org>\n\t<20211029041424.1430886-5-hiroh@chromium.org>","From":"Umang Jain ","Message-ID":"","Date":"Thu, 11 Nov 2021 22:52:24 +0530","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101\n\tThunderbird/78.10.2","MIME-Version":"1.0","In-Reply-To":"<20211029041424.1430886-5-hiroh@chromium.org>","Content-Type":"text/plain; charset=utf-8; format=flowed","Content-Transfer-Encoding":"8bit","Content-Language":"en-US","Subject":"Re: [libcamera-devel] [RFC PATCH 4/6] android: camera_stream: Add\n\tthread safety annotation","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\" "}},{"id":20885,"web_url":"https://patchwork.libcamera.org/comment/20885/","msgid":"","date":"2021-11-11T23:09:03","subject":"Re: [libcamera-devel] [RFC PATCH 4/6] android: camera_stream: Add\n\tthread safety annotation","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Hiro,\n\nThank you for the patch.\n\nOn Fri, Oct 29, 2021 at 01:14:22PM +0900, Hirokazu Honda wrote:\n> This applies clang thread safety annotation to CameraStream.\n> Mutex and MutexLocker there are replaced with Mutex2 and\n> MutexLocer2.\n\nSame typo as in 3/6. Same for the next patches.\n\n> Signed-off-by: Hirokazu Honda \n> ---\n> src/android/camera_stream.cpp | 22 ++++++++++++----------\n> src/android/camera_stream.h | 13 +++++++------\n> 2 files changed, 19 insertions(+), 16 deletions(-)\n> \n> diff --git a/src/android/camera_stream.cpp b/src/android/camera_stream.cpp\n> index 9023c13c..c5272445 100644\n> --- a/src/android/camera_stream.cpp\n> +++ b/src/android/camera_stream.cpp\n> @@ -119,12 +119,13 @@ int CameraStream::configure()\n> \n> \tif (type_ == Type::Internal) {\n> \t\tallocator_ = std::make_unique(cameraDevice_->camera());\n> -\t\tmutex_ = std::make_unique();\n> +\t\tmutex_ = std::make_unique();\n> \n> \t\tint ret = allocator_->allocate(stream());\n> \t\tif (ret < 0)\n> \t\t\treturn ret;\n> \n> +\t\tMutexLocker2 lock(*mutex_);\n\nIs this a bug fix that thread safety annotation reported ? I'd split it\nto a separate patch.\n\n> \t\t/* Save a pointer to the reserved frame buffers */\n> \t\tfor (const auto &frameBuffer : allocator_->buffers(stream()))\n> \t\t\tbuffers_.push_back(frameBuffer.get());\n> @@ -208,7 +209,7 @@ FrameBuffer *CameraStream::getBuffer()\n> \tif (!allocator_)\n> \t\treturn nullptr;\n> \n> -\tstd::lock_guard locker(*mutex_);\n> +\tMutexLocker2 lock(*mutex_);\n> \n> \tif (buffers_.empty()) {\n> \t\tLOG(HAL, Error) << \"Buffer underrun\";\n> @@ -226,20 +227,21 @@ void CameraStream::putBuffer(FrameBuffer *buffer)\n> \tif (!allocator_)\n> \t\treturn;\n> \n> -\tstd::lock_guard locker(*mutex_);\n> +\tMutexLocker2 lock(*mutex_);\n> \n> \tbuffers_.push_back(buffer);\n> }\n> \n> CameraStream::PostProcessorWorker::PostProcessorWorker(PostProcessor *postProcessor)\n> -\t: postProcessor_(postProcessor)\n> +\t: postProcessor_(postProcessor),\n> +\t state_(State::Stopped)\n> {\n> }\n> \n> CameraStream::PostProcessorWorker::~PostProcessorWorker()\n> {\n> \t{\n> -\t\tlibcamera::MutexLocker lock(mutex_);\n> +\t\tlibcamera::MutexLocker2 lock(mutex_);\n> \t\tstate_ = State::Stopped;\n> \t}\n> \n> @@ -250,7 +252,7 @@ CameraStream::PostProcessorWorker::~PostProcessorWorker()\n> void CameraStream::PostProcessorWorker::start()\n> {\n> \t{\n> -\t\tlibcamera::MutexLocker lock(mutex_);\n> +\t\tlibcamera::MutexLocker2 lock(mutex_);\n> \t\tASSERT(state_ != State::Running);\n> \t\tstate_ = State::Running;\n> \t}\n> @@ -261,7 +263,7 @@ void CameraStream::PostProcessorWorker::start()\n> void CameraStream::PostProcessorWorker::queueRequest(Camera3RequestDescriptor::StreamBuffer *dest)\n> {\n> \t{\n> -\t\tMutexLocker lock(mutex_);\n> +\t\tMutexLocker2 lock(mutex_);\n> \t\tASSERT(state_ == State::Running);\n> \t\trequests_.push(dest);\n> \t}\n> @@ -271,10 +273,10 @@ void CameraStream::PostProcessorWorker::queueRequest(Camera3RequestDescriptor::S\n> \n> void CameraStream::PostProcessorWorker::run()\n> {\n> -\tMutexLocker locker(mutex_);\n> +\tMutexLocker2 locker(mutex_);\n> \n> \twhile (1) {\n> -\t\tcv_.wait(locker, [&] {\n> +\t\tcv_.wait(locker.get(), [&]() REQUIRES(mutex_) {\n> \t\t\treturn state_ != State::Running || !requests_.empty();\n> \t\t});\n> \n> @@ -308,7 +310,7 @@ void CameraStream::PostProcessorWorker::run()\n> \n> void CameraStream::PostProcessorWorker::flush()\n> {\n> -\tlibcamera::MutexLocker lock(mutex_);\n> +\tMutexLocker2 lock(mutex_);\n> \tstate_ = State::Flushing;\n> \tlock.unlock();\n> \n> diff --git a/src/android/camera_stream.h b/src/android/camera_stream.h\n> index 0c402deb..665bdf5c 100644\n> --- a/src/android/camera_stream.h\n> +++ b/src/android/camera_stream.h\n> @@ -9,13 +9,14 @@\n> \n> #include \n> #include \n> -#include \n> #include \n> #include \n> \n> #include \n> \n> +#include \n> #include \n> +#include \n> \n> #include \n> #include \n> @@ -153,11 +154,11 @@ private:\n> \tprivate:\n> \t\tPostProcessor *postProcessor_;\n> \n> -\t\tlibcamera::Mutex mutex_;\n> +\t\tlibcamera::Mutex2 mutex_;\n> \t\tstd::condition_variable cv_;\n> \n> -\t\tstd::queue requests_;\n> -\t\tState state_ = State::Stopped;\n> +\t\tstd::queue requests_ GUARDED_BY(mutex_);\n> +\t\tState state_ GUARDED_BY(mutex_);\n\nIs there a problem with\n\n\t\tState state_ GUARDED_BY(mutex_) = State::Stopped;\n\n?\n\n> \t};\n> \n> \tint waitFence(int fence);\n> @@ -169,12 +170,12 @@ private:\n> \tconst unsigned int index_;\n> \n> \tstd::unique_ptr allocator_;\n> -\tstd::vector buffers_;\n> +\tstd::vector buffers_ GUARDED_BY(mutex_);\n> \t/*\n> \t * The class has to be MoveConstructible as instances are stored in\n> \t * an std::vector in CameraDevice.\n> \t */\n> -\tstd::unique_ptr mutex_;\n> +\tstd::unique_ptr mutex_;\n> \tstd::unique_ptr postProcessor_;\n> \n> \tstd::unique_ptr worker_;","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 DA6E0BDB1C\n\tfor ;\n\tThu, 11 Nov 2021 23:09:28 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 36E2F6035A;\n\tFri, 12 Nov 2021 00:09:28 +0100 (CET)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 7FC436033C\n\tfor ;\n\tFri, 12 Nov 2021 00:09:26 +0100 (CET)","from pendragon.ideasonboard.com\n\t(117.145-247-81.adsl-dyn.isp.belgacom.be [81.247.145.117])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 0644D74C;\n\tFri, 12 Nov 2021 00:09:25 +0100 (CET)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"li0mX0pr\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1636672166;\n\tbh=FyXzEENDOhrCsvHQq53EgVFvAx64oQsyj1Vi2zl3cuE=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=li0mX0prSrdx2Lxiefo3pAX2foVL61THi3+0D3hpzhYpe+4p/Mw1JzlmubeK9GsQM\n\tnqkdq4fcbQZsURQB4RegQTzpVBC1yvcbO2dmkOWvgkCy0NAXC6ph/ywvZzKw/AzeAJ\n\tHEY+HjnldWDn9bvQGqRntY6mlohgNu8re1A72evM=","Date":"Fri, 12 Nov 2021 01:09:03 +0200","From":"Laurent Pinchart ","To":"Hirokazu Honda ","Message-ID":"","References":"<20211029041424.1430886-1-hiroh@chromium.org>\n\t<20211029041424.1430886-5-hiroh@chromium.org>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20211029041424.1430886-5-hiroh@chromium.org>","Subject":"Re: [libcamera-devel] [RFC PATCH 4/6] android: camera_stream: Add\n\tthread safety annotation","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","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]