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