2020-01-22 00:05:08 +08:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This header provides generic wrappers for memory access instrumentation that
|
2022-09-15 23:03:52 +08:00
|
|
|
* the compiler cannot emit for: KASAN, KCSAN, KMSAN.
|
2020-01-22 00:05:08 +08:00
|
|
|
*/
|
|
|
|
#ifndef _LINUX_INSTRUMENTED_H
|
|
|
|
#define _LINUX_INSTRUMENTED_H
|
|
|
|
|
|
|
|
#include <linux/compiler.h>
|
|
|
|
#include <linux/kasan-checks.h>
|
|
|
|
#include <linux/kcsan-checks.h>
|
2022-09-15 23:03:52 +08:00
|
|
|
#include <linux/kmsan-checks.h>
|
2020-01-22 00:05:08 +08:00
|
|
|
#include <linux/types.h>
|
|
|
|
|
|
|
|
/**
|
|
|
|
* instrument_read - instrument regular read access
|
2023-02-27 09:17:00 +08:00
|
|
|
* @v: address of access
|
|
|
|
* @size: size of access
|
2020-01-22 00:05:08 +08:00
|
|
|
*
|
|
|
|
* Instrument a regular read access. The instrumentation should be inserted
|
|
|
|
* before the actual read happens.
|
|
|
|
*/
|
|
|
|
static __always_inline void instrument_read(const volatile void *v, size_t size)
|
|
|
|
{
|
|
|
|
kasan_check_read(v, size);
|
|
|
|
kcsan_check_read(v, size);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* instrument_write - instrument regular write access
|
2023-02-27 09:17:00 +08:00
|
|
|
* @v: address of access
|
|
|
|
* @size: size of access
|
2020-01-22 00:05:08 +08:00
|
|
|
*
|
|
|
|
* Instrument a regular write access. The instrumentation should be inserted
|
|
|
|
* before the actual write happens.
|
|
|
|
*/
|
|
|
|
static __always_inline void instrument_write(const volatile void *v, size_t size)
|
|
|
|
{
|
|
|
|
kasan_check_write(v, size);
|
|
|
|
kcsan_check_write(v, size);
|
|
|
|
}
|
|
|
|
|
2020-07-24 15:00:06 +08:00
|
|
|
/**
|
|
|
|
* instrument_read_write - instrument regular read-write access
|
2023-02-27 09:17:00 +08:00
|
|
|
* @v: address of access
|
|
|
|
* @size: size of access
|
2020-07-24 15:00:06 +08:00
|
|
|
*
|
|
|
|
* Instrument a regular write access. The instrumentation should be inserted
|
|
|
|
* before the actual write happens.
|
|
|
|
*/
|
|
|
|
static __always_inline void instrument_read_write(const volatile void *v, size_t size)
|
|
|
|
{
|
|
|
|
kasan_check_write(v, size);
|
|
|
|
kcsan_check_read_write(v, size);
|
|
|
|
}
|
|
|
|
|
2020-01-22 00:05:08 +08:00
|
|
|
/**
|
|
|
|
* instrument_atomic_read - instrument atomic read access
|
2023-02-27 09:17:00 +08:00
|
|
|
* @v: address of access
|
|
|
|
* @size: size of access
|
2020-01-22 00:05:08 +08:00
|
|
|
*
|
|
|
|
* Instrument an atomic read access. The instrumentation should be inserted
|
|
|
|
* before the actual read happens.
|
|
|
|
*/
|
|
|
|
static __always_inline void instrument_atomic_read(const volatile void *v, size_t size)
|
|
|
|
{
|
|
|
|
kasan_check_read(v, size);
|
|
|
|
kcsan_check_atomic_read(v, size);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* instrument_atomic_write - instrument atomic write access
|
2023-02-27 09:17:00 +08:00
|
|
|
* @v: address of access
|
|
|
|
* @size: size of access
|
2020-01-22 00:05:08 +08:00
|
|
|
*
|
|
|
|
* Instrument an atomic write access. The instrumentation should be inserted
|
|
|
|
* before the actual write happens.
|
|
|
|
*/
|
|
|
|
static __always_inline void instrument_atomic_write(const volatile void *v, size_t size)
|
|
|
|
{
|
|
|
|
kasan_check_write(v, size);
|
|
|
|
kcsan_check_atomic_write(v, size);
|
|
|
|
}
|
|
|
|
|
2020-07-24 15:00:06 +08:00
|
|
|
/**
|
|
|
|
* instrument_atomic_read_write - instrument atomic read-write access
|
2023-02-27 09:17:00 +08:00
|
|
|
* @v: address of access
|
|
|
|
* @size: size of access
|
2020-07-24 15:00:06 +08:00
|
|
|
*
|
|
|
|
* Instrument an atomic read-write access. The instrumentation should be
|
|
|
|
* inserted before the actual write happens.
|
|
|
|
*/
|
|
|
|
static __always_inline void instrument_atomic_read_write(const volatile void *v, size_t size)
|
|
|
|
{
|
|
|
|
kasan_check_write(v, size);
|
|
|
|
kcsan_check_atomic_read_write(v, size);
|
|
|
|
}
|
|
|
|
|
2020-01-22 00:05:08 +08:00
|
|
|
/**
|
|
|
|
* instrument_copy_to_user - instrument reads of copy_to_user
|
2023-02-27 09:17:00 +08:00
|
|
|
* @to: destination address
|
|
|
|
* @from: source address
|
|
|
|
* @n: number of bytes to copy
|
2020-01-22 00:05:08 +08:00
|
|
|
*
|
|
|
|
* Instrument reads from kernel memory, that are due to copy_to_user (and
|
|
|
|
* variants). The instrumentation must be inserted before the accesses.
|
|
|
|
*/
|
|
|
|
static __always_inline void
|
|
|
|
instrument_copy_to_user(void __user *to, const void *from, unsigned long n)
|
|
|
|
{
|
|
|
|
kasan_check_read(from, n);
|
|
|
|
kcsan_check_read(from, n);
|
2022-09-15 23:03:52 +08:00
|
|
|
kmsan_copy_to_user(to, from, n, 0);
|
2020-01-22 00:05:08 +08:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2022-09-15 23:03:37 +08:00
|
|
|
* instrument_copy_from_user_before - add instrumentation before copy_from_user
|
2023-02-27 09:17:00 +08:00
|
|
|
* @to: destination address
|
|
|
|
* @from: source address
|
|
|
|
* @n: number of bytes to copy
|
2020-01-22 00:05:08 +08:00
|
|
|
*
|
|
|
|
* Instrument writes to kernel memory, that are due to copy_from_user (and
|
|
|
|
* variants). The instrumentation should be inserted before the accesses.
|
|
|
|
*/
|
|
|
|
static __always_inline void
|
2022-09-15 23:03:37 +08:00
|
|
|
instrument_copy_from_user_before(const void *to, const void __user *from, unsigned long n)
|
2020-01-22 00:05:08 +08:00
|
|
|
{
|
|
|
|
kasan_check_write(to, n);
|
|
|
|
kcsan_check_write(to, n);
|
|
|
|
}
|
|
|
|
|
2022-09-15 23:03:37 +08:00
|
|
|
/**
|
|
|
|
* instrument_copy_from_user_after - add instrumentation after copy_from_user
|
2023-02-27 09:17:00 +08:00
|
|
|
* @to: destination address
|
|
|
|
* @from: source address
|
|
|
|
* @n: number of bytes to copy
|
|
|
|
* @left: number of bytes not copied (as returned by copy_from_user)
|
2022-09-15 23:03:37 +08:00
|
|
|
*
|
|
|
|
* Instrument writes to kernel memory, that are due to copy_from_user (and
|
|
|
|
* variants). The instrumentation should be inserted after the accesses.
|
|
|
|
*/
|
|
|
|
static __always_inline void
|
|
|
|
instrument_copy_from_user_after(const void *to, const void __user *from,
|
|
|
|
unsigned long n, unsigned long left)
|
|
|
|
{
|
2022-09-15 23:03:52 +08:00
|
|
|
kmsan_unpoison_memory(to, n - left);
|
2022-09-15 23:03:37 +08:00
|
|
|
}
|
|
|
|
|
2022-09-15 23:03:38 +08:00
|
|
|
/**
|
|
|
|
* instrument_get_user() - add instrumentation to get_user()-like macros
|
2023-02-27 09:17:00 +08:00
|
|
|
* @to: destination variable, may not be address-taken
|
2022-09-15 23:03:38 +08:00
|
|
|
*
|
|
|
|
* get_user() and friends are fragile, so it may depend on the implementation
|
|
|
|
* whether the instrumentation happens before or after the data is copied from
|
|
|
|
* the userspace.
|
|
|
|
*/
|
2022-09-15 23:03:52 +08:00
|
|
|
#define instrument_get_user(to) \
|
|
|
|
({ \
|
|
|
|
u64 __tmp = (u64)(to); \
|
|
|
|
kmsan_unpoison_memory(&__tmp, sizeof(__tmp)); \
|
|
|
|
to = __tmp; \
|
2022-09-15 23:03:38 +08:00
|
|
|
})
|
|
|
|
|
2022-09-15 23:03:52 +08:00
|
|
|
|
2022-09-15 23:03:38 +08:00
|
|
|
/**
|
|
|
|
* instrument_put_user() - add instrumentation to put_user()-like macros
|
2023-02-27 09:17:00 +08:00
|
|
|
* @from: source address
|
|
|
|
* @ptr: userspace pointer to copy to
|
|
|
|
* @size: number of bytes to copy
|
2022-09-15 23:03:38 +08:00
|
|
|
*
|
|
|
|
* put_user() and friends are fragile, so it may depend on the implementation
|
|
|
|
* whether the instrumentation happens before or after the data is copied from
|
|
|
|
* the userspace.
|
|
|
|
*/
|
2022-09-15 23:03:52 +08:00
|
|
|
#define instrument_put_user(from, ptr, size) \
|
|
|
|
({ \
|
|
|
|
kmsan_copy_to_user(ptr, &from, sizeof(from), 0); \
|
2022-09-15 23:03:38 +08:00
|
|
|
})
|
|
|
|
|
2020-01-22 00:05:08 +08:00
|
|
|
#endif /* _LINUX_INSTRUMENTED_H */
|