The outer function entity does not use the F...E delimiters and return type decoration.
[cparser] / mangle.c
1 /*
2  * This file is part of cparser.
3  * Copyright (C) 2007-2008 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 <libfirm/firm.h>
23 #include <string.h>
24
25 #include "entity_t.h"
26 #include "type_t.h"
27 #include "symbol_t.h"
28 #include "mangle.h"
29 #include "diagnostic.h"
30 #include "ast2firm.h"
31 #include "lang_features.h"
32 #include "adt/error.h"
33
34 static struct obstack obst;
35
36 static void mangle_type(type_t *type);
37
38 static char get_atomic_type_mangle(atomic_type_kind_t kind)
39 {
40         switch (kind) {
41         case ATOMIC_TYPE_INVALID: break;
42         case ATOMIC_TYPE_VOID:        return 'v';
43         case ATOMIC_TYPE_BOOL:        return 'b';
44         case ATOMIC_TYPE_CHAR:        return 'c';
45         case ATOMIC_TYPE_SCHAR:       return 'a';
46         case ATOMIC_TYPE_UCHAR:       return 'h';
47         case ATOMIC_TYPE_INT:         return 'i';
48         case ATOMIC_TYPE_UINT:        return 'j';
49         case ATOMIC_TYPE_SHORT:       return 's';
50         case ATOMIC_TYPE_USHORT:      return 't';
51         case ATOMIC_TYPE_LONG:        return 'l';
52         case ATOMIC_TYPE_ULONG:       return 'm';
53         case ATOMIC_TYPE_LONGLONG:    return 'x';
54         case ATOMIC_TYPE_ULONGLONG:   return 'y';
55         case ATOMIC_TYPE_LONG_DOUBLE: return 'e';
56         case ATOMIC_TYPE_FLOAT:       return 'f';
57         case ATOMIC_TYPE_DOUBLE:      return 'd';
58         }
59         panic("invalid atomic type in mangler");
60 }
61
62 static void mangle_atomic_type(const atomic_type_t *type)
63 {
64         obstack_1grow(&obst, get_atomic_type_mangle(type->akind));
65 }
66
67 static void mangle_pointer_type(const pointer_type_t *type)
68 {
69         obstack_1grow(&obst, 'P');
70         mangle_type(type->points_to);
71 }
72
73 static void mangle_parameters(const function_type_t *type)
74 {
75         if (type->unspecified_parameters)
76                 panic("can't mangle unspecified parameter types");
77         if (type->kr_style_parameters)
78                 panic("can't mangle kr_style_parameters type");
79
80         const function_parameter_t *parameter = type->parameters;
81         if (parameter != NULL) {
82                 for ( ; parameter != NULL; parameter = parameter->next) {
83                         mangle_type(parameter->type);
84                 }
85                 if (type->variadic) {
86                         obstack_1grow(&obst, 'z');
87                 }
88         } else {
89                 obstack_1grow(&obst, 'v');
90         }
91 }
92
93 static void mangle_function_type(const function_type_t *type)
94 {
95         obstack_1grow(&obst, 'F');
96         if (type->linkage == LINKAGE_C) {
97                 obstack_1grow(&obst, 'Y');
98         }
99
100         mangle_type(type->return_type);
101         mangle_parameters(type);
102
103         obstack_1grow(&obst, 'E');
104 }
105
106 static void mangle_qualifiers(type_qualifiers_t qualifiers)
107 {
108         if (qualifiers & TYPE_QUALIFIER_RESTRICT)
109                 obstack_1grow(&obst, 'r');
110         if (qualifiers & TYPE_QUALIFIER_VOLATILE)
111                 obstack_1grow(&obst, 'V');
112         if (qualifiers & TYPE_QUALIFIER_CONST)
113                 obstack_1grow(&obst, 'K');
114
115         /* handle MS extended qualifiers? */
116 }
117
118 static void mangle_type(type_t *orig_type)
119 {
120         type_t *type = skip_typeref(orig_type);
121
122         mangle_qualifiers(type->base.qualifiers);
123
124         switch (type->kind) {
125         case TYPE_ATOMIC:
126                 mangle_atomic_type(&type->atomic);
127                 return;
128         case TYPE_POINTER:
129                 mangle_pointer_type(&type->pointer);
130                 return;
131         case TYPE_FUNCTION:
132                 mangle_function_type(&type->function);
133                 return;
134         case TYPE_INVALID:
135                 panic("invalid type encountered while mangling");
136         case TYPE_ERROR:
137                 panic("error type encountered while mangling");
138         case TYPE_BUILTIN:
139         case TYPE_TYPEDEF:
140         case TYPE_TYPEOF:
141                 panic("typeref not resolved while manging?!?");
142
143         case TYPE_BITFIELD:
144         case TYPE_COMPLEX:
145         case TYPE_IMAGINARY:
146         case TYPE_COMPOUND_STRUCT:
147         case TYPE_COMPOUND_UNION:
148         case TYPE_ENUM:
149         case TYPE_ARRAY:
150                 panic("no mangling for this type implemented yet");
151                 break;
152         }
153         panic("invalid type encountered while mangling");
154 }
155
156 static void mangle_entity(entity_t *entity)
157 {
158         obstack_1grow(&obst, '_');
159         obstack_1grow(&obst, 'Z');
160
161         /* TODO: mangle scope */
162
163         symbol_t *symbol = entity->base.symbol;
164         obstack_printf(&obst, "%u%s", strlen(symbol->string), symbol->string);
165
166         if (entity->kind == ENTITY_FUNCTION) {
167                 mangle_parameters(&entity->declaration.type->function);
168         }
169 }
170
171 static ident *make_id_from_obst(void)
172 {
173         size_t  size = obstack_object_size(&obst);
174         char   *str  = obstack_finish(&obst);
175         ident  *id   = new_id_from_chars(str, size);
176         obstack_free(&obst, str);
177         return id;
178 }
179
180 /**
181  * Mangles an entity linker (ld) name for win32 usage.
182  *
183  * @param ent          the entity to be mangled
184  * @param declaration  the declaration
185  */
186 ident *create_name_win32(entity_t *entity)
187 {
188         struct obstack *o = &obst;
189
190         assert(is_declaration(entity));
191
192         if (entity->declaration.modifiers & DM_DLLIMPORT) {
193                 /* add prefix for imported symbols */
194                 obstack_printf(o, "__imp_");
195         }
196
197         if (entity->kind == ENTITY_FUNCTION) {
198                 cc_kind_t cc = entity->declaration.type->function.calling_convention;
199
200                 /* calling convention prefix */
201                 switch (cc) {
202                         case CC_DEFAULT:
203                         case CC_CDECL:
204                         case CC_STDCALL:  obstack_1grow(o, '_'); break;
205                         case CC_FASTCALL: obstack_1grow(o, '@'); break;
206                         default:          panic("unhandled calling convention");
207                 }
208
209                 switch (entity->declaration.type->function.linkage) {
210                         case LINKAGE_INVALID:
211                                 break;
212
213                         case LINKAGE_C:
214                                 obstack_printf(o, "%s", entity->base.symbol->string);
215                                 break;
216
217                         case LINKAGE_CXX:
218                                 mangle_entity(entity);
219                                 break;
220                 }
221
222                 /* calling convention suffix */
223                 switch (cc) {
224                         case CC_DEFAULT:
225                         case CC_CDECL:
226                                 break;
227
228                         case CC_STDCALL:
229                         case CC_FASTCALL: {
230                                 ir_type *irtype = get_ir_type(entity->declaration.type);
231                                 size_t   size   = 0;
232                                 for (int i = get_method_n_params(irtype) - 1; i >= 0; --i) {
233                                         size += get_type_size_bytes(get_method_param_type(irtype, i));
234                                 }
235                                 obstack_printf(o, "@%zu\n", size);
236                                 break;
237                         }
238
239                         default:
240                                 panic("unhandled calling convention");
241                 }
242         } else {
243                 obstack_printf(o, "_%s", entity->base.symbol->string);
244         }
245
246         return make_id_from_obst();
247 }
248
249 /**
250  * Mangles an entity linker (ld) name for Linux ELF usage.
251  *
252  * @param ent          the entity to be mangled
253  * @param declaration  the declaration
254  */
255 ident *create_name_linux_elf(entity_t *entity)
256 {
257         bool needs_mangling = false;
258
259         if (entity->kind == ENTITY_FUNCTION) {
260                 switch (entity->declaration.type->function.linkage) {
261                         case LINKAGE_INVALID: break;
262                         case LINKAGE_C:       break;
263                         case LINKAGE_CXX:     needs_mangling = true; break;
264                 }
265         }
266
267         if (needs_mangling) {
268                 mangle_entity(entity);
269                 return make_id_from_obst();
270         }
271
272         return new_id_from_str(entity->base.symbol->string);
273 }
274
275 /**
276  * Mangles an entity linker (ld) name for Mach-O usage.
277  *
278  * @param ent          the entity to be mangled
279  * @param declaration  the declaration
280  */
281 ident *create_name_macho(entity_t *entity)
282 {
283         obstack_printf(&obst, "_%s", entity->base.symbol->string);
284         return make_id_from_obst();
285 }
286
287 void init_mangle(void)
288 {
289         obstack_init(&obst);
290 }
291
292 void exit_mangle(void)
293 {
294         obstack_free(&obst, NULL);
295 }