inline.c

   1 /*
   2  * Sparse - a semantic source parser.
   3  *
   4  * Copyright (C) 2003 Transmeta Corp.
   5  *               2003-2004 Linus Torvalds
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23  * THE SOFTWARE.
  24  */
  25
  26 #include <stdlib.h>
  27 #include <stdio.h>
  28
  29 #include "lib.h"
  30 #include "allocate.h"
  31 #include "token.h"
  32 #include "parse.h"
  33 #include "symbol.h"
  34 #include "expression.h"
  35 #include "evaluate.h"
  36
  37 static void copy_statement(struct statement *src, struct statement *dst);
  38
  39 static struct expression * dup_expression(struct expression *expr)
  40 {
  41         struct expression *dup = alloc_expression(expr->pos, expr->type);
  42         *dup = *expr;
  43         return dup;
  44 }
  45
  46 static struct statement * dup_statement(struct statement *stmt)
  47 {
  48         struct statement *dup = alloc_statement(stmt->pos, stmt->type);
  49         *dup = *stmt;
  50         return dup;
  51 }
  52
  53 static struct symbol *copy_symbol(struct position pos, struct symbol *sym)
  54 {
  55         if (!sym)
  56                 return sym;
  57         if (sym->ctype.modifiers & (MOD_STATIC | MOD_EXTERN | MOD_TOPLEVEL | MOD_INLINE))
  58                 return sym;
  59         if (!sym->replace) {
  60                 warning(pos, "unreplaced symbol '%s'", show_ident(sym->ident));
  61                 return sym;
  62         }
  63         return sym->replace;
  64 }
  65
  66 static struct symbol_list *copy_symbol_list(struct symbol_list *src)
  67 {
  68         struct symbol_list *dst = NULL;
  69         struct symbol *sym;
  70
  71         FOR_EACH_PTR(src, sym) {
  72                 struct symbol *newsym = copy_symbol(sym->pos, sym);
  73                 add_symbol(&dst, newsym);
  74         } END_FOR_EACH_PTR(sym);
  75         return dst;
  76 }
  77
  78 static struct expression * copy_expression(struct expression *expr)
  79 {
  80         if (!expr)
  81                 return NULL;
  82
  83         switch (expr->type) {
  84         /*
  85          * EXPR_SYMBOL is the interesting case, we may need to replace the
  86          * symbol to the new copy.
  87          */
  88         case EXPR_SYMBOL: {
  89                 struct symbol *sym = copy_symbol(expr->pos, expr->symbol);
  90                 if (sym == expr->symbol)
  91                         break;
  92                 expr = dup_expression(expr);
  93                 expr->symbol = sym;
  94                 break;
  95         }
  96
  97         /* Atomics, never change, just return the expression directly */
  98         case EXPR_VALUE:
  99         case EXPR_STRING:
 100         case EXPR_FVALUE:
 101         case EXPR_TYPE:
 102                 break;
 103
 104         /* Unops: check if the subexpression is unique */
 105         case EXPR_PREOP:
 106         case EXPR_POSTOP: {
 107                 struct expression *unop = copy_expression(expr->unop);
 108                 if (expr->unop == unop)
 109                         break;
 110                 expr = dup_expression(expr);
 111                 expr->unop = unop;
 112                 break;
 113         }
 114
 115         case EXPR_SLICE: {
 116                 struct expression *base = copy_expression(expr->base);
 117                 expr = dup_expression(expr);
 118                 expr->base = base;
 119                 break;
 120         }
 121
 122         /* Binops: copy left/right expressions */
 123         case EXPR_BINOP:
 124         case EXPR_COMMA:
 125         case EXPR_COMPARE:
 126         case EXPR_LOGICAL: {
 127                 struct expression *left = copy_expression(expr->left);
 128                 struct expression *right = copy_expression(expr->right);
 129                 if (left == expr->left && right == expr->right)
 130                         break;
 131                 expr = dup_expression(expr);
 132                 expr->left = left;
 133                 expr->right = right;
 134                 break;
 135         }
 136
 137         case EXPR_ASSIGNMENT: {
 138                 struct expression *left = copy_expression(expr->left);
 139                 struct expression *right = copy_expression(expr->right);
 140                 if (expr->op == '=' && left == expr->left && right == expr->right)
 141                         break;
 142                 expr = dup_expression(expr);
 143                 expr->left = left;
 144                 expr->right = right;
 145                 break;
 146         }
 147
 148         /* Dereference */
 149         case EXPR_DEREF: {
 150                 struct expression *deref = copy_expression(expr->deref);
 151                 expr = dup_expression(expr);
 152                 expr->deref = deref;
 153                 break;
 154         }
 155
 156         /* Cast/sizeof/__alignof__ */
 157         case EXPR_CAST:
 158                 if (expr->cast_expression->type == EXPR_INITIALIZER) {
 159                         struct expression *cast = expr->cast_expression;
 160                         struct symbol *sym = expr->cast_type;
 161                         expr = dup_expression(expr);
 162                         expr->cast_expression = copy_expression(cast);
 163                         expr->cast_type = alloc_symbol(sym->pos, sym->type);
 164                         *expr->cast_type = *sym;
 165                         break;
 166                 }
 167         case EXPR_FORCE_CAST:
 168         case EXPR_IMPLIED_CAST:
 169         case EXPR_SIZEOF:
 170         case EXPR_PTRSIZEOF:
 171         case EXPR_ALIGNOF: {
 172                 struct expression *cast = copy_expression(expr->cast_expression);
 173                 if (cast == expr->cast_expression)
 174                         break;
 175                 expr = dup_expression(expr);
 176                 expr->cast_expression = cast;
 177                 break;
 178         }
 179
 180         /* Conditional expression */
 181         case EXPR_SELECT:
 182         case EXPR_CONDITIONAL: {
 183                 struct expression *cond = copy_expression(expr->conditional);
 184                 struct expression *valt = copy_expression(expr->cond_true);
 185                 struct expression *valf = copy_expression(expr->cond_false);
 186                 if (cond == expr->conditional && valt == expr->cond_true && valf == expr->cond_false)
 187                         break;
 188                 expr = dup_expression(expr);
 189                 expr->conditional = cond;
 190                 expr->cond_true = valt;
 191                 expr->cond_false = valf;
 192                 break;
 193         }
 194
 195         /* Statement expression */
 196         case EXPR_STATEMENT: {
 197                 struct statement *stmt = alloc_statement(expr->pos, STMT_COMPOUND);
 198                 copy_statement(expr->statement, stmt);
 199                 expr = dup_expression(expr);
 200                 expr->statement = stmt;
 201                 break;
 202         }
 203
 204         /* Call expression */
 205         case EXPR_CALL: {
 206                 struct expression *fn = copy_expression(expr->fn);
 207                 struct expression_list *list = expr->args;
 208                 struct expression *arg;
 209
 210                 expr = dup_expression(expr);
 211                 expr->fn = fn;
 212                 expr->args = NULL;
 213                 FOR_EACH_PTR(list, arg) {
 214                         add_expression(&expr->args, copy_expression(arg));
 215                 } END_FOR_EACH_PTR(arg);
 216                 break;
 217         }
 218
 219         /* Initializer list statement */
 220         case EXPR_INITIALIZER: {
 221                 struct expression_list *list = expr->expr_list;
 222                 struct expression *entry;
 223                 expr = dup_expression(expr);
 224                 expr->expr_list = NULL;
 225                 FOR_EACH_PTR(list, entry) {
 226                         add_expression(&expr->expr_list, copy_expression(entry));
 227                 } END_FOR_EACH_PTR(entry);
 228                 break;
 229         }
 230
 231         /* Label in inline function - hmm. */
 232         case EXPR_LABEL: {
 233                 struct symbol *label_symbol = copy_symbol(expr->pos, expr->label_symbol);
 234                 expr = dup_expression(expr);
 235                 expr->label_symbol = label_symbol;
 236                 break;
 237         }
 238
 239         case EXPR_INDEX: {
 240                 struct expression *sub_expr = copy_expression(expr->idx_expression);
 241                 expr = dup_expression(expr);
 242                 expr->idx_expression = sub_expr;
 243                 break;
 244         }
 245
 246         case EXPR_IDENTIFIER: {
 247                 struct expression *sub_expr = copy_expression(expr->ident_expression);
 248                 expr = dup_expression(expr);
 249                 expr->ident_expression = sub_expr;
 250                 break;
 251         }
 252
 253         /* Position in initializer.. */
 254         case EXPR_POS: {
 255                 struct expression *val = copy_expression(expr->init_expr);
 256                 expr = dup_expression(expr);
 257                 expr->init_expr = val;
 258                 break;
 259         }
 260         case EXPR_OFFSETOF: {
 261                 struct expression *val = copy_expression(expr->down);
 262                 if (expr->op == '.') {
 263                         if (expr->down != val) {
 264                                 expr = dup_expression(expr);
 265                                 expr->down = val;
 266                         }
 267                 } else {
 268                         struct expression *idx = copy_expression(expr->index);
 269                         if (expr->down != val || expr->index != idx) {
 270                                 expr = dup_expression(expr);
 271                                 expr->down = val;
 272                                 expr->index = idx;
 273                         }
 274                 }
 275                 break;
 276         }
 277         default:
 278                 warning(expr->pos, "trying to copy expression type %d", expr->type);
 279         }
 280         return expr;
 281 }
 282
 283 static struct asm_operand_list *copy_asm_operands(struct asm_operand_list *in)
 284 {
 285         struct asm_operand_list *out = NULL;
 286         struct asm_operand *old;
 287
 288         FOR_EACH_PTR(in, old) {
 289                 struct asm_operand *new = __alloc_asm_operand(0);
 290                 new->name = old->name;
 291                 new->constraint = copy_expression(old->constraint);
 292                 new->expr = copy_expression(old->expr);
 293                 add_ptr_list(&out, new);
 294         } END_FOR_EACH_PTR(old);
 295         return out;
 296 }
 297
 298 static void set_replace(struct symbol *old, struct symbol *new)
 299 {
 300         new->replace = old;
 301         old->replace = new;
 302 }
 303
 304 static void unset_replace(struct symbol *sym)
 305 {
 306         struct symbol *r = sym->replace;
 307         if (!r) {
 308                 warning(sym->pos, "symbol '%s' not replaced?", show_ident(sym->ident));
 309                 return;
 310         }
 311         r->replace = NULL;
 312         sym->replace = NULL;
 313 }
 314
 315 static void unset_replace_list(struct symbol_list *list)
 316 {
 317         struct symbol *sym;
 318         FOR_EACH_PTR(list, sym) {
 319                 unset_replace(sym);
 320         } END_FOR_EACH_PTR(sym);
 321 }
 322
 323 static struct statement *copy_one_statement(struct statement *stmt)
 324 {
 325         if (!stmt)
 326                 return NULL;
 327         switch(stmt->type) {
 328         case STMT_NONE:
 329                 break;
 330         case STMT_DECLARATION: {
 331                 struct symbol *sym;
 332                 struct statement *newstmt = dup_statement(stmt);
 333                 newstmt->declaration = NULL;
 334                 FOR_EACH_PTR(stmt->declaration, sym) {
 335                         struct symbol *newsym = copy_symbol(stmt->pos, sym);
 336                         if (newsym != sym)
 337                                 newsym->initializer = copy_expression(sym->initializer);
 338                         add_symbol(&newstmt->declaration, newsym);
 339                 } END_FOR_EACH_PTR(sym);
 340                 stmt = newstmt;
 341                 break;
 342         }
 343         case STMT_CONTEXT:
 344         case STMT_EXPRESSION: {
 345                 struct expression *expr = copy_expression(stmt->expression);
 346                 if (expr == stmt->expression)
 347                         break;
 348                 stmt = dup_statement(stmt);
 349                 stmt->expression = expr;
 350                 break;
 351         }
 352         case STMT_RANGE: {
 353                 struct expression *expr = copy_expression(stmt->range_expression);
 354                 if (expr == stmt->expression)
 355                         break;
 356                 stmt = dup_statement(stmt);
 357                 stmt->range_expression = expr;
 358                 break;
 359         }
 360         case STMT_COMPOUND: {
 361                 struct statement *new = alloc_statement(stmt->pos, STMT_COMPOUND);
 362                 copy_statement(stmt, new);
 363                 stmt = new;
 364                 break;
 365         }
 366         case STMT_IF: {
 367                 struct expression *cond = stmt->if_conditional;
 368                 struct statement *valt = stmt->if_true;
 369                 struct statement *valf = stmt->if_false;
 370
 371                 cond = copy_expression(cond);
 372                 valt = copy_one_statement(valt);
 373                 valf = copy_one_statement(valf);
 374                 if (stmt->if_conditional == cond &&
 375                     stmt->if_true == valt &&
 376                     stmt->if_false == valf)
 377                         break;
 378                 stmt = dup_statement(stmt);
 379                 stmt->if_conditional = cond;
 380                 stmt->if_true = valt;
 381                 stmt->if_false = valf;
 382                 break;
 383         }
 384         case STMT_RETURN: {
 385                 struct expression *retval = copy_expression(stmt->ret_value);
 386                 struct symbol *sym = copy_symbol(stmt->pos, stmt->ret_target);
 387
 388                 stmt = dup_statement(stmt);
 389                 stmt->ret_value = retval;
 390                 stmt->ret_target = sym;
 391                 break;
 392         }
 393         case STMT_CASE: {
 394                 stmt = dup_statement(stmt);
 395                 stmt->case_label = copy_symbol(stmt->pos, stmt->case_label);
 396                 stmt->case_label->stmt = stmt;
 397                 stmt->case_expression = copy_expression(stmt->case_expression);
 398                 stmt->case_to = copy_expression(stmt->case_to);
 399                 stmt->case_statement = copy_one_statement(stmt->case_statement);
 400                 break;
 401         }
 402         case STMT_SWITCH: {
 403                 struct symbol *switch_break = copy_symbol(stmt->pos, stmt->switch_break);
 404                 struct symbol *switch_case = copy_symbol(stmt->pos, stmt->switch_case);
 405                 struct expression *expr = copy_expression(stmt->switch_expression);
 406                 struct statement *switch_stmt = copy_one_statement(stmt->switch_statement);
 407
 408                 stmt = dup_statement(stmt);
 409                 switch_case->symbol_list = copy_symbol_list(switch_case->symbol_list);
 410                 stmt->switch_break = switch_break;
 411                 stmt->switch_case = switch_case;
 412                 stmt->switch_expression = expr;
 413                 stmt->switch_statement = switch_stmt;
 414                 break;
 415         }
 416         case STMT_ITERATOR: {
 417                 stmt = dup_statement(stmt);
 418                 stmt->iterator_break = copy_symbol(stmt->pos, stmt->iterator_break);
 419                 stmt->iterator_continue = copy_symbol(stmt->pos, stmt->iterator_continue);
 420                 stmt->iterator_syms = copy_symbol_list(stmt->iterator_syms);
 421
 422                 stmt->iterator_pre_statement = copy_one_statement(stmt->iterator_pre_statement);
 423                 stmt->iterator_pre_condition = copy_expression(stmt->iterator_pre_condition);
 424
 425                 stmt->iterator_statement = copy_one_statement(stmt->iterator_statement);
 426
 427                 stmt->iterator_post_statement = copy_one_statement(stmt->iterator_post_statement);
 428                 stmt->iterator_post_condition = copy_expression(stmt->iterator_post_condition);
 429                 break;
 430         }
 431         case STMT_LABEL: {
 432                 stmt = dup_statement(stmt);
 433                 stmt->label_identifier = copy_symbol(stmt->pos, stmt->label_identifier);
 434                 stmt->label_statement = copy_one_statement(stmt->label_statement);
 435                 break;
 436         }
 437         case STMT_GOTO: {
 438                 stmt = dup_statement(stmt);
 439                 stmt->goto_label = copy_symbol(stmt->pos, stmt->goto_label);
 440                 stmt->goto_expression = copy_expression(stmt->goto_expression);
 441                 stmt->target_list = copy_symbol_list(stmt->target_list);
 442                 break;
 443         }
 444         case STMT_ASM: {
 445                 stmt = dup_statement(stmt);
 446                 stmt->asm_inputs = copy_asm_operands(stmt->asm_inputs);
 447                 stmt->asm_outputs = copy_asm_operands(stmt->asm_outputs);
 448                 /* no need to dup "clobbers", since they are all constant strings */
 449                 break;
 450         }
 451         default:
 452                 warning(stmt->pos, "trying to copy statement type %d", stmt->type);
 453                 break;
 454         }
 455         return stmt;
 456 }
 457
 458 /*
 459  * Copy a statement tree from 'src' to 'dst', where both
 460  * source and destination are of type STMT_COMPOUND.
 461  *
 462  * We do this for the tree-level inliner.
 463  *
 464  * This doesn't do the symbol replacement right: it's not
 465  * re-entrant.
 466  */
 467 static void copy_statement(struct statement *src, struct statement *dst)
 468 {
 469         struct statement *stmt;
 470
 471         FOR_EACH_PTR(src->stmts, stmt) {
 472                 add_statement(&dst->stmts, copy_one_statement(stmt));
 473         } END_FOR_EACH_PTR(stmt);
 474         dst->args = copy_one_statement(src->args);
 475         dst->ret = copy_symbol(src->pos, src->ret);
 476         dst->inline_fn = src->inline_fn;
 477 }
 478
 479 static struct symbol *create_copy_symbol(struct symbol *orig)
 480 {
 481         struct symbol *sym = orig;
 482         if (orig) {
 483                 sym = alloc_symbol(orig->pos, orig->type);
 484                 *sym = *orig;
 485                 sym->bb_target = NULL;
 486                 sym->pseudo = NULL;
 487                 set_replace(orig, sym);
 488                 orig = sym;
 489         }
 490         return orig;
 491 }
 492
 493 static struct symbol_list *create_symbol_list(struct symbol_list *src)
 494 {
 495         struct symbol_list *dst = NULL;
 496         struct symbol *sym;
 497
 498         FOR_EACH_PTR(src, sym) {
 499                 struct symbol *newsym = create_copy_symbol(sym);
 500                 add_symbol(&dst, newsym);
 501         } END_FOR_EACH_PTR(sym);
 502         return dst;
 503 }
 504
 505 int inline_function(struct expression *expr, struct symbol *sym)
 506 {
 507         struct symbol_list * fn_symbol_list;
 508         struct symbol *fn = sym->ctype.base_type;
 509         struct expression_list *arg_list = expr->args;
 510         struct statement *stmt = alloc_statement(expr->pos, STMT_COMPOUND);
 511         struct symbol_list *name_list, *arg_decl;
 512         struct symbol *name;
 513         struct expression *arg;
 514
 515         if (!fn->inline_stmt) {
 516                 sparse_error(fn->pos, "marked inline, but without a definition");
 517                 return 0;
 518         }
 519         if (fn->expanding)
 520                 return 0;
 521
 522         name_list = fn->arguments;
 523
 524         expr->type = EXPR_STATEMENT;
 525         expr->statement = stmt;
 526         expr->ctype = fn->ctype.base_type;
 527
 528         fn_symbol_list = create_symbol_list(sym->inline_symbol_list);
 529
 530         arg_decl = NULL;
 531         PREPARE_PTR_LIST(name_list, name);
 532         FOR_EACH_PTR(arg_list, arg) {
 533                 struct symbol *a = alloc_symbol(arg->pos, SYM_NODE);
 534
 535                 a->ctype.base_type = arg->ctype;
 536                 if (name) {
 537                         *a = *name;
 538                         set_replace(name, a);
 539                         add_symbol(&fn_symbol_list, a);
 540                 }
 541                 a->initializer = arg;
 542                 add_symbol(&arg_decl, a);
 543
 544                 NEXT_PTR_LIST(name);
 545         } END_FOR_EACH_PTR(arg);
 546         FINISH_PTR_LIST(name);
 547
 548         copy_statement(fn->inline_stmt, stmt);
 549
 550         if (arg_decl) {
 551                 struct statement *decl = alloc_statement(expr->pos, STMT_DECLARATION);
 552                 decl->declaration = arg_decl;
 553                 stmt->args = decl;
 554         }
 555         stmt->inline_fn = sym;
 556
 557         unset_replace_list(fn_symbol_list);
 558
 559         return 1;
 560 }
 561
 562 void uninline(struct symbol *sym)
 563 {
 564         struct symbol *fn = sym->ctype.base_type;
 565         struct symbol_list *arg_list = fn->arguments;
 566         struct symbol *p;
 567
 568         sym->symbol_list = create_symbol_list(sym->inline_symbol_list);
 569         FOR_EACH_PTR(arg_list, p) {
 570                 p->replace = p;
 571         } END_FOR_EACH_PTR(p);
 572         fn->stmt = alloc_statement(fn->pos, STMT_COMPOUND);
 573         copy_statement(fn->inline_stmt, fn->stmt);
 574         unset_replace_list(sym->symbol_list);
 575         unset_replace_list(arg_list);
 576 }