xref: /netbsd-src/UPDATING (revision a7e090f70e491979434963c9a27df4020fe0a18b)
1$NetBSD: UPDATING,v 1.209 2010/02/22 12:35:32 njoly Exp $
2
3This file (UPDATING) is intended to be a brief reference to recent
4changes that might cause problems in the build process, and a guide for
5what to do if something doesn't work.
6
7For a more detailed description of the recommended way to build NetBSD
8using build.sh, see the BUILDING file.
9
10Note that much of the advice in this UPDATING file was written before
11build.sh existed.  Nevertheless, the advice here may be useful for
12working around specific problems with build.sh.
13
14See also: BUILDING, build.sh, Makefile.
15
16Recent changes:
17^^^^^^^^^^^^^^^
18
1920100222:
20	The shared objects file extension has been changed from .so to
21	.pico, in order to avoid conflicts with shared libraries names
22	libXX.so.  All now stale regular .so files can be removed from
23	your object directories.
24
2520100204:
26	The termcap database has been removed from the sources,
27	but has not been marked obsolete so it is not removed
28	from the system when upgrading.
29	As such, you will need to remove them from your object
30	and destination directories.
31
3220091101:
33        After updating, it may be necessary to make the 'cleandir'
34        target in src/tools/yacc/ and in src/usr.bin/yacc/ before a
35        'build.sh -u tools' or 'build.sh -u distribution'.  Ditto
36        src/tools/lex/ and src/usr.bin/lex/.
37
3820091001:
39	On amd64 you must rebuild tools (to get the new binutils)
40	before building a kernel, or the build fails on cpufunc.S.
41
4220091001:
43	An error will create a ./usr/X11R7/lib/X11/xkb/compiled/xkb
44	symlink, failing the build.  Delete the link, and the subdir
45	it is in, and retry your build.
46
4720090718:
48	libc build changed so that strchr() provides the extra entry
49	point for index(). Update build of libc.a (and libc_pic.a)
50	may fail because the archive contains the unwanted index.o.
51	(Similarly for strrchr() and rindex().)
52
5320090709:
54	Native Xorg was upgraded again.  Builds will probably fail again
55	without a clean objdir, at least for src/external/mit/xorg.
56
5720090616:
58	Native Xorg was upgraded.  Builds will need a clean objdir for
59	src/external/mit/xorg.  Upgrading a system from sets will not
60	work properly yet as the /usr/X11R7/lib/X11/xkb/symbols/pc
61	subdirectory has been changed into a file, and this needs to
62	be manually "rm -r"'ed before installing xbase.tgz.
63
6420090501:
65	Several new functions were added to string.h/libc, and this
66	can cause autoconf problems during the tool build for people
67	who fail to clean out their tools objects properly. If you
68	note messages about stpcpy, stpncpy or strnlen accompanying a
69	failure during the tool build, clean out all your tools
70	objects and start again.
71
7220090325:
73	The i386 port was switched to i486 default toolchain.  This requires
74	cleaning your src/tools directory and $TOOLDIR and rebuilding them.
75
7620090126:
77	The __posix_fadvise50 system call changed assembly stub type. You
78	need to 'rm -f __posix_fadvise50.*' in the libc build directory
79	to avoid using the old assembly stub.
80
8120090202:
82	pkg_install now depends on the pkgdb cache for automatic conflict
83	detection.  It is recommented to rebuild the cache with
84	``pkg_admin rebuild''.
85
8620090110:
87	time_t and dev_t have been bumped to 64 bit quantities. To upgrade:
88	1. Make sure your kernel has COMPAT_50 in it. Build and install.
89	   This is needed even in the MODULAR kernel because there is
90	   conditionally compiled code in rtsock.c.
91	2. make sure build.sh completes and the binaries in a chroot work
92	   before installing.
93	3. If you don't use build.sh and you build directly to root, and
94	   your build breaks in the middle, don't despair. Make sure headers
95	   are installed properly, and start building libraries first libc
96	   and libutil, install them and then continue building all the
97	   libraries in src/lib and src/gnu/lib and install them. Once
98	   the new libraries are installed, you can restart the build.
99	4. If you compile packages and you notice link time warnings,
100	   rebuild the required packages to update their shared libraries.
101	   Any package you rebuild will require rebuilding all the packages
102	   that depend on it.
103	5. Next time you run pwd_mkdb with the new binary, the file
104	   will be upgraded and it will not be backwards compatible.
105	6. The utmpx/wtmpx files (/var/run/utmpx and /var/log/wtmpx, see
106	   lastlogx(5)) have been versioned, and there is a heuristic
107	   for utmp. You are better off removing the old files after
108	   upgrading.  The automated clearing of /var/run during
109	   boot, and the automated rotating of files in /var/log by
110	   newsyslog(8), may mean that you do not have to remove the
111	   files manually.
112	7. The optional accounting file (/var/account/acct, see
113	   accton(8)) has not been versioned, and will need to be
114	   removed.  The automatic rotation of the accounting file by
115	   /etc/daily limits the bad consequences of failure to remove
116	   the file.
117	8. Application software that writes time_t to binary files on
118	   disk will break or need attention. Most notably: if you are
119	   using PostgreSQL < 8.4, you need to dump your databases,
120	   rebuild PostgreSQL with the new time_t, then restore.
121
12220081219:
123	config(1) has been updated, and one of the files it creates -
124	swapnetbsd.o - has changed format.  You need to rebuild config
125	(done automatically by build.sh) and then you need to rerun
126	config on all kernel configuration files before rebuilding those
127	kernels.
128
12920081205:
130	If you build with MKX11=no, you should remove /etc/rc.d/xdm and
131	/etc/rc.d/xfs from DESTDIR because those files were moved to the xetc
132	set and will appear as extra files for MKX11=no update builds.
133
13420081122:
135	On i386, various kernel options(4) in GENERIC including
136	file systems have been disabled and moved into kernel modules.
137	Before trying a new GENERIC kernel, you have to prepare the
138	following files as well as a new GENERIC kernel:
139
140	- build and install kernel modules from src/sys/modules
141
142	- install the latest bootloader, which will load a module
143	  for the file system from which the kernel is loaded automatically
144
145	If you have to load your kernel from a file system which is not of
146	the same type as the root file system, you have to load the necessary
147	file system module manually on the boot prompt or in the boot.cfg file.
148
14920080827:
150	If you built and installed a libc from sources between
151	2008/08/20 and 2008/08/26 you got a broken strtouq(3)
152	which results in false errors reported by lint(1).
153	Since this breaks the libc build itself, manual help is
154	needed -- lint must be disabled temporarily, e.g.:
155	  $ (cd lib/libc && make MKLINT=no dependall install)
156
15720080813:
158	MKDEBUG build was broken because the .depend files did not know
159	about .go files. You need to remove all .depend files and rebuild.
160
16120080802:
162	A regression in binary compatibility for pthread_mutex_t has
163	been fixed. Unfortunately, the price is breaking compatibility
164	for -current.
165
166	Threaded programs (using libpthread) and C++ programs (using
167	libstdc++) compiled after 20070907 and before 20080802 need to
168	be recompiled.
169
170	One way to find affected pkgsrc packages:
171
172	  $ grep REQUIRES=/usr/lib/libpthread /var/db/pkg/*/+BUILD_INFO
173	  $ grep REQUIRES=/usr/lib/libstdc++ /var/db/pkg/*/+BUILD_INFO
174
17520080731:
176	WAPBL (metadata journaling support) has been added, but at this
177	time isn't backwards compatible with pre-WAPBL aware kernels
178	and userland (fsck_ffs in particular).  Please make sure you
179	don't use a journaled filesystem with an older kernel/userland,
180	especially an uncleanly mounted journaled filesystem.  WAPBL
181	also requires the super block to be in the UFS2 format.  You
182	can use fsck_ffs -c 4 to update the superblock format.
183
18420080721:
185	Assembler warnings are now fatal if $WARNS>0 and $NOGCCERROR
186	isn't defined.
187
18820080531:
189	The ioctl number of DRVSUSPENDDEV command on /dev/drvctl changed
190	from 125 (conflicted with DRVCTLCOMMAND) to 129. The drvctl(8)
191	utility needs to be rebuilt and reinstalled as older binaries
192	won't work correctly. The following sequence of commands:
193
194	  $ (cd sys/sys/ && nbmake-$arch includes)
195	  $ (cd sbin/drvctl/ && nbmake-$arch clean)
196	  $ (cd sbin/drvctl/ && nbmake-$arch all)
197
198	leaves new drvctl utility in sbin/drvctl build directory.
199
20020080503:
201	The <bsd.lib.mk> variable MKPRIVATELIB was renamed to LIBISPRIVATE.
202
20320080521:
204	For a while, unprivileged UPDATE builds would fail to
205	succeed at the checkflist stage, complaining that
206	${DESTDIR}/stand/<arch>/ did not exist.  A fix for this
207	problem was committed to share/mk/bsd.kmodule.mk, revision 1.9.
208	If you already hit this problem, update the .mk file,
209	remove ${DESTDIR}/stand/<arch>, and re-run the build.
210
21120080303:
212	Linker warnings are now fatal if $WARNS>0.
213
21420080126:
215	The posix_fadvise system call has been changed from an assembly
216	stub, to a c file that calls an assembly stub. You need to
217	'rm -f posix_fadvise.* .depend' in the libc build directory to
218	avoid using the old assembly stub.
219
22020071209:
221	The acpiec(4) driver has been split into two attachments. If you
222	get ACPI errors before the attachment, please update your kernel
223	configuration file appropriately or see GENERIC for more details.
224
22520071115:
226	The it(4) driver has been renamed to itesio(4) and the old port
227	argument specified in the kernel configuration file is not valid
228	anymore. The itesio(4) driver now uses the Super I/O address port
229	rather than the EC address port. Please update your kernel
230	configuration file appropriately or see GENERIC for more details.
231
23220071028:
233	The pccons(4) driver has been removed from the NetBSD/shark port.
234	You need to update any custom kernel configuration file you have
235	to remove any references to pccons (which includes removing the
236	now useless XSERVER option) and replace them with the correct
237	entries for the wscons driver.  See the GENERIC configuration file
238	for more details.
239
24020070913:
241	A latent bug in dhclient/dhcpd that caused it to be unable to
242	enumerate interfaces was fixed.  The bug began to cause
243	problems after 20070911 when the kernel's SIOCGIFCONF
244	implementation was repaired.  From 20070529 to 20070911 racoon
245	could not enumerate interfaces.  (These are noted because
246	normal kernel/userspace version matching hygiene is not
247	sufficient to avoid this problem.)  Ensure that both kernel
248	and userland are from after 20070913.
249
25020070703:
251	nbinstall has been renamed ${MACHINE_GNU_ARCH}-install. It
252	calls the target-specific strip program, and the logic to pass
253	down STRIP from make has been removed.  This requires a
254	re-installation of tools.
255
25620070422:
257	The way OS emulations lookup filenames inside the emulation root
258	has been changed.  Rather than modify the pathname (and copy back
259	to userspace) namei() and lookup() directly check the emulation
260	root. One side effect is that absolute symlinks inside the emulated
261	root file system will be relative to that file system - unless they
262	start /../ this is useful when the emulated root is a real install
263	that has such links.
264	This might affect symlinks that have been added to reference outside
265	the emulated root.
266
26720070412:
268	The pckbc driver on sgimips IP32 has been removed. Use macekbc
269	instead. See the GENERIC32_IP3x kernel configuration for an
270	example.
271
27220070319:
273        src/lib/libc/Makefile revision 1.129 broke libc and ld.elf_so
274        on many platforms due to incorrect flags settings.  If you
275        updated and built after about 20070315, do "nbmake-$arch
276	cleandir" in src/lib/libc and src/libexec/ld.elf_so to force a
277	rebuild of object files that might have been built
278	incorrectly, and ensure that you have at least
279	src/lib/libc/Makefile 1.130.
280
28120070210:
282        src/sys/sys/{sa.h,savar.h} were removed.
283          find ${OBJDIR} \( -name .depend -o -name '*.d' \) -print \
284              | xargs egrep -l '/sa.h|/savar.h' | xargs rm
285        will allow dependencies on those files to get get rebuilt
286
28720070209:
288        The threading model was changed when the newlock2 branch
289        was merged to NetBSD-current.  If you boot with a new
290        kernel (version 4.99.10), then you also need a new pthread
291        library (/usr/lib/libpthread.so.0.7).  If you boot with
292        an old kernel, then you need the old pthread library
293        (/usr/lib/libpthread.so.0.6).  Provided you keep the kernel and
294        the pthread library in sync, old threaded applications should
295        continue to work with an old or new kernel.  Note that named(8)
296	is the only threaded application in the base system.
297
29820061214:
299	Following the move of string_to_flags() and flags_to_string()
300	from the bin/ls/ sources to libutil, users doing UPDATE builds
301	will need to do a "make cleandir" in
302		tools/mtree/, tools/makefs/, tools/binstall/, tools/pax/,
303		bin/pax/, bin/ls/, usr.sbin/mtree/, usr.sbin/makefs/,
304		usr.bin/xinstall/, libexec/ftpd/, rescue/, as well
305		as the installation images in distrib/
306	in order to excise stale references to the old stat_flags.h header
307	file in the ls sources -- stat_flags.h has been removed.
308
30920061108:
310	The configure script used in the src/tools/gcc compiler has been
311	changed to indicate that our libc has ssp support built-in and
312	does not depend on -lssp and -lssp-nonshared. You'll need to
313	make clean in src/tools/gcc first to rebuild the compiler.
314
31520061009:
316	The sysctl variables net.inet{,6}.tcp{,6}.newreno are no longer
317	available. Use net.inet{,6}.tcp{,6}.congctl.selected instead.
318
31920060814:
320	The vt, vidcconsole, kbd, and rpckbd drivers on acorn32 have been
321	withdrawn.  Use vidcvideo and pckbd instead.  See the GENERIC
322	kernel configuration for an example.  X servers from the last
323	few years should cope.
324
32520060703:
326	MPACPI is no more. We always configure PCI interrupts using ACPI
327	if we have an ACPI kernel. The option MPACPI_SCANPCI has been renamed
328	to ACPI_SCANPCI. Thanks to work from fvdl.
329
33020060627:
331	socket(2) has changed, and its system call has been versioned.
332	For userlands with the old version of socket(2), make sure that
333	your kernel has 'options COMPAT_30' set, or else 'bad system call'
334	errors will result.
335
336Hints for a more successful build:
337^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
338    Use build.sh, but do not use its "expert mode":
339	This will automatically build the tools in the
340	   correct order, and it will keep the tools and the
341	   new build products from interfering with the running
342	   system.  This will allow you to ignore most of the
343	   other advice in this file.
344    Build a new kernel first:
345	This makes sure that any new system calls or features
346	   expected by the new userland will be present.  This
347	   helps to avoid critical errors when upgrading.
348    Use object directories:
349	This helps to keep stale object
350	   files from polluting the build if a Makefile "forgets"
351	   about one.  It also makes it easier to clean up after
352	   a build.  It's also necessary if you want to use the
353	   same source tree for multiple machines.
354	   To use object directories with build.sh:
355	    a) invoke build.sh with the "-M" or "-O" options.
356	   To use object directories without using build.sh:
357	    a) cd /usr/src ; make cleandir
358	    b) Add "OBJMACHINE=yes" to /etc/mk.conf
359	    c) Add "MKOBJDIRS=yes" to /etc/mk.conf
360	    d) cd /usr/src ; make build
361	   Note that running "make obj" in a directory will create
362	   in obj.$MACHINE directory.
363    Build to a DESTDIR:
364	This helps to keep old installed files (especially libraries)
365	   from interfering with the new build.
366	   To build to a DESTDIR with build.sh, use the "-D" option.
367	   To build to a DESTDIR without using build.sh, set the DESTDIR
368	   environment variable before running make build.  It should be
369	   set to the pathname of an initially empty directory.
370	   Problems: if you do not use build.sh, you might need to
371		update critical utilities without using DESTDIR since
372		nothing is executed from what is installed in DESTDIR.
373		(See critical utils, below.)
374    Build often:
375	This keeps critical utilities current enough to not choke
376	on any other part of the source tree that depends on up to
377	date functionality.  If you use build.sh, you should not have
378	this problem.
379
380What to do if things don't work:
381^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
382When things don't work there is usually a few things that commonly
383should be done.
384    1)	make includes
385	This should be done automatically by make build.
386    2)  cd share/mk && make install
387	Again, automatically done by make build.
388
389Failsafe rebuild of a small part of the tree:
390^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
391To make sure you rebuild something correctly you want to do
392something like the following:
393    1)  Make sure the includes and .mk files are up to date.
394    2)  Make sure any program used to build the particular
395	utility is up to date.  (yacc, lex, etc...)
396    3)  cd ...path/to/util...
397	make cleandir
398	rm ...all obj directories...
399	make cleandir			# yes, again
400	make obj
401	make depend && make
402
403Failsafe rebuild of the entire tree:
404^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
405If you really want to make sure the source tree is clean and
406ready for a build try the following.  Note that sourcing /etc/mk.conf
407(a make(1) Makefile) in this manner is not right, and will not work
408for anyone who uses any make(1) features in /etc/mk.conf.
409
410---cut here---
411#!/bin/sh
412. /etc/mk.conf
413
414if [ -z $NETBSDSRCDIR ] ; then
415    NETBSDSRCDIR=/usr/src
416fi
417if [ \! -d $NETBSDSRCDIR ] ; then
418    echo Unable to find sources
419    exit 1
420fi
421find $NETBSDSRCDIR -name \*.o -o -name obj.\* -o -name obj -exec rm \{\} \;
422
423if [ -z $BSDOBJDIR ] ; then
424    BSDOBJDIR=/usr/obj
425fi
426if [ -d $BSDOBJDIR ] ; then
427    rm -rf $BSDOBJDIR
428fi
429
430cd $NETBSDSRCDIR && make cleandir
431
432---cut here---
433
434Critical utilities:
435^^^^^^^^^^^^^^^^^^^
436	usr.bin/compile_et
437	usr.bin/make
438	usr.bin/yacc
439	usr.bin/lex
440	usr.bin/xlint
441	usr.bin/config
442
443Other problems and possible solutions:
444^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
445Symptom:Complaints involving a Makefile.
446Fix:	Rebuild usr.bin/make:
447	cd usr.bin/make && make && make install
448	Or, a failsafe method if that doesn't work:
449	cd usr.bin/make && cc *.c */*.c -I . -o make && mv make /usr/bin
450
451Fix:	Make sure .mk files are up to date.
452	cd share/mk && make install
453
454Symptom:Kernel `config' fails to configure any kernel, including GENERIC.
455Fix:	Rebuild usr.bin/config
456
457Symptom:
458Fix:	Rebuild usr.bin/yacc
459
460Symptom:
461Fix:	Rebuild usr.bin/lex
462
463Symptom:
464Fix:	rm /usr/lib/libbfd.a
465
466Symptom:Obsolete intermediate files are used during compilation
467Fix:	Try the following sequence of commands in the directory in question.
468	make cleandir; rm `make print-objdir`; make cleandir; make obj
469	(If you built the tree without "make obj" in the past, obsolete files
470	may remain.  The command tries to clean everything up)
471
472Symptom:.../sysinst/run.c:xx: warning: initialization from incompatible
473	pointer type
474Fix:	Rebuild and install usr.bin/menuc
475
476Symptom:mklocale not found during build in share/locale/ctype
477Fix:	Build and install usr.bin/mklocale
478
479Symptom:undefined reference to `__assert13' or `__unsetenv13'
480Fix:    Rebuild and install lib/libc
481
482Symptom:usr.bin/config fails to build.
483Fix:	Try building with -DMAKE_BOOTSTRAP added to CFLAGS in Makefile.
484
485Symptom:undefined reference to `getprogname' or `setprogname'
486Fix:    Rebuild and install lib/libc
487
488Symptom:lint does not understand the '-X' option
489Fix:    May need to build & install libs with NOLINT=1 before rebuilding lint
490