1 /**********************************************************
2 * Copyright 2010 VMware, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person
5 * obtaining a copy of this software and associated documentation
6 * files (the "Software"), to deal in the Software without
7 * restriction, including without limitation the rights to use, copy,
8 * modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be
13 * included in all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
19 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 *
24 **********************************************************/
25
26
27 #ifndef _API_H_
28 #define _API_H_
29
30 #include "pipe/p_format.h"
31
32 /**
33 * \file API for communication between gallium frontends and supporting
34 * frontends such as DRI.
35 *
36 * This file defines an API to be implemented by both gallium frontends and
37 * their managers.
38 */
39
40 /**
41 * The supported rendering API.
42 */
43 enum st_api_type {
44 ST_API_OPENGL,
45 ST_API_OPENVG,
46
47 ST_API_COUNT
48 };
49
50 /**
51 * The profile of a context.
52 */
53 enum st_profile_type
54 {
55 ST_PROFILE_DEFAULT, /**< OpenGL compatibility profile */
56 ST_PROFILE_OPENGL_CORE, /**< OpenGL 3.2+ core profile */
57 ST_PROFILE_OPENGL_ES1, /**< OpenGL ES 1.x */
58 ST_PROFILE_OPENGL_ES2 /**< OpenGL ES 2.0 */
59 };
60
61 /* for profile_mask in st_api */
62 #define ST_PROFILE_DEFAULT_MASK (1 << ST_PROFILE_DEFAULT)
63 #define ST_PROFILE_OPENGL_CORE_MASK (1 << ST_PROFILE_OPENGL_CORE)
64 #define ST_PROFILE_OPENGL_ES1_MASK (1 << ST_PROFILE_OPENGL_ES1)
65 #define ST_PROFILE_OPENGL_ES2_MASK (1 << ST_PROFILE_OPENGL_ES2)
66
67 /**
68 * Optional API features.
69 */
70 enum st_api_feature
71 {
72 ST_API_FEATURE_MS_VISUALS /**< support for multisample visuals */
73 };
74
75 /* for feature_mask in st_api */
76 #define ST_API_FEATURE_MS_VISUALS_MASK (1 << ST_API_FEATURE_MS_VISUALS)
77
78 /**
79 * New context flags for GL 3.0 and beyond.
80 *
81 * Profile information (core vs. compatibilty for OpenGL 3.2+) is communicated
82 * through the \c st_profile_type, not through flags.
83 */
84 #define ST_CONTEXT_FLAG_DEBUG (1 << 0)
85 #define ST_CONTEXT_FLAG_FORWARD_COMPATIBLE (1 << 1)
86 #define ST_CONTEXT_FLAG_ROBUST_ACCESS (1 << 2)
87 #define ST_CONTEXT_FLAG_RESET_NOTIFICATION_ENABLED (1 << 3)
88 #define ST_CONTEXT_FLAG_NO_ERROR (1 << 4)
89 #define ST_CONTEXT_FLAG_RELEASE_NONE (1 << 5)
90 #define ST_CONTEXT_FLAG_HIGH_PRIORITY (1 << 6)
91 #define ST_CONTEXT_FLAG_LOW_PRIORITY (1 << 7)
92
93 /**
94 * Reasons that context creation might fail.
95 */
96 enum st_context_error {
97 ST_CONTEXT_SUCCESS = 0,
98 ST_CONTEXT_ERROR_NO_MEMORY,
99 ST_CONTEXT_ERROR_BAD_API,
100 ST_CONTEXT_ERROR_BAD_VERSION,
101 ST_CONTEXT_ERROR_BAD_FLAG,
102 ST_CONTEXT_ERROR_UNKNOWN_ATTRIBUTE,
103 ST_CONTEXT_ERROR_UNKNOWN_FLAG
104 };
105
106 /**
107 * Used in st_context_iface->teximage.
108 */
109 enum st_texture_type {
110 ST_TEXTURE_1D,
111 ST_TEXTURE_2D,
112 ST_TEXTURE_3D,
113 ST_TEXTURE_RECT
114 };
115
116 /**
117 * Available attachments of framebuffer.
118 */
119 enum st_attachment_type {
120 ST_ATTACHMENT_FRONT_LEFT,
121 ST_ATTACHMENT_BACK_LEFT,
122 ST_ATTACHMENT_FRONT_RIGHT,
123 ST_ATTACHMENT_BACK_RIGHT,
124 ST_ATTACHMENT_DEPTH_STENCIL,
125 ST_ATTACHMENT_ACCUM,
126
127 ST_ATTACHMENT_COUNT,
128 ST_ATTACHMENT_INVALID = -1
129 };
130
131 /* for buffer_mask in st_visual */
132 #define ST_ATTACHMENT_FRONT_LEFT_MASK (1 << ST_ATTACHMENT_FRONT_LEFT)
133 #define ST_ATTACHMENT_BACK_LEFT_MASK (1 << ST_ATTACHMENT_BACK_LEFT)
134 #define ST_ATTACHMENT_FRONT_RIGHT_MASK (1 << ST_ATTACHMENT_FRONT_RIGHT)
135 #define ST_ATTACHMENT_BACK_RIGHT_MASK (1 << ST_ATTACHMENT_BACK_RIGHT)
136 #define ST_ATTACHMENT_DEPTH_STENCIL_MASK (1 << ST_ATTACHMENT_DEPTH_STENCIL)
137 #define ST_ATTACHMENT_ACCUM_MASK (1 << ST_ATTACHMENT_ACCUM)
138
139 /**
140 * Flush flags.
141 */
142 #define ST_FLUSH_FRONT (1 << 0)
143 #define ST_FLUSH_END_OF_FRAME (1 << 1)
144 #define ST_FLUSH_WAIT (1 << 2)
145 #define ST_FLUSH_FENCE_FD (1 << 3)
146
147 /**
148 * State invalidation flags to notify frontends that states have been changed
149 * behind their back.
150 */
151 #define ST_INVALIDATE_FS_SAMPLER_VIEWS (1 << 0)
152 #define ST_INVALIDATE_FS_CONSTBUF0 (1 << 1)
153 #define ST_INVALIDATE_VS_CONSTBUF0 (1 << 2)
154 #define ST_INVALIDATE_VERTEX_BUFFERS (1 << 3)
155
156 /**
157 * Value to st_manager->get_param function.
158 */
159 enum st_manager_param {
160 /**
161 * The DRI frontend on old libGL's doesn't do the right thing
162 * with regards to invalidating the framebuffers.
163 *
164 * For the GL gallium frontend that means that it needs to invalidate
165 * the framebuffer in glViewport itself.
166 */
167 ST_MANAGER_BROKEN_INVALIDATE
168 };
169
170 struct pipe_context;
171 struct pipe_resource;
172 struct pipe_fence_handle;
173 struct util_queue_monitoring;
174
175 /**
176 * Used in st_manager_iface->get_egl_image.
177 */
178 struct st_egl_image
179 {
180 /* this is owned by the caller */
181 struct pipe_resource *texture;
182
183 /* format only differs from texture->format for multi-planar (YUV): */
184 enum pipe_format format;
185
186 unsigned level;
187 unsigned layer;
188 /* GL internal format. */
189 unsigned internalformat;
190 };
191
192 /**
193 * Represent the visual of a framebuffer.
194 */
195 struct st_visual
196 {
197 /**
198 * Available buffers. Bitfield of ST_ATTACHMENT_*_MASK bits.
199 */
200 unsigned buffer_mask;
201
202 /**
203 * Buffer formats. The formats are always set even when the buffer is
204 * not available.
205 */
206 enum pipe_format color_format;
207 enum pipe_format depth_stencil_format;
208 enum pipe_format accum_format;
209 unsigned samples;
210 };
211
212
213 /**
214 * Configuration options from driconf
215 */
216 struct st_config_options
217 {
218 bool disable_blend_func_extended;
219 bool disable_glsl_line_continuations;
220 bool disable_arb_gpu_shader5;
221 bool force_compat_shaders;
222 bool force_glsl_extensions_warn;
223 unsigned force_glsl_version;
224 bool allow_extra_pp_tokens;
225 bool allow_glsl_extension_directive_midshader;
226 bool allow_glsl_120_subset_in_110;
227 bool allow_glsl_builtin_const_expression;
228 bool allow_glsl_relaxed_es;
229 bool allow_glsl_builtin_variable_redeclaration;
230 bool allow_higher_compat_version;
231 bool allow_glsl_compat_shaders;
232 bool glsl_ignore_write_to_readonly_var;
233 bool glsl_zero_init;
234 bool vs_position_always_invariant;
235 bool vs_position_always_precise;
236 bool force_glsl_abs_sqrt;
237 bool allow_glsl_cross_stage_interpolation_mismatch;
238 bool do_dce_before_clip_cull_analysis;
239 bool allow_draw_out_of_order;
240 bool glthread_nop_check_framebuffer_status;
241 bool ignore_map_unsynchronized;
242 bool force_integer_tex_nearest;
243 bool force_gl_names_reuse;
244 bool transcode_etc;
245 bool transcode_astc;
246 char *force_gl_vendor;
247 char *force_gl_renderer;
248 char *mesa_extension_override;
249 unsigned char config_options_sha1[20];
250 };
251
252 /**
253 * Represent the attributes of a context.
254 */
255 struct st_context_attribs
256 {
257 /**
258 * The profile and minimal version to support.
259 *
260 * The valid profiles and versions are rendering API dependent. The latest
261 * version satisfying the request should be returned.
262 */
263 enum st_profile_type profile;
264 int major, minor;
265
266 /** Mask of ST_CONTEXT_FLAG_x bits */
267 unsigned flags;
268
269 /**
270 * The visual of the framebuffers the context will be bound to.
271 */
272 struct st_visual visual;
273
274 /**
275 * Configuration options.
276 */
277 struct st_config_options options;
278 };
279
280 struct st_context_iface;
281 struct st_manager;
282
283 /**
284 * Represent a windowing system drawable.
285 *
286 * The framebuffer is implemented by the frontend manager and
287 * used by gallium frontends.
288 *
289 * Instead of the winsys poking into the frontend context to figure
290 * out what buffers that might be needed in the future by the frontend
291 * context, it calls into the framebuffer to get the textures.
292 *
293 * This structure along with the notify_invalid_framebuffer
294 * allows framebuffers to be shared between different threads
295 * but at the same make the API context free from thread
296 * synchronization primitves, with the exception of a small
297 * atomic flag used for notification of framebuffer dirty status.
298 *
299 * The thread synchronization is put inside the framebuffer
300 * and only called once the framebuffer has become dirty.
301 */
302 struct st_framebuffer_iface
303 {
304 /**
305 * Atomic stamp which changes when framebuffers need to be updated.
306 */
307 int32_t stamp;
308
309 /**
310 * Identifier that uniquely identifies the framebuffer interface object.
311 */
312 uint32_t ID;
313
314 /**
315 * The frontend manager that manages this object.
316 */
317 struct st_manager *state_manager;
318
319 /**
320 * Available for the frontend manager to use.
321 */
322 void *st_manager_private;
323
324 /**
325 * The visual of a framebuffer.
326 */
327 const struct st_visual *visual;
328
329 /**
330 * Flush the front buffer.
331 *
332 * On some window systems, changes to the front buffers are not immediately
333 * visible. They need to be flushed.
334 *
335 * @att is one of the front buffer attachments.
336 */
337 bool (*flush_front)(struct st_context_iface *stctx,
338 struct st_framebuffer_iface *stfbi,
339 enum st_attachment_type statt);
340
341 /**
342 * the gallium frontend asks for the textures it needs.
343 *
344 * It should try to only ask for attachments that it currently renders
345 * to, thus allowing the winsys to delay the allocation of textures not
346 * needed. For example front buffer attachments are not needed if you
347 * only do back buffer rendering.
348 *
349 * The implementor of this function needs to also ensure
350 * thread safty as this call might be done from multiple threads.
351 *
352 * The returned textures are owned by the caller. They should be
353 * unreferenced when no longer used. If this function is called multiple
354 * times with different sets of attachments, those buffers not included in
355 * the last call might be destroyed. This behavior might change in the
356 * future.
357 */
358 bool (*validate)(struct st_context_iface *stctx,
359 struct st_framebuffer_iface *stfbi,
360 const enum st_attachment_type *statts,
361 unsigned count,
362 struct pipe_resource **out);
363 bool (*flush_swapbuffers) (struct st_context_iface *stctx,
364 struct st_framebuffer_iface *stfbi);
365 };
366
367 /**
368 * Represent a rendering context.
369 *
370 * This entity is created from st_api and used by the frontend manager.
371 */
372 struct st_context_iface
373 {
374 /**
375 * Available for the gallium frontend and the manager to use.
376 */
377 void *st_context_private;
378 void *st_manager_private;
379
380 /**
381 * The frontend manager that manages this object.
382 */
383 struct st_manager *state_manager;
384
385 /**
386 * The CSO context associated with this context in case we need to draw
387 * something before swap buffers.
388 */
389 struct cso_context *cso_context;
390
391 /**
392 * The gallium context.
393 */
394 struct pipe_context *pipe;
395
396 /**
397 * Destroy the context.
398 */
399 void (*destroy)(struct st_context_iface *stctxi);
400
401 /**
402 * Flush all drawing from context to the pipe also flushes the pipe.
403 */
404 void (*flush)(struct st_context_iface *stctxi, unsigned flags,
405 struct pipe_fence_handle **fence,
406 void (*notify_before_flush_cb) (void*),
407 void* notify_before_flush_cb_args);
408
409 /**
410 * Replace the texture image of a texture object at the specified level.
411 *
412 * This function is optional.
413 */
414 bool (*teximage)(struct st_context_iface *stctxi,
415 enum st_texture_type target,
416 int level, enum pipe_format internal_format,
417 struct pipe_resource *tex, bool mipmap);
418
419 /**
420 * Used to implement glXCopyContext.
421 */
422 void (*copy)(struct st_context_iface *stctxi,
423 struct st_context_iface *stsrci, unsigned mask);
424
425 /**
426 * Used to implement wglShareLists.
427 */
428 bool (*share)(struct st_context_iface *stctxi,
429 struct st_context_iface *stsrci);
430
431 /**
432 * Start the thread if the API has a worker thread.
433 * Called after the context has been created and fully initialized on both
434 * sides (e.g. st/mesa and st/dri).
435 */
436 void (*start_thread)(struct st_context_iface *stctxi);
437
438 /**
439 * If the API is multithreaded, wait for all queued commands to complete.
440 * Called from the main thread.
441 */
442 void (*thread_finish)(struct st_context_iface *stctxi);
443
444 /**
445 * Invalidate states to notify the frontend that states have been changed
446 * behind its back.
447 */
448 void (*invalidate_state)(struct st_context_iface *stctxi, unsigned flags);
449 };
450
451
452 /**
453 * Represent a frontend manager.
454 *
455 * This interface is implemented by the frontend manager. It corresponds
456 * to a "display" in the window system.
457 */
458 struct st_manager
459 {
460 struct pipe_screen *screen;
461
462 /**
463 * Look up and return the info of an EGLImage.
464 *
465 * This is used to implement for example EGLImageTargetTexture2DOES.
466 * The GLeglImageOES agrument of that call is passed directly to this
467 * function call and the information needed to access this is returned
468 * in the given struct out.
469 *
470 * @smapi: manager owning the caller context
471 * @stctx: caller context
472 * @egl_image: EGLImage that caller recived
473 * @out: return struct filled out with access information.
474 *
475 * This function is optional.
476 */
477 bool (*get_egl_image)(struct st_manager *smapi,
478 void *egl_image,
479 struct st_egl_image *out);
480
481 /**
482 * Validate EGLImage passed to get_egl_image.
483 */
484 bool (*validate_egl_image)(struct st_manager *smapi,
485 void *egl_image);
486
487 /**
488 * Query an manager param.
489 */
490 int (*get_param)(struct st_manager *smapi,
491 enum st_manager_param param);
492
493 /**
494 * Call the loader function setBackgroundContext. Called from the worker
495 * thread.
496 */
497 void (*set_background_context)(struct st_context_iface *stctxi,
498 struct util_queue_monitoring *queue_info);
499
500 /**
501 * Destroy any private data used by the frontend manager.
502 */
503 void (*destroy)(struct st_manager *smapi);
504
505 /**
506 * Available for the frontend manager to use.
507 */
508 void *st_manager_private;
509 };
510
511 /**
512 * Represent a rendering API such as OpenGL or OpenVG.
513 *
514 * Implemented by the gallium frontend and used by the frontend manager.
515 */
516 struct st_api
517 {
518 /**
519 * The name of the rendering API. This is informative.
520 */
521 const char *name;
522
523 /**
524 * The supported rendering API.
525 */
526 enum st_api_type api;
527
528 /**
529 * The supported profiles. Tested with ST_PROFILE_*_MASK.
530 */
531 unsigned profile_mask;
532
533 /**
534 * The supported optional features. Tested with ST_FEATURE_*_MASK.
535 */
536 unsigned feature_mask;
537
538 /**
539 * Destroy the API.
540 */
541 void (*destroy)(struct st_api *stapi);
542
543 /**
544 * Query supported OpenGL versions. (if applicable)
545 * The format is (major*10+minor).
546 */
547 void (*query_versions)(struct st_api *stapi, struct st_manager *sm,
548 struct st_config_options *options,
549 int *gl_core_version,
550 int *gl_compat_version,
551 int *gl_es1_version,
552 int *gl_es2_version);
553
554 /**
555 * Create a rendering context.
556 */
557 struct st_context_iface *(*create_context)(struct st_api *stapi,
558 struct st_manager *smapi,
559 const struct st_context_attribs *attribs,
560 enum st_context_error *error,
561 struct st_context_iface *stsharei);
562
563 /**
564 * Bind the context to the calling thread with draw and read as drawables.
565 *
566 * The framebuffers might be NULL, or might have different visuals than the
567 * context does.
568 */
569 bool (*make_current)(struct st_api *stapi,
570 struct st_context_iface *stctxi,
571 struct st_framebuffer_iface *stdrawi,
572 struct st_framebuffer_iface *streadi);
573
574 /**
575 * Get the currently bound context in the calling thread.
576 */
577 struct st_context_iface *(*get_current)(struct st_api *stapi);
578
579 /**
580 * Notify the st manager the framebuffer interface object
581 * is no longer valid.
582 */
583 void (*destroy_drawable)(struct st_api *stapi,
584 struct st_framebuffer_iface *stfbi);
585 };
586
587 /**
588 * Return true if the visual has the specified buffers.
589 */
590 static inline bool
st_visual_have_buffers(const struct st_visual * visual,unsigned mask)591 st_visual_have_buffers(const struct st_visual *visual, unsigned mask)
592 {
593 return ((visual->buffer_mask & mask) == mask);
594 }
595
596 #endif /* _API_H_ */
597