object.c 51.8 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 "qom/object_interfaces.h"
15
#include "qemu-common.h"
16
#include "qapi/visitor.h"
17
#include "qapi-visit.h"
18 19
#include "qapi/string-input-visitor.h"
#include "qapi/string-output-visitor.h"
20
#include "qapi/qmp/qerror.h"
P
Paolo Bonzini 已提交
21
#include "trace.h"
22

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

31 32 33 34 35 36 37
#define MAX_INTERFACES 32

typedef struct InterfaceImpl InterfaceImpl;
typedef struct TypeImpl TypeImpl;

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

struct TypeImpl
{
    const char *name;

    size_t class_size;

    size_t instance_size;

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

    void *class_data;

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

    bool abstract;

    const char *parent;
    TypeImpl *parent_type;

    ObjectClass *class;

    int num_interfaces;
    InterfaceImpl interfaces[MAX_INTERFACES];
};

70 71 72 73
struct ObjectPropertyIterator {
    ObjectProperty *next;
};

74 75
static Type type_interface;

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

87 88
static bool enumerating_types;

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

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

    g_assert(info->name != NULL);

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

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

    ti->instance_init = info->instance_init;
124
    ti->instance_post_init = info->instance_post_init;
125 126 127 128
    ti->instance_finalize = info->instance_finalize;

    ti->abstract = info->abstract;

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

134 135
    return ti;
}
136

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

    type_table_add(ti);
143 144 145
    return ti;
}

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

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

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

C
Cao jin 已提交
211
    /* Check if target_type is a direct ancestor of type */
A
Anthony Liguori 已提交
212 213 214 215
    while (type) {
        if (type == target_type) {
            return true;
        }
216

A
Anthony Liguori 已提交
217 218 219 220 221 222 223 224
        type = type_get_parent(type);
    }

    return false;
}

static void type_initialize(TypeImpl *ti);

225 226
static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type,
                                      TypeImpl *parent_type)
A
Anthony Liguori 已提交
227 228 229 230 231
{
    InterfaceClass *new_iface;
    TypeInfo info = { };
    TypeImpl *iface_impl;

232 233
    info.parent = parent_type->name;
    info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name);
A
Anthony Liguori 已提交
234 235
    info.abstract = true;

236 237
    iface_impl = type_new(&info);
    iface_impl->parent_type = parent_type;
A
Anthony Liguori 已提交
238 239 240 241 242
    type_initialize(iface_impl);
    g_free((char *)info.name);

    new_iface = (InterfaceClass *)iface_impl->class;
    new_iface->concrete_class = ti->class;
243
    new_iface->interface_type = interface_type;
A
Anthony Liguori 已提交
244 245 246

    ti->class->interfaces = g_slist_append(ti->class->interfaces,
                                           iface_impl->class);
247 248
}

249
static void type_initialize(TypeImpl *ti)
250
{
P
Paolo Bonzini 已提交
251
    TypeImpl *parent;
252 253 254 255 256 257

    if (ti->class) {
        return;
    }

    ti->class_size = type_class_get_size(ti);
258
    ti->instance_size = type_object_get_size(ti);
259 260 261

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

P
Paolo Bonzini 已提交
262 263
    parent = type_get_parent(ti);
    if (parent) {
264
        type_initialize(parent);
A
Anthony Liguori 已提交
265 266
        GSList *e;
        int i;
267 268

        g_assert(parent->class_size <= ti->class_size);
P
Paolo Bonzini 已提交
269
        memcpy(ti->class, parent->class, parent->class_size);
270
        ti->class->interfaces = NULL;
A
Anthony Liguori 已提交
271 272

        for (e = parent->class->interfaces; e; e = e->next) {
273 274 275 276
            InterfaceClass *iface = e->data;
            ObjectClass *klass = OBJECT_CLASS(iface);

            type_initialize_interface(ti, iface->interface_type, klass->type);
A
Anthony Liguori 已提交
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
        }

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

293
            type_initialize_interface(ti, t, t);
A
Anthony Liguori 已提交
294
        }
P
Paolo Bonzini 已提交
295
    }
296

P
Paolo Bonzini 已提交
297
    ti->class->type = ti;
P
Paolo Bonzini 已提交
298

P
Paolo Bonzini 已提交
299 300 301
    while (parent) {
        if (parent->class_base_init) {
            parent->class_base_init(ti->class, ti->class_data);
P
Paolo Bonzini 已提交
302
        }
P
Paolo Bonzini 已提交
303
        parent = type_get_parent(parent);
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
    }

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

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

