xref: /kvm-unit-tests/lib/libcflat.h (revision 9e801bd9d2d4b37bfad26123bcd58548adb0d82c)
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License, version 2, as
4  * published by the Free Software Foundation.
5  *
6  * This program is distributed in the hope that it will be useful,
7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9  * GNU General Public License for more details.
10  *
11  * You should have received a copy of the GNU General Public License
12  * along with this program; if not, write to the Free Software
13  * Foundation, 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
14  *
15  * Copyright IBM Corp. 2008
16  *
17  * Authors: Hollis Blanchard <hollisb@us.ibm.com>
18  */
19 
20 #ifndef __LIBCFLAT_H
21 #define __LIBCFLAT_H
22 
23 #include <stdarg.h>
24 #include <stddef.h>
25 #include <stdint.h>
26 #include <string.h>
27 #include <stdbool.h>
28 
29 #define __unused __attribute__((__unused__))
30 
31 #define xstr(s...) xxstr(s)
32 #define xxstr(s...) #s
33 
34 #define __ALIGN_MASK(x, mask)	(((x) + (mask)) & ~(mask))
35 #define __ALIGN(x, a)		__ALIGN_MASK(x, (typeof(x))(a) - 1)
36 #define ALIGN(x, a)		__ALIGN((x), (a))
37 #define IS_ALIGNED(x, a)	(((x) & ((typeof(x))(a) - 1)) == 0)
38 
39 #define SZ_256			(1 << 8)
40 #define SZ_4K			(1 << 12)
41 #define SZ_8K			(1 << 13)
42 #define SZ_16K			(1 << 14)
43 #define SZ_64K			(1 << 16)
44 #define SZ_2M			(1 << 21)
45 #define SZ_1G			(1 << 30)
46 
47 #define MIN(a, b)		((a) < (b) ? (a) : (b))
48 #define MAX(a, b)		((a) > (b) ? (a) : (b))
49 
50 typedef uint8_t		u8;
51 typedef int8_t		s8;
52 typedef uint16_t	u16;
53 typedef int16_t		s16;
54 typedef uint32_t	u32;
55 typedef int32_t		s32;
56 typedef uint64_t	u64;
57 typedef int64_t		s64;
58 typedef unsigned long	ulong;
59 
60 #if __SIZEOF_LONG__ == 8
61 #  define __PRI32_PREFIX
62 #  define __PRI64_PREFIX	"l"
63 #  define __PRIPTR_PREFIX	"l"
64 #else
65 #if defined(__U32_LONG_FMT__)
66 #  define __PRI32_PREFIX        "l"
67 #else
68 #  define __PRI32_PREFIX
69 #endif
70 #  define __PRI64_PREFIX	"ll"
71 #  define __PRIPTR_PREFIX
72 #endif
73 #define PRId32  __PRI32_PREFIX	"d"
74 #define PRIu32  __PRI32_PREFIX	"u"
75 #define PRIx32  __PRI32_PREFIX	"x"
76 #define PRId64  __PRI64_PREFIX	"d"
77 #define PRIu64  __PRI64_PREFIX	"u"
78 #define PRIx64  __PRI64_PREFIX	"x"
79 #define PRIxPTR __PRIPTR_PREFIX	"x"
80 
81 typedef u64			phys_addr_t;
82 #define INVALID_PHYS_ADDR	(~(phys_addr_t)0)
83 
84 extern void puts(const char *s);
85 extern int __getchar(void);
86 extern int getchar(void);
87 extern void exit(int code) __attribute__((noreturn));
88 extern void abort(void) __attribute__((noreturn));
89 extern long atol(const char *ptr);
90 extern char *getenv(const char *name);
91 
92 extern int printf(const char *fmt, ...)
93 					__attribute__((format(printf, 1, 2)));
94 extern int snprintf(char *buf, int size, const char *fmt, ...)
95 					__attribute__((format(printf, 3, 4)));
96 extern int vsnprintf(char *buf, int size, const char *fmt, va_list va)
97 					__attribute__((format(printf, 3, 0)));
98 extern int vprintf(const char *fmt, va_list va)
99 					__attribute__((format(printf, 1, 0)));
100 
101 void report_prefix_pushf(const char *prefix_fmt, ...)
102 					__attribute__((format(printf, 1, 2)));
103 extern void report_prefix_push(const char *prefix);
104 extern void report_prefix_pop(void);
105 extern void report(bool pass, const char *msg_fmt, ...)
106 		__attribute__((format(printf, 2, 3), nonnull(2)));
107 extern void report_xfail(bool xfail, bool pass, const char *msg_fmt, ...)
108 		__attribute__((format(printf, 3, 4), nonnull(3)));
109 extern void report_abort(const char *msg_fmt, ...)
110 					__attribute__((format(printf, 1, 2)))
111 					__attribute__((noreturn));
112 extern void report_skip(const char *msg_fmt, ...)
113 					__attribute__((format(printf, 1, 2)));
114 extern void report_info(const char *msg_fmt, ...)
115 					__attribute__((format(printf, 1, 2)));
116 extern void report_pass(void);
117 extern int report_summary(void);
118 
119 bool simple_glob(const char *text, const char *pattern);
120 
121 extern void dump_stack(void);
122 extern void dump_frame_stack(const void *instruction, const void *frame);
123 
124 #define ARRAY_SIZE(_a) (sizeof(_a)/sizeof((_a)[0]))
125 
126 #define container_of(ptr, type, member) ({				\
127 	const typeof( ((type *)0)->member ) *__mptr = (ptr);		\
128 	(type *)( (char *)__mptr - offsetof(type,member) );})
129 
130 #define assert(cond)							\
131 do {									\
132 	if (!(cond)) {							\
133 		printf("%s:%d: assert failed: %s\n",			\
134 		       __FILE__, __LINE__, #cond);			\
135 		dump_stack();						\
136 		abort();						\
137 	}								\
138 } while (0)
139 
140 #define assert_msg(cond, fmt, args...)					\
141 do {									\
142 	if (!(cond)) {							\
143 		printf("%s:%d: assert failed: %s: " fmt "\n",		\
144 		       __FILE__, __LINE__, #cond, ## args);		\
145 		dump_stack();						\
146 		abort();						\
147 	}								\
148 } while (0)
149 
150 /*
151  * One byte per bit, a ' between each group of 4 bits, and a null terminator.
152  */
153 #define BINSTR_SZ (sizeof(unsigned long) * 8 + sizeof(unsigned long) * 2)
154 void binstr(unsigned long x, char out[BINSTR_SZ]);
155 void print_binstr(unsigned long x);
156 
157 extern void setup_vm(void);
158 
159 #endif
160