1c6d3bcb4SMarc-André Lureau /*
2c6d3bcb4SMarc-André Lureau * QTest
3c6d3bcb4SMarc-André Lureau *
4c6d3bcb4SMarc-André Lureau * Copyright IBM, Corp. 2012
5c6d3bcb4SMarc-André Lureau * Copyright Red Hat, Inc. 2012
6c6d3bcb4SMarc-André Lureau * Copyright SUSE LINUX Products GmbH 2013
7c6d3bcb4SMarc-André Lureau *
8c6d3bcb4SMarc-André Lureau * Authors:
9c6d3bcb4SMarc-André Lureau * Anthony Liguori <aliguori@us.ibm.com>
10c6d3bcb4SMarc-André Lureau * Paolo Bonzini <pbonzini@redhat.com>
11c6d3bcb4SMarc-André Lureau * Andreas Färber <afaerber@suse.de>
12c6d3bcb4SMarc-André Lureau *
13c6d3bcb4SMarc-André Lureau * This work is licensed under the terms of the GNU GPL, version 2 or later.
14c6d3bcb4SMarc-André Lureau * See the COPYING file in the top-level directory.
15c6d3bcb4SMarc-André Lureau */
16c6d3bcb4SMarc-André Lureau
17c6d3bcb4SMarc-André Lureau #include "qemu/osdep.h"
18c6d3bcb4SMarc-André Lureau
19c6d3bcb4SMarc-André Lureau #include "libqmp.h"
20c6d3bcb4SMarc-André Lureau
2156b6dab2SMarc-André Lureau #ifndef _WIN32
2256b6dab2SMarc-André Lureau #include <sys/socket.h>
2356b6dab2SMarc-André Lureau #endif
2456b6dab2SMarc-André Lureau
2556b6dab2SMarc-André Lureau #include "qemu/cutils.h"
2684c662d2SXuzhou Cheng #include "qemu/sockets.h"
27c6d3bcb4SMarc-André Lureau #include "qapi/error.h"
28c6d3bcb4SMarc-André Lureau #include "qapi/qmp/json-parser.h"
29c6d3bcb4SMarc-André Lureau #include "qapi/qmp/qjson.h"
30c6d3bcb4SMarc-André Lureau
31c6d3bcb4SMarc-André Lureau #define SOCKET_MAX_FDS 16
32c6d3bcb4SMarc-André Lureau
33c6d3bcb4SMarc-André Lureau typedef struct {
34c6d3bcb4SMarc-André Lureau JSONMessageParser parser;
35c6d3bcb4SMarc-André Lureau QDict *response;
36c6d3bcb4SMarc-André Lureau } QMPResponseParser;
37c6d3bcb4SMarc-André Lureau
socket_send(int fd,const char * buf,size_t size)38c6d3bcb4SMarc-André Lureau static void socket_send(int fd, const char *buf, size_t size)
39c6d3bcb4SMarc-André Lureau {
4084c662d2SXuzhou Cheng ssize_t res = qemu_send_full(fd, buf, size);
41c6d3bcb4SMarc-André Lureau
42c6d3bcb4SMarc-André Lureau assert(res == size);
43c6d3bcb4SMarc-André Lureau }
44c6d3bcb4SMarc-André Lureau
qmp_response(void * opaque,QObject * obj,Error * err)45c6d3bcb4SMarc-André Lureau static void qmp_response(void *opaque, QObject *obj, Error *err)
46c6d3bcb4SMarc-André Lureau {
47c6d3bcb4SMarc-André Lureau QMPResponseParser *qmp = opaque;
48c6d3bcb4SMarc-André Lureau
49c6d3bcb4SMarc-André Lureau assert(!obj != !err);
50c6d3bcb4SMarc-André Lureau
51c6d3bcb4SMarc-André Lureau if (err) {
52c6d3bcb4SMarc-André Lureau error_prepend(&err, "QMP JSON response parsing failed: ");
53c6d3bcb4SMarc-André Lureau error_report_err(err);
54c6d3bcb4SMarc-André Lureau abort();
55c6d3bcb4SMarc-André Lureau }
56c6d3bcb4SMarc-André Lureau
57c6d3bcb4SMarc-André Lureau g_assert(!qmp->response);
58c6d3bcb4SMarc-André Lureau qmp->response = qobject_to(QDict, obj);
59c6d3bcb4SMarc-André Lureau g_assert(qmp->response);
60c6d3bcb4SMarc-André Lureau }
61c6d3bcb4SMarc-André Lureau
qmp_fd_receive(int fd)62c6d3bcb4SMarc-André Lureau QDict *qmp_fd_receive(int fd)
63c6d3bcb4SMarc-André Lureau {
64c6d3bcb4SMarc-André Lureau QMPResponseParser qmp;
65c6d3bcb4SMarc-André Lureau bool log = getenv("QTEST_LOG") != NULL;
66c6d3bcb4SMarc-André Lureau
67c6d3bcb4SMarc-André Lureau qmp.response = NULL;
68c6d3bcb4SMarc-André Lureau json_message_parser_init(&qmp.parser, qmp_response, &qmp, NULL);
69c6d3bcb4SMarc-André Lureau while (!qmp.response) {
70c6d3bcb4SMarc-André Lureau ssize_t len;
71c6d3bcb4SMarc-André Lureau char c;
72c6d3bcb4SMarc-André Lureau
7384c662d2SXuzhou Cheng len = recv(fd, &c, 1, 0);
74c6d3bcb4SMarc-André Lureau if (len == -1 && errno == EINTR) {
75c6d3bcb4SMarc-André Lureau continue;
76c6d3bcb4SMarc-André Lureau }
77c6d3bcb4SMarc-André Lureau
78c6d3bcb4SMarc-André Lureau if (len == -1 || len == 0) {
79c6d3bcb4SMarc-André Lureau fprintf(stderr, "Broken pipe\n");
80c6d3bcb4SMarc-André Lureau abort();
81c6d3bcb4SMarc-André Lureau }
82c6d3bcb4SMarc-André Lureau
83c6d3bcb4SMarc-André Lureau if (log) {
84c6d3bcb4SMarc-André Lureau g_assert(write(2, &c, 1) == 1);
85c6d3bcb4SMarc-André Lureau }
86c6d3bcb4SMarc-André Lureau json_message_parser_feed(&qmp.parser, &c, 1);
87c6d3bcb4SMarc-André Lureau }
88c6d3bcb4SMarc-André Lureau if (log) {
89c6d3bcb4SMarc-André Lureau g_assert(write(2, "\n", 1) == 1);
90c6d3bcb4SMarc-André Lureau }
91c6d3bcb4SMarc-André Lureau json_message_parser_destroy(&qmp.parser);
92c6d3bcb4SMarc-André Lureau
93c6d3bcb4SMarc-André Lureau return qmp.response;
94c6d3bcb4SMarc-André Lureau }
95c6d3bcb4SMarc-André Lureau
9656b6dab2SMarc-André Lureau #ifndef _WIN32
97c6d3bcb4SMarc-André Lureau /* Sends a message and file descriptors to the socket.
98c6d3bcb4SMarc-André Lureau * It's needed for qmp-commands like getfd/add-fd */
socket_send_fds(int socket_fd,int * fds,size_t fds_num,const char * buf,size_t buf_size)99c6d3bcb4SMarc-André Lureau static void socket_send_fds(int socket_fd, int *fds, size_t fds_num,
100c6d3bcb4SMarc-André Lureau const char *buf, size_t buf_size)
101c6d3bcb4SMarc-André Lureau {
102c6d3bcb4SMarc-André Lureau ssize_t ret;
103c6d3bcb4SMarc-André Lureau struct msghdr msg = { 0 };
104c6d3bcb4SMarc-André Lureau char control[CMSG_SPACE(sizeof(int) * SOCKET_MAX_FDS)] = { 0 };
105c6d3bcb4SMarc-André Lureau size_t fdsize = sizeof(int) * fds_num;
106c6d3bcb4SMarc-André Lureau struct cmsghdr *cmsg;
107c6d3bcb4SMarc-André Lureau struct iovec iov = { .iov_base = (char *)buf, .iov_len = buf_size };
108c6d3bcb4SMarc-André Lureau
109c6d3bcb4SMarc-André Lureau msg.msg_iov = &iov;
110c6d3bcb4SMarc-André Lureau msg.msg_iovlen = 1;
111c6d3bcb4SMarc-André Lureau
112c6d3bcb4SMarc-André Lureau if (fds && fds_num > 0) {
113c6d3bcb4SMarc-André Lureau g_assert_cmpuint(fds_num, <, SOCKET_MAX_FDS);
114c6d3bcb4SMarc-André Lureau
115c6d3bcb4SMarc-André Lureau msg.msg_control = control;
116c6d3bcb4SMarc-André Lureau msg.msg_controllen = CMSG_SPACE(fdsize);
117c6d3bcb4SMarc-André Lureau
118c6d3bcb4SMarc-André Lureau cmsg = CMSG_FIRSTHDR(&msg);
119c6d3bcb4SMarc-André Lureau cmsg->cmsg_len = CMSG_LEN(fdsize);
120c6d3bcb4SMarc-André Lureau cmsg->cmsg_level = SOL_SOCKET;
121c6d3bcb4SMarc-André Lureau cmsg->cmsg_type = SCM_RIGHTS;
122c6d3bcb4SMarc-André Lureau memcpy(CMSG_DATA(cmsg), fds, fdsize);
123c6d3bcb4SMarc-André Lureau }
124c6d3bcb4SMarc-André Lureau
125c6d3bcb4SMarc-André Lureau do {
126c6d3bcb4SMarc-André Lureau ret = sendmsg(socket_fd, &msg, 0);
127c6d3bcb4SMarc-André Lureau } while (ret < 0 && errno == EINTR);
128c6d3bcb4SMarc-André Lureau g_assert_cmpint(ret, >, 0);
129c6d3bcb4SMarc-André Lureau }
13056b6dab2SMarc-André Lureau #endif
131c6d3bcb4SMarc-André Lureau
132c6d3bcb4SMarc-André Lureau /**
133c6d3bcb4SMarc-André Lureau * Allow users to send a message without waiting for the reply,
134c6d3bcb4SMarc-André Lureau * in the case that they choose to discard all replies up until
135c6d3bcb4SMarc-André Lureau * a particular EVENT is received.
136c6d3bcb4SMarc-André Lureau */
137*0472b2e5SDaniel P. Berrangé static G_GNUC_PRINTF(4, 0) void
_qmp_fd_vsend_fds(int fd,int * fds,size_t fds_num,const char * fmt,va_list ap)13856b6dab2SMarc-André Lureau _qmp_fd_vsend_fds(int fd, int *fds, size_t fds_num,
139c6d3bcb4SMarc-André Lureau const char *fmt, va_list ap)
140c6d3bcb4SMarc-André Lureau {
141c6d3bcb4SMarc-André Lureau QObject *qobj;
142c6d3bcb4SMarc-André Lureau
14356b6dab2SMarc-André Lureau #ifdef _WIN32
14456b6dab2SMarc-André Lureau assert(fds_num == 0);
14556b6dab2SMarc-André Lureau #endif
14656b6dab2SMarc-André Lureau
147c6d3bcb4SMarc-André Lureau /* Going through qobject ensures we escape strings properly */
148c6d3bcb4SMarc-André Lureau qobj = qobject_from_vjsonf_nofail(fmt, ap);
149c6d3bcb4SMarc-André Lureau
150c6d3bcb4SMarc-André Lureau /* No need to send anything for an empty QObject. */
151c6d3bcb4SMarc-André Lureau if (qobj) {
152c6d3bcb4SMarc-André Lureau int log = getenv("QTEST_LOG") != NULL;
153c6d3bcb4SMarc-André Lureau GString *str = qobject_to_json(qobj);
154c6d3bcb4SMarc-André Lureau
155c6d3bcb4SMarc-André Lureau /*
156c6d3bcb4SMarc-André Lureau * BUG: QMP doesn't react to input until it sees a newline, an
157c6d3bcb4SMarc-André Lureau * object, or an array. Work-around: give it a newline.
158c6d3bcb4SMarc-André Lureau */
159c6d3bcb4SMarc-André Lureau g_string_append_c(str, '\n');
160c6d3bcb4SMarc-André Lureau
161c6d3bcb4SMarc-André Lureau if (log) {
162c6d3bcb4SMarc-André Lureau fprintf(stderr, "%s", str->str);
163c6d3bcb4SMarc-André Lureau }
16456b6dab2SMarc-André Lureau
16556b6dab2SMarc-André Lureau #ifndef _WIN32
166c6d3bcb4SMarc-André Lureau /* Send QMP request */
167c6d3bcb4SMarc-André Lureau if (fds && fds_num > 0) {
168c6d3bcb4SMarc-André Lureau socket_send_fds(fd, fds, fds_num, str->str, str->len);
16956b6dab2SMarc-André Lureau } else
17056b6dab2SMarc-André Lureau #endif
17156b6dab2SMarc-André Lureau {
172c6d3bcb4SMarc-André Lureau socket_send(fd, str->str, str->len);
173c6d3bcb4SMarc-André Lureau }
174c6d3bcb4SMarc-André Lureau
175c6d3bcb4SMarc-André Lureau g_string_free(str, true);
176c6d3bcb4SMarc-André Lureau qobject_unref(qobj);
177c6d3bcb4SMarc-André Lureau }
178c6d3bcb4SMarc-André Lureau }
179c6d3bcb4SMarc-André Lureau
18056b6dab2SMarc-André Lureau #ifndef _WIN32
qmp_fd_vsend_fds(int fd,int * fds,size_t fds_num,const char * fmt,va_list ap)18156b6dab2SMarc-André Lureau void qmp_fd_vsend_fds(int fd, int *fds, size_t fds_num,
18256b6dab2SMarc-André Lureau const char *fmt, va_list ap)
18356b6dab2SMarc-André Lureau {
18456b6dab2SMarc-André Lureau _qmp_fd_vsend_fds(fd, fds, fds_num, fmt, ap);
18556b6dab2SMarc-André Lureau }
18656b6dab2SMarc-André Lureau #endif
18756b6dab2SMarc-André Lureau
qmp_fd_vsend(int fd,const char * fmt,va_list ap)188c6d3bcb4SMarc-André Lureau void qmp_fd_vsend(int fd, const char *fmt, va_list ap)
189c6d3bcb4SMarc-André Lureau {
19056b6dab2SMarc-André Lureau _qmp_fd_vsend_fds(fd, NULL, 0, fmt, ap);
191c6d3bcb4SMarc-André Lureau }
192c6d3bcb4SMarc-André Lureau
193c6d3bcb4SMarc-André Lureau
qmp_fdv(int fd,const char * fmt,va_list ap)194c6d3bcb4SMarc-André Lureau QDict *qmp_fdv(int fd, const char *fmt, va_list ap)
195c6d3bcb4SMarc-André Lureau {
19656b6dab2SMarc-André Lureau _qmp_fd_vsend_fds(fd, NULL, 0, fmt, ap);
197c6d3bcb4SMarc-André Lureau
198c6d3bcb4SMarc-André Lureau return qmp_fd_receive(fd);
199c6d3bcb4SMarc-André Lureau }
200c6d3bcb4SMarc-André Lureau
qmp_fd(int fd,const char * fmt,...)201c6d3bcb4SMarc-André Lureau QDict *qmp_fd(int fd, const char *fmt, ...)
202c6d3bcb4SMarc-André Lureau {
203c6d3bcb4SMarc-André Lureau va_list ap;
204c6d3bcb4SMarc-André Lureau QDict *response;
205c6d3bcb4SMarc-André Lureau
206c6d3bcb4SMarc-André Lureau va_start(ap, fmt);
207c6d3bcb4SMarc-André Lureau response = qmp_fdv(fd, fmt, ap);
208c6d3bcb4SMarc-André Lureau va_end(ap);
209c6d3bcb4SMarc-André Lureau return response;
210c6d3bcb4SMarc-André Lureau }
211c6d3bcb4SMarc-André Lureau
qmp_fd_send(int fd,const char * fmt,...)212c6d3bcb4SMarc-André Lureau void qmp_fd_send(int fd, const char *fmt, ...)
213c6d3bcb4SMarc-André Lureau {
214c6d3bcb4SMarc-André Lureau va_list ap;
215c6d3bcb4SMarc-André Lureau
216c6d3bcb4SMarc-André Lureau va_start(ap, fmt);
217c6d3bcb4SMarc-André Lureau qmp_fd_vsend(fd, fmt, ap);
218c6d3bcb4SMarc-André Lureau va_end(ap);
219c6d3bcb4SMarc-André Lureau }
220c6d3bcb4SMarc-André Lureau
qmp_fd_vsend_raw(int fd,const char * fmt,va_list ap)221c6d3bcb4SMarc-André Lureau void qmp_fd_vsend_raw(int fd, const char *fmt, va_list ap)
222c6d3bcb4SMarc-André Lureau {
223c6d3bcb4SMarc-André Lureau bool log = getenv("QTEST_LOG") != NULL;
224c6d3bcb4SMarc-André Lureau char *str = g_strdup_vprintf(fmt, ap);
225c6d3bcb4SMarc-André Lureau
226c6d3bcb4SMarc-André Lureau if (log) {
227c6d3bcb4SMarc-André Lureau fprintf(stderr, "%s", str);
228c6d3bcb4SMarc-André Lureau }
229c6d3bcb4SMarc-André Lureau socket_send(fd, str, strlen(str));
230c6d3bcb4SMarc-André Lureau g_free(str);
231c6d3bcb4SMarc-André Lureau }
232c6d3bcb4SMarc-André Lureau
qmp_fd_send_raw(int fd,const char * fmt,...)233c6d3bcb4SMarc-André Lureau void qmp_fd_send_raw(int fd, const char *fmt, ...)
234c6d3bcb4SMarc-André Lureau {
235c6d3bcb4SMarc-André Lureau va_list ap;
236c6d3bcb4SMarc-André Lureau
237c6d3bcb4SMarc-André Lureau va_start(ap, fmt);
238c6d3bcb4SMarc-André Lureau qmp_fd_vsend_raw(fd, fmt, ap);
239c6d3bcb4SMarc-André Lureau va_end(ap);
240c6d3bcb4SMarc-André Lureau }
241c6d3bcb4SMarc-André Lureau
qmp_rsp_is_err(QDict * rsp)242c6d3bcb4SMarc-André Lureau bool qmp_rsp_is_err(QDict *rsp)
243c6d3bcb4SMarc-André Lureau {
244c6d3bcb4SMarc-André Lureau QDict *error = qdict_get_qdict(rsp, "error");
245c6d3bcb4SMarc-André Lureau qobject_unref(rsp);
246c6d3bcb4SMarc-André Lureau return !!error;
247c6d3bcb4SMarc-André Lureau }
248c6d3bcb4SMarc-André Lureau
qmp_expect_error_and_unref(QDict * rsp,const char * class)249c6d3bcb4SMarc-André Lureau void qmp_expect_error_and_unref(QDict *rsp, const char *class)
250c6d3bcb4SMarc-André Lureau {
251c6d3bcb4SMarc-André Lureau QDict *error = qdict_get_qdict(rsp, "error");
252c6d3bcb4SMarc-André Lureau
253c6d3bcb4SMarc-André Lureau g_assert_cmpstr(qdict_get_try_str(error, "class"), ==, class);
254c6d3bcb4SMarc-André Lureau g_assert_nonnull(qdict_get_try_str(error, "desc"));
255c6d3bcb4SMarc-André Lureau g_assert(!qdict_haskey(rsp, "return"));
256c6d3bcb4SMarc-André Lureau
257c6d3bcb4SMarc-André Lureau qobject_unref(rsp);
258c6d3bcb4SMarc-André Lureau }
259