go_tool.py 33 KB

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