libsanitizer/HOWTO_MERGE

   1 In general, merging process should not be very difficult, but we need to
   2 track various ABI changes and GCC-specific patches carefully.  Here is a
   3 general list of actions required to perform the merge:
   4
   5 * Checkout recent GCC tree.
   6 * Run merge.sh script from libsanitizer directory.
   7 * Modify Makefile.am files into asan/tsan/lsan/ubsan/sanitizer_common/interception
   8   directories if needed.  In particular, you may need to add new source files
   9   and remove old ones in source files list, add new flags to {C, CXX}FLAGS if
  10   needed and update DEFS with new defined variables.  You can find these changes
  11   in corresponding CMakeLists.txt and config-ix.cmake files from compiler-rt source
  12   directory.
  13 * Apply all needed GCC-specific patches to libsanitizer (note that some of
  14   them might be already included to upstream).
  15 * Apply all necessary compiler changes.  Be especially careful here, you must
  16   not break ABI between compiler and library.  You can reveal these changes by
  17   inspecting the history of AddressSanitizer.cpp and ThreadSanitizer.cpp files
  18   from LLVM source tree.
  19 * Update ASan testsuite with corresponding tests from lib/asan/tests directory.
  20   Not all tests can be migrated easily, so you don't need them all to be adapted.
  21 * Modify configure.ac file if needed (e.g. if you need to add link against new
  22   library for sanitizer lilbs).
  23 * Add new target platforms in configure.tgt script if needed.
  24 * Bump SONAME for sanitizer libraries in asan/tsan/ubsan libtool-version files
  25   if ABI has changed.
  26 * Regenerate configure script and all Makefiles by autoreconf.  You should use
  27   exactly the same autoconf and automake versions as for other GCC directories (current
  28   versions are written in Makefile.in and configure files).
  29 * Run regression testing on at least three platforms (e.g. x86-linux-gnu, x86_64-linux-gnu,
  30   aarch64-linux-gnu, arm-linux-gnueabi).
  31 * Run {A, UB}San bootstrap on at least three platforms.
  32 * Compare ABI of corresponding libclang_rt-asan and newly build libasan libraries.
  33   You can use a pretty good libabigail tool (https://sourceware.org/libabigail/index.html)
  34   to perform such a comparision.  Note, that the list of exported symbols may differ,
  35   e.g. because libasan currently does not include UBSan runtime.
  36 * Split your changes into logical parts (e.g. raw merge, compiler changes, GCC-specific changes
  37   in libasan, configure/Makefile changes). The review process has O(N^2) complexity, so you
  38   would simplify and probably speed up the review process by doing this.
  39 * Send your patches for review to GCC Patches Mailing List (gcc-patches@gcc.gnu.org).