1/*
2 * Mesa 3-D graphics library
3 *
4 * Copyright (C) 2010 LunarG Inc.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *
24 * Authors:
25 *    Chia-I Wu <olv@lunarg.com>
26 */
27
28#include "main/mtypes.h"
29#include "main/extensions.h"
30#include "main/context.h"
31#include "main/debug_output.h"
32#include "main/glthread.h"
33#include "main/texobj.h"
34#include "main/teximage.h"
35#include "main/texstate.h"
36#include "main/errors.h"
37#include "main/framebuffer.h"
38#include "main/fbobject.h"
39#include "main/renderbuffer.h"
40#include "main/version.h"
41#include "util/hash_table.h"
42#include "st_texture.h"
43
44#include "st_context.h"
45#include "st_debug.h"
46#include "st_extensions.h"
47#include "st_format.h"
48#include "st_cb_bitmap.h"
49#include "st_cb_fbo.h"
50#include "st_cb_flush.h"
51#include "st_manager.h"
52#include "st_sampler_view.h"
53
54#include "state_tracker/st_gl_api.h"
55
56#include "pipe/p_context.h"
57#include "pipe/p_screen.h"
58#include "util/u_format.h"
59#include "util/u_helpers.h"
60#include "util/u_pointer.h"
61#include "util/u_inlines.h"
62#include "util/u_atomic.h"
63#include "util/u_surface.h"
64#include "util/list.h"
65
66struct hash_table;
67struct st_manager_private
68{
69   struct hash_table *stfbi_ht; /* framebuffer iface objects hash table */
70   mtx_t st_mutex;
71};
72
73
74/**
75 * Map an attachment to a buffer index.
76 */
77static inline gl_buffer_index
78attachment_to_buffer_index(enum st_attachment_type statt)
79{
80   gl_buffer_index index;
81
82   switch (statt) {
83   case ST_ATTACHMENT_FRONT_LEFT:
84      index = BUFFER_FRONT_LEFT;
85      break;
86   case ST_ATTACHMENT_BACK_LEFT:
87      index = BUFFER_BACK_LEFT;
88      break;
89   case ST_ATTACHMENT_FRONT_RIGHT:
90      index = BUFFER_FRONT_RIGHT;
91      break;
92   case ST_ATTACHMENT_BACK_RIGHT:
93      index = BUFFER_BACK_RIGHT;
94      break;
95   case ST_ATTACHMENT_DEPTH_STENCIL:
96      index = BUFFER_DEPTH;
97      break;
98   case ST_ATTACHMENT_ACCUM:
99      index = BUFFER_ACCUM;
100      break;
101   case ST_ATTACHMENT_SAMPLE:
102   default:
103      index = BUFFER_COUNT;
104      break;
105   }
106
107   return index;
108}
109
110
111/**
112 * Map a buffer index to an attachment.
113 */
114static inline enum st_attachment_type
115buffer_index_to_attachment(gl_buffer_index index)
116{
117   enum st_attachment_type statt;
118
119   switch (index) {
120   case BUFFER_FRONT_LEFT:
121      statt = ST_ATTACHMENT_FRONT_LEFT;
122      break;
123   case BUFFER_BACK_LEFT:
124      statt = ST_ATTACHMENT_BACK_LEFT;
125      break;
126   case BUFFER_FRONT_RIGHT:
127      statt = ST_ATTACHMENT_FRONT_RIGHT;
128      break;
129   case BUFFER_BACK_RIGHT:
130      statt = ST_ATTACHMENT_BACK_RIGHT;
131      break;
132   case BUFFER_DEPTH:
133      statt = ST_ATTACHMENT_DEPTH_STENCIL;
134      break;
135   case BUFFER_ACCUM:
136      statt = ST_ATTACHMENT_ACCUM;
137      break;
138   default:
139      statt = ST_ATTACHMENT_INVALID;
140      break;
141   }
142
143   return statt;
144}
145
146
147/**
148 * Make sure a context picks up the latest cached state of the
149 * drawables it binds to.
150 */
151static void
152st_context_validate(struct st_context *st,
153                    struct st_framebuffer *stdraw,
154                    struct st_framebuffer *stread)
155{
156    if (stdraw && stdraw->stamp != st->draw_stamp) {
157       st->dirty |= ST_NEW_FRAMEBUFFER;
158       _mesa_resize_framebuffer(st->ctx, &stdraw->Base,
159                                stdraw->Base.Width,
160                                stdraw->Base.Height);
161       st->draw_stamp = stdraw->stamp;
162    }
163
164    if (stread && stread->stamp != st->read_stamp) {
165       if (stread != stdraw) {
166          st->dirty |= ST_NEW_FRAMEBUFFER;
167          _mesa_resize_framebuffer(st->ctx, &stread->Base,
168                                   stread->Base.Width,
169                                   stread->Base.Height);
170       }
171       st->read_stamp = stread->stamp;
172    }
173}
174
175
176void
177st_set_ws_renderbuffer_surface(struct st_renderbuffer *strb,
178                               struct pipe_surface *surf)
179{
180   pipe_surface_reference(&strb->surface_srgb, NULL);
181   pipe_surface_reference(&strb->surface_linear, NULL);
182
183   if (util_format_is_srgb(surf->format))
184      pipe_surface_reference(&strb->surface_srgb, surf);
185   else
186      pipe_surface_reference(&strb->surface_linear, surf);
187
188   strb->surface = surf; /* just assign, don't ref */
189   pipe_resource_reference(&strb->texture, surf->texture);
190
191   strb->Base.Width = surf->width;
192   strb->Base.Height = surf->height;
193}
194
195
196/**
197 * Validate a framebuffer to make sure up-to-date pipe_textures are used.
198 * The context is only used for creating pipe surfaces and for calling
199 * _mesa_resize_framebuffer().
200 * (That should probably be rethought, since those surfaces become
201 * drawable state, not context state, and can be freed by another pipe
202 * context).
203 */
204static void
205st_framebuffer_validate(struct st_framebuffer *stfb,
206                        struct st_context *st)
207{
208   struct pipe_resource *textures[ST_ATTACHMENT_COUNT];
209   uint width, height;
210   unsigned i;
211   boolean changed = FALSE;
212   int32_t new_stamp;
213
214   new_stamp = p_atomic_read(&stfb->iface->stamp);
215   if (stfb->iface_stamp == new_stamp)
216      return;
217
218   memset(textures, 0, stfb->num_statts * sizeof(textures[0]));
219
220   /* validate the fb */
221   do {
222      if (!stfb->iface->validate(&st->iface, stfb->iface, stfb->statts,
223                                 stfb->num_statts, textures))
224         return;
225
226      stfb->iface_stamp = new_stamp;
227      new_stamp = p_atomic_read(&stfb->iface->stamp);
228   } while(stfb->iface_stamp != new_stamp);
229
230   width = stfb->Base.Width;
231   height = stfb->Base.Height;
232
233   for (i = 0; i < stfb->num_statts; i++) {
234      struct st_renderbuffer *strb;
235      struct pipe_surface *ps, surf_tmpl;
236      gl_buffer_index idx;
237
238      if (!textures[i])
239         continue;
240
241      idx = attachment_to_buffer_index(stfb->statts[i]);
242      if (idx >= BUFFER_COUNT) {
243         pipe_resource_reference(&textures[i], NULL);
244         continue;
245      }
246
247      strb = st_renderbuffer(stfb->Base.Attachment[idx].Renderbuffer);
248      assert(strb);
249      if (strb->texture == textures[i]) {
250         pipe_resource_reference(&textures[i], NULL);
251         continue;
252      }
253
254      u_surface_default_template(&surf_tmpl, textures[i]);
255      ps = st->pipe->create_surface(st->pipe, textures[i], &surf_tmpl);
256      if (ps) {
257         st_set_ws_renderbuffer_surface(strb, ps);
258         pipe_surface_reference(&ps, NULL);
259
260         changed = TRUE;
261
262         width = strb->Base.Width;
263         height = strb->Base.Height;
264      }
265
266      pipe_resource_reference(&textures[i], NULL);
267   }
268
269   if (changed) {
270      ++stfb->stamp;
271      _mesa_resize_framebuffer(st->ctx, &stfb->Base, width, height);
272   }
273}
274
275
276/**
277 * Update the attachments to validate by looping the existing renderbuffers.
278 */
279static void
280st_framebuffer_update_attachments(struct st_framebuffer *stfb)
281{
282   gl_buffer_index idx;
283
284   stfb->num_statts = 0;
285   for (idx = 0; idx < BUFFER_COUNT; idx++) {
286      struct st_renderbuffer *strb;
287      enum st_attachment_type statt;
288
289      strb = st_renderbuffer(stfb->Base.Attachment[idx].Renderbuffer);
290      if (!strb || strb->software)
291         continue;
292
293      statt = buffer_index_to_attachment(idx);
294      if (statt != ST_ATTACHMENT_INVALID &&
295          st_visual_have_buffers(stfb->iface->visual, 1 << statt))
296         stfb->statts[stfb->num_statts++] = statt;
297   }
298   stfb->stamp++;
299}
300
301
302/**
303 * Add a renderbuffer to the framebuffer.  The framebuffer is one that
304 * corresponds to a window and is not a user-created FBO.
305 */
306static boolean
307st_framebuffer_add_renderbuffer(struct st_framebuffer *stfb,
308                                gl_buffer_index idx, bool prefer_srgb)
309{
310   struct gl_renderbuffer *rb;
311   enum pipe_format format;
312   boolean sw;
313
314   assert(_mesa_is_winsys_fbo(&stfb->Base));
315
316   /* do not distinguish depth/stencil buffers */
317   if (idx == BUFFER_STENCIL)
318      idx = BUFFER_DEPTH;
319
320   switch (idx) {
321   case BUFFER_DEPTH:
322      format = stfb->iface->visual->depth_stencil_format;
323      sw = FALSE;
324      break;
325   case BUFFER_ACCUM:
326      format = stfb->iface->visual->accum_format;
327      sw = TRUE;
328      break;
329   default:
330      format = stfb->iface->visual->color_format;
331      if (prefer_srgb)
332         format = util_format_srgb(format);
333      sw = FALSE;
334      break;
335   }
336
337   if (format == PIPE_FORMAT_NONE)
338      return FALSE;
339
340   rb = st_new_renderbuffer_fb(format, stfb->iface->visual->samples, sw);
341   if (!rb)
342      return FALSE;
343
344   if (idx != BUFFER_DEPTH) {
345      _mesa_attach_and_own_rb(&stfb->Base, idx, rb);
346      return TRUE;
347   }
348
349   bool rb_ownership_taken = false;
350   if (util_format_get_component_bits(format, UTIL_FORMAT_COLORSPACE_ZS, 0)) {
351      _mesa_attach_and_own_rb(&stfb->Base, BUFFER_DEPTH, rb);
352      rb_ownership_taken = true;
353   }
354
355   if (util_format_get_component_bits(format, UTIL_FORMAT_COLORSPACE_ZS, 1)) {
356      if (rb_ownership_taken)
357         _mesa_attach_and_reference_rb(&stfb->Base, BUFFER_STENCIL, rb);
358      else
359         _mesa_attach_and_own_rb(&stfb->Base, BUFFER_STENCIL, rb);
360   }
361
362   return TRUE;
363}
364
365
366/**
367 * Intialize a struct gl_config from a visual.
368 */
369static void
370st_visual_to_context_mode(const struct st_visual *visual,
371                          struct gl_config *mode)
372{
373   memset(mode, 0, sizeof(*mode));
374
375   if (st_visual_have_buffers(visual, ST_ATTACHMENT_BACK_LEFT_MASK))
376      mode->doubleBufferMode = GL_TRUE;
377
378   if (st_visual_have_buffers(visual,
379            ST_ATTACHMENT_FRONT_RIGHT_MASK | ST_ATTACHMENT_BACK_RIGHT_MASK))
380      mode->stereoMode = GL_TRUE;
381
382   if (visual->color_format != PIPE_FORMAT_NONE) {
383      mode->rgbMode = GL_TRUE;
384
385      mode->redBits =
386         util_format_get_component_bits(visual->color_format,
387               UTIL_FORMAT_COLORSPACE_RGB, 0);
388      mode->greenBits =
389         util_format_get_component_bits(visual->color_format,
390               UTIL_FORMAT_COLORSPACE_RGB, 1);
391      mode->blueBits =
392         util_format_get_component_bits(visual->color_format,
393               UTIL_FORMAT_COLORSPACE_RGB, 2);
394      mode->alphaBits =
395         util_format_get_component_bits(visual->color_format,
396               UTIL_FORMAT_COLORSPACE_RGB, 3);
397
398      mode->rgbBits = mode->redBits +
399         mode->greenBits + mode->blueBits + mode->alphaBits;
400      mode->sRGBCapable = util_format_is_srgb(visual->color_format);
401   }
402
403   if (visual->depth_stencil_format != PIPE_FORMAT_NONE) {
404      mode->depthBits =
405         util_format_get_component_bits(visual->depth_stencil_format,
406               UTIL_FORMAT_COLORSPACE_ZS, 0);
407      mode->stencilBits =
408         util_format_get_component_bits(visual->depth_stencil_format,
409               UTIL_FORMAT_COLORSPACE_ZS, 1);
410
411      mode->haveDepthBuffer = mode->depthBits > 0;
412      mode->haveStencilBuffer = mode->stencilBits > 0;
413   }
414
415   if (visual->accum_format != PIPE_FORMAT_NONE) {
416      mode->haveAccumBuffer = GL_TRUE;
417
418      mode->accumRedBits =
419         util_format_get_component_bits(visual->accum_format,
420               UTIL_FORMAT_COLORSPACE_RGB, 0);
421      mode->accumGreenBits =
422         util_format_get_component_bits(visual->accum_format,
423               UTIL_FORMAT_COLORSPACE_RGB, 1);
424      mode->accumBlueBits =
425         util_format_get_component_bits(visual->accum_format,
426               UTIL_FORMAT_COLORSPACE_RGB, 2);
427      mode->accumAlphaBits =
428         util_format_get_component_bits(visual->accum_format,
429               UTIL_FORMAT_COLORSPACE_RGB, 3);
430   }
431
432   if (visual->samples > 1) {
433      mode->sampleBuffers = 1;
434      mode->samples = visual->samples;
435   }
436}
437
438
439/**
440 * Create a framebuffer from a manager interface.
441 */
442static struct st_framebuffer *
443st_framebuffer_create(struct st_context *st,
444                      struct st_framebuffer_iface *stfbi)
445{
446   struct st_framebuffer *stfb;
447   struct gl_config mode;
448   gl_buffer_index idx;
449   bool prefer_srgb = false;
450
451   if (!stfbi)
452      return NULL;
453
454   stfb = CALLOC_STRUCT(st_framebuffer);
455   if (!stfb)
456      return NULL;
457
458   st_visual_to_context_mode(stfbi->visual, &mode);
459
460   /*
461    * For desktop GL, sRGB framebuffer write is controlled by both the
462    * capability of the framebuffer and GL_FRAMEBUFFER_SRGB.  We should
463    * advertise the capability when the pipe driver (and core Mesa) supports
464    * it so that applications can enable sRGB write when they want to.
465    *
466    * This is not to be confused with GLX_FRAMEBUFFER_SRGB_CAPABLE_ARB.  When
467    * the attribute is GLX_TRUE, it tells the st manager to pick a color
468    * format such that util_format_srgb(visual->color_format) can be supported
469    * by the pipe driver.  We still need to advertise the capability here.
470    *
471    * For GLES, however, sRGB framebuffer write is initially only controlled
472    * by the capability of the framebuffer, with GL_EXT_sRGB_write_control
473    * control is given back to the applications, but GL_FRAMEBUFFER_SRGB is
474    * still enabled by default since this is the behaviour when
475    * EXT_sRGB_write_control is not available. Since GL_EXT_sRGB_write_control
476    * brings GLES on par with desktop GLs EXT_framebuffer_sRGB, in mesa this
477    * is also expressed by using the same extension flag
478    */
479   if (_mesa_has_EXT_framebuffer_sRGB(st->ctx)) {
480      struct pipe_screen *screen = st->pipe->screen;
481      const enum pipe_format srgb_format =
482         util_format_srgb(stfbi->visual->color_format);
483
484      if (srgb_format != PIPE_FORMAT_NONE &&
485          st_pipe_format_to_mesa_format(srgb_format) != MESA_FORMAT_NONE &&
486          screen->is_format_supported(screen, srgb_format,
487                                      PIPE_TEXTURE_2D, stfbi->visual->samples,
488                                      stfbi->visual->samples,
489                                      (PIPE_BIND_DISPLAY_TARGET |
490                                       PIPE_BIND_RENDER_TARGET))) {
491         mode.sRGBCapable = GL_TRUE;
492         /* Since GL_FRAMEBUFFER_SRGB is enabled by default on GLES we must not
493          * create renderbuffers with an sRGB format derived from the
494          * visual->color_format, but we still want sRGB for desktop GL.
495          */
496         prefer_srgb = _mesa_is_desktop_gl(st->ctx);
497      }
498   }
499
500   _mesa_initialize_window_framebuffer(&stfb->Base, &mode);
501
502   stfb->iface = stfbi;
503   stfb->iface_ID = stfbi->ID;
504   stfb->iface_stamp = p_atomic_read(&stfbi->stamp) - 1;
505
506   /* add the color buffer */
507   idx = stfb->Base._ColorDrawBufferIndexes[0];
508   if (!st_framebuffer_add_renderbuffer(stfb, idx, prefer_srgb)) {
509      free(stfb);
510      return NULL;
511   }
512
513   st_framebuffer_add_renderbuffer(stfb, BUFFER_DEPTH, false);
514   st_framebuffer_add_renderbuffer(stfb, BUFFER_ACCUM, false);
515
516   stfb->stamp = 0;
517   st_framebuffer_update_attachments(stfb);
518
519   return stfb;
520}
521
522
523/**
524 * Reference a framebuffer.
525 */
526void
527st_framebuffer_reference(struct st_framebuffer **ptr,
528                         struct st_framebuffer *stfb)
529{
530   struct gl_framebuffer *fb = &stfb->Base;
531   _mesa_reference_framebuffer((struct gl_framebuffer **) ptr, fb);
532}
533
534
535static uint32_t
536st_framebuffer_iface_hash(const void *key)
537{
538   return (uintptr_t)key;
539}
540
541
542static bool
543st_framebuffer_iface_equal(const void *a, const void *b)
544{
545   return (struct st_framebuffer_iface *)a == (struct st_framebuffer_iface *)b;
546}
547
548
549static boolean
550st_framebuffer_iface_lookup(struct st_manager *smapi,
551                            const struct st_framebuffer_iface *stfbi)
552{
553   struct st_manager_private *smPriv =
554      (struct st_manager_private *)smapi->st_manager_private;
555   struct hash_entry *entry;
556
557   assert(smPriv);
558   assert(smPriv->stfbi_ht);
559
560   mtx_lock(&smPriv->st_mutex);
561   entry = _mesa_hash_table_search(smPriv->stfbi_ht, stfbi);
562   mtx_unlock(&smPriv->st_mutex);
563
564   return entry != NULL;
565}
566
567
568static boolean
569st_framebuffer_iface_insert(struct st_manager *smapi,
570                            struct st_framebuffer_iface *stfbi)
571{
572   struct st_manager_private *smPriv =
573      (struct st_manager_private *)smapi->st_manager_private;
574   struct hash_entry *entry;
575
576   assert(smPriv);
577   assert(smPriv->stfbi_ht);
578
579   mtx_lock(&smPriv->st_mutex);
580   entry = _mesa_hash_table_insert(smPriv->stfbi_ht, stfbi, stfbi);
581   mtx_unlock(&smPriv->st_mutex);
582
583   return entry != NULL;
584}
585
586
587static void
588st_framebuffer_iface_remove(struct st_manager *smapi,
589                            struct st_framebuffer_iface *stfbi)
590{
591   struct st_manager_private *smPriv =
592      (struct st_manager_private *)smapi->st_manager_private;
593   struct hash_entry *entry;
594
595   if (!smPriv || !smPriv->stfbi_ht)
596      return;
597
598   mtx_lock(&smPriv->st_mutex);
599   entry = _mesa_hash_table_search(smPriv->stfbi_ht, stfbi);
600   if (!entry)
601      goto unlock;
602
603   _mesa_hash_table_remove(smPriv->stfbi_ht, entry);
604
605unlock:
606   mtx_unlock(&smPriv->st_mutex);
607}
608
609
610/**
611 * The framebuffer interface object is no longer valid.
612 * Remove the object from the framebuffer interface hash table.
613 */
614static void
615st_api_destroy_drawable(struct st_api *stapi,
616                        struct st_framebuffer_iface *stfbi)
617{
618   if (!stfbi)
619      return;
620
621   st_framebuffer_iface_remove(stfbi->state_manager, stfbi);
622}
623
624
625/**
626 * Purge the winsys buffers list to remove any references to
627 * non-existing framebuffer interface objects.
628 */
629static void
630st_framebuffers_purge(struct st_context *st)
631{
632   struct st_context_iface *st_iface = &st->iface;
633   struct st_manager *smapi = st_iface->state_manager;
634   struct st_framebuffer *stfb, *next;
635
636   assert(smapi);
637
638   LIST_FOR_EACH_ENTRY_SAFE_REV(stfb, next, &st->winsys_buffers, head) {
639      struct st_framebuffer_iface *stfbi = stfb->iface;
640
641      assert(stfbi);
642
643      /**
644       * If the corresponding framebuffer interface object no longer exists,
645       * remove the framebuffer object from the context's winsys buffers list,
646       * and unreference the framebuffer object, so its resources can be
647       * deleted.
648       */
649      if (!st_framebuffer_iface_lookup(smapi, stfbi)) {
650         LIST_DEL(&stfb->head);
651         st_framebuffer_reference(&stfb, NULL);
652      }
653   }
654}
655
656
657static void
658st_context_flush(struct st_context_iface *stctxi, unsigned flags,
659                 struct pipe_fence_handle **fence)
660{
661   struct st_context *st = (struct st_context *) stctxi;
662   unsigned pipe_flags = 0;
663
664   if (flags & ST_FLUSH_END_OF_FRAME)
665      pipe_flags |= PIPE_FLUSH_END_OF_FRAME;
666   if (flags & ST_FLUSH_FENCE_FD)
667      pipe_flags |= PIPE_FLUSH_FENCE_FD;
668
669   FLUSH_VERTICES(st->ctx, 0);
670   FLUSH_CURRENT(st->ctx, 0);
671   st_flush(st, fence, pipe_flags);
672
673   if ((flags & ST_FLUSH_WAIT) && fence && *fence) {
674      st->pipe->screen->fence_finish(st->pipe->screen, NULL, *fence,
675                                     PIPE_TIMEOUT_INFINITE);
676      st->pipe->screen->fence_reference(st->pipe->screen, fence, NULL);
677   }
678
679   if (flags & ST_FLUSH_FRONT)
680      st_manager_flush_frontbuffer(st);
681
682   /* DRI3 changes the framebuffer after SwapBuffers, but we need to invoke
683    * st_manager_validate_framebuffers to notice that.
684    *
685    * Set gfx_shaders_may_be_dirty to invoke st_validate_state in the next
686    * draw call, which will invoke st_manager_validate_framebuffers, but it
687    * won't dirty states if there is no change.
688    */
689   if (flags & ST_FLUSH_END_OF_FRAME)
690      st->gfx_shaders_may_be_dirty = true;
691}
692
693static boolean
694st_context_teximage(struct st_context_iface *stctxi,
695                    enum st_texture_type tex_type,
696                    int level, enum pipe_format pipe_format,
697                    struct pipe_resource *tex, boolean mipmap)
698{
699   struct st_context *st = (struct st_context *) stctxi;
700   struct gl_context *ctx = st->ctx;
701   struct gl_texture_object *texObj;
702   struct gl_texture_image *texImage;
703   struct st_texture_object *stObj;
704   struct st_texture_image *stImage;
705   GLenum internalFormat;
706   GLuint width, height, depth;
707   GLenum target;
708
709   switch (tex_type) {
710   case ST_TEXTURE_1D:
711      target = GL_TEXTURE_1D;
712      break;
713   case ST_TEXTURE_2D:
714      target = GL_TEXTURE_2D;
715      break;
716   case ST_TEXTURE_3D:
717      target = GL_TEXTURE_3D;
718      break;
719   case ST_TEXTURE_RECT:
720      target = GL_TEXTURE_RECTANGLE_ARB;
721      break;
722   default:
723      return FALSE;
724   }
725
726   texObj = _mesa_get_current_tex_object(ctx, target);
727
728   _mesa_lock_texture(ctx, texObj);
729
730   stObj = st_texture_object(texObj);
731   /* switch to surface based */
732   if (!stObj->surface_based) {
733      _mesa_clear_texture_object(ctx, texObj, NULL);
734      stObj->surface_based = GL_TRUE;
735   }
736
737   texImage = _mesa_get_tex_image(ctx, texObj, target, level);
738   stImage = st_texture_image(texImage);
739   if (tex) {
740      mesa_format texFormat = st_pipe_format_to_mesa_format(pipe_format);
741
742      if (util_format_has_alpha(tex->format))
743         internalFormat = GL_RGBA;
744      else
745         internalFormat = GL_RGB;
746
747      _mesa_init_teximage_fields(ctx, texImage,
748                                 tex->width0, tex->height0, 1, 0,
749                                 internalFormat, texFormat);
750
751      width = tex->width0;
752      height = tex->height0;
753      depth = tex->depth0;
754
755      /* grow the image size until we hit level = 0 */
756      while (level > 0) {
757         if (width != 1)
758            width <<= 1;
759         if (height != 1)
760            height <<= 1;
761         if (depth != 1)
762            depth <<= 1;
763         level--;
764      }
765   }
766   else {
767      _mesa_clear_texture_image(ctx, texImage);
768      width = height = depth = 0;
769   }
770
771   pipe_resource_reference(&stObj->pt, tex);
772   st_texture_release_all_sampler_views(st, stObj);
773   pipe_resource_reference(&stImage->pt, tex);
774   stObj->surface_format = pipe_format;
775
776   stObj->needs_validation = true;
777
778   _mesa_dirty_texobj(ctx, texObj);
779   _mesa_unlock_texture(ctx, texObj);
780
781   return TRUE;
782}
783
784
785static void
786st_context_copy(struct st_context_iface *stctxi,
787                struct st_context_iface *stsrci, unsigned mask)
788{
789   struct st_context *st = (struct st_context *) stctxi;
790   struct st_context *src = (struct st_context *) stsrci;
791
792   _mesa_copy_context(src->ctx, st->ctx, mask);
793}
794
795
796static boolean
797st_context_share(struct st_context_iface *stctxi,
798                 struct st_context_iface *stsrci)
799{
800   struct st_context *st = (struct st_context *) stctxi;
801   struct st_context *src = (struct st_context *) stsrci;
802
803   return _mesa_share_state(st->ctx, src->ctx);
804}
805
806
807static void
808st_context_destroy(struct st_context_iface *stctxi)
809{
810   struct st_context *st = (struct st_context *) stctxi;
811   st_destroy_context(st);
812}
813
814
815static void
816st_start_thread(struct st_context_iface *stctxi)
817{
818   struct st_context *st = (struct st_context *) stctxi;
819
820   _mesa_glthread_init(st->ctx);
821
822   /* Pin all driver threads to one L3 cache for optimal performance
823    * on AMD Zen. This is only done if glthread is enabled.
824    *
825    * If glthread is disabled, st_draw.c re-pins driver threads regularly
826    * based on the location of the app thread.
827    */
828   struct glthread_state *glthread = st->ctx->GLThread;
829   if (glthread && st->pipe->set_context_param) {
830      util_pin_driver_threads_to_random_L3(st->pipe, &glthread->queue.threads[0]);
831   }
832}
833
834
835static void
836st_thread_finish(struct st_context_iface *stctxi)
837{
838   struct st_context *st = (struct st_context *) stctxi;
839
840   _mesa_glthread_finish(st->ctx);
841}
842
843
844static void
845st_manager_destroy(struct st_manager *smapi)
846{
847   struct st_manager_private *smPriv = smapi->st_manager_private;
848
849   if (smPriv && smPriv->stfbi_ht) {
850      _mesa_hash_table_destroy(smPriv->stfbi_ht, NULL);
851      mtx_destroy(&smPriv->st_mutex);
852      free(smPriv);
853      smapi->st_manager_private = NULL;
854   }
855}
856
857
858static struct st_context_iface *
859st_api_create_context(struct st_api *stapi, struct st_manager *smapi,
860                      const struct st_context_attribs *attribs,
861                      enum st_context_error *error,
862                      struct st_context_iface *shared_stctxi)
863{
864   struct st_context *shared_ctx = (struct st_context *) shared_stctxi;
865   struct st_context *st;
866   struct pipe_context *pipe;
867   struct gl_config* mode_ptr;
868   struct gl_config mode;
869   gl_api api;
870   bool no_error = false;
871   unsigned ctx_flags = PIPE_CONTEXT_PREFER_THREADED;
872
873   if (!(stapi->profile_mask & (1 << attribs->profile)))
874      return NULL;
875
876   switch (attribs->profile) {
877   case ST_PROFILE_DEFAULT:
878      api = API_OPENGL_COMPAT;
879      break;
880   case ST_PROFILE_OPENGL_ES1:
881      api = API_OPENGLES;
882      break;
883   case ST_PROFILE_OPENGL_ES2:
884      api = API_OPENGLES2;
885      break;
886   case ST_PROFILE_OPENGL_CORE:
887      api = API_OPENGL_CORE;
888      break;
889   default:
890      *error = ST_CONTEXT_ERROR_BAD_API;
891      return NULL;
892   }
893
894   /* Create a hash table for the framebuffer interface objects
895    * if it has not been created for this st manager.
896    */
897   if (smapi->st_manager_private == NULL) {
898      struct st_manager_private *smPriv;
899
900      smPriv = CALLOC_STRUCT(st_manager_private);
901      mtx_init(&smPriv->st_mutex, mtx_plain);
902      smPriv->stfbi_ht = _mesa_hash_table_create(NULL,
903                                                 st_framebuffer_iface_hash,
904                                                 st_framebuffer_iface_equal);
905      smapi->st_manager_private = smPriv;
906      smapi->destroy = st_manager_destroy;
907   }
908
909   if (attribs->flags & ST_CONTEXT_FLAG_ROBUST_ACCESS)
910      ctx_flags |= PIPE_CONTEXT_ROBUST_BUFFER_ACCESS;
911
912   if (attribs->flags & ST_CONTEXT_FLAG_NO_ERROR)
913      no_error = true;
914
915   if (attribs->flags & ST_CONTEXT_FLAG_LOW_PRIORITY)
916      ctx_flags |= PIPE_CONTEXT_LOW_PRIORITY;
917   else if (attribs->flags & ST_CONTEXT_FLAG_HIGH_PRIORITY)
918      ctx_flags |= PIPE_CONTEXT_HIGH_PRIORITY;
919
920   if (attribs->flags & ST_CONTEXT_FLAG_RESET_NOTIFICATION_ENABLED)
921      ctx_flags |= PIPE_CONTEXT_LOSE_CONTEXT_ON_RESET;
922
923   pipe = smapi->screen->context_create(smapi->screen, NULL, ctx_flags);
924   if (!pipe) {
925      *error = ST_CONTEXT_ERROR_NO_MEMORY;
926      return NULL;
927   }
928
929   st_visual_to_context_mode(&attribs->visual, &mode);
930
931   if (attribs->visual.no_config)
932      mode_ptr = NULL;
933   else
934      mode_ptr = &mode;
935
936   st = st_create_context(api, pipe, mode_ptr, shared_ctx,
937                          &attribs->options, no_error);
938   if (!st) {
939      *error = ST_CONTEXT_ERROR_NO_MEMORY;
940      pipe->destroy(pipe);
941      return NULL;
942   }
943
944   if (attribs->flags & ST_CONTEXT_FLAG_DEBUG) {
945      if (!_mesa_set_debug_state_int(st->ctx, GL_DEBUG_OUTPUT, GL_TRUE)) {
946         *error = ST_CONTEXT_ERROR_NO_MEMORY;
947         return NULL;
948      }
949
950      st->ctx->Const.ContextFlags |= GL_CONTEXT_FLAG_DEBUG_BIT;
951   }
952
953   if (st->ctx->Const.ContextFlags & GL_CONTEXT_FLAG_DEBUG_BIT) {
954      st_update_debug_callback(st);
955   }
956
957   if (attribs->flags & ST_CONTEXT_FLAG_FORWARD_COMPATIBLE)
958      st->ctx->Const.ContextFlags |= GL_CONTEXT_FLAG_FORWARD_COMPATIBLE_BIT;
959   if (attribs->flags & ST_CONTEXT_FLAG_ROBUST_ACCESS) {
960      st->ctx->Const.ContextFlags |= GL_CONTEXT_FLAG_ROBUST_ACCESS_BIT_ARB;
961      st->ctx->Const.RobustAccess = GL_TRUE;
962   }
963   if (attribs->flags & ST_CONTEXT_FLAG_RESET_NOTIFICATION_ENABLED) {
964      st->ctx->Const.ResetStrategy = GL_LOSE_CONTEXT_ON_RESET_ARB;
965      st_install_device_reset_callback(st);
966   }
967
968   if (attribs->flags & ST_CONTEXT_FLAG_RELEASE_NONE)
969       st->ctx->Const.ContextReleaseBehavior = GL_NONE;
970
971   /* need to perform version check */
972   if (attribs->major > 1 || attribs->minor > 0) {
973      /* Is the actual version less than the requested version?
974       */
975      if (st->ctx->Version < attribs->major * 10U + attribs->minor) {
976         *error = ST_CONTEXT_ERROR_BAD_VERSION;
977         st_destroy_context(st);
978         return NULL;
979      }
980   }
981
982   st->invalidate_on_gl_viewport =
983      smapi->get_param(smapi, ST_MANAGER_BROKEN_INVALIDATE);
984
985   st->iface.destroy = st_context_destroy;
986   st->iface.flush = st_context_flush;
987   st->iface.teximage = st_context_teximage;
988   st->iface.copy = st_context_copy;
989   st->iface.share = st_context_share;
990   st->iface.start_thread = st_start_thread;
991   st->iface.thread_finish = st_thread_finish;
992   st->iface.st_context_private = (void *) smapi;
993   st->iface.cso_context = st->cso_context;
994   st->iface.pipe = st->pipe;
995   st->iface.state_manager = smapi;
996
997   *error = ST_CONTEXT_SUCCESS;
998   return &st->iface;
999}
1000
1001
1002static struct st_context_iface *
1003st_api_get_current(struct st_api *stapi)
1004{
1005   GET_CURRENT_CONTEXT(ctx);
1006   struct st_context *st = ctx ? ctx->st : NULL;
1007
1008   return st ? &st->iface : NULL;
1009}
1010
1011
1012static struct st_framebuffer *
1013st_framebuffer_reuse_or_create(struct st_context *st,
1014                               struct gl_framebuffer *fb,
1015                               struct st_framebuffer_iface *stfbi)
1016{
1017   struct st_framebuffer *cur = NULL, *stfb = NULL;
1018
1019   if (!stfbi)
1020      return NULL;
1021
1022   /* Check if there is already a framebuffer object for the specified
1023    * framebuffer interface in this context. If there is one, use it.
1024    */
1025   LIST_FOR_EACH_ENTRY(cur, &st->winsys_buffers, head) {
1026      if (cur->iface_ID == stfbi->ID) {
1027         st_framebuffer_reference(&stfb, cur);
1028         break;
1029      }
1030   }
1031
1032   /* If there is not already a framebuffer object, create one */
1033   if (stfb == NULL) {
1034      cur = st_framebuffer_create(st, stfbi);
1035
1036      if (cur) {
1037         /* add the referenced framebuffer interface object to
1038          * the framebuffer interface object hash table.
1039          */
1040         if (!st_framebuffer_iface_insert(stfbi->state_manager, stfbi)) {
1041            st_framebuffer_reference(&cur, NULL);
1042            return NULL;
1043         }
1044
1045         /* add to the context's winsys buffers list */
1046         LIST_ADD(&cur->head, &st->winsys_buffers);
1047
1048         st_framebuffer_reference(&stfb, cur);
1049      }
1050   }
1051
1052   return stfb;
1053}
1054
1055
1056static boolean
1057st_api_make_current(struct st_api *stapi, struct st_context_iface *stctxi,
1058                    struct st_framebuffer_iface *stdrawi,
1059                    struct st_framebuffer_iface *streadi)
1060{
1061   struct st_context *st = (struct st_context *) stctxi;
1062   struct st_framebuffer *stdraw, *stread;
1063   boolean ret;
1064
1065   if (st) {
1066      /* reuse or create the draw fb */
1067      stdraw = st_framebuffer_reuse_or_create(st,
1068            st->ctx->WinSysDrawBuffer, stdrawi);
1069      if (streadi != stdrawi) {
1070         /* do the same for the read fb */
1071         stread = st_framebuffer_reuse_or_create(st,
1072               st->ctx->WinSysReadBuffer, streadi);
1073      }
1074      else {
1075         stread = NULL;
1076         /* reuse the draw fb for the read fb */
1077         if (stdraw)
1078            st_framebuffer_reference(&stread, stdraw);
1079      }
1080
1081      if (stdraw && stread) {
1082         st_framebuffer_validate(stdraw, st);
1083         if (stread != stdraw)
1084            st_framebuffer_validate(stread, st);
1085
1086         ret = _mesa_make_current(st->ctx, &stdraw->Base, &stread->Base);
1087
1088         st->draw_stamp = stdraw->stamp - 1;
1089         st->read_stamp = stread->stamp - 1;
1090         st_context_validate(st, stdraw, stread);
1091      }
1092      else {
1093         struct gl_framebuffer *incomplete = _mesa_get_incomplete_framebuffer();
1094         ret = _mesa_make_current(st->ctx, incomplete, incomplete);
1095      }
1096
1097      st_framebuffer_reference(&stdraw, NULL);
1098      st_framebuffer_reference(&stread, NULL);
1099
1100      /* Purge the context's winsys_buffers list in case any
1101       * of the referenced drawables no longer exist.
1102       */
1103      st_framebuffers_purge(st);
1104   }
1105   else {
1106      GET_CURRENT_CONTEXT(ctx);
1107
1108      if (ctx) {
1109         /* Before releasing the context, release its associated
1110          * winsys buffers first. Then purge the context's winsys buffers list
1111          * to free the resources of any winsys buffers that no longer have
1112          * an existing drawable.
1113          */
1114         ret = _mesa_make_current(ctx, NULL, NULL);
1115         st_framebuffers_purge(ctx->st);
1116      }
1117
1118      ret = _mesa_make_current(NULL, NULL, NULL);
1119   }
1120
1121   return ret;
1122}
1123
1124
1125static void
1126st_api_destroy(struct st_api *stapi)
1127{
1128}
1129
1130
1131/**
1132 * Flush the front buffer if the current context renders to the front buffer.
1133 */
1134void
1135st_manager_flush_frontbuffer(struct st_context *st)
1136{
1137   struct st_framebuffer *stfb = st_ws_framebuffer(st->ctx->DrawBuffer);
1138   struct st_renderbuffer *strb = NULL;
1139
1140   if (!stfb)
1141      return;
1142
1143   /* If the context uses a doublebuffered visual, but the buffer is
1144    * single-buffered, guess that it's a pbuffer, which doesn't need
1145    * flushing.
1146    */
1147   if (st->ctx->Visual.doubleBufferMode &&
1148       !stfb->Base.Visual.doubleBufferMode)
1149      return;
1150
1151   strb = st_renderbuffer(stfb->Base.Attachment[BUFFER_FRONT_LEFT].
1152                          Renderbuffer);
1153
1154   /* Do we have a front color buffer and has it been drawn to since last
1155    * frontbuffer flush?
1156    */
1157   if (strb && strb->defined) {
1158      stfb->iface->flush_front(&st->iface, stfb->iface,
1159                               ST_ATTACHMENT_FRONT_LEFT);
1160      strb->defined = GL_FALSE;
1161
1162      /* Trigger an update of strb->defined on next draw */
1163      st->dirty |= ST_NEW_FB_STATE;
1164   }
1165}
1166
1167
1168/**
1169 * Re-validate the framebuffers.
1170 */
1171void
1172st_manager_validate_framebuffers(struct st_context *st)
1173{
1174   struct st_framebuffer *stdraw = st_ws_framebuffer(st->ctx->DrawBuffer);
1175   struct st_framebuffer *stread = st_ws_framebuffer(st->ctx->ReadBuffer);
1176
1177   if (stdraw)
1178      st_framebuffer_validate(stdraw, st);
1179   if (stread && stread != stdraw)
1180      st_framebuffer_validate(stread, st);
1181
1182   st_context_validate(st, stdraw, stread);
1183}
1184
1185
1186/**
1187 * Flush any outstanding swapbuffers on the current draw framebuffer.
1188 */
1189void
1190st_manager_flush_swapbuffers(void)
1191{
1192   GET_CURRENT_CONTEXT(ctx);
1193   struct st_context *st = (ctx) ? ctx->st : NULL;
1194   struct st_framebuffer *stfb;
1195
1196   if (!st)
1197      return;
1198
1199   stfb = st_ws_framebuffer(ctx->DrawBuffer);
1200   if (!stfb || !stfb->iface->flush_swapbuffers)
1201      return;
1202
1203   stfb->iface->flush_swapbuffers(&st->iface, stfb->iface);
1204}
1205
1206
1207/**
1208 * Add a color renderbuffer on demand.  The FBO must correspond to a window,
1209 * not a user-created FBO.
1210 */
1211boolean
1212st_manager_add_color_renderbuffer(struct st_context *st,
1213                                  struct gl_framebuffer *fb,
1214                                  gl_buffer_index idx)
1215{
1216   struct st_framebuffer *stfb = st_ws_framebuffer(fb);
1217
1218   /* FBO */
1219   if (!stfb)
1220      return FALSE;
1221
1222   assert(_mesa_is_winsys_fbo(fb));
1223
1224   if (stfb->Base.Attachment[idx].Renderbuffer)
1225      return TRUE;
1226
1227   switch (idx) {
1228   case BUFFER_FRONT_LEFT:
1229   case BUFFER_BACK_LEFT:
1230   case BUFFER_FRONT_RIGHT:
1231   case BUFFER_BACK_RIGHT:
1232      break;
1233   default:
1234      return FALSE;
1235   }
1236
1237   if (!st_framebuffer_add_renderbuffer(stfb, idx,
1238                                        stfb->Base.Visual.sRGBCapable))
1239      return FALSE;
1240
1241   st_framebuffer_update_attachments(stfb);
1242
1243   /*
1244    * Force a call to the state tracker manager to validate the
1245    * new renderbuffer. It might be that there is a window system
1246    * renderbuffer available.
1247    */
1248   if (stfb->iface)
1249      stfb->iface_stamp = p_atomic_read(&stfb->iface->stamp) - 1;
1250
1251   st_invalidate_buffers(st);
1252
1253   return TRUE;
1254}
1255
1256
1257static unsigned
1258get_version(struct pipe_screen *screen,
1259            struct st_config_options *options, gl_api api)
1260{
1261   struct gl_constants consts = {0};
1262   struct gl_extensions extensions = {0};
1263   GLuint version;
1264
1265   if (_mesa_override_gl_version_contextless(&consts, &api, &version)) {
1266      return version;
1267   }
1268
1269   _mesa_init_constants(&consts, api);
1270   _mesa_init_extensions(&extensions);
1271
1272   st_init_limits(screen, &consts, &extensions);
1273   st_init_extensions(screen, &consts, &extensions, options, api);
1274
1275   return _mesa_get_version(&extensions, &consts, api);
1276}
1277
1278
1279static void
1280st_api_query_versions(struct st_api *stapi, struct st_manager *sm,
1281                      struct st_config_options *options,
1282                      int *gl_core_version,
1283                      int *gl_compat_version,
1284                      int *gl_es1_version,
1285                      int *gl_es2_version)
1286{
1287   *gl_core_version = get_version(sm->screen, options, API_OPENGL_CORE);
1288   *gl_compat_version = get_version(sm->screen, options, API_OPENGL_COMPAT);
1289   *gl_es1_version = get_version(sm->screen, options, API_OPENGLES);
1290   *gl_es2_version = get_version(sm->screen, options, API_OPENGLES2);
1291}
1292
1293
1294static const struct st_api st_gl_api = {
1295   .name = "Mesa " PACKAGE_VERSION,
1296   .api = ST_API_OPENGL,
1297   .profile_mask = ST_PROFILE_DEFAULT_MASK |
1298                   ST_PROFILE_OPENGL_CORE_MASK |
1299                   ST_PROFILE_OPENGL_ES1_MASK |
1300                   ST_PROFILE_OPENGL_ES2_MASK |
1301                   0,
1302   .feature_mask = ST_API_FEATURE_MS_VISUALS_MASK,
1303   .destroy = st_api_destroy,
1304   .query_versions = st_api_query_versions,
1305   .create_context = st_api_create_context,
1306   .make_current = st_api_make_current,
1307   .get_current = st_api_get_current,
1308   .destroy_drawable = st_api_destroy_drawable,
1309};
1310
1311
1312struct st_api *
1313st_gl_api_create(void)
1314{
1315   return (struct st_api *) &st_gl_api;
1316}
1317