• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright © 2014 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 #ifndef _INTEL_ASM_ANNOTATION_H
25 #define _INTEL_ASM_ANNOTATION_H
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 struct backend_instruction;
32 struct cfg_t;
33 
34 struct annotation {
35    int offset;
36 
37    size_t error_length;
38    char *error;
39 
40    /* Pointers to the basic block in the CFG if the instruction group starts
41     * or ends a basic block.
42     */
43    struct bblock_t *block_start;
44    struct bblock_t *block_end;
45 
46    /* Annotation for the generated IR.  One of the two can be set. */
47    const void *ir;
48    const char *annotation;
49 };
50 
51 struct annotation_info {
52    void *mem_ctx;
53    struct annotation *ann;
54    int ann_count;
55    int ann_size;
56 
57    /** Block index in the cfg. */
58    int cur_block;
59 };
60 
61 void
62 dump_assembly(void *assembly, int num_annotations, struct annotation *annotation,
63               const struct gen_device_info *devinfo);
64 
65 void
66 annotate(const struct gen_device_info *devinfo,
67          struct annotation_info *annotation, const struct cfg_t *cfg,
68          struct backend_instruction *inst, unsigned offset);
69 void
70 annotation_finalize(struct annotation_info *annotation, unsigned offset);
71 
72 void
73 annotation_insert_error(struct annotation_info *annotation, unsigned offset,
74                         const char *error);
75 
76 #ifdef __cplusplus
77 } /* extern "C" */
78 #endif
79 
80 #endif /* _INTEL_ASM_ANNOTATION_H */
81