build: enable ASan for arm64

  This patch defines ASAN_SHADOW_OFFSET for arm64 according to the ASan
documentation. This offset should cover all arm64 VMAs supported by
ASan.

Signed-off-by: Volodymyr Fialko <vfialko@marvell.com>
---
 config/meson.build             | 2 +-
 doc/guides/prog_guide/asan.rst | 2 +-
 lib/eal/common/malloc_elem.h   | 3 +++
 3 files changed, 5 insertions(+), 2 deletions(-)
  

On Mon, Nov 8, 2021 at 2:46 PM Volodymyr Fialko <vfialko@marvell.com> wrote:
>
> This patch defines ASAN_SHADOW_OFFSET for arm64 according to the ASan
> documentation. This offset should cover all arm64 VMAs supported by
> ASan.
>
> Signed-off-by: Volodymyr Fialko <vfialko@marvell.com>
> ---
>  config/meson.build             | 2 +-
>  doc/guides/prog_guide/asan.rst | 2 +-
>  lib/eal/common/malloc_elem.h   | 3 +++
>  3 files changed, 5 insertions(+), 2 deletions(-)
>
> diff --git a/config/meson.build b/config/meson.build
> index 17b5bec406..7eb710c08d 100644
> --- a/config/meson.build
> +++ b/config/meson.build
> @@ -428,7 +428,7 @@ if get_option('b_sanitize') == 'address' or get_option('b_sanitize') == 'address
>          dpdk_extra_ldflags += '-lasan'
>      endif
>
> -    if is_linux and arch_subdir == 'x86' and dpdk_conf.get('RTE_ARCH_64')
> +    if is_linux and arch_subdir in ['x86', 'arm'] and dpdk_conf.get('RTE_ARCH_64')
>          dpdk_conf.set10('RTE_MALLOC_ASAN', true)
>      endif
>  endif
> diff --git a/doc/guides/prog_guide/asan.rst b/doc/guides/prog_guide/asan.rst
> index 6d1b871c93..7a584427dd 100644
> --- a/doc/guides/prog_guide/asan.rst
> +++ b/doc/guides/prog_guide/asan.rst
> @@ -33,7 +33,7 @@ Example::
>      "stty echo" command when an error occurs.
>
>  ASan is aware of DPDK memory allocations, thanks to added instrumentation.
> -This is only enabled on x86_64 at the moment.
> +This is only enabled on x86_64 and arm64 at the moment.

Nit: "only" can be removed now.


>  Other architectures may have to define ASAN_SHADOW_OFFSET.
>
>  Example heap-buffer-overflow error
> diff --git a/lib/eal/common/malloc_elem.h b/lib/eal/common/malloc_elem.h
> index 262d69bb3e..c00c7845ab 100644
> --- a/lib/eal/common/malloc_elem.h
> +++ b/lib/eal/common/malloc_elem.h
> @@ -107,6 +107,9 @@ malloc_elem_cookies_ok(const struct malloc_elem *elem)
>  #ifdef RTE_ARCH_X86_64
>  #define ASAN_SHADOW_OFFSET    0x00007fff8000
>  #endif
> +#ifdef RTE_ARCH_ARM64
> +#define ASAN_SHADOW_OFFSET    0x001000000000
> +#endif

The value lgtm, from gcc:
libsanitizer/asan/asan_mapping.h:static const u64
kAArch64_ShadowOffset64 = 1ULL << 36;
libsanitizer/asan/asan_mapping.h:#    define SHADOW_OFFSET
kAArch64_ShadowOffset64


>
>  #define ASAN_SHADOW_GRAIN_SIZE 8
>  #define ASAN_MEM_FREE_FLAG     0xfd
> --
> 2.25.1
>

Reviewed-by: David Marchand <david.marchand@redhat.com>

I hope ppc will follow soon :-).
  

On Mon, Nov 8, 2021 at 7:16 PM Volodymyr Fialko <vfialko@marvell.com> wrote:
>
> This patch defines ASAN_SHADOW_OFFSET for arm64 according to the ASan
> documentation. This offset should cover all arm64 VMAs supported by
> ASan.
>
> Signed-off-by: Volodymyr Fialko <vfialko@marvell.com>

++ Arm maintainers

Prefer to change the subject to eal/arm64: support ASan

> ---
>  config/meson.build             | 2 +-
>  doc/guides/prog_guide/asan.rst | 2 +-
>  lib/eal/common/malloc_elem.h   | 3 +++
>  3 files changed, 5 insertions(+), 2 deletions(-)
>
> diff --git a/config/meson.build b/config/meson.build
> index 17b5bec406..7eb710c08d 100644
> --- a/config/meson.build
> +++ b/config/meson.build
> @@ -428,7 +428,7 @@ if get_option('b_sanitize') == 'address' or get_option('b_sanitize') == 'address
>          dpdk_extra_ldflags += '-lasan'
>      endif
>
> -    if is_linux and arch_subdir == 'x86' and dpdk_conf.get('RTE_ARCH_64')
> +    if is_linux and arch_subdir in ['x86', 'arm'] and dpdk_conf.get('RTE_ARCH_64')
>          dpdk_conf.set10('RTE_MALLOC_ASAN', true)
>      endif
>  endif
> diff --git a/doc/guides/prog_guide/asan.rst b/doc/guides/prog_guide/asan.rst
> index 6d1b871c93..7a584427dd 100644
> --- a/doc/guides/prog_guide/asan.rst
> +++ b/doc/guides/prog_guide/asan.rst
> @@ -33,7 +33,7 @@ Example::
>      "stty echo" command when an error occurs.
>
>  ASan is aware of DPDK memory allocations, thanks to added instrumentation.
> -This is only enabled on x86_64 at the moment.
> +This is only enabled on x86_64 and arm64 at the moment.
>  Other architectures may have to define ASAN_SHADOW_OFFSET.
>
>  Example heap-buffer-overflow error
> diff --git a/lib/eal/common/malloc_elem.h b/lib/eal/common/malloc_elem.h
> index 262d69bb3e..c00c7845ab 100644
> --- a/lib/eal/common/malloc_elem.h
> +++ b/lib/eal/common/malloc_elem.h
> @@ -107,6 +107,9 @@ malloc_elem_cookies_ok(const struct malloc_elem *elem)
>  #ifdef RTE_ARCH_X86_64
>  #define ASAN_SHADOW_OFFSET    0x00007fff8000
>  #endif
> +#ifdef RTE_ARCH_ARM64
Better to change to "else if" to be more foolproof

> +#define ASAN_SHADOW_OFFSET    0x001000000000

Add a minimal comment on why this value was selected instead of x86
value of 0x00007fff8000


With the above change,

Acked-by: Jerin Jacob <jerinj@marvell.com>


> +#endif


>
>  #define ASAN_SHADOW_GRAIN_SIZE 8
>  #define ASAN_MEM_FREE_FLAG     0xfd
> --
> 2.25.1
>