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# 22# Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved. 23 24 25This directory contains the tools used to do a full build of the 26OS/Net workspace. They usually live in the /opt/onbld directory on build 27machines. From here, 'make install' will build and install the tools 28in $ROOT/opt/onbld. 29 30Layout of /opt/onbld 31-------------------- 32 33/opt/onbld/etc/abi 34 contains Solaris ABI database (ABI_*.db) and exceptions 35 for ABI Auditing tool (interface_check, interface_cmp). 36 37/opt/onbld/bin 38 basic bin directory - contains scripts. 39 40/opt/onbld/bin/${MACH} 41 architecture-specific bin directory for binaries. 42 43/opt/onbld/env 44 build environment files. 45 46/opt/onbld/lib 47 libraries used by the build tools. 48 49/opt/onbld/lib/python<version>/ 50 python modules used by the build tools. 51 52/opt/onbld/lib/python<version>/onbld/hgext 53 Mercurial extensions. 54 55/opt/onbld/lib/python/ 56 symlink to the modules directory of the currently preferred 57 python version. This exists to retain compatibility both for 58 tools expecting only one supported version of python, and for 59 user .hgrc files that expect to find cdm.py in 60 /opt/onbld/lib/python/onbld/hgext. 61 62/opt/onbld/man 63 rudimentary man pages for some of the tools. 64 65 66Tool Summary 67------------ 68 69bldenv 70 companion to 'nightly.' Takes the same environment file you 71 used with 'nightly,' and starts a shell with the environment 72 set up the same way as 'nightly' set it up. This is useful 73 if you're trying to quickly rebuild portions of a workspace 74 built by 'nightly'. 'ws' should not be used for this since it 75 sets the environment up differently and may cause everything 76 to rebuild (because of different -I or -L paths). 77 78build_cscope 79 builds cscope databases in the uts, the platform subdirectories 80 of uts, and in usr/src. Uses cscope-fast. 81 82cdm 83 A Mercurial extension providing various commands useful for ON 84 development 85 86check_rtime 87 checks ELF attributes used by ELF dynamic objects in the proto area. 88 Used by 'nightly's -r option, to check a number of ELF runtime 89 attributes for consistency with common build rules. nightly uses 90 the -o option to simplify the output for diffing with previous 91 build results. It also uses the -i option to obtain NEEDED and RUNPATH 92 entries, which help detect changes in software dependencies and makes 93 sure objects don't have any strange runpaths like /opt/SUNWspro/lib. 94 95codereview 96 Given two filenames, creates a postscript file with the file 97 differences highlighted. 98 99codesign 100 Tools for signing cryptographic modules using the official 101 Sun release keys stored on a remote signing server. This 102 directory contains signit, a client program for signing 103 files with the signing server; signproto, a shell script 104 that finds crypto modules in $ROOT and signs them using 105 signit; and codesign_server.pl, the code that runs on the 106 server. The codesign_server code is not used on an ON 107 build machine but is kept here for source control purposes. 108 109copyrightchk 110 Checks that files have appropriate SMI copyright notices. 111 Primarily used by wx 112 113cscope-fast 114 The fast version of cscope that we use internally. Seems to work, 115 but may need more testing before it's placed in the gate. The source 116 just really needs to be here. 117 118cstyle 119 checks C source for compliance with OS/Net guidelines. 120 121ctfconvert 122 Convert symbolic debugging information in an object file to the Compact 123 ANSI-C Type Format (CTF). 124 125ctfdump 126 Decode and display CTF data stored in a raw file or in an ELF file. 127 128ctfmerge 129 Merge the CTF data from one or more object files. 130 131elfcmp 132 Compares two ELF modules (e.g. .o files, executables) section by 133 section. Useful for determining whether "trivial" changes - 134 cstyle, lint, etc - actually changed the code. The -S option 135 is used to test whether two binaries are the same except for 136 the elfsign signature. 137 138find_elf 139 Search a directory tree for ELF objects, and produce one line of 140 output per object. Used by check_rtime and interface_check to locate 141 the objects to examine. 142 143findunref 144 Finds all files in a source tree that have access times older than a 145 certain time and are not in a specified list of exceptions. Since 146 'nightly' timestamps the start of the build, and findunref uses its 147 timestamp (by default), this can be used to find all files that were 148 unreferenced during a nightly build). Since some files are only used 149 during a SPARC or Intel build, 'findunref' needs to be run on 150 workspaces from both architectures and the results need to be merged. 151 For instance, if $INTELSRC and $SPARCSRC are set to the usr/src 152 directories of your Intel and SPARC nightly workspaces, then you 153 can merge the results like so: 154 155 $ findunref $INTELSRC $INTELSRC/tools/findunref/exception_list | \ 156 sort > ~/unref-i386.out 157 $ findunref $SPARCSRC $SPARCSRC/tools/findunref/exception_list | \ 158 sort > ~/unref-sparc.out 159 $ comm -12 ~/unref-i386.out ~/unref-sparc.out > ~/unref.out 160 161hdrchk 162 checks headers for compliance with OS/Net standards (form, includes, 163 C++ guards). 164 165hgsetup 166 creates a basic Mercurial configuration for the user. 167 168hg-active 169 helper used by webrev to generate file lists for Mercurial 170 workspaces. 171 172install.bin 173 binary version of /usr/sbin/install. Used to be vastly faster 174 (since /usr/sbin/install is a shell script), but may only be a bit 175 faster now. One speedup includes avoiding the name service for the 176 well-known, never-changing password entries like 'root' and 'sys.' 177 178interface_check 179 detects and reports invalid versioning in ELF objects. 180 Optionally generates an interface description file for 181 the workspace. 182 183interface_cmp 184 Compares two interface description files, as produced by 185 interface_check, and flags invalid deviations in ELF object 186 versioning between them. interface_cmp can be used between Solaris 187 gates to ensure that older releases remain compatible with the 188 development gate. It can also be used to validate new changes to 189 the development gate before they are integrated. 190 191lintdump 192 dumps the contents of one or more lint libraries; see lintdump(1) 193 194ndrgen 195 Network Data Language (NDL) RPC protocol compiler to support DCE 196 RPC/MSRPC and SMB/CIFS. ndrgen takes an input protocol definition 197 file (say, proto.ndl) and generates an output C source file 198 (proto_ndr.c) containing the Network Data Representation (NDR) 199 marshalling routines to implement the RPC protocol. 200 201nightly 202 nightly build script. Takes an environment (or 'env') file describing 203 such things as the workspace, the parent, and what to build. See 204 env/developer and env/gatekeeper for sample, hopefully well-commented 205 env files. 206 207protocmp 208 compares proto lists and the package definitions. Used by nightly 209 to determine if the proto area matches the packages, and to detect 210 differences between a childs proto area and a parents. 211 212protocmp.terse 213 transforms the output of protocmp into something a bit more friendly 214 215protolist 216 create a list of what's in the proto area, to feed to protocmp. 217 218 219ws 220 creates a shell with the environment set up to build in the given 221 workspace. Used mostly for non-full-build workspaces, so it sets up 222 to pull headers and libraries from the proto area of the parent if 223 they aren't in the childs proto area. 224 225tokenize 226 Used to build the sun4u boot block. 227 228webrev 229 Generates a set of HTML pages that show side-by-side diffs of 230 changes in your workspace, for easy communication of code 231 review materials. Can automagically find edited files or use a 232 manually-generated list; knows how to use wx's active file for 233 lists of checked-out files and proposed SCCS comments. 234 235which_scm 236 Reports the current Source Code Management (SCM) system in use 237 and the top-level directory of the workspace. 238 239wsdiff 240 Detect object differences between two ON proto areas. Used by 241 nightly(1) to determine what changed between two builds. Handy 242 for identifying the set of built objects impacted by a given 243 source change. This information is needed for patch construction. 244 245 246How to do a full build 247---------------------- 248 2491. Find an environment file that might do what you want to do. If you're just 250 a developer wanting to do a full build in a child of the gate, copy the 251 'developer' environment file to a new name (private to you and/or the 252 work being done in this workspace, to avoid collisions with others). Then 253 edit the file and tailor it to your workspace. Remember that this file 254 is a shell script, so it can do more than set environment variables. 255 2562. Run 'nightly' and give it your environment file as an 257 option. 'nightly' will first look for your environment file in 258 /opt/onbld/env, and if it's not there then it will look for it as an 259 absolute or relative path. Some people put their environment files in 260 their workspace to keep them close. 261 2623. When 'nightly' is complete, it will send a summary of what happened to 263 $MAILTO. Usually, the less info in the mail the better. If you have failures, 264 you can go look at the full log of what happened, generally in 265 $CODEMGR_WS/log/log.<date>/nightly.log (the mail_msg it sent and the proto 266 list are there too). You can also find the individual build logs, like 267 'make clobber' and 'make install' output in $SRC, under names like 268 clobber-${MACH}.out and install-${MACH}.out (for a DEBUG build). These 269 will be smaller than nightly.log, and maybe more searchable. 270 271Files you have to update to add a tool 272-------------------------------------- 273 2741. Add the tool in its appropriate place. 2752. Update the Makefile as required. 2763. Update usr/src/pkg/manifests/developer-build-onbld.mf 2774. Update usr/src/tools/README.tools (this file). 2785. Repeat 1-4 for any man pages. 279