util: Move DRI parse_debug_string() to util
[mesa.git] / src / mesa / drivers / dri / common / utils.c
1 /*
2 * (C) Copyright IBM Corporation 2002, 2004
3 * All Rights Reserved.
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * on the rights to use, copy, modify, merge, publish, distribute, sub
9 * license, and/or sell copies of the Software, and to permit persons to whom
10 * the Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * 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 NON-INFRINGEMENT. IN NO EVENT SHALL
19 * VA LINUX SYSTEM, IBM AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
21 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
22 * USE OR OTHER DEALINGS IN THE SOFTWARE.
23 */
24
25 /**
26 * \file utils.c
27 * Utility functions for DRI drivers.
28 *
29 * \author Ian Romanick <idr@us.ibm.com>
30 */
31
32 #include <string.h>
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <stdbool.h>
36 #include <stdint.h>
37 #include "main/macros.h"
38 #include "main/mtypes.h"
39 #include "main/cpuinfo.h"
40 #include "main/extensions.h"
41 #include "utils.h"
42 #include "dri_util.h"
43
44 /**
45 * Create the \c GL_RENDERER string for DRI drivers.
46 *
47 * Almost all DRI drivers use a \c GL_RENDERER string of the form:
48 *
49 * "Mesa DRI <chip> <driver date> <AGP speed) <CPU information>"
50 *
51 * Using the supplied chip name, driver data, and AGP speed, this function
52 * creates the string.
53 *
54 * \param buffer Buffer to hold the \c GL_RENDERER string.
55 * \param hardware_name Name of the hardware.
56 * \param agp_mode AGP mode (speed).
57 *
58 * \returns
59 * The length of the string stored in \c buffer. This does \b not include
60 * the terminating \c NUL character.
61 */
62 unsigned
63 driGetRendererString( char * buffer, const char * hardware_name,
64 GLuint agp_mode )
65 {
66 unsigned offset;
67 char *cpu;
68
69 offset = sprintf( buffer, "Mesa DRI %s", hardware_name );
70
71 /* Append any AGP-specific information.
72 */
73 switch ( agp_mode ) {
74 case 1:
75 case 2:
76 case 4:
77 case 8:
78 offset += sprintf( & buffer[ offset ], " AGP %ux", agp_mode );
79 break;
80
81 default:
82 break;
83 }
84
85 /* Append any CPU-specific information.
86 */
87 cpu = _mesa_get_cpu_string();
88 if (cpu) {
89 offset += sprintf(buffer + offset, " %s", cpu);
90 free(cpu);
91 }
92
93 return offset;
94 }
95
96
97 /**
98 * Creates a set of \c struct gl_config that a driver will expose.
99 *
100 * A set of \c struct gl_config will be created based on the supplied
101 * parameters. The number of modes processed will be 2 *
102 * \c num_depth_stencil_bits * \c num_db_modes.
103 *
104 * For the most part, data is just copied from \c depth_bits, \c stencil_bits,
105 * \c db_modes, and \c visType into each \c struct gl_config element.
106 * However, the meanings of \c fb_format and \c fb_type require further
107 * explanation. The \c fb_format specifies which color components are in
108 * each pixel and what the default order is. For example, \c GL_RGB specifies
109 * that red, green, blue are available and red is in the "most significant"
110 * position and blue is in the "least significant". The \c fb_type specifies
111 * the bit sizes of each component and the actual ordering. For example, if
112 * \c GL_UNSIGNED_SHORT_5_6_5_REV is specified with \c GL_RGB, bits [15:11]
113 * are the blue value, bits [10:5] are the green value, and bits [4:0] are
114 * the red value.
115 *
116 * One sublte issue is the combination of \c GL_RGB or \c GL_BGR and either
117 * of the \c GL_UNSIGNED_INT_8_8_8_8 modes. The resulting mask values in the
118 * \c struct gl_config structure is \b identical to the \c GL_RGBA or
119 * \c GL_BGRA case, except the \c alphaMask is zero. This means that, as
120 * far as this routine is concerned, \c GL_RGB with \c GL_UNSIGNED_INT_8_8_8_8
121 * still uses 32-bits.
122 *
123 * If in doubt, look at the tables used in the function.
124 *
125 * \param ptr_to_modes Pointer to a pointer to a linked list of
126 * \c struct gl_config. Upon completion, a pointer to
127 * the next element to be process will be stored here.
128 * If the function fails and returns \c GL_FALSE, this
129 * value will be unmodified, but some elements in the
130 * linked list may be modified.
131 * \param format Mesa mesa_format enum describing the pixel format
132 * \param depth_bits Array of depth buffer sizes to be exposed.
133 * \param stencil_bits Array of stencil buffer sizes to be exposed.
134 * \param num_depth_stencil_bits Number of entries in both \c depth_bits and
135 * \c stencil_bits.
136 * \param db_modes Array of buffer swap modes. If an element has a
137 * value of \c GLX_NONE, then it represents a
138 * single-buffered mode. Other valid values are
139 * \c GLX_SWAP_EXCHANGE_OML, \c GLX_SWAP_COPY_OML, and
140 * \c GLX_SWAP_UNDEFINED_OML. See the
141 * GLX_OML_swap_method extension spec for more details.
142 * \param num_db_modes Number of entries in \c db_modes.
143 * \param msaa_samples Array of msaa sample count. 0 represents a visual
144 * without a multisample buffer.
145 * \param num_msaa_modes Number of entries in \c msaa_samples.
146 * \param visType GLX visual type. Usually either \c GLX_TRUE_COLOR or
147 * \c GLX_DIRECT_COLOR.
148 *
149 * \returns
150 * Pointer to any array of pointers to the \c __DRIconfig structures created
151 * for the specified formats. If there is an error, \c NULL is returned.
152 * Currently the only cause of failure is a bad parameter (i.e., unsupported
153 * \c format).
154 */
155 __DRIconfig **
156 driCreateConfigs(mesa_format format,
157 const uint8_t * depth_bits, const uint8_t * stencil_bits,
158 unsigned num_depth_stencil_bits,
159 const GLenum * db_modes, unsigned num_db_modes,
160 const uint8_t * msaa_samples, unsigned num_msaa_modes,
161 GLboolean enable_accum)
162 {
163 static const uint32_t masks_table[][4] = {
164 /* MESA_FORMAT_B5G6R5_UNORM */
165 { 0x0000F800, 0x000007E0, 0x0000001F, 0x00000000 },
166 /* MESA_FORMAT_B8G8R8X8_UNORM */
167 { 0x00FF0000, 0x0000FF00, 0x000000FF, 0x00000000 },
168 /* MESA_FORMAT_B8G8R8A8_UNORM */
169 { 0x00FF0000, 0x0000FF00, 0x000000FF, 0xFF000000 },
170 /* MESA_FORMAT_B10G10R10X2_UNORM */
171 { 0x3FF00000, 0x000FFC00, 0x000003FF, 0x00000000 },
172 /* MESA_FORMAT_B10G10R10A2_UNORM */
173 { 0x3FF00000, 0x000FFC00, 0x000003FF, 0xC0000000 },
174 };
175
176 const uint32_t * masks;
177 __DRIconfig **configs, **c;
178 struct gl_config *modes;
179 unsigned i, j, k, h;
180 unsigned num_modes;
181 unsigned num_accum_bits = (enable_accum) ? 2 : 1;
182 int red_bits;
183 int green_bits;
184 int blue_bits;
185 int alpha_bits;
186 bool is_srgb;
187
188 switch (format) {
189 case MESA_FORMAT_B5G6R5_UNORM:
190 masks = masks_table[0];
191 break;
192 case MESA_FORMAT_B8G8R8X8_UNORM:
193 case MESA_FORMAT_B8G8R8X8_SRGB:
194 masks = masks_table[1];
195 break;
196 case MESA_FORMAT_B8G8R8A8_UNORM:
197 case MESA_FORMAT_B8G8R8A8_SRGB:
198 masks = masks_table[2];
199 break;
200 case MESA_FORMAT_B10G10R10X2_UNORM:
201 masks = masks_table[3];
202 break;
203 case MESA_FORMAT_B10G10R10A2_UNORM:
204 masks = masks_table[4];
205 break;
206 default:
207 fprintf(stderr, "[%s:%u] Unknown framebuffer type %s (%d).\n",
208 __func__, __LINE__,
209 _mesa_get_format_name(format), format);
210 return NULL;
211 }
212
213 red_bits = _mesa_get_format_bits(format, GL_RED_BITS);
214 green_bits = _mesa_get_format_bits(format, GL_GREEN_BITS);
215 blue_bits = _mesa_get_format_bits(format, GL_BLUE_BITS);
216 alpha_bits = _mesa_get_format_bits(format, GL_ALPHA_BITS);
217 is_srgb = _mesa_get_format_color_encoding(format) == GL_SRGB;
218
219 num_modes = num_depth_stencil_bits * num_db_modes * num_accum_bits * num_msaa_modes;
220 configs = calloc(num_modes + 1, sizeof *configs);
221 if (configs == NULL)
222 return NULL;
223
224 c = configs;
225 for ( k = 0 ; k < num_depth_stencil_bits ; k++ ) {
226 for ( i = 0 ; i < num_db_modes ; i++ ) {
227 for ( h = 0 ; h < num_msaa_modes; h++ ) {
228 for ( j = 0 ; j < num_accum_bits ; j++ ) {
229 *c = malloc (sizeof **c);
230 modes = &(*c)->modes;
231 c++;
232
233 memset(modes, 0, sizeof *modes);
234 modes->redBits = red_bits;
235 modes->greenBits = green_bits;
236 modes->blueBits = blue_bits;
237 modes->alphaBits = alpha_bits;
238 modes->redMask = masks[0];
239 modes->greenMask = masks[1];
240 modes->blueMask = masks[2];
241 modes->alphaMask = masks[3];
242 modes->rgbBits = modes->redBits + modes->greenBits
243 + modes->blueBits + modes->alphaBits;
244
245 modes->accumRedBits = 16 * j;
246 modes->accumGreenBits = 16 * j;
247 modes->accumBlueBits = 16 * j;
248 modes->accumAlphaBits = (masks[3] != 0) ? 16 * j : 0;
249 modes->visualRating = (j == 0) ? GLX_NONE : GLX_SLOW_CONFIG;
250
251 modes->stencilBits = stencil_bits[k];
252 modes->depthBits = depth_bits[k];
253
254 modes->transparentPixel = GLX_NONE;
255 modes->transparentRed = GLX_DONT_CARE;
256 modes->transparentGreen = GLX_DONT_CARE;
257 modes->transparentBlue = GLX_DONT_CARE;
258 modes->transparentAlpha = GLX_DONT_CARE;
259 modes->transparentIndex = GLX_DONT_CARE;
260 modes->rgbMode = GL_TRUE;
261
262 if ( db_modes[i] == GLX_NONE ) {
263 modes->doubleBufferMode = GL_FALSE;
264 }
265 else {
266 modes->doubleBufferMode = GL_TRUE;
267 modes->swapMethod = db_modes[i];
268 }
269
270 modes->samples = msaa_samples[h];
271 modes->sampleBuffers = modes->samples ? 1 : 0;
272
273
274 modes->haveAccumBuffer = ((modes->accumRedBits +
275 modes->accumGreenBits +
276 modes->accumBlueBits +
277 modes->accumAlphaBits) > 0);
278 modes->haveDepthBuffer = (modes->depthBits > 0);
279 modes->haveStencilBuffer = (modes->stencilBits > 0);
280
281 modes->bindToTextureRgb = GL_TRUE;
282 modes->bindToTextureRgba = GL_TRUE;
283 modes->bindToMipmapTexture = GL_FALSE;
284 modes->bindToTextureTargets =
285 __DRI_ATTRIB_TEXTURE_1D_BIT |
286 __DRI_ATTRIB_TEXTURE_2D_BIT |
287 __DRI_ATTRIB_TEXTURE_RECTANGLE_BIT;
288
289 modes->yInverted = GL_TRUE;
290 modes->sRGBCapable = is_srgb;
291 }
292 }
293 }
294 }
295 *c = NULL;
296
297 return configs;
298 }
299
300 __DRIconfig **driConcatConfigs(__DRIconfig **a,
301 __DRIconfig **b)
302 {
303 __DRIconfig **all;
304 int i, j, index;
305
306 if (a == NULL || a[0] == NULL)
307 return b;
308 else if (b == NULL || b[0] == NULL)
309 return a;
310
311 i = 0;
312 while (a[i] != NULL)
313 i++;
314 j = 0;
315 while (b[j] != NULL)
316 j++;
317
318 all = malloc((i + j + 1) * sizeof *all);
319 index = 0;
320 for (i = 0; a[i] != NULL; i++)
321 all[index++] = a[i];
322 for (j = 0; b[j] != NULL; j++)
323 all[index++] = b[j];
324 all[index++] = NULL;
325
326 free(a);
327 free(b);
328
329 return all;
330 }
331
332 #define __ATTRIB(attrib, field) \
333 { attrib, offsetof(struct gl_config, field) }
334
335 static const struct { unsigned int attrib, offset; } attribMap[] = {
336 __ATTRIB(__DRI_ATTRIB_BUFFER_SIZE, rgbBits),
337 __ATTRIB(__DRI_ATTRIB_LEVEL, level),
338 __ATTRIB(__DRI_ATTRIB_RED_SIZE, redBits),
339 __ATTRIB(__DRI_ATTRIB_GREEN_SIZE, greenBits),
340 __ATTRIB(__DRI_ATTRIB_BLUE_SIZE, blueBits),
341 __ATTRIB(__DRI_ATTRIB_ALPHA_SIZE, alphaBits),
342 __ATTRIB(__DRI_ATTRIB_DEPTH_SIZE, depthBits),
343 __ATTRIB(__DRI_ATTRIB_STENCIL_SIZE, stencilBits),
344 __ATTRIB(__DRI_ATTRIB_ACCUM_RED_SIZE, accumRedBits),
345 __ATTRIB(__DRI_ATTRIB_ACCUM_GREEN_SIZE, accumGreenBits),
346 __ATTRIB(__DRI_ATTRIB_ACCUM_BLUE_SIZE, accumBlueBits),
347 __ATTRIB(__DRI_ATTRIB_ACCUM_ALPHA_SIZE, accumAlphaBits),
348 __ATTRIB(__DRI_ATTRIB_SAMPLE_BUFFERS, sampleBuffers),
349 __ATTRIB(__DRI_ATTRIB_SAMPLES, samples),
350 __ATTRIB(__DRI_ATTRIB_DOUBLE_BUFFER, doubleBufferMode),
351 __ATTRIB(__DRI_ATTRIB_STEREO, stereoMode),
352 __ATTRIB(__DRI_ATTRIB_AUX_BUFFERS, numAuxBuffers),
353 __ATTRIB(__DRI_ATTRIB_TRANSPARENT_TYPE, transparentPixel),
354 __ATTRIB(__DRI_ATTRIB_TRANSPARENT_INDEX_VALUE, transparentPixel),
355 __ATTRIB(__DRI_ATTRIB_TRANSPARENT_RED_VALUE, transparentRed),
356 __ATTRIB(__DRI_ATTRIB_TRANSPARENT_GREEN_VALUE, transparentGreen),
357 __ATTRIB(__DRI_ATTRIB_TRANSPARENT_BLUE_VALUE, transparentBlue),
358 __ATTRIB(__DRI_ATTRIB_TRANSPARENT_ALPHA_VALUE, transparentAlpha),
359 __ATTRIB(__DRI_ATTRIB_RED_MASK, redMask),
360 __ATTRIB(__DRI_ATTRIB_GREEN_MASK, greenMask),
361 __ATTRIB(__DRI_ATTRIB_BLUE_MASK, blueMask),
362 __ATTRIB(__DRI_ATTRIB_ALPHA_MASK, alphaMask),
363 __ATTRIB(__DRI_ATTRIB_MAX_PBUFFER_WIDTH, maxPbufferWidth),
364 __ATTRIB(__DRI_ATTRIB_MAX_PBUFFER_HEIGHT, maxPbufferHeight),
365 __ATTRIB(__DRI_ATTRIB_MAX_PBUFFER_PIXELS, maxPbufferPixels),
366 __ATTRIB(__DRI_ATTRIB_OPTIMAL_PBUFFER_WIDTH, optimalPbufferWidth),
367 __ATTRIB(__DRI_ATTRIB_OPTIMAL_PBUFFER_HEIGHT, optimalPbufferHeight),
368 __ATTRIB(__DRI_ATTRIB_SWAP_METHOD, swapMethod),
369 __ATTRIB(__DRI_ATTRIB_BIND_TO_TEXTURE_RGB, bindToTextureRgb),
370 __ATTRIB(__DRI_ATTRIB_BIND_TO_TEXTURE_RGBA, bindToTextureRgba),
371 __ATTRIB(__DRI_ATTRIB_BIND_TO_MIPMAP_TEXTURE, bindToMipmapTexture),
372 __ATTRIB(__DRI_ATTRIB_BIND_TO_TEXTURE_TARGETS, bindToTextureTargets),
373 __ATTRIB(__DRI_ATTRIB_YINVERTED, yInverted),
374 __ATTRIB(__DRI_ATTRIB_FRAMEBUFFER_SRGB_CAPABLE, sRGBCapable),
375
376 /* The struct field doesn't matter here, these are handled by the
377 * switch in driGetConfigAttribIndex. We need them in the array
378 * so the iterator includes them though.*/
379 __ATTRIB(__DRI_ATTRIB_RENDER_TYPE, level),
380 __ATTRIB(__DRI_ATTRIB_CONFIG_CAVEAT, level),
381 __ATTRIB(__DRI_ATTRIB_SWAP_METHOD, level)
382 };
383
384
385 /**
386 * Return the value of a configuration attribute. The attribute is
387 * indicated by the index.
388 */
389 static int
390 driGetConfigAttribIndex(const __DRIconfig *config,
391 unsigned int index, unsigned int *value)
392 {
393 switch (attribMap[index].attrib) {
394 case __DRI_ATTRIB_RENDER_TYPE:
395 /* no support for color index mode */
396 *value = __DRI_ATTRIB_RGBA_BIT;
397 break;
398 case __DRI_ATTRIB_CONFIG_CAVEAT:
399 if (config->modes.visualRating == GLX_NON_CONFORMANT_CONFIG)
400 *value = __DRI_ATTRIB_NON_CONFORMANT_CONFIG;
401 else if (config->modes.visualRating == GLX_SLOW_CONFIG)
402 *value = __DRI_ATTRIB_SLOW_BIT;
403 else
404 *value = 0;
405 break;
406 case __DRI_ATTRIB_SWAP_METHOD:
407 /* XXX no return value??? */
408 break;
409
410 default:
411 /* any other int-sized field */
412 *value = *(unsigned int *)
413 ((char *) &config->modes + attribMap[index].offset);
414
415 break;
416 }
417
418 return GL_TRUE;
419 }
420
421
422 /**
423 * Get the value of a configuration attribute.
424 * \param attrib the attribute (one of the _DRI_ATTRIB_x tokens)
425 * \param value returns the attribute's value
426 * \return 1 for success, 0 for failure
427 */
428 int
429 driGetConfigAttrib(const __DRIconfig *config,
430 unsigned int attrib, unsigned int *value)
431 {
432 unsigned i;
433
434 for (i = 0; i < ARRAY_SIZE(attribMap); i++)
435 if (attribMap[i].attrib == attrib)
436 return driGetConfigAttribIndex(config, i, value);
437
438 return GL_FALSE;
439 }
440
441
442 /**
443 * Get a configuration attribute name and value, given an index.
444 * \param index which field of the __DRIconfig to query
445 * \param attrib returns the attribute name (one of the _DRI_ATTRIB_x tokens)
446 * \param value returns the attribute's value
447 * \return 1 for success, 0 for failure
448 */
449 int
450 driIndexConfigAttrib(const __DRIconfig *config, int index,
451 unsigned int *attrib, unsigned int *value)
452 {
453 if (index >= 0 && index < ARRAY_SIZE(attribMap)) {
454 *attrib = attribMap[index].attrib;
455 return driGetConfigAttribIndex(config, index, value);
456 }
457
458 return GL_FALSE;
459 }
460
461 /**
462 * Implement queries for values that are common across all Mesa drivers
463 *
464 * Currently only the following queries are supported by this function:
465 *
466 * - \c __DRI2_RENDERER_VERSION
467 * - \c __DRI2_RENDERER_PREFERRED_PROFILE
468 * - \c __DRI2_RENDERER_OPENGL_CORE_PROFILE_VERSION
469 * - \c __DRI2_RENDERER_OPENGL_COMPATIBLITY_PROFILE_VERSION
470 * - \c __DRI2_RENDERER_ES_PROFILE_VERSION
471 * - \c __DRI2_RENDERER_ES2_PROFILE_VERSION
472 *
473 * \returns
474 * Zero if a recognized value of \c param is supplied, -1 otherwise.
475 */
476 int
477 driQueryRendererIntegerCommon(__DRIscreen *psp, int param, unsigned int *value)
478 {
479 switch (param) {
480 case __DRI2_RENDERER_VERSION: {
481 static const char *const ver = PACKAGE_VERSION;
482 char *endptr;
483 int v[3];
484
485 v[0] = strtol(ver, &endptr, 10);
486 assert(endptr[0] == '.');
487 if (endptr[0] != '.')
488 return -1;
489
490 v[1] = strtol(endptr + 1, &endptr, 10);
491 assert(endptr[0] == '.');
492 if (endptr[0] != '.')
493 return -1;
494
495 v[2] = strtol(endptr + 1, &endptr, 10);
496
497 value[0] = v[0];
498 value[1] = v[1];
499 value[2] = v[2];
500 return 0;
501 }
502 case __DRI2_RENDERER_PREFERRED_PROFILE:
503 value[0] = (psp->max_gl_core_version != 0)
504 ? (1U << __DRI_API_OPENGL_CORE) : (1U << __DRI_API_OPENGL);
505 return 0;
506 case __DRI2_RENDERER_OPENGL_CORE_PROFILE_VERSION:
507 value[0] = psp->max_gl_core_version / 10;
508 value[1] = psp->max_gl_core_version % 10;
509 return 0;
510 case __DRI2_RENDERER_OPENGL_COMPATIBILITY_PROFILE_VERSION:
511 value[0] = psp->max_gl_compat_version / 10;
512 value[1] = psp->max_gl_compat_version % 10;
513 return 0;
514 case __DRI2_RENDERER_OPENGL_ES_PROFILE_VERSION:
515 value[0] = psp->max_gl_es1_version / 10;
516 value[1] = psp->max_gl_es1_version % 10;
517 return 0;
518 case __DRI2_RENDERER_OPENGL_ES2_PROFILE_VERSION:
519 value[0] = psp->max_gl_es2_version / 10;
520 value[1] = psp->max_gl_es2_version % 10;
521 return 0;
522 default:
523 break;
524 }
525
526 return -1;
527 }