-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
backend_open62541_nodes.py
476 lines (424 loc) · 22.5 KB
/
backend_open62541_nodes.py
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
#!/usr/bin/env python
# -*- coding: utf-8 -*-
###
### Author: Chris Iatrou (ichrispa@core-vector.net)
### Version: rev 13
###
### This program was created for educational purposes and has been
### contributed to the open62541 project by the author. All licensing
### terms for this source is inherited by the terms and conditions
### specified for by the open62541 project (see the projects readme
### file for more information on the LGPL terms and restrictions).
###
### This program is not meant to be used in a production environment. The
### author is not liable for any complications arising due to the use of
### this program.
###
from nodes import *
from backend_open62541_datatypes import *
import re
import logging
logger = logging.getLogger(__name__)
#################
# Generate Code #
#################
def generateNodeIdPrintable(node):
if isinstance(node.id, NodeId):
CodePrintable = node.__class__.__name__ + "_" + str(node.id)
else:
CodePrintable = node.__class__.__name__ + "_unknown_nid"
return re.sub('[^0-9a-z_]+', '_', CodePrintable.lower())
def generateNodeValueInstanceName(node, parent, arrayIndex):
return generateNodeIdPrintable(parent) + "_" + str(node.alias) + "_" + str(arrayIndex)
def generateReferenceCode(reference):
if reference.isForward:
return "retVal |= UA_Server_addReference(server, %s, %s, %s, true);" % \
(generateNodeIdCode(reference.source),
generateNodeIdCode(reference.referenceType),
generateExpandedNodeIdCode(reference.target))
else:
return "retVal |= UA_Server_addReference(server, %s, %s, %s, false);" % \
(generateNodeIdCode(reference.source),
generateNodeIdCode(reference.referenceType),
generateExpandedNodeIdCode(reference.target))
def generateReferenceTypeNodeCode(node):
code = []
code.append("UA_ReferenceTypeAttributes attr = UA_ReferenceTypeAttributes_default;")
if node.isAbstract:
code.append("attr.isAbstract = true;")
if node.symmetric:
code.append("attr.symmetric = true;")
if node.inverseName != "":
code.append("attr.inverseName = UA_LOCALIZEDTEXT(\"\", \"%s\");" % \
node.inverseName)
return code
def generateObjectNodeCode(node):
code = []
code.append("UA_ObjectAttributes attr = UA_ObjectAttributes_default;")
if node.eventNotifier:
code.append("attr.eventNotifier = true;")
return code
def generateVariableNodeCode(node, nodeset, encode_binary_size):
code = []
codeCleanup = []
codeGlobal = []
code.append("UA_VariableAttributes attr = UA_VariableAttributes_default;")
if node.historizing:
code.append("attr.historizing = true;")
code.append("attr.minimumSamplingInterval = %f;" % node.minimumSamplingInterval)
code.append("attr.userAccessLevel = %d;" % node.userAccessLevel)
code.append("attr.accessLevel = %d;" % node.accessLevel)
# in order to be compatible with mostly OPC UA client
# force valueRank = -1 for scalar VariableNode
if node.valueRank == -2:
node.valueRank = -1
code.append("attr.valueRank = %d;" % node.valueRank)
if node.valueRank > 0:
code.append("attr.arrayDimensionsSize = %d;" % node.valueRank)
code.append("UA_UInt32 arrayDimensions[{}];".format(node.valueRank))
if len(node.arrayDimensions) == node.valueRank:
for idx, v in enumerate(node.arrayDimensions):
code.append("arrayDimensions[{}] = {};".format(idx, int(str(v))))
else:
for dim in range(0, node.valueRank):
code.append("arrayDimensions[{}] = 0;".format(dim))
code.append("attr.arrayDimensions = &arrayDimensions[0];")
if node.dataType is not None:
if isinstance(node.dataType, NodeId) and node.dataType.ns == 0 and node.dataType.i == 0:
#BaseDataType
dataTypeNode = nodeset.nodes[NodeId("i=24")]
dataTypeNodeOpaque = nodeset.nodes[NodeId("i=24")]
else:
dataTypeNodeOpaque = nodeset.getDataTypeNode(node.dataType)
dataTypeNode = nodeset.getBaseDataType(nodeset.getDataTypeNode(node.dataType))
if dataTypeNode is not None:
code.append("attr.dataType = %s;" % generateNodeIdCode(dataTypeNodeOpaque.id))
if dataTypeNode.isEncodable():
if node.value is not None:
[code1, codeCleanup1, codeGlobal1] = generateValueCode(node.value, nodeset.nodes[node.id], nodeset)
code += code1
codeCleanup += codeCleanup1
codeGlobal += codeGlobal1
# #1978 Variant arrayDimensions are only required to properly decode multidimensional arrays
# (valueRank >= 2) from data stored as one-dimensional array of arrayLength elements.
# One-dimensional arrays are already completely defined by arraylength attribute so setting
# also arrayDimensions, even if not explicitly forbidden, can confuse clients
if node.valueRank > 1 and len(node.arrayDimensions) == node.valueRank:
code.append("attr.value.arrayDimensionsSize = attr.arrayDimensionsSize;")
code.append("attr.value.arrayDimensions = attr.arrayDimensions;")
else:
code += generateValueCodeDummy(dataTypeNode, nodeset.nodes[node.id], nodeset)
else:
#TODO: take a look on this
#logger.error("cannot encode: " + node.browseName.name)
pass
return [code, codeCleanup, codeGlobal]
def generateVariableTypeNodeCode(node, nodeset, encode_binary_size):
code = []
codeCleanup = []
codeGlobal = []
code.append("UA_VariableTypeAttributes attr = UA_VariableTypeAttributes_default;")
if node.historizing:
code.append("attr.historizing = true;")
if node.isAbstract:
code.append("attr.isAbstract = true;")
code.append("attr.valueRank = (UA_Int32)%s;" % str(node.valueRank))
if node.dataType is not None:
if isinstance(node.dataType, NodeId) and node.dataType.ns == 0 and node.dataType.i == 0:
#BaseDataType
dataTypeNode = nodeset.nodes[NodeId("i=24")]
else:
dataTypeNode = nodeset.getBaseDataType(nodeset.getDataTypeNode(node.dataType))
if dataTypeNode is not None:
code.append("attr.dataType = %s;" % generateNodeIdCode(dataTypeNode.id))
if dataTypeNode.isEncodable():
if node.value is not None:
[code1, codeCleanup1, codeGlobal1] = generateValueCode(node.value, nodeset.nodes[node.id], nodeset)
code += code1
codeCleanup += codeCleanup1
codeGlobal += codeGlobal1
else:
code += generateValueCodeDummy(dataTypeNode, nodeset.nodes[node.id], nodeset)
return [code, codeCleanup, codeGlobal]
def lowerFirstChar(inputString):
return inputString[0].lower() + inputString[1:]
def generateExtensionObjectSubtypeCode(node, parent, nodeset, global_var_code, instanceName=None, isArrayElement=False):
code = [""]
codeCleanup = [""]
logger.debug("Building extensionObject for " + str(parent.id))
logger.debug("Value " + str(node.value))
logger.debug("Encoding " + str(node.encodingRule))
typeBrowseNode = makeCIdentifier(nodeset.getDataTypeNode(parent.dataType).browseName.name)
#TODO: review this
if typeBrowseNode == "NumericRange":
# in the stack we define a separate structure for the numeric range, but
# the value itself is just a string
typeBrowseNode = "String"
typeString = "UA_" + typeBrowseNode
if instanceName is None:
instanceName = generateNodeValueInstanceName(node, parent, 0)
code.append("UA_STACKARRAY(" + typeString + ", " + instanceName + ", 1);")
typeArr = nodeset.getDataTypeNode(parent.dataType).typesArray
typeString = nodeset.getDataTypeNode(parent.dataType).browseName.name.upper()
typeArrayString = typeArr + "[" + typeArr + "_" + typeString + "]"
code.append("UA_init({ref}{instanceName}, &{typeArrayString});".format(ref="&" if isArrayElement else "",
instanceName=instanceName,
typeArrayString=typeArrayString))
# Assign data to the struct contents
# Track the encoding rule definition to detect arrays and/or ExtensionObjects
encFieldIdx = 0
for subv in node.value:
encField = node.encodingRule[encFieldIdx]
encFieldIdx = encFieldIdx + 1
memberName = lowerFirstChar(encField[0])
if isinstance(subv, list):
if len(subv) == 0:
continue
logger.info("ExtensionObject contains array")
memberName = lowerFirstChar(encField[0])
encTypeString = "UA_" + subv[0].__class__.__name__
code.append("UA_STACKARRAY(" + encTypeString + ", " + instanceName + "_" + memberName+", {0});".format(len(subv)))
encTypeArr = nodeset.getDataTypeNode(subv[0].__class__.__name__).typesArray
encTypeArrayString = encTypeArr + "[" + encTypeArr + "_" + subv[0].__class__.__name__.upper() + "]"
code.append("UA_init({ref}{instanceName}, &{typeArrayString});".format(ref="&" if isArrayElement else "",
instanceName=instanceName + "_" + memberName,
typeArrayString=encTypeArrayString))
subArrayIdx = 0
for val in subv:
code.append(generateNodeValueCode(instanceName + "_" + memberName + "[" + str(subArrayIdx) + "]" +" = ", val, instanceName,instanceName + "_gehtNed_member", global_var_code, asIndirect=False))
subArrayIdx = subArrayIdx + 1
code.append(instanceName + "->" + memberName + " = " + instanceName+"_"+ memberName+";")
continue
else:
logger.debug(
"Encoding of field " + memberName + " is " + str(subv.encodingRule) + "defined by " + str(encField))
# Check if this is an array
accessor = "." if isArrayElement else "->"
if subv.valueRank is None or subv.valueRank == 0:
valueName = instanceName + accessor + memberName
code.append(generateNodeValueCode(valueName + " = " ,
subv, instanceName,valueName, global_var_code, asIndirect=False))
else:
memberName = lowerFirstChar(encField[0])
code.append(generateNodeValueCode(instanceName + accessor + memberName + "Size = ", subv, instanceName,valueName, global_var_code, asIndirect=False))
if not isArrayElement:
code.append("UA_Variant_setScalar(&attr.value, " + instanceName + ", &" + typeArrayString + ");")
return [code, codeCleanup]
def getTypeBrowseName(dataTypeNode):
typeBrowseName = makeCIdentifier(dataTypeNode.browseName.name)
#TODO: review this
if typeBrowseName == "NumericRange":
# in the stack we define a separate structure for the numeric range, but
# the value itself is just a string
typeBrowseName = "String"
return typeBrowseName
def generateValueCodeDummy(dataTypeNode, parentNode, nodeset):
code = []
valueName = generateNodeIdPrintable(parentNode) + "_variant_DataContents"
typeBrowseName = getTypeBrowseName(dataTypeNode)
typeArr = dataTypeNode.typesArray + "[" + dataTypeNode.typesArray + "_" + typeBrowseName.upper() + "]"
typeStr = "UA_" + typeBrowseName
if parentNode.valueRank > 0:
for i in range(0, parentNode.valueRank):
code.append("UA_Variant_setArray(&attr.value, NULL, (UA_Int32) " + "0, &" + typeArr + ");")
elif not dataTypeNode.isAbstract:
code.append("UA_STACKARRAY(" + typeStr + ", " + valueName + ", 1);")
code.append("UA_init(" + valueName + ", &" + typeArr + ");")
code.append("UA_Variant_setScalar(&attr.value, " + valueName + ", &" + typeArr + ");")
return code
def getTypesArrayForValue(nodeset, value):
typeNode = nodeset.getNodeByBrowseName(value.__class__.__name__)
if typeNode is None or value.isInternal:
typesArray = "UA_TYPES"
else:
typesArray = typeNode.typesArray
typeName = makeCIdentifier(value.__class__.__name__.upper())
return "&" + typesArray + "[" + typesArray + "_" + typeName + "]"
def isArrayVariableNode(node, parentNode):
return parentNode.valueRank != -1 and (parentNode.valueRank >= 0
or (len(node.value) > 1
and (parentNode.valueRank != -2 or parentNode.valueRank != -3)))
def generateValueCode(node, parentNode, nodeset, bootstrapping=True):
code = []
codeCleanup = []
codeGlobal = []
valueName = generateNodeIdPrintable(parentNode) + "_variant_DataContents"
# node.value either contains a list of multiple identical BUILTINTYPES, or it
# contains a single builtintype (which may be a container); choose if we need
# to create an array or a single variable.
# Note that some genious defined that there are arrays of size 1, which are
# distinctly different then a single value, so we need to check that as well
# Semantics:
# -3: Scalar or 1-dim
# -2: Scalar or x-dim | x>0
# -1: Scalar
# 0: x-dim | x>0
# n: n-dim | n>0
if (len(node.value) == 0):
return ["", "", ""]
if not isinstance(node.value[0], Value):
return ["", "", ""]
dataTypeNode = nodeset.getDataTypeNode(parentNode.dataType)
if isArrayVariableNode(node, parentNode):
# User the following strategy for all directly mappable values a la 'UA_Type MyInt = (UA_Type) 23;'
if isinstance(node.value[0], Guid):
logger.warn("Don't know how to print array of GUID in node " + str(parentNode.id))
elif isinstance(node.value[0], DiagnosticInfo):
logger.warn("Don't know how to print array of DiagnosticInfo in node " + str(parentNode.id))
elif isinstance(node.value[0], StatusCode):
logger.warn("Don't know how to print array of StatusCode in node " + str(parentNode.id))
else:
if isinstance(node.value[0], ExtensionObject):
code.append("UA_" + getTypeBrowseName(dataTypeNode) + " " + valueName + "[" + str(len(node.value)) + "];")
for idx, v in enumerate(node.value):
logger.debug("Building extObj array index " + str(idx))
instanceName = valueName + "[" + str(idx) + "]"
[code1, codeCleanup1] = generateExtensionObjectSubtypeCode(v, parent=parentNode, nodeset=nodeset,
global_var_code=codeGlobal, instanceName=instanceName,
isArrayElement=True)
code = code + code1
codeCleanup = codeCleanup + codeCleanup1
else:
code.append("UA_" + node.value[0].__class__.__name__ + " " + valueName + "[" + str(len(node.value)) + "];")
for idx, v in enumerate(node.value):
instanceName = generateNodeValueInstanceName(v, parentNode, idx)
code.append(generateNodeValueCode(
valueName + "[" + str(idx) + "] = " , v, instanceName, valueName, codeGlobal))
code.append("UA_Variant_setArray(&attr.value, &" + valueName +
", (UA_Int32) " + str(len(node.value)) + ", " + "&" +
dataTypeNode.typesArray + "["+dataTypeNode.typesArray + "_" + getTypeBrowseName(dataTypeNode).upper() +"]);")
#scalar value
else:
# User the following strategy for all directly mappable values a la 'UA_Type MyInt = (UA_Type) 23;'
if isinstance(node.value[0], Guid):
logger.warn("Don't know how to print scalar GUID in node " + str(parentNode.id))
elif isinstance(node.value[0], DiagnosticInfo):
logger.warn("Don't know how to print scalar DiagnosticInfo in node " + str(parentNode.id))
elif isinstance(node.value[0], StatusCode):
logger.warn("Don't know how to print scalar StatusCode in node " + str(parentNode.id))
else:
# The following strategy applies to all other types, in particular strings and numerics.
if isinstance(node.value[0], ExtensionObject):
[code1, codeCleanup1] = generateExtensionObjectSubtypeCode(node.value[0], parent=parentNode, nodeset=nodeset, global_var_code=codeGlobal, isArrayElement=False)
code = code + code1
codeCleanup = codeCleanup + codeCleanup1
instanceName = generateNodeValueInstanceName(node.value[0], parentNode, 0)
if not(isinstance(node.value[0], ExtensionObject)):
code.append("UA_" + node.value[0].__class__.__name__ + " *" + valueName + " = UA_" + node.value[
0].__class__.__name__ + "_new();")
code.append("if (!" + valueName + ") return UA_STATUSCODE_BADOUTOFMEMORY;")
code.append(generateNodeValueCode("*" + valueName + " = " , node.value[0], instanceName, valueName, codeGlobal, asIndirect=True))
code.append(
"UA_Variant_setScalar(&attr.value, " + valueName + ", " +
getTypesArrayForValue(nodeset, node.value[0]) + ");")
if node.value[0].__class__.__name__ == "ByteString":
# The data is on the stack, not heap, so we can not delete the ByteString
codeCleanup.append("{}->data = NULL;".format(valueName))
codeCleanup.append("{}->length = 0;".format(valueName))
codeCleanup.append("UA_{0}_delete({1});".format(
node.value[0].__class__.__name__, valueName))
return [code, codeCleanup, codeGlobal]
def generateMethodNodeCode(node):
code = []
code.append("UA_MethodAttributes attr = UA_MethodAttributes_default;")
if node.executable:
code.append("attr.executable = true;")
if node.userExecutable:
code.append("attr.userExecutable = true;")
return code
def generateObjectTypeNodeCode(node):
code = []
code.append("UA_ObjectTypeAttributes attr = UA_ObjectTypeAttributes_default;")
if node.isAbstract:
code.append("attr.isAbstract = true;")
return code
def generateDataTypeNodeCode(node):
code = []
code.append("UA_DataTypeAttributes attr = UA_DataTypeAttributes_default;")
if node.isAbstract:
code.append("attr.isAbstract = true;")
return code
def generateViewNodeCode(node):
code = []
code.append("UA_ViewAttributes attr = UA_ViewAttributes_default;")
if node.containsNoLoops:
code.append("attr.containsNoLoops = true;")
code.append("attr.eventNotifier = (UA_Byte)%s;" % str(node.eventNotifier))
return code
def getNodeTypeDefinition(node):
for ref in node.references:
# 40 = HasTypeDefinition
if ref.referenceType.i == 40:
return ref.target
return None
def generateSubtypeOfDefinitionCode(node):
for ref in node.inverseReferences:
# 45 = HasSubtype
if ref.referenceType.i == 45:
return generateNodeIdCode(ref.target)
return "UA_NODEID_NULL"
def generateNodeCode_begin(node, nodeset, generate_ns0, parentref, encode_binary_size, code_global):
code = []
codeCleanup = []
code.append("UA_StatusCode retVal = UA_STATUSCODE_GOOD;")
# Attributes
if isinstance(node, ReferenceTypeNode):
code.extend(generateReferenceTypeNodeCode(node))
elif isinstance(node, ObjectNode):
code.extend(generateObjectNodeCode(node))
elif isinstance(node, VariableNode) and not isinstance(node, VariableTypeNode):
[code1, codeCleanup1, codeGlobal1] = generateVariableNodeCode(node, nodeset, encode_binary_size)
code.extend(code1)
codeCleanup.extend(codeCleanup1)
code_global.extend(codeGlobal1)
elif isinstance(node, VariableTypeNode):
[code1, codeCleanup1, codeGlobal1] = generateVariableTypeNodeCode(node, nodeset, encode_binary_size)
code.extend(code1)
codeCleanup.extend(codeCleanup1)
code_global.extend(codeGlobal1)
elif isinstance(node, MethodNode):
code.extend(generateMethodNodeCode(node))
elif isinstance(node, ObjectTypeNode):
code.extend(generateObjectTypeNodeCode(node))
elif isinstance(node, DataTypeNode):
code.extend(generateDataTypeNodeCode(node))
elif isinstance(node, ViewNode):
code.extend(generateViewNodeCode(node))
if node.displayName is not None:
code.append("attr.displayName = " + generateLocalizedTextCode(node.displayName, alloc=False) + ";")
if node.description is not None:
code.append("#ifdef UA_ENABLE_NODESET_COMPILER_DESCRIPTIONS")
code.append("attr.description = " + generateLocalizedTextCode(node.description, alloc=False) + ";")
code.append("#endif")
if node.writeMask is not None:
code.append("attr.writeMask = %d;" % node.writeMask)
if node.userWriteMask is not None:
code.append("attr.userWriteMask = %d;" % node.userWriteMask)
# AddNodes call
code.append("retVal |= UA_Server_addNode_begin(server, UA_NODECLASS_{},".
format(makeCIdentifier(node.__class__.__name__.upper().replace("NODE" ,""))))
code.append(generateNodeIdCode(node.id) + ",")
code.append(generateNodeIdCode(parentref.target) + ",")
code.append(generateNodeIdCode(parentref.referenceType) + ",")
code.append(generateQualifiedNameCode(node.browseName) + ",")
if isinstance(node, VariableNode) or isinstance(node, ObjectNode):
typeDefRef = node.popTypeDef()
code.append(generateNodeIdCode(typeDefRef.target) + ",")
else:
code.append(" UA_NODEID_NULL,")
code.append("(const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_{}ATTRIBUTES],NULL, NULL);".
format(makeCIdentifier(node.__class__.__name__.upper().replace("NODE" ,""))))
code.extend(codeCleanup)
return "\n".join(code)
def generateNodeCode_finish(node):
code = []
if isinstance(node, MethodNode):
code.append("UA_Server_addMethodNode_finish(server, ")
else:
code.append("UA_Server_addNode_finish(server, ")
code.append(generateNodeIdCode(node.id))
if isinstance(node, MethodNode):
code.append(", NULL, 0, NULL, 0, NULL);")
else:
code.append(");")
return "\n".join(code)