1//===-- Common internal contructs -------------------------------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#ifndef LLVM_LIBC_SRC___SUPPORT_COMMON_H
10#define LLVM_LIBC_SRC___SUPPORT_COMMON_H
11
12#ifndef LIBC_NAMESPACE
13#error "LIBC_NAMESPACE macro is not defined."
14#endif
15
16#include "src/__support/macros/attributes.h"
17#include "src/__support/macros/config.h"
18#include "src/__support/macros/hardening.h"
19#include "src/__support/macros/properties/architectures.h"
20#include "src/__support/macros/properties/compiler.h"
21#include "src/__support/macros/properties/os.h"
22
23#if defined(__APPLE__) || (defined(LIBC_TARGET_OS_IS_WINDOWS) && \
24 defined(LIBC_TARGET_ARCH_IS_X86_32))
25#define LIBC_TARGET_USES_LEADING_UNDERSCORE
26#endif
27
28#ifndef LLVM_LIBC_FUNCTION_ATTR
29#define LLVM_LIBC_FUNCTION_ATTR
30#endif
31
32#ifndef LLVM_LIBC_VARIABLE_ATTR
33#define LLVM_LIBC_VARIABLE_ATTR
34#endif
35
36// clang-format off
37// Allow each function `func` to have extra attributes specified by defining:
38// `LLVM_LIBC_FUNCTION_ATTR_func` macro, which should always start with
39// "LLVM_LIBC_EMPTY, "
40//
41// For examples:
42// #define LLVM_LIBC_FUNCTION_ATTR_memcpy LLVM_LIBC_EMPTY, [[gnu::weak]]
43// #define LLVM_LIBC_FUNCTION_ATTR_memchr LLVM_LIBC_EMPTY, [[gnu::weak]] [[gnu::visibility("default")]]
44// clang-format on
45#define LLVM_LIBC_EMPTY
46
47#define GET_NOTHING(...) 0
48#define GET_SECOND(first, second, ...) second
49#define GET_FIFTH(first, second, third, fourth, fifth, ...) fifth
50#define EXPAND_THEN_SECOND(name) GET_SECOND(name, LLVM_LIBC_EMPTY)
51
52#define LLVM_LIBC_ATTR(name) EXPAND_THEN_SECOND(LLVM_LIBC_FUNCTION_ATTR_##name)
53
54// Export both `func` and `LIBC_NAMESPACE::func` using an alias symbol.
55// This does not work on platfors with LIBC_TARGET_USES_LEADING_UNDERSCORE
56// so there this only exports `_func`.
57#if defined(LIBC_COPT_PUBLIC_PACKAGING) && !defined(LIBC_COMPILER_IS_MSVC)
58#ifndef LIBC_TARGET_USES_LEADING_UNDERSCORE
59#define LLVM_LIBC_FUNCTION_IMPL_4(type, name, arglist, c_alias) \
60 LLVM_LIBC_ATTR(name) \
61 LLVM_LIBC_FUNCTION_ATTR decltype(LIBC_NAMESPACE::name) \
62 __##name##_impl__ asm(c_alias); \
63 decltype(LIBC_NAMESPACE::name) name [[gnu::alias(c_alias)]]; \
64 type __##name##_impl__ arglist
65
66#define LLVM_LIBC_ADD_FUNCTION_C_ALIAS(name, c_alias) \
67 extern "C" LLVM_LIBC_FUNCTION_ATTR decltype(LIBC_NAMESPACE::name) c_alias \
68 [[gnu::alias(#name)]]
69
70#else // LIBC_TARGET_USES_LEADING_UNDERSCORE
71#define LLVM_LIBC_FUNCTION_IMPL_4(type, name, arglist, c_alias) \
72 LLVM_LIBC_ATTR(name) \
73 LLVM_LIBC_FUNCTION_ATTR decltype(LIBC_NAMESPACE::name) name asm( \
74 "_" c_alias); \
75 type name arglist
76
77// clang-format off
78#define LLVM_LIBC_ADD_FUNCTION_C_ALIAS(name, c_alias) \
79 asm(".text\n" \
80 ".global " "_" #c_alias "\n" \
81 ".type " "_" #c_alias ", @function\n" \
82 "_" #c_alias " = " "_" #name "\n")
83// clang-format on
84#endif // LIBC_TARGET_USES_LEADING_UNDERSCORE
85
86#else // LIBC_COPT_PUBLIC_PACKAGING
87#define LLVM_LIBC_FUNCTION_IMPL_4(type, name, arglist, c_alias) \
88 type name arglist
89
90// Add an extra C alias `c_alias` for `LIBC_NAMESPACE::name` at file scope when
91// a function needs multiple exported names (omitted in non-packaging builds).
92#define LLVM_LIBC_ADD_FUNCTION_C_ALIAS(name, c_alias) \
93 extern "C" using __llvm_libc_unused_alias_##c_alias = \
94 decltype(LIBC_NAMESPACE::name)
95
96#endif // LIBC_COPT_PUBLIC_PACKAGING
97
98#define LLVM_LIBC_FUNCTION_IMPL_3(type, name, arglist) \
99 LLVM_LIBC_FUNCTION_IMPL_4(type, name, arglist, #name)
100
101// LLVM_LIBC_FUNCTION(type, name, arglist) is equivalent to
102// LLVM_LIBC_FUNCTION(type, name, arglist, #name)
103#define LLVM_LIBC_FUNCTION(...) \
104 GET_FIFTH(__VA_ARGS__, LLVM_LIBC_FUNCTION_IMPL_4, LLVM_LIBC_FUNCTION_IMPL_3, \
105 GET_NOTHING)(__VA_ARGS__)
106
107// See comment on LLVM_LIBC_FUNCTION_IMPL_4 for why this checks
108// LIBC_TARGET_USES_LEADING_UNDERSCORE.
109#if defined(LIBC_COPT_PUBLIC_PACKAGING) && !defined(LIBC_COMPILER_IS_MSVC)
110#ifndef LIBC_TARGET_USES_LEADING_UNDERSCORE
111#define LLVM_LIBC_VARIABLE_IMPL(type, name) \
112 LLVM_LIBC_ATTR(name) \
113 extern LLVM_LIBC_VARIABLE_ATTR decltype(LIBC_NAMESPACE::name) \
114 __##name##_impl__ asm(#name); \
115 extern decltype(LIBC_NAMESPACE::name) name [[gnu::alias(#name)]]; \
116 type __##name##_impl__
117#else // LIBC_TARGET_USES_LEADING_UNDERSCORE
118#define LLVM_LIBC_VARIABLE_IMPL(type, name) \
119 LLVM_LIBC_ATTR(name) \
120 extern LLVM_LIBC_VARIABLE_ATTR decltype(LIBC_NAMESPACE::name) name asm( \
121 "_" #name); \
122 type name
123#endif // LIBC_TARGET_USES_LEADING_UNDERSCORE
124#else // LIBC_COPT_PUBLIC_PACKAGING
125#define LLVM_LIBC_VARIABLE_IMPL(type, name) type name
126#endif // LIBC_COPT_PUBLIC_PACKAGING
127
128#define LLVM_LIBC_VARIABLE(type, name) LLVM_LIBC_VARIABLE_IMPL(type, name)
129
130#endif // LLVM_LIBC_SRC___SUPPORT_COMMON_H
131