333
void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
334 335 336 337
{
    Object *obj = data;

    g_assert(type != NULL);
338
    type_initialize(type);
339 340

    g_assert(type->instance_size >= sizeof(Object));
341
    g_assert(type->abstract == false);
342
    g_assert(size >= type->instance_size);
343 344 345

    memset(obj, 0, type->instance_size);
    obj->class = type->class;
346
    object_ref(obj);
347
    QTAILQ_INIT(&obj->properties);
348
    object_init_with_type(obj, type);
349
    object_post_init_with_type(obj, type);
350 351
}

352
void object_initialize(void *data, size_t size, const char *typename)
353 354 355
{
    TypeImpl *type = type_get_by_name(typename);

356
    object_initialize_with_type(data, size, type);
357 358
}

359 360 361 362 363
static inline bool object_property_is_child(ObjectProperty *prop)
{
    return strstart(prop->type, "child<", NULL);
}

364 365 366 367 368 369 370 371 372 373 374 375 376
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);
377
        g_free(prop->description);
378 379 380 381 382 383 384 385 386
        g_free(prop);
    }
}

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

    QTAILQ_FOREACH(prop, &obj->properties, node) {
387
        if (object_property_is_child(prop) && prop->opaque == child) {
388
            object_property_del(obj, prop->name, errp);
P
Paolo Bonzini 已提交
389
            break;
390 391 392 393 394 395
        }
    }
}

void object_unparent(Object *obj)
{
396 397 398
    if (obj->parent) {
        object_property_del_child(obj->parent, obj, NULL);
    }
399 400
}

401 402 403 404 405 406 407 408 409 410 411
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 已提交
412
static void object_finalize(void *data)
413 414 415 416
{
    Object *obj = data;
    TypeImpl *ti = obj->class->type;

417
    object_property_del_all(obj);
418
    object_deinit(obj, ti);
419 420

    g_assert(obj->ref == 0);
421 422 423
    if (obj->free) {
        obj->free(obj);
    }
424 425 426 427 428 429 430
}

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

    g_assert(type != NULL);
431
    type_initialize(type);
432 433

    obj = g_malloc(type->instance_size);
434
    object_initialize_with_type(obj, type->instance_size, type);
435
    obj->free = g_free;
436 437 438 439 440 441 442 443 444 445 446

    return obj;
}

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

    return object_new_with_type(ti);
}

447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 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 552 553 554

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:
    if (local_err) {
        error_propagate(errp, local_err);
    }
    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;
}


555 556
Object *object_dynamic_cast(Object *obj, const char *typename)
{
557
    if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
558 559 560
        return obj;
    }

561 562 563
    return NULL;
}

564 565
Object *object_dynamic_cast_assert(Object *obj, const char *typename,
                                   const char *file, int line, const char *func)
566
{
P
Paolo Bonzini 已提交
567 568 569
    trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
                                     typename, file, line, func);

570
#ifdef CONFIG_QOM_CAST_DEBUG
571 572 573
    int i;
    Object *inst;

574
    for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
575
        if (obj->class->object_cast_cache[i] == typename) {
576 577 578 579 580
            goto out;
        }
    }

    inst = object_dynamic_cast(obj, typename);
581

582
    if (!inst && obj) {
583 584
        fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
                file, line, func, obj, typename);
585 586 587
        abort();
    }

588
    assert(obj == inst);
589

590
    if (obj && obj == inst) {
591
        for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
592 593
            obj->class->object_cast_cache[i - 1] =
                    obj->class->object_cast_cache[i];
594
        }
595
        obj->class->object_cast_cache[i - 1] = typename;
596 597 598
    }

out:
599 600
#endif
    return obj;
601 602 603 604 605
}

ObjectClass *object_class_dynamic_cast(ObjectClass *class,
                                       const char *typename)
{
A
Anthony Liguori 已提交
606
    ObjectClass *ret = NULL;
607 608
    TypeImpl *target_type;
    TypeImpl *type;
609

610 611 612 613
    if (!class) {
        return NULL;
    }

614
    /* A simple fast path that can trigger a lot for leaf classes.  */
615
    type = class->type;
616 617 618 619
    if (type->name == typename) {
        return class;
    }

620
    target_type = type_get_by_name(typename);
621 622 623 624 625
    if (!target_type) {
        /* target class type unknown, so fail the cast */
        return NULL;
    }

626 627
    if (type->class->interfaces &&
            type_is_ancestor(target_type, type_interface)) {
A
Anthony Liguori 已提交
628 629
        int found = 0;
        GSList *i;
630

A
Anthony Liguori 已提交
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
        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;
646 647
    }

A
Anthony Liguori 已提交
648
    return ret;
649 650 651
}

ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
652 653 654
                                              const char *typename,
                                              const char *file, int line,
                                              const char *func)
655
{
P
Paolo Bonzini 已提交
656 657 658 659
    ObjectClass *ret;

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

661 662 663
#ifdef CONFIG_QOM_CAST_DEBUG
    int i;

664
    for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
665
        if (class->class_cast_cache[i] == typename) {
666 667 668 669 670
            ret = class;
            goto out;
        }
    }
#else
671
    if (!class || !class->interfaces) {
672 673 674 675
        return class;
    }
#endif

P
Paolo Bonzini 已提交
676
    ret = object_class_dynamic_cast(class, typename);
677
    if (!ret && class) {
678 679
        fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
                file, line, func, class, typename);
680 681 682
        abort();
    }

683
#ifdef CONFIG_QOM_CAST_DEBUG
684
    if (class && ret == class) {
685
        for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
686
            class->class_cast_cache[i - 1] = class->class_cast_cache[i];
687
        }
688
        class->class_cast_cache[i - 1] = typename;
689 690 691
    }
out:
#endif
692 693 694 695 696 697 698 699 700 701 702 703 704
    return ret;
}

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

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

705 706 707 708 709
bool object_class_is_abstract(ObjectClass *klass)
{
    return klass->type->abstract;
}

710 711 712 713 714 715 716 717 718 719 720 721 722
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;
    }

723
    type_initialize(type);
724 725 726 727

    return type->class;
}

728 729 730 731 732 733 734 735 736 737 738 739 740
ObjectClass *object_class_get_parent(ObjectClass *class)
{
    TypeImpl *type = type_get_parent(class->type);

    if (!type) {
        return NULL;
    }

    type_initialize(type);

    return type->class;
}

741 742 743
typedef struct OCFData
{
    void (*fn)(ObjectClass *klass, void *opaque);
744 745
    const char *implements_type;
    bool include_abstract;
746 747 748 749 750 751 752 753
    void *opaque;
} OCFData;

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

756
    type_initialize(type);
757
    k = type->class;
758

759 760 761 762 763 764 765 766 767 768
    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);
769 770 771
}

void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
772
                          const char *implements_type, bool include_abstract,
773 774
                          void *opaque)
{
775
    OCFData data = { fn, implements_type, include_abstract, opaque };
776

777
    enumerating_types = true;
778
    g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
779
    enumerating_types = false;
780
}
781

782 783 784
static int do_object_child_foreach(Object *obj,
                                   int (*fn)(Object *child, void *opaque),
                                   void *opaque, bool recurse)
P
Paolo Bonzini 已提交
785
{
786
    ObjectProperty *prop, *next;
P
Paolo Bonzini 已提交
787 788
    int ret = 0;

789
    QTAILQ_FOREACH_SAFE(prop, &obj->properties, node, next) {
P
Paolo Bonzini 已提交
790
        if (object_property_is_child(prop)) {
791 792 793
            Object *child = prop->opaque;

            ret = fn(child, opaque);
P
Paolo Bonzini 已提交
794 795 796
            if (ret != 0) {
                break;
            }
797 798 799
            if (recurse) {
                do_object_child_foreach(child, fn, opaque, true);
            }
P
Paolo Bonzini 已提交
800 801 802 803 804
        }
    }
    return ret;
}

805 806 807 808 809 810 811 812 813 814 815 816 817
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);
}

818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
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;
}

835 836
void object_ref(Object *obj)
{
837 838 839
    if (!obj) {
        return;
    }
840
     atomic_inc(&obj->ref);
841 842 843 844
}

void object_unref(Object *obj)
{
845 846 847
    if (!obj) {
        return;
    }
848 849 850
    g_assert(obj->ref > 0);

    /* parent always holds a reference to its children */
851
    if (atomic_fetch_dec(&obj->ref) == 1) {
852 853 854 855
        object_finalize(obj);
    }
}

856 857 858 859 860 861
ObjectProperty *
object_property_add(Object *obj, const char *name, const char *type,
                    ObjectPropertyAccessor *get,
                    ObjectPropertyAccessor *set,
                    ObjectPropertyRelease *release,
                    void *opaque, Error **errp)
862
{
863
    ObjectProperty *prop;
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884
    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;
    }
885 886 887 888 889 890

    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));
891
            return NULL;
892 893 894 895
        }
    }

    prop = g_malloc0(sizeof(*prop));
896 897 898 899 900 901 902 903 904 905

    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);
