[libc-commits] [libc] [llvm] [RFC][libc] Codify header inclusion policy (PR #87017)
Nick Desaulniers via libc-commits
libc-commits at lists.llvm.org
Wed Apr 10 16:26:46 PDT 2024
https://github.com/nickdesaulniers updated https://github.com/llvm/llvm-project/pull/87017
>From 4e2833ab58e1d64c95cda19338370899f62d15fd Mon Sep 17 00:00:00 2001
From: Nick Desaulniers <ndesaulniers at google.com>
Date: Thu, 28 Mar 2024 12:48:07 -0700
Subject: [PATCH 1/2] [RFC][libc] Codify header inclusion policy
This RFC is meant to spur discussion; it's not yet clear if this policy is best
(or even makes sense).
When supporting "overlay" vs "fullbuild" modes, "what ABI are you using?"
becomes a fundamental question to have concrete answers for. Overlay mode MUST
match the ABI of the system being overlayed onto; fullbuild more flexible (the
only system ABI relevant is the OS kernel).
When implementing llvm-libc we generally prefer the include-what-you use style
of avoiding transitive dependencies (since that makes refactoring headers more
painful, and slows down build times). So what header do you include for any
given type or function declaration? For any given userspace program, the answer
is straightforward. But for llvm-libc which is trying to support multiple ABIs
(at least one per configuration), the answer is perhaps less clear.
This proposal seeks to add one layer of indirection relative to what's being
done today.
It then converts users of sigset_t, struct epoll_event, and struct timespec
over to this convention as an example.
---
libc/docs/dev/code_style.rst | 33 +++++++++++++++++++
libc/docs/usage_modes.rst | 6 +++-
libc/hdr/CMakeLists.txt | 2 ++
libc/hdr/types/sigset_t.h | 21 ++++++++++++
libc/hdr/types/struct_epoll_event.h | 21 ++++++++++++
libc/hdr/types/struct_timespec.h | 21 ++++++++++++
libc/src/signal/linux/CMakeLists.txt | 16 +++++----
libc/src/signal/linux/raise.cpp | 5 +--
libc/src/signal/linux/sigaction.cpp | 7 ++--
libc/src/signal/linux/sigaddset.cpp | 4 +--
libc/src/signal/linux/sigdelset.cpp | 4 +--
libc/src/signal/linux/sigfillset.cpp | 4 +--
libc/src/signal/linux/signal_utils.h | 3 +-
libc/src/signal/linux/sigprocmask.cpp | 6 ++--
libc/src/signal/sigaddset.h | 2 +-
libc/src/signal/sigdelset.h | 2 +-
libc/src/signal/sigemptyset.h | 2 +-
libc/src/signal/sigfillset.h | 2 +-
libc/src/signal/sigprocmask.h | 2 +-
libc/src/sys/epoll/epoll_pwait.h | 7 ++--
libc/src/sys/epoll/epoll_pwait2.h | 13 +++-----
libc/src/sys/epoll/epoll_wait.h | 8 ++---
libc/src/sys/epoll/linux/CMakeLists.txt | 14 +++++---
libc/src/sys/epoll/linux/epoll_pwait.cpp | 10 ++----
libc/src/sys/epoll/linux/epoll_pwait2.cpp | 12 +++----
libc/src/sys/epoll/linux/epoll_wait.cpp | 9 ++---
libc/src/sys/select/linux/select.cpp | 8 ++---
.../llvm-project-overlay/libc/BUILD.bazel | 13 ++++++++
28 files changed, 181 insertions(+), 76 deletions(-)
create mode 100644 libc/hdr/types/sigset_t.h
create mode 100644 libc/hdr/types/struct_epoll_event.h
create mode 100644 libc/hdr/types/struct_timespec.h
diff --git a/libc/docs/dev/code_style.rst b/libc/docs/dev/code_style.rst
index 22a18b7a4cc1dd..ee4e4257c9fa88 100644
--- a/libc/docs/dev/code_style.rst
+++ b/libc/docs/dev/code_style.rst
@@ -186,3 +186,36 @@ We expect contributions to be free of warnings from the `minimum supported
compiler versions`__ (and newer).
.. __: https://libc.llvm.org/compiler_support.html#minimum-supported-versions
+
+Header Inclusion Policy
+=======================
+
+Because llvm-libc supports
+`Overlay Mode <https://libc.llvm.org/overlay_mode.html>`__ and
+`Fullbuild Mode <https://libc.llvm.org/fullbuild_mode.html>`__ care must be
+taken when ``#include``'ing certain headers.
+
+The ``include/`` directory contains public facing headers that users must
+consume for fullbuild mode. As such, types defined here will have ABI
+implications as these definitions may differ from the underlying system for
+overlay mode and are NEVER appropriate to include in ``libc/src/`` without
+preprocessor guards for ``LLVM_LIBC_FULL_BUILD``.
+
+Consider the case where an implementation in ``libc/src/`` may wish to refer to
+a ``sigset_t``, what header should be included? ``<signal.h>``, ``<spawn.h>``,
+``<sys/select.h>``?
+
+None of the above. Instead, code under ``src/`` should ``#include
+"hdr/types/sigset_t.h"`` which contains preprocessor guards on
+``LLVM_LIBC_FULL_BUILD`` to either include the public type (fullbuild mode) or
+the underlying system header (overlay mode).
+
+Implementations in ``libc/src/`` should NOT be ``#include``'ing using ``<>`` or
+``"include/*``, except for these "proxy" headers that first check for
+``LLVM_LIBC_FULL_BUILD``.
+
+These "proxy" headers are similarly used when referring to preprocessor
+defines. Code under ``libc/src/`` should ``#include`` a proxy header from
+``hdr/``, which contains a guard on ``LLVM_LIBC_FULL_BUILD`` to either include
+our header from ``libc/include/`` (fullbuild) or the corresponding underlying
+system header (overlay).
diff --git a/libc/docs/usage_modes.rst b/libc/docs/usage_modes.rst
index 11c10623b61dba..8e5dcca6e0a75c 100644
--- a/libc/docs/usage_modes.rst
+++ b/libc/docs/usage_modes.rst
@@ -6,6 +6,10 @@ The libc can used in two different modes:
#. The **overlay** mode: In this mode, the link order semantics are exploited
to overlay implementations from LLVM's libc over the system libc. See
- :ref:`overlay_mode` for more information about this mode.
+ :ref:`overlay_mode` for more information about this mode. In this mode, libc
+ uses the ABI of the system it's being overlayed onto. Headers are NOT
+ generated. libllvmlibc.a is the only build artifact.
#. The **fullbuild** mode: In this mode, LLVM's libc is used as the only libc
for the binary. See :ref:`fullbuild_mode` for information about this mode.
+ In this mode, libc uses its own ABI. Headers are generated along with a
+ libc.a.
diff --git a/libc/hdr/CMakeLists.txt b/libc/hdr/CMakeLists.txt
index 5a1acd9d17ab48..38ef56e3f04c03 100644
--- a/libc/hdr/CMakeLists.txt
+++ b/libc/hdr/CMakeLists.txt
@@ -40,3 +40,5 @@ add_proxy_header_library(
libc.include.llvm-libc-macros.fenv_macros
libc.include.fenv
)
+
+add_subdirectory(types)
diff --git a/libc/hdr/types/sigset_t.h b/libc/hdr/types/sigset_t.h
new file mode 100644
index 00000000000000..695ec3029f686b
--- /dev/null
+++ b/libc/hdr/types/sigset_t.h
@@ -0,0 +1,21 @@
+//===-- Proxy for sigset_t ------------------------------------------------===//
+//
+// Part of the LLVM Project, 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
+//
+//===----------------------------------------------------------------------===//
+#ifndef LLVM_LIBC_HDR_TYPES_SIGSET_T_H
+#define LLVM_LIBC_HDR_TYPES_SIGSET_T_H
+
+#ifdef LIBC_FULL_BUILD
+
+#include "include/llvm-libc-types/sigset_t.h"
+
+#else
+
+#include <signal.h>
+
+#endif // LIBC_FULL_BUILD
+
+#endif // LLVM_LIBC_HDR_TYPES_SIGSET_T_H
diff --git a/libc/hdr/types/struct_epoll_event.h b/libc/hdr/types/struct_epoll_event.h
new file mode 100644
index 00000000000000..5bb98ce05bb28a
--- /dev/null
+++ b/libc/hdr/types/struct_epoll_event.h
@@ -0,0 +1,21 @@
+//===-- Proxy for struct epoll_event --------------------------------------===//
+//
+// Part of the LLVM Project, 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
+//
+//===----------------------------------------------------------------------===//
+#ifndef LLVM_LIBC_HDR_TYPES_STRUCT_EPOLL_EVENT_H
+#define LLVM_LIBC_HDR_TYPES_STRUCT_EPOLL_EVENT_H
+
+#ifdef LIBC_FULL_BUILD
+
+#include "include/llvm-libc-types/struct_epoll_event.h"
+
+#else
+
+#include <sys/epoll.h>
+
+#endif // LIBC_FULL_BUILD
+
+#endif // LLVM_LIBC_HDR_TYPES_STRUCT_EPOLL_EVENT_H
diff --git a/libc/hdr/types/struct_timespec.h b/libc/hdr/types/struct_timespec.h
new file mode 100644
index 00000000000000..1f121f3d24d820
--- /dev/null
+++ b/libc/hdr/types/struct_timespec.h
@@ -0,0 +1,21 @@
+//===-- Proxy for struct timespec ----------------------------------------===//
+//
+// Part of the LLVM Project, 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
+//
+//===----------------------------------------------------------------------===//
+#ifndef LLVM_LIBC_HDR_TYPES_STRUCT_TIMESPEC_H
+#define LLVM_LIBC_HDR_TYPES_STRUCT_TIMESPEC_H
+
+#ifdef LIBC_FULL_BUILD
+
+#include "include/llvm-libc-types/struct_timespec.h"
+
+#else
+
+#include <time.h>
+
+#endif // LIBC_FULL_BUILD
+
+#endif // LLVM_LIBC_HDR_TYPES_STRUCT_TIMESPEC_H
diff --git a/libc/src/signal/linux/CMakeLists.txt b/libc/src/signal/linux/CMakeLists.txt
index 77a2453b25a0ac..7606b4b21d3ddb 100644
--- a/libc/src/signal/linux/CMakeLists.txt
+++ b/libc/src/signal/linux/CMakeLists.txt
@@ -3,6 +3,8 @@ add_header_library(
HDRS
signal_utils.h
DEPENDS
+ libc.hdr.types.sigset_t
+ libc.include.signal
libc.include.sys_syscall
libc.src.__support.OSUtil.osutil
)
@@ -28,7 +30,7 @@ add_entrypoint_object(
../raise.h
DEPENDS
.signal_utils
- libc.include.signal
+ libc.hdr.types.sigset_t
libc.include.sys_syscall
libc.src.__support.OSUtil.osutil
)
@@ -57,7 +59,7 @@ add_entrypoint_object(
../sigaction.h
DEPENDS
.__restore
- libc.include.signal
+ libc.hdr.types.sigset_t
libc.include.sys_syscall
libc.src.__support.OSUtil.osutil
libc.src.errno.errno
@@ -84,7 +86,7 @@ add_entrypoint_object(
../sigprocmask.h
DEPENDS
.signal_utils
- libc.include.signal
+ libc.hdr.types.sigset_t
libc.include.sys_syscall
libc.src.__support.OSUtil.osutil
libc.src.errno.errno
@@ -98,7 +100,7 @@ add_entrypoint_object(
../sigemptyset.h
DEPENDS
.signal_utils
- libc.include.signal
+ libc.hdr.types.sigset_t
libc.src.errno.errno
)
@@ -110,7 +112,7 @@ add_entrypoint_object(
../sigaddset.h
DEPENDS
.signal_utils
- libc.include.signal
+ libc.hdr.types.sigset_t
libc.src.errno.errno
)
@@ -133,7 +135,7 @@ add_entrypoint_object(
../sigfillset.h
DEPENDS
.signal_utils
- libc.include.signal
+ libc.hdr.types.sigset_t
libc.src.errno.errno
)
@@ -145,6 +147,6 @@ add_entrypoint_object(
../sigdelset.h
DEPENDS
.signal_utils
- libc.include.signal
+ libc.hdr.types.sigset_t
libc.src.errno.errno
)
diff --git a/libc/src/signal/linux/raise.cpp b/libc/src/signal/linux/raise.cpp
index dd6f5eb4b35754..2250df5478444e 100644
--- a/libc/src/signal/linux/raise.cpp
+++ b/libc/src/signal/linux/raise.cpp
@@ -7,14 +7,15 @@
//===----------------------------------------------------------------------===//
#include "src/signal/raise.h"
-#include "src/signal/linux/signal_utils.h"
+#include "hdr/types/sigset_t.h"
#include "src/__support/common.h"
+#include "src/signal/linux/signal_utils.h"
namespace LIBC_NAMESPACE {
LLVM_LIBC_FUNCTION(int, raise, (int sig)) {
- ::sigset_t sigset;
+ sigset_t sigset;
block_all_signals(sigset);
long pid = LIBC_NAMESPACE::syscall_impl<long>(SYS_getpid);
long tid = LIBC_NAMESPACE::syscall_impl<long>(SYS_gettid);
diff --git a/libc/src/signal/linux/sigaction.cpp b/libc/src/signal/linux/sigaction.cpp
index 7ddc2dc5cbcc70..7b220e5c37f6f7 100644
--- a/libc/src/signal/linux/sigaction.cpp
+++ b/libc/src/signal/linux/sigaction.cpp
@@ -7,12 +7,11 @@
//===----------------------------------------------------------------------===//
#include "src/signal/sigaction.h"
-#include "src/errno/libc_errno.h"
-#include "src/signal/linux/signal_utils.h"
+#include "hdr/types/sigset_t.h"
#include "src/__support/common.h"
-
-#include <signal.h>
+#include "src/errno/libc_errno.h"
+#include "src/signal/linux/signal_utils.h"
namespace LIBC_NAMESPACE {
diff --git a/libc/src/signal/linux/sigaddset.cpp b/libc/src/signal/linux/sigaddset.cpp
index 536391734e0587..8fc5d43180e28c 100644
--- a/libc/src/signal/linux/sigaddset.cpp
+++ b/libc/src/signal/linux/sigaddset.cpp
@@ -7,12 +7,12 @@
//===----------------------------------------------------------------------===//
#include "src/signal/sigaddset.h"
+
+#include "hdr/types/sigset_t.h"
#include "src/__support/common.h"
#include "src/errno/libc_errno.h"
#include "src/signal/linux/signal_utils.h"
-#include <signal.h>
-
namespace LIBC_NAMESPACE {
LLVM_LIBC_FUNCTION(int, sigaddset, (sigset_t * set, int signum)) {
diff --git a/libc/src/signal/linux/sigdelset.cpp b/libc/src/signal/linux/sigdelset.cpp
index 5cb645e461cf8e..997f4574c05d04 100644
--- a/libc/src/signal/linux/sigdelset.cpp
+++ b/libc/src/signal/linux/sigdelset.cpp
@@ -7,12 +7,12 @@
//===----------------------------------------------------------------------===//
#include "src/signal/sigdelset.h"
+
+#include "hdr/types/sigset_t.h"
#include "src/__support/common.h"
#include "src/errno/libc_errno.h"
#include "src/signal/linux/signal_utils.h"
-#include <signal.h>
-
namespace LIBC_NAMESPACE {
LLVM_LIBC_FUNCTION(int, sigdelset, (sigset_t * set, int signum)) {
diff --git a/libc/src/signal/linux/sigfillset.cpp b/libc/src/signal/linux/sigfillset.cpp
index e17c85a897ce74..d98bbf7f619cc1 100644
--- a/libc/src/signal/linux/sigfillset.cpp
+++ b/libc/src/signal/linux/sigfillset.cpp
@@ -7,12 +7,12 @@
//===----------------------------------------------------------------------===//
#include "src/signal/sigfillset.h"
+
+#include "hdr/types/sigset_t.h"
#include "src/__support/common.h"
#include "src/errno/libc_errno.h"
#include "src/signal/linux/signal_utils.h"
-#include <signal.h>
-
namespace LIBC_NAMESPACE {
LLVM_LIBC_FUNCTION(int, sigfillset, (sigset_t * set)) {
diff --git a/libc/src/signal/linux/signal_utils.h b/libc/src/signal/linux/signal_utils.h
index 5e9dd9a5c53ab0..3fd0cc0b7b4597 100644
--- a/libc/src/signal/linux/signal_utils.h
+++ b/libc/src/signal/linux/signal_utils.h
@@ -9,10 +9,11 @@
#ifndef LLVM_LIBC_SRC_SIGNAL_LINUX_SIGNAL_UTILS_H
#define LLVM_LIBC_SRC_SIGNAL_LINUX_SIGNAL_UTILS_H
+#include "hdr/types/sigset_t.h"
#include "src/__support/OSUtil/syscall.h" // For internal syscall function.
#include "src/__support/common.h"
-#include <signal.h>
+#include <signal.h> // sigaction
#include <stddef.h>
#include <sys/syscall.h> // For syscall numbers.
diff --git a/libc/src/signal/linux/sigprocmask.cpp b/libc/src/signal/linux/sigprocmask.cpp
index 79a35dd59d75c8..0e94efb6400c00 100644
--- a/libc/src/signal/linux/sigprocmask.cpp
+++ b/libc/src/signal/linux/sigprocmask.cpp
@@ -7,13 +7,13 @@
//===----------------------------------------------------------------------===//
#include "src/signal/sigprocmask.h"
+
+#include "hdr/types/sigset_t.h"
#include "src/__support/OSUtil/syscall.h" // For internal syscall function.
+#include "src/__support/common.h"
#include "src/errno/libc_errno.h"
#include "src/signal/linux/signal_utils.h"
-#include "src/__support/common.h"
-
-#include <signal.h>
#include <sys/syscall.h> // For syscall numbers.
namespace LIBC_NAMESPACE {
diff --git a/libc/src/signal/sigaddset.h b/libc/src/signal/sigaddset.h
index 626eb20a295c83..c703b46bc6059e 100644
--- a/libc/src/signal/sigaddset.h
+++ b/libc/src/signal/sigaddset.h
@@ -9,7 +9,7 @@
#ifndef LLVM_LIBC_SRC_SIGNAL_SIGADDSET_H
#define LLVM_LIBC_SRC_SIGNAL_SIGADDSET_H
-#include <signal.h>
+#include "hdr/types/sigset_t.h"
namespace LIBC_NAMESPACE {
diff --git a/libc/src/signal/sigdelset.h b/libc/src/signal/sigdelset.h
index c4fdb9975fa3d0..7bdb6e6d18fdd3 100644
--- a/libc/src/signal/sigdelset.h
+++ b/libc/src/signal/sigdelset.h
@@ -9,7 +9,7 @@
#ifndef LLVM_LIBC_SRC_SIGNAL_SIGDELSET_H
#define LLVM_LIBC_SRC_SIGNAL_SIGDELSET_H
-#include <signal.h>
+#include "hdr/types/sigset_t.h"
namespace LIBC_NAMESPACE {
diff --git a/libc/src/signal/sigemptyset.h b/libc/src/signal/sigemptyset.h
index f3763d1f4f3d44..661fd33b888e09 100644
--- a/libc/src/signal/sigemptyset.h
+++ b/libc/src/signal/sigemptyset.h
@@ -9,7 +9,7 @@
#ifndef LLVM_LIBC_SRC_SIGNAL_SIGEMPTYSET_H
#define LLVM_LIBC_SRC_SIGNAL_SIGEMPTYSET_H
-#include <signal.h>
+#include "hdr/types/sigset_t.h"
namespace LIBC_NAMESPACE {
diff --git a/libc/src/signal/sigfillset.h b/libc/src/signal/sigfillset.h
index d8e3168871ea8a..2849aacf953b1e 100644
--- a/libc/src/signal/sigfillset.h
+++ b/libc/src/signal/sigfillset.h
@@ -9,7 +9,7 @@
#ifndef LLVM_LIBC_SRC_SIGNAL_SIGFILLSET_H
#define LLVM_LIBC_SRC_SIGNAL_SIGFILLSET_H
-#include <signal.h>
+#include "hdr/types/sigset_t.h"
namespace LIBC_NAMESPACE {
diff --git a/libc/src/signal/sigprocmask.h b/libc/src/signal/sigprocmask.h
index e0658860579e4e..8569578eb68cad 100644
--- a/libc/src/signal/sigprocmask.h
+++ b/libc/src/signal/sigprocmask.h
@@ -9,7 +9,7 @@
#ifndef LLVM_LIBC_SRC_SIGNAL_SIGPROCMASK_H
#define LLVM_LIBC_SRC_SIGNAL_SIGPROCMASK_H
-#include <signal.h>
+#include "hdr/types/sigset_t.h"
namespace LIBC_NAMESPACE {
diff --git a/libc/src/sys/epoll/epoll_pwait.h b/libc/src/sys/epoll/epoll_pwait.h
index 9dcb55533009f9..801aa976100016 100644
--- a/libc/src/sys/epoll/epoll_pwait.h
+++ b/libc/src/sys/epoll/epoll_pwait.h
@@ -9,11 +9,8 @@
#ifndef LLVM_LIBC_SRC_SYS_EPOLL_EPOLL_PWAIT_H
#define LLVM_LIBC_SRC_SYS_EPOLL_EPOLL_PWAIT_H
-// TODO: Use this include once the include headers are also using quotes.
-// #include "include/llvm-libc-types/sigset_t.h"
-// #include "include/llvm-libc-types/struct_epoll_event.h"
-
-#include <sys/epoll.h>
+#include "hdr/types/sigset_t.h"
+#include "hdr/types/struct_epoll_event.h"
namespace LIBC_NAMESPACE {
diff --git a/libc/src/sys/epoll/epoll_pwait2.h b/libc/src/sys/epoll/epoll_pwait2.h
index 622ede6a0f9f9a..e3503be02f86a2 100644
--- a/libc/src/sys/epoll/epoll_pwait2.h
+++ b/libc/src/sys/epoll/epoll_pwait2.h
@@ -9,18 +9,15 @@
#ifndef LLVM_LIBC_SRC_SYS_EPOLL_EPOLL_PWAIT2_H
#define LLVM_LIBC_SRC_SYS_EPOLL_EPOLL_PWAIT2_H
-// TODO: Use this include once the include headers are also using quotes.
-// #include "include/llvm-libc-types/sigset_t.h"
-// #include "include/llvm-libc-types/struct_epoll_event.h"
-// #include "include/llvm-libc-types/struct_timespec.h"
-
-#include <sys/epoll.h>
+#include "hdr/types/sigset_t.h"
+#include "hdr/types/struct_epoll_event.h"
+#include "hdr/types/struct_timespec.h"
namespace LIBC_NAMESPACE {
// TODO: sigmask and timeout should be nullable
-int epoll_pwait2(int epfd, epoll_event *events, int maxevents,
- const timespec *timeout, const sigset_t *sigmask);
+int epoll_pwait2(int epfd, struct epoll_event *events, int maxevents,
+ const struct timespec *timeout, const sigset_t *sigmask);
} // namespace LIBC_NAMESPACE
diff --git a/libc/src/sys/epoll/epoll_wait.h b/libc/src/sys/epoll/epoll_wait.h
index d51c9100846ce0..8a72261be3ae36 100644
--- a/libc/src/sys/epoll/epoll_wait.h
+++ b/libc/src/sys/epoll/epoll_wait.h
@@ -9,14 +9,12 @@
#ifndef LLVM_LIBC_SRC_SYS_EPOLL_EPOLL_WAIT_H
#define LLVM_LIBC_SRC_SYS_EPOLL_EPOLL_WAIT_H
-// TODO: Use this include once the include headers are also using quotes.
-// #include "include/llvm-libc-types/struct_epoll_event.h"
-
-#include <sys/epoll.h>
+#include "hdr/types/struct_epoll_event.h"
namespace LIBC_NAMESPACE {
-int epoll_wait(int epfd, epoll_event *events, int maxevents, int timeout);
+int epoll_wait(int epfd, struct epoll_event *events, int maxevents,
+ int timeout);
} // namespace LIBC_NAMESPACE
diff --git a/libc/src/sys/epoll/linux/CMakeLists.txt b/libc/src/sys/epoll/linux/CMakeLists.txt
index a27905d962dc57..586aac7055dc1f 100644
--- a/libc/src/sys/epoll/linux/CMakeLists.txt
+++ b/libc/src/sys/epoll/linux/CMakeLists.txt
@@ -5,7 +5,9 @@ add_entrypoint_object(
HDRS
../epoll_wait.h
DEPENDS
- libc.include.sys_epoll
+ libc.hdr.types.sigset_t
+ libc.hdr.types.struct_epoll_event
+ libc.hdr.types.struct_timespec
libc.include.sys_syscall
libc.src.__support.OSUtil.osutil
libc.src.errno.errno
@@ -18,7 +20,9 @@ add_entrypoint_object(
HDRS
../epoll_pwait.h
DEPENDS
- libc.include.sys_epoll
+ libc.hdr.types.sigset_t
+ libc.hdr.types.struct_epoll_event
+ libc.hdr.types.struct_timespec
libc.include.signal
libc.include.sys_syscall
libc.src.__support.OSUtil.osutil
@@ -32,10 +36,12 @@ add_entrypoint_object(
HDRS
../epoll_pwait2.h
DEPENDS
- libc.include.sys_epoll
+ libc.hdr.types.sigset_t
+ libc.hdr.types.struct_epoll_event
+ libc.hdr.types.struct_timespec
libc.include.signal
- libc.include.time
libc.include.sys_syscall
+ libc.include.time
libc.src.__support.OSUtil.osutil
libc.src.errno.errno
)
diff --git a/libc/src/sys/epoll/linux/epoll_pwait.cpp b/libc/src/sys/epoll/linux/epoll_pwait.cpp
index ee1b4e66e98444..ac012944a9577c 100644
--- a/libc/src/sys/epoll/linux/epoll_pwait.cpp
+++ b/libc/src/sys/epoll/linux/epoll_pwait.cpp
@@ -8,17 +8,13 @@
#include "src/sys/epoll/epoll_pwait.h"
+#include "hdr/types/sigset_t.h"
+#include "hdr/types/struct_epoll_event.h"
#include "src/__support/OSUtil/syscall.h" // For internal syscall function.
#include "src/__support/common.h"
-
#include "src/errno/libc_errno.h"
-#include <sys/syscall.h> // For syscall numbers.
-// TODO: Use this include once the include headers are also using quotes.
-// #include "include/llvm-libc-types/sigset_t.h"
-// #include "include/llvm-libc-types/struct_epoll_event.h"
-
-#include <sys/epoll.h>
+#include <sys/syscall.h> // For syscall numbers.
namespace LIBC_NAMESPACE {
diff --git a/libc/src/sys/epoll/linux/epoll_pwait2.cpp b/libc/src/sys/epoll/linux/epoll_pwait2.cpp
index 671dede2a1058d..3c42e38deb22bc 100644
--- a/libc/src/sys/epoll/linux/epoll_pwait2.cpp
+++ b/libc/src/sys/epoll/linux/epoll_pwait2.cpp
@@ -8,18 +8,14 @@
#include "src/sys/epoll/epoll_pwait2.h"
+#include "hdr/types/sigset_t.h"
+#include "hdr/types/struct_epoll_event.h"
+#include "hdr/types/struct_timespec.h"
#include "src/__support/OSUtil/syscall.h" // For internal syscall function.
#include "src/__support/common.h"
-
#include "src/errno/libc_errno.h"
-#include <sys/syscall.h> // For syscall numbers.
-// TODO: Use this include once the include headers are also using quotes.
-// #include "include/llvm-libc-types/sigset_t.h"
-// #include "include/llvm-libc-types/struct_epoll_event.h"
-// #include "include/llvm-libc-types/struct_timespec.h"
-
-#include <sys/epoll.h>
+#include <sys/syscall.h> // For syscall numbers.
namespace LIBC_NAMESPACE {
diff --git a/libc/src/sys/epoll/linux/epoll_wait.cpp b/libc/src/sys/epoll/linux/epoll_wait.cpp
index 0c43edf7645454..18dd6e2b83543f 100644
--- a/libc/src/sys/epoll/linux/epoll_wait.cpp
+++ b/libc/src/sys/epoll/linux/epoll_wait.cpp
@@ -8,16 +8,13 @@
#include "src/sys/epoll/epoll_wait.h"
+#include "hdr/types/sigset_t.h"
+#include "hdr/types/struct_epoll_event.h"
#include "src/__support/OSUtil/syscall.h" // For internal syscall function.
#include "src/__support/common.h"
#include "src/errno/libc_errno.h"
-#include <sys/syscall.h> // For syscall numbers.
-
-// TODO: Use this include once the include headers are also using quotes.
-// #include "include/llvm-libc-types/sigset_t.h"
-// #include "include/llvm-libc-types/struct_epoll_event.h"
-#include <sys/epoll.h>
+#include <sys/syscall.h> // For syscall numbers.
namespace LIBC_NAMESPACE {
diff --git a/libc/src/sys/select/linux/select.cpp b/libc/src/sys/select/linux/select.cpp
index 3f387c14ec5601..9034b75e5c29eb 100644
--- a/libc/src/sys/select/linux/select.cpp
+++ b/libc/src/sys/select/linux/select.cpp
@@ -8,14 +8,14 @@
#include "src/sys/select/select.h"
+#include "hdr/types/sigset_t.h"
+#include "hdr/types/struct_timespec.h"
#include "src/__support/CPP/limits.h"
#include "src/__support/OSUtil/syscall.h" // For internal syscall function.
#include "src/__support/common.h"
-
#include "src/errno/libc_errno.h"
-#include <signal.h>
-#include <stddef.h> // For size_t
-#include <sys/select.h>
+
+#include <stddef.h> // For size_t
#include <sys/syscall.h> // For syscall numbers.
namespace LIBC_NAMESPACE {
diff --git a/utils/bazel/llvm-project-overlay/libc/BUILD.bazel b/utils/bazel/llvm-project-overlay/libc/BUILD.bazel
index d38dc3029f74ff..c61904a967117e 100644
--- a/utils/bazel/llvm-project-overlay/libc/BUILD.bazel
+++ b/utils/bazel/llvm-project-overlay/libc/BUILD.bazel
@@ -3417,6 +3417,15 @@ libc_function(
############################## sys/epoll targets ###############################
+libc_support_library(
+ name = "types_sigset_t",
+ hdrs = ["hdr/types/sigset_t.h"],
+)
+libc_support_library(
+ name = "types_struct_epoll_event",
+ hdrs = ["hdr/types/struct_epoll_event.h"],
+)
+
libc_function(
name = "epoll_wait",
srcs = ["src/sys/epoll/linux/epoll_wait.cpp"],
@@ -3429,6 +3438,8 @@ libc_function(
deps = [
":__support_osutil_syscall",
":errno",
+ ":types_sigset_t",
+ ":types_struct_epoll_event",
],
)
@@ -3444,6 +3455,8 @@ libc_function(
deps = [
":__support_osutil_syscall",
":errno",
+ ":types_sigset_t",
+ ":types_struct_epoll_event",
],
)
>From 681d51ff75f7470c8e8cb2238d17781455da5e69 Mon Sep 17 00:00:00 2001
From: Nick Desaulniers <ndesaulniers at google.com>
Date: Wed, 10 Apr 2024 16:26:21 -0700
Subject: [PATCH 2/2] git add libc/hdr/types/CMakeLists.txt
---
libc/hdr/types/CMakeLists.txt | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
create mode 100644 libc/hdr/types/CMakeLists.txt
diff --git a/libc/hdr/types/CMakeLists.txt b/libc/hdr/types/CMakeLists.txt
new file mode 100644
index 00000000000000..b685d82fd8cc84
--- /dev/null
+++ b/libc/hdr/types/CMakeLists.txt
@@ -0,0 +1,23 @@
+add_proxy_header_library(
+ sigset_t
+ HDRS
+ sigset_t.h
+ FULL_BUILD_DEPENDS
+ libc.include.llvm-libc-types.sigset_t
+)
+
+add_proxy_header_library(
+ struct_epoll_event
+ HDRS
+ struct_epoll_event.h
+ FULL_BUILD_DEPENDS
+ libc.include.llvm-libc-types.struct_epoll_event
+)
+
+add_proxy_header_library(
+ struct_timespec
+ HDRS
+ struct_timespec.h
+ FULL_BUILD_DEPENDS
+ libc.include.llvm-libc-types.struct_timespec
+)
More information about the libc-commits
mailing list