> -----Original Message----- > From: Peng, ZhihongX <zhihongx.p...@intel.com> > Sent: Friday, October 15, 2021 11:11 PM > To: david.march...@redhat.com; Burakov, Anatoly > <anatoly.bura...@intel.com>; Ananyev, Konstantin > <konstantin.anan...@intel.com>; step...@networkplumber.org; > Dumitrescu, Cristian <cristian.dumitre...@intel.com>; Mcnamara, John > <john.mcnam...@intel.com> > Cc: dev@dpdk.org; Lin, Xueqin <xueqin....@intel.com>; Peng, ZhihongX > <zhihongx.p...@intel.com> > Subject: [PATCH v10 1/4] Enable ASan for memory detector on DPDK > > From: Zhihong Peng <zhihongx.p...@intel.com> > > `AddressSanitizer > <https://github.com/google/sanitizers/wiki/AddressSanitizer>` (ASan) is a > widely-used debugging tool to detect memory access errors. > It helps detect issues like use-after-free, various kinds of buffer overruns > in > C/C++ programs, and other similar errors, as well as printing out detailed > debug information whenever an error is detected. > > We can enable ASan by adding below compilation options: > -Dbuildtype=debug -Db_lundef=false -Db_sanitize=address > "-Dbuildtype=debug": This is a non-essential option. When this option is > added, if a memory error occurs, ASan can clearly show where the code is > wrong. > "-Db_lundef=false": When use clang to compile DPDK, this option must be > added. > > Signed-off-by: Xueqin Lin <xueqin....@intel.com> > Signed-off-by: Zhihong Peng <zhihongx.p...@intel.com> > --- > v7: 1) Split doc and code into two. > 2) Modify asan.rst doc > v8: No change. > v9: 1) Add the check of libasan library. > 2) Add release notes. > v10:1) Split doc and code into two. > 2) Meson supports asan. > --- > config/meson.build | 16 ++++++++++++ > devtools/words-case.txt | 1 + > doc/guides/prog_guide/asan.rst | 35 ++++++++++++++++++++++++++ > doc/guides/prog_guide/index.rst | 1 + > doc/guides/rel_notes/release_21_11.rst | 9 +++++++ > 5 files changed, 62 insertions(+) > create mode 100644 doc/guides/prog_guide/asan.rst > > diff --git a/config/meson.build b/config/meson.build index > 4cdf589e20..a7b71581dd 100644 > --- a/config/meson.build > +++ b/config/meson.build > @@ -411,6 +411,22 @@ if get_option('b_lto') > endif > endif > > +if get_option('b_sanitize') == 'address' or get_option('b_sanitize') == > 'address,undefined' > + if is_windows > + error('ASan is not supported on windows') > + endif > + > + if cc.get_id() == 'gcc' > + asan_dep = cc.find_library('asan', required: true) > + if (not cc.links('int main(int argc, char *argv[]) { return 0; }', > + dependencies: asan_dep)) > + error('broken dependency, "libasan"') > + endif > + add_project_link_arguments('-lasan', language: 'c') > + dpdk_extra_ldflags += '-lasan' > + endif > +endif > + > if get_option('default_library') == 'both' > error( ''' > Unsupported value "both" for "default_library" option. > diff --git a/devtools/words-case.txt b/devtools/words-case.txt index > 0bbad48626..ada6910fa0 100644 > --- a/devtools/words-case.txt > +++ b/devtools/words-case.txt > @@ -5,6 +5,7 @@ API > Arm > armv7 > armv8 > +ASan > BAR > CRC > DCB > diff --git a/doc/guides/prog_guide/asan.rst > b/doc/guides/prog_guide/asan.rst new file mode 100644 index > 0000000000..b732288af3 > --- /dev/null > +++ b/doc/guides/prog_guide/asan.rst > @@ -0,0 +1,35 @@ > +.. Copyright (c) <2021>, Intel Corporation > + All rights reserved. > + > +Memory error detect standard tool - AddressSanitizer(ASan) > +========================================================= > = > + > +`AddressSanitizer > +<https://github.com/google/sanitizers/wiki/AddressSanitizer>` (ASan) is > +a widely-used debugging tool to detect memory access errors. > +It helps detect issues like use-after-free, various kinds of buffer > +overruns in C/C++ programs, and other similar errors, as well as > +printing out detailed debug information whenever an error is detected. > + > +AddressSanitizer is a part of LLVM (3.1+) and GCC (4.8+). > + > +Usage > +----- > + > +meson build > +^^^^^^^^^^^ > + > +To enable ASan in meson build system, use following meson build > command: > + > +Example usage:: > + > + gcc : meson build -Dbuildtype=debug -Db_sanitize=address > + ninja -C build > + clang: meson build -Dbuildtype=debug -Db_lundef=false - > Db_sanitize=address > + ninja -C build > + > +.. Note:: > + > + a) DPDK test has been completed in ubuntu18.04/ubuntu20.04/redhat8.3. > To compile with gcc in > + centos, libasan needs to be installed separately. > + b) If the program uses cmdline, when a memory bug occurs, need to > execute the "stty echo" command. > diff --git a/doc/guides/prog_guide/index.rst > b/doc/guides/prog_guide/index.rst index 2dce507f46..df8a4b93e1 100644 > --- a/doc/guides/prog_guide/index.rst > +++ b/doc/guides/prog_guide/index.rst > @@ -71,3 +71,4 @@ Programmer's Guide > lto > profile_app > glossary > + asan > diff --git a/doc/guides/rel_notes/release_21_11.rst > b/doc/guides/rel_notes/release_21_11.rst > index 4c56cdfeaa..b6c4174dc6 100644 > --- a/doc/guides/rel_notes/release_21_11.rst > +++ b/doc/guides/rel_notes/release_21_11.rst > @@ -159,6 +159,15 @@ New Features > * Added tests to verify tunnel header verification in IPsec inbound. > * Added tests to verify inner checksum. > > +* **Enable ASan for memory detector on DPDK.** > + > + `AddressSanitizer > + <https://github.com/google/sanitizers/wiki/AddressSanitizer>` (ASan) > + is a widely-used debugging tool to detect memory access errors. > + It helps detect issues like use-after-free, various kinds of buffer > + overruns in C/C++ programs, and other similar errors, as well as > + printing out detailed debug information whenever an error is detected. > + > > Removed Items > ------------- > -- > 2.25.1
Hi, David I have compiled passed on the x86/arm/ppc platforms, directory targets as below : build-arm64-bluefield build-arm64-host-clang build-clang-shared build-gcc-shared build-ppc64le-power8 build-arm64-dpaa build-arm64-octeontx2 build-clang-static build-gcc-static build-x86-generic We do not support the windows platform due to standard google document(https://github.com/google/sanitizers/wiki/AddressSanitizer) also not support this. We also sent our cross-compilation log to you in an other email. Passed to run unit test for dpdk-testpmd simple on x86 platform. What else is blocking the process ? What's any action we should do for the code merge? High appreciate for your check and feedback. Thanks!
