xref: /illumos-gate/usr/src/tools/env/illumos.sh (revision 9164a50bf932130cbb5097a16f6986873ce0e6e5)
1#
2# CDDL HEADER START
3#
4# The contents of this file are subject to the terms of the
5# Common Development and Distribution License (the "License").
6# You may not use this file except in compliance with the License.
7#
8# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9# or http://www.opensolaris.org/os/licensing.
10# See the License for the specific language governing permissions
11# and limitations under the License.
12#
13# When distributing Covered Code, include this CDDL HEADER in each
14# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15# If applicable, add the following below this CDDL HEADER, with the
16# fields enclosed by brackets "[]" replaced with your own identifying
17# information: Portions Copyright [yyyy] [name of copyright owner]
18#
19# CDDL HEADER END
20#
21# Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
22# Copyright 2012 Joshua M. Clulow <josh@sysmgr.org>
23# Copyright 2015 Nexenta Systems, Inc.  All rights reserved.
24# Copyright 2015, OmniTI Computer Consulting, Inc. All rights reserved.
25# Copyright 2016 RackTop Systems.
26# Copyright 2019 OmniOS Community Edition (OmniOSce) Association.
27# Copyright 2020 Joyent, Inc.
28# Copyright 2023 Bill Sommerfeld
29#
30# - This file is sourced by "bldenv" and "nightly" and should not
31#   be executed directly.
32# - This script is only interpreted by ksh93 and explicitly allows the
33#   use of ksh93 language extensions.
34
35
36# -----------------------------------------------------------------------------
37# Parameters you are likely to want to change
38# -----------------------------------------------------------------------------
39
40#       DEBUG build only (-D, -F)
41#       do not bringover from the parent (-n)
42#       runs 'make check' (-C)
43#       checks for new interfaces in libraries (-A)
44#       sends mail on completion (-m and the MAILTO variable)
45#       creates packages for PIT/RE (-p)
46#       checks for changes in ELF runpaths (-r)
47#       build and use this workspace's tools in $SRC/tools (-t)
48export NIGHTLY_OPTIONS='-FnCDAmprt'
49
50# Some scripts optionally send mail messages to MAILTO.
51#export MAILTO=
52
53# CODEMGR_WS - where is your workspace at
54export CODEMGR_WS="${CODEMGR_WS:-`git rev-parse --show-toplevel`}"
55
56# Compilers may be specified using the following variables:
57# PRIMARY_CC	- primary C compiler
58# PRIMARY_CCC	- primary C++ compiler
59#
60# SHADOW_CCS    - list of shadow C compilers
61# SHADOW_CCCS	- list of shadow C++ compilers
62#
63# Each entry has the form <name>,<path to binary>,<style> where name is a
64# free-form name (possibly used in the makefiles to guard options), path is
65# the path to the executable.  style is the 'style' of command line taken by
66# the compiler, currently either gnu (or gcc) or sun (or cc), which is also
67# used by Makefiles to guard options.
68#
69# for example:
70# export PRIMARY_CC=gcc4,/opt/gcc/4.4.4/bin/gcc,gnu
71# export PRIMARY_CCC=gcc4,/opt/gcc/4.4.4/bin/g++,gnu
72# export SHADOW_CCS=studio12,/opt/SUNWspro/bin/cc,sun
73# export SHADOW_CCCS=studio12,/opt/SUNWspro/bin/CC,sun
74#
75# There can be several space-separated entries in SHADOW_* to run multiple
76# shadow compilers.
77#
78# To disable shadow compilation, unset SHADOW_* or set them to the empty string.
79#
80export GNUC_ROOT=/usr/gcc/10
81export PRIMARY_CC=gcc10,$GNUC_ROOT/bin/gcc,gnu
82export PRIMARY_CCC=gcc10,$GNUC_ROOT/bin/g++,gnu
83export SHADOW_CCS=gcc7,/usr/gcc/7/bin/gcc,gnu
84export SHADOW_CCCS=gcc7,/usr/gcc/7/bin/g++,gnu
85
86# comment to disable smatch
87export ENABLE_SMATCH=1
88
89# Comment this out to disable support for SMB printing, i.e. if you
90# don't want to bother providing the CUPS headers this needs.
91export ENABLE_SMB_PRINTING=
92
93# If your distro uses certain versions of Perl, make sure either Makefile.master
94# contains your new defaults OR your .env file sets them.
95# These are how you would override for building on OmniOS r151028, for example.
96#export PERL_VERSION=5.28
97#export PERL_VARIANT=-thread-multi
98#export PERL_PKGVERS=
99
100# To disable building of the 32-bit or 64-bit perl modules (or both),
101# uncomment these lines:
102#export BUILDPERL32='#'
103#export BUILDPERL64='#'
104
105# If your distro uses certain versions of Python, make sure either
106# Makefile.master contains your new defaults OR your .env file sets them.
107#export PYTHON3_VERSION=3.9
108#export PYTHON3_PKGVERS=-39
109#export PYTHON3_SUFFIX=
110
111# Set console color scheme either by build type:
112#
113#export RELEASE_CONSOLE_COLOR="-DDEFAULT_ANSI_FOREGROUND=ANSI_COLOR_BLACK \
114#	-DDEFAULT_ANSI_BACKGROUND=ANSI_COLOR_WHITE"
115#
116#export DEBUG_CONSOLE_COLOR="-DDEFAULT_ANSI_FOREGROUND=ANSI_COLOR_RED \
117#	-DDEFAULT_ANSI_BACKGROUND=ANSI_COLOR_WHITE"
118#
119# or just one for any build type:
120#
121#export DEFAULT_CONSOLE_COLOR="-DDEFAULT_ANSI_FOREGROUND=ANSI_COLOR_BLACK \
122#	-DDEFAULT_ANSI_BACKGROUND=ANSI_COLOR_WHITE"
123
124# Set if your distribution has different package versioning
125#export PKGVERS_BRANCH=2018.0.0.17900
126
127# Skip Java 11 builds on distributions that don't support it
128#export BLD_JAVA_11=
129
130# POST_NIGHTLY can be any command to be run at the end of nightly.  See
131# nightly(1) for interactions between environment variables and this command.
132#POST_NIGHTLY=
133
134# Populates /etc/versions/build on each nightly run
135export BUILDVERSION_EXEC="git describe --all --long --dirty"
136
137# -----------------------------------------------------------------------------
138# You are less likely to need to modify parameters below.
139# -----------------------------------------------------------------------------
140
141# Maximum number of dmake jobs.  The recommended number is 2 + NCPUS,
142# where NCPUS is the number of logical CPUs on your build system.
143function maxjobs
144{
145	nameref maxjobs=$1
146	integer ncpu
147	integer -r min_mem_per_job=512 # minimum amount of memory for a job
148
149	ncpu=$(builtin getconf ; getconf 'NPROCESSORS_ONLN')
150	(( maxjobs=ncpu + 2 ))
151
152	# Throttle number of parallel jobs launched by dmake to a value which
153	# gurantees that all jobs have enough memory. This was added to avoid
154	# excessive paging/swapping in cases of virtual machine installations
155	# which have lots of CPUs but not enough memory assigned to handle
156	# that many parallel jobs
157	if [[ $(/usr/sbin/prtconf 2>'/dev/null') == ~(E)Memory\ size:\ ([[:digit:]]+)\ Megabytes ]] ; then
158		integer max_jobs_per_memory # parallel jobs which fit into physical memory
159		integer physical_memory # physical memory installed
160
161		# The array ".sh.match" contains the contents of capturing
162		# brackets in the last regex, .sh.match[1] will contain
163		# the value matched by ([[:digit:]]+), i.e. the amount of
164		# memory installed
165		physical_memory="10#${.sh.match[1]}"
166
167		((
168			max_jobs_per_memory=round(physical_memory/min_mem_per_job) ,
169			maxjobs=fmax(2, fmin(maxjobs, max_jobs_per_memory))
170		))
171	fi
172
173	return 0
174}
175
176maxjobs DMAKE_MAX_JOBS # "DMAKE_MAX_JOBS" passed as ksh(1) name reference
177export DMAKE_MAX_JOBS
178
179# path to onbld tool binaries
180ONBLD_BIN='/opt/onbld/bin'
181
182# PARENT_WS is used to determine the parent of this workspace. This is
183# for the options that deal with the parent workspace (such as where the
184# proto area will go).
185export PARENT_WS="${PARENT_WS:-}"
186
187# CLONE_WS is the workspace nightly should do a bringover from.
188# The bringover, if any, is done as STAFFER.
189export CLONE_WS="${CLONE_WS:-}"
190
191# Set STAFFER to your own login as gatekeeper or developer
192# The point is to use group "staff" and avoid referencing the parent
193# workspace as root.
194export STAFFER="$LOGNAME"
195export MAILTO="${MAILTO:-$STAFFER}"
196
197# If you wish the mail messages to be From: an arbitrary address, export
198# MAILFROM.
199#export MAILFROM="user@example.com"
200
201# The project (see project(5)) under which to run this build.  If not
202# specified, the build is simply run in a new task in the current project.
203export BUILD_PROJECT=''
204
205# You should not need to change the next three lines
206export ATLOG="$CODEMGR_WS/log"
207export LOGFILE="$ATLOG/nightly.log"
208export MACH="$(uname -p)"
209
210#
211#  The following macro points to the closed binaries.  Once illumos has
212#  totally freed itself, we can remove this reference.
213#
214# Location of encumbered binaries.
215export ON_CLOSED_BINS="/opt/onbld/closed"
216
217# REF_PROTO_LIST - for comparing the list of stuff in your proto area
218# with. Generally this should be left alone, since you want to see differences
219# from your parent (the gate).
220#
221export REF_PROTO_LIST="$PARENT_WS/usr/src/proto_list_${MACH}"
222
223
224export ROOT="$CODEMGR_WS/proto/root_${MACH}"
225export SRC="$CODEMGR_WS/usr/src"
226export MULTI_PROTO="no"
227
228#
229#	build environment variables, including version info for mcs, motd,
230# motd, uname and boot messages. Mostly you shouldn't change this except
231# when the release slips (nah) or you move an environment file to a new
232# release
233#
234export VERSION="${VERSION:-`git describe --long --all HEAD | cut -d/ -f2-`}"
235
236#
237# the RELEASE and RELEASE_DATE variables are set in Makefile.master;
238# there might be special reasons to override them here, but that
239# should not be the case in general
240#
241# export RELEASE='5.11'
242# export RELEASE_DATE='October 2007'
243
244# proto area in parent for optionally depositing a copy of headers and
245# libraries corresponding to the protolibs target
246# not applicable given the NIGHTLY_OPTIONS
247#
248export PARENT_ROOT="$PARENT_WS/proto/root_$MACH"
249export PARENT_TOOLS_ROOT="$PARENT_WS/usr/src/tools/proto/root_$MACH-nd"
250
251# Package creation variables.  You probably shouldn't change these,
252# either.
253#
254# PKGARCHIVE determines where the repository will be created.
255#
256# PKGPUBLISHER_REDIST controls the publisher setting for the repository.
257#
258export PKGARCHIVE="${CODEMGR_WS}/packages/${MACH}/nightly"
259# export PKGPUBLISHER_REDIST='on-redist'
260
261# Package manifest format version.
262export PKGFMT_OUTPUT='v2'
263
264# We want make to do as much as it can, just in case there's more than
265# one problem.
266# We also must set e in MAKEFLAGS as the makefiles depend on importing
267# the environment variables set here.
268export MAKEFLAGS='ke'
269
270# Build tools - don't change these unless you know what you're doing.  These
271# variables allows you to get the compilers and onbld files locally.
272# Set BUILD_TOOLS to pull everything from one location.
273# Alternately, you can set ONBLD_TOOLS to where you keep the contents of
274# SUNWonbld.
275export BUILD_TOOLS='/opt'
276#export ONBLD_TOOLS='/opt/onbld'
277
278# Set this flag to 'n' to disable the use of 'checkpaths'.  The default,
279# if the 'N' option is not specified, is to run this test.
280#CHECK_PATHS='y'
281
282if [[ "$ENABLE_SMATCH" == "1" ]]; then
283	SMATCHBIN=$CODEMGR_WS/usr/src/tools/proto/root_$MACH-nd/opt/onbld/bin/$MACH/smatch
284	export SHADOW_CCS="$SHADOW_CCS smatch,$SMATCHBIN,smatch"
285fi
286