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
|
# Copyright 2019-2023 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
# @ECLASS: llvm.org.eclass
# @MAINTAINER:
# Michał Górny <mgorny@gentoo.org>
# @AUTHOR:
# Michał Górny <mgorny@gentoo.org>
# @SUPPORTED_EAPIS: 7 8
# @PROVIDES: git-r3
# @BLURB: Common bits for fetching & unpacking llvm.org projects
# @DESCRIPTION:
# The llvm.org eclass provides common code to fetch and unpack parts
# of the llvm.org project tree. It takes care of handling both git
# checkouts and source tarballs, making it possible to unify the code
# of live and release ebuilds and effectively reduce the work needed
# to package new releases/RCs/branches.
#
# In order to use this eclass, the ebuild needs to declare
# LLVM_COMPONENTS and then call llvm.org_set_globals. If tests require
# additional components, they need to be listed in LLVM_TEST_COMPONENTS.
# The eclass exports an implementation of src_unpack() phase.
#
# Example:
# @CODE
# inherit llvm.org
#
# LLVM_COMPONENTS=( lld )
# LLVM_TEST_COMPONENTS=( llvm/utils/lit )
# llvm.org_set_globals
# @CODE
case ${EAPI} in
7|8) ;;
*) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
esac
# == version substrings ==
# @ECLASS_VARIABLE: LLVM_MAJOR
# @OUTPUT_VARIABLE
# @DESCRIPTION:
# The major LLVM version.
LLVM_MAJOR=$(ver_cut 1)
# @ECLASS_VARIABLE: LLVM_VERSION
# @OUTPUT_VARIABLE
# @DESCRIPTION:
# The full 3-component LLVM version without suffixes or .9999.
LLVM_VERSION=$(ver_cut 1-3)
# == internal control bits ==
# @ECLASS_VARIABLE: _LLVM_MASTER_MAJOR
# @INTERNAL
# @DESCRIPTION:
# The major version of current LLVM trunk. Used to determine
# the correct branch to use.
_LLVM_MASTER_MAJOR=17
# @ECLASS_VARIABLE: _LLVM_SOURCE_TYPE
# @INTERNAL
# @DESCRIPTION:
# Source type to use: 'git', 'tar' or 'snapshot'.
if [[ -z ${_LLVM_SOURCE_TYPE+1} ]]; then
case ${PV} in
*.9999)
_LLVM_SOURCE_TYPE=git
;;
*_pre*)
_LLVM_SOURCE_TYPE=snapshot
case ${PV} in
17.0.0_pre20230512)
EGIT_COMMIT=7d436d56b60b36508b94e39d08761f1405a9c770
;;
17.0.0_pre20230502)
EGIT_COMMIT=52882de0e641487329c9e093a90ea3dad01842c8
;;
*)
die "Unknown snapshot: ${PV}"
;;
esac
export EGIT_VERSION=${EGIT_COMMIT}
;;
*)
_LLVM_SOURCE_TYPE=tar
;;
esac
fi
[[ ${_LLVM_SOURCE_TYPE} == git ]] && inherit git-r3
[[ ${LLVM_MAJOR} == ${_LLVM_MASTER_MAJOR} && ${_LLVM_SOURCE_TYPE} == tar ]] &&
die "${ECLASS}: Release ebuild for master branch?!"
inherit multiprocessing
if [[ ${_LLVM_SOURCE_TYPE} == tar ]]; then
inherit verify-sig
fi
# == control variables ==
# @ECLASS_VARIABLE: LLVM_COMPONENTS
# @REQUIRED
# @DESCRIPTION:
# List of components needed unconditionally. Specified as bash array
# with paths relative to llvm-project git. Automatically translated
# for tarball releases.
#
# The first path specified is used to construct default S.
# @ECLASS_VARIABLE: LLVM_TEST_COMPONENTS
# @DEFAULT_UNSET
# @DESCRIPTION:
# List of additional components needed for tests.
# @ECLASS_VARIABLE: LLVM_MANPAGES
# @DEFAULT_UNSET
# @DESCRIPTION:
# Set to a non-empty value in ebuilds that build manpages via Sphinx.
# The eclass will either include the dependency on dev-python/sphinx
# or pull the pregenerated manpage tarball depending on the package
# version.
# @ECLASS_VARIABLE: LLVM_PATCHSET
# @DEFAULT_UNSET
# @DESCRIPTION:
# LLVM patchset version. No patchset is used if unset.
# @ECLASS_VARIABLE: LLVM_USE_TARGETS
# @DEFAULT_UNSET
# @DESCRIPTION:
# Add LLVM_TARGETS flags. The following values are supported:
#
# - provide - this package provides LLVM targets. USE flags
# and REQUIRED_USE will be added but no dependencies.
#
# - llvm - this package uses targets from LLVM. RDEPEND+DEPEND
# on matching sys-devel/llvm versions with requested flags will
# be added.
#
# Note that you still need to pass enabled targets to the build system,
# usually grabbing them from ${LLVM_TARGETS} (via USE_EXPAND).
# == global data ==
# @ECLASS_VARIABLE: ALL_LLVM_EXPERIMENTAL_TARGETS
# @OUTPUT_VARIABLE
# @DESCRIPTION:
# The complete list of LLVM experimental targets available in this LLVM
# version. The value depends on ${PV}.
# @ECLASS_VARIABLE: ALL_LLVM_PRODUCTION_TARGETS
# @OUTPUT_VARIABLE
# @DESCRIPTION:
# The complete list of LLVM production-ready targets available in this
# LLVM version. The value depends on ${PV}.
# @ECLASS_VARIABLE: ALL_LLVM_TARGET_FLAGS
# @OUTPUT_VARIABLE
# @DESCRIPTION:
# The list of USE flags corresponding to all LLVM targets in this LLVM
# version. The value depends on ${PV}.
case ${LLVM_MAJOR} in
14)
ALL_LLVM_EXPERIMENTAL_TARGETS=( ARC CSKY M68k )
ALL_LLVM_PRODUCTION_TARGETS=(
AArch64 AMDGPU ARM AVR BPF Hexagon Lanai Mips MSP430 NVPTX
PowerPC RISCV Sparc SystemZ VE WebAssembly X86 XCore
)
;;
15)
ALL_LLVM_EXPERIMENTAL_TARGETS=(
ARC CSKY DirectX LoongArch M68k SPIRV
)
ALL_LLVM_PRODUCTION_TARGETS=(
AArch64 AMDGPU ARM AVR BPF Hexagon Lanai Mips MSP430 NVPTX
PowerPC RISCV Sparc SystemZ VE WebAssembly X86 XCore
)
;;
*)
ALL_LLVM_EXPERIMENTAL_TARGETS=(
ARC CSKY DirectX M68k SPIRV Xtensa
)
ALL_LLVM_PRODUCTION_TARGETS=(
AArch64 AMDGPU ARM AVR BPF Hexagon Lanai LoongArch Mips
MSP430 NVPTX PowerPC RISCV Sparc SystemZ VE WebAssembly X86
XCore
)
;;
esac
ALL_LLVM_TARGET_FLAGS=(
"${ALL_LLVM_PRODUCTION_TARGETS[@]/#/llvm_targets_}"
"${ALL_LLVM_EXPERIMENTAL_TARGETS[@]/#/llvm_targets_}"
)
# @ECLASS_VARIABLE: LLVM_SOABI
# @OUTPUT_VARIABLE
# @DESCRIPTION:
# The current ABI version of LLVM dylib, in a form suitable for use
# as a subslot. This is equal to LLVM_MAJOR for releases, and to PV
# for the main branch.
LLVM_SOABI=${LLVM_MAJOR}
[[ ${LLVM_MAJOR} == ${_LLVM_MASTER_MAJOR} ]] && LLVM_SOABI=${PV}
# == global scope logic ==
# @FUNCTION: llvm.org_set_globals
# @DESCRIPTION:
# Set global variables. This must be called after setting LLVM_*
# variables used by the eclass.
llvm.org_set_globals() {
if [[ $(declare -p LLVM_COMPONENTS) != "declare -a"* ]]; then
die 'LLVM_COMPONENTS must be an array.'
fi
if declare -p LLVM_TEST_COMPONENTS &>/dev/null; then
if [[ $(declare -p LLVM_TEST_COMPONENTS) != "declare -a"* ]]; then
die 'LLVM_TEST_COMPONENTS must be an array.'
fi
fi
case ${_LLVM_SOURCE_TYPE} in
git)
EGIT_REPO_URI="https://github.com/llvm/llvm-project.git"
[[ ${LLVM_MAJOR} != ${_LLVM_MASTER_MAJOR} ]] &&
EGIT_BRANCH="release/${LLVM_MAJOR}.x"
;;
tar)
SRC_URI+="
https://github.com/llvm/llvm-project/releases/download/llvmorg-${PV/_/-}/llvm-project-${PV/_/}.src.tar.xz
verify-sig? (
https://github.com/llvm/llvm-project/releases/download/llvmorg-${PV/_/-}/llvm-project-${PV/_/}.src.tar.xz.sig
)
"
BDEPEND+="
verify-sig? (
>=sec-keys/openpgp-keys-llvm-16.0.4
)
"
VERIFY_SIG_OPENPGP_KEY_PATH=${BROOT}/usr/share/openpgp-keys/llvm.asc
;;
snapshot)
SRC_URI+="
https://github.com/llvm/llvm-project/archive/${EGIT_COMMIT}.tar.gz
-> llvm-project-${EGIT_COMMIT}.tar.gz
"
;;
*)
die "Invalid _LLVM_SOURCE_TYPE: ${LLVM_SOURCE_TYPE}"
esac
S=${WORKDIR}/${LLVM_COMPONENTS[0]}
if [[ -n ${LLVM_TEST_COMPONENTS+1} ]]; then
IUSE+=" test"
RESTRICT+=" !test? ( test )"
fi
if [[ ${LLVM_MANPAGES} ]]; then
# use pregenerated tarball if available
local manpage_dist=$(llvm_manpage_get_dist)
if [[ -n ${manpage_dist} ]]; then
IUSE+=" doc"
SRC_URI+="
!doc? (
https://dev.gentoo.org/~mgorny/dist/llvm/${manpage_dist}
)
"
else
IUSE+=" +doc"
# NB: this is not always the correct dep but it does no harm
BDEPEND+=" dev-python/sphinx"
fi
fi
if [[ -n ${LLVM_PATCHSET} ]]; then
SRC_URI+="
https://dev.gentoo.org/~mgorny/dist/llvm/llvm-gentoo-patchset-${LLVM_PATCHSET}.tar.xz"
fi
local x
case ${LLVM_USE_TARGETS:-__unset__} in
__unset__)
;;
provide|llvm)
IUSE+=" ${ALL_LLVM_TARGET_FLAGS[*]}"
REQUIRED_USE+=" || ( ${ALL_LLVM_TARGET_FLAGS[*]} )"
;;&
llvm)
local dep=
for x in "${ALL_LLVM_TARGET_FLAGS[@]}"; do
dep+="
${x}? ( ~sys-devel/llvm-${PV}[${x}] )"
done
RDEPEND+=" ${dep}"
DEPEND+=" ${dep}"
;;
esac
# === useful defaults for cmake-based packages ===
# least intrusive of all
CMAKE_BUILD_TYPE=RelWithDebInfo
_LLVM_ORG_SET_GLOBALS_CALLED=1
}
# == phase functions ==
# @FUNCTION: llvm.org_src_unpack
# @DESCRIPTION:
# Unpack or checkout requested LLVM components.
llvm.org_src_unpack() {
if [[ ! ${_LLVM_ORG_SET_GLOBALS_CALLED} ]]; then
die "llvm.org_set_globals must be called in global scope"
fi
local components=( "${LLVM_COMPONENTS[@]}" )
if [[ ${LLVM_TEST_COMPONENTS+1} ]] && use test; then
components+=( "${LLVM_TEST_COMPONENTS[@]}" )
fi
local archive=
case ${_LLVM_SOURCE_TYPE} in
git)
git-r3_fetch
git-r3_checkout '' . '' "${components[@]}"
;;
tar)
archive=llvm-project-${PV/_/}.src.tar.xz
if use verify-sig; then
verify-sig_verify_detached \
"${DISTDIR}/${archive}" "${DISTDIR}/${archive}.sig"
fi
ebegin "Unpacking from ${archive}"
tar -x -J -o --strip-components 1 \
-f "${DISTDIR}/${archive}" \
"${components[@]/#/${archive%.tar*}/}" || die
eend ${?}
;;
snapshot)
archive=llvm-project-${EGIT_COMMIT}.tar.gz
ebegin "Unpacking from ${archive}"
tar -x -z -o --strip-components 1 \
-f "${DISTDIR}/${archive}" \
"${components[@]/#/${archive%.tar*}/}" || die
eend ${?}
;;
*)
die "Invalid _LLVM_SOURCE_TYPE: ${LLVM_SOURCE_TYPE}"
;;
esac
# unpack all remaining distfiles
local x
for x in ${A}; do
[[ ${x} != ${archive} ]] && unpack "${x}"
done
if [[ -n ${LLVM_PATCHSET} ]]; then
local nocomp=$(grep -r -L "^Gentoo-Component:" \
"${WORKDIR}/llvm-gentoo-patchset-${LLVM_PATCHSET}")
if [[ -n ${nocomp} ]]; then
die "Patches lacking Gentoo-Component found: ${nocomp}"
fi
# strip patches that don't match current components
local IFS='|'
grep -E -r -L "^Gentoo-Component:.*(${components[*]})" \
"${WORKDIR}/llvm-gentoo-patchset-${LLVM_PATCHSET}" |
xargs rm
local status=( "${PIPESTATUS[@]}" )
[[ ${status[1]} -ne 0 ]] && die "rm failed"
[[ ${status[0]} -ne 0 ]] &&
die "No patches in the patchset apply to the package"
fi
}
# @FUNCTION: llvm.org_src_prepare
# @DESCRIPTION:
# Call appropriate src_prepare (cmake or default) depending on inherited
# eclasses. Make sure that PATCHES and user patches are applied in top
# ${WORKDIR}, so that patches straight from llvm-project repository
# work correctly with -p1.
llvm.org_src_prepare() {
if [[ -n ${LLVM_PATCHSET} ]]; then
local PATCHES=(
"${PATCHES[@]}"
"${WORKDIR}/llvm-gentoo-patchset-${LLVM_PATCHSET}"
)
fi
pushd "${WORKDIR}" >/dev/null || die
if declare -f cmake_src_prepare >/dev/null; then
CMAKE_USE_DIR=${S}
if [[ ${EAPI} == 7 ]]; then
# cmake eclasses force ${S} for default_src_prepare in EAPI 7
# but use ${CMAKE_USE_DIR} for everything else
local S=${WORKDIR}
fi
cmake_src_prepare
else
default_src_prepare
fi
popd >/dev/null || die
}
# == helper functions ==
# @ECLASS_VARIABLE: LIT_JOBS
# @USER_VARIABLE
# @DEFAULT_UNSET
# @DESCRIPTION:
# Number of test jobs to run simultaneously. If unset, defaults
# to '-j' in MAKEOPTS. If that is not found, default to nproc.
# @FUNCTION: get_lit_flags
# @DESCRIPTION:
# Get the standard recommended lit flags for running tests, in CMake
# list form (;-separated).
get_lit_flags() {
echo "-vv;-j;${LIT_JOBS:-$(makeopts_jobs)}"
}
# @FUNCTION: llvm_manpage_get_dist
# @DESCRIPTION:
# Output the filename of the manpage dist for this version,
# if available. Otherwise returns without output.
llvm_manpage_get_dist() {
if [[ ${_LLVM_SOURCE_TYPE} == tar && ${PV} != *_rc* ]]; then
case ${PV} in
14*|15*|16.0.[0-3])
echo "llvm-${PV}-manpages.tar.bz2"
;;
16*)
echo "llvm-16.0.4-manpages.tar.bz2"
;;
esac
fi
}
# @FUNCTION: llvm_manpage_dist_available
# @DESCRIPTION:
# Return true (0) if this LLVM version features prebuilt manpage
# tarball, false (1) otherwise.
llvm_manpage_dist_available() {
local manpage_dist=$(llvm_manpage_get_dist)
[[ -n ${manpage_dist} ]]
}
# @FUNCTION: llvm_are_manpages_built
# @DESCRIPTION:
# Return true (0) if manpages are going to be built from source,
# false (1) if preinstalled manpages will be used.
llvm_are_manpages_built() {
use doc || ! llvm_manpage_dist_available
}
# @FUNCTION: llvm_install_manpages
# @DESCRIPTION:
# Install pregenerated manpages if available. No-op otherwise.
llvm_install_manpages() {
# install pre-generated manpages
if ! llvm_are_manpages_built; then
# (doman does not support custom paths)
insinto "/usr/lib/llvm/${LLVM_MAJOR}/share/man/man1"
doins "${WORKDIR}"/llvm-*-manpages/"${LLVM_COMPONENTS[0]}"/*.1
fi
}
EXPORT_FUNCTIONS src_unpack src_prepare
|