-
Notifications
You must be signed in to change notification settings - Fork 31
/
Runner.jl
1267 lines (1127 loc) · 50.8 KB
/
Runner.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import Base: strip
abstract type Runner; end
export default_host_platform
const AnyRedirectable = Union{Base.AbstractCmd, Base.TTY, IOStream, IOBuffer}
# Host platform _must_ match the C++ string ABI of the binaries we get from the
# repositories. Note: when preferred_gcc_version=v"4" we can't really build for
# that C++ string ABI :-(
"""
default_host_platform
The default host platform in the build environment.
"""
const default_host_platform = Platform("x86_64", "linux"; libc="musl", cxxstring_abi="cxx11")
function nbits(p::AbstractPlatform)
if arch(p) in ("i686", "armv6l", "armv7l")
return 32
elseif arch(p) in ("x86_64", "aarch64", "powerpc64le")
return 64
else
error("Unknown bitwidth for architecture $(arch(p))")
end
end
function proc_family(p::AbstractPlatform)
if arch(p) in ("x86_64", "i686")
return "intel"
elseif arch(p) in ("armv6l", "armv7l", "aarch64")
return "arm"
elseif arch(p) == "powerpc64le"
return "power"
else
error("Unknown processor family for architecture $(arch(p))")
end
end
# Convert platform to a triplet, but strip out the ABI parts.
# Also translate `armvXl` -> `arm` for now, since that's what most
# compiler toolchains call it. :(
function aatriplet(p::AbstractPlatform)
t = triplet(abi_agnostic(p))
t = replace(t, "armv7l" => "arm")
t = replace(t, "armv6l" => "arm")
return t
end
# We want AnyPlatform to look like `default_host_platform` in the build environment.
aatriplet(p::AnyPlatform) = aatriplet(default_host_platform)
function ld_library_path(target::AbstractPlatform,
host::AbstractPlatform,
prefix::String="",
host_libdir::String="";
csl_paths::Bool=true)
# Helper for generating the library include path for a target. MacOS, as usual,
# puts things in slightly different place.
function target_lib_dir(p::AbstractPlatform)
t = aatriplet(p)
if Sys.isapple(p)
return "/opt/$(t)/$(t)/lib:/opt/$(t)/lib"
else
return "/opt/$(t)/$(t)/lib64:/opt/$(t)/$(t)/lib"
end
end
# Let's start
paths = String[]
# If requested, start with our CSL libraries for target/host, but only for architectures
# that can natively run within this environment
if csl_paths
append!(paths,
unique("/usr/lib/csl-$(libc(p))-$(arch(p))" for p in (host, target) if Sys.islinux(p) && proc_family(p) == "intel"),
)
end
push!(paths,
# Then add default system paths
"/usr/local/lib64:/usr/local/lib:/usr/lib64:/usr/lib",
# Add our loader directories
"/lib64:/lib",
)
if !isempty(host_libdir)
push!(paths,
# Libdir of the host platform, to run programs in `HostBuildDependency`
host_libdir,
)
end
push!(paths,
# Add our target/host-specific library directories for compiler support libraries
target_lib_dir(host),
target_lib_dir(target),
)
# Finally, add dependencies in the prefix
if !isempty(prefix)
push!(paths,
"$(prefix)/lib64:$(prefix)/lib",
)
end
return join(paths, ":")
end
function macos_version(kernel_version::Integer)
# See https://en.wikipedia.org/wiki/Darwin_(operating_system)#Release_history
kernel_to_macos = Dict(
12 => "10.8",
13 => "10.9",
14 => "10.10",
15 => "10.11",
16 => "10.12",
17 => "10.13",
18 => "10.14",
19 => "10.15",
20 => "11.0",
21 => "12.0",
)
return get(kernel_to_macos, kernel_version, nothing)
end
function macos_version(p::AbstractPlatform)
if os(p) != "macos"
return nothing
end
# If no `os_version` is specified in `p`, default to the oldest we support in the Julia world,
# which is `10.8`, but if it is actually specified, then set that corresponding value.
#version = something(os_version(p), v"14.0.0")
# Eventually, we'll take this in `os_version(p)`, but not just yet. We need to fix the paths
# to the compiler shards first, since right now they have `14` at the end
version = something(os_version(p), v"14.0.0")
return macos_version(version.major)
end
"""
generate_compiler_wrappers!(platform::AbstractPlatform; bin_path::AbstractString,
host_platform::AbstractPlatform = $(repr(default_host_platform)),
compilers::Vector{Symbol} = [:c],
allow_unsafe_flags::Bool = false,
lock_microarchitecture::Bool = true)
We generate a set of compiler wrapper scripts within our build environment to force all
build systems to honor the necessary sets of compiler flags to build for our systems.
Note that while `platform_envs()` sets many environment variables, those values are
intended to be optional/overridable. These values, while still overridable by directly
invoking a compiler binary directly (e.g. /opt/{target}/bin/{target}-gcc), are much more
difficult to override, as the flags embedded in these wrappers are absolutely necessary,
and even simple programs will not compile without them.
"""
function generate_compiler_wrappers!(platform::AbstractPlatform; bin_path::AbstractString,
host_platform::AbstractPlatform = default_host_platform,
compilers::Vector{Symbol} = [:c],
allow_unsafe_flags::Bool = false,
lock_microarchitecture::Bool = true,
bootstrap::Bool = !isempty(bootstrap_list),
)
# Wipe that directory out, in case it already had compiler wrappers
rm(bin_path; recursive=true, force=true)
mkpath(bin_path)
# Early-exit if we're bootstrapping
if bootstrap
return
end
target = aatriplet(platform)
host_target = aatriplet(host_platform)
function wrapper(io::IO,
prog::String;
# Flags that are always prepended
flags::Vector{String} = String[],
# Flags that are prepended if we think we're compiling (e.g. no `-x assembler`)
compile_only_flags::Vector = String[],
# Flags that are postpended if we think we're linking (e.g. no `-c`)
link_only_flags::Vector = String[],
allow_ccache::Bool = true,
no_soft_float::Bool = false,
hash_args::Bool = false,
extra_cmds::String = "",
env::Dict{String,String} = Dict{String,String}(),
unsafe_flags = String[])
write(io, """
#!/bin/bash
# This compiler wrapper script brought into existence by `generate_compiler_wrappers!()`
if [ "x\${SUPER_VERBOSE}" = "x" ]; then
vrun() { "\$@"; }
else
vrun() { echo -e "\\e[96m\$@\\e[0m" >&2; "\$@"; }
fi
ARGS=( "\$@" )
PRE_FLAGS=()
POST_FLAGS=()
""")
# Sometimes we need to look at the hash of our arguments
if hash_args
write(io, """
ARGS_HASH="\$(echo -n "\$*" | sha1sum | cut -c1-8)"
""")
end
# If we're given always-prepend flags, include them
if !isempty(flags)
println(io)
for cf in flags
println(io, "PRE_FLAGS+=( $cf )")
end
println(io)
end
# If we're given compile-only flags, include them only if `-x assembler` is not provided
if !isempty(compile_only_flags)
println(io)
println(io, "if [[ \" \${ARGS[@]} \" != *' -x assembler '* ]]; then")
for cf in compile_only_flags
println(io, " PRE_FLAGS+=( $cf )")
end
println(io, "fi")
println(io)
end
# If we're given link-only flags, include them only if `-c` or other link-disablers are not provided.
if !isempty(link_only_flags)
println(io)
println(io, "if [[ \" \${ARGS[@]} \" != *' -c '* ]] && [[ \" \${ARGS[@]} \" != *' -E '* ]] && [[ \" \${ARGS[@]} \" != *' -M '* ]] && [[ \" \${ARGS[@]} \" != *' -fsyntax-only '* ]]; then")
for lf in link_only_flags
println(io, " POST_FLAGS+=( $lf )")
end
println(io, "fi")
println(io)
end
# Insert extra commands from the user (usually some kind of conditional setting
# of PRE_FLAGS and POST_FLAGS)
println(io)
write(io, extra_cmds)
println(io)
for (name, val) in env
write(io, "export $(name)=\"$(val)\"\n")
end
# TODO: improve this check
if lock_microarchitecture
write(io, raw"""
if [[ " ${ARGS[@]} " == *"-march="* ]]; then
echo "BinaryBuilder: Cannot force an architecture via -march" >&2
exit 1
fi
""")
println(io)
end
if no_soft_float
write(io, raw"""
if [[ " ${ARGS[@]} " == *"-mfloat-abi=soft"* ]]; then
echo "BinaryBuilder: ${target} platform does not support soft-float ABI (-mfloat-abi=soft)" >&2
exit 1
fi
""")
println(io)
end
if length(unsafe_flags) >= 1
write(io, """
if [[ "\${ARGS[@]}" =~ \"$(join(unsafe_flags, "\"|\""))\" ]]; then
echo -e \"BinaryBuilder: You used one or more of the unsafe flags: $(join(unsafe_flags, ", "))\\nPlease repent.\" >&2
exit 1
fi
""")
println(io)
end
if allow_ccache
write(io, """
if [ \${USE_CCACHE} == "true" ]; then
CCACHE="ccache"
fi
""")
end
write(io, """
vrun \${CCACHE} $(prog) "\${PRE_FLAGS[@]}" "\${ARGS[@]}" "\${POST_FLAGS[@]}"
""")
end
# Helper invocations
target_tool(io::IO, tool::String, args...; kwargs...) = wrapper(io, "/opt/$(target)/bin/$(target)-$(tool)", args...; kwargs...)
llvm_tool(io::IO, tool::String, args...; kwargs...) = wrapper(io, "/opt/$(host_target)/bin/llvm-$(tool)", args...; kwargs...)
# For now this is required for Clang, since apple spells aarch64 as "arm64".
# Should probably be fixed upstream, but will do for now
clang_target_triplet(p::AbstractPlatform) = replace(aatriplet(p), "aarch64" => "arm64")
function clang_flags!(p::AbstractPlatform, flags::Vector{String} = String[])
# Focus the clang targeting laser
append!(flags, [
# Set the `target` for `clang` so it generates the right kind of code
"-target $(clang_target_triplet(p))",
# Set our sysroot to the platform-specific location, dropping compiler ABI annotations
"--sysroot=/opt/$(aatriplet(p))/$(aatriplet(p))/sys-root",
])
# For MacOS and FreeBSD, we don't set `-rtlib`, and FreeBSD is special-cased within the LLVM source tree
# to not allow for -gcc-toolchain, which means that we have to manually add the location of libgcc_s. LE SIGH.
# We do that within `clang_linker_flags()`, so that we don't get "unused argument" warnings all over the place.
# https://github.com/llvm-mirror/clang/blob/f3b7928366f63b51ffc97e74f8afcff497c57e8d/lib/Driver/ToolChains/FreeBSD.cpp
# For everything else, we provide `-rtlib=libgcc` because clang-builtins are broken (pending Valentin-based-magic),
# and we also need to provide `-stdlib=libstdc++` to match Julia on these platforms.
if !Sys.isbsd(p)
append!(flags, [
# Find GCC toolchain here (for things like libgcc_s)
"--gcc-toolchain=/opt/$(aatriplet(p))"
# Use libgcc as the C runtime library
"-rtlib=libgcc"
# Use libstdc++ as the C++ runtime library
"-stdlib=libstdc++"
])
end
return flags
end
function min_macos_version_flag(p::AbstractPlatform)
# Ask compilers to compile for a minimum macOS version
return "-mmacosx-version-min=$(macos_version(p))"
end
function add_system_includedir(flags::Vector{String})
# GCC 4.8.5 for musl and clang on FreeBSD do not have `SYSROOT/usr/local` (which
# in our build environments is a symlink to $includedir = "$(prefix)/include")
# in the default list of include search directories. As a result, quite some
# builders that work fine everywhere else need to add something like
# `-I${includedir}` to their CPPFLAGS.
#
# To remove this annoyance, we simply add it here. We use `-isystem` instead
# of `-I` to mimic how this dir is treated on other operating systems. It
# is still not a perfect match, as the order of the default search directories
# differs, but this should not matter in practice.
#
# See also https://github.com/JuliaPackaging/Yggdrasil/issues/3949 and
# https://github.com/JuliaPackaging/Yggdrasil/pull/3969 for further details.
append!(flags, ["-isystem", raw"${includedir}"])
end
function clang_compile_flags!(p::AbstractPlatform, flags::Vector{String} = String[])
if lock_microarchitecture
append!(flags, get_march_flags(arch(p), march(p), "clang"))
end
if Sys.isapple(p)
append!(flags, String[
# On MacOS, we need to override the typical C++ include search paths, because it always includes
# the toolchain C++ headers first. Valentin tracked this down to:
# https://github.com/llvm/llvm-project/blob/0378f3a90341d990236c44f297b923a32b35fab1/clang/lib/Driver/ToolChains/Darwin.cpp#L1944-L1978
"-nostdinc++",
"-isystem",
"/opt/$(aatriplet(p))/$(aatriplet(p))/sys-root/usr/include/c++/v1",
# We also add `-Wno-unused-command-line-argument` so that if someone does something like
# `clang -Werror -o foo a.o b.o`, it doesn't complain due to the fact that that is using
# `clang` as a linker (and we have no real way to detect that in the wrapper), which will
# cause `clang` to complain about compiler flags being passed in.
"-Wno-unused-command-line-argument",
min_macos_version_flag(p),
])
end
if Sys.isfreebsd(p)
add_system_includedir(flags)
end
return flags
end
function clang_link_flags!(p::AbstractPlatform, flags::Vector{String} = String[])
# On macos and freebsd, we must pass in the `/lib` directory for some reason
if Sys.isbsd(p)
push!(flags, "-L/opt/$(aatriplet(p))/$(aatriplet(p))/lib")
end
# we want to use a particular linker with clang. But we want to avoid warnings about unused
# flags when just compiling, so we put it into "linker-only flags".
push!(flags, "-fuse-ld=$(aatriplet(p))")
# On macos, we need to pass `-headerpad_max_install_names` so that we have lots of space
# for `install_name_tool` shenanigans during audit fixups.
if Sys.isapple(p)
push!(flags, "-headerpad_max_install_names")
end
return flags
end
function macos_gcc_flags!(p::AbstractPlatform, flags::Vector{String} = String[])
# On macOS, if we're on an old GCC, the default -syslibroot that gets
# passed to the linker isn't calculated correctly, so we have to manually set it.
gcc_version, llvm_version = select_compiler_versions(p, compilers)
if gcc_version.major in (4, 5)
push!(flags, "-Wl,-syslibroot,/opt/$(aatriplet(p))/$(aatriplet(p))/sys-root")
end
push!(flags, min_macos_version_flag(p))
return flags
end
function gcc_flags!(p::AbstractPlatform, flags::Vector{String} = String[])
# Force proper cxx11 string ABI usage w00t w00t!
if cxxstring_abi(p) == "cxx11"
push!(flags, "-D_GLIBCXX_USE_CXX11_ABI=1")
elseif cxxstring_abi(p) == "cxx03"
push!(flags, "-D_GLIBCXX_USE_CXX11_ABI=0")
end
# Simulate some of the `__OSX_AVAILABLE()` macro usage that is broken in GCC
if Sys.isapple(p) && something(os_version(p), v"14") < v"16"
# Disable usage of `clock_gettime()`
push!(flags, "-D_DARWIN_FEATURE_CLOCK_GETTIME=0")
end
# Use hash of arguments to provide consistent, unique random seed
push!(flags, "-frandom-seed=0x\${ARGS_HASH}")
if Sys.isapple(p)
macos_gcc_flags!(p, flags)
end
return flags
end
function gcc_compile_flags!(p::AbstractPlatform, flags::Vector{String} = String[])
if Sys.islinux(p) || Sys.isfreebsd(p)
# Help GCCBootstrap find its own libraries under
# `/opt/${target}/${target}/lib{,64}`. Note: we need to push them directly in
# the wrappers before any additional arguments because we want this path to have
# precedence over anything else. In this way for example we avoid libraries
# from `CompilerSupportLibraries_jll` in `${libdir}` are picked up by mistake.
dir = "/opt/$(aatriplet(p))/$(aatriplet(p))/lib" * (nbits(p) == 32 ? "" : "64")
append!(flags, ("-L$(dir)", "-Wl,-rpath-link,$(dir)"))
end
if lock_microarchitecture
append!(flags, get_march_flags(arch(p), march(p), "gcc"))
end
gcc_version, llvm_version = select_compiler_versions(p, compilers)
if libc(platform) == "musl" && gcc_version in (v"4.8.5", v"5.2.0")
add_system_includedir(flags)
end
return flags
end
function gcc_link_flags!(p::AbstractPlatform, flags::Vector{String} = String[])
# Yes, it does seem that the inclusion of `/lib64` on `powerpc64le` was fixed
# in GCC 6, broken again in GCC 7, and then fixed again for GCC 8 and 9
gcc_version, llvm_version = select_compiler_versions(p, compilers)
if arch(p) == "powerpc64le" && Sys.islinux(p) && gcc_version.major in (4, 5, 7)
append!(flags, String[
"-L/opt/$(aatriplet(p))/$(aatriplet(p))/sys-root/lib64",
"-Wl,-rpath-link,/opt/$(aatriplet(p))/$(aatriplet(p))/sys-root/lib64",
])
elseif Sys.isapple(p)
push!(flags, "-headerpad_max_install_names")
end
return flags
end
function gcc_unsafe_flags!(p::AbstractPlatform, flags::Vector{String} = String[])
if !allow_unsafe_flags
return String["-Ofast", "-ffast-math", "-funsafe-math-optimizations"]
end
return String[]
end
function gcc_wrapper(io::IO, tool::String, p::AbstractPlatform, allow_ccache::Bool = true)
return wrapper(io,
"/opt/$(aatriplet(p))/bin/$(aatriplet(p))-$(tool)";
flags=gcc_flags!(p),
compile_only_flags=gcc_compile_flags!(p),
link_only_flags=gcc_link_flags!(p),
unsafe_flags=gcc_unsafe_flags!(p),
hash_args = true,
allow_ccache,
no_soft_float=arch(p) in ("armv6l", "armv7l"),
# Override `LD_LIBRARY_PATH` to avoid external settings mess it up.
env=Dict("LD_LIBRARY_PATH"=>ld_library_path(platform, host_platform; csl_paths=false)),
)
end
function clang_wrapper(io::IO, tool::String, p::AbstractPlatform)
flags = clang_flags!(p)
return wrapper(io,
"/opt/$(host_target)/bin/$(tool)";
flags=flags,
compile_only_flags=clang_compile_flags!(p),
link_only_flags=clang_link_flags!(p),
no_soft_float=arch(p) in ("armv6l", "armv7l"),
# Override `LD_LIBRARY_PATH` to avoid external settings mess it up.
env=Dict("LD_LIBRARY_PATH"=>ld_library_path(platform, host_platform; csl_paths=false)),
)
end
# C/C++/Fortran
gcc(io::IO, p::AbstractPlatform) = gcc_wrapper(io, "gcc", p)
gxx(io::IO, p::AbstractPlatform) = gcc_wrapper(io, "g++", p)
gfortran(io::IO, p::AbstractPlatform) = gcc_wrapper(io, "gfortran", p, false)
clang(io::IO, p::AbstractPlatform) = clang_wrapper(io, "clang", p)
clangxx(io::IO, p::AbstractPlatform) = clang_wrapper(io, "clang++", p)
# Our general `cc` points to `gcc` for most systems, but `clang` for MacOS and FreeBSD
function cc(io::IO, p::AbstractPlatform)
if Sys.isbsd(p)
return clang(io, p)
else
return gcc(io, p)
end
end
function cxx(io::IO, p::AbstractPlatform)
if Sys.isbsd(p)
return clangxx(io, p)
else
return gxx(io, p)
end
end
fc(io::IO, p::AbstractPlatform) = gfortran(io, p)
# Go stuff where we build an environment mapping each time we invoke `go-${target}`
function GOOS(p::AbstractPlatform)
if os(p) == "macos"
return "darwin"
end
return os(p)
end
function GOARCH(p::AbstractPlatform)
arch_mapping = Dict(
"armv6l" => "arm",
"armv7l" => "arm",
"aarch64" => "arm64",
"x86_64" => "amd64",
"i686" => "386",
"powerpc64le" => "ppc64le",
)
return arch_mapping[arch(p)]
end
function go(io::IO, p::AbstractPlatform)
env = Dict(
"GOOS" => GOOS(p),
"GOROOT" => "/opt/$(host_target)/go",
"GOARCH" => GOARCH(p),
)
return wrapper(io, "/opt/$(host_target)/go/bin/go"; env=env, allow_ccache=false)
end
gofmt(io::IO, p::AbstractPlatform) = wrapper(io, "/opt/$(host_target)/go/bin/gofmt"; allow_ccache=false)
# Rust stuff
function rust_flags!(p::AbstractPlatform, flags::Vector{String} = String[])
if Sys.islinux(p)
push!(flags, "-Clinker=$(aatriplet(p))-gcc")
# Add aarch64 workaround https://github.com/rust-lang/rust/issues/46651#issuecomment-402850885
if arch(p) == "aarch64" && libc(p) == "musl"
push!(flags, "-C link-arg=-lgcc")
end
elseif Sys.iswindows(p)
# Rust on i686 mingw32 can't deal with exceptions
# https://github.com/rust-lang/rust/issues/12859
if arch(p) == "i686"
push!(flags, "-C panic=abort")
end
end
return flags
end
function rustc(io::IO, p::AbstractPlatform)
extra_cmds = """
if [[ " \${ARGS[@]} " == *'--target'* ]]; then
if ! [[ " \${ARGS[@]} " =~ --target(=| )$(map_rust_target(p)) ]]; then
echo "Attempting to invoke targeted 'rustc' wrapper with a different target! (Expected $(map_rust_target(p)))" >&2
echo "args: \${ARGS[@]}" >&2
exit 1
fi
else
PRE_FLAGS+=( '--target=$(map_rust_target(p))' )
fi
"""
wrapper(io, "/opt/$(host_target)/bin/rustc"; flags=rust_flags!(p), allow_ccache=false, extra_cmds=extra_cmds)
end
rustup(io::IO, p::AbstractPlatform) = wrapper(io, "/opt/$(host_target)/bin/rustup"; allow_ccache=false)
cargo(io::IO, p::AbstractPlatform) = wrapper(io, "/opt/$(host_target)/bin/cargo"; allow_ccache=false)
# Meson REQUIRES that `CC`, `CXX`, etc.. are set to the host utils. womp womp.
function meson(io::IO, p::AbstractPlatform)
# Ugh, we need the path to `host_prefix`, let's quickly generate our
# environment variables.
host_prefix = platform_envs(p, ""; host_platform=default_host_platform)["host_prefix"]
meson_env = Dict(
# TODO: still needed? See
# https://mesonbuild.com/Release-notes-for-0-54-0.html#environment-variables-with-cross-builds
"AR" => "$(host_target)-ar",
"CC" => "$(host_target)-cc",
"CXX" => "$(host_target)-c++",
"FC" => "$(host_target)-f77",
"LD" => "$(host_target)-ld",
"NM" => "$(host_target)-nm",
"OBJC" => "$(host_target)-cc",
"RANLIB" => "$(host_target)-ranlib",
# Needed to find pkg-config files for the host: https://mesonbuild.com/Reference-tables.html#environment-variables-per-machine
"PKG_CONFIG_PATH_FOR_BUILD" => "$(host_prefix)/lib/pkgconfig:$(host_prefix)/lib64/pkgconfig:$(host_prefix)/share/pkgconfig",
)
wrapper(io, "/usr/bin/meson"; allow_ccache=false, env=meson_env)
end
# Patchelf needs some page-alignment on aarch64 and ppc64le forced into its noggin
# https://github.com/JuliaPackaging/BinaryBuilder.jl/commit/cce4f8fdbb16425d245ab87a50f60d1a16d04948
function patchelf(io::IO, p::AbstractPlatform)
extra_cmds = ""
if Sys.islinux(p) && arch(p) in ("aarch64", "powerpc64le")
extra_cmds = raw"""
if [[ " ${ARGS[@]} " != *'--page-size'* ]]; then
PRE_FLAGS+=( '--page-size' '65536' )
fi
"""
end
wrapper(io, "/usr/bin/patchelf"; allow_ccache=false, extra_cmds=extra_cmds)
end
# We pass `-D` to all `ar` invocations (unless `-U` is explicitly passed) for reproducibility
function ar(io::IO, p::AbstractPlatform)
ar_name = string(aatriplet(p), "-ar")
if Sys.isapple(p)
ar_name = "llvm-ar"
end
extra_cmds = raw"""
if [[ " ${ARGS[0]} " =~ --* ]]; then
# do nothing, it's probably --version or something
true
elif [[ " ${ARGS[0]} " != *'U'* ]]; then
# Eliminate the `u` option, as it's incompatible with `D` and is just an optimization
if [[ " ${ARGS[0]} " == *'u'* ]]; then
ARGS[0]=$(echo "${ARGS[0]}" | tr -d u)
fi
# Add -D for "Deterministic mode"
ARGS[0]="${ARGS[0]}D"
else
echo "Non-reproducibility alert: This 'ar' invocation uses the '-U' flag which embeds timestamps." >&2
echo "ar flags: ${ARGS[@]}" >&2
echo "Continuing build, but please repent." >&2
fi
"""
wrapper(io, string("/opt/", aatriplet(p), "/bin/", ar_name); allow_ccache=false, extra_cmds=extra_cmds)
end
function ranlib(io::IO, p::AbstractPlatform)
if !Sys.isapple(p)
ranlib_name = string(aatriplet(p), "-ranlib")
extra_cmds = raw"""
if [[ " ${ARGS[@]} " =~ "-[hHvVt]*U" ]]; then
echo "Non-reproducibility alert: This `ranlib` invocation uses the `-U` flag which embeds timestamps." >&2
echo "ranlib flags: ${ARGS[@]}" >&2
echo "Continuing build, but please repent." >&2
else
PRE_FLAGS+=( '-D' )
fi
"""
else
# llvm-ranlib is always reproducible
ranlib_name = "llvm-ranlib"
extra_cmds = ""
end
wrapper(io, string("/opt/", aatriplet(p), "/bin/", ranlib_name); allow_ccache=false, extra_cmds=extra_cmds)
end
function dlltool(io::IO, p::AbstractPlatform)
extra_cmds = raw"""
PRE_FLAGS+=( --temp-prefix /tmp/dlltool-${ARGS_HASH} )
"""
wrapper(io, string("/opt/", aatriplet(p), "/bin/", string(aatriplet(p), "-dlltool")); allow_ccache=false, extra_cmds=extra_cmds, hash_args=true)
end
# Write out a bunch of common tools
for tool in (:cpp, :ld, :nm, :libtool, :objcopy, :objdump, :otool,
:strip, :install_name_tool, :dlltool, :windres, :winmc, :lipo)
@eval $(tool)(io::IO, p::AbstractPlatform) = $(wrapper)(io, string("/opt/", aatriplet(p), "/bin/", aatriplet(p), "-", $(string(tool))); allow_ccache=false)
end
as(io::IO, p::AbstractPlatform) =
wrapper(io, string("/opt/", aatriplet(p), "/bin/", aatriplet(p), "-as");
allow_ccache=false,
# At the moment `as` for `aarch64-apple-darwin` is `clang-8`, which can't deal with
# `MACOSX_DEPLOYMENT_TARGET=11.0`, so we pretend to be on 10.16. Note: a better check would be
# `VersionNumber(macos_version(p)) ≥ v"11"`, but sometimes `p` may not have `os_version` set, leading to
# an error. TODO: remove this hack and create `as` wrapper together with the tools above when we
# upgrade `as` to a newer version of Clang.
env=(Sys.isapple(p) && arch(p) == "aarch64") ? Dict("MACOSX_DEPLOYMENT_TARGET"=>"10.16") : Dict{String,String}())
# c++filt is hard to write in symbols
function cxxfilt(io::IO, p::AbstractPlatform)
if Sys.isapple(p)
# We must use `llvm-cxxfilt` on MacOS
path = "/opt/$(aatriplet(p))/bin/llvm-cxxfilt"
else
path = "/opt/$(aatriplet(p))/bin/$(aatriplet(p))-c++filt"
end
return wrapper(io, path; allow_ccache=false)
end
function dsymutil(io::IO, p::AbstractPlatform)
if !Sys.isapple(p)
# Nobody except macOS has a `dsymutil`
return (io, p) -> nothing
end
return wrapper(io, "/opt/$(aatriplet(p))/bin/dsymutil"; allow_ccache=false)
end
function readelf(io::IO, p::AbstractPlatform)
if Sys.isapple(p)
# macOS doesn't have a readelf
return (io, p) -> nothing
end
return wrapper(io, "/opt/$(aatriplet(p))/bin/$(aatriplet(p))-readelf"; allow_ccache=false)
end
function write_wrapper(wrappergen, p, fname)
file_path = joinpath(bin_path, triplet(p), fname)
mkpath(dirname(file_path))
open(io -> Base.invokelatest(wrappergen, io, p), file_path, "w")
chmod(file_path, 0o775)
end
## Generate compiler wrappers for both our host and our target.
for p in unique((host_platform, platform))
t = aatriplet(p)
# Generate `:c` compilers
if :c in compilers
write_wrapper(cc, p, "$(t)-cc")
write_wrapper(cxx, p, "$(t)-c++")
# Generate `gcc`, `g++`, `clang` and `clang++`
write_wrapper(gcc, p, "$(t)-gcc")
write_wrapper(gxx, p, "$(t)-g++")
write_wrapper(clang, p, "$(t)-clang")
write_wrapper(clangxx, p, "$(t)-clang++")
# Someday, you will be split out
write_wrapper(gfortran, p, "$(t)-f77")
write_wrapper(gfortran, p, "$(t)-gfortran")
# Binutils
write_wrapper(ar, p, "$(t)-ar")
write_wrapper(as, p, "$(t)-as")
write_wrapper(cpp, p, "$(t)-cpp")
write_wrapper(cxxfilt, p, "$(t)-c++filt")
write_wrapper(ld, p, "$(t)-ld")
# ld wrappers for clang's `-fuse-ld=$(target)`
if Sys.isapple(p)
write_wrapper(ld, p, "ld64.$(t)")
else
write_wrapper(ld, p, "ld.$(t)")
end
write_wrapper(nm, p, "$(t)-nm")
write_wrapper(libtool, p, "$(t)-libtool")
write_wrapper(objcopy, p, "$(t)-objcopy")
write_wrapper(objdump, p, "$(t)-objdump")
write_wrapper(ranlib, p, "$(t)-ranlib")
write_wrapper(readelf, p, "$(t)-readelf")
write_wrapper(strip, p, "$(t)-strip")
# Special mac stuff
if Sys.isapple(p)
write_wrapper(install_name_tool, p, "$(t)-install_name_tool")
write_wrapper(lipo, p, "$(t)-lipo")
write_wrapper(dsymutil, p, "$(t)-dsymutil")
write_wrapper(otool, p, "$(t)-otool")
end
# Special Windows stuff
if Sys.iswindows(p)
write_wrapper(dlltool, p, "$(t)-dlltool")
write_wrapper(windres, p, "$(t)-windres")
write_wrapper(winmc, p, "$(t)-winmc")
end
end
# Generate go stuff
if :go in compilers
write_wrapper(go, p, "$(t)-go")
write_wrapper(gofmt, p, "$(t)-gofmt")
end
# Misc. utilities
write_wrapper(patchelf, p, "$(t)-patchelf")
end
# Rust stuff doesn't use the normal "host" platform, it uses x86_64-linux-gnu, so we always have THREE around,
# because clever build systems like `meson` ask Rust what its native system is, and it truthfully answers
# `x86_64-linux-gnu`, while other build systems might say `x86_64-linux-musl` with no less accuracy. So for
# safety, we just ship all three all the time.
if :rust in compilers
for p in unique((platform, host_platform))
t = aatriplet(p)
write_wrapper(rustc, p, "$(t)-rustc")
write_wrapper(rustup, p, "$(t)-rustup")
write_wrapper(cargo, p, "$(t)-cargo")
end
end
# Write a single wrapper for `meson`
write_wrapper(meson, host_platform, "meson")
default_tools = [
# Misc. utilities from RootFS
"patchelf",
]
if :c in compilers
# Binutils
append!(default_tools,
("ar", "as", "c++filt", "ld", "nm", "libtool", "objcopy", "ranlib", "readelf", "strip"))
if Sys.isapple(platform)
append!(default_tools, ("dsymutil", "lipo", "otool", "install_name_tool"))
elseif Sys.iswindows(platform)
append!(default_tools, ("dlltool", "windres", "winmc"))
end
append!(default_tools, ("cc", "c++", "cpp", "f77", "gfortran", "gcc", "clang", "g++", "clang++"))
end
if :rust in compilers
append!(default_tools, ("rustc","rustup","cargo"))
end
if :go in compilers
append!(default_tools, ("go", "gofmt"))
end
# Create symlinks for default compiler invocations, invoke target toolchain
for tool in default_tools
symlink("$(target)-$(tool)", joinpath(bin_path, triplet(platform), tool))
end
# Generate other fake system-specific tools.
if os(platform) == "macos"
# `sw_vers -productVersion` is needed to make CMake correctly initialise the macOS
# platform, ref: <https://github.com/JuliaPackaging/Yggdrasil/pull/4403>. In the
# future we may add more arguments, see
# <https://www.unix.com/man-page/osx/1/sw_vers/> for reference.
product_version = macos_version(platform)
product_name = VersionNumber(product_version) < v"10.12" ? "Mac OS X" : "macOS"
sw_vers_path = joinpath(bin_path, triplet(platform), "sw_vers")
write(sw_vers_path, """
#!/bin/sh
if [[ -z "\${@}" ]]; then
echo "ProductName: $(product_name)"
echo "ProductVersion: $(product_version)"
elif [[ "\${@}" == "-productName" ]]; then
echo "$(product_name)"
elif [[ "\${@}" == "-productVersion" ]]; then
echo "$(product_version)"
fi
""")
chmod(sw_vers_path, 0o775)
# `xcrun` is another macOS-specific tool, which is occasionally needed to run some
# commands, for example for the CGO linker. Ref:
# <https://github.com/JuliaPackaging/Yggdrasil/pull/2962>.
xcrun_path = joinpath(bin_path, triplet(platform), "xcrun")
write(xcrun_path, """
#!/bin/sh
exec "\${@}"
""")
chmod(xcrun_path, 0o775)
end
end
# Translation mappers for our target names to cargo-compatible ones. See
# https://doc.rust-lang.org/rustc/platform-support.html
map_rust_arch(p::AbstractPlatform) =
replace(replace(arch(p), "armv7l" => "armv7"), "armv6l" => "arm")
function map_rust_target(p::AbstractPlatform)
if Sys.isapple(p)
return "$(map_rust_arch(p))-apple-darwin"
elseif Sys.isfreebsd(p)
return "$(map_rust_arch(p))-unknown-freebsd"
elseif Sys.iswindows(p)
return "$(map_rust_arch(p))-pc-windows-gnu"
else
libc_str = libc(p) == "glibc" ? "gnu" : libc(p)
call_abi_str = something(call_abi(p), "")
return "$(map_rust_arch(p))-unknown-linux-$(libc_str)$(call_abi_str)"
end
end
# Match
# https://github.com/JuliaPackaging/Yggdrasil/blob/c58c5abe64e177bc6ed6aa775aff1fefbfe85517/0_RootFS/gcc_common.jl#L342-L352
function map_musl_arch(p::AbstractPlatform)
if arch(p) == "i686"
return "i386"
elseif startswith(arch(p), "arm")
return "armhf"
else
return arch(p)
end
end
"""
platform_envs(platform::AbstractPlatform, src_name::AbstractString;
host_platform = default_host_platform,
bootstrap::Bool=!isempty(bootstrap_list),
compilers::Vector{Symbol}=[:c],
rust_version::Union{Nothing,VersionNumber}=nothing,
verbose::Bool = false,
)
Given a `platform` and a `src_name`, generate a `Dict` mapping representing all
the environment variables to be set within the build environment to force
compiles toward the defined target architecture. Examples of things set are
`PATH`, `CC`, `RANLIB`, as well as nonstandard things like `target`.
Accepted keyword arguments are:
* `host_platform`: the platform of the host system,
* `bootstraop`: if `true`, only basic environment variables will be generated,
* `compilers`: list of compilers, some environment variables will be generated
only if the relevant compilers are used (e.g., for Go and Rust),
* `rust_version`: version of the Rust toolchain, needed to set the environment
variable `RUSTUP_TOOLCHAIN`,
* `verbose`: holds the value of the `V` and `VERBOSE` environment variables.
"""
function platform_envs(platform::AbstractPlatform, src_name::AbstractString;
host_platform = default_host_platform,
bootstrap::Bool=!isempty(bootstrap_list),
compilers::Vector{Symbol}=[:c],
rust_version::Union{Nothing,VersionNumber}=nothing,
verbose::Bool = false,
)
global use_ccache
# Convert platform to a triplet, but strip out the ABI parts
target = aatriplet(platform)
host_target = aatriplet(host_platform)
# Prefix, libdir, etc...
prefix = "/workspace/destdir"
host_prefix = "/workspace/$(triplet(host_platform))/destdir"
if Sys.iswindows(platform)
libdir = "$(prefix)/bin"
else
libdir = "$(prefix)/lib"
end
if Sys.iswindows(host_platform)
host_libdir = "$(host_prefix)/bin"
else
host_libdir = "$(host_prefix)/lib"
end
if get(stdout, :color, false)
PS1 = string(
raw"\[",
Base.text_colors[:light_blue],
raw"\]",
"sandbox",
raw"\[",
Base.text_colors[:normal],
raw"\]",
":",
raw"\[",
Base.text_colors[:yellow],
raw"\]",
raw"${PWD//$WORKSPACE/$\{WORKSPACE\}}",
raw"\[",
Base.text_colors[:normal],
raw"\]",
raw" \$ ",
)
else
PS1 = raw"sandbox:${PWD//$WORKSPACE/$\{WORKSPACE\}} $ "
end
# Number of parallel jobs to use for builds
nproc = "$(get(ENV, "BINARYBUILDER_NPROC", Sys.CPU_THREADS))"
# Base mappings
mapping = Dict(
# Platform information (we save a `bb_target` because sometimes `target` gets
# overwritten in `./configure`, and we want tools like `uname` to still see it)
"bb_target" => target,
"target" => target,
# Also give people access to the full `-cxxYY` and `-libgfortranX` triplet if they really want it
"bb_full_target" => triplet(platform),
"rust_target" => map_rust_target(platform),
"rust_host" => map_rust_target(host_platform),
"nproc" => nproc,
"nbits" => string(nbits(platform)),
"proc_family" => string(proc_family(platform)),
"dlext" => platform_dlext(platform),
"exeext" => platform_exeext(platform),
"PATH" => "/usr/local/bin:/usr/local/sbin:/usr/bin:/usr/sbin:/bin:/sbin",
"MACHTYPE" => aatriplet(default_host_platform),
# Set location parameters
"WORKSPACE" => "/workspace",
"prefix" => prefix,