object.c 29.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
 * QEMU Object Model
 *
 * Copyright IBM, Corp. 2011
 *
 * Authors:
 *  Anthony Liguori   <aliguori@us.ibm.com>
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 * See the COPYING file in the top-level directory.
 */

#include "qemu/object.h"
#include "qemu-common.h"
15
#include "qapi/qapi-visit-core.h"
16 17
#include "qapi/string-input-visitor.h"
#include "qapi/string-output-visitor.h"
18

19 20 21 22 23 24 25 26
/* TODO: replace QObject with a simpler visitor to avoid a dependency
 * of the QOM core on QObject?  */
#include "qemu/qom-qobject.h"
#include "qobject.h"
#include "qbool.h"
#include "qint.h"
#include "qstring.h"

27 28 29 30 31 32 33
#define MAX_INTERFACES 32

typedef struct InterfaceImpl InterfaceImpl;
typedef struct TypeImpl TypeImpl;

struct InterfaceImpl
{
A
Anthony Liguori 已提交
34
    const char *typename;
35 36 37 38 39 40 41 42 43 44 45
};

struct TypeImpl
{
    const char *name;

    size_t class_size;

    size_t instance_size;

    void (*class_init)(ObjectClass *klass, void *data);
P
Paolo Bonzini 已提交
46
    void (*class_base_init)(ObjectClass *klass, void *data);
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
    void (*class_finalize)(ObjectClass *klass, void *data);

    void *class_data;

    void (*instance_init)(Object *obj);
    void (*instance_finalize)(Object *obj);

    bool abstract;

    const char *parent;
    TypeImpl *parent_type;

    ObjectClass *class;

    int num_interfaces;
    InterfaceImpl interfaces[MAX_INTERFACES];
};

65 66
static Type type_interface;

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
static GHashTable *type_table_get(void)
{
    static GHashTable *type_table;

    if (type_table == NULL) {
        type_table = g_hash_table_new(g_str_hash, g_str_equal);
    }

    return type_table;
}

static void type_table_add(TypeImpl *ti)
{
    g_hash_table_insert(type_table_get(), (void *)ti->name, ti);
}

static TypeImpl *type_table_lookup(const char *name)
{
    return g_hash_table_lookup(type_table_get(), name);
}

88
static TypeImpl *type_register_internal(const TypeInfo *info)
89 90
{
    TypeImpl *ti = g_malloc0(sizeof(*ti));
A
Anthony Liguori 已提交
91
    int i;
92 93 94

    g_assert(info->name != NULL);

95 96 97 98 99
    if (type_table_lookup(info->name) != NULL) {
        fprintf(stderr, "Registering `%s' which already exists\n", info->name);
        abort();
    }

100 101 102 103 104 105 106
    ti->name = g_strdup(info->name);
    ti->parent = g_strdup(info->parent);

    ti->class_size = info->class_size;
    ti->instance_size = info->instance_size;

    ti->class_init = info->class_init;
P
Paolo Bonzini 已提交
107
    ti->class_base_init = info->class_base_init;
108 109 110 111 112 113 114 115
    ti->class_finalize = info->class_finalize;
    ti->class_data = info->class_data;

    ti->instance_init = info->instance_init;
    ti->instance_finalize = info->instance_finalize;

    ti->abstract = info->abstract;

A
Anthony Liguori 已提交
116 117
    for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
        ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
118
    }
A
Anthony Liguori 已提交
119
    ti->num_interfaces = i;
120 121 122 123 124 125

    type_table_add(ti);

    return ti;
}

126 127 128 129 130 131
TypeImpl *type_register(const TypeInfo *info)
{
    assert(info->parent);
    return type_register_internal(info);
}

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
TypeImpl *type_register_static(const TypeInfo *info)
{
    return type_register(info);
}

static TypeImpl *type_get_by_name(const char *name)
{
    if (name == NULL) {
        return NULL;
    }

    return type_table_lookup(name);
}

