Page MenuHomeFreeBSD
Differential D40729

lib/libc/tests/string: add unit tests for ffs, ffsl, ffsll, fls, flsl, and flsll
ClosedPublic
Actions

Authored by fuz on Jun 23 2023, 9:45 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Apr 19, 3:25 PM
Unknown Object (File)
Sat, Apr 19, 2:29 AM
Unknown Object (File)
Mon, Apr 14, 1:55 AM
Unknown Object (File)
Wed, Apr 9, 8:35 AM
Unknown Object (File)
Mar 11 2025, 1:08 AM
Unknown Object (File)
Jan 26 2025, 11:40 PM
Unknown Object (File)
Nov 15 2024, 10:42 AM
Unknown Object (File)
Nov 15 2024, 9:04 AM
View All 49 Files
Subscribers
imp
jrm
kevans

Details

Reviewers
mjg
kevans
ngie
Commits
rG65b618794f68: lib/libc/tests/string: add unit tests for ffs, ffsl, ffsll, fls, flsl, and flsll
rG49390697b926: lib/libc/tests/string: add unit tests for ffs, ffsl, ffsll, fls, flsl, and flsll
Summary

Add atf unit tests for ffs, ffsl, ffsll, fls, flsl, flsll.
These unit tests will be used for an upcoming DR.

Also supply CFLAGS+=-fno-builtin to ensure our unit tests
actually test libc functions and not clang's builtins.

Sponsored by: FreeBSD Foundation

Test Plan

Unit tests pass with current implementations of
these functions. This DR is the test plan for an upcoming DR.

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 52263
Build 49154: arc lint + arc unit

Event Timeline

fuz created this revision.Jun 23 2023, 9:45 PM
Herald added a subscriber: imp. · View Herald TranscriptJun 23 2023, 9:45 PM
fuz requested review of this revision.Jun 23 2023, 9:45 PM
Harbormaster completed remote builds in B52263: Diff 123693.Jun 23 2023, 9:45 PM
fuz mentioned this in D40730: lib/libc/string: replace ffs/fls implementations with clang builtins.Jun 23 2023, 9:47 PM
kevans accepted this revision.Jun 28 2023, 7:47 PM
kevans added a reviewer: ngie.
kevans added a subscriber: kevans.

This seems to LGTM, let's perhaps pull in ngie for another sanity check. I think templating ffs_test and fls_test like this is a fine approach.

This revision is now accepted and ready to land.Jun 28 2023, 7:47 PM
ngie added a comment.Jun 28 2023, 8:08 PM

Are these testcases already implemented in the libm tests?

ngie added inline comments.Jun 28 2023, 8:41 PM
lib/libc/tests/string/flsll_test.c
28–30

Why don't you just modify the CFLAGS to define these things at build time instead of creating a ton of basically boilerplate C files?

fuz added a comment.Jun 28 2023, 10:14 PM

This seems to LGTM, let's perhaps pull in ngie for another sanity check. I think templating ffs_test and fls_test like this is a fine approach.

Thanks. Do I have approval to commit once @ngie approves? If yes, can this be MFC'ed to 13-STABLE?

Are these testcases already implemented in the libm tests?

I am not aware of any such tests.

lib/libc/tests/string/flsll_test.c
28–30

I was copying the design pattern used for string functions. If this is not how I am supposed to write test cases, could you point me at some example I can copy?

mjg added a comment.Jul 2 2023, 10:39 PM

I don't think these should run by default, in fact the overall suite is already taking way too long

can this be made condiitonal, even if installed

Closed by commit rG49390697b926: lib/libc/tests/string: add unit tests for ffs, ffsl, ffsll, fls, flsl, and flsll (authored by fuz). · Explain WhyJul 3 2023, 8:24 PM
This revision was automatically updated to reflect the committed changes.
fuz added a commit: rG49390697b926: lib/libc/tests/string: add unit tests for ffs, ffsl, ffsll, fls, flsl, and flsll.
fuz added a commit: rG65b618794f68: lib/libc/tests/string: add unit tests for ffs, ffsl, ffsll, fls, flsl, and flsll.Jul 21 2023, 8:57 AM
fuz mentioned this in D41855: lib/libc/amd64: back out amd64 SIMD work.Sep 14 2023, 5:56 AM
fuz mentioned this in rG6dff5fb10b5e: lib/libc/amd64: back out amd64 SIMD work.Sep 19 2023, 3:20 AM

Revision Contents
Changeset List

