Show a patch.

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

{
    "id": 23372,
    "url": "https://patchwork.libcamera.org/api/1.1/patches/23372/?format=api",
    "web_url": "https://patchwork.libcamera.org/patch/23372/",
    "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": "<20250515120012.3127231-8-barnabas.pocze@ideasonboard.com>",
    "date": "2025-05-15T12:00:11",
    "name": "[RFC,v1,7/8] libcamera: ipa_data_serializer: Add specialization for enums",
    "commit_ref": null,
    "pull_url": null,
    "state": "superseded",
    "archived": false,
    "hash": "f548c16008b567fe34e8b13de91b3395e2ab9f9b",
    "submitter": {
        "id": 216,
        "url": "https://patchwork.libcamera.org/api/1.1/people/216/?format=api",
        "name": "Barnabás Pőcze",
        "email": "barnabas.pocze@ideasonboard.com"
    },
    "delegate": null,
    "mbox": "https://patchwork.libcamera.org/patch/23372/mbox/",
    "series": [
        {
            "id": 5173,
            "url": "https://patchwork.libcamera.org/api/1.1/series/5173/?format=api",
            "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=5173",
            "date": "2025-05-15T12:00:04",
            "name": "utils: codegen: ipc: Simplify deserialization",
            "version": 1,
            "mbox": "https://patchwork.libcamera.org/series/5173/mbox/"
        }
    ],
    "comments": "https://patchwork.libcamera.org/api/patches/23372/comments/",
    "check": "pending",
    "checks": "https://patchwork.libcamera.org/api/patches/23372/checks/",
    "tags": {},
    "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 95F7EC328D\n\tfor <parsemail@patchwork.libcamera.org>;\n\tThu, 15 May 2025 12:00:32 +0000 (UTC)",
            "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 2202C68D6E;\n\tThu, 15 May 2025 14:00:29 +0200 (CEST)",
            "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 6B65968D6E\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu, 15 May 2025 14:00:19 +0200 (CEST)",
            "from pb-laptop.local (185.221.142.248.nat.pool.zt.hu\n\t[185.221.142.248])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id C974013D7;\n\tThu, 15 May 2025 14:00:01 +0200 (CEST)"
        ],
        "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"j57EsIJG\"; dkim-atps=neutral",
        "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1747310401;\n\tbh=KlLYRQX/yb09aTmFuBEAhe9FMte8G6Yt0Qvep/GllxM=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=j57EsIJGTihP7SudLMtX3C09sZr2EX474A2/EQx6HxVC1dOxO0foU05+HASOmPOlX\n\tXbEgjuarEwlFipnDr/LbYLb3h+ieEI6q7AwT6lzJuUSb577KzHaZ5gyZQ2dCGFUInh\n\tT+bbigOvrdun65zUT3KgThHeW5ML9jcu/5tS9JQM=",
        "From": "=?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= <barnabas.pocze@ideasonboard.com>",
        "To": "libcamera-devel@lists.libcamera.org",
        "Cc": "Paul Elder <paul.elder@ideasonboard.com>",
        "Subject": "[RFC PATCH v1 7/8] libcamera: ipa_data_serializer: Add\n\tspecialization for enums",
        "Date": "Thu, 15 May 2025 14:00:11 +0200",
        "Message-ID": "<20250515120012.3127231-8-barnabas.pocze@ideasonboard.com>",
        "X-Mailer": "git-send-email 2.49.0",
        "In-Reply-To": "<20250515120012.3127231-1-barnabas.pocze@ideasonboard.com>",
        "References": "<20250515120012.3127231-1-barnabas.pocze@ideasonboard.com>",
        "MIME-Version": "1.0",
        "Content-Type": "text/plain; charset=UTF-8",
        "Content-Transfer-Encoding": "8bit",
        "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>",
        "Errors-To": "libcamera-devel-bounces@lists.libcamera.org",
        "Sender": "\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"
    },
    "content": "Instead of handling enums specially in the code generation templates,\ncreate a specialization of `IPADataSerializer` that handles enums.\n\nTo stay compatible, encode every enum as a `uint32_t`, and also\nstatic_assert that the given enum type is smaller.\n\nSigned-off-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>\n---\n .../libcamera/internal/ipa_data_serializer.h  | 48 ++++++++++++++++++-\n .../libcamera_templates/proxy_functions.tmpl  | 17 +------\n .../libcamera_templates/serializer.tmpl       | 14 ------\n 3 files changed, 48 insertions(+), 31 deletions(-)",
    "diff": "diff --git a/include/libcamera/internal/ipa_data_serializer.h b/include/libcamera/internal/ipa_data_serializer.h\nindex b1fefba58..564f59e25 100644\n--- a/include/libcamera/internal/ipa_data_serializer.h\n+++ b/include/libcamera/internal/ipa_data_serializer.h\n@@ -61,7 +61,7 @@ T readPOD(std::vector<uint8_t> &vec, size_t pos)\n \n } /* namespace */\n \n-template<typename T>\n+template<typename T, typename = void>\n class IPADataSerializer\n {\n public:\n@@ -344,6 +344,52 @@ public:\n \t}\n };\n \n+template<typename E>\n+class IPADataSerializer<E, std::enable_if_t<std::is_enum_v<E>>>\n+{\n+\tusing U = uint32_t;\n+\tstatic_assert(sizeof(E) <= sizeof(U));\n+\n+public:\n+\tstatic std::tuple<std::vector<uint8_t>, std::vector<SharedFD>>\n+\tserialize(const E &data, [[maybe_unused]] ControlSerializer *cs = nullptr)\n+\t{\n+\t\tstd::vector<uint8_t> dataVec;\n+\t\tappendPOD<U>(dataVec, static_cast<U>(data));\n+\n+\t\treturn { dataVec, {} };\n+\t}\n+\n+\tstatic E deserialize(std::vector<uint8_t> &data,\n+\t\t\t     [[maybe_unused]] ControlSerializer *cs = nullptr)\n+\t{\n+\t\treturn deserialize(data.cbegin(), data.cend());\n+\t}\n+\n+\tstatic E deserialize(std::vector<uint8_t>::const_iterator dataBegin,\n+\t\t\t     std::vector<uint8_t>::const_iterator dataEnd,\n+\t\t\t     [[maybe_unused]] ControlSerializer *cs = nullptr)\n+\t{\n+\t\treturn static_cast<E>(readPOD<U>(dataBegin, 0, dataEnd));\n+\t}\n+\n+\tstatic E deserialize(std::vector<uint8_t> &data,\n+\t\t\t    [[maybe_unused]] std::vector<SharedFD> &fds,\n+\t\t\t    [[maybe_unused]] ControlSerializer *cs = nullptr)\n+\t{\n+\t\treturn deserialize(data.cbegin(), data.cend());\n+\t}\n+\n+\tstatic E deserialize(std::vector<uint8_t>::const_iterator dataBegin,\n+\t\t\t     std::vector<uint8_t>::const_iterator dataEnd,\n+\t\t\t     [[maybe_unused]] std::vector<SharedFD>::const_iterator fdsBegin,\n+\t\t\t     [[maybe_unused]] std::vector<SharedFD>::const_iterator fdsEnd,\n+\t\t\t     [[maybe_unused]] ControlSerializer *cs = nullptr)\n+\t{\n+\t\treturn deserialize(dataBegin, dataEnd);\n+\t}\n+};\n+\n #endif /* __DOXYGEN__ */\n \n } /* namespace libcamera */\ndiff --git a/utils/codegen/ipc/generators/libcamera_templates/proxy_functions.tmpl b/utils/codegen/ipc/generators/libcamera_templates/proxy_functions.tmpl\nindex 25476990e..01e2567ca 100644\n--- a/utils/codegen/ipc/generators/libcamera_templates/proxy_functions.tmpl\n+++ b/utils/codegen/ipc/generators/libcamera_templates/proxy_functions.tmpl\n@@ -52,9 +52,6 @@\n  #}\n {%- macro serialize_call(params, buf, fds) %}\n {%- for param in params %}\n-{%- if param|is_enum %}\n-\tstatic_assert(sizeof({{param|name_full}}) <= 4);\n-{%- endif %}\n \tstd::vector<uint8_t> {{param.mojom_name}}Buf;\n {%- if param|has_fd %}\n \tstd::vector<SharedFD> {{param.mojom_name}}Fds;\n@@ -62,13 +59,7 @@\n {%- else %}\n \tstd::tie({{param.mojom_name}}Buf, std::ignore) =\n {%- endif %}\n-{%- if param|is_flags %}\n \t\tIPADataSerializer<{{param|name_full}}>::serialize({{param.mojom_name}}\n-{%- elif param|is_enum %}\n-\t\tIPADataSerializer<uint32_t>::serialize(static_cast<uint32_t>({{param.mojom_name}})\n-{%- else %}\n-\t\tIPADataSerializer<{{param|name}}>::serialize({{param.mojom_name}}\n-{% endif -%}\n {{- \", &controlSerializer_\" if param|needs_control_serializer -}}\n );\n {%- endfor %}\n@@ -107,13 +98,7 @@\n  #}\n {%- macro deserialize_param(param, pointer, loop, buf, fds, iter, data_size) -%}\n {{\"*\" if pointer}}{{param.mojom_name}} =\n-{%- if param|is_flags %}\n IPADataSerializer<{{param|name_full}}>::deserialize(\n-{%- elif param|is_enum %}\n-static_cast<{{param|name_full}}>(IPADataSerializer<uint32_t>::deserialize(\n-{%- else %}\n-IPADataSerializer<{{param|name}}>::deserialize(\n-{%- endif %}\n \t{{buf}}{{- \".cbegin()\" if not iter}} + {{param.mojom_name}}Start,\n {%- if loop.last and not iter %}\n \t{{buf}}.cend()\n@@ -137,7 +122,7 @@ IPADataSerializer<{{param|name}}>::deserialize(\n {%- if param|needs_control_serializer %}\n \t&controlSerializer_\n {%- endif -%}\n-){{\")\" if param|is_enum and not param|is_flags}};\n+);\n {%- endmacro -%}\n \n \ndiff --git a/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl b/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl\nindex d07836cc1..e316dd88a 100644\n--- a/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl\n+++ b/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl\n@@ -32,15 +32,7 @@\n {%- if field|is_pod or field|is_enum %}\n \t\tstd::vector<uint8_t> {{field.mojom_name}};\n \t\tstd::tie({{field.mojom_name}}, std::ignore) =\n-\t{%- if field|is_pod %}\n-\t\t\tIPADataSerializer<{{field|name}}>::serialize(data.{{field.mojom_name}});\n-\t{%- elif field|is_flags %}\n \t\t\tIPADataSerializer<{{field|name_full}}>::serialize(data.{{field.mojom_name}});\n-\t{%- elif field|is_enum_scoped %}\n-\t\t\tIPADataSerializer<uint{{field|bit_width}}_t>::serialize(static_cast<uint{{field|bit_width}}_t>(data.{{field.mojom_name}}));\n-\t{%- elif field|is_enum %}\n-\t\t\tIPADataSerializer<uint{{field|bit_width}}_t>::serialize(data.{{field.mojom_name}});\n-\t{%- endif %}\n \t\tretData.insert(retData.end(), {{field.mojom_name}}.begin(), {{field.mojom_name}}.end());\n {%- elif field|is_fd %}\n \t\tstd::vector<uint8_t> {{field.mojom_name}};\n@@ -98,13 +90,7 @@\n {% if field|is_pod or field|is_enum %}\n \t{%- set field_size = (field|bit_width|int / 8)|int %}\n \t\t{{- check_data_size(field_size, 'dataSize', field.mojom_name, 'data')}}\n-\t\t{%- if field|is_pod %}\n-\t\tret.{{field.mojom_name}} = IPADataSerializer<{{field|name}}>::deserialize(m, m + {{field_size}});\n-\t\t{%- elif field|is_flags %}\n \t\tret.{{field.mojom_name}} = IPADataSerializer<{{field|name_full}}>::deserialize(m, m + {{field_size}});\n-\t\t{%- else %}\n-\t\tret.{{field.mojom_name}} = static_cast<{{field|name_full}}>(IPADataSerializer<uint{{field|bit_width}}_t>::deserialize(m, m + {{field_size}}));\n-\t\t{%- endif %}\n \t{%- if not loop.last %}\n \t\tm += {{field_size}};\n \t\tdataSize -= {{field_size}};\n",
    "prefixes": [
        "RFC",
        "v1",
        "7/8"
    ]
}