qdev.c 28.1 KB
Newer Older
Paul Brook's avatar
Paul Brook committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/*
 *  Dynamic device configuration and creation.
 *
 *  Copyright (c) 2009 CodeSourcery
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * 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/>.
Paul Brook's avatar
Paul Brook committed
18 19 20 21 22 23 24 25 26 27
 */

/* The theory here is that it should be possible to create a machine without
   knowledge of specific devices.  Historically board init routines have
   passed a bunch of arguments to each device, requiring the board know
   exactly which device it is dealing with.  This file provides an abstract
   API for device configuration and initialization.  Devices will generally
   inherit from a particular bus (e.g. PCI or I2C) rather than
   this API directly.  */

Paul Brook's avatar
Paul Brook committed
28
#include "net.h"
Paul Brook's avatar
Paul Brook committed
29 30 31
#include "qdev.h"
#include "sysemu.h"

32
int qdev_hotplug = 0;
33 34
static bool qdev_hot_added = false;
static bool qdev_hot_removed = false;
35

Gerd Hoffmann's avatar
Gerd Hoffmann committed
36
/* This is a nasty hack to allow passing a NULL bus to qdev_create.  */
Blue Swirl's avatar
Blue Swirl committed
37
static BusState *main_system_bus;
38
static void main_system_bus_create(void);
Paul Brook's avatar
Paul Brook committed
39

Paul Brook's avatar
Paul Brook committed
40
/* Register a new device type.  */
41 42
const VMStateDescription *qdev_get_vmsd(DeviceState *dev)
{
Anthony Liguori's avatar
Anthony Liguori committed
43 44
    DeviceClass *dc = DEVICE_GET_CLASS(dev);
    return dc->vmsd;
45 46 47 48
}

BusInfo *qdev_get_bus_info(DeviceState *dev)
{
Anthony Liguori's avatar
Anthony Liguori committed
49 50
    DeviceClass *dc = DEVICE_GET_CLASS(dev);
    return dc->bus_info;
51 52 53 54
}

Property *qdev_get_props(DeviceState *dev)
{
Anthony Liguori's avatar
Anthony Liguori committed
55 56
    DeviceClass *dc = DEVICE_GET_CLASS(dev);
    return dc->props;
57 58 59 60
}

const char *qdev_fw_name(DeviceState *dev)
{
Anthony Liguori's avatar
Anthony Liguori committed
61
    DeviceClass *dc = DEVICE_GET_CLASS(dev);
62

Anthony Liguori's avatar
Anthony Liguori committed
63 64
    if (dc->fw_name) {
        return dc->fw_name;
65 66 67 68 69
    }

    return object_get_typename(OBJECT(dev));
}

Blue Swirl's avatar
Blue Swirl committed
70 71
bool qdev_exists(const char *name)
{
72
    return !!object_class_by_name(name);
Blue Swirl's avatar
Blue Swirl committed
73
}
74

75 76 77
static void qdev_property_add_legacy(DeviceState *dev, Property *prop,
                                     Error **errp);

78
void qdev_set_parent_bus(DeviceState *dev, BusState *bus)
79
{
80
    Property *prop;
81 82 83 84

    if (qdev_hotplug) {
        assert(bus->allow_hotplug);
    }
85

86
    dev->parent_bus = bus;
87
    QTAILQ_INSERT_HEAD(&bus->children, dev, sibling);
88

89
    qdev_prop_set_defaults(dev, dev->parent_bus->info->props);
Anthony Liguori's avatar
Anthony Liguori committed
90
    for (prop = qdev_get_bus_info(dev)->props; prop && prop->name; prop++) {
91
        qdev_property_add_legacy(dev, prop, NULL);
92
        qdev_property_add_static(dev, prop, NULL);
93
    }
94 95
}

Paul Brook's avatar
Paul Brook committed
96 97 98
/* Create a new device.  This only initializes the device state structure
   and allows properties to be set.  qdev_init should be called to
   initialize the actual device emulation.  */
Paul Brook's avatar
Paul Brook committed
99
DeviceState *qdev_create(BusState *bus, const char *name)
100 101 102 103 104
{
    DeviceState *dev;

    dev = qdev_try_create(bus, name);
    if (!dev) {
105 106 107 108 109 110
        if (bus) {
            hw_error("Unknown device '%s' for bus '%s'\n", name,
                     bus->info->name);
        } else {
            hw_error("Unknown device '%s' for default sysbus\n", name);
        }
111 112 113 114 115 116
    }

    return dev;
}

