unbreak kernel (netgraph) by adding missing header inclusion
[dragonfly.git] / UPDATING
1 # Updating Information for DragonFly users.
2 #
3 #
4 # This file should warn you of any pitfalls which you might need to work around
5 # when trying to update your DragonFly system.  The information below is
6 # in reverse-time order, with the latest information at the top.
7 #
8 # If you discover any problem, please contact the bugs@lists.dragonflybsd.org
9 # mailing list with the details.
10
11 +-----------------------------------------------------------------------+
12 +         UPGRADING DRAGONFLY FROM 3.8 TO LATER VERSIONS                +
13 +-----------------------------------------------------------------------+
14
15 DEFAULT DRIVER CHANGED FOR LSI "THUNDERBOLT" SERIES RAID CONTROLLERS
16 --------------------------------------------------------------------
17
18 The default driver for those controllers is now mrsas(4) due to reports
19 of file system corruption using the mfi(4) driver. The whole issue (and
20 how to deal with potential problems when switching) was explained here:
21
22 http://lists.dragonflybsd.org/pipermail/users/2014-July/128703.html
23
24 A tunable is provided for letting those controllers still attach via
25 the mfi(4) driver, hw.mrsas.mfi_enable (see mrsas(4) manual page).
26
27 OLDER NETWORK DRIVERS MOVED TO I386 ONLY
28 ----------------------------------------
29
30 The following drivers have been made i386 only: ed(4), sr(4), ng_sync_ar
31 and ng_sync_sr. ed(4) used to be in X86_64_GENERIC, so it has to be
32 removed in kernel configs derived from X86_64_GENERIC.
33
34 +-----------------------------------------------------------------------+
35 +         UPGRADING DRAGONFLY FROM 3.6 TO LATER VERSIONS                +
36 +-----------------------------------------------------------------------+
37
38 UPDATE FROM MOST RECENT 3.6
39 ---------------------------
40
41 Versions of 3.6 built before June 25th have a bug where installworld might 
42 crash during installation of the new initrd.  Upgrade to the latest version
43 of 3.6 before updating to 3.8 or later.
44
45 ATM, IPX, NCP AND NWFS SUPPORT DROPPED
46 --------------------------------------
47
48 Support for the IPX and NCP network protocols and for mouting NetWare
49 file systems has been dropped. Dito for ATM protocol support.
50
51 INITRD IMAGES NOW INSTALLED BY DEFAULT
52 --------------------------------------
53
54 An initial ramdisk image is now installed in /boot/kernel/initrd.img.gz
55
56 Older images installed under the file name of initrd.img will be removed
57 automatically by the make upgrade process.
58
59 USB4BSD IS NOW THE DEFAULT USB STACK
60 ------------------------------------
61
62 To get back to the old stack, put "WANT_OLDUSB=yes" in /etc/make.conf and
63 replace "device usb" with "device oldusb" in the kernel configuration.
64
65 MORE ISA SUPPORT DROPPED
66 ------------------------
67
68 ISA support has been dropped from the following drivers: adv(4), an(4),
69 ar(4), cs(4), digi(4), ed(4), ep(4), ex(4), fe(4), lnc(4), sbni(4),
70 si(4), sn(4), and stg(4).
71
72 +-----------------------------------------------------------------------+
73 +         UPGRADING DRAGONFLY FROM 3.4 TO LATER VERSIONS                +
74 +-----------------------------------------------------------------------+
75
76 ABI CHANGE
77 ----------
78
79 Installed third-party software (dports) will have to be rebuilt after upgrade,
80 or reinstalled from binary packages.
81
82 UPDATING FROM 3.4 TO 3.6
83 ------------------------
84
85 This only applies for this specific upgrade due to locale changes; it is 
86 not needed for upgrades after 3.6.  Please update in this order:
87
88 make buildworld
89 make buildkernel
90 make installworld
91 make installkernel
92 *reboot*
93 make upgrade
94
95 See this mailing list post for details:
96 http://lists.dragonflybsd.org/pipermail/users/2013-September/090163.html
97
98 CYRIX OPTIONS REMOVED
99 ---------------------
100
101 The following Cyrix related options have been removed: CPU_BTB_EN,
102 CPU_CYRIX_NO_LOCK, CPU_DIRECT_MAPPED_CACHE, CPU_DISABLE_5X86_LSSER,
103 CPU_FASTER_5X86_FPU, CPU_IORT, CPU_LOOP_EN, CPU_RSTK_EN, CPU_SUSP_HLT,
104 CYRIX_CACHE_WORKS, and CYRIX_CACHE_REALLY_WORKS
105
106 ISA SUPPORT REMOVED FROM RP(4)
107 ------------------------------
108
109 ISA support has been removed from the rp(4) driver. It is now PCI only.
110
111 +-----------------------------------------------------------------------+
112 +         UPGRADING DRAGONFLY FROM 3.2 TO LATER VERSIONS                +
113 +-----------------------------------------------------------------------+
114
115 COMPAT_SUNOS OPTION REMOVED
116 ---------------------------
117
118 The COMPAT_SUNOS option has been removed. It was meant to provide binary
119 compatibility with SunOS 4.x for the sparc32 port of 4.4BSD.
120
121 ISA SOUND CARD SUPPORT REMOVED
122 ------------------------------
123
124 The following modules have been removed (all for ISA sound cards):
125 snd_ad1816.ko, snd_ess.ko, snd_mss.ko, snd_sb8.ko, snd_sb16.ko, snd_sbc.ko
126
127 GCC 4.7
128 -------
129
130 DragonFly has switched base compilers.  GCC 4.7 is now the default
131 compiler and GCC 4.4 is the alternative compiler.  The "NO_GCC47" make
132 variable ceases to work now.
133
134 Users who wish to build only GCC 4.7 have to use NO_GCC44 in the
135 /etc/make.conf to prohibit GCC 4.4 from building.  However, using it is
136 highly discouraged.  There are a few packages in pkgsrc that do not build
137 with GCC 4.7 and the new "DPorts" system uses GCC 4.4 by default.  At
138 this time, it is recommended to keep both compilers on the base system.
139
140 SMP OPTION REMOVED
141 ------------------
142
143 The SMP kernel option has been made a no-op. All kernels now feature SMP
144 support. If you have 'options SMP' in your kernel config, you can as well
145 remove it.
146
147 DEVICE_POLLING OPTION REPLACED BY IFPOLL_ENABLE OPTION, KTR_POLLING REMOVED
148 ---------------------------------------------------------------------------
149
150 The DEVICE_POLLING kernel option has been made a no-op and it has been
151 replaced by IFPOLL_ENABLE.  If you have 'options DEVICE_POLLING' in your
152 kernel config, you need to change it to IFPOLL_ENABLE.
153
154 Also, the KTR_POLLING kernel option has been removed, so it must be
155 removed from kernel configs that have it.
156
157 BUSLOGIC, CYCLADES AND STALLION ISA SUPPORT REMOVED
158 ---------------------------------------------------
159
160 The bt(4) driver for Buslogic SCSI adapters has been made PCI only. ISA
161 cards will no longer be detected.
162
163 The same has been done for Stallion multiport serial controllers. stli(4)
164 has been completely removed (along with the stlload(8) and stlstty(8)
165 utilities) and stl(4) was changed to support only PCI cards. Similarly,
166 ISA support was removed from cy(4) too. All these drivers are i386 only.
167
168 COMPAT_OLDISA OPTION GONE
169 -------------------------
170
171 The i386 specific COMPAT_OLDISA kernel option has been removed, since
172 nothing needs it anymore.
173
174 +-----------------------------------------------------------------------+
175 +         UPGRADING DRAGONFLY FROM 3.0 TO LATER VERSIONS                +
176 +-----------------------------------------------------------------------+
177
178 APIC_IO OPTION REMOVED
179 ----------------------
180
181 The APIC_IO kernel option is no longer accepted after having been without
182 effect for a while. The hw.ioapic_enable tunable now serves its purpose.
183 If you have 'options APIC_IO' in your kernel config, you'll have to
184 remove it.
185
186 WATCHDOG_ENABLE & HW_WDOG OPTIONS REMOVED
187 -----------------------------------------
188
189 The wdog framework is now compiled into our kernels by default, so the
190 options are no longer needed.
191
192 DOSCMD(1) REMOVED
193 -----------------
194
195 doscmd(1) has been removed. It was i386 only. The doscmd(1) specific
196 NO_X make.conf option was removed too.
197
198 GCC 4.7
199 -------
200
201 GCC 4.7 has been brought in and replaces GCC 4.1 as DragonFly's non-
202 default compiler in base (default is still GCC 4.4).
203
204 Users who wish to build only GCC 4.4 have to replace NO_GCC41 with
205 NO_GCC47 in /etc/make.conf.
206
207 USB4BSD
208 -------
209
210 A new USB stack (from FreeBSD) has been brought in. The following
211 modules have been ported so far: usb, uhci, ohci, ehci, xhci, umass,
212 usfs, uether, if_axe, if_udav, ukbd, ums, uep, uhid, usb_quirk,
213 and uaudio.
214
215 It is not yet the default. To activate it, WANT_USB4BSD=yes has to
216 be put in make.conf and device "usb4bsd" (quotes needed) has to
217 replace device usb in the kernel config. After that, a full
218 build/install/upgrade cycle is needed.
219
220 Note that this is experimental and incomplete, but we are interested
221 in hearing about issues with it, of course.
222
223 ISA SUPPORT REMOVED FROM AIC-6260/6360 DRIVER
224 ---------------------------------------------
225
226 ISA adapter support was dropped from the aic(4) driver.
227
228 +-----------------------------------------------------------------------+
229 +         UPGRADING DRAGONFLY FROM 2.10 TO LATER VERSIONS               +
230 +-----------------------------------------------------------------------+
231
232 SEVERAL ISA DRIVERS REMOVED
233 ---------------------------
234
235 The following ISA only drivers have been removed along with a couple of
236 associated userland tools:
237
238 aha(4)
239 asc(4) & sasc(1)
240 ctx
241 dgb(4)
242 el(4)
243 gpib
244 gsc(4) & sgsc(1)
245 ie(4)
246 labpc(4)
247 le(4)
248 mse(4)
249 rc(4)
250 rdp(4)
251 spigot
252 tw(4) & xten(1) & xtend(8)
253 wl(4) & wlconfig(8)
254 wt(4)
255
256 Note that two of these drivers (aha(4) and ie(4)) are in our GENERIC
257 config and one (aha(4)) is in our X86_64_GENERIC kernel configuration
258 file.
259
260 If buildkernel complains about any of these drivers, just remove them
261 from your kernel configuration.
262
263 BINUTILS 2.20
264 -------------
265 Binutils 2.20 has been removed in favor of Binutils 2.22.  The accepted
266 values of BINUTILSVERS are now binutils221 and binutils222 (default).
267
268 BUILDWORLD/-KERNEL PARALLELIZATION WORK
269 ---------------------------------------
270 Due to changes in the way we build with more than one make job, you
271 will have to update install(1) and mkdir(1) prior to buildworld if you
272 want to build with 'make -j':
273
274 cd /usr/src/usr.bin/xinstall; make; make install; make clean
275 cd /usr/src/bin/mkdir; make; make install; make clean
276
277 DMA(8) UPGRADE
278 --------------
279 dma(8) has been upgraded to v0.7 which no longer supports the
280 /etc/dma/virtusertable. Some of its functionality has been replaced
281 with the MASQUERADE keyword and the EMAIL environment variable (see
282 the dma(8) manual page).
283
284 +-----------------------------------------------------------------------+
285 +         UPGRADING DRAGONFLY FROM 2.8 TO LATER VERSIONS                +
286 +-----------------------------------------------------------------------+
287
288 GCC 4.4 & BINUTILS 2.21
289 -----------------------
290
291 GCC 4.4 has been made DragonFly's default compiler and Binutils 2.21 has
292 been made DragonFly's default Binutils.
293
294 That means that any settings that set CCVER to 'gcc44' are not needed
295 anymore. Instead, CCVER can be set to 'gcc41' to go back to using
296 GCC 4.1.
297
298 It also means that 'binutils221' as a value for BINUTILSVER has no
299 effect anymore. 2.17 has been removed and 'binutils220' is available
300 as an option.
301
302 The NO_GCC44 option has been removed and will not affect the build
303 anymore. There is now a NO_GCC41 option that will prevent GCC 4.1 from
304 building in a similar fashion.
305
306 Note that you must do a full buildworld/buildkernel for upgrading.
307
308 pkg_radd settings
309 -----------------
310
311 The config file for pkg_radd has moved from /etc/settings.conf to 
312 /etc/pkg_radd.conf.  Save the contents of settings.conf before upgrading
313 if this is needed.  This warning only applies if /etc/settings.conf 
314 exists.  pkg_radd will continue to work with defaults.
315
316 +-----------------------------------------------------------------------+
317 +         20100927                                                      +
318 +         UPGRADING DRAGONFLY FROM 2.6 to 2.8 or HEAD                   +
319 +-----------------------------------------------------------------------+
320
321 OpenSSL
322 --------
323
324 OpenSSL has been upgraded, and SHLIB_MAJOR was bumped for libssh and libcrypto.
325 This shouldn't break any 3rd-party software, but you'll need to recompile your
326 3rd-party software if you want it to link against the new version of OpenSSL.
327
328 Loader
329 -------
330
331 A new loader (dloader) has been added which better handles booting from
332 multiple kernel/module versions.
333
334 To upgrade (Only for this upgrade, for post 2.8 upgrades see GENERAL below)
335
336         cd /usr/src
337         make buildworld
338         make installworld
339         make upgrade
340         make buildkernel KERNCONF=<KERNELNAME>
341         make installkernel KERNCONF=<KERNELNAME>
342
343 Note that you must installworld and run the 'upgrade' target before
344 installing the new kernel.
345
346 BIND
347 -----
348
349 BIND has been removed from the base system.  The ldns and drill tools have 
350 been added for basic functionality.  Use 'drill' where you would normally 
351 use nslookup or dig, or install BIND from pkgsrc.  It's available as 
352 net/bind95, net/bind96, or net/bind97 as of this writing.
353
354 This only affects older systems upgrading to 2.8.  New 2.8+ installs 
355 include BIND as a pkgsrc package.
356
357 +-----------------------------------------------------------------------+
358 +         UPGRADING DRAGONFLY ON AN EXISTING DRAGONFLY SYSTEM           +
359 +                               GENERAL                                 +
360 +-----------------------------------------------------------------------+
361
362 Instructions on how to obtain and maintain DragonFly source code using git
363 are in the development(7) manual page.
364
365 To upgrade a DragonFly system from sources you run the following sequence:
366
367         cd /usr/src
368         make buildworld
369         make buildkernel KERNCONF=<KERNELNAME>
370         make installkernel KERNCONF=<KERNELNAME>
371         make installworld
372
373 You will also want to run the 'upgrade' target to upgrade your /etc and the
374 rest of your system.  The upgrade target is aware of stale files created by
375 older DragonFly installations and should delete them automatically.
376
377         make upgrade
378
379 See the build(7) manual page for further information.
380
381 Once you've done a full build of the world and kernel you can do incremental
382 upgrades of either by using the 'quickworld' and 'quickkernel' targets
383 instead of 'buildworld' and 'buildkernel'.  If you have any problems with
384 the quick targets, try updating your repo first, and then a full buildworld
385 and buildkernel as shown above, before asking for help.
386
387 +-----------------------------------------------------------------------+
388 +         UPGRADING FROM DRAGONFLY <= 2.0 TO DRAGONFLY >= 2.1           +
389 +-----------------------------------------------------------------------+
390
391 In 2.1 kernel and modules has moved to boot directory.  For most cases
392 this is handled automatically by 'make upgrade'.  A few cases needs manual
393 intervention:
394
395  * When installing a kernel without first doing a make buildworld,
396    installworld and upgrade to the same DESTDIR as kernel:
397    make DESTDIR/boot directory and move kernel and modules into this boot
398    directory; also move kernel.old and modules.old.
399    Typical example is vkernel(7), use (no modules used):
400
401         cd /var/vkernel
402         mkdir boot
403         chflags noschg kernel
404         mv kernel kernel.old boot
405         chflags schg boot/kernel
406         
407  * When using a boot-only partition, /boot/loader.rc needs to be edited:
408    delete occurrences of '/boot/'.
409    These occurences can normally be deleted in any case, see loader(8).
410
411 +-----------------------------------------------------------------------+
412 +         UPGRADING FROM DRAGONFLY <= 1.8 TO DRAGONFLY >= 1.9           +
413 +-----------------------------------------------------------------------+
414
415 In 1.9 major changes to the disk management infrastructure have taken
416 place.  make upgrade may not catch all of your disk devices in /dev,
417 so after upgrading be sure to cd /dev; ./MAKEDEV <blah> where <blah>
418 are all of your disk devices.  HOWEVER, from late 2.3 on we run devfs
419 and MAKEDEV no longer exists.
420
421 The biggest changes in 1.9 are:
422
423 (1) That whole-slice devices such as da0s1 no longer share the same device
424     id as partition c devices such as da0s1c.
425
426 (2) The whole-disk device (e.g. da0) is full raw access to the disk,
427     with no snooping or reserved sectors.  Consequently you cannot run
428     disklabel on this device.  Instead you must run disklabel on a
429     whole-slice device.
430
431 (3) The 'compatibility' partitions now use slice 0 in the device name,
432     so instead of da0a you must specify da0s0a.  Also, as per (1) above,
433     accessing the disklabel for the compatibility partitions must be
434     done via slice 0 (da0s0).
435
436 (4) Many device drivers that used to fake up labels, such as CD, ACD, VN,
437     and CCD now run through the disk management layer and are assigned
438     real disk management devices.   VN and CCD in particular do not usually
439     use a MBR and disklabels must be accessed through the compatibility
440     slice 0.  Your /etc/ccd.conf file still specifies 'ccd0', though, you
441     don't name it 'ccd0s0' in the config file.
442
443 Generally speaking, you have to get used to running fdisk and disklabel on
444 the correctly specified device names.  A lot of the wiggle, such as running
445 disklabel on a partition, has been removed.
446
447 +-----------------------------------------------------------------------+
448 +         UPGRADING FROM OLDER VERSIONS OF DRAGONFLY OR FREEBSD         +
449 +-----------------------------------------------------------------------+
450
451 > Kerberos IV
452 -------------
453
454 Kerberos IV (eBones) was removed from the tree, please consider moving to
455 Kerberos 5 (Heimdal).
456
457 > Package Management System
458 ---------------------------
459
460 Starting with the 1.4 release, DragonFly uses NetBSD's pkgsrc package
461 management system.  The necessary tools to build and maintain packages
462 are provided in /usr/pkg/bin and /usr/pkg/sbin.  Make sure that these
463 directories are in your PATH variable.
464
465 In order to obtain a reasonably current snapshot of the pkgsrc tree, use
466 the tarball from NetBSD:
467
468         fetch -o /tmp/pkgsrc.tar.gz ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc.tar.gz
469         cd /usr; tar -xzf /tmp/pkgsrc.tar.gz; chown -R root:wheel pkgsrc
470
471 This tree can then be kept up to date with cvs update:
472
473         cd /usr/pkgsrc; cvs up
474
475 NOTE! If you upgraded from a pre-1.4 system to 1.4 or later, you need to
476 build and install the pkgsrc bootstrap manually:
477
478         cd /usr/pkgsrc/bootstrap
479         ./bootstrap --pkgdbdir /var/db/pkg --prefix /usr/pkg
480
481 +-----------------------------------------------------------------------+
482 +         UPGRADING DRAGONFLY ON AN EXISTING DRAGONFLY SYSTEM           +
483 +         UPDATING FROM PRE-1.2 SYSTEMS OR FreeBSD 4.x TO               +
484 +         DRAGONFLY 1.3+ (EITHER PREVIEW or HEAD)                       +
485 +-----------------------------------------------------------------------+
486
487 The compatibility shims for the build environment have been removed, you
488 have to update to DragonFly 1.2 release branch first.
489
490 The default PAM configuration has moved from /etc/pam.conf to /etc/pam.d/.
491 The existing configuration can be converted using /etc/pam.d/convert.sh.
492 Entries in /etc/pam.d/ override entries in /etc/pam.conf. In addition
493 the pam_skey.so module was retired, you have to remove it manually from
494 your configuration, when you convert it.
495
496 > Required user and group IDs when upgrading from either FreeBSD or DragonFly
497 ---------------------
498
499 The following users may be missing from your password file.  Use vipw and
500 add any that are missing:
501
502 smmsp:*:25:25::0:0:Sendmail Submission User:/var/spool/clientmqueue:/sbin/nologin
503 _pflogd:*:64:64::0:0:pflogd privsep user:/var/empty:/sbin/nologin
504
505 The following groups may be missing from your group file.  Use vi /etc/group
506 and add any that are missing:
507
508 smmsp:*:25:
509 authpf:*:63:
510 _pflogd:*:64:
511
512
513 > Upgrading to DragonFly from FreeBSD
514 ---------------------
515
516 You can build the DragonFly world and DragonFly kernels on a FreeBSD-4.x or
517 FreeBSD-5.x machine and then install DragonFly over FreeBSD, replacing
518 FreeBSD.  Note that the DragonFly buildworld target does not try to reuse
519 make depend information, it starts from scratch, so no pre-cleaning of the
520 object hierarchy is necessary.
521
522         # get the CVS repository (it is placed in /home/dcvs, 500MB).
523         # Please use the -h option and a mirror site to pull the 
524         # initial repository, but feel free to use the main repository
525         # machine to pull updates.
526         cvsup /usr/share/examples/cvsup/DragonFly-cvs-supfile
527         # install the source from the CVS hierarchy (remove preexisting
528         # FreeBSD src first) (500MB)
529         cd /usr
530         rm -rf src
531         cvs -R -d /home/dcvs checkout -P src
532
533         # build it (500MB used in /usr/obj)
534         #
535         cd /usr/src
536         make buildworld
537         make buildkernel KERNCONF=<KERNELNAME>
538
539 Once you have built DragonFly you have to install it over FreeBSD.  Since
540 DragonFly does not track changes made by FreeBSD to its include file 
541 hierarchy and include file pollution can cause all sorts of unexpected
542 compilation issues to come up, it is best to wipe your include hierarchy
543 prior to installing DragonFly.  Note that you should not wipe any installed
544 FreeBSD header files or binaries until after you have successfully completed
545 the build steps above.
546
547         rm -rf /usr/include
548         mkdir /usr/include
549         make installkernel KERNCONF=<KERNELNAME>
550         make installworld
551
552 Then you need to upgrade your system.  DragonFly's 'make upgrade' target 
553 will unconditionally upgrade the /etc files that sysops do not usually
554 mess around with, such as the files in /etc/rc.d.  It will also remove any
555 obsolete files such as utilities and manpages that have been removed from
556 the system since the version you're coming from.  If you are unsure we 
557 recommend that you make a backup of at least your /etc before applying
558 this step.  Note that DragonFly's RC system is basically RCNG from
559 FreeBSD-5, but there are some differences in the contents of the RC files.
560
561         make upgrade
562
563 NOTE! Never do a 'make upgrade' before 'make installworld' has been run.
564 Doing so might leave your system in an unusable state.
565
566 Finally we recommend that you do an 'ls -lta BLAH' for /bin, /sbin, /usr/bin,
567 /usr/bin, and /usr/lib, and remove any stale files that you find.  Please
568 report these files to the DragonFly developers so that they can be added to
569 the 'upgrade' target.
570