ich9: add support for pci assignment
[qemu/ar7.git] / tcg / README
blobec1ac79375aa8911497a24147ab45f4cadcd1a39
1 Tiny Code Generator - Fabrice Bellard.
3 1) Introduction
5 TCG (Tiny Code Generator) began as a generic backend for a C
6 compiler. It was simplified to be used in QEMU. It also has its roots
7 in the QOP code generator written by Paul Brook. 
9 2) Definitions
11 The TCG "target" is the architecture for which we generate the
12 code. It is of course not the same as the "target" of QEMU which is
13 the emulated architecture. As TCG started as a generic C backend used
14 for cross compiling, it is assumed that the TCG target is different
15 from the host, although it is never the case for QEMU.
17 A TCG "function" corresponds to a QEMU Translated Block (TB).
19 A TCG "temporary" is a variable only live in a basic
20 block. Temporaries are allocated explicitly in each function.
22 A TCG "local temporary" is a variable only live in a function. Local
23 temporaries are allocated explicitly in each function.
25 A TCG "global" is a variable which is live in all the functions
26 (equivalent of a C global variable). They are defined before the
27 functions defined. A TCG global can be a memory location (e.g. a QEMU
28 CPU register), a fixed host register (e.g. the QEMU CPU state pointer)
29 or a memory location which is stored in a register outside QEMU TBs
30 (not implemented yet).
32 A TCG "basic block" corresponds to a list of instructions terminated
33 by a branch instruction. 
35 3) Intermediate representation
37 3.1) Introduction
39 TCG instructions operate on variables which are temporaries, local
40 temporaries or globals. TCG instructions and variables are strongly
41 typed. Two types are supported: 32 bit integers and 64 bit
42 integers. Pointers are defined as an alias to 32 bit or 64 bit
43 integers depending on the TCG target word size.
45 Each instruction has a fixed number of output variable operands, input
46 variable operands and always constant operands.
48 The notable exception is the call instruction which has a variable
49 number of outputs and inputs.
51 In the textual form, output operands usually come first, followed by
52 input operands, followed by constant operands. The output type is
53 included in the instruction name. Constants are prefixed with a '$'.
55 add_i32 t0, t1, t2  (t0 <- t1 + t2)
57 3.2) Assumptions
59 * Basic blocks
61 - Basic blocks end after branches (e.g. brcond_i32 instruction),
62   goto_tb and exit_tb instructions.
63 - Basic blocks start after the end of a previous basic block, or at a
64   set_label instruction.
66 After the end of a basic block, the content of temporaries is
67 destroyed, but local temporaries and globals are preserved.
69 * Floating point types are not supported yet
71 * Pointers: depending on the TCG target, pointer size is 32 bit or 64
72   bit. The type TCG_TYPE_PTR is an alias to TCG_TYPE_I32 or
73   TCG_TYPE_I64.
75 * Helpers:
77 Using the tcg_gen_helper_x_y it is possible to call any function
78 taking i32, i64 or pointer types. By default, before calling a helper,
79 all globals are stored at their canonical location and it is assumed
80 that the function can modify them. By default, the helper is allowed to
81 modify the CPU state or raise an exception.
83 This can be overridden using the following function modifiers:
84 - TCG_CALL_NO_READ_GLOBALS means that the helper does not read globals,
85   either directly or via an exception. They will not be saved to their
86   canonical locations before calling the helper.
87 - TCG_CALL_NO_WRITE_GLOBALS means that the helper does not modify any globals.
88   They will only be saved to their canonical location before calling helpers,
89   but they won't be reloaded afterwise.
90 - TCG_CALL_NO_SIDE_EFFECTS means that the call to the function is removed if
91   the return value is not used.
93 Note that TCG_CALL_NO_READ_GLOBALS implies TCG_CALL_NO_WRITE_GLOBALS.
95 On some TCG targets (e.g. x86), several calling conventions are
96 supported.
98 * Branches:
100 Use the instruction 'br' to jump to a label.
102 3.3) Code Optimizations
104 When generating instructions, you can count on at least the following
105 optimizations:
107 - Single instructions are simplified, e.g.
109    and_i32 t0, t0, $0xffffffff
110     
111   is suppressed.
113 - A liveness analysis is done at the basic block level. The
114   information is used to suppress moves from a dead variable to
115   another one. It is also used to remove instructions which compute
116   dead results. The later is especially useful for condition code
117   optimization in QEMU.
119   In the following example:
121   add_i32 t0, t1, t2
122   add_i32 t0, t0, $1
123   mov_i32 t0, $1
125   only the last instruction is kept.
127 3.4) Instruction Reference
129 ********* Function call
131 * call <ret> <params> ptr
133 call function 'ptr' (pointer type)
135 <ret> optional 32 bit or 64 bit return value
136 <params> optional 32 bit or 64 bit parameters
138 ********* Jumps/Labels
140 * set_label $label
142 Define label 'label' at the current program point.
144 * br $label
146 Jump to label.
148 * brcond_i32/i64 t0, t1, cond, label
150 Conditional jump if t0 cond t1 is true. cond can be:
151     TCG_COND_EQ
152     TCG_COND_NE
153     TCG_COND_LT /* signed */
154     TCG_COND_GE /* signed */
155     TCG_COND_LE /* signed */
156     TCG_COND_GT /* signed */
157     TCG_COND_LTU /* unsigned */
158     TCG_COND_GEU /* unsigned */
159     TCG_COND_LEU /* unsigned */
160     TCG_COND_GTU /* unsigned */
162 ********* Arithmetic
164 * add_i32/i64 t0, t1, t2
166 t0=t1+t2
168 * sub_i32/i64 t0, t1, t2
170 t0=t1-t2
172 * neg_i32/i64 t0, t1
174 t0=-t1 (two's complement)
176 * mul_i32/i64 t0, t1, t2
178 t0=t1*t2
180 * div_i32/i64 t0, t1, t2
182 t0=t1/t2 (signed). Undefined behavior if division by zero or overflow.
184 * divu_i32/i64 t0, t1, t2
186 t0=t1/t2 (unsigned). Undefined behavior if division by zero.
188 * rem_i32/i64 t0, t1, t2
190 t0=t1%t2 (signed). Undefined behavior if division by zero or overflow.
192 * remu_i32/i64 t0, t1, t2
194 t0=t1%t2 (unsigned). Undefined behavior if division by zero.
196 ********* Logical
198 * and_i32/i64 t0, t1, t2
200 t0=t1&t2
202 * or_i32/i64 t0, t1, t2
204 t0=t1|t2
206 * xor_i32/i64 t0, t1, t2
208 t0=t1^t2
210 * not_i32/i64 t0, t1
212 t0=~t1
214 * andc_i32/i64 t0, t1, t2
216 t0=t1&~t2
218 * eqv_i32/i64 t0, t1, t2
220 t0=~(t1^t2), or equivalently, t0=t1^~t2
222 * nand_i32/i64 t0, t1, t2
224 t0=~(t1&t2)
226 * nor_i32/i64 t0, t1, t2
228 t0=~(t1|t2)
230 * orc_i32/i64 t0, t1, t2
232 t0=t1|~t2
234 ********* Shifts/Rotates
236 * shl_i32/i64 t0, t1, t2
238 t0=t1 << t2. Undefined behavior if t2 < 0 or t2 >= 32 (resp 64)
240 * shr_i32/i64 t0, t1, t2
242 t0=t1 >> t2 (unsigned). Undefined behavior if t2 < 0 or t2 >= 32 (resp 64)
244 * sar_i32/i64 t0, t1, t2
246 t0=t1 >> t2 (signed). Undefined behavior if t2 < 0 or t2 >= 32 (resp 64)
248 * rotl_i32/i64 t0, t1, t2
250 Rotation of t2 bits to the left. Undefined behavior if t2 < 0 or t2 >= 32 (resp 64)
252 * rotr_i32/i64 t0, t1, t2
254 Rotation of t2 bits to the right. Undefined behavior if t2 < 0 or t2 >= 32 (resp 64)
256 ********* Misc
258 * mov_i32/i64 t0, t1
260 t0 = t1
262 Move t1 to t0 (both operands must have the same type).
264 * ext8s_i32/i64 t0, t1
265 ext8u_i32/i64 t0, t1
266 ext16s_i32/i64 t0, t1
267 ext16u_i32/i64 t0, t1
268 ext32s_i64 t0, t1
269 ext32u_i64 t0, t1
271 8, 16 or 32 bit sign/zero extension (both operands must have the same type)
273 * bswap16_i32/i64 t0, t1
275 16 bit byte swap on a 32/64 bit value. It assumes that the two/six high order
276 bytes are set to zero.
278 * bswap32_i32/i64 t0, t1
280 32 bit byte swap on a 32/64 bit value. With a 64 bit value, it assumes that
281 the four high order bytes are set to zero.
283 * bswap64_i64 t0, t1
285 64 bit byte swap
287 * discard_i32/i64 t0
289 Indicate that the value of t0 won't be used later. It is useful to
290 force dead code elimination.
292 * deposit_i32/i64 dest, t1, t2, pos, len
294 Deposit T2 as a bitfield into T1, placing the result in DEST.
295 The bitfield is described by POS/LEN, which are immediate values:
297   LEN - the length of the bitfield
298   POS - the position of the first bit, counting from the LSB
300 For example, pos=8, len=4 indicates a 4-bit field at bit 8.
301 This operation would be equivalent to
303   dest = (t1 & ~0x0f00) | ((t2 << 8) & 0x0f00)
306 ********* Conditional moves
308 * setcond_i32/i64 dest, t1, t2, cond
310 dest = (t1 cond t2)
312 Set DEST to 1 if (T1 cond T2) is true, otherwise set to 0.
314 * movcond_i32/i64 dest, c1, c2, v1, v2, cond
316 dest = (c1 cond c2 ? v1 : v2)
318 Set DEST to V1 if (C1 cond C2) is true, otherwise set to V2.
320 ********* Type conversions
322 * ext_i32_i64 t0, t1
323 Convert t1 (32 bit) to t0 (64 bit) and does sign extension
325 * extu_i32_i64 t0, t1
326 Convert t1 (32 bit) to t0 (64 bit) and does zero extension
328 * trunc_i64_i32 t0, t1
329 Truncate t1 (64 bit) to t0 (32 bit)
331 * concat_i32_i64 t0, t1, t2
332 Construct t0 (64-bit) taking the low half from t1 (32 bit) and the high half
333 from t2 (32 bit).
335 * concat32_i64 t0, t1, t2
336 Construct t0 (64-bit) taking the low half from t1 (64 bit) and the high half
337 from t2 (64 bit).
339 ********* Load/Store
341 * ld_i32/i64 t0, t1, offset
342 ld8s_i32/i64 t0, t1, offset
343 ld8u_i32/i64 t0, t1, offset
344 ld16s_i32/i64 t0, t1, offset
345 ld16u_i32/i64 t0, t1, offset
346 ld32s_i64 t0, t1, offset
347 ld32u_i64 t0, t1, offset
349 t0 = read(t1 + offset)
350 Load 8, 16, 32 or 64 bits with or without sign extension from host memory. 
351 offset must be a constant.
353 * st_i32/i64 t0, t1, offset
354 st8_i32/i64 t0, t1, offset
355 st16_i32/i64 t0, t1, offset
356 st32_i64 t0, t1, offset
358 write(t0, t1 + offset)
359 Write 8, 16, 32 or 64 bits to host memory.
361 All this opcodes assume that the pointed host memory doesn't correspond
362 to a global. In the latter case the behaviour is unpredictable.
364 ********* 64-bit target on 32-bit host support
366 The following opcodes are internal to TCG.  Thus they are to be implemented by
367 32-bit host code generators, but are not to be emitted by guest translators.
368 They are emitted as needed by inline functions within "tcg-op.h".
370 * brcond2_i32 t0_low, t0_high, t1_low, t1_high, cond, label
372 Similar to brcond, except that the 64-bit values T0 and T1
373 are formed from two 32-bit arguments.
375 * add2_i32 t0_low, t0_high, t1_low, t1_high, t2_low, t2_high
376 * sub2_i32 t0_low, t0_high, t1_low, t1_high, t2_low, t2_high
378 Similar to add/sub, except that the 64-bit inputs T1 and T2 are
379 formed from two 32-bit arguments, and the 64-bit output T0
380 is returned in two 32-bit outputs.
382 * mulu2_i32 t0_low, t0_high, t1, t2
384 Similar to mul, except two 32-bit (unsigned) inputs T1 and T2 yielding
385 the full 64-bit product T0.  The later is returned in two 32-bit outputs.
387 * setcond2_i32 dest, t1_low, t1_high, t2_low, t2_high, cond
389 Similar to setcond, except that the 64-bit values T1 and T2 are
390 formed from two 32-bit arguments.  The result is a 32-bit value.
392 ********* QEMU specific operations
394 * exit_tb t0
396 Exit the current TB and return the value t0 (word type).
398 * goto_tb index
400 Exit the current TB and jump to the TB index 'index' (constant) if the
401 current TB was linked to this TB. Otherwise execute the next
402 instructions. Only indices 0 and 1 are valid and tcg_gen_goto_tb may be issued
403 at most once with each slot index per TB.
405 * qemu_ld8u t0, t1, flags
406 qemu_ld8s t0, t1, flags
407 qemu_ld16u t0, t1, flags
408 qemu_ld16s t0, t1, flags
409 qemu_ld32 t0, t1, flags
410 qemu_ld32u t0, t1, flags
411 qemu_ld32s t0, t1, flags
412 qemu_ld64 t0, t1, flags
414 Load data at the QEMU CPU address t1 into t0. t1 has the QEMU CPU address
415 type. 'flags' contains the QEMU memory index (selects user or kernel access)
416 for example.
418 Note that "qemu_ld32" implies a 32-bit result, while "qemu_ld32u" and
419 "qemu_ld32s" imply a 64-bit result appropriately extended from 32 bits.
421 * qemu_st8 t0, t1, flags
422 qemu_st16 t0, t1, flags
423 qemu_st32 t0, t1, flags
424 qemu_st64 t0, t1, flags
426 Store the data t0 at the QEMU CPU Address t1. t1 has the QEMU CPU
427 address type. 'flags' contains the QEMU memory index (selects user or
428 kernel access) for example.
430 Note 1: Some shortcuts are defined when the last operand is known to be
431 a constant (e.g. addi for add, movi for mov).
433 Note 2: When using TCG, the opcodes must never be generated directly
434 as some of them may not be available as "real" opcodes. Always use the
435 function tcg_gen_xxx(args).
437 4) Backend
439 tcg-target.h contains the target specific definitions. tcg-target.c
440 contains the target specific code.
442 4.1) Assumptions
444 The target word size (TCG_TARGET_REG_BITS) is expected to be 32 bit or
445 64 bit. It is expected that the pointer has the same size as the word.
447 On a 32 bit target, all 64 bit operations are converted to 32 bits. A
448 few specific operations must be implemented to allow it (see add2_i32,
449 sub2_i32, brcond2_i32).
451 Floating point operations are not supported in this version. A
452 previous incarnation of the code generator had full support of them,
453 but it is better to concentrate on integer operations first.
455 On a 64 bit target, no assumption is made in TCG about the storage of
456 the 32 bit values in 64 bit registers.
458 4.2) Constraints
460 GCC like constraints are used to define the constraints of every
461 instruction. Memory constraints are not supported in this
462 version. Aliases are specified in the input operands as for GCC.
464 The same register may be used for both an input and an output, even when
465 they are not explicitly aliased.  If an op expands to multiple target
466 instructions then care must be taken to avoid clobbering input values.
467 GCC style "early clobber" outputs are not currently supported.
469 A target can define specific register or constant constraints. If an
470 operation uses a constant input constraint which does not allow all
471 constants, it must also accept registers in order to have a fallback.
473 The movi_i32 and movi_i64 operations must accept any constants.
475 The mov_i32 and mov_i64 operations must accept any registers of the
476 same type.
478 The ld/st instructions must accept signed 32 bit constant offsets. It
479 can be implemented by reserving a specific register to compute the
480 address if the offset is too big.
482 The ld/st instructions must accept any destination (ld) or source (st)
483 register.
485 4.3) Function call assumptions
487 - The only supported types for parameters and return value are: 32 and
488   64 bit integers and pointer.
489 - The stack grows downwards.
490 - The first N parameters are passed in registers.
491 - The next parameters are passed on the stack by storing them as words.
492 - Some registers are clobbered during the call. 
493 - The function can return 0 or 1 value in registers. On a 32 bit
494   target, functions must be able to return 2 values in registers for
495   64 bit return type.
497 5) Recommended coding rules for best performance
499 - Use globals to represent the parts of the QEMU CPU state which are
500   often modified, e.g. the integer registers and the condition
501   codes. TCG will be able to use host registers to store them.
503 - Avoid globals stored in fixed registers. They must be used only to
504   store the pointer to the CPU state and possibly to store a pointer
505   to a register window.
507 - Use temporaries. Use local temporaries only when really needed,
508   e.g. when you need to use a value after a jump. Local temporaries
509   introduce a performance hit in the current TCG implementation: their
510   content is saved to memory at end of each basic block.
512 - Free temporaries and local temporaries when they are no longer used
513   (tcg_temp_free). Since tcg_const_x() also creates a temporary, you
514   should free it after it is used. Freeing temporaries does not yield
515   a better generated code, but it reduces the memory usage of TCG and
516   the speed of the translation.
518 - Don't hesitate to use helpers for complicated or seldom used target
519   instructions. There is little performance advantage in using TCG to
520   implement target instructions taking more than about twenty TCG
521   instructions. Note that this rule of thumb is more applicable to
522   helpers doing complex logic or arithmetic, where the C compiler has
523   scope to do a good job of optimisation; it is less relevant where
524   the instruction is mostly doing loads and stores, and in those cases
525   inline TCG may still be faster for longer sequences.
527 - The hard limit on the number of TCG instructions you can generate
528   per target instruction is set by MAX_OP_PER_INSTR in exec-all.h --
529   you cannot exceed this without risking a buffer overrun.
531 - Use the 'discard' instruction if you know that TCG won't be able to
532   prove that a given global is "dead" at a given program point. The
533   x86 target uses it to improve the condition codes optimisation.