object.c 59.5 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.
 */

P
Peter Maydell 已提交
13
#include "qemu/osdep.h"
14
#include "qapi/error.h"
15
#include "qom/object.h"
16
#include "qom/object_interfaces.h"
17
#include "qemu/cutils.h"
18
#include "qapi/visitor.h"
19
#include "qapi-visit.h"
20 21
#include "qapi/string-input-visitor.h"
#include "qapi/string-output-visitor.h"
22
#include "qapi/qmp/qerror.h"
P
Paolo Bonzini 已提交
23
#include "trace.h"
24

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

33 34 35 36 37 38 39
#define MAX_INTERFACES 32

typedef struct InterfaceImpl InterfaceImpl;
typedef struct TypeImpl TypeImpl;

struct InterfaceImpl
{
A
Anthony Liguori 已提交
40
    const char *typename;
41 42 43 44 45 46 47 48 49 50 51
};

struct TypeImpl
{
    const char *name;

    size_t class_size;

    size_t instance_size;

    void (*class_init)(ObjectClass *klass, void *data);
P
Paolo Bonzini 已提交
52
    void (*class_base_init)(ObjectClass *klass, void *data);
53 54 55 56 57
    void (*class_finalize)(ObjectClass *klass, void *data);

    void *class_data;

    void (*instance_init)(Object *obj);
58
    void (*instance_post_init)(Object *obj);
59 60 61 62 63 64 65 66 67 68 69 70 71
    void (*instance_finalize)(Object *obj);

    bool abstract;

    const char *parent;
    TypeImpl *parent_type;

    ObjectClass *class;

    int num_interfaces;
    InterfaceImpl interfaces[MAX_INTERFACES];
};

72 73
static Type type_interface;

74 75 76 77 78 79 80 81 82 83 84
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;
}

85 86
static bool enumerating_types;

87 88
static void type_table_add(TypeImpl *ti)
{
89
    assert(!enumerating_types);
90 91 92 93 94 95 96 97
    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);
}

98
static TypeImpl *type_new(const TypeInfo *info)
99 100
{
    TypeImpl *ti = g_malloc0(sizeof(*ti));
A
Anthony Liguori 已提交
101
    int i;
102 103 104

    g_assert(info->name != NULL);

105 106 107 108 109
    if (type_table_lookup(info->name) != NULL) {
        fprintf(stderr, "Registering `%s' which already exists\n", info->name);
        abort();
    }

110 111 112 113 114 115 116
    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 已提交
117
    ti->class_base_init = info->class_base_init;
118 119 120 121
    ti->class_finalize = info->class_finalize;
    ti->class_data = info->class_data;

    ti->instance_init = info->instance_init;
122
    ti->instance_post_init = info->instance_post_init;
123 124 125 126
    ti->instance_finalize = info->instance_finalize;

    ti->abstract = info->abstract;

A
Anthony Liguori 已提交
127 128
    for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
        ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
129
    }
A
Anthony Liguori 已提交
130
    ti->num_interfaces = i;
131

132 133
    return ti;
}
134

135 136 137 138 139 140
static TypeImpl *type_register_internal(const TypeInfo *info)
{
    TypeImpl *ti;
    ti = type_new(info);

    type_table_add(ti);
141 142 143
    return ti;
}

144 145 146 147 148 149
TypeImpl *type_register(const TypeInfo *info)
{
    assert(info->parent);
    return type_register_internal(info);
}

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 188 189 190 191
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);
}

192 193 194 195 196 197 198 199 200 201 202 203 204
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;
}

205 206 207 208 209 210 211 212
size_t object_type_get_instance_size(const char *typename)
{
    TypeImpl *type = type_get_by_name(typename);

    g_assert(type != NULL);
    return type_object_get_size(type);
}

A
Anthony Liguori 已提交
213
static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
214
{
A
Anthony Liguori 已提交
215 216
    assert(target_type);

C
Cao jin 已提交
217
    /* Check if target_type is a direct ancestor of type */
A
Anthony Liguori 已提交
218 219 220 221
    while (type) {
        if (type == target_type) {
            return true;
        }
222

A
Anthony Liguori 已提交
223 224 225 226 227 228 229 230
        type = type_get_parent(type);
    }

    return false;
}

static void type_initialize(TypeImpl *ti);

231 232
static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type,
                                      TypeImpl *parent_type)
A
Anthony Liguori 已提交
233 234 235 236 237
{
    InterfaceClass *new_iface;
    TypeInfo info = { };
    TypeImpl *iface_impl;

238 239
    info.parent = parent_type->name;
    info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name);
A
Anthony Liguori 已提交
240 241
    info.abstract = true;

242 243
    iface_impl = type_new(&info);
    iface_impl->parent_type = parent_type;
A
Anthony Liguori 已提交
244 245 246 247 248
    type_initialize(iface_impl);
    g_free((char *)info.name);

    new_iface = (InterfaceClass *)iface_impl->class;
    new_iface->concrete_class = ti->class;
249
    new_iface->interface_type = interface_type;
A
Anthony Liguori 已提交
250 251 252

    ti->class->interfaces = g_slist_append(ti->class->interfaces,
                                           iface_impl->class);
253 254
}

255 256 257 258 259 260 261 262 263 264
static void object_property_free(gpointer data)
{
    ObjectProperty *prop = data;

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

265
static void type_initialize(TypeImpl *ti)
266
{
P
Paolo Bonzini 已提交
267
    TypeImpl *parent;
268 269 270 271 272 273

    if (ti->class) {
        return;
    }

    ti->class_size = type_class_get_size(ti);
274
    ti->instance_size = type_object_get_size(ti);
275 276 277

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

P
Paolo Bonzini 已提交
278 279
    parent = type_get_parent(ti);
    if (parent) {
280
        type_initialize(parent);
A
Anthony Liguori 已提交
281 282
        GSList *e;
        int i;
283

284
        g_assert_cmpint(parent->class_size, <=, ti->class_size);
P
Paolo Bonzini 已提交
285
        memcpy(ti->class, parent->class, parent->class_size);
286
        ti->class->interfaces = NULL;
287 288
        ti->class->properties = g_hash_table_new_full(
            g_str_hash, g_str_equal, g_free, object_property_free);
A
Anthony Liguori 已提交
289 290

        for (e = parent->class->interfaces; e; e = e->next) {
291 292 293 294
            InterfaceClass *iface = e->data;
            ObjectClass *klass = OBJECT_CLASS(iface);

            type_initialize_interface(ti, iface->interface_type, klass->type);
A
Anthony Liguori 已提交
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
        }

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

311
            type_initialize_interface(ti, t, t);
A
Anthony Liguori 已提交
312
        }
313 314 315
    } else {
        ti->class->properties = g_hash_table_new_full(
            g_str_hash, g_str_equal, g_free, object_property_free);
P
Paolo Bonzini 已提交
316
    }
317

P
Paolo Bonzini 已提交
318
    ti->class->type = ti;
P
Paolo Bonzini 已提交
319

P
Paolo Bonzini 已提交
320 321 322
    while (parent) {
        if (parent->class_base_init) {
            parent->class_base_init(ti->class, ti->class_data);
P
Paolo Bonzini 已提交
323
        }
P
Paolo Bonzini 已提交
324
        parent = type_get_parent(parent);
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
    }

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

343 344 345 346 347 348 349 350 351 352 353
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));
    }
}

