[{"id":3241,"web_url":"https://patchwork.libcamera.org/comment/3241/","msgid":"<20191210015922.GL18060@pendragon.ideasonboard.com>","date":"2019-12-10T01:59:22","subject":"Re: [libcamera-devel] [PATCH 07/30] ipa: Switch to FrameBuffer\n\tinterface","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Niklas,\n\nThank you for the patch.\n\nOn Wed, Nov 27, 2019 at 12:35:57AM +0100, Niklas Söderlund wrote:\n> Switch the IPA interfaces and implementations to use the Framebuffer\n> interface.\n> \n> - The IPA interface is switch to use the simpler FrameBuffer::Plane\n>   container when carrying dmabuf descriptions (fd and length) over the\n>   pipeline/IPA boundary.\n> \n> - The RkISP1 IPA implementation takes advantage of the new simpler and\n>   safer (better control over file descriptors) FrameBuffer interface.\n> \n> The biggest change can be observed in the test case where it is\n> demonstrated that FrameBuffer objects only carry the necessary number of\n> planes and not a fixed number. As a consequence of this the test needs\n> to verify the file descriptors it injects and not depend on the library\n> to handle uninitialized fields.\n> \n> Signed-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>\n> ---\n>  include/ipa/ipa_interface.h              |  2 +-\n>  src/ipa/libipa/ipa_interface_wrapper.cpp |  7 ++---\n>  src/ipa/rkisp1/rkisp1.cpp                | 14 +++++----\n>  src/libcamera/ipa_context_wrapper.cpp    |  8 ++---\n>  src/libcamera/ipa_interface.cpp          |  7 ++---\n>  src/libcamera/pipeline/rkisp1/rkisp1.cpp | 16 ++++++++--\n>  test/ipa/ipa_wrappers_test.cpp           | 38 ++++++++++++------------\n>  7 files changed, 52 insertions(+), 40 deletions(-)\n> \n> diff --git a/include/ipa/ipa_interface.h b/include/ipa/ipa_interface.h\n> index 0ea53d120fe10acf..229d1124b19ec1c9 100644\n> --- a/include/ipa/ipa_interface.h\n> +++ b/include/ipa/ipa_interface.h\n> @@ -105,7 +105,7 @@ struct IPAStream {\n>  \n>  struct IPABuffer {\n>  \tunsigned int id;\n> -\tBufferMemory memory;\n> +\tstd::vector<FrameBuffer::Plane> planes;\n\nDepending on how the discussion on FrameBuffer::Plane and Dmabuf turns\nout, you may need to move FrameBuffer::Plane to the IPA interface\ndefinition, to an IPABufferPlane class probably.\n\n>  };\n>  \n>  struct IPAOperationData {\n> diff --git a/src/ipa/libipa/ipa_interface_wrapper.cpp b/src/ipa/libipa/ipa_interface_wrapper.cpp\n> index 6a389dfa714ab535..a1aa88979d73446f 100644\n> --- a/src/ipa/libipa/ipa_interface_wrapper.cpp\n> +++ b/src/ipa/libipa/ipa_interface_wrapper.cpp\n> @@ -144,15 +144,14 @@ void IPAInterfaceWrapper::map_buffers(struct ipa_context *_ctx,\n>  \tfor (unsigned int i = 0; i < num_buffers; ++i) {\n>  \t\tconst struct ipa_buffer &_buffer = _buffers[i];\n>  \t\tIPABuffer &buffer = buffers[i];\n> -\t\tstd::vector<Plane> &planes = buffer.memory.planes();\n> +\t\tstd::vector<FrameBuffer::Plane> &planes = buffer.planes;\n>  \n>  \t\tbuffer.id = _buffer.id;\n>  \n>  \t\tplanes.resize(_buffer.num_planes);\n>  \t\tfor (unsigned int j = 0; j < _buffer.num_planes; ++j) {\n> -\t\t\tif (_buffer.planes[j].dmabuf != -1)\n> -\t\t\t\tplanes[j].setDmabuf(_buffer.planes[j].dmabuf,\n> -\t\t\t\t\t\t    _buffer.planes[j].length);\n> +\t\t\tplanes[j].fd = _buffer.planes[j].dmabuf;\n\nYou're assigning the numerical dmabuf fd here.\n\n> +\t\t\tplanes[j].length = _buffer.planes[j].length;\n>  \t\t\t/** \\todo Create a Dmabuf class to implement RAII. */\n>  \t\t\t::close(_buffer.planes[j].dmabuf);\n\nAnd you then close it. Looks like a test case is missing.\n\nWe have a Dmabuf class now to address the above \\todo. If you give it an\nint &&fd move constructor, and if you store a Dmabuf in\nFrameBuffer::Plane instead of a plain integer, I think you could get rid\nof the ::close().\n\nIn any case storing a plain integer in FrameBuffer::Plane seems to be\nlooking for trouble.\n\n>  \t\t}\n> diff --git a/src/ipa/rkisp1/rkisp1.cpp b/src/ipa/rkisp1/rkisp1.cpp\n> index 744a16ae5b9aa420..7f29d0351ba58e6d 100644\n> --- a/src/ipa/rkisp1/rkisp1.cpp\n> +++ b/src/ipa/rkisp1/rkisp1.cpp\n> @@ -48,7 +48,7 @@ private:\n>  \tvoid setControls(unsigned int frame);\n>  \tvoid metadataReady(unsigned int frame, unsigned int aeState);\n>  \n> -\tstd::map<unsigned int, BufferMemory> bufferInfo_;\n> +\tstd::map<unsigned int, FrameBuffer *> bufferInfo_;\n\nIt's not info anymore, let's rename the variable.\n\nWhy do you store pointers instead of instances ? I fear memory leaks.\n\n>  \n>  \tControlInfoMap ctrls_;\n>  \n> @@ -102,15 +102,17 @@ void IPARkISP1::configure(const std::map<unsigned int, IPAStream> &streamConfig,\n>  void IPARkISP1::mapBuffers(const std::vector<IPABuffer> &buffers)\n>  {\n>  \tfor (const IPABuffer &buffer : buffers) {\n> -\t\tbufferInfo_[buffer.id] = buffer.memory;\n> -\t\tbufferInfo_[buffer.id].planes()[0].mem();\n> +\t\tbufferInfo_[buffer.id] = new FrameBuffer(buffer.planes);\n> +\t\tbufferInfo_[buffer.id]->dmabufs()[0]->mem();\n\nInterestingly enough, we're now using FrameBuffer for buffers that store\nmetadata. Not necessarily a big issue, but we need to explain this in\nthe FrameBuffer documentation. The alternative would be to change the\nlevel of abstraction of the IPA API to handle dmabufs instead of\nmulti-planar buffers. I'm not sure that would be desirable though.\n\n>  \t}\n>  }\n>  \n>  void IPARkISP1::unmapBuffers(const std::vector<unsigned int> &ids)\n>  {\n> -\tfor (unsigned int id : ids)\n> +\tfor (unsigned int id : ids) {\n> +\t\tdelete bufferInfo_[id];\n>  \t\tbufferInfo_.erase(id);\n> +\t}\n>  }\n>  \n>  void IPARkISP1::processEvent(const IPAOperationData &event)\n> @@ -121,7 +123,7 @@ void IPARkISP1::processEvent(const IPAOperationData &event)\n>  \t\tunsigned int bufferId = event.data[1];\n>  \n>  \t\tconst rkisp1_stat_buffer *stats =\n> -\t\t\tstatic_cast<rkisp1_stat_buffer *>(bufferInfo_[bufferId].planes()[0].mem());\n> +\t\t\tstatic_cast<rkisp1_stat_buffer *>(bufferInfo_[bufferId]->dmabufs()[0]->mem());\n>  \n>  \t\tupdateStatistics(frame, stats);\n>  \t\tbreak;\n> @@ -131,7 +133,7 @@ void IPARkISP1::processEvent(const IPAOperationData &event)\n>  \t\tunsigned int bufferId = event.data[1];\n>  \n>  \t\trkisp1_isp_params_cfg *params =\n> -\t\t\tstatic_cast<rkisp1_isp_params_cfg *>(bufferInfo_[bufferId].planes()[0].mem());\n> +\t\t\tstatic_cast<rkisp1_isp_params_cfg *>(bufferInfo_[bufferId]->dmabufs()[0]->mem());\n>  \n>  \t\tqueueRequest(frame, params, event.controls[0]);\n>  \t\tbreak;\n> diff --git a/src/libcamera/ipa_context_wrapper.cpp b/src/libcamera/ipa_context_wrapper.cpp\n> index 9603fdac87150aa0..978ead927d196f02 100644\n> --- a/src/libcamera/ipa_context_wrapper.cpp\n> +++ b/src/libcamera/ipa_context_wrapper.cpp\n> @@ -149,15 +149,15 @@ void IPAContextWrapper::mapBuffers(const std::vector<IPABuffer> &buffers)\n>  \tfor (unsigned int i = 0; i < buffers.size(); ++i) {\n>  \t\tstruct ipa_buffer &c_buffer = c_buffers[i];\n>  \t\tconst IPABuffer &buffer = buffers[i];\n> -\t\tconst std::vector<Plane> &planes = buffer.memory.planes();\n> +\t\tconst std::vector<FrameBuffer::Plane> &planes = buffer.planes;\n>  \n>  \t\tc_buffer.id = buffer.id;\n>  \t\tc_buffer.num_planes = planes.size();\n>  \n>  \t\tfor (unsigned int j = 0; j < planes.size(); ++j) {\n> -\t\t\tconst Plane &plane = planes[j];\n> -\t\t\tc_buffer.planes[j].dmabuf = plane.dmabuf();\n> -\t\t\tc_buffer.planes[j].length = plane.length();\n> +\t\t\tconst FrameBuffer::Plane &plane = planes[j];\n> +\t\t\tc_buffer.planes[j].dmabuf = plane.fd;\n> +\t\t\tc_buffer.planes[j].length = plane.length;\n>  \t\t}\n>  \t}\n>  \n> diff --git a/src/libcamera/ipa_interface.cpp b/src/libcamera/ipa_interface.cpp\n> index ee3e3622f39ae85f..2f86087ee4aa414f 100644\n> --- a/src/libcamera/ipa_interface.cpp\n> +++ b/src/libcamera/ipa_interface.cpp\n> @@ -334,11 +334,10 @@ namespace libcamera {\n>   */\n>  \n>  /**\n> - * \\var IPABuffer::memory\n> - * \\brief The buffer memory description\n> + * \\var IPABuffer::planes\n> + * \\brief The buffer planes description\n>   *\n> - * The memory field stores the dmabuf handle and size for each plane of the\n> - * buffer.\n> + * Stores the dmabuf handle and length for each plane of the buffer.\n>   */\n>  \n>  /**\n> diff --git a/src/libcamera/pipeline/rkisp1/rkisp1.cpp b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n> index f75b25c6787e40df..00fa4d4f19cb4aa4 100644\n> --- a/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n> +++ b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n> @@ -687,14 +687,26 @@ int PipelineHandlerRkISP1::allocateBuffers(Camera *camera,\n>  \t}\n>  \n>  \tfor (unsigned int i = 0; i < stream->configuration().bufferCount + 1; i++) {\n> +\t\tstd::vector<FrameBuffer::Plane> planes;\n> +\t\tplanes.push_back({\n> +\t\t\t.fd = paramPool_.buffers()[i].planes()[0].dmabuf(),\n> +\t\t\t.length = paramPool_.buffers()[i].planes()[0].length(),\n> +\t\t});\n> +\n>  \t\tdata->ipaBuffers_.push_back({ .id = RKISP1_PARAM_BASE | i,\n> -\t\t\t\t\t      .memory = paramPool_.buffers()[i] });\n> +\t\t\t\t\t      .planes = planes });\n>  \t\tparamBuffers_.push(new Buffer(i));\n>  \t}\n>  \n>  \tfor (unsigned int i = 0; i < stream->configuration().bufferCount + 1; i++) {\n> +\t\tstd::vector<FrameBuffer::Plane> planes;\n> +\t\tplanes.push_back({\n> +\t\t\t.fd = statPool_.buffers()[i].planes()[0].dmabuf(),\n> +\t\t\t.length = statPool_.buffers()[i].planes()[0].length(),\n> +\t\t});\n> +\n>  \t\tdata->ipaBuffers_.push_back({ .id = RKISP1_STAT_BASE | i,\n> -\t\t\t\t\t      .memory = statPool_.buffers()[i] });\n> +\t\t\t\t\t      .planes = planes });\n>  \t\tstatBuffers_.push(new Buffer(i));\n>  \t}\n>  \n> diff --git a/test/ipa/ipa_wrappers_test.cpp b/test/ipa/ipa_wrappers_test.cpp\n> index a1e34ad52317f47b..022db05172fcd548 100644\n> --- a/test/ipa/ipa_wrappers_test.cpp\n> +++ b/test/ipa/ipa_wrappers_test.cpp\n> @@ -115,28 +115,28 @@ public:\n>  \t\t\treturn report(Op_mapBuffers, TestFail);\n>  \t\t}\n>  \n> -\t\tif (buffers[0].memory.planes().size() != 3 ||\n> -\t\t    buffers[1].memory.planes().size() != 3) {\n> +\t\tif (buffers[0].planes.size() != 3 ||\n> +\t\t    buffers[1].planes.size() != 3) {\n>  \t\t\tcerr << \"mapBuffers(): Invalid number of planes\" << endl;\n>  \t\t\treturn report(Op_mapBuffers, TestFail);\n>  \t\t}\n>  \n> -\t\tif (buffers[0].memory.planes()[0].length() != 4096 ||\n> -\t\t    buffers[0].memory.planes()[1].length() != 0 ||\n> -\t\t    buffers[0].memory.planes()[2].length() != 0 ||\n> -\t\t    buffers[0].memory.planes()[0].length() != 4096 ||\n> -\t\t    buffers[1].memory.planes()[1].length() != 4096 ||\n> -\t\t    buffers[1].memory.planes()[2].length() != 0) {\n> +\t\tif (buffers[0].planes[0].length != 4096 ||\n> +\t\t    buffers[0].planes[1].length != 0 ||\n> +\t\t    buffers[0].planes[2].length != 0 ||\n> +\t\t    buffers[0].planes[0].length != 4096 ||\n> +\t\t    buffers[1].planes[1].length != 4096 ||\n> +\t\t    buffers[1].planes[2].length != 0) {\n>  \t\t\tcerr << \"mapBuffers(): Invalid length\" << endl;\n>  \t\t\treturn report(Op_mapBuffers, TestFail);\n>  \t\t}\n>  \n> -\t\tif (buffers[0].memory.planes()[0].dmabuf() == -1 ||\n> -\t\t    buffers[0].memory.planes()[1].dmabuf() != -1 ||\n> -\t\t    buffers[0].memory.planes()[2].dmabuf() != -1 ||\n> -\t\t    buffers[0].memory.planes()[0].dmabuf() == -1 ||\n> -\t\t    buffers[1].memory.planes()[1].dmabuf() == -1 ||\n> -\t\t    buffers[1].memory.planes()[2].dmabuf() != -1) {\n> +\t\tif (buffers[0].planes[0].fd == 0 ||\n> +\t\t    buffers[0].planes[1].fd != 0 ||\n> +\t\t    buffers[0].planes[2].fd != 0 ||\n> +\t\t    buffers[0].planes[0].fd == 0 ||\n> +\t\t    buffers[1].planes[1].fd == 0 ||\n> +\t\t    buffers[1].planes[2].fd != 0) {\n>  \t\t\tcerr << \"mapBuffers(): Invalid dmabuf\" << endl;\n>  \t\t\treturn report(Op_mapBuffers, TestFail);\n>  \t\t}\n> @@ -287,13 +287,13 @@ protected:\n>  \n>  \t\t/* Test mapBuffers(). */\n>  \t\tstd::vector<IPABuffer> buffers(2);\n> -\t\tbuffers[0].memory.planes().resize(3);\n> +\t\tbuffers[0].planes.resize(3);\n>  \t\tbuffers[0].id = 10;\n> -\t\tbuffers[0].memory.planes()[0].setDmabuf(fd_, 4096);\n> +\t\tbuffers[0].planes[0] = { .fd = fd_, .length = 4096 };\n>  \t\tbuffers[1].id = 11;\n> -\t\tbuffers[1].memory.planes().resize(3);\n> -\t\tbuffers[1].memory.planes()[0].setDmabuf(fd_, 4096);\n> -\t\tbuffers[1].memory.planes()[1].setDmabuf(fd_, 4096);\n> +\t\tbuffers[1].planes.resize(3);\n> +\t\tbuffers[1].planes[0] = { .fd = fd_, .length = 4096 };\n> +\t\tbuffers[1].planes[1] = { .fd = fd_, .length = 4096 };\n>  \n>  \t\tret = INVOKE(mapBuffers, buffers);\n>  \t\tif (ret == TestFail)","headers":{"Return-Path":"<laurent.pinchart@ideasonboard.com>","Received":["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 AED6960BDB\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 10 Dec 2019 02:59:30 +0100 (CET)","from pendragon.ideasonboard.com (81-175-216-236.bb.dnainternet.fi\n\t[81.175.216.236])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 04E509D0;\n\tTue, 10 Dec 2019 02:59:29 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1575943170;\n\tbh=B6HJA6srDDOQCWF6CP+T0Gb2q5hnBTOTuLAGvC3JaAA=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=Zum4mNPHxdShSq2HReFQgoXCwwqdTruc+Qq6zQjarddWpaLdsALmBXhpSOrwRXAMy\n\tTVFejnAbSGFjxZKhoswNAXvmJ8rPojH9Zc9exHIm8lCqY3kH9nz94Oqy5v+vwdzGCT\n\tjVEwagpEZ+niLFkoPPvmE9CbgPz44OiF7Chdqcjg=","Date":"Tue, 10 Dec 2019 03:59:22 +0200","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"Niklas =?utf-8?q?S=C3=B6derlund?= <niklas.soderlund@ragnatech.se>","Cc":"libcamera-devel@lists.libcamera.org","Message-ID":"<20191210015922.GL18060@pendragon.ideasonboard.com>","References":"<20191126233620.1695316-1-niklas.soderlund@ragnatech.se>\n\t<20191126233620.1695316-8-niklas.soderlund@ragnatech.se>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","Content-Transfer-Encoding":"8bit","In-Reply-To":"<20191126233620.1695316-8-niklas.soderlund@ragnatech.se>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [libcamera-devel] [PATCH 07/30] ipa: Switch to FrameBuffer\n\tinterface","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>","X-List-Received-Date":"Tue, 10 Dec 2019 01:59:30 -0000"}}]