include:rtdef.h: comment Refine the annotation of RT_ALIGN and RT_ALIGN_DOWN (#10201)

include :rtdef.h : [ Refine the annotation of RT_ALIGN and RT_ALIGN_DOWN ]

This macro is vulnerable to non-2-byte alignments,
but I assume that the macro definition was designed with an explicit use case of 2-byte alignments in mind.
Therefore, I only modify the comment to remind the user.

Solution:
RT_ALIGN(size, align) ((size) + (align) - 1) / (align) * (align)
RT_ALIGN_DOWN(size, align) (size) / (align) * (align)
Here's what deepseek recommends more.

Signed-off-by: Yucai Liu <1486344514@qq.com>
This commit is contained in:
ricky 2025-04-18 17:07:57 +08:00 committed by GitHub
parent 443c530c3c
commit 7125e7bebd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 0 deletions

View File

@ -251,6 +251,7 @@ typedef int (*init_fn_t)(void);
* @def RT_ALIGN(size, align)
* Return the most contiguous size aligned at specified width. RT_ALIGN(13, 4)
* would return 16.
* @note align Must be an integer power of 2 or the result will be incorrect
*/
#define RT_ALIGN(size, align) (((size) + (align) - 1) & ~((align) - 1))
@ -260,6 +261,7 @@ typedef int (*init_fn_t)(void);
* @def RT_ALIGN_DOWN(size, align)
* Return the down number of aligned at specified width. RT_ALIGN_DOWN(13, 4)
* would return 12.
* @note align Must be an integer power of 2 or the result will be incorrect
*/
#define RT_ALIGN_DOWN(size, align) ((size) & ~((align) - 1))