Skip to content

[libc++] Add support for picolibc and newlib in RUNTIMES_USE_LIBC #147956

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions libcxx/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -751,6 +751,18 @@ config_define(${LIBCXX_ENABLE_WIDE_CHARACTERS} _LIBCPP_HAS_WIDE_CHARACTERS)
config_define(${LIBCXX_ENABLE_TIME_ZONE_DATABASE} _LIBCPP_HAS_TIME_ZONE_DATABASE)
config_define(${LIBCXX_ENABLE_VENDOR_AVAILABILITY_ANNOTATIONS} _LIBCPP_HAS_VENDOR_AVAILABILITY_ANNOTATIONS)

# Set C library in use
if (RUNTIMES_USE_LIBC STREQUAL "picolibc")
config_define(1 _LIBCXX_LIBC_PICOLIBC)
# picolibc is derived from newlib and behaves the same in regards to libc++
# so setting both here:
# * _LIBCXX_LIBC_NEWLIB is used now
# * _LIBCXX_LIBC_PICOLIBC can be used for further customizations later
config_define(1 _LIBCXX_LIBC_NEWLIB)
elseif (RUNTIMES_USE_LIBC STREQUAL "newlib")
config_define(1 _LIBCXX_LIBC_NEWLIB)
endif()

# TODO: Remove in LLVM 21. We're leaving an error to make this fail explicitly.
if (LIBCXX_ENABLE_ASSERTIONS)
message(FATAL_ERROR "LIBCXX_ENABLE_ASSERTIONS has been removed. Please use LIBCXX_HARDENING_MODE instead.")
Expand Down
4 changes: 4 additions & 0 deletions libcxx/include/__config_site.in
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@
// Hardening.
#cmakedefine _LIBCPP_HARDENING_MODE_DEFAULT @_LIBCPP_HARDENING_MODE_DEFAULT@

// C libraries
#cmakedefine01 _LIBCXX_LIBC_PICOLIBC
#cmakedefine01 _LIBCXX_LIBC_NEWLIB

// __USE_MINGW_ANSI_STDIO gets redefined on MinGW
#ifdef __clang__
# pragma clang diagnostic push
Expand Down
7 changes: 0 additions & 7 deletions libcxx/include/__configuration/platform.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,6 @@
# endif
#endif

// This is required in order for _NEWLIB_VERSION to be defined in places where we use it.
// TODO: We shouldn't be including arbitrarily-named headers from libc++ since this can break valid
// user code. Move code paths that need _NEWLIB_VERSION to another customization mechanism.
#if __has_include(<picolibc.h>)
# include <picolibc.h>
#endif

#ifndef __BYTE_ORDER__
# error \
"Your compiler doesn't seem to define __BYTE_ORDER__, which is required by libc++ to know the endianness of your target platform"
Expand Down
2 changes: 1 addition & 1 deletion libcxx/include/__cxx03/__fwd/ios.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ using wios = basic_ios<wchar_t>;
template <class _CharT, class _Traits>
class _LIBCPP_PREFERRED_NAME(ios) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wios)) basic_ios;

#if defined(_NEWLIB_VERSION)
#if _LIBCXX_LIBC_NEWLIB
// On newlib, off_t is 'long int'
using streamoff = long int; // for char_traits in <string>
#else
Expand Down
2 changes: 1 addition & 1 deletion libcxx/include/__cxx03/__locale
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,7 @@ public:
static const mask xdigit = _ISXDIGIT;
static const mask blank = _ISBLANK;
static const mask __regex_word = 0x8000;
#elif defined(_NEWLIB_VERSION)
#elif _LIBCXX_LIBC_NEWLIB
// Same type as Newlib's _ctype_ array in newlib/libc/include/ctype.h.
typedef char mask;
// In case char is signed, static_cast is needed to avoid warning on
Expand Down
2 changes: 1 addition & 1 deletion libcxx/include/__cxx03/__locale_dir/locale_base_api.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
# include <__cxx03/__locale_dir/locale_base_api/android.h>
#elif defined(__sun__)
# include <__cxx03/__locale_dir/locale_base_api/solaris.h>
#elif defined(_NEWLIB_VERSION)
#elif _LIBCXX_LIBC_NEWLIB
# include <__cxx03/__locale_dir/locale_base_api/newlib.h>
#elif defined(__OpenBSD__)
# include <__cxx03/__locale_dir/locale_base_api/openbsd.h>
Expand Down
2 changes: 1 addition & 1 deletion libcxx/include/__cxx03/fstream
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ typedef basic_fstream<wchar_t> wfstream;
_LIBCPP_PUSH_MACROS
#include <__cxx03/__undef_macros>

