object.c 35.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"
P
Paolo Bonzini 已提交
19
#include "trace.h"
20

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

29 30 31 32 33 34 35
#define MAX_INTERFACES 32

typedef struct InterfaceImpl InterfaceImpl;
typedef struct TypeImpl TypeImpl;

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

struct TypeImpl
{
    const char *name;

    size_t class_size;

    size_t instance_size;

    void (*class_init)(ObjectClass *klass, void *data);
P
Paolo Bonzini 已提交
48
    void (*class_base_init)(ObjectClass *klass, void *data);
49 50 51 52 53
    void (*class_finalize)(ObjectClass *klass, void *data);

    void *class_data;

    void (*instance_init)(Object *obj);
54
    void (*instance_post_init)(Object *obj);
55 56 57 58 59 60 61 62 63 64 65 66 67
    void (*instance_finalize)(Object *obj);

    bool abstract;

    const char *parent;
    TypeImpl *parent_type;

    ObjectClass *class;

    int num_interfaces;
    InterfaceImpl interfaces[MAX_INTERFACES];
};

68 69
static Type type_interface;

70 71 72 73 74 75 76 77 78 79 80
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;
}

81 82
static bool enumerating_types;

83 84
static void type_table_add(TypeImpl *ti)
{
85
    assert(!enumerating_types);
86 87 88 89 90 91 92 93
    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);
}

94
static TypeImpl *type_new(const TypeInfo *info)
95 96
{
    TypeImpl *ti = g_malloc0(sizeof(*ti));
A
Anthony Liguori 已提交
97
    int i;
98 99 100

    g_assert(info->name != NULL);

101 102 103 104 105
    if (type_table_lookup(info->name) != NULL) {
        fprintf(stderr, "Registering `%s' which already exists\n", info->name);
        abort();
    }

106 107 108 109 110 111 112
    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 已提交
113
    ti->class_base_init = info->class_base_init;
114 115 116 117
    ti->class_finalize = info->class_finalize;
    ti->class_data = info->class_data;

    ti->instance_init = info->instance_init;
118
    ti->instance_post_init = info->instance_post_init;
119 120 121 122
    ti->instance_finalize = info->instance_finalize;

    ti->abstract = info->abstract;

A
Anthony Liguori 已提交
123 124
    for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
        ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
125
    }
A
Anthony Liguori 已提交
126
    ti->num_interfaces = i;
127

128 129
    return ti;
}
130

131 132 133 134 135 136
static TypeImpl *type_register_internal(const TypeInfo *info)
{
    TypeImpl *ti;
    ti = type_new(info);

    type_table_add(ti);
137 138 139
    return ti;
}

140 141 142 143 144 145
TypeImpl *type_register(const TypeInfo *info)
{
    assert(info->parent);
    return type_register_internal(info);
}

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 175 176 177 178 179 180 181 182 183 184 185 186 187
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);
}

188 189 190 191 192 193 194 195 196 197 198 199 200
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 已提交
201
static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
202
{
A
Anthony Liguori 已提交
203 204 205 206 207 208 209
    assert(target_type);

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

A
Anthony Liguori 已提交
211 212 213 214 215 216 217 218
        type = type_get_parent(type);
    }

    return false;
}

static void type_initialize(TypeImpl *ti);

219 220
static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type,
                                      TypeImpl *parent_type)
A
Anthony Liguori 已提交
221 222 223 224 225
{
    InterfaceClass *new_iface;
    TypeInfo info = { };
    TypeImpl *iface_impl;

226 227
    info.parent = parent_type->name;
    info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name);
A
Anthony Liguori 已提交
228 229
    info.abstract = true;

230 231
    iface_impl = type_new(&info);
    iface_impl->parent_type = parent_type;
A
Anthony Liguori 已提交
232 233 234 235 236
    type_initialize(iface_impl);
    g_free((char *)info.name);

    new_iface = (InterfaceClass *)iface_impl->class;
    new_iface->concrete_class = ti->class;
237
    new_iface->interface_type = interface_type;
A
Anthony Liguori 已提交
238 239 240

    ti->class->interfaces = g_slist_append(ti->class->interfaces,
                                           iface_impl->class);