static TypeImpl *type_get_parent(TypeImpl *type)
{
    if (!type->parent_type && type->parent) {
        type->parent_type = type_get_by_name(type->parent);
        g_assert(type->parent_type != NULL);
    }

    return type->parent_type;
}

static bool type_has_parent(TypeImpl *type)
{
    return (type->parent != NULL);
}

static size_t type_class_get_size(TypeImpl *ti)
{
    if (ti->class_size) {
        return ti->class_size;
    }

    if (type_has_parent(ti)) {
        return type_class_get_size(type_get_parent(ti));
    }

    return sizeof(ObjectClass);
}

174 175 176 177 178 179 180 181 182 183 184 185 186
static size_t type_object_get_size(TypeImpl *ti)
{
    if (ti->instance_size) {
        return ti->instance_size;
    }

    if (type_has_parent(ti)) {
        return type_object_get_size(type_get_parent(ti));
    }

    return 0;
}

A
Anthony Liguori 已提交
187
static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
188
{
A
Anthony Liguori 已提交
189 190 191 192 193 194 195
    assert(target_type);

    /* Check if typename is a direct ancestor of type */
    while (type) {
        if (type == target_type) {
            return true;
        }
196

A
Anthony Liguori 已提交
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
        type = type_get_parent(type);
    }

    return false;
}

static void type_initialize(TypeImpl *ti);

static void type_initialize_interface(TypeImpl *ti, const char *parent)
{
    InterfaceClass *new_iface;
    TypeInfo info = { };
    TypeImpl *iface_impl;

    info.parent = parent;
    info.name = g_strdup_printf("%s::%s", ti->name, info.parent);
    info.abstract = true;

    iface_impl = type_register(&info);
    type_initialize(iface_impl);
    g_free((char *)info.name);

    new_iface = (InterfaceClass *)iface_impl->class;
    new_iface->concrete_class = ti->class;

    ti->class->interfaces = g_slist_append(ti->class->interfaces,
                                           iface_impl->class);
224 225
}

226
static void type_initialize(TypeImpl *ti)
227
{
P
Paolo Bonzini 已提交
228
    TypeImpl *parent;
229 230 231 232 233 234

    if (ti->class) {
        return;
    }

    ti->class_size = type_class_get_size(ti);
235
    ti->instance_size = type_object_get_size(ti);
236 237 238

    ti->class = g_malloc0(ti->class_size);

P
Paolo Bonzini 已提交
239 240
    parent = type_get_parent(ti);
    if (parent) {
241
        type_initialize(parent);
A
Anthony Liguori 已提交
242 243
        GSList *e;
        int i;
244 245

        g_assert(parent->class_size <= ti->class_size);
P
Paolo Bonzini 已提交
246
        memcpy(ti->class, parent->class, parent->class_size);
A
Anthony Liguori 已提交
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268

        for (e = parent->class->interfaces; e; e = e->next) {
            ObjectClass *iface = e->data;
            type_initialize_interface(ti, object_class_get_name(iface));
        }

        for (i = 0; i < ti->num_interfaces; i++) {
            TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
            for (e = ti->class->interfaces; e; e = e->next) {
                TypeImpl *target_type = OBJECT_CLASS(e->data)->type;

                if (type_is_ancestor(target_type, t)) {
                    break;
                }
            }

            if (e) {
                continue;
            }

            type_initialize_interface(ti, ti->interfaces[i].typename);
        }
P
Paolo Bonzini 已提交
269
    }
270

P
Paolo Bonzini 已提交
271
    ti->class->type = ti;
P
Paolo Bonzini 已提交
272

P
Paolo Bonzini 已提交
273 274 275
    while (parent) {
        if (parent->class_base_init) {
            parent->class_base_init(ti->class, ti->class_data);
P
Paolo Bonzini 已提交
276
        }
P
Paolo Bonzini 已提交
277
        parent = type_get_parent(parent);
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
    }

    if (ti->class_init) {
        ti->class_init(ti->class, ti->class_data);
    }


}

