rom/graphics/objcache.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4 */
   5
   6 #include <proto/exec.h>
   7 #include <proto/oop.h>
   8 #include <proto/utility.h>
   9 #include <proto/arossupport.h>
  10
  11 #include <oop/oop.h>
  12 #include <exec/alerts.h>
  13 #include <exec/memory.h>
  14 #include <utility/tagitem.h>
  15
  16 #include <string.h>
  17
  18 #include "graphics_intern.h"
  19 #include "objcache.h"
  20
  21 #define DEBUG 0
  22 #include <aros/debug.h>
  23
  24 #define CACHE_INCREMENT 4
  25
  26 struct cacheitem
  27 {
  28     OOP_Object *obj;
  29     BOOL used;
  30 };
  31
  32 struct objcache
  33 {
  34     struct TagItem          *create_tags;
  35     struct SignalSemaphore  lock;
  36     struct cacheitem        *cache;
  37     ULONG                   cachesize;
  38     ULONG                   num_objects;
  39     STRPTR                  class_id;
  40     OOP_Class               *class_ptr;
  41 };
  42
  43
  44 ObjectCache *create_object_cache(OOP_Class *classPtr, STRPTR classID, struct TagItem *createTags, struct GfxBase *GfxBase)
  45 {
  46     struct objcache *oc;
  47
  48
  49     if (   (NULL == classPtr && NULL == classID)
  50         || (NULL != classPtr && NULL != classID) )
  51         return NULL;
  52
  53
  54     oc = AllocMem(sizeof (*oc), MEMF_PUBLIC|MEMF_CLEAR);
  55     if (NULL != oc) {
  56
  57         InitSemaphore(&oc->lock);
  58         oc->cachesize = CACHE_INCREMENT;
  59         oc->num_objects = 0;
  60
  61         oc->create_tags = CloneTagItems(createTags);
  62         if (NULL != oc->create_tags) {
  63             BOOL got_class = FALSE;
  64
  65             if (NULL != classID) {
  66                 oc->class_id = AllocVec(strlen(classID) + 1, MEMF_ANY);
  67                 if (NULL != oc->class_id) {
  68                     strcpy(oc->class_id, classID);
  69                     got_class = TRUE;
  70                 }
  71             } else {
  72                 oc->class_ptr = classPtr;
  73                 got_class = TRUE;
  74             }
  75
  76             if (got_class) {
  77
  78                 oc->cache = AllocMem(sizeof (*oc->cache) * oc->cachesize, MEMF_CLEAR);
  79                 if (NULL != oc->cache) {
  80                     return (ObjectCache *)oc;
  81                 }
  82
  83                 if (NULL != oc->class_id)
  84                     FreeVec(oc->class_id);
  85
  86             } /* if (got class) */
  87
  88             FreeTagItems(oc->create_tags);
  89
  90         } /* if (tagitems copied) */
  91
  92         FreeMem(oc, sizeof (*oc));
  93     } /* if (objcache struct allocated) */
  94
  95     return NULL;
  96 }
  97
  98 VOID delete_object_cache(ObjectCache *objectCache, struct GfxBase *GfxBase)
  99 {
 100     struct objcache *oc;
 101
 102     ULONG i;
 103
 104     oc = (struct objcache *)objectCache;
 105
 106     ObtainSemaphore(&oc->lock);
 107
 108     /* Check if all elements in the object cache are unused */
 109     for (i = 0; i < oc->num_objects; i ++) {
 110             if (oc->cache[i].used) {
 111                 D(bug("!!!! TRYING TO DELETE AN OBJECT CACHE WITH USED OBJECTS !!!!\n"));
 112                 ReleaseSemaphore(&oc->lock);
 113                 return;
 114
 115
 116         }
 117
 118     }
 119
 120
 121     for (i = 0; i < oc->num_objects; i ++) {
 122         if (NULL != oc->cache[i].obj)
 123             OOP_DisposeObject(oc->cache[i].obj);
 124         else
 125             break;
 126     }
 127
 128     FreeMem(oc->cache, sizeof (*oc->cache) * oc->cachesize);
 129
 130     FreeTagItems(oc->create_tags);
 131
 132     if (NULL != oc->class_id)
 133         FreeVec(oc->class_id);
 134
 135     ReleaseSemaphore(&oc->lock);
 136
 137     FreeMem(oc, sizeof (*oc));
 138
 139     return;
 140
 141 }
 142
 143
 144 OOP_Object *obtain_cache_object(ObjectCache *objectCache, struct GfxBase *GfxBase)
 145 {
 146     struct objcache *oc;
 147     ULONG i;
 148     OOP_Object *obj = NULL;
 149
 150     oc = (struct objcache *)objectCache;
 151
 152 /*    bug("obtain_cache_object(classID=%s, classPtr=%p)\n"
 153         , oc->class_id, oc->class_ptr);
 154 */
 155     ObtainSemaphore(&oc->lock);
 156
 157
 158     /* Look to see if we can find a free object */
 159     for (i = 0; i < oc->cachesize; i ++) {
 160         struct cacheitem *ci;
 161
 162         ci = &oc->cache[i];
 163 /* bug("cache[%d]=%p, %d\n", i, ci->obj, ci->used);
 164 */      if (NULL == ci->obj) {
 165             break;
 166         } else {
 167             if (!ci->used) {
 168                 obj = ci->obj;
 169                 ci->used = TRUE;
 170                 break;
 171             }
 172         }
 173     }
 174
 175 /* bug("obj found in cache: %p\n", obj);
 176 */    if (NULL == obj) {
 177         struct cacheitem *ci;
 178         /* No object free, so we try to create a new one.
 179         But first we see if the cache can hold it */
 180
 181         if (oc->num_objects == oc->cachesize) {
 182              /* Not more space in the cache, try to expand it */
 183              struct cacheitem *newcache;
 184
 185              newcache = AllocMem(sizeof (*oc->cache) * (oc->cachesize + CACHE_INCREMENT), MEMF_CLEAR);
 186              if (NULL == newcache)
 187                 goto exit;
 188
 189              /* Copy the old cache data */
 190              memcpy(newcache, oc->cache, sizeof (*oc->cache) * oc->cachesize);
 191
 192              /* Free old cache */
 193              FreeMem(oc->cache, sizeof (*oc->cache) * oc->cachesize);
 194
 195              /* Use new cache */
 196              oc->cache = newcache;
 197              oc->cachesize +=CACHE_INCREMENT;
 198
 199         }
 200
 201         /* Try to create a new object */
 202 /* bug("Trying to create new object\n");
 203 */      ci = &oc->cache[oc->num_objects];
 204
 205         if (oc->class_id)
 206             ci->obj = OOP_NewObject(NULL, oc->class_id, oc->create_tags);
 207         else
 208             ci->obj = OOP_NewObject(oc->class_ptr, NULL, oc->create_tags);
 209
 210         if (NULL == ci->obj)
 211             goto exit;
 212
 213         oc->num_objects ++;
 214         ci->used = TRUE;
 215
 216         obj = ci->obj;
 217
 218     }
 219
 220 exit:
 221     ReleaseSemaphore(&oc->lock);
 222
 223     return obj;
 224
 225
 226 }
 227
 228 VOID release_cache_object(ObjectCache *objectCache, OOP_Object *object, struct GfxBase *GfxBase)
 229 {
 230     struct objcache *oc;
 231     ULONG i;
 232     D(BOOL found = FALSE);
 233
 234     oc = (struct objcache *)objectCache;
 235
 236     ObtainSemaphore(&oc->lock);
 237
 238     for (i = 0; i < oc->cachesize; i ++) {
 239         struct cacheitem *ci;
 240
 241         ci = &oc->cache[i];
 242         if (NULL == ci->obj) {
 243             break;
 244         } else {
 245             if (ci->obj == object) {
 246                 /* Object found */
 247                 ci->used = FALSE;
 248                 D(found = TRUE);
 249             }
 250         }
 251     }
 252
 253 #if DEBUG
 254     if (!found)
 255         bug("!!!! TRYING TO RELEASE OBJECT CACHE ELEMENT WHICH WAS NOT PRESENT IN CACHE\n");
 256 #endif
 257
 258     ReleaseSemaphore(&oc->lock);
 259
 260     return;
 261
 262 }