Assign the proper namespace to all new entities and assert that nobody tries to retri...
[cparser] / builtins.c
1 /*
2  * This file is part of cparser.
3  * Copyright (C) 2007-2009 Matthias Braun <matze@braunis.de>
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
18  * 02111-1307, USA.
19  */
20 #include "config.h"
21
22 #include "type_t.h"
23 #include "types.h"
24 #include "entity_t.h"
25 #include "ast_t.h"
26 #include "parser.h"
27 #include "builtins.h"
28 #include "lang_features.h"
29
30 static entity_t *create_builtin_function(builtin_kind_t kind, const char *name,
31                                          type_t *function_type)
32 {
33         symbol_t *symbol = symbol_table_insert(name);
34         entity_t *entity = allocate_entity_zero(ENTITY_FUNCTION);
35         entity->declaration.storage_class          = STORAGE_CLASS_EXTERN;
36         entity->declaration.declared_storage_class = STORAGE_CLASS_EXTERN;
37         entity->declaration.type                   = function_type;
38         entity->declaration.implicit               = true;
39         entity->base.namespc                       = NAMESPACE_NORMAL;
40         entity->base.symbol                        = symbol;
41         entity->base.source_position               = builtin_source_position;
42
43         entity->function.btk                       = kind;
44
45         record_entity(entity, /*is_definition=*/false);
46         return entity;
47 }
48
49 void create_gnu_builtins(void)
50 {
51 #define GNU_BUILTIN(a, b) create_builtin_function(bk_gnu_builtin_##a, "__builtin_" #a, b)
52
53         GNU_BUILTIN(alloca,         make_function_1_type(type_void_ptr, type_size_t));
54         GNU_BUILTIN(huge_val,       make_function_0_type(type_double));
55         GNU_BUILTIN(huge_valf,      make_function_0_type(type_float));
56         GNU_BUILTIN(huge_vall,      make_function_0_type(type_long_double));
57         GNU_BUILTIN(inf,            make_function_0_type(type_double));
58         GNU_BUILTIN(inff,           make_function_0_type(type_float));
59         GNU_BUILTIN(infl,           make_function_0_type(type_long_double));
60         GNU_BUILTIN(nan,            make_function_1_type(type_double, type_char_ptr));
61         GNU_BUILTIN(nanf,           make_function_1_type(type_float, type_char_ptr));
62         GNU_BUILTIN(nanl,           make_function_1_type(type_long_double, type_char_ptr));
63         GNU_BUILTIN(va_end,         make_function_1_type(type_void, type_valist));
64         GNU_BUILTIN(expect,         make_function_2_type(type_long, type_long, type_long));
65         GNU_BUILTIN(return_address, make_function_1_type(type_void_ptr, type_unsigned_int));
66         GNU_BUILTIN(frame_address,  make_function_1_type(type_void_ptr, type_unsigned_int));
67         GNU_BUILTIN(ffs,            make_function_1_type(type_int, type_unsigned_int));
68         GNU_BUILTIN(clz,            make_function_1_type(type_int, type_unsigned_int));
69         GNU_BUILTIN(ctz,            make_function_1_type(type_int, type_unsigned_int));
70         GNU_BUILTIN(popcount,       make_function_1_type(type_int, type_unsigned_int));
71         GNU_BUILTIN(parity,         make_function_1_type(type_int, type_unsigned_int));
72         GNU_BUILTIN(prefetch,       make_function_1_type_variadic(type_float, type_void_ptr));
73         GNU_BUILTIN(trap,           make_function_type(type_void, 0, NULL, DM_NORETURN));
74         GNU_BUILTIN(object_size,    make_function_2_type(type_size_t, type_void_ptr, type_int));
75         GNU_BUILTIN(abort,          make_function_type(type_void, 0, NULL, DM_NORETURN));
76         GNU_BUILTIN(abs,            make_function_type(type_int, 1, (type_t *[]) { type_int }, DM_CONST));
77         GNU_BUILTIN(labs,           make_function_type(type_long, 1, (type_t *[]) { type_long }, DM_CONST));
78         GNU_BUILTIN(llabs,          make_function_type(type_long_long, 1, (type_t *[]) { type_long_long }, DM_CONST));
79         GNU_BUILTIN(memcpy,         make_function_type(type_void_ptr, 3, (type_t *[]) { type_void_ptr_restrict, type_const_void_ptr_restrict, type_size_t }, DM_NONE));
80         GNU_BUILTIN(__memcpy_chk,   make_function_type(type_void_ptr, 4, (type_t *[]) { type_void_ptr_restrict, type_const_void_ptr_restrict, type_size_t, type_size_t}, DM_NONE));
81         GNU_BUILTIN(memcmp,         make_function_type(type_int, 3, (type_t *[]) { type_const_void_ptr, type_const_void_ptr, type_size_t }, DM_PURE));
82         GNU_BUILTIN(memset,         make_function_type(type_void_ptr, 3, (type_t *[]) { type_void_ptr, type_int, type_size_t }, DM_NONE));
83         GNU_BUILTIN(__memset_chk,   make_function_type(type_void_ptr, 4, (type_t *[]) { type_void_ptr, type_int, type_size_t, type_size_t }, DM_NONE));
84         GNU_BUILTIN(memmove,        make_function_type(type_void_ptr, 3, (type_t *[]) { type_void_ptr_restrict, type_const_void_ptr_restrict, type_size_t }, DM_NONE));
85         GNU_BUILTIN(__memmove_chk,  make_function_type(type_void_ptr, 4, (type_t *[]) { type_void_ptr_restrict, type_const_void_ptr_restrict, type_size_t, type_size_t }, DM_NONE));
86         GNU_BUILTIN(strcat,         make_function_type(type_char_ptr, 2, (type_t *[]) { type_char_ptr_restrict, type_const_char_ptr_restrict }, DM_NONE));
87         GNU_BUILTIN(__strcat_chk,   make_function_type(type_char_ptr, 3, (type_t *[]) { type_char_ptr_restrict, type_const_char_ptr_restrict, type_size_t }, DM_NONE));
88         GNU_BUILTIN(strncat,        make_function_type(type_char_ptr, 3, (type_t *[]) { type_char_ptr_restrict, type_const_char_ptr_restrict, type_size_t }, DM_NONE));
89         GNU_BUILTIN(__strncat_chk,  make_function_type(type_char_ptr, 4, (type_t *[]) { type_char_ptr_restrict, type_const_char_ptr_restrict, type_size_t, type_size_t }, DM_NONE));
90         GNU_BUILTIN(strlen,         make_function_type(type_size_t, 1, (type_t *[]) { type_const_char_ptr }, DM_PURE));
91         GNU_BUILTIN(strcmp,         make_function_type(type_int, 2, (type_t *[]) { type_const_char_ptr, type_const_char_ptr }, DM_PURE));
92         GNU_BUILTIN(strcpy,         make_function_type(type_char_ptr, 2, (type_t *[]) { type_char_ptr_restrict, type_const_char_ptr_restrict }, DM_NONE));
93         GNU_BUILTIN(__strcpy_chk,   make_function_type(type_char_ptr, 3, (type_t *[]) { type_char_ptr_restrict, type_const_char_ptr_restrict }, DM_NONE));
94         GNU_BUILTIN(strncpy,        make_function_type(type_char_ptr, 3, (type_t *[]) { type_char_ptr_restrict, type_char_ptr_restrict, type_size_t }, DM_NONE));
95         GNU_BUILTIN(__strncpy_chk,  make_function_type(type_char_ptr, 4, (type_t *[]) { type_char_ptr_restrict, type_char_ptr_restrict, type_size_t, type_size_t }, DM_NONE));
96         GNU_BUILTIN(exit,           make_function_type(type_void, 1, (type_t *[]) { type_int }, DM_NORETURN));
97         GNU_BUILTIN(malloc,         make_function_type(type_void_ptr, 1, (type_t *[]) { type_size_t }, DM_MALLOC));
98
99         /* TODO: gcc has a LONG list of builtin functions (nearly everything from
100          * C89-C99 and others. Complete this */
101
102 #undef GNU_BUILTIN
103 }
104
105 static const char *get_builtin_replacement_name(builtin_kind_t kind)
106 {
107         switch (kind) {
108         case bk_gnu_builtin___memcpy_chk:    return "memcpy";
109         case bk_gnu_builtin___memmove_chk:   return "memmove";
110         case bk_gnu_builtin___memset_chk:    return "memset";
111         case bk_gnu_builtin___snprintf_chk:  return "snprintf";
112         case bk_gnu_builtin___sprintf_chk:   return "sprintf";
113         case bk_gnu_builtin___strcat_chk:    return "strcat";
114         case bk_gnu_builtin___strcpy_chk:    return "strcpy";
115         case bk_gnu_builtin___strncat_chk:   return "strncat";
116         case bk_gnu_builtin___strncpy_chk:   return "strncpy";
117         case bk_gnu_builtin___vsnprintf_chk: return "vsnprintf";
118         case bk_gnu_builtin___vsprintf_chk:  return "vsprintf";
119         case bk_gnu_builtin_abort:           return "abort";
120         case bk_gnu_builtin_abs:             return "abs";
121         case bk_gnu_builtin_exit:            return "exit";
122         case bk_gnu_builtin_labs:            return "labs";
123         case bk_gnu_builtin_llabs:           return "llabs";
124         case bk_gnu_builtin_malloc:          return "malloc";
125         case bk_gnu_builtin_memcmp:          return "memcmp";
126         case bk_gnu_builtin_memcpy:          return "memcpy";
127         case bk_gnu_builtin_memmove:         return "memmove";
128         case bk_gnu_builtin_memset:          return "memset";
129         case bk_gnu_builtin_snprintf:        return "snprintf";
130         case bk_gnu_builtin_sprintf:         return "sprintf";
131         case bk_gnu_builtin_strcat:          return "strcat";
132         case bk_gnu_builtin_strcmp:          return "strcmp";
133         case bk_gnu_builtin_strcpy:          return "strcpy";
134         case bk_gnu_builtin_strlen:          return "strlen";
135         case bk_gnu_builtin_strncat:         return "strncat";
136         case bk_gnu_builtin_strncpy:         return "strncpy";
137         case bk_gnu_builtin_vsnprintf:       return "vsnprintf";
138         case bk_gnu_builtin_vsprintf:        return "vsprintf";
139
140         default:
141                 break;
142         }
143         return NULL;
144 }
145
146 int get_builtin_chk_arg_pos(builtin_kind_t kind)
147 {
148         switch (kind) {
149         case bk_gnu_builtin___sprintf_chk:
150         case bk_gnu_builtin___strcat_chk:
151         case bk_gnu_builtin___strcpy_chk:
152         case bk_gnu_builtin___vsprintf_chk:
153                 return 2;
154         case bk_gnu_builtin___memcpy_chk:
155         case bk_gnu_builtin___memmove_chk:
156         case bk_gnu_builtin___memset_chk:
157         case bk_gnu_builtin___snprintf_chk:
158         case bk_gnu_builtin___strncat_chk:
159         case bk_gnu_builtin___strncpy_chk:
160         case bk_gnu_builtin___vsnprintf_chk:
161                 return 3;
162         default:
163                 break;
164         }
165         return -1;
166 }
167
168 entity_t *get_builtin_replacement(const entity_t *builtin_entity)
169 {
170         builtin_kind_t  kind        = builtin_entity->function.btk;
171         const char     *replacement = get_builtin_replacement_name(kind);
172         if (replacement == NULL)
173                 return NULL;
174
175         entity_t *entity = allocate_entity_zero(ENTITY_FUNCTION);
176         entity->base.symbol           = symbol_table_insert(replacement);
177         entity->base.namespc          = NAMESPACE_NORMAL;
178         entity->base.source_position  = builtin_source_position;
179         entity->declaration.storage_class          = STORAGE_CLASS_EXTERN;
180         entity->declaration.declared_storage_class = STORAGE_CLASS_EXTERN;
181         entity->declaration.type      = builtin_entity->declaration.type;
182         entity->declaration.implicit  = true;
183         entity->declaration.modifiers = builtin_entity->declaration.modifiers;
184
185         return entity;
186 }
187
188 void create_microsoft_intrinsics(void)
189 {
190 #define MS_BUILTIN(a, b) create_builtin_function(bk_ms##a, #a, b)
191
192         /* intrinsics for all architectures */
193         MS_BUILTIN(_rotl,                  make_function_2_type(type_unsigned_int,   type_unsigned_int, type_int));
194         MS_BUILTIN(_rotr,                  make_function_2_type(type_unsigned_int,   type_unsigned_int, type_int));
195         MS_BUILTIN(_rotl64,                make_function_2_type(type_unsigned_int64, type_unsigned_int64, type_int));
196         MS_BUILTIN(_rotr64,                make_function_2_type(type_unsigned_int64, type_unsigned_int64, type_int));
197         MS_BUILTIN(_byteswap_ushort,       make_function_1_type(type_unsigned_short, type_unsigned_short));
198         MS_BUILTIN(_byteswap_ulong,        make_function_1_type(type_unsigned_long,  type_unsigned_long));
199         MS_BUILTIN(_byteswap_uint64,       make_function_1_type(type_unsigned_int64, type_unsigned_int64));
200
201         MS_BUILTIN(__debugbreak,            make_function_0_type(type_void));
202         MS_BUILTIN(_ReturnAddress,          make_function_0_type(type_void_ptr));
203         MS_BUILTIN(_AddressOfReturnAddress, make_function_0_type(type_void_ptr));
204         MS_BUILTIN(__popcount,              make_function_1_type(type_unsigned_int, type_unsigned_int));
205
206         /* x86/x64 only */
207         MS_BUILTIN(_enable,                make_function_0_type(type_void));
208         MS_BUILTIN(_disable,               make_function_0_type(type_void));
209         MS_BUILTIN(__inbyte,               make_function_1_type(type_unsigned_char, type_unsigned_short));
210         MS_BUILTIN(__inword,               make_function_1_type(type_unsigned_short, type_unsigned_short));
211         MS_BUILTIN(__indword,              make_function_1_type(type_unsigned_long, type_unsigned_short));
212         MS_BUILTIN(__outbyte,              make_function_2_type(type_void, type_unsigned_short, type_unsigned_char));
213         MS_BUILTIN(__outword,              make_function_2_type(type_void, type_unsigned_short, type_unsigned_short));
214         MS_BUILTIN(__outdword,             make_function_2_type(type_void, type_unsigned_short, type_unsigned_long));
215         MS_BUILTIN(__ud2,                  make_function_type(type_void, 0, NULL, DM_NORETURN));
216         MS_BUILTIN(_BitScanForward,        make_function_2_type(type_unsigned_char, type_unsigned_long_ptr, type_unsigned_long));
217         MS_BUILTIN(_BitScanReverse,        make_function_2_type(type_unsigned_char, type_unsigned_long_ptr, type_unsigned_long));
218         MS_BUILTIN(_InterlockedExchange,   make_function_2_type(type_long, type_long_ptr, type_long));
219         MS_BUILTIN(_InterlockedExchange64, make_function_2_type(type_int64, type_int64_ptr, type_int64));
220
221         if (machine_size <= 32) {
222                 MS_BUILTIN(__readeflags,           make_function_0_type(type_unsigned_int));
223                 MS_BUILTIN(__writeeflags,          make_function_1_type(type_void, type_unsigned_int));
224         } else {
225                 MS_BUILTIN(__readeflags,           make_function_0_type(type_unsigned_int64));
226                 MS_BUILTIN(__writeeflags,          make_function_1_type(type_void, type_unsigned_int64));
227         }
228
229 #undef MS_BUILTIN
230 }