Add support for general handling of trivially serializable types #1330

leekillough · 2025-05-09T02:02:04Z

Template metaprogramming to determine if a type is trivially serializable - that it can be read and written as raw data without any special handling.

The criteria are:

It is one of these types:
- arithmetic (integral, floating-point)
- enumeration (including std::byte)
- pointer-to-member-object (not pointer or pointer-to-member-function)
- std::complex<T>, C99 _Complex
- std::bitset<N>
- trivially copyable, standard layout aggregate type with trivially serializable members and no serialize_order() method

An aggregate is a C-style array, std::array, or a class/struct/union with all public non-static data members and direct bases, no user-provided, inherited or explicit constructors (C++17), no user-declared or inherited constructors (C++20), and no virtual functions or virtual bases.

Pointers are not considered trivially serializable since they have specific addresses which are not portable across runs, and may require special tracking and allocation. But pointers to member objects are typed offsets within a class, and are portable across runs. Pointers to member functions point to a static data structure which is not stable from run to run and is able to handle all contingencies of overriden and virtual functions.

Note: If an aggregate is a union, only the first member will be considered active, and thus cannot be a pointer. Rather than ban unions entirely, pointers in unions are strongly discouraged and can cause unexpected results.

Note: is_trivially_serializable<T> should return true if T is trivially serializable, even if there exists a specialization for serialize_impl<T>. is_trivially_serialzable<T> is a trait for trivial serializability in general, not a serialize_impl specialization test condition. For example, it returns true for arrays of int, even if serialize_impl<int[N]> is specialized.

For mapping mode, this does not change the current behavior, which only implements mapping mode for arithmetic and enumeration types which are trivially serializable. If mapping mode is required for an aggregate class type, a to_string() method and custom serialize_impl specializations are required.

std::complex, C99 _Complex, _Float16 and __float128 are supported as well, although some of them may need to be #ifdef'ed to not be included on certain platforms.

Array serialization uses the is_trivially_serializable<> trait, and calls the primitive serialization routines to serialize/deserialize the whole array as one group of bytes, if the element type is trivially serializable.

This uses C++ metaprogramming and reflection methods to determine whether an aggregate type contains any members which are not trivially serializable, such as pointers.

github-actions · 2025-05-09T02:02:27Z

CLANG-FORMAT TEST - FAILED (on last commit):
Run > ./scripts/clang-format-test.sh using clang-format v20 to check formatting

github-actions · 2025-05-09T02:02:29Z

CMAKE-FORMAT TEST - PASSED

sst-autotester · 2025-05-09T02:20:34Z

Status Flag 'Pre-Test Inspection' - - This Pull Request Requires Inspection... The code must be inspected by a member of the Team before Testing/Merging
NO INSPECTION HAS BEEN PERFORMED ON THIS PULL REQUEST! - This PR must be inspected by setting label 'AT: PRE-TEST INSPECTED'.

github-actions · 2025-05-09T02:33:14Z

CLANG-FORMAT TEST - PASSED

github-actions · 2025-05-09T02:33:15Z

CMAKE-FORMAT TEST - PASSED

github-actions · 2025-05-09T10:40:39Z

CLANG-FORMAT TEST - FAILED (on last commit):
Run > ./scripts/clang-format-test.sh using clang-format v20 to check formatting

github-actions · 2025-05-09T10:40:41Z

CMAKE-FORMAT TEST - PASSED

github-actions · 2025-05-09T10:42:06Z

CLANG-FORMAT TEST - PASSED

github-actions · 2025-05-09T10:42:07Z

CMAKE-FORMAT TEST - PASSED

github-actions · 2025-05-09T10:43:47Z

CMAKE-FORMAT TEST - PASSED

sst-autotester · 2025-06-11T15:27:11Z

Status Flag 'Pull Request AutoTester' - Testing Jenkins Projects:

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements

Build Num: 2078
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2

Build Num: 2034
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2

Build Num: 2033
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist

Build Num: 807
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Build Num: 589
Status: STARTED

Using Repos:

Repo: CORE (leekillough/sst-core)

Repo: SQE (sstsimulator/sst-sqe)

Repo: ELEMENTS (sstsimulator/sst-elements)

Repo: MACRO (sstsimulator/sst-macro)

Pull Request Author: leekillough

sst-autotester · 2025-06-11T15:33:56Z

Status Flag 'Pull Request AutoTester' - Jenkins Testing: 1 or more Jobs FAILED

Note: Testing will normally be attempted again in approx. 4 Hrs. If a change to the PR source branch occurs, the testing will be attempted again on next available autotester run.

Pull Request Auto Testing has FAILED (click to expand)

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements

Result: FAILED
Build #: 2078
URL: Jenkins server at https://sst-jenkins.sandia.gov/view/SST/job/SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements/2078/consoleFull
Job: - Status: FAILURE

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2

Result: FAILED
Build #: 2034
URL: Jenkins server at https://sst-jenkins.sandia.gov/view/SST/job/SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2/2034/consoleFull
Job: - Status: FAILURE

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2

Result: FAILED
Build #: 2033
URL: Jenkins server at https://sst-jenkins.sandia.gov/view/SST/job/SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2/2033/consoleFull
Job: - Status: FAILURE

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist

Result: FAILED
Build #: 807
URL: Jenkins server at https://sst-jenkins.sandia.gov/view/SST/job/SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist/807/consoleFull
Job: - Status: FAILURE

Job: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Result: FAILED
Build #: 589
URL: Jenkins server at https://sst-jenkins.sandia.gov/view/SST/job/SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements/589/consoleFull
Job: - Status: FAILURE

feldergast · 2025-06-11T15:45:50Z

src/sst/core/serialization/impl/serialize_utility.h

+template <>
+inline constexpr bool is_trivially_serializable_v<_Float16, false> = true;
+
+template <>
+inline constexpr bool is_trivially_serializable_v<__float128, false> = true;


Looks like _Float16 isn't available on the compilers on our Linux testers and _float128 isn't available on our Mac testers. We'll either need to remove these are put checks around them.

I have removed __float128 and added an #ifdef around _Float16.

sst-autotester · 2025-06-11T19:53:55Z

Status Flag 'Pull Request AutoTester' - Testing Jenkins Projects:

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements

Build Num: 2079
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2

Build Num: 2035
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2

Build Num: 2034
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist

Build Num: 808
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Build Num: 590
Status: STARTED

Using Repos:

Repo: CORE (leekillough/sst-core)

Repo: SQE (sstsimulator/sst-sqe)

Repo: ELEMENTS (sstsimulator/sst-elements)

Repo: MACRO (sstsimulator/sst-macro)

Pull Request Author: leekillough

sst-autotester · 2025-06-11T20:00:42Z

Status Flag 'Pull Request AutoTester' - Jenkins Testing: 1 or more Jobs FAILED

Note: Testing will normally be attempted again in approx. 4 Hrs. If a change to the PR source branch occurs, the testing will be attempted again on next available autotester run.

Pull Request Auto Testing has FAILED (click to expand)

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements

Result: FAILED
Build #: 2079
URL: Jenkins server at https://sst-jenkins.sandia.gov/view/SST/job/SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements/2079/consoleFull
Job: - Status: FAILURE

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2

Result: FAILED
Build #: 2035
URL: Jenkins server at https://sst-jenkins.sandia.gov/view/SST/job/SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2/2035/consoleFull
Job: - Status: FAILURE

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2

Result: FAILED
Build #: 2034
URL: Jenkins server at https://sst-jenkins.sandia.gov/view/SST/job/SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2/2034/consoleFull
Job: - Status: FAILURE

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist

Result: FAILED
Build #: 808
URL: Jenkins server at https://sst-jenkins.sandia.gov/view/SST/job/SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist/808/consoleFull
Job: - Status: FAILURE

