1$NetBSD: UPDATING,v 1.214 2010/06/09 17:29:15 dholland 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 1920100604: 20 The update of ATF to 0.9 causes old tests written in shell to fail 21 unless they are rebuilt. If you are building with MKUPDATE=yes, 22 you need to clean the src/external/bsd/atf/tests/ and the src/tests/ 23 trees by hand. 24 2520100522: 26 Recent Xorg updates in xsrc/external/mit/ will cause various build 27 problems. Delete your entire DESTDIR and OBJDIR if you have any 28 build problems with xsrc. 29 3020100522: 31 private section of <ctype.h> was splitted, and now mklocale(1) 32 include ctype_local.h, so you have to make cleandir in tools/mklocale. 33 3420100520: 35 The location of the xkb compiled descriptions has changed. Please 36 remove usr/X11R7/lib/X11/xkb/compiled from your $DESTDIR. 37 3820100222: 39 The shared objects file extension has been changed from .so to 40 .pico, in order to avoid conflicts with shared libraries names 41 libXX.so. All now stale regular .so files can be removed from 42 your object directories. 43 4420100204: 45 The termcap database has been removed from the sources, 46 but has not been marked obsolete so it is not removed 47 from the system when upgrading. 48 As such, you will need to remove them from your object 49 and destination directories. 50 5120091101: 52 After updating, it may be necessary to make the 'cleandir' 53 target in src/tools/yacc/ and in src/usr.bin/yacc/ before a 54 'build.sh -u tools' or 'build.sh -u distribution'. Ditto 55 src/tools/lex/ and src/usr.bin/lex/. 56 5720091001: 58 On amd64 you must rebuild tools (to get the new binutils) 59 before building a kernel, or the build fails on cpufunc.S. 60 6120091001: 62 An error will create a ./usr/X11R7/lib/X11/xkb/compiled/xkb 63 symlink, failing the build. Delete the link, and the subdir 64 it is in, and retry your build. 65 6620090718: 67 libc build changed so that strchr() provides the extra entry 68 point for index(). Update build of libc.a (and libc_pic.a) 69 may fail because the archive contains the unwanted index.o. 70 (Similarly for strrchr() and rindex().) 71 7220090709: 73 Native Xorg was upgraded again. Builds will probably fail again 74 without a clean objdir, at least for src/external/mit/xorg. 75 7620090616: 77 Native Xorg was upgraded. Builds will need a clean objdir for 78 src/external/mit/xorg. Upgrading a system from sets will not 79 work properly yet as the /usr/X11R7/lib/X11/xkb/symbols/pc 80 subdirectory has been changed into a file, and this needs to 81 be manually "rm -r"'ed before installing xbase.tgz. 82 8320090501: 84 Several new functions were added to string.h/libc, and this 85 can cause autoconf problems during the tool build for people 86 who fail to clean out their tools objects properly. If you 87 note messages about stpcpy, stpncpy or strnlen accompanying a 88 failure during the tool build, clean out all your tools 89 objects and start again. 90 9120090325: 92 The i386 port was switched to i486 default toolchain. This requires 93 cleaning your src/tools directory and $TOOLDIR and rebuilding them. 94 9520090126: 96 The __posix_fadvise50 system call changed assembly stub type. You 97 need to 'rm -f __posix_fadvise50.*' in the libc build directory 98 to avoid using the old assembly stub. 99 10020090202: 101 pkg_install now depends on the pkgdb cache for automatic conflict 102 detection. It is recommented to rebuild the cache with 103 ``pkg_admin rebuild''. 104 10520090110: 106 time_t and dev_t have been bumped to 64 bit quantities. To upgrade: 107 1. Make sure your kernel has COMPAT_50 in it. Build and install. 108 This is needed even in the MODULAR kernel because there is 109 conditionally compiled code in rtsock.c. 110 2. make sure build.sh completes and the binaries in a chroot work 111 before installing. 112 3. If you don't use build.sh and you build directly to root, and 113 your build breaks in the middle, don't despair. Make sure headers 114 are installed properly, and start building libraries first libc 115 and libutil, install them and then continue building all the 116 libraries in src/lib and src/gnu/lib and install them. Once 117 the new libraries are installed, you can restart the build. 118 4. If you compile packages and you notice link time warnings, 119 rebuild the required packages to update their shared libraries. 120 Any package you rebuild will require rebuilding all the packages 121 that depend on it. 122 5. Next time you run pwd_mkdb with the new binary, the file 123 will be upgraded and it will not be backwards compatible. 124 6. The utmpx/wtmpx files (/var/run/utmpx and /var/log/wtmpx, see 125 lastlogx(5)) have been versioned, and there is a heuristic 126 for utmp. You are better off removing the old files after 127 upgrading. The automated clearing of /var/run during 128 boot, and the automated rotating of files in /var/log by 129 newsyslog(8), may mean that you do not have to remove the 130 files manually. 131 7. The optional accounting file (/var/account/acct, see 132 accton(8)) has not been versioned, and will need to be 133 removed. The automatic rotation of the accounting file by 134 /etc/daily limits the bad consequences of failure to remove 135 the file. 136 8. Application software that writes time_t to binary files on 137 disk will break or need attention. Most notably: if you are 138 using PostgreSQL < 8.4, you need to dump your databases, 139 rebuild PostgreSQL with the new time_t, then restore. 140 14120081219: 142 config(1) has been updated, and one of the files it creates - 143 swapnetbsd.o - has changed format. You need to rebuild config 144 (done automatically by build.sh) and then you need to rerun 145 config on all kernel configuration files before rebuilding those 146 kernels. 147 14820081205: 149 If you build with MKX11=no, you should remove /etc/rc.d/xdm and 150 /etc/rc.d/xfs from DESTDIR because those files were moved to the xetc 151 set and will appear as extra files for MKX11=no update builds. 152 15320081122: 154 On i386, various kernel options(4) in GENERIC including 155 file systems have been disabled and moved into kernel modules. 156 Before trying a new GENERIC kernel, you have to prepare the 157 following files as well as a new GENERIC kernel: 158 159 - build and install kernel modules from src/sys/modules 160 161 - install the latest bootloader, which will load a module 162 for the file system from which the kernel is loaded automatically 163 164 If you have to load your kernel from a file system which is not of 165 the same type as the root file system, you have to load the necessary 166 file system module manually on the boot prompt or in the boot.cfg file. 167 16820080827: 169 If you built and installed a libc from sources between 170 2008/08/20 and 2008/08/26 you got a broken strtouq(3) 171 which results in false errors reported by lint(1). 172 Since this breaks the libc build itself, manual help is 173 needed -- lint must be disabled temporarily, e.g.: 174 $ (cd lib/libc && make MKLINT=no dependall install) 175 17620080813: 177 MKDEBUG build was broken because the .depend files did not know 178 about .go files. You need to remove all .depend files and rebuild. 179 18020080802: 181 A regression in binary compatibility for pthread_mutex_t has 182 been fixed. Unfortunately, the price is breaking compatibility 183 for -current. 184 185 Threaded programs (using libpthread) and C++ programs (using 186 libstdc++) compiled after 20070907 and before 20080802 need to 187 be recompiled. 188 189 One way to find affected pkgsrc packages: 190 191 $ grep REQUIRES=/usr/lib/libpthread /var/db/pkg/*/+BUILD_INFO 192 $ grep REQUIRES=/usr/lib/libstdc++ /var/db/pkg/*/+BUILD_INFO 193 19420080731: 195 WAPBL (metadata journaling support) has been added, but at this 196 time isn't backwards compatible with pre-WAPBL aware kernels 197 and userland (fsck_ffs in particular). Please make sure you 198 don't use a journaled filesystem with an older kernel/userland, 199 especially an uncleanly mounted journaled filesystem. WAPBL 200 also requires the super block to be in the UFS2 format. You 201 can use fsck_ffs -c 4 to update the superblock format. 202 20320080721: 204 Assembler warnings are now fatal if $WARNS>0 and $NOGCCERROR 205 isn't defined. 206 20720080531: 208 The ioctl number of DRVSUSPENDDEV command on /dev/drvctl changed 209 from 125 (conflicted with DRVCTLCOMMAND) to 129. The drvctl(8) 210 utility needs to be rebuilt and reinstalled as older binaries 211 won't work correctly. The following sequence of commands: 212 213 $ (cd sys/sys/ && nbmake-$arch includes) 214 $ (cd sbin/drvctl/ && nbmake-$arch clean) 215 $ (cd sbin/drvctl/ && nbmake-$arch all) 216 217 leaves new drvctl utility in sbin/drvctl build directory. 218 21920080503: 220 The <bsd.lib.mk> variable MKPRIVATELIB was renamed to LIBISPRIVATE. 221 22220080521: 223 For a while, unprivileged UPDATE builds would fail to 224 succeed at the checkflist stage, complaining that 225 ${DESTDIR}/stand/<arch>/ did not exist. A fix for this 226 problem was committed to share/mk/bsd.kmodule.mk, revision 1.9. 227 If you already hit this problem, update the .mk file, 228 remove ${DESTDIR}/stand/<arch>, and re-run the build. 229 23020080303: 231 Linker warnings are now fatal if $WARNS>0. 232 23320080126: 234 The posix_fadvise system call has been changed from an assembly 235 stub, to a c file that calls an assembly stub. You need to 236 'rm -f posix_fadvise.* .depend' in the libc build directory to 237 avoid using the old assembly stub. 238 23920071209: 240 The acpiec(4) driver has been split into two attachments. If you 241 get ACPI errors before the attachment, please update your kernel 242 configuration file appropriately or see GENERIC for more details. 243 24420071115: 245 The it(4) driver has been renamed to itesio(4) and the old port 246 argument specified in the kernel configuration file is not valid 247 anymore. The itesio(4) driver now uses the Super I/O address port 248 rather than the EC address port. Please update your kernel 249 configuration file appropriately or see GENERIC for more details. 250 25120071028: 252 The pccons(4) driver has been removed from the NetBSD/shark port. 253 You need to update any custom kernel configuration file you have 254 to remove any references to pccons (which includes removing the 255 now useless XSERVER option) and replace them with the correct 256 entries for the wscons driver. See the GENERIC configuration file 257 for more details. 258 25920070913: 260 A latent bug in dhclient/dhcpd that caused it to be unable to 261 enumerate interfaces was fixed. The bug began to cause 262 problems after 20070911 when the kernel's SIOCGIFCONF 263 implementation was repaired. From 20070529 to 20070911 racoon 264 could not enumerate interfaces. (These are noted because 265 normal kernel/userspace version matching hygiene is not 266 sufficient to avoid this problem.) Ensure that both kernel 267 and userland are from after 20070913. 268 26920070703: 270 nbinstall has been renamed ${MACHINE_GNU_ARCH}-install. It 271 calls the target-specific strip program, and the logic to pass 272 down STRIP from make has been removed. This requires a 273 re-installation of tools. 274 27520070422: 276 The way OS emulations lookup filenames inside the emulation root 277 has been changed. Rather than modify the pathname (and copy back 278 to userspace) namei() and lookup() directly check the emulation 279 root. One side effect is that absolute symlinks inside the emulated 280 root file system will be relative to that file system - unless they 281 start /../ this is useful when the emulated root is a real install 282 that has such links. 283 This might affect symlinks that have been added to reference outside 284 the emulated root. 285 28620070412: 287 The pckbc driver on sgimips IP32 has been removed. Use macekbc 288 instead. See the GENERIC32_IP3x kernel configuration for an 289 example. 290 29120070319: 292 src/lib/libc/Makefile revision 1.129 broke libc and ld.elf_so 293 on many platforms due to incorrect flags settings. If you 294 updated and built after about 20070315, do "nbmake-$arch 295 cleandir" in src/lib/libc and src/libexec/ld.elf_so to force a 296 rebuild of object files that might have been built 297 incorrectly, and ensure that you have at least 298 src/lib/libc/Makefile 1.130. 299 30020070210: 301 src/sys/sys/{sa.h,savar.h} were removed. 302 find ${OBJDIR} \( -name .depend -o -name '*.d' \) -print \ 303 | xargs egrep -l '/sa.h|/savar.h' | xargs rm 304 will allow dependencies on those files to get get rebuilt 305 30620070209: 307 The threading model was changed when the newlock2 branch 308 was merged to NetBSD-current. If you boot with a new 309 kernel (version 4.99.10), then you also need a new pthread 310 library (/usr/lib/libpthread.so.0.7). If you boot with 311 an old kernel, then you need the old pthread library 312 (/usr/lib/libpthread.so.0.6). Provided you keep the kernel and 313 the pthread library in sync, old threaded applications should 314 continue to work with an old or new kernel. Note that named(8) 315 is the only threaded application in the base system. 316 31720061214: 318 Following the move of string_to_flags() and flags_to_string() 319 from the bin/ls/ sources to libutil, users doing UPDATE builds 320 will need to do a "make cleandir" in 321 tools/mtree/, tools/makefs/, tools/binstall/, tools/pax/, 322 bin/pax/, bin/ls/, usr.sbin/mtree/, usr.sbin/makefs/, 323 usr.bin/xinstall/, libexec/ftpd/, rescue/, as well 324 as the installation images in distrib/ 325 in order to excise stale references to the old stat_flags.h header 326 file in the ls sources -- stat_flags.h has been removed. 327 32820061108: 329 The configure script used in the src/tools/gcc compiler has been 330 changed to indicate that our libc has ssp support built-in and 331 does not depend on -lssp and -lssp-nonshared. You'll need to 332 make clean in src/tools/gcc first to rebuild the compiler. 333 33420061009: 335 The sysctl variables net.inet{,6}.tcp{,6}.newreno are no longer 336 available. Use net.inet{,6}.tcp{,6}.congctl.selected instead. 337 33820060814: 339 The vt, vidcconsole, kbd, and rpckbd drivers on acorn32 have been 340 withdrawn. Use vidcvideo and pckbd instead. See the GENERIC 341 kernel configuration for an example. X servers from the last 342 few years should cope. 343 34420060703: 345 MPACPI is no more. We always configure PCI interrupts using ACPI 346 if we have an ACPI kernel. The option MPACPI_SCANPCI has been renamed 347 to ACPI_SCANPCI. Thanks to work from fvdl. 348 34920060627: 350 socket(2) has changed, and its system call has been versioned. 351 For userlands with the old version of socket(2), make sure that 352 your kernel has 'options COMPAT_30' set, or else 'bad system call' 353 errors will result. 354 355Hints for a more successful build: 356^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 357 Use build.sh, but do not use its "expert mode": 358 This will automatically build the tools in the 359 correct order, and it will keep the tools and the 360 new build products from interfering with the running 361 system. This will allow you to ignore most of the 362 other advice in this file. 363 Build a new kernel first: 364 This makes sure that any new system calls or features 365 expected by the new userland will be present. This 366 helps to avoid critical errors when upgrading. 367 Use object directories: 368 This helps to keep stale object 369 files from polluting the build if a Makefile "forgets" 370 about one. It also makes it easier to clean up after 371 a build. It's also necessary if you want to use the 372 same source tree for multiple machines. 373 To use object directories with build.sh: 374 a) invoke build.sh with the "-M" or "-O" options. 375 To use object directories without using build.sh: 376 a) cd /usr/src ; make cleandir 377 b) Add "OBJMACHINE=yes" to /etc/mk.conf 378 c) Add "MKOBJDIRS=yes" to /etc/mk.conf 379 d) cd /usr/src ; make build 380 Note that running "make obj" in a directory will create 381 in obj.$MACHINE directory. 382 Build to a DESTDIR: 383 This helps to keep old installed files (especially libraries) 384 from interfering with the new build. 385 To build to a DESTDIR with build.sh, use the "-D" option. 386 To build to a DESTDIR without using build.sh, set the DESTDIR 387 environment variable before running make build. It should be 388 set to the pathname of an initially empty directory. 389 Problems: if you do not use build.sh, you might need to 390 update critical utilities without using DESTDIR since 391 nothing is executed from what is installed in DESTDIR. 392 (See critical utils, below.) 393 Build often: 394 This keeps critical utilities current enough to not choke 395 on any other part of the source tree that depends on up to 396 date functionality. If you use build.sh, you should not have 397 this problem. 398 399What to do if things don't work: 400^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 401When things don't work there is usually a few things that commonly 402should be done. 403 1) make includes 404 This should be done automatically by make build. 405 2) cd share/mk && make install 406 Again, automatically done by make build. 407 408Failsafe rebuild of a small part of the tree: 409^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 410To make sure you rebuild something correctly you want to do 411something like the following: 412 1) Make sure the includes and .mk files are up to date. 413 2) Make sure any program used to build the particular 414 utility is up to date. (yacc, lex, etc...) 415 3) cd ...path/to/util... 416 make cleandir 417 rm ...all obj directories... 418 make cleandir # yes, again 419 make obj 420 make depend && make 421 422Failsafe rebuild of the entire tree: 423^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 424If you really want to make sure the source tree is clean and 425ready for a build try the following. Note that sourcing /etc/mk.conf 426(a make(1) Makefile) in this manner is not right, and will not work 427for anyone who uses any make(1) features in /etc/mk.conf. 428 429---cut here--- 430#!/bin/sh 431. /etc/mk.conf 432 433if [ -z $NETBSDSRCDIR ] ; then 434 NETBSDSRCDIR=/usr/src 435fi 436if [ \! -d $NETBSDSRCDIR ] ; then 437 echo Unable to find sources 438 exit 1 439fi 440find $NETBSDSRCDIR -name \*.o -o -name obj.\* -o -name obj -exec rm \{\} \; 441 442if [ -z $BSDOBJDIR ] ; then 443 BSDOBJDIR=/usr/obj 444fi 445if [ -d $BSDOBJDIR ] ; then 446 rm -rf $BSDOBJDIR 447fi 448 449cd $NETBSDSRCDIR && make cleandir 450 451---cut here--- 452 453Critical utilities: 454^^^^^^^^^^^^^^^^^^^ 455 usr.bin/compile_et 456 usr.bin/make 457 usr.bin/yacc 458 usr.bin/lex 459 usr.bin/xlint 460 usr.bin/config 461 462Other problems and possible solutions: 463^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 464Symptom:Complaints involving a Makefile. 465Fix: Rebuild usr.bin/make: 466 cd usr.bin/make && make && make install 467 Or, a failsafe method if that doesn't work: 468 cd usr.bin/make && cc *.c */*.c -I . -o make && mv make /usr/bin 469 470Fix: Make sure .mk files are up to date. 471 cd share/mk && make install 472 473Symptom:Kernel `config' fails to configure any kernel, including GENERIC. 474Fix: Rebuild usr.bin/config 475 476Symptom: 477Fix: Rebuild usr.bin/yacc 478 479Symptom: 480Fix: Rebuild usr.bin/lex 481 482Symptom: 483Fix: rm /usr/lib/libbfd.a 484 485Symptom:Obsolete intermediate files are used during compilation 486Fix: Try the following sequence of commands in the directory in question. 487 make cleandir; rm `make print-objdir`; make cleandir; make obj 488 (If you built the tree without "make obj" in the past, obsolete files 489 may remain. The command tries to clean everything up) 490 491Symptom:.../sysinst/run.c:xx: warning: initialization from incompatible 492 pointer type 493Fix: Rebuild and install usr.bin/menuc 494 495Symptom:mklocale not found during build in share/locale/ctype 496Fix: Build and install usr.bin/mklocale 497 498Symptom:undefined reference to `__assert13' or `__unsetenv13' 499Fix: Rebuild and install lib/libc 500 501Symptom:usr.bin/config fails to build. 502Fix: Try building with -DMAKE_BOOTSTRAP added to CFLAGS in Makefile. 503 504Symptom:undefined reference to `getprogname' or `setprogname' 505Fix: Rebuild and install lib/libc 506 507Symptom:lint does not understand the '-X' option 508Fix: May need to build & install libs with NOLINT=1 before rebuilding lint 509