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