object.c 30.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
/*
 * 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.
 */

13
#include "qom/object.h"
14
#include "qemu-common.h"
15
#include "qapi/visitor.h"
16 17
#include "qapi/string-input-visitor.h"
#include "qapi/string-output-visitor.h"
18
#include "qapi/qmp/qerror.h"
19

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

28 29 30 31 32 33 34
#define MAX_INTERFACES 32

typedef struct InterfaceImpl InterfaceImpl;
typedef struct TypeImpl TypeImpl;

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

struct TypeImpl
{
    const char *name;

    size_t class_size;

    size_t instance_size;

    void (*class_init)(ObjectClass *klass, void *data);
P
Paolo Bonzini 已提交
47
    void (*class_base_init)(ObjectClass *klass, void *data);
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
    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];
};

66 67
static Type type_interface;

68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
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);
}

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

    g_assert(info->name != NULL);

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

101 102 103 104 105 106 107
    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 已提交
108
    ti->class_base_init = info->class_base_init;
109 110 111 112 113 114 115 116
    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 已提交
117 118
    for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
        ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
119
    }
A
Anthony Liguori 已提交
120
    ti->num_interfaces = i;
121 122 123 124 125 126

    type_table_add(ti);

    return ti;
}

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

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 174
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);
}

175 176 177 178 179 180 181 182 183 184 185 186 187
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 已提交
188
static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
189
{
A
Anthony Liguori 已提交
190 191 192 193 194 195 196
    assert(target_type);

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

A
Anthony Liguori 已提交
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 224
        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);
225 226
}

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

    if (ti->class) {
        return;
    }

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

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

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

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

        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 已提交
271
    }
272

P
Paolo Bonzini 已提交
273
    ti->class->type = ti;
P
Paolo Bonzini 已提交
274

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

    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);
305
    type_initialize(type);
306 307

    g_assert(type->instance_size >= sizeof(Object));
308 309 310 311
    g_assert(type->abstract == false);

    memset(obj, 0, type->instance_size);
    obj->class = type->class;
312
    object_ref(obj);
313
    QTAILQ_INIT(&obj->properties);
314 315 316 317 318 319 320 321 322 323
    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);
}

324 325 326 327 328 329 330 331 332 333
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);
}

334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
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) {
356
        if (object_property_is_child(prop) && prop->opaque == child) {
357
            object_property_del(obj, prop->name, errp);
P
Paolo Bonzini 已提交
358
            break;
359 360 361 362 363 364
        }
    }
}

void object_unparent(Object *obj)
{
365 366 367 368
    if (!obj->parent) {
        return;
    }

369
    object_ref(obj);
370 371 372
    if (obj->class->unparent) {
        (obj->class->unparent)(obj);
    }
373 374 375
    if (obj->parent) {
        object_property_del_child(obj->parent, obj, NULL);
    }
376
    object_unref(obj);
377 378
}

379 380 381 382 383 384 385 386 387 388 389
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));
    }
}

P
Paolo Bonzini 已提交
390
static void object_finalize(void *data)
391 392 393 394 395
{
    Object *obj = data;
    TypeImpl *ti = obj->class->type;

    object_deinit(obj, ti);
396
    object_property_del_all(obj);
397 398

    g_assert(obj->ref == 0);
399 400 401
    if (obj->free) {
        obj->free(obj);
    }
402 403 404 405 406 407 408
}

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

    g_assert(type != NULL);
409
    type_initialize(type);
410 411 412

    obj = g_malloc(type->instance_size);
    object_initialize_with_type(obj, type);
413
    obj->free = g_free;
414 415 416 417 418 419 420 421 422 423 424 425 426

    return obj;
}

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

    return object_new_with_type(ti);
}

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

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

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

    inst = object_dynamic_cast(obj, typename);

440
    if (!inst && obj) {
441 442 443 444 445 446 447 448 449 450 451 452 453
        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 已提交
454
    ObjectClass *ret = NULL;
455

456 457 458 459 460
    if (!target_type) {
        /* target class type unknown, so fail the cast */
        return NULL;
    }

461 462
    if (type->class->interfaces &&
            type_is_ancestor(target_type, type_interface)) {
A
Anthony Liguori 已提交
463 464
        int found = 0;
        GSList *i;
465

A
Anthony Liguori 已提交
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
        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;
481 482
    }

A
Anthony Liguori 已提交
483
    return ret;
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
}

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;
}

510 511 512 513 514
bool object_class_is_abstract(ObjectClass *klass)
{
    return klass->type->abstract;
}

515 516 517 518 519 520 521 522 523 524 525 526 527
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;
    }

528
    type_initialize(type);
529 530 531 532

    return type->class;
}