354
void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
355 356 357 358
{
    Object *obj = data;

    g_assert(type != NULL);
359
    type_initialize(type);
360

361
    g_assert_cmpint(type->instance_size, >=, sizeof(Object));
362
    g_assert(type->abstract == false);
363
    g_assert_cmpint(size, >=, type->instance_size);
364 365 366

    memset(obj, 0, type->instance_size);
    obj->class = type->class;
367
    object_ref(obj);
368 369
    obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal,
                                            NULL, object_property_free);
370
    object_init_with_type(obj, type);
371
    object_post_init_with_type(obj, type);
372 373
}

374
void object_initialize(void *data, size_t size, const char *typename)
375 376 377
{
    TypeImpl *type = type_get_by_name(typename);

378
    object_initialize_with_type(data, size, type);
379 380
}

381 382 383 384 385
static inline bool object_property_is_child(ObjectProperty *prop)
{
    return strstart(prop->type, "child<", NULL);
}

386 387
static void object_property_del_all(Object *obj)
{
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
    ObjectProperty *prop;
    GHashTableIter iter;
    gpointer key, value;
    bool released;

    do {
        released = false;
        g_hash_table_iter_init(&iter, obj->properties);
        while (g_hash_table_iter_next(&iter, &key, &value)) {
            prop = value;
            if (prop->release) {
                prop->release(obj, prop->name, prop->opaque);
                prop->release = NULL;
                released = true;
                break;
            }
            g_hash_table_iter_remove(&iter);
405
        }
406
    } while (released);
407

408
    g_hash_table_unref(obj->properties);
409 410 411 412 413
}

static void object_property_del_child(Object *obj, Object *child, Error **errp)
{
    ObjectProperty *prop;
414 415
    GHashTableIter iter;
    gpointer key, value;
416

417 418 419 420 421 422 423 424 425 426 427 428 429 430
    g_hash_table_iter_init(&iter, obj->properties);
    while (g_hash_table_iter_next(&iter, &key, &value)) {
        prop = value;
        if (object_property_is_child(prop) && prop->opaque == child) {
            if (prop->release) {
                prop->release(obj, prop->name, prop->opaque);
                prop->release = NULL;
            }
            break;
        }
    }
    g_hash_table_iter_init(&iter, obj->properties);
    while (g_hash_table_iter_next(&iter, &key, &value)) {
        prop = value;
431
        if (object_property_is_child(prop) && prop->opaque == child) {
432
            g_hash_table_iter_remove(&iter);
P
Paolo Bonzini 已提交
433
            break;
434 435 436 437 438 439
        }
    }
}

void object_unparent(Object *obj)
{
440 441 442
    if (obj->parent) {
        object_property_del_child(obj->parent, obj, NULL);
    }
443 444
}

445 446 447 448 449 450 451 452 453 454 455
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 已提交
456
static void object_finalize(void *data)
457 458 459 460
{
    Object *obj = data;
    TypeImpl *ti = obj->class->type;

461
    object_property_del_all(obj);
462
    object_deinit(obj, ti);
463

464
    g_assert_cmpint(obj->ref, ==, 0);
465 466 467
    if (obj->free) {
        obj->free(obj);
    }
468 469 470 471 472 473 474
}

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

    g_assert(type != NULL);
475
    type_initialize(type);
476 477

    obj = g_malloc(type->instance_size);
478
    object_initialize_with_type(obj, type->instance_size, type);
479
    obj->free = g_free;
480 481 482 483 484 485 486 487 488 489 490

    return obj;
}

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

    return object_new_with_type(ti);
}

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 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551

Object *object_new_with_props(const char *typename,
                              Object *parent,
                              const char *id,
                              Error **errp,
                              ...)
{
    va_list vargs;
    Object *obj;

    va_start(vargs, errp);
    obj = object_new_with_propv(typename, parent, id, errp, vargs);
    va_end(vargs);

    return obj;
}


Object *object_new_with_propv(const char *typename,
                              Object *parent,
                              const char *id,
                              Error **errp,
                              va_list vargs)
{
    Object *obj;
    ObjectClass *klass;
    Error *local_err = NULL;

    klass = object_class_by_name(typename);
    if (!klass) {
        error_setg(errp, "invalid object type: %s", typename);
        return NULL;
    }

    if (object_class_is_abstract(klass)) {
        error_setg(errp, "object type '%s' is abstract", typename);
        return NULL;
    }
    obj = object_new(typename);

    if (object_set_propv(obj, &local_err, vargs) < 0) {
        goto error;
    }

    object_property_add_child(parent, id, obj, &local_err);
    if (local_err) {
        goto error;
    }

    if (object_dynamic_cast(obj, TYPE_USER_CREATABLE)) {
        user_creatable_complete(obj, &local_err);
        if (local_err) {
            object_unparent(obj);
            goto error;
        }
    }

    object_unref(OBJECT(obj));
    return obj;

 error:
552
    error_propagate(errp, local_err);
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
    object_unref(obj);
    return NULL;
}


int object_set_props(Object *obj,
                     Error **errp,
                     ...)
{
    va_list vargs;
    int ret;

    va_start(vargs, errp);
    ret = object_set_propv(obj, errp, vargs);
    va_end(vargs);

    return ret;
}


int object_set_propv(Object *obj,
                     Error **errp,
                     va_list vargs)
{
    const char *propname;
    Error *local_err = NULL;

    propname = va_arg(vargs, char *);
    while (propname != NULL) {
        const char *value = va_arg(vargs, char *);

        g_assert(value != NULL);
        object_property_parse(obj, value, propname, &local_err);
        if (local_err) {
            error_propagate(errp, local_err);
            return -1;
        }
        propname = va_arg(vargs, char *);
    }

    return 0;
}


597 598
Object *object_dynamic_cast(Object *obj, const char *typename)
{
599
    if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
600 601 602
        return obj;
    }

603 604 605
    return NULL;
}

606 607
Object *object_dynamic_cast_assert(Object *obj, const char *typename,
                                   const char *file, int line, const char *func)
608
{
P
Paolo Bonzini 已提交
609 610 611
    trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
                                     typename, file, line, func);

612
#ifdef CONFIG_QOM_CAST_DEBUG
613 614 615
    int i;
    Object *inst;

616
    for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
617
        if (obj->class->object_cast_cache[i] == typename) {
618 619 620 621 622
            goto out;
        }
    }

    inst = object_dynamic_cast(obj, typename);
623

624
    if (!inst && obj) {
625 626
        fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
                file, line, func, obj, typename);
627 628 629
        abort();
    }

630
    assert(obj == inst);
631

