Home | History | Annotate | Download | only in pipebuffer 
      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 (at) 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_fence_handle;
     63 
     64 
     65 /**
     66  * List of buffers which are awaiting fence signalling.
     67  */
     68 struct fenced_buffer_list;
     69 
     70 
     71 struct pb_fence_ops
     72 {
     73    void (*destroy)( struct pb_fence_ops *ops );
     74 
     75    /** Set ptr = fence, with reference counting */
     76    void (*fence_reference)( struct pb_fence_ops *ops,
     77                             struct pipe_fence_handle **ptr,
     78                             struct pipe_fence_handle *fence );
     79 
     80    /**
     81     * Checks whether the fence has been signalled.
     82     * \param flags  driver-specific meaning
     83     * \return zero on success.
     84     */
     85    int (*fence_signalled)( struct pb_fence_ops *ops,
     86                            struct pipe_fence_handle *fence,
     87                            unsigned flag );
     88 
     89    /**
     90     * Wait for the fence to finish.
     91     * \param flags  driver-specific meaning
     92     * \return zero on success.
     93     */
     94    int (*fence_finish)( struct pb_fence_ops *ops,
     95                         struct pipe_fence_handle *fence,
     96                         unsigned flag );
     97 };
     98 
     99 
    100 #ifdef __cplusplus
    101 }
    102 #endif
    103 
    104 #endif /*PB_BUFFER_FENCED_H_*/
    105