Job: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Result: FAILED
Build #: 590
URL: Jenkins server at https://sst-jenkins.sandia.gov/view/SST/job/SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements/590/consoleFull
Job: - Status: FAILURE

github-actions · 2025-06-12T21:08:12Z

CLANG-FORMAT TEST - PASSED

github-actions · 2025-06-12T21:08:13Z

CMAKE-FORMAT TEST - PASSED

sst-autotester · 2025-06-12T22:11:58Z

Status Flag 'Pre-Test Inspection' - - This Pull Request Requires Inspection... The code must be inspected by a member of the Team before Testing/Merging
NO INSPECTION HAS BEEN PERFORMED ON THIS PULL REQUEST! - This PR must be inspected by setting label 'AT: PRE-TEST INSPECTED'.

sst-autotester · 2025-06-17T00:20:51Z

Status Flag 'Pre-Test Inspection' - SUCCESS: The last commit to this Pull Request has been INSPECTED by label AT: PRE-TEST INSPECTED! Autotester is Removing Label; this inspection will remain valid until a new commit to source branch is performed.

sst-autotester · 2025-06-17T00:23:57Z

Status Flag 'Pull Request AutoTester' - Testing Jenkins Projects:

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements

Build Num: 2090
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2

Build Num: 2046
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2

Build Num: 2045
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist

Build Num: 817
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Build Num: 601
Status: STARTED

Using Repos:

Repo: CORE (leekillough/sst-core)

Repo: SQE (sstsimulator/sst-sqe)

Repo: ELEMENTS (sstsimulator/sst-elements)

Repo: MACRO (sstsimulator/sst-macro)

Pull Request Author: leekillough

sst-autotester · 2025-06-17T00:30:27Z

Status Flag 'Pull Request AutoTester' - Error: Jenkins Jobs - Error: [Jenkins] Cannot retrieve build running status on build ([Errno 32] Broken pipe)

sst-autotester · 2025-06-17T04:53:55Z

Status Flag 'Pull Request AutoTester' - Testing Jenkins Projects:

Pull Request Auto Testing STARTING (click to expand)

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements

Build Num: 2092
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2

Build Num: 2048
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2

Build Num: 2047
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist

Build Num: 818
Status: STARTED

Build Information

Test Name: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Build Num: 603
Status: STARTED

Using Repos:

Repo: CORE (leekillough/sst-core)

Repo: SQE (sstsimulator/sst-sqe)

Repo: ELEMENTS (sstsimulator/sst-elements)

Repo: MACRO (sstsimulator/sst-macro)

Pull Request Author: leekillough

sst-autotester · 2025-06-17T05:49:00Z

Status Flag 'Pull Request AutoTester' - Jenkins Testing: all Jobs PASSED

Pull Request Auto Testing has PASSED (click to expand)

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements

Build Num: 2092
Status: PASSED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2

Build Num: 2048
Status: PASSED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2

Build Num: 2047
Status: PASSED

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist

Build Num: 818
Status: PASSED

Build Information

Test Name: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Build Num: 603
Status: PASSED

sst-autotester · 2025-06-17T05:49:18Z

Status Flag 'Pre-Merge Inspection' - - This Pull Request Requires Inspection... The code must be inspected by a member of the Team before Testing/Merging
THE LAST COMMIT TO THIS PULL REQUEST HAS NOT BEEN REVIEWED YET!

sst-autotester · 2025-06-17T05:49:25Z

All Jobs Finished; status = PASSED, However Inspection must be performed before merge can occur...

sst-autotester · 2025-06-17T09:51:00Z

All Jobs Finished; status = PASSED, However Inspection must be performed before merge can occur...

sst-autotester · 2025-06-17T16:51:22Z

All Jobs Finished; status = PASSED, However Inspection must be performed before merge can occur...

sst-autotester · 2025-06-17T16:57:40Z

Status Flag 'Pre-Merge Inspection' - SUCCESS: The last commit to this Pull Request has been INSPECTED AND APPROVED by [ feldergast ]!

sst-autotester · 2025-06-17T16:57:47Z

Status Flag 'Pull Request AutoTester' - Pull Request MUST BE MERGED MANUALLY BY Project Team - This Repo does not support Automerge

github-actions bot added AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) AT: CLANG-FORMAT FAIL labels May 9, 2025

github-actions bot added AT: CMAKE-FORMAT PASS and removed AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) labels May 9, 2025

leekillough force-pushed the trivially_serializable branch from 098356b to 876b6ed Compare May 9, 2025 02:32

github-actions bot added AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) AT: CLANG-FORMAT PASS and removed AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) AT: CLANG-FORMAT FAIL labels May 9, 2025

github-actions bot added AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) AT: CLANG-FORMAT FAIL and removed AT: CLANG-FORMAT PASS labels May 9, 2025

github-actions bot removed the AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) label May 9, 2025

github-actions bot added AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) AT: CLANG-FORMAT PASS and removed AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) AT: CLANG-FORMAT FAIL labels May 9, 2025

leekillough force-pushed the trivially_serializable branch from 36ca676 to b49fff5 Compare May 9, 2025 10:43

github-actions bot added AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) and removed AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) labels May 9, 2025

feldergast reviewed Jun 11, 2025

View reviewed changes

feldergast added the AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) label Jun 11, 2025

Add support for trivially serializable types

cdbee13

leekillough dismissed feldergast’s stale review via cdbee13 June 12, 2025 21:07

leekillough force-pushed the trivially_serializable branch from 8485352 to cdbee13 Compare June 12, 2025 21:07

github-actions bot removed the AT: WIP Mark PR as a Work in Progress (No Autotesting Performed) label Jun 12, 2025

feldergast added AT: PRE-TEST INSPECTED labels Jun 16, 2025

sst-autotester removed the AT: PRE-TEST INSPECTED label Jun 17, 2025

feldergast approved these changes Jun 17, 2025

View reviewed changes

feldergast merged commit e8f7e72 into sstsimulator:devel Jun 17, 2025
7 checks passed

jleidel mentioned this pull request Jun 18, 2025

macos build failures #1361

Closed

Add support for general handling of trivially serializable types #1330

Add support for general handling of trivially serializable types #1330

Uh oh!

Conversation

leekillough commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 9, 2025

Uh oh!

github-actions bot commented May 9, 2025

Uh oh!

sst-autotester commented May 9, 2025

Uh oh!

github-actions bot commented May 9, 2025

Uh oh!

github-actions bot commented May 9, 2025

Uh oh!

github-actions bot commented May 9, 2025

Uh oh!

github-actions bot commented May 9, 2025

Uh oh!

github-actions bot commented May 9, 2025

Uh oh!

github-actions bot commented May 9, 2025

Uh oh!

github-actions bot commented May 9, 2025

Uh oh!

sst-autotester commented Jun 11, 2025

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist

Build Information

Test Name: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Using Repos:

Uh oh!

sst-autotester commented Jun 11, 2025

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist

Job: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Uh oh!

feldergast Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

leekillough Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

sst-autotester commented Jun 11, 2025

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2

Build Information

Test Name: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist

Build Information

Test Name: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Using Repos:

Uh oh!

sst-autotester commented Jun 11, 2025

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MR-2

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-elements_MT-2

Job: SST__AutotestGen2_NewFW_sst-test_OMPI-4.1.4_PY3.6_sst-core_Make-Dist

Job: SST__AutotestGen2_NewFW_OSX-14-XC15-ARM2_OMPI-4.1.6_PY3.10_sst-elements

Uh oh!

github-actions bot commented Jun 12, 2025

Uh oh!

github-actions bot commented Jun 12, 2025

Uh oh!

sst-autotester commented Jun 12, 2025

Uh oh!

sst-autotester commented Jun 17, 2025

leekillough commented May 9, 2025 •

edited

Loading