241 242
}

243
static void type_initialize(TypeImpl *ti)
244
{
P
Paolo Bonzini 已提交
245
    TypeImpl *parent;
246 247 248 249 250 251

    if (ti->class) {
        return;
    }

    ti->class_size = type_class_get_size(ti);
252
    ti->instance_size = type_object_get_size(ti);
253 254 255

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

P
Paolo Bonzini 已提交
256 257
    parent = type_get_parent(ti);
    if (parent) {
258
        type_initialize(parent);
A
Anthony Liguori 已提交
259 260
        GSList *e;
        int i;
261 262

        g_assert(parent->class_size <= ti->class_size);
P
Paolo Bonzini 已提交
263
        memcpy(ti->class, parent->class, parent->class_size);
264
        ti->class->interfaces = NULL;
A
Anthony Liguori 已提交
265 266

        for (e = parent->class->interfaces; e; e = e->next) {
267 268 269 270
            InterfaceClass *iface = e->data;
            ObjectClass *klass = OBJECT_CLASS(iface);

            type_initialize_interface(ti, iface->interface_type, klass->type);
A
Anthony Liguori 已提交
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286
        }

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

287
            type_initialize_interface(ti, t, t);
A
Anthony Liguori 已提交
288
        }
P
Paolo Bonzini 已提交
289
    }
290

P
Paolo Bonzini 已提交
291
    ti->class->type = ti;
P
Paolo Bonzini 已提交
292

P
Paolo Bonzini 已提交
293 294 295
    while (parent) {
        if (parent->class_base_init) {
            parent->class_base_init(ti->class, ti->class_data);
P
Paolo Bonzini 已提交
296
        }
P
Paolo Bonzini 已提交
297
        parent = type_get_parent(parent);
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
    }

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

316 317 318 319 320 321 322 323 324 325 326
static void object_post_init_with_type(Object *obj, TypeImpl *ti)
{
    if (ti->instance_post_init) {
        ti->instance_post_init(obj);
    }

    if (type_has_parent(ti)) {
        object_post_init_with_type(obj, type_get_parent(ti));
    }
}

327
void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
328 329 330 331
{
    Object *obj = data;

    g_assert(type != NULL);
332
    type_initialize(type);
333 334

    g_assert(type->instance_size >= sizeof(Object));
335
    g_assert(type->abstract == false);
336
    g_assert(size >= type->instance_size);
337 338 339

    memset(obj, 0, type->instance_size);
    obj->class = type->class;
340
    object_ref(obj);
341
    QTAILQ_INIT(&obj->properties);
342
    object_init_with_type(obj, type);
343
    object_post_init_with_type(obj, type);
344 345
}

346
void object_initialize(void *data, size_t size, const char *typename)
347 348 349
{
    TypeImpl *type = type_get_by_name(typename);

350
    object_initialize_with_type(data, size, type);
351 352
}

353 354 355 356 357 358 359 360 361 362
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);
}

363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
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) {
385
        if (object_property_is_child(prop) && prop->opaque == child) {
386
            object_property_del(obj, prop->name, errp);
P
Paolo Bonzini 已提交
387
            break;
388 389 390 391 392 393
        }
    }
}

void object_unparent(Object *obj)
{
394 395 396 397
    if (!obj->parent) {
        return;
    }

398
    object_ref(obj);
399 400 401
    if (obj->class->unparent) {
        (obj->class->unparent)(obj);
    }
402 403 404
    if (obj->parent) {
        object_property_del_child(obj->parent, obj, NULL);
    }
405
    object_unref(obj);
406 407
}

408 409 410 411 412 413 414 415 416 417 418
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 已提交
419
static void object_finalize(void *data)
420 421 422 423 424
{
    Object *obj = data;
    TypeImpl *ti = obj->class->type;

    object_deinit(obj, ti);
425
    object_property_del_all(obj);
426 427

    g_assert(obj->ref == 0);
428 429 430
    if (obj->free) {
        obj->free(obj);
    }
431 432 433 434 435 436 437
}

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

    g_assert(type != NULL);
438
    type_initialize(type);