static void object_init_with_type(Object *obj, TypeImpl *ti)
{
    if (type_has_parent(ti)) {
        object_init_with_type(obj, type_get_parent(ti));
    }

    if (ti->instance_init) {
        ti->instance_init(obj);
    }
}

void object_initialize_with_type(void *data, TypeImpl *type)
{
    Object *obj = data;

    g_assert(type != NULL);
303
    type_initialize(type);
304 305

    g_assert(type->instance_size >= sizeof(Object));
306 307 308 309
    g_assert(type->abstract == false);

    memset(obj, 0, type->instance_size);
    obj->class = type->class;
310
    object_ref(obj);
311
    QTAILQ_INIT(&obj->properties);
312 313 314 315 316 317 318 319 320 321
    object_init_with_type(obj, type);
}

void object_initialize(void *data, const char *typename)
{
    TypeImpl *type = type_get_by_name(typename);

    object_initialize_with_type(data, type);
}

322 323 324 325 326 327 328 329 330 331
static inline bool object_property_is_child(ObjectProperty *prop)
{
    return strstart(prop->type, "child<", NULL);
}

static inline bool object_property_is_link(ObjectProperty *prop)
{
    return strstart(prop->type, "link<", NULL);
}

332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
static void object_property_del_all(Object *obj)
{
    while (!QTAILQ_EMPTY(&obj->properties)) {
        ObjectProperty *prop = QTAILQ_FIRST(&obj->properties);

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

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

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

static void object_property_del_child(Object *obj, Object *child, Error **errp)
{
    ObjectProperty *prop;

    QTAILQ_FOREACH(prop, &obj->properties, node) {
354
        if (object_property_is_child(prop) && prop->opaque == child) {
355
            object_property_del(obj, prop->name, errp);
P
Paolo Bonzini 已提交
356
            break;
357 358 359 360 361 362 363 364 365
        }
    }
}

void object_unparent(Object *obj)
{
    if (obj->parent) {
        object_property_del_child(obj->parent, obj, NULL);
    }
366 367 368
    if (obj->class->unparent) {
        (obj->class->unparent)(obj);
    }
369 370
}

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
static void object_deinit(Object *obj, TypeImpl *type)
{
    if (type->instance_finalize) {
        type->instance_finalize(obj);
    }

    if (type_has_parent(type)) {
        object_deinit(obj, type_get_parent(type));
    }
}

void object_finalize(void *data)
{
    Object *obj = data;
    TypeImpl *ti = obj->class->type;

    object_deinit(obj, ti);
388
    object_property_del_all(obj);
389 390

    g_assert(obj->ref == 0);
391 392 393
    if (obj->free) {
        obj->free(obj);
    }
394 395 396 397 398 399 400
}

Object *object_new_with_type(Type type)
{
    Object *obj;

    g_assert(type != NULL);
401
    type_initialize(type);
402 403 404

    obj = g_malloc(type->instance_size);
    object_initialize_with_type(obj, type);
405
    obj->free = g_free;
406 407 408 409 410 411 412 413 414 415 416 417 418

    return obj;
}

Object *object_new(const char *typename)
{
    TypeImpl *ti = type_get_by_name(typename);

    return object_new_with_type(ti);
}

void object_delete(Object *obj)
{
419 420
    object_unparent(obj);
    g_assert(obj->ref == 1);
421
    object_unref(obj);
422 423 424 425
}

Object *object_dynamic_cast(Object *obj, const char *typename)
{
426
    if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
427 428 429
        return obj;
    }

430 431 432 433 434 435 436 437 438
    return NULL;
}

Object *object_dynamic_cast_assert(Object *obj, const char *typename)
{
    Object *inst;

    inst = object_dynamic_cast(obj, typename);

439
    if (!inst && obj) {
440 441 442 443 444 445 446 447 448 449 450 451 452
        fprintf(stderr, "Object %p is not an instance of type %s\n",
                obj, typename);
        abort();
    }

    return inst;
}

ObjectClass *object_class_dynamic_cast(ObjectClass *class,
                                       const char *typename)
{
    TypeImpl *target_type = type_get_by_name(typename);
    TypeImpl *type = class->type;
A
Anthony Liguori 已提交
453
    ObjectClass *ret = NULL;
454

A
Anthony Liguori 已提交
455 456 457
    if (type->num_interfaces && type_is_ancestor(target_type, type_interface)) {
        int found = 0;
        GSList *i;
458

A
Anthony Liguori 已提交
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
        for (i = class->interfaces; i; i = i->next) {
            ObjectClass *target_class = i->data;

            if (type_is_ancestor(target_class->type, target_type)) {
                ret = target_class;
                found++;
            }
         }

        /* The match was ambiguous, don't allow a cast */
        if (found > 1) {
            ret = NULL;
        }
    } else if (type_is_ancestor(type, target_type)) {
        ret = class;
474 475
    }

A
Anthony Liguori 已提交
476
    return ret;
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
}

ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
                                              const char *typename)
{
    ObjectClass *ret = object_class_dynamic_cast(class, typename);

    if (!ret) {
        fprintf(stderr, "Object %p is not an instance of type %s\n",
                class, typename);
        abort();
    }

    return ret;
}

