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    boolean (*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    boolean (*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    boolean (*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 state trackers 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    boolean (*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     * Mark the resource as changed so derived internal resources will be
 267     * recreated on next use.
 268     *
 269     * This is necessary when reimporting external images that can't be directly
 270     * used as texture sampler source, to avoid sampling from old copies.
 271     */
 272    void (*resource_changed)(struct pipe_screen *, struct pipe_resource *pt);
 273
 274    void (*resource_destroy)(struct pipe_screen *,
 275                             struct pipe_resource *pt);
 276
 277
 278    /**
 279     * Do any special operations to ensure frontbuffer contents are
 280     * displayed, eg copy fake frontbuffer.
 281     * \param winsys_drawable_handle  an opaque handle that the calling context
 282     *                                gets out-of-band
 283     * \param subbox an optional sub region to flush
 284     */
 285    void (*flush_frontbuffer)( struct pipe_screen *screen,
 286                               struct pipe_resource *resource,
 287                               unsigned level, unsigned layer,
 288                               void *winsys_drawable_handle,
 289                               struct pipe_box *subbox );
 290
 291    /** Set ptr = fence, with reference counting */
 292    void (*fence_reference)( struct pipe_screen *screen,
 293                             struct pipe_fence_handle **ptr,
 294                             struct pipe_fence_handle *fence );
 295
 296    /**
 297     * Wait for the fence to finish.
 298     *
 299     * If the fence was created with PIPE_FLUSH_DEFERRED, and the context is
 300     * still unflushed, and the ctx parameter of fence_finish is equal to
 301     * the context where the fence was created, fence_finish will flush
 302     * the context prior to waiting for the fence.
 303     *
 304     * In all other cases, the ctx parameter has no effect.
 305     *
 306     * \param timeout  in nanoseconds (may be PIPE_TIMEOUT_INFINITE).
 307     */
 308    boolean (*fence_finish)(struct pipe_screen *screen,
 309                            struct pipe_context *ctx,
 310                            struct pipe_fence_handle *fence,
 311                            uint64_t timeout);
 312
 313    /**
 314     * For fences created with PIPE_FLUSH_FENCE_FD (exported fd) or
 315     * by create_fence_fd() (imported fd), return the native fence fd
 316     * associated with the fence.  This may return -1 for fences
 317     * created with PIPE_FLUSH_DEFERRED if the fence command has not
 318     * been flushed yet.
 319     */
 320    int (*fence_get_fd)(struct pipe_screen *screen,
 321                        struct pipe_fence_handle *fence);
 322
 323    /**
 324     * Returns a driver-specific query.
 325     *
 326     * If \p info is NULL, the number of available queries is returned.
 327     * Otherwise, the driver query at the specified \p index is returned
 328     * in \p info. The function returns non-zero on success.
 329     */
 330    int (*get_driver_query_info)(struct pipe_screen *screen,
 331                                 unsigned index,
 332                                 struct pipe_driver_query_info *info);
 333
 334    /**
 335     * Returns a driver-specific query group.
 336     *
 337     * If \p info is NULL, the number of available groups is returned.
 338     * Otherwise, the driver query group at the specified \p index is returned
 339     * in \p info. The function returns non-zero on success.
 340     */
 341    int (*get_driver_query_group_info)(struct pipe_screen *screen,
 342                                       unsigned index,
 343                                       struct pipe_driver_query_group_info *info);
 344
 345    /**
 346     * Query information about memory usage.
 347     */
 348    void (*query_memory_info)(struct pipe_screen *screen,
 349                              struct pipe_memory_info *info);
 350
 351    /**
 352     * Get IR specific compiler options struct.  For PIPE_SHADER_IR_NIR this
 353     * returns a 'struct nir_shader_compiler_options'.  Drivers reporting
 354     * NIR as the preferred IR must implement this.
 355     */
 356    const void *(*get_compiler_options)(struct pipe_screen *screen,
 357                                       enum pipe_shader_ir ir,
 358                                       enum pipe_shader_type shader);
 359
 360    /**
 361     * Returns a pointer to a driver-specific on-disk shader cache. If the
 362     * driver failed to create the cache or does not support an on-disk shader
 363     * cache NULL is returned. The callback itself may also be NULL if the
 364     * driver doesn't support an on-disk shader cache.
 365     */
 366    struct disk_cache *(*get_disk_shader_cache)(struct pipe_screen *screen);
 367
 368    /**
 369     * Create a new texture object from the given template info, taking
 370     * format modifiers into account. \p modifiers specifies a list of format
 371     * modifier tokens, as defined in drm_fourcc.h. The driver then picks the
 372     * best modifier among these and creates the resource. \p count must
 373     * contain the size of \p modifiers array.
 374     *
 375     * Returns NULL if an entry in \p modifiers is unsupported by the driver,
 376     * or if only DRM_FORMAT_MOD_INVALID is provided.
 377     */
 378    struct pipe_resource * (*resource_create_with_modifiers)(
 379                            struct pipe_screen *,
 380                            const struct pipe_resource *templat,
 381                            const uint64_t *modifiers, int count);
 382
 383    /**
 384     * Get supported modifiers for a format.
 385     * If \p max is 0, the total number of supported modifiers for the supplied
 386     * format is returned in \p count, with no modification to \p modifiers.
 387     * Otherwise, \p modifiers is filled with upto \p max supported modifier
 388     * codes, and \p count with the number of modifiers copied.
 389     * The \p external_only array is used to return whether the format and
 390     * modifier combination can only be used with an external texture target.
 391     */
 392    void (*query_dmabuf_modifiers)(struct pipe_screen *screen,
 393                                   enum pipe_format format, int max,
 394                                   uint64_t *modifiers,
 395                                   unsigned int *external_only, int *count);
 396
 397    /**
 398     * Create a memory object from a winsys handle
 399     *
 400     * The underlying memory is most often allocated in by a foregin API.
 401     * Then the underlying memory object is then exported through interfaces
 402     * compatible with EXT_external_resources.
 403     *
 404     * Note: For WINSYS_HANDLE_TYPE_FD handles, the caller retains ownership
 405     * of the fd.
 406     *
 407     * \param handle  A handle representing the memory object to import
 408     */
 409    struct pipe_memory_object *(*memobj_create_from_handle)(struct pipe_screen *screen,
 410                                                            struct winsys_handle *handle,
 411                                                            bool dedicated);
 412
 413    /**
 414     * Destroy a memory object
 415     *
 416     * \param memobj  The memory object to destroy
 417     */
 418    void (*memobj_destroy)(struct pipe_screen *screen,
 419                           struct pipe_memory_object *memobj);
 420
 421    /**
 422     * Create a texture from a memory object
 423     *
 424     * \param t       texture template
 425     * \param memobj  The memory object used to back the texture
 426     */
 427    struct pipe_resource * (*resource_from_memobj)(struct pipe_screen *screen,
 428                                                   const struct pipe_resource *t,
 429                                                   struct pipe_memory_object *memobj,
 430                                                   uint64_t offset);
 431
 432    /**
 433     * Fill @uuid with a unique driver identifier
 434     *
 435     * \param uuid    pointer to a memory region of PIPE_UUID_SIZE bytes
 436     */
 437    void (*get_driver_uuid)(struct pipe_screen *screen, char *uuid);
 438
 439    /**
 440     * Fill @uuid with a unique device identifier
 441     *
 442     * \param uuid    pointer to a memory region of PIPE_UUID_SIZE bytes
 443     */
 444    void (*get_device_uuid)(struct pipe_screen *screen, char *uuid);
 445
 446    /**
 447     * Set the maximum number of parallel shader compiler threads.
 448     */
 449    void (*set_max_shader_compiler_threads)(struct pipe_screen *screen,
 450                                            unsigned max_threads);
 451
 452    /**
 453     * Return whether parallel shader compilation has finished.
 454     */
 455    bool (*is_parallel_shader_compilation_finished)(struct pipe_screen *screen,
 456                                                    void *shader,
 457                                                    unsigned shader_type);
 458 };
 459
 460
 461 /**
 462  * Global configuration options for screen creation.
 463  */
 464 struct pipe_screen_config {
 465    const struct driOptionCache *options;
 466 };
 467
 468
 469 #ifdef __cplusplus
 470 }
 471 #endif
 472
 473 #endif /* P_SCREEN_H */