632
    if (obj && obj == inst) {
633
        for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
634 635
            obj->class->object_cast_cache[i - 1] =
                    obj->class->object_cast_cache[i];
636
        }
637
        obj->class->object_cast_cache[i - 1] = typename;
638 639 640
    }

out:
641 642
#endif
    return obj;
643 644 645 646 647
}

ObjectClass *object_class_dynamic_cast(ObjectClass *class,
                                       const char *typename)
{
A
Anthony Liguori 已提交
648
    ObjectClass *ret = NULL;
649 650
    TypeImpl *target_type;
    TypeImpl *type;
651

652 653 654 655
    if (!class) {
        return NULL;
    }

656
    /* A simple fast path that can trigger a lot for leaf classes.  */
657
    type = class->type;
658 659 660 661
    if (type->name == typename) {
        return class;
    }

662
    target_type = type_get_by_name(typename);
663 664 665 666 667
    if (!target_type) {
        /* target class type unknown, so fail the cast */
        return NULL;
    }

668 669
    if (type->class->interfaces &&
            type_is_ancestor(target_type, type_interface)) {
A
Anthony Liguori 已提交
670 671
        int found = 0;
        GSList *i;
672

A
Anthony Liguori 已提交
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
        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;
688 689
    }

A
Anthony Liguori 已提交
690
    return ret;
691 692 693
}

ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
694 695 696
                                              const char *typename,
                                              const char *file, int line,
                                              const char *func)
697
{
P
Paolo Bonzini 已提交
698 699 700 701
    ObjectClass *ret;

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

703 704 705
#ifdef CONFIG_QOM_CAST_DEBUG
    int i;

706
    for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
707
        if (class->class_cast_cache[i] == typename) {
708 709 710 711 712
            ret = class;
            goto out;
        }
    }
#else
713
    if (!class || !class->interfaces) {
714 715 716 717
        return class;
    }
#endif

P
Paolo Bonzini 已提交
718
    ret = object_class_dynamic_cast(class, typename);
719
    if (!ret && class) {
720 721
        fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
                file, line, func, class, typename);
722 723 724
        abort();
    }

725
#ifdef CONFIG_QOM_CAST_DEBUG
726
    if (class && ret == class) {
727
        for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
728
            class->class_cast_cache[i - 1] = class->class_cast_cache[i];
729
        }
730
        class->class_cast_cache[i - 1] = typename;
731 732 733
    }
out:
#endif
734 735 736 737 738 739 740 741 742 743 744 745 746
    return ret;
}

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

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

747 748 749 750 751
bool object_class_is_abstract(ObjectClass *klass)
{
    return klass->type->abstract;
}

752 753 754 755 756 757 758 759 760 761 762 763 764
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;
    }

765
    type_initialize(type);
766 767 768 769

    return type->class;
}

770 771 772 773 774 775 776 777 778 779 780 781 782
ObjectClass *object_class_get_parent(ObjectClass *class)
{
    TypeImpl *type = type_get_parent(class->type);

    if (!type) {
        return NULL;
    }

    type_initialize(type);

    return type->class;
}

783 784 785
typedef struct OCFData
{
    void (*fn)(ObjectClass *klass, void *opaque);
786 787
    const char *implements_type;
    bool include_abstract;
788 789 790 791 792 793 794 795
    void *opaque;
} OCFData;

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

798
    type_initialize(type);
799
    k = type->class;
800

801 802 803 804 805 806 807 808 809 810
    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);
811 812 813
}

void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
814
                          const char *implements_type, bool include_abstract,
815 816
                          void *opaque)
{
817
    OCFData data = { fn, implements_type, include_abstract, opaque };
818

819
    enumerating_types = true;
820
    g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
821
    enumerating_types = false;
822
}
823

824 825 826
static int do_object_child_foreach(Object *obj,
                                   int (*fn)(Object *child, void *opaque),
                                   void *opaque, bool recurse)
P
Paolo Bonzini 已提交
827
{
828 829
    GHashTableIter iter;
    ObjectProperty *prop;
P
Paolo Bonzini 已提交
830 831
    int ret = 0;

832 833
    g_hash_table_iter_init(&iter, obj->properties);
    while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
P
Paolo Bonzini 已提交
834
        if (object_property_is_child(prop)) {
835 836 837
            Object *child = prop->opaque;

            ret = fn(child, opaque);
P
Paolo Bonzini 已提交
838 839 840
            if (ret != 0) {
                break;
            }
841 842 843
            if (recurse) {
                do_object_child_foreach(child, fn, opaque, true);
            }
P
Paolo Bonzini 已提交
844 845 846 847 848
        }
    }
    return ret;
}

849 850 851 852 853 854 855 856 857 858 859 860 861
int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
                         void *opaque)
{
    return do_object_child_foreach(obj, fn, opaque, false);
}

int object_child_foreach_recursive(Object *obj,
                                   int (*fn)(Object *child, void *opaque),
                                   void *opaque)
{
    return do_object_child_foreach(obj, fn, opaque, true);
}

862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
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;
}

879 880
void object_ref(Object *obj)
{
881 882 883
    if (!obj) {
        return;
    }
884
    atomic_inc(&obj->ref);
885 886 887 888
}

void object_unref(Object *obj)
{
889 890 891
    if (!obj) {
        return;
    }
892
    g_assert_cmpint(obj->ref, >, 0);
893 894

    /* parent always holds a reference to its children */
895
    if (atomic_fetch_dec(&obj->ref) == 1) {
896 897 898 899
        object_finalize(obj);
    }
}

900 901 902 903 904 905
ObjectProperty *
object_property_add(Object *obj, const char *name, const char *type,
                    ObjectPropertyAccessor *get,
                    ObjectPropertyAccessor *set,
                    ObjectPropertyRelease *release,
                    void *opaque, Error **errp)
906
{
907
    ObjectProperty *prop;
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
    size_t name_len = strlen(name);

    if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
        int i;
        ObjectProperty *ret;
        char *name_no_array = g_strdup(name);

        name_no_array[name_len - 3] = '\0';
        for (i = 0; ; ++i) {
            char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);

            ret = object_property_add(obj, full_name, type, get, set,
                                      release, opaque, NULL);
            g_free(full_name);
            if (ret) {
                break;
            }
        }
        g_free(name_no_array);
        return ret;
    }
929

930
    if (object_property_find(obj, name, NULL) != NULL) {
931
        error_setg(errp, "attempt to add duplicate property '%s'"
932 933
                   " to object (type '%s')", name,
                   object_get_typename(obj));
934
        return NULL;
935 936 937
    }

    prop = g_malloc0(sizeof(*prop));
938 939 940 941 942 943 944 945 946

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

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

947
    g_hash_table_insert(obj->properties, prop->name, prop);
948
    return prop;
949 950
}

