src/intel/common/gen_decoder.c

   1 /*
   2  * Copyright © 2016 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #include <stdio.h>
  25 #include <stdbool.h>
  26 #include <stdint.h>
  27 #include <stdarg.h>
  28 #include <string.h>
  29 #include <expat.h>
  30 #include <inttypes.h>
  31 #include <zlib.h>
  32
  33 #include <util/macros.h>
  34 #include <util/ralloc.h>
  35
  36 #include "gen_decoder.h"
  37
  38 #include "genxml/genX_xml.h"
  39
  40 #define XML_BUFFER_SIZE 4096
  41 #define MAX_VALUE_ITEMS 128
  42
  43 struct location {
  44    const char *filename;
  45    int line_number;
  46 };
  47
  48 struct parser_context {
  49    XML_Parser parser;
  50    int foo;
  51    struct location loc;
  52
  53    struct gen_group *group;
  54    struct gen_enum *enoom;
  55
  56    int n_values, n_allocated_values;
  57    struct gen_value **values;
  58
  59    struct gen_field *last_field;
  60
  61    struct gen_spec *spec;
  62 };
  63
  64 const char *
  65 gen_group_get_name(struct gen_group *group)
  66 {
  67    return group->name;
  68 }
  69
  70 uint32_t
  71 gen_group_get_opcode(struct gen_group *group)
  72 {
  73    return group->opcode;
  74 }
  75
  76 struct gen_group *
  77 gen_spec_find_struct(struct gen_spec *spec, const char *name)
  78 {
  79    struct hash_entry *entry = _mesa_hash_table_search(spec->structs,
  80                                                       name);
  81    return entry ? entry->data : NULL;
  82 }
  83
  84 struct gen_group *
  85 gen_spec_find_register(struct gen_spec *spec, uint32_t offset)
  86 {
  87    struct hash_entry *entry =
  88       _mesa_hash_table_search(spec->registers_by_offset,
  89                               (void *) (uintptr_t) offset);
  90    return entry ? entry->data : NULL;
  91 }
  92
  93 struct gen_group *
  94 gen_spec_find_register_by_name(struct gen_spec *spec, const char *name)
  95 {
  96    struct hash_entry *entry =
  97       _mesa_hash_table_search(spec->registers_by_name, name);
  98    return entry ? entry->data : NULL;
  99 }
 100
 101 struct gen_enum *
 102 gen_spec_find_enum(struct gen_spec *spec, const char *name)
 103 {
 104    struct hash_entry *entry = _mesa_hash_table_search(spec->enums,
 105                                                       name);
 106    return entry ? entry->data : NULL;
 107 }
 108
 109 uint32_t
 110 gen_spec_get_gen(struct gen_spec *spec)
 111 {
 112    return spec->gen;
 113 }
 114
 115 static void __attribute__((noreturn))
 116 fail(struct location *loc, const char *msg, ...)
 117 {
 118    va_list ap;
 119
 120    va_start(ap, msg);
 121    fprintf(stderr, "%s:%d: error: ",
 122            loc->filename, loc->line_number);
 123    vfprintf(stderr, msg, ap);
 124    fprintf(stderr, "\n");
 125    va_end(ap);
 126    exit(EXIT_FAILURE);
 127 }
 128
 129 static void
 130 get_group_offset_count(const char **atts, uint32_t *offset, uint32_t *count,
 131                        uint32_t *size, bool *variable)
 132 {
 133    for (int i = 0; atts[i]; i += 2) {
 134       char *p;
 135
 136       if (strcmp(atts[i], "count") == 0) {
 137          *count = strtoul(atts[i + 1], &p, 0);
 138          if (*count == 0)
 139             *variable = true;
 140       } else if (strcmp(atts[i], "start") == 0) {
 141          *offset = strtoul(atts[i + 1], &p, 0);
 142       } else if (strcmp(atts[i], "size") == 0) {
 143          *size = strtoul(atts[i + 1], &p, 0);
 144       }
 145    }
 146    return;
 147 }
 148
 149 static struct gen_group *
 150 create_group(struct parser_context *ctx,
 151              const char *name,
 152              const char **atts,
 153              struct gen_group *parent)
 154 {
 155    struct gen_group *group;
 156
 157    group = rzalloc(ctx->spec, struct gen_group);
 158    if (name)
 159       group->name = ralloc_strdup(group, name);
 160
 161    group->spec = ctx->spec;
 162    group->variable = false;
 163
 164    for (int i = 0; atts[i]; i += 2) {
 165       char *p;
 166       if (strcmp(atts[i], "length") == 0) {
 167          group->dw_length = strtoul(atts[i + 1], &p, 0);
 168       }
 169    }
 170
 171    if (parent) {
 172       group->parent = parent;
 173       get_group_offset_count(atts,
 174                              &group->group_offset,
 175                              &group->group_count,
 176                              &group->group_size,
 177                              &group->variable);
 178    }
 179
 180    return group;
 181 }
 182
 183 static struct gen_enum *
 184 create_enum(struct parser_context *ctx, const char *name, const char **atts)
 185 {
 186    struct gen_enum *e;
 187
 188    e = rzalloc(ctx->spec, struct gen_enum);
 189    if (name)
 190       e->name = ralloc_strdup(e, name);
 191
 192    return e;
 193 }
 194
 195 static void
 196 get_register_offset(const char **atts, uint32_t *offset)
 197 {
 198    for (int i = 0; atts[i]; i += 2) {
 199       char *p;
 200
 201       if (strcmp(atts[i], "num") == 0)
 202          *offset = strtoul(atts[i + 1], &p, 0);
 203    }
 204    return;
 205 }
 206
 207 static void
 208 get_start_end_pos(int *start, int *end)
 209 {
 210    /* start value has to be mod with 32 as we need the relative
 211     * start position in the first DWord. For the end position, add
 212     * the length of the field to the start position to get the
 213     * relative postion in the 64 bit address.
 214     */
 215    if (*end - *start > 32) {
 216       int len = *end - *start;
 217       *start = *start % 32;
 218       *end = *start + len;
 219    } else {
 220       *start = *start % 32;
 221       *end = *end % 32;
 222    }
 223
 224    return;
 225 }
 226
 227 static inline uint64_t
 228 mask(int start, int end)
 229 {
 230    uint64_t v;
 231
 232    v = ~0ULL >> (63 - end + start);
 233
 234    return v << start;
 235 }
 236
 237 static inline uint64_t
 238 field(uint64_t value, int start, int end)
 239 {
 240    get_start_end_pos(&start, &end);
 241    return (value & mask(start, end)) >> (start);
 242 }
 243
 244 static inline uint64_t
 245 field_address(uint64_t value, int start, int end)
 246 {
 247    /* no need to right shift for address/offset */
 248    get_start_end_pos(&start, &end);
 249    return (value & mask(start, end));
 250 }
 251
 252 static struct gen_type
 253 string_to_type(struct parser_context *ctx, const char *s)
 254 {
 255    int i, f;
 256    struct gen_group *g;
 257    struct gen_enum *e;
 258
 259    if (strcmp(s, "int") == 0)
 260       return (struct gen_type) { .kind = GEN_TYPE_INT };
 261    else if (strcmp(s, "uint") == 0)
 262       return (struct gen_type) { .kind = GEN_TYPE_UINT };
 263    else if (strcmp(s, "bool") == 0)
 264       return (struct gen_type) { .kind = GEN_TYPE_BOOL };
 265    else if (strcmp(s, "float") == 0)
 266       return (struct gen_type) { .kind = GEN_TYPE_FLOAT };
 267    else if (strcmp(s, "address") == 0)
 268       return (struct gen_type) { .kind = GEN_TYPE_ADDRESS };
 269    else if (strcmp(s, "offset") == 0)
 270       return (struct gen_type) { .kind = GEN_TYPE_OFFSET };
 271    else if (sscanf(s, "u%d.%d", &i, &f) == 2)
 272       return (struct gen_type) { .kind = GEN_TYPE_UFIXED, .i = i, .f = f };
 273    else if (sscanf(s, "s%d.%d", &i, &f) == 2)
 274       return (struct gen_type) { .kind = GEN_TYPE_SFIXED, .i = i, .f = f };
 275    else if (g = gen_spec_find_struct(ctx->spec, s), g != NULL)
 276       return (struct gen_type) { .kind = GEN_TYPE_STRUCT, .gen_struct = g };
 277    else if (e = gen_spec_find_enum(ctx->spec, s), e != NULL)
 278       return (struct gen_type) { .kind = GEN_TYPE_ENUM, .gen_enum = e };
 279    else if (strcmp(s, "mbo") == 0)
 280       return (struct gen_type) { .kind = GEN_TYPE_MBO };
 281    else
 282       fail(&ctx->loc, "invalid type: %s", s);
 283 }
 284
 285 static struct gen_field *
 286 create_field(struct parser_context *ctx, const char **atts)
 287 {
 288    struct gen_field *field;
 289
 290    field = rzalloc(ctx->group, struct gen_field);
 291
 292    for (int i = 0; atts[i]; i += 2) {
 293       char *p;
 294
 295       if (strcmp(atts[i], "name") == 0)
 296          field->name = ralloc_strdup(field, atts[i + 1]);
 297       else if (strcmp(atts[i], "start") == 0)
 298          field->start = strtoul(atts[i + 1], &p, 0);
 299       else if (strcmp(atts[i], "end") == 0) {
 300          field->end = strtoul(atts[i + 1], &p, 0);
 301       } else if (strcmp(atts[i], "type") == 0)
 302          field->type = string_to_type(ctx, atts[i + 1]);
 303       else if (strcmp(atts[i], "default") == 0 &&
 304                field->start >= 16 && field->end <= 31) {
 305          field->has_default = true;
 306          field->default_value = strtoul(atts[i + 1], &p, 0);
 307       }
 308    }
 309
 310    return field;
 311 }
 312
 313 static struct gen_value *
 314 create_value(struct parser_context *ctx, const char **atts)
 315 {
 316    struct gen_value *value = rzalloc(ctx->values, struct gen_value);
 317
 318    for (int i = 0; atts[i]; i += 2) {
 319       if (strcmp(atts[i], "name") == 0)
 320          value->name = ralloc_strdup(value, atts[i + 1]);
 321       else if (strcmp(atts[i], "value") == 0)
 322          value->value = strtoul(atts[i + 1], NULL, 0);
 323    }
 324
 325    return value;
 326 }
 327
 328 static struct gen_field *
 329 create_and_append_field(struct parser_context *ctx,
 330                         const char **atts)
 331 {
 332    struct gen_field *field = create_field(ctx, atts);
 333    struct gen_field *prev = NULL, *list = ctx->group->fields;
 334
 335    while (list && field->start > list->start) {
 336       prev = list;
 337       list = list->next;
 338    }
 339
 340    field->next = list;
 341    if (prev == NULL)
 342       ctx->group->fields = field;
 343    else
 344       prev->next = field;
 345
 346    return field;
 347 }
 348
 349 static void
 350 start_element(void *data, const char *element_name, const char **atts)
 351 {
 352    struct parser_context *ctx = data;
 353    const char *name = NULL;
 354    const char *gen = NULL;
 355
 356    ctx->loc.line_number = XML_GetCurrentLineNumber(ctx->parser);
 357
 358    for (int i = 0; atts[i]; i += 2) {
 359       if (strcmp(atts[i], "name") == 0)
 360          name = atts[i + 1];
 361       else if (strcmp(atts[i], "gen") == 0)
 362          gen = atts[i + 1];
 363    }
 364
 365    if (strcmp(element_name, "genxml") == 0) {
 366       if (name == NULL)
 367          fail(&ctx->loc, "no platform name given");
 368       if (gen == NULL)
 369          fail(&ctx->loc, "no gen given");
 370
 371       int major, minor;
 372       int n = sscanf(gen, "%d.%d", &major, &minor);
 373       if (n == 0)
 374          fail(&ctx->loc, "invalid gen given: %s", gen);
 375       if (n == 1)
 376          minor = 0;
 377
 378       ctx->spec->gen = gen_make_gen(major, minor);
 379    } else if (strcmp(element_name, "instruction") == 0 ||
 380               strcmp(element_name, "struct") == 0) {
 381       ctx->group = create_group(ctx, name, atts, NULL);
 382    } else if (strcmp(element_name, "register") == 0) {
 383       ctx->group = create_group(ctx, name, atts, NULL);
 384       get_register_offset(atts, &ctx->group->register_offset);
 385    } else if (strcmp(element_name, "group") == 0) {
 386       struct gen_group *previous_group = ctx->group;
 387       while (previous_group->next)
 388          previous_group = previous_group->next;
 389
 390       struct gen_group *group = create_group(ctx, "", atts, ctx->group);
 391       previous_group->next = group;
 392       ctx->group = group;
 393    } else if (strcmp(element_name, "field") == 0) {
 394       ctx->last_field = create_and_append_field(ctx, atts);
 395    } else if (strcmp(element_name, "enum") == 0) {
 396       ctx->enoom = create_enum(ctx, name, atts);
 397    } else if (strcmp(element_name, "value") == 0) {
 398       if (ctx->n_values >= ctx->n_allocated_values) {
 399          ctx->n_allocated_values = MAX2(2, ctx->n_allocated_values * 2);
 400          ctx->values = reralloc_array_size(ctx->spec, ctx->values,
 401                                            sizeof(struct gen_value *),
 402                                            ctx->n_allocated_values);
 403       }
 404       assert(ctx->n_values < ctx->n_allocated_values);
 405       ctx->values[ctx->n_values++] = create_value(ctx, atts);
 406    }
 407
 408 }
 409
 410 static void
 411 end_element(void *data, const char *name)
 412 {
 413    struct parser_context *ctx = data;
 414    struct gen_spec *spec = ctx->spec;
 415
 416    if (strcmp(name, "instruction") == 0 ||
 417        strcmp(name, "struct") == 0 ||
 418        strcmp(name, "register") == 0) {
 419       struct gen_group *group = ctx->group;
 420       struct gen_field *list = group->fields;
 421
 422       ctx->group = ctx->group->parent;
 423
 424       while (list && list->end <= 31) {
 425          if (list->start >= 16 && list->has_default) {
 426             group->opcode_mask |=
 427                mask(list->start % 32, list->end % 32);
 428             group->opcode |= list->default_value << list->start;
 429          }
 430          list = list->next;
 431       }
 432
 433       if (strcmp(name, "instruction") == 0)
 434          _mesa_hash_table_insert(spec->commands, group->name, group);
 435       else if (strcmp(name, "struct") == 0)
 436          _mesa_hash_table_insert(spec->structs, group->name, group);
 437       else if (strcmp(name, "register") == 0) {
 438          _mesa_hash_table_insert(spec->registers_by_name, group->name, group);
 439          _mesa_hash_table_insert(spec->registers_by_offset,
 440                                  (void *) (uintptr_t) group->register_offset,
 441                                  group);
 442       }
 443    } else if (strcmp(name, "group") == 0) {
 444       ctx->group = ctx->group->parent;
 445    } else if (strcmp(name, "field") == 0) {
 446       struct gen_field *field = ctx->last_field;
 447       ctx->last_field = NULL;
 448       field->inline_enum.values = ctx->values;
 449       field->inline_enum.nvalues = ctx->n_values;
 450       ctx->values = ralloc_array(ctx->spec, struct gen_value*, ctx->n_allocated_values = 2);
 451       ctx->n_values = 0;
 452    } else if (strcmp(name, "enum") == 0) {
 453       struct gen_enum *e = ctx->enoom;
 454       e->values = ctx->values;
 455       e->nvalues = ctx->n_values;
 456       ctx->values = ralloc_array(ctx->spec, struct gen_value*, ctx->n_allocated_values = 2);
 457       ctx->n_values = 0;
 458       ctx->enoom = NULL;
 459       _mesa_hash_table_insert(spec->enums, e->name, e);
 460    }
 461 }
 462
 463 static void
 464 character_data(void *data, const XML_Char *s, int len)
 465 {
 466 }
 467
 468 static int
 469 devinfo_to_gen(const struct gen_device_info *devinfo)
 470 {
 471    int value = 10 * devinfo->gen;
 472
 473    if (devinfo->is_baytrail || devinfo->is_haswell)
 474       value += 5;
 475
 476    return value;
 477 }
 478
 479 static uint32_t zlib_inflate(const void *compressed_data,
 480                              uint32_t compressed_len,
 481                              void **out_ptr)
 482 {
 483    struct z_stream_s zstream;
 484    void *out;
 485
 486    memset(&zstream, 0, sizeof(zstream));
 487
 488    zstream.next_in = (unsigned char *)compressed_data;
 489    zstream.avail_in = compressed_len;
 490
 491    if (inflateInit(&zstream) != Z_OK)
 492       return 0;
 493
 494    out = malloc(4096);
 495    zstream.next_out = out;
 496    zstream.avail_out = 4096;
 497
 498    do {
 499       switch (inflate(&zstream, Z_SYNC_FLUSH)) {
 500       case Z_STREAM_END:
 501          goto end;
 502       case Z_OK:
 503          break;
 504       default:
 505          inflateEnd(&zstream);
 506          return 0;
 507       }
 508
 509       if (zstream.avail_out)
 510          break;
 511
 512       out = realloc(out, 2*zstream.total_out);
 513       if (out == NULL) {
 514          inflateEnd(&zstream);
 515          return 0;
 516       }
 517
 518       zstream.next_out = (unsigned char *)out + zstream.total_out;
 519       zstream.avail_out = zstream.total_out;
 520    } while (1);
 521  end:
 522    inflateEnd(&zstream);
 523    *out_ptr = out;
 524    return zstream.total_out;
 525 }
 526
 527 static uint32_t _hash_uint32(const void *key)
 528 {
 529    return (uint32_t) (uintptr_t) key;
 530 }
 531
 532 struct gen_spec *
 533 gen_spec_load(const struct gen_device_info *devinfo)
 534 {
 535    struct parser_context ctx;
 536    void *buf;
 537    uint8_t *text_data = NULL;
 538    uint32_t text_offset = 0, text_length = 0, total_length;
 539    uint32_t gen_10 = devinfo_to_gen(devinfo);
 540
 541    for (int i = 0; i < ARRAY_SIZE(genxml_files_table); i++) {
 542       if (genxml_files_table[i].gen_10 == gen_10) {
 543          text_offset = genxml_files_table[i].offset;
 544          text_length = genxml_files_table[i].length;
 545          break;
 546       }
 547    }
 548
 549    if (text_length == 0) {
 550       fprintf(stderr, "unable to find gen (%u) data\n", gen_10);
 551       return NULL;
 552    }
 553
 554    memset(&ctx, 0, sizeof ctx);
 555    ctx.parser = XML_ParserCreate(NULL);
 556    XML_SetUserData(ctx.parser, &ctx);
 557    if (ctx.parser == NULL) {
 558       fprintf(stderr, "failed to create parser\n");
 559       return NULL;
 560    }
 561
 562    XML_SetElementHandler(ctx.parser, start_element, end_element);
 563    XML_SetCharacterDataHandler(ctx.parser, character_data);
 564
 565    ctx.spec = rzalloc(NULL, struct gen_spec);
 566
 567    ctx.spec->commands =
 568       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 569    ctx.spec->structs =
 570       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 571    ctx.spec->registers_by_name =
 572       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 573    ctx.spec->registers_by_offset =
 574       _mesa_hash_table_create(ctx.spec, _hash_uint32, _mesa_key_pointer_equal);
 575    ctx.spec->enums =
 576       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 577
 578    total_length = zlib_inflate(compress_genxmls,
 579                                sizeof(compress_genxmls),
 580                                (void **) &text_data);
 581    assert(text_offset + text_length <= total_length);
 582
 583    buf = XML_GetBuffer(ctx.parser, text_length);
 584    memcpy(buf, &text_data[text_offset], text_length);
 585
 586    if (XML_ParseBuffer(ctx.parser, text_length, true) == 0) {
 587       fprintf(stderr,
 588               "Error parsing XML at line %ld col %ld byte %ld/%u: %s\n",
 589               XML_GetCurrentLineNumber(ctx.parser),
 590               XML_GetCurrentColumnNumber(ctx.parser),
 591               XML_GetCurrentByteIndex(ctx.parser), text_length,
 592               XML_ErrorString(XML_GetErrorCode(ctx.parser)));
 593       XML_ParserFree(ctx.parser);
 594       free(text_data);
 595       return NULL;
 596    }
 597
 598    XML_ParserFree(ctx.parser);
 599    free(text_data);
 600
 601    return ctx.spec;
 602 }
 603
 604 struct gen_spec *
 605 gen_spec_load_from_path(const struct gen_device_info *devinfo,
 606                         const char *path)
 607 {
 608    struct parser_context ctx;
 609    size_t len, filename_len = strlen(path) + 20;
 610    char *filename = malloc(filename_len);
 611    void *buf;
 612    FILE *input;
 613
 614    len = snprintf(filename, filename_len, "%s/gen%i.xml",
 615                   path, devinfo_to_gen(devinfo));
 616    assert(len < filename_len);
 617
 618    input = fopen(filename, "r");
 619    if (input == NULL) {
 620       fprintf(stderr, "failed to open xml description\n");
 621       free(filename);
 622       return NULL;
 623    }
 624
 625    memset(&ctx, 0, sizeof ctx);
 626    ctx.parser = XML_ParserCreate(NULL);
 627    XML_SetUserData(ctx.parser, &ctx);
 628    if (ctx.parser == NULL) {
 629       fprintf(stderr, "failed to create parser\n");
 630       fclose(input);
 631       free(filename);
 632       return NULL;
 633    }
 634
 635    XML_SetElementHandler(ctx.parser, start_element, end_element);
 636    XML_SetCharacterDataHandler(ctx.parser, character_data);
 637    ctx.loc.filename = filename;
 638    ctx.spec = rzalloc(NULL, struct gen_spec);
 639
 640    do {
 641       buf = XML_GetBuffer(ctx.parser, XML_BUFFER_SIZE);
 642       len = fread(buf, 1, XML_BUFFER_SIZE, input);
 643       if (len == 0) {
 644          fprintf(stderr, "fread: %m\n");
 645          free(ctx.spec);
 646          ctx.spec = NULL;
 647          goto end;
 648       }
 649       if (XML_ParseBuffer(ctx.parser, len, len == 0) == 0) {
 650          fprintf(stderr,
 651                  "Error parsing XML at line %ld col %ld: %s\n",
 652                  XML_GetCurrentLineNumber(ctx.parser),
 653                  XML_GetCurrentColumnNumber(ctx.parser),
 654                  XML_ErrorString(XML_GetErrorCode(ctx.parser)));
 655          free(ctx.spec);
 656          ctx.spec = NULL;
 657          goto end;
 658       }
 659    } while (len > 0);
 660
 661  end:
 662    XML_ParserFree(ctx.parser);
 663
 664    fclose(input);
 665    free(filename);
 666
 667    return ctx.spec;
 668 }
 669
 670 void gen_spec_destroy(struct gen_spec *spec)
 671 {
 672    ralloc_free(spec);
 673 }
 674
 675 struct gen_group *
 676 gen_spec_find_instruction(struct gen_spec *spec, const uint32_t *p)
 677 {
 678    struct hash_entry *entry;
 679
 680    hash_table_foreach(spec->commands, entry) {
 681       struct gen_group *command = entry->data;
 682       uint32_t opcode = *p & command->opcode_mask;
 683       if (opcode == command->opcode)
 684          return command;
 685    }
 686
 687    return NULL;
 688 }
 689
 690 int
 691 gen_group_get_length(struct gen_group *group, const uint32_t *p)
 692 {
 693    uint32_t h = p[0];
 694    uint32_t type = field(h, 29, 31);
 695
 696    switch (type) {
 697    case 0: /* MI */ {
 698       uint32_t opcode = field(h, 23, 28);
 699       if (opcode < 16)
 700          return 1;
 701       else
 702          return field(h, 0, 7) + 2;
 703       break;
 704    }
 705
 706    case 2: /* BLT */ {
 707       return field(h, 0, 7) + 2;
 708    }
 709
 710    case 3: /* Render */ {
 711       uint32_t subtype = field(h, 27, 28);
 712       uint32_t opcode = field(h, 24, 26);
 713       uint16_t whole_opcode = field(h, 16, 31);
 714       switch (subtype) {
 715       case 0:
 716          if (whole_opcode == 0x6104 /* PIPELINE_SELECT_965 */)
 717             return 1;
 718          else if (opcode < 2)
 719             return field(h, 0, 7) + 2;
 720          else
 721             return -1;
 722       case 1:
 723          if (opcode < 2)
 724             return 1;
 725          else
 726             return -1;
 727       case 2: {
 728          if (opcode == 0)
 729             return field(h, 0, 7) + 2;
 730          else if (opcode < 3)
 731             return field(h, 0, 15) + 2;
 732          else
 733             return -1;
 734       }
 735       case 3:
 736          if (whole_opcode == 0x780b)
 737             return 1;
 738          else if (opcode < 4)
 739             return field(h, 0, 7) + 2;
 740          else
 741             return -1;
 742       }
 743    }
 744    }
 745
 746    return -1;
 747 }
 748
 749 static const char *
 750 gen_get_enum_name(struct gen_enum *e, uint64_t value)
 751 {
 752    for (int i = 0; i < e->nvalues; i++) {
 753       if (e->values[i]->value == value) {
 754          return e->values[i]->name;
 755       }
 756    }
 757    return NULL;
 758 }
 759
 760 static bool
 761 iter_more_fields(const struct gen_field_iterator *iter)
 762 {
 763    return iter->field != NULL && iter->field->next != NULL;
 764 }
 765
 766 static uint32_t
 767 iter_group_offset_bits(const struct gen_field_iterator *iter,
 768                        uint32_t group_iter)
 769 {
 770    return iter->group->group_offset + (group_iter * iter->group->group_size);
 771 }
 772
 773 static bool
 774 iter_more_groups(const struct gen_field_iterator *iter)
 775 {
 776    if (iter->group->variable) {
 777       return iter_group_offset_bits(iter, iter->group_iter + 1) <
 778               (gen_group_get_length(iter->group, iter->p) * 32);
 779    } else {
 780       return (iter->group_iter + 1) < iter->group->group_count ||
 781          iter->group->next != NULL;
 782    }
 783 }
 784
 785 static void
 786 iter_advance_group(struct gen_field_iterator *iter)
 787 {
 788    if (iter->group->variable)
 789       iter->group_iter++;
 790    else {
 791       if ((iter->group_iter + 1) < iter->group->group_count) {
 792          iter->group_iter++;
 793       } else {
 794          iter->group = iter->group->next;
 795          iter->group_iter = 0;
 796       }
 797    }
 798
 799    iter->field = iter->group->fields;
 800 }
 801
 802 static bool
 803 iter_advance_field(struct gen_field_iterator *iter)
 804 {
 805    while (!iter_more_fields(iter)) {
 806       if (!iter_more_groups(iter))
 807          return false;
 808
 809       iter_advance_group(iter);
 810    }
 811
 812    iter->field = iter->field->next;
 813    if (iter->field->name)
 814       strncpy(iter->name, iter->field->name, sizeof(iter->name));
 815    else
 816       memset(iter->name, 0, sizeof(iter->name));
 817
 818    int group_member_offset = iter_group_offset_bits(iter, iter->group_iter);
 819
 820    iter->start = group_member_offset + iter->field->start;
 821    iter->end = group_member_offset + iter->field->end;
 822    iter->dword = iter->start / 32;
 823    iter->struct_desc = NULL;
 824
 825    return true;
 826 }
 827
 828 static void
 829 gen_field_decode(struct gen_field_iterator *iter)
 830 {
 831    union {
 832       uint64_t qw;
 833       float f;
 834    } v;
 835
 836    if (iter->field->name)
 837       strncpy(iter->name, iter->field->name, sizeof(iter->name));
 838    else
 839       memset(iter->name, 0, sizeof(iter->name));
 840
 841    memset(&v, 0, sizeof(v));
 842
 843    if ((iter->field->end - iter->field->start) > 32) {
 844       if (&iter->p[iter->dword + 1] < iter->p_end)
 845          v.qw = ((uint64_t) iter->p[iter->dword+1] << 32);
 846       v.qw |= iter->p[iter->dword];
 847    } else
 848       v.qw = iter->p[iter->dword];
 849
 850    const char *enum_name = NULL;
 851
 852    switch (iter->field->type.kind) {
 853    case GEN_TYPE_UNKNOWN:
 854    case GEN_TYPE_INT: {
 855       uint64_t value = field(v.qw, iter->start, iter->end);
 856       snprintf(iter->value, sizeof(iter->value), "%"PRId64, value);
 857       enum_name = gen_get_enum_name(&iter->field->inline_enum, value);
 858       break;
 859    }
 860    case GEN_TYPE_UINT: {
 861       uint64_t value = field(v.qw, iter->start, iter->end);
 862       snprintf(iter->value, sizeof(iter->value), "%"PRIu64, value);
 863       enum_name = gen_get_enum_name(&iter->field->inline_enum, value);
 864       break;
 865    }
 866    case GEN_TYPE_BOOL: {
 867       const char *true_string =
 868          iter->print_colors ? "\e[0;35mtrue\e[0m" : "true";
 869       snprintf(iter->value, sizeof(iter->value), "%s",
 870                field(v.qw, iter->start, iter->end) ?
 871                true_string : "false");
 872       break;
 873    }
 874    case GEN_TYPE_FLOAT:
 875       snprintf(iter->value, sizeof(iter->value), "%f", v.f);
 876       break;
 877    case GEN_TYPE_ADDRESS:
 878    case GEN_TYPE_OFFSET:
 879       snprintf(iter->value, sizeof(iter->value), "0x%08"PRIx64,
 880                field_address(v.qw, iter->start, iter->end));
 881       break;
 882    case GEN_TYPE_STRUCT:
 883       snprintf(iter->value, sizeof(iter->value), "<struct %s>",
 884                iter->field->type.gen_struct->name);
 885       iter->struct_desc =
 886          gen_spec_find_struct(iter->group->spec,
 887                               iter->field->type.gen_struct->name);
 888       break;
 889    case GEN_TYPE_UFIXED:
 890       snprintf(iter->value, sizeof(iter->value), "%f",
 891                (float) field(v.qw, iter->start, iter->end) /
 892                (1 << iter->field->type.f));
 893       break;
 894    case GEN_TYPE_SFIXED:
 895       /* FIXME: Sign extend extracted field. */
 896       snprintf(iter->value, sizeof(iter->value), "%s", "foo");
 897       break;
 898    case GEN_TYPE_MBO:
 899        break;
 900    case GEN_TYPE_ENUM: {
 901       uint64_t value = field(v.qw, iter->start, iter->end);
 902       snprintf(iter->value, sizeof(iter->value),
 903                "%"PRId64, value);
 904       enum_name = gen_get_enum_name(iter->field->type.gen_enum, value);
 905       break;
 906    }
 907    }
 908
 909    if (strlen(iter->group->name) == 0) {
 910       int length = strlen(iter->name);
 911       snprintf(iter->name + length, sizeof(iter->name) - length,
 912                "[%i]", iter->group_iter);
 913    }
 914
 915    if (enum_name) {
 916       int length = strlen(iter->value);
 917       snprintf(iter->value + length, sizeof(iter->value) - length,
 918                " (%s)", enum_name);
 919    }
 920 }
 921
 922 void
 923 gen_field_iterator_init(struct gen_field_iterator *iter,
 924                         struct gen_group *group,
 925                         const uint32_t *p,
 926                         bool print_colors)
 927 {
 928    memset(iter, 0, sizeof(*iter));
 929
 930    iter->group = group;
 931    if (group->fields)
 932       iter->field = group->fields;
 933    else
 934       iter->field = group->next->fields;
 935    iter->p = p;
 936    iter->p_end = &p[gen_group_get_length(iter->group, iter->p)];
 937    iter->print_colors = print_colors;
 938
 939    gen_field_decode(iter);
 940 }
 941
 942 bool
 943 gen_field_iterator_next(struct gen_field_iterator *iter)
 944 {
 945    if (!iter_advance_field(iter))
 946       return false;
 947
 948    gen_field_decode(iter);
 949
 950    return true;
 951 }
 952
 953 static void
 954 print_dword_header(FILE *outfile,
 955                    struct gen_field_iterator *iter,
 956                    uint64_t offset, uint32_t dword)
 957 {
 958    fprintf(outfile, "0x%08"PRIx64":  0x%08x : Dword %d\n",
 959            offset + 4 * dword, iter->p[dword], dword);
 960 }
 961
 962 bool
 963 gen_group_header_is_header(struct gen_group *group, struct gen_field *field)
 964 {
 965    uint32_t bits;
 966
 967    if (field->start >= 32)
 968       return false;
 969
 970    bits = (1U << (field->end - field->start + 1)) - 1;
 971    bits <<= field->start;
 972
 973    return (group->opcode_mask & bits) != 0;
 974 }
 975
 976 void
 977 gen_print_group(FILE *outfile, struct gen_group *group,
 978                 uint64_t offset, const uint32_t *p, bool color)
 979 {
 980    struct gen_field_iterator iter;
 981    int last_dword = -1;
 982
 983    gen_field_iterator_init(&iter, group, p, color);
 984    do {
 985       if (last_dword != iter.dword) {
 986          for (int i = last_dword + 1; i <= iter.dword; i++)
 987             print_dword_header(outfile, &iter, offset, i);
 988          last_dword = iter.dword;
 989       }
 990       if (!gen_group_header_is_header(group, iter.field)) {
 991          fprintf(outfile, "    %s: %s\n", iter.name, iter.value);
 992          if (iter.struct_desc) {
 993             uint64_t struct_offset = offset + 4 * iter.dword;
 994             gen_print_group(outfile, iter.struct_desc, struct_offset,
 995                             &p[iter.dword], color);
 996          }
 997       }
 998    } while (gen_field_iterator_next(&iter));
 999 }