DeviceState *qdev_try_create(BusState *bus, const char *name)
Paul Brook's avatar
Paul Brook committed
117
{
118 119 120 121 122 123 124
    DeviceState *dev;

    dev = DEVICE(object_new(name));
    if (!dev) {
        return NULL;
    }

125
    if (!bus) {
126
        bus = sysbus_get_default();
127 128
    }

129 130 131 132
    qdev_set_parent_bus(dev, bus);
    qdev_prop_set_globals(dev);

    return dev;
Paul Brook's avatar
Paul Brook committed
133 134 135 136
}

/* Initialize a device.  Device properties should be set before calling
   this function.  IRQs and MMIO regions should be connected/mapped after
137 138 139
   calling this function.
   On failure, destroy the device and return negative value.
   Return 0 on success.  */
140
int qdev_init(DeviceState *dev)
Paul Brook's avatar
Paul Brook committed
141
{
Anthony Liguori's avatar
Anthony Liguori committed
142
    DeviceClass *dc = DEVICE_GET_CLASS(dev);
Gerd Hoffmann's avatar
Gerd Hoffmann committed
143 144
    int rc;

Gerd Hoffmann's avatar
Gerd Hoffmann committed
145
    assert(dev->state == DEV_STATE_CREATED);
Anthony Liguori's avatar
Anthony Liguori committed
146

Anthony Liguori's avatar
Anthony Liguori committed
147
    rc = dc->init(dev);
148 149
    if (rc < 0) {
        qdev_free(dev);
Gerd Hoffmann's avatar
Gerd Hoffmann committed
150
        return rc;
151
    }
Anthony Liguori's avatar
Anthony Liguori committed
152 153
    if (qdev_get_vmsd(dev)) {
        vmstate_register_with_alias_id(dev, -1, qdev_get_vmsd(dev), dev,
Jan Kiszka's avatar
Jan Kiszka committed
154 155 156
                                       dev->instance_id_alias,
                                       dev->alias_required_for_version);
    }
Gerd Hoffmann's avatar
Gerd Hoffmann committed
157
    dev->state = DEV_STATE_INITIALIZED;
158 159
    if (dev->hotplugged) {
        device_reset(dev);
Jan Kiszka's avatar
Jan Kiszka committed
160
    }
Gerd Hoffmann's avatar
Gerd Hoffmann committed
161
    return 0;
Paul Brook's avatar
Paul Brook committed
162 163
}

Jan Kiszka's avatar
Jan Kiszka committed
164 165 166 167 168 169 170 171
void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
                                 int required_for_version)
{
    assert(dev->state == DEV_STATE_CREATED);
    dev->instance_id_alias = alias_id;
    dev->alias_required_for_version = required_for_version;
}

172 173
int qdev_unplug(DeviceState *dev)
{
Anthony Liguori's avatar
Anthony Liguori committed
174 175
    DeviceClass *dc = DEVICE_GET_CLASS(dev);

176
    if (!dev->parent_bus->allow_hotplug) {
177
        qerror_report(QERR_BUS_NO_HOTPLUG, dev->parent_bus->name);
178 179
        return -1;
    }
Anthony Liguori's avatar
Anthony Liguori committed
180
    assert(dc->unplug != NULL);
181

182 183
    qdev_hot_removed = true;

Anthony Liguori's avatar
Anthony Liguori committed
184
    return dc->unplug(dev);
185 186
}

187 188
static int qdev_reset_one(DeviceState *dev, void *opaque)
{
189
    device_reset(dev);
190 191 192 193 194 195

    return 0;
}

BusState *sysbus_get_default(void)
{
196
    if (!main_system_bus) {
197
        main_system_bus_create();
198
    }
199 200 201
    return main_system_bus;
}

202 203 204 205 206 207 208 209
static int qbus_reset_one(BusState *bus, void *opaque)
{
    if (bus->info->reset) {
        return bus->info->reset(bus);
    }
    return 0;
}

210 211 212 213 214
void qdev_reset_all(DeviceState *dev)
{
    qdev_walk_children(dev, qdev_reset_one, qbus_reset_one, NULL);
}

215 216 217
void qbus_reset_all_fn(void *opaque)
{
    BusState *bus = opaque;
218
    qbus_walk_children(bus, qdev_reset_one, qbus_reset_one, NULL);
219 220
}

221 222 223 224 225 226 227 228
/* can be used as ->unplug() callback for the simple cases */
int qdev_simple_unplug_cb(DeviceState *dev)
{
    /* just zap it */
    qdev_free(dev);
    return 0;
}

229 230

/* Like qdev_init(), but terminate program via error_report() instead of
Markus Armbruster's avatar
Markus Armbruster committed
231 232 233 234 235 236 237 238
   returning an error value.  This is okay during machine creation.
   Don't use for hotplug, because there callers need to recover from
   failure.  Exception: if you know the device's init() callback can't
   fail, then qdev_init_nofail() can't fail either, and is therefore
   usable even then.  But relying on the device implementation that
   way is somewhat unclean, and best avoided.  */
void qdev_init_nofail(DeviceState *dev)
{
239
    if (qdev_init(dev) < 0) {
Anthony Liguori's avatar
Anthony Liguori committed
240 241
        error_report("Initialization of device %s failed",
                     object_get_typename(OBJECT(dev)));
242 243
        exit(1);
    }
Markus Armbruster's avatar
Markus Armbruster committed
244 245
}

246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
static void qdev_property_del_all(DeviceState *dev)
{
    while (!QTAILQ_EMPTY(&dev->properties)) {
        DeviceProperty *prop = QTAILQ_FIRST(&dev->properties);

        QTAILQ_REMOVE(&dev->properties, prop, node);

        if (prop->release) {
            prop->release(dev, prop->name, prop->opaque);
        }

        g_free(prop->name);
        g_free(prop->type);
        g_free(prop);
    }
}

263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
static void qdev_property_del_child(DeviceState *dev, DeviceState *child, Error **errp)
{
    DeviceProperty *prop;

    QTAILQ_FOREACH(prop, &dev->properties, node) {
        if (strstart(prop->type, "child<", NULL) && prop->opaque == child) {
            break;
        }
    }

    g_assert(prop != NULL);

    QTAILQ_REMOVE(&dev->properties, prop, node);

    if (prop->release) {
        prop->release(dev, prop->name, prop->opaque);
    }

    g_free(prop->name);
    g_free(prop->type);
    g_free(prop);
}

Paul Brook's avatar
Paul Brook committed
286 287 288
/* Unlink device from bus and free the structure.  */
void qdev_free(DeviceState *dev)
{
Gerd Hoffmann's avatar
Gerd Hoffmann committed
289
    BusState *bus;
290
    Property *prop;
Anthony Liguori's avatar
Anthony Liguori committed
291
    DeviceClass *dc = DEVICE_GET_CLASS(dev);
Gerd Hoffmann's avatar
Gerd Hoffmann committed
292

293 294
    qdev_property_del_all(dev);

Gerd Hoffmann's avatar
Gerd Hoffmann committed
295 296 297 298 299
    if (dev->state == DEV_STATE_INITIALIZED) {
        while (dev->num_child_bus) {
            bus = QLIST_FIRST(&dev->child_bus);
            qbus_free(bus);
        }
Anthony Liguori's avatar
Anthony Liguori committed
300 301 302 303 304 305 306
        if (qdev_get_vmsd(dev)) {
            vmstate_unregister(dev, qdev_get_vmsd(dev), dev);
        }
        if (dc->exit) {
            dc->exit(dev);
        }
        if (dev->opts) {
307
            qemu_opts_del(dev->opts);
Anthony Liguori's avatar
Anthony Liguori committed
308
        }
Gerd Hoffmann's avatar
Gerd Hoffmann committed
309
    }
310
    QTAILQ_REMOVE(&dev->parent_bus->children, dev, sibling);
Anthony Liguori's avatar
Anthony Liguori committed
311
    for (prop = qdev_get_props(dev); prop && prop->name; prop++) {
312 313 314 315
        if (prop->info->free) {
            prop->info->free(dev, prop);
        }
    }
316 317 318 319 320 321
    if (dev->parent) {
        qdev_property_del_child(dev->parent, dev, NULL);
    }
    if (dev->ref != 0) {
        qerror_report(QERR_DEVICE_IN_USE, dev->id?:"");
    }
322
    object_delete(OBJECT(dev));
Paul Brook's avatar
Paul Brook committed
323 324
}

325 326 327 328 329 330 331 332 333
void qdev_machine_creation_done(void)
{
    /*
     * ok, initial machine setup is done, starting from now we can
     * only create hotpluggable devices
     */
    qdev_hotplug = 1;
}

334 335 336 337 338
bool qdev_machine_modified(void)
{
    return qdev_hot_added || qdev_hot_removed;
}

Paul Brook's avatar
Paul Brook committed
339 340 341 342
/* Get a character (serial) device interface.  */
CharDriverState *qdev_init_chardev(DeviceState *dev)
{
    static int next_serial;
343 344 345

    /* FIXME: This function needs to go away: use chardev properties!  */
    return serial_hds[next_serial++];
Paul Brook's avatar
Paul Brook committed
346 347
}

Paul Brook's avatar
Paul Brook committed
348
BusState *qdev_get_parent_bus(DeviceState *dev)
Paul Brook's avatar
Paul Brook committed
349
{
Paul Brook's avatar
Paul Brook committed
350
    return dev->parent_bus;
Paul Brook's avatar
Paul Brook committed
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
}

void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n)
{
    assert(dev->num_gpio_in == 0);
    dev->num_gpio_in = n;
    dev->gpio_in = qemu_allocate_irqs(handler, dev, n);
}

void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n)
{
    assert(dev->num_gpio_out == 0);
    dev->num_gpio_out = n;
    dev->gpio_out = pins;
}

qemu_irq qdev_get_gpio_in(DeviceState *dev, int n)
{
    assert(n >= 0 && n < dev->num_gpio_in);
    return dev->gpio_in[n];
}

void qdev_connect_gpio_out(DeviceState * dev, int n, qemu_irq pin)
{
    assert(n >= 0 && n < dev->num_gpio_out);
    dev->gpio_out[n] = pin;
}

379 380
void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd)
{
381
    qdev_prop_set_macaddr(dev, "mac", nd->macaddr.a);
382 383 384 385
    if (nd->vlan)
        qdev_prop_set_vlan(dev, "vlan", nd->vlan);
    if (nd->netdev)
        qdev_prop_set_netdev(dev, "netdev", nd->netdev);
386
    if (nd->nvectors != DEV_NVECTORS_UNSPECIFIED &&
387 388 389
        qdev_prop_exists(dev, "vectors")) {
        qdev_prop_set_uint32(dev, "vectors", nd->nvectors);
    }
390
    nd->instantiated = 1;
391 392
}

Paul Brook's avatar
Paul Brook committed
393
BusState *qdev_get_child_bus(DeviceState *dev, const char *name)
Paul Brook's avatar
Paul Brook committed
394
{
Paul Brook's avatar
Paul Brook committed
395
    BusState *bus;
Paul Brook's avatar
Paul Brook committed
396

Blue Swirl's avatar
Blue Swirl committed
397
    QLIST_FOREACH(bus, &dev->child_bus, sibling) {
Paul Brook's avatar
Paul Brook committed
398
        if (strcmp(name, bus->name) == 0) {
Paul Brook's avatar
Paul Brook committed
399
            return bus;
Paul Brook's avatar
Paul Brook committed
400 401 402 403 404
        }
    }
    return NULL;
}

405 406 407 408 409 410 411 412 413 414 415 416 417
int qbus_walk_children(BusState *bus, qdev_walkerfn *devfn,
                       qbus_walkerfn *busfn, void *opaque)
{
    DeviceState *dev;
    int err;

    if (busfn) {
        err = busfn(bus, opaque);
        if (err) {
            return err;
        }
    }

418
    QTAILQ_FOREACH(dev, &bus->children, sibling) {
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
        err = qdev_walk_children(dev, devfn, busfn, opaque);
        if (err < 0) {
            return err;
        }
    }

    return 0;
}

int qdev_walk_children(DeviceState *dev, qdev_walkerfn *devfn,
                       qbus_walkerfn *busfn, void *opaque)
{
    BusState *bus;
    int err;

    if (devfn) {
        err = devfn(dev, opaque);
        if (err) {
            return err;
        }
    }

    QLIST_FOREACH(bus, &dev->child_bus, sibling) {
        err = qbus_walk_children(bus, devfn, busfn, opaque);
        if (err < 0) {
            return err;
        }
    }

    return 0;
}

451
DeviceState *qdev_find_recursive(BusState *bus, const char *id)
452 453 454 455
{
    DeviceState *dev, *ret;
    BusState *child;

456
    QTAILQ_FOREACH(dev, &bus->children, sibling) {
457 458 459 460 461 462 463 464 465 466 467 468
        if (dev->id && strcmp(dev->id, id) == 0)
            return dev;
        QLIST_FOREACH(child, &dev->child_bus, sibling) {
            ret = qdev_find_recursive(child, id);
            if (ret) {
                return ret;
            }
        }
    }
    return NULL;
}

469 470
void qbus_create_inplace(BusState *bus, BusInfo *info,
                         DeviceState *parent, const char *name)
