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