Add folly::Expected, an alternative to exceptions for non-throwing APIs that can...
[folly.git] / folly / Portability.h
index a6241feaab0a641b0e1b067e68238d90e124f61d..56dc7c95c2a59c1994f2cde035518a1f512c8374 100644 (file)
  * limitations under the License.
  */
 
-#ifndef FOLLY_PORTABILITY_H_
-#define FOLLY_PORTABILITY_H_
-
-// @nocommit invalidate ccache 20151125 (see #8764509)
+#pragma once
 
 #include <string.h>
 
 #include <cstddef>
 
-#ifndef FOLLY_NO_CONFIG
-#include <folly/folly-config.h>
-#endif
-
-#ifdef FOLLY_PLATFORM_CONFIG
-#include FOLLY_PLATFORM_CONFIG
-#endif
-
-#if FOLLY_HAVE_FEATURES_H
-#include <features.h>
-#endif
+#include <folly/portability/Config.h>
 
 #include <folly/CPortability.h>
 
-#ifdef __APPLE__
-# include <malloc/malloc.h>
-#endif
-
 #if FOLLY_HAVE_SCHED_H
  #include <sched.h>
- #ifndef FOLLY_HAVE_PTHREAD_YIELD
-  #define pthread_yield sched_yield
- #endif
-#endif
-
-#ifndef FOLLY_HAVE_UNALIGNED_READS
-#define FOLLY_HAVE_UNALIGNED_READS 0
 #endif
 
-// A change in folly/MemoryMapping.cpp uses MAP_ANONYMOUS, which is named
-// MAP_ANON on OSX/BSD.
-#if defined(__APPLE__) || defined(__FreeBSD__)
-  #include <sys/mman.h>
-  #ifndef MAP_ANONYMOUS
-    #ifdef MAP_ANON
-      #define MAP_ANONYMOUS MAP_ANON
-    #endif
-  #endif
+// Unaligned loads and stores
+namespace folly {
+#if FOLLY_HAVE_UNALIGNED_ACCESS
+constexpr bool kHasUnalignedAccess = true;
+#else
+constexpr bool kHasUnalignedAccess = false;
 #endif
+}
 
 // compiler specific attribute translation
 // msvc should come first, so if clang is in msvc mode it gets the right defines
 # define FOLLY_DEPRECATED(msg)
 #endif
 
-// noreturn
-#if defined(_MSC_VER)
-# define FOLLY_NORETURN __declspec(noreturn)
-#elif defined(__clang__) || defined(__GNUC__)
-# define FOLLY_NORETURN __attribute__((__noreturn__))
-#else
-# define FOLLY_NORETURN
-#endif
-
 // noinline
 #ifdef _MSC_VER
 # define FOLLY_NOINLINE __declspec(noinline)
 # define FOLLY_ALWAYS_INLINE inline
 #endif
 
+// target
+#ifdef _MSC_VER
+# define FOLLY_TARGET_ATTRIBUTE(target)
+#else
+# define FOLLY_TARGET_ATTRIBUTE(target) __attribute__((__target__(target)))
+#endif
+
 // detection for 64 bit
 #if defined(__x86_64__) || defined(_M_X64)
 # define FOLLY_X64 1
@@ -231,20 +203,10 @@ namespace std { typedef ::max_align_t max_align_t; }
 # error cannot define platform specific thread local storage
 #endif
 
-#if defined(__APPLE__) && (TARGET_IPHONE_SIMULATOR || TARGET_OS_IPHONE)
+#if FOLLY_MOBILE
 #undef FOLLY_TLS
 #endif
 
-// Define to 1 if you have the `preadv' and `pwritev' functions, respectively
-#if !defined(FOLLY_HAVE_PREADV) && !defined(FOLLY_HAVE_PWRITEV)
-# if defined(__GLIBC_PREREQ)
-#  if __GLIBC_PREREQ(2, 10)
-#   define FOLLY_HAVE_PREADV 1
-#   define FOLLY_HAVE_PWRITEV 1
-#  endif
-# endif
-#endif
-
 // It turns out that GNU libstdc++ and LLVM libc++ differ on how they implement
 // the 'std' namespace; the latter uses inline namespaces. Wrap this decision
 // up in a macro to make forward-declarations easier.
@@ -267,14 +229,6 @@ namespace std { typedef ::max_align_t max_align_t; }
 # define FOLLY_GLIBCXX_NAMESPACE_CXX11_END
 #endif
 
