pound-emu/archived-ballistic
1
0
Fork 0
mirror of https://github.com/pound-emu/ballistic.git synced 2026-01-31 01:15:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

engine: update bal_attributes.h docs formatting

Browse Source 
Signed-off-by: Ronald Caesar <github43132@proton.me>
This commit is contained in:
Ronald Caesar
2026-01-23 17:58:32 -04:00
parent d4a1d395ec
commit 24891bf97f
1 changed files with 17 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
include/bal_attributes.h
View File

@@ -8,15 +8,12 @@
#include "bal_platform.h"
/*!
* BAL_HOT()/BAL_COLD()
* Marks a function as hot or cold. Hot makes the compiller optimize it more
* aggressively. Cold marks the function as rarely executed.
*
* Usage:
* BAL_HOT bal_error_t emit_instruction(...);
*/
/// BAL_HOT()/BAL_COLD()
/// Marks a function as hot or cold. Hot makes the compiller optimize it more
/// aggressively. Cold marks the function as rarely executed.
///
/// Usage:
/// BAL_HOT bal_error_t emit_instruction(...);
#if BAL_COMPILER_GCC
#define BAL_HOT __attribute__((hot))
@@ -29,13 +26,10 @@
#endif
/*!
* BAL_LIKELY(x)/BAL_UNLIKELY(x)
* Hints to the CPU branch predictor. Should only be used in hot functions.
*
* Usage: if (BAL_UNLIKELY(ptr == NULL)) { ... }
*/
/// BAL_LIKELY(x)/BAL_UNLIKELY(x)
/// Hints to the CPU branch predictor. Should only be used in hot functions.
///
/// Usage: if (BAL_UNLIKELY(ptr == NULL)) { ... }
#if BAL_COMPILER_GCC
#define BAL_LIKELY(x) __builtin_expect(!!(x), 1)
@@ -48,13 +42,10 @@
#endif
/*!
* BAL_ALIGNED(x)
* Aligns a variable or a structure to x bytes.
*
* Usage: BAL_ALIGNED(64) struct data { ... };
*/
/// BAL_ALIGNED(x)
/// Aligns a variable or a structure to x bytes.
///
/// Usage: BAL_ALIGNED(64) struct data { ... };
#if BAL_COMPILER_GCC
#define BAL_ALIGNED(x) __attribute__((aligned(x)))
@@ -69,12 +60,9 @@
#endif
/*!
* BAL_RESTRICT:
* Tells the compiler that a pointer does not alias any other pointer in
* current scope.
*/
/// BAL_RESTRICT
/// Tells the compiler that a pointer does not alias any other pointer in
/// current scope.
#if BAL_COMPILER_GCC
#define BAL_RESTRICT __restrict__