439 440

    obj = g_malloc(type->instance_size);
441
    object_initialize_with_type(obj, type->instance_size, type);
442
    obj->free = g_free;
443 444 445 446 447 448 449 450 451 452 453 454 455

    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)
{
456
    if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
457 458 459
        return obj;
    }

460 461 462
    return NULL;
}

463 464
Object *object_dynamic_cast_assert(Object *obj, const char *typename,
                                   const char *file, int line, const char *func)
465
{
P
Paolo Bonzini 已提交
466 467 468
    trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
                                     typename, file, line, func);

469
#ifdef CONFIG_QOM_CAST_DEBUG
470 471 472
    int i;
    Object *inst;

473
    for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
474
        if (obj->class->object_cast_cache[i] == typename) {
475 476 477 478 479
            goto out;
        }
    }

    inst = object_dynamic_cast(obj, typename);
480

481
    if (!inst && obj) {
482 483
        fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
                file, line, func, obj, typename);
484 485 486
        abort();
    }

487
    assert(obj == inst);
488

489
    if (obj && obj == inst) {
490
        for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
491 492
            obj->class->object_cast_cache[i - 1] =
                    obj->class->object_cast_cache[i];
493
        }
494
        obj->class->object_cast_cache[i - 1] = typename;
495 496 497
    }

out:
498 499
#endif
    return obj;
500 501 502 503 504
}

ObjectClass *object_class_dynamic_cast(ObjectClass *class,
                                       const char *typename)
{
A
Anthony Liguori 已提交
505
    ObjectClass *ret = NULL;
506 507
    TypeImpl *target_type;
    TypeImpl *type;
508

509 510 511 512
    if (!class) {
        return NULL;
    }

513
    /* A simple fast path that can trigger a lot for leaf classes.  */
514
    type = class->type;
515 516 517 518
    if (type->name == typename) {
        return class;
    }

519
    target_type = type_get_by_name(typename);
520 521 522 523 524
    if (!target_type) {
        /* target class type unknown, so fail the cast */
        return NULL;
    }

525 526
    if (type->class->interfaces &&
            type_is_ancestor(target_type, type_interface)) {
A
Anthony Liguori 已提交
527 528
        int found = 0;
        GSList *i;
529

A
Anthony Liguori 已提交
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
        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;
545 546
    }

A
Anthony Liguori 已提交
547
    return ret;
548 549 550
}

ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
551 552 553
                                              const char *typename,
                                              const char *file, int line,
                                              const char *func)
554
{
P
Paolo Bonzini 已提交
555 556 557 558
    ObjectClass *ret;

    trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
                                           typename, file, line, func);
559

560 561 562
#ifdef CONFIG_QOM_CAST_DEBUG
    int i;

563
    for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
564
        if (class->class_cast_cache[i] == typename) {
565 566 567 568 569
            ret = class;
            goto out;
        }
    }
#else
570
    if (!class || !class->interfaces) {
571 572 573 574
        return class;
    }
#endif

P
Paolo Bonzini 已提交
575
    ret = object_class_dynamic_cast(class, typename);
576
    if (!ret && class) {
577 578
        fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
                file, line, func, class, typename);
579 580 581
        abort();
    }

582
#ifdef CONFIG_QOM_CAST_DEBUG
583
    if (class && ret == class) {
584
        for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
585
            class->class_cast_cache[i - 1] = class->class_cast_cache[i];
586
        }
587
        class->class_cast_cache[i - 1] = typename;
588 589 590
    }
out:
#endif
591 592 593 594 595 596 597 598 599 600 601 602 603
    return ret;
}

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

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

604 605 606 607 608
bool object_class_is_abstract(ObjectClass *klass)
{
    return klass->type->abstract;
}

609 610 611 612 613 614 615 616 617 618 619 620 621
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;
    }

622
    type_initialize(type);
623 624 625 626

    return type->class;
}

627 628 629 630 631 632 633 634 635 636 637 638 639
ObjectClass *object_class_get_parent(ObjectClass *class)
{
    TypeImpl *type = type_get_parent(class->type);

    if (!type) {
        return NULL;
    }

    type_initialize(type);

    return type->class;
}

