You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

gen_param_defs.py 33 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930
  1. #!/usr/bin/env python3
  2. # -*- coding: utf-8 -*-
  3. import argparse
  4. import collections
  5. import textwrap
  6. import os
  7. import hashlib
  8. import struct
  9. class member_defs:
  10. """contain classes to define members of an opr param"""
  11. Dtype = collections.namedtuple('Dtype', ['cname', 'pycvt', 'pyfmt',
  12. 'cppjson', 'cname_attr'])
  13. Dtype.__new__.__defaults__ = ('', )
  14. uint32 = Dtype('uint32_t', 'int', 'I', 'NumberInt')
  15. uint64 = Dtype('uint64_t', 'int', 'Q', 'NumberInt',
  16. 'alignas(sizeof(uint64_t)) ')
  17. int32 = Dtype('int32_t', 'int', 'i', 'NumberInt')
  18. float32 = Dtype('float', 'float', 'f', 'Number')
  19. float64 = Dtype('double', 'float', 'd', 'Number')
  20. dtype = Dtype('DTypeEnum', '_as_dtype_num', 'I', 'Number')
  21. bool = Dtype('bool', 'bool', '?', 'Bool')
  22. class Base:
  23. pass
  24. class Doc:
  25. """wrap an identifier to associate document
  26. note: if the doc starts with a linebreak, it would not be reforamtted.
  27. """
  28. __slots__ = ['id', 'doc']
  29. def __init__(self, id_, doc):
  30. assert isinstance(id_, str) and isinstance(doc, str), (id_, doc)
  31. self.id = id_
  32. self.doc = doc
  33. @property
  34. def no_reformat(self):
  35. """whether reformat is disallowed for this doc string"""
  36. return self.doc.startswith('\n')
  37. @property
  38. def raw_lines(self):
  39. """the doc lines when ``no_format`` is true"""
  40. ret = self.doc.split('\n')
  41. assert not ret[0]
  42. return ret[1:]
  43. @classmethod
  44. def make(cls, v):
  45. """make doc object from str or doc"""
  46. if isinstance(v, cls):
  47. return v
  48. assert isinstance(v, str)
  49. return cls(v, '')
  50. def __str__(self):
  51. return self.id
  52. def __eq__(self, rhs):
  53. if isinstance(rhs, str):
  54. return self.id == rhs
  55. return (isinstance(rhs, Doc) and
  56. (self.id, self.doc) == (rhs.id, rhs.doc))
  57. class Enum(Base):
  58. """define an enum; the result would contain both an enum class def and its
  59. corresponding data field
  60. :param default:
  61. for normal enum class: index of default member value
  62. for bit combined class: tuple of index of default member value
  63. For example, following representations of the default value for bit
  64. combined class are all equivalent:
  65. Enum(members=('a', 'b', 'c'), default=('a', 'b'), ...)
  66. Enum(members=('a', 'b', 'c'), default=(0, 1), ...)
  67. Enum(members=('a', 'b', 'c'), default=(1 << 0) | (1 << 1), ...)
  68. :attr name_field: name of the data field of this enum in the param
  69. struct
  70. :attr member_alias:
  71. for normal enum class: list of (member, alias) pairs
  72. for bit combined class: list of (tuple of members, alias) paris
  73. """
  74. __slots__ = ['name', 'name_field', 'members', 'default',
  75. 'member_alias', 'combined']
  76. all_enums = {}
  77. """(param_name, name) => enum"""
  78. def __init__(self, param_name, name, name_field, members, default,
  79. member_alias, combined = False):
  80. name = member_defs.Doc.make(name)
  81. assert name.id[0].isupper()
  82. members = tuple(map(member_defs.Doc.make, members))
  83. self.name = name
  84. self.combined = combined
  85. self.name_field = self.get_name_field(name.id, name_field)
  86. self.members = members
  87. self.default = self.normalize_enum_value(default)
  88. self.all_enums[(param_name, name.id)] = self
  89. assert isinstance(member_alias, list)
  90. self.member_alias = member_alias
  91. @classmethod
  92. def get_name_field(cls, name, name_field):
  93. if name_field is None:
  94. name_field = name[0].lower() + name[1:]
  95. assert isinstance(name_field, str)
  96. return name_field
  97. def normalize_enum_value(self, value):
  98. def normalize(v):
  99. if isinstance(v, str):
  100. for idx, m in enumerate(self.members):
  101. m = str(m).split(' ')[0].split('=')[0]
  102. if v == m :
  103. return idx
  104. raise ValueError(
  105. "enum member '{}' does not exist.".format(v))
  106. assert isinstance(v, int)
  107. return v
  108. if self.combined:
  109. if isinstance(value, int):
  110. value = self.decompose_combined_enum(value)
  111. assert isinstance(value, tuple)
  112. value = tuple(normalize(i) for i in value)
  113. return value
  114. else:
  115. return normalize(value)
  116. @staticmethod
  117. def decompose_combined_enum(v):
  118. """Integer => tuple of the indexes of the enum members"""
  119. assert isinstance(v, int)
  120. idx = 0
  121. members = []
  122. while v > 0:
  123. if v & 1:
  124. members.append(idx)
  125. idx += 1
  126. v >>= 1
  127. return tuple(members)
  128. def compose_combined_enum(self, v):
  129. """tuple of members => Integer"""
  130. assert self.combined and isinstance(v, tuple)
  131. norm_v = self.normalize_enum_value(v)
  132. return sum(1 << i for i in norm_v)
  133. class Field(Base):
  134. """define a normal data field"""
  135. __slots__ = ['name', 'dtype', 'default']
  136. def __init__(self, name, dtype, default):
  137. assert isinstance(dtype, member_defs.Dtype)
  138. self.name = member_defs.Doc.make(name)
  139. self.dtype = dtype
  140. self.default = default
  141. class Const(Base):
  142. """define a const data field"""
  143. __slots__ = ['name', 'dtype', 'default']
  144. def __init__(self, name, dtype, default):
  145. assert isinstance(dtype, member_defs.Dtype)
  146. self.name = member_defs.Doc.make(name)
  147. self.dtype = dtype
  148. self.default = default
  149. class EnumAlias(Base):
  150. """alias of enum type from another param"""
  151. __slots__ = ['name', 'name_field', 'src_class', 'src_name', 'default']
  152. def __init__(self, name, name_field, src_class, src_name, default):
  153. self.name = name
  154. self.name_field = member_defs.Enum.get_name_field(name, name_field)
  155. self.src_class = src_class
  156. if src_name is None:
  157. src_name = name
  158. self.src_name = src_name
  159. self.default = default
  160. # TODO: remove this assertion if needed; adding mock param_defs in
  161. # current testing framework is too complicated, and currently we
  162. # only allow aliasing of normal enum
  163. assert not self.src_enum.combined
  164. @property
  165. def src_enum(self):
  166. """source Enum class"""
  167. return member_defs.Enum.all_enums[(self.src_class, self.src_name)]
  168. def get_default(self):
  169. """get default index; fallback to src index if default is not
  170. set"""
  171. if self.default is None:
  172. return self.src_enum.default
  173. return self.src_enum.normalize_enum_value(self.default)
  174. class ParamDef:
  175. """"""
  176. __all_tags = set()
  177. all_param_defs = []
  178. __slots__ = ['name', 'members', 'tag', 'is_legacy']
  179. def __init__(self, name, doc='', *, version=0, is_legacy=False):
  180. self.members = []
  181. self.all_param_defs.append(self)
  182. h = hashlib.sha256(name.encode('utf-8'))
  183. if version:
  184. h.update(struct.pack('<I', version))
  185. if is_legacy:
  186. name += 'V{}'.format(version)
  187. self.name = member_defs.Doc(name, doc)
  188. self.tag = int(h.hexdigest()[:8], 16)
  189. self.is_legacy = is_legacy
  190. if self.tag < 1024:
  191. self.tag += 1024
  192. assert self.tag not in self.__all_tags, (
  193. 'tag hash confliction: name={} tag={}'.format(name, self.tag))
  194. self.__all_tags.add(self.tag)
  195. def add_fields(self, dtype, *names_defaults):
  196. assert isinstance(dtype, str)
  197. dtype = getattr(member_defs, dtype)
  198. assert len(names_defaults) % 2 == 0
  199. for i, j in zip(names_defaults[::2], names_defaults[1::2]):
  200. self.members.append(member_defs.Field(i, dtype, j))
  201. return self
  202. def add_enum(self, name, *members, default=0, name_field=None,
  203. member_alias=[]):
  204. self.members.append(member_defs.Enum(
  205. self.name.id, name, name_field, members, default, member_alias))
  206. return self
  207. def add_bit_combination_enum(self, name, *members, default=tuple(),
  208. name_field=None, member_alias=[]):
  209. self.members.append(member_defs.Enum(
  210. self.name.id, name, name_field, members, default, member_alias, True))
  211. return self
  212. def add_enum_alias(self, name, src_class, src_name=None, name_field=None,
  213. default=None):
  214. self.members.append(member_defs.EnumAlias(
  215. name, name_field, src_class, src_name, default))
  216. return self
  217. def add_const(self, dtype, *names_defaults):
  218. assert isinstance(dtype, str)
  219. dtype = getattr(member_defs, dtype)
  220. assert len(names_defaults) % 2 == 0
  221. for i, j in zip(names_defaults[::2], names_defaults[1::2]):
  222. self.members.append(member_defs.Const(i, dtype, j))
  223. return self
  224. class WriterBase:
  225. """base class for output file writer"""
  226. _fout = None
  227. _input_hash = None
  228. def __call__(self, fout):
  229. self._fout = fout
  230. def set_input_hash(self, h):
  231. self._input_hash = h
  232. return self
  233. def _get_header(self):
  234. return 'generated by {} for {}'.format(
  235. os.path.basename(__file__),
  236. self._input_hash
  237. )
  238. def _process(self, defs):
  239. dispatch = {
  240. member_defs.Enum: self._on_member_enum,
  241. member_defs.EnumAlias: self._on_member_enum_alias,
  242. member_defs.Field: self._on_member_field,
  243. member_defs.Const: self._on_const_field
  244. }
  245. for i in defs:
  246. assert isinstance(i, ParamDef)
  247. self._on_param_begin(i)
  248. for j in i.members:
  249. dispatch[type(j)](j)
  250. self._on_param_end(i)
  251. def _on_param_begin(self, p):
  252. """:type p: :class:`.ParamDef`"""
  253. def _on_param_end(self, p):
  254. """:type p: :class:`.ParamDef`"""
  255. def _on_member_enum(self, e):
  256. """:type p: :class:`.Enum`"""
  257. def _on_member_enum_alias(self, e):
  258. """:type p: :class:`.EnumAlias`"""
  259. def _on_member_field(self, f):
  260. """:type p: :class:`.Field`"""
  261. def _on_const_field(self, f):
  262. """:type p: :class:`.Const`"""
  263. class IndentWriterBase(WriterBase):
  264. _cur_indent = ''
  265. def _indent(self):
  266. self._cur_indent += ' ' * 4
  267. def _unindent(self):
  268. self._cur_indent = self._cur_indent[:-4]
  269. def _write(self, content, *fmt, indent=0):
  270. if indent < 0:
  271. self._unindent()
  272. self._fout.write(self._cur_indent)
  273. if fmt:
  274. content = content % fmt
  275. self._fout.write(content)
  276. self._fout.write('\n')
  277. if indent > 0:
  278. self._indent()
  279. class PyWriter(IndentWriterBase):
  280. FieldDef = collections.namedtuple(
  281. 'FieldDef', ['name', 'cvt', 'fmt', 'default', 'type', 'doc'])
  282. # see _on_param_end() for the use of those fields
  283. _cur_param_name = None
  284. _cur_fields = None
  285. _cur_struct_fmt = None
  286. _enum_member2num = None
  287. def __init__(self, for_imperative=False):
  288. self._imperative = for_imperative
  289. def __call__(self, fout, defs):
  290. super().__call__(fout)
  291. self._enum_member2num = []
  292. self._write('# %s', self._get_header())
  293. self._write('import struct')
  294. self._write('from . import enum36 as enum')
  295. self._write(
  296. 'class _ParamDefBase:\n'
  297. ' def serialize(self):\n'
  298. ' tag = struct.pack("I", type(self).TAG)\n'
  299. ' pdata = [getattr(self, i) for i in self.__slots__]\n'
  300. ' for idx, v in enumerate(pdata):\n'
  301. ' if isinstance(v, _EnumBase):\n'
  302. ' pdata[idx] = _enum_member2num[id(v)]\n'
  303. ' elif isinstance(v, _BitCombinedEnumBase):\n'
  304. ' pdata[idx] = v._value_\n'
  305. ' return tag + self._packer.pack(*pdata)\n'
  306. '\n'
  307. )
  308. # it's hard to mix custom implemention into enum, just do copy-paste instead
  309. classbody = (
  310. ' @classmethod\n'
  311. ' def __normalize(cls, val):\n'
  312. ' if isinstance(val, str):\n'
  313. ' if not hasattr(cls, "__member_upper_dict__"):\n'
  314. ' cls.__member_upper_dict__ = {k.upper(): v\n'
  315. ' for k, v in cls.__members__.items()}\n'
  316. ' val = cls.__member_upper_dict__.get(val.upper(),val)\n'
  317. ' return val\n'
  318. ' @classmethod\n'
  319. ' def convert(cls, val):\n'
  320. ' val = cls.__normalize(val)\n'
  321. ' if isinstance(val, cls):\n'
  322. ' return val\n'
  323. ' return cls(val)\n'
  324. ' @classmethod\n'
  325. ' def _missing_(cls, value):\n'
  326. ' vnorm = cls.__normalize(value)\n'
  327. ' if vnorm is not value:\n'
  328. ' return cls(vnorm)\n'
  329. ' return super()._missing_(value)\n'
  330. '\n'
  331. )
  332. self._write(
  333. 'class _EnumBase(enum.Enum):\n' + classbody
  334. )
  335. self._write(
  336. 'class _BitCombinedEnumBase(enum.Flag):\n' + classbody
  337. )
  338. if not self._imperative:
  339. self._write(
  340. 'def _as_dtype_num(dtype):\n'
  341. ' import megbrain.mgb as m\n'
  342. ' return m._get_dtype_num(dtype)\n'
  343. '\n'
  344. )
  345. self._write(
  346. 'def _as_serialized_dtype(dtype):\n'
  347. ' import megbrain.mgb as m\n'
  348. ' return m._get_serialized_dtype(dtype)\n'
  349. '\n'
  350. )
  351. else:
  352. self._write(
  353. 'def _as_dtype_num(dtype):\n'
  354. ' import megengine.core._imperative_rt.utils as m\n'
  355. ' return m._get_dtype_num(dtype)\n'
  356. '\n'
  357. )
  358. self._write(
  359. 'def _as_serialized_dtype(dtype):\n'
  360. ' import megengine.core._imperative_rt.utils as m\n'
  361. ' return m._get_serialized_dtype(dtype)\n'
  362. '\n'
  363. )
  364. self._process(defs)
  365. self._write(
  366. '''
  367. class SerializedDType(_ParamDefBase):
  368. TAG = FakeSerializedDType.TAG
  369. __slots__ = ['dtype']
  370. class IdentityPacker:
  371. def pack(self, *args):
  372. assert all([isinstance(x, bytes) for x in args])
  373. return b''.join(args)
  374. _packer = IdentityPacker()
  375. def __init__(self, dtype):
  376. """
  377. :type dtype: :class:`np.dtype` compatible
  378. """
  379. self.dtype = _as_serialized_dtype(dtype)
  380. '''
  381. )
  382. self._write('_enum_member2num = {\n %s}',
  383. ',\n '.join(self._enum_member2num))
  384. def _write_doc(self, doc):
  385. assert isinstance(doc, member_defs.Doc)
  386. if not doc.doc:
  387. return
  388. if doc.no_reformat:
  389. self._write('"""')
  390. for i in doc.raw_lines:
  391. self._write(i)
  392. self._write('"""')
  393. return
  394. doc = doc.doc.replace('\n', ' ')
  395. textwidth = 80 - len(self._cur_indent)
  396. self._write('"""')
  397. for i in textwrap.wrap(doc, textwidth):
  398. self._write(i)
  399. self._write('"""')
  400. def _on_param_begin(self, p):
  401. self._cur_param_name = str(p.name)
  402. self._cur_fields = []
  403. self._cur_enum_names = []
  404. self._write('class %s(_ParamDefBase):', p.name, indent=1)
  405. self._write_doc(p.name)
  406. self._write('TAG = %d', p.tag)
  407. def _on_param_end(self, p):
  408. # gen slots and packer
  409. self._write('__slots__ = [%s]', ', '.join(
  410. map('"{.name}"'.format, self._cur_fields)))
  411. struct_fmt = ''.join(i.fmt for i in self._cur_fields)
  412. if not struct_fmt:
  413. struct_fmt = 'x'
  414. else:
  415. # add padding at end
  416. max_t = max(struct_fmt, key=struct.calcsize)
  417. struct_fmt += '0{}'.format(max_t)
  418. self._write('_packer = struct.Struct("%s")', struct_fmt)
  419. # gen __init__ signature
  420. self._write('def __init__(%s):',
  421. ', '.join(['self'] +
  422. list('{}={}'.format(i.name, i.default)
  423. for i in self._cur_fields)),
  424. indent=1)
  425. # gen __init__ doc
  426. self._write('"""')
  427. for i in self._cur_fields:
  428. self._write(':type {}: :class:`.{}`'.format(i.name, i.type))
  429. if i.doc:
  430. self._write(':param {}: {}'.format(i.name, i.doc))
  431. self._write('"""')
  432. # gen cvt in __init__
  433. for i in self._cur_fields:
  434. self._write('self.%s = %s', i.name, i.cvt)
  435. self._unindent()
  436. self._unindent()
  437. self._write('')
  438. def _on_member_enum(self, e):
  439. qualname = '{}.{}'.format(self._cur_param_name, e.name)
  440. if e.combined:
  441. self._write('class %s(_BitCombinedEnumBase):', e.name, indent=1)
  442. else:
  443. self._write('class %s(_EnumBase):', e.name, indent=1)
  444. self._write_doc(e.name)
  445. for emem in e.members:
  446. if e.combined:
  447. self._write('%s', emem)
  448. self._write_doc(emem)
  449. else:
  450. v = str(emem).split(' ')[0].split('=')[0]
  451. n = int(str(emem).split('=')[1])
  452. self._write('%s = "%s"', v, v)
  453. self._write_doc(emem)
  454. self._enum_member2num.append('id({}.{}):{}'.format(
  455. qualname, v, n))
  456. for emem, emem_alias in e.member_alias:
  457. em_a = emem_alias.split(' ')[0].split('=')[0]
  458. if e.combined:
  459. self._write('%s = %s', em_a, e.compose_combined_enum(emem))
  460. else:
  461. em = str(emem).split(' ')[0].split('=')[0]
  462. self._write('%s = %s', em_a, em)
  463. self._unindent()
  464. self._write('')
  465. if e.combined:
  466. default = e.compose_combined_enum(e.default)
  467. else:
  468. default = "'{}'".format(str(e.members[e.default]).split(' ')[0].split('=')[0])
  469. self._cur_fields.append(self.FieldDef(
  470. name=e.name_field,
  471. cvt='{}.convert({})'.format(qualname, e.name_field),
  472. fmt='I',
  473. default=default,
  474. type=qualname,
  475. doc=None))
  476. def _on_member_enum_alias(self, e):
  477. self._write('%s = %s.%s', e.name, e.src_class, e.src_name)
  478. s = e.src_enum
  479. qualname = '{}.{}'.format(e.src_class, e.src_name)
  480. if s.combined:
  481. default = s.compose_combined_enum(e.get_default())
  482. else:
  483. default = "'{}'".format(str(s.members[e.get_default()]).split(' ')[0].split('=')[0])
  484. self._cur_fields.append(self.FieldDef(
  485. name=e.name_field,
  486. cvt='{}.convert({})'.format(qualname, e.name_field),
  487. fmt='I',
  488. default=default,
  489. type=qualname,
  490. doc=None))
  491. def _get_py_default(self, cppdefault):
  492. if not isinstance(cppdefault, str):
  493. return cppdefault
  494. d = cppdefault
  495. if d.endswith('f'): # 1.f
  496. return d[:-1]
  497. if d.endswith('ull'):
  498. return d[:-3]
  499. if d == 'false':
  500. return 'False'
  501. if d == 'true':
  502. return 'True'
  503. if d.startswith('DTypeEnum::'):
  504. return '"{}"'.format(d.split(':')[2].lower())
  505. return d
  506. def _on_member_field(self, f):
  507. d = self._get_py_default(f.default)
  508. self._cur_fields.append(self.FieldDef(
  509. name=f.name,
  510. cvt='{}({})'.format(f.dtype.pycvt, f.name),
  511. fmt=f.dtype.pyfmt,
  512. default=d,
  513. type=f.dtype.pycvt,
  514. doc=f.name.doc
  515. ))
  516. def _on_const_field(self, f):
  517. d = self._get_py_default(f.default)
  518. self._write_doc(f.name)
  519. self._write('%s = %s', f.name, d)
  520. class CPPWriter(IndentWriterBase):
  521. _param_namespace = 'param'
  522. _ctor_args = None
  523. """list of (text in func param, var name); func param name must be var name
  524. appended by an underscore"""
  525. _non_static_members = None
  526. def __call__(self, fout, defs):
  527. super().__call__(fout)
  528. self._write('// %s', self._get_header())
  529. self._write('#pragma once')
  530. self._write('#include "megdnn/dtype.h"')
  531. self._write('#include <stdint.h>')
  532. if self._param_namespace == 'param':
  533. self._write('#include <string.h>')
  534. self._write('namespace megdnn {')
  535. self._write('namespace %s {', self._param_namespace)
  536. self._process(defs)
  537. self._write('} // namespace megdnn')
  538. self._write('} // namespace %s', self._param_namespace)
  539. self._write('// vim: syntax=cpp.doxygen')
  540. def _write_doc(self, doc):
  541. assert isinstance(doc, member_defs.Doc)
  542. if not doc.doc:
  543. return
  544. if doc.no_reformat:
  545. self._write('/*')
  546. for i in doc.raw_lines:
  547. self._write('* ' + i)
  548. self._write('*/')
  549. return
  550. doc = doc.doc.replace('\n', ' ')
  551. textwidth = 80 - len(self._cur_indent) - 4
  552. if len(doc) <= textwidth:
  553. self._write('//! ' + doc)
  554. return
  555. self._write('/*!')
  556. for i in textwrap.wrap(doc, textwidth):
  557. self._write(' * ' + i)
  558. self._write(' */')
  559. def _on_param_begin(self, p):
  560. self._write_doc(p.name)
  561. self._write('struct %s {', p.name, indent=1)
  562. self._write('static MEGDNN_CONSTEXPR uint32_t TAG = %du;', p.tag)
  563. self._ctor_args = []
  564. self._non_static_members = []
  565. def _add_ctor_args(self, typename, default, varname):
  566. self._ctor_args.append((
  567. '{} {}_={}'.format(typename, varname, default),
  568. varname))
  569. def _on_param_end(self, p):
  570. '''
  571. MegDNN param structures are not packed and we need to initialize the structure
  572. paddings to zero or it would break MegBrain hash system. We do memset(0) in default
  573. ctor and use a trick, wrapping non-static members in a anonymous union which would
  574. copy the object representation in its default copy/move ctor, for copy/move ctor.
  575. > The implicitly-defined copy/move constructor for a non-union class X performs
  576. > a memberwise copy/move of its bases and members. [class.copy.ctor 14]
  577. > The implicitly-defined copy/move constructor for a union X copies the object
  578. > representation (6.9) of X. [class.copy.ctor 15]
  579. '''
  580. if self._non_static_members:
  581. self._write('union { struct {')
  582. for i in self._non_static_members:
  583. if isinstance(i, member_defs.Field):
  584. self._write_doc(i.name)
  585. self._write('%s%s %s;', i.dtype.cname_attr, i.dtype.cname, i.name)
  586. else:
  587. assert isinstance(i, (member_defs.Enum, member_defs.EnumAlias))
  588. self._write('%s %s;', i.name, i.name_field)
  589. self._write('}; };')
  590. if self._ctor_args:
  591. pdefs, varnames = zip(*self._ctor_args)
  592. self._write('%s(%s) {', p.name, ', '.join(pdefs), indent=1)
  593. self._write('memset(this, 0, sizeof(*this));')
  594. for var in varnames:
  595. self._write('this->%s = %s_;', var, var)
  596. self._write('}', indent=-1)
  597. self._write('};\n', indent=-1)
  598. def _on_member_enum(self, e):
  599. self._write_doc(e.name)
  600. self._write('enum class %s: uint32_t {', e.name, indent=1)
  601. for i in e.members:
  602. self._write_doc(i)
  603. v = str(i)
  604. if i is not e.members[-1] or e.member_alias:
  605. v += ','
  606. self._write(v)
  607. for mem, alias in e.member_alias:
  608. if e.combined:
  609. self._write('%s = %s,', alias, e.compose_combined_enum(mem))
  610. else:
  611. self._write('%s = %s,', str(alias).split(' ')[0].split('=')[0], str(mem).split(' ')[0].split('=')[0])
  612. self._write('};', indent=-1)
  613. self._non_static_members.append(e)
  614. self._write('static MEGDNN_CONSTEXPR uint32_t %s_NR_MEMBER = %d;',
  615. str(e.name).upper(), len(e.members))
  616. if e.combined:
  617. default = 'static_cast<{}>({})'.format(e.name, e.compose_combined_enum(e.default))
  618. else:
  619. value = str(e.members[e.default])
  620. value = value.split(' ')[0].split('=')[0]
  621. default = '{}::{}'.format(e.name, value)
  622. self._add_ctor_args(e.name, default, e.name_field)
  623. def _on_member_enum_alias(self, e):
  624. s = e.src_enum
  625. self._write('using %s = %s::%s;', e.name, e.src_class, e.src_name)
  626. self._non_static_members.append(e)
  627. self._write('static MEGDNN_CONSTEXPR uint32_t %s_NR_MEMBER = %d;',
  628. str(e.name).upper(), len(s.members))
  629. if s.combined:
  630. default = 'static_cast<{}>({})'.format(e.name, s.compose_combined_enum(e.default))
  631. else:
  632. value = str(s.members[e.get_default()])
  633. value = value.split(' ')[0].split('=')[0]
  634. default = '{}::{}'.format(e.name, value)
  635. self._add_ctor_args(e.name, default, e.name_field)
  636. def _on_member_field(self, f):
  637. self._non_static_members.append(f)
  638. self._add_ctor_args(f.dtype.cname, f.default, f.name)
  639. def _on_const_field(self, f):
  640. self._write_doc(f.name)
  641. if 'int' in f.dtype.cname:
  642. self._write('static constexpr %s%s %s = %s;', f.dtype.cname_attr, f.dtype.cname, f.name, f.default)
  643. else:
  644. self._write('static const %s%s %s = %s;', f.dtype.cname_attr, f.dtype.cname, f.name, f.default)
  645. class CPPEnumValueWriter(CPPWriter):
  646. _param_namespace = 'param_enumv'
  647. def _on_member_enum(self, e):
  648. self._write_doc(e.name)
  649. self._write('struct %s {', e.name, indent=1)
  650. for val in e.members:
  651. self._write_doc(val)
  652. v = str(val)
  653. self._write('static const uint32_t %s;', v)
  654. for mem, alias in e.member_alias:
  655. self._write('static const uint32_t %s = %s;', str(alias).split(' ')[0].split('=')[0], str(mem).split(' ')[0].split('=')[0])
  656. self._write('};', indent=-1)
  657. def _on_member_enum_alias(self, e):
  658. s = e.src_enum
  659. self._write('typedef %s::%s %s;', e.src_class, e.src_name, e.name)
  660. def _on_member_field(self, f):
  661. pass
  662. def _on_const_field(self, f):
  663. pass
  664. class CPPEnumItemWriter(WriterBase):
  665. _class_name = None
  666. _enum_name = None
  667. _enable = False
  668. def __init__(self, enum_def):
  669. self._class_name, self._enum_name = enum_def.split(':')
  670. def __call__(self, fout, defs):
  671. super().__call__(fout)
  672. self._process(defs)
  673. def _on_param_begin(self, p):
  674. self._enable = p.name == self._class_name
  675. def _on_member_enum(self, e):
  676. if self._enable and e.name == self._enum_name:
  677. for i in e.members:
  678. self._fout.write('{}\n'.format(i))
  679. class CPPParamJsonFuncWriter(IndentWriterBase):
  680. _param_namespace = 'param'
  681. _param_name = None
  682. _items = None
  683. def _write_json_item(self, json_cls, field):
  684. cls2ctype = {
  685. 'NumberInt': 'int64_t',
  686. 'Number': 'double',
  687. 'Bool': 'bool',
  688. }
  689. self._items.append('{"%s", json::%s::make(static_cast<%s>(p.%s))},' % (
  690. field, json_cls, cls2ctype[json_cls], field))
  691. def __call__(self, fout, defs):
  692. super().__call__(fout)
  693. self._write('// %s', self._get_header())
  694. self._write('// this file can only be included in '
  695. 'megbrain/src/plugin/impl/opr_footprint.cpp\n'
  696. '// please do not include it directly')
  697. self._write('#include "megdnn/opr_param_defs.h"')
  698. self._write('#pragma once')
  699. self._write('using namespace megdnn;')
  700. self._write('namespace mgb {')
  701. self._write('namespace opr {')
  702. self._write('template<class OprParam>')
  703. self._write('std::shared_ptr<mgb::json::Value> opr_param_to_json(const OprParam &param);')
  704. self._process(defs)
  705. self._write('} // namespace opr')
  706. self._write('} // namespace mgb')
  707. self._write('\n// vim: syntax=cpp.doxygen')
  708. def _on_param_begin(self, p):
  709. self._write('template<>', indent=0)
  710. self._write(
  711. 'std::shared_ptr<mgb::json::Value> opr_param_to_json(const param::%s &p) {',
  712. p.name, indent=1)
  713. self._param_name = 'param::{}'.format(p.name)
  714. self._items = []
  715. def _on_param_end(self, p):
  716. self._write('return json::Object::make({', indent=1)
  717. for i in self._items:
  718. self._write(i, indent=0)
  719. self._write('});', indent=-1)
  720. self._write('}', indent=-1)
  721. def _on_member_enum(self, e):
  722. self._write('auto %s2str = [](const %s::%s arg) -> std::string {',
  723. e.name, self._param_name, e.name, indent=1)
  724. self._write('switch (arg) {', indent=1)
  725. enum2str = []
  726. if isinstance(e, member_defs.EnumAlias):
  727. members = e.src_enum.members
  728. else:
  729. members = e.members
  730. for i in members:
  731. v = str(i)
  732. v = v.split(' ')[0].split('=')[0]
  733. self._write('case %s::%s::%s: return "%s";',
  734. self._param_name, e.name, v, v, indent=0)
  735. self._write('default: mgb_throw(MegBrainError, "Invalid %s::%s:%%d", static_cast<int>(arg));',
  736. self._param_name, e.name, indent=0)
  737. self._write('}', indent=-1)
  738. self._write('};', indent=-1)
  739. self._items.append('{"%s", json::String::make(%s2str(p.%s))},' % (
  740. e.name_field, e.name, e.name_field))
  741. def _on_member_enum_alias(self, e):
  742. self._on_member_enum(e)
  743. def _on_member_field(self, f):
  744. self._write_json_item(f.dtype.cppjson, f.name)
  745. def _on_const_field(self, f):
  746. pass
  747. def main():
  748. parser = argparse.ArgumentParser(
  749. 'generate opr param defs from description file')
  750. parser.add_argument('--enumv', action='store_true',
  751. help='generate c++03 compatible code which only '
  752. 'contains enum values')
  753. parser.add_argument('-t', '--type', choices=['c++', 'py'], default='c++',
  754. help='output type')
  755. parser.add_argument('--write-enum-items',
  756. help='write enum item names to output file; argument '
  757. 'should be given in the CLASS:ENUM format')
  758. parser.add_argument('--write-cppjson',
  759. help='generate megbrain json serialization implemention'
  760. 'cpp file')
  761. parser.add_argument('input')
  762. parser.add_argument('output')
  763. parser.add_argument('--imperative', action='store_true',
  764. help='generate files for imperatvie ')
  765. args = parser.parse_args()
  766. for_imperative = args.imperative
  767. with open(args.input) as fin:
  768. inputs = fin.read()
  769. exec(inputs, {'pdef': ParamDef, 'Doc': member_defs.Doc})
  770. input_hash = hashlib.sha256()
  771. input_hash.update(inputs.encode(encoding='UTF-8'))
  772. input_hash = input_hash.hexdigest()
  773. if args.type == 'py':
  774. writer = PyWriter(for_imperative=for_imperative)
  775. else:
  776. assert args.type == 'c++'
  777. if args.enumv:
  778. writer = CPPEnumValueWriter()
  779. elif args.write_enum_items:
  780. writer = CPPEnumItemWriter(args.write_enum_items)
  781. else:
  782. writer = CPPWriter()
  783. with open(args.output, 'w') as fout:
  784. writer.set_input_hash(input_hash)(fout, ParamDef.all_param_defs)
  785. if args.write_cppjson:
  786. writer = CPPParamJsonFuncWriter()
  787. with open(args.write_cppjson, 'w') as fout:
  788. writer.set_input_hash(input_hash)(fout, ParamDef.all_param_defs)
  789. if __name__ == '__main__':
  790. main()

MegEngine 安装包中集成了使用 GPU 运行代码所需的 CUDA 环境,不用区分 CPU 和 GPU 版。 如果想要运行 GPU 程序,请确保机器本身配有 GPU 硬件设备并安装好驱动。 如果你想体验在云端 GPU 算力平台进行深度学习开发的感觉,欢迎访问 MegStudio 平台