source: src/Concurrency/Keywords.cc@ d807ca28

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 with_gc
Last change on this file since d807ca28 was 9a705dc8, checked in by Rob Schluntz <rschlunt@…>, 7 years ago

Implement concurrency keyword casts
  • Property mode set to 100644
File size: 20.7 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2016 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// Keywords.cc --
8//
9// Author : Thierry Delisle
10// Created On : Mon Mar 13 12:41:22 2017
11// Last Modified By :
12// Last Modified On :
13// Update Count : 5
14//
15
16#include "Concurrency/Keywords.h"
17
18#include <cassert> // for assert
19#include <string> // for string, operator==
20
21#include "Common/PassVisitor.h" // for PassVisitor
22#include "Common/SemanticError.h" // for SemanticError
23#include "Common/utility.h" // for deleteAll, map_range
24#include "CodeGen/OperatorTable.h" // for isConstructor
25#include "InitTweak/InitTweak.h" // for getPointerBase
26#include "Parser/LinkageSpec.h" // for Cforall
27#include "SynTree/Constant.h" // for Constant
28#include "SynTree/Declaration.h" // for StructDecl, FunctionDecl, ObjectDecl
29#include "SynTree/Expression.h" // for VariableExpr, ConstantExpr, Untype...
30#include "SynTree/Initializer.h" // for SingleInit, ListInit, Initializer ...
31#include "SynTree/Label.h" // for Label
32#include "SynTree/Statement.h" // for CompoundStmt, DeclStmt, ExprStmt
33#include "SynTree/Type.h" // for StructInstType, Type, PointerType
34#include "SynTree/Visitor.h" // for Visitor, acceptAll
35
36class Attribute;
37
38namespace Concurrency {
39 //=============================================================================================
40 // Pass declarations
41 //=============================================================================================
42
43 //-----------------------------------------------------------------------------
44 //Handles sue type declarations :
45 // sue MyType { struct MyType {
46 // int data; int data;
47 // a_struct_t more_data; a_struct_t more_data;
48 // => NewField_t newField;
49 // }; };
50 // static inline NewField_t * getter_name( MyType * this ) { return &this->newField; }
51 //
52 class ConcurrentSueKeyword : public WithDeclsToAdd {
53 public:
54
55 ConcurrentSueKeyword( std::string&& type_name, std::string&& field_name, std::string&& getter_name, std::string&& context_error, bool needs_main, KeywordCastExpr::Target cast_target ) :
56 type_name( type_name ), field_name( field_name ), getter_name( getter_name ), context_error( context_error ), needs_main( needs_main ), cast_target( cast_target ) {}
57
58 virtual ~ConcurrentSueKeyword() {}
59
60 Declaration * postmutate( StructDecl * decl );
61
62 void handle( StructDecl * );
63 FunctionDecl * forwardDeclare( StructDecl * );
64 ObjectDecl * addField( StructDecl * );
65 void addRoutines( ObjectDecl *, FunctionDecl * );
66
67 virtual bool is_target( StructDecl * decl ) = 0;
68
69 Expression * postmutate( KeywordCastExpr * cast );
70
71 private:
72 const std::string type_name;
73 const std::string field_name;
74 const std::string getter_name;
75 const std::string context_error;
76 bool needs_main;
77 KeywordCastExpr::Target cast_target;
78
79 StructDecl* type_decl = nullptr;
80 };
81
82
83 //-----------------------------------------------------------------------------
84 //Handles thread type declarations :
85 // thread Mythread { struct MyThread {
86 // int data; int data;
87 // a_struct_t more_data; a_struct_t more_data;
88 // => thread_desc __thrd_d;
89 // }; };
90 // static inline thread_desc * get_thread( MyThread * this ) { return &this->__thrd_d; }
91 //
92 class ThreadKeyword final : public ConcurrentSueKeyword {
93 public:
94
95 ThreadKeyword() : ConcurrentSueKeyword(
96 "thread_desc",
97 "__thrd",
98 "get_thread",
99 "thread keyword requires threads to be in scope, add #include <thread>",
100 true,
101 KeywordCastExpr::Thread
102 )
103 {}
104
105 virtual ~ThreadKeyword() {}
106
107 virtual bool is_target( StructDecl * decl ) override final { return decl->is_thread(); }
108
109 static void implement( std::list< Declaration * > & translationUnit ) {
110 PassVisitor< ThreadKeyword > impl;
111 mutateAll( translationUnit, impl );
112 }
113 };
114
115 //-----------------------------------------------------------------------------
116 //Handles coroutine type declarations :
117 // coroutine MyCoroutine { struct MyCoroutine {
118 // int data; int data;
119 // a_struct_t more_data; a_struct_t more_data;
120 // => coroutine_desc __cor_d;
121 // }; };
122 // static inline coroutine_desc * get_coroutine( MyCoroutine * this ) { return &this->__cor_d; }
123 //
124 class CoroutineKeyword final : public ConcurrentSueKeyword {
125 public:
126
127 CoroutineKeyword() : ConcurrentSueKeyword(
128 "coroutine_desc",
129 "__cor",
130 "get_coroutine",
131 "coroutine keyword requires coroutines to be in scope, add #include <coroutine>",
132 true,
133 KeywordCastExpr::Coroutine
134 )
135 {}
136
137 virtual ~CoroutineKeyword() {}
138
139 virtual bool is_target( StructDecl * decl ) override final { return decl->is_coroutine(); }
140
141 static void implement( std::list< Declaration * > & translationUnit ) {
142 PassVisitor< CoroutineKeyword > impl;
143 mutateAll( translationUnit, impl );
144 }
145 };
146
147 //-----------------------------------------------------------------------------
148 //Handles monitor type declarations :
149 // monitor MyMonitor { struct MyMonitor {
150 // int data; int data;
151 // a_struct_t more_data; a_struct_t more_data;
152 // => monitor_desc __mon_d;
153 // }; };
154 // static inline monitor_desc * get_coroutine( MyMonitor * this ) { return &this->__cor_d; }
155 //
156 class MonitorKeyword final : public ConcurrentSueKeyword {
157 public:
158
159 MonitorKeyword() : ConcurrentSueKeyword(
160 "monitor_desc",
161 "__mon",
162 "get_monitor",
163 "monitor keyword requires monitors to be in scope, add #include <monitor>",
164 false,
165 KeywordCastExpr::Monitor
166 )
167 {}
168
169 virtual ~MonitorKeyword() {}
170
171 virtual bool is_target( StructDecl * decl ) override final { return decl->is_monitor(); }
172
173 static void implement( std::list< Declaration * > & translationUnit ) {
174 PassVisitor< MonitorKeyword > impl;
175 mutateAll( translationUnit, impl );
176 }
177 };
178
179 //-----------------------------------------------------------------------------
180 //Handles mutex routines definitions :
181 // void foo( A * mutex a, B * mutex b, int i ) { void foo( A * a, B * b, int i ) {
182 // monitor_desc * __monitors[] = { get_monitor(a), get_monitor(b) };
183 // monitor_guard_t __guard = { __monitors, 2 };
184 // /*Some code*/ => /*Some code*/
185 // } }
186 //
187 class MutexKeyword final {
188 public:
189
190 void postvisit( FunctionDecl * decl );
191 void postvisit( StructDecl * decl );
192
193 std::list<DeclarationWithType*> findMutexArgs( FunctionDecl* );
194 void validate( DeclarationWithType * );
195 void addDtorStatments( FunctionDecl* func, CompoundStmt *, const std::list<DeclarationWithType * > &);
196 void addStatments( FunctionDecl* func, CompoundStmt *, const std::list<DeclarationWithType * > &);
197
198 static void implement( std::list< Declaration * > & translationUnit ) {
199 PassVisitor< MutexKeyword > impl;
200 acceptAll( translationUnit, impl );
201 }
202
203 private:
204 StructDecl* monitor_decl = nullptr;
205 StructDecl* guard_decl = nullptr;
206 StructDecl* dtor_guard_decl = nullptr;
207
208 static std::unique_ptr< Type > generic_func;
209 };
210
211 std::unique_ptr< Type > MutexKeyword::generic_func = std::unique_ptr< Type >(
212 new FunctionType(
213 noQualifiers,
214 true
215 )
216 );
217
218 //-----------------------------------------------------------------------------
219 //Handles mutex routines definitions :
220 // void foo( A * mutex a, B * mutex b, int i ) { void foo( A * a, B * b, int i ) {
221 // monitor_desc * __monitors[] = { get_monitor(a), get_monitor(b) };
222 // monitor_guard_t __guard = { __monitors, 2 };
223 // /*Some code*/ => /*Some code*/
224 // } }
225 //
226 class ThreadStarter final {
227 public:
228
229 void postvisit( FunctionDecl * decl );
230 void previsit ( StructDecl * decl );
231
232 void addStartStatement( FunctionDecl * decl, DeclarationWithType * param );
233
234 static void implement( std::list< Declaration * > & translationUnit ) {
235 PassVisitor< ThreadStarter > impl;
236 acceptAll( translationUnit, impl );
237 }
238
239 private :
240 bool thread_ctor_seen = false;
241 StructDecl * thread_decl = nullptr;
242 };
243
244 //=============================================================================================
245 // General entry routine
246 //=============================================================================================
247 void applyKeywords( std::list< Declaration * > & translationUnit ) {
248 ThreadKeyword ::implement( translationUnit );
249 CoroutineKeyword ::implement( translationUnit );
250 MonitorKeyword ::implement( translationUnit );
251 }
252
253 void implementMutexFuncs( std::list< Declaration * > & translationUnit ) {
254 MutexKeyword ::implement( translationUnit );
255 }
256
257 void implementThreadStarter( std::list< Declaration * > & translationUnit ) {
258 ThreadStarter ::implement( translationUnit );
259 }
260
261 //=============================================================================================
262 // Generic keyword implementation
263 //=============================================================================================
264 void fixupGenerics(FunctionType * func, StructDecl * decl) {
265 cloneAll(decl->parameters, func->forall);
266 for ( TypeDecl * td : func->forall ) {
267 strict_dynamic_cast<StructInstType*>(
268 func->parameters.front()->get_type()->stripReferences()
269 )->parameters.push_back(
270 new TypeExpr( new TypeInstType( noQualifiers, td->name, td ) )
271 );
272 }
273 }
274
275 Declaration * ConcurrentSueKeyword::postmutate(StructDecl * decl) {
276 if( decl->name == type_name && decl->body ) {
277 assert( !type_decl );
278 type_decl = decl;
279 }
280 else if ( is_target(decl) ) {
281 handle( decl );
282 }
283 return decl;
284 }
285
286 Expression * ConcurrentSueKeyword::postmutate( KeywordCastExpr * cast ) {
287 if ( cast_target == cast->target ) {
288 // convert (thread &)t to (thread_desc &)*get_thread(t), etc.
289 if( !type_decl ) SemanticError( cast, context_error );
290 Expression * arg = cast->arg;
291 cast->arg = nullptr;
292 delete cast;
293 return new CastExpr(
294 UntypedExpr::createDeref(
295 new UntypedExpr( new NameExpr( getter_name ), { arg } )
296 ),
297 new ReferenceType(
298 noQualifiers,
299 new StructInstType( noQualifiers, type_decl ) )
300 );
301 }
302 return cast;
303 }
304
305
306 void ConcurrentSueKeyword::handle( StructDecl * decl ) {
307 if( ! decl->body ) return;
308
309 if( !type_decl ) SemanticError( decl, context_error );
310
311 FunctionDecl * func = forwardDeclare( decl );
312 ObjectDecl * field = addField( decl );
313 addRoutines( field, func );
314 }
315
316 FunctionDecl * ConcurrentSueKeyword::forwardDeclare( StructDecl * decl ) {
317
318 StructDecl * forward = decl->clone();
319 forward->set_body( false );
320 deleteAll( forward->get_members() );
321 forward->get_members().clear();
322
323 FunctionType * get_type = new FunctionType( noQualifiers, false );
324 ObjectDecl * this_decl = new ObjectDecl(
325 "this",
326 noStorageClasses,
327 LinkageSpec::Cforall,
328 nullptr,
329 new ReferenceType(
330 noQualifiers,
331 new StructInstType(
332 noQualifiers,
333 decl
334 )
335 ),
336 nullptr
337 );
338
339 get_type->get_parameters().push_back( this_decl->clone() );
340 get_type->get_returnVals().push_back(
341 new ObjectDecl(
342 "ret",
343 noStorageClasses,
344 LinkageSpec::Cforall,
345 nullptr,
346 new PointerType(
347 noQualifiers,
348 new StructInstType(
349 noQualifiers,
350 type_decl
351 )
352 ),
353 nullptr
354 )
355 );
356 fixupGenerics(get_type, decl);
357
358 FunctionDecl * get_decl = new FunctionDecl(
359 getter_name,
360 Type::Static,
361 LinkageSpec::Cforall,
362 get_type,
363 nullptr,
364 noAttributes,
365 Type::Inline
366 );
367
368 FunctionDecl * main_decl = nullptr;
369
370 if( needs_main ) {
371 FunctionType * main_type = new FunctionType( noQualifiers, false );
372
373 main_type->get_parameters().push_back( this_decl->clone() );
374
375 main_decl = new FunctionDecl(
376 "main",
377 noStorageClasses,
378 LinkageSpec::Cforall,
379 main_type,
380 nullptr
381 );
382 fixupGenerics(main_type, decl);
383 }
384
385 delete this_decl;
386
387 declsToAddBefore.push_back( forward );
388 if( needs_main ) declsToAddBefore.push_back( main_decl );
389 declsToAddBefore.push_back( get_decl );
390
391 return get_decl;
392 }
393
394 ObjectDecl * ConcurrentSueKeyword::addField( StructDecl * decl ) {
395 ObjectDecl * field = new ObjectDecl(
396 field_name,
397 noStorageClasses,
398 LinkageSpec::Cforall,
399 nullptr,
400 new StructInstType(
401 noQualifiers,
402 type_decl
403 ),
404 nullptr
405 );
406
407 decl->get_members().push_back( field );
408
409 return field;
410 }
411
412 void ConcurrentSueKeyword::addRoutines( ObjectDecl * field, FunctionDecl * func ) {
413 CompoundStmt * statement = new CompoundStmt();
414 statement->push_back(
415 new ReturnStmt(
416 new AddressExpr(
417 new MemberExpr(
418 field,
419 new CastExpr(
420 new VariableExpr( func->get_functionType()->get_parameters().front() ),
421 func->get_functionType()->get_parameters().front()->get_type()->stripReferences()->clone()
422 )
423 )
424 )
425 )
426 );
427
428 FunctionDecl * get_decl = func->clone();
429
430 get_decl->set_statements( statement );
431
432 declsToAddAfter.push_back( get_decl );
433
434 // get_decl->fixUniqueId();
435 }
436
437 //=============================================================================================
438 // Mutex keyword implementation
439 //=============================================================================================
440
441 void MutexKeyword::postvisit(FunctionDecl* decl) {
442
443 std::list<DeclarationWithType*> mutexArgs = findMutexArgs( decl );
444 if( mutexArgs.empty() ) return;
445
446 if( CodeGen::isConstructor(decl->name) ) SemanticError( decl, "constructors cannot have mutex parameters" );
447
448 bool isDtor = CodeGen::isDestructor( decl->name );
449
450 if( isDtor && mutexArgs.size() != 1 ) SemanticError( decl, "destructors can only have 1 mutex argument" );
451
452 for(auto arg : mutexArgs) {
453 validate( arg );
454 }
455
456 CompoundStmt* body = decl->get_statements();
457 if( ! body ) return;
458
459 if( !monitor_decl || !guard_decl || !dtor_guard_decl )
460 SemanticError( decl, "mutex keyword requires monitors to be in scope, add #include <monitor>" );
461
462 if( isDtor ) {
463 addDtorStatments( decl, body, mutexArgs );
464 }
465 else {
466 addStatments( decl, body, mutexArgs );
467 }
468 }
469
470 void MutexKeyword::postvisit(StructDecl* decl) {
471
472 if( decl->name == "monitor_desc" ) {
473 assert( !monitor_decl );
474 monitor_decl = decl;
475 }
476 else if( decl->name == "monitor_guard_t" ) {
477 assert( !guard_decl );
478 guard_decl = decl;
479 }
480 else if( decl->name == "monitor_dtor_guard_t" ) {
481 assert( !dtor_guard_decl );
482 dtor_guard_decl = decl;
483 }
484 }
485
486 std::list<DeclarationWithType*> MutexKeyword::findMutexArgs( FunctionDecl* decl ) {
487 std::list<DeclarationWithType*> mutexArgs;
488
489 for( auto arg : decl->get_functionType()->get_parameters()) {
490 //Find mutex arguments
491 Type* ty = arg->get_type();
492 if( ! ty->get_mutex() ) continue;
493
494 //Append it to the list
495 mutexArgs.push_back( arg );
496 }
497
498 return mutexArgs;
499 }
500
501 void MutexKeyword::validate( DeclarationWithType * arg ) {
502 Type* ty = arg->get_type();
503
504 //Makes sure it's not a copy
505 ReferenceType* rty = dynamic_cast< ReferenceType * >( ty );
506 if( ! rty ) SemanticError( arg, "Mutex argument must be of reference type " );
507
508 //Make sure the we are pointing directly to a type
509 Type* base = rty->get_base();
510 if( dynamic_cast< ReferenceType * >( base ) ) SemanticError( arg, "Mutex argument have exactly one level of indirection " );
511 if( dynamic_cast< PointerType * >( base ) ) SemanticError( arg, "Mutex argument have exactly one level of indirection " );
512
513 //Make sure that typed isn't mutex
514 if( base->get_mutex() ) SemanticError( arg, "mutex keyword may only appear once per argument " );
515 }
516
517 void MutexKeyword::addDtorStatments( FunctionDecl* func, CompoundStmt * body, const std::list<DeclarationWithType * > & args ) {
518 Type * arg_type = args.front()->get_type()->clone();
519 arg_type->set_mutex( false );
520
521 ObjectDecl * monitors = new ObjectDecl(
522 "__monitor",
523 noStorageClasses,
524 LinkageSpec::Cforall,
525 nullptr,
526 new PointerType(
527 noQualifiers,
528 new StructInstType(
529 noQualifiers,
530 monitor_decl
531 )
532 ),
533 new SingleInit( new UntypedExpr(
534 new NameExpr( "get_monitor" ),
535 { new CastExpr( new VariableExpr( args.front() ), arg_type ) }
536 ))
537 );
538
539 assert(generic_func);
540
541 //in reverse order :
542 // monitor_guard_t __guard = { __monitors, #, func };
543 body->push_front(
544 new DeclStmt( new ObjectDecl(
545 "__guard",
546 noStorageClasses,
547 LinkageSpec::Cforall,
548 nullptr,
549 new StructInstType(
550 noQualifiers,
551 dtor_guard_decl
552 ),
553 new ListInit(
554 {
555 new SingleInit( new AddressExpr( new VariableExpr( monitors ) ) ),
556 new SingleInit( new CastExpr( new VariableExpr( func ), generic_func->clone() ) )
557 },
558 noDesignators,
559 true
560 )
561 ))
562 );
563
564 //monitor_desc * __monitors[] = { get_monitor(a), get_monitor(b) };
565 body->push_front( new DeclStmt( monitors) );
566 }
567
568 void MutexKeyword::addStatments( FunctionDecl* func, CompoundStmt * body, const std::list<DeclarationWithType * > & args ) {
569 ObjectDecl * monitors = new ObjectDecl(
570 "__monitors",
571 noStorageClasses,
572 LinkageSpec::Cforall,
573 nullptr,
574 new ArrayType(
575 noQualifiers,
576 new PointerType(
577 noQualifiers,
578 new StructInstType(
579 noQualifiers,
580 monitor_decl
581 )
582 ),
583 new ConstantExpr( Constant::from_ulong( args.size() ) ),
584 false,
585 false
586 ),
587 new ListInit(
588 map_range < std::list<Initializer*> > ( args, [](DeclarationWithType * var ){
589 Type * type = var->get_type()->clone();
590 type->set_mutex( false );
591 return new SingleInit( new UntypedExpr(
592 new NameExpr( "get_monitor" ),
593 { new CastExpr( new VariableExpr( var ), type ) }
594 ) );
595 })
596 )
597 );
598
599 assert(generic_func);
600
601 //in reverse order :
602 // monitor_guard_t __guard = { __monitors, #, func };
603 body->push_front(
604 new DeclStmt( new ObjectDecl(
605 "__guard",
606 noStorageClasses,
607 LinkageSpec::Cforall,
608 nullptr,
609 new StructInstType(
610 noQualifiers,
611 guard_decl
612 ),
613 new ListInit(
614 {
615 new SingleInit( new VariableExpr( monitors ) ),
616 new SingleInit( new ConstantExpr( Constant::from_ulong( args.size() ) ) ),
617 new SingleInit( new CastExpr( new VariableExpr( func ), generic_func->clone() ) )
618 },
619 noDesignators,
620 true
621 )
622 ))
623 );
624
625 //monitor_desc * __monitors[] = { get_monitor(a), get_monitor(b) };
626 body->push_front( new DeclStmt( monitors) );
627 }
628
629 //=============================================================================================
630 // General entry routine
631 //=============================================================================================
632 void ThreadStarter::previsit( StructDecl * decl ) {
633 if( decl->name == "thread_desc" && decl->body ) {
634 assert( !thread_decl );
635 thread_decl = decl;
636 }
637 }
638
639 void ThreadStarter::postvisit(FunctionDecl * decl) {
640 if( ! CodeGen::isConstructor(decl->name) ) return;
641
642 Type * typeof_this = InitTweak::getTypeofThis(decl->type);
643 StructInstType * ctored_type = dynamic_cast< StructInstType * >( typeof_this );
644 if( ctored_type && ctored_type->baseStruct == thread_decl ) {
645 thread_ctor_seen = true;
646 }
647
648 DeclarationWithType * param = decl->get_functionType()->get_parameters().front();
649 auto type = dynamic_cast< StructInstType * >( InitTweak::getPointerBase( param->get_type() ) );
650 if( type && type->get_baseStruct()->is_thread() ) {
651 if( !thread_decl || !thread_ctor_seen ) {
652 SemanticError( type->get_baseStruct()->location, "thread keyword requires threads to be in scope, add #include <thread>");
653 }
654
655 addStartStatement( decl, param );
656 }
657 }
658
659 void ThreadStarter::addStartStatement( FunctionDecl * decl, DeclarationWithType * param ) {
660 CompoundStmt * stmt = decl->get_statements();
661
662 if( ! stmt ) return;
663
664 stmt->push_back(
665 new ExprStmt(
666 new UntypedExpr(
667 new NameExpr( "__thrd_start" ),
668 { new VariableExpr( param ) }
669 )
670 )
671 );
672 }
673};
674
675// Local Variables: //
676// mode: c //
677// tab-width: 4 //
678// End: //
Note: See TracBrowser for help on using the repository browser.