xref: /openbmc/qemu/hw/core/qdev.c (revision b7b34d055d82abaa511b35c9fc24efbb63dca0b1)
1 /*
2  *  Dynamic device configuration and creation.
3  *
4  *  Copyright (c) 2009 CodeSourcery
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 /* The theory here is that it should be possible to create a machine without
21    knowledge of specific devices.  Historically board init routines have
22    passed a bunch of arguments to each device, requiring the board know
23    exactly which device it is dealing with.  This file provides an abstract
24    API for device configuration and initialization.  Devices will generally
25    inherit from a particular bus (e.g. PCI or I2C) rather than
26    this API directly.  */
27 
28 #include "hw/qdev.h"
29 #include "hw/fw-path-provider.h"
30 #include "sysemu/sysemu.h"
31 #include "qapi/error.h"
32 #include "qapi/qmp/qerror.h"
33 #include "qapi/visitor.h"
34 #include "qapi/qmp/qjson.h"
35 #include "monitor/monitor.h"
36 #include "hw/hotplug.h"
37 #include "hw/boards.h"
38 
39 int qdev_hotplug = 0;
40 static bool qdev_hot_added = false;
41 static bool qdev_hot_removed = false;
42 
43 const VMStateDescription *qdev_get_vmsd(DeviceState *dev)
44 {
45     DeviceClass *dc = DEVICE_GET_CLASS(dev);
46     return dc->vmsd;
47 }
48 
49 const char *qdev_fw_name(DeviceState *dev)
50 {
51     DeviceClass *dc = DEVICE_GET_CLASS(dev);
52 
53     if (dc->fw_name) {
54         return dc->fw_name;
55     }
56 
57     return object_get_typename(OBJECT(dev));
58 }
59 
60 static void qdev_property_add_legacy(DeviceState *dev, Property *prop,
61                                      Error **errp);
62 
63 static void bus_remove_child(BusState *bus, DeviceState *child)
64 {
65     BusChild *kid;
66 
67     QTAILQ_FOREACH(kid, &bus->children, sibling) {
68         if (kid->child == child) {
69             char name[32];
70 
71             snprintf(name, sizeof(name), "child[%d]", kid->index);
72             QTAILQ_REMOVE(&bus->children, kid, sibling);
73 
74             /* This gives back ownership of kid->child back to us.  */
75             object_property_del(OBJECT(bus), name, NULL);
76             object_unref(OBJECT(kid->child));
77             g_free(kid);
78             return;
79         }
80     }
81 }
82 
83 static void bus_add_child(BusState *bus, DeviceState *child)
84 {
85     char name[32];
86     BusChild *kid = g_malloc0(sizeof(*kid));
87 
88     if (qdev_hotplug) {
89         assert(bus->allow_hotplug);
90     }
91 
92     kid->index = bus->max_index++;
93     kid->child = child;
94     object_ref(OBJECT(kid->child));
95 
96     QTAILQ_INSERT_HEAD(&bus->children, kid, sibling);
97 
98     /* This transfers ownership of kid->child to the property.  */
99     snprintf(name, sizeof(name), "child[%d]", kid->index);
100     object_property_add_link(OBJECT(bus), name,
101                              object_get_typename(OBJECT(child)),
102                              (Object **)&kid->child,
103                              NULL, /* read-only property */
104                              0, /* return ownership on prop deletion */
105                              NULL);
106 }
107 
108 void qdev_set_parent_bus(DeviceState *dev, BusState *bus)
109 {
110     dev->parent_bus = bus;
111     object_ref(OBJECT(bus));
112     bus_add_child(bus, dev);
113 }
114 
115 /* Create a new device.  This only initializes the device state structure
116    and allows properties to be set.  qdev_init should be called to
117    initialize the actual device emulation.  */
118 DeviceState *qdev_create(BusState *bus, const char *name)
119 {
120     DeviceState *dev;
121 
122     dev = qdev_try_create(bus, name);
123     if (!dev) {
124         if (bus) {
125             error_report("Unknown device '%s' for bus '%s'", name,
126                          object_get_typename(OBJECT(bus)));
127         } else {
128             error_report("Unknown device '%s' for default sysbus", name);
129         }
130         abort();
131     }
132 
133     return dev;
134 }
135 
136 DeviceState *qdev_try_create(BusState *bus, const char *type)
137 {
138     DeviceState *dev;
139 
140     if (object_class_by_name(type) == NULL) {
141         return NULL;
142     }
143     dev = DEVICE(object_new(type));
144     if (!dev) {
145         return NULL;
146     }
147 
148     if (!bus) {
149         bus = sysbus_get_default();
150     }
151 
152     qdev_set_parent_bus(dev, bus);
153     object_unref(OBJECT(dev));
154     return dev;
155 }
156 
157 /* Initialize a device.  Device properties should be set before calling
158    this function.  IRQs and MMIO regions should be connected/mapped after
159    calling this function.
160    On failure, destroy the device and return negative value.
161    Return 0 on success.  */
162 int qdev_init(DeviceState *dev)
163 {
164     Error *local_err = NULL;
165 
166     assert(!dev->realized);
167 
168     object_property_set_bool(OBJECT(dev), true, "realized", &local_err);
169     if (local_err != NULL) {
170         qerror_report_err(local_err);
171         error_free(local_err);
172         object_unparent(OBJECT(dev));
173         return -1;
174     }
175     return 0;
176 }
177 
178 static void device_realize(DeviceState *dev, Error **errp)
179 {
180     DeviceClass *dc = DEVICE_GET_CLASS(dev);
181 
182     if (dc->init) {
183         int rc = dc->init(dev);
184         if (rc < 0) {
185             error_setg(errp, "Device initialization failed.");
186             return;
187         }
188     }
189 }
190 
191 static void device_unrealize(DeviceState *dev, Error **errp)
192 {
193     DeviceClass *dc = DEVICE_GET_CLASS(dev);
194 
195     if (dc->exit) {
196         int rc = dc->exit(dev);
197         if (rc < 0) {
198             error_setg(errp, "Device exit failed.");
199             return;
200         }
201     }
202 }
203 
204 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
205                                  int required_for_version)
206 {
207     assert(!dev->realized);
208     dev->instance_id_alias = alias_id;
209     dev->alias_required_for_version = required_for_version;
210 }
211 
212 void qdev_unplug(DeviceState *dev, Error **errp)
213 {
214     DeviceClass *dc = DEVICE_GET_CLASS(dev);
215 
216     if (dev->parent_bus && !dev->parent_bus->allow_hotplug) {
217         error_set(errp, QERR_BUS_NO_HOTPLUG, dev->parent_bus->name);
218         return;
219     }
220 
221     if (!dc->hotpluggable) {
222         error_set(errp, QERR_DEVICE_NO_HOTPLUG,
223                   object_get_typename(OBJECT(dev)));
224         return;
225     }
226 
227     qdev_hot_removed = true;
228 
229     if (dev->parent_bus && dev->parent_bus->hotplug_handler) {
230         hotplug_handler_unplug(dev->parent_bus->hotplug_handler, dev, errp);
231     } else {
232         assert(dc->unplug != NULL);
233         if (dc->unplug(dev) < 0) { /* legacy handler */
234             error_set(errp, QERR_UNDEFINED_ERROR);
235         }
236     }
237 }
238 
239 static int qdev_reset_one(DeviceState *dev, void *opaque)
240 {
241     device_reset(dev);
242 
243     return 0;
244 }
245 
246 static int qbus_reset_one(BusState *bus, void *opaque)
247 {
248     BusClass *bc = BUS_GET_CLASS(bus);
249     if (bc->reset) {
250         bc->reset(bus);
251     }
252     return 0;
253 }
254 
255 void qdev_reset_all(DeviceState *dev)
256 {
257     qdev_walk_children(dev, NULL, NULL, qdev_reset_one, qbus_reset_one, NULL);
258 }
259 
260 void qbus_reset_all(BusState *bus)
261 {
262     qbus_walk_children(bus, NULL, NULL, qdev_reset_one, qbus_reset_one, NULL);
263 }
264 
265 void qbus_reset_all_fn(void *opaque)
266 {
267     BusState *bus = opaque;
268     qbus_reset_all(bus);
269 }
270 
271 /* can be used as ->unplug() callback for the simple cases */
272 int qdev_simple_unplug_cb(DeviceState *dev)
273 {
274     /* just zap it */
275     object_unparent(OBJECT(dev));
276     return 0;
277 }
278 
279 
280 /* Like qdev_init(), but terminate program via error_report() instead of
281    returning an error value.  This is okay during machine creation.
282    Don't use for hotplug, because there callers need to recover from
283    failure.  Exception: if you know the device's init() callback can't
284    fail, then qdev_init_nofail() can't fail either, and is therefore
285    usable even then.  But relying on the device implementation that
286    way is somewhat unclean, and best avoided.  */
287 void qdev_init_nofail(DeviceState *dev)
288 {
289     const char *typename = object_get_typename(OBJECT(dev));
290 
291     if (qdev_init(dev) < 0) {
292         error_report("Initialization of device %s failed", typename);
293         exit(1);
294     }
295 }
296 
297 void qdev_machine_creation_done(void)
298 {
299     /*
300      * ok, initial machine setup is done, starting from now we can
301      * only create hotpluggable devices
302      */
303     qdev_hotplug = 1;
304 }
305 
306 bool qdev_machine_modified(void)
307 {
308     return qdev_hot_added || qdev_hot_removed;
309 }
310 
311 BusState *qdev_get_parent_bus(DeviceState *dev)
312 {
313     return dev->parent_bus;
314 }
315 
316 static NamedGPIOList *qdev_get_named_gpio_list(DeviceState *dev,
317                                                const char *name)
318 {
319     NamedGPIOList *ngl;
320 
321     QLIST_FOREACH(ngl, &dev->gpios, node) {
322         /* NULL is a valid and matchable name, otherwise do a normal
323          * strcmp match.
324          */
325         if ((!ngl->name && !name) ||
326                 (name && ngl->name && strcmp(name, ngl->name) == 0)) {
327             return ngl;
328         }
329     }
330 
331     ngl = g_malloc0(sizeof(*ngl));
332     ngl->name = g_strdup(name);
333     QLIST_INSERT_HEAD(&dev->gpios, ngl, node);
334     return ngl;
335 }
336 
337 void qdev_init_gpio_in_named(DeviceState *dev, qemu_irq_handler handler,
338                              const char *name, int n)
339 {
340     NamedGPIOList *gpio_list = qdev_get_named_gpio_list(dev, name);
341 
342     gpio_list->in = qemu_extend_irqs(gpio_list->in, gpio_list->num_in, handler,
343                                      dev, n);
344     gpio_list->num_in += n;
345 }
346 
347 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n)
348 {
349     qdev_init_gpio_in_named(dev, handler, NULL, n);
350 }
351 
352 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
353                               const char *name, int n)
354 {
355     NamedGPIOList *gpio_list = qdev_get_named_gpio_list(dev, name);
356 
357     assert(gpio_list->num_out == 0);
358     gpio_list->num_out = n;
359     gpio_list->out = pins;
360 }
361 
362 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n)
363 {
364     qdev_init_gpio_out_named(dev, pins, NULL, n);
365 }
366 
367 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n)
368 {
369     NamedGPIOList *gpio_list = qdev_get_named_gpio_list(dev, name);
370 
371     assert(n >= 0 && n < gpio_list->num_in);
372     return gpio_list->in[n];
373 }
374 
375 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n)
376 {
377     return qdev_get_gpio_in_named(dev, NULL, n);
378 }
379 
380 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
381                                  qemu_irq pin)
382 {
383     NamedGPIOList *gpio_list = qdev_get_named_gpio_list(dev, name);
384 
385     assert(n >= 0 && n < gpio_list->num_out);
386     gpio_list->out[n] = pin;
387 }
388 
389 void qdev_connect_gpio_out(DeviceState * dev, int n, qemu_irq pin)
390 {
391     qdev_connect_gpio_out_named(dev, NULL, n, pin);
392 }
393 
394 BusState *qdev_get_child_bus(DeviceState *dev, const char *name)
395 {
396     BusState *bus;
397 
398     QLIST_FOREACH(bus, &dev->child_bus, sibling) {
399         if (strcmp(name, bus->name) == 0) {
400             return bus;
401         }
402     }
403     return NULL;
404 }
405 
406 int qbus_walk_children(BusState *bus,
407                        qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
408                        qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
409                        void *opaque)
410 {
411     BusChild *kid;
412     int err;
413 
414     if (pre_busfn) {
415         err = pre_busfn(bus, opaque);
416         if (err) {
417             return err;
418         }
419     }
420 
421     QTAILQ_FOREACH(kid, &bus->children, sibling) {
422         err = qdev_walk_children(kid->child,
423                                  pre_devfn, pre_busfn,
424                                  post_devfn, post_busfn, opaque);
425         if (err < 0) {
426             return err;
427         }
428     }
429 
430     if (post_busfn) {
431         err = post_busfn(bus, opaque);
432         if (err) {
433             return err;
434         }
435     }
436 
437     return 0;
438 }
439 
440 int qdev_walk_children(DeviceState *dev,
441                        qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
442                        qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
443                        void *opaque)
444 {
445     BusState *bus;
446     int err;
447 
448     if (pre_devfn) {
449         err = pre_devfn(dev, opaque);
450         if (err) {
451             return err;
452         }
453     }
454 
455     QLIST_FOREACH(bus, &dev->child_bus, sibling) {
456         err = qbus_walk_children(bus, pre_devfn, pre_busfn,
457                                  post_devfn, post_busfn, opaque);
458         if (err < 0) {
459             return err;
460         }
461     }
462 
463     if (post_devfn) {
464         err = post_devfn(dev, opaque);
465         if (err) {
466             return err;
467         }
468     }
469 
470     return 0;
471 }
472 
473 DeviceState *qdev_find_recursive(BusState *bus, const char *id)
474 {
475     BusChild *kid;
476     DeviceState *ret;
477     BusState *child;
478 
479     QTAILQ_FOREACH(kid, &bus->children, sibling) {
480         DeviceState *dev = kid->child;
481 
482         if (dev->id && strcmp(dev->id, id) == 0) {
483             return dev;
484         }
485 
486         QLIST_FOREACH(child, &dev->child_bus, sibling) {
487             ret = qdev_find_recursive(child, id);
488             if (ret) {
489                 return ret;
490             }
491         }
492     }
493     return NULL;
494 }
495 
496 static void qbus_realize(BusState *bus, DeviceState *parent, const char *name)
497 {
498     const char *typename = object_get_typename(OBJECT(bus));
499     BusClass *bc;
500     char *buf;
501     int i, len, bus_id;
502 
503     bus->parent = parent;
504 
505     if (name) {
506         bus->name = g_strdup(name);
507     } else if (bus->parent && bus->parent->id) {
508         /* parent device has id -> use it plus parent-bus-id for bus name */
509         bus_id = bus->parent->num_child_bus;
510 
511         len = strlen(bus->parent->id) + 16;
512         buf = g_malloc(len);
513         snprintf(buf, len, "%s.%d", bus->parent->id, bus_id);
514         bus->name = buf;
515     } else {
516         /* no id -> use lowercase bus type plus global bus-id for bus name */
517         bc = BUS_GET_CLASS(bus);
518         bus_id = bc->automatic_ids++;
519 
520         len = strlen(typename) + 16;
521         buf = g_malloc(len);
522         len = snprintf(buf, len, "%s.%d", typename, bus_id);
523         for (i = 0; i < len; i++) {
524             buf[i] = qemu_tolower(buf[i]);
525         }
526         bus->name = buf;
527     }
528 
529     if (bus->parent) {
530         QLIST_INSERT_HEAD(&bus->parent->child_bus, bus, sibling);
531         bus->parent->num_child_bus++;
532         object_property_add_child(OBJECT(bus->parent), bus->name, OBJECT(bus), NULL);
533         object_unref(OBJECT(bus));
534     } else if (bus != sysbus_get_default()) {
535         /* TODO: once all bus devices are qdevified,
536            only reset handler for main_system_bus should be registered here. */
537         qemu_register_reset(qbus_reset_all_fn, bus);
538     }
539 }
540 
541 static void bus_unparent(Object *obj)
542 {
543     BusState *bus = BUS(obj);
544     BusChild *kid;
545 
546     while ((kid = QTAILQ_FIRST(&bus->children)) != NULL) {
547         DeviceState *dev = kid->child;
548         object_unparent(OBJECT(dev));
549     }
550     if (bus->parent) {
551         QLIST_REMOVE(bus, sibling);
552         bus->parent->num_child_bus--;
553         bus->parent = NULL;
554     } else {
555         assert(bus != sysbus_get_default()); /* main_system_bus is never freed */
556         qemu_unregister_reset(qbus_reset_all_fn, bus);
557     }
558 }
559 
560 static bool bus_get_realized(Object *obj, Error **errp)
561 {
562     BusState *bus = BUS(obj);
563 
564     return bus->realized;
565 }
566 
567 static void bus_set_realized(Object *obj, bool value, Error **errp)
568 {
569     BusState *bus = BUS(obj);
570     BusClass *bc = BUS_GET_CLASS(bus);
571     Error *local_err = NULL;
572 
573     if (value && !bus->realized) {
574         if (bc->realize) {
575             bc->realize(bus, &local_err);
576         }
577     } else if (!value && bus->realized) {
578         if (bc->unrealize) {
579             bc->unrealize(bus, &local_err);
580         }
581     }
582 
583     if (local_err != NULL) {
584         error_propagate(errp, local_err);
585         return;
586     }
587 
588     bus->realized = value;
589 }
590 
591 void qbus_create_inplace(void *bus, size_t size, const char *typename,
592                          DeviceState *parent, const char *name)
593 {
594     object_initialize(bus, size, typename);
595     qbus_realize(bus, parent, name);
596 }
597 
598 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name)
599 {
600     BusState *bus;
601 
602     bus = BUS(object_new(typename));
603     qbus_realize(bus, parent, name);
604 
605     return bus;
606 }
607 
608 static char *bus_get_fw_dev_path(BusState *bus, DeviceState *dev)
609 {
610     BusClass *bc = BUS_GET_CLASS(bus);
611 
612     if (bc->get_fw_dev_path) {
613         return bc->get_fw_dev_path(dev);
614     }
615 
616     return NULL;
617 }
618 
619 static char *qdev_get_fw_dev_path_from_handler(BusState *bus, DeviceState *dev)
620 {
621     Object *obj = OBJECT(dev);
622     char *d = NULL;
623 
624     while (!d && obj->parent) {
625         obj = obj->parent;
626         d = fw_path_provider_try_get_dev_path(obj, bus, dev);
627     }
628     return d;
629 }
630 
631 static int qdev_get_fw_dev_path_helper(DeviceState *dev, char *p, int size)
632 {
633     int l = 0;
634 
635     if (dev && dev->parent_bus) {
636         char *d;
637         l = qdev_get_fw_dev_path_helper(dev->parent_bus->parent, p, size);
638         d = qdev_get_fw_dev_path_from_handler(dev->parent_bus, dev);
639         if (!d) {
640             d = bus_get_fw_dev_path(dev->parent_bus, dev);
641         }
642         if (d) {
643             l += snprintf(p + l, size - l, "%s", d);
644             g_free(d);
645         } else {
646             return l;
647         }
648     }
649     l += snprintf(p + l , size - l, "/");
650 
651     return l;
652 }
653 
654 char* qdev_get_fw_dev_path(DeviceState *dev)
655 {
656     char path[128];
657     int l;
658 
659     l = qdev_get_fw_dev_path_helper(dev, path, 128);
660 
661     path[l-1] = '\0';
662 
663     return g_strdup(path);
664 }
665 
666 char *qdev_get_dev_path(DeviceState *dev)
667 {
668     BusClass *bc;
669 
670     if (!dev || !dev->parent_bus) {
671         return NULL;
672     }
673 
674     bc = BUS_GET_CLASS(dev->parent_bus);
675     if (bc->get_dev_path) {
676         return bc->get_dev_path(dev);
677     }
678 
679     return NULL;
680 }
681 
682 /**
683  * Legacy property handling
684  */
685 
686 static void qdev_get_legacy_property(Object *obj, Visitor *v, void *opaque,
687                                      const char *name, Error **errp)
688 {
689     DeviceState *dev = DEVICE(obj);
690     Property *prop = opaque;
691 
692     char buffer[1024];
693     char *ptr = buffer;
694 
695     prop->info->print(dev, prop, buffer, sizeof(buffer));
696     visit_type_str(v, &ptr, name, errp);
697 }
698 
699 /**
700  * @qdev_add_legacy_property - adds a legacy property
701  *
702  * Do not use this is new code!  Properties added through this interface will
703  * be given names and types in the "legacy" namespace.
704  *
705  * Legacy properties are string versions of other OOM properties.  The format
706  * of the string depends on the property type.
707  */
708 static void qdev_property_add_legacy(DeviceState *dev, Property *prop,
709                                      Error **errp)
710 {
711     gchar *name;
712 
713     /* Register pointer properties as legacy properties */
714     if (!prop->info->print && prop->info->get) {
715         return;
716     }
717 
718     name = g_strdup_printf("legacy-%s", prop->name);
719     object_property_add(OBJECT(dev), name, "str",
720                         prop->info->print ? qdev_get_legacy_property : prop->info->get,
721                         NULL,
722                         NULL,
723                         prop, errp);
724 
725     g_free(name);
726 }
727 
728 /**
729  * @qdev_property_add_static - add a @Property to a device.
730  *
731  * Static properties access data in a struct.  The actual type of the
732  * property and the field depends on the property type.
733  */
734 void qdev_property_add_static(DeviceState *dev, Property *prop,
735                               Error **errp)
736 {
737     Error *local_err = NULL;
738     Object *obj = OBJECT(dev);
739 
740     /*
741      * TODO qdev_prop_ptr does not have getters or setters.  It must
742      * go now that it can be replaced with links.  The test should be
743      * removed along with it: all static properties are read/write.
744      */
745     if (!prop->info->get && !prop->info->set) {
746         return;
747     }
748 
749     object_property_add(obj, prop->name, prop->info->name,
750                         prop->info->get, prop->info->set,
751                         prop->info->release,
752                         prop, &local_err);
753 
754     if (local_err) {
755         error_propagate(errp, local_err);
756         return;
757     }
758     if (prop->qtype == QTYPE_NONE) {
759         return;
760     }
761 
762     if (prop->qtype == QTYPE_QBOOL) {
763         object_property_set_bool(obj, prop->defval, prop->name, &error_abort);
764     } else if (prop->info->enum_table) {
765         object_property_set_str(obj, prop->info->enum_table[prop->defval],
766                                 prop->name, &error_abort);
767     } else if (prop->qtype == QTYPE_QINT) {
768         object_property_set_int(obj, prop->defval, prop->name, &error_abort);
769     }
770 }
771 
772 static bool device_get_realized(Object *obj, Error **errp)
773 {
774     DeviceState *dev = DEVICE(obj);
775     return dev->realized;
776 }
777 
778 static void device_set_realized(Object *obj, bool value, Error **errp)
779 {
780     DeviceState *dev = DEVICE(obj);
781     DeviceClass *dc = DEVICE_GET_CLASS(dev);
782     BusState *bus;
783     Error *local_err = NULL;
784 
785     if (dev->hotplugged && !dc->hotpluggable) {
786         error_set(errp, QERR_DEVICE_NO_HOTPLUG, object_get_typename(obj));
787         return;
788     }
789 
790     if (value && !dev->realized) {
791         if (!obj->parent && local_err == NULL) {
792             static int unattached_count;
793             gchar *name = g_strdup_printf("device[%d]", unattached_count++);
794 
795             object_property_add_child(container_get(qdev_get_machine(),
796                                                     "/unattached"),
797                                       name, obj, &local_err);
798             g_free(name);
799         }
800 
801         if (dc->realize) {
802             dc->realize(dev, &local_err);
803         }
804 
805         if (dev->parent_bus && dev->parent_bus->hotplug_handler &&
806             local_err == NULL) {
807             hotplug_handler_plug(dev->parent_bus->hotplug_handler,
808                                  dev, &local_err);
809         } else if (local_err == NULL &&
810                    object_dynamic_cast(qdev_get_machine(), TYPE_MACHINE)) {
811             HotplugHandler *hotplug_ctrl;
812             MachineState *machine = MACHINE(qdev_get_machine());
813             MachineClass *mc = MACHINE_GET_CLASS(machine);
814 
815             if (mc->get_hotplug_handler) {
816                 hotplug_ctrl = mc->get_hotplug_handler(machine, dev);
817                 if (hotplug_ctrl) {
818                     hotplug_handler_plug(hotplug_ctrl, dev, &local_err);
819                 }
820             }
821         }
822 
823         if (qdev_get_vmsd(dev) && local_err == NULL) {
824             vmstate_register_with_alias_id(dev, -1, qdev_get_vmsd(dev), dev,
825                                            dev->instance_id_alias,
826                                            dev->alias_required_for_version);
827         }
828         if (local_err == NULL) {
829             QLIST_FOREACH(bus, &dev->child_bus, sibling) {
830                 object_property_set_bool(OBJECT(bus), true, "realized",
831                                          &local_err);
832                 if (local_err != NULL) {
833                     break;
834                 }
835             }
836         }
837         if (dev->hotplugged && local_err == NULL) {
838             device_reset(dev);
839         }
840     } else if (!value && dev->realized) {
841         QLIST_FOREACH(bus, &dev->child_bus, sibling) {
842             object_property_set_bool(OBJECT(bus), false, "realized",
843                                      &local_err);
844             if (local_err != NULL) {
845                 break;
846             }
847         }
848         if (qdev_get_vmsd(dev) && local_err == NULL) {
849             vmstate_unregister(dev, qdev_get_vmsd(dev), dev);
850         }
851         if (dc->unrealize && local_err == NULL) {
852             dc->unrealize(dev, &local_err);
853         }
854     }
855 
856     if (local_err != NULL) {
857         error_propagate(errp, local_err);
858         return;
859     }
860 
861     dev->realized = value;
862 }
863 
864 static bool device_get_hotpluggable(Object *obj, Error **errp)
865 {
866     DeviceClass *dc = DEVICE_GET_CLASS(obj);
867     DeviceState *dev = DEVICE(obj);
868 
869     return dc->hotpluggable && (dev->parent_bus == NULL ||
870                                 dev->parent_bus->allow_hotplug);
871 }
872 
873 static bool device_get_hotplugged(Object *obj, Error **err)
874 {
875     DeviceState *dev = DEVICE(obj);
876 
877     return dev->hotplugged;
878 }
879 
880 static void device_set_hotplugged(Object *obj, bool value, Error **err)
881 {
882     DeviceState *dev = DEVICE(obj);
883 
884     dev->hotplugged = value;
885 }
886 
887 static void device_initfn(Object *obj)
888 {
889     DeviceState *dev = DEVICE(obj);
890     ObjectClass *class;
891     Property *prop;
892 
893     if (qdev_hotplug) {
894         dev->hotplugged = 1;
895         qdev_hot_added = true;
896     }
897 
898     dev->instance_id_alias = -1;
899     dev->realized = false;
900 
901     object_property_add_bool(obj, "realized",
902                              device_get_realized, device_set_realized, NULL);
903     object_property_add_bool(obj, "hotpluggable",
904                              device_get_hotpluggable, NULL, NULL);
905     object_property_add_bool(obj, "hotplugged",
906                              device_get_hotplugged, device_set_hotplugged,
907                              &error_abort);
908 
909     class = object_get_class(OBJECT(dev));
910     do {
911         for (prop = DEVICE_CLASS(class)->props; prop && prop->name; prop++) {
912             qdev_property_add_legacy(dev, prop, &error_abort);
913             qdev_property_add_static(dev, prop, &error_abort);
914         }
915         class = object_class_get_parent(class);
916     } while (class != object_class_by_name(TYPE_DEVICE));
917 
918     object_property_add_link(OBJECT(dev), "parent_bus", TYPE_BUS,
919                              (Object **)&dev->parent_bus, NULL, 0,
920                              &error_abort);
921     QLIST_INIT(&dev->gpios);
922 }
923 
924 static void device_post_init(Object *obj)
925 {
926     qdev_prop_set_globals(DEVICE(obj), &error_abort);
927 }
928 
929 /* Unlink device from bus and free the structure.  */
930 static void device_finalize(Object *obj)
931 {
932     NamedGPIOList *ngl, *next;
933 
934     DeviceState *dev = DEVICE(obj);
935     if (dev->opts) {
936         qemu_opts_del(dev->opts);
937     }
938 
939     QLIST_FOREACH_SAFE(ngl, &dev->gpios, node, next) {
940         QLIST_REMOVE(ngl, node);
941         qemu_free_irqs(ngl->in);
942         g_free(ngl->name);
943         g_free(ngl);
944         /* ngl->out irqs are owned by the other end and should not be freed
945          * here
946          */
947     }
948 }
949 
950 static void device_class_base_init(ObjectClass *class, void *data)
951 {
952     DeviceClass *klass = DEVICE_CLASS(class);
953 
954     /* We explicitly look up properties in the superclasses,
955      * so do not propagate them to the subclasses.
956      */
957     klass->props = NULL;
958 }
959 
960 static void device_unparent(Object *obj)
961 {
962     DeviceState *dev = DEVICE(obj);
963     BusState *bus;
964     QObject *event_data;
965     bool have_realized = dev->realized;
966 
967     if (dev->realized) {
968         object_property_set_bool(obj, false, "realized", NULL);
969     }
970     while (dev->num_child_bus) {
971         bus = QLIST_FIRST(&dev->child_bus);
972         object_unparent(OBJECT(bus));
973     }
974     if (dev->parent_bus) {
975         bus_remove_child(dev->parent_bus, dev);
976         object_unref(OBJECT(dev->parent_bus));
977         dev->parent_bus = NULL;
978     }
979 
980     /* Only send event if the device had been completely realized */
981     if (have_realized) {
982         gchar *path = object_get_canonical_path(OBJECT(dev));
983 
984         if (dev->id) {
985             event_data = qobject_from_jsonf("{ 'device': %s, 'path': %s }",
986                                             dev->id, path);
987         } else {
988             event_data = qobject_from_jsonf("{ 'path': %s }", path);
989         }
990         monitor_protocol_event(QEVENT_DEVICE_DELETED, event_data);
991         qobject_decref(event_data);
992         g_free(path);
993     }
994 }
995 
996 static void device_class_init(ObjectClass *class, void *data)
997 {
998     DeviceClass *dc = DEVICE_CLASS(class);
999 
1000     class->unparent = device_unparent;
1001     dc->realize = device_realize;
1002     dc->unrealize = device_unrealize;
1003 
1004     /* by default all devices were considered as hotpluggable,
1005      * so with intent to check it in generic qdev_unplug() /
1006      * device_set_realized() functions make every device
1007      * hotpluggable. Devices that shouldn't be hotpluggable,
1008      * should override it in their class_init()
1009      */
1010     dc->hotpluggable = true;
1011 }
1012 
1013 void device_reset(DeviceState *dev)
1014 {
1015     DeviceClass *klass = DEVICE_GET_CLASS(dev);
1016 
1017     if (klass->reset) {
1018         klass->reset(dev);
1019     }
1020 }
1021 
1022 Object *qdev_get_machine(void)
1023 {
1024     static Object *dev;
1025 
1026     if (dev == NULL) {
1027         dev = container_get(object_get_root(), "/machine");
1028     }
1029 
1030     return dev;
1031 }
1032 
1033 static const TypeInfo device_type_info = {
1034     .name = TYPE_DEVICE,
1035     .parent = TYPE_OBJECT,
1036     .instance_size = sizeof(DeviceState),
1037     .instance_init = device_initfn,
1038     .instance_post_init = device_post_init,
1039     .instance_finalize = device_finalize,
1040     .class_base_init = device_class_base_init,
1041     .class_init = device_class_init,
1042     .abstract = true,
1043     .class_size = sizeof(DeviceClass),
1044 };
1045 
1046 static void qbus_initfn(Object *obj)
1047 {
1048     BusState *bus = BUS(obj);
1049 
1050     QTAILQ_INIT(&bus->children);
1051     object_property_add_link(obj, QDEV_HOTPLUG_HANDLER_PROPERTY,
1052                              TYPE_HOTPLUG_HANDLER,
1053                              (Object **)&bus->hotplug_handler,
1054                              object_property_allow_set_link,
1055                              OBJ_PROP_LINK_UNREF_ON_RELEASE,
1056                              NULL);
1057     object_property_add_bool(obj, "realized",
1058                              bus_get_realized, bus_set_realized, NULL);
1059 }
1060 
1061 static char *default_bus_get_fw_dev_path(DeviceState *dev)
1062 {
1063     return g_strdup(object_get_typename(OBJECT(dev)));
1064 }
1065 
1066 static void bus_class_init(ObjectClass *class, void *data)
1067 {
1068     BusClass *bc = BUS_CLASS(class);
1069 
1070     class->unparent = bus_unparent;
1071     bc->get_fw_dev_path = default_bus_get_fw_dev_path;
1072 }
1073 
1074 static void qbus_finalize(Object *obj)
1075 {
1076     BusState *bus = BUS(obj);
1077 
1078     g_free((char *)bus->name);
1079 }
1080 
1081 static const TypeInfo bus_info = {
1082     .name = TYPE_BUS,
1083     .parent = TYPE_OBJECT,
1084     .instance_size = sizeof(BusState),
1085     .abstract = true,
1086     .class_size = sizeof(BusClass),
1087     .instance_init = qbus_initfn,
1088     .instance_finalize = qbus_finalize,
1089     .class_init = bus_class_init,
1090 };
1091 
1092 static void qdev_register_types(void)
1093 {
1094     type_register_static(&bus_info);
1095     type_register_static(&device_type_info);
1096 }
1097 
1098 type_init(qdev_register_types)
1099