-// Some platforms lack clock_gettime(2) and clock_getres(2). Inject our own
-// versions of these into the global namespace.
-#if FOLLY_HAVE_CLOCK_GETTIME
-#include <time.h>
-#else
-#include <folly/detail/Clock.h>
-#endif
-
 // Provide our own std::__throw_* wrappers for platforms that don't have them
 #if FOLLY_HAVE_BITS_FUNCTEXCEPT_H
 #include <bits/functexcept.h>
@@ -307,18 +261,7 @@ namespace std { typedef ::max_align_t max_align_t; }
 // MSVC specific defines
 // mainly for posix compat
 #ifdef _MSC_VER
-
-// this definition is in a really silly place with a silly name
-// and ifdefing it every time we want it is painful
-#include <basetsd.h>
-typedef SSIZE_T ssize_t;
-
-// sprintf semantics are not exactly identical
-// but current usage is not a problem
-# define snprintf _snprintf
-
-// semantics here are identical
-# define strerror_r(errno,buf,len) strerror_s(buf,len,errno)
+#include <folly/portability/SysTypes.h>
 
 // compiler specific to compiler specific
 // nolint
@@ -327,10 +270,9 @@ typedef SSIZE_T ssize_t;
 // Hide a GCC specific thing that breaks MSVC if left alone.
 # define __extension__
 
-#ifdef _M_IX86_FP
-# define FOLLY_SSE _M_IX86_FP
-# define FOLLY_SSE_MINOR 0
-#endif
+// We have compiler support for the newest of the new, but
+// MSVC doesn't tell us that.
+#define __SSE4_2__ 1
 
 #endif
 
@@ -398,64 +340,26 @@ using namespace FOLLY_GFLAGS_NAMESPACE;
 #include <TargetConditionals.h>
 #endif
 
-// MacOS doesn't have malloc_usable_size()
-#if defined(__APPLE__) && !defined(FOLLY_HAVE_MALLOC_USABLE_SIZE)
-inline size_t malloc_usable_size(void* ptr) {
-  return malloc_size(ptr);
-}
-#endif
-
 // RTTI may not be enabled for this compilation unit.
 #if defined(__GXX_RTTI) || defined(__cpp_rtti) || \
     (defined(_MSC_VER) && defined(_CPPRTTI))
 # define FOLLY_HAS_RTTI 1
 #endif
 
-#ifdef _MSC_VER
-# include <intrin.h>
-#endif
-
-namespace folly {
-
-inline void asm_volatile_memory() {
-#if defined(__clang__) || defined(__GNUC__)
-  asm volatile("" : : : "memory");
-#elif defined(_MSC_VER)
-  ::_ReadWriteBarrier();
-#endif
-}
-
-inline void asm_volatile_pause() {
-#if defined(_MSC_VER) && (defined(_M_IX86) || defined(_M_X64))
-  ::_mm_pause();
-#elif defined(__i386__) || FOLLY_X64
-  asm volatile ("pause");
-#elif FOLLY_A64
-  asm volatile ("wfe");
-#elif FOLLY_PPC64
-  asm volatile("or 27,27,27");
-#endif
-}
-inline void asm_pause() {
-#if defined(_MSC_VER) && (defined(_M_IX86) || defined(_M_X64))
-  ::_mm_pause();
-#elif defined(__i386__) || FOLLY_X64
-  asm ("pause");
-#elif FOLLY_A64
-  asm ("wfe");
-#elif FOLLY_PPC64
-  asm ("or 31,31,31");
-#endif
-}
-
 #if defined(__APPLE__) || defined(_MSC_VER)
-#define MAX_STATIC_CONSTRUCTOR_PRIORITY
+#define FOLLY_STATIC_CTOR_PRIORITY_MAX
 #else
 // 101 is the highest priority allowed by the init_priority attribute.
 // This priority is already used by JEMalloc and other memory allocators so
 // we will take the next one.
-#define MAX_STATIC_CONSTRUCTOR_PRIORITY __attribute__ ((__init_priority__(102)))
+#define FOLLY_STATIC_CTOR_PRIORITY_MAX __attribute__((__init_priority__(102)))
 #endif
 
-} // namespace folly
-#endif // FOLLY_PORTABILITY_H_
+namespace folly {
+
+#if defined(__linux__) && !FOLLY_MOBILE
+constexpr auto kIsLinux = true;
+#else
+constexpr auto kIsLinux = false;
+#endif
+}