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