[ASan] Added __cplusplus guard around the C++ code so it is safe to include asan_mapping.h in assembly files.

[kstoimenov]

Summary

This will avoid addind asan_shadow_defines.h in D114558.

[kstoimenov]

Fixed compile error.

[kstoimenov]

Added an error message.

[kstoimenov]

Fixed message.

[kstoimenov]

Removed quotes.

[kstoimenov]

Lint.

[kstoimenov]

More lint.

[vitalybuka]

compiler-rt/lib/asan/asan_mapping.h

214

can you please clang-format entire file in a separate patch and rebase?

[vitalybuka]

compiler-rt/lib/asan/asan_mapping.h

198–203

actually clangformat in this file + c++ guard is OK

This errors" are probably redundant

[kstoimenov]

[ASan] Ran clang-format on asan_mappings.h.

[kstoimenov]

compiler-rt/lib/asan/asan_mapping.h

198–203

Not sure what you mean by this? What would you like me to do?

214

See D115371.

[vitalybuka]

compiler-rt/lib/asan/asan_mapping.h

198–203

I wanted to say patch as-is was ok.
But errors probably unnecessary as ASAN_SHADOW_SCALE set to 3

[kstoimenov]

After pull.

compiler-rt/lib/asan/asan_mapping.h

 //===-- asan_mapping.h ------------------------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // This file is a part of AddressSanitizer, an address sanity checker.
 //
 // Defines ASan memory mapping.
 //===----------------------------------------------------------------------===//
 #ifndef ASAN_MAPPING_H
 #define ASAN_MAPPING_H
 
-#include "asan_internal.h"
-
 // The full explanation of the memory mapping could be found here:
 // https://github.com/google/sanitizers/wiki/AddressSanitizerAlgorithm
 //
 // Typical shadow mapping on Linux/x86_64 with SHADOW_OFFSET == 0x00007fff8000:
 // || `[0x10007fff8000, 0x7fffffffffff]` || HighMem    ||
 // || `[0x02008fff7000, 0x10007fff7fff]` || HighShadow ||
 // || `[0x00008fff7000, 0x02008fff6fff]` || ShadowGap  ||
 // || `[0x00007fff8000, 0x00008fff6fff]` || LowShadow  ||

 // || `[0x50000000, 0xffffffff]` || HighMem    ||
 // || `[0x3a000000, 0x4fffffff]` || HighShadow ||
 // || `[0x36000000, 0x39ffffff]` || ShadowGap  ||
 // || `[0x30000000, 0x35ffffff]` || LowShadow  ||
 // || `[0x00000000, 0x2fffffff]` || LowMem     ||
 
 #define ASAN_SHADOW_SCALE 3
 
-static const u64 kDefaultShadowSentinel = ~(uptr)0;
-
 #if SANITIZER_FUCHSIA
 #  define ASAN_SHADOW_OFFSET_CONST (0)
 #elif SANITIZER_WORDSIZE == 32
 #  if SANITIZER_ANDROID
 #    define ASAN_SHADOW_OFFSET_DYNAMIC
 #  elif defined(__mips__)
 #    define ASAN_SHADOW_OFFSET_CONST 0x0aaa0000
 #  elif SANITIZER_FREEBSD

 #    define ASAN_SHADOW_OFFSET_CONST 0x0000100000000000
 #  elif defined(__mips64)
 #    define ASAN_SHADOW_OFFSET_CONST 0x0000002000000000
 #  elif defined(__sparc__)
 #    define ASAN_SHADOW_OFFSET_CONST 0x0000080000000000
 #  elif SANITIZER_WINDOWS64
 #    define ASAN_SHADOW_OFFSET_DYNAMIC
 #  else
-#    define ASAN_SHADOW_OFFSET_CONST \
-      0x000000007FFFFFFF & (~0xFFFULL << ASAN_SHADOW_SCALE)
+#    if ASAN_SHADOW_SCALE != 3
+#      error "Value below is based on shadow scale = 3."
+#      error "Original formula was: 0x7FFFFFFF & (~0xFFFULL << SHADOW_SCALE)."
+#    endif
+#    define ASAN_SHADOW_OFFSET_CONST 0x000000007fff8000
 #  endif
 #endif
 
-#if defined(ASAN_SHADOW_OFFSET_CONST)
+#if defined(__cplusplus)
+#  include "asan_internal.h"
+
+static const u64 kDefaultShadowSentinel = ~(uptr)0;
+
+#  if defined(ASAN_SHADOW_OFFSET_CONST)
 static const u64 kConstShadowOffset = ASAN_SHADOW_OFFSET_CONST;
-#  define ASAN_SHADOW_OFFSET kConstShadowOffset
-#elif defined(ASAN_SHADOW_OFFSET_DYNAMIC)
-#  define ASAN_SHADOW_OFFSET __asan_shadow_memory_dynamic_address
-#else
-#  error "ASAN_SHADOW_OFFSET can't be determined."
-#endif
+#    define ASAN_SHADOW_OFFSET kConstShadowOffset
+#  elif defined(ASAN_SHADOW_OFFSET_DYNAMIC)
+#    define ASAN_SHADOW_OFFSET __asan_shadow_memory_dynamic_address
+#  else
+#    error "ASAN_SHADOW_OFFSET can't be determined."
+#  endif
 
-#if SANITIZER_ANDROID && defined(__arm__)
-#  define ASAN_PREMAP_SHADOW 1
-#else
-#  define ASAN_PREMAP_SHADOW 0
-#endif
+#  if SANITIZER_ANDROID && defined(__arm__)
+#    define ASAN_PREMAP_SHADOW 1
+#  else
+#    define ASAN_PREMAP_SHADOW 0
+#  endif
 
-#define ASAN_SHADOW_GRANULARITY (1ULL << ASAN_SHADOW_SCALE)
+#  define ASAN_SHADOW_GRANULARITY (1ULL << ASAN_SHADOW_SCALE)
 
-#define DO_ASAN_MAPPING_PROFILE 0  // Set to 1 to profile the functions below.
+#  define DO_ASAN_MAPPING_PROFILE 0  // Set to 1 to profile the functions below.
 
-#if DO_ASAN_MAPPING_PROFILE
-#  define PROFILE_ASAN_MAPPING() AsanMappingProfile[__LINE__]++;
-#else
-#  define PROFILE_ASAN_MAPPING()
-#endif
+#  if DO_ASAN_MAPPING_PROFILE
+#    define PROFILE_ASAN_MAPPING() AsanMappingProfile[__LINE__]++;
+#  else
+#    define PROFILE_ASAN_MAPPING()
+#  endif
 
 // If 1, all shadow boundaries are constants.
 // Don't set to 1 other than for testing.
-#define ASAN_FIXED_MAPPING 0
+#  define ASAN_FIXED_MAPPING 0
 
 namespace __asan {
 
 extern uptr AsanMappingProfile[];
 
-#if ASAN_FIXED_MAPPING
+#  if ASAN_FIXED_MAPPING
 // Fixed mapping for 64-bit Linux. Mostly used for performance comparison
 // with non-fixed mapping. As of r175253 (Feb 2013) the performance
 // difference between fixed and non-fixed mapping is below the noise level.
 static uptr kHighMemEnd = 0x7fffffffffffULL;
 static uptr kMidMemBeg = 0x3000000000ULL;
 static uptr kMidMemEnd = 0x4fffffffffULL;
-#else
+#  else
 extern uptr kHighMemEnd, kMidMemBeg, kMidMemEnd;  // Initialized in __asan_init.
-#endif
+#  endif
 
 }  // namespace __asan
 
-#if defined(__sparc__) && SANITIZER_WORDSIZE == 64
-#  include "asan_mapping_sparc64.h"
-#else
-#  define MEM_TO_SHADOW(mem) \
+#  if defined(__sparc__) && SANITIZER_WORDSIZE == 64
+#    include "asan_mapping_sparc64.h"
+#  else
+#    define MEM_TO_SHADOW(mem) \
       (((mem) >> ASAN_SHADOW_SCALE) + (ASAN_SHADOW_OFFSET))
 
