src/gallium/winsys/sw/xlib/xlib_sw_winsys.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 #include "pipe/p_format.h"
  36 #include "pipe/p_context.h"
  37 #include "util/u_inlines.h"
  38 #include "util/u_format.h"
  39 #include "util/u_math.h"
  40 #include "util/u_memory.h"
  41
  42 #include "state_tracker/xlib_sw_winsys.h"
  43
  44 #include <X11/Xlib.h>
  45 #include <X11/Xlibint.h>
  46 #include <X11/Xutil.h>
  47 #include <sys/ipc.h>
  48 #include <sys/shm.h>
  49 #include <X11/extensions/XShm.h>
  50
  51 DEBUG_GET_ONCE_BOOL_OPTION(xlib_no_shm, "XLIB_NO_SHM", FALSE)
  52
  53 /**
  54  * Display target for Xlib winsys.
  55  * Low-level OS/window system memory buffer
  56  */
  57 struct xm_displaytarget
  58 {
  59    enum pipe_format format;
  60    unsigned width;
  61    unsigned height;
  62    unsigned stride;
  63
  64    void *data;
  65    void *mapped;
  66
  67    Display *display;
  68    Visual *visual;
  69    XImage *tempImage;
  70    GC gc;
  71
  72    /* This is the last drawable that this display target was presented
  73     * against.  May need to recreate gc, tempImage when this changes??
  74     */
  75    Drawable drawable;
  76
  77    XShmSegmentInfo shminfo;
  78    int shm;
  79 };
  80
  81
  82 /**
  83  * Subclass of sw_winsys for Xlib winsys
  84  */
  85 struct xlib_sw_winsys
  86 {
  87    struct sw_winsys base;
  88    Display *display;
  89 };
  90
  91
  92
  93 /** Cast wrapper */
  94 static INLINE struct xm_displaytarget *
  95 xm_displaytarget( struct sw_displaytarget *dt )
  96 {
  97    return (struct xm_displaytarget *)dt;
  98 }
  99
 100
 101 /**
 102  * X Shared Memory Image extension code
 103  */
 104
 105 static volatile int mesaXErrorFlag = 0;
 106
 107 /**
 108  * Catches potential Xlib errors.
 109  */
 110 static int
 111 mesaHandleXError(Display *dpy, XErrorEvent *event)
 112 {
 113    (void) dpy;
 114    (void) event;
 115    mesaXErrorFlag = 1;
 116    return 0;
 117 }
 118
 119
 120 static char *
 121 alloc_shm(struct xm_displaytarget *buf, unsigned size)
 122 {
 123    XShmSegmentInfo *const shminfo = & buf->shminfo;
 124
 125    shminfo->shmid = -1;
 126    shminfo->shmaddr = (char *) -1;
 127
 128    shminfo->shmid = shmget(IPC_PRIVATE, size, IPC_CREAT|0777);
 129    if (shminfo->shmid < 0) {
 130       return NULL;
 131    }
 132
 133    shminfo->shmaddr = (char *) shmat(shminfo->shmid, 0, 0);
 134    if (shminfo->shmaddr == (char *) -1) {
 135       shmctl(shminfo->shmid, IPC_RMID, 0);
 136       return NULL;
 137    }
 138
 139    shminfo->readOnly = False;
 140    return shminfo->shmaddr;
 141 }
 142
 143
 144 /**
 145  * Allocate a shared memory XImage back buffer for the given XMesaBuffer.
 146  */
 147 static void
 148 alloc_shm_ximage(struct xm_displaytarget *xm_dt,
 149                  struct xlib_drawable *xmb,
 150                  unsigned width, unsigned height)
 151 {
 152    /*
 153     * We have to do a _lot_ of error checking here to be sure we can
 154     * really use the XSHM extension.  It seems different servers trigger
 155     * errors at different points if the extension won't work.  Therefore
 156     * we have to be very careful...
 157     */
 158    int (*old_handler)(Display *, XErrorEvent *);
 159
 160    xm_dt->tempImage = XShmCreateImage(xm_dt->display,
 161                                       xmb->visual,
 162                                       xmb->depth,
 163                                       ZPixmap,
 164                                       NULL,
 165                                       &xm_dt->shminfo,
 166                                       width, height);
 167    if (xm_dt->tempImage == NULL) {
 168       xm_dt->shm = 0;
 169       return;
 170    }
 171
 172
 173    mesaXErrorFlag = 0;
 174    old_handler = XSetErrorHandler(mesaHandleXError);
 175    /* This may trigger the X protocol error we're ready to catch: */
 176    XShmAttach(xm_dt->display, &xm_dt->shminfo);
 177    XSync(xm_dt->display, False);
 178
 179    if (mesaXErrorFlag) {
 180       /* we are on a remote display, this error is normal, don't print it */
 181       XFlush(xm_dt->display);
 182       mesaXErrorFlag = 0;
 183       XDestroyImage(xm_dt->tempImage);
 184       xm_dt->tempImage = NULL;
 185       xm_dt->shm = 0;
 186       (void) XSetErrorHandler(old_handler);
 187       return;
 188    }
 189
 190    xm_dt->shm = 1;
 191 }
 192
 193
 194 static void
 195 alloc_ximage(struct xm_displaytarget *xm_dt,
 196              struct xlib_drawable *xmb,
 197              unsigned width, unsigned height)
 198 {
 199    if (xm_dt->shm) {
 200       alloc_shm_ximage(xm_dt, xmb, width, height);
 201       return;
 202    }
 203
 204    xm_dt->tempImage = XCreateImage(xm_dt->display,
 205                                    xmb->visual,
 206                                    xmb->depth,
 207                                    ZPixmap, 0,
 208                                    NULL, width, height,
 209                                    8, 0);
 210 }
 211
 212 static boolean
 213 xm_is_displaytarget_format_supported( struct sw_winsys *ws,
 214                                       unsigned tex_usage,
 215                                       enum pipe_format format )
 216 {
 217    /* TODO: check visuals or other sensible thing here */
 218    return TRUE;
 219 }
 220
 221
 222 static void *
 223 xm_displaytarget_map(struct sw_winsys *ws,
 224                      struct sw_displaytarget *dt,
 225                      unsigned flags)
 226 {
 227    struct xm_displaytarget *xm_dt = xm_displaytarget(dt);
 228    xm_dt->mapped = xm_dt->data;
 229    return xm_dt->mapped;
 230 }
 231
 232
 233 static void
 234 xm_displaytarget_unmap(struct sw_winsys *ws,
 235                        struct sw_displaytarget *dt)
 236 {
 237    struct xm_displaytarget *xm_dt = xm_displaytarget(dt);
 238    xm_dt->mapped = NULL;
 239 }
 240
 241
 242 static void
 243 xm_displaytarget_destroy(struct sw_winsys *ws,
 244                          struct sw_displaytarget *dt)
 245 {
 246    struct xm_displaytarget *xm_dt = xm_displaytarget(dt);
 247
 248    if (xm_dt->data) {
 249       if (xm_dt->shminfo.shmid >= 0) {
 250          shmdt(xm_dt->shminfo.shmaddr);
 251          shmctl(xm_dt->shminfo.shmid, IPC_RMID, 0);
 252
 253          xm_dt->shminfo.shmid = -1;
 254          xm_dt->shminfo.shmaddr = (char *) -1;
 255       }
 256       else {
 257          FREE(xm_dt->data);
 258          if (xm_dt->tempImage && xm_dt->tempImage->data == xm_dt->data) {
 259             xm_dt->tempImage->data = NULL;
 260          }
 261          xm_dt->data = NULL;
 262       }
 263    }
 264
 265    if (xm_dt->tempImage) {
 266       XDestroyImage(xm_dt->tempImage);
 267       xm_dt->tempImage = NULL;
 268    }
 269
 270    if (xm_dt->gc)
 271       XFreeGC(xm_dt->display, xm_dt->gc);
 272
 273    FREE(xm_dt);
 274 }
 275
 276
 277 /**
 278  * Display/copy the image in the surface into the X window specified
 279  * by the XMesaBuffer.
 280  */
 281 static void
 282 xlib_sw_display(struct xlib_drawable *xlib_drawable,
 283                 struct sw_displaytarget *dt)
 284 {
 285    static boolean no_swap = 0;
 286    static boolean firsttime = 1;
 287    struct xm_displaytarget *xm_dt = xm_displaytarget(dt);
 288    Display *display = xm_dt->display;
 289    XImage *ximage;
 290
 291    if (firsttime) {
 292       no_swap = getenv("SP_NO_RAST") != NULL;
 293       firsttime = 0;
 294    }
 295
 296    if (no_swap)
 297       return;
 298
 299    if (xm_dt->drawable != xlib_drawable->drawable) {
 300       if (xm_dt->gc) {
 301          XFreeGC( display, xm_dt->gc );
 302          xm_dt->gc = NULL;
 303       }
 304
 305       if (xm_dt->tempImage) {
 306          XDestroyImage( xm_dt->tempImage );
 307          xm_dt->tempImage = NULL;
 308       }
 309
 310       xm_dt->drawable = xlib_drawable->drawable;
 311    }
 312
 313    if (xm_dt->tempImage == NULL) {
 314       assert(util_format_get_blockwidth(xm_dt->format) == 1);
 315       assert(util_format_get_blockheight(xm_dt->format) == 1);
 316       alloc_ximage(xm_dt, xlib_drawable,
 317                    xm_dt->stride / util_format_get_blocksize(xm_dt->format),
 318                    xm_dt->height);
 319       if (!xm_dt->tempImage)
 320          return;
 321    }
 322
 323    if (xm_dt->gc == NULL) {
 324       xm_dt->gc = XCreateGC( display, xlib_drawable->drawable, 0, NULL );
 325       XSetFunction( display, xm_dt->gc, GXcopy );
 326    }
 327
 328    if (xm_dt->shm) {
 329       ximage = xm_dt->tempImage;
 330       ximage->data = xm_dt->data;
 331
 332       /* _debug_printf("XSHM\n"); */
 333       XShmPutImage(xm_dt->display, xlib_drawable->drawable, xm_dt->gc,
 334                    ximage, 0, 0, 0, 0, xm_dt->width, xm_dt->height, False);
 335    }
 336    else {
 337       /* display image in Window */
 338       ximage = xm_dt->tempImage;
 339       ximage->data = xm_dt->data;
 340
 341       /* check that the XImage has been previously initialized */
 342       assert(ximage->format);
 343       assert(ximage->bitmap_unit);
 344
 345       /* update XImage's fields */
 346       ximage->width = xm_dt->width;
 347       ximage->height = xm_dt->height;
 348       ximage->bytes_per_line = xm_dt->stride;
 349
 350       /* _debug_printf("XPUT\n"); */
 351       XPutImage(xm_dt->display, xlib_drawable->drawable, xm_dt->gc,
 352                 ximage, 0, 0, 0, 0, xm_dt->width, xm_dt->height);
 353    }
 354
 355    XFlush(xm_dt->display);
 356 }
 357
 358
 359 /**
 360  * Display/copy the image in the surface into the X window specified
 361  * by the XMesaBuffer.
 362  */
 363 static void
 364 xm_displaytarget_display(struct sw_winsys *ws,
 365                          struct sw_displaytarget *dt,
 366                          void *context_private)
 367 {
 368    struct xlib_drawable *xlib_drawable = (struct xlib_drawable *)context_private;
 369    xlib_sw_display(xlib_drawable, dt);
 370 }
 371
 372
 373 static struct sw_displaytarget *
 374 xm_displaytarget_create(struct sw_winsys *winsys,
 375                         unsigned tex_usage,
 376                         enum pipe_format format,
 377                         unsigned width, unsigned height,
 378                         unsigned alignment,
 379                         unsigned *stride)
 380 {
 381    struct xm_displaytarget *xm_dt;
 382    unsigned nblocksy, size;
 383
 384    xm_dt = CALLOC_STRUCT(xm_displaytarget);
 385    if (!xm_dt)
 386       goto no_xm_dt;
 387
 388    xm_dt->display = ((struct xlib_sw_winsys *)winsys)->display;
 389    xm_dt->format = format;
 390    xm_dt->width = width;
 391    xm_dt->height = height;
 392
 393    nblocksy = util_format_get_nblocksy(format, height);
 394    xm_dt->stride = align(util_format_get_stride(format, width), alignment);
 395    size = xm_dt->stride * nblocksy;
 396
 397    if (!debug_get_option_xlib_no_shm()) {
 398       xm_dt->data = alloc_shm(xm_dt, size);
 399       if (xm_dt->data) {
 400          xm_dt->shm = TRUE;
 401       }
 402    }
 403
 404    if (!xm_dt->data) {
 405       xm_dt->data = align_malloc(size, alignment);
 406       if (!xm_dt->data)
 407          goto no_data;
 408    }
 409
 410    *stride = xm_dt->stride;
 411    return (struct sw_displaytarget *)xm_dt;
 412
 413 no_data:
 414    FREE(xm_dt);
 415 no_xm_dt:
 416    return NULL;
 417 }
 418
 419
 420 static struct sw_displaytarget *
 421 xm_displaytarget_from_handle(struct sw_winsys *winsys,
 422                              const struct pipe_resource *templet,
 423                              struct winsys_handle *whandle,
 424                              unsigned *stride)
 425 {
 426    assert(0);
 427    return NULL;
 428 }
 429
 430
 431 static boolean
 432 xm_displaytarget_get_handle(struct sw_winsys *winsys,
 433                             struct sw_displaytarget *dt,
 434                             struct winsys_handle *whandle)
 435 {
 436    assert(0);
 437    return FALSE;
 438 }
 439
 440
 441 static void
 442 xm_destroy( struct sw_winsys *ws )
 443 {
 444    FREE(ws);
 445 }
 446
 447
 448 struct sw_winsys *
 449 xlib_create_sw_winsys( Display *display )
 450 {
 451    struct xlib_sw_winsys *ws;
 452
 453    ws = CALLOC_STRUCT(xlib_sw_winsys);
 454    if (!ws)
 455       return NULL;
 456
 457    ws->display = display;
 458    ws->base.destroy = xm_destroy;
 459
 460    ws->base.is_displaytarget_format_supported = xm_is_displaytarget_format_supported;
 461
 462    ws->base.displaytarget_create = xm_displaytarget_create;
 463    ws->base.displaytarget_from_handle = xm_displaytarget_from_handle;
 464    ws->base.displaytarget_get_handle = xm_displaytarget_get_handle;
 465    ws->base.displaytarget_map = xm_displaytarget_map;
 466    ws->base.displaytarget_unmap = xm_displaytarget_unmap;
 467    ws->base.displaytarget_destroy = xm_displaytarget_destroy;
 468
 469    ws->base.displaytarget_display = xm_displaytarget_display;
 470
 471    return &ws->base;
 472 }