[libc-commits] [libc] [libc] move pthread macros to dedicated header (PR #119286)

[Nick Desaulniers via libc-commits]

https://github.com/nickdesaulniers created https://github.com/llvm/llvm-project/pull/119286

so that docgen can find our definitions.

Also eliminate the enums. POSIX is careful to call these "symbolic constants"
rather than specifically whether they are preprocessor macro defines or not.
Enums are useful to expressing mutual exclusion when the enum values are in
distinct enums which can improve type safety. Our enum values weren't using
that pattern though; they were all in one big anonymous enum.

Link: https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/pthread.h.html
Fixes: #88997


>From 3b4672309f7e2bca8101a6878f48117e4c9b451e Mon Sep 17 00:00:00 2001
From: Nick Desaulniers <ndesaulniers at google.com>
Date: Mon, 9 Dec 2024 15:11:55 -0800
Subject: [PATCH] [libc] move pthread macros to dedicated header

so that docgen can find our definitions.

Also eliminate the enums. POSIX is careful to call these "symbolic constants"
rather than specifically whether they are preprocessor macro defines or not.
Enums are useful to expressing mutual exclusion when the enum values are in
distinct enums which can improve type safety. Our enum values weren't using
that pattern though; they were all in one big anonymous enum.

Link: https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/pthread.h.html
Fixes: #88997
---
 libc/include/CMakeLists.txt                   |  3 +-
 libc/include/llvm-libc-macros/CMakeLists.txt  |  6 +++
 .../include/llvm-libc-macros/pthread-macros.h | 38 +++++++++++++++++++
 libc/include/pthread.h.def                    | 34 +----------------
 4 files changed, 47 insertions(+), 34 deletions(-)
 create mode 100644 libc/include/llvm-libc-macros/pthread-macros.h

diff --git a/libc/include/CMakeLists.txt b/libc/include/CMakeLists.txt
index 6fdaa6c03c0c87..18ce8e22d1a0ac 100644
--- a/libc/include/CMakeLists.txt
+++ b/libc/include/CMakeLists.txt
@@ -389,7 +389,7 @@ add_header_macro(
   pthread.h.def
   pthread.h
   DEPENDS
-    .llvm_libc_common_h
+    .llvm-libc-macros.pthread_macros
     .llvm-libc-types.__atfork_callback_t
     .llvm-libc-types.__pthread_once_func_t
     .llvm-libc-types.__pthread_start_t
@@ -404,6 +404,7 @@ add_header_macro(
     .llvm-libc-types.pthread_rwlockattr_t
     .llvm-libc-types.pthread_spinlock_t
     .llvm-libc-types.pthread_t
+    .llvm_libc_common_h
 )
 
 add_header_macro(
diff --git a/libc/include/llvm-libc-macros/CMakeLists.txt b/libc/include/llvm-libc-macros/CMakeLists.txt
index 75194923a452fb..9d5d9f65442889 100644
--- a/libc/include/llvm-libc-macros/CMakeLists.txt
+++ b/libc/include/llvm-libc-macros/CMakeLists.txt
@@ -315,3 +315,9 @@ add_macro_header(
   HDR
     locale-macros.h
 )
+
+add_macro_header(
+  pthread_macros
+  HDR
+    pthread-macros.h
+)
diff --git a/libc/include/llvm-libc-macros/pthread-macros.h b/libc/include/llvm-libc-macros/pthread-macros.h
new file mode 100644
index 00000000000000..34ef450056f069
--- /dev/null
+++ b/libc/include/llvm-libc-macros/pthread-macros.h
@@ -0,0 +1,38 @@
+//===-- Definition of pthread macros --------------------------------------===//
+//
+// 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_MACROS_PTHREAD_MACRO_H
+#define LLVM_LIBC_MACROS_PTHREAD_MACRO_H
+
+#define PTHREAD_CREATE_JOINABLE 0
+#define PTHREAD_CREATE_DETACHED 1
+
+#define PTHREAD_MUTEX_NORMAL 0
+#define PTHREAD_MUTEX_ERRORCHECK 1
+#define PTHREAD_MUTEX_RECURSIVE 2
+#define PTHREAD_MUTEX_DEFAULT PTHREAD_MUTEX_NORMAL
+
+#define PTHREAD_MUTEX_STALLED 0
+#define PTHREAD_MUTEX_ROBUST 1
+
+#define PTHREAD_ONCE_INIT {0}
+
+#define PTHREAD_PROCESS_PRIVATE 0
+#define PTHREAD_PROCESS_SHARED 1
+
+#define PTHREAD_MUTEX_INITIALIZER {0}
+#define PTHREAD_RWLOCK_INITIALIZER {}
+
+// glibc extensions
+#define PTHREAD_STACK_MIN (1 << 14) // 16KB
+#define PTHREAD_RWLOCK_PREFER_READER_NP 0
+#define PTHREAD_RWLOCK_PREFER_WRITER_NP 1
+#define PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP 2
+
+#endif // LLVM_LIBC_MACROS_PTHREAD_MACRO_H
+
diff --git a/libc/include/pthread.h.def b/libc/include/pthread.h.def
index 4dbeed6b5f321a..aa1e9983e4bb9a 100644
--- a/libc/include/pthread.h.def
+++ b/libc/include/pthread.h.def
@@ -10,39 +10,7 @@
 #define LLVM_LIBC_PTHREAD_H
 
 #include "__llvm-libc-common.h"
-
-// TODO: move to a pthreads-macros.h file:
-// https://github.com/llvm/llvm-project/issues/88997
-
-#define PTHREAD_STACK_MIN (1 << 14) // 16KB
-
-#define PTHREAD_MUTEX_INITIALIZER {0}
-#define PTHREAD_RWLOCK_INITIALIZER {}
-#define PTHREAD_ONCE_INIT {0}
-
-enum {
-  PTHREAD_CREATE_JOINABLE = 0x0,
-  PTHREAD_CREATE_DETACHED = 0x1,
-
-  PTHREAD_MUTEX_NORMAL = 0x0,
-  PTHREAD_MUTEX_ERRORCHECK = 0x1,
-  PTHREAD_MUTEX_RECURSIVE = 0x2,
-  PTHREAD_MUTEX_DEFAULT = PTHREAD_MUTEX_NORMAL,
-
-  PTHREAD_PROCESS_PRIVATE = 0x0,
-  PTHREAD_PROCESS_SHARED = 0x1,
-
-  PTHREAD_MUTEX_STALLED = 0x0,
-  PTHREAD_MUTEX_ROBUST = 0x1,
-};
-
-#define PTHREAD_PROCESS_PRIVATE 0
-#define PTHREAD_PROCESS_SHARED 1
-
-#define PTHREAD_RWLOCK_PREFER_READER_NP 0
-#define PTHREAD_RWLOCK_PREFER_WRITER_NP 1
-#define PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP 2
-
+#include "llvm-libc-macros/pthread-macros.h"
 
 %%public_api()