object.c

Go to the documentation of this file.

/*
 * Copyright 2012 Red Hat Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * Authors: Ben Skeggs
 */

#include <core/object.h>
#include <core/parent.h>
#include <core/namedb.h>
#include <core/handle.h>
#include <core/engine.h>

#ifdef NOUVEAU_OBJECT_MAGIC
static struct list_head _objlist = LIST_HEAD_INIT(_objlist);
static DEFINE_SPINLOCK(_objlist_lock);
#endif

int
nouveau_object_create_(struct nouveau_object *parent,
               struct nouveau_object *engine,
               struct nouveau_oclass *oclass, u32 pclass,
               int size, void **pobject)
{
    struct nouveau_object *object;

    object = *pobject = kzalloc(size, GFP_KERNEL);
    if (!object)
        return -ENOMEM;

    nouveau_object_ref(parent, &object->parent);
    nouveau_object_ref(engine, &object->engine);
    object->oclass = oclass;
    object->oclass->handle |= pclass;
    atomic_set(&object->refcount, 1);
    atomic_set(&object->usecount, 0);

#ifdef NOUVEAU_OBJECT_MAGIC
    object->_magic = NOUVEAU_OBJECT_MAGIC;
    spin_lock(&_objlist_lock);
    list_add(&object->list, &_objlist);
    spin_unlock(&_objlist_lock);
#endif
    return 0;
}

static int
_nouveau_object_ctor(struct nouveau_object *parent,
             struct nouveau_object *engine,
             struct nouveau_oclass *oclass, void *data, u32 size,
             struct nouveau_object **pobject)
{
    struct nouveau_object *object;
    int ret;

    ret = nouveau_object_create(parent, engine, oclass, 0, &object);
    *pobject = nv_object(object);
    if (ret)
        return ret;

    return 0;
}

void
nouveau_object_destroy(struct nouveau_object *object)
{
#ifdef NOUVEAU_OBJECT_MAGIC
    spin_lock(&_objlist_lock);
    list_del(&object->list);
    spin_unlock(&_objlist_lock);
#endif
    nouveau_object_ref(NULL, &object->engine);
    nouveau_object_ref(NULL, &object->parent);
    kfree(object);
}

static void
_nouveau_object_dtor(struct nouveau_object *object)
{
    nouveau_object_destroy(object);
}

int
nouveau_object_init(struct nouveau_object *object)
{
    return 0;
}

static int
_nouveau_object_init(struct nouveau_object *object)
{
    return nouveau_object_init(object);
}

int
nouveau_object_fini(struct nouveau_object *object, bool suspend)
{
    return 0;
}

static int
_nouveau_object_fini(struct nouveau_object *object, bool suspend)
{
    return nouveau_object_fini(object, suspend);
}

struct nouveau_ofuncs
nouveau_object_ofuncs = {
    .ctor = _nouveau_object_ctor,
    .dtor = _nouveau_object_dtor,
    .init = _nouveau_object_init,
    .fini = _nouveau_object_fini,
};

int
nouveau_object_ctor(struct nouveau_object *parent,
            struct nouveau_object *engine,
            struct nouveau_oclass *oclass, void *data, u32 size,
            struct nouveau_object **pobject)
{
    struct nouveau_ofuncs *ofuncs = oclass->ofuncs;
    int ret;

    *pobject = NULL;

    ret = ofuncs->ctor(parent, engine, oclass, data, size, pobject);
    if (ret < 0) {
        if (ret != -ENODEV) {
            nv_error(parent, "failed to create 0x%08x, %d\n",
                 oclass->handle, ret);
        }

        if (*pobject) {
            ofuncs->dtor(*pobject);
            *pobject = NULL;
        }

        return ret;
    }

    nv_debug(*pobject, "created\n");
    return 0;
}

static void
nouveau_object_dtor(struct nouveau_object *object)
{
    nv_debug(object, "destroying\n");
    nv_ofuncs(object)->dtor(object);
}

void
nouveau_object_ref(struct nouveau_object *obj, struct nouveau_object **ref)
{
    if (obj) {
        atomic_inc(&obj->refcount);
        nv_trace(obj, "inc() == %d\n", atomic_read(&obj->refcount));
    }

    if (*ref) {
        int dead = atomic_dec_and_test(&(*ref)->refcount);
        nv_trace(*ref, "dec() == %d\n", atomic_read(&(*ref)->refcount));
        if (dead)
            nouveau_object_dtor(*ref);
    }

    *ref = obj;
}

int
nouveau_object_new(struct nouveau_object *client, u32 _parent, u32 _handle,
           u16 _oclass, void *data, u32 size,
           struct nouveau_object **pobject)
{
    struct nouveau_object *parent = NULL;
    struct nouveau_object *engctx = NULL;
    struct nouveau_object *object = NULL;
    struct nouveau_object *engine;
    struct nouveau_oclass *oclass;
    struct nouveau_handle *handle;
    int ret;

    /* lookup parent object and ensure it *is* a parent */
    parent = nouveau_handle_ref(client, _parent);
    if (!parent) {
        nv_error(client, "parent 0x%08x not found\n", _parent);
        return -ENOENT;
    }

    if (!nv_iclass(parent, NV_PARENT_CLASS)) {
        nv_error(parent, "cannot have children\n");
        ret = -EINVAL;
        goto fail_class;
    }

    /* check that parent supports the requested subclass */
    ret = nouveau_parent_sclass(parent, _oclass, &engine, &oclass);
    if (ret) {
        nv_debug(parent, "illegal class 0x%04x\n", _oclass);
        goto fail_class;
    }

    /* make sure engine init has been completed *before* any objects
     * it controls are created - the constructors may depend on
     * state calculated at init (ie. default context construction)
     */
    if (engine) {
        ret = nouveau_object_inc(engine);
        if (ret)
            goto fail_class;
    }

    /* if engine requires it, create a context object to insert
     * between the parent and its children (eg. PGRAPH context)
     */
    if (engine && nv_engine(engine)->cclass) {
        ret = nouveau_object_ctor(parent, engine,
                      nv_engine(engine)->cclass,
                      data, size, &engctx);
        if (ret)
            goto fail_engctx;
    } else {
        nouveau_object_ref(parent, &engctx);
    }

    /* finally, create new object and bind it to its handle */
    ret = nouveau_object_ctor(engctx, engine, oclass, data, size, &object);
    *pobject = object;
    if (ret)
        goto fail_ctor;

    ret = nouveau_object_inc(object);
    if (ret)
        goto fail_init;

    ret = nouveau_handle_create(parent, _parent, _handle, object, &handle);
    if (ret)
        goto fail_handle;

    ret = nouveau_handle_init(handle);
    if (ret)
        nouveau_handle_destroy(handle);

fail_handle:
    nouveau_object_dec(object, false);
fail_init:
    nouveau_object_ref(NULL, &object);
fail_ctor:
    nouveau_object_ref(NULL, &engctx);
fail_engctx:
    if (engine)
        nouveau_object_dec(engine, false);
fail_class:
    nouveau_object_ref(NULL, &parent);
    return ret;
}

int
nouveau_object_del(struct nouveau_object *client, u32 _parent, u32 _handle)
{
    struct nouveau_object *parent = NULL;
    struct nouveau_object *namedb = NULL;
    struct nouveau_handle *handle = NULL;
    int ret = -EINVAL;

    parent = nouveau_handle_ref(client, _parent);
    if (!parent)
        return -ENOENT;

    namedb = nv_pclass(parent, NV_NAMEDB_CLASS);
    if (namedb) {
        handle = nouveau_namedb_get(nv_namedb(namedb), _handle);
        if (handle) {
            nouveau_namedb_put(handle);
            nouveau_handle_fini(handle, false);
            nouveau_handle_destroy(handle);
        }
    }

    nouveau_object_ref(NULL, &parent);
    return ret;
}

