src/gallium/auxiliary/pipebuffer/pb_buffer_fenced.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 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 fencing.
  31  *
  32  * "Fenced buffers" is actually a misnomer. They should be referred as
  33  * "fenceable buffers", i.e, buffers that can be fenced, but I couldn't find
  34  * the word "fenceable" in the dictionary.
  35  *
  36  * A "fenced buffer" is a decorator around a normal buffer, which adds two
  37  * special properties:
  38  * - the ability for the destruction to be delayed by a fence;
  39  * - reference counting.
  40  *
  41  * Usually DMA buffers have a life-time that will extend the life-time of its
  42  * handle. The end-of-life is dictated by the fence signalling.
  43  *
  44  * Between the handle's destruction, and the fence signalling, the buffer is
  45  * stored in a fenced buffer list.
  46  *
  47  * \author Jose Fonseca <jrfonseca@tungstengraphics.com>
  48  */
  49
  50 #ifndef PB_BUFFER_FENCED_H_
  51 #define PB_BUFFER_FENCED_H_
  52
  53
  54 #include "util/u_debug.h"
  55
  56
  57 #ifdef __cplusplus
  58 extern "C" {
  59 #endif
  60
  61
  62 struct pipe_buffer;
  63 struct pipe_fence_handle;
  64
  65
  66 /**
  67  * List of buffers which are awaiting fence signalling.
  68  */
  69 struct fenced_buffer_list;
  70
  71
  72 struct pb_fence_ops
  73 {
  74    void (*destroy)( struct pb_fence_ops *ops );
  75
  76    /** Set ptr = fence, with reference counting */
  77    void (*fence_reference)( struct pb_fence_ops *ops,
  78                             struct pipe_fence_handle **ptr,
  79                             struct pipe_fence_handle *fence );
  80
  81    /**
  82     * Checks whether the fence has been signalled.
  83     * \param flags  driver-specific meaning
  84     * \return zero on success.
  85     */
  86    int (*fence_signalled)( struct pb_fence_ops *ops,
  87                            struct pipe_fence_handle *fence,
  88                            unsigned flag );
  89
  90    /**
  91     * Wait for the fence to finish.
  92     * \param flags  driver-specific meaning
  93     * \return zero on success.
  94     */
  95    int (*fence_finish)( struct pb_fence_ops *ops,
  96                         struct pipe_fence_handle *fence,
  97                         unsigned flag );
  98 };
  99
 100
 101 /**
 102  * Create a fenced buffer list.
 103  *
 104  * See also fenced_bufmgr_create for a more convenient way to use this.
 105  */
 106 struct fenced_buffer_list *
 107 fenced_buffer_list_create(struct pb_fence_ops *ops);
 108
 109
 110 /**
 111  * Walk the fenced buffer list to check and free signalled buffers.
 112  */
 113 void
 114 fenced_buffer_list_check_free(struct fenced_buffer_list *fenced_list,
 115                               int wait);
 116
 117
 118 #ifdef DEBUG
 119 void
 120 fenced_buffer_list_dump(struct fenced_buffer_list *fenced_list);
 121 #endif
 122
 123
 124 void
 125 fenced_buffer_list_destroy(struct fenced_buffer_list *fenced_list);
 126
 127
 128 /**
 129  * Wrap a buffer in a fenced buffer.
 130  *
 131  * NOTE: this will not increase the buffer reference count.
 132  */
 133 struct pb_buffer *
 134 fenced_buffer_create(struct fenced_buffer_list *fenced,
 135                      struct pb_buffer *buffer);
 136
 137
 138 #ifdef __cplusplus
 139 }
 140 #endif
 141
 142 #endif /*PB_BUFFER_FENCED_H_*/