Skip to content

[libc][bazel] Add bazel targets for libc/include/... tests. #141150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 26, 2025

Conversation

jtstogel
Copy link
Contributor

@jtstogel jtstogel commented May 22, 2025

This PR also sets alwayslink=True for //libc/test:LibcUnitTest. This ensures that the main function provided always gets linked into a test target. While not strictly necessary, it makes it so tests like https://github.com/llvm/llvm-project/blob/45d8759cbed0f216786729718608a8be72a505c6/libc/test/include/signbit_test.c will give a duplicate symbol error if they incorrectly depend on //libc/test:LibcUnitTest.

This PR is missing tests for generated header includes since the current Bazel setup lacks generated headers or a mechanism to run hermetic tests. CMake version of the header include tests:

foreach(target ${TARGET_PUBLIC_HEADERS})

See issue #134780

Copy link

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@jtstogel jtstogel marked this pull request as draft May 22, 2025 22:16
@llvmbot llvmbot added libc bazel "Peripheral" support tier build system: utils/bazel labels May 22, 2025
@llvmbot
Copy link
Member

llvmbot commented May 22, 2025

@llvm/pr-subscribers-bolt

@llvm/pr-subscribers-libc

Author: None (jtstogel)

Changes

This PR also sets alwayslink=True for //libc/test:LibcUnitTest. This ensures that the main function provided always gets linked into a test target. While not strictly necessary, it makes it so tests like https://github.com/llvm/llvm-project/blob/45d8759cbed0f216786729718608a8be72a505c6/libc/test/include/signbit_test.c will give a duplicate symbol error if they incorrectly depend on //libc/test:LibcUnitTest.


Full diff: https://github.com/llvm/llvm-project/pull/141150.diff

4 Files Affected:

  • (modified) utils/bazel/llvm-project-overlay/libc/test/UnitTest/BUILD.bazel (+1)
  • (modified) utils/bazel/llvm-project-overlay/libc/test/include/BUILD.bazel (+302-6)
  • (added) utils/bazel/llvm-project-overlay/libc/test/include/sys/BUILD.bazel (+21)
  • (modified) utils/bazel/llvm-project-overlay/libc/test/libc_test_rules.bzl (+32-12)
diff --git a/utils/bazel/llvm-project-overlay/libc/test/UnitTest/BUILD.bazel b/utils/bazel/llvm-project-overlay/libc/test/UnitTest/BUILD.bazel
index b37ec19330236..91820536d55f8 100644
--- a/utils/bazel/llvm-project-overlay/libc/test/UnitTest/BUILD.bazel
+++ b/utils/bazel/llvm-project-overlay/libc/test/UnitTest/BUILD.bazel
@@ -71,6 +71,7 @@ libc_test_library(
         "//libc:llvm_libc_macros_stdfix_macros",
         "//llvm:Support",
     ],
