pb_bufmgr_cache.c 9.52 KB
Newer Older
José Fonseca's avatar
José Fonseca committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
/**************************************************************************
 *
 * Copyright 2007-2008 Tungsten Graphics, Inc., Cedar Park, Texas.
 * All Rights Reserved.
 *
 * 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, sub license, 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 (including the
 * next paragraph) 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 NON-INFRINGEMENT.
 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS 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.
 *
 **************************************************************************/

/**
 * \file
 * Buffer cache.
 * 
32
 * \author Jose Fonseca <jrfonseca-at-tungstengraphics-dot-com>
José Fonseca's avatar
José Fonseca committed
33 34 35 36 37
 * \author Thomas Hellström <thomas-at-tungstengraphics-dot-com>
 */


#include "pipe/p_compiler.h"
38
#include "util/u_debug.h"
39
#include "os/os_thread.h"
40
#include "util/u_memory.h"
José Fonseca's avatar
José Fonseca committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
#include "util/u_double_list.h"
#include "util/u_time.h"

#include "pb_buffer.h"
#include "pb_bufmgr.h"


/**
 * Convenience macro (type safe).
 */
#define SUPER(__derived) (&(__derived)->base)


struct pb_cache_manager;


/**
 * Wrapper around a pipe buffer which adds delayed destruction.
 */
struct pb_cache_buffer
{
   struct pb_buffer base;
   
   struct pb_buffer *buffer;
   struct pb_cache_manager *mgr;

   /** Caching time interval */
68
   int64_t start, end;
José Fonseca's avatar
José Fonseca committed
69 70 71 72 73 74 75 76 77 78 79 80

   struct list_head head;
};


struct pb_cache_manager
{
   struct pb_manager base;

   struct pb_manager *provider;
   unsigned usecs;
   
81
   pipe_mutex mutex;
José Fonseca's avatar
José Fonseca committed
82 83
   
   struct list_head delayed;
84
   pb_size numDelayed;
José Fonseca's avatar
José Fonseca committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
};


static INLINE struct pb_cache_buffer *
pb_cache_buffer(struct pb_buffer *buf)
{
   assert(buf);
   return (struct pb_cache_buffer *)buf;
}


static INLINE struct pb_cache_manager *
pb_cache_manager(struct pb_manager *mgr)
{
   assert(mgr);
   return (struct pb_cache_manager *)mgr;
}


/**
 * Actually destroy the buffer.
 */
static INLINE void
_pb_cache_buffer_destroy(struct pb_cache_buffer *buf)
{
   struct pb_cache_manager *mgr = buf->mgr;

   LIST_DEL(&buf->head);
   assert(mgr->numDelayed);
   --mgr->numDelayed;
115
   assert(!pipe_is_referenced(&buf->base.base.reference));
José Fonseca's avatar
José Fonseca committed
116 117 118 119 120 121 122 123 124 125 126 127 128
   pb_reference(&buf->buffer, NULL);
   FREE(buf);
}


/**
 * Free as many cache buffers from the list head as possible. 
 */
static void
_pb_cache_buffer_list_check_free(struct pb_cache_manager *mgr)
{
   struct list_head *curr, *next;
   struct pb_cache_buffer *buf;
129
   int64_t now;
José Fonseca's avatar
José Fonseca committed
130
   
131
   now = os_time_get();
José Fonseca's avatar
José Fonseca committed
132 133 134 135 136 137
   
   curr = mgr->delayed.next;
   next = curr->next;
   while(curr != &mgr->delayed) {
      buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);

138
      if(!os_time_timeout(buf->start, buf->end, now))
José Fonseca's avatar
José Fonseca committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
	 break;
	 
      _pb_cache_buffer_destroy(buf);

      curr = next; 
      next = curr->next;
   }
}


static void
pb_cache_buffer_destroy(struct pb_buffer *_buf)
{
   struct pb_cache_buffer *buf = pb_cache_buffer(_buf);   
   struct pb_cache_manager *mgr = buf->mgr;

155
   pipe_mutex_lock(mgr->mutex);
156
   assert(!pipe_is_referenced(&buf->base.base.reference));
José Fonseca's avatar
José Fonseca committed
157 158 159
   
   _pb_cache_buffer_list_check_free(mgr);
   
160 161
   buf->start = os_time_get();
   buf->end = buf->start + mgr->usecs;
José Fonseca's avatar
José Fonseca committed
162 163
   LIST_ADDTAIL(&buf->head, &mgr->delayed);
   ++mgr->numDelayed;
164
   pipe_mutex_unlock(mgr->mutex);
José Fonseca's avatar
José Fonseca committed
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
}


