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