xref: /freebsd/UPDATING (revision 262e143bd46171a6415a5b28af260a5efa2a3db8)
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
2420051202:
25	Scripts in the local_startup directories (as defined in
26	/etc/defaults/rc.conf) that have the new rc.d semantics will
27	now be run as part of the base system rcorder. If there are
28	errors or problems with one of these local scripts, it could
29	cause boot problems. If you encounter such problems, boot in
30	single user mode, remove that script from the */rc.d directory.
31	Please report the problem to the port's maintainer, and the
32	freebsd-ports@freebsd.org mailing list.
33
3420051129:
35	The nodev mount option was deprecated in RELENG_6 (where it
36	was a no-op), and is now unsupported.  If you have nodev or dev listed
37	in /etc/fstab, remove it, otherwise it will result in a mount error.
38
3920051129:
40	ABI between ipfw(4) and ipfw(8) has been changed. You need
41	to rebuild ipfw(8) when rebuilding kernel.
42
4320051029:
44	/etc/rc.d/ppp-user has been renamed to /etc/rc.d/ppp.
45	Its /etc/rc.conf.d configuration file has been `ppp' from
46	the beginning, and hence there is no need to touch it.
47
4820051001:
49	kern.polling.enable sysctl MIB is now deprecated. Use ifconfig(8)
50	to turn polling(4) on your interfaces.
51
5220050927:
53	The old bridge(4) implementation was retired.  The new
54	if_bridge(4) serves as a full functional replacement.
55
5620050722:
57	The ai_addrlen of a struct addrinfo was changed to a socklen_t
58	to conform to POSIX-2001.  This change broke an ABI
59	compatibility on 64 bit architecture.  You have to recompile
60	userland programs that use getaddrinfo(3) on 64 bit
61	architecture.
62
6320050711:
64	RELENG_6 branched here.
65
6620050629:
67	The pccard_ifconfig rc.conf variable has been removed and a new
68	variable, ifconfig_DEFAULT has been introduced.  Unlike
69	pccard_ifconfig, ifconfig_DEFAULT applies to ALL interfaces that
70	do not have ifconfig_ifn entries rather than just those in
71	removable_interfaces.
72
7320050616:
74	Some previous versions of PAM have permitted the use of
75	non-absolute paths in /etc/pam.conf or /etc/pam.d/* when referring
76	to third party PAM modules in /usr/local/lib.  A change has been
77	made to require the use of absolute paths in order to avoid
78	ambiguity and dependence on library path configuration, which may
79	affect existing configurations.
80
8120050610:
82	Major changes to network interface API.  All drivers must be
83	recompiled.  Drivers not in the base system will need to be
84	updated to the new APIs.
85
8620050609:
87	Changes were made to kinfo_proc in sys/user.h.  Please recompile
88	userland, or commands like `fstat', `pkill', `ps', `top' and `w'
89	will not behave correctly.
90
91	The API and ABI for hwpmc(4) have changed with the addition
92	of sampling support.  Please recompile lib/libpmc(3) and
93	usr.sbin/{pmcstat,pmccontrol}.
94
9520050606:
96	The OpenBSD dhclient was imported in place of the ISC dhclient
97	and the network interface configuration scripts were updated
98	accordingly.  If you use DHCP to configure your interfaces, you
99	must now run devd.  Also, DNS updating was lost so you will need
100	to find a workaround if you use this feature.
101
10220050605:
103	if_bridge was added to the tree. This has changed struct ifnet.
104	Please recompile userland and all network related modules.
105
10620050603:
107	The n_net of a struct netent was changed to an uint32_t, and
108	1st argument of getnetbyaddr() was changed to an uint32_t, to
109	conform to POSIX-2001.  These changes broke an ABI
110	compatibility on 64 bit architecture.  With these changes,
111	shlib major of libpcap was bumped.  You have to recompile
112	userland programs that use getnetbyaddr(3), getnetbyname(3),
113	getnetent(3) and/or libpcap on 64 bit architecture.
114
11520050528:
116	Kernel parsing of extra options on '#!' first lines of shell
117	scripts has changed.  Lines with multiple options likely will
118	fail after this date.  For full details, please see
119		http://people.freebsd.org/~gad/Updating-20050528.txt
120
12120050503:
122	The packet filter (pf) code has been updated to OpenBSD 3.7
123	Please note the changed anchor syntax and the fact that
124	authpf(8) now needs a mounted fdescfs(5) to function.
125
12620050415:
127	The NO_MIXED_MODE kernel option has been removed from the i386
128	amd64 platforms as its use has been superceded by the new local
129	APIC timer code.  Any kernel config files containing this option
130	should be updated.
131
13220050227:
133	The on-disk format of LC_CTYPE files was changed to be machine
134	independent.  Please make sure NOT to use NO_CLEAN buildworld
135	when crossing this point. Crossing this point also requires
136	recompile or reinstall of all locale depended packages.
137
13820050225:
139	The ifi_epoch member of struct if_data has been changed to
140	contain the uptime at which the interface was created or the
141	statistics zeroed rather then the wall clock time because
142	wallclock time may go backwards.  This should have no impact
143	unless an snmp implementation is using this value (I know of
144	none at this point.)
145
14620050224:
147	The acpi_perf and acpi_throttle drivers are now part of the
148	acpi(4) main module.  They are no longer built separately.
149
15020050223:
151	The layout of struct image_params has changed. You have to
152	recompile all compatibility modules (linux, svr4, etc) for use
153	with the new kernel.
154
15520050223:
156	The p4tcc driver has been merged into cpufreq(4).  This makes
157	"options CPU_ENABLE_TCC" obsolete.  Please load cpufreq.ko or
158	compile in "device cpufreq" to restore this functionality.
159
16020050220:
161	The responsibility of recomputing the file system summary of
162	a SoftUpdates-enabled dirty volume has been transferred to the
163	background fsck.  A rebuild of fsck(8) utility is recommended
164	if you have updated the kernel.
165
166	To get the old behavior (recompute file system summary at mount
167	time), you can set vfs.ffs.compute_summary_at_mount=1 before
168	mounting the new volume.
169
17020050206:
171	The cpufreq import is complete.  As part of this, the sysctls for
172	acpi(4) throttling have been removed.  The power_profile script
173	has been updated, so you can use performance/economy_cpu_freq in
174	rc.conf(5) to set AC on/offline cpu frequencies.
175
17620050206:
177	NG_VERSION has been increased. Recompiling kernel (or ng_socket.ko)
178	requires recompiling libnetgraph and userland netgraph utilities.
179
18020050114:
181	Support for abbreviated forms of a number of ipfw options is
182	now deprecated.  Warnings are printed to stderr indicating the
183	correct full form when a match occurs.  Some abbreviations may
184	be supported at a later date based on user feedback.  To be
185	considered for support, abbreviations must be in use prior to
186	this commit and unlikely to be confused with current key words.
187
18820041221:
189	By a popular demand, a lot of NOFOO options were renamed
190	to NO_FOO (see bsd.compat.mk for a full list).  The old
191	spellings are still supported, but will cause annoying
192	warnings on stderr.  Make sure you upgrade properly (see
193	the COMMON ITEMS: section later in this file).
194
19520041219:
196	Auto-loading of ancillary wlan modules such as wlan_wep has
197	been temporarily disabled; you need to statically configure
198	the modules you need into your kernel or explicitly load them
199	prior to use.  Specifically, if you intend to use WEP encryption
200	with an 802.11 device load/configure wlan_wep; if you want to
201	use WPA with the ath driver load/configure wlan_tkip, wlan_ccmp,
202	and wlan_xauth as required.
203
20420041213:
205	The behaviour of ppp(8) has changed slightly.  If lqr is enabled
206	(``enable lqr''), older versions would revert to LCP ECHO mode on
207	negotiation failure.  Now, ``enable echo'' is required for this
208	behaviour.  The ppp version number has been bumped to 3.4.2 to
209	reflect the change.
210
21120041201:
212	The wlan support has been updated to split the crypto support
213	into separate modules.  For static WEP you must configure the
214	wlan_wep module in your system or build and install the module
215	in place where it can be loaded (the kernel will auto-load
216	the module when a wep key is configured).
217
21820041201:
219	The ath driver has been updated to split the tx rate control
220	algorithm into a separate module.  You need to include either
221	ath_rate_onoe or ath_rate_amrr when configuring the kernel.
222
22320041116:
224	Support for systems with an 80386 CPU has been removed.  Please
225	use FreeBSD 5.x or earlier on systems with an 80386.
226
22720041110:
228	We have had a hack which would mount the root filesystem
229	R/W if the device were named 'md*'.  As part of the vnode
230	work I'm doing I have had to remove this hack.  People
231	building systems which use preloaded MD root filesystems
232	may need to insert a "/sbin/mount -u -o rw /dev/md0 /" in
233	their /etc/rc scripts.
234
23520041104:
236	FreeBSD 5.3 shipped here.
237
23820041102:
239	The size of struct tcpcb has changed again due to the removal
240	of RFC1644 T/TCP.  You have to recompile userland programs that
241	read kmem for tcp sockets directly (netstat, sockstat, etc.)
242
24320041022:
244	The size of struct tcpcb has changed.  You have to recompile
245	userland programs that read kmem for tcp sockets directly
246	(netstat, sockstat, etc.)
247
24820041016:
249	RELENG_5 branched here.  For older entries, please see updating
250	in the RELENG_5 branch.
251
252COMMON ITEMS:
253
254	General Notes
255	-------------
256	Avoid using make -j when upgrading.  From time to time in the
257	past there have been problems using -j with buildworld and/or
258	installworld.  This is especially true when upgrading between
259	"distant" versions (eg one that cross a major release boundary
260	or several minor releases, or when several months have passed
261	on the -current branch).
262
263	Sometimes, obscure build problems are the result of environment
264	poisoning.  This can happen because the make utility reads its
265	environment when searching for values for global variables.
266	To run your build attempts in an "environmental clean room",
267	prefix all make commands with 'env -i '.  See the env(1) manual
268	page for more details.
269
270	When upgrading from one major version to another it is generally
271	best to upgrade to the latest code in the currently installed branch
272	first, then do an upgrade to the new branch. This is the best-tested
273	upgrade path, and has the highest probability of being successful.
274	Please try this approach before reporting problems with a major
275	version upgrade.
276
277	To build a kernel
278	-----------------
279	If you are updating from a prior version of FreeBSD (even one just
280	a few days old), you should follow this procedure.  It is the most
281	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
282
283	make kernel-toolchain
284	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
285	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
286
287	To test a kernel once
288	---------------------
289	If you just want to boot a kernel once (because you are not sure
290	if it works, or if you want to boot a known bad kernel to provide
291	debugging information) run
292	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
293	nextboot -k testkernel
294
295	To just build a kernel when you know that it won't mess you up
296	--------------------------------------------------------------
297	This assumes you are already running a 5.X system.  Replace
298	${arch} with the architecture of your machine (e.g. "i386",
299	"alpha", "amd64", "ia64", "pc98", "sparc64", etc).
300
301	cd src/sys/${arch}/conf
302	config KERNEL_NAME_HERE
303	cd ../compile/KERNEL_NAME_HERE
304	make depend
305	make
306	make install
307
308	If this fails, go to the "To build a kernel" section.
309
310	To rebuild everything and install it on the current system.
311	-----------------------------------------------------------
312	# Note: sometimes if you are running current you gotta do more than
313	# is listed here if you are upgrading from a really old current.
314
315	<make sure you have good level 0 dumps>
316	make buildworld
317	make kernel KERNCONF=YOUR_KERNEL_HERE
318							[1]
319	<reboot in single user>				[3]
320	mergemaster -p					[5]
321	make installworld
322	make delete-old
323	mergemaster					[4]
324	<reboot>
325
326
327	To cross-install current onto a separate partition
328	--------------------------------------------------
329	# In this approach we use a separate partition to hold
330	# current's root, 'usr', and 'var' directories.   A partition
331	# holding "/", "/usr" and "/var" should be about 2GB in
332	# size.
333
334	<make sure you have good level 0 dumps>
335	<boot into -stable>
336	make buildworld
337	make buildkernel KERNCONF=YOUR_KERNEL_HERE
338	<maybe newfs current's root partition>
339	<mount current's root partition on directory ${CURRENT_ROOT}>
340	make installworld DESTDIR=${CURRENT_ROOT}
341	cd src/etc; make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
342	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
343	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
344	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
345	<reboot into current>
346	<do a "native" rebuild/install as described in the previous section>
347	<maybe install compatibility libraries from src/lib/compat>
348 	<reboot>
349
350
351	To upgrade in-place from 5.x-stable to current
352	----------------------------------------------
353	<make sure you have good level 0 dumps>
354	make buildworld					[9]
355	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
356							[1]
357	<reboot in single user>				[3]
358	mergemaster -p					[5]
359	make installworld
360	make delete-old
361	mergemaster -i					[4]
362	<reboot>
363
364	Make sure that you've read the UPDATING file to understand the
365	tweaks to various things you need.  At this point in the life
366	cycle of current, things change often and you are on your own
367	to cope.  The defaults can also change, so please read ALL of
368	the UPDATING entries.
369
370	Also, if you are tracking -current, you must be subscribed to
371	freebsd-current@freebsd.org.  Make sure that before you update
372	your sources that you have read and understood all the recent
373	messages there.  If in doubt, please track -stable which has
374	much fewer pitfalls.
375
376	[1] If you have third party modules, such as vmware, you
377	should disable them at this point so they don't crash your
378	system on reboot.
379
380	[3] From the bootblocks, boot -s, and then do
381		fsck -p
382		mount -u /
383		mount -a
384		cd src
385		adjkerntz -i		# if CMOS is wall time
386	Also, when doing a major release upgrade, it is required that
387	you boot into single user mode to do the installworld.
388
389	[4] Note: This step is non-optional.  Failure to do this step
390	can result in a significant reduction in the functionality of the
391	system.  Attempting to do it by hand is not recommended and those
392	that pursue this avenue should read this file carefully, as well
393	as the archives of freebsd-current and freebsd-hackers mailing lists
394	for potential gotchas.
395
396	[5] Usually this step is a noop.  However, from time to time
397	you may need to do this if you get unknown user in the following
398	step.  It never hurts to do it all the time.  You may need to
399	install a new mergemaster (cd src/usr.sbin/mergemaster && make
400	install) after the buildworld before this step if you last updated
401	from current before 20020224 or from -stable before 20020408.
402
403	[8] In order to have a kernel that can run the 4.x binaries
404	needed to do an installworld, you must include the COMPAT_FREEBSD4
405	option in your kernel.  Failure to do so may leave you with a system
406	that is hard to boot to recover. A similar kernel option COMPAT_FREEBSD5
407	is required to run the 5.x binaries on more recent kernels.
408
409	Make sure that you merge any new devices from GENERIC since the
410	last time you updated your kernel config file.
411
412	[9] When checking out sources, you must include the -P flag to have
413	cvs prune empty directories.
414
415	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
416	"?=" instead of the "=" assignment operator, so that buildworld can
417	override the CPUTYPE if it needs to.
418
419	MAKEOBJDIRPREFIX must be defined in an environment variable, and
420	not on the command line, or in /etc/make.conf.  buildworld will
421	warn if it is improperly defined.
422FORMAT:
423
424This file contains a list, in reverse chronological order, of major
425breakages in tracking -current.  Not all things will be listed here,
426and it only starts on October 16, 2004.  Updating files can found in
427previous releases if your system is older than this.
428
429Copyright information:
430
431Copyright 1998-2005 M. Warner Losh.  All Rights Reserved.
432
433Redistribution, publication, translation and use, with or without
434modification, in full or in part, in any form or format of this
435document are permitted without further permission from the author.
436
437THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
438IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
439WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
440DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
441INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
442(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
443SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
444HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
445STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
446IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
447POSSIBILITY OF SUCH DAMAGE.
448
449If you find this document useful, and you want to, you may buy the
450author a beer.
451
452Contact Warner Losh if you have any questions about your use of
453this document.
454
455$FreeBSD$
456