#include <limits.h>
#include <stdarg.h>
#include <stdatomic.h>
#include <stddef.h>
#include <stdint.h>
#include <stdio.h>

Include dependency graph for utils.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	srn_spinlock_t

Macros
#define	SERENE_DEBUG 0
#define	UNUSED(x)
#define	PANIC(msg)
#define	TODO(msg)
#define	PANIC_WITH_CTX(ctx, msg)
#define	PANIC_IF(cond, msg)
#define	PANIC_IF_NULL(ptr)
#define	RETURN_IF_NULL(ptr)
#define	SNPRINTF(buf, s, f, ...)
#define	SHOULD_NOT_HAPPEN PANIC("This should not happen")
#define	PANIC_ON_ERR(interr)
#define	SRN_ATTR_COLD
#define	SRN_ATTR_FMT(a, b)
#define	DBG(...)
#define	DBG_HEX(...)
#define	DBG_ASSERT(x)
#define	SRN_NS_PER_SEC 1000000000ULL
	nanoseconds in one second
#define	SRN_NS_PER_MS 1000000ULL
	nanoseconds in one millisecond
#define	TYPE_BITS(T)
#define	MAX_POW2_EXP_FOR_UNSIGNED(T)

Typedefs
typedef struct srn_spinlock_t	srn_spinlock_t

Functions
void	srn_panic (const char msg, const char file, size_t line, const char *fn)
	TODO(lxsameer): unwind the stack.
static uint32_t	srn_popcnt32 (uint32_t x)
static uint64_t	srn_popcnt64 (uint64_t x)
static void	cpu_relax (void)
	A portable way to use pasue instructions.
static void	srn_spinlock_unlock (srn_spinlock_t *lock)
static void	srn_spinlock_init (srn_spinlock_t *lock)
static void	srn_spinlock_lock (srn_spinlock_t *lock)
char *	srn_copy_bytes (const srn_context_t ctx, const char src, size_t len, size_t alignment)
char *	srn_dup_str (srn_mm_t mm, const char s)
	Copy a null terminated C string into a fresh allocation made through mm.
uint64_t	srn_now_ns (void)
	The current time on the monotonic clock, in nanoseconds.

Macro Definition Documentation

◆ DBG

#define DBG ( ... )

Value:

do { \

} while (0)

Definition at line 179 of file utils.h.

#  define DBG(...) \
    do {           \
    } while (0)

◆ DBG_ASSERT

#define DBG_ASSERT ( x )

Value:

do {                \
  (void)sizeof(x);  \
} while (0)

Definition at line 185 of file utils.h.

#  define DBG_ASSERT(x) \
    do {                \
      (void)sizeof(x);  \
    } while (0)

◆ DBG_HEX

#define DBG_HEX ( ... )

Value:

do { \

} while (0)

Definition at line 182 of file utils.h.

#  define DBG_HEX(...) \
    do {               \
    } while (0)

◆ MAX_POW2_EXP_FOR_UNSIGNED

#define MAX_POW2_EXP_FOR_UNSIGNED ( T )

Value:

(TYPE_BITS(T) - 1)

TYPE_BITS

#define TYPE_BITS(T)

Definition utils.h:319

Definition at line 320 of file utils.h.

◆ PANIC

#define PANIC ( msg )

Value:

srn_panic(msg, __FILE__, __LINE__, __func__)

srn_panic

void srn_panic(const char *msg, const char *file, size_t line, const char *fn)

TODO(lxsameer): unwind the stack.

Definition utils.c:31

Definition at line 53 of file utils.h.

◆ PANIC_IF

#define PANIC_IF	(		cond,
			msg )

Value:

do {                      \
  if (cond) {             \
    PANIC(msg);           \
  }                       \
} while (0)

Definition at line 59 of file utils.h.

#define PANIC_IF(cond, msg) \
  do {                      \
    if (cond) {             \
      PANIC(msg);           \
    }                       \
  } while (0)

◆ PANIC_IF_NULL