const char *object_get_typename(Object *obj)
{
    return obj->class->type->name;
}

ObjectClass *object_get_class(Object *obj)
{
    return obj->class;
}

const char *object_class_get_name(ObjectClass *klass)
{
    return klass->type->name;
}

ObjectClass *object_class_by_name(const char *typename)
{
    TypeImpl *type = type_get_by_name(typename);

    if (!type) {
        return NULL;
    }

516
    type_initialize(type);
517 518 519 520

    return type->class;
}

521 522 523 524 525 526 527 528 529 530 531 532 533
ObjectClass *object_class_get_parent(ObjectClass *class)
{
    TypeImpl *type = type_get_parent(class->type);

    if (!type) {
        return NULL;
    }

    type_initialize(type);

    return type->class;
}

534 535 536
typedef struct OCFData
{
    void (*fn)(ObjectClass *klass, void *opaque);
537 538
    const char *implements_type;
    bool include_abstract;
539 540 541 542 543 544 545 546
    void *opaque;
} OCFData;

static void object_class_foreach_tramp(gpointer key, gpointer value,
                                       gpointer opaque)
{
    OCFData *data = opaque;
    TypeImpl *type = value;
547
    ObjectClass *k;
548

549
    type_initialize(type);
550
    k = type->class;
551

552 553 554 555 556 557 558 559 560 561
    if (!data->include_abstract && type->abstract) {
        return;
    }

    if (data->implements_type && 
        !object_class_dynamic_cast(k, data->implements_type)) {
        return;
    }

    data->fn(k, data->opaque);
562 563 564
}

void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
565
                          const char *implements_type, bool include_abstract,
566 567
                          void *opaque)
{
568
    OCFData data = { fn, implements_type, include_abstract, opaque };
569 570 571

    g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
}
572

P
Paolo Bonzini 已提交
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
                         void *opaque)
{
    ObjectProperty *prop;
    int ret = 0;

    QTAILQ_FOREACH(prop, &obj->properties, node) {
        if (object_property_is_child(prop)) {
            ret = fn(prop->opaque, opaque);
            if (ret != 0) {
                break;
            }
        }
    }
    return ret;
}

590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
{
    GSList **list = opaque;

    *list = g_slist_prepend(*list, klass);
}

GSList *object_class_get_list(const char *implements_type,
                              bool include_abstract)
{
    GSList *list = NULL;

    object_class_foreach(object_class_get_list_tramp,
                         implements_type, include_abstract, &list);
    return list;
}

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
void object_ref(Object *obj)
{
    obj->ref++;
}