+    alwayslink = True,
 )
 
 libc_test_library(
diff --git a/utils/bazel/llvm-project-overlay/libc/test/include/BUILD.bazel b/utils/bazel/llvm-project-overlay/libc/test/include/BUILD.bazel
index 51e8424282af0..0740b4c30334f 100644
--- a/utils/bazel/llvm-project-overlay/libc/test/include/BUILD.bazel
+++ b/utils/bazel/llvm-project-overlay/libc/test/include/BUILD.bazel
@@ -4,19 +4,315 @@
 
 # Tests for LLVM libc public headers.
 
-load("//libc/test:libc_test_rules.bzl", "libc_test")
-
-package(default_visibility = ["//visibility:public"])
+load("//libc/test:libc_test_rules.bzl", "libc_c_test", "libc_test", "libc_test_library")
 
 licenses(["notice"])
 
+libc_test(
+    name = "assert_test",
+    srcs = ["assert_test.cpp"],
+    deps = ["//libc:public_headers_deps"],
+)
+
+libc_test(
+    name = "complex_test",
+    srcs = ["complex_test.cpp"],
+    deps = [
+        "//libc:public_headers_deps",
+        "//libc/test/UnitTest:fp_test_helpers",
+    ],
+)
+
+libc_test_library(
+    name = "fpclassify_test_fixture",
+    hdrs = ["FpClassifyTest.h"],
+    deps = ["//libc/test/UnitTest:fp_test_helpers"],
+)
+
+libc_test(
+    name = "fpclassify_test",
+    srcs = ["fpclassify_test.cpp"],
+    deps = [
+        ":fpclassify_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "fpclassifyf_test",
+    srcs = ["fpclassifyf_test.cpp"],
+    deps = [
+        ":fpclassify_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "fpclassifyl_test",
+    srcs = ["fpclassifyl_test.cpp"],
+    deps = [
+        ":fpclassify_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_c_test(
+    name = "fpclassify_c_test",
+    srcs = ["fpclassify_test.c"],
+    deps = ["//libc:public_headers_deps"],
+)
+
+libc_test_library(
+    name = "isfinite_test_ficture",
+    hdrs = ["IsFiniteTest.h"],
+    deps = ["//libc/test/UnitTest:fp_test_helpers"],
+)
+
+libc_test(
+    name = "isfinite_test",
+    srcs = ["isfinite_test.cpp"],
+    deps = [
+        ":isfinite_test_ficture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "isfinitef_test",
+    srcs = ["isfinitef_test.cpp"],
+    deps = [
+        ":isfinite_test_ficture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "isfinitel_test",
+    srcs = ["isfinitel_test.cpp"],
+    deps = [
+        ":isfinite_test_ficture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_c_test(
+    name = "isfinite_c_test",
+    srcs = ["isfinite_test.c"],
+    deps = ["//libc:public_headers_deps"],
+)
+
+libc_test_library(
+    name = "isinf_test_fixture",
+    hdrs = ["IsInfTest.h"],
+    deps = ["//libc/test/UnitTest:fp_test_helpers"],
+)
+
+libc_test(
+    name = "isinf_test",
+    srcs = ["isinf_test.cpp"],
+    deps = [
+        ":isinf_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "isinff_test",
+    srcs = ["isinff_test.cpp"],
+    deps = [
+        ":isinf_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "isinfl_test",
+    srcs = ["isinfl_test.cpp"],
+    deps = [
+        ":isinf_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_c_test(
+    name = "isinf_c_test",
+    srcs = ["isinf_test.c"],
+    deps = ["//libc:public_headers_deps"],
+)
+
+libc_test_library(
+    name = "isnan_test_fixture",
+    hdrs = ["IsNanTest.h"],
+    deps = ["//libc/test/UnitTest:fp_test_helpers"],
+)
+
+libc_test(
+    name = "isnan_test",
+    srcs = ["isnan_test.cpp"],
+    deps = [
+        ":isnan_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "isnanf_test",
+    srcs = ["isnanf_test.cpp"],
+    deps = [
+        ":isnan_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "isnanl_test",
+    srcs = ["isnanl_test.cpp"],
+    deps = [
+        ":isnan_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_c_test(
+    name = "isnan_c_test",
+    srcs = ["isnan_test.c"],
+    deps = ["//libc:public_headers_deps"],
+)
+
+libc_test_library(
+    name = "isnormal_test_fixture",
+    hdrs = ["IsNormalTest.h"],
+    deps = ["//libc/test/UnitTest:fp_test_helpers"],
+)
+
+libc_test(
+    name = "isnormal_test",
+    srcs = ["isnormal_test.cpp"],
+    deps = [
+        ":isnormal_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "isnormalf_test",
+    srcs = ["isnormalf_test.cpp"],
+    deps = [
+        ":isnormal_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "isnormall_test",
+    srcs = ["isnormall_test.cpp"],
+    deps = [
+        ":isnormal_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_c_test(
+    name = "isnormal_c_test",
+    srcs = ["isnormal_test.c"],
+    deps = ["//libc:public_headers_deps"],
+)
+
+libc_c_test(
+    name = "issubnormal_c_test",
+    srcs = ["issubnormal_test.c"],
+    deps = ["//libc:public_headers_deps"],
+)
+
+libc_test_library(
+    name = "iszero_test_fixture",
+    hdrs = ["IsZeroTest.h"],
+    deps = ["//libc/test/UnitTest:fp_test_helpers"],
+)
+
+libc_test(
+    name = "iszero_test",
+    srcs = ["iszero_test.cpp"],
+    deps = [
+        ":iszero_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "iszerof_test",
+    srcs = ["iszerof_test.cpp"],
+    deps = [
+        ":iszero_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "iszerol_test",
+    srcs = ["iszerol_test.cpp"],
+    deps = [
+        ":iszero_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_c_test(
+    name = "iszero_c_test",
+    srcs = ["iszero_test.c"],
+    deps = ["//libc:public_headers_deps"],
+)
+
+libc_test_library(
+    name = "signbit_test_fixture",
+    hdrs = ["SignbitTest.h"],
+    deps = ["//libc/test/UnitTest:fp_test_helpers"],
+)
+
+libc_test(
+    name = "signbit_test",
+    srcs = ["signbit_test.cpp"],
+    deps = [
+        ":signbit_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "signbitf_test",
+    srcs = ["signbitf_test.cpp"],
+    deps = [
+        ":signbit_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
+libc_test(
+    name = "signbitl_test",
+    srcs = ["signbitl_test.cpp"],
+    deps = [
+        ":signbit_test_fixture",
+        "//libc:public_headers_deps",
+    ],
+)
+
 libc_test(
     name = "stdbit_test",
     srcs = [
         "stdbit_stub.h",
         "stdbit_test.cpp",
     ],
-    deps = [
-        "//libc:public_headers_deps",
-    ],
+    deps = ["//libc:public_headers_deps"],
+)
+
+libc_c_test(
+    name = "signbit_c_test",
+    srcs = ["signbit_test.c"],
+    deps = ["//libc:public_headers_deps"],
+)
+
+libc_test(
+    name = "stdckdint_test",
+    srcs = ["stdckdint_test.cpp"],
+    deps = ["//libc:public_headers_deps"],
 )
diff --git a/utils/bazel/llvm-project-overlay/libc/test/include/sys/BUILD.bazel b/utils/bazel/llvm-project-overlay/libc/test/include/sys/BUILD.bazel
new file mode 100644
index 0000000000000..2ad56b00e8686
--- /dev/null
+++ b/utils/bazel/llvm-project-overlay/libc/test/include/sys/BUILD.bazel
@@ -0,0 +1,21 @@
+# This file is licensed under the Apache License v2.0 with LLVM Exceptions.
+# See https://llvm.org/LICENSE.txt for license information.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+# Tests for LLVM libc public headers.
+
+load("//libc/test:libc_test_rules.bzl", "libc_test")
+
+package(default_visibility = ["//visibility:public"])
+
+licenses(["notice"])
+
+libc_test(
+    name = "queue_test",
+    srcs = ["queue_test.cpp"],
+    deps = [
+        "//libc:__support_char_vector",
+        "//libc:__support_cpp_string",
+        "//libc:public_headers_deps",
+    ],
+)
diff --git a/utils/bazel/llvm-project-overlay/libc/test/libc_test_rules.bzl b/utils/bazel/llvm-project-overlay/libc/test/libc_test_rules.bzl
index 123e05727aeff..60933fcffcf8c 100644
--- a/utils/bazel/llvm-project-overlay/libc/test/libc_test_rules.bzl
+++ b/utils/bazel/llvm-project-overlay/libc/test/libc_test_rules.bzl
@@ -12,10 +12,18 @@ They come in two flavors:
 When performing tests we make sure to always use the internal version.
 """
 
+load("@rules_cc//cc:cc_library.bzl", "cc_library")
+load("@rules_cc//cc:cc_test.bzl", "cc_test")
 load("//libc:libc_build_rules.bzl", "libc_common_copts")
 load("//libc:libc_configure_options.bzl", "LIBC_CONFIGURE_OPTIONS")
 
-def libc_test(name, copts = [], deps = [], local_defines = [], **kwargs):
+def _libc_test(
+        name,
+        copts = [],
+        deps = [],
+        local_defines = [],
+        use_test_framework = True,
+        **kwargs):
     """Add target for a libc test.
 
     Args:
@@ -23,25 +31,37 @@ def libc_test(name, copts = [], deps = [], local_defines = [], **kwargs):
       copts: The list of options to add to the C++ compilation command.
       deps: The list of libc functions and libraries to be linked in.
       local_defines: The list of target local_defines if any.
+      use_test_framework: Whether the unit test has a custom `main` function.
       **kwargs: Attributes relevant for a cc_test.
     """
-    native.cc_test(
+    deps = deps + [
+        "//libc:__support_macros_config",
+        "//libc:errno",
+        "//libc:func_aligned_alloc",
+        "//libc:func_free",
+        "//libc:func_malloc",
+        "//libc:func_realloc",
+    ]
+    if use_test_framework:
+        deps = deps + ["//libc/test/UnitTest:LibcUnitTest"]
+
+    cc_test(
         name = name,
         local_defines = local_defines + LIBC_CONFIGURE_OPTIONS,
-        deps = [
-            "//libc/test/UnitTest:LibcUnitTest",
-            "//libc:__support_macros_config",
-            "//libc:errno",
-            "//libc:func_aligned_alloc",
-            "//libc:func_free",
-            "//libc:func_malloc",
-            "//libc:func_realloc",
-        ] + deps,
+        deps = deps,
         copts = copts + libc_common_copts(),
         linkstatic = 1,
         **kwargs
     )
 
+def libc_test(name, **kwargs):
+    """Add a target for a libc configured for libc."""
+    _libc_test(name, **kwargs)
+
+def libc_c_test(name, **kwargs):
+    """Add a target for a libc test in C that does not use a test framework."""
+    _libc_test(name, use_test_framework = False, **kwargs)
+
 def libc_test_library(name, copts = [], local_defines = [], **kwargs):
     """Add target for library used in libc tests.
 
@@ -51,7 +71,7 @@ def libc_test_library(name, copts = [], local_defines = [], **kwargs):
       local_defines: See cc_library.local_defines.
       **kwargs: Other attributes relevant to cc_library (e.g. "deps").
     """
-    native.cc_library(
+    cc_library(
         name = name,
         testonly = True,
         copts = copts + libc_common_copts(),

@jtstogel jtstogel changed the title Add bazel targets for libc/include/... tests. [libc][bazel] Add bazel targets for libc/include/... tests. May 22, 2025
@jtstogel jtstogel force-pushed the add-include-tests branch from ea15c9e to 6638a34 Compare May 27, 2025 18:08
@jtstogel jtstogel marked this pull request as ready for review May 27, 2025 19:54
Copy link
Contributor

@vonosmas vonosmas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The change looks good after addressing the comment below. Let me know if you'd like to merge this for you.

Thank you for working on this!

@jtstogel jtstogel force-pushed the add-include-tests branch 2 times, most recently from b53f71b to 7dddbb8 Compare May 28, 2025 18:40
@jtstogel jtstogel force-pushed the add-include-tests branch 2 times, most recently from dd48a03 to 2498281 Compare June 23, 2025 18:44
@llvmbot llvmbot added the BOLT label Jun 23, 2025
@jtstogel jtstogel force-pushed the add-include-tests branch 5 times, most recently from c3809eb to cf95711 Compare June 23, 2025 21:27
Copy link
Contributor

@vonosmas vonosmas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with a couple optional suggestions below.

@jtstogel jtstogel force-pushed the add-include-tests branch 2 times, most recently from a638dc4 to 4fed8d9 Compare June 24, 2025 21:19
These tests are compiled with `-DLIBC_FULL_BUILD`, since otherwise
inclusion of system headers can redefined macros defined by LLVM
libc.

Also, set `alwayslink=True` for `//libc/test:LibcUnitTest`. This ensures that the `main` function provided always gets linked into a test target. While not strictly necessary, it makes it so tests like https://github.com/llvm/llvm-project/blob/45d8759cbed0f216786729718608a8be72a505c6/libc/test/include/signbit_test.c will give a duplicate symbol error if they incorrectly depend on `LibcUnitTest`.
@jtstogel jtstogel force-pushed the add-include-tests branch from 4fed8d9 to 8756607 Compare June 26, 2025 17:58
@vonosmas
Copy link
Contributor

Thank you for working on this! Merging per offline request.

@vonosmas vonosmas merged commit 66ec141 into llvm:main Jun 26, 2025
7 checks passed
Copy link

@jtstogel Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

anthonyhatran pushed a commit to anthonyhatran/llvm-project that referenced this pull request Jun 26, 2025
)

This PR also sets `alwayslink=True` for `//libc/test:LibcUnitTest`. This
ensures that the `main` function provided always gets linked into a test
target. While not strictly necessary, it makes it so tests like
https://github.com/llvm/llvm-project/blob/45d8759cbed0f216786729718608a8be72a505c6/libc/test/include/signbit_test.c
will give a duplicate symbol error if they incorrectly depend on
`//libc/test:LibcUnitTest`.

This PR is missing tests for generated header includes since the current
Bazel setup lacks generated headers or a mechanism to run hermetic
tests. CMake version of the header include tests:
https://github.com/llvm/llvm-project/blob/a2ce5647200ad40ae356affd44db7d054de444d2/libc/test/include/CMakeLists.txt#L515

See issue llvm#134780
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bazel "Peripheral" support tier build system: utils/bazel BOLT libc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants