summaryrefslogtreecommitdiffstats
path: root/awlsim/fupcompiler/elemshift.py
blob: 78c331f5cee28c868dfaaea01f20548411cae863 (plain)
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
# -*- coding: utf-8 -*-
#
# AWL simulator - FUP compiler - Shift operations
#
# Copyright 2017-2018 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.fupcompiler.elem import *
from awlsim.fupcompiler.elemoper import *
from awlsim.fupcompiler.elembool import *
from awlsim.fupcompiler.helpers import *

from awlsim.core.operators import * #+cimport
from awlsim.core.operatortypes import * #+cimport

from awlsim.core.instructions.all_insns import * #+cimport


class FupCompiler_ElemShift(FupCompiler_Elem):
	"""FUP compiler - Shift operation.
	"""

	ELEM_NAME		= "SHIFT"
	SUBTYPE			= None # Override this in the subclass
	SHIFT_INSN_CLASS	= None # Override this in the subclass

	EnumGen.start
	SUBTYPE_SSI		= EnumGen.item
	SUBTYPE_SSD		= EnumGen.item
	SUBTYPE_SLW		= EnumGen.item
	SUBTYPE_SRW		= EnumGen.item
	SUBTYPE_SLD		= EnumGen.item
	SUBTYPE_SRD		= EnumGen.item
	SUBTYPE_RRD		= EnumGen.item
	SUBTYPE_RLD		= EnumGen.item
	EnumGen.end

	str2subtype = {
		"ssi"	: SUBTYPE_SSI,
		"ssd"	: SUBTYPE_SSD,
		"slw"	: SUBTYPE_SLW,
		"srw"	: SUBTYPE_SRW,
		"sld"	: SUBTYPE_SLD,
		"srd"	: SUBTYPE_SRD,
		"rrd"	: SUBTYPE_RRD,
		"rld"	: SUBTYPE_RLD,
	}

	@classmethod
	def parse(cls, grid, x, y, subType, content):
		try:
			subType = cls.str2subtype[subType]
			type2class = {
				cls.SUBTYPE_SSI	: FupCompiler_ElemShiftSSI,
				cls.SUBTYPE_SSD	: FupCompiler_ElemShiftSSD,
				cls.SUBTYPE_SLW	: FupCompiler_ElemShiftSLW,
				cls.SUBTYPE_SRW	: FupCompiler_ElemShiftSRW,
				cls.SUBTYPE_SLD	: FupCompiler_ElemShiftSLD,
				cls.SUBTYPE_SRD	: FupCompiler_ElemShiftSRD,
				cls.SUBTYPE_RRD	: FupCompiler_ElemShiftRRD,
				cls.SUBTYPE_RLD	: FupCompiler_ElemShiftRLD,
			}
			elemClass = None
			with contextlib.suppress(KeyError):
				elemClass = type2class[subType]
			if elemClass:
				return elemClass(grid=grid, x=x, y=y,
						 content=content)
		except KeyError:
			pass
		return None

	def __init__(self, grid, x, y, content, **kwargs):
		FupCompiler_Elem.__init__(self, grid=grid, x=x, y=y,
					  elemType=FupCompiler_Elem.TYPE_SHIFT,
					  subType=self.SUBTYPE,
					  content=content,
					  **kwargs)

	def connIsOptional(self, conn):
		if not self.enabled:
			return True
		return conn.hasText({ "EN", "ENO", "LOB", })

	def getConnType(self, conn, preferVKE=False):
		if self.enabled and conn in self.connections:
			if conn.hasText({ "EN", "ENO", "LOB", }):
				return FupCompiler_Conn.TYPE_VKE
			return FupCompiler_Conn.TYPE_ACCU
		return FupCompiler_Conn.TYPE_UNKNOWN

	def __getConnsEN(self):
		"""Get EN and ENO connections.
		"""
		conn_EN = self.getUniqueConnByText("EN", searchInputs=True)
		conn_ENO = self.getUniqueConnByText("ENO", searchOutputs=True)
		if not conn_EN or not conn_ENO:
			raise FupElemError("Invalid EN or ENO connections "
				"in FUP element %s." % (
				str(self)),
				self)
		return conn_EN, conn_ENO

	def __getConnsIN(self):
		"""Get IN and N connections.
		"""
		conn_IN = self.getUniqueConnByText("IN", searchInputs=True)
		conn_N = self.getUniqueConnByText("N", searchInputs=True)
		if not conn_IN or not conn_N:
			raise FupElemError("Invalid IN or N connections "
				"in FUP element %s." % (
				str(self)),
				self)
		return conn_IN, conn_N

	def __getConnFlag(self, connName):
		conn = self.getUniqueConnByText(connName, searchOutputs=True)
		if conn and conn.isConnected:
			return conn
		return None

	def __allConnsOUT(self):
		"""Get all OUTx connections.
		"""
		for conn in FupCompiler_Conn.sorted(self.outConnections):
			if conn.textMatch(r"OUT\d+"):
				yield conn

	def compileConn(self, conn, desiredTarget, inverted=False):
		if not self.enabled:
			return []
		insns = []
		assert(conn in self.connections)

		awlInsnClass = FupCompiler_Conn.targetToInsnClass(desiredTarget,
								  toLoad=True,
								  inverted=inverted)

		if conn.hasText("ENO"):
			self._compileConn_checkTarget(conn, desiredTarget, inverted,
						      targetExpectVKE=True,
						      allowInversion=True)
			if self.needCompile:
				insns.extend(self.compile())
				if inverted:
					insns.append(self.newInsn(AwlInsn_NOT))
			else:
				insns.extend(conn.elem._loadFromTemp(awlInsnClass, conn))
		elif conn.hasText("LOB"):
			self._compileConn_checkTarget(conn, desiredTarget, inverted,
						      targetExpectVKE=True,
						      allowInversion=False)
			if self.needCompile:
				insns.extend(self.compile())
			insns.extend(conn.elem._loadFromTemp(awlInsnClass, conn))
		elif conn.textMatch(r"OUT\d+"):
			self._compileConn_checkTarget(conn, desiredTarget, inverted,
						      targetExpectVKE=False,
						      allowInversion=False)
			if self.needCompile:
				insns.extend(self.compile())
			insns.extend(conn.elem._loadFromTemp(awlInsnClass, conn))
		else:
			return FupCompiler_Elem.compileConn(self, conn, desiredTarget, inverted)
		return insns

	def _doPreprocess(self):
		if not self.enabled:
			return
		# If the element connected to IN is not a LOAD operand, we must
		# take its ENO into account.
		# If we don't have a connection on EN, we implicitly connect
		# the IN-element's ENO to our EN here.
		# If we already have a connection on EN, we implicitly add an AND-element
		# between the IN-element's ENO and our EN.
		elemsA = []
		for conn in self.__getConnsIN():
			connectedElem = conn.getConnectedElem(viaOut=True)
			if not connectedElem.isType(FupCompiler_Elem.TYPE_OPERAND,
						    FupCompiler_ElemOper.SUBTYPE_LOAD):
				elemsA.append(connectedElem)
		FupCompiler_Helpers.genIntermediateBool(
				parentElem=self,
				elemsA=elemsA,
				connNamesA=(["ENO"] * len(elemsA)),
				elemB=self,
				connNameB="EN",
				boolElemClass=FupCompiler_ElemBoolAnd)

	def _doCompile(self):
		if not self.enabled:
			return []
		insns = []

		conn_EN, conn_ENO = self.__getConnsEN()

		# Compile all elements connected to IN connections.
		for conn in self.__getConnsIN():
			connectedElem = conn.getConnectedElem(viaOut=True)
			# Only compile the element, if it is not a plain LOAD box.
			if connectedElem.needCompile and\
			   not connectedElem.isType(FupCompiler_Elem.TYPE_OPERAND,
						    FupCompiler_ElemOper.SUBTYPE_LOAD):
				insns.extend(connectedElem.compile())

		# Generate a jump target label name for the EN jump.
		# This might end up being unused, though.
		endLabel = self.grid.compiler.newLabel()

		# If we have an EN input, emit the corresponding conditional jump.
		# If EN is not a plain operator, this might involve compiling
		# the connected element.
		if conn_EN.isConnected:
			# Compile the element that drives this wire.
			otherConn = conn_EN.getConnectedConn(getOutput=True)
			insns.extend(otherConn.compileConn(targetInsnClass=AwlInsn_U,
							   inverted=False))

			# Emit the jump instruction.
			# This will evaluate the current VKE.
			insns.append(self.newInsn_JMP(AwlInsn_SPBNB, endLabel))

		# Compile the actual operation.
		conn_IN, conn_N = self.__getConnsIN()
		for conn in (conn_N, conn_IN):
			otherConn = conn.getConnectedConn(getOutput=True)
			otherElem = otherConn.elem

			# Compile the element connected to the input.
			insns.extend(otherConn.compileConn(targetInsnClass=AwlInsn_L))
			if otherConn.connType != FupCompiler_Conn.TYPE_ACCU:
				raise FupElemError("The IN connection "
					"of the FUP element %s must not be connected "
					"to a bit (VKE) wire." % (
					str(self)),
					self)
		# Add the shift operation.
		insns.append(self.newInsn(self.SHIFT_INSN_CLASS))

		# Assign the outputs.
		storeToTempConns = set()
		for conn in self.__allConnsOUT():
			for otherElem in self.sorted(conn.getConnectedElems(viaIn=True)):
				if otherElem.isType(FupCompiler_Elem.TYPE_OPERAND,
						    FupCompiler_ElemOper.SUBTYPE_ASSIGN):
					insns.extend(otherElem.emitStore_ACCU())
				else:
					storeToTempConns.add(conn)
		if storeToTempConns:
			storeToTempConns.add(self.MAIN_RESULT)
			insns.extend(self._storeToTemp("DWORD", AwlInsn_T, storeToTempConns))

		# Check if any of the flags outputs is used.
		anyFlagConnected = any(bool(self.__getConnFlag(name))
				       for name in {"LOB", })

		# Make sure BIE is set, if EN is not connected and ENO is connected.
		if not conn_EN.isConnected and conn_ENO.isConnected:
			# set BIE=1 and /ER=0.
			insns.extend(self.newInsns_SET_BIE_CLR_ER())

		# Create the jump target label for EN=0.
		# This might end up being unused, though.
		insns.append(self.newInsn_NOP(labelStr=endLabel))

		# Compile flags outputs.
		if anyFlagConnected:
			insns.extend(FupCompiler_Helpers.genSTWOutputOper(self,
					conn=self.__getConnFlag("LOB"),
					andWithBIE=conn_EN.isConnected,
					operType=AwlOperatorTypes.MEM_STW_NZ))

		# Handle ENO output.
		if conn_ENO.isConnected:
			# Add instruction:  U BIE
			insns.append(self.newInsn_LOAD_BIE(AwlInsn_U))

			# Add VKE assignment instruction.
			storeToTempConns = set()
			for otherElem in self.sorted(conn_ENO.getConnectedElems(viaIn=True)):
				if otherElem.isType(FupCompiler_Elem.TYPE_OPERAND,
						    FupCompiler_ElemOper.SUBTYPE_ASSIGN):
					insns.extend(otherElem.emitStore_VKE())
				else:
					storeToTempConns.add(conn_ENO)
			if storeToTempConns:
				insns.extend(self._storeToTemp("BOOL", AwlInsn_ASSIGN,
							       storeToTempConns))

		return insns

