[libcxxabi] Add macro for changing functions to support the relative vtables ABI

[leonardchan]

Summary

Under the relative vtables ABI, __dynamic_cast will not work since it assumes the vtable pointer is 2 ptrdiff_ts away from the start of the vtable (8-byte offset to top + 8-byte pointer to typeinfo) when it is actually 8 bytes away (4-byte offset to top + 4-byte offset to typeinfo). This adjusts the logic under __dynamic_cast to support this ABI when it's used.

[leonardchan]

Marking WIP for now since (I think for testing), this will require some separate clang changes first.

[leonardchan]

Ok. Ready for review!

[mcgrathr]

Long-term, I think we want this to be keyed entirely on a compiler predefine and not chosen in cmake.

[ldionne]

In D77606#2214538, @mcgrathr wrote:

Long-term, I think we want this to be keyed entirely on a compiler predefine and not chosen in cmake.

Actually, I'd like to use that approach now. @leonardchan is that possible?

[leonardchan]

In D77606#2215442, @ldionne wrote:

In D77606#2214538, @mcgrathr wrote:

Long-term, I think we want this to be keyed entirely on a compiler predefine and not chosen in cmake.

Actually, I'd like to use that approach now. @leonardchan is that possible?

Can do. Something like D85924?

[ldionne]

In D77606#2216493, @leonardchan wrote:

In D77606#2215442, @ldionne wrote:

In D77606#2214538, @mcgrathr wrote:

Long-term, I think we want this to be keyed entirely on a compiler predefine and not chosen in cmake.

Actually, I'd like to use that approach now. @leonardchan is that possible?

Can do. Something like D85924?

Yeah, something like that. I'm not a big fan of the name of the macro, but that's a different story to be discussed in D85924.

[leonardchan]

Update to use the __has_feature(cxx_abi_relative_vtable) macro to check how we should find the dynamic_type.

[mcgrathr]

libcxxabi/src/private_typeinfo.cpp

621

I think this should be const uint32_t* ... and <const uint32_t* const*>.

627

This should also be pointer to const.

[leonardchan]

Update with more consts and clang-formated.

[leonardchan]

*ping* Any more comments on this patch?

[ldionne]

libcxxabi/src/private_typeinfo.cpp

618–622

Just to be clear, is this enabled whenever the compiler *supports* the feature, or whenever the feature is actually turned on?

The former would be incorrect, because any sufficiently recent Clang would take that code path. The latter is what we want.

623

Are you certain this is the only place where code needs changing? For example we seem to extract the vtable in __base_class_type_info::search_above_dst and other functions -- don't they need to be changed too?

[leonardchan]

libcxxabi/src/private_typeinfo.cpp

618–622

The latter, where it's turned on.

623

Thanks for catching this. It took me some time to check and assert what these values should be. Updated to just load 32-bit ints instead of ptrdiff_t.

[ldionne]

libcxxabi/src/private_typeinfo.cpp

632

Can you avoid changing the formatting of this piece of code to make it clear it's unchanged?

[leonardchan]

Removed formatting for existing code.

libcxxabi/CMakeLists.txt

 option(LIBCXXABI_HERMETIC_STATIC_LIBRARY
   "Do not export any symbols from the static library." OFF)
 
 set(LIBCXXABI_TEST_CONFIG "${CMAKE_CURRENT_SOURCE_DIR}/test/lit.site.cfg.in" CACHE STRING
     "The Lit testing configuration to use when running the tests.")
 set(LIBCXXABI_TEST_PARAMS "" CACHE STRING
     "A list of parameters to run the Lit test suite with.")
 
+option(LIBCXXABI_RELATIVE_VTABLES_ABI_ENABLED
+  "Use different configurations of libcxxabi functions supported for the \
+  Relative VTables ABI, which replaces vtable function pointers with offsets \
+  between those virtual functions and the vtable itself." OFF)
+
 #===============================================================================
 # Configure System
 #===============================================================================
 
 # Add path for custom modules
 set(CMAKE_MODULE_PATH
   "${CMAKE_CURRENT_SOURCE_DIR}/cmake"
   "${CMAKE_CURRENT_SOURCE_DIR}/cmake/Modules"
if (LIBCXXABI_HAS_PTHREAD_LIB)
     add_definitions(-D_LIBCXXABI_LINK_PTHREAD_LIB)
   endif()
 endif()
 
 string(REPLACE ";" " " LIBCXXABI_CXX_FLAGS "${LIBCXXABI_CXX_FLAGS}")
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${LIBCXXABI_CXX_FLAGS}")
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${LIBCXXABI_C_FLAGS}")
 
+if (LIBCXXABI_RELATIVE_VTABLES_ABI_ENABLED)
+  add_definitions(-D_LIBCXXABI_RELATIVE_VTABLES_ABI_ENABLED)
+endif()
+
 #===============================================================================
 # Setup Source Code
 #===============================================================================
 
 set(LIBCXXABI_LIBUNWIND_INCLUDES "${LIBCXXABI_LIBUNWIND_INCLUDES}" CACHE PATH
     "Specify path to libunwind includes." FORCE)
 set(LIBCXXABI_LIBUNWIND_PATH "${LIBCXXABI_LIBUNWIND_PATH}" CACHE PATH
     "Specify path to libunwind source." FORCE)

libcxxabi/src/private_typeinfo.cpp

 
 extern "C" _LIBCXXABI_FUNC_VIS void *
 __dynamic_cast(const void *static_ptr, const __class_type_info *static_type,
                const __class_type_info *dst_type,
                std::ptrdiff_t src2dst_offset) {
     // Possible future optimization:  Take advantage of src2dst_offset
 
     // Get (dynamic_ptr, dynamic_type) from static_ptr
-    void **vtable = *static_cast<void ** const *>(static_ptr);
+#ifdef _LIBCXXABI_RELATIVE_VTABLES_ABI_ENABLED
+    // The vtable address will point to the first virtual function, which is 8
+    // bytes after the start of the vtable (4 for the offset from top + 4 for the typeinfo component).
+    uint32_t* vtable = *reinterpret_cast<uint32_t* const*>(static_ptr);
+    uint32_t offset_to_derived = vtable[-2];
+    const void* dynamic_ptr = static_cast<const char*>(static_ptr) + offset_to_derived;
+
+    // The typeinfo component is now a relative offset to a proxy.
+    int32_t offset_to_ti_proxy = static_cast<int32_t>(vtable[-1]);
+    uint8_t *ptr_to_ti_proxy = reinterpret_cast<uint8_t *>(vtable) + offset_to_ti_proxy;
+    const __class_type_info* dynamic_type = *(reinterpret_cast<__class_type_info **>(ptr_to_ti_proxy));
+#else
+    void** vtable = *static_cast<void** const*>(static_ptr);
     ptrdiff_t offset_to_derived = reinterpret_cast<ptrdiff_t>(vtable[-2]);
-    const void* dynamic_ptr = static_cast<const char*>(static_ptr) + offset_to_derived;
-    const __class_type_info* dynamic_type = static_cast<const __class_type_info*>(vtable[-1]);
+    const void* dynamic_ptr =
+        static_cast<const char*>(static_ptr) + offset_to_derived;
+    const __class_type_info* dynamic_type =
+        static_cast<const __class_type_info*>(vtable[-1]);
+#endif
 
     // Initialize answer to nullptr.  This will be changed from the search
     //    results if a non-null answer is found.  Regardless, this is what will
     //    be returned.
     const void* dst_ptr = 0;
     // Initialize info struct for this search.
     __dynamic_cast_info info = {dst_type, static_ptr, static_type, src2dst_offset, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,};