mirror of
https://sourceware.org/git/glibc.git
synced 2024-09-19 16:10:01 +00:00
b34b46b880
C23 adds a header <stdbit.h> with various functions and type-generic
macros for bit-manipulation of unsigned integers (plus macro defines
related to endianness). Implement this header for glibc.
The functions have both inline definitions in the header (referenced
by macros defined in the header) and copies with external linkage in
the library (which are implemented in terms of those macros to avoid
duplication). They are documented in the glibc manual. Tests, as
well as verifying results for various inputs (of both the macros and
the out-of-line functions), verify the types of those results (which
showed up a bug in an earlier version with the type-generic macro
stdc_has_single_bit wrongly returning a promoted type), that the
macros can be used at top level in a source file (so don't use ({})),
that they evaluate their arguments exactly once, and that the macros
for the type-specific functions have the expected implicit conversions
to the relevant argument type.
Jakub previously referred to -Wconversion warnings in type-generic
macros, so I've included a test with -Wconversion (but the only
warnings I saw and fixed from that test were actually in inline
functions in the <stdbit.h> header - not anything coming from use of
the type-generic macros themselves).
This implementation of the type-generic macros does not handle
unsigned __int128, or unsigned _BitInt types with a width other than
that of a standard integer type (and C23 doesn't require the header to
handle such types either). Support for those types, using the new
type-generic built-in functions Jakub's added for GCC 14, can
reasonably be added in a followup (along of course with associated
tests).
This implementation doesn't do anything special to handle C++, or have
any tests of functionality in C++ beyond the existing tests that all
headers can be compiled in C++ code; it's not clear exactly what form
this header should take in C++, but probably not one using macros.
DIS ballot comment AT-107 asks for the word "count" to be added to the
names of the stdc_leading_zeros, stdc_leading_ones,
stdc_trailing_zeros and stdc_trailing_ones functions and macros. I
don't think it's likely to be accepted (accepting any technical
comments would mean having an FDIS ballot), but if it is accepted at
the WG14 meeting (22-26 January in Strasbourg, starting with DIS
ballot comment handling) then there would still be time to update
glibc for the renaming before the 2.39 release.
The new functions and header are placed in the stdlib/ directory in
glibc, rather than creating a new toplevel stdbit/ or putting them in
string/ alongside ffs.
Tested for x86_64 and x86.
199 lines
8.0 KiB
C
199 lines
8.0 KiB
C
/* Common test support for <stdbit.h> tests.
|
|
Copyright (C) 2024 Free Software Foundation, Inc.
|
|
This file is part of the GNU C Library.
|
|
|
|
The GNU C Library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2.1 of the License, or (at your option) any later version.
|
|
|
|
The GNU C Library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with the GNU C Library; if not, see
|
|
<https://www.gnu.org/licenses/>. */
|
|
|
|
#ifndef _TST_STDBIT_H
|
|
#define _TST_STDBIT_H
|
|
|
|
#include <stdbit.h>
|
|
#include <stdbool.h>
|
|
|
|
#include <array_length.h>
|
|
#include <support/check.h>
|
|
|
|
struct stdbit_test
|
|
{
|
|
/* The test input. */
|
|
uint64_t x;
|
|
/* Expected results if that test input is converted to 8, 16, 32 or
|
|
64 bits and then passed to the function under test for that
|
|
width. */
|
|
uint64_t res_8, res_16, res_32, res_64;
|
|
};
|
|
|
|
#define TEST_TYPE(EXPR, TYPE) \
|
|
_Static_assert (_Generic ((EXPR), TYPE: 1, default: 0), "bad type")
|
|
|
|
/* Test a <stdbit.h> function / macro. For each function family, and
|
|
each input type, we test both with and without macros from the
|
|
header being used, both with a possibly wider argument being passed
|
|
(that must be truncated by the prototype) and with the argument
|
|
truncated in the caller, as well as testing the type-generic macro
|
|
(with the argument truncated in the caller). Also test that the
|
|
results have the correct type; also test truncation from
|
|
floating-point arguments (valid for functions, including with macro
|
|
expansion, because the prototype must implicitly convert to integer
|
|
type; not valid for the type-generic macros). Also test that the
|
|
argument is evaluated exactly once. Also test the macros are
|
|
usable (e.g. in typeof) at top level (GCC doesn't allow ({})
|
|
outside functions: bug 93239). */
|
|
|
|
#define TEST_STDBIT_T(FUNC, X, RES, TTYPE, TYPE, SUFFIX) \
|
|
do \
|
|
{ \
|
|
TEST_COMPARE (FUNC ## SUFFIX (X), (RES)); \
|
|
TEST_TYPE (FUNC ## SUFFIX (X), TTYPE); \
|
|
TEST_COMPARE ((FUNC ## SUFFIX) (X), (RES)); \
|
|
TEST_TYPE ((FUNC ## SUFFIX) (X), TTYPE); \
|
|
TEST_COMPARE (FUNC ## SUFFIX ((TYPE) (X)), (RES)); \
|
|
TEST_TYPE (FUNC ## SUFFIX ((TYPE) (X)), TTYPE); \
|
|
TEST_COMPARE ((FUNC ## SUFFIX) ((TYPE) (X)), (RES)); \
|
|
TEST_TYPE ((FUNC ## SUFFIX) ((TYPE) (X)), TTYPE); \
|
|
TEST_COMPARE (FUNC ((TYPE) (X)), (RES)); \
|
|
TEST_TYPE (FUNC ((TYPE) (X)), TTYPE); \
|
|
if (sizeof (TYPE) <= 2) \
|
|
{ \
|
|
TEST_COMPARE (FUNC ## SUFFIX ((float) (TYPE) (X)), (RES)); \
|
|
TEST_TYPE (FUNC ## SUFFIX ((float) (TYPE) (X)), TTYPE); \
|
|
TEST_COMPARE ((FUNC ## SUFFIX) ((float) (TYPE) (X)), (RES)); \
|
|
TEST_TYPE ((FUNC ## SUFFIX) ((float) (TYPE) (X)), TTYPE); \
|
|
} \
|
|
if (sizeof (TYPE) <= 4) \
|
|
{ \
|
|
TEST_COMPARE (FUNC ## SUFFIX ((double) (TYPE) (X)), (RES)); \
|
|
TEST_TYPE (FUNC ## SUFFIX ((double) (TYPE) (X)), TTYPE); \
|
|
TEST_COMPARE ((FUNC ## SUFFIX) ((double) (TYPE) (X)), (RES)); \
|
|
TEST_TYPE ((FUNC ## SUFFIX) ((double) (TYPE) (X)), TTYPE); \
|
|
TEST_COMPARE (FUNC ## SUFFIX ((long double) (TYPE) (X)), (RES)); \
|
|
TEST_TYPE (FUNC ## SUFFIX ((long double) (TYPE) (X)), TTYPE); \
|
|
TEST_COMPARE ((FUNC ## SUFFIX) ((long double) (TYPE) (X)), (RES)); \
|
|
TEST_TYPE ((FUNC ## SUFFIX) ((long double) (TYPE) (X)), TTYPE); \
|
|
} \
|
|
TYPE xt = (X); \
|
|
TEST_COMPARE (FUNC ## SUFFIX (xt++), (RES)); \
|
|
TEST_COMPARE (xt, (TYPE) ((X) + 1)); \
|
|
xt = (X); \
|
|
TEST_COMPARE (FUNC (xt++), (RES)); \
|
|
TEST_COMPARE (xt, (TYPE) ((X) + 1)); \
|
|
} \
|
|
while (0)
|
|
|
|
#define TEST_STDBIT_UI(FUNC, INPUTS) \
|
|
do \
|
|
for (int i = 0; i < array_length (INPUTS); i++) \
|
|
{ \
|
|
uint64_t x = (INPUTS)[i].x; \
|
|
unsigned int res_8 = (INPUTS)[i].res_8; \
|
|
unsigned int res_16 = (INPUTS)[i].res_16; \
|
|
unsigned int res_32 = (INPUTS)[i].res_32; \
|
|
unsigned int res_64 = (INPUTS)[i].res_64; \
|
|
unsigned int res_l = (sizeof (long int) == 4 \
|
|
? res_32 : res_64); \
|
|
TEST_STDBIT_T (FUNC, x, res_8, unsigned int, \
|
|
unsigned char, _uc); \
|
|
TEST_STDBIT_T (FUNC, x, res_16, unsigned int, \
|
|
unsigned short, _us); \
|
|
TEST_STDBIT_T (FUNC, x, res_32, unsigned int, \
|
|
unsigned int, _ui); \
|
|
TEST_STDBIT_T (FUNC, x, res_l, unsigned int, \
|
|
unsigned long int, _ul); \
|
|
TEST_STDBIT_T (FUNC, x, res_64, unsigned int, \
|
|
unsigned long long int, _ull); \
|
|
} \
|
|
while (0)
|
|
|
|
#define TEST_STDBIT_BOOL(FUNC, INPUTS) \
|
|
do \
|
|
for (int i = 0; i < array_length (INPUTS); i++) \
|
|
{ \
|
|
uint64_t x = (INPUTS)[i].x; \
|
|
bool res_8 = (INPUTS)[i].res_8; \
|
|
bool res_16 = (INPUTS)[i].res_16; \
|
|
bool res_32 = (INPUTS)[i].res_32; \
|
|
bool res_64 = (INPUTS)[i].res_64; \
|
|
bool res_l = (sizeof (long int) == 4 ? res_32 : res_64); \
|
|
TEST_STDBIT_T (FUNC, x, res_8, _Bool, unsigned char, _uc); \
|
|
TEST_STDBIT_T (FUNC, x, res_16, _Bool, unsigned short, _us); \
|
|
TEST_STDBIT_T (FUNC, x, res_32, _Bool, unsigned int, _ui); \
|
|
TEST_STDBIT_T (FUNC, x, res_l, _Bool, unsigned long int, _ul); \
|
|
TEST_STDBIT_T (FUNC, x, res_64, _Bool, \
|
|
unsigned long long int, _ull); \
|
|
} \
|
|
while (0)
|
|
|
|
#define TEST_STDBIT_SAME(FUNC, INPUTS) \
|
|
do \
|
|
for (int i = 0; i < array_length (INPUTS); i++) \
|
|
{ \
|
|
uint64_t x = (INPUTS)[i].x; \
|
|
unsigned char res_8 = (INPUTS)[i].res_8; \
|
|
unsigned short res_16 = (INPUTS)[i].res_16; \
|
|
unsigned int res_32 = (INPUTS)[i].res_32; \
|
|
unsigned long long int res_64 = (INPUTS)[i].res_64; \
|
|
unsigned long int res_l = (sizeof (long int) == 4 \
|
|
? res_32 : res_64); \
|
|
TEST_STDBIT_T (FUNC, x, res_8, unsigned char, \
|
|
unsigned char, _uc); \
|
|
TEST_STDBIT_T (FUNC, x, res_16, unsigned short, \
|
|
unsigned short, _us); \
|
|
TEST_STDBIT_T (FUNC, x, res_32, unsigned int, \
|
|
unsigned int, _ui); \
|
|
TEST_STDBIT_T (FUNC, x, res_l, unsigned long int, \
|
|
unsigned long int, _ul); \
|
|
TEST_STDBIT_T (FUNC, x, res_64, unsigned long long int, \
|
|
unsigned long long int, _ull); \
|
|
} \
|
|
while (0)
|
|
|
|
#define TEST_STDBIT_UI_TOPLEVEL(FUNC) \
|
|
TEST_TYPE (FUNC ## _uc ((unsigned char) 0), unsigned int); \
|
|
TEST_TYPE (FUNC ((unsigned char) 0), unsigned int); \
|
|
TEST_TYPE (FUNC ## _us ((unsigned short) 0), unsigned int); \
|
|
TEST_TYPE (FUNC ((unsigned short) 0), unsigned int); \
|
|
TEST_TYPE (FUNC ## _ui (0U), unsigned int); \
|
|
TEST_TYPE (FUNC (0U), unsigned int); \
|
|
TEST_TYPE (FUNC ## _ul (0UL), unsigned int); \
|
|
TEST_TYPE (FUNC (0UL), unsigned int); \
|
|
TEST_TYPE (FUNC ## _ull (0ULL), unsigned int); \
|
|
TEST_TYPE (FUNC (0ULL), unsigned int)
|
|
|
|
#define TEST_STDBIT_BOOL_TOPLEVEL(FUNC) \
|
|
TEST_TYPE (FUNC ## _uc ((unsigned char) 0), _Bool); \
|
|
TEST_TYPE (FUNC ((unsigned char) 0), _Bool); \
|
|
TEST_TYPE (FUNC ## _us ((unsigned short) 0), _Bool); \
|
|
TEST_TYPE (FUNC ((unsigned short) 0), _Bool); \
|
|
TEST_TYPE (FUNC ## _ui (0U), _Bool); \
|
|
TEST_TYPE (FUNC (0U), _Bool); \
|
|
TEST_TYPE (FUNC ## _ul (0UL), _Bool); \
|
|
TEST_TYPE (FUNC (0UL), _Bool); \
|
|
TEST_TYPE (FUNC ## _ull (0ULL), _Bool); \
|
|
TEST_TYPE (FUNC (0ULL), _Bool)
|
|
|
|
#define TEST_STDBIT_SAME_TOPLEVEL(FUNC) \
|
|
TEST_TYPE (FUNC ## _uc ((unsigned char) 0), unsigned char); \
|
|
TEST_TYPE (FUNC ((unsigned char) 0), unsigned char); \
|
|
TEST_TYPE (FUNC ## _us ((unsigned short) 0), unsigned short); \
|
|
TEST_TYPE (FUNC ((unsigned short) 0), unsigned short); \
|
|
TEST_TYPE (FUNC ## _ui (0U), unsigned int); \
|
|
TEST_TYPE (FUNC (0U), unsigned int); \
|
|
TEST_TYPE (FUNC ## _ul (0UL), unsigned long int); \
|
|
TEST_TYPE (FUNC (0UL), unsigned long int); \
|
|
TEST_TYPE (FUNC ## _ull (0ULL), unsigned long long int); \
|
|
TEST_TYPE (FUNC (0ULL), unsigned long long int)
|
|
|
|
#endif
|