951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
ObjectProperty *
object_class_property_add(ObjectClass *klass,
                          const char *name,
                          const char *type,
                          ObjectPropertyAccessor *get,
                          ObjectPropertyAccessor *set,
                          ObjectPropertyRelease *release,
                          void *opaque,
                          Error **errp)
{
    ObjectProperty *prop;

    if (object_class_property_find(klass, name, NULL) != NULL) {
        error_setg(errp, "attempt to add duplicate property '%s'"
                   " to object (type '%s')", name,
                   object_class_get_name(klass));
        return NULL;
    }

    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;

    g_hash_table_insert(klass->properties, g_strdup(name), prop);

    return prop;
}

985 986
ObjectProperty *object_property_find(Object *obj, const char *name,
                                     Error **errp)
987 988
{
    ObjectProperty *prop;
989 990 991 992 993 994
    ObjectClass *klass = object_get_class(obj);

    prop = object_class_property_find(klass, name, NULL);
    if (prop) {
        return prop;
    }
995

996 997 998
    prop = g_hash_table_lookup(obj->properties, name);
    if (prop) {
        return prop;
999 1000
    }

1001
    error_setg(errp, "Property '.%s' not found", name);
1002 1003 1004
    return NULL;
}

1005 1006
void object_property_iter_init(ObjectPropertyIterator *iter,
                               Object *obj)
1007
{
1008 1009
    g_hash_table_iter_init(&iter->iter, obj->properties);
    iter->nextclass = object_get_class(obj);
1010 1011 1012 1013
}

ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
{
1014
    gpointer key, val;
1015 1016 1017 1018 1019 1020
    while (!g_hash_table_iter_next(&iter->iter, &key, &val)) {
        if (!iter->nextclass) {
            return NULL;
        }
        g_hash_table_iter_init(&iter->iter, iter->nextclass->properties);
        iter->nextclass = object_class_get_parent(iter->nextclass);
1021
    }
1022
    return val;
1023 1024
}

1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045
ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name,
                                           Error **errp)
{
    ObjectProperty *prop;
    ObjectClass *parent_klass;

    parent_klass = object_class_get_parent(klass);
    if (parent_klass) {
        prop = object_class_property_find(parent_klass, name, NULL);
        if (prop) {
            return prop;
        }
    }

    prop = g_hash_table_lookup(klass->properties, name);
    if (!prop) {
        error_setg(errp, "Property '.%s' not found", name);
    }
    return prop;
}

1046 1047
void object_property_del(Object *obj, const char *name, Error **errp)
{
1048 1049 1050 1051
    ObjectProperty *prop = g_hash_table_lookup(obj->properties, name);

    if (!prop) {
        error_setg(errp, "Property '.%s' not found", name);
A
Anthony Liguori 已提交
1052 1053
        return;
    }
1054

A
Anthony Liguori 已提交
1055 1056 1057
    if (prop->release) {
        prop->release(obj, name, prop->opaque);
    }
1058
    g_hash_table_remove(obj->properties, name);
1059 1060 1061 1062 1063
}

void object_property_get(Object *obj, Visitor *v, const char *name,
                         Error **errp)
{
1064
    ObjectProperty *prop = object_property_find(obj, name, errp);
1065 1066 1067 1068 1069
    if (prop == NULL) {
        return;
    }

    if (!prop->get) {
1070
        error_setg(errp, QERR_PERMISSION_DENIED);
1071
    } else {
1072
        prop->get(obj, v, name, prop->opaque, errp);
1073 1074 1075 1076 1077 1078
    }
}

void object_property_set(Object *obj, Visitor *v, const char *name,
                         Error **errp)
{
1079
    ObjectProperty *prop = object_property_find(obj, name, errp);
1080 1081 1082 1083 1084
    if (prop == NULL) {
        return;
    }

    if (!prop->set) {
1085
        error_setg(errp, QERR_PERMISSION_DENIED);
1086
    } else {
1087
        prop->set(obj, v, name, prop->opaque, errp);
1088 1089 1090
    }
}

1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
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) {
1112
        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
1113 1114 1115 1116 1117 1118 1119 1120 1121
        retval = NULL;
    } else {
        retval = g_strdup(qstring_get_str(qstring));
    }

    QDECREF(qstring);
    return retval;
}

1122 1123 1124
void object_property_set_link(Object *obj, Object *value,
                              const char *name, Error **errp)
{
1125 1126 1127 1128 1129 1130 1131
    if (value) {
        gchar *path = object_get_canonical_path(value);
        object_property_set_str(obj, path, name, errp);
        g_free(path);
    } else {
        object_property_set_str(obj, "", name, errp);
    }
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
}

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) {
1143 1144
            error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                      "Device '%s' not found", str);
1145 1146 1147 1148 1149 1150 1151
        }
    }

    g_free(str);
    return target;
}

1152 1153 1154
void object_property_set_bool(Object *obj, bool value,
                              const char *name, Error **errp)
{
E
Eric Blake 已提交
1155
    QBool *qbool = qbool_from_bool(value);
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
    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) {
1173
        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
1174 1175
        retval = false;
    } else {
E
Eric Blake 已提交
1176
        retval = qbool_get_bool(qbool);
1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203
    }

    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) {
1204
        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
1205 1206 1207 1208 1209 1210 1211
        retval = -1;
    } else {
        retval = qint_get_int(qint);
    }

    QDECREF(qint);
    return retval;
1212 1213
}

1214 1215 1216 1217 1218 1219
typedef struct EnumProperty {
    const char * const *strings;
    int (*get)(Object *, Error **);
    void (*set)(Object *, int, Error **);
} EnumProperty;

1220
int object_property_get_enum(Object *obj, const char *name,
1221
                             const char *typename, Error **errp)
1222
{
1223
    Error *err = NULL;
1224
    StringOutputVisitor *sov;
1225
    Visitor *v;
1226
    char *str;
1227
    int ret;
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
    ObjectProperty *prop = object_property_find(obj, name, errp);
    EnumProperty *enumprop;

    if (prop == NULL) {
        return 0;
    }

    if (!g_str_equal(prop->type, typename)) {
        error_setg(errp, "Property %s on %s is not '%s' enum type",
                   name, object_class_get_name(
                       object_get_class(obj)), typename);
        return 0;
    }

    enumprop = prop->opaque;
1243 1244

    sov = string_output_visitor_new(false);
1245 1246 1247 1248 1249 1250
    object_property_get(obj, string_output_get_visitor(sov), name, &err);
    if (err) {
        error_propagate(errp, err);
        string_output_visitor_cleanup(sov);
        return 0;
    }
1251
    str = string_output_get_string(sov);
1252
    string_output_visitor_cleanup(sov);
1253 1254
    v = string_input_visitor_new(str);
    visit_type_enum(v, name, &ret, enumprop->strings, errp);
1255 1256

    g_free(str);
1257
    visit_free(v);
1258 1259 1260 1261 1262 1263 1264

    return ret;
}

