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