void object_unref(Object *obj)
{
    g_assert(obj->ref > 0);
    obj->ref--;

    /* parent always holds a reference to its children */
    if (obj->ref == 0) {
        object_finalize(obj);
    }
}

void object_property_add(Object *obj, const char *name, const char *type,
                         ObjectPropertyAccessor *get,
                         ObjectPropertyAccessor *set,
                         ObjectPropertyRelease *release,
                         void *opaque, Error **errp)
{
    ObjectProperty *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(&obj->properties, prop, node);
}

642 643
ObjectProperty *object_property_find(Object *obj, const char *name,
                                     Error **errp)
644 645 646 647 648 649 650 651 652
{
    ObjectProperty *prop;

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

653
    error_set(errp, QERR_PROPERTY_NOT_FOUND, "", name);
654 655 656 657 658
    return NULL;
}

void object_property_del(Object *obj, const char *name, Error **errp)
{
659
    ObjectProperty *prop = object_property_find(obj, name, errp);
A
Anthony Liguori 已提交
660 661 662
    if (prop == NULL) {
        return;
    }
663

A
Anthony Liguori 已提交
664 665 666 667 668
    if (prop->release) {
        prop->release(obj, name, prop->opaque);
    }

    QTAILQ_REMOVE(&obj->properties, prop, node);
669 670 671 672 673 674 675 676 677

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

void object_property_get(Object *obj, Visitor *v, const char *name,
                         Error **errp)
{
678
    ObjectProperty *prop = object_property_find(obj, name, errp);
679 680 681 682 683 684 685 686 687 688 689 690 691 692
    if (prop == NULL) {
        return;
    }

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

void object_property_set(Object *obj, Visitor *v, const char *name,
                         Error **errp)
{
693
    ObjectProperty *prop = object_property_find(obj, name, errp);
694 695 696 697 698 699 700 701 702 703 704
    if (prop == NULL) {
        return;
    }

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

705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
void object_property_set_str(Object *obj, const char *value,
                             const char *name, Error **errp)
{
    QString *qstr = qstring_from_str(value);
    object_property_set_qobject(obj, QOBJECT(qstr), name, errp);

    QDECREF(qstr);
}

char *object_property_get_str(Object *obj, const char *name,
                              Error **errp)
{
    QObject *ret = object_property_get_qobject(obj, name, errp);
    QString *qstring;
    char *retval;

    if (!ret) {
        return NULL;
    }
    qstring = qobject_to_qstring(ret);
    if (!qstring) {
        error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
        retval = NULL;
    } else {
        retval = g_strdup(qstring_get_str(qstring));
    }

    QDECREF(qstring);
    return retval;
}

736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
void object_property_set_link(Object *obj, Object *value,
                              const char *name, Error **errp)
{
    object_property_set_str(obj, object_get_canonical_path(value),
                            name, errp);
}

Object *object_property_get_link(Object *obj, const char *name,
                                 Error **errp)
{
    char *str = object_property_get_str(obj, name, errp);
    Object *target = NULL;

    if (str && *str) {
        target = object_resolve_path(str, NULL);
        if (!target) {
            error_set(errp, QERR_DEVICE_NOT_FOUND, str);
        }
    }

    g_free(str);
    return target;
}

760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
void object_property_set_bool(Object *obj, bool value,
                              const char *name, Error **errp)
{
    QBool *qbool = qbool_from_int(value);
    object_property_set_qobject(obj, QOBJECT(qbool), name, errp);

    QDECREF(qbool);
}

bool object_property_get_bool(Object *obj, const char *name,
                              Error **errp)
{
    QObject *ret = object_property_get_qobject(obj, name, errp);
    QBool *qbool;
    bool retval;

    if (!ret) {
        return false;
    }
    qbool = qobject_to_qbool(ret);
    if (!qbool) {
        error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
        retval = false;
    } else {
        retval = qbool_get_int(qbool);
    }

    QDECREF(qbool);
    return retval;
}

void object_property_set_int(Object *obj, int64_t value,
                             const char *name, Error **errp)
{
    QInt *qint = qint_from_int(value);
    object_property_set_qobject(obj, QOBJECT(qint), name, errp);

    QDECREF(qint);
}

int64_t object_property_get_int(Object *obj, const char *name,
                                Error **errp)
{
    QObject *ret = object_property_get_qobject(obj, name, errp);
    QInt *qint;
    int64_t retval;

    if (!ret) {
        return -1;
    }
    qint = qobject_to_qint(ret);
    if (!qint) {
        error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
        retval = -1;
    } else {
        retval = qint_get_int(qint);
    }

    QDECREF(qint);
    return retval;
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
}

void object_property_parse(Object *obj, const char *string,
                           const char *name, Error **errp)
{
    StringInputVisitor *mi;
    mi = string_input_visitor_new(string);
    object_property_set(obj, string_input_get_visitor(mi), name, errp);

    string_input_visitor_cleanup(mi);
}

char *object_property_print(Object *obj, const char *name,
                            Error **errp)
{
    StringOutputVisitor *mo;
    char *string;

    mo = string_output_visitor_new();
839
    object_property_get(obj, string_output_get_visitor(mo), name, errp);
840 841 842
    string = string_output_get_string(mo);
    string_output_visitor_cleanup(mo);
    return string;
843 844
}

845 846
const char *object_property_get_type(Object *obj, const char *name, Error **errp)
{
847
    ObjectProperty *prop = object_property_find(obj, name, errp);
848 849 850 851 852 853 854 855 856
    if (prop == NULL) {
        return NULL;
    }

    return prop->type;
}

Object *object_get_root(void)
{
857
    static Object *root;
858

859 860
    if (!root) {
        root = object_new("container");
861 862
    }

863
    return root;
864 865 866 867 868 869 870 871 872 873 874 875 876
}

static void object_get_child_property(Object *obj, Visitor *v, void *opaque,
                                      const char *name, Error **errp)
{
    Object *child = opaque;
    gchar *path;

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

877 878 879 880 881 882 883 884
static void object_finalize_child_property(Object *obj, const char *name,
                                           void *opaque)
{
    Object *child = opaque;

    object_unref(child);
}

885 886 887 888 889 890 891 892
void object_property_add_child(Object *obj, const char *name,
                               Object *child, Error **errp)
{
    gchar *type;

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

    object_property_add(obj, name, type, object_get_child_property,
893
                        NULL, object_finalize_child_property, child, errp);
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921

    object_ref(child);
    g_assert(child->parent == NULL);
    child->parent = obj;

    g_free(type);
}

static void object_get_link_property(Object *obj, Visitor *v, void *opaque,
                                     const char *name, Error **errp)
{
    Object **child = opaque;
    gchar *path;

    if (*child) {
        path = object_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 object_set_link_property(Object *obj, Visitor *v, void *opaque,
                                     const char *name, Error **errp)
{
    Object **child = opaque;
922
    Object *old_target;
923 924 925
    bool ambiguous = false;
    const char *type;
    char *path;
926
    gchar *target_type;
927 928 929 930 931

    type = object_property_get_type(obj, name, NULL);

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

932 933
    old_target = *child;
    *child = NULL;
934 935 936 937

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

938 939 940
        /* Go from link<FOO> to FOO.  */
        target_type = g_strndup(&type[5], strlen(type) - 6);
        target = object_resolve_path_type(path, target_type, &ambiguous);
941

942 943 944 945 946
        if (ambiguous) {
            error_set(errp, QERR_AMBIGUOUS_PATH, path);
        } else if (target) {
            object_ref(target);
            *child = target;
947
        } else {
948 949 950 951 952 953
            target = object_resolve_path(path, &ambiguous);
            if (target || ambiguous) {
                error_set(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
            } else {
                error_set(errp, QERR_DEVICE_NOT_FOUND, path);
            }
954
        }
955
        g_free(target_type);
956 957 958
    }

    g_free(path);
959 960 961 962

    if (old_target != NULL) {
        object_unref(old_target);
    }
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
}

void object_property_add_link(Object *obj, const char *name,
                              const char *type, Object **child,
                              Error **errp)
{
    gchar *full_type;

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

    object_property_add(obj, name, full_type,
                        object_get_link_property,
                        object_set_link_property,
                        NULL, child, errp);

    g_free(full_type);
}

gchar *object_get_canonical_path(Object *obj)
{
    Object *root = object_get_root();
    char *newpath = NULL, *path = NULL;

    while (obj != root) {
        ObjectProperty *prop = NULL;

        g_assert(obj->parent != NULL);

        QTAILQ_FOREACH(prop, &obj->parent->properties, node) {
992
            if (!object_property_is_child(prop)) {
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
                continue;
            }

            if (prop->opaque == obj) {
                if (path) {
                    newpath = g_strdup_printf("%s/%s", prop->name, path);
                    g_free(path);
                    path = newpath;
                } else {
                    path = g_strdup(prop->name);
                }
                break;
            }
        }

        g_assert(prop != NULL);

        obj = obj->parent;
    }

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

    return newpath;
}

P
Paolo Bonzini 已提交
1019 1020
Object *object_resolve_path_component(Object *parent, gchar *part)
{
1021
    ObjectProperty *prop = object_property_find(parent, part, NULL);
P
Paolo Bonzini 已提交
1022 1023 1024 1025
    if (prop == NULL) {
        return NULL;
    }

1026
    if (object_property_is_link(prop)) {
P
Paolo Bonzini 已提交
1027
        return *(Object **)prop->opaque;
1028
    } else if (object_property_is_child(prop)) {
P
Paolo Bonzini 已提交
1029 1030 1031 1032 1033 1034
        return prop->opaque;
    } else {
        return NULL;
    }
}

1035 1036
static Object *object_resolve_abs_path(Object *parent,
                                          gchar **parts,
1037
                                          const char *typename,
1038 1039 1040 1041 1042
                                          int index)
{
    Object *child;

    if (parts[index] == NULL) {
1043
        return object_dynamic_cast(parent, typename);
1044 1045 1046
    }

    if (strcmp(parts[index], "") == 0) {
1047
        return object_resolve_abs_path(parent, parts, typename, index + 1);
1048 1049
    }

P
Paolo Bonzini 已提交
1050
    child = object_resolve_path_component(parent, parts[index]);
1051 1052 1053 1054
    if (!child) {
        return NULL;
    }

1055
    return object_resolve_abs_path(child, parts, typename, index + 1);
1056 1057 1058 1059
}

static Object *object_resolve_partial_path(Object *parent,
                                              gchar **parts,
1060
                                              const char *typename,
1061 1062 1063 1064 1065
                                              bool *ambiguous)
{
    Object *obj;
    ObjectProperty *prop;

1066
    obj = object_resolve_abs_path(parent, parts, typename, 0);
1067 1068 1069 1070

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

1071
        if (!object_property_is_child(prop)) {
1072 1073 1074
            continue;
        }

1075 1076
        found = object_resolve_partial_path(prop->opaque, parts,
                                            typename, ambiguous);
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
        if (found) {
            if (obj) {
                if (ambiguous) {
                    *ambiguous = true;
                }
                return NULL;
            }
            obj = found;
        }

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

    return obj;
}

1095 1096
Object *object_resolve_path_type(const char *path, const char *typename,
                                 bool *ambiguous)
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
{
    bool partial_path = true;
    Object *obj;
    gchar **parts;

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

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

    if (partial_path) {
        if (ambiguous) {
            *ambiguous = false;
        }
1116 1117
        obj = object_resolve_partial_path(object_get_root(), parts,
                                          typename, ambiguous);
1118
    } else {
1119
        obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1120 1121 1122 1123 1124 1125 1126
    }

    g_strfreev(parts);

    return obj;
}

1127 1128 1129 1130 1131
Object *object_resolve_path(const char *path, bool *ambiguous)
{
    return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
}

1132 1133 1134 1135 1136 1137
typedef struct StringProperty
{
    char *(*get)(Object *, Error **);
    void (*set)(Object *, const char *, Error **);
} StringProperty;

1138 1139
static void property_get_str(Object *obj, Visitor *v, void *opaque,
                             const char *name, Error **errp)
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
{
    StringProperty *prop = opaque;
    char *value;

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

1151 1152
static void property_set_str(Object *obj, Visitor *v, void *opaque,
                             const char *name, Error **errp)
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
{
    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(obj, value, errp);
    g_free(value);
}

1168 1169
static void property_release_str(Object *obj, const char *name,
                                 void *opaque)
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
{
    StringProperty *prop = opaque;
    g_free(prop);
}

void object_property_add_str(Object *obj, const char *name,
                           char *(*get)(Object *, Error **),
                           void (*set)(Object *, const char *, Error **),
                           Error **errp)
{
    StringProperty *prop = g_malloc0(sizeof(*prop));

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

    object_property_add(obj, name, "string",
1186 1187 1188
                        get ? property_get_str : NULL,
                        set ? property_set_str : NULL,
                        property_release_str,
1189 1190
                        prop, errp);
}
P
Paolo Bonzini 已提交
1191

1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
typedef struct BoolProperty
{
    bool (*get)(Object *, Error **);
    void (*set)(Object *, bool, Error **);
} BoolProperty;

static void property_get_bool(Object *obj, Visitor *v, void *opaque,
                              const char *name, Error **errp)
{
    BoolProperty *prop = opaque;
    bool value;

    value = prop->get(obj, errp);
    visit_type_bool(v, &value, name, errp);
}

static void property_set_bool(Object *obj, Visitor *v, void *opaque,
                              const char *name, Error **errp)
{
    BoolProperty *prop = opaque;
    bool value;
    Error *local_err = NULL;

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

    prop->set(obj, value, errp);
}

static void property_release_bool(Object *obj, const char *name,
                                  void *opaque)
{
    BoolProperty *prop = opaque;
    g_free(prop);
}

void object_property_add_bool(Object *obj, const char *name,
                              bool (*get)(Object *, Error **),
                              void (*set)(Object *, bool, Error **),
                              Error **errp)
{
    BoolProperty *prop = g_malloc0(sizeof(*prop));

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

    object_property_add(obj, name, "bool",
                        get ? property_get_bool : NULL,
                        set ? property_set_bool : NULL,
                        property_release_bool,
                        prop, errp);
}

1248 1249 1250 1251 1252 1253 1254 1255 1256 1257
static char *qdev_get_type(Object *obj, Error **errp)
{
    return g_strdup(object_get_typename(obj));
}

static void object_instance_init(Object *obj)
{
    object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
}

P
Paolo Bonzini 已提交
1258 1259 1260 1261
static void register_types(void)
{
    static TypeInfo interface_info = {
        .name = TYPE_INTERFACE,
A
Anthony Liguori 已提交
1262
        .class_size = sizeof(InterfaceClass),
P
Paolo Bonzini 已提交
1263 1264 1265 1266 1267 1268
        .abstract = true,
    };

    static TypeInfo object_info = {
        .name = TYPE_OBJECT,
        .instance_size = sizeof(Object),
1269
        .instance_init = object_instance_init,
P
Paolo Bonzini 已提交
1270 1271 1272
        .abstract = true,
    };

1273 1274
    type_interface = type_register_internal(&interface_info);
    type_register_internal(&object_info);
P
Paolo Bonzini 已提交
1275 1276 1277
}

type_init(register_types)