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