src/gallium/winsys/xlib/xlib_softpipe.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 Tungsten Graphics, Inc., Bismarck, ND., USA
   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 SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  17  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  18  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  19  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  20  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * The above copyright notice and this permission notice (including the
  23  * next paragraph) shall be included in all copies or substantial portions
  24  * of the Software.
  25  *
  26  *
  27  **************************************************************************/
  28
  29 /*
  30  * Authors:
  31  *   Keith Whitwell
  32  *   Brian Paul
  33  */
  34
  35
  36 #include "xm_api.h"
  37
  38 #undef ASSERT
  39 #undef Elements
  40
  41 #include "pipe/internal/p_winsys_screen.h"
  42 #include "pipe/p_format.h"
  43 #include "pipe/p_context.h"
  44 #include "pipe/p_inlines.h"
  45 #include "util/u_math.h"
  46 #include "util/u_memory.h"
  47 #include "softpipe/sp_winsys.h"
  48 #include "softpipe/sp_texture.h"
  49
  50 #include "xlib.h"
  51
  52 /**
  53  * Subclass of pipe_buffer for Xlib winsys.
  54  * Low-level OS/window system memory buffer
  55  */
  56 struct xm_buffer
  57 {
  58    struct pipe_buffer base;
  59    boolean userBuffer;  /** Is this a user-space buffer? */
  60    void *data;
  61    void *mapped;
  62
  63    XImage *tempImage;
  64 #ifdef USE_XSHM
  65    boolean shm;         /** Is this a shared memory buffer? */
  66    XShmSegmentInfo shminfo;
  67 #endif
  68 };
  69
  70
  71 /**
  72  * Subclass of pipe_winsys for Xlib winsys
  73  */
  74 struct xmesa_pipe_winsys
  75 {
  76    struct pipe_winsys base;
  77 /*   struct xmesa_visual *xm_visual; */
  78 };
  79
  80
  81
  82 /** Cast wrapper */
  83 static INLINE struct xm_buffer *
  84 xm_buffer( struct pipe_buffer *buf )
  85 {
  86    return (struct xm_buffer *)buf;
  87 }
  88
  89
  90 /**
  91  * X Shared Memory Image extension code
  92  */
  93
  94 #ifdef USE_XSHM
  95
  96 static volatile int mesaXErrorFlag = 0;
  97
  98 /**
  99  * Catches potential Xlib errors.
 100  */
 101 static int
 102 mesaHandleXError(Display *dpy, XErrorEvent *event)
 103 {
 104    (void) dpy;
 105    (void) event;
 106    mesaXErrorFlag = 1;
 107    return 0;
 108 }
 109
 110
 111 static char *alloc_shm(struct xm_buffer *buf, unsigned size)
 112 {
 113    XShmSegmentInfo *const shminfo = & buf->shminfo;
 114
 115    shminfo->shmid = shmget(IPC_PRIVATE, size, IPC_CREAT|0777);
 116    if (shminfo->shmid < 0) {
 117       return NULL;
 118    }
 119
 120    shminfo->shmaddr = (char *) shmat(shminfo->shmid, 0, 0);
 121    if (shminfo->shmaddr == (char *) -1) {
 122       shmctl(shminfo->shmid, IPC_RMID, 0);
 123       return NULL;
 124    }
 125
 126    shminfo->readOnly = False;
 127    return shminfo->shmaddr;
 128 }
 129
 130
 131 /**
 132  * Allocate a shared memory XImage back buffer for the given XMesaBuffer.
 133  */
 134 static void
 135 alloc_shm_ximage(struct xm_buffer *b, struct xmesa_buffer *xmb,
 136                  unsigned width, unsigned height)
 137 {
 138    /*
 139     * We have to do a _lot_ of error checking here to be sure we can
 140     * really use the XSHM extension.  It seems different servers trigger
 141     * errors at different points if the extension won't work.  Therefore
 142     * we have to be very careful...
 143     */
 144    int (*old_handler)(Display *, XErrorEvent *);
 145
 146    b->tempImage = XShmCreateImage(xmb->xm_visual->display,
 147                                   xmb->xm_visual->visinfo->visual,
 148                                   xmb->xm_visual->visinfo->depth,
 149                                   ZPixmap,
 150                                   NULL,
 151                                   &b->shminfo,
 152                                   width, height);
 153    if (b->tempImage == NULL) {
 154       b->shm = FALSE;
 155       return;
 156    }
 157
 158
 159    mesaXErrorFlag = 0;
 160    old_handler = XSetErrorHandler(mesaHandleXError);
 161    /* This may trigger the X protocol error we're ready to catch: */
 162    XShmAttach(xmb->xm_visual->display, &b->shminfo);
 163    XSync(xmb->xm_visual->display, False);
 164
 165    if (mesaXErrorFlag) {
 166       /* we are on a remote display, this error is normal, don't print it */
 167       XFlush(xmb->xm_visual->display);
 168       mesaXErrorFlag = 0;
 169       XDestroyImage(b->tempImage);
 170       b->tempImage = NULL;
 171       b->shm = FALSE;
 172       (void) XSetErrorHandler(old_handler);
 173       return;
 174    }
 175
 176    b->shm = TRUE;
 177 }
 178
 179 #endif /* USE_XSHM */
 180
 181
 182
 183 /* Most callbacks map direcly onto dri_bufmgr operations:
 184  */
 185 static void *
 186 xm_buffer_map(struct pipe_winsys *pws, struct pipe_buffer *buf,
 187               unsigned flags)
 188 {
 189    struct xm_buffer *xm_buf = xm_buffer(buf);
 190    xm_buf->mapped = xm_buf->data;
 191    return xm_buf->mapped;
 192 }
 193
 194 static void
 195 xm_buffer_unmap(struct pipe_winsys *pws, struct pipe_buffer *buf)
 196 {
 197    struct xm_buffer *xm_buf = xm_buffer(buf);
 198    xm_buf->mapped = NULL;
 199 }
 200
 201 static void
 202 xm_buffer_destroy(struct pipe_buffer *buf)
 203 {
 204    struct xm_buffer *oldBuf = xm_buffer(buf);
 205
 206    /*
 207     * Note oldBuf->data may point to one of three things:
 208     * 1. XShm shared memory image data
 209     * 2. User-provided (wrapped) memory, see xm_user_buffer_create()
 210     * 3. Regular, malloc'd memory
 211     * We need to be careful with freeing that data now.
 212     */
 213
 214    if (oldBuf->data) {
 215 #ifdef USE_XSHM
 216       if (oldBuf->shminfo.shmid >= 0) {
 217          shmdt(oldBuf->shminfo.shmaddr);
 218          shmctl(oldBuf->shminfo.shmid, IPC_RMID, 0);
 219
 220          oldBuf->shminfo.shmid = -1;
 221          oldBuf->shminfo.shmaddr = (char *) -1;
 222       }
 223
 224       if (oldBuf->shm) {
 225          oldBuf->data = NULL;
 226       }
 227
 228       if (oldBuf->tempImage) {
 229          XDestroyImage(oldBuf->tempImage);
 230          oldBuf->tempImage = NULL;
 231       }
 232 #endif
 233
 234       if (oldBuf->data && !oldBuf->userBuffer) {
 235          /* this was regular malloc'd memory */
 236          align_free(oldBuf->data);
 237       }
 238
 239       oldBuf->data = NULL;
 240    }
 241
 242    free(oldBuf);
 243 }
 244
 245
 246 /**
 247  * Display/copy the image in the surface into the X window specified
 248  * by the XMesaBuffer.
 249  */
 250 static void
 251 xlib_softpipe_display_surface(struct xmesa_buffer *b,
 252                               struct pipe_surface *surf)
 253 {
 254    XImage *ximage;
 255    struct softpipe_texture *spt = softpipe_texture(surf->texture);
 256    struct xm_buffer *xm_buf = xm_buffer(spt->buffer);
 257    static boolean no_swap = 0;
 258    static boolean firsttime = 1;
 259
 260    if (firsttime) {
 261       no_swap = getenv("SP_NO_RAST") != NULL;
 262       firsttime = 0;
 263    }
 264
 265    if (no_swap)
 266       return;
 267
 268 #ifdef USE_XSHM
 269    if (xm_buf->shm)
 270    {
 271       if (xm_buf->tempImage == NULL)
 272       {
 273          assert(surf->texture->block.width == 1);
 274          assert(surf->texture->block.height == 1);
 275          alloc_shm_ximage(xm_buf, b, spt->stride[surf->level] /
 276                           surf->texture->block.size, surf->height);
 277       }
 278
 279       ximage = xm_buf->tempImage;
 280       ximage->data = xm_buf->data;
 281
 282       /* _debug_printf("XSHM\n"); */
 283       XShmPutImage(b->xm_visual->display, b->drawable, b->gc,
 284                    ximage, 0, 0, 0, 0, surf->width, surf->height, False);
 285    }
 286    else
 287 #endif
 288    {
 289       /* display image in Window */
 290       ximage = b->tempImage;
 291       ximage->data = xm_buf->data;
 292
 293       /* check that the XImage has been previously initialized */
 294       assert(ximage->format);
 295       assert(ximage->bitmap_unit);
 296
 297       /* update XImage's fields */
 298       ximage->width = surf->width;
 299       ximage->height = surf->height;
 300       ximage->bytes_per_line = spt->stride[surf->level];
 301
 302       /* _debug_printf("XPUT\n"); */
 303       XPutImage(b->xm_visual->display, b->drawable, b->gc,
 304                 ximage, 0, 0, 0, 0, surf->width, surf->height);
 305    }
 306 }
 307
 308
 309 static void
 310 xm_flush_frontbuffer(struct pipe_winsys *pws,
 311                      struct pipe_surface *surf,
 312                      void *context_private)
 313 {
 314    /*
 315     * The front color buffer is actually just another XImage buffer.
 316     * This function copies that XImage to the actual X Window.
 317     */
 318    XMesaContext xmctx = (XMesaContext) context_private;
 319    xlib_softpipe_display_surface(xmctx->xm_buffer, surf);
 320    xmesa_check_and_update_buffer_size(xmctx, xmctx->xm_buffer);
 321 }
 322
 323
 324
 325 static const char *
 326 xm_get_name(struct pipe_winsys *pws)
 327 {
 328    return "Xlib";
 329 }
 330
 331
 332 static struct pipe_buffer *
 333 xm_buffer_create(struct pipe_winsys *pws,
 334                  unsigned alignment,
 335                  unsigned usage,
 336                  unsigned size)
 337 {
 338    struct xm_buffer *buffer = CALLOC_STRUCT(xm_buffer);
 339
 340    pipe_reference_init(&buffer->base.reference, 1);
 341    buffer->base.alignment = alignment;
 342    buffer->base.usage = usage;
 343    buffer->base.size = size;
 344
 345    /* align to 16-byte multiple for Cell */
 346    buffer->data = align_malloc(size, max(alignment, 16));
 347
 348    return &buffer->base;
 349 }
 350
 351
 352 /**
 353  * Create buffer which wraps user-space data.
 354  */
 355 static struct pipe_buffer *
 356 xm_user_buffer_create(struct pipe_winsys *pws, void *ptr, unsigned bytes)
 357 {
 358    struct xm_buffer *buffer = CALLOC_STRUCT(xm_buffer);
 359    pipe_reference_init(&buffer->base.reference, 1);
 360    buffer->base.size = bytes;
 361    buffer->userBuffer = TRUE;
 362    buffer->data = ptr;
 363
 364    return &buffer->base;
 365 }
 366
 367
 368 static struct pipe_buffer *
 369 xm_surface_buffer_create(struct pipe_winsys *winsys,
 370                          unsigned width, unsigned height,
 371                          enum pipe_format format,
 372                          unsigned usage,
 373                          unsigned tex_usage,
 374                          unsigned *stride)
 375 {
 376    const unsigned alignment = 64;
 377    struct pipe_format_block block;
 378    unsigned nblocksx, nblocksy, size;
 379
 380    pf_get_block(format, &block);
 381    nblocksx = pf_get_nblocksx(&block, width);
 382    nblocksy = pf_get_nblocksy(&block, height);
 383    *stride = align(nblocksx * block.size, alignment);
 384    size = *stride * nblocksy;
 385
 386 #ifdef USE_XSHM
 387    if (!debug_get_bool_option("XLIB_NO_SHM", FALSE))
 388    {
 389       struct xm_buffer *buffer = CALLOC_STRUCT(xm_buffer);
 390
 391       pipe_reference_init(&buffer->base.reference, 1);
 392       buffer->base.alignment = alignment;
 393       buffer->base.usage = usage;
 394       buffer->base.size = size;
 395       buffer->userBuffer = FALSE;
 396       buffer->shminfo.shmid = -1;
 397       buffer->shminfo.shmaddr = (char *) -1;
 398       buffer->shm = TRUE;
 399
 400       buffer->data = alloc_shm(buffer, size);
 401       if (!buffer->data)
 402          goto out;
 403
 404       return &buffer->base;
 405
 406    out:
 407       if (buffer)
 408          FREE(buffer);
 409    }
 410 #endif
 411
 412
 413    return winsys->buffer_create(winsys, alignment,
 414                                 usage,
 415                                 size);
 416 }
 417
 418
 419 /*
 420  * Fence functions - basically nothing to do, as we don't create any actual
 421  * fence objects.
 422  */
 423
 424 static void
 425 xm_fence_reference(struct pipe_winsys *sws, struct pipe_fence_handle **ptr,
 426                    struct pipe_fence_handle *fence)
 427 {
 428 }
 429
 430
 431 static int
 432 xm_fence_signalled(struct pipe_winsys *sws, struct pipe_fence_handle *fence,
 433                    unsigned flag)
 434 {
 435    return 0;
 436 }
 437
 438
 439 static int
 440 xm_fence_finish(struct pipe_winsys *sws, struct pipe_fence_handle *fence,
 441                 unsigned flag)
 442 {
 443    return 0;
 444 }
 445
 446
 447
 448 static struct pipe_winsys *
 449 xlib_create_softpipe_winsys( void )
 450 {
 451    static struct xmesa_pipe_winsys *ws = NULL;
 452
 453    if (!ws) {
 454       ws = CALLOC_STRUCT(xmesa_pipe_winsys);
 455
 456       /* Fill in this struct with callbacks that pipe will need to
 457        * communicate with the window system, buffer manager, etc.
 458        */
 459       ws->base.buffer_create = xm_buffer_create;
 460       ws->base.user_buffer_create = xm_user_buffer_create;
 461       ws->base.buffer_map = xm_buffer_map;
 462       ws->base.buffer_unmap = xm_buffer_unmap;
 463       ws->base.buffer_destroy = xm_buffer_destroy;
 464
 465       ws->base.surface_buffer_create = xm_surface_buffer_create;
 466
 467       ws->base.fence_reference = xm_fence_reference;
 468       ws->base.fence_signalled = xm_fence_signalled;
 469       ws->base.fence_finish = xm_fence_finish;
 470
 471       ws->base.flush_frontbuffer = xm_flush_frontbuffer;
 472       ws->base.get_name = xm_get_name;
 473    }
 474
 475    return &ws->base;
 476 }
 477
 478
 479 static struct pipe_screen *
 480 xlib_create_softpipe_screen( void )
 481 {
 482    struct pipe_winsys *winsys;
 483    struct pipe_screen *screen;
 484
 485    winsys = xlib_create_softpipe_winsys();
 486    if (winsys == NULL)
 487       return NULL;
 488
 489    screen = softpipe_create_screen(winsys);
 490    if (screen == NULL)
 491       goto fail;
 492
 493    return screen;
 494
 495 fail:
 496    if (winsys)
 497       winsys->destroy( winsys );
 498
 499    return NULL;
 500 }
 501
 502
 503 static struct pipe_context *
 504 xlib_create_softpipe_context( struct pipe_screen *screen,
 505                               void *context_private )
 506 {
 507    struct pipe_context *pipe;
 508
 509    pipe = softpipe_create(screen);
 510    if (pipe == NULL)
 511       goto fail;
 512
 513    pipe->priv = context_private;
 514    return pipe;
 515
 516 fail:
 517    /* Free stuff here */
 518    return NULL;
 519 }
 520
 521 struct xm_driver xlib_softpipe_driver =
 522 {
 523    .create_pipe_screen = xlib_create_softpipe_screen,
 524    .create_pipe_context = xlib_create_softpipe_context,
 525    .display_surface = xlib_softpipe_display_surface
 526 };
 527
 528
 529