SemanticAdaptationCanonicalGenerator.xtend 55 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530
  1. /*
  2. * generated by Xtext 2.10.0
  3. */
  4. package be.uantwerpen.ansymo.semanticadaptation.generator
  5. import be.uantwerpen.ansymo.semanticadaptation.generator.graph.DirectedGraph
  6. import be.uantwerpen.ansymo.semanticadaptation.generator.graph.FMUGraph
  7. import be.uantwerpen.ansymo.semanticadaptation.generator.graph.TopologicalSort
  8. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.Adaptation
  9. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.Assignment
  10. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.AtomicUnity
  11. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.BoolLiteral
  12. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.BuiltinFunction
  13. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.Close
  14. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.CompositeOutputFunction
  15. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.Connection
  16. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.CustomControlRule
  17. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.DataRule
  18. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.Declaration
  19. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.DeclaredParameter
  20. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.DivideUnity
  21. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.DoStep
  22. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.DoStepFun
  23. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.Expression
  24. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.FMU
  25. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.InnerFMU
  26. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.InnerFMUDeclaration
  27. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.InnerFMUDeclarationFull
  28. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.IntLiteral
  29. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.IsSet
  30. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.MooreOrMealy
  31. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.MultiplyUnity
  32. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.Port
  33. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.ReactiveOrDelayed
  34. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.RealLiteral
  35. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.SemanticAdaptation
  36. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.SemanticAdaptationFactory
  37. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.SingleParamDeclaration
  38. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.SingleVarDeclaration
  39. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.Statement
  40. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.StringLiteral
  41. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.Unity
  42. import be.uantwerpen.ansymo.semanticadaptation.semanticAdaptation.Variable
  43. import java.io.ByteArrayOutputStream
  44. import java.util.HashMap
  45. import java.util.LinkedList
  46. import java.util.List
  47. import java.util.Map
  48. import org.eclipse.emf.common.util.EList
  49. import org.eclipse.emf.ecore.EObject
  50. import org.eclipse.emf.ecore.resource.Resource
  51. import org.eclipse.xtext.EcoreUtil2
  52. import org.eclipse.xtext.generator.AbstractGenerator
  53. import org.eclipse.xtext.generator.IFileSystemAccess2
  54. import org.eclipse.xtext.generator.IGeneratorContext
  55. /**
  56. * Generates code from your model files on save.
  57. *
  58. * See https://www.eclipse.org/Xtext/documentation/303_runtime_concepts.html#code-generation
  59. */
  60. class SemanticAdaptationCanonicalGenerator extends AbstractGenerator {
  61. String CANONICAL_SUFIX = "_canonical"
  62. override void doGenerate(Resource resource, IFileSystemAccess2 fsa, IGeneratorContext context) {
  63. Log.push("Generating canonical semantic adaptation for file " + resource.URI + "...")
  64. Log.println("Resource URI information:")
  65. Log.println("\t resource.URI.lastSegment = " + resource.URI.lastSegment())
  66. Log.println("\t resource.URI.trimFileExtension = " + resource.URI.trimFileExtension())
  67. // Create in memory representation of canonical SA file
  68. var adaptations = resource.allContents.toIterable.filter(SemanticAdaptation).last.elements.filter(Adaptation);
  69. check(adaptations.size == 1, "Only one semantic adaptation is supported per .sa file")
  70. var adaptation = adaptations.head
  71. Log.println(prettyprint_model(adaptation, "File Read"))
  72. // Create file name for the canonical sa file
  73. var fileNameWithoutExt = resource.URI.trimFileExtension().lastSegment()
  74. Log.println("Checking if file is already a canonical version...")
  75. if (fileNameWithoutExt.indexOf(CANONICAL_SUFIX) == -1){
  76. Log.println("It is not.")
  77. var canonicalFileName = fileNameWithoutExt + CANONICAL_SUFIX + ".sa"
  78. Log.println("canonicalFileName = " + canonicalFileName)
  79. canonicalize(adaptation)
  80. Log.println(prettyprint_model(adaptation, "Generated File"))
  81. fsa.generateFile(canonicalFileName, adaptation.serialize_model)
  82. Log.println("File " + canonicalFileName + " written.")
  83. } else {
  84. Log.println("It is already a canonical version.")
  85. Log.println("Nothing to do.")
  86. }
  87. Log.pop("Generating canonical semantic adaptation for file " + resource.URI + "... DONE.")
  88. }
  89. def prettyprint_model(Adaptation sa, String title){
  90. var outputByteArray = new ByteArrayOutputStream()
  91. sa.eResource.save(outputByteArray,null)
  92. return "______________________________" + title + "______________________________\n" +
  93. sa.serialize_model +
  94. "\n__________________________________________________________________________"
  95. }
  96. def serialize_model(Adaptation sa){
  97. var outputByteArray = new ByteArrayOutputStream()
  98. sa.eResource.save(outputByteArray,null)
  99. return outputByteArray.toString()
  100. }
  101. def inferUnits(Adaptation sa){
  102. // Unit inference
  103. var unitlessElements = genericDeclarationInferenceAlgorithm(sa ,
  104. [// getField
  105. element | {
  106. var DUMMY_UNIT = "Dips"
  107. if (element instanceof SingleParamDeclaration) {
  108. return DUMMY_UNIT
  109. } else if (element instanceof Port){
  110. return element.unity
  111. } else if (element instanceof SingleVarDeclaration){
  112. return DUMMY_UNIT
  113. } else {
  114. throw new Exception("Unexpected element type: " + element)
  115. }
  116. }
  117. ],
  118. [// setField
  119. element, value | {
  120. if (element instanceof SingleParamDeclaration) {
  121. } else if (element instanceof Port){
  122. element.unity = EcoreUtil2.copy(value as Unity)
  123. } else if (element instanceof SingleVarDeclaration){
  124. } else {
  125. throw new Exception("Unexpected element type: " + element)
  126. }
  127. }
  128. ],
  129. [// inferField
  130. element | {
  131. var DUMMY_UNIT = "Dips"
  132. if (element instanceof SingleParamDeclaration) {
  133. return DUMMY_UNIT
  134. } else if (element instanceof Port){
  135. return getPortUnit(element)
  136. } else if (element instanceof SingleVarDeclaration){
  137. return DUMMY_UNIT
  138. } else {
  139. throw new Exception("Unexpected element type: " + element)
  140. }
  141. }
  142. ]
  143. )
  144. if (unitlessElements > 0){
  145. Log.println("Could not infer all element units. There are " + unitlessElements + " unitless elements.")
  146. }
  147. }
  148. def inferTypes(Adaptation sa){
  149. // Type inference
  150. var untypedElements = genericDeclarationInferenceAlgorithm(sa ,
  151. [// getField
  152. element | {
  153. if (element instanceof SingleParamDeclaration) {
  154. return element.type
  155. } else if (element instanceof Port){
  156. return element.type
  157. } else if (element instanceof SingleVarDeclaration){
  158. return element.type
  159. } else {
  160. throw new Exception("Unexpected element type: " + element)
  161. }
  162. }
  163. ],
  164. [// setField
  165. element, value | {
  166. if (element instanceof SingleParamDeclaration) {
  167. element.type = value as String
  168. } else if (element instanceof Port){
  169. element.type = value as String
  170. } else if (element instanceof SingleVarDeclaration){
  171. element.type = value as String
  172. } else {
  173. throw new Exception("Unexpected element type: " + element)
  174. }
  175. }
  176. ],
  177. [// inferField
  178. element | {
  179. if (element instanceof SingleParamDeclaration) {
  180. return extractTypeFromExpression(element.expr, element.name)
  181. } else if (element instanceof Port){
  182. return getPortType(element)
  183. } else if (element instanceof SingleVarDeclaration){
  184. return extractTypeFromExpression(element.expr, element.name)
  185. } else {
  186. throw new Exception("Unexpected element type: " + element)
  187. }
  188. }
  189. ]
  190. )
  191. if (untypedElements > 0){
  192. Log.println("Error: Could not infer all types. There are " + untypedElements + " untyped elements.")
  193. Log.println(prettyprint_model(sa, "Current File"))
  194. throw new Exception("Could not infer all types. There are " + untypedElements + " untyped elements.")
  195. }
  196. }
  197. def canonicalize(Adaptation sa){
  198. Log.push("Canonicalize")
  199. inferUnits(sa)
  200. inferTypes(sa)
  201. addInPorts(sa)
  202. val inputPort2parameterDeclaration = addInParams(sa)
  203. val externalInputPort2InVarDeclaration = addInVars(sa, inputPort2parameterDeclaration)
  204. addInRules_External2Stored_Assignments(sa, externalInputPort2InVarDeclaration)
  205. val internalPort2ExternalPortBindings = findAllExternalPort2InputPort_Bindings(sa)
  206. addInRules_External2Internal_Assignments(sa, internalPort2ExternalPortBindings)
  207. removeBindings(internalPort2ExternalPortBindings, sa)
  208. if (sa.outports.size==0){
  209. addOutPorts(sa)
  210. }
  211. val outputPort2parameterDeclaration = addOutParams(sa)
  212. val internalOutputPort2OutVarDeclaration = addOutVars(sa, outputPort2parameterDeclaration)
  213. val internalOutputPort2ExternalPortBindings = findAllInternalPort2ExternalOutputPort_Bindings(sa)
  214. //val internalOutputPort2OutVarDeclaration = transitiveStep(internalOutputPort2ExternalPortBindings, internalOutputPort2OutVarDeclaration)
  215. addOutRules_Internal2Stored_Assignments(sa, internalOutputPort2OutVarDeclaration)
  216. addOutRules_Internal2External_Assignments(sa, internalOutputPort2ExternalPortBindings)
  217. removeBindings(internalOutputPort2ExternalPortBindings, sa)
  218. if (sa.control === null){
  219. sa.control = SemanticAdaptationFactory.eINSTANCE.createControlRuleBlock()
  220. sa.control.rule = SemanticAdaptationFactory.eINSTANCE.createCustomControlRule()
  221. createCoSimStepInstructions(sa)
  222. }
  223. createInternalBindingAssignments(sa)
  224. Log.push("Replace port refs in input rules")
  225. for (rule : sa.in.rules){
  226. check(rule.outputfunction instanceof CompositeOutputFunction, "Only CompositeOutputFunction are supported in DataRules.")
  227. replacePortRefsByVarDecl((rule.outputfunction as CompositeOutputFunction).statements, externalInputPort2InVarDeclaration)
  228. }
  229. Log.pop("Replace port refs in input rules")
  230. Log.push("Replace port refs in control rule")
  231. if (sa.control.rule instanceof CustomControlRule){
  232. replacePortRefsByVarDecl((sa.control.rule as CustomControlRule).controlRulestatements,internalOutputPort2OutVarDeclaration)
  233. }
  234. Log.pop("Replace port refs in control rule")
  235. Log.push("Replace port refs in output rule")
  236. for (rule : sa.out.rules){
  237. check(rule.outputfunction instanceof CompositeOutputFunction, "Only CompositeOutputFunction are supported in DataRules.")
  238. replacePortRefsByVarDecl((rule.outputfunction as CompositeOutputFunction).statements, internalOutputPort2OutVarDeclaration)
  239. }
  240. Log.pop("Replace port refs in output rule")
  241. Log.pop("Canonicalize")
  242. }
  243. def replacePortRefsByVarDecl(EList<Statement> statements, HashMap<Port, SingleVarDeclaration> port2VarDecl) {
  244. Log.push("replacePortRefsByVarDecl")
  245. for(statement : statements){
  246. val vars = statement.eAllContents.filter[v | v instanceof Variable]
  247. var Variable v
  248. while (vars.hasNext) {
  249. v = vars.next as Variable
  250. if (port2VarDecl.containsKey(v.ref)){
  251. val port = v.ref as Port
  252. v.owner = null
  253. val varDecl = port2VarDecl.get(v.ref)
  254. v.ref = varDecl
  255. Log.println("Replaced ref to " + port.qualifiedName + " by " + varDecl.name)
  256. } else {
  257. Log.println("Var ref not substituted: " + v.ref)
  258. }
  259. }
  260. }
  261. Log.pop("replacePortRefsByVarDecl")
  262. }
  263. def createInternalBindingAssignments(Adaptation sa) {
  264. Log.push("createInternalBindingAssignments")
  265. val scenario = (sa.inner as InnerFMUDeclarationFull)
  266. for (connection : scenario.connection){
  267. val trgFMU = connection.tgt.port.eContainer as InnerFMU
  268. val ctrlRule = sa.control.rule as CustomControlRule
  269. val doStepIndex = findDoStepStatementIndex(ctrlRule, trgFMU)
  270. if (! existsAssignmentToPort_BeforeIndex(connection.tgt.port, doStepIndex, ctrlRule)){
  271. Log.println("Creating assignment to port " + connection.tgt.port.qualifiedName + " at position " + doStepIndex)
  272. addPortAssignment(ctrlRule.controlRulestatements, connection.tgt.port, connection.src.port, doStepIndex, true)
  273. } else {
  274. Log.println("There is already an assignment to port " + connection.tgt.port.qualifiedName + " before position " + doStepIndex)
  275. }
  276. }
  277. Log.pop("createInternalBindingAssignments")
  278. }
  279. def existsAssignmentToPort_BeforeIndex(Port port, int index, CustomControlRule rule) {
  280. val assignmentsToPort = rule.controlRulestatements.indexed
  281. .filter[s | s.value instanceof Assignment &&
  282. (s.value as Assignment).lvalue.ref == port
  283. ]
  284. check(assignmentsToPort.size <= 1, "Multiple assignments to the same port are not supported yet. Use a loop with a single call.")
  285. return assignmentsToPort.size == 1
  286. }
  287. def findDoStepStatementIndex(CustomControlRule rule, InnerFMU fmu) {
  288. Log.push("findDoStepStatementIndex")
  289. var result = -1
  290. val doStepProcedures = rule.controlRulestatements.indexed.filter[s | s.value instanceof DoStep && (s.value as DoStep).fmu == fmu]
  291. check(doStepProcedures.size <= 1, "Multiple calls to the doStep function for the same FMU are not supported yet. Use a loop with a single call.")
  292. if (doStepProcedures.size == 1){
  293. Log.println("Found a doStep procedure for fmu " + fmu.name + " at position " + doStepProcedures.head.key)
  294. result = doStepProcedures.head.key
  295. }
  296. // Warning: this does not support instructions such as:
  297. // var someVar = 10, h = doStep(f), etc...
  298. // Only single declarations are supported, such as:
  299. // var h = doStep(f)
  300. val doStepAssignments = rule.controlRulestatements.indexed
  301. .filter[s | s.value instanceof Declaration &&
  302. (s.value as Declaration).declarations.size == 1 &&
  303. (s.value as Declaration).declarations.head instanceof SingleVarDeclaration &&
  304. ((s.value as Declaration).declarations.head as SingleVarDeclaration).expr instanceof DoStepFun &&
  305. (((s.value as Declaration).declarations.head as SingleVarDeclaration).expr as DoStepFun).fmu == fmu
  306. ]
  307. check(doStepAssignments.size <= 1, "Multiple calls to the doStep function for the same FMU are not supported yet. Use a loop with a single call.")
  308. if (doStepAssignments.size == 1){
  309. check(result==-1, "Multiple calls to the doStep function for the same FMU are not supported yet. Use a loop with a single call.")
  310. Log.println("Found a doStep function for fmu " + fmu.name + " at position " + doStepAssignments.head.key)
  311. result = doStepAssignments.head.key
  312. }
  313. Log.pop("findDoStepStatementIndex")
  314. return result
  315. }
  316. def createCoSimStepInstructions(Adaptation sa) {
  317. check((sa.inner as InnerFMUDeclarationFull).fmus.size > 0, "At least one internal FMU is expected...")
  318. if (onlyOneInternalFMU(sa)){
  319. createCosimStepForOneFMU(sa)
  320. } else {
  321. createCosimStepForMultipleFMUs(sa)
  322. }
  323. }
  324. def createCosimStepForOneFMU(Adaptation sa) {
  325. Log.push("createCosimStepForOneFMU")
  326. val fmu = (sa.inner as InnerFMUDeclarationFull).fmus.head
  327. val controlRule = sa.control.rule as CustomControlRule
  328. val returnedStepVar = controlRule.appendDoStep(fmu)
  329. val stepVarSingleton = new LinkedList()
  330. stepVarSingleton.add(returnedStepVar)
  331. controlRule.appendReturnCosimStep(stepVarSingleton)
  332. Log.pop("createCosimStepForOneFMU")
  333. }
  334. def appendReturnCosimStep(CustomControlRule rule, LinkedList<SingleVarDeclaration> stepVariables) {
  335. Log.push("appendReturnCosimStep")
  336. if (stepVariables.size == 0){
  337. throw new Exception("Does not make sense. At least one inner FMU is expected.")
  338. }
  339. val minExpression = SemanticAdaptationFactory.eINSTANCE.createMin()
  340. Log.println("Creating min(...) expression with the following arguments:")
  341. for(varDecl : stepVariables){
  342. val varRef = SemanticAdaptationFactory.eINSTANCE.createVariable()
  343. varRef.ref = varDecl
  344. minExpression.args.add(varRef)
  345. Log.println(varDecl.name)
  346. }
  347. rule.returnstatement = SemanticAdaptationFactory.eINSTANCE.createReturnStatement()
  348. rule.returnstatement.expr = minExpression
  349. Log.pop("appendReturnCosimStep")
  350. }
  351. def appendDoStep(CustomControlRule rule, InnerFMU fmu) {
  352. Log.push("appendDoStep")
  353. val t = SemanticAdaptationFactory.eINSTANCE.createCurrentTime()
  354. val H = SemanticAdaptationFactory.eINSTANCE.createStepSize()
  355. val doStep = SemanticAdaptationFactory.eINSTANCE.createDoStepFun()
  356. doStep.t = t
  357. doStep.h = H
  358. doStep.fmu = fmu
  359. val step_var = SemanticAdaptationFactory.eINSTANCE.createSingleVarDeclaration()
  360. step_var.name = "H_" + fmu.name
  361. step_var.expr = doStep
  362. val step_decl = SemanticAdaptationFactory.eINSTANCE.createDeclaration()
  363. step_decl.declarations.add(step_var)
  364. rule.controlRulestatements.add(step_decl)
  365. Log.println("Added var " + step_var.name + " := doStep(t, H, " + fmu.name + ")")
  366. Log.pop("appendDoStep")
  367. return step_var
  368. }
  369. def createCosimStepForMultipleFMUs(Adaptation sa) {
  370. Log.push("createCosimStepForMultipleFMUs")
  371. val innerDeclaration = (sa.inner as InnerFMUDeclarationFull)
  372. val controlRule = sa.control.rule as CustomControlRule
  373. val stepVarSingleton = new LinkedList()
  374. for (fmu : innerDeclaration.topologicalSort()){
  375. val returnedStepVar = controlRule.appendDoStep(fmu)
  376. stepVarSingleton.add(returnedStepVar)
  377. }
  378. controlRule.appendReturnCosimStep(stepVarSingleton)
  379. Log.pop("createCosimStepForMultipleFMUs")
  380. }
  381. def topologicalSort(InnerFMUDeclarationFull scenario){
  382. Log.push("topologicalSort")
  383. val DirectedGraph<InnerFMU> inner_fmu_graph = createFMUGraph(scenario)
  384. val result = TopologicalSort.sort(inner_fmu_graph)
  385. Log.println("Sorting: " + result)
  386. Log.pop("topologicalSort")
  387. return result
  388. }
  389. def createFMUGraph(InnerFMUDeclarationFull scenario) {
  390. Log.push("createFMUGraph")
  391. val graph = new FMUGraph()
  392. for (fmu : scenario.fmus){
  393. graph.addNode(fmu)
  394. }
  395. for (connection : scenario.connection){
  396. check(connection.src.port.eContainer instanceof InnerFMU &&
  397. connection.tgt.port.eContainer instanceof InnerFMU, "Weird connection found: " + connection)
  398. if (reactiveMealyFMU(connection.tgt.port.eContainer as InnerFMU)){
  399. graph.addEdge(connection.src.port.eContainer as InnerFMU, connection.tgt.port.eContainer as InnerFMU)
  400. } else {
  401. Log.println("FMU " + (connection.tgt.port.eContainer as InnerFMU).name + " is not reactive mealy, so it has no algebraic dependencies.")
  402. }
  403. }
  404. Log.println(graph.toString())
  405. Log.pop("createFMUGraph")
  406. return graph
  407. }
  408. def reactiveMealyFMU(InnerFMU fmu) {
  409. return fmu.reactiveness == ReactiveOrDelayed.REACTIVE && fmu.machine == MooreOrMealy.MEALY
  410. }
  411. def check(Boolean condition, String msg){
  412. if (! condition){
  413. throw new Exception("Assertion error: " + msg)
  414. }
  415. }
  416. def onlyOneInternalFMU(Adaptation sa) {
  417. if(sa.inner instanceof InnerFMUDeclarationFull){
  418. return (sa.inner as InnerFMUDeclarationFull).fmus.size == 1
  419. } else {
  420. throw new Exception('This kind of internal scenario is not supported yet.')
  421. }
  422. }
  423. def transitiveStep(HashMap<Port, Port> internalOutputPort2ExternalPortBindings, HashMap<Port, SingleVarDeclaration> externalOutputPort2OutVarDeclaration) {
  424. Log.push("transitiveStep")
  425. val internalOutputPort2OutVarDeclaration = new HashMap<Port, SingleVarDeclaration>()
  426. for(internalOutputPort : internalOutputPort2ExternalPortBindings.keySet){
  427. val externalOutputPort = internalOutputPort2ExternalPortBindings.get(internalOutputPort)
  428. if (externalOutputPort2OutVarDeclaration.containsKey(externalOutputPort)){
  429. val outVar = externalOutputPort2OutVarDeclaration.get(externalOutputPort)
  430. Log.println("Found binding: " + internalOutputPort.qualifiedName + "->" + externalOutputPort.qualifiedName + " to be stored in " + outVar.name)
  431. internalOutputPort2OutVarDeclaration.put(internalOutputPort, outVar)
  432. }
  433. }
  434. Log.pop("transitiveStep")
  435. return internalOutputPort2OutVarDeclaration
  436. }
  437. def String qualifiedName(Port port){
  438. if (port.eContainer instanceof FMU){
  439. return (port.eContainer as FMU).name + "." + port.name
  440. }
  441. return port.name
  442. }
  443. def removeBindings(HashMap<Port, Port> internalPort2ExternalPortBindings, Adaptation sa) {
  444. Log.push("removeBindings")
  445. for (internalPort : internalPort2ExternalPortBindings.keySet){
  446. val externalPort = internalPort2ExternalPortBindings.get(internalPort)
  447. Log.println("Removing binding " + externalPort.qualifiedName + "->" + internalPort.qualifiedName)
  448. externalPort.targetdependency = null
  449. Log.println("Removing binding " + externalPort.qualifiedName + "<-" + internalPort.qualifiedName)
  450. externalPort.sourcedependency = null
  451. }
  452. Log.pop("removeBindings")
  453. }
  454. def findAllExternalPort2InputPort_Bindings(Adaptation sa) {
  455. Log.push("findAllExternalPort2InputPort_Bindings")
  456. val internalPort2ExternalPortBindings = new HashMap<Port, Port>()
  457. for (port : getAllInnerFMUInputPortDeclarations(sa)){
  458. var parentFMU = port.eContainer as InnerFMU
  459. Log.println("Checking if port " + port.qualifiedName + " is bound to an external port.")
  460. val externalPort = findExternalPortByTargetDependency(sa.inports, port)
  461. if (externalPort !== null){
  462. Log.println("Port " + port.qualifiedName + " is bound to an external port: " + externalPort.qualifiedName)
  463. internalPort2ExternalPortBindings.put(port, externalPort)
  464. } else {
  465. Log.println("Port " + port.qualifiedName + " is not bound to an external port.")
  466. }
  467. }
  468. Log.pop("findAllExternalPort2InputPort_Bindings")
  469. return internalPort2ExternalPortBindings
  470. }
  471. def findAllInternalPort2ExternalOutputPort_Bindings(Adaptation sa) {
  472. Log.push("findAllInternalPort2ExternalOutputPort_Bindings")
  473. val internalPort2ExternalPortBindings = new HashMap<Port, Port>()
  474. for (port : getAllInnerFMUOutputPortDeclarations(sa)){
  475. Log.println("Checking if port " + port.qualifiedName + " is bound to an external port.")
  476. val externalPort = findExternalPortBySourceDependency(sa.outports, port)
  477. if (externalPort !== null){
  478. Log.println("Port " + externalPort.qualifiedName + " is bound to an internal port: " + port.qualifiedName
  479. )
  480. internalPort2ExternalPortBindings.put(port, externalPort)
  481. } else {
  482. Log.println("Port " + port.qualifiedName + " is not bound to an external port.")
  483. }
  484. }
  485. Log.pop("findAllInternalPort2ExternalOutputPort_Bindings")
  486. return internalPort2ExternalPortBindings
  487. }
  488. def createExternalPortNameFromInternalPort(String parentFMUName, String internalPortName) {
  489. //return parentFMUName + "__" + internalPortName // Violates transparency
  490. return internalPortName
  491. }
  492. def addInRules_External2Internal_Assignments(Adaptation sa, HashMap<Port, Port> internalPort2ExternalPort) {
  493. Log.push("addInRules_External2Internal_Assignments")
  494. val dataRule = getOrPrependTrueRule(sa.in.rules)
  495. for(internalPort : internalPort2ExternalPort.keySet){
  496. val externalPort = internalPort2ExternalPort.get(internalPort)
  497. check((dataRule.outputfunction instanceof CompositeOutputFunction), "Only CompositeOutputFunction is supported for now.")
  498. val outFunction = dataRule.outputfunction as CompositeOutputFunction
  499. addPortAssignment(outFunction.statements, internalPort, externalPort, 0, true)
  500. }
  501. Log.pop("addInRules_External2Internal_Assignments")
  502. }
  503. def addOutRules_Internal2External_Assignments(Adaptation sa, HashMap<Port, Port> internalPort2ExternalPort){
  504. Log.push("addOutRules_Internal2External_Assignments")
  505. val dataRule = getOrPrependTrueRule(sa.out.rules)
  506. for(internalPort : internalPort2ExternalPort.keySet){
  507. val externalPort = internalPort2ExternalPort.get(internalPort)
  508. check((dataRule.outputfunction instanceof CompositeOutputFunction), "Only CompositeOutputFunction is supported for now.")
  509. val outFunction = dataRule.outputfunction as CompositeOutputFunction
  510. addPortAssignment(outFunction.statements, externalPort, internalPort, 0, true)
  511. }
  512. Log.pop("addOutRules_Internal2External_Assignments")
  513. }
  514. def addPortAssignment(List<Statement> statements, Port toPort, Port fromPort, int position, boolean convertUnits) {
  515. Log.push("addPortAssignment")
  516. val assignment = SemanticAdaptationFactory.eINSTANCE.createAssignment()
  517. assignment.lvalue = SemanticAdaptationFactory.eINSTANCE.createVariable()
  518. (assignment.lvalue as Variable).owner = toPort.eContainer as FMU
  519. (assignment.lvalue as Variable).ref = toPort
  520. val varRef = SemanticAdaptationFactory.eINSTANCE.createVariable()
  521. varRef.owner = fromPort.eContainer as FMU
  522. varRef.ref = fromPort
  523. if (convertUnits && compatibleUnits(toPort.unity, fromPort.unity) && !unitsEqual(toPort.unity, fromPort.unity)){
  524. Log.println("Converting units " + fromPort.unity + " to " + toPort.unity)
  525. assignment.expr = getConversionExpression(toPort.unity, fromPort.unity, varRef)
  526. } else {
  527. assignment.expr = varRef
  528. Log.println("Assignment " + toPort.qualifiedName + " := " + fromPort.qualifiedName + " created.")
  529. }
  530. statements.add(position, assignment)
  531. Log.pop("addPortAssignment")
  532. }
  533. def getConversionExpression(Unity toUnits, Unity fromUnit, Variable varFrom) {
  534. check(toUnits instanceof AtomicUnity && fromUnit instanceof AtomicUnity, "Conversion between units is only supported for AtomicUnits.")
  535. var toAtomic = toUnits as AtomicUnity
  536. var fromAtomic = fromUnit as AtomicUnity
  537. check(fromAtomic.name == "cm" && toAtomic.name == "m", "Conversion only possible between cm and m... Not very usefull :)")
  538. var division = SemanticAdaptationFactory.eINSTANCE.createDiv()
  539. division.left = varFrom
  540. var hundred = SemanticAdaptationFactory.eINSTANCE.createRealLiteral()
  541. hundred.value=100f
  542. division.right = hundred
  543. return division
  544. }
  545. def dispatch boolean unitsEqual(DivideUnity u1, DivideUnity u2) {
  546. return unitsEqual(u1.left, u2.left) && unitsEqual(u1.right, u2.right)
  547. }
  548. def dispatch boolean unitsEqual(Void u1, Void u2) {
  549. return true
  550. }
  551. def dispatch boolean unitsEqual(MultiplyUnity u1, MultiplyUnity u2) {
  552. return unitsEqual(u1.left, u2.left) && unitsEqual(u1.right, u2.right)
  553. }
  554. def dispatch boolean unitsEqual(AtomicUnity u1, AtomicUnity u2) {
  555. return u1.name == u2.name && u1.power == u2.power
  556. }
  557. def compatibleUnits(Unity u1, Unity u2) {
  558. if ((u1 === null && u2===null) ||
  559. (u1 !== null && u2!==null)
  560. ){
  561. // TODO What makes two units compatible?
  562. return true
  563. } else {
  564. return false
  565. }
  566. }
  567. def addInRules_External2Stored_Assignments(Adaptation sa, HashMap<Port, SingleVarDeclaration> inputPort2InVarDeclaration) {
  568. Log.push("addInRules_External2Stored_Assignments")
  569. if (sa.in === null){
  570. sa.in = SemanticAdaptationFactory.eINSTANCE.createInRulesBlock()
  571. }
  572. addRules_Port2Stored_Assignments(sa.in.rules, inputPort2InVarDeclaration)
  573. Log.pop("addInRules_External2Stored_Assignments")
  574. }
  575. def addOutRules_Internal2Stored_Assignments(Adaptation sa, HashMap<Port, SingleVarDeclaration> internalOutputPort2OutVarDeclaration) {
  576. Log.push("addOutRules_Internal2Stored_Assignments")
  577. if (sa.out === null){
  578. sa.out = SemanticAdaptationFactory.eINSTANCE.createOutRulesBlock()
  579. }
  580. addRules_Port2Stored_Assignments(sa.out.rules, internalOutputPort2OutVarDeclaration)
  581. Log.pop("addOutRules_Internal2Stored_Assignments")
  582. }
  583. def addRules_Port2Stored_Assignments(List<DataRule> rules, HashMap<Port, SingleVarDeclaration> port2VarDeclaration) {
  584. Log.push("addRules_External2Stored_Assignments")
  585. val dataRule = getOrPrependTrueRule(rules)
  586. if (dataRule.statetransitionfunction.expression !== null){
  587. throw new Exception("Expressions in rules are not supported yet.")
  588. // This and the one below are asily solved with a syntactic sugar substitution.
  589. }
  590. if (dataRule.statetransitionfunction.assignment !== null){
  591. throw new Exception("Assignment in rules are not supported yet.")
  592. }
  593. for(port : port2VarDeclaration.keySet){
  594. val storedVarDecl = port2VarDeclaration.get(port)
  595. addAssignmentToStoredVar(dataRule.statetransitionfunction.statements, port, storedVarDecl)
  596. }
  597. Log.pop("addRules_External2Stored_Assignments")
  598. }
  599. def addAssignmentToStoredVar(List<Statement> statements, Port internalPort, SingleVarDeclaration storedVarDecl) {
  600. Log.push("addAssignmentToStoredVar")
  601. val assignment = SemanticAdaptationFactory.eINSTANCE.createAssignment()
  602. assignment.lvalue = SemanticAdaptationFactory.eINSTANCE.createVariable()
  603. assignment.lvalue.ref = storedVarDecl
  604. assignment.expr = SemanticAdaptationFactory.eINSTANCE.createVariable()
  605. (assignment.expr as Variable).owner = internalPort.eContainer as FMU
  606. (assignment.expr as Variable).ref = internalPort
  607. statements.add(0, assignment)
  608. Log.println("Assignment " + storedVarDecl.name + " := " + internalPort.qualifiedName + " created.")
  609. Log.pop("addAssignmentToStoredVar")
  610. }
  611. def getOrPrependTrueRule(List<DataRule> rules) {
  612. var DataRule rule = null
  613. if (rules.size == 0 || !isTrueRule(rules.head)){
  614. Log.println("No existing rule found with true condition. Creating one.")
  615. val trueRule = SemanticAdaptationFactory.eINSTANCE.createDataRule()
  616. trueRule.condition = SemanticAdaptationFactory.eINSTANCE.createRuleCondition()
  617. val trueExpr = SemanticAdaptationFactory.eINSTANCE.createBoolLiteral()
  618. trueExpr.value = "true"
  619. trueRule.condition.condition = trueExpr
  620. trueRule.statetransitionfunction = SemanticAdaptationFactory.eINSTANCE.createStateTransitionFunction()
  621. trueRule.outputfunction = SemanticAdaptationFactory.eINSTANCE.createCompositeOutputFunction()
  622. rules.add(0, trueRule)
  623. rule = trueRule
  624. } else {
  625. Log.println("Existing rule with true condition found.")
  626. rule = rules.head
  627. }
  628. return rule
  629. }
  630. def isTrueRule(DataRule rule){
  631. if (rule.condition.condition instanceof BoolLiteral){
  632. return (rule.condition.condition as BoolLiteral).value == "true"
  633. }
  634. return false
  635. }
  636. def addInVars(Adaptation sa, Map<Port, SingleParamDeclaration> inputPort2parameterDeclaration){
  637. Log.push("addInVars")
  638. if (sa.in === null){
  639. sa.in = SemanticAdaptationFactory.eINSTANCE.createInRulesBlock()
  640. }
  641. val inputPort2InVarDeclaration = addStorageVars(sa.in.globalInVars, inputPort2parameterDeclaration)
  642. Log.pop("addInVars")
  643. return inputPort2InVarDeclaration
  644. }
  645. def addOutVars(Adaptation sa, Map<Port, SingleParamDeclaration> outputPort2parameterDeclaration){
  646. Log.push("addOutVars")
  647. if (sa.out === null){
  648. sa.out = SemanticAdaptationFactory.eINSTANCE.createOutRulesBlock()
  649. }
  650. val outputPort2InVarDeclaration = addStorageVars(sa.out.globalOutVars, outputPort2parameterDeclaration)
  651. Log.pop("addOutVars")
  652. return outputPort2InVarDeclaration
  653. }
  654. def addStorageVars(List<Declaration> varDeclarations, Map<Port, SingleParamDeclaration> port2parameterDeclaration){
  655. Log.push("addStorageVars")
  656. var port2VarDeclaration = new HashMap<Port, SingleVarDeclaration>()
  657. for(port : port2parameterDeclaration.keySet){
  658. Log.println("Processing port " + port.qualifiedName)
  659. val paramDecl = port2parameterDeclaration.get(port)
  660. val varDeclarationName = getStorageVarDeclarationName(port)
  661. if (!varDeclarationExists(varDeclarationName, varDeclarations) ){
  662. Log.println("Creating new variable declaration " + varDeclarationName)
  663. val varDeclaration = addNewVarDeclaration(port, paramDecl, varDeclarations)
  664. port2VarDeclaration.put(port, varDeclaration)
  665. } else {
  666. Log.println("Input variable declaration " + varDeclarationName + " already exists.")
  667. }
  668. }
  669. Log.pop("addStorageVars")
  670. return port2VarDeclaration
  671. }
  672. def addNewVarDeclaration(Port externalInputPort, SingleParamDeclaration paramDecl, List<Declaration> varDeclarations) {
  673. /*
  674. if (sa.in === null){
  675. sa.in = SemanticAdaptationFactory.eINSTANCE.createInRulesBlock()
  676. }
  677. */
  678. if (varDeclarations.size == 0){
  679. varDeclarations.add(SemanticAdaptationFactory.eINSTANCE.createDeclaration())
  680. }
  681. val newSingleVarDecl = SemanticAdaptationFactory.eINSTANCE.createSingleVarDeclaration()
  682. newSingleVarDecl.name = getStorageVarDeclarationName(externalInputPort)
  683. newSingleVarDecl.type = externalInputPort.type
  684. val initValue = SemanticAdaptationFactory.eINSTANCE.createVariable()
  685. initValue.ref = paramDecl
  686. newSingleVarDecl.expr = initValue
  687. varDeclarations.head.declarations.add(newSingleVarDecl)
  688. Log.println("New variable declaration created: " + newSingleVarDecl.name + " := " + paramDecl.name)
  689. return newSingleVarDecl
  690. }
  691. def varDeclarationExists(String invarName, List<Declaration> varDeclarations) {
  692. for (declarations : varDeclarations){ // sa.in.globalInVars
  693. for (decl : declarations.declarations){
  694. if (decl.name == invarName){
  695. return true
  696. }
  697. }
  698. }
  699. return false
  700. }
  701. def getStorageVarDeclarationName(Port externalInputPort) {
  702. return "stored__" + externalInputPort.name;
  703. }
  704. def genericDeclarationInferenceAlgorithm(Adaptation sa,
  705. (EObject)=>Object getField,
  706. (EObject, Object)=>void setField,
  707. (EObject)=>Object inferField
  708. ){
  709. Log.push("Running generic inference algorithm...")
  710. /*
  711. * Dumbest (and simplest) algorithm for this is a fixed point computation:
  712. * 1. Look for every var/port declaration
  713. * 2. If that var has a XXX already, nothing else to be done.
  714. * 3. If that var has no XXX declared, then
  715. * 3.1 If var/port has an initial value or connection, then
  716. * 3.1.1 If the initial_value/connection has a XXX declared, then var gets that XXX.
  717. * 3.1.2 Otherwise, nothing else to be done.
  718. * 3.2 If var/port has no initial value or connection then this either is a missing feature, or an error.
  719. * 3.3 If something has changed, go to 1. Otherwise, end.
  720. *
  721. * An extra set of instructions is there to push the element field information using connections and bindings.
  722. */
  723. var fixedPoint = false
  724. var unfieldedElementsCounter = 0
  725. while (! fixedPoint){
  726. fixedPoint = true
  727. unfieldedElementsCounter = 0
  728. Log.println("Inferring parameter fields...")
  729. for (paramDeclarations : sa.params) {
  730. for (paramDeclaration : paramDeclarations.declarations) {
  731. Log.println("Computing field for param " + paramDeclaration.name)
  732. if(getField.apply(paramDeclaration) !== null){
  733. Log.println("Already has been inferred: " + getField.apply(paramDeclaration))
  734. } else {
  735. Log.println("Has not been inferred yet.")
  736. if (tryInferAndAssignField(paramDeclaration, getField, setField, inferField)){
  737. fixedPoint = false
  738. } else {
  739. unfieldedElementsCounter++
  740. }
  741. }
  742. }
  743. }
  744. if(sa.inner !== null){
  745. if(sa.inner instanceof InnerFMUDeclarationFull){
  746. var innerFMUFull = sa.inner as InnerFMUDeclarationFull
  747. for(fmu : innerFMUFull.fmus){
  748. Log.println("Inferring port fields of FMU " + fmu.name)
  749. for (port : EcoreUtil2.getAllContentsOfType(fmu, Port)) {
  750. if(getField.apply(port) !== null){
  751. Log.println("Already has a field: " + getField.apply(port))
  752. } else {
  753. if (tryInferAndAssignField(port, getField, setField, inferField)){
  754. fixedPoint = false
  755. } else {
  756. unfieldedElementsCounter++
  757. }
  758. }
  759. }
  760. }
  761. if (innerFMUFull.connection.size > 0){
  762. Log.println("Inferring port fields using internal scenario bindings.")
  763. for (binding : innerFMUFull.connection){
  764. if (getField.apply(binding.src.port) !== null && getField.apply(binding.tgt.port) !== null){
  765. Log.println("Both ports have fields already.")
  766. } else {
  767. var inferredFieldAttempt = inferPortFieldViaConnection(binding, getField, setField, inferField)
  768. if (inferredFieldAttempt !== null){
  769. if (getField.apply(binding.src.port) === null){
  770. setField.apply(binding.src.port, inferredFieldAttempt)
  771. } else if (getField.apply(binding.tgt.port) === null){
  772. setField.apply(binding.tgt.port, inferredFieldAttempt)
  773. }
  774. fixedPoint = false
  775. unfieldedElementsCounter--
  776. Log.println("Got new field: " + inferredFieldAttempt)
  777. } else {
  778. Log.println("Cannot infer field from binding now.")
  779. }
  780. }
  781. }
  782. }
  783. } else {
  784. throw new Exception("Field inference only supported for InnerFMUDeclarationFull.")
  785. }
  786. }
  787. Log.println("Inferring external port fields...")
  788. var externalPorts = new LinkedList(sa.inports)
  789. externalPorts.addAll(sa.outports)
  790. for (port : externalPorts) {
  791. if (getField.apply(port) !== null){
  792. Log.println("Already has a field: " + getField.apply(port))
  793. if (pushPortField(port, getField, setField, inferField)){
  794. fixedPoint = false
  795. unfieldedElementsCounter--
  796. }
  797. } else {
  798. if (tryInferAndAssignField(port, getField, setField, inferField)){
  799. fixedPoint = false
  800. } else {
  801. unfieldedElementsCounter++
  802. }
  803. }
  804. }
  805. Log.println("Inferring all other declaration fields...")
  806. for (varDeclaration : EcoreUtil2.getAllContentsOfType(sa, SingleVarDeclaration)) {
  807. Log.println("Computing field for declaration " + varDeclaration.name)
  808. if(getField.apply(varDeclaration) !== null){
  809. Log.println("Already has a field: " + getField.apply(varDeclaration))
  810. } else {
  811. if (tryInferAndAssignField(varDeclaration, getField, setField, inferField)){
  812. fixedPoint = false
  813. } else {
  814. unfieldedElementsCounter++
  815. }
  816. }
  817. }
  818. Log.println("Ended iteration with unfielded elements remaining: " + unfieldedElementsCounter)
  819. } // while (! fixedPoint)
  820. Log.pop("Running generic inference algorithm... DONE")
  821. return unfieldedElementsCounter
  822. }
  823. def tryInferAndAssignField(EObject element,
  824. (EObject)=>Object getField,
  825. (EObject, Object)=>void setField,
  826. (EObject)=>Object inferField) {
  827. var inferredFieldAttempt = inferField.apply(element)
  828. if (inferredFieldAttempt !== null){
  829. setField.apply(element, inferredFieldAttempt)
  830. Log.println("Got new field: " + inferredFieldAttempt)
  831. return true
  832. } else {
  833. Log.println("Cannot infer field now.")
  834. return false
  835. }
  836. }
  837. def extractTypeFromExpression(Expression expression, String declarationName){
  838. if (expression instanceof IntLiteral){
  839. return "Integer"
  840. } else if (expression instanceof RealLiteral){
  841. return "Real"
  842. } else if (expression instanceof BoolLiteral){
  843. return "Bool"
  844. } else if (expression instanceof StringLiteral){
  845. return "String"
  846. } else if (expression instanceof Variable){
  847. var varRef = expression as Variable
  848. if (varRef.ref instanceof Port){
  849. var decl = varRef.ref as Port
  850. if (decl.type !== null){
  851. return decl.type
  852. }
  853. } else if(varRef.ref instanceof SingleParamDeclaration){
  854. var decl = varRef.ref as SingleParamDeclaration
  855. if (decl.type !== null){
  856. return decl.type
  857. }
  858. } else if(varRef.ref instanceof SingleVarDeclaration){
  859. var decl = varRef.ref as SingleVarDeclaration
  860. if (decl.type !== null){
  861. return decl.type
  862. }
  863. } else if(varRef.ref instanceof DeclaredParameter){
  864. throw new Exception("Type cannot be inferred for references to DeclaredParameter (for now). Please specify the explicit type of declaration " + declarationName)
  865. } else {
  866. throw new Exception("Unexpected kind of Variable expression found.")
  867. }
  868. } else if(expression instanceof BuiltinFunction){
  869. if (expression instanceof IsSet || expression instanceof Close){
  870. return "Bool"
  871. } else {
  872. return "Real"
  873. }
  874. } else {
  875. throw new Exception("Initial value for declaration " + declarationName + " must be literal or var ref for now. Got instead " + expression + ". If you want complex expressions, give it an explicit type.")
  876. }
  877. return null
  878. }
  879. def inferPortFieldViaConnection(Connection binding,
  880. (EObject)=>Object getField,
  881. (EObject, Object)=>void setField,
  882. (EObject)=>Object inferField
  883. ){
  884. var Object resultField = null
  885. if (getField.apply(binding.src.port) !== null && getField.apply(binding.tgt.port) !== null){
  886. throw new Exception("Wrong way of using this function. It assumes type is not inferred yet.")
  887. } else if (getField.apply(binding.src.port) !== null){
  888. resultField = getField.apply(binding.src.port)
  889. Log.println("Target port "+ binding.tgt.port.qualifiedName +" got new type: " + resultField)
  890. } else if (getField.apply(binding.tgt.port) !== null){
  891. resultField = getField.apply(binding.tgt.port)
  892. Log.println("Target port "+ binding.src.port.qualifiedName +" got new type: " + resultField)
  893. }
  894. return resultField
  895. }
  896. def pushPortField(Port port,
  897. (EObject)=>Object getField,
  898. (EObject, Object)=>void setField,
  899. (EObject)=>Object inferField){
  900. var fieldInferred = false
  901. Log.println("Pushing field of port " + port.qualifiedName + " to its bindings.")
  902. if(getField.apply(port) === null){
  903. Log.println("Has no field to be pushed.")
  904. throw new Exception("Wrong way of using this function. It assumes field is already inferred.")
  905. } else {
  906. Log.println("Pushing field: " + getField.apply(port))
  907. if(port.sourcedependency !== null){
  908. Log.println("Has a source dependency: " + port.sourcedependency.port.qualifiedName)
  909. if(getField.apply(port.sourcedependency.port) === null){
  910. setField.apply(port.sourcedependency.port, getField.apply(port))
  911. Log.println("Port " + port.sourcedependency.port.qualifiedName + " got new type: " + getField.apply(port.sourcedependency.port))
  912. fieldInferred = true
  913. } else {
  914. Log.println("Source port already has field.")
  915. }
  916. } else {
  917. Log.println("Has no source dependency.")
  918. }
  919. if (port.targetdependency !== null) {
  920. Log.println("Has a target dependency: " + port.targetdependency.port.qualifiedName)
  921. if(getField.apply(port.targetdependency.port) === null){
  922. Log.println("Dependency has no field yet.")
  923. setField.apply(port.targetdependency.port, getField.apply(port))
  924. Log.println("Port " + port.targetdependency.port.qualifiedName + " got new type: " + getField.apply(port.targetdependency.port))
  925. fieldInferred = true
  926. } else {
  927. Log.println("Target port already has field.")
  928. }
  929. } else {
  930. Log.println("Has no target dependency.")
  931. }
  932. }
  933. return fieldInferred
  934. }
  935. def getPortUnit(Port port){
  936. var unitInferred = false
  937. Log.println("Computing unit for port " + port.qualifiedName)
  938. var Unity returnUnit = null
  939. if(port.unity !== null){
  940. throw new Exception("Wrong way of using this function. It assumes unit is not inferred yet.")
  941. } else {
  942. Log.println("Has no unit.")
  943. Log.println("Attempting to infer unit from bindings.")
  944. if(port.sourcedependency !== null){
  945. Log.println("Has a source dependency: " + port.sourcedependency.port.qualifiedName)
  946. if(port.sourcedependency.port.unity === null){
  947. Log.println("Dependency has no unit yet.")
  948. } else {
  949. returnUnit = port.sourcedependency.port.unity
  950. Log.println("Got new unit: " + returnUnit)
  951. unitInferred = true
  952. }
  953. } else {
  954. Log.println("Has no source dependency.")
  955. }
  956. if (port.targetdependency !== null && !unitInferred) {
  957. Log.println("Has a target dependency: " + port.targetdependency.port.qualifiedName)
  958. if(port.targetdependency.port.unity === null){
  959. Log.println("Dependency has no unit yet.")
  960. } else {
  961. returnUnit = port.targetdependency.port.unity
  962. Log.println("Got new unit: " + returnUnit)
  963. unitInferred = true
  964. }
  965. } else {
  966. Log.println("Has no target dependency, or unit has already been inferred from source dependency.")
  967. }
  968. }
  969. return returnUnit
  970. }
  971. def getPortType(Port port){
  972. var typeInferred = false
  973. Log.println("Computing type for port " + port.qualifiedName)
  974. var String returnType = null
  975. if(port.type !== null){
  976. throw new Exception("Wrong way of using this function. It assumes type is not inferred yet.")
  977. } else {
  978. Log.println("Has no type.")
  979. Log.println("Attempting to infer type from units.")
  980. if (port.unity !== null){
  981. returnType = "Real"
  982. Log.println("Got new type: " + returnType)
  983. typeInferred = true
  984. } else {
  985. Log.println("Attempting to infer type from bindings.")
  986. if(port.sourcedependency !== null){
  987. Log.println("Has a source dependency: " + port.sourcedependency.port.qualifiedName)
  988. if(port.sourcedependency.port.type === null){
  989. Log.println("Dependency has no type yet.")
  990. } else {
  991. returnType = port.sourcedependency.port.type
  992. Log.println("Got new type: " + returnType)
  993. typeInferred = true
  994. }
  995. } else {
  996. Log.println("Has no source dependency.")
  997. }
  998. if (port.targetdependency !== null && !typeInferred) {
  999. Log.println("Has a target dependency: " + port.targetdependency.port.qualifiedName)
  1000. if(port.targetdependency.port.type === null){
  1001. //println("Port object: " + port.targetdependency.port)
  1002. Log.println("Dependency has no type yet.")
  1003. } else {
  1004. returnType = port.targetdependency.port.type
  1005. Log.println("Got new type: " + returnType)
  1006. typeInferred = true
  1007. }
  1008. } else {
  1009. Log.println("Has no target dependency, or type has already been inferred from source dependency.")
  1010. }
  1011. }
  1012. }
  1013. return returnType
  1014. }
  1015. def addInPorts(Adaptation sa) {
  1016. Log.push("Adding input ports...")
  1017. for (port : getAllInnerFMUInputPortDeclarations(sa)){
  1018. var parentFMU = port.eContainer as InnerFMU
  1019. Log.println("Checking if port " + port.qualifiedName + " has incoming connections"
  1020. )
  1021. if (! hasConnection(port, sa, true)){
  1022. Log.println("Port " + port.qualifiedName + " has no incoming connections.")
  1023. val externalPortName = createExternalPortNameFromInternalPort(parentFMU.name, port.name)
  1024. if (findExternalPortByName(sa, externalPortName) === null){
  1025. var newExternalPort = createExternalInputPortDeclarationFromInnerPort(port, parentFMU, sa)
  1026. Log.println("External port " + newExternalPort.qualifiedName + " created.")
  1027. newExternalPort.bindExternalInputPortTo(parentFMU, port)
  1028. Log.println("External port " + newExternalPort.qualifiedName + " bound to port " + port.qualifiedName)
  1029. } else {
  1030. Log.println("Error: External port " + externalPortName + " already declared.")
  1031. throw new Exception("Error: External port " + externalPortName + " already declared. Please rename it to avoid clashes.")
  1032. }
  1033. } else {
  1034. Log.println("Port " + port.qualifiedName + " has an incoming connection.")
  1035. }
  1036. }
  1037. Log.pop("Adding input ports... DONE")
  1038. }
  1039. def bindExternalInputPortTo(Port externalInputPort, InnerFMU internalPortParent, Port internalPort) {
  1040. externalInputPort.targetdependency = SemanticAdaptationFactory.eINSTANCE.createSpecifiedPort()
  1041. externalInputPort.targetdependency.owner = internalPortParent
  1042. externalInputPort.targetdependency.port = internalPort
  1043. }
  1044. def bindExternalOutputPortTo(Port externalOutputPort, InnerFMU internalPortParent, Port internalPort) {
  1045. externalOutputPort.sourcedependency = SemanticAdaptationFactory.eINSTANCE.createSpecifiedPort()
  1046. externalOutputPort.sourcedependency.owner = internalPortParent
  1047. externalOutputPort.sourcedependency.port = internalPort
  1048. }
  1049. def createExternalInputPortDeclarationFromInnerPort(Port port, FMU parent, Adaptation sa) {
  1050. var externalInputPort = createExternalPortDeclarationFromInnerPort(port, parent)
  1051. sa.inports.add(externalInputPort)
  1052. return externalInputPort
  1053. }
  1054. def createExternalOutputPortDeclarationFromInnerPort(Port port, FMU parent, Adaptation sa) {
  1055. var externalOutputPort = createExternalPortDeclarationFromInnerPort(port, parent)
  1056. sa.outports.add(externalOutputPort)
  1057. return externalOutputPort
  1058. }
  1059. def createExternalPortDeclarationFromInnerPort(Port port, FMU parent) {
  1060. var externalInputPort = SemanticAdaptationFactory.eINSTANCE.createPort()
  1061. externalInputPort.name = createExternalPortNameFromInternalPort(parent.name, port.name)
  1062. externalInputPort.type = port.type
  1063. externalInputPort.unity = EcoreUtil2.copy(port.unity)
  1064. return externalInputPort
  1065. }
  1066. def findExternalPortByName(Adaptation adaptation, String name) {
  1067. for (externalInputPort : adaptation.inports){
  1068. if (externalInputPort.name == name){
  1069. return externalInputPort
  1070. }
  1071. }
  1072. return null
  1073. }
  1074. def findExternalPortByTargetDependency(List<Port> ports, Port targetDependency) {
  1075. for (externalInputPort : ports){
  1076. if (externalInputPort.targetdependency !== null && externalInputPort.targetdependency.port == targetDependency){
  1077. return externalInputPort
  1078. }
  1079. }
  1080. return null
  1081. }
  1082. def findExternalPortBySourceDependency(List<Port> ports, Port sourceDependency) {
  1083. for (externalInputPort : ports){
  1084. if (externalInputPort.sourcedependency !== null && externalInputPort.sourcedependency.port == sourceDependency){
  1085. return externalInputPort
  1086. }
  1087. }
  1088. return null
  1089. }
  1090. def hasConnection(Port port, Adaptation adaptation, Boolean checkForIncomming) {
  1091. var result = false
  1092. if ( (checkForIncomming && port.sourcedependency !== null) ||
  1093. (! checkForIncomming && port.targetdependency !== null)
  1094. ){
  1095. result = true
  1096. } else {
  1097. if (port.eContainer instanceof InnerFMU){
  1098. var innerScenarioDeclaration = EcoreUtil2.getContainerOfType(port, InnerFMUDeclaration)
  1099. if (innerScenarioDeclaration instanceof InnerFMUDeclarationFull){
  1100. var innerScenarioWithCoupling = innerScenarioDeclaration as InnerFMUDeclarationFull
  1101. if (innerScenarioWithCoupling.connection.size > 0){
  1102. for (connection : innerScenarioWithCoupling.connection ){
  1103. if ( (checkForIncomming && connection.tgt.port == port)){
  1104. Log.println("Port " + port.qualifiedName + " has an incoming connection from internal port " + connection.src.port.qualifiedName)
  1105. result = true
  1106. } else if (!checkForIncomming && connection.src.port == port) {
  1107. Log.println("Port " + port.qualifiedName + " has an outgoing connection to internal port " + connection.tgt.port.qualifiedName)
  1108. result = true
  1109. }
  1110. }
  1111. }
  1112. }
  1113. for (externalInputPort : adaptation.inports.filter[p | (checkForIncomming && p.targetdependency !== null) || (!checkForIncomming && p.sourcedependency !== null) ]){
  1114. if (checkForIncomming && externalInputPort.targetdependency.port == port){
  1115. Log.println("Port " + port.qualifiedName + " has an incoming connection from external port " + externalInputPort.qualifiedName)
  1116. result = true
  1117. } else if ( !checkForIncomming && externalInputPort.sourcedependency.port == port){
  1118. Log.println("Port " + port.qualifiedName + " has an outgoing connection to external port " + externalInputPort.qualifiedName)
  1119. result = true
  1120. }
  1121. }
  1122. }
  1123. }
  1124. return result
  1125. }
  1126. def getAllInnerFMUInputPortDeclarations(Adaptation sa){
  1127. return mapAllInnerFMUs(sa, [fmu | fmu.inports]);
  1128. }
  1129. def getAllInnerFMUOutputPortDeclarations(Adaptation sa){
  1130. return mapAllInnerFMUs(sa, [fmu | fmu.outports]);
  1131. }
  1132. def <T> List<T> mapAllInnerFMUs(Adaptation sa, (InnerFMU)=>List<T> map){
  1133. var result = new LinkedList()
  1134. if(sa.inner !== null){
  1135. if(sa.inner instanceof InnerFMUDeclarationFull){
  1136. var innerFMUFull = sa.inner as InnerFMUDeclarationFull
  1137. for(fmu : innerFMUFull.fmus){
  1138. result.addAll(map.apply(fmu))
  1139. }
  1140. } else {
  1141. throw new Exception("Only support for InnerFMUDeclarationFull.")
  1142. }
  1143. }
  1144. return result;
  1145. }
  1146. def addInParams(Adaptation sa) {
  1147. Log.push("Adding input parameters...")
  1148. val result = addParamForPortDeclarations(sa, sa.inports)
  1149. Log.pop("Adding input parameters... DONE")
  1150. return result
  1151. }
  1152. def addOutParams(Adaptation sa) {
  1153. Log.push("Adding output parameters...")
  1154. val result = addParamForPortDeclarations(sa, getAllInnerFMUOutputPortDeclarations(sa))
  1155. Log.pop("Adding output parameters... DONE")
  1156. return result
  1157. }
  1158. def addParamForPortDeclarations(Adaptation sa, List<Port> ports){
  1159. Log.push("addParamForPortDeclarations")
  1160. val PARAM_PREFIX = "INIT_"
  1161. var port2parameterDeclaration = new HashMap<Port, SingleParamDeclaration>(ports.size)
  1162. for (externalPortDecl : ports) {
  1163. Log.println("Generating parameter for port " + externalPortDecl.qualifiedName)
  1164. var paramname = PARAM_PREFIX + externalPortDecl.name.toUpperCase()
  1165. if (paramAlreadyDeclared(paramname, sa)){
  1166. Log.println("Parameter " + paramname + " already declared for port " + externalPortDecl.qualifiedName)
  1167. } else {
  1168. Log.println("Declaring new parameter " + paramname + " for port " + externalPortDecl.qualifiedName)
  1169. var paramDeclaration = addNewParamDeclaration(paramname, externalPortDecl, sa)
  1170. port2parameterDeclaration.put(externalPortDecl, paramDeclaration)
  1171. }
  1172. }
  1173. Log.pop("addParamForPortDeclarations")
  1174. return port2parameterDeclaration
  1175. }
  1176. def addNewParamDeclaration(String name, Port fromPort, Adaptation sa) {
  1177. var factory = SemanticAdaptationFactory.eINSTANCE
  1178. var paramDeclaration = factory.createSingleParamDeclaration()
  1179. paramDeclaration.name = name
  1180. paramDeclaration.type = fromPort.type
  1181. paramDeclaration.expr = getDefaultTypeExpression(paramDeclaration.type)
  1182. if (sa.params.size == 0){
  1183. sa.params.add(factory.createParamDeclarations())
  1184. }
  1185. sa.params.head.declarations.add(paramDeclaration)
  1186. return paramDeclaration
  1187. }
  1188. def getDefaultTypeExpression(String type) {
  1189. switch (type) {
  1190. case "Integer": {
  1191. val result = SemanticAdaptationFactory.eINSTANCE.createIntLiteral
  1192. result.value = 0
  1193. return result
  1194. }
  1195. case "Real": {
  1196. val result = SemanticAdaptationFactory.eINSTANCE.createRealLiteral
  1197. result.value = 0.0f
  1198. return result
  1199. }
  1200. case "Bool": {
  1201. val result = SemanticAdaptationFactory.eINSTANCE.createBoolLiteral
  1202. result.value = "false"
  1203. return result
  1204. }
  1205. case "String": {
  1206. val result = SemanticAdaptationFactory.eINSTANCE.createStringLiteral
  1207. result.value = " "
  1208. return result
  1209. }
  1210. default: {
  1211. throw new Exception("Unexpected type.")
  1212. }
  1213. }
  1214. }
  1215. def paramAlreadyDeclared(String name, Adaptation sa) {
  1216. for(paramDeclarations : sa.params){
  1217. for(paramDeclaration : paramDeclarations.declarations){
  1218. if(paramDeclaration.name == name){
  1219. return true
  1220. }
  1221. }
  1222. }
  1223. return false
  1224. }
  1225. def addOutPorts(Adaptation sa) {
  1226. Log.push("Adding output ports...")
  1227. for (port : getAllInnerFMUOutputPortDeclarations(sa)){
  1228. var parentFMU = port.eContainer as InnerFMU
  1229. Log.println("Checking if port " + port.qualifiedName + " has outgoing connections")
  1230. if (! hasConnection(port, sa, false)){
  1231. Log.println("Port " + port.qualifiedName + " has no outgoing connections.")
  1232. val externalPortName = createExternalPortNameFromInternalPort(parentFMU.name, port.name)
  1233. if (findExternalPortByName(sa, externalPortName) === null){
  1234. var newExternalPort = createExternalOutputPortDeclarationFromInnerPort(port, parentFMU, sa)
  1235. Log.println("External port " + newExternalPort.qualifiedName + " created.")
  1236. newExternalPort.bindExternalOutputPortTo(parentFMU, port)
  1237. Log.println("External port " + newExternalPort.qualifiedName + " bound to port " + port.qualifiedName)
  1238. } else {
  1239. Log.println("Error: External port " + externalPortName + " already declared.")
  1240. throw new Exception("Error: External port " + externalPortName + " already declared. Please rename it to avoid clashes.")
  1241. }
  1242. } else {
  1243. Log.println("Port " + port.qualifiedName + " has an incoming connection.")
  1244. }
  1245. }
  1246. Log.pop("Adding output ports... DONE")
  1247. }
  1248. }