906
    return prop;
907 908
}

909 910
ObjectProperty *object_property_find(Object *obj, const char *name,
                                     Error **errp)
911 912 913 914 915 916 917 918 919
{
    ObjectProperty *prop;

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

920
    error_setg(errp, "Property '.%s' not found", name);
921 922 923
    return NULL;
}

924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
ObjectPropertyIterator *object_property_iter_init(Object *obj)
{
    ObjectPropertyIterator *ret = g_new0(ObjectPropertyIterator, 1);
    ret->next = QTAILQ_FIRST(&obj->properties);
    return ret;
}

void object_property_iter_free(ObjectPropertyIterator *iter)
{
    if (!iter) {
        return;
    }
    g_free(iter);
}

ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
{
    ObjectProperty *ret = iter->next;
    if (ret) {
        iter->next = QTAILQ_NEXT(iter->next, node);
    }
    return ret;
}

948 949
void object_property_del(Object *obj, const char *name, Error **errp)
{
950
    ObjectProperty *prop = object_property_find(obj, name, errp);
A
Anthony Liguori 已提交
951 952 953
    if (prop == NULL) {
        return;
    }
954

A
Anthony Liguori 已提交
955 956 957 958 959
    if (prop->release) {
        prop->release(obj, name, prop->opaque);
    }

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

    g_free(prop->name);
    g_free(prop->type);
963
    g_free(prop->description);
964 965 966 967 968 969
    g_free(prop);
}

void object_property_get(Object *obj, Visitor *v, const char *name,
                         Error **errp)
{
970
    ObjectProperty *prop = object_property_find(obj, name, errp);
971 972 973 974 975
    if (prop == NULL) {
        return;
    }

    if (!prop->get) {
976
        error_setg(errp, QERR_PERMISSION_DENIED);
977 978 979 980 981 982 983 984
    } else {
        prop->get(obj, v, prop->opaque, name, errp);
    }
}

void object_property_set(Object *obj, Visitor *v, const char *name,
                         Error **errp)
{
985
    ObjectProperty *prop = object_property_find(obj, name, errp);
986 987 988 989 990
    if (prop == NULL) {
        return;
    }

    if (!prop->set) {
991
        error_setg(errp, QERR_PERMISSION_DENIED);
992 993 994 995 996
    } else {
        prop->set(obj, v, prop->opaque, name, errp);
    }
}

997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
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) {
1018
        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
1019 1020 1021 1022 1023 1024 1025 1026 1027
        retval = NULL;
    } else {
        retval = g_strdup(qstring_get_str(qstring));
    }

    QDECREF(qstring);
    return retval;
}

1028 1029 1030
void object_property_set_link(Object *obj, Object *value,
                              const char *name, Error **errp)
{
1031 1032 1033 1034 1035 1036 1037
    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);
    }
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048
}

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) {
1049 1050
            error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                      "Device '%s' not found", str);
1051 1052 1053 1054 1055 1056 1057
        }
    }

    g_free(str);
    return target;
}

1058 1059 1060
void object_property_set_bool(Object *obj, bool value,
                              const char *name, Error **errp)
{
E
Eric Blake 已提交
1061
    QBool *qbool = qbool_from_bool(value);
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
    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) {
1079
        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
1080 1081
        retval = false;
    } else {
E
Eric Blake 已提交
1082
        retval = qbool_get_bool(qbool);
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
    }

    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) {
1110
        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
1111 1112 1113 1114 1115 1116 1117
        retval = -1;
    } else {
        retval = qint_get_int(qint);
    }

    QDECREF(qint);
    return retval;
1118 1119
}

1120 1121 1122 1123 1124 1125
typedef struct EnumProperty {
    const char * const *strings;
    int (*get)(Object *, Error **);
    void (*set)(Object *, int, Error **);
} EnumProperty;

1126
int object_property_get_enum(Object *obj, const char *name,
1127
                             const char *typename, Error **errp)
1128
{
1129
    Error *err = NULL;
1130 1131
    StringOutputVisitor *sov;
    StringInputVisitor *siv;
1132
    char *str;
1133
    int ret;
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
    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;
1149 1150

    sov = string_output_visitor_new(false);
1151 1152 1153 1154 1155 1156
    object_property_get(obj, string_output_get_visitor(sov), name, &err);
    if (err) {
        error_propagate(errp, err);
        string_output_visitor_cleanup(sov);
        return 0;
    }
1157 1158
    str = string_output_get_string(sov);
    siv = string_input_visitor_new(str);
1159 1160
    string_output_visitor_cleanup(sov);
    visit_type_enum(string_input_get_visitor(siv),
1161
                    &ret, enumprop->strings, NULL, name, errp);
1162 1163

    g_free(str);
1164 1165 1166 1167 1168 1169 1170 1171
    string_input_visitor_cleanup(siv);

    return ret;
}

