src/mesa/drivers/dri/intel/intel_regions.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2006 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 /* Provide additional functionality on top of bufmgr buffers:
  29  *   - 2d semantics and blit operations
  30  *   - refcounting of buffers for multiple images in a buffer.
  31  *   - refcounting of buffer mappings.
  32  *   - some logic for moving the buffers to the best memory pools for
  33  *     given operations.
  34  *
  35  * Most of this is to make it easier to implement the fixed-layout
  36  * mipmap tree required by intel hardware in the face of GL's
  37  * programming interface where each image can be specifed in random
  38  * order and it isn't clear what layout the tree should have until the
  39  * last moment.
  40  */
  41
  42 #include <sys/ioctl.h>
  43 #include <errno.h>
  44
  45 #include "main/hash.h"
  46 #include "intel_context.h"
  47 #include "intel_regions.h"
  48 #include "intel_blit.h"
  49 #include "intel_buffer_objects.h"
  50 #include "intel_bufmgr.h"
  51 #include "intel_batchbuffer.h"
  52
  53 #define FILE_DEBUG_FLAG DEBUG_REGION
  54
  55 /* This should be set to the maximum backtrace size desired.
  56  * Set it to 0 to disable backtrace debugging.
  57  */
  58 #define DEBUG_BACKTRACE_SIZE 0
  59
  60 #if DEBUG_BACKTRACE_SIZE == 0
  61 /* Use the standard debug output */
  62 #define _DBG(...) DBG(__VA_ARGS__)
  63 #else
  64 /* Use backtracing debug output */
  65 #define _DBG(...) {debug_backtrace(); DBG(__VA_ARGS__);}
  66
  67 /* Backtracing debug support */
  68 #include <execinfo.h>
  69
  70 static void
  71 debug_backtrace(void)
  72 {
  73    void *trace[DEBUG_BACKTRACE_SIZE];
  74    char **strings = NULL;
  75    int traceSize;
  76    register int i;
  77
  78    traceSize = backtrace(trace, DEBUG_BACKTRACE_SIZE);
  79    strings = backtrace_symbols(trace, traceSize);
  80    if (strings == NULL) {
  81       DBG("no backtrace:");
  82       return;
  83    }
  84
  85    /* Spit out all the strings with a colon separator.  Ignore
  86     * the first, since we don't really care about the call
  87     * to debug_backtrace() itself.  Skip until the final "/" in
  88     * the trace to avoid really long lines.
  89     */
  90    for (i = 1; i < traceSize; i++) {
  91       char *p = strings[i], *slash = strings[i];
  92       while (*p) {
  93          if (*p++ == '/') {
  94             slash = p;
  95          }
  96       }
  97
  98       DBG("%s:", slash);
  99    }
 100
 101    /* Free up the memory, and we're done */
 102    free(strings);
 103 }
 104
 105 #endif
 106
 107
 108
 109 /* XXX: Thread safety?
 110  */
 111 GLubyte *
 112 intel_region_map(struct intel_context *intel, struct intel_region *region)
 113 {
 114    intel_flush(&intel->ctx);
 115
 116    _DBG("%s %p\n", __FUNCTION__, region);
 117    if (!region->map_refcount++) {
 118       if (region->pbo)
 119          intel_region_cow(intel, region);
 120
 121       if (region->tiling != I915_TILING_NONE)
 122          drm_intel_gem_bo_map_gtt(region->buffer);
 123       else
 124          drm_intel_bo_map(region->buffer, GL_TRUE);
 125       region->map = region->buffer->virtual;
 126    }
 127
 128    return region->map;
 129 }
 130
 131 void
 132 intel_region_unmap(struct intel_context *intel, struct intel_region *region)
 133 {
 134    _DBG("%s %p\n", __FUNCTION__, region);
 135    if (!--region->map_refcount) {
 136       if (region->tiling != I915_TILING_NONE)
 137          drm_intel_gem_bo_unmap_gtt(region->buffer);
 138       else
 139          drm_intel_bo_unmap(region->buffer);
 140       region->map = NULL;
 141    }
 142 }
 143
 144 static struct intel_region *
 145 intel_region_alloc_internal(struct intel_screen *screen,
 146                             GLuint cpp,
 147                             GLuint width, GLuint height, GLuint pitch,
 148                             uint32_t tiling, drm_intel_bo *buffer)
 149 {
 150    struct intel_region *region;
 151
 152    region = calloc(sizeof(*region), 1);
 153    if (region == NULL)
 154       return region;
 155
 156    region->cpp = cpp;
 157    region->width = width;
 158    region->height = height;
 159    region->pitch = pitch;
 160    region->refcount = 1;
 161    region->buffer = buffer;
 162    region->tiling = tiling;
 163    region->screen = screen;
 164
 165    _DBG("%s <-- %p\n", __FUNCTION__, region);
 166    return region;
 167 }
 168
 169 struct intel_region *
 170 intel_region_alloc(struct intel_screen *screen,
 171                    uint32_t tiling,
 172                    GLuint cpp, GLuint width, GLuint height,
 173                    GLboolean expect_accelerated_upload)
 174 {
 175    drm_intel_bo *buffer;
 176    unsigned long flags = 0;
 177    unsigned long aligned_pitch;
 178    struct intel_region *region;
 179
 180    if (expect_accelerated_upload)
 181       flags |= BO_ALLOC_FOR_RENDER;
 182
 183    buffer = drm_intel_bo_alloc_tiled(screen->bufmgr, "region",
 184                                      width, height, cpp,
 185                                      &tiling, &aligned_pitch, flags);
 186    if (buffer == NULL)
 187       return NULL;
 188
 189    region = intel_region_alloc_internal(screen, cpp, width, height,
 190                                         aligned_pitch / cpp, tiling, buffer);
 191    if (region == NULL) {
 192       drm_intel_bo_unreference(buffer);
 193       return NULL;
 194    }
 195
 196    return region;
 197 }
 198
 199 GLboolean
 200 intel_region_flink(struct intel_region *region, uint32_t *name)
 201 {
 202    if (region->name == 0) {
 203       if (drm_intel_bo_flink(region->buffer, &region->name))
 204          return GL_FALSE;
 205
 206       _mesa_HashInsert(region->screen->named_regions,
 207                        region->name, region);
 208    }
 209
 210    *name = region->name;
 211
 212    return GL_TRUE;
 213 }
 214
 215 struct intel_region *
 216 intel_region_alloc_for_handle(struct intel_screen *screen,
 217                               GLuint cpp,
 218                               GLuint width, GLuint height, GLuint pitch,
 219                               GLuint handle, const char *name)
 220 {
 221    struct intel_region *region, *dummy;
 222    drm_intel_bo *buffer;
 223    int ret;
 224    uint32_t bit_6_swizzle, tiling;
 225
 226    region = _mesa_HashLookup(screen->named_regions, handle);
 227    if (region != NULL) {
 228       dummy = NULL;
 229       if (region->width != width || region->height != height ||
 230           region->cpp != cpp || region->pitch != pitch) {
 231          fprintf(stderr,
 232                  "Region for name %d already exists but is not compatible\n",
 233                  handle);
 234          return NULL;
 235       }
 236       intel_region_reference(&dummy, region);
 237       return dummy;
 238    }
 239
 240    buffer = intel_bo_gem_create_from_name(screen->bufmgr, name, handle);
 241    if (buffer == NULL)
 242       return NULL;
 243    ret = drm_intel_bo_get_tiling(buffer, &tiling, &bit_6_swizzle);
 244    if (ret != 0) {
 245       fprintf(stderr, "Couldn't get tiling of buffer %d (%s): %s\n",
 246               handle, name, strerror(-ret));
 247       drm_intel_bo_unreference(buffer);
 248       return NULL;
 249    }
 250
 251    region = intel_region_alloc_internal(screen, cpp,
 252                                         width, height, pitch, tiling, buffer);
 253    if (region == NULL) {
 254       drm_intel_bo_unreference(buffer);
 255       return NULL;
 256    }
 257
 258    region->name = handle;
 259    _mesa_HashInsert(screen->named_regions, handle, region);
 260
 261    return region;
 262 }
 263
 264 void
 265 intel_region_reference(struct intel_region **dst, struct intel_region *src)
 266 {
 267    if (src)
 268       _DBG("%s %p %d\n", __FUNCTION__, src, src->refcount);
 269
 270    assert(*dst == NULL);
 271    if (src) {
 272       src->refcount++;
 273       *dst = src;
 274    }
 275 }
 276
 277 void
 278 intel_region_release(struct intel_region **region_handle)
 279 {
 280    struct intel_region *region = *region_handle;
 281
 282    if (region == NULL) {
 283       _DBG("%s NULL\n", __FUNCTION__);
 284       return;
 285    }
 286
 287    _DBG("%s %p %d\n", __FUNCTION__, region, region->refcount - 1);
 288
 289    ASSERT(region->refcount > 0);
 290    region->refcount--;
 291
 292    if (region->refcount == 0) {
 293       assert(region->map_refcount == 0);
 294
 295       if (region->pbo)
 296          region->pbo->region = NULL;
 297       region->pbo = NULL;
 298       drm_intel_bo_unreference(region->buffer);
 299
 300       if (region->name > 0)
 301          _mesa_HashRemove(region->screen->named_regions, region->name);
 302
 303       free(region);
 304    }
 305    *region_handle = NULL;
 306 }
 307
 308 /*
 309  * XXX Move this into core Mesa?
 310  */
 311 void
 312 _mesa_copy_rect(GLubyte * dst,
 313                 GLuint cpp,
 314                 GLuint dst_pitch,
 315                 GLuint dst_x,
 316                 GLuint dst_y,
 317                 GLuint width,
 318                 GLuint height,
 319                 const GLubyte * src,
 320                 GLuint src_pitch, GLuint src_x, GLuint src_y)
 321 {
 322    GLuint i;
 323
 324    dst_pitch *= cpp;
 325    src_pitch *= cpp;
 326    dst += dst_x * cpp;
 327    src += src_x * cpp;
 328    dst += dst_y * dst_pitch;
 329    src += src_y * src_pitch;
 330    width *= cpp;
 331
 332    if (width == dst_pitch && width == src_pitch)
 333       memcpy(dst, src, height * width);
 334    else {
 335       for (i = 0; i < height; i++) {
 336          memcpy(dst, src, width);
 337          dst += dst_pitch;
 338          src += src_pitch;
 339       }
 340    }
 341 }
 342
 343
 344 /* Upload data to a rectangular sub-region.  Lots of choices how to do this:
 345  *
 346  * - memcpy by span to current destination
 347  * - upload data as new buffer and blit
 348  *
 349  * Currently always memcpy.
 350  */
 351 void
 352 intel_region_data(struct intel_context *intel,
 353                   struct intel_region *dst,
 354                   GLuint dst_offset,
 355                   GLuint dstx, GLuint dsty,
 356                   const void *src, GLuint src_pitch,
 357                   GLuint srcx, GLuint srcy, GLuint width, GLuint height)
 358 {
 359    _DBG("%s\n", __FUNCTION__);
 360
 361    if (intel == NULL)
 362       return;
 363
 364    if (dst->pbo) {
 365       if (dstx == 0 &&
 366           dsty == 0 && width == dst->pitch && height == dst->height)
 367          intel_region_release_pbo(intel, dst);
 368       else
 369          intel_region_cow(intel, dst);
 370    }
 371
 372    intel_prepare_render(intel);
 373
 374    _mesa_copy_rect(intel_region_map(intel, dst) + dst_offset,
 375                    dst->cpp,
 376                    dst->pitch,
 377                    dstx, dsty, width, height, src, src_pitch, srcx, srcy);
 378
 379    intel_region_unmap(intel, dst);
 380 }
 381
 382 /* Copy rectangular sub-regions. Need better logic about when to
 383  * push buffers into AGP - will currently do so whenever possible.
 384  */
 385 GLboolean
 386 intel_region_copy(struct intel_context *intel,
 387                   struct intel_region *dst,
 388                   GLuint dst_offset,
 389                   GLuint dstx, GLuint dsty,
 390                   struct intel_region *src,
 391                   GLuint src_offset,
 392                   GLuint srcx, GLuint srcy, GLuint width, GLuint height,
 393                   GLboolean flip,
 394                   GLenum logicop)
 395 {
 396    uint32_t src_pitch = src->pitch;
 397
 398    _DBG("%s\n", __FUNCTION__);
 399
 400    if (intel == NULL)
 401       return GL_FALSE;
 402
 403    if (dst->pbo) {
 404       if (dstx == 0 &&
 405           dsty == 0 && width == dst->pitch && height == dst->height)
 406          intel_region_release_pbo(intel, dst);
 407       else
 408          intel_region_cow(intel, dst);
 409    }
 410
 411    assert(src->cpp == dst->cpp);
 412
 413    if (flip)
 414       src_pitch = -src_pitch;
 415
 416    return intelEmitCopyBlit(intel,
 417                             dst->cpp,
 418                             src_pitch, src->buffer, src_offset, src->tiling,
 419                             dst->pitch, dst->buffer, dst_offset, dst->tiling,
 420                             srcx, srcy, dstx, dsty, width, height,
 421                             logicop);
 422 }
 423
 424 /* Attach to a pbo, discarding our data.  Effectively zero-copy upload
 425  * the pbo's data.
 426  */
 427 void
 428 intel_region_attach_pbo(struct intel_context *intel,
 429                         struct intel_region *region,
 430                         struct intel_buffer_object *pbo)
 431 {
 432    drm_intel_bo *buffer;
 433
 434    if (region->pbo == pbo)
 435       return;
 436
 437    _DBG("%s %p %p\n", __FUNCTION__, region, pbo);
 438
 439    /* If there is already a pbo attached, break the cow tie now.
 440     * Don't call intel_region_release_pbo() as that would
 441     * unnecessarily allocate a new buffer we would have to immediately
 442     * discard.
 443     */
 444    if (region->pbo) {
 445       region->pbo->region = NULL;
 446       region->pbo = NULL;
 447    }
 448
 449    if (region->buffer) {
 450       drm_intel_bo_unreference(region->buffer);
 451       region->buffer = NULL;
 452    }
 453
 454    /* make sure pbo has a buffer of its own */
 455    buffer = intel_bufferobj_buffer(intel, pbo, INTEL_WRITE_FULL);
 456
 457    region->pbo = pbo;
 458    region->pbo->region = region;
 459    drm_intel_bo_reference(buffer);
 460    region->buffer = buffer;
 461    region->tiling = I915_TILING_NONE;
 462 }
 463
 464
 465 /* Break the COW tie to the pbo and allocate a new buffer.
 466  * The pbo gets to keep the data.
 467  */
 468 void
 469 intel_region_release_pbo(struct intel_context *intel,
 470                          struct intel_region *region)
 471 {
 472    _DBG("%s %p\n", __FUNCTION__, region);
 473    assert(region->buffer == region->pbo->buffer);
 474    region->pbo->region = NULL;
 475    region->pbo = NULL;
 476    drm_intel_bo_unreference(region->buffer);
 477    region->buffer = NULL;
 478
 479    region->buffer = drm_intel_bo_alloc(intel->bufmgr, "region",
 480                                        region->pitch * region->cpp *
 481                                        region->height,
 482                                        64);
 483 }
 484
 485 /* Break the COW tie to the pbo.  Both the pbo and the region end up
 486  * with a copy of the data.
 487  */
 488 void
 489 intel_region_cow(struct intel_context *intel, struct intel_region *region)
 490 {
 491    struct intel_buffer_object *pbo = region->pbo;
 492    GLboolean ok;
 493
 494    intel_region_release_pbo(intel, region);
 495
 496    assert(region->cpp * region->pitch * region->height == pbo->Base.Size);
 497
 498    _DBG("%s %p (%d bytes)\n", __FUNCTION__, region, (int)pbo->Base.Size);
 499
 500    /* Now blit from the texture buffer to the new buffer:
 501     */
 502
 503    intel_prepare_render(intel);
 504    ok = intelEmitCopyBlit(intel,
 505                           region->cpp,
 506                           region->pitch, pbo->buffer, 0, region->tiling,
 507                           region->pitch, region->buffer, 0, region->tiling,
 508                           0, 0, 0, 0,
 509                           region->pitch, region->height,
 510                           GL_COPY);
 511    assert(ok);
 512 }
 513
 514 drm_intel_bo *
 515 intel_region_buffer(struct intel_context *intel,
 516                     struct intel_region *region, GLuint flag)
 517 {
 518    if (region->pbo) {
 519       if (flag == INTEL_WRITE_PART)
 520          intel_region_cow(intel, region);
 521       else if (flag == INTEL_WRITE_FULL)
 522          intel_region_release_pbo(intel, region);
 523    }
 524
 525    return region->buffer;
 526 }