blob: 878272721cbb6f9703f68a911eadde11c46a90df [file] [log] [blame]
Patrick Williams92b42cb2022-09-03 06:53:57 -05001#
2# Copyright OpenEmbedded Contributors
3#
4# SPDX-License-Identifier: MIT
5#
6
7inherit python3native
8inherit rust-target-config
9
10# Common variables used by all Rust builds
11export rustlibdir = "${libdir}/rustlib/${RUST_HOST_SYS}/lib"
12FILES:${PN} += "${rustlibdir}/*.so"
13FILES:${PN}-dev += "${rustlibdir}/*.rlib ${rustlibdir}/*.rmeta"
14FILES:${PN}-dbg += "${rustlibdir}/.debug"
15
16RUSTLIB = "-L ${STAGING_DIR_HOST}${rustlibdir}"
17RUST_DEBUG_REMAP = "--remap-path-prefix=${WORKDIR}=/usr/src/debug/${PN}/${EXTENDPE}${PV}-${PR}"
18RUSTFLAGS += "${RUSTLIB} ${RUST_DEBUG_REMAP}"
19RUSTLIB_DEP ?= "libstd-rs"
20RUST_PANIC_STRATEGY ?= "unwind"
21
22def target_is_armv7(d):
23 '''Determine if target is armv7'''
24 # TUNE_FEATURES may include arm* even if the target is not arm
25 # in the case of *-native packages
26 if d.getVar('TARGET_ARCH') != 'arm':
27 return False
28
29 feat = d.getVar('TUNE_FEATURES')
30 feat = frozenset(feat.split())
31 mach_overrides = d.getVar('MACHINEOVERRIDES')
32 mach_overrides = frozenset(mach_overrides.split(':'))
33
34 v7=frozenset(['armv7a', 'armv7r', 'armv7m', 'armv7ve'])
35 if mach_overrides.isdisjoint(v7) and feat.isdisjoint(v7):
36 return False
37 else:
38 return True
39target_is_armv7[vardepvalue] = "${@target_is_armv7(d)}"
40
41# Responsible for taking Yocto triples and converting it to Rust triples
42def rust_base_triple(d, thing):
43 '''
44 Mangle bitbake's *_SYS into something that rust might support (see
45 rust/mk/cfg/* for a list)
46
47 Note that os is assumed to be some linux form
48 '''
49
50 # The llvm-target for armv7 is armv7-unknown-linux-gnueabihf
51 if d.getVar('{}_ARCH'.format(thing)) == d.getVar('TARGET_ARCH') and target_is_armv7(d):
52 arch = "armv7"
53 else:
54 arch = oe.rust.arch_to_rust_arch(d.getVar('{}_ARCH'.format(thing)))
55
Patrick Williams2390b1b2022-11-03 13:47:49 -050056 # Substituting "unknown" when vendor is empty will match rust's standard
57 # targets when building native recipes (including rust-native itself)
58 vendor = d.getVar('{}_VENDOR'.format(thing)) or "-unknown"
Patrick Williams92b42cb2022-09-03 06:53:57 -050059
60 # Default to glibc
61 libc = "-gnu"
62 os = d.getVar('{}_OS'.format(thing))
63 # This catches ARM targets and appends the necessary hard float bits
64 if os == "linux-gnueabi" or os == "linux-musleabi":
65 libc = bb.utils.contains('TUNE_FEATURES', 'callconvention-hard', 'hf', '', d)
66 elif "musl" in os:
67 libc = "-musl"
68 os = "linux"
Andrew Geissler517393d2023-01-13 08:55:19 -060069 elif "elf" in os:
70 libc = "-elf"
71 os = "none"
72 elif "eabi" in os:
73 libc = "-eabi"
74 os = "none"
Patrick Williams92b42cb2022-09-03 06:53:57 -050075
76 return arch + vendor + '-' + os + libc
77
78
79# In some cases uname and the toolchain differ on their idea of the arch name
80RUST_BUILD_ARCH = "${@oe.rust.arch_to_rust_arch(d.getVar('BUILD_ARCH'))}"
81
82# Naming explanation
83# Yocto
84# - BUILD_SYS - Yocto triple of the build environment
85# - HOST_SYS - What we're building for in Yocto
86# - TARGET_SYS - What we're building for in Yocto
87#
88# So when building '-native' packages BUILD_SYS == HOST_SYS == TARGET_SYS
89# When building packages for the image HOST_SYS == TARGET_SYS
90# This is a gross over simplification as there are other modes but
91# currently this is all that's supported.
92#
93# Rust
94# - TARGET - the system where the binary will run
95# - HOST - the system where the binary is being built
96#
97# Rust additionally will use two additional cases:
98# - undecorated (e.g. CC) - equivalent to TARGET
99# - triple suffix (e.g. CC:x86_64_unknown_linux_gnu) - both
Andrew Geissler517393d2023-01-13 08:55:19 -0600100# see: https://github.com/rust-lang/cc-rs
Patrick Williams92b42cb2022-09-03 06:53:57 -0500101# The way that Rust's internal triples and Yocto triples are mapped together
102# its likely best to not use the triple suffix due to potential confusion.
103
104RUST_BUILD_SYS = "${@rust_base_triple(d, 'BUILD')}"
105RUST_BUILD_SYS[vardepvalue] = "${RUST_BUILD_SYS}"
106RUST_HOST_SYS = "${@rust_base_triple(d, 'HOST')}"
107RUST_HOST_SYS[vardepvalue] = "${RUST_HOST_SYS}"
108RUST_TARGET_SYS = "${@rust_base_triple(d, 'TARGET')}"
109RUST_TARGET_SYS[vardepvalue] = "${RUST_TARGET_SYS}"
110
111# wrappers to get around the fact that Rust needs a single
112# binary but Yocto's compiler and linker commands have
113# arguments. Technically the archiver is always one command but
114# this is necessary for builds that determine the prefix and then
115# use those commands based on the prefix.
116WRAPPER_DIR = "${WORKDIR}/wrapper"
117RUST_BUILD_CC = "${WRAPPER_DIR}/build-rust-cc"
118RUST_BUILD_CXX = "${WRAPPER_DIR}/build-rust-cxx"
119RUST_BUILD_CCLD = "${WRAPPER_DIR}/build-rust-ccld"
120RUST_BUILD_AR = "${WRAPPER_DIR}/build-rust-ar"
121RUST_TARGET_CC = "${WRAPPER_DIR}/target-rust-cc"
122RUST_TARGET_CXX = "${WRAPPER_DIR}/target-rust-cxx"
123RUST_TARGET_CCLD = "${WRAPPER_DIR}/target-rust-ccld"
124RUST_TARGET_AR = "${WRAPPER_DIR}/target-rust-ar"
125
126create_wrapper_rust () {
127 file="$1"
128 shift
129 extras="$1"
130 shift
Andrew Geissler517393d2023-01-13 08:55:19 -0600131 crate_cc_extras="$1"
132 shift
Patrick Williams92b42cb2022-09-03 06:53:57 -0500133
134 cat <<- EOF > "${file}"
135 #!/usr/bin/env python3
136 import os, sys
137 orig_binary = "$@"
138 extras = "${extras}"
Andrew Geissler517393d2023-01-13 08:55:19 -0600139
140 # Apply a required subset of CC crate compiler flags
141 # when we build a target recipe for a non-bare-metal target.
142 # https://github.com/rust-lang/cc-rs/blob/main/src/lib.rs#L1614
143 if "CRATE_CC_NO_DEFAULTS" in os.environ.keys() and \
144 "TARGET" in os.environ.keys() and not "-none-" in os.environ["TARGET"]:
145 orig_binary += "${crate_cc_extras}"
146
Patrick Williams92b42cb2022-09-03 06:53:57 -0500147 binary = orig_binary.split()[0]
148 args = orig_binary.split() + sys.argv[1:]
149 if extras:
150 args.append(extras)
151 os.execvp(binary, args)
152 EOF
153 chmod +x "${file}"
154}
155
156WRAPPER_TARGET_CC = "${CC}"
157WRAPPER_TARGET_CXX = "${CXX}"
158WRAPPER_TARGET_CCLD = "${CCLD}"
159WRAPPER_TARGET_LDFLAGS = "${LDFLAGS}"
160WRAPPER_TARGET_EXTRALD = ""
Andrew Geissler8f840682023-07-21 09:09:43 -0500161# see recipes-devtools/gcc/gcc/0018-Add-ssp_nonshared-to-link-commandline-for-musl-targe.patch
162# we need to link with ssp_nonshared on musl to avoid "undefined reference to `__stack_chk_fail_local'"
163# when building MACHINE=qemux86 for musl
164WRAPPER_TARGET_EXTRALD:libc-musl = "-lssp_nonshared"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500165WRAPPER_TARGET_AR = "${AR}"
166
167# compiler is used by gcc-rs
168# linker is used by rustc/cargo
169# archiver is used by the build of libstd-rs
170do_rust_create_wrappers () {
171 mkdir -p "${WRAPPER_DIR}"
172
173 # Yocto Build / Rust Host C compiler
Andrew Geissler517393d2023-01-13 08:55:19 -0600174 create_wrapper_rust "${RUST_BUILD_CC}" "" "${CRATE_CC_FLAGS}" "${BUILD_CC}"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500175 # Yocto Build / Rust Host C++ compiler
Andrew Geissler517393d2023-01-13 08:55:19 -0600176 create_wrapper_rust "${RUST_BUILD_CXX}" "" "${CRATE_CC_FLAGS}" "${BUILD_CXX}"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500177 # Yocto Build / Rust Host linker
Andrew Geissler517393d2023-01-13 08:55:19 -0600178 create_wrapper_rust "${RUST_BUILD_CCLD}" "" "" "${BUILD_CCLD}" "${BUILD_LDFLAGS}"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500179 # Yocto Build / Rust Host archiver
Andrew Geissler517393d2023-01-13 08:55:19 -0600180 create_wrapper_rust "${RUST_BUILD_AR}" "" "" "${BUILD_AR}"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500181
182 # Yocto Target / Rust Target C compiler
Andrew Geissler517393d2023-01-13 08:55:19 -0600183 create_wrapper_rust "${RUST_TARGET_CC}" "${WRAPPER_TARGET_EXTRALD}" "${CRATE_CC_FLAGS}" "${WRAPPER_TARGET_CC}" "${WRAPPER_TARGET_LDFLAGS}"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500184 # Yocto Target / Rust Target C++ compiler
Andrew Geissler517393d2023-01-13 08:55:19 -0600185 create_wrapper_rust "${RUST_TARGET_CXX}" "${WRAPPER_TARGET_EXTRALD}" "${CRATE_CC_FLAGS}" "${WRAPPER_TARGET_CXX}" "${CXXFLAGS}"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500186 # Yocto Target / Rust Target linker
Andrew Geissler517393d2023-01-13 08:55:19 -0600187 create_wrapper_rust "${RUST_TARGET_CCLD}" "${WRAPPER_TARGET_EXTRALD}" "" "${WRAPPER_TARGET_CCLD}" "${WRAPPER_TARGET_LDFLAGS}"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500188 # Yocto Target / Rust Target archiver
Andrew Geissler517393d2023-01-13 08:55:19 -0600189 create_wrapper_rust "${RUST_TARGET_AR}" "" "" "${WRAPPER_TARGET_AR}"
Patrick Williams92b42cb2022-09-03 06:53:57 -0500190
191}
192
193addtask rust_create_wrappers before do_configure after do_patch do_prepare_recipe_sysroot
194do_rust_create_wrappers[dirs] += "${WRAPPER_DIR}"