2 * Copyright © 2016 Intel Corporation
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:
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
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
33 #include <util/macros.h>
35 #include "gen_decoder.h"
37 #include "genxml/genX_xml.h"
39 #define XML_BUFFER_SIZE 4096
41 #define MAKE_GEN(major, minor) ( ((major) << 8) | (minor) )
47 struct gen_group
*commands
[256];
49 struct gen_group
*structs
[256];
51 struct gen_group
*registers
[256];
53 struct gen_enum
*enums
[256];
61 struct parser_context
{
67 struct gen_group
*group
;
68 struct gen_enum
*enoom
;
71 struct gen_field
*fields
[128];
74 struct gen_value
*values
[256];
76 struct gen_spec
*spec
;
80 gen_group_get_name(struct gen_group
*group
)
86 gen_group_get_opcode(struct gen_group
*group
)
92 gen_spec_find_struct(struct gen_spec
*spec
, const char *name
)
94 for (int i
= 0; i
< spec
->nstructs
; i
++)
95 if (strcmp(spec
->structs
[i
]->name
, name
) == 0)
96 return spec
->structs
[i
];
102 gen_spec_find_register(struct gen_spec
*spec
, uint32_t offset
)
104 for (int i
= 0; i
< spec
->nregisters
; i
++)
105 if (spec
->registers
[i
]->register_offset
== offset
)
106 return spec
->registers
[i
];
112 gen_spec_find_enum(struct gen_spec
*spec
, const char *name
)
114 for (int i
= 0; i
< spec
->nenums
; i
++)
115 if (strcmp(spec
->enums
[i
]->name
, name
) == 0)
116 return spec
->enums
[i
];
122 gen_spec_get_gen(struct gen_spec
*spec
)
127 static void __attribute__((noreturn
))
128 fail(struct location
*loc
, const char *msg
, ...)
133 fprintf(stderr
, "%s:%d: error: ",
134 loc
->filename
, loc
->line_number
);
135 vfprintf(stderr
, msg
, ap
);
136 fprintf(stderr
, "\n");
142 fail_on_null(void *p
)
145 fprintf(stderr
, "aubinator: out of memory\n");
153 xstrdup(const char *s
)
155 return fail_on_null(strdup(s
));
167 return fail_on_null(zalloc(s
));
170 static struct gen_group
*
171 create_group(struct parser_context
*ctx
, const char *name
, const char **atts
)
173 struct gen_group
*group
;
175 group
= xzalloc(sizeof(*group
));
177 group
->name
= xstrdup(name
);
179 group
->spec
= ctx
->spec
;
180 group
->group_offset
= 0;
181 group
->group_count
= 0;
186 static struct gen_enum
*
187 create_enum(struct parser_context
*ctx
, const char *name
, const char **atts
)
191 e
= xzalloc(sizeof(*e
));
193 e
->name
= xstrdup(name
);
201 get_group_offset_count(struct parser_context
*ctx
, const char *name
,
202 const char **atts
, uint32_t *offset
, uint32_t *count
)
207 for (i
= 0; atts
[i
]; i
+= 2) {
208 if (strcmp(atts
[i
], "count") == 0)
209 *count
= strtoul(atts
[i
+ 1], &p
, 0);
210 else if (strcmp(atts
[i
], "start") == 0)
211 *offset
= strtoul(atts
[i
+ 1], &p
, 0);
217 get_register_offset(const char **atts
, uint32_t *offset
)
222 for (i
= 0; atts
[i
]; i
+= 2) {
223 if (strcmp(atts
[i
], "num") == 0)
224 *offset
= strtoul(atts
[i
+ 1], &p
, 0);
230 get_start_end_pos(int *start
, int *end
)
232 /* start value has to be mod with 32 as we need the relative
233 * start position in the first DWord. For the end position, add
234 * the length of the field to the start position to get the
235 * relative postion in the 64 bit address.
237 if (*end
- *start
> 32) {
238 int len
= *end
- *start
;
239 *start
= *start
% 32;
242 *start
= *start
% 32;
249 static inline uint64_t
250 mask(int start
, int end
)
254 v
= ~0ULL >> (63 - end
+ start
);
259 static inline uint64_t
260 field(uint64_t value
, int start
, int end
)
262 get_start_end_pos(&start
, &end
);
263 return (value
& mask(start
, end
)) >> (start
);
266 static inline uint64_t
267 field_address(uint64_t value
, int start
, int end
)
269 /* no need to right shift for address/offset */
270 get_start_end_pos(&start
, &end
);
271 return (value
& mask(start
, end
));
274 static struct gen_type
275 string_to_type(struct parser_context
*ctx
, const char *s
)
281 if (strcmp(s
, "int") == 0)
282 return (struct gen_type
) { .kind
= GEN_TYPE_INT
};
283 else if (strcmp(s
, "uint") == 0)
284 return (struct gen_type
) { .kind
= GEN_TYPE_UINT
};
285 else if (strcmp(s
, "bool") == 0)
286 return (struct gen_type
) { .kind
= GEN_TYPE_BOOL
};
287 else if (strcmp(s
, "float") == 0)
288 return (struct gen_type
) { .kind
= GEN_TYPE_FLOAT
};
289 else if (strcmp(s
, "address") == 0)
290 return (struct gen_type
) { .kind
= GEN_TYPE_ADDRESS
};
291 else if (strcmp(s
, "offset") == 0)
292 return (struct gen_type
) { .kind
= GEN_TYPE_OFFSET
};
293 else if (sscanf(s
, "u%d.%d", &i
, &f
) == 2)
294 return (struct gen_type
) { .kind
= GEN_TYPE_UFIXED
, .i
= i
, .f
= f
};
295 else if (sscanf(s
, "s%d.%d", &i
, &f
) == 2)
296 return (struct gen_type
) { .kind
= GEN_TYPE_SFIXED
, .i
= i
, .f
= f
};
297 else if (g
= gen_spec_find_struct(ctx
->spec
, s
), g
!= NULL
)
298 return (struct gen_type
) { .kind
= GEN_TYPE_STRUCT
, .gen_struct
= g
};
299 else if (e
= gen_spec_find_enum(ctx
->spec
, s
), e
!= NULL
)
300 return (struct gen_type
) { .kind
= GEN_TYPE_ENUM
, .gen_enum
= e
};
301 else if (strcmp(s
, "mbo") == 0)
302 return (struct gen_type
) { .kind
= GEN_TYPE_MBO
};
304 fail(&ctx
->loc
, "invalid type: %s", s
);
307 static struct gen_field
*
308 create_field(struct parser_context
*ctx
, const char **atts
)
310 struct gen_field
*field
;
314 field
= xzalloc(sizeof(*field
));
316 for (i
= 0; atts
[i
]; i
+= 2) {
317 if (strcmp(atts
[i
], "name") == 0)
318 field
->name
= xstrdup(atts
[i
+ 1]);
319 else if (strcmp(atts
[i
], "start") == 0)
320 field
->start
= ctx
->group
->group_offset
+strtoul(atts
[i
+ 1], &p
, 0);
321 else if (strcmp(atts
[i
], "end") == 0) {
322 field
->end
= ctx
->group
->group_offset
+strtoul(atts
[i
+ 1], &p
, 0);
323 if (ctx
->group
->group_offset
)
324 ctx
->group
->group_offset
= field
->end
+1;
325 } else if (strcmp(atts
[i
], "type") == 0)
326 field
->type
= string_to_type(ctx
, atts
[i
+ 1]);
327 else if (strcmp(atts
[i
], "default") == 0 &&
328 field
->start
>= 16 && field
->end
<= 31) {
329 field
->has_default
= true;
330 field
->default_value
= strtoul(atts
[i
+ 1], &p
, 0);
337 static struct gen_value
*
338 create_value(struct parser_context
*ctx
, const char **atts
)
340 struct gen_value
*value
= xzalloc(sizeof(*value
));
342 for (int i
= 0; atts
[i
]; i
+= 2) {
343 if (strcmp(atts
[i
], "name") == 0)
344 value
->name
= xstrdup(atts
[i
+ 1]);
345 else if (strcmp(atts
[i
], "value") == 0)
346 value
->value
= strtoul(atts
[i
+ 1], NULL
, 0);
353 start_element(void *data
, const char *element_name
, const char **atts
)
355 struct parser_context
*ctx
= data
;
357 const char *name
= NULL
;
358 const char *gen
= NULL
;
360 ctx
->loc
.line_number
= XML_GetCurrentLineNumber(ctx
->parser
);
362 for (i
= 0; atts
[i
]; i
+= 2) {
363 if (strcmp(atts
[i
], "name") == 0)
365 else if (strcmp(atts
[i
], "gen") == 0)
369 if (strcmp(element_name
, "genxml") == 0) {
371 fail(&ctx
->loc
, "no platform name given");
373 fail(&ctx
->loc
, "no gen given");
375 ctx
->platform
= xstrdup(name
);
377 int n
= sscanf(gen
, "%d.%d", &major
, &minor
);
379 fail(&ctx
->loc
, "invalid gen given: %s", gen
);
383 ctx
->spec
->gen
= MAKE_GEN(major
, minor
);
384 } else if (strcmp(element_name
, "instruction") == 0 ||
385 strcmp(element_name
, "struct") == 0) {
386 ctx
->group
= create_group(ctx
, name
, atts
);
387 } else if (strcmp(element_name
, "register") == 0) {
388 ctx
->group
= create_group(ctx
, name
, atts
);
389 get_register_offset(atts
, &ctx
->group
->register_offset
);
390 } else if (strcmp(element_name
, "group") == 0) {
391 get_group_offset_count(ctx
, name
, atts
, &ctx
->group
->group_offset
,
392 &ctx
->group
->group_count
);
393 } else if (strcmp(element_name
, "field") == 0) {
395 ctx
->fields
[ctx
->nfields
++] = create_field(ctx
, atts
);
396 if (ctx
->group
->group_count
)
397 ctx
->group
->group_count
--;
398 } while (ctx
->group
->group_count
> 0);
399 } else if (strcmp(element_name
, "enum") == 0) {
400 ctx
->enoom
= create_enum(ctx
, name
, atts
);
401 } else if (strcmp(element_name
, "value") == 0) {
402 ctx
->values
[ctx
->nvalues
++] = create_value(ctx
, atts
);
407 end_element(void *data
, const char *name
)
409 struct parser_context
*ctx
= data
;
410 struct gen_spec
*spec
= ctx
->spec
;
412 if (strcmp(name
, "instruction") == 0 ||
413 strcmp(name
, "struct") == 0 ||
414 strcmp(name
, "register") == 0) {
415 size_t size
= ctx
->nfields
* sizeof(ctx
->fields
[0]);
416 struct gen_group
*group
= ctx
->group
;
418 group
->fields
= xzalloc(size
);
419 group
->nfields
= ctx
->nfields
;
420 memcpy(group
->fields
, ctx
->fields
, size
);
424 for (int i
= 0; i
< group
->nfields
; i
++) {
425 if (group
->fields
[i
]->start
>= 16 &&
426 group
->fields
[i
]->end
<= 31 &&
427 group
->fields
[i
]->has_default
) {
428 group
->opcode_mask
|=
429 mask(group
->fields
[i
]->start
% 32, group
->fields
[i
]->end
% 32);
431 group
->fields
[i
]->default_value
<< group
->fields
[i
]->start
;
435 if (strcmp(name
, "instruction") == 0)
436 spec
->commands
[spec
->ncommands
++] = group
;
437 else if (strcmp(name
, "struct") == 0)
438 spec
->structs
[spec
->nstructs
++] = group
;
439 else if (strcmp(name
, "register") == 0)
440 spec
->registers
[spec
->nregisters
++] = group
;
441 } else if (strcmp(name
, "group") == 0) {
442 ctx
->group
->group_offset
= 0;
443 ctx
->group
->group_count
= 0;
444 } else if (strcmp(name
, "field") == 0) {
445 assert(ctx
->nfields
> 0);
446 struct gen_field
*field
= ctx
->fields
[ctx
->nfields
- 1];
447 size_t size
= ctx
->nvalues
* sizeof(ctx
->values
[0]);
448 field
->inline_enum
.values
= xzalloc(size
);
449 field
->inline_enum
.nvalues
= ctx
->nvalues
;
450 memcpy(field
->inline_enum
.values
, ctx
->values
, size
);
452 } else if (strcmp(name
, "enum") == 0) {
453 struct gen_enum
*e
= ctx
->enoom
;
454 size_t size
= ctx
->nvalues
* sizeof(ctx
->values
[0]);
455 e
->values
= xzalloc(size
);
456 e
->nvalues
= ctx
->nvalues
;
457 memcpy(e
->values
, ctx
->values
, size
);
460 spec
->enums
[spec
->nenums
++] = e
;
465 character_data(void *data
, const XML_Char
*s
, int len
)
470 devinfo_to_gen(const struct gen_device_info
*devinfo
)
472 int value
= 10 * devinfo
->gen
;
474 if (devinfo
->is_baytrail
|| devinfo
->is_haswell
)
480 static uint32_t zlib_inflate(const void *compressed_data
,
481 uint32_t compressed_len
,
484 struct z_stream_s zstream
;
487 memset(&zstream
, 0, sizeof(zstream
));
489 zstream
.next_in
= (unsigned char *)compressed_data
;
490 zstream
.avail_in
= compressed_len
;
492 if (inflateInit(&zstream
) != Z_OK
)
496 zstream
.next_out
= out
;
497 zstream
.avail_out
= 4096;
500 switch (inflate(&zstream
, Z_SYNC_FLUSH
)) {
506 inflateEnd(&zstream
);
510 if (zstream
.avail_out
)
513 out
= realloc(out
, 2*zstream
.total_out
);
515 inflateEnd(&zstream
);
519 zstream
.next_out
= (unsigned char *)out
+ zstream
.total_out
;
520 zstream
.avail_out
= zstream
.total_out
;
523 inflateEnd(&zstream
);
525 return zstream
.total_out
;
529 gen_spec_load(const struct gen_device_info
*devinfo
)
531 struct parser_context ctx
;
534 uint32_t text_offset
= 0, text_length
= 0, total_length
;
535 uint32_t gen_10
= devinfo_to_gen(devinfo
);
537 for (int i
= 0; i
< ARRAY_SIZE(genxml_files_table
); i
++) {
538 if (genxml_files_table
[i
].gen_10
== gen_10
) {
539 text_offset
= genxml_files_table
[i
].offset
;
540 text_length
= genxml_files_table
[i
].length
;
545 if (text_length
== 0) {
546 fprintf(stderr
, "unable to find gen (%u) data\n", gen_10
);
550 memset(&ctx
, 0, sizeof ctx
);
551 ctx
.parser
= XML_ParserCreate(NULL
);
552 XML_SetUserData(ctx
.parser
, &ctx
);
553 if (ctx
.parser
== NULL
) {
554 fprintf(stderr
, "failed to create parser\n");
558 XML_SetElementHandler(ctx
.parser
, start_element
, end_element
);
559 XML_SetCharacterDataHandler(ctx
.parser
, character_data
);
561 ctx
.spec
= xzalloc(sizeof(*ctx
.spec
));
563 total_length
= zlib_inflate(compress_genxmls
,
564 sizeof(compress_genxmls
),
565 (void **) &text_data
);
566 assert(text_offset
+ text_length
<= total_length
);
568 buf
= XML_GetBuffer(ctx
.parser
, text_length
);
569 memcpy(buf
, &text_data
[text_offset
], text_length
);
571 if (XML_ParseBuffer(ctx
.parser
, text_length
, true) == 0) {
573 "Error parsing XML at line %ld col %ld byte %ld/%u: %s\n",
574 XML_GetCurrentLineNumber(ctx
.parser
),
575 XML_GetCurrentColumnNumber(ctx
.parser
),
576 XML_GetCurrentByteIndex(ctx
.parser
), text_length
,
577 XML_ErrorString(XML_GetErrorCode(ctx
.parser
)));
578 XML_ParserFree(ctx
.parser
);
583 XML_ParserFree(ctx
.parser
);
590 gen_spec_load_from_path(const struct gen_device_info
*devinfo
,
593 struct parser_context ctx
;
594 size_t len
, filename_len
= strlen(path
) + 20;
595 char *filename
= malloc(filename_len
);
599 len
= snprintf(filename
, filename_len
, "%s/gen%i.xml",
600 path
, devinfo_to_gen(devinfo
));
601 assert(len
< filename_len
);
603 input
= fopen(filename
, "r");
605 fprintf(stderr
, "failed to open xml description\n");
610 memset(&ctx
, 0, sizeof ctx
);
611 ctx
.parser
= XML_ParserCreate(NULL
);
612 XML_SetUserData(ctx
.parser
, &ctx
);
613 if (ctx
.parser
== NULL
) {
614 fprintf(stderr
, "failed to create parser\n");
620 XML_SetElementHandler(ctx
.parser
, start_element
, end_element
);
621 XML_SetCharacterDataHandler(ctx
.parser
, character_data
);
622 ctx
.loc
.filename
= filename
;
623 ctx
.spec
= xzalloc(sizeof(*ctx
.spec
));
626 buf
= XML_GetBuffer(ctx
.parser
, XML_BUFFER_SIZE
);
627 len
= fread(buf
, 1, XML_BUFFER_SIZE
, input
);
629 fprintf(stderr
, "fread: %m\n");
634 if (XML_ParseBuffer(ctx
.parser
, len
, len
== 0) == 0) {
636 "Error parsing XML at line %ld col %ld: %s\n",
637 XML_GetCurrentLineNumber(ctx
.parser
),
638 XML_GetCurrentColumnNumber(ctx
.parser
),
639 XML_ErrorString(XML_GetErrorCode(ctx
.parser
)));
646 XML_ParserFree(ctx
.parser
);
655 gen_spec_find_instruction(struct gen_spec
*spec
, const uint32_t *p
)
657 for (int i
= 0; i
< spec
->ncommands
; i
++) {
658 uint32_t opcode
= *p
& spec
->commands
[i
]->opcode_mask
;
659 if (opcode
== spec
->commands
[i
]->opcode
)
660 return spec
->commands
[i
];
667 gen_group_get_length(struct gen_group
*group
, const uint32_t *p
)
670 uint32_t type
= field(h
, 29, 31);
674 uint32_t opcode
= field(h
, 23, 28);
678 return field(h
, 0, 7) + 2;
682 case 3: /* Render */ {
683 uint32_t subtype
= field(h
, 27, 28);
686 return field(h
, 0, 7) + 2;
692 return field(h
, 0, 7) + 2;
697 unreachable("bad opcode");
701 gen_field_iterator_init(struct gen_field_iterator
*iter
,
702 struct gen_group
*group
,
709 iter
->print_colors
= print_colors
;
713 gen_get_enum_name(struct gen_enum
*e
, uint64_t value
)
715 for (int i
= 0; i
< e
->nvalues
; i
++) {
716 if (e
->values
[i
]->value
== value
) {
717 return e
->values
[i
]->name
;
724 gen_field_iterator_next(struct gen_field_iterator
*iter
)
731 if (iter
->i
== iter
->group
->nfields
)
734 iter
->field
= iter
->group
->fields
[iter
->i
++];
735 iter
->name
= iter
->field
->name
;
736 iter
->dword
= iter
->field
->start
/ 32;
737 iter
->struct_desc
= NULL
;
739 if ((iter
->field
->end
- iter
->field
->start
) > 32)
740 v
.qw
= ((uint64_t) iter
->p
[iter
->dword
+1] << 32) | iter
->p
[iter
->dword
];
742 v
.qw
= iter
->p
[iter
->dword
];
744 const char *enum_name
= NULL
;
746 switch (iter
->field
->type
.kind
) {
747 case GEN_TYPE_UNKNOWN
:
749 uint64_t value
= field(v
.qw
, iter
->field
->start
, iter
->field
->end
);
750 snprintf(iter
->value
, sizeof(iter
->value
), "%"PRId64
, value
);
751 enum_name
= gen_get_enum_name(&iter
->field
->inline_enum
, value
);
754 case GEN_TYPE_UINT
: {
755 uint64_t value
= field(v
.qw
, iter
->field
->start
, iter
->field
->end
);
756 snprintf(iter
->value
, sizeof(iter
->value
), "%"PRIu64
, value
);
757 enum_name
= gen_get_enum_name(&iter
->field
->inline_enum
, value
);
760 case GEN_TYPE_BOOL
: {
761 const char *true_string
=
762 iter
->print_colors
? "\e[0;35mtrue\e[0m" : "true";
763 snprintf(iter
->value
, sizeof(iter
->value
), "%s",
764 field(v
.qw
, iter
->field
->start
, iter
->field
->end
) ?
765 true_string
: "false");
769 snprintf(iter
->value
, sizeof(iter
->value
), "%f", v
.f
);
771 case GEN_TYPE_ADDRESS
:
772 case GEN_TYPE_OFFSET
:
773 snprintf(iter
->value
, sizeof(iter
->value
), "0x%08"PRIx64
,
774 field_address(v
.qw
, iter
->field
->start
, iter
->field
->end
));
776 case GEN_TYPE_STRUCT
:
777 snprintf(iter
->value
, sizeof(iter
->value
), "<struct %s>",
778 iter
->field
->type
.gen_struct
->name
);
780 gen_spec_find_struct(iter
->group
->spec
,
781 iter
->field
->type
.gen_struct
->name
);
783 case GEN_TYPE_UFIXED
:
784 snprintf(iter
->value
, sizeof(iter
->value
), "%f",
785 (float) field(v
.qw
, iter
->field
->start
,
786 iter
->field
->end
) / (1 << iter
->field
->type
.f
));
788 case GEN_TYPE_SFIXED
:
789 /* FIXME: Sign extend extracted field. */
790 snprintf(iter
->value
, sizeof(iter
->value
), "%s", "foo");
794 case GEN_TYPE_ENUM
: {
795 uint64_t value
= field(v
.qw
, iter
->field
->start
, iter
->field
->end
);
796 snprintf(iter
->value
, sizeof(iter
->value
),
798 enum_name
= gen_get_enum_name(iter
->field
->type
.gen_enum
, value
);
804 int length
= strlen(iter
->value
);
805 snprintf(iter
->value
+ length
, sizeof(iter
->value
) - length
,
813 print_dword_header(FILE *outfile
,
814 struct gen_field_iterator
*iter
, uint64_t offset
)
816 fprintf(outfile
, "0x%08"PRIx64
": 0x%08x : Dword %d\n",
817 offset
+ 4 * iter
->dword
, iter
->p
[iter
->dword
], iter
->dword
);
821 gen_print_group(FILE *outfile
, struct gen_group
*group
,
822 uint64_t offset
, const uint32_t *p
,
823 int starting_dword
, bool color
)
825 struct gen_field_iterator iter
;
828 gen_field_iterator_init(&iter
, group
, p
, color
);
829 while (gen_field_iterator_next(&iter
)) {
830 if (last_dword
!= iter
.dword
) {
831 print_dword_header(outfile
, &iter
, offset
);
832 last_dword
= iter
.dword
;
834 if (iter
.dword
>= starting_dword
) {
835 fprintf(outfile
, " %s: %s\n", iter
.name
, iter
.value
);
836 if (iter
.struct_desc
) {
837 uint64_t struct_offset
= offset
+ 4 * iter
.dword
;
838 print_dword_header(outfile
, &iter
, struct_offset
);
839 gen_print_group(outfile
, iter
.struct_desc
, struct_offset
,
840 &p
[iter
.dword
], 0, color
);