lunaix-os/includes/lunaix/spike.h

   1 #ifndef __LUNAIX_SPIKE_H
   2 #define __LUNAIX_SPIKE_H
   3
   4 #include <lunaix/compiler.h>
   5
   6 /** Some helper functions. As helpful as Spike the Dragon! :) **/
   7
   8 // 除法 v/(2^k) 向上取整
   9 #define CEIL(v, k) (((v) + (1 << (k)) - 1) >> (k))
  10
  11 #define ICEIL(x, y) ((x) / (y) + ((x) % (y) != 0))
  12
  13 // 除法 v/(2^k) 向下取整
  14 #define FLOOR(v, k) ((v) >> (k))
  15
  16 // 获取v最近的最大k倍数 (k=2^n)
  17 #define ROUNDUP(v, k) (((v) + (k)-1) & ~((k)-1))
  18
  19 // 获取v最近的最小k倍数 (k=2^m)
  20 #define ROUNDDOWN(v, k) ((v) & ~((k)-1))
  21
  22 #define MIN(a, b) ((a) < (b) ? (a) : (b))
  23 #define MAX(a, b) ((a) > (b) ? (a) : (b))
  24
  25 #define is_pot(val) (((val) != 0) || ((val) & ((val)-1)) == 0)
  26
  27 /**
  28  * @brief Fast log base 2 for integer, utilizing constant unfolding.
  29  * Adopted from
  30  * https://elixir.bootlin.com/linux/v4.4/source/include/linux/log2.h#L85
  31  *
  32  */
  33 #define ilog2(x)                                                               \
  34     (__builtin_constant_p(x) ? ((x) == 0              ? 0                      \
  35                                 : ((x) & (1ul << 31)) ? 31                     \
  36                                 : ((x) & (1ul << 30)) ? 30                     \
  37                                 : ((x) & (1ul << 29)) ? 29                     \
  38                                 : ((x) & (1ul << 28)) ? 28                     \
  39                                 : ((x) & (1ul << 27)) ? 27                     \
  40                                 : ((x) & (1ul << 26)) ? 26                     \
  41                                 : ((x) & (1ul << 25)) ? 25                     \
  42                                 : ((x) & (1ul << 24)) ? 24                     \
  43                                 : ((x) & (1ul << 23)) ? 23                     \
  44                                 : ((x) & (1ul << 22)) ? 22                     \
  45                                 : ((x) & (1ul << 21)) ? 21                     \
  46                                 : ((x) & (1ul << 20)) ? 20                     \
  47                                 : ((x) & (1ul << 19)) ? 19                     \
  48                                 : ((x) & (1ul << 18)) ? 18                     \
  49                                 : ((x) & (1ul << 17)) ? 17                     \
  50                                 : ((x) & (1ul << 16)) ? 16                     \
  51                                 : ((x) & (1ul << 15)) ? 15                     \
  52                                 : ((x) & (1ul << 14)) ? 14                     \
  53                                 : ((x) & (1ul << 13)) ? 13                     \
  54                                 : ((x) & (1ul << 12)) ? 12                     \
  55                                 : ((x) & (1ul << 11)) ? 11                     \
  56                                 : ((x) & (1ul << 10)) ? 10                     \
  57                                 : ((x) & (1ul << 9))  ? 9                      \
  58                                 : ((x) & (1ul << 8))  ? 8                      \
  59                                 : ((x) & (1ul << 7))  ? 7                      \
  60                                 : ((x) & (1ul << 6))  ? 6                      \
  61                                 : ((x) & (1ul << 5))  ? 5                      \
  62                                 : ((x) & (1ul << 4))  ? 4                      \
  63                                 : ((x) & (1ul << 3))  ? 3                      \
  64                                 : ((x) & (1ul << 2))  ? 2                      \
  65                                 : ((x) & (1ul << 1))  ? 1                      \
  66                                                       : 0)                      \
  67                              : (msbiti - clz(x)))
  68
  69 #define llog2(x)   (msbitl - clzl(x))
  70
  71 #ifndef CONFIG_NO_ASSERT
  72 #define assert(cond)                                                           \
  73     do {                                                                       \
  74         if (unlikely(!(cond))) {                                                \
  75             __assert_fail(#cond, __FILE__, __LINE__);                          \
  76         }                                                                      \
  77     } while(0)
  78
  79 #define assert_p(cond, prefix)                                                 \
  80     do {                                                                       \
  81         if (unlikely(!(cond))) {                                               \
  82             __assert_fail(prefix ": " #cond, __FILE__, __LINE__);              \
  83         }                                                                      \
  84     } while(0)
  85
  86 #define assert_msg(cond, msg)                                                  \
  87     do {                                                                       \
  88         if (unlikely(!(cond))) {                                               \
  89             __assert_fail(msg, __FILE__, __LINE__);                            \
  90         }                                                                      \
  91     } while(0)
  92
  93 #define assert_msg_p(cond, prefix, msg)                                        \
  94     do {                                                                       \
  95         if (unlikely(!(cond))) {                                               \
  96             __assert_fail(prefix ":" msg, __FILE__, __LINE__);                     \
  97         }                                                                      \
  98     } while(0)
  99
 100 #define must_success(statement)                                                \
 101     do {                                                                       \
 102         int err = (statement);                                                 \
 103         if (err) fail(#statement " failed");                                   \
 104     } while(0)
 105
 106 #define fail(msg) __assert_fail(msg, __FILE__, __LINE__);
 107 #define fail_p(msg, prefix) fail(prefix msg);
 108
 109 void
 110 __assert_fail(const char* expr, const char* file, unsigned int line)
 111     __attribute__((noinline, noreturn));
 112 #else
 113 #define assert(cond) (void)(cond);          // assert nothing
 114 #define assert_msg(cond, msg) (void)(cond); // assert nothing
 115
 116 #endif // CONFIG_NO_ASSERT
 117
 118 #define wait_until(cond)                                                       \
 119     while (!(cond))                                                            \
 120         ;
 121 #define loop_until(cond)                                                       \
 122     while (!(cond))                                                            \
 123         ;
 124
 125 #define wait_until_expire(cond, max)                                           \
 126     ({                                                                         \
 127         unsigned int __wcounter__ = (max);                                     \
 128         while (!(cond) && __wcounter__-- > 1)                                  \
 129             ;                                                                  \
 130         __wcounter__;                                                          \
 131     })
 132
 133 #endif /* __LUNAIX_SPIKE_H */