void object_property_get_uint16List(Object *obj, const char *name,
                                    uint16List **list, Error **errp)
{
1265
    Error *err = NULL;
1266
    StringOutputVisitor *ov;
1267
    Visitor *v;
1268
    char *str;
1269 1270 1271

    ov = string_output_visitor_new(false);
    object_property_get(obj, string_output_get_visitor(ov),
1272 1273 1274 1275 1276
                        name, &err);
    if (err) {
        error_propagate(errp, err);
        goto out;
    }
1277
    str = string_output_get_string(ov);
1278 1279
    v = string_input_visitor_new(str);
    visit_type_uint16List(v, NULL, list, errp);
1280 1281

    g_free(str);
1282
    visit_free(v);
1283 1284
out:
    string_output_visitor_cleanup(ov);
1285 1286
}

1287 1288 1289
void object_property_parse(Object *obj, const char *string,
                           const char *name, Error **errp)
{
1290 1291 1292
    Visitor *v = string_input_visitor_new(string);
    object_property_set(obj, v, name, errp);
    visit_free(v);
1293 1294
}

1295
char *object_property_print(Object *obj, const char *name, bool human,
1296 1297
                            Error **errp)
{
1298
    StringOutputVisitor *sov;
1299 1300
    char *string = NULL;
    Error *local_err = NULL;
1301

1302 1303
    sov = string_output_visitor_new(human);
    object_property_get(obj, string_output_get_visitor(sov), name, &local_err);
1304 1305 1306 1307 1308
    if (local_err) {
        error_propagate(errp, local_err);
        goto out;
    }

1309
    string = string_output_get_string(sov);
1310 1311

out:
1312
    string_output_visitor_cleanup(sov);
1313
    return string;
1314 1315
}

1316 1317
const char *object_property_get_type(Object *obj, const char *name, Error **errp)
{
1318
    ObjectProperty *prop = object_property_find(obj, name, errp);
1319 1320 1321 1322 1323 1324 1325 1326 1327
    if (prop == NULL) {
        return NULL;
    }

    return prop->type;
}

Object *object_get_root(void)
{
1328
    static Object *root;
1329

1330 1331
    if (!root) {
        root = object_new("container");
1332 1333
    }

1334
    return root;
1335 1336
}

1337 1338 1339 1340 1341
Object *object_get_objects_root(void)
{
    return container_get(object_get_root(), "/objects");
}

1342 1343 1344
static void object_get_child_property(Object *obj, Visitor *v,
                                      const char *name, void *opaque,
                                      Error **errp)
1345 1346 1347 1348 1349
{
    Object *child = opaque;
    gchar *path;

    path = object_get_canonical_path(child);
1350
    visit_type_str(v, name, &path, errp);
1351 1352 1353
    g_free(path);
}

1354 1355 1356 1357 1358
static Object *object_resolve_child_property(Object *parent, void *opaque, const gchar *part)
{
    return opaque;
}

1359 1360 1361 1362 1363
static void object_finalize_child_property(Object *obj, const char *name,
                                           void *opaque)
{
    Object *child = opaque;

1364 1365 1366 1367
    if (child->class->unparent) {
        (child->class->unparent)(child);
    }
    child->parent = NULL;
1368 1369 1370
    object_unref(child);
}

1371 1372 1373
void object_property_add_child(Object *obj, const char *name,
                               Object *child, Error **errp)
{
1374
    Error *local_err = NULL;
1375
    gchar *type;
1376
    ObjectProperty *op;
1377

1378 1379 1380 1381 1382
    if (child->parent != NULL) {
        error_setg(errp, "child object is already parented");
        return;
    }

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

1385 1386
    op = object_property_add(obj, name, type, object_get_child_property, NULL,
                             object_finalize_child_property, child, &local_err);
1387 1388 1389 1390
    if (local_err) {
        error_propagate(errp, local_err);
        goto out;
    }
1391 1392

    op->resolve = object_resolve_child_property;
1393 1394 1395
    object_ref(child);
    child->parent = obj;

1396
out:
1397 1398 1399
    g_free(type);
}

1400 1401 1402 1403 1404 1405
void object_property_allow_set_link(Object *obj, const char *name,
                                    Object *val, Error **errp)
{
    /* Allow the link to be set, always */
}

1406 1407
typedef struct {
    Object **child;
1408
    void (*check)(Object *, const char *, Object *, Error **);
1409 1410 1411
    ObjectPropertyLinkFlags flags;
} LinkProperty;

1412 1413 1414
static void object_get_link_property(Object *obj, Visitor *v,
                                     const char *name, void *opaque,
                                     Error **errp)
1415
{
1416 1417
    LinkProperty *lprop = opaque;
    Object **child = lprop->child;
1418 1419 1420 1421
    gchar *path;

    if (*child) {
        path = object_get_canonical_path(*child);
1422
        visit_type_str(v, name, &path, errp);
1423 1424 1425
        g_free(path);
    } else {
        path = (gchar *)"";
1426
        visit_type_str(v, name, &path, errp);
1427 1428 1429
    }
}

1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
/*
 * object_resolve_link:
 *
 * Lookup an object and ensure its type matches the link property type.  This
 * is similar to object_resolve_path() except type verification against the
 * link property is performed.
 *
 * Returns: The matched object or NULL on path lookup failures.
 */
static Object *object_resolve_link(Object *obj, const char *name,
                                   const char *path, Error **errp)
{
    const char *type;
    gchar *target_type;
    bool ambiguous = false;
    Object *target;

    /* Go from link<FOO> to FOO.  */
    type = object_property_get_type(obj, name, NULL);
    target_type = g_strndup(&type[5], strlen(type) - 6);
    target = object_resolve_path_type(path, target_type, &ambiguous);

    if (ambiguous) {
E
Eric Blake 已提交
1453 1454
        error_setg(errp, "Path '%s' does not uniquely identify an object",
                   path);
1455 1456 1457
    } else if (!target) {
        target = object_resolve_path(path, &ambiguous);
        if (target || ambiguous) {
1458
            error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
1459
        } else {
1460 1461
            error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                      "Device '%s' not found", path);
1462 1463 1464 1465 1466 1467 1468 1469
        }
        target = NULL;
    }
    g_free(target_type);

    return target;
}

1470 1471 1472
static void object_set_link_property(Object *obj, Visitor *v,
                                     const char *name, void *opaque,
                                     Error **errp)
1473
{
1474
    Error *local_err = NULL;
1475 1476
    LinkProperty *prop = opaque;
    Object **child = prop->child;
1477 1478 1479
    Object *old_target = *child;
    Object *new_target = NULL;
    char *path = NULL;
1480

1481
    visit_type_str(v, name, &path, &local_err);
1482

1483 1484
    if (!local_err && strcmp(path, "") != 0) {
        new_target = object_resolve_link(obj, name, path, &local_err);
1485 1486 1487
    }

    g_free(path);
1488 1489 1490 1491
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }
1492

1493 1494 1495 1496 1497 1498
    prop->check(obj, name, new_target, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }

1499
    object_ref(new_target);
1500
    *child = new_target;
1501
    object_unref(old_target);
1502 1503
}

1504 1505 1506 1507 1508 1509 1510
static Object *object_resolve_link_property(Object *parent, void *opaque, const gchar *part)
{
    LinkProperty *lprop = opaque;

    return *lprop->child;
}

