xref: /freebsd/UPDATING (revision d0bd1251350a0564fb20f0044f061f1c6b6079c2)
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
9    http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
10
11Items affecting the ports and packages system can be found in
12/usr/ports/UPDATING.  Please read that file before running portupgrade.
13
14NOTE: FreeBSD has switched from gcc to clang. If you have trouble bootstrapping
15from older versions of FreeBSD, try WITHOUT_CLANG and WITH_GCC to bootstrap to
16the tip of head, and then rebuild without this option. The bootstrap process from
17older version of current across the gcc/clang cutover is a bit fragile.
18
19NOTE TO PEOPLE WHO THINK THAT FreeBSD 11.x IS SLOW:
20	FreeBSD 11.x has many debugging features turned on, in both the kernel
21	and userland.  These features attempt to detect incorrect use of
22	system primitives, and encourage loud failure through extra sanity
23	checking and fail stop semantics.  They also substantially impact
24	system performance.  If you want to do performance measurement,
25	benchmarking, and optimization, you'll want to turn them off.  This
26	includes various WITNESS- related kernel options, INVARIANTS, malloc
27	debugging flags in userland, and various verbose features in the
28	kernel.  Many developers choose to disable these features on build
29	machines to maximize performance.  (To completely disable malloc
30	debugging, define MALLOC_PRODUCTION in /etc/make.conf, or to merely
31	disable the most expensive debugging functionality run
32	"ln -s 'abort:false,junk:false' /etc/malloc.conf".)
33
3420141222:
35	The old NFS client and server (kernel options NFSCLIENT, NFSSERVER)
36	kernel sources have been removed. The .h files remain, since some
37	utilities include them. This will need to be fixed later.
38	If "mount -t oldnfs ..." is attempted, it will fail.
39	If the "-o" option on mountd(8), nfsd(8) or nfsstat(1) is used,
40	the utilities will report errors.
41
4220141121:
43	The handling of LOCAL_LIB_DIRS has been altered to skip addition of
44	directories to top level SUBDIR variable when their parent
45	directory is included in LOCAL_DIRS.  Users with build systems with
46	such hierarchies and without SUBDIR entries in the parent
47	directory Makefiles should add them or add the directories to
48	LOCAL_DIRS.
49
5020141109:
51	faith(4) and faithd(8) has been removed from base system. It
52	has been obsolete for a very long time.
53
5420141104:
55	vt(4), the new console driver, is enabled by default. It brings
56	support for Unicode and double-width characters, as well as
57	support for UEFI and integration with the KMS kernel video
58	drivers.
59
60	You may need to update your console settings in /etc/rc.conf,
61	most probably the keymap. During boot, /etc/rc.d/syscons will
62	indicate what you need to do.
63
64	vt(4) still has issues and lacks some features compared to
65	syscons(4). See the wiki for up-to-date information:
66	  https://wiki.freebsd.org/Newcons
67
68	If you want to keep using syscons(4), you can do so by adding
69	the following line to /boot/loader.conf:
70	  kern.vty=sc
71
7220141102:
73	pjdfstest has been integrated into kyua as an opt-in test suite.
74	Please see share/doc/pjdfstest/README for a more details on how to
75	execute it.
76
7720141009:
78	gperf has been removed from the base system for architectures
79	that use clang. Ports that require gperf will obtain it from the
80	devel/gperf port.
81
8220140923:
83	pjdfstest has been moved from tools/regression/pjdfstest to
84	contrib/pjdfstest .
85
8620140922:
87	At svn r271982, The default linux compat kernel ABI has been adjusted
88	to 2.6.18 in support of the linux-c6 compat ports infrastructure
89	update.  If you wish to continue using the linux-f10 compat ports,
90	add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
91	encouraged to update their linux-compat packages to linux-c6 during
92	their next update cycle.
93
9420140729:
95	The ofwfb driver, used to provide a graphics console on PowerPC when
96	using vt(4), no longer allows mmap() of all of physical memory. This
97	will prevent Xorg on PowerPC with some ATI graphics cards from
98	initializing properly unless x11-servers/xorg-server is updated to
99	1.12.4_8 or newer.
100
10120140723:
102	The xdev targets have been converted to using TARGET and
103	TARGET_ARCH instead of XDEV and XDEV_ARCH.
104
10520140719:
106	The default unbound configuration has been modified to address
107	issues with reverse lookups on networks that use private
108	address ranges.  If you use the local_unbound service, run
109	"service local_unbound setup" as root to regenerate your
110	configuration, then "service local_unbound reload" to load the
111	new configuration.
112
11320140709:
114	The GNU texinfo and GNU info pages are not built and installed
115	anymore, WITH_INFO knob has been added to allow to built and install
116	them again.
117
11820140708:
119	The GNU readline library is now an INTERNALLIB - that is, it is
120	statically linked into consumers (GDB and variants) in the base
121	system, and the shared library is no longer installed.  The
122	devel/readline port is available for third party software that
123	requires readline.
124
12520140702:
126	The Itanium architecture (ia64) has been removed from the list of
127	known architectures. This is the first step in the removal of the
128	architecture.
129
13020140701:
131	Commit r268115 has added NFSv4.1 server support, merged from
132	projects/nfsv4.1-server.  Since this includes changes to the
133	internal interfaces between the NFS related modules, a full
134	build of the kernel and modules will be necessary.
135	__FreeBSD_version has been bumped.
136
13720140629:
138	The WITHOUT_VT_SUPPORT kernel config knob has been renamed
139	WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
140	which differs from the behaviour controlled by this knob.)
141
14220140619:
143	Maximal length of the serial number in CTL was increased from 16 to
144	64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
145	and ctld, need to be rebuilt to work with a new kernel.
146
14720140606:
148	The libatf-c and libatf-c++ major versions were downgraded to 0 and
149	1 respectively to match the upstream numbers.  They were out of
150	sync because, when they were originally added to FreeBSD, the
151	upstream versions were not respected.  These libraries are private
152	and not yet built by default, so renumbering them should be a
153	non-issue.  However, unclean source trees will yield broken test
154	programs once the operator executes "make delete-old-libs" after a
155	"make installworld".
156
157	Additionally, the atf-sh binary was made private by moving it into
158	/usr/libexec/.  Already-built shell test programs will keep the
159	path to the old binary so they will break after "make delete-old"
160	is run.
161
162	If you are using WITH_TESTS=yes (not the default), wipe the object
163	tree and rebuild from scratch to prevent spurious test failures.
164	This is only needed once: the misnumbered libraries and misplaced
165	binaries have been added to OptionalObsoleteFiles.inc so they will
166	be removed during a clean upgrade.
167
16820140512:
169	Clang and llvm have been upgraded to 3.4.1 release.
170
17120140508:
172	We bogusly installed src.opts.mk in /usr/share/mk. This file should
173	be removed to avoid issues in the future (and has been added to
174	ObsoleteFiles.inc).
175
17620140505:
177	/etc/src.conf now affects only builds of the FreeBSD src tree. In the
178	past, it affected all builds that used the bsd.*.mk files. The old
179	behavior was a bug, but people may have relied upon it. To get this
180	behavior back, you can .include /etc/src.conf from /etc/make.conf
181	(which is still global and isn't changed). This also changes the
182	behavior of incremental builds inside the tree of individual
183	directories. Set MAKESYSPATH to ".../share/mk" to do that.
184	Although this has survived make universe and some upgrade scenarios,
185	other upgrade scenarios may have broken. At least one form of
186	temporary breakage was fixed with MAKESYSPATH settings for buildworld
187	as well... In cases where MAKESYSPATH isn't working with this
188	setting, you'll need to set it to the full path to your tree.
189
190	One side effect of all this cleaning up is that bsd.compiler.mk
191	is no longer implicitly included by bsd.own.mk. If you wish to
192	use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
193	as well.
194
19520140430:
196	The lindev device has been removed since /dev/full has been made a
197	standard device.  __FreeBSD_version has been bumped.
198
19920140418:
200	The YES_HESIOD knob has been removed. It has been obsolete for
201	a decade. Please move to using WITH_HESIOD instead or your builds
202	will silently lack HESIOD.
203
20420140405:
205	The uart(4) driver has been changed with respect to its handling
206	of the low-level console. Previously the uart(4) driver prevented
207	any process from changing the baudrate or the CLOCAL and HUPCL
208	control flags. By removing the restrictions, operators can make
209	changes to the serial console port without having to reboot.
210	However, when getty(8) is started on the serial device that is
211	associated with the low-level console, a misconfigured terminal
212	line in /etc/ttys will now have a real impact.
213	Before upgrading the kernel, make sure that /etc/ttys has the
214	serial console device configured as 3wire without baudrate to
215	preserve the previous behaviour. E.g:
216	    ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
217
21820140306:
219	Support for libwrap (TCP wrappers) in rpcbind was disabled by default
220	to improve performance.  To re-enable it, if needed, run rpcbind
221	with command line option -W.
222
22320140226:
224	Switched back to the GPL dtc compiler due to updates in the upstream
225	dts files not being supported by the BSDL dtc compiler. You will need
226	to rebuild your kernel toolchain to pick up the new compiler. Core dumps
227	may result while building dtb files during a kernel build if you fail
228	to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
229
23020140216:
231	Clang and llvm have been upgraded to 3.4 release.
232
23320140216:
234	The nve(4) driver has been removed.  Please use the nfe(4) driver
235	for NVIDIA nForce MCP Ethernet adapters instead.
236
23720140212:
238	An ABI incompatibility crept into the libc++ 3.4 import in r261283.
239	This could cause certain C++ applications using shared libraries built
240	against the previous version of libc++ to crash.  The incompatibility
241	has now been fixed, but any C++ applications or shared libraries built
242	between r261283 and r261801 should be recompiled.
243
24420140204:
245	OpenSSH will now ignore errors caused by kernel lacking of Capsicum
246	capability mode support.  Please note that enabling the feature in
247	kernel is still highly recommended.
248
24920140131:
250	OpenSSH is now built with sandbox support, and will use sandbox as
251	the default privilege separation method.  This requires Capsicum
252	capability mode support in kernel.
253
25420140128:
255	The libelf and libdwarf libraries have been updated to newer
256	versions from upstream. Shared library version numbers for
257	these two libraries were bumped. Any ports or binaries
258	requiring these two libraries should be recompiled.
259	__FreeBSD_version is bumped to 1100006.
260
26120140110:
262	If a Makefile in a tests/ directory was auto-generating a Kyuafile
263	instead of providing an explicit one, this would prevent such
264	Makefile from providing its own Kyuafile in the future during
265	NO_CLEAN builds.  This has been fixed in the Makefiles but manual
266	intervention is needed to clean an objdir if you use NO_CLEAN:
267	  # find /usr/obj -name Kyuafile | xargs rm -f
268
26920131213:
270	The behavior of gss_pseudo_random() for the krb5 mechanism
271	has changed, for applications requesting a longer random string
272	than produced by the underlying enctype's pseudo-random() function.
273	In particular, the random string produced from a session key of
274	enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
275	be different at the 17th octet and later, after this change.
276	The counter used in the PRF+ construction is now encoded as a
277	big-endian integer in accordance with RFC 4402.
278	__FreeBSD_version is bumped to 1100004.
279
28020131108:
281	The WITHOUT_ATF build knob has been removed and its functionality
282	has been subsumed into the more generic WITHOUT_TESTS.  If you were
283	using the former to disable the build of the ATF libraries, you
284	should change your settings to use the latter.
285
28620131025:
287	The default version of mtree is nmtree which is obtained from
288	NetBSD.  The output is generally the same, but may vary
289	slightly.  If you found you need identical output adding
290	"-F freebsd9" to the command line should do the trick.  For the
291	time being, the old mtree is available as fmtree.
292
29320131014:
294	libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
295	This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
296	1.1.4_8 and verify bsdyml not linked in, before running "make
297	delete-old-libs":
298	  # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
299	  or
300	  # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
301
30220131010:
303	The rc.d/jail script has been updated to support jail(8)
304	configuration file.  The "jail_<jname>_*" rc.conf(5) variables
305	for per-jail configuration are automatically converted to
306	/var/run/jail.<jname>.conf before the jail(8) utility is invoked.
307	This is transparently backward compatible.  See below about some
308	incompatibilities and rc.conf(5) manual page for more details.
309
310	These variables are now deprecated in favor of jail(8) configuration
311	file.  One can use "rc.d/jail config <jname>" command to generate
312	a jail(8) configuration file in /var/run/jail.<jname>.conf without
313	running the jail(8) utility.   The default pathname of the
314	configuration file is /etc/jail.conf and can be specified by
315	using $jail_conf or $jail_<jname>_conf variables.
316
317	Please note that jail_devfs_ruleset accepts an integer at
318	this moment.  Please consider to rewrite the ruleset name
319	with an integer.
320
32120130930:
322	BIND has been removed from the base system.  If all you need
323	is a local resolver, simply enable and start the local_unbound
324	service instead.  Otherwise, several versions of BIND are
325	available in the ports tree.   The dns/bind99 port is one example.
326
327	With this change, nslookup(1) and dig(1) are no longer in the base
328	system.  Users should instead use host(1) and drill(1) which are
329	in the base system.  Alternatively, nslookup and dig can
330	be obtained by installing the dns/bind-tools port.
331
33220130916:
333	With the addition of unbound(8), a new unbound user is now
334	required during installworld.  "mergemaster -p" can be used to
335	add the user prior to installworld, as documented in the handbook.
336
33720130911:
338	OpenSSH is now built with DNSSEC support, and will by default
339	silently trust signed SSHFP records.  This can be controlled with
340	the VerifyHostKeyDNS client configuration setting.  DNSSEC support
341	can be disabled entirely with the WITHOUT_LDNS option in src.conf.
342
34320130906:
344	The GNU Compiler Collection and C++ standard library (libstdc++)
345	are no longer built by default on platforms where clang is the system
346	compiler.  You can enable them with the WITH_GCC and WITH_GNUCXX
347	options in src.conf.
348
34920130905:
350	The PROCDESC kernel option is now part of the GENERIC kernel
351	configuration and is required for the rwhod(8) to work.
352	If you are using custom kernel configuration, you should include
353	'options PROCDESC'.
354
35520130905:
356	The API and ABI related to the Capsicum framework was modified
357	in backward incompatible way. The userland libraries and programs
358	have to be recompiled to work with the new kernel. This includes the
359	following libraries and programs, but the whole buildworld is
360	advised: libc, libprocstat, dhclient, tcpdump, hastd, hastctl,
361	kdump, procstat, rwho, rwhod, uniq.
362
36320130903:
364	AES-NI intrinsic support has been added to gcc.  The AES-NI module
365	has been updated to use this support.  A new gcc is required to build
366	the aesni module on both i386 and amd64.
367
36820130821:
369	The PADLOCK_RNG and RDRAND_RNG kernel options are now devices.
370	Thus "device padlock_rng" and "device rdrand_rng" should be
371	used instead of "options PADLOCK_RNG" & "options RDRAND_RNG".
372
37320130813:
374	WITH_ICONV has been split into two feature sets.  WITH_ICONV now
375	enables just the iconv* functionality and is now on by default.
376	WITH_LIBICONV_COMPAT enables the libiconv api and link time
377	compatability.  Set WITHOUT_ICONV to build the old way.
378	If you have been using WITH_ICONV before, you will very likely
379	need to turn on WITH_LIBICONV_COMPAT.
380
38120130806:
382	INVARIANTS option now enables DEBUG for code with OpenSolaris and
383	Illumos origin, including ZFS.  If you have INVARIANTS in your
384	kernel configuration, then there is no need to set DEBUG or ZFS_DEBUG
385	explicitly.
386	DEBUG used to enable witness(9) tracking of OpenSolaris (mostly ZFS)
387	locks if WITNESS option was set.  Because that generated a lot of
388	witness(9) reports and all of them were believed to be false
389	positives, this is no longer done.  New option OPENSOLARIS_WITNESS
390	can be used to achieve the previous behavior.
391
39220130806:
393	Timer values in IPv6 data structures now use time_uptime instead
394	of time_second.  Although this is not a user-visible functional
395	change, userland utilities which directly use them---ndp(8),
396	rtadvd(8), and rtsold(8) in the base system---need to be updated
397	to r253970 or later.
398
39920130802:
400	find -delete can now delete the pathnames given as arguments,
401	instead of only files found below them or if the pathname did
402	not contain any slashes. Formerly, the following error message
403	would result:
404
405	find: -delete: <path>: relative path potentially not safe
406
407	Deleting the pathnames given as arguments can be prevented
408	without error messages using -mindepth 1 or by changing
409	directory and passing "." as argument to find. This works in the
410	old as well as the new version of find.
411
41220130726:
413	Behavior of devfs rules path matching has been changed.
414	Pattern is now always matched against fully qualified devfs
415	path and slash characters must be explicitly matched by
416	slashes in pattern (FNM_PATHNAME). Rulesets involving devfs
417	subdirectories must be reviewed.
418
41920130716:
420	The default ARM ABI has changed to the ARM EABI. The old ABI is
421	incompatible with the ARM EABI and all programs and modules will
422	need to be rebuilt to work with a new kernel.
423
424	To keep using the old ABI ensure the WITHOUT_ARM_EABI knob is set.
425
426	NOTE: Support for the old ABI will be removed in the future and
427	users are advised to upgrade.
428
42920130709:
430	pkg_install has been disconnected from the build if you really need it
431	you should add WITH_PKGTOOLS in your src.conf(5).
432
43320130709:
434	Most of network statistics structures were changed to be able
435	keep 64-bits counters. Thus all tools, that work with networking
436	statistics, must be rebuilt (netstat(1), bsnmpd(1), etc.)
437
43820130629:
439	Fix targets that run multiple make's to use && rather than ;
440	so that subsequent steps depend on success of previous.
441
442	NOTE: if building 'universe' with -j* on stable/8 or stable/9
443	it would be better to start the build using bmake, to avoid
444	overloading the machine.
445
44620130618:
447	Fix a bug that allowed a tracing process (e.g. gdb) to write
448	to a memory-mapped file in the traced process's address space
449	even if neither the traced process nor the tracing process had
450	write access to that file.
451
45220130615:
453	CVS has been removed from the base system.  An exact copy
454	of the code is available from the devel/cvs port.
455
45620130613:
457	Some people report the following error after the switch to bmake:
458
459		make: illegal option -- J
460		usage: make [-BPSXeiknpqrstv] [-C directory] [-D variable]
461			...
462		*** [buildworld] Error code 2
463
464	this likely due to an old instance of make in
465	${MAKEPATH} (${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE})
466	which src/Makefile will use that blindly, if it exists, so if
467	you see the above error:
468
469		rm -rf `make -V MAKEPATH`
470
471	should resolve it.
472
47320130516:
474	Use bmake by default.
475	Whereas before one could choose to build with bmake via
476	-DWITH_BMAKE one must now use -DWITHOUT_BMAKE to use the old
477	make. The goal is to remove these knobs for 10-RELEASE.
478
479	It is worth noting that bmake (like gmake) treats the command
480	line as the unit of failure, rather than statements within the
481	command line.  Thus '(cd some/where && dosomething)' is safer
482	than 'cd some/where; dosomething'. The '()' allows consistent
483	behavior in parallel build.
484
48520130429:
486        Fix a bug that allows NFS clients to issue READDIR on files.
487
48820130426:
489	The WITHOUT_IDEA option has been removed because
490	the IDEA patent expired.
491
49220130426:
493	The sysctl which controls TRIM support under ZFS has been renamed
494	from vfs.zfs.trim_disable -> vfs.zfs.trim.enabled and has been
495	enabled by default.
496
49720130425:
498	The mergemaster command now uses the default MAKEOBJDIRPREFIX
499	rather than creating it's own in the temporary directory in
500	order allow access to bootstrapped versions of tools such as
501	install and mtree.  When upgrading from version of FreeBSD where
502	the install command does not support -l, you will need to
503	install a new mergemaster command if mergemaster -p is required.
504	This can be accomplished with the command (cd src/usr.sbin/mergemaster
505	&& make install).
506
50720130404:
508	Legacy ATA stack, disabled and replaced by new CAM-based one since
509	FreeBSD 9.0, completely removed from the sources.  Kernel modules
510	atadisk and atapi*, user-level tools atacontrol and burncd are
511	removed.  Kernel option `options ATA_CAM` is now permanently enabled
512	and removed.
513
51420130319:
515	SOCK_CLOEXEC and SOCK_NONBLOCK flags have been added to socket(2)
516	and socketpair(2). Software, in particular Kerberos, may
517	automatically detect and use these during building. The resulting
518	binaries will not work on older kernels.
519
52020130308:
521	CTL_DISABLE has also been added to the sparc64 GENERIC (for further
522	information, see the respective 20130304 entry).
523
52420130304:
525	Recent commits to callout(9) changed the size of struct callout,
526	so the KBI is probably heavily disturbed. Also, some functions
527	in callout(9)/sleep(9)/sleepqueue(9)/condvar(9) KPIs were replaced
528	by macros. Every kernel module using it won't load, so rebuild
529	is requested.
530
531	The ctl device has been re-enabled in GENERIC for i386 and amd64,
532	but does not initialize by default (because of the new CTL_DISABLE
533	option) to save memory.  To re-enable it, remove the CTL_DISABLE
534	option from the kernel config file or set kern.cam.ctl.disable=0
535	in /boot/loader.conf.
536
53720130301:
538	The ctl device has been disabled in GENERIC for i386 and amd64.
539	This was done due to the extra memory being allocated at system
540	initialisation time by the ctl driver which was only used if
541	a CAM target device was created.  This makes a FreeBSD system
542	unusable on 128MB or less of RAM.
543
54420130208:
545	A new compression method (lz4) has been merged to -HEAD.  Please
546	refer to zpool-features(7) for more information.
547
548	Please refer to the "ZFS notes" section of this file for information
549	on upgrading boot ZFS pools.
550
55120130129:
552	A BSD-licensed patch(1) variant has been added and is installed
553	as bsdpatch, being the GNU version the default patch.
554	To inverse the logic and use the BSD-licensed one as default,
555	while having the GNU version installed as gnupatch, rebuild
556	and install world with the WITH_BSD_PATCH knob set.
557
55820130121:
559	Due to the use of the new -l option to install(1) during build
560	and install, you must take care not to directly set the INSTALL
561	make variable in your /etc/make.conf, /etc/src.conf, or on the
562	command line.  If you wish to use the -C flag for all installs
563	you may be able to add INSTALL+=-C to /etc/make.conf or
564	/etc/src.conf.
565
56620130118:
567	The install(1) option -M has changed meaning and now takes an
568	argument that is a file or path to append logs to.  In the
569	unlikely event that -M was the last option on the command line
570	and the command line contained at least two files and a target
571	directory the first file will have logs appended to it.  The -M
572	option served little practical purpose in the last decade so its
573	use is expected to be extremely rare.
574
57520121223:
576	After switching to Clang as the default compiler some users of ZFS
577	on i386 systems started to experience stack overflow kernel panics.
578	Please consider using 'options KSTACK_PAGES=4' in such configurations.
579
58020121222:
581	GEOM_LABEL now mangles label names read from file system metadata.
582	Mangling affect labels containing spaces, non-printable characters,
583	'%' or '"'. Device names in /etc/fstab and other places may need to
584	be updated.
585
58620121217:
587	By default, only the 10 most recent kernel dumps will be saved.  To
588	restore the previous behaviour (no limit on the number of kernel dumps
589	stored in the dump directory) add the following line to /etc/rc.conf:
590
591		savecore_flags=""
592
59320121201:
594	With the addition of auditdistd(8), a new auditdistd user is now
595	required during installworld.  "mergemaster -p" can be used to
596	add the user prior to installworld, as documented in the handbook.
597
59820121117:
599	The sin6_scope_id member variable in struct sockaddr_in6 is now
600	filled by the kernel before passing the structure to the userland via
601	sysctl or routing socket.  This means the KAME-specific embedded scope
602	id in sin6_addr.s6_addr[2] is always cleared in userland application.
603	This behavior can be controlled by net.inet6.ip6.deembed_scopeid.
604	__FreeBSD_version is bumped to 1000025.
605
60620121105:
607	On i386 and amd64 systems WITH_CLANG_IS_CC is now the default.
608	This means that the world and kernel will be compiled with clang
609	and that clang will be installed as /usr/bin/cc, /usr/bin/c++,
610	and /usr/bin/cpp.  To disable this behavior and revert to building
611	with gcc, compile with WITHOUT_CLANG_IS_CC. Really old versions
612	of current may need to bootstrap WITHOUT_CLANG first if the clang
613	build fails (its compatibility window doesn't extend to the 9 stable
614	branch point).
615
61620121102:
617	The IPFIREWALL_FORWARD kernel option has been removed. Its
618	functionality now turned on by default.
619
62020121023:
621	The ZERO_COPY_SOCKET kernel option has been removed and
622	split into SOCKET_SEND_COW and SOCKET_RECV_PFLIP.
623	NB: SOCKET_SEND_COW uses the VM page based copy-on-write
624	mechanism which is not safe and may result in kernel crashes.
625	NB: The SOCKET_RECV_PFLIP mechanism is useless as no current
626	driver supports disposeable external page sized mbuf storage.
627	Proper replacements for both zero-copy mechanisms are under
628	consideration and will eventually lead to complete removal
629	of the two kernel options.
630
63120121023:
632	The IPv4 network stack has been converted to network byte
633	order. The following modules need to be recompiled together
634	with kernel: carp(4), divert(4), gif(4), siftr(4), gre(4),
635	pf(4), ipfw(4), ng_ipfw(4), stf(4).
636
63720121022:
638	Support for non-MPSAFE filesystems was removed from VFS. The
639	VFS_VERSION was bumped, all filesystem modules shall be
640	recompiled.
641
64220121018:
643	All the non-MPSAFE filesystems have been disconnected from
644	the build. The full list includes: codafs, hpfs, ntfs, nwfs,
645	portalfs, smbfs, xfs.
646
64720121016:
648	The interface cloning API and ABI has changed. The following
649	modules need to be recompiled together with kernel:
650	ipfw(4), pfsync(4), pflog(4), usb(4), wlan(4), stf(4),
651	vlan(4), disc(4), edsc(4), if_bridge(4), gif(4), tap(4),
652	faith(4), epair(4), enc(4), tun(4), if_lagg(4), gre(4).
653
65420121015:
655	The sdhci driver was split in two parts: sdhci (generic SD Host
656	Controller logic) and sdhci_pci (actual hardware driver).
657	No kernel config modifications are required, but if you
658	load sdhc as a module you must switch to sdhci_pci instead.
659
66020121014:
661	Import the FUSE kernel and userland support into base system.
662
66320121013:
664	The GNU sort(1) program has been removed since the BSD-licensed
665	sort(1) has been the default for quite some time and no serious
666	problems have been reported.  The corresponding WITH_GNU_SORT
667	knob has also gone.
668
66920121006:
670	The pfil(9) API/ABI for AF_INET family has been changed. Packet
671	filtering modules: pf(4), ipfw(4), ipfilter(4) need to be recompiled
672	with new kernel.
673
67420121001:
675	The net80211(4) ABI has been changed to allow for improved driver
676	PS-POLL and power-save support.  All wireless drivers need to be
677	recompiled to work with the new kernel.
678
67920120913:
680	The random(4) support for the VIA hardware random number
681	generator (`PADLOCK') is no longer enabled unconditionally.
682	Add the padlock_rng device in the custom kernel config if
683	needed.  The GENERIC kernels on i386 and amd64 do include the
684	device, so the change only affects the custom kernel
685	configurations.
686
68720120908:
688	The pf(4) packet filter ABI has been changed. pfctl(8) and
689	snmp_pf module need to be recompiled to work with new kernel.
690
69120120828:
692	A new ZFS feature flag "com.delphix:empty_bpobj" has been merged
693	to -HEAD. Pools that have empty_bpobj in active state can not be
694	imported read-write with ZFS implementations that do not support
695	this feature. For more information read the zpool-features(5)
696	manual page.
697
69820120727:
699	The sparc64 ZFS loader has been changed to no longer try to auto-
700	detect ZFS providers based on diskN aliases but now requires these
701	to be explicitly listed in the OFW boot-device environment variable.
702
70320120712:
704	The OpenSSL has been upgraded to 1.0.1c.  Any binaries requiring
705	libcrypto.so.6 or libssl.so.6 must be recompiled.  Also, there are
706	configuration changes.  Make sure to merge /etc/ssl/openssl.cnf.
707
70820120712:
709	The following sysctls and tunables have been renamed for consistency
710	with other variables:
711	  kern.cam.da.da_send_ordered   -> kern.cam.da.send_ordered
712	  kern.cam.ada.ada_send_ordered -> kern.cam.ada.send_ordered
713
71420120628:
715	The sort utility has been replaced with BSD sort.  For now, GNU sort
716	is also available as "gnusort" or the default can be set back to
717	GNU sort by setting WITH_GNU_SORT.  In this case, BSD sort will be
718	installed as "bsdsort".
719
72020120611:
721	A new version of ZFS (pool version 5000) has been merged to -HEAD.
722	Starting with this version the old system of ZFS pool versioning
723	is superseded by "feature flags". This concept enables forward
724	compatibility against certain future changes in functionality of ZFS
725	pools. The first read-only compatible "feature flag" for ZFS pools
726	is named "com.delphix:async_destroy". For more information
727	read the new zpool-features(5) manual page.
728	Please refer to the "ZFS notes" section of this file for information
729	on upgrading boot ZFS pools.
730
73120120417:
732	The malloc(3) implementation embedded in libc now uses sources imported
733	as contrib/jemalloc.  The most disruptive API change is to
734	/etc/malloc.conf.  If your system has an old-style /etc/malloc.conf,
735	delete it prior to installworld, and optionally re-create it using the
736	new format after rebooting.  See malloc.conf(5) for details
737	(specifically the TUNING section and the "opt.*" entries in the MALLCTL
738	NAMESPACE section).
739
74020120328:
741	Big-endian MIPS TARGET_ARCH values no longer end in "eb".  mips64eb
742	is now spelled mips64.  mipsn32eb is now spelled mipsn32.  mipseb is
743	now spelled mips.  This is to aid compatibility with third-party
744	software that expects this naming scheme in uname(3).  Little-endian
745	settings are unchanged. If you are updating a big-endian mips64 machine
746	from before this change, you may need to set MACHINE_ARCH=mips64 in
747	your environment before the new build system will recognize your machine.
748
74920120306:
750	Disable by default the option VFS_ALLOW_NONMPSAFE for all supported
751	platforms.
752
75320120229:
754	Now unix domain sockets behave "as expected" on	nullfs(5). Previously
755	nullfs(5) did not pass through all behaviours to the underlying layer,
756	as a result if we bound to a socket on the lower layer we could connect
757	only to the lower path; if we bound to the upper layer we could connect
758	only to	the upper path. The new behavior is one can connect to both the
759	lower and the upper paths regardless what layer path one binds to.
760
76120120211:
762	The getifaddrs upgrade path broken with 20111215 has been restored.
763	If you have upgraded in between 20111215 and 20120209 you need to
764	recompile libc again with your kernel.  You still need to recompile
765	world to be able to configure CARP but this restriction already
766	comes from 20111215.
767
76820120114:
769	The set_rcvar() function has been removed from /etc/rc.subr.  All
770	base and ports rc.d scripts have been updated, so if you have a
771	port installed with a script in /usr/local/etc/rc.d you can either
772	hand-edit the rcvar= line, or reinstall the port.
773
774	An easy way to handle the mass-update of /etc/rc.d:
775	rm /etc/rc.d/* && mergemaster -i
776
77720120109:
778	panic(9) now stops other CPUs in the SMP systems, disables interrupts
779	on the current CPU and prevents other threads from running.
780	This behavior can be reverted using the kern.stop_scheduler_on_panic
781	tunable/sysctl.
782	The new behavior can be incompatible with kern.sync_on_panic.
783
78420111215:
785	The carp(4) facility has been changed significantly. Configuration
786	of the CARP protocol via ifconfig(8) has changed, as well as format
787	of CARP events submitted to devd(8) has changed. See manual pages
788	for more information. The arpbalance feature of carp(4) is currently
789	not supported anymore.
790
791	Size of struct in_aliasreq, struct in6_aliasreq has changed. User
792	utilities using SIOCAIFADDR, SIOCAIFADDR_IN6, e.g. ifconfig(8),
793	need to be recompiled.
794
79520111122:
796	The acpi_wmi(4) status device /dev/wmistat has been renamed to
797	/dev/wmistat0.
798
79920111108:
800	The option VFS_ALLOW_NONMPSAFE option has been added in order to
801	explicitely support non-MPSAFE filesystems.
802	It is on by default for all supported platform at this present
803	time.
804
80520111101:
806	The broken amd(4) driver has been replaced with esp(4) in the amd64,
807	i386 and pc98 GENERIC kernel configuration files.
808
80920110930:
810	sysinstall has been removed
811
81220110923:
813	The stable/9 branch created in subversion.  This corresponds to the
814	RELENG_9 branch in CVS.
815
816COMMON ITEMS:
817
818	General Notes
819	-------------
820	Avoid using make -j when upgrading.  While generally safe, there are
821	sometimes problems using -j to upgrade.  If your upgrade fails with
822	-j, please try again without -j.  From time to time in the past there
823	have been problems using -j with buildworld and/or installworld.  This
824	is especially true when upgrading between "distant" versions (eg one
825	that cross a major release boundary or several minor releases, or when
826	several months have passed on the -current branch).
827
828	Sometimes, obscure build problems are the result of environment
829	poisoning.  This can happen because the make utility reads its
830	environment when searching for values for global variables.  To run
831	your build attempts in an "environmental clean room", prefix all make
832	commands with 'env -i '.  See the env(1) manual page for more details.
833
834	When upgrading from one major version to another it is generally best
835	to upgrade to the latest code in the currently installed branch first,
836	then do an upgrade to the new branch. This is the best-tested upgrade
837	path, and has the highest probability of being successful.  Please try
838	this approach before reporting problems with a major version upgrade.
839
840	When upgrading a live system, having a root shell around before
841	installing anything can help undo problems. Not having a root shell
842	around can lead to problems if pam has changed too much from your
843	starting point to allow continued authentication after the upgrade.
844
845	ZFS notes
846	---------
847	When upgrading the boot ZFS pool to a new version, always follow
848	these two steps:
849
850	1.) recompile and reinstall the ZFS boot loader and boot block
851	(this is part of "make buildworld" and "make installworld")
852
853	2.) update the ZFS boot block on your boot drive
854
855	The following example updates the ZFS boot block on the first
856	partition (freebsd-boot) of a GPT partitioned drive ada0:
857	"gpart bootcode -p /boot/gptzfsboot -i 1 ada0"
858
859	Non-boot pools do not need these updates.
860
861	To build a kernel
862	-----------------
863	If you are updating from a prior version of FreeBSD (even one just
864	a few days old), you should follow this procedure.  It is the most
865	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
866
867	make kernel-toolchain
868	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
869	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
870
871	To test a kernel once
872	---------------------
873	If you just want to boot a kernel once (because you are not sure
874	if it works, or if you want to boot a known bad kernel to provide
875	debugging information) run
876	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
877	nextboot -k testkernel
878
879	To just build a kernel when you know that it won't mess you up
880	--------------------------------------------------------------
881	This assumes you are already running a CURRENT system.  Replace
882	${arch} with the architecture of your machine (e.g. "i386",
883	"arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
884
885	cd src/sys/${arch}/conf
886	config KERNEL_NAME_HERE
887	cd ../compile/KERNEL_NAME_HERE
888	make depend
889	make
890	make install
891
892	If this fails, go to the "To build a kernel" section.
893
894	To rebuild everything and install it on the current system.
895	-----------------------------------------------------------
896	# Note: sometimes if you are running current you gotta do more than
897	# is listed here if you are upgrading from a really old current.
898
899	<make sure you have good level 0 dumps>
900	make buildworld
901	make kernel KERNCONF=YOUR_KERNEL_HERE
902							[1]
903	<reboot in single user>				[3]
904	mergemaster -Fp					[5]
905	make installworld
906	mergemaster -Fi					[4]
907	make delete-old					[6]
908	<reboot>
909
910	To cross-install current onto a separate partition
911	--------------------------------------------------
912	# In this approach we use a separate partition to hold
913	# current's root, 'usr', and 'var' directories.   A partition
914	# holding "/", "/usr" and "/var" should be about 2GB in
915	# size.
916
917	<make sure you have good level 0 dumps>
918	<boot into -stable>
919	make buildworld
920	make buildkernel KERNCONF=YOUR_KERNEL_HERE
921	<maybe newfs current's root partition>
922	<mount current's root partition on directory ${CURRENT_ROOT}>
923	make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
924	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
925	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
926	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
927	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
928	<reboot into current>
929	<do a "native" rebuild/install as described in the previous section>
930	<maybe install compatibility libraries from ports/misc/compat*>
931	<reboot>
932
933
934	To upgrade in-place from stable to current
935	----------------------------------------------
936	<make sure you have good level 0 dumps>
937	make buildworld					[9]
938	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
939							[1]
940	<reboot in single user>				[3]
941	mergemaster -Fp					[5]
942	make installworld
943	mergemaster -Fi					[4]
944	make delete-old					[6]
945	<reboot>
946
947	Make sure that you've read the UPDATING file to understand the
948	tweaks to various things you need.  At this point in the life
949	cycle of current, things change often and you are on your own
950	to cope.  The defaults can also change, so please read ALL of
951	the UPDATING entries.
952
953	Also, if you are tracking -current, you must be subscribed to
954	freebsd-current@freebsd.org.  Make sure that before you update
955	your sources that you have read and understood all the recent
956	messages there.  If in doubt, please track -stable which has
957	much fewer pitfalls.
958
959	[1] If you have third party modules, such as vmware, you
960	should disable them at this point so they don't crash your
961	system on reboot.
962
963	[3] From the bootblocks, boot -s, and then do
964		fsck -p
965		mount -u /
966		mount -a
967		cd src
968		adjkerntz -i		# if CMOS is wall time
969	Also, when doing a major release upgrade, it is required that
970	you boot into single user mode to do the installworld.
971
972	[4] Note: This step is non-optional.  Failure to do this step
973	can result in a significant reduction in the functionality of the
974	system.  Attempting to do it by hand is not recommended and those
975	that pursue this avenue should read this file carefully, as well
976	as the archives of freebsd-current and freebsd-hackers mailing lists
977	for potential gotchas.  The -U option is also useful to consider.
978	See mergemaster(8) for more information.
979
980	[5] Usually this step is a noop.  However, from time to time
981	you may need to do this if you get unknown user in the following
982	step.  It never hurts to do it all the time.  You may need to
983	install a new mergemaster (cd src/usr.sbin/mergemaster && make
984	install) after the buildworld before this step if you last updated
985	from current before 20130425 or from -stable before 20130430.
986
987	[6] This only deletes old files and directories. Old libraries
988	can be deleted by "make delete-old-libs", but you have to make
989	sure that no program is using those libraries anymore.
990
991	[8] In order to have a kernel that can run the 4.x binaries needed to
992	do an installworld, you must include the COMPAT_FREEBSD4 option in
993	your kernel.  Failure to do so may leave you with a system that is
994	hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
995	required to run the 5.x binaries on more recent kernels.  And so on
996	for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
997
998	Make sure that you merge any new devices from GENERIC since the
999	last time you updated your kernel config file.
1000
1001	[9] When checking out sources, you must include the -P flag to have
1002	cvs prune empty directories.
1003
1004	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1005	"?=" instead of the "=" assignment operator, so that buildworld can
1006	override the CPUTYPE if it needs to.
1007
1008	MAKEOBJDIRPREFIX must be defined in an environment variable, and
1009	not on the command line, or in /etc/make.conf.  buildworld will
1010	warn if it is improperly defined.
1011FORMAT:
1012
1013This file contains a list, in reverse chronological order, of major
1014breakages in tracking -current.  It is not guaranteed to be a complete
1015list of such breakages, and only contains entries since October 10, 2007.
1016If you need to see UPDATING entries from before that date, you will need
1017to fetch an UPDATING file from an older FreeBSD release.
1018
1019Copyright information:
1020
1021Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1022
1023Redistribution, publication, translation and use, with or without
1024modification, in full or in part, in any form or format of this
1025document are permitted without further permission from the author.
1026
1027THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1028IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1029WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1030DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1031INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1032(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1033SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1034HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1035STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1036IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1037POSSIBILITY OF SUCH DAMAGE.
1038
1039Contact Warner Losh if you have any questions about your use of
1040this document.
1041
1042$FreeBSD$
1043