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