1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
(* Copyright 2004-2013 Sascha Husa, Ian Hinder, Christiane Lechner
This file is part of Kranc.
Kranc is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
Kranc is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Kranc; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*)
BeginPackage[
"CodeGenSchedule`",
{"Errors`", "Helpers`", "Kranc`", "CodeGen`", "CodeGenC`", "MapLookup`",
"CodeGenKranc`", "CodeGenCactus`"}];
CreateSchedule::usage = "Create the content of the schedule.ccl file.";
Begin["`Private`"];
(* ------------------------------------------------------------------------
Scheduling
------------------------------------------------------------------------ *)
(* storage group
(represents the fact that we want to allocate storage for a Cactus
variable group with the given number of timelevels)
{Group -> "admbase::metric", Timelevels -> 3,
Conditional -> {Parameter -> "", Value -> ""},
Conditionals -> {{Parameter -> "", Value -> ""}},
Conditional -> {Textual -> "CCTK_EQUALS(name,value)"}}
A "conditional" structure looks like this: {Parameter -> "", Value -> ""}
scheduled function: (a function to be scheduled at a particular point)
{Name -> "ADM_BSSN_CalcRHS_fn", SchedulePoint -> "in POSTINITIAL before ExternalLapse",
Language -> "C", Comment -> "",
(optional) SynchronizedGroups -> {ADM_BSSN_gamma, ...},
(optional) Options -> {"meta", "level", ...},
(optional) StorageGroups -> {Group -> "mygroup", Timelevels -> 1},
(optional) Conditional -> {Parameter -> "", Value -> ""},
(optional) Conditionals -> {{Parameter -> "", Value -> ""}}}
scheduled group:
{... sameish}
*)
(* Given a storage group structure defined above, return a CodeGen
structure for inclusion in the schedule.ccl file to allocate
storage for this group. *)
groupStorage[spec_] :=
Module[
{tls = lookup[spec,Timelevels],
group = lookup[spec, Group]},
Which[
IntegerQ[tls],
{"STORAGE: ", group, "[", tls, "]\n"},
ListQ[tls],
If[!MatchQ[tls, {_String, _Integer}],
Error["Unrecognized Timelevels value "<>ToString[tls]]];
Module[
{param,max},
{param,max} = tls;
{"STORAGE: ", group, "[", param, "]\n"}],
True, Error["Unrecognized Timelevels value "<>ToString[tls]]]];
(* Given a function scheduling specification as defined above, return
a CodeGen block to schedule the function for the schedule.ccl file *)
scheduleUnconditionalFunction[spec_] :=
{"schedule ", lookup[spec, Name], " ", lookup[spec,SchedulePoint], "\n",
SuffixedCBlock[
{If[lookup[spec, Language] != "None",
"LANG: " <> lookup[spec, Language] <> "\n",
""],
If[lookupDefault[spec, Options, ""] != "",
"OPTIONS: " <> lookup[spec, Options] <> "\n",
""],
(* Insert a SYNC line for each group we want to synchronize. *)
Map[{"SYNC: ", #, "\n"} &, lookupDefault[spec, SynchronizedGroups, {}]],
Map[{"TRIGGERS: ", #, "\n"} &, lookupDefault[spec, TriggerGroups, {}]],
(* TODO: Expect a set of keyword/value pairs instead of a string *)
If[lookupDefault[spec, Tags, ""] != "",
"TAGS: " <> lookup[spec, Tags] <> "\n",
""],
translateRegion[r_] := Switch[r,
Everywhere, "Everywhere",
Interior, "Interior",
InteriorNoSync, "Interior",
Boundary, "Boundary",
BoundaryNoSync, "Boundary",
_, "ERROR(" <> ToString[r] <> ")"];
Map[{"READS: ", #, "(",
translateRegion[lookupDefault[spec, RequiredRegion, "ERROR"]],
")\n"} &,
lookupDefault[spec, RequiredGroups, {}]],
Map[{"WRITES: ", #, "(",
translateRegion[lookupDefault[spec, ProvidedRegion, "ERROR"]],
")\n"} &,
lookupDefault[spec, ProvidedGroups, {}]],
(* Insert a storage block for each group we want to allocate
storage for *)
Map[groupStorage, lookupDefault[spec, StorageGroups, {}]]},
Quote[lookup[spec, Comment]]]};
(* Handle the aspect of scheduling the function conditionally *)
scheduleFunction[spec_,params_] :=
Module[{condition, conditions, parameter, value, u, v, w, x, y},
u = scheduleUnconditionalFunction[spec];
v = If[mapContains[spec, Conditional],
(* Output the conditional structure *)
condition = lookup[spec, Conditional];
If[mapContains[condition, Textual],
ConditionalOnParameterTextual[lookup[condition, Textual], u],
If[mapContains[condition, Parameter],
parameter = lookup[condition, Parameter];
value = lookup[condition, Value];
ConditionalOnParameter[parameter, value, u],
If[condition != {},
ThrowError["Unrecognized conditional structure", condition],
u]]],
u];
w = If[mapContains[spec, Conditionals],
(* Output the conditionals structure *)
conditions = lookup[spec, Conditionals];
Fold[Function[{x, condition},
If[mapContains[condition, Textual],
ConditionalOnParameterTextual[lookup[condition, Textual], x],
If[mapContains[condition, Parameter],
parameter = lookup[condition, Parameter];
value = lookup[condition, Value];
ConditionalOnParameter[parameter, value, x],
If[condition != {},
ThrowError["Unrecognized conditional structure", condition],
x]],
x]],
v, conditions],
v];
y = If[mapContains[spec, NewConditional],
cond = lookup[spec, NewConditional];
Module[
{render, renderbool, paramPattern},
paramPattern = Except[True | False, _Symbol | _Parameter];
renderbool[Equal[a:paramPattern,b_String]] := {"CCTK_EQUALS(", rendervalue[a], ",\"", b,"\")"};
renderbool[Unequal[a:paramPattern,b_String]] := {"!CCTK_EQUALS(", rendervalue[a], ",\"", b,"\")"};
renderbool[Equal[a:paramPattern,b_?NumberQ]] := {rendervalue[a], " == ", rendervalue[b]};
renderbool[Unequal[a:paramPattern,b_?NumberQ]] := {rendervalue[a], " != ", rendervalue[b]};
renderbool[Or[a_,b_]] := {"(",renderbool[a]," || ", renderbool[b],")"};
renderbool[And[a_,b_]] := {"(",renderbool[a]," && ", renderbool[b],")"};
renderbool[Not[a_]] := {"(!", renderbool[a],")"};
renderbool[a:paramPattern] := ToString[a/.(Parameter[x_]->x)]; (* Boolean parameter *)
(* rendervalue[a_String] := a; -- Allow literal pass-through *)
rendervalue[a_?NumberQ] := ToString[a];
rendervalue[Parameter[a_String]] := a;
rendervalue[a_ /; MemberQ[params,a]] := ToString[a];
renderbool[x_] := ThrowError["Unexpected value in run-time conditional expression (boolean):", x, "in", cond];
render[x_] := ThrowError["Unexpected value in run-time conditional expression (value):", x, "in", cond];
unparen[s_] :=
Module[
{s2 = FlattenBlock[s],result},
result = StringReplace[FlattenBlock[s2],StartOfString ~~ "(" ~~ any__ ~~ ")" ~~ EndOfString :> any];
If[result === s2, result, unparen[result]]];
ConditionalOnParameterTextual[unparen@renderbool[cond], w]],
w];
y];
(* Schedule a schedule group. Use a slightly dirty trick; given that
the structure is identical to that for a function except with the
word "GROUP" added before the function name, just use the existing
function. *)
scheduleGroup[spec_,params_] :=
scheduleFunction[mapReplace[spec, Name, "group " <> lookup[spec, Name]],params];
(* Taking a list of group storage specifications for global storage,
and lists of scheduled function and scheduled group structures,
return a CodeGen block representing a schedule.ccl file. *)
CreateSchedule[globalStorageGroups_, scheduledGroups_, scheduledFunctions_, params_] :=
{FileHeader["CCL"],
Map[SeparatedBlock[groupStorage[#]] &, globalStorageGroups],
Map[SeparatedBlock[scheduleFunction[#,params]] &, scheduledFunctions],
Map[SeparatedBlock[scheduleGroup[#,params]] &, scheduledGroups]};
End[];
EndPackage[];
|
