Skip to content

Conversation

@andreagilardoni
Copy link

This PR aims to:

  • add a check on header fields to ensure endianness through byteorder zephyr library
  • redefine struct sketch_header_v1 to a union which can simplify the procedure of converting a 16 byte buffer into a C struct and respect the strict aliasing rule.

Copy link

@pillo79 pillo79 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, not sure about the need for endianness checks as it would require a very big effort to go over the whole project (code and tools) to make sure there is proper support for it.

EDIT: please add a short commit message that explains why this is useful.

@andreagilardoni
Copy link
Author

@pillo79 I believe that the endianness commit has little to no cost in terms of code space (on little endian platforms) and in a distant future where we may try a big endian platform we have one place less to check to make it compatible. I don't see any other reasons except that this is a free improvement in platform independent code.

sketch_hdr.len = sys_le32_to_cpu(sketch_hdr.len);
sketch_hdr.magic = sys_le16_to_cpu(sketch_hdr.magic);

if (sketch_hdr.ver != 0x1 || sketch_hdr.magic != 0x2341) {
Copy link
Member

@leonardocavagnis leonardocavagnis Nov 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if (sketch_hdr.ver != 0x1 || sketch_hdr.magic != 0x2341) {
if (sketch_hdr.ver != SKETCH_VER || sketch_hdr.magic != SKETCH_MAGIC) {

Consider replacing the magic numbers with #define constants for maintainability

Copy link
Member

@leonardocavagnis leonardocavagnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)
minor change suggested

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants