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