1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
static void object_release_link_property(Object *obj, const char *name,
                                         void *opaque)
{
    LinkProperty *prop = opaque;

    if ((prop->flags & OBJ_PROP_LINK_UNREF_ON_RELEASE) && *prop->child) {
        object_unref(*prop->child);
    }
    g_free(prop);
}

1522 1523
void object_property_add_link(Object *obj, const char *name,
                              const char *type, Object **child,
1524 1525
                              void (*check)(Object *, const char *,
                                            Object *, Error **),
1526
                              ObjectPropertyLinkFlags flags,
1527 1528
                              Error **errp)
{
1529 1530
    Error *local_err = NULL;
    LinkProperty *prop = g_malloc(sizeof(*prop));
1531
    gchar *full_type;
1532
    ObjectProperty *op;
1533

1534
    prop->child = child;
1535
    prop->check = check;
1536 1537
    prop->flags = flags;

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

1540 1541 1542 1543 1544 1545
    op = object_property_add(obj, name, full_type,
                             object_get_link_property,
                             check ? object_set_link_property : NULL,
                             object_release_link_property,
                             prop,
                             &local_err);
1546 1547 1548
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
1549
        goto out;
1550
    }
1551

1552 1553 1554
    op->resolve = object_resolve_link_property;

out:
1555 1556 1557
    g_free(full_type);
}

1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573
void object_property_add_const_link(Object *obj, const char *name,
                                    Object *target, Error **errp)
{
    char *link_type;
    ObjectProperty *op;

    link_type = g_strdup_printf("link<%s>", object_get_typename(target));
    op = object_property_add(obj, name, link_type,
                             object_get_child_property, NULL,
                             NULL, target, errp);
    if (op != NULL) {
        op->resolve = object_resolve_child_property;
    }
    g_free(link_type);
}

1574 1575 1576
gchar *object_get_canonical_path_component(Object *obj)
{
    ObjectProperty *prop = NULL;
1577
    GHashTableIter iter;
1578 1579 1580 1581

    g_assert(obj);
    g_assert(obj->parent != NULL);

1582 1583
    g_hash_table_iter_init(&iter, obj->parent->properties);
    while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
        if (!object_property_is_child(prop)) {
            continue;
        }

        if (prop->opaque == obj) {
            return g_strdup(prop->name);
        }
    }

    /* obj had a parent but was not a child, should never happen */
    g_assert_not_reached();
    return NULL;
}

1598 1599 1600
gchar *object_get_canonical_path(Object *obj)
{
    Object *root = object_get_root();
1601
    char *newpath, *path = NULL;
1602 1603

    while (obj != root) {
1604
        char *component = object_get_canonical_path_component(obj);
1605

1606 1607 1608 1609 1610 1611 1612
        if (path) {
            newpath = g_strdup_printf("%s/%s", component, path);
            g_free(component);
            g_free(path);
            path = newpath;
        } else {
            path = component;
1613 1614 1615 1616 1617
        }

        obj = obj->parent;
    }

1618
    newpath = g_strdup_printf("/%s", path ? path : "");
1619 1620 1621 1622 1623
    g_free(path);

    return newpath;
}

1624
Object *object_resolve_path_component(Object *parent, const gchar *part)
P
Paolo Bonzini 已提交
1625
{
1626
    ObjectProperty *prop = object_property_find(parent, part, NULL);
P
Paolo Bonzini 已提交
1627 1628 1629 1630
    if (prop == NULL) {
        return NULL;
    }

1631 1632
    if (prop->resolve) {
        return prop->resolve(parent, prop->opaque, part);
P
Paolo Bonzini 已提交
1633 1634 1635 1636 1637
    } else {
        return NULL;
    }
}

1638 1639
static Object *object_resolve_abs_path(Object *parent,
                                          gchar **parts,
1640
                                          const char *typename,
1641 1642 1643 1644 1645
                                          int index)
{
    Object *child;

    if (parts[index] == NULL) {
1646
        return object_dynamic_cast(parent, typename);
1647 1648 1649
    }

    if (strcmp(parts[index], "") == 0) {
1650
        return object_resolve_abs_path(parent, parts, typename, index + 1);
1651 1652
    }

P
Paolo Bonzini 已提交
1653
    child = object_resolve_path_component(parent, parts[index]);
1654 1655 1656 1657
    if (!child) {
        return NULL;
    }

1658
    return object_resolve_abs_path(child, parts, typename, index + 1);
1659 1660 1661 1662
}

static Object *object_resolve_partial_path(Object *parent,
                                              gchar **parts,
1663
                                              const char *typename,
1664 1665 1666
                                              bool *ambiguous)
{
    Object *obj;
1667
    GHashTableIter iter;
1668 1669
    ObjectProperty *prop;

1670
    obj = object_resolve_abs_path(parent, parts, typename, 0);
1671

1672 1673
    g_hash_table_iter_init(&iter, parent->properties);
    while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1674 1675
        Object *found;

1676
        if (!object_property_is_child(prop)) {
1677 1678 1679
            continue;
        }

1680 1681
        found = object_resolve_partial_path(prop->opaque, parts,
                                            typename, ambiguous);
1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
        if (found) {
            if (obj) {
                if (ambiguous) {
                    *ambiguous = true;
                }
                return NULL;
            }
            obj = found;
        }

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

    return obj;
}

1700 1701
Object *object_resolve_path_type(const char *path, const char *typename,
                                 bool *ambiguous)
1702 1703 1704 1705 1706
{
    Object *obj;
    gchar **parts;

    parts = g_strsplit(path, "/", 0);
1707
    assert(parts);
1708

1709
    if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
1710 1711 1712
        if (ambiguous) {
            *ambiguous = false;
        }
1713 1714
        obj = object_resolve_partial_path(object_get_root(), parts,
                                          typename, ambiguous);
1715
    } else {
1716
        obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1717 1718 1719 1720 1721 1722 1723
    }

    g_strfreev(parts);

    return obj;
}

1724 1725 1726 1727 1728
Object *object_resolve_path(const char *path, bool *ambiguous)
{
    return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
}

1729 1730 1731 1732 1733 1734
typedef struct StringProperty
{
    char *(*get)(Object *, Error **);
    void (*set)(Object *, const char *, Error **);
} StringProperty;

1735 1736
static void property_get_str(Object *obj, Visitor *v, const char *name,
                             void *opaque, Error **errp)
1737 1738 1739
{
    StringProperty *prop = opaque;
    char *value;
1740
    Error *err = NULL;
1741

1742 1743 1744 1745
    value = prop->get(obj, &err);
    if (err) {
        error_propagate(errp, err);
        return;
1746
    }
1747

1748
    visit_type_str(v, name, &value, errp);
1749
    g_free(value);
1750 1751
}

1752 1753
static void property_set_str(Object *obj, Visitor *v, const char *name,
                             void *opaque, Error **errp)
1754 1755 1756 1757 1758
{
    StringProperty *prop = opaque;
    char *value;
    Error *local_err = NULL;

1759
    visit_type_str(v, name, &value, &local_err);
1760 1761 1762 1763 1764 1765 1766 1767 1768
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }

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

