source: src/Concurrency/Keywords.cc @ ba3706f

aaron-thesisarm-ehcleanup-dtorsdeferred_resndemanglerjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerresolv-newwith_gc
Last change on this file since ba3706f was ba3706f, checked in by Rob Schluntz <rschlunt@…>, 4 years ago

Remove label lists from various Statement constructors

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