156762816SKevin Wolf /*
256762816SKevin Wolf * QMP commands related to the monitor (common to sysemu and tools)
356762816SKevin Wolf *
456762816SKevin Wolf * Copyright (c) 2003-2004 Fabrice Bellard
556762816SKevin Wolf *
656762816SKevin Wolf * Permission is hereby granted, free of charge, to any person obtaining a copy
756762816SKevin Wolf * of this software and associated documentation files (the "Software"), to deal
856762816SKevin Wolf * in the Software without restriction, including without limitation the rights
956762816SKevin Wolf * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
1056762816SKevin Wolf * copies of the Software, and to permit persons to whom the Software is
1156762816SKevin Wolf * furnished to do so, subject to the following conditions:
1256762816SKevin Wolf *
1356762816SKevin Wolf * The above copyright notice and this permission notice shall be included in
1456762816SKevin Wolf * all copies or substantial portions of the Software.
1556762816SKevin Wolf *
1656762816SKevin Wolf * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1756762816SKevin Wolf * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1856762816SKevin Wolf * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
1956762816SKevin Wolf * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
2056762816SKevin Wolf * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2156762816SKevin Wolf * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2256762816SKevin Wolf * THE SOFTWARE.
2356762816SKevin Wolf */
2456762816SKevin Wolf
2556762816SKevin Wolf #include "qemu/osdep.h"
2656762816SKevin Wolf
2756762816SKevin Wolf #include "monitor-internal.h"
2856762816SKevin Wolf #include "qemu-version.h"
29624fa80cSMarkus Armbruster #include "qapi/compat-policy.h"
3056762816SKevin Wolf #include "qapi/error.h"
3156762816SKevin Wolf #include "qapi/qapi-commands-control.h"
32624fa80cSMarkus Armbruster #include "qapi/qapi-commands-introspect.h"
337d3f5053SKevin Wolf #include "qapi/qapi-introspect.h"
34624fa80cSMarkus Armbruster #include "qapi/qapi-visit-introspect.h"
35624fa80cSMarkus Armbruster #include "qapi/qobject-input-visitor.h"
3656762816SKevin Wolf
3756762816SKevin Wolf /*
3856762816SKevin Wolf * Accept QMP capabilities in @list for @mon.
3956762816SKevin Wolf * On success, set mon->qmp.capab[], and return true.
4056762816SKevin Wolf * On error, set @errp, and return false.
4156762816SKevin Wolf */
qmp_caps_accept(MonitorQMP * mon,QMPCapabilityList * list,Error ** errp)4256762816SKevin Wolf static bool qmp_caps_accept(MonitorQMP *mon, QMPCapabilityList *list,
4356762816SKevin Wolf Error **errp)
4456762816SKevin Wolf {
4556762816SKevin Wolf GString *unavailable = NULL;
4656762816SKevin Wolf bool capab[QMP_CAPABILITY__MAX];
4756762816SKevin Wolf
4856762816SKevin Wolf memset(capab, 0, sizeof(capab));
4956762816SKevin Wolf
5056762816SKevin Wolf for (; list; list = list->next) {
5156762816SKevin Wolf if (!mon->capab_offered[list->value]) {
5256762816SKevin Wolf if (!unavailable) {
5356762816SKevin Wolf unavailable = g_string_new(QMPCapability_str(list->value));
5456762816SKevin Wolf } else {
5556762816SKevin Wolf g_string_append_printf(unavailable, ", %s",
5656762816SKevin Wolf QMPCapability_str(list->value));
5756762816SKevin Wolf }
5856762816SKevin Wolf }
5956762816SKevin Wolf capab[list->value] = true;
6056762816SKevin Wolf }
6156762816SKevin Wolf
6256762816SKevin Wolf if (unavailable) {
6356762816SKevin Wolf error_setg(errp, "Capability %s not available", unavailable->str);
6456762816SKevin Wolf g_string_free(unavailable, true);
6556762816SKevin Wolf return false;
6656762816SKevin Wolf }
6756762816SKevin Wolf
6856762816SKevin Wolf memcpy(mon->capab, capab, sizeof(capab));
6956762816SKevin Wolf return true;
7056762816SKevin Wolf }
7156762816SKevin Wolf
qmp_qmp_capabilities(bool has_enable,QMPCapabilityList * enable,Error ** errp)7256762816SKevin Wolf void qmp_qmp_capabilities(bool has_enable, QMPCapabilityList *enable,
7356762816SKevin Wolf Error **errp)
7456762816SKevin Wolf {
75947e4744SKevin Wolf Monitor *cur_mon = monitor_cur();
7656762816SKevin Wolf MonitorQMP *mon;
7756762816SKevin Wolf
7856762816SKevin Wolf assert(monitor_is_qmp(cur_mon));
7956762816SKevin Wolf mon = container_of(cur_mon, MonitorQMP, common);
8056762816SKevin Wolf
8156762816SKevin Wolf if (mon->commands == &qmp_commands) {
8256762816SKevin Wolf error_set(errp, ERROR_CLASS_COMMAND_NOT_FOUND,
8356762816SKevin Wolf "Capabilities negotiation is already complete, command "
8456762816SKevin Wolf "ignored");
8556762816SKevin Wolf return;
8656762816SKevin Wolf }
8756762816SKevin Wolf
8856762816SKevin Wolf if (!qmp_caps_accept(mon, enable, errp)) {
8956762816SKevin Wolf return;
9056762816SKevin Wolf }
9156762816SKevin Wolf
9256762816SKevin Wolf mon->commands = &qmp_commands;
9356762816SKevin Wolf }
9456762816SKevin Wolf
qmp_query_version(Error ** errp)9556762816SKevin Wolf VersionInfo *qmp_query_version(Error **errp)
9656762816SKevin Wolf {
9756762816SKevin Wolf VersionInfo *info = g_new0(VersionInfo, 1);
9856762816SKevin Wolf
9956762816SKevin Wolf info->qemu = g_new0(VersionTriple, 1);
10056762816SKevin Wolf info->qemu->major = QEMU_VERSION_MAJOR;
10156762816SKevin Wolf info->qemu->minor = QEMU_VERSION_MINOR;
10256762816SKevin Wolf info->qemu->micro = QEMU_VERSION_MICRO;
10356762816SKevin Wolf info->package = g_strdup(QEMU_PKGVERSION);
10456762816SKevin Wolf
10556762816SKevin Wolf return info;
10656762816SKevin Wolf }
10756762816SKevin Wolf
query_commands_cb(const QmpCommand * cmd,void * opaque)108f0ccc00bSMarc-André Lureau static void query_commands_cb(const QmpCommand *cmd, void *opaque)
10956762816SKevin Wolf {
110240ee8bdSEric Blake CommandInfo *info;
111240ee8bdSEric Blake CommandInfoList **list = opaque;
11256762816SKevin Wolf
11356762816SKevin Wolf if (!cmd->enabled) {
11456762816SKevin Wolf return;
11556762816SKevin Wolf }
11656762816SKevin Wolf
11756762816SKevin Wolf info = g_malloc0(sizeof(*info));
118240ee8bdSEric Blake info->name = g_strdup(cmd->name);
119240ee8bdSEric Blake QAPI_LIST_PREPEND(*list, info);
12056762816SKevin Wolf }
12156762816SKevin Wolf
qmp_query_commands(Error ** errp)12256762816SKevin Wolf CommandInfoList *qmp_query_commands(Error **errp)
12356762816SKevin Wolf {
12456762816SKevin Wolf CommandInfoList *list = NULL;
125947e4744SKevin Wolf Monitor *cur_mon = monitor_cur();
12656762816SKevin Wolf MonitorQMP *mon;
12756762816SKevin Wolf
12856762816SKevin Wolf assert(monitor_is_qmp(cur_mon));
12956762816SKevin Wolf mon = container_of(cur_mon, MonitorQMP, common);
13056762816SKevin Wolf
13156762816SKevin Wolf qmp_for_each_command(mon->commands, query_commands_cb, &list);
13256762816SKevin Wolf
13356762816SKevin Wolf return list;
13456762816SKevin Wolf }
13556762816SKevin Wolf
split_off_generic_list(void * list,bool (* splitp)(void * elt),void ** part)136*2df68d77SMarkus Armbruster static void *split_off_generic_list(void *list,
137*2df68d77SMarkus Armbruster bool (*splitp)(void *elt),
138*2df68d77SMarkus Armbruster void **part)
139*2df68d77SMarkus Armbruster {
140*2df68d77SMarkus Armbruster GenericList *keep = NULL, **keep_tailp = &keep;
141*2df68d77SMarkus Armbruster GenericList *split = NULL, **split_tailp = &split;
142*2df68d77SMarkus Armbruster GenericList *tail;
143*2df68d77SMarkus Armbruster
144*2df68d77SMarkus Armbruster for (tail = list; tail; tail = tail->next) {
145*2df68d77SMarkus Armbruster if (splitp(tail)) {
146*2df68d77SMarkus Armbruster *split_tailp = tail;
147*2df68d77SMarkus Armbruster split_tailp = &tail->next;
148*2df68d77SMarkus Armbruster } else {
149*2df68d77SMarkus Armbruster *keep_tailp = tail;
150*2df68d77SMarkus Armbruster keep_tailp = &tail->next;
151*2df68d77SMarkus Armbruster }
152*2df68d77SMarkus Armbruster }
153*2df68d77SMarkus Armbruster
154*2df68d77SMarkus Armbruster *keep_tailp = *split_tailp = NULL;
155*2df68d77SMarkus Armbruster *part = split;
156*2df68d77SMarkus Armbruster return keep;
157*2df68d77SMarkus Armbruster }
158*2df68d77SMarkus Armbruster
is_in(const char * s,strList * list)159*2df68d77SMarkus Armbruster static bool is_in(const char *s, strList *list)
160*2df68d77SMarkus Armbruster {
161*2df68d77SMarkus Armbruster strList *tail;
162*2df68d77SMarkus Armbruster
163*2df68d77SMarkus Armbruster for (tail = list; tail; tail = tail->next) {
164*2df68d77SMarkus Armbruster if (!strcmp(tail->value, s)) {
165*2df68d77SMarkus Armbruster return true;
166*2df68d77SMarkus Armbruster }
167*2df68d77SMarkus Armbruster }
168*2df68d77SMarkus Armbruster return false;
169*2df68d77SMarkus Armbruster }
170*2df68d77SMarkus Armbruster
is_entity_deprecated(void * link)171*2df68d77SMarkus Armbruster static bool is_entity_deprecated(void *link)
172*2df68d77SMarkus Armbruster {
173*2df68d77SMarkus Armbruster return is_in("deprecated", ((SchemaInfoList *)link)->value->features);
174*2df68d77SMarkus Armbruster }
175*2df68d77SMarkus Armbruster
is_member_deprecated(void * link)176*2df68d77SMarkus Armbruster static bool is_member_deprecated(void *link)
177*2df68d77SMarkus Armbruster {
178*2df68d77SMarkus Armbruster return is_in("deprecated",
179*2df68d77SMarkus Armbruster ((SchemaInfoObjectMemberList *)link)->value->features);
180*2df68d77SMarkus Armbruster }
181*2df68d77SMarkus Armbruster
zap_deprecated(SchemaInfoList * schema)182*2df68d77SMarkus Armbruster static SchemaInfoList *zap_deprecated(SchemaInfoList *schema)
183*2df68d77SMarkus Armbruster {
184*2df68d77SMarkus Armbruster void *to_zap;
185*2df68d77SMarkus Armbruster SchemaInfoList *tail;
186*2df68d77SMarkus Armbruster SchemaInfo *ent;
187*2df68d77SMarkus Armbruster
188*2df68d77SMarkus Armbruster schema = split_off_generic_list(schema, is_entity_deprecated, &to_zap);
189*2df68d77SMarkus Armbruster qapi_free_SchemaInfoList(to_zap);
190*2df68d77SMarkus Armbruster
191*2df68d77SMarkus Armbruster for (tail = schema; tail; tail = tail->next) {
192*2df68d77SMarkus Armbruster ent = tail->value;
193*2df68d77SMarkus Armbruster if (ent->meta_type == SCHEMA_META_TYPE_OBJECT) {
194*2df68d77SMarkus Armbruster ent->u.object.members
195*2df68d77SMarkus Armbruster = split_off_generic_list(ent->u.object.members,
196*2df68d77SMarkus Armbruster is_member_deprecated, &to_zap);
197*2df68d77SMarkus Armbruster qapi_free_SchemaInfoObjectMemberList(to_zap);
198*2df68d77SMarkus Armbruster }
199*2df68d77SMarkus Armbruster }
200*2df68d77SMarkus Armbruster
201*2df68d77SMarkus Armbruster return schema;
202*2df68d77SMarkus Armbruster }
203*2df68d77SMarkus Armbruster
qmp_query_qmp_schema(Error ** errp)204624fa80cSMarkus Armbruster SchemaInfoList *qmp_query_qmp_schema(Error **errp)
2057d3f5053SKevin Wolf {
206624fa80cSMarkus Armbruster QObject *obj = qobject_from_qlit(&qmp_schema_qlit);
207624fa80cSMarkus Armbruster Visitor *v = qobject_input_visitor_new(obj);
208624fa80cSMarkus Armbruster SchemaInfoList *schema = NULL;
209624fa80cSMarkus Armbruster
210624fa80cSMarkus Armbruster /* test_visitor_in_qmp_introspect() ensures this can't fail */
211624fa80cSMarkus Armbruster visit_type_SchemaInfoList(v, NULL, &schema, &error_abort);
212624fa80cSMarkus Armbruster g_assert(schema);
213624fa80cSMarkus Armbruster
214624fa80cSMarkus Armbruster qobject_unref(obj);
215624fa80cSMarkus Armbruster visit_free(v);
216624fa80cSMarkus Armbruster
217*2df68d77SMarkus Armbruster if (compat_policy.deprecated_output == COMPAT_POLICY_OUTPUT_HIDE) {
218*2df68d77SMarkus Armbruster return zap_deprecated(schema);
219*2df68d77SMarkus Armbruster }
220624fa80cSMarkus Armbruster return schema;
2217d3f5053SKevin Wolf }
222