xref: /openbmc/qemu/scripts/cocci-macro-file.h (revision 09a274d8)
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_GNUC_PREREQ(maj, min) 1
23 #define QEMU_NORETURN __attribute__ ((__noreturn__))
24 #define QEMU_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
25 #define QEMU_SENTINEL __attribute__((sentinel))
26 #define QEMU_PACKED __attribute__((gcc_struct, packed))
27 
28 #define cat(x,y) x ## y
29 #define cat2(x,y) cat(x,y)
30 #define QEMU_BUILD_BUG_ON(x) \
31     typedef char cat2(qemu_build_bug_on__,__LINE__)[(x)?-1:1] __attribute__((unused));
32 
33 #define GCC_FMT_ATTR(n, m) __attribute__((format(gnu_printf, n, m)))
34 
35 #define xglue(x, y) x ## y
36 #define glue(x, y) xglue(x, y)
37 #define stringify(s)	tostring(s)
38 #define tostring(s)	#s
39 
40 #define typeof_field(type, field) typeof(((type *)0)->field)
41 #define type_check(t1,t2) ((t1*)0 - (t2*)0)
42 
43 /* From qemu/queue.h */
44 
45 #define QLIST_HEAD(name, type)                                          \
46 struct name {                                                           \
47         struct type *lh_first;  /* first element */                     \
48 }
49 
50 #define QLIST_HEAD_INITIALIZER(head)                                    \
51         { NULL }
52 
53 #define QLIST_ENTRY(type)                                               \
54 struct {                                                                \
55         struct type *le_next;   /* next element */                      \
56         struct type **le_prev;  /* address of previous next element */  \
57 }
58 
59 /*
60  * Singly-linked List definitions.
61  */
62 #define QSLIST_HEAD(name, type)                                          \
63 struct name {                                                           \
64         struct type *slh_first; /* first element */                     \
65 }
66 
67 #define QSLIST_HEAD_INITIALIZER(head)                                    \
68         { NULL }
69 
70 #define QSLIST_ENTRY(type)                                               \
71 struct {                                                                \
72         struct type *sle_next;  /* next element */                      \
73 }
74 
75 /*
76  * Simple queue definitions.
77  */
78 #define QSIMPLEQ_HEAD(name, type)                                       \
79 struct name {                                                           \
80     struct type *sqh_first;    /* first element */                      \
81     struct type **sqh_last;    /* addr of last next element */          \
82 }
83 
84 #define QSIMPLEQ_HEAD_INITIALIZER(head)                                 \
85     { NULL, &(head).sqh_first }
86 
87 #define QSIMPLEQ_ENTRY(type)                                            \
88 struct {                                                                \
89     struct type *sqe_next;    /* next element */                        \
90 }
91 
92 /*
93  * Tail queue definitions.
94  */
95 #define QTAILQ_HEAD(name, type)                                         \
96 union name {                                                            \
97         struct type *tqh_first;       /* first element */               \
98         QTailQLink tqh_circ;          /* link for last element */       \
99 }
100 
101 #define QTAILQ_HEAD_INITIALIZER(head)                                   \
102         { .tqh_circ = { NULL, &(head).tqh_circ } }
103 
104 #define QTAILQ_ENTRY(type)                                              \
105 union {                                                                 \
106         struct type *tqe_next;        /* next element */                \
107         QTailQLink tqe_circ;          /* link for prev element */       \
108 }
109 
110 /* From glib */
111 #define g_assert_cmpint(a, op, b)   g_assert(a op b)
112 #define g_assert_cmpuint(a, op, b)   g_assert(a op b)
113 #define g_assert_cmphex(a, op, b)   g_assert(a op b)
114 #define g_assert_cmpstr(a, op, b)   g_assert(strcmp(a, b) op 0)
115