static void *
pb_cache_buffer_map(struct pb_buffer *_buf, 
                  unsigned flags)
{
   struct pb_cache_buffer *buf = pb_cache_buffer(_buf);   
   return pb_map(buf->buffer, flags);
}


static void
pb_cache_buffer_unmap(struct pb_buffer *_buf)
{
   struct pb_cache_buffer *buf = pb_cache_buffer(_buf);   
   pb_unmap(buf->buffer);
}


185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
static enum pipe_error 
pb_cache_buffer_validate(struct pb_buffer *_buf, 
                         struct pb_validate *vl,
                         unsigned flags)
{
   struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
   return pb_validate(buf->buffer, vl, flags);
}


static void
pb_cache_buffer_fence(struct pb_buffer *_buf, 
                      struct pipe_fence_handle *fence)
{
   struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
   pb_fence(buf->buffer, fence);
}


José Fonseca's avatar
José Fonseca committed
204 205 206
static void
pb_cache_buffer_get_base_buffer(struct pb_buffer *_buf,
                              struct pb_buffer **base_buf,
207
                              pb_size *offset)
José Fonseca's avatar
José Fonseca committed
208 209 210 211 212 213 214 215 216 217 218
{
   struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
   pb_get_base_buffer(buf->buffer, base_buf, offset);
}


const struct pb_vtbl 
pb_cache_buffer_vtbl = {
      pb_cache_buffer_destroy,
      pb_cache_buffer_map,
      pb_cache_buffer_unmap,
219 220
      pb_cache_buffer_validate,
      pb_cache_buffer_fence,
José Fonseca's avatar
José Fonseca committed
221 222 223 224
      pb_cache_buffer_get_base_buffer
};


225 226
static INLINE boolean
pb_cache_is_buffer_compat(struct pb_cache_buffer *buf,  
227
                          pb_size size,
228 229
                          const struct pb_desc *desc)
{
230 231
   void *map;

232 233 234 235 236
   if(buf->base.base.size < size)
      return FALSE;

   /* be lenient with size */
   if(buf->base.base.size >= 2*size)
237 238 239 240 241
      return FALSE;
   
   if(!pb_check_alignment(desc->alignment, buf->base.base.alignment))
      return FALSE;
   
242 243
   if(!pb_check_usage(desc->usage, buf->base.base.usage))
      return FALSE;
244 245 246 247 248 249 250

   map = pb_map(buf->buffer, PIPE_BUFFER_USAGE_DONTBLOCK);
   if (!map) {
      return FALSE;
   }

   pb_unmap(buf->buffer);
251 252 253 254 255
   
   return TRUE;
}


