summaryrefslogtreecommitdiff
path: root/libsanitizer
diff options
context:
space:
mode:
authorchefmax <chefmax@138bc75d-0d04-0410-961f-82ee72b054a4>2015-10-23 08:50:30 +0000
committerchefmax <chefmax@138bc75d-0d04-0410-961f-82ee72b054a4>2015-10-23 08:50:30 +0000
commit81a55c7293c59e9b0d9a0baed4d57fb894f44a27 (patch)
tree351d702cb624f55df131a0f7077c2a3c613e5262 /libsanitizer
parent304b6b2858b314c196aa02cd567ed17205f8f727 (diff)
downloadgcc-81a55c7293c59e9b0d9a0baed4d57fb894f44a27.tar.gz
Update HOWTO_MERGE file for libsanitizer.
git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@229215 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'libsanitizer')
-rw-r--r--libsanitizer/HOWTO_MERGE49
1 files changed, 31 insertions, 18 deletions
diff --git a/libsanitizer/HOWTO_MERGE b/libsanitizer/HOWTO_MERGE
index 5d68e06789d..d0eca40ec06 100644
--- a/libsanitizer/HOWTO_MERGE
+++ b/libsanitizer/HOWTO_MERGE
@@ -2,25 +2,38 @@ In general, merging process should not be very difficult, but we need to
track various ABI changes and GCC-specific patches carefully. Here is a
general list of actions required to perform the merge:
-- Checkout recent GCC tree.
-- Run merge.sh script from libsanitizer directory.
-- Modify Makefile.am files into asan/tsan/lsan/ubsan/sanitizer_common/interception
+* Checkout recent GCC tree.
+* Run merge.sh script from libsanitizer directory.
+* Modify Makefile.am files into asan/tsan/lsan/ubsan/sanitizer_common/interception
directories if needed. In particular, you may need to add new source files
and remove old ones in source files list, add new flags to {C, CXX}FLAGS if
- needed and update DEFS with new defined variables.
-- Apply all needed GCC-specific patches to libsanitizer (note that some of
+ needed and update DEFS with new defined variables. You can find these changes
+ in corresponding CMakeLists.txt and config-ix.cmake files from compiler-rt source
+ directory.
+* Apply all needed GCC-specific patches to libsanitizer (note that some of
them might be already included to upstream).
-- Apply all necessary compiler changes. Be especially careful here, you must
- not break ABI between compiler and library.
-- Modify configure.ac file if needed (e.g. if you need to add link against new
+* Apply all necessary compiler changes. Be especially careful here, you must
+ not break ABI between compiler and library. You can reveal these changes by
+ inspecting the history of AddressSanitizer.cpp and ThreadSanitizer.cpp files
+ from LLVM source tree.
+* Update ASan testsuite with corresponding tests from lib/asan/tests directory.
+ Not all tests can be migrated easily, so you don't need them all to be adapted.
+* Modify configure.ac file if needed (e.g. if you need to add link against new
library for sanitizer lilbs).
-- Remove unused (deleted by merge) files from all source and include
- directories. Be especially careful with headers, because they aren't listed
- in Makefiles explicitly.
-- Regenerate configure script and all Makefiles by autoreconf. You should use
- exactly the same autotools version as for other GCC directories (current
- version is 2.64, https://www.gnu.org/software/automake/faq/autotools-faq.html
- for details how to install/use it).
-- Run regression testing on at least three platforms (e.g. x86-linux-gnu,
- x86_64-linux-gnu, aarch64-linux-gnu).
-- Run {A, UB}San bootstrap on at least three platforms.
+* Add new target platforms in configure.tgt script if needed.
+* Bump SONAME for sanitizer libraries in asan/tsan/ubsan libtool-version files
+ if ABI has changed.
+* Regenerate configure script and all Makefiles by autoreconf. You should use
+ exactly the same autoconf and automake versions as for other GCC directories (current
+ versions are written in Makefile.in and configure files).
+* Run regression testing on at least three platforms (e.g. x86-linux-gnu, x86_64-linux-gnu,
+ aarch64-linux-gnu, arm-linux-gnueabi).
+* Run {A, UB}San bootstrap on at least three platforms.
+* Compare ABI of corresponding libclang_rt-asan and newly build libasan libraries.
+ You can use a pretty good libabigail tool (https://sourceware.org/libabigail/index.html)
+ to perform such a comparision. Note, that the list of exported symbols may differ,
+ e.g. because libasan currently does not include UBSan runtime.
+* Split your changes into logical parts (e.g. raw merge, compiler changes, GCC-specific changes
+ in libasan, configure/Makefile changes). The review process has O(N^2) complexity, so you
+ would simplify and probably speed up the review process by doing this.
+* Send your patches for review to GCC Patches Mailing List (gcc-patches@gcc.gnu.org).