1$NetBSD: UPDATING,v 1.234.2.4 2012/09/30 18:47:58 bouyer 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 1920120813: 20 The update of openssl requires cleaning both the openssl build 21 directory and DESTDIR. *Even non-update builds require cleaning 22 DESTDIR.* Builds done without taking these steps may fail, or in 23 some cases may succeed and install broken openssl libraries that 24 cause third-party software to link incorrectly and/or crash. 25 2620120216: 27 Default for MKCATPAGES changed to NO. Update builds will fail 28 unless DESTDIR is cleaned manually. If you built between 20120207 29 and 20120216, daily and weekly could have created an unreadable 30 /var/db/man.db index for apropos. Running makemandb -f or 31 the next run of weekly will fix it. 32 3320111227: 34 If you built between 20111225 and 20111227 you need to remove 35 /usr/lib/libpam.so.4* and /usr/lib/security/*.so.4, since the 36 bump has been reverted. 37 3820111125: 39 The "rnd" pseudodevice has been added to sys/conf/std, which 40 means it should no longer be explicitly listed in kernel 41 configuration files. The line "pseudo-device rnd" should be 42 removed from any custom kernel config files users may have. 43 4420111119: 45 A problem with the datastructures used by the rndctl(8) 46 utility (pointers in datastructures in an array, making 32->64 47 bit compatibility very painful) has been fixed in a 48 non-backwards-compatible way. If you replace your kernel, 49 replace your rndctl executable too. 50 5120111001: 52 the prop_*_send_syscall() functions from proplib(3) have been 53 changed and their new version is not backward compatible with the old 54 one. So ensure that all consumers of these functions (currently: 55 quota2 code and its tests) are updated together with the new lib. 56 5720110817: 58 sparc has been changed to use GCC 4.5.3, so any objdir or 59 DESTDIR for them should be deleted before updating. 60 6120110806: 62 i386 and amd64 have been changed to use GCC 4.5.3, so any 63 objdir or DESTDIR for them should be deleted before updating. 64 6520110805: 66 The update to GCC 4.5.3 requires a non-trivial portion of 67 the tree to be cleaned. Best to delete both objdir and 68 DESTDIR before running this update. So far, only the 69 sparc64, mips and powerpc platforms have changed. 70 7120110803: 72 The layout of external/public-domain/xz has changed. To do an 73 update build you will have to remove the contents of the OBJDIR 74 for external/public-domain/xz/bin by hand as the xz entry there 75 is now a directory. 76 7720110410: 78 The configuration of src/tools/gcc has changed. To do an 79 update build you have to clean both tools/binutils and 80 tools/gcc by hand. 81 8220110328: 83 Building the Xorg binary was moved into a subdirectory to fix 84 ordering issues with "make all". It may be necessary to remove 85 the OBJDIR for external/mit/xorg/server/xorg-server/hw/xfree86 86 if your update build fails, as the "Xorg" entry there is now a 87 directory. 88 8920110121: 90 Assembler files no longer use -traditional-cpp. This can break 91 the build of individual parts of the tree. This is handled 92 correctly by build.sh. Manual builds have to update /usr/share/mk 93 and re-run config(1) for any kernel configurations as needed. 94 9520101217: 96 The tcpdump(8) program was changed to drop privileges and chroot(2) 97 by default. It may be necessary to manually update passwd(5) and 98 group(5) in order to make the program work with existing setups. 99 10020101125: 101 The latest changes to setenv(3) dissallow setting environment 102 variables with names that contain '='. Revision 1.18 of env.c 103 assumed that this was allowed. Installing a new libc with an 104 old copy of /usr/bin/env causes env x=1 printenv | grep x= to 105 break which affects the autoconf tests for dependency finding, 106 so building gcc will end up printing: 107 checking dependency style of gcc... none 108 configure: error: no usable dependency style found 109 Fix it by rebuilding and re-installing env. 110 11120101119: 112 Recent Xorg updates in xsrc/external/mit/ may cause various build 113 or run-time problems. Delete your entire DESTDIR and OBJDIR if you 114 have any build problems with xsrc, or problems with mismatched 115 versions between xorg-server and drivers. 116 11720100604: 118 The update of ATF to 0.9 causes old tests written in shell to fail 119 unless they are rebuilt. If you are building with MKUPDATE=yes, 120 you need to clean the src/external/bsd/atf/tests/ and the src/tests/ 121 trees by hand. 122 12320100522: 124 Recent Xorg updates in xsrc/external/mit/ will cause various build 125 problems. Delete your entire DESTDIR and OBJDIR if you have any 126 build problems with xsrc. 127 12820100522: 129 private section of <ctype.h> was splitted, and now mklocale(1) 130 include ctype_local.h, so you have to make cleandir in tools/mklocale. 131 13220100520: 133 The location of the xkb compiled descriptions has changed. Please 134 remove usr/X11R7/lib/X11/xkb/compiled from your $DESTDIR. 135 13620100222: 137 The shared objects file extension has been changed from .so to 138 .pico, in order to avoid conflicts with shared libraries names 139 libXX.so. All now stale regular .so files can be removed from 140 your object directories. 141 14220100204: 143 The termcap database has been removed from the sources, 144 but has not been marked obsolete so it is not removed 145 from the system when upgrading. 146 As such, you will need to remove them from your object 147 and destination directories. 148 14920091101: 150 After updating, it may be necessary to make the 'cleandir' 151 target in src/tools/yacc/ and in src/usr.bin/yacc/ before a 152 'build.sh -u tools' or 'build.sh -u distribution'. Ditto 153 src/tools/lex/ and src/usr.bin/lex/. 154 15520091001: 156 On amd64 you must rebuild tools (to get the new binutils) 157 before building a kernel, or the build fails on cpufunc.S. 158 15920091001: 160 An error will create a ./usr/X11R7/lib/X11/xkb/compiled/xkb 161 symlink, failing the build. Delete the link, and the subdir 162 it is in, and retry your build. 163 16420090718: 165 libc build changed so that strchr() provides the extra entry 166 point for index(). Update build of libc.a (and libc_pic.a) 167 may fail because the archive contains the unwanted index.o. 168 (Similarly for strrchr() and rindex().) 169 17020090709: 171 Native Xorg was upgraded again. Builds will probably fail again 172 without a clean objdir, at least for src/external/mit/xorg. 173 17420090616: 175 Native Xorg was upgraded. Builds will need a clean objdir for 176 src/external/mit/xorg. Upgrading a system from sets will not 177 work properly yet as the /usr/X11R7/lib/X11/xkb/symbols/pc 178 subdirectory has been changed into a file, and this needs to 179 be manually "rm -r"'ed before installing xbase.tgz. 180 18120090501: 182 Several new functions were added to string.h/libc, and this 183 can cause autoconf problems during the tool build for people 184 who fail to clean out their tools objects properly. If you 185 note messages about stpcpy, stpncpy or strnlen accompanying a 186 failure during the tool build, clean out all your tools 187 objects and start again. 188 18920090325: 190 The i386 port was switched to i486 default toolchain. This requires 191 cleaning your src/tools directory and $TOOLDIR and rebuilding them. 192 19320090126: 194 The __posix_fadvise50 system call changed assembly stub type. You 195 need to 'rm -f __posix_fadvise50.*' in the libc build directory 196 to avoid using the old assembly stub. 197 19820090202: 199 pkg_install now depends on the pkgdb cache for automatic conflict 200 detection. It is recommented to rebuild the cache with 201 ``pkg_admin rebuild''. 202 20320090110: 204 time_t and dev_t have been bumped to 64 bit quantities. To upgrade: 205 1. Make sure your kernel has COMPAT_50 in it. Build and install. 206 This is needed even in the MODULAR kernel because there is 207 conditionally compiled code in rtsock.c. 208 2. make sure build.sh completes and the binaries in a chroot work 209 before installing. 210 3. If you don't use build.sh and you build directly to root, and 211 your build breaks in the middle, don't despair. Make sure headers 212 are installed properly, and start building libraries first libc 213 and libutil, install them and then continue building all the 214 libraries in src/lib and src/gnu/lib and install them. Once 215 the new libraries are installed, you can restart the build. 216 4. If you compile packages and you notice link time warnings, 217 rebuild the required packages to update their shared libraries. 218 Any package you rebuild will require rebuilding all the packages 219 that depend on it. 220 5. Next time you run pwd_mkdb with the new binary, the file 221 will be upgraded and it will not be backwards compatible. 222 6. The utmpx/wtmpx files (/var/run/utmpx and /var/log/wtmpx, see 223 lastlogx(5)) have been versioned, and there is a heuristic 224 for utmp. You are better off removing the old files after 225 upgrading. The automated clearing of /var/run during 226 boot, and the automated rotating of files in /var/log by 227 newsyslog(8), may mean that you do not have to remove the 228 files manually. 229 7. The optional accounting file (/var/account/acct, see 230 accton(8)) has not been versioned, and will need to be 231 removed. The automatic rotation of the accounting file by 232 /etc/daily limits the bad consequences of failure to remove 233 the file. 234 8. Application software that writes time_t to binary files on 235 disk will break or need attention. Most notably: if you are 236 using PostgreSQL < 8.4, you need to dump your databases, 237 rebuild PostgreSQL with the new time_t, then restore. 238 23920081219: 240 config(1) has been updated, and one of the files it creates - 241 swapnetbsd.o - has changed format. You need to rebuild config 242 (done automatically by build.sh) and then you need to rerun 243 config on all kernel configuration files before rebuilding those 244 kernels. 245 24620081205: 247 If you build with MKX11=no, you should remove /etc/rc.d/xdm and 248 /etc/rc.d/xfs from DESTDIR because those files were moved to the xetc 249 set and will appear as extra files for MKX11=no update builds. 250 25120081122: 252 On i386, various kernel options(4) in GENERIC including 253 file systems have been disabled and moved into kernel modules. 254 Before trying a new GENERIC kernel, you have to prepare the 255 following files as well as a new GENERIC kernel: 256 257 - build and install kernel modules from src/sys/modules 258 259 - install the latest bootloader, which will load a module 260 for the file system from which the kernel is loaded automatically 261 262 If you have to load your kernel from a file system which is not of 263 the same type as the root file system, you have to load the necessary 264 file system module manually on the boot prompt or in the boot.cfg file. 265 26620080827: 267 If you built and installed a libc from sources between 268 2008/08/20 and 2008/08/26 you got a broken strtouq(3) 269 which results in false errors reported by lint(1). 270 Since this breaks the libc build itself, manual help is 271 needed -- lint must be disabled temporarily, e.g.: 272 $ (cd lib/libc && make MKLINT=no dependall install) 273 27420080813: 275 MKDEBUG build was broken because the .depend files did not know 276 about .go files. You need to remove all .depend files and rebuild. 277 27820080802: 279 A regression in binary compatibility for pthread_mutex_t has 280 been fixed. Unfortunately, the price is breaking compatibility 281 for -current. 282 283 Threaded programs (using libpthread) and C++ programs (using 284 libstdc++) compiled after 20070907 and before 20080802 need to 285 be recompiled. 286 287 One way to find affected pkgsrc packages: 288 289 $ grep REQUIRES=/usr/lib/libpthread /var/db/pkg/*/+BUILD_INFO 290 $ grep REQUIRES=/usr/lib/libstdc++ /var/db/pkg/*/+BUILD_INFO 291 29220080731: 293 WAPBL (metadata journaling support) has been added, but at this 294 time isn't backwards compatible with pre-WAPBL aware kernels 295 and userland (fsck_ffs in particular). Please make sure you 296 don't use a journaled filesystem with an older kernel/userland, 297 especially an uncleanly mounted journaled filesystem. WAPBL 298 also requires the super block to be in the UFS2 format. You 299 can use fsck_ffs -c 4 to update the superblock format. 300 30120080721: 302 Assembler warnings are now fatal if $WARNS>0 and $NOGCCERROR 303 isn't defined. 304 30520080531: 306 The ioctl number of DRVSUSPENDDEV command on /dev/drvctl changed 307 from 125 (conflicted with DRVCTLCOMMAND) to 129. The drvctl(8) 308 utility needs to be rebuilt and reinstalled as older binaries 309 won't work correctly. The following sequence of commands: 310 311 $ (cd sys/sys/ && nbmake-$arch includes) 312 $ (cd sbin/drvctl/ && nbmake-$arch clean) 313 $ (cd sbin/drvctl/ && nbmake-$arch all) 314 315 leaves new drvctl utility in sbin/drvctl build directory. 316 31720080503: 318 The <bsd.lib.mk> variable MKPRIVATELIB was renamed to LIBISPRIVATE. 319 32020080521: 321 For a while, unprivileged UPDATE builds would fail to 322 succeed at the checkflist stage, complaining that 323 ${DESTDIR}/stand/<arch>/ did not exist. A fix for this 324 problem was committed to share/mk/bsd.kmodule.mk, revision 1.9. 325 If you already hit this problem, update the .mk file, 326 remove ${DESTDIR}/stand/<arch>, and re-run the build. 327 32820080303: 329 Linker warnings are now fatal if $WARNS>0. 330 33120080126: 332 The posix_fadvise system call has been changed from an assembly 333 stub, to a c file that calls an assembly stub. You need to 334 'rm -f posix_fadvise.* .depend' in the libc build directory to 335 avoid using the old assembly stub. 336 33720071209: 338 The acpiec(4) driver has been split into two attachments. If you 339 get ACPI errors before the attachment, please update your kernel 340 configuration file appropriately or see GENERIC for more details. 341 34220071115: 343 The it(4) driver has been renamed to itesio(4) and the old port 344 argument specified in the kernel configuration file is not valid 345 anymore. The itesio(4) driver now uses the Super I/O address port 346 rather than the EC address port. Please update your kernel 347 configuration file appropriately or see GENERIC for more details. 348 34920071028: 350 The pccons(4) driver has been removed from the NetBSD/shark port. 351 You need to update any custom kernel configuration file you have 352 to remove any references to pccons (which includes removing the 353 now useless XSERVER option) and replace them with the correct 354 entries for the wscons driver. See the GENERIC configuration file 355 for more details. 356 35720070913: 358 A latent bug in dhclient/dhcpd that caused it to be unable to 359 enumerate interfaces was fixed. The bug began to cause 360 problems after 20070911 when the kernel's SIOCGIFCONF 361 implementation was repaired. From 20070529 to 20070911 racoon 362 could not enumerate interfaces. (These are noted because 363 normal kernel/userspace version matching hygiene is not 364 sufficient to avoid this problem.) Ensure that both kernel 365 and userland are from after 20070913. 366 36720070703: 368 nbinstall has been renamed ${MACHINE_GNU_ARCH}-install. It 369 calls the target-specific strip program, and the logic to pass 370 down STRIP from make has been removed. This requires a 371 re-installation of tools. 372 37320070422: 374 The way OS emulations lookup filenames inside the emulation root 375 has been changed. Rather than modify the pathname (and copy back 376 to userspace) namei() and lookup() directly check the emulation 377 root. One side effect is that absolute symlinks inside the emulated 378 root file system will be relative to that file system - unless they 379 start /../ this is useful when the emulated root is a real install 380 that has such links. 381 This might affect symlinks that have been added to reference outside 382 the emulated root. 383 38420070412: 385 The pckbc driver on sgimips IP32 has been removed. Use macekbc 386 instead. See the GENERIC32_IP3x kernel configuration for an 387 example. 388 38920070319: 390 src/lib/libc/Makefile revision 1.129 broke libc and ld.elf_so 391 on many platforms due to incorrect flags settings. If you 392 updated and built after about 20070315, do "nbmake-$arch 393 cleandir" in src/lib/libc and src/libexec/ld.elf_so to force a 394 rebuild of object files that might have been built 395 incorrectly, and ensure that you have at least 396 src/lib/libc/Makefile 1.130. 397 39820070210: 399 src/sys/sys/{sa.h,savar.h} were removed. 400 find ${OBJDIR} \( -name .depend -o -name '*.d' \) -print \ 401 | xargs egrep -l '/sa.h|/savar.h' | xargs rm 402 will allow dependencies on those files to get get rebuilt 403 40420070209: 405 The threading model was changed when the newlock2 branch 406 was merged to NetBSD-current. If you boot with a new 407 kernel (version 4.99.10), then you also need a new pthread 408 library (/usr/lib/libpthread.so.0.7). If you boot with 409 an old kernel, then you need the old pthread library 410 (/usr/lib/libpthread.so.0.6). Provided you keep the kernel and 411 the pthread library in sync, old threaded applications should 412 continue to work with an old or new kernel. Note that named(8) 413 is the only threaded application in the base system. 414 41520061214: 416 Following the move of string_to_flags() and flags_to_string() 417 from the bin/ls/ sources to libutil, users doing UPDATE builds 418 will need to do a "make cleandir" in 419 tools/mtree/, tools/makefs/, tools/binstall/, tools/pax/, 420 bin/pax/, bin/ls/, usr.sbin/mtree/, usr.sbin/makefs/, 421 usr.bin/xinstall/, libexec/ftpd/, rescue/, as well 422 as the installation images in distrib/ 423 in order to excise stale references to the old stat_flags.h header 424 file in the ls sources -- stat_flags.h has been removed. 425 42620061108: 427 The configure script used in the src/tools/gcc compiler has been 428 changed to indicate that our libc has ssp support built-in and 429 does not depend on -lssp and -lssp-nonshared. You'll need to 430 make clean in src/tools/gcc first to rebuild the compiler. 431 43220061009: 433 The sysctl variables net.inet{,6}.tcp{,6}.newreno are no longer 434 available. Use net.inet{,6}.tcp{,6}.congctl.selected instead. 435 43620060814: 437 The vt, vidcconsole, kbd, and rpckbd drivers on acorn32 have been 438 withdrawn. Use vidcvideo and pckbd instead. See the GENERIC 439 kernel configuration for an example. X servers from the last 440 few years should cope. 441 44220060703: 443 MPACPI is no more. We always configure PCI interrupts using ACPI 444 if we have an ACPI kernel. The option MPACPI_SCANPCI has been renamed 445 to ACPI_SCANPCI. Thanks to work from fvdl. 446 44720060627: 448 socket(2) has changed, and its system call has been versioned. 449 For userlands with the old version of socket(2), make sure that 450 your kernel has 'options COMPAT_30' set, or else 'bad system call' 451 errors will result. 452 453Hints for a more successful build: 454^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 455 Use build.sh, but do not use its "expert mode": 456 This will automatically build the tools in the 457 correct order, and it will keep the tools and the 458 new build products from interfering with the running 459 system. This will allow you to ignore most of the 460 other advice in this file. 461 Build a new kernel first: 462 This makes sure that any new system calls or features 463 expected by the new userland will be present. This 464 helps to avoid critical errors when upgrading. 465 Use object directories: 466 This helps to keep stale object 467 files from polluting the build if a Makefile "forgets" 468 about one. It also makes it easier to clean up after 469 a build. It's also necessary if you want to use the 470 same source tree for multiple machines. 471 To use object directories with build.sh: 472 a) invoke build.sh with the "-M" or "-O" options. 473 To use object directories without using build.sh: 474 a) cd /usr/src ; make cleandir 475 b) Add "OBJMACHINE=yes" to /etc/mk.conf 476 c) Add "MKOBJDIRS=yes" to /etc/mk.conf 477 d) cd /usr/src ; make build 478 Note that running "make obj" in a directory will create 479 in obj.$MACHINE directory. 480 Build to a DESTDIR: 481 This helps to keep old installed files (especially libraries) 482 from interfering with the new build. 483 To build to a DESTDIR with build.sh, use the "-D" option. 484 To build to a DESTDIR without using build.sh, set the DESTDIR 485 environment variable before running make build. It should be 486 set to the pathname of an initially empty directory. 487 Problems: if you do not use build.sh, you might need to 488 update critical utilities without using DESTDIR since 489 nothing is executed from what is installed in DESTDIR. 490 (See critical utils, below.) 491 Build often: 492 This keeps critical utilities current enough to not choke 493 on any other part of the source tree that depends on up to 494 date functionality. If you use build.sh, you should not have 495 this problem. 496 497What to do if things don't work: 498^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 499When things don't work there are usually a few things that commonly 500should be done. 501 1) make includes 502 This should be done automatically by make build. 503 2) cd share/mk && make install 504 Again, automatically done by make build. 505 506Failsafe rebuild of a small part of the tree: 507^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 508To make sure you rebuild something correctly you want to do 509something like the following: 510 1) Make sure the includes and .mk files are up to date. 511 2) Make sure any program used to build the particular 512 utility is up to date. (yacc, lex, etc...) 513 3) cd ...path/to/util... 514 make cleandir 515 rm ...all obj directories... 516 make cleandir # yes, again 517 make obj 518 make depend && make 519 520Failsafe rebuild of the entire tree: 521^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 522If you really want to make sure the source tree is clean and 523ready for a build try the following. Note that sourcing /etc/mk.conf 524(a make(1) Makefile) in this manner is not right, and will not work 525for anyone who uses any make(1) features in /etc/mk.conf. 526 527---cut here--- 528#!/bin/sh 529. /etc/mk.conf 530 531if [ -z $NETBSDSRCDIR ] ; then 532 NETBSDSRCDIR=/usr/src 533fi 534if [ \! -d $NETBSDSRCDIR ] ; then 535 echo Unable to find sources 536 exit 1 537fi 538find $NETBSDSRCDIR -name \*.o -o -name obj.\* -o -name obj -exec rm \{\} \; 539 540if [ -z $BSDOBJDIR ] ; then 541 BSDOBJDIR=/usr/obj 542fi 543if [ -d $BSDOBJDIR ] ; then 544 rm -rf $BSDOBJDIR 545fi 546 547cd $NETBSDSRCDIR && make cleandir 548 549---cut here--- 550 551Critical utilities: 552^^^^^^^^^^^^^^^^^^^ 553 usr.bin/compile_et 554 usr.bin/make 555 usr.bin/yacc 556 usr.bin/lex 557 usr.bin/xlint 558 usr.bin/config 559 560Other problems and possible solutions: 561^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 562Symptom:Complaints involving a Makefile. 563Fix: Rebuild usr.bin/make: 564 cd usr.bin/make && make && make install 565 Or, a failsafe method if that doesn't work: 566 cd usr.bin/make && cc *.c */*.c -I . -o make && mv make /usr/bin 567 568Fix: Make sure .mk files are up to date. 569 cd share/mk && make install 570 571Symptom:Kernel `config' fails to configure any kernel, including GENERIC. 572Fix: Rebuild usr.bin/config 573 574Symptom: 575Fix: Rebuild usr.bin/yacc 576 577Symptom: 578Fix: Rebuild usr.bin/lex 579 580Symptom: 581Fix: rm /usr/lib/libbfd.a 582 583Symptom:Obsolete intermediate files are used during compilation 584Fix: Try the following sequence of commands in the directory in question. 585 make cleandir; rm `make print-objdir`; make cleandir; make obj 586 (If you built the tree without "make obj" in the past, obsolete files 587 may remain. The command tries to clean everything up) 588 589Symptom:.../sysinst/run.c:xx: warning: initialization from incompatible 590 pointer type 591Fix: Rebuild and install usr.bin/menuc 592 593Symptom:mklocale not found during build in share/locale/ctype 594Fix: Build and install usr.bin/mklocale 595 596Symptom:undefined reference to `__assert13' or `__unsetenv13' 597Fix: Rebuild and install lib/libc 598 599Symptom:usr.bin/config fails to build. 600Fix: Try building with -DMAKE_BOOTSTRAP added to CFLAGS in Makefile. 601 602Symptom:undefined reference to `getprogname' or `setprogname' 603Fix: Rebuild and install lib/libc 604 605Symptom:lint does not understand the '-X' option 606Fix: May need to build & install libs with NOLINT=1 before rebuilding lint 607 608Symptom:Update build fails in src/tools/gcc complaining that a variable 609 (e.g. CPPFLAGS) has changed since the previous run. 610Fix: Run "nbmake-${ARCH} clean" in src/tools/gcc or do a clean build. 611