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