void object_property_get_uint16List(Object *obj, const char *name,
                                    uint16List **list, Error **errp)
{
1172
    Error *err = NULL;
1173 1174
    StringOutputVisitor *ov;
    StringInputVisitor *iv;
1175
    char *str;
1176 1177 1178

    ov = string_output_visitor_new(false);
    object_property_get(obj, string_output_get_visitor(ov),
1179 1180 1181 1182 1183
                        name, &err);
    if (err) {
        error_propagate(errp, err);
        goto out;
    }
1184 1185
    str = string_output_get_string(ov);
    iv = string_input_visitor_new(str);
1186 1187
    visit_type_uint16List(string_input_get_visitor(iv),
                          list, NULL, errp);
1188 1189

    g_free(str);
1190
    string_input_visitor_cleanup(iv);
1191 1192
out:
    string_output_visitor_cleanup(ov);
1193 1194
}

1195 1196 1197
void object_property_parse(Object *obj, const char *string,
                           const char *name, Error **errp)
{
1198 1199 1200
    StringInputVisitor *siv;
    siv = string_input_visitor_new(string);
    object_property_set(obj, string_input_get_visitor(siv), name, errp);
1201

1202
    string_input_visitor_cleanup(siv);
1203 1204
}

1205
char *object_property_print(Object *obj, const char *name, bool human,
1206 1207
                            Error **errp)
{
1208
    StringOutputVisitor *sov;
1209 1210
    char *string = NULL;
    Error *local_err = NULL;
1211

1212 1213
    sov = string_output_visitor_new(human);
    object_property_get(obj, string_output_get_visitor(sov), name, &local_err);
1214 1215 1216 1217 1218
    if (local_err) {
        error_propagate(errp, local_err);
        goto out;
    }

1219
    string = string_output_get_string(sov);
1220 1221

out:
1222
    string_output_visitor_cleanup(sov);
1223
    return string;
1224 1225
}

1226 1227
const char *object_property_get_type(Object *obj, const char *name, Error **errp)
{
1228
    ObjectProperty *prop = object_property_find(obj, name, errp);
1229 1230 1231 1232 1233 1234 1235 1236 1237
    if (prop == NULL) {
        return NULL;
    }

    return prop->type;
}

Object *object_get_root(void)
{
1238
    static Object *root;
1239

1240 1241
    if (!root) {
        root = object_new("container");
1242 1243
    }

1244
    return root;
1245 1246
}

1247 1248 1249 1250 1251
Object *object_get_objects_root(void)
{
    return container_get(object_get_root(), "/objects");
}

1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
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);
}

1263 1264 1265 1266 1267
static Object *object_resolve_child_property(Object *parent, void *opaque, const gchar *part)
{
    return opaque;
}

1268 1269 1270 1271 1272
static void object_finalize_child_property(Object *obj, const char *name,
                                           void *opaque)
{
    Object *child = opaque;

1273 1274 1275 1276
    if (child->class->unparent) {
        (child->class->unparent)(child);
    }
    child->parent = NULL;
1277 1278 1279
    object_unref(child);
}

1280 1281 1282
void object_property_add_child(Object *obj, const char *name,
                               Object *child, Error **errp)
{
1283
    Error *local_err = NULL;
1284
    gchar *type;
1285
    ObjectProperty *op;
1286

1287 1288 1289 1290 1291
    if (child->parent != NULL) {
        error_setg(errp, "child object is already parented");
        return;
    }

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

1294 1295
    op = object_property_add(obj, name, type, object_get_child_property, NULL,
                             object_finalize_child_property, child, &local_err);
1296 1297 1298 1299
    if (local_err) {
        error_propagate(errp, local_err);
        goto out;
    }
1300 1301

    op->resolve = object_resolve_child_property;
1302 1303 1304
    object_ref(child);
    child->parent = obj;

1305
out:
1306 1307 1308
    g_free(type);
}

1309 1310 1311 1312 1313 1314
void object_property_allow_set_link(Object *obj, const char *name,
                                    Object *val, Error **errp)
{
    /* Allow the link to be set, always */
}

1315 1316
typedef struct {
    Object **child;
1317
    void (*check)(Object *, const char *, Object *, Error **);
1318 1319 1320
    ObjectPropertyLinkFlags flags;
} LinkProperty;