class FupCompiler_ElemShiftSSI(FupCompiler_ElemShift):
	"""FUP compiler - Shift operation - SSI
	"""

	ELEM_NAME		= "SSI"
	SUBTYPE			= FupCompiler_ElemShift.SUBTYPE_SSI
	SHIFT_INSN_CLASS	= AwlInsn_SSI

class FupCompiler_ElemShiftSSD(FupCompiler_ElemShift):
	"""FUP compiler - Shift operation - SSD
	"""

	ELEM_NAME		= "SSD"
	SUBTYPE			= FupCompiler_ElemShift.SUBTYPE_SSD
	SHIFT_INSN_CLASS	= AwlInsn_SSD

class FupCompiler_ElemShiftSLW(FupCompiler_ElemShift):
	"""FUP compiler - Shift operation - SLW
	"""

	ELEM_NAME		= "SLW"
	SUBTYPE			= FupCompiler_ElemShift.SUBTYPE_SLW
	SHIFT_INSN_CLASS	= AwlInsn_SLW

class FupCompiler_ElemShiftSRW(FupCompiler_ElemShift):
	"""FUP compiler - Shift operation - SRW
	"""

	ELEM_NAME		= "SRW"
	SUBTYPE			= FupCompiler_ElemShift.SUBTYPE_SRW
	SHIFT_INSN_CLASS	= AwlInsn_SRW

