]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - UPDATING
Import OpenBSD's rsu(4) WLAN driver.
[FreeBSD/FreeBSD.git] / UPDATING
1 Updating Information for FreeBSD current users
2
3 This file is maintained and copyrighted by M. Warner Losh <imp@freebsd.org>.
4 See end of file for further details.  For commonly done items, please see the
5 COMMON ITEMS: section later in the file.  These instructions assume that you
6 basically know what you are doing.  If not, then please consult the FreeBSD
7 handbook:
8
9     http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
10
11 Items affecting the ports and packages system can be found in
12 /usr/ports/UPDATING.  Please read that file before running portupgrade.
13
14 NOTE: FreeBSD has switched from gcc to clang. If you have trouble bootstrapping
15 from older versions of FreeBSD, try WITHOUT_CLANG to bootstrap to the tip of
16 head, and then rebuild without this option. The bootstrap process from
17 older version of current is a bit fragile.
18
19 NOTE TO PEOPLE WHO THINK THAT FreeBSD 10.x IS SLOW:
20         FreeBSD 10.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
34 20130729:
35         random(4) and actual RNG implementations (aka, adaptors) have been
36         further decoupled.  If you are running a custom kernel, you may
37         need to explicitly enable at least one RNG adaptor in your kernel
38         config.  For example, to use Yarrow, add "options YARROW_RNG" to
39         your kernel config.  For hardware backed RNGs, use either
40         "RDRAND_RNG" or "PADLOCK_RNG" options.
41         If you use random.ko via 'random_load="YES"' in /boot/loader.conf
42         instead of "device random", you will need to change that to
43         'yarrow_rng_load="YES"', 'rdrand_rng_load="YES"', or
44         'padlock_rng_load="YES"'.  random.ko will be loaded automatically
45         as a dependency module.
46
47 20130726:
48         Behavior of devfs rules path matching has been changed.
49         Pattern is now always matched against fully qualified devfs
50         path and slash characters must be explicitly matched by
51         slashes in pattern (FNM_PATHNAME). Rulesets involving devfs
52         subdirectories must be reviewed.
53
54 20130716:
55         The default ARM ABI has changed to the ARM EABI. The old ABI is
56         incompatible with the ARM EABI and all programs and modules will
57         need to be rebuilt to work with a new kernel.
58
59         To keep using the old ABI ensure the WITHOUT_ARM_EABI knob is set.
60
61         NOTE: Support for the old ABI will be removed in the future and
62         users are advised to upgrade.
63
64 20130709:
65         pkg_install has been disconnected from the build if you really need it
66         you should add WITH_PKGTOOLS in your src.conf(5).
67
68 20130709:
69         Most of network statistics structures were changed to be able
70         keep 64-bits counters. Thus all tools, that work with networking
71         statistics, must be rebuilt (netstat(1), bsnmpd(1), etc.)
72
73 20130629:
74         Fix targets that run multiple make's to use && rather than ;
75         so that subsequent steps depend on success of previous.
76
77         NOTE: if building 'universe' with -j* on stable/8 or stable/9
78         it would be better to start the build using bmake, to avoid
79         overloading the machine.
80
81 20130618:
82         Fix a bug that allowed a tracing process (e.g. gdb) to write
83         to a memory-mapped file in the traced process's address space
84         even if neither the traced process nor the tracing process had
85         write access to that file.
86
87 20130615:
88         CVS has been removed from the base system.  An exact copy
89         of the code is available from the devel/cvs port.
90
91 20130613:
92         Some people report the following error after the switch to bmake:
93
94                 make: illegal option -- J
95                 usage: make [-BPSXeiknpqrstv] [-C directory] [-D variable]
96                         ...
97                 *** [buildworld] Error code 2
98
99         this likely due to an old instance of make in
100         ${MAKEPATH} (${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE})
101         which src/Makefile will use that blindly, if it exists, so if
102         you see the above error:
103
104                 rm -rf `make -V MAKEPATH`
105
106         should resolve it.
107
108 20130516:
109         Use bmake by default.
110         Whereas before one could choose to build with bmake via
111         -DWITH_BMAKE one must now use -DWITHOUT_BMAKE to use the old
112         make. The goal is to remove these knobs for 10-RELEASE.
113
114         It is worth noting that bmake (like gmake) treats the command
115         line as the unit of failure, rather than statements within the
116         command line.  Thus '(cd some/where && dosomething)' is safer
117         than 'cd some/where; dosomething'. The '()' allows consistent
118         behavior in parallel build.
119
120 20130429:
121         Fix a bug that allows NFS clients to issue READDIR on files.
122
123 20130426:
124         The WITHOUT_IDEA option has been removed because
125         the IDEA patent expired.
126
127 20130426:
128         The sysctl which controls TRIM support under ZFS has been renamed
129         from vfs.zfs.trim_disable -> vfs.zfs.trim.enabled and has been
130         enabled by default.
131
132 20130425:
133         The mergemaster command now uses the default MAKEOBJDIRPREFIX
134         rather than creating it's own in the temporary directory in
135         order allow access to bootstrapped versions of tools such as
136         install and mtree.  When upgrading from version of FreeBSD where
137         the install command does not support -l, you will need to
138         install a new mergemaster command if mergemaster -p is required.
139         This can be accomplished with the command (cd src/usr.sbin/mergemaster
140         && make install).
141
142 20130404:
143         Legacy ATA stack, disabled and replaced by new CAM-based one since
144         FreeBSD 9.0, completely removed from the sources.  Kernel modules
145         atadisk and atapi*, user-level tools atacontrol and burncd are
146         removed.  Kernel option `options ATA_CAM` is now permanently enabled
147         and removed.
148
149 20130319:
150         SOCK_CLOEXEC and SOCK_NONBLOCK flags have been added to socket(2)
151         and socketpair(2). Software, in particular Kerberos, may
152         automatically detect and use these during building. The resulting
153         binaries will not work on older kernels.
154
155 20130308:
156         CTL_DISABLE has also been added to the sparc64 GENERIC (for further
157         information, see the respective 20130304 entry).
158
159 20130304:
160         Recent commits to callout(9) changed the size of struct callout,
161         so the KBI is probably heavily disturbed. Also, some functions
162         in callout(9)/sleep(9)/sleepqueue(9)/condvar(9) KPIs were replaced
163         by macros. Every kernel module using it won't load, so rebuild
164         is requested.
165
166         The ctl device has been re-enabled in GENERIC for i386 and amd64,
167         but does not initialize by default (because of the new CTL_DISABLE
168         option) to save memory.  To re-enable it, remove the CTL_DISABLE
169         option from the kernel config file or set kern.cam.ctl.disable=0
170         in /boot/loader.conf.
171
172 20130301:
173         The ctl device has been disabled in GENERIC for i386 and amd64.
174         This was done due to the extra memory being allocated at system
175         initialisation time by the ctl driver which was only used if
176         a CAM target device was created.  This makes a FreeBSD system
177         unusable on 128MB or less of RAM.
178
179 20130208:
180         A new compression method (lz4) has been merged to -HEAD.  Please
181         refer to zpool-features(7) for more information.
182
183         Please refer to the "ZFS notes" section of this file for information
184         on upgrading boot ZFS pools.
185
186 20130129:
187         A BSD-licensed patch(1) variant has been added and is installed
188         as bsdpatch, being the GNU version the default patch.
189         To inverse the logic and use the BSD-licensed one as default,
190         while having the GNU version installed as gnupatch, rebuild
191         and install world with the WITH_BSD_PATCH knob set.
192
193 20130121:
194         Due to the use of the new -l option to install(1) during build
195         and install, you must take care not to directly set the INSTALL
196         make variable in your /etc/make.conf, /etc/src.conf, or on the
197         command line.  If you wish to use the -C flag for all installs
198         you may be able to add INSTALL+=-C to /etc/make.conf or
199         /etc/src.conf.
200
201 20130118:
202         The install(1) option -M has changed meaning and now takes an
203         argument that is a file or path to append logs to.  In the
204         unlikely event that -M was the last option on the command line
205         and the command line contained at least two files and a target
206         directory the first file will have logs appended to it.  The -M
207         option served little practical purpose in the last decade so its
208         use is expected to be extremely rare.
209
210 20121223:
211         After switching to Clang as the default compiler some users of ZFS
212         on i386 systems started to experience stack overflow kernel panics.
213         Please consider using 'options KSTACK_PAGES=4' in such configurations.
214
215 20121222:
216         GEOM_LABEL now mangles label names read from file system metadata.
217         Mangling affect labels containing spaces, non-printable characters,
218         '%' or '"'. Device names in /etc/fstab and other places may need to
219         be updated.
220
221 20121217:
222         By default, only the 10 most recent kernel dumps will be saved.  To
223         restore the previous behaviour (no limit on the number of kernel dumps
224         stored in the dump directory) add the following line to /etc/rc.conf:
225
226                 savecore_flags=""
227
228 20121201:
229         With the addition of auditdistd(8), a new auditdistd user is now
230         depended on during installworld.  "mergemaster -p" can be used to add
231         the user prior to installworld, as documented in the handbook.
232
233 20121117:
234         The sin6_scope_id member variable in struct sockaddr_in6 is now
235         filled by the kernel before passing the structure to the userland via
236         sysctl or routing socket.  This means the KAME-specific embedded scope
237         id in sin6_addr.s6_addr[2] is always cleared in userland application.
238         This behavior can be controlled by net.inet6.ip6.deembed_scopeid.
239         __FreeBSD_version is bumped to 1000025.
240
241 20121105:
242         On i386 and amd64 systems WITH_CLANG_IS_CC is now the default.
243         This means that the world and kernel will be compiled with clang
244         and that clang will be installed as /usr/bin/cc, /usr/bin/c++,
245         and /usr/bin/cpp.  To disable this behavior and revert to building
246         with gcc, compile with WITHOUT_CLANG_IS_CC. Really old versions
247         of current may need to bootstrap WITHOUT_CLANG first if the clang
248         build fails (its compatibility window doesn't extend to the 9 stable
249         branch point).
250
251 20121102:
252         The IPFIREWALL_FORWARD kernel option has been removed. Its
253         functionality now turned on by default.
254
255 20121023:
256         The ZERO_COPY_SOCKET kernel option has been removed and
257         split into SOCKET_SEND_COW and SOCKET_RECV_PFLIP.
258         NB: SOCKET_SEND_COW uses the VM page based copy-on-write
259         mechanism which is not safe and may result in kernel crashes.
260         NB: The SOCKET_RECV_PFLIP mechanism is useless as no current
261         driver supports disposeable external page sized mbuf storage.
262         Proper replacements for both zero-copy mechanisms are under
263         consideration and will eventually lead to complete removal
264         of the two kernel options.
265
266 20121023:
267         The IPv4 network stack has been converted to network byte
268         order. The following modules need to be recompiled together
269         with kernel: carp(4), divert(4), gif(4), siftr(4), gre(4),
270         pf(4), ipfw(4), ng_ipfw(4), stf(4).
271
272 20121022:
273         Support for non-MPSAFE filesystems was removed from VFS. The
274         VFS_VERSION was bumped, all filesystem modules shall be
275         recompiled.
276
277 20121018:
278         All the non-MPSAFE filesystems have been disconnected from
279         the build. The full list includes: codafs, hpfs, ntfs, nwfs,
280         portalfs, smbfs, xfs.
281
282 20121016:
283         The interface cloning API and ABI has changed. The following
284         modules need to be recompiled together with kernel:
285         ipfw(4), pfsync(4), pflog(4), usb(4), wlan(4), stf(4),
286         vlan(4), disc(4), edsc(4), if_bridge(4), gif(4), tap(4),
287         faith(4), epair(4), enc(4), tun(4), if_lagg(4), gre(4).
288
289 20121015:
290         The sdhci driver was split in two parts: sdhci (generic SD Host
291         Controller logic) and sdhci_pci (actual hardware driver).
292         No kernel config modifications are required, but if you
293         load sdhc as a module you must switch to sdhci_pci instead.
294
295 20121014:
296         Import the FUSE kernel and userland support into base system.
297
298 20121013:
299         The GNU sort(1) program has been removed since the BSD-licensed
300         sort(1) has been the default for quite some time and no serious
301         problems have been reported.  The corresponding WITH_GNU_SORT
302         knob has also gone.
303
304 20121006:
305         The pfil(9) API/ABI for AF_INET family has been changed. Packet
306         filtering modules: pf(4), ipfw(4), ipfilter(4) need to be recompiled
307         with new kernel.
308
309 20121001:
310         The net80211(4) ABI has been changed to allow for improved driver
311         PS-POLL and power-save support.  All wireless drivers need to be
312         recompiled to work with the new kernel.
313
314 20120913:
315         The random(4) support for the VIA hardware random number
316         generator (`PADLOCK') is no longer enabled unconditionally.
317         Add the PADLOCK_RNG option in the custom kernel config if
318         needed.  The GENERIC kernels on i386 and amd64 do include the
319         option, so the change only affects the custom kernel
320         configurations.
321
322 20120908:
323         The pf(4) packet filter ABI has been changed. pfctl(8) and
324         snmp_pf module need to be recompiled to work with new kernel.
325
326 20120828:
327         A new ZFS feature flag "com.delphix:empty_bpobj" has been merged
328         to -HEAD. Pools that have empty_bpobj in active state can not be
329         imported read-write with ZFS implementations that do not support
330         this feature. For more information read the zpool-features(5)
331         manual page.
332
333 20120727:
334         The sparc64 ZFS loader has been changed to no longer try to auto-
335         detect ZFS providers based on diskN aliases but now requires these
336         to be explicitly listed in the OFW boot-device environment variable. 
337
338 20120712:
339         The OpenSSL has been upgraded to 1.0.1c.  Any binaries requiring
340         libcrypto.so.6 or libssl.so.6 must be recompiled.  Also, there are
341         configuration changes.  Make sure to merge /etc/ssl/openssl.cnf.
342
343 20120712:
344         The following sysctls and tunables have been renamed for consistency
345         with other variables:
346           kern.cam.da.da_send_ordered   -> kern.cam.da.send_ordered
347           kern.cam.ada.ada_send_ordered -> kern.cam.ada.send_ordered
348
349 20120628:
350         The sort utility has been replaced with BSD sort.  For now, GNU sort
351         is also available as "gnusort" or the default can be set back to
352         GNU sort by setting WITH_GNU_SORT.  In this case, BSD sort will be
353         installed as "bsdsort".
354
355 20120611:
356         A new version of ZFS (pool version 5000) has been merged to -HEAD.
357         Starting with this version the old system of ZFS pool versioning
358         is superseded by "feature flags". This concept enables forward
359         compatibility against certain future changes in functionality of ZFS
360         pools. The first read-only compatible "feature flag" for ZFS pools
361         is named "com.delphix:async_destroy". For more information
362         read the new zpool-features(5) manual page.
363         Please refer to the "ZFS notes" section of this file for information
364         on upgrading boot ZFS pools.
365
366 20120417:
367         The malloc(3) implementation embedded in libc now uses sources imported
368         as contrib/jemalloc.  The most disruptive API change is to
369         /etc/malloc.conf.  If your system has an old-style /etc/malloc.conf,
370         delete it prior to installworld, and optionally re-create it using the
371         new format after rebooting.  See malloc.conf(5) for details
372         (specifically the TUNING section and the "opt.*" entries in the MALLCTL
373         NAMESPACE section).
374
375 20120328:
376         Big-endian MIPS TARGET_ARCH values no longer end in "eb".  mips64eb
377         is now spelled mips64.  mipsn32eb is now spelled mipsn32.  mipseb is
378         now spelled mips.  This is to aid compatibility with third-party
379         software that expects this naming scheme in uname(3).  Little-endian
380         settings are unchanged. If you are updating a big-endian mips64 machine
381         from before this change, you may need to set MACHINE_ARCH=mips64 in
382         your environment before the new build system will recognize your machine.
383
384 20120306:
385         Disable by default the option VFS_ALLOW_NONMPSAFE for all supported
386         platforms.
387
388 20120229:
389         Now unix domain sockets behave "as expected" on nullfs(5). Previously
390         nullfs(5) did not pass through all behaviours to the underlying layer,
391         as a result if we bound to a socket on the lower layer we could connect
392         only to the lower path; if we bound to the upper layer we could connect
393         only to the upper path. The new behavior is one can connect to both the
394         lower and the upper paths regardless what layer path one binds to.
395
396 20120211:
397         The getifaddrs upgrade path broken with 20111215 has been restored.
398         If you have upgraded in between 20111215 and 20120209 you need to
399         recompile libc again with your kernel.  You still need to recompile
400         world to be able to configure CARP but this restriction already
401         comes from 20111215.
402
403 20120114:
404         The set_rcvar() function has been removed from /etc/rc.subr.  All
405         base and ports rc.d scripts have been updated, so if you have a
406         port installed with a script in /usr/local/etc/rc.d you can either
407         hand-edit the rcvar= line, or reinstall the port.
408
409         An easy way to handle the mass-update of /etc/rc.d:
410         rm /etc/rc.d/* && mergemaster -i
411
412 20120109:
413         panic(9) now stops other CPUs in the SMP systems, disables interrupts
414         on the current CPU and prevents other threads from running.
415         This behavior can be reverted using the kern.stop_scheduler_on_panic
416         tunable/sysctl.
417         The new behavior can be incompatible with kern.sync_on_panic.
418
419 20111215:
420         The carp(4) facility has been changed significantly. Configuration
421         of the CARP protocol via ifconfig(8) has changed, as well as format
422         of CARP events submitted to devd(8) has changed. See manual pages
423         for more information. The arpbalance feature of carp(4) is currently
424         not supported anymore.
425
426         Size of struct in_aliasreq, struct in6_aliasreq has changed. User
427         utilities using SIOCAIFADDR, SIOCAIFADDR_IN6, e.g. ifconfig(8),
428         need to be recompiled.
429
430 20111122:
431         The acpi_wmi(4) status device /dev/wmistat has been renamed to
432         /dev/wmistat0.
433
434 20111108:
435         The option VFS_ALLOW_NONMPSAFE option has been added in order to
436         explicitely support non-MPSAFE filesystems.
437         It is on by default for all supported platform at this present
438         time.
439
440 20111101:
441         The broken amd(4) driver has been replaced with esp(4) in the amd64,
442         i386 and pc98 GENERIC kernel configuration files.
443
444 20110930:
445         sysinstall has been removed
446
447 20110923:
448         The stable/9 branch created in subversion.  This corresponds to the
449         RELENG_9 branch in CVS.
450
451 20110913:
452         This commit modifies vfs_register() so that it uses a hash
453         calculation to set vfc_typenum, which is enabled by default.
454         The first time a system is booted after this change, the
455         vfc_typenum values will change for all file systems. The
456         main effect of this is a change to the NFS server file handles
457         for file systems that use vfc_typenum in their fsid, such as ZFS.
458         It will, however, prevent vfc_typenum from changing when file
459         systems are loaded in a different order for subsequent reboots.
460         To disable this, you can set vfs.typenumhash=0 in /boot/loader.conf
461         until you are ready to remount all NFS clients after a reboot.
462
463 20110828:
464         Bump the shared library version numbers for libraries that
465         do not use symbol versioning, have changed the ABI compared
466         to stable/8 and which shared library version was not bumped.
467         Done as part of 9.0-RELEASE cycle.
468
469 20110815:
470         During the merge of Capsicum features, the fget(9) KPI was modified.
471         This may require the rebuilding of out-of-tree device drivers --
472         issues have been reported specifically with the nVidia device driver.
473         __FreeBSD_version is bumped to 900041.
474
475         Also, there is a period between 20110811 and 20110814 where the
476         special devices /dev/{stdin,stdout,stderr} did not work correctly.
477         Building world from a kernel during that window may not work.
478
479 20110628:
480         The packet filter (pf) code has been updated to OpenBSD 4.5.
481         You need to update userland tools to be in sync with kernel.
482         This update breaks backward compatibility with earlier pfsync(4)
483         versions.  Care must be taken when updating redundant firewall setups.
484
485 20110608:
486         The following sysctls and tunables are retired on x86 platforms:
487                 machdep.hlt_cpus
488                 machdep.hlt_logical_cpus
489         The following sysctl is retired:
490                 machdep.hyperthreading_allowed
491         The sysctls were supposed to provide a way to dynamically offline and
492         online selected CPUs on x86 platforms, but the implementation has not
493         been reliable especially with SCHED_ULE scheduler.
494         machdep.hyperthreading_allowed tunable is still available to ignore
495         hyperthreading CPUs at OS level.
496         Individual CPUs can be disabled using hint.lapic.X.disabled tunable,
497         where X is an APIC ID of a CPU.  Be advised, though, that disabling
498         CPUs in non-uniform fashion will result in non-uniform topology and
499         may lead to sub-optimal system performance with SCHED_ULE, which is
500         a default scheduler.
501
502 20110607:
503         cpumask_t type is retired and cpuset_t is used in order to describe
504         a mask of CPUs.
505
506 20110531:
507         Changes to ifconfig(8) for dynamic address family detection mandate
508         that you are running a kernel of 20110525 or later.  Make sure to
509         follow the update procedure to boot a new kernel before installing
510         world.
511
512 20110513:
513         Support for sun4v architecture is officially dropped
514
515 20110503:
516         Several KPI breaking changes have been committed to the mii(4) layer,
517         the PHY drivers and consequently some Ethernet drivers using mii(4).
518         This means that miibus.ko and the modules of the affected Ethernet
519         drivers need to be recompiled.
520
521         Note to kernel developers: Given that the OUI bit reversion problem
522         was fixed as part of these changes all mii(4) commits related to OUIs,
523         i.e. to sys/dev/mii/miidevs, PHY driver probing and vendor specific
524         handling, no longer can be merged verbatim to stable/8 and previous
525         branches.
526
527 20110430:
528         Users of the Atheros AR71xx SoC code now need to add 'device ar71xx_pci'
529         into their kernel configurations along with 'device pci'.
530
531 20110427:
532         The default NFS client is now the new NFS client, so fstype "newnfs"
533         is now "nfs" and the regular/old NFS client is now fstype "oldnfs".
534         Although mounts via fstype "nfs" will usually work without userland
535         changes, it is recommended that the mount(8) and mount_nfs(8)
536         commands be rebuilt from sources and that a link to mount_nfs called
537         mount_oldnfs be created. The new client is compiled into the
538         kernel with "options NFSCL" and this is needed for diskless root
539         file systems. The GENERIC kernel configs have been changed to use
540         NFSCL and NFSD (the new server) instead of NFSCLIENT and NFSSERVER.
541         To use the regular/old client, you can "mount -t oldnfs ...". For
542         a diskless root file system, you must also include a line like:
543         
544         vfs.root.mountfrom="oldnfs:"
545
546         in the boot/loader.conf on the root fs on the NFS server to make
547         a diskless root fs use the old client.
548
549 20110424:
550         The GENERIC kernels for all architectures now default to the new
551         CAM-based ATA stack. It means that all legacy ATA drivers were
552         removed and replaced by respective CAM drivers. If you are using
553         ATA device names in /etc/fstab or other places, make sure to update
554         them respectively (adX -> adaY, acdX -> cdY, afdX -> daY, astX -> saY,
555         where 'Y's are the sequential numbers starting from zero for each type
556         in order of detection, unless configured otherwise with tunables,
557         see cam(4)). There will be symbolic links created in /dev/ to map
558         old adX devices to the respective adaY. They should provide basic
559         compatibility for file systems mounting in most cases, but they do
560         not support old user-level APIs and do not have respective providers
561         in GEOM. Consider using updated management tools with new device names.
562
563         It is possible to load devices ahci, ata, siis and mvs as modules,
564         but option ATA_CAM should remain in kernel configuration to make ata
565         module work as CAM driver supporting legacy ATA controllers. Device ata
566         still can be used in modular fashion (atacore + ...). Modules atadisk
567         and atapi* are not used and won't affect operation in ATA_CAM mode.
568         Note that to use CAM-based ATA kernel should include CAM devices
569         scbus, pass, da (or explicitly ada), cd and optionally others. All of
570         them are parts of the cam module.
571
572         ataraid(4) functionality is now supported by the RAID GEOM class.
573         To use it you can load geom_raid kernel module and use graid(8) tool
574         for management. Instead of /dev/arX device names, use /dev/raid/rX.
575
576         No kernel config options or code have been removed, so if a problem
577         arises, please report it and optionally revert to the old ATA stack.
578         In order to do it you can remove from the kernel config:
579             options        ATA_CAM
580             device         ahci
581             device         mvs
582             device         siis
583         , and instead add back:
584             device         atadisk         # ATA disk drives
585             device         ataraid         # ATA RAID drives
586             device         atapicd         # ATAPI CDROM drives
587             device         atapifd         # ATAPI floppy drives
588             device         atapist         # ATAPI tape drives
589
590 20110423:
591         The default NFS server has been changed to the new server, which
592         was referred to as the experimental server. If you need to switch
593         back to the old NFS server, you must now put the "-o" option on
594         both the mountd and nfsd commands. This can be done using the
595         mountd_flags and nfs_server_flags rc.conf variables until an
596         update to the rc scripts is committed, which is coming soon.
597
598 20110418:
599         The GNU Objective-C runtime library (libobjc), and other Objective-C
600         related components have been removed from the base system.  If you
601         require an Objective-C library, please use one of the available ports.
602
603 20110331:
604         ath(4) has been split into bus- and device- modules. if_ath contains
605         the HAL, the TX rate control and the network device code. if_ath_pci
606         contains the PCI bus glue. For Atheros MIPS embedded systems, if_ath_ahb
607         contains the AHB glue. Users need to load both if_ath_pci and if_ath
608         in order to use ath on everything else.
609
610         TO REPEAT: if_ath_ahb is not needed for normal users. Normal users only
611         need to load if_ath and if_ath_pci for ath(4) operation.
612
613 20110314:
614         As part of the replacement of sysinstall, the process of building
615         release media has changed significantly. For details, please re-read
616         release(7), which has been updated to reflect the new build process.
617
618 20110218:
619         GNU binutils 2.17.50 (as of 2007-07-03) has been merged to -HEAD.  This
620         is the last available version under GPLv2.  It brings a number of new
621         features, such as support for newer x86 CPU's (with SSE-3, SSSE-3, SSE
622         4.1 and SSE 4.2), better support for powerpc64, a number of new
623         directives, and lots of other small improvements.  See the ChangeLog
624         file in contrib/binutils for the full details.
625
626 20110218:
627         IPsec's HMAC_SHA256-512 support has been fixed to be RFC4868
628         compliant, and will now use half of hash for authentication.
629         This will break interoperability with all stacks (including all
630         actual FreeBSD versions) who implement
631         draft-ietf-ipsec-ciph-sha-256-00 (they use 96 bits of hash for
632         authentication).
633         The only workaround with such peers is to use another HMAC
634         algorithm for IPsec ("phase 2") authentication.
635
636 20110207:
637         Remove the uio_yield prototype and symbol.  This function has
638         been misnamed since it was introduced and should not be
639         globally exposed with this name.  The equivalent functionality
640         is now available using kern_yield(curthread->td_user_pri).
641         The function remains undocumented.
642
643 20110112:
644         A SYSCTL_[ADD_]UQUAD was added for unsigned uint64_t pointers,
645         symmetric with the existing SYSCTL_[ADD_]QUAD.  Type checking
646         for scalar sysctls is defined but disabled.  Code that needs
647         UQUAD to pass the type checking that must compile on older
648         systems where the define is not present can check against
649         __FreeBSD_version >= 900030.
650
651         The system dialog(1) has been replaced with a new version previously
652         in ports as devel/cdialog. dialog(1) is mostly command-line compatible
653         with the previous version, but the libdialog associated with it has
654         a largely incompatible API. As such, the original version of libdialog
655         will be kept temporarily as libodialog, until its base system consumers
656         are replaced or updated. Bump __FreeBSD_version to 900030.
657
658 20110103:
659         If you are trying to run make universe on a -stable system, and you get
660         the following warning:
661         "Makefile", line 356: "Target architecture for i386/conf/GENERIC 
662         unknown.  config(8) likely too old."
663         or something similar to it, then you must upgrade your -stable system
664         to 8.2-Release or newer (really, any time after r210146 7/15/2010 in
665         stable/8) or build the config from the latest stable/8 branch and
666         install it on your system.
667
668         Prior to this date, building a current universe on 8-stable system from
669         between 7/15/2010 and 1/2/2011 would result in a weird shell parsing
670         error in the first kernel build phase.  A new config on those old 
671         systems will fix that problem for older versions of -current.
672
673 20101228:
674         The TCP stack has been modified to allow Khelp modules to interact with
675         it via helper hook points and store per-connection data in the TCP
676         control block. Bump __FreeBSD_version to 900029. User space tools that
677         rely on the size of struct tcpcb in tcp_var.h (e.g. sockstat) need to
678         be recompiled.
679
680 20101114:
681         Generic IEEE 802.3 annex 31B full duplex flow control support has been
682         added to mii(4) and bge(4), bce(4), msk(4), nfe(4) and stge(4) along
683         with brgphy(4), e1000phy(4) as well as ip1000phy() have been converted
684         to take advantage of it instead of using custom implementations.  This
685         means that these drivers now no longer unconditionally advertise
686         support for flow control but only do so if flow control is a selected
687         media option.  This was implemented in the generic support that way in
688         order to allow flow control to be switched on and off via ifconfig(8)
689         with the PHY specific default to typically off in order to protect
690         from unwanted effects.  Consequently, if you used flow control with
691         one of the above mentioned drivers you now need to explicitly enable
692         it, for example via:
693                 ifconfig bge0 media auto mediaopt flowcontrol
694
695         Along with the above mentioned changes generic support for setting
696         1000baseT master mode also has been added and brgphy(4), ciphy(4),
697         e1000phy(4) as well as ip1000phy(4) have been converted to take
698         advantage of it.  This means that these drivers now no longer take the
699         link0 parameter for selecting master mode but the master media option
700         has to be used instead, for example like in the following:
701                 ifconfig bge0 media 1000baseT mediaopt full-duplex,master
702
703         Selection of master mode now is also available with all other PHY
704         drivers supporting 1000baseT.
705
706 20101111:
707         The TCP stack has received a significant update to add support for
708         modularised congestion control and generally improve the clarity of
709         congestion control decisions. Bump __FreeBSD_version to 900025. User
710         space tools that rely on the size of struct tcpcb in tcp_var.h (e.g.
711         sockstat) need to be recompiled.
712
713 20101002:
714         The man(1) utility has been replaced by a new version that no longer
715         uses /etc/manpath.config. Please consult man.conf(5) for how to
716         migrate local entries to the new format.
717
718 20100928:
719         The copyright strings printed by login(1) and sshd(8) at the time of a
720         new connection have been removed to follow other operating systems and
721         upstream sshd.
722
723 20100915:
724         A workaround for a fixed ld bug has been removed in kernel code,
725         so make sure that your system ld is built from sources after
726         revision 210245 from 2010-07-19 (r211583 if building head kernel
727         on stable/8, r211584 for stable/7; both from 2010-08-21).
728         A symptom of incorrect ld version is different addresses for
729         set_pcpu section and __start_set_pcpu symbol in kernel and/or modules.
730
731 20100913:
732         The $ipv6_prefer variable in rc.conf(5) has been split into
733         $ip6addrctl_policy and $ipv6_activate_all_interfaces.
734
735         The $ip6addrctl_policy is a variable to choose a pre-defined
736         address selection policy set by ip6addrctl(8).  A value
737         "ipv4_prefer", "ipv6_prefer" or "AUTO" can be specified.  The
738         default is "AUTO".
739
740         The $ipv6_activate_all_interfaces specifies whether IFDISABLED
741         flag (see an entry of 20090926) is set on an interface with no
742         corresponding $ifconfig_IF_ipv6 line.  The default is "NO" for
743         security reason.  If you want IPv6 link-local address on all
744         interfaces by default, set this to "YES".
745
746         The old ipv6_prefer="YES" is equivalent to
747         ipv6_activate_all_interfaces="YES" and
748         ip6addrctl_policy="ipv6_prefer".
749
750 20100913:
751         DTrace has grown support for userland tracing. Due to this, DTrace is
752         now i386 and amd64 only.
753         dtruss(1) is now installed by default on those systems and a new
754         kernel module is needed for userland tracing: fasttrap.
755         No changes to your kernel config file are necessary to enable
756         userland tracing, but you might consider adding 'STRIP=' and
757         'CFLAGS+=-fno-omit-frame-pointer' to your make.conf if you want
758         to have informative userland stack traces in DTrace (ustack).
759
760 20100725:
761         The acpi_aiboost(4) driver has been removed in favor of the new
762         aibs(4) driver. You should update your kernel configuration file.
763
764 20100722:
765         BSD grep has been imported to the base system and it is built by
766         default.  It is completely BSD licensed, highly GNU-compatible, uses
767         less memory than its GNU counterpart and has a small codebase.
768         However, it is slower than its GNU counterpart, which is mostly
769         noticeable for larger searches, for smaller ones it is measurable
770         but not significant.  The reason is complex, the most important factor
771         is that we lack a modern and efficient regex library and GNU
772         overcomes this by optimizing the searches internally.  Future work
773         on improving the regex performance is planned, for the meantime,
774         users that need better performance, can build GNU grep instead by
775         setting the WITH_GNU_GREP knob.
776
777 20100713:
778         Due to the import of powerpc64 support, all existing powerpc kernel
779         configuration files must be updated with a machine directive like this:
780             machine powerpc powerpc
781
782         In addition, an updated config(8) is required to build powerpc kernels
783         after this change.
784
785 20100713:
786         A new version of ZFS (version 15) has been merged to -HEAD.
787         This version uses a python library for the following subcommands:
788         zfs allow, zfs unallow, zfs groupspace, zfs userspace.
789         For full functionality of these commands the following port must
790         be installed: sysutils/py-zfs
791
792 20100429:
793         'vm_page's are now hashed by physical address to an array of mutexes.
794         Currently this is only used to serialize access to hold_count. Over 
795         time the page queue mutex will be peeled away. This changes the size
796         of pmap on every architecture. And requires all callers of vm_page_hold
797         and vm_page_unhold to be updated. 
798  
799 20100402:
800         WITH_CTF can now be specified in src.conf (not recommended, there
801         are some problems with static executables), make.conf (would also
802         affect ports which do not use GNU make and do not override the
803         compile targets) or in the kernel config (via "makeoptions
804         WITH_CTF=yes").
805         When WITH_CTF was specified there before this was silently ignored,
806         so make sure that WITH_CTF is not used in places which could lead
807         to unwanted behavior.
808
809 20100311:
810         The kernel option COMPAT_IA32 has been replaced with COMPAT_FREEBSD32
811         to allow 32-bit compatibility on non-x86 platforms. All kernel
812         configurations on amd64 and ia64 platforms using these options must
813         be modified accordingly.
814
815 20100113:
816         The utmp user accounting database has been replaced with utmpx,
817         the user accounting interface standardized by POSIX.
818         Unfortunately the semantics of utmp and utmpx don't match,
819         making it practically impossible to support both interfaces.
820         The user accounting database is used by tools like finger(1),
821         last(1), talk(1), w(1) and ac(8).
822
823         All applications in the base system use utmpx.  This means only
824         local binaries (e.g. from the ports tree) may still use these
825         utmp database files.  These applications must be rebuilt to make
826         use of utmpx.
827
828         After the system has been upgraded, it is safe to remove the old
829         log files (/var/run/utmp, /var/log/lastlog and /var/log/wtmp*),
830         assuming their contents is of no importance anymore.  Old wtmp
831         databases can only be used by last(1) and ac(8) after they have
832         been converted to the new format using wtmpcvt(1).
833
834 20100108:
835         Introduce the kernel thread "deadlock resolver" (which can be enabled
836         via the DEADLKRES option, see NOTES for more details) and the
837         sleepq_type() function for sleepqueues.
838
839 20091202:
840         The rc.firewall and rc.firewall6 were unified, and
841         rc.firewall6 and rc.d/ip6fw were removed.
842         According to the removal of rc.d/ip6fw, ipv6_firewall_* rc
843         variables are obsoleted.  Instead, the following new rc
844         variables are added to rc.d/ipfw:
845
846                 firewall_client_net_ipv6, firewall_simple_iif_ipv6,
847                 firewall_simple_inet_ipv6, firewall_simple_oif_ipv6,
848                 firewall_simple_onet_ipv6, firewall_trusted_ipv6
849
850         The meanings correspond to the relevant IPv4 variables.
851
852 20091125:
853         8.0-RELEASE.
854
855 20091113:
856         The default terminal emulation for syscons(4) has been changed
857         from cons25 to xterm on all platforms except pc98.  This means
858         that the /etc/ttys file needs to be updated to ensure correct
859         operation of applications on the console.
860
861         The terminal emulation style can be toggled per window by using
862         vidcontrol(1)'s -T flag.  The TEKEN_CONS25 kernel configuration
863         options can be used to change the compile-time default back to
864         cons25.
865
866         To prevent graphical artifacts, make sure the TERM environment
867         variable is set to match the terminal emulation that is being
868         performed by syscons(4).
869
870 20091109:
871         The layout of the structure ieee80211req_scan_result has changed.
872         Applications that require wireless scan results (e.g. ifconfig(8))
873         from net80211 need to be recompiled.
874
875         Applications such as wpa_supplicant(8) may require a full world
876         build without using NO_CLEAN in order to get synchronized with the
877         new structure.
878
879 20091025:
880         The iwn(4) driver has been updated to support the 5000 and 5150 series.
881         There's one kernel module for each firmware. Adding "device iwnfw"
882         to the kernel configuration file means including all three firmware
883         images inside the kernel. If you want to include just the one for
884         your wireless card, use the devices iwn4965fw, iwn5000fw or
885         iwn5150fw.
886
887 20090926:
888         The rc.d/network_ipv6, IPv6 configuration script has been integrated
889         into rc.d/netif.  The changes are the following:
890
891         1. To use IPv6, simply define $ifconfig_IF_ipv6 like $ifconfig_IF
892            for IPv4.  For aliases, $ifconfig_IF_aliasN should be used.
893            Note that both variables need the "inet6" keyword at the head.
894
895            Do not set $ipv6_network_interfaces manually if you do not
896            understand what you are doing.  It is not needed in most cases. 
897
898            $ipv6_ifconfig_IF and $ipv6_ifconfig_IF_aliasN still work, but
899            they are obsolete.
900
901         2. $ipv6_enable is obsolete.  Use $ipv6_prefer and
902            "inet6 accept_rtadv" keyword in ifconfig(8) instead.
903
904            If you define $ipv6_enable=YES, it means $ipv6_prefer=YES and
905            all configured interfaces have "inet6 accept_rtadv" in the
906            $ifconfig_IF_ipv6.  These are for backward compatibility.
907
908         3. A new variable $ipv6_prefer has been added.  If NO, IPv6
909            functionality of interfaces with no corresponding
910            $ifconfig_IF_ipv6 is disabled by using "inet6 ifdisabled" flag,
911            and the default address selection policy of ip6addrctl(8) 
912            is the IPv4-preferred one (see rc.d/ip6addrctl for more details).
913            Note that if you want to configure IPv6 functionality on the
914            disabled interfaces after boot, first you need to clear the flag by
915            using ifconfig(8) like:
916
917                 ifconfig em0 inet6 -ifdisabled
918
919            If YES, the default address selection policy is set as
920            IPv6-preferred.
921
922            The default value of $ipv6_prefer is NO.
923
924         4. If your system need to receive Router Advertisement messages,
925            define "inet6 accept_rtadv" in $ifconfig_IF_ipv6.  The rc(8)
926            scripts automatically invoke rtsol(8) when the interface becomes
927            UP.  The Router Advertisement messages are used for SLAAC
928            (State-Less Address AutoConfiguration).
929
930 20090922:
931         802.11s D3.03 support was committed. This is incompatible with the
932         previous code, which was based on D3.0.
933
934 20090912:
935         A sysctl variable net.inet6.ip6.accept_rtadv now sets the default value
936         of a per-interface flag ND6_IFF_ACCEPT_RTADV, not a global knob to
937         control whether accepting Router Advertisement messages or not.
938         Also, a per-interface flag ND6_IFF_AUTO_LINKLOCAL has been added and
939         a sysctl variable net.inet6.ip6.auto_linklocal is its default value.
940         The ifconfig(8) utility now supports these flags.
941
942 20090910:
943         ZFS snapshots are now mounted with MNT_IGNORE flag. Use -v option for
944         mount(8) and -a option for df(1) to see them.
945
946 20090825:
947         The old tunable hw.bus.devctl_disable has been superseded by
948         hw.bus.devctl_queue.  hw.bus.devctl_disable=1 in loader.conf should be
949         replaced by hw.bus.devctl_queue=0.  The default for this new tunable
950         is 1000.
951
952 20090813:
953         Remove the option STOP_NMI.  The default action is now to use NMI only
954         for KDB via the newly introduced function stop_cpus_hard() and
955         maintain stop_cpus() to just use a normal IPI_STOP on ia32 and amd64.
956
957 20090803:
958         The stable/8 branch created in subversion.  This corresponds to the
959         RELENG_8 branch in CVS.
960
961 20090719:
962         Bump the shared library version numbers for all libraries that do not
963         use symbol versioning as part of the 8.0-RELEASE cycle.  Bump
964         __FreeBSD_version to 800105.
965
966 20090714:
967         Due to changes in the implementation of virtual network stack support,
968         all network-related kernel modules must be recompiled.  As this change
969         breaks the ABI, bump __FreeBSD_version to 800104.
970
971 20090713:
972         The TOE interface to the TCP syncache has been modified to remove
973         struct tcpopt (<netinet/tcp_var.h>) from the ABI of the network stack.
974         The cxgb driver is the only TOE consumer affected by this change, and
975         needs to be recompiled along with the kernel. As this change breaks
976         the ABI, bump __FreeBSD_version to 800103.
977
978 20090712: 
979         Padding has been added to struct tcpcb, sackhint and tcpstat in
980         <netinet/tcp_var.h> to facilitate future MFCs and bug fixes whilst
981         maintaining the ABI. However, this change breaks the ABI, so bump
982         __FreeBSD_version to 800102. User space tools that rely on the size of
983         any of these structs (e.g. sockstat) need to be recompiled.
984
985 20090630:
986         The NFS_LEGACYRPC option has been removed along with the old kernel
987         RPC implementation that this option selected. Kernel configurations
988         may need to be adjusted.
989
990 20090629:
991         The network interface device nodes at /dev/net/<interface> have been
992         removed.  All ioctl operations can be performed the normal way using
993         routing sockets.  The kqueue functionality can generally be replaced
994         with routing sockets.
995
996 20090628:
997         The documentation from the FreeBSD Documentation Project (Handbook,
998         FAQ, etc.) is now installed via packages by sysinstall(8) and under
999         the /usr/local/share/doc/freebsd directory instead of /usr/share/doc.
1000
1001 20090624:
1002         The ABI of various structures related to the SYSV IPC API have been
1003         changed.  As a result, the COMPAT_FREEBSD[456] and COMPAT_43 kernel
1004         options now all require COMPAT_FREEBSD7.  Bump __FreeBSD_version to
1005         800100.
1006
1007 20090622:
1008         Layout of struct vnet has changed as routing related variables were
1009         moved to their own Vimage module. Modules need to be recompiled.  Bump
1010         __FreeBSD_version to 800099.
1011
1012 20090619:
1013         NGROUPS_MAX and NGROUPS have been increased from 16 to 1023 and 1024
1014         respectively.  As long as no more than 16 groups per process are used,
1015         no changes should be visible.  When more than 16 groups are used, old
1016         binaries may fail if they call getgroups() or getgrouplist() with
1017         statically sized storage.  Recompiling will work around this, but
1018         applications should be modified to use dynamically allocated storage
1019         for group arrays as POSIX.1-2008 does not cap an implementation's
1020         number of supported groups at NGROUPS_MAX+1 as previous versions did.
1021
1022         NFS and portalfs mounts may also be affected as the list of groups is
1023         truncated to 16.  Users of NFS who use more than 16 groups, should
1024         take care that negative group permissions are not used on the exported
1025         file systems as they will not be reliable unless a GSSAPI based
1026         authentication method is used.
1027
1028 20090616: 
1029         The compiling option ADAPTIVE_LOCKMGRS has been introduced.  This
1030         option compiles in the support for adaptive spinning for lockmgrs
1031         which want to enable it.  The lockinit() function now accepts the flag
1032         LK_ADAPTIVE in order to make the lock object subject to adaptive
1033         spinning when both held in write and read mode.
1034
1035 20090613:
1036         The layout of the structure returned by IEEE80211_IOC_STA_INFO has
1037         changed.  User applications that use this ioctl need to be rebuilt.
1038
1039 20090611:
1040         The layout of struct thread has changed.  Kernel and modules need to
1041         be rebuilt.
1042
1043 20090608:
1044         The layout of structs ifnet, domain, protosw and vnet_net has changed.
1045         Kernel modules need to be rebuilt.  Bump __FreeBSD_version to 800097.
1046
1047 20090602:
1048         window(1) has been removed from the base system. It can now be
1049         installed from ports. The port is called misc/window.
1050
1051 20090601:
1052         The way we are storing and accessing `routing table' entries has
1053         changed. Programs reading the FIB, like netstat, need to be
1054         re-compiled.
1055
1056 20090601:
1057         A new netisr implementation has been added for FreeBSD 8.  Network
1058         file system modules, such as igmp, ipdivert, and others, should be
1059         rebuilt.
1060         Bump __FreeBSD_version to 800096.
1061
1062 20090530:
1063         Remove the tunable/sysctl debug.mpsafevfs as its initial purpose is no
1064         more valid.
1065
1066 20090530:
1067         Add VOP_ACCESSX(9).  File system modules need to be rebuilt.
1068         Bump __FreeBSD_version to 800094.
1069
1070 20090529:
1071         Add mnt_xflag field to 'struct mount'.  File system modules need to be
1072         rebuilt.
1073         Bump __FreeBSD_version to 800093.
1074
1075 20090528:
1076         The compiling option ADAPTIVE_SX has been retired while it has been
1077         introduced the option NO_ADAPTIVE_SX which handles the reversed logic.
1078         The KPI for sx_init_flags() changes as accepting flags:
1079         SX_ADAPTIVESPIN flag has been retired while the SX_NOADAPTIVE flag has
1080         been introduced in order to handle the reversed logic.
1081         Bump __FreeBSD_version to 800092.
1082
1083 20090527:
1084         Add support for hierarchical jails.  Remove global securelevel.
1085         Bump __FreeBSD_version to 800091.
1086
1087 20090523:
1088         The layout of struct vnet_net has changed, therefore modules
1089         need to be rebuilt.
1090         Bump __FreeBSD_version to 800090.
1091
1092 20090523:
1093         The newly imported zic(8) produces a new format in the output. Please
1094         run tzsetup(8) to install the newly created data to /etc/localtime.
1095
1096 20090520:
1097         The sysctl tree for the usb stack has renamed from hw.usb2.* to
1098         hw.usb.* and is now consistent again with previous releases.
1099
1100 20090520:
1101         802.11 monitor mode support was revised and driver api's were changed.
1102         Drivers dependent on net80211 now support DLT_IEEE802_11_RADIO instead
1103         of DLT_IEEE802_11.  No user-visible data structures were changed but
1104         applications that use DLT_IEEE802_11 may require changes.
1105         Bump __FreeBSD_version to 800088.
1106
1107 20090430:
1108         The layout of the following structs has changed: sysctl_oid,
1109         socket, ifnet, inpcbinfo, tcpcb, syncache_head, vnet_inet,
1110         vnet_inet6 and vnet_ipfw.  Most modules need to be rebuild or
1111         panics may be experienced.  World rebuild is required for
1112         correctly checking networking state from userland.
1113         Bump __FreeBSD_version to 800085.
1114
1115 20090429:
1116         MLDv2 and Source-Specific Multicast (SSM) have been merged
1117         to the IPv6 stack. VIMAGE hooks are in but not yet used.
1118         The implementation of SSM within FreeBSD's IPv6 stack closely
1119         follows the IPv4 implementation.
1120
1121         For kernel developers:
1122
1123         * The most important changes are that the ip6_output() and
1124           ip6_input() paths no longer take the IN6_MULTI_LOCK,
1125           and this lock has been downgraded to a non-recursive mutex.
1126
1127         * As with the changes to the IPv4 stack to support SSM, filtering
1128           of inbound multicast traffic must now be performed by transport
1129           protocols within the IPv6 stack. This does not apply to TCP and
1130           SCTP, however, it does apply to UDP in IPv6 and raw IPv6.
1131
1132         * The KPIs used by IPv6 multicast are similar to those used by
1133           the IPv4 stack, with the following differences:
1134            * im6o_mc_filter() is analogous to imo_multicast_filter().
1135            * The legacy KAME entry points in6_joingroup and in6_leavegroup()
1136              are shimmed to in6_mc_join() and in6_mc_leave() respectively.
1137            * IN6_LOOKUP_MULTI() has been deprecated and removed.
1138            * IPv6 relies on MLD for the DAD mechanism. KAME's internal KPIs
1139              for MLDv1 have an additional 'timer' argument which is used to
1140              jitter the initial membership report for the solicited-node
1141              multicast membership on-link.
1142            * This is not strictly needed for MLDv2, which already jitters
1143              its report transmissions.  However, the 'timer' argument is
1144              preserved in case MLDv1 is active on the interface.
1145
1146         * The KAME linked-list based IPv6 membership implementation has
1147           been refactored to use a vector similar to that used by the IPv4
1148           stack.
1149           Code which maintains a list of its own multicast memberships
1150           internally, e.g. carp, has been updated to reflect the new
1151           semantics.
1152
1153         * There is a known Lock Order Reversal (LOR) due to in6_setscope()
1154           acquiring the IF_AFDATA_LOCK and being called within ip6_output().
1155           Whilst MLDv2 tries to avoid this otherwise benign LOR, it is an
1156           implementation constraint which needs to be addressed in HEAD.
1157
1158         For application developers:
1159
1160         * The changes are broadly similar to those made for the IPv4
1161           stack.
1162
1163         * The use of IPv4 and IPv6 multicast socket options on the same
1164           socket, using mapped addresses, HAS NOT been tested or supported.
1165
1166         * There are a number of issues with the implementation of various
1167           IPv6 multicast APIs which need to be resolved in the API surface
1168           before the implementation is fully compatible with KAME userland
1169           use, and these are mostly to do with interface index treatment.
1170
1171         * The literature available discusses the use of either the delta / ASM
1172           API with setsockopt(2)/getsockopt(2), or the full-state / ASM API
1173           using setsourcefilter(3)/getsourcefilter(3). For more information
1174           please refer to RFC 3768, 'Socket Interface Extensions for
1175           Multicast Source Filters'.
1176
1177         * Applications which use the published RFC 3678 APIs should be fine.
1178
1179         For systems administrators:
1180
1181         * The mtest(8) utility has been refactored to support IPv6, in
1182           addition to IPv4. Interface addresses are no longer accepted
1183           as arguments, their names must be used instead. The utility
1184           will map the interface name to its first IPv4 address as
1185           returned by getifaddrs(3).
1186
1187         * The ifmcstat(8) utility has also been updated to print the MLDv2
1188           endpoint state and source filter lists via sysctl(3).
1189
1190         * The net.inet6.ip6.mcast.loop sysctl may be tuned to 0 to disable
1191           loopback of IPv6 multicast datagrams by default; it defaults to 1
1192           to preserve the existing behaviour. Disabling multicast loopback is
1193           recommended for optimal system performance.
1194
1195         * The IPv6 MROUTING code has been changed to examine this sysctl
1196           instead of attempting to perform a group lookup before looping
1197           back forwarded datagrams.
1198
1199         Bump __FreeBSD_version to 800084.
1200
1201 20090422:
1202         Implement low-level Bluetooth HCI API.
1203         Bump __FreeBSD_version to 800083.
1204
1205 20090419:
1206         The layout of struct malloc_type, used by modules to register new
1207         memory allocation types, has changed.  Most modules will need to
1208         be rebuilt or panics may be experienced.
1209         Bump __FreeBSD_version to 800081.
1210
1211 20090415:
1212         Anticipate overflowing inp_flags - add inp_flags2.
1213         This changes most offsets in inpcb, so checking v4 connection
1214         state will require a world rebuild.
1215         Bump __FreeBSD_version to 800080.
1216
1217 20090415:
1218         Add an llentry to struct route and struct route_in6. Modules
1219         embedding a struct route will need to be recompiled.
1220         Bump __FreeBSD_version to 800079.
1221
1222 20090414:
1223         The size of rt_metrics_lite and by extension rtentry has changed.
1224         Networking administration apps will need to be recompiled.
1225         The route command now supports show as an alias for get, weighting
1226         of routes, sticky and nostick flags to alter the behavior of stateful
1227         load balancing.
1228         Bump __FreeBSD_version to 800078.
1229
1230 20090408:
1231         Do not use Giant for kbdmux(4) locking. This is wrong and
1232         apparently causing more problems than it solves. This will
1233         re-open the issue where interrupt handlers may race with
1234         kbdmux(4) in polling mode. Typical symptoms include (but
1235         not limited to) duplicated and/or missing characters when
1236         low level console functions (such as gets) are used while
1237         interrupts are enabled (for example geli password prompt,
1238         mountroot prompt etc.). Disabling kbdmux(4) may help.
1239
1240 20090407:
1241         The size of structs vnet_net, vnet_inet and vnet_ipfw has changed;
1242         kernel modules referencing any of the above need to be recompiled.
1243         Bump __FreeBSD_version to 800075.
1244
1245 20090320:
1246         GEOM_PART has become the default partition slicer for storage devices,
1247         replacing GEOM_MBR, GEOM_BSD, GEOM_PC98 and GEOM_GPT slicers. It
1248         introduces some changes:
1249
1250         MSDOS/EBR: the devices created from MSDOS extended partition entries
1251         (EBR) can be named differently than with GEOM_MBR and are now symlinks
1252         to devices with offset-based names. fstabs may need to be modified.
1253
1254         BSD: the "geometry does not match label" warning is harmless in most
1255         cases but it points to problems in file system misalignment with
1256         disk geometry. The "c" partition is now implicit, covers the whole
1257         top-level drive and cannot be (mis)used by users.
1258
1259         General: Kernel dumps are now not allowed to be written to devices
1260         whose partition types indicate they are meant to be used for file
1261         systems (or, in case of MSDOS partitions, as something else than
1262         the "386BSD" type).
1263
1264         Most of these changes date approximately from 200812.
1265
1266 20090319:
1267         The uscanner(4) driver has been removed from the kernel. This follows
1268         Linux removing theirs in 2.6 and making libusb the default interface
1269         (supported by sane).
1270
1271 20090319:
1272         The multicast forwarding code has been cleaned up. netstat(1)
1273         only relies on KVM now for printing bandwidth upcall meters.
1274         The IPv4 and IPv6 modules are split into ip_mroute_mod and
1275         ip6_mroute_mod respectively. The config(5) options for statically
1276         compiling this code remain the same, i.e. 'options MROUTING'.
1277
1278 20090315:
1279         Support for the IFF_NEEDSGIANT network interface flag has been
1280         removed, which means that non-MPSAFE network device drivers are no
1281         longer supported.  In particular, if_ar, if_sr, and network device
1282         drivers from the old (legacy) USB stack can no longer be built or
1283         used.
1284
1285 20090313:
1286         POSIX.1 Native Language Support (NLS) has been enabled in libc and
1287         a bunch of new language catalog files have also been added.
1288         This means that some common libc messages are now localized and
1289         they depend on the LC_MESSAGES environmental variable.
1290
1291 20090313:
1292         The k8temp(4) driver has been renamed to amdtemp(4) since
1293         support for Family 10 and Family 11 CPU families was added.
1294
1295 20090309:
1296         IGMPv3 and Source-Specific Multicast (SSM) have been merged
1297         to the IPv4 stack. VIMAGE hooks are in but not yet used.
1298
1299         For kernel developers, the most important changes are that the
1300         ip_output() and ip_input() paths no longer take the IN_MULTI_LOCK(),
1301         and this lock has been downgraded to a non-recursive mutex.
1302
1303         Transport protocols (UDP, Raw IP) are now responsible for filtering
1304         inbound multicast traffic according to group membership and source
1305         filters. The imo_multicast_filter() KPI exists for this purpose.
1306         Transports which do not use multicast (SCTP, TCP) already reject
1307         multicast by default. Forwarding and receive performance may improve
1308         as a mutex acquisition is no longer needed in the ip_input()
1309         low-level input path.  in_addmulti() and in_delmulti() are shimmed
1310         to new KPIs which exist to support SSM in-kernel.
1311
1312         For application developers, it is recommended that loopback of
1313         multicast datagrams be disabled for best performance, as this
1314         will still cause the lock to be taken for each looped-back
1315         datagram transmission. The net.inet.ip.mcast.loop sysctl may
1316         be tuned to 0 to disable loopback by default; it defaults to 1
1317         to preserve the existing behaviour.
1318
1319         For systems administrators, to obtain best performance with
1320         multicast reception and multiple groups, it is always recommended
1321         that a card with a suitably precise hash filter is used. Hash
1322         collisions will still result in the lock being taken within the
1323         transport protocol input path to check group membership.
1324
1325         If deploying FreeBSD in an environment with IGMP snooping switches,
1326         it is recommended that the net.inet.igmp.sendlocal sysctl remain
1327         enabled; this forces 224.0.0.0/24 group membership to be announced
1328         via IGMP.
1329
1330         The size of 'struct igmpstat' has changed; netstat needs to be
1331         recompiled to reflect this.
1332         Bump __FreeBSD_version to 800070.
1333
1334 20090309:
1335         libusb20.so.1 is now installed as libusb.so.1 and the ports system
1336         updated to use it. This requires a buildworld/installworld in order to
1337         update the library and dependencies (usbconfig, etc). Its advisable to
1338         rebuild all ports which uses libusb. More specific directions are given
1339         in the ports collection UPDATING file. Any /etc/libmap.conf entries for
1340         libusb are no longer required and can be removed.
1341
1342 20090302:
1343         A workaround is committed to allow the creation of System V shared
1344         memory segment of size > 2 GB on the 64-bit architectures.
1345         Due to a limitation of the existing ABI, the shm_segsz member
1346         of the struct shmid_ds, returned by shmctl(IPC_STAT) call is
1347         wrong for large segments. Note that limits must be explicitly
1348         raised to allow such segments to be created.
1349
1350 20090301:
1351         The layout of struct ifnet has changed, requiring a rebuild of all
1352         network device driver modules.
1353
1354 20090227:
1355         The /dev handling for the new USB stack has changed, a
1356         buildworld/installworld is required for libusb20.
1357
1358 20090223:
1359         The new USB2 stack has now been permanently moved in and all kernel and
1360         module names reverted to their previous values (eg, usb, ehci, ohci,
1361         ums, ...).  The old usb stack can be compiled in by prefixing the name
1362         with the letter 'o', the old usb modules have been removed.
1363         Updating entry 20090216 for xorg and 20090215 for libmap may still
1364         apply.
1365
1366 20090217:
1367         The rc.conf(5) option if_up_delay has been renamed to
1368         defaultroute_delay to better reflect its purpose. If you have
1369         customized this setting in /etc/rc.conf you need to update it to
1370         use the new name.
1371
1372 20090216:
1373         xorg 7.4 wants to configure its input devices via hald which does not
1374         yet work with USB2. If the keyboard/mouse does not work in xorg then
1375         add
1376                 Option "AllowEmptyInput" "off"
1377         to your ServerLayout section.  This will cause X to use the configured
1378         kbd and mouse sections from your xorg.conf.
1379
1380 20090215:
1381         The GENERIC kernels for all architectures now default to the new USB2
1382         stack. No kernel config options or code have been removed so if a
1383         problem arises please report it and optionally revert to the old USB
1384         stack. If you are loading USB kernel modules or have a custom kernel
1385         that includes GENERIC then ensure that usb names are also changed over,
1386         eg uftdi -> usb2_serial_ftdi.
1387
1388         Older programs linked against the ports libusb 0.1 need to be
1389         redirected to the new stack's libusb20.  /etc/libmap.conf can
1390         be used for this:
1391                 # Map old usb library to new one for usb2 stack
1392                 libusb-0.1.so.8 libusb20.so.1
1393
1394 20090209:
1395         All USB ethernet devices now attach as interfaces under the name ueN
1396         (eg. ue0). This is to provide a predictable name as vendors often
1397         change usb chipsets in a product without notice.
1398
1399 20090203:
1400         The ichsmb(4) driver has been changed to require SMBus slave
1401         addresses be left-justified (xxxxxxx0b) rather than right-justified.
1402         All of the other SMBus controller drivers require left-justified
1403         slave addresses, so this change makes all the drivers provide the
1404         same interface.
1405
1406 20090201:
1407         INET6 statistics (struct ip6stat) was updated.
1408         netstat(1) needs to be recompiled.
1409
1410 20090119:
1411         NTFS has been removed from GENERIC kernel on amd64 to match
1412         GENERIC on i386. Should not cause any issues since mount_ntfs(8)
1413         will load ntfs.ko module automatically when NTFS support is
1414         actually needed, unless ntfs.ko is not installed or security
1415         level prohibits loading kernel modules. If either is the case,
1416         "options NTFS" has to be added into kernel config.
1417
1418 20090115:
1419         TCP Appropriate Byte Counting (RFC 3465) support added to kernel.
1420         New field in struct tcpcb breaks ABI, so bump __FreeBSD_version to
1421         800061. User space tools that rely on the size of struct tcpcb in
1422         tcp_var.h (e.g. sockstat) need to be recompiled.
1423
1424 20081225:
1425         ng_tty(4) module updated to match the new TTY subsystem.
1426         Due to API change, user-level applications must be updated.
1427         New API support added to mpd5 CVS and expected to be present
1428         in next mpd5.3 release.
1429
1430 20081219:
1431         With __FreeBSD_version 800060 the makefs tool is part of
1432         the base system (it was a port).
1433
1434 20081216:
1435         The afdata and ifnet locks have been changed from mutexes to
1436         rwlocks, network modules will need to be re-compiled.
1437
1438 20081214:
1439         __FreeBSD_version 800059 incorporates the new arp-v2 rewrite.
1440         RTF_CLONING, RTF_LLINFO and RTF_WASCLONED flags are eliminated.
1441         The new code reduced struct rtentry{} by 16 bytes on 32-bit
1442         architecture and 40 bytes on 64-bit architecture. The userland
1443         applications "arp" and "ndp" have been updated accordingly.
1444         The output from "netstat -r" shows only routing entries and
1445         none of the L2 information.
1446
1447 20081130:
1448         __FreeBSD_version 800057 marks the switchover from the
1449         binary ath hal to source code. Users must add the line:
1450
1451         options AH_SUPPORT_AR5416
1452
1453         to their kernel config files when specifying:
1454
1455         device  ath_hal
1456
1457         The ath_hal module no longer exists; the code is now compiled
1458         together with the driver in the ath module.  It is now
1459         possible to tailor chip support (i.e. reduce the set of chips
1460         and thereby the code size); consult ath_hal(4) for details.
1461
1462 20081121:
1463         __FreeBSD_version 800054 adds memory barriers to
1464         <machine/atomic.h>, new interfaces to ifnet to facilitate
1465         multiple hardware transmit queues for cards that support
1466         them, and a lock-less ring-buffer implementation to
1467         enable drivers to more efficiently manage queueing of
1468         packets.
1469
1470 20081117:
1471         A new version of ZFS (version 13) has been merged to -HEAD.
1472         This version has zpool attribute "listsnapshots" off by
1473         default, which means "zfs list" does not show snapshots,
1474         and is the same as Solaris behavior.
1475
1476 20081028:
1477         dummynet(4) ABI has changed. ipfw(8) needs to be recompiled.
1478
1479 20081009:
1480         The uhci, ohci, ehci and slhci USB Host controller drivers have
1481         been put into separate modules. If you load the usb module
1482         separately through loader.conf you will need to load the
1483         appropriate *hci module as well. E.g. for a UHCI-based USB 2.0
1484         controller add the following to loader.conf:
1485
1486                 uhci_load="YES"
1487                 ehci_load="YES"
1488
1489 20081009:
1490         The ABI used by the PMC toolset has changed.  Please keep
1491         userland (libpmc(3)) and the kernel module (hwpmc(4)) in
1492         sync.
1493
1494 20081009:
1495         atapci kernel module now includes only generic PCI ATA
1496         driver. AHCI driver moved to ataahci kernel module.
1497         All vendor-specific code moved into separate kernel modules:
1498         ataacard, ataacerlabs, ataadaptec, ataamd, ataati, atacenatek,
1499         atacypress, atacyrix, atahighpoint, ataintel, ataite, atajmicron,
1500         atamarvell, atamicron, atanational, atanetcell, atanvidia,
1501         atapromise, ataserverworks, atasiliconimage, atasis, atavia
1502
1503 20080820:
1504         The TTY subsystem of the kernel has been replaced by a new
1505         implementation, which provides better scalability and an
1506         improved driver model. Most common drivers have been migrated to
1507         the new TTY subsystem, while others have not. The following
1508         drivers have not yet been ported to the new TTY layer:
1509
1510         PCI/ISA:
1511                 cy, digi, rc, rp, sio
1512
1513         USB:
1514                 ubser, ucycom
1515
1516         Line disciplines:
1517                 ng_h4, ng_tty, ppp, sl, snp
1518
1519         Adding these drivers to your kernel configuration file shall
1520         cause compilation to fail.
1521
1522 20080818:
1523         ntpd has been upgraded to 4.2.4p5.
1524
1525 20080801:
1526         OpenSSH has been upgraded to 5.1p1.
1527
1528         For many years, FreeBSD's version of OpenSSH preferred DSA
1529         over RSA for host and user authentication keys.  With this
1530         upgrade, we've switched to the vendor's default of RSA over
1531         DSA.  This may cause upgraded clients to warn about unknown
1532         host keys even for previously known hosts.  Users should
1533         follow the usual procedure for verifying host keys before
1534         accepting the RSA key.
1535
1536         This can be circumvented by setting the "HostKeyAlgorithms"
1537         option to "ssh-dss,ssh-rsa" in ~/.ssh/config or on the ssh
1538         command line.
1539
1540         Please note that the sequence of keys offered for
1541         authentication has been changed as well.  You may want to
1542         specify IdentityFile in a different order to revert this
1543         behavior.
1544
1545 20080713:
1546         The sio(4) driver has been removed from the i386 and amd64
1547         kernel configuration files. This means uart(4) is now the
1548         default serial port driver on those platforms as well.
1549
1550         To prevent collisions with the sio(4) driver, the uart(4) driver
1551         uses different names for its device nodes. This means the
1552         onboard serial port will now most likely be called "ttyu0"
1553         instead of "ttyd0". You may need to reconfigure applications to
1554         use the new device names.
1555
1556         When using the serial port as a boot console, be sure to update
1557         /boot/device.hints and /etc/ttys before booting the new kernel.
1558         If you forget to do so, you can still manually specify the hints
1559         at the loader prompt:
1560
1561                 set hint.uart.0.at="isa"
1562                 set hint.uart.0.port="0x3F8"
1563                 set hint.uart.0.flags="0x10"
1564                 set hint.uart.0.irq="4"
1565                 boot -s
1566
1567 20080609:
1568         The gpt(8) utility has been removed. Use gpart(8) to partition
1569         disks instead.
1570
1571 20080603:
1572         The version that Linuxulator emulates was changed from 2.4.2
1573         to 2.6.16. If you experience any problems with Linux binaries
1574         please try to set sysctl compat.linux.osrelease to 2.4.2 and
1575         if it fixes the problem contact emulation mailing list.
1576
1577 20080525:
1578         ISDN4BSD (I4B) was removed from the src tree. You may need to
1579         update a your kernel configuration and remove relevant entries.
1580
1581 20080509:
1582         I have checked in code to support multiple routing tables.
1583         See the man pages setfib(1) and setfib(2).
1584         This is a hopefully backwards compatible version,
1585         but to make use of it you need to compile your kernel
1586         with options ROUTETABLES=2 (or more up to 16).
1587
1588 20080420:
1589         The 802.11 wireless support was redone to enable multi-bss
1590         operation on devices that are capable.  The underlying device
1591         is no longer used directly but instead wlanX devices are
1592         cloned with ifconfig.  This requires changes to rc.conf files.
1593         For example, change:
1594                 ifconfig_ath0="WPA DHCP"
1595         to
1596                 wlans_ath0=wlan0
1597                 ifconfig_wlan0="WPA DHCP"
1598         see rc.conf(5) for more details.  In addition, mergemaster of
1599         /etc/rc.d is highly recommended.  Simultaneous update of userland
1600         and kernel wouldn't hurt either.
1601
1602         As part of the multi-bss changes the wlan_scan_ap and wlan_scan_sta
1603         modules were merged into the base wlan module.  All references
1604         to these modules (e.g. in kernel config files) must be removed.
1605
1606 20080408:
1607         psm(4) has gained write(2) support in native operation level.
1608         Arbitrary commands can be written to /dev/psm%d and status can
1609         be read back from it.  Therefore, an application is responsible
1610         for status validation and error recovery.  It is a no-op in
1611         other operation levels.
1612
1613 20080312:
1614         Support for KSE threading has been removed from the kernel.  To
1615         run legacy applications linked against KSE libmap.conf may
1616         be used.  The following libmap.conf may be used to ensure
1617         compatibility with any prior release:
1618
1619         libpthread.so.1 libthr.so.1
1620         libpthread.so.2 libthr.so.2
1621         libkse.so.3 libthr.so.3
1622
1623 20080301:
1624         The layout of struct vmspace has changed. This affects libkvm
1625         and any executables that link against libkvm and use the
1626         kvm_getprocs() function. In particular, but not exclusively,
1627         it affects ps(1), fstat(1), pkill(1), systat(1), top(1) and w(1).
1628         The effects are minimal, but it's advisable to upgrade world
1629         nonetheless.
1630
1631 20080229:
1632         The latest em driver no longer has support in it for the
1633         82575 adapter, this is now moved to the igb driver. The
1634         split was done to make new features that are incompatible
1635         with older hardware easier to do.
1636
1637 20080220:
1638         The new geom_lvm(4) geom class has been renamed to geom_linux_lvm(4),
1639         likewise the kernel option is now GEOM_LINUX_LVM.
1640
1641 20080211:
1642         The default NFS mount mode has changed from UDP to TCP for
1643         increased reliability.  If you rely on (insecurely) NFS
1644         mounting across a firewall you may need to update your
1645         firewall rules.
1646
1647 20080208:
1648         Belatedly note the addition of m_collapse for compacting
1649         mbuf chains.
1650
1651 20080126:
1652         The fts(3) structures have been changed to use adequate
1653         integer types for their members and so to be able to cope
1654         with huge file trees.  The old fts(3) ABI is preserved
1655         through symbol versioning in libc, so third-party binaries
1656         using fts(3) should still work, although they will not take
1657         advantage of the extended types.  At the same time, some
1658         third-party software might fail to build after this change
1659         due to unportable assumptions made in its source code about
1660         fts(3) structure members.  Such software should be fixed
1661         by its vendor or, in the worst case, in the ports tree.
1662         FreeBSD_version 800015 marks this change for the unlikely
1663         case that a portable fix is impossible.
1664
1665 20080123:
1666         To upgrade to -current after this date, you must be running
1667         FreeBSD not older than 6.0-RELEASE.  Upgrading to -current
1668         from 5.x now requires a stop over at RELENG_6 or RELENG_7 systems.
1669
1670 20071128:
1671         The ADAPTIVE_GIANT kernel option has been retired because its
1672         functionality is the default now.
1673
1674 20071118:
1675         The AT keyboard emulation of sunkbd(4) has been turned on
1676         by default. In order to make the special symbols of the Sun
1677         keyboards driven by sunkbd(4) work under X these now have
1678         to be configured the same way as Sun USB keyboards driven
1679         by ukbd(4) (which also does AT keyboard emulation), f.e.:
1680
1681         Option  "XkbLayout" "us"
1682         Option  "XkbRules" "xorg"
1683         Option  "XkbSymbols" "pc(pc105)+sun_vndr/usb(sun_usb)+us"
1684
1685 20071024:
1686         It has been decided that it is desirable to provide ABI
1687         backwards compatibility to the FreeBSD 4/5/6 versions of the
1688         PCIOCGETCONF, PCIOCREAD and PCIOCWRITE IOCTLs, which was
1689         broken with the introduction of PCI domain support (see the
1690         20070930 entry). Unfortunately, this required the ABI of
1691         PCIOCGETCONF to be broken again in order to be able to
1692         provide backwards compatibility to the old version of that
1693         IOCTL. Thus consumers of PCIOCGETCONF have to be recompiled
1694         again. As for prominent ports this affects neither pciutils
1695         nor xorg-server this time, the hal port needs to be rebuilt
1696         however.
1697
1698 20071020:
1699         The misnamed kthread_create() and friends have been renamed
1700         to kproc_create() etc. Many of the callers already
1701         used kproc_start()..
1702         I will return kthread_create() and friends in a while
1703         with implementations that actually create threads, not procs.
1704         Renaming corresponds with version 800002.
1705
1706 20071010:
1707         RELENG_7 branched.
1708
1709 COMMON ITEMS:
1710
1711         General Notes
1712         -------------
1713         Avoid using make -j when upgrading.  While generally safe, there are
1714         sometimes problems using -j to upgrade.  If your upgrade fails with
1715         -j, please try again without -j.  From time to time in the past there
1716         have been problems using -j with buildworld and/or installworld.  This
1717         is especially true when upgrading between "distant" versions (eg one
1718         that cross a major release boundary or several minor releases, or when
1719         several months have passed on the -current branch).
1720
1721         Sometimes, obscure build problems are the result of environment
1722         poisoning.  This can happen because the make utility reads its
1723         environment when searching for values for global variables.  To run
1724         your build attempts in an "environmental clean room", prefix all make
1725         commands with 'env -i '.  See the env(1) manual page for more details.
1726
1727         When upgrading from one major version to another it is generally best
1728         to upgrade to the latest code in the currently installed branch first,
1729         then do an upgrade to the new branch. This is the best-tested upgrade
1730         path, and has the highest probability of being successful.  Please try
1731         this approach before reporting problems with a major version upgrade.
1732
1733         When upgrading a live system, having a root shell around before
1734         installing anything can help undo problems. Not having a root shell
1735         around can lead to problems if pam has changed too much from your
1736         starting point to allow continued authentication after the upgrade.
1737
1738         ZFS notes
1739         ---------
1740         When upgrading the boot ZFS pool to a new version, always follow
1741         these two steps:
1742
1743         1.) recompile and reinstall the ZFS boot loader and boot block
1744         (this is part of "make buildworld" and "make installworld")
1745
1746         2.) update the ZFS boot block on your boot drive
1747
1748         The following example updates the ZFS boot block on the first
1749         partition (freebsd-boot) of a GPT partitioned drive ad0:
1750         "gpart bootcode -p /boot/gptzfsboot -i 1 ad0"
1751
1752         Non-boot pools do not need these updates.
1753
1754         To build a kernel
1755         -----------------
1756         If you are updating from a prior version of FreeBSD (even one just
1757         a few days old), you should follow this procedure.  It is the most
1758         failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1759
1760         make kernel-toolchain
1761         make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1762         make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1763
1764         To test a kernel once
1765         ---------------------
1766         If you just want to boot a kernel once (because you are not sure
1767         if it works, or if you want to boot a known bad kernel to provide
1768         debugging information) run
1769         make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1770         nextboot -k testkernel
1771
1772         To just build a kernel when you know that it won't mess you up
1773         --------------------------------------------------------------
1774         This assumes you are already running a CURRENT system.  Replace
1775         ${arch} with the architecture of your machine (e.g. "i386",
1776         "arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
1777
1778         cd src/sys/${arch}/conf
1779         config KERNEL_NAME_HERE
1780         cd ../compile/KERNEL_NAME_HERE
1781         make depend
1782         make
1783         make install
1784
1785         If this fails, go to the "To build a kernel" section.
1786
1787         To rebuild everything and install it on the current system.
1788         -----------------------------------------------------------
1789         # Note: sometimes if you are running current you gotta do more than
1790         # is listed here if you are upgrading from a really old current.
1791
1792         <make sure you have good level 0 dumps>
1793         make buildworld
1794         make kernel KERNCONF=YOUR_KERNEL_HERE
1795                                                         [1]
1796         <reboot in single user>                         [3]
1797         mergemaster -p                                  [5]
1798         make installworld
1799         mergemaster -i                                  [4]
1800         make delete-old                                 [6]
1801         <reboot>
1802
1803         To cross-install current onto a separate partition
1804         --------------------------------------------------
1805         # In this approach we use a separate partition to hold
1806         # current's root, 'usr', and 'var' directories.   A partition
1807         # holding "/", "/usr" and "/var" should be about 2GB in
1808         # size.
1809
1810         <make sure you have good level 0 dumps>
1811         <boot into -stable>
1812         make buildworld
1813         make buildkernel KERNCONF=YOUR_KERNEL_HERE
1814         <maybe newfs current's root partition>
1815         <mount current's root partition on directory ${CURRENT_ROOT}>
1816         make installworld DESTDIR=${CURRENT_ROOT}
1817         make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1818         make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1819         cp /etc/fstab ${CURRENT_ROOT}/etc/fstab                    # if newfs'd
1820         <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1821         <reboot into current>
1822         <do a "native" rebuild/install as described in the previous section>
1823         <maybe install compatibility libraries from ports/misc/compat*>
1824         <reboot>
1825
1826
1827         To upgrade in-place from stable to current
1828         ----------------------------------------------
1829         <make sure you have good level 0 dumps>
1830         make buildworld                                 [9]
1831         make kernel KERNCONF=YOUR_KERNEL_HERE           [8]
1832                                                         [1]
1833         <reboot in single user>                         [3]
1834         mergemaster -p                                  [5]
1835         make installworld
1836         mergemaster -i                                  [4]
1837         make delete-old                                 [6]
1838         <reboot>
1839
1840         Make sure that you've read the UPDATING file to understand the
1841         tweaks to various things you need.  At this point in the life
1842         cycle of current, things change often and you are on your own
1843         to cope.  The defaults can also change, so please read ALL of
1844         the UPDATING entries.
1845
1846         Also, if you are tracking -current, you must be subscribed to
1847         freebsd-current@freebsd.org.  Make sure that before you update
1848         your sources that you have read and understood all the recent
1849         messages there.  If in doubt, please track -stable which has
1850         much fewer pitfalls.
1851
1852         [1] If you have third party modules, such as vmware, you
1853         should disable them at this point so they don't crash your
1854         system on reboot.
1855
1856         [3] From the bootblocks, boot -s, and then do
1857                 fsck -p
1858                 mount -u /
1859                 mount -a
1860                 cd src
1861                 adjkerntz -i            # if CMOS is wall time
1862         Also, when doing a major release upgrade, it is required that
1863         you boot into single user mode to do the installworld.
1864
1865         [4] Note: This step is non-optional.  Failure to do this step
1866         can result in a significant reduction in the functionality of the
1867         system.  Attempting to do it by hand is not recommended and those
1868         that pursue this avenue should read this file carefully, as well
1869         as the archives of freebsd-current and freebsd-hackers mailing lists
1870         for potential gotchas.  The -U option is also useful to consider.
1871         See mergemaster(8) for more information.
1872
1873         [5] Usually this step is a noop.  However, from time to time
1874         you may need to do this if you get unknown user in the following
1875         step.  It never hurts to do it all the time.  You may need to
1876         install a new mergemaster (cd src/usr.sbin/mergemaster && make
1877         install) after the buildworld before this step if you last updated
1878         from current before 20130425 or from -stable before 20130430.
1879
1880         [6] This only deletes old files and directories. Old libraries
1881         can be deleted by "make delete-old-libs", but you have to make
1882         sure that no program is using those libraries anymore.
1883
1884         [8] In order to have a kernel that can run the 4.x binaries needed to
1885         do an installworld, you must include the COMPAT_FREEBSD4 option in
1886         your kernel.  Failure to do so may leave you with a system that is
1887         hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1888         required to run the 5.x binaries on more recent kernels.  And so on
1889         for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1890
1891         Make sure that you merge any new devices from GENERIC since the
1892         last time you updated your kernel config file.
1893
1894         [9] When checking out sources, you must include the -P flag to have
1895         cvs prune empty directories.
1896
1897         If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1898         "?=" instead of the "=" assignment operator, so that buildworld can
1899         override the CPUTYPE if it needs to.
1900
1901         MAKEOBJDIRPREFIX must be defined in an environment variable, and
1902         not on the command line, or in /etc/make.conf.  buildworld will
1903         warn if it is improperly defined.
1904 FORMAT:
1905
1906 This file contains a list, in reverse chronological order, of major
1907 breakages in tracking -current.  It is not guaranteed to be a complete
1908 list of such breakages, and only contains entries since October 10, 2007.
1909 If you need to see UPDATING entries from before that date, you will need
1910 to fetch an UPDATING file from an older FreeBSD release.
1911
1912 Copyright information:
1913
1914 Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1915
1916 Redistribution, publication, translation and use, with or without
1917 modification, in full or in part, in any form or format of this
1918 document are permitted without further permission from the author.
1919
1920 THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1921 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1922 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1923 DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1924 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1925 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1926 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1927 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1928 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1929 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1930 POSSIBILITY OF SUCH DAMAGE.
1931
1932 Contact Warner Losh if you have any questions about your use of
1933 this document.
1934
1935 $FreeBSD$