/**************************************************************************
*
- * Copyright 2007-2008 Tungsten Graphics, Inc., Cedar Park, Texas.
+ * Copyright 2007-2008 VMware, Inc.
* All Rights Reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* 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
+ * IN NO EVENT SHALL VMWARE 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.
*
- * \author Jose Fonseca <jrfonseca-at-tungstengraphics-dot-com>
- * \author Thomas Hellström <thomas-at-tungstengraphics-dot-com>
+ * \author Jose Fonseca <jfonseca-at-vmware-dot-com>
+ * \author Thomas Hellström <thellstom-at-vmware-dot-com>
*/
#include "pipe/p_compiler.h"
#include "util/u_debug.h"
-#include "pipe/p_thread.h"
+#include "os/os_thread.h"
#include "util/u_memory.h"
-#include "util/u_double_list.h"
+#include "util/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;
+#include "pb_cache.h"
/**
struct pb_cache_buffer
{
struct pb_buffer base;
-
struct pb_buffer *buffer;
struct pb_cache_manager *mgr;
-
- /** Caching time interval */
- struct util_time start, end;
-
- struct list_head head;
+ struct pb_cache_entry cache_entry;
};
struct pb_cache_manager
{
struct pb_manager base;
-
struct pb_manager *provider;
- unsigned usecs;
-
- pipe_mutex mutex;
-
- struct list_head delayed;
- pb_size numDelayed;
+ struct pb_cache cache;
};
-static INLINE struct pb_cache_buffer *
+static inline struct pb_cache_buffer *
pb_cache_buffer(struct pb_buffer *buf)
{
assert(buf);
}
-static INLINE struct pb_cache_manager *
+static inline struct pb_cache_manager *
pb_cache_manager(struct pb_manager *mgr)
{
assert(mgr);
}
-/**
- * Actually destroy the buffer.
- */
-static INLINE void
-_pb_cache_buffer_destroy(struct pb_cache_buffer *buf)
+void
+pb_cache_manager_remove_buffer(struct pb_buffer *pb_buf)
{
- struct pb_cache_manager *mgr = buf->mgr;
+ struct pb_cache_buffer *buf = pb_cache_buffer(pb_buf);
- LIST_DEL(&buf->head);
- assert(mgr->numDelayed);
- --mgr->numDelayed;
- assert(!pipe_is_referenced(&buf->base.base.reference));
- pb_reference(&buf->buffer, NULL);
- FREE(buf);
+ /* the buffer won't be added if mgr is NULL */
+ buf->mgr = NULL;
}
-
/**
- * Free as many cache buffers from the list head as possible.
+ * Actually destroy the buffer.
*/
static void
-_pb_cache_buffer_list_check_free(struct pb_cache_manager *mgr)
+_pb_cache_buffer_destroy(struct pb_buffer *pb_buf)
{
- struct list_head *curr, *next;
- struct pb_cache_buffer *buf;
- struct util_time now;
-
- util_time_get(&now);
-
- curr = mgr->delayed.next;
- next = curr->next;
- while(curr != &mgr->delayed) {
- buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
-
- if(!util_time_timeout(&buf->start, &buf->end, &now))
- break;
-
- _pb_cache_buffer_destroy(buf);
-
- curr = next;
- next = curr->next;
- }
+ struct pb_cache_buffer *buf = pb_cache_buffer(pb_buf);
+
+ assert(!pipe_is_referenced(&buf->base.reference));
+ pb_reference(&buf->buffer, NULL);
+ FREE(buf);
}
struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
struct pb_cache_manager *mgr = buf->mgr;
- pipe_mutex_lock(mgr->mutex);
- assert(!pipe_is_referenced(&buf->base.base.reference));
-
- _pb_cache_buffer_list_check_free(mgr);
-
- util_time_get(&buf->start);
- util_time_add(&buf->start, mgr->usecs, &buf->end);
- LIST_ADDTAIL(&buf->head, &mgr->delayed);
- ++mgr->numDelayed;
- pipe_mutex_unlock(mgr->mutex);
+ if (!mgr) {
+ pb_reference(&buf->buffer, NULL);
+ FREE(buf);
+ return;
+ }
+
+ pb_cache_add_buffer(&buf->cache_entry);
}
static void *
pb_cache_buffer_map(struct pb_buffer *_buf,
- unsigned flags)
+ unsigned flags, void *flush_ctx)
{
struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
- return pb_map(buf->buffer, flags);
+ return pb_map(buf->buffer, flags, flush_ctx);
}
};
-static INLINE boolean
-pb_cache_is_buffer_compat(struct pb_cache_buffer *buf,
- pb_size size,
- const struct pb_desc *desc)
+static bool
+pb_cache_can_reclaim_buffer(struct pb_buffer *_buf)
{
- if(buf->base.base.size < size)
- return FALSE;
+ struct pb_cache_buffer *buf = pb_cache_buffer(_buf);
- /* be lenient with size */
- if(buf->base.base.size >= 2*size)
- return FALSE;
-
- if(!pb_check_alignment(desc->alignment, buf->base.base.alignment))
- return FALSE;
-
- if(!pb_check_usage(desc->usage, buf->base.base.usage))
- return FALSE;
-
- return TRUE;
+ if (buf->mgr->provider->is_buffer_busy) {
+ if (buf->mgr->provider->is_buffer_busy(buf->mgr->provider, buf->buffer))
+ return false;
+ } else {
+ void *ptr = pb_map(buf->buffer, PB_USAGE_DONTBLOCK, NULL);
+
+ if (!ptr)
+ return false;
+
+ pb_unmap(buf->buffer);
+ }
+
+ return true;
}
{
struct pb_cache_manager *mgr = pb_cache_manager(_mgr);
struct pb_cache_buffer *buf;
- struct pb_cache_buffer *curr_buf;
- struct list_head *curr, *next;
- struct util_time now;
-
- pipe_mutex_lock(mgr->mutex);
- buf = NULL;
- curr = mgr->delayed.next;
- next = curr->next;
-
- /* search in the expired buffers, freeing them in the process */
- util_time_get(&now);
- while(curr != &mgr->delayed) {
- curr_buf = LIST_ENTRY(struct pb_cache_buffer, curr, head);
- if(!buf && pb_cache_is_buffer_compat(curr_buf, size, desc))
- buf = curr_buf;
- else if(util_time_timeout(&curr_buf->start, &curr_buf->end, &now))
- _pb_cache_buffer_destroy(curr_buf);
- else
- /* This buffer (and all hereafter) are still hot in cache */
- break;
- curr = next;
- next = curr->next;
- }
-
- /* keep searching in the hot buffers */
- 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;
- }
- }
-
- if(buf) {
- LIST_DEL(&buf->head);
- pipe_mutex_unlock(mgr->mutex);
- /* Increase refcount */
- pipe_reference(NULL, &buf->base.base.reference);
+ /* get a buffer from the cache */
+ buf = (struct pb_cache_buffer *)
+ pb_cache_reclaim_buffer(&mgr->cache, size, desc->alignment,
+ desc->usage);
+ if (buf)
return &buf->base;
- }
-
- pipe_mutex_unlock(mgr->mutex);
+ /* create a new one */
buf = CALLOC_STRUCT(pb_cache_buffer);
- if(!buf)
+ if (!buf)
return NULL;
buf->buffer = mgr->provider->create_buffer(mgr->provider, size, desc);
+
+ /* Empty the cache and try again. */
+ if (!buf->buffer) {
+ pb_cache_release_all_buffers(&mgr->cache);
+ buf->buffer = mgr->provider->create_buffer(mgr->provider, size, desc);
+ }
+
if(!buf->buffer) {
FREE(buf);
return NULL;
}
- assert(pipe_is_referenced(&buf->buffer->base.reference));
- assert(pb_check_alignment(desc->alignment, buf->buffer->base.alignment));
- assert(pb_check_usage(desc->usage, buf->buffer->base.usage));
- assert(buf->buffer->base.size >= size);
+ assert(pipe_is_referenced(&buf->buffer->reference));
+ assert(pb_check_alignment(desc->alignment, buf->buffer->alignment));
+ assert(buf->buffer->size >= size);
- pipe_reference_init(&buf->base.base.reference, 1);
- buf->base.base.alignment = buf->buffer->base.alignment;
- buf->base.base.usage = buf->buffer->base.usage;
- buf->base.base.size = buf->buffer->base.size;
+ pipe_reference_init(&buf->base.reference, 1);
+ buf->base.alignment = buf->buffer->alignment;
+ buf->base.usage = buf->buffer->usage;
+ buf->base.size = buf->buffer->size;
buf->base.vtbl = &pb_cache_buffer_vtbl;
buf->mgr = mgr;
+ pb_cache_init_entry(&mgr->cache, &buf->cache_entry, &buf->base);
return &buf->base;
}
pb_cache_manager_flush(struct pb_manager *_mgr)
{
struct pb_cache_manager *mgr = pb_cache_manager(_mgr);
- struct list_head *curr, *next;
- struct pb_cache_buffer *buf;
- pipe_mutex_lock(mgr->mutex);
- 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;
- }
- pipe_mutex_unlock(mgr->mutex);
+ pb_cache_release_all_buffers(&mgr->cache);
assert(mgr->provider->flush);
if(mgr->provider->flush)
static void
-pb_cache_manager_destroy(struct pb_manager *mgr)
+pb_cache_manager_destroy(struct pb_manager *_mgr)
{
- pb_cache_manager_flush(mgr);
+ struct pb_cache_manager *mgr = pb_cache_manager(_mgr);
+
+ pb_cache_deinit(&mgr->cache);
FREE(mgr);
}
-
+/**
+ * Create a caching buffer manager
+ *
+ * @param provider The buffer manager to which cache miss buffer requests
+ * should be redirected.
+ * @param usecs Unused buffers may be released from the cache after this
+ * time
+ * @param size_factor Declare buffers that are size_factor times bigger than
+ * the requested size as cache hits.
+ * @param bypass_usage Bitmask. If (requested usage & bypass_usage) != 0,
+ * buffer allocation requests are redirected to the provider.
+ * @param maximum_cache_size Maximum size of all unused buffers the cache can
+ * hold.
+ */
struct pb_manager *
pb_cache_manager_create(struct pb_manager *provider,
- unsigned usecs)
+ unsigned usecs,
+ float size_factor,
+ unsigned bypass_usage,
+ uint64_t maximum_cache_size)
{
struct pb_cache_manager *mgr;
- if(!provider)
+ if (!provider)
return NULL;
mgr = CALLOC_STRUCT(pb_cache_manager);
mgr->base.create_buffer = pb_cache_manager_create_buffer;
mgr->base.flush = pb_cache_manager_flush;
mgr->provider = provider;
- mgr->usecs = usecs;
- LIST_INITHEAD(&mgr->delayed);
- mgr->numDelayed = 0;
- pipe_mutex_init(mgr->mutex);
-
+ pb_cache_init(&mgr->cache, usecs, size_factor, bypass_usage,
+ maximum_cache_size,
+ _pb_cache_buffer_destroy,
+ pb_cache_can_reclaim_buffer);
return &mgr->base;
}