Paul Brook's avatar
Paul Brook committed
471
{
472 473
    char *buf;
    int i,len;
Paul Brook's avatar
Paul Brook committed
474

475
    bus->info = info;
Paul Brook's avatar
Paul Brook committed
476
    bus->parent = parent;
477 478 479

    if (name) {
        /* use supplied name */
480
        bus->name = g_strdup(name);
481 482 483
    } else if (parent && parent->id) {
        /* parent device has id -> use it for bus name */
        len = strlen(parent->id) + 16;
484
        buf = g_malloc(len);
485 486 487 488 489
        snprintf(buf, len, "%s.%d", parent->id, parent->num_child_bus);
        bus->name = buf;
    } else {
        /* no id -> use lowercase bus type for bus name */
        len = strlen(info->name) + 16;
490
        buf = g_malloc(len);
491 492 493
        len = snprintf(buf, len, "%s.%d", info->name,
                       parent ? parent->num_child_bus : 0);
        for (i = 0; i < len; i++)
Christoph Egger's avatar
Christoph Egger committed
494
            buf[i] = qemu_tolower(buf[i]);
495 496 497
        bus->name = buf;
    }

498
    QTAILQ_INIT(&bus->children);
Paul Brook's avatar
Paul Brook committed
499
    if (parent) {
Blue Swirl's avatar
Blue Swirl committed
500
        QLIST_INSERT_HEAD(&parent->child_bus, bus, sibling);
501
        parent->num_child_bus++;
502 503 504 505
    } else if (bus != main_system_bus) {
        /* TODO: once all bus devices are qdevified,
           only reset handler for main_system_bus should be registered here. */
        qemu_register_reset(qbus_reset_all_fn, bus);
Paul Brook's avatar
Paul Brook committed
506
    }
507 508 509 510 511 512
}

BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name)
{
    BusState *bus;

513
    bus = g_malloc0(info->size);
514 515
    bus->qdev_allocated = 1;
    qbus_create_inplace(bus, info, parent, name);
Paul Brook's avatar
Paul Brook committed
516 517
    return bus;
}
518

519 520 521 522
static void main_system_bus_create(void)
{
    /* assign main_system_bus before qbus_create_inplace()
     * in order to make "if (bus != main_system_bus)" work */
523
    main_system_bus = g_malloc0(system_bus_info.size);
524 525 526 527 528
    main_system_bus->qdev_allocated = 1;
    qbus_create_inplace(main_system_bus, &system_bus_info, NULL,
                        "main-system-bus");
}

Gerd Hoffmann's avatar
Gerd Hoffmann committed
529 530 531 532
void qbus_free(BusState *bus)
{
    DeviceState *dev;

533
    while ((dev = QTAILQ_FIRST(&bus->children)) != NULL) {
Gerd Hoffmann's avatar
Gerd Hoffmann committed
534 535 536 537 538
        qdev_free(dev);
    }
    if (bus->parent) {
        QLIST_REMOVE(bus, sibling);
        bus->parent->num_child_bus--;
539 540 541
    } else {
        assert(bus != main_system_bus); /* main_system_bus is never freed */
        qemu_unregister_reset(qbus_reset_all_fn, bus);
Gerd Hoffmann's avatar
Gerd Hoffmann committed
542
    }
543
    g_free((void*)bus->name);
Gerd Hoffmann's avatar
Gerd Hoffmann committed
544
    if (bus->qdev_allocated) {
545
        g_free(bus);
Gerd Hoffmann's avatar
Gerd Hoffmann committed
546 547 548
    }
}

549 550 551 552 553 554 555 556 557 558
static int qdev_get_fw_dev_path_helper(DeviceState *dev, char *p, int size)
{
    int l = 0;

    if (dev && dev->parent_bus) {
        char *d;
        l = qdev_get_fw_dev_path_helper(dev->parent_bus->parent, p, size);
        if (dev->parent_bus->info->get_fw_dev_path) {
            d = dev->parent_bus->info->get_fw_dev_path(dev);
            l += snprintf(p + l, size - l, "%s", d);
559
            g_free(d);
560
        } else {
561
            l += snprintf(p + l, size - l, "%s", object_get_typename(OBJECT(dev)));
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
        }
    }
    l += snprintf(p + l , size - l, "/");

    return l;
}

char* qdev_get_fw_dev_path(DeviceState *dev)
{
    char path[128];
    int l;

    l = qdev_get_fw_dev_path_helper(dev, path, 128);

    path[l-1] = '\0';

    return strdup(path);
}
580

581 582
char *qdev_get_type(DeviceState *dev, Error **errp)
{
583
    return g_strdup(object_get_typename(OBJECT(dev)));
584 585
}

586 587 588 589 590 591 592 593 594 595
void qdev_ref(DeviceState *dev)
{
    dev->ref++;
}

void qdev_unref(DeviceState *dev)
{
    g_assert(dev->ref > 0);
    dev->ref--;
}
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657

void qdev_property_add(DeviceState *dev, const char *name, const char *type,
                       DevicePropertyAccessor *get, DevicePropertyAccessor *set,
                       DevicePropertyRelease *release,
                       void *opaque, Error **errp)
{
    DeviceProperty *prop = g_malloc0(sizeof(*prop));

    prop->name = g_strdup(name);
    prop->type = g_strdup(type);

    prop->get = get;
    prop->set = set;
    prop->release = release;
    prop->opaque = opaque;

    QTAILQ_INSERT_TAIL(&dev->properties, prop, node);
}

