backend_open62541_nodes.py 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460
  1. #!/usr/bin/env python
  2. # -*- coding: utf-8 -*-
  3. ###
  4. ### Author: Chris Iatrou (ichrispa@core-vector.net)
  5. ### Version: rev 13
  6. ###
  7. ### This program was created for educational purposes and has been
  8. ### contributed to the open62541 project by the author. All licensing
  9. ### terms for this source is inherited by the terms and conditions
  10. ### specified for by the open62541 project (see the projects readme
  11. ### file for more information on the LGPL terms and restrictions).
  12. ###
  13. ### This program is not meant to be used in a production environment. The
  14. ### author is not liable for any complications arising due to the use of
  15. ### this program.
  16. ###
  17. from nodes import *
  18. from backend_open62541_datatypes import *
  19. import re
  20. import logging
  21. logger = logging.getLogger(__name__)
  22. #################
  23. # Generate Code #
  24. #################
  25. def generateNodeIdPrintable(node):
  26. if isinstance(node.id, NodeId):
  27. CodePrintable = node.__class__.__name__ + "_" + str(node.id)
  28. else:
  29. CodePrintable = node.__class__.__name__ + "_unknown_nid"
  30. return re.sub('[^0-9a-z_]+', '_', CodePrintable.lower())
  31. def generateNodeValueInstanceName(node, parent, arrayIndex):
  32. return generateNodeIdPrintable(parent) + "_" + str(node.alias) + "_" + str(arrayIndex)
  33. def generateReferenceCode(reference):
  34. if reference.isForward:
  35. return "retVal |= UA_Server_addReference(server, %s, %s, %s, true);" % \
  36. (generateNodeIdCode(reference.source),
  37. generateNodeIdCode(reference.referenceType),
  38. generateExpandedNodeIdCode(reference.target))
  39. else:
  40. return "retVal |= UA_Server_addReference(server, %s, %s, %s, false);" % \
  41. (generateNodeIdCode(reference.source),
  42. generateNodeIdCode(reference.referenceType),
  43. generateExpandedNodeIdCode(reference.target))
  44. def generateReferenceTypeNodeCode(node):
  45. code = []
  46. code.append("UA_ReferenceTypeAttributes attr = UA_ReferenceTypeAttributes_default;")
  47. if node.isAbstract:
  48. code.append("attr.isAbstract = true;")
  49. if node.symmetric:
  50. code.append("attr.symmetric = true;")
  51. if node.inverseName != "":
  52. code.append("attr.inverseName = UA_LOCALIZEDTEXT(\"\", \"%s\");" % \
  53. node.inverseName)
  54. return code
  55. def generateObjectNodeCode(node):
  56. code = []
  57. code.append("UA_ObjectAttributes attr = UA_ObjectAttributes_default;")
  58. if node.eventNotifier:
  59. code.append("attr.eventNotifier = true;")
  60. return code
  61. def generateVariableNodeCode(node, nodeset, encode_binary_size):
  62. code = []
  63. codeCleanup = []
  64. codeGlobal = []
  65. code.append("UA_VariableAttributes attr = UA_VariableAttributes_default;")
  66. if node.historizing:
  67. code.append("attr.historizing = true;")
  68. code.append("attr.minimumSamplingInterval = %f;" % node.minimumSamplingInterval)
  69. code.append("attr.userAccessLevel = %d;" % node.userAccessLevel)
  70. code.append("attr.accessLevel = %d;" % node.accessLevel)
  71. # in order to be compatible with mostly OPC UA client
  72. # force valueRank = -1 for scalar VariableNode
  73. if node.valueRank == -2:
  74. node.valueRank = -1
  75. code.append("attr.valueRank = %d;" % node.valueRank)
  76. if node.valueRank > 0:
  77. code.append("attr.arrayDimensionsSize = %d;" % node.valueRank)
  78. code.append("UA_UInt32 arrayDimensions[{}];".format(node.valueRank))
  79. if len(node.arrayDimensions) == node.valueRank:
  80. for idx, v in enumerate(node.arrayDimensions):
  81. code.append("arrayDimensions[{}] = {};".format(idx, int(str(v))))
  82. else:
  83. for dim in range(0, node.valueRank):
  84. code.append("arrayDimensions[{}] = 0;".format(dim))
  85. code.append("attr.arrayDimensions = &arrayDimensions[0];")
  86. if node.dataType is not None:
  87. if isinstance(node.dataType, NodeId) and node.dataType.ns == 0 and node.dataType.i == 0:
  88. #BaseDataType
  89. dataTypeNode = nodeset.nodes[NodeId("i=24")]
  90. dataTypeNodeOpaque = nodeset.nodes[NodeId("i=24")]
  91. else:
  92. dataTypeNodeOpaque = nodeset.getDataTypeNode(node.dataType)
  93. dataTypeNode = nodeset.getBaseDataType(nodeset.getDataTypeNode(node.dataType))
  94. if dataTypeNode is not None:
  95. code.append("attr.dataType = %s;" % generateNodeIdCode(dataTypeNodeOpaque.id))
  96. if dataTypeNode.isEncodable():
  97. if node.value is not None:
  98. [code1, codeCleanup1, codeGlobal1] = generateValueCode(node.value, nodeset.nodes[node.id], nodeset)
  99. code += code1
  100. codeCleanup += codeCleanup1
  101. codeGlobal += codeGlobal1
  102. # #1978 Variant arrayDimensions are only required to properly decode multidimensional arrays
  103. # (valueRank >= 2) from data stored as one-dimensional array of arrayLength elements.
  104. # One-dimensional arrays are already completely defined by arraylength attribute so setting
  105. # also arrayDimensions, even if not explicitly forbidden, can confuse clients
  106. if node.valueRank > 1 and len(node.arrayDimensions) == node.valueRank:
  107. code.append("attr.value.arrayDimensionsSize = attr.arrayDimensionsSize;")
  108. code.append("attr.value.arrayDimensions = attr.arrayDimensions;")
  109. else:
  110. code += generateValueCodeDummy(dataTypeNode, nodeset.nodes[node.id], nodeset)
  111. else:
  112. #TODO: take a look on this
  113. #logger.error("cannot encode: " + node.browseName.name)
  114. pass
  115. return [code, codeCleanup, codeGlobal]
  116. def generateVariableTypeNodeCode(node, nodeset, encode_binary_size):
  117. code = []
  118. codeCleanup = []
  119. codeGlobal = []
  120. code.append("UA_VariableTypeAttributes attr = UA_VariableTypeAttributes_default;")
  121. if node.historizing:
  122. code.append("attr.historizing = true;")
  123. if node.isAbstract:
  124. code.append("attr.isAbstract = true;")
  125. code.append("attr.valueRank = (UA_Int32)%s;" % str(node.valueRank))
  126. if node.dataType is not None:
  127. if isinstance(node.dataType, NodeId) and node.dataType.ns == 0 and node.dataType.i == 0:
  128. #BaseDataType
  129. dataTypeNode = nodeset.nodes[NodeId("i=24")]
  130. else:
  131. dataTypeNode = nodeset.getBaseDataType(nodeset.getDataTypeNode(node.dataType))
  132. if dataTypeNode is not None:
  133. code.append("attr.dataType = %s;" % generateNodeIdCode(dataTypeNode.id))
  134. if dataTypeNode.isEncodable():
  135. if node.value is not None:
  136. [code1, codeCleanup1, codeGlobal1] = generateValueCode(node.value, nodeset.nodes[node.id], nodeset)
  137. code += code1
  138. codeCleanup += codeCleanup1
  139. codeGlobal += codeGlobal1
  140. else:
  141. code += generateValueCodeDummy(dataTypeNode, nodeset.nodes[node.id], nodeset)
  142. return [code, codeCleanup, codeGlobal]
  143. def lowerFirstChar(inputString):
  144. return inputString[0].lower() + inputString[1:]
  145. def generateExtensionObjectSubtypeCode(node, parent, nodeset, global_var_code, instanceName=None, isArrayElement=False):
  146. code = [""]
  147. codeCleanup = [""]
  148. logger.debug("Building extensionObject for " + str(parent.id))
  149. logger.debug("Value " + str(node.value))
  150. logger.debug("Encoding " + str(node.encodingRule))
  151. # If there are any ExtensionObjects inside this ExtensionObject, we need to
  152. # generate one-time-structs for them too before we can proceed;
  153. for subv in node.value:
  154. if isinstance(subv, list):
  155. logger.error("ExtensionObject contains an ExtensionObject, which is currently not encodable!")
  156. return
  157. typeBrowseNode = makeCIdentifier(nodeset.getDataTypeNode(parent.dataType).browseName.name)
  158. #TODO: review this
  159. if typeBrowseNode == "NumericRange":
  160. # in the stack we define a separate structure for the numeric range, but
  161. # the value itself is just a string
  162. typeBrowseNode = "String"
  163. typeString = "UA_" + typeBrowseNode
  164. if instanceName is None:
  165. instanceName = generateNodeValueInstanceName(node, parent, 0)
  166. code.append("UA_STACKARRAY(" + typeString + ", " + instanceName + ", 1);")
  167. typeArr = nodeset.getDataTypeNode(parent.dataType).typesArray
  168. typeString = nodeset.getDataTypeNode(parent.dataType).browseName.name.upper()
  169. typeArrayString = typeArr + "[" + typeArr + "_" + typeString + "]"
  170. code.append("UA_init({ref}{instanceName}, &{typeArrayString});".format(ref="&" if isArrayElement else "",
  171. instanceName=instanceName,
  172. typeArrayString=typeArrayString))
  173. # Assign data to the struct contents
  174. # Track the encoding rule definition to detect arrays and/or ExtensionObjects
  175. encFieldIdx = 0
  176. for subv in node.value:
  177. encField = node.encodingRule[encFieldIdx]
  178. encFieldIdx = encFieldIdx + 1
  179. memberName= lowerFirstChar(encField[0])
  180. logger.debug(
  181. "Encoding of field " + memberName + " is " + str(subv.encodingRule) + "defined by " + str(encField))
  182. # Check if this is an array
  183. accessor = "." if isArrayElement else "->"
  184. if subv.valueRank is None or subv.valueRank == 0:
  185. valueName = instanceName + accessor + memberName
  186. code.append(generateNodeValueCode(valueName + " = " ,
  187. subv, instanceName,valueName, global_var_code, asIndirect=False))
  188. else:
  189. memberName = lowerFirstChar(encField[0])
  190. code.append(generateNodeValueCode(instanceName + accessor + memberName + "Size = ", subv, instanceName,valueName, global_var_code, asIndirect=False))
  191. if not isArrayElement:
  192. code.append("UA_Variant_setScalar(&attr.value, " + instanceName + ", &" + typeArrayString + ");")
  193. return [code, codeCleanup]
  194. def getTypeBrowseName(dataTypeNode):
  195. typeBrowseName = makeCIdentifier(dataTypeNode.browseName.name)
  196. #TODO: review this
  197. if typeBrowseName == "NumericRange":
  198. # in the stack we define a separate structure for the numeric range, but
  199. # the value itself is just a string
  200. typeBrowseName = "String"
  201. return typeBrowseName
  202. def generateValueCodeDummy(dataTypeNode, parentNode, nodeset):
  203. code = []
  204. valueName = generateNodeIdPrintable(parentNode) + "_variant_DataContents"
  205. typeBrowseName = getTypeBrowseName(dataTypeNode)
  206. typeArr = dataTypeNode.typesArray + "[" + dataTypeNode.typesArray + "_" + typeBrowseName.upper() + "]"
  207. typeStr = "UA_" + typeBrowseName
  208. if parentNode.valueRank > 0:
  209. for i in range(0, parentNode.valueRank):
  210. code.append("UA_Variant_setArray(&attr.value, NULL, (UA_Int32) " + "0, &" + typeArr + ");")
  211. elif not dataTypeNode.isAbstract:
  212. code.append("UA_STACKARRAY(" + typeStr + ", " + valueName + ", 1);")
  213. code.append("UA_init(" + valueName + ", &" + typeArr + ");")
  214. code.append("UA_Variant_setScalar(&attr.value, " + valueName + ", &" + typeArr + ");")
  215. return code
  216. def getTypesArrayForValue(nodeset, value):
  217. typeNode = nodeset.getNodeByBrowseName(value.__class__.__name__)
  218. if typeNode is None or value.isInternal:
  219. typesArray = "UA_TYPES"
  220. else:
  221. typesArray = typeNode.typesArray
  222. typeName = makeCIdentifier(value.__class__.__name__.upper())
  223. return "&" + typesArray + "[" + typesArray + "_" + typeName + "]"
  224. def isArrayVariableNode(node, parentNode):
  225. return parentNode.valueRank != -1 and (parentNode.valueRank >= 0
  226. or (len(node.value) > 1
  227. and (parentNode.valueRank != -2 or parentNode.valueRank != -3)))
  228. def generateValueCode(node, parentNode, nodeset, bootstrapping=True):
  229. code = []
  230. codeCleanup = []
  231. codeGlobal = []
  232. valueName = generateNodeIdPrintable(parentNode) + "_variant_DataContents"
  233. # node.value either contains a list of multiple identical BUILTINTYPES, or it
  234. # contains a single builtintype (which may be a container); choose if we need
  235. # to create an array or a single variable.
  236. # Note that some genious defined that there are arrays of size 1, which are
  237. # distinctly different then a single value, so we need to check that as well
  238. # Semantics:
  239. # -3: Scalar or 1-dim
  240. # -2: Scalar or x-dim | x>0
  241. # -1: Scalar
  242. # 0: x-dim | x>0
  243. # n: n-dim | n>0
  244. if (len(node.value) == 0):
  245. return ["", "", ""]
  246. if not isinstance(node.value[0], Value):
  247. return ["", "", ""]
  248. dataTypeNode = nodeset.getDataTypeNode(parentNode.dataType)
  249. if isArrayVariableNode(node, parentNode):
  250. # User the following strategy for all directly mappable values a la 'UA_Type MyInt = (UA_Type) 23;'
  251. if isinstance(node.value[0], Guid):
  252. logger.warn("Don't know how to print array of GUID in node " + str(parentNode.id))
  253. elif isinstance(node.value[0], DiagnosticInfo):
  254. logger.warn("Don't know how to print array of DiagnosticInfo in node " + str(parentNode.id))
  255. elif isinstance(node.value[0], StatusCode):
  256. logger.warn("Don't know how to print array of StatusCode in node " + str(parentNode.id))
  257. else:
  258. if isinstance(node.value[0], ExtensionObject):
  259. code.append("UA_" + getTypeBrowseName(dataTypeNode) + " " + valueName + "[" + str(len(node.value)) + "];")
  260. for idx, v in enumerate(node.value):
  261. logger.debug("Building extObj array index " + str(idx))
  262. instanceName = valueName + "[" + str(idx) + "]"
  263. [code1, codeCleanup1] = generateExtensionObjectSubtypeCode(v, parent=parentNode, nodeset=nodeset,
  264. global_var_code=codeGlobal, instanceName=instanceName,
  265. isArrayElement=True)
  266. code = code + code1
  267. codeCleanup = codeCleanup + codeCleanup1
  268. else:
  269. code.append("UA_" + node.value[0].__class__.__name__ + " " + valueName + "[" + str(len(node.value)) + "];")
  270. for idx, v in enumerate(node.value):
  271. instanceName = generateNodeValueInstanceName(v, parentNode, idx)
  272. code.append(generateNodeValueCode(
  273. valueName + "[" + str(idx) + "] = " , v, instanceName, valueName, codeGlobal))
  274. code.append("UA_Variant_setArray(&attr.value, &" + valueName +
  275. ", (UA_Int32) " + str(len(node.value)) + ", " + "&" +
  276. dataTypeNode.typesArray + "["+dataTypeNode.typesArray + "_" + getTypeBrowseName(dataTypeNode).upper() +"]);")
  277. #scalar value
  278. else:
  279. # User the following strategy for all directly mappable values a la 'UA_Type MyInt = (UA_Type) 23;'
  280. if isinstance(node.value[0], Guid):
  281. logger.warn("Don't know how to print scalar GUID in node " + str(parentNode.id))
  282. elif isinstance(node.value[0], DiagnosticInfo):
  283. logger.warn("Don't know how to print scalar DiagnosticInfo in node " + str(parentNode.id))
  284. elif isinstance(node.value[0], StatusCode):
  285. logger.warn("Don't know how to print scalar StatusCode in node " + str(parentNode.id))
  286. else:
  287. # The following strategy applies to all other types, in particular strings and numerics.
  288. if isinstance(node.value[0], ExtensionObject):
  289. [code1, codeCleanup1] = generateExtensionObjectSubtypeCode(node.value[0], parent=parentNode, nodeset=nodeset, global_var_code=codeGlobal, isArrayElement=False)
  290. code = code + code1
  291. codeCleanup = codeCleanup + codeCleanup1
  292. instanceName = generateNodeValueInstanceName(node.value[0], parentNode, 0)
  293. if not(isinstance(node.value[0], ExtensionObject)):
  294. code.append("UA_" + node.value[0].__class__.__name__ + " *" + valueName + " = UA_" + node.value[
  295. 0].__class__.__name__ + "_new();")
  296. code.append("if (!" + valueName + ") return UA_STATUSCODE_BADOUTOFMEMORY;")
  297. code.append(generateNodeValueCode("*" + valueName + " = " , node.value[0], instanceName, valueName, codeGlobal, asIndirect=True))
  298. code.append(
  299. "UA_Variant_setScalar(&attr.value, " + valueName + ", " +
  300. getTypesArrayForValue(nodeset, node.value[0]) + ");")
  301. if node.value[0].__class__.__name__ == "ByteString":
  302. # The data is on the stack, not heap, so we can not delete the ByteString
  303. codeCleanup.append("{}->data = NULL;".format(valueName))
  304. codeCleanup.append("{}->length = 0;".format(valueName))
  305. codeCleanup.append("UA_{0}_delete({1});".format(
  306. node.value[0].__class__.__name__, valueName))
  307. return [code, codeCleanup, codeGlobal]
  308. def generateMethodNodeCode(node):
  309. code = []
  310. code.append("UA_MethodAttributes attr = UA_MethodAttributes_default;")
  311. if node.executable:
  312. code.append("attr.executable = true;")
  313. if node.userExecutable:
  314. code.append("attr.userExecutable = true;")
  315. return code
  316. def generateObjectTypeNodeCode(node):
  317. code = []
  318. code.append("UA_ObjectTypeAttributes attr = UA_ObjectTypeAttributes_default;")
  319. if node.isAbstract:
  320. code.append("attr.isAbstract = true;")
  321. return code
  322. def generateDataTypeNodeCode(node):
  323. code = []
  324. code.append("UA_DataTypeAttributes attr = UA_DataTypeAttributes_default;")
  325. if node.isAbstract:
  326. code.append("attr.isAbstract = true;")
  327. return code
  328. def generateViewNodeCode(node):
  329. code = []
  330. code.append("UA_ViewAttributes attr = UA_ViewAttributes_default;")
  331. if node.containsNoLoops:
  332. code.append("attr.containsNoLoops = true;")
  333. code.append("attr.eventNotifier = (UA_Byte)%s;" % str(node.eventNotifier))
  334. return code
  335. def getNodeTypeDefinition(node):
  336. for ref in node.references:
  337. # 40 = HasTypeDefinition
  338. if ref.referenceType.i == 40:
  339. return ref.target
  340. return None
  341. def generateSubtypeOfDefinitionCode(node):
  342. for ref in node.inverseReferences:
  343. # 45 = HasSubtype
  344. if ref.referenceType.i == 45:
  345. return generateNodeIdCode(ref.target)
  346. return "UA_NODEID_NULL"
  347. def generateNodeCode_begin(node, nodeset, generate_ns0, parentref, encode_binary_size, code_global):
  348. code = []
  349. codeCleanup = []
  350. code.append("UA_StatusCode retVal = UA_STATUSCODE_GOOD;")
  351. # Attributes
  352. if isinstance(node, ReferenceTypeNode):
  353. code.extend(generateReferenceTypeNodeCode(node))
  354. elif isinstance(node, ObjectNode):
  355. code.extend(generateObjectNodeCode(node))
  356. elif isinstance(node, VariableNode) and not isinstance(node, VariableTypeNode):
  357. [code1, codeCleanup1, codeGlobal1] = generateVariableNodeCode(node, nodeset, encode_binary_size)
  358. code.extend(code1)
  359. codeCleanup.extend(codeCleanup1)
  360. code_global.extend(codeGlobal1)
  361. elif isinstance(node, VariableTypeNode):
  362. [code1, codeCleanup1, codeGlobal1] = generateVariableTypeNodeCode(node, nodeset, encode_binary_size)
  363. code.extend(code1)
  364. codeCleanup.extend(codeCleanup1)
  365. code_global.extend(codeGlobal1)
  366. elif isinstance(node, MethodNode):
  367. code.extend(generateMethodNodeCode(node))
  368. elif isinstance(node, ObjectTypeNode):
  369. code.extend(generateObjectTypeNodeCode(node))
  370. elif isinstance(node, DataTypeNode):
  371. code.extend(generateDataTypeNodeCode(node))
  372. elif isinstance(node, ViewNode):
  373. code.extend(generateViewNodeCode(node))
  374. code.append("attr.displayName = " + generateLocalizedTextCode(node.displayName, alloc=False) + ";")
  375. code.append("#ifdef UA_ENABLE_NODESET_COMPILER_DESCRIPTIONS")
  376. code.append("attr.description = " + generateLocalizedTextCode(node.description, alloc=False) + ";")
  377. code.append("#endif")
  378. code.append("attr.writeMask = %d;" % node.writeMask)
  379. code.append("attr.userWriteMask = %d;" % node.userWriteMask)
  380. # AddNodes call
  381. code.append("retVal |= UA_Server_addNode_begin(server, UA_NODECLASS_{},".
  382. format(makeCIdentifier(node.__class__.__name__.upper().replace("NODE" ,""))))
  383. code.append(generateNodeIdCode(node.id) + ",")
  384. code.append(generateNodeIdCode(parentref.target) + ",")
  385. code.append(generateNodeIdCode(parentref.referenceType) + ",")
  386. code.append(generateQualifiedNameCode(node.browseName) + ",")
  387. if isinstance(node, VariableNode) or isinstance(node, ObjectNode):
  388. typeDefRef = node.popTypeDef()
  389. code.append(generateNodeIdCode(typeDefRef.target) + ",")
  390. else:
  391. code.append(" UA_NODEID_NULL,")
  392. code.append("(const UA_NodeAttributes*)&attr, &UA_TYPES[UA_TYPES_{}ATTRIBUTES],NULL, NULL);".
  393. format(makeCIdentifier(node.__class__.__name__.upper().replace("NODE" ,""))))
  394. code.extend(codeCleanup)
  395. return "\n".join(code)
  396. def generateNodeCode_finish(node):
  397. code = []
  398. if isinstance(node, MethodNode):
  399. code.append("UA_Server_addMethodNode_finish(server, ")
  400. else:
  401. code.append("UA_Server_addNode_finish(server, ")
  402. code.append(generateNodeIdCode(node.id))
  403. if isinstance(node, MethodNode):
  404. code.append(", NULL, 0, NULL, 0, NULL);")
  405. else:
  406. code.append(");")
  407. return "\n".join(code)