533 534 535 536 537 538 539 540 541 542 543 544 545
ObjectClass *object_class_get_parent(ObjectClass *class)
{
    TypeImpl *type = type_get_parent(class->type);

    if (!type) {
        return NULL;
    }

    type_initialize(type);

    return type->class;
}

546 547 548
typedef struct OCFData
{
    void (*fn)(ObjectClass *klass, void *opaque);
549 550
    const char *implements_type;
    bool include_abstract;
551 552 553 554 555 556 557 558
    void *opaque;
} OCFData;

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

561
    type_initialize(type);
562
    k = type->class;
563

564 565 566 567 568 569 570 571 572 573
    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);
574 575 576
}

void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
577
                          const char *implements_type, bool include_abstract,
578 579
                          void *opaque)
{
580
    OCFData data = { fn, implements_type, include_abstract, opaque };
581 582 583

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

P
Paolo Bonzini 已提交
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601
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;
}

602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
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;
}

619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640
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)
{
641 642 643 644 645 646 647 648 649 650 651 652
    ObjectProperty *prop;

    QTAILQ_FOREACH(prop, &obj->properties, node) {
        if (strcmp(prop->name, name) == 0) {
            error_setg(errp, "attempt to add duplicate property '%s'"
                       " to object (type '%s')", name,
                       object_get_typename(obj));
            return;
        }
    }

    prop = g_malloc0(sizeof(*prop));
653 654 655 656 657 658 659 660 661 662 663 664

    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);
}

665 666
ObjectProperty *object_property_find(Object *obj, const char *name,
                                     Error **errp)
667 668 669 670 671 672 673 674 675
{
    ObjectProperty *prop;

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

676
    error_set(errp, QERR_PROPERTY_NOT_FOUND, "", name);
677 678 679 680 681
    return NULL;
}

void object_property_del(Object *obj, const char *name, Error **errp)
{
682
    ObjectProperty *prop = object_property_find(obj, name, errp);
A
Anthony Liguori 已提交
683 684 685
    if (prop == NULL) {
        return;
    }
686

A
Anthony Liguori 已提交
687 688 689 690 691
    if (prop->release) {
        prop->release(obj, name, prop->opaque);
    }

    QTAILQ_REMOVE(&obj->properties, prop, node);
692 693 694 695 696 697 698 699 700

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

void object_property_get(Object *obj, Visitor *v, const char *name,
                         Error **errp)
{
701
    ObjectProperty *prop = object_property_find(obj, name, errp);
702 703 704 705 706 707 708 709 710 711 712 713 714 715
    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)
{
716
    ObjectProperty *prop = object_property_find(obj, name, errp);
717 718 719 720 721 722 723 724 725 726 727
    if (prop == NULL) {
        return;
    }

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

728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
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;
}

759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782
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;
}

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 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
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;
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
}

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();
862
    object_property_get(obj, string_output_get_visitor(mo), name, errp);
863 864 865
    string = string_output_get_string(mo);
    string_output_visitor_cleanup(mo);
    return string;
866 867
}

868 869
const char *object_property_get_type(Object *obj, const char *name, Error **errp)
{
870
    ObjectProperty *prop = object_property_find(obj, name, errp);
871 872 873 874 875 876 877 878 879
    if (prop == NULL) {
        return NULL;
    }

    return prop->type;
}

Object *object_get_root(void)
{
880
    static Object *root;
881

882 883
    if (!root) {
        root = object_new("container");
884 885
    }

886
    return root;
887 888 889 890 891 892 893 894 895 896 897 898 899
}

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);
}

900 901 902 903 904 905 906 907
static void object_finalize_child_property(Object *obj, const char *name,
                                           void *opaque)
{
    Object *child = opaque;

    object_unref(child);
}

908 909 910 911 912 913 914 915
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,
916
                        NULL, object_finalize_child_property, child, errp);
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

    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;
945
    Object *old_target;
946 947 948
    bool ambiguous = false;
    const char *type;
    char *path;
949
    gchar *target_type;
950 951 952 953 954

    type = object_property_get_type(obj, name, NULL);

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

955 956
    old_target = *child;
    *child = NULL;
957 958 959 960

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

961 962 963
        /* Go from link<FOO> to FOO.  */
        target_type = g_strndup(&type[5], strlen(type) - 6);
        target = object_resolve_path_type(path, target_type, &ambiguous);
964

965 966 967 968 969
        if (ambiguous) {
            error_set(errp, QERR_AMBIGUOUS_PATH, path);
        } else if (target) {
            object_ref(target);
            *child = target;
970
        } else {
971 972 973 974 975 976
            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);
            }
977
        }
978
        g_free(target_type);
979 980 981
    }

    g_free(path);
