SemanticAdaptationCanonicalGenerator.xtend 48 KB

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