-
Notifications
You must be signed in to change notification settings - Fork 296
/
NFEvalConstants.mo
594 lines (521 loc) · 16.9 KB
/
NFEvalConstants.mo
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
/*
* This file is part of OpenModelica.
*
* Copyright (c) 1998-2014, Open Source Modelica Consortium (OSMC),
* c/o Linköpings universitet, Department of Computer and Information Science,
* SE-58183 Linköping, Sweden.
*
* All rights reserved.
*
* THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
* THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
* ACCORDING TO RECIPIENTS CHOICE.
*
* The OpenModelica software and the Open Source Modelica
* Consortium (OSMC) Public License (OSMC-PL) are obtained
* from OSMC, either from the above address,
* from the URLs: http://www.ida.liu.se/projects/OpenModelica or
* http://www.openmodelica.org, and in the OpenModelica distribution.
* GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
*
* This program is distributed WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
* IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
*
* See the full OSMC Public License conditions for more details.
*
*/
encapsulated package NFEvalConstants
import FlatModel = NFFlatModel;
import Equation = NFEquation;
import Statement = NFStatement;
import Expression = NFExpression;
import Type = NFType;
import ComponentRef = NFComponentRef;
import NFFlatten.FunctionTree;
import Class = NFClass;
import NFInstNode.InstNode;
import NFFunction.Function;
import Sections = NFSections;
import Binding = NFBinding;
import Variable = NFVariable;
import Algorithm = NFAlgorithm;
import NFEquation.Branch;
import Dimension = NFDimension;
import NFTyping.ExpOrigin;
protected
import MetaModelica.Dangerous.*;
import ExecStat.execStat;
import NFPrefixes.Variability;
import Ceval = NFCeval;
import Package = NFPackage;
import SimplifyExp = NFSimplifyExp;
public
function evaluate
input output FlatModel flatModel;
algorithm
flatModel.variables := list(evaluateVariable(v) for v in flatModel.variables);
flatModel.equations := evaluateEquations(flatModel.equations);
flatModel.initialEquations := evaluateEquations(flatModel.initialEquations);
flatModel.algorithms := evaluateAlgorithms(flatModel.algorithms);
flatModel.initialAlgorithms := evaluateAlgorithms(flatModel.initialAlgorithms);
execStat(getInstanceName());
end evaluate;
function evaluateVariable
input output Variable var;
protected
Binding binding;
algorithm
binding := evaluateBinding(var.binding,
Variable.variability(var) <= Variability.STRUCTURAL_PARAMETER);
if not referenceEq(binding, var.binding) then
var.binding := binding;
end if;
var.typeAttributes := list(evaluateTypeAttribute(a) for a in var.typeAttributes);
end evaluateVariable;
function evaluateBinding
input output Binding binding;
input Boolean structural;
protected
Expression exp, eexp;
SourceInfo info;
algorithm
if Binding.isBound(binding) then
exp := Binding.getTypedExp(binding);
if structural then
eexp := Ceval.evalExp(exp, Ceval.EvalTarget.ATTRIBUTE(binding));
else
info := Binding.getInfo(binding);
eexp := evaluateExp(exp, info);
end if;
if not referenceEq(exp, eexp) then
binding := Binding.setTypedExp(eexp, binding);
end if;
end if;
end evaluateBinding;
function evaluateTypeAttribute
input output tuple<String, Binding> attribute;
protected
String name;
Binding binding, sbinding;
Boolean structural;
algorithm
(name, binding) := attribute;
structural := name == "fixed" or name == "stateSelect";
sbinding := evaluateBinding(binding, structural);
if not referenceEq(binding, sbinding) then
attribute := (name, sbinding);
end if;
end evaluateTypeAttribute;
function evaluateExp
input Expression exp;
input SourceInfo info;
output Expression outExp;
algorithm
outExp := evaluateExpTraverser(exp, info);
end evaluateExp;
function evaluateExpTraverser
input Expression exp;
input SourceInfo info;
input Boolean changed = false;
output Expression outExp;
output Boolean outChanged;
protected
Expression e;
ComponentRef cref;
Type ty, ty2;
Variability var;
algorithm
outExp := match exp
case Expression.CREF()
algorithm
(outExp as Expression.CREF(cref = cref, ty = ty), outChanged) :=
Expression.mapFoldShallow(exp,
function evaluateExpTraverser(info = info), false);
if ComponentRef.nodeVariability(cref) <= Variability.STRUCTURAL_PARAMETER then
// Evaluate all constants and structural parameters.
outExp := Ceval.evalCref(cref, outExp, Ceval.EvalTarget.IGNORE_ERRORS(), evalSubscripts = false);
outExp := Expression.stripBindingInfo(outExp);
outChanged := true;
elseif outChanged then
ty := ComponentRef.getSubscriptedType(cref);
end if;
ty2 := evaluateType(ty, info);
if not referenceEq(ty, ty2) then
outExp := Expression.setType(ty2, outExp);
end if;
then
outExp;
case Expression.IF()
algorithm
(outExp, outChanged) := evaluateIfExp(exp, info);
then
outExp;
// TODO: The return type of calls can have dimensions that reference
// function parameters, and thus can't be evaluated. This should be
// fixed so that the return type reference the input arguments instead.
case Expression.CALL()
algorithm
(outExp, outChanged) := Expression.mapFoldShallow(exp,
function evaluateExpTraverser(info = info), false);
then
outExp;
else
algorithm
(outExp, outChanged) := Expression.mapFoldShallow(exp,
function evaluateExpTraverser(info = info), false);
ty := Expression.typeOf(outExp);
ty2 := evaluateType(ty, info);
then
if referenceEq(ty, ty2) then outExp else Expression.setType(ty2, outExp);
end match;
outChanged := changed or outChanged;
end evaluateExpTraverser;
function evaluateType
input output Type ty;
input SourceInfo info;
algorithm
ty := match ty
case Type.ARRAY()
algorithm
ty.dimensions := list(evaluateDimension(d, info) for d in ty.dimensions);
then
ty;
case Type.CONDITIONAL_ARRAY()
then Type.simplifyConditionalArray(ty);
else ty;
end match;
end evaluateType;
function evaluateDimension
input Dimension dim;
input SourceInfo info;
output Dimension outDim;
algorithm
outDim := match dim
local
Expression e;
case Dimension.EXP()
algorithm
if dim.var <= Variability.STRUCTURAL_PARAMETER and not
Expression.containsIterator(dim.exp, ExpOrigin.FOR) then
e := Ceval.evalExp(dim.exp, Ceval.EvalTarget.GENERIC(info));
else
e := evaluateExp(dim.exp, info);
end if;
then
if referenceEq(e, dim.exp) then dim else Dimension.fromExp(e, dim.var);
else dim;
end match;
end evaluateDimension;
function evaluateIfExp
"Evaluates constants in an if-expression. This is done by first checking if
the condition can be evaluated, in which case branch selection is done to
avoid issues that can arise when evaluating constants in branches that are
expected to be discarded. This function also makes sure that if-expressions
with branches that have different dimensions are resolved to the correct
branch based on the type matching in earlier stages of the compilation."
input Expression exp;
input SourceInfo info;
output Expression outExp;
output Boolean outChanged;
protected
Type ty;
Expression cond, tb, fb;
Boolean c1, c2;
Type.Branch matched_branch;
algorithm
Expression.IF(ty, cond, tb, fb) := exp;
(cond, outChanged) := evaluateExpTraverser(cond, info);
// Simplify the condition in case it can be reduced to a literal value.
cond := SimplifyExp.simplify(cond);
if Type.isConditionalArray(ty) then
(outExp, outChanged) := match cond
case Expression.BOOLEAN()
algorithm
if not Type.isMatchedBranch(cond.value, ty) then
// The branch with the incompatible dimensions was chosen, print an error and fail.
(tb, fb) := Util.swap(cond.value, fb, tb);
Error.addSourceMessage(Error.ARRAY_DIMENSION_MISMATCH,
{Expression.toString(tb), Type.toString(Expression.typeOf(tb)),
Dimension.toStringList(Type.arrayDims(Expression.typeOf(fb)), brackets = false)}, info);
fail();
end if;
outExp := evaluateExpTraverser(if cond.value then tb else fb, info);
then
(outExp, true);
else
algorithm
// The condition could not be evaluated to a literal. This is required
// if the branches have different dimensions, so print an error and fail.
Error.addSourceMessage(Error.TYPE_MISMATCH_IF_EXP,
{"", Expression.toString(tb), Type.toString(Expression.typeOf(tb)),
Expression.toString(fb), Type.toString(Expression.typeOf(fb))}, info);
then
fail();
end match;
else
(outExp, outChanged) := match cond
// Only evaluate constants in and return one of the branches if the
// condition is a literal boolean value.
case Expression.BOOLEAN()
algorithm
outExp := evaluateExpTraverser(if cond.value then tb else fb, info);
then
(outExp, true);
// Otherwise evaluate constants in both branches and return the whole
// if-expression.
else
algorithm
(tb, c1) := evaluateExpTraverser(tb, info);
(fb, c2) := evaluateExpTraverser(fb, info);
then
(Expression.IF(ty, cond, tb, fb), outChanged or c1 or c2);
end match;
end if;
end evaluateIfExp;
function evaluateEquations
input list<Equation> eql;
output list<Equation> outEql = list(evaluateEquation(e) for e in eql);
end evaluateEquations;
function evaluateEquation
input output Equation eq;
protected
SourceInfo info = Equation.info(eq);
algorithm
eq := match eq
local
Expression e1, e2, e3;
Type ty;
case Equation.EQUALITY()
algorithm
ty := Type.mapDims(eq.ty, function evaluateDimension(info = info));
e1 := evaluateExp(eq.lhs, info);
e2 := evaluateExp(eq.rhs, info);
then
Equation.EQUALITY(e1, e2, ty, eq.source);
case Equation.ARRAY_EQUALITY()
algorithm
ty := Type.mapDims(eq.ty, function evaluateDimension(info = info));
e2 := evaluateExp(eq.rhs, info);
then
Equation.ARRAY_EQUALITY(eq.lhs, e2, ty, eq.source);
case Equation.FOR()
algorithm
eq.range := Util.applyOption(eq.range,
function evaluateExp(info = info));
eq.body := evaluateEquations(eq.body);
then
eq;
case Equation.IF()
algorithm
eq.branches := list(evaluateEqBranch(b, info) for b in eq.branches);
then
eq;
case Equation.WHEN()
algorithm
eq.branches := list(evaluateEqBranch(b, info) for b in eq.branches);
then
eq;
case Equation.ASSERT()
algorithm
e1 := evaluateExp(eq.condition, info);
e2 := evaluateExp(eq.message, info);
e3 := evaluateExp(eq.level, info);
then
Equation.ASSERT(e1, e2, e3, eq.source);
case Equation.TERMINATE()
algorithm
eq.message := evaluateExp(eq.message, info);
then
eq;
case Equation.REINIT()
algorithm
eq.reinitExp := evaluateExp(eq.reinitExp, info);
then
eq;
case Equation.NORETCALL()
algorithm
eq.exp := evaluateExp(eq.exp, info);
then
eq;
else eq;
end match;
end evaluateEquation;
function evaluateEqBranch
input Branch branch;
input SourceInfo info;
output Branch outBranch;
algorithm
outBranch := match branch
local
Expression condition;
list<Equation> body;
case Branch.BRANCH(condition = condition, body = body)
algorithm
condition := evaluateExp(condition, info);
body := evaluateEquations(body);
then
Branch.BRANCH(condition, branch.conditionVar, body);
else branch;
end match;
end evaluateEqBranch;
function evaluateAlgorithms
input list<Algorithm> algs;
output list<Algorithm> outAlgs = list(evaluateAlgorithm(a) for a in algs);
end evaluateAlgorithms;
function evaluateAlgorithm
input output Algorithm alg;
algorithm
alg.statements := evaluateStatements(alg.statements);
end evaluateAlgorithm;
function evaluateStatements
input list<Statement> stmts;
output list<Statement> outStmts = list(evaluateStatement(s) for s in stmts);
end evaluateStatements;
function evaluateStatement
input output Statement stmt;
protected
SourceInfo info = Statement.info(stmt);
algorithm
stmt := match stmt
local
Expression e1, e2, e3;
Type ty;
case Statement.ASSIGNMENT()
algorithm
ty := Type.mapDims(stmt.ty, function evaluateDimension(info = info));
e1 := evaluateExp(stmt.lhs, info);
e2 := evaluateExp(stmt.rhs, info);
then
Statement.ASSIGNMENT(e1, e2, ty, stmt.source);
case Statement.FOR()
algorithm
stmt.range := Util.applyOption(stmt.range,
function evaluateExp(info = info));
stmt.body := evaluateStatements(stmt.body);
then
stmt;
case Statement.IF()
algorithm
stmt.branches := list(evaluateStmtBranch(b, info) for b in stmt.branches);
then
stmt;
case Statement.WHEN()
algorithm
stmt.branches := list(evaluateStmtBranch(b, info) for b in stmt.branches);
then
stmt;
case Statement.ASSERT()
algorithm
e1 := evaluateExp(stmt.condition, info);
e2 := evaluateExp(stmt.message, info);
e3 := evaluateExp(stmt.level, info);
then
Statement.ASSERT(e1, e2, e3, stmt.source);
case Statement.TERMINATE()
algorithm
stmt.message := evaluateExp(stmt.message, info);
then
stmt;
case Statement.NORETCALL()
algorithm
stmt.exp := evaluateExp(stmt.exp, info);
then
stmt;
case Statement.WHILE()
algorithm
stmt.condition := evaluateExp(stmt.condition, info);
stmt.body := evaluateStatements(stmt.body);
then
stmt;
else stmt;
end match;
end evaluateStatement;
function evaluateStmtBranch
input tuple<Expression, list<Statement>> branch;
input SourceInfo info;
output tuple<Expression, list<Statement>> outBranch;
protected
Expression cond;
list<Statement> body;
algorithm
(cond, body) := branch;
cond := evaluateExp(cond, info);
body := evaluateStatements(body);
outBranch := (cond, body);
end evaluateStmtBranch;
function evaluateFunction
input output Function func;
protected
Class cls;
Algorithm fn_body;
Sections sections;
algorithm
if not Function.isEvaluated(func) then
Function.markEvaluated(func);
func := Function.mapExp(func, function evaluateFuncExp(fnNode = func.node));
for fn_der in func.derivatives loop
for der_fn in Function.getCachedFuncs(fn_der.derivativeFn) loop
evaluateFunction(der_fn);
end for;
end for;
end if;
end evaluateFunction;
function evaluateFuncExp
input Expression exp;
input InstNode fnNode;
output Expression outExp;
algorithm
outExp := evaluateFuncExpTraverser(exp, fnNode, false);
end evaluateFuncExp;
function evaluateFuncExpTraverser
input Expression exp;
input InstNode fnNode;
input Boolean changed;
output Expression outExp;
output Boolean outChanged;
protected
Expression e;
algorithm
(e, outChanged) := Expression.mapFoldShallow(exp,
function evaluateFuncExpTraverser(fnNode = fnNode), false);
outExp := match e
case Expression.CREF()
algorithm
if not isLocalFunctionVariable(e.cref, fnNode) then
outExp := Ceval.evalCref(e.cref, e, Ceval.EvalTarget.IGNORE_ERRORS(), evalSubscripts = false);
outExp := Expression.stripBindingInfo(outExp);
outChanged := true;
elseif outChanged then
// If the cref's subscripts changed, recalculate its type.
outExp := Expression.CREF(ComponentRef.getSubscriptedType(e.cref), e.cref);
else
outExp := e;
end if;
then
outExp;
else if outChanged then Expression.retype(e) else e;
end match;
outChanged := changed or outChanged;
end evaluateFuncExpTraverser;
function isLocalFunctionVariable
input ComponentRef cref;
input InstNode fnNode;
output Boolean res;
protected
InstNode node;
algorithm
if ComponentRef.isPackageConstant(cref) then
res := false;
elseif ComponentRef.nodeVariability(cref) <= Variability.PARAMETER then
node := InstNode.derivedParent(ComponentRef.node(ComponentRef.firstNonScope(cref)));
res := InstNode.refEqual(fnNode, node);
else
res := true;
end if;
end isLocalFunctionVariable;
annotation(__OpenModelica_Interface="frontend");
end NFEvalConstants;