Context Navigation

source: src/Concurrency/Keywords.cc @ f07c1e6

ADTaaron-thesisarm-ehast-experimentalcleanup-dtorsdeferred_resndemanglerenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprnew-envno_listpersistent-indexerpthread-emulationqualifiedEnumresolv-newwith_gc

Last change on this file since f07c1e6 was 2db79e5, checked in by Thierry Delisle <tdelisle@…>, 7 years ago
[fixes #68] added generic parameters to genereted functions for thread
Property mode set to `100644`
File size: 20.2 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
37	class Attribute;
38
39	namespace 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 fixupGenerics(FunctionType * func, StructDecl * decl) {
260	cloneAll(decl->parameters, func->forall);
261	for ( TypeDecl * td : func->forall ) {
262	strict_dynamic_cast<StructInstType*>(
263	func->parameters.front()->get_type()->stripReferences()
264	)->parameters.push_back(
265	new TypeExpr( new TypeInstType( noQualifiers, td->name, td ) )
266	);
267	}
268	}
269
270	void ConcurrentSueKeyword::postvisit(StructDecl * decl) {
271	if( decl->name == type_name && decl->body ) {
272	assert( !type_decl );
273	type_decl = decl;
274	}
275	else if ( is_target(decl) ) {
276	handle( decl );
277	}
278
279	}
280
281	void ConcurrentSueKeyword::handle( StructDecl * decl ) {
282	if( ! decl->body ) return;
283
284	if( !type_decl ) throw SemanticError( context_error, decl );
285
286	FunctionDecl * func = forwardDeclare( decl );
287	ObjectDecl * field = addField( decl );
288	addRoutines( field, func );
289	}
290
291	FunctionDecl * ConcurrentSueKeyword::forwardDeclare( StructDecl * decl ) {
292
293	StructDecl * forward = decl->clone();
294	forward->set_body( false );
295	deleteAll( forward->get_members() );
296	forward->get_members().clear();
297
298	FunctionType * get_type = new FunctionType( noQualifiers, false );
299	ObjectDecl * this_decl = new ObjectDecl(
300	"this",
301	noStorageClasses,
302	LinkageSpec::Cforall,
303	nullptr,
304	new ReferenceType(
305	noQualifiers,
306	new StructInstType(
307	noQualifiers,
308	decl
309	)
310	),
311	nullptr
312	);
313
314	get_type->get_parameters().push_back( this_decl->clone() );
315	get_type->get_returnVals().push_back(
316	new ObjectDecl(
317	"ret",
318	noStorageClasses,
319	LinkageSpec::Cforall,
320	nullptr,
321	new PointerType(
322	noQualifiers,
323	new StructInstType(
324	noQualifiers,
325	type_decl
326	)
327	),
328	nullptr
329	)
330	);
331	fixupGenerics(get_type, decl);
332
333	FunctionDecl * get_decl = new FunctionDecl(
334	getter_name,
335	Type::Static,
336	LinkageSpec::Cforall,
337	get_type,
338	nullptr,
339	noAttributes,
340	Type::Inline
341	);
342
343	FunctionDecl * main_decl = nullptr;
344
345	if( needs_main ) {
346	FunctionType * main_type = new FunctionType( noQualifiers, false );
347
348	main_type->get_parameters().push_back( this_decl->clone() );
349
350	main_decl = new FunctionDecl(
351	"main",
352	noStorageClasses,
353	LinkageSpec::Cforall,
354	main_type,
355	nullptr
356	);
357	fixupGenerics(main_type, decl);
358	}
359
360	delete this_decl;
361
362	declsToAddBefore.push_back( forward );
363	if( needs_main ) declsToAddBefore.push_back( main_decl );
364	declsToAddBefore.push_back( get_decl );
365
366	return get_decl;
367	}
368
369	ObjectDecl * ConcurrentSueKeyword::addField( StructDecl * decl ) {
370	ObjectDecl * field = new ObjectDecl(
371	field_name,
372	noStorageClasses,
373	LinkageSpec::Cforall,
374	nullptr,
375	new StructInstType(
376	noQualifiers,
377	type_decl
378	),
379	nullptr
380	);
381
382	decl->get_members().push_back( field );
383
384	return field;
385	}
386
387	void ConcurrentSueKeyword::addRoutines( ObjectDecl * field, FunctionDecl * func ) {
388	CompoundStmt * statement = new CompoundStmt();
389	statement->push_back(
390	new ReturnStmt(
391	new AddressExpr(
392	new MemberExpr(
393	field,
394	new CastExpr(
395	new VariableExpr( func->get_functionType()->get_parameters().front() ),
396	func->get_functionType()->get_parameters().front()->get_type()->stripReferences()->clone()
397	)
398	)
399	)
400	)
401	);
402
403	FunctionDecl * get_decl = func->clone();
404
405	get_decl->set_statements( statement );
406
407	declsToAddAfter.push_back( get_decl );
408
409	// get_decl->fixUniqueId();
410	}
411
412	//=============================================================================================
413	// Mutex keyword implementation
414	//=============================================================================================
415
416	void MutexKeyword::postvisit(FunctionDecl* decl) {
417
418	std::list<DeclarationWithType*> mutexArgs = findMutexArgs( decl );
419	if( mutexArgs.empty() ) return;
420
421	if( CodeGen::isConstructor(decl->name) ) throw SemanticError( "constructors cannot have mutex parameters", decl );
422
423	bool isDtor = CodeGen::isDestructor( decl->name );
424
425	if( isDtor && mutexArgs.size() != 1 ) throw SemanticError( "destructors can only have 1 mutex argument", decl );
426
427	for(auto arg : mutexArgs) {
428	validate( arg );
429	}
430
431	CompoundStmt* body = decl->get_statements();
432	if( ! body ) return;
433
434	if( !monitor_decl ) throw SemanticError( "mutex keyword requires monitors to be in scope, add #include <monitor>", decl );
435	if( !guard_decl ) throw SemanticError( "mutex keyword requires monitors to be in scope, add #include <monitor>", decl );
436	if( !dtor_guard_decl ) throw SemanticError( "mutex keyword requires monitors to be in scope, add #include <monitor>", decl );
437
438	if( isDtor ) {
439	addDtorStatments( decl, body, mutexArgs );
440	}
441	else {
442	addStatments( decl, body, mutexArgs );
443	}
444	}
445
446	void MutexKeyword::postvisit(StructDecl* decl) {
447
448	if( decl->name == "monitor_desc" ) {
449	assert( !monitor_decl );
450	monitor_decl = decl;
451	}
452	else if( decl->name == "monitor_guard_t" ) {
453	assert( !guard_decl );
454	guard_decl = decl;
455	}
456	else if( decl->name == "monitor_dtor_guard_t" ) {
457	assert( !dtor_guard_decl );
458	dtor_guard_decl = decl;
459	}
460	}
461
462	std::list<DeclarationWithType> MutexKeyword::findMutexArgs( FunctionDecl decl ) {
463	std::list<DeclarationWithType*> mutexArgs;
464
465	for( auto arg : decl->get_functionType()->get_parameters()) {
466	//Find mutex arguments
467	Type* ty = arg->get_type();
468	if( ! ty->get_mutex() ) continue;
469
470	//Append it to the list
471	mutexArgs.push_back( arg );
472	}
473
474	return mutexArgs;
475	}
476
477	void MutexKeyword::validate( DeclarationWithType * arg ) {
478	Type* ty = arg->get_type();
479
480	//Makes sure it's not a copy
481	ReferenceType* rty = dynamic_cast< ReferenceType * >( ty );
482	if( ! rty ) throw SemanticError( "Mutex argument must be of reference type ", arg );
483
484	//Make sure the we are pointing directly to a type
485	Type* base = rty->get_base();
486	if( dynamic_cast< ReferenceType * >( base ) ) throw SemanticError( "Mutex argument have exactly one level of indirection ", arg );
487	if( dynamic_cast< PointerType * >( base ) ) throw SemanticError( "Mutex argument have exactly one level of indirection ", arg );
488
489	//Make sure that typed isn't mutex
490	if( base->get_mutex() ) throw SemanticError( "mutex keyword may only appear once per argument ", arg );
491	}
492
493	void MutexKeyword::addDtorStatments( FunctionDecl* func, CompoundStmt * body, const std::list<DeclarationWithType * > & args ) {
494	Type * arg_type = args.front()->get_type()->clone();
495	arg_type->set_mutex( false );
496
497	ObjectDecl * monitors = new ObjectDecl(
498	"__monitor",
499	noStorageClasses,
500	LinkageSpec::Cforall,
501	nullptr,
502	new PointerType(
503	noQualifiers,
504	new StructInstType(
505	noQualifiers,
506	monitor_decl
507	)
508	),
509	new SingleInit( new UntypedExpr(
510	new NameExpr( "get_monitor" ),
511	{ new CastExpr( new VariableExpr( args.front() ), arg_type ) }
512	))
513	);
514
515	assert(generic_func);
516
517	//in reverse order :
518	// monitor_guard_t __guard = { __monitors, #, func };
519	body->push_front(
520	new DeclStmt( new ObjectDecl(
521	"__guard",
522	noStorageClasses,
523	LinkageSpec::Cforall,
524	nullptr,
525	new StructInstType(
526	noQualifiers,
527	dtor_guard_decl
528	),
529	new ListInit(
530	{
531	new SingleInit( new AddressExpr( new VariableExpr( monitors ) ) ),
532	new SingleInit( new CastExpr( new VariableExpr( func ), generic_func->clone() ) )
533	},
534	noDesignators,
535	true
536	)
537	))
538	);
539
540	//monitor_desc * __monitors[] = { get_monitor(a), get_monitor(b) };
541	body->push_front( new DeclStmt( monitors) );
542	}
543
544	void MutexKeyword::addStatments( FunctionDecl* func, CompoundStmt * body, const std::list<DeclarationWithType * > & args ) {
545	ObjectDecl * monitors = new ObjectDecl(
546	"__monitors",
547	noStorageClasses,
548	LinkageSpec::Cforall,
549	nullptr,
550	new ArrayType(
551	noQualifiers,
552	new PointerType(
553	noQualifiers,
554	new StructInstType(
555	noQualifiers,
556	monitor_decl
557	)
558	),
559	new ConstantExpr( Constant::from_ulong( args.size() ) ),
560	false,
561	false
562	),
563	new ListInit(
564	map_range < std::list<Initializer> > ( args, [](DeclarationWithType var ){
565	Type * type = var->get_type()->clone();
566	type->set_mutex( false );
567	return new SingleInit( new UntypedExpr(
568	new NameExpr( "get_monitor" ),
569	{ new CastExpr( new VariableExpr( var ), type ) }
570	) );
571	})
572	)
573	);
574
575	assert(generic_func);
576
577	//in reverse order :
578	// monitor_guard_t __guard = { __monitors, #, func };
579	body->push_front(
580	new DeclStmt( new ObjectDecl(
581	"__guard",
582	noStorageClasses,
583	LinkageSpec::Cforall,
584	nullptr,
585	new StructInstType(
586	noQualifiers,
587	guard_decl
588	),
589	new ListInit(
590	{
591	new SingleInit( new VariableExpr( monitors ) ),
592	new SingleInit( new ConstantExpr( Constant::from_ulong( args.size() ) ) ),
593	new SingleInit( new CastExpr( new VariableExpr( func ), generic_func->clone() ) )
594	},
595	noDesignators,
596	true
597	)
598	))
599	);
600
601	//monitor_desc * __monitors[] = { get_monitor(a), get_monitor(b) };
602	body->push_front( new DeclStmt( monitors) );
603	}
604
605	//=============================================================================================
606	// General entry routine
607	//=============================================================================================
608	void ThreadStarter::previsit( StructDecl * decl ) {
609	if( decl->name == "thread_desc" && decl->body ) {
610	assert( !thread_decl );
611	thread_decl = decl;
612	}
613	}
614
615	void ThreadStarter::postvisit(FunctionDecl * decl) {
616	if( ! CodeGen::isConstructor(decl->name) ) return;
617
618	Type * typeof_this = InitTweak::getTypeofThis(decl->type);
619	StructInstType * ctored_type = dynamic_cast< StructInstType * >( typeof_this );
620	if( ctored_type && ctored_type->baseStruct == thread_decl ) {
621	thread_ctor_seen = true;
622	}
623
624	DeclarationWithType * param = decl->get_functionType()->get_parameters().front();
625	auto type = dynamic_cast< StructInstType * >( InitTweak::getPointerBase( param->get_type() ) );
626	if( type && type->get_baseStruct()->is_thread() ) {
627	if( !thread_decl \|\| !thread_ctor_seen ) {
628	throw SemanticError("thread keyword requires threads to be in scope, add #include <thread>");
629	}
630
631	addStartStatement( decl, param );
632	}
633	}
634
635	void ThreadStarter::addStartStatement( FunctionDecl * decl, DeclarationWithType * param ) {
636	CompoundStmt * stmt = decl->get_statements();
637
638	if( ! stmt ) return;
639
640	stmt->push_back(
641	new ExprStmt(
642	new UntypedExpr(
643	new NameExpr( "__thrd_start" ),
644	{ new VariableExpr( param ) }
645	)
646	)
647	);
648	}
649	};
650
651	// Local Variables: //
652	// mode: c //
653	// tab-width: 4 //
654	// End: //

Note: See TracBrowser for help on using the repository browser.

Download in other formats: