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    const char *platform;
  53
  54    struct gen_group *group;
  55    struct gen_enum *enoom;
  56
  57    int n_values, n_allocated_values;
  58    struct gen_value **values;
  59
  60    struct gen_field *last_field;
  61
  62    struct gen_spec *spec;
  63 };
  64
  65 const char *
  66 gen_group_get_name(struct gen_group *group)
  67 {
  68    return group->name;
  69 }
  70
  71 uint32_t
  72 gen_group_get_opcode(struct gen_group *group)
  73 {
  74    return group->opcode;
  75 }
  76
  77 struct gen_group *
  78 gen_spec_find_struct(struct gen_spec *spec, const char *name)
  79 {
  80    struct hash_entry *entry = _mesa_hash_table_search(spec->structs,
  81                                                       name);
  82    return entry ? entry->data : NULL;
  83 }
  84
  85 struct gen_group *
  86 gen_spec_find_register(struct gen_spec *spec, uint32_t offset)
  87 {
  88    struct hash_entry *entry =
  89       _mesa_hash_table_search(spec->registers_by_offset,
  90                               (void *) (uintptr_t) offset);
  91    return entry ? entry->data : NULL;
  92 }
  93
  94 struct gen_group *
  95 gen_spec_find_register_by_name(struct gen_spec *spec, const char *name)
  96 {
  97    struct hash_entry *entry =
  98       _mesa_hash_table_search(spec->registers_by_name, name);
  99    return entry ? entry->data : NULL;
 100 }
 101
 102 struct gen_enum *
 103 gen_spec_find_enum(struct gen_spec *spec, const char *name)
 104 {
 105    struct hash_entry *entry = _mesa_hash_table_search(spec->enums,
 106                                                       name);
 107    return entry ? entry->data : NULL;
 108 }
 109
 110 uint32_t
 111 gen_spec_get_gen(struct gen_spec *spec)
 112 {
 113    return spec->gen;
 114 }
 115
 116 static void __attribute__((noreturn))
 117 fail(struct location *loc, const char *msg, ...)
 118 {
 119    va_list ap;
 120
 121    va_start(ap, msg);
 122    fprintf(stderr, "%s:%d: error: ",
 123            loc->filename, loc->line_number);
 124    vfprintf(stderr, msg, ap);
 125    fprintf(stderr, "\n");
 126    va_end(ap);
 127    exit(EXIT_FAILURE);
 128 }
 129
 130 static void
 131 get_group_offset_count(const char **atts, uint32_t *offset, uint32_t *count,
 132                        uint32_t *size, bool *variable)
 133 {
 134    char *p;
 135    int i;
 136
 137    for (i = 0; atts[i]; i += 2) {
 138       if (strcmp(atts[i], "count") == 0) {
 139          *count = strtoul(atts[i + 1], &p, 0);
 140          if (*count == 0)
 141             *variable = true;
 142       } else if (strcmp(atts[i], "start") == 0) {
 143          *offset = strtoul(atts[i + 1], &p, 0);
 144       } else if (strcmp(atts[i], "size") == 0) {
 145          *size = strtoul(atts[i + 1], &p, 0);
 146       }
 147    }
 148    return;
 149 }
 150
 151 static struct gen_group *
 152 create_group(struct parser_context *ctx,
 153              const char *name,
 154              const char **atts,
 155              struct gen_group *parent)
 156 {
 157    struct gen_group *group;
 158
 159    group = rzalloc(ctx->spec, struct gen_group);
 160    if (name)
 161       group->name = ralloc_strdup(group, name);
 162
 163    group->spec = ctx->spec;
 164    group->group_offset = 0;
 165    group->group_count = 0;
 166    group->variable = false;
 167
 168    if (parent) {
 169       group->parent = parent;
 170       get_group_offset_count(atts,
 171                              &group->group_offset,
 172                              &group->group_count,
 173                              &group->group_size,
 174                              &group->variable);
 175    }
 176
 177    return group;
 178 }
 179
 180 static struct gen_enum *
 181 create_enum(struct parser_context *ctx, const char *name, const char **atts)
 182 {
 183    struct gen_enum *e;
 184
 185    e = rzalloc(ctx->spec, struct gen_enum);
 186    if (name)
 187       e->name = ralloc_strdup(e, name);
 188
 189    e->nvalues = 0;
 190
 191    return e;
 192 }
 193
 194 static void
 195 get_register_offset(const char **atts, uint32_t *offset)
 196 {
 197    char *p;
 198    int i;
 199
 200    for (i = 0; atts[i]; i += 2) {
 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    char *p;
 290    int i;
 291
 292    field = rzalloc(ctx->group, struct gen_field);
 293
 294    for (i = 0; atts[i]; i += 2) {
 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    int i;
 354    const char *name = NULL;
 355    const char *gen = NULL;
 356
 357    ctx->loc.line_number = XML_GetCurrentLineNumber(ctx->parser);
 358
 359    for (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       ctx->platform = strdup(name);
 373       int major, minor;
 374       int n = sscanf(gen, "%d.%d", &major, &minor);
 375       if (n == 0)
 376          fail(&ctx->loc, "invalid gen given: %s", gen);
 377       if (n == 1)
 378          minor = 0;
 379
 380       ctx->spec->gen = gen_make_gen(major, minor);
 381    } else if (strcmp(element_name, "instruction") == 0 ||
 382               strcmp(element_name, "struct") == 0) {
 383       ctx->group = create_group(ctx, name, atts, NULL);
 384    } else if (strcmp(element_name, "register") == 0) {
 385       ctx->group = create_group(ctx, name, atts, NULL);
 386       get_register_offset(atts, &ctx->group->register_offset);
 387    } else if (strcmp(element_name, "group") == 0) {
 388       struct gen_group *previous_group = ctx->group;
 389       while (previous_group->next)
 390          previous_group = previous_group->next;
 391
 392       struct gen_group *group = create_group(ctx, "", atts, ctx->group);
 393       previous_group->next = group;
 394       ctx->group = group;
 395    } else if (strcmp(element_name, "field") == 0) {
 396       ctx->last_field = create_and_append_field(ctx, atts);
 397    } else if (strcmp(element_name, "enum") == 0) {
 398       ctx->enoom = create_enum(ctx, name, atts);
 399    } else if (strcmp(element_name, "value") == 0) {
 400       if (ctx->n_values >= ctx->n_allocated_values) {
 401          ctx->n_allocated_values = MAX2(2, ctx->n_allocated_values * 2);
 402          ctx->values = reralloc_array_size(ctx->spec, ctx->values,
 403                                            sizeof(struct gen_value *),
 404                                            ctx->n_allocated_values);
 405       }
 406       assert(ctx->n_values < ctx->n_allocated_values);
 407       ctx->values[ctx->n_values++] = create_value(ctx, atts);
 408    }
 409
 410 }
 411
 412 static void
 413 end_element(void *data, const char *name)
 414 {
 415    struct parser_context *ctx = data;
 416    struct gen_spec *spec = ctx->spec;
 417
 418    if (strcmp(name, "instruction") == 0 ||
 419        strcmp(name, "struct") == 0 ||
 420        strcmp(name, "register") == 0) {
 421       struct gen_group *group = ctx->group;
 422       struct gen_field *list = group->fields;
 423
 424       ctx->group = ctx->group->parent;
 425
 426       while (list && list->end <= 31) {
 427          if (list->start >= 16 && list->has_default) {
 428             group->opcode_mask |=
 429                mask(list->start % 32, list->end % 32);
 430             group->opcode |= list->default_value << list->start;
 431          }
 432          list = list->next;
 433       }
 434
 435       if (strcmp(name, "instruction") == 0)
 436          _mesa_hash_table_insert(spec->commands, group->name, group);
 437       else if (strcmp(name, "struct") == 0)
 438          _mesa_hash_table_insert(spec->structs, group->name, group);
 439       else if (strcmp(name, "register") == 0) {
 440          _mesa_hash_table_insert(spec->registers_by_name, group->name, group);
 441          _mesa_hash_table_insert(spec->registers_by_offset,
 442                                  (void *) (uintptr_t) group->register_offset,
 443                                  group);
 444       }
 445    } else if (strcmp(name, "group") == 0) {
 446       ctx->group = ctx->group->parent;
 447    } else if (strcmp(name, "field") == 0) {
 448       struct gen_field *field = ctx->last_field;
 449       ctx->last_field = NULL;
 450       field->inline_enum.values = ctx->values;
 451       field->inline_enum.nvalues = ctx->n_values;
 452       ctx->values = ralloc_array(ctx->spec, struct gen_value*, ctx->n_allocated_values = 2);
 453       ctx->n_values = 0;
 454    } else if (strcmp(name, "enum") == 0) {
 455       struct gen_enum *e = ctx->enoom;
 456       e->values = ctx->values;
 457       e->nvalues = ctx->n_values;
 458       ctx->values = ralloc_array(ctx->spec, struct gen_value*, ctx->n_allocated_values = 2);
 459       ctx->n_values = 0;
 460       ctx->enoom = NULL;
 461       _mesa_hash_table_insert(spec->enums, e->name, e);
 462    }
 463 }
 464
 465 static void
 466 character_data(void *data, const XML_Char *s, int len)
 467 {
 468 }
 469
 470 static int
 471 devinfo_to_gen(const struct gen_device_info *devinfo)
 472 {
 473    int value = 10 * devinfo->gen;
 474
 475    if (devinfo->is_baytrail || devinfo->is_haswell)
 476       value += 5;
 477
 478    return value;
 479 }
 480
 481 static uint32_t zlib_inflate(const void *compressed_data,
 482                              uint32_t compressed_len,
 483                              void **out_ptr)
 484 {
 485    struct z_stream_s zstream;
 486    void *out;
 487
 488    memset(&zstream, 0, sizeof(zstream));
 489
 490    zstream.next_in = (unsigned char *)compressed_data;
 491    zstream.avail_in = compressed_len;
 492
 493    if (inflateInit(&zstream) != Z_OK)
 494       return 0;
 495
 496    out = malloc(4096);
 497    zstream.next_out = out;
 498    zstream.avail_out = 4096;
 499
 500    do {
 501       switch (inflate(&zstream, Z_SYNC_FLUSH)) {
 502       case Z_STREAM_END:
 503          goto end;
 504       case Z_OK:
 505          break;
 506       default:
 507          inflateEnd(&zstream);
 508          return 0;
 509       }
 510
 511       if (zstream.avail_out)
 512          break;
 513
 514       out = realloc(out, 2*zstream.total_out);
 515       if (out == NULL) {
 516          inflateEnd(&zstream);
 517          return 0;
 518       }
 519
 520       zstream.next_out = (unsigned char *)out + zstream.total_out;
 521       zstream.avail_out = zstream.total_out;
 522    } while (1);
 523  end:
 524    inflateEnd(&zstream);
 525    *out_ptr = out;
 526    return zstream.total_out;
 527 }
 528
 529 static uint32_t _hash_uint32(const void *key)
 530 {
 531    return (uint32_t) (uintptr_t) key;
 532 }
 533
 534 struct gen_spec *
 535 gen_spec_load(const struct gen_device_info *devinfo)
 536 {
 537    struct parser_context ctx;
 538    void *buf;
 539    uint8_t *text_data = NULL;
 540    uint32_t text_offset = 0, text_length = 0, total_length;
 541    uint32_t gen_10 = devinfo_to_gen(devinfo);
 542
 543    for (int i = 0; i < ARRAY_SIZE(genxml_files_table); i++) {
 544       if (genxml_files_table[i].gen_10 == gen_10) {
 545          text_offset = genxml_files_table[i].offset;
 546          text_length = genxml_files_table[i].length;
 547          break;
 548       }
 549    }
 550
 551    if (text_length == 0) {
 552       fprintf(stderr, "unable to find gen (%u) data\n", gen_10);
 553       return NULL;
 554    }
 555
 556    memset(&ctx, 0, sizeof ctx);
 557    ctx.parser = XML_ParserCreate(NULL);
 558    XML_SetUserData(ctx.parser, &ctx);
 559    if (ctx.parser == NULL) {
 560       fprintf(stderr, "failed to create parser\n");
 561       return NULL;
 562    }
 563
 564    XML_SetElementHandler(ctx.parser, start_element, end_element);
 565    XML_SetCharacterDataHandler(ctx.parser, character_data);
 566
 567    ctx.spec = rzalloc(NULL, struct gen_spec);
 568
 569    ctx.spec->commands =
 570       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 571    ctx.spec->structs =
 572       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 573    ctx.spec->registers_by_name =
 574       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 575    ctx.spec->registers_by_offset =
 576       _mesa_hash_table_create(ctx.spec, _hash_uint32, _mesa_key_pointer_equal);
 577    ctx.spec->enums =
 578       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 579
 580    total_length = zlib_inflate(compress_genxmls,
 581                                sizeof(compress_genxmls),
 582                                (void **) &text_data);
 583    assert(text_offset + text_length <= total_length);
 584
 585    buf = XML_GetBuffer(ctx.parser, text_length);
 586    memcpy(buf, &text_data[text_offset], text_length);
 587
 588    if (XML_ParseBuffer(ctx.parser, text_length, true) == 0) {
 589       fprintf(stderr,
 590               "Error parsing XML at line %ld col %ld byte %ld/%u: %s\n",
 591               XML_GetCurrentLineNumber(ctx.parser),
 592               XML_GetCurrentColumnNumber(ctx.parser),
 593               XML_GetCurrentByteIndex(ctx.parser), text_length,
 594               XML_ErrorString(XML_GetErrorCode(ctx.parser)));
 595       XML_ParserFree(ctx.parser);
 596       free(text_data);
 597       return NULL;
 598    }
 599
 600    XML_ParserFree(ctx.parser);
 601    free(text_data);
 602
 603    return ctx.spec;
 604 }
 605
 606 struct gen_spec *
 607 gen_spec_load_from_path(const struct gen_device_info *devinfo,
 608                         const char *path)
 609 {
 610    struct parser_context ctx;
 611    size_t len, filename_len = strlen(path) + 20;
 612    char *filename = malloc(filename_len);
 613    void *buf;
 614    FILE *input;
 615
 616    len = snprintf(filename, filename_len, "%s/gen%i.xml",
 617                   path, devinfo_to_gen(devinfo));
 618    assert(len < filename_len);
 619
 620    input = fopen(filename, "r");
 621    if (input == NULL) {
 622       fprintf(stderr, "failed to open xml description\n");
 623       free(filename);
 624       return NULL;
 625    }
 626
 627    memset(&ctx, 0, sizeof ctx);
 628    ctx.parser = XML_ParserCreate(NULL);
 629    XML_SetUserData(ctx.parser, &ctx);
 630    if (ctx.parser == NULL) {
 631       fprintf(stderr, "failed to create parser\n");
 632       fclose(input);
 633       free(filename);
 634       return NULL;
 635    }
 636
 637    XML_SetElementHandler(ctx.parser, start_element, end_element);
 638    XML_SetCharacterDataHandler(ctx.parser, character_data);
 639    ctx.loc.filename = filename;
 640    ctx.spec = rzalloc(NULL, struct gen_spec);
 641
 642    do {
 643       buf = XML_GetBuffer(ctx.parser, XML_BUFFER_SIZE);
 644       len = fread(buf, 1, XML_BUFFER_SIZE, input);
 645       if (len == 0) {
 646          fprintf(stderr, "fread: %m\n");
 647          free(ctx.spec);
 648          ctx.spec = NULL;
 649          goto end;
 650       }
 651       if (XML_ParseBuffer(ctx.parser, len, len == 0) == 0) {
 652          fprintf(stderr,
 653                  "Error parsing XML at line %ld col %ld: %s\n",
 654                  XML_GetCurrentLineNumber(ctx.parser),
 655                  XML_GetCurrentColumnNumber(ctx.parser),
 656                  XML_ErrorString(XML_GetErrorCode(ctx.parser)));
 657          free(ctx.spec);
 658          ctx.spec = NULL;
 659          goto end;
 660       }
 661    } while (len > 0);
 662
 663  end:
 664    XML_ParserFree(ctx.parser);
 665
 666    fclose(input);
 667    free(filename);
 668
 669    return ctx.spec;
 670 }
 671
 672 void gen_spec_destroy(struct gen_spec *spec)
 673 {
 674    ralloc_free(spec);
 675 }
 676
 677 struct gen_group *
 678 gen_spec_find_instruction(struct gen_spec *spec, const uint32_t *p)
 679 {
 680    struct hash_entry *entry;
 681
 682    hash_table_foreach(spec->commands, entry) {
 683       struct gen_group *command = entry->data;
 684       uint32_t opcode = *p & command->opcode_mask;
 685       if (opcode == command->opcode)
 686          return command;
 687    }
 688
 689    return NULL;
 690 }
 691
 692 int
 693 gen_group_get_length(struct gen_group *group, const uint32_t *p)
 694 {
 695    uint32_t h = p[0];
 696    uint32_t type = field(h, 29, 31);
 697
 698    switch (type) {
 699    case 0: /* MI */ {
 700       uint32_t opcode = field(h, 23, 28);
 701       if (opcode < 16)
 702          return 1;
 703       else
 704          return field(h, 0, 7) + 2;
 705       break;
 706    }
 707
 708    case 2: /* BLT */ {
 709       return field(h, 0, 7) + 2;
 710    }
 711
 712    case 3: /* Render */ {
 713       uint32_t subtype = field(h, 27, 28);
 714       uint32_t opcode = field(h, 24, 26);
 715       uint16_t whole_opcode = field(h, 16, 31);
 716       switch (subtype) {
 717       case 0:
 718          if (whole_opcode == 0x6104 /* PIPELINE_SELECT_965 */)
 719             return 1;
 720          else if (opcode < 2)
 721             return field(h, 0, 7) + 2;
 722          else
 723             return -1;
 724       case 1:
 725          if (opcode < 2)
 726             return 1;
 727          else
 728             return -1;
 729       case 2: {
 730          if (opcode == 0)
 731             return field(h, 0, 7) + 2;
 732          else if (opcode < 3)
 733             return field(h, 0, 15) + 2;
 734          else
 735             return -1;
 736       }
 737       case 3:
 738          if (whole_opcode == 0x780b)
 739             return 1;
 740          else if (opcode < 4)
 741             return field(h, 0, 7) + 2;
 742          else
 743             return -1;
 744       }
 745    }
 746    }
 747
 748    return -1;
 749 }
 750
 751 static const char *
 752 gen_get_enum_name(struct gen_enum *e, uint64_t value)
 753 {
 754    for (int i = 0; i < e->nvalues; i++) {
 755       if (e->values[i]->value == value) {
 756          return e->values[i]->name;
 757       }
 758    }
 759    return NULL;
 760 }
 761
 762 static bool
 763 iter_more_fields(const struct gen_field_iterator *iter)
 764 {
 765    return iter->field != NULL && iter->field->next != NULL;
 766 }
 767
 768 static uint32_t
 769 iter_group_offset_bits(const struct gen_field_iterator *iter,
 770                        uint32_t group_iter)
 771 {
 772    return iter->group->group_offset + (group_iter * iter->group->group_size);
 773 }
 774
 775 static bool
 776 iter_more_groups(const struct gen_field_iterator *iter)
 777 {
 778    if (iter->group->variable) {
 779       return iter_group_offset_bits(iter, iter->group_iter + 1) <
 780               (gen_group_get_length(iter->group, iter->p) * 32);
 781    } else {
 782       return (iter->group_iter + 1) < iter->group->group_count ||
 783          iter->group->next != NULL;
 784    }
 785 }
 786
 787 static void
 788 iter_advance_group(struct gen_field_iterator *iter)
 789 {
 790    if (iter->group->variable)
 791       iter->group_iter++;
 792    else {
 793       if ((iter->group_iter + 1) < iter->group->group_count) {
 794          iter->group_iter++;
 795       } else {
 796          iter->group = iter->group->next;
 797          iter->group_iter = 0;
 798       }
 799    }
 800
 801    iter->field = iter->group->fields;
 802 }
 803
 804 static bool
 805 iter_advance_field(struct gen_field_iterator *iter)
 806 {
 807    while (!iter_more_fields(iter)) {
 808       if (!iter_more_groups(iter))
 809          return false;
 810
 811       iter_advance_group(iter);
 812    }
 813
 814    iter->field = iter->field->next;
 815    if (iter->field->name)
 816       strncpy(iter->name, iter->field->name, sizeof(iter->name));
 817    else
 818       memset(iter->name, 0, sizeof(iter->name));
 819
 820    int group_member_offset = iter_group_offset_bits(iter, iter->group_iter);
 821
 822    iter->start = group_member_offset + iter->field->start;
 823    iter->end = group_member_offset + iter->field->end;
 824    iter->dword = iter->start / 32;
 825    iter->struct_desc = NULL;
 826
 827    return true;
 828 }
 829
 830 static void
 831 gen_field_decode(struct gen_field_iterator *iter)
 832 {
 833    union {
 834       uint64_t qw;
 835       float f;
 836    } v;
 837
 838    if (iter->field->name)
 839       strncpy(iter->name, iter->field->name, sizeof(iter->name));
 840    else
 841       memset(iter->name, 0, sizeof(iter->name));
 842
 843    memset(&v, 0, sizeof(v));
 844
 845    if ((iter->field->end - iter->field->start) > 32) {
 846       if (&iter->p[iter->dword + 1] < iter->p_end)
 847          v.qw = ((uint64_t) iter->p[iter->dword+1] << 32);
 848       v.qw |= iter->p[iter->dword];
 849    } else
 850       v.qw = iter->p[iter->dword];
 851
 852    const char *enum_name = NULL;
 853
 854    switch (iter->field->type.kind) {
 855    case GEN_TYPE_UNKNOWN:
 856    case GEN_TYPE_INT: {
 857       uint64_t value = field(v.qw, iter->start, iter->end);
 858       snprintf(iter->value, sizeof(iter->value), "%"PRId64, value);
 859       enum_name = gen_get_enum_name(&iter->field->inline_enum, value);
 860       break;
 861    }
 862    case GEN_TYPE_UINT: {
 863       uint64_t value = field(v.qw, iter->start, iter->end);
 864       snprintf(iter->value, sizeof(iter->value), "%"PRIu64, value);
 865       enum_name = gen_get_enum_name(&iter->field->inline_enum, value);
 866       break;
 867    }
 868    case GEN_TYPE_BOOL: {
 869       const char *true_string =
 870          iter->print_colors ? "\e[0;35mtrue\e[0m" : "true";
 871       snprintf(iter->value, sizeof(iter->value), "%s",
 872                field(v.qw, iter->start, iter->end) ?
 873                true_string : "false");
 874       break;
 875    }
 876    case GEN_TYPE_FLOAT:
 877       snprintf(iter->value, sizeof(iter->value), "%f", v.f);
 878       break;
 879    case GEN_TYPE_ADDRESS:
 880    case GEN_TYPE_OFFSET:
 881       snprintf(iter->value, sizeof(iter->value), "0x%08"PRIx64,
 882                field_address(v.qw, iter->start, iter->end));
 883       break;
 884    case GEN_TYPE_STRUCT:
 885       snprintf(iter->value, sizeof(iter->value), "<struct %s>",
 886                iter->field->type.gen_struct->name);
 887       iter->struct_desc =
 888          gen_spec_find_struct(iter->group->spec,
 889                               iter->field->type.gen_struct->name);
 890       break;
 891    case GEN_TYPE_UFIXED:
 892       snprintf(iter->value, sizeof(iter->value), "%f",
 893                (float) field(v.qw, iter->start, iter->end) /
 894                (1 << iter->field->type.f));
 895       break;
 896    case GEN_TYPE_SFIXED:
 897       /* FIXME: Sign extend extracted field. */
 898       snprintf(iter->value, sizeof(iter->value), "%s", "foo");
 899       break;
 900    case GEN_TYPE_MBO:
 901        break;
 902    case GEN_TYPE_ENUM: {
 903       uint64_t value = field(v.qw, iter->start, iter->end);
 904       snprintf(iter->value, sizeof(iter->value),
 905                "%"PRId64, value);
 906       enum_name = gen_get_enum_name(iter->field->type.gen_enum, value);
 907       break;
 908    }
 909    }
 910
 911    if (strlen(iter->group->name) == 0) {
 912       int length = strlen(iter->name);
 913       snprintf(iter->name + length, sizeof(iter->name) - length,
 914                "[%i]", iter->group_iter);
 915    }
 916
 917    if (enum_name) {
 918       int length = strlen(iter->value);
 919       snprintf(iter->value + length, sizeof(iter->value) - length,
 920                " (%s)", enum_name);
 921    }
 922 }
 923
 924 void
 925 gen_field_iterator_init(struct gen_field_iterator *iter,
 926                         struct gen_group *group,
 927                         const uint32_t *p,
 928                         bool print_colors)
 929 {
 930    memset(iter, 0, sizeof(*iter));
 931
 932    iter->group = group;
 933    if (group->fields)
 934       iter->field = group->fields;
 935    else
 936       iter->field = group->next->fields;
 937    iter->p = p;
 938    iter->p_end = &p[gen_group_get_length(iter->group, iter->p)];
 939    iter->print_colors = print_colors;
 940
 941    gen_field_decode(iter);
 942 }
 943
 944 bool
 945 gen_field_iterator_next(struct gen_field_iterator *iter)
 946 {
 947    if (!iter_advance_field(iter))
 948       return false;
 949
 950    gen_field_decode(iter);
 951
 952    return true;
 953 }
 954
 955 static void
 956 print_dword_header(FILE *outfile,
 957                    struct gen_field_iterator *iter,
 958                    uint64_t offset, uint32_t dword)
 959 {
 960    fprintf(outfile, "0x%08"PRIx64":  0x%08x : Dword %d\n",
 961            offset + 4 * dword, iter->p[dword], dword);
 962 }
 963
 964 bool
 965 gen_group_header_is_header(struct gen_group *group, struct gen_field *field)
 966 {
 967    uint32_t bits;
 968
 969    if (field->start >= 32)
 970       return false;
 971
 972    bits = (1U << (field->end - field->start + 1)) - 1;
 973    bits <<= field->start;
 974
 975    return (group->opcode_mask & bits) != 0;
 976 }
 977
 978 void
 979 gen_print_group(FILE *outfile, struct gen_group *group,
 980                 uint64_t offset, const uint32_t *p, bool color)
 981 {
 982    struct gen_field_iterator iter;
 983    int last_dword = -1;
 984
 985    gen_field_iterator_init(&iter, group, p, color);
 986    do {
 987       if (last_dword != iter.dword) {
 988          for (int i = last_dword + 1; i <= iter.dword; i++)
 989             print_dword_header(outfile, &iter, offset, i);
 990          last_dword = iter.dword;
 991       }
 992       if (!gen_group_header_is_header(group, iter.field)) {
 993          fprintf(outfile, "    %s: %s\n", iter.name, iter.value);
 994          if (iter.struct_desc) {
 995             uint64_t struct_offset = offset + 4 * iter.dword;
 996             gen_print_group(outfile, iter.struct_desc, struct_offset,
 997                             &p[iter.dword], color);
 998          }
 999       }
1000    } while (gen_field_iterator_next(&iter));
1001 }