teach cellspu how to return i8 and i16 from calls,
[oota-llvm.git] / lib / Target / CellSPU / README.txt
1 //===- README.txt - Notes for improving CellSPU-specific code gen ---------===//
2
3 This code was contributed by a team from the Computer Systems Research
4 Department in The Aerospace Corporation:
5
6 - Scott Michel (head bottle washer and much of the non-floating point
7   instructions)
8 - Mark Thomas (floating point instructions)
9 - Michael AuYeung (intrinsics)
10 - Chandler Carruth (LLVM expertise)
11 - Nehal Desai (debugging, i32 operations, RoadRunner SPU expertise)
12
13 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
15 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR
16 OTHERWISE.  IN NO EVENT SHALL THE AEROSPACE CORPORATION BE LIABLE FOR DAMAGES
17 OF ANY KIND OR NATURE WHETHER BASED IN CONTRACT, TORT, OR OTHERWISE ARISING
18 OUT OF OR IN CONNECTION WITH THE USE OF THE SOFTWARE INCLUDING, WITHOUT
19 LIMITATION, DAMAGES RESULTING FROM LOST OR CONTAMINATED DATA, LOST PROFITS OR
20 REVENUE, COMPUTER MALFUNCTION, OR FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL,
21 OR PUNITIVE  DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR
22 SUCH DAMAGES ARE FORESEEABLE.
23
24 ---------------------------------------------------------------------------
25 --WARNING--:
26 --WARNING--: The CellSPU work is work-in-progress and "alpha" quality code.
27 --WARNING--:
28
29 If you are brave enough to try this code or help to hack on it, be sure
30 to add 'spu' to configure's --enable-targets option, e.g.:
31
32         ./configure <your_configure_flags_here> \
33            --enable-targets=x86,x86_64,powerpc,spu
34
35 ---------------------------------------------------------------------------
36
37 TODO:
38 * Create a machine pass for performing dual-pipeline scheduling specifically
39   for CellSPU, and insert branch prediction instructions as needed.
40
41 * i32 instructions:
42
43   * i32 division (work-in-progress)
44
45 * i64 support (see i64operations.c test harness):
46
47   * shifts and comparison operators: done
48   * sign and zero extension: done
49   * addition: done
50   * subtraction: needed
51   * multiplication: done
52
53 * i128 support:
54
55   * zero extension, any extension: done
56   * sign extension: needed
57   * arithmetic operators (add, sub, mul, div): needed
58   * logical operations (and, or, shl, srl, sra, xor, nor, nand): needed
59
60     * or: done
61
62 * f64 support
63
64   * Comparison operators:
65     SETOEQ              unimplemented
66     SETOGT              unimplemented
67     SETOGE              unimplemented
68     SETOLT              unimplemented
69     SETOLE              unimplemented
70     SETONE              unimplemented
71     SETO                done (lowered)
72     SETUO               done (lowered)
73     SETUEQ              unimplemented
74     SETUGT              unimplemented
75     SETUGE              unimplemented
76     SETULT              unimplemented
77     SETULE              unimplemented
78     SETUNE              unimplemented
79
80 * LLVM vector suport
81
82   * VSETCC needs to be implemented. It's pretty straightforward to code, but
83     needs implementation.
84
85 * Intrinsics
86
87   * spu.h instrinsics added but not tested. Need to have an operational
88     llvm-spu-gcc in order to write a unit test harness.
89
90 ===-------------------------------------------------------------------------===