icd/intel/obj.h

/*
 * XGL
 *
 * Copyright (C) 2014 LunarG, 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 AUTHORS OR COPYRIGHT HOLDERS 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:
 *   Chia-I Wu <olv@lunarg.com>
 */

#ifndef OBJ_H
#define OBJ_H

#include "intel.h"

struct intel_dev;
struct intel_mem;

struct intel_base_dbg {
    uint32_t alloc_id;
    XGL_DBG_OBJECT_TYPE type;

    void *create_info;
    size_t create_info_size;

    void *tag;
    size_t tag_size;

    /*
     * Need pointer to base object to be able to log debug
     * messages with intel_dev_log
     */
    struct intel_dev *dev;
};

struct intel_base {
    /* the loader expects a "void *" at the beginning */
    void *loader_data;
    uint32_t magic;

    struct intel_base_dbg *dbg;

    XGL_RESULT (*get_info)(struct intel_base *base, int type,
                           size_t *size, void *data);
};

struct intel_obj {
    struct intel_base base;

    void (*destroy)(struct intel_obj *obj);

    /* for memory binding */
    struct intel_mem *mem;
    size_t offset;
};

static inline struct intel_base *intel_base(XGL_BASE_OBJECT base)
{
    return (struct intel_base *) base;
}

static inline struct intel_obj *intel_obj(XGL_OBJECT obj)
{
    return (struct intel_obj *) obj;
}

static inline void intel_obj_bind_mem(struct intel_obj *obj,
                                      struct intel_mem *mem,
                                      XGL_GPU_SIZE offset)
{
    obj->mem = mem;
    obj->offset = offset;
}

bool intel_base_is_valid(const struct intel_base *base,
                         XGL_DBG_OBJECT_TYPE type);

XGL_RESULT intel_base_get_info(struct intel_base *base, int type,
                               size_t *size, void *data);

struct intel_base_dbg *intel_base_dbg_create(struct intel_dev *dev,
                                             XGL_DBG_OBJECT_TYPE type,
                                             const void *create_info,
                                             size_t dbg_size);
void intel_base_dbg_destroy(struct intel_base_dbg *dbg);

struct intel_base *intel_base_create(struct intel_dev *dev,
                                     size_t obj_size, bool debug,
                                     XGL_DBG_OBJECT_TYPE type,
                                     const void *create_info,
                                     size_t dbg_size);
void intel_base_destroy(struct intel_base *base);

#endif /* OBJ_H */