]>
Commit | Line | Data |
---|---|---|
ab02ab2a MR |
1 | /* |
2 | * Core Definitions for QAPI/QMP Dispatch | |
3 | * | |
4 | * Copyright IBM, Corp. 2011 | |
5 | * | |
6 | * Authors: | |
7 | * Anthony Liguori <aliguori@us.ibm.com> | |
8 | * | |
9 | * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. | |
10 | * See the COPYING.LIB file in the top-level directory. | |
11 | * | |
12 | */ | |
13 | ||
cbf21151 | 14 | #include "qemu/osdep.h" |
da34e65c | 15 | #include "qapi/error.h" |
7b1b5d19 | 16 | #include "qapi/qmp/dispatch.h" |
452fcdbc | 17 | #include "qapi/qmp/qdict.h" |
c7eb39cb | 18 | #include "qapi/qmp/qjson.h" |
54d31236 | 19 | #include "sysemu/runstate.h" |
cf869d53 | 20 | #include "qapi/qmp/qbool.h" |
ab02ab2a | 21 | |
69240fe6 MA |
22 | static QDict *qmp_dispatch_check_obj(const QObject *request, bool allow_oob, |
23 | Error **errp) | |
ab02ab2a | 24 | { |
00ecec15 | 25 | const char *exec_key = NULL; |
ab02ab2a MR |
26 | const QDictEntry *ent; |
27 | const char *arg_name; | |
28 | const QObject *arg_obj; | |
00ecec15 | 29 | QDict *dict; |
ab02ab2a | 30 | |
7dc847eb | 31 | dict = qobject_to(QDict, request); |
ca6b6e1e | 32 | if (!dict) { |
10e37839 | 33 | error_setg(errp, "QMP input must be a JSON object"); |
ab02ab2a MR |
34 | return NULL; |
35 | } | |
36 | ||
ab02ab2a MR |
37 | for (ent = qdict_first(dict); ent; |
38 | ent = qdict_next(dict, ent)) { | |
39 | arg_name = qdict_entry_key(ent); | |
40 | arg_obj = qdict_entry_value(ent); | |
41 | ||
00ecec15 MA |
42 | if (!strcmp(arg_name, "execute") |
43 | || (!strcmp(arg_name, "exec-oob") && allow_oob)) { | |
ab02ab2a | 44 | if (qobject_type(arg_obj) != QTYPE_QSTRING) { |
00ecec15 MA |
45 | error_setg(errp, "QMP input member '%s' must be a string", |
46 | arg_name); | |
ab02ab2a MR |
47 | return NULL; |
48 | } | |
00ecec15 MA |
49 | if (exec_key) { |
50 | error_setg(errp, "QMP input member '%s' clashes with '%s'", | |
51 | arg_name, exec_key); | |
74d8c9d9 MA |
52 | return NULL; |
53 | } | |
00ecec15 MA |
54 | exec_key = arg_name; |
55 | } else if (!strcmp(arg_name, "arguments")) { | |
cf869d53 PX |
56 | if (qobject_type(arg_obj) != QTYPE_QDICT) { |
57 | error_setg(errp, | |
00ecec15 | 58 | "QMP input member 'arguments' must be an object"); |
cf869d53 PX |
59 | return NULL; |
60 | } | |
4eaca8de MAL |
61 | } else if (!strcmp(arg_name, "id")) { |
62 | continue; | |
74d8c9d9 | 63 | } else { |
10e37839 | 64 | error_setg(errp, "QMP input member '%s' is unexpected", |
99fb0c53 | 65 | arg_name); |
ab02ab2a MR |
66 | return NULL; |
67 | } | |
68 | } | |
69 | ||
00ecec15 | 70 | if (!exec_key) { |
10e37839 | 71 | error_setg(errp, "QMP input lacks member 'execute'"); |
ab02ab2a MR |
72 | return NULL; |
73 | } | |
74 | ||
75 | return dict; | |
76 | } | |
77 | ||
cf4a0643 MA |
78 | QDict *qmp_error_response(Error *err) |
79 | { | |
80 | QDict *rsp; | |
81 | ||
82 | rsp = qdict_from_jsonf_nofail("{ 'error': { 'class': %s, 'desc': %s } }", | |
83 | QapiErrorClass_str(error_get_class(err)), | |
84 | error_get_pretty(err)); | |
85 | error_free(err); | |
86 | return rsp; | |
87 | } | |
88 | ||
89 | /* | |
90 | * Does @qdict look like a command to be run out-of-band? | |
91 | */ | |
92 | bool qmp_is_oob(const QDict *dict) | |
ab02ab2a | 93 | { |
cf4a0643 MA |
94 | return qdict_haskey(dict, "exec-oob") |
95 | && !qdict_haskey(dict, "execute"); | |
96 | } | |
97 | ||
98 | QDict *qmp_dispatch(QmpCommandList *cmds, QObject *request, | |
99 | bool allow_oob) | |
100 | { | |
101 | Error *err = NULL; | |
69240fe6 | 102 | bool oob; |
ab02ab2a | 103 | const char *command; |
cf4a0643 | 104 | QDict *args; |
ab02ab2a | 105 | QmpCommand *cmd; |
cf4a0643 MA |
106 | QDict *dict = qobject_to(QDict, request); |
107 | QObject *id = dict ? qdict_get(dict, "id") : NULL; | |
ab02ab2a | 108 | QObject *ret = NULL; |
d3226035 | 109 | QDict *rsp = NULL; |
ab02ab2a | 110 | |
cf4a0643 | 111 | dict = qmp_dispatch_check_obj(request, allow_oob, &err); |
4af8be1f | 112 | if (!dict) { |
cf4a0643 | 113 | goto out; |
ab02ab2a MR |
114 | } |
115 | ||
00ecec15 | 116 | command = qdict_get_try_str(dict, "execute"); |
69240fe6 | 117 | oob = false; |
00ecec15 MA |
118 | if (!command) { |
119 | assert(allow_oob); | |
120 | command = qdict_get_str(dict, "exec-oob"); | |
69240fe6 | 121 | oob = true; |
00ecec15 | 122 | } |
1527badb | 123 | cmd = qmp_find_command(cmds, command); |
ab02ab2a | 124 | if (cmd == NULL) { |
cf4a0643 | 125 | error_set(&err, ERROR_CLASS_COMMAND_NOT_FOUND, |
a6c90cbc | 126 | "The command %s has not been found", command); |
cf4a0643 | 127 | goto out; |
ab02ab2a | 128 | } |
abd6cf6d | 129 | if (!cmd->enabled) { |
cf4a0643 | 130 | error_set(&err, ERROR_CLASS_COMMAND_NOT_FOUND, |
2546be1c MP |
131 | "The command %s has been disabled for this instance", |
132 | command); | |
cf4a0643 | 133 | goto out; |
abd6cf6d | 134 | } |
69240fe6 | 135 | if (oob && !(cmd->options & QCO_ALLOW_OOB)) { |
cf4a0643 | 136 | error_setg(&err, "The command %s does not support OOB", |
69240fe6 | 137 | command); |
cf4a0643 | 138 | goto out; |
69240fe6 | 139 | } |
ab02ab2a | 140 | |
047f7038 IM |
141 | if (runstate_check(RUN_STATE_PRECONFIG) && |
142 | !(cmd->options & QCO_ALLOW_PRECONFIG)) { | |
cf4a0643 | 143 | error_setg(&err, "The command '%s' isn't permitted in '%s' state", |
047f7038 | 144 | cmd->name, RunState_str(RUN_STATE_PRECONFIG)); |
cf4a0643 | 145 | goto out; |
047f7038 IM |
146 | } |
147 | ||
ab02ab2a MR |
148 | if (!qdict_haskey(dict, "arguments")) { |
149 | args = qdict_new(); | |
150 | } else { | |
151 | args = qdict_get_qdict(dict, "arguments"); | |
cb3e7f08 | 152 | qobject_ref(args); |
ab02ab2a | 153 | } |
cf4a0643 | 154 | cmd->fn(args, &ret, &err); |
d3226035 | 155 | qobject_unref(args); |
cf4a0643 | 156 | if (err) { |
d3226035 MA |
157 | goto out; |
158 | } | |
159 | ||
160 | if (cmd->options & QCO_NO_SUCCESS_RESP) { | |
42a502a7 | 161 | g_assert(!ret); |
d3226035 | 162 | return NULL; |
42a502a7 | 163 | } else if (!ret) { |
62e93be2 | 164 | /* TODO turn into assertion */ |
42a502a7 | 165 | ret = QOBJECT(qdict_new()); |
ab02ab2a MR |
166 | } |
167 | ||
d3226035 MA |
168 | rsp = qdict_new(); |
169 | qdict_put_obj(rsp, "return", ret); | |
ab02ab2a | 170 | |
cf4a0643 | 171 | out: |
ab02ab2a | 172 | if (err) { |
d3226035 | 173 | assert(!rsp); |
cee32796 | 174 | rsp = qmp_error_response(err); |
ab02ab2a MR |
175 | } |
176 | ||
d3226035 MA |
177 | assert(rsp); |
178 | ||
179 | if (id) { | |
4eaca8de MAL |
180 | qdict_put_obj(rsp, "id", qobject_ref(id)); |
181 | } | |
182 | ||
d43b1694 | 183 | return rsp; |
ab02ab2a | 184 | } |