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