int
nouveau_object_inc(struct nouveau_object *object)
{
    int ref = atomic_add_return(1, &object->usecount);
    int ret;

    nv_trace(object, "use(+1) == %d\n", atomic_read(&object->usecount));
    if (ref != 1)
        return 0;

    nv_trace(object, "initialising...\n");
    if (object->parent) {
        ret = nouveau_object_inc(object->parent);
        if (ret) {
            nv_error(object, "parent failed, %d\n", ret);
            goto fail_parent;
        }
    }

    if (object->engine) {
        mutex_lock(&nv_subdev(object->engine)->mutex);
        ret = nouveau_object_inc(object->engine);
        mutex_unlock(&nv_subdev(object->engine)->mutex);
        if (ret) {
            nv_error(object, "engine failed, %d\n", ret);
            goto fail_engine;
        }
    }

    ret = nv_ofuncs(object)->init(object);
    if (ret) {
        nv_error(object, "init failed, %d\n", ret);
        goto fail_self;
    }

    nv_debug(object, "initialised\n");
    return 0;

fail_self:
    if (object->engine) {
        mutex_lock(&nv_subdev(object->engine)->mutex);
        nouveau_object_dec(object->engine, false);
        mutex_unlock(&nv_subdev(object->engine)->mutex);
    }
fail_engine:
    if (object->parent)
         nouveau_object_dec(object->parent, false);
fail_parent:
    atomic_dec(&object->usecount);
    return ret;
}

static int
nouveau_object_decf(struct nouveau_object *object)
{
    int ret;

    nv_trace(object, "stopping...\n");

    ret = nv_ofuncs(object)->fini(object, false);
    if (ret)
        nv_warn(object, "failed fini, %d\n", ret);

    if (object->engine) {
        mutex_lock(&nv_subdev(object->engine)->mutex);
        nouveau_object_dec(object->engine, false);
        mutex_unlock(&nv_subdev(object->engine)->mutex);
    }

    if (object->parent)
        nouveau_object_dec(object->parent, false);

    nv_debug(object, "stopped\n");
    return 0;
}

static int
nouveau_object_decs(struct nouveau_object *object)
{
    int ret, rret;

    nv_trace(object, "suspending...\n");

    ret = nv_ofuncs(object)->fini(object, true);
    if (ret) {
        nv_error(object, "failed suspend, %d\n", ret);
        return ret;
    }

    if (object->engine) {
        mutex_lock(&nv_subdev(object->engine)->mutex);
        ret = nouveau_object_dec(object->engine, true);
        mutex_unlock(&nv_subdev(object->engine)->mutex);
        if (ret) {
            nv_warn(object, "engine failed suspend, %d\n", ret);
            goto fail_engine;
        }
    }

    if (object->parent) {
        ret = nouveau_object_dec(object->parent, true);
        if (ret) {
            nv_warn(object, "parent failed suspend, %d\n", ret);
            goto fail_parent;
        }
    }

    nv_debug(object, "suspended\n");
    return 0;

fail_parent:
    if (object->engine) {
        mutex_lock(&nv_subdev(object->engine)->mutex);
        rret = nouveau_object_inc(object->engine);
        mutex_unlock(&nv_subdev(object->engine)->mutex);
        if (rret)
            nv_fatal(object, "engine failed to reinit, %d\n", rret);
    }

fail_engine:
    rret = nv_ofuncs(object)->init(object);
    if (rret)
        nv_fatal(object, "failed to reinit, %d\n", rret);

    return ret;
}

int
nouveau_object_dec(struct nouveau_object *object, bool suspend)
{
    int ref = atomic_add_return(-1, &object->usecount);
    int ret;

    nv_trace(object, "use(-1) == %d\n", atomic_read(&object->usecount));

    if (ref == 0) {
        if (suspend)
            ret = nouveau_object_decs(object);
        else
            ret = nouveau_object_decf(object);

        if (ret) {
            atomic_inc(&object->usecount);
            return ret;
        }
    }

    return 0;
}

void
nouveau_object_debug(void)
{
#ifdef NOUVEAU_OBJECT_MAGIC
    struct nouveau_object *object;
    if (!list_empty(&_objlist)) {
        nv_fatal(NULL, "*******************************************\n");
        nv_fatal(NULL, "* AIIIII! object(s) still exist!!!\n");
        nv_fatal(NULL, "*******************************************\n");
        list_for_each_entry(object, &_objlist, list) {
            nv_fatal(object, "%p/%p/%d/%d\n",
                 object->parent, object->engine,
                 atomic_read(&object->refcount),
                 atomic_read(&object->usecount));
        }
    }
#endif
}