1 #include "qemu/osdep.h" 2 3 #include "qemu/cutils.h" 4 #include "qapi/error.h" 5 #include "qapi/qmp/qdict.h" 6 #include "qapi/qmp/qerror.h" 7 #include "qapi/qmp/qjson.h" 8 #include "qapi/qmp/qstring.h" 9 #include "qapi/qobject-input-visitor.h" 10 #include "qom/object_interfaces.h" 11 #include "qemu/help_option.h" 12 #include "qemu/module.h" 13 #include "qemu/option.h" 14 #include "qapi/opts-visitor.h" 15 #include "qemu/config-file.h" 16 17 bool user_creatable_complete(UserCreatable *uc, Error **errp) 18 { 19 UserCreatableClass *ucc = USER_CREATABLE_GET_CLASS(uc); 20 Error *err = NULL; 21 22 if (ucc->complete) { 23 ucc->complete(uc, &err); 24 error_propagate(errp, err); 25 } 26 return !err; 27 } 28 29 bool user_creatable_can_be_deleted(UserCreatable *uc) 30 { 31 32 UserCreatableClass *ucc = USER_CREATABLE_GET_CLASS(uc); 33 34 if (ucc->can_be_deleted) { 35 return ucc->can_be_deleted(uc); 36 } else { 37 return true; 38 } 39 } 40 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 67 assert(qdict); 68 obj = object_new(type); 69 if (!visit_start_struct(v, NULL, NULL, 0, &local_err)) { 70 goto out; 71 } 72 for (e = qdict_first(qdict); e; e = qdict_next(qdict, e)) { 73 if (!object_property_set(obj, e->key, v, &local_err)) { 74 break; 75 } 76 } 77 if (!local_err) { 78 visit_check_struct(v, &local_err); 79 } 80 visit_end_struct(v, NULL); 81 if (local_err) { 82 goto out; 83 } 84 85 if (id != NULL) { 86 object_property_try_add_child(object_get_objects_root(), 87 id, obj, &local_err); 88 if (local_err) { 89 goto out; 90 } 91 } 92 93 if (!user_creatable_complete(USER_CREATABLE(obj), &local_err)) { 94 if (id != NULL) { 95 object_property_del(object_get_objects_root(), id); 96 } 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 108 bool user_creatable_add_dict(QDict *qdict, bool keyval, Error **errp) 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"); 118 return false; 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"); 125 return false; 126 } 127 qdict_del(qdict, "id"); 128 129 if (keyval) { 130 v = qobject_input_visitor_new_keyval(QOBJECT(qdict)); 131 } else { 132 v = qobject_input_visitor_new(QOBJECT(qdict)); 133 } 134 obj = user_creatable_add_type(type, id, qdict, v, errp); 135 visit_free(v); 136 object_unref(obj); 137 return !!obj; 138 } 139 140 Object *user_creatable_add_opts(QemuOpts *opts, Error **errp) 141 { 142 Visitor *v; 143 QDict *pdict; 144 Object *obj; 145 const char *id = qemu_opts_id(opts); 146 char *type = qemu_opt_get_del(opts, "qom-type"); 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"); 154 qemu_opt_set(opts, "qom-type", type, &error_abort); 155 g_free(type); 156 return NULL; 157 } 158 159 qemu_opts_set_id(opts, NULL); 160 pdict = qemu_opts_to_qdict(opts, NULL); 161 162 v = opts_visitor_new(opts); 163 obj = user_creatable_add_type(type, id, pdict, v, errp); 164 visit_free(v); 165 166 qemu_opts_set_id(opts, (char *) id); 167 qemu_opt_set(opts, "qom-type", type, &error_abort); 168 g_free(type); 169 qobject_unref(pdict); 170 return obj; 171 } 172 173 174 int user_creatable_add_opts_foreach(void *opaque, QemuOpts *opts, Error **errp) 175 { 176 bool (*type_opt_predicate)(const char *, QemuOpts *) = opaque; 177 Object *obj = NULL; 178 const char *type; 179 180 type = qemu_opt_get(opts, "qom-type"); 181 if (type && type_opt_predicate && 182 !type_opt_predicate(type, opts)) { 183 return 0; 184 } 185 186 obj = user_creatable_add_opts(opts, errp); 187 if (!obj) { 188 return -1; 189 } 190 object_unref(obj); 191 return 0; 192 } 193 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 217 bool user_creatable_print_help(const char *type, QemuOpts *opts) 218 { 219 ObjectClass *klass; 220 221 if (is_help_option(type)) { 222 GSList *l, *list; 223 224 printf("List of user creatable objects:\n"); 225 list = object_class_get_list_sorted(TYPE_USER_CREATABLE, false); 226 for (l = list; l != NULL; l = l->next) { 227 ObjectClass *oc = OBJECT_CLASS(l->data); 228 printf(" %s\n", object_class_get_name(oc)); 229 } 230 g_slist_free(list); 231 return true; 232 } 233 234 klass = object_class_by_name(type); 235 if (klass && qemu_opt_has_help_opt(opts)) { 236 ObjectPropertyIterator iter; 237 ObjectProperty *prop; 238 GPtrArray *array = g_ptr_array_new(); 239 int i; 240 241 object_class_property_iter_init(&iter, klass); 242 while ((prop = object_property_iter_next(&iter))) { 243 if (!prop->set) { 244 continue; 245 } 246 247 g_ptr_array_add(array, 248 object_property_help(prop->name, prop->type, 249 prop->defval, prop->description)); 250 } 251 g_ptr_array_sort(array, (GCompareFunc)qemu_pstrcmp0); 252 if (array->len > 0) { 253 printf("%s options:\n", type); 254 } else { 255 printf("There are no options for %s.\n", type); 256 } 257 for (i = 0; i < array->len; i++) { 258 printf("%s\n", (char *)array->pdata[i]); 259 } 260 g_ptr_array_set_free_func(array, g_free); 261 g_ptr_array_free(array, true); 262 return true; 263 } 264 265 return false; 266 } 267 268 bool user_creatable_del(const char *id, Error **errp) 269 { 270 Object *container; 271 Object *obj; 272 273 container = object_get_objects_root(); 274 obj = object_resolve_path_component(container, id); 275 if (!obj) { 276 error_setg(errp, "object '%s' not found", id); 277 return false; 278 } 279 280 if (!user_creatable_can_be_deleted(USER_CREATABLE(obj))) { 281 error_setg(errp, "object '%s' is in use, can not be deleted", id); 282 return false; 283 } 284 285 /* 286 * if object was defined on the command-line, remove its corresponding 287 * option group entry 288 */ 289 qemu_opts_del(qemu_opts_find(qemu_find_opts_err("object", &error_abort), 290 id)); 291 292 object_unparent(obj); 293 return true; 294 } 295 296 void user_creatable_cleanup(void) 297 { 298 object_unparent(object_get_objects_root()); 299 } 300 301 static void register_types(void) 302 { 303 static const TypeInfo uc_interface_info = { 304 .name = TYPE_USER_CREATABLE, 305 .parent = TYPE_INTERFACE, 306 .class_size = sizeof(UserCreatableClass), 307 }; 308 309 type_register_static(&uc_interface_info); 310 } 311 312 type_init(register_types) 313