UPDATING revision 156326
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 2420060305: 25 The NETSMBCRYPTO kernel option has been retired because its 26 functionality is always included in NETSMB and smbfs.ko now. 27 2820060303: 29 The TDFX_LINUX kernel option was retired and replaced by the 30 tdfx_linux device. The latter can be loaded as a kernel module. 31 Loading it alone should suffice to get 3dfx support for Linux 32 apps because it will pull in tdfx.ko and linux.ko through its 33 dependencies. 34 3520060201: 36 The kernel ABI to file system modules was changed on i386. 37 Please make sure that your kernel and modules are in sync. 38 3920060118: 40 This actually occured some time ago, but installing the kernel 41 now also installs a bunch of symbol files for the kernel modules. 42 This increases the size of /boot/kernel to about 67Mbytes. You 43 will need twice this if you will eventually back this up to kernel.old 44 on your next install. 45 If you have a shortage of room in your root partition, you should add 46 -DINSTALL_NODEBUG to your make arguments or add INSTALL_NODEBUG="yes" 47 to your /etc/make.conf. 48 4920060113: 50 libc's malloc implementation has been replaced. This change has the 51 potential to uncover application bugs that previously went unnoticed. 52 See the malloc(3) manual page for more details. 53 5420060112: 55 The generic netgraph(4) cookie has been changed. If you upgrade 56 kernel passing this point, you also need to upgrade userland 57 and netgraph(4) utilities like ports/net/mpd or ports/net/mpd4. 58 5920060106: 60 si(4)'s device files now contain the unit number. 61 Uses of {cua,tty}A[0-9a-f] should be replaced by {cua,tty}A0[0-9a-f]. 62 6320060106: 64 The kernel ABI was mostly destroyed due to a change in the size 65 of struct lock_object which is nested in other structures such 66 as mutexes which are nested in all sorts of other structures. 67 Make sure your kernel and modules are in sync. 68 6920051231: 70 The page coloring algorithm in the VM subsystem was converted 71 from tuning with kernel options to autotuning. Please remove 72 any PQ_* option except PQ_NOOPT from your kernel config. 73 7420051211: 75 The net80211-related tools in the tools/tools/ath directory 76 have been moved to tools/tools/net80211 and renamed with a 77 "wlan" prefix. Scripts that use them should be adjusted 78 accordingly. 79 8020051202: 81 Scripts in the local_startup directories (as defined in 82 /etc/defaults/rc.conf) that have the new rc.d semantics will 83 now be run as part of the base system rcorder. If there are 84 errors or problems with one of these local scripts, it could 85 cause boot problems. If you encounter such problems, boot in 86 single user mode, remove that script from the */rc.d directory. 87 Please report the problem to the port's maintainer, and the 88 freebsd-ports@freebsd.org mailing list. 89 9020051129: 91 The nodev mount option was deprecated in RELENG_6 (where it 92 was a no-op), and is now unsupported. If you have nodev or dev listed 93 in /etc/fstab, remove it, otherwise it will result in a mount error. 94 9520051129: 96 ABI between ipfw(4) and ipfw(8) has been changed. You need 97 to rebuild ipfw(8) when rebuilding kernel. 98 9920051108: 100 rp(4)'s device files now contain the unit number. 101 Uses of {cua,tty}R[0-9a-f] should be replaced by {cua,tty}R0[0-9a-f]. 102 10320051029: 104 /etc/rc.d/ppp-user has been renamed to /etc/rc.d/ppp. 105 Its /etc/rc.conf.d configuration file has been `ppp' from 106 the beginning, and hence there is no need to touch it. 107 10820051014: 109 Now most modules get their build-time options from the kernel 110 configuration file. A few modules still have fixed options 111 due to their non-conformant implementation, but they will be 112 corrected eventually. You may need to review the options of 113 the modules in use, explicitly specify the non-default options 114 in the kernel configuration file, and rebuild the kernel and 115 modules afterwards. 116 11720051001: 118 kern.polling.enable sysctl MIB is now deprecated. Use ifconfig(8) 119 to turn polling(4) on your interfaces. 120 12120050927: 122 The old bridge(4) implementation was retired. The new 123 if_bridge(4) serves as a full functional replacement. 124 12520050722: 126 The ai_addrlen of a struct addrinfo was changed to a socklen_t 127 to conform to POSIX-2001. This change broke an ABI 128 compatibility on 64 bit architecture. You have to recompile 129 userland programs that use getaddrinfo(3) on 64 bit 130 architecture. 131 13220050711: 133 RELENG_6 branched here. 134 13520050629: 136 The pccard_ifconfig rc.conf variable has been removed and a new 137 variable, ifconfig_DEFAULT has been introduced. Unlike 138 pccard_ifconfig, ifconfig_DEFAULT applies to ALL interfaces that 139 do not have ifconfig_ifn entries rather than just those in 140 removable_interfaces. 141 14220050616: 143 Some previous versions of PAM have permitted the use of 144 non-absolute paths in /etc/pam.conf or /etc/pam.d/* when referring 145 to third party PAM modules in /usr/local/lib. A change has been 146 made to require the use of absolute paths in order to avoid 147 ambiguity and dependence on library path configuration, which may 148 affect existing configurations. 149 15020050610: 151 Major changes to network interface API. All drivers must be 152 recompiled. Drivers not in the base system will need to be 153 updated to the new APIs. 154 15520050609: 156 Changes were made to kinfo_proc in sys/user.h. Please recompile 157 userland, or commands like `fstat', `pkill', `ps', `top' and `w' 158 will not behave correctly. 159 160 The API and ABI for hwpmc(4) have changed with the addition 161 of sampling support. Please recompile lib/libpmc(3) and 162 usr.sbin/{pmcstat,pmccontrol}. 163 16420050606: 165 The OpenBSD dhclient was imported in place of the ISC dhclient 166 and the network interface configuration scripts were updated 167 accordingly. If you use DHCP to configure your interfaces, you 168 must now run devd. Also, DNS updating was lost so you will need 169 to find a workaround if you use this feature. 170 17120050605: 172 if_bridge was added to the tree. This has changed struct ifnet. 173 Please recompile userland and all network related modules. 174 17520050603: 176 The n_net of a struct netent was changed to an uint32_t, and 177 1st argument of getnetbyaddr() was changed to an uint32_t, to 178 conform to POSIX-2001. These changes broke an ABI 179 compatibility on 64 bit architecture. With these changes, 180 shlib major of libpcap was bumped. You have to recompile 181 userland programs that use getnetbyaddr(3), getnetbyname(3), 182 getnetent(3) and/or libpcap on 64 bit architecture. 183 18420050528: 185 Kernel parsing of extra options on '#!' first lines of shell 186 scripts has changed. Lines with multiple options likely will 187 fail after this date. For full details, please see 188 http://people.freebsd.org/~gad/Updating-20050528.txt 189 19020050503: 191 The packet filter (pf) code has been updated to OpenBSD 3.7 192 Please note the changed anchor syntax and the fact that 193 authpf(8) now needs a mounted fdescfs(5) to function. 194 19520050415: 196 The NO_MIXED_MODE kernel option has been removed from the i386 197 amd64 platforms as its use has been superceded by the new local 198 APIC timer code. Any kernel config files containing this option 199 should be updated. 200 20120050227: 202 The on-disk format of LC_CTYPE files was changed to be machine 203 independent. Please make sure NOT to use NO_CLEAN buildworld 204 when crossing this point. Crossing this point also requires 205 recompile or reinstall of all locale depended packages. 206 20720050225: 208 The ifi_epoch member of struct if_data has been changed to 209 contain the uptime at which the interface was created or the 210 statistics zeroed rather then the wall clock time because 211 wallclock time may go backwards. This should have no impact 212 unless an snmp implementation is using this value (I know of 213 none at this point.) 214 21520050224: 216 The acpi_perf and acpi_throttle drivers are now part of the 217 acpi(4) main module. They are no longer built separately. 218 21920050223: 220 The layout of struct image_params has changed. You have to 221 recompile all compatibility modules (linux, svr4, etc) for use 222 with the new kernel. 223 22420050223: 225 The p4tcc driver has been merged into cpufreq(4). This makes 226 "options CPU_ENABLE_TCC" obsolete. Please load cpufreq.ko or 227 compile in "device cpufreq" to restore this functionality. 228 22920050220: 230 The responsibility of recomputing the file system summary of 231 a SoftUpdates-enabled dirty volume has been transferred to the 232 background fsck. A rebuild of fsck(8) utility is recommended 233 if you have updated the kernel. 234 235 To get the old behavior (recompute file system summary at mount 236 time), you can set vfs.ffs.compute_summary_at_mount=1 before 237 mounting the new volume. 238 23920050206: 240 The cpufreq import is complete. As part of this, the sysctls for 241 acpi(4) throttling have been removed. The power_profile script 242 has been updated, so you can use performance/economy_cpu_freq in 243 rc.conf(5) to set AC on/offline cpu frequencies. 244 24520050206: 246 NG_VERSION has been increased. Recompiling kernel (or ng_socket.ko) 247 requires recompiling libnetgraph and userland netgraph utilities. 248 24920050114: 250 Support for abbreviated forms of a number of ipfw options is 251 now deprecated. Warnings are printed to stderr indicating the 252 correct full form when a match occurs. Some abbreviations may 253 be supported at a later date based on user feedback. To be 254 considered for support, abbreviations must be in use prior to 255 this commit and unlikely to be confused with current key words. 256 25720041221: 258 By a popular demand, a lot of NOFOO options were renamed 259 to NO_FOO (see bsd.compat.mk for a full list). The old 260 spellings are still supported, but will cause annoying 261 warnings on stderr. Make sure you upgrade properly (see 262 the COMMON ITEMS: section later in this file). 263 26420041219: 265 Auto-loading of ancillary wlan modules such as wlan_wep has 266 been temporarily disabled; you need to statically configure 267 the modules you need into your kernel or explicitly load them 268 prior to use. Specifically, if you intend to use WEP encryption 269 with an 802.11 device load/configure wlan_wep; if you want to 270 use WPA with the ath driver load/configure wlan_tkip, wlan_ccmp, 271 and wlan_xauth as required. 272 27320041213: 274 The behaviour of ppp(8) has changed slightly. If lqr is enabled 275 (``enable lqr''), older versions would revert to LCP ECHO mode on 276 negotiation failure. Now, ``enable echo'' is required for this 277 behaviour. The ppp version number has been bumped to 3.4.2 to 278 reflect the change. 279 28020041201: 281 The wlan support has been updated to split the crypto support 282 into separate modules. For static WEP you must configure the 283 wlan_wep module in your system or build and install the module 284 in place where it can be loaded (the kernel will auto-load 285 the module when a wep key is configured). 286 28720041201: 288 The ath driver has been updated to split the tx rate control 289 algorithm into a separate module. You need to include either 290 ath_rate_onoe or ath_rate_amrr when configuring the kernel. 291 29220041116: 293 Support for systems with an 80386 CPU has been removed. Please 294 use FreeBSD 5.x or earlier on systems with an 80386. 295 29620041110: 297 We have had a hack which would mount the root filesystem 298 R/W if the device were named 'md*'. As part of the vnode 299 work I'm doing I have had to remove this hack. People 300 building systems which use preloaded MD root filesystems 301 may need to insert a "/sbin/mount -u -o rw /dev/md0 /" in 302 their /etc/rc scripts. 303 30420041104: 305 FreeBSD 5.3 shipped here. 306 30720041102: 308 The size of struct tcpcb has changed again due to the removal 309 of RFC1644 T/TCP. You have to recompile userland programs that 310 read kmem for tcp sockets directly (netstat, sockstat, etc.) 311 31220041022: 313 The size of struct tcpcb has changed. You have to recompile 314 userland programs that read kmem for tcp sockets directly 315 (netstat, sockstat, etc.) 316 31720041016: 318 RELENG_5 branched here. For older entries, please see updating 319 in the RELENG_5 branch. 320 321COMMON ITEMS: 322 323 General Notes 324 ------------- 325 Avoid using make -j when upgrading. From time to time in the 326 past there have been problems using -j with buildworld and/or 327 installworld. This is especially true when upgrading between 328 "distant" versions (eg one that cross a major release boundary 329 or several minor releases, or when several months have passed 330 on the -current branch). 331 332 Sometimes, obscure build problems are the result of environment 333 poisoning. This can happen because the make utility reads its 334 environment when searching for values for global variables. 335 To run your build attempts in an "environmental clean room", 336 prefix all make commands with 'env -i '. See the env(1) manual 337 page for more details. 338 339 When upgrading from one major version to another it is generally 340 best to upgrade to the latest code in the currently installed branch 341 first, then do an upgrade to the new branch. This is the best-tested 342 upgrade path, and has the highest probability of being successful. 343 Please try this approach before reporting problems with a major 344 version upgrade. 345 346 To build a kernel 347 ----------------- 348 If you are updating from a prior version of FreeBSD (even one just 349 a few days old), you should follow this procedure. It is the most 350 failsafe as it uses a /usr/obj tree with a fresh mini-buildworld, 351 352 make kernel-toolchain 353 make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE 354 make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE 355 356 To test a kernel once 357 --------------------- 358 If you just want to boot a kernel once (because you are not sure 359 if it works, or if you want to boot a known bad kernel to provide 360 debugging information) run 361 make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel 362 nextboot -k testkernel 363 364 To just build a kernel when you know that it won't mess you up 365 -------------------------------------------------------------- 366 This assumes you are already running a 5.X system. Replace 367 ${arch} with the architecture of your machine (e.g. "i386", 368 "alpha", "amd64", "ia64", "pc98", "sparc64", etc). 369 370 cd src/sys/${arch}/conf 371 config KERNEL_NAME_HERE 372 cd ../compile/KERNEL_NAME_HERE 373 make depend 374 make 375 make install 376 377 If this fails, go to the "To build a kernel" section. 378 379 To rebuild everything and install it on the current system. 380 ----------------------------------------------------------- 381 # Note: sometimes if you are running current you gotta do more than 382 # is listed here if you are upgrading from a really old current. 383 384 <make sure you have good level 0 dumps> 385 make buildworld 386 make kernel KERNCONF=YOUR_KERNEL_HERE 387 [1] 388 <reboot in single user> [3] 389 mergemaster -p [5] 390 make installworld 391 make delete-old 392 mergemaster [4] 393 <reboot> 394 395 396 To cross-install current onto a separate partition 397 -------------------------------------------------- 398 # In this approach we use a separate partition to hold 399 # current's root, 'usr', and 'var' directories. A partition 400 # holding "/", "/usr" and "/var" should be about 2GB in 401 # size. 402 403 <make sure you have good level 0 dumps> 404 <boot into -stable> 405 make buildworld 406 make buildkernel KERNCONF=YOUR_KERNEL_HERE 407 <maybe newfs current's root partition> 408 <mount current's root partition on directory ${CURRENT_ROOT}> 409 make installworld DESTDIR=${CURRENT_ROOT} 410 cd src/etc; make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd 411 make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT} 412 cp /etc/fstab ${CURRENT_ROOT}/etc/fstab # if newfs'd 413 <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition> 414 <reboot into current> 415 <do a "native" rebuild/install as described in the previous section> 416 <maybe install compatibility libraries from src/lib/compat> 417 <reboot> 418 419 420 To upgrade in-place from 5.x-stable to current 421 ---------------------------------------------- 422 <make sure you have good level 0 dumps> 423 make buildworld [9] 424 make kernel KERNCONF=YOUR_KERNEL_HERE [8] 425 [1] 426 <reboot in single user> [3] 427 mergemaster -p [5] 428 make installworld 429 make delete-old 430 mergemaster -i [4] 431 <reboot> 432 433 Make sure that you've read the UPDATING file to understand the 434 tweaks to various things you need. At this point in the life 435 cycle of current, things change often and you are on your own 436 to cope. The defaults can also change, so please read ALL of 437 the UPDATING entries. 438 439 Also, if you are tracking -current, you must be subscribed to 440 freebsd-current@freebsd.org. Make sure that before you update 441 your sources that you have read and understood all the recent 442 messages there. If in doubt, please track -stable which has 443 much fewer pitfalls. 444 445 [1] If you have third party modules, such as vmware, you 446 should disable them at this point so they don't crash your 447 system on reboot. 448 449 [3] From the bootblocks, boot -s, and then do 450 fsck -p 451 mount -u / 452 mount -a 453 cd src 454 adjkerntz -i # if CMOS is wall time 455 Also, when doing a major release upgrade, it is required that 456 you boot into single user mode to do the installworld. 457 458 [4] Note: This step is non-optional. Failure to do this step 459 can result in a significant reduction in the functionality of the 460 system. Attempting to do it by hand is not recommended and those 461 that pursue this avenue should read this file carefully, as well 462 as the archives of freebsd-current and freebsd-hackers mailing lists 463 for potential gotchas. 464 465 [5] Usually this step is a noop. However, from time to time 466 you may need to do this if you get unknown user in the following 467 step. It never hurts to do it all the time. You may need to 468 install a new mergemaster (cd src/usr.sbin/mergemaster && make 469 install) after the buildworld before this step if you last updated 470 from current before 20020224 or from -stable before 20020408. 471 472 [8] In order to have a kernel that can run the 4.x binaries 473 needed to do an installworld, you must include the COMPAT_FREEBSD4 474 option in your kernel. Failure to do so may leave you with a system 475 that is hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 476 is required to run the 5.x binaries on more recent kernels. 477 478 Make sure that you merge any new devices from GENERIC since the 479 last time you updated your kernel config file. 480 481 [9] When checking out sources, you must include the -P flag to have 482 cvs prune empty directories. 483 484 If CPUTYPE is defined in your /etc/make.conf, make sure to use the 485 "?=" instead of the "=" assignment operator, so that buildworld can 486 override the CPUTYPE if it needs to. 487 488 MAKEOBJDIRPREFIX must be defined in an environment variable, and 489 not on the command line, or in /etc/make.conf. buildworld will 490 warn if it is improperly defined. 491FORMAT: 492 493This file contains a list, in reverse chronological order, of major 494breakages in tracking -current. Not all things will be listed here, 495and it only starts on October 16, 2004. Updating files can found in 496previous releases if your system is older than this. 497 498Copyright information: 499 500Copyright 1998-2005 M. Warner Losh. All Rights Reserved. 501 502Redistribution, publication, translation and use, with or without 503modification, in full or in part, in any form or format of this 504document are permitted without further permission from the author. 505 506THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR 507IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 508WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 509DISCLAIMED. IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT, 510INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 511(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 512SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 513HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 514STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 515IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 516POSSIBILITY OF SUCH DAMAGE. 517 518If you find this document useful, and you want to, you may buy the 519author a beer. 520 521Contact Warner Losh if you have any questions about your use of 522this document. 523 524$FreeBSD: head/UPDATING 156326 2006-03-05 22:52:17Z yar $ 525