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