numam-spdk/include/spdk/util.h
Ben Walker de03082191 util: Generate multiple versions of spdk_u32log2
Generate multiple versions for various architectures automatically.

Fixes issue #713

Change-Id: I757a1d05e54c938b66dd5b2ec255ad960bb89945
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/463550
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Changpeng Liu <changpeng.liu@intel.com>
2019-08-15 20:33:20 +00:00

128 lines
3.6 KiB
C

/*-
* BSD LICENSE
*
* Copyright (c) Intel Corporation. All rights reserved.
* Copyright (c) 2019 Mellanox Technologies LTD. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/** \file
* General utility functions
*/
#ifndef SPDK_UTIL_H
#define SPDK_UTIL_H
#include "spdk/stdinc.h"
#ifdef __cplusplus
extern "C" {
#endif
#define spdk_min(a,b) (((a)<(b))?(a):(b))
#define spdk_max(a,b) (((a)>(b))?(a):(b))
#define SPDK_COUNTOF(arr) (sizeof(arr) / sizeof((arr)[0]))
#define SPDK_CONTAINEROF(ptr, type, member) ((type *)((uintptr_t)ptr - offsetof(type, member)))
#define SPDK_SEC_TO_USEC 1000000ULL
#define SPDK_SEC_TO_NSEC 1000000000ULL
/* Ceiling division of unsigned integers */
#define SPDK_CEIL_DIV(x,y) (((x)+(y)-1)/(y))
/* The following will automatically generate several version of
* this function, targeted at different architectures. This
* is only supported by GCC 6 or newer. */
#if defined(__GNUC__) && __GNUC__ >= 6 && !defined(__clang__)
__attribute__((target_clones("bmi", "arch=core2", "arch=atom", "default")))
#endif
static inline uint32_t
spdk_u32log2(uint32_t x)
{
if (x == 0) {
/* log(0) is undefined */
return 0;
}
return 31u - __builtin_clz(x);
}
static inline uint32_t
spdk_align32pow2(uint32_t x)
{
return 1u << (1 + spdk_u32log2(x - 1));
}
/* The following will automatically generate several version of
* this function, targeted at different architectures. This
* is only supported by GCC 6 or newer. */
#if defined(__GNUC__) && __GNUC__ >= 6 && !defined(__clang__)
__attribute__((target_clones("bmi", "arch=core2", "arch=atom", "default")))
#endif
static inline uint64_t
spdk_u64log2(uint64_t x)
{
if (x == 0) {
/* log(0) is undefined */
return 0;
}
return 63u - __builtin_clzl(x);
}
static inline uint64_t
spdk_align64pow2(uint64_t x)
{
return 1u << (1 + spdk_u64log2(x - 1));
}
/**
* Check if a uint32_t is a power of 2.
*/
static inline bool
spdk_u32_is_pow2(uint32_t x)
{
if (x == 0) {
return false;
}
return (x & (x - 1)) == 0;
}
static inline uint64_t
spdk_divide_round_up(uint64_t num, uint64_t divisor)
{
return (num + divisor - 1) / divisor;
}
#ifdef __cplusplus
}
#endif
#endif