640 641 642
typedef struct OCFData
{
    void (*fn)(ObjectClass *klass, void *opaque);
643 644
    const char *implements_type;
    bool include_abstract;
645 646 647 648 649 650 651 652
    void *opaque;
} OCFData;

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

655
    type_initialize(type);
656
    k = type->class;
657

658 659 660 661 662 663 664 665 666 667
    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);
668 669 670
}

void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
671
                          const char *implements_type, bool include_abstract,
672 673
                          void *opaque)
{
674
    OCFData data = { fn, implements_type, include_abstract, opaque };
675

676
    enumerating_types = true;
677
    g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
678
    enumerating_types = false;
679
}
680

P
Paolo Bonzini 已提交
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
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;
}

698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
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;
}

715 716
void object_ref(Object *obj)
{
717
     atomic_inc(&obj->ref);
718 719 720 721 722 723 724
}

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

    /* parent always holds a reference to its children */
725
    if (atomic_fetch_dec(&obj->ref) == 1) {
726 727 728 729 730 731 732 733 734 735
        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)
{
736 737 738 739 740 741 742 743 744 745 746 747
    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));
748 749 750 751 752 753 754 755 756 757 758 759

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

760 761
ObjectProperty *object_property_find(Object *obj, const char *name,
                                     Error **errp)
762 763 764 765 766 767 768 769 770
{
    ObjectProperty *prop;

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

771
    error_set(errp, QERR_PROPERTY_NOT_FOUND, "", name);
772 773 774 775 776
    return NULL;
}

void object_property_del(Object *obj, const char *name, Error **errp)
{
777
    ObjectProperty *prop = object_property_find(obj, name, errp);
A
Anthony Liguori 已提交
778 779 780
    if (prop == NULL) {
        return;
    }
781

A
Anthony Liguori 已提交
782 783 784 785 786
    if (prop->release) {
        prop->release(obj, name, prop->opaque);
    }

    QTAILQ_REMOVE(&obj->properties, prop, node);
787 788 789 790 791 792 793 794 795

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

void object_property_get(Object *obj, Visitor *v, const char *name,
                         Error **errp)
{
796
    ObjectProperty *prop = object_property_find(obj, name, errp);
797 798 799 800 801 802 803 804 805 806 807 808 809 810
    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)
{
811
    ObjectProperty *prop = object_property_find(obj, name, errp);
812 813 814 815 816 817 818 819 820 821 822
    if (prop == NULL) {
        return;
    }

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

823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
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;
}

854 855 856
void object_property_set_link(Object *obj, Object *value,
                              const char *name, Error **errp)
{
857 858 859
    gchar *path = object_get_canonical_path(value);
    object_property_set_str(obj, path, name, errp);
    g_free(path);
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
}

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

879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 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 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
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;
939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
}

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();
958
    object_property_get(obj, string_output_get_visitor(mo), name, errp);
959 960 961
    string = string_output_get_string(mo);
    string_output_visitor_cleanup(mo);
    return string;
962 963
}

964 965
const char *object_property_get_type(Object *obj, const char *name, Error **errp)
{
966
    ObjectProperty *prop = object_property_find(obj, name, errp);
967 968 969 970 971 972 973 974 975
    if (prop == NULL) {
        return NULL;
    }

    return prop->type;
}

Object *object_get_root(void)
{
976
    static Object *root;
977

978 979
    if (!root) {
        root = object_new("container");
980 981
    }

982
    return root;
983 984 985 986 987 988 989 990 991 992 993 994 995
}

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

996 997 998 999 1000 1001 1002 1003
static void object_finalize_child_property(Object *obj, const char *name,
                                           void *opaque)
{
    Object *child = opaque;

    object_unref(child);
}