982 983 984 985

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

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) {
1015
            if (!object_property_is_child(prop)) {
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
                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;
}

1042
Object *object_resolve_path_component(Object *parent, const gchar *part)
P
Paolo Bonzini 已提交
1043
{
1044
    ObjectProperty *prop = object_property_find(parent, part, NULL);
P
Paolo Bonzini 已提交
1045 1046 1047 1048
    if (prop == NULL) {
        return NULL;
    }

1049
    if (object_property_is_link(prop)) {
P
Paolo Bonzini 已提交
1050
        return *(Object **)prop->opaque;
1051
    } else if (object_property_is_child(prop)) {
P
Paolo Bonzini 已提交
1052 1053 1054 1055 1056 1057
        return prop->opaque;
    } else {
        return NULL;
    }
}

1058 1059
static Object *object_resolve_abs_path(Object *parent,
                                          gchar **parts,
1060
                                          const char *typename,
1061 1062 1063 1064 1065
                                          int index)
{
    Object *child;

    if (parts[index] == NULL) {
1066
        return object_dynamic_cast(parent, typename);
1067 1068 1069
    }

    if (strcmp(parts[index], "") == 0) {
1070
        return object_resolve_abs_path(parent, parts, typename, index + 1);
1071 1072
    }

P
Paolo Bonzini 已提交
1073
    child = object_resolve_path_component(parent, parts[index]);
1074 1075 1076 1077
    if (!child) {
        return NULL;
    }

1078
    return object_resolve_abs_path(child, parts, typename, index + 1);
1079 1080 1081 1082
}

static Object *object_resolve_partial_path(Object *parent,
                                              gchar **parts,
1083
                                              const char *typename,
1084 1085 1086 1087 1088
                                              bool *ambiguous)
{
    Object *obj;
    ObjectProperty *prop;

1089
    obj = object_resolve_abs_path(parent, parts, typename, 0);
1090 1091 1092 1093

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

1094
        if (!object_property_is_child(prop)) {
1095 1096 1097
            continue;
        }

1098 1099
        found = object_resolve_partial_path(prop->opaque, parts,
                                            typename, ambiguous);
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117
        if (found) {
            if (obj) {
                if (ambiguous) {
                    *ambiguous = true;
                }
                return NULL;
            }
            obj = found;
        }

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

    return obj;
}

1118 1119
Object *object_resolve_path_type(const char *path, const char *typename,
                                 bool *ambiguous)
1120 1121 1122 1123 1124
{
    Object *obj;
    gchar **parts;

    parts = g_strsplit(path, "/", 0);
1125
    assert(parts);
1126

1127
    if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
1128 1129 1130
        if (ambiguous) {
            *ambiguous = false;
        }
1131 1132
        obj = object_resolve_partial_path(object_get_root(), parts,
                                          typename, ambiguous);
1133
    } else {
1134
        obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1135 1136 1137 1138 1139 1140 1141
    }

    g_strfreev(parts);

    return obj;
}

1142 1143 1144 1145 1146
Object *object_resolve_path(const char *path, bool *ambiguous)
{
    return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
}

1147 1148 1149 1150 1151 1152
typedef struct StringProperty
{
    char *(*get)(Object *, Error **);
    void (*set)(Object *, const char *, Error **);
} StringProperty;

1153 1154
static void property_get_str(Object *obj, Visitor *v, void *opaque,
                             const char *name, Error **errp)
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
{
    StringProperty *prop = opaque;
    char *value;

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

1166 1167
static void property_set_str(Object *obj, Visitor *v, void *opaque,
                             const char *name, Error **errp)
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
{
    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);
}

1183 1184
static void property_release_str(Object *obj, const char *name,
                                 void *opaque)
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
{
    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",
1201 1202 1203
                        get ? property_get_str : NULL,
                        set ? property_set_str : NULL,
                        property_release_str,
1204 1205
                        prop, errp);
}
P
Paolo Bonzini 已提交
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 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
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);
}

1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
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 已提交
1273 1274 1275 1276
static void register_types(void)
{
    static TypeInfo interface_info = {
        .name = TYPE_INTERFACE,
A
Anthony Liguori 已提交
1277
        .class_size = sizeof(InterfaceClass),
P
Paolo Bonzini 已提交
1278 1279 1280 1281 1282 1283
        .abstract = true,
    };

    static TypeInfo object_info = {
        .name = TYPE_OBJECT,
        .instance_size = sizeof(Object),
1284
        .instance_init = object_instance_init,
P
Paolo Bonzini 已提交
1285 1286 1287
        .abstract = true,
    };

1288 1289
    type_interface = type_register_internal(&interface_info);
    type_register_internal(&object_info);
P
Paolo Bonzini 已提交
1290 1291 1292
}

type_init(register_types)