generate_datatypes.py 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491
  1. from __future__ import print_function
  2. import sys
  3. import time
  4. import platform
  5. import getpass
  6. from collections import OrderedDict
  7. import re
  8. from lxml import etree
  9. import itertools
  10. import argparse
  11. fixed_size = {"UA_Boolean": 1, "UA_SByte": 1, "UA_Byte": 1, "UA_Int16": 2, "UA_UInt16": 2,
  12. "UA_Int32": 4, "UA_UInt32": 4, "UA_Int64": 8, "UA_UInt64": 8, "UA_Float": 4,
  13. "UA_Double": 8, "UA_DateTime": 8, "UA_Guid": 16, "UA_StatusCode": 4}
  14. zero_copy = ["UA_Boolean", "UA_SByte", "UA_Byte", "UA_Int16", "UA_UInt16", "UA_Int32", "UA_UInt32",
  15. "UA_Int64", "UA_UInt64", "UA_Float", "UA_Double", "UA_DateTime", "UA_StatusCode"]
  16. # The order of the builtin-types is not as in the standard. We put all the
  17. # fixed_size types in the front, so they can be distinguished by a simple geq
  18. # comparison. That's ok, since we use the type-index only internally!!
  19. builtin_types = ["UA_Boolean", "UA_SByte", "UA_Byte", # 1 byte
  20. "UA_Int16", "UA_UInt16", # 2 bytes
  21. "UA_Int32", "UA_UInt32", "UA_StatusCode", "UA_Float", # 4 byte
  22. "UA_Int64", "UA_UInt64", "UA_Double", "UA_DateTime", # 8 byte
  23. "UA_Guid", "UA_NodeId", "UA_ExpandedNodeId", "UA_QualifiedName", "UA_LocalizedText", "UA_ExtensionObject", "UA_DataValue", "UA_Variant", "UA_DiagnosticInfo", # fancy types
  24. "UA_String", "UA_ByteString", "UA_XmlElement" # strings (handled as structured types with a single array entry)
  25. ]
  26. excluded_types = ["UA_NodeIdType", "UA_InstanceNode", "UA_TypeNode", "UA_Node", "UA_ObjectNode",
  27. "UA_ObjectTypeNode", "UA_VariableNode", "UA_VariableTypeNode", "UA_ReferenceTypeNode",
  28. "UA_MethodNode", "UA_ViewNode", "UA_DataTypeNode", "UA_ServerDiagnosticsSummaryDataType",
  29. "UA_SamplingIntervalDiagnosticsDataType", "UA_SessionSecurityDiagnosticsDataType",
  30. "UA_SubscriptionDiagnosticsDataType", "UA_SessionDiagnosticsDataType"]
  31. class TypeDescription(object):
  32. def __init__(self, name, nodeid, namespaceid):
  33. self.name = name # without the UA_ prefix
  34. self.nodeid = nodeid
  35. self.namespaceid = namespaceid
  36. def parseTypeDescriptions(filename, namespaceid):
  37. definitions = {}
  38. f = open(filename[0])
  39. input_str = f.read()
  40. f.close()
  41. input_str = input_str.replace('\r','')
  42. rows = map(lambda x:tuple(x.split(',')), input_str.split('\n'))
  43. for index, row in enumerate(rows):
  44. if len(row) < 3:
  45. continue
  46. if row[2] != "DataType":
  47. continue
  48. if row[0] == "BaseDataType":
  49. definitions["UA_Variant"] = TypeDescription(row[0], row[1], namespaceid)
  50. elif row[0] == "Structure":
  51. definitions["UA_ExtensionObject"] = TypeDescription(row[0], row[1], namespaceid)
  52. else:
  53. definitions["UA_" + row[0]] = TypeDescription(row[0], row[1], namespaceid)
  54. return definitions
  55. class BuiltinType(object):
  56. "Generic type without members. Used for builtin types."
  57. def __init__(self, name, description = ""):
  58. self.name = name
  59. self.description = description
  60. def fixed_size(self):
  61. return self.name in fixed_size
  62. def mem_size(self):
  63. return fixed_size[self.name]
  64. def zero_copy(self):
  65. return self.name in zero_copy
  66. def typedef_c(self):
  67. pass
  68. def typelayout_c(self, namespace_0, description, outname):
  69. if description == None:
  70. typeid = "{.namespaceIndex = 0, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = 0}, "
  71. else:
  72. typeid = "{.namespaceIndex = %s, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = %s}, " % (description.namespaceid, description.nodeid)
  73. return "{.typeId = " + typeid + \
  74. ".memSize = sizeof(" + self.name + "), " + \
  75. ".namespaceZero = UA_TRUE, " + \
  76. ".fixedSize = " + ("UA_TRUE" if self.fixed_size() else "UA_FALSE") + \
  77. ", .zeroCopyable = " + ("UA_TRUE" if self.zero_copy() else "UA_FALSE") + \
  78. ", .membersSize = 1,\n\t.members = {{.memberTypeIndex = UA_TYPES_" + self.name[3:].upper() + "," + \
  79. ".namespaceZero = UA_TRUE, .padding = 0, .isArray = UA_FALSE }}, " + \
  80. ".typeIndex = %s }" % (outname.upper() + "_" + self.name[3:].upper())
  81. class EnumerationType(object):
  82. def __init__(self, name, description = "", elements = OrderedDict()):
  83. self.name = name
  84. self.description = description
  85. self.elements = elements # maps a name to an integer value
  86. def append_enum(name, value):
  87. self.elements[name] = value
  88. def fixed_size(self):
  89. return True
  90. def mem_size(self):
  91. return 4
  92. def zero_copy(self):
  93. return True
  94. def typedef_c(self):
  95. return "typedef enum { \n " + \
  96. ",\n ".join(map(lambda (key,value) : key.upper() + " = " + value,self.elements.iteritems())) + \
  97. "\n} " + self.name + ";"
  98. def typelayout_c(self, namespace_0, description, outname):
  99. if description == None:
  100. typeid = "{.namespaceIndex = 0, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = 0}, "
  101. else:
  102. typeid = "{.namespaceIndex = %s, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = %s}, " % (description.namespaceid, description.nodeid)
  103. return "{.typeId = " + typeid + \
  104. ".memSize = sizeof(" + self.name + "), " +\
  105. ".namespaceZero = " + ("UA_TRUE" if namespace_0 else "UA_FALSE") + \
  106. ", .fixedSize = UA_TRUE, .zeroCopyable = UA_TRUE, " + \
  107. ".membersSize = 1,\n\t.members = {{.memberTypeIndex = UA_TYPES_INT32," + \
  108. ".namespaceZero = UA_TRUE, .padding = 0, .isArray = UA_FALSE }}, .typeIndex = %s }" % (outname.upper() + "_" + self.name[3:].upper())
  109. def functions_c(self, typeTableName):
  110. return '''#define %s_new (%s*)UA_Int32_new
  111. #define %s_init(p) UA_Int32_init((UA_Int32*)p)
  112. #define %s_delete(p) UA_Int32_delete((UA_Int32*)p)
  113. #define %s_deleteMembers(p) UA_Int32_deleteMembers((UA_Int32*)p)
  114. #define %s_copy(src, dst) UA_Int32_copy((const UA_Int32*)src, (UA_Int32*)dst)
  115. #define %s_calcSizeBinary(p) UA_Int32_calcSizeBinary((UA_Int32*)p)
  116. #define %s_encodeBinary(src, dst, offset) UA_Int32_encodeBinary((UA_Int32*)src, dst, offset)
  117. #define %s_decodeBinary(src, offset, dst) UA_Int32_decodeBinary(src, offset, (UA_Int32*)dst)''' % tuple(itertools.repeat(self.name, 9))
  118. class OpaqueType(object):
  119. def __init__(self, name, description = ""):
  120. self.name = name
  121. self.description = description
  122. def fixed_size(self):
  123. return False
  124. def zero_copy(self):
  125. return False
  126. def typedef_c(self):
  127. return "typedef UA_ByteString " + self.name + ";"
  128. def typelayout_c(self, namespace_0, description, outname):
  129. if description == None:
  130. typeid = "{.namespaceIndex = 0, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = 0}, "
  131. else:
  132. typeid = "{.namespaceIndex = %s, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = %s}, " % (description.namespaceid, description.nodeid)
  133. return "{.typeId = " + typeid + \
  134. ".memSize = sizeof(" + self.name + "), .fixedSize = UA_FALSE, .zeroCopyable = UA_FALSE, " + \
  135. ".namespaceZero = " + ("UA_TRUE" if namespace_0 else "UA_FALSE") + \
  136. ", .membersSize = 1,\n\t.members = {{.memberTypeIndex = UA_TYPES_BYTESTRING," + \
  137. ".namespaceZero = UA_TRUE, .padding = 0, .isArray = UA_FALSE }}, .typeIndex = %s }" % (outname.upper() + "_" + self.name[3:].upper())
  138. def functions_c(self, typeTableName):
  139. return '''#define %s_new UA_ByteString_new
  140. #define %s_init UA_ByteString_init
  141. #define %s_delete UA_ByteString_delete
  142. #define %s_deleteMembers UA_ByteString_deleteMembers
  143. #define %s_copy UA_ByteString_copy
  144. #define %s_calcSizeBinary UA_ByteString_calcSizeBinary
  145. #define %s_encodeBinary UA_ByteString_encodeBinary
  146. #define %s_decodeBinary UA_ByteString_decodeBinary''' % tuple(itertools.repeat(self.name, 8))
  147. class StructMember(object):
  148. def __init__(self, name, memberType, isArray):
  149. self.name = name
  150. self.memberType = memberType
  151. self.isArray = isArray
  152. class StructType(object):
  153. def __init__(self, name, description, members = OrderedDict()):
  154. self.name = name
  155. self.description = description
  156. self.members = members # maps a name to a member definition
  157. def fixed_size(self):
  158. for m in self.members.values():
  159. if m.isArray or not m.memberType.fixed_size():
  160. return False
  161. return True
  162. def mem_size(self):
  163. total = 0
  164. for m in self.members.values():
  165. if m.isArray:
  166. raise Exception("Arrays have no fixed size!")
  167. else:
  168. total += m.memberType.mem_size()
  169. return total
  170. def zero_copy(self):
  171. for m in self.members.values():
  172. if m.isArray or not m.memberType.zero_copy():
  173. return False
  174. return True
  175. def typedef_c(self):
  176. if len(self.members) == 0:
  177. return "typedef void * " + self.name + ";"
  178. returnstr = "typedef struct {\n"
  179. for name, member in self.members.iteritems():
  180. if member.isArray:
  181. returnstr += " UA_Int32 " + name + "Size;\n"
  182. returnstr += " " + member.memberType.name + " *" +name + ";\n"
  183. else:
  184. returnstr += " " + member.memberType.name + " " +name + ";\n"
  185. return returnstr + "} " + self.name + ";"
  186. def typelayout_c(self, namespace_0, description, outname):
  187. if description == None:
  188. typeid = "{.namespaceIndex = 0, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = 0}, "
  189. else:
  190. typeid = "{.namespaceIndex = %s, .identifierType = UA_NODEIDTYPE_NUMERIC, .identifier.numeric = %s}, " % (description.namespaceid, description.nodeid)
  191. layout = "{.typeId = "+ typeid + \
  192. ".memSize = sizeof(" + self.name + "), "+ \
  193. ".namespaceZero = " + ("UA_TRUE" if namespace_0 else "UA_FALSE") + \
  194. ", .fixedSize = " + ("UA_TRUE" if self.fixed_size() else "UA_FALSE") + \
  195. ", .zeroCopyable = " + ("sizeof(" + self.name + ") == " + str(self.mem_size()) if self.zero_copy() \
  196. else "UA_FALSE") + \
  197. ", .typeIndex = " + outname.upper() + "_" + self.name[3:].upper() + \
  198. ", .membersSize = " + str(len(self.members)) + ","
  199. if len(self.members) > 0:
  200. layout += "\n\t.members={"
  201. for index, member in enumerate(self.members.values()):
  202. layout += "\n\t{" + \
  203. ".memberTypeIndex = " + ("UA_TYPES_" + member.memberType.name[3:].upper() if args.namespace_id == 0 or member.memberType.name in existing_types else \
  204. outname.upper() + "_" + member.memberType.name[3:].upper()) + ", " + \
  205. ".namespaceZero = "+ \
  206. ("UA_TRUE, " if args.namespace_id == 0 or member.memberType.name in existing_types else "UA_FALSE, ") + \
  207. ".padding = "
  208. before_endpos = "0"
  209. thispos = "offsetof(%s, %s)" % (self.name, member.name)
  210. if index > 0:
  211. before = self.members.values()[index-1]
  212. before_endpos = "(offsetof(%s, %s)" % (self.name, before.name)
  213. if before.isArray:
  214. before_endpos += " + sizeof(void*))"
  215. else:
  216. before_endpos += " + sizeof(%s))" % before.memberType.name
  217. if member.isArray:
  218. # the first two bytes are padding for the length index, the last three for the pointer
  219. length_pos = "offsetof(%s, %sSize)" % (self.name, member.name)
  220. if index != 0:
  221. layout += "((%s - %s) << 3) + " % (length_pos, before_endpos)
  222. layout += "(%s - sizeof(UA_Int32) - %s)" % (thispos, length_pos)
  223. else:
  224. layout += "%s - %s" % (thispos, before_endpos)
  225. layout += ", .isArray = " + ("UA_TRUE" if member.isArray else "UA_FALSE") + " }, "
  226. layout += "}"
  227. return layout + "}"
  228. def functions_c(self, typeTableName):
  229. return '''#define %s_new() UA_new(%s)
  230. #define %s_init(p) UA_init(p, %s)
  231. #define %s_delete(p) UA_delete(p, %s)
  232. #define %s_deleteMembers(p) UA_deleteMembers(p, %s)
  233. #define %s_copy(src, dst) UA_copy(src, dst, %s)
  234. #define %s_calcSizeBinary(p) UA_calcSizeBinary(p, %s)
  235. #define %s_encodeBinary(src, dst, offset) UA_encodeBinary(src, %s, dst, offset)
  236. #define %s_decodeBinary(src, offset, dst) UA_decodeBinary(src, offset, dst, %s)''' % \
  237. tuple(itertools.chain(*itertools.repeat([self.name, "&"+typeTableName+"[" + typeTableName + "_" + self.name[3:].upper()+"]"], 8)))
  238. def parseTypeDefinitions(xmlDescription, existing_types = OrderedDict()):
  239. '''Returns an ordered dict that maps names to types. The order is such that
  240. every type depends only on known types. '''
  241. ns = {"opc": "http://opcfoundation.org/BinarySchema/"}
  242. tree = etree.parse(xmlDescription)
  243. typeSnippets = tree.xpath("/opc:TypeDictionary/*[not(self::opc:Import)]", namespaces=ns)
  244. types = OrderedDict(existing_types.items())
  245. # types we do not want to autogenerate
  246. def skipType(name):
  247. if name in builtin_types:
  248. return True
  249. if name in excluded_types:
  250. return True
  251. if "Test" in name: # skip all test types
  252. return True
  253. if re.search("NodeId$", name) != None:
  254. return True
  255. return False
  256. def stripTypename(tn):
  257. return tn[tn.find(":")+1:]
  258. def camlCase2CCase(item):
  259. "Member names begin with a lower case character"
  260. return item[:1].lower() + item[1:] if item else ''
  261. def typeReady(element):
  262. "Do we have the member types yet?"
  263. for child in element:
  264. if child.tag == "{http://opcfoundation.org/BinarySchema/}Field":
  265. if stripTypename(child.get("TypeName")) not in types:
  266. return False
  267. return True
  268. def parseEnumeration(typeXml):
  269. name = "UA_" + typeXml.get("Name")
  270. description = ""
  271. elements = OrderedDict()
  272. for child in typeXml:
  273. if child.tag == "{http://opcfoundation.org/BinarySchema/}Documentation":
  274. description = child.text
  275. if child.tag == "{http://opcfoundation.org/BinarySchema/}EnumeratedValue":
  276. elements[name + "_" + child.get("Name")] = child.get("Value")
  277. return EnumerationType(name, description, elements)
  278. def parseOpaque(typeXml):
  279. name = "UA_" + typeXml.get("Name")
  280. description = ""
  281. for child in typeXml:
  282. if child.tag == "{http://opcfoundation.org/BinarySchema/}Documentation":
  283. description = child.text
  284. return OpaqueType(name, description)
  285. def parseStructured(typeXml):
  286. "Returns None if we miss member descriptions"
  287. name = "UA_" + typeXml.get("Name")
  288. description = ""
  289. for child in typeXml:
  290. if child.tag == "{http://opcfoundation.org/BinarySchema/}Documentation":
  291. description = child.text
  292. # ignore lengthfields, just tag the array-members as an array
  293. lengthfields = []
  294. for child in typeXml:
  295. if child.get("LengthField"):
  296. lengthfields.append(child.get("LengthField"))
  297. members = OrderedDict()
  298. for child in typeXml:
  299. if not child.tag == "{http://opcfoundation.org/BinarySchema/}Field":
  300. continue
  301. if child.get("Name") in lengthfields:
  302. continue
  303. memberTypeName = "UA_" + stripTypename(child.get("TypeName"))
  304. if not memberTypeName in types:
  305. return None
  306. memberType = types[memberTypeName]
  307. memberName = camlCase2CCase(child.get("Name"))
  308. isArray = True if child.get("LengthField") else False
  309. members[memberName] = StructMember(memberName, memberType, isArray)
  310. return StructType(name, description, members)
  311. finished = False
  312. while(not finished):
  313. finished = True
  314. for typeXml in typeSnippets:
  315. name = "UA_" + typeXml.get("Name")
  316. if name in types or skipType(name):
  317. continue
  318. if typeXml.tag == "{http://opcfoundation.org/BinarySchema/}EnumeratedType":
  319. t = parseEnumeration(typeXml)
  320. types[t.name] = t
  321. elif typeXml.tag == "{http://opcfoundation.org/BinarySchema/}OpaqueType":
  322. t = parseOpaque(typeXml)
  323. types[t.name] = t
  324. elif typeXml.tag == "{http://opcfoundation.org/BinarySchema/}StructuredType":
  325. t = parseStructured(typeXml)
  326. if t == None:
  327. finished = False
  328. else:
  329. types[t.name] = t
  330. # remove the existing types
  331. for k in existing_types.keys():
  332. types.pop(k)
  333. return types
  334. parser = argparse.ArgumentParser()
  335. parser.add_argument('--ns0-types-xml', nargs=1, help='xml-definition of the ns0 types that are assumed to already exist')
  336. parser.add_argument('--typedescriptions', nargs=1, help='csv file with type descriptions')
  337. parser.add_argument('namespace_id', type=int, help='the id of the target namespace')
  338. parser.add_argument('types_xml', help='path/to/Opc.Ua.Types.bsd')
  339. parser.add_argument('outfile', help='output file w/o extension')
  340. args = parser.parse_args()
  341. outname = args.outfile.split("/")[-1]
  342. inname = args.types_xml.split("/")[-1]
  343. existing_types = OrderedDict()
  344. if args.namespace_id == 0 or args.ns0_types_xml:
  345. existing_types = OrderedDict([(t, BuiltinType(t)) for t in builtin_types])
  346. if args.ns0_types_xml:
  347. OrderedDict(existing_types.items() + parseTypeDefinitions(args.ns0_types_xml[0], existing_types).items())
  348. types = parseTypeDefinitions(args.types_xml, existing_types)
  349. if args.namespace_id == 0:
  350. types = OrderedDict(existing_types.items() + types.items())
  351. typedescriptions = {}
  352. if args.typedescriptions:
  353. typedescriptions = parseTypeDescriptions(args.typedescriptions, args.namespace_id)
  354. fh = open(args.outfile + "_generated.h",'w')
  355. fc = open(args.outfile + "_generated.c",'w')
  356. def printh(string):
  357. print(string, end='\n', file=fh)
  358. def printc(string):
  359. print(string, end='\n', file=fc)
  360. printh('''/**
  361. * @file ''' + outname + '''_generated.h
  362. *
  363. * @brief Autogenerated data types
  364. *
  365. * Generated from ''' + inname + ''' with script ''' + sys.argv[0] + '''
  366. * on host ''' + platform.uname()[1] + ''' by user ''' + getpass.getuser() + ''' at ''' + time.strftime("%Y-%m-%d %I:%M:%S") + '''
  367. */
  368. #ifndef ''' + outname.upper() + '''_GENERATED_H_
  369. #define ''' + outname.upper() + '''_GENERATED_H_
  370. #ifdef __cplusplus
  371. extern "C" {
  372. #endif
  373. #include "ua_types.h" '''
  374. + ('\n#include "ua_types_generated.h"\n' if args.namespace_id != 0 else '') + '''
  375. /**
  376. * @ingroup types
  377. *
  378. * @defgroup ''' + outname + '''_generated Autogenerated ''' + outname + ''' Types
  379. *
  380. * @brief Data structures that are autogenerated from an XML-Schema.
  381. *
  382. * @{
  383. */
  384. ''')
  385. printh("#define " + outname.upper() + "_COUNT %s\n" % (str(len(types))))
  386. printh("extern UA_EXPORT const UA_DataType *" + outname.upper() + ";\n")
  387. i = 0
  388. for t in types.itervalues():
  389. if type(t) != BuiltinType:
  390. printh("")
  391. if t.description != "":
  392. printh("/** @brief " + t.description + " */")
  393. printh(t.typedef_c())
  394. printh("#define " + outname.upper() + "_" + t.name[3:].upper() + " " + str(i))
  395. if type(t) != BuiltinType:
  396. printh(t.functions_c(outname.upper()))
  397. i += 1
  398. printh('''
  399. /// @} /* end of group */\n
  400. #ifdef __cplusplus
  401. } // extern "C"
  402. #endif\n
  403. #endif''')
  404. printc('''/**
  405. * @file ''' + outname + '''_generated.c
  406. *
  407. * @brief Autogenerated data types
  408. *
  409. * Generated from ''' + inname + ''' with script ''' + sys.argv[0] + '''
  410. * on host ''' + platform.uname()[1] + ''' by user ''' + getpass.getuser() + ''' at ''' + time.strftime("%Y-%m-%d %I:%M:%S") + '''
  411. */\n
  412. #include "stddef.h"
  413. #include "ua_types.h"
  414. #include "''' + outname + '''_generated.h"\n
  415. const UA_DataType *''' + outname.upper() + ''' = (UA_DataType[]){''')
  416. for t in types.itervalues():
  417. printc("")
  418. printc("/* " + t.name + " */")
  419. if args.typedescriptions:
  420. td = typedescriptions[t.name]
  421. else:
  422. td = None
  423. printc(t.typelayout_c(args.namespace_id == 0, td, outname) + ",")
  424. printc("};\n")
  425. # if args.typedescriptions:
  426. # printc('const UA_UInt32 *' + outname.upper() + '_IDS = (UA_UInt32[]){')
  427. # for t in types.itervalues():
  428. # print(str(typedescriptions[t.name].nodeid) + ", ", end='', file=fc)
  429. # printc("};")
  430. fh.close()
  431. fc.close()