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