Use TERM_PRIMARY_* and TERM_IMMED* macros, following erl_term.h #1701
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bettio
reviewed
Jun 10, 2025
pguyot
force-pushed
the
w24/use-erl_term-macros
branch
from
f374948 to
9ce5c26
Compare
jgonet
reviewed
Jun 16, 2025
| @@ -2080,7 +2091,7 @@ static inline term term_alloc_bin_match_state(term binary_or_state, int slots, H | |||
| static inline void term_truncate_boxed(term boxed, size_t new_size, Heap *heap) | |||
| { | |||
| /* boxed: 10 */ | |||
| TERM_DEBUG_ASSERT((t & 0x3) == 0x2); | |||
| TERM_DEBUG_ASSERT((t & TERM_PRIMARY_MASK) == TERM_PRIMARY_BOXED); | |||
jgonet
added a commit
to jgonet/AtomVM
that referenced
this pull request
Jun 16, 2025
memory.c had a missing semicolon, get/put_tuple_element in term.h unpacked header directly instead of using function. Additionally, first condition is already checked by term_is_tuple(). There's one unfixed assert TERM_DEBUG_ASSERT((t & 0x3) == 0x2); but fixing it would create conflicts with atomvm#1701 (changes magic values to macros). Signed-off-by: Jakub Gonet <jakub.gonet@swmansion.com>
Merged
bettio
reviewed
Jun 17, 2025
There was a problem hiding this comment.
ok, makes sense. My last comment on this topic:
I'm not strongly opinionated about this, but the suffix _TAG makes more clear that is a marker that is applied on top of something else.
such as TERM_PRIMARY_BOXED -> TERM_PRIMARY_BOXED_TAG.
Anyway as soon as it is rebased it can be merged.
Erlang/OTP's erl_term.h defines several macros to encode terms and distinguishes `TAG_PRIMARY_*` for the two lowest bits, `_TAG_IMMED1*` for the lowest four bits and `_TAG_IMMED2*` for the lowest six bits. AtomVM term.h uses `TERM_BOXED_*` for the first word of boxed items. It used magic number `0x2` or `TERM_BOXED_VALUE_TAG` instead of what erl_term.h calls `TAG_PRIMARY_BOXED`, which is confusing as it's not related to the first word of boxed item but to the (lowest two bits of the) term itself. This change introduces `TERM_PRIMARY_*` macros following Erlang/OTP erl_term.h's `TAG_PRIMARY_*` macros, and replaces all matching magic numbers with these macros. It also introduces `TERM_IMMED2_*` macros and uses them instead of magic numbers. `TERM_BOXED_VALUE_TAG` is marked as deprecated but kept. No macro called `TERM_IMMED1_*` is introduced as AtomVM already uses non-confusing macros `TERM_PID_TAG`, `TERM_PORT_TAG` and `TERM_INTEGER_TAG`. Signed-off-by: Paul Guyot <pguyot@kallisys.net>
pguyot
force-pushed
the
w24/use-erl_term-macros
branch
from
9ce5c26 to
ea687ad
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Erlang/OTP's erl_term.h defines several macros to encode terms and
distinguishes
TAG_PRIMARY_*for the two lowest bits,_TAG_IMMED1*forthe lowest four bits and
_TAG_IMMED2*for the lowest six bits.AtomVM term.h uses
TERM_BOXED_*for the first word of boxed items.It used magic number
0x2orTERM_BOXED_VALUE_TAGinstead of whaterl_term.h calls
TAG_PRIMARY_BOXED, which is confusing as it's not relatedto the first word of boxed item but to the (lowest two bits of the) term itself.
This change introduces
TERM_PRIMARY_*macros following Erlang/OTP erl_term.h'sTAG_PRIMARY_*macros, and replaces all matching magic numbers with thesemacros.
It also introduces
TERM_IMMED2_*macros and uses them instead of magicnumbers.
TERM_BOXED_VALUE_TAGis marked as deprecated but kept.No macro called
TERM_IMMED1_*is introduced as AtomVM already usesnon-confusing macros
TERM_PID_TAG,TERM_PORT_TAGandTERM_INTEGER_TAG.These changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).
SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later