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_value(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    field->parent = ctx->group;
 292
 293    for (int i = 0; atts[i]; i += 2) {
 294       char *p;
 295
 296       if (strcmp(atts[i], "name") == 0)
 297          field->name = ralloc_strdup(field, atts[i + 1]);
 298       else if (strcmp(atts[i], "start") == 0)
 299          field->start = strtoul(atts[i + 1], &p, 0);
 300       else if (strcmp(atts[i], "end") == 0) {
 301          field->end = strtoul(atts[i + 1], &p, 0);
 302       } else if (strcmp(atts[i], "type") == 0)
 303          field->type = string_to_type(ctx, atts[i + 1]);
 304       else if (strcmp(atts[i], "default") == 0 &&
 305                field->start >= 16 && field->end <= 31) {
 306          field->has_default = true;
 307          field->default_value = strtoul(atts[i + 1], &p, 0);
 308       }
 309    }
 310
 311    return field;
 312 }
 313
 314 static struct gen_value *
 315 create_value(struct parser_context *ctx, const char **atts)
 316 {
 317    struct gen_value *value = rzalloc(ctx->values, struct gen_value);
 318
 319    for (int i = 0; atts[i]; i += 2) {
 320       if (strcmp(atts[i], "name") == 0)
 321          value->name = ralloc_strdup(value, atts[i + 1]);
 322       else if (strcmp(atts[i], "value") == 0)
 323          value->value = strtoul(atts[i + 1], NULL, 0);
 324    }
 325
 326    return value;
 327 }
 328
 329 static struct gen_field *
 330 create_and_append_field(struct parser_context *ctx,
 331                         const char **atts)
 332 {
 333    struct gen_field *field = create_field(ctx, atts);
 334    struct gen_field *prev = NULL, *list = ctx->group->fields;
 335
 336    while (list && field->start > list->start) {
 337       prev = list;
 338       list = list->next;
 339    }
 340
 341    field->next = list;
 342    if (prev == NULL)
 343       ctx->group->fields = field;
 344    else
 345       prev->next = field;
 346
 347    return field;
 348 }
 349
 350 static void
 351 start_element(void *data, const char *element_name, const char **atts)
 352 {
 353    struct parser_context *ctx = data;
 354    const char *name = NULL;
 355    const char *gen = NULL;
 356
 357    ctx->loc.line_number = XML_GetCurrentLineNumber(ctx->parser);
 358
 359    for (int i = 0; atts[i]; i += 2) {
 360       if (strcmp(atts[i], "name") == 0)
 361          name = atts[i + 1];
 362       else if (strcmp(atts[i], "gen") == 0)
 363          gen = atts[i + 1];
 364    }
 365
 366    if (strcmp(element_name, "genxml") == 0) {
 367       if (name == NULL)
 368          fail(&ctx->loc, "no platform name given");
 369       if (gen == NULL)
 370          fail(&ctx->loc, "no gen given");
 371
 372       int major, minor;
 373       int n = sscanf(gen, "%d.%d", &major, &minor);
 374       if (n == 0)
 375          fail(&ctx->loc, "invalid gen given: %s", gen);
 376       if (n == 1)
 377          minor = 0;
 378
 379       ctx->spec->gen = gen_make_gen(major, minor);
 380    } else if (strcmp(element_name, "instruction") == 0 ||
 381               strcmp(element_name, "struct") == 0) {
 382       ctx->group = create_group(ctx, name, atts, NULL);
 383    } else if (strcmp(element_name, "register") == 0) {
 384       ctx->group = create_group(ctx, name, atts, NULL);
 385       get_register_offset(atts, &ctx->group->register_offset);
 386    } else if (strcmp(element_name, "group") == 0) {
 387       struct gen_group *previous_group = ctx->group;
 388       while (previous_group->next)
 389          previous_group = previous_group->next;
 390
 391       struct gen_group *group = create_group(ctx, "", atts, ctx->group);
 392       previous_group->next = group;
 393       ctx->group = group;
 394    } else if (strcmp(element_name, "field") == 0) {
 395       ctx->last_field = create_and_append_field(ctx, atts);
 396    } else if (strcmp(element_name, "enum") == 0) {
 397       ctx->enoom = create_enum(ctx, name, atts);
 398    } else if (strcmp(element_name, "value") == 0) {
 399       if (ctx->n_values >= ctx->n_allocated_values) {
 400          ctx->n_allocated_values = MAX2(2, ctx->n_allocated_values * 2);
 401          ctx->values = reralloc_array_size(ctx->spec, ctx->values,
 402                                            sizeof(struct gen_value *),
 403                                            ctx->n_allocated_values);
 404       }
 405       assert(ctx->n_values < ctx->n_allocated_values);
 406       ctx->values[ctx->n_values++] = create_value(ctx, atts);
 407    }
 408
 409 }
 410
 411 static void
 412 end_element(void *data, const char *name)
 413 {
 414    struct parser_context *ctx = data;
 415    struct gen_spec *spec = ctx->spec;
 416
 417    if (strcmp(name, "instruction") == 0 ||
 418        strcmp(name, "struct") == 0 ||
 419        strcmp(name, "register") == 0) {
 420       struct gen_group *group = ctx->group;
 421       struct gen_field *list = group->fields;
 422
 423       ctx->group = ctx->group->parent;
 424
 425       while (list && list->end <= 31) {
 426          if (list->start >= 16 && list->has_default) {
 427             group->opcode_mask |=
 428                mask(list->start % 32, list->end % 32);
 429             group->opcode |= list->default_value << list->start;
 430          }
 431          list = list->next;
 432       }
 433
 434       if (strcmp(name, "instruction") == 0)
 435          _mesa_hash_table_insert(spec->commands, group->name, group);
 436       else if (strcmp(name, "struct") == 0)
 437          _mesa_hash_table_insert(spec->structs, group->name, group);
 438       else if (strcmp(name, "register") == 0) {
 439          _mesa_hash_table_insert(spec->registers_by_name, group->name, group);
 440          _mesa_hash_table_insert(spec->registers_by_offset,
 441                                  (void *) (uintptr_t) group->register_offset,
 442                                  group);
 443       }
 444    } else if (strcmp(name, "group") == 0) {
 445       ctx->group = ctx->group->parent;
 446    } else if (strcmp(name, "field") == 0) {
 447       struct gen_field *field = ctx->last_field;
 448       ctx->last_field = NULL;
 449       field->inline_enum.values = ctx->values;
 450       field->inline_enum.nvalues = ctx->n_values;
 451       ctx->values = ralloc_array(ctx->spec, struct gen_value*, ctx->n_allocated_values = 2);
 452       ctx->n_values = 0;
 453    } else if (strcmp(name, "enum") == 0) {
 454       struct gen_enum *e = ctx->enoom;
 455       e->values = ctx->values;
 456       e->nvalues = ctx->n_values;
 457       ctx->values = ralloc_array(ctx->spec, struct gen_value*, ctx->n_allocated_values = 2);
 458       ctx->n_values = 0;
 459       ctx->enoom = NULL;
 460       _mesa_hash_table_insert(spec->enums, e->name, e);
 461    }
 462 }
 463
 464 static void
 465 character_data(void *data, const XML_Char *s, int len)
 466 {
 467 }
 468
 469 static int
 470 devinfo_to_gen(const struct gen_device_info *devinfo)
 471 {
 472    int value = 10 * devinfo->gen;
 473
 474    if (devinfo->is_baytrail || devinfo->is_haswell)
 475       value += 5;
 476
 477    return value;
 478 }
 479
 480 static uint32_t zlib_inflate(const void *compressed_data,
 481                              uint32_t compressed_len,
 482                              void **out_ptr)
 483 {
 484    struct z_stream_s zstream;
 485    void *out;
 486
 487    memset(&zstream, 0, sizeof(zstream));
 488
 489    zstream.next_in = (unsigned char *)compressed_data;
 490    zstream.avail_in = compressed_len;
 491
 492    if (inflateInit(&zstream) != Z_OK)
 493       return 0;
 494
 495    out = malloc(4096);
 496    zstream.next_out = out;
 497    zstream.avail_out = 4096;
 498
 499    do {
 500       switch (inflate(&zstream, Z_SYNC_FLUSH)) {
 501       case Z_STREAM_END:
 502          goto end;
 503       case Z_OK:
 504          break;
 505       default:
 506          inflateEnd(&zstream);
 507          return 0;
 508       }
 509
 510       if (zstream.avail_out)
 511          break;
 512
 513       out = realloc(out, 2*zstream.total_out);
 514       if (out == NULL) {
 515          inflateEnd(&zstream);
 516          return 0;
 517       }
 518
 519       zstream.next_out = (unsigned char *)out + zstream.total_out;
 520       zstream.avail_out = zstream.total_out;
 521    } while (1);
 522  end:
 523    inflateEnd(&zstream);
 524    *out_ptr = out;
 525    return zstream.total_out;
 526 }
 527
 528 static uint32_t _hash_uint32(const void *key)
 529 {
 530    return (uint32_t) (uintptr_t) key;
 531 }
 532
 533 struct gen_spec *
 534 gen_spec_load(const struct gen_device_info *devinfo)
 535 {
 536    struct parser_context ctx;
 537    void *buf;
 538    uint8_t *text_data = NULL;
 539    uint32_t text_offset = 0, text_length = 0, total_length;
 540    uint32_t gen_10 = devinfo_to_gen(devinfo);
 541
 542    for (int i = 0; i < ARRAY_SIZE(genxml_files_table); i++) {
 543       if (genxml_files_table[i].gen_10 == gen_10) {
 544          text_offset = genxml_files_table[i].offset;
 545          text_length = genxml_files_table[i].length;
 546          break;
 547       }
 548    }
 549
 550    if (text_length == 0) {
 551       fprintf(stderr, "unable to find gen (%u) data\n", gen_10);
 552       return NULL;
 553    }
 554
 555    memset(&ctx, 0, sizeof ctx);
 556    ctx.parser = XML_ParserCreate(NULL);
 557    XML_SetUserData(ctx.parser, &ctx);
 558    if (ctx.parser == NULL) {
 559       fprintf(stderr, "failed to create parser\n");
 560       return NULL;
 561    }
 562
 563    XML_SetElementHandler(ctx.parser, start_element, end_element);
 564    XML_SetCharacterDataHandler(ctx.parser, character_data);
 565
 566    ctx.spec = rzalloc(NULL, struct gen_spec);
 567
 568    ctx.spec->commands =
 569       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 570    ctx.spec->structs =
 571       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 572    ctx.spec->registers_by_name =
 573       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 574    ctx.spec->registers_by_offset =
 575       _mesa_hash_table_create(ctx.spec, _hash_uint32, _mesa_key_pointer_equal);
 576    ctx.spec->enums =
 577       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 578
 579    total_length = zlib_inflate(compress_genxmls,
 580                                sizeof(compress_genxmls),
 581                                (void **) &text_data);
 582    assert(text_offset + text_length <= total_length);
 583
 584    buf = XML_GetBuffer(ctx.parser, text_length);
 585    memcpy(buf, &text_data[text_offset], text_length);
 586
 587    if (XML_ParseBuffer(ctx.parser, text_length, true) == 0) {
 588       fprintf(stderr,
 589               "Error parsing XML at line %ld col %ld byte %ld/%u: %s\n",
 590               XML_GetCurrentLineNumber(ctx.parser),
 591               XML_GetCurrentColumnNumber(ctx.parser),
 592               XML_GetCurrentByteIndex(ctx.parser), text_length,
 593               XML_ErrorString(XML_GetErrorCode(ctx.parser)));
 594       XML_ParserFree(ctx.parser);
 595       free(text_data);
 596       return NULL;
 597    }
 598
 599    XML_ParserFree(ctx.parser);
 600    free(text_data);
 601
 602    return ctx.spec;
 603 }
 604
 605 struct gen_spec *
 606 gen_spec_load_from_path(const struct gen_device_info *devinfo,
 607                         const char *path)
 608 {
 609    struct parser_context ctx;
 610    size_t len, filename_len = strlen(path) + 20;
 611    char *filename = malloc(filename_len);
 612    void *buf;
 613    FILE *input;
 614
 615    len = snprintf(filename, filename_len, "%s/gen%i.xml",
 616                   path, devinfo_to_gen(devinfo));
 617    assert(len < filename_len);
 618
 619    input = fopen(filename, "r");
 620    if (input == NULL) {
 621       fprintf(stderr, "failed to open xml description\n");
 622       free(filename);
 623       return NULL;
 624    }
 625
 626    memset(&ctx, 0, sizeof ctx);
 627    ctx.parser = XML_ParserCreate(NULL);
 628    XML_SetUserData(ctx.parser, &ctx);
 629    if (ctx.parser == NULL) {
 630       fprintf(stderr, "failed to create parser\n");
 631       fclose(input);
 632       free(filename);
 633       return NULL;
 634    }
 635
 636    XML_SetElementHandler(ctx.parser, start_element, end_element);
 637    XML_SetCharacterDataHandler(ctx.parser, character_data);
 638    ctx.loc.filename = filename;
 639    ctx.spec = rzalloc(NULL, struct gen_spec);
 640
 641    do {
 642       buf = XML_GetBuffer(ctx.parser, XML_BUFFER_SIZE);
 643       len = fread(buf, 1, XML_BUFFER_SIZE, input);
 644       if (len == 0) {
 645          fprintf(stderr, "fread: %m\n");
 646          free(ctx.spec);
 647          ctx.spec = NULL;
 648          goto end;
 649       }
 650       if (XML_ParseBuffer(ctx.parser, len, len == 0) == 0) {
 651          fprintf(stderr,
 652                  "Error parsing XML at line %ld col %ld: %s\n",
 653                  XML_GetCurrentLineNumber(ctx.parser),
 654                  XML_GetCurrentColumnNumber(ctx.parser),
 655                  XML_ErrorString(XML_GetErrorCode(ctx.parser)));
 656          free(ctx.spec);
 657          ctx.spec = NULL;
 658          goto end;
 659       }
 660    } while (len > 0);
 661
 662  end:
 663    XML_ParserFree(ctx.parser);
 664
 665    fclose(input);
 666    free(filename);
 667
 668    return ctx.spec;
 669 }
 670
 671 void gen_spec_destroy(struct gen_spec *spec)
 672 {
 673    ralloc_free(spec);
 674 }
 675
 676 struct gen_group *
 677 gen_spec_find_instruction(struct gen_spec *spec, const uint32_t *p)
 678 {
 679    struct hash_entry *entry;
 680
 681    hash_table_foreach(spec->commands, entry) {
 682       struct gen_group *command = entry->data;
 683       uint32_t opcode = *p & command->opcode_mask;
 684       if (opcode == command->opcode)
 685          return command;
 686    }
 687
 688    return NULL;
 689 }
 690
 691 int
 692 gen_group_get_length(struct gen_group *group, const uint32_t *p)
 693 {
 694    uint32_t h = p[0];
 695    uint32_t type = field_value(h, 29, 31);
 696
 697    switch (type) {
 698    case 0: /* MI */ {
 699       uint32_t opcode = field_value(h, 23, 28);
 700       if (opcode < 16)
 701          return 1;
 702       else
 703          return field_value(h, 0, 7) + 2;
 704       break;
 705    }
 706
 707    case 2: /* BLT */ {
 708       return field_value(h, 0, 7) + 2;
 709    }
 710
 711    case 3: /* Render */ {
 712       uint32_t subtype = field_value(h, 27, 28);
 713       uint32_t opcode = field_value(h, 24, 26);
 714       uint16_t whole_opcode = field_value(h, 16, 31);
 715       switch (subtype) {
 716       case 0:
 717          if (whole_opcode == 0x6104 /* PIPELINE_SELECT_965 */)
 718             return 1;
 719          else if (opcode < 2)
 720             return field_value(h, 0, 7) + 2;
 721          else
 722             return -1;
 723       case 1:
 724          if (opcode < 2)
 725             return 1;
 726          else
 727             return -1;
 728       case 2: {
 729          if (opcode == 0)
 730             return field_value(h, 0, 7) + 2;
 731          else if (opcode < 3)
 732             return field_value(h, 0, 15) + 2;
 733          else
 734             return -1;
 735       }
 736       case 3:
 737          if (whole_opcode == 0x780b)
 738             return 1;
 739          else if (opcode < 4)
 740             return field_value(h, 0, 7) + 2;
 741          else
 742             return -1;
 743       }
 744    }
 745    }
 746
 747    return -1;
 748 }
 749
 750 static const char *
 751 gen_get_enum_name(struct gen_enum *e, uint64_t value)
 752 {
 753    for (int i = 0; i < e->nvalues; i++) {
 754       if (e->values[i]->value == value) {
 755          return e->values[i]->name;
 756       }
 757    }
 758    return NULL;
 759 }
 760
 761 static bool
 762 iter_more_fields(const struct gen_field_iterator *iter)
 763 {
 764    return iter->field != NULL && iter->field->next != NULL;
 765 }
 766
 767 static uint32_t
 768 iter_group_offset_bits(const struct gen_field_iterator *iter,
 769                        uint32_t group_iter)
 770 {
 771    return iter->group->group_offset + (group_iter * iter->group->group_size);
 772 }
 773
 774 static bool
 775 iter_more_groups(const struct gen_field_iterator *iter)
 776 {
 777    if (iter->group->variable) {
 778       return iter_group_offset_bits(iter, iter->group_iter + 1) <
 779               (gen_group_get_length(iter->group, iter->p) * 32);
 780    } else {
 781       return (iter->group_iter + 1) < iter->group->group_count ||
 782          iter->group->next != NULL;
 783    }
 784 }
 785
 786 static void
 787 iter_advance_group(struct gen_field_iterator *iter)
 788 {
 789    if (iter->group->variable)
 790       iter->group_iter++;
 791    else {
 792       if ((iter->group_iter + 1) < iter->group->group_count) {
 793          iter->group_iter++;
 794       } else {
 795          iter->group = iter->group->next;
 796          iter->group_iter = 0;
 797       }
 798    }
 799
 800    iter->field = iter->group->fields;
 801 }
 802
 803 static bool
 804 iter_advance_field(struct gen_field_iterator *iter)
 805 {
 806    while (!iter_more_fields(iter)) {
 807       if (!iter_more_groups(iter))
 808          return false;
 809
 810       iter_advance_group(iter);
 811    }
 812
 813    iter->field = iter->field->next;
 814    if (iter->field->name)
 815       strncpy(iter->name, iter->field->name, sizeof(iter->name));
 816    else
 817       memset(iter->name, 0, sizeof(iter->name));
 818
 819    int group_member_offset = iter_group_offset_bits(iter, iter->group_iter);
 820
 821    iter->start = group_member_offset + iter->field->start;
 822    iter->end = group_member_offset + iter->field->end;
 823    iter->dword = iter->start / 32;
 824    iter->struct_desc = NULL;
 825
 826    return true;
 827 }
 828
 829 static void
 830 iter_decode_field(struct gen_field_iterator *iter)
 831 {
 832    union {
 833       uint64_t qw;
 834       float f;
 835    } v;
 836
 837    if (iter->field->name)
 838       strncpy(iter->name, iter->field->name, sizeof(iter->name));
 839    else
 840       memset(iter->name, 0, sizeof(iter->name));
 841
 842    memset(&v, 0, sizeof(v));
 843
 844    if ((iter->field->end - iter->field->start) > 32) {
 845       if (&iter->p[iter->dword + 1] < iter->p_end)
 846          v.qw = ((uint64_t) iter->p[iter->dword+1] << 32);
 847       v.qw |= iter->p[iter->dword];
 848    } else
 849       v.qw = iter->p[iter->dword];
 850
 851    const char *enum_name = NULL;
 852
 853    switch (iter->field->type.kind) {
 854    case GEN_TYPE_UNKNOWN:
 855    case GEN_TYPE_INT: {
 856       uint64_t value = field_value(v.qw, iter->field->start, iter->field->end);
 857       snprintf(iter->value, sizeof(iter->value), "%"PRId64, value);
 858       enum_name = gen_get_enum_name(&iter->field->inline_enum, value);
 859       break;
 860    }
 861    case GEN_TYPE_UINT: {
 862       uint64_t value = field_value(v.qw, iter->field->start, iter->field->end);
 863       snprintf(iter->value, sizeof(iter->value), "%"PRIu64, value);
 864       enum_name = gen_get_enum_name(&iter->field->inline_enum, value);
 865       break;
 866    }
 867    case GEN_TYPE_BOOL: {
 868       const char *true_string =
 869          iter->print_colors ? "\e[0;35mtrue\e[0m" : "true";
 870       snprintf(iter->value, sizeof(iter->value), "%s",
 871                field_value(v.qw, iter->field->start, iter->field->end) ?
 872                true_string : "false");
 873       break;
 874    }
 875    case GEN_TYPE_FLOAT:
 876       snprintf(iter->value, sizeof(iter->value), "%f", v.f);
 877       break;
 878    case GEN_TYPE_ADDRESS:
 879    case GEN_TYPE_OFFSET:
 880       snprintf(iter->value, sizeof(iter->value), "0x%08"PRIx64,
 881                field_address(v.qw, iter->start, iter->end));
 882       break;
 883    case GEN_TYPE_STRUCT:
 884       snprintf(iter->value, sizeof(iter->value), "<struct %s>",
 885                iter->field->type.gen_struct->name);
 886       iter->struct_desc =
 887          gen_spec_find_struct(iter->group->spec,
 888                               iter->field->type.gen_struct->name);
 889       break;
 890    case GEN_TYPE_UFIXED:
 891       snprintf(iter->value, sizeof(iter->value), "%f",
 892                (float) field_value(v.qw, iter->field->start,
 893                                    iter->field->end) / (1 << iter->field->type.f));
 894       break;
 895    case GEN_TYPE_SFIXED:
 896       /* FIXME: Sign extend extracted field. */
 897       snprintf(iter->value, sizeof(iter->value), "%s", "foo");
 898       break;
 899    case GEN_TYPE_MBO:
 900        break;
 901    case GEN_TYPE_ENUM: {
 902       uint64_t value = field_value(v.qw, iter->field->start, iter->field->end);
 903       snprintf(iter->value, sizeof(iter->value),
 904                "%"PRId64, value);
 905       enum_name = gen_get_enum_name(iter->field->type.gen_enum, value);
 906       break;
 907    }
 908    }
 909
 910    if (strlen(iter->group->name) == 0) {
 911       int length = strlen(iter->name);
 912       snprintf(iter->name + length, sizeof(iter->name) - length,
 913                "[%i]", iter->group_iter);
 914    }
 915
 916    if (enum_name) {
 917       int length = strlen(iter->value);
 918       snprintf(iter->value + length, sizeof(iter->value) - length,
 919                " (%s)", enum_name);
 920    }
 921 }
 922
 923 void
 924 gen_field_iterator_init(struct gen_field_iterator *iter,
 925                         struct gen_group *group,
 926                         const uint32_t *p,
 927                         bool print_colors)
 928 {
 929    memset(iter, 0, sizeof(*iter));
 930
 931    iter->group = group;
 932    if (group->fields)
 933       iter->field = group->fields;
 934    else
 935       iter->field = group->next->fields;
 936    iter->p = p;
 937    iter->p_end = &p[gen_group_get_length(iter->group, iter->p)];
 938    iter->print_colors = print_colors;
 939
 940    iter_decode_field(iter);
 941 }
 942
 943 bool
 944 gen_field_iterator_next(struct gen_field_iterator *iter)
 945 {
 946    if (!iter_advance_field(iter))
 947       return false;
 948
 949    iter_decode_field(iter);
 950
 951    return true;
 952 }
 953
 954 static void
 955 print_dword_header(FILE *outfile,
 956                    struct gen_field_iterator *iter,
 957                    uint64_t offset, uint32_t dword)
 958 {
 959    fprintf(outfile, "0x%08"PRIx64":  0x%08x : Dword %d\n",
 960            offset + 4 * dword, iter->p[dword], dword);
 961 }
 962
 963 bool
 964 gen_field_is_header(struct gen_field *field)
 965 {
 966    uint32_t bits;
 967
 968    if (field->start >= 32)
 969       return false;
 970
 971    bits = (1U << (field->end - field->start + 1)) - 1;
 972    bits <<= field->start;
 973
 974    return (field->parent->opcode_mask & bits) != 0;
 975 }
 976
 977 void
 978 gen_print_group(FILE *outfile, struct gen_group *group,
 979                 uint64_t offset, const uint32_t *p, bool color)
 980 {
 981    struct gen_field_iterator iter;
 982    int last_dword = -1;
 983
 984    gen_field_iterator_init(&iter, group, p, color);
 985    do {
 986       if (last_dword != iter.dword) {
 987          for (int i = last_dword + 1; i <= iter.dword; i++)
 988             print_dword_header(outfile, &iter, offset, i);
 989          last_dword = iter.dword;
 990       }
 991       if (!gen_field_is_header(iter.field)) {
 992          fprintf(outfile, "    %s: %s\n", iter.name, iter.value);
 993          if (iter.struct_desc) {
 994             uint64_t struct_offset = offset + 4 * iter.dword;
 995             gen_print_group(outfile, iter.struct_desc, struct_offset,
 996                             &p[iter.dword], color);
 997          }
 998       }
 999    } while (gen_field_iterator_next(&iter));
1000 }