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