UPDATING

   1 Updating Information for FreeBSD current users
   2
   3 This file is maintained and copyrighted by M. Warner Losh
   4 <imp@village.org>.  See end of file for further details.  For commonly
   5 done items, please see the COMMON ITEMS: section later in the file.
   6
   7 Items affecting the ports and packages system can be found in
   8 /usr/ports/UPDATING.  Please read that file before running
   9 portupgrade.
  10
  11 NOTE TO PEOPLE WHO THINK THAT FreeBSD 6.x IS SLOW:
  12         FreeBSD 6.x has many debugging features turned on, in
  13         both the kernel and userland.  These features attempt to detect
  14         incorrect use of system primitives, and encourage loud failure
  15         through extra sanity checking and fail stop semantics.  They
  16         also substantially impact system performance.  If you want to
  17         do performance measurement, benchmarking, and optimization,
  18         you'll want to turn them off.  This includes various WITNESS-
  19         related kernel options, INVARIANTS, malloc debugging flags
  20         in userland, and various verbose features in the kernel.  Many
  21         developers choose to disable these features on build machines
  22         to maximize performance.
  23
  24 20050528:
  25         Kernel parsing of extra options on '#!' first lines of shell
  26         scripts has changed.  Lines with multiple options likely will
  27         fail after this date.  For full details, please see
  28                 http://people.freebsd.org/~gad/Updating-20050528.txt
  29
  30 20050503:
  31         The packet filter (pf) code has been updated to OpenBSD 3.7
  32         Please note the changed anchor syntax and the fact that
  33         authpf(8) now needs a mounted fdescfs(5) to function.
  34
  35 20050415:
  36         The NO_MIXED_MODE kernel option has been removed from the i386
  37         amd64 platforms as its use has been superceded by the new local
  38         APIC timer code.  Any kernel config files containing this option
  39         should be updated.
  40
  41 20050227:
  42         The on-disk format of LC_CTYPE files was changed to be machine
  43         independent.  Please make sure NOT to use NO_CLEAN buildworld
  44         when crossing this point.
  45
  46 20050225:
  47         The ifi_epoch member of struct if_data has been changed to
  48         contain the uptime at which the interface was created or the
  49         statistics zeroed rather then the wall clock time because
  50         wallclock time may go backwards.  This should have no impact
  51         unless an snmp implementation is using this value (I know of
  52         none at this point.)
  53
  54 20050224:
  55         The acpi_perf and acpi_throttle drivers are now part of the
  56         acpi(4) main module.  They are no longer built separately.
  57
  58 20050223:
  59         The layout of struct image_params has changed. You have to
  60         recompile all compatibility modules (linux, svr4, etc) for use
  61         with the new kernel.
  62
  63 20050223:
  64         The p4tcc driver has been merged into cpufreq(4).  This makes
  65         "options CPU_ENABLE_TCC" obsolete.  Please load cpufreq.ko or
  66         compile in "device cpufreq" to restore this functionality.
  67
  68 20050220:
  69         The responsibility of recomputing the file system summary of
  70         a SoftUpdates-enabled dirty volume has been transferred to the
  71         background fsck.  A rebuild of fsck(8) utility is recommended
  72         if you have updated the kernel.
  73
  74         To get the old behavior (recompute file system summary at mount
  75         time), you can set vfs.ffs.compute_summary_at_mount=1 before
  76         mounting the new volume.
  77
  78 20050206:
  79         The cpufreq import is complete.  As part of this, the sysctls for
  80         acpi(4) throttling have been removed.  The power_profile script
  81         has been updated, so you can use performance/economy_cpu_freq in
  82         rc.conf(5) to set AC on/offline cpu frequencies.
  83
  84 20050206:
  85         NG_VERSION has been increased. Recompiling kernel (or ng_socket.ko)
  86         requires recompiling libnetgraph and userland netgraph utilities.
  87
  88 20050114:
  89         Support for abbreviated forms of a number of ipfw options is
  90         now deprecated.  Warnings are printed to stderr indicating the
  91         correct full form when a match occurs.  Some abbreviations may
  92         be supported at a later date based on user feedback.  To be
  93         considered for support, abbreviations must be in use prior to
  94         this commit and unlikely to be confused with current key words.
  95
  96 20041221:
  97         By a popular demand, a lot of NOFOO options were renamed
  98         to NO_FOO (see bsd.compat.mk for a full list).  The old
  99         spellings are still supported, but will cause annoying
 100         warnings on stderr.  Make sure you upgrade properly (see
 101         the COMMON ITEMS: section later in this file).
 102
 103 20041219:
 104         Auto-loading of ancillary wlan modules such as wlan_wep has
 105         been temporarily disabled; you need to statically configure
 106         the modules you need into your kernel or explicitly load them
 107         prior to use.  Specifically, if you intend to use WEP encryption
 108         with an 802.11 device load/configure wlan_wep; if you want to
 109         use WPA with the ath driver load/configure wlan_tkip, wlan_ccmp,
 110         and wlan_xauth as required.
 111
 112 20041213:
 113         The behaviour of ppp(8) has changed slightly.  If lqr is enabled
 114         (``enable lqr''), older versions would revert to LCP ECHO mode on
 115         negotiation failure.  Now, ``enable echo'' is required for this
 116         behaviour.  The ppp version number has been bumped to 3.4.2 to
 117         reflect the change.
 118
 119 20041201:
 120         The wlan support has been updated to split the crypto support
 121         into separate modules.  For static WEP you must configure the
 122         wlan_wep module in your system or build and install the module
 123         in place where it can be loaded (the kernel will auto-load
 124         the module when a wep key is configured).
 125
 126 20041201:
 127         The ath driver has been updated to split the tx rate control
 128         algorithm into a separate module.  You need to include either
 129         ath_rate_onoe or ath_rate_amrr when configuring the kernel.
 130
 131 20041116:
 132         Support for systems with an 80386 CPU has been removed.  Please
 133         use FreeBSD 5.x or earlier on systems with an 80386.
 134
 135 20041110:
 136         We have had a hack which would mount the root filesystem
 137         R/W if the device were named 'md*'.  As part of the vnode
 138         work I'm doing I have had to remove this hack.  People
 139         building systems which use preloaded MD root filesystems
 140         may need to insert a "/sbin/mount -u -o rw /dev/md0 /" in
 141         their /etc/rc scripts.
 142
 143 20041104:
 144         FreeBSD 5.3 shipped here.
 145
 146 20041102:
 147         The size of struct tcpcb has changed again due to the removal
 148         of RFC1644 T/TCP.  You have to recompile userland programs that
 149         read kmem for tcp sockets directly (netstat, sockstat, etc.)
 150
 151 20041022:
 152         The size of struct tcpcb has changed.  You have to recompile
 153         userland programs that read kmem for tcp sockets directly
 154         (netstat, sockstat, etc.)
 155
 156 20041016:
 157         RELENG_5 branched here.  For older entries, please see updating
 158         in the RELENG_5 branch.
 159
 160 COMMON ITEMS:
 161
 162         General Notes
 163         -------------
 164         Avoid using make -j when upgrading.  From time to time in the
 165         past there have been problems using -j with buildworld and/or
 166         installworld.  This is especially true when upgrading between
 167         "distant" versions (eg one that cross a major release boundary
 168         or several minor releases, or when several months have passed
 169         on the -current branch).
 170
 171         Sometimes, obscure build problems are the result of environment
 172         poisoning.  This can happen because the make utility reads its
 173         environment when searching for values for global variables.
 174         To run your build attempts in an "environmental clean room",
 175         prefix all make commands with 'env -i '.  See the env(1) manual
 176         page for more details.
 177
 178         To build a kernel
 179         -----------------
 180         If you are updating from a prior version of FreeBSD (even one just
 181         a few days old), you should follow this procedure. With a
 182         /usr/obj tree with a fresh buildworld,
 183         make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
 184         make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
 185
 186         To test a kernel once
 187         ---------------------
 188         If you just want to boot a kernel once (because you are not sure
 189         if it works, or if you want to boot a known bad kernel to provide
 190         debugging information) run
 191         make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
 192         nextboot -k testkernel
 193
 194         To just build a kernel when you know that it won't mess you up
 195         --------------------------------------------------------------
 196         This assumes you are already running a 5.X system.  Replace
 197         ${arch} with the architecture of your machine (e.g. "i386",
 198         "alpha", "amd64", "ia64", "pc98", "sparc64", etc).
 199
 200         cd src/sys/${arch}/conf
 201         config KERNEL_NAME_HERE
 202         cd ../compile/KERNEL_NAME_HERE
 203         make depend
 204         make
 205         make install
 206
 207         If this fails, go to the "To build a kernel" section.
 208
 209         To rebuild everything and install it on the current system.
 210         -----------------------------------------------------------
 211         # Note: sometimes if you are running current you gotta do more than
 212         # is listed here if you are upgrading from a really old current.
 213
 214         <make sure you have good level 0 dumps>
 215         make buildworld
 216         make kernel KERNCONF=YOUR_KERNEL_HERE
 217                                                         [1]
 218         <reboot in single user>                         [3]
 219         mergemaster -p                                  [5]
 220         make installworld
 221         mergemaster                                     [4]
 222         <reboot>
 223
 224
 225         To cross-install current onto a separate partition
 226         --------------------------------------------------
 227         # In this approach we use a separate partition to hold
 228         # current's root, 'usr', and 'var' directories.   A partition
 229         # holding "/", "/usr" and "/var" should be about 2GB in
 230         # size.
 231
 232         <make sure you have good level 0 dumps>
 233         <boot into -stable>
 234         make buildworld
 235         make buildkernel KERNCONF=YOUR_KERNEL_HERE
 236         <maybe newfs current's root partition>
 237         <mount current's root partition on directory ${CURRENT_ROOT}>
 238         make installworld DESTDIR=${CURRENT_ROOT}
 239         cd src/etc; make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
 240         make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
 241         cp /etc/fstab ${CURRENT_ROOT}/etc/fstab                    # if newfs'd
 242         <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
 243         <reboot into current>
 244         <do a "native" rebuild/install as described in the previous section>
 245         <maybe install compatibility libraries from src/lib/compat>
 246         <reboot>
 247
 248
 249         To upgrade in-place from 5.x-stable to current
 250         ----------------------------------------------
 251         <make sure you have good level 0 dumps>
 252         make buildworld                                 [9]
 253         make kernel KERNCONF=YOUR_KERNEL_HERE           [8]
 254                                                         [1]
 255         <reboot in single user>                         [3]
 256         mergemaster -p                                  [5]
 257         make installworld
 258         mergemaster -i                                  [4]
 259         <reboot>
 260
 261         Make sure that you've read the UPDATING file to understand the
 262         tweaks to various things you need.  At this point in the life
 263         cycle of current, things change often and you are on your own
 264         to cope.  The defaults can also change, so please read ALL of
 265         the UPDATING entries.
 266
 267         Also, if you are tracking -current, you must be subscribed to
 268         freebsd-current@freebsd.org.  Make sure that before you update
 269         your sources that you have read and understood all the recent
 270         messages there.  If in doubt, please track -stable which has
 271         much fewer pitfalls.
 272
 273         [1] If you have third party modules, such as vmware, you
 274         should disable them at this point so they don't crash your
 275         system on reboot.
 276
 277         [3] From the bootblocks, boot -s, and then do
 278                 fsck -p
 279                 mount -u /
 280                 mount -a
 281                 cd src
 282                 adjkerntz -i            # if CMOS is wall time
 283         Also, when doing a major release upgrade, it is required that
 284         you boot into single user mode to do the installworld.
 285
 286         [4] Note: This step is non-optional.  Failure to do this step
 287         can result in a significant reduction in the functionality of the
 288         system.  Attempting to do it by hand is not recommended and those
 289         that pursue this avenue should read this file carefully, as well
 290         as the archives of freebsd-current and freebsd-hackers mailing lists
 291         for potential gotchas.
 292
 293         [5] Usually this step is a noop.  However, from time to time
 294         you may need to do this if you get unknown user in the following
 295         step.  It never hurts to do it all the time.  You may need to
 296         install a new mergemaster (cd src/usr.sbin/mergemaster && make
 297         install) after the buildworld before this step if you last updated
 298         from current before 20020224 or from -stable before 20020408.
 299
 300         [8] In order to have a kernel that can run the 4.x binaries
 301         needed to do an installworld, you must include the COMPAT_FREEBSD4
 302         option in your kernel.  Failure to do so may leave you with a system
 303         that is hard to boot to recover.
 304
 305         Make sure that you merge any new devices from GENERIC since the
 306         last time you updated your kernel config file.
 307
 308         [9] When checking out sources, you must include the -P flag to have
 309         cvs prune empty directories.
 310
 311         If CPUTYPE is defined in your /etc/make.conf, make sure to use the
 312         "?=" instead of the "=" assignment operator, so that buildworld can
 313         override the CPUTYPE if it needs to.
 314
 315         MAKEOBJDIRPREFIX must be defined in an environment variable, and
 316         not on the command line, or in /etc/make.conf.  buildworld will
 317         warn if it is improperly defined.
 318 FORMAT:
 319
 320 This file contains a list, in reverse chronological order, of major
 321 breakages in tracking -current.  Not all things will be listed here,
 322 and it only starts on October 16, 2004.  Updating files can found in
 323 previous releases if your system is older than this.
 324
 325 Copyright information:
 326
 327 Copyright 1998-2005 M. Warner Losh.  All Rights Reserved.
 328
 329 Redistribution, publication, translation and use, with or without
 330 modification, in full or in part, in any form or format of this
 331 document are permitted without further permission from the author.
 332
 333 THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
 334 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 335 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 336 DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
 337 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 338 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 339 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 340 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 341 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 342 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 343 POSSIBILITY OF SUCH DAMAGE.
 344
 345 If you find this document useful, and you want to, you may buy the
 346 author a beer.
 347
 348 Contact Warner Losh if you have any questions about your use of
 349 this document.
 350
 351 $FreeBSD$