Daniel Dunbar | b3a6901 | 2009-06-26 16:47:03 +0000 | [diff] [blame] | 1 | Compiler-RT |
| 2 | ================================ |
| 3 | |
| 4 | This directory and its subdirectories contain source code for the compiler |
| 5 | support routines. |
| 6 | |
| 7 | Compiler-RT is open source software. You may freely distribute it under the |
| 8 | terms of the license agreement found in LICENSE.txt. |
| 9 | |
| 10 | ================================ |
| 11 | |
Gabor Greif | 34ecf0f | 2009-07-03 14:37:30 +0000 | [diff] [blame] | 12 | This is a replacement library for libgcc. Each function is contained |
Daniel Dunbar | b3a6901 | 2009-06-26 16:47:03 +0000 | [diff] [blame] | 13 | in its own file. Each function has a corresponding unit test under |
| 14 | test/Unit. |
| 15 | |
| 16 | A rudimentary script to test each file is in the file called |
| 17 | test/Unit/test. |
| 18 | |
| 19 | Here is the specification for this library: |
| 20 | |
| 21 | http://gcc.gnu.org/onlinedocs/gccint/Libgcc.html#Libgcc |
| 22 | |
| 23 | Here is a synopsis of the contents of this library: |
| 24 | |
| 25 | typedef int si_int; |
| 26 | typedef unsigned su_int; |
| 27 | |
| 28 | typedef long long di_int; |
| 29 | typedef unsigned long long du_int; |
| 30 | |
| 31 | // Integral bit manipulation |
| 32 | |
| 33 | di_int __ashldi3(di_int a, si_int b); // a << b |
| 34 | di_int __ashrdi3(di_int a, si_int b); // a >> b arithmetic (sign fill) |
| 35 | di_int __lshrdi3(di_int a, si_int b); // a >> b logical (zero fill) |
| 36 | |
Gabor Greif | 34ecf0f | 2009-07-03 14:37:30 +0000 | [diff] [blame] | 37 | si_int __clzsi2(si_int a); // count leading zeros |
| 38 | si_int __clzdi2(di_int a); // count leading zeros |
| 39 | si_int __ctzsi2(si_int a); // count trailing zeros |
| 40 | si_int __ctzdi2(di_int a); // count trailing zeros |
Daniel Dunbar | b3a6901 | 2009-06-26 16:47:03 +0000 | [diff] [blame] | 41 | |
| 42 | si_int __ffsdi2(di_int a); // find least significant 1 bit |
| 43 | |
| 44 | si_int __paritysi2(si_int a); // bit parity |
| 45 | si_int __paritydi2(di_int a); // bit parity |
| 46 | |
| 47 | si_int __popcountsi2(si_int a); // bit population |
| 48 | si_int __popcountdi2(di_int a); // bit population |
| 49 | |
| 50 | // Integral arithmetic |
| 51 | |
| 52 | di_int __negdi2 (di_int a); // -a |
| 53 | di_int __muldi3 (di_int a, di_int b); // a * b |
| 54 | di_int __divdi3 (di_int a, di_int b); // a / b signed |
| 55 | du_int __udivdi3 (du_int a, du_int b); // a / b unsigned |
| 56 | di_int __moddi3 (di_int a, di_int b); // a % b signed |
| 57 | du_int __umoddi3 (du_int a, du_int b); // a % b unsigned |
| 58 | du_int __udivmoddi4(du_int a, du_int b, du_int* rem); // a / b, *rem = a % b |
| 59 | |
| 60 | // Integral arithmetic with trapping overflow |
| 61 | |
| 62 | si_int __absvsi2(si_int a); // abs(a) |
| 63 | di_int __absvdi2(di_int a); // abs(a) |
| 64 | |
| 65 | si_int __negvsi2(si_int a); // -a |
| 66 | di_int __negvdi2(di_int a); // -a |
| 67 | |
| 68 | si_int __addvsi3(si_int a, si_int b); // a + b |
| 69 | di_int __addvdi3(di_int a, di_int b); // a + b |
| 70 | |
| 71 | si_int __subvsi3(si_int a, si_int b); // a - b |
| 72 | di_int __subvdi3(di_int a, di_int b); // a - b |
| 73 | |
| 74 | si_int __mulvsi3(si_int a, si_int b); // a * b |
| 75 | di_int __mulvdi3(di_int a, di_int b); // a * b |
| 76 | |
| 77 | // Integral comparison: a < b -> 0 |
| 78 | // a == b -> 1 |
| 79 | // a > b -> 2 |
| 80 | |
| 81 | si_int __cmpdi2 (di_int a, di_int b); |
| 82 | si_int __ucmpdi2(du_int a, du_int b); |
| 83 | |
| 84 | // Integral / floating point conversion |
| 85 | |
| 86 | di_int __fixsfdi( float a); |
| 87 | di_int __fixdfdi( double a); |
| 88 | di_int __fixxfdi(long double a); |
| 89 | |
| 90 | su_int __fixunssfsi( float a); |
| 91 | su_int __fixunsdfsi( double a); |
| 92 | su_int __fixunsxfsi(long double a); |
| 93 | |
| 94 | du_int __fixunssfdi( float a); |
| 95 | du_int __fixunsdfdi( double a); |
| 96 | du_int __fixunsxfdi(long double a); |
| 97 | |
| 98 | float __floatdisf(di_int a); |
| 99 | double __floatdidf(di_int a); |
| 100 | long double __floatdixf(di_int a); |
| 101 | |
| 102 | float __floatundisf(du_int a); |
| 103 | double __floatundidf(du_int a); |
| 104 | long double __floatundixf(du_int a); |
| 105 | |
| 106 | // Floating point raised to integer power |
| 107 | |
| 108 | float __powisf2( float a, si_int b); // a ^ b |
| 109 | double __powidf2( double a, si_int b); // a ^ b |
| 110 | long double __powixf2(long double a, si_int b); // a ^ b |
| 111 | |
| 112 | // Complex arithmetic |
| 113 | |
| 114 | // (a + ib) * (c + id) |
| 115 | |
| 116 | float _Complex __mulsc3( float a, float b, float c, float d); |
| 117 | double _Complex __muldc3(double a, double b, double c, double d); |
| 118 | long double _Complex __mulxc3(long double a, long double b, |
| 119 | long double c, long double d); |
| 120 | |
| 121 | // (a + ib) / (c + id) |
| 122 | |
| 123 | float _Complex __divsc3( float a, float b, float c, float d); |
| 124 | double _Complex __divdc3(double a, double b, double c, double d); |
| 125 | long double _Complex __divxc3(long double a, long double b, |
| 126 | long double c, long double d); |
| 127 | |
| 128 | Preconditions are listed for each function at the definition when there are any. |
| 129 | Any preconditions reflect the specification at |
| 130 | http://gcc.gnu.org/onlinedocs/gccint/Libgcc.html#Libgcc. |
| 131 | |
| 132 | Assumptions are listed in "int_lib.h", and in individual files. Where possible |
| 133 | assumptions are checked at compile time. |