qemu/qom/object.c
<<
>>
Prefs
   1/*
   2 * QEMU Object Model
   3 *
   4 * Copyright IBM, Corp. 2011
   5 *
   6 * Authors:
   7 *  Anthony Liguori   <aliguori@us.ibm.com>
   8 *
   9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
  10 * See the COPYING file in the top-level directory.
  11 */
  12
  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#include "qapi/string-input-visitor.h"
  21#include "qapi/string-output-visitor.h"
  22#include "qapi/qmp/qerror.h"
  23#include "trace.h"
  24
  25/* TODO: replace QObject with a simpler visitor to avoid a dependency
  26 * of the QOM core on QObject?  */
  27#include "qom/qom-qobject.h"
  28#include "qapi/qmp/qobject.h"
  29#include "qapi/qmp/qbool.h"
  30#include "qapi/qmp/qstring.h"
  31
  32#define MAX_INTERFACES 32
  33
  34typedef struct InterfaceImpl InterfaceImpl;
  35typedef struct TypeImpl TypeImpl;
  36
  37struct InterfaceImpl
  38{
  39    const char *typename;
  40};
  41
  42struct TypeImpl
  43{
  44    const char *name;
  45
  46    size_t class_size;
  47
  48    size_t instance_size;
  49
  50    void (*class_init)(ObjectClass *klass, void *data);
  51    void (*class_base_init)(ObjectClass *klass, void *data);
  52    void (*class_finalize)(ObjectClass *klass, void *data);
  53
  54    void *class_data;
  55
  56    void (*instance_init)(Object *obj);
  57    void (*instance_post_init)(Object *obj);
  58    void (*instance_finalize)(Object *obj);
  59
  60    bool abstract;
  61
  62    const char *parent;
  63    TypeImpl *parent_type;
  64
  65    ObjectClass *class;
  66
  67    int num_interfaces;
  68    InterfaceImpl interfaces[MAX_INTERFACES];
  69};
  70
  71static Type type_interface;
  72
  73static GHashTable *type_table_get(void)
  74{
  75    static GHashTable *type_table;
  76
  77    if (type_table == NULL) {
  78        type_table = g_hash_table_new(g_str_hash, g_str_equal);
  79    }
  80
  81    return type_table;
  82}
  83
  84static bool enumerating_types;
  85
  86static void type_table_add(TypeImpl *ti)
  87{
  88    assert(!enumerating_types);
  89    g_hash_table_insert(type_table_get(), (void *)ti->name, ti);
  90}
  91
  92static TypeImpl *type_table_lookup(const char *name)
  93{
  94    return g_hash_table_lookup(type_table_get(), name);
  95}
  96
  97static TypeImpl *type_new(const TypeInfo *info)
  98{
  99    TypeImpl *ti = g_malloc0(sizeof(*ti));
 100    int i;
 101
 102    g_assert(info->name != NULL);
 103
 104    if (type_table_lookup(info->name) != NULL) {
 105        fprintf(stderr, "Registering `%s' which already exists\n", info->name);
 106        abort();
 107    }
 108
 109    ti->name = g_strdup(info->name);
 110    ti->parent = g_strdup(info->parent);
 111
 112    ti->class_size = info->class_size;
 113    ti->instance_size = info->instance_size;
 114
 115    ti->class_init = info->class_init;
 116    ti->class_base_init = info->class_base_init;
 117    ti->class_finalize = info->class_finalize;
 118    ti->class_data = info->class_data;
 119
 120    ti->instance_init = info->instance_init;
 121    ti->instance_post_init = info->instance_post_init;
 122    ti->instance_finalize = info->instance_finalize;
 123
 124    ti->abstract = info->abstract;
 125
 126    for (i = 0; info->interfaces && info->interfaces[i].type; i++) {
 127        ti->interfaces[i].typename = g_strdup(info->interfaces[i].type);
 128    }
 129    ti->num_interfaces = i;
 130
 131    return ti;
 132}
 133
 134static TypeImpl *type_register_internal(const TypeInfo *info)
 135{
 136    TypeImpl *ti;
 137    ti = type_new(info);
 138
 139    type_table_add(ti);
 140    return ti;
 141}
 142
 143TypeImpl *type_register(const TypeInfo *info)
 144{
 145    assert(info->parent);
 146    return type_register_internal(info);
 147}
 148
 149TypeImpl *type_register_static(const TypeInfo *info)
 150{
 151    return type_register(info);
 152}
 153
 154void type_register_static_array(const TypeInfo *infos, int nr_infos)
 155{
 156    int i;
 157
 158    for (i = 0; i < nr_infos; i++) {
 159        type_register_static(&infos[i]);
 160    }
 161}
 162
 163static TypeImpl *type_get_by_name(const char *name)
 164{
 165    if (name == NULL) {
 166        return NULL;
 167    }
 168
 169    return type_table_lookup(name);
 170}
 171
 172static TypeImpl *type_get_parent(TypeImpl *type)
 173{
 174    if (!type->parent_type && type->parent) {
 175        type->parent_type = type_get_by_name(type->parent);
 176        g_assert(type->parent_type != NULL);
 177    }
 178
 179    return type->parent_type;
 180}
 181
 182static bool type_has_parent(TypeImpl *type)
 183{
 184    return (type->parent != NULL);
 185}
 186
 187static size_t type_class_get_size(TypeImpl *ti)
 188{
 189    if (ti->class_size) {
 190        return ti->class_size;
 191    }
 192
 193    if (type_has_parent(ti)) {
 194        return type_class_get_size(type_get_parent(ti));
 195    }
 196
 197    return sizeof(ObjectClass);
 198}
 199
 200static size_t type_object_get_size(TypeImpl *ti)
 201{
 202    if (ti->instance_size) {
 203        return ti->instance_size;
 204    }
 205
 206    if (type_has_parent(ti)) {
 207        return type_object_get_size(type_get_parent(ti));
 208    }
 209
 210    return 0;
 211}
 212
 213size_t object_type_get_instance_size(const char *typename)
 214{
 215    TypeImpl *type = type_get_by_name(typename);
 216
 217    g_assert(type != NULL);
 218    return type_object_get_size(type);
 219}
 220
 221static bool type_is_ancestor(TypeImpl *type, TypeImpl *target_type)
 222{
 223    assert(target_type);
 224
 225    /* Check if target_type is a direct ancestor of type */
 226    while (type) {
 227        if (type == target_type) {
 228            return true;
 229        }
 230
 231        type = type_get_parent(type);
 232    }
 233
 234    return false;
 235}
 236
 237static void type_initialize(TypeImpl *ti);
 238
 239static void type_initialize_interface(TypeImpl *ti, TypeImpl *interface_type,
 240                                      TypeImpl *parent_type)
 241{
 242    InterfaceClass *new_iface;
 243    TypeInfo info = { };
 244    TypeImpl *iface_impl;
 245
 246    info.parent = parent_type->name;
 247    info.name = g_strdup_printf("%s::%s", ti->name, interface_type->name);
 248    info.abstract = true;
 249
 250    iface_impl = type_new(&info);
 251    iface_impl->parent_type = parent_type;
 252    type_initialize(iface_impl);
 253    g_free((char *)info.name);
 254
 255    new_iface = (InterfaceClass *)iface_impl->class;
 256    new_iface->concrete_class = ti->class;
 257    new_iface->interface_type = interface_type;
 258
 259    ti->class->interfaces = g_slist_append(ti->class->interfaces,
 260                                           iface_impl->class);
 261}
 262
 263static void object_property_free(gpointer data)
 264{
 265    ObjectProperty *prop = data;
 266
 267    g_free(prop->name);
 268    g_free(prop->type);
 269    g_free(prop->description);
 270    g_free(prop);
 271}
 272
 273static void type_initialize(TypeImpl *ti)
 274{
 275    TypeImpl *parent;
 276
 277    if (ti->class) {
 278        return;
 279    }
 280
 281    ti->class_size = type_class_get_size(ti);
 282    ti->instance_size = type_object_get_size(ti);
 283    /* Any type with zero instance_size is implicitly abstract.
 284     * This means interface types are all abstract.
 285     */
 286    if (ti->instance_size == 0) {
 287        ti->abstract = true;
 288    }
 289
 290    ti->class = g_malloc0(ti->class_size);
 291
 292    parent = type_get_parent(ti);
 293    if (parent) {
 294        type_initialize(parent);
 295        GSList *e;
 296        int i;
 297
 298        g_assert_cmpint(parent->class_size, <=, ti->class_size);
 299        memcpy(ti->class, parent->class, parent->class_size);
 300        ti->class->interfaces = NULL;
 301        ti->class->properties = g_hash_table_new_full(
 302            g_str_hash, g_str_equal, g_free, object_property_free);
 303
 304        for (e = parent->class->interfaces; e; e = e->next) {
 305            InterfaceClass *iface = e->data;
 306            ObjectClass *klass = OBJECT_CLASS(iface);
 307
 308            type_initialize_interface(ti, iface->interface_type, klass->type);
 309        }
 310
 311        for (i = 0; i < ti->num_interfaces; i++) {
 312            TypeImpl *t = type_get_by_name(ti->interfaces[i].typename);
 313            for (e = ti->class->interfaces; e; e = e->next) {
 314                TypeImpl *target_type = OBJECT_CLASS(e->data)->type;
 315
 316                if (type_is_ancestor(target_type, t)) {
 317                    break;
 318                }
 319            }
 320
 321            if (e) {
 322                continue;
 323            }
 324
 325            type_initialize_interface(ti, t, t);
 326        }
 327    } else {
 328        ti->class->properties = g_hash_table_new_full(
 329            g_str_hash, g_str_equal, g_free, object_property_free);
 330    }
 331
 332    ti->class->type = ti;
 333
 334    while (parent) {
 335        if (parent->class_base_init) {
 336            parent->class_base_init(ti->class, ti->class_data);
 337        }
 338        parent = type_get_parent(parent);
 339    }
 340
 341    if (ti->class_init) {
 342        ti->class_init(ti->class, ti->class_data);
 343    }
 344}
 345
 346static void object_init_with_type(Object *obj, TypeImpl *ti)
 347{
 348    if (type_has_parent(ti)) {
 349        object_init_with_type(obj, type_get_parent(ti));
 350    }
 351
 352    if (ti->instance_init) {
 353        ti->instance_init(obj);
 354    }
 355}
 356
 357static void object_post_init_with_type(Object *obj, TypeImpl *ti)
 358{
 359    if (ti->instance_post_init) {
 360        ti->instance_post_init(obj);
 361    }
 362
 363    if (type_has_parent(ti)) {
 364        object_post_init_with_type(obj, type_get_parent(ti));
 365    }
 366}
 367
 368static void object_initialize_with_type(void *data, size_t size, TypeImpl *type)
 369{
 370    Object *obj = data;
 371
 372    g_assert(type != NULL);
 373    type_initialize(type);
 374
 375    g_assert_cmpint(type->instance_size, >=, sizeof(Object));
 376    g_assert(type->abstract == false);
 377    g_assert_cmpint(size, >=, type->instance_size);
 378
 379    memset(obj, 0, type->instance_size);
 380    obj->class = type->class;
 381    object_ref(obj);
 382    obj->properties = g_hash_table_new_full(g_str_hash, g_str_equal,
 383                                            NULL, object_property_free);
 384    object_init_with_type(obj, type);
 385    object_post_init_with_type(obj, type);
 386}
 387
 388void object_initialize(void *data, size_t size, const char *typename)
 389{
 390    TypeImpl *type = type_get_by_name(typename);
 391
 392    object_initialize_with_type(data, size, type);
 393}
 394
 395static inline bool object_property_is_child(ObjectProperty *prop)
 396{
 397    return strstart(prop->type, "child<", NULL);
 398}
 399
 400static void object_property_del_all(Object *obj)
 401{
 402    ObjectProperty *prop;
 403    GHashTableIter iter;
 404    gpointer key, value;
 405    bool released;
 406
 407    do {
 408        released = false;
 409        g_hash_table_iter_init(&iter, obj->properties);
 410        while (g_hash_table_iter_next(&iter, &key, &value)) {
 411            prop = value;
 412            if (prop->release) {
 413                prop->release(obj, prop->name, prop->opaque);
 414                prop->release = NULL;
 415                released = true;
 416                break;
 417            }
 418            g_hash_table_iter_remove(&iter);
 419        }
 420    } while (released);
 421
 422    g_hash_table_unref(obj->properties);
 423}
 424
 425static void object_property_del_child(Object *obj, Object *child, Error **errp)
 426{
 427    ObjectProperty *prop;
 428    GHashTableIter iter;
 429    gpointer key, value;
 430
 431    g_hash_table_iter_init(&iter, obj->properties);
 432    while (g_hash_table_iter_next(&iter, &key, &value)) {
 433        prop = value;
 434        if (object_property_is_child(prop) && prop->opaque == child) {
 435            if (prop->release) {
 436                prop->release(obj, prop->name, prop->opaque);
 437                prop->release = NULL;
 438            }
 439            break;
 440        }
 441    }
 442    g_hash_table_iter_init(&iter, obj->properties);
 443    while (g_hash_table_iter_next(&iter, &key, &value)) {
 444        prop = value;
 445        if (object_property_is_child(prop) && prop->opaque == child) {
 446            g_hash_table_iter_remove(&iter);
 447            break;
 448        }
 449    }
 450}
 451
 452void object_unparent(Object *obj)
 453{
 454    if (obj->parent) {
 455        object_property_del_child(obj->parent, obj, NULL);
 456    }
 457}
 458
 459static void object_deinit(Object *obj, TypeImpl *type)
 460{
 461    if (type->instance_finalize) {
 462        type->instance_finalize(obj);
 463    }
 464
 465    if (type_has_parent(type)) {
 466        object_deinit(obj, type_get_parent(type));
 467    }
 468}
 469
 470static void object_finalize(void *data)
 471{
 472    Object *obj = data;
 473    TypeImpl *ti = obj->class->type;
 474
 475    object_property_del_all(obj);
 476    object_deinit(obj, ti);
 477
 478    g_assert_cmpint(obj->ref, ==, 0);
 479    if (obj->free) {
 480        obj->free(obj);
 481    }
 482}
 483
 484static Object *object_new_with_type(Type type)
 485{
 486    Object *obj;
 487
 488    g_assert(type != NULL);
 489    type_initialize(type);
 490
 491    obj = g_malloc(type->instance_size);
 492    object_initialize_with_type(obj, type->instance_size, type);
 493    obj->free = g_free;
 494
 495    return obj;
 496}
 497
 498Object *object_new(const char *typename)
 499{
 500    TypeImpl *ti = type_get_by_name(typename);
 501
 502    return object_new_with_type(ti);
 503}
 504
 505
 506Object *object_new_with_props(const char *typename,
 507                              Object *parent,
 508                              const char *id,
 509                              Error **errp,
 510                              ...)
 511{
 512    va_list vargs;
 513    Object *obj;
 514
 515    va_start(vargs, errp);
 516    obj = object_new_with_propv(typename, parent, id, errp, vargs);
 517    va_end(vargs);
 518
 519    return obj;
 520}
 521
 522
 523Object *object_new_with_propv(const char *typename,
 524                              Object *parent,
 525                              const char *id,
 526                              Error **errp,
 527                              va_list vargs)
 528{
 529    Object *obj;
 530    ObjectClass *klass;
 531    Error *local_err = NULL;
 532
 533    klass = object_class_by_name(typename);
 534    if (!klass) {
 535        error_setg(errp, "invalid object type: %s", typename);
 536        return NULL;
 537    }
 538
 539    if (object_class_is_abstract(klass)) {
 540        error_setg(errp, "object type '%s' is abstract", typename);
 541        return NULL;
 542    }
 543    obj = object_new(typename);
 544
 545    if (object_set_propv(obj, &local_err, vargs) < 0) {
 546        goto error;
 547    }
 548
 549    object_property_add_child(parent, id, obj, &local_err);
 550    if (local_err) {
 551        goto error;
 552    }
 553
 554    if (object_dynamic_cast(obj, TYPE_USER_CREATABLE)) {
 555        user_creatable_complete(obj, &local_err);
 556        if (local_err) {
 557            object_unparent(obj);
 558            goto error;
 559        }
 560    }
 561
 562    object_unref(OBJECT(obj));
 563    return obj;
 564
 565 error:
 566    error_propagate(errp, local_err);
 567    object_unref(obj);
 568    return NULL;
 569}
 570
 571
 572int object_set_props(Object *obj,
 573                     Error **errp,
 574                     ...)
 575{
 576    va_list vargs;
 577    int ret;
 578
 579    va_start(vargs, errp);
 580    ret = object_set_propv(obj, errp, vargs);
 581    va_end(vargs);
 582
 583    return ret;
 584}
 585
 586
 587int object_set_propv(Object *obj,
 588                     Error **errp,
 589                     va_list vargs)
 590{
 591    const char *propname;
 592    Error *local_err = NULL;
 593
 594    propname = va_arg(vargs, char *);
 595    while (propname != NULL) {
 596        const char *value = va_arg(vargs, char *);
 597
 598        g_assert(value != NULL);
 599        object_property_parse(obj, value, propname, &local_err);
 600        if (local_err) {
 601            error_propagate(errp, local_err);
 602            return -1;
 603        }
 604        propname = va_arg(vargs, char *);
 605    }
 606
 607    return 0;
 608}
 609
 610
 611Object *object_dynamic_cast(Object *obj, const char *typename)
 612{
 613    if (obj && object_class_dynamic_cast(object_get_class(obj), typename)) {
 614        return obj;
 615    }
 616
 617    return NULL;
 618}
 619
 620Object *object_dynamic_cast_assert(Object *obj, const char *typename,
 621                                   const char *file, int line, const char *func)
 622{
 623    trace_object_dynamic_cast_assert(obj ? obj->class->type->name : "(null)",
 624                                     typename, file, line, func);
 625
 626#ifdef CONFIG_QOM_CAST_DEBUG
 627    int i;
 628    Object *inst;
 629
 630    for (i = 0; obj && i < OBJECT_CLASS_CAST_CACHE; i++) {
 631        if (atomic_read(&obj->class->object_cast_cache[i]) == typename) {
 632            goto out;
 633        }
 634    }
 635
 636    inst = object_dynamic_cast(obj, typename);
 637
 638    if (!inst && obj) {
 639        fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
 640                file, line, func, obj, typename);
 641        abort();
 642    }
 643
 644    assert(obj == inst);
 645
 646    if (obj && obj == inst) {
 647        for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
 648            atomic_set(&obj->class->object_cast_cache[i - 1],
 649                       atomic_read(&obj->class->object_cast_cache[i]));
 650        }
 651        atomic_set(&obj->class->object_cast_cache[i - 1], typename);
 652    }
 653
 654out:
 655#endif
 656    return obj;
 657}
 658
 659ObjectClass *object_class_dynamic_cast(ObjectClass *class,
 660                                       const char *typename)
 661{
 662    ObjectClass *ret = NULL;
 663    TypeImpl *target_type;
 664    TypeImpl *type;
 665
 666    if (!class) {
 667        return NULL;
 668    }
 669
 670    /* A simple fast path that can trigger a lot for leaf classes.  */
 671    type = class->type;
 672    if (type->name == typename) {
 673        return class;
 674    }
 675
 676    target_type = type_get_by_name(typename);
 677    if (!target_type) {
 678        /* target class type unknown, so fail the cast */
 679        return NULL;
 680    }
 681
 682    if (type->class->interfaces &&
 683            type_is_ancestor(target_type, type_interface)) {
 684        int found = 0;
 685        GSList *i;
 686
 687        for (i = class->interfaces; i; i = i->next) {
 688            ObjectClass *target_class = i->data;
 689
 690            if (type_is_ancestor(target_class->type, target_type)) {
 691                ret = target_class;
 692                found++;
 693            }
 694         }
 695
 696        /* The match was ambiguous, don't allow a cast */
 697        if (found > 1) {
 698            ret = NULL;
 699        }
 700    } else if (type_is_ancestor(type, target_type)) {
 701        ret = class;
 702    }
 703
 704    return ret;
 705}
 706
 707ObjectClass *object_class_dynamic_cast_assert(ObjectClass *class,
 708                                              const char *typename,
 709                                              const char *file, int line,
 710                                              const char *func)
 711{
 712    ObjectClass *ret;
 713
 714    trace_object_class_dynamic_cast_assert(class ? class->type->name : "(null)",
 715                                           typename, file, line, func);
 716
 717#ifdef CONFIG_QOM_CAST_DEBUG
 718    int i;
 719
 720    for (i = 0; class && i < OBJECT_CLASS_CAST_CACHE; i++) {
 721        if (atomic_read(&class->class_cast_cache[i]) == typename) {
 722            ret = class;
 723            goto out;
 724        }
 725    }
 726#else
 727    if (!class || !class->interfaces) {
 728        return class;
 729    }
 730#endif
 731
 732    ret = object_class_dynamic_cast(class, typename);
 733    if (!ret && class) {
 734        fprintf(stderr, "%s:%d:%s: Object %p is not an instance of type %s\n",
 735                file, line, func, class, typename);
 736        abort();
 737    }
 738
 739#ifdef CONFIG_QOM_CAST_DEBUG
 740    if (class && ret == class) {
 741        for (i = 1; i < OBJECT_CLASS_CAST_CACHE; i++) {
 742            atomic_set(&class->class_cast_cache[i - 1],
 743                       atomic_read(&class->class_cast_cache[i]));
 744        }
 745        atomic_set(&class->class_cast_cache[i - 1], typename);
 746    }
 747out:
 748#endif
 749    return ret;
 750}
 751
 752const char *object_get_typename(const Object *obj)
 753{
 754    return obj->class->type->name;
 755}
 756
 757ObjectClass *object_get_class(Object *obj)
 758{
 759    return obj->class;
 760}
 761
 762bool object_class_is_abstract(ObjectClass *klass)
 763{
 764    return klass->type->abstract;
 765}
 766
 767const char *object_class_get_name(ObjectClass *klass)
 768{
 769    return klass->type->name;
 770}
 771
 772ObjectClass *object_class_by_name(const char *typename)
 773{
 774    TypeImpl *type = type_get_by_name(typename);
 775
 776    if (!type) {
 777        return NULL;
 778    }
 779
 780    type_initialize(type);
 781
 782    return type->class;
 783}
 784
 785ObjectClass *object_class_get_parent(ObjectClass *class)
 786{
 787    TypeImpl *type = type_get_parent(class->type);
 788
 789    if (!type) {
 790        return NULL;
 791    }
 792
 793    type_initialize(type);
 794
 795    return type->class;
 796}
 797
 798typedef struct OCFData
 799{
 800    void (*fn)(ObjectClass *klass, void *opaque);
 801    const char *implements_type;
 802    bool include_abstract;
 803    void *opaque;
 804} OCFData;
 805
 806static void object_class_foreach_tramp(gpointer key, gpointer value,
 807                                       gpointer opaque)
 808{
 809    OCFData *data = opaque;
 810    TypeImpl *type = value;
 811    ObjectClass *k;
 812
 813    type_initialize(type);
 814    k = type->class;
 815
 816    if (!data->include_abstract && type->abstract) {
 817        return;
 818    }
 819
 820    if (data->implements_type && 
 821        !object_class_dynamic_cast(k, data->implements_type)) {
 822        return;
 823    }
 824
 825    data->fn(k, data->opaque);
 826}
 827
 828void object_class_foreach(void (*fn)(ObjectClass *klass, void *opaque),
 829                          const char *implements_type, bool include_abstract,
 830                          void *opaque)
 831{
 832    OCFData data = { fn, implements_type, include_abstract, opaque };
 833
 834    enumerating_types = true;
 835    g_hash_table_foreach(type_table_get(), object_class_foreach_tramp, &data);
 836    enumerating_types = false;
 837}
 838
 839static int do_object_child_foreach(Object *obj,
 840                                   int (*fn)(Object *child, void *opaque),
 841                                   void *opaque, bool recurse)
 842{
 843    GHashTableIter iter;
 844    ObjectProperty *prop;
 845    int ret = 0;
 846
 847    g_hash_table_iter_init(&iter, obj->properties);
 848    while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
 849        if (object_property_is_child(prop)) {
 850            Object *child = prop->opaque;
 851
 852            ret = fn(child, opaque);
 853            if (ret != 0) {
 854                break;
 855            }
 856            if (recurse) {
 857                do_object_child_foreach(child, fn, opaque, true);
 858            }
 859        }
 860    }
 861    return ret;
 862}
 863
 864int object_child_foreach(Object *obj, int (*fn)(Object *child, void *opaque),
 865                         void *opaque)
 866{
 867    return do_object_child_foreach(obj, fn, opaque, false);
 868}
 869
 870int object_child_foreach_recursive(Object *obj,
 871                                   int (*fn)(Object *child, void *opaque),
 872                                   void *opaque)
 873{
 874    return do_object_child_foreach(obj, fn, opaque, true);
 875}
 876
 877static void object_class_get_list_tramp(ObjectClass *klass, void *opaque)
 878{
 879    GSList **list = opaque;
 880
 881    *list = g_slist_prepend(*list, klass);
 882}
 883
 884GSList *object_class_get_list(const char *implements_type,
 885                              bool include_abstract)
 886{
 887    GSList *list = NULL;
 888
 889    object_class_foreach(object_class_get_list_tramp,
 890                         implements_type, include_abstract, &list);
 891    return list;
 892}
 893
 894void object_ref(Object *obj)
 895{
 896    if (!obj) {
 897        return;
 898    }
 899    atomic_inc(&obj->ref);
 900}
 901
 902void object_unref(Object *obj)
 903{
 904    if (!obj) {
 905        return;
 906    }
 907    g_assert_cmpint(obj->ref, >, 0);
 908
 909    /* parent always holds a reference to its children */
 910    if (atomic_fetch_dec(&obj->ref) == 1) {
 911        object_finalize(obj);
 912    }
 913}
 914
 915ObjectProperty *
 916object_property_add(Object *obj, const char *name, const char *type,
 917                    ObjectPropertyAccessor *get,
 918                    ObjectPropertyAccessor *set,
 919                    ObjectPropertyRelease *release,
 920                    void *opaque, Error **errp)
 921{
 922    ObjectProperty *prop;
 923    size_t name_len = strlen(name);
 924
 925    if (name_len >= 3 && !memcmp(name + name_len - 3, "[*]", 4)) {
 926        int i;
 927        ObjectProperty *ret;
 928        char *name_no_array = g_strdup(name);
 929
 930        name_no_array[name_len - 3] = '\0';
 931        for (i = 0; ; ++i) {
 932            char *full_name = g_strdup_printf("%s[%d]", name_no_array, i);
 933
 934            ret = object_property_add(obj, full_name, type, get, set,
 935                                      release, opaque, NULL);
 936            g_free(full_name);
 937            if (ret) {
 938                break;
 939            }
 940        }
 941        g_free(name_no_array);
 942        return ret;
 943    }
 944
 945    if (object_property_find(obj, name, NULL) != NULL) {
 946        error_setg(errp, "attempt to add duplicate property '%s'"
 947                   " to object (type '%s')", name,
 948                   object_get_typename(obj));
 949        return NULL;
 950    }
 951
 952    prop = g_malloc0(sizeof(*prop));
 953
 954    prop->name = g_strdup(name);
 955    prop->type = g_strdup(type);
 956
 957    prop->get = get;
 958    prop->set = set;
 959    prop->release = release;
 960    prop->opaque = opaque;
 961
 962    g_hash_table_insert(obj->properties, prop->name, prop);
 963    return prop;
 964}
 965
 966ObjectProperty *
 967object_class_property_add(ObjectClass *klass,
 968                          const char *name,
 969                          const char *type,
 970                          ObjectPropertyAccessor *get,
 971                          ObjectPropertyAccessor *set,
 972                          ObjectPropertyRelease *release,
 973                          void *opaque,
 974                          Error **errp)
 975{
 976    ObjectProperty *prop;
 977
 978    if (object_class_property_find(klass, name, NULL) != NULL) {
 979        error_setg(errp, "attempt to add duplicate property '%s'"
 980                   " to object (type '%s')", name,
 981                   object_class_get_name(klass));
 982        return NULL;
 983    }
 984
 985    prop = g_malloc0(sizeof(*prop));
 986
 987    prop->name = g_strdup(name);
 988    prop->type = g_strdup(type);
 989
 990    prop->get = get;
 991    prop->set = set;
 992    prop->release = release;
 993    prop->opaque = opaque;
 994
 995    g_hash_table_insert(klass->properties, g_strdup(name), prop);
 996
 997    return prop;
 998}
 999
1000ObjectProperty *object_property_find(Object *obj, const char *name,
1001                                     Error **errp)
1002{
1003    ObjectProperty *prop;
1004    ObjectClass *klass = object_get_class(obj);
1005
1006    prop = object_class_property_find(klass, name, NULL);
1007    if (prop) {
1008        return prop;
1009    }
1010
1011    prop = g_hash_table_lookup(obj->properties, name);
1012    if (prop) {
1013        return prop;
1014    }
1015
1016    error_setg(errp, "Property '.%s' not found", name);
1017    return NULL;
1018}
1019
1020void object_property_iter_init(ObjectPropertyIterator *iter,
1021                               Object *obj)
1022{
1023    g_hash_table_iter_init(&iter->iter, obj->properties);
1024    iter->nextclass = object_get_class(obj);
1025}
1026
1027ObjectProperty *object_property_iter_next(ObjectPropertyIterator *iter)
1028{
1029    gpointer key, val;
1030    while (!g_hash_table_iter_next(&iter->iter, &key, &val)) {
1031        if (!iter->nextclass) {
1032            return NULL;
1033        }
1034        g_hash_table_iter_init(&iter->iter, iter->nextclass->properties);
1035        iter->nextclass = object_class_get_parent(iter->nextclass);
1036    }
1037    return val;
1038}
1039
1040ObjectProperty *object_class_property_find(ObjectClass *klass, const char *name,
1041                                           Error **errp)
1042{
1043    ObjectProperty *prop;
1044    ObjectClass *parent_klass;
1045
1046    parent_klass = object_class_get_parent(klass);
1047    if (parent_klass) {
1048        prop = object_class_property_find(parent_klass, name, NULL);
1049        if (prop) {
1050            return prop;
1051        }
1052    }
1053
1054    prop = g_hash_table_lookup(klass->properties, name);
1055    if (!prop) {
1056        error_setg(errp, "Property '.%s' not found", name);
1057    }
1058    return prop;
1059}
1060
1061void object_property_del(Object *obj, const char *name, Error **errp)
1062{
1063    ObjectProperty *prop = g_hash_table_lookup(obj->properties, name);
1064
1065    if (!prop) {
1066        error_setg(errp, "Property '.%s' not found", name);
1067        return;
1068    }
1069
1070    if (prop->release) {
1071        prop->release(obj, name, prop->opaque);
1072    }
1073    g_hash_table_remove(obj->properties, name);
1074}
1075
1076void object_property_get(Object *obj, Visitor *v, const char *name,
1077                         Error **errp)
1078{
1079    ObjectProperty *prop = object_property_find(obj, name, errp);
1080    if (prop == NULL) {
1081        return;
1082    }
1083
1084    if (!prop->get) {
1085        error_setg(errp, QERR_PERMISSION_DENIED);
1086    } else {
1087        prop->get(obj, v, name, prop->opaque, errp);
1088    }
1089}
1090
1091void object_property_set(Object *obj, Visitor *v, const char *name,
1092                         Error **errp)
1093{
1094    ObjectProperty *prop = object_property_find(obj, name, errp);
1095    if (prop == NULL) {
1096        return;
1097    }
1098
1099    if (!prop->set) {
1100        error_setg(errp, QERR_PERMISSION_DENIED);
1101    } else {
1102        prop->set(obj, v, name, prop->opaque, errp);
1103    }
1104}
1105
1106void object_property_set_str(Object *obj, const char *value,
1107                             const char *name, Error **errp)
1108{
1109    QString *qstr = qstring_from_str(value);
1110    object_property_set_qobject(obj, QOBJECT(qstr), name, errp);
1111
1112    QDECREF(qstr);
1113}
1114
1115char *object_property_get_str(Object *obj, const char *name,
1116                              Error **errp)
1117{
1118    QObject *ret = object_property_get_qobject(obj, name, errp);
1119    QString *qstring;
1120    char *retval;
1121
1122    if (!ret) {
1123        return NULL;
1124    }
1125    qstring = qobject_to_qstring(ret);
1126    if (!qstring) {
1127        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "string");
1128        retval = NULL;
1129    } else {
1130        retval = g_strdup(qstring_get_str(qstring));
1131    }
1132
1133    qobject_decref(ret);
1134    return retval;
1135}
1136
1137void object_property_set_link(Object *obj, Object *value,
1138                              const char *name, Error **errp)
1139{
1140    if (value) {
1141        gchar *path = object_get_canonical_path(value);
1142        object_property_set_str(obj, path, name, errp);
1143        g_free(path);
1144    } else {
1145        object_property_set_str(obj, "", name, errp);
1146    }
1147}
1148
1149Object *object_property_get_link(Object *obj, const char *name,
1150                                 Error **errp)
1151{
1152    char *str = object_property_get_str(obj, name, errp);
1153    Object *target = NULL;
1154
1155    if (str && *str) {
1156        target = object_resolve_path(str, NULL);
1157        if (!target) {
1158            error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1159                      "Device '%s' not found", str);
1160        }
1161    }
1162
1163    g_free(str);
1164    return target;
1165}
1166
1167void object_property_set_bool(Object *obj, bool value,
1168                              const char *name, Error **errp)
1169{
1170    QBool *qbool = qbool_from_bool(value);
1171    object_property_set_qobject(obj, QOBJECT(qbool), name, errp);
1172
1173    QDECREF(qbool);
1174}
1175
1176bool object_property_get_bool(Object *obj, const char *name,
1177                              Error **errp)
1178{
1179    QObject *ret = object_property_get_qobject(obj, name, errp);
1180    QBool *qbool;
1181    bool retval;
1182
1183    if (!ret) {
1184        return false;
1185    }
1186    qbool = qobject_to_qbool(ret);
1187    if (!qbool) {
1188        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "boolean");
1189        retval = false;
1190    } else {
1191        retval = qbool_get_bool(qbool);
1192    }
1193
1194    qobject_decref(ret);
1195    return retval;
1196}
1197
1198void object_property_set_int(Object *obj, int64_t value,
1199                             const char *name, Error **errp)
1200{
1201    QNum *qnum = qnum_from_int(value);
1202    object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
1203
1204    QDECREF(qnum);
1205}
1206
1207int64_t object_property_get_int(Object *obj, const char *name,
1208                                Error **errp)
1209{
1210    QObject *ret = object_property_get_qobject(obj, name, errp);
1211    QNum *qnum;
1212    int64_t retval;
1213
1214    if (!ret) {
1215        return -1;
1216    }
1217
1218    qnum = qobject_to_qnum(ret);
1219    if (!qnum || !qnum_get_try_int(qnum, &retval)) {
1220        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "int");
1221        retval = -1;
1222    }
1223
1224    qobject_decref(ret);
1225    return retval;
1226}
1227
1228void object_property_set_uint(Object *obj, uint64_t value,
1229                              const char *name, Error **errp)
1230{
1231    QNum *qnum = qnum_from_uint(value);
1232
1233    object_property_set_qobject(obj, QOBJECT(qnum), name, errp);
1234    QDECREF(qnum);
1235}
1236
1237uint64_t object_property_get_uint(Object *obj, const char *name,
1238                                  Error **errp)
1239{
1240    QObject *ret = object_property_get_qobject(obj, name, errp);
1241    QNum *qnum;
1242    uint64_t retval;
1243
1244    if (!ret) {
1245        return 0;
1246    }
1247    qnum = qobject_to_qnum(ret);
1248    if (!qnum || !qnum_get_try_uint(qnum, &retval)) {
1249        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, "uint");
1250        retval = 0;
1251    }
1252
1253    qobject_decref(ret);
1254    return retval;
1255}
1256
1257typedef struct EnumProperty {
1258    const QEnumLookup *lookup;
1259    int (*get)(Object *, Error **);
1260    void (*set)(Object *, int, Error **);
1261} EnumProperty;
1262
1263int object_property_get_enum(Object *obj, const char *name,
1264                             const char *typename, Error **errp)
1265{
1266    Error *err = NULL;
1267    Visitor *v;
1268    char *str;
1269    int ret;
1270    ObjectProperty *prop = object_property_find(obj, name, errp);
1271    EnumProperty *enumprop;
1272
1273    if (prop == NULL) {
1274        return 0;
1275    }
1276
1277    if (!g_str_equal(prop->type, typename)) {
1278        error_setg(errp, "Property %s on %s is not '%s' enum type",
1279                   name, object_class_get_name(
1280                       object_get_class(obj)), typename);
1281        return 0;
1282    }
1283
1284    enumprop = prop->opaque;
1285
1286    v = string_output_visitor_new(false, &str);
1287    object_property_get(obj, v, name, &err);
1288    if (err) {
1289        error_propagate(errp, err);
1290        visit_free(v);
1291        return 0;
1292    }
1293    visit_complete(v, &str);
1294    visit_free(v);
1295    v = string_input_visitor_new(str);
1296    visit_type_enum(v, name, &ret, enumprop->lookup, errp);
1297
1298    g_free(str);
1299    visit_free(v);
1300
1301    return ret;
1302}
1303
1304void object_property_get_uint16List(Object *obj, const char *name,
1305                                    uint16List **list, Error **errp)
1306{
1307    Error *err = NULL;
1308    Visitor *v;
1309    char *str;
1310
1311    v = string_output_visitor_new(false, &str);
1312    object_property_get(obj, v, name, &err);
1313    if (err) {
1314        error_propagate(errp, err);
1315        goto out;
1316    }
1317    visit_complete(v, &str);
1318    visit_free(v);
1319    v = string_input_visitor_new(str);
1320    visit_type_uint16List(v, NULL, list, errp);
1321
1322    g_free(str);
1323out:
1324    visit_free(v);
1325}
1326
1327void object_property_parse(Object *obj, const char *string,
1328                           const char *name, Error **errp)
1329{
1330    Visitor *v = string_input_visitor_new(string);
1331    object_property_set(obj, v, name, errp);
1332    visit_free(v);
1333}
1334
1335char *object_property_print(Object *obj, const char *name, bool human,
1336                            Error **errp)
1337{
1338    Visitor *v;
1339    char *string = NULL;
1340    Error *local_err = NULL;
1341
1342    v = string_output_visitor_new(human, &string);
1343    object_property_get(obj, v, name, &local_err);
1344    if (local_err) {
1345        error_propagate(errp, local_err);
1346        goto out;
1347    }
1348
1349    visit_complete(v, &string);
1350
1351out:
1352    visit_free(v);
1353    return string;
1354}
1355
1356const char *object_property_get_type(Object *obj, const char *name, Error **errp)
1357{
1358    ObjectProperty *prop = object_property_find(obj, name, errp);
1359    if (prop == NULL) {
1360        return NULL;
1361    }
1362
1363    return prop->type;
1364}
1365
1366Object *object_get_root(void)
1367{
1368    static Object *root;
1369
1370    if (!root) {
1371        root = object_new("container");
1372    }
1373
1374    return root;
1375}
1376
1377Object *object_get_objects_root(void)
1378{
1379    return container_get(object_get_root(), "/objects");
1380}
1381
1382Object *object_get_internal_root(void)
1383{
1384    static Object *internal_root;
1385
1386    if (!internal_root) {
1387        internal_root = object_new("container");
1388    }
1389
1390    return internal_root;
1391}
1392
1393static void object_get_child_property(Object *obj, Visitor *v,
1394                                      const char *name, void *opaque,
1395                                      Error **errp)
1396{
1397    Object *child = opaque;
1398    gchar *path;
1399
1400    path = object_get_canonical_path(child);
1401    visit_type_str(v, name, &path, errp);
1402    g_free(path);
1403}
1404
1405static Object *object_resolve_child_property(Object *parent, void *opaque, const gchar *part)
1406{
1407    return opaque;
1408}
1409
1410static void object_finalize_child_property(Object *obj, const char *name,
1411                                           void *opaque)
1412{
1413    Object *child = opaque;
1414
1415    if (child->class->unparent) {
1416        (child->class->unparent)(child);
1417    }
1418    child->parent = NULL;
1419    object_unref(child);
1420}
1421
1422void object_property_add_child(Object *obj, const char *name,
1423                               Object *child, Error **errp)
1424{
1425    Error *local_err = NULL;
1426    gchar *type;
1427    ObjectProperty *op;
1428
1429    if (child->parent != NULL) {
1430        error_setg(errp, "child object is already parented");
1431        return;
1432    }
1433
1434    type = g_strdup_printf("child<%s>", object_get_typename(OBJECT(child)));
1435
1436    op = object_property_add(obj, name, type, object_get_child_property, NULL,
1437                             object_finalize_child_property, child, &local_err);
1438    if (local_err) {
1439        error_propagate(errp, local_err);
1440        goto out;
1441    }
1442
1443    op->resolve = object_resolve_child_property;
1444    object_ref(child);
1445    child->parent = obj;
1446
1447out:
1448    g_free(type);
1449}
1450
1451void object_property_allow_set_link(const Object *obj, const char *name,
1452                                    Object *val, Error **errp)
1453{
1454    /* Allow the link to be set, always */
1455}
1456
1457typedef struct {
1458    Object **child;
1459    void (*check)(const Object *, const char *, Object *, Error **);
1460    ObjectPropertyLinkFlags flags;
1461} LinkProperty;
1462
1463static void object_get_link_property(Object *obj, Visitor *v,
1464                                     const char *name, void *opaque,
1465                                     Error **errp)
1466{
1467    LinkProperty *lprop = opaque;
1468    Object **child = lprop->child;
1469    gchar *path;
1470
1471    if (*child) {
1472        path = object_get_canonical_path(*child);
1473        visit_type_str(v, name, &path, errp);
1474        g_free(path);
1475    } else {
1476        path = (gchar *)"";
1477        visit_type_str(v, name, &path, errp);
1478    }
1479}
1480
1481/*
1482 * object_resolve_link:
1483 *
1484 * Lookup an object and ensure its type matches the link property type.  This
1485 * is similar to object_resolve_path() except type verification against the
1486 * link property is performed.
1487 *
1488 * Returns: The matched object or NULL on path lookup failures.
1489 */
1490static Object *object_resolve_link(Object *obj, const char *name,
1491                                   const char *path, Error **errp)
1492{
1493    const char *type;
1494    gchar *target_type;
1495    bool ambiguous = false;
1496    Object *target;
1497
1498    /* Go from link<FOO> to FOO.  */
1499    type = object_property_get_type(obj, name, NULL);
1500    target_type = g_strndup(&type[5], strlen(type) - 6);
1501    target = object_resolve_path_type(path, target_type, &ambiguous);
1502
1503    if (ambiguous) {
1504        error_setg(errp, "Path '%s' does not uniquely identify an object",
1505                   path);
1506    } else if (!target) {
1507        target = object_resolve_path(path, &ambiguous);
1508        if (target || ambiguous) {
1509            error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name, target_type);
1510        } else {
1511            error_set(errp, ERROR_CLASS_DEVICE_NOT_FOUND,
1512                      "Device '%s' not found", path);
1513        }
1514        target = NULL;
1515    }
1516    g_free(target_type);
1517
1518    return target;
1519}
1520
1521static void object_set_link_property(Object *obj, Visitor *v,
1522                                     const char *name, void *opaque,
1523                                     Error **errp)
1524{
1525    Error *local_err = NULL;
1526    LinkProperty *prop = opaque;
1527    Object **child = prop->child;
1528    Object *old_target = *child;
1529    Object *new_target = NULL;
1530    char *path = NULL;
1531
1532    visit_type_str(v, name, &path, &local_err);
1533
1534    if (!local_err && strcmp(path, "") != 0) {
1535        new_target = object_resolve_link(obj, name, path, &local_err);
1536    }
1537
1538    g_free(path);
1539    if (local_err) {
1540        error_propagate(errp, local_err);
1541        return;
1542    }
1543
1544    prop->check(obj, name, new_target, &local_err);
1545    if (local_err) {
1546        error_propagate(errp, local_err);
1547        return;
1548    }
1549
1550    object_ref(new_target);
1551    *child = new_target;
1552    object_unref(old_target);
1553}
1554
1555static Object *object_resolve_link_property(Object *parent, void *opaque, const gchar *part)
1556{
1557    LinkProperty *lprop = opaque;
1558
1559    return *lprop->child;
1560}
1561
1562static void object_release_link_property(Object *obj, const char *name,
1563                                         void *opaque)
1564{
1565    LinkProperty *prop = opaque;
1566
1567    if ((prop->flags & OBJ_PROP_LINK_UNREF_ON_RELEASE) && *prop->child) {
1568        object_unref(*prop->child);
1569    }
1570    g_free(prop);
1571}
1572
1573void object_property_add_link(Object *obj, const char *name,
1574                              const char *type, Object **child,
1575                              void (*check)(const Object *, const char *,
1576                                            Object *, Error **),
1577                              ObjectPropertyLinkFlags flags,
1578                              Error **errp)
1579{
1580    Error *local_err = NULL;
1581    LinkProperty *prop = g_malloc(sizeof(*prop));
1582    gchar *full_type;
1583    ObjectProperty *op;
1584
1585    prop->child = child;
1586    prop->check = check;
1587    prop->flags = flags;
1588
1589    full_type = g_strdup_printf("link<%s>", type);
1590
1591    op = object_property_add(obj, name, full_type,
1592                             object_get_link_property,
1593                             check ? object_set_link_property : NULL,
1594                             object_release_link_property,
1595                             prop,
1596                             &local_err);
1597    if (local_err) {
1598        error_propagate(errp, local_err);
1599        g_free(prop);
1600        goto out;
1601    }
1602
1603    op->resolve = object_resolve_link_property;
1604
1605out:
1606    g_free(full_type);
1607}
1608
1609void object_property_add_const_link(Object *obj, const char *name,
1610                                    Object *target, Error **errp)
1611{
1612    char *link_type;
1613    ObjectProperty *op;
1614
1615    link_type = g_strdup_printf("link<%s>", object_get_typename(target));
1616    op = object_property_add(obj, name, link_type,
1617                             object_get_child_property, NULL,
1618                             NULL, target, errp);
1619    if (op != NULL) {
1620        op->resolve = object_resolve_child_property;
1621    }
1622    g_free(link_type);
1623}
1624
1625gchar *object_get_canonical_path_component(Object *obj)
1626{
1627    ObjectProperty *prop = NULL;
1628    GHashTableIter iter;
1629
1630    g_assert(obj);
1631    g_assert(obj->parent != NULL);
1632
1633    g_hash_table_iter_init(&iter, obj->parent->properties);
1634    while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1635        if (!object_property_is_child(prop)) {
1636            continue;
1637        }
1638
1639        if (prop->opaque == obj) {
1640            return g_strdup(prop->name);
1641        }
1642    }
1643
1644    /* obj had a parent but was not a child, should never happen */
1645    g_assert_not_reached();
1646    return NULL;
1647}
1648
1649gchar *object_get_canonical_path(Object *obj)
1650{
1651    Object *root = object_get_root();
1652    char *newpath, *path = NULL;
1653
1654    while (obj != root) {
1655        char *component = object_get_canonical_path_component(obj);
1656
1657        if (path) {
1658            newpath = g_strdup_printf("%s/%s", component, path);
1659            g_free(component);
1660            g_free(path);
1661            path = newpath;
1662        } else {
1663            path = component;
1664        }
1665
1666        obj = obj->parent;
1667    }
1668
1669    newpath = g_strdup_printf("/%s", path ? path : "");
1670    g_free(path);
1671
1672    return newpath;
1673}
1674
1675Object *object_resolve_path_component(Object *parent, const gchar *part)
1676{
1677    ObjectProperty *prop = object_property_find(parent, part, NULL);
1678    if (prop == NULL) {
1679        return NULL;
1680    }
1681
1682    if (prop->resolve) {
1683        return prop->resolve(parent, prop->opaque, part);
1684    } else {
1685        return NULL;
1686    }
1687}
1688
1689static Object *object_resolve_abs_path(Object *parent,
1690                                          gchar **parts,
1691                                          const char *typename,
1692                                          int index)
1693{
1694    Object *child;
1695
1696    if (parts[index] == NULL) {
1697        return object_dynamic_cast(parent, typename);
1698    }
1699
1700    if (strcmp(parts[index], "") == 0) {
1701        return object_resolve_abs_path(parent, parts, typename, index + 1);
1702    }
1703
1704    child = object_resolve_path_component(parent, parts[index]);
1705    if (!child) {
1706        return NULL;
1707    }
1708
1709    return object_resolve_abs_path(child, parts, typename, index + 1);
1710}
1711
1712static Object *object_resolve_partial_path(Object *parent,
1713                                              gchar **parts,
1714                                              const char *typename,
1715                                              bool *ambiguous)
1716{
1717    Object *obj;
1718    GHashTableIter iter;
1719    ObjectProperty *prop;
1720
1721    obj = object_resolve_abs_path(parent, parts, typename, 0);
1722
1723    g_hash_table_iter_init(&iter, parent->properties);
1724    while (g_hash_table_iter_next(&iter, NULL, (gpointer *)&prop)) {
1725        Object *found;
1726
1727        if (!object_property_is_child(prop)) {
1728            continue;
1729        }
1730
1731        found = object_resolve_partial_path(prop->opaque, parts,
1732                                            typename, ambiguous);
1733        if (found) {
1734            if (obj) {
1735                *ambiguous = true;
1736                return NULL;
1737            }
1738            obj = found;
1739        }
1740
1741        if (*ambiguous) {
1742            return NULL;
1743        }
1744    }
1745
1746    return obj;
1747}
1748
1749Object *object_resolve_path_type(const char *path, const char *typename,
1750                                 bool *ambiguousp)
1751{
1752    Object *obj;
1753    gchar **parts;
1754
1755    parts = g_strsplit(path, "/", 0);
1756    assert(parts);
1757
1758    if (parts[0] == NULL || strcmp(parts[0], "") != 0) {
1759        bool ambiguous = false;
1760        obj = object_resolve_partial_path(object_get_root(), parts,
1761                                          typename, &ambiguous);
1762        if (ambiguousp) {
1763            *ambiguousp = ambiguous;
1764        }
1765    } else {
1766        obj = object_resolve_abs_path(object_get_root(), parts, typename, 1);
1767    }
1768
1769    g_strfreev(parts);
1770
1771    return obj;
1772}
1773
1774Object *object_resolve_path(const char *path, bool *ambiguous)
1775{
1776    return object_resolve_path_type(path, TYPE_OBJECT, ambiguous);
1777}
1778
1779typedef struct StringProperty
1780{
1781    char *(*get)(Object *, Error **);
1782    void (*set)(Object *, const char *, Error **);
1783} StringProperty;
1784
1785static void property_get_str(Object *obj, Visitor *v, const char *name,
1786                             void *opaque, Error **errp)
1787{
1788    StringProperty *prop = opaque;
1789    char *value;
1790    Error *err = NULL;
1791
1792    value = prop->get(obj, &err);
1793    if (err) {
1794        error_propagate(errp, err);
1795        return;
1796    }
1797
1798    visit_type_str(v, name, &value, errp);
1799    g_free(value);
1800}
1801
1802static void property_set_str(Object *obj, Visitor *v, const char *name,
1803                             void *opaque, Error **errp)
1804{
1805    StringProperty *prop = opaque;
1806    char *value;
1807    Error *local_err = NULL;
1808
1809    visit_type_str(v, name, &value, &local_err);
1810    if (local_err) {
1811        error_propagate(errp, local_err);
1812        return;
1813    }
1814
1815    prop->set(obj, value, errp);
1816    g_free(value);
1817}
1818
1819static void property_release_str(Object *obj, const char *name,
1820                                 void *opaque)
1821{
1822    StringProperty *prop = opaque;
1823    g_free(prop);
1824}
1825
1826void object_property_add_str(Object *obj, const char *name,
1827                           char *(*get)(Object *, Error **),
1828                           void (*set)(Object *, const char *, Error **),
1829                           Error **errp)
1830{
1831    Error *local_err = NULL;
1832    StringProperty *prop = g_malloc0(sizeof(*prop));
1833
1834    prop->get = get;
1835    prop->set = set;
1836
1837    object_property_add(obj, name, "string",
1838                        get ? property_get_str : NULL,
1839                        set ? property_set_str : NULL,
1840                        property_release_str,
1841                        prop, &local_err);
1842    if (local_err) {
1843        error_propagate(errp, local_err);
1844        g_free(prop);
1845    }
1846}
1847
1848void object_class_property_add_str(ObjectClass *klass, const char *name,
1849                                   char *(*get)(Object *, Error **),
1850                                   void (*set)(Object *, const char *,
1851                                               Error **),
1852                                   Error **errp)
1853{
1854    Error *local_err = NULL;
1855    StringProperty *prop = g_malloc0(sizeof(*prop));
1856
1857    prop->get = get;
1858    prop->set = set;
1859
1860    object_class_property_add(klass, name, "string",
1861                              get ? property_get_str : NULL,
1862                              set ? property_set_str : NULL,
1863                              property_release_str,
1864                              prop, &local_err);
1865    if (local_err) {
1866        error_propagate(errp, local_err);
1867        g_free(prop);
1868    }
1869}
1870
1871typedef struct BoolProperty
1872{
1873    bool (*get)(Object *, Error **);
1874    void (*set)(Object *, bool, Error **);
1875} BoolProperty;
1876
1877static void property_get_bool(Object *obj, Visitor *v, const char *name,
1878                              void *opaque, Error **errp)
1879{
1880    BoolProperty *prop = opaque;
1881    bool value;
1882    Error *err = NULL;
1883
1884    value = prop->get(obj, &err);
1885    if (err) {
1886        error_propagate(errp, err);
1887        return;
1888    }
1889
1890    visit_type_bool(v, name, &value, errp);
1891}
1892
1893static void property_set_bool(Object *obj, Visitor *v, const char *name,
1894                              void *opaque, Error **errp)
1895{
1896    BoolProperty *prop = opaque;
1897    bool value;
1898    Error *local_err = NULL;
1899
1900    visit_type_bool(v, name, &value, &local_err);
1901    if (local_err) {
1902        error_propagate(errp, local_err);
1903        return;
1904    }
1905
1906    prop->set(obj, value, errp);
1907}
1908
1909static void property_release_bool(Object *obj, const char *name,
1910                                  void *opaque)
1911{
1912    BoolProperty *prop = opaque;
1913    g_free(prop);
1914}
1915
1916void object_property_add_bool(Object *obj, const char *name,
1917                              bool (*get)(Object *, Error **),
1918                              void (*set)(Object *, bool, Error **),
1919                              Error **errp)
1920{
1921    Error *local_err = NULL;
1922    BoolProperty *prop = g_malloc0(sizeof(*prop));
1923
1924    prop->get = get;
1925    prop->set = set;
1926
1927    object_property_add(obj, name, "bool",
1928                        get ? property_get_bool : NULL,
1929                        set ? property_set_bool : NULL,
1930                        property_release_bool,
1931                        prop, &local_err);
1932    if (local_err) {
1933        error_propagate(errp, local_err);
1934        g_free(prop);
1935    }
1936}
1937
1938void object_class_property_add_bool(ObjectClass *klass, const char *name,
1939                                    bool (*get)(Object *, Error **),
1940                                    void (*set)(Object *, bool, Error **),
1941                                    Error **errp)
1942{
1943    Error *local_err = NULL;
1944    BoolProperty *prop = g_malloc0(sizeof(*prop));
1945
1946    prop->get = get;
1947    prop->set = set;
1948
1949    object_class_property_add(klass, name, "bool",
1950                              get ? property_get_bool : NULL,
1951                              set ? property_set_bool : NULL,
1952                              property_release_bool,
1953                              prop, &local_err);
1954    if (local_err) {
1955        error_propagate(errp, local_err);
1956        g_free(prop);
1957    }
1958}
1959
1960static void property_get_enum(Object *obj, Visitor *v, const char *name,
1961                              void *opaque, Error **errp)
1962{
1963    EnumProperty *prop = opaque;
1964    int value;
1965    Error *err = NULL;
1966
1967    value = prop->get(obj, &err);
1968    if (err) {
1969        error_propagate(errp, err);
1970        return;
1971    }
1972
1973    visit_type_enum(v, name, &value, prop->lookup, errp);
1974}
1975
1976static void property_set_enum(Object *obj, Visitor *v, const char *name,
1977                              void *opaque, Error **errp)
1978{
1979    EnumProperty *prop = opaque;
1980    int value;
1981    Error *err = NULL;
1982
1983    visit_type_enum(v, name, &value, prop->lookup, &err);
1984    if (err) {
1985        error_propagate(errp, err);
1986        return;
1987    }
1988    prop->set(obj, value, errp);
1989}
1990
1991static void property_release_enum(Object *obj, const char *name,
1992                                  void *opaque)
1993{
1994    EnumProperty *prop = opaque;
1995    g_free(prop);
1996}
1997
1998void object_property_add_enum(Object *obj, const char *name,
1999                              const char *typename,
2000                              const QEnumLookup *lookup,
2001                              int (*get)(Object *, Error **),
2002                              void (*set)(Object *, int, Error **),
2003                              Error **errp)
2004{
2005    Error *local_err = NULL;
2006    EnumProperty *prop = g_malloc(sizeof(*prop));
2007
2008    prop->lookup = lookup;
2009    prop->get = get;
2010    prop->set = set;
2011
2012    object_property_add(obj, name, typename,
2013                        get ? property_get_enum : NULL,
2014                        set ? property_set_enum : NULL,
2015                        property_release_enum,
2016                        prop, &local_err);
2017    if (local_err) {
2018        error_propagate(errp, local_err);
2019        g_free(prop);
2020    }
2021}
2022
2023void object_class_property_add_enum(ObjectClass *klass, const char *name,
2024                                    const char *typename,
2025                                    const QEnumLookup *lookup,
2026                                    int (*get)(Object *, Error **),
2027                                    void (*set)(Object *, int, Error **),
2028                                    Error **errp)
2029{
2030    Error *local_err = NULL;
2031    EnumProperty *prop = g_malloc(sizeof(*prop));
2032
2033    prop->lookup = lookup;
2034    prop->get = get;
2035    prop->set = set;
2036
2037    object_class_property_add(klass, name, typename,
2038                              get ? property_get_enum : NULL,
2039                              set ? property_set_enum : NULL,
2040                              property_release_enum,
2041                              prop, &local_err);
2042    if (local_err) {
2043        error_propagate(errp, local_err);
2044        g_free(prop);
2045    }
2046}
2047
2048typedef struct TMProperty {
2049    void (*get)(Object *, struct tm *, Error **);
2050} TMProperty;
2051
2052static void property_get_tm(Object *obj, Visitor *v, const char *name,
2053                            void *opaque, Error **errp)
2054{
2055    TMProperty *prop = opaque;
2056    Error *err = NULL;
2057    struct tm value;
2058
2059    prop->get(obj, &value, &err);
2060    if (err) {
2061        goto out;
2062    }
2063
2064    visit_start_struct(v, name, NULL, 0, &err);
2065    if (err) {
2066        goto out;
2067    }
2068    visit_type_int32(v, "tm_year", &value.tm_year, &err);
2069    if (err) {
2070        goto out_end;
2071    }
2072    visit_type_int32(v, "tm_mon", &value.tm_mon, &err);
2073    if (err) {
2074        goto out_end;
2075    }
2076    visit_type_int32(v, "tm_mday", &value.tm_mday, &err);
2077    if (err) {
2078        goto out_end;
2079    }
2080    visit_type_int32(v, "tm_hour", &value.tm_hour, &err);
2081    if (err) {
2082        goto out_end;
2083    }
2084    visit_type_int32(v, "tm_min", &value.tm_min, &err);
2085    if (err) {
2086        goto out_end;
2087    }
2088    visit_type_int32(v, "tm_sec", &value.tm_sec, &err);
2089    if (err) {
2090        goto out_end;
2091    }
2092    visit_check_struct(v, &err);
2093out_end:
2094    visit_end_struct(v, NULL);
2095out:
2096    error_propagate(errp, err);
2097
2098}
2099
2100static void property_release_tm(Object *obj, const char *name,
2101                                void *opaque)
2102{
2103    TMProperty *prop = opaque;
2104    g_free(prop);
2105}
2106
2107void object_property_add_tm(Object *obj, const char *name,
2108                            void (*get)(Object *, struct tm *, Error **),
2109                            Error **errp)
2110{
2111    Error *local_err = NULL;
2112    TMProperty *prop = g_malloc0(sizeof(*prop));
2113
2114    prop->get = get;
2115
2116    object_property_add(obj, name, "struct tm",
2117                        get ? property_get_tm : NULL, NULL,
2118                        property_release_tm,
2119                        prop, &local_err);
2120    if (local_err) {
2121        error_propagate(errp, local_err);
2122        g_free(prop);
2123    }
2124}
2125
2126void object_class_property_add_tm(ObjectClass *klass, const char *name,
2127                                  void (*get)(Object *, struct tm *, Error **),
2128                                  Error **errp)
2129{
2130    Error *local_err = NULL;
2131    TMProperty *prop = g_malloc0(sizeof(*prop));
2132
2133    prop->get = get;
2134
2135    object_class_property_add(klass, name, "struct tm",
2136                              get ? property_get_tm : NULL, NULL,
2137                              property_release_tm,
2138                              prop, &local_err);
2139    if (local_err) {
2140        error_propagate(errp, local_err);
2141        g_free(prop);
2142    }
2143}
2144
2145static char *qdev_get_type(Object *obj, Error **errp)
2146{
2147    return g_strdup(object_get_typename(obj));
2148}
2149
2150static void property_get_uint8_ptr(Object *obj, Visitor *v, const char *name,
2151                                   void *opaque, Error **errp)
2152{
2153    uint8_t value = *(uint8_t *)opaque;
2154    visit_type_uint8(v, name, &value, errp);
2155}
2156
2157static void property_get_uint16_ptr(Object *obj, Visitor *v, const char *name,
2158                                    void *opaque, Error **errp)
2159{
2160    uint16_t value = *(uint16_t *)opaque;
2161    visit_type_uint16(v, name, &value, errp);
2162}
2163
2164static void property_get_uint32_ptr(Object *obj, Visitor *v, const char *name,
2165                                    void *opaque, Error **errp)
2166{
2167    uint32_t value = *(uint32_t *)opaque;
2168    visit_type_uint32(v, name, &value, errp);
2169}
2170
2171static void property_get_uint64_ptr(Object *obj, Visitor *v, const char *name,
2172                                    void *opaque, Error **errp)
2173{
2174    uint64_t value = *(uint64_t *)opaque;
2175    visit_type_uint64(v, name, &value, errp);
2176}
2177
2178void object_property_add_uint8_ptr(Object *obj, const char *name,
2179                                   const uint8_t *v, Error **errp)
2180{
2181    object_property_add(obj, name, "uint8", property_get_uint8_ptr,
2182                        NULL, NULL, (void *)v, errp);
2183}
2184
2185void object_class_property_add_uint8_ptr(ObjectClass *klass, const char *name,
2186                                         const uint8_t *v, Error **errp)
2187{
2188    object_class_property_add(klass, name, "uint8", property_get_uint8_ptr,
2189                              NULL, NULL, (void *)v, errp);
2190}
2191
2192void object_property_add_uint16_ptr(Object *obj, const char *name,
2193                                    const uint16_t *v, Error **errp)
2194{
2195    object_property_add(obj, name, "uint16", property_get_uint16_ptr,
2196                        NULL, NULL, (void *)v, errp);
2197}
2198
2199void object_class_property_add_uint16_ptr(ObjectClass *klass, const char *name,
2200                                          const uint16_t *v, Error **errp)
2201{
2202    object_class_property_add(klass, name, "uint16", property_get_uint16_ptr,
2203                              NULL, NULL, (void *)v, errp);
2204}
2205
2206void object_property_add_uint32_ptr(Object *obj, const char *name,
2207                                    const uint32_t *v, Error **errp)
2208{
2209    object_property_add(obj, name, "uint32", property_get_uint32_ptr,
2210                        NULL, NULL, (void *)v, errp);
2211}
2212
2213void object_class_property_add_uint32_ptr(ObjectClass *klass, const char *name,
2214                                          const uint32_t *v, Error **errp)
2215{
2216    object_class_property_add(klass, name, "uint32", property_get_uint32_ptr,
2217                              NULL, NULL, (void *)v, errp);
2218}
2219
2220void object_property_add_uint64_ptr(Object *obj, const char *name,
2221                                    const uint64_t *v, Error **errp)
2222{
2223    object_property_add(obj, name, "uint64", property_get_uint64_ptr,
2224                        NULL, NULL, (void *)v, errp);
2225}
2226
2227void object_class_property_add_uint64_ptr(ObjectClass *klass, const char *name,
2228                                          const uint64_t *v, Error **errp)
2229{
2230    object_class_property_add(klass, name, "uint64", property_get_uint64_ptr,
2231                              NULL, NULL, (void *)v, errp);
2232}
2233
2234typedef struct {
2235    Object *target_obj;
2236    char *target_name;
2237} AliasProperty;
2238
2239static void property_get_alias(Object *obj, Visitor *v, const char *name,
2240                               void *opaque, Error **errp)
2241{
2242    AliasProperty *prop = opaque;
2243
2244    object_property_get(prop->target_obj, v, prop->target_name, errp);
2245}
2246
2247static void property_set_alias(Object *obj, Visitor *v, const char *name,
2248                               void *opaque, Error **errp)
2249{
2250    AliasProperty *prop = opaque;
2251
2252    object_property_set(prop->target_obj, v, prop->target_name, errp);
2253}
2254
2255static Object *property_resolve_alias(Object *obj, void *opaque,
2256                                      const gchar *part)
2257{
2258    AliasProperty *prop = opaque;
2259
2260    return object_resolve_path_component(prop->target_obj, prop->target_name);
2261}
2262
2263static void property_release_alias(Object *obj, const char *name, void *opaque)
2264{
2265    AliasProperty *prop = opaque;
2266
2267    g_free(prop->target_name);
2268    g_free(prop);
2269}
2270
2271void object_property_add_alias(Object *obj, const char *name,
2272                               Object *target_obj, const char *target_name,
2273                               Error **errp)
2274{
2275    AliasProperty *prop;
2276    ObjectProperty *op;
2277    ObjectProperty *target_prop;
2278    gchar *prop_type;
2279    Error *local_err = NULL;
2280
2281    target_prop = object_property_find(target_obj, target_name, errp);
2282    if (!target_prop) {
2283        return;
2284    }
2285
2286    if (object_property_is_child(target_prop)) {
2287        prop_type = g_strdup_printf("link%s",
2288                                    target_prop->type + strlen("child"));
2289    } else {
2290        prop_type = g_strdup(target_prop->type);
2291    }
2292
2293    prop = g_malloc(sizeof(*prop));
2294    prop->target_obj = target_obj;
2295    prop->target_name = g_strdup(target_name);
2296
2297    op = object_property_add(obj, name, prop_type,
2298                             property_get_alias,
2299                             property_set_alias,
2300                             property_release_alias,
2301                             prop, &local_err);
2302    if (local_err) {
2303        error_propagate(errp, local_err);
2304        g_free(prop);
2305        goto out;
2306    }
2307    op->resolve = property_resolve_alias;
2308
2309    object_property_set_description(obj, op->name,
2310                                    target_prop->description,
2311                                    &error_abort);
2312
2313out:
2314    g_free(prop_type);
2315}
2316
2317void object_property_set_description(Object *obj, const char *name,
2318                                     const char *description, Error **errp)
2319{
2320    ObjectProperty *op;
2321
2322    op = object_property_find(obj, name, errp);
2323    if (!op) {
2324        return;
2325    }
2326
2327    g_free(op->description);
2328    op->description = g_strdup(description);
2329}
2330
2331void object_class_property_set_description(ObjectClass *klass,
2332                                           const char *name,
2333                                           const char *description,
2334                                           Error **errp)
2335{
2336    ObjectProperty *op;
2337
2338    op = g_hash_table_lookup(klass->properties, name);
2339    if (!op) {
2340        error_setg(errp, "Property '.%s' not found", name);
2341        return;
2342    }
2343
2344    g_free(op->description);
2345    op->description = g_strdup(description);
2346}
2347
2348static void object_instance_init(Object *obj)
2349{
2350    object_property_add_str(obj, "type", qdev_get_type, NULL, NULL);
2351}
2352
2353static void register_types(void)
2354{
2355    static TypeInfo interface_info = {
2356        .name = TYPE_INTERFACE,
2357        .class_size = sizeof(InterfaceClass),
2358        .abstract = true,
2359    };
2360
2361    static TypeInfo object_info = {
2362        .name = TYPE_OBJECT,
2363        .instance_size = sizeof(Object),
2364        .instance_init = object_instance_init,
2365        .abstract = true,
2366    };
2367
2368    type_interface = type_register_internal(&interface_info);
2369    type_register_internal(&object_info);
2370}
2371
2372type_init(register_types)
2373