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