[libc] Add llvm-lit testing infrastructure

[abrachet]

Summary

This patch is a work in progress. Is this even something we think will be useful?

These lit tests are meant to be for correctness of the environment not of the implementations necessarily.

[abrachet]

libc/test/test/lit.cfg.py

49

I just realized I should use CMAKE_C_COMPILER in lit.site.cfg.py.in instead of just using clang, I will do that in the next round.

libc/test/test/sanity/includes.c

9

This one also fails currently because <linux/errno.h> is not found because %clang_libc compiles with -nostdinc

libc/test/test/src/assert/assert.c

1

This test is erroneous because it is linking against glibc's __assert_fail not ours. Which is surprising because __assert_fail is in libllvmlibc.a. I'm not sure why ld is not linking against libllvmlibc.a's __assert_fail.

[sivachandra]

Just answering the question in the "Summary": Yes, something like this is useful to check the integrity of llvmlibc.a and the public header files. But, I have not spent time to convince myself that llvm-lit is the best way to do it.

[abrachet]

In D75427#1900317, @sivachandra wrote:

Just answering the question in the "Summary": Yes, something like this is useful to check the integrity of llvmlibc.a and the public header files. But, I have not spent time to convince myself that llvm-lit is the best way to do it.

I think it's probably not, now that I think more about it. In any case something like this might be too early given the current state of llvmlibc.

libc/test/CMakeLists.txt

 add_custom_target(check-libc)
 
 add_subdirectory(config)
 add_subdirectory(src)
+
+if (LIBC_LIT_TESTS)
+  add_subdirectory(test)
+endif()

libc/test/test/CMakeLists.txt

+configure_lit_site_cfg(
+  ${CMAKE_CURRENT_SOURCE_DIR}/lit.site.cfg.py.in
+  ${CMAKE_CURRENT_BINARY_DIR}/lit.site.cfg.py
+  MAIN_CONFIG
+    ${CMAKE_CURRENT_SOURCE_DIR}/lit.cfg.py
+)
+
+
+set(LLVM_TEST_DEPENDS
+  not
+  FileCheck
+)
+
+add_lit_testsuite(check-libc-lit "Running llvm libc lit tests"
+  ${CMAKE_CURRENT_BINARY_DIR}
+  DEPENDS
+    llvmlibc
+)
+
+set_target_properties(check-libc-lit PROPERTIES FOLDER "Tests")

libc/test/test/lit.cfg.py

+# -*- Python -*-
+
+import os
+import platform
+import re
+import subprocess
+import tempfile
+
+import lit.formats
+import lit.util
+
+from lit.llvm import llvm_config
+from lit.llvm.subst import ToolSubst
+from lit.llvm.subst import FindTool
+
+# Configuration file for the 'lit' test runner.
+
+# name: The name of this test suite.
+config.name = 'libc'
+
+# testFormat: The test format to use to interpret tests.
+#
+# For now we require '&&' between commands, until they get globally killed and
+# the test runner updated.
+config.test_format = lit.formats.ShTest(not llvm_config.use_lit_shell)
+
+# suffixes: A list of file extensions to treat as test files.
+config.suffixes = ['.c', '.cpp', '.test', '.s']
+
+# excludes: A list of directories to exclude from the testsuite. The 'Inputs'
+# subdirectories contain auxiliary inputs for various tests in their parent
+# directories.
+config.excludes = ['CMakeLists.txt']
+
+# test_source_root: The root path where tests are located.
+config.test_source_root = os.path.dirname(__file__)
+
+llvm_config.use_default_substitutions()
+
+def findLibcIncDir():
+    return config.libc_build_dir + '/include/'
+
+def findLibcDotA():
+    return config.libc_build_dir + '/lib/libllvmlibc.a'
+
+# TODO: in the future when we provide the crt, make sure we aren't linking
+# against the system libc at all.
+config.substitutions.append(
+    ('%clang_libc', 'clang -nostdinc -isystem '
+        + findLibcIncDir() + ' ' + findLibcDotA()))

libc/test/test/lit.site.cfg.py.in

+@LIT_SITE_CFG_IN_HEADER@
+
+import sys
+
+config.lit_tools_dir = "@LLVM_LIT_TOOLS_DIR@"
+config.llvm_src_root = "@LLVM_SOURCE_DIR@"
+config.llvm_obj_root = "@LLVM_BINARY_DIR@"
+config.llvm_tools_dir = "@LLVM_TOOLS_DIR@"
+config.libc_build_dir = "@LIBC_BUILD_DIR@"
+
+# Support substitution of the tools_dir with user parameters.
+# This is used when we can't determine the tool dir at configuration time.
+try:
+    config.llvm_tools_dir = config.llvm_tools_dir % lit_config.params
+except KeyError:
+    e = sys.exc_info()[1]
+    key, = e.args
+    lit_config.fatal("unable to find %r parameter, use '--param=%s=VALUE'" % (key,key))
+
+import lit.llvm
+lit.llvm.initialize(lit_config, config)
+
+# Let the main config do the real work.
+lit_config.load_config(config, "@LIBC_SOURCE_DIR@/test/test/lit.cfg.py")

libc/test/test/sanity/includes.c

+// This tests that all of the expected includes are available in their expected
+// directories and are syntactically valid.
+
+// RUN: %clang_libc %s -fsyntax-only
+
+#include <assert.h>
+// #include <ctype.h> This fails because ctype.h is never copied into the
+// build's include directory.
+#include <errno.h>
+#include <math.h>
+#include <signal.h>
+#include <stdlib.h>
+#include <string.h>
+
+#ifndef WIN32
+#include <sys/mman.h>
+#include <sys/syscall.h>
+#endif

libc/test/test/sanity/sanity.c

+// This is a sanity check to ensure llvm libc headers are in our include path
+// and that the llvm libc lit tests are set up correctly.
+
+// RUN: %clang_libc %s -fsyntax-only 2>&1 | FileCheck %s
+// CHECK: sanity check compiled successfully
+
+#include <__llvm-libc-common.h>
+
+#warning "sanity check compiled successfully"

libc/test/test/src/assert/assert.c

+// This tests that asserts error message is as we expect.
+
+// RUN: %clang_libc %s -o %t
+// RUN: not %t | FileCheck %s
+
+// RUN: %clang_libc %s -o %t -DNDEBUG
+// RUN: %t
+
+// CHECK: assert.c: Assertion failed '0' in function 'int main()'
+
+#include <assert.h>
+
+int main() {
+  assert(0);
+}