-#  define kLowMemBeg 0
-#  define kLowMemEnd (ASAN_SHADOW_OFFSET ? ASAN_SHADOW_OFFSET - 1 : 0)
+#    define kLowMemBeg 0
+#    define kLowMemEnd (ASAN_SHADOW_OFFSET ? ASAN_SHADOW_OFFSET - 1 : 0)
 
-#  define kLowShadowBeg ASAN_SHADOW_OFFSET
-#  define kLowShadowEnd MEM_TO_SHADOW(kLowMemEnd)
+#    define kLowShadowBeg ASAN_SHADOW_OFFSET
+#    define kLowShadowEnd MEM_TO_SHADOW(kLowMemEnd)
 
-#  define kHighMemBeg (MEM_TO_SHADOW(kHighMemEnd) + 1)
+#    define kHighMemBeg (MEM_TO_SHADOW(kHighMemEnd) + 1)
 
-#  define kHighShadowBeg MEM_TO_SHADOW(kHighMemBeg)
-#  define kHighShadowEnd MEM_TO_SHADOW(kHighMemEnd)
+#    define kHighShadowBeg MEM_TO_SHADOW(kHighMemBeg)
+#    define kHighShadowEnd MEM_TO_SHADOW(kHighMemEnd)
 
-#  define kMidShadowBeg MEM_TO_SHADOW(kMidMemBeg)
-#  define kMidShadowEnd MEM_TO_SHADOW(kMidMemEnd)
+#    define kMidShadowBeg MEM_TO_SHADOW(kMidMemBeg)
+#    define kMidShadowEnd MEM_TO_SHADOW(kMidMemEnd)
 
 // With the zero shadow base we can not actually map pages starting from 0.
 // This constant is somewhat arbitrary.
-#  define kZeroBaseShadowStart 0
-#  define kZeroBaseMaxShadowStart (1 << 18)
+#    define kZeroBaseShadowStart 0
+#    define kZeroBaseMaxShadowStart (1 << 18)
 
-#  define kShadowGapBeg \
+#    define kShadowGapBeg \
       (kLowShadowEnd ? kLowShadowEnd + 1 : kZeroBaseShadowStart)
-#  define kShadowGapEnd ((kMidMemBeg ? kMidShadowBeg : kHighShadowBeg) - 1)
+#    define kShadowGapEnd ((kMidMemBeg ? kMidShadowBeg : kHighShadowBeg) - 1)
 
-#  define kShadowGap2Beg (kMidMemBeg ? kMidShadowEnd + 1 : 0)
-#  define kShadowGap2End (kMidMemBeg ? kMidMemBeg - 1 : 0)
+#    define kShadowGap2Beg (kMidMemBeg ? kMidShadowEnd + 1 : 0)
+#    define kShadowGap2End (kMidMemBeg ? kMidMemBeg - 1 : 0)
 
-#  define kShadowGap3Beg (kMidMemBeg ? kMidMemEnd + 1 : 0)
-#  define kShadowGap3End (kMidMemBeg ? kHighShadowBeg - 1 : 0)
+#    define kShadowGap3Beg (kMidMemBeg ? kMidMemEnd + 1 : 0)
+#    define kShadowGap3End (kMidMemBeg ? kHighShadowBeg - 1 : 0)
 
 namespace __asan {
 
 static inline bool AddrIsInLowMem(uptr a) {
   PROFILE_ASAN_MAPPING();
   return a <= kLowMemEnd;
 }
 
static inline bool AddrIsInShadowGap(uptr a) {
   // in shadow gap as well.
   if (ASAN_SHADOW_OFFSET == 0)
     return a <= kShadowGapEnd;
   return a >= kShadowGapBeg && a <= kShadowGapEnd;
 }
 
 }  // namespace __asan
 
-#endif
+#  endif
 
 namespace __asan {
 
 static inline uptr MemToShadowSize(uptr size) {
   return size >> ASAN_SHADOW_SCALE;
 }
 
 static inline bool AddrIsInMem(uptr a) {
static inline bool AddressIsPoisoned(uptr a) {
   return false;
 }
 
 // Must be after all calls to PROFILE_ASAN_MAPPING().
 static const uptr kAsanMappingProfileSize = __LINE__;
 
 }  // namespace __asan
 
+#endif  // __cplusplus
+
 #endif  // ASAN_MAPPING_H