2013-07-24 07:41:39 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
2012-06-04 03:36:43 +00:00
|
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
2012-05-21 11:12:37 +00:00
|
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
2011-11-20 20:22:51 +00:00
|
|
|
|
2011-12-17 21:45:29 +00:00
|
|
|
/* Implementations of various class and method modifier attributes. */
|
2011-11-20 20:22:51 +00:00
|
|
|
|
2013-07-24 07:41:39 +00:00
|
|
|
#ifndef mozilla_Attributes_h
|
|
|
|
#define mozilla_Attributes_h
|
2011-11-20 20:22:51 +00:00
|
|
|
|
2013-01-22 03:42:15 +00:00
|
|
|
#include "mozilla/Compiler.h"
|
2011-11-20 20:22:51 +00:00
|
|
|
|
2011-12-19 19:45:52 +00:00
|
|
|
/*
|
|
|
|
* MOZ_ALWAYS_INLINE is a macro which expands to tell the compiler that the
|
|
|
|
* method decorated with it must be inlined, even if the compiler thinks
|
2013-10-21 21:34:24 +00:00
|
|
|
* otherwise. This is only a (much) stronger version of the inline hint:
|
2011-12-19 19:45:52 +00:00
|
|
|
* compilers are not guaranteed to respect it (although they're much more likely
|
|
|
|
* to do so).
|
2013-04-19 17:55:34 +00:00
|
|
|
*
|
|
|
|
* The MOZ_ALWAYS_INLINE_EVEN_DEBUG macro is yet stronger. It tells the
|
|
|
|
* compiler to inline even in DEBUG builds. It should be used very rarely.
|
2011-12-19 19:45:52 +00:00
|
|
|
*/
|
2013-02-12 13:30:16 +00:00
|
|
|
#if defined(_MSC_VER)
|
2013-04-19 17:55:34 +00:00
|
|
|
# define MOZ_ALWAYS_INLINE_EVEN_DEBUG __forceinline
|
2011-12-19 19:45:52 +00:00
|
|
|
#elif defined(__GNUC__)
|
2013-10-21 21:34:24 +00:00
|
|
|
# define MOZ_ALWAYS_INLINE_EVEN_DEBUG __attribute__((always_inline)) inline
|
2011-12-19 19:45:52 +00:00
|
|
|
#else
|
2013-10-21 21:34:24 +00:00
|
|
|
# define MOZ_ALWAYS_INLINE_EVEN_DEBUG inline
|
2013-04-19 17:55:34 +00:00
|
|
|
#endif
|
|
|
|
|
2013-10-21 21:34:24 +00:00
|
|
|
#if !defined(DEBUG)
|
2013-04-19 17:55:34 +00:00
|
|
|
# define MOZ_ALWAYS_INLINE MOZ_ALWAYS_INLINE_EVEN_DEBUG
|
2013-10-21 21:34:24 +00:00
|
|
|
#elif defined(_MSC_VER) && !defined(__cplusplus)
|
|
|
|
# define MOZ_ALWAYS_INLINE __inline
|
|
|
|
#else
|
|
|
|
# define MOZ_ALWAYS_INLINE inline
|
2011-12-19 19:45:52 +00:00
|
|
|
#endif
|
|
|
|
|
2014-06-10 20:33:39 +00:00
|
|
|
#if defined(_MSC_VER)
|
2011-11-20 20:22:51 +00:00
|
|
|
/*
|
|
|
|
* g++ requires -std=c++0x or -std=gnu++0x to support C++11 functionality
|
|
|
|
* without warnings (functionality used by the macros below). These modes are
|
|
|
|
* detectable by checking whether __GXX_EXPERIMENTAL_CXX0X__ is defined or, more
|
|
|
|
* standardly, by checking whether __cplusplus has a C++11 or greater value.
|
|
|
|
* Current versions of g++ do not correctly set __cplusplus, so we check both
|
|
|
|
* for forward compatibility.
|
2014-06-10 20:33:39 +00:00
|
|
|
*
|
|
|
|
* Even though some versions of MSVC support explicit conversion operators, we
|
|
|
|
* don't indicate support for them here, due to
|
|
|
|
* http://stackoverflow.com/questions/20498142/visual-studio-2013-explicit-keyword-bug
|
2011-11-20 20:22:51 +00:00
|
|
|
*/
|
2014-06-10 20:33:39 +00:00
|
|
|
# define MOZ_HAVE_NEVER_INLINE __declspec(noinline)
|
|
|
|
# define MOZ_HAVE_NORETURN __declspec(noreturn)
|
2015-08-05 08:14:42 +00:00
|
|
|
# if _MSC_VER >= 1900
|
2015-08-20 23:17:18 +00:00
|
|
|
# define MOZ_HAVE_CXX11_CONSTEXPR
|
2015-08-25 07:53:25 +00:00
|
|
|
# define MOZ_HAVE_CXX11_CONSTEXPR_IN_TEMPLATES
|
2015-08-05 08:14:42 +00:00
|
|
|
# define MOZ_HAVE_EXPLICIT_CONVERSION
|
|
|
|
# endif
|
2014-10-10 22:29:56 +00:00
|
|
|
# ifdef __clang__
|
2016-01-28 02:00:32 +00:00
|
|
|
/* clang-cl probably supports explicit conversions. */
|
2015-01-13 05:26:16 +00:00
|
|
|
# if __has_extension(cxx_explicit_conversions)
|
|
|
|
# define MOZ_HAVE_EXPLICIT_CONVERSION
|
|
|
|
# endif
|
2014-10-10 22:29:56 +00:00
|
|
|
# endif
|
2014-06-10 20:33:39 +00:00
|
|
|
#elif defined(__clang__)
|
2011-12-17 21:45:29 +00:00
|
|
|
/*
|
|
|
|
* Per Clang documentation, "Note that marketing version numbers should not
|
|
|
|
* be used to check for language features, as different vendors use different
|
|
|
|
* numbering schemes. Instead, use the feature checking macros."
|
|
|
|
*/
|
|
|
|
# ifndef __has_extension
|
|
|
|
# define __has_extension __has_feature /* compatibility, for older versions of clang */
|
|
|
|
# endif
|
2013-01-08 07:29:00 +00:00
|
|
|
# if __has_extension(cxx_constexpr)
|
|
|
|
# define MOZ_HAVE_CXX11_CONSTEXPR
|
|
|
|
# endif
|
2015-01-13 05:26:16 +00:00
|
|
|
# if __has_extension(cxx_explicit_conversions)
|
|
|
|
# define MOZ_HAVE_EXPLICIT_CONVERSION
|
|
|
|
# endif
|
2011-12-19 19:45:52 +00:00
|
|
|
# if __has_attribute(noinline)
|
|
|
|
# define MOZ_HAVE_NEVER_INLINE __attribute__((noinline))
|
|
|
|
# endif
|
2011-12-17 21:45:29 +00:00
|
|
|
# if __has_attribute(noreturn)
|
|
|
|
# define MOZ_HAVE_NORETURN __attribute__((noreturn))
|
|
|
|
# endif
|
2011-11-20 20:22:51 +00:00
|
|
|
#elif defined(__GNUC__)
|
|
|
|
# if defined(__GXX_EXPERIMENTAL_CXX0X__) || __cplusplus >= 201103L
|
2015-03-28 00:08:12 +00:00
|
|
|
# define MOZ_HAVE_CXX11_CONSTEXPR
|
|
|
|
# if MOZ_GCC_VERSION_AT_LEAST(4, 8, 0)
|
|
|
|
# define MOZ_HAVE_CXX11_CONSTEXPR_IN_TEMPLATES
|
|
|
|
# endif
|
|
|
|
# define MOZ_HAVE_EXPLICIT_CONVERSION
|
2011-11-20 20:22:51 +00:00
|
|
|
# endif
|
2011-12-19 19:45:52 +00:00
|
|
|
# define MOZ_HAVE_NEVER_INLINE __attribute__((noinline))
|
2011-12-17 21:45:29 +00:00
|
|
|
# define MOZ_HAVE_NORETURN __attribute__((noreturn))
|
2011-11-20 20:22:51 +00:00
|
|
|
#endif
|
|
|
|
|
2014-05-06 14:23:08 +00:00
|
|
|
/*
|
|
|
|
* When built with clang analyzer (a.k.a scan-build), define MOZ_HAVE_NORETURN
|
|
|
|
* to mark some false positives
|
|
|
|
*/
|
|
|
|
#ifdef __clang_analyzer__
|
|
|
|
# if __has_extension(attribute_analyzer_noreturn)
|
|
|
|
# define MOZ_HAVE_ANALYZER_NORETURN __attribute__((analyzer_noreturn))
|
|
|
|
# endif
|
|
|
|
#endif
|
|
|
|
|
2013-01-08 07:29:00 +00:00
|
|
|
/*
|
|
|
|
* The MOZ_CONSTEXPR specifier declares that a C++11 compiler can evaluate a
|
|
|
|
* function at compile time. A constexpr function cannot examine any values
|
|
|
|
* except its arguments and can have no side effects except its return value.
|
2013-06-28 21:34:51 +00:00
|
|
|
* The MOZ_CONSTEXPR_VAR specifier tells a C++11 compiler that a variable's
|
|
|
|
* value may be computed at compile time. It should be prefered to just
|
|
|
|
* marking variables as MOZ_CONSTEXPR because if the compiler does not support
|
|
|
|
* constexpr it will fall back to making the variable const, and some compilers
|
|
|
|
* do not accept variables being marked both const and constexpr.
|
2013-01-08 07:29:00 +00:00
|
|
|
*/
|
|
|
|
#ifdef MOZ_HAVE_CXX11_CONSTEXPR
|
|
|
|
# define MOZ_CONSTEXPR constexpr
|
2013-06-28 21:34:51 +00:00
|
|
|
# define MOZ_CONSTEXPR_VAR constexpr
|
2015-03-28 00:08:12 +00:00
|
|
|
# ifdef MOZ_HAVE_CXX11_CONSTEXPR_IN_TEMPLATES
|
|
|
|
# define MOZ_CONSTEXPR_TMPL constexpr
|
|
|
|
# else
|
|
|
|
# define MOZ_CONSTEXPR_TMPL
|
|
|
|
# endif
|
2013-01-08 07:29:00 +00:00
|
|
|
#else
|
|
|
|
# define MOZ_CONSTEXPR /* no support */
|
2013-06-28 21:34:51 +00:00
|
|
|
# define MOZ_CONSTEXPR_VAR const
|
2015-03-28 00:08:12 +00:00
|
|
|
# define MOZ_CONSTEXPR_TMPL
|
2013-01-08 07:29:00 +00:00
|
|
|
#endif
|
|
|
|
|
2015-01-13 05:26:16 +00:00
|
|
|
/*
|
|
|
|
* MOZ_EXPLICIT_CONVERSION is a specifier on a type conversion
|
|
|
|
* overloaded operator that declares that a C++11 compiler should restrict
|
|
|
|
* this operator to allow only explicit type conversions, disallowing
|
|
|
|
* implicit conversions.
|
|
|
|
*
|
|
|
|
* Example:
|
|
|
|
*
|
|
|
|
* template<typename T>
|
|
|
|
* class Ptr
|
|
|
|
* {
|
|
|
|
* T* mPtr;
|
|
|
|
* MOZ_EXPLICIT_CONVERSION operator bool() const
|
|
|
|
* {
|
|
|
|
* return mPtr != nullptr;
|
|
|
|
* }
|
|
|
|
* };
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
#ifdef MOZ_HAVE_EXPLICIT_CONVERSION
|
|
|
|
# define MOZ_EXPLICIT_CONVERSION explicit
|
|
|
|
#else
|
|
|
|
# define MOZ_EXPLICIT_CONVERSION /* no support */
|
|
|
|
#endif
|
|
|
|
|
2011-12-19 19:45:52 +00:00
|
|
|
/*
|
|
|
|
* MOZ_NEVER_INLINE is a macro which expands to tell the compiler that the
|
|
|
|
* method decorated with it must never be inlined, even if the compiler would
|
|
|
|
* otherwise choose to inline the method. Compilers aren't absolutely
|
|
|
|
* guaranteed to support this, but most do.
|
|
|
|
*/
|
|
|
|
#if defined(MOZ_HAVE_NEVER_INLINE)
|
|
|
|
# define MOZ_NEVER_INLINE MOZ_HAVE_NEVER_INLINE
|
|
|
|
#else
|
|
|
|
# define MOZ_NEVER_INLINE /* no support */
|
|
|
|
#endif
|
|
|
|
|
2011-12-17 21:45:29 +00:00
|
|
|
/*
|
|
|
|
* MOZ_NORETURN, specified at the start of a function declaration, indicates
|
|
|
|
* that the given function does not return. (The function definition does not
|
|
|
|
* need to be annotated.)
|
|
|
|
*
|
|
|
|
* MOZ_NORETURN void abort(const char* msg);
|
|
|
|
*
|
|
|
|
* This modifier permits the compiler to optimize code assuming a call to such a
|
|
|
|
* function will never return. It also enables the compiler to avoid spurious
|
|
|
|
* warnings about not initializing variables, or about any other seemingly-dodgy
|
|
|
|
* operations performed after the function returns.
|
|
|
|
*
|
|
|
|
* This modifier does not affect the corresponding function's linking behavior.
|
|
|
|
*/
|
|
|
|
#if defined(MOZ_HAVE_NORETURN)
|
|
|
|
# define MOZ_NORETURN MOZ_HAVE_NORETURN
|
|
|
|
#else
|
|
|
|
# define MOZ_NORETURN /* no support */
|
|
|
|
#endif
|
|
|
|
|
2015-01-27 01:30:19 +00:00
|
|
|
/**
|
|
|
|
* MOZ_COLD tells the compiler that a function is "cold", meaning infrequently
|
|
|
|
* executed. This may lead it to optimize for size more aggressively than speed,
|
|
|
|
* or to allocate the body of the function in a distant part of the text segment
|
|
|
|
* to help keep it from taking up unnecessary icache when it isn't in use.
|
|
|
|
*
|
|
|
|
* Place this attribute at the very beginning of a function definition. For
|
|
|
|
* example, write
|
|
|
|
*
|
|
|
|
* MOZ_COLD int foo();
|
|
|
|
*
|
|
|
|
* or
|
|
|
|
*
|
|
|
|
* MOZ_COLD int foo() { return 42; }
|
|
|
|
*/
|
|
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
|
|
# define MOZ_COLD __attribute__ ((cold))
|
|
|
|
#else
|
|
|
|
# define MOZ_COLD
|
|
|
|
#endif
|
|
|
|
|
2015-02-12 16:37:01 +00:00
|
|
|
/**
|
|
|
|
* MOZ_NONNULL tells the compiler that some of the arguments to a function are
|
|
|
|
* known to be non-null. The arguments are a list of 1-based argument indexes
|
|
|
|
* identifying arguments which are known to be non-null.
|
|
|
|
*
|
|
|
|
* Place this attribute at the very beginning of a function definition. For
|
|
|
|
* example, write
|
|
|
|
*
|
|
|
|
* MOZ_NONNULL(1, 2) int foo(char *p, char *q);
|
|
|
|
*/
|
|
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
|
|
# define MOZ_NONNULL(...) __attribute__ ((nonnull(__VA_ARGS__)))
|
|
|
|
#else
|
|
|
|
# define MOZ_NONNULL(...)
|
|
|
|
#endif
|
|
|
|
|
2014-05-06 14:23:08 +00:00
|
|
|
/*
|
|
|
|
* MOZ_PRETEND_NORETURN_FOR_STATIC_ANALYSIS, specified at the end of a function
|
|
|
|
* declaration, indicates that for the purposes of static analysis, this
|
|
|
|
* function does not return. (The function definition does not need to be
|
|
|
|
* annotated.)
|
|
|
|
*
|
2014-07-11 02:10:17 +00:00
|
|
|
* MOZ_ReportCrash(const char* s, const char* file, int ln)
|
|
|
|
* MOZ_PRETEND_NORETURN_FOR_STATIC_ANALYSIS
|
2014-05-06 14:23:08 +00:00
|
|
|
*
|
|
|
|
* Some static analyzers, like scan-build from clang, can use this information
|
|
|
|
* to eliminate false positives. From the upstream documentation of scan-build:
|
|
|
|
* "This attribute is useful for annotating assertion handlers that actually
|
|
|
|
* can return, but for the purpose of using the analyzer we want to pretend
|
|
|
|
* that such functions do not return."
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
#if defined(MOZ_HAVE_ANALYZER_NORETURN)
|
|
|
|
# define MOZ_PRETEND_NORETURN_FOR_STATIC_ANALYSIS MOZ_HAVE_ANALYZER_NORETURN
|
|
|
|
#else
|
|
|
|
# define MOZ_PRETEND_NORETURN_FOR_STATIC_ANALYSIS /* no support */
|
|
|
|
#endif
|
|
|
|
|
2012-05-05 06:08:32 +00:00
|
|
|
/*
|
|
|
|
* MOZ_ASAN_BLACKLIST is a macro to tell AddressSanitizer (a compile-time
|
2014-01-21 17:51:03 +00:00
|
|
|
* instrumentation shipped with Clang and GCC) to not instrument the annotated
|
|
|
|
* function. Furthermore, it will prevent the compiler from inlining the
|
|
|
|
* function because inlining currently breaks the blacklisting mechanism of
|
|
|
|
* AddressSanitizer.
|
2012-05-05 06:08:32 +00:00
|
|
|
*/
|
2013-10-17 14:29:11 +00:00
|
|
|
#if defined(__has_feature)
|
|
|
|
# if __has_feature(address_sanitizer)
|
2014-01-21 17:51:03 +00:00
|
|
|
# define MOZ_HAVE_ASAN_BLACKLIST
|
2013-10-17 14:29:11 +00:00
|
|
|
# endif
|
2014-01-21 17:51:03 +00:00
|
|
|
#elif defined(__GNUC__)
|
|
|
|
# if defined(__SANITIZE_ADDRESS__)
|
|
|
|
# define MOZ_HAVE_ASAN_BLACKLIST
|
|
|
|
# endif
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#if defined(MOZ_HAVE_ASAN_BLACKLIST)
|
|
|
|
# define MOZ_ASAN_BLACKLIST MOZ_NEVER_INLINE __attribute__((no_sanitize_address))
|
2013-10-17 14:29:11 +00:00
|
|
|
#else
|
|
|
|
# define MOZ_ASAN_BLACKLIST /* nothing */
|
2012-05-05 06:08:32 +00:00
|
|
|
#endif
|
|
|
|
|
2013-10-17 14:29:11 +00:00
|
|
|
/*
|
|
|
|
* MOZ_TSAN_BLACKLIST is a macro to tell ThreadSanitizer (a compile-time
|
|
|
|
* instrumentation shipped with Clang) to not instrument the annotated function.
|
|
|
|
* Furthermore, it will prevent the compiler from inlining the function because
|
|
|
|
* inlining currently breaks the blacklisting mechanism of ThreadSanitizer.
|
|
|
|
*/
|
|
|
|
#if defined(__has_feature)
|
|
|
|
# if __has_feature(thread_sanitizer)
|
|
|
|
# define MOZ_TSAN_BLACKLIST MOZ_NEVER_INLINE __attribute__((no_sanitize_thread))
|
|
|
|
# else
|
|
|
|
# define MOZ_TSAN_BLACKLIST /* nothing */
|
|
|
|
# endif
|
|
|
|
#else
|
|
|
|
# define MOZ_TSAN_BLACKLIST /* nothing */
|
|
|
|
#endif
|
2012-05-05 06:08:32 +00:00
|
|
|
|
2015-03-19 06:56:08 +00:00
|
|
|
/**
|
|
|
|
* MOZ_ALLOCATOR tells the compiler that the function it marks returns either a
|
|
|
|
* "fresh", "pointer-free" block of memory, or nullptr. "Fresh" means that the
|
|
|
|
* block is not pointed to by any other reachable pointer in the program.
|
|
|
|
* "Pointer-free" means that the block contains no pointers to any valid object
|
|
|
|
* in the program. It may be initialized with other (non-pointer) values.
|
|
|
|
*
|
|
|
|
* Placing this attribute on appropriate functions helps GCC analyze pointer
|
|
|
|
* aliasing more accurately in their callers.
|
|
|
|
*
|
|
|
|
* GCC warns if a caller ignores the value returned by a function marked with
|
|
|
|
* MOZ_ALLOCATOR: it is hard to imagine cases where dropping the value returned
|
|
|
|
* by a function that meets the criteria above would be intentional.
|
|
|
|
*
|
|
|
|
* Place this attribute after the argument list and 'this' qualifiers of a
|
|
|
|
* function definition. For example, write
|
|
|
|
*
|
|
|
|
* void *my_allocator(size_t) MOZ_ALLOCATOR;
|
|
|
|
*
|
|
|
|
* or
|
|
|
|
*
|
|
|
|
* void *my_allocator(size_t bytes) MOZ_ALLOCATOR { ... }
|
|
|
|
*/
|
|
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
|
|
# define MOZ_ALLOCATOR __attribute__ ((malloc, warn_unused_result))
|
|
|
|
#else
|
|
|
|
# define MOZ_ALLOCATOR
|
|
|
|
#endif
|
|
|
|
|
2012-03-02 22:18:21 +00:00
|
|
|
/**
|
|
|
|
* MOZ_WARN_UNUSED_RESULT tells the compiler to emit a warning if a function's
|
|
|
|
* return value is not used by the caller.
|
|
|
|
*
|
|
|
|
* Place this attribute at the very beginning of a function definition. For
|
|
|
|
* example, write
|
|
|
|
*
|
|
|
|
* MOZ_WARN_UNUSED_RESULT int foo();
|
|
|
|
*
|
|
|
|
* or
|
|
|
|
*
|
|
|
|
* MOZ_WARN_UNUSED_RESULT int foo() { return 42; }
|
|
|
|
*/
|
|
|
|
#if defined(__GNUC__) || defined(__clang__)
|
|
|
|
# define MOZ_WARN_UNUSED_RESULT __attribute__ ((warn_unused_result))
|
|
|
|
#else
|
|
|
|
# define MOZ_WARN_UNUSED_RESULT
|
|
|
|
#endif
|
|
|
|
|
2015-10-05 04:03:26 +00:00
|
|
|
/**
|
|
|
|
* MOZ_FALLTHROUGH is an annotation to suppress compiler warnings about switch
|
|
|
|
* cases that fall through without a break or return statement. MOZ_FALLTHROUGH
|
2015-12-27 20:27:17 +00:00
|
|
|
* is only needed on cases that have code.
|
|
|
|
*
|
|
|
|
* MOZ_FALLTHROUGH_ASSERT is an annotation to suppress compiler warnings about
|
|
|
|
* switch cases that MOZ_ASSERT(false) (or its alias MOZ_ASSERT_UNREACHABLE) in
|
|
|
|
* debug builds, but intentionally fall through in release builds. See comment
|
|
|
|
* in Assertions.h for more details.
|
2015-10-05 04:03:26 +00:00
|
|
|
*
|
|
|
|
* switch (foo) {
|
|
|
|
* case 1: // These cases have no code. No fallthrough annotations are needed.
|
|
|
|
* case 2:
|
2015-12-27 20:27:17 +00:00
|
|
|
* case 3: // This case has code, so a fallthrough annotation is needed!
|
|
|
|
* foo++;
|
2015-10-05 04:03:26 +00:00
|
|
|
* MOZ_FALLTHROUGH;
|
2015-12-27 20:27:17 +00:00
|
|
|
* case 4:
|
2015-10-05 04:03:26 +00:00
|
|
|
* return foo;
|
2015-12-27 20:27:17 +00:00
|
|
|
*
|
|
|
|
* default:
|
|
|
|
* // This case asserts in debug builds, falls through in release.
|
|
|
|
* MOZ_FALLTHROUGH_ASSERT("Unexpected foo value?!");
|
|
|
|
* case 5:
|
|
|
|
* return 5;
|
2015-10-05 04:03:26 +00:00
|
|
|
* }
|
|
|
|
*/
|
|
|
|
#if defined(__clang__) && __cplusplus >= 201103L
|
|
|
|
/* clang's fallthrough annotations are only available starting in C++11. */
|
|
|
|
# define MOZ_FALLTHROUGH [[clang::fallthrough]]
|
|
|
|
#elif defined(_MSC_VER)
|
|
|
|
/*
|
|
|
|
* MSVC's __fallthrough annotations are checked by /analyze (Code Analysis):
|
|
|
|
* https://msdn.microsoft.com/en-us/library/ms235402%28VS.80%29.aspx
|
|
|
|
*/
|
|
|
|
# include <sal.h>
|
|
|
|
# define MOZ_FALLTHROUGH __fallthrough
|
|
|
|
#else
|
|
|
|
# define MOZ_FALLTHROUGH /* FALLTHROUGH */
|
|
|
|
#endif
|
|
|
|
|
2015-03-19 07:46:40 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
|
2013-03-24 02:14:43 +00:00
|
|
|
/*
|
|
|
|
* The following macros are attributes that support the static analysis plugin
|
|
|
|
* included with Mozilla, and will be implemented (when such support is enabled)
|
|
|
|
* as C++11 attributes. Since such attributes are legal pretty much everywhere
|
|
|
|
* and have subtly different semantics depending on their placement, the
|
|
|
|
* following is a guide on where to place the attributes.
|
|
|
|
*
|
|
|
|
* Attributes that apply to a struct or class precede the name of the class:
|
2015-03-21 16:28:53 +00:00
|
|
|
* (Note that this is different from the placement of final for classes!)
|
2013-03-24 02:14:43 +00:00
|
|
|
*
|
|
|
|
* class MOZ_CLASS_ATTRIBUTE SomeClass {};
|
|
|
|
*
|
|
|
|
* Attributes that apply to functions follow the parentheses and const
|
2015-03-21 16:28:53 +00:00
|
|
|
* qualifiers but precede final, override and the function body:
|
2013-03-24 02:14:43 +00:00
|
|
|
*
|
|
|
|
* void DeclaredFunction() MOZ_FUNCTION_ATTRIBUTE;
|
|
|
|
* void SomeFunction() MOZ_FUNCTION_ATTRIBUTE {}
|
|
|
|
* void PureFunction() const MOZ_FUNCTION_ATTRIBUTE = 0;
|
2015-03-21 16:28:53 +00:00
|
|
|
* void OverriddenFunction() MOZ_FUNCTION_ATTIRBUTE override;
|
2013-03-24 02:14:43 +00:00
|
|
|
*
|
|
|
|
* Attributes that apply to variables or parameters follow the variable's name:
|
|
|
|
*
|
|
|
|
* int variable MOZ_VARIABLE_ATTRIBUTE;
|
|
|
|
*
|
|
|
|
* Attributes that apply to types follow the type name:
|
|
|
|
*
|
|
|
|
* typedef int MOZ_TYPE_ATTRIBUTE MagicInt;
|
|
|
|
* int MOZ_TYPE_ATTRIBUTE someVariable;
|
2014-07-11 02:10:17 +00:00
|
|
|
* int* MOZ_TYPE_ATTRIBUTE magicPtrInt;
|
|
|
|
* int MOZ_TYPE_ATTRIBUTE* ptrToMagicInt;
|
2013-03-24 02:14:43 +00:00
|
|
|
*
|
|
|
|
* Attributes that apply to statements precede the statement:
|
|
|
|
*
|
|
|
|
* MOZ_IF_ATTRIBUTE if (x == 0)
|
2014-07-11 02:10:17 +00:00
|
|
|
* MOZ_DO_ATTRIBUTE do { } while (0);
|
2013-03-24 02:14:43 +00:00
|
|
|
*
|
|
|
|
* Attributes that apply to labels precede the label:
|
|
|
|
*
|
|
|
|
* MOZ_LABEL_ATTRIBUTE target:
|
|
|
|
* goto target;
|
|
|
|
* MOZ_CASE_ATTRIBUTE case 5:
|
|
|
|
* MOZ_DEFAULT_ATTRIBUTE default:
|
|
|
|
*
|
|
|
|
* The static analyses that are performed by the plugin are as follows:
|
|
|
|
*
|
|
|
|
* MOZ_MUST_OVERRIDE: Applies to all C++ member functions. All immediate
|
|
|
|
* subclasses must provide an exact override of this method; if a subclass
|
|
|
|
* does not override this method, the compiler will emit an error. This
|
|
|
|
* attribute is not limited to virtual methods, so if it is applied to a
|
|
|
|
* nonvirtual method and the subclass does not provide an equivalent
|
|
|
|
* definition, the compiler will emit an error.
|
2013-04-12 03:20:02 +00:00
|
|
|
* MOZ_STACK_CLASS: Applies to all classes. Any class with this annotation is
|
|
|
|
* expected to live on the stack, so it is a compile-time error to use it, or
|
|
|
|
* an array of such objects, as a global or static variable, or as the type of
|
2013-05-27 21:04:18 +00:00
|
|
|
* a new expression (unless placement new is being used). If a member of
|
|
|
|
* another class uses this class, or if another class inherits from this
|
|
|
|
* class, then it is considered to be a stack class as well, although this
|
|
|
|
* attribute need not be provided in such cases.
|
2013-05-27 21:05:02 +00:00
|
|
|
* MOZ_NONHEAP_CLASS: Applies to all classes. Any class with this annotation is
|
|
|
|
* expected to live on the stack or in static storage, so it is a compile-time
|
|
|
|
* error to use it, or an array of such objects, as the type of a new
|
2015-08-06 00:38:54 +00:00
|
|
|
* expression. If a member of another class uses this class, or if another
|
|
|
|
* class inherits from this class, then it is considered to be a non-heap class
|
|
|
|
* as well, although this attribute need not be provided in such cases.
|
|
|
|
* MOZ_HEAP_CLASS: Applies to all classes. Any class with this annotation is
|
|
|
|
* expected to live on the heap, so it is a compile-time error to use it, or
|
|
|
|
* an array of such objects, as the type of a variable declaration, or as a
|
|
|
|
* temporary object. If a member of another class uses this class, or if
|
|
|
|
* another class inherits from this class, then it is considered to be a heap
|
|
|
|
* class as well, although this attribute need not be provided in such cases.
|
2015-09-03 15:31:55 +00:00
|
|
|
* MOZ_NON_TEMPORARY_CLASS: Applies to all classes. Any class with this
|
|
|
|
* annotation is expected not to live in a temporary. If a member of another
|
|
|
|
* class uses this class or if another class inherits from this class, then it
|
|
|
|
* is considered to be a non-temporary class as well, although this attribute
|
|
|
|
* need not be provided in such cases.
|
|
|
|
* MOZ_RAII: Applies to all classes. Any class with this annotation is assumed
|
|
|
|
* to be a RAII guard, which is expected to live on the stack in an automatic
|
|
|
|
* allocation. It is prohibited from being allocated in a temporary, static
|
|
|
|
* storage, or on the heap. This is a combination of MOZ_STACK_CLASS and
|
|
|
|
* MOZ_NON_TEMPORARY_CLASS.
|
2014-12-22 23:10:44 +00:00
|
|
|
* MOZ_ONLY_USED_TO_AVOID_STATIC_CONSTRUCTORS: Applies to all classes that are
|
|
|
|
* intended to prevent introducing static initializers. This attribute
|
|
|
|
* currently makes it a compile-time error to instantiate these classes
|
|
|
|
* anywhere other than at the global scope, or as a static member of a class.
|
2015-12-10 16:26:27 +00:00
|
|
|
* In non-debug mode, it also prohibits non-trivial constructors and
|
|
|
|
* destructors.
|
2014-12-22 23:16:16 +00:00
|
|
|
* MOZ_TRIVIAL_CTOR_DTOR: Applies to all classes that must have both a trivial
|
2015-12-10 16:26:27 +00:00
|
|
|
* or constexpr constructor and a trivial destructor. Setting this attribute
|
|
|
|
* on a class makes it a compile-time error for that class to get a
|
|
|
|
* non-trivial constructor or destructor for any reason.
|
2013-12-07 03:23:06 +00:00
|
|
|
* MOZ_HEAP_ALLOCATOR: Applies to any function. This indicates that the return
|
|
|
|
* value is allocated on the heap, and will as a result check such allocations
|
|
|
|
* during MOZ_STACK_CLASS and MOZ_NONHEAP_CLASS annotation checking.
|
2014-05-22 01:31:29 +00:00
|
|
|
* MOZ_IMPLICIT: Applies to constructors. Implicit conversion constructors
|
|
|
|
* are disallowed by default unless they are marked as MOZ_IMPLICIT. This
|
2014-05-22 13:28:06 +00:00
|
|
|
* attribute must be used for constructors which intend to provide implicit
|
2014-05-22 01:31:29 +00:00
|
|
|
* conversions.
|
2014-12-18 20:27:05 +00:00
|
|
|
* MOZ_NO_ARITHMETIC_EXPR_IN_ARGUMENT: Applies to functions. Makes it a compile
|
2014-12-19 18:40:30 +00:00
|
|
|
* time error to pass arithmetic expressions on variables to the function.
|
2015-06-01 18:44:00 +00:00
|
|
|
* MOZ_OWNING_REF: Applies to declarations of pointers to reference counted
|
|
|
|
* types. This attribute tells the compiler that the raw pointer is a strong
|
|
|
|
* reference, where ownership through methods such as AddRef and Release is
|
|
|
|
* managed manually. This can make the compiler ignore these pointers when
|
|
|
|
* validating the usage of pointers otherwise.
|
|
|
|
*
|
|
|
|
* Example uses include owned pointers inside of unions, and pointers stored
|
|
|
|
* in POD types where a using a smart pointer class would make the object
|
|
|
|
* non-POD.
|
|
|
|
* MOZ_NON_OWNING_REF: Applies to declarations of pointers to reference counted
|
|
|
|
* types. This attribute tells the compiler that the raw pointer is a weak
|
|
|
|
* reference, which is ensured to be valid by a guarantee that the reference
|
|
|
|
* will be nulled before the pointer becomes invalid. This can make the compiler
|
2014-12-22 23:16:55 +00:00
|
|
|
* ignore these pointers when validating the usage of pointers otherwise.
|
2015-06-01 18:44:00 +00:00
|
|
|
*
|
|
|
|
* Examples include an mOwner pointer, which is nulled by the owning class's
|
|
|
|
* destructor, and is null-checked before dereferencing.
|
|
|
|
* MOZ_UNSAFE_REF: Applies to declarations of pointers to reference counted types.
|
|
|
|
* Occasionally there are non-owning references which are valid, but do not take
|
|
|
|
* the form of a MOZ_NON_OWNING_REF. Their safety may be dependent on the behaviour
|
|
|
|
* of API consumers. The string argument passed to this macro documents the safety
|
|
|
|
* conditions. This can make the compiler ignore these pointers when validating
|
|
|
|
* the usage of pointers elsewhere.
|
|
|
|
*
|
|
|
|
* Examples include an nsIAtom* member which is known at compile time to point to a
|
|
|
|
* static atom which is valid throughout the lifetime of the program, or an API which
|
|
|
|
* stores a pointer, but doesn't take ownership over it, instead requiring the API
|
|
|
|
* consumer to correctly null the value before it becomes invalid.
|
|
|
|
*
|
|
|
|
* Use of this annotation is discouraged when a strong reference or one of the above
|
|
|
|
* two annotations can be used instead.
|
2014-12-25 20:18:38 +00:00
|
|
|
* MOZ_NO_ADDREF_RELEASE_ON_RETURN: Applies to function declarations. Makes it
|
|
|
|
* a compile time error to call AddRef or Release on the return value of a
|
|
|
|
* function. This is intended to be used with operator->() of our smart
|
|
|
|
* pointer classes to ensure that the refcount of an object wrapped in a
|
|
|
|
* smart pointer is not manipulated directly.
|
2015-07-07 01:42:00 +00:00
|
|
|
* MOZ_MUST_USE: Applies to type declarations. Makes it a compile time error to not
|
|
|
|
* use the return value of a function which has this type. This is intended to be
|
|
|
|
* used with types which it is an error to not use.
|
2015-06-19 23:37:43 +00:00
|
|
|
* MOZ_NEEDS_NO_VTABLE_TYPE: Applies to template class declarations. Makes it
|
|
|
|
* a compile time error to instantiate this template with a type parameter which
|
|
|
|
* has a VTable.
|
2015-06-18 21:37:22 +00:00
|
|
|
* MOZ_NON_MEMMOVABLE: Applies to class declarations for types that are not safe
|
|
|
|
* to be moved in memory using memmove().
|
|
|
|
* MOZ_NEEDS_MEMMOVABLE_TYPE: Applies to template class declarations where the
|
|
|
|
* template arguments are required to be safe to move in memory using
|
|
|
|
* memmove(). Passing MOZ_NON_MEMMOVABLE types to these templates is a
|
|
|
|
* compile time error.
|
2015-07-31 17:59:00 +00:00
|
|
|
* MOZ_INHERIT_TYPE_ANNOTATIONS_FROM_TEMPLATE_ARGS: Applies to template class
|
|
|
|
* declarations where an instance of the template should be considered, for
|
|
|
|
* static analysis purposes, to inherit any type annotations (such as
|
|
|
|
* MOZ_MUST_USE and MOZ_STACK_CLASS) from its template arguments.
|
2015-08-12 14:46:42 +00:00
|
|
|
* MOZ_NON_AUTOABLE: Applies to class declarations. Makes it a compile time error to
|
|
|
|
* use `auto` in place of this type in variable declarations. This is intended to
|
|
|
|
* be used with types which are intended to be implicitly constructed into other
|
|
|
|
* other types before being assigned to variables.
|
2013-03-24 02:14:43 +00:00
|
|
|
*/
|
|
|
|
#ifdef MOZ_CLANG_PLUGIN
|
2013-12-07 03:23:06 +00:00
|
|
|
# define MOZ_MUST_OVERRIDE __attribute__((annotate("moz_must_override")))
|
|
|
|
# define MOZ_STACK_CLASS __attribute__((annotate("moz_stack_class")))
|
|
|
|
# define MOZ_NONHEAP_CLASS __attribute__((annotate("moz_nonheap_class")))
|
2015-08-06 00:38:54 +00:00
|
|
|
# define MOZ_HEAP_CLASS __attribute__((annotate("moz_heap_class")))
|
2015-09-03 15:31:55 +00:00
|
|
|
# define MOZ_NON_TEMPORARY_CLASS __attribute__((annotate("moz_non_temporary_class")))
|
2014-12-22 23:16:16 +00:00
|
|
|
# define MOZ_TRIVIAL_CTOR_DTOR __attribute__((annotate("moz_trivial_ctor_dtor")))
|
|
|
|
# ifdef DEBUG
|
|
|
|
/* in debug builds, these classes do have non-trivial constructors. */
|
|
|
|
# define MOZ_ONLY_USED_TO_AVOID_STATIC_CONSTRUCTORS __attribute__((annotate("moz_global_class")))
|
|
|
|
# else
|
|
|
|
# define MOZ_ONLY_USED_TO_AVOID_STATIC_CONSTRUCTORS __attribute__((annotate("moz_global_class"))) \
|
|
|
|
MOZ_TRIVIAL_CTOR_DTOR
|
|
|
|
# endif
|
2014-05-22 01:31:29 +00:00
|
|
|
# define MOZ_IMPLICIT __attribute__((annotate("moz_implicit")))
|
2014-12-18 20:27:05 +00:00
|
|
|
# define MOZ_NO_ARITHMETIC_EXPR_IN_ARGUMENT __attribute__((annotate("moz_no_arith_expr_in_arg")))
|
2014-12-24 02:17:50 +00:00
|
|
|
# define MOZ_OWNING_REF __attribute__((annotate("moz_strong_ref")))
|
|
|
|
# define MOZ_NON_OWNING_REF __attribute__((annotate("moz_weak_ref")))
|
2015-06-01 18:44:00 +00:00
|
|
|
# define MOZ_UNSAFE_REF(reason) __attribute__((annotate("moz_weak_ref")))
|
2014-12-25 20:18:38 +00:00
|
|
|
# define MOZ_NO_ADDREF_RELEASE_ON_RETURN __attribute__((annotate("moz_no_addref_release_on_return")))
|
2015-07-07 01:42:00 +00:00
|
|
|
# define MOZ_MUST_USE __attribute__((annotate("moz_must_use")))
|
2015-06-19 23:37:43 +00:00
|
|
|
# define MOZ_NEEDS_NO_VTABLE_TYPE __attribute__((annotate("moz_needs_no_vtable_type")))
|
2015-06-18 21:37:22 +00:00
|
|
|
# define MOZ_NON_MEMMOVABLE __attribute__((annotate("moz_non_memmovable")))
|
|
|
|
# define MOZ_NEEDS_MEMMOVABLE_TYPE __attribute__((annotate("moz_needs_memmovable_type")))
|
2015-08-12 14:46:42 +00:00
|
|
|
# define MOZ_INHERIT_TYPE_ANNOTATIONS_FROM_TEMPLATE_ARGS \
|
2015-07-31 17:59:00 +00:00
|
|
|
__attribute__((annotate("moz_inherit_type_annotations_from_template_args")))
|
2015-08-12 14:46:42 +00:00
|
|
|
# define MOZ_NON_AUTOABLE __attribute__((annotate("moz_non_autoable")))
|
2013-12-07 03:23:06 +00:00
|
|
|
/*
|
|
|
|
* It turns out that clang doesn't like void func() __attribute__ {} without a
|
|
|
|
* warning, so use pragmas to disable the warning. This code won't work on GCC
|
|
|
|
* anyways, so the warning is safe to ignore.
|
|
|
|
*/
|
|
|
|
# define MOZ_HEAP_ALLOCATOR \
|
|
|
|
_Pragma("clang diagnostic push") \
|
|
|
|
_Pragma("clang diagnostic ignored \"-Wgcc-compat\"") \
|
|
|
|
__attribute__((annotate("moz_heap_allocator"))) \
|
|
|
|
_Pragma("clang diagnostic pop")
|
2013-03-24 02:14:43 +00:00
|
|
|
#else
|
2013-12-07 03:23:06 +00:00
|
|
|
# define MOZ_MUST_OVERRIDE /* nothing */
|
|
|
|
# define MOZ_STACK_CLASS /* nothing */
|
|
|
|
# define MOZ_NONHEAP_CLASS /* nothing */
|
2015-08-06 00:38:54 +00:00
|
|
|
# define MOZ_HEAP_CLASS /* nothing */
|
2015-09-03 15:31:55 +00:00
|
|
|
# define MOZ_NON_TEMPORARY_CLASS /* nothing */
|
2014-12-22 23:16:16 +00:00
|
|
|
# define MOZ_TRIVIAL_CTOR_DTOR /* nothing */
|
2014-12-22 23:10:44 +00:00
|
|
|
# define MOZ_ONLY_USED_TO_AVOID_STATIC_CONSTRUCTORS /* nothing */
|
2014-05-22 01:31:29 +00:00
|
|
|
# define MOZ_IMPLICIT /* nothing */
|
2014-12-18 20:27:05 +00:00
|
|
|
# define MOZ_NO_ARITHMETIC_EXPR_IN_ARGUMENT /* nothing */
|
2013-12-07 03:23:06 +00:00
|
|
|
# define MOZ_HEAP_ALLOCATOR /* nothing */
|
2014-12-24 02:17:50 +00:00
|
|
|
# define MOZ_OWNING_REF /* nothing */
|
|
|
|
# define MOZ_NON_OWNING_REF /* nothing */
|
2015-01-05 20:46:37 +00:00
|
|
|
# define MOZ_UNSAFE_REF(reason) /* nothing */
|
2014-12-25 20:18:38 +00:00
|
|
|
# define MOZ_NO_ADDREF_RELEASE_ON_RETURN /* nothing */
|
2015-07-07 01:42:00 +00:00
|
|
|
# define MOZ_MUST_USE /* nothing */
|
2015-06-19 23:37:43 +00:00
|
|
|
# define MOZ_NEEDS_NO_VTABLE_TYPE /* nothing */
|
2015-06-18 21:37:22 +00:00
|
|
|
# define MOZ_NON_MEMMOVABLE /* nothing */
|
|
|
|
# define MOZ_NEEDS_MEMMOVABLE_TYPE /* nothing */
|
2015-07-31 17:59:00 +00:00
|
|
|
# define MOZ_INHERIT_TYPE_ANNOTATIONS_FROM_TEMPLATE_ARGS /* nothing */
|
2015-08-12 14:46:42 +00:00
|
|
|
# define MOZ_NON_AUTOABLE /* nothing */
|
2013-03-24 02:14:43 +00:00
|
|
|
#endif /* MOZ_CLANG_PLUGIN */
|
|
|
|
|
2015-09-03 15:31:55 +00:00
|
|
|
#define MOZ_RAII MOZ_NON_TEMPORARY_CLASS MOZ_STACK_CLASS
|
|
|
|
|
2015-08-11 10:45:00 +00:00
|
|
|
/*
|
|
|
|
* MOZ_HAVE_REF_QUALIFIERS is defined for compilers that support C++11's rvalue
|
|
|
|
* qualifier, "&&".
|
|
|
|
*/
|
|
|
|
#if defined(_MSC_VER) && _MSC_VER >= 1900
|
|
|
|
# define MOZ_HAVE_REF_QUALIFIERS
|
|
|
|
#elif defined(__clang__)
|
|
|
|
// All supported Clang versions
|
|
|
|
# define MOZ_HAVE_REF_QUALIFIERS
|
|
|
|
#elif defined(__GNUC__)
|
|
|
|
# include "mozilla/Compiler.h"
|
|
|
|
# if MOZ_GCC_VERSION_AT_LEAST(4, 8, 1)
|
|
|
|
# define MOZ_HAVE_REF_QUALIFIERS
|
|
|
|
# endif
|
|
|
|
#endif
|
|
|
|
|
2011-12-17 21:45:29 +00:00
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
2013-07-24 07:41:39 +00:00
|
|
|
#endif /* mozilla_Attributes_h */
|