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