From patchwork Thu May 15 12:00:05 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= X-Patchwork-Id: 23366 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id AAAEFC3220 for ; Thu, 15 May 2025 12:00:24 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id C42D168D73; Thu, 15 May 2025 14:00:21 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="pPSNfBRO"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id C4B5C68B6C for ; Thu, 15 May 2025 14:00:16 +0200 (CEST) Received: from pb-laptop.local (185.221.142.248.nat.pool.zt.hu [185.221.142.248]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 878F189A; Thu, 15 May 2025 13:59:59 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1747310399; bh=l7yybGVLafH1XWOnEm8igYUsDS7khbHK2rEVGgdAMBM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=pPSNfBROxfU0GJ3vBFL50KJWyr12bBK8jiWVSnOTiob9U3JMVx339MrAqA7/VvQgN AuoFwgB/kuNcIMBxmFmO0WXwWS/JtTFtzYvsqEi9Gh5hq3zxFHNlep1AJUHEbtmv5e fHeRFTVifEtTcLf7m/eVHIJdJkS64SR3/E+QggS4= From: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= To: libcamera-devel@lists.libcamera.org Cc: Paul Elder Subject: [RFC PATCH v1 1/8] utils: codegen: ipc: Use `any()` instead of `len([]) > 0` Date: Thu, 15 May 2025 14:00:05 +0200 Message-ID: <20250515120012.3127231-2-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 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Use `any()` with a generator expression instead of constructing a list and checking its length. Signed-off-by: Barnabás Pőcze Reviewed-by: Paul Elder --- .../ipc/generators/mojom_libcamera_generator.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/utils/codegen/ipc/generators/mojom_libcamera_generator.py b/utils/codegen/ipc/generators/mojom_libcamera_generator.py index d9c620a05..eff29a5b8 100644 --- a/utils/codegen/ipc/generators/mojom_libcamera_generator.py +++ b/utils/codegen/ipc/generators/mojom_libcamera_generator.py @@ -166,7 +166,7 @@ def MethodParamOutputs(method): return method.response_parameters[1:] def MethodParamsHaveFd(parameters): - return len([x for x in parameters if HasFd(x)]) > 0 + return any(x for x in parameters if HasFd(x)) def MethodInputHasFd(method): return MethodParamsHaveFd(method.parameters) @@ -465,9 +465,9 @@ class Generator(generator.Generator): 'cmd_event_enum_name': '_%sEventCmd' % self.module_name, 'consts': self.module.constants, 'enums': self.module.enums, - 'has_array': len([x for x in self.module.kinds.keys() if x[0] == 'a']) > 0, - 'has_map': len([x for x in self.module.kinds.keys() if x[0] == 'm']) > 0, - 'has_string': len([x for x in self.module.kinds.keys() if x[0] == 's']) > 0, + 'has_array': any(x for x in self.module.kinds.keys() if x[0] == 'a'), + 'has_map': any(x for x in self.module.kinds.keys() if x[0] == 'm'), + 'has_string': any(x for x in self.module.kinds.keys() if x[0] == 's'), 'has_namespace': self.module.mojom_namespace != '', 'interface_event': GetEventInterface(self.module.interfaces), 'interface_main': GetMainInterface(self.module.interfaces), @@ -485,9 +485,9 @@ class Generator(generator.Generator): return { 'consts': self.module.constants, 'enums_gen_header': [x for x in self.module.enums if x.attributes is None or 'skipHeader' not in x.attributes], - 'has_array': len([x for x in self.module.kinds.keys() if x[0] == 'a']) > 0, - 'has_map': len([x for x in self.module.kinds.keys() if x[0] == 'm']) > 0, - 'has_string': len([x for x in self.module.kinds.keys() if x[0] == 's']) > 0, + 'has_array': any(x for x in self.module.kinds.keys() if x[0] == 'a'), + 'has_map': any(x for x in self.module.kinds.keys() if x[0] == 'm'), + 'has_string': any(x for x in self.module.kinds.keys() if x[0] == 's'), 'structs_gen_header': [x for x in self.module.structs if x.attributes is None or 'skipHeader' not in x.attributes], 'structs_gen_serializer': [x for x in self.module.structs if x.attributes is None or 'skipSerdes' not in x.attributes], } From patchwork Thu May 15 12:00:06 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= X-Patchwork-Id: 23367 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 46615C3220 for ; Thu, 15 May 2025 12:00:27 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 756D968C92; Thu, 15 May 2025 14:00:23 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="oGmU38gT"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 079F968B6E for ; Thu, 15 May 2025 14:00:17 +0200 (CEST) Received: from pb-laptop.local (185.221.142.248.nat.pool.zt.hu [185.221.142.248]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id DB8B0A57; Thu, 15 May 2025 13:59:59 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1747310400; bh=cFUUT4bWq0B7vLv+FUMXYm9V1puLnTfIqpnWJEO1PCc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=oGmU38gTcvrq8cCtWuoF5msJfjRg0NBjilJAZ3yBjn/Axx+qy1bSICEUsYNy+pAiu zlu/6DJf8DEX22D6J5+fAOZv9cODxgq+M3JKum/oCVPMmoR2lkEZKxBYGrSAQdU5/z GWaxwew13tBhoIHnHN3ZdOINenamjcgXVx0Wzjrw= From: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= To: libcamera-devel@lists.libcamera.org Cc: Paul Elder Subject: [RFC PATCH v1 2/8] utils: codegen: ipc: Remove `namespace` argument Date: Thu, 15 May 2025 14:00:06 +0200 Message-ID: <20250515120012.3127231-3-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 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The `serializer()`, `deserializer_{fd,no_fd,simple}()` functions take a string argument named "namespace", but they do not use it. So remove the argument. Signed-off-by: Barnabás Pőcze Reviewed-by: Paul Elder --- .../core_ipa_serializer.h.tmpl | 8 ++++---- .../module_ipa_serializer.h.tmpl | 8 ++++---- .../libcamera_templates/serializer.tmpl | 18 +++++++++--------- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/utils/codegen/ipc/generators/libcamera_templates/core_ipa_serializer.h.tmpl b/utils/codegen/ipc/generators/libcamera_templates/core_ipa_serializer.h.tmpl index 036518f6c..cbb35ef51 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/core_ipa_serializer.h.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/core_ipa_serializer.h.tmpl @@ -31,12 +31,12 @@ template<> class IPADataSerializer<{{struct|name}}> { public: -{{- serializer.serializer(struct, "")}} +{{- serializer.serializer(struct)}} {%- if struct|has_fd %} -{{serializer.deserializer_fd(struct, "")}} +{{serializer.deserializer_fd(struct)}} {%- else %} -{{serializer.deserializer_no_fd(struct, "")}} -{{serializer.deserializer_fd_simple(struct, "")}} +{{serializer.deserializer_no_fd(struct)}} +{{serializer.deserializer_fd_simple(struct)}} {%- endif %} }; {% endfor %} diff --git a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_serializer.h.tmpl b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_serializer.h.tmpl index cd5a65a92..f3b8e3b15 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_serializer.h.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_serializer.h.tmpl @@ -32,12 +32,12 @@ template<> class IPADataSerializer<{{struct|name_full}}> { public: -{{- serializer.serializer(struct, namespace_str)}} +{{- serializer.serializer(struct)}} {%- if struct|has_fd %} -{{serializer.deserializer_fd(struct, namespace_str)}} +{{serializer.deserializer_fd(struct)}} {%- else %} -{{serializer.deserializer_no_fd(struct, namespace_str)}} -{{serializer.deserializer_fd_simple(struct, namespace_str)}} +{{serializer.deserializer_no_fd(struct)}} +{{serializer.deserializer_fd_simple(struct)}} {%- endif %} }; {% endfor %} diff --git a/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl b/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl index 323e12939..114e349c9 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl @@ -28,7 +28,7 @@ # # \todo Avoid intermediate vectors #} -{%- macro serializer_field(field, namespace, loop) %} +{%- macro serializer_field(field, loop) %} {%- if field|is_pod or field|is_enum %} std::vector {{field.mojom_name}}; std::tie({{field.mojom_name}}, std::ignore) = @@ -94,7 +94,7 @@ # Generate code to deserialize \a field into object ret. # This code is meant to be used by the IPADataSerializer specialization. #} -{%- macro deserializer_field(field, namespace, loop) %} +{%- macro deserializer_field(field, loop) %} {% if field|is_pod or field|is_enum %} {%- set field_size = (field|bit_width|int / 8)|int %} {{- check_data_size(field_size, 'dataSize', field.mojom_name, 'data')}} @@ -182,7 +182,7 @@ # Generate code for IPADataSerializer specialization, for serializing # \a struct. #} -{%- macro serializer(struct, namespace) %} +{%- macro serializer(struct) %} static std::tuple, std::vector> serialize(const {{struct|name_full}} &data, {%- if struct|needs_control_serializer %} @@ -196,7 +196,7 @@ std::vector retFds; {%- endif %} {%- for field in struct.fields %} -{{serializer_field(field, namespace, loop)}} +{{serializer_field(field, loop)}} {%- endfor %} {% if struct|has_fd %} return {retData, retFds}; @@ -213,7 +213,7 @@ # Generate code for IPADataSerializer specialization, for deserializing # \a struct, in the case that \a struct has file descriptors. #} -{%- macro deserializer_fd(struct, namespace) %} +{%- macro deserializer_fd(struct) %} static {{struct|name_full}} deserialize(std::vector &data, std::vector &fds, @@ -245,7 +245,7 @@ size_t dataSize = std::distance(dataBegin, dataEnd); [[maybe_unused]] size_t fdsSize = std::distance(fdsBegin, fdsEnd); {%- for field in struct.fields -%} -{{deserializer_field(field, namespace, loop)}} +{{deserializer_field(field, loop)}} {%- endfor %} return ret; } @@ -258,7 +258,7 @@ # \a struct, in the case that \a struct has no file descriptors but requires # deserializers with file descriptors. #} -{%- macro deserializer_fd_simple(struct, namespace) %} +{%- macro deserializer_fd_simple(struct) %} static {{struct|name_full}} deserialize(std::vector &data, [[maybe_unused]] std::vector &fds, @@ -285,7 +285,7 @@ # Generate code for IPADataSerializer specialization, for deserializing # \a struct, in the case that \a struct does not have file descriptors. #} -{%- macro deserializer_no_fd(struct, namespace) %} +{%- macro deserializer_no_fd(struct) %} static {{struct|name_full}} deserialize(std::vector &data, {%- if struct|needs_control_serializer %} @@ -312,7 +312,7 @@ size_t dataSize = std::distance(dataBegin, dataEnd); {%- for field in struct.fields -%} -{{deserializer_field(field, namespace, loop)}} +{{deserializer_field(field, loop)}} {%- endfor %} return ret; } From patchwork Thu May 15 12:00:07 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= X-Patchwork-Id: 23368 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 426D8C3220 for ; Thu, 15 May 2025 12:00:29 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 9B38768D72; Thu, 15 May 2025 14:00:24 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="YW6wJd6F"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 4041468B6F for ; Thu, 15 May 2025 14:00:17 +0200 (CEST) Received: from pb-laptop.local (185.221.142.248.nat.pool.zt.hu [185.221.142.248]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 34FA0A98; Thu, 15 May 2025 14:00:00 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1747310400; bh=/B3sXhpwkTa5Gg7mdJMHshgtvVqSlm4UlwZ4Fsaw5Cg=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=YW6wJd6FelkBbcRCTVmV28Nog00My/9EQqd7bnmYcg2K8Rf+majKhO6/zv6hwefb7 NaIgDED4QaJn2Uq1ysPKWvNsjJ6T/Dv3iEfzSa0KLO77gG8uzJu/dRfXigVFLedw0I eaNOGsAb//8aK/LuJUqopFysWJJ2GwcPhShEpD7U= From: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= To: libcamera-devel@lists.libcamera.org Cc: Paul Elder Subject: [RFC PATCH v1 3/8] utils: codegen: ipc: Add `deserializer()` function Date: Thu, 15 May 2025 14:00:07 +0200 Message-ID: <20250515120012.3127231-4-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 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Add `deserializer()` in `serializer.tmpl` to have a single function that generates all the necessary functions into the template specialization like `serializer()`. This also avoids the duplication of some conditional logic. Signed-off-by: Barnabás Pőcze Reviewed-by: Paul Elder --- .../libcamera_templates/core_ipa_serializer.h.tmpl | 7 +------ .../module_ipa_serializer.h.tmpl | 7 +------ .../generators/libcamera_templates/serializer.tmpl | 14 ++++++++++++++ 3 files changed, 16 insertions(+), 12 deletions(-) diff --git a/utils/codegen/ipc/generators/libcamera_templates/core_ipa_serializer.h.tmpl b/utils/codegen/ipc/generators/libcamera_templates/core_ipa_serializer.h.tmpl index cbb35ef51..ac84963dc 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/core_ipa_serializer.h.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/core_ipa_serializer.h.tmpl @@ -32,12 +32,7 @@ class IPADataSerializer<{{struct|name}}> { public: {{- serializer.serializer(struct)}} -{%- if struct|has_fd %} -{{serializer.deserializer_fd(struct)}} -{%- else %} -{{serializer.deserializer_no_fd(struct)}} -{{serializer.deserializer_fd_simple(struct)}} -{%- endif %} +{{- serializer.deserializer(struct)}} }; {% endfor %} diff --git a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_serializer.h.tmpl b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_serializer.h.tmpl index f3b8e3b15..65a7dd11c 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_serializer.h.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_serializer.h.tmpl @@ -33,12 +33,7 @@ class IPADataSerializer<{{struct|name_full}}> { public: {{- serializer.serializer(struct)}} -{%- if struct|has_fd %} -{{serializer.deserializer_fd(struct)}} -{%- else %} -{{serializer.deserializer_no_fd(struct)}} -{{serializer.deserializer_fd_simple(struct)}} -{%- endif %} +{{- serializer.deserializer(struct)}} }; {% endfor %} diff --git a/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl b/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl index 114e349c9..d07836cc1 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl @@ -317,3 +317,17 @@ return ret; } {%- endmacro %} + +{# + # \brief Deserialize a struct + # + # Generate code for IPADataSerializer specialization, for deserializing \a struct. + #} +{%- macro deserializer(struct) %} +{%- if struct|has_fd %} +{{deserializer_fd(struct)}} +{%- else %} +{{deserializer_no_fd(struct)}} +{{deserializer_fd_simple(struct)}} +{%- endif %} +{%- endmacro %} From patchwork Thu May 15 12:00:08 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= X-Patchwork-Id: 23369 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 9526FC328D for ; Thu, 15 May 2025 12:00:30 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id EA84A68D6B; Thu, 15 May 2025 14:00:25 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="T+2F5etH"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 8F9CC68B70 for ; Thu, 15 May 2025 14:00:17 +0200 (CEST) Received: from pb-laptop.local (185.221.142.248.nat.pool.zt.hu [185.221.142.248]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 7FD13886; Thu, 15 May 2025 14:00:00 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1747310400; bh=O/0GBjFh9O7FN9IdFr4qs/b/FCsajvZOuZVKvXKVcwQ=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=T+2F5etHll52Ud9QoUVz1+qxkAptid12bAbqQDFB9d4M/1IL4S15IsNWeMgdyxH/P ZlKU+veJ3onnwdaLmFuTzXo2km8efmBTlpNCeW9vF6qzX70+7P4Y8cQCvHca4wRJoN 1iQXZ2b58mA42JMLbsgik5RO1l+U/P9F3Va6H5AA= From: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= To: libcamera-devel@lists.libcamera.org Cc: Paul Elder Subject: [RFC PATCH v1 4/8] utils: codegen: ipc: Log error code when remote call fails Date: Thu, 15 May 2025 14:00:08 +0200 Message-ID: <20250515120012.3127231-5-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 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The error code can be useful in diagnosing the underlying issue, so log that as well, not just the existence of the issue. Signed-off-by: Barnabás Pőcze Reviewed-by: Paul Elder --- .../generators/libcamera_templates/module_ipa_proxy.cpp.tmpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl index 07165821e..effc8f7dd 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl @@ -206,7 +206,7 @@ void {{proxy_name}}::recvMessage(const IPCMessage &data) ); {%- endif %} if (_ret < 0) { - LOG(IPAProxy, Error) << "Failed to call {{method.mojom_name}}"; + LOG(IPAProxy, Error) << "Failed to call {{method.mojom_name}}: " << _ret; {%- if method|method_return_value != "void" %} return static_cast<{{method|method_return_value}}>(_ret); {%- else %} From patchwork Thu May 15 12:00:09 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= X-Patchwork-Id: 23370 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 68AEFC3220 for ; Thu, 15 May 2025 12:00:31 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id B18DD68D70; Thu, 15 May 2025 14:00:26 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="iikk8OBB"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 4352368B5D for ; Thu, 15 May 2025 14:00:18 +0200 (CEST) Received: from pb-laptop.local (185.221.142.248.nat.pool.zt.hu [185.221.142.248]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 3539A89A; Thu, 15 May 2025 14:00:01 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1747310401; bh=iV3AqVrrv/QwfftjgOAa+8a6ln7NaCNcA+pIvxHxPHc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=iikk8OBBTpbFQR8Ik57v0MGV8ygYGpivv412Q0Hw9eKwDc5n0koWDEGvPXWJsRHNA VmhbMvA0COjrerlk9WeNyWWJ2nZrp8+LKRjiQik1/22hSXJaTq7x4hl3hvG7Un7NFy TT1fsBLZVbvWAXDqx+eMwfhekwIGhzMrjsT/b1j0= From: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= To: libcamera-devel@lists.libcamera.org Cc: Paul Elder Subject: [RFC PATCH v1 5/8] utils: codegen: ipc: Simplify `return` statements Date: Thu, 15 May 2025 14:00:09 +0200 Message-ID: <20250515120012.3127231-6-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 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Returning an expression of type `void` from a function returning `void` is legal, so do not handle those cases specially. Signed-off-by: Barnabás Pőcze Reviewed-by: Paul Elder --- .../libcamera_templates/module_ipa_proxy.cpp.tmpl | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl index effc8f7dd..9a3aadbd2 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl @@ -127,13 +127,13 @@ void {{proxy_name}}::recvMessage(const IPCMessage &data) {{proxy_funcs.func_sig(proxy_name, method)}} { if (isolate_) - {{"return " if method|method_return_value != "void"}}{{method.mojom_name}}IPC( + return {{method.mojom_name}}IPC( {%- for param in method|method_param_names -%} {{param}}{{- ", " if not loop.last}} {%- endfor -%} ); else - {{"return " if method|method_return_value != "void"}}{{method.mojom_name}}Thread( + return {{method.mojom_name}}Thread( {%- for param in method|method_param_names -%} {{param}}{{- ", " if not loop.last}} {%- endfor -%} @@ -159,16 +159,14 @@ void {{proxy_name}}::recvMessage(const IPCMessage &data) state_ = ProxyRunning; thread_.start(); - {{ "return " if method|method_return_value != "void" -}} - proxy_.invokeMethod(&ThreadProxy::start, ConnectionTypeBlocking + return proxy_.invokeMethod(&ThreadProxy::start, ConnectionTypeBlocking {{- ", " if method|method_param_names}} {%- for param in method|method_param_names -%} {{param}}{{- ", " if not loop.last}} {%- endfor -%} ); {%- elif not method|is_async %} - {{ "return " if method|method_return_value != "void" -}} - ipa_->{{method.mojom_name}}( + return ipa_->{{method.mojom_name}}( {%- for param in method|method_param_names -%} {{param}}{{- ", " if not loop.last}} {%- endfor -%} From patchwork Thu May 15 12:00:10 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= X-Patchwork-Id: 23371 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 208F6C331E for ; Thu, 15 May 2025 12:00:32 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id BF9BA68D73; Thu, 15 May 2025 14:00:27 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="rIYl1I3E"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 9090368C92 for ; Thu, 15 May 2025 14:00:18 +0200 (CEST) Received: from pb-laptop.local (185.221.142.248.nat.pool.zt.hu [185.221.142.248]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 7F61C1121; Thu, 15 May 2025 14:00:01 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1747310401; bh=82tyq6j3KwSy/Q4N6O2oal8z5jmNHJqniAzCsWeApZk=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=rIYl1I3EHi8xyUTtmKxZQSJm5TFJRE5370fnF0UYizIt6LwnXETi9ZiQ2QA4QXTQY FL0c2kMfrEGh1m63U03cUtsNM5uK7z9HSUcQe8V0bvMeKwrKLwZiGnaQleoGcKqD9B 60XvotfAFCuKG6SElTbyE2Ta1VARy7Q9v+5PHAN8= From: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= To: libcamera-devel@lists.libcamera.org Cc: Paul Elder Subject: [RFC PATCH v1 6/8] libcamera: ipa_data_serializer: Remove some vector `reserve()` calls Date: Thu, 15 May 2025 14:00:10 +0200 Message-ID: <20250515120012.3127231-7-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 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" `appendPOD()` does a single insertion, so if only a single `appendPOD()` will be called on a vector before returning, then calling `reserve()` is not that useful, so remove it. Signed-off-by: Barnabás Pőcze Reviewed-by: Paul Elder --- include/libcamera/internal/ipa_data_serializer.h | 1 - src/libcamera/ipa_data_serializer.cpp | 1 - 2 files changed, 2 deletions(-) diff --git a/include/libcamera/internal/ipa_data_serializer.h b/include/libcamera/internal/ipa_data_serializer.h index b4614f21d..b1fefba58 100644 --- a/include/libcamera/internal/ipa_data_serializer.h +++ b/include/libcamera/internal/ipa_data_serializer.h @@ -309,7 +309,6 @@ public: serialize(const Flags &data, [[maybe_unused]] ControlSerializer *cs = nullptr) { std::vector dataVec; - dataVec.reserve(sizeof(Flags)); appendPOD(dataVec, static_cast::Type>(data)); return { dataVec, {} }; diff --git a/src/libcamera/ipa_data_serializer.cpp b/src/libcamera/ipa_data_serializer.cpp index 2189a2466..0537f785b 100644 --- a/src/libcamera/ipa_data_serializer.cpp +++ b/src/libcamera/ipa_data_serializer.cpp @@ -196,7 +196,6 @@ IPADataSerializer::serialize(const type &data, \ [[maybe_unused]] ControlSerializer *cs) \ { \ std::vector dataVec; \ - dataVec.reserve(sizeof(type)); \ appendPOD(dataVec, data); \ \ return { dataVec, {} }; \ From patchwork Thu May 15 12:00:11 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= X-Patchwork-Id: 23372 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 95F7EC328D for ; Thu, 15 May 2025 12:00:32 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 2202C68D6E; Thu, 15 May 2025 14:00:29 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="j57EsIJG"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 6B65968D6E for ; Thu, 15 May 2025 14:00:19 +0200 (CEST) Received: from pb-laptop.local (185.221.142.248.nat.pool.zt.hu [185.221.142.248]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id C974013D7; Thu, 15 May 2025 14:00:01 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1747310401; bh=KlLYRQX/yb09aTmFuBEAhe9FMte8G6Yt0Qvep/GllxM=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=j57EsIJGTihP7SudLMtX3C09sZr2EX474A2/EQx6HxVC1dOxO0foU05+HASOmPOlX XbEgjuarEwlFipnDr/LbYLb3h+ieEI6q7AwT6lzJuUSb577KzHaZ5gyZQ2dCGFUInh T+bbigOvrdun65zUT3KgThHeW5ML9jcu/5tS9JQM= From: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= To: libcamera-devel@lists.libcamera.org Cc: Paul Elder Subject: [RFC PATCH v1 7/8] libcamera: ipa_data_serializer: Add specialization 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 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Instead of handling enums specially in the code generation templates, create a specialization of `IPADataSerializer` that handles enums. To stay compatible, encode every enum as a `uint32_t`, and also static_assert that the given enum type is smaller. Signed-off-by: Barnabás Pőcze Reviewed-by: Paul Elder --- .../libcamera/internal/ipa_data_serializer.h | 48 ++++++++++++++++++- .../libcamera_templates/proxy_functions.tmpl | 17 +------ .../libcamera_templates/serializer.tmpl | 14 ------ 3 files changed, 48 insertions(+), 31 deletions(-) diff --git a/include/libcamera/internal/ipa_data_serializer.h b/include/libcamera/internal/ipa_data_serializer.h index b1fefba58..564f59e25 100644 --- a/include/libcamera/internal/ipa_data_serializer.h +++ b/include/libcamera/internal/ipa_data_serializer.h @@ -61,7 +61,7 @@ T readPOD(std::vector &vec, size_t pos) } /* namespace */ -template +template class IPADataSerializer { public: @@ -344,6 +344,52 @@ public: } }; +template +class IPADataSerializer>> +{ + using U = uint32_t; + static_assert(sizeof(E) <= sizeof(U)); + +public: + static std::tuple, std::vector> + serialize(const E &data, [[maybe_unused]] ControlSerializer *cs = nullptr) + { + std::vector dataVec; + appendPOD(dataVec, static_cast(data)); + + return { dataVec, {} }; + } + + static E deserialize(std::vector &data, + [[maybe_unused]] ControlSerializer *cs = nullptr) + { + return deserialize(data.cbegin(), data.cend()); + } + + static E deserialize(std::vector::const_iterator dataBegin, + std::vector::const_iterator dataEnd, + [[maybe_unused]] ControlSerializer *cs = nullptr) + { + return static_cast(readPOD(dataBegin, 0, dataEnd)); + } + + static E deserialize(std::vector &data, + [[maybe_unused]] std::vector &fds, + [[maybe_unused]] ControlSerializer *cs = nullptr) + { + return deserialize(data.cbegin(), data.cend()); + } + + static E deserialize(std::vector::const_iterator dataBegin, + std::vector::const_iterator dataEnd, + [[maybe_unused]] std::vector::const_iterator fdsBegin, + [[maybe_unused]] std::vector::const_iterator fdsEnd, + [[maybe_unused]] ControlSerializer *cs = nullptr) + { + return deserialize(dataBegin, dataEnd); + } +}; + #endif /* __DOXYGEN__ */ } /* namespace libcamera */ diff --git a/utils/codegen/ipc/generators/libcamera_templates/proxy_functions.tmpl b/utils/codegen/ipc/generators/libcamera_templates/proxy_functions.tmpl index 25476990e..01e2567ca 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/proxy_functions.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/proxy_functions.tmpl @@ -52,9 +52,6 @@ #} {%- macro serialize_call(params, buf, fds) %} {%- for param in params %} -{%- if param|is_enum %} - static_assert(sizeof({{param|name_full}}) <= 4); -{%- endif %} std::vector {{param.mojom_name}}Buf; {%- if param|has_fd %} std::vector {{param.mojom_name}}Fds; @@ -62,13 +59,7 @@ {%- else %} std::tie({{param.mojom_name}}Buf, std::ignore) = {%- endif %} -{%- if param|is_flags %} IPADataSerializer<{{param|name_full}}>::serialize({{param.mojom_name}} -{%- elif param|is_enum %} - IPADataSerializer::serialize(static_cast({{param.mojom_name}}) -{%- else %} - IPADataSerializer<{{param|name}}>::serialize({{param.mojom_name}} -{% endif -%} {{- ", &controlSerializer_" if param|needs_control_serializer -}} ); {%- endfor %} @@ -107,13 +98,7 @@ #} {%- macro deserialize_param(param, pointer, loop, buf, fds, iter, data_size) -%} {{"*" if pointer}}{{param.mojom_name}} = -{%- if param|is_flags %} IPADataSerializer<{{param|name_full}}>::deserialize( -{%- elif param|is_enum %} -static_cast<{{param|name_full}}>(IPADataSerializer::deserialize( -{%- else %} -IPADataSerializer<{{param|name}}>::deserialize( -{%- endif %} {{buf}}{{- ".cbegin()" if not iter}} + {{param.mojom_name}}Start, {%- if loop.last and not iter %} {{buf}}.cend() @@ -137,7 +122,7 @@ IPADataSerializer<{{param|name}}>::deserialize( {%- if param|needs_control_serializer %} &controlSerializer_ {%- endif -%} -){{")" if param|is_enum and not param|is_flags}}; +); {%- endmacro -%} diff --git a/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl b/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl index d07836cc1..e316dd88a 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl @@ -32,15 +32,7 @@ {%- if field|is_pod or field|is_enum %} std::vector {{field.mojom_name}}; std::tie({{field.mojom_name}}, std::ignore) = - {%- if field|is_pod %} - IPADataSerializer<{{field|name}}>::serialize(data.{{field.mojom_name}}); - {%- elif field|is_flags %} IPADataSerializer<{{field|name_full}}>::serialize(data.{{field.mojom_name}}); - {%- elif field|is_enum_scoped %} - IPADataSerializer::serialize(static_cast(data.{{field.mojom_name}})); - {%- elif field|is_enum %} - IPADataSerializer::serialize(data.{{field.mojom_name}}); - {%- endif %} retData.insert(retData.end(), {{field.mojom_name}}.begin(), {{field.mojom_name}}.end()); {%- elif field|is_fd %} std::vector {{field.mojom_name}}; @@ -98,13 +90,7 @@ {% if field|is_pod or field|is_enum %} {%- set field_size = (field|bit_width|int / 8)|int %} {{- check_data_size(field_size, 'dataSize', field.mojom_name, 'data')}} - {%- if field|is_pod %} - ret.{{field.mojom_name}} = IPADataSerializer<{{field|name}}>::deserialize(m, m + {{field_size}}); - {%- elif field|is_flags %} ret.{{field.mojom_name}} = IPADataSerializer<{{field|name_full}}>::deserialize(m, m + {{field_size}}); - {%- else %} - ret.{{field.mojom_name}} = static_cast<{{field|name_full}}>(IPADataSerializer::deserialize(m, m + {{field_size}})); - {%- endif %} {%- if not loop.last %} m += {{field_size}}; dataSize -= {{field_size}}; From patchwork Thu May 15 12:00:12 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= X-Patchwork-Id: 23373 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 25DE4C331F for ; Thu, 15 May 2025 12:00:33 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id CF40268D7E; Thu, 15 May 2025 14:00:29 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="t5pCxR87"; dkim-atps=neutral Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id A276268D6B for ; Thu, 15 May 2025 14:00:19 +0200 (CEST) Received: from pb-laptop.local (185.221.142.248.nat.pool.zt.hu [185.221.142.248]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 2387FA98; Thu, 15 May 2025 14:00:02 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1747310402; bh=+GWeYEwXY1mBuWPBdmC7RrHIG9BOHTDNx0VTXyhc3CU=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=t5pCxR87TJ1nVjiY1nPXvIPgC3ncs6ZGxEPjzrTeA/561BYkCa09nYxjoDEcVloNS 20pReE9pVbLgbVkFp739xvB1oDJKMS8JrwnBZ8St0jeL4zMI2tAMlUOPtdhRxUulco w6bCSKfKxBKFpf6MhI5UuaUQdi6DrKSI/ceLcd90= From: =?utf-8?q?Barnab=C3=A1s_P=C5=91cze?= To: libcamera-devel@lists.libcamera.org Cc: Paul Elder Subject: [RFC PATCH v1 8/8] utils: codegen: ipc: Simplify deserialization Date: Thu, 15 May 2025 14:00:12 +0200 Message-ID: <20250515120012.3127231-9-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 X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" First, introduce the `SeriReader` type, which is a collection of bytes and file descriptors, with the appropriate methods to consume the first couples bytes / file descriptors. Then a new method is added to `IPCMessage` that returns an appropriately constructed `SeriReader` for parsing the message contents. Then three of the four `deserialize()` overloads are removed, the remaining one is converted to have a single `SeriReader` and an optional `ControlSerializer` as arguments. The remaining `deserialize()` function is also changed to return an `std::optional` to be able to report deserialization failure. There is also a more fundamental change in the serialization: previously, the number of bytes taken up by an item has been written before the serialized bytes (and conditionally the number of file descriptors) when the item is serialized as part of a struct, array, map, function parameter list. This is changed: the number of bytes and file descriptors are *not* serialized into the final buffer. This affords some simplification of the serialization related code paths, but most importantly, it greatly simplifies and unifies how an object is (de)serialized because the deserialization of every object becomes completely self-contained. As a consequence of that, strings now include their lengths as part of the string serialization, and it is not left to an "upper" layer. Another consequence is that an "out parameter" of a remote function call must be deserialized if a later out parameter is needed, even if itself is not. This does not appear to be a great limitation since in all situations presently none of the out parameters are ignored. Finally, the code generation templates are adapted to the above changes. This allows the simplification of the deserialization templates as now calling `IPADataSerializer::deserialize(reader, &controlSerializer_)` is appropriate for any type. Bug: https://bugs.libcamera.org/show_bug.cgi?id=269 Signed-off-by: Barnabás Pőcze --- .../libcamera/internal/ipa_data_serializer.h | 228 +++-------- include/libcamera/internal/ipc_pipe.h | 3 + include/libcamera/internal/serialization.h | 91 +++++ src/libcamera/ipa_data_serializer.cpp | 356 ++++-------------- src/libcamera/ipc_pipe.cpp | 5 + test/ipc/unixsocket_ipc.cpp | 18 +- .../generated_serializer_test.cpp | 17 +- .../ipa_data_serializer_test.cpp | 32 +- .../module_ipa_proxy.cpp.tmpl | 30 +- .../module_ipa_proxy.h.tmpl | 5 +- .../module_ipa_proxy_worker.cpp.tmpl | 5 +- .../libcamera_templates/proxy_functions.tmpl | 113 +----- .../libcamera_templates/serializer.tmpl | 238 +----------- 13 files changed, 316 insertions(+), 825 deletions(-) create mode 100644 include/libcamera/internal/serialization.h diff --git a/include/libcamera/internal/ipa_data_serializer.h b/include/libcamera/internal/ipa_data_serializer.h index 564f59e25..0d03729a1 100644 --- a/include/libcamera/internal/ipa_data_serializer.h +++ b/include/libcamera/internal/ipa_data_serializer.h @@ -7,6 +7,7 @@ #pragma once +#include #include #include #include @@ -23,6 +24,7 @@ #include #include "libcamera/internal/control_serializer.h" +#include "libcamera/internal/serialization.h" namespace libcamera { @@ -39,26 +41,6 @@ void appendPOD(std::vector &vec, T val) memcpy(&*(vec.end() - byteWidth), &val, byteWidth); } -template> * = nullptr> -T readPOD(std::vector::const_iterator it, size_t pos, - std::vector::const_iterator end) -{ - ASSERT(pos + it < end); - - T ret = 0; - memcpy(&ret, &(*(it + pos)), sizeof(ret)); - - return ret; -} - -template> * = nullptr> -T readPOD(std::vector &vec, size_t pos) -{ - return readPOD(vec.cbegin(), pos, vec.end()); -} - } /* namespace */ template @@ -68,20 +50,8 @@ public: static std::tuple, std::vector> serialize(const T &data, ControlSerializer *cs = nullptr); - static T deserialize(const std::vector &data, - ControlSerializer *cs = nullptr); - static T deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - ControlSerializer *cs = nullptr); - - static T deserialize(const std::vector &data, - const std::vector &fds, - ControlSerializer *cs = nullptr); - static T deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - std::vector::const_iterator fdsBegin, - std::vector::const_iterator fdsEnd, - ControlSerializer *cs = nullptr); + [[nodiscard]] static std::optional + deserialize(SeriReader &reader, ControlSerializer *cs = nullptr); }; #ifndef __DOXYGEN__ @@ -121,9 +91,6 @@ public: std::tie(dvec, fvec) = IPADataSerializer::serialize(it, cs); - appendPOD(dataVec, dvec.size()); - appendPOD(dataVec, fvec.size()); - dataVec.insert(dataVec.end(), dvec.begin(), dvec.end()); fdsVec.insert(fdsVec.end(), fvec.begin(), fvec.end()); } @@ -131,52 +98,25 @@ public: return { dataVec, fdsVec }; } - static std::vector deserialize(std::vector &data, ControlSerializer *cs = nullptr) + [[nodiscard]] static std::optional> + deserialize(SeriReader &reader, ControlSerializer *cs = nullptr) { - return deserialize(data.cbegin(), data.cend(), cs); - } + uint32_t vecLen; + if (!reader.read(vecLen)) + return {}; - static std::vector deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - ControlSerializer *cs = nullptr) - { - std::vector fds; - return deserialize(dataBegin, dataEnd, fds.cbegin(), fds.cend(), cs); - } + std::vector ret; + ret.reserve(vecLen); - static std::vector deserialize(std::vector &data, std::vector &fds, - ControlSerializer *cs = nullptr) - { - return deserialize(data.cbegin(), data.cend(), fds.cbegin(), fds.cend(), cs); - } - - static std::vector deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - std::vector::const_iterator fdsBegin, - [[maybe_unused]] std::vector::const_iterator fdsEnd, - ControlSerializer *cs = nullptr) - { - uint32_t vecLen = readPOD(dataBegin, 0, dataEnd); - std::vector ret(vecLen); - - std::vector::const_iterator dataIter = dataBegin + 4; - std::vector::const_iterator fdIter = fdsBegin; for (uint32_t i = 0; i < vecLen; i++) { - uint32_t sizeofData = readPOD(dataIter, 0, dataEnd); - uint32_t sizeofFds = readPOD(dataIter, 4, dataEnd); - dataIter += 8; - - ret[i] = IPADataSerializer::deserialize(dataIter, - dataIter + sizeofData, - fdIter, - fdIter + sizeofFds, - cs); - - dataIter += sizeofData; - fdIter += sizeofFds; + auto item = IPADataSerializer::deserialize(reader, cs); + if (!item) + return {}; + + ret.emplace_back(std::move(*item)); } - return ret; + return std::move(ret); } }; @@ -218,18 +158,12 @@ public: std::tie(dvec, fvec) = IPADataSerializer::serialize(it.first, cs); - appendPOD(dataVec, dvec.size()); - appendPOD(dataVec, fvec.size()); - dataVec.insert(dataVec.end(), dvec.begin(), dvec.end()); fdsVec.insert(fdsVec.end(), fvec.begin(), fvec.end()); std::tie(dvec, fvec) = IPADataSerializer::serialize(it.second, cs); - appendPOD(dataVec, dvec.size()); - appendPOD(dataVec, fvec.size()); - dataVec.insert(dataVec.end(), dvec.begin(), dvec.end()); fdsVec.insert(fdsVec.end(), fvec.begin(), fvec.end()); } @@ -237,63 +171,25 @@ public: return { dataVec, fdsVec }; } - static std::map deserialize(std::vector &data, ControlSerializer *cs = nullptr) - { - return deserialize(data.cbegin(), data.cend(), cs); - } - - static std::map deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - ControlSerializer *cs = nullptr) + [[nodiscard]] static std::optional> + deserialize(SeriReader &reader, ControlSerializer *cs = nullptr) { - std::vector fds; - return deserialize(dataBegin, dataEnd, fds.cbegin(), fds.cend(), cs); - } + uint32_t mapLen; + if (!reader.read(mapLen)) + return {}; - static std::map deserialize(std::vector &data, std::vector &fds, - ControlSerializer *cs = nullptr) - { - return deserialize(data.cbegin(), data.cend(), fds.cbegin(), fds.cend(), cs); - } - - static std::map deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - std::vector::const_iterator fdsBegin, - [[maybe_unused]] std::vector::const_iterator fdsEnd, - ControlSerializer *cs = nullptr) - { std::map ret; - uint32_t mapLen = readPOD(dataBegin, 0, dataEnd); - - std::vector::const_iterator dataIter = dataBegin + 4; - std::vector::const_iterator fdIter = fdsBegin; for (uint32_t i = 0; i < mapLen; i++) { - uint32_t sizeofData = readPOD(dataIter, 0, dataEnd); - uint32_t sizeofFds = readPOD(dataIter, 4, dataEnd); - dataIter += 8; - - K key = IPADataSerializer::deserialize(dataIter, - dataIter + sizeofData, - fdIter, - fdIter + sizeofFds, - cs); - - dataIter += sizeofData; - fdIter += sizeofFds; - sizeofData = readPOD(dataIter, 0, dataEnd); - sizeofFds = readPOD(dataIter, 4, dataEnd); - dataIter += 8; - - const V value = IPADataSerializer::deserialize(dataIter, - dataIter + sizeofData, - fdIter, - fdIter + sizeofFds, - cs); - ret.insert({ key, value }); - - dataIter += sizeofData; - fdIter += sizeofFds; + auto key = IPADataSerializer::deserialize(reader, cs); + if (!key) + return {}; + + auto value = IPADataSerializer::deserialize(reader, cs); + if (!value) + return {}; + + ret.try_emplace(std::move(*key), std::move(*value)); } return ret; @@ -314,33 +210,14 @@ public: return { dataVec, {} }; } - static Flags deserialize(std::vector &data, - [[maybe_unused]] ControlSerializer *cs = nullptr) - { - return deserialize(data.cbegin(), data.cend()); - } - - static Flags deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - [[maybe_unused]] ControlSerializer *cs = nullptr) + [[nodiscard]] static std::optional> + deserialize(SeriReader &reader, [[maybe_unused]] ControlSerializer *cs = nullptr) { - return Flags{ static_cast(readPOD(dataBegin, 0, dataEnd)) }; - } + uint32_t value; + if (!reader.read(value)) + return {}; - static Flags deserialize(std::vector &data, - [[maybe_unused]] std::vector &fds, - [[maybe_unused]] ControlSerializer *cs = nullptr) - { - return deserialize(data.cbegin(), data.cend()); - } - - static Flags deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - [[maybe_unused]] std::vector::const_iterator fdsBegin, - [[maybe_unused]] std::vector::const_iterator fdsEnd, - [[maybe_unused]] ControlSerializer *cs = nullptr) - { - return deserialize(dataBegin, dataEnd); + return Flags{ static_cast(value) }; } }; @@ -360,33 +237,14 @@ public: return { dataVec, {} }; } - static E deserialize(std::vector &data, - [[maybe_unused]] ControlSerializer *cs = nullptr) + [[nodiscard]] static std::optional + deserialize(SeriReader &reader, [[maybe_unused]] ControlSerializer *cs = nullptr) { - return deserialize(data.cbegin(), data.cend()); - } + U value; + if (!reader.read(value)) + return {}; - static E deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - [[maybe_unused]] ControlSerializer *cs = nullptr) - { - return static_cast(readPOD(dataBegin, 0, dataEnd)); - } - - static E deserialize(std::vector &data, - [[maybe_unused]] std::vector &fds, - [[maybe_unused]] ControlSerializer *cs = nullptr) - { - return deserialize(data.cbegin(), data.cend()); - } - - static E deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - [[maybe_unused]] std::vector::const_iterator fdsBegin, - [[maybe_unused]] std::vector::const_iterator fdsEnd, - [[maybe_unused]] ControlSerializer *cs = nullptr) - { - return deserialize(dataBegin, dataEnd); + return static_cast(value); } }; diff --git a/include/libcamera/internal/ipc_pipe.h b/include/libcamera/internal/ipc_pipe.h index 418c4622f..2b6cde042 100644 --- a/include/libcamera/internal/ipc_pipe.h +++ b/include/libcamera/internal/ipc_pipe.h @@ -14,6 +14,7 @@ #include #include "libcamera/internal/ipc_unixsocket.h" +#include "libcamera/internal/serialization.h" namespace libcamera { @@ -40,6 +41,8 @@ public: const std::vector &data() const { return data_; } const std::vector &fds() const { return fds_; } + SeriReader reader() const { return { data(), fds() }; } + private: Header header_; diff --git a/include/libcamera/internal/serialization.h b/include/libcamera/internal/serialization.h new file mode 100644 index 000000000..daa7e5438 --- /dev/null +++ b/include/libcamera/internal/serialization.h @@ -0,0 +1,91 @@ +/* SPDX-License-Identifier: LGPL-2.1-or-later */ +/* + * Copyright (C) 2025, Ideas On Board Oy + * + * Data (de)serialization helper structures + */ +#pragma once + +#include +#include +#include + +#include +#include + +namespace libcamera { + +#ifndef __DOXYGEN__ +class SeriReader +{ +public: + SeriReader(Span data, Span fds = {}) + : data_(data), + fds_(fds) + { + } + + SeriReader(Span data, Span fds = {}) + : data_(reinterpret_cast(data.data()), + reinterpret_cast(data.data() + data.size())), + fds_(fds) + { + } + + [[nodiscard]] const std::byte *consume(std::size_t s) + { + if (data_.size() < s) + return nullptr; + + const auto *p = data_.data(); + data_ = data_.subspan(s); + + return p; + } + + template + [[nodiscard]] bool read(Ts &...xs) + { + static_assert((std::is_trivially_copyable_v && ...)); + + const auto *p = consume((sizeof(xs) + ...)); + if (p) + ((memcpy(&xs, p, sizeof(xs)), p += sizeof(xs)), ...); + + return p; + } + + template + [[nodiscard]] auto read() + { + std::tuple xs; + bool ok = std::apply([&](auto &...vs) { + return read(vs...); + }, xs); + + if constexpr (sizeof...(Ts) == 1) + return ok ? std::optional(std::get<0>(xs)) : std::nullopt; + else + return ok ? std::optional(xs) : std::nullopt; + } + + [[nodiscard]] const SharedFD *nextFd() + { + if (fds_.empty()) + return nullptr; + + const auto *p = fds_.data(); + fds_ = fds_.subspan(1); + + return p; + } + + [[nodiscard]] bool empty() const { return data_.empty() && fds_.empty(); } + +private: + Span data_; + Span fds_; +}; +#endif + +} /* namespace libcamera */ diff --git a/src/libcamera/ipa_data_serializer.cpp b/src/libcamera/ipa_data_serializer.cpp index 0537f785b..979a1e0db 100644 --- a/src/libcamera/ipa_data_serializer.cpp +++ b/src/libcamera/ipa_data_serializer.cpp @@ -50,42 +50,6 @@ namespace { * generated IPA proxies. */ -/** - * \fn template T readPOD(std::vector::iterator it, size_t pos, - * std::vector::iterator end) - * \brief Read POD from byte vector, in little-endian order - * \tparam T Type of POD to read - * \param[in] it Iterator of byte vector to read from - * \param[in] pos Index in byte vector to read from - * \param[in] end Iterator marking end of byte vector - * - * This function is meant to be used by the IPA data serializer, and the - * generated IPA proxies. - * - * If the \a pos plus the byte-width of the desired POD is past \a end, it is - * a fata error will occur, as it means there is insufficient data for - * deserialization, which should never happen. - * - * \return The POD read from \a it at index \a pos - */ - -/** - * \fn template T readPOD(std::vector &vec, size_t pos) - * \brief Read POD from byte vector, in little-endian order - * \tparam T Type of POD to read - * \param[in] vec Byte vector to read from - * \param[in] pos Index in vec to start reading from - * - * This function is meant to be used by the IPA data serializer, and the - * generated IPA proxies. - * - * If the \a pos plus the byte-width of the desired POD is past the end of - * \a vec, a fatal error will occur, as it means there is insufficient data - * for deserialization, which should never happen. - * - * \return The POD read from \a vec at index \a pos - */ - } /* namespace */ /** @@ -106,80 +70,13 @@ namespace { /** * \fn template IPADataSerializer::deserialize( - * const std::vector &data, + * SeriReader &reader, * ControlSerializer *cs = nullptr) - * \brief Deserialize byte vector into an object + * \brief Deserialize bytes and file descriptors vector into an object * \tparam T Type of object to deserialize to - * \param[in] data Byte vector to deserialize from + * \param[in] reader Source of bytes and file descriptors * \param[in] cs ControlSerializer * - * This version of deserialize() can be used if the object type \a T and its - * members don't have any SharedFD. - * - * \a cs is only necessary if the object type \a T or its members contain - * ControlList or ControlInfoMap. - * - * \return The deserialized object - */ - -/** - * \fn template IPADataSerializer::deserialize( - * std::vector::const_iterator dataBegin, - * std::vector::const_iterator dataEnd, - * ControlSerializer *cs = nullptr) - * \brief Deserialize byte vector into an object - * \tparam T Type of object to deserialize to - * \param[in] dataBegin Begin iterator of byte vector to deserialize from - * \param[in] dataEnd End iterator of byte vector to deserialize from - * \param[in] cs ControlSerializer - * - * This version of deserialize() can be used if the object type \a T and its - * members don't have any SharedFD. - * - * \a cs is only necessary if the object type \a T or its members contain - * ControlList or ControlInfoMap. - * - * \return The deserialized object - */ - -/** - * \fn template IPADataSerializer::deserialize( - * const std::vector &data, - * const std::vector &fds, - * ControlSerializer *cs = nullptr) - * \brief Deserialize byte vector and fd vector into an object - * \tparam T Type of object to deserialize to - * \param[in] data Byte vector to deserialize from - * \param[in] fds Fd vector to deserialize from - * \param[in] cs ControlSerializer - * - * This version of deserialize() (or the iterator version) must be used if - * the object type \a T or its members contain SharedFD. - * - * \a cs is only necessary if the object type \a T or its members contain - * ControlList or ControlInfoMap. - * - * \return The deserialized object - */ - -/** - * \fn template IPADataSerializer::deserialize( - * std::vector::const_iterator dataBegin, - * std::vector::const_iterator dataEnd, - * std::vector::const_iterator fdsBegin, - * std::vector::const_iterator fdsEnd, - * ControlSerializer *cs = nullptr) - * \brief Deserialize byte vector and fd vector into an object - * \tparam T Type of object to deserialize to - * \param[in] dataBegin Begin iterator of byte vector to deserialize from - * \param[in] dataEnd End iterator of byte vector to deserialize from - * \param[in] fdsBegin Begin iterator of fd vector to deserialize from - * \param[in] fdsEnd End iterator of fd vector to deserialize from - * \param[in] cs ControlSerializer - * - * This version of deserialize() (or the vector version) must be used if - * the object type \a T or its members contain SharedFD. - * * \a cs is only necessary if the object type \a T or its members contain * ControlList or ControlInfoMap. * @@ -202,37 +99,11 @@ IPADataSerializer::serialize(const type &data, \ } \ \ template<> \ -type IPADataSerializer::deserialize(std::vector::const_iterator dataBegin, \ - std::vector::const_iterator dataEnd, \ - [[maybe_unused]] ControlSerializer *cs) \ +std::optional IPADataSerializer::deserialize(SeriReader &reader, \ + [[maybe_unused]] ControlSerializer *cs) \ { \ - return readPOD(dataBegin, 0, dataEnd); \ + return reader.read(); \ } \ - \ -template<> \ -type IPADataSerializer::deserialize(const std::vector &data, \ - ControlSerializer *cs) \ -{ \ - return deserialize(data.cbegin(), data.end(), cs); \ -} \ - \ -template<> \ -type IPADataSerializer::deserialize(const std::vector &data, \ - [[maybe_unused]] const std::vector &fds, \ - ControlSerializer *cs) \ -{ \ - return deserialize(data.cbegin(), data.end(), cs); \ -} \ - \ -template<> \ -type IPADataSerializer::deserialize(std::vector::const_iterator dataBegin, \ - std::vector::const_iterator dataEnd, \ - [[maybe_unused]] std::vector::const_iterator fdsBegin, \ - [[maybe_unused]] std::vector::const_iterator fdsEnd, \ - ControlSerializer *cs) \ -{ \ - return deserialize(dataBegin, dataEnd, cs); \ -} DEFINE_POD_SERIALIZER(bool) DEFINE_POD_SERIALIZER(uint8_t) @@ -256,44 +127,29 @@ std::tuple, std::vector> IPADataSerializer::serialize(const std::string &data, [[maybe_unused]] ControlSerializer *cs) { - return { { data.cbegin(), data.end() }, {} }; -} + std::vector dataVec; -template<> -std::string -IPADataSerializer::deserialize(const std::vector &data, - [[maybe_unused]] ControlSerializer *cs) -{ - return { data.cbegin(), data.cend() }; -} + ASSERT(data.size() <= std::numeric_limits::max()); + appendPOD(dataVec, data.size()); + dataVec.insert(dataVec.end(), data.c_str(), data.c_str() + data.size()); -template<> -std::string -IPADataSerializer::deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - [[maybe_unused]] ControlSerializer *cs) -{ - return { dataBegin, dataEnd }; + return { dataVec, {} }; } template<> -std::string -IPADataSerializer::deserialize(const std::vector &data, - [[maybe_unused]] const std::vector &fds, +std::optional +IPADataSerializer::deserialize(SeriReader &reader, [[maybe_unused]] ControlSerializer *cs) { - return { data.cbegin(), data.cend() }; -} + uint32_t length; + if (!reader.read(length)) + return {}; -template<> -std::string -IPADataSerializer::deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - [[maybe_unused]] std::vector::const_iterator fdsBegin, - [[maybe_unused]] std::vector::const_iterator fdsEnd, - [[maybe_unused]] ControlSerializer *cs) -{ - return { dataBegin, dataEnd }; + const auto *p = reader.consume(length); + if (!p) + return {}; + + return { { reinterpret_cast(p), std::size_t(length) } }; } /* @@ -356,73 +212,43 @@ IPADataSerializer::serialize(const ControlList &data, ControlSerial } template<> -ControlList -IPADataSerializer::deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, +std::optional +IPADataSerializer::deserialize(SeriReader &reader, ControlSerializer *cs) { if (!cs) LOG(IPADataSerializer, Fatal) << "ControlSerializer not provided for deserialization of ControlList"; - if (std::distance(dataBegin, dataEnd) < 8) - return {}; - - uint32_t infoDataSize = readPOD(dataBegin, 0, dataEnd); - uint32_t listDataSize = readPOD(dataBegin, 4, dataEnd); - - std::vector::const_iterator it = dataBegin + 8; - - if (infoDataSize + listDataSize < infoDataSize || - static_cast(std::distance(it, dataEnd)) < infoDataSize + listDataSize) + uint32_t infoDataSize, listDataSize; + if (!reader.read(infoDataSize, listDataSize)) return {}; if (infoDataSize > 0) { - ByteStreamBuffer buffer(&*it, infoDataSize); + const auto *p = reader.consume(infoDataSize); + if (!p) + return {}; + + ByteStreamBuffer buffer(reinterpret_cast(p), infoDataSize); ControlInfoMap map = cs->deserialize(buffer); /* It's fine if map is empty. */ if (buffer.overflow()) { LOG(IPADataSerializer, Error) << "Failed to deserialize ControlLists's ControlInfoMap: buffer overflow"; - return ControlList(); + return {}; } } - it += infoDataSize; - ByteStreamBuffer buffer(&*it, listDataSize); + const auto *p = reader.consume(listDataSize); + + ByteStreamBuffer buffer(reinterpret_cast(p), listDataSize); ControlList list = cs->deserialize(buffer); - if (buffer.overflow()) + if (buffer.overflow()) { LOG(IPADataSerializer, Error) << "Failed to deserialize ControlList: buffer overflow"; + return {}; + } - return list; -} - -template<> -ControlList -IPADataSerializer::deserialize(const std::vector &data, - ControlSerializer *cs) -{ - return deserialize(data.cbegin(), data.end(), cs); -} - -template<> -ControlList -IPADataSerializer::deserialize(const std::vector &data, - [[maybe_unused]] const std::vector &fds, - ControlSerializer *cs) -{ - return deserialize(data.cbegin(), data.end(), cs); -} - -template<> -ControlList -IPADataSerializer::deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - [[maybe_unused]] std::vector::const_iterator fdsBegin, - [[maybe_unused]] std::vector::const_iterator fdsEnd, - ControlSerializer *cs) -{ - return deserialize(dataBegin, dataEnd, cs); + return std::move(list); } /* @@ -458,57 +284,28 @@ IPADataSerializer::serialize(const ControlInfoMap &map, } template<> -ControlInfoMap -IPADataSerializer::deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, +std::optional +IPADataSerializer::deserialize(SeriReader &reader, ControlSerializer *cs) { if (!cs) LOG(IPADataSerializer, Fatal) << "ControlSerializer not provided for deserialization of ControlInfoMap"; - if (std::distance(dataBegin, dataEnd) < 4) + uint32_t infoDataSize; + if (!reader.read(infoDataSize)) return {}; - uint32_t infoDataSize = readPOD(dataBegin, 0, dataEnd); - - std::vector::const_iterator it = dataBegin + 4; - - if (static_cast(std::distance(it, dataEnd)) < infoDataSize) + const auto *p = reader.consume(infoDataSize); + if (!p) return {}; - ByteStreamBuffer buffer(&*it, infoDataSize); + ByteStreamBuffer buffer(reinterpret_cast(p), infoDataSize); ControlInfoMap map = cs->deserialize(buffer); + if (buffer.overflow()) + return {}; - return map; -} - -template<> -ControlInfoMap -IPADataSerializer::deserialize(const std::vector &data, - ControlSerializer *cs) -{ - return deserialize(data.cbegin(), data.end(), cs); -} - -template<> -ControlInfoMap -IPADataSerializer::deserialize(const std::vector &data, - [[maybe_unused]] const std::vector &fds, - ControlSerializer *cs) -{ - return deserialize(data.cbegin(), data.end(), cs); -} - -template<> -ControlInfoMap -IPADataSerializer::deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - [[maybe_unused]] std::vector::const_iterator fdsBegin, - [[maybe_unused]] std::vector::const_iterator fdsEnd, - ControlSerializer *cs) -{ - return deserialize(dataBegin, dataEnd, cs); + return std::move(map); } /* @@ -542,27 +339,23 @@ IPADataSerializer::serialize(const SharedFD &data, } template<> -SharedFD IPADataSerializer::deserialize([[maybe_unused]] std::vector::const_iterator dataBegin, - [[maybe_unused]] std::vector::const_iterator dataEnd, - std::vector::const_iterator fdsBegin, - std::vector::const_iterator fdsEnd, - [[maybe_unused]] ControlSerializer *cs) +std::optional +IPADataSerializer::deserialize(SeriReader &reader, + [[maybe_unused]] ControlSerializer *cs) { - ASSERT(std::distance(dataBegin, dataEnd) >= 4); + uint32_t valid; - uint32_t valid = readPOD(dataBegin, 0, dataEnd); + if (!reader.read(valid)) + return {}; - ASSERT(!(valid && std::distance(fdsBegin, fdsEnd) < 1)); + if (!valid) + return SharedFD{}; - return valid ? *fdsBegin : SharedFD(); -} + const auto *fd = reader.nextFd(); + if (!fd) + return {}; -template<> -SharedFD IPADataSerializer::deserialize(const std::vector &data, - const std::vector &fds, - [[maybe_unused]] ControlSerializer *cs) -{ - return deserialize(data.cbegin(), data.end(), fds.cbegin(), fds.end()); + return *fd; } /* @@ -594,30 +387,19 @@ IPADataSerializer::serialize(const FrameBuffer::Plane &data, } template<> -FrameBuffer::Plane -IPADataSerializer::deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - std::vector::const_iterator fdsBegin, - [[maybe_unused]] std::vector::const_iterator fdsEnd, +std::optional +IPADataSerializer::deserialize(SeriReader &reader, [[maybe_unused]] ControlSerializer *cs) { - FrameBuffer::Plane ret; - - ret.fd = IPADataSerializer::deserialize(dataBegin, dataBegin + 4, - fdsBegin, fdsBegin + 1); - ret.offset = readPOD(dataBegin, 4, dataEnd); - ret.length = readPOD(dataBegin, 8, dataEnd); + auto fd = IPADataSerializer::deserialize(reader); + if (!fd) + return {}; - return ret; -} + uint32_t offset, length; + if (!reader.read(offset, length)) + return {}; -template<> -FrameBuffer::Plane -IPADataSerializer::deserialize(const std::vector &data, - const std::vector &fds, - ControlSerializer *cs) -{ - return deserialize(data.cbegin(), data.end(), fds.cbegin(), fds.end(), cs); + return { { std::move(*fd), offset, length } }; } #endif /* __DOXYGEN__ */ diff --git a/src/libcamera/ipc_pipe.cpp b/src/libcamera/ipc_pipe.cpp index 548299d05..71d0c2cb4 100644 --- a/src/libcamera/ipc_pipe.cpp +++ b/src/libcamera/ipc_pipe.cpp @@ -148,6 +148,11 @@ IPCUnixSocket::Payload IPCMessage::payload() const * \brief Returns a const reference to the vector containing file descriptors */ +/** + * \fn IPCMessage::reader() const + * \brief Returns a `SeriReader` instance for parsing the message + */ + /** * \class IPCPipe * \brief IPC message pipe for IPA isolation diff --git a/test/ipc/unixsocket_ipc.cpp b/test/ipc/unixsocket_ipc.cpp index df7d9c2b4..c0e174ba9 100644 --- a/test/ipc/unixsocket_ipc.cpp +++ b/test/ipc/unixsocket_ipc.cpp @@ -102,7 +102,14 @@ private: } case CmdSetAsync: { - value_ = IPADataSerializer::deserialize(ipcMessage.data()); + SeriReader reader = ipcMessage.reader(); + auto value = IPADataSerializer::deserialize(reader); + if (!value) { + cerr << "Failed to deserialize value" << endl; + stop(-ENODATA); + } else { + value_ = *value; + } break; } } @@ -155,7 +162,14 @@ protected: return ret; } - return IPADataSerializer::deserialize(buf.data()); + SeriReader reader = buf.reader(); + auto value = IPADataSerializer::deserialize(reader); + if (!value) { + cerr << "Failed to deserialize value" << endl; + return -ENODATA; + } + + return *value; } int exit() diff --git a/test/serialization/generated_serializer/generated_serializer_test.cpp b/test/serialization/generated_serializer/generated_serializer_test.cpp index dd6968850..0640e741d 100644 --- a/test/serialization/generated_serializer/generated_serializer_test.cpp +++ b/test/serialization/generated_serializer/generated_serializer_test.cpp @@ -43,7 +43,7 @@ if (struct1.field != struct2.field) { \ } - ipa::test::TestStruct t, u; + ipa::test::TestStruct t; t.m = { { "a", "z" }, @@ -71,8 +71,13 @@ if (struct1.field != struct2.field) { \ std::tie(serialized, ignore) = IPADataSerializer::serialize(t); + SeriReader reader(serialized); - u = IPADataSerializer::deserialize(serialized); + auto optu = IPADataSerializer::deserialize(reader); + if (!optu) + return TestFail; + + auto &u = *optu; if (!equals(t.m, u.m)) return TestFail; @@ -91,12 +96,16 @@ if (struct1.field != struct2.field) { \ /* Test vector of generated structs */ std::vector v = { t, u }; - std::vector w; std::tie(serialized, ignore) = IPADataSerializer>::serialize(v); + reader = SeriReader(serialized); + + auto optw = IPADataSerializer>::deserialize(reader); + if (!optw) + return TestFail; - w = IPADataSerializer>::deserialize(serialized); + auto &w = *optw; if (!equals(v[0].m, w[0].m) || !equals(v[1].m, w[1].m)) diff --git a/test/serialization/ipa_data_serializer_test.cpp b/test/serialization/ipa_data_serializer_test.cpp index afea93a6c..3873808a6 100644 --- a/test/serialization/ipa_data_serializer_test.cpp +++ b/test/serialization/ipa_data_serializer_test.cpp @@ -52,7 +52,9 @@ int testPodSerdes(T in) std::vector fds; std::tie(buf, fds) = IPADataSerializer::serialize(in); - T out = IPADataSerializer::deserialize(buf, fds); + SeriReader reader(buf, fds); + + auto out = IPADataSerializer::deserialize(reader); if (in == out) return TestPass; @@ -71,7 +73,9 @@ int testVectorSerdes(const std::vector &in, std::vector fds; std::tie(buf, fds) = IPADataSerializer>::serialize(in, cs); - std::vector out = IPADataSerializer>::deserialize(buf, fds, cs); + SeriReader reader(buf, fds); + + auto out = IPADataSerializer>::deserialize(reader, cs); if (in == out) return TestPass; @@ -91,7 +95,9 @@ int testMapSerdes(const std::map &in, std::vector fds; std::tie(buf, fds) = IPADataSerializer>::serialize(in, cs); - std::map out = IPADataSerializer>::deserialize(buf, fds, cs); + SeriReader reader(buf, fds); + + auto out = IPADataSerializer>::deserialize(reader, cs); if (in == out) return TestPass; @@ -171,17 +177,27 @@ private: std::tie(listBuf, std::ignore) = IPADataSerializer::serialize(list, &cs); - const ControlInfoMap infoMapOut = - IPADataSerializer::deserialize(infoMapBuf, &cs); + SeriReader listReader(listBuf); + SeriReader infoMapReader(infoMapBuf); + + auto infoMapOut = IPADataSerializer::deserialize(infoMapReader, &cs); + if (!infoMapOut) { + cerr << "`ControlInfoMap` cannot be deserialized" << endl; + return TestFail; + } - ControlList listOut = IPADataSerializer::deserialize(listBuf, &cs); + auto listOut = IPADataSerializer::deserialize(listReader, &cs); + if (!listOut) { + cerr << "`ControlList` cannot be deserialized" << endl; + return TestFail; + } - if (!SerializationTest::equals(infoMap, infoMapOut)) { + if (!SerializationTest::equals(infoMap, *infoMapOut)) { cerr << "Deserialized map doesn't match original" << endl; return TestFail; } - if (!SerializationTest::equals(list, listOut)) { + if (!SerializationTest::equals(list, *listOut)) { cerr << "Deserialized list doesn't match original" << endl; return TestFail; } diff --git a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl index 9a3aadbd2..843260b4b 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.cpp.tmpl @@ -107,13 +107,13 @@ namespace {{ns}} { {% if interface_event.methods|length > 0 %} void {{proxy_name}}::recvMessage(const IPCMessage &data) { - size_t dataSize = data.data().size(); + SeriReader reader = data.reader(); {{cmd_event_enum_name}} _cmd = static_cast<{{cmd_event_enum_name}}>(data.header().cmd); switch (_cmd) { {%- for method in interface_event.methods %} case {{cmd_event_enum_name}}::{{method.mojom_name|cap}}: { - {{method.mojom_name}}IPC(data.data().cbegin(), dataSize, data.fds()); + {{method.mojom_name}}IPC(reader); break; } {%- endfor %} @@ -211,18 +211,23 @@ void {{proxy_name}}::recvMessage(const IPCMessage &data) return; {%- endif %} } +{% if has_output %} + SeriReader _outputReader = _ipcOutputBuf.reader(); +{% endif -%} {% if method|method_return_value != "void" %} - {{method|method_return_value}} _retValue = IPADataSerializer<{{method|method_return_value}}>::deserialize(_ipcOutputBuf.data(), 0); - -{{proxy_funcs.deserialize_call(method|method_param_outputs, '_ipcOutputBuf.data()', '_ipcOutputBuf.fds()', init_offset = method|method_return_value|byte_width|int)}} + auto _retValue = IPADataSerializer<{{method|method_return_value}}>::deserialize(_outputReader); + ASSERT(_retValue); +{% endif -%} - return _retValue; +{% if has_output %} + {{proxy_funcs.deserialize_call(method|method_param_outputs, '_outputReader')}} + ASSERT(_outputReader.empty()); +{% endif -%} -{% elif method|method_param_outputs|length > 0 %} -{{proxy_funcs.deserialize_call(method|method_param_outputs, '_ipcOutputBuf.data()', '_ipcOutputBuf.fds()')}} +{% if method|method_return_value != "void" %} + return std::move(*_retValue); {% endif -%} } - {% endfor %} {% for method in interface_event.methods %} @@ -232,12 +237,9 @@ void {{proxy_name}}::recvMessage(const IPCMessage &data) {{method.mojom_name}}.emit({{method.parameters|params_comma_sep}}); } -void {{proxy_name}}::{{method.mojom_name}}IPC( - [[maybe_unused]] std::vector::const_iterator data, - [[maybe_unused]] size_t dataSize, - [[maybe_unused]] const std::vector &fds) +void {{proxy_name}}::{{method.mojom_name}}IPC([[maybe_unused]] SeriReader &reader) { -{{proxy_funcs.deserialize_call(method.parameters, 'data', 'fds', false, true, true, 'dataSize')}} + {{proxy_funcs.deserialize_call(method.parameters, 'reader', false, true)}} {{method.mojom_name}}.emit({{method.parameters|params_comma_sep}}); } {% endfor %} diff --git a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.h.tmpl b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.h.tmpl index a0312a7c1..945a4ded9 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.h.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy.h.tmpl @@ -53,10 +53,7 @@ private: {% endfor %} {% for method in interface_event.methods %} {{proxy_funcs.func_sig(proxy_name, method, "Thread", false)|indent(8, true)}}; - void {{method.mojom_name}}IPC( - std::vector::const_iterator data, - size_t dataSize, - const std::vector &fds); + void {{method.mojom_name}}IPC(SeriReader &reader); {% endfor %} /* Helper class to invoke async functions in another thread. */ diff --git a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy_worker.cpp.tmpl b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy_worker.cpp.tmpl index 1f990d3f9..de6378be0 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy_worker.cpp.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/module_ipa_proxy_worker.cpp.tmpl @@ -71,6 +71,7 @@ public: } IPCMessage _ipcMessage(_message); + SeriReader _reader = _ipcMessage.reader(); {{cmd_enum_name}} _cmd = static_cast<{{cmd_enum_name}}>(_ipcMessage.header().cmd); @@ -85,7 +86,9 @@ public: {%- if method.mojom_name == "configure" %} controlSerializer_.reset(); {%- endif %} - {{proxy_funcs.deserialize_call(method|method_param_inputs, '_ipcMessage.data()', '_ipcMessage.fds()', false, true)|indent(16, true)}} + {{proxy_funcs.deserialize_call(method|method_param_inputs, '_reader', false, true)|indent(16, true)}} + ASSERT(_reader.empty()); + {% for param in method|method_param_outputs %} {{param|name}} {{param.mojom_name}}; {% endfor %} diff --git a/utils/codegen/ipc/generators/libcamera_templates/proxy_functions.tmpl b/utils/codegen/ipc/generators/libcamera_templates/proxy_functions.tmpl index 01e2567ca..b6835ca35 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/proxy_functions.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/proxy_functions.tmpl @@ -64,15 +64,6 @@ ); {%- endfor %} -{%- if params|length > 1 %} -{%- for param in params %} - appendPOD({{buf}}, {{param.mojom_name}}Buf.size()); -{%- if param|has_fd %} - appendPOD({{buf}}, {{param.mojom_name}}Fds.size()); -{%- endif %} -{%- endfor %} -{%- endif %} - {%- for param in params %} {{buf}}.insert({{buf}}.end(), {{param.mojom_name}}Buf.begin(), {{param.mojom_name}}Buf.end()); {%- endfor %} @@ -84,104 +75,28 @@ {%- endfor %} {%- endmacro -%} - -{# - # \brief Deserialize a single object from data buffer and fd vector - # - # \param pointer If true, deserialize the object into a dereferenced pointer - # \param iter If true, treat \a buf as an iterator instead of a vector - # \param data_size Variable that holds the size of the vector referenced by \a buf - # - # Generate code to deserialize a single object, as specified in \a param, - # from \a buf data buffer and \a fds fd vector. - # This code is meant to be used by macro deserialize_call. - #} -{%- macro deserialize_param(param, pointer, loop, buf, fds, iter, data_size) -%} -{{"*" if pointer}}{{param.mojom_name}} = -IPADataSerializer<{{param|name_full}}>::deserialize( - {{buf}}{{- ".cbegin()" if not iter}} + {{param.mojom_name}}Start, -{%- if loop.last and not iter %} - {{buf}}.cend() -{%- elif not iter %} - {{buf}}.cbegin() + {{param.mojom_name}}Start + {{param.mojom_name}}BufSize -{%- elif iter and loop.length == 1 %} - {{buf}} + {{data_size}} -{%- else %} - {{buf}} + {{param.mojom_name}}Start + {{param.mojom_name}}BufSize -{%- endif -%} -{{- "," if param|has_fd}} -{%- if param|has_fd %} - {{fds}}.cbegin() + {{param.mojom_name}}FdStart, -{%- if loop.last %} - {{fds}}.cend() -{%- else %} - {{fds}}.cbegin() + {{param.mojom_name}}FdStart + {{param.mojom_name}}FdsSize -{%- endif -%} -{%- endif -%} -{{- "," if param|needs_control_serializer}} -{%- if param|needs_control_serializer %} - &controlSerializer_ -{%- endif -%} -); -{%- endmacro -%} - - {# - # \brief Deserialize multiple objects from data buffer and fd vector + # \brief Deserialize multiple objects # # \param pointer If true, deserialize objects into pointers, and adds a null check. # \param declare If true, declare the objects in addition to deserialization. - # \param iter if true, treat \a buf as an iterator instead of a vector - # \param data_size Variable that holds the size of the vector referenced by \a buf - # - # Generate code to deserialize multiple objects, as specified in \a params - # (which are the parameters to some function), from \a buf data buffer and - # \a fds fd vector. - # This code is meant to be used by the proxy, for deserializing after IPC calls. # - # \todo Avoid intermediate vectors + # Generate code to deserialize multiple objects, as specified in \a params, + # from \a reader. This code is meant to be used by the proxy, for deserializing + # after IPC calls. #} -{%- macro deserialize_call(params, buf, fds, pointer = true, declare = false, iter = false, data_size = '', init_offset = 0) -%} -{% set ns = namespace(size_offset = init_offset) %} -{%- if params|length > 1 %} +{%- macro deserialize_call(params, reader, pointer = true, declare = false) -%} {%- for param in params %} - [[maybe_unused]] const size_t {{param.mojom_name}}BufSize = readPOD({{buf}}, {{ns.size_offset}} -{%- if iter -%} -, {{buf}} + {{data_size}} -{%- endif -%} -); - {%- set ns.size_offset = ns.size_offset + 4 %} -{%- if param|has_fd %} - [[maybe_unused]] const size_t {{param.mojom_name}}FdsSize = readPOD({{buf}}, {{ns.size_offset}} -{%- if iter -%} -, {{buf}} + {{data_size}} -{%- endif -%} -); - {%- set ns.size_offset = ns.size_offset + 4 %} -{%- endif %} -{%- endfor %} -{%- endif %} -{% for param in params %} -{%- if loop.first %} - const size_t {{param.mojom_name}}Start = {{ns.size_offset}}; -{%- else %} - const size_t {{param.mojom_name}}Start = {{loop.previtem.mojom_name}}Start + {{loop.previtem.mojom_name}}BufSize; -{%- endif %} -{%- endfor %} -{% for param in params|with_fds %} -{%- if loop.first %} - const size_t {{param.mojom_name}}FdStart = 0; + auto param_{{param.mojom_name}} = IPADataSerializer<{{param|name_full}}>::deserialize({{reader}}, &controlSerializer_); + ASSERT(param_{{param.mojom_name}}); + +{%- if pointer %} + if ({{param.mojom_name}}) + *{{param.mojom_name}} = std::move(*param_{{param.mojom_name}}); +{%- elif declare %} + {{param|name}} &{{param.mojom_name}} = *param_{{param.mojom_name}}; {%- else %} - const size_t {{param.mojom_name}}FdStart = {{loop.previtem.mojom_name}}FdStart + {{loop.previtem.mojom_name}}FdsSize; + {{param.mojom_name}} = std::move(*param_{{param.mojom_name}}); {%- endif %} -{%- endfor %} -{% for param in params %} - {%- if pointer %} - if ({{param.mojom_name}}) { -{{deserialize_param(param, pointer, loop, buf, fds, iter, data_size)|indent(16, True)}} - } - {%- else %} - {{param|name + " " if declare}}{{deserialize_param(param, pointer, loop, buf, fds, iter, data_size)|indent(8)}} - {%- endif %} {% endfor %} {%- endmacro -%} diff --git a/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl b/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl index e316dd88a..9e9dd0ca6 100644 --- a/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl +++ b/utils/codegen/ipc/generators/libcamera_templates/serializer.tmpl @@ -2,22 +2,6 @@ # SPDX-License-Identifier: LGPL-2.1-or-later # Copyright (C) 2020, Google Inc. -#} -{# - # \brief Verify that there is enough bytes to deserialize - # - # Generate code that verifies that \a size is not greater than \a dataSize. - # Otherwise log an error with \a name and \a typename. - #} -{%- macro check_data_size(size, dataSize, name, typename) %} - if ({{dataSize}} < {{size}}) { - LOG(IPADataSerializer, Error) - << "Failed to deserialize " << "{{name}}" - << ": not enough {{typename}}, expected " - << ({{size}}) << ", got " << ({{dataSize}}); - return ret; - } -{%- endmacro %} - {# # \brief Serialize a field into return vector @@ -42,15 +26,10 @@ retData.insert(retData.end(), {{field.mojom_name}}.begin(), {{field.mojom_name}}.end()); retFds.insert(retFds.end(), {{field.mojom_name}}Fds.begin(), {{field.mojom_name}}Fds.end()); {%- elif field|is_controls %} - if (data.{{field.mojom_name}}.size() > 0) { - std::vector {{field.mojom_name}}; - std::tie({{field.mojom_name}}, std::ignore) = - IPADataSerializer<{{field|name}}>::serialize(data.{{field.mojom_name}}, cs); - appendPOD(retData, {{field.mojom_name}}.size()); - retData.insert(retData.end(), {{field.mojom_name}}.begin(), {{field.mojom_name}}.end()); - } else { - appendPOD(retData, 0); - } + std::vector {{field.mojom_name}}; + std::tie({{field.mojom_name}}, std::ignore) = + IPADataSerializer<{{field|name}}>::serialize(data.{{field.mojom_name}}, cs); + retData.insert(retData.end(), {{field.mojom_name}}.begin(), {{field.mojom_name}}.end()); {%- elif field|is_plain_struct or field|is_array or field|is_map or field|is_str %} std::vector {{field.mojom_name}}; {%- if field|has_fd %} @@ -65,10 +44,6 @@ IPADataSerializer<{{field|name}}>::serialize(data.{{field.mojom_name}}); {%- else %} IPADataSerializer<{{field|name_full}}>::serialize(data.{{field.mojom_name}}, cs); - {%- endif %} - appendPOD(retData, {{field.mojom_name}}.size()); - {%- if field|has_fd %} - appendPOD(retData, {{field.mojom_name}}Fds.size()); {%- endif %} retData.insert(retData.end(), {{field.mojom_name}}.begin(), {{field.mojom_name}}.end()); {%- if field|has_fd %} @@ -79,89 +54,6 @@ {%- endif %} {%- endmacro %} - -{# - # \brief Deserialize a field into return struct - # - # Generate code to deserialize \a field into object ret. - # This code is meant to be used by the IPADataSerializer specialization. - #} -{%- macro deserializer_field(field, loop) %} -{% if field|is_pod or field|is_enum %} - {%- set field_size = (field|bit_width|int / 8)|int %} - {{- check_data_size(field_size, 'dataSize', field.mojom_name, 'data')}} - ret.{{field.mojom_name}} = IPADataSerializer<{{field|name_full}}>::deserialize(m, m + {{field_size}}); - {%- if not loop.last %} - m += {{field_size}}; - dataSize -= {{field_size}}; - {%- endif %} -{% elif field|is_fd %} - {%- set field_size = 4 %} - {{- check_data_size(field_size, 'dataSize', field.mojom_name, 'data')}} - ret.{{field.mojom_name}} = IPADataSerializer<{{field|name}}>::deserialize(m, m + {{field_size}}, n, n + 1, cs); - {%- if not loop.last %} - m += {{field_size}}; - dataSize -= {{field_size}}; - n += ret.{{field.mojom_name}}.isValid() ? 1 : 0; - fdsSize -= ret.{{field.mojom_name}}.isValid() ? 1 : 0; - {%- endif %} -{% elif field|is_controls %} - {%- set field_size = 4 %} - {{- check_data_size(field_size, 'dataSize', field.mojom_name + 'Size', 'data')}} - const size_t {{field.mojom_name}}Size = readPOD(m, 0, dataEnd); - m += {{field_size}}; - dataSize -= {{field_size}}; - {%- set field_size = field.mojom_name + 'Size' -%} - {{- check_data_size(field_size, 'dataSize', field.mojom_name, 'data')}} - if ({{field.mojom_name}}Size > 0) - ret.{{field.mojom_name}} = - IPADataSerializer<{{field|name}}>::deserialize(m, m + {{field.mojom_name}}Size, cs); - {%- if not loop.last %} - m += {{field_size}}; - dataSize -= {{field_size}}; - {%- endif %} -{% elif field|is_plain_struct or field|is_array or field|is_map or field|is_str %} - {%- set field_size = 4 %} - {{- check_data_size(field_size, 'dataSize', field.mojom_name + 'Size', 'data')}} - const size_t {{field.mojom_name}}Size = readPOD(m, 0, dataEnd); - m += {{field_size}}; - dataSize -= {{field_size}}; - {%- if field|has_fd %} - {%- set field_size = 4 %} - {{- check_data_size(field_size, 'dataSize', field.mojom_name + 'FdsSize', 'data')}} - const size_t {{field.mojom_name}}FdsSize = readPOD(m, 0, dataEnd); - m += {{field_size}}; - dataSize -= {{field_size}}; - {{- check_data_size(field.mojom_name + 'FdsSize', 'fdsSize', field.mojom_name, 'fds')}} - {%- endif %} - {%- set field_size = field.mojom_name + 'Size' -%} - {{- check_data_size(field_size, 'dataSize', field.mojom_name, 'data')}} - ret.{{field.mojom_name}} = - {%- if field|is_str %} - IPADataSerializer<{{field|name}}>::deserialize(m, m + {{field.mojom_name}}Size); - {%- elif field|has_fd and (field|is_array or field|is_map) %} - IPADataSerializer<{{field|name}}>::deserialize(m, m + {{field.mojom_name}}Size, n, n + {{field.mojom_name}}FdsSize, cs); - {%- elif field|has_fd and (not (field|is_array or field|is_map)) %} - IPADataSerializer<{{field|name_full}}>::deserialize(m, m + {{field.mojom_name}}Size, n, n + {{field.mojom_name}}FdsSize, cs); - {%- elif (not field|has_fd) and (field|is_array or field|is_map) %} - IPADataSerializer<{{field|name}}>::deserialize(m, m + {{field.mojom_name}}Size, cs); - {%- else %} - IPADataSerializer<{{field|name_full}}>::deserialize(m, m + {{field.mojom_name}}Size, cs); - {%- endif %} - {%- if not loop.last %} - m += {{field_size}}; - dataSize -= {{field_size}}; - {%- if field|has_fd %} - n += {{field.mojom_name}}FdsSize; - fdsSize -= {{field.mojom_name}}FdsSize; - {%- endif %} - {%- endif %} -{% else %} - /* Unknown deserialization for {{field.mojom_name}}. */ -{%- endif %} -{%- endmacro %} - - {# # \brief Serialize a struct # @@ -194,126 +86,30 @@ {# - # \brief Deserialize a struct that has fds + # \brief Deserialize a struct # - # Generate code for IPADataSerializer specialization, for deserializing - # \a struct, in the case that \a struct has file descriptors. + # Generate code for IPADataSerializer specialization, for deserializing \a struct. #} -{%- macro deserializer_fd(struct) %} - static {{struct|name_full}} - deserialize(std::vector &data, - std::vector &fds, -{%- if struct|needs_control_serializer %} - ControlSerializer *cs) -{%- else %} - ControlSerializer *cs = nullptr) -{%- endif %} - { - return IPADataSerializer<{{struct|name_full}}>::deserialize(data.cbegin(), data.cend(), fds.cbegin(), fds.cend(), cs); - } - +{%- macro deserializer(struct) %} {# \todo Don't inline this function #} - static {{struct|name_full}} - deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - std::vector::const_iterator fdsBegin, - std::vector::const_iterator fdsEnd, + [[nodiscard]] static std::optional<{{struct|name_full}}> + deserialize(SeriReader &reader, {%- if struct|needs_control_serializer %} ControlSerializer *cs) {%- else %} [[maybe_unused]] ControlSerializer *cs = nullptr) {%- endif %} { - {{struct|name_full}} ret; - std::vector::const_iterator m = dataBegin; - std::vector::const_iterator n = fdsBegin; - - size_t dataSize = std::distance(dataBegin, dataEnd); - [[maybe_unused]] size_t fdsSize = std::distance(fdsBegin, fdsEnd); -{%- for field in struct.fields -%} -{{deserializer_field(field, loop)}} +{%- for field in struct.fields %} + auto {{field.mojom_name}} = IPADataSerializer<{{field|name_full}}>::deserialize(reader, cs); + if (!{{field.mojom_name}}) + return {}; {%- endfor %} - return ret; - } -{%- endmacro %} - -{# - # \brief Deserialize a struct that has fds, using non-fd - # - # Generate code for IPADataSerializer specialization, for deserializing - # \a struct, in the case that \a struct has no file descriptors but requires - # deserializers with file descriptors. - #} -{%- macro deserializer_fd_simple(struct) %} - static {{struct|name_full}} - deserialize(std::vector &data, - [[maybe_unused]] std::vector &fds, - ControlSerializer *cs = nullptr) - { - return IPADataSerializer<{{struct|name_full}}>::deserialize(data.cbegin(), data.cend(), cs); - } - - static {{struct|name_full}} - deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, - [[maybe_unused]] std::vector::const_iterator fdsBegin, - [[maybe_unused]] std::vector::const_iterator fdsEnd, - ControlSerializer *cs = nullptr) - { - return IPADataSerializer<{{struct|name_full}}>::deserialize(dataBegin, dataEnd, cs); - } -{%- endmacro %} - - -{# - # \brief Deserialize a struct that has no fds - # - # Generate code for IPADataSerializer specialization, for deserializing - # \a struct, in the case that \a struct does not have file descriptors. - #} -{%- macro deserializer_no_fd(struct) %} - static {{struct|name_full}} - deserialize(std::vector &data, -{%- if struct|needs_control_serializer %} - ControlSerializer *cs) -{%- else %} - ControlSerializer *cs = nullptr) -{%- endif %} - { - return IPADataSerializer<{{struct|name_full}}>::deserialize(data.cbegin(), data.cend(), cs); - } -{# \todo Don't inline this function #} - static {{struct|name_full}} - deserialize(std::vector::const_iterator dataBegin, - std::vector::const_iterator dataEnd, -{%- if struct|needs_control_serializer %} - ControlSerializer *cs) -{%- else %} - [[maybe_unused]] ControlSerializer *cs = nullptr) -{%- endif %} - { - {{struct|name_full}} ret; - std::vector::const_iterator m = dataBegin; - - size_t dataSize = std::distance(dataBegin, dataEnd); -{%- for field in struct.fields -%} -{{deserializer_field(field, loop)}} + return { { +{%- for field in struct.fields %} + std::move(*{{field.mojom_name}}), {%- endfor %} - return ret; + } }; } {%- endmacro %} - -{# - # \brief Deserialize a struct - # - # Generate code for IPADataSerializer specialization, for deserializing \a struct. - #} -{%- macro deserializer(struct) %} -{%- if struct|has_fd %} -{{deserializer_fd(struct)}} -{%- else %} -{{deserializer_no_fd(struct)}} -{{deserializer_fd_simple(struct)}} -{%- endif %} -{%- endmacro %}