Skip to content

rfc3: fix message framing length description and define USER1 message flag#502

Merged
mergify[bot] merged 3 commits intoflux-framework:masterfrom
garlick:rfc3_errors
Mar 6, 2026
Merged

rfc3: fix message framing length description and define USER1 message flag#502
mergify[bot] merged 3 commits intoflux-framework:masterfrom
garlick:rfc3_errors

Conversation

@garlick
Copy link
Member

@garlick garlick commented Mar 6, 2026

This corrects some errors and omissions in RFC 3.

Thanks to @manorom for catching the length issue in #496

garlick added 3 commits March 6, 2026 08:17
Problem: the API defines FLUX_MSGFLAG_USER1 as 0x80, and this is used
in the content cache implementation, but RFC 3 leaves this flag bit
undefined, inviting it to be co-opted for incompatible purposes.

Define the user1 flag in the ABNF.

Fixes flux-framework#498
Problem: the figure depicting message framing for messages passed
over the local connector has an incorrect message length.

The length is shown as 0x25 (37 bytes), but the sum of the payload
fields is 0x31 (49 bytes) and the size and magic fields (8 bytes)
are excluded, in conflict with the current implementation.

Update the the length field in the figure to 0x39 (57 bytes) so
that it reflects the actual payload length, plus the size of the
length and magic fields.

Regenerate the png from the dia source.
Problem: RFC 3 specifies the message length for messages framed
for transmission over UNIX domain sockets as sum of the payload
frames, but the implementation includes the length field itself
and the magic field.

Update RFC 3 so that it matches the implementation.

Fixes flux-framework#496
Copy link
Contributor

@grondo grondo left a comment

Choose a reason for hiding this comment

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

LGTM!

@github-actions
Copy link

github-actions bot commented Mar 6, 2026

⚠️ linkcheck failed with status code 2

@garlick
Copy link
Member Author

garlick commented Mar 6, 2026

Thanks! Setting MWP.

@mergify mergify bot added the queued label Mar 6, 2026
@mergify mergify bot merged commit 881c055 into flux-framework:master Mar 6, 2026
6 of 7 checks passed
@mergify
Copy link
Contributor

mergify bot commented Mar 6, 2026

Merge Queue Status

Rule: default


  • Entered queue2026-03-06 16:52 UTC
  • Checks passed · in-place
  • Merged2026-03-06 16:53 UTC · at 60147643d86a961153aa266f96ca4a76bdef8df8

This pull request spent 39 seconds in the queue, with no time running CI.

Required conditions to merge
  • any of [🛡 GitHub branch protection]:
    • check-success = docs/readthedocs.org:flux-rfc
    • check-neutral = docs/readthedocs.org:flux-rfc
    • check-skipped = docs/readthedocs.org:flux-rfc
  • any of [🛡 GitHub branch protection]:
    • check-success = make check
    • check-neutral = make check
    • check-skipped = make check
  • any of [🛡 GitHub branch protection]:
    • check-success = validate commits
    • check-neutral = validate commits
    • check-skipped = validate commits

@mergify mergify bot removed the queued label Mar 6, 2026
@garlick garlick deleted the rfc3_errors branch March 6, 2026 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants