[{"id":14157,"web_url":"https://patchwork.libcamera.org/comment/14157/","msgid":"<223c78b6-a403-e203-3497-7a6917062d82@ideasonboard.com>","date":"2020-12-08T22:25:00","subject":"Re: [libcamera-devel] [PATCH 2/2] libcamera: v4l2_device: Return a\n\tunique pointer from fromEntityName()","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hi Laurent,\n\nOn 08/12/2020 01:49, Laurent Pinchart wrote:\n> The fromEntityName() function returns a pointer to a newly allocated\n> V4L2Device instance, which must be deleted by the caller. This opens the\n> door to memory leaks. Return a unique pointer instead, which conveys the\n> API semantics better than a sentence in the documentation.\n> \n> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> ---\n>  include/libcamera/internal/v4l2_videodevice.h |  4 ++--\n>  src/libcamera/pipeline/ipu3/cio2.cpp          |  3 +--\n>  src/libcamera/pipeline/ipu3/cio2.h            |  2 +-\n>  src/libcamera/pipeline/ipu3/imgu.cpp          | 10 ++++------\n>  src/libcamera/pipeline/rkisp1/rkisp1.cpp      | 13 +++----------\n>  src/libcamera/pipeline/rkisp1/rkisp1_path.cpp |  7 +------\n>  src/libcamera/pipeline/rkisp1/rkisp1_path.h   |  3 +--\n>  src/libcamera/v4l2_videodevice.cpp            | 10 ++++------\n>  test/libtest/buffer_source.cpp                |  2 +-\n>  9 files changed, 18 insertions(+), 36 deletions(-)\n> \n> diff --git a/include/libcamera/internal/v4l2_videodevice.h b/include/libcamera/internal/v4l2_videodevice.h\n> index 661503d1565a..529ca0e359d6 100644\n> --- a/include/libcamera/internal/v4l2_videodevice.h\n> +++ b/include/libcamera/internal/v4l2_videodevice.h\n> @@ -210,8 +210,8 @@ public:\n>  \tint streamOn();\n>  \tint streamOff();\n>  \n> -\tstatic V4L2VideoDevice *fromEntityName(const MediaDevice *media,\n> -\t\t\t\t\t       const std::string &entity);\n> +\tstatic std::unique_ptr<V4L2VideoDevice>\n> +\tfromEntityName(const MediaDevice *media, const std::string &entity);\n>  \n>  \tV4L2PixelFormat toV4L2PixelFormat(const PixelFormat &pixelFormat);\n>  \n> diff --git a/src/libcamera/pipeline/ipu3/cio2.cpp b/src/libcamera/pipeline/ipu3/cio2.cpp\n> index e43ec70fe3e4..821715e325b4 100644\n> --- a/src/libcamera/pipeline/ipu3/cio2.cpp\n> +++ b/src/libcamera/pipeline/ipu3/cio2.cpp\n> @@ -33,13 +33,12 @@ const std::map<uint32_t, PixelFormat> mbusCodesToPixelFormat = {\n>  } /* namespace */\n>  \n>  CIO2Device::CIO2Device()\n> -\t: sensor_(nullptr), csi2_(nullptr), output_(nullptr)\n> +\t: sensor_(nullptr), csi2_(nullptr)\n>  {\n>  }\n>  \n>  CIO2Device::~CIO2Device()\n>  {\n> -\tdelete output_;\n>  \tdelete csi2_;\n>  \tdelete sensor_;\n>  }\n> diff --git a/src/libcamera/pipeline/ipu3/cio2.h b/src/libcamera/pipeline/ipu3/cio2.h\n> index fa813a989fd2..0dca9673ca07 100644\n> --- a/src/libcamera/pipeline/ipu3/cio2.h\n> +++ b/src/libcamera/pipeline/ipu3/cio2.h\n> @@ -63,7 +63,7 @@ private:\n>  \n>  \tCameraSensor *sensor_;\n>  \tV4L2Subdevice *csi2_;\n> -\tV4L2VideoDevice *output_;\n> +\tstd::unique_ptr<V4L2VideoDevice> output_;\n>  \n>  \tstd::vector<std::unique_ptr<FrameBuffer>> buffers_;\n>  \tstd::queue<FrameBuffer *> availableBuffers_;\n> diff --git a/src/libcamera/pipeline/ipu3/imgu.cpp b/src/libcamera/pipeline/ipu3/imgu.cpp\n> index bfe9624c7797..5b1c0318b426 100644\n> --- a/src/libcamera/pipeline/ipu3/imgu.cpp\n> +++ b/src/libcamera/pipeline/ipu3/imgu.cpp\n> @@ -348,24 +348,22 @@ int ImgUDevice::init(MediaDevice *media, unsigned int index)\n>  \tif (ret)\n>  \t\treturn ret;\n>  \n> -\tinput_.reset(V4L2VideoDevice::fromEntityName(media, name_ + \" input\"));\n> +\tinput_ = V4L2VideoDevice::fromEntityName(media, name_ + \" input\");\n>  \tret = input_->open();\n>  \tif (ret)\n>  \t\treturn ret;\n>  \n> -\toutput_.reset(V4L2VideoDevice::fromEntityName(media,\n> -\t\t\t\t\t\t      name_ + \" output\"));\n> +\toutput_ = V4L2VideoDevice::fromEntityName(media, name_ + \" output\");\n>  \tret = output_->open();\n>  \tif (ret)\n>  \t\treturn ret;\n>  \n> -\tviewfinder_.reset(V4L2VideoDevice::fromEntityName(media,\n> -\t\t\t\t\t\t\t  name_ + \" viewfinder\"));\n> +\tviewfinder_ = V4L2VideoDevice::fromEntityName(media, name_ + \" viewfinder\");\n>  \tret = viewfinder_->open();\n>  \tif (ret)\n>  \t\treturn ret;\n>  \n> -\tstat_.reset(V4L2VideoDevice::fromEntityName(media, name_ + \" 3a stat\"));\n> +\tstat_ = V4L2VideoDevice::fromEntityName(media, name_ + \" 3a stat\");\n\nResetting to something just feels awkward, so I certainly like all that.\n\n\n>  \tret = stat_->open();\n>  \tif (ret)\n>  \t\treturn ret;\n> diff --git a/src/libcamera/pipeline/rkisp1/rkisp1.cpp b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n> index bcfe6c0514ab..064ab01057f4 100644\n> --- a/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n> +++ b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n> @@ -178,7 +178,6 @@ class PipelineHandlerRkISP1 : public PipelineHandler\n>  {\n>  public:\n>  \tPipelineHandlerRkISP1(CameraManager *manager);\n> -\t~PipelineHandlerRkISP1();\n>  \n>  \tCameraConfiguration *generateConfiguration(Camera *camera,\n>  \t\tconst StreamRoles &roles) override;\n> @@ -218,8 +217,8 @@ private:\n>  \n>  \tMediaDevice *media_;\n>  \tstd::unique_ptr<V4L2Subdevice> isp_;\n> -\tV4L2VideoDevice *param_;\n> -\tV4L2VideoDevice *stat_;\n> +\tstd::unique_ptr<V4L2VideoDevice> param_;\n> +\tstd::unique_ptr<V4L2VideoDevice> stat_;\n>  \n>  \tRkISP1MainPath mainPath_;\n>  \tRkISP1SelfPath selfPath_;\n> @@ -599,16 +598,10 @@ CameraConfiguration::Status RkISP1CameraConfiguration::validate()\n>  }\n>  \n>  PipelineHandlerRkISP1::PipelineHandlerRkISP1(CameraManager *manager)\n> -\t: PipelineHandler(manager), param_(nullptr), stat_(nullptr)\n> +\t: PipelineHandler(manager)\n>  {\n>  }\n>  \n> -PipelineHandlerRkISP1::~PipelineHandlerRkISP1()\n> -{\n> -\tdelete param_;\n> -\tdelete stat_;\n> -}\n\nAnd we no longer need a destructor - even better.\n\nReviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>\n\n> -\n>  /* -----------------------------------------------------------------------------\n>   * Pipeline Operations\n>   */\n> diff --git a/src/libcamera/pipeline/rkisp1/rkisp1_path.cpp b/src/libcamera/pipeline/rkisp1/rkisp1_path.cpp\n> index e05d9dd657cd..25f482eb8d8e 100644\n> --- a/src/libcamera/pipeline/rkisp1/rkisp1_path.cpp\n> +++ b/src/libcamera/pipeline/rkisp1/rkisp1_path.cpp\n> @@ -24,15 +24,10 @@ RkISP1Path::RkISP1Path(const char *name, const Span<const PixelFormat> &formats,\n>  \t\t       const Size &minResolution, const Size &maxResolution)\n>  \t: name_(name), running_(false), formats_(formats),\n>  \t  minResolution_(minResolution), maxResolution_(maxResolution),\n> -\t  video_(nullptr), link_(nullptr)\n> +\t  link_(nullptr)\n>  {\n>  }\n>  \n> -RkISP1Path::~RkISP1Path()\n> -{\n> -\tdelete video_;\n> -}\n> -\n>  bool RkISP1Path::init(MediaDevice *media)\n>  {\n>  \tstd::string resizer = std::string(\"rkisp1_resizer_\") + name_ + \"path\";\n> diff --git a/src/libcamera/pipeline/rkisp1/rkisp1_path.h b/src/libcamera/pipeline/rkisp1/rkisp1_path.h\n> index f06ac5a731cc..3b3e37d258d0 100644\n> --- a/src/libcamera/pipeline/rkisp1/rkisp1_path.h\n> +++ b/src/libcamera/pipeline/rkisp1/rkisp1_path.h\n> @@ -31,7 +31,6 @@ class RkISP1Path\n>  public:\n>  \tRkISP1Path(const char *name, const Span<const PixelFormat> &formats,\n>  \t\t   const Size &minResolution, const Size &maxResolution);\n> -\t~RkISP1Path();\n>  \n>  \tbool init(MediaDevice *media);\n>  \n> @@ -67,7 +66,7 @@ private:\n>  \tconst Size maxResolution_;\n>  \n>  \tstd::unique_ptr<V4L2Subdevice> resizer_;\n> -\tV4L2VideoDevice *video_;\n> +\tstd::unique_ptr<V4L2VideoDevice> video_;\n>  \tMediaLink *link_;\n>  };\n>  \n> diff --git a/src/libcamera/v4l2_videodevice.cpp b/src/libcamera/v4l2_videodevice.cpp\n> index e76fe2dd1f3a..e2b582842a9b 100644\n> --- a/src/libcamera/v4l2_videodevice.cpp\n> +++ b/src/libcamera/v4l2_videodevice.cpp\n> @@ -1598,19 +1598,17 @@ int V4L2VideoDevice::streamOff()\n>   * \\param[in] media The media device where the entity is registered\n>   * \\param[in] entity The media entity name\n>   *\n> - * Releasing memory of the newly created instance is responsibility of the\n> - * caller of this function.\n> - *\n>   * \\return A newly created V4L2VideoDevice on success, nullptr otherwise\n>   */\n> -V4L2VideoDevice *V4L2VideoDevice::fromEntityName(const MediaDevice *media,\n> -\t\t\t\t\t\t const std::string &entity)\n> +std::unique_ptr<V4L2VideoDevice>\n> +V4L2VideoDevice::fromEntityName(const MediaDevice *media,\n> +\t\t\t\tconst std::string &entity)\n>  {\n>  \tMediaEntity *mediaEntity = media->getEntityByName(entity);\n>  \tif (!mediaEntity)\n>  \t\treturn nullptr;\n>  \n> -\treturn new V4L2VideoDevice(mediaEntity);\n> +\treturn std::make_unique<V4L2VideoDevice>(mediaEntity);\n>  }\n>  \n>  /**\n> diff --git a/test/libtest/buffer_source.cpp b/test/libtest/buffer_source.cpp\n> index ee87c8cd821c..73563f2fc39d 100644\n> --- a/test/libtest/buffer_source.cpp\n> +++ b/test/libtest/buffer_source.cpp\n> @@ -50,7 +50,7 @@ int BufferSource::allocate(const StreamConfiguration &config)\n>  \t\treturn TestSkip;\n>  \t}\n>  \n> -\tstd::unique_ptr<V4L2VideoDevice> video{ V4L2VideoDevice::fromEntityName(media_.get(), videoDeviceName) };\n> +\tstd::unique_ptr<V4L2VideoDevice> video = V4L2VideoDevice::fromEntityName(media_.get(), videoDeviceName);\n>  \tif (!video) {\n>  \t\tstd::cout << \"Failed to get video device from entity \"\n>  \t\t\t  << videoDeviceName << std::endl;\n>","headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","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 2E2D7BDB1F\n\tfor <parsemail@patchwork.libcamera.org>;\n\tTue,  8 Dec 2020 22:25:05 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id AC49C67F0C;\n\tTue,  8 Dec 2020 23:25:04 +0100 (CET)","from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 3212267F0C\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue,  8 Dec 2020 23:25:03 +0100 (CET)","from [192.168.0.20]\n\t(cpc89244-aztw30-2-0-cust3082.18-1.cable.virginm.net [86.31.172.11])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 9022CDD;\n\tTue,  8 Dec 2020 23:25:02 +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=\"HZN3koMs\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1607466302;\n\tbh=QQJ5H7gZ6R4EQpPqWxwCMUv3DAae01FHZv+YSRDXJxA=;\n\th=Reply-To:Subject:To:References:From:Date:In-Reply-To:From;\n\tb=HZN3koMsPptINbV0H66Fm/uT5QKlTb1h0G1MoWqenqcoYnWAsumKsJ/MfdOGRmASe\n\tQ7i96qR7v2TK5gkOJYQqPn4KRbu7XxrMB/w16xUXbnknFQGvabH2SVdtGt5nJrr7nX\n\tK8PqJMq2oI8qN+kkPKHzxaM3TZVKkTaywQgoMapQ=","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>,\n\tlibcamera-devel@lists.libcamera.org","References":"<20201208014951.30989-1-laurent.pinchart@ideasonboard.com>\n\t<20201208014951.30989-2-laurent.pinchart@ideasonboard.com>","From":"Kieran Bingham <kieran.bingham@ideasonboard.com>","Autocrypt":"addr=kieran.bingham@ideasonboard.com; keydata=\n\tmQINBFYE/WYBEACs1PwjMD9rgCu1hlIiUA1AXR4rv2v+BCLUq//vrX5S5bjzxKAryRf0uHat\n\tV/zwz6hiDrZuHUACDB7X8OaQcwhLaVlq6byfoBr25+hbZG7G3+5EUl9cQ7dQEdvNj6V6y/SC\n\trRanWfelwQThCHckbobWiQJfK9n7rYNcPMq9B8e9F020LFH7Kj6YmO95ewJGgLm+idg1Kb3C\n\tpotzWkXc1xmPzcQ1fvQMOfMwdS+4SNw4rY9f07Xb2K99rjMwZVDgESKIzhsDB5GY465sCsiQ\n\tcSAZRxqE49RTBq2+EQsbrQpIc8XiffAB8qexh5/QPzCmR4kJgCGeHIXBtgRj+nIkCJPZvZtf\n\tKr2EAbc6tgg6DkAEHJb+1okosV09+0+TXywYvtEop/WUOWQ+zo+Y/OBd+8Ptgt1pDRyOBzL8\n\tRXa8ZqRf0Mwg75D+dKntZeJHzPRJyrlfQokngAAs4PaFt6UfS+ypMAF37T6CeDArQC41V3ko\n\tlPn1yMsVD0p+6i3DPvA/GPIksDC4owjnzVX9kM8Zc5Cx+XoAN0w5Eqo4t6qEVbuettxx55gq\n\t8K8FieAjgjMSxngo/HST8TpFeqI5nVeq0/lqtBRQKumuIqDg+Bkr4L1V/PSB6XgQcOdhtd36\n\tOe9X9dXB8YSNt7VjOcO7BTmFn/Z8r92mSAfHXpb07YJWJosQOQARAQABtDBLaWVyYW4gQmlu\n\tZ2hhbSA8a2llcmFuLmJpbmdoYW1AaWRlYXNvbmJvYXJkLmNvbT6JAlcEEwEKAEECGwMFCwkI\n\tBwIGFQgJCgsCBBYCAwECHgECF4ACGQEWIQSQLdeYP70o/eNy1HqhHkZyEKRh/QUCXWTtygUJ\n\tCyJXZAAKCRChHkZyEKRh/f8dEACTDsbLN2nioNZMwyLuQRUAFcXNolDX48xcUXsWS2QjxaPm\n\tVsJx8Uy8aYkS85mdPBh0C83OovQR/OVbr8AxhGvYqBs3nQvbWuTl/+4od7DfK2VZOoKBAu5S\n\tQK2FYuUcikDqYcFWJ8DQnubxfE8dvzojHEkXw0sA4igINHDDFX3HJGZtLio+WpEFQtCbfTAG\n\tYZslasz1YZRbwEdSsmO3/kqy5eMnczlm8a21A3fKUo3g8oAZEFM+f4DUNzqIltg31OAB/kZS\n\tenKZQ/SWC8PmLg/ZXBrReYakxXtkP6w3FwMlzOlhGxqhIRNiAJfXJBaRhuUWzPOpEDE9q5YJ\n\tBmqQL2WJm1VSNNVxbXJHpaWMH1sA2R00vmvRrPXGwyIO0IPYeUYQa3gsy6k+En/aMQJd27dp\n\taScf9am9PFICPY5T4ppneeJLif2lyLojo0mcHOV+uyrds9XkLpp14GfTkeKPdPMrLLTsHRfH\n\tfA4I4OBpRrEPiGIZB/0im98MkGY/Mu6qxeZmYLCcgD6qz4idOvfgVOrNh+aA8HzIVR+RMW8H\n\tQGBN9f0E3kfwxuhl3omo6V7lDw8XOdmuWZNC9zPq1UfryVHANYbLGz9KJ4Aw6M+OgBC2JpkD\n\thXMdHUkC+d20dwXrwHTlrJi1YNp6rBc+xald3wsUPOZ5z8moTHUX/uPA/qhGsbkCDQRWBP1m\n\tARAAzijkb+Sau4hAncr1JjOY+KyFEdUNxRy+hqTJdJfaYihxyaj0Ee0P0zEi35CbE6lgU0Uz\n\ttih9fiUbSV3wfsWqg1Ut3/5rTKu7kLFp15kF7eqvV4uezXRD3Qu4yjv/rMmEJbbD4cTvGCYI\n\td6MDC417f7vK3hCbCVIZSp3GXxyC1LU+UQr3fFcOyCwmP9vDUR9JV0BSqHHxRDdpUXE26Dk6\n\tmhf0V1YkspE5St814ETXpEus2urZE5yJIUROlWPIL+hm3NEWfAP06vsQUyLvr/GtbOT79vXl\n\tEn1aulcYyu20dRRxhkQ6iILaURcxIAVJJKPi8dsoMnS8pB0QW12AHWuirPF0g6DiuUfPmrA5\n\tPKe56IGlpkjc8cO51lIxHkWTpCMWigRdPDexKX+Sb+W9QWK/0JjIc4t3KBaiG8O4yRX8ml2R\n\t+rxfAVKM6V769P/hWoRGdgUMgYHFpHGSgEt80OKK5HeUPy2cngDUXzwrqiM5Sz6Od0qw5pCk\n\tNlXqI0W/who0iSVM+8+RmyY0OEkxEcci7rRLsGnM15B5PjLJjh1f2ULYkv8s4SnDwMZ/kE04\n\t/UqCMK/KnX8pwXEMCjz0h6qWNpGwJ0/tYIgQJZh6bqkvBrDogAvuhf60Sogw+mH8b+PBlx1L\n\toeTK396wc+4c3BfiC6pNtUS5GpsPMMjYMk7kVvEAEQEAAYkCPAQYAQoAJgIbDBYhBJAt15g/\n\tvSj943LUeqEeRnIQpGH9BQJdizzIBQkLSKZiAAoJEKEeRnIQpGH9eYgQAJpjaWNgqNOnMTmD\n\tMJggbwjIotypzIXfhHNCeTkG7+qCDlSaBPclcPGYrTwCt0YWPU2TgGgJrVhYT20ierN8LUvj\n\t6qOPTd+Uk7NFzL65qkh80ZKNBFddx1AabQpSVQKbdcLb8OFs85kuSvFdgqZwgxA1vl4TFhNz\n\tPZ79NAmXLackAx3sOVFhk4WQaKRshCB7cSl+RIng5S/ThOBlwNlcKG7j7W2MC06BlTbdEkUp\n\tECzuuRBv8wX4OQl+hbWbB/VKIx5HKlLu1eypen/5lNVzSqMMIYkkZcjV2SWQyUGxSwq0O/sx\n\tS0A8/atCHUXOboUsn54qdxrVDaK+6jIAuo8JiRWctP16KjzUM7MO0/+4zllM8EY57rXrj48j\n\tsbEYX0YQnzaj+jO6kJtoZsIaYR7rMMq9aUAjyiaEZpmP1qF/2sYenDx0Fg2BSlLvLvXM0vU8\n\tpQk3kgDu7kb/7PRYrZvBsr21EIQoIjXbZxDz/o7z95frkP71EaICttZ6k9q5oxxA5WC6sTXc\n\tMW8zs8avFNuA9VpXt0YupJd2ijtZy2mpZNG02fFVXhIn4G807G7+9mhuC4XG5rKlBBUXTvPU\n\tAfYnB4JBDLmLzBFavQfvonSfbitgXwCG3vS+9HEwAjU30Bar1PEOmIbiAoMzuKeRm2LVpmq4\n\tWZw01QYHU/GUV/zHJSFk","Organization":"Ideas on Board","Message-ID":"<223c78b6-a403-e203-3497-7a6917062d82@ideasonboard.com>","Date":"Tue, 8 Dec 2020 22:25:00 +0000","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101\n\tThunderbird/68.10.0","MIME-Version":"1.0","In-Reply-To":"<20201208014951.30989-2-laurent.pinchart@ideasonboard.com>","Content-Language":"en-GB","Subject":"Re: [libcamera-devel] [PATCH 2/2] libcamera: v4l2_device: Return a\n\tunique pointer from fromEntityName()","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Reply-To":"kieran.bingham@ideasonboard.com","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}},{"id":14161,"web_url":"https://patchwork.libcamera.org/comment/14161/","msgid":"<20201209091510.aevqwbyokgy4zmmq@uno.localdomain>","date":"2020-12-09T09:15:10","subject":"Re: [libcamera-devel] [PATCH 2/2] libcamera: v4l2_device: Return a\n\tunique pointer from fromEntityName()","submitter":{"id":3,"url":"https://patchwork.libcamera.org/api/people/3/","name":"Jacopo Mondi","email":"jacopo@jmondi.org"},"content":"Hi Laurent,\n\nOn Tue, Dec 08, 2020 at 10:25:00PM +0000, Kieran Bingham wrote:\n> Hi Laurent,\n>\n> On 08/12/2020 01:49, Laurent Pinchart wrote:\n> > The fromEntityName() function returns a pointer to a newly allocated\n> > V4L2Device instance, which must be deleted by the caller. This opens the\n> > door to memory leaks. Return a unique pointer instead, which conveys the\n> > API semantics better than a sentence in the documentation.\n> >\n> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n> > ---\n> >  include/libcamera/internal/v4l2_videodevice.h |  4 ++--\n> >  src/libcamera/pipeline/ipu3/cio2.cpp          |  3 +--\n> >  src/libcamera/pipeline/ipu3/cio2.h            |  2 +-\n> >  src/libcamera/pipeline/ipu3/imgu.cpp          | 10 ++++------\n> >  src/libcamera/pipeline/rkisp1/rkisp1.cpp      | 13 +++----------\n> >  src/libcamera/pipeline/rkisp1/rkisp1_path.cpp |  7 +------\n> >  src/libcamera/pipeline/rkisp1/rkisp1_path.h   |  3 +--\n> >  src/libcamera/v4l2_videodevice.cpp            | 10 ++++------\n> >  test/libtest/buffer_source.cpp                |  2 +-\n> >  9 files changed, 18 insertions(+), 36 deletions(-)\n> >\n> > diff --git a/include/libcamera/internal/v4l2_videodevice.h b/include/libcamera/internal/v4l2_videodevice.h\n> > index 661503d1565a..529ca0e359d6 100644\n> > --- a/include/libcamera/internal/v4l2_videodevice.h\n> > +++ b/include/libcamera/internal/v4l2_videodevice.h\n> > @@ -210,8 +210,8 @@ public:\n> >  \tint streamOn();\n> >  \tint streamOff();\n> >\n> > -\tstatic V4L2VideoDevice *fromEntityName(const MediaDevice *media,\n> > -\t\t\t\t\t       const std::string &entity);\n> > +\tstatic std::unique_ptr<V4L2VideoDevice>\n> > +\tfromEntityName(const MediaDevice *media, const std::string &entity);\n> >\n> >  \tV4L2PixelFormat toV4L2PixelFormat(const PixelFormat &pixelFormat);\n> >\n> > diff --git a/src/libcamera/pipeline/ipu3/cio2.cpp b/src/libcamera/pipeline/ipu3/cio2.cpp\n> > index e43ec70fe3e4..821715e325b4 100644\n> > --- a/src/libcamera/pipeline/ipu3/cio2.cpp\n> > +++ b/src/libcamera/pipeline/ipu3/cio2.cpp\n> > @@ -33,13 +33,12 @@ const std::map<uint32_t, PixelFormat> mbusCodesToPixelFormat = {\n> >  } /* namespace */\n> >\n> >  CIO2Device::CIO2Device()\n> > -\t: sensor_(nullptr), csi2_(nullptr), output_(nullptr)\n> > +\t: sensor_(nullptr), csi2_(nullptr)\n> >  {\n> >  }\n> >\n> >  CIO2Device::~CIO2Device()\n> >  {\n> > -\tdelete output_;\n> >  \tdelete csi2_;\n> >  \tdelete sensor_;\n> >  }\n> > diff --git a/src/libcamera/pipeline/ipu3/cio2.h b/src/libcamera/pipeline/ipu3/cio2.h\n> > index fa813a989fd2..0dca9673ca07 100644\n> > --- a/src/libcamera/pipeline/ipu3/cio2.h\n> > +++ b/src/libcamera/pipeline/ipu3/cio2.h\n> > @@ -63,7 +63,7 @@ private:\n> >\n> >  \tCameraSensor *sensor_;\n> >  \tV4L2Subdevice *csi2_;\n> > -\tV4L2VideoDevice *output_;\n> > +\tstd::unique_ptr<V4L2VideoDevice> output_;\n\nIt would be worth to make the other two class members unique_ptr<>\ntoo. On top anyway.\n\nReviewed-by: Jacopo Mondi <jacopo@jmondi.org>\n\nThanks\n  j\n> >\n> >  \tstd::vector<std::unique_ptr<FrameBuffer>> buffers_;\n> >  \tstd::queue<FrameBuffer *> availableBuffers_;\n> > diff --git a/src/libcamera/pipeline/ipu3/imgu.cpp b/src/libcamera/pipeline/ipu3/imgu.cpp\n> > index bfe9624c7797..5b1c0318b426 100644\n> > --- a/src/libcamera/pipeline/ipu3/imgu.cpp\n> > +++ b/src/libcamera/pipeline/ipu3/imgu.cpp\n> > @@ -348,24 +348,22 @@ int ImgUDevice::init(MediaDevice *media, unsigned int index)\n> >  \tif (ret)\n> >  \t\treturn ret;\n> >\n> > -\tinput_.reset(V4L2VideoDevice::fromEntityName(media, name_ + \" input\"));\n> > +\tinput_ = V4L2VideoDevice::fromEntityName(media, name_ + \" input\");\n> >  \tret = input_->open();\n> >  \tif (ret)\n> >  \t\treturn ret;\n> >\n> > -\toutput_.reset(V4L2VideoDevice::fromEntityName(media,\n> > -\t\t\t\t\t\t      name_ + \" output\"));\n> > +\toutput_ = V4L2VideoDevice::fromEntityName(media, name_ + \" output\");\n> >  \tret = output_->open();\n> >  \tif (ret)\n> >  \t\treturn ret;\n> >\n> > -\tviewfinder_.reset(V4L2VideoDevice::fromEntityName(media,\n> > -\t\t\t\t\t\t\t  name_ + \" viewfinder\"));\n> > +\tviewfinder_ = V4L2VideoDevice::fromEntityName(media, name_ + \" viewfinder\");\n> >  \tret = viewfinder_->open();\n> >  \tif (ret)\n> >  \t\treturn ret;\n> >\n> > -\tstat_.reset(V4L2VideoDevice::fromEntityName(media, name_ + \" 3a stat\"));\n> > +\tstat_ = V4L2VideoDevice::fromEntityName(media, name_ + \" 3a stat\");\n>\n> Resetting to something just feels awkward, so I certainly like all that.\n>\n>\n> >  \tret = stat_->open();\n> >  \tif (ret)\n> >  \t\treturn ret;\n> > diff --git a/src/libcamera/pipeline/rkisp1/rkisp1.cpp b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n> > index bcfe6c0514ab..064ab01057f4 100644\n> > --- a/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n> > +++ b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n> > @@ -178,7 +178,6 @@ class PipelineHandlerRkISP1 : public PipelineHandler\n> >  {\n> >  public:\n> >  \tPipelineHandlerRkISP1(CameraManager *manager);\n> > -\t~PipelineHandlerRkISP1();\n> >\n> >  \tCameraConfiguration *generateConfiguration(Camera *camera,\n> >  \t\tconst StreamRoles &roles) override;\n> > @@ -218,8 +217,8 @@ private:\n> >\n> >  \tMediaDevice *media_;\n> >  \tstd::unique_ptr<V4L2Subdevice> isp_;\n> > -\tV4L2VideoDevice *param_;\n> > -\tV4L2VideoDevice *stat_;\n> > +\tstd::unique_ptr<V4L2VideoDevice> param_;\n> > +\tstd::unique_ptr<V4L2VideoDevice> stat_;\n> >\n> >  \tRkISP1MainPath mainPath_;\n> >  \tRkISP1SelfPath selfPath_;\n> > @@ -599,16 +598,10 @@ CameraConfiguration::Status RkISP1CameraConfiguration::validate()\n> >  }\n> >\n> >  PipelineHandlerRkISP1::PipelineHandlerRkISP1(CameraManager *manager)\n> > -\t: PipelineHandler(manager), param_(nullptr), stat_(nullptr)\n> > +\t: PipelineHandler(manager)\n> >  {\n> >  }\n> >\n> > -PipelineHandlerRkISP1::~PipelineHandlerRkISP1()\n> > -{\n> > -\tdelete param_;\n> > -\tdelete stat_;\n> > -}\n>\n> And we no longer need a destructor - even better.\n>\n> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>\n>\n> > -\n> >  /* -----------------------------------------------------------------------------\n> >   * Pipeline Operations\n> >   */\n> > diff --git a/src/libcamera/pipeline/rkisp1/rkisp1_path.cpp b/src/libcamera/pipeline/rkisp1/rkisp1_path.cpp\n> > index e05d9dd657cd..25f482eb8d8e 100644\n> > --- a/src/libcamera/pipeline/rkisp1/rkisp1_path.cpp\n> > +++ b/src/libcamera/pipeline/rkisp1/rkisp1_path.cpp\n> > @@ -24,15 +24,10 @@ RkISP1Path::RkISP1Path(const char *name, const Span<const PixelFormat> &formats,\n> >  \t\t       const Size &minResolution, const Size &maxResolution)\n> >  \t: name_(name), running_(false), formats_(formats),\n> >  \t  minResolution_(minResolution), maxResolution_(maxResolution),\n> > -\t  video_(nullptr), link_(nullptr)\n> > +\t  link_(nullptr)\n> >  {\n> >  }\n> >\n> > -RkISP1Path::~RkISP1Path()\n> > -{\n> > -\tdelete video_;\n> > -}\n> > -\n> >  bool RkISP1Path::init(MediaDevice *media)\n> >  {\n> >  \tstd::string resizer = std::string(\"rkisp1_resizer_\") + name_ + \"path\";\n> > diff --git a/src/libcamera/pipeline/rkisp1/rkisp1_path.h b/src/libcamera/pipeline/rkisp1/rkisp1_path.h\n> > index f06ac5a731cc..3b3e37d258d0 100644\n> > --- a/src/libcamera/pipeline/rkisp1/rkisp1_path.h\n> > +++ b/src/libcamera/pipeline/rkisp1/rkisp1_path.h\n> > @@ -31,7 +31,6 @@ class RkISP1Path\n> >  public:\n> >  \tRkISP1Path(const char *name, const Span<const PixelFormat> &formats,\n> >  \t\t   const Size &minResolution, const Size &maxResolution);\n> > -\t~RkISP1Path();\n> >\n> >  \tbool init(MediaDevice *media);\n> >\n> > @@ -67,7 +66,7 @@ private:\n> >  \tconst Size maxResolution_;\n> >\n> >  \tstd::unique_ptr<V4L2Subdevice> resizer_;\n> > -\tV4L2VideoDevice *video_;\n> > +\tstd::unique_ptr<V4L2VideoDevice> video_;\n> >  \tMediaLink *link_;\n> >  };\n> >\n> > diff --git a/src/libcamera/v4l2_videodevice.cpp b/src/libcamera/v4l2_videodevice.cpp\n> > index e76fe2dd1f3a..e2b582842a9b 100644\n> > --- a/src/libcamera/v4l2_videodevice.cpp\n> > +++ b/src/libcamera/v4l2_videodevice.cpp\n> > @@ -1598,19 +1598,17 @@ int V4L2VideoDevice::streamOff()\n> >   * \\param[in] media The media device where the entity is registered\n> >   * \\param[in] entity The media entity name\n> >   *\n> > - * Releasing memory of the newly created instance is responsibility of the\n> > - * caller of this function.\n> > - *\n> >   * \\return A newly created V4L2VideoDevice on success, nullptr otherwise\n> >   */\n> > -V4L2VideoDevice *V4L2VideoDevice::fromEntityName(const MediaDevice *media,\n> > -\t\t\t\t\t\t const std::string &entity)\n> > +std::unique_ptr<V4L2VideoDevice>\n> > +V4L2VideoDevice::fromEntityName(const MediaDevice *media,\n> > +\t\t\t\tconst std::string &entity)\n> >  {\n> >  \tMediaEntity *mediaEntity = media->getEntityByName(entity);\n> >  \tif (!mediaEntity)\n> >  \t\treturn nullptr;\n> >\n> > -\treturn new V4L2VideoDevice(mediaEntity);\n> > +\treturn std::make_unique<V4L2VideoDevice>(mediaEntity);\n> >  }\n> >\n> >  /**\n> > diff --git a/test/libtest/buffer_source.cpp b/test/libtest/buffer_source.cpp\n> > index ee87c8cd821c..73563f2fc39d 100644\n> > --- a/test/libtest/buffer_source.cpp\n> > +++ b/test/libtest/buffer_source.cpp\n> > @@ -50,7 +50,7 @@ int BufferSource::allocate(const StreamConfiguration &config)\n> >  \t\treturn TestSkip;\n> >  \t}\n> >\n> > -\tstd::unique_ptr<V4L2VideoDevice> video{ V4L2VideoDevice::fromEntityName(media_.get(), videoDeviceName) };\n> > +\tstd::unique_ptr<V4L2VideoDevice> video = V4L2VideoDevice::fromEntityName(media_.get(), videoDeviceName);\n> >  \tif (!video) {\n> >  \t\tstd::cout << \"Failed to get video device from entity \"\n> >  \t\t\t  << videoDeviceName << std::endl;\n> >\n>\n> --\n> Regards\n> --\n> Kieran\n> _______________________________________________\n> libcamera-devel mailing list\n> libcamera-devel@lists.libcamera.org\n> https://lists.libcamera.org/listinfo/libcamera-devel","headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","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 45157BDE1E\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed,  9 Dec 2020 09:15:05 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id C70FC67E72;\n\tWed,  9 Dec 2020 10:15:04 +0100 (CET)","from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net\n\t[217.70.183.199])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 224AF635C4\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed,  9 Dec 2020 10:15:03 +0100 (CET)","from uno.localdomain (93-34-118-233.ip49.fastwebnet.it\n\t[93.34.118.233]) (Authenticated sender: jacopo@jmondi.org)\n\tby relay9-d.mail.gandi.net (Postfix) with ESMTPSA id 1A8DAFF805;\n\tWed,  9 Dec 2020 09:15:01 +0000 (UTC)"],"X-Originating-IP":"93.34.118.233","Date":"Wed, 9 Dec 2020 10:15:10 +0100","From":"Jacopo Mondi <jacopo@jmondi.org>","To":"Kieran Bingham <kieran.bingham@ideasonboard.com>","Message-ID":"<20201209091510.aevqwbyokgy4zmmq@uno.localdomain>","References":"<20201208014951.30989-1-laurent.pinchart@ideasonboard.com>\n\t<20201208014951.30989-2-laurent.pinchart@ideasonboard.com>\n\t<223c78b6-a403-e203-3497-7a6917062d82@ideasonboard.com>","MIME-Version":"1.0","Content-Disposition":"inline","In-Reply-To":"<223c78b6-a403-e203-3497-7a6917062d82@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH 2/2] libcamera: v4l2_device: Return a\n\tunique pointer from fromEntityName()","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","Cc":"libcamera-devel@lists.libcamera.org","Content-Type":"text/plain; charset=\"us-ascii\"","Content-Transfer-Encoding":"7bit","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"}}]