#if defined(_LIBCPP_MSVCRT) || defined(_NEWLIB_VERSION)
#if defined(_LIBCPP_MSVCRT) || _LIBCXX_LIBC_NEWLIB
# define _LIBCPP_HAS_NO_OFF_T_FUNCTIONS
#endif

Expand Down
2 changes: 1 addition & 1 deletion libcxx/include/__cxx03/locale
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ template <class charT> class messages_byname;

# if defined(__unix__) || (defined(__APPLE__) && defined(__MACH__))
// Most unix variants have catopen. These are the specific ones that don't.
# if !defined(__BIONIC__) && !defined(_NEWLIB_VERSION) && !defined(__EMSCRIPTEN__)
# if !defined(__BIONIC__) && !_LIBCXX_LIBC_NEWLIB && !defined(__EMSCRIPTEN__)
# define _LIBCPP_HAS_CATOPEN 1
# include <nl_types.h>
# endif
Expand Down
6 changes: 2 additions & 4 deletions libcxx/include/__cxx03/regex
Original file line number Diff line number Diff line change
Expand Up @@ -984,7 +984,7 @@ public:
typedef _CharT char_type;
typedef basic_string<char_type> string_type;
typedef locale locale_type;
#if defined(__BIONIC__) || defined(_NEWLIB_VERSION)
#if defined(__BIONIC__) || _LIBCXX_LIBC_NEWLIB
// Originally bionic's ctype_base used its own ctype masks because the
// builtin ctype implementation wasn't in libc++ yet. Bionic's ctype mask
// was only 8 bits wide and already saturated, so it used a wider type here
Expand All @@ -993,9 +993,7 @@ public:
// implementation, but this was not updated to match. Since then Android has
// needed to maintain a stable libc++ ABI, and this can't be changed without
// an ABI break.
// We also need this workaround for newlib since _NEWLIB_VERSION is not
// defined yet inside __config, so we can't set the
// _LIBCPP_PROVIDES_DEFAULT_RUNE_TABLE macro. Additionally, newlib is
// We also need this workaround for newlib since newlib is
// often used for space constrained environments, so it makes sense not to
// duplicate the ctype table.
typedef uint16_t char_class_type;
Expand Down
2 changes: 1 addition & 1 deletion libcxx/include/__fwd/ios.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ using wios = basic_ios<wchar_t>;
template <class _CharT, class _Traits>
class _LIBCPP_PREFERRED_NAME(ios) _LIBCPP_IF_WIDE_CHARACTERS(_LIBCPP_PREFERRED_NAME(wios)) basic_ios;

#if defined(_NEWLIB_VERSION)
#if _LIBCXX_LIBC_NEWLIB
// On newlib, off_t is 'long int'
using streamoff = long int; // for char_traits in <string>
#else
Expand Down
2 changes: 1 addition & 1 deletion libcxx/include/__locale
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ public:
static const mask xdigit = _ISXDIGIT;
static const mask blank = _ISBLANK;
static const mask __regex_word = 0x8000;
# elif defined(_NEWLIB_VERSION)
# elif _LIBCXX_LIBC_NEWLIB
// Same type as Newlib's _ctype_ array in newlib/libc/include/ctype.h.
typedef char mask;
// In case char is signed, static_cast is needed to avoid warning on
Expand Down
2 changes: 1 addition & 1 deletion libcxx/include/__locale_dir/messages.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@

