xref: /qemu/qom/object_interfaces.c (revision 08329701)
19bbc853bSPeter Maydell #include "qemu/osdep.h"
2da34e65cSMarkus Armbruster #include "qapi/error.h"
3269e09f3SIgor Mammedov #include "qom/object_interfaces.h"
4269e09f3SIgor Mammedov #include "qemu/module.h"
590998d58SDaniel P. Berrange #include "qapi-visit.h"
690998d58SDaniel P. Berrange #include "qapi/opts-visitor.h"
7269e09f3SIgor Mammedov 
8269e09f3SIgor Mammedov void user_creatable_complete(Object *obj, Error **errp)
9269e09f3SIgor Mammedov {
10269e09f3SIgor Mammedov 
11269e09f3SIgor Mammedov     UserCreatableClass *ucc;
12269e09f3SIgor Mammedov     UserCreatable *uc =
13269e09f3SIgor Mammedov         (UserCreatable *)object_dynamic_cast(obj, TYPE_USER_CREATABLE);
14269e09f3SIgor Mammedov 
15269e09f3SIgor Mammedov     if (!uc) {
16269e09f3SIgor Mammedov         return;
17269e09f3SIgor Mammedov     }
18269e09f3SIgor Mammedov 
19269e09f3SIgor Mammedov     ucc = USER_CREATABLE_GET_CLASS(uc);
20269e09f3SIgor Mammedov     if (ucc->complete) {
21269e09f3SIgor Mammedov         ucc->complete(uc, errp);
22269e09f3SIgor Mammedov     }
23269e09f3SIgor Mammedov }
24269e09f3SIgor Mammedov 
25d6edb155SLin Ma bool user_creatable_can_be_deleted(UserCreatable *uc, Error **errp)
26d6edb155SLin Ma {
27d6edb155SLin Ma 
28d6edb155SLin Ma     UserCreatableClass *ucc = USER_CREATABLE_GET_CLASS(uc);
29d6edb155SLin Ma 
30d6edb155SLin Ma     if (ucc->can_be_deleted) {
31d6edb155SLin Ma         return ucc->can_be_deleted(uc, errp);
32d6edb155SLin Ma     } else {
33d6edb155SLin Ma         return true;
34d6edb155SLin Ma     }
35d6edb155SLin Ma }
36d6edb155SLin Ma 
3790998d58SDaniel P. Berrange Object *user_creatable_add_type(const char *type, const char *id,
3890998d58SDaniel P. Berrange                                 const QDict *qdict,
3990998d58SDaniel P. Berrange                                 Visitor *v, Error **errp)
4090998d58SDaniel P. Berrange {
4190998d58SDaniel P. Berrange     Object *obj;
4290998d58SDaniel P. Berrange     ObjectClass *klass;
4390998d58SDaniel P. Berrange     const QDictEntry *e;
4490998d58SDaniel P. Berrange     Error *local_err = NULL;
4590998d58SDaniel P. Berrange 
4690998d58SDaniel P. Berrange     klass = object_class_by_name(type);
4790998d58SDaniel P. Berrange     if (!klass) {
4890998d58SDaniel P. Berrange         error_setg(errp, "invalid object type: %s", type);
4990998d58SDaniel P. Berrange         return NULL;
5090998d58SDaniel P. Berrange     }
5190998d58SDaniel P. Berrange 
5290998d58SDaniel P. Berrange     if (!object_class_dynamic_cast(klass, TYPE_USER_CREATABLE)) {
5390998d58SDaniel P. Berrange         error_setg(errp, "object type '%s' isn't supported by object-add",
5490998d58SDaniel P. Berrange                    type);
5590998d58SDaniel P. Berrange         return NULL;
5690998d58SDaniel P. Berrange     }
5790998d58SDaniel P. Berrange 
5890998d58SDaniel P. Berrange     if (object_class_is_abstract(klass)) {
5990998d58SDaniel P. Berrange         error_setg(errp, "object type '%s' is abstract", type);
6090998d58SDaniel P. Berrange         return NULL;
6190998d58SDaniel P. Berrange     }
6290998d58SDaniel P. Berrange 
63ad739706SEric Blake     assert(qdict);
6490998d58SDaniel P. Berrange     obj = object_new(type);
65e1ff3c67SIgor Mammedov     if (object_property_find(obj, "id", NULL)) {
66e1ff3c67SIgor Mammedov         object_property_set_str(obj, id, "id", &local_err);
67e1ff3c67SIgor Mammedov         if (local_err) {
68e1ff3c67SIgor Mammedov             goto out;
69e1ff3c67SIgor Mammedov         }
70e1ff3c67SIgor Mammedov     }
71ad739706SEric Blake     visit_start_struct(v, NULL, NULL, 0, &local_err);
7290998d58SDaniel P. Berrange     if (local_err) {
7390998d58SDaniel P. Berrange         goto out;
7490998d58SDaniel P. Berrange     }
75ad739706SEric Blake     for (e = qdict_first(qdict); e; e = qdict_next(qdict, e)) {
76ad739706SEric Blake         object_property_set(obj, v, e->key, &local_err);
77ad739706SEric Blake         if (local_err) {
78ad739706SEric Blake             break;
7990998d58SDaniel P. Berrange         }
8090998d58SDaniel P. Berrange     }
8115c2f669SEric Blake     if (!local_err) {
8215c2f669SEric Blake         visit_check_struct(v, &local_err);
8315c2f669SEric Blake     }
841158bb2aSEric Blake     visit_end_struct(v, NULL);
85ad739706SEric Blake     if (local_err) {
86ad739706SEric Blake         goto out;
87ad739706SEric Blake     }
8890998d58SDaniel P. Berrange 
8990998d58SDaniel P. Berrange     object_property_add_child(object_get_objects_root(),
9090998d58SDaniel P. Berrange                               id, obj, &local_err);
9190998d58SDaniel P. Berrange     if (local_err) {
9290998d58SDaniel P. Berrange         goto out;
9390998d58SDaniel P. Berrange     }
9490998d58SDaniel P. Berrange 
9590998d58SDaniel P. Berrange     user_creatable_complete(obj, &local_err);
9690998d58SDaniel P. Berrange     if (local_err) {
9790998d58SDaniel P. Berrange         object_property_del(object_get_objects_root(),
9890998d58SDaniel P. Berrange                             id, &error_abort);
9990998d58SDaniel P. Berrange         goto out;
10090998d58SDaniel P. Berrange     }
10190998d58SDaniel P. Berrange out:
10290998d58SDaniel P. Berrange     if (local_err) {
10390998d58SDaniel P. Berrange         error_propagate(errp, local_err);
10490998d58SDaniel P. Berrange         object_unref(obj);
10590998d58SDaniel P. Berrange         return NULL;
10690998d58SDaniel P. Berrange     }
10790998d58SDaniel P. Berrange     return obj;
10890998d58SDaniel P. Berrange }
10990998d58SDaniel P. Berrange 
11090998d58SDaniel P. Berrange 
11190998d58SDaniel P. Berrange Object *user_creatable_add_opts(QemuOpts *opts, Error **errp)
11290998d58SDaniel P. Berrange {
11309204eacSEric Blake     Visitor *v;
11490998d58SDaniel P. Berrange     QDict *pdict;
1153a464105SIgor Mammedov     Object *obj;
1163a464105SIgor Mammedov     const char *id = qemu_opts_id(opts);
1179a6d1acbSEric Blake     char *type = qemu_opt_get_del(opts, "qom-type");
1183a464105SIgor Mammedov 
1193a464105SIgor Mammedov     if (!type) {
1203a464105SIgor Mammedov         error_setg(errp, QERR_MISSING_PARAMETER, "qom-type");
1213a464105SIgor Mammedov         return NULL;
1223a464105SIgor Mammedov     }
1233a464105SIgor Mammedov     if (!id) {
1243a464105SIgor Mammedov         error_setg(errp, QERR_MISSING_PARAMETER, "id");
125*08329701SEric Blake         qemu_opt_set(opts, "qom-type", type, &error_abort);
1269a6d1acbSEric Blake         g_free(type);
1273a464105SIgor Mammedov         return NULL;
1283a464105SIgor Mammedov     }
1293a464105SIgor Mammedov 
1309a6d1acbSEric Blake     qemu_opts_set_id(opts, NULL);
1313a464105SIgor Mammedov     pdict = qemu_opts_to_qdict(opts, NULL);
13290998d58SDaniel P. Berrange 
13309204eacSEric Blake     v = opts_visitor_new(opts);
1343a464105SIgor Mammedov     obj = user_creatable_add_type(type, id, pdict, v, errp);
13509204eacSEric Blake     visit_free(v);
1363a464105SIgor Mammedov 
1379a6d1acbSEric Blake     qemu_opts_set_id(opts, (char *) id);
138*08329701SEric Blake     qemu_opt_set(opts, "qom-type", type, &error_abort);
1399a6d1acbSEric Blake     g_free(type);
14090998d58SDaniel P. Berrange     QDECREF(pdict);
14190998d58SDaniel P. Berrange     return obj;
14290998d58SDaniel P. Berrange }
14390998d58SDaniel P. Berrange 
14490998d58SDaniel P. Berrange 
14590998d58SDaniel P. Berrange int user_creatable_add_opts_foreach(void *opaque, QemuOpts *opts, Error **errp)
14690998d58SDaniel P. Berrange {
14790998d58SDaniel P. Berrange     bool (*type_predicate)(const char *) = opaque;
14890998d58SDaniel P. Berrange     Object *obj = NULL;
14951b9b478SMarkus Armbruster     Error *err = NULL;
15090998d58SDaniel P. Berrange     const char *type;
15190998d58SDaniel P. Berrange 
15290998d58SDaniel P. Berrange     type = qemu_opt_get(opts, "qom-type");
15390998d58SDaniel P. Berrange     if (type && type_predicate &&
15490998d58SDaniel P. Berrange         !type_predicate(type)) {
15590998d58SDaniel P. Berrange         return 0;
15690998d58SDaniel P. Berrange     }
15790998d58SDaniel P. Berrange 
15851b9b478SMarkus Armbruster     obj = user_creatable_add_opts(opts, &err);
15990998d58SDaniel P. Berrange     if (!obj) {
16051b9b478SMarkus Armbruster         error_report_err(err);
16190998d58SDaniel P. Berrange         return -1;
16290998d58SDaniel P. Berrange     }
16390998d58SDaniel P. Berrange     object_unref(obj);
16490998d58SDaniel P. Berrange     return 0;
16590998d58SDaniel P. Berrange }
16690998d58SDaniel P. Berrange 
16790998d58SDaniel P. Berrange 
16890998d58SDaniel P. Berrange void user_creatable_del(const char *id, Error **errp)
16990998d58SDaniel P. Berrange {
17090998d58SDaniel P. Berrange     Object *container;
17190998d58SDaniel P. Berrange     Object *obj;
17290998d58SDaniel P. Berrange 
17390998d58SDaniel P. Berrange     container = object_get_objects_root();
17490998d58SDaniel P. Berrange     obj = object_resolve_path_component(container, id);
17590998d58SDaniel P. Berrange     if (!obj) {
17690998d58SDaniel P. Berrange         error_setg(errp, "object '%s' not found", id);
17790998d58SDaniel P. Berrange         return;
17890998d58SDaniel P. Berrange     }
17990998d58SDaniel P. Berrange 
18090998d58SDaniel P. Berrange     if (!user_creatable_can_be_deleted(USER_CREATABLE(obj), errp)) {
18190998d58SDaniel P. Berrange         error_setg(errp, "object '%s' is in use, can not be deleted", id);
18290998d58SDaniel P. Berrange         return;
18390998d58SDaniel P. Berrange     }
18490998d58SDaniel P. Berrange     object_unparent(obj);
18590998d58SDaniel P. Berrange }
18690998d58SDaniel P. Berrange 
187269e09f3SIgor Mammedov static void register_types(void)
188269e09f3SIgor Mammedov {
189269e09f3SIgor Mammedov     static const TypeInfo uc_interface_info = {
190269e09f3SIgor Mammedov         .name          = TYPE_USER_CREATABLE,
191269e09f3SIgor Mammedov         .parent        = TYPE_INTERFACE,
192269e09f3SIgor Mammedov         .class_size = sizeof(UserCreatableClass),
193269e09f3SIgor Mammedov     };
194269e09f3SIgor Mammedov 
195269e09f3SIgor Mammedov     type_register_static(&uc_interface_info);
196269e09f3SIgor Mammedov }
197269e09f3SIgor Mammedov 
198269e09f3SIgor Mammedov type_init(register_types)
199