src/mesa/drivers/dri/common/xmlconfig.c

   1 /*
   2  * XML DRI client-side driver configuration
   3  * Copyright (C) 2003 Felix Kuehling
   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  * 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:
  11  *
  12  * The above copyright notice and this permission notice shall be included
  13  * in all copies or substantial portions of the Software.
  14  *
  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.
  22  *
  23  */
  24 /**
  25  * \file xmlconfig.c
  26  * \brief Driver-independent client-side part of the XML configuration
  27  * \author Felix Kuehling
  28  */
  29
  30 #include <string.h>
  31 #include <assert.h>
  32 #include <expat.h>
  33 #include <fcntl.h>
  34 #include <unistd.h>
  35 #include <errno.h>
  36 #include "main/imports.h"
  37 #include "utils.h"
  38 #include "xmlconfig.h"
  39
  40 #undef GET_PROGRAM_NAME
  41
  42 #if (defined(__GNU_LIBRARY__) || defined(__GLIBC__)) && !defined(__UCLIBC__)
  43 #    if !defined(__GLIBC__) || (__GLIBC__ < 2)
  44 /* These aren't declared in any libc5 header */
  45 extern char *program_invocation_name, *program_invocation_short_name;
  46 #    endif
  47 #    define GET_PROGRAM_NAME() program_invocation_short_name
  48 #elif defined(__CYGWIN__)
  49 #    define GET_PROGRAM_NAME() program_invocation_short_name
  50 #elif defined(__FreeBSD__) && (__FreeBSD__ >= 2)
  51 #    include <osreldate.h>
  52 #    if (__FreeBSD_version >= 440000)
  53 #        include <stdlib.h>
  54 #        define GET_PROGRAM_NAME() getprogname()
  55 #    endif
  56 #elif defined(__NetBSD__) && defined(__NetBSD_Version) && (__NetBSD_Version >= 106000100)
  57 #    include <stdlib.h>
  58 #    define GET_PROGRAM_NAME() getprogname()
  59 #elif defined(__APPLE__)
  60 #    include <stdlib.h>
  61 #    define GET_PROGRAM_NAME() getprogname()
  62 #elif defined(__sun)
  63 /* Solaris has getexecname() which returns the full path - return just
  64    the basename to match BSD getprogname() */
  65 #    include <stdlib.h>
  66 #    include <libgen.h>
  67
  68 static const char *__getProgramName () {
  69     static const char *progname;
  70
  71     if (progname == NULL) {
  72         const char *e = getexecname();
  73         if (e != NULL) {
  74             /* Have to make a copy since getexecname can return a readonly
  75                string, but basename expects to be able to modify its arg. */
  76             char *n = strdup(e);
  77             if (n != NULL) {
  78                 progname = basename(n);
  79             }
  80         }
  81     }
  82     return progname;
  83 }
  84
  85 #    define GET_PROGRAM_NAME() __getProgramName()
  86 #endif
  87
  88 #if !defined(GET_PROGRAM_NAME)
  89 #    if defined(__OpenBSD__) || defined(NetBSD) || defined(__UCLIBC__) || defined(ANDROID)
  90 /* This is a hack. It's said to work on OpenBSD, NetBSD and GNU.
  91  * Rogelio M.Serrano Jr. reported it's also working with UCLIBC. It's
  92  * used as a last resort, if there is no documented facility available. */
  93 static const char *__getProgramName () {
  94     extern const char *__progname;
  95     char * arg = strrchr(__progname, '/');
  96     if (arg)
  97         return arg+1;
  98     else
  99         return __progname;
 100 }
 101 #        define GET_PROGRAM_NAME() __getProgramName()
 102 #    else
 103 #        define GET_PROGRAM_NAME() ""
 104 #        warning "Per application configuration won't work with your OS version."
 105 #    endif
 106 #endif
 107
 108 /** \brief Find an option in an option cache with the name as key */
 109 static uint32_t findOption (const driOptionCache *cache, const char *name) {
 110     uint32_t len = strlen (name);
 111     uint32_t size = 1 << cache->tableSize, mask = size - 1;
 112     uint32_t hash = 0;
 113     uint32_t i, shift;
 114
 115   /* compute a hash from the variable length name */
 116     for (i = 0, shift = 0; i < len; ++i, shift = (shift+8) & 31)
 117         hash += (uint32_t)name[i] << shift;
 118     hash *= hash;
 119     hash = (hash >> (16-cache->tableSize/2)) & mask;
 120
 121   /* this is just the starting point of the linear search for the option */
 122     for (i = 0; i < size; ++i, hash = (hash+1) & mask) {
 123       /* if we hit an empty entry then the option is not defined (yet) */
 124         if (cache->info[hash].name == 0)
 125             break;
 126         else if (!strcmp (name, cache->info[hash].name))
 127             break;
 128     }
 129   /* this assertion fails if the hash table is full */
 130     assert (i < size);
 131
 132     return hash;
 133 }
 134
 135 /** \brief Like strdup but using malloc and with error checking. */
 136 #define XSTRDUP(dest,source) do { \
 137     uint32_t len = strlen (source); \
 138     if (!(dest = malloc(len+1))) { \
 139         fprintf (stderr, "%s: %d: out of memory.\n", __FILE__, __LINE__); \
 140         abort(); \
 141     } \
 142     memcpy (dest, source, len+1); \
 143 } while (0)
 144
 145 static int compare (const void *a, const void *b) {
 146     return strcmp (*(char *const*)a, *(char *const*)b);
 147 }
 148 /** \brief Binary search in a string array. */
 149 static uint32_t bsearchStr (const XML_Char *name,
 150                           const XML_Char *elems[], uint32_t count) {
 151     const XML_Char **found;
 152     found = bsearch (&name, elems, count, sizeof (XML_Char *), compare);
 153     if (found)
 154         return found - elems;
 155     else
 156         return count;
 157 }
 158
 159 /** \brief Locale-independent integer parser.
 160  *
 161  * Works similar to strtol. Leading space is NOT skipped. The input
 162  * number may have an optional sign. Radix is specified by base. If
 163  * base is 0 then decimal is assumed unless the input number is
 164  * prefixed by 0x or 0X for hexadecimal or 0 for octal. After
 165  * returning tail points to the first character that is not part of
 166  * the integer number. If no number was found then tail points to the
 167  * start of the input string. */
 168 static int strToI (const XML_Char *string, const XML_Char **tail, int base) {
 169     int radix = base == 0 ? 10 : base;
 170     int result = 0;
 171     int sign = 1;
 172     bool numberFound = false;
 173     const XML_Char *start = string;
 174
 175     assert (radix >= 2 && radix <= 36);
 176
 177     if (*string == '-') {
 178         sign = -1;
 179         string++;
 180     } else if (*string == '+')
 181         string++;
 182     if (base == 0 && *string == '0') {
 183         numberFound = true;
 184         if (*(string+1) == 'x' || *(string+1) == 'X') {
 185             radix = 16;
 186             string += 2;
 187         } else {
 188             radix = 8;
 189             string++;
 190         }
 191     }
 192     do {
 193         int digit = -1;
 194         if (radix <= 10) {
 195             if (*string >= '0' && *string < '0' + radix)
 196                 digit = *string - '0';
 197         } else {
 198             if (*string >= '0' && *string <= '9')
 199                 digit = *string - '0';
 200             else if (*string >= 'a' && *string < 'a' + radix - 10)
 201                 digit = *string - 'a' + 10;
 202             else if (*string >= 'A' && *string < 'A' + radix - 10)
 203                 digit = *string - 'A' + 10;
 204         }
 205         if (digit != -1) {
 206             numberFound = true;
 207             result = radix*result + digit;
 208             string++;
 209         } else
 210             break;
 211     } while (true);
 212     *tail = numberFound ? string : start;
 213     return sign * result;
 214 }
 215
 216 /** \brief Locale-independent floating-point parser.
 217  *
 218  * Works similar to strtod. Leading space is NOT skipped. The input
 219  * number may have an optional sign. '.' is interpreted as decimal
 220  * point and may occur at most once. Optionally the number may end in
 221  * [eE]<exponent>, where <exponent> is an integer as recognized by
 222  * strToI. In that case the result is number * 10^exponent. After
 223  * returning tail points to the first character that is not part of
 224  * the floating point number. If no number was found then tail points
 225  * to the start of the input string.
 226  *
 227  * Uses two passes for maximum accuracy. */
 228 static float strToF (const XML_Char *string, const XML_Char **tail) {
 229     int nDigits = 0, pointPos, exponent;
 230     float sign = 1.0f, result = 0.0f, scale;
 231     const XML_Char *start = string, *numStart;
 232
 233     /* sign */
 234     if (*string == '-') {
 235         sign = -1.0f;
 236         string++;
 237     } else if (*string == '+')
 238         string++;
 239
 240     /* first pass: determine position of decimal point, number of
 241      * digits, exponent and the end of the number. */
 242     numStart = string;
 243     while (*string >= '0' && *string <= '9') {
 244         string++;
 245         nDigits++;
 246     }
 247     pointPos = nDigits;
 248     if (*string == '.') {
 249         string++;
 250         while (*string >= '0' && *string <= '9') {
 251             string++;
 252             nDigits++;
 253         }
 254     }
 255     if (nDigits == 0) {
 256         /* no digits, no number */
 257         *tail = start;
 258         return 0.0f;
 259     }
 260     *tail = string;
 261     if (*string == 'e' || *string == 'E') {
 262         const XML_Char *expTail;
 263         exponent = strToI (string+1, &expTail, 10);
 264         if (expTail == string+1)
 265             exponent = 0;
 266         else
 267             *tail = expTail;
 268     } else
 269         exponent = 0;
 270     string = numStart;
 271
 272     /* scale of the first digit */
 273     scale = sign * (float)pow (10.0, (double)(pointPos-1 + exponent));
 274
 275     /* second pass: parse digits */
 276     do {
 277         if (*string != '.') {
 278             assert (*string >= '0' && *string <= '9');
 279             result += scale * (float)(*string - '0');
 280             scale *= 0.1f;
 281             nDigits--;
 282         }
 283         string++;
 284     } while (nDigits > 0);
 285
 286     return result;
 287 }
 288
 289 /** \brief Parse a value of a given type. */
 290 static unsigned char parseValue (driOptionValue *v, driOptionType type,
 291                              const XML_Char *string) {
 292     const XML_Char *tail = NULL;
 293   /* skip leading white-space */
 294     string += strspn (string, " \f\n\r\t\v");
 295     switch (type) {
 296       case DRI_BOOL:
 297         if (!strcmp (string, "false")) {
 298             v->_bool = false;
 299             tail = string + 5;
 300         } else if (!strcmp (string, "true")) {
 301             v->_bool = true;
 302             tail = string + 4;
 303         }
 304         else
 305             return false;
 306         break;
 307       case DRI_ENUM: /* enum is just a special integer */
 308       case DRI_INT:
 309         v->_int = strToI (string, &tail, 0);
 310         break;
 311       case DRI_FLOAT:
 312         v->_float = strToF (string, &tail);
 313         break;
 314       case DRI_STRING:
 315         if (v->_string)
 316             free (v->_string);
 317         v->_string = strndup(string, STRING_CONF_MAXLEN);
 318         return GL_TRUE;
 319     }
 320
 321     if (tail == string)
 322         return false; /* empty string (or containing only white-space) */
 323   /* skip trailing white space */
 324     if (*tail)
 325         tail += strspn (tail, " \f\n\r\t\v");
 326     if (*tail)
 327         return false; /* something left over that is not part of value */
 328
 329     return true;
 330 }
 331
 332 /** \brief Parse a list of ranges of type info->type. */
 333 static unsigned char parseRanges (driOptionInfo *info, const XML_Char *string) {
 334     XML_Char *cp, *range;
 335     uint32_t nRanges, i;
 336     driOptionRange *ranges;
 337
 338     XSTRDUP (cp, string);
 339   /* pass 1: determine the number of ranges (number of commas + 1) */
 340     range = cp;
 341     for (nRanges = 1; *range; ++range)
 342         if (*range == ',')
 343             ++nRanges;
 344
 345     if ((ranges = malloc(nRanges*sizeof(driOptionRange))) == NULL) {
 346         fprintf (stderr, "%s: %d: out of memory.\n", __FILE__, __LINE__);
 347         abort();
 348     }
 349
 350   /* pass 2: parse all ranges into preallocated array */
 351     range = cp;
 352     for (i = 0; i < nRanges; ++i) {
 353         XML_Char *end, *sep;
 354         assert (range);
 355         end = strchr (range, ',');
 356         if (end)
 357             *end = '\0';
 358         sep = strchr (range, ':');
 359         if (sep) { /* non-empty interval */
 360             *sep = '\0';
 361             if (!parseValue (&ranges[i].start, info->type, range) ||
 362                 !parseValue (&ranges[i].end, info->type, sep+1))
 363                 break;
 364             if (info->type == DRI_INT &&
 365                 ranges[i].start._int > ranges[i].end._int)
 366                 break;
 367             if (info->type == DRI_FLOAT &&
 368                 ranges[i].start._float > ranges[i].end._float)
 369                 break;
 370         } else { /* empty interval */
 371             if (!parseValue (&ranges[i].start, info->type, range))
 372                 break;
 373             ranges[i].end = ranges[i].start;
 374         }
 375         if (end)
 376             range = end+1;
 377         else
 378             range = NULL;
 379     }
 380     free(cp);
 381     if (i < nRanges) {
 382         free(ranges);
 383         return false;
 384     } else
 385         assert (range == NULL);
 386
 387     info->nRanges = nRanges;
 388     info->ranges = ranges;
 389     return true;
 390 }
 391
 392 /** \brief Check if a value is in one of info->ranges. */
 393 static bool checkValue (const driOptionValue *v, const driOptionInfo *info) {
 394     uint32_t i;
 395     assert (info->type != DRI_BOOL); /* should be caught by the parser */
 396     if (info->nRanges == 0)
 397         return true;
 398     switch (info->type) {
 399       case DRI_ENUM: /* enum is just a special integer */
 400       case DRI_INT:
 401         for (i = 0; i < info->nRanges; ++i)
 402             if (v->_int >= info->ranges[i].start._int &&
 403                 v->_int <= info->ranges[i].end._int)
 404                 return true;
 405         break;
 406       case DRI_FLOAT:
 407         for (i = 0; i < info->nRanges; ++i)
 408             if (v->_float >= info->ranges[i].start._float &&
 409                 v->_float <= info->ranges[i].end._float)
 410                 return true;
 411         break;
 412       case DRI_STRING:
 413         break;
 414       default:
 415         assert (0); /* should never happen */
 416     }
 417     return false;
 418 }
 419
 420 /**
 421  * Print message to \c stderr if the \c LIBGL_DEBUG environment variable
 422  * is set.
 423  *
 424  * Is called from the drivers.
 425  *
 426  * \param f \c printf like format string.
 427  */
 428 static void
 429 __driUtilMessage(const char *f, ...)
 430 {
 431     va_list args;
 432
 433     if (getenv("LIBGL_DEBUG")) {
 434         fprintf(stderr, "libGL: ");
 435         va_start(args, f);
 436         vfprintf(stderr, f, args);
 437         va_end(args);
 438         fprintf(stderr, "\n");
 439     }
 440 }
 441
 442 /** \brief Output a warning message. */
 443 #define XML_WARNING1(msg) do {\
 444     __driUtilMessage ("Warning in %s line %d, column %d: "msg, data->name, \
 445                       (int) XML_GetCurrentLineNumber(data->parser), \
 446                       (int) XML_GetCurrentColumnNumber(data->parser)); \
 447 } while (0)
 448 #define XML_WARNING(msg,args...) do { \
 449     __driUtilMessage ("Warning in %s line %d, column %d: "msg, data->name, \
 450                       (int) XML_GetCurrentLineNumber(data->parser), \
 451                       (int) XML_GetCurrentColumnNumber(data->parser), \
 452                       args); \
 453 } while (0)
 454 /** \brief Output an error message. */
 455 #define XML_ERROR1(msg) do { \
 456     __driUtilMessage ("Error in %s line %d, column %d: "msg, data->name, \
 457                       (int) XML_GetCurrentLineNumber(data->parser), \
 458                       (int) XML_GetCurrentColumnNumber(data->parser)); \
 459 } while (0)
 460 #define XML_ERROR(msg,args...) do { \
 461     __driUtilMessage ("Error in %s line %d, column %d: "msg, data->name, \
 462                       (int) XML_GetCurrentLineNumber(data->parser), \
 463                       (int) XML_GetCurrentColumnNumber(data->parser), \
 464                       args); \
 465 } while (0)
 466 /** \brief Output a fatal error message and abort. */
 467 #define XML_FATAL1(msg) do { \
 468     fprintf (stderr, "Fatal error in %s line %d, column %d: "msg"\n", \
 469              data->name, \
 470              (int) XML_GetCurrentLineNumber(data->parser),      \
 471              (int) XML_GetCurrentColumnNumber(data->parser)); \
 472     abort();\
 473 } while (0)
 474 #define XML_FATAL(msg,args...) do { \
 475     fprintf (stderr, "Fatal error in %s line %d, column %d: "msg"\n", \
 476              data->name, \
 477              (int) XML_GetCurrentLineNumber(data->parser),      \
 478              (int) XML_GetCurrentColumnNumber(data->parser),            \
 479              args); \
 480     abort();\
 481 } while (0)
 482
 483 /** \brief Parser context for __driConfigOptions. */
 484 struct OptInfoData {
 485     const char *name;
 486     XML_Parser parser;
 487     driOptionCache *cache;
 488     bool inDriInfo;
 489     bool inSection;
 490     bool inDesc;
 491     bool inOption;
 492     bool inEnum;
 493     int curOption;
 494 };
 495
 496 /** \brief Elements in __driConfigOptions. */
 497 enum OptInfoElem {
 498     OI_DESCRIPTION = 0, OI_DRIINFO, OI_ENUM, OI_OPTION, OI_SECTION, OI_COUNT
 499 };
 500 static const XML_Char *OptInfoElems[] = {
 501     "description", "driinfo", "enum", "option", "section"
 502 };
 503
 504 /** \brief Parse attributes of an enum element.
 505  *
 506  * We're not actually interested in the data. Just make sure this is ok
 507  * for external configuration tools.
 508  */
 509 static void parseEnumAttr (struct OptInfoData *data, const XML_Char **attr) {
 510     uint32_t i;
 511     const XML_Char *value = NULL, *text = NULL;
 512     driOptionValue v;
 513     uint32_t opt = data->curOption;
 514     for (i = 0; attr[i]; i += 2) {
 515         if (!strcmp (attr[i], "value")) value = attr[i+1];
 516         else if (!strcmp (attr[i], "text")) text = attr[i+1];
 517         else XML_FATAL("illegal enum attribute: %s.", attr[i]);
 518     }
 519     if (!value) XML_FATAL1 ("value attribute missing in enum.");
 520     if (!text) XML_FATAL1 ("text attribute missing in enum.");
 521      if (!parseValue (&v, data->cache->info[opt].type, value))
 522         XML_FATAL ("illegal enum value: %s.", value);
 523     if (!checkValue (&v, &data->cache->info[opt]))
 524         XML_FATAL ("enum value out of valid range: %s.", value);
 525 }
 526
 527 /** \brief Parse attributes of a description element.
 528  *
 529  * We're not actually interested in the data. Just make sure this is ok
 530  * for external configuration tools.
 531  */
 532 static void parseDescAttr (struct OptInfoData *data, const XML_Char **attr) {
 533     uint32_t i;
 534     const XML_Char *lang = NULL, *text = NULL;
 535     for (i = 0; attr[i]; i += 2) {
 536         if (!strcmp (attr[i], "lang")) lang = attr[i+1];
 537         else if (!strcmp (attr[i], "text")) text = attr[i+1];
 538         else XML_FATAL("illegal description attribute: %s.", attr[i]);
 539     }
 540     if (!lang) XML_FATAL1 ("lang attribute missing in description.");
 541     if (!text) XML_FATAL1 ("text attribute missing in description.");
 542 }
 543
 544 /** \brief Parse attributes of an option element. */
 545 static void parseOptInfoAttr (struct OptInfoData *data, const XML_Char **attr) {
 546     enum OptAttr {OA_DEFAULT = 0, OA_NAME, OA_TYPE, OA_VALID, OA_COUNT};
 547     static const XML_Char *optAttr[] = {"default", "name", "type", "valid"};
 548     const XML_Char *attrVal[OA_COUNT] = {NULL, NULL, NULL, NULL};
 549     const char *defaultVal;
 550     driOptionCache *cache = data->cache;
 551     uint32_t opt, i;
 552     for (i = 0; attr[i]; i += 2) {
 553         uint32_t attrName = bsearchStr (attr[i], optAttr, OA_COUNT);
 554         if (attrName >= OA_COUNT)
 555             XML_FATAL ("illegal option attribute: %s", attr[i]);
 556         attrVal[attrName] = attr[i+1];
 557     }
 558     if (!attrVal[OA_NAME]) XML_FATAL1 ("name attribute missing in option.");
 559     if (!attrVal[OA_TYPE]) XML_FATAL1 ("type attribute missing in option.");
 560     if (!attrVal[OA_DEFAULT]) XML_FATAL1 ("default attribute missing in option.");
 561
 562     opt = findOption (cache, attrVal[OA_NAME]);
 563     if (cache->info[opt].name)
 564         XML_FATAL ("option %s redefined.", attrVal[OA_NAME]);
 565     data->curOption = opt;
 566
 567     XSTRDUP (cache->info[opt].name, attrVal[OA_NAME]);
 568
 569     if (!strcmp (attrVal[OA_TYPE], "bool"))
 570         cache->info[opt].type = DRI_BOOL;
 571     else if (!strcmp (attrVal[OA_TYPE], "enum"))
 572         cache->info[opt].type = DRI_ENUM;
 573     else if (!strcmp (attrVal[OA_TYPE], "int"))
 574         cache->info[opt].type = DRI_INT;
 575     else if (!strcmp (attrVal[OA_TYPE], "float"))
 576         cache->info[opt].type = DRI_FLOAT;
 577     else if (!strcmp (attrVal[OA_TYPE], "string"))
 578         cache->info[opt].type = DRI_STRING;
 579     else
 580         XML_FATAL ("illegal type in option: %s.", attrVal[OA_TYPE]);
 581
 582     defaultVal = getenv (cache->info[opt].name);
 583     if (defaultVal != NULL) {
 584       /* don't use XML_WARNING, we want the user to see this! */
 585         fprintf (stderr,
 586                  "ATTENTION: default value of option %s overridden by environment.\n",
 587                  cache->info[opt].name);
 588     } else
 589         defaultVal = attrVal[OA_DEFAULT];
 590     if (!parseValue (&cache->values[opt], cache->info[opt].type, defaultVal))
 591         XML_FATAL ("illegal default value for %s: %s.", cache->info[opt].name, defaultVal);
 592
 593     if (attrVal[OA_VALID]) {
 594         if (cache->info[opt].type == DRI_BOOL)
 595             XML_FATAL1 ("boolean option with valid attribute.");
 596         if (!parseRanges (&cache->info[opt], attrVal[OA_VALID]))
 597             XML_FATAL ("illegal valid attribute: %s.", attrVal[OA_VALID]);
 598         if (!checkValue (&cache->values[opt], &cache->info[opt]))
 599             XML_FATAL ("default value out of valid range '%s': %s.",
 600                        attrVal[OA_VALID], defaultVal);
 601     } else if (cache->info[opt].type == DRI_ENUM) {
 602         XML_FATAL1 ("valid attribute missing in option (mandatory for enums).");
 603     } else {
 604         cache->info[opt].nRanges = 0;
 605         cache->info[opt].ranges = NULL;
 606     }
 607 }
 608
 609 /** \brief Handler for start element events. */
 610 static void optInfoStartElem (void *userData, const XML_Char *name,
 611                               const XML_Char **attr) {
 612     struct OptInfoData *data = (struct OptInfoData *)userData;
 613     enum OptInfoElem elem = bsearchStr (name, OptInfoElems, OI_COUNT);
 614     switch (elem) {
 615       case OI_DRIINFO:
 616         if (data->inDriInfo)
 617             XML_FATAL1 ("nested <driinfo> elements.");
 618         if (attr[0])
 619             XML_FATAL1 ("attributes specified on <driinfo> element.");
 620         data->inDriInfo = true;
 621         break;
 622       case OI_SECTION:
 623         if (!data->inDriInfo)
 624             XML_FATAL1 ("<section> must be inside <driinfo>.");
 625         if (data->inSection)
 626             XML_FATAL1 ("nested <section> elements.");
 627         if (attr[0])
 628             XML_FATAL1 ("attributes specified on <section> element.");
 629         data->inSection = true;
 630         break;
 631       case OI_DESCRIPTION:
 632         if (!data->inSection && !data->inOption)
 633             XML_FATAL1 ("<description> must be inside <description> or <option.");
 634         if (data->inDesc)
 635             XML_FATAL1 ("nested <description> elements.");
 636         data->inDesc = true;
 637         parseDescAttr (data, attr);
 638         break;
 639       case OI_OPTION:
 640         if (!data->inSection)
 641             XML_FATAL1 ("<option> must be inside <section>.");
 642         if (data->inDesc)
 643             XML_FATAL1 ("<option> nested in <description> element.");
 644         if (data->inOption)
 645             XML_FATAL1 ("nested <option> elements.");
 646         data->inOption = true;
 647         parseOptInfoAttr (data, attr);
 648         break;
 649       case OI_ENUM:
 650         if (!(data->inOption && data->inDesc))
 651             XML_FATAL1 ("<enum> must be inside <option> and <description>.");
 652         if (data->inEnum)
 653             XML_FATAL1 ("nested <enum> elements.");
 654         data->inEnum = true;
 655         parseEnumAttr (data, attr);
 656         break;
 657       default:
 658         XML_FATAL ("unknown element: %s.", name);
 659     }
 660 }
 661
 662 /** \brief Handler for end element events. */
 663 static void optInfoEndElem (void *userData, const XML_Char *name) {
 664     struct OptInfoData *data = (struct OptInfoData *)userData;
 665     enum OptInfoElem elem = bsearchStr (name, OptInfoElems, OI_COUNT);
 666     switch (elem) {
 667       case OI_DRIINFO:
 668         data->inDriInfo = false;
 669         break;
 670       case OI_SECTION:
 671         data->inSection = false;
 672         break;
 673       case OI_DESCRIPTION:
 674         data->inDesc = false;
 675         break;
 676       case OI_OPTION:
 677         data->inOption = false;
 678         break;
 679       case OI_ENUM:
 680         data->inEnum = false;
 681         break;
 682       default:
 683         assert (0); /* should have been caught by StartElem */
 684     }
 685 }
 686
 687 void driParseOptionInfo (driOptionCache *info, const char *configOptions) {
 688     XML_Parser p;
 689     int status;
 690     struct OptInfoData userData;
 691     struct OptInfoData *data = &userData;
 692
 693     /* Make the hash table big enough to fit more than the maximum number of
 694      * config options we've ever seen in a driver.
 695      */
 696     info->tableSize = 6;
 697     info->info = calloc(1 << info->tableSize, sizeof (driOptionInfo));
 698     info->values = calloc(1 << info->tableSize, sizeof (driOptionValue));
 699     if (info->info == NULL || info->values == NULL) {
 700         fprintf (stderr, "%s: %d: out of memory.\n", __FILE__, __LINE__);
 701         abort();
 702     }
 703
 704     p = XML_ParserCreate ("UTF-8"); /* always UTF-8 */
 705     XML_SetElementHandler (p, optInfoStartElem, optInfoEndElem);
 706     XML_SetUserData (p, data);
 707
 708     userData.name = "__driConfigOptions";
 709     userData.parser = p;
 710     userData.cache = info;
 711     userData.inDriInfo = false;
 712     userData.inSection = false;
 713     userData.inDesc = false;
 714     userData.inOption = false;
 715     userData.inEnum = false;
 716     userData.curOption = -1;
 717
 718     status = XML_Parse (p, configOptions, strlen (configOptions), 1);
 719     if (!status)
 720         XML_FATAL ("%s.", XML_ErrorString(XML_GetErrorCode(p)));
 721
 722     XML_ParserFree (p);
 723 }
 724
 725 /** \brief Parser context for configuration files. */
 726 struct OptConfData {
 727     const char *name;
 728     XML_Parser parser;
 729     driOptionCache *cache;
 730     int screenNum;
 731     const char *driverName, *execName;
 732     uint32_t ignoringDevice;
 733     uint32_t ignoringApp;
 734     uint32_t inDriConf;
 735     uint32_t inDevice;
 736     uint32_t inApp;
 737     uint32_t inOption;
 738 };
 739
 740 /** \brief Elements in configuration files. */
 741 enum OptConfElem {
 742     OC_APPLICATION = 0, OC_DEVICE, OC_DRICONF, OC_OPTION, OC_COUNT
 743 };
 744 static const XML_Char *OptConfElems[] = {
 745     "application", "device", "driconf", "option"
 746 };
 747
 748 /** \brief Parse attributes of a device element. */
 749 static void parseDeviceAttr (struct OptConfData *data, const XML_Char **attr) {
 750     uint32_t i;
 751     const XML_Char *driver = NULL, *screen = NULL;
 752     for (i = 0; attr[i]; i += 2) {
 753         if (!strcmp (attr[i], "driver")) driver = attr[i+1];
 754         else if (!strcmp (attr[i], "screen")) screen = attr[i+1];
 755         else XML_WARNING("unknown device attribute: %s.", attr[i]);
 756     }
 757     if (driver && strcmp (driver, data->driverName))
 758         data->ignoringDevice = data->inDevice;
 759     else if (screen) {
 760         driOptionValue screenNum;
 761         if (!parseValue (&screenNum, DRI_INT, screen))
 762             XML_WARNING("illegal screen number: %s.", screen);
 763         else if (screenNum._int != data->screenNum)
 764             data->ignoringDevice = data->inDevice;
 765     }
 766 }
 767
 768 /** \brief Parse attributes of an application element. */
 769 static void parseAppAttr (struct OptConfData *data, const XML_Char **attr) {
 770     uint32_t i;
 771     const XML_Char *exec = NULL;
 772     for (i = 0; attr[i]; i += 2) {
 773         if (!strcmp (attr[i], "name")) /* not needed here */;
 774         else if (!strcmp (attr[i], "executable")) exec = attr[i+1];
 775         else XML_WARNING("unknown application attribute: %s.", attr[i]);
 776     }
 777     if (exec && strcmp (exec, data->execName))
 778         data->ignoringApp = data->inApp;
 779 }
 780
 781 /** \brief Parse attributes of an option element. */
 782 static void parseOptConfAttr (struct OptConfData *data, const XML_Char **attr) {
 783     uint32_t i;
 784     const XML_Char *name = NULL, *value = NULL;
 785     for (i = 0; attr[i]; i += 2) {
 786         if (!strcmp (attr[i], "name")) name = attr[i+1];
 787         else if (!strcmp (attr[i], "value")) value = attr[i+1];
 788         else XML_WARNING("unknown option attribute: %s.", attr[i]);
 789     }
 790     if (!name) XML_WARNING1 ("name attribute missing in option.");
 791     if (!value) XML_WARNING1 ("value attribute missing in option.");
 792     if (name && value) {
 793         driOptionCache *cache = data->cache;
 794         uint32_t opt = findOption (cache, name);
 795         if (cache->info[opt].name == NULL)
 796             /* don't use XML_WARNING, drirc defines options for all drivers,
 797              * but not all drivers support them */
 798             return;
 799         else if (getenv (cache->info[opt].name))
 800           /* don't use XML_WARNING, we want the user to see this! */
 801             fprintf (stderr, "ATTENTION: option value of option %s ignored.\n",
 802                      cache->info[opt].name);
 803         else if (!parseValue (&cache->values[opt], cache->info[opt].type, value))
 804             XML_WARNING ("illegal option value: %s.", value);
 805     }
 806 }
 807
 808 /** \brief Handler for start element events. */
 809 static void optConfStartElem (void *userData, const XML_Char *name,
 810                               const XML_Char **attr) {
 811     struct OptConfData *data = (struct OptConfData *)userData;
 812     enum OptConfElem elem = bsearchStr (name, OptConfElems, OC_COUNT);
 813     switch (elem) {
 814       case OC_DRICONF:
 815         if (data->inDriConf)
 816             XML_WARNING1 ("nested <driconf> elements.");
 817         if (attr[0])
 818             XML_WARNING1 ("attributes specified on <driconf> element.");
 819         data->inDriConf++;
 820         break;
 821       case OC_DEVICE:
 822         if (!data->inDriConf)
 823             XML_WARNING1 ("<device> should be inside <driconf>.");
 824         if (data->inDevice)
 825             XML_WARNING1 ("nested <device> elements.");
 826         data->inDevice++;
 827         if (!data->ignoringDevice && !data->ignoringApp)
 828             parseDeviceAttr (data, attr);
 829         break;
 830       case OC_APPLICATION:
 831         if (!data->inDevice)
 832             XML_WARNING1 ("<application> should be inside <device>.");
 833         if (data->inApp)
 834             XML_WARNING1 ("nested <application> elements.");
 835         data->inApp++;
 836         if (!data->ignoringDevice && !data->ignoringApp)
 837             parseAppAttr (data, attr);
 838         break;
 839       case OC_OPTION:
 840         if (!data->inApp)
 841             XML_WARNING1 ("<option> should be inside <application>.");
 842         if (data->inOption)
 843             XML_WARNING1 ("nested <option> elements.");
 844         data->inOption++;
 845         if (!data->ignoringDevice && !data->ignoringApp)
 846             parseOptConfAttr (data, attr);
 847         break;
 848       default:
 849         XML_WARNING ("unknown element: %s.", name);
 850     }
 851 }
 852
 853 /** \brief Handler for end element events. */
 854 static void optConfEndElem (void *userData, const XML_Char *name) {
 855     struct OptConfData *data = (struct OptConfData *)userData;
 856     enum OptConfElem elem = bsearchStr (name, OptConfElems, OC_COUNT);
 857     switch (elem) {
 858       case OC_DRICONF:
 859         data->inDriConf--;
 860         break;
 861       case OC_DEVICE:
 862         if (data->inDevice-- == data->ignoringDevice)
 863             data->ignoringDevice = 0;
 864         break;
 865       case OC_APPLICATION:
 866         if (data->inApp-- == data->ignoringApp)
 867             data->ignoringApp = 0;
 868         break;
 869       case OC_OPTION:
 870         data->inOption--;
 871         break;
 872       default:
 873         /* unknown element, warning was produced on start tag */;
 874     }
 875 }
 876
 877 /** \brief Initialize an option cache based on info */
 878 static void initOptionCache (driOptionCache *cache, const driOptionCache *info) {
 879     GLuint i, size = 1 << info->tableSize;
 880     cache->info = info->info;
 881     cache->tableSize = info->tableSize;
 882     cache->values = malloc((1<<info->tableSize) * sizeof (driOptionValue));
 883     if (cache->values == NULL) {
 884         fprintf (stderr, "%s: %d: out of memory.\n", __FILE__, __LINE__);
 885         abort();
 886     }
 887     memcpy (cache->values, info->values,
 888             (1<<info->tableSize) * sizeof (driOptionValue));
 889     for (i = 0; i < size; ++i) {
 890         if (cache->info[i].type == DRI_STRING)
 891             XSTRDUP(cache->values[i]._string, info->values[i]._string);
 892     }
 893 }
 894
 895 /** \brief Parse the named configuration file */
 896 static void parseOneConfigFile (XML_Parser p) {
 897 #define BUF_SIZE 0x1000
 898     struct OptConfData *data = (struct OptConfData *)XML_GetUserData (p);
 899     int status;
 900     int fd;
 901
 902     if ((fd = open (data->name, O_RDONLY)) == -1) {
 903         __driUtilMessage ("Can't open configuration file %s: %s.",
 904                           data->name, strerror (errno));
 905         return;
 906     }
 907
 908     while (1) {
 909         int bytesRead;
 910         void *buffer = XML_GetBuffer (p, BUF_SIZE);
 911         if (!buffer) {
 912             __driUtilMessage ("Can't allocate parser buffer.");
 913             break;
 914         }
 915         bytesRead = read (fd, buffer, BUF_SIZE);
 916         if (bytesRead == -1) {
 917             __driUtilMessage ("Error reading from configuration file %s: %s.",
 918                               data->name, strerror (errno));
 919             break;
 920         }
 921         status = XML_ParseBuffer (p, bytesRead, bytesRead == 0);
 922         if (!status) {
 923             XML_ERROR ("%s.", XML_ErrorString(XML_GetErrorCode(p)));
 924             break;
 925         }
 926         if (bytesRead == 0)
 927             break;
 928     }
 929
 930     close (fd);
 931 #undef BUF_SIZE
 932 }
 933
 934 void driParseConfigFiles (driOptionCache *cache, const driOptionCache *info,
 935                           int screenNum, const char *driverName) {
 936     char *filenames[2] = {"/etc/drirc", NULL};
 937     char *home;
 938     uint32_t i;
 939     struct OptConfData userData;
 940
 941     initOptionCache (cache, info);
 942
 943     userData.cache = cache;
 944     userData.screenNum = screenNum;
 945     userData.driverName = driverName;
 946     userData.execName = GET_PROGRAM_NAME();
 947
 948     if ((home = getenv ("HOME"))) {
 949         uint32_t len = strlen (home);
 950         filenames[1] = malloc(len + 7+1);
 951         if (filenames[1] == NULL)
 952             __driUtilMessage ("Can't allocate memory for %s/.drirc.", home);
 953         else {
 954             memcpy (filenames[1], home, len);
 955             memcpy (filenames[1] + len, "/.drirc", 7+1);
 956         }
 957     }
 958
 959     for (i = 0; i < 2; ++i) {
 960         XML_Parser p;
 961         if (filenames[i] == NULL)
 962             continue;
 963
 964         p = XML_ParserCreate (NULL); /* use encoding specified by file */
 965         XML_SetElementHandler (p, optConfStartElem, optConfEndElem);
 966         XML_SetUserData (p, &userData);
 967         userData.parser = p;
 968         userData.name = filenames[i];
 969         userData.ignoringDevice = 0;
 970         userData.ignoringApp = 0;
 971         userData.inDriConf = 0;
 972         userData.inDevice = 0;
 973         userData.inApp = 0;
 974         userData.inOption = 0;
 975
 976         parseOneConfigFile (p);
 977         XML_ParserFree (p);
 978     }
 979
 980     free(filenames[1]);
 981 }
 982
 983 void driDestroyOptionInfo (driOptionCache *info) {
 984     driDestroyOptionCache (info);
 985     if (info->info) {
 986         uint32_t i, size = 1 << info->tableSize;
 987         for (i = 0; i < size; ++i) {
 988             if (info->info[i].name) {
 989                 free(info->info[i].name);
 990                 free(info->info[i].ranges);
 991             }
 992         }
 993         free(info->info);
 994     }
 995 }
 996
 997 void driDestroyOptionCache (driOptionCache *cache) {
 998     if (cache->info) {
 999         GLuint i, size = 1 << cache->tableSize;
1000         for (i = 0; i < size; ++i) {
1001             if (cache->info[i].type == DRI_STRING)
1002                 free(cache->values[i]._string);
1003         }
1004     }
1005     free(cache->values);
1006 }
1007
1008 unsigned char driCheckOption (const driOptionCache *cache, const char *name,
1009                           driOptionType type) {
1010     uint32_t i = findOption (cache, name);
1011     return cache->info[i].name != NULL && cache->info[i].type == type;
1012 }
1013
1014 unsigned char driQueryOptionb (const driOptionCache *cache, const char *name) {
1015     uint32_t i = findOption (cache, name);
1016   /* make sure the option is defined and has the correct type */
1017     assert (cache->info[i].name != NULL);
1018     assert (cache->info[i].type == DRI_BOOL);
1019     return cache->values[i]._bool;
1020 }
1021
1022 int driQueryOptioni (const driOptionCache *cache, const char *name) {
1023     uint32_t i = findOption (cache, name);
1024   /* make sure the option is defined and has the correct type */
1025     assert (cache->info[i].name != NULL);
1026     assert (cache->info[i].type == DRI_INT || cache->info[i].type == DRI_ENUM);
1027     return cache->values[i]._int;
1028 }
1029
1030 float driQueryOptionf (const driOptionCache *cache, const char *name) {
1031     uint32_t i = findOption (cache, name);
1032   /* make sure the option is defined and has the correct type */
1033     assert (cache->info[i].name != NULL);
1034     assert (cache->info[i].type == DRI_FLOAT);
1035     return cache->values[i]._float;
1036 }
1037
1038 char *driQueryOptionstr (const driOptionCache *cache, const char *name) {
1039     GLuint i = findOption (cache, name);
1040   /* make sure the option is defined and has the correct type */
1041     assert (cache->info[i].name != NULL);
1042     assert (cache->info[i].type == DRI_STRING);
1043     return cache->values[i]._string;
1044 }