dummy_drv_video/object_heap.h

   1 /*
   2  * Copyright (c) 2007 Intel Corporation. All Rights Reserved.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sub license, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the
  13  * next paragraph) shall be included in all copies or substantial portions
  14  * of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  19  * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
  20  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  21  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  22  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 #ifndef _OBJECT_HEAP_H_
  26 #define _OBJECT_HEAP_H_
  27
  28 #define OBJECT_HEAP_OFFSET_MASK         0x7F000000
  29 #define OBJECT_HEAP_ID_MASK                     0x00FFFFFF
  30
  31 typedef struct object_base *object_base_p;
  32 typedef struct object_heap *object_heap_p;
  33
  34 struct object_base {
  35     int id;
  36     int next_free;
  37 };
  38
  39 struct object_heap {
  40     int object_size;
  41     int id_offset;
  42     void *heap_index;
  43     int next_free;
  44     int heap_size;
  45     int heap_increment;
  46 };
  47
  48 typedef int object_heap_iterator;
  49
  50 /*
  51  * Return 0 on success, -1 on error
  52  */
  53 int object_heap_init( object_heap_p heap, int object_size, int id_offset);
  54
  55 /*
  56  * Allocates an object
  57  * Returns the object ID on success, returns -1 on error
  58  */
  59 int object_heap_allocate( object_heap_p heap );
  60
  61 /*
  62  * Lookup an allocated object by object ID
  63  * Returns a pointer to the object on success, returns NULL on error
  64  */
  65 object_base_p object_heap_lookup( object_heap_p heap, int id );
  66
  67 /*
  68  * Iterate over all objects in the heap.
  69  * Returns a pointer to the first object on the heap, returns NULL if heap is empty.
  70  */
  71 object_base_p object_heap_first( object_heap_p heap, object_heap_iterator *iter );
  72
  73 /*
  74  * Iterate over all objects in the heap.
  75  * Returns a pointer to the next object on the heap, returns NULL if heap is empty.
  76  */
  77 object_base_p object_heap_next( object_heap_p heap, object_heap_iterator *iter );
  78
  79 /*
  80  * Frees an object
  81  */
  82 void object_heap_free( object_heap_p heap, object_base_p obj );
  83
  84 /*
  85  * Destroys a heap, the heap must be empty.
  86  */
  87 void object_heap_destroy( object_heap_p heap );
  88
  89 #endif /* _OBJECT_HEAP_H_ */