José Fonseca's avatar
José Fonseca committed
256 257
static struct pb_buffer *
pb_cache_manager_create_buffer(struct pb_manager *_mgr, 
258
                               pb_size size,
José Fonseca's avatar
José Fonseca committed
259 260 261 262
                               const struct pb_desc *desc)
{
   struct pb_cache_manager *mgr = pb_cache_manager(_mgr);
   struct pb_cache_buffer *buf;
263
   struct pb_cache_buffer *curr_buf;
José Fonseca's avatar
José Fonseca committed
264
   struct list_head *curr, *next;
265
   int64_t now;
José Fonseca's avatar
José Fonseca committed
266
   
267
   pipe_mutex_lock(mgr->mutex);
268 269

   buf = NULL;
José Fonseca's avatar
José Fonseca committed
270 271
   curr = mgr->delayed.next;
   next = curr->next;
272 273
   
   /* search in the expired buffers, freeing them in the process */
274
   now = os_time_get();
José Fonseca's avatar
José Fonseca committed
275
   while(curr != &mgr->delayed) {
276 277 278
      curr_buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
      if(!buf && pb_cache_is_buffer_compat(curr_buf, size, desc))
	 buf = curr_buf;
279
      else if(os_time_timeout(curr_buf->start, curr_buf->end, now))
280
	 _pb_cache_buffer_destroy(curr_buf);
281 282 283
      else
         /* This buffer (and all hereafter) are still hot in cache */
         break;
284 285 286
      curr = next; 
      next = curr->next;
   }
José Fonseca's avatar
José Fonseca committed
287

288
   /* keep searching in the hot buffers */
289 290 291 292 293 294 295 296 297 298 299
   if(!buf) {
      while(curr != &mgr->delayed) {
         curr_buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
         if(pb_cache_is_buffer_compat(curr_buf, size, desc)) {
            buf = curr_buf;
            break;
         }
         /* no need to check the timeout here */
         curr = next;
         next = curr->next;
      }
José Fonseca's avatar
José Fonseca committed
300
   }
301 302 303
   
   if(buf) {
      LIST_DEL(&buf->head);
304
      pipe_mutex_unlock(mgr->mutex);
305
      /* Increase refcount */
306
      pipe_reference_init(&buf->base.base.reference, 1);
307 308 309
      return &buf->base;
   }
   
310
   pipe_mutex_unlock(mgr->mutex);
José Fonseca's avatar
José Fonseca committed
311 312 313 314 315 316 317 318 319 320 321

   buf = CALLOC_STRUCT(pb_cache_buffer);
   if(!buf)
      return NULL;
   
   buf->buffer = mgr->provider->create_buffer(mgr->provider, size, desc);
   if(!buf->buffer) {
      FREE(buf);
      return NULL;
   }
   
322
   assert(pipe_is_referenced(&buf->buffer->base.reference));
323
   assert(pb_check_alignment(desc->alignment, buf->buffer->base.alignment));
324
   assert(pb_check_usage(desc->usage, buf->buffer->base.usage));
325 326
   assert(buf->buffer->base.size >= size);
   
327
   pipe_reference_init(&buf->base.base.reference, 1);
José Fonseca's avatar
José Fonseca committed
328 329 330 331 332 333 334 335 336 337 338
   buf->base.base.alignment = buf->buffer->base.alignment;
   buf->base.base.usage = buf->buffer->base.usage;
   buf->base.base.size = buf->buffer->base.size;
   
   buf->base.vtbl = &pb_cache_buffer_vtbl;
   buf->mgr = mgr;
   
   return &buf->base;
}


339 340
static void
pb_cache_manager_flush(struct pb_manager *_mgr)
José Fonseca's avatar
José Fonseca committed
341 342 343 344 345
{
   struct pb_cache_manager *mgr = pb_cache_manager(_mgr);
   struct list_head *curr, *next;
   struct pb_cache_buffer *buf;

346
   pipe_mutex_lock(mgr->mutex);
José Fonseca's avatar
José Fonseca committed
347 348 349 350 351 352 353 354
   curr = mgr->delayed.next;
   next = curr->next;
   while(curr != &mgr->delayed) {
      buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
      _pb_cache_buffer_destroy(buf);
      curr = next; 
      next = curr->next;
   }
355
   pipe_mutex_unlock(mgr->mutex);
356 357 358 359
   
   assert(mgr->provider->flush);
   if(mgr->provider->flush)
      mgr->provider->flush(mgr->provider);
360 361 362 363 364 365
}


static void
pb_cache_manager_destroy(struct pb_manager *mgr)
{
366
   pb_cache_manager_flush(mgr);
José Fonseca's avatar
José Fonseca committed
367 368 369 370 371 372 373 374 375 376
   FREE(mgr);
}


struct pb_manager *
pb_cache_manager_create(struct pb_manager *provider, 
                     	unsigned usecs) 
{
   struct pb_cache_manager *mgr;

377 378 379 380
   if(!provider)
      return NULL;
   
   mgr = CALLOC_STRUCT(pb_cache_manager);
José Fonseca's avatar
José Fonseca committed
381 382 383 384 385
   if (!mgr)
      return NULL;

   mgr->base.destroy = pb_cache_manager_destroy;
   mgr->base.create_buffer = pb_cache_manager_create_buffer;
386
   mgr->base.flush = pb_cache_manager_flush;
José Fonseca's avatar
José Fonseca committed
387 388 389 390
   mgr->provider = provider;
   mgr->usecs = usecs;
   LIST_INITHEAD(&mgr->delayed);
   mgr->numDelayed = 0;
391
   pipe_mutex_init(mgr->mutex);
José Fonseca's avatar
José Fonseca committed
392 393 394
      
   return &mgr->base;
}