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