1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
|
# -*- coding: utf-8 -*-
#
# AWL simulator - FUP compiler
#
# Copyright 2016-2017 Michael Buesch <m@bues.ch>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
from __future__ import division, absolute_import, print_function, unicode_literals
#from awlsim.common.cython_support cimport * #@cy
from awlsim.common.compat import *
from awlsim.common.sources import *
from awlsim.common.xmlfactory import *
from awlsim.common.cpuconfig import *
from awlsim.core.cpu import * #+cimport
from awlsim.core.operators import * #+cimport
from awlsim.core.operatortypes import * #+cimport
from awlsim.core.statusword import * #+cimport
from awlsim.core.symbolparser import *
from awlsim.core.instructions.all_insns import * #+cimport
from awlsim.core.instructions.parentinfo import *
from awlsim.awloptimizer.awloptimizer import *
from awlsim.fupcompiler.blockdecl import *
from awlsim.fupcompiler.interf import *
from awlsim.fupcompiler.grid import *
from awlsim.fupcompiler.elem import *
class FupFakeCpu(S7CPU):
def getMnemonics(self):
return self.fupCompiler.mnemonics
class FupCompilerFactory(XmlFactory):
FUP_VERSION = 0
def parser_open(self, tag=None):
self.inFup = False
self.inGrids = False
XmlFactory.parser_open(self, tag)
def parser_beginTag(self, tag):
if self.inFup:
if self.inGrids:
if tag.name == "grid":
grid = FupCompiler_Grid(self.compiler)
self.compiler.grids.append(grid)
self.parser_switchTo(grid.factory(grid=grid))
return
else:
if tag.name == "blockdecl":
if self.compiler.decl:
raise self.Error("Multiple <blockdecl>s defined.")
decl = FupCompiler_BlockDecl(self.compiler)
self.compiler.decl = decl
self.parser_switchTo(decl.factory(decl=decl))
return
if tag.name == "interface":
if self.compiler.interf:
raise self.Error("Multiple <interface>s defined.")
interf = FupCompiler_Interf(self.compiler)
self.compiler.interf = interf
self.parser_switchTo(interf.factory(interf=interf))
return
if tag.name == "grids":
self.inGrids = True
return
else:
if tag.name == "FUP":
version = tag.getAttrInt("version")
if version != self.FUP_VERSION:
raise self.Error("Unsupported FUP version. "
"Got %d, but expected %d." % (
version, self.FUP_VERSION))
self.inFup = True
return
XmlFactory.parser_beginTag(self, tag)
def parser_endTag(self, tag):
if self.inFup:
if self.inGrids:
if tag.name == "grids":
self.inGrids = False
return
else:
if tag.name == "FUP":
self.inFup = False
self.parser_finish()
return
XmlFactory.parser_endTag(self, tag)
class FupCompiler(object):
# Convert U to UN and vice versa.
invertedInsnClass = {
AwlInsn_UN : AwlInsn_U,
AwlInsn_UNB : AwlInsn_UB,
AwlInsn_ON : AwlInsn_O,
AwlInsn_ONB : AwlInsn_OB,
AwlInsn_XN : AwlInsn_X,
AwlInsn_XNB : AwlInsn_XB,
}
invertedInsnClass.update(pivotDict(invertedInsnClass))
# Convert U to UB and vice versa.
branchInsnClass = {
AwlInsn_UB : AwlInsn_U,
AwlInsn_UNB : AwlInsn_UN,
AwlInsn_OB : AwlInsn_O,
AwlInsn_ONB : AwlInsn_ON,
AwlInsn_XB : AwlInsn_X,
AwlInsn_XNB : AwlInsn_XN,
}
branchInsnClass.update(pivotDict(branchInsnClass))
def __init__(self):
self.reset()
def reset(self):
self.mnemonics = None
self.symTab = SymbolTable()
self.opTrans = None
self.decl = None # FupCompiler_BlockDecl
self.interf = None # FupCompiler_Interf
self.grids = [] # FupCompiler_Grid
self.blockHeaderAwl = [] # Block declaration header AWL code strings
self.blockFooterAwl = [] # Block declaration footer AWL code strings
self.blockInterfAwl = [] # Block interface AWL code strings
self.instanceDBsAwl = [] # Instance DBs AWL code strings
self.fupSource = None # FUP source
self.awlSource = None # Compiled AWL source
self.optimizerSettingsContainer = None
self.__labelCounter = 0 # Current label name counter
def getAwlSource(self):
return self.awlSource
def newLabel(self):
"""Generate a new block-unique label.
A label name string is returned.
The name does not include the final ':' character.
"""
labelMax = 0xFFF
labelCounter = self.__labelCounter
if labelCounter > labelMax:
raise FupCompilerError("Out of jump labels. "
"Cannot create more than %d labels." % (
labelMax))
self.__labelCounter += 1
return "L%03X" % labelCounter
def newInsn(self, parentFupElem, insnClass, ops=[],
labelStr=None, parentFupConn=None):
"""Create a new instruction instance.
parentFupElem: The FUP element that creates this insn.
insnClass: The class that shall be instantiated.
ops: Optional list of operators.
labelStr: Optional label name string for this instruction.
parentFupConn: Optional FUP connection this insn belongs to.
If the connection is given, parentFupElem will
also be overriden by parentFupConn.elem.
"""
if parentFupConn and parentFupConn.elem:
parentFupElem = parentFupConn.elem
insn = insnClass(cpu=None, ops=ops)
if labelStr:
insn.labelStr = labelStr
if parentFupElem:
insn.commentStr = str(parentFupElem)
connType = AwlInsnParentInfo.CONNTYPE_NONE
connIndex = -1
if parentFupConn:
if parentFupConn.dirIn and parentFupConn.dirOut:
connType = AwlInsnParentInfo.CONNTYPE_INOUT
connIndex = parentFupConn.pos
elif parentFupConn.dirIn:
connType = AwlInsnParentInfo.CONNTYPE_IN
connIndex = parentFupConn.pos
elif parentFupConn.dirOut:
connType = AwlInsnParentInfo.CONNTYPE_OUT
connIndex = parentFupConn.pos
insn.parentInfo = AwlInsnParentInfo(
uuid=parentFupElem.uuid,
connType=connType,
connIndex=connIndex)
return insn
def newInsn_INLINEAWL(self, parentFupElem, awlCodeStr):
insn = AwlInsn_INLINE_AWL(cpu=None, awlCodeStr=awlCodeStr)
if parentFupElem:
insn.commentStr = str(parentFupElem)
return insn
def newInsn_JMP(self, parentFupElem, insnClass,
targetLabelStr, labelStr=None,
parentFupConn=None):
"""Create a new jump instruction instance.
parentFupElem: The FUP element that creates this insn.
insnClass: The jump instruction class that shall be instantiated.
targetLabelStr: The label name string of the jump target.
labelStr: Optional label name string of this jump insn.
"""
oper = make_AwlOperator(AwlOperatorTypes.LBL_REF, 0, None, None)
oper.immediateStr = targetLabelStr
return self.newInsn(parentFupElem=parentFupElem,
insnClass=insnClass,
ops=[oper],
labelStr=labelStr,
parentFupConn=parentFupConn)
def newInsn_NOP(self, parentFupElem, labelStr, parentFupConn=None):
"""Create a new jump instruction instance.
parentFupElem: The FUP element that creates this insn.
labelStr: Optional label name string.
"""
oper = make_AwlOperator(AwlOperatorTypes.IMM, 16, None, None)
oper.immediate = 0
return self.newInsn(parentFupElem, AwlInsn_NOP, ops=[oper],
labelStr=labelStr,
parentFupConn=parentFupConn)
def newInsn_LOAD_BIE(self, parentFupElem, insnClass, parentFupConn=None):
"""Create a new BIE load instruction instance.
parentFupElem: The FUP element that creates this insn.
insnClass: The loadinstruction class that shall be instantiated (i.e. U)
"""
bitPos = S7StatusWord.getBitnrByName("BIE", S7CPUConfig.MNEMONICS_DE)
offset = make_AwlOffset(0, bitPos)
oper = make_AwlOperator(AwlOperatorTypes.MEM_STW, 1, offset, None)
return self.newInsn(parentFupElem, insnClass, ops=[oper],
parentFupConn=parentFupConn)
def newInsns_SET_BIE_CLR_ER(self, parentFupElem, parentFupConn=None):
"""Create instructions to set BIE and clear /ER.
The instructions will clobber VKE.
parentFupElem: The FUP element that creates this insn.
"""
labelStr = self.newLabel()
# Add instruction to SET VKE.
insns = [ self.newInsn(parentFupElem,
AwlInsn_SET,
parentFupConn=parentFupConn) ]
# Add jump instruction that copies VKE to BIE.
# This jump _never_ actually jumps, because VKE is 1.
# The jump instruction also resets /ER to 0.
insns.append(self.newInsn_JMP(parentFupElem,
AwlInsn_SPBNB,
targetLabelStr=labelStr,
labelStr=labelStr,
parentFupConn=parentFupConn))
return insns
def newInsn_L_STW(self, parentFupElem, parentFupConn=None):
"""Create a new L STW instruction instance.
parentFupElem: The FUP element that creates this insn.
"""
oper = make_AwlOperator(AwlOperatorTypes.MEM_STW, 16,
make_AwlOffset(0, 0), None)
return self.newInsn(parentFupElem, AwlInsn_L, ops=[oper],
parentFupConn=parentFupConn)
def newInsn_T_STW(self, parentFupElem, parentFupConn=None):
"""Create a new T STW instruction instance.
parentFupElem: The FUP element that creates this insn.
"""
oper = make_AwlOperator(AwlOperatorTypes.MEM_STW, 16,
make_AwlOffset(0, 0), None)
return self.newInsn(parentFupElem, AwlInsn_T, ops=[oper],
parentFupConn=parentFupConn)
def newInsn_SRD(self, parentFupElem, count=None, parentFupConn=None):
"""Create a new SRD instruction instance.
parentFupElem: The FUP element that creates this insn.
count: The shift count (or None).
"""
if count is None:
ops = []
else:
oper = make_AwlOperator(AwlOperatorTypes.IMM, 16, None, None)
oper.immediate = count
ops = [oper]
return self.newInsn(parentFupElem, AwlInsn_SRD, ops=ops,
parentFupConn=parentFupConn)
def getOperDataWidth(self, oper):
"""Helper function to get the data type width (in bits)
of an operator. This will first attempt to resolve the operator,
if it is symbolic.
"""
from awlsim.core.datatypes import AwlDataType
if oper.width > 0:
return oper.width
if oper.operType == AwlOperatorTypes.NAMED_LOCAL:
# Get the type of an interface field
# and return its bit width.
fieldName = str(oper.offset.identChain)
field = self.interf.getFieldByName(fieldName)
if not field:
raise FupCompilerError("Interface field "
"'#%s' could not be found in the "
"declared interface." % (
fieldName))
dataType = AwlDataType.makeByName(field.typeStr)
if dataType:
return dataType.width
elif oper.operType == AwlOperatorTypes.SYMBOLIC:
# Get the type of a classic symbolic operator
# and return its bit width.
fieldName = str(oper.offset.identChain)
symbol = self.symTab.findByName(fieldName)
if not symbol:
raise FupCompilerError("The symbolic operator "
"\"%s\" not found in symbol tables." % (
fieldName))
dataType = symbol.getType()
if dataType:
return dataType.width
return 0
def __parse(self):
try:
return FupCompilerFactory(compiler=self).parse(
self.fupSource.sourceBytes)
except FupCompilerFactory.Error as e:
raise FupCompilerError("Failed to parse FUP source: "
"%s" % str(e))
def __genAwlCode(self, insns):
"""Generate AWL code from a list of instructions.
Returns bytes encoded as AwlSource.ENCODING.
"""
awl = []
# Create header
awl.extend(self.blockHeaderAwl)
awl.extend(self.blockInterfAwl)
# Create instructions body
awl.append("BEGIN")
fakeCpu = FupFakeCpu()
fakeCpu.fupCompiler = self
for insn in insns:
insn.cpu = fakeCpu
awl.append(insn.getStr(compact=False,
withSemicolon=True,
withComment=True))
# Create footer
awl.extend(self.blockFooterAwl)
# Create the instance DBs
awl.extend(self.instanceDBsAwl or [])
return ('\r\n'.join(awl) + '\r\n').encode(AwlSource.ENCODING)
def __compileBlockDecl(self):
"""Compile block declaration.
"""
self.blockHeaderAwl, self.blockFooterAwl, self.instanceDBsAwl =\
self.decl.compile(self.interf)
def __compileInterface(self):
"""Compile block interface.
"""
self.blockInterfAwl = self.interf.compile()
def __compileGrids(self):
"""Compile all self.grids
"""
allInsns = []
for i, grid in enumerate(self.grids):
# Compile the grid
insns = grid.compile()
if i >= len(self.grids) - 1:
insns.append(AwlInsn_BE(cpu=None))
# Optimize the generated instructions
if self.optimizerSettingsContainer is None:
optSettCont = grid.optimizerSettingsContainer
else:
optSettCont = self.optimizerSettingsContainer
optimizer = AwlOptimizer(settingsContainer=optSettCont)
insns = optimizer.optimizeInsns(
insns,
infoStr=str(self.fupSource))
allInsns.extend(insns)
return allInsns
def __trycompile(self,
fupSource,
symTabSources,
mnemonics,
optimizerSettingsContainer=None):
self.reset()
self.fupSource = fupSource
self.mnemonics = mnemonics
self.optimizerSettingsContainer = optimizerSettingsContainer
self.opTrans = AwlOpTranslator(mnemonics=mnemonics)
self.symTab.clear()
for symTabSrc in symTabSources:
tab = SymTabParser.parseSource(symTabSrc,
autodetectFormat=True,
mnemonics=mnemonics)
self.symTab.merge(tab, overrideExisting=True)
name = "%s (Compiled from FUP/FBD source)" % fupSource.name
self.awlSource = AwlSource(name=name,
enabled=fupSource.enabled,
filepath=fupSource.filepath)
if self.__parse():
self.__compileBlockDecl()
insns = self.__compileGrids()
self.__compileInterface()
# Store the AWL code in the AWL source object.
self.awlSource.sourceBytes = self.__genAwlCode(insns)
return self.getAwlSource()
def compile(self,
fupSource,
symTabSources,
mnemonics,
optimizerSettingsContainer=None):
"""Compile a FupSource.
fupSource: FUP source to compile.
symTabSources: List of symbol table sources.
mnemonics: Either MNEMONICS_EN, MNEMONICS_DE or MNEMONICS_AUTO.
optimizerSettingsContainer: AwlOptimizerSettingsContainer() instance.
Returns an AwlSource.
"""
if mnemonics == S7CPUConfig.MNEMONICS_AUTO:
try:
return self.__trycompile(fupSource,
symTabSources,
S7CPUConfig.MNEMONICS_EN,
optimizerSettingsContainer)
except AwlSimError as e:
pass
return self.__trycompile(fupSource,
symTabSources,
S7CPUConfig.MNEMONICS_DE,
optimizerSettingsContainer)
return self.__trycompile(fupSource,
symTabSources,
mnemonics,
optimizerSettingsContainer)
def generateCallTemplate(self):
"""Generate template AWL code for a CALL operation
to this block.
Returns an AwlSource.
"""
if not self.fupSource:
raise FupCompilerError("FUP/FBD source is not compiled.")
awlLines = []
awlLines.extend(self.decl.generateCallTemplate())
paramLines = self.interf.generateCallTemplate()
if paramLines:
awlLines[-1] += " ("
awlLines.extend(paramLines)
awlLines.append("\t)")
awlString = "\r\n".join(awlLines)
awlSource = AwlSource(name=("CALL " + self.fupSource.name))
awlSource.sourceBytes = awlString.encode(AwlSource.ENCODING)
return awlSource
def __repr__(self):
return "FupCompiler()"
def __str__(self):
return "FUP-compiler"
|