static DeviceProperty *qdev_property_find(DeviceState *dev, const char *name)
{
    DeviceProperty *prop;

    QTAILQ_FOREACH(prop, &dev->properties, node) {
        if (strcmp(prop->name, name) == 0) {
            return prop;
        }
    }

    return NULL;
}

void qdev_property_get(DeviceState *dev, Visitor *v, const char *name,
                       Error **errp)
{
    DeviceProperty *prop = qdev_property_find(dev, name);

    if (prop == NULL) {
        error_set(errp, QERR_PROPERTY_NOT_FOUND, dev->id?:"", name);
        return;
    }

    if (!prop->get) {
        error_set(errp, QERR_PERMISSION_DENIED);
    } else {
        prop->get(dev, v, prop->opaque, name, errp);
    }
}

void qdev_property_set(DeviceState *dev, Visitor *v, const char *name,
                       Error **errp)
{
    DeviceProperty *prop = qdev_property_find(dev, name);

    if (prop == NULL) {
        error_set(errp, QERR_PROPERTY_NOT_FOUND, dev->id?:"", name);
        return;
    }

    if (!prop->set) {
        error_set(errp, QERR_PERMISSION_DENIED);
    } else {
Paolo Bonzini's avatar
Paolo Bonzini committed
658
        prop->set(dev, v, prop->opaque, name, errp);
659 660 661 662 663 664 665 666 667 668 669 670 671 672
    }
}

const char *qdev_property_get_type(DeviceState *dev, const char *name, Error **errp)
{
    DeviceProperty *prop = qdev_property_find(dev, name);

    if (prop == NULL) {
        error_set(errp, QERR_PROPERTY_NOT_FOUND, dev->id?:"", name);
        return NULL;
    }

    return prop->type;
}
673 674 675 676 677 678 679 680 681 682

/**
 * Legacy property handling
 */

static void qdev_get_legacy_property(DeviceState *dev, Visitor *v, void *opaque,
                                     const char *name, Error **errp)
{
    Property *prop = opaque;

683 684
    char buffer[1024];
    char *ptr = buffer;
685

686 687
    prop->info->print(dev, prop, buffer, sizeof(buffer));
    visit_type_str(v, &ptr, name, errp);
688 689 690 691 692 693
}

static void qdev_set_legacy_property(DeviceState *dev, Visitor *v, void *opaque,
                                     const char *name, Error **errp)
{
    Property *prop = opaque;
694 695 696
    Error *local_err = NULL;
    char *ptr = NULL;
    int ret;
697 698 699 700 701 702

    if (dev->state != DEV_STATE_CREATED) {
        error_set(errp, QERR_PERMISSION_DENIED);
        return;
    }

703 704 705 706 707
    visit_type_str(v, &ptr, name, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }
708

709
    ret = prop->info->parse(dev, prop, ptr);
710
    error_set_from_qdev_prop_error(errp, ret, dev, prop, ptr);
711
    g_free(ptr);
712 713 714 715 716 717
}

/**
 * @qdev_add_legacy_property - adds a legacy property
 *
 * Do not use this is new code!  Properties added through this interface will
718
 * be given names and types in the "legacy" namespace.
719 720 721 722 723 724 725
 *
 * Legacy properties are always processed as strings.  The format of the string
 * depends on the property type.
 */
void qdev_property_add_legacy(DeviceState *dev, Property *prop,
                              Error **errp)
{
726
    gchar *name, *type;
727

728
    name = g_strdup_printf("legacy-%s", prop->name);
729 730
    type = g_strdup_printf("legacy<%s>",
                           prop->info->legacy_name ?: prop->info->name);
731

732
    qdev_property_add(dev, name, type,
733 734
                      prop->info->print ? qdev_get_legacy_property : NULL,
                      prop->info->parse ? qdev_set_legacy_property : NULL,
735 736 737 738
                      NULL,
                      prop, errp);

    g_free(type);
739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
    g_free(name);
}

/**
 * @qdev_property_add_static - add a @Property to a device.
 *
 * Static properties access data in a struct.  The actual type of the
 * property and the field depends on the property type.
 */
void qdev_property_add_static(DeviceState *dev, Property *prop,
                              Error **errp)
{
    qdev_property_add(dev, prop->name, prop->info->name,
                      prop->info->get, prop->info->set,
                      NULL,
                      prop, errp);
755
}
Anthony Liguori's avatar
Anthony Liguori committed
756 757 758 759 760 761 762 763 764 765 766 767

