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