1004 1005 1006
void object_property_add_child(Object *obj, const char *name,
                               Object *child, Error **errp)
{
1007
    Error *local_err = NULL;
1008 1009 1010 1011
    gchar *type;

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

1012 1013 1014 1015 1016 1017
    object_property_add(obj, name, type, object_get_child_property, NULL,
                        object_finalize_child_property, child, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        goto out;
    }
1018 1019 1020 1021
    object_ref(child);
    g_assert(child->parent == NULL);
    child->parent = obj;

1022
out:
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
    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;
1046
    Object *old_target;
1047 1048 1049
    bool ambiguous = false;
    const char *type;
    char *path;
1050
    gchar *target_type;
1051 1052 1053 1054 1055

    type = object_property_get_type(obj, name, NULL);

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

1056 1057
    old_target = *child;
    *child = NULL;
1058 1059 1060 1061

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

1062 1063 1064
        /* Go from link<FOO> to FOO.  */
        target_type = g_strndup(&type[5], strlen(type) - 6);
        target = object_resolve_path_type(path, target_type, &ambiguous);
1065

1066 1067 1068 1069 1070
        if (ambiguous) {
            error_set(errp, QERR_AMBIGUOUS_PATH, path);
        } else if (target) {
            object_ref(target);
            *child = target;
1071
        } else {
1072 1073 1074 1075 1076 1077
            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);
            }
1078
        }
1079
        g_free(target_type);
1080 1081 1082
    }

    g_free(path);
1083 1084 1085 1086

    if (old_target != NULL) {
        object_unref(old_target);
    }
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115
}

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) {
1116
            if (!object_property_is_child(prop)) {
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
                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;
}

1143
Object *object_resolve_path_component(Object *parent, const gchar *part)
P
Paolo Bonzini 已提交
1144
{
1145
    ObjectProperty *prop = object_property_find(parent, part, NULL);
P
Paolo Bonzini 已提交
1146 1147 1148 1149
    if (prop == NULL) {
        return NULL;
    }

1150
    if (object_property_is_link(prop)) {
P
Paolo Bonzini 已提交
1151
        return *(Object **)prop->opaque;
1152
    } else if (object_property_is_child(prop)) {
P
Paolo Bonzini 已提交
1153 1154 1155 1156 1157 1158
        return prop->opaque;
    } else {
        return NULL;
    }
}

1159 1160
static Object *object_resolve_abs_path(Object *parent,
                                          gchar **parts,
1161
                                          const char *typename,
1162 1163 1164 1165 1166
                                          int index)
{
    Object *child;

    if (parts[index] == NULL) {
1167
        return object_dynamic_cast(parent, typename);
1168 1169 1170
    }

    if (strcmp(parts[index], "") == 0) {
1171
        return object_resolve_abs_path(parent, parts, typename, index + 1);
1172 1173
    }

P
Paolo Bonzini 已提交
1174
    child = object_resolve_path_component(parent, parts[index]);
1175 1176 1177 1178
    if (!child) {
        return NULL;
    }

1179
    return object_resolve_abs_path(child, parts, typename, index + 1);
1180 1181 1182 1183
}

static Object *object_resolve_partial_path(Object *parent,
                                              gchar **parts,
1184
                                              const char *typename,
1185 1186 1187 1188 1189
                                              bool *ambiguous)
{
    Object *obj;
    ObjectProperty *prop;

1190
    obj = object_resolve_abs_path(parent, parts, typename, 0);
1191 1192 1193 1194

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

1195
        if (!object_property_is_child(prop)) {
1196 1197 1198
            continue;
        }

1199 1200
        found = object_resolve_partial_path(prop->opaque, parts,
                                            typename, ambiguous);
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
        if (found) {
            if (obj) {
                if (ambiguous) {
                    *ambiguous = true;
                }
                return NULL;
            }
            obj = found;
        }

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

    return obj;
}

1219 1220
Object *object_resolve_path_type(const char *path, const char *typename,
                                 bool *ambiguous)
1221 1222 1223 1224 1225
{
    Object *obj;
    gchar **parts;

    parts = g_strsplit(path, "/", 0);
1226
    assert(parts);
1227

1228
    if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
1229 1230 1231
        if (ambiguous) {
            *ambiguous = false;
        }
1232 1233
        obj = object_resolve_partial_path(object_get_root(), parts,
                                          typename, ambiguous);
1234
    } else {
1235
        obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1236 1237 1238 1239 1240 1241 1242
    }

    g_strfreev(parts);

    return obj;
}

