2011-07-19 21:50:37 +02:00
|
|
|
/*
|
|
|
|
* Core Definitions for QAPI/QMP Dispatch
|
|
|
|
*
|
|
|
|
* Copyright IBM, Corp. 2011
|
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
* Anthony Liguori <aliguori@us.ibm.com>
|
|
|
|
*
|
|
|
|
* This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
|
|
|
|
* See the COPYING.LIB file in the top-level directory.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2016-01-29 18:49:57 +01:00
|
|
|
#include "qemu/osdep.h"
|
include/qemu/osdep.h: Don't include qapi/error.h
Commit 57cb38b included qapi/error.h into qemu/osdep.h to get the
Error typedef. Since then, we've moved to include qemu/osdep.h
everywhere. Its file comment explains: "To avoid getting into
possible circular include dependencies, this file should not include
any other QEMU headers, with the exceptions of config-host.h,
compiler.h, os-posix.h and os-win32.h, all of which are doing a
similar job to this file and are under similar constraints."
qapi/error.h doesn't do a similar job, and it doesn't adhere to
similar constraints: it includes qapi-types.h. That's in excess of
100KiB of crap most .c files don't actually need.
Add the typedef to qemu/typedefs.h, and include that instead of
qapi/error.h. Include qapi/error.h in .c files that need it and don't
get it now. Include qapi-types.h in qom/object.h for uint16List.
Update scripts/clean-includes accordingly. Update it further to match
reality: replace config.h by config-target.h, add sysemu/os-posix.h,
sysemu/os-win32.h. Update the list of includes in the qemu/osdep.h
comment quoted above similarly.
This reduces the number of objects depending on qapi/error.h from "all
of them" to less than a third. Unfortunately, the number depending on
qapi-types.h shrinks only a little. More work is needed for that one.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
[Fix compilation without the spice devel packages. - Paolo]
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2016-03-14 09:01:28 +01:00
|
|
|
#include "qapi/error.h"
|
2012-12-17 18:19:43 +01:00
|
|
|
#include "qapi/qmp/types.h"
|
|
|
|
#include "qapi/qmp/dispatch.h"
|
|
|
|
#include "qapi/qmp/json-parser.h"
|
2016-06-09 18:48:32 +02:00
|
|
|
#include "qapi/qmp/qjson.h"
|
2012-08-01 21:30:13 +02:00
|
|
|
#include "qapi-types.h"
|
2012-12-17 18:19:43 +01:00
|
|
|
#include "qapi/qmp/qerror.h"
|
2011-07-19 21:50:37 +02:00
|
|
|
|
|
|
|
static QDict *qmp_dispatch_check_obj(const QObject *request, Error **errp)
|
|
|
|
{
|
|
|
|
const QDictEntry *ent;
|
|
|
|
const char *arg_name;
|
|
|
|
const QObject *arg_obj;
|
|
|
|
bool has_exec_key = false;
|
|
|
|
QDict *dict = NULL;
|
|
|
|
|
|
|
|
if (qobject_type(request) != QTYPE_QDICT) {
|
2015-03-17 11:54:50 +01:00
|
|
|
error_setg(errp, QERR_QMP_BAD_INPUT_OBJECT,
|
|
|
|
"request is not a dictionary");
|
2011-07-19 21:50:37 +02:00
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
dict = qobject_to_qdict(request);
|
|
|
|
|
|
|
|
for (ent = qdict_first(dict); ent;
|
|
|
|
ent = qdict_next(dict, ent)) {
|
|
|
|
arg_name = qdict_entry_key(ent);
|
|
|
|
arg_obj = qdict_entry_value(ent);
|
|
|
|
|
|
|
|
if (!strcmp(arg_name, "execute")) {
|
|
|
|
if (qobject_type(arg_obj) != QTYPE_QSTRING) {
|
2015-03-17 11:54:50 +01:00
|
|
|
error_setg(errp, QERR_QMP_BAD_INPUT_OBJECT_MEMBER, "execute",
|
|
|
|
"string");
|
2011-07-19 21:50:37 +02:00
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
has_exec_key = true;
|
|
|
|
} else if (strcmp(arg_name, "arguments")) {
|
2015-03-17 11:54:50 +01:00
|
|
|
error_setg(errp, QERR_QMP_EXTRA_MEMBER, arg_name);
|
2011-07-19 21:50:37 +02:00
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!has_exec_key) {
|
2015-03-17 11:54:50 +01:00
|
|
|
error_setg(errp, QERR_QMP_BAD_INPUT_OBJECT, "execute");
|
2011-07-19 21:50:37 +02:00
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
return dict;
|
|
|
|
}
|
|
|
|
|
|
|
|
static QObject *do_qmp_dispatch(QObject *request, Error **errp)
|
|
|
|
{
|
2014-05-02 13:26:37 +02:00
|
|
|
Error *local_err = NULL;
|
2011-07-19 21:50:37 +02:00
|
|
|
const char *command;
|
|
|
|
QDict *args, *dict;
|
|
|
|
QmpCommand *cmd;
|
|
|
|
QObject *ret = NULL;
|
|
|
|
|
|
|
|
dict = qmp_dispatch_check_obj(request, errp);
|
2014-05-02 13:26:35 +02:00
|
|
|
if (!dict) {
|
2011-07-19 21:50:37 +02:00
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
command = qdict_get_str(dict, "execute");
|
|
|
|
cmd = qmp_find_command(command);
|
|
|
|
if (cmd == NULL) {
|
2015-01-13 16:16:35 +01:00
|
|
|
error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
|
|
|
|
"The command %s has not been found", command);
|
2011-07-19 21:50:37 +02:00
|
|
|
return NULL;
|
|
|
|
}
|
2011-12-07 05:03:42 +01:00
|
|
|
if (!cmd->enabled) {
|
2014-03-22 00:42:26 +01:00
|
|
|
error_setg(errp, "The command %s has been disabled for this instance",
|
|
|
|
command);
|
2011-12-07 05:03:42 +01:00
|
|
|
return NULL;
|
|
|
|
}
|
2011-07-19 21:50:37 +02:00
|
|
|
|
|
|
|
if (!qdict_haskey(dict, "arguments")) {
|
|
|
|
args = qdict_new();
|
|
|
|
} else {
|
|
|
|
args = qdict_get_qdict(dict, "arguments");
|
|
|
|
QINCREF(args);
|
|
|
|
}
|
|
|
|
|
2016-04-28 23:45:11 +02:00
|
|
|
cmd->fn(args, &ret, &local_err);
|
|
|
|
if (local_err) {
|
|
|
|
error_propagate(errp, local_err);
|
|
|
|
} else if (cmd->options & QCO_NO_SUCCESS_RESP) {
|
|
|
|
g_assert(!ret);
|
|
|
|
} else if (!ret) {
|
|
|
|
ret = QOBJECT(qdict_new());
|
2011-07-19 21:50:37 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
QDECREF(args);
|
|
|
|
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2014-05-02 13:26:29 +02:00
|
|
|
QObject *qmp_build_error_object(Error *err)
|
2012-08-01 21:30:13 +02:00
|
|
|
{
|
|
|
|
return qobject_from_jsonf("{ 'class': %s, 'desc': %s }",
|
qapi: Add alias for ErrorClass
The qapi enum ErrorClass is unusual that it uses 'CamelCase' names,
contrary to our documented convention of preferring 'lower-case'.
However, this enum is entrenched in the API; we cannot change
what strings QMP outputs. Meanwhile, we want to simplify how
c_enum_const() is used to generate enum constants, by moving away
from the heuristics of camel_to_upper() to a more straightforward
c_name(N).upper() - but doing so will rename all of the ErrorClass
constants and cause churn to all client files, where the new names
are aesthetically less pleasing (ERROR_CLASS_DEVICENOTFOUND looks
like we can't make up our minds on whether to break between words).
So as always in computer science, solve the problem by some more
indirection: rename the qapi type to QapiErrorClass, and add a
new enum ErrorClass in error.h whose members are aliases of the
qapi type, but with the spelling expected elsewhere in the tree.
Then, when c_enum_const() changes the munging, we only have to
adjust the one alias spot.
Suggested by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Eric Blake <eblake@redhat.com>
Message-Id: <1447836791-369-26-git-send-email-eblake@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2015-11-18 09:53:00 +01:00
|
|
|
QapiErrorClass_lookup[error_get_class(err)],
|
2014-05-02 13:26:29 +02:00
|
|
|
error_get_pretty(err));
|
2012-08-01 21:30:13 +02:00
|
|
|
}
|
|
|
|
|
2011-07-19 21:50:37 +02:00
|
|
|
QObject *qmp_dispatch(QObject *request)
|
|
|
|
{
|
|
|
|
Error *err = NULL;
|
|
|
|
QObject *ret;
|
|
|
|
QDict *rsp;
|
|
|
|
|
|
|
|
ret = do_qmp_dispatch(request, &err);
|
|
|
|
|
|
|
|
rsp = qdict_new();
|
|
|
|
if (err) {
|
2012-08-01 21:30:13 +02:00
|
|
|
qdict_put_obj(rsp, "error", qmp_build_error_object(err));
|
2011-07-19 21:50:37 +02:00
|
|
|
error_free(err);
|
|
|
|
} else if (ret) {
|
|
|
|
qdict_put_obj(rsp, "return", ret);
|
|
|
|
} else {
|
|
|
|
QDECREF(rsp);
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
return QOBJECT(rsp);
|
|
|
|
}
|