DeviceState *qdev_get_root(void)
{
    static DeviceState *qdev_root;

    if (!qdev_root) {
        qdev_root = qdev_create(NULL, "container");
        qdev_init_nofail(qdev_root);
    }

    return qdev_root;
}
768

769 770 771 772 773 774 775 776 777 778 779
static void qdev_get_child_property(DeviceState *dev, Visitor *v, void *opaque,
                                    const char *name, Error **errp)
{
    DeviceState *child = opaque;
    gchar *path;

    path = qdev_get_canonical_path(child);
    visit_type_str(v, &path, name, errp);
    g_free(path);
}

780 781 782 783 784 785 786 787
static void qdev_release_child_property(DeviceState *dev, const char *name,
                                        void *opaque)
{
    DeviceState *child = opaque;

    qdev_unref(child);
}

788 789 790 791 792
void qdev_property_add_child(DeviceState *dev, const char *name,
                             DeviceState *child, Error **errp)
{
    gchar *type;

793
    type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
794 795

    qdev_property_add(dev, name, type, qdev_get_child_property,
796 797
                      NULL, qdev_release_child_property,
                      child, errp);
798 799

    qdev_ref(child);
800 801
    g_assert(child->parent == NULL);
    child->parent = dev;
802 803 804 805

    g_free(type);
}

806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
static void qdev_get_link_property(DeviceState *dev, Visitor *v, void *opaque,
                                   const char *name, Error **errp)
{
    DeviceState **child = opaque;
    gchar *path;

    if (*child) {
        path = qdev_get_canonical_path(*child);
        visit_type_str(v, &path, name, errp);
        g_free(path);
    } else {
        path = (gchar *)"";
        visit_type_str(v, &path, name, errp);
    }
}

static void qdev_set_link_property(DeviceState *dev, Visitor *v, void *opaque,
                                   const char *name, Error **errp)
{
    DeviceState **child = opaque;
    bool ambiguous = false;
    const char *type;
    char *path;

    type = qdev_property_get_type(dev, name, NULL);

    visit_type_str(v, &path, name, errp);

    if (*child) {
        qdev_unref(*child);
    }

    if (strcmp(path, "") != 0) {
        DeviceState *target;

        target = qdev_resolve_path(path, &ambiguous);
        if (target) {
            gchar *target_type;

845
            target_type = g_strdup_printf("link<%s>", object_get_typename(OBJECT(target)));
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
            if (strcmp(target_type, type) == 0) {
                *child = target;
                qdev_ref(target);
            } else {
                error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, type);
            }

            g_free(target_type);
        } else {
            error_set(errp, QERR_DEVICE_NOT_FOUND, path);
        }
    } else {
        *child = NULL;
    }

    g_free(path);
}

void qdev_property_add_link(DeviceState *dev, const char *name,
                            const char *type, DeviceState **child,
                            Error **errp)
{
    gchar *full_type;

    full_type = g_strdup_printf("link<%s>", type);

    qdev_property_add(dev, name, full_type,
                      qdev_get_link_property,
                      qdev_set_link_property,
                      NULL, child, errp);

    g_free(full_type);
}

880
gchar *qdev_get_canonical_path(DeviceState *dev)
881
{
882 883
    DeviceState *root = qdev_get_root();
    char *newpath = NULL, *path = NULL;
884

885 886
    while (dev != root) {
        DeviceProperty *prop = NULL;
887

888
        g_assert(dev->parent != NULL);
889

890 891 892 893
        QTAILQ_FOREACH(prop, &dev->parent->properties, node) {
            if (!strstart(prop->type, "child<", NULL)) {
                continue;
            }
894

895 896 897 898 899 900 901 902 903 904
            if (prop->opaque == dev) {
                if (path) {
                    newpath = g_strdup_printf("%s/%s", prop->name, path);
                    g_free(path);
                    path = newpath;
                } else {
                    path = g_strdup(prop->name);
                }
                break;
            }
905 906
        }

907
        g_assert(prop != NULL);
908

909
        dev = dev->parent;
910 911 912 913 914 915 916
    }

    newpath = g_strdup_printf("/%s", path);
    g_free(path);

    return newpath;
}
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019

static DeviceState *qdev_resolve_abs_path(DeviceState *parent,
                                          gchar **parts,
                                          int index)
{
    DeviceProperty *prop;
    DeviceState *child;

    if (parts[index] == NULL) {
        return parent;
    }

    if (strcmp(parts[index], "") == 0) {
        return qdev_resolve_abs_path(parent, parts, index + 1);
    }

    prop = qdev_property_find(parent, parts[index]);
    if (prop == NULL) {
        return NULL;
    }

    child = NULL;
    if (strstart(prop->type, "link<", NULL)) {
        DeviceState **pchild = prop->opaque;
        if (*pchild) {
            child = *pchild;
        }
    } else if (strstart(prop->type, "child<", NULL)) {
        child = prop->opaque;
    }

    if (!child) {
        return NULL;
    }

    return qdev_resolve_abs_path(child, parts, index + 1);
}

