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