1243 1244 1245 1246 1247
Object *object_resolve_path(const char *path, bool *ambiguous)
{
    return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
}

1248 1249 1250 1251 1252 1253
typedef struct StringProperty
{
    char *(*get)(Object *, Error **);
    void (*set)(Object *, const char *, Error **);
} StringProperty;

1254 1255
static void property_get_str(Object *obj, Visitor *v, void *opaque,
                             const char *name, Error **errp)
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
{
    StringProperty *prop = opaque;
    char *value;

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

1267 1268
static void property_set_str(Object *obj, Visitor *v, void *opaque,
                             const char *name, Error **errp)
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283
{
    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);
}

1284 1285
static void property_release_str(Object *obj, const char *name,
                                 void *opaque)
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
{
    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",
1302 1303 1304
                        get ? property_get_str : NULL,
                        set ? property_set_str : NULL,
                        property_release_str,
1305 1306
                        prop, errp);
}
P
Paolo Bonzini 已提交
1307

1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
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);
}

1364 1365 1366 1367 1368
static char *qdev_get_type(Object *obj, Error **errp)
{
    return g_strdup(object_get_typename(obj));
}

1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428
static void property_get_uint8_ptr(Object *obj, Visitor *v,
                                   void *opaque, const char *name,
                                   Error **errp)
{
    uint8_t value = *(uint8_t *)opaque;
    visit_type_uint8(v, &value, name, errp);
}

static void property_get_uint16_ptr(Object *obj, Visitor *v,
                                   void *opaque, const char *name,
                                   Error **errp)
{
    uint16_t value = *(uint16_t *)opaque;
    visit_type_uint16(v, &value, name, errp);
}

static void property_get_uint32_ptr(Object *obj, Visitor *v,
                                   void *opaque, const char *name,
                                   Error **errp)
{
    uint32_t value = *(uint32_t *)opaque;
    visit_type_uint32(v, &value, name, errp);
}

static void property_get_uint64_ptr(Object *obj, Visitor *v,
                                   void *opaque, const char *name,
                                   Error **errp)
{
    uint64_t value = *(uint64_t *)opaque;
    visit_type_uint64(v, &value, name, errp);
}

void object_property_add_uint8_ptr(Object *obj, const char *name,
                                   const uint8_t *v, Error **errp)
{
    object_property_add(obj, name, "uint8", property_get_uint8_ptr,
                        NULL, NULL, (void *)v, errp);
}

void object_property_add_uint16_ptr(Object *obj, const char *name,
                                    const uint16_t *v, Error **errp)
{
    object_property_add(obj, name, "uint16", property_get_uint16_ptr,
                        NULL, NULL, (void *)v, errp);
}

void object_property_add_uint32_ptr(Object *obj, const char *name,
                                    const uint32_t *v, Error **errp)
{
    object_property_add(obj, name, "uint32", property_get_uint32_ptr,
                        NULL, NULL, (void *)v, errp);
}

void object_property_add_uint64_ptr(Object *obj, const char *name,
                                    const uint64_t *v, Error **errp)
{
    object_property_add(obj, name, "uint64", property_get_uint64_ptr,
                        NULL, NULL, (void *)v, errp);
}

1429 1430 1431 1432 1433
static void object_instance_init(Object *obj)
{
    object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
}

P
Paolo Bonzini 已提交
1434 1435 1436 1437
static void register_types(void)
{
    static TypeInfo interface_info = {
        .name = TYPE_INTERFACE,
A
Anthony Liguori 已提交
1438
        .class_size = sizeof(InterfaceClass),
P
Paolo Bonzini 已提交
1439 1440 1441 1442 1443 1444
        .abstract = true,
    };

    static TypeInfo object_info = {
        .name = TYPE_OBJECT,
        .instance_size = sizeof(Object),
1445
        .instance_init = object_instance_init,
P
Paolo Bonzini 已提交
1446 1447 1448
        .abstract = true,
    };

1449 1450
    type_interface = type_register_internal(&interface_info);
    type_register_internal(&object_info);
P
Paolo Bonzini 已提交
1451 1452 1453
}

type_init(register_types)