xref: /openbmc/qemu/accel/tcg/translator.c (revision f6476697)
1 /*
2  * Generic intermediate code generation.
3  *
4  * Copyright (C) 2016-2017 Lluís Vilanova <vilanova@ac.upc.edu>
5  *
6  * This work is licensed under the terms of the GNU GPL, version 2 or later.
7  * See the COPYING file in the top-level directory.
8  */
9 
10 #include "qemu/osdep.h"
11 #include "qemu/error-report.h"
12 #include "tcg/tcg.h"
13 #include "tcg/tcg-op.h"
14 #include "exec/exec-all.h"
15 #include "exec/gen-icount.h"
16 #include "exec/log.h"
17 #include "exec/translator.h"
18 #include "exec/plugin-gen.h"
19 #include "sysemu/replay.h"
20 
21 /* Pairs with tcg_clear_temp_count.
22    To be called by #TranslatorOps.{translate_insn,tb_stop} if
23    (1) the target is sufficiently clean to support reporting,
24    (2) as and when all temporaries are known to be consumed.
25    For most targets, (2) is at the end of translate_insn.  */
26 void translator_loop_temp_check(DisasContextBase *db)
27 {
28     if (tcg_check_temp_count()) {
29         qemu_log("warning: TCG temporary leaks before "
30                  TARGET_FMT_lx "\n", db->pc_next);
31     }
32 }
33 
34 void translator_loop(const TranslatorOps *ops, DisasContextBase *db,
35                      CPUState *cpu, TranslationBlock *tb, int max_insns)
36 {
37     int bp_insn = 0;
38     bool plugin_enabled;
39 
40     /* Initialize DisasContext */
41     db->tb = tb;
42     db->pc_first = tb->pc;
43     db->pc_next = db->pc_first;
44     db->is_jmp = DISAS_NEXT;
45     db->num_insns = 0;
46     db->max_insns = max_insns;
47     db->singlestep_enabled = cpu->singlestep_enabled;
48 
49     ops->init_disas_context(db, cpu);
50     tcg_debug_assert(db->is_jmp == DISAS_NEXT);  /* no early exit */
51 
52     /* Reset the temp count so that we can identify leaks */
53     tcg_clear_temp_count();
54 
55     /* Start translating.  */
56     gen_tb_start(db->tb);
57     ops->tb_start(db, cpu);
58     tcg_debug_assert(db->is_jmp == DISAS_NEXT);  /* no early exit */
59 
60     plugin_enabled = plugin_gen_tb_start(cpu, tb,
61                                          tb_cflags(db->tb) & CF_MEMI_ONLY);
62 
63     while (true) {
64         db->num_insns++;
65         ops->insn_start(db, cpu);
66         tcg_debug_assert(db->is_jmp == DISAS_NEXT);  /* no early exit */
67 
68         if (plugin_enabled) {
69             plugin_gen_insn_start(cpu, db);
70         }
71 
72         /* Pass breakpoint hits to target for further processing */
73         if (!db->singlestep_enabled
74             && unlikely(!QTAILQ_EMPTY(&cpu->breakpoints))) {
75             CPUBreakpoint *bp;
76             QTAILQ_FOREACH(bp, &cpu->breakpoints, entry) {
77                 if (bp->pc == db->pc_next) {
78                     if (ops->breakpoint_check(db, cpu, bp)) {
79                         bp_insn = 1;
80                         break;
81                     }
82                 }
83             }
84             /* The breakpoint_check hook may use DISAS_TOO_MANY to indicate
85                that only one more instruction is to be executed.  Otherwise
86                it should use DISAS_NORETURN when generating an exception,
87                but may use a DISAS_TARGET_* value for Something Else.  */
88             if (db->is_jmp > DISAS_TOO_MANY) {
89                 break;
90             }
91         }
92 
93         /* Disassemble one instruction.  The translate_insn hook should
94            update db->pc_next and db->is_jmp to indicate what should be
95            done next -- either exiting this loop or locate the start of
96            the next instruction.  */
97         if (db->num_insns == db->max_insns
98             && (tb_cflags(db->tb) & CF_LAST_IO)) {
99             /* Accept I/O on the last instruction.  */
100             gen_io_start();
101             ops->translate_insn(db, cpu);
102         } else {
103             /* we should only see CF_MEMI_ONLY for io_recompile */
104             tcg_debug_assert(!(tb_cflags(db->tb) & CF_MEMI_ONLY));
105             ops->translate_insn(db, cpu);
106         }
107 
108         /* Stop translation if translate_insn so indicated.  */
109         if (db->is_jmp != DISAS_NEXT) {
110             break;
111         }
112 
113         /*
114          * We can't instrument after instructions that change control
115          * flow although this only really affects post-load operations.
116          */
117         if (plugin_enabled) {
118             plugin_gen_insn_end();
119         }
120 
121         /* Stop translation if the output buffer is full,
122            or we have executed all of the allowed instructions.  */
123         if (tcg_op_buf_full() || db->num_insns >= db->max_insns) {
124             db->is_jmp = DISAS_TOO_MANY;
125             break;
126         }
127     }
128 
129     /* Emit code to exit the TB, as indicated by db->is_jmp.  */
130     ops->tb_stop(db, cpu);
131     gen_tb_end(db->tb, db->num_insns - bp_insn);
132 
133     if (plugin_enabled) {
134         plugin_gen_tb_end(cpu);
135     }
136 
137     /* The disas_log hook may use these values rather than recompute.  */
138     tb->size = db->pc_next - db->pc_first;
139     tb->icount = db->num_insns;
140 
141 #ifdef DEBUG_DISAS
142     if (qemu_loglevel_mask(CPU_LOG_TB_IN_ASM)
143         && qemu_log_in_addr_range(db->pc_first)) {
144         FILE *logfile = qemu_log_lock();
145         qemu_log("----------------\n");
146         ops->disas_log(db, cpu);
147         qemu_log("\n");
148         qemu_log_unlock(logfile);
149     }
150 #endif
151 }
152