]>
Commit | Line | Data |
---|---|---|
49ee3590 AL |
1 | /* |
2 | * QTest | |
3 | * | |
4 | * Copyright IBM, Corp. 2012 | |
5 | * Copyright Red Hat, Inc. 2012 | |
872536bf | 6 | * Copyright SUSE LINUX Products GmbH 2013 |
49ee3590 AL |
7 | * |
8 | * Authors: | |
9 | * Anthony Liguori <aliguori@us.ibm.com> | |
10 | * Paolo Bonzini <pbonzini@redhat.com> | |
872536bf | 11 | * Andreas Färber <afaerber@suse.de> |
49ee3590 AL |
12 | * |
13 | * This work is licensed under the terms of the GNU GPL, version 2 or later. | |
14 | * See the COPYING file in the top-level directory. | |
15 | * | |
16 | */ | |
17 | #include "libqtest.h" | |
18 | ||
19 | #include <glib.h> | |
20 | #include <sys/types.h> | |
21 | #include <sys/socket.h> | |
22 | #include <sys/wait.h> | |
23 | #include <sys/un.h> | |
24 | #include <inttypes.h> | |
25 | #include <errno.h> | |
26 | #include <stdio.h> | |
27 | #include <stdlib.h> | |
28 | #include <unistd.h> | |
29 | #include <string.h> | |
30 | ||
1de7afc9 PB |
31 | #include "qemu/compiler.h" |
32 | #include "qemu/osdep.h" | |
0c460dac SH |
33 | #include "qapi/qmp/json-streamer.h" |
34 | #include "qapi/qmp/json-parser.h" | |
49ee3590 AL |
35 | |
36 | #define MAX_IRQ 256 | |
37 | ||
38 | QTestState *global_qtest; | |
39 | ||
40 | struct QTestState | |
41 | { | |
42 | int fd; | |
a3ca163c | 43 | int qmp_fd; |
49ee3590 AL |
44 | bool irq_level[MAX_IRQ]; |
45 | GString *rx; | |
cef60c92 | 46 | pid_t qemu_pid; /* our child QEMU process */ |
49ee3590 AL |
47 | }; |
48 | ||
49 | #define g_assert_no_errno(ret) do { \ | |
50 | g_assert_cmpint(ret, !=, -1); \ | |
51 | } while (0) | |
52 | ||
a3ca163c KW |
53 | static int init_socket(const char *socket_path) |
54 | { | |
55 | struct sockaddr_un addr; | |
56 | int sock; | |
57 | int ret; | |
58 | ||
59 | sock = socket(PF_UNIX, SOCK_STREAM, 0); | |
60 | g_assert_no_errno(sock); | |
61 | ||
62 | addr.sun_family = AF_UNIX; | |
63 | snprintf(addr.sun_path, sizeof(addr.sun_path), "%s", socket_path); | |
64 | qemu_set_cloexec(sock); | |
65 | ||
66 | do { | |
67 | ret = bind(sock, (struct sockaddr *)&addr, sizeof(addr)); | |
68 | } while (ret == -1 && errno == EINTR); | |
69 | g_assert_no_errno(ret); | |
70 | listen(sock, 1); | |
71 | ||
72 | return sock; | |
73 | } | |
74 | ||
75 | static int socket_accept(int sock) | |
76 | { | |
77 | struct sockaddr_un addr; | |
78 | socklen_t addrlen; | |
79 | int ret; | |
80 | ||
b34d2595 | 81 | addrlen = sizeof(addr); |
a3ca163c KW |
82 | do { |
83 | ret = accept(sock, (struct sockaddr *)&addr, &addrlen); | |
84 | } while (ret == -1 && errno == EINTR); | |
85 | g_assert_no_errno(ret); | |
86 | close(sock); | |
87 | ||
88 | return ret; | |
89 | } | |
90 | ||
49ee3590 AL |
91 | QTestState *qtest_init(const char *extra_args) |
92 | { | |
93 | QTestState *s; | |
8a8fd637 | 94 | int sock, qmpsock, i; |
56db2e58 SH |
95 | gchar *socket_path; |
96 | gchar *qmp_socket_path; | |
49ee3590 AL |
97 | gchar *command; |
98 | const char *qemu_binary; | |
49ee3590 AL |
99 | |
100 | qemu_binary = getenv("QTEST_QEMU_BINARY"); | |
101 | g_assert(qemu_binary != NULL); | |
102 | ||
49ee3590 AL |
103 | s = g_malloc(sizeof(*s)); |
104 | ||
56db2e58 SH |
105 | socket_path = g_strdup_printf("/tmp/qtest-%d.sock", getpid()); |
106 | qmp_socket_path = g_strdup_printf("/tmp/qtest-%d.qmp", getpid()); | |
bb494a50 | 107 | |
56db2e58 SH |
108 | sock = init_socket(socket_path); |
109 | qmpsock = init_socket(qmp_socket_path); | |
49ee3590 | 110 | |
cef60c92 SH |
111 | s->qemu_pid = fork(); |
112 | if (s->qemu_pid == 0) { | |
113 | command = g_strdup_printf("exec %s " | |
49ee3590 AL |
114 | "-qtest unix:%s,nowait " |
115 | "-qtest-log /dev/null " | |
a3ca163c | 116 | "-qmp unix:%s,nowait " |
49ee3590 | 117 | "-machine accel=qtest " |
2ad645d2 | 118 | "-display none " |
56db2e58 | 119 | "%s", qemu_binary, socket_path, |
cef60c92 | 120 | qmp_socket_path, |
49ee3590 | 121 | extra_args ?: ""); |
8a8fd637 AL |
122 | execlp("/bin/sh", "sh", "-c", command, NULL); |
123 | exit(1); | |
49ee3590 AL |
124 | } |
125 | ||
a3ca163c KW |
126 | s->fd = socket_accept(sock); |
127 | s->qmp_fd = socket_accept(qmpsock); | |
56db2e58 SH |
128 | unlink(socket_path); |
129 | unlink(qmp_socket_path); | |
130 | g_free(socket_path); | |
131 | g_free(qmp_socket_path); | |
49ee3590 | 132 | |
49ee3590 | 133 | s->rx = g_string_new(""); |
49ee3590 AL |
134 | for (i = 0; i < MAX_IRQ; i++) { |
135 | s->irq_level[i] = false; | |
136 | } | |
137 | ||
a3ca163c | 138 | /* Read the QMP greeting and then do the handshake */ |
0d1aa05e SH |
139 | qtest_qmp_discard_response(s, ""); |
140 | qtest_qmp_discard_response(s, "{ 'execute': 'qmp_capabilities' }"); | |
49ee3590 | 141 | |
e0fea6b1 | 142 | if (getenv("QTEST_STOP")) { |
1ad3c6ab | 143 | kill(s->qemu_pid, SIGSTOP); |
e0fea6b1 PB |
144 | } |
145 | ||
49ee3590 AL |
146 | return s; |
147 | } | |
148 | ||
149 | void qtest_quit(QTestState *s) | |
150 | { | |
e0fea6b1 | 151 | int status; |
49ee3590 | 152 | |
1ad3c6ab SH |
153 | if (s->qemu_pid != -1) { |
154 | kill(s->qemu_pid, SIGTERM); | |
155 | waitpid(s->qemu_pid, &status, 0); | |
49ee3590 | 156 | } |
bb494a50 | 157 | |
fdd26fca MA |
158 | close(s->fd); |
159 | close(s->qmp_fd); | |
160 | g_string_free(s->rx, true); | |
fdd26fca | 161 | g_free(s); |
49ee3590 AL |
162 | } |
163 | ||
a3ca163c | 164 | static void socket_sendf(int fd, const char *fmt, va_list ap) |
49ee3590 | 165 | { |
49ee3590 AL |
166 | gchar *str; |
167 | size_t size, offset; | |
168 | ||
49ee3590 | 169 | str = g_strdup_vprintf(fmt, ap); |
49ee3590 AL |
170 | size = strlen(str); |
171 | ||
172 | offset = 0; | |
173 | while (offset < size) { | |
174 | ssize_t len; | |
175 | ||
a3ca163c | 176 | len = write(fd, str + offset, size - offset); |
49ee3590 AL |
177 | if (len == -1 && errno == EINTR) { |
178 | continue; | |
179 | } | |
180 | ||
181 | g_assert_no_errno(len); | |
182 | g_assert_cmpint(len, >, 0); | |
183 | ||
184 | offset += len; | |
185 | } | |
186 | } | |
187 | ||
a3ca163c KW |
188 | static void GCC_FMT_ATTR(2, 3) qtest_sendf(QTestState *s, const char *fmt, ...) |
189 | { | |
190 | va_list ap; | |
191 | ||
192 | va_start(ap, fmt); | |
193 | socket_sendf(s->fd, fmt, ap); | |
194 | va_end(ap); | |
195 | } | |
196 | ||
49ee3590 AL |
197 | static GString *qtest_recv_line(QTestState *s) |
198 | { | |
199 | GString *line; | |
200 | size_t offset; | |
201 | char *eol; | |
202 | ||
203 | while ((eol = strchr(s->rx->str, '\n')) == NULL) { | |
204 | ssize_t len; | |
205 | char buffer[1024]; | |
206 | ||
207 | len = read(s->fd, buffer, sizeof(buffer)); | |
208 | if (len == -1 && errno == EINTR) { | |
209 | continue; | |
210 | } | |
211 | ||
212 | if (len == -1 || len == 0) { | |
213 | fprintf(stderr, "Broken pipe\n"); | |
214 | exit(1); | |
215 | } | |
216 | ||
217 | g_string_append_len(s->rx, buffer, len); | |
218 | } | |
219 | ||
220 | offset = eol - s->rx->str; | |
221 | line = g_string_new_len(s->rx->str, offset); | |
222 | g_string_erase(s->rx, 0, offset + 1); | |
223 | ||
224 | return line; | |
225 | } | |
226 | ||
227 | static gchar **qtest_rsp(QTestState *s, int expected_args) | |
228 | { | |
229 | GString *line; | |
230 | gchar **words; | |
231 | int i; | |
232 | ||
233 | redo: | |
234 | line = qtest_recv_line(s); | |
235 | words = g_strsplit(line->str, " ", 0); | |
236 | g_string_free(line, TRUE); | |
237 | ||
238 | if (strcmp(words[0], "IRQ") == 0) { | |
239 | int irq; | |
240 | ||
241 | g_assert(words[1] != NULL); | |
242 | g_assert(words[2] != NULL); | |
243 | ||
244 | irq = strtoul(words[2], NULL, 0); | |
245 | g_assert_cmpint(irq, >=, 0); | |
246 | g_assert_cmpint(irq, <, MAX_IRQ); | |
247 | ||
248 | if (strcmp(words[1], "raise") == 0) { | |
249 | s->irq_level[irq] = true; | |
250 | } else { | |
251 | s->irq_level[irq] = false; | |
252 | } | |
253 | ||
254 | g_strfreev(words); | |
255 | goto redo; | |
256 | } | |
257 | ||
258 | g_assert(words[0] != NULL); | |
259 | g_assert_cmpstr(words[0], ==, "OK"); | |
260 | ||
261 | if (expected_args) { | |
262 | for (i = 0; i < expected_args; i++) { | |
263 | g_assert(words[i] != NULL); | |
264 | } | |
265 | } else { | |
266 | g_strfreev(words); | |
267 | } | |
268 | ||
269 | return words; | |
270 | } | |
271 | ||
0c460dac SH |
272 | typedef struct { |
273 | JSONMessageParser parser; | |
274 | QDict *response; | |
275 | } QMPResponseParser; | |
276 | ||
277 | static void qmp_response(JSONMessageParser *parser, QList *tokens) | |
a3ca163c | 278 | { |
0c460dac SH |
279 | QMPResponseParser *qmp = container_of(parser, QMPResponseParser, parser); |
280 | QObject *obj; | |
281 | ||
282 | obj = json_parser_parse(tokens, NULL); | |
283 | if (!obj) { | |
284 | fprintf(stderr, "QMP JSON response parsing failed\n"); | |
285 | exit(1); | |
286 | } | |
287 | ||
288 | g_assert(qobject_type(obj) == QTYPE_QDICT); | |
289 | g_assert(!qmp->response); | |
290 | qmp->response = (QDict *)obj; | |
291 | } | |
292 | ||
293 | QDict *qtest_qmpv(QTestState *s, const char *fmt, va_list ap) | |
294 | { | |
295 | QMPResponseParser qmp; | |
a3ca163c KW |
296 | |
297 | /* Send QMP request */ | |
a3ca163c | 298 | socket_sendf(s->qmp_fd, fmt, ap); |
a3ca163c KW |
299 | |
300 | /* Receive reply */ | |
0c460dac SH |
301 | qmp.response = NULL; |
302 | json_message_parser_init(&qmp.parser, qmp_response); | |
303 | while (!qmp.response) { | |
a3ca163c KW |
304 | ssize_t len; |
305 | char c; | |
306 | ||
307 | len = read(s->qmp_fd, &c, 1); | |
308 | if (len == -1 && errno == EINTR) { | |
309 | continue; | |
310 | } | |
311 | ||
039380a8 AL |
312 | if (len == -1 || len == 0) { |
313 | fprintf(stderr, "Broken pipe\n"); | |
314 | exit(1); | |
315 | } | |
316 | ||
0c460dac | 317 | json_message_parser_feed(&qmp.parser, &c, 1); |
a3ca163c | 318 | } |
0c460dac SH |
319 | json_message_parser_destroy(&qmp.parser); |
320 | ||
321 | return qmp.response; | |
322 | } | |
323 | ||
324 | QDict *qtest_qmp(QTestState *s, const char *fmt, ...) | |
325 | { | |
326 | va_list ap; | |
327 | QDict *response; | |
328 | ||
329 | va_start(ap, fmt); | |
330 | response = qtest_qmpv(s, fmt, ap); | |
331 | va_end(ap); | |
332 | return response; | |
333 | } | |
334 | ||
335 | void qtest_qmpv_discard_response(QTestState *s, const char *fmt, va_list ap) | |
336 | { | |
337 | QDict *response = qtest_qmpv(s, fmt, ap); | |
338 | QDECREF(response); | |
a3ca163c KW |
339 | } |
340 | ||
0d1aa05e | 341 | void qtest_qmp_discard_response(QTestState *s, const char *fmt, ...) |
b73cf9e9 AF |
342 | { |
343 | va_list ap; | |
0c460dac | 344 | QDict *response; |
b73cf9e9 AF |
345 | |
346 | va_start(ap, fmt); | |
0c460dac | 347 | response = qtest_qmpv(s, fmt, ap); |
b73cf9e9 | 348 | va_end(ap); |
0c460dac | 349 | QDECREF(response); |
b73cf9e9 AF |
350 | } |
351 | ||
49ee3590 AL |
352 | const char *qtest_get_arch(void) |
353 | { | |
354 | const char *qemu = getenv("QTEST_QEMU_BINARY"); | |
355 | const char *end = strrchr(qemu, '/'); | |
356 | ||
357 | return end + strlen("/qemu-system-"); | |
358 | } | |
359 | ||
360 | bool qtest_get_irq(QTestState *s, int num) | |
361 | { | |
362 | /* dummy operation in order to make sure irq is up to date */ | |
363 | qtest_inb(s, 0); | |
364 | ||
365 | return s->irq_level[num]; | |
366 | } | |
367 | ||
368 | static int64_t qtest_clock_rsp(QTestState *s) | |
369 | { | |
370 | gchar **words; | |
371 | int64_t clock; | |
372 | words = qtest_rsp(s, 2); | |
373 | clock = g_ascii_strtoll(words[1], NULL, 0); | |
374 | g_strfreev(words); | |
375 | return clock; | |
376 | } | |
377 | ||
378 | int64_t qtest_clock_step_next(QTestState *s) | |
379 | { | |
380 | qtest_sendf(s, "clock_step\n"); | |
381 | return qtest_clock_rsp(s); | |
382 | } | |
383 | ||
384 | int64_t qtest_clock_step(QTestState *s, int64_t step) | |
385 | { | |
386 | qtest_sendf(s, "clock_step %"PRIi64"\n", step); | |
387 | return qtest_clock_rsp(s); | |
388 | } | |
389 | ||
390 | int64_t qtest_clock_set(QTestState *s, int64_t val) | |
391 | { | |
392 | qtest_sendf(s, "clock_set %"PRIi64"\n", val); | |
393 | return qtest_clock_rsp(s); | |
394 | } | |
395 | ||
396 | void qtest_irq_intercept_out(QTestState *s, const char *qom_path) | |
397 | { | |
398 | qtest_sendf(s, "irq_intercept_out %s\n", qom_path); | |
399 | qtest_rsp(s, 0); | |
400 | } | |
401 | ||
402 | void qtest_irq_intercept_in(QTestState *s, const char *qom_path) | |
403 | { | |
404 | qtest_sendf(s, "irq_intercept_in %s\n", qom_path); | |
405 | qtest_rsp(s, 0); | |
406 | } | |
407 | ||
408 | static void qtest_out(QTestState *s, const char *cmd, uint16_t addr, uint32_t value) | |
409 | { | |
410 | qtest_sendf(s, "%s 0x%x 0x%x\n", cmd, addr, value); | |
411 | qtest_rsp(s, 0); | |
412 | } | |
413 | ||
414 | void qtest_outb(QTestState *s, uint16_t addr, uint8_t value) | |
415 | { | |
416 | qtest_out(s, "outb", addr, value); | |
417 | } | |
418 | ||
419 | void qtest_outw(QTestState *s, uint16_t addr, uint16_t value) | |
420 | { | |
421 | qtest_out(s, "outw", addr, value); | |
422 | } | |
423 | ||
424 | void qtest_outl(QTestState *s, uint16_t addr, uint32_t value) | |
425 | { | |
426 | qtest_out(s, "outl", addr, value); | |
427 | } | |
428 | ||
429 | static uint32_t qtest_in(QTestState *s, const char *cmd, uint16_t addr) | |
430 | { | |
431 | gchar **args; | |
432 | uint32_t value; | |
433 | ||
434 | qtest_sendf(s, "%s 0x%x\n", cmd, addr); | |
435 | args = qtest_rsp(s, 2); | |
436 | value = strtoul(args[1], NULL, 0); | |
437 | g_strfreev(args); | |
438 | ||
439 | return value; | |
440 | } | |
441 | ||
442 | uint8_t qtest_inb(QTestState *s, uint16_t addr) | |
443 | { | |
444 | return qtest_in(s, "inb", addr); | |
445 | } | |
446 | ||
447 | uint16_t qtest_inw(QTestState *s, uint16_t addr) | |
448 | { | |
449 | return qtest_in(s, "inw", addr); | |
450 | } | |
451 | ||
452 | uint32_t qtest_inl(QTestState *s, uint16_t addr) | |
453 | { | |
454 | return qtest_in(s, "inl", addr); | |
455 | } | |
456 | ||
872536bf AF |
457 | static void qtest_write(QTestState *s, const char *cmd, uint64_t addr, |
458 | uint64_t value) | |
459 | { | |
460 | qtest_sendf(s, "%s 0x%" PRIx64 " 0x%" PRIx64 "\n", cmd, addr, value); | |
461 | qtest_rsp(s, 0); | |
462 | } | |
463 | ||
464 | void qtest_writeb(QTestState *s, uint64_t addr, uint8_t value) | |
465 | { | |
466 | qtest_write(s, "writeb", addr, value); | |
467 | } | |
468 | ||
469 | void qtest_writew(QTestState *s, uint64_t addr, uint16_t value) | |
470 | { | |
471 | qtest_write(s, "writew", addr, value); | |
472 | } | |
473 | ||
474 | void qtest_writel(QTestState *s, uint64_t addr, uint32_t value) | |
475 | { | |
476 | qtest_write(s, "writel", addr, value); | |
477 | } | |
478 | ||
479 | void qtest_writeq(QTestState *s, uint64_t addr, uint64_t value) | |
480 | { | |
481 | qtest_write(s, "writeq", addr, value); | |
482 | } | |
483 | ||
484 | static uint64_t qtest_read(QTestState *s, const char *cmd, uint64_t addr) | |
485 | { | |
486 | gchar **args; | |
487 | uint64_t value; | |
488 | ||
489 | qtest_sendf(s, "%s 0x%" PRIx64 "\n", cmd, addr); | |
490 | args = qtest_rsp(s, 2); | |
491 | value = strtoull(args[1], NULL, 0); | |
492 | g_strfreev(args); | |
493 | ||
494 | return value; | |
495 | } | |
496 | ||
497 | uint8_t qtest_readb(QTestState *s, uint64_t addr) | |
498 | { | |
499 | return qtest_read(s, "readb", addr); | |
500 | } | |
501 | ||
502 | uint16_t qtest_readw(QTestState *s, uint64_t addr) | |
503 | { | |
504 | return qtest_read(s, "readw", addr); | |
505 | } | |
506 | ||
507 | uint32_t qtest_readl(QTestState *s, uint64_t addr) | |
508 | { | |
509 | return qtest_read(s, "readl", addr); | |
510 | } | |
511 | ||
512 | uint64_t qtest_readq(QTestState *s, uint64_t addr) | |
513 | { | |
514 | return qtest_read(s, "readq", addr); | |
515 | } | |
516 | ||
49ee3590 AL |
517 | static int hex2nib(char ch) |
518 | { | |
519 | if (ch >= '0' && ch <= '9') { | |
520 | return ch - '0'; | |
521 | } else if (ch >= 'a' && ch <= 'f') { | |
522 | return 10 + (ch - 'a'); | |
523 | } else if (ch >= 'A' && ch <= 'F') { | |
524 | return 10 + (ch - 'a'); | |
525 | } else { | |
526 | return -1; | |
527 | } | |
528 | } | |
529 | ||
530 | void qtest_memread(QTestState *s, uint64_t addr, void *data, size_t size) | |
531 | { | |
532 | uint8_t *ptr = data; | |
533 | gchar **args; | |
534 | size_t i; | |
535 | ||
ea7697fc | 536 | qtest_sendf(s, "read 0x%" PRIx64 " 0x%zx\n", addr, size); |
49ee3590 AL |
537 | args = qtest_rsp(s, 2); |
538 | ||
539 | for (i = 0; i < size; i++) { | |
540 | ptr[i] = hex2nib(args[1][2 + (i * 2)]) << 4; | |
541 | ptr[i] |= hex2nib(args[1][2 + (i * 2) + 1]); | |
542 | } | |
543 | ||
544 | g_strfreev(args); | |
545 | } | |
546 | ||
547 | void qtest_add_func(const char *str, void (*fn)) | |
548 | { | |
549 | gchar *path = g_strdup_printf("/%s/%s", qtest_get_arch(), str); | |
550 | g_test_add_func(path, fn); | |
551 | } | |
552 | ||
553 | void qtest_memwrite(QTestState *s, uint64_t addr, const void *data, size_t size) | |
554 | { | |
555 | const uint8_t *ptr = data; | |
556 | size_t i; | |
557 | ||
ea7697fc | 558 | qtest_sendf(s, "write 0x%" PRIx64 " 0x%zx 0x", addr, size); |
49ee3590 AL |
559 | for (i = 0; i < size; i++) { |
560 | qtest_sendf(s, "%02x", ptr[i]); | |
561 | } | |
562 | qtest_sendf(s, "\n"); | |
563 | qtest_rsp(s, 0); | |
564 | } |