1$NetBSD: UPDATING,v 1.183 2008/12/19 20:37:45 pgoyette Exp $ 2 3This file (UPDATING) is intended to be a brief reference to recent 4changes that might cause problems in the build process, and a guide for 5what to do if something doesn't work. 6 7For a more detailed description of the recommended way to build NetBSD 8using build.sh, see the BUILDING file. 9 10Note that much of the advice in this UPDATING file was written before 11build.sh existed. Nevertheless, the advice here may be useful for 12working around specific problems with build.sh. 13 14See also: BUILDING, build.sh, Makefile. 15 16Recent changes: 17^^^^^^^^^^^^^^^ 18 1920081219: 20 config(1) has been updated, and one of the files it creates - 21 swapnetbsd.o - has changed format. You need to rebuild config 22 (done automatically by build.sh) and then you need to rerun 23 config on all kernel configuration files before rebuilding those 24 kernels. 25 2620081205: 27 If you build with MKX11=no, you should remove /etc/rc.d/xdm and 28 /etc/rc.d/xfs from DESTDIR because those files were moved to the xetc 29 set and will appear as extra files for MKX11=no update builds. 30 3120081122: 32 On i386, various kernel options(4) in GENERIC including 33 file systems have been disabled and moved into kernel modules. 34 Before trying a new GENERIC kernel, you have to prepare the 35 following files as well as a new GENERIC kernel: 36 37 - build and install kernel modules from src/sys/modules 38 39 - install the latest bootloader, which will load a module 40 for the file system from which the kernel is loaded automatically 41 42 If you have to load your kernel from a file system which is not of 43 the same type as the root file system, you have to load the necessary 44 file system module manually on the boot prompt or in the boot.cfg file. 45 4620080827: 47 If you built and installed a libc from sources between 48 2008/08/20 and 2008/08/26 you got a broken strtouq(3) 49 which results in false errors reported by lint(1). 50 Since this breaks the libc build itself, manual help is 51 needed -- lint must be disabled temporarily, e.g.: 52 $ (cd lib/libc && make MKLINT=no dependall install) 53 5420080813: 55 MKDEBUG build was broken because the .depend files did not know 56 about .go files. You need to remove all .depend files and rebuild. 57 5820080731: 59 WAPBL (metadata journaling support) has been added, but at this 60 time isn't backwards compatible with pre-WAPBL aware kernels 61 and userland (fsck_ffs in particular). Please make sure you 62 don't use a journaled filesystem with an older kernel/userland, 63 especially an uncleanly mounted journaled filesystem. WAPBL 64 also requires the super block to be in the UFS2 format. You 65 can use fsck_ffs -c 4 to update the superblock format. 66 6720080721: 68 Assembler warnings are now fatal if $WARNS>0 and $NOGCCERROR 69 isn't defined. 70 7120080531: 72 The ioctl number of DRVSUSPENDDEV command on /dev/drvctl changed 73 from 125 (conflicted with DRVCTLCOMMAND) to 129. The drvctl(8) 74 utility needs to be rebuilt and reinstalled as older binaries 75 won't work correctly. The following sequence of commands: 76 77 $ (cd sys/sys/ && nbmake-$arch includes) 78 $ (cd sbin/drvctl/ && nbmake-$arch clean) 79 $ (cd sbin/drvctl/ && nbmake-$arch all) 80 81 leaves new drvctl utility in sbin/drvctl build directory. 82 8320080503: 84 The <bsd.lib.mk> variable MKPRIVATELIB was renamed to LIBISPRIVATE. 85 8620080521: 87 For a while, unprivileged UPDATE builds would fail to 88 succeed at the checkflist stage, complaining that 89 ${DESTDIR}/stand/<arch>/ did not exist. A fix for this 90 problem was committed to share/mk/bsd.kmodule.mk, revision 1.9. 91 If you already hit this problem, update the .mk file, 92 remove ${DESTDIR}/stand/<arch>, and re-run the build. 93 9420080303: 95 Linker warnings are now fatal if $WARNS>0. 96 9720080126: 98 The posix_fadvise system call has been changed from an assembly 99 stub, to a c file that calls an assembly stub. You need to 100 'rm -f posix_fadvise.* .depend' in the libc build directory to 101 avoid using the old assembly stub. 102 10320071209: 104 The acpiec(4) driver has been split into two attachments. If you 105 get ACPI errors before the attachment, please update your kernel 106 configuration file appropriately or see GENERIC for more details. 107 10820071115: 109 The it(4) driver has been renamed to itesio(4) and the old port 110 argument specified in the kernel configuration file is not valid 111 anymore. The itesio(4) driver now uses the Super I/O address port 112 rather than the EC address port. Please update your kernel 113 configuration file appropriately or see GENERIC for more details. 114 11520071028: 116 The pccons(4) driver has been removed from the NetBSD/shark port. 117 You need to update any custom kernel configuration file you have 118 to remove any references to pccons (which includes removing the 119 now useless XSERVER option) and replace them with the correct 120 entries for the wscons driver. See the GENERIC configuration file 121 for more details. 122 12320070913: 124 A latent bug in dhclient/dhcpd that caused it to be unable to 125 enumerate interfaces was fixed. The bug began to cause 126 problems after 20070911 when the kernel's SIOCGIFCONF 127 implementation was repaired. From 20070529 to 20070911 racoon 128 could not enumerate interfaces. (These are noted because 129 normal kernel/userspace version matching hygiene is not 130 sufficient to avoid this problem.) Ensure that both kernel 131 and userland are from after 20070913. 132 13320070703: 134 nbinstall has been renamed as it calls the target specific and 135 the logic to pass down STRIP from mk been removed. This forces 136 a re-installation of tools. 137 13820070422: 139 The way OS emulations lookup filenames inside the emulation root 140 has been changed. Rather than modify the pathname (and copy back 141 to userspace) namei() and lookup() directly check the emulation 142 root. One side effect is that absolute symlinks inside the emulated 143 root file system will be relative to that file system - unless they 144 start /../ this is useful when the emulated root is a real install 145 that has such links. 146 This might affect symlinks that have been added to reference outside 147 the emulated root. 148 14920070412: 150 The pckbc driver on sgimips IP32 has been removed. Use macekbc 151 instead. See the GENERIC32_IP3x kernel configuration for an 152 example. 153 15420070319: 155 src/lib/libc/Makefile revision 1.129 broke libc and ld.elf_so 156 on many platforms due to incorrect flags settings. If you 157 updated and built after about 20070315, do "nbmake-$arch 158 cleandir" in src/lib/libc and src/libexec/ld.elf_so to force a 159 rebuild of object files that might have been built 160 incorrectly, and ensure that you have at least 161 src/lib/libc/Makefile 1.130. 162 16320070210: 164 src/sys/sys/{sa.h,savar.h} were removed. 165 find ${OBJDIR} \( -name .depend -o -name '*.d' \) -print \ 166 | xargs egrep -l '/sa.h|/savar.h' | xargs rm 167 will allow dependencies on those files to get get rebuilt 168 16920070209: 170 The threading model was changed when the newlock2 branch 171 was merged to NetBSD-current. If you boot with a new 172 kernel (version 4.99.10), then you also need a new pthread 173 library (/usr/lib/libpthread.so.0.7). If you boot with 174 an old kernel, then you need the old pthread library 175 (/usr/lib/libpthread.so.0.6). Provided you keep the kernel and 176 the pthread library in sync, old threaded applications should 177 continue to work with an old or new kernel. Note that named(8) 178 is the only threaded application in the base system. 179 18020061214: 181 Following the move of string_to_flags() and flags_to_string() 182 from the bin/ls/ sources to libutil, users doing UPDATE builds 183 will need to do a "make cleandir" in 184 tools/mtree/, tools/makefs/, tools/binstall/, tools/pax/, 185 bin/pax/, bin/ls/, usr.sbin/mtree/, usr.sbin/makefs/, 186 usr.bin/xinstall/, libexec/ftpd/, rescue/, as well 187 as the installation images in distrib/ 188 in order to excise stale references to the old stat_flags.h header 189 file in the ls sources -- stat_flags.h has been removed. 190 19120061108: 192 The configure script used in the src/tools/gcc compiler has been 193 changed to indicate that our libc has ssp support built-in and 194 does not depend on -lssp and -lssp-nonshared. You'll need to 195 make clean in src/tools/gcc first to rebuild the compiler. 196 19720061009: 198 The sysctl variables net.inet{,6}.tcp{,6}.newreno are no longer 199 available. Use net.inet{,6}.tcp{,6}.congctl.selected instead. 200 20120060814: 202 The vt, vidcconsole, kbd, and rpckbd drivers on acorn32 have been 203 withdrawn. Use vidcvideo and pckbd instead. See the GENERIC 204 kernel configuration for an example. X servers from the last 205 few years should cope. 206 20720060703: 208 MPACPI is no more. We always configure PCI interrupts using ACPI 209 if we have an ACPI kernel. The option MPACPI_SCANPCI has been renamed 210 to ACPI_SCANPCI. Thanks to work from fvdl. 211 21220060627: 213 socket(2) has changed, and its system call has been versioned. 214 For userlands with the old version of socket(2), make sure that 215 your kernel has 'options COMPAT_30' set, or else 'bad system call' 216 errors will result. 217 218Hints for a more successful build: 219^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 220 Use build.sh, but do not use its "expert mode": 221 This will automatically build the tools in the 222 correct order, and it will keep the tools and the 223 new build products from interfering with the running 224 system. This will allow you to ignore most of the 225 other advice in this file. 226 Build a new kernel first: 227 This makes sure that any new system calls or features 228 expected by the new userland will be present. This 229 helps to avoid critical errors when upgrading. 230 Use object directories: 231 This helps to keep stale object 232 files from polluting the build if a Makefile "forgets" 233 about one. It also makes it easier to clean up after 234 a build. It's also necessary if you want to use the 235 same source tree for multiple machines. 236 To use object directories with build.sh: 237 a) invoke build.sh with the "-M" or "-O" options. 238 To use object directories without using build.sh: 239 a) cd /usr/src ; make cleandir 240 b) Add "OBJMACHINE=yes" to /etc/mk.conf 241 c) Add "MKOBJDIRS=yes" to /etc/mk.conf 242 d) cd /usr/src ; make build 243 Note that running "make obj" in a directory will create 244 in obj.$MACHINE directory. 245 Build to a DESTDIR: 246 This helps to keep old installed files (especially libraries) 247 from interfering with the new build. 248 To build to a DESTDIR with build.sh, use the "-D" option. 249 To build to a DESTDIR without using build.sh, set the DESTDIR 250 environment variable before running make build. It should be 251 set to the pathname of an initially empty directory. 252 Problems: if you do not use build.sh, you might need to 253 update critical utilities without using DESTDIR since 254 nothing is executed from what is installed in DESTDIR. 255 (See critical utils, below.) 256 Build often: 257 This keeps critical utilities current enough to not choke 258 on any other part of the source tree that depends on up to 259 date functionality. If you use build.sh, you should not have 260 this problem. 261 262What to do if things don't work: 263^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 264When things don't work there is usually a few things that commonly 265should be done. 266 1) make includes 267 This should be done automatically by make build. 268 2) cd share/mk && make install 269 Again, automatically done by make build. 270 271Failsafe rebuild of a small part of the tree: 272^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 273To make sure you rebuild something correctly you want to do 274something like the following: 275 1) Make sure the includes and .mk files are up to date. 276 2) Make sure any program used to build the particular 277 utility is up to date. (yacc, lex, etc...) 278 3) cd ...path/to/util... 279 make cleandir 280 rm ...all obj directories... 281 make cleandir # yes, again 282 make obj 283 make depend && make 284 285Failsafe rebuild of the entire tree: 286^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 287If you really want to make sure the source tree is clean and 288ready for a build try the following. Note that sourcing /etc/mk.conf 289(a make(1) Makefile) in this manner is not right, and will not work 290for anyone who uses any make(1) features in /etc/mk.conf. 291 292---cut here--- 293#!/bin/sh 294. /etc/mk.conf 295 296if [ -z $NETBSDSRCDIR ] ; then 297 NETBSDSRCDIR=/usr/src 298fi 299if [ \! -d $NETBSDSRCDIR ] ; then 300 echo Unable to find sources 301 exit 1 302fi 303find $NETBSDSRCDIR -name \*.o -o -name obj.\* -o -name obj -exec rm \{\} \; 304 305if [ -z $BSDOBJDIR ] ; then 306 BSDOBJDIR=/usr/obj 307fi 308if [ -d $BSDOBJDIR ] ; then 309 rm -rf $BSDOBJDIR 310fi 311 312cd $NETBSDSRCDIR && make cleandir 313 314---cut here--- 315 316Critical utilities: 317^^^^^^^^^^^^^^^^^^^ 318 usr.bin/compile_et 319 usr.bin/make 320 usr.bin/yacc 321 usr.bin/lex 322 usr.bin/xlint 323 usr.bin/config 324 325Other problems and possible solutions: 326^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 327Symptom:Complaints involving a Makefile. 328Fix: Rebuild usr.bin/make: 329 cd usr.bin/make && make && make install 330 Or, a failsafe method if that doesn't work: 331 cd usr.bin/make && cc *.c */*.c -I . -o make && mv make /usr/bin 332 333Fix: Make sure .mk files are up to date. 334 cd share/mk && make install 335 336Symptom:Kernel `config' fails to configure any kernel, including GENERIC. 337Fix: Rebuild usr.bin/config 338 339Symptom: 340Fix: Rebuild usr.bin/yacc 341 342Symptom: 343Fix: Rebuild usr.bin/lex 344 345Symptom: 346Fix: rm /usr/lib/libbfd.a 347 348Symptom:Obsolete intermediate files are used during compilation 349Fix: Try the following sequence of commands in the directory in question. 350 make cleandir; rm `make print-objdir`; make cleandir; make obj 351 (If you built the tree without "make obj" in the past, obsolete files 352 may remain. The command tries to clean everything up) 353 354Symptom:.../sysinst/run.c:xx: warning: initialization from incompatible pointer type 355Fix: Rebuild and install usr.bin/menuc 356 357Symptom:mklocale not found during build in share/locale/ctype 358Fix: Build and install usr.bin/mklocale 359 360Symptom:undefined reference to `__assert13' or `__unsetenv13' 361Fix: Rebuild and install lib/libc 362 363Symptom:usr.bin/config fails to build. 364Fix: Try building with -DMAKE_BOOTSTRAP added to CFLAGS in Makefile. 365 366Symptom:undefined reference to `getprogname' or `setprogname' 367Fix: Rebuild and install lib/libc 368 369Symptom:lint does not understand the '-X' option 370Fix: May need to build & install libs with NOLINT=1 before rebuilding lint 371