#define PANIC_IF_NULL ( ptr )

Value:

PANIC_IF((ptr) == nullptr, "Null pointer")

PANIC_IF

#define PANIC_IF(cond, msg)

Definition utils.h:59

Definition at line 66 of file utils.h.

◆ PANIC_ON_ERR

#define PANIC_ON_ERR ( interr )

Value:

if ((interr) < 0) {        \
  SHOULD_NOT_HAPPEN;       \
}

Definition at line 84 of file utils.h.

#define PANIC_ON_ERR(interr) \
  if ((interr) < 0) {        \
    SHOULD_NOT_HAPPEN;       \
  }

◆ PANIC_WITH_CTX

#define PANIC_WITH_CTX	(		ctx,
			msg )

Value:

srn_context_release(ctx); \

PANIC(msg)

srn_context_release

int srn_context_release(srn_context_t *ctx)

Definition context.c:64

Definition at line 55 of file utils.h.

#define PANIC_WITH_CTX(ctx, msg) \
  srn_context_release(ctx);      \
  PANIC(msg)

◆ RETURN_IF_NULL

#define RETURN_IF_NULL ( ptr )

Value:

if ((ptr) == nullptr) {   \
  return;                 \
}

Definition at line 67 of file utils.h.

#define RETURN_IF_NULL(ptr) \
  if ((ptr) == nullptr) {   \
    return;                 \
  }

◆ SERENE_DEBUG

#define SERENE_DEBUG 0

Definition at line 32 of file utils.h.

◆ SHOULD_NOT_HAPPEN

#define SHOULD_NOT_HAPPEN PANIC("This should not happen")

Definition at line 83 of file utils.h.

◆ SNPRINTF

#define SNPRINTF	(	buf,
		s,
		f,
		... )

Value:

do {                                                          \
  int i = snprintf(buf, (s) + 1, f, __VA_ARGS__);             \
  if (i < 0) {                                                \
    PANIC("[snprintf] A negative return value");              \
  }                                                           \
  if (i >= (int)(s)) {                                        \
    PANIC("[snprintf] Written bytes are more than expected"); \
  }                                                           \
} while (0)

Definition at line 72 of file utils.h.

#define SNPRINTF(buf, s, f, ...)                                \
  do {                                                          \
    int i = snprintf(buf, (s) + 1, f, __VA_ARGS__);             \
    if (i < 0) {                                                \
      PANIC("[snprintf] A negative return value");              \
    }                                                           \
    if (i >= (int)(s)) {                                        \
      PANIC("[snprintf] Written bytes are more than expected"); \
    }                                                           \
  } while (0)

◆ SRN_ATTR_COLD

#define SRN_ATTR_COLD

Definition at line 109 of file utils.h.

◆ SRN_ATTR_FMT

#define SRN_ATTR_FMT	(		a,
			b )

Definition at line 110 of file utils.h.

◆ SRN_NS_PER_MS

#define SRN_NS_PER_MS 1000000ULL

nanoseconds in one millisecond

Definition at line 308 of file utils.h.

◆ SRN_NS_PER_SEC

#define SRN_NS_PER_SEC 1000000000ULL

nanoseconds in one second

Definition at line 306 of file utils.h.

◆ TODO

#define TODO ( msg )

Value:

PANIC(msg)

PANIC

#define PANIC(msg)

Definition utils.h:53

Definition at line 54 of file utils.h.

◆ TYPE_BITS

#define TYPE_BITS ( T )

Value:

(sizeof(T) * CHAR_BIT)

Definition at line 319 of file utils.h.

◆ UNUSED

#define UNUSED ( x )

Value:

(void)(x)

Definition at line 45 of file utils.h.

Typedef Documentation

◆ srn_spinlock_t

typedef struct srn_spinlock_t srn_spinlock_t

Function Documentation

◆ cpu_relax()

void cpu_relax ( void )

inlinestatic

A portable way to use pasue instructions.

The long list of preprocessors is there thanks to: https://github.com/goodcleanfun/cpu_relax

