{"id":11832,"url":"https://patchwork.libcamera.org/api/patches/11832/?format=json","web_url":"https://patchwork.libcamera.org/patch/11832/","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":"<20210403135734.1600523-1-hiroh@chromium.org>","date":"2021-04-03T13:57:34","name":"[libcamera-devel,v6] android: CameraDevice: Fix Camera3RequestDescriptor leakage","commit_ref":null,"pull_url":null,"state":"accepted","archived":false,"hash":"6664558f22ffeba5ecfeadbd57cdd34b07126f99","submitter":{"id":63,"url":"https://patchwork.libcamera.org/api/people/63/?format=json","name":"Hirokazu Honda","email":"hiroh@chromium.org"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/11832/mbox/","series":[{"id":1888,"url":"https://patchwork.libcamera.org/api/series/1888/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=1888","date":"2021-04-03T13:57:34","name":"[libcamera-devel,v6] android: CameraDevice: Fix Camera3RequestDescriptor leakage","version":6,"mbox":"https://patchwork.libcamera.org/series/1888/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/11832/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/11832/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 357D1C0DA3\n\tfor ;\n\tSat, 3 Apr 2021 13:57:45 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 9BF40602E6;\n\tSat, 3 Apr 2021 15:57:44 +0200 (CEST)","from mail-pg1-x52b.google.com (mail-pg1-x52b.google.com\n\t[IPv6:2607:f8b0:4864:20::52b])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 694A4602CF\n\tfor ;\n\tSat, 3 Apr 2021 15:57:42 +0200 (CEST)","by mail-pg1-x52b.google.com with SMTP id b17so1595408pgh.7\n\tfor ;\n\tSat, 03 Apr 2021 06:57:42 -0700 (PDT)","from hiroh2.tok.corp.google.com\n\t([2401:fa00:8f:2:d1f5:1b96:f027:f646])\n\tby smtp.gmail.com with ESMTPSA id\n\te1sm11345988pfi.175.2021.04.03.06.57.39\n\t(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n\tSat, 03 Apr 2021 06:57:40 -0700 (PDT)"],"Authentication-Results":"lancelot.ideasonboard.com;\n\tdkim=fail reason=\"signature verification failed\" (1024-bit key;\n\tunprotected) header.d=chromium.org header.i=@chromium.org\n\theader.b=\"DhktLhhk\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org;\n\ts=google; h=from:to:cc:subject:date:message-id:mime-version\n\t:content-transfer-encoding;\n\tbh=2/qjJA9Ix6MT2C8XKK6yNXlpYziaJtkJr+QhxOpygeY=;\n\tb=DhktLhhk2M4m+wWDPMNJCjdbVz0aTnxEQ3w8/8EOe/InhUkI3ujxNqaxSwugADV8IR\n\tnSFXPQKusRRsgUgwXCgYaKTGHQcHHzaZ7mD4Xj3ZrpGo6zQkmJHcnCRvHwSUpA+9B6kn\n\twD2RszUydFzb772VP1NdEb4KyPMhN9FSwIpLY=","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20161025;\n\th=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version\n\t:content-transfer-encoding;\n\tbh=2/qjJA9Ix6MT2C8XKK6yNXlpYziaJtkJr+QhxOpygeY=;\n\tb=gjkxAPuxJTAnyzEVfWr1LEPw3/UravBsiywVX/7nXHFweZKGihFcZ62z0qfSenoMRz\n\tO7sKgapQmzPwDeN8MaJ2EEaGMmJjeESMhJxt2FK6hcpaaiZ14KGvXyfxfTWmPRB6/DdD\n\tHze1F4FDlzUYHTO+C8MgR1wGSiQTtInvZ+UGZJD1QSjwQh2DuAry7hlmZl20n160aeRd\n\tNxxWMhJOxgT5SC5ulbutGhobWgWhefmRmcOG7GDPnchKfu/3uJ+VJyM0ixCkSAiNcLSY\n\t/EmhavjU1HhQaHTSA/G19V1oGv80yCgUPFkjrXkPcSjE1ik5EYd1UgUeAPSoQL3q3okJ\n\tb92A==","X-Gm-Message-State":"AOAM530qI4Kp00JCgTqhXIXGDuiKQuvjQk0P2Y4HxjMwDRzeqcjN6zAu\n\t7eYKEk2I+K46PKoUQzqsRsUEaUSugYDBXw==","X-Google-Smtp-Source":"ABdhPJy3F79EB0zDIXfne2F0/TDw7YuwvHyGTECLPNSha0cj+pv9Vk6IffR4e/MNKV/CElQf2qtv4Q==","X-Received":"by 2002:a63:f914:: with SMTP id\n\th20mr15930303pgi.114.1617458260658; \n\tSat, 03 Apr 2021 06:57:40 -0700 (PDT)","From":"Hirokazu Honda ","To":"libcamera-devel@lists.libcamera.org","Date":"Sat, 3 Apr 2021 22:57:34 +0900","Message-Id":"<20210403135734.1600523-1-hiroh@chromium.org>","X-Mailer":"git-send-email 2.31.0.208.g409f899ff0-goog","MIME-Version":"1.0","Subject":"[libcamera-devel] [PATCH v6] android: CameraDevice: Fix\n\tCamera3RequestDescriptor leakage","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","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"CameraDevice creates Camera3RequestDescriptor in\nprocessCaptureRequest() and disallocates in requestComplete().\nCamera3RequestDescriptor can never be destroyed if\nrequestComplete() is never called. This avoid the memory\nleakage by storing them in map CameraRequestDescriptor.\n\nSigned-off-by: Hirokazu Honda \nReviewed-by: Laurent Pinchart \n---\n src/android/camera_device.cpp | 80 ++++++++++++++++++++---------------\n src/android/camera_device.h | 10 ++++-\n src/android/camera_worker.cpp | 4 +-\n src/android/camera_worker.h | 2 +-\n 4 files changed, 57 insertions(+), 39 deletions(-)","diff":"diff --git a/src/android/camera_device.cpp b/src/android/camera_device.cpp\nindex b45d3a54..9d6be1f9 100644\n--- a/src/android/camera_device.cpp\n+++ b/src/android/camera_device.cpp\n@@ -286,16 +286,12 @@ CameraDevice::Camera3RequestDescriptor::Camera3RequestDescriptor(\n \tsettings_ = CameraMetadata(camera3Request->settings);\n \n \t/*\n-\t * Create the libcamera::Request unique_ptr<> to tie its lifetime\n-\t * to the descriptor's one. Set the descriptor's address as the\n-\t * request's cookie to retrieve it at completion time.\n+\t * Create the libcamera::CaptureRequest unique_ptr<> to tie its lifetime\n+\t * to the descriptor's one.\n \t */\n-\trequest_ = std::make_unique(camera,\n-\t\t\t\t\t\t reinterpret_cast(this));\n+\trequest_ = std::make_unique(camera);\n }\n \n-CameraDevice::Camera3RequestDescriptor::~Camera3RequestDescriptor() = default;\n-\n /*\n * \\class CameraDevice\n *\n@@ -672,6 +668,7 @@ void CameraDevice::stop()\n \tworker_.stop();\n \tcamera_->stop();\n \n+\tdescriptors_.clear();\n \trunning_ = false;\n }\n \n@@ -1818,8 +1815,8 @@ int CameraDevice::processCaptureRequest(camera3_capture_request_t *camera3Reques\n \t * The descriptor and the associated memory reserved here are freed\n \t * at request complete time.\n \t */\n-\tCamera3RequestDescriptor *descriptor =\n-\t\tnew Camera3RequestDescriptor(camera_.get(), camera3Request);\n+\tCamera3RequestDescriptor descriptor(camera_.get(), camera3Request);\n+\n \t/*\n \t * \\todo The Android request model is incremental, settings passed in\n \t * previous requests are to be effective until overridden explicitly in\n@@ -1829,12 +1826,12 @@ int CameraDevice::processCaptureRequest(camera3_capture_request_t *camera3Reques\n \tif (camera3Request->settings)\n \t\tlastSettings_ = camera3Request->settings;\n \telse\n-\t\tdescriptor->settings_ = lastSettings_;\n+\t\tdescriptor.settings_ = lastSettings_;\n \n-\tLOG(HAL, Debug) << \"Queueing request \" << descriptor->request_->cookie()\n-\t\t\t<< \" with \" << descriptor->buffers_.size() << \" streams\";\n-\tfor (unsigned int i = 0; i < descriptor->buffers_.size(); ++i) {\n-\t\tconst camera3_stream_buffer_t &camera3Buffer = descriptor->buffers_[i];\n+\tLOG(HAL, Debug) << \"Queueing request \" << descriptor.request_->cookie()\n+\t\t\t<< \" with \" << descriptor.buffers_.size() << \" streams\";\n+\tfor (unsigned int i = 0; i < descriptor.buffers_.size(); ++i) {\n+\t\tconst camera3_stream_buffer_t &camera3Buffer = descriptor.buffers_[i];\n \t\tcamera3_stream *camera3Stream = camera3Buffer.stream;\n \t\tCameraStream *cameraStream = static_cast(camera3Stream->priv);\n \n@@ -1867,7 +1864,7 @@ int CameraDevice::processCaptureRequest(camera3_capture_request_t *camera3Reques\n \t\t\t * lifetime management only.\n \t\t\t */\n \t\t\tbuffer = createFrameBuffer(*camera3Buffer.buffer);\n-\t\t\tdescriptor->frameBuffers_.emplace_back(buffer);\n+\t\t\tdescriptor.frameBuffers_.emplace_back(buffer);\n \t\t\tLOG(HAL, Debug) << ss.str() << \" (direct)\";\n \t\t\tbreak;\n \n@@ -1886,11 +1883,10 @@ int CameraDevice::processCaptureRequest(camera3_capture_request_t *camera3Reques\n \n \t\tif (!buffer) {\n \t\t\tLOG(HAL, Error) << \"Failed to create buffer\";\n-\t\t\tdelete descriptor;\n \t\t\treturn -ENOMEM;\n \t\t}\n \n-\t\tdescriptor->request_->addBuffer(cameraStream->stream(), buffer,\n+\t\tdescriptor.request_->addBuffer(cameraStream->stream(), buffer,\n \t\t\t\t\t\tcamera3Buffer.acquire_fence);\n \t}\n \n@@ -1898,11 +1894,16 @@ int CameraDevice::processCaptureRequest(camera3_capture_request_t *camera3Reques\n \t * Translate controls from Android to libcamera and queue the request\n \t * to the CameraWorker thread.\n \t */\n-\tint ret = processControls(descriptor);\n+\tint ret = processControls(&descriptor);\n \tif (ret)\n \t\treturn ret;\n \n-\tworker_.queueRequest(descriptor->request_.get());\n+\tworker_.queueRequest(descriptor.request_.get());\n+\n+\t{\n+\t\tstd::scoped_lock lock(mutex_);\n+\t\tdescriptors_[descriptor.request_->cookie()] = std::move(descriptor);\n+\t}\n \n \treturn 0;\n }\n@@ -1912,8 +1913,21 @@ void CameraDevice::requestComplete(Request *request)\n \tconst Request::BufferMap &buffers = request->buffers();\n \tcamera3_buffer_status status = CAMERA3_BUFFER_STATUS_OK;\n \tstd::unique_ptr resultMetadata;\n-\tCamera3RequestDescriptor *descriptor =\n-\t\treinterpret_cast(request->cookie());\n+\n+\tdecltype(descriptors_)::node_type node;\n+\t{\n+\t\tstd::scoped_lock lock(mutex_);\n+\t\tauto it = descriptors_.find(request->cookie());\n+\t\tif (it == descriptors_.end()) {\n+\t\t\tLOG(HAL, Fatal)\n+\t\t\t\t<< \"Unknown request: \" << request->cookie();\n+\t\t\tstatus = CAMERA3_BUFFER_STATUS_ERROR;\n+\t\t\treturn;\n+\t\t}\n+\n+\t\tnode = descriptors_.extract(it);\n+\t}\n+\tCamera3RequestDescriptor &descriptor = node.mapped();\n \n \tif (request->status() != Request::RequestComplete) {\n \t\tLOG(HAL, Error) << \"Request not successfully completed: \"\n@@ -1922,7 +1936,7 @@ void CameraDevice::requestComplete(Request *request)\n \t}\n \n \tLOG(HAL, Debug) << \"Request \" << request->cookie() << \" completed with \"\n-\t\t\t<< descriptor->buffers_.size() << \" streams\";\n+\t\t\t<< descriptor.buffers_.size() << \" streams\";\n \n \t/*\n \t * \\todo The timestamp used for the metadata is currently always taken\n@@ -1931,10 +1945,10 @@ void CameraDevice::requestComplete(Request *request)\n \t * pipeline handlers) timestamp in the Request itself.\n \t */\n \tuint64_t timestamp = buffers.begin()->second->metadata().timestamp;\n-\tresultMetadata = getResultMetadata(*descriptor, timestamp);\n+\tresultMetadata = getResultMetadata(descriptor, timestamp);\n \n \t/* Handle any JPEG compression. */\n-\tfor (camera3_stream_buffer_t &buffer : descriptor->buffers_) {\n+\tfor (camera3_stream_buffer_t &buffer : descriptor.buffers_) {\n \t\tCameraStream *cameraStream =\n \t\t\tstatic_cast(buffer.stream->priv);\n \n@@ -1949,7 +1963,7 @@ void CameraDevice::requestComplete(Request *request)\n \n \t\tint ret = cameraStream->process(*src,\n \t\t\t\t\t\t*buffer.buffer,\n-\t\t\t\t\t\tdescriptor->settings_,\n+\t\t\t\t\t\tdescriptor.settings_,\n \t\t\t\t\t\tresultMetadata.get());\n \t\tif (ret) {\n \t\t\tstatus = CAMERA3_BUFFER_STATUS_ERROR;\n@@ -1966,17 +1980,17 @@ void CameraDevice::requestComplete(Request *request)\n \n \t/* Prepare to call back the Android camera stack. */\n \tcamera3_capture_result_t captureResult = {};\n-\tcaptureResult.frame_number = descriptor->frameNumber_;\n-\tcaptureResult.num_output_buffers = descriptor->buffers_.size();\n-\tfor (camera3_stream_buffer_t &buffer : descriptor->buffers_) {\n+\tcaptureResult.frame_number = descriptor.frameNumber_;\n+\tcaptureResult.num_output_buffers = descriptor.buffers_.size();\n+\tfor (camera3_stream_buffer_t &buffer : descriptor.buffers_) {\n \t\tbuffer.acquire_fence = -1;\n \t\tbuffer.release_fence = -1;\n \t\tbuffer.status = status;\n \t}\n-\tcaptureResult.output_buffers = descriptor->buffers_.data();\n+\tcaptureResult.output_buffers = descriptor.buffers_.data();\n \n \tif (status == CAMERA3_BUFFER_STATUS_OK) {\n-\t\tnotifyShutter(descriptor->frameNumber_, timestamp);\n+\t\tnotifyShutter(descriptor.frameNumber_, timestamp);\n \n \t\tcaptureResult.partial_result = 1;\n \t\tcaptureResult.result = resultMetadata->get();\n@@ -1989,13 +2003,11 @@ void CameraDevice::requestComplete(Request *request)\n \t\t * is here signalled. Make sure the error path plays well with\n \t\t * the camera stack state machine.\n \t\t */\n-\t\tnotifyError(descriptor->frameNumber_,\n-\t\t\t descriptor->buffers_[0].stream);\n+\t\tnotifyError(descriptor.frameNumber_,\n+\t\t\t descriptor.buffers_[0].stream);\n \t}\n \n \tcallbacks_->process_capture_result(callbacks_, &captureResult);\n-\n-\tdelete descriptor;\n }\n \n std::string CameraDevice::logPrefix() const\ndiff --git a/src/android/camera_device.h b/src/android/camera_device.h\nindex 39cf95ad..c63e8e21 100644\n--- a/src/android/camera_device.h\n+++ b/src/android/camera_device.h\n@@ -9,6 +9,7 @@\n \n #include \n #include \n+#include \n #include \n #include \n \n@@ -69,11 +70,13 @@ private:\n \tCameraDevice(unsigned int id, std::shared_ptr camera);\n \n \tstruct Camera3RequestDescriptor {\n+\t\tCamera3RequestDescriptor() = default;\n+\t\t~Camera3RequestDescriptor() = default;\n \t\tCamera3RequestDescriptor(libcamera::Camera *camera,\n \t\t\t\t\t const camera3_capture_request_t *camera3Request);\n-\t\t~Camera3RequestDescriptor();\n+\t\tCamera3RequestDescriptor &operator=(Camera3RequestDescriptor &&) = default;\n \n-\t\tuint32_t frameNumber_;\n+\t\tuint32_t frameNumber_ = 0;\n \t\tstd::vector buffers_;\n \t\tstd::vector> frameBuffers_;\n \t\tCameraMetadata settings_;\n@@ -124,6 +127,9 @@ private:\n \tstd::map formatsMap_;\n \tstd::vector streams_;\n \n+\tstd::mutex mutex_; /* Protect descriptors_ */\n+\tstd::map descriptors_;\n+\n \tstd::string maker_;\n \tstd::string model_;\n \ndiff --git a/src/android/camera_worker.cpp b/src/android/camera_worker.cpp\nindex df436460..300ddde0 100644\n--- a/src/android/camera_worker.cpp\n+++ b/src/android/camera_worker.cpp\n@@ -26,10 +26,10 @@ LOG_DECLARE_CATEGORY(HAL)\n * by the CameraWorker which queues it to the libcamera::Camera after handling\n * fences.\n */\n-CaptureRequest::CaptureRequest(libcamera::Camera *camera, uint64_t cookie)\n+CaptureRequest::CaptureRequest(libcamera::Camera *camera)\n \t: camera_(camera)\n {\n-\trequest_ = camera_->createRequest(cookie);\n+\trequest_ = camera_->createRequest(reinterpret_cast(this));\n }\n \n void CaptureRequest::addBuffer(Stream *stream, FrameBuffer *buffer, int fence)\ndiff --git a/src/android/camera_worker.h b/src/android/camera_worker.h\nindex d7060576..64b1658b 100644\n--- a/src/android/camera_worker.h\n+++ b/src/android/camera_worker.h\n@@ -22,7 +22,7 @@ class CameraDevice;\n class CaptureRequest\n {\n public:\n-\tCaptureRequest(libcamera::Camera *camera, uint64_t cookie);\n+\tCaptureRequest(libcamera::Camera *camera);\n \n \tconst std::vector &fences() const { return acquireFences_; }\n \tlibcamera::ControlList &controls() { return request_->controls(); }\n","prefixes":["libcamera-devel","v6"]}