1769 1770
static void property_release_str(Object *obj, const char *name,
                                 void *opaque)
1771 1772 1773 1774 1775 1776 1777 1778 1779 1780
{
    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)
{
1781
    Error *local_err = NULL;
1782 1783 1784 1785 1786 1787
    StringProperty *prop = g_malloc0(sizeof(*prop));

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

    object_property_add(obj, name, "string",
1788 1789 1790
                        get ? property_get_str : NULL,
                        set ? property_set_str : NULL,
                        property_release_str,
1791 1792 1793 1794 1795
                        prop, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
    }
1796
}
P
Paolo Bonzini 已提交
1797

1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820
void object_class_property_add_str(ObjectClass *klass, const char *name,
                                   char *(*get)(Object *, Error **),
                                   void (*set)(Object *, const char *,
                                               Error **),
                                   Error **errp)
{
    Error *local_err = NULL;
    StringProperty *prop = g_malloc0(sizeof(*prop));

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

    object_class_property_add(klass, name, "string",
                              get ? property_get_str : NULL,
                              set ? property_set_str : NULL,
                              property_release_str,
                              prop, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
    }
}

1821 1822 1823 1824 1825 1826
typedef struct BoolProperty
{
    bool (*get)(Object *, Error **);
    void (*set)(Object *, bool, Error **);
} BoolProperty;

1827 1828
static void property_get_bool(Object *obj, Visitor *v, const char *name,
                              void *opaque, Error **errp)
1829 1830 1831
{
    BoolProperty *prop = opaque;
    bool value;
1832 1833 1834 1835 1836 1837 1838
    Error *err = NULL;

    value = prop->get(obj, &err);
    if (err) {
        error_propagate(errp, err);
        return;
    }
1839

1840
    visit_type_bool(v, name, &value, errp);
1841 1842
}

1843 1844
static void property_set_bool(Object *obj, Visitor *v, const char *name,
                              void *opaque, Error **errp)
1845 1846 1847 1848 1849
{
    BoolProperty *prop = opaque;
    bool value;
    Error *local_err = NULL;

1850
    visit_type_bool(v, name, &value, &local_err);
1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870
    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)
{
1871
    Error *local_err = NULL;
1872 1873 1874 1875 1876 1877 1878 1879 1880
    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,
1881 1882 1883 1884 1885
                        prop, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
    }
1886 1887
}

1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909
void object_class_property_add_bool(ObjectClass *klass, const char *name,
                                    bool (*get)(Object *, Error **),
                                    void (*set)(Object *, bool, Error **),
                                    Error **errp)
{
    Error *local_err = NULL;
    BoolProperty *prop = g_malloc0(sizeof(*prop));

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

    object_class_property_add(klass, name, "bool",
                              get ? property_get_bool : NULL,
                              set ? property_set_bool : NULL,
                              property_release_bool,
                              prop, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
    }
}

1910 1911
static void property_get_enum(Object *obj, Visitor *v, const char *name,
                              void *opaque, Error **errp)
1912 1913 1914
{
    EnumProperty *prop = opaque;
    int value;
1915 1916 1917 1918 1919 1920 1921
    Error *err = NULL;

    value = prop->get(obj, &err);
    if (err) {
        error_propagate(errp, err);
        return;
    }
1922

1923
    visit_type_enum(v, name, &value, prop->strings, errp);
1924 1925
}

1926 1927
static void property_set_enum(Object *obj, Visitor *v, const char *name,
                              void *opaque, Error **errp)
1928 1929 1930
{
    EnumProperty *prop = opaque;
    int value;
1931
    Error *err = NULL;
1932

1933
    visit_type_enum(v, name, &value, prop->strings, &err);
1934 1935 1936 1937
    if (err) {
        error_propagate(errp, err);
        return;
    }
1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972
    prop->set(obj, value, errp);
}

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

void object_property_add_enum(Object *obj, const char *name,
                              const char *typename,
                              const char * const *strings,
                              int (*get)(Object *, Error **),
                              void (*set)(Object *, int, Error **),
                              Error **errp)
{
    Error *local_err = NULL;
    EnumProperty *prop = g_malloc(sizeof(*prop));

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

    object_property_add(obj, name, typename,
                        get ? property_get_enum : NULL,
                        set ? property_set_enum : NULL,
                        property_release_enum,
                        prop, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
    }
}

1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997
void object_class_property_add_enum(ObjectClass *klass, const char *name,
                                    const char *typename,
                                    const char * const *strings,
                                    int (*get)(Object *, Error **),
                                    void (*set)(Object *, int, Error **),
                                    Error **errp)
{
    Error *local_err = NULL;
    EnumProperty *prop = g_malloc(sizeof(*prop));

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

    object_class_property_add(klass, name, typename,
                              get ? property_get_enum : NULL,
                              set ? property_set_enum : NULL,
                              property_release_enum,
                              prop, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
    }
}

1998 1999 2000 2001
typedef struct TMProperty {
    void (*get)(Object *, struct tm *, Error **);
} TMProperty;

2002 2003
static void property_get_tm(Object *obj, Visitor *v, const char *name,
                            void *opaque, Error **errp)
2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
{
    TMProperty *prop = opaque;
    Error *err = NULL;
    struct tm value;

    prop->get(obj, &value, &err);
    if (err) {
        goto out;
    }

2014
    visit_start_struct(v, name, NULL, 0, &err);
2015 2016 2017
    if (err) {
        goto out;
    }
2018
    visit_type_int32(v, "tm_year", &value.tm_year, &err);
2019 2020 2021
    if (err) {
        goto out_end;
    }
2022
    visit_type_int32(v, "tm_mon", &value.tm_mon, &err);
2023 2024 2025
    if (err) {
        goto out_end;
    }
2026
    visit_type_int32(v, "tm_mday", &value.tm_mday, &err);
2027 2028 2029
    if (err) {
        goto out_end;
    }
2030
    visit_type_int32(v, "tm_hour", &value.tm_hour, &err);
2031 2032 2033
    if (err) {
        goto out_end;
    }
2034
    visit_type_int32(v, "tm_min", &value.tm_min, &err);
2035 2036 2037
    if (err) {
        goto out_end;
    }
2038
    visit_type_int32(v, "tm_sec", &value.tm_sec, &err);
2039 2040 2041
    if (err) {
        goto out_end;
    }
2042
    visit_check_struct(v, &err);
2043
out_end:
E
Eric Blake 已提交
2044
    visit_end_struct(v, NULL);
2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075
out:
    error_propagate(errp, err);

}

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

void object_property_add_tm(Object *obj, const char *name,
                            void (*get)(Object *, struct tm *, Error **),
                            Error **errp)
{
    Error *local_err = NULL;
    TMProperty *prop = g_malloc0(sizeof(*prop));

    prop->get = get;

    object_property_add(obj, name, "struct tm",
                        get ? property_get_tm : NULL, NULL,
                        property_release_tm,
                        prop, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
    }
}

