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