backend_open62541.py 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306
  1. #!/usr/bin/env/python
  2. # -*- coding: utf-8 -*-
  3. ###
  4. ### Authors:
  5. ### - Chris Iatrou (ichrispa@core-vector.net)
  6. ### - Julius Pfrommer
  7. ### - Stefan Profanter (profanter@fortiss.org)
  8. ###
  9. ### This program was created for educational purposes and has been
  10. ### contributed to the open62541 project by the author. All licensing
  11. ### terms for this source is inherited by the terms and conditions
  12. ### specified for by the open62541 project (see the projects readme
  13. ### file for more information on the LGPL terms and restrictions).
  14. ###
  15. ### This program is not meant to be used in a production environment. The
  16. ### author is not liable for any complications arising due to the use of
  17. ### this program.
  18. ###
  19. from __future__ import print_function
  20. import string
  21. from os.path import basename
  22. import logging
  23. import codecs
  24. try:
  25. from StringIO import StringIO
  26. except ImportError:
  27. from io import StringIO
  28. logger = logging.getLogger(__name__)
  29. from constants import *
  30. from nodes import *
  31. from nodeset import *
  32. from backend_open62541_nodes import generateNodeCode_begin, generateNodeCode_finish, generateReferenceCode
  33. # Kahn's algorithm: https://algocoding.wordpress.com/2015/04/05/topological-sorting-python/
  34. def sortNodes(nodeset):
  35. # Ensure that every reference has an inverse reference in the target
  36. for u in nodeset.nodes.values():
  37. for ref in u.references:
  38. back = Reference(ref.target, ref.referenceType, ref.source, not ref.isForward)
  39. nodeset.nodes[ref.target].references.add(back) # ref set does not make a duplicate entry
  40. # reverse hastypedefinition references to treat only forward references
  41. hasTypeDef = NodeId("ns=0;i=40")
  42. for u in nodeset.nodes.values():
  43. for ref in u.references:
  44. if ref.referenceType == hasTypeDef:
  45. ref.isForward = not ref.isForward
  46. # Only hierarchical types...
  47. relevant_refs = nodeset.getRelevantOrderingReferences()
  48. # determine in-degree of unfulfilled references
  49. L = [node for node in nodeset.nodes.values() if node.hidden] # ordered list of nodes
  50. R = {node.id: node for node in nodeset.nodes.values() if not node.hidden} # remaining nodes
  51. in_degree = {id: 0 for id in R.keys()}
  52. for u in R.values(): # for each node
  53. for ref in u.references:
  54. if not ref.referenceType in relevant_refs:
  55. continue
  56. if nodeset.nodes[ref.target].hidden:
  57. continue
  58. if ref.isForward:
  59. continue
  60. in_degree[u.id] += 1
  61. # Print ReferenceType and DataType nodes first. They may be required even
  62. # though there is no reference to them. For example if the referencetype is
  63. # used in a reference, it must exist. A Variable node may point to a
  64. # DataTypeNode in the datatype attribute and not via an explicit reference.
  65. Q = {node for node in R.values() if in_degree[node.id] == 0 and
  66. (isinstance(node, ReferenceTypeNode) or isinstance(node, DataTypeNode))}
  67. while Q:
  68. u = Q.pop() # choose node of zero in-degree and 'remove' it from graph
  69. L.append(u)
  70. del R[u.id]
  71. for ref in u.references:
  72. if not ref.referenceType in relevant_refs:
  73. continue
  74. if nodeset.nodes[ref.target].hidden:
  75. continue
  76. if not ref.isForward:
  77. continue
  78. in_degree[ref.target] -= 1
  79. if in_degree[ref.target] == 0:
  80. Q.add(R[ref.target])
  81. # Order the remaining nodes
  82. Q = {node for node in R.values() if in_degree[node.id] == 0}
  83. while Q:
  84. u = Q.pop() # choose node of zero in-degree and 'remove' it from graph
  85. L.append(u)
  86. del R[u.id]
  87. for ref in u.references:
  88. if not ref.referenceType in relevant_refs:
  89. continue
  90. if nodeset.nodes[ref.target].hidden:
  91. continue
  92. if not ref.isForward:
  93. continue
  94. in_degree[ref.target] -= 1
  95. if in_degree[ref.target] == 0:
  96. Q.add(R[ref.target])
  97. # reverse hastype references
  98. for u in nodeset.nodes.values():
  99. for ref in u.references:
  100. if ref.referenceType == hasTypeDef:
  101. ref.isForward = not ref.isForward
  102. if len(L) != len(nodeset.nodes.values()):
  103. print(len(L))
  104. stillOpen = ""
  105. for id in in_degree:
  106. if in_degree[id] == 0:
  107. continue
  108. node = nodeset.nodes[id]
  109. stillOpen += node.browseName.name + "/" + str(node.id) + " = " + str(in_degree[id]) + \
  110. " " + str(node.references) + "\r\n"
  111. raise Exception("Node graph is circular on the specified references. Still open nodes:\r\n" + stillOpen)
  112. return L
  113. ###################
  114. # Generate C Code #
  115. ###################
  116. def generateOpen62541Code(nodeset, outfilename, generate_ns0=False, internal_headers=False, typesArray=[], max_string_length=0, encode_binary_size=32000):
  117. outfilebase = basename(outfilename)
  118. # Printing functions
  119. outfileh = codecs.open(outfilename + ".h", r"w+", encoding='utf-8')
  120. outfilec = StringIO()
  121. def writeh(line):
  122. print(unicode(line), end='\n', file=outfileh)
  123. def writec(line):
  124. print(unicode(line), end='\n', file=outfilec)
  125. additionalHeaders = ""
  126. if len(typesArray) > 0:
  127. for arr in set(typesArray):
  128. if arr == "UA_TYPES":
  129. continue
  130. additionalHeaders += """#include "%s_generated.h"\n""" % arr.lower()
  131. # Print the preamble of the generated code
  132. writeh("""/* WARNING: This is a generated file.
  133. * Any manual changes will be overwritten. */
  134. #ifndef %s_H_
  135. #define %s_H_
  136. """ % (outfilebase.upper(), outfilebase.upper()))
  137. if internal_headers:
  138. writeh("""
  139. #ifdef UA_NO_AMALGAMATION
  140. # include "ua_server.h"
  141. # include "ua_types_encoding_binary.h"
  142. #else
  143. # include "open62541.h"
  144. /* The following declarations are in the open62541.c file so here's needed when compiling nodesets externally */
  145. # ifndef UA_Nodestore_remove //this definition is needed to hide this code in the amalgamated .c file
  146. typedef UA_StatusCode (*UA_exchangeEncodeBuffer)(void *handle, UA_Byte **bufPos,
  147. const UA_Byte **bufEnd);
  148. UA_StatusCode
  149. UA_encodeBinary(const void *src, const UA_DataType *type,
  150. UA_Byte **bufPos, const UA_Byte **bufEnd,
  151. UA_exchangeEncodeBuffer exchangeCallback,
  152. void *exchangeHandle) UA_FUNC_ATTR_WARN_UNUSED_RESULT;
  153. UA_StatusCode
  154. UA_decodeBinary(const UA_ByteString *src, size_t *offset, void *dst,
  155. const UA_DataType *type, size_t customTypesSize,
  156. const UA_DataType *customTypes) UA_FUNC_ATTR_WARN_UNUSED_RESULT;
  157. size_t
  158. UA_calcSizeBinary(void *p, const UA_DataType *type);
  159. const UA_DataType *
  160. UA_findDataTypeByBinary(const UA_NodeId *typeId);
  161. # endif // UA_Nodestore_remove
  162. #endif
  163. %s
  164. """ % (additionalHeaders))
  165. else:
  166. writeh("""
  167. #include "open62541.h"
  168. """)
  169. writeh("""
  170. #ifdef __cplusplus
  171. extern "C" {
  172. #endif
  173. extern UA_StatusCode %s(UA_Server *server);
  174. #ifdef __cplusplus
  175. }
  176. #endif
  177. #endif /* %s_H_ */""" % \
  178. (outfilebase, outfilebase.upper()))
  179. writec("""/* WARNING: This is a generated file.
  180. * Any manual changes will be overwritten. */
  181. #include "%s.h"
  182. """ % (outfilebase))
  183. # Loop over the sorted nodes
  184. logger.info("Reordering nodes for minimal dependencies during printing")
  185. sorted_nodes = sortNodes(nodeset)
  186. logger.info("Writing code for nodes and references")
  187. functionNumber = 0
  188. parentreftypes = getSubTypesOf(nodeset, nodeset.getNodeByBrowseName("HierarchicalReferences"))
  189. parentreftypes = list(map(lambda x: x.id, parentreftypes))
  190. printed_ids = set()
  191. for node in sorted_nodes:
  192. printed_ids.add(node.id)
  193. parentref = node.popParentRef(parentreftypes)
  194. if not node.hidden:
  195. writec("\n/* " + str(node.displayName) + " - " + str(node.id) + " */")
  196. code = generateNodeCode_begin(node, nodeset, max_string_length, generate_ns0, parentref, encode_binary_size)
  197. if code is None:
  198. writec("/* Ignored. No parent */")
  199. nodeset.hide_node(node.id)
  200. continue
  201. else:
  202. writec("\nstatic UA_StatusCode function_" + outfilebase + "_" + str(functionNumber) + "_begin(UA_Server *server, UA_UInt16* ns) {")
  203. if isinstance(node, MethodNode):
  204. writec("#ifdef UA_ENABLE_METHODCALLS")
  205. writec(code)
  206. # Print inverse references leading to this node
  207. for ref in node.references:
  208. if ref.target not in printed_ids:
  209. continue
  210. if node.hidden and nodeset.nodes[ref.target].hidden:
  211. continue
  212. writec(generateReferenceCode(ref))
  213. if node.hidden:
  214. continue
  215. writec("return retVal;")
  216. if isinstance(node, MethodNode):
  217. writec("#else")
  218. writec("return UA_STATUSCODE_GOOD;")
  219. writec("#endif /* UA_ENABLE_METHODCALLS */")
  220. writec("}");
  221. writec("\nstatic UA_StatusCode function_" + outfilebase + "_" + str(functionNumber) + "_finish(UA_Server *server, UA_UInt16* ns) {")
  222. if isinstance(node, MethodNode):
  223. writec("#ifdef UA_ENABLE_METHODCALLS")
  224. writec("return " + generateNodeCode_finish(node))
  225. if isinstance(node, MethodNode):
  226. writec("#else")
  227. writec("return UA_STATUSCODE_GOOD;")
  228. writec("#endif /* UA_ENABLE_METHODCALLS */")
  229. writec("}");
  230. functionNumber = functionNumber + 1
  231. writec("""
  232. UA_StatusCode %s(UA_Server *server) {
  233. UA_StatusCode retVal = UA_STATUSCODE_GOOD;""" % (outfilebase))
  234. # Generate namespaces (don't worry about duplicates)
  235. writec("/* Use namespace ids generated by the server */")
  236. writec("UA_UInt16 ns[" + str(len(nodeset.namespaces)) + "];")
  237. for i, nsid in enumerate(nodeset.namespaces):
  238. nsid = nsid.replace("\"", "\\\"")
  239. writec("ns[" + str(i) + "] = UA_Server_addNamespace(server, \"" + nsid + "\");")
  240. for i in range(0, functionNumber):
  241. writec("retVal |= function_" + outfilebase + "_" + str(i) + "_begin(server, ns);")
  242. for i in reversed(range(0, functionNumber)):
  243. writec("retVal |= function_" + outfilebase + "_" + str(i) + "_finish(server, ns);")
  244. writec("return retVal;\n}")
  245. outfileh.close()
  246. fullCode = outfilec.getvalue()
  247. outfilec.close()
  248. outfilec = codecs.open(outfilename + ".c", r"w+", encoding='utf-8')
  249. outfilec.write(fullCode)
  250. outfilec.close()