Merge remote-tracking branch 'remotes/dagrh/tags/pull-virtiofs-20211026' into staging
[qemu.git] / scripts / cocci-macro-file.h
1 /* Macro file for Coccinelle
2 *
3 * Copyright (C) 2015 Red Hat, Inc.
4 *
5 * Authors:
6 * Paolo Bonzini <pbonzini@redhat.com>
7 *
8 * This work is licensed under the terms of the GNU GPL, version 2 or, at your
9 * option, any later version. See the COPYING file in the top-level directory.
10 */
11
12 /* Coccinelle only does limited parsing of headers, and chokes on some idioms
13 * defined in compiler.h and queue.h. Macros that Coccinelle must know about
14 * in order to parse .c files must be in a separate macro file---which is
15 * exactly what you're staring at now.
16 *
17 * To use this file, add the "--macro-file scripts/cocci-macro-file.h" to the
18 * Coccinelle command line.
19 */
20
21 /* From qemu/compiler.h */
22 #define QEMU_NORETURN __attribute__ ((__noreturn__))
23 #define QEMU_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
24 #define QEMU_SENTINEL __attribute__((sentinel))
25
26 #if defined(_WIN32) && (defined(__x86_64__) || defined(__i386__))
27 # define QEMU_PACKED __attribute__((gcc_struct, packed))
28 #else
29 # define QEMU_PACKED __attribute__((packed))
30 #endif
31
32 #define cat(x,y) x ## y
33 #define cat2(x,y) cat(x,y)
34 #define QEMU_BUILD_BUG_ON(x) \
35 typedef char cat2(qemu_build_bug_on__,__LINE__)[(x)?-1:1] __attribute__((unused));
36
37 #define GCC_FMT_ATTR(n, m) __attribute__((format(gnu_printf, n, m)))
38
39 #define xglue(x, y) x ## y
40 #define glue(x, y) xglue(x, y)
41 #define stringify(s) tostring(s)
42 #define tostring(s) #s
43
44 #define typeof_field(type, field) typeof(((type *)0)->field)
45 #define type_check(t1,t2) ((t1*)0 - (t2*)0)
46
47 /* From qemu/queue.h */
48
49 #define QLIST_HEAD(name, type) \
50 struct name { \
51 struct type *lh_first; /* first element */ \
52 }
53
54 #define QLIST_HEAD_INITIALIZER(head) \
55 { NULL }
56
57 #define QLIST_ENTRY(type) \
58 struct { \
59 struct type *le_next; /* next element */ \
60 struct type **le_prev; /* address of previous next element */ \
61 }
62
63 /*
64 * Singly-linked List definitions.
65 */
66 #define QSLIST_HEAD(name, type) \
67 struct name { \
68 struct type *slh_first; /* first element */ \
69 }
70
71 #define QSLIST_HEAD_INITIALIZER(head) \
72 { NULL }
73
74 #define QSLIST_ENTRY(type) \
75 struct { \
76 struct type *sle_next; /* next element */ \
77 }
78
79 /*
80 * Simple queue definitions.
81 */
82 #define QSIMPLEQ_HEAD(name, type) \
83 struct name { \
84 struct type *sqh_first; /* first element */ \
85 struct type **sqh_last; /* addr of last next element */ \
86 }
87
88 #define QSIMPLEQ_HEAD_INITIALIZER(head) \
89 { NULL, &(head).sqh_first }
90
91 #define QSIMPLEQ_ENTRY(type) \
92 struct { \
93 struct type *sqe_next; /* next element */ \
94 }
95
96 /*
97 * Tail queue definitions.
98 */
99 #define QTAILQ_HEAD(name, type) \
100 union name { \
101 struct type *tqh_first; /* first element */ \
102 QTailQLink tqh_circ; /* link for last element */ \
103 }
104
105 #define QTAILQ_HEAD_INITIALIZER(head) \
106 { .tqh_circ = { NULL, &(head).tqh_circ } }
107
108 #define QTAILQ_ENTRY(type) \
109 union { \
110 struct type *tqe_next; /* next element */ \
111 QTailQLink tqe_circ; /* link for prev element */ \
112 }
113
114 /* From glib */
115 #define g_assert_cmpint(a, op, b) g_assert(a op b)
116 #define g_assert_cmpuint(a, op, b) g_assert(a op b)
117 #define g_assert_cmphex(a, op, b) g_assert(a op b)
118 #define g_assert_cmpstr(a, op, b) g_assert(strcmp(a, b) op 0)