source: src/SymTab/Autogen.cc@ cb43451

ADT aaron-thesis arm-eh ast-experimental cleanup-dtors deferred_resn demangler enum forall-pointer-decay jacob/cs343-translation jenkins-sandbox new-ast new-ast-unique-expr new-env no_list persistent-indexer pthread-emulation qualifiedEnum resolv-new with_gc
Last change on this file since cb43451 was 49148d5, checked in by Rob Schluntz <rschlunt@…>, 8 years ago

Update autogen to generate ctor/dtor/assign with references
  • Property mode set to 100644
File size: 36.1 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// Autogen.cc --
8//
9// Author : Rob Schluntz
10// Created On : Thu Mar 03 15:45:56 2016
11// Last Modified By : Andrew Beach
12// Last Modified On : Wed Jun 28 15:30:00 2017
13// Update Count : 61
14//
15
16#include <list>
17#include <iterator>
18#include "SynTree/Visitor.h"
19#include "SynTree/Type.h"
20#include "SynTree/Statement.h"
21#include "SynTree/TypeSubstitution.h"
22#include "Common/utility.h"
23#include "AddVisit.h"
24#include "MakeLibCfa.h"
25#include "Autogen.h"
26#include "GenPoly/ScopedSet.h"
27#include "Common/ScopedMap.h"
28#include "SymTab/Mangler.h"
29#include "GenPoly/DeclMutator.h"
30
31namespace SymTab {
32 Type * SizeType = 0;
33 typedef ScopedMap< std::string, bool > TypeMap;
34
35 /// Data used to generate functions generically. Specifically, the name of the generated function, a function which generates the routine protoype, and a map which contains data to determine whether a function should be generated.
36 struct FuncData {
37 typedef FunctionType * (*TypeGen)( Type * );
38 FuncData( const std::string & fname, const TypeGen & genType, TypeMap & map ) : fname( fname ), genType( genType ), map( map ) {}
39 std::string fname;
40 TypeGen genType;
41 TypeMap & map;
42 };
43
44 class AutogenerateRoutines final : public Visitor {
45 template< typename Visitor >
46 friend void acceptAndAdd( std::list< Declaration * > &translationUnit, Visitor &visitor );
47 template< typename Visitor >
48 friend void addVisitStatementList( std::list< Statement* > &stmts, Visitor &visitor );
49 public:
50 std::list< Declaration * > &get_declsToAdd() { return declsToAdd; }
51
52 typedef Visitor Parent;
53 using Parent::visit;
54
55 AutogenerateRoutines();
56
57 virtual void visit( EnumDecl *enumDecl );
58 virtual void visit( StructDecl *structDecl );
59 virtual void visit( UnionDecl *structDecl );
60 virtual void visit( TypeDecl *typeDecl );
61 virtual void visit( TraitDecl *ctxDecl );
62 virtual void visit( FunctionDecl *functionDecl );
63
64 virtual void visit( FunctionType *ftype );
65 virtual void visit( PointerType *ftype );
66
67 virtual void visit( CompoundStmt *compoundStmt );
68 virtual void visit( SwitchStmt *switchStmt );
69
70 private:
71 template< typename StmtClass > void visitStatement( StmtClass *stmt );
72
73 std::list< Declaration * > declsToAdd, declsToAddAfter;
74 std::set< std::string > structsDone;
75 unsigned int functionNesting = 0; // current level of nested functions
76 /// Note: the following maps could be ScopedSets, but it should be easier to work
77 /// deleted functions in if they are maps, since the value false can be inserted
78 /// at the current scope without affecting outer scopes or requiring copies.
79 TypeMap copyable, assignable, constructable, destructable;
80 std::vector< FuncData > data;
81 };
82
83 /// generates routines for tuple types.
84 /// Doesn't really need to be a mutator, but it's easier to reuse DeclMutator than it is to use AddVisit
85 /// or anything we currently have that supports adding new declarations for visitors
86 class AutogenTupleRoutines : public GenPoly::DeclMutator {
87 public:
88 typedef GenPoly::DeclMutator Parent;
89 using Parent::mutate;
90
91 virtual DeclarationWithType * mutate( FunctionDecl *functionDecl );
92
93 virtual Type * mutate( TupleType *tupleType );
94
95 virtual CompoundStmt * mutate( CompoundStmt *compoundStmt );
96
97 private:
98 unsigned int functionNesting = 0; // current level of nested functions
99 GenPoly::ScopedSet< std::string > seenTuples;
100 };
101
102 void autogenerateRoutines( std::list< Declaration * > &translationUnit ) {
103 AutogenerateRoutines generator;
104 acceptAndAdd( translationUnit, generator );
105
106 // needs to be done separately because AutogenerateRoutines skips types that appear as function arguments, etc.
107 // AutogenTupleRoutines tupleGenerator;
108 // tupleGenerator.mutateDeclarationList( translationUnit );
109 }
110
111 bool isUnnamedBitfield( ObjectDecl * obj ) {
112 return obj != NULL && obj->get_name() == "" && obj->get_bitfieldWidth() != NULL;
113 }
114
115 /// inserts a forward declaration for functionDecl into declsToAdd
116 void addForwardDecl( FunctionDecl * functionDecl, std::list< Declaration * > & declsToAdd ) {
117 FunctionDecl * decl = functionDecl->clone();
118 delete decl->get_statements();
119 decl->set_statements( NULL );
120 declsToAdd.push_back( decl );
121 decl->fixUniqueId();
122 }
123
124 /// given type T, generate type of default ctor/dtor, i.e. function type void (*) (T *)
125 FunctionType * genDefaultType( Type * paramType ) {
126 FunctionType *ftype = new FunctionType( Type::Qualifiers(), false );
127 ObjectDecl *dstParam = new ObjectDecl( "_dst", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, new ReferenceType( Type::Qualifiers(), paramType->clone() ), nullptr );
128 ftype->get_parameters().push_back( dstParam );
129
130 return ftype;
131 }
132
133 /// given type T, generate type of copy ctor, i.e. function type void (*) (T *, T)
134 FunctionType * genCopyType( Type * paramType ) {
135 FunctionType *ftype = genDefaultType( paramType );
136 ObjectDecl *srcParam = new ObjectDecl( "_src", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, paramType->clone(), nullptr );
137 ftype->get_parameters().push_back( srcParam );
138 return ftype;
139 }
140
141 /// given type T, generate type of assignment, i.e. function type T (*) (T *, T)
142 FunctionType * genAssignType( Type * paramType ) {
143 FunctionType *ftype = genCopyType( paramType );
144 ObjectDecl *returnVal = new ObjectDecl( "_ret", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, paramType->clone(), nullptr );
145 ftype->get_returnVals().push_back( returnVal );
146 return ftype;
147 }
148
149 /// true if the aggregate's layout is dynamic
150 template< typename AggrDecl >
151 bool hasDynamicLayout( AggrDecl * aggregateDecl ) {
152 for ( TypeDecl * param : aggregateDecl->get_parameters() ) {
153 if ( param->isComplete() ) return true;
154 }
155 return false;
156 }
157
158 /// generate a function decl from a name and type. Nesting depth determines whether
159 /// the declaration is static or not; optional paramter determines if declaration is intrinsic
160 FunctionDecl * genFunc( const std::string & fname, FunctionType * ftype, unsigned int functionNesting, bool isIntrinsic = false ) {
161 // Routines at global scope marked "static" to prevent multiple definitions in separate translation units
162 // because each unit generates copies of the default routines for each aggregate.
163// DeclarationNode::StorageClass sc = functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static;
164 Type::StorageClasses scs = functionNesting > 0 ? Type::StorageClasses() : Type::StorageClasses( Type::Static );
165 LinkageSpec::Spec spec = isIntrinsic ? LinkageSpec::Intrinsic : LinkageSpec::AutoGen;
166 FunctionDecl * decl = new FunctionDecl( fname, scs, spec, ftype, new CompoundStmt( noLabels ),
167 std::list< Attribute * >(), Type::FuncSpecifiers( Type::Inline ) );
168 decl->fixUniqueId();
169 return decl;
170 }
171
172 /// inserts base type of first argument into map if pred(funcDecl) is true
173 void insert( FunctionDecl *funcDecl, TypeMap & map, FunctionDecl * (*pred)(Declaration *) ) {
174 // insert type into constructable, etc. map if appropriate
175 if ( pred( funcDecl ) ) {
176 FunctionType * ftype = funcDecl->get_functionType();
177 assert( ! ftype->get_parameters().empty() );
178 Type * t = InitTweak::getPointerBase( ftype->get_parameters().front()->get_type() );
179 assert( t );
180 map.insert( Mangler::mangleType( t ), true );
181 }
182 }
183
184 /// using map and t, determines if is constructable, etc.
185 bool lookup( const TypeMap & map, Type * t ) {
186 if ( dynamic_cast< PointerType * >( t ) ) {
187 // will need more complicated checking if we want this to work with pointer types, since currently
188 return true;
189 } else if ( ArrayType * at = dynamic_cast< ArrayType * >( t ) ) {
190 // an array's constructor, etc. is generated on the fly based on the base type's constructor, etc.
191 return lookup( map, at->get_base() );
192 }
193 TypeMap::const_iterator it = map.find( Mangler::mangleType( t ) );
194 if ( it != map.end() ) return it->second;
195 // something that does not appear in the map is by default not constructable, etc.
196 return false;
197 }
198
199 /// using map and aggr, examines each member to determine if constructor, etc. should be generated
200 template<typename AggrDecl>
201 bool shouldGenerate( const TypeMap & map, AggrDecl * aggr ) {
202 for ( Declaration * dcl : aggr->get_members() ) {
203 if ( DeclarationWithType * dwt = dynamic_cast< DeclarationWithType * >( dcl ) ) {
204 if ( ! lookup( map, dwt->get_type() ) ) return false;
205 }
206 }
207 return true;
208 }
209
210 /// data structure for abstracting the generation of special functions
211 template< typename OutputIterator >
212 struct FuncGenerator {
213 StructDecl *aggregateDecl;
214 StructInstType *refType;
215 unsigned int functionNesting;
216 const std::list< TypeDecl* > & typeParams;
217 OutputIterator out;
218 FuncGenerator( StructDecl *aggregateDecl, StructInstType *refType, unsigned int functionNesting, const std::list< TypeDecl* > & typeParams, OutputIterator out ) : aggregateDecl( aggregateDecl ), refType( refType ), functionNesting( functionNesting ), typeParams( typeParams ), out( out ) {}
219
220 /// generates a function (?{}, ?=?, ^?{}) based on the data argument and members. If function is generated, inserts the type into the map.
221 void gen( const FuncData & data, bool concurrent_type ) {
222 if ( ! shouldGenerate( data.map, aggregateDecl ) ) return;
223 FunctionType * ftype = data.genType( refType );
224
225 if(concurrent_type && InitTweak::isDestructor( data.fname )) {
226 ftype->get_parameters().front()->get_type()->set_mutex( true );
227 }
228
229 cloneAll( typeParams, ftype->get_forall() );
230 *out++ = genFunc( data.fname, ftype, functionNesting );
231 data.map.insert( Mangler::mangleType( refType ), true );
232 }
233 };
234
235 template< typename OutputIterator >
236 FuncGenerator<OutputIterator> makeFuncGenerator( StructDecl *aggregateDecl, StructInstType *refType, unsigned int functionNesting, const std::list< TypeDecl* > & typeParams, OutputIterator out ) {
237 return FuncGenerator<OutputIterator>( aggregateDecl, refType, functionNesting, typeParams, out );
238 }
239
240 /// generates a single enumeration assignment expression
241 ApplicationExpr * genEnumAssign( FunctionType * ftype, FunctionDecl * assignDecl ) {
242 // enum copy construct and assignment is just C-style assignment.
243 // this looks like a bad recursive call, but code gen will turn it into
244 // a C-style assignment.
245 // This happens before function pointer type conversion, so need to do it manually here
246 // NOTE: ftype is not necessarily the functionType belonging to assignDecl - ftype is the
247 // type of the function that this expression is being generated for (so that the correct
248 // parameters) are using in the variable exprs
249 assert( ftype->get_parameters().size() == 2 );
250 ObjectDecl * dstParam = safe_dynamic_cast< ObjectDecl * >( ftype->get_parameters().front() );
251 ObjectDecl * srcParam = safe_dynamic_cast< ObjectDecl * >( ftype->get_parameters().back() );
252
253 VariableExpr * assignVarExpr = new VariableExpr( assignDecl );
254 Type * assignVarExprType = assignVarExpr->get_result();
255 assignVarExprType = new PointerType( Type::Qualifiers(), assignVarExprType );
256 assignVarExpr->set_result( assignVarExprType );
257 ApplicationExpr * assignExpr = new ApplicationExpr( assignVarExpr );
258 assignExpr->get_args().push_back( new VariableExpr( dstParam ) );
259 assignExpr->get_args().push_back( new VariableExpr( srcParam ) );
260 return assignExpr;
261 }
262
263 // E ?=?(E volatile*, int),
264 // ?=?(E _Atomic volatile*, int);
265 void makeEnumFunctions( EnumInstType *refType, unsigned int functionNesting, std::list< Declaration * > &declsToAdd ) {
266
267 // T ?=?(E *, E);
268 FunctionType *assignType = genAssignType( refType );
269
270 // void ?{}(E *); void ^?{}(E *);
271 FunctionType * ctorType = genDefaultType( refType->clone() );
272 FunctionType * dtorType = genDefaultType( refType->clone() );
273
274 // void ?{}(E *, E);
275 FunctionType *copyCtorType = genCopyType( refType->clone() );
276
277 // xxx - should we also generate void ?{}(E *, int) and E ?{}(E *, E)?
278 // right now these cases work, but that might change.
279
280 // xxx - Temporary: make these functions intrinsic so they codegen as C assignment.
281 // Really they're something of a cross between instrinsic and autogen, so should
282 // probably make a new linkage type
283 FunctionDecl *assignDecl = genFunc( "?=?", assignType, functionNesting, true );
284 FunctionDecl *ctorDecl = genFunc( "?{}", ctorType, functionNesting, true );
285 FunctionDecl *copyCtorDecl = genFunc( "?{}", copyCtorType, functionNesting, true );
286 FunctionDecl *dtorDecl = genFunc( "^?{}", dtorType, functionNesting, true );
287
288 // body is either return stmt or expr stmt
289 assignDecl->get_statements()->get_kids().push_back( new ReturnStmt( noLabels, genEnumAssign( assignType, assignDecl ) ) );
290 copyCtorDecl->get_statements()->get_kids().push_back( new ExprStmt( noLabels, genEnumAssign( copyCtorType, assignDecl ) ) );
291
292 declsToAdd.push_back( ctorDecl );
293 declsToAdd.push_back( copyCtorDecl );
294 declsToAdd.push_back( dtorDecl );
295 declsToAdd.push_back( assignDecl ); // assignment should come last since it uses copy constructor in return
296 }
297
298 /// generates a single struct member operation (constructor call, destructor call, assignment call)
299 void makeStructMemberOp( ObjectDecl * dstParam, Expression * src, DeclarationWithType * field, FunctionDecl * func, bool isDynamicLayout, bool forward = true ) {
300 InitTweak::InitExpander srcParam( src );
301
302 // assign to destination
303 Expression *dstselect = new MemberExpr( field, new CastExpr( new VariableExpr( dstParam ), safe_dynamic_cast< ReferenceType* >( dstParam->get_type() )->get_base()->clone() ) );
304 genImplicitCall( srcParam, dstselect, func->get_name(), back_inserter( func->get_statements()->get_kids() ), field, forward );
305 }
306
307 /// generates the body of a struct function by iterating the struct members (via parameters) - generates default ctor, copy ctor, assignment, and dtor bodies, but NOT field ctor bodies
308 template<typename Iterator>
309 void makeStructFunctionBody( Iterator member, Iterator end, FunctionDecl * func, bool isDynamicLayout, bool forward = true ) {
310 for ( ; member != end; ++member ) {
311 if ( DeclarationWithType *field = dynamic_cast< DeclarationWithType * >( *member ) ) { // otherwise some form of type declaration, e.g. Aggregate
312 // query the type qualifiers of this field and skip assigning it if it is marked const.
313 // If it is an array type, we need to strip off the array layers to find its qualifiers.
314 Type * type = field->get_type();
315 while ( ArrayType * at = dynamic_cast< ArrayType * >( type ) ) {
316 type = at->get_base();
317 }
318
319 if ( type->get_const() && func->get_name() == "?=?" ) {
320 // don't assign const members, but do construct/destruct
321 continue;
322 }
323
324 if ( field->get_name() == "" ) {
325 // don't assign to anonymous members
326 // xxx - this is a temporary fix. Anonymous members tie into
327 // our inheritance model. I think the correct way to handle this is to
328 // cast the structure to the type of the member and let the resolver
329 // figure out whether it's valid and have a pass afterwards that fixes
330 // the assignment to use pointer arithmetic with the offset of the
331 // member, much like how generic type members are handled.
332 continue;
333 }
334
335 assert( ! func->get_functionType()->get_parameters().empty() );
336 ObjectDecl * dstParam = dynamic_cast<ObjectDecl*>( func->get_functionType()->get_parameters().front() );
337 ObjectDecl * srcParam = NULL;
338 if ( func->get_functionType()->get_parameters().size() == 2 ) {
339 srcParam = dynamic_cast<ObjectDecl*>( func->get_functionType()->get_parameters().back() );
340 }
341 // srcParam may be NULL, in which case we have default ctor/dtor
342 assert( dstParam );
343
344 Expression *srcselect = srcParam ? new MemberExpr( field, new VariableExpr( srcParam ) ) : NULL;
345 makeStructMemberOp( dstParam, srcselect, field, func, isDynamicLayout, forward );
346 } // if
347 } // for
348 } // makeStructFunctionBody
349
350 /// generate the body of a constructor which takes parameters that match fields, e.g.
351 /// void ?{}(A *, int) and void?{}(A *, int, int) for a struct A which has two int fields.
352 template<typename Iterator>
353 void makeStructFieldCtorBody( Iterator member, Iterator end, FunctionDecl * func, bool isDynamicLayout ) {
354 FunctionType * ftype = func->get_functionType();
355 std::list<DeclarationWithType*> & params = ftype->get_parameters();
356 assert( params.size() >= 2 ); // should not call this function for default ctor, etc.
357
358 // skip 'this' parameter
359 ObjectDecl * dstParam = dynamic_cast<ObjectDecl*>( params.front() );
360 assert( dstParam );
361 std::list<DeclarationWithType*>::iterator parameter = params.begin()+1;
362 for ( ; member != end; ++member ) {
363 if ( DeclarationWithType * field = dynamic_cast<DeclarationWithType*>( *member ) ) {
364 if ( isUnnamedBitfield( dynamic_cast< ObjectDecl * > ( field ) ) ) {
365 // don't make a function whose parameter is an unnamed bitfield
366 continue;
367 } else if ( field->get_name() == "" ) {
368 // don't assign to anonymous members
369 // xxx - this is a temporary fix. Anonymous members tie into
370 // our inheritance model. I think the correct way to handle this is to
371 // cast the structure to the type of the member and let the resolver
372 // figure out whether it's valid and have a pass afterwards that fixes
373 // the assignment to use pointer arithmetic with the offset of the
374 // member, much like how generic type members are handled.
375 continue;
376 } else if ( parameter != params.end() ) {
377 // matching parameter, initialize field with copy ctor
378 Expression *srcselect = new VariableExpr(*parameter);
379 makeStructMemberOp( dstParam, srcselect, field, func, isDynamicLayout );
380 ++parameter;
381 } else {
382 // no matching parameter, initialize field with default ctor
383 makeStructMemberOp( dstParam, NULL, field, func, isDynamicLayout );
384 }
385 }
386 }
387 }
388
389 /// generates struct constructors, destructor, and assignment functions
390 void makeStructFunctions( StructDecl *aggregateDecl, StructInstType *refType, unsigned int functionNesting, std::list< Declaration * > & declsToAdd, const std::vector< FuncData > & data ) {
391 // Builtins do not use autogeneration.
392 if ( aggregateDecl->get_linkage() == LinkageSpec::Builtin ||
393 aggregateDecl->get_linkage() == LinkageSpec::BuiltinC ) {
394 return;
395 }
396
397 // Make function polymorphic in same parameters as generic struct, if applicable
398 const std::list< TypeDecl* > & typeParams = aggregateDecl->get_parameters(); // List of type variables to be placed on the generated functions
399 bool isDynamicLayout = hasDynamicLayout( aggregateDecl ); // NOTE this flag is an incredibly ugly kludge; we should fix the assignment signature instead (ditto for union)
400
401 // generate each of the functions based on the supplied FuncData objects
402 std::list< FunctionDecl * > newFuncs;
403 auto generator = makeFuncGenerator( aggregateDecl, refType, functionNesting, typeParams, back_inserter( newFuncs ) );
404 for ( const FuncData & d : data ) {
405 generator.gen( d, aggregateDecl->is_thread() || aggregateDecl->is_monitor() );
406 }
407
408 // field ctors are only generated if default constructor and copy constructor are both generated
409 unsigned numCtors = std::count_if( newFuncs.begin(), newFuncs.end(), [](FunctionDecl * dcl) { return InitTweak::isConstructor( dcl->get_name() ); } );
410
411 if ( functionNesting == 0 ) {
412 // forward declare if top-level struct, so that
413 // type is complete as soon as its body ends
414 // Note: this is necessary if we want structs which contain
415 // generic (otype) structs as members.
416 for ( FunctionDecl * dcl : newFuncs ) {
417 addForwardDecl( dcl, declsToAdd );
418 }
419 }
420
421 for ( FunctionDecl * dcl : newFuncs ) {
422 // generate appropriate calls to member ctor, assignment
423 // destructor needs to do everything in reverse, so pass "forward" based on whether the function is a destructor
424 if ( ! InitTweak::isDestructor( dcl->get_name() ) ) {
425 makeStructFunctionBody( aggregateDecl->get_members().begin(), aggregateDecl->get_members().end(), dcl, isDynamicLayout );
426 } else {
427 makeStructFunctionBody( aggregateDecl->get_members().rbegin(), aggregateDecl->get_members().rend(), dcl, isDynamicLayout, false );
428 }
429 if ( InitTweak::isAssignment( dcl->get_name() ) ) {
430 // assignment needs to return a value
431 FunctionType * assignType = dcl->get_functionType();
432 assert( assignType->get_parameters().size() == 2 );
433 ObjectDecl * srcParam = safe_dynamic_cast< ObjectDecl * >( assignType->get_parameters().back() );
434 dcl->get_statements()->get_kids().push_back( new ReturnStmt( noLabels, new VariableExpr( srcParam ) ) );
435 }
436 declsToAdd.push_back( dcl );
437 }
438
439 // create constructors which take each member type as a parameter.
440 // for example, for struct A { int x, y; }; generate
441 // void ?{}(A *, int) and void ?{}(A *, int, int)
442 // Field constructors are only generated if default and copy constructor
443 // are generated, since they need access to both
444 if ( numCtors == 2 ) {
445 FunctionType * memCtorType = genDefaultType( refType );
446 cloneAll( typeParams, memCtorType->get_forall() );
447 for ( std::list<Declaration *>::iterator i = aggregateDecl->get_members().begin(); i != aggregateDecl->get_members().end(); ++i ) {
448 DeclarationWithType * member = dynamic_cast<DeclarationWithType *>( *i );
449 assert( member );
450 if ( isUnnamedBitfield( dynamic_cast< ObjectDecl * > ( member ) ) ) {
451 // don't make a function whose parameter is an unnamed bitfield
452 continue;
453 } else if ( member->get_name() == "" ) {
454 // don't assign to anonymous members
455 // xxx - this is a temporary fix. Anonymous members tie into
456 // our inheritance model. I think the correct way to handle this is to
457 // cast the structure to the type of the member and let the resolver
458 // figure out whether it's valid/choose the correct unnamed member
459 continue;
460 }
461 memCtorType->get_parameters().push_back( new ObjectDecl( member->get_name(), Type::StorageClasses(), LinkageSpec::Cforall, 0, member->get_type()->clone(), 0 ) );
462 FunctionDecl * ctor = genFunc( "?{}", memCtorType->clone(), functionNesting );
463 makeStructFieldCtorBody( aggregateDecl->get_members().begin(), aggregateDecl->get_members().end(), ctor, isDynamicLayout );
464 declsToAdd.push_back( ctor );
465 }
466 delete memCtorType;
467 }
468 }
469
470 /// generate a single union assignment expression (using memcpy)
471 template< typename OutputIterator >
472 void makeUnionFieldsAssignment( ObjectDecl * srcParam, ObjectDecl * dstParam, OutputIterator out ) {
473 UntypedExpr *copy = new UntypedExpr( new NameExpr( "__builtin_memcpy" ) );
474 copy->get_args().push_back( new AddressExpr( new VariableExpr( dstParam ) ) );
475 copy->get_args().push_back( new AddressExpr( new VariableExpr( srcParam ) ) );
476 copy->get_args().push_back( new SizeofExpr( srcParam->get_type()->clone() ) );
477 *out++ = new ExprStmt( noLabels, copy );
478 }
479
480 /// generates the body of a union assignment/copy constructor/field constructor
481 void makeUnionAssignBody( FunctionDecl * funcDecl ) {
482 FunctionType * ftype = funcDecl->get_functionType();
483 assert( ftype->get_parameters().size() == 2 );
484 ObjectDecl * dstParam = safe_dynamic_cast< ObjectDecl * >( ftype->get_parameters().front() );
485 ObjectDecl * srcParam = safe_dynamic_cast< ObjectDecl * >( ftype->get_parameters().back() );
486
487 makeUnionFieldsAssignment( srcParam, dstParam, back_inserter( funcDecl->get_statements()->get_kids() ) );
488 if ( InitTweak::isAssignment( funcDecl->get_name() ) ) {
489 // also generate return statement in assignment
490 funcDecl->get_statements()->get_kids().push_back( new ReturnStmt( noLabels, new VariableExpr( srcParam ) ) );
491 }
492 }
493
494 /// generates union constructors, destructors, and assignment operator
495 void makeUnionFunctions( UnionDecl *aggregateDecl, UnionInstType *refType, unsigned int functionNesting, std::list< Declaration * > & declsToAdd ) {
496 // Make function polymorphic in same parameters as generic union, if applicable
497 const std::list< TypeDecl* > & typeParams = aggregateDecl->get_parameters(); // List of type variables to be placed on the generated functions
498
499 // default ctor/dtor need only first parameter
500 // void ?{}(T *); void ^?{}(T *);
501 FunctionType *ctorType = genDefaultType( refType );
502 FunctionType *dtorType = genDefaultType( refType );
503
504 // copy ctor needs both parameters
505 // void ?{}(T *, T);
506 FunctionType *copyCtorType = genCopyType( refType );
507
508 // assignment needs both and return value
509 // T ?=?(T *, T);
510 FunctionType *assignType = genAssignType( refType );
511
512 cloneAll( typeParams, ctorType->get_forall() );
513 cloneAll( typeParams, dtorType->get_forall() );
514 cloneAll( typeParams, copyCtorType->get_forall() );
515 cloneAll( typeParams, assignType->get_forall() );
516
517 // Routines at global scope marked "static" to prevent multiple definitions is separate translation units
518 // because each unit generates copies of the default routines for each aggregate.
519 FunctionDecl *assignDecl = genFunc( "?=?", assignType, functionNesting );
520 FunctionDecl *ctorDecl = genFunc( "?{}", ctorType, functionNesting );
521 FunctionDecl *copyCtorDecl = genFunc( "?{}", copyCtorType, functionNesting );
522 FunctionDecl *dtorDecl = genFunc( "^?{}", dtorType, functionNesting );
523
524 makeUnionAssignBody( assignDecl );
525
526 // body of assignment and copy ctor is the same
527 makeUnionAssignBody( copyCtorDecl );
528
529 // create a constructor which takes the first member type as a parameter.
530 // for example, for Union A { int x; double y; }; generate
531 // void ?{}(A *, int)
532 // This is to mimic C's behaviour which initializes the first member of the union.
533 std::list<Declaration *> memCtors;
534 for ( Declaration * member : aggregateDecl->get_members() ) {
535 if ( DeclarationWithType * field = dynamic_cast< DeclarationWithType * >( member ) ) {
536 ObjectDecl * srcParam = new ObjectDecl( "src", Type::StorageClasses(), LinkageSpec::Cforall, 0, field->get_type()->clone(), 0 );
537
538 FunctionType * memCtorType = ctorType->clone();
539 memCtorType->get_parameters().push_back( srcParam );
540 FunctionDecl * ctor = genFunc( "?{}", memCtorType, functionNesting );
541
542 makeUnionAssignBody( ctor );
543 memCtors.push_back( ctor );
544 // only generate a ctor for the first field
545 break;
546 }
547 }
548
549 declsToAdd.push_back( ctorDecl );
550 declsToAdd.push_back( copyCtorDecl );
551 declsToAdd.push_back( dtorDecl );
552 declsToAdd.push_back( assignDecl ); // assignment should come last since it uses copy constructor in return
553 declsToAdd.splice( declsToAdd.end(), memCtors );
554 }
555
556 AutogenerateRoutines::AutogenerateRoutines() {
557 // the order here determines the order that these functions are generated.
558 // assignment should come last since it uses copy constructor in return.
559 data.push_back( FuncData( "?{}", genDefaultType, constructable ) );
560 data.push_back( FuncData( "?{}", genCopyType, copyable ) );
561 data.push_back( FuncData( "^?{}", genDefaultType, destructable ) );
562 data.push_back( FuncData( "?=?", genAssignType, assignable ) );
563 }
564
565 void AutogenerateRoutines::visit( EnumDecl *enumDecl ) {
566 if ( ! enumDecl->get_members().empty() ) {
567 EnumInstType *enumInst = new EnumInstType( Type::Qualifiers(), enumDecl->get_name() );
568 // enumInst->set_baseEnum( enumDecl );
569 makeEnumFunctions( enumInst, functionNesting, declsToAddAfter );
570 }
571 }
572
573 void AutogenerateRoutines::visit( StructDecl *structDecl ) {
574 if ( structDecl->has_body() && structsDone.find( structDecl->get_name() ) == structsDone.end() ) {
575 StructInstType structInst( Type::Qualifiers(), structDecl->get_name() );
576 for ( TypeDecl * typeDecl : structDecl->get_parameters() ) {
577 // need to visit assertions so that they are added to the appropriate maps
578 acceptAll( typeDecl->get_assertions(), *this );
579 structInst.get_parameters().push_back( new TypeExpr( new TypeInstType( Type::Qualifiers(), typeDecl->get_name(), typeDecl ) ) );
580 }
581 structInst.set_baseStruct( structDecl );
582 makeStructFunctions( structDecl, &structInst, functionNesting, declsToAddAfter, data );
583 structsDone.insert( structDecl->get_name() );
584 } // if
585 }
586
587 void AutogenerateRoutines::visit( UnionDecl *unionDecl ) {
588 if ( ! unionDecl->get_members().empty() ) {
589 UnionInstType unionInst( Type::Qualifiers(), unionDecl->get_name() );
590 unionInst.set_baseUnion( unionDecl );
591 for ( TypeDecl * typeDecl : unionDecl->get_parameters() ) {
592 unionInst.get_parameters().push_back( new TypeExpr( new TypeInstType( Type::Qualifiers(), typeDecl->get_name(), typeDecl ) ) );
593 }
594 makeUnionFunctions( unionDecl, &unionInst, functionNesting, declsToAddAfter );
595 } // if
596 }
597
598 void AutogenerateRoutines::visit( TypeDecl *typeDecl ) {
599 TypeInstType *typeInst = new TypeInstType( Type::Qualifiers(), typeDecl->get_name(), false );
600 typeInst->set_baseType( typeDecl );
601 ObjectDecl *src = new ObjectDecl( "_src", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, typeInst->clone(), nullptr );
602 ObjectDecl *dst = new ObjectDecl( "_dst", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, new PointerType( Type::Qualifiers(), typeInst->clone() ), nullptr );
603
604 std::list< Statement * > stmts;
605 if ( typeDecl->get_base() ) {
606 // xxx - generate ctor/dtors for typedecls, e.g.
607 // otype T = int *;
608 UntypedExpr *assign = new UntypedExpr( new NameExpr( "?=?" ) );
609 assign->get_args().push_back( new CastExpr( new VariableExpr( dst ), new PointerType( Type::Qualifiers(), typeDecl->get_base()->clone() ) ) );
610 assign->get_args().push_back( new CastExpr( new VariableExpr( src ), typeDecl->get_base()->clone() ) );
611 stmts.push_back( new ReturnStmt( std::list< Label >(), assign ) );
612 } // if
613 FunctionType *type = new FunctionType( Type::Qualifiers(), false );
614 type->get_returnVals().push_back( new ObjectDecl( "", Type::StorageClasses(), LinkageSpec::Cforall, 0, typeInst, 0 ) );
615 type->get_parameters().push_back( dst );
616 type->get_parameters().push_back( src );
617 FunctionDecl *func = genFunc( "?=?", type, functionNesting );
618 func->get_statements()->get_kids() = stmts;
619 declsToAddAfter.push_back( func );
620 }
621
622 void addDecls( std::list< Declaration * > &declsToAdd, std::list< Statement * > &statements, std::list< Statement * >::iterator i ) {
623 for ( std::list< Declaration * >::iterator decl = declsToAdd.begin(); decl != declsToAdd.end(); ++decl ) {
624 statements.insert( i, new DeclStmt( noLabels, *decl ) );
625 } // for
626 declsToAdd.clear();
627 }
628
629 void AutogenerateRoutines::visit( FunctionType *) {
630 // ensure that we don't add assignment ops for types defined as part of the function
631 }
632
633 void AutogenerateRoutines::visit( PointerType *) {
634 // ensure that we don't add assignment ops for types defined as part of the pointer
635 }
636
637 void AutogenerateRoutines::visit( TraitDecl *) {
638 // ensure that we don't add assignment ops for types defined as part of the trait
639 }
640
641 template< typename StmtClass >
642 inline void AutogenerateRoutines::visitStatement( StmtClass *stmt ) {
643 std::set< std::string > oldStructs = structsDone;
644 addVisit( stmt, *this );
645 structsDone = oldStructs;
646 }
647
648 void AutogenerateRoutines::visit( FunctionDecl *functionDecl ) {
649 // record the existence of this function as appropriate
650 insert( functionDecl, constructable, InitTweak::isDefaultConstructor );
651 insert( functionDecl, assignable, InitTweak::isAssignment );
652 insert( functionDecl, copyable, InitTweak::isCopyConstructor );
653 insert( functionDecl, destructable, InitTweak::isDestructor );
654
655 maybeAccept( functionDecl->get_functionType(), *this );
656 functionNesting += 1;
657 maybeAccept( functionDecl->get_statements(), *this );
658 functionNesting -= 1;
659 }
660
661 void AutogenerateRoutines::visit( CompoundStmt *compoundStmt ) {
662 constructable.beginScope();
663 assignable.beginScope();
664 copyable.beginScope();
665 destructable.beginScope();
666 visitStatement( compoundStmt );
667 constructable.endScope();
668 assignable.endScope();
669 copyable.endScope();
670 destructable.endScope();
671 }
672
673 void AutogenerateRoutines::visit( SwitchStmt *switchStmt ) {
674 visitStatement( switchStmt );
675 }
676
677 void makeTupleFunctionBody( FunctionDecl * function ) {
678 FunctionType * ftype = function->get_functionType();
679 assertf( ftype->get_parameters().size() == 1 || ftype->get_parameters().size() == 2, "too many parameters in generated tuple function" );
680
681 UntypedExpr * untyped = new UntypedExpr( new NameExpr( function->get_name() ) );
682
683 /// xxx - &* is used to make this easier for later passes to handle
684 untyped->get_args().push_back( new AddressExpr( UntypedExpr::createDeref( new VariableExpr( ftype->get_parameters().front() ) ) ) );
685 if ( ftype->get_parameters().size() == 2 ) {
686 untyped->get_args().push_back( new VariableExpr( ftype->get_parameters().back() ) );
687 }
688 function->get_statements()->get_kids().push_back( new ExprStmt( noLabels, untyped ) );
689 function->get_statements()->get_kids().push_back( new ReturnStmt( noLabels, UntypedExpr::createDeref( new VariableExpr( ftype->get_parameters().front() ) ) ) );
690 }
691
692 Type * AutogenTupleRoutines::mutate( TupleType * tupleType ) {
693 tupleType = safe_dynamic_cast< TupleType * >( Parent::mutate( tupleType ) );
694 std::string mangleName = SymTab::Mangler::mangleType( tupleType );
695 if ( seenTuples.find( mangleName ) != seenTuples.end() ) return tupleType;
696 seenTuples.insert( mangleName );
697
698 // T ?=?(T *, T);
699 FunctionType *assignType = genAssignType( tupleType );
700
701 // void ?{}(T *); void ^?{}(T *);
702 FunctionType *ctorType = genDefaultType( tupleType );
703 FunctionType *dtorType = genDefaultType( tupleType );
704
705 // void ?{}(T *, T);
706 FunctionType *copyCtorType = genCopyType( tupleType );
707
708 std::set< TypeDecl* > done;
709 std::list< TypeDecl * > typeParams;
710 for ( Type * t : *tupleType ) {
711 if ( TypeInstType * ty = dynamic_cast< TypeInstType * >( t ) ) {
712 if ( ! done.count( ty->get_baseType() ) ) {
713 TypeDecl * newDecl = new TypeDecl( ty->get_baseType()->get_name(), Type::StorageClasses(), nullptr, TypeDecl::Any );
714 TypeInstType * inst = new TypeInstType( Type::Qualifiers(), newDecl->get_name(), newDecl );
715 newDecl->get_assertions().push_back( new FunctionDecl( "?=?", Type::StorageClasses(), LinkageSpec::Cforall, genAssignType( inst ), nullptr,
716 std::list< Attribute * >(), Type::FuncSpecifiers( Type::Inline ) ) );
717 newDecl->get_assertions().push_back( new FunctionDecl( "?{}", Type::StorageClasses(), LinkageSpec::Cforall, genDefaultType( inst ), nullptr,
718 std::list< Attribute * >(), Type::FuncSpecifiers( Type::Inline ) ) );
719 newDecl->get_assertions().push_back( new FunctionDecl( "?{}", Type::StorageClasses(), LinkageSpec::Cforall, genCopyType( inst ), nullptr,
720 std::list< Attribute * >(), Type::FuncSpecifiers( Type::Inline ) ) );
721 newDecl->get_assertions().push_back( new FunctionDecl( "^?{}", Type::StorageClasses(), LinkageSpec::Cforall, genDefaultType( inst ), nullptr,
722 std::list< Attribute * >(), Type::FuncSpecifiers( Type::Inline ) ) );
723 typeParams.push_back( newDecl );
724 done.insert( ty->get_baseType() );
725 }
726 }
727 }
728 cloneAll( typeParams, ctorType->get_forall() );
729 cloneAll( typeParams, dtorType->get_forall() );
730 cloneAll( typeParams, copyCtorType->get_forall() );
731 cloneAll( typeParams, assignType->get_forall() );
732
733 FunctionDecl *assignDecl = genFunc( "?=?", assignType, functionNesting );
734 FunctionDecl *ctorDecl = genFunc( "?{}", ctorType, functionNesting );
735 FunctionDecl *copyCtorDecl = genFunc( "?{}", copyCtorType, functionNesting );
736 FunctionDecl *dtorDecl = genFunc( "^?{}", dtorType, functionNesting );
737
738 makeTupleFunctionBody( assignDecl );
739 makeTupleFunctionBody( ctorDecl );
740 makeTupleFunctionBody( copyCtorDecl );
741 makeTupleFunctionBody( dtorDecl );
742
743 addDeclaration( ctorDecl );
744 addDeclaration( copyCtorDecl );
745 addDeclaration( dtorDecl );
746 addDeclaration( assignDecl ); // assignment should come last since it uses copy constructor in return
747
748 return tupleType;
749 }
750
751 DeclarationWithType * AutogenTupleRoutines::mutate( FunctionDecl *functionDecl ) {
752 functionDecl->set_functionType( maybeMutate( functionDecl->get_functionType(), *this ) );
753 functionNesting += 1;
754 functionDecl->set_statements( maybeMutate( functionDecl->get_statements(), *this ) );
755 functionNesting -= 1;
756 return functionDecl;
757 }
758
759 CompoundStmt * AutogenTupleRoutines::mutate( CompoundStmt *compoundStmt ) {
760 seenTuples.beginScope();
761 compoundStmt = safe_dynamic_cast< CompoundStmt * >( Parent::mutate( compoundStmt ) );
762 seenTuples.endScope();
763 return compoundStmt;
764 }
765} // SymTab
766
767// Local Variables: //
768// tab-width: 4 //
769// mode: c++ //
770// compile-command: "make install" //
771// End: //
Note: See TracBrowser for help on using the repository browser.