1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
|
# -*- coding: utf-8 -*-
#
# AWL simulator - PLC core server messages
#
# Copyright 2013 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.core.compat import *
from awlsim.coreserver.memarea import *
from awlsim.core.util import *
from awlsim.core.cpuspecs import *
import struct
import socket
import errno
class TransferError(Exception):
pass
class AwlSimMessage(object):
# Header format:
# Magic (16 bit)
# Message ID (16 bit)
# Sequence count (16 bit)
# Reserved (16 bit)
# Payload length (32 bit)
# Payload (optional)
hdrStruct = struct.Struct(str(">HHHHI"))
HDR_MAGIC = 0x5710
HDR_LENGTH = hdrStruct.size
EnumGen.start
MSG_ID_REPLY = EnumGen.item # Generic status reply
MSG_ID_EXCEPTION = EnumGen.item
MSG_ID_PING = EnumGen.item
MSG_ID_PONG = EnumGen.item
MSG_ID_RESET = EnumGen.item
MSG_ID_RUNSTATE = EnumGen.item
MSG_ID_LOAD_SYMTAB = EnumGen.item
MSG_ID_LOAD_CODE = EnumGen.item
MSG_ID_LOAD_HW = EnumGen.item
MSG_ID_SET_OPT = EnumGen.item
MSG_ID_CPUDUMP = EnumGen.item
MSG_ID_MAINTREQ = EnumGen.item
MSG_ID_GET_CPUSPECS = EnumGen.item
MSG_ID_CPUSPECS = EnumGen.item
MSG_ID_REQ_MEMORY = EnumGen.item
MSG_ID_MEMORY = EnumGen.item
EnumGen.end
_strLenStruct = struct.Struct(str(">H"))
@classmethod
def packString(cls, string):
try:
data = string.encode("utf-8", "strict")
return cls._strLenStruct.pack(len(data)) + data
except (UnicodeError, struct.error) as e:
raise ValueError
@classmethod
def unpackString(cls, data, offset = 0):
try:
(length, ) = cls._strLenStruct.unpack_from(data, offset)
strBytes = data[offset + cls._strLenStruct.size :
offset + cls._strLenStruct.size + length]
if len(strBytes) != length:
raise ValueError
return (strBytes.decode("utf-8", "strict"),
cls._strLenStruct.size + length)
except (UnicodeError, struct.error) as e:
raise ValueError
def __init__(self, msgId, seq=0):
self.msgId = msgId
self.seq = seq
def toBytes(self, payloadLength=0):
return self.hdrStruct.pack(self.HDR_MAGIC,
self.msgId,
self.seq,
0,
payloadLength)
@classmethod
def fromBytes(cls, payload):
return cls()
class AwlSimMessage_REPLY(AwlSimMessage):
EnumGen.start
STAT_OK = EnumGen.item
STAT_FAIL = EnumGen.item
EnumGen.end
plStruct = struct.Struct(str(">HHH"))
@classmethod
def make(cls, inReplyToMsg, status):
return cls(inReplyToMsg.msgId, inReplyToMsg.seq, status)
def __init__(self, inReplyToId, inReplyToSeq, status):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_REPLY)
self.inReplyToId = inReplyToId
self.inReplyToSeq = inReplyToSeq
self.status = status
def toBytes(self):
pl = self.plStruct.pack(self.inReplyToId,
self.inReplyToSeq,
self.status)
return AwlSimMessage.toBytes(self, len(pl)) + pl
@classmethod
def fromBytes(cls, payload):
try:
inReplyToId, inReplyToSeq, status =\
cls.plStruct.unpack(payload)
except struct.error as e:
raise TransferError("REPLY: Invalid data format")
return cls(inReplyToId, inReplyToSeq, status)
class AwlSimMessage_PING(AwlSimMessage):
def __init__(self):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_PING)
class AwlSimMessage_PONG(AwlSimMessage):
def __init__(self):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_PONG)
class AwlSimMessage_RESET(AwlSimMessage):
def __init__(self):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_RESET)
class AwlSimMessage_RUNSTATE(AwlSimMessage):
EnumGen.start
STATE_STOP = EnumGen.item
STATE_RUN = EnumGen.item
EnumGen.end
plStruct = struct.Struct(str(">H"))
def __init__(self, runState):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_RUNSTATE)
self.runState = runState
def toBytes(self):
pl = self.plStruct.pack(self.runState)
return AwlSimMessage.toBytes(self, len(pl)) + pl
@classmethod
def fromBytes(cls, payload):
try:
(runState, ) = cls.plStruct.unpack(payload)
except struct.error as e:
raise TransferError("RUNSTATE: Invalid data format")
return cls(runState)
class AwlSimMessage_EXCEPTION(AwlSimMessage):
def __init__(self, exceptionText):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_EXCEPTION)
self.exceptionText = exceptionText
def toBytes(self):
try:
textBytes = self.exceptionText.encode()
return AwlSimMessage.toBytes(self, len(textBytes)) + textBytes
except UnicodeError:
raise TransferError("EXCEPTION: Unicode error")
@classmethod
def fromBytes(cls, payload):
try:
text = payload.decode()
except UnicodeError:
raise TransferError("EXCEPTION: Unicode error")
return cls(text)
class AwlSimMessage_LOAD_SYMTAB(AwlSimMessage):
def __init__(self, symTabText):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_LOAD_SYMTAB)
self.symTabText = symTabText
def toBytes(self):
try:
data = self.symTabText.encode()
return AwlSimMessage.toBytes(self, len(data)) + data
except UnicodeError:
raise TransferError("LOAD_SYMTAB: Unicode error")
@classmethod
def fromBytes(cls, payload):
try:
symTabText = payload.decode()
except UnicodeError:
raise TransferError("LOAD_SYMTAB: Unicode error")
return cls(symTabText)
class AwlSimMessage_LOAD_CODE(AwlSimMessage):
def __init__(self, code):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_LOAD_CODE)
self.code = code
def toBytes(self):
try:
code = self.code.encode()
return AwlSimMessage.toBytes(self, len(code)) + code
except UnicodeError:
raise TransferError("LOAD_CODE: Unicode error")
@classmethod
def fromBytes(cls, payload):
try:
code = payload.decode()
except UnicodeError:
raise TransferError("LOAD_CODE: Unicode error")
return cls(code)
class AwlSimMessage_LOAD_HW(AwlSimMessage):
def __init__(self, name, paramDict):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_LOAD_HW)
self.name = name
self.paramDict = paramDict
def toBytes(self):
payload = b""
try:
payload += self.packString(self.name)
for pname, pval in self.paramDict.items():
payload += self.packString(pname)
payload += self.packString(pval)
return AwlSimMessage.toBytes(self, len(payload)) + payload
except (ValueError) as e:
raise TransferError("LOAD_HW: Invalid data format")
@classmethod
def fromBytes(cls, payload):
paramDict = {}
offset = 0
try:
name, count = cls.unpackString(payload, offset)
offset += count
while offset < len(payload):
pname, count = cls.unpackString(payload, offset)
offset += count
pval, count = cls.unpackString(payload, offset)
offset += count
paramDict[pname] = pval
except (ValueError) as e:
raise TransferError("LOAD_HW: Invalid data format")
return cls(name = name, paramDict = paramDict)
class AwlSimMessage_SET_OPT(AwlSimMessage):
def __init__(self, name, value):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_SET_OPT)
self.name = name
self.value = value
def getIntValue(self):
try:
return int(self.value)
except ValueError as e:
raise AwlSimError("SET_OPT: Value is not an integer")
def getBoolValue(self):
try:
return bool(self.value)
except ValueError as e:
raise AwlSimError("SET_OPT: Value is not a boolean")
def getFloatValue(self):
try:
return float(self.value)
except ValueError as e:
raise AwlSimError("SET_OPT: Value is not a float")
def toBytes(self):
try:
payload = self.packString(self.name)
payload += self.packString(self.value)
except ValueError as e:
raise TransferError("SET_OPT: Invalid data format")
return AwlSimMessage.toBytes(self, len(payload)) + payload
@classmethod
def fromBytes(cls, payload):
try:
offset = 0
name, count = cls.unpackString(payload, offset)
offset += count
value, count = cls.unpackString(payload, offset)
offset += count
except ValueError as e:
raise TransferError("SET_OPT: Invalid data format")
return cls(name = name, value = value)
class AwlSimMessage_CPUDUMP(AwlSimMessage):
def __init__(self, dumpText):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_CPUDUMP)
self.dumpText = dumpText
def toBytes(self):
try:
dumpBytes = self.dumpText.encode()
return AwlSimMessage.toBytes(self, len(dumpBytes)) + dumpBytes
except UnicodeError:
raise TransferError("CPUDUMP: Unicode error")
@classmethod
def fromBytes(cls, payload):
try:
dumpText = payload.decode()
except UnicodeError:
raise TransferError("CPUDUMP: Unicode error")
return cls(dumpText)
class AwlSimMessage_MAINTREQ(AwlSimMessage):
plStruct = struct.Struct(str(">H"))
def __init__(self, requestType):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_MAINTREQ)
self.requestType = requestType
def toBytes(self):
pl = self.plStruct.pack(self.requestType)
return AwlSimMessage.toBytes(self, len(pl)) + pl
@classmethod
def fromBytes(cls, payload):
try:
(requestType, ) = cls.plStruct.unpack(payload)
except struct.error as e:
raise TransferError("MAINTREQ: Invalid data format")
return cls(requestType)
class AwlSimMessage_GET_CPUSPECS(AwlSimMessage):
def __init__(self):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_GET_CPUSPECS)
class AwlSimMessage_CPUSPECS(AwlSimMessage):
plStruct = struct.Struct(str(">32I"))
def __init__(self, cpuspecs):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_CPUSPECS)
self.cpuspecs = cpuspecs
self.cpuspecs.cpu = None
def toBytes(self):
pl = self.plStruct.pack(self.cpuspecs.getConfiguredMnemonics(),
self.cpuspecs.nrAccus,
self.cpuspecs.nrTimers,
self.cpuspecs.nrCounters,
self.cpuspecs.nrFlags,
self.cpuspecs.nrInputs,
self.cpuspecs.nrOutputs,
self.cpuspecs.nrLocalbytes,
*( (0,) * 24 ) # padding
)
return AwlSimMessage.toBytes(self, len(pl)) + pl
@classmethod
def fromBytes(cls, payload):
try:
data = cls.plStruct.unpack(payload)
(mnemonics, nrAccus, nrTimers,
nrCounters, nrFlags, nrInputs,
nrOutputs, nrLocalbytes) = data[:8]
except struct.error as e:
raise TransferError("CPUSPECS: Invalid data format")
cpuspecs = S7CPUSpecs()
cpuspecs.setConfiguredMnemonics(mnemonics)
cpuspecs.setNrAccus(nrAccus)
cpuspecs.setNrTimers(nrTimers)
cpuspecs.setNrCounters(nrCounters)
cpuspecs.setNrFlags(nrFlags)
cpuspecs.setNrInputs(nrInputs)
cpuspecs.setNrOutputs(nrOutputs)
cpuspecs.setNrLocalbytes(nrLocalbytes)
return cls(cpuspecs)
class AwlSimMessage_REQ_MEMORY(AwlSimMessage):
# Payload header struct:
# flags (32 bit)
# repetition factor (32 bit)
plHdrStruct = struct.Struct(str(">II"))
# Payload memory area struct:
# memType (8 bit)
# flags (8 bit)
# index (16 bit)
# start (32 bit)
# length (32 bit)
plAreaStruct = struct.Struct(str(">BBHII"))
# Flags
FLG_SYNC = 1 << 0 # Synchronous. Returns a REPLY when finished.
def __init__(self, flags, repetitionFactor, memAreas):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_REQ_MEMORY)
self.flags = flags
self.repetitionFactor = repetitionFactor
self.memAreas = memAreas
def toBytes(self):
pl = self.plHdrStruct.pack(self.flags,
self.repetitionFactor)
for memArea in self.memAreas:
pl += self.plAreaStruct.pack(memArea.memType,
memArea.flags,
memArea.index,
memArea.start,
memArea.length)
return AwlSimMessage.toBytes(self, len(pl)) + pl
@classmethod
def fromBytes(cls, payload):
try:
offset = 0
flags, repetitionFactor =\
cls.plHdrStruct.unpack_from(payload, offset)
offset += cls.plHdrStruct.size
memAreas = []
while offset < len(payload):
memType, mFlags, index, start, length =\
cls.plAreaStruct.unpack_from(payload, offset)
offset += cls.plAreaStruct.size
memAreas.append(MemoryArea(memType, mFlags, index, start, length))
except struct.error as e:
raise TransferError("REQ_MEMORY: Invalid data format")
return cls(flags, repetitionFactor, memAreas)
class AwlSimMessage_MEMORY(AwlSimMessage):
# Payload header struct:
# flags (32 bit)
plHdrStruct = struct.Struct(str(">I"))
# Payload memory area struct:
# memType (8 bit)
# flags (8 bit)
# index (16 bit)
# start (32 bit)
# length (32 bit)
# the actual binary data (variable length)
plAreaStruct = struct.Struct(str(">BBHII"))
# Flags
FLG_SYNC = 1 << 0 # Synchronous. Returns a REPLY when finished.
def __init__(self, flags, memAreas):
AwlSimMessage.__init__(self, AwlSimMessage.MSG_ID_MEMORY)
self.flags = flags
self.memAreas = memAreas
def toBytes(self):
pl = [ self.plHdrStruct.pack(self.flags) ]
for memArea in self.memAreas:
pl.append(self.plAreaStruct.pack(memArea.memType,
memArea.flags,
memArea.index,
memArea.start,
len(memArea.data)))
pl.append(memArea.data) #FIXME padding to 32bit?
pl = b''.join(pl)
return AwlSimMessage.toBytes(self, len(pl)) + pl
@classmethod
def fromBytes(cls, payload):
try:
offset = 0
(flags, ) = cls.plHdrStruct.unpack_from(payload, offset)
offset += cls.plHdrStruct.size
memAreas = []
while offset < len(payload):
memType, mFlags, index, start, length =\
cls.plAreaStruct.unpack_from(payload, offset)
offset += cls.plAreaStruct.size
#FIXME pad length to 32bit?
data = payload[offset : offset + length]
offset += length
if len(data) != length:
raise IndexError
memAreas.append(MemoryArea(memType, mFlags, index,
start, length, data))
except (struct.error, IndexError) as e:
raise TransferError("MEMORY: Invalid data format")
return cls(flags, memAreas)
class AwlSimMessageTransceiver(object):
class RemoteEndDied(Exception): pass
id2class = {
AwlSimMessage.MSG_ID_REPLY : AwlSimMessage_REPLY,
AwlSimMessage.MSG_ID_EXCEPTION : AwlSimMessage_EXCEPTION,
AwlSimMessage.MSG_ID_PING : AwlSimMessage_PING,
AwlSimMessage.MSG_ID_PONG : AwlSimMessage_PONG,
AwlSimMessage.MSG_ID_RESET : AwlSimMessage_RESET,
AwlSimMessage.MSG_ID_RUNSTATE : AwlSimMessage_RUNSTATE,
AwlSimMessage.MSG_ID_LOAD_SYMTAB : AwlSimMessage_LOAD_SYMTAB,
AwlSimMessage.MSG_ID_LOAD_CODE : AwlSimMessage_LOAD_CODE,
AwlSimMessage.MSG_ID_LOAD_HW : AwlSimMessage_LOAD_HW,
AwlSimMessage.MSG_ID_SET_OPT : AwlSimMessage_SET_OPT,
AwlSimMessage.MSG_ID_CPUDUMP : AwlSimMessage_CPUDUMP,
AwlSimMessage.MSG_ID_MAINTREQ : AwlSimMessage_MAINTREQ,
AwlSimMessage.MSG_ID_GET_CPUSPECS : AwlSimMessage_GET_CPUSPECS,
AwlSimMessage.MSG_ID_CPUSPECS : AwlSimMessage_CPUSPECS,
AwlSimMessage.MSG_ID_REQ_MEMORY : AwlSimMessage_REQ_MEMORY,
AwlSimMessage.MSG_ID_MEMORY : AwlSimMessage_MEMORY,
}
def __init__(self, sock):
self.sock = sock
# Transmit status
self.txSeqCount = 0
# Receive buffer
self.buf = b""
self.msgId = None
self.seq = None
self.payloadLen = None
self.sock.setblocking(False)
def shutdown(self):
if self.sock:
try:
self.sock.shutdown(socket.SHUT_RDWR)
except socket.error as e:
pass
try:
self.sock.close()
except socket.error as e:
pass
self.sock = None
def send(self, msg):
msg.seq = self.txSeqCount
self.txSeqCount = (self.txSeqCount + 1) & 0xFFFF
offset, data = 0, msg.toBytes()
while offset < len(data):
try:
offset += self.sock.send(data[offset : ])
except socket.error as e:
if e.errno != errno.EAGAIN:
raise TransferError(str(e))
def receive(self):
hdrLen = AwlSimMessage.HDR_LENGTH
if len(self.buf) < hdrLen:
data = self.sock.recv(hdrLen - len(self.buf))
if not data:
# The remote end closed the connection
raise self.RemoteEndDied()
self.buf += data
if len(self.buf) < hdrLen:
return None
try:
magic, self.msgId, self.seq, _reserved, self.payloadLen =\
AwlSimMessage.hdrStruct.unpack(self.buf)
except struct.error as e:
raise AwlSimError("Received message with invalid "
"header format.")
if magic != AwlSimMessage.HDR_MAGIC:
raise AwlSimError("Received message with invalid "
"magic value (was 0x%04X, expected 0x%04X)." %\
(magic, AwlSimMessage.HDR_MAGIC))
if self.payloadLen:
return None
if len(self.buf) < hdrLen + self.payloadLen:
data = self.sock.recv(hdrLen + self.payloadLen - len(self.buf))
if not data:
# The remote end closed the connection
raise self.RemoteEndDied()
self.buf += data
if len(self.buf) < hdrLen + self.payloadLen:
return None
try:
cls = self.id2class[self.msgId]
except KeyError:
raise AwlSimError("Received unknown message: 0x%04X" %\
self.msgId)
msg = cls.fromBytes(self.buf[hdrLen : ])
msg.seq = self.seq
self.buf, self.msgId, self.seq, self.payloadLen = b"", None, None, None
return msg
def receiveBlocking(self, timeoutSec=None):
try:
self.sock.settimeout(timeoutSec)
msg = self.receive()
except socket.timeout:
return None
finally:
self.sock.setblocking(False)
return msg
|