UPDATING revision 160710
1Updating Information for FreeBSD current users 2 3This file is maintained and copyrighted by M. Warner Losh 4<imp@village.org>. See end of file for further details. For commonly 5done items, please see the COMMON ITEMS: section later in the file. 6 7Items affecting the ports and packages system can be found in 8/usr/ports/UPDATING. Please read that file before running 9portupgrade. 10 11NOTE TO PEOPLE WHO THINK THAT FreeBSD 7.x IS SLOW: 12 FreeBSD 7.x has many debugging features turned on, in 13 both the kernel and userland. These features attempt to detect 14 incorrect use of system primitives, and encourage loud failure 15 through extra sanity checking and fail stop semantics. They 16 also substantially impact system performance. If you want to 17 do performance measurement, benchmarking, and optimization, 18 you'll want to turn them off. This includes various WITNESS- 19 related kernel options, INVARIANTS, malloc debugging flags 20 in userland, and various verbose features in the kernel. Many 21 developers choose to disable these features on build machines 22 to maximize performance. 23 2420060725: 25 enigma(1)/crypt(1) utility has been changed on 64 bit architectures. 26 Now it can decrypt files created from different architectures. 27 Unfortunately, it is no longer able to decrypt a cipher text 28 generated with an older version on 64 bit architectures. 29 If you have such a file, you need old utility to decrypt it. 30 3120060709: 32 The interface version of the i4b kernel part has changed. So 33 after updating the kernel sources and compiling a new kernel, 34 the i4b user space tools in "/usr/src/usr.sbin/i4b" must also 35 be rebuilt, and vice versa. 36 3720060627: 38 The XBOX kernel now defaults to the nfe(4) driver instead of 39 the nve(4) driver. Please update your configuration 40 accordingly. 41 4220060511: 43 The machdep.* sysctls and the adjkerntz utility have been 44 modified a bit. The new adjkerntz utility uses the new 45 sysctl names and sysctlbyname() calls, so it may be impossible 46 to run an old /sbin/adjkerntz utility in single-user mode 47 with a new kernel. Replace the `adjkerntz -i' step before 48 `make installworld' with: 49 50 /usr/obj/usr/src/sbin/adjkerntz/adjkerntz -i 51 52 and proceed as usual with the rest of the installworld-stage 53 steps. Otherwise, you risk installing binaries with their 54 timestamp set several hours in the future, especially if 55 you are running with local time set to GMT+X hours. 56 5720060412: 58 The ip6fw utility has been removed. The behavior provided by 59 ip6fw has been in ipfw2 for a good while and the rc.d scripts 60 have been updated to deal with it. There are some rules that 61 might not migrate cleanly. Use rc.firewall6 as a template to 62 rewrite rules. 63 6420060428: 65 The puc(4) driver has been overhauled. The ebus(4) and sbus(4) 66 attachments have been removed. Make sure to configure scc(4) 67 on sparc64. Note also that by default puc(4) will use uart(4) 68 and not sio(4) for serial ports because interrupt handling has 69 been optimized for multi-port serial cards and only uart(4) 70 implements the interface to support it. 71 7220060330: 73 The scc(4) driver replaces puc(4) for Serial Communications 74 Controllers (SCCs) like the Siemens SAB82532 and the Zilog 75 Z8530. On sparc64, it is advised to add scc(4) to the kernel 76 configuration to make sure that the serial ports remain 77 functional. 78 7920060317: 80 Most world/kernel related NO_* build options changed names. 81 New knobs have common prefixes WITHOUT_*/WITH_* (modelled 82 after FreeBSD ports) and should be set in /etc/src.conf 83 (the src.conf(5) manpage is provided). Full backwards 84 compatibility is maintained for the time being though it's 85 highly recommended to start moving old options out of the 86 system-wide /etc/make.conf file into the new /etc/src.conf 87 while also properly renaming them. More conversions will 88 likely follow. Posting to current@: 89 90 http://lists.freebsd.org/pipermail/freebsd-current/2006-March/061725.html 91 9220060305: 93 The NETSMBCRYPTO kernel option has been retired because its 94 functionality is always included in NETSMB and smbfs.ko now. 95 9620060303: 97 The TDFX_LINUX kernel option was retired and replaced by the 98 tdfx_linux device. The latter can be loaded as the 3dfx_linux.ko 99 kernel module. Loading it alone should suffice to get 3dfx support 100 for Linux apps because it will pull in 3dfx.ko and linux.ko through 101 its dependencies. 102 10320060204: 104 The 'audit' group was added to support the new auditing functionality 105 in the base system. Be sure to follow the directions for updating, 106 including the requirement to run mergemaster -p. 107 10820060201: 109 The kernel ABI to file system modules was changed on i386. 110 Please make sure that your kernel and modules are in sync. 111 11220060118: 113 This actually occured some time ago, but installing the kernel 114 now also installs a bunch of symbol files for the kernel modules. 115 This increases the size of /boot/kernel to about 67Mbytes. You 116 will need twice this if you will eventually back this up to kernel.old 117 on your next install. 118 If you have a shortage of room in your root partition, you should add 119 -DINSTALL_NODEBUG to your make arguments or add INSTALL_NODEBUG="yes" 120 to your /etc/make.conf. 121 12220060113: 123 libc's malloc implementation has been replaced. This change has the 124 potential to uncover application bugs that previously went unnoticed. 125 See the malloc(3) manual page for more details. 126 12720060112: 128 The generic netgraph(4) cookie has been changed. If you upgrade 129 kernel passing this point, you also need to upgrade userland 130 and netgraph(4) utilities like ports/net/mpd or ports/net/mpd4. 131 13220060106: 133 si(4)'s device files now contain the unit number. 134 Uses of {cua,tty}A[0-9a-f] should be replaced by {cua,tty}A0[0-9a-f]. 135 13620060106: 137 The kernel ABI was mostly destroyed due to a change in the size 138 of struct lock_object which is nested in other structures such 139 as mutexes which are nested in all sorts of other structures. 140 Make sure your kernel and modules are in sync. 141 14220051231: 143 The page coloring algorithm in the VM subsystem was converted 144 from tuning with kernel options to autotuning. Please remove 145 any PQ_* option except PQ_NOOPT from your kernel config. 146 14720051211: 148 The net80211-related tools in the tools/tools/ath directory 149 have been moved to tools/tools/net80211 and renamed with a 150 "wlan" prefix. Scripts that use them should be adjusted 151 accordingly. 152 15320051202: 154 Scripts in the local_startup directories (as defined in 155 /etc/defaults/rc.conf) that have the new rc.d semantics will 156 now be run as part of the base system rcorder. If there are 157 errors or problems with one of these local scripts, it could 158 cause boot problems. If you encounter such problems, boot in 159 single user mode, remove that script from the */rc.d directory. 160 Please report the problem to the port's maintainer, and the 161 freebsd-ports@freebsd.org mailing list. 162 16320051129: 164 The nodev mount option was deprecated in RELENG_6 (where it 165 was a no-op), and is now unsupported. If you have nodev or dev listed 166 in /etc/fstab, remove it, otherwise it will result in a mount error. 167 16820051129: 169 ABI between ipfw(4) and ipfw(8) has been changed. You need 170 to rebuild ipfw(8) when rebuilding kernel. 171 17220051108: 173 rp(4)'s device files now contain the unit number. 174 Uses of {cua,tty}R[0-9a-f] should be replaced by {cua,tty}R0[0-9a-f]. 175 17620051029: 177 /etc/rc.d/ppp-user has been renamed to /etc/rc.d/ppp. 178 Its /etc/rc.conf.d configuration file has been `ppp' from 179 the beginning, and hence there is no need to touch it. 180 18120051014: 182 Now most modules get their build-time options from the kernel 183 configuration file. A few modules still have fixed options 184 due to their non-conformant implementation, but they will be 185 corrected eventually. You may need to review the options of 186 the modules in use, explicitly specify the non-default options 187 in the kernel configuration file, and rebuild the kernel and 188 modules afterwards. 189 19020051001: 191 kern.polling.enable sysctl MIB is now deprecated. Use ifconfig(8) 192 to turn polling(4) on your interfaces. 193 19420050927: 195 The old bridge(4) implementation was retired. The new 196 if_bridge(4) serves as a full functional replacement. 197 19820050722: 199 The ai_addrlen of a struct addrinfo was changed to a socklen_t 200 to conform to POSIX-2001. This change broke an ABI 201 compatibility on 64 bit architecture. You have to recompile 202 userland programs that use getaddrinfo(3) on 64 bit 203 architecture. 204 20520050711: 206 RELENG_6 branched here. 207 20820050629: 209 The pccard_ifconfig rc.conf variable has been removed and a new 210 variable, ifconfig_DEFAULT has been introduced. Unlike 211 pccard_ifconfig, ifconfig_DEFAULT applies to ALL interfaces that 212 do not have ifconfig_ifn entries rather than just those in 213 removable_interfaces. 214 21520050616: 216 Some previous versions of PAM have permitted the use of 217 non-absolute paths in /etc/pam.conf or /etc/pam.d/* when referring 218 to third party PAM modules in /usr/local/lib. A change has been 219 made to require the use of absolute paths in order to avoid 220 ambiguity and dependence on library path configuration, which may 221 affect existing configurations. 222 22320050610: 224 Major changes to network interface API. All drivers must be 225 recompiled. Drivers not in the base system will need to be 226 updated to the new APIs. 227 22820050609: 229 Changes were made to kinfo_proc in sys/user.h. Please recompile 230 userland, or commands like `fstat', `pkill', `ps', `top' and `w' 231 will not behave correctly. 232 233 The API and ABI for hwpmc(4) have changed with the addition 234 of sampling support. Please recompile lib/libpmc(3) and 235 usr.sbin/{pmcstat,pmccontrol}. 236 23720050606: 238 The OpenBSD dhclient was imported in place of the ISC dhclient 239 and the network interface configuration scripts were updated 240 accordingly. If you use DHCP to configure your interfaces, you 241 must now run devd. Also, DNS updating was lost so you will need 242 to find a workaround if you use this feature. 243 244 The '_dhcp' user was added to support the OpenBSD dhclient. Be 245 sure to run mergemaster -p (like you are supposed to do every time 246 anyway). 247 24820050605: 249 if_bridge was added to the tree. This has changed struct ifnet. 250 Please recompile userland and all network related modules. 251 25220050603: 253 The n_net of a struct netent was changed to an uint32_t, and 254 1st argument of getnetbyaddr() was changed to an uint32_t, to 255 conform to POSIX-2001. These changes broke an ABI 256 compatibility on 64 bit architecture. With these changes, 257 shlib major of libpcap was bumped. You have to recompile 258 userland programs that use getnetbyaddr(3), getnetbyname(3), 259 getnetent(3) and/or libpcap on 64 bit architecture. 260 26120050528: 262 Kernel parsing of extra options on '#!' first lines of shell 263 scripts has changed. Lines with multiple options likely will 264 fail after this date. For full details, please see 265 http://people.freebsd.org/~gad/Updating-20050528.txt 266 26720050503: 268 The packet filter (pf) code has been updated to OpenBSD 3.7 269 Please note the changed anchor syntax and the fact that 270 authpf(8) now needs a mounted fdescfs(5) to function. 271 27220050415: 273 The NO_MIXED_MODE kernel option has been removed from the i386 274 amd64 platforms as its use has been superceded by the new local 275 APIC timer code. Any kernel config files containing this option 276 should be updated. 277 27820050227: 279 The on-disk format of LC_CTYPE files was changed to be machine 280 independent. Please make sure NOT to use NO_CLEAN buildworld 281 when crossing this point. Crossing this point also requires 282 recompile or reinstall of all locale depended packages. 283 28420050225: 285 The ifi_epoch member of struct if_data has been changed to 286 contain the uptime at which the interface was created or the 287 statistics zeroed rather then the wall clock time because 288 wallclock time may go backwards. This should have no impact 289 unless an snmp implementation is using this value (I know of 290 none at this point.) 291 29220050224: 293 The acpi_perf and acpi_throttle drivers are now part of the 294 acpi(4) main module. They are no longer built separately. 295 29620050223: 297 The layout of struct image_params has changed. You have to 298 recompile all compatibility modules (linux, svr4, etc) for use 299 with the new kernel. 300 30120050223: 302 The p4tcc driver has been merged into cpufreq(4). This makes 303 "options CPU_ENABLE_TCC" obsolete. Please load cpufreq.ko or 304 compile in "device cpufreq" to restore this functionality. 305 30620050220: 307 The responsibility of recomputing the file system summary of 308 a SoftUpdates-enabled dirty volume has been transferred to the 309 background fsck. A rebuild of fsck(8) utility is recommended 310 if you have updated the kernel. 311 312 To get the old behavior (recompute file system summary at mount 313 time), you can set vfs.ffs.compute_summary_at_mount=1 before 314 mounting the new volume. 315 31620050206: 317 The cpufreq import is complete. As part of this, the sysctls for 318 acpi(4) throttling have been removed. The power_profile script 319 has been updated, so you can use performance/economy_cpu_freq in 320 rc.conf(5) to set AC on/offline cpu frequencies. 321 32220050206: 323 NG_VERSION has been increased. Recompiling kernel (or ng_socket.ko) 324 requires recompiling libnetgraph and userland netgraph utilities. 325 32620050114: 327 Support for abbreviated forms of a number of ipfw options is 328 now deprecated. Warnings are printed to stderr indicating the 329 correct full form when a match occurs. Some abbreviations may 330 be supported at a later date based on user feedback. To be 331 considered for support, abbreviations must be in use prior to 332 this commit and unlikely to be confused with current key words. 333 33420041221: 335 By a popular demand, a lot of NOFOO options were renamed 336 to NO_FOO (see bsd.compat.mk for a full list). The old 337 spellings are still supported, but will cause annoying 338 warnings on stderr. Make sure you upgrade properly (see 339 the COMMON ITEMS: section later in this file). 340 34120041219: 342 Auto-loading of ancillary wlan modules such as wlan_wep has 343 been temporarily disabled; you need to statically configure 344 the modules you need into your kernel or explicitly load them 345 prior to use. Specifically, if you intend to use WEP encryption 346 with an 802.11 device load/configure wlan_wep; if you want to 347 use WPA with the ath driver load/configure wlan_tkip, wlan_ccmp, 348 and wlan_xauth as required. 349 35020041213: 351 The behaviour of ppp(8) has changed slightly. If lqr is enabled 352 (``enable lqr''), older versions would revert to LCP ECHO mode on 353 negotiation failure. Now, ``enable echo'' is required for this 354 behaviour. The ppp version number has been bumped to 3.4.2 to 355 reflect the change. 356 35720041201: 358 The wlan support has been updated to split the crypto support 359 into separate modules. For static WEP you must configure the 360 wlan_wep module in your system or build and install the module 361 in place where it can be loaded (the kernel will auto-load 362 the module when a wep key is configured). 363 36420041201: 365 The ath driver has been updated to split the tx rate control 366 algorithm into a separate module. You need to include either 367 ath_rate_onoe or ath_rate_amrr when configuring the kernel. 368 36920041116: 370 Support for systems with an 80386 CPU has been removed. Please 371 use FreeBSD 5.x or earlier on systems with an 80386. 372 37320041110: 374 We have had a hack which would mount the root filesystem 375 R/W if the device were named 'md*'. As part of the vnode 376 work I'm doing I have had to remove this hack. People 377 building systems which use preloaded MD root filesystems 378 may need to insert a "/sbin/mount -u -o rw /dev/md0 /" in 379 their /etc/rc scripts. 380 38120041104: 382 FreeBSD 5.3 shipped here. 383 38420041102: 385 The size of struct tcpcb has changed again due to the removal 386 of RFC1644 T/TCP. You have to recompile userland programs that 387 read kmem for tcp sockets directly (netstat, sockstat, etc.) 388 38920041022: 390 The size of struct tcpcb has changed. You have to recompile 391 userland programs that read kmem for tcp sockets directly 392 (netstat, sockstat, etc.) 393 39420041016: 395 RELENG_5 branched here. For older entries, please see updating 396 in the RELENG_5 branch. 397 398COMMON ITEMS: 399 400 General Notes 401 ------------- 402 Avoid using make -j when upgrading. From time to time in the 403 past there have been problems using -j with buildworld and/or 404 installworld. This is especially true when upgrading between 405 "distant" versions (eg one that cross a major release boundary 406 or several minor releases, or when several months have passed 407 on the -current branch). 408 409 Sometimes, obscure build problems are the result of environment 410 poisoning. This can happen because the make utility reads its 411 environment when searching for values for global variables. 412 To run your build attempts in an "environmental clean room", 413 prefix all make commands with 'env -i '. See the env(1) manual 414 page for more details. 415 416 When upgrading from one major version to another it is generally 417 best to upgrade to the latest code in the currently installed branch 418 first, then do an upgrade to the new branch. This is the best-tested 419 upgrade path, and has the highest probability of being successful. 420 Please try this approach before reporting problems with a major 421 version upgrade. 422 423 To build a kernel 424 ----------------- 425 If you are updating from a prior version of FreeBSD (even one just 426 a few days old), you should follow this procedure. It is the most 427 failsafe as it uses a /usr/obj tree with a fresh mini-buildworld, 428 429 make kernel-toolchain 430 make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE 431 make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE 432 433 To test a kernel once 434 --------------------- 435 If you just want to boot a kernel once (because you are not sure 436 if it works, or if you want to boot a known bad kernel to provide 437 debugging information) run 438 make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel 439 nextboot -k testkernel 440 441 To just build a kernel when you know that it won't mess you up 442 -------------------------------------------------------------- 443 This assumes you are already running a 5.X system. Replace 444 ${arch} with the architecture of your machine (e.g. "i386", 445 "alpha", "amd64", "ia64", "pc98", "sparc64", etc). 446 447 cd src/sys/${arch}/conf 448 config KERNEL_NAME_HERE 449 cd ../compile/KERNEL_NAME_HERE 450 make depend 451 make 452 make install 453 454 If this fails, go to the "To build a kernel" section. 455 456 To rebuild everything and install it on the current system. 457 ----------------------------------------------------------- 458 # Note: sometimes if you are running current you gotta do more than 459 # is listed here if you are upgrading from a really old current. 460 461 <make sure you have good level 0 dumps> 462 make buildworld 463 make kernel KERNCONF=YOUR_KERNEL_HERE 464 [1] 465 <reboot in single user> [3] 466 mergemaster -p [5] 467 make installworld 468 make delete-old 469 mergemaster [4] 470 <reboot> 471 472 473 To cross-install current onto a separate partition 474 -------------------------------------------------- 475 # In this approach we use a separate partition to hold 476 # current's root, 'usr', and 'var' directories. A partition 477 # holding "/", "/usr" and "/var" should be about 2GB in 478 # size. 479 480 <make sure you have good level 0 dumps> 481 <boot into -stable> 482 make buildworld 483 make buildkernel KERNCONF=YOUR_KERNEL_HERE 484 <maybe newfs current's root partition> 485 <mount current's root partition on directory ${CURRENT_ROOT}> 486 make installworld DESTDIR=${CURRENT_ROOT} 487 make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd 488 make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT} 489 cp /etc/fstab ${CURRENT_ROOT}/etc/fstab # if newfs'd 490 <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition> 491 <reboot into current> 492 <do a "native" rebuild/install as described in the previous section> 493 <maybe install compatibility libraries from src/lib/compat> 494 <reboot> 495 496 497 To upgrade in-place from 5.x-stable to current 498 ---------------------------------------------- 499 <make sure you have good level 0 dumps> 500 make buildworld [9] 501 make kernel KERNCONF=YOUR_KERNEL_HERE [8] 502 [1] 503 <reboot in single user> [3] 504 mergemaster -p [5] 505 make installworld 506 make delete-old 507 mergemaster -i [4] 508 <reboot> 509 510 Make sure that you've read the UPDATING file to understand the 511 tweaks to various things you need. At this point in the life 512 cycle of current, things change often and you are on your own 513 to cope. The defaults can also change, so please read ALL of 514 the UPDATING entries. 515 516 Also, if you are tracking -current, you must be subscribed to 517 freebsd-current@freebsd.org. Make sure that before you update 518 your sources that you have read and understood all the recent 519 messages there. If in doubt, please track -stable which has 520 much fewer pitfalls. 521 522 [1] If you have third party modules, such as vmware, you 523 should disable them at this point so they don't crash your 524 system on reboot. 525 526 [3] From the bootblocks, boot -s, and then do 527 fsck -p 528 mount -u / 529 mount -a 530 cd src 531 adjkerntz -i # if CMOS is wall time 532 Also, when doing a major release upgrade, it is required that 533 you boot into single user mode to do the installworld. 534 535 [4] Note: This step is non-optional. Failure to do this step 536 can result in a significant reduction in the functionality of the 537 system. Attempting to do it by hand is not recommended and those 538 that pursue this avenue should read this file carefully, as well 539 as the archives of freebsd-current and freebsd-hackers mailing lists 540 for potential gotchas. 541 542 [5] Usually this step is a noop. However, from time to time 543 you may need to do this if you get unknown user in the following 544 step. It never hurts to do it all the time. You may need to 545 install a new mergemaster (cd src/usr.sbin/mergemaster && make 546 install) after the buildworld before this step if you last updated 547 from current before 20020224 or from -stable before 20020408. 548 549 [8] In order to have a kernel that can run the 4.x binaries 550 needed to do an installworld, you must include the COMPAT_FREEBSD4 551 option in your kernel. Failure to do so may leave you with a system 552 that is hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 553 is required to run the 5.x binaries on more recent kernels. 554 555 Make sure that you merge any new devices from GENERIC since the 556 last time you updated your kernel config file. 557 558 [9] When checking out sources, you must include the -P flag to have 559 cvs prune empty directories. 560 561 If CPUTYPE is defined in your /etc/make.conf, make sure to use the 562 "?=" instead of the "=" assignment operator, so that buildworld can 563 override the CPUTYPE if it needs to. 564 565 MAKEOBJDIRPREFIX must be defined in an environment variable, and 566 not on the command line, or in /etc/make.conf. buildworld will 567 warn if it is improperly defined. 568FORMAT: 569 570This file contains a list, in reverse chronological order, of major 571breakages in tracking -current. Not all things will be listed here, 572and it only starts on October 16, 2004. Updating files can found in 573previous releases if your system is older than this. 574 575Copyright information: 576 577Copyright 1998-2005 M. Warner Losh. All Rights Reserved. 578 579Redistribution, publication, translation and use, with or without 580modification, in full or in part, in any form or format of this 581document are permitted without further permission from the author. 582 583THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR 584IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 585WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 586DISCLAIMED. IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT, 587INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 588(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 589SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 590HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 591STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 592IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 593POSSIBILITY OF SUCH DAMAGE. 594 595If you find this document useful, and you want to, you may buy the 596author a beer. 597 598Contact Warner Losh if you have any questions about your use of 599this document. 600 601$FreeBSD: head/UPDATING 160710 2006-07-26 16:31:10Z jkim $ 602