src/mesa/state_tracker/st_context.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2003 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 #ifndef ST_CONTEXT_H
  29 #define ST_CONTEXT_H
  30
  31 #include "main/arrayobj.h"
  32 #include "main/mtypes.h"
  33 #include "state_tracker/st_api.h"
  34 #include "main/fbobject.h"
  35 #include "state_tracker/st_atom.h"
  36 #include "util/u_helpers.h"
  37 #include "util/u_inlines.h"
  38 #include "util/list.h"
  39 #include "vbo/vbo.h"
  40 #include "util/list.h"
  41
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47
  48 struct dd_function_table;
  49 struct draw_context;
  50 struct draw_stage;
  51 struct gen_mipmap_state;
  52 struct st_context;
  53 struct st_program;
  54 struct st_perf_monitor_group;
  55 struct u_upload_mgr;
  56
  57
  58 struct st_bitmap_cache
  59 {
  60    /** Window pos to render the cached image */
  61    GLint xpos, ypos;
  62    /** Bounds of region used in window coords */
  63    GLint xmin, ymin, xmax, ymax;
  64
  65    GLfloat color[4];
  66
  67    /** Bitmap's Z position */
  68    GLfloat zpos;
  69
  70    struct pipe_resource *texture;
  71    struct pipe_transfer *trans;
  72
  73    GLboolean empty;
  74
  75    /** An I8 texture image: */
  76    ubyte *buffer;
  77 };
  78
  79 struct st_bound_handles
  80 {
  81    unsigned num_handles;
  82    uint64_t *handles;
  83 };
  84
  85
  86 #define NUM_DRAWPIX_CACHE_ENTRIES 4
  87
  88 struct drawpix_cache_entry
  89 {
  90    GLsizei width, height;
  91    GLenum format, type;
  92    const void *user_pointer;  /**< Last user 'pixels' pointer */
  93    void *image;               /**< Copy of the glDrawPixels image data */
  94    struct pipe_resource *texture;
  95    unsigned age;
  96 };
  97
  98
  99 /*
 100  * Node for a linked list of dead sampler views.
 101  */
 102 struct st_zombie_sampler_view_node
 103 {
 104    struct pipe_sampler_view *view;
 105    struct list_head node;
 106 };
 107
 108
 109 /*
 110  * Node for a linked list of dead shaders.
 111  */
 112 struct st_zombie_shader_node
 113 {
 114    void *shader;
 115    enum pipe_shader_type type;
 116    struct list_head node;
 117 };
 118
 119
 120 struct st_context
 121 {
 122    struct st_context_iface iface;
 123
 124    struct gl_context *ctx;
 125
 126    struct pipe_context *pipe;
 127
 128    struct draw_context *draw;  /**< For selection/feedback/rastpos only */
 129    struct draw_stage *feedback_stage;  /**< For GL_FEEDBACK rendermode */
 130    struct draw_stage *selection_stage;  /**< For GL_SELECT rendermode */
 131    struct draw_stage *rastpos_stage;  /**< For glRasterPos */
 132    GLboolean clamp_frag_color_in_shader;
 133    GLboolean clamp_vert_color_in_shader;
 134    boolean clamp_frag_depth_in_shader;
 135    boolean has_stencil_export; /**< can do shader stencil export? */
 136    boolean has_time_elapsed;
 137    boolean has_etc1;
 138    boolean has_etc2;
 139    boolean has_astc_2d_ldr;
 140    boolean has_astc_5x5_ldr;
 141    boolean prefer_blit_based_texture_transfer;
 142    boolean force_persample_in_shader;
 143    boolean has_shareable_shaders;
 144    boolean has_half_float_packing;
 145    boolean has_multi_draw_indirect;
 146    boolean has_single_pipe_stat;
 147    boolean has_indep_blend_func;
 148    boolean needs_rgb_dst_alpha_override;
 149    boolean can_bind_const_buffer_as_vertex;
 150    boolean lower_flatshade;
 151    boolean lower_alpha_test;
 152    boolean lower_point_size;
 153    boolean lower_two_sided_color;
 154    boolean lower_ucp;
 155
 156    /* There are consequences for drivers wanting to call st_finalize_nir
 157     * twice, once before shader caching and once after lowering for shader
 158     * variants. If shader variants use lowering passes that are not ready
 159     * for that, things can blow up.
 160     *
 161     * If this is true, st_finalize_nir and pipe_screen::finalize_nir will be
 162     * called before the result is stored in the shader cache. If lowering for
 163     * shader variants is invoked, the functions will be called again.
 164     */
 165    boolean allow_st_finalize_nir_twice;
 166
 167    /**
 168     * If a shader can be created when we get its source.
 169     * This means it has only 1 variant, not counting glBitmap and
 170     * glDrawPixels.
 171     */
 172    boolean shader_has_one_variant[MESA_SHADER_STAGES];
 173
 174    boolean needs_texcoord_semantic;
 175    boolean apply_texture_swizzle_to_border_color;
 176
 177    /* On old libGL's for linux we need to invalidate the drawables
 178     * on glViewpport calls, this is set via a option.
 179     */
 180    boolean invalidate_on_gl_viewport;
 181    boolean draw_needs_minmax_index;
 182    boolean has_hw_atomics;
 183
 184    /* Some state is contained in constant objects.
 185     * Other state is just parameter values.
 186     */
 187    struct {
 188       struct pipe_blend_state               blend;
 189       struct pipe_depth_stencil_alpha_state depth_stencil;
 190       struct pipe_rasterizer_state          rasterizer;
 191       struct pipe_sampler_state vert_samplers[PIPE_MAX_SAMPLERS];
 192       struct pipe_sampler_state frag_samplers[PIPE_MAX_SAMPLERS];
 193       GLuint num_vert_samplers;
 194       GLuint num_frag_samplers;
 195       struct pipe_sampler_view *vert_sampler_views[PIPE_MAX_SAMPLERS];
 196       struct pipe_sampler_view *frag_sampler_views[PIPE_MAX_SAMPLERS];
 197       GLuint num_sampler_views[PIPE_SHADER_TYPES];
 198       struct pipe_clip_state clip;
 199       struct {
 200          void *ptr;
 201          unsigned size;
 202       } constants[PIPE_SHADER_TYPES];
 203       unsigned fb_width;
 204       unsigned fb_height;
 205       unsigned fb_num_samples;
 206       unsigned fb_num_layers;
 207       unsigned fb_num_cb;
 208       unsigned num_viewports;
 209       struct pipe_scissor_state scissor[PIPE_MAX_VIEWPORTS];
 210       struct pipe_viewport_state viewport[PIPE_MAX_VIEWPORTS];
 211       struct {
 212          unsigned num;
 213          boolean include;
 214          struct pipe_scissor_state rects[PIPE_MAX_WINDOW_RECTANGLES];
 215       } window_rects;
 216
 217       GLuint poly_stipple[32];  /**< In OpenGL's bottom-to-top order */
 218
 219       GLuint fb_orientation;
 220
 221       bool enable_sample_locations;
 222       unsigned sample_locations_samples;
 223       uint8_t sample_locations[
 224          PIPE_MAX_SAMPLE_LOCATION_GRID_SIZE *
 225          PIPE_MAX_SAMPLE_LOCATION_GRID_SIZE * 32];
 226    } state;
 227
 228    uint64_t dirty; /**< dirty states */
 229
 230    /** This masks out unused shader resources. Only valid in draw calls. */
 231    uint64_t active_states;
 232
 233    unsigned pin_thread_counter; /* for L3 thread pinning on AMD Zen */
 234
 235    /* If true, further analysis of states is required to know if something
 236     * has changed. Used mainly for shaders.
 237     */
 238    bool gfx_shaders_may_be_dirty;
 239    bool compute_shader_may_be_dirty;
 240
 241    GLboolean vertdata_edgeflags;
 242    GLboolean edgeflag_culls_prims;
 243
 244    /**
 245     * The number of currently active queries (excluding timer queries).
 246     * This is used to know if we need to pause any queries for meta ops.
 247     */
 248    unsigned active_queries;
 249
 250    union {
 251       struct {
 252          struct st_program *vp;    /**< Currently bound vertex program */
 253          struct st_program *tcp; /**< Currently bound tess control program */
 254          struct st_program *tep; /**< Currently bound tess eval program */
 255          struct st_program *gp;  /**< Currently bound geometry program */
 256          struct st_program *fp;  /**< Currently bound fragment program */
 257          struct st_program *cp;   /**< Currently bound compute program */
 258       };
 259       struct gl_program *current_program[MESA_SHADER_STAGES];
 260    };
 261
 262    struct st_common_variant *vp_variant;
 263
 264    struct {
 265       struct pipe_resource *pixelmap_texture;
 266       struct pipe_sampler_view *pixelmap_sampler_view;
 267    } pixel_xfer;
 268
 269    /** for glBitmap */
 270    struct {
 271       struct pipe_rasterizer_state rasterizer;
 272       struct pipe_sampler_state sampler;
 273       struct pipe_sampler_state atlas_sampler;
 274       enum pipe_format tex_format;
 275       struct st_bitmap_cache cache;
 276    } bitmap;
 277
 278    /** for glDraw/CopyPixels */
 279    struct {
 280       void *zs_shaders[4];
 281    } drawpix;
 282
 283    /** Cache of glDrawPixels images */
 284    struct {
 285       struct drawpix_cache_entry entries[NUM_DRAWPIX_CACHE_ENTRIES];
 286       unsigned age;
 287    } drawpix_cache;
 288
 289    /** for glReadPixels */
 290    struct {
 291       struct pipe_resource *src;
 292       struct pipe_resource *cache;
 293       enum pipe_format dst_format;
 294       unsigned level;
 295       unsigned layer;
 296       unsigned hits;
 297    } readpix_cache;
 298
 299    /** for glClear */
 300    struct {
 301       struct pipe_rasterizer_state raster;
 302       struct pipe_viewport_state viewport;
 303       void *vs;
 304       void *fs;
 305       void *vs_layered;
 306       void *gs_layered;
 307    } clear;
 308
 309    /* For gl(Compressed)Tex(Sub)Image */
 310    struct {
 311       struct pipe_rasterizer_state raster;
 312       struct pipe_blend_state upload_blend;
 313       void *vs;
 314       void *gs;
 315       void *upload_fs[3];
 316       void *download_fs[3][PIPE_MAX_TEXTURE_TYPES];
 317       bool upload_enabled;
 318       bool download_enabled;
 319       bool rgba_only;
 320       bool layers;
 321       bool use_gs;
 322    } pbo;
 323
 324    /** for drawing with st_util_vertex */
 325    struct pipe_vertex_element util_velems[3];
 326
 327    /** passthrough vertex shader matching the util_velem attributes */
 328    void *passthrough_vs;
 329
 330    enum pipe_texture_target internal_target;
 331
 332    struct cso_context *cso_context;
 333
 334    void *winsys_drawable_handle;
 335
 336    /* The number of vertex buffers from the last call of validate_arrays. */
 337    unsigned last_num_vbuffers;
 338
 339    unsigned last_used_atomic_bindings[PIPE_SHADER_TYPES];
 340    unsigned last_num_ssbos[PIPE_SHADER_TYPES];
 341
 342    int32_t draw_stamp;
 343    int32_t read_stamp;
 344
 345    struct st_config_options options;
 346
 347    struct st_perf_monitor_group *perfmon;
 348
 349    enum pipe_reset_status reset_status;
 350
 351    /* Array of bound texture/image handles which are resident in the context.
 352     */
 353    struct st_bound_handles bound_texture_handles[PIPE_SHADER_TYPES];
 354    struct st_bound_handles bound_image_handles[PIPE_SHADER_TYPES];
 355
 356    /* Winsys buffers */
 357    struct list_head winsys_buffers;
 358
 359    /* Throttling for texture uploads and similar operations to limit memory
 360     * usage by limiting the number of in-flight operations based on
 361     * the estimated allocated size needed to execute those operations.
 362     */
 363    struct util_throttle throttle;
 364
 365    struct {
 366       struct st_zombie_sampler_view_node list;
 367       simple_mtx_t mutex;
 368    } zombie_sampler_views;
 369
 370    struct {
 371       struct st_zombie_shader_node list;
 372       simple_mtx_t mutex;
 373    } zombie_shaders;
 374
 375 };
 376
 377
 378 /*
 379  * Get the state tracker context for the given Mesa context.
 380  */
 381 static inline struct st_context *
 382 st_context(struct gl_context *ctx)
 383 {
 384    return ctx->st;
 385 }
 386
 387
 388 extern struct st_context *
 389 st_create_context(gl_api api, struct pipe_context *pipe,
 390                   const struct gl_config *visual,
 391                   struct st_context *share,
 392                   const struct st_config_options *options,
 393                   bool no_error);
 394
 395 extern void
 396 st_destroy_context(struct st_context *st);
 397
 398
 399 extern void
 400 st_invalidate_buffers(struct st_context *st);
 401
 402
 403 extern void
 404 st_save_zombie_sampler_view(struct st_context *st,
 405                             struct pipe_sampler_view *view);
 406
 407 extern void
 408 st_save_zombie_shader(struct st_context *st,
 409                       enum pipe_shader_type type,
 410                       struct pipe_shader_state *shader);
 411
 412
 413 void
 414 st_context_free_zombie_objects(struct st_context *st);
 415
 416
 417
 418 /**
 419  * Wrapper for struct gl_framebuffer.
 420  * This is an opaque type to the outside world.
 421  */
 422 struct st_framebuffer
 423 {
 424    struct gl_framebuffer Base;
 425
 426    struct st_framebuffer_iface *iface;
 427    enum st_attachment_type statts[ST_ATTACHMENT_COUNT];
 428    unsigned num_statts;
 429    int32_t stamp;
 430    int32_t iface_stamp;
 431    uint32_t iface_ID;
 432
 433    /* list of framebuffer objects */
 434    struct list_head head;
 435 };
 436
 437
 438 #ifdef __cplusplus
 439 }
 440 #endif
 441
 442 #endif