src/gallium/drivers/svga/svga_winsys.h

   1 /**********************************************************
   2  * Copyright 2008-2009 VMware, Inc.  All rights reserved.
   3  *
   4  * Permission is hereby granted, free of charge, to any person
   5  * obtaining a copy of this software and associated documentation
   6  * files (the "Software"), to deal in the Software without
   7  * restriction, including without limitation the rights to use, copy,
   8  * modify, merge, publish, distribute, sublicense, and/or sell copies
   9  * of the Software, and to permit persons to whom the Software is
  10  * furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be
  13  * included in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  18  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  19  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  20  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  21  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  *
  24  **********************************************************/
  25
  26 /**
  27  * @file
  28  * VMware SVGA specific winsys interface.
  29  *
  30  * @author Jose Fonseca <jfonseca@vmware.com>
  31  *
  32  * Documentation taken from the VMware SVGA DDK.
  33  */
  34
  35 #ifndef SVGA_WINSYS_H_
  36 #define SVGA_WINSYS_H_
  37
  38 #include "svga_types.h"
  39 #include "svga3d_types.h"
  40 #include "svga_reg.h"
  41 #include "svga3d_reg.h"
  42
  43 #include "pipe/p_compiler.h"
  44 #include "pipe/p_defines.h"
  45
  46 #include "svga_mksstats.h"
  47
  48 struct svga_winsys_screen;
  49 struct svga_winsys_buffer;
  50 struct pipe_screen;
  51 struct pipe_context;
  52 struct pipe_debug_callback;
  53 struct pipe_fence_handle;
  54 struct pipe_resource;
  55 struct svga_region;
  56 struct winsys_handle;
  57
  58
  59 #define SVGA_BUFFER_USAGE_PINNED  (1 << 0)
  60 #define SVGA_BUFFER_USAGE_WRAPPED (1 << 1)
  61 #define SVGA_BUFFER_USAGE_SHADER  (1 << 2)
  62
  63 /**
  64  * Relocation flags to help with dirty tracking
  65  * SVGA_RELOC_WRITE -   The command will cause a GPU write to this
  66  *                      resource.
  67  * SVGA_RELOC_READ -    The command will cause a GPU read from this
  68  *                      resource.
  69  * SVGA_RELOC_INTERNAL  The command will only transfer data internally
  70  *                      within the resource, and optionally clear
  71  *                      dirty bits
  72  * SVGA_RELOC_DMA -     Only set for resource buffer DMA uploads for winsys
  73  *                      implementations that want to track the amount
  74  *                      of such data referenced in the command stream.
  75  */
  76 #define SVGA_RELOC_WRITE          (1 << 0)
  77 #define SVGA_RELOC_READ           (1 << 1)
  78 #define SVGA_RELOC_INTERNAL       (1 << 2)
  79 #define SVGA_RELOC_DMA            (1 << 3)
  80
  81 #define SVGA_FENCE_FLAG_EXEC      (1 << 0)
  82 #define SVGA_FENCE_FLAG_QUERY     (1 << 1)
  83
  84 #define SVGA_SURFACE_USAGE_SHARED   (1 << 0)
  85 #define SVGA_SURFACE_USAGE_SCANOUT  (1 << 1)
  86 #define SVGA_SURFACE_USAGE_COHERENT (1 << 2)
  87
  88 #define SVGA_QUERY_FLAG_SET        (1 << 0)
  89 #define SVGA_QUERY_FLAG_REF        (1 << 1)
  90
  91 #define SVGA_HINT_FLAG_CAN_PRE_FLUSH   (1 << 0)  /* Can preemptively flush */
  92 #define SVGA_HINT_FLAG_EXPORT_FENCE_FD (1 << 1)  /* Export a Fence FD */
  93
  94 /**
  95  * SVGA mks statistics info
  96  */
  97 struct svga_winsys_stats_timeframe {
  98    void *counterTime;
  99    uint64 startTime;
 100    uint64 adjustedStartTime;
 101    struct svga_winsys_stats_timeframe *enclosing;
 102 };
 103
 104 enum svga_stats_count {
 105    SVGA_STATS_COUNT_BLENDSTATE,
 106    SVGA_STATS_COUNT_BLITBLITTERCOPY,
 107    SVGA_STATS_COUNT_DEPTHSTENCILSTATE,
 108    SVGA_STATS_COUNT_RASTERIZERSTATE,
 109    SVGA_STATS_COUNT_SAMPLER,
 110    SVGA_STATS_COUNT_SAMPLERVIEW,
 111    SVGA_STATS_COUNT_SURFACEWRITEFLUSH,
 112    SVGA_STATS_COUNT_TEXREADBACK,
 113    SVGA_STATS_COUNT_VERTEXELEMENT,
 114    SVGA_STATS_COUNT_MAX
 115 };
 116
 117 enum svga_stats_time {
 118    SVGA_STATS_TIME_BLIT,
 119    SVGA_STATS_TIME_BLITBLITTER,
 120    SVGA_STATS_TIME_BLITFALLBACK,
 121    SVGA_STATS_TIME_BUFFERSFLUSH,
 122    SVGA_STATS_TIME_BUFFERTRANSFERMAP,
 123    SVGA_STATS_TIME_BUFFERTRANSFERUNMAP,
 124    SVGA_STATS_TIME_CONTEXTFINISH,
 125    SVGA_STATS_TIME_CONTEXTFLUSH,
 126    SVGA_STATS_TIME_COPYREGION,
 127    SVGA_STATS_TIME_COPYREGIONFALLBACK,
 128    SVGA_STATS_TIME_CREATEBACKEDSURFACEVIEW,
 129    SVGA_STATS_TIME_CREATEBUFFER,
 130    SVGA_STATS_TIME_CREATECONTEXT,
 131    SVGA_STATS_TIME_CREATEFS,
 132    SVGA_STATS_TIME_CREATEGS,
 133    SVGA_STATS_TIME_CREATESURFACE,
 134    SVGA_STATS_TIME_CREATESURFACEVIEW,
 135    SVGA_STATS_TIME_CREATETEXTURE,
 136    SVGA_STATS_TIME_CREATEVS,
 137    SVGA_STATS_TIME_DEFINESHADER,
 138    SVGA_STATS_TIME_DESTROYSURFACE,
 139    SVGA_STATS_TIME_DRAWVBO,
 140    SVGA_STATS_TIME_DRAWARRAYS,
 141    SVGA_STATS_TIME_DRAWELEMENTS,
 142    SVGA_STATS_TIME_EMITFS,
 143    SVGA_STATS_TIME_EMITGS,
 144    SVGA_STATS_TIME_EMITVS,
 145    SVGA_STATS_TIME_EMULATESURFACEVIEW,
 146    SVGA_STATS_TIME_FENCEFINISH,
 147    SVGA_STATS_TIME_GENERATEINDICES,
 148    SVGA_STATS_TIME_HWTNLDRAWARRAYS,
 149    SVGA_STATS_TIME_HWTNLDRAWELEMENTS,
 150    SVGA_STATS_TIME_HWTNLFLUSH,
 151    SVGA_STATS_TIME_HWTNLPRIM,
 152    SVGA_STATS_TIME_PROPAGATESURFACE,
 153    SVGA_STATS_TIME_SETSAMPLERVIEWS,
 154    SVGA_STATS_TIME_SURFACEFLUSH,
 155    SVGA_STATS_TIME_SWTNLDRAWVBO,
 156    SVGA_STATS_TIME_SWTNLUPDATEDRAW,
 157    SVGA_STATS_TIME_SWTNLUPDATEVDECL,
 158    SVGA_STATS_TIME_TEXTRANSFERMAP,
 159    SVGA_STATS_TIME_TEXTRANSFERUNMAP,
 160    SVGA_STATS_TIME_TGSIVGPU10TRANSLATE,
 161    SVGA_STATS_TIME_TGSIVGPU9TRANSLATE,
 162    SVGA_STATS_TIME_UPDATESTATE,
 163    SVGA_STATS_TIME_VALIDATESURFACEVIEW,
 164    SVGA_STATS_TIME_VBUFDRAWARRAYS,
 165    SVGA_STATS_TIME_VBUFDRAWELEMENTS,
 166    SVGA_STATS_TIME_VBUFRENDERALLOCVERT,
 167    SVGA_STATS_TIME_VBUFRENDERMAPVERT,
 168    SVGA_STATS_TIME_VBUFRENDERUNMAPVERT,
 169    SVGA_STATS_TIME_VBUFSUBMITSTATE,
 170    SVGA_STATS_TIME_MAX
 171 };
 172
 173 #define SVGA_STATS_PREFIX "GuestGL_"
 174
 175 #define SVGA_STATS_COUNT_NAMES                \
 176    SVGA_STATS_PREFIX "BlendState",            \
 177    SVGA_STATS_PREFIX "BlitBlitterCopy",       \
 178    SVGA_STATS_PREFIX "DepthStencilState",     \
 179    SVGA_STATS_PREFIX "RasterizerState",       \
 180    SVGA_STATS_PREFIX "Sampler",               \
 181    SVGA_STATS_PREFIX "SamplerView",           \
 182    SVGA_STATS_PREFIX "SurfaceWriteFlush",     \
 183    SVGA_STATS_PREFIX "TextureReadback",       \
 184    SVGA_STATS_PREFIX "VertexElement"          \
 185
 186 #define SVGA_STATS_TIME_NAMES                       \
 187    SVGA_STATS_PREFIX "Blit",                        \
 188    SVGA_STATS_PREFIX "BlitBlitter",                 \
 189    SVGA_STATS_PREFIX "BlitFallback",                \
 190    SVGA_STATS_PREFIX "BuffersFlush",                \
 191    SVGA_STATS_PREFIX "BufferTransferMap",           \
 192    SVGA_STATS_PREFIX "BufferTransferUnmap",         \
 193    SVGA_STATS_PREFIX "ContextFinish",               \
 194    SVGA_STATS_PREFIX "ContextFlush",                \
 195    SVGA_STATS_PREFIX "CopyRegion",                  \
 196    SVGA_STATS_PREFIX "CopyRegionFallback",          \
 197    SVGA_STATS_PREFIX "CreateBackedSurfaceView",     \
 198    SVGA_STATS_PREFIX "CreateBuffer",                \
 199    SVGA_STATS_PREFIX "CreateContext",               \
 200    SVGA_STATS_PREFIX "CreateFS",                    \
 201    SVGA_STATS_PREFIX "CreateGS",                    \
 202    SVGA_STATS_PREFIX "CreateSurface",               \
 203    SVGA_STATS_PREFIX "CreateSurfaceView",           \
 204    SVGA_STATS_PREFIX "CreateTexture",               \
 205    SVGA_STATS_PREFIX "CreateVS",                    \
 206    SVGA_STATS_PREFIX "DefineShader",                \
 207    SVGA_STATS_PREFIX "DestroySurface",              \
 208    SVGA_STATS_PREFIX "DrawVBO",                     \
 209    SVGA_STATS_PREFIX "DrawArrays",                  \
 210    SVGA_STATS_PREFIX "DrawElements",                \
 211    SVGA_STATS_PREFIX "EmitFS",                      \
 212    SVGA_STATS_PREFIX "EmitGS",                      \
 213    SVGA_STATS_PREFIX "EmitVS",                      \
 214    SVGA_STATS_PREFIX "EmulateSurfaceView",          \
 215    SVGA_STATS_PREFIX "FenceFinish",                 \
 216    SVGA_STATS_PREFIX "GenerateIndices",             \
 217    SVGA_STATS_PREFIX "HWtnlDrawArrays",             \
 218    SVGA_STATS_PREFIX "HWtnlDrawElements",           \
 219    SVGA_STATS_PREFIX "HWtnlFlush",                  \
 220    SVGA_STATS_PREFIX "HWtnlPrim",                   \
 221    SVGA_STATS_PREFIX "PropagateSurface",            \
 222    SVGA_STATS_PREFIX "SetSamplerViews",             \
 223    SVGA_STATS_PREFIX "SurfaceFlush",                \
 224    SVGA_STATS_PREFIX "SwtnlDrawVBO",                \
 225    SVGA_STATS_PREFIX "SwtnlUpdateDraw",             \
 226    SVGA_STATS_PREFIX "SwtnlUpdateVDecl",            \
 227    SVGA_STATS_PREFIX "TextureTransferMap",          \
 228    SVGA_STATS_PREFIX "TextureTransferUnmap",        \
 229    SVGA_STATS_PREFIX "TGSIVGPU10Translate",         \
 230    SVGA_STATS_PREFIX "TGSIVGPU9Translate",          \
 231    SVGA_STATS_PREFIX "UpdateState",                 \
 232    SVGA_STATS_PREFIX "ValidateSurfaceView",         \
 233    SVGA_STATS_PREFIX "VbufDrawArrays",              \
 234    SVGA_STATS_PREFIX "VbufDrawElements",            \
 235    SVGA_STATS_PREFIX "VbufRenderAllocVertices",     \
 236    SVGA_STATS_PREFIX "VbufRenderMapVertices",       \
 237    SVGA_STATS_PREFIX "VbufRenderUnmapVertices",     \
 238    SVGA_STATS_PREFIX "VbufSubmitState"
 239
 240
 241 /** Opaque surface handle */
 242 struct svga_winsys_surface;
 243
 244 /** Opaque guest-backed objects */
 245 struct svga_winsys_gb_shader;
 246 struct svga_winsys_gb_query;
 247
 248
 249 /**
 250  * SVGA per-context winsys interface.
 251  */
 252 struct svga_winsys_context
 253 {
 254    void
 255    (*destroy)(struct svga_winsys_context *swc);
 256
 257    void *
 258    (*reserve)(struct svga_winsys_context *swc,
 259               uint32_t nr_bytes, uint32_t nr_relocs );
 260
 261    /**
 262     * Returns current size of command buffer, in bytes.
 263     */
 264    unsigned
 265    (*get_command_buffer_size)(struct svga_winsys_context *swc);
 266
 267    /**
 268     * Emit a relocation for a host surface.
 269     *
 270     * @param flags bitmask of SVGA_RELOC_* flags
 271     *
 272     * NOTE: Order of this call does matter. It should be the same order
 273     * as relocations appear in the command buffer.
 274     */
 275    void
 276    (*surface_relocation)(struct svga_winsys_context *swc,
 277                          uint32 *sid,
 278                          uint32 *mobid,
 279                          struct svga_winsys_surface *surface,
 280                          unsigned flags);
 281
 282    /**
 283     * Emit a relocation for a guest memory region.
 284     *
 285     * @param flags bitmask of SVGA_RELOC_* flags
 286     *
 287     * NOTE: Order of this call does matter. It should be the same order
 288     * as relocations appear in the command buffer.
 289     */
 290    void
 291    (*region_relocation)(struct svga_winsys_context *swc,
 292                         struct SVGAGuestPtr *ptr,
 293                         struct svga_winsys_buffer *buffer,
 294                         uint32 offset,
 295                         unsigned flags);
 296
 297    /**
 298     * Emit a relocation for a guest-backed shader object.
 299     *
 300     * NOTE: Order of this call does matter. It should be the same order
 301     * as relocations appear in the command buffer.
 302     */
 303    void
 304    (*shader_relocation)(struct svga_winsys_context *swc,
 305                         uint32 *shid,
 306                         uint32 *mobid,
 307                         uint32 *offset,
 308                         struct svga_winsys_gb_shader *shader,
 309                         unsigned flags);
 310
 311    /**
 312     * Emit a relocation for a guest-backed context.
 313     *
 314     * NOTE: Order of this call does matter. It should be the same order
 315     * as relocations appear in the command buffer.
 316     */
 317    void
 318    (*context_relocation)(struct svga_winsys_context *swc, uint32 *cid);
 319
 320    /**
 321     * Emit a relocation for a guest Memory OBject.
 322     *
 323     * @param flags bitmask of SVGA_RELOC_* flags
 324     * @param offset_into_mob Buffer starts at this offset into the MOB.
 325     *
 326     * Note that not all commands accept an offset into the MOB and
 327     * those commands can't use suballocated buffer pools. To trap
 328     * errors from improper buffer pool usage, set the offset_into_mob
 329     * pointer to NULL.
 330     */
 331    void
 332    (*mob_relocation)(struct svga_winsys_context *swc,
 333                      SVGAMobId *id,
 334                      uint32 *offset_into_mob,
 335                      struct svga_winsys_buffer *buffer,
 336                      uint32 offset,
 337                      unsigned flags);
 338
 339    /**
 340     * Emit a relocation for a guest-backed query object.
 341     *
 342     * NOTE: Order of this call does matter. It should be the same order
 343     * as relocations appear in the command buffer.
 344     */
 345    void
 346    (*query_relocation)(struct svga_winsys_context *swc,
 347                        SVGAMobId *id,
 348                        struct svga_winsys_gb_query *query);
 349
 350    /**
 351     * Bind queries to context.
 352     * \param flags  exactly one of SVGA_QUERY_FLAG_SET/REF
 353     */
 354    enum pipe_error
 355    (*query_bind)(struct svga_winsys_context *sws,
 356                  struct svga_winsys_gb_query *query,
 357                  unsigned flags);
 358
 359    void
 360    (*commit)(struct svga_winsys_context *swc);
 361
 362    enum pipe_error
 363    (*flush)(struct svga_winsys_context *swc,
 364             struct pipe_fence_handle **pfence);
 365
 366    /**
 367     * Context ID used to fill in the commands
 368     *
 369     * Context IDs are arbitrary small non-negative integers,
 370     * global to the entire SVGA device.
 371     */
 372    uint32 cid;
 373
 374    /**
 375     * Flags to hint the current context state
 376     */
 377    uint32 hints;
 378
 379    /**
 380     * File descriptor for imported fence
 381     */
 382    int32 imported_fence_fd;
 383
 384    /**
 385     ** BEGIN new functions for guest-backed surfaces.
 386     **/
 387
 388    boolean have_gb_objects;
 389    boolean force_coherent;
 390
 391    /**
 392     * Map a guest-backed surface.
 393     * \param flags  bitmaks of PIPE_TRANSFER_x flags
 394     *
 395     * The surface_map() member is allowed to fail due to a
 396     * shortage of command buffer space, if the
 397     * PIPE_TRANSFER_DISCARD_WHOLE_RESOURCE bit is set in flags.
 398     * In that case, the caller must flush the current command
 399     * buffer and reissue the map.
 400     */
 401    void *
 402    (*surface_map)(struct svga_winsys_context *swc,
 403                   struct svga_winsys_surface *surface,
 404                   unsigned flags, boolean *retry);
 405
 406    /**
 407     * Unmap a guest-backed surface.
 408     * \param rebind  returns a flag indicating whether the caller should
 409     *                issue a SVGA3D_BindGBSurface() call.
 410     */
 411    void
 412    (*surface_unmap)(struct svga_winsys_context *swc,
 413                     struct svga_winsys_surface *surface,
 414                     boolean *rebind);
 415
 416    /**
 417     * Create and define a DX GB shader that resides in the device COTable.
 418     * Caller of this function will issue the DXDefineShader command.
 419     */
 420    struct svga_winsys_gb_shader *
 421    (*shader_create)(struct svga_winsys_context *swc,
 422                     uint32 shaderId,
 423                     SVGA3dShaderType shaderType,
 424                     const uint32 *bytecode,
 425                     uint32 bytecodeLen);
 426
 427    /**
 428     * Destroy a DX GB shader.
 429     * This function will issue the DXDestroyShader command.
 430     */
 431    void
 432    (*shader_destroy)(struct svga_winsys_context *swc,
 433                      struct svga_winsys_gb_shader *shader);
 434
 435    /**
 436     * Rebind a DX GB resource to a context.
 437     * This is called to reference a DX GB resource in the command stream in
 438     * order to page in the associated resource in case the memory has been
 439     * paged out, and to fence it if necessary after command submission.
 440     */
 441    enum pipe_error
 442    (*resource_rebind)(struct svga_winsys_context *swc,
 443                       struct svga_winsys_surface *surface,
 444                       struct svga_winsys_gb_shader *shader,
 445                       unsigned flags);
 446
 447    /** To report perf/conformance/etc issues to the state tracker */
 448    struct pipe_debug_callback *debug_callback;
 449
 450    /** The more recent command issued to command buffer */
 451    SVGAFifo3dCmdId last_command;
 452
 453    /** For HUD queries */
 454    uint64_t num_commands;
 455    uint64_t num_draw_commands;
 456 };
 457
 458
 459 /**
 460  * SVGA per-screen winsys interface.
 461  */
 462 struct svga_winsys_screen
 463 {
 464    void
 465    (*destroy)(struct svga_winsys_screen *sws);
 466
 467    SVGA3dHardwareVersion
 468    (*get_hw_version)(struct svga_winsys_screen *sws);
 469
 470    boolean
 471    (*get_cap)(struct svga_winsys_screen *sws,
 472               SVGA3dDevCapIndex index,
 473               SVGA3dDevCapResult *result);
 474
 475    /**
 476     * Create a new context.
 477     *
 478     * Context objects encapsulate all render state, and shader
 479     * objects are per-context.
 480     *
 481     * Surfaces are not per-context. The same surface can be shared
 482     * between multiple contexts, and surface operations can occur
 483     * without a context.
 484     */
 485    struct svga_winsys_context *
 486    (*context_create)(struct svga_winsys_screen *sws);
 487
 488    /**
 489     * This creates a "surface" object in the SVGA3D device.
 490     *
 491     * \param sws Pointer to an svga_winsys_context
 492     * \param flags Device surface create flags
 493     * \param format Format Device surface format
 494     * \param usage Winsys usage: bitmask of SVGA_SURFACE_USAGE_x flags
 495     * \param size Surface size given in device format
 496     * \param numLayers Number of layers of the surface (or cube faces)
 497     * \param numMipLevels Number of mipmap levels for each face
 498     *
 499     * Returns the surface ID (sid). Surfaces are generic
 500     * containers for host VRAM objects like textures, vertex
 501     * buffers, and depth/stencil buffers.
 502     *
 503     * Surfaces are hierarchial:
 504     *
 505     * - Surface may have multiple faces (for cube maps)
 506     *
 507     * - Each face has a list of mipmap levels
 508     *
 509     * - Each mipmap image may have multiple volume
 510     *   slices for 3D image, or multiple 2D slices for texture array.
 511     *
 512     * - Each slice is a 2D array of 'blocks'
 513     *
 514     * - Each block may be one or more pixels.
 515     *   (Usually 1, more for DXT or YUV formats.)
 516     *
 517     * Surfaces are generic host VRAM objects. The SVGA3D device
 518     * may optimize surfaces according to the format they were
 519     * created with, but this format does not limit the ways in
 520     * which the surface may be used. For example, a depth surface
 521     * can be used as a texture, or a floating point image may
 522     * be used as a vertex buffer. Some surface usages may be
 523     * lower performance, due to software emulation, but any
 524     * usage should work with any surface.
 525     */
 526    struct svga_winsys_surface *
 527    (*surface_create)(struct svga_winsys_screen *sws,
 528                      SVGA3dSurfaceAllFlags flags,
 529                      SVGA3dSurfaceFormat format,
 530                      unsigned usage,
 531                      SVGA3dSize size,
 532                      uint32 numLayers,
 533                      uint32 numMipLevels,
 534                      unsigned sampleCount);
 535
 536    /**
 537     * Creates a surface from a winsys handle.
 538     * Used to implement pipe_screen::resource_from_handle.
 539     */
 540    struct svga_winsys_surface *
 541    (*surface_from_handle)(struct svga_winsys_screen *sws,
 542                           struct winsys_handle *whandle,
 543                           SVGA3dSurfaceFormat *format);
 544
 545    /**
 546     * Get a winsys_handle from a surface.
 547     * Used to implement pipe_screen::resource_get_handle.
 548     */
 549    boolean
 550    (*surface_get_handle)(struct svga_winsys_screen *sws,
 551                          struct svga_winsys_surface *surface,
 552                          unsigned stride,
 553                          struct winsys_handle *whandle);
 554
 555    /**
 556     * Whether this surface is sitting in a validate list
 557     */
 558    boolean
 559    (*surface_is_flushed)(struct svga_winsys_screen *sws,
 560                          struct svga_winsys_surface *surface);
 561
 562    /**
 563     * Reference a SVGA3D surface object. This allows sharing of a
 564     * surface between different objects.
 565     */
 566    void
 567    (*surface_reference)(struct svga_winsys_screen *sws,
 568                         struct svga_winsys_surface **pdst,
 569                         struct svga_winsys_surface *src);
 570
 571    /**
 572     * Check if a resource (texture, buffer) of the given size
 573     * and format can be created.
 574     * \Return TRUE if OK, FALSE if too large.
 575     */
 576    boolean
 577    (*surface_can_create)(struct svga_winsys_screen *sws,
 578                          SVGA3dSurfaceFormat format,
 579                          SVGA3dSize size,
 580                          uint32 numLayers,
 581                          uint32 numMipLevels,
 582                          uint32 numSamples);
 583
 584    /**
 585     * Buffer management. Buffer attributes are mostly fixed over its lifetime.
 586     *
 587     * @param usage bitmask of SVGA_BUFFER_USAGE_* flags.
 588     *
 589     * alignment indicates the client's alignment requirements, eg for
 590     * SSE instructions.
 591     */
 592    struct svga_winsys_buffer *
 593    (*buffer_create)( struct svga_winsys_screen *sws,
 594                      unsigned alignment,
 595                      unsigned usage,
 596                      unsigned size );
 597
 598    /**
 599     * Map the entire data store of a buffer object into the client's address.
 600     * usage is a bitmask of PIPE_TRANSFER_*
 601     */
 602    void *
 603    (*buffer_map)( struct svga_winsys_screen *sws,
 604                   struct svga_winsys_buffer *buf,
 605                   unsigned usage );
 606
 607    void
 608    (*buffer_unmap)( struct svga_winsys_screen *sws,
 609                     struct svga_winsys_buffer *buf );
 610
 611    void
 612    (*buffer_destroy)( struct svga_winsys_screen *sws,
 613                       struct svga_winsys_buffer *buf );
 614
 615
 616    /**
 617     * Reference a fence object.
 618     */
 619    void
 620    (*fence_reference)( struct svga_winsys_screen *sws,
 621                        struct pipe_fence_handle **pdst,
 622                        struct pipe_fence_handle *src );
 623
 624    /**
 625     * Checks whether the fence has been signalled.
 626     * \param flags  driver-specific meaning
 627     * \return zero on success.
 628     */
 629    int (*fence_signalled)( struct svga_winsys_screen *sws,
 630                            struct pipe_fence_handle *fence,
 631                            unsigned flag );
 632
 633    /**
 634     * Wait for the fence to finish.
 635     * \param timeout in nanoseconds (may be PIPE_TIMEOUT_INFINITE).
 636     *                0 to return immediately, if the API suports it.
 637     * \param flags  driver-specific meaning
 638     * \return zero on success.
 639     */
 640    int (*fence_finish)( struct svga_winsys_screen *sws,
 641                         struct pipe_fence_handle *fence,
 642                         uint64_t timeout,
 643                         unsigned flag );
 644
 645    /**
 646     * Get the file descriptor associated with the fence
 647     * \param duplicate duplicate the fd before returning it
 648     * \return zero on success.
 649     */
 650    int (*fence_get_fd)( struct svga_winsys_screen *sws,
 651                         struct pipe_fence_handle *fence,
 652                         boolean duplicate );
 653
 654    /**
 655     * Create a fence using the given file descriptor
 656     * \return zero on success.
 657     */
 658    void (*fence_create_fd)( struct svga_winsys_screen *sws,
 659                             struct pipe_fence_handle **fence,
 660                             int32_t fd );
 661
 662    /**
 663     * Accumulates fence FD from other devices into the current context
 664     * \param context_fd FD the context will be waiting on
 665     * \return zero on success
 666     */
 667    int (*fence_server_sync)( struct svga_winsys_screen *sws,
 668                              int32_t *context_fd,
 669                              struct pipe_fence_handle *fence );
 670
 671    /**
 672     ** BEGIN new functions for guest-backed surfaces.
 673     **/
 674
 675    /** Are guest-backed objects enabled? */
 676    bool have_gb_objects;
 677
 678    /** Can we do DMA with guest-backed objects enabled? */
 679    bool have_gb_dma;
 680
 681    /** Do we support coherent surface memory? */
 682    bool have_coherent;
 683    /**
 684     * Create and define a GB shader.
 685     */
 686    struct svga_winsys_gb_shader *
 687    (*shader_create)(struct svga_winsys_screen *sws,
 688                     SVGA3dShaderType shaderType,
 689                     const uint32 *bytecode,
 690                     uint32 bytecodeLen);
 691
 692    /**
 693     * Destroy a GB shader. It's safe to call this function even
 694     * if the shader is referenced in a context's command stream.
 695     */
 696    void
 697    (*shader_destroy)(struct svga_winsys_screen *sws,
 698                      struct svga_winsys_gb_shader *shader);
 699
 700    /**
 701     * Create and define a GB query.
 702     */
 703    struct svga_winsys_gb_query *
 704    (*query_create)(struct svga_winsys_screen *sws, uint32 len);
 705
 706    /**
 707     * Destroy a GB query.
 708     */
 709    void
 710    (*query_destroy)(struct svga_winsys_screen *sws,
 711                     struct svga_winsys_gb_query *query);
 712
 713    /**
 714     * Initialize the query state of the query that resides in the slot
 715     * specified in offset
 716     * \return zero on success.
 717     */
 718    int
 719    (*query_init)(struct svga_winsys_screen *sws,
 720                        struct svga_winsys_gb_query *query,
 721                        unsigned offset,
 722                        SVGA3dQueryState queryState);
 723
 724    /**
 725     * Inquire for the query state and result of the query that resides
 726     * in the slot specified in offset
 727     */
 728    void
 729    (*query_get_result)(struct svga_winsys_screen *sws,
 730                        struct svga_winsys_gb_query *query,
 731                        unsigned offset,
 732                        SVGA3dQueryState *queryState,
 733                        void *result, uint32 resultLen);
 734
 735    /**
 736     * Increment a statistic counter
 737     */
 738    void
 739    (*stats_inc)(enum svga_stats_count);
 740
 741    /**
 742     * Push a time frame onto the stack
 743     */
 744    void
 745    (*stats_time_push)(enum svga_stats_time, struct svga_winsys_stats_timeframe *);
 746
 747    /**
 748     * Pop a time frame.
 749     */
 750    void
 751    (*stats_time_pop)();
 752
 753    /**
 754     * Send a host log message
 755     */
 756    void
 757    (*host_log)(struct svga_winsys_screen *sws, const char *message);
 758
 759    /** Have VGPU v10 hardware? */
 760    boolean have_vgpu10;
 761
 762    /** Have SM4_1 hardware? */
 763    boolean have_sm4_1;
 764
 765    /** To rebind resources at the beginnning of a new command buffer */
 766    boolean need_to_rebind_resources;
 767
 768    boolean have_generate_mipmap_cmd;
 769    boolean have_set_predication_cmd;
 770    boolean have_transfer_from_buffer_cmd;
 771    boolean have_fence_fd;
 772    boolean have_intra_surface_copy;
 773 };
 774
 775
 776 struct svga_winsys_screen *
 777 svga_winsys_screen(struct pipe_screen *screen);
 778
 779 struct svga_winsys_context *
 780 svga_winsys_context(struct pipe_context *context);
 781
 782 struct pipe_resource *
 783 svga_screen_buffer_wrap_surface(struct pipe_screen *screen,
 784                                 enum SVGA3dSurfaceFormat format,
 785                                 struct svga_winsys_surface *srf);
 786
 787 struct svga_winsys_surface *
 788 svga_screen_buffer_get_winsys_surface(struct pipe_resource *buffer);
 789
 790 #endif /* SVGA_WINSYS_H_ */