2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094
void object_class_property_add_tm(ObjectClass *klass, const char *name,
                                  void (*get)(Object *, struct tm *, Error **),
                                  Error **errp)
{
    Error *local_err = NULL;
    TMProperty *prop = g_malloc0(sizeof(*prop));

    prop->get = get;

    object_class_property_add(klass, name, "struct tm",
                              get ? property_get_tm : NULL, NULL,
                              property_release_tm,
                              prop, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
    }
}

2095 2096 2097 2098 2099
static char *qdev_get_type(Object *obj, Error **errp)
{
    return g_strdup(object_get_typename(obj));
}

2100 2101
static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name,
                                   void *opaque, Error **errp)
2102 2103
{
    uint8_t value = *(uint8_t *)opaque;
2104
    visit_type_uint8(v, name, &value, errp);
2105 2106
}

2107 2108
static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name,
                                    void *opaque, Error **errp)
2109 2110
{
    uint16_t value = *(uint16_t *)opaque;
2111
    visit_type_uint16(v, name, &value, errp);
2112 2113
}

2114 2115
static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name,
                                    void *opaque, Error **errp)
2116 2117
{
    uint32_t value = *(uint32_t *)opaque;
2118
    visit_type_uint32(v, name, &value, errp);
2119 2120
}

2121 2122
static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name,
                                    void *opaque, Error **errp)
2123 2124
{
    uint64_t value = *(uint64_t *)opaque;
2125
    visit_type_uint64(v, name, &value, errp);
2126 2127 2128 2129 2130 2131 2132 2133 2134
}

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

2135 2136 2137 2138 2139 2140 2141
void object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name,
                                         const uint8_t *v, Error **errp)
{
    object_class_property_add(klass, name, "uint8", property_get_uint8_ptr,
                              NULL, NULL, (void *)v, errp);
}

2142 2143 2144 2145 2146 2147 2148
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);
}

2149 2150 2151 2152 2153 2154 2155
void object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name,
                                          const uint16_t *v, Error **errp)
{
    object_class_property_add(klass, name, "uint16", property_get_uint16_ptr,
                              NULL, NULL, (void *)v, errp);
}

2156 2157 2158 2159 2160 2161 2162
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);
}

2163 2164 2165 2166 2167 2168 2169
void object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name,
                                          const uint32_t *v, Error **errp)
{
    object_class_property_add(klass, name, "uint32", property_get_uint32_ptr,
                              NULL, NULL, (void *)v, errp);
}

2170 2171 2172 2173 2174 2175 2176
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);
}

2177 2178 2179 2180 2181 2182 2183
void object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name,
                                          const uint64_t *v, Error **errp)
{
    object_class_property_add(klass, name, "uint64", property_get_uint64_ptr,
                              NULL, NULL, (void *)v, errp);
}

2184 2185
typedef struct {
    Object *target_obj;
2186
    char *target_name;
2187 2188
} AliasProperty;

2189 2190
static void property_get_alias(Object *obj, Visitor *v, const char *name,
                               void *opaque, Error **errp)
2191 2192 2193 2194 2195 2196
{
    AliasProperty *prop = opaque;

    object_property_get(prop->target_obj, v, prop->target_name, errp);
}

2197 2198
static void property_set_alias(Object *obj, Visitor *v, const char *name,
                               void *opaque, Error **errp)
2199 2200 2201 2202 2203 2204
{
    AliasProperty *prop = opaque;

    object_property_set(prop->target_obj, v, prop->target_name, errp);
}

2205 2206 2207 2208 2209 2210 2211 2212
static Object *property_resolve_alias(Object *obj, void *opaque,
                                      const gchar *part)
{
    AliasProperty *prop = opaque;

    return object_resolve_path_component(prop->target_obj, prop->target_name);
}

2213 2214 2215 2216
static void property_release_alias(Object *obj, const char *name, void *opaque)
{
    AliasProperty *prop = opaque;

2217
    g_free(prop->target_name);
2218 2219 2220 2221 2222 2223 2224 2225
    g_free(prop);
}

void object_property_add_alias(Object *obj, const char *name,
                               Object *target_obj, const char *target_name,
                               Error **errp)
{
    AliasProperty *prop;
2226
    ObjectProperty *op;
2227
    ObjectProperty *target_prop;
2228
    gchar *prop_type;
2229
    Error *local_err = NULL;
2230 2231 2232 2233 2234 2235

    target_prop = object_property_find(target_obj, target_name, errp);
    if (!target_prop) {
        return;
    }

2236 2237 2238 2239 2240 2241 2242
    if (object_property_is_child(target_prop)) {
        prop_type = g_strdup_printf("link%s",
                                    target_prop->type + strlen("child"));
    } else {
        prop_type = g_strdup(target_prop->type);
    }

2243 2244
    prop = g_malloc(sizeof(*prop));
    prop->target_obj = target_obj;
2245
    prop->target_name = g_strdup(target_name);
2246

2247
    op = object_property_add(obj, name, prop_type,
2248 2249 2250
                             property_get_alias,
                             property_set_alias,
                             property_release_alias,
2251 2252 2253 2254 2255 2256
                             prop, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
        goto out;
    }
2257
    op->resolve = property_resolve_alias;
2258

2259
    object_property_set_description(obj, op->name,
2260 2261 2262
                                    target_prop->description,
                                    &error_abort);

2263
out:
2264
    g_free(prop_type);
2265 2266
}

2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
void object_property_set_description(Object *obj, const char *name,
                                     const char *description, Error **errp)
{
    ObjectProperty *op;

    op = object_property_find(obj, name, errp);
    if (!op) {
        return;
    }

    g_free(op->description);
    op->description = g_strdup(description);
}

2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297
void object_class_property_set_description(ObjectClass *klass,
                                           const char *name,
                                           const char *description,
                                           Error **errp)
{
    ObjectProperty *op;

    op = g_hash_table_lookup(klass->properties, name);
    if (!op) {
        error_setg(errp, "Property '.%s' not found", name);
        return;
    }

    g_free(op->description);
    op->description = g_strdup(description);
}

2298 2299 2300 2301 2302
static void object_instance_init(Object *obj)
{
    object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
}

P
Paolo Bonzini 已提交
2303 2304 2305 2306
static void register_types(void)
{
    static TypeInfo interface_info = {
        .name = TYPE_INTERFACE,
A
Anthony Liguori 已提交
2307
        .class_size = sizeof(InterfaceClass),
P
Paolo Bonzini 已提交
2308 2309 2310 2311 2312 2313
        .abstract = true,
    };

    static TypeInfo object_info = {
        .name = TYPE_OBJECT,
        .instance_size = sizeof(Object),
2314
        .instance_init = object_instance_init,
P
Paolo Bonzini 已提交
2315 2316 2317
        .abstract = true,
    };

2318 2319
    type_interface = type_register_internal(&interface_info);
    type_register_internal(&object_info);
P
Paolo Bonzini 已提交
2320 2321 2322
}

type_init(register_types)