]>
Commit | Line | Data |
---|---|---|
9bbc853b | 1 | #include "qemu/osdep.h" |
3e9297f3 KW |
2 | |
3 | #include "qemu/cutils.h" | |
da34e65c | 4 | #include "qapi/error.h" |
452fcdbc | 5 | #include "qapi/qmp/qdict.h" |
0dd13589 | 6 | #include "qapi/qmp/qerror.h" |
4df81616 | 7 | #include "qapi/qmp/qjson.h" |
d6a5beeb | 8 | #include "qapi/qobject-input-visitor.h" |
269e09f3 | 9 | #include "qom/object_interfaces.h" |
3e9297f3 | 10 | #include "qemu/help_option.h" |
269e09f3 | 11 | #include "qemu/module.h" |
922a01a0 | 12 | #include "qemu/option.h" |
90998d58 | 13 | #include "qapi/opts-visitor.h" |
c645d5ac | 14 | #include "qemu/config-file.h" |
269e09f3 | 15 | |
6fd5bef1 | 16 | bool user_creatable_complete(UserCreatable *uc, Error **errp) |
269e09f3 | 17 | { |
3650b2de | 18 | UserCreatableClass *ucc = USER_CREATABLE_GET_CLASS(uc); |
6fd5bef1 | 19 | Error *err = NULL; |
269e09f3 | 20 | |
269e09f3 | 21 | if (ucc->complete) { |
6fd5bef1 MA |
22 | ucc->complete(uc, &err); |
23 | error_propagate(errp, err); | |
269e09f3 | 24 | } |
6fd5bef1 | 25 | return !err; |
269e09f3 IM |
26 | } |
27 | ||
3beacfb9 | 28 | bool user_creatable_can_be_deleted(UserCreatable *uc) |
d6edb155 LM |
29 | { |
30 | ||
31 | UserCreatableClass *ucc = USER_CREATABLE_GET_CLASS(uc); | |
32 | ||
33 | if (ucc->can_be_deleted) { | |
3beacfb9 | 34 | return ucc->can_be_deleted(uc); |
d6edb155 LM |
35 | } else { |
36 | return true; | |
37 | } | |
38 | } | |
39 | ||
90998d58 DB |
40 | Object *user_creatable_add_type(const char *type, const char *id, |
41 | const QDict *qdict, | |
42 | Visitor *v, Error **errp) | |
43 | { | |
44 | Object *obj; | |
45 | ObjectClass *klass; | |
46 | const QDictEntry *e; | |
47 | Error *local_err = NULL; | |
48 | ||
49 | klass = object_class_by_name(type); | |
50 | if (!klass) { | |
51 | error_setg(errp, "invalid object type: %s", type); | |
52 | return NULL; | |
53 | } | |
54 | ||
55 | if (!object_class_dynamic_cast(klass, TYPE_USER_CREATABLE)) { | |
56 | error_setg(errp, "object type '%s' isn't supported by object-add", | |
57 | type); | |
58 | return NULL; | |
59 | } | |
60 | ||
61 | if (object_class_is_abstract(klass)) { | |
62 | error_setg(errp, "object type '%s' is abstract", type); | |
63 | return NULL; | |
64 | } | |
65 | ||
ad739706 | 66 | assert(qdict); |
90998d58 | 67 | obj = object_new(type); |
62a35aaa | 68 | if (!visit_start_struct(v, NULL, NULL, 0, &local_err)) { |
ad739706 EB |
69 | goto out; |
70 | } | |
71 | for (e = qdict_first(qdict); e; e = qdict_next(qdict, e)) { | |
778a2dc5 | 72 | if (!object_property_set(obj, e->key, v, &local_err)) { |
ad739706 | 73 | break; |
90998d58 DB |
74 | } |
75 | } | |
15c2f669 EB |
76 | if (!local_err) { |
77 | visit_check_struct(v, &local_err); | |
78 | } | |
1158bb2a | 79 | visit_end_struct(v, NULL); |
ad739706 EB |
80 | if (local_err) { |
81 | goto out; | |
82 | } | |
90998d58 | 83 | |
6134d752 | 84 | if (id != NULL) { |
db57fef1 EA |
85 | object_property_try_add_child(object_get_objects_root(), |
86 | id, obj, &local_err); | |
87 | if (local_err) { | |
88 | goto out; | |
89 | } | |
90998d58 DB |
90 | } |
91 | ||
778a2dc5 | 92 | if (!user_creatable_complete(USER_CREATABLE(obj), &local_err)) { |
6134d752 | 93 | if (id != NULL) { |
df4fe0b2 | 94 | object_property_del(object_get_objects_root(), id); |
6134d752 | 95 | } |
90998d58 DB |
96 | goto out; |
97 | } | |
98 | out: | |
99 | if (local_err) { | |
100 | error_propagate(errp, local_err); | |
101 | object_unref(obj); | |
102 | return NULL; | |
103 | } | |
104 | return obj; | |
105 | } | |
106 | ||
6fd5bef1 | 107 | bool user_creatable_add_dict(QDict *qdict, bool keyval, Error **errp) |
d6a5beeb KW |
108 | { |
109 | Visitor *v; | |
110 | Object *obj; | |
111 | g_autofree char *type = NULL; | |
112 | g_autofree char *id = NULL; | |
113 | ||
114 | type = g_strdup(qdict_get_try_str(qdict, "qom-type")); | |
115 | if (!type) { | |
116 | error_setg(errp, QERR_MISSING_PARAMETER, "qom-type"); | |
6fd5bef1 | 117 | return false; |
d6a5beeb KW |
118 | } |
119 | qdict_del(qdict, "qom-type"); | |
120 | ||
121 | id = g_strdup(qdict_get_try_str(qdict, "id")); | |
122 | if (!id) { | |
123 | error_setg(errp, QERR_MISSING_PARAMETER, "id"); | |
6fd5bef1 | 124 | return false; |
d6a5beeb KW |
125 | } |
126 | qdict_del(qdict, "id"); | |
127 | ||
eaae29ef KW |
128 | if (keyval) { |
129 | v = qobject_input_visitor_new_keyval(QOBJECT(qdict)); | |
130 | } else { | |
131 | v = qobject_input_visitor_new(QOBJECT(qdict)); | |
132 | } | |
d6a5beeb KW |
133 | obj = user_creatable_add_type(type, id, qdict, v, errp); |
134 | visit_free(v); | |
135 | object_unref(obj); | |
6fd5bef1 | 136 | return !!obj; |
d6a5beeb | 137 | } |
90998d58 DB |
138 | |
139 | Object *user_creatable_add_opts(QemuOpts *opts, Error **errp) | |
140 | { | |
09204eac | 141 | Visitor *v; |
90998d58 | 142 | QDict *pdict; |
3a464105 IM |
143 | Object *obj; |
144 | const char *id = qemu_opts_id(opts); | |
9a6d1acb | 145 | char *type = qemu_opt_get_del(opts, "qom-type"); |
3a464105 IM |
146 | |
147 | if (!type) { | |
148 | error_setg(errp, QERR_MISSING_PARAMETER, "qom-type"); | |
149 | return NULL; | |
150 | } | |
151 | if (!id) { | |
152 | error_setg(errp, QERR_MISSING_PARAMETER, "id"); | |
08329701 | 153 | qemu_opt_set(opts, "qom-type", type, &error_abort); |
9a6d1acb | 154 | g_free(type); |
3a464105 IM |
155 | return NULL; |
156 | } | |
90998d58 | 157 | |
9a6d1acb | 158 | qemu_opts_set_id(opts, NULL); |
90998d58 DB |
159 | pdict = qemu_opts_to_qdict(opts, NULL); |
160 | ||
3a464105 IM |
161 | v = opts_visitor_new(opts); |
162 | obj = user_creatable_add_type(type, id, pdict, v, errp); | |
09204eac | 163 | visit_free(v); |
3a464105 | 164 | |
9a6d1acb | 165 | qemu_opts_set_id(opts, (char *) id); |
08329701 | 166 | qemu_opt_set(opts, "qom-type", type, &error_abort); |
9a6d1acb | 167 | g_free(type); |
cb3e7f08 | 168 | qobject_unref(pdict); |
90998d58 DB |
169 | return obj; |
170 | } | |
171 | ||
172 | ||
173 | int user_creatable_add_opts_foreach(void *opaque, QemuOpts *opts, Error **errp) | |
174 | { | |
1195fa2b | 175 | bool (*type_opt_predicate)(const char *, QemuOpts *) = opaque; |
90998d58 DB |
176 | Object *obj = NULL; |
177 | const char *type; | |
178 | ||
179 | type = qemu_opt_get(opts, "qom-type"); | |
1195fa2b MAL |
180 | if (type && type_opt_predicate && |
181 | !type_opt_predicate(type, opts)) { | |
90998d58 DB |
182 | return 0; |
183 | } | |
184 | ||
7e1e0c11 | 185 | obj = user_creatable_add_opts(opts, errp); |
90998d58 DB |
186 | if (!obj) { |
187 | return -1; | |
188 | } | |
189 | object_unref(obj); | |
190 | return 0; | |
191 | } | |
192 | ||
4df81616 MAL |
193 | char *object_property_help(const char *name, const char *type, |
194 | QObject *defval, const char *description) | |
195 | { | |
196 | GString *str = g_string_new(NULL); | |
197 | ||
198 | g_string_append_printf(str, " %s=<%s>", name, type); | |
199 | if (description || defval) { | |
200 | if (str->len < 24) { | |
201 | g_string_append_printf(str, "%*s", 24 - (int)str->len, ""); | |
202 | } | |
203 | g_string_append(str, " - "); | |
204 | } | |
205 | if (description) { | |
206 | g_string_append(str, description); | |
207 | } | |
208 | if (defval) { | |
eab3a467 MA |
209 | g_autofree char *def_json = g_string_free(qobject_to_json(defval), |
210 | true); | |
4df81616 MAL |
211 | g_string_append_printf(str, " (default: %s)", def_json); |
212 | } | |
213 | ||
214 | return g_string_free(str, false); | |
215 | } | |
216 | ||
0e301d44 KW |
217 | static void user_creatable_print_types(void) |
218 | { | |
219 | GSList *l, *list; | |
220 | ||
221 | printf("List of user creatable objects:\n"); | |
222 | list = object_class_get_list_sorted(TYPE_USER_CREATABLE, false); | |
223 | for (l = list; l != NULL; l = l->next) { | |
224 | ObjectClass *oc = OBJECT_CLASS(l->data); | |
225 | printf(" %s\n", object_class_get_name(oc)); | |
226 | } | |
227 | g_slist_free(list); | |
228 | } | |
229 | ||
230 | static bool user_creatable_print_type_properites(const char *type) | |
3e9297f3 KW |
231 | { |
232 | ObjectClass *klass; | |
0e301d44 KW |
233 | ObjectPropertyIterator iter; |
234 | ObjectProperty *prop; | |
235 | GPtrArray *array; | |
236 | int i; | |
3e9297f3 | 237 | |
0e301d44 KW |
238 | klass = object_class_by_name(type); |
239 | if (!klass) { | |
240 | return false; | |
241 | } | |
3e9297f3 | 242 | |
0e301d44 KW |
243 | array = g_ptr_array_new(); |
244 | object_class_property_iter_init(&iter, klass); | |
245 | while ((prop = object_property_iter_next(&iter))) { | |
246 | if (!prop->set) { | |
247 | continue; | |
3e9297f3 | 248 | } |
0e301d44 KW |
249 | |
250 | g_ptr_array_add(array, | |
251 | object_property_help(prop->name, prop->type, | |
252 | prop->defval, prop->description)); | |
3e9297f3 | 253 | } |
0e301d44 KW |
254 | g_ptr_array_sort(array, (GCompareFunc)qemu_pstrcmp0); |
255 | if (array->len > 0) { | |
256 | printf("%s options:\n", type); | |
257 | } else { | |
258 | printf("There are no options for %s.\n", type); | |
259 | } | |
260 | for (i = 0; i < array->len; i++) { | |
261 | printf("%s\n", (char *)array->pdata[i]); | |
262 | } | |
263 | g_ptr_array_set_free_func(array, g_free); | |
264 | g_ptr_array_free(array, true); | |
265 | return true; | |
266 | } | |
3e9297f3 | 267 | |
0e301d44 KW |
268 | bool user_creatable_print_help(const char *type, QemuOpts *opts) |
269 | { | |
270 | if (is_help_option(type)) { | |
271 | user_creatable_print_types(); | |
3e9297f3 KW |
272 | return true; |
273 | } | |
274 | ||
0e301d44 KW |
275 | if (qemu_opt_has_help_opt(opts)) { |
276 | return user_creatable_print_type_properites(type); | |
277 | } | |
278 | ||
3e9297f3 KW |
279 | return false; |
280 | } | |
90998d58 | 281 | |
c9ac1458 KW |
282 | void user_creatable_print_help_from_qdict(QDict *args) |
283 | { | |
284 | const char *type = qdict_get_try_str(args, "qom-type"); | |
285 | ||
286 | if (!type || !user_creatable_print_type_properites(type)) { | |
287 | user_creatable_print_types(); | |
288 | } | |
289 | } | |
290 | ||
6fd5bef1 | 291 | bool user_creatable_del(const char *id, Error **errp) |
90998d58 DB |
292 | { |
293 | Object *container; | |
294 | Object *obj; | |
295 | ||
296 | container = object_get_objects_root(); | |
297 | obj = object_resolve_path_component(container, id); | |
298 | if (!obj) { | |
299 | error_setg(errp, "object '%s' not found", id); | |
6fd5bef1 | 300 | return false; |
90998d58 DB |
301 | } |
302 | ||
3beacfb9 | 303 | if (!user_creatable_can_be_deleted(USER_CREATABLE(obj))) { |
90998d58 | 304 | error_setg(errp, "object '%s' is in use, can not be deleted", id); |
6fd5bef1 | 305 | return false; |
90998d58 | 306 | } |
c645d5ac MR |
307 | |
308 | /* | |
309 | * if object was defined on the command-line, remove its corresponding | |
310 | * option group entry | |
311 | */ | |
312 | qemu_opts_del(qemu_opts_find(qemu_find_opts_err("object", &error_abort), | |
313 | id)); | |
314 | ||
90998d58 | 315 | object_unparent(obj); |
6fd5bef1 | 316 | return true; |
90998d58 DB |
317 | } |
318 | ||
9d5139e5 EH |
319 | void user_creatable_cleanup(void) |
320 | { | |
321 | object_unparent(object_get_objects_root()); | |
322 | } | |
323 | ||
269e09f3 IM |
324 | static void register_types(void) |
325 | { | |
326 | static const TypeInfo uc_interface_info = { | |
327 | .name = TYPE_USER_CREATABLE, | |
328 | .parent = TYPE_INTERFACE, | |
329 | .class_size = sizeof(UserCreatableClass), | |
330 | }; | |
331 | ||
332 | type_register_static(&uc_interface_info); | |
333 | } | |
334 | ||
335 | type_init(register_types) |