heap_kasan.h

Go to the documentation of this file.

/*
 * Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_SYS_HEAP_KASAN_H_
#define ZEPHYR_INCLUDE_SYS_HEAP_KASAN_H_
 
#include <stdint.h>
#include <stddef.h>
#include <zephyr/sys/sys_heap.h>
#include <zephyr/sys/bitarray.h>
#include <zephyr/toolchain.h>
#include <zephyr/init.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if defined(CONFIG_SYS_HEAP_KASAN) || defined(__DOXYGEN__)


#define SYS_HEAP_KASAN_GRANULE             ((size_t)CONFIG_SYS_HEAP_KASAN_GRANULE)

#define SYS_HEAP_KASAN_SHADOW_BITS(_sz)    ((_sz) / SYS_HEAP_KASAN_GRANULE)
#define SYS_HEAP_KASAN_SHADOW_BUNDLES(_sz) DIV_ROUND_UP(SYS_HEAP_KASAN_SHADOW_BITS(_sz), 32)

void heap_kasan_report(uintptr_t addr, size_t size);

void heap_kasan_register(struct sys_heap *heap, sys_bitarray_t *ba);

#define SYS_HEAP_KASAN_ENABLE(_heap_name, _heap_sz) \
        static uint32_t \
                _heap_name##_kasan_bundles[SYS_HEAP_KASAN_SHADOW_BUNDLES(_heap_sz)] __noinit \
                __aligned(4); \
        static sys_bitarray_t _heap_name##_kasan_ba = { \
                .num_bits = SYS_HEAP_KASAN_SHADOW_BITS(_heap_sz), \
                .num_bundles = SYS_HEAP_KASAN_SHADOW_BUNDLES(_heap_sz), \
                .bundles = _heap_name##_kasan_bundles, \
        }; \
        static int _heap_name##_kasan_init_fn(void) \
        { \
                heap_kasan_register(&(_heap_name), &_heap_name##_kasan_ba); \
                return 0; \
        } \
        SYS_INIT(_heap_name##_kasan_init_fn, PRE_KERNEL_1, 0)

#define K_HEAP_KASAN_ENABLE(_heap_name, _heap_sz) \
        static uint32_t _heap_name##_kasan_bundles[SYS_HEAP_KASAN_SHADOW_BUNDLES( \
                MAX(_heap_sz, Z_HEAP_MIN_SIZE))] __noinit __aligned(4); \
        static sys_bitarray_t _heap_name##_kasan_ba = { \
                .num_bits = SYS_HEAP_KASAN_SHADOW_BITS(MAX(_heap_sz, Z_HEAP_MIN_SIZE)), \
                .num_bundles = SYS_HEAP_KASAN_SHADOW_BUNDLES(MAX(_heap_sz, Z_HEAP_MIN_SIZE)), \
                .bundles = _heap_name##_kasan_bundles, \
        }; \
        static int _heap_name##_kasan_init_fn(void) \
        { \
                heap_kasan_register(&(_heap_name).heap, &_heap_name##_kasan_ba); \
                return 0; \
        } \
        SYS_INIT(_heap_name##_kasan_init_fn, PRE_KERNEL_1, 0)

 
#else                                              /* !CONFIG_SYS_HEAP_KASAN */

#define SYS_HEAP_KASAN_ENABLE(_heap_name, _heap_sz) /* no-op */
#define K_HEAP_KASAN_ENABLE(_heap_name, _heap_sz)   /* no-op */
 
#endif /* CONFIG_SYS_HEAP_KASAN */
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_SYS_HEAP_KASAN_H_ */