Definition at line 223 of file utils.h.

                                   {
#if defined(_M_IX86) || defined(__I86__) || defined(i686) || defined(__i686) ||                    \
  defined(__i686__) || defined(i586) || defined(__i586) || defined(__i586__) || defined(i486) ||   \
  defined(__i486) || defined(__i486__) || defined(i386) || defined(__i386) || defined(__i386__) || \
  defined(_X86_) || defined(__X86__) || defined(__THW_INTEL__)
#  if defined(__SSE2__)
  _mm_pause();
#  elif defined(_MSC_VER)
  __asm pause;
#  else
  __asm__ __volatile__("pause");
#  endif
#elif defined(__amd64__) || defined(__amd64) || defined(__x86_64__) || defined(__x86_64) || \
  defined(_M_X64) || defined(_M_AMD64)
#  if defined(__SSE2__)
  _mm_pause();
#  endif
#elif defined(__aarch64__) || defined(_M_ARM64)
#  if defined(_MSC_VER)
  __isb(_ARM64_BARRIER_SY);
#  else
  __asm__ __volatile__("isb\n");
#  endif
#elif defined(__ARM_ARCH) || defined(_M_ARM) || defined(__arm__) || defined(__thumb__) || \
  defined(__TARGET_ARCH_ARM) || defined(_ARM)
#  if defined(_MSC_VER)
  __yield();
#  else
  __asm__ __volatile__("yield");
#  endif
#elif defined(__powerpc) || defined(__powerpc__) || defined(__POWERPC__) || defined(__ppc__) || \
  defined(__PPC__) || defined(_ARCH_PPC) || defined(__ppc)
  __asm__ __volatile__("or 27,27,27" ::: "memory");
#elif defined(__riscv) || defined(__riscv__)
#  if defined(__riscv_pause)
  __builtin_riscv_pause();
#  else
  __asm__ __volatile__("nop");
#  endif
#elif defined(__loongarch32) || defined(__loongarch64)
  __asm__ __volatile__("nop");
#elif defined(__wasm__)
  __asm__ __volatile__("nop");
#endif
}

Here is the caller graph for this function:

◆ srn_copy_bytes()

char * srn_copy_bytes	(	const srn_context_t *	ctx,
		const char *	src,
		size_t	len,
		size_t	alignment )