# if defined(__unix__) || (defined(__APPLE__) && defined(__MACH__))
// Most unix variants have catopen. These are the specific ones that don't.
# if !defined(__BIONIC__) && !defined(_NEWLIB_VERSION) && !defined(__EMSCRIPTEN__)
# if !defined(__BIONIC__) && !_LIBCXX_LIBC_NEWLIB && !defined(__EMSCRIPTEN__)
# define _LIBCPP_HAS_CATOPEN 1
# include <nl_types.h>
# else
Expand Down
4 changes: 2 additions & 2 deletions libcxx/include/fstream
Original file line number Diff line number Diff line change
Expand Up @@ -964,7 +964,7 @@ template <class _CharT, class _Traits>
int basic_filebuf<_CharT, _Traits>::__fseek(FILE* __file, pos_type __offset, int __whence) {
# if defined(_LIBCPP_MSVCRT_LIKE)
return _fseeki64(__file, __offset, __whence);
# elif defined(_NEWLIB_VERSION)
# elif _LIBCXX_LIBC_NEWLIB
return fseek(__file, __offset, __whence);
# else
return ::fseeko(__file, __offset, __whence);
Expand All @@ -975,7 +975,7 @@ template <class _CharT, class _Traits>
typename basic_filebuf<_CharT, _Traits>::pos_type basic_filebuf<_CharT, _Traits>::__ftell(FILE* __file) {
# if defined(_LIBCPP_MSVCRT_LIKE)
return _ftelli64(__file);
# elif defined(_NEWLIB_VERSION)
# elif _LIBCXX_LIBC_NEWLIB
return ftell(__file);
# else
return ftello(__file);
Expand Down
6 changes: 2 additions & 4 deletions libcxx/include/regex
Original file line number Diff line number Diff line change
Expand Up @@ -1004,7 +1004,7 @@ public:
typedef _CharT char_type;
typedef basic_string<char_type> string_type;
typedef locale locale_type;
# if defined(__BIONIC__) || defined(_NEWLIB_VERSION)
# if defined(__BIONIC__) || _LIBCXX_LIBC_NEWLIB
// Originally bionic's ctype_base used its own ctype masks because the
// builtin ctype implementation wasn't in libc++ yet. Bionic's ctype mask
// was only 8 bits wide and already saturated, so it used a wider type here
Expand All @@ -1013,9 +1013,7 @@ public:
// implementation, but this was not updated to match. Since then Android has
// needed to maintain a stable libc++ ABI, and this can't be changed without
// an ABI break.
// We also need this workaround for newlib since _NEWLIB_VERSION is not
// defined yet inside __config, so we can't set the
// _LIBCPP_PROVIDES_DEFAULT_RUNE_TABLE macro. Additionally, newlib is
// We also need this workaround for newlib since newlib is
// often used for space constrained environments, so it makes sense not to
// duplicate the ctype table.
typedef uint16_t char_class_type;
Expand Down
2 changes: 1 addition & 1 deletion libcxx/src/include/config_elast.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
# define _LIBCPP_ELAST ELAST
#elif defined(__LLVM_LIBC__)
// No _LIBCPP_ELAST needed for LLVM libc
#elif defined(_NEWLIB_VERSION)
#elif _LIBCXX_LIBC_NEWLIB
# define _LIBCPP_ELAST __ELASTERROR
#elif defined(__NuttX__)
// No _LIBCPP_ELAST needed on NuttX
Expand Down
2 changes: 1 addition & 1 deletion libcxx/src/locale.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -933,7 +933,7 @@ const ctype<char>::mask* ctype<char>::classic_table() noexcept {
return __pctype_func();
# elif defined(__EMSCRIPTEN__)
return *__ctype_b_loc();
# elif defined(_NEWLIB_VERSION)
# elif _LIBCXX_LIBC_NEWLIB
// Newlib has a 257-entry table in ctype_.c, where (char)0 starts at [1].
return _ctype_ + 1;
# elif defined(_AIX)
Expand Down
4 changes: 2 additions & 2 deletions libcxx/test/libcxx/system_reserved_names.gen.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@

// Test that libc++ doesn't use names that collide with FreeBSD system macros.
// newlib and picolibc also define these macros
#if !defined(__FreeBSD__) && !defined(_NEWLIB_VERSION)
#if !defined(__FreeBSD__) && !_LIBCXX_LIBC_NEWLIB
# define __null_sentinel SYSTEM_RESERVED_NAME
# define __generic SYSTEM_RESERVED_NAME
#endif
Expand Down Expand Up @@ -117,7 +117,7 @@
#endif

// Newlib & picolibc use __input as a parameter name of a64l & l64a
#ifndef _NEWLIB_VERSION
#if !_LIBCXX_LIBC_NEWLIB
# define __input SYSTEM_RESERVED_NAME
#endif
#define __output SYSTEM_RESERVED_NAME
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ int main(int, char**)
// responds with an empty message, which we probably want to
// treat as a failure code otherwise, but we can detect that
// with the preprocessor.
#if defined(_NEWLIB_VERSION)
#if _LIBCXX_LIBC_NEWLIB
const bool is_newlib = true;
#else
const bool is_newlib = false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ int main(int, char**) {
// responds with an empty message, which we probably want to
// treat as a failure code otherwise, but we can detect that
// with the preprocessor.
#if defined(_NEWLIB_VERSION)
#if _LIBCXX_LIBC_NEWLIB
const bool is_newlib = true;
#else
const bool is_newlib = false;
Expand Down
2 changes: 1 addition & 1 deletion libcxx/test/support/platform_support.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
# include <string.h> // strverscmp
#endif

#if defined(_NEWLIB_VERSION) && defined(__STRICT_ANSI__)
#if _LIBCXX_LIBC_NEWLIB && defined(__STRICT_ANSI__)
// Newlib provides this, but in the header it's under __STRICT_ANSI__
extern "C" {
int mkstemp(char*);
Expand Down
1 change: 1 addition & 0 deletions libcxx/utils/ci/run-buildbot
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,7 @@ function test-armv7m-picolibc() {
-DLIBUNWIND_TEST_CONFIG="armv7m-picolibc-libunwind.cfg.in" \
-DCMAKE_C_FLAGS="${flags}" \
-DCMAKE_CXX_FLAGS="${flags}" \
-DRUNTIMES_USE_LIBC=picolibc \
"${@}"

step "Installing compiler-rt"
Expand Down
4 changes: 2 additions & 2 deletions runtimes/cmake/Modules/HandleLibC.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@

include_guard(GLOBAL)

set(RUNTIMES_SUPPORTED_C_LIBRARIES system llvm-libc)
set(RUNTIMES_SUPPORTED_C_LIBRARIES system llvm-libc picolibc newlib)
set(RUNTIMES_USE_LIBC "system" CACHE STRING "Specify C library to use. Supported values are ${RUNTIMES_SUPPORTED_C_LIBRARIES}.")
if (NOT "${RUNTIMES_USE_LIBC}" IN_LIST RUNTIMES_SUPPORTED_C_LIBRARIES)
message(FATAL_ERROR "Unsupported C library: '${RUNTIMES_CXX_ABI}'. Supported values are ${RUNTIMES_SUPPORTED_C_LIBRARIES}.")
message(FATAL_ERROR "Unsupported C library: '${RUNTIMES_USE_LIBC}'. Supported values are ${RUNTIMES_SUPPORTED_C_LIBRARIES}.")
endif()

# Link against a system-provided libc
Expand Down
Loading