go_tool.py 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913
  1. import argparse
  2. import copy
  3. import json
  4. import os
  5. import re
  6. import shutil
  7. import subprocess
  8. import sys
  9. import tarfile
  10. import tempfile
  11. import threading
  12. import traceback
  13. from contextlib import contextmanager
  14. from functools import reduce
  15. import process_command_files as pcf
  16. import process_whole_archive_option as pwa
  17. arc_project_prefix = 'a.yandex-team.ru/'
  18. # FIXME: make version-independent
  19. std_lib_prefix = 'contrib/go/_std_1.19/src/'
  20. vendor_prefix = 'vendor/'
  21. vet_info_ext = '.vet.out'
  22. vet_report_ext = '.vet.txt'
  23. FIXED_CGO1_SUFFIX = '.fixed.cgo1.go'
  24. COMPILE_OPTIMIZATION_FLAGS = ('-N',)
  25. def get_trimpath_args(args):
  26. return ['-trimpath', args.trimpath] if args.trimpath else []
  27. def preprocess_cgo1(src_path, dst_path, source_root):
  28. with open(src_path, 'r') as f:
  29. content = f.read()
  30. content = content.replace('__ARCADIA_SOURCE_ROOT_PREFIX__', source_root)
  31. with open(dst_path, 'w') as f:
  32. f.write(content)
  33. def preprocess_args(args):
  34. # Temporary work around for noauto
  35. if args.cgo_srcs and len(args.cgo_srcs) > 0:
  36. cgo_srcs_set = set(args.cgo_srcs)
  37. args.srcs = [x for x in args.srcs if x not in cgo_srcs_set]
  38. args.pkg_root = os.path.join(args.toolchain_root, 'pkg')
  39. toolchain_tool_root = os.path.join(args.pkg_root, 'tool', '{}_{}'.format(args.host_os, args.host_arch))
  40. args.go_compile = os.path.join(toolchain_tool_root, 'compile')
  41. args.go_cgo = os.path.join(toolchain_tool_root, 'cgo')
  42. args.go_link = os.path.join(toolchain_tool_root, 'link')
  43. args.go_asm = os.path.join(toolchain_tool_root, 'asm')
  44. args.go_pack = os.path.join(toolchain_tool_root, 'pack')
  45. args.go_vet = os.path.join(toolchain_tool_root, 'vet') if args.vet is True else args.vet
  46. args.output = os.path.normpath(args.output)
  47. args.vet_report_output = vet_report_output_name(args.output, args.vet_report_ext)
  48. args.trimpath = None
  49. if args.debug_root_map:
  50. roots = {'build': args.build_root, 'source': args.source_root, 'tools': args.tools_root}
  51. replaces = []
  52. for root in args.debug_root_map.split(';'):
  53. src, dst = root.split('=', 1)
  54. assert src in roots
  55. replaces.append('{}=>{}'.format(roots[src], dst))
  56. del roots[src]
  57. assert len(replaces) > 0
  58. args.trimpath = ';'.join(replaces)
  59. args.build_root = os.path.normpath(args.build_root)
  60. args.build_root_dir = args.build_root + os.path.sep
  61. args.source_root = os.path.normpath(args.source_root)
  62. args.source_root_dir = args.source_root + os.path.sep
  63. args.output_root = os.path.normpath(args.output_root)
  64. args.import_map = {}
  65. args.module_map = {}
  66. if args.cgo_peers:
  67. args.cgo_peers = [x for x in args.cgo_peers if not x.endswith('.fake.pkg')]
  68. srcs = []
  69. for f in args.srcs:
  70. if f.endswith('.gosrc'):
  71. with tarfile.open(f, 'r') as tar:
  72. srcs.extend(os.path.join(args.output_root, src) for src in tar.getnames())
  73. tar.extractall(path=args.output_root)
  74. else:
  75. srcs.append(f)
  76. args.srcs = srcs
  77. assert args.mode == 'test' or args.test_srcs is None and args.xtest_srcs is None
  78. # add lexical oreder by basename for go sources
  79. args.srcs.sort(key=lambda x: os.path.basename(x))
  80. if args.test_srcs:
  81. args.srcs += sorted(args.test_srcs, key=lambda x: os.path.basename(x))
  82. del args.test_srcs
  83. if args.xtest_srcs:
  84. args.xtest_srcs.sort(key=lambda x: os.path.basename(x))
  85. # compute root relative module dir path
  86. assert args.output is None or args.output_root == os.path.dirname(args.output)
  87. assert args.output_root.startswith(args.build_root_dir)
  88. args.module_path = args.output_root[len(args.build_root_dir) :]
  89. args.source_module_dir = os.path.join(args.source_root, args.test_import_path or args.module_path) + os.path.sep
  90. assert len(args.module_path) > 0
  91. args.import_path, args.is_std = get_import_path(args.module_path)
  92. assert args.asmhdr is None or args.word == 'go'
  93. srcs = []
  94. for f in args.srcs:
  95. if f.endswith(FIXED_CGO1_SUFFIX) and f.startswith(args.build_root_dir):
  96. path = os.path.join(args.output_root, '{}.cgo1.go'.format(os.path.basename(f[: -len(FIXED_CGO1_SUFFIX)])))
  97. srcs.append(path)
  98. preprocess_cgo1(f, path, args.source_root)
  99. else:
  100. srcs.append(f)
  101. args.srcs = srcs
  102. if args.extldflags:
  103. args.extldflags = pwa.ProcessWholeArchiveOption(args.targ_os).construct_cmd(args.extldflags)
  104. classify_srcs(args.srcs, args)
  105. def compare_versions(version1, version2):
  106. def last_index(version):
  107. index = version.find('beta')
  108. return len(version) if index < 0 else index
  109. v1 = tuple(x.zfill(8) for x in version1[: last_index(version1)].split('.'))
  110. v2 = tuple(x.zfill(8) for x in version2[: last_index(version2)].split('.'))
  111. if v1 == v2:
  112. return 0
  113. return 1 if v1 < v2 else -1
  114. def get_symlink_or_copyfile():
  115. os_symlink = getattr(os, 'symlink', None)
  116. if os_symlink is None or os.name == 'nt':
  117. os_symlink = shutil.copyfile
  118. return os_symlink
  119. def copy_args(args):
  120. return copy.copy(args)
  121. def get_vendor_index(import_path):
  122. index = import_path.rfind('/' + vendor_prefix)
  123. if index < 0:
  124. index = 0 if import_path.startswith(vendor_prefix) else index
  125. else:
  126. index = index + 1
  127. return index
  128. def get_import_path(module_path):
  129. assert len(module_path) > 0
  130. import_path = module_path.replace('\\', '/')
  131. is_std_module = import_path.startswith(std_lib_prefix)
  132. if is_std_module:
  133. import_path = import_path[len(std_lib_prefix) :]
  134. elif import_path.startswith(vendor_prefix):
  135. import_path = import_path[len(vendor_prefix) :]
  136. else:
  137. import_path = arc_project_prefix + import_path
  138. assert len(import_path) > 0
  139. return import_path, is_std_module
  140. def call(cmd, cwd, env=None):
  141. # sys.stderr.write('{}\n'.format(' '.join(cmd)))
  142. return subprocess.check_output(cmd, stdin=None, stderr=subprocess.STDOUT, cwd=cwd, env=env, text=True)
  143. def classify_srcs(srcs, args):
  144. args.go_srcs = [x for x in srcs if x.endswith('.go')]
  145. args.asm_srcs = [x for x in srcs if x.endswith('.s')]
  146. args.objects = [x for x in srcs if x.endswith('.o') or x.endswith('.obj')]
  147. args.symabis = [x for x in srcs if x.endswith('.symabis')]
  148. args.sysos = [x for x in srcs if x.endswith('.syso')]
  149. def get_import_config_info(peers, gen_importmap, import_map={}, module_map={}):
  150. info = {'importmap': [], 'packagefile': [], 'standard': {}}
  151. if gen_importmap:
  152. for key, value in import_map.items():
  153. info['importmap'].append((key, value))
  154. for peer in peers:
  155. peer_import_path, is_std = get_import_path(os.path.dirname(peer))
  156. if gen_importmap:
  157. index = get_vendor_index(peer_import_path)
  158. if index >= 0:
  159. index += len(vendor_prefix)
  160. info['importmap'].append((peer_import_path[index:], peer_import_path))
  161. info['packagefile'].append((peer_import_path, os.path.join(args.build_root, peer)))
  162. if is_std:
  163. info['standard'][peer_import_path] = True
  164. for key, value in module_map.items():
  165. info['packagefile'].append((key, value))
  166. return info
  167. def create_import_config(peers, gen_importmap, import_map={}, module_map={}):
  168. lines = []
  169. info = get_import_config_info(peers, gen_importmap, import_map, module_map)
  170. for key in ('importmap', 'packagefile'):
  171. for item in info[key]:
  172. lines.append('{} {}={}'.format(key, *item))
  173. if len(lines) > 0:
  174. lines.append('')
  175. content = '\n'.join(lines)
  176. # sys.stderr.writelines('{}\n'.format(l) for l in lines)
  177. with tempfile.NamedTemporaryFile(delete=False) as f:
  178. f.write(content.encode('UTF-8'))
  179. return f.name
  180. return None
  181. def create_embed_config(args):
  182. data = {
  183. 'Patterns': {},
  184. 'Files': {},
  185. }
  186. for info in args.embed:
  187. embed_dir = os.path.normpath(info[0])
  188. assert embed_dir == args.source_module_dir[:-1] or embed_dir.startswith(
  189. (args.source_module_dir, args.build_root)
  190. )
  191. pattern = info[1]
  192. if pattern.endswith('/**/*'):
  193. pattern = pattern[:-3]
  194. files = {os.path.relpath(f, embed_dir).replace('\\', '/'): f for f in info[2:]}
  195. data['Patterns'][pattern] = list(files.keys())
  196. data['Files'].update(files)
  197. # sys.stderr.write('{}\n'.format(json.dumps(data, indent=4)))
  198. with tempfile.NamedTemporaryFile(delete=False, suffix='.embedcfg') as f:
  199. f.write(json.dumps(data).encode('UTF-8'))
  200. return f.name
  201. def vet_info_output_name(path, ext=None):
  202. return '{}{}'.format(path, ext or vet_info_ext)
  203. def vet_report_output_name(path, ext=None):
  204. return '{}{}'.format(path, ext or vet_report_ext)
  205. def get_source_path(args):
  206. return args.test_import_path or args.module_path
  207. def gen_vet_info(args):
  208. import_path = args.real_import_path if hasattr(args, 'real_import_path') else args.import_path
  209. info = get_import_config_info(args.peers, True, args.import_map, args.module_map)
  210. import_map = dict(info['importmap'])
  211. # FIXME(snermolaev): it seems that adding import map for 'fake' package
  212. # does't make any harm (it needs to be revised later)
  213. import_map['unsafe'] = 'unsafe'
  214. for key, _ in info['packagefile']:
  215. if key not in import_map:
  216. import_map[key] = key
  217. data = {
  218. 'ID': import_path,
  219. 'Compiler': 'gc',
  220. 'Dir': os.path.join(args.source_root, get_source_path(args)),
  221. 'ImportPath': import_path,
  222. 'GoFiles': [x for x in args.go_srcs if x.endswith('.go')],
  223. 'NonGoFiles': [x for x in args.go_srcs if not x.endswith('.go')],
  224. 'ImportMap': import_map,
  225. 'PackageFile': dict(info['packagefile']),
  226. 'Standard': dict(info['standard']),
  227. 'PackageVetx': dict((key, vet_info_output_name(value)) for key, value in info['packagefile']),
  228. 'VetxOnly': False,
  229. 'VetxOutput': vet_info_output_name(args.output),
  230. 'SucceedOnTypecheckFailure': False,
  231. }
  232. # sys.stderr.write('{}\n'.format(json.dumps(data, indent=4)))
  233. return data
  234. def create_vet_config(args, info):
  235. with tempfile.NamedTemporaryFile(delete=False, suffix='.cfg') as f:
  236. f.write(json.dumps(info).encode('UTF-8'))
  237. return f.name
  238. def decode_vet_report(json_report):
  239. report = ''
  240. if json_report:
  241. try:
  242. full_diags = json.JSONDecoder().decode(json_report.decode('UTF-8'))
  243. except ValueError:
  244. report = json_report
  245. else:
  246. messages = []
  247. for _, module_diags in full_diags.items():
  248. for _, type_diags in module_diags.items():
  249. for diag in type_diags:
  250. messages.append('{}: {}'.format(diag['posn'], json.dumps(diag['message'])))
  251. report = '\n'.join(messages)
  252. return report
  253. def dump_vet_report(args, report):
  254. if report:
  255. report = report.replace(args.build_root, '$B')
  256. report = report.replace(args.source_root, '$S')
  257. with open(args.vet_report_output, 'w') as f:
  258. f.write(report)
  259. def read_vet_report(args):
  260. assert args
  261. report = ''
  262. if os.path.exists(args.vet_report_output):
  263. with open(args.vet_report_output, 'r') as f:
  264. report += f.read()
  265. return report
  266. def dump_vet_report_for_tests(args, *test_args_list):
  267. dump_vet_report(args, reduce(lambda x, y: x + read_vet_report(y), [_f for _f in test_args_list if _f], ''))
  268. def do_vet(args):
  269. assert args.vet
  270. info = gen_vet_info(args)
  271. vet_config = create_vet_config(args, info)
  272. cmd = [args.go_vet, '-json']
  273. if args.vet_flags:
  274. cmd.extend(args.vet_flags)
  275. cmd.append(vet_config)
  276. # sys.stderr.write('>>>> [{}]\n'.format(' '.join(cmd)))
  277. p_vet = subprocess.Popen(cmd, stdin=None, stderr=subprocess.PIPE, stdout=subprocess.PIPE, cwd=args.source_root)
  278. vet_out, vet_err = p_vet.communicate()
  279. report = decode_vet_report(vet_out) if vet_out else ''
  280. dump_vet_report(args, report)
  281. if p_vet.returncode:
  282. raise subprocess.CalledProcessError(returncode=p_vet.returncode, cmd=cmd, output=vet_err)
  283. def _do_compile_go(args):
  284. import_path, is_std_module = args.import_path, args.is_std
  285. cmd = [
  286. args.go_compile,
  287. '-o',
  288. args.output,
  289. '-p',
  290. import_path if import_path != "unsafe" else "",
  291. '-D',
  292. '""',
  293. ]
  294. if args.lang:
  295. cmd.append('-lang=go{}'.format(args.lang))
  296. cmd.extend(get_trimpath_args(args))
  297. compiling_runtime = False
  298. if is_std_module:
  299. cmd.append('-std')
  300. if import_path in ('runtime', 'internal/abi', 'internal/bytealg', 'internal/cpu') or import_path.startswith(
  301. 'runtime/internal/'
  302. ):
  303. cmd.append('-+')
  304. compiling_runtime = True
  305. import_config_name = create_import_config(args.peers, True, args.import_map, args.module_map)
  306. if import_config_name:
  307. cmd += ['-importcfg', import_config_name]
  308. else:
  309. if import_path == 'unsafe' or len(args.objects) > 0 or args.asmhdr:
  310. pass
  311. else:
  312. cmd.append('-complete')
  313. # if compare_versions('1.16', args.goversion) >= 0:
  314. if args.embed:
  315. embed_config_name = create_embed_config(args)
  316. cmd.extend(['-embedcfg', embed_config_name])
  317. if args.asmhdr:
  318. cmd += ['-asmhdr', args.asmhdr]
  319. # Use .symabis (starting from 1.12 version)
  320. if args.symabis:
  321. cmd += ['-symabis'] + args.symabis
  322. # If 1.12 <= version < 1.13 we have to pass -allabis for 'runtime' and 'runtime/internal/atomic'
  323. # if compare_versions('1.13', args.goversion) >= 0:
  324. # pass
  325. # elif import_path in ('runtime', 'runtime/internal/atomic'):
  326. # cmd.append('-allabis')
  327. compile_workers = '4'
  328. if args.compile_flags:
  329. if compiling_runtime:
  330. cmd.extend(x for x in args.compile_flags if x not in COMPILE_OPTIMIZATION_FLAGS)
  331. else:
  332. cmd.extend(args.compile_flags)
  333. if any([x in ('-race', '-shared') for x in args.compile_flags]):
  334. compile_workers = '1'
  335. cmd += ['-pack', '-c={}'.format(compile_workers)]
  336. cmd += args.go_srcs
  337. call(cmd, args.build_root)
  338. class VetThread(threading.Thread):
  339. def __init__(self, target, args):
  340. super(VetThread, self).__init__(target=target, args=args)
  341. self.exc_info = None
  342. def run(self):
  343. try:
  344. super(VetThread, self).run()
  345. except:
  346. self.exc_info = sys.exc_info()
  347. def join_with_exception(self, reraise_exception):
  348. self.join()
  349. if reraise_exception and self.exc_info:
  350. raise self.exc_info[0].with_traceback(self.exc_info[1], self.exc_info[2])
  351. def do_compile_go(args):
  352. raise_exception_from_vet = False
  353. if args.vet:
  354. run_vet = VetThread(target=do_vet, args=(args,))
  355. run_vet.start()
  356. try:
  357. _do_compile_go(args)
  358. raise_exception_from_vet = True
  359. finally:
  360. if args.vet:
  361. run_vet.join_with_exception(raise_exception_from_vet)
  362. def do_compile_asm(args):
  363. def need_compiling_runtime(import_path):
  364. return (
  365. import_path in ('runtime', 'reflect', 'syscall')
  366. or import_path.startswith('runtime/internal/')
  367. or compare_versions('1.17', args.goversion) >= 0
  368. and import_path == 'internal/bytealg'
  369. )
  370. assert len(args.srcs) == 1 and len(args.asm_srcs) == 1
  371. cmd = [args.go_asm]
  372. cmd += get_trimpath_args(args)
  373. cmd += ['-I', args.output_root, '-I', os.path.join(args.pkg_root, 'include')]
  374. cmd += ['-D', 'GOOS_' + args.targ_os, '-D', 'GOARCH_' + args.targ_arch, '-o', args.output]
  375. # if compare_versions('1.16', args.goversion) >= 0:
  376. cmd += ['-p', args.import_path]
  377. if need_compiling_runtime(args.import_path):
  378. cmd += ['-compiling-runtime']
  379. if args.asm_flags:
  380. cmd += args.asm_flags
  381. cmd += args.asm_srcs
  382. call(cmd, args.build_root)
  383. def do_link_lib(args):
  384. if len(args.asm_srcs) > 0:
  385. asmargs = copy_args(args)
  386. asmargs.asmhdr = os.path.join(asmargs.output_root, 'go_asm.h')
  387. do_compile_go(asmargs)
  388. for src in asmargs.asm_srcs:
  389. asmargs.srcs = [src]
  390. asmargs.asm_srcs = [src]
  391. asmargs.output = os.path.join(asmargs.output_root, os.path.basename(src) + '.o')
  392. do_compile_asm(asmargs)
  393. args.objects.append(asmargs.output)
  394. else:
  395. do_compile_go(args)
  396. if args.objects or args.sysos:
  397. cmd = [args.go_pack, 'r', args.output] + args.objects + args.sysos
  398. call(cmd, args.build_root)
  399. def do_link_exe(args):
  400. assert args.extld is not None
  401. assert args.non_local_peers is not None
  402. compile_args = copy_args(args)
  403. compile_args.output = os.path.join(args.output_root, 'main.a')
  404. compile_args.real_import_path = compile_args.import_path
  405. compile_args.import_path = 'main'
  406. if args.vcs and os.path.isfile(compile_args.vcs):
  407. build_info = os.path.join('library', 'go', 'core', 'buildinfo')
  408. if any([x.startswith(build_info) for x in compile_args.peers]):
  409. compile_args.go_srcs.append(compile_args.vcs)
  410. do_link_lib(compile_args)
  411. cmd = [args.go_link, '-o', args.output]
  412. import_config_name = create_import_config(
  413. args.peers + args.non_local_peers, False, args.import_map, args.module_map
  414. )
  415. if import_config_name:
  416. cmd += ['-importcfg', import_config_name]
  417. if args.link_flags:
  418. cmd += args.link_flags
  419. extldflags = []
  420. if args.buildmode:
  421. cmd.append('-buildmode={}'.format(args.buildmode))
  422. elif args.mode in ('exe', 'test'):
  423. cmd.append('-buildmode=exe')
  424. if 'ld.lld' in str(args):
  425. extldflags.append('-Wl,-no-pie')
  426. elif args.mode == 'dll':
  427. cmd.append('-buildmode=c-shared')
  428. else:
  429. assert False, 'Unexpected mode: {}'.format(args.mode)
  430. cmd.append('-extld={}'.format(args.extld))
  431. if args.extldflags is not None:
  432. filter_musl = bool
  433. if args.musl:
  434. cmd.append('-linkmode=external')
  435. extldflags.append('-static')
  436. filter_musl = lambda x: x not in ('-lc', '-ldl', '-lm', '-lpthread', '-lrt')
  437. extldflags += [x for x in args.extldflags if filter_musl(x)]
  438. cgo_peers = []
  439. if args.cgo_peers is not None and len(args.cgo_peers) > 0:
  440. is_group = args.targ_os == 'linux'
  441. if is_group:
  442. cgo_peers.append('-Wl,--start-group')
  443. cgo_peers.extend(args.cgo_peers)
  444. if is_group:
  445. cgo_peers.append('-Wl,--end-group')
  446. try:
  447. index = extldflags.index('--cgo-peers')
  448. extldflags = extldflags[:index] + cgo_peers + extldflags[index + 1 :]
  449. except ValueError:
  450. extldflags.extend(cgo_peers)
  451. if len(extldflags) > 0:
  452. cmd.append('-extldflags={}'.format(' '.join(extldflags)))
  453. cmd.append(compile_args.output)
  454. call(cmd, args.build_root)
  455. def gen_cover_info(args):
  456. lines = []
  457. lines.extend(
  458. [
  459. """
  460. var (
  461. coverCounters = make(map[string][]uint32)
  462. coverBlocks = make(map[string][]testing.CoverBlock)
  463. )
  464. """,
  465. 'func init() {',
  466. ]
  467. )
  468. for var, file in (x.split(':') for x in args.cover_info):
  469. lines.append(
  470. ' coverRegisterFile("{file}", _cover0.{var}.Count[:], _cover0.{var}.Pos[:], _cover0.{var}.NumStmt[:])'.format(
  471. file=file, var=var
  472. )
  473. )
  474. lines.extend(
  475. [
  476. '}',
  477. """
  478. func coverRegisterFile(fileName string, counter []uint32, pos []uint32, numStmts []uint16) {
  479. if 3*len(counter) != len(pos) || len(counter) != len(numStmts) {
  480. panic("coverage: mismatched sizes")
  481. }
  482. if coverCounters[fileName] != nil {
  483. // Already registered.
  484. return
  485. }
  486. coverCounters[fileName] = counter
  487. block := make([]testing.CoverBlock, len(counter))
  488. for i := range counter {
  489. block[i] = testing.CoverBlock{
  490. Line0: pos[3*i+0],
  491. Col0: uint16(pos[3*i+2]),
  492. Line1: pos[3*i+1],
  493. Col1: uint16(pos[3*i+2]>>16),
  494. Stmts: numStmts[i],
  495. }
  496. }
  497. coverBlocks[fileName] = block
  498. }
  499. """,
  500. ]
  501. )
  502. return lines
  503. def filter_out_skip_tests(tests, skip_tests):
  504. skip_set = set()
  505. star_skip_set = set()
  506. for t in skip_tests:
  507. work_set = star_skip_set if '*' in t else skip_set
  508. work_set.add(t)
  509. re_star_tests = None
  510. if len(star_skip_set) > 0:
  511. re_star_tests = re.compile(re.sub(r'(\*)+', r'.\1', '^({})$'.format('|'.join(star_skip_set))))
  512. return [x for x in tests if not (x in skip_tests or re_star_tests and re_star_tests.match(x))]
  513. @contextmanager
  514. def create_strip_symlink():
  515. # This function creates symlink of llvm-strip as strip for golink needs.
  516. # We believe that cc-binaries path is a first element in PATH enviroment variable.
  517. tmpdir = None
  518. if os.getenv("CC") == "clang":
  519. tmpdir = tempfile.mkdtemp()
  520. cc_path = os.getenv("PATH").split(os.pathsep)[0]
  521. os.environ["PATH"] += os.pathsep + tmpdir
  522. src_strip_path = os.path.join(cc_path, 'llvm-strip')
  523. dst_strip_path = os.path.join(tmpdir, 'strip')
  524. os.symlink(src_strip_path, dst_strip_path)
  525. try:
  526. yield
  527. finally:
  528. if tmpdir:
  529. shutil.rmtree(tmpdir)
  530. def gen_test_main(args, test_lib_args, xtest_lib_args):
  531. assert args and (test_lib_args or xtest_lib_args)
  532. test_miner = args.test_miner
  533. test_module_path = test_lib_args.import_path if test_lib_args else xtest_lib_args.import_path
  534. is_cover = args.cover_info and len(args.cover_info) > 0
  535. # Prepare GOPATH
  536. # $BINDIR
  537. # |- __go__
  538. # |- src
  539. # |- pkg
  540. # |- ${TARGET_OS}_${TARGET_ARCH}
  541. go_path_root = os.path.join(args.output_root, '__go__')
  542. test_src_dir = os.path.join(go_path_root, 'src')
  543. target_os_arch = '_'.join([args.targ_os, args.targ_arch])
  544. test_pkg_dir = os.path.join(go_path_root, 'pkg', target_os_arch, os.path.dirname(test_module_path))
  545. os.makedirs(test_pkg_dir)
  546. my_env = os.environ.copy()
  547. my_env['GOROOT'] = ''
  548. my_env['GOPATH'] = go_path_root
  549. my_env['GOARCH'] = args.targ_arch
  550. my_env['GOOS'] = args.targ_os
  551. tests = []
  552. xtests = []
  553. os_symlink = get_symlink_or_copyfile()
  554. # Get the list of "internal" tests
  555. if test_lib_args:
  556. os.makedirs(os.path.join(test_src_dir, test_module_path))
  557. os_symlink(test_lib_args.output, os.path.join(test_pkg_dir, os.path.basename(test_module_path) + '.a'))
  558. cmd = [test_miner, '-benchmarks', '-tests', test_module_path]
  559. tests = [x for x in (call(cmd, test_lib_args.output_root, my_env) or '').strip().split('\n') if len(x) > 0]
  560. if args.skip_tests:
  561. tests = filter_out_skip_tests(tests, args.skip_tests)
  562. test_main_found = '#TestMain' in tests
  563. # Get the list of "external" tests
  564. if xtest_lib_args:
  565. xtest_module_path = xtest_lib_args.import_path
  566. os.makedirs(os.path.join(test_src_dir, xtest_module_path))
  567. os_symlink(xtest_lib_args.output, os.path.join(test_pkg_dir, os.path.basename(xtest_module_path) + '.a'))
  568. cmd = [test_miner, '-benchmarks', '-tests', xtest_module_path]
  569. xtests = [x for x in (call(cmd, xtest_lib_args.output_root, my_env) or '').strip().split('\n') if len(x) > 0]
  570. if args.skip_tests:
  571. xtests = filter_out_skip_tests(xtests, args.skip_tests)
  572. xtest_main_found = '#TestMain' in xtests
  573. test_main_package = None
  574. if test_main_found and xtest_main_found:
  575. assert False, 'multiple definition of TestMain'
  576. elif test_main_found:
  577. test_main_package = '_test'
  578. elif xtest_main_found:
  579. test_main_package = '_xtest'
  580. shutil.rmtree(go_path_root)
  581. lines = ['package main', '', 'import (']
  582. if test_main_package is None:
  583. lines.append(' "os"')
  584. lines.extend([' "testing"', ' "testing/internal/testdeps"'])
  585. lines.extend([' _ "{}library/go/test/yatest"'.format(args.arc_project_prefix)])
  586. if len(tests) > 0:
  587. lines.append(' _test "{}"'.format(test_module_path))
  588. elif test_lib_args:
  589. lines.append(' _ "{}"'.format(test_module_path))
  590. if len(xtests) > 0:
  591. lines.append(' _xtest "{}"'.format(xtest_module_path))
  592. elif xtest_lib_args:
  593. lines.append(' _ "{}"'.format(xtest_module_path))
  594. if is_cover:
  595. lines.append(' _cover0 "{}"'.format(test_module_path))
  596. lines.extend([')', ''])
  597. if compare_versions('1.18', args.goversion) < 0:
  598. kinds = ['Test', 'Benchmark', 'Example']
  599. else:
  600. kinds = ['Test', 'Benchmark', 'FuzzTarget', 'Example']
  601. var_names = []
  602. for kind in kinds:
  603. var_name = '{}s'.format(kind.lower())
  604. var_names.append(var_name)
  605. lines.append('var {} = []testing.Internal{}{{'.format(var_name, kind))
  606. for test in [x for x in tests if x.startswith(kind)]:
  607. lines.append(' {{"{test}", _test.{test}}},'.format(test=test))
  608. for test in [x for x in xtests if x.startswith(kind)]:
  609. lines.append(' {{"{test}", _xtest.{test}}},'.format(test=test))
  610. lines.extend(['}', ''])
  611. if is_cover:
  612. lines.extend(gen_cover_info(args))
  613. lines.append('func main() {')
  614. if is_cover:
  615. lines.extend(
  616. [
  617. ' testing.RegisterCover(testing.Cover{',
  618. ' Mode: "set",',
  619. ' Counters: coverCounters,',
  620. ' Blocks: coverBlocks,',
  621. ' CoveredPackages: "",',
  622. ' })',
  623. ]
  624. )
  625. lines.extend(
  626. [
  627. ' m := testing.MainStart(testdeps.TestDeps{{}}, {})'.format(', '.join(var_names)),
  628. '',
  629. ]
  630. )
  631. if test_main_package:
  632. lines.append(' {}.TestMain(m)'.format(test_main_package))
  633. else:
  634. lines.append(' os.Exit(m.Run())')
  635. lines.extend(['}', ''])
  636. content = '\n'.join(lines)
  637. # sys.stderr.write('{}\n'.format(content))
  638. return content
  639. def do_link_test(args):
  640. assert args.srcs or args.xtest_srcs
  641. assert args.test_miner is not None
  642. test_module_path = get_source_path(args)
  643. test_import_path, _ = get_import_path(test_module_path)
  644. test_lib_args = copy_args(args) if args.srcs else None
  645. xtest_lib_args = copy_args(args) if args.xtest_srcs else None
  646. if xtest_lib_args is not None:
  647. xtest_lib_args.embed = args.embed_xtest if args.embed_xtest else None
  648. ydx_file_name = None
  649. xtest_ydx_file_name = None
  650. need_append_ydx = test_lib_args and xtest_lib_args and args.ydx_file and args.vet_flags
  651. if need_append_ydx:
  652. def find_ydx_file_name(name, flags):
  653. for i, elem in enumerate(flags):
  654. if elem.endswith(name):
  655. return (i, elem)
  656. assert False, 'Unreachable code'
  657. idx, ydx_file_name = find_ydx_file_name(xtest_lib_args.ydx_file, xtest_lib_args.vet_flags)
  658. xtest_ydx_file_name = '{}_xtest'.format(ydx_file_name)
  659. xtest_lib_args.vet_flags = copy.copy(xtest_lib_args.vet_flags)
  660. xtest_lib_args.vet_flags[idx] = xtest_ydx_file_name
  661. if test_lib_args:
  662. test_lib_args.output = os.path.join(args.output_root, 'test.a')
  663. test_lib_args.vet_report_output = vet_report_output_name(test_lib_args.output)
  664. test_lib_args.module_path = test_module_path
  665. test_lib_args.import_path = test_import_path
  666. do_link_lib(test_lib_args)
  667. if xtest_lib_args:
  668. xtest_lib_args.srcs = xtest_lib_args.xtest_srcs
  669. classify_srcs(xtest_lib_args.srcs, xtest_lib_args)
  670. xtest_lib_args.output = os.path.join(args.output_root, 'xtest.a')
  671. xtest_lib_args.vet_report_output = vet_report_output_name(xtest_lib_args.output)
  672. xtest_lib_args.module_path = test_module_path + '_test'
  673. xtest_lib_args.import_path = test_import_path + '_test'
  674. if test_lib_args:
  675. xtest_lib_args.module_map[test_import_path] = test_lib_args.output
  676. need_append_ydx = args.ydx_file and args.srcs and args.vet_flags
  677. do_link_lib(xtest_lib_args)
  678. if need_append_ydx:
  679. with open(os.path.join(args.build_root, ydx_file_name), 'ab') as dst_file:
  680. with open(os.path.join(args.build_root, xtest_ydx_file_name), 'rb') as src_file:
  681. dst_file.write(src_file.read())
  682. test_main_content = gen_test_main(args, test_lib_args, xtest_lib_args)
  683. test_main_name = os.path.join(args.output_root, '_test_main.go')
  684. with open(test_main_name, "w") as f:
  685. f.write(test_main_content)
  686. test_args = copy_args(args)
  687. test_args.embed = None
  688. test_args.srcs = [test_main_name]
  689. if test_args.test_import_path is None:
  690. # it seems that we can do it unconditionally, but this kind
  691. # of mangling doesn't really looks good to me and we leave it
  692. # for pure GO_TEST module
  693. test_args.module_path = test_args.module_path + '___test_main__'
  694. test_args.import_path = test_args.import_path + '___test_main__'
  695. classify_srcs(test_args.srcs, test_args)
  696. if test_lib_args:
  697. test_args.module_map[test_lib_args.import_path] = test_lib_args.output
  698. if xtest_lib_args:
  699. test_args.module_map[xtest_lib_args.import_path] = xtest_lib_args.output
  700. if args.vet:
  701. dump_vet_report_for_tests(test_args, test_lib_args, xtest_lib_args)
  702. test_args.vet = False
  703. do_link_exe(test_args)
  704. if __name__ == '__main__':
  705. args = pcf.get_args(sys.argv[1:])
  706. parser = argparse.ArgumentParser(prefix_chars='+')
  707. parser.add_argument('++mode', choices=['dll', 'exe', 'lib', 'test'], required=True)
  708. parser.add_argument('++buildmode', choices=['c-shared', 'exe', 'pie'])
  709. parser.add_argument('++srcs', nargs='*', required=True)
  710. parser.add_argument('++cgo-srcs', nargs='*')
  711. parser.add_argument('++test_srcs', nargs='*')
  712. parser.add_argument('++xtest_srcs', nargs='*')
  713. parser.add_argument('++cover_info', nargs='*')
  714. parser.add_argument('++output', nargs='?', default=None)
  715. parser.add_argument('++source-root', default=None)
  716. parser.add_argument('++build-root', required=True)
  717. parser.add_argument('++tools-root', default=None)
  718. parser.add_argument('++output-root', required=True)
  719. parser.add_argument('++toolchain-root', required=True)
  720. parser.add_argument('++host-os', choices=['linux', 'darwin', 'windows'], required=True)
  721. parser.add_argument('++host-arch', choices=['amd64', 'arm64'], required=True)
  722. parser.add_argument('++targ-os', choices=['linux', 'darwin', 'windows'], required=True)
  723. parser.add_argument('++targ-arch', choices=['amd64', 'x86', 'arm64'], required=True)
  724. parser.add_argument('++peers', nargs='*')
  725. parser.add_argument('++non-local-peers', nargs='*')
  726. parser.add_argument('++cgo-peers', nargs='*')
  727. parser.add_argument('++asmhdr', nargs='?', default=None)
  728. parser.add_argument('++test-import-path', nargs='?')
  729. parser.add_argument('++test-miner', nargs='?')
  730. parser.add_argument('++arc-project-prefix', nargs='?', default=arc_project_prefix)
  731. parser.add_argument('++std-lib-prefix', nargs='?', default=std_lib_prefix)
  732. parser.add_argument('++vendor-prefix', nargs='?', default=vendor_prefix)
  733. parser.add_argument('++extld', nargs='?', default=None)
  734. parser.add_argument('++extldflags', nargs='+', default=None)
  735. parser.add_argument('++goversion', required=True)
  736. parser.add_argument('++lang', nargs='?', default=None)
  737. parser.add_argument('++asm-flags', nargs='*')
  738. parser.add_argument('++compile-flags', nargs='*')
  739. parser.add_argument('++link-flags', nargs='*')
  740. parser.add_argument('++vcs', nargs='?', default=None)
  741. parser.add_argument('++vet', nargs='?', const=True, default=False)
  742. parser.add_argument('++vet-flags', nargs='*', default=None)
  743. parser.add_argument('++vet-info-ext', default=vet_info_ext)
  744. parser.add_argument('++vet-report-ext', default=vet_report_ext)
  745. parser.add_argument('++musl', action='store_true')
  746. parser.add_argument('++skip-tests', nargs='*', default=None)
  747. parser.add_argument('++ydx-file', default='')
  748. parser.add_argument('++debug-root-map', default=None)
  749. parser.add_argument('++embed', action='append', nargs='*')
  750. parser.add_argument('++embed_xtest', action='append', nargs='*')
  751. args = parser.parse_args(args)
  752. arc_project_prefix = args.arc_project_prefix
  753. std_lib_prefix = args.std_lib_prefix
  754. vendor_prefix = args.vendor_prefix
  755. vet_info_ext = args.vet_info_ext
  756. vet_report_ext = args.vet_report_ext
  757. preprocess_args(args)
  758. try:
  759. os.unlink(args.output)
  760. except OSError:
  761. pass
  762. # We are going to support only 'lib', 'exe' and 'cgo' build modes currently
  763. # and as a result we are going to generate only one build node per module
  764. # (or program)
  765. dispatch = {'exe': do_link_exe, 'dll': do_link_exe, 'lib': do_link_lib, 'test': do_link_test}
  766. exit_code = 1
  767. try:
  768. with create_strip_symlink():
  769. dispatch[args.mode](args)
  770. exit_code = 0
  771. except KeyError:
  772. sys.stderr.write('Unknown build mode [{}]...\n'.format(args.mode))
  773. except subprocess.CalledProcessError as e:
  774. sys.stderr.write('{} returned non-zero exit code {}.\n{}\n'.format(' '.join(e.cmd), e.returncode, e.output))
  775. exit_code = e.returncode
  776. except AssertionError as e:
  777. traceback.print_exc(file=sys.stderr)
  778. except Exception as e:
  779. sys.stderr.write('Unhandled exception [{}]...\n'.format(str(e)))
  780. sys.exit(exit_code)