pb_buffer.h File Reference

Generic code for buffers. More...

Include dependency graph for pb_buffer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	pb_desc
	Buffer description. More...
struct	pb_buffer
	Base class for all pb_* buffers. More...
struct	pb_vtbl
	Virtual function table for the buffer storage operations. More...
Functions
static struct pipe_buffer *	pb_pipe_buffer (struct pb_buffer *pbuf)
static struct pb_buffer *	pb_buffer (struct pipe_buffer *buf)
static void *	pb_map (struct pb_buffer *buf, unsigned flags)
static void	pb_unmap (struct pb_buffer *buf)
static void	pb_get_base_buffer (struct pb_buffer *buf, struct pb_buffer **base_buf, unsigned *offset)
static void	pb_destroy (struct pb_buffer *buf)
static void	pb_reference (struct pb_buffer **dst, struct pb_buffer *src)
static boolean	pb_check_alignment (size_t requested, size_t provided)
	Utility function to check whether the provided alignment is consistent with the requested or not.
static boolean	pb_check_usage (unsigned requested, unsigned provided)
	Utility function to check whether the provided alignment is consistent with the requested or not.
struct pb_buffer *	pb_malloc_buffer_create (size_t size, const struct pb_desc *desc)
	Malloc-based buffer to store data that can't be used by the graphics hardware.
void	pb_init_winsys (struct pipe_winsys *winsys)

---

Detailed Description

Generic code for buffers.

Behind a pipe buffle handle there can be DMA buffers, client (or user) buffers, regular malloced buffers, etc. This file provides an abstract base buffer handle that allows the driver to cope with all those kinds of buffers in a more flexible way.

There is no obligation of a winsys driver to use this library. And a pipe driver should be completly agnostic about it.

Author:

Jos� Fonseca <jrfonseca@tungstengraphics.com>

Definition in file pb_buffer.h.

---

Function Documentation

static struct pb_buffer* pb_buffer

(

struct pipe_buffer *

buf

)

[static, read]

Definition at line 133 of file pb_buffer.h.

References assert.

{
   assert(buf);
   /* Could add a magic cookie check on debug builds.
    */
   return (struct pb_buffer *)buf;
}

static boolean pb_check_alignment	(	size_t	requested,
		size_t	provided
	)			[static]

Utility function to check whether the provided alignment is consistent with the requested or not.

Definition at line 211 of file pb_buffer.h.

References FALSE, and TRUE.

{
   return requested <= provided && (provided % requested) == 0 ? TRUE : FALSE;
}

static boolean pb_check_usage	(	unsigned	requested,
		unsigned	provided
	)			[static]

Utility function to check whether the provided alignment is consistent with the requested or not.

Definition at line 222 of file pb_buffer.h.

References FALSE, and TRUE.

{
   return (requested & provided) == requested ? TRUE : FALSE;
}

static void pb_destroy

(

struct pb_buffer *

buf

)

[static]

Definition at line 181 of file pb_buffer.h.

References assert, pb_vtbl::destroy, and pb_buffer::vtbl.

{
   assert(buf);
   if(!buf)
      return;
   buf->vtbl->destroy(buf);
}

static void pb_get_base_buffer	(	struct pb_buffer *	buf,
		struct pb_buffer **	base_buf,
		unsigned *	offset
	)			[static]

Definition at line 166 of file pb_buffer.h.

References assert, pb_vtbl::get_base_buffer, and pb_buffer::vtbl.

{
   assert(buf);
   if(!buf) {
      base_buf = NULL;
      offset = 0;
      return;
   }
   buf->vtbl->get_base_buffer(buf, base_buf, offset);
}

void pb_init_winsys

(

struct pipe_winsys *

winsys

)

Definition at line 164 of file pb_winsys.c.

References pipe_winsys::buffer_destroy, pipe_winsys::buffer_map, pipe_winsys::buffer_unmap, pb_winsys_buffer_destroy(), pb_winsys_buffer_map(), pb_winsys_buffer_unmap(), pb_winsys_user_buffer_create(), and pipe_winsys::user_buffer_create.

{
   winsys->user_buffer_create = pb_winsys_user_buffer_create;
   winsys->buffer_map = pb_winsys_buffer_map;
   winsys->buffer_unmap = pb_winsys_buffer_unmap;
   winsys->buffer_destroy = pb_winsys_buffer_destroy;
}

struct pb_buffer* pb_malloc_buffer_create	(	size_t	size,
		const struct pb_desc *	desc
	)			[read]

Malloc-based buffer to store data that can't be used by the graphics hardware.

Definition at line 104 of file pb_buffer_malloc.c.

References align_malloc(), pb_desc::alignment, pipe_buffer::alignment, pb_buffer::base, malloc_buffer::base, CALLOC_STRUCT, malloc_buffer::data, FREE, pipe_buffer::refcount, pipe_buffer::size, pb_desc::usage, pipe_buffer::usage, and pb_buffer::vtbl.

{
   struct malloc_buffer *buf;
   
   /* TODO: do a single allocation */
   
   buf = CALLOC_STRUCT(malloc_buffer);
   if(!buf)
      return NULL;

   buf->base.base.refcount = 1;
   buf->base.base.alignment = desc->alignment;
   buf->base.base.usage = desc->usage;
   buf->base.base.size = size;
   buf->base.vtbl = &malloc_buffer_vtbl;

   buf->data = align_malloc(size, desc->alignment < sizeof(void*) ? sizeof(void*) : desc->alignment);
   if(!buf->data) {
      FREE(buf);
      return NULL;
   }

   return &buf->base;
}

static void* pb_map	(	struct pb_buffer *	buf,
		unsigned	flags
	)			[static]

Definition at line 145 of file pb_buffer.h.

References assert, pb_vtbl::map, and pb_buffer::vtbl.

{
   assert(buf);
   if(!buf)
      return NULL;
   return buf->vtbl->map(buf, flags);
}

static struct pipe_buffer* pb_pipe_buffer

(

struct pb_buffer *

pbuf

)

[static, read]

Definition at line 125 of file pb_buffer.h.

References assert, and pb_buffer::base.

{
   assert(pbuf);
   return &pbuf->base;
}

static void pb_reference	(	struct pb_buffer **	dst,
		struct pb_buffer *	src
	)			[static]

Definition at line 193 of file pb_buffer.h.

References pb_buffer::base, pb_destroy(), and pipe_buffer::refcount.

{
   if (src) 
      src->base.refcount++;

   if (*dst && --(*dst)->base.refcount == 0)
      pb_destroy( *dst );

   *dst = src;
}

static void pb_unmap

(

struct pb_buffer *

buf

)

[static]

Definition at line 156 of file pb_buffer.h.

References assert, pb_vtbl::unmap, and pb_buffer::vtbl.

{
   assert(buf);
   if(!buf)
      return;
   buf->vtbl->unmap(buf);
}

---