inc/hf/arch/std.h

/*
 * Copyright 2018 The Hafnium Authors.
 *
 * Use of this source code is governed by a BSD-style
 * license that can be found in the LICENSE file or at
 * https://opensource.org/licenses/BSD-3-Clause.
 */

#pragma once

#include <stddef.h>
#include <stdint.h>

#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))

/* NOLINTNEXTLINE(readability-redundant-declaration) */
int memcmp(const void *a, const void *b, size_t n);

/* NOLINTNEXTLINE(readability-redundant-declaration) */
int strncmp(const char *a, const char *b, size_t n);

#define ctz(x) __builtin_ctz(x)

/**
 * Check whether the value `v` is aligned to the boundary `a`,
 * with `a` power of 2.
 */
#define is_aligned(v, a) __builtin_is_aligned((v), (a))

/**
 * Align up the value `v` to the boundary `a`, with `a` power of 2.
 */
#define align_up(v, a) __builtin_align_up((v), (a))

/**
 * Align down the value `v` to the boundary `a`, with `a` power of 2.
 */
#define align_down(v, a) __builtin_align_down((v), (a))

/*
 * Calculate the sum `a + b` and write the result to `*res`.
 * Returns whether the operation overflowed.
 */
#define add_overflow(a, b, res) __builtin_add_overflow((a), (b), (res))

/*
 * Calculate product `a * b` and write the result to `*res`.
 * Returns whether the operation overflowed.
 */
#define mul_overflow(a, b, res) __builtin_mul_overflow((a), (b), (res))

/*
 * Round up a value to align with a given size and
 * check whether overflow happens.
 * The rounded value is '*res', return false on success and true on overflow.
 */
#define align_up_overflow(v, size, res)         \
	__extension__({                         \
		typeof(v) __v = (v);            \
		typeof(size) __size = (size);   \
		typeof(res) __res = (res);      \
		*__res = align_up(__v, __size); \
		__v > *__res;                   \
	})

/*
 * Add a with b, then round up the result to align with a given size and
 * check whether overflow happens.
 * The rounded value is '*res', return false on success and true on overflow.
 */
#define add_with_round_up_overflow(a, b, size, res)                  \
	(__extension__({                                             \
		typeof(a) __add_res = 0;                             \
		add_overflow((a), (b), &__add_res) ||                \
			align_up_overflow(__add_res, (size), (res)); \
	}))

#ifndef be16toh
#if __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__

#define be16toh(v) __builtin_bswap16(v)
#define be32toh(v) __builtin_bswap32(v)
#define be64toh(v) __builtin_bswap64(v)

#define htobe16(v) __builtin_bswap16(v)
#define htobe32(v) __builtin_bswap32(v)
#define htobe64(v) __builtin_bswap64(v)

#define le16toh(v) (v)
#define le32toh(v) (v)
#define le64toh(v) (v)

#define htole16(v) (v)
#define htole32(v) (v)
#define htole64(v) (v)

#elif __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__

#define be16toh(v) (v)
#define be32toh(v) (v)
#define be64toh(v) (v)

#define htobe16(v) (v)
#define htobe32(v) (v)
#define htobe64(v) (v)

#define le16toh(v) __builtin_bswap16(v)
#define le32toh(v) __builtin_bswap32(v)
#define le64toh(v) __builtin_bswap64(v)

#define htole16(v) __builtin_bswap16(v)
#define htole32(v) __builtin_bswap32(v)
#define htole64(v) __builtin_bswap64(v)

#else

/*
 * __BYTE_ORDER__ != __ORDER_LITTLE_ENDIAN__ &&
 * __BYTE_ORDER__ != __ORDER_BIG_ENDIAN__
 */

#error "Unsupported byte order"

#endif
#endif