xref: /illumos-gate/usr/src/tools/env/illumos.sh (revision 45818ee124adeaaf947698996b4f4c722afc6d1f)
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 2010, 2011 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#
26
27# Configuration variables for the runtime environment of the nightly
28# build script and other tools for construction and packaging of
29# releases.
30# This example is suitable for building an illumos workspace, which
31# will contain the resulting archives. It is based off the onnv
32# release. It sets NIGHTLY_OPTIONS to make nightly do:
33#       DEBUG build only (-D, -F)
34#       do not bringover from the parent (-n)
35#       runs 'make check' (-C)
36#       checks for new interfaces in libraries (-A)
37#       runs lint in usr/src (-l plus the LINTDIRS variable)
38#       sends mail on completion (-m and the MAILTO variable)
39#       creates packages for PIT/RE (-p)
40#       checks for changes in ELF runpaths (-r)
41#       build and use this workspace's tools in $SRC/tools (-t)
42#
43# - This file is sourced by "bldenv.sh" and "nightly.sh" and should not
44#   be executed directly.
45# - This script is only interpreted by ksh93 and explicitly allows the
46#   use of ksh93 language extensions.
47#
48export NIGHTLY_OPTIONS='-FnCDAlmprt'
49
50#
51# -- PLEASE READ THIS --
52#
53# The variables  GATE and CODEMGR_WS must always be customised to
54# match your workspace/gate location!!
55#
56# -- PLEASE READ THIS --
57#
58
59# This is a variable for the rest of the script - GATE doesn't matter to
60# nightly itself
61export GATE='testws'
62
63# CODEMGR_WS - where is your workspace at (or what should nightly name it)
64export CODEMGR_WS="$HOME/ws/$GATE"
65
66# Maximum number of dmake jobs.  The recommended number is 2 + NCPUS,
67# where NCPUS is the number of logical CPUs on your build system.
68function maxjobs
69{
70	nameref maxjobs=$1
71	integer ncpu
72	integer -r min_mem_per_job=512 # minimum amount of memory for a job
73
74	ncpu=$(builtin getconf ; getconf 'NPROCESSORS_ONLN')
75	(( maxjobs=ncpu + 2 ))
76
77	# Throttle number of parallel jobs launched by dmake to a value which
78	# gurantees that all jobs have enough memory. This was added to avoid
79	# excessive paging/swapping in cases of virtual machine installations
80	# which have lots of CPUs but not enough memory assigned to handle
81	# that many parallel jobs
82	if [[ $(/usr/sbin/prtconf 2>'/dev/null') == ~(E)Memory\ size:\ ([[:digit:]]+)\ Megabytes ]] ; then
83		integer max_jobs_per_memory # parallel jobs which fit into physical memory
84		integer physical_memory # physical memory installed
85
86		# The array ".sh.match" contains the contents of capturing
87		# brackets in the last regex, .sh.match[1] will contain
88		# the value matched by ([[:digit:]]+), i.e. the amount of
89		# memory installed
90		physical_memory="10#${.sh.match[1]}"
91
92		((
93			max_jobs_per_memory=round(physical_memory/min_mem_per_job) ,
94			maxjobs=fmax(2, fmin(maxjobs, max_jobs_per_memory))
95		))
96	fi
97
98	return 0
99}
100
101maxjobs DMAKE_MAX_JOBS # "DMAKE_MAX_JOBS" passed as ksh(1) name reference
102export DMAKE_MAX_JOBS
103
104# path to onbld tool binaries
105ONBLD_BIN='/opt/onbld/bin'
106
107# PARENT_WS is used to determine the parent of this workspace. This is
108# for the options that deal with the parent workspace (such as where the
109# proto area will go).
110export PARENT_WS=''
111
112# CLONE_WS is the workspace nightly should do a bringover from.
113export CLONE_WS='ssh://anonhg@hg.illumos.org/illumos-gate'
114
115# The bringover, if any, is done as STAFFER.
116# Set STAFFER to your own login as gatekeeper or developer
117# The point is to use group "staff" and avoid referencing the parent
118# workspace as root.
119# Some scripts optionally send mail messages to MAILTO.
120#
121export STAFFER="$LOGNAME"
122export MAILTO="$STAFFER"
123
124# If you wish the mail messages to be From: an arbitrary address, export
125# MAILFROM.
126#export MAILFROM="user@example.com"
127
128# The project (see project(4)) under which to run this build.  If not
129# specified, the build is simply run in a new task in the current project.
130export BUILD_PROJECT=''
131
132# You should not need to change the next three lines
133export ATLOG="$CODEMGR_WS/log"
134export LOGFILE="$ATLOG/nightly.log"
135export MACH="$(uname -p)"
136
137#
138#  The following two macros are the closed/crypto binaries.  Once
139#  Illumos has totally freed itself, we can remove these references.
140#
141# Location of encumbered binaries.
142export ON_CLOSED_BINS="$CODEMGR_WS/closed"
143# Location of signed cryptographic binaries.
144export ON_CRYPTO_BINS="$CODEMGR_WS/on-crypto.$MACH.tar.bz2"
145
146# REF_PROTO_LIST - for comparing the list of stuff in your proto area
147# with. Generally this should be left alone, since you want to see differences
148# from your parent (the gate).
149#
150export REF_PROTO_LIST="$PARENT_WS/usr/src/proto_list_${MACH}"
151
152
153export ROOT="$CODEMGR_WS/proto/root_${MACH}"
154export SRC="$CODEMGR_WS/usr/src"
155export MULTI_PROTO="no"
156
157#
158#	build environment variables, including version info for mcs, motd,
159# motd, uname and boot messages. Mostly you shouldn't change this except
160# when the release slips (nah) or you move an environment file to a new
161# release
162#
163export VERSION="$GATE"
164
165#
166# the RELEASE and RELEASE_DATE variables are set in Makefile.master;
167# there might be special reasons to override them here, but that
168# should not be the case in general
169#
170# export RELEASE='5.11'
171# export RELEASE_DATE='October 2007'
172
173# proto area in parent for optionally depositing a copy of headers and
174# libraries corresponding to the protolibs target
175# not applicable given the NIGHTLY_OPTIONS
176#
177export PARENT_ROOT="$PARENT_WS/proto/root_$MACH"
178export PARENT_TOOLS_ROOT="$PARENT_WS/usr/src/tools/proto/root_$MACH-nd"
179
180# Package creation variables.  You probably shouldn't change these,
181# either.
182#
183# PKGARCHIVE determines where the repository will be created.
184#
185# PKGPUBLISHER_REDIST controls the publisher setting for the repository.
186#
187export PKGARCHIVE="${CODEMGR_WS}/packages/${MACH}/nightly"
188# export PKGPUBLISHER_REDIST='on-redist'
189
190# Package manifest format version.
191export PKGFMT_OUTPUT='v1'
192
193# we want make to do as much as it can, just in case there's more than
194# one problem.
195export MAKEFLAGS='k'
196
197# Magic variable to prevent the devpro compilers/teamware from sending
198# mail back to devpro on every use.
199export UT_NO_USAGE_TRACKING='1'
200
201# Build tools - don't change these unless you know what you're doing.  These
202# variables allows you to get the compilers and onbld files locally or
203# through cachefs.  Set BUILD_TOOLS to pull everything from one location.
204# Alternately, you can set ONBLD_TOOLS to where you keep the contents of
205# SUNWonbld and SPRO_ROOT to where you keep the compilers.  SPRO_VROOT
206# exists to make it easier to test new versions of the compiler.
207export BUILD_TOOLS='/opt'
208#export ONBLD_TOOLS='/opt/onbld'
209export SPRO_ROOT='/opt/SUNWspro'
210export SPRO_VROOT="$SPRO_ROOT"
211
212# This goes along with lint - it is a series of the form "A [y|n]" which
213# means "go to directory A and run 'make lint'" Then mail me (y) the
214# difference in the lint output. 'y' should only be used if the area you're
215# linting is actually lint clean or you'll get lots of mail.
216# You shouldn't need to change this though.
217#export LINTDIRS="$SRC y"
218
219# Set this flag to 'n' to disable the use of 'checkpaths'.  The default,
220# if the 'N' option is not specified, is to run this test.
221#CHECK_PATHS='y'
222
223# POST_NIGHTLY can be any command to be run at the end of nightly.  See
224# nightly(1) for interactions between environment variables and this command.
225#POST_NIGHTLY=
226
227# Comment this out to disable support for IPP printing, i.e. if you
228# don't want to bother providing the Apache headers this needs.
229export ENABLE_IPP_PRINTING=
230
231# Comment this out to disable support for SMB printing, i.e. if you
232# don't want to bother providing the CUPS headers this needs.
233export ENABLE_SMB_PRINTING=
234
235# If your distro uses certain versions of Perl, make sure either Makefile.master
236# contains your new defaults OR your .env file sets them.
237# These are how you would override for building on OmniOS r151012, for example.
238#export PERL_VERSION=5.16.1
239#export PERL_ARCH=i86pc-solaris-thread-multi-64int
240#export PERL_PKGVERS=-5161
241