]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - UPDATING
Switch the GENERIC kernels for all architectures to the new CAM-based ATA
[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 Items affecting the ports and packages system can be found in
10 /usr/ports/UPDATING.  Please read that file before running portupgrade.
11
12 NOTE TO PEOPLE WHO THINK THAT FreeBSD 9.x IS SLOW:
13         FreeBSD 9.x has many debugging features turned on, in both the kernel
14         and userland.  These features attempt to detect incorrect use of
15         system primitives, and encourage loud failure through extra sanity
16         checking and fail stop semantics.  They also substantially impact
17         system performance.  If you want to do performance measurement,
18         benchmarking, and optimization, you'll want to turn them off.  This
19         includes various WITNESS- related kernel options, INVARIANTS, malloc
20         debugging flags in userland, and various verbose features in the
21         kernel.  Many developers choose to disable these features on build
22         machines to maximize performance.  (To disable malloc debugging, run
23         ln -s aj /etc/malloc.conf.)
24
25 20110424:
26         The GENERIC kernels for all architectures now default to the new
27         CAM-based ATA stack. It means that all legacy ATA drivers were
28         removed and replaced by respective CAM drivers. If you are using
29         ATA device names in /etc/fstab or other places, make sure to update
30         them respectively (adX -> adaY, acdX -> cdY, afdX -> daY, astX -> saY,
31         where 'Y's are the sequential numbers for each type in order of
32         detection, unless configured otherwise with tunables, see cam(4)).
33
34         ataraid(4) functionality is now supported by the RAID GEOM class.
35         To use it you can load geom_raid kernel module and use graid(8) tool
36         for management. Instead of /dev/arX device names, use /dev/raid/rX.
37
38         No kernel config options or code have been removed, so if a problem
39         arises, please report it and optionally revert to the old ATA stack.
40         In order to do it you can remove from the kernel config:
41             options        ATA_CAM
42             device         ahci
43             device         mvs
44             device         siis
45         , and instead add back:
46             device         atadisk         # ATA disk drives
47             device         ataraid         # ATA RAID drives
48             device         atapicd         # ATAPI CDROM drives
49             device         atapifd         # ATAPI floppy drives
50             device         atapist         # ATAPI tape drives
51             options        ATA_STATIC_ID   # Static device numbering
52
53 20110423:
54         The default NFS server has been changed to the new server, which
55         was referred to as the experimental server. If you need to switch
56         back to the old NFS server, you must now put the "-o" option on
57         both the mountd and nfsd commands. This can be done using the
58         mountd_flags and nfs_server_flags rc.conf variables until an
59         update to the rc scripts is committed, which is coming soon.
60
61 20110418:
62         The GNU Objective-C runtime library (libobjc), and other Objective-C
63         related components have been removed from the base system.  If you
64         require an Objective-C library, please use one of the available ports.
65
66 20110331:
67         ath(4) has been split into bus- and device- modules. if_ath contains
68         the HAL, the TX rate control and the network device code. if_ath_pci
69         contains the PCI bus glue. For Atheros MIPS embedded systems, if_ath_ahb
70         contains the AHB glue. Users need to load both if_ath_pci and if_ath
71         in order to use ath on everything else.
72
73         TO REPEAT: if_ath_ahb is not needed for normal users. Normal users only
74         need to load if_ath and if_ath_pci for ath(4) operation.
75
76 20110314:
77         As part of the replacement of sysinstall, the process of building
78         release media has changed significantly. For details, please re-read
79         release(7), which has been updated to reflect the new build process.
80
81 20110218:
82         GNU binutils 2.17.50 (as of 2007-07-03) has been merged to -HEAD.  This
83         is the last available version under GPLv2.  It brings a number of new
84         features, such as support for newer x86 CPU's (with SSE-3, SSSE-3, SSE
85         4.1 and SSE 4.2), better support for powerpc64, a number of new
86         directives, and lots of other small improvements.  See the ChangeLog
87         file in contrib/binutils for the full details.
88
89 20110218:
90         IPsec's HMAC_SHA256-512 support has been fixed to be RFC4868
91         compliant, and will now use half of hash for authentication.
92         This will break interoperability with all stacks (including all
93         actual FreeBSD versions) who implement
94         draft-ietf-ipsec-ciph-sha-256-00 (they use 96 bits of hash for
95         authentication).
96         The only workaround with such peers is to use another HMAC
97         algorithm for IPsec ("phase 2") authentication.
98
99 20110207:
100         Remove the uio_yield prototype and symbol.  This function has
101         been misnamed since it was introduced and should not be
102         globally exposed with this name.  The equivalent functionality
103         is now available using kern_yield(curthread->td_user_pri).
104         The function remains undocumented.
105
106 20110112:
107         A SYSCTL_[ADD_]UQUAD was added for unsigned uint64_t pointers,
108         symmetric with the existing SYSCTL_[ADD_]QUAD.  Type checking
109         for scalar sysctls is defined but disabled.  Code that needs
110         UQUAD to pass the type checking that must compile on older
111         systems where the define is not present can check against
112         __FreeBSD_version >= 900030.
113
114         The system dialog(1) has been replaced with a new version previously
115         in ports as devel/cdialog. dialog(1) is mostly command-line compatible
116         with the previous version, but the libdialog associated with it has
117         a largely incompatible API. As such, the original version of libdialog
118         will be kept temporarily as libodialog, until its base system consumers
119         are replaced or updated. Bump __FreeBSD_version to 900030.
120
121 20110103:
122         If you are trying to run make universe on a -stable system, and you get
123         the following warning:
124         "Makefile", line 356: "Target architecture for i386/conf/GENERIC 
125         unknown.  config(8) likely too old."
126         or something similar to it, then you must upgrade your -stable system
127         to 8.2-Release or newer (really, any time after r210146 7/15/2010 in
128         stable/8) or build the config from the latest stable/8 branch and
129         install it on your system.
130
131         Prior to this date, building a current universe on 8-stable system from
132         between 7/15/2010 and 1/2/2011 would result in a weird shell parsing
133         error in the first kernel build phase.  A new config on those old 
134         systems will fix that problem for older versions of -current.
135
136 20101228:
137         The TCP stack has been modified to allow Khelp modules to interact with
138         it via helper hook points and store per-connection data in the TCP
139         control block. Bump __FreeBSD_version to 900029. User space tools that
140         rely on the size of struct tcpcb in tcp_var.h (e.g. sockstat) need to
141         be recompiled.
142
143 20101114:
144         Generic IEEE 802.3 annex 31B full duplex flow control support has been
145         added to mii(4) and bge(4), bce(4), msk(4), nfe(4) and stge(4) along
146         with brgphy(4), e1000phy(4) as well as ip1000phy() have been converted
147         to take advantage of it instead of using custom implementations.  This
148         means that these drivers now no longer unconditionally advertise
149         support for flow control but only do so if flow control is a selected
150         media option.  This was implemented in the generic support that way in
151         order to allow flow control to be switched on and off via ifconfig(8)
152         with the PHY specific default to typically off in order to protect
153         from unwanted effects.  Consequently, if you used flow control with
154         one of the above mentioned drivers you now need to explicitly enable
155         it, for example via:
156                 ifconfig bge0 media auto mediaopt flowcontrol
157
158         Along with the above mentioned changes generic support for setting
159         1000baseT master mode also has been added and brgphy(4), ciphy(4),
160         e1000phy(4) as well as ip1000phy(4) have been converted to take
161         advantage of it.  This means that these drivers now no longer take the
162         link0 parameter for selecting master mode but the master media option
163         has to be used instead, for example like in the following:
164                 ifconfig bge0 media 1000baseT mediaopt full-duplex,master
165
166         Selection of master mode now is also available with all other PHY
167         drivers supporting 1000baseT.
168
169 20101111:
170         The TCP stack has received a significant update to add support for
171         modularised congestion control and generally improve the clarity of
172         congestion control decisions. Bump __FreeBSD_version to 900025. User
173         space tools that rely on the size of struct tcpcb in tcp_var.h (e.g.
174         sockstat) need to be recompiled.
175
176 20101002:
177         The man(1) utility has been replaced by a new version that no longer
178         uses /etc/manpath.config. Please consult man.conf(5) for how to
179         migrate local entries to the new format.
180
181 20100928:
182         The copyright strings printed by login(1) and sshd(8) at the time of a
183         new connection have been removed to follow other operating systems and
184         upstream sshd.
185
186 20100915:
187         A workaround for a fixed ld bug has been removed in kernel code,
188         so make sure that your system ld is built from sources after
189         revision 210245 from 2010-07-19 (r211583 if building head kernel
190         on stable/8, r211584 for stable/7; both from 2010-08-21).
191         A symptom of incorrect ld version is different addresses for
192         set_pcpu section and __start_set_pcpu symbol in kernel and/or modules.
193
194 20100913:
195         The $ipv6_prefer variable in rc.conf(5) has been split into
196         $ip6addrctl_policy and $ipv6_activate_all_interfaces.
197
198         The $ip6addrctl_policy is a variable to choose a pre-defined
199         address selection policy set by ip6addrctl(8).  A value
200         "ipv4_prefer", "ipv6_prefer" or "AUTO" can be specified.  The
201         default is "AUTO".
202
203         The $ipv6_activate_all_interfaces specifies whether IFDISABLED
204         flag (see an entry of 20090926) is set on an interface with no
205         corresponding $ifconfig_IF_ipv6 line.  The default is "NO" for
206         security reason.  If you want IPv6 link-local address on all
207         interfaces by default, set this to "YES".
208
209         The old ipv6_prefer="YES" is equivalent to
210         ipv6_activate_all_interfaces="YES" and
211         ip6addrctl_policy="ipv6_prefer".
212
213 20100913:
214         DTrace has grown support for userland tracing. Due to this, DTrace is
215         now i386 and amd64 only.
216         dtruss(1) is now installed by default on those systems and a new
217         kernel module is needed for userland tracing: fasttrap.
218         No changes to your kernel config file are necessary to enable
219         userland tracing, but you might consider adding 'STRIP=' and
220         'CFLAGS+=-fno-omit-frame-pointer' to your make.conf if you want
221         to have informative userland stack traces in DTrace (ustack).
222
223 20100725:
224         The acpi_aiboost(4) driver has been removed in favor of the new
225         aibs(4) driver. You should update your kernel configuration file.
226
227 20100722:
228         BSD grep has been imported to the base system and it is built by
229         default.  It is completely BSD licensed, highly GNU-compatible, uses
230         less memory than its GNU counterpart and has a small codebase.
231         However, it is slower than its GNU counterpart, which is mostly
232         noticeable for larger searches, for smaller ones it is measurable
233         but not significant.  The reason is complex, the most important factor
234         is that we lack a modern and efficient regex library and GNU
235         overcomes this by optimizing the searches internally.  Future work
236         on improving the regex performance is planned, for the meantime,
237         users that need better performance, can build GNU grep instead by
238         setting the WITH_GNU_GREP knob.
239
240 20100713:
241         Due to the import of powerpc64 support, all existing powerpc kernel
242         configuration files must be updated with a machine directive like this:
243             machine powerpc powerpc
244
245         In addition, an updated config(8) is required to build powerpc kernels
246         after this change.
247
248 20100713:
249         A new version of ZFS (version 15) has been merged to -HEAD.
250         This version uses a python library for the following subcommands:
251         zfs allow, zfs unallow, zfs groupspace, zfs userspace.
252         For full functionality of these commands the following port must
253         be installed: sysutils/py-zfs
254
255 20100429:
256         'vm_page's are now hashed by physical address to an array of mutexes.
257         Currently this is only used to serialize access to hold_count. Over 
258         time the page queue mutex will be peeled away. This changes the size
259         of pmap on every architecture. And requires all callers of vm_page_hold
260         and vm_page_unhold to be updated. 
261  
262 20100402:
263         WITH_CTF can now be specified in src.conf (not recommended, there
264         are some problems with static executables), make.conf (would also
265         affect ports which do not use GNU make and do not override the
266         compile targets) or in the kernel config (via "makeoptions
267         WITH_CTF=yes").
268         When WITH_CTF was specified there before this was silently ignored,
269         so make sure that WITH_CTF is not used in places which could lead
270         to unwanted behavior.
271
272 20100311:
273         The kernel option COMPAT_IA32 has been replaced with COMPAT_FREEBSD32
274         to allow 32-bit compatibility on non-x86 platforms. All kernel
275         configurations on amd64 and ia64 platforms using these options must
276         be modified accordingly.
277
278 20100113:
279         The utmp user accounting database has been replaced with utmpx,
280         the user accounting interface standardized by POSIX.
281         Unfortunately the semantics of utmp and utmpx don't match,
282         making it practically impossible to support both interfaces.
283         The user accounting database is used by tools like finger(1),
284         last(1), talk(1), w(1) and ac(8).
285
286         All applications in the base system use utmpx.  This means only
287         local binaries (e.g. from the ports tree) may still use these
288         utmp database files.  These applications must be rebuilt to make
289         use of utmpx.
290
291         After the system has been upgraded, it is safe to remove the old
292         log files (/var/run/utmp, /var/log/lastlog and /var/log/wtmp*),
293         assuming their contents is of no importance anymore.  Old wtmp
294         databases can only be used by last(1) and ac(8) after they have
295         been converted to the new format using wtmpcvt(1).
296
297 20100108:
298         Introduce the kernel thread "deadlock resolver" (which can be enabled
299         via the DEADLKRES option, see NOTES for more details) and the
300         sleepq_type() function for sleepqueues.
301
302 20091202:
303         The rc.firewall and rc.firewall6 were unified, and
304         rc.firewall6 and rc.d/ip6fw were removed.
305         According to the removal of rc.d/ip6fw, ipv6_firewall_* rc
306         variables are obsoleted.  Instead, the following new rc
307         variables are added to rc.d/ipfw:
308
309                 firewall_client_net_ipv6, firewall_simple_iif_ipv6,
310                 firewall_simple_inet_ipv6, firewall_simple_oif_ipv6,
311                 firewall_simple_onet_ipv6, firewall_trusted_ipv6
312
313         The meanings correspond to the relevant IPv4 variables.
314
315 20091125:
316         8.0-RELEASE.
317
318 20091113:
319         The default terminal emulation for syscons(4) has been changed
320         from cons25 to xterm on all platforms except pc98.  This means
321         that the /etc/ttys file needs to be updated to ensure correct
322         operation of applications on the console.
323
324         The terminal emulation style can be toggled per window by using
325         vidcontrol(1)'s -T flag.  The TEKEN_CONS25 kernel configuration
326         options can be used to change the compile-time default back to
327         cons25.
328
329         To prevent graphical artifacts, make sure the TERM environment
330         variable is set to match the terminal emulation that is being
331         performed by syscons(4).
332
333 20091109:
334         The layout of the structure ieee80211req_scan_result has changed.
335         Applications that require wireless scan results (e.g. ifconfig(8))
336         from net80211 need to be recompiled.
337
338         Applications such as wpa_supplicant(8) may require a full world
339         build without using NO_CLEAN in order to get synchronized with the
340         new structure.
341
342 20091025:
343         The iwn(4) driver has been updated to support the 5000 and 5150 series.
344         There's one kernel module for each firmware. Adding "device iwnfw"
345         to the kernel configuration file means including all three firmware
346         images inside the kernel. If you want to include just the one for
347         your wireless card, use the the devices iwn4965fw, iwn5000fw or
348         iwn5150fw.
349
350 20090926:
351         The rc.d/network_ipv6, IPv6 configuration script has been integrated
352         into rc.d/netif.  The changes are the following:
353
354         1. To use IPv6, simply define $ifconfig_IF_ipv6 like $ifconfig_IF
355            for IPv4.  For aliases, $ifconfig_IF_aliasN should be used.
356            Note that both variables need the "inet6" keyword at the head.
357
358            Do not set $ipv6_network_interfaces manually if you do not
359            understand what you are doing.  It is not needed in most cases. 
360
361            $ipv6_ifconfig_IF and $ipv6_ifconfig_IF_aliasN still work, but
362            they are obsolete.
363
364         2. $ipv6_enable is obsolete.  Use $ipv6_prefer and
365            "inet6 accept_rtadv" keyword in ifconfig(8) instead.
366
367            If you define $ipv6_enable=YES, it means $ipv6_prefer=YES and
368            all configured interfaces have "inet6 accept_rtadv" in the
369            $ifconfig_IF_ipv6.  These are for backward compatibility.
370
371         3. A new variable $ipv6_prefer has been added.  If NO, IPv6
372            functionality of interfaces with no corresponding
373            $ifconfig_IF_ipv6 is disabled by using "inet6 ifdisabled" flag,
374            and the default address selection policy of ip6addrctl(8) 
375            is the IPv4-preferred one (see rc.d/ip6addrctl for more details).
376            Note that if you want to configure IPv6 functionality on the
377            disabled interfaces after boot, first you need to clear the flag by
378            using ifconfig(8) like:
379
380                 ifconfig em0 inet6 -ifdisabled
381
382            If YES, the default address selection policy is set as
383            IPv6-preferred.
384
385            The default value of $ipv6_prefer is NO.
386
387         4. If your system need to receive Router Advertisement messages,
388            define "inet6 accept_rtadv" in $ifconfig_IF_ipv6.  The rc(8)
389            scripts automatically invoke rtsol(8) when the interface becomes
390            UP.  The Router Advertisement messages are used for SLAAC
391            (State-Less Address AutoConfiguration).
392
393 20090922:
394         802.11s D3.03 support was committed. This is incompatible with the
395         previous code, which was based on D3.0.
396
397 20090912:
398         A sysctl variable net.inet6.ip6.accept_rtadv now sets the default value
399         of a per-interface flag ND6_IFF_ACCEPT_RTADV, not a global knob to
400         control whether accepting Router Advertisement messages or not.
401         Also, a per-interface flag ND6_IFF_AUTO_LINKLOCAL has been added and
402         a sysctl variable net.inet6.ip6.auto_linklocal is its default value.
403         The ifconfig(8) utility now supports these flags.
404
405 20090910:
406         ZFS snapshots are now mounted with MNT_IGNORE flag. Use -v option for
407         mount(8) and -a option for df(1) to see them.
408
409 20090825:
410         The old tunable hw.bus.devctl_disable has been superseded by
411         hw.bus.devctl_queue.  hw.bus.devctl_disable=1 in loader.conf should be
412         replaced by hw.bus.devctl_queue=0.  The default for this new tunable
413         is 1000.
414
415 20090813:
416         Remove the option STOP_NMI.  The default action is now to use NMI only
417         for KDB via the newly introduced function stop_cpus_hard() and
418         maintain stop_cpus() to just use a normal IPI_STOP on ia32 and amd64.
419
420 20090803:
421         The stable/8 branch created in subversion.  This corresponds to the
422         RELENG_8 branch in CVS.
423
424 20090719:
425         Bump the shared library version numbers for all libraries that do not
426         use symbol versioning as part of the 8.0-RELEASE cycle.  Bump
427         __FreeBSD_version to 800105.
428
429 20090714:
430         Due to changes in the implementation of virtual network stack support,
431         all network-related kernel modules must be recompiled.  As this change
432         breaks the ABI, bump __FreeBSD_version to 800104.
433
434 20090713:
435         The TOE interface to the TCP syncache has been modified to remove
436         struct tcpopt (<netinet/tcp_var.h>) from the ABI of the network stack.
437         The cxgb driver is the only TOE consumer affected by this change, and
438         needs to be recompiled along with the kernel. As this change breaks
439         the ABI, bump __FreeBSD_version to 800103.
440
441 20090712: 
442         Padding has been added to struct tcpcb, sackhint and tcpstat in
443         <netinet/tcp_var.h> to facilitate future MFCs and bug fixes whilst
444         maintaining the ABI. However, this change breaks the ABI, so bump
445         __FreeBSD_version to 800102. User space tools that rely on the size of
446         any of these structs (e.g. sockstat) need to be recompiled.
447
448 20090630:
449         The NFS_LEGACYRPC option has been removed along with the old kernel
450         RPC implementation that this option selected. Kernel configurations
451         may need to be adjusted.
452
453 20090629:
454         The network interface device nodes at /dev/net/<interface> have been
455         removed.  All ioctl operations can be performed the normal way using
456         routing sockets.  The kqueue functionality can generally be replaced
457         with routing sockets.
458
459 20090628:
460         The documentation from the FreeBSD Documentation Project (Handbook,
461         FAQ, etc.) is now installed via packages by sysinstall(8) and under
462         the /usr/local/share/doc/freebsd directory instead of /usr/share/doc.
463
464 20090624:
465         The ABI of various structures related to the SYSV IPC API have been
466         changed.  As a result, the COMPAT_FREEBSD[456] and COMPAT_43 kernel
467         options now all require COMPAT_FREEBSD7.  Bump __FreeBSD_version to
468         800100.
469
470 20090622:
471         Layout of struct vnet has changed as routing related variables were
472         moved to their own Vimage module. Modules need to be recompiled.  Bump
473         __FreeBSD_version to 800099.
474
475 20090619:
476         NGROUPS_MAX and NGROUPS have been increased from 16 to 1023 and 1024
477         respectively.  As long as no more than 16 groups per process are used,
478         no changes should be visible.  When more than 16 groups are used, old
479         binaries may fail if they call getgroups() or getgrouplist() with
480         statically sized storage.  Recompiling will work around this, but
481         applications should be modified to use dynamically allocated storage
482         for group arrays as POSIX.1-2008 does not cap an implementation's
483         number of supported groups at NGROUPS_MAX+1 as previous versions did.
484
485         NFS and portalfs mounts may also be affected as the list of groups is
486         truncated to 16.  Users of NFS who use more than 16 groups, should
487         take care that negative group permissions are not used on the exported
488         file systems as they will not be reliable unless a GSSAPI based
489         authentication method is used.
490
491 20090616: 
492         The compiling option ADAPTIVE_LOCKMGRS has been introduced.  This
493         option compiles in the support for adaptive spinning for lockmgrs
494         which want to enable it.  The lockinit() function now accepts the flag
495         LK_ADAPTIVE in order to make the lock object subject to adaptive
496         spinning when both held in write and read mode.
497
498 20090613:
499         The layout of the structure returned by IEEE80211_IOC_STA_INFO has
500         changed.  User applications that use this ioctl need to be rebuilt.
501
502 20090611:
503         The layout of struct thread has changed.  Kernel and modules need to
504         be rebuilt.
505
506 20090608:
507         The layout of structs ifnet, domain, protosw and vnet_net has changed.
508         Kernel modules need to be rebuilt.  Bump __FreeBSD_version to 800097.
509
510 20090602:
511         window(1) has been removed from the base system. It can now be
512         installed from ports. The port is called misc/window.
513
514 20090601:
515         The way we are storing and accessing `routing table' entries has
516         changed. Programs reading the FIB, like netstat, need to be
517         re-compiled.
518
519 20090601:
520         A new netisr implementation has been added for FreeBSD 8.  Network
521         file system modules, such as igmp, ipdivert, and others, should be
522         rebuilt.
523         Bump __FreeBSD_version to 800096.
524
525 20090530:
526         Remove the tunable/sysctl debug.mpsafevfs as its initial purpose is no
527         more valid.
528
529 20090530:
530         Add VOP_ACCESSX(9).  File system modules need to be rebuilt.
531         Bump __FreeBSD_version to 800094.
532
533 20090529:
534         Add mnt_xflag field to 'struct mount'.  File system modules need to be
535         rebuilt.
536         Bump __FreeBSD_version to 800093.
537
538 20090528:
539         The compiling option ADAPTIVE_SX has been retired while it has been
540         introduced the option NO_ADAPTIVE_SX which handles the reversed logic.
541         The KPI for sx_init_flags() changes as accepting flags:
542         SX_ADAPTIVESPIN flag has been retired while the SX_NOADAPTIVE flag has
543         been introduced in order to handle the reversed logic.
544         Bump __FreeBSD_version to 800092.
545
546 20090527:
547         Add support for hierarchical jails.  Remove global securelevel.
548         Bump __FreeBSD_version to 800091.
549
550 20090523:
551         The layout of struct vnet_net has changed, therefore modules
552         need to be rebuilt.
553         Bump __FreeBSD_version to 800090.
554
555 20090523:
556         The newly imported zic(8) produces a new format in the output. Please
557         run tzsetup(8) to install the newly created data to /etc/localtime.
558
559 20090520:
560         The sysctl tree for the usb stack has renamed from hw.usb2.* to
561         hw.usb.* and is now consistent again with previous releases.
562
563 20090520:
564         802.11 monitor mode support was revised and driver api's were changed.
565         Drivers dependent on net80211 now support DLT_IEEE802_11_RADIO instead
566         of DLT_IEEE802_11.  No user-visible data structures were changed but
567         applications that use DLT_IEEE802_11 may require changes.
568         Bump __FreeBSD_version to 800088.
569
570 20090430:
571         The layout of the following structs has changed: sysctl_oid,
572         socket, ifnet, inpcbinfo, tcpcb, syncache_head, vnet_inet,
573         vnet_inet6 and vnet_ipfw.  Most modules need to be rebuild or
574         panics may be experienced.  World rebuild is required for
575         correctly checking networking state from userland.
576         Bump __FreeBSD_version to 800085.
577
578 20090429:
579         MLDv2 and Source-Specific Multicast (SSM) have been merged
580         to the IPv6 stack. VIMAGE hooks are in but not yet used.
581         The implementation of SSM within FreeBSD's IPv6 stack closely
582         follows the IPv4 implementation.
583
584         For kernel developers:
585
586         * The most important changes are that the ip6_output() and
587           ip6_input() paths no longer take the IN6_MULTI_LOCK,
588           and this lock has been downgraded to a non-recursive mutex.
589
590         * As with the changes to the IPv4 stack to support SSM, filtering
591           of inbound multicast traffic must now be performed by transport
592           protocols within the IPv6 stack. This does not apply to TCP and
593           SCTP, however, it does apply to UDP in IPv6 and raw IPv6.
594
595         * The KPIs used by IPv6 multicast are similar to those used by
596           the IPv4 stack, with the following differences:
597            * im6o_mc_filter() is analogous to imo_multicast_filter().
598            * The legacy KAME entry points in6_joingroup and in6_leavegroup()
599              are shimmed to in6_mc_join() and in6_mc_leave() respectively.
600            * IN6_LOOKUP_MULTI() has been deprecated and removed.
601            * IPv6 relies on MLD for the DAD mechanism. KAME's internal KPIs
602              for MLDv1 have an additional 'timer' argument which is used to
603              jitter the initial membership report for the solicited-node
604              multicast membership on-link.
605            * This is not strictly needed for MLDv2, which already jitters
606              its report transmissions.  However, the 'timer' argument is
607              preserved in case MLDv1 is active on the interface.
608
609         * The KAME linked-list based IPv6 membership implementation has
610           been refactored to use a vector similar to that used by the IPv4
611           stack.
612           Code which maintains a list of its own multicast memberships
613           internally, e.g. carp, has been updated to reflect the new
614           semantics.
615
616         * There is a known Lock Order Reversal (LOR) due to in6_setscope()
617           acquiring the IF_AFDATA_LOCK and being called within ip6_output().
618           Whilst MLDv2 tries to avoid this otherwise benign LOR, it is an
619           implementation constraint which needs to be addressed in HEAD.
620
621         For application developers:
622
623         * The changes are broadly similar to those made for the IPv4
624           stack.
625
626         * The use of IPv4 and IPv6 multicast socket options on the same
627           socket, using mapped addresses, HAS NOT been tested or supported.
628
629         * There are a number of issues with the implementation of various
630           IPv6 multicast APIs which need to be resolved in the API surface
631           before the implementation is fully compatible with KAME userland
632           use, and these are mostly to do with interface index treatment.
633
634         * The literature available discusses the use of either the delta / ASM
635           API with setsockopt(2)/getsockopt(2), or the full-state / ASM API
636           using setsourcefilter(3)/getsourcefilter(3). For more information
637           please refer to RFC 3768, 'Socket Interface Extensions for
638           Multicast Source Filters'.
639
640         * Applications which use the published RFC 3678 APIs should be fine.
641
642         For systems administrators:
643
644         * The mtest(8) utility has been refactored to support IPv6, in
645           addition to IPv4. Interface addresses are no longer accepted
646           as arguments, their names must be used instead. The utility
647           will map the interface name to its first IPv4 address as
648           returned by getifaddrs(3).
649
650         * The ifmcstat(8) utility has also been updated to print the MLDv2
651           endpoint state and source filter lists via sysctl(3).
652
653         * The net.inet6.ip6.mcast.loop sysctl may be tuned to 0 to disable
654           loopback of IPv6 multicast datagrams by default; it defaults to 1
655           to preserve the existing behaviour. Disabling multicast loopback is
656           recommended for optimal system performance.
657
658         * The IPv6 MROUTING code has been changed to examine this sysctl
659           instead of attempting to perform a group lookup before looping
660           back forwarded datagrams.
661
662         Bump __FreeBSD_version to 800084.
663
664 20090422:
665         Implement low-level Bluetooth HCI API.
666         Bump __FreeBSD_version to 800083.
667
668 20090419:
669         The layout of struct malloc_type, used by modules to register new
670         memory allocation types, has changed.  Most modules will need to
671         be rebuilt or panics may be experienced.
672         Bump __FreeBSD_version to 800081.
673
674 20090415:
675         Anticipate overflowing inp_flags - add inp_flags2.
676         This changes most offsets in inpcb, so checking v4 connection
677         state will require a world rebuild.
678         Bump __FreeBSD_version to 800080.
679
680 20090415:
681         Add an llentry to struct route and struct route_in6. Modules
682         embedding a struct route will need to be recompiled.
683         Bump __FreeBSD_version to 800079.
684
685 20090414:
686         The size of rt_metrics_lite and by extension rtentry has changed.
687         Networking administration apps will need to be recompiled.
688         The route command now supports show as an alias for get, weighting
689         of routes, sticky and nostick flags to alter the behavior of stateful
690         load balancing.
691         Bump __FreeBSD_version to 800078.
692
693 20090408:
694         Do not use Giant for kbdmux(4) locking. This is wrong and
695         apparently causing more problems than it solves. This will
696         re-open the issue where interrupt handlers may race with
697         kbdmux(4) in polling mode. Typical symptoms include (but
698         not limited to) duplicated and/or missing characters when
699         low level console functions (such as gets) are used while
700         interrupts are enabled (for example geli password prompt,
701         mountroot prompt etc.). Disabling kbdmux(4) may help.
702
703 20090407:
704         The size of structs vnet_net, vnet_inet and vnet_ipfw has changed;
705         kernel modules referencing any of the above need to be recompiled.
706         Bump __FreeBSD_version to 800075.
707
708 20090320:
709         GEOM_PART has become the default partition slicer for storage devices,
710         replacing GEOM_MBR, GEOM_BSD, GEOM_PC98 and GEOM_GPT slicers. It
711         introduces some changes:
712
713         MSDOS/EBR: the devices created from MSDOS extended partition entries
714         (EBR) can be named differently than with GEOM_MBR and are now symlinks
715         to devices with offset-based names. fstabs may need to be modified.
716
717         BSD: the "geometry does not match label" warning is harmless in most
718         cases but it points to problems in file system misalignment with
719         disk geometry. The "c" partition is now implicit, covers the whole
720         top-level drive and cannot be (mis)used by users.
721
722         General: Kernel dumps are now not allowed to be written to devices
723         whose partition types indicate they are meant to be used for file
724         systems (or, in case of MSDOS partitions, as something else than
725         the "386BSD" type).
726
727         Most of these changes date approximately from 200812.
728
729 20090319:
730         The uscanner(4) driver has been removed from the kernel. This follows
731         Linux removing theirs in 2.6 and making libusb the default interface
732         (supported by sane).
733
734 20090319:
735         The multicast forwarding code has been cleaned up. netstat(1)
736         only relies on KVM now for printing bandwidth upcall meters.
737         The IPv4 and IPv6 modules are split into ip_mroute_mod and
738         ip6_mroute_mod respectively. The config(5) options for statically
739         compiling this code remain the same, i.e. 'options MROUTING'.
740
741 20090315:
742         Support for the IFF_NEEDSGIANT network interface flag has been
743         removed, which means that non-MPSAFE network device drivers are no
744         longer supported.  In particular, if_ar, if_sr, and network device
745         drivers from the old (legacy) USB stack can no longer be built or
746         used.
747
748 20090313:
749         POSIX.1 Native Language Support (NLS) has been enabled in libc and
750         a bunch of new language catalog files have also been added.
751         This means that some common libc messages are now localized and
752         they depend on the LC_MESSAGES environmental variable.
753
754 20090313:
755         The k8temp(4) driver has been renamed to amdtemp(4) since
756         support for Family 10 and Family 11 CPU families was added.
757
758 20090309:
759         IGMPv3 and Source-Specific Multicast (SSM) have been merged
760         to the IPv4 stack. VIMAGE hooks are in but not yet used.
761
762         For kernel developers, the most important changes are that the
763         ip_output() and ip_input() paths no longer take the IN_MULTI_LOCK(),
764         and this lock has been downgraded to a non-recursive mutex.
765
766         Transport protocols (UDP, Raw IP) are now responsible for filtering
767         inbound multicast traffic according to group membership and source
768         filters. The imo_multicast_filter() KPI exists for this purpose.
769         Transports which do not use multicast (SCTP, TCP) already reject
770         multicast by default. Forwarding and receive performance may improve
771         as a mutex acquisition is no longer needed in the ip_input()
772         low-level input path.  in_addmulti() and in_delmulti() are shimmed
773         to new KPIs which exist to support SSM in-kernel.
774
775         For application developers, it is recommended that loopback of
776         multicast datagrams be disabled for best performance, as this
777         will still cause the lock to be taken for each looped-back
778         datagram transmission. The net.inet.ip.mcast.loop sysctl may
779         be tuned to 0 to disable loopback by default; it defaults to 1
780         to preserve the existing behaviour.
781
782         For systems administrators, to obtain best performance with
783         multicast reception and multiple groups, it is always recommended
784         that a card with a suitably precise hash filter is used. Hash
785         collisions will still result in the lock being taken within the
786         transport protocol input path to check group membership.
787
788         If deploying FreeBSD in an environment with IGMP snooping switches,
789         it is recommended that the net.inet.igmp.sendlocal sysctl remain
790         enabled; this forces 224.0.0.0/24 group membership to be announced
791         via IGMP.
792
793         The size of 'struct igmpstat' has changed; netstat needs to be
794         recompiled to reflect this.
795         Bump __FreeBSD_version to 800070.
796
797 20090309:
798         libusb20.so.1 is now installed as libusb.so.1 and the ports system
799         updated to use it. This requires a buildworld/installworld in order to
800         update the library and dependencies (usbconfig, etc). Its advisable to
801         rebuild all ports which uses libusb. More specific directions are given
802         in the ports collection UPDATING file. Any /etc/libmap.conf entries for
803         libusb are no longer required and can be removed.
804
805 20090302:
806         A workaround is committed to allow the creation of System V shared
807         memory segment of size > 2 GB on the 64-bit architectures.
808         Due to a limitation of the existing ABI, the shm_segsz member
809         of the struct shmid_ds, returned by shmctl(IPC_STAT) call is
810         wrong for large segments. Note that limits must be explicitly
811         raised to allow such segments to be created.
812
813 20090301:
814         The layout of struct ifnet has changed, requiring a rebuild of all
815         network device driver modules.
816
817 20090227:
818         The /dev handling for the new USB stack has changed, a
819         buildworld/installworld is required for libusb20.
820
821 20090223:
822         The new USB2 stack has now been permanently moved in and all kernel and
823         module names reverted to their previous values (eg, usb, ehci, ohci,
824         ums, ...).  The old usb stack can be compiled in by prefixing the name
825         with the letter 'o', the old usb modules have been removed.
826         Updating entry 20090216 for xorg and 20090215 for libmap may still
827         apply.
828
829 20090217:
830         The rc.conf(5) option if_up_delay has been renamed to
831         defaultroute_delay to better reflect its purpose. If you have
832         customized this setting in /etc/rc.conf you need to update it to
833         use the new name.
834
835 20090216:
836         xorg 7.4 wants to configure its input devices via hald which does not
837         yet work with USB2. If the keyboard/mouse does not work in xorg then
838         add
839                 Option "AllowEmptyInput" "off"
840         to your ServerLayout section.  This will cause X to use the configured
841         kbd and mouse sections from your xorg.conf.
842
843 20090215:
844         The GENERIC kernels for all architectures now default to the new USB2
845         stack. No kernel config options or code have been removed so if a
846         problem arises please report it and optionally revert to the old USB
847         stack. If you are loading USB kernel modules or have a custom kernel
848         that includes GENERIC then ensure that usb names are also changed over,
849         eg uftdi -> usb2_serial_ftdi.
850
851         Older programs linked against the ports libusb 0.1 need to be
852         redirected to the new stack's libusb20.  /etc/libmap.conf can
853         be used for this:
854                 # Map old usb library to new one for usb2 stack
855                 libusb-0.1.so.8 libusb20.so.1
856
857 20090209:
858         All USB ethernet devices now attach as interfaces under the name ueN
859         (eg. ue0). This is to provide a predictable name as vendors often
860         change usb chipsets in a product without notice.
861
862 20090203:
863         The ichsmb(4) driver has been changed to require SMBus slave
864         addresses be left-justified (xxxxxxx0b) rather than right-justified.
865         All of the other SMBus controller drivers require left-justified
866         slave addresses, so this change makes all the drivers provide the
867         same interface.
868
869 20090201:
870         INET6 statistics (struct ip6stat) was updated.
871         netstat(1) needs to be recompiled.
872
873 20090119:
874         NTFS has been removed from GENERIC kernel on amd64 to match
875         GENERIC on i386. Should not cause any issues since mount_ntfs(8)
876         will load ntfs.ko module automatically when NTFS support is
877         actually needed, unless ntfs.ko is not installed or security
878         level prohibits loading kernel modules. If either is the case,
879         "options NTFS" has to be added into kernel config.
880
881 20090115:
882         TCP Appropriate Byte Counting (RFC 3465) support added to kernel.
883         New field in struct tcpcb breaks ABI, so bump __FreeBSD_version to
884         800061. User space tools that rely on the size of struct tcpcb in
885         tcp_var.h (e.g. sockstat) need to be recompiled.
886
887 20081225:
888         ng_tty(4) module updated to match the new TTY subsystem.
889         Due to API change, user-level applications must be updated.
890         New API support added to mpd5 CVS and expected to be present
891         in next mpd5.3 release.
892
893 20081219:
894         With __FreeBSD_version 800060 the makefs tool is part of
895         the base system (it was a port).
896
897 20081216:
898         The afdata and ifnet locks have been changed from mutexes to
899         rwlocks, network modules will need to be re-compiled.
900
901 20081214:
902         __FreeBSD_version 800059 incorporates the new arp-v2 rewrite.
903         RTF_CLONING, RTF_LLINFO and RTF_WASCLONED flags are eliminated.
904         The new code reduced struct rtentry{} by 16 bytes on 32-bit
905         architecture and 40 bytes on 64-bit architecture. The userland
906         applications "arp" and "ndp" have been updated accordingly.
907         The output from "netstat -r" shows only routing entries and
908         none of the L2 information.
909
910 20081130:
911         __FreeBSD_version 800057 marks the switchover from the
912         binary ath hal to source code. Users must add the line:
913
914         options AH_SUPPORT_AR5416
915
916         to their kernel config files when specifying:
917
918         device  ath_hal
919
920         The ath_hal module no longer exists; the code is now compiled
921         together with the driver in the ath module.  It is now
922         possible to tailor chip support (i.e. reduce the set of chips
923         and thereby the code size); consult ath_hal(4) for details.
924
925 20081121:
926         __FreeBSD_version 800054 adds memory barriers to
927         <machine/atomic.h>, new interfaces to ifnet to facilitate
928         multiple hardware transmit queues for cards that support
929         them, and a lock-less ring-buffer implementation to
930         enable drivers to more efficiently manage queueing of
931         packets.
932
933 20081117:
934         A new version of ZFS (version 13) has been merged to -HEAD.
935         This version has zpool attribute "listsnapshots" off by
936         default, which means "zfs list" does not show snapshots,
937         and is the same as Solaris behavior.
938
939 20081028:
940         dummynet(4) ABI has changed. ipfw(8) needs to be recompiled.
941
942 20081009:
943         The uhci, ohci, ehci and slhci USB Host controller drivers have
944         been put into separate modules. If you load the usb module
945         separately through loader.conf you will need to load the
946         appropriate *hci module as well. E.g. for a UHCI-based USB 2.0
947         controller add the following to loader.conf:
948
949                 uhci_load="YES"
950                 ehci_load="YES"
951
952 20081009:
953         The ABI used by the PMC toolset has changed.  Please keep
954         userland (libpmc(3)) and the kernel module (hwpmc(4)) in
955         sync.
956
957 20081009:
958         atapci kernel module now includes only generic PCI ATA
959         driver. AHCI driver moved to ataahci kernel module.
960         All vendor-specific code moved into separate kernel modules:
961         ataacard, ataacerlabs, ataadaptec, ataamd, ataati, atacenatek,
962         atacypress, atacyrix, atahighpoint, ataintel, ataite, atajmicron,
963         atamarvell, atamicron, atanational, atanetcell, atanvidia,
964         atapromise, ataserverworks, atasiliconimage, atasis, atavia
965
966 20080820:
967         The TTY subsystem of the kernel has been replaced by a new
968         implementation, which provides better scalability and an
969         improved driver model. Most common drivers have been migrated to
970         the new TTY subsystem, while others have not. The following
971         drivers have not yet been ported to the new TTY layer:
972
973         PCI/ISA:
974                 cy, digi, rc, rp, sio
975
976         USB:
977                 ubser, ucycom
978
979         Line disciplines:
980                 ng_h4, ng_tty, ppp, sl, snp
981
982         Adding these drivers to your kernel configuration file shall
983         cause compilation to fail.
984
985 20080818:
986         ntpd has been upgraded to 4.2.4p5.
987
988 20080801:
989         OpenSSH has been upgraded to 5.1p1.
990
991         For many years, FreeBSD's version of OpenSSH preferred DSA
992         over RSA for host and user authentication keys.  With this
993         upgrade, we've switched to the vendor's default of RSA over
994         DSA.  This may cause upgraded clients to warn about unknown
995         host keys even for previously known hosts.  Users should
996         follow the usual procedure for verifying host keys before
997         accepting the RSA key.
998
999         This can be circumvented by setting the "HostKeyAlgorithms"
1000         option to "ssh-dss,ssh-rsa" in ~/.ssh/config or on the ssh
1001         command line.
1002
1003         Please note that the sequence of keys offered for
1004         authentication has been changed as well.  You may want to
1005         specify IdentityFile in a different order to revert this
1006         behavior.
1007
1008 20080713:
1009         The sio(4) driver has been removed from the i386 and amd64
1010         kernel configuration files. This means uart(4) is now the
1011         default serial port driver on those platforms as well.
1012
1013         To prevent collisions with the sio(4) driver, the uart(4) driver
1014         uses different names for its device nodes. This means the
1015         onboard serial port will now most likely be called "ttyu0"
1016         instead of "ttyd0". You may need to reconfigure applications to
1017         use the new device names.
1018
1019         When using the serial port as a boot console, be sure to update
1020         /boot/device.hints and /etc/ttys before booting the new kernel.
1021         If you forget to do so, you can still manually specify the hints
1022         at the loader prompt:
1023
1024                 set hint.uart.0.at="isa"
1025                 set hint.uart.0.port="0x3F8"
1026                 set hint.uart.0.flags="0x10"
1027                 set hint.uart.0.irq="4"
1028                 boot -s
1029
1030 20080609:
1031         The gpt(8) utility has been removed. Use gpart(8) to partition
1032         disks instead.
1033
1034 20080603:
1035         The version that Linuxulator emulates was changed from 2.4.2
1036         to 2.6.16. If you experience any problems with Linux binaries
1037         please try to set sysctl compat.linux.osrelease to 2.4.2 and
1038         if it fixes the problem contact emulation mailing list.
1039
1040 20080525:
1041         ISDN4BSD (I4B) was removed from the src tree. You may need to
1042         update a your kernel configuration and remove relevant entries.
1043
1044 20080509:
1045         I have checked in code to support multiple routing tables.
1046         See the man pages setfib(1) and setfib(2).
1047         This is a hopefully backwards compatible version,
1048         but to make use of it you need to compile your kernel
1049         with options ROUTETABLES=2 (or more up to 16).
1050
1051 20080420:
1052         The 802.11 wireless support was redone to enable multi-bss
1053         operation on devices that are capable.  The underlying device
1054         is no longer used directly but instead wlanX devices are
1055         cloned with ifconfig.  This requires changes to rc.conf files.
1056         For example, change:
1057                 ifconfig_ath0="WPA DHCP"
1058         to
1059                 wlans_ath0=wlan0
1060                 ifconfig_wlan0="WPA DHCP"
1061         see rc.conf(5) for more details.  In addition, mergemaster of
1062         /etc/rc.d is highly recommended.  Simultaneous update of userland
1063         and kernel wouldn't hurt either.
1064
1065         As part of the multi-bss changes the wlan_scan_ap and wlan_scan_sta
1066         modules were merged into the base wlan module.  All references
1067         to these modules (e.g. in kernel config files) must be removed.
1068
1069 20080408:
1070         psm(4) has gained write(2) support in native operation level.
1071         Arbitrary commands can be written to /dev/psm%d and status can
1072         be read back from it.  Therefore, an application is responsible
1073         for status validation and error recovery.  It is a no-op in
1074         other operation levels.
1075
1076 20080312:
1077         Support for KSE threading has been removed from the kernel.  To
1078         run legacy applications linked against KSE libmap.conf may
1079         be used.  The following libmap.conf may be used to ensure
1080         compatibility with any prior release:
1081
1082         libpthread.so.1 libthr.so.1
1083         libpthread.so.2 libthr.so.2
1084         libkse.so.3 libthr.so.3
1085
1086 20080301:
1087         The layout of struct vmspace has changed. This affects libkvm
1088         and any executables that link against libkvm and use the
1089         kvm_getprocs() function. In particular, but not exclusively,
1090         it affects ps(1), fstat(1), pkill(1), systat(1), top(1) and w(1).
1091         The effects are minimal, but it's advisable to upgrade world
1092         nonetheless.
1093
1094 20080229:
1095         The latest em driver no longer has support in it for the
1096         82575 adapter, this is now moved to the igb driver. The
1097         split was done to make new features that are incompatible
1098         with older hardware easier to do.
1099
1100 20080220:
1101         The new geom_lvm(4) geom class has been renamed to geom_linux_lvm(4),
1102         likewise the kernel option is now GEOM_LINUX_LVM.
1103
1104 20080211:
1105         The default NFS mount mode has changed from UDP to TCP for
1106         increased reliability.  If you rely on (insecurely) NFS
1107         mounting across a firewall you may need to update your
1108         firewall rules.
1109
1110 20080208:
1111         Belatedly note the addition of m_collapse for compacting
1112         mbuf chains.
1113
1114 20080126:
1115         The fts(3) structures have been changed to use adequate
1116         integer types for their members and so to be able to cope
1117         with huge file trees.  The old fts(3) ABI is preserved
1118         through symbol versioning in libc, so third-party binaries
1119         using fts(3) should still work, although they will not take
1120         advantage of the extended types.  At the same time, some
1121         third-party software might fail to build after this change
1122         due to unportable assumptions made in its source code about
1123         fts(3) structure members.  Such software should be fixed
1124         by its vendor or, in the worst case, in the ports tree.
1125         FreeBSD_version 800015 marks this change for the unlikely
1126         case that a portable fix is impossible.
1127
1128 20080123:
1129         To upgrade to -current after this date, you must be running
1130         FreeBSD not older than 6.0-RELEASE.  Upgrading to -current
1131         from 5.x now requires a stop over at RELENG_6 or RELENG_7 systems.
1132
1133 20071128:
1134         The ADAPTIVE_GIANT kernel option has been retired because its
1135         functionality is the default now.
1136
1137 20071118:
1138         The AT keyboard emulation of sunkbd(4) has been turned on
1139         by default. In order to make the special symbols of the Sun
1140         keyboards driven by sunkbd(4) work under X these now have
1141         to be configured the same way as Sun USB keyboards driven
1142         by ukbd(4) (which also does AT keyboard emulation), f.e.:
1143
1144         Option  "XkbLayout" "us"
1145         Option  "XkbRules" "xorg"
1146         Option  "XkbSymbols" "pc(pc105)+sun_vndr/usb(sun_usb)+us"
1147
1148 20071024:
1149         It has been decided that it is desirable to provide ABI
1150         backwards compatibility to the FreeBSD 4/5/6 versions of the
1151         PCIOCGETCONF, PCIOCREAD and PCIOCWRITE IOCTLs, which was
1152         broken with the introduction of PCI domain support (see the
1153         20070930 entry). Unfortunately, this required the ABI of
1154         PCIOCGETCONF to be broken again in order to be able to
1155         provide backwards compatibility to the old version of that
1156         IOCTL. Thus consumers of PCIOCGETCONF have to be recompiled
1157         again. As for prominent ports this affects neither pciutils
1158         nor xorg-server this time, the hal port needs to be rebuilt
1159         however.
1160
1161 20071020:
1162         The misnamed kthread_create() and friends have been renamed
1163         to kproc_create() etc. Many of the callers already
1164         used kproc_start()..
1165         I will return kthread_create() and friends in a while
1166         with implementations that actually create threads, not procs.
1167         Renaming corresponds with version 800002.
1168
1169 20071010:
1170         RELENG_7 branched.
1171
1172 COMMON ITEMS:
1173
1174         General Notes
1175         -------------
1176         Avoid using make -j when upgrading.  While generally safe, there are
1177         sometimes problems using -j to upgrade.  If your upgrade fails with
1178         -j, please try again without -j.  From time to time in the past there
1179         have been problems using -j with buildworld and/or installworld.  This
1180         is especially true when upgrading between "distant" versions (eg one
1181         that cross a major release boundary or several minor releases, or when
1182         several months have passed on the -current branch).
1183
1184         Sometimes, obscure build problems are the result of environment
1185         poisoning.  This can happen because the make utility reads its
1186         environment when searching for values for global variables.  To run
1187         your build attempts in an "environmental clean room", prefix all make
1188         commands with 'env -i '.  See the env(1) manual page for more details.
1189
1190         When upgrading from one major version to another it is generally best
1191         to upgrade to the latest code in the currently installed branch first,
1192         then do an upgrade to the new branch. This is the best-tested upgrade
1193         path, and has the highest probability of being successful.  Please try
1194         this approach before reporting problems with a major version upgrade.
1195
1196         ZFS notes
1197         ---------
1198         When upgrading the boot ZFS pool to a new version, always follow
1199         these two steps:
1200
1201         1.) recompile and reinstall the ZFS boot loader and boot block
1202         (this is part of "make buildworld" and "make installworld")
1203
1204         2.) update the ZFS boot block on your boot drive
1205
1206         The following example updates the ZFS boot block on the first
1207         partition (freebsd-boot) of a GPT partitioned drive ad0:
1208         "gpart bootcode -p /boot/gptzfsboot -i 1 ad0"
1209
1210         Non-boot pools do not need these updates.
1211
1212         To build a kernel
1213         -----------------
1214         If you are updating from a prior version of FreeBSD (even one just
1215         a few days old), you should follow this procedure.  It is the most
1216         failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1217
1218         make kernel-toolchain
1219         make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1220         make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1221
1222         To test a kernel once
1223         ---------------------
1224         If you just want to boot a kernel once (because you are not sure
1225         if it works, or if you want to boot a known bad kernel to provide
1226         debugging information) run
1227         make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1228         nextboot -k testkernel
1229
1230         To just build a kernel when you know that it won't mess you up
1231         --------------------------------------------------------------
1232         This assumes you are already running a CURRENT system.  Replace
1233         ${arch} with the architecture of your machine (e.g. "i386",
1234         "arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
1235
1236         cd src/sys/${arch}/conf
1237         config KERNEL_NAME_HERE
1238         cd ../compile/KERNEL_NAME_HERE
1239         make depend
1240         make
1241         make install
1242
1243         If this fails, go to the "To build a kernel" section.
1244
1245         To rebuild everything and install it on the current system.
1246         -----------------------------------------------------------
1247         # Note: sometimes if you are running current you gotta do more than
1248         # is listed here if you are upgrading from a really old current.
1249
1250         <make sure you have good level 0 dumps>
1251         make buildworld
1252         make kernel KERNCONF=YOUR_KERNEL_HERE
1253                                                         [1]
1254         <reboot in single user>                         [3]
1255         mergemaster -p                                  [5]
1256         make installworld
1257         mergemaster -i                                  [4]
1258         make delete-old                                 [6]
1259         <reboot>
1260
1261
1262         To cross-install current onto a separate partition
1263         --------------------------------------------------
1264         # In this approach we use a separate partition to hold
1265         # current's root, 'usr', and 'var' directories.   A partition
1266         # holding "/", "/usr" and "/var" should be about 2GB in
1267         # size.
1268
1269         <make sure you have good level 0 dumps>
1270         <boot into -stable>
1271         make buildworld
1272         make buildkernel KERNCONF=YOUR_KERNEL_HERE
1273         <maybe newfs current's root partition>
1274         <mount current's root partition on directory ${CURRENT_ROOT}>
1275         make installworld DESTDIR=${CURRENT_ROOT}
1276         make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1277         make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1278         cp /etc/fstab ${CURRENT_ROOT}/etc/fstab                    # if newfs'd
1279         <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1280         <reboot into current>
1281         <do a "native" rebuild/install as described in the previous section>
1282         <maybe install compatibility libraries from ports/misc/compat*>
1283         <reboot>
1284
1285
1286         To upgrade in-place from 8.x-stable to current
1287         ----------------------------------------------
1288         <make sure you have good level 0 dumps>
1289         make buildworld                                 [9]
1290         make kernel KERNCONF=YOUR_KERNEL_HERE           [8]
1291                                                         [1]
1292         <reboot in single user>                         [3]
1293         mergemaster -p                                  [5]
1294         make installworld
1295         mergemaster -i                                  [4]
1296         make delete-old                                 [6]
1297         <reboot>
1298
1299         Make sure that you've read the UPDATING file to understand the
1300         tweaks to various things you need.  At this point in the life
1301         cycle of current, things change often and you are on your own
1302         to cope.  The defaults can also change, so please read ALL of
1303         the UPDATING entries.
1304
1305         Also, if you are tracking -current, you must be subscribed to
1306         freebsd-current@freebsd.org.  Make sure that before you update
1307         your sources that you have read and understood all the recent
1308         messages there.  If in doubt, please track -stable which has
1309         much fewer pitfalls.
1310
1311         [1] If you have third party modules, such as vmware, you
1312         should disable them at this point so they don't crash your
1313         system on reboot.
1314
1315         [3] From the bootblocks, boot -s, and then do
1316                 fsck -p
1317                 mount -u /
1318                 mount -a
1319                 cd src
1320                 adjkerntz -i            # if CMOS is wall time
1321         Also, when doing a major release upgrade, it is required that
1322         you boot into single user mode to do the installworld.
1323
1324         [4] Note: This step is non-optional.  Failure to do this step
1325         can result in a significant reduction in the functionality of the
1326         system.  Attempting to do it by hand is not recommended and those
1327         that pursue this avenue should read this file carefully, as well
1328         as the archives of freebsd-current and freebsd-hackers mailing lists
1329         for potential gotchas.  The -U option is also useful to consider.
1330         See mergemaster(8) for more information.
1331
1332         [5] Usually this step is a noop.  However, from time to time
1333         you may need to do this if you get unknown user in the following
1334         step.  It never hurts to do it all the time.  You may need to
1335         install a new mergemaster (cd src/usr.sbin/mergemaster && make
1336         install) after the buildworld before this step if you last updated
1337         from current before 20020224 or from -stable before 20020408.
1338
1339         [6] This only deletes old files and directories. Old libraries
1340         can be deleted by "make delete-old-libs", but you have to make
1341         sure that no program is using those libraries anymore.
1342
1343         [8] In order to have a kernel that can run the 4.x binaries needed to
1344         do an installworld, you must include the COMPAT_FREEBSD4 option in
1345         your kernel.  Failure to do so may leave you with a system that is
1346         hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1347         required to run the 5.x binaries on more recent kernels.  And so on
1348         for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1349
1350         Make sure that you merge any new devices from GENERIC since the
1351         last time you updated your kernel config file.
1352
1353         [9] When checking out sources, you must include the -P flag to have
1354         cvs prune empty directories.
1355
1356         If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1357         "?=" instead of the "=" assignment operator, so that buildworld can
1358         override the CPUTYPE if it needs to.
1359
1360         MAKEOBJDIRPREFIX must be defined in an environment variable, and
1361         not on the command line, or in /etc/make.conf.  buildworld will
1362         warn if it is improperly defined.
1363 FORMAT:
1364
1365 This file contains a list, in reverse chronological order, of major
1366 breakages in tracking -current.  Not all things will be listed here,
1367 and it only starts on October 16, 2004.  Updating files can found in
1368 previous releases if your system is older than this.
1369
1370 Copyright information:
1371
1372 Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1373
1374 Redistribution, publication, translation and use, with or without
1375 modification, in full or in part, in any form or format of this
1376 document are permitted without further permission from the author.
1377
1378 THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1379 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1380 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1381 DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1382 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1383 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1384 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1385 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1386 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1387 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1388 POSSIBILITY OF SUCH DAMAGE.
1389
1390 Contact Warner Losh if you have any questions about your use of
1391 this document.
1392
1393 $FreeBSD$