libmetal
Loading...
Searching...
No Matches
utilities.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2015, Xilinx Inc. and Contributors. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7/*
8 * @file utilities.h
9 * @brief Utility routines for libmetal.
10 */
11
12#ifndef __METAL_UTILITIES__H__
13#define __METAL_UTILITIES__H__
14
15#include <stdint.h>
16#include <limits.h>
17#include <metal/assert.h>
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
28#define metal_unused(x) do { (x) = (x); } while (0)
29
31#define metal_dim(x) (sizeof(x) / sizeof(x[0]))
32
34#define metal_min(x, y) ((x) < (y) ? (x) : (y))
35
37#define metal_max(x, y) ((x) > (y) ? (x) : (y))
38
40#define metal_sign(x) ((x) < 0 ? -1 : ((x) > 0 ? 1 : 0))
41
43#define metal_align_down(size, align) \
44 ((size) & ~((align) - 1))
45
47#define metal_align_up(size, align) \
48 metal_align_down((size) + (align) - 1, align)
49
51#define metal_div_round_down(num, den) \
52 ((num) / (den))
53
55#define metal_div_round_up(num, den) \
56 metal_div_round_down((num) + (den) - 1, (den))
57
59#define metal_ptr_align_down(ptr, align) \
60 (void *)(metal_align_down((uintptr_t)(ptr), (uintptr_t)(align)))
61
63#define metal_ptr_align_up(ptr, align) \
64 (void *)(metal_align_up((uintptr_t)(ptr), (uintptr_t)(align)))
65
67#define metal_offset_of(structure, member) \
68 ((uintptr_t)&(((structure *)0)->member))
69
71#define metal_container_of(ptr, structure, member) \
72 (void *)((uintptr_t)(ptr) - metal_offset_of(structure, member))
73
74#define METAL_BITS_PER_ULONG (CHAR_BIT * sizeof(unsigned long))
75
76#define metal_bit(bit) (1UL << (bit))
77
78#define metal_bitmap_longs(x) metal_div_round_up((x), METAL_BITS_PER_ULONG)
79
80static inline void metal_bitmap_set_bit(unsigned long *bitmap, int bit)
81{
82 bitmap[bit / METAL_BITS_PER_ULONG] |=
84}
85
86static inline int metal_bitmap_is_bit_set(unsigned long *bitmap, int bit)
87{
88 return ((bitmap[bit / METAL_BITS_PER_ULONG] &
89 metal_bit(bit & (METAL_BITS_PER_ULONG - 1))) == 0) ? 0 : 1;
90}
91
92static inline void metal_bitmap_clear_bit(unsigned long *bitmap, int bit)
93{
94 bitmap[bit / METAL_BITS_PER_ULONG] &=
95 ~metal_bit(bit & (METAL_BITS_PER_ULONG - 1));
96}
97
98static inline int metal_bitmap_is_bit_clear(unsigned long *bitmap, int bit)
99{
100 return !metal_bitmap_is_bit_set(bitmap, bit);
101}
102
103static inline unsigned int
104metal_bitmap_next_set_bit(unsigned long *bitmap, unsigned int start,
105 unsigned int max)
106{
107 unsigned int bit;
108
109 for (bit = start;
110 bit < max && !metal_bitmap_is_bit_set(bitmap, bit);
111 bit++)
112 ;
113 return bit;
114}
115
116#define metal_bitmap_for_each_set_bit(bitmap, bit, max) \
117 for ((bit) = metal_bitmap_next_set_bit((bitmap), 0, (max)); \
118 (bit) < (max); \
119 (bit) = metal_bitmap_next_set_bit((bitmap), (bit + 1), (max)))
120
121static inline unsigned int
122metal_bitmap_next_clear_bit(unsigned long *bitmap, unsigned int start,
123 unsigned int max)
124{
125 unsigned int bit;
126
127 for (bit = start;
128 bit < max && !metal_bitmap_is_bit_clear(bitmap, bit);
129 bit++)
130 ;
131 return bit;
132}
133
134#define metal_bitmap_for_each_clear_bit(bitmap, bit, max) \
135 for ((bit) = metal_bitmap_next_clear_bit((bitmap), 0, (max)); \
136 (bit) < (max); \
137 (bit) = metal_bitmap_next_clear_bit((bitmap), (bit + 1), (max)))
138
139static inline unsigned long metal_log2(unsigned long in)
140{
141 unsigned long result;
142
143 metal_assert((in & (in - 1)) == 0);
144
145 for (result = 0; (1UL << result) < in; result++)
146 ;
147 return result;
148}
149
152#ifdef __cplusplus
153}
154#endif
155
156#endif /* __METAL_UTILITIES__H__ */
#define metal_assert(cond)
Assertion macro.
Definition assert.h:21
#define METAL_BITS_PER_ULONG
Definition utilities.h:74
static unsigned long metal_log2(unsigned long in)
Definition utilities.h:139
static void metal_bitmap_set_bit(unsigned long *bitmap, int bit)
Definition utilities.h:80
#define metal_bit(bit)
Definition utilities.h:76
static int metal_bitmap_is_bit_set(unsigned long *bitmap, int bit)
Definition utilities.h:86
static void metal_bitmap_clear_bit(unsigned long *bitmap, int bit)
Definition utilities.h:92
static unsigned int metal_bitmap_next_set_bit(unsigned long *bitmap, unsigned int start, unsigned int max)
Definition utilities.h:104
static unsigned int metal_bitmap_next_clear_bit(unsigned long *bitmap, unsigned int start, unsigned int max)
Definition utilities.h:122
static int metal_bitmap_is_bit_clear(unsigned long *bitmap, int bit)
Definition utilities.h:98