2 * XML DRI client-side driver configuration
3 * Copyright (C) 2003 Felix Kuehling
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 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included
13 * in all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * FELIX KUEHLING, OR ANY OTHER CONTRIBUTORS BE LIABLE FOR ANY CLAIM,
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
21 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 * \brief Driver-independent client-side part of the XML configuration
27 * \author Felix Kuehling
33 #include "util/mesa-sha1.h"
34 #include "util/ralloc.h"
37 #define STRING_CONF_MAXLEN 25
39 /** \brief Option data types */
40 typedef enum driOptionType {
41 DRI_BOOL, DRI_ENUM, DRI_INT, DRI_FLOAT, DRI_STRING
44 /** \brief Option value */
45 typedef union driOptionValue {
46 unsigned char _bool; /**< \brief Boolean */
47 int _int; /**< \brief Integer or Enum */
48 float _float; /**< \brief Floating-point */
49 char *_string; /**< \brief String */
52 /** \brief Single range of valid values
54 * For empty ranges (a single value) start == end */
55 typedef struct driOptionRange {
56 driOptionValue start; /**< \brief Start */
57 driOptionValue end; /**< \brief End */
60 /** \brief Information about an option */
61 typedef struct driOptionInfo {
62 char *name; /**< \brief Name */
63 driOptionType type; /**< \brief Type */
64 driOptionRange *ranges; /**< \brief Array of ranges */
65 unsigned int nRanges; /**< \brief Number of ranges */
68 /** \brief Option cache
70 * \li One in <driver>Screen caching option info and the default values
71 * \li One in each <driver>Context with the actual values for that context */
72 typedef struct driOptionCache {
74 /**< \brief Array of option infos
76 * Points to the same array in the screen and all contexts */
77 driOptionValue *values;
78 /**< \brief Array of option values
80 * \li Default values in screen
81 * \li Actual values in contexts
83 unsigned int tableSize;
84 /**< \brief Size of the arrays
86 * In the current implementation it's not actually a size but log2(size).
87 * The value is the same in the screen and all contexts. */
90 /** \brief Parse XML option info from configOptions
92 * To be called in <driver>CreateScreen
94 * \param info pointer to a driOptionCache that will store the option info
95 * \param configOptions XML document describing available configuration opts
97 * For the option information to be available to external configuration tools
98 * it must be a public symbol __driConfigOptions. It is also passed as a
99 * parameter to driParseOptionInfo in order to avoid driver-independent code
100 * depending on symbols in driver-specific code. */
101 void driParseOptionInfo (driOptionCache *info,
102 const char *configOptions);
103 /** \brief Initialize option cache from info and parse configuration files
105 * To be called in <driver>CreateContext. screenNum and driverName select
106 * device sections. */
107 void driParseConfigFiles (driOptionCache *cache, const driOptionCache *info,
108 int screenNum, const char *driverName);
109 /** \brief Destroy option info
111 * To be called in <driver>DestroyScreen */
112 void driDestroyOptionInfo (driOptionCache *info);
113 /** \brief Destroy option cache
115 * To be called in <driver>DestroyContext */
116 void driDestroyOptionCache (driOptionCache *cache);
118 /** \brief Check if there exists a certain option */
119 unsigned char driCheckOption (const driOptionCache *cache, const char *name,
122 /** \brief Query a boolean option value */
123 unsigned char driQueryOptionb (const driOptionCache *cache, const char *name);
124 /** \brief Query an integer option value */
125 int driQueryOptioni (const driOptionCache *cache, const char *name);
126 /** \brief Query a floating-point option value */
127 float driQueryOptionf (const driOptionCache *cache, const char *name);
128 /** \brief Query a string option value */
129 char *driQueryOptionstr (const driOptionCache *cache, const char *name);
132 * Returns a hash of the options for this application.
135 driComputeOptionsSha1(const driOptionCache *cache, unsigned char *sha1)
137 void *ctx = ralloc_context(NULL);
138 char *dri_options = ralloc_strdup(ctx, "");
140 for (int i = 0; i < 1 << cache->tableSize; i++) {
141 if (cache->info[i].name == NULL)
145 switch (cache->info[i].type) {
147 ret = ralloc_asprintf_append(&dri_options, "%s:%u,",
149 cache->values[i]._bool);
153 ret = ralloc_asprintf_append(&dri_options, "%s:%d,",
155 cache->values[i]._int);
158 ret = ralloc_asprintf_append(&dri_options, "%s:%f,",
160 cache->values[i]._float);
163 ret = ralloc_asprintf_append(&dri_options, "%s:%s,",
165 cache->values[i]._string);
168 unreachable("unsupported dri config type!");
176 _mesa_sha1_compute(dri_options, strlen(dri_options), sha1);