PathSize
lib/
libc/
tests/
string/
9 lines
88 lines
32 lines
32 lines
88 lines
32 lines
32 lines

Diff 123693

View Options

lib/libc/tests/string/Makefile

# $FreeBSD$ # $FreeBSD$
# ensure libc functions are tested, not clang's builtins
CFLAGS+= -fno-builtin
ATF_TESTS_C+= ffs_test
ATF_TESTS_C+= ffsl_test
ATF_TESTS_C+= ffsll_test
ATF_TESTS_C+= fls_test
ATF_TESTS_C+= flsl_test
ATF_TESTS_C+= flsll_test
ATF_TESTS_C+= memcmp_test ATF_TESTS_C+= memcmp_test
ATF_TESTS_C+= memset_s_test ATF_TESTS_C+= memset_s_test
ATF_TESTS_C+= stpncpy_test ATF_TESTS_C+= stpncpy_test
ATF_TESTS_C+= strerror2_test ATF_TESTS_C+= strerror2_test
ATF_TESTS_C+= strverscmp_test ATF_TESTS_C+= strverscmp_test
ATF_TESTS_C+= strxfrm_test ATF_TESTS_C+= strxfrm_test
ATF_TESTS_C+= wcscasecmp_test ATF_TESTS_C+= wcscasecmp_test
ATF_TESTS_C+= wcscoll_test ATF_TESTS_C+= wcscoll_test
Show All 29 Lines
View Options

lib/libc/tests/string/ffs_test.c

  • This file was added.
/*-
* Copyright (c) 2023 The FreeBSD Foundation
*
* This software was developed by Robert Clausecker <fuz@FreeBSD.org>
* under sponsorship from the FreeBSD Foundation.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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
*/
#include <sys/cdefs.h>
#include <atf-c.h>
#include <limits.h>
#include <stdint.h>
#include <strings.h>
#ifndef FFS
# define FFS ffs
# define TYPE int
# define TYPE_MIN INT_MIN
#endif
ATF_TC_WITHOUT_HEAD(zero);
ATF_TC_BODY(zero, tc)
{
ATF_CHECK_EQ((TYPE)0, FFS(0));
}
ATF_TC_WITHOUT_HEAD(twobit);
ATF_TC_BODY(twobit, tc)
{
const TYPE one = 1;
TYPE x;
const int n = sizeof(TYPE) * CHAR_BIT;
int i, j;
for (i = 0; i < n - 1; i++)
for (j = 0; j <= i; j++) {
x = one << i | one << j;
ATF_CHECK_EQ_MSG(j + 1, FFS(x),
"%s(%#jx) == %d != %d", __STRING(FFS), (intmax_t)x, FFS(x), j + 1);
}
}
ATF_TC_WITHOUT_HEAD(twobitneg);
ATF_TC_BODY(twobitneg, tc)
{
const TYPE one = 1;
TYPE x;
const int n = sizeof(TYPE) * CHAR_BIT;
int i, j;
for (i = 0; i < n - 1; i++)
for (j = 0; j <= i; j++) {
x = one << i | one << j | TYPE_MIN;
ATF_CHECK_EQ_MSG(j + 1, FFS(x),
"%s(%#jx) == %d != %d", __STRING(FFS), (intmax_t)x, FFS(x), j + 1);
}
}
ATF_TP_ADD_TCS(tp)
{
ATF_TP_ADD_TC(tp, zero);
ATF_TP_ADD_TC(tp, twobit);
ATF_TP_ADD_TC(tp, twobitneg);
return (atf_no_error());
}
View Options

lib/libc/tests/string/ffsl_test.c

  • This file was added.
/*-
* Copyright (c) 2023 The FreeBSD Foundation
*
* This software was developed by Robert Clausecker <fuz@FreeBSD.org>
* under sponsorship from the FreeBSD Foundation.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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
*/
#define FFS ffsl
#define TYPE long
#define TYPE_MIN LONG_MIN
#include "ffs_test.c"
View Options

lib/libc/tests/string/ffsll_test.c

  • This file was added.
/*-
* Copyright (c) 2023 The FreeBSD Foundation
*
* This software was developed by Robert Clausecker <fuz@FreeBSD.org>
* under sponsorship from the FreeBSD Foundation.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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
*/
#define FFS ffsll
#define TYPE long long
#define TYPE_MIN LLONG_MIN
#include "ffs_test.c"
View Options

lib/libc/tests/string/fls_test.c

Loading...
View Options

lib/libc/tests/string/flsl_test.c

Loading...
View Options

lib/libc/tests/string/flsll_test.c

Loading...