class FupCompiler_ElemShiftSLD(FupCompiler_ElemShift):
	"""FUP compiler - Shift operation - SLD
	"""

	ELEM_NAME		= "SLD"
	SUBTYPE			= FupCompiler_ElemShift.SUBTYPE_SLD
	SHIFT_INSN_CLASS	= AwlInsn_SLD

class FupCompiler_ElemShiftSRD(FupCompiler_ElemShift):
	"""FUP compiler - Shift operation - SRD
	"""

	ELEM_NAME		= "SRD"
	SUBTYPE			= FupCompiler_ElemShift.SUBTYPE_SRD
	SHIFT_INSN_CLASS	= AwlInsn_SRD

class FupCompiler_ElemShiftRLD(FupCompiler_ElemShift):
	"""FUP compiler - Shift operation - RLD
	"""

	ELEM_NAME		= "RLD"
	SUBTYPE			= FupCompiler_ElemShift.SUBTYPE_RLD
	SHIFT_INSN_CLASS	= AwlInsn_RLD

class FupCompiler_ElemShiftRRD(FupCompiler_ElemShift):
	"""FUP compiler - Shift operation - RRD
	"""

	ELEM_NAME		= "RRD"
	SUBTYPE			= FupCompiler_ElemShift.SUBTYPE_RRD
	SHIFT_INSN_CLASS	= AwlInsn_RRD
bues.ch cgit interface