src/gallium/auxiliary/pipebuffer/pb_bufmgr_cache.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007-2008 Tungsten Graphics, Inc., Cedar Park, Texas.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 /**
  29  * \file
  30  * Buffer cache.
  31  *
  32  * \author José Fonseca <jrfonseca-at-tungstengraphics-dot-com>
  33  * \author Thomas Hellström <thomas-at-tungstengraphics-dot-com>
  34  */
  35
  36
  37 #include "pipe/p_compiler.h"
  38 #include "pipe/p_debug.h"
  39 #include "pipe/p_winsys.h"
  40 #include "pipe/p_thread.h"
  41 #include "pipe/p_util.h"
  42 #include "util/u_double_list.h"
  43 #include "util/u_time.h"
  44
  45 #include "pb_buffer.h"
  46 #include "pb_bufmgr.h"
  47
  48
  49 /**
  50  * Convenience macro (type safe).
  51  */
  52 #define SUPER(__derived) (&(__derived)->base)
  53
  54
  55 struct pb_cache_manager;
  56
  57
  58 /**
  59  * Wrapper around a pipe buffer which adds delayed destruction.
  60  */
  61 struct pb_cache_buffer
  62 {
  63    struct pb_buffer base;
  64
  65    struct pb_buffer *buffer;
  66    struct pb_cache_manager *mgr;
  67
  68    /** Caching time interval */
  69    struct util_time start, end;
  70
  71    struct list_head head;
  72 };
  73
  74
  75 struct pb_cache_manager
  76 {
  77    struct pb_manager base;
  78
  79    struct pb_manager *provider;
  80    unsigned usecs;
  81
  82    _glthread_Mutex mutex;
  83
  84    struct list_head delayed;
  85    size_t numDelayed;
  86 };
  87
  88
  89 static INLINE struct pb_cache_buffer *
  90 pb_cache_buffer(struct pb_buffer *buf)
  91 {
  92    assert(buf);
  93    return (struct pb_cache_buffer *)buf;
  94 }
  95
  96
  97 static INLINE struct pb_cache_manager *
  98 pb_cache_manager(struct pb_manager *mgr)
  99 {
 100    assert(mgr);
 101    return (struct pb_cache_manager *)mgr;
 102 }
 103
 104
 105 /**
 106  * Actually destroy the buffer.
 107  */
 108 static INLINE void
 109 _pb_cache_buffer_destroy(struct pb_cache_buffer *buf)
 110 {
 111    struct pb_cache_manager *mgr = buf->mgr;
 112
 113    LIST_DEL(&buf->head);
 114    assert(mgr->numDelayed);
 115    --mgr->numDelayed;
 116    assert(!buf->base.base.refcount);
 117    pb_reference(&buf->buffer, NULL);
 118    FREE(buf);
 119 }
 120
 121
 122 /**
 123  * Free as many cache buffers from the list head as possible.
 124  */
 125 static void
 126 _pb_cache_buffer_list_check_free(struct pb_cache_manager *mgr)
 127 {
 128    struct list_head *curr, *next;
 129    struct pb_cache_buffer *buf;
 130    struct util_time now;
 131
 132    util_time_get(&now);
 133
 134    curr = mgr->delayed.next;
 135    next = curr->next;
 136    while(curr != &mgr->delayed) {
 137       buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
 138
 139       if(!util_time_timeout(&buf->start, &buf->end, &now))
 140          break;
 141
 142       _pb_cache_buffer_destroy(buf);
 143
 144       curr = next;
 145       next = curr->next;
 146    }
 147 }
 148
 149
 150 static void
 151 pb_cache_buffer_destroy(struct pb_buffer *_buf)
 152 {
 153    struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
 154    struct pb_cache_manager *mgr = buf->mgr;
 155
 156    _glthread_LOCK_MUTEX(mgr->mutex);
 157    assert(buf->base.base.refcount == 0);
 158
 159    _pb_cache_buffer_list_check_free(mgr);
 160
 161    util_time_get(&buf->start);
 162    util_time_add(&buf->start, mgr->usecs, &buf->end);
 163    LIST_ADDTAIL(&buf->head, &mgr->delayed);
 164    ++mgr->numDelayed;
 165    _glthread_UNLOCK_MUTEX(mgr->mutex);
 166 }
 167
 168
 169 static void *
 170 pb_cache_buffer_map(struct pb_buffer *_buf,
 171                   unsigned flags)
 172 {
 173    struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
 174    return pb_map(buf->buffer, flags);
 175 }
 176
 177
 178 static void
 179 pb_cache_buffer_unmap(struct pb_buffer *_buf)
 180 {
 181    struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
 182    pb_unmap(buf->buffer);
 183 }
 184
 185
 186 static void
 187 pb_cache_buffer_get_base_buffer(struct pb_buffer *_buf,
 188                               struct pb_buffer **base_buf,
 189                               unsigned *offset)
 190 {
 191    struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
 192    pb_get_base_buffer(buf->buffer, base_buf, offset);
 193 }
 194
 195
 196 const struct pb_vtbl
 197 pb_cache_buffer_vtbl = {
 198       pb_cache_buffer_destroy,
 199       pb_cache_buffer_map,
 200       pb_cache_buffer_unmap,
 201       pb_cache_buffer_get_base_buffer
 202 };
 203
 204
 205 static INLINE boolean
 206 pb_cache_is_buffer_compat(struct pb_cache_buffer *buf,
 207                           size_t size,
 208                           const struct pb_desc *desc)
 209 {
 210    /* TODO: be more lenient with size */
 211    if(buf->base.base.size != size)
 212       return FALSE;
 213
 214    if(!pb_check_alignment(desc->alignment, buf->base.base.alignment))
 215       return FALSE;
 216
 217    /* XXX: check usage too? */
 218
 219    return TRUE;
 220 }
 221
 222
 223 static struct pb_buffer *
 224 pb_cache_manager_create_buffer(struct pb_manager *_mgr,
 225                                size_t size,
 226                                const struct pb_desc *desc)
 227 {
 228    struct pb_cache_manager *mgr = pb_cache_manager(_mgr);
 229    struct pb_cache_buffer *buf;
 230    struct pb_cache_buffer *curr_buf;
 231    struct list_head *curr, *next;
 232    struct util_time now;
 233
 234    _glthread_LOCK_MUTEX(mgr->mutex);
 235
 236    buf = NULL;
 237    curr = mgr->delayed.next;
 238    next = curr->next;
 239
 240    /* search in the expired buffers, freeing them in the process */
 241    util_time_get(&now);
 242    while(curr != &mgr->delayed) {
 243       curr_buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
 244       if(!buf && pb_cache_is_buffer_compat(curr_buf, size, desc))
 245          buf = curr_buf;
 246       else if(util_time_timeout(&curr_buf->start, &curr_buf->end, &now))
 247          _pb_cache_buffer_destroy(curr_buf);
 248       curr = next;
 249       next = curr->next;
 250    }
 251
 252    /* keep searching in the hot buffers */
 253    while(!buf && curr != &mgr->delayed) {
 254       curr_buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
 255       if(pb_cache_is_buffer_compat(curr_buf, size, desc))
 256          buf = curr_buf;
 257       curr = next;
 258       next = curr->next;
 259    }
 260
 261    if(buf) {
 262       LIST_DEL(&buf->head);
 263       _glthread_UNLOCK_MUTEX(mgr->mutex);
 264       ++buf->base.base.refcount;
 265       return &buf->base;
 266    }
 267
 268    _glthread_UNLOCK_MUTEX(mgr->mutex);
 269
 270    buf = CALLOC_STRUCT(pb_cache_buffer);
 271    if(!buf)
 272       return NULL;
 273
 274    buf->buffer = mgr->provider->create_buffer(mgr->provider, size, desc);
 275    if(!buf->buffer) {
 276       FREE(buf);
 277       return NULL;
 278    }
 279
 280    assert(buf->buffer->base.refcount >= 1);
 281    assert(pb_check_alignment(desc->alignment, buf->buffer->base.alignment));
 282    assert((buf->buffer->base.usage & desc->usage) == desc->usage);
 283    assert(buf->buffer->base.size >= size);
 284
 285    buf->base.base.refcount = 1;
 286    buf->base.base.alignment = buf->buffer->base.alignment;
 287    buf->base.base.usage = buf->buffer->base.usage;
 288    buf->base.base.size = buf->buffer->base.size;
 289
 290    buf->base.vtbl = &pb_cache_buffer_vtbl;
 291    buf->mgr = mgr;
 292
 293    return &buf->base;
 294 }
 295
 296
 297 static void
 298 pb_cache_manager_destroy(struct pb_manager *_mgr)
 299 {
 300    struct pb_cache_manager *mgr = pb_cache_manager(_mgr);
 301    struct list_head *curr, *next;
 302    struct pb_cache_buffer *buf;
 303
 304    _glthread_LOCK_MUTEX(mgr->mutex);
 305    curr = mgr->delayed.next;
 306    next = curr->next;
 307    while(curr != &mgr->delayed) {
 308       buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
 309       _pb_cache_buffer_destroy(buf);
 310       curr = next;
 311       next = curr->next;
 312    }
 313    _glthread_UNLOCK_MUTEX(mgr->mutex);
 314
 315    FREE(mgr);
 316 }
 317
 318
 319 struct pb_manager *
 320 pb_cache_manager_create(struct pb_manager *provider,
 321                         unsigned usecs)
 322 {
 323    struct pb_cache_manager *mgr;
 324
 325    mgr = (struct pb_cache_manager *)CALLOC(1, sizeof(*mgr));
 326    if (!mgr)
 327       return NULL;
 328
 329    mgr->base.destroy = pb_cache_manager_destroy;
 330    mgr->base.create_buffer = pb_cache_manager_create_buffer;
 331    mgr->provider = provider;
 332    mgr->usecs = usecs;
 333    LIST_INITHEAD(&mgr->delayed);
 334    mgr->numDelayed = 0;
 335    _glthread_INIT_MUTEX(mgr->mutex);
 336
 337    return &mgr->base;
 338 }