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