/
Flags.mo
1923 lines (1733 loc) · 78.5 KB
/
Flags.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
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* This file is part of OpenModelica.
*
* Copyright (c) 1998-CurrentYear, Linköping University,
* 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
* AND THIS OSMC PUBLIC LICENSE (OSMC-PL).
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES RECIPIENT'S
* ACCEPTANCE OF THE OSMC PUBLIC LICENSE.
*
* The OpenModelica software and the Open Source Modelica
* Consortium (OSMC) Public License (OSMC-PL) are obtained
* from Linköping University, 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 Flags
" file: Flags.mo
package: Flags
description: Tools for using compiler flags.
RCS: $Id$
This package contains function for using compiler flags. There are two types
of flags, debug flag and configuration flags. The flags are stored and
retrieved with set/getGlobalRoot so that they can be accessed everywhere in
the compiler.
Configuration flags are flags such as +std which affects the behaviour of the
compiler. These flags can have different types, see the FlagData uniontype
below, and they also have a default value. There is also another package,
Config, which acts as a wrapper for many of these flags.
Debug flags are boolean flags specified with +d, which can be used together
with the Debug package. They are typically used to enable printing of extra
information that helps debugging, such as the failtrace flag. Unlike
configuration flags they are only on or off, i.e. true or false.
To add a new flag, simply add a new constant of either DebugFlag or ConfigFlag
type below, and then add it to either the allDebugFlags or allConfigFlags list
depending on which type it is.
"
protected import Corba;
protected import Debug;
protected import Error;
protected import ErrorExt;
protected import Global;
protected import List;
protected import Print;
protected import Settings;
protected import System;
public import Absyn;
public import Util;
public uniontype DebugFlag
record DEBUG_FLAG
Integer index "Unique index.";
String name "The name of the flag used by +d";
Boolean default "Default enabled or not";
Util.TranslatableContent description "A description of the flag.";
end DEBUG_FLAG;
end DebugFlag;
public uniontype ConfigFlag
record CONFIG_FLAG
Integer index "Unique index.";
String name "The whole name of the flag.";
Option<String> shortname "A short name one-character name for the flag.";
FlagVisibility visibility "Whether the flag is visible to the user or not.";
FlagData defaultValue "The default value of the flag.";
Option<ValidOptions> validOptions "The valid options for the flag.";
Util.TranslatableContent description "A description of the flag.";
end CONFIG_FLAG;
end ConfigFlag;
public uniontype FlagData
"This uniontype is used to store the values of configuration flags."
record EMPTY_FLAG
"Only used to initialize the flag array."
end EMPTY_FLAG;
record BOOL_FLAG
"Value of a boolean flag."
Boolean data;
end BOOL_FLAG;
record INT_FLAG
"Value of an integer flag."
Integer data;
end INT_FLAG;
record REAL_FLAG
"Value of a real flag."
Real data;
end REAL_FLAG;
record STRING_FLAG
"Value of a string flag."
String data;
end STRING_FLAG;
record STRING_LIST_FLAG
"Values of a string flag that can have multiple values."
list<String> data;
end STRING_LIST_FLAG;
record ENUM_FLAG
"Value of an enumeration flag."
Integer data;
list<tuple<String, Integer>> validValues "The valid values of the enum.";
end ENUM_FLAG;
end FlagData;
public uniontype FlagVisibility
"This uniontype is used to specify the visibility of a configuration flag."
record INTERNAL "An internal flag that is hidden to the user." end INTERNAL;
record EXTERNAL "An external flag that is visible to the user." end EXTERNAL;
end FlagVisibility;
public uniontype Flags
"The structure which stores the flags."
record FLAGS
array<Boolean> debugFlags;
array<FlagData> configFlags;
end FLAGS;
end Flags;
public uniontype ValidOptions
"Specifies valid options for a flag."
record STRING_OPTION
"Options for a string flag."
list<String> options;
end STRING_OPTION;
record STRING_DESC_OPTION
"Options for a string flag, with a description for each option."
list<tuple<String, Util.TranslatableContent>> options;
end STRING_DESC_OPTION;
end ValidOptions;
// Change this to a proper enum when we have support for them.
public constant Integer MODELICA = 1;
public constant Integer METAMODELICA = 2;
public constant Integer PARMODELICA = 3;
public constant Integer OPTIMICA = 4;
// DEBUG FLAGS
public
constant DebugFlag FAILTRACE = DEBUG_FLAG(1, "failtrace", false,
Util.gettext("Sets whether to print a failtrace or not."));
constant DebugFlag CEVAL = DEBUG_FLAG(2, "ceval", false,
Util.gettext("Prints extra information from Ceval."));
constant DebugFlag CHECK_BACKEND_DAE = DEBUG_FLAG(3, "checkBackendDae", false,
Util.gettext("Do some simple analyses on the datastructure from the frontend to check if it is consistent."));
constant DebugFlag OPENMP = DEBUG_FLAG(4, "openmp", false,
Util.gettext("Experimental: Enable parallelization of independent systems of equations in the translated model."));
constant DebugFlag PTHREADS = DEBUG_FLAG(5, "pthreads", false,
Util.gettext("Experimental: Unused parallelization."));
constant DebugFlag EVENTS = DEBUG_FLAG(6, "events", true,
Util.gettext("Turns on/off events handling."));
constant DebugFlag DUMP_INLINE_SOLVER = DEBUG_FLAG(7, "dumpInlineSolver", false,
Util.gettext("Dumps the inline solver equation system."));
constant DebugFlag EVAL_FUNC = DEBUG_FLAG(8, "evalfunc", true,
Util.gettext("Turns on/off symbolic function evaluation."));
constant DebugFlag GEN = DEBUG_FLAG(9, "gen", true,
Util.gettext("Turns on/off dynamic loading of functions that are compiled during translation. Only enable this if external functions are needed to calculate structural parameters or constants."));
constant DebugFlag DYN_LOAD = DEBUG_FLAG(10, "dynload", false,
Util.gettext("Display debug information about dynamic loading of compiled functions."));
constant DebugFlag GENERATE_CODE_CHEAT = DEBUG_FLAG(11, "generateCodeCheat", false,
Util.gettext("Used to generate code for the bootstrapped compiler."));
constant DebugFlag CGRAPH_GRAPHVIZ_FILE = DEBUG_FLAG(12, "cgraphGraphVizFile", false,
Util.gettext("Generates a graphviz file of the connection graph."));
constant DebugFlag CGRAPH_GRAPHVIZ_SHOW = DEBUG_FLAG(13, "cgraphGraphVizShow", false,
Util.gettext("Displays the connection graph with the GraphViz lefty tool."));
constant DebugFlag USEDEP = DEBUG_FLAG(14, "usedep", false,
Util.gettext("Turns on/off dependency analysis for getTotalProgram."));
constant DebugFlag CHECK_DAE_CREF_TYPE = DEBUG_FLAG(15, "checkDAECrefType", false,
Util.gettext("Enables extra type checking for cref expressions."));
constant DebugFlag CHECK_ASUB = DEBUG_FLAG(16, "checkASUB", false,
Util.gettext("Prints out a warning if an ASUB is created from a CREF expression."));
constant DebugFlag INSTANCE = DEBUG_FLAG(17, "instance", false,
Util.gettext("Prints extra failtrace from InstanceHierarchy."));
constant DebugFlag CACHE = DEBUG_FLAG(18, "Cache", true,
Util.gettext("Turns off the instantiation cache."));
constant DebugFlag RML = DEBUG_FLAG(19, "rml", false,
Util.gettext("Turns on extra RML checks."));
constant DebugFlag TAIL = DEBUG_FLAG(20, "tail", false,
Util.gettext("Prints out a notification if tail recursion optimization has been applied."));
constant DebugFlag LOOKUP = DEBUG_FLAG(21, "lookup", false,
Util.gettext("Print extra failtrace from lookup."));
constant DebugFlag PATTERNM_SKIP_FILTER_UNUSED_AS_BINDINGS = DEBUG_FLAG(22, "patternmSkipFilterUnusedBindings", false,
Util.notrans(""));
constant DebugFlag PATTERNM_ALL_INFO = DEBUG_FLAG(23, "patternmAllInfo", false,
Util.gettext("Adds notifications of all pattern-matching optimizations that are performed."));
constant DebugFlag PATTERNM_DCE = DEBUG_FLAG(24, "patternmDeadCodeEliminiation", true,
Util.gettext("Performs dead code elimination in match-expressions."));
constant DebugFlag PATTERNM_MOVE_LAST_EXP = DEBUG_FLAG(25, "patternmMoveLastExp", true,
Util.gettext("Optimization that moves the last assignment(s) into the result of a match-expression. For example: equation c = fn(b); then c; => then fn(b);"));
constant DebugFlag EXPERIMENTAL_REDUCTIONS = DEBUG_FLAG(26, "experimentalReductions", false,
Util.gettext("Turns on custom reduction functions (OpenModelica extension)."));
constant DebugFlag EVAL_PARAM = DEBUG_FLAG(27, "evalparam", false,
Util.gettext("Constant evaluates parameters if set."));
constant DebugFlag TYPES = DEBUG_FLAG(28, "types", false,
Util.gettext("Prints extra failtrace from Types."));
constant DebugFlag SHOW_STATEMENT = DEBUG_FLAG(29, "showStatement", false,
Util.gettext("Shows the statement that is currently being evaluated when evaluating a script."));
constant DebugFlag DUMP = DEBUG_FLAG(30, "dump", false,
Util.gettext("Dumps the absyn representation of a program."));
constant DebugFlag DUMP_GRAPHVIZ = DEBUG_FLAG(31, "graphviz", false,
Util.gettext("Dumps the absyn representation of a program in graphviz format."));
constant DebugFlag EXEC_STAT = DEBUG_FLAG(32, "execstat", false,
Util.gettext("Prints out execution statistics for the compiler."));
constant DebugFlag TRANSFORMS_BEFORE_DUMP = DEBUG_FLAG(33, "transformsbeforedump", false,
Util.gettext("Applies transformations required for code generation before dumping flat code."));
constant DebugFlag DAE_DUMP_GRAPHV = DEBUG_FLAG(34, "daedumpgraphv", false,
Util.gettext("Dumps the DAE in graphviz format."));
constant DebugFlag INTERACTIVE = DEBUG_FLAG(35, "interactive", false,
Util.gettext("Starts omc as a server listening on the socket interface."));
constant DebugFlag INTERACTIVE_CORBA = DEBUG_FLAG(36, "interactiveCorba", false,
Util.gettext("Starts omc as a server listening on the Corba interface."));
constant DebugFlag INTERACTIVE_DUMP = DEBUG_FLAG(37, "interactivedump", false,
Util.gettext("Prints out debug information for the interactive server."));
constant DebugFlag RELIDX = DEBUG_FLAG(38, "relidx", false,
Util.notrans("Prints out debug information about relations, that are used as zero-crossings."));
constant DebugFlag DUMP_REPL = DEBUG_FLAG(39, "dumprepl", false,
Util.gettext("Dump the found replacements for simple equation removal."));
constant DebugFlag DUMP_FP_REPL = DEBUG_FLAG(40, "dumpFPrepl", false,
Util.gettext("Dump the found replacements for final parameters."));
constant DebugFlag DUMP_PARAM_REPL = DEBUG_FLAG(41, "dumpParamrepl", false,
Util.gettext("Dump the found replacements for remove parameters."));
constant DebugFlag DUMP_PP_REPL = DEBUG_FLAG(42, "dumpPPrepl", false,
Util.gettext("Dump the found replacements for protected parameters."));
constant DebugFlag DUMP_EA_REPL = DEBUG_FLAG(43, "dumpEArepl", false,
Util.gettext("Dump the found replacements for evaluate annotations (evaluate=true) parameters."));
constant DebugFlag DEBUG_ALIAS = DEBUG_FLAG(44, "debugAlias", false,
Util.gettext("Dump the found alias variables."));
constant DebugFlag TEARING_DUMP = DEBUG_FLAG(45, "tearingdump", false,
Util.gettext("Dumps tearing information."));
constant DebugFlag JAC_DUMP = DEBUG_FLAG(46, "symjacdump", false,
Util.gettext("Dumps information about symbolic jacobians. Can be used only with postOptModules: generateSymbolicJacobian, generateSymbolicLinearization."));
constant DebugFlag JAC_DUMP2 = DEBUG_FLAG(47, "symjacdumpverbose", false,
Util.gettext("Dumps information in verbose mode about symbolic jacobians. Can be used only with postOptModules: generateSymbolicJacobian, generateSymbolicLinearization."));
constant DebugFlag JAC_DUMP_EQN = DEBUG_FLAG(48, "symjacdumpeqn", false,
Util.gettext("Dump for debug purpose of symbolic jacobians. (deactivated now)."));
constant DebugFlag JAC_WARNINGS = DEBUG_FLAG(49, "symjacwarnings", false,
Util.gettext("Prints warnings regarding symoblic jacbians."));
constant DebugFlag DUMP_SPARSE = DEBUG_FLAG(50, "dumpSparsePattern", false,
Util.gettext("Dumps sparse pattern with coloring used for simulation."));
constant DebugFlag DUMP_SPARSE_VERBOSE = DEBUG_FLAG(51, "dumpSparsePatternVerbose", false,
Util.gettext("Dumps in verbose mode sparse pattern with coloring used for simulation."));
constant DebugFlag BLT_DUMP = DEBUG_FLAG(52, "bltdump", false,
Util.gettext("Dumps information from index reduction."));
constant DebugFlag DUMMY_SELECT = DEBUG_FLAG(53, "dummyselect", false,
Util.gettext("Dumps information from dummy state selection heuristic."));
constant DebugFlag DUMP_DAE_LOW = DEBUG_FLAG(54, "dumpdaelow", false,
Util.gettext("Dumps the equation system at the beginning of the back end."));
constant DebugFlag DUMP_INDX_DAE = DEBUG_FLAG(55, "dumpindxdae", false,
Util.gettext("Dumps the equation system after index reduction and optimization."));
constant DebugFlag OPT_DAE_DUMP = DEBUG_FLAG(56, "optdaedump", false,
Util.gettext("Dumps information from the optimization modules."));
constant DebugFlag EXEC_HASH = DEBUG_FLAG(57, "execHash", false,
Util.gettext("Measures the time it takes to hash all simcode variables before code generation."));
constant DebugFlag PARAM_DLOW_DUMP = DEBUG_FLAG(58, "paramdlowdump", false,
Util.gettext("Enables dumping of the parameters in the order they are calculated."));
constant DebugFlag DUMP_ENCAPSULATEWHENCONDITIONS = DEBUG_FLAG(59, "dumpEncapsulateWhenConditions", false,
Util.gettext("Dumps the results of the preOptModule encapsulateWhenConditions."));
constant DebugFlag ON_RELAXATION = DEBUG_FLAG(60, "onRelaxation", false,
Util.gettext("Perform O(n) relaxation."));
constant DebugFlag SHORT_OUTPUT = DEBUG_FLAG(61, "shortOutput", false,
Util.gettext("Enables short output of the simulate() command. Useful for tools like OMNotebook."));
constant DebugFlag COUNT_OPERATIONS = DEBUG_FLAG(62, "countOperations", false,
Util.gettext("Count operations."));
constant DebugFlag CGRAPH = DEBUG_FLAG(63, "cgraph", false,
Util.gettext("Prints out connection graph information."));
constant DebugFlag UPDMOD = DEBUG_FLAG(64, "updmod", false,
Util.gettext("Prints information about modification updates."));
constant DebugFlag STATIC = DEBUG_FLAG(65, "static", false,
Util.gettext("Enables extra debug output from the static elaboration."));
constant DebugFlag TPL_PERF_TIMES = DEBUG_FLAG(66, "tplPerfTimes", false,
Util.gettext("Enables output of template performance data for rendering text to file."));
constant DebugFlag CHECK_SIMPLIFY = DEBUG_FLAG(67, "checkSimplify", false,
Util.gettext("Enables checks for expression simplification and prints a notification whenever an undesirable transformation has been performed."));
constant DebugFlag SCODE_INST = DEBUG_FLAG(68, "scodeInst", false,
Util.gettext("Enables experimental SCode instantiation phase."));
constant DebugFlag WRITE_TO_BUFFER = DEBUG_FLAG(69, "writeToBuffer", false,
Util.gettext("Enables writing simulation results to buffer."));
constant DebugFlag DUMP_BACKENDDAE_INFO = DEBUG_FLAG(70, "backenddaeinfo", false,
Util.gettext("Enables dumping of backend information about system (Number of equations before backend,...)."));
constant DebugFlag GEN_DEBUG_SYMBOLS = DEBUG_FLAG(71, "gendebugsymbols", false,
Util.gettext("Generate code with debugging symbols."));
constant DebugFlag DUMP_STATESELECTION_INFO = DEBUG_FLAG(72, "stateselection", false,
Util.gettext("Enables dumping of selected states. Works only in combination with backenddaeinfo."));
constant DebugFlag DUMP_DERREPL = DEBUG_FLAG(73, "dumpderrepl", false,
Util.gettext("Enables dumping of selected states. Works only in combination with backenddaeinfo."));
constant DebugFlag DUMP_EQNINORDER = DEBUG_FLAG(74, "dumpeqninorder", false,
Util.gettext("Enables dumping of the equations in the order they are calculated."));
constant DebugFlag SYMBOLIC_INITIALIZATION = DEBUG_FLAG(75, "symbolicInitialization", false,
Util.gettext("Enables using of symbolic matrices for initialization (ipopt only)."));
constant DebugFlag DUMPOPTINIT = DEBUG_FLAG(76, "dumpoptinit", false,
Util.gettext("Enables dumping of the optimization information when optimizing the initial system."));
constant DebugFlag SEMILINEAR = DEBUG_FLAG(77, "semiLinear", false,
Util.gettext("Enables dumping of the optimization information when optimizing calls to semiLinear."));
constant DebugFlag UNCERTAINTIES = DEBUG_FLAG(78, "uncertainties", false,
Util.gettext("Enables dumping of status when calling modelEquationsUC."));
constant DebugFlag DUMP_DAE= DEBUG_FLAG(79, "daeunparser", false,
Util.gettext("Enables dumping of the DAE."));
constant DebugFlag SHOW_START_ORIGIN = DEBUG_FLAG(80, "showStartOrigin", false,
Util.gettext("Enables dumping of the DAE startOrigin attribute of the variables."));
// The flags mixedTearing are only needed as long tearing of mixed system in not default.
constant DebugFlag MIXED_TEARING = DEBUG_FLAG(81, "MixedTearing", true,
Util.gettext("Disables tearing of mixed system."));
constant DebugFlag LINEAR_TEARING = DEBUG_FLAG(82, "doLinearTearing", false,
Util.gettext("Enables tearing of linear systems, but for now they aren't handled efficent in the runtime."));
constant DebugFlag DUMP_INITIAL_SYSTEM = DEBUG_FLAG(83, "dumpinitialsystem", false,
Util.gettext("Dumps the initial equation system."));
constant DebugFlag SCODE_INST_SHORTCUT = DEBUG_FLAG(84, "scodeInstShortcut", false,
Util.gettext("Enables experimental SCode instantiation shortcut phase."));
constant DebugFlag SHOW_SCODE = DEBUG_FLAG(85, "showSCode", false,
Util.gettext("Shows the SCode result of +d=scodeInstShortcut."));
constant DebugFlag DUMP_CONST_REPL = DEBUG_FLAG(86, "dumpConstrepl", false,
Util.gettext("Dump the found replacements for constants."));
constant DebugFlag PEDANTIC = DEBUG_FLAG(87, "pedantic", false,
Util.gettext("Switch into pedantic debug-mode, to get much more feedback."));
constant DebugFlag SHOW_REDECLARE_ANALYSIS = DEBUG_FLAG(88, "showRedeclareAnalysis", false,
Util.gettext("Prints the result of the redeclare analysis (only works with +d=scodeInstShortcut)."));
constant DebugFlag SHOW_PROGRAM_CHANGES = DEBUG_FLAG(89, "showProgramChanges", false,
Util.gettext("Prints the replacements to be done on program to remove redeclares (only works with +d=scodeInstShortcut)."));
constant DebugFlag SHOW_EQUATION_SOURCE = DEBUG_FLAG(90, "showEquationSource", false,
Util.gettext("Display the element source information in the dumped DAE for easier debugging."));
constant DebugFlag NLS_ANALYTIC_JACOBIAN = DEBUG_FLAG(91, "NLSanalyticJacobian", false,
Util.gettext("Generates analytical jacobian for non-linear algebraic loops."));
constant DebugFlag INLINE_SOLVER = DEBUG_FLAG(92, "inlineSolver", false,
Util.gettext("Generates code for inline solver."));
constant DebugFlag GEN_GRAPH = DEBUG_FLAG(93, "genGraph", false,
Util.gettext("Dumps a graph of the program."));
constant DebugFlag HPCOM = DEBUG_FLAG(94, "hpcom", false,
Util.gettext("Enables parallel calculation based on task-graphs."));
constant DebugFlag INITIALIZATION = DEBUG_FLAG(95, "initialization", false,
Util.gettext("Shows additional information from the initialization process."));
constant DebugFlag INLINE_FUNCTIONS = DEBUG_FLAG(96, "inlineFunctions", true,
Util.gettext("Controls if function inlining should be performed."));
constant DebugFlag DUMP_SCC_GRAPHML = DEBUG_FLAG(97, "dumpSCCGraphML", false,
Util.gettext("Dumps graphml files with the strongly connected components."));
constant DebugFlag TEARING_DUMPVERBOSE = DEBUG_FLAG(98, "tearingdumpV", false,
Util.gettext("Dumps verbose tearing information."));
// This is a list of all debug flags, to keep track of which flags are used. A
// flag can not be used unless it's in this list, and the list is checked at
// initialization so that all flags are sorted by index (and thus have unique
// indices).
constant list<DebugFlag> allDebugFlags = {
FAILTRACE,
CEVAL,
CHECK_BACKEND_DAE,
OPENMP,
PTHREADS,
EVENTS,
DUMP_INLINE_SOLVER,
EVAL_FUNC,
GEN,
DYN_LOAD,
GENERATE_CODE_CHEAT,
CGRAPH_GRAPHVIZ_FILE,
CGRAPH_GRAPHVIZ_SHOW,
USEDEP,
CHECK_DAE_CREF_TYPE,
CHECK_ASUB,
INSTANCE,
CACHE,
RML,
TAIL,
LOOKUP,
PATTERNM_SKIP_FILTER_UNUSED_AS_BINDINGS,
PATTERNM_ALL_INFO,
PATTERNM_DCE,
PATTERNM_MOVE_LAST_EXP,
EXPERIMENTAL_REDUCTIONS,
EVAL_PARAM,
TYPES,
SHOW_STATEMENT,
DUMP,
DUMP_GRAPHVIZ,
EXEC_STAT,
TRANSFORMS_BEFORE_DUMP,
DAE_DUMP_GRAPHV,
INTERACTIVE,
INTERACTIVE_CORBA,
INTERACTIVE_DUMP,
RELIDX,
DUMP_REPL,
DUMP_FP_REPL,
DUMP_PARAM_REPL,
DUMP_PP_REPL,
DUMP_EA_REPL,
DEBUG_ALIAS,
TEARING_DUMP,
JAC_DUMP,
JAC_DUMP2,
JAC_DUMP_EQN,
JAC_WARNINGS,
DUMP_SPARSE,
DUMP_SPARSE_VERBOSE,
BLT_DUMP,
DUMMY_SELECT,
DUMP_DAE_LOW,
DUMP_INDX_DAE,
OPT_DAE_DUMP,
EXEC_HASH,
PARAM_DLOW_DUMP,
DUMP_ENCAPSULATEWHENCONDITIONS,
ON_RELAXATION,
SHORT_OUTPUT,
COUNT_OPERATIONS,
CGRAPH,
UPDMOD,
STATIC,
TPL_PERF_TIMES,
CHECK_SIMPLIFY,
SCODE_INST,
WRITE_TO_BUFFER,
DUMP_BACKENDDAE_INFO,
GEN_DEBUG_SYMBOLS,
DUMP_STATESELECTION_INFO,
DUMP_DERREPL,
DUMP_EQNINORDER,
SYMBOLIC_INITIALIZATION,
DUMPOPTINIT,
SEMILINEAR,
UNCERTAINTIES,
DUMP_DAE,
SHOW_START_ORIGIN,
MIXED_TEARING,
LINEAR_TEARING,
DUMP_INITIAL_SYSTEM,
SCODE_INST_SHORTCUT,
SHOW_SCODE,
DUMP_CONST_REPL,
PEDANTIC,
SHOW_REDECLARE_ANALYSIS,
SHOW_PROGRAM_CHANGES,
SHOW_EQUATION_SOURCE,
NLS_ANALYTIC_JACOBIAN,
INLINE_SOLVER,
GEN_GRAPH,
HPCOM,
INITIALIZATION,
INLINE_FUNCTIONS,
DUMP_SCC_GRAPHML,
TEARING_DUMPVERBOSE
};
// CONFIGURATION FLAGS
constant ConfigFlag DEBUG = CONFIG_FLAG(1, "debug",
SOME("d"), EXTERNAL(), STRING_LIST_FLAG({}), NONE(),
Util.gettext("Sets debug flags. Use +help=debug to see available flags."));
constant ConfigFlag HELP = CONFIG_FLAG(2, "help",
SOME("h"), EXTERNAL(), STRING_FLAG(""), NONE(),
Util.gettext("Displays the help text. Use +help=topics for more information."));
constant ConfigFlag RUNNING_TESTSUITE = CONFIG_FLAG(3, "running-testsuite",
NONE(), INTERNAL(), STRING_FLAG(""), NONE(),
Util.gettext("Used when running the testsuite."));
constant ConfigFlag SHOW_VERSION = CONFIG_FLAG(4, "version",
SOME("+v"), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Print the version and exit."));
constant ConfigFlag TARGET = CONFIG_FLAG(5, "target", NONE(), EXTERNAL(),
STRING_FLAG("gcc"), SOME(STRING_OPTION({"gcc", "msvc"})),
Util.gettext("Sets the target compiler to use."));
constant ConfigFlag GRAMMAR = CONFIG_FLAG(6, "grammar", SOME("g"), EXTERNAL(),
ENUM_FLAG(MODELICA, {("Modelica", MODELICA), ("MetaModelica", METAMODELICA), ("ParModelica", PARMODELICA), ("Optimica", OPTIMICA)}),
SOME(STRING_OPTION({"Modelica", "MetaModelica", "ParModelica"})),
Util.gettext("Sets the grammar and semantics to accept."));
constant ConfigFlag ANNOTATION_VERSION = CONFIG_FLAG(7, "annotationVersion",
NONE(), EXTERNAL(), STRING_FLAG("3.x"), SOME(STRING_OPTION({"1.x", "2.x", "3.x"})),
Util.gettext("Sets the annotation version that should be used."));
constant ConfigFlag LANGUAGE_STANDARD = CONFIG_FLAG(8, "std", NONE(), EXTERNAL(),
ENUM_FLAG(1000,
{("1.x", 10), ("2.x", 20), ("3.0", 30), ("3.1", 31), ("3.2", 32), ("3.3", 33)}),
SOME(STRING_OPTION({"1.x", "2.x", "3.1", "3.2", "3.3"})),
Util.gettext("Sets the language standard that should be used."));
constant ConfigFlag SHOW_ERROR_MESSAGES = CONFIG_FLAG(9, "showErrorMessages",
NONE(), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Show error messages immediately when they happen."));
constant ConfigFlag SHOW_ANNOTATIONS = CONFIG_FLAG(10, "showAnnotations",
NONE(), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Show annotations in the flattened code."));
constant ConfigFlag NO_SIMPLIFY = CONFIG_FLAG(11, "noSimplify",
NONE(), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Do not simplify expressions if set."));
protected constant Util.TranslatableContent removeSimpleEquationDesc = Util.gettext("Performs alias elimination and removes constant variables from the DAE, replacing all occurrences of the old variable reference with the new value (constants) or variable reference (alias elimination).");
public
constant ConfigFlag PRE_OPT_MODULES = CONFIG_FLAG(12, "preOptModules",
NONE(), EXTERNAL(), STRING_LIST_FLAG({
"evaluateReplaceFinalEvaluateParameters",
"simplifyIfEquations",
"removeEqualFunctionCalls",
"partitionIndependentBlocks",
"expandDerOperator",
"findStateOrder",
"replaceEdgeChange",
"inlineArrayEqn",
"removeSimpleEquations"
// "addInitialStmtsToAlgorithms"
}),
SOME(STRING_DESC_OPTION({
("removeSimpleEquations", removeSimpleEquationDesc),
("removeAllSimpleEquations", removeSimpleEquationDesc),
("inlineArrayEqn", Util.notrans("DESCRIBE ME")),
("evaluateFinalParameters", Util.gettext("Structural parameters and parameters declared as final are evalutated and replaced with their value in other vars. They may no longer be changed in the init file.")),
("evaluateEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateFinalEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceFinalParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceFinalEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("removeEqualFunctionCalls", Util.notrans("DESCRIBE ME")),
("removeProtectedParameters", Util.gettext("Replace all parameters with protected=true in the system.")),
("removeUnusedParameter", Util.gettext("Strips all parameter not present in the equations from the system.")),
("removeUnusedVariables", Util.gettext("Strips all variables not present in the equations from the system.")),
("partitionIndependentBlocks", Util.gettext("Partitions the equation system into independent equation systems (which can then be simulated in parallel or used to speed up subsequent optimizations).")),
("collapseIndependentBlocks", Util.gettext("Collapses all equation systems back into one big system again (undo partitionIndependentBlocks).")),
("expandDerOperator", Util.notrans("DESCRIBE ME")),
("simplifyIfEquations", Util.gettext("Tries to simplify if equations by use of information from evaluated parameters.")),
("replaceEdgeChange", Util.gettext("Replace edge(b) = b and not pre(b) and change(b) = v <> pre(v).")),
("residualForm", Util.gettext("Transforms simple equations x=y to zero-sum equations 0=y-x.")),
("addInitialStmtsToAlgorithms", Util.gettext("Expands all algorithms with initial statements for outputs."))
})),
Util.gettext("Sets the pre optimization modules to use in the back end. See +help=optmodules for more info."));
constant ConfigFlag CHEAPMATCHING_ALGORITHM = CONFIG_FLAG(13, "cheapmatchingAlgorithm",
NONE(), EXTERNAL(), INT_FLAG(3),
SOME(STRING_DESC_OPTION({
("0", Util.gettext("No cheap matching.")),
("1", Util.gettext("Cheap matching, traverses all equations and match the first free variable.")),
("3", Util.gettext("Random Karp-Sipser: R. M. Karp and M. Sipser. Maximum matching in sparse random graphs."))})),
Util.gettext("Sets the cheap matching algorithm to use. A cheap matching algorithm gives a jump start matching by heuristics."));
constant ConfigFlag MATCHING_ALGORITHM = CONFIG_FLAG(14, "matchingAlgorithm",
NONE(), EXTERNAL(), STRING_FLAG("PFPlusExt"),
SOME(STRING_DESC_OPTION({
("BFSB", Util.gettext("Breadth First Search based algorithm.")),
("DFSB", Util.gettext("Depth First Search based algorithm.")),
("MC21A", Util.gettext("Depth First Search based algorithm with look ahead feature.")),
("PF", Util.gettext("Depth First Search based algorithm with look ahead feature.")),
("PFPlus", Util.gettext("Depth First Search based algorithm with look ahead feature and fair row traversal.")),
("HK", Util.gettext("Combined BFS and DFS algorithm.")),
("HKDW", Util.gettext("Combined BFS and DFS algorithm.")),
("ABMP", Util.gettext("Combined BFS and DFS algorithm.")),
("PR", Util.gettext("Matching algorithm using push relabel mechanism.")),
("DFSBExt", Util.gettext("Depth First Search based Algorithm external c implementation.")),
("BFSBExt", Util.gettext("Breadth First Search based Algorithm external c implementation.")),
("MC21AExt", Util.gettext("Depth First Search based Algorithm with look ahead feature external c implementation.")),
("PFExt", Util.gettext("Depth First Search based Algorithm with look ahead feature external c implementation.")),
("PFPlusExt", Util.gettext("Depth First Search based Algorithm with look ahead feature and fair row traversal external c implementation.")),
("HKExt", Util.gettext("Combined BFS and DFS algorithm external c implementation.")),
("HKDWExt", Util.gettext("Combined BFS and DFS algorithm external c implementation.")),
("ABMPExt", Util.gettext("Combined BFS and DFS algorithm external c implementation.")),
("PRExt", Util.gettext("Matching algorithm using push relabel mechanism external c implementation."))})),
Util.gettext("Sets the matching algorithm to use. See +help=optmodules for more info."));
constant ConfigFlag INDEX_REDUCTION_METHOD = CONFIG_FLAG(15, "indexReductionMethod",
NONE(), EXTERNAL(), STRING_FLAG("dynamicStateSelection"),
SOME(STRING_DESC_OPTION({
("uode", Util.gettext("Use the underlying ODE without the constraints.")),
("dynamicStateSelection", Util.gettext("Simple index reduction method, select (dynamic) dummy states based on analysis of the system."))})),
Util.gettext("Sets the index reduction method to use. See +help=optmodules for more info."));
constant ConfigFlag POST_OPT_MODULES = CONFIG_FLAG(16, "postOptModules",
NONE(), EXTERNAL(), STRING_LIST_FLAG({
"relaxSystem",
"inlineArrayEqn",
"constantLinearSystem",
"simplifysemiLinear",
"removeSimpleEquations",
"encapsulateWhenConditions", // must called after remove simple equations
"tearingSystem", // must be the last one, otherwise the torn systems are lost when throw away the matching information
"countOperations",
"removeUnusedFunctions",
"inputDerivativesUsed",
"detectJacobianSparsePattern",
// "generateSymbolicJacobian",
"removeConstants"
// "partitionIndependentBlocks",
// "addInitialStmtsToAlgorithms"
}),
SOME(STRING_DESC_OPTION({
("encapsulateWhenConditions", Util.gettext("Replace each when-condition with an discrete variable.")),
("lateInlineFunction", Util.gettext("Perform function inlining for function with annotation LateInline=true.")),
("removeSimpleEquationsFast", removeSimpleEquationDesc),
("removeSimpleEquations", removeSimpleEquationDesc),
("evaluateFinalParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateFinalEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceFinalParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("evaluateReplaceFinalEvaluateParameters", Util.gettext("Structural parameters and parameters declared as final are removed and replaced with their value. They may no longer be changed in the init file.")),
("removeEqualFunctionCalls", Util.notrans("DESCRIBE ME")),
("inlineArrayEqn", Util.notrans("DESCRIBE ME")),
("removeUnusedParameter", Util.gettext("Strips all parameter not present in the equations from the system.")),
("constantLinearSystem", Util.gettext("Evaluates constant linear systems (a*x+b*y=c; d*x+e*y=f; a,b,c,d,e,f are constants) at compile-time.")),
("tearingSystem",Util.notrans("For method selection use flag tearingMethod.")),
("relaxSystem",Util.notrans("DESCRIBE ME")),
("countOperations", Util.gettext("Count the mathematic operations of the system.")),
("dumpComponentsGraphStr", Util.notrans("DESCRIBE ME")),
("generateSymbolicJacobian", Util.gettext("Generates symbolic jacobian.")),
("generateSymbolicLinearization", Util.gettext("Generates symbolic Linearization Matrixes A,B,C,D for Linear Model:\n\t\t\\dot x = Ax + Bu\n\t\ty = Cx +Du")),
("collapseIndependentBlocks", Util.gettext("Collapses all equation systems back into one big system again (undo partitionIndependentBlocks).")),
("removeUnusedFunctions", Util.gettext("Removed all unused functions from functionTree.")),
("simplifyTimeIndepFuncCalls", Util.gettext("Simplifies time independent built in function calls like pre(param) -> param, der(param) -> 0.0, change(param) -> false, edge(param) -> false.")),
("inputDerivativesUsed", Util.gettext("Checks if derivatives of inputs are need to calculate the model.")),
("simplifysemiLinear", Util.gettext("Simplifies calls to semiLinear.")),
("removeConstants", Util.gettext("Remove all constants in the system.")),
("optimizeInitialSystem", Util.gettext("Simplifies time initial system.")),
("detectJacobianSparsePattern", Util.gettext("Detects the sparse pattern for Jacobian A.")),
("partitionIndependentBlocks", Util.gettext("Partitions the equation system into independent equation systems (which can then be simulated in parallel or used to speed up subsequent optimizations).")),
("addInitialStmtsToAlgorithms", Util.gettext("Expands all algorithms with initial statements for outputs."))
})),
Util.gettext("Sets the post optimization modules to use in the back end. See +help=optmodules for more info."));
constant ConfigFlag SIMCODE_TARGET = CONFIG_FLAG(17, "simCodeTarget",
NONE(), EXTERNAL(), STRING_FLAG("C"),
SOME(STRING_OPTION({"C", "CSharp", "Cpp", "Adevs", "QSS", "Dump", "XML", "Java","ResidualCMP", "None"})),
Util.gettext("Sets the target language for the code generation."));
constant ConfigFlag ORDER_CONNECTIONS = CONFIG_FLAG(18, "orderConnections",
NONE(), EXTERNAL(), BOOL_FLAG(true), NONE(),
Util.gettext("Orders connect equations alphabetically if set."));
constant ConfigFlag TYPE_INFO = CONFIG_FLAG(19, "typeinfo",
SOME("t"), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Prints out extra type information if set."));
constant ConfigFlag KEEP_ARRAYS = CONFIG_FLAG(20, "keepArrays",
SOME("a"), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Sets whether to split arrays or not."));
constant ConfigFlag MODELICA_OUTPUT = CONFIG_FLAG(21, "modelicaOutput",
SOME("m"), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Enables valid modelica output for flat modelica."));
constant ConfigFlag SILENT = CONFIG_FLAG(22, "silent",
SOME("q"), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Turns on silent mode."));
constant ConfigFlag CORBA_SESSION = CONFIG_FLAG(23, "corbaSessionName",
SOME("c"), EXTERNAL(), STRING_FLAG(""), NONE(),
Util.gettext("Sets the name of the corba session if +d=interactiveCorba is used."));
constant ConfigFlag NUM_PROC = CONFIG_FLAG(24, "numProcs",
SOME("n"), EXTERNAL(), INT_FLAG(0), NONE(),
Util.gettext("Sets the number of processors to use."));
constant ConfigFlag LATENCY = CONFIG_FLAG(25, "latency",
SOME("l"), EXTERNAL(), INT_FLAG(0), NONE(),
Util.gettext("Sets the latency for parallel execution."));
constant ConfigFlag BANDWIDTH = CONFIG_FLAG(26, "bandwidth",
SOME("b"), EXTERNAL(), INT_FLAG(0), NONE(),
Util.gettext("Sets the bandwidth for parallel execution."));
constant ConfigFlag INST_CLASS = CONFIG_FLAG(27, "instClass",
SOME("i"), EXTERNAL(), STRING_FLAG(""), NONE(),
Util.gettext("Instantiate the class given by the fully qualified path."));
constant ConfigFlag VECTORIZATION_LIMIT = CONFIG_FLAG(28, "vectorizationLimit",
SOME("v"), EXTERNAL(), INT_FLAG(0), NONE(),
Util.gettext("Sets the vectorization limit, arrays and matrices larger than this will not be vectorized."));
constant ConfigFlag SIMULATION_CG = CONFIG_FLAG(29, "simulationCg",
SOME("s"), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Turns on simulation code generation."));
constant ConfigFlag EVAL_PARAMS_IN_ANNOTATIONS = CONFIG_FLAG(30,
"evalAnnotationParams", NONE(), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Sets whether to evaluate parameters in annotations or not."));
constant ConfigFlag CHECK_MODEL = CONFIG_FLAG(31,
"checkModel", NONE(), INTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Set when checkModel is used to turn on specific features for checking."));
constant ConfigFlag CEVAL_EQUATION = CONFIG_FLAG(32,
"cevalEquation", NONE(), INTERNAL(), BOOL_FLAG(true), NONE(),
Util.notrans(""));
constant ConfigFlag UNIT_CHECKING = CONFIG_FLAG(33,
"unitChecking", NONE(), INTERNAL(), BOOL_FLAG(false), NONE(),
Util.notrans(""));
constant ConfigFlag TRANSLATE_DAE_STRING = CONFIG_FLAG(34,
"translateDAEString", NONE(), INTERNAL(), BOOL_FLAG(true), NONE(),
Util.notrans(""));
constant ConfigFlag ENV_CACHE = CONFIG_FLAG(35,
"envCache", NONE(), INTERNAL(), BOOL_FLAG(false), NONE(),
Util.notrans(""));
constant ConfigFlag GENERATE_LABELED_SIMCODE = CONFIG_FLAG(36,
"generateLabeledSimCode", NONE(), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Turns on labeled SimCode generation for reduction algorithms."));
constant ConfigFlag REDUCE_TERMS = CONFIG_FLAG(37,
"reduceTerms", NONE(), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Turns on reducing terms for reduction algorithms."));
constant ConfigFlag REDUCTION_METHOD = CONFIG_FLAG(38, "reductionMethod",
NONE(), EXTERNAL(), STRING_FLAG("deletion"),
SOME(STRING_OPTION({"deletion","substitution","linearization"})),
Util.gettext("Sets the reduction method to be used."));
constant ConfigFlag PLOT_SILENT = CONFIG_FLAG(39, "plotSilent",
NONE(), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Defines whether plot commands should open OMPlot or show the list of arguments that would have been sent to OMPlot."));
constant ConfigFlag LOCALE_FLAG = CONFIG_FLAG(40, "locale",
NONE(), EXTERNAL(), STRING_FLAG(""), NONE(),
Util.gettext("Override the locale from the environment."));
constant ConfigFlag DEFAULT_OPENCL_DEVICE = CONFIG_FLAG(41, "defaultOCLDevice",
SOME("o"), EXTERNAL(), INT_FLAG(0), NONE(),
Util.gettext("Sets the default OpenCL device to be used for parallel execution."));
constant ConfigFlag MAXTRAVERSALS = CONFIG_FLAG(42, "maxTraversals",
NONE(), EXTERNAL(), INT_FLAG(2),NONE(),
Util.gettext("Maximal traversals to find simple equations in the acausal system."));
constant ConfigFlag DUMP_TARGET = CONFIG_FLAG(43, "dumpTarget",
NONE(), EXTERNAL(), STRING_FLAG(""), NONE(),
Util.gettext("Redirect the dump to file. If the file ends with .html HTML code is generated."));
constant ConfigFlag DELAY_BREAK_LOOP = CONFIG_FLAG(44, "delayBreakLoop",
NONE(), EXTERNAL(), BOOL_FLAG(true),NONE(),
Util.gettext("Enables (very) experimental code to break algebraic loops using the delay() operator. Probably messes with initialization."));
constant ConfigFlag TEARING_METHOD = CONFIG_FLAG(45, "tearingMethod",
NONE(), EXTERNAL(), STRING_FLAG("omcTearing"),
SOME(STRING_DESC_OPTION({
("noTearing", Util.gettext("Skip tearing.")),
("omcTearing", Util.gettext("Tearing method developed by TU Dresden: Frenkel, Schubert.")),
("cellier", Util.gettext("Cellier tearing.")),
("carpanzano2", Util.gettext("Carpanzano2 tearing.")),
("olleroAmselem", Util.gettext("Ollero-Amselem tearing.")),
("steward", Util.gettext("Steward tearing."))})),
Util.gettext("Sets the tearing method to use. Select no tearing or choose tearing method."));
constant ConfigFlag SCALARIZE_MINMAX = CONFIG_FLAG(46, "scalarizeMinMax",
NONE(), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Scalarizes the builtin min/max reduction operators if true."));
constant ConfigFlag RUNNING_WSM_TESTSUITE = CONFIG_FLAG(47, "wsm-testsuite",
NONE(), INTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Used when running the WSM testsuite."));
constant ConfigFlag CORRECT_CREF_TYPES = CONFIG_FLAG(48, "correctCrefTypes",
NONE(), INTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Set to true to set correct types in component references. Doesn't work for OpenModelica backend."));
constant ConfigFlag SCALARIZE_BINDINGS = CONFIG_FLAG(49, "scalarizeBindings",
NONE(), EXTERNAL(), BOOL_FLAG(false), NONE(),
Util.gettext("Always scalarizes bindings if set."));
constant ConfigFlag CORBA_OBJECT_REFERENCE_FILE_PATH = CONFIG_FLAG(50, "corbaObjectReferenceFilePath",
NONE(), EXTERNAL(), STRING_FLAG(""), NONE(),
Util.gettext("Sets the path for corba object reference file if +d=interactiveCorba is used."));
// This is a list of all configuration flags. A flag can not be used unless it's
// in this list, and the list is checked at initialization so that all flags are
// sorted by index (and thus have unique indices).
constant list<ConfigFlag> allConfigFlags = {
DEBUG,
HELP,
RUNNING_TESTSUITE,
SHOW_VERSION,
TARGET,
GRAMMAR,
ANNOTATION_VERSION,
LANGUAGE_STANDARD,
SHOW_ERROR_MESSAGES,
SHOW_ANNOTATIONS,
NO_SIMPLIFY,
PRE_OPT_MODULES,
CHEAPMATCHING_ALGORITHM,
MATCHING_ALGORITHM,
INDEX_REDUCTION_METHOD,
POST_OPT_MODULES,
SIMCODE_TARGET,
ORDER_CONNECTIONS,
TYPE_INFO,
KEEP_ARRAYS,
MODELICA_OUTPUT,
SILENT,
CORBA_SESSION,
NUM_PROC,
LATENCY,
BANDWIDTH,
INST_CLASS,
VECTORIZATION_LIMIT,
SIMULATION_CG,
EVAL_PARAMS_IN_ANNOTATIONS,
CHECK_MODEL,
CEVAL_EQUATION,
UNIT_CHECKING,
TRANSLATE_DAE_STRING,
ENV_CACHE,
GENERATE_LABELED_SIMCODE,
REDUCE_TERMS,
REDUCTION_METHOD,
PLOT_SILENT,
LOCALE_FLAG,
DEFAULT_OPENCL_DEVICE,
MAXTRAVERSALS,
DUMP_TARGET,
DELAY_BREAK_LOOP,
TEARING_METHOD,
SCALARIZE_MINMAX,
RUNNING_WSM_TESTSUITE,
CORRECT_CREF_TYPES,
SCALARIZE_BINDINGS,
CORBA_OBJECT_REFERENCE_FILE_PATH
};
public function new
"Create a new flags structure and read the given arguments."
input list<String> inArgs;
output list<String> outArgs;
algorithm
_ := loadFlags();
outArgs := readArgs(inArgs);
end new;
protected function saveFlags
"Saves the flags with setGlobalRoot."
input Flags inFlags;
algorithm
setGlobalRoot(Global.flagsIndex, inFlags);
end saveFlags;
protected function createConfigFlags
output array<FlagData> outConfigFlags;
protected
Integer count;
algorithm
count := listLength(allConfigFlags);
outConfigFlags := arrayCreate(count, EMPTY_FLAG());
_ := List.fold1(allConfigFlags, setDefaultConfig, outConfigFlags, 1);
end createConfigFlags;
protected function createDebugFlags
output array<Boolean> outDebugFlags;
algorithm
outDebugFlags := listArray(List.map(allDebugFlags, defaultDebugFlag));
end createDebugFlags;
protected function loadFlags
"Loads the flags with getGlobalRoot. Creates a new flags structure if it
hasn't been created yet."
output Flags outFlags;
algorithm
outFlags := matchcontinue()
local
array<Boolean> debug_flags;
array<FlagData> config_flags;
Flags flags;
Integer debug_count, config_count;
case ()
equation
outFlags = getGlobalRoot(Global.flagsIndex);
then
outFlags;
else
equation
_ = List.fold(allDebugFlags, checkDebugFlag, 1);
debug_flags = createDebugFlags();
config_flags = createConfigFlags();
flags = FLAGS(debug_flags, config_flags);
saveFlags(flags);
then
flags;
end matchcontinue;
end loadFlags;
public function resetDebugFlags
"Resets all debug flags to their default values."
protected
array<Boolean> debug_flags;
array<FlagData> config_flags;
algorithm
FLAGS(_, config_flags) := loadFlags();
debug_flags := createDebugFlags();
saveFlags(FLAGS(debug_flags, config_flags));
end resetDebugFlags;
public function resetConfigFlags
"Resets all configuration flags to their default values."
protected
array<Boolean> debug_flags;
array<FlagData> config_flags;
algorithm
FLAGS(debug_flags, _) := loadFlags();
config_flags := createConfigFlags();
saveFlags(FLAGS(debug_flags, config_flags));
end resetConfigFlags;
protected function checkDebugFlag
"Used when creating a new flags structure (in loadFlags) to check that a debug
flag has a valid index."
input DebugFlag inDebugFlag;
input Integer inFlagIndex;
output Integer outNextFlagIndex;
algorithm
outNextFlagIndex := matchcontinue(inDebugFlag, inFlagIndex)
local
Integer index;
String name, index_str, err_str;
case (DEBUG_FLAG(index = index), _)
equation
true = intEq(index, inFlagIndex);
then
inFlagIndex + 1;
case (DEBUG_FLAG(index = index, name = name), _)
equation
index_str = intString(index);
err_str = "Invalid flag " +& name +& " with index " +& index_str +&
" in Flags.allDebugFlags. Make sure that all flags are present and ordered correctly.";
Error.addMessage(Error.INTERNAL_ERROR, {err_str});
then
fail();
end matchcontinue;
end checkDebugFlag;
protected function defaultDebugFlag
"Used when creating a new flags structure (in loadFlags) to get the default values of debug flags"
input DebugFlag inDebugFlag;
output Boolean default;
algorithm
DEBUG_FLAG(default = default) := inDebugFlag;
end defaultDebugFlag;
protected function setDefaultConfig
"Used when creating a new flags structure (in loadFlags) to set the default
value of a configuration flag, and also to check that it has a valid index."
input ConfigFlag inConfigFlag;
input array<FlagData> inConfigData;
input Integer inFlagIndex;
output Integer outFlagIndex;
algorithm
outFlagIndex := matchcontinue(inConfigFlag, inConfigData, inFlagIndex)
local
Integer index;
FlagData default_value;
String name, index_str, err_str;
case (CONFIG_FLAG(index = index, defaultValue = default_value), _, _)
equation
true = intEq(index, inFlagIndex);
_ = arrayUpdate(inConfigData, index, default_value);
then
inFlagIndex + 1;
case (CONFIG_FLAG(index = index, name = name), _, _)
equation
index_str = intString(index);
err_str = "Invalid flag " +& name +& " with index " +& index_str +&
" in Flags.allConfigFlags. Make sure that all flags are present and ordered correctly.";
Error.addMessage(Error.INTERNAL_ERROR, {err_str});
then
fail();
end matchcontinue;
end setDefaultConfig;