libmetal
Loading...
Searching...
No Matches
Simple Utilities

Macros

#define MB   (1024UL << 10UL)
 
#define GB   (MB << 10UL)
 
#define metal_unused(x)   do { (x) = (x); } while (0)
 
#define metal_dim(x)   (sizeof(x) / sizeof(x[0]))
 
#define metal_min(x, y)   ((x) < (y) ? (x) : (y))
 
#define metal_max(x, y)   ((x) > (y) ? (x) : (y))
 
#define metal_sign(x)   ((x) < 0 ? -1 : ((x) > 0 ? 1 : 0))
 
#define metal_align_down(size, align)    ((size) & ~((align) - 1))
 
#define metal_align_up(size, align)    metal_align_down((size) + (align) - 1, align)
 
#define metal_div_round_down(num, den)    ((num) / (den))
 
#define metal_div_round_up(num, den)    metal_div_round_down((num) + (den) - 1, (den))
 
#define metal_ptr_align_down(ptr, align)    (void *)(metal_align_down((uintptr_t)(ptr), (uintptr_t)(align)))
 
#define metal_ptr_align_up(ptr, align)    (void *)(metal_align_up((uintptr_t)(ptr), (uintptr_t)(align)))
 
#define metal_offset_of(structure, member)    ((uintptr_t)&(((structure *)0)->member))
 
#define metal_container_of(ptr, structure, member)    (void *)((uintptr_t)(ptr) - metal_offset_of(structure, member))
 
#define METAL_BITS_PER_ULONG   (CHAR_BIT * sizeof(unsigned long))
 
#define metal_bit(bit)   (1UL << (bit))
 
#define metal_bitmap_longs(x)   metal_div_round_up((x), METAL_BITS_PER_ULONG)
 
#define metal_bitmap_for_each_set_bit(bitmap, bit, max)
 
#define metal_bitmap_for_each_clear_bit(bitmap, bit, max)
 

Functions

static void metal_bitmap_set_bit (unsigned long *bitmap, int bit)
 
static int metal_bitmap_is_bit_set (unsigned long *bitmap, int bit)
 
static void metal_bitmap_clear_bit (unsigned long *bitmap, int bit)
 
static int metal_bitmap_is_bit_clear (unsigned long *bitmap, int bit)
 
static unsigned int metal_bitmap_next_set_bit (unsigned long *bitmap, unsigned int start, unsigned int max)
 
static unsigned int metal_bitmap_next_clear_bit (unsigned long *bitmap, unsigned int start, unsigned int max)
 
static unsigned long metal_log2 (unsigned long in)
 

Detailed Description

Macro Definition Documentation

◆ GB

#define GB   (MB << 10UL)

◆ MB

#define MB   (1024UL << 10UL)

◆ metal_align_down

#define metal_align_down ( size,
align )    ((size) & ~((align) - 1))

Align 'size' down to a multiple of 'align' (must be a power of two).

◆ metal_align_up

#define metal_align_up ( size,
align )    metal_align_down((size) + (align) - 1, align)

Align 'size' up to a multiple of 'align' (must be a power of two).

◆ metal_bit

#define metal_bit ( bit)    (1UL << (bit))

◆ metal_bitmap_for_each_clear_bit

#define metal_bitmap_for_each_clear_bit ( bitmap,
bit,
max )
Value:
for ((bit) = metal_bitmap_next_clear_bit((bitmap), 0, (max)); \
(bit) < (max); \
(bit) = metal_bitmap_next_clear_bit((bitmap), (bit + 1), (max)))
static unsigned int metal_bitmap_next_clear_bit(unsigned long *bitmap, unsigned int start, unsigned int max)
Definition utilities.h:131

◆ metal_bitmap_for_each_set_bit

#define metal_bitmap_for_each_set_bit ( bitmap,
bit,
max )
Value:
for ((bit) = metal_bitmap_next_set_bit((bitmap), 0, (max)); \
(bit) < (max); \
(bit) = metal_bitmap_next_set_bit((bitmap), (bit + 1), (max)))
static unsigned int metal_bitmap_next_set_bit(unsigned long *bitmap, unsigned int start, unsigned int max)
Definition utilities.h:113

◆ metal_bitmap_longs

#define metal_bitmap_longs ( x)    metal_div_round_up((x), METAL_BITS_PER_ULONG)

◆ METAL_BITS_PER_ULONG

#define METAL_BITS_PER_ULONG   (CHAR_BIT * sizeof(unsigned long))

◆ metal_container_of

#define metal_container_of ( ptr,
structure,
member )    (void *)((uintptr_t)(ptr) - metal_offset_of(structure, member))

Compute pointer to a structure given a pointer to one of its fields.

◆ metal_dim

#define metal_dim ( x)    (sizeof(x) / sizeof(x[0]))

Figure out number of elements in an array.

◆ metal_div_round_down

#define metal_div_round_down ( num,
den )    ((num) / (den))

Divide (and round down).

◆ metal_div_round_up

#define metal_div_round_up ( num,
den )    metal_div_round_down((num) + (den) - 1, (den))

Divide (and round up).

◆ metal_max

#define metal_max ( x,
y )   ((x) > (y) ? (x) : (y))

Maximum of two numbers (warning: multiple evaluation!).

◆ metal_min

#define metal_min ( x,
y )   ((x) < (y) ? (x) : (y))

Minimum of two numbers (warning: multiple evaluation!).

◆ metal_offset_of

#define metal_offset_of ( structure,
member )    ((uintptr_t)&(((structure *)0)->member))

Compute offset of a field within a structure.

◆ metal_ptr_align_down

#define metal_ptr_align_down ( ptr,
align )    (void *)(metal_align_down((uintptr_t)(ptr), (uintptr_t)(align)))

Align 'ptr' down to a multiple of 'align' (must be a power of two).

◆ metal_ptr_align_up

#define metal_ptr_align_up ( ptr,
align )    (void *)(metal_align_up((uintptr_t)(ptr), (uintptr_t)(align)))

Align 'ptr' up to a multiple of 'align' (must be a power of two).

◆ metal_sign

#define metal_sign ( x)    ((x) < 0 ? -1 : ((x) > 0 ? 1 : 0))

Sign of a number [-1, 0, or 1] (warning: multiple evaluation!).

◆ metal_unused

#define metal_unused ( x)    do { (x) = (x); } while (0)

Marker for unused function arguments/variables.

Function Documentation

◆ metal_bitmap_clear_bit()

static void metal_bitmap_clear_bit ( unsigned long * bitmap,
int bit )
inlinestatic

◆ metal_bitmap_is_bit_clear()

static int metal_bitmap_is_bit_clear ( unsigned long * bitmap,
int bit )
inlinestatic

◆ metal_bitmap_is_bit_set()

static int metal_bitmap_is_bit_set ( unsigned long * bitmap,
int bit )
inlinestatic

◆ metal_bitmap_next_clear_bit()

static unsigned int metal_bitmap_next_clear_bit ( unsigned long * bitmap,
unsigned int start,
unsigned int max )
inlinestatic

◆ metal_bitmap_next_set_bit()

static unsigned int metal_bitmap_next_set_bit ( unsigned long * bitmap,
unsigned int start,
unsigned int max )
inlinestatic

◆ metal_bitmap_set_bit()

static void metal_bitmap_set_bit ( unsigned long * bitmap,
int bit )
inlinestatic

◆ metal_log2()

static unsigned long metal_log2 ( unsigned long in)
inlinestatic