1321 1322 1323
static void object_get_link_property(Object *obj, Visitor *v, void *opaque,
                                     const char *name, Error **errp)
{
1324 1325
    LinkProperty *lprop = opaque;
    Object **child = lprop->child;
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
    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);
    }
}

1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
/*
 * 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 已提交
1361 1362
        error_setg(errp, "Path '%s' does not uniquely identify an object",
                   path);
1363 1364 1365
    } else if (!target) {
        target = object_resolve_path(path, &ambiguous);
        if (target || ambiguous) {
1366
            error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
1367
        } else {
1368 1369
            error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
                      "Device '%s' not found", path);
1370 1371 1372 1373 1374 1375 1376 1377
        }
        target = NULL;
    }
    g_free(target_type);

    return target;
}

1378 1379 1380
static void object_set_link_property(Object *obj, Visitor *v, void *opaque,
                                     const char *name, Error **errp)
{
1381
    Error *local_err = NULL;
1382 1383
    LinkProperty *prop = opaque;
    Object **child = prop->child;
1384 1385 1386
    Object *old_target = *child;
    Object *new_target = NULL;
    char *path = NULL;
1387

1388
    visit_type_str(v, &path, name, &local_err);
1389

1390 1391
    if (!local_err && strcmp(path, "") != 0) {
        new_target = object_resolve_link(obj, name, path, &local_err);
1392 1393 1394
    }

    g_free(path);
1395 1396 1397 1398
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }
1399

1400 1401 1402 1403 1404 1405
    prop->check(obj, name, new_target, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        return;
    }

1406
    object_ref(new_target);
1407
    *child = new_target;
1408
    object_unref(old_target);
1409 1410
}

1411 1412 1413 1414 1415 1416 1417
static Object *object_resolve_link_property(Object *parent, void *opaque, const gchar *part)
{
    LinkProperty *lprop = opaque;

    return *lprop->child;
}

1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428
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);
}

1429 1430
void object_property_add_link(Object *obj, const char *name,
                              const char *type, Object **child,
1431 1432
                              void (*check)(Object *, const char *,
                                            Object *, Error **),
1433
                              ObjectPropertyLinkFlags flags,
1434 1435
                              Error **errp)
{
1436 1437
    Error *local_err = NULL;
    LinkProperty *prop = g_malloc(sizeof(*prop));
1438
    gchar *full_type;
1439
    ObjectProperty *op;
1440

1441
    prop->child = child;
1442
    prop->check = check;
1443 1444
    prop->flags = flags;

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

1447 1448 1449 1450 1451 1452
    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);
1453 1454 1455
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
1456
        goto out;
1457
    }
1458

1459 1460 1461
    op->resolve = object_resolve_link_property;

out:
1462 1463 1464
    g_free(full_type);
}

1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
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);
}

1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502
gchar *object_get_canonical_path_component(Object *obj)
{
    ObjectProperty *prop = NULL;

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

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

1503 1504 1505
gchar *object_get_canonical_path(Object *obj)
{
    Object *root = object_get_root();
1506
    char *newpath, *path = NULL;
1507 1508

    while (obj != root) {
1509
        char *component = object_get_canonical_path_component(obj);
1510

1511 1512 1513 1514 1515 1516 1517
        if (path) {
            newpath = g_strdup_printf("%s/%s", component, path);
            g_free(component);
            g_free(path);
            path = newpath;
        } else {
            path = component;
1518 1519 1520 1521 1522
        }

        obj = obj->parent;
    }

1523
    newpath = g_strdup_printf("/%s", path ? path : "");
1524 1525 1526 1527 1528
    g_free(path);

    return newpath;
}

1529
Object *object_resolve_path_component(Object *parent, const gchar *part)
P
Paolo Bonzini 已提交
1530
{
1531
    ObjectProperty *prop = object_property_find(parent, part, NULL);
P
Paolo Bonzini 已提交
1532 1533 1534 1535
    if (prop == NULL) {
        return NULL;
    }

1536 1537
    if (prop->resolve) {
        return prop->resolve(parent, prop->opaque, part);
P
Paolo Bonzini 已提交
1538 1539 1540 1541 1542
    } else {
        return NULL;
    }
}

1543 1544
static Object *object_resolve_abs_path(Object *parent,
                                          gchar **parts,
1545
                                          const char *typename,
1546 1547 1548 1549 1550
                                          int index)
{
    Object *child;

    if (parts[index] == NULL) {
1551
        return object_dynamic_cast(parent, typename);
1552 1553 1554
    }

    if (strcmp(parts[index], "") == 0) {
1555
        return object_resolve_abs_path(parent, parts, typename, index + 1);
1556 1557
    }

P
Paolo Bonzini 已提交
1558
    child = object_resolve_path_component(parent, parts[index]);
1559 1560 1561 1562
    if (!child) {
        return NULL;
    }

1563
    return object_resolve_abs_path(child, parts, typename, index + 1);
1564 1565 1566 1567
}

static Object *object_resolve_partial_path(Object *parent,
                                              gchar **parts,
1568
                                              const char *typename,
1569 1570 1571 1572 1573
                                              bool *ambiguous)
{
    Object *obj;
    ObjectProperty *prop;

1574
    obj = object_resolve_abs_path(parent, parts, typename, 0);
1575 1576 1577 1578

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

1579
        if (!object_property_is_child(prop)) {
1580 1581 1582
            continue;
        }

1583 1584
        found = object_resolve_partial_path(prop->opaque, parts,
                                            typename, ambiguous);
1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
        if (found) {
            if (obj) {
                if (ambiguous) {
                    *ambiguous = true;
                }
                return NULL;
            }
            obj = found;
        }

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

    return obj;
}

1603 1604
Object *object_resolve_path_type(const char *path, const char *typename,
                                 bool *ambiguous)
1605 1606 1607 1608 1609
{
    Object *obj;
    gchar **parts;

    parts = g_strsplit(path, "/", 0);
1610
    assert(parts);
1611

1612
    if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
1613 1614 1615
        if (ambiguous) {
            *ambiguous = false;
        }
1616 1617
        obj = object_resolve_partial_path(object_get_root(), parts,
                                          typename, ambiguous);
1618
    } else {
1619
        obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1620 1621 1622 1623 1624 1625 1626
    }

    g_strfreev(parts);

    return obj;
}

1627 1628 1629 1630 1631
Object *object_resolve_path(const char *path, bool *ambiguous)
{
    return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
}

1632 1633 1634 1635 1636 1637
typedef struct StringProperty
{
    char *(*get)(Object *, Error **);
    void (*set)(Object *, const char *, Error **);
} StringProperty;

1638 1639
static void property_get_str(Object *obj, Visitor *v, void *opaque,
                             const char *name, Error **errp)
1640 1641 1642
{
    StringProperty *prop = opaque;
    char *value;
1643
    Error *err = NULL;
1644

1645 1646 1647 1648
    value = prop->get(obj, &err);
    if (err) {
        error_propagate(errp, err);
        return;
1649
    }
1650 1651 1652

    visit_type_str(v, &value, name, errp);
    g_free(value);
1653 1654
}

1655 1656
static void property_set_str(Object *obj, Visitor *v, void *opaque,
                             const char *name, Error **errp)
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
{
    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);
}

1672 1673
static void property_release_str(Object *obj, const char *name,
                                 void *opaque)
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683
{
    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)
{
1684
    Error *local_err = NULL;
1685 1686 1687 1688 1689 1690
    StringProperty *prop = g_malloc0(sizeof(*prop));

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

    object_property_add(obj, name, "string",
1691 1692 1693
                        get ? property_get_str : NULL,
                        set ? property_set_str : NULL,
                        property_release_str,
1694 1695 1696 1697 1698
                        prop, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
    }
1699
}
P
Paolo Bonzini 已提交
1700

1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711
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;
1712 1713 1714 1715 1716 1717 1718
    Error *err = NULL;

    value = prop->get(obj, &err);
    if (err) {
        error_propagate(errp, err);
        return;
    }
1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750

    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)
{
1751
    Error *local_err = NULL;
1752 1753 1754 1755 1756 1757 1758 1759 1760
    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,
1761 1762 1763 1764 1765
                        prop, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
    }
1766 1767
}

1768 1769 1770 1771 1772
static void property_get_enum(Object *obj, Visitor *v, void *opaque,
                              const char *name, Error **errp)
{
    EnumProperty *prop = opaque;
    int value;
1773 1774 1775 1776 1777 1778 1779
    Error *err = NULL;

    value = prop->get(obj, &err);
    if (err) {
        error_propagate(errp, err);
        return;
    }
1780 1781 1782 1783 1784 1785 1786 1787 1788

    visit_type_enum(v, &value, prop->strings, NULL, name, errp);
}

static void property_set_enum(Object *obj, Visitor *v, void *opaque,
                              const char *name, Error **errp)
{
    EnumProperty *prop = opaque;
    int value;
1789
    Error *err = NULL;
1790

1791 1792 1793 1794 1795
    visit_type_enum(v, &value, prop->strings, NULL, name, &err);
    if (err) {
        error_propagate(errp, err);
        return;
    }
1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830
    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);
    }
}

1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909
typedef struct TMProperty {
    void (*get)(Object *, struct tm *, Error **);
} TMProperty;

static void property_get_tm(Object *obj, Visitor *v, void *opaque,
                            const char *name, Error **errp)
{
    TMProperty *prop = opaque;
    Error *err = NULL;
    struct tm value;

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

    visit_start_struct(v, NULL, "struct tm", name, 0, &err);
    if (err) {
        goto out;
    }
    visit_type_int32(v, &value.tm_year, "tm_year", &err);
    if (err) {
        goto out_end;
    }
    visit_type_int32(v, &value.tm_mon, "tm_mon", &err);
    if (err) {
        goto out_end;
    }
    visit_type_int32(v, &value.tm_mday, "tm_mday", &err);
    if (err) {
        goto out_end;
    }
    visit_type_int32(v, &value.tm_hour, "tm_hour", &err);
    if (err) {
        goto out_end;
    }
    visit_type_int32(v, &value.tm_min, "tm_min", &err);
    if (err) {
        goto out_end;
    }
    visit_type_int32(v, &value.tm_sec, "tm_sec", &err);
    if (err) {
        goto out_end;
    }
out_end:
    error_propagate(errp, err);
    err = NULL;
    visit_end_struct(v, errp);
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);
    }
}

1910 1911 1912 1913 1914
static char *qdev_get_type(Object *obj, Error **errp)
{
    return g_strdup(object_get_typename(obj));
}

1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 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 1973 1974
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);
}

1975 1976
typedef struct {
    Object *target_obj;
1977
    char *target_name;
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995
} AliasProperty;

static void property_get_alias(Object *obj, struct Visitor *v, void *opaque,
                               const char *name, Error **errp)
{
    AliasProperty *prop = opaque;

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

static void property_set_alias(Object *obj, struct Visitor *v, void *opaque,
                               const char *name, Error **errp)
{
    AliasProperty *prop = opaque;

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

1996 1997 1998 1999 2000 2001 2002 2003
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);
}

2004 2005 2006 2007
static void property_release_alias(Object *obj, const char *name, void *opaque)
{
    AliasProperty *prop = opaque;

2008
    g_free(prop->target_name);
2009 2010 2011 2012 2013 2014 2015 2016
    g_free(prop);
}

void object_property_add_alias(Object *obj, const char *name,
                               Object *target_obj, const char *target_name,
                               Error **errp)
{
    AliasProperty *prop;
2017
    ObjectProperty *op;
2018
    ObjectProperty *target_prop;
2019
    gchar *prop_type;
2020
    Error *local_err = NULL;
2021 2022 2023 2024 2025 2026

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

2027 2028 2029 2030 2031 2032 2033
    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);
    }

2034 2035
    prop = g_malloc(sizeof(*prop));
    prop->target_obj = target_obj;
2036
    prop->target_name = g_strdup(target_name);
2037

2038
    op = object_property_add(obj, name, prop_type,
2039 2040 2041
                             property_get_alias,
                             property_set_alias,
                             property_release_alias,
2042 2043 2044 2045 2046 2047
                             prop, &local_err);
    if (local_err) {
        error_propagate(errp, local_err);
        g_free(prop);
        goto out;
    }
2048
    op->resolve = property_resolve_alias;
2049

2050
    object_property_set_description(obj, op->name,
2051 2052 2053
                                    target_prop->description,
                                    &error_abort);

2054
out:
2055
    g_free(prop_type);
2056 2057
}

2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071
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);
}

2072 2073 2074 2075 2076
static void object_instance_init(Object *obj)
{
    object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
}

P
Paolo Bonzini 已提交
2077 2078 2079 2080
static void register_types(void)
{
    static TypeInfo interface_info = {
        .name = TYPE_INTERFACE,
A
Anthony Liguori 已提交
2081
        .class_size = sizeof(InterfaceClass),
P
Paolo Bonzini 已提交
2082 2083 2084 2085 2086 2087
        .abstract = true,
    };

    static TypeInfo object_info = {
        .name = TYPE_OBJECT,
        .instance_size = sizeof(Object),
2088
        .instance_init = object_instance_init,
P
Paolo Bonzini 已提交
2089 2090 2091
        .abstract = true,
    };

2092 2093
    type_interface = type_register_internal(&interface_info);
    type_register_internal(&object_info);
P
Paolo Bonzini 已提交
2094 2095 2096
}

type_init(register_types)