[libc-commits] [libc] [libc] add snmalloc as an alternative allocator to libc (PR #122284)
Schrodinger ZHU Yifan via libc-commits
libc-commits at lists.llvm.org
Sun Jan 19 01:57:15 PST 2025
https://github.com/SchrodingerZhu updated https://github.com/llvm/llvm-project/pull/122284
>From ddedf1e4b10a9b386fd334c3babcfd604bed6c62 Mon Sep 17 00:00:00 2001
From: Schrodinger ZHU Yifan <i at zhuyi.fan>
Date: Thu, 9 Jan 2025 22:57:57 +0800
Subject: [PATCH 1/6] POC: add snmalloc as an alternative allocator to libc
---
libc/src/stdlib/CMakeLists.txt | 41 +++++++++++-
libc/src/stdlib/snmalloc/CMakeLists.txt | 75 ++++++++++++++++++++++
libc/src/stdlib/snmalloc/aligned_alloc.cpp | 0
libc/src/stdlib/snmalloc/calloc.cpp | 0
libc/src/stdlib/snmalloc/free.cpp | 0
libc/src/stdlib/snmalloc/malloc.cpp | 9 +++
libc/src/stdlib/snmalloc/mallopt.cpp | 0
libc/src/stdlib/snmalloc/realloc.cpp | 0
libc/src/stdlib/snmalloc/support.h | 14 ++++
9 files changed, 138 insertions(+), 1 deletion(-)
create mode 100644 libc/src/stdlib/snmalloc/CMakeLists.txt
create mode 100644 libc/src/stdlib/snmalloc/aligned_alloc.cpp
create mode 100644 libc/src/stdlib/snmalloc/calloc.cpp
create mode 100644 libc/src/stdlib/snmalloc/free.cpp
create mode 100644 libc/src/stdlib/snmalloc/malloc.cpp
create mode 100644 libc/src/stdlib/snmalloc/mallopt.cpp
create mode 100644 libc/src/stdlib/snmalloc/realloc.cpp
create mode 100644 libc/src/stdlib/snmalloc/support.h
diff --git a/libc/src/stdlib/CMakeLists.txt b/libc/src/stdlib/CMakeLists.txt
index 40ba9ead9a7ae6..7d0dfd1aa9da4b 100644
--- a/libc/src/stdlib/CMakeLists.txt
+++ b/libc/src/stdlib/CMakeLists.txt
@@ -324,7 +324,46 @@ add_entrypoint_object(
)
if(NOT LIBC_TARGET_OS_IS_BAREMETAL AND NOT LIBC_TARGET_OS_IS_GPU)
- if(LLVM_LIBC_INCLUDE_SCUDO)
+ if (NOT "${LLVM_LIBC_INCLUDE_SNMALLOC}" STREQUAL "")
+ message(STATUS "Including snmalloc as the allocator, source directory: ${LLVM_LIBC_INCLUDE_SNMALLOC}")
+ add_subdirectory(snmalloc)
+ add_entrypoint_object(
+ malloc
+ ALIAS
+ DEPENDS
+ .snmalloc.malloc
+ )
+ add_entrypoint_object(
+ calloc
+ ALIAS
+ DEPENDS
+ .snmalloc.calloc
+ )
+ add_entrypoint_object(
+ realloc
+ ALIAS
+ DEPENDS
+ .snmalloc.realloc
+ )
+ add_entrypoint_object(
+ aligned_alloc
+ ALIAS
+ DEPENDS
+ .snmalloc.aligned_alloc
+ )
+ add_entrypoint_object(
+ free
+ ALIAS
+ DEPENDS
+ .snmalloc.free
+ )
+ add_entrypoint_object(
+ mallopt
+ ALIAS
+ DEPENDS
+ .snmalloc.mallopt
+ )
+ elseif(LLVM_LIBC_INCLUDE_SCUDO)
set(SCUDO_DEPS "")
include(${LIBC_SOURCE_DIR}/../compiler-rt/cmake/Modules/AllSupportedArchDefs.cmake)
diff --git a/libc/src/stdlib/snmalloc/CMakeLists.txt b/libc/src/stdlib/snmalloc/CMakeLists.txt
new file mode 100644
index 00000000000000..3971ea42db1744
--- /dev/null
+++ b/libc/src/stdlib/snmalloc/CMakeLists.txt
@@ -0,0 +1,75 @@
+set(SNMALLOC_USE_SELF_VENDORED_STL ON CACHE BOOL "use freestanding snmalloc setup" FORCE)
+set(SNMALLOC_BUILD_TESTING OFF CACHE BOOL "disable snmalloc tests" FORCE)
+set(SNMALLOC_HEADER_ONLY_LIBRARY ON CACHE BOOL "use snmalloc as header only library" FORCE)
+
+# Disable installation
+macro (install)
+endmacro ()
+
+add_subdirectory(${LLVM_LIBC_INCLUDE_SNMALLOC} ${CMAKE_CURRENT_BINARY_DIR}/snmalloc EXCLUDE_FROM_ALL)
+
+target_compile_options(
+ snmalloc
+ INTERFACE
+ -ffreestanding
+ -nostdinc
+ -Wno-newline-eof
+ -Wno-extra-semi
+ -Wno-unused-command-line-argument
+ -Wno-ctad-maybe-unsupported
+ # TODO: define this
+ -DSTDERR_FILENO=2
+ -include ${CMAKE_CURRENT_SOURCE_DIR}/support.h
+ # include_directories does not propagate, use options instead
+ -isystem ${COMPILER_RESOURCE_DIR}/include
+ -isystem ${LIBC_INCLUDE_DIR}
+)
+add_dependencies(snmalloc libc-headers)
+
+add_entrypoint_object(
+ malloc
+ SRCS
+ malloc.cpp
+ DEPENDS
+ snmalloc
+)
+
+add_entrypoint_object(
+ calloc
+ SRCS
+ calloc.cpp
+ DEPENDS
+ snmalloc
+)
+
+add_entrypoint_object(
+ realloc
+ SRCS
+ realloc.cpp
+ DEPENDS
+ snmalloc
+)
+
+add_entrypoint_object(
+ aligned_alloc
+ SRCS
+ aligned_alloc.cpp
+ DEPENDS
+ snmalloc
+)
+
+add_entrypoint_object(
+ free
+ SRCS
+ free.cpp
+ DEPENDS
+ snmalloc
+)
+
+add_entrypoint_object(
+ mallopt
+ SRCS
+ mallopt.cpp
+ DEPENDS
+ snmalloc
+)
diff --git a/libc/src/stdlib/snmalloc/aligned_alloc.cpp b/libc/src/stdlib/snmalloc/aligned_alloc.cpp
new file mode 100644
index 00000000000000..e69de29bb2d1d6
diff --git a/libc/src/stdlib/snmalloc/calloc.cpp b/libc/src/stdlib/snmalloc/calloc.cpp
new file mode 100644
index 00000000000000..e69de29bb2d1d6
diff --git a/libc/src/stdlib/snmalloc/free.cpp b/libc/src/stdlib/snmalloc/free.cpp
new file mode 100644
index 00000000000000..e69de29bb2d1d6
diff --git a/libc/src/stdlib/snmalloc/malloc.cpp b/libc/src/stdlib/snmalloc/malloc.cpp
new file mode 100644
index 00000000000000..644f2eef0ed2bf
--- /dev/null
+++ b/libc/src/stdlib/snmalloc/malloc.cpp
@@ -0,0 +1,9 @@
+#include "src/stdlib/malloc.h"
+#include "snmalloc/snmalloc.h"
+#include "src/__support/common.h"
+
+namespace LIBC_NAMESPACE_DECL {
+LLVM_LIBC_FUNCTION(void *, malloc, (size_t size)) {
+ return snmalloc::libc::malloc(size);
+}
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/stdlib/snmalloc/mallopt.cpp b/libc/src/stdlib/snmalloc/mallopt.cpp
new file mode 100644
index 00000000000000..e69de29bb2d1d6
diff --git a/libc/src/stdlib/snmalloc/realloc.cpp b/libc/src/stdlib/snmalloc/realloc.cpp
new file mode 100644
index 00000000000000..e69de29bb2d1d6
diff --git a/libc/src/stdlib/snmalloc/support.h b/libc/src/stdlib/snmalloc/support.h
new file mode 100644
index 00000000000000..4909667c1a50d8
--- /dev/null
+++ b/libc/src/stdlib/snmalloc/support.h
@@ -0,0 +1,14 @@
+#include "src/sys/random/getrandom.h"
+
+// TODO: define this
+inline int getentropy(void *buf, size_t size) {
+ while (size > 0) {
+ ssize_t ret = LIBC_NAMESPACE::getrandom(buf, size, 0);
+ if (ret < 0) {
+ return -1;
+ }
+ buf = (char *)buf + ret;
+ size -= ret;
+ }
+ return 0;
+}
>From 96ebfa909efe6f6f31c6a28e99649a586f152404 Mon Sep 17 00:00:00 2001
From: Schrodinger ZHU Yifan <i at zhuyi.fan>
Date: Thu, 16 Jan 2025 04:08:22 +0000
Subject: [PATCH 2/6] adjust build
---
libc/src/stdlib/snmalloc/CMakeLists.txt | 2 +-
libc/src/stdlib/snmalloc/free.cpp | 17 +++++++++++++++++
libc/src/stdlib/snmalloc/malloc.cpp | 8 ++++++++
libc/src/stdlib/snmalloc/support.h | 14 --------------
4 files changed, 26 insertions(+), 15 deletions(-)
delete mode 100644 libc/src/stdlib/snmalloc/support.h
diff --git a/libc/src/stdlib/snmalloc/CMakeLists.txt b/libc/src/stdlib/snmalloc/CMakeLists.txt
index 3971ea42db1744..516505c09a13d1 100644
--- a/libc/src/stdlib/snmalloc/CMakeLists.txt
+++ b/libc/src/stdlib/snmalloc/CMakeLists.txt
@@ -19,7 +19,7 @@ target_compile_options(
-Wno-ctad-maybe-unsupported
# TODO: define this
-DSTDERR_FILENO=2
- -include ${CMAKE_CURRENT_SOURCE_DIR}/support.h
+ -DSNMALLOC_USE_PTHREAD_DESTRUCTORS
# include_directories does not propagate, use options instead
-isystem ${COMPILER_RESOURCE_DIR}/include
-isystem ${LIBC_INCLUDE_DIR}
diff --git a/libc/src/stdlib/snmalloc/free.cpp b/libc/src/stdlib/snmalloc/free.cpp
index e69de29bb2d1d6..a3160c15d0df38 100644
--- a/libc/src/stdlib/snmalloc/free.cpp
+++ b/libc/src/stdlib/snmalloc/free.cpp
@@ -0,0 +1,17 @@
+//===-- Implementation of free --------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/stdlib/free.h"
+#include "snmalloc/snmalloc.h"
+#include "src/__support/common.h"
+
+namespace LIBC_NAMESPACE_DECL {
+LLVM_LIBC_FUNCTION(void, free, (void * ptr)) {
+ return snmalloc::libc::free(ptr);
+}
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/stdlib/snmalloc/malloc.cpp b/libc/src/stdlib/snmalloc/malloc.cpp
index 644f2eef0ed2bf..ab58e63743016a 100644
--- a/libc/src/stdlib/snmalloc/malloc.cpp
+++ b/libc/src/stdlib/snmalloc/malloc.cpp
@@ -1,3 +1,11 @@
+//===-- Implementation of malloc ------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
#include "src/stdlib/malloc.h"
#include "snmalloc/snmalloc.h"
#include "src/__support/common.h"
diff --git a/libc/src/stdlib/snmalloc/support.h b/libc/src/stdlib/snmalloc/support.h
deleted file mode 100644
index 4909667c1a50d8..00000000000000
--- a/libc/src/stdlib/snmalloc/support.h
+++ /dev/null
@@ -1,14 +0,0 @@
-#include "src/sys/random/getrandom.h"
-
-// TODO: define this
-inline int getentropy(void *buf, size_t size) {
- while (size > 0) {
- ssize_t ret = LIBC_NAMESPACE::getrandom(buf, size, 0);
- if (ret < 0) {
- return -1;
- }
- buf = (char *)buf + ret;
- size -= ret;
- }
- return 0;
-}
>From bc6eb843e3cff098a20adde7f408d8a7d38e9915 Mon Sep 17 00:00:00 2001
From: Schrodinger ZHU Yifan <i at zhuyi.fan>
Date: Thu, 16 Jan 2025 04:26:12 +0000
Subject: [PATCH 3/6] implement all symbols
---
libc/src/stdlib/snmalloc/aligned_alloc.cpp | 17 +++++++++++++++++
libc/src/stdlib/snmalloc/calloc.cpp | 17 +++++++++++++++++
libc/src/stdlib/snmalloc/free.cpp | 2 +-
libc/src/stdlib/snmalloc/mallopt.cpp | 13 +++++++++++++
libc/src/stdlib/snmalloc/realloc.cpp | 17 +++++++++++++++++
5 files changed, 65 insertions(+), 1 deletion(-)
diff --git a/libc/src/stdlib/snmalloc/aligned_alloc.cpp b/libc/src/stdlib/snmalloc/aligned_alloc.cpp
index e69de29bb2d1d6..ee1d74ca9c778c 100644
--- a/libc/src/stdlib/snmalloc/aligned_alloc.cpp
+++ b/libc/src/stdlib/snmalloc/aligned_alloc.cpp
@@ -0,0 +1,17 @@
+//===-- Implementation of aligned_alloc -----------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/stdlib/aligned_alloc.h"
+#include "snmalloc/snmalloc.h"
+#include "src/__support/common.h"
+
+namespace LIBC_NAMESPACE_DECL {
+LLVM_LIBC_FUNCTION(void *, aligned_alloc, (size_t alignment, size_t size)) {
+ return snmalloc::libc::aligned_alloc(alignment, size);
+}
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/stdlib/snmalloc/calloc.cpp b/libc/src/stdlib/snmalloc/calloc.cpp
index e69de29bb2d1d6..39af67607bf709 100644
--- a/libc/src/stdlib/snmalloc/calloc.cpp
+++ b/libc/src/stdlib/snmalloc/calloc.cpp
@@ -0,0 +1,17 @@
+//===-- Implementation of calloc ------------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/stdlib/calloc.h"
+#include "snmalloc/snmalloc.h"
+#include "src/__support/common.h"
+
+namespace LIBC_NAMESPACE_DECL {
+LLVM_LIBC_FUNCTION(void *, calloc, (size_t num, size_t size)) {
+ return snmalloc::libc::calloc(num, size);
+}
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/stdlib/snmalloc/free.cpp b/libc/src/stdlib/snmalloc/free.cpp
index a3160c15d0df38..eb403710fffada 100644
--- a/libc/src/stdlib/snmalloc/free.cpp
+++ b/libc/src/stdlib/snmalloc/free.cpp
@@ -11,7 +11,7 @@
#include "src/__support/common.h"
namespace LIBC_NAMESPACE_DECL {
-LLVM_LIBC_FUNCTION(void, free, (void * ptr)) {
+LLVM_LIBC_FUNCTION(void, free, (void *ptr)) {
return snmalloc::libc::free(ptr);
}
} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/stdlib/snmalloc/mallopt.cpp b/libc/src/stdlib/snmalloc/mallopt.cpp
index e69de29bb2d1d6..c52d68e3d52230 100644
--- a/libc/src/stdlib/snmalloc/mallopt.cpp
+++ b/libc/src/stdlib/snmalloc/mallopt.cpp
@@ -0,0 +1,13 @@
+//===-- Implementation of mallopt stub ------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/__support/common.h"
+
+namespace LIBC_NAMESPACE_DECL {
+LLVM_LIBC_FUNCTION(int, mallopt, (int, int)) { return 0; }
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/stdlib/snmalloc/realloc.cpp b/libc/src/stdlib/snmalloc/realloc.cpp
index e69de29bb2d1d6..36972e0a2232ec 100644
--- a/libc/src/stdlib/snmalloc/realloc.cpp
+++ b/libc/src/stdlib/snmalloc/realloc.cpp
@@ -0,0 +1,17 @@
+//===-- Implementation of realloc -----------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/stdlib/realloc.h"
+#include "snmalloc/snmalloc.h"
+#include "src/__support/common.h"
+
+namespace LIBC_NAMESPACE_DECL {
+LLVM_LIBC_FUNCTION(void *, realloc, (void *ptr, size_t size)) {
+ return snmalloc::libc::realloc(ptr, size);
+}
+} // namespace LIBC_NAMESPACE_DECL
>From 5f6651d0c0a8d7cfc270bca198cc5db9b09c8f45 Mon Sep 17 00:00:00 2001
From: Schrodinger ZHU Yifan <i at zhuyi.fan>
Date: Thu, 16 Jan 2025 05:09:37 +0000
Subject: [PATCH 4/6] setup dependencies
---
libc/src/stdlib/snmalloc/CMakeLists.txt | 43 +++++++++++++++++++++++++
1 file changed, 43 insertions(+)
diff --git a/libc/src/stdlib/snmalloc/CMakeLists.txt b/libc/src/stdlib/snmalloc/CMakeLists.txt
index 516505c09a13d1..cc7172c947c4c2 100644
--- a/libc/src/stdlib/snmalloc/CMakeLists.txt
+++ b/libc/src/stdlib/snmalloc/CMakeLists.txt
@@ -24,8 +24,46 @@ target_compile_options(
-isystem ${COMPILER_RESOURCE_DIR}/include
-isystem ${LIBC_INCLUDE_DIR}
)
+
add_dependencies(snmalloc libc-headers)
+set(SNMALLOC_DEPS
+ # includes
+ libc.include.errno
+ libc.include.fcntl
+ libc.include.limits
+ libc.include.pthread
+ libc.include.stdio
+ libc.include.stdint
+ libc.include.stdlib
+ libc.include.string
+ libc.include.strings
+ libc.include.sys_mman
+ libc.include.sys_prctl
+ libc.include.sys_random
+ libc.include.sys_syscall
+ libc.include.sys_uio
+ libc.include.unistd
+ # symbols
+ libc.src.errno.errno
+ libc.src.fcntl.open
+ libc.src.pthread.pthread_key_create
+ libc.src.pthread.pthread_setspecific
+ libc.src.stdlib.abort
+ libc.src.stdlib.atexit
+ libc.src.string.memset
+ libc.src.string.strlen
+ libc.src.sys.mman.madvise
+ libc.src.sys.mman.mmap
+ libc.src.sys.uio.writev
+ libc.src.time.clock_gettime
+ libc.src.unistd.__llvm_libc_syscall
+ libc.src.unistd.close
+ libc.src.unistd.fsync
+ libc.src.unistd.getentropy
+ libc.src.unistd.read
+)
+
add_entrypoint_object(
malloc
SRCS
@@ -40,6 +78,7 @@ add_entrypoint_object(
calloc.cpp
DEPENDS
snmalloc
+ ${SNMALLOC_DEPS}
)
add_entrypoint_object(
@@ -48,6 +87,7 @@ add_entrypoint_object(
realloc.cpp
DEPENDS
snmalloc
+ ${SNMALLOC_DEPS}
)
add_entrypoint_object(
@@ -56,6 +96,7 @@ add_entrypoint_object(
aligned_alloc.cpp
DEPENDS
snmalloc
+ ${SNMALLOC_DEPS}
)
add_entrypoint_object(
@@ -64,6 +105,7 @@ add_entrypoint_object(
free.cpp
DEPENDS
snmalloc
+ ${SNMALLOC_DEPS}
)
add_entrypoint_object(
@@ -72,4 +114,5 @@ add_entrypoint_object(
mallopt.cpp
DEPENDS
snmalloc
+ ${SNMALLOC_DEPS}
)
>From 1382389b1f693f98f9b253ef53ee6a8985350899 Mon Sep 17 00:00:00 2001
From: Schrodinger ZHU Yifan <i at zhuyi.fan>
Date: Thu, 16 Jan 2025 06:12:42 +0000
Subject: [PATCH 5/6] make hermetic build pass with snmalloc
---
libc/src/stdlib/snmalloc/CMakeLists.txt | 1 +
libc/src/stdlib/snmalloc/override.h | 32 +++++++++++++++++++++++++
libc/test/src/stdlib/CMakeLists.txt | 4 +++-
3 files changed, 36 insertions(+), 1 deletion(-)
create mode 100644 libc/src/stdlib/snmalloc/override.h
diff --git a/libc/src/stdlib/snmalloc/CMakeLists.txt b/libc/src/stdlib/snmalloc/CMakeLists.txt
index cc7172c947c4c2..e360b36f5fb3ad 100644
--- a/libc/src/stdlib/snmalloc/CMakeLists.txt
+++ b/libc/src/stdlib/snmalloc/CMakeLists.txt
@@ -21,6 +21,7 @@ target_compile_options(
-DSTDERR_FILENO=2
-DSNMALLOC_USE_PTHREAD_DESTRUCTORS
# include_directories does not propagate, use options instead
+ -include ${CMAKE_CURRENT_SOURCE_DIR}/override.h
-isystem ${COMPILER_RESOURCE_DIR}/include
-isystem ${LIBC_INCLUDE_DIR}
)
diff --git a/libc/src/stdlib/snmalloc/override.h b/libc/src/stdlib/snmalloc/override.h
new file mode 100644
index 00000000000000..a36a6316790fbd
--- /dev/null
+++ b/libc/src/stdlib/snmalloc/override.h
@@ -0,0 +1,32 @@
+//===-- Macro Override for SnMalloc ---------------------------------------===//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+// skip special headers
+#define LLVM_LIBC_COMMON_H
+#define LLVM_LIBC_ERRNO_H
+
+// define common macros
+#define __BEGIN_C_DECLS namespace LIBC_NAMESPACE {
+#define __END_C_DECLS \
+ } \
+ using namespace LIBC_NAMESPACE;
+
+#define _Noreturn [[noreturn]]
+#define _Alignas alignas
+#define _Static_assert static_assert
+#define _Alignof alignof
+#define _Thread_local thread_local
+
+// Use empty definition to avoid spec mismatching
+// We are building internally anyway, hence noexcept does not matter here
+#define __NOEXCEPT
+
+// Enforce internal errno implementation
+#include "hdr/errno_macros.h"
+#include "src/errno/libc_errno.h"
+#define errno libc_errno
diff --git a/libc/test/src/stdlib/CMakeLists.txt b/libc/test/src/stdlib/CMakeLists.txt
index 8cc0428632ba39..2346a8bae08f87 100644
--- a/libc/test/src/stdlib/CMakeLists.txt
+++ b/libc/test/src/stdlib/CMakeLists.txt
@@ -420,7 +420,9 @@ if(LLVM_LIBC_FULL_BUILD)
)
# Only baremetal and GPU has an in-tree 'malloc' implementation.
- if(LIBC_TARGET_OS_IS_BAREMETAL OR LIBC_TARGET_OS_IS_GPU)
+ if(LIBC_TARGET_OS_IS_BAREMETAL
+ OR LIBC_TARGET_OS_IS_GPU
+ OR NOT "${LLVM_LIBC_INCLUDE_SNMALLOC}" STREQUAL "")
add_libc_test(
malloc_test
HERMETIC_TEST_ONLY
>From c89428c9ee03922a5699e6295ed3809026413915 Mon Sep 17 00:00:00 2001
From: Schrodinger ZHU Yifan <i at zhuyi.fan>
Date: Sun, 19 Jan 2025 09:04:54 +0000
Subject: [PATCH 6/6] use _malloc_thread_cleanup hook in fullbuild mode
---
libc/src/__support/threads/linux/CMakeLists.txt | 5 +++++
libc/src/__support/threads/linux/thread.cpp | 10 ++++++++++
libc/src/stdlib/CMakeLists.txt | 9 +++++++++
libc/src/stdlib/atexit.cpp | 9 +++++++++
libc/src/stdlib/snmalloc/CMakeLists.txt | 5 -----
libc/src/stdlib/snmalloc/aligned_alloc.cpp | 4 +++-
libc/src/stdlib/snmalloc/calloc.cpp | 4 +++-
libc/src/stdlib/snmalloc/free.cpp | 4 +++-
libc/src/stdlib/snmalloc/malloc.cpp | 4 +++-
libc/src/stdlib/snmalloc/override.h | 4 ++++
libc/src/stdlib/snmalloc/realloc.cpp | 4 +++-
11 files changed, 52 insertions(+), 10 deletions(-)
diff --git a/libc/src/__support/threads/linux/CMakeLists.txt b/libc/src/__support/threads/linux/CMakeLists.txt
index 47598d98c98863..71d9eec932c6c7 100644
--- a/libc/src/__support/threads/linux/CMakeLists.txt
+++ b/libc/src/__support/threads/linux/CMakeLists.txt
@@ -71,6 +71,10 @@ add_header_library(
libc.src.__support.threads.mutex_common
)
+if (NOT "${LLVM_LIBC_INCLUDE_SNMALLOC}" STREQUAL "")
+ set (libc_malloc_thread_cleanup_flag "-DLIBC_USE_MALLOC_THREAD_CLEANUP")
+endif()
+
add_object_library(
thread
SRCS
@@ -89,6 +93,7 @@ add_object_library(
libc.src.__support.threads.thread_common
COMPILE_OPTIONS
${libc_opt_high_flag}
+ ${libc_malloc_thread_cleanup_flag}
-fno-omit-frame-pointer # This allows us to sniff out the thread args from
# the new thread's stack reliably.
-Wno-frame-address # Yes, calling __builtin_return_address with a
diff --git a/libc/src/__support/threads/linux/thread.cpp b/libc/src/__support/threads/linux/thread.cpp
index c531d74c533550..a80c04a24fdba8 100644
--- a/libc/src/__support/threads/linux/thread.cpp
+++ b/libc/src/__support/threads/linux/thread.cpp
@@ -482,6 +482,11 @@ int Thread::get_name(cpp::StringStream &name) const {
return 0;
}
+#ifdef LIBC_USE_MALLOC_THREAD_CLEANUP
+// This symbol may not be defined if libc is not built with allocator
+extern "C" [[gnu::weak]] void _malloc_thread_cleanup();
+#endif
+
void thread_exit(ThreadReturnValue retval, ThreadStyle style) {
auto attrib = self.attrib;
@@ -494,6 +499,11 @@ void thread_exit(ThreadReturnValue retval, ThreadStyle style) {
// different thread. The destructors of thread local and TSS objects should
// be called by the thread which owns them.
internal::call_atexit_callbacks(attrib);
+#ifdef LIBC_USE_MALLOC_THREAD_CLEANUP
+ // teardown TLS heap
+ if (_malloc_thread_cleanup)
+ _malloc_thread_cleanup();
+#endif
uint32_t joinable_state = uint32_t(DetachState::JOINABLE);
if (!attrib->detach_state.compare_exchange_strong(
diff --git a/libc/src/stdlib/CMakeLists.txt b/libc/src/stdlib/CMakeLists.txt
index 7d0dfd1aa9da4b..10dfdff04dcfdd 100644
--- a/libc/src/stdlib/CMakeLists.txt
+++ b/libc/src/stdlib/CMakeLists.txt
@@ -326,6 +326,9 @@ add_entrypoint_object(
if(NOT LIBC_TARGET_OS_IS_BAREMETAL AND NOT LIBC_TARGET_OS_IS_GPU)
if (NOT "${LLVM_LIBC_INCLUDE_SNMALLOC}" STREQUAL "")
message(STATUS "Including snmalloc as the allocator, source directory: ${LLVM_LIBC_INCLUDE_SNMALLOC}")
+ if (NOT LLVM_LIBC_FULL_BUILD)
+ message(FATAL_ERROR "Snmalloc can only be included when fullbuild mode is enabled")
+ endif()
add_subdirectory(snmalloc)
add_entrypoint_object(
malloc
@@ -595,6 +598,10 @@ add_header_library(
)
endif()
+if (NOT "${LLVM_LIBC_INCLUDE_SNMALLOC}" STREQUAL "")
+ set (libc_malloc_thread_cleanup_flag "-DLIBC_USE_MALLOC_THREAD_CLEANUP")
+endif()
+
add_entrypoint_object(
atexit
SRCS
@@ -605,6 +612,8 @@ add_entrypoint_object(
20 # For constinit
DEPENDS
.exit_handler
+ COMPILE_OPTIONS
+ ${libc_malloc_thread_cleanup_flag}
)
add_entrypoint_object(
diff --git a/libc/src/stdlib/atexit.cpp b/libc/src/stdlib/atexit.cpp
index 799aad136bda5c..e5baca946c85b0 100644
--- a/libc/src/stdlib/atexit.cpp
+++ b/libc/src/stdlib/atexit.cpp
@@ -18,6 +18,11 @@ constinit ExitCallbackList atexit_callbacks;
Mutex handler_list_mtx(false, false, false, false);
[[gnu::weak]] extern void teardown_main_tls();
+#ifdef LIBC_USE_MALLOC_THREAD_CLEANUP
+// This symbol may not be defined if libc is not built with allocator
+extern "C" [[gnu::weak]] void _malloc_thread_cleanup();
+#endif
+
extern "C" {
int __cxa_atexit(AtExitCallback *callback, void *payload, void *) {
@@ -27,6 +32,10 @@ int __cxa_atexit(AtExitCallback *callback, void *payload, void *) {
void __cxa_finalize(void *dso) {
if (!dso) {
call_exit_callbacks(atexit_callbacks);
+#ifdef LIBC_USE_MALLOC_THREAD_CLEANUP
+ if (_malloc_thread_cleanup)
+ _malloc_thread_cleanup();
+#endif
if (teardown_main_tls)
teardown_main_tls();
}
diff --git a/libc/src/stdlib/snmalloc/CMakeLists.txt b/libc/src/stdlib/snmalloc/CMakeLists.txt
index e360b36f5fb3ad..b980738abb750f 100644
--- a/libc/src/stdlib/snmalloc/CMakeLists.txt
+++ b/libc/src/stdlib/snmalloc/CMakeLists.txt
@@ -17,11 +17,6 @@ target_compile_options(
-Wno-extra-semi
-Wno-unused-command-line-argument
-Wno-ctad-maybe-unsupported
- # TODO: define this
- -DSTDERR_FILENO=2
- -DSNMALLOC_USE_PTHREAD_DESTRUCTORS
- # include_directories does not propagate, use options instead
- -include ${CMAKE_CURRENT_SOURCE_DIR}/override.h
-isystem ${COMPILER_RESOURCE_DIR}/include
-isystem ${LIBC_INCLUDE_DIR}
)
diff --git a/libc/src/stdlib/snmalloc/aligned_alloc.cpp b/libc/src/stdlib/snmalloc/aligned_alloc.cpp
index ee1d74ca9c778c..7e209c170d6133 100644
--- a/libc/src/stdlib/snmalloc/aligned_alloc.cpp
+++ b/libc/src/stdlib/snmalloc/aligned_alloc.cpp
@@ -6,9 +6,11 @@
//
//===----------------------------------------------------------------------===//
-#include "src/stdlib/aligned_alloc.h"
+#include "src/stdlib/snmalloc/override.h"
+
#include "snmalloc/snmalloc.h"
#include "src/__support/common.h"
+#include "src/stdlib/aligned_alloc.h"
namespace LIBC_NAMESPACE_DECL {
LLVM_LIBC_FUNCTION(void *, aligned_alloc, (size_t alignment, size_t size)) {
diff --git a/libc/src/stdlib/snmalloc/calloc.cpp b/libc/src/stdlib/snmalloc/calloc.cpp
index 39af67607bf709..7bac3f6b1b0e6c 100644
--- a/libc/src/stdlib/snmalloc/calloc.cpp
+++ b/libc/src/stdlib/snmalloc/calloc.cpp
@@ -6,9 +6,11 @@
//
//===----------------------------------------------------------------------===//
-#include "src/stdlib/calloc.h"
+#include "src/stdlib/snmalloc/override.h"
+
#include "snmalloc/snmalloc.h"
#include "src/__support/common.h"
+#include "src/stdlib/calloc.h"
namespace LIBC_NAMESPACE_DECL {
LLVM_LIBC_FUNCTION(void *, calloc, (size_t num, size_t size)) {
diff --git a/libc/src/stdlib/snmalloc/free.cpp b/libc/src/stdlib/snmalloc/free.cpp
index eb403710fffada..fa8f94f73a563f 100644
--- a/libc/src/stdlib/snmalloc/free.cpp
+++ b/libc/src/stdlib/snmalloc/free.cpp
@@ -6,9 +6,11 @@
//
//===----------------------------------------------------------------------===//
-#include "src/stdlib/free.h"
+#include "src/stdlib/snmalloc/override.h"
+
#include "snmalloc/snmalloc.h"
#include "src/__support/common.h"
+#include "src/stdlib/free.h"
namespace LIBC_NAMESPACE_DECL {
LLVM_LIBC_FUNCTION(void, free, (void *ptr)) {
diff --git a/libc/src/stdlib/snmalloc/malloc.cpp b/libc/src/stdlib/snmalloc/malloc.cpp
index ab58e63743016a..ff4352687ed0d1 100644
--- a/libc/src/stdlib/snmalloc/malloc.cpp
+++ b/libc/src/stdlib/snmalloc/malloc.cpp
@@ -6,9 +6,11 @@
//
//===----------------------------------------------------------------------===//
-#include "src/stdlib/malloc.h"
+#include "src/stdlib/snmalloc/override.h"
+
#include "snmalloc/snmalloc.h"
#include "src/__support/common.h"
+#include "src/stdlib/malloc.h"
namespace LIBC_NAMESPACE_DECL {
LLVM_LIBC_FUNCTION(void *, malloc, (size_t size)) {
diff --git a/libc/src/stdlib/snmalloc/override.h b/libc/src/stdlib/snmalloc/override.h
index a36a6316790fbd..50f26f8b203866 100644
--- a/libc/src/stdlib/snmalloc/override.h
+++ b/libc/src/stdlib/snmalloc/override.h
@@ -26,6 +26,10 @@
// We are building internally anyway, hence noexcept does not matter here
#define __NOEXCEPT
+// TODO: define this in stdio.h
+#define STDERR_FILENO 2
+#define SNMALLOC_USE_THREAD_CLEANUP
+
// Enforce internal errno implementation
#include "hdr/errno_macros.h"
#include "src/errno/libc_errno.h"
diff --git a/libc/src/stdlib/snmalloc/realloc.cpp b/libc/src/stdlib/snmalloc/realloc.cpp
index 36972e0a2232ec..bdafc2d0cc7590 100644
--- a/libc/src/stdlib/snmalloc/realloc.cpp
+++ b/libc/src/stdlib/snmalloc/realloc.cpp
@@ -6,9 +6,11 @@
//
//===----------------------------------------------------------------------===//
-#include "src/stdlib/realloc.h"
+#include "src/stdlib/snmalloc/override.h"
+
#include "snmalloc/snmalloc.h"
#include "src/__support/common.h"
+#include "src/stdlib/realloc.h"
namespace LIBC_NAMESPACE_DECL {
LLVM_LIBC_FUNCTION(void *, realloc, (void *ptr, size_t size)) {
More information about the libc-commits
mailing list