Whitespace fixes.
[cparser] / attribute.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 <assert.h>
23 #include "diagnostic.h"
24 #include "warning.h"
25 #include "attribute_t.h"
26 #include "symbol_t.h"
27 #include "adt/error.h"
28 #include "type_t.h"
29
30 static const char *const attribute_names[ATTRIBUTE_LAST+1] = {
31         [ATTRIBUTE_GNU_CONST]                  = "const",
32         [ATTRIBUTE_GNU_VOLATILE]               = "volatile",
33         [ATTRIBUTE_GNU_CDECL]                  = "cdecl",
34         [ATTRIBUTE_GNU_STDCALL]                = "stdcall",
35         [ATTRIBUTE_GNU_FASTCALL]               = "fastcall",
36         [ATTRIBUTE_GNU_DEPRECATED]             = "deprecated",
37         [ATTRIBUTE_GNU_NOINLINE]               = "noinline",
38         [ATTRIBUTE_GNU_RETURNS_TWICE]          = "returns_twice",
39         [ATTRIBUTE_GNU_NORETURN]               = "noreturn",
40         [ATTRIBUTE_GNU_NAKED]                  = "naked",
41         [ATTRIBUTE_GNU_PURE]                   = "pure",
42         [ATTRIBUTE_GNU_ALWAYS_INLINE]          = "always_inline",
43         [ATTRIBUTE_GNU_MALLOC]                 = "malloc",
44         [ATTRIBUTE_GNU_WEAK]                   = "weak",
45         [ATTRIBUTE_GNU_CONSTRUCTOR]            = "constructor",
46         [ATTRIBUTE_GNU_DESTRUCTOR]             = "destructor",
47         [ATTRIBUTE_GNU_NOTHROW]                = "nothrow",
48         [ATTRIBUTE_GNU_TRANSPARENT_UNION]      = "transparent_union",
49         [ATTRIBUTE_GNU_COMMON]                 = "common",
50         [ATTRIBUTE_GNU_NOCOMMON]               = "nocommon",
51         [ATTRIBUTE_GNU_PACKED]                 = "packed",
52         [ATTRIBUTE_GNU_SHARED]                 = "shared",
53         [ATTRIBUTE_GNU_NOTSHARED]              = "notshared",
54         [ATTRIBUTE_GNU_USED]                   = "used",
55         [ATTRIBUTE_GNU_UNUSED]                 = "unused",
56         [ATTRIBUTE_GNU_NO_INSTRUMENT_FUNCTION] = "no_instrument_function",
57         [ATTRIBUTE_GNU_WARN_UNUSED_RESULT]     = "warn_unused_result",
58         [ATTRIBUTE_GNU_LONGCALL]               = "longcall",
59         [ATTRIBUTE_GNU_SHORTCALL]              = "shortcall",
60         [ATTRIBUTE_GNU_LONG_CALL]              = "long_call",
61         [ATTRIBUTE_GNU_SHORT_CALL]             = "short_call",
62         [ATTRIBUTE_GNU_FUNCTION_VECTOR]        = "function_vector",
63         [ATTRIBUTE_GNU_INTERRUPT]              = "interrupt",
64         [ATTRIBUTE_GNU_INTERRUPT_HANDLER]      = "interrupt_handler",
65         [ATTRIBUTE_GNU_NMI_HANDLER]            = "nmi_handler",
66         [ATTRIBUTE_GNU_NESTING]                = "nesting",
67         [ATTRIBUTE_GNU_NEAR]                   = "near",
68         [ATTRIBUTE_GNU_FAR]                    = "far",
69         [ATTRIBUTE_GNU_SIGNAL]                 = "signal",
70         [ATTRIBUTE_GNU_EIGTHBIT_DATA]          = "eightbit_data",
71         [ATTRIBUTE_GNU_TINY_DATA]              = "tiny_data",
72         [ATTRIBUTE_GNU_SAVEALL]                = "saveall",
73         [ATTRIBUTE_GNU_FLATTEN]                = "flatten",
74         [ATTRIBUTE_GNU_SSEREGPARM]             = "sseregparm",
75         [ATTRIBUTE_GNU_EXTERNALLY_VISIBLE]     = "externally_visible",
76         [ATTRIBUTE_GNU_MAY_ALIAS]              = "may_alias",
77         [ATTRIBUTE_GNU_MS_STRUCT]              = "ms_struct",
78         [ATTRIBUTE_GNU_GCC_STRUCT]             = "gcc_struct",
79         [ATTRIBUTE_GNU_DLLIMPORT]              = "dllimport",
80         [ATTRIBUTE_GNU_DLLEXPORT]              = "dllexport",
81         [ATTRIBUTE_GNU_ALIGNED]                = "aligned",
82         [ATTRIBUTE_GNU_ALIAS]                  = "alias",
83         [ATTRIBUTE_GNU_SECTION]                = "section",
84         [ATTRIBUTE_GNU_FORMAT]                 = "format",
85         [ATTRIBUTE_GNU_FORMAT_ARG]             = "format_arg",
86         [ATTRIBUTE_GNU_WEAKREF]                = "weakref",
87         [ATTRIBUTE_GNU_NONNULL]                = "nonnull",
88         [ATTRIBUTE_GNU_TLS_MODEL]              = "tls_model",
89         [ATTRIBUTE_GNU_VISIBILITY]             = "visibility",
90         [ATTRIBUTE_GNU_REGPARM]                = "regparm",
91         [ATTRIBUTE_GNU_MODE]                   = "mode",
92         [ATTRIBUTE_GNU_MODEL]                  = "model",
93         [ATTRIBUTE_GNU_TRAP_EXIT]              = "trap_exit",
94         [ATTRIBUTE_GNU_SP_SWITCH]              = "sp_switch",
95         [ATTRIBUTE_GNU_SENTINEL]               = "sentinel",
96
97         [ATTRIBUTE_MS_ALIGN]                   = "align",
98         [ATTRIBUTE_MS_ALLOCATE]                = "allocate",
99         [ATTRIBUTE_MS_DLLIMPORT]               = "dllimport",
100         [ATTRIBUTE_MS_DLLEXPORT]               = "dllexport",
101         [ATTRIBUTE_MS_NAKED]                   = "naked",
102         [ATTRIBUTE_MS_NOINLINE]                = "noinline",
103         [ATTRIBUTE_MS_RETURNS_TWICE]           = "returns_twice",
104         [ATTRIBUTE_MS_NORETURN]                = "noreturn",
105         [ATTRIBUTE_MS_NOTHROW]                 = "nothrow",
106         [ATTRIBUTE_MS_NOVTABLE]                = "novtable",
107         [ATTRIBUTE_MS_PROPERTY]                = "property",
108         [ATTRIBUTE_MS_SELECTANY]               = "selectany",
109         [ATTRIBUTE_MS_THREAD]                  = "thread",
110         [ATTRIBUTE_MS_UUID]                    = "uuid",
111         [ATTRIBUTE_MS_DEPRECATED]              = "deprecated",
112         [ATTRIBUTE_MS_RESTRICT]                = "restrict",
113         [ATTRIBUTE_MS_NOALIAS]                 = "noalias",
114 };
115
116 const char *get_attribute_name(attribute_kind_t kind)
117 {
118         assert(kind <= ATTRIBUTE_LAST);
119         return attribute_names[kind];
120 }
121
122 /**
123  * compare two string, ignoring double underscores on the second.
124  */
125 static int strcmp_underscore(const char *s1, const char *s2)
126 {
127         if (s2[0] == '_' && s2[1] == '_') {
128                 size_t len2 = strlen(s2);
129                 size_t len1 = strlen(s1);
130                 if (len1 == len2-4 && s2[len2-2] == '_' && s2[len2-1] == '_') {
131                         return strncmp(s1, s2+2, len2-4);
132                 }
133         }
134
135         return strcmp(s1, s2);
136 }
137
138 type_t *handle_attribute_mode(const attribute_t *attribute, type_t *orig_type)
139 {
140         type_t *type = skip_typeref(orig_type);
141
142         /* at least: byte, word, pointer, list of machine modes
143          * __XXX___ is interpreted as XXX */
144
145         /* This isn't really correct, the backend should provide a list of machine
146          * specific modes (according to gcc philosophy that is...) */
147         attribute_argument_t *arg        = attribute->a.arguments;
148         const char           *symbol_str = arg->v.symbol->string;
149         bool                  sign       = is_type_signed(type);
150         atomic_type_kind_t  akind;
151         if (strcmp_underscore("QI",   symbol_str) == 0 ||
152             strcmp_underscore("byte", symbol_str) == 0) {
153                 akind = sign ? ATOMIC_TYPE_CHAR : ATOMIC_TYPE_UCHAR;
154         } else if (strcmp_underscore("HI", symbol_str) == 0) {
155                 akind = sign ? ATOMIC_TYPE_SHORT : ATOMIC_TYPE_USHORT;
156         } else if (strcmp_underscore("SI",      symbol_str) == 0
157                 || strcmp_underscore("word",    symbol_str) == 0
158                 || strcmp_underscore("pointer", symbol_str) == 0) {
159                 akind = sign ? ATOMIC_TYPE_INT : ATOMIC_TYPE_UINT;
160         } else if (strcmp_underscore("DI", symbol_str) == 0) {
161                 akind = sign ? ATOMIC_TYPE_LONGLONG : ATOMIC_TYPE_ULONGLONG;
162         } else {
163                 if (warning.other)
164                         warningf(&attribute->source_position, "ignoring unknown mode '%s'",
165                                  symbol_str);
166                 return orig_type;
167         }
168
169         if (type->kind == TYPE_ATOMIC) {
170                 type_t *copy       = duplicate_type(type);
171                 copy->atomic.akind = akind;
172                 return identify_new_type(copy);
173         } else if (type->kind == TYPE_ENUM) {
174                 type_t *copy      = duplicate_type(type);
175                 copy->enumt.akind = akind;
176                 return identify_new_type(copy);
177         } else if (is_type_pointer(type)) {
178                 warningf(&attribute->source_position,
179                          "__attribute__((mode)) on pointers not implemented yet (ignored)");
180                 return type;
181         }
182
183         errorf(&attribute->source_position,
184                "__attribute__((mode)) only allowed on integer, enum or pointer type");
185         return orig_type;
186 }
187
188 static inline bool is_po2(unsigned x)
189 {
190         return (x & (x-1)) == 0;
191 }
192
193 static void handle_attribute_aligned(const attribute_t *attribute,
194                                      entity_t *entity)
195 {
196         int alignment = 32; /* TODO: fill in maximum useful alignment for
197                                                    target machine */
198         if (attribute->a.arguments) {
199                 attribute_argument_t *argument = attribute->a.arguments;
200                 alignment = fold_constant_to_int(argument->v.expression);
201         }
202
203         if (!is_po2(alignment)) {
204                 errorf(&attribute->source_position,
205                            "alignment must be a power of 2 but is %d\n",
206                            alignment);
207                 return;
208         }
209         if (alignment <= 0) {
210                 errorf(&attribute->source_position,
211                            "alignment must be bigger than 0 but is %d\n",
212                            alignment);
213                 return;
214         }
215
216         switch (entity->kind) {
217         DECLARATION_KIND_CASES
218                 entity->declaration.alignment = alignment;
219         case ENTITY_TYPEDEF:
220                 entity->typedefe.alignment = alignment;
221                 break;
222         case ENTITY_STRUCT:
223         case ENTITY_UNION:
224                 if (alignment > entity->compound.alignment) {
225                         entity->compound.alignment = alignment;
226                 }
227                 break;
228         default:
229                 if (warning.other) {
230                         warningf(&attribute->source_position,
231                                          "alignment attribute specification on '%S' ignored",
232                                          entity->base.symbol);
233                 }
234                 break;
235         }
236 }
237
238 static void warn_arguments(const attribute_t *attribute)
239 {
240         if (attribute->a.arguments == NULL)
241                 return;
242
243         if (warning.other) {
244                 warningf(&attribute->source_position,
245                                  "attribute '%s' needs no attributes",
246                                  get_attribute_name(attribute->kind));
247         }
248 }
249
250 static void handle_attribute_packed_e(const attribute_t *attribute,
251                                       entity_t *entity)
252 {
253 #if 0
254         if (entity->kind != ENTITY_STRUCT) {
255                 warningf(&attribute->source_position,
256                          "packed attribute on %s '%s' ignored",
257                                  get_entity_kind_name(entity->kind),
258                                  entity->base.symbol->string);
259                 return;
260         }
261 #endif
262
263         warn_arguments(attribute);
264         entity->compound.packed = true;
265 }
266
267 static void handle_attribute_packed(const attribute_t *attribute, type_t *type)
268 {
269         if (type->kind != TYPE_COMPOUND_STRUCT) {
270                 warningf(&attribute->source_position,
271                          "packed attribute on type '%T' ignored", type);
272                 return;
273         }
274
275         handle_attribute_packed_e(attribute, (entity_t*) type->compound.compound);
276 }
277
278 void handle_entity_attributes(const attribute_t *attributes, entity_t *entity)
279 {
280         if (entity->kind == ENTITY_TYPEDEF) {
281                 type_t *type = entity->typedefe.type;
282                 type = handle_type_attributes(attributes, type);
283                 entity->typedefe.type = type;
284         } else if (is_declaration(entity)) {
285                 type_t *type = entity->declaration.type;
286                 type = handle_type_attributes(attributes, type);
287                 entity->declaration.type = type;
288         }
289
290         decl_modifiers_t modifiers = 0;
291         const attribute_t *attribute = attributes;
292         for ( ; attribute != NULL; attribute = attribute->next) {
293                 switch(attribute->kind) {
294                 case ATTRIBUTE_GNU_CONST:         modifiers |= DM_CONST; break;
295                 case ATTRIBUTE_GNU_DEPRECATED:    modifiers |= DM_DEPRECATED; break;
296                 case ATTRIBUTE_GNU_NOINLINE:      modifiers |= DM_NOINLINE; break;
297                 case ATTRIBUTE_GNU_RETURNS_TWICE: modifiers |= DM_RETURNS_TWICE; break;
298                 case ATTRIBUTE_GNU_NORETURN:      modifiers |= DM_NORETURN; break;
299                 case ATTRIBUTE_GNU_NAKED:         modifiers |= DM_NAKED; break;
300                 case ATTRIBUTE_GNU_PURE:          modifiers |= DM_PURE; break;
301                 case ATTRIBUTE_GNU_ALWAYS_INLINE: modifiers |= DM_FORCEINLINE; break;
302                 case ATTRIBUTE_GNU_MALLOC:        modifiers |= DM_MALLOC; break;
303                 case ATTRIBUTE_GNU_CONSTRUCTOR:   modifiers |= DM_CONSTRUCTOR; break;
304                 case ATTRIBUTE_GNU_DESTRUCTOR:    modifiers |= DM_DESTRUCTOR; break;
305                 case ATTRIBUTE_GNU_NOTHROW:       modifiers |= DM_NOTHROW; break;
306                 case ATTRIBUTE_GNU_TRANSPARENT_UNION:
307                                                                                   modifiers |= DM_TRANSPARENT_UNION;
308                                                                                   break;
309                 case ATTRIBUTE_GNU_USED:          modifiers |= DM_USED; break;
310                 case ATTRIBUTE_GNU_UNUSED:        modifiers |= DM_UNUSED; break;
311                 case ATTRIBUTE_GNU_DLLIMPORT:     modifiers |= DM_DLLIMPORT; break;
312                 case ATTRIBUTE_GNU_DLLEXPORT:     modifiers |= DM_DLLEXPORT; break;
313                 case ATTRIBUTE_GNU_WEAK:          modifiers |= DM_WEAK; break;
314
315                 case ATTRIBUTE_MS_ALLOCATE:      modifiers |= DM_MALLOC; break;
316                 case ATTRIBUTE_MS_DLLIMPORT:     modifiers |= DM_DLLIMPORT; break;
317                 case ATTRIBUTE_MS_DLLEXPORT:     modifiers |= DM_DLLEXPORT; break;
318                 case ATTRIBUTE_MS_NAKED:         modifiers |= DM_NAKED; break;
319                 case ATTRIBUTE_MS_NOINLINE:      modifiers |= DM_NOINLINE; break;
320                 case ATTRIBUTE_MS_RETURNS_TWICE: modifiers |= DM_RETURNS_TWICE; break;
321                 case ATTRIBUTE_MS_NORETURN:      modifiers |= DM_NORETURN; break;
322                 case ATTRIBUTE_MS_NOTHROW:       modifiers |= DM_NOTHROW; break;
323                 case ATTRIBUTE_MS_THREAD:        modifiers |= DM_THREAD; break;
324                 case ATTRIBUTE_MS_DEPRECATED:    modifiers |= DM_DEPRECATED; break;
325                 case ATTRIBUTE_MS_RESTRICT:      modifiers |= DM_RESTRICT; break;
326                 case ATTRIBUTE_MS_NOALIAS:       modifiers |= DM_NOALIAS; break;
327
328                 case ATTRIBUTE_GNU_PACKED:
329                         handle_attribute_packed_e(attribute, entity);
330                         break;
331
332                 case ATTRIBUTE_MS_ALIGN:
333                 case ATTRIBUTE_GNU_ALIGNED:
334                         handle_attribute_aligned(attribute, entity);
335                         break;
336                 default: break;
337                 }
338         }
339
340         if (modifiers != 0) {
341                 switch(entity->kind) {
342                 case ENTITY_TYPEDEF:
343                         entity->typedefe.modifiers |= modifiers;
344                         break;
345                 case ENTITY_UNION:
346                 case ENTITY_STRUCT:
347                         entity->compound.modifiers |= modifiers;
348                         break;
349                 case ENTITY_COMPOUND_MEMBER:
350                 case ENTITY_VARIABLE:
351                 case ENTITY_FUNCTION:
352                         entity->declaration.modifiers |= modifiers;
353                         break;
354                 default:
355                         /* TODO: warning */
356                         break;
357                 }
358         }
359 }
360
361 static type_t *change_calling_convention(type_t *type, cc_kind_t cconv)
362 {
363         if (is_typeref(type) || !is_type_function(type)) {
364                 return type;
365         }
366
367         if (type->function.calling_convention == cconv)
368                 return type;
369
370         type_t* new_type = duplicate_type(type);
371         new_type->function.calling_convention = cconv;
372         return identify_new_type(new_type);
373 }
374
375 type_t *handle_type_attributes(const attribute_t *attributes, type_t *type)
376 {
377         const attribute_t *attribute = attributes;
378         for ( ; attribute != NULL; attribute = attribute->next) {
379                 switch(attribute->kind) {
380                 case ATTRIBUTE_GNU_PACKED:
381                         handle_attribute_packed(attribute, type);
382                         break;
383                 case ATTRIBUTE_GNU_CDECL:
384                 case ATTRIBUTE_MS_CDECL:
385                         type = change_calling_convention(type, CC_CDECL);
386                         break;
387                 case ATTRIBUTE_MS_STDCALL:
388                 case ATTRIBUTE_GNU_STDCALL:
389                         type = change_calling_convention(type, CC_STDCALL);
390                         break;
391                 case ATTRIBUTE_MS_FASTCALL:
392                 case ATTRIBUTE_GNU_FASTCALL:
393                         type = change_calling_convention(type, CC_FASTCALL);
394                         break;
395                 case ATTRIBUTE_MS_THISCALL:
396                         type = change_calling_convention(type, CC_THISCALL);
397                         break;
398                 case ATTRIBUTE_GNU_MODE:
399                         type = handle_attribute_mode(attribute, type);
400                         break;
401                 default:
402                         break;
403                 }
404         }
405
406         return type;
407 }
408
409 const char *get_deprecated_string(const attribute_t *attribute)
410 {
411         for ( ; attribute != NULL; attribute = attribute->next) {
412                 if (attribute->kind != ATTRIBUTE_MS_DEPRECATED)
413                         continue;
414
415                 attribute_argument_t *argument = attribute->a.arguments;
416                 if (argument == NULL)
417                         return NULL;
418                 if (argument->kind != ATTRIBUTE_ARGUMENT_EXPRESSION)
419                         return NULL;
420                 expression_t *expression = argument->v.expression;
421                 if (expression->kind != EXPR_STRING_LITERAL)
422                         return NULL;
423                 return expression->literal.value.begin;
424         }
425         return NULL;
426 }
427
428 static bool property_attribute_equal(const attribute_property_argument_t *prop1,
429                                      const attribute_property_argument_t *prop2)
430 {
431         return prop1->put_symbol == prop2->put_symbol
432                 && prop1->get_symbol == prop2->get_symbol;
433 }
434
435 static bool attribute_argument_equal(const attribute_argument_t *arg1,
436                                      const attribute_argument_t *arg2)
437 {
438         if (arg1->kind != arg2->kind)
439                 return false;
440
441         switch (arg1->kind) {
442         case ATTRIBUTE_ARGUMENT_SYMBOL:
443                 return arg1->v.symbol == arg2->v.symbol;
444         case ATTRIBUTE_ARGUMENT_EXPRESSION:
445                 /* TODO */
446                 return false;
447         }
448         panic("Unknown argument type found");
449 }
450
451 static bool attribute_arguments_equal(const attribute_argument_t *args1,
452                                       const attribute_argument_t *args2)
453 {
454         for ( ; args1 != NULL && args2 != NULL;
455              args1 = args1->next, args2 = args2->next) {
456                 if (!attribute_argument_equal(args1, args2))
457                         return false;
458         }
459         /* both should be NULL now */
460         return args1 == args2;
461 }
462
463 bool attributes_equal(const attribute_t *attr1, const attribute_t *attr2)
464 {
465         if (attr1->kind != attr2->kind)
466                 return false;
467
468         switch (attr1->kind) {
469         case ATTRIBUTE_MS_PROPERTY:
470                 return property_attribute_equal(attr1->a.property, attr2->a.property);
471         default:
472                 return attribute_arguments_equal(attr1->a.arguments,
473                                                  attr2->a.arguments);
474         }
475 }