[GWP-ASan] Rework utilities (NFC)

[cryptoad]

Summary

Few changes wrt utilities:

• split Check into a platform agnostic condition test and a platform specific termination, for which we introduce the function die.
• add a platform agnostic utilities.cpp that gets the allocation alignment functions original in the platform specific file, as they are reusable by all platforms.

[cryptoad]

Redoing this, arc is being weird.

[hctim]

(commenting to try and front my comments before your new patch)

compiler-rt/lib/gwp_asan/utilities.h

21

nit: prefer GWP_ASAN_ALWAYS_INLINE

compiler-rt/lib/gwp_asan/CMakeLists.txt

 add_compiler_rt_component(gwp_asan)
 
 include_directories(..)
 
 set(GWP_ASAN_SOURCES
   common.cpp
   crash_handler.cpp
   platform_specific/common_posix.cpp
   platform_specific/guarded_pool_allocator_posix.cpp
   platform_specific/mutex_posix.cpp
   platform_specific/utilities_posix.cpp
   guarded_pool_allocator.cpp
   random.cpp
   stack_trace_compressor.cpp
+  utilities.cpp
 )
 
 set(GWP_ASAN_HEADERS
   common.h
   crash_handler.h
   definitions.h
   guarded_pool_allocator.h
   mutex.h

compiler-rt/lib/gwp_asan/platform_specific/utilities_posix.cpp

 #ifdef __BIONIC__
 #include <stdlib.h>
 extern "C" GWP_ASAN_WEAK void android_set_abort_message(const char *);
 #else // __BIONIC__
 #include <stdio.h>
 #endif
 
 namespace gwp_asan {
-
+void die(const char *Message) {
 #ifdef __BIONIC__
-void Check(bool Condition, const char *Message) {
-  if (Condition)
-    return;
   if (&android_set_abort_message != nullptr)
     android_set_abort_message(Message);
   abort();
 }
 #else // __BIONIC__
-void Check(bool Condition, const char *Message) {
-  if (Condition)
-    return;
   fprintf(stderr, "%s", Message);
   __builtin_trap();
 }
 #endif // __BIONIC__
-
-// See `bionic/tests/malloc_test.cpp` in the Android source for documentation
-// regarding their alignment guarantees. We always round up to the closest
-// 8-byte window. As GWP-ASan's malloc(X) can always get exactly an X-sized
-// allocation, an allocation that rounds up to 16-bytes will always be given a
-// 16-byte aligned allocation.
-static size_t alignBionic(size_t RealAllocationSize) {
-  if (RealAllocationSize % 8 == 0)
-    return RealAllocationSize;
-  return RealAllocationSize + 8 - (RealAllocationSize % 8);
-}
-
-static size_t alignPowerOfTwo(size_t RealAllocationSize) {
-  if (RealAllocationSize <= 2)
-    return RealAllocationSize;
-  if (RealAllocationSize <= 4)
-    return 4;
-  if (RealAllocationSize <= 8)
-    return 8;
-  if (RealAllocationSize % 16 == 0)
-    return RealAllocationSize;
-  return RealAllocationSize + 16 - (RealAllocationSize % 16);
-}
-
-#ifdef __BIONIC__
-static constexpr AlignmentStrategy PlatformDefaultAlignment =
-    AlignmentStrategy::BIONIC;
-#else // __BIONIC__
-static constexpr AlignmentStrategy PlatformDefaultAlignment =
-    AlignmentStrategy::POWER_OF_TWO;
-#endif // __BIONIC__
-
-size_t rightAlignedAllocationSize(size_t RealAllocationSize,
-                                  AlignmentStrategy Align) {
-  assert(RealAllocationSize > 0);
-  if (Align == AlignmentStrategy::DEFAULT)
-    Align = PlatformDefaultAlignment;
-
-  switch (Align) {
-  case AlignmentStrategy::BIONIC:
-    return alignBionic(RealAllocationSize);
-  case AlignmentStrategy::POWER_OF_TWO:
-    return alignPowerOfTwo(RealAllocationSize);
-  case AlignmentStrategy::PERFECT:
-    return RealAllocationSize;
-  case AlignmentStrategy::DEFAULT:
-    __builtin_unreachable();
-  }
-  __builtin_unreachable();
-}
-
 } // namespace gwp_asan

compiler-rt/lib/gwp_asan/utilities.h

 //===-- utilities.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
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef GWP_ASAN_UTILITIES_H_
 #define GWP_ASAN_UTILITIES_H_
 
 #include "gwp_asan/definitions.h"
 
 #include <stddef.h>
-#include <stdint.h>
 
 namespace gwp_asan {
-// Checks that `Condition` is true, otherwise fails in a platform-specific way
-// with `Message`.
-void Check(bool Condition, const char *Message);
+// Terminates in a platform-specific way with `Message`.
+void die(const char *Message);
+
+// Checks that `Condition` is true, otherwise dies with `Message`.
+inline void Check(bool Condition, const char *Message) {
+  if (Condition)
+    return;
+  die(Message);
+}
 
 enum class AlignmentStrategy {
   // Default => POWER_OF_TWO on most platforms, BIONIC for Android Bionic.
   DEFAULT,
   POWER_OF_TWO,
   BIONIC,
   PERFECT,
 };
 
 // Returns the real size of a right-aligned allocation.
 size_t rightAlignedAllocationSize(
     size_t RealAllocationSize,
     AlignmentStrategy Align = AlignmentStrategy::DEFAULT);
 } // namespace gwp_asan
 
 #endif // GWP_ASAN_UTILITIES_H_

compiler-rt/lib/gwp_asan/utilities.cpp

 //===-- utilities_posix.cpp -------------------------------------*- 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
 //
 //===----------------------------------------------------------------------===//
 
-#include "gwp_asan/definitions.h"
 #include "gwp_asan/utilities.h"
 
 #include <assert.h>
 
-#ifdef __BIONIC__
-#include <stdlib.h>
-extern "C" GWP_ASAN_WEAK void android_set_abort_message(const char *);
-#else // __BIONIC__
-#include <stdio.h>
-#endif
-
 namespace gwp_asan {
-
-#ifdef __BIONIC__
-void Check(bool Condition, const char *Message) {
-  if (Condition)
-    return;
-  if (&android_set_abort_message != nullptr)
-    android_set_abort_message(Message);
-  abort();
-}
-#else // __BIONIC__
-void Check(bool Condition, const char *Message) {
-  if (Condition)
-    return;
-  fprintf(stderr, "%s", Message);
-  __builtin_trap();
-}
-#endif // __BIONIC__
-
 // See `bionic/tests/malloc_test.cpp` in the Android source for documentation
 // regarding their alignment guarantees. We always round up to the closest
 // 8-byte window. As GWP-ASan's malloc(X) can always get exactly an X-sized
 // allocation, an allocation that rounds up to 16-bytes will always be given a
 // 16-byte aligned allocation.
 static size_t alignBionic(size_t RealAllocationSize) {
   if (RealAllocationSize % 8 == 0)
     return RealAllocationSize;
static size_t alignPowerOfTwo(size_t RealAllocationSize) {
   if (RealAllocationSize % 16 == 0)
     return RealAllocationSize;
   return RealAllocationSize + 16 - (RealAllocationSize % 16);
 }
 
 #ifdef __BIONIC__
 static constexpr AlignmentStrategy PlatformDefaultAlignment =
     AlignmentStrategy::BIONIC;
 #else // __BIONIC__
 static constexpr AlignmentStrategy PlatformDefaultAlignment =
     AlignmentStrategy::POWER_OF_TWO;
 #endif // __BIONIC__
 
 size_t rightAlignedAllocationSize(size_t RealAllocationSize,
                                   AlignmentStrategy Align) {
   assert(RealAllocationSize > 0);
   if (Align == AlignmentStrategy::DEFAULT)
     Align = PlatformDefaultAlignment;
 
   switch (Align) {
   case AlignmentStrategy::BIONIC:
     return alignBionic(RealAllocationSize);
   case AlignmentStrategy::POWER_OF_TWO:
     return alignPowerOfTwo(RealAllocationSize);
   case AlignmentStrategy::PERFECT:
     return RealAllocationSize;
   case AlignmentStrategy::DEFAULT:
     __builtin_unreachable();
   }
   __builtin_unreachable();
 }
-
 } // namespace gwp_asan