src/gallium/include/pipe/p_screen.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2007 VMware, Inc.
   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 VMWARE 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 /**
  29  * @file
  30  *
  31  * Screen, Adapter or GPU
  32  *
  33  * These are driver functions/facilities that are context independent.
  34  */
  35
  36
  37 #ifndef P_SCREEN_H
  38 #define P_SCREEN_H
  39
  40
  41 #include "pipe/p_compiler.h"
  42 #include "pipe/p_format.h"
  43 #include "pipe/p_defines.h"
  44 #include "pipe/p_video_enums.h"
  45
  46
  47
  48 #ifdef __cplusplus
  49 extern "C" {
  50 #endif
  51
  52
  53 /** Opaque types */
  54 struct winsys_handle;
  55 struct pipe_fence_handle;
  56 struct pipe_resource;
  57 struct pipe_surface;
  58 struct pipe_transfer;
  59 struct pipe_box;
  60 struct pipe_memory_info;
  61 struct disk_cache;
  62 struct driOptionCache;
  63 struct u_transfer_helper;
  64
  65 /**
  66  * Gallium screen/adapter context.  Basically everything
  67  * hardware-specific that doesn't actually require a rendering
  68  * context.
  69  */
  70 struct pipe_screen {
  71
  72    /**
  73     * For drivers using u_transfer_helper:
  74     */
  75    struct u_transfer_helper *transfer_helper;
  76
  77    void (*destroy)( struct pipe_screen * );
  78
  79    const char *(*get_name)( struct pipe_screen * );
  80
  81    const char *(*get_vendor)( struct pipe_screen * );
  82
  83    /**
  84     * Returns the device vendor.
  85     *
  86     * The returned value should return the actual device vendor/manufacturer,
  87     * rather than a potentially generic driver string.
  88     */
  89    const char *(*get_device_vendor)( struct pipe_screen * );
  90
  91    /**
  92     * Query an integer-valued capability/parameter/limit
  93     * \param param  one of PIPE_CAP_x
  94     */
  95    int (*get_param)( struct pipe_screen *, enum pipe_cap param );
  96
  97    /**
  98     * Query a float-valued capability/parameter/limit
  99     * \param param  one of PIPE_CAP_x
 100     */
 101    float (*get_paramf)( struct pipe_screen *, enum pipe_capf param );
 102
 103    /**
 104     * Query a per-shader-stage integer-valued capability/parameter/limit
 105     * \param param  one of PIPE_CAP_x
 106     */
 107    int (*get_shader_param)( struct pipe_screen *, enum pipe_shader_type shader,
 108                             enum pipe_shader_cap param );
 109
 110    /**
 111     * Query an integer-valued capability/parameter/limit for a codec/profile
 112     * \param param  one of PIPE_VIDEO_CAP_x
 113     */
 114    int (*get_video_param)( struct pipe_screen *,
 115                            enum pipe_video_profile profile,
 116                            enum pipe_video_entrypoint entrypoint,
 117                            enum pipe_video_cap param );
 118
 119    /**
 120     * Query a compute-specific capability/parameter/limit.
 121     * \param ir_type shader IR type for which the param applies, or don't care
 122     *                if the param is not shader related
 123     * \param param   one of PIPE_COMPUTE_CAP_x
 124     * \param ret     pointer to a preallocated buffer that will be
 125     *                initialized to the parameter value, or NULL.
 126     * \return        size in bytes of the parameter value that would be
 127     *                returned.
 128     */
 129    int (*get_compute_param)(struct pipe_screen *,
 130                             enum pipe_shader_ir ir_type,
 131                             enum pipe_compute_cap param,
 132                             void *ret);
 133
 134    /**
 135     * Get the sample pixel grid's size. This function requires
 136     * PIPE_CAP_PROGRAMMABLE_SAMPLE_LOCATIONS to be callable.
 137     *
 138     * \param sample_count - total number of samples
 139     * \param out_width - the width of the pixel grid
 140     * \param out_height - the height of the pixel grid
 141     */
 142    void (*get_sample_pixel_grid)(struct pipe_screen *, unsigned sample_count,
 143                                  unsigned *out_width, unsigned *out_height);
 144
 145    /**
 146     * Query a timestamp in nanoseconds. The returned value should match
 147     * PIPE_QUERY_TIMESTAMP. This function returns immediately and doesn't
 148     * wait for rendering to complete (which cannot be achieved with queries).
 149     */
 150    uint64_t (*get_timestamp)(struct pipe_screen *);
 151
 152    /**
 153     * Create a context.
 154     *
 155     * \param screen      pipe screen
 156     * \param priv        a pointer to set in pipe_context::priv
 157     * \param flags       a mask of PIPE_CONTEXT_* flags
 158     */
 159    struct pipe_context * (*context_create)(struct pipe_screen *screen,
 160                                            void *priv, unsigned flags);
 161
 162    /**
 163     * Check if the given pipe_format is supported as a texture or
 164     * drawing surface.
 165     * \param bindings  bitmask of PIPE_BIND_*
 166     */
 167    bool (*is_format_supported)( struct pipe_screen *,
 168                                 enum pipe_format format,
 169                                 enum pipe_texture_target target,
 170                                 unsigned sample_count,
 171                                 unsigned storage_sample_count,
 172                                 unsigned bindings );
 173
 174    /**
 175     * Check if the given pipe_format is supported as output for this codec/profile.
 176     * \param profile  profile to check, may also be PIPE_VIDEO_PROFILE_UNKNOWN
 177     */
 178    bool (*is_video_format_supported)( struct pipe_screen *,
 179                                       enum pipe_format format,
 180                                       enum pipe_video_profile profile,
 181                                       enum pipe_video_entrypoint entrypoint );
 182
 183    /**
 184     * Check if we can actually create the given resource (test the dimension,
 185     * overall size, etc).  Used to implement proxy textures.
 186     * \return TRUE if size is OK, FALSE if too large.
 187     */
 188    bool (*can_create_resource)(struct pipe_screen *screen,
 189                                const struct pipe_resource *templat);
 190
 191    /**
 192     * Create a new texture object, using the given template info.
 193     */
 194    struct pipe_resource * (*resource_create)(struct pipe_screen *,
 195                                              const struct pipe_resource *templat);
 196
 197    struct pipe_resource * (*resource_create_front)(struct pipe_screen *,
 198                                                    const struct pipe_resource *templat,
 199                                                    const void *map_front_private);
 200
 201    /**
 202     * Create a texture from a winsys_handle. The handle is often created in
 203     * another process by first creating a pipe texture and then calling
 204     * resource_get_handle.
 205     *
 206     * NOTE: in the case of WINSYS_HANDLE_TYPE_FD handles, the caller
 207     * retains ownership of the FD.  (This is consistent with
 208     * EGL_EXT_image_dma_buf_import)
 209     *
 210     * \param usage  A combination of PIPE_HANDLE_USAGE_* flags.
 211     */
 212    struct pipe_resource * (*resource_from_handle)(struct pipe_screen *,
 213                                                   const struct pipe_resource *templat,
 214                                                   struct winsys_handle *handle,
 215                                                   unsigned usage);
 216
 217    /**
 218     * Create a resource from user memory. This maps the user memory into
 219     * the device address space.
 220     */
 221    struct pipe_resource * (*resource_from_user_memory)(struct pipe_screen *,
 222                                                        const struct pipe_resource *t,
 223                                                        void *user_memory);
 224
 225    /**
 226     * Unlike pipe_resource::bind, which describes what gallium frontends want,
 227     * resources can have much greater capabilities in practice, often implied
 228     * by the tiling layout or memory placement. This function allows querying
 229     * whether a capability is supported beyond what was requested by state
 230     * trackers. It's also useful for querying capabilities of imported
 231     * resources where the capabilities are unknown at first.
 232     *
 233     * Only these flags are allowed:
 234     * - PIPE_BIND_SCANOUT
 235     * - PIPE_BIND_CURSOR
 236     * - PIPE_BIND_LINEAR
 237     */
 238    bool (*check_resource_capability)(struct pipe_screen *screen,
 239                                      struct pipe_resource *resource,
 240                                      unsigned bind);
 241
 242    /**
 243     * Get a winsys_handle from a texture. Some platforms/winsys requires
 244     * that the texture is created with a special usage flag like
 245     * DISPLAYTARGET or PRIMARY.
 246     *
 247     * The context parameter can optionally be used to flush the resource and
 248     * the context to make sure the resource is coherent with whatever user
 249     * will use it. Some drivers may also use the context to convert
 250     * the resource into a format compatible for sharing. The use case is
 251     * OpenGL-OpenCL interop. The context parameter is allowed to be NULL.
 252     *
 253     * NOTE: in the case of WINSYS_HANDLE_TYPE_FD handles, the caller
 254     * takes ownership of the FD.  (This is consistent with
 255     * EGL_MESA_image_dma_buf_export)
 256     *
 257     * \param usage  A combination of PIPE_HANDLE_USAGE_* flags.
 258     */
 259    bool (*resource_get_handle)(struct pipe_screen *,
 260                                struct pipe_context *context,
 261                                struct pipe_resource *tex,
 262                                struct winsys_handle *handle,
 263                                unsigned usage);
 264
 265    /**
 266     * Get info for the given pipe resource without the need to get a
 267     * winsys_handle.
 268     *
 269     * The context parameter can optionally be used to flush the resource and
 270     * the context to make sure the resource is coherent with whatever user
 271     * will use it. Some drivers may also use the context to convert
 272     * the resource into a format compatible for sharing. The context parameter
 273     * is allowed to be NULL.
 274     */
 275    bool (*resource_get_param)(struct pipe_screen *screen,
 276                               struct pipe_context *context,
 277                               struct pipe_resource *resource,
 278                               unsigned plane,
 279                               unsigned layer,
 280                               enum pipe_resource_param param,
 281                               unsigned handle_usage,
 282                               uint64_t *value);
 283
 284    /**
 285     * Get stride and offset for the given pipe resource without the need to get
 286     * a winsys_handle.
 287     */
 288    void (*resource_get_info)(struct pipe_screen *screen,
 289                              struct pipe_resource *resource,
 290                              unsigned *stride,
 291                              unsigned *offset);
 292
 293    /**
 294     * Mark the resource as changed so derived internal resources will be
 295     * recreated on next use.
 296     *
 297     * This is necessary when reimporting external images that can't be directly
 298     * used as texture sampler source, to avoid sampling from old copies.
 299     */
 300    void (*resource_changed)(struct pipe_screen *, struct pipe_resource *pt);
 301
 302    void (*resource_destroy)(struct pipe_screen *,
 303                             struct pipe_resource *pt);
 304
 305
 306    /**
 307     * Do any special operations to ensure frontbuffer contents are
 308     * displayed, eg copy fake frontbuffer.
 309     * \param winsys_drawable_handle  an opaque handle that the calling context
 310     *                                gets out-of-band
 311     * \param subbox an optional sub region to flush
 312     */
 313    void (*flush_frontbuffer)( struct pipe_screen *screen,
 314                               struct pipe_resource *resource,
 315                               unsigned level, unsigned layer,
 316                               void *winsys_drawable_handle,
 317                               struct pipe_box *subbox );
 318
 319    /** Set ptr = fence, with reference counting */
 320    void (*fence_reference)( struct pipe_screen *screen,
 321                             struct pipe_fence_handle **ptr,
 322                             struct pipe_fence_handle *fence );
 323
 324    /**
 325     * Wait for the fence to finish.
 326     *
 327     * If the fence was created with PIPE_FLUSH_DEFERRED, and the context is
 328     * still unflushed, and the ctx parameter of fence_finish is equal to
 329     * the context where the fence was created, fence_finish will flush
 330     * the context prior to waiting for the fence.
 331     *
 332     * In all other cases, the ctx parameter has no effect.
 333     *
 334     * \param timeout  in nanoseconds (may be PIPE_TIMEOUT_INFINITE).
 335     */
 336    bool (*fence_finish)(struct pipe_screen *screen,
 337                         struct pipe_context *ctx,
 338                         struct pipe_fence_handle *fence,
 339                         uint64_t timeout);
 340
 341    /**
 342     * For fences created with PIPE_FLUSH_FENCE_FD (exported fd) or
 343     * by create_fence_fd() (imported fd), return the native fence fd
 344     * associated with the fence.  This may return -1 for fences
 345     * created with PIPE_FLUSH_DEFERRED if the fence command has not
 346     * been flushed yet.
 347     */
 348    int (*fence_get_fd)(struct pipe_screen *screen,
 349                        struct pipe_fence_handle *fence);
 350
 351    /**
 352     * Returns a driver-specific query.
 353     *
 354     * If \p info is NULL, the number of available queries is returned.
 355     * Otherwise, the driver query at the specified \p index is returned
 356     * in \p info. The function returns non-zero on success.
 357     */
 358    int (*get_driver_query_info)(struct pipe_screen *screen,
 359                                 unsigned index,
 360                                 struct pipe_driver_query_info *info);
 361
 362    /**
 363     * Returns a driver-specific query group.
 364     *
 365     * If \p info is NULL, the number of available groups is returned.
 366     * Otherwise, the driver query group at the specified \p index is returned
 367     * in \p info. The function returns non-zero on success.
 368     */
 369    int (*get_driver_query_group_info)(struct pipe_screen *screen,
 370                                       unsigned index,
 371                                       struct pipe_driver_query_group_info *info);
 372
 373    /**
 374     * Query information about memory usage.
 375     */
 376    void (*query_memory_info)(struct pipe_screen *screen,
 377                              struct pipe_memory_info *info);
 378
 379    /**
 380     * Get IR specific compiler options struct.  For PIPE_SHADER_IR_NIR this
 381     * returns a 'struct nir_shader_compiler_options'.  Drivers reporting
 382     * NIR as the preferred IR must implement this.
 383     */
 384    const void *(*get_compiler_options)(struct pipe_screen *screen,
 385                                       enum pipe_shader_ir ir,
 386                                       enum pipe_shader_type shader);
 387
 388    /**
 389     * Returns a pointer to a driver-specific on-disk shader cache. If the
 390     * driver failed to create the cache or does not support an on-disk shader
 391     * cache NULL is returned. The callback itself may also be NULL if the
 392     * driver doesn't support an on-disk shader cache.
 393     */
 394    struct disk_cache *(*get_disk_shader_cache)(struct pipe_screen *screen);
 395
 396    /**
 397     * Create a new texture object from the given template info, taking
 398     * format modifiers into account. \p modifiers specifies a list of format
 399     * modifier tokens, as defined in drm_fourcc.h. The driver then picks the
 400     * best modifier among these and creates the resource. \p count must
 401     * contain the size of \p modifiers array.
 402     *
 403     * Returns NULL if an entry in \p modifiers is unsupported by the driver,
 404     * or if only DRM_FORMAT_MOD_INVALID is provided.
 405     */
 406    struct pipe_resource * (*resource_create_with_modifiers)(
 407                            struct pipe_screen *,
 408                            const struct pipe_resource *templat,
 409                            const uint64_t *modifiers, int count);
 410
 411    /**
 412     * Get supported modifiers for a format.
 413     * If \p max is 0, the total number of supported modifiers for the supplied
 414     * format is returned in \p count, with no modification to \p modifiers.
 415     * Otherwise, \p modifiers is filled with upto \p max supported modifier
 416     * codes, and \p count with the number of modifiers copied.
 417     * The \p external_only array is used to return whether the format and
 418     * modifier combination can only be used with an external texture target.
 419     */
 420    void (*query_dmabuf_modifiers)(struct pipe_screen *screen,
 421                                   enum pipe_format format, int max,
 422                                   uint64_t *modifiers,
 423                                   unsigned int *external_only, int *count);
 424
 425    /**
 426     * Create a memory object from a winsys handle
 427     *
 428     * The underlying memory is most often allocated in by a foregin API.
 429     * Then the underlying memory object is then exported through interfaces
 430     * compatible with EXT_external_resources.
 431     *
 432     * Note: For WINSYS_HANDLE_TYPE_FD handles, the caller retains ownership
 433     * of the fd.
 434     *
 435     * \param handle  A handle representing the memory object to import
 436     */
 437    struct pipe_memory_object *(*memobj_create_from_handle)(struct pipe_screen *screen,
 438                                                            struct winsys_handle *handle,
 439                                                            bool dedicated);
 440
 441    /**
 442     * Destroy a memory object
 443     *
 444     * \param memobj  The memory object to destroy
 445     */
 446    void (*memobj_destroy)(struct pipe_screen *screen,
 447                           struct pipe_memory_object *memobj);
 448
 449    /**
 450     * Create a texture from a memory object
 451     *
 452     * \param t       texture template
 453     * \param memobj  The memory object used to back the texture
 454     */
 455    struct pipe_resource * (*resource_from_memobj)(struct pipe_screen *screen,
 456                                                   const struct pipe_resource *t,
 457                                                   struct pipe_memory_object *memobj,
 458                                                   uint64_t offset);
 459
 460    /**
 461     * Fill @uuid with a unique driver identifier
 462     *
 463     * \param uuid    pointer to a memory region of PIPE_UUID_SIZE bytes
 464     */
 465    void (*get_driver_uuid)(struct pipe_screen *screen, char *uuid);
 466
 467    /**
 468     * Fill @uuid with a unique device identifier
 469     *
 470     * \param uuid    pointer to a memory region of PIPE_UUID_SIZE bytes
 471     */
 472    void (*get_device_uuid)(struct pipe_screen *screen, char *uuid);
 473
 474    /**
 475     * Set the maximum number of parallel shader compiler threads.
 476     */
 477    void (*set_max_shader_compiler_threads)(struct pipe_screen *screen,
 478                                            unsigned max_threads);
 479
 480    /**
 481     * Return whether parallel shader compilation has finished.
 482     */
 483    bool (*is_parallel_shader_compilation_finished)(struct pipe_screen *screen,
 484                                                    void *shader,
 485                                                    unsigned shader_type);
 486
 487    /**
 488     * Set the damage region (called when KHR_partial_update() is invoked).
 489     * This function is passed an array of rectangles encoding the damage area.
 490     * rects are using the bottom-left origin convention.
 491     * nrects = 0 means 'reset the damage region'. What 'reset' implies is HW
 492     * specific. For tile-based renderers, the damage extent is typically set
 493     * to cover the whole resource with no damage rect (or a 0-size damage
 494     * rect). This way, the existing resource content is reloaded into the
 495     * local tile buffer for every tile thus making partial tile update
 496     * possible. For HW operating in immediate mode, this reset operation is
 497     * likely to be a NOOP.
 498     */
 499    void (*set_damage_region)(struct pipe_screen *screen,
 500                              struct pipe_resource *resource,
 501                              unsigned int nrects,
 502                              const struct pipe_box *rects);
 503
 504    /**
 505     * Run driver-specific NIR lowering and optimization passes.
 506     *
 507     * gallium frontends should call this before passing shaders to drivers,
 508     * and ideally also before shader caching.
 509     *
 510     * \param optimize  Whether the input shader hasn't been optimized and
 511     *                  should be.
 512     */
 513    void (*finalize_nir)(struct pipe_screen *screen, void *nir, bool optimize);
 514 };
 515
 516
 517 /**
 518  * Global configuration options for screen creation.
 519  */
 520 struct pipe_screen_config {
 521    const struct driOptionCache *options;
 522 };
 523
 524
 525 #ifdef __cplusplus
 526 }
 527 #endif
 528
 529 #endif /* P_SCREEN_H */