Show a patch.

GET /api/1.1/patches/2556/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 2556,
    "url": "https://patchwork.libcamera.org/api/1.1/patches/2556/?format=api",
    "web_url": "https://patchwork.libcamera.org/patch/2556/",
    "project": {
        "id": 1,
        "url": "https://patchwork.libcamera.org/api/1.1/projects/1/?format=api",
        "name": "libcamera",
        "link_name": "libcamera",
        "list_id": "libcamera_core",
        "list_email": "libcamera-devel@lists.libcamera.org",
        "web_url": "",
        "scm_url": "",
        "webscm_url": ""
    },
    "msgid": "<20200110193808.2266294-10-niklas.soderlund@ragnatech.se>",
    "date": "2020-01-10T19:37:44",
    "name": "[libcamera-devel,v3,09/33] ipa: Switch to FrameBuffer interface",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": false,
    "hash": "92491b545c400efd4ac2681bce319e4341a9ebca",
    "submitter": {
        "id": 5,
        "url": "https://patchwork.libcamera.org/api/1.1/people/5/?format=api",
        "name": "Niklas Söderlund",
        "email": "niklas.soderlund@ragnatech.se"
    },
    "delegate": null,
    "mbox": "https://patchwork.libcamera.org/patch/2556/mbox/",
    "series": [
        {
            "id": 615,
            "url": "https://patchwork.libcamera.org/api/1.1/series/615/?format=api",
            "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=615",
            "date": "2020-01-10T19:37:35",
            "name": "libcamera: Rework buffer API",
            "version": 3,
            "mbox": "https://patchwork.libcamera.org/series/615/mbox/"
        }
    ],
    "comments": "https://patchwork.libcamera.org/api/patches/2556/comments/",
    "check": "pending",
    "checks": "https://patchwork.libcamera.org/api/patches/2556/checks/",
    "tags": {},
    "headers": {
        "Return-Path": "<niklas.soderlund@ragnatech.se>",
        "Received": [
            "from vsp-unauthed02.binero.net (vsp-unauthed02.binero.net\n\t[195.74.38.227])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 9A64E60689\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 10 Jan 2020 20:38:42 +0100 (CET)",
            "from bismarck.berto.se (p54ac5d7b.dip0.t-ipconnect.de\n\t[84.172.93.123]) by bin-vsp-out-02.atm.binero.net (Halon) with ESMTPA\n\tid cc89039e-33e0-11ea-b6d8-005056917f90;\n\tFri, 10 Jan 2020 20:38:38 +0100 (CET)"
        ],
        "X-Halon-ID": "cc89039e-33e0-11ea-b6d8-005056917f90",
        "Authorized-sender": "niklas@soderlund.pp.se",
        "From": "=?utf-8?q?Niklas_S=C3=B6derlund?= <niklas.soderlund@ragnatech.se>",
        "To": "libcamera-devel@lists.libcamera.org",
        "Date": "Fri, 10 Jan 2020 20:37:44 +0100",
        "Message-Id": "<20200110193808.2266294-10-niklas.soderlund@ragnatech.se>",
        "X-Mailer": "git-send-email 2.24.1",
        "In-Reply-To": "<20200110193808.2266294-1-niklas.soderlund@ragnatech.se>",
        "References": "<20200110193808.2266294-1-niklas.soderlund@ragnatech.se>",
        "MIME-Version": "1.0",
        "Content-Type": "text/plain; charset=UTF-8",
        "Content-Transfer-Encoding": "8bit",
        "Subject": "[libcamera-devel] [PATCH v3 09/33] 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": "Fri, 10 Jan 2020 19:38:42 -0000"
    },
    "content": "Switch the IPA interfaces and implementations to use the Framebuffer\ninterface.\n\n- The IPA interface is switched 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\nSigned-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>\n---\n* Changes since v2\n- Update how FrameBuffers are handled in IPARkISP1::mapBuffers() and\n  IPARkISP1::unmapBuffers() to match the changes to FrameBuffers.\n- Add todo about helper to mmap() in RkISP1 IPA.\n- Dropped left over paragraph in commit message from RFCv1 which should\n  have been dropped in v1.\n---\n include/ipa/ipa_interface.h              |  2 +-\n src/ipa/libipa/ipa_interface_wrapper.cpp |  9 ++----\n src/ipa/rkisp1/rkisp1.cpp                | 40 +++++++++++++++++++----\n src/libcamera/ipa_context_wrapper.cpp    |  8 ++---\n src/libcamera/ipa_interface.cpp          |  7 ++--\n src/libcamera/pipeline/rkisp1/rkisp1.cpp | 12 +++++--\n test/ipa/ipa_wrappers_test.cpp           | 41 +++++++++++++-----------\n 7 files changed, 76 insertions(+), 43 deletions(-)",
    "diff": "diff --git a/include/ipa/ipa_interface.h b/include/ipa/ipa_interface.h\nindex 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 };\n \n struct IPAOperationData {\ndiff --git a/src/ipa/libipa/ipa_interface_wrapper.cpp b/src/ipa/libipa/ipa_interface_wrapper.cpp\nindex 6a389dfa714ab535..3628a785dc3e63f4 100644\n--- a/src/ipa/libipa/ipa_interface_wrapper.cpp\n+++ b/src/ipa/libipa/ipa_interface_wrapper.cpp\n@@ -144,17 +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\t/** \\todo Create a Dmabuf class to implement RAII. */\n-\t\t\t::close(_buffer.planes[j].dmabuf);\n+\t\t\tplanes[j].fd = FileDescriptor(_buffer.planes[j].dmabuf);\n+\t\t\tplanes[j].length = _buffer.planes[j].length;\n \t\t}\n \t}\n \ndiff --git a/src/ipa/rkisp1/rkisp1.cpp b/src/ipa/rkisp1/rkisp1.cpp\nindex 744a16ae5b9aa420..74b2922004bed556 100644\n--- a/src/ipa/rkisp1/rkisp1.cpp\n+++ b/src/ipa/rkisp1/rkisp1.cpp\n@@ -10,6 +10,7 @@\n #include <queue>\n #include <stdint.h>\n #include <string.h>\n+#include <sys/mman.h>\n \n #include <linux/rkisp1-config.h>\n \n@@ -48,7 +49,8 @@ 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> buffers_;\n+\tstd::map<unsigned int, void *> buffersMemory_;\n \n \tControlInfoMap ctrls_;\n \n@@ -102,15 +104,39 @@ 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\tauto elem = buffers_.emplace(buffer.id, buffer.planes);\n+\t\tconst FrameBuffer &fb = elem.first->second;\n+\n+\t\t/*\n+\t\t * \\todo Provide a helper to mmap() buffers (possibly exposed\n+\t\t * to applications).\n+\t\t */\n+\t\tbuffersMemory_[buffer.id] = mmap(NULL,\n+\t\t\t\t\t\t fb.planes()[0].length,\n+\t\t\t\t\t\t PROT_READ | PROT_WRITE,\n+\t\t\t\t\t\t MAP_SHARED,\n+\t\t\t\t\t\t fb.planes()[0].fd.fd(),\n+\t\t\t\t\t\t 0);\n+\n+\t\tif (buffersMemory_[buffer.id] == MAP_FAILED) {\n+\t\t\tint ret = -errno;\n+\t\t\tLOG(IPARkISP1, Fatal) << \"Failed to mmap buffer: \"\n+\t\t\t\t\t      << strerror(-ret);\n+\t\t}\n \t}\n }\n \n void IPARkISP1::unmapBuffers(const std::vector<unsigned int> &ids)\n {\n-\tfor (unsigned int id : ids)\n-\t\tbufferInfo_.erase(id);\n+\tfor (unsigned int id : ids) {\n+\t\tconst auto fb = buffers_.find(id);\n+\t\tif (fb == buffers_.end())\n+\t\t\tcontinue;\n+\n+\t\tmunmap(buffersMemory_[id], fb->second.planes()[0].length);\n+\t\tbuffersMemory_.erase(id);\n+\t\tbuffers_.erase(id);\n+\t}\n }\n \n void IPARkISP1::processEvent(const IPAOperationData &event)\n@@ -121,7 +147,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 *>(buffersMemory_[bufferId]);\n \n \t\tupdateStatistics(frame, stats);\n \t\tbreak;\n@@ -131,7 +157,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 *>(buffersMemory_[bufferId]);\n \n \t\tqueueRequest(frame, params, event.controls[0]);\n \t\tbreak;\ndiff --git a/src/libcamera/ipa_context_wrapper.cpp b/src/libcamera/ipa_context_wrapper.cpp\nindex 9603fdac87150aa0..946a2fd8cab1782a 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.fd();\n+\t\t\tc_buffer.planes[j].length = plane.length;\n \t\t}\n \t}\n \ndiff --git a/src/libcamera/ipa_interface.cpp b/src/libcamera/ipa_interface.cpp\nindex 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 /**\ndiff --git a/src/libcamera/pipeline/rkisp1/rkisp1.cpp b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\nindex 7e41222e3d01a475..d7ee95ded0f76027 100644\n--- a/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n+++ b/src/libcamera/pipeline/rkisp1/rkisp1.cpp\n@@ -687,14 +687,22 @@ int PipelineHandlerRkISP1::allocateBuffers(Camera *camera,\n \t}\n \n \tfor (unsigned int i = 0; i < stream->configuration().bufferCount + 1; i++) {\n+\t\tFrameBuffer::Plane plane;\n+\t\tplane.fd = FileDescriptor(paramPool_.buffers()[i].planes()[0].dmabuf());\n+\t\tplane.length = paramPool_.buffers()[i].planes()[0].length();\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 = { plane } });\n \t\tparamBuffers_.push(new Buffer(i));\n \t}\n \n \tfor (unsigned int i = 0; i < stream->configuration().bufferCount + 1; i++) {\n+\t\tFrameBuffer::Plane plane;\n+\t\tplane.fd = FileDescriptor(statPool_.buffers()[i].planes()[0].dmabuf());\n+\t\tplane.length = statPool_.buffers()[i].planes()[0].length();\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 = { plane } });\n \t\tstatBuffers_.push(new Buffer(i));\n \t}\n \ndiff --git a/test/ipa/ipa_wrappers_test.cpp b/test/ipa/ipa_wrappers_test.cpp\nindex a1e34ad52317f47b..e711e4fe318d8179 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.fd() == -1 ||\n+\t\t    buffers[0].planes[1].fd.fd() != -1 ||\n+\t\t    buffers[0].planes[2].fd.fd() != -1 ||\n+\t\t    buffers[0].planes[0].fd.fd() == -1 ||\n+\t\t    buffers[1].planes[1].fd.fd() == -1 ||\n+\t\t    buffers[1].planes[2].fd.fd() != -1) {\n \t\t\tcerr << \"mapBuffers(): Invalid dmabuf\" << endl;\n \t\t\treturn report(Op_mapBuffers, TestFail);\n \t\t}\n@@ -287,13 +287,16 @@ 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 = FileDescriptor(fd_);\n+\t\tbuffers[0].planes[0].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 = FileDescriptor(fd_);\n+\t\tbuffers[1].planes[0].length = 4096;\n+\t\tbuffers[1].planes[1].fd = FileDescriptor(fd_);\n+\t\tbuffers[1].planes[1].length = 4096;\n \n \t\tret = INVOKE(mapBuffers, buffers);\n \t\tif (ret == TestFail)\n",
    "prefixes": [
        "libcamera-devel",
        "v3",
        "09/33"
    ]
}