source: src/GenPoly/Lvalue.cc @ ba89e9b7

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerpthread-emulationqualifiedEnumwith_gc
Last change on this file since ba89e9b7 was ba89e9b7, checked in by Rob Schluntz <rschlunt@…>, 5 years ago

Temporarily enable more debug information

  • Property mode set to 100644
File size: 20.0 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo
3//
4// The contents of this file are covered under the licence agreement in the
5// file "LICENCE" distributed with Cforall.
6//
7// Lvalue.cc --
8//
9// Author           : Richard C. Bilson
10// Created On       : Mon May 18 07:44:20 2015
11// Last Modified By : Peter A. Buhr
12// Last Modified On : Fri Mar 17 09:11:18 2017
13// Update Count     : 5
14//
15
16#include <cassert>                       // for strict_dynamic_cast
17#include <string>                        // for string
18
19#include "Common/Debug.h"
20#include "Common/PassVisitor.h"
21#include "GenPoly.h"                     // for isPolyType
22#include "Lvalue.h"
23
24#include "Parser/LinkageSpec.h"          // for Spec, isBuiltin, Intrinsic
25#include "ResolvExpr/TypeEnvironment.h"  // for AssertionSet, OpenVarSet
26#include "ResolvExpr/Unify.h"            // for unify
27#include "ResolvExpr/typeops.h"
28#include "SymTab/Autogen.h"
29#include "SymTab/Indexer.h"              // for Indexer
30#include "SynTree/Declaration.h"         // for Declaration, FunctionDecl
31#include "SynTree/Expression.h"          // for Expression, ConditionalExpr
32#include "SynTree/Mutator.h"             // for mutateAll, Mutator
33#include "SynTree/Statement.h"           // for ReturnStmt, Statement (ptr o...
34#include "SynTree/Type.h"                // for PointerType, Type, FunctionType
35#include "SynTree/Visitor.h"             // for Visitor, acceptAll
36
37#if 0
38#define PRINT(x) x
39#else
40#define PRINT(x)
41#endif
42
43namespace GenPoly {
44        namespace {
45                // TODO: fold this into the general createDeref function??
46                Expression * mkDeref( Expression * arg ) {
47                        if ( SymTab::dereferenceOperator ) {
48                                // note: reference depth can be arbitrarily deep here, so peel off the outermost pointer/reference, not just pointer because they are effecitvely equivalent in this pass
49                                VariableExpr * deref = new VariableExpr( SymTab::dereferenceOperator );
50                                deref->result = new PointerType( Type::Qualifiers(), deref->result );
51                                Type * base = InitTweak::getPointerBase( arg->result );
52                                assertf( base, "expected pointer type in dereference (type was %s)", toString( arg->result ).c_str() );
53                                ApplicationExpr * ret = new ApplicationExpr( deref, { arg } );
54                                delete ret->result;
55                                ret->result = base->clone();
56                                ret->result->set_lvalue( true );
57                                return ret;
58                        } else {
59                                return UntypedExpr::createDeref( arg );
60                        }
61                }
62
63                struct ReferenceConversions final : public WithStmtsToAdd {
64                        Expression * postmutate( CastExpr * castExpr );
65                        Expression * postmutate( AddressExpr * addrExpr );
66                };
67
68                /// Intrinsic functions that take reference parameters don't REALLY take reference parameters -- their reference arguments must always be implicitly dereferenced.
69                struct FixIntrinsicArgs final {
70                        Expression * postmutate( ApplicationExpr * appExpr );
71                };
72
73                struct FixIntrinsicResult final : public WithGuards {
74                        Expression * postmutate( ApplicationExpr * appExpr );
75                        void premutate( FunctionDecl * funcDecl );
76                        bool inIntrinsic = false;
77                };
78
79                /// Replace reference types with pointer types
80                struct ReferenceTypeElimination final {
81                        Type * postmutate( ReferenceType * refType );
82                };
83
84                /// GCC-like Generalized Lvalues (which have since been removed from GCC)
85                /// https://gcc.gnu.org/onlinedocs/gcc-3.4.6/gcc/Lvalues.html#Lvalues
86                /// Replaces &(a,b) with (a, &b), &(a ? b : c) with (a ? &b : &c)
87                struct GeneralizedLvalue final : public WithVisitorRef<GeneralizedLvalue> {
88                        Expression * postmutate( AddressExpr * addressExpr );
89                        Expression * postmutate( MemberExpr * memExpr );
90
91                        template<typename Func>
92                        Expression * applyTransformation( Expression * expr, Expression * arg, Func mkExpr );
93                };
94
95                /// Removes redundant &*/*& pattern that this pass can generate
96                struct CollapseAddrDeref final {
97                        Expression * postmutate( AddressExpr * addressExpr );
98                        Expression * postmutate( ApplicationExpr * appExpr );
99                };
100
101                struct AddrRef final : public WithGuards {
102                        void premutate( AddressExpr * addrExpr );
103                        Expression * postmutate( AddressExpr * addrExpr );
104                        void premutate( Expression * expr );
105
106                        bool first = true;
107                        bool current = false;
108                        int refDepth = 0;
109                };
110        } // namespace
111
112        static bool referencesEliminated = false;
113        // used by UntypedExpr::createDeref to determine whether result type of dereference should be ReferenceType or value type.
114        bool referencesPermissable() {
115                return ! referencesEliminated;
116        }
117
118        void convertLvalue( std::list< Declaration* > & translationUnit ) {
119                PassVisitor<ReferenceConversions> refCvt;
120                PassVisitor<ReferenceTypeElimination> elim;
121                PassVisitor<GeneralizedLvalue> genLval;
122                PassVisitor<FixIntrinsicArgs> fixer;
123                PassVisitor<CollapseAddrDeref> collapser;
124                PassVisitor<AddrRef> addrRef;
125                PassVisitor<FixIntrinsicResult> intrinsicResults;
126                Debug::codeGen( translationUnit, "begin" );
127                mutateAll( translationUnit, intrinsicResults );
128                Debug::codeGen( translationUnit, "intrinsicResults" );
129                mutateAll( translationUnit, addrRef );
130                Debug::codeGen( translationUnit, "addrRef" );
131                mutateAll( translationUnit, refCvt );
132                Debug::codeGen( translationUnit, "refCvt" );
133                mutateAll( translationUnit, fixer );
134                Debug::codeGen( translationUnit, "fixer" );
135                mutateAll( translationUnit, collapser );
136                Debug::codeGen( translationUnit, "collapser" );
137                mutateAll( translationUnit, genLval );
138                Debug::codeGen( translationUnit, "genLval" );
139                mutateAll( translationUnit, elim );  // last because other passes need reference types to work
140                Debug::codeGen( translationUnit, "elim" );
141
142                // from this point forward, no other pass should create reference types.
143                referencesEliminated = true;
144        }
145
146        Expression * generalizedLvalue( Expression * expr ) {
147                PassVisitor<GeneralizedLvalue> genLval;
148                return expr->acceptMutator( genLval );
149        }
150
151        namespace {
152                // true for intrinsic function calls that return a reference
153                bool isIntrinsicReference( Expression * expr ) {
154                        if ( UntypedExpr * untyped = dynamic_cast< UntypedExpr * >( expr ) ) {
155                                std::string fname = InitTweak::getFunctionName( untyped );
156                                // known intrinsic-reference prelude functions
157                                return fname == "*?" || fname == "?[?]";
158                        } else if ( ApplicationExpr * appExpr = dynamic_cast< ApplicationExpr * > ( expr ) ) {
159                                if ( DeclarationWithType * func = InitTweak::getFunction( appExpr ) ) {
160                                        // use type of return variable rather than expr result type, since it may have been changed to a pointer type
161                                        FunctionType * ftype = GenPoly::getFunctionType( func->get_type() );
162                                        Type * ret = ftype->returnVals.empty() ? nullptr : ftype->returnVals.front()->get_type();
163                                        return func->linkage == LinkageSpec::Intrinsic && dynamic_cast<ReferenceType *>( ret );
164                                }
165                        }
166                        return false;
167                }
168
169                Expression * FixIntrinsicResult::postmutate( ApplicationExpr * appExpr ) {
170                        if ( isIntrinsicReference( appExpr ) ) {
171                                // eliminate reference types from intrinsic applications - now they return lvalues
172                                Type * result = appExpr->result;
173                                appExpr->result = result->stripReferences()->clone();
174                                appExpr->result->set_lvalue( true );
175                                if ( ! inIntrinsic ) {
176                                        // when not in an intrinsic function, add a cast to
177                                        // don't add cast when in an intrinsic function, since they already have the cast
178                                        Expression * ret = new CastExpr( appExpr, result );
179                                        std::swap( ret->env, appExpr->env );
180                                        return ret;
181                                }
182                                delete result;
183                        }
184                        return appExpr;
185                }
186
187                void FixIntrinsicResult::premutate( FunctionDecl * funcDecl ) {
188                        GuardValue( inIntrinsic );
189                        inIntrinsic =  funcDecl->linkage == LinkageSpec::Intrinsic;
190                }
191
192                Expression * FixIntrinsicArgs::postmutate( ApplicationExpr * appExpr ) {
193                        // intrinsic functions don't really take reference-typed parameters, so they require an implicit dereference on their arguments.
194                        if ( DeclarationWithType * function = InitTweak::getFunction( appExpr ) ) {
195                                FunctionType * ftype = GenPoly::getFunctionType( function->get_type() );
196                                assertf( ftype, "Function declaration does not have function type." );
197                                // can be of differing lengths only when function is variadic
198                                assertf( ftype->parameters.size() == appExpr->args.size() || ftype->isVarArgs, "ApplicationExpr args do not match formal parameter type." );
199
200
201                                unsigned int i = 0;
202                                const unsigned int end = ftype->parameters.size();
203                                for ( auto p : unsafe_group_iterate( appExpr->args, ftype->parameters ) ) {
204                                        if (i == end) break;
205                                        Expression *& arg = std::get<0>( p );
206                                        Type * formal = std::get<1>( p )->get_type();
207                                        PRINT(
208                                                std::cerr << "pair<0>: " << arg << std::endl;
209                                                std::cerr << " -- " << arg->result << std::endl;
210                                                std::cerr << "pair<1>: " << formal << std::endl;
211                                        )
212                                        if ( dynamic_cast<ReferenceType*>( formal ) ) {
213                                                PRINT(
214                                                        std::cerr << "===formal is reference" << std::endl;
215                                                )
216                                                // TODO: it's likely that the second condition should be ... && ! isIntrinsicReference( arg ), but this requires investigation.
217                                                // if ( function->get_linkage() != LinkageSpec::Intrinsic && isIntrinsicReference( arg ) ) {
218                                                //      // if argument is dereference or array subscript, the result isn't REALLY a reference, but non-intrinsic functions expect a reference: take address
219                                                //      // PRINT(
220                                                //              std::cerr << "===is intrinsic arg in non-intrinsic call - adding address" << std::endl;
221                                                //      // )
222                                                //      arg = new AddressExpr( arg );
223                                                // } else
224                                                // if ( function->get_linkage() == LinkageSpec::Intrinsic && arg->result->referenceDepth() != 0 ) {
225                                                if ( function->get_linkage() == LinkageSpec::Intrinsic && InitTweak::getPointerBase( arg->result ) ) {
226
227                                                        // needed for definition of prelude functions, etc.
228
229                                                        // argument is a 'real' reference, but function expects a C lvalue: add a dereference to the reference-typed argument
230                                                        PRINT(
231                                                                std::cerr << "===is non-intrinsic arg in intrinsic call - adding deref to arg" << std::endl;
232                                                        )
233                                                        Type * baseType = InitTweak::getPointerBase( arg->result );
234                                                        assertf( baseType, "parameter is reference, arg must be pointer or reference: %s", toString( arg->result ).c_str() );
235                                                        PointerType * ptrType = new PointerType( Type::Qualifiers(), baseType->clone() );
236                                                        delete arg->result;
237                                                        arg->result = ptrType;
238                                                        arg = mkDeref( arg );
239                                                        // assertf( arg->result->referenceDepth() == 0, "Reference types should have been eliminated from intrinsic function calls, but weren't: %s", toCString( arg->result ) );
240                                                }
241                                        }
242                                        ++i;
243                                }
244                        }
245                        return appExpr;
246                }
247
248                // idea: &&&E: get outer &, inner &
249                // at inner &, record depth D of reference type
250                // at outer &, add D derefs.
251                void AddrRef::premutate( Expression * ) {
252                        GuardValue( current );
253                        GuardValue( first );
254                        current = false;
255                        first = true;
256                }
257
258                void AddrRef::premutate( AddressExpr * ) {
259                        GuardValue( current );
260                        GuardValue( first );
261                        current = first;
262                        first = false;
263                        if ( current ) {
264                                GuardValue( refDepth );
265                                refDepth = 0;
266                        }
267                }
268
269                Expression * AddrRef::postmutate( AddressExpr * addrExpr ) {
270                        if ( refDepth == 0 ) {
271                                if ( ! isIntrinsicReference( addrExpr->arg ) ) {
272                                        // try to avoid ?[?]
273                                        refDepth = addrExpr->arg->result->referenceDepth();
274                                }
275                        }
276                        if ( current ) {
277                                Expression * ret = addrExpr;
278                                while ( refDepth ) {
279                                        ret = mkDeref( ret );
280                                        refDepth--;
281                                }
282                                return ret;
283                        }
284                        return addrExpr;
285                }
286
287                Expression * ReferenceConversions::postmutate( AddressExpr * addrExpr ) {
288                        // Inner expression may have been lvalue to reference conversion, which becomes an address expression.
289                        // In this case, remove the outer address expression and return the argument.
290                        // TODO: It's possible that this might catch too much and require a more sophisticated check.
291                        return addrExpr;
292                }
293
294                Expression * ReferenceConversions::postmutate( CastExpr * castExpr ) {
295                        // xxx - is it possible to convert directly between reference types with a different base? E.g.,
296                        //   int x;
297                        //   (double&)x;
298                        // At the moment, I am working off of the assumption that this is illegal, thus the cast becomes redundant
299                        // after this pass, so trash the cast altogether. If that changes, care must be taken to insert the correct
300                        // pointer casts in the right places.
301
302                        // Note: reference depth difference is the determining factor in what code is run, rather than whether something is
303                        // reference type or not, since conversion still needs to occur when both types are references that differ in depth.
304
305                        Type * destType = castExpr->result;
306                        Type * srcType = castExpr->arg->result;
307                        int depth1 = destType->referenceDepth();
308                        int depth2 = srcType->referenceDepth();
309                        int diff = depth1 - depth2;
310
311                        if ( diff > 0 && ! srcType->get_lvalue() ) {
312                                // rvalue to reference conversion -- introduce temporary
313                                // know that reference depth of cast argument is 0, need to introduce n temporaries for reference depth of n, e.g.
314                                //   (int &&&)3;
315                                // becomes
316                                //   int __ref_tmp_0 = 3;
317                                //   int & __ref_tmp_1 = _&_ref_tmp_0;
318                                //   int && __ref_tmp_2 = &__ref_tmp_1;
319                                //   &__ref_tmp_2;
320                                // the last & comes from the remaining reference conversion code
321                                SemanticWarning( castExpr->arg->location, Warning::RvalueToReferenceConversion, toCString( castExpr->arg ) );
322
323                                static UniqueName tempNamer( "__ref_tmp_" );
324                                ObjectDecl * temp = ObjectDecl::newObject( tempNamer.newName(), castExpr->arg->result->clone(), new SingleInit( castExpr->arg ) );
325                                PRINT( std::cerr << "made temp: " << temp << std::endl; )
326                                stmtsToAddBefore.push_back( new DeclStmt( temp ) );
327                                for ( int i = 0; i < depth1-1; i++ ) { // xxx - maybe this should be diff-1? check how this works with reference type for srcType
328                                        ObjectDecl * newTemp = ObjectDecl::newObject( tempNamer.newName(), new ReferenceType( Type::Qualifiers(), temp->type->clone() ), new SingleInit( new AddressExpr( new VariableExpr( temp ) ) ) );
329                                        PRINT( std::cerr << "made temp" << i << ": " << newTemp << std::endl; )
330                                        stmtsToAddBefore.push_back( new DeclStmt( newTemp ) );
331                                        temp = newTemp;
332                                }
333                                // update diff so that remaining code works out correctly
334                                castExpr->arg = new VariableExpr( temp );
335                                PRINT( std::cerr << "update cast to: " << castExpr << std::endl; )
336                                srcType = castExpr->arg->result;
337                                depth2 = srcType->referenceDepth();
338                                diff = depth1 - depth2;
339                                assert( diff == 1 );
340                        }
341
342                        // handle conversion between different depths
343                        PRINT (
344                                if ( depth1 || depth2 ) {
345                                        std::cerr << "destType: " << destType << " / srcType: " << srcType << std::endl;
346                                        std::cerr << "depth: " << depth1 << " / " << depth2 << std::endl;
347                                }
348                        )
349                        if ( diff > 0 ) {
350                                // conversion to type with more depth (e.g. int & -> int &&): add address-of for each level of difference
351                                Expression * ret = castExpr->arg;
352                                for ( int i = 0; i < diff; ++i ) {
353                                        ret = new AddressExpr( ret );
354                                }
355                                if ( srcType->get_lvalue() && srcType->get_qualifiers() != strict_dynamic_cast<ReferenceType *>( destType )->base->get_qualifiers() ) {
356                                        // must keep cast if cast-to type is different from the actual type
357                                        castExpr->arg = ret;
358                                        return castExpr;
359                                }
360                                ret->env = castExpr->env;
361                                delete ret->result;
362                                ret->result = castExpr->result;
363                                castExpr->env = nullptr;
364                                castExpr->arg = nullptr;
365                                castExpr->result = nullptr;
366                                delete castExpr;
367                                return ret;
368                        } else if ( diff < 0 ) {
369                                // conversion to type with less depth (e.g. int && -> int &): add dereferences for each level of difference
370                                diff = -diff; // care only about magnitude now
371                                Expression * ret = castExpr->arg;
372                                for ( int i = 0; i < diff; ++i ) {
373                                        ret = mkDeref( ret );
374                                        // xxx - try removing one reference here? actually, looks like mkDeref already does this, so more closely look at the types generated.
375                                }
376                                if ( ! ResolvExpr::typesCompatibleIgnoreQualifiers( destType->stripReferences(), srcType->stripReferences(), SymTab::Indexer() ) ) {
377                                        // must keep cast if types are different
378                                        castExpr->arg = ret;
379                                        return castExpr;
380                                }
381                                ret->env = castExpr->env;
382                                delete ret->result;
383                                ret->result = castExpr->result;
384                                ret->result->set_lvalue( true ); // ensure result is lvalue
385                                castExpr->env = nullptr;
386                                castExpr->arg = nullptr;
387                                castExpr->result = nullptr;
388                                delete castExpr;
389                                return ret;
390                        } else {
391                                assert( diff == 0 );
392                                // conversion between references of the same depth
393                                return castExpr;
394                        }
395                }
396
397                Type * ReferenceTypeElimination::postmutate( ReferenceType * refType ) {
398                        Type * base = refType->base;
399                        Type::Qualifiers qualifiers = refType->get_qualifiers();
400                        refType->base = nullptr;
401                        delete refType;
402                        return new PointerType( qualifiers, base );
403                }
404
405                template<typename Func>
406                Expression * GeneralizedLvalue::applyTransformation( Expression * expr, Expression * arg, Func mkExpr ) {
407                        if ( CommaExpr * commaExpr = dynamic_cast< CommaExpr * >( arg ) ) {
408                                Expression * arg1 = commaExpr->arg1->clone();
409                                Expression * arg2 = commaExpr->arg2->clone();
410                                Expression * ret = new CommaExpr( arg1, mkExpr( arg2 )->acceptMutator( *visitor ) );
411                                ret->env = expr->env;
412                                expr->env = nullptr;
413                                delete expr;
414                                return ret;
415                        } else if ( ConditionalExpr * condExpr = dynamic_cast< ConditionalExpr * >( arg ) ) {
416                                Expression * arg1 = condExpr->arg1->clone();
417                                Expression * arg2 = condExpr->arg2->clone();
418                                Expression * arg3 = condExpr->arg3->clone();
419                                ConditionalExpr * ret = new ConditionalExpr( arg1, mkExpr( arg2 )->acceptMutator( *visitor ), mkExpr( arg3 )->acceptMutator( *visitor ) );
420                                ret->env = expr->env;
421                                expr->env = nullptr;
422                                delete expr;
423
424                                // conditional expr type may not be either of the argument types, need to unify
425                                using namespace ResolvExpr;
426                                Type* commonType = nullptr;
427                                TypeEnvironment newEnv;
428                                AssertionSet needAssertions, haveAssertions;
429                                OpenVarSet openVars;
430                                unify( ret->arg2->result, ret->arg3->result, newEnv, needAssertions, haveAssertions, openVars, SymTab::Indexer(), commonType );
431                                ret->result = commonType ? commonType : ret->arg2->result->clone();
432                                return ret;
433                        }
434                        return expr;
435                }
436
437                Expression * GeneralizedLvalue::postmutate( MemberExpr * memExpr ) {
438                        return applyTransformation( memExpr, memExpr->aggregate, [=]( Expression * aggr ) { return new MemberExpr( memExpr->member, aggr ); } );
439                }
440
441                Expression * GeneralizedLvalue::postmutate( AddressExpr * addrExpr ) {
442                        return applyTransformation( addrExpr, addrExpr->arg, []( Expression * arg ) { return new AddressExpr( arg ); } );
443                }
444
445                Expression * CollapseAddrDeref::postmutate( AddressExpr * addrExpr ) {
446                        Expression * arg = addrExpr->arg;
447                        if ( isIntrinsicReference( arg ) ) {
448                                std::string fname = InitTweak::getFunctionName( arg );
449                                if ( fname == "*?" ) {
450                                        Expression *& arg0 = InitTweak::getCallArg( arg, 0 );
451                                        Expression * ret = arg0;
452                                        ret->set_env( addrExpr->env );
453                                        arg0 = nullptr;
454                                        addrExpr->env = nullptr;
455                                        delete addrExpr;
456                                        return ret;
457                                }
458                        } else if ( CastExpr * castExpr = dynamic_cast< CastExpr * > ( arg ) ) {
459                                // need to move cast to pointer type out a level since address of pointer
460                                // is not valid C code (can be introduced in prior passes, e.g., InstantiateGeneric)
461                                if ( InitTweak::getPointerBase( castExpr->result ) ) {
462                                        addrExpr->arg = castExpr->arg;
463                                        castExpr->arg = addrExpr;
464                                        castExpr->result = new PointerType( Type::Qualifiers(), castExpr->result );
465                                        return castExpr;
466                                }
467                        }
468                        return addrExpr;
469                }
470
471                Expression * CollapseAddrDeref::postmutate( ApplicationExpr * appExpr ) {
472                        if ( isIntrinsicReference( appExpr ) ) {
473                                std::string fname = InitTweak::getFunctionName( appExpr );
474                                if ( fname == "*?" ) {
475                                        Expression * arg = InitTweak::getCallArg( appExpr, 0 );
476                                        // xxx - this isn't right, because it can remove casts that should be there...
477                                        // while ( CastExpr * castExpr = dynamic_cast< CastExpr * >( arg ) ) {
478                                        //      arg = castExpr->get_arg();
479                                        // }
480                                        if ( AddressExpr * addrExpr = dynamic_cast< AddressExpr * >( arg ) ) {
481                                                Expression * ret = addrExpr->arg;
482                                                ret->env = appExpr->env;
483                                                addrExpr->arg = nullptr;
484                                                appExpr->env = nullptr;
485                                                delete appExpr;
486                                                return ret;
487                                        }
488                                }
489                        }
490                        return appExpr;
491                }
492        } // namespace
493} // namespace GenPoly
494
495// Local Variables: //
496// tab-width: 4 //
497// mode: c++ //
498// compile-command: "make install" //
499// End: //
Note: See TracBrowser for help on using the repository browser.