xref: /titanic_41/usr/src/tools/scripts/bldenv.sh (revision 9149877b124dd1e992eeea9c1f34e3fd78abd4af) 
1#!/usr/bin/ksh93
2#
3# CDDL HEADER START
4#
5# The contents of this file are subject to the terms of the
6# Common Development and Distribution License (the "License").
7# You may not use this file except in compliance with the License.
8#
9# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10# or http://www.opensolaris.org/os/licensing.
11# See the License for the specific language governing permissions
12# and limitations under the License.
13#
14# When distributing Covered Code, include this CDDL HEADER in each
15# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16# If applicable, add the following below this CDDL HEADER, with the
17# fields enclosed by brackets "[]" replaced with your own identifying
18# information: Portions Copyright [yyyy] [name of copyright owner]
19#
20# CDDL HEADER END
21#
22
23#
24# Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
25# Copyright 2011 Nexenta Systems, Inc.  All rights reserved.
26#
27# Uses supplied "env" file, based on /opt/onbld/etc/env, to set shell variables
28# before spawning a shell for doing a release-style builds interactively
29# and incrementally.
30#
31
32function fatal_error
33{
34	print -u2 "${progname}: $*"
35	exit 1
36}
37
38function usage
39{
40    OPTIND=0
41    getopts -a "${progname}" "${USAGE}" OPT '-?'
42    exit 2
43}
44
45typeset -r USAGE=$'+
46[-?\n@(#)\$Id: bldenv (OS/Net) 2008-04-06 \$\n]
47[-author?OS/Net community <tools-discuss@opensolaris.org>]
48[+NAME?bldenv - spawn shell for interactive incremental OS-Net
49    consolidation builds]
50[+DESCRIPTION?bldenv is a useful companion to the nightly(1) script for
51    doing interactive and incremental builds in a workspace
52    already built with nightly(1). bldenv spawns a shell set up
53    with the same environment variables taken from an env_file,
54    as prepared for use with nightly(1).]
55[+?In addition to running a shell for interactive use, bldenv
56    can optionally run a single command in the given environment,
57    in the vein of sh -c or su -c. This is useful for
58    scripting, when an interactive shell would not be. If the
59    command is composed of multiple shell words or contains
60    other shell metacharacters, it must be quoted appropriately.]
61[+?bldenv is particularly useful for testing Makefile targets
62    like clobber, install and _msg, which otherwise require digging
63    through large build logs to figure out what is being
64    done.]
65[+?By default, bldenv will invoke the shell specified in
66    $SHELL. If $SHELL is not set or is invalid, csh will be
67    used.]
68[c?force the use of csh, regardless of the  value  of $SHELL.]
69[f?invoke csh with the -f (fast-start) option. This option is valid
70    only if $SHELL is unset or if it points to csh.]
71[d?set up environment for doing DEBUG builds (default is non-DEBUG)]
72[t?set up environment to use the tools in usr/src/tools (this is the
73    default, use +t to use the tools from /opt/onbld)]
74
75<env_file> [command]
76
77[+EXAMPLES]{
78    [+?Example 1: Interactive use]{
79        [+?Use bldenv to spawn a shell to perform  a  DEBUG  build  and
80            testing of the  Makefile  targets  clobber and install for
81            usr/src/cmd/true.]
82        [+\n% rlogin wopr-2 -l gk
83{root::wopr-2::49} bldenv -d /export0/jg/on10-se.env
84Build type   is  DEBUG
85RELEASE      is  5.10
86VERSION      is  wopr-2::on10-se::11/01/2001
87RELEASE_DATE is  May 2004
88The top-level `setup\' target is available to build headers
89and tools.
90Using /usr/bin/tcsh as shell.
91{root::wopr-2::49}
92{root::wopr-2::49} cd $SRC/cmd/true
93{root::wopr-2::50} make
94{root::wopr-2::51} make clobber
95/usr/bin/rm -f true true.po
96{root::wopr-2::52} make
97/usr/bin/rm -f true
98cat true.sh > true
99chmod +x true
100{root::wopr-2::53} make install
101install -s -m 0555 -u root -g bin -f /export0/jg/on10-se/proto/root_sparc/usr/bin true
102`install\' is up to date.]
103    }
104    [+?Example 2: Non-interactive use]{
105        [+?Invoke bldenv to create SUNWonbld with a single command:]
106        [+\nexample% bldenv onnv_06 \'cd $SRC/tools && make pkg\']
107        }
108}
109[+SEE ALSO?\bnightly\b(1)]
110'
111
112# main
113builtin basename
114
115# boolean flags (true/false)
116typeset flags=(
117	typeset c=false
118	typeset f=false
119	typeset d=false
120	typeset O=false
121	typeset o=false
122	typeset t=true
123	typeset s=(
124		typeset e=false
125		typeset h=false
126		typeset d=false
127		typeset o=false
128	)
129)
130
131typeset progname="$(basename -- "${0}")"
132
133OPTIND=1
134SUFFIX="-nd"
135
136while getopts -a "${progname}" "${USAGE}" OPT ; do
137    case ${OPT} in
138	  c)	flags.c=true  ;;
139	  +c)	flags.c=false ;;
140	  f)	flags.f=true  ;;
141	  +f)	flags.f=false ;;
142	  d)	flags.d=true  SUFFIX=""    ;;
143	  +d)	flags.d=false SUFFIX="-nd" ;;
144	  t)	flags.t=true  ;;
145	  +t)	flags.t=false ;;
146	  \?)	usage ;;
147    esac
148done
149shift $((OPTIND-1))
150
151# test that the path to the environment-setting file was given
152if (( $# < 1 )) ; then
153	usage
154fi
155
156# force locale to C
157export \
158	LC_COLLATE=C \
159	LC_CTYPE=C \
160	LC_MESSAGES=C \
161	LC_MONETARY=C \
162	LC_NUMERIC=C \
163	LC_TIME=C
164
165# clear environment variables we know to be bad for the build
166unset \
167	LD_OPTIONS \
168	LD_LIBRARY_PATH \
169	LD_AUDIT \
170	LD_BIND_NOW \
171	LD_BREADTH \
172	LD_CONFIG \
173	LD_DEBUG \
174	LD_FLAGS \
175	LD_LIBRARY_PATH_64 \
176	LD_NOVERSION \
177	LD_ORIGIN \
178	LD_LOADFLTR \
179	LD_NOAUXFLTR \
180	LD_NOCONFIG \
181	LD_NODIRCONFIG \
182	LD_NOOBJALTER \
183	LD_PRELOAD \
184	LD_PROFILE \
185	CONFIG \
186	GROUP \
187	OWNER \
188	REMOTE \
189	ENV \
190	ARCH \
191	CLASSPATH
192
193#
194# Setup environment variables
195#
196if [[ -f /etc/nightly.conf ]]; then
197	source /etc/nightly.conf
198fi
199
200if [[ -f "$1" ]]; then
201	if [[ "$1" == */* ]]; then
202		source "$1"
203	else
204		source "./$1"
205	fi
206else
207	if [[ -f "/opt/onbld/env/$1" ]]; then
208		source "/opt/onbld/env/$1"
209	else
210		printf \
211		    'Cannot find env file as either %s or /opt/onbld/env/%s\n' \
212		    "$1" "$1"
213		exit 1
214	fi
215fi
216shift
217
218# contents of stdenv.sh inserted after next line:
219# STDENV_START
220# STDENV_END
221
222# Check if we have sufficient data to continue...
223[[ -v CODEMGR_WS ]] || fatal_error "Error: Variable CODEMGR_WS not set."
224[[ -d "${CODEMGR_WS}" ]] || fatal_error "Error: ${CODEMGR_WS} is not a directory."
225[[ -f "${CODEMGR_WS}/usr/src/Makefile" ]] || fatal_error "Error: ${CODEMGR_WS}/usr/src/Makefile not found."
226
227# must match the getopts in nightly.sh
228OPTIND=1
229NIGHTLY_OPTIONS="-${NIGHTLY_OPTIONS#-}"
230while getopts '+0ABCDdFfGIilMmNnpRrtUuwW' FLAG "$NIGHTLY_OPTIONS"
231do
232	case "$FLAG" in
233	  t)	flags.t=true  ;;
234	  +t)	flags.t=false ;;
235	  *)	;;
236	esac
237done
238
239POUND_SIGN="#"
240# have we set RELEASE_DATE in our env file?
241if [ -z "$RELEASE_DATE" ]; then
242	RELEASE_DATE=$(LC_ALL=C date +"%B %Y")
243fi
244BUILD_DATE=$(LC_ALL=C date +%Y-%b-%d)
245BASEWSDIR=$(basename -- "${CODEMGR_WS}")
246DEV_CM="\"@(#)SunOS Internal Development: $LOGNAME $BUILD_DATE [$BASEWSDIR]\""
247export DEV_CM RELEASE_DATE POUND_SIGN
248
249print 'Build type   is  \c'
250if ${flags.d} ; then
251	print 'DEBUG'
252	unset RELEASE_BUILD
253	unset EXTRA_OPTIONS
254	unset EXTRA_CFLAGS
255else
256	# default is a non-DEBUG build
257	print 'non-DEBUG'
258	export RELEASE_BUILD=
259	unset EXTRA_OPTIONS
260	unset EXTRA_CFLAGS
261fi
262
263# update build-type variables
264PKGARCHIVE="${PKGARCHIVE}${SUFFIX}"
265
266# 	Set PATH for a build
267PATH="/opt/onbld/bin:/opt/onbld/bin/${MACH}:/opt/SUNWspro/bin:/usr/ccs/bin:/usr/bin:/usr/sbin:/usr/ucb:/usr/etc:/usr/openwin/bin:/usr/sfw/bin:/opt/sfw/bin:."
268if [[ "${SUNWSPRO}" != "" ]]; then
269	export PATH="${SUNWSPRO}/bin:$PATH"
270fi
271
272if [[ -n "${MAKE}" ]]; then
273	if [[ -x "${MAKE}" ]]; then
274		export PATH="$(dirname -- "${MAKE}"):$PATH"
275	else
276		print "\$MAKE (${MAKE}) is not a valid executible"
277		exit 1
278	fi
279fi
280
281TOOLS="${SRC}/tools"
282TOOLS_PROTO="${TOOLS}/proto/root_${MACH}-nd" ; export TOOLS_PROTO
283
284if "${flags.t}" ; then
285	export ONBLD_TOOLS="${ONBLD_TOOLS:=${TOOLS_PROTO}/opt/onbld}"
286
287	export STABS="${TOOLS_PROTO}/opt/onbld/bin/${MACH}/stabs"
288	export CTFSTABS="${TOOLS_PROTO}/opt/onbld/bin/${MACH}/ctfstabs"
289	export GENOFFSETS="${TOOLS_PROTO}/opt/onbld/bin/genoffsets"
290
291	export CTFCONVERT="${TOOLS_PROTO}/opt/onbld/bin/${MACH}/ctfconvert"
292	export CTFMERGE="${TOOLS_PROTO}/opt/onbld/bin/${MACH}/ctfmerge"
293
294	export CTFCVTPTBL="${TOOLS_PROTO}/opt/onbld/bin/ctfcvtptbl"
295	export CTFFINDMOD="${TOOLS_PROTO}/opt/onbld/bin/ctffindmod"
296
297	PATH="${TOOLS_PROTO}/opt/onbld/bin/${MACH}:${PATH}"
298	PATH="${TOOLS_PROTO}/opt/onbld/bin:${PATH}"
299	export PATH
300fi
301
302export DMAKE_MODE=${DMAKE_MODE:-parallel}
303
304DEF_STRIPFLAG="-s"
305
306TMPDIR="/tmp"
307
308export \
309	PATH TMPDIR \
310	POUND_SIGN \
311	DEF_STRIPFLAG \
312	RELEASE_DATE
313unset \
314	CFLAGS \
315	LD_LIBRARY_PATH
316
317# a la ws
318ENVLDLIBS1=
319ENVLDLIBS2=
320ENVLDLIBS3=
321ENVCPPFLAGS1=
322ENVCPPFLAGS2=
323ENVCPPFLAGS3=
324ENVCPPFLAGS4=
325PARENT_ROOT=
326PARENT_TOOLS_ROOT=
327
328if [[ "$MULTI_PROTO" != "yes" && "$MULTI_PROTO" != "no" ]]; then
329	printf \
330	    'WARNING: invalid value for MULTI_PROTO (%s); setting to "no".\n' \
331	    "$MULTI_PROTO"
332	export MULTI_PROTO="no"
333fi
334
335[[ "$MULTI_PROTO" == "yes" ]] && export ROOT="${ROOT}${SUFFIX}"
336
337ENVLDLIBS1="-L$ROOT/lib -L$ROOT/usr/lib"
338ENVCPPFLAGS1="-I$ROOT/usr/include"
339MAKEFLAGS=e
340
341export \
342        ENVLDLIBS1 \
343        ENVLDLIBS2 \
344        ENVLDLIBS3 \
345	ENVCPPFLAGS1 \
346        ENVCPPFLAGS2 \
347        ENVCPPFLAGS3 \
348	ENVCPPFLAGS4 \
349        MAKEFLAGS \
350        PARENT_ROOT \
351        PARENT_TOOLS_ROOT
352
353printf 'RELEASE      is %s\n'   "$RELEASE"
354printf 'VERSION      is %s\n'   "$VERSION"
355printf 'RELEASE_DATE is %s\n\n' "$RELEASE_DATE"
356
357if [[ -f "$SRC/Makefile" ]] && egrep -s '^setup:' "$SRC/Makefile" ; then
358	print "The top-level 'setup' target is available \c"
359	print "to build headers and tools."
360	print ""
361
362elif "${flags.t}" ; then
363	printf \
364	    'The tools can be (re)built with the install target in %s.\n\n' \
365	    "${TOOLS}"
366fi
367
368#
369# place ourselves in a new task, respecting BUILD_PROJECT if set.
370#
371/usr/bin/newtask -c $$ ${BUILD_PROJECT:+-p$BUILD_PROJECT}
372
373if [[ "${flags.c}" == "false" && -x "$SHELL" && \
374    "$(basename -- "${SHELL}")" != "csh" ]]; then
375	# $SHELL is set, and it's not csh.
376
377	if "${flags.f}" ; then
378		print 'WARNING: -f is ignored when $SHELL is not csh'
379	fi
380
381	printf 'Using %s as shell.\n' "$SHELL"
382	exec "$SHELL" ${@:+-c "$@"}
383
384elif "${flags.f}" ; then
385	print 'Using csh -f as shell.'
386	exec csh -f ${@:+-c "$@"}
387
388else
389	print 'Using csh as shell.'
390	exec csh ${@:+-c "$@"}
391fi
392
393# not reached
394