]>
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 MAL |
7 | #include "qapi/qmp/qjson.h" |
8 | #include "qapi/qmp/qstring.h" | |
d6a5beeb | 9 | #include "qapi/qobject-input-visitor.h" |
269e09f3 | 10 | #include "qom/object_interfaces.h" |
3e9297f3 | 11 | #include "qemu/help_option.h" |
269e09f3 | 12 | #include "qemu/module.h" |
922a01a0 | 13 | #include "qemu/option.h" |
90998d58 | 14 | #include "qapi/opts-visitor.h" |
c645d5ac | 15 | #include "qemu/config-file.h" |
269e09f3 | 16 | |
6fd5bef1 | 17 | bool user_creatable_complete(UserCreatable *uc, Error **errp) |
269e09f3 | 18 | { |
3650b2de | 19 | UserCreatableClass *ucc = USER_CREATABLE_GET_CLASS(uc); |
6fd5bef1 | 20 | Error *err = NULL; |
269e09f3 | 21 | |
269e09f3 | 22 | if (ucc->complete) { |
6fd5bef1 MA |
23 | ucc->complete(uc, &err); |
24 | error_propagate(errp, err); | |
269e09f3 | 25 | } |
6fd5bef1 | 26 | return !err; |
269e09f3 IM |
27 | } |
28 | ||
3beacfb9 | 29 | bool user_creatable_can_be_deleted(UserCreatable *uc) |
d6edb155 LM |
30 | { |
31 | ||
32 | UserCreatableClass *ucc = USER_CREATABLE_GET_CLASS(uc); | |
33 | ||
34 | if (ucc->can_be_deleted) { | |
3beacfb9 | 35 | return ucc->can_be_deleted(uc); |
d6edb155 LM |
36 | } else { |
37 | return true; | |
38 | } | |
39 | } | |
40 | ||
90998d58 DB |
41 | Object *user_creatable_add_type(const char *type, const char *id, |
42 | const QDict *qdict, | |
43 | Visitor *v, Error **errp) | |
44 | { | |
45 | Object *obj; | |
46 | ObjectClass *klass; | |
47 | const QDictEntry *e; | |
48 | Error *local_err = NULL; | |
49 | ||
50 | klass = object_class_by_name(type); | |
51 | if (!klass) { | |
52 | error_setg(errp, "invalid object type: %s", type); | |
53 | return NULL; | |
54 | } | |
55 | ||
56 | if (!object_class_dynamic_cast(klass, TYPE_USER_CREATABLE)) { | |
57 | error_setg(errp, "object type '%s' isn't supported by object-add", | |
58 | type); | |
59 | return NULL; | |
60 | } | |
61 | ||
62 | if (object_class_is_abstract(klass)) { | |
63 | error_setg(errp, "object type '%s' is abstract", type); | |
64 | return NULL; | |
65 | } | |
66 | ||
ad739706 | 67 | assert(qdict); |
90998d58 | 68 | obj = object_new(type); |
62a35aaa | 69 | if (!visit_start_struct(v, NULL, NULL, 0, &local_err)) { |
ad739706 EB |
70 | goto out; |
71 | } | |
72 | for (e = qdict_first(qdict); e; e = qdict_next(qdict, e)) { | |
778a2dc5 | 73 | if (!object_property_set(obj, e->key, v, &local_err)) { |
ad739706 | 74 | break; |
90998d58 DB |
75 | } |
76 | } | |
15c2f669 EB |
77 | if (!local_err) { |
78 | visit_check_struct(v, &local_err); | |
79 | } | |
1158bb2a | 80 | visit_end_struct(v, NULL); |
ad739706 EB |
81 | if (local_err) { |
82 | goto out; | |
83 | } | |
90998d58 | 84 | |
6134d752 | 85 | if (id != NULL) { |
db57fef1 EA |
86 | object_property_try_add_child(object_get_objects_root(), |
87 | id, obj, &local_err); | |
88 | if (local_err) { | |
89 | goto out; | |
90 | } | |
90998d58 DB |
91 | } |
92 | ||
778a2dc5 | 93 | if (!user_creatable_complete(USER_CREATABLE(obj), &local_err)) { |
6134d752 | 94 | if (id != NULL) { |
df4fe0b2 | 95 | object_property_del(object_get_objects_root(), id); |
6134d752 | 96 | } |
90998d58 DB |
97 | goto out; |
98 | } | |
99 | out: | |
100 | if (local_err) { | |
101 | error_propagate(errp, local_err); | |
102 | object_unref(obj); | |
103 | return NULL; | |
104 | } | |
105 | return obj; | |
106 | } | |
107 | ||
6fd5bef1 | 108 | bool user_creatable_add_dict(QDict *qdict, bool keyval, Error **errp) |
d6a5beeb KW |
109 | { |
110 | Visitor *v; | |
111 | Object *obj; | |
112 | g_autofree char *type = NULL; | |
113 | g_autofree char *id = NULL; | |
114 | ||
115 | type = g_strdup(qdict_get_try_str(qdict, "qom-type")); | |
116 | if (!type) { | |
117 | error_setg(errp, QERR_MISSING_PARAMETER, "qom-type"); | |
6fd5bef1 | 118 | return false; |
d6a5beeb KW |
119 | } |
120 | qdict_del(qdict, "qom-type"); | |
121 | ||
122 | id = g_strdup(qdict_get_try_str(qdict, "id")); | |
123 | if (!id) { | |
124 | error_setg(errp, QERR_MISSING_PARAMETER, "id"); | |
6fd5bef1 | 125 | return false; |
d6a5beeb KW |
126 | } |
127 | qdict_del(qdict, "id"); | |
128 | ||
eaae29ef KW |
129 | if (keyval) { |
130 | v = qobject_input_visitor_new_keyval(QOBJECT(qdict)); | |
131 | } else { | |
132 | v = qobject_input_visitor_new(QOBJECT(qdict)); | |
133 | } | |
d6a5beeb KW |
134 | obj = user_creatable_add_type(type, id, qdict, v, errp); |
135 | visit_free(v); | |
136 | object_unref(obj); | |
6fd5bef1 | 137 | return !!obj; |
d6a5beeb | 138 | } |
90998d58 DB |
139 | |
140 | Object *user_creatable_add_opts(QemuOpts *opts, Error **errp) | |
141 | { | |
09204eac | 142 | Visitor *v; |
90998d58 | 143 | QDict *pdict; |
3a464105 IM |
144 | Object *obj; |
145 | const char *id = qemu_opts_id(opts); | |
9a6d1acb | 146 | char *type = qemu_opt_get_del(opts, "qom-type"); |
3a464105 IM |
147 | |
148 | if (!type) { | |
149 | error_setg(errp, QERR_MISSING_PARAMETER, "qom-type"); | |
150 | return NULL; | |
151 | } | |
152 | if (!id) { | |
153 | error_setg(errp, QERR_MISSING_PARAMETER, "id"); | |
08329701 | 154 | qemu_opt_set(opts, "qom-type", type, &error_abort); |
9a6d1acb | 155 | g_free(type); |
3a464105 IM |
156 | return NULL; |
157 | } | |
90998d58 | 158 | |
9a6d1acb | 159 | qemu_opts_set_id(opts, NULL); |
90998d58 DB |
160 | pdict = qemu_opts_to_qdict(opts, NULL); |
161 | ||
3a464105 IM |
162 | v = opts_visitor_new(opts); |
163 | obj = user_creatable_add_type(type, id, pdict, v, errp); | |
09204eac | 164 | visit_free(v); |
3a464105 | 165 | |
9a6d1acb | 166 | qemu_opts_set_id(opts, (char *) id); |
08329701 | 167 | qemu_opt_set(opts, "qom-type", type, &error_abort); |
9a6d1acb | 168 | g_free(type); |
cb3e7f08 | 169 | qobject_unref(pdict); |
90998d58 DB |
170 | return obj; |
171 | } | |
172 | ||
173 | ||
174 | int user_creatable_add_opts_foreach(void *opaque, QemuOpts *opts, Error **errp) | |
175 | { | |
1195fa2b | 176 | bool (*type_opt_predicate)(const char *, QemuOpts *) = opaque; |
90998d58 DB |
177 | Object *obj = NULL; |
178 | const char *type; | |
179 | ||
180 | type = qemu_opt_get(opts, "qom-type"); | |
1195fa2b MAL |
181 | if (type && type_opt_predicate && |
182 | !type_opt_predicate(type, opts)) { | |
90998d58 DB |
183 | return 0; |
184 | } | |
185 | ||
7e1e0c11 | 186 | obj = user_creatable_add_opts(opts, errp); |
90998d58 DB |
187 | if (!obj) { |
188 | return -1; | |
189 | } | |
190 | object_unref(obj); | |
191 | return 0; | |
192 | } | |
193 | ||
4df81616 MAL |
194 | char *object_property_help(const char *name, const char *type, |
195 | QObject *defval, const char *description) | |
196 | { | |
197 | GString *str = g_string_new(NULL); | |
198 | ||
199 | g_string_append_printf(str, " %s=<%s>", name, type); | |
200 | if (description || defval) { | |
201 | if (str->len < 24) { | |
202 | g_string_append_printf(str, "%*s", 24 - (int)str->len, ""); | |
203 | } | |
204 | g_string_append(str, " - "); | |
205 | } | |
206 | if (description) { | |
207 | g_string_append(str, description); | |
208 | } | |
209 | if (defval) { | |
210 | g_autofree char *def_json = qstring_free(qobject_to_json(defval), TRUE); | |
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 | |
6fd5bef1 | 282 | bool user_creatable_del(const char *id, Error **errp) |
90998d58 DB |
283 | { |
284 | Object *container; | |
285 | Object *obj; | |
286 | ||
287 | container = object_get_objects_root(); | |
288 | obj = object_resolve_path_component(container, id); | |
289 | if (!obj) { | |
290 | error_setg(errp, "object '%s' not found", id); | |
6fd5bef1 | 291 | return false; |
90998d58 DB |
292 | } |
293 | ||
3beacfb9 | 294 | if (!user_creatable_can_be_deleted(USER_CREATABLE(obj))) { |
90998d58 | 295 | error_setg(errp, "object '%s' is in use, can not be deleted", id); |
6fd5bef1 | 296 | return false; |
90998d58 | 297 | } |
c645d5ac MR |
298 | |
299 | /* | |
300 | * if object was defined on the command-line, remove its corresponding | |
301 | * option group entry | |
302 | */ | |
303 | qemu_opts_del(qemu_opts_find(qemu_find_opts_err("object", &error_abort), | |
304 | id)); | |
305 | ||
90998d58 | 306 | object_unparent(obj); |
6fd5bef1 | 307 | return true; |
90998d58 DB |
308 | } |
309 | ||
9d5139e5 EH |
310 | void user_creatable_cleanup(void) |
311 | { | |
312 | object_unparent(object_get_objects_root()); | |
313 | } | |
314 | ||
269e09f3 IM |
315 | static void register_types(void) |
316 | { | |
317 | static const TypeInfo uc_interface_info = { | |
318 | .name = TYPE_USER_CREATABLE, | |
319 | .parent = TYPE_INTERFACE, | |
320 | .class_size = sizeof(UserCreatableClass), | |
321 | }; | |
322 | ||
323 | type_register_static(&uc_interface_info); | |
324 | } | |
325 | ||
326 | type_init(register_types) |