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