log/detail/config.hpp

0001 /*
0002  *          Copyright Andrey Semashev 2007 - 2015.
0003  * Distributed under the Boost Software License, Version 1.0.
0004  *    (See accompanying file LICENSE_1_0.txt or copy at
0005  *          http://www.boost.org/LICENSE_1_0.txt)
0006  */
0007 /*!
0008  * \file   config.hpp
0009  * \author Andrey Semashev
0010  * \date   08.03.2007
0011  *
0012  * \brief  This header is the Boost.Log library implementation, see the library documentation
0013  *         at http://www.boost.org/doc/libs/release/libs/log/doc/html/index.html. In this file
0014  *         internal configuration macros are defined.
0015  */
0016
0017 #ifndef BOOST_LOG_DETAIL_CONFIG_HPP_INCLUDED_
0018 #define BOOST_LOG_DETAIL_CONFIG_HPP_INCLUDED_
0019
0020 // Try including WinAPI config as soon as possible so that any other headers don't include Windows SDK headers
0021 #if defined(_WIN32) || defined(_WIN64) || defined(__WIN32__) || defined(__TOS_WIN__) || defined(__WINDOWS__)
0022 #include <boost/winapi/config.hpp>
0023 #endif
0024
0025 #include <limits.h> // To bring in libc macros
0026 #include <boost/config.hpp>
0027
0028 // The library requires dynamic_cast in a few places
0029 #if defined(BOOST_NO_RTTI)
0030 #   error Boost.Log: RTTI is required by the library
0031 #endif
0032
0033 #if defined(_MSC_VER) && _MSC_VER >= 1600
0034 #   define BOOST_LOG_HAS_PRAGMA_DETECT_MISMATCH
0035 #endif
0036
0037 #if !defined(BOOST_WINDOWS)
0038 #   ifndef BOOST_LOG_WITHOUT_DEBUG_OUTPUT
0039 #       define BOOST_LOG_WITHOUT_DEBUG_OUTPUT
0040 #   endif
0041 #   ifndef BOOST_LOG_WITHOUT_EVENT_LOG
0042 #       define BOOST_LOG_WITHOUT_EVENT_LOG
0043 #   endif
0044 #endif
0045
0046 #ifdef BOOST_HAS_PRAGMA_ONCE
0047 #pragma once
0048 #endif
0049
0050 #if defined(BOOST_MSVC)
0051     // For some reason MSVC 9.0 fails to link the library if static integral constants are defined in cpp
0052 #   define BOOST_LOG_BROKEN_STATIC_CONSTANTS_LINKAGE
0053 #   if _MSC_VER <= 1310
0054         // MSVC 7.1 sometimes fails to match out-of-class template function definitions with
0055         // their declarations if the return type or arguments of the functions involve typename keyword
0056         // and depend on the template parameters.
0057 #       define BOOST_LOG_BROKEN_TEMPLATE_DEFINITION_MATCHING
0058 #   endif
0059 #   if _MSC_VER <= 1400
0060         // Older MSVC versions reject friend declarations for class template specializations
0061 #       define BOOST_LOG_BROKEN_FRIEND_TEMPLATE_SPECIALIZATIONS
0062 #   endif
0063 #   if _MSC_VER <= 1600
0064         // MSVC up to 10.0 attempts to invoke copy constructor when initializing a const reference from rvalue returned from a function.
0065         // This fails when the returned value cannot be copied (only moved):
0066         //
0067         // class base {};
0068         // class derived : public base { BOOST_MOVABLE_BUT_NOT_COPYABLE(derived) };
0069         // derived foo();
0070         // base const& var = foo(); // attempts to call copy constructor of derived
0071 #       define BOOST_LOG_BROKEN_REFERENCE_FROM_RVALUE_INIT
0072 #   endif
0073 #   if !defined(_STLPORT_VERSION)
0074         // MSVC 9.0 mandates packaging of STL classes, which apparently affects alignment and
0075         // makes alignment_of< T >::value no longer be a power of 2 for types that derive from STL classes.
0076         // This breaks type_with_alignment and everything that relies on it.
0077         // This doesn't happen with non-native STLs, such as STLPort. Strangely, this doesn't show with
0078         // STL classes themselves or most of the user-defined derived classes.
0079         // Not sure if that happens with other MSVC versions.
0080         // See: http://svn.boost.org/trac/boost/ticket/1946
0081 #       define BOOST_LOG_BROKEN_STL_ALIGNMENT
0082 #   endif
0083 #endif
0084
0085 #if defined(BOOST_INTEL) || defined(__SUNPRO_CC)
0086     // Intel compiler and Sun Studio 12.3 have problems with friend declarations for nested class templates
0087 #   define BOOST_LOG_NO_MEMBER_TEMPLATE_FRIENDS
0088 #endif
0089
0090 #if defined(BOOST_MSVC) && BOOST_MSVC <= 1600
0091     // MSVC cannot interpret constant expressions in certain contexts, such as non-type template parameters
0092 #   define BOOST_LOG_BROKEN_CONSTANT_EXPRESSIONS
0093 #endif
0094
0095 #if (defined(BOOST_NO_CXX11_HDR_CODECVT) && BOOST_CXX_VERSION < 201703) || (BOOST_CXX_VERSION >= 202002) || \
0096     (defined(_MSVC_STL_VERSION) && _MSVC_STL_VERSION < 142)
0097     // The compiler does not support std::codecvt<char16_t> and std::codecvt<char32_t> specializations.
0098     // The BOOST_NO_CXX11_HDR_CODECVT means there's no usable <codecvt>, which is slightly different from this macro.
0099     // But in order for <codecvt> to be implemented the std::codecvt specializations have to be implemented as well.
0100     // We need to check the C++ version as well, since <codecvt> is deprecated from C++17 onwards which may cause
0101     // BOOST_NO_CXX11_HDR_CODECVT to be set, even though std::codecvt in <locale> is just fine.
0102     // The std::codecvt<char16_t> and std::codecvt<char32_t> specializations were eventually deprecated in C++20.
0103 #   define BOOST_LOG_NO_CXX11_CODECVT_FACETS
0104 #endif
0105
0106 #if defined(__CYGWIN__)
0107     // Boost.ASIO is broken on Cygwin
0108 #   define BOOST_LOG_NO_ASIO
0109 #endif
0110
0111 #if defined(__VXWORKS__)
0112 #   define BOOST_LOG_NO_GETPGRP
0113 #   define BOOST_LOG_NO_GETSID
0114     // for _WRS_CONFIG_USER_MANAGEMENT used below
0115 #   include <vsbConfig.h>
0116 #endif
0117
0118 #if (!defined(__CRYSTAX__) && defined(__ANDROID__) && (__ANDROID_API__ < 21)) || \
0119      (defined(__VXWORKS__) && !defined(_WRS_CONFIG_USER_MANAGEMENT))
0120 // Until Android API version 21 Google NDK does not provide getpwuid_r
0121 #    define BOOST_LOG_NO_GETPWUID_R
0122 #endif
0123
0124 #if !defined(BOOST_LOG_USE_NATIVE_SYSLOG) && defined(BOOST_LOG_NO_ASIO)
0125 #   ifndef BOOST_LOG_WITHOUT_SYSLOG
0126 #       define BOOST_LOG_WITHOUT_SYSLOG
0127 #   endif
0128 #endif
0129
0130 #if defined(__GNUC__) && (__GNUC__ == 4 && __GNUC_MINOR__ <= 2)
0131     // GCC 4.1 and 4.2 have buggy anonymous namespaces support, which interferes with symbol linkage
0132 #   define BOOST_LOG_ANONYMOUS_NAMESPACE namespace anonymous {} using namespace anonymous; namespace anonymous
0133 #else
0134 #   define BOOST_LOG_ANONYMOUS_NAMESPACE namespace
0135 #endif
0136
0137 #if defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || (defined(__GNUC__) && (__GNUC__ == 4 && __GNUC_MINOR__ <= 6))
0138 // GCC up to 4.6 (inclusively) did not support expanding template argument packs into non-variadic template arguments
0139 #define BOOST_LOG_NO_CXX11_ARG_PACKS_TO_NON_VARIADIC_ARGS_EXPANSION
0140 #endif
0141
0142 #if defined(BOOST_NO_CXX11_CONSTEXPR) || (defined(BOOST_GCC) && (BOOST_GCC / 100) <= 406)
0143 // GCC 4.6 does not support in-class brace initializers for static constexpr array members
0144 #define BOOST_LOG_NO_CXX11_CONSTEXPR_DATA_MEMBER_BRACE_INITIALIZERS
0145 #endif
0146
0147 #if defined(BOOST_NO_CXX11_DEFAULTED_FUNCTIONS) || (defined(BOOST_GCC) && (BOOST_GCC / 100) <= 406)
0148 // GCC 4.6 cannot handle defaulted functions with noexcept specifier or virtual functions
0149 #define BOOST_LOG_NO_CXX11_DEFAULTED_NOEXCEPT_FUNCTIONS
0150 #define BOOST_LOG_NO_CXX11_DEFAULTED_VIRTUAL_FUNCTIONS
0151 #endif
0152
0153 #if defined(BOOST_NO_CXX11_DEFAULTED_FUNCTIONS) || (defined(BOOST_CLANG) && ((__clang_major__ == 3) && (__clang_minor__ <= 1)))
0154 // Clang 3.1 cannot handle a defaulted constexpr constructor in some cases (presumably, if the class contains a member with a constexpr constructor)
0155 #define BOOST_LOG_NO_CXX11_DEFAULTED_CONSTEXPR_CONSTRUCTORS
0156 #endif
0157
0158 // The macro indicates that the compiler does not support C++20 pack expansions in lambda init-captures.
0159 // Early gcc, clang and MSVC versions support C++20 pack expansions in lambda init-captures,
0160 // but define __cpp_init_captures to a lower value.
0161 #if (!defined(__cpp_init_captures) || (__cpp_init_captures < 201803)) && \
0162     !(\
0163         BOOST_CXX_VERSION > 201703 && \
0164         (\
0165             (defined(BOOST_GCC) && (BOOST_GCC >= 90000)) || \
0166             (defined(BOOST_CLANG) && (BOOST_CLANG_VERSION >= 90000)) || \
0167             (defined(BOOST_MSVC) && (BOOST_MSVC >= 1922))\
0168         )\
0169     )
0170 #define BOOST_LOG_NO_CXX20_PACK_EXPANSION_IN_LAMBDA_INIT_CAPTURE
0171 #endif
0172
0173 #if defined(_MSC_VER)
0174 #   define BOOST_LOG_NO_VTABLE __declspec(novtable)
0175 #else
0176 #   define BOOST_LOG_NO_VTABLE
0177 #endif
0178
0179 // An MS-like compilers' extension that allows to optimize away the needless code
0180 #if defined(_MSC_VER)
0181 #   define BOOST_LOG_ASSUME(expr) __assume(expr)
0182 #elif defined(__has_builtin)
0183 // Clang 3.6 adds __builtin_assume, but enabling it causes weird compilation errors, where the compiler
0184 // doesn't see one of attachable_sstream_buf::append overloads. It works fine with Clang 3.7 and later.
0185 #   if __has_builtin(__builtin_assume) && (!defined(__clang__) || (__clang_major__ * 100 + __clang_minor__) >= 307)
0186 #       define BOOST_LOG_ASSUME(expr) __builtin_assume(expr)
0187 #   else
0188 #       define BOOST_LOG_ASSUME(expr)
0189 #   endif
0190 #else
0191 #   define BOOST_LOG_ASSUME(expr)
0192 #endif
0193
0194 // The statement marking unreachable branches of code to avoid warnings
0195 #if defined(BOOST_CLANG)
0196 #   if __has_builtin(__builtin_unreachable)
0197 #       define BOOST_LOG_UNREACHABLE() __builtin_unreachable()
0198 #   endif
0199 #elif defined(__GNUC__)
0200 #   if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
0201 #       define BOOST_LOG_UNREACHABLE() __builtin_unreachable()
0202 #   endif
0203 #elif defined(_MSC_VER)
0204 #   define BOOST_LOG_UNREACHABLE() __assume(0)
0205 #endif
0206 #if !defined(BOOST_LOG_UNREACHABLE)
0207 #   define BOOST_LOG_UNREACHABLE()
0208 #   define BOOST_LOG_UNREACHABLE_RETURN(r) return r
0209 #else
0210 #   define BOOST_LOG_UNREACHABLE_RETURN(r) BOOST_LOG_UNREACHABLE()
0211 #endif
0212
0213 // The macro efficiently returns a local lvalue from a function.
0214 // It employs NRVO, if supported by compiler, or uses a move constructor otherwise.
0215 #if defined(BOOST_HAS_NRVO)
0216 #define BOOST_LOG_NRVO_RESULT(x) x
0217 #else
0218 #define BOOST_LOG_NRVO_RESULT(x) boost::move(x)
0219 #endif
0220
0221 // Some compilers support a special attribute that shows that a function won't return
0222 #if defined(__GNUC__) || (defined(__SUNPRO_CC) && __SUNPRO_CC >= 0x590)
0223     // GCC and Sun Studio 12 support attribute syntax
0224 #   define BOOST_LOG_NORETURN __attribute__((noreturn))
0225 #elif defined (_MSC_VER)
0226     // Microsoft-compatible compilers go here
0227 #   define BOOST_LOG_NORETURN __declspec(noreturn)
0228 #else
0229     // The rest compilers might emit bogus warnings about missing return statements
0230     // in functions with non-void return types when throw_exception is used.
0231 #   define BOOST_LOG_NORETURN
0232 #endif
0233
0234 // Some compilers may require marking types that may alias other types
0235 #define BOOST_LOG_MAY_ALIAS BOOST_MAY_ALIAS
0236
0237 #if !defined(BOOST_LOG_BUILDING_THE_LIB)
0238
0239 // Detect if we're dealing with dll
0240 #   if defined(BOOST_LOG_DYN_LINK) || defined(BOOST_ALL_DYN_LINK)
0241 #       define BOOST_LOG_DLL
0242 #   endif
0243
0244 #   if defined(BOOST_LOG_DLL)
0245 #       define BOOST_LOG_API BOOST_SYMBOL_IMPORT
0246 #   else
0247 #       define BOOST_LOG_API
0248 #   endif
0249 //
0250 // Automatically link to the correct build variant where possible.
0251 //
0252 #   if !defined(BOOST_ALL_NO_LIB)
0253 #       if !defined(BOOST_LOG_NO_LIB)
0254 #          define BOOST_LIB_NAME boost_log
0255 #          if defined(BOOST_LOG_DLL)
0256 #              define BOOST_DYN_LINK
0257 #          endif
0258 #          include <boost/config/auto_link.hpp>
0259 #       endif
0260         // In static-library builds compilers ignore auto-link comments from Boost.Log binary to
0261         // other Boost libraries. We explicitly add comments here for other libraries.
0262         // In dynamic-library builds this is not needed.
0263 #       if !defined(BOOST_LOG_DLL)
0264 #           include <boost/filesystem/config.hpp>
0265             // Boost.Thread's config is included below, if needed
0266 #       endif
0267 #   endif  // auto-linking disabled
0268
0269 #else // !defined(BOOST_LOG_BUILDING_THE_LIB)
0270
0271 #   if defined(BOOST_LOG_DLL)
0272 #       define BOOST_LOG_API BOOST_SYMBOL_EXPORT
0273 #   else
0274 #       define BOOST_LOG_API BOOST_SYMBOL_VISIBLE
0275 #   endif
0276
0277 #endif // !defined(BOOST_LOG_BUILDING_THE_LIB)
0278
0279 // By default we provide support for both char and wchar_t
0280 #if !defined(BOOST_LOG_WITHOUT_CHAR)
0281 #   define BOOST_LOG_USE_CHAR
0282 #endif
0283 #if !defined(BOOST_LOG_WITHOUT_WCHAR_T)
0284 #   define BOOST_LOG_USE_WCHAR_T
0285 #endif
0286
0287 #if !defined(BOOST_LOG_DOXYGEN_PASS)
0288     // Check if multithreading is supported
0289 #   if !defined(BOOST_LOG_NO_THREADS) && !defined(BOOST_HAS_THREADS)
0290 #       define BOOST_LOG_NO_THREADS
0291 #   endif // !defined(BOOST_LOG_NO_THREADS) && !defined(BOOST_HAS_THREADS)
0292 #endif // !defined(BOOST_LOG_DOXYGEN_PASS)
0293
0294 #if !defined(BOOST_LOG_NO_THREADS)
0295     // We need this header to (i) enable auto-linking with Boost.Thread and
0296     // (ii) to bring in configuration macros of Boost.Thread.
0297 #   include <boost/thread/detail/config.hpp>
0298 #endif // !defined(BOOST_LOG_NO_THREADS)
0299
0300 #if !defined(BOOST_LOG_NO_THREADS)
0301 #   define BOOST_LOG_EXPR_IF_MT(expr) expr
0302 #else
0303 #   undef BOOST_LOG_USE_COMPILER_TLS
0304 #   define BOOST_LOG_EXPR_IF_MT(expr)
0305 #endif // !defined(BOOST_LOG_NO_THREADS)
0306
0307 #if defined(BOOST_LOG_USE_COMPILER_TLS)
0308 #   if defined(__GNUC__) || defined(__SUNPRO_CC)
0309 #       define BOOST_LOG_TLS __thread
0310 #   elif defined(BOOST_MSVC)
0311 #       define BOOST_LOG_TLS __declspec(thread)
0312 #   else
0313 #       undef BOOST_LOG_USE_COMPILER_TLS
0314 #   endif
0315 #endif // defined(BOOST_LOG_USE_COMPILER_TLS)
0316
0317 #ifndef BOOST_LOG_CPU_CACHE_LINE_SIZE
0318 //! The macro defines the CPU cache line size for the target architecture. This is mostly used for optimization.
0319 #if defined(__s390__) || defined(__s390x__)
0320 #define BOOST_LOG_CPU_CACHE_LINE_SIZE 256
0321 #elif defined(powerpc) || defined(__powerpc__) || defined(__ppc__)
0322 #define BOOST_LOG_CPU_CACHE_LINE_SIZE 128
0323 #else
0324 #define BOOST_LOG_CPU_CACHE_LINE_SIZE 64
0325 #endif
0326 #endif
0327
0328 namespace boost {
0329
0330 // Setup namespace name
0331 #if !defined(BOOST_LOG_DOXYGEN_PASS)
0332 #   if defined(BOOST_LOG_DLL)
0333 #       if defined(BOOST_LOG_NO_THREADS)
0334 #           define BOOST_LOG_VERSION_NAMESPACE v2_st
0335 #       else
0336 #           if defined(BOOST_THREAD_PLATFORM_PTHREAD)
0337 #               define BOOST_LOG_VERSION_NAMESPACE v2_mt_posix
0338 #           elif defined(BOOST_THREAD_PLATFORM_WIN32)
0339 #               if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN8
0340 #                   define BOOST_LOG_VERSION_NAMESPACE v2_mt_nt62
0341 #               elif BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
0342 #                   define BOOST_LOG_VERSION_NAMESPACE v2_mt_nt6
0343 #               else
0344 #                   define BOOST_LOG_VERSION_NAMESPACE v2_mt_nt5
0345 #               endif
0346 #           else
0347 #               define BOOST_LOG_VERSION_NAMESPACE v2_mt
0348 #           endif
0349 #       endif // defined(BOOST_LOG_NO_THREADS)
0350 #   else
0351 #       if defined(BOOST_LOG_NO_THREADS)
0352 #           define BOOST_LOG_VERSION_NAMESPACE v2s_st
0353 #       else
0354 #           if defined(BOOST_THREAD_PLATFORM_PTHREAD)
0355 #               define BOOST_LOG_VERSION_NAMESPACE v2s_mt_posix
0356 #           elif defined(BOOST_THREAD_PLATFORM_WIN32)
0357 #               if BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN8
0358 #                   define BOOST_LOG_VERSION_NAMESPACE v2s_mt_nt62
0359 #               elif BOOST_USE_WINAPI_VERSION >= BOOST_WINAPI_VERSION_WIN6
0360 #                   define BOOST_LOG_VERSION_NAMESPACE v2s_mt_nt6
0361 #               else
0362 #                   define BOOST_LOG_VERSION_NAMESPACE v2s_mt_nt5
0363 #               endif
0364 #           else
0365 #               define BOOST_LOG_VERSION_NAMESPACE v2s_mt
0366 #           endif
0367 #       endif // defined(BOOST_LOG_NO_THREADS)
0368 #   endif // defined(BOOST_LOG_DLL)
0369
0370
0371 namespace log {
0372
0373 #   if !defined(BOOST_NO_CXX11_INLINE_NAMESPACES)
0374
0375 inline namespace BOOST_LOG_VERSION_NAMESPACE {}
0376
0377 #       define BOOST_LOG_OPEN_NAMESPACE namespace log { inline namespace BOOST_LOG_VERSION_NAMESPACE {
0378 #       define BOOST_LOG_CLOSE_NAMESPACE }}
0379
0380 #   elif defined(BOOST_GCC) && (BOOST_GCC >= 40400)
0381
0382 // GCC 7 deprecated strong using directives but allows inline namespaces in C++03 mode since GCC 4.4.
0383 __extension__ inline namespace BOOST_LOG_VERSION_NAMESPACE {}
0384
0385 #       define BOOST_LOG_OPEN_NAMESPACE namespace log { __extension__ inline namespace BOOST_LOG_VERSION_NAMESPACE {
0386 #       define BOOST_LOG_CLOSE_NAMESPACE }}
0387
0388 #   else
0389
0390 namespace BOOST_LOG_VERSION_NAMESPACE {}
0391
0392 using namespace BOOST_LOG_VERSION_NAMESPACE
0393 #       if defined(__GNUC__) && (__GNUC__ >= 4 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 4)) && !defined(__clang__)
0394 __attribute__((__strong__))
0395 #       endif
0396 ;
0397
0398 #       define BOOST_LOG_OPEN_NAMESPACE namespace log { namespace BOOST_LOG_VERSION_NAMESPACE {
0399 #       define BOOST_LOG_CLOSE_NAMESPACE }}
0400 #   endif
0401
0402 } // namespace log
0403
0404 #else // !defined(BOOST_LOG_DOXYGEN_PASS)
0405
0406 namespace log {}
0407 #   define BOOST_LOG_OPEN_NAMESPACE namespace log {
0408 #   define BOOST_LOG_CLOSE_NAMESPACE }
0409
0410 #endif // !defined(BOOST_LOG_DOXYGEN_PASS)
0411
0412 #if defined(BOOST_LOG_HAS_PRAGMA_DETECT_MISMATCH)
0413 #pragma detect_mismatch("boost_log_abi", BOOST_STRINGIZE(BOOST_LOG_VERSION_NAMESPACE))
0414 #endif
0415
0416 } // namespace boost
0417
0418 #endif // BOOST_LOG_DETAIL_CONFIG_HPP_INCLUDED_