src/gallium/auxiliary/util/u_inlines.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 #ifndef U_INLINES_H
  29 #define U_INLINES_H
  30
  31 #include "pipe/p_context.h"
  32 #include "pipe/p_defines.h"
  33 #include "pipe/p_state.h"
  34 #include "pipe/p_screen.h"
  35 #include "util/u_debug.h"
  36 #include "util/u_debug_describe.h"
  37 #include "util/u_debug_refcnt.h"
  38 #include "util/u_atomic.h"
  39 #include "util/u_box.h"
  40 #include "util/u_math.h"
  41
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47
  48 /*
  49  * Reference counting helper functions.
  50  */
  51
  52
  53 static INLINE void
  54 pipe_reference_init(struct pipe_reference *reference, unsigned count)
  55 {
  56    p_atomic_set(&reference->count, count);
  57 }
  58
  59 static INLINE boolean
  60 pipe_is_referenced(struct pipe_reference *reference)
  61 {
  62    return p_atomic_read(&reference->count) != 0;
  63 }
  64
  65 /**
  66  * Update reference counting.
  67  * The old thing pointed to, if any, will be unreferenced.
  68  * Both 'ptr' and 'reference' may be NULL.
  69  * \return TRUE if the object's refcount hits zero and should be destroyed.
  70  */
  71 static INLINE boolean
  72 pipe_reference_described(struct pipe_reference *ptr,
  73                          struct pipe_reference *reference,
  74                          debug_reference_descriptor get_desc)
  75 {
  76    boolean destroy = FALSE;
  77
  78    if(ptr != reference) {
  79       /* bump the reference.count first */
  80       if (reference) {
  81          assert(pipe_is_referenced(reference));
  82          p_atomic_inc(&reference->count);
  83          debug_reference(reference, get_desc, 1);
  84       }
  85
  86       if (ptr) {
  87          assert(pipe_is_referenced(ptr));
  88          if (p_atomic_dec_zero(&ptr->count)) {
  89             destroy = TRUE;
  90          }
  91          debug_reference(ptr, get_desc, -1);
  92       }
  93    }
  94
  95    return destroy;
  96 }
  97
  98 static INLINE boolean
  99 pipe_reference(struct pipe_reference *ptr, struct pipe_reference *reference)
 100 {
 101    return pipe_reference_described(ptr, reference,
 102                                    (debug_reference_descriptor)debug_describe_reference);
 103 }
 104
 105 static INLINE void
 106 pipe_surface_reference(struct pipe_surface **ptr, struct pipe_surface *surf)
 107 {
 108    struct pipe_surface *old_surf = *ptr;
 109
 110    if (pipe_reference_described(&(*ptr)->reference, &surf->reference,
 111                                 (debug_reference_descriptor)debug_describe_surface))
 112       old_surf->context->surface_destroy(old_surf->context, old_surf);
 113    *ptr = surf;
 114 }
 115
 116 static INLINE void
 117 pipe_resource_reference(struct pipe_resource **ptr, struct pipe_resource *tex)
 118 {
 119    struct pipe_resource *old_tex = *ptr;
 120
 121    if (pipe_reference_described(&(*ptr)->reference, &tex->reference,
 122                                 (debug_reference_descriptor)debug_describe_resource))
 123       old_tex->screen->resource_destroy(old_tex->screen, old_tex);
 124    *ptr = tex;
 125 }
 126
 127 static INLINE void
 128 pipe_sampler_view_reference(struct pipe_sampler_view **ptr, struct pipe_sampler_view *view)
 129 {
 130    struct pipe_sampler_view *old_view = *ptr;
 131
 132    if (pipe_reference_described(&(*ptr)->reference, &view->reference,
 133                                 (debug_reference_descriptor)debug_describe_sampler_view))
 134       old_view->context->sampler_view_destroy(old_view->context, old_view);
 135    *ptr = view;
 136 }
 137
 138 static INLINE void
 139 pipe_surface_reset(struct pipe_context *ctx, struct pipe_surface* ps,
 140                    struct pipe_resource *pt, unsigned level, unsigned layer,
 141                    unsigned flags)
 142 {
 143    pipe_resource_reference(&ps->texture, pt);
 144    ps->format = pt->format;
 145    ps->width = u_minify(pt->width0, level);
 146    ps->height = u_minify(pt->height0, level);
 147    ps->usage = flags;
 148    ps->u.tex.level = level;
 149    ps->u.tex.first_layer = ps->u.tex.last_layer = layer;
 150    ps->context = ctx;
 151 }
 152
 153 static INLINE void
 154 pipe_surface_init(struct pipe_context *ctx, struct pipe_surface* ps,
 155                   struct pipe_resource *pt, unsigned level, unsigned layer,
 156                   unsigned flags)
 157 {
 158    ps->texture = 0;
 159    pipe_reference_init(&ps->reference, 1);
 160    pipe_surface_reset(ctx, ps, pt, level, layer, flags);
 161 }
 162
 163 /* Return true if the surfaces are equal. */
 164 static INLINE boolean
 165 pipe_surface_equal(struct pipe_surface *s1, struct pipe_surface *s2)
 166 {
 167    return s1->texture == s2->texture &&
 168           s1->format == s2->format &&
 169           (s1->texture->target != PIPE_BUFFER ||
 170            (s1->u.buf.first_element == s2->u.buf.first_element &&
 171             s1->u.buf.last_element == s2->u.buf.last_element)) &&
 172           (s1->texture->target == PIPE_BUFFER ||
 173            (s1->u.tex.level == s2->u.tex.level &&
 174             s1->u.tex.first_layer == s2->u.tex.first_layer &&
 175             s1->u.tex.last_layer == s2->u.tex.last_layer));
 176 }
 177
 178 /*
 179  * Convenience wrappers for screen buffer functions.
 180  */
 181
 182 static INLINE struct pipe_resource *
 183 pipe_buffer_create( struct pipe_screen *screen,
 184                     unsigned bind,
 185                     unsigned usage,
 186                     unsigned size )
 187 {
 188    struct pipe_resource buffer;
 189    memset(&buffer, 0, sizeof buffer);
 190    buffer.target = PIPE_BUFFER;
 191    buffer.format = PIPE_FORMAT_R8_UNORM; /* want TYPELESS or similar */
 192    buffer.bind = bind;
 193    buffer.usage = usage;
 194    buffer.flags = 0;
 195    buffer.width0 = size;
 196    buffer.height0 = 1;
 197    buffer.depth0 = 1;
 198    buffer.array_size = 1;
 199    return screen->resource_create(screen, &buffer);
 200 }
 201
 202
 203 static INLINE struct pipe_resource *
 204 pipe_user_buffer_create( struct pipe_screen *screen, void *ptr, unsigned size,
 205                          unsigned usage )
 206 {
 207    return screen->user_buffer_create(screen, ptr, size, usage);
 208 }
 209
 210 static INLINE void *
 211 pipe_buffer_map_range(struct pipe_context *pipe,
 212                       struct pipe_resource *buffer,
 213                       unsigned offset,
 214                       unsigned length,
 215                       unsigned usage,
 216                       struct pipe_transfer **transfer)
 217 {
 218    struct pipe_box box;
 219    void *map;
 220
 221    assert(offset < buffer->width0);
 222    assert(offset + length <= buffer->width0);
 223    assert(length);
 224
 225    u_box_1d(offset, length, &box);
 226
 227    *transfer = pipe->get_transfer( pipe,
 228                                    buffer,
 229                                    0,
 230                                    usage,
 231                                    &box);
 232
 233    if (*transfer == NULL)
 234       return NULL;
 235
 236    map = pipe->transfer_map( pipe, *transfer );
 237    if (map == NULL) {
 238       pipe->transfer_destroy( pipe, *transfer );
 239       *transfer = NULL;
 240       return NULL;
 241    }
 242
 243    /* Match old screen->buffer_map_range() behaviour, return pointer
 244     * to where the beginning of the buffer would be:
 245     */
 246    return (void *)((char *)map - offset);
 247 }
 248
 249
 250 static INLINE void *
 251 pipe_buffer_map(struct pipe_context *pipe,
 252                 struct pipe_resource *buffer,
 253                 unsigned usage,
 254                 struct pipe_transfer **transfer)
 255 {
 256    return pipe_buffer_map_range(pipe, buffer, 0, buffer->width0, usage, transfer);
 257 }
 258
 259
 260 static INLINE void
 261 pipe_buffer_unmap(struct pipe_context *pipe,
 262                   struct pipe_transfer *transfer)
 263 {
 264    if (transfer) {
 265       pipe->transfer_unmap(pipe, transfer);
 266       pipe->transfer_destroy(pipe, transfer);
 267    }
 268 }
 269
 270 static INLINE void
 271 pipe_buffer_flush_mapped_range(struct pipe_context *pipe,
 272                                struct pipe_transfer *transfer,
 273                                unsigned offset,
 274                                unsigned length)
 275 {
 276    struct pipe_box box;
 277    int transfer_offset;
 278
 279    assert(length);
 280    assert(transfer->box.x <= offset);
 281    assert(offset + length <= transfer->box.x + transfer->box.width);
 282
 283    /* Match old screen->buffer_flush_mapped_range() behaviour, where
 284     * offset parameter is relative to the start of the buffer, not the
 285     * mapped range.
 286     */
 287    transfer_offset = offset - transfer->box.x;
 288
 289    u_box_1d(transfer_offset, length, &box);
 290
 291    pipe->transfer_flush_region(pipe, transfer, &box);
 292 }
 293
 294 static INLINE void
 295 pipe_buffer_write(struct pipe_context *pipe,
 296                   struct pipe_resource *buf,
 297                   unsigned offset,
 298                   unsigned size,
 299                   const void *data)
 300 {
 301    struct pipe_box box;
 302    unsigned usage = PIPE_TRANSFER_WRITE;
 303
 304    if (offset == 0 && size == buf->width0) {
 305       usage |= PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE;
 306    } else {
 307       usage |= PIPE_TRANSFER_DISCARD_RANGE;
 308    }
 309
 310    u_box_1d(offset, size, &box);
 311
 312    pipe->transfer_inline_write( pipe,
 313                                 buf,
 314                                 0,
 315                                 usage,
 316                                 &box,
 317                                 data,
 318                                 size,
 319                                 0);
 320 }
 321
 322 /**
 323  * Special case for writing non-overlapping ranges.
 324  *
 325  * We can avoid GPU/CPU synchronization when writing range that has never
 326  * been written before.
 327  */
 328 static INLINE void
 329 pipe_buffer_write_nooverlap(struct pipe_context *pipe,
 330                             struct pipe_resource *buf,
 331                             unsigned offset, unsigned size,
 332                             const void *data)
 333 {
 334    struct pipe_box box;
 335
 336    u_box_1d(offset, size, &box);
 337
 338    pipe->transfer_inline_write(pipe,
 339                                buf,
 340                                0,
 341                                (PIPE_TRANSFER_WRITE |
 342                                 PIPE_TRANSFER_NOOVERWRITE),
 343                                &box,
 344                                data,
 345                                0, 0);
 346 }
 347
 348 static INLINE void
 349 pipe_buffer_read(struct pipe_context *pipe,
 350                  struct pipe_resource *buf,
 351                  unsigned offset,
 352                  unsigned size,
 353                  void *data)
 354 {
 355    struct pipe_transfer *src_transfer;
 356    ubyte *map;
 357
 358    map = (ubyte *) pipe_buffer_map_range(pipe,
 359                                          buf,
 360                                          offset, size,
 361                                          PIPE_TRANSFER_READ,
 362                                          &src_transfer);
 363
 364    if (map)
 365       memcpy(data, map + offset, size);
 366
 367    pipe_buffer_unmap(pipe, src_transfer);
 368 }
 369
 370 static INLINE struct pipe_transfer *
 371 pipe_get_transfer( struct pipe_context *context,
 372                    struct pipe_resource *resource,
 373                    unsigned level, unsigned layer,
 374                    enum pipe_transfer_usage usage,
 375                    unsigned x, unsigned y,
 376                    unsigned w, unsigned h)
 377 {
 378    struct pipe_box box;
 379    u_box_2d_zslice( x, y, layer, w, h, &box );
 380    return context->get_transfer( context,
 381                                  resource,
 382                                  level,
 383                                  usage,
 384                                  &box );
 385 }
 386
 387 static INLINE void *
 388 pipe_transfer_map( struct pipe_context *context,
 389                    struct pipe_transfer *transfer )
 390 {
 391    return context->transfer_map( context, transfer );
 392 }
 393
 394 static INLINE void
 395 pipe_transfer_unmap( struct pipe_context *context,
 396                      struct pipe_transfer *transfer )
 397 {
 398    context->transfer_unmap( context, transfer );
 399 }
 400
 401
 402 static INLINE void
 403 pipe_transfer_destroy( struct pipe_context *context,
 404                        struct pipe_transfer *transfer )
 405 {
 406    context->transfer_destroy(context, transfer);
 407 }
 408
 409
 410 static INLINE boolean util_get_offset(
 411    const struct pipe_rasterizer_state *templ,
 412    unsigned fill_mode)
 413 {
 414    switch(fill_mode) {
 415    case PIPE_POLYGON_MODE_POINT:
 416       return templ->offset_point;
 417    case PIPE_POLYGON_MODE_LINE:
 418       return templ->offset_line;
 419    case PIPE_POLYGON_MODE_FILL:
 420       return templ->offset_tri;
 421    default:
 422       assert(0);
 423       return FALSE;
 424    }
 425 }
 426
 427 /**
 428  * This function is used to copy an array of pipe_vertex_buffer structures,
 429  * while properly referencing the pipe_vertex_buffer::buffer member.
 430  *
 431  * \sa util_copy_framebuffer_state
 432  */
 433 static INLINE void util_copy_vertex_buffers(struct pipe_vertex_buffer *dst,
 434                                             unsigned *dst_count,
 435                                             const struct pipe_vertex_buffer *src,
 436                                             unsigned src_count)
 437 {
 438    unsigned i;
 439
 440    /* Reference the buffers of 'src' in 'dst'. */
 441    for (i = 0; i < src_count; i++) {
 442       pipe_resource_reference(&dst[i].buffer, src[i].buffer);
 443    }
 444    /* Unreference the rest of the buffers in 'dst'. */
 445    for (; i < *dst_count; i++) {
 446       pipe_resource_reference(&dst[i].buffer, NULL);
 447    }
 448
 449    /* Update the size of 'dst' and copy over the other members
 450     * of pipe_vertex_buffer. */
 451    *dst_count = src_count;
 452    memcpy(dst, src, src_count * sizeof(struct pipe_vertex_buffer));
 453 }
 454
 455 #ifdef __cplusplus
 456 }
 457 #endif
 458
 459 #endif /* U_INLINES_H */