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    int shm;
  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 = 0;
 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 = 0;
 172       (void) XSetErrorHandler(old_handler);
 173       return;
 174    }
 175
 176    b->shm = 1;
 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    if (oldBuf->data) {
 207 #ifdef USE_XSHM
 208       if (oldBuf->shminfo.shmid >= 0) {
 209          shmdt(oldBuf->shminfo.shmaddr);
 210          shmctl(oldBuf->shminfo.shmid, IPC_RMID, 0);
 211
 212          oldBuf->shminfo.shmid = -1;
 213          oldBuf->shminfo.shmaddr = (char *) -1;
 214       }
 215       else
 216 #endif
 217       {
 218          if (!oldBuf->userBuffer) {
 219             align_free(oldBuf->data);
 220          }
 221       }
 222
 223       oldBuf->data = NULL;
 224    }
 225
 226    free(oldBuf);
 227 }
 228
 229
 230 /**
 231  * Display/copy the image in the surface into the X window specified
 232  * by the XMesaBuffer.
 233  */
 234 static void
 235 xlib_softpipe_display_surface(struct xmesa_buffer *b,
 236                               struct pipe_surface *surf)
 237 {
 238    XImage *ximage;
 239    struct softpipe_texture *spt = softpipe_texture(surf->texture);
 240    struct xm_buffer *xm_buf = xm_buffer(spt->buffer);
 241    static boolean no_swap = 0;
 242    static boolean firsttime = 1;
 243
 244    if (firsttime) {
 245       no_swap = getenv("SP_NO_RAST") != NULL;
 246       firsttime = 0;
 247    }
 248
 249    if (no_swap)
 250       return;
 251
 252 #ifdef USE_XSHM
 253    if (xm_buf->shm)
 254    {
 255       if (xm_buf->tempImage == NULL)
 256       {
 257          assert(surf->texture->block.width == 1);
 258          assert(surf->texture->block.height == 1);
 259          alloc_shm_ximage(xm_buf, b, spt->stride[surf->level] /
 260                           surf->texture->block.size, surf->height);
 261       }
 262
 263       ximage = xm_buf->tempImage;
 264       ximage->data = xm_buf->data;
 265
 266       /* _debug_printf("XSHM\n"); */
 267       XShmPutImage(b->xm_visual->display, b->drawable, b->gc,
 268                    ximage, 0, 0, 0, 0, surf->width, surf->height, False);
 269    }
 270    else
 271 #endif
 272    {
 273       /* display image in Window */
 274       ximage = b->tempImage;
 275       ximage->data = xm_buf->data;
 276
 277       /* check that the XImage has been previously initialized */
 278       assert(ximage->format);
 279       assert(ximage->bitmap_unit);
 280
 281       /* update XImage's fields */
 282       ximage->width = surf->width;
 283       ximage->height = surf->height;
 284       ximage->bytes_per_line = spt->stride[surf->level];
 285
 286       /* _debug_printf("XPUT\n"); */
 287       XPutImage(b->xm_visual->display, b->drawable, b->gc,
 288                 ximage, 0, 0, 0, 0, surf->width, surf->height);
 289    }
 290 }
 291
 292
 293 static void
 294 xm_flush_frontbuffer(struct pipe_winsys *pws,
 295                      struct pipe_surface *surf,
 296                      void *context_private)
 297 {
 298    /*
 299     * The front color buffer is actually just another XImage buffer.
 300     * This function copies that XImage to the actual X Window.
 301     */
 302    XMesaContext xmctx = (XMesaContext) context_private;
 303    xlib_softpipe_display_surface(xmctx->xm_buffer, surf);
 304 }
 305
 306
 307
 308 static const char *
 309 xm_get_name(struct pipe_winsys *pws)
 310 {
 311    return "Xlib";
 312 }
 313
 314
 315 static struct pipe_buffer *
 316 xm_buffer_create(struct pipe_winsys *pws,
 317                  unsigned alignment,
 318                  unsigned usage,
 319                  unsigned size)
 320 {
 321    struct xm_buffer *buffer = CALLOC_STRUCT(xm_buffer);
 322
 323    pipe_reference_init(&buffer->base.reference, 1);
 324    buffer->base.alignment = alignment;
 325    buffer->base.usage = usage;
 326    buffer->base.size = size;
 327
 328    if (buffer->data == NULL) {
 329       /* align to 16-byte multiple for Cell */
 330       buffer->data = align_malloc(size, max(alignment, 16));
 331    }
 332
 333    return &buffer->base;
 334 }
 335
 336
 337 /**
 338  * Create buffer which wraps user-space data.
 339  */
 340 static struct pipe_buffer *
 341 xm_user_buffer_create(struct pipe_winsys *pws, void *ptr, unsigned bytes)
 342 {
 343    struct xm_buffer *buffer = CALLOC_STRUCT(xm_buffer);
 344    pipe_reference_init(&buffer->base.reference, 1);
 345    buffer->base.size = bytes;
 346    buffer->userBuffer = TRUE;
 347    buffer->data = ptr;
 348
 349    return &buffer->base;
 350 }
 351
 352
 353 static struct pipe_buffer *
 354 xm_surface_buffer_create(struct pipe_winsys *winsys,
 355                          unsigned width, unsigned height,
 356                          enum pipe_format format,
 357                          unsigned usage,
 358                          unsigned *stride)
 359 {
 360    const unsigned alignment = 64;
 361    struct pipe_format_block block;
 362    unsigned nblocksx, nblocksy, size;
 363
 364    pf_get_block(format, &block);
 365    nblocksx = pf_get_nblocksx(&block, width);
 366    nblocksy = pf_get_nblocksy(&block, height);
 367    *stride = align(nblocksx * block.size, alignment);
 368    size = *stride * nblocksy;
 369
 370 #ifdef USE_XSHM
 371    if (!debug_get_bool_option("XLIB_NO_SHM", FALSE))
 372    {
 373       struct xm_buffer *buffer = CALLOC_STRUCT(xm_buffer);
 374
 375       pipe_reference_init(&buffer->base.reference, 1);
 376       buffer->base.alignment = alignment;
 377       buffer->base.usage = usage;
 378       buffer->base.size = size;
 379       buffer->userBuffer = FALSE;
 380       buffer->shminfo.shmid = -1;
 381       buffer->shminfo.shmaddr = (char *) -1;
 382       buffer->shm = TRUE;
 383
 384       buffer->data = alloc_shm(buffer, size);
 385       if (!buffer->data)
 386          goto out;
 387
 388       return &buffer->base;
 389
 390    out:
 391       if (buffer)
 392          FREE(buffer);
 393    }
 394 #endif
 395
 396
 397    return winsys->buffer_create(winsys, alignment,
 398                                 usage,
 399                                 size);
 400 }
 401
 402
 403 /*
 404  * Fence functions - basically nothing to do, as we don't create any actual
 405  * fence objects.
 406  */
 407
 408 static void
 409 xm_fence_reference(struct pipe_winsys *sws, struct pipe_fence_handle **ptr,
 410                    struct pipe_fence_handle *fence)
 411 {
 412 }
 413
 414
 415 static int
 416 xm_fence_signalled(struct pipe_winsys *sws, struct pipe_fence_handle *fence,
 417                    unsigned flag)
 418 {
 419    return 0;
 420 }
 421
 422
 423 static int
 424 xm_fence_finish(struct pipe_winsys *sws, struct pipe_fence_handle *fence,
 425                 unsigned flag)
 426 {
 427    return 0;
 428 }
 429
 430
 431
 432 static struct pipe_winsys *
 433 xlib_create_softpipe_winsys( void )
 434 {
 435    static struct xmesa_pipe_winsys *ws = NULL;
 436
 437    if (!ws) {
 438       ws = CALLOC_STRUCT(xmesa_pipe_winsys);
 439
 440       /* Fill in this struct with callbacks that pipe will need to
 441        * communicate with the window system, buffer manager, etc.
 442        */
 443       ws->base.buffer_create = xm_buffer_create;
 444       ws->base.user_buffer_create = xm_user_buffer_create;
 445       ws->base.buffer_map = xm_buffer_map;
 446       ws->base.buffer_unmap = xm_buffer_unmap;
 447       ws->base.buffer_destroy = xm_buffer_destroy;
 448
 449       ws->base.surface_buffer_create = xm_surface_buffer_create;
 450
 451       ws->base.fence_reference = xm_fence_reference;
 452       ws->base.fence_signalled = xm_fence_signalled;
 453       ws->base.fence_finish = xm_fence_finish;
 454
 455       ws->base.flush_frontbuffer = xm_flush_frontbuffer;
 456       ws->base.get_name = xm_get_name;
 457    }
 458
 459    return &ws->base;
 460 }
 461
 462
 463 static struct pipe_screen *
 464 xlib_create_softpipe_screen( void )
 465 {
 466    struct pipe_winsys *winsys;
 467    struct pipe_screen *screen;
 468
 469    winsys = xlib_create_softpipe_winsys();
 470    if (winsys == NULL)
 471       return NULL;
 472
 473    screen = softpipe_create_screen(winsys);
 474    if (screen == NULL)
 475       goto fail;
 476
 477    return screen;
 478
 479 fail:
 480    if (winsys)
 481       winsys->destroy( winsys );
 482
 483    return NULL;
 484 }
 485
 486
 487 static struct pipe_context *
 488 xlib_create_softpipe_context( struct pipe_screen *screen,
 489                               void *context_private )
 490 {
 491    struct pipe_context *pipe;
 492
 493    pipe = softpipe_create(screen);
 494    if (pipe == NULL)
 495       goto fail;
 496
 497    pipe->priv = context_private;
 498    return pipe;
 499
 500 fail:
 501    /* Free stuff here */
 502    return NULL;
 503 }
 504
 505 struct xm_driver xlib_softpipe_driver =
 506 {
 507    .create_pipe_screen = xlib_create_softpipe_screen,
 508    .create_pipe_context = xlib_create_softpipe_context,
 509    .display_surface = xlib_softpipe_display_surface
 510 };
 511
 512
 513