Definition at line 56 of file utils.c.

                                                                                              {
  PANIC_IF_NULL(ctx);
 
  char *dst = srn_allocate(ctx, len, alignment);
 
  // It will panic earlier anyway.
  if (dst == nullptr) {
    return nullptr;
  }
 
  memcpy(dst, src, len);
  return dst;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ srn_dup_str()

char * srn_dup_str	(	srn_mm_t *	mm,
		const char *	s )

Copy a null terminated C string into a fresh allocation made through mm.

Returns nullptr on allocation failure.

Definition at line 70 of file utils.c.

                                               {
  PANIC_IF_NULL(mm);
  PANIC_IF_NULL(s);
  size_t n   = strlen(s);
  char *copy = srn_mm_malloc(mm, n + 1);
  if (copy == nullptr) {
    return nullptr;
  }
  memcpy(copy, s, n + 1);
  return copy;
}

Here is the call graph for this function:

◆ srn_now_ns()

uint64_t srn_now_ns ( void )

The current time on the monotonic clock, in nanoseconds.

Panics if the clock read fails – CLOCK_MONOTONIC with a valid buffer cannot fail on supported targets, so a failure means something is deeply wrong.

Definition at line 46 of file utils.c.

                          {
  struct timespec ts;
  // CLOCK_MONOTONIC with a valid buffer can only fail EINVAL (clock
  // unsupported) or EFAULT (bad pointer), neither possible here -- so a failure
  // should never happen.
  int rc = clock_gettime(CLOCK_MONOTONIC, &ts);
  PANIC_IF(rc != 0, "clock_gettime(CLOCK_MONOTONIC) failed");
  return ((uint64_t)ts.tv_sec * SRN_NS_PER_SEC) + (uint64_t)ts.tv_nsec;
}

Here is the caller graph for this function:

◆ srn_panic()

void srn_panic	(	const char *	msg,
		const char *	file,
		size_t	line,
		const char *	fn )

TODO(lxsameer): unwind the stack.

Definition at line 31 of file utils.c.

                                                                               {
  (void)fprintf(stderr, "PANIC: %s %s:%zu (%s)\n", msg, file, line, fn);
  (void)fflush(nullptr);
#if SERENE_DEBUG
#  if defined(__has_builtin) && __has_builtin(__builtin_debugtrap)
  __builtin_debugtrap();
#  else
  __builtin_trap(); // gcc: SIGILL into the debugger; no resumable trap
#  endif
  __builtin_unreachable();
#else
  abort();
#endif
}

◆ srn_popcnt32()

uint32_t srn_popcnt32 ( uint32_t x )

inlinestatic

Definition at line 194 of file utils.h.

                                                {
#if defined(__clang__) || defined(__GNUC__)
  return (uint32_t)__builtin_popcount(x);
#else
  x = x - ((x >> 1) & 0x55555555u);
  x = (x & 0x33333333u) + ((x >> 2) & 0x33333333u);
  return (((x + (x >> 4)) & 0x0F0F0F0Fu) * 0x01010101u) >> 24;
#endif
}

Here is the caller graph for this function:

◆ srn_popcnt64()

uint64_t srn_popcnt64 ( uint64_t x )

inlinestatic

Definition at line 204 of file utils.h.

                                                {
#if defined(__GNUC__) || defined(__clang__)
  return (uint64_t)__builtin_popcountll(x);
#else
  unsigned c = 0;
  while (x) {
    x &= x - 1;
    ++c;
  }
  return c;
#endif
}

◆ srn_spinlock_init()

void srn_spinlock_init ( srn_spinlock_t * lock )

inlinestatic

Definition at line 280 of file utils.h.

                                                           {
  lock->flag = (atomic_flag)ATOMIC_FLAG_INIT;
  srn_spinlock_unlock(lock);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ srn_spinlock_lock()

void srn_spinlock_lock ( srn_spinlock_t * lock )

inlinestatic

Definition at line 285 of file utils.h.

                                                           {
  while (atomic_flag_test_and_set_explicit(&lock->flag, memory_order_acquire)) {
    // Keep busy for the lock to get unlocked
    cpu_relax();
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ srn_spinlock_unlock()

void srn_spinlock_unlock ( srn_spinlock_t * lock )

inlinestatic

Definition at line 276 of file utils.h.

                                                             {
  atomic_flag_clear_explicit(&lock->flag, memory_order_release);
}

Here is the caller graph for this function:

Data Structures

Macros

Typedefs

Functions

Macro Definition Documentation

◆ DBG

◆ DBG_ASSERT

◆ DBG_HEX

◆ MAX_POW2_EXP_FOR_UNSIGNED

◆ PANIC

◆ PANIC_IF

◆ PANIC_IF_NULL

◆ PANIC_ON_ERR

◆ PANIC_WITH_CTX

◆ RETURN_IF_NULL

◆ SERENE_DEBUG

◆ SHOULD_NOT_HAPPEN

◆ SNPRINTF

◆ SRN_ATTR_COLD

◆ SRN_ATTR_FMT

◆ SRN_NS_PER_MS

◆ SRN_NS_PER_SEC

◆ TODO

◆ TYPE_BITS

◆ UNUSED

Typedef Documentation

◆ srn_spinlock_t

Function Documentation

◆ cpu_relax()

◆ srn_copy_bytes()

◆ srn_dup_str()

◆ srn_now_ns()

◆ srn_panic()

◆ srn_popcnt32()

◆ srn_popcnt64()

◆ srn_spinlock_init()

◆ srn_spinlock_lock()

◆ srn_spinlock_unlock()