xref: /freebsd/UPDATING (revision eb6d21b4ca6d668cf89afd99eef7baeafa712197)
1Updating Information for FreeBSD current users
2
3This file is maintained and copyrighted by M. Warner Losh <imp@freebsd.org>.
4See end of file for further details.  For commonly done items, please see the
5COMMON ITEMS: section later in the file.  These instructions assume that you
6basically know what you are doing.  If not, then please consult the FreeBSD
7handbook.
8
9Items affecting the ports and packages system can be found in
10/usr/ports/UPDATING.  Please read that file before running portupgrade.
11
12NOTE TO PEOPLE WHO THINK THAT FreeBSD 9.x IS SLOW:
13	FreeBSD 9.x has many debugging features turned on, in both the kernel
14	and userland.  These features attempt to detect incorrect use of
15	system primitives, and encourage loud failure through extra sanity
16	checking and fail stop semantics.  They also substantially impact
17	system performance.  If you want to do performance measurement,
18	benchmarking, and optimization, you'll want to turn them off.  This
19	includes various WITNESS- related kernel options, INVARIANTS, malloc
20	debugging flags in userland, and various verbose features in the
21	kernel.  Many developers choose to disable these features on build
22	machines to maximize performance.  (To disable malloc debugging, run
23	ln -s aj /etc/malloc.conf.)
24
2520091113:
26	The default terminal emulation for syscons(4) has been changed
27	from cons25 to xterm on all platforms except pc98.  This means
28	that the /etc/ttys file needs to be updated to ensure correct
29	operation of applications on the console.
30
31	The terminal emulation style can be toggled per window by using
32	vidcontrol(1)'s -T flag.  The TEKEN_CONS25 kernel configuration
33	options can be used to change the compile-time default back to
34	cons25.
35
36	To prevent graphical artifacts, make sure the TERM environment
37	variable is set to match the terminal emulation that is being
38	performed by syscons(4).
39
4020091109:
41	The layout of the structure ieee80211req_scan_result has changed.
42	Applications that require wireless scan results (e.g. ifconfig(8))
43	from net80211 need to be recompiled.
44
45	Applications such as wpa_supplicant(8) may require a full world
46	build without using NO_CLEAN in order to get synchronized with the
47	new structure.
48
4920091025:
50	The iwn(4) driver has been updated to support the 5000 and 5150 series.
51	There's one kernel module for each firmware. Adding "device iwnfw"
52	to the kernel configuration file means including all three firmware
53	images inside the kernel. If you want to include just the one for
54	your wireless card, use the the devices iwn4965fw, iwn5000fw or
55	iwn5150fw.
56
5720090926:
58	The rc.d/network_ipv6, IPv6 configuration script has been integrated
59	into rc.d/netif.  The changes are the following:
60
61	1. To use IPv6, simply define $ifconfig_IF_ipv6 like $ifconfig_IF
62	   for IPv4.  For aliases, $ifconfig_IF_aliasN should be used.
63	   Note that both variables need the "inet6" keyword at the head.
64
65	   Do not set $ipv6_network_interfaces manually if you do not
66	   understand what you are doing.  It is not needed in most cases.
67
68	   $ipv6_ifconfig_IF and $ipv6_ifconfig_IF_aliasN still work, but
69	   they are obsolete.
70
71	2. $ipv6_enable is obsolete.  Use $ipv6_prefer and
72	   "inet6 accept_rtadv" keyword in ifconfig(8) instead.
73
74	   If you define $ipv6_enable=YES, it means $ipv6_prefer=YES and
75	   all configured interfaces have "inet6 accept_rtadv" in the
76	   $ifconfig_IF_ipv6.  These are for backward compatibility.
77
78	3. A new variable $ipv6_prefer has been added.  If NO, IPv6
79	   functionality of interfaces with no corresponding
80	   $ifconfig_IF_ipv6 is disabled by using "inet6 ifdisabled" flag,
81	   and the default address selection policy of ip6addrctl(8)
82	   is the IPv4-preferred one (see rc.d/ip6addrctl for more details).
83	   Note that if you want to configure IPv6 functionality on the
84	   disabled interfaces after boot, first you need to clear the flag by
85	   using ifconfig(8) like:
86
87		ifconfig em0 inet6 -ifdisabled
88
89	   If YES, the default address selection policy is set as
90	   IPv6-preferred.
91
92	   The default value of $ipv6_prefer is NO.
93
94	4. If your system need to receive Router Advertisement messages,
95	   define "inet6 accept_rtadv" in $ifconfig_IF_ipv6.  The rc(8)
96	   scripts automatically invoke rtsol(8) when the interface becomes
97	   UP.  The Router Advertisement messages are used for SLAAC
98	   (State-Less Address AutoConfiguration).
99
10020090922:
101	802.11s D3.03 support was committed. This is incompatible with the
102	previous code, which was based on D3.0.
103
10420090912:
105	A sysctl variable net.inet6.ip6.accept_rtadv now sets the default value
106	of a per-interface flag ND6_IFF_ACCEPT_RTADV, not a global knob to
107	control whether accepting Router Advertisement messages or not.
108	Also, a per-interface flag ND6_IFF_AUTO_LINKLOCAL has been added and
109	a sysctl variable net.inet6.ip6.auto_linklocal is its default value.
110	The ifconfig(8) utility now supports these flags.
111
11220090910:
113	ZFS snapshots are now mounted with MNT_IGNORE flag. Use -v option for
114	mount(8) and -a option for df(1) to see them.
115
11620090825:
117	The old tunable hw.bus.devctl_disable has been superseded by
118	hw.bus.devctl_queue.  hw.bus.devctl_disable=1 in loader.conf should be
119	replaced by hw.bus.devctl_queue=0.  The default for this new tunable
120	is 1000.
121
12220090813:
123	Remove the option STOP_NMI.  The default action is now to use NMI only
124	for KDB via the newly introduced function stop_cpus_hard() and
125	maintain stop_cpus() to just use a normal IPI_STOP on ia32 and amd64.
126
12720090803:
128	The stable/8 branch created in subversion.  This corresponds to the
129	RELENG_8 branch in CVS.
130
13120090719:
132	Bump the shared library version numbers for all libraries that do not
133	use symbol versioning as part of the 8.0-RELEASE cycle.  Bump
134	__FreeBSD_version to 800105.
135
13620090714:
137	Due to changes in the implementation of virtual network stack support,
138	all network-related kernel modules must be recompiled.  As this change
139	breaks the ABI, bump __FreeBSD_version to 800104.
140
14120090713:
142	The TOE interface to the TCP syncache has been modified to remove
143	struct tcpopt (<netinet/tcp_var.h>) from the ABI of the network stack.
144	The cxgb driver is the only TOE consumer affected by this change, and
145	needs to be recompiled along with the kernel. As this change breaks
146	the ABI, bump __FreeBSD_version to 800103.
147
14820090712:
149	Padding has been added to struct tcpcb, sackhint and tcpstat in
150	<netinet/tcp_var.h> to facilitate future MFCs and bug fixes whilst
151	maintainig the ABI. However, this change breaks the ABI, so bump
152	__FreeBSD_version to 800102. User space tools that rely on the size of
153	any of these structs (e.g. sockstat) need to be recompiled.
154
15520090630:
156	The NFS_LEGACYRPC option has been removed along with the old kernel
157	RPC implementation that this option selected. Kernel configurations
158	may need to be adjusted.
159
16020090629:
161	The network interface device nodes at /dev/net/<interface> have been
162	removed.  All ioctl operations can be performed the normal way using
163	routing sockets.  The kqueue functionality can generally be replaced
164	with routing sockets.
165
16620090628:
167	The documentation from the FreeBSD Documentation Project (Handbook,
168	FAQ, etc.) is now installed via packages by sysinstall(8) and under
169	the /usr/local/share/doc/freebsd directory instead of /usr/share/doc.
170
17120090624:
172	The ABI of various structures related to the SYSV IPC API have been
173	changed.  As a result, the COMPAT_FREEBSD[456] and COMPAT_43 kernel
174	options now all require COMPAT_FREEBSD7.  Bump __FreeBSD_version to
175	800100.
176
17720090622:
178	Layout of struct vnet has changed as routing related variables were
179	moved to their own Vimage module. Modules need to be recompiled.  Bump
180	__FreeBSD_version to 800099.
181
18220090619:
183	NGROUPS_MAX and NGROUPS have been increased from 16 to 1023 and 1024
184	respectively.  As long as no more than 16 groups per process are used,
185	no changes should be visible.  When more than 16 groups are used, old
186	binaries may fail if they call getgroups() or getgrouplist() with
187	statically sized storage.  Recompiling will work around this, but
188	applications should be modified to use dynamically allocated storage
189	for group arrays as POSIX.1-2008 does not cap an implementation's
190	number of supported groups at NGROUPS_MAX+1 as previous versions did.
191
192	NFS and portalfs mounts may also be affected as the list of groups is
193	truncated to 16.  Users of NFS who use more than 16 groups, should
194	take care that negative group permissions are not used on the exported
195	file systems as they will not be reliable unless a GSSAPI based
196	authentication method is used.
197
19820090616:
199	The compiling option ADAPTIVE_LOCKMGRS has been introduced.  This
200	option compiles in the support for adaptive spinning for lockmgrs
201	which want to enable it.  The lockinit() function now accepts the flag
202	LK_ADAPTIVE in order to make the lock object subject to adaptive
203	spinning when both held in write and read mode.
204
20520090613:
206	The layout of the structure returned by IEEE80211_IOC_STA_INFO has
207	changed.  User applications that use this ioctl need to be rebuilt.
208
20920090611:
210	The layout of struct thread has changed.  Kernel and modules need to
211	be rebuilt.
212
21320090608:
214	The layout of structs ifnet, domain, protosw and vnet_net has changed.
215	Kernel modules need to be rebuilt.  Bump __FreeBSD_version to 800097.
216
21720090602:
218	window(1) has been removed from the base system. It can now be
219	installed from ports. The port is called misc/window.
220
22120090601:
222	The way we are storing and accessing `routing table' entries has
223	changed. Programs reading the FIB, like netstat, need to be
224	re-compiled.
225
22620090601:
227	A new netisr implementation has been added for FreeBSD 8.  Network
228	file system modules, such as igmp, ipdivert, and others, should be
229	rebuilt.
230	Bump __FreeBSD_version to 800096.
231
23220090530:
233	Remove the tunable/sysctl debug.mpsafevfs as its initial purpose is no
234	more valid.
235
23620090530:
237	Add VOP_ACCESSX(9).  File system modules need to be rebuilt.
238	Bump __FreeBSD_version to 800094.
239
24020090529:
241	Add mnt_xflag field to 'struct mount'.  File system modules need to be
242	rebuilt.
243	Bump __FreeBSD_version to 800093.
244
24520090528:
246	The compiling option ADAPTIVE_SX has been retired while it has been
247	introduced the option NO_ADAPTIVE_SX which handles the reversed logic.
248	The KPI for sx_init_flags() changes as accepting flags:
249	SX_ADAPTIVESPIN flag has been retired while the SX_NOADAPTIVE flag has
250	been introduced in order to handle the reversed logic.
251	Bump __FreeBSD_version to 800092.
252
25320090527:
254	Add support for hierarchical jails.  Remove global securelevel.
255	Bump __FreeBSD_version to 800091.
256
25720090523:
258	The layout of struct vnet_net has changed, therefore modules
259	need to be rebuilt.
260	Bump __FreeBSD_version to 800090.
261
26220090523:
263	The newly imported zic(8) produces a new format in the output. Please
264	run tzsetup(8) to install the newly created data to /etc/localtime.
265
26620090520:
267	The sysctl tree for the usb stack has renamed from hw.usb2.* to
268	hw.usb.* and is now consistent again with previous releases.
269
27020090520:
271	802.11 monitor mode support was revised and driver api's were changed.
272	Drivers dependent on net80211 now support DLT_IEEE802_11_RADIO instead
273	of DLT_IEEE802_11.  No user-visible data structures were changed but
274	applications that use DLT_IEEE802_11 may require changes.
275	Bump __FreeBSD_version to 800088.
276
27720090430:
278	The layout of the following structs has changed: sysctl_oid,
279	socket, ifnet, inpcbinfo, tcpcb, syncache_head, vnet_inet,
280	vnet_inet6 and vnet_ipfw.  Most modules need to be rebuild or
281	panics may be experienced.  World rebuild is required for
282	correctly checking networking state from userland.
283	Bump __FreeBSD_version to 800085.
284
28520090429:
286	MLDv2 and Source-Specific Multicast (SSM) have been merged
287	to the IPv6 stack. VIMAGE hooks are in but not yet used.
288	The implementation of SSM within FreeBSD's IPv6 stack closely
289	follows the IPv4 implementation.
290
291	For kernel developers:
292
293	* The most important changes are that the ip6_output() and
294	  ip6_input() paths no longer take the IN6_MULTI_LOCK,
295	  and this lock has been downgraded to a non-recursive mutex.
296
297	* As with the changes to the IPv4 stack to support SSM, filtering
298	  of inbound multicast traffic must now be performed by transport
299	  protocols within the IPv6 stack. This does not apply to TCP and
300	  SCTP, however, it does apply to UDP in IPv6 and raw IPv6.
301
302	* The KPIs used by IPv6 multicast are similar to those used by
303	  the IPv4 stack, with the following differences:
304	   * im6o_mc_filter() is analogous to imo_multicast_filter().
305	   * The legacy KAME entry points in6_joingroup and in6_leavegroup()
306	     are shimmed to in6_mc_join() and in6_mc_leave() respectively.
307	   * IN6_LOOKUP_MULTI() has been deprecated and removed.
308	   * IPv6 relies on MLD for the DAD mechanism. KAME's internal KPIs
309	     for MLDv1 have an additional 'timer' argument which is used to
310	     jitter the initial membership report for the solicited-node
311	     multicast membership on-link.
312	   * This is not strictly needed for MLDv2, which already jitters
313	     its report transmissions.  However, the 'timer' argument is
314	     preserved in case MLDv1 is active on the interface.
315
316	* The KAME linked-list based IPv6 membership implementation has
317	  been refactored to use a vector similar to that used by the IPv4
318	  stack.
319	  Code which maintains a list of its own multicast memberships
320	  internally, e.g. carp, has been updated to reflect the new
321	  semantics.
322
323	* There is a known Lock Order Reversal (LOR) due to in6_setscope()
324	  acquiring the IF_AFDATA_LOCK and being called within ip6_output().
325	  Whilst MLDv2 tries to avoid this otherwise benign LOR, it is an
326	  implementation constraint which needs to be addressed in HEAD.
327
328	For application developers:
329
330	* The changes are broadly similar to those made for the IPv4
331	  stack.
332
333	* The use of IPv4 and IPv6 multicast socket options on the same
334	  socket, using mapped addresses, HAS NOT been tested or supported.
335
336	* There are a number of issues with the implementation of various
337	  IPv6 multicast APIs which need to be resolved in the API surface
338	  before the implementation is fully compatible with KAME userland
339	  use, and these are mostly to do with interface index treatment.
340
341	* The literature available discusses the use of either the delta / ASM
342	  API with setsockopt(2)/getsockopt(2), or the full-state / ASM API
343	  using setsourcefilter(3)/getsourcefilter(3). For more information
344	  please refer to RFC 3768, 'Socket Interface Extensions for
345	  Multicast Source Filters'.
346
347	* Applications which use the published RFC 3678 APIs should be fine.
348
349	For systems administrators:
350
351	* The mtest(8) utility has been refactored to support IPv6, in
352	  addition to IPv4. Interface addresses are no longer accepted
353	  as arguments, their names must be used instead. The utility
354	  will map the interface name to its first IPv4 address as
355	  returned by getifaddrs(3).
356
357	* The ifmcstat(8) utility has also been updated to print the MLDv2
358	  endpoint state and source filter lists via sysctl(3).
359
360	* The net.inet6.ip6.mcast.loop sysctl may be tuned to 0 to disable
361	  loopback of IPv6 multicast datagrams by default; it defaults to 1
362	  to preserve the existing behaviour. Disabling multicast loopback is
363	  recommended for optimal system performance.
364
365	* The IPv6 MROUTING code has been changed to examine this sysctl
366	  instead of attempting to perform a group lookup before looping
367	  back forwarded datagrams.
368
369	Bump __FreeBSD_version to 800084.
370
37120090422:
372	Implement low-level Bluetooth HCI API.
373	Bump __FreeBSD_version to 800083.
374
37520090419:
376	The layout of struct malloc_type, used by modules to register new
377	memory allocation types, has changed.  Most modules will need to
378	be rebuilt or panics may be experienced.
379	Bump __FreeBSD_version to 800081.
380
38120090415:
382	Anticipate overflowing inp_flags - add inp_flags2.
383	This changes most offsets in inpcb, so checking v4 connection
384	state will require a world rebuild.
385	Bump __FreeBSD_version to 800080.
386
38720090415:
388	Add an llentry to struct route and struct route_in6. Modules
389	embedding a struct route will need to be recompiled.
390	Bump __FreeBSD_version to 800079.
391
39220090414:
393	The size of rt_metrics_lite and by extension rtentry has changed.
394	Networking administration apps will need to be recompiled.
395	The route command now supports show as an alias for get, weighting
396	of routes, sticky and nostick flags to alter the behavior of stateful
397	load balancing.
398	Bump __FreeBSD_version to 800078.
399
40020090408:
401	Do not use Giant for kbdmux(4) locking. This is wrong and
402	apparently causing more problems than it solves. This will
403	re-open the issue where interrupt handlers may race with
404	kbdmux(4) in polling mode. Typical symptoms include (but
405	not limited to) duplicated and/or missing characters when
406	low level console functions (such as gets) are used while
407	interrupts are enabled (for example geli password prompt,
408	mountroot prompt etc.). Disabling kbdmux(4) may help.
409
41020090407:
411	The size of structs vnet_net, vnet_inet and vnet_ipfw has changed;
412	kernel modules referencing any of the above need to be recompiled.
413	Bump __FreeBSD_version to 800075.
414
41520090320:
416	GEOM_PART has become the default partition slicer for storage devices,
417	replacing GEOM_MBR, GEOM_BSD, GEOM_PC98 and GEOM_GPT slicers. It
418	introduces some changes:
419
420	MSDOS/EBR: the devices created from MSDOS extended partition entries
421	(EBR) can be named differently than with GEOM_MBR and are now symlinks
422	to devices with offset-based names. fstabs may need to be modified.
423
424	BSD: the "geometry does not match label" warning is harmless in most
425	cases but it points to problems in file system misalignment with
426	disk geometry. The "c" partition is now implicit, covers the whole
427	top-level drive and cannot be (mis)used by users.
428
429	General: Kernel dumps are now not allowed to be written to devices
430	whose partition types indicate they are meant to be used for file
431	systems (or, in case of MSDOS partitions, as something else than
432	the "386BSD" type).
433
434	Most of these changes date approximately from 200812.
435
43620090319:
437	The uscanner(4) driver has been removed from the kernel. This follows
438	Linux removing theirs in 2.6 and making libusb the default interface
439	(supported by sane).
440
44120090319:
442	The multicast forwarding code has been cleaned up. netstat(1)
443	only relies on KVM now for printing bandwidth upcall meters.
444	The IPv4 and IPv6 modules are split into ip_mroute_mod and
445	ip6_mroute_mod respectively. The config(5) options for statically
446	compiling this code remain the same, i.e. 'options MROUTING'.
447
44820090315:
449	Support for the IFF_NEEDSGIANT network interface flag has been
450	removed, which means that non-MPSAFE network device drivers are no
451	longer supported.  In particular, if_ar, if_sr, and network device
452	drivers from the old (legacy) USB stack can no longer be built or
453	used.
454
45520090313:
456	POSIX.1 Native Language Support (NLS) has been enabled in libc and
457	a bunch of new language catalog files have also been added.
458	This means that some common libc messages are now localized and
459	they depend on the LC_MESSAGES environmental variable.
460
46120090313:
462	The k8temp(4) driver has been renamed to amdtemp(4) since
463	support for K10 and K11 CPU families was added.
464
46520090309:
466	IGMPv3 and Source-Specific Multicast (SSM) have been merged
467	to the IPv4 stack. VIMAGE hooks are in but not yet used.
468
469	For kernel developers, the most important changes are that the
470	ip_output() and ip_input() paths no longer take the IN_MULTI_LOCK(),
471	and this lock has been downgraded to a non-recursive mutex.
472
473	Transport protocols (UDP, Raw IP) are now responsible for filtering
474	inbound multicast traffic according to group membership and source
475	filters. The imo_multicast_filter() KPI exists for this purpose.
476	Transports which do not use multicast (SCTP, TCP) already reject
477	multicast by default. Forwarding and receive performance may improve
478	as a mutex acquisition is no longer needed in the ip_input()
479	low-level input path.  in_addmulti() and in_delmulti() are shimmed
480	to new KPIs which exist to support SSM in-kernel.
481
482	For application developers, it is recommended that loopback of
483	multicast datagrams be disabled for best performance, as this
484	will still cause the lock to be taken for each looped-back
485	datagram transmission. The net.inet.ip.mcast.loop sysctl may
486	be tuned to 0 to disable loopback by default; it defaults to 1
487	to preserve the existing behaviour.
488
489	For systems administrators, to obtain best performance with
490	multicast reception and multiple groups, it is always recommended
491	that a card with a suitably precise hash filter is used. Hash
492	collisions will still result in the lock being taken within the
493	transport protocol input path to check group membership.
494
495	If deploying FreeBSD in an environment with IGMP snooping switches,
496	it is recommended that the net.inet.igmp.sendlocal sysctl remain
497	enabled; this forces 224.0.0.0/24 group membership to be announced
498	via IGMP.
499
500	The size of 'struct igmpstat' has changed; netstat needs to be
501	recompiled to reflect this.
502	Bump __FreeBSD_version to 800070.
503
50420090309:
505	libusb20.so.1 is now installed as libusb.so.1 and the ports system
506	updated to use it. This requires a buildworld/installworld in order to
507	update the library and dependencies (usbconfig, etc). Its advisable to
508	rebuild all ports which uses libusb. More specific directions are given
509	in the ports collection UPDATING file. Any /etc/libmap.conf entries for
510	libusb are no longer required and can be removed.
511
51220090302:
513	A workaround is committed to allow the creation of System V shared
514	memory segment of size > 2 GB on the 64-bit architectures.
515	Due to a limitation of the existing ABI, the shm_segsz member
516	of the struct shmid_ds, returned by shmctl(IPC_STAT) call is
517	wrong for large segments. Note that limits must be explicitly
518	raised to allow such segments to be created.
519
52020090301:
521	The layout of struct ifnet has changed, requiring a rebuild of all
522	network device driver modules.
523
52420090227:
525	The /dev handling for the new USB stack has changed, a
526	buildworld/installworld is required for libusb20.
527
52820090223:
529	The new USB2 stack has now been permanently moved in and all kernel and
530	module names reverted to their previous values (eg, usb, ehci, ohci,
531	ums, ...).  The old usb stack can be compiled in by prefixing the name
532	with the letter 'o', the old usb modules have been removed.
533	Updating entry 20090216 for xorg and 20090215 for libmap may still
534	apply.
535
53620090217:
537	The rc.conf(5) option if_up_delay has been renamed to
538	defaultroute_delay to better reflect its purpose. If you have
539	customized this setting in /etc/rc.conf you need to update it to
540	use the new name.
541
54220090216:
543	xorg 7.4 wants to configure its input devices via hald which does not
544	yet work with USB2. If the keyboard/mouse does not work in xorg then
545	add
546		Option "AllowEmptyInput" "off"
547	to your ServerLayout section.  This will cause X to use the configured
548	kbd and mouse sections from your xorg.conf.
549
55020090215:
551	The GENERIC kernels for all architectures now default to the new USB2
552	stack. No kernel config options or code have been removed so if a
553	problem arises please report it and optionally revert to the old USB
554	stack. If you are loading USB kernel modules or have a custom kernel
555	that includes GENERIC then ensure that usb names are also changed over,
556	eg uftdi -> usb2_serial_ftdi.
557
558	Older programs linked against the ports libusb 0.1 need to be
559	redirected to the new stack's libusb20.  /etc/libmap.conf can
560	be used for this:
561		# Map old usb library to new one for usb2 stack
562		libusb-0.1.so.8	libusb20.so.1
563
56420090209:
565	All USB ethernet devices now attach as interfaces under the name ueN
566	(eg. ue0). This is to provide a predictable name as vendors often
567	change usb chipsets in a product without notice.
568
56920090203:
570	The ichsmb(4) driver has been changed to require SMBus slave
571	addresses be left-justified (xxxxxxx0b) rather than right-justified.
572	All of the other SMBus controller drivers require left-justified
573	slave addresses, so this change makes all the drivers provide the
574	same interface.
575
57620090201:
577	INET6 statistics (struct ip6stat) was updated.
578	netstat(1) needs to be recompiled.
579
58020090119:
581	NTFS has been removed from GENERIC kernel on amd64 to match
582	GENERIC on i386. Should not cause any issues since mount_ntfs(8)
583	will load ntfs.ko module automatically when NTFS support is
584	actually needed, unless ntfs.ko is not installed or security
585	level prohibits loading kernel modules. If either is the case,
586	"options NTFS" has to be added into kernel config.
587
58820090115:
589	TCP Appropriate Byte Counting (RFC 3465) support added to kernel.
590	New field in struct tcpcb breaks ABI, so bump __FreeBSD_version to
591	800061. User space tools that rely on the size of struct tcpcb in
592	tcp_var.h (e.g. sockstat) need to be recompiled.
593
59420081225:
595	ng_tty(4) module updated to match the new TTY subsystem.
596	Due to API change, user-level applications must be updated.
597	New API support added to mpd5 CVS and expected to be present
598	in next mpd5.3 release.
599
60020081219:
601	With __FreeBSD_version 800060 the makefs tool is part of
602	the base system (it was a port).
603
60420081216:
605	The afdata and ifnet locks have been changed from mutexes to
606	rwlocks, network modules will need to be re-compiled.
607
60820081214:
609	__FreeBSD_version 800059 incorporates the new arp-v2 rewrite.
610	RTF_CLONING, RTF_LLINFO and RTF_WASCLONED flags are eliminated.
611	The new code reduced struct rtentry{} by 16 bytes on 32-bit
612	architecture and 40 bytes on 64-bit architecture. The userland
613	applications "arp" and "ndp" have been updated accordingly.
614	The output from "netstat -r" shows only routing entries and
615	none of the L2 information.
616
61720081130:
618	__FreeBSD_version 800057 marks the switchover from the
619	binary ath hal to source code. Users must add the line:
620
621	options	AH_SUPPORT_AR5416
622
623	to their kernel config files when specifying:
624
625	device	ath_hal
626
627	The ath_hal module no longer exists; the code is now compiled
628	together with the driver in the ath module.  It is now
629	possible to tailor chip support (i.e. reduce the set of chips
630	and thereby the code size); consult ath_hal(4) for details.
631
63220081121:
633	__FreeBSD_version 800054 adds memory barriers to
634	<machine/atomic.h>, new interfaces to ifnet to facilitate
635	multiple hardware transmit queues for cards that support
636	them, and a lock-less ring-buffer implementation to
637	enable drivers to more efficiently manage queueing of
638	packets.
639
64020081117:
641	A new version of ZFS (version 13) has been merged to -HEAD.
642	This version has zpool attribute "listsnapshots" off by
643	default, which means "zfs list" does not show snapshots,
644	and is the same as Solaris behavior.
645
64620081028:
647	dummynet(4) ABI has changed. ipfw(8) needs to be recompiled.
648
64920081009:
650	The uhci, ohci, ehci and slhci USB Host controller drivers have
651	been put into separate modules. If you load the usb module
652	separately through loader.conf you will need to load the
653	appropriate *hci module as well. E.g. for a UHCI-based USB 2.0
654	controller add the following to loader.conf:
655
656		uhci_load="YES"
657		ehci_load="YES"
658
65920081009:
660	The ABI used by the PMC toolset has changed.  Please keep
661	userland (libpmc(3)) and the kernel module (hwpmc(4)) in
662	sync.
663
66420081009:
665	atapci kernel module now includes only generic PCI ATA
666	driver. AHCI driver moved to ataahci kernel module.
667	All vendor-specific code moved into separate kernel modules:
668	ataacard, ataacerlabs, ataadaptec, ataamd, ataati, atacenatek,
669	atacypress, atacyrix, atahighpoint, ataintel, ataite, atajmicron,
670	atamarvell, atamicron, atanational, atanetcell, atanvidia,
671	atapromise, ataserverworks, atasiliconimage, atasis, atavia
672
67320080820:
674	The TTY subsystem of the kernel has been replaced by a new
675	implementation, which provides better scalability and an
676	improved driver model. Most common drivers have been migrated to
677	the new TTY subsystem, while others have not. The following
678	drivers have not yet been ported to the new TTY layer:
679
680	PCI/ISA:
681		cy, digi, rc, rp, sio
682
683	USB:
684		ubser, ucycom
685
686	Line disciplines:
687		ng_h4, ng_tty, ppp, sl, snp
688
689	Adding these drivers to your kernel configuration file shall
690	cause compilation to fail.
691
69220080818:
693	ntpd has been upgraded to 4.2.4p5.
694
69520080801:
696	OpenSSH has been upgraded to 5.1p1.
697
698	For many years, FreeBSD's version of OpenSSH preferred DSA
699	over RSA for host and user authentication keys.  With this
700	upgrade, we've switched to the vendor's default of RSA over
701	DSA.  This may cause upgraded clients to warn about unknown
702	host keys even for previously known hosts.  Users should
703	follow the usual procedure for verifying host keys before
704	accepting the RSA key.
705
706	This can be circumvented by setting the "HostKeyAlgorithms"
707	option to "ssh-dss,ssh-rsa" in ~/.ssh/config or on the ssh
708	command line.
709
710	Please note that the sequence of keys offered for
711	authentication has been changed as well.  You may want to
712	specify IdentityFile in a different order to revert this
713	behavior.
714
71520080713:
716	The sio(4) driver has been removed from the i386 and amd64
717	kernel configuration files. This means uart(4) is now the
718	default serial port driver on those platforms as well.
719
720	To prevent collisions with the sio(4) driver, the uart(4) driver
721	uses different names for its device nodes. This means the
722	onboard serial port will now most likely be called "ttyu0"
723	instead of "ttyd0". You may need to reconfigure applications to
724	use the new device names.
725
726	When using the serial port as a boot console, be sure to update
727	/boot/device.hints and /etc/ttys before booting the new kernel.
728	If you forget to do so, you can still manually specify the hints
729	at the loader prompt:
730
731		set hint.uart.0.at="isa"
732		set hint.uart.0.port="0x3F8"
733		set hint.uart.0.flags="0x10"
734		set hint.uart.0.irq="4"
735		boot -s
736
73720080609:
738	The gpt(8) utility has been removed. Use gpart(8) to partition
739	disks instead.
740
74120080603:
742	The version that Linuxulator emulates was changed from 2.4.2
743	to 2.6.16. If you experience any problems with Linux binaries
744	please try to set sysctl compat.linux.osrelease to 2.4.2 and
745	if it fixes the problem contact emulation mailing list.
746
74720080525:
748	ISDN4BSD (I4B) was removed from the src tree. You may need to
749	update a your kernel configuration and remove relevant entries.
750
75120080509:
752	I have checked in code to support multiple routing tables.
753	See the man pages setfib(1) and setfib(2).
754	This is a hopefully backwards compatible version,
755	but to make use of it you need to compile your kernel
756	with options ROUTETABLES=2 (or more up to 16).
757
75820080420:
759	The 802.11 wireless support was redone to enable multi-bss
760	operation on devices that are capable.  The underlying device
761	is no longer used directly but instead wlanX devices are
762	cloned with ifconfig.  This requires changes to rc.conf files.
763	For example, change:
764		ifconfig_ath0="WPA DHCP"
765	to
766		wlans_ath0=wlan0
767		ifconfig_wlan0="WPA DHCP"
768	see rc.conf(5) for more details.  In addition, mergemaster of
769	/etc/rc.d is highly recommended.  Simultaneous update of userland
770	and kernel wouldn't hurt either.
771
772	As part of the multi-bss changes the wlan_scan_ap and wlan_scan_sta
773	modules were merged into the base wlan module.  All references
774	to these modules (e.g. in kernel config files) must be removed.
775
77620080408:
777	psm(4) has gained write(2) support in native operation level.
778	Arbitrary commands can be written to /dev/psm%d and status can
779	be read back from it.  Therefore, an application is responsible
780	for status validation and error recovery.  It is a no-op in
781	other operation levels.
782
78320080312:
784	Support for KSE threading has been removed from the kernel.  To
785	run legacy applications linked against KSE libmap.conf may
786	be used.  The following libmap.conf may be used to ensure
787	compatibility with any prior release:
788
789	libpthread.so.1 libthr.so.1
790	libpthread.so.2 libthr.so.2
791	libkse.so.3 libthr.so.3
792
79320080301:
794	The layout of struct vmspace has changed. This affects libkvm
795	and any executables that link against libkvm and use the
796	kvm_getprocs() function. In particular, but not exclusively,
797	it affects ps(1), fstat(1), pkill(1), systat(1), top(1) and w(1).
798	The effects are minimal, but it's advisable to upgrade world
799	nonetheless.
800
80120080229:
802	The latest em driver no longer has support in it for the
803	82575 adapter, this is now moved to the igb driver. The
804	split was done to make new features that are incompatible
805	with older hardware easier to do.
806
80720080220:
808	The new geom_lvm(4) geom class has been renamed to geom_linux_lvm(4),
809	likewise the kernel option is now GEOM_LINUX_LVM.
810
81120080211:
812	The default NFS mount mode has changed from UDP to TCP for
813	increased reliability.  If you rely on (insecurely) NFS
814	mounting across a firewall you may need to update your
815	firewall rules.
816
81720080208:
818	Belatedly note the addition of m_collapse for compacting
819	mbuf chains.
820
82120080126:
822	The fts(3) structures have been changed to use adequate
823	integer types for their members and so to be able to cope
824	with huge file trees.  The old fts(3) ABI is preserved
825	through symbol versioning in libc, so third-party binaries
826	using fts(3) should still work, although they will not take
827	advantage of the extended types.  At the same time, some
828	third-party software might fail to build after this change
829	due to unportable assumptions made in its source code about
830	fts(3) structure members.  Such software should be fixed
831	by its vendor or, in the worst case, in the ports tree.
832	FreeBSD_version 800015 marks this change for the unlikely
833	case that a portable fix is impossible.
834
83520080123:
836	To upgrade to -current after this date, you must be running
837	FreeBSD not older than 6.0-RELEASE.  Upgrading to -current
838	from 5.x now requires a stop over at RELENG_6 or RELENG_7 systems.
839
84020071128:
841	The ADAPTIVE_GIANT kernel option has been retired because its
842	functionality is the default now.
843
84420071118:
845	The AT keyboard emulation of sunkbd(4) has been turned on
846	by default. In order to make the special symbols of the Sun
847	keyboards driven by sunkbd(4) work under X these now have
848	to be configured the same way as Sun USB keyboards driven
849	by ukbd(4) (which also does AT keyboard emulation), f.e.:
850
851	Option	"XkbLayout" "us"
852	Option	"XkbRules" "xorg"
853	Option	"XkbSymbols" "pc(pc105)+sun_vndr/usb(sun_usb)+us"
854
85520071024:
856	It has been decided that it is desirable to provide ABI
857	backwards compatibility to the FreeBSD 4/5/6 versions of the
858	PCIOCGETCONF, PCIOCREAD and PCIOCWRITE IOCTLs, which was
859	broken with the introduction of PCI domain support (see the
860	20070930 entry). Unfortunately, this required the ABI of
861	PCIOCGETCONF to be broken again in order to be able to
862	provide backwards compatibility to the old version of that
863	IOCTL. Thus consumers of PCIOCGETCONF have to be recompiled
864	again. As for prominent ports this affects neither pciutils
865	nor xorg-server this time, the hal port needs to be rebuilt
866	however.
867
86820071020:
869	The misnamed kthread_create() and friends have been renamed
870	to kproc_create() etc. Many of the callers already
871	used kproc_start()..
872	I will return kthread_create() and friends in a while
873	with implementations that actually create threads, not procs.
874	Renaming corresponds with version 800002.
875
87620071010:
877	RELENG_7 branched.
878
879COMMON ITEMS:
880
881	General Notes
882	-------------
883	Avoid using make -j when upgrading.  While generally safe, there are
884	sometimes problems using -j to upgrade.  If your upgrade fails with
885	-j, please try again wtihout -j.  From time to time in the past there
886	have been problems using -j with buildworld and/or installworld.  This
887	is especially true when upgrading between "distant" versions (eg one
888	that cross a major release boundary or several minor releases, or when
889	several months have passed on the -current branch).
890
891	Sometimes, obscure build problems are the result of environment
892	poisoning.  This can happen because the make utility reads its
893	environment when searching for values for global variables.  To run
894	your build attempts in an "environmental clean room", prefix all make
895	commands with 'env -i '.  See the env(1) manual page for more details.
896
897	When upgrading from one major version to another it is generally best
898	to upgrade to the latest code in the currently installed branch first,
899	then do an upgrade to the new branch. This is the best-tested upgrade
900	path, and has the highest probability of being successful.  Please try
901	this approach before reporting problems with a major version upgrade.
902
903	To build a kernel
904	-----------------
905	If you are updating from a prior version of FreeBSD (even one just
906	a few days old), you should follow this procedure.  It is the most
907	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
908
909	make kernel-toolchain
910	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
911	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
912
913	To test a kernel once
914	---------------------
915	If you just want to boot a kernel once (because you are not sure
916	if it works, or if you want to boot a known bad kernel to provide
917	debugging information) run
918	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
919	nextboot -k testkernel
920
921	To just build a kernel when you know that it won't mess you up
922	--------------------------------------------------------------
923	This assumes you are already running a CURRENT system.  Replace
924	${arch} with the architecture of your machine (e.g. "i386",
925	"arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
926
927	cd src/sys/${arch}/conf
928	config KERNEL_NAME_HERE
929	cd ../compile/KERNEL_NAME_HERE
930	make depend
931	make
932	make install
933
934	If this fails, go to the "To build a kernel" section.
935
936	To rebuild everything and install it on the current system.
937	-----------------------------------------------------------
938	# Note: sometimes if you are running current you gotta do more than
939	# is listed here if you are upgrading from a really old current.
940
941	<make sure you have good level 0 dumps>
942	make buildworld
943	make kernel KERNCONF=YOUR_KERNEL_HERE
944							[1]
945	<reboot in single user>				[3]
946	mergemaster -p					[5]
947	make installworld
948	make delete-old
949	mergemaster					[4]
950	<reboot>
951
952
953	To cross-install current onto a separate partition
954	--------------------------------------------------
955	# In this approach we use a separate partition to hold
956	# current's root, 'usr', and 'var' directories.   A partition
957	# holding "/", "/usr" and "/var" should be about 2GB in
958	# size.
959
960	<make sure you have good level 0 dumps>
961	<boot into -stable>
962	make buildworld
963	make buildkernel KERNCONF=YOUR_KERNEL_HERE
964	<maybe newfs current's root partition>
965	<mount current's root partition on directory ${CURRENT_ROOT}>
966	make installworld DESTDIR=${CURRENT_ROOT}
967	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
968	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
969	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
970	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
971	<reboot into current>
972	<do a "native" rebuild/install as described in the previous section>
973	<maybe install compatibility libraries from ports/misc/compat*>
974	<reboot>
975
976
977	To upgrade in-place from 8.x-stable to current
978	----------------------------------------------
979	<make sure you have good level 0 dumps>
980	make buildworld					[9]
981	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
982							[1]
983	<reboot in single user>				[3]
984	mergemaster -p					[5]
985	make installworld
986	make delete-old
987	mergemaster -i					[4]
988	<reboot>
989
990	Make sure that you've read the UPDATING file to understand the
991	tweaks to various things you need.  At this point in the life
992	cycle of current, things change often and you are on your own
993	to cope.  The defaults can also change, so please read ALL of
994	the UPDATING entries.
995
996	Also, if you are tracking -current, you must be subscribed to
997	freebsd-current@freebsd.org.  Make sure that before you update
998	your sources that you have read and understood all the recent
999	messages there.  If in doubt, please track -stable which has
1000	much fewer pitfalls.
1001
1002	[1] If you have third party modules, such as vmware, you
1003	should disable them at this point so they don't crash your
1004	system on reboot.
1005
1006	[3] From the bootblocks, boot -s, and then do
1007		fsck -p
1008		mount -u /
1009		mount -a
1010		cd src
1011		adjkerntz -i		# if CMOS is wall time
1012	Also, when doing a major release upgrade, it is required that
1013	you boot into single user mode to do the installworld.
1014
1015	[4] Note: This step is non-optional.  Failure to do this step
1016	can result in a significant reduction in the functionality of the
1017	system.  Attempting to do it by hand is not recommended and those
1018	that pursue this avenue should read this file carefully, as well
1019	as the archives of freebsd-current and freebsd-hackers mailing lists
1020	for potential gotchas.
1021
1022	[5] Usually this step is a noop.  However, from time to time
1023	you may need to do this if you get unknown user in the following
1024	step.  It never hurts to do it all the time.  You may need to
1025	install a new mergemaster (cd src/usr.sbin/mergemaster && make
1026	install) after the buildworld before this step if you last updated
1027	from current before 20020224 or from -stable before 20020408.
1028
1029	[8] In order to have a kernel that can run the 4.x binaries needed to
1030	do an installworld, you must include the COMPAT_FREEBSD4 option in
1031	your kernel.  Failure to do so may leave you with a system that is
1032	hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1033	required to run the 5.x binaries on more recent kernels.  And so on
1034	for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1035
1036	Make sure that you merge any new devices from GENERIC since the
1037	last time you updated your kernel config file.
1038
1039	[9] When checking out sources, you must include the -P flag to have
1040	cvs prune empty directories.
1041
1042	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1043	"?=" instead of the "=" assignment operator, so that buildworld can
1044	override the CPUTYPE if it needs to.
1045
1046	MAKEOBJDIRPREFIX must be defined in an environment variable, and
1047	not on the command line, or in /etc/make.conf.  buildworld will
1048	warn if it is improperly defined.
1049FORMAT:
1050
1051This file contains a list, in reverse chronological order, of major
1052breakages in tracking -current.  Not all things will be listed here,
1053and it only starts on October 16, 2004.  Updating files can found in
1054previous releases if your system is older than this.
1055
1056Copyright information:
1057
1058Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1059
1060Redistribution, publication, translation and use, with or without
1061modification, in full or in part, in any form or format of this
1062document are permitted without further permission from the author.
1063
1064THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1065IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1066WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1067DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1068INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1069(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1070SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1071HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1072STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1073IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1074POSSIBILITY OF SUCH DAMAGE.
1075
1076Contact Warner Losh if you have any questions about your use of
1077this document.
1078
1079$FreeBSD$
1080