static DeviceState *qdev_resolve_partial_path(DeviceState *parent,
                                              gchar **parts,
                                              bool *ambiguous)
{
    DeviceState *dev;
    DeviceProperty *prop;

    dev = qdev_resolve_abs_path(parent, parts, 0);

    QTAILQ_FOREACH(prop, &parent->properties, node) {
        DeviceState *found;

        if (!strstart(prop->type, "child<", NULL)) {
            continue;
        }

        found = qdev_resolve_partial_path(prop->opaque, parts, ambiguous);
        if (found) {
            if (dev) {
                if (ambiguous) {
                    *ambiguous = true;
                }
                return NULL;
            }
            dev = found;
        }

        if (ambiguous && *ambiguous) {
            return NULL;
        }
    }

    return dev;
}

DeviceState *qdev_resolve_path(const char *path, bool *ambiguous)
{
    bool partial_path = true;
    DeviceState *dev;
    gchar **parts;

    parts = g_strsplit(path, "/", 0);
    if (parts == NULL || parts[0] == NULL) {
        g_strfreev(parts);
        return qdev_get_root();
    }

    if (strcmp(parts[0], "") == 0) {
        partial_path = false;
    }

    if (partial_path) {
        if (ambiguous) {
            *ambiguous = false;
        }
        dev = qdev_resolve_partial_path(qdev_get_root(), parts, ambiguous);
    } else {
        dev = qdev_resolve_abs_path(qdev_get_root(), parts, 1);
    }

    g_strfreev(parts);

    return dev;
}

1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
typedef struct StringProperty
{
    char *(*get)(DeviceState *, Error **);
    void (*set)(DeviceState *, const char *, Error **);
} StringProperty;

static void qdev_property_get_str(DeviceState *dev, Visitor *v, void *opaque,
                                  const char *name, Error **errp)
{
    StringProperty *prop = opaque;
    char *value;

    value = prop->get(dev, errp);
    if (value) {
        visit_type_str(v, &value, name, errp);
        g_free(value);
    }
}

static void qdev_property_set_str(DeviceState *dev, Visitor *v, void *opaque,
                                  const char *name, Error **errp)
{
    StringProperty *prop = opaque;
    char *value;
    Error *local_err = NULL;

    visit_type_str(v, &value, name, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }

    prop->set(dev, value, errp);
    g_free(value);
}

static void qdev_property_release_str(DeviceState *dev, const char *name,
                                      void *opaque)
{
    StringProperty *prop = opaque;
    g_free(prop);
}

void qdev_property_add_str(DeviceState *dev, const char *name,
                           char *(*get)(DeviceState *, Error **),
                           void (*set)(DeviceState *, const char *, Error **),
                           Error **errp)
{
    StringProperty *prop = g_malloc0(sizeof(*prop));

    prop->get = get;
    prop->set = set;

    qdev_property_add(dev, name, "string",
                      get ? qdev_property_get_str : NULL,
                      set ? qdev_property_set_str : NULL,
                      qdev_property_release_str,
                      prop, errp);
}
1079

1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102
static void device_initfn(Object *obj)
{
    DeviceState *dev = DEVICE(obj);
    Property *prop;

    if (qdev_hotplug) {
        dev->hotplugged = 1;
        qdev_hot_added = true;
    }

    dev->instance_id_alias = -1;
    QTAILQ_INIT(&dev->properties);
    dev->state = DEV_STATE_CREATED;

    qdev_prop_set_defaults(dev, qdev_get_props(dev));
    for (prop = qdev_get_props(dev); prop && prop->name; prop++) {
        qdev_property_add_legacy(dev, prop, NULL);
        qdev_property_add_static(dev, prop, NULL);
    }

    qdev_property_add_str(dev, "type", qdev_get_type, NULL, NULL);
}

1103 1104 1105 1106 1107 1108 1109 1110 1111
void device_reset(DeviceState *dev)
{
    DeviceClass *klass = DEVICE_GET_CLASS(dev);

    if (klass->reset) {
        klass->reset(dev);
    }
}

1112 1113 1114 1115
static TypeInfo device_type_info = {
    .name = TYPE_DEVICE,
    .parent = TYPE_OBJECT,
    .instance_size = sizeof(DeviceState),
1116
    .instance_init = device_initfn,
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
    .abstract = true,
    .class_size = sizeof(DeviceClass),
};

static void init_qdev(void)
{
    type_register_static(&device_type_info);
}

device_init(init_qdev);