koch.nim 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782
  1. #
  2. #
  3. # Maintenance program for Nim
  4. # (c) Copyright 2017 Andreas Rumpf
  5. #
  6. # See the file "copying.txt", included in this
  7. # distribution, for details about the copyright.
  8. #
  9. # See doc/koch.txt for documentation.
  10. #
  11. const
  12. # examples of possible values for repos: Head, ea82b54
  13. NimbleStableCommit = "4fb6f8e6c33963f6f510fe82d09ad2a61b5e4265" # 0.16.1
  14. AtlasStableCommit = "5faec3e9a33afe99a7d22377dd1b45a5391f5504"
  15. ChecksumsStableCommit = "bd9bf4eaea124bf8d01e08f92ac1b14c6879d8d3"
  16. SatStableCommit = "faf1617f44d7632ee9601ebc13887644925dcc01"
  17. # examples of possible values for fusion: #head, #ea82b54, 1.2.3
  18. FusionStableHash = "#372ee4313827ef9f2ea388840f7d6b46c2b1b014"
  19. HeadHash = "#head"
  20. when not defined(windows):
  21. const
  22. Z3StableCommit = "65de3f748a6812eecd7db7c478d5fc54424d368b" # the version of Z3 that DrNim uses
  23. when defined(gcc) and defined(windows):
  24. when defined(x86):
  25. {.link: "icons/koch.res".}
  26. else:
  27. {.link: "icons/koch_icon.o".}
  28. when defined(amd64) and defined(windows) and defined(vcc):
  29. {.link: "icons/koch-amd64-windows-vcc.res".}
  30. when defined(i386) and defined(windows) and defined(vcc):
  31. {.link: "icons/koch-i386-windows-vcc.res".}
  32. import std/[os, strutils, parseopt, osproc]
  33. # Using `std/os` instead of `os` to fail early if config isn't set up properly.
  34. # If this fails with: `Error: cannot open file: std/os`, see
  35. # https://github.com/nim-lang/Nim/pull/14291 for explanation + how to fix.
  36. when defined(nimPreviewSlimSystem):
  37. import std/[assertions, syncio]
  38. import tools / kochdocs
  39. import tools / deps
  40. const VersionAsString = system.NimVersion
  41. const
  42. HelpText = """
  43. +-----------------------------------------------------------------+
  44. | Maintenance program for Nim |
  45. | Version $1|
  46. | (c) 2017 Andreas Rumpf |
  47. +-----------------------------------------------------------------+
  48. Build time: $2, $3
  49. Usage:
  50. koch [options] command [options for command]
  51. Options:
  52. --help, -h shows this help and quits
  53. --latest bundle the installers with bleeding edge versions of
  54. external components.
  55. --stable bundle the installers with stable versions of
  56. external components (default).
  57. --nim:path use specified path for nim binary
  58. --localdocs[:path] only build local documentations. If a path is not
  59. specified (or empty), the default is used.
  60. --skipIntegrityCheck skips integrity check when booting the compiler
  61. Possible Commands:
  62. boot [options] bootstraps with given command line options
  63. distrohelper [bindir] helper for distro packagers
  64. tools builds Nim related tools
  65. toolsNoExternal builds Nim related tools (except external tools,
  66. e.g. nimble)
  67. doesn't require network connectivity
  68. nimble builds the Nimble tool
  69. atlas builds the Atlas tool
  70. fusion installs fusion via Nimble
  71. Boot options:
  72. -d:release produce a release version of the compiler
  73. -d:nimUseLinenoise use the linenoise library for interactive mode
  74. `nim secret` (not needed on Windows)
  75. -d:leanCompiler produce a compiler without JS codegen or
  76. documentation generator in order to use less RAM
  77. for bootstrapping
  78. -d:nimHasLibFFI adds FFI support for allowing compile-time VM to
  79. interface with native functions (experimental,
  80. requires prior `koch installdeps libffi`)
  81. Commands for core developers:
  82. runCI runs continuous integration (CI), e.g. from Github Actions
  83. docs [options] generates the full documentation
  84. csource -d:danger builds the C sources for installation
  85. pdf builds the PDF documentation
  86. zip builds the installation zip package
  87. xz builds the installation tar.xz package
  88. testinstall test tar.xz package; Unix only!
  89. installdeps [options] installs external dependency (e.g. tinyc) to dist/
  90. tests [options] run the testsuite (run a subset of tests by
  91. specifying a category, e.g. `tests cat async`)
  92. temp options creates a temporary compiler for testing
  93. """
  94. let kochExe* = when isMainModule: os.getAppFilename() # always correct when koch is main program, even if `koch` exe renamed e.g.: `nim c -o:koch_debug koch.nim`
  95. else: getAppDir() / "koch".exe # works for winrelease
  96. proc kochExec*(cmd: string) =
  97. exec kochExe.quoteShell & " " & cmd
  98. proc kochExecFold*(desc, cmd: string) =
  99. execFold(desc, kochExe.quoteShell & " " & cmd)
  100. template withDir(dir, body) =
  101. let old = getCurrentDir()
  102. try:
  103. setCurrentDir(dir)
  104. body
  105. finally:
  106. setCurrentDir(old)
  107. let origDir = getCurrentDir()
  108. setCurrentDir(getAppDir())
  109. proc tryExec(cmd: string): bool =
  110. echo(cmd)
  111. result = execShellCmd(cmd) == 0
  112. proc safeRemove(filename: string) =
  113. if fileExists(filename): removeFile(filename)
  114. proc overwriteFile(source, dest: string) =
  115. safeRemove(dest)
  116. moveFile(source, dest)
  117. proc copyExe(source, dest: string) =
  118. safeRemove(dest)
  119. copyFile(dest=dest, source=source)
  120. inclFilePermissions(dest, {fpUserExec, fpGroupExec, fpOthersExec})
  121. const
  122. compileNimInst = "tools/niminst/niminst"
  123. distDir = "dist"
  124. proc csource(args: string) =
  125. nimexec(("cc $1 -r $3 --var:version=$2 --var:mingw=none csource " &
  126. "--main:compiler/nim.nim compiler/installer.ini $1") %
  127. [args, VersionAsString, compileNimInst])
  128. proc bundleC2nim(args: string) =
  129. cloneDependency(distDir, "https://github.com/nim-lang/c2nim.git")
  130. nimCompile("dist/c2nim/c2nim",
  131. options = "--noNimblePath --path:. " & args)
  132. proc bundleNimbleExe(latest: bool, args: string) =
  133. let commit = if latest: "HEAD" else: NimbleStableCommit
  134. cloneDependency(distDir, "https://github.com/nim-lang/nimble.git",
  135. commit = commit, allowBundled = true)
  136. cloneDependency(distDir / "nimble" / distDir, "https://github.com/nim-lang/checksums.git",
  137. commit = ChecksumsStableCommit, allowBundled = true) # or copy it from dist?
  138. cloneDependency(distDir / "nimble" / distDir, "https://github.com/nim-lang/sat.git",
  139. commit = SatStableCommit, allowBundled = true)
  140. # installer.ini expects it under $nim/bin
  141. nimCompile("dist/nimble/src/nimble.nim",
  142. options = "-d:release -d:nimNimbleBootstrap --noNimblePath " & args)
  143. proc bundleAtlasExe(latest: bool, args: string) =
  144. let commit = if latest: "HEAD" else: AtlasStableCommit
  145. cloneDependency(distDir, "https://github.com/nim-lang/atlas.git",
  146. commit = commit, allowBundled = true)
  147. cloneDependency(distDir / "atlas" / distDir, "https://github.com/nim-lang/sat.git",
  148. commit = SatStableCommit, allowBundled = true)
  149. # installer.ini expects it under $nim/bin
  150. nimCompile("dist/atlas/src/atlas.nim",
  151. options = "-d:release --noNimblePath -d:nimAtlasBootstrap " & args)
  152. proc bundleNimsuggest(args: string) =
  153. nimCompileFold("Compile nimsuggest", "nimsuggest/nimsuggest.nim",
  154. options = "-d:danger " & args)
  155. proc buildVccTool(args: string) =
  156. let input = "tools/vccexe/vccexe.nim"
  157. if contains(args, "--cc:vcc"):
  158. nimCompileFold("Compile Vcc", input, "build", options = args)
  159. let fileName = input.splitFile.name
  160. moveFile(exe("build" / fileName), exe("bin" / fileName))
  161. else:
  162. nimCompileFold("Compile Vcc", input, options = args)
  163. proc bundleNimpretty(args: string) =
  164. nimCompileFold("Compile nimpretty", "nimpretty/nimpretty.nim",
  165. options = "-d:release " & args)
  166. proc bundleWinTools(args: string) =
  167. nimCompile("tools/finish.nim", outputDir = "", options = args)
  168. buildVccTool(args)
  169. nimCompile("tools/nimgrab.nim", options = "-d:ssl " & args)
  170. nimCompile("tools/nimgrep.nim", options = args)
  171. nimCompile("testament/testament.nim", options = args)
  172. when false:
  173. # not yet a tool worth including
  174. nimCompile(r"tools\downloader.nim",
  175. options = r"--cc:vcc --app:gui -d:ssl --noNimblePath --path:..\ui " & args)
  176. proc bundleChecksums(latest: bool) =
  177. let commit = if latest: "HEAD" else: ChecksumsStableCommit
  178. cloneDependency(distDir, "https://github.com/nim-lang/checksums.git", commit, allowBundled = true)
  179. proc zip(latest: bool; args: string) =
  180. bundleChecksums(latest)
  181. bundleNimbleExe(latest, args)
  182. bundleAtlasExe(latest, args)
  183. bundleNimsuggest(args)
  184. bundleNimpretty(args)
  185. bundleWinTools(args)
  186. nimexec("cc -r $2 --var:version=$1 --var:mingw=none --main:compiler/nim.nim scripts compiler/installer.ini" %
  187. [VersionAsString, compileNimInst])
  188. exec("$# --var:version=$# --var:mingw=none --main:compiler/nim.nim zip compiler/installer.ini" %
  189. ["tools/niminst/niminst".exe, VersionAsString])
  190. proc ensureCleanGit() =
  191. let (outp, status) = osproc.execCmdEx("git diff")
  192. if outp.len != 0:
  193. quit "Not a clean git repository; 'git diff' not empty!"
  194. if status != 0:
  195. quit "Not a clean git repository; 'git diff' returned non-zero!"
  196. proc xz(latest: bool; args: string) =
  197. ensureCleanGit()
  198. nimexec("cc -r $2 --var:version=$1 --var:mingw=none --main:compiler/nim.nim scripts compiler/installer.ini" %
  199. [VersionAsString, compileNimInst])
  200. exec("$# --var:version=$# --var:mingw=none --main:compiler/nim.nim xz compiler/installer.ini" %
  201. ["tools" / "niminst" / "niminst".exe, VersionAsString])
  202. proc buildTool(toolname, args: string) =
  203. nimexec("cc $# $#" % [args, toolname])
  204. copyFile(dest="bin" / splitFile(toolname).name.exe, source=toolname.exe)
  205. proc buildTools(args: string = "") =
  206. bundleNimsuggest(args)
  207. nimCompileFold("Compile nimgrep", "tools/nimgrep.nim",
  208. options = "-d:release " & args)
  209. when defined(windows): buildVccTool(args)
  210. bundleNimpretty(args)
  211. nimCompileFold("Compile testament", "testament/testament.nim", options = "-d:release " & args)
  212. # pre-packages a debug version of nim which can help in many cases investigate issuses
  213. # withouth having to rebuild compiler.
  214. # `-d:nimDebugUtils` only makes sense when temporarily editing/debugging compiler
  215. # `-d:debug` should be changed to a flag that doesn't require re-compiling nim
  216. # `--opt:speed` is a sensible default even for a debug build, it doesn't affect nim stacktraces
  217. nimCompileFold("Compile nim_dbg", "compiler/nim.nim", options =
  218. "--opt:speed --stacktrace -d:debug --stacktraceMsgs -d:nimCompilerStacktraceHints " & args,
  219. outputName = "nim_dbg")
  220. proc testTools(args: string = "") =
  221. nimCompileFold("Compile nimgrep", "tools/nimgrep.nim",
  222. options = "-d:release " & args)
  223. when defined(windows): buildVccTool(args)
  224. bundleNimpretty(args)
  225. nimCompileFold("Compile testament", "testament/testament.nim", options = "-d:release " & args)
  226. proc nsis(latest: bool; args: string) =
  227. bundleChecksums(latest)
  228. bundleNimbleExe(latest, args)
  229. bundleAtlasExe(latest, args)
  230. bundleNimsuggest(args)
  231. bundleWinTools(args)
  232. # make sure we have generated the niminst executables:
  233. buildTool("tools/niminst/niminst", args)
  234. #buildTool("tools/nimgrep", args)
  235. # produce 'nim_debug.exe':
  236. #exec "nim c compiler" / "nim.nim"
  237. #copyExe("compiler/nim".exe, "bin/nim_debug".exe)
  238. exec(("tools" / "niminst" / "niminst --var:version=$# --var:mingw=mingw$#" &
  239. " nsis compiler/installer.ini") % [VersionAsString, $(sizeof(pointer)*8)])
  240. proc geninstall(args="") =
  241. nimexec("cc -r $# --var:version=$# --var:mingw=none --main:compiler/nim.nim scripts compiler/installer.ini $#" %
  242. [compileNimInst, VersionAsString, args])
  243. proc install(args: string) =
  244. geninstall()
  245. exec("sh ./install.sh $#" % args)
  246. proc installDeps(dep: string, commit = "") =
  247. # the hashes/urls are version controlled here, so can be changed seamlessly
  248. # and tied to a nim release (mimicking git submodules)
  249. var commit = commit
  250. case dep
  251. of "tinyc":
  252. if commit.len == 0: commit = "916cc2f94818a8a382dd8d4b8420978816c1dfb3"
  253. cloneDependency(distDir, "https://github.com/timotheecour/nim-tinyc-archive", commit)
  254. of "libffi":
  255. # technically a nimble package, however to play nicely with --noNimblePath,
  256. # let's just clone it wholesale:
  257. if commit.len == 0: commit = "bb2bdaf1a29a4bff6fbd8ae4695877cbb3ec783e"
  258. cloneDependency(distDir, "https://github.com/Araq/libffi", commit)
  259. else: doAssert false, "unsupported: " & dep
  260. # xxx: also add linenoise, niminst etc, refs https://github.com/nim-lang/RFCs/issues/206
  261. # -------------- boot ---------------------------------------------------------
  262. proc findStartNim: string =
  263. # we try several things before giving up:
  264. # * nimExe
  265. # * bin/nim
  266. # * $PATH/nim
  267. # If these fail, we try to build nim with the "build.(sh|bat)" script.
  268. let (nim, ok) = findNimImpl()
  269. if ok: return nim
  270. when defined(posix):
  271. const buildScript = "build.sh"
  272. if fileExists(buildScript):
  273. if tryExec("./" & buildScript): return "bin" / nim
  274. else:
  275. const buildScript = "build.bat"
  276. if fileExists(buildScript):
  277. if tryExec(buildScript): return "bin" / nim
  278. echo("Found no nim compiler and every attempt to build one failed!")
  279. quit("FAILURE")
  280. proc thVersion(i: int): string =
  281. result = ("compiler" / "nim" & $i).exe
  282. template doUseCpp(): bool = getEnv("NIM_COMPILE_TO_CPP", "false") == "true"
  283. proc boot(args: string, skipIntegrityCheck: bool) =
  284. ## bootstrapping is a process that involves 3 steps:
  285. ## 1. use csourcesAny to produce nim1.exe. This nim1.exe is buggy but
  286. ## rock solid for building a Nim compiler. It shouldn't be used for anything else.
  287. ## 2. use nim1.exe to produce nim2.exe. nim2.exe is the one you really need.
  288. ## 3. We use nim2.exe to build nim3.exe. nim3.exe is equal to nim2.exe except for timestamps.
  289. ## This step ensures a minimum amount of quality. We know that nim2.exe can be used
  290. ## for Nim compiler development.
  291. var output = "compiler" / "nim".exe
  292. var finalDest = "bin" / "nim".exe
  293. # default to use the 'c' command:
  294. let useCpp = doUseCpp()
  295. let smartNimcache = (if "release" in args or "danger" in args: "nimcache/r_" else: "nimcache/d_") &
  296. hostOS & "_" & hostCPU
  297. if not dirExists("dist/checksums"):
  298. bundleChecksums(false)
  299. let usingLibFFI = "nimHasLibFFI" in args
  300. if usingLibFFI and not dirExists("dist/libffi"):
  301. installDeps("libffi")
  302. let nimStart = findStartNim().quoteShell()
  303. let times = 2 - ord(skipIntegrityCheck)
  304. for i in 0..times:
  305. let defaultCommand = if useCpp: "cpp" else: "c"
  306. let bootOptions = if args.len == 0 or args.startsWith("-"): defaultCommand else: ""
  307. echo "iteration: ", i+1
  308. var extraOption = ""
  309. var nimi = i.thVersion
  310. if i == 0:
  311. nimi = nimStart
  312. extraOption.add " --skipUserCfg --skipParentCfg -d:nimKochBootstrap"
  313. # --noNimblePath precludes nimble packages as dependencies to the compiler,
  314. # so libffi is not "installed as a nimble package"
  315. if usingLibFFI: extraOption.add " --path:./dist"
  316. # The configs are skipped for bootstrap
  317. # (1st iteration) to prevent newer flags from breaking bootstrap phase.
  318. let ret = execCmdEx(nimStart & " --version")
  319. doAssert ret.exitCode == 0
  320. let version = ret.output.splitLines[0]
  321. if version.startsWith "Nim Compiler Version 0.20.0":
  322. extraOption.add " --lib:lib" # see https://github.com/nim-lang/Nim/pull/14291
  323. # in order to use less memory, we split the build into two steps:
  324. # --compileOnly produces a $project.json file and does not run GCC/Clang.
  325. # jsonbuild then uses the $project.json file to build the Nim binary.
  326. exec "$# $# $# --nimcache:$# $# --noNimblePath --compileOnly compiler" / "nim.nim" %
  327. [nimi, bootOptions, extraOption, smartNimcache, args]
  328. exec "$# jsonscript --noNimblePath --nimcache:$# $# compiler" / "nim.nim" %
  329. [nimi, smartNimcache, args]
  330. if sameFileContent(output, i.thVersion):
  331. copyExe(output, finalDest)
  332. echo "executables are equal: SUCCESS!"
  333. return
  334. copyExe(output, (i+1).thVersion)
  335. copyExe(output, finalDest)
  336. when not defined(windows):
  337. if not skipIntegrityCheck:
  338. echo "[Warning] executables are still not equal"
  339. # -------------- clean --------------------------------------------------------
  340. const
  341. cleanExt = [
  342. ".ppu", ".o", ".obj", ".dcu", ".~pas", ".~inc", ".~dsk", ".~dpr",
  343. ".map", ".tds", ".err", ".bak", ".pyc", ".exe", ".rod", ".pdb", ".idb",
  344. ".idx", ".ilk"
  345. ]
  346. ignore = [
  347. ".bzrignore", "nim", "nim.exe", "koch", "koch.exe", ".gitignore"
  348. ]
  349. proc cleanAux(dir: string) =
  350. for kind, path in walkDir(dir):
  351. case kind
  352. of pcFile:
  353. var (_, name, ext) = splitFile(path)
  354. if ext == "" or cleanExt.contains(ext):
  355. if not ignore.contains(name):
  356. echo "removing: ", path
  357. removeFile(path)
  358. of pcDir:
  359. case splitPath(path).tail
  360. of "nimcache":
  361. echo "removing dir: ", path
  362. removeDir(path)
  363. of "dist", ".git", "icons": discard
  364. else: cleanAux(path)
  365. else: discard
  366. proc removePattern(pattern: string) =
  367. for f in walkFiles(pattern):
  368. echo "removing: ", f
  369. removeFile(f)
  370. proc clean(args: string) =
  371. removePattern("web/*.html")
  372. removePattern("doc/*.html")
  373. cleanAux(getCurrentDir())
  374. for kind, path in walkDir(getCurrentDir() / "build"):
  375. if kind == pcDir:
  376. echo "removing dir: ", path
  377. removeDir(path)
  378. # -------------- builds a release ---------------------------------------------
  379. proc winReleaseArch(arch: string) =
  380. doAssert arch in ["32", "64"]
  381. let cpu = if arch == "32": "i386" else: "amd64"
  382. template withMingw(path, body) =
  383. let prevPath = getEnv("PATH")
  384. putEnv("PATH", (if path.len > 0: path & PathSep else: "") & prevPath)
  385. try:
  386. body
  387. finally:
  388. putEnv("PATH", prevPath)
  389. withMingw r"..\mingw" & arch & r"\bin":
  390. # Rebuilding koch is necessary because it uses its pointer size to
  391. # determine which mingw link to put in the NSIS installer.
  392. inFold "winrelease koch":
  393. nimexec "c --cpu:$# koch" % cpu
  394. kochExecFold("winrelease boot", "boot -d:release --cpu:$#" % cpu)
  395. kochExecFold("winrelease zip", "zip -d:release")
  396. overwriteFile r"build\nim-$#.zip" % VersionAsString,
  397. r"web\upload\download\nim-$#_x$#.zip" % [VersionAsString, arch]
  398. proc winRelease*() =
  399. # Now used from "tools/winrelease" and not directly supported by koch
  400. # anymore!
  401. # Build -docs file:
  402. when true:
  403. inFold "winrelease buildDocs":
  404. buildDocs(gaCode)
  405. withDir "web/upload/" & VersionAsString:
  406. inFold "winrelease zipdocs":
  407. exec "7z a -tzip docs-$#.zip *.html" % VersionAsString
  408. overwriteFile "web/upload/$1/docs-$1.zip" % VersionAsString,
  409. "web/upload/download/docs-$1.zip" % VersionAsString
  410. when true:
  411. inFold "winrelease csource":
  412. csource("-d:danger")
  413. when sizeof(pointer) == 4:
  414. winReleaseArch "32"
  415. when sizeof(pointer) == 8:
  416. winReleaseArch "64"
  417. # -------------- tests --------------------------------------------------------
  418. template `|`(a, b): string = (if a.len > 0: a else: b)
  419. proc tests(args: string) =
  420. nimexec "cc --opt:speed testament/testament"
  421. var testCmd = quoteShell(getCurrentDir() / "testament/testament".exe)
  422. testCmd.add " " & quoteShell("--nim:" & findNim())
  423. testCmd.add " " & (args|"all")
  424. let success = tryExec testCmd
  425. if not success:
  426. quit("tests failed", QuitFailure)
  427. proc temp(args: string) =
  428. proc splitArgs(a: string): (string, string) =
  429. # every --options before the command (indicated by starting
  430. # with not a dash) is part of the bootArgs, the rest is part
  431. # of the programArgs:
  432. let args = os.parseCmdLine a
  433. result = ("", "")
  434. var i = 0
  435. while i < args.len and args[i][0] == '-':
  436. result[0].add " " & quoteShell(args[i])
  437. inc i
  438. while i < args.len:
  439. result[1].add " " & quoteShell(args[i])
  440. inc i
  441. if not dirExists("dist/checksums"):
  442. bundleChecksums(false)
  443. let d = getAppDir()
  444. let output = d / "compiler" / "nim".exe
  445. let finalDest = d / "bin" / "nim_temp".exe
  446. # 125 is the magic number to tell git bisect to skip the current commit.
  447. var (bootArgs, programArgs) = splitArgs(args)
  448. if "doc" notin programArgs and
  449. "threads" notin programArgs and
  450. "js" notin programArgs and "rst2html" notin programArgs:
  451. bootArgs = " -d:leanCompiler" & bootArgs
  452. let nimexec = findNim().quoteShell()
  453. exec(nimexec & " c -d:debug --debugger:native -d:nimBetterRun " & bootArgs & " " & (d / "compiler" / "nim"), 125)
  454. copyExe(output, finalDest)
  455. setCurrentDir(origDir)
  456. if programArgs.len > 0: exec(finalDest & " " & programArgs)
  457. proc xtemp(cmd: string) =
  458. let d = getAppDir()
  459. copyExe(d / "bin" / "nim".exe, d / "bin" / "nim_backup".exe)
  460. try:
  461. withDir(d):
  462. temp""
  463. copyExe(d / "bin" / "nim_temp".exe, d / "bin" / "nim".exe)
  464. exec(cmd)
  465. finally:
  466. copyExe(d / "bin" / "nim_backup".exe, d / "bin" / "nim".exe)
  467. proc icTest(args: string) =
  468. temp("")
  469. let inp = os.parseCmdLine(args)[0]
  470. let content = readFile(inp)
  471. let nimExe = getAppDir() / "bin" / "nim_temp".exe
  472. var i = 0
  473. for fragment in content.split("#!EDIT!#"):
  474. let file = inp.replace(".nim", "_temp.nim")
  475. writeFile(file, fragment)
  476. var cmd = nimExe & " cpp --ic:on -d:nimIcIntegrityChecks --listcmd "
  477. if i == 0:
  478. cmd.add "-f "
  479. cmd.add quoteShell(file)
  480. exec(cmd)
  481. inc i
  482. proc buildDrNim(args: string) =
  483. if not dirExists("dist/nimz3"):
  484. exec("git clone https://github.com/zevv/nimz3.git dist/nimz3")
  485. when defined(windows):
  486. if not dirExists("dist/dlls"):
  487. exec("git clone -q https://github.com/nim-lang/dlls.git dist/dlls")
  488. copyExe("dist/dlls/libz3.dll", "bin/libz3.dll")
  489. execFold("build drnim", "nim c -o:$1 $2 drnim/drnim" % ["bin/drnim".exe, args])
  490. else:
  491. if not dirExists("dist/z3"):
  492. exec("git clone -q https://github.com/Z3Prover/z3.git dist/z3")
  493. withDir("dist/z3"):
  494. exec("git fetch")
  495. exec("git checkout " & Z3StableCommit)
  496. createDir("build")
  497. withDir("build"):
  498. exec("""cmake -DZ3_BUILD_LIBZ3_SHARED=FALSE -G "Unix Makefiles" ../""")
  499. exec("make -j4")
  500. execFold("build drnim", "nim cpp --dynlibOverride=libz3 -o:$1 $2 drnim/drnim" % ["bin/drnim".exe, args])
  501. # always run the tests for now:
  502. exec("testament/testament".exe & " --nim:" & "drnim".exe & " pat drnim/tests")
  503. proc hostInfo(): string =
  504. "hostOS: $1, hostCPU: $2, int: $3, float: $4, cpuEndian: $5, cwd: $6" %
  505. [hostOS, hostCPU, $int.sizeof, $float.sizeof, $cpuEndian, getCurrentDir()]
  506. proc runCI(cmd: string) =
  507. doAssert cmd.len == 0, cmd # avoid silently ignoring
  508. echo "runCI: ", cmd
  509. echo hostInfo()
  510. # boot without -d:nimHasLibFFI to make sure this still works
  511. # `--lib:lib` is needed for bootstrap on openbsd, for reasons described in
  512. # https://github.com/nim-lang/Nim/pull/14291 (`getAppFilename` bugsfor older nim on openbsd).
  513. kochExecFold("Boot Nim ORC", "boot -d:release -d:nimStrictMode --lib:lib")
  514. when false: # debugging: when you need to run only 1 test in CI, use something like this:
  515. execFold("debugging test", "nim r tests/stdlib/tosproc.nim")
  516. doAssert false, "debugging only"
  517. ## build nimble early on to enable remainder to depend on it if needed
  518. kochExecFold("Build Nimble", "nimble")
  519. execFold("Install smtp", "nimble install smtp -y")
  520. let batchParam = "--batch:$1" % "NIM_TESTAMENT_BATCH".getEnv("_")
  521. if getEnv("NIM_TEST_PACKAGES", "0") == "1":
  522. nimCompileFold("Compile testament", "testament/testament.nim", options = "-d:release")
  523. execFold("Test selected Nimble packages", "testament $# pcat nimble-packages" % batchParam)
  524. else:
  525. testTools()
  526. for a in "zip opengl sdl1 jester@#head".split:
  527. let buildDeps = "build"/"deps" # xxx factor pending https://github.com/timotheecour/Nim/issues/616
  528. # if this gives `Additional info: "build/deps" [OSError]`, make sure nimble is >= v0.12.0,
  529. # otherwise `absolutePath` is needed, refs https://github.com/nim-lang/nimble/issues/901
  530. execFold("", "nimble install -y --nimbleDir:$# $#" % [buildDeps.quoteShell, a])
  531. ## run tests
  532. execFold("Test nimscript", "nim e tests/test_nimscript.nims")
  533. when defined(windows):
  534. execFold("Compile tester", "nim c --usenimcache -d:nimCoroutines --os:genode -d:posix --compileOnly testament/testament")
  535. # main bottleneck here
  536. # xxx: even though this is the main bottleneck, we could speedup the rest via batching with `--batch`.
  537. # BUG: with initOptParser, `--batch:'' all` interprets `all` as the argument of --batch, pending bug #14343
  538. execFold("Run tester", "nim c -r --putenv:NIM_TESTAMENT_REMOTE_NETWORKING:1 -d:nimStrictMode testament/testament $# all -d:nimCoroutines" % batchParam)
  539. block: # nimHasLibFFI:
  540. when defined(posix): # windows can be handled in future PR's
  541. installDeps("libffi")
  542. const nimFFI = "bin/nim.ctffi"
  543. # no need to bootstrap with koch boot (would be slower)
  544. let backend = if doUseCpp(): "cpp" else: "c"
  545. execFold("build with -d:nimHasLibFFI", "nim $1 -d:release --noNimblePath -d:nimHasLibFFI --path:./dist -o:$2 compiler/nim.nim" % [backend, nimFFI])
  546. execFold("test with -d:nimHasLibFFI", "$1 $2 -r testament/testament --nim:$1 r tests/misc/trunner.nim -d:nimTrunnerFfi" % [nimFFI, backend])
  547. execFold("Run nimdoc tests", "nim r nimdoc/tester")
  548. execFold("Run rst2html tests", "nim r nimdoc/rsttester")
  549. execFold("Run nimpretty tests", "nim r nimpretty/tester.nim")
  550. when defined(posix):
  551. # refs #18385, build with -d:release instead of -d:danger for testing
  552. # We could also skip building nimsuggest in buildTools, or build it with -d:release
  553. # in bundleNimsuggest depending on some environment variable when we are in CI. One advantage
  554. # of rebuilding is this won't affect bin/nimsuggest when running runCI locally
  555. execFold("build nimsuggest_testing", "nim c -o:bin/nimsuggest_testing -d:release nimsuggest/nimsuggest")
  556. execFold("Run nimsuggest tests", "nim r nimsuggest/tester")
  557. kochExecFold("Testing booting in refc", "boot -d:release --mm:refc -d:nimStrictMode --lib:lib")
  558. proc testUnixInstall(cmdLineRest: string) =
  559. csource("-d:danger" & cmdLineRest)
  560. xz(false, cmdLineRest)
  561. let oldCurrentDir = getCurrentDir()
  562. try:
  563. let destDir = getTempDir()
  564. copyFile("build/nim-$1.tar.xz" % VersionAsString,
  565. destDir / "nim-$1.tar.xz" % VersionAsString)
  566. setCurrentDir(destDir)
  567. execCleanPath("tar -xJf nim-$1.tar.xz" % VersionAsString)
  568. setCurrentDir("nim-$1" % VersionAsString)
  569. execCleanPath("sh build.sh")
  570. # first test: try if './bin/nim --version' outputs something sane:
  571. let output = execProcess("./bin/nim --version").splitLines
  572. if output.len > 0 and output[0].contains(VersionAsString):
  573. echo "Version check: success"
  574. execCleanPath("./bin/nim c koch.nim")
  575. execCleanPath("./koch boot -d:release", destDir / "bin")
  576. # check the docs build:
  577. execCleanPath("./koch docs", destDir / "bin")
  578. # check nimble builds:
  579. execCleanPath("./koch tools")
  580. # check the tests work:
  581. putEnv("NIM_EXE_NOT_IN_PATH", "NOT_IN_PATH")
  582. execCleanPath("./koch tests --nim:bin/nim cat megatest", destDir / "bin")
  583. else:
  584. echo "Version check: failure"
  585. finally:
  586. setCurrentDir oldCurrentDir
  587. proc valgrind(cmd: string) =
  588. # somewhat hacky: '=' sign means "pass to valgrind" else "pass to Nim"
  589. let args = parseCmdLine(cmd)
  590. var nimcmd = ""
  591. var valcmd = ""
  592. for i, a in args:
  593. if i == args.len-1:
  594. # last element is the filename:
  595. valcmd.add ' '
  596. valcmd.add changeFileExt(a, ExeExt)
  597. nimcmd.add ' '
  598. nimcmd.add a
  599. elif '=' in a:
  600. valcmd.add ' '
  601. valcmd.add a
  602. else:
  603. nimcmd.add ' '
  604. nimcmd.add a
  605. exec("nim c" & nimcmd)
  606. let supp = getAppDir() / "tools" / "nimgrind.supp"
  607. exec("valgrind --suppressions=" & supp & valcmd)
  608. proc showHelp(success: bool) =
  609. quit(HelpText % [VersionAsString & spaces(44-len(VersionAsString)),
  610. CompileDate, CompileTime], if success: QuitSuccess else: QuitFailure)
  611. proc branchDone() =
  612. let thisBranch = execProcess("git symbolic-ref --short HEAD").strip()
  613. if thisBranch != "devel" and thisBranch != "":
  614. exec("git checkout devel")
  615. exec("git branch -D " & thisBranch)
  616. exec("git pull --rebase")
  617. when isMainModule:
  618. var op = initOptParser()
  619. var
  620. latest = false
  621. localDocsOnly = false
  622. localDocsOut = ""
  623. skipIntegrityCheck = false
  624. while true:
  625. op.next()
  626. case op.kind
  627. of cmdLongOption, cmdShortOption:
  628. case normalize(op.key)
  629. of "help", "h": showHelp(success = true)
  630. of "latest": latest = true
  631. of "stable": latest = false
  632. of "nim": nimExe = op.val.absolutePath # absolute so still works with changeDir
  633. of "localdocs":
  634. localDocsOnly = true
  635. if op.val.len > 0:
  636. localDocsOut = op.val.absolutePath
  637. of "skipintegritycheck":
  638. skipIntegrityCheck = true
  639. else: showHelp(success = false)
  640. of cmdArgument:
  641. case normalize(op.key)
  642. of "boot": boot(op.cmdLineRest, skipIntegrityCheck)
  643. of "clean": clean(op.cmdLineRest)
  644. of "doc", "docs": buildDocs(op.cmdLineRest & " --d:nimPreviewSlimSystem " & paCode, localDocsOnly, localDocsOut)
  645. of "doc0", "docs0":
  646. # undocumented command for Araq-the-merciful:
  647. buildDocs(op.cmdLineRest & gaCode)
  648. of "pdf": buildPdfDoc(op.cmdLineRest, "doc/pdf")
  649. of "csource", "csources": csource(op.cmdLineRest)
  650. of "zip": zip(latest, op.cmdLineRest)
  651. of "xz": xz(latest, op.cmdLineRest)
  652. of "nsis": nsis(latest, op.cmdLineRest)
  653. of "geninstall": geninstall(op.cmdLineRest)
  654. of "distrohelper": geninstall()
  655. of "install": install(op.cmdLineRest)
  656. of "testinstall": testUnixInstall(op.cmdLineRest)
  657. of "installdeps": installDeps(op.cmdLineRest)
  658. of "runci": runCI(op.cmdLineRest)
  659. of "test", "tests": tests(op.cmdLineRest)
  660. of "temp": temp(op.cmdLineRest)
  661. of "xtemp": xtemp(op.cmdLineRest)
  662. of "wintools": bundleWinTools(op.cmdLineRest)
  663. of "nimble": bundleNimbleExe(latest, op.cmdLineRest)
  664. of "atlas": bundleAtlasExe(latest, op.cmdLineRest)
  665. of "nimsuggest": bundleNimsuggest(op.cmdLineRest)
  666. # toolsNoNimble is kept for backward compatibility with build scripts
  667. of "toolsnonimble", "toolsnoexternal":
  668. buildTools(op.cmdLineRest)
  669. of "tools":
  670. buildTools(op.cmdLineRest)
  671. bundleNimbleExe(latest, op.cmdLineRest)
  672. bundleAtlasExe(latest, op.cmdLineRest)
  673. of "checksums":
  674. bundleChecksums(latest)
  675. of "pushcsource":
  676. quit "use this instead: https://github.com/nim-lang/csources_v1/blob/master/push_c_code.nim"
  677. of "valgrind": valgrind(op.cmdLineRest)
  678. of "c2nim": bundleC2nim(op.cmdLineRest)
  679. of "drnim": buildDrNim(op.cmdLineRest)
  680. of "fusion":
  681. let suffix = if latest: HeadHash else: FusionStableHash
  682. exec("nimble install -y fusion@$#" % suffix)
  683. of "ic": icTest(op.cmdLineRest)
  684. of "branchdone": branchDone()
  685. else: showHelp(success = false)
  686. break
  687. of cmdEnd:
  688. showHelp(success = false)