1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
|
// SPDX-FileCopyrightText: 2023 Olivier Dion <odion@efficios.com>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
#ifndef _URCU_ANNOTATE_H
#define _URCU_ANNOTATE_H
/*
* urcu/annotate.h
*
* Userspace RCU - annotation header.
*/
/*
* WARNING!
*
* This API is highly experimental. There is zero guarantees of stability
* between releases.
*
* You have been warned.
*/
#include <stdio.h>
#include <stdlib.h>
#include <urcu/compiler.h>
enum cmm_annotate {
CMM_ANNOTATE_VOID,
CMM_ANNOTATE_LOAD,
CMM_ANNOTATE_STORE,
CMM_ANNOTATE_MB,
};
typedef enum cmm_annotate cmm_annotate_t __attribute__((__unused__));
#define cmm_annotate_define(name) \
cmm_annotate_t name = CMM_ANNOTATE_VOID
#ifdef CMM_SANITIZE_THREAD
# ifdef __cplusplus
extern "C" {
# endif
extern void __tsan_acquire(void *);
extern void __tsan_release(void *);
# ifdef __cplusplus
}
# endif
# define cmm_annotate_die(msg) \
do { \
fprintf(stderr, \
"(" __FILE__ ":%s@%u) Annotation ERROR: %s\n", \
__func__, __LINE__, msg); \
abort(); \
} while (0)
/* Only used for typechecking in macros. */
static inline cmm_annotate_t cmm_annotate_dereference(cmm_annotate_t *group)
{
return *group;
}
# define cmm_annotate_group_mb_acquire(group) \
do { \
switch (cmm_annotate_dereference(group)) { \
case CMM_ANNOTATE_VOID: \
break; \
case CMM_ANNOTATE_LOAD: \
break; \
case CMM_ANNOTATE_STORE: \
cmm_annotate_die("store for acquire group"); \
break; \
case CMM_ANNOTATE_MB: \
cmm_annotate_die( \
"redundant mb for acquire group" \
); \
break; \
} \
*(group) = CMM_ANNOTATE_MB; \
} while (0)
# define cmm_annotate_group_mb_release(group) \
do { \
switch (cmm_annotate_dereference(group)) { \
case CMM_ANNOTATE_VOID: \
break; \
case CMM_ANNOTATE_LOAD: \
cmm_annotate_die("load before release group"); \
break; \
case CMM_ANNOTATE_STORE: \
cmm_annotate_die( \
"store before release group" \
); \
break; \
case CMM_ANNOTATE_MB: \
cmm_annotate_die( \
"redundant mb of release group" \
); \
break; \
} \
*(group) = CMM_ANNOTATE_MB; \
} while (0)
# define cmm_annotate_group_mem_acquire(group, mem) \
do { \
__tsan_acquire((void*)(mem)); \
switch (cmm_annotate_dereference(group)) { \
case CMM_ANNOTATE_VOID: \
*(group) = CMM_ANNOTATE_LOAD; \
break; \
case CMM_ANNOTATE_MB: \
cmm_annotate_die( \
"load after mb for acquire group" \
); \
break; \
default: \
break; \
} \
} while (0)
# define cmm_annotate_group_mem_release(group, mem) \
do { \
__tsan_release((void*)(mem)); \
switch (cmm_annotate_dereference(group)) { \
case CMM_ANNOTATE_MB: \
break; \
default: \
cmm_annotate_die( \
"missing mb for release group" \
); \
} \
} while (0)
# define cmm_annotate_mem_acquire(mem) \
__tsan_acquire((void*)(mem))
# define cmm_annotate_mem_release(mem) \
__tsan_release((void*)(mem))
#else
# define cmm_annotate_group_mb_acquire(group) \
(void) (group)
# define cmm_annotate_group_mb_release(group) \
(void) (group)
# define cmm_annotate_group_mem_acquire(group, mem) \
(void) (group)
# define cmm_annotate_group_mem_release(group, mem) \
(void) (group)
# define cmm_annotate_mem_acquire(mem) \
do { } while (0)
# define cmm_annotate_mem_release(mem) \
do { } while (0)
#endif /* CMM_SANITIZE_THREAD */
#endif /* _URCU_ANNOTATE_H */
|