UPDATING revision 1.361 1 $NetBSD: UPDATING,v 1.361 2024/10/16 09:26:39 martin Exp $
2
3 This file (UPDATING) is intended to be a brief reference to recent
4 changes that might cause problems in the build process, and a guide for
5 what to do if something doesn't work.
6
7 For a more detailed description of the recommended way to build NetBSD
8 using build.sh, see the BUILDING file.
9
10 Note that much of the advice in this UPDATING file was written before
11 build.sh existed. Nevertheless, the advice here may be useful for
12 working around specific problems with build.sh.
13
14 Sections are marked with "^^^^^". After the section on "Recent changes"
15 are several sections containing more general information.
16
17 See also: BUILDING, build.sh, Makefile.
18
19 Recent changes:
20 ^^^^^^^^^^^^^^^
21
22 20241015:
23 OpenSSL symbol changes require a full rebuild of all libs
24 and all binaries linked against libcrypto. Recommended
25 workaround is a clean build or removing the $OBJ directory
26 completely.
27
28 20240926:
29 Building -current when running on amd64 from about 20240924
30 to about 20240926 will not work due to a "malloc_np.h"
31 error. Please downgrade to a version from 20240924 or older,
32 or upgrade to a newer version e.g. using a binary release from
33 the NetBSD build servers.
34
35 20240923:
36 Update builds will require cleaning the object directories for
37 jemalloc (like: "rm -rf $OBJ/external/bsd/jemalloc*") and the
38 libc dependency files (like: "rm $OBJ/lib/libc/jemalloc.*").
39 On architectures with COMPAT libs, those also have to be cleaned,
40 e.g. on sparc64: "rm -rf $OBJ/compat/sparc64/sparc/external/bsd/jemalloc*"
41 and "rm $OBJ/compat/sparc64/sparc/lib/libc/jemalloc.*".
42
43 20240817:
44 Update builds will require cleaning in src/external/historical/nawk/bin
45 in order to remove the awk binary since now there is a subdirectory
46 called awk.
47
48 20240812:
49 Update builds will require removing the tools objdir for gdb
50 if building with MKCROSSGDB=yes. All architectures use gdb.old
51 now.
52
53 20240630:
54 Update builds will require removing the tools objdir for binutils
55 (as most architectures should use binutils.old now).
56
57 20240610:
58 Update builds are likely to require removing the objdir for
59 distrib/<arch>/cdroms - or at least references to libarchive
60 from within there after the recent libarchive update.
61
62 20240504:
63 Update builds on x86 require making the `cleandir' target in
64 lib/libm, or deleting the objdir for lib/libm.
65
66 20240423:
67 Update builds with x11 may fail after switching to Mesa 21.
68
69 20240410:
70 Update builds may require manually deleting
71 $DESTDIR/var/run/named (and, potentially,
72 $DESTDIR/var/run/lwresd) in order to avoid checkflist failure.
73
74 20240409:
75 32-bit compatibility libraries were moved into the base32
76 and debug32 sets. HTML man pages were moved into the manhtml set.
77
78 20230828:
79 If:
80 - you updated to current and ran postinstall between 20230826
81 and 20230828 inclusive, and
82 - you are not using anything outside the base system to
83 populate /etc/openssl/certs (e.g., manually adding
84 certificates or using ca-certificates or mozilla-rootcerts or
85 mozilla-rootcerts-openssl from pkgsrc),
86 delete /etc/openssl/certs and rerun postinstall or just
87 `certctl rehash'.
88
89 Otherwise, certctl(8) will think someone else has left
90 /etc/openssl/certs in the way and will avoid clobbering it on
91 upgrade from older NetBSD.
92
93 20230718:
94 build.sh will use mk.conf in the same directory as build.sh instead
95 of /etc/mk.conf, unless MAKECONF is already defined in the environment.
96
97 20230714:
98 Import of gcc 10.5 requires a clean build of at least tools/gcc
99 and external/gpl3/gcc* object directories. An update build
100 without cleaning will result in obscure failures in rare corner
101 cases.
102
103 20230604:
104 Building native kernels with the installed make(1) instead of
105 the $TOOLDIR/bin/nbmake-${arch} wrapper will fail if userland
106 has not been updated. Note that this is an unsupported build
107 configuration (but usually works if userland is -current enough).
108
109 20230523:
110 ctfmerge was fixed as macOS host tool. This may require a clean tools
111 rebuild to detect the update to tools/compat/configure.
112
113 20230515:
114 New openssl build requires removal of the crypto/external/bsd/openssl
115 and tests/crypto/libcrypto subdirectories in the ${OBJDIR} hierarchy.
116 Otherwise test results may be wrong due to wrong "golden" output
117 files being installed.
118
119 20230322:
120 Fixes for moved /lib/libisns* mean that builds will complain about
121 ./usr/lib/libisns* being missing until src/lib/libisns is forced
122 to (re)install the files, including the symlinks. The simplest
123 way is to clean this subdir before building.
124
125 20230112:
126 New binutils require an updated ld.elf_so. If you are doing
127 (unsupported) in-place self builds (with the -E flag to build.sh),
128 make sure to have installed latest ld.elf_so before you rebuild
129 userland.
130
131 20221116:
132 The addition to NetBSD's version of UFS2 of support for extended
133 attributes broke backward compatibility with previous releases
134 of NetBSD, so UFS2 has been restored to being compatible with
135 previous NetBSD releases by disabling extended attributes.
136 (Note that ACLs are implemented as extended attributes, so
137 this changes disables ACLs as well.)
138
139 Support for UFS2 with extended attributes is now available in a new
140 UFS variant called UFS2ea. If you have created extended attributes
141 in an original UFS2 file system then "fsck -p" will now fail due to
142 the unexpected presence of extended attributes and "fsck -y" will
143 remove all extended attributes. If you wish to preserve extended
144 attributes rather than delete them, there is a utility to convert
145 a UFS2 file system to UFS2ea and leave extended attributes in place,
146 but this should be used with caution since it will preserve any
147 extended attributes that have been corrupted by the backward
148 incompatibility too.
149
150 If you wish to use a UFS2ea file system as your root file system,
151 then you will need to update your boot loader to a version that
152 supports UFS2ea.
153
154 For more information, see:
155 https://wiki.netbsd.org/features/UFS2ea
156
157 20221111:
158 The new libdrm import worsened the conflict issues for the
159 kdump/ktruss ioctl, and i915 now conflicts with base, and has
160 been turned off. This will cause update build issues like:
161
162 kdump-ioctl.c:12175:143: error: 'DRM_IOCTL_I915_DESTROY_HEAP'
163 undeclared here (not in a function);
164 did you mean 'DRM_IOCTL_MODE_DESTROY_DUMB'?
165
166 You'll need to clean usr.bin/ktruss, usr.bin/kdump, and rescue.
167
168 20220921:
169 Since the kernel version was bumped to 9.99.100, the bootloader
170 must be updated on x86 or EFI boot platforms in order to load
171 modules from boot.cfg(5) or interactively at the bootloader
172 prompt.
173
174 The kernel can still load modules at runtime, with modload(8)
175 or modules.conf(5), with no bootloader update. This will not
176 affect release branches because it only applies to patch
177 numbers >=100.
178
179 On x86 (i386 or amd64) with BIOS boot, this requires copying a
180 new /usr/mdec/boot to /boot. You can build this in the destdir
181 by running `$TOOLDIR/bin/nbmake-$ARCH dependall install' in
182 sys/arch/i386/stand.
183
184 On platforms with EFI boot (including x86 with EFI boot), this
185 requires copying a new /usr/mdec/boot*.efi to the EFI/BOOT/
186 directory on the EFI system partition. The boot*.efi file is:
187
188 aarch64 bootaa64.efi
189 amd64 bootx64.efi
190 arm bootarm.efi (32-bit arm)
191 i386 bootx32.efi
192
193 You can build this in the destdir by running
194 `$TOOLDIR/bin/nbmake-$ARCH dependall install' in
195 sys/stand/efiboot/boot*.
196
197 20220821:
198 Support for building extsrc/ has been deprecated.
199 EXTSRCSRCDIR and MKEXTSRC have been deprecated.
200
201 20220714:
202 Updates to xorg-server and associated drivers may cause builds to
203 fail. Cleaning both DESTDIR and the xorg build tree may be needed.
204
205 20220628:
206 Changes in the build of src/games/robots require a clean build
207 of that program.
208
209 20211116:
210 Changes in the xorg build require clean obj dirs for external/mit/xorg
211 (or a full clean/non-update build).
212
213 20211112:
214 Device tree sources were updated for evbarm. Some device nodes
215 (in particular, ld(4) devices on the ROCKPro64) will be renumbered.
216
217 20211014:
218 MKPIE default for aarch64 has changed, a clean build is required.
219
220 20210917:
221 Changed MNT_ACLS to default to POSIX1e ACLs instead of NFSv4
222 ACLs, to be compatible with FreeBSD. If you are using NFSv4 ACLs
223 and have "acls" in /etc/fstab you'll need to change it to "nfs4acls".
224
225 20210711:
226 Updated GMP sources may require cleaning in tools/gmp and/or in
227 external/lgpl3/gmp/lib, particularly if GCC itself does not build.
228
229 20210417:
230 GCC 10 was enabled for several platforms. If builds fail in either
231 tools/gcc or external/gpl3/gcc, first try cleaning those objects and
232 removing the $DESTDIR/usr/include/g++ subdirectory.
233
234 20201016:
235 MIPS kernel modules have been disabled until they work. This will
236 turn up in extra files in the DESTDIR, which should be cleaned.
237
238 20200925:
239 GNU MPC and MPFR have been updated. At least MPFR needs cleaning
240 in both the tools and external dirs.
241
242 20200912:
243 GCC 9 has arrived for Arm and x86 platforms, and will be coming
244 for several more, as will binutils 2.34. Clean as required.
245
246 20200907:
247 GCC 9 is coming, and binutils has been updated for MIPS. This
248 probably requires cleaning the tools/binutils.
249
250 20200811:
251 GCC updates may require cleaning the objdir. This may occur
252 due to GCC 7.5 update, GCC 8.4 move to gcc.old, or the upcoming
253 GCC 9 upgrade.
254
255 20200614:
256 blacklist* has been renamed to blocklist*. postinstall(8)
257 should handle the migration.
258
259 20200601:
260 Due to a mistake in LIBISPRIVATE handling, .so libraries were
261 created in the build directories and need cleaning.
262
263 20200311:
264 GCC 8 ports will need cleaning in src/tools/gcc and
265 src/external/gpl3/gcc due to GCC 8.4 update.
266
267 20191118:
268 More architectures were switched to gcc8:
269 i386, ia64 powerpc64, sparc, sparc64, arm
270 The same comments as in 20191022 apply.
271
272 20191112:
273 The LLVM update requires a clean rebuild for all architectures using
274 LLVM during the tools build phase (i386, amd64, aarch64).
275
276 20191022:
277 Ports amd64 and aarch64 switched to GCC 8.3 by default.
278 In-place ("expert mode", build.sh -E) builds are not supported
279 when going from a GCC 7 userland to GCC 8. Do a regular
280 build to a different DESTDIR (or preferably: build.sh -U) at least
281 once and install sets, or download comp.{tar.xz,tgz} from the
282 daily builds and install that before doing the next in-place build.
283
284 20191001:
285 GCC 8.3 was imported. Builds of src/tools/gcc may fail if
286 old builds with GCC 7 output now uses GCC 8. Clean this
287 directory, and also clean src/external/gpl3/gcc.
288
289 20190903:
290 Files with names that coincide with existing files' names on
291 case-insensitive file systems were inadvertently committed, for
292 radeon GPU firmware. We cannot mark these as obsolete for
293 postinstall to fix, so if you updated src since 2019-08-26, and
294 ran build.sh distribution or ran build.sh release, you must
295 manually delete the following files in your DESTDIR (which is
296 usually $OBJDIR/destir.$ARCH), or from / if you have installed
297 them:
298
299 /libdata/firmware/radeon/bonaire_ce.bin
300 /libdata/firmware/radeon/bonaire_mc.bin
301 /libdata/firmware/radeon/bonaire_me.bin
302 /libdata/firmware/radeon/bonaire_mec.bin
303 /libdata/firmware/radeon/bonaire_pfp.bin
304 /libdata/firmware/radeon/bonaire_rlc.bin
305 /libdata/firmware/radeon/bonaire_sdma.bin
306 /libdata/firmware/radeon/bonaire_smc.bin
307 /libdata/firmware/radeon/bonaire_uvd.bin
308 /libdata/firmware/radeon/hainan_ce.bin
309 /libdata/firmware/radeon/hainan_mc.bin
310 /libdata/firmware/radeon/hainan_me.bin
311 /libdata/firmware/radeon/hainan_pfp.bin
312 /libdata/firmware/radeon/hainan_rlc.bin
313 /libdata/firmware/radeon/hainan_smc.bin
314 /libdata/firmware/radeon/hawaii_ce.bin
315 /libdata/firmware/radeon/hawaii_mc.bin
316 /libdata/firmware/radeon/hawaii_me.bin
317 /libdata/firmware/radeon/hawaii_mec.bin
318 /libdata/firmware/radeon/hawaii_pfp.bin
319 /libdata/firmware/radeon/hawaii_rlc.bin
320 /libdata/firmware/radeon/hawaii_sdma.bin
321 /libdata/firmware/radeon/hawaii_smc.bin
322 /libdata/firmware/radeon/kabini_ce.bin
323 /libdata/firmware/radeon/kabini_me.bin
324 /libdata/firmware/radeon/kabini_mec.bin
325 /libdata/firmware/radeon/kabini_pfp.bin
326 /libdata/firmware/radeon/kabini_rlc.bin
327 /libdata/firmware/radeon/kabini_sdma.bin
328 /libdata/firmware/radeon/kaveri_ce.bin
329 /libdata/firmware/radeon/kaveri_me.bin
330 /libdata/firmware/radeon/kaveri_mec.bin
331 /libdata/firmware/radeon/kaveri_mec2.bin
332 /libdata/firmware/radeon/kaveri_pfp.bin
333 /libdata/firmware/radeon/kaveri_rlc.bin
334 /libdata/firmware/radeon/kaveri_sdma.bin
335 /libdata/firmware/radeon/mullins_ce.bin
336 /libdata/firmware/radeon/mullins_me.bin
337 /libdata/firmware/radeon/mullins_mec.bin
338 /libdata/firmware/radeon/mullins_pfp.bin
339 /libdata/firmware/radeon/mullins_rlc.bin
340 /libdata/firmware/radeon/mullins_sdma.bin
341 /libdata/firmware/radeon/oland_ce.bin
342 /libdata/firmware/radeon/oland_mc.bin
343 /libdata/firmware/radeon/oland_me.bin
344 /libdata/firmware/radeon/oland_pfp.bin
345 /libdata/firmware/radeon/oland_rlc.bin
346 /libdata/firmware/radeon/oland_smc.bin
347 /libdata/firmware/radeon/pitcairn_ce.bin
348 /libdata/firmware/radeon/pitcairn_mc.bin
349 /libdata/firmware/radeon/pitcairn_me.bin
350 /libdata/firmware/radeon/pitcairn_pfp.bin
351 /libdata/firmware/radeon/pitcairn_rlc.bin
352 /libdata/firmware/radeon/pitcairn_smc.bin
353 /libdata/firmware/radeon/tahiti_ce.bin
354 /libdata/firmware/radeon/tahiti_mc.bin
355 /libdata/firmware/radeon/tahiti_me.bin
356 /libdata/firmware/radeon/tahiti_pfp.bin
357 /libdata/firmware/radeon/tahiti_rlc.bin
358 /libdata/firmware/radeon/tahiti_smc.bin
359 /libdata/firmware/radeon/verde_ce.bin
360 /libdata/firmware/radeon/verde_mc.bin
361 /libdata/firmware/radeon/verde_me.bin
362 /libdata/firmware/radeon/verde_pfp.bin
363 /libdata/firmware/radeon/verde_rlc.bin
364 /libdata/firmware/radeon/verde_smc.bin
365
366 We will re-import these radeon firmware images another way
367 later.
368
369 20190727:
370 The uefi bootloader has gained tftp support and needs a clean
371 build. If you do update builds, manually clean its object
372 directory by something like:
373 cd sys/arch/i386/stand/efiboot && make clean
374
375 20190723:
376 The jemalloc allocator in libc is now built without extended
377 debugging (for performance reasons). In update builds make sure
378 to rebuild it completely, by removing all affected object files,
379 including compat builds, something like:
380 cd /usr/obj && find . -type d -name jemalloc|xargs rm -rf
381
382 20190207:
383 GCC 7 switched for many ports. Update builds are likely to fail.
384
385 Hints for a more successful build:
386 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
387 Use build.sh, but do not use its "expert mode":
388 This will automatically build the tools in the
389 correct order, and it will keep the tools and the
390 new build products from interfering with the running
391 system. This will allow you to ignore most of the
392 other advice in this file.
393 Build a new kernel first:
394 This makes sure that any new system calls or features
395 expected by the new userland will be present. This
396 helps to avoid critical errors when upgrading.
397 Use object directories:
398 This helps to keep stale object
399 files from polluting the build if a Makefile "forgets"
400 about one. It also makes it easier to clean up after
401 a build. It's also necessary if you want to use the
402 same source tree for multiple machines.
403 To use object directories with build.sh:
404 a) invoke build.sh with the "-M" or "-O" options.
405 To use object directories without using build.sh:
406 a) cd /usr/src ; make cleandir
407 b) Add "OBJMACHINE=yes" to /etc/mk.conf
408 c) Add "MKOBJDIRS=yes" to /etc/mk.conf
409 d) cd /usr/src ; make build
410 Note that running "make obj" in a directory will create
411 in obj.$MACHINE directory.
412 Build to a DESTDIR:
413 This helps to keep old installed files (especially libraries)
414 from interfering with the new build.
415 To build to a DESTDIR with build.sh, use the "-D" option.
416 To build to a DESTDIR without using build.sh, set the DESTDIR
417 environment variable before running make build. It should be
418 set to the pathname of an initially empty directory.
419 Problems: if you do not use build.sh, you might need to
420 update critical utilities without using DESTDIR since
421 nothing is executed from what is installed in DESTDIR.
422 (See critical utils, below.)
423 Build often:
424 This keeps critical utilities current enough to not choke
425 on any other part of the source tree that depends on up to
426 date functionality. If you use build.sh, you should not have
427 this problem.
428
429 What to do if things don't work:
430 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
431 When things don't work there are usually a few things that commonly
432 should be done.
433 1) make includes
434 This should be done automatically by make build.
435 2) cd share/mk && make install
436 Again, automatically done by make build.
437
438 Failsafe rebuild of a small part of the tree:
439 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
440 To make sure you rebuild something correctly you want to do
441 something like the following:
442 1) Make sure the includes and .mk files are up to date.
443 2) Make sure any program used to build the particular
444 utility is up to date. (yacc, lex, etc...)
445 3) cd ...path/to/util...
446 make cleandir
447 rm ...all obj directories...
448 make cleandir # yes, again
449 make obj
450 make depend && make
451
452 Failsafe rebuild of the entire tree:
453 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
454 If you really want to make sure the source tree is clean and
455 ready for a build try the following. Note that sourcing /etc/mk.conf
456 (a make(1) Makefile) in this manner is not right, and will not work
457 for anyone who uses any make(1) features in /etc/mk.conf.
458
459 ---cut here---
460 #!/bin/sh
461 . /etc/mk.conf
462
463 if [ -z $NETBSDSRCDIR ] ; then
464 NETBSDSRCDIR=/usr/src
465 fi
466 if [ \! -d $NETBSDSRCDIR ] ; then
467 echo Unable to find sources
468 exit 1
469 fi
470 find $NETBSDSRCDIR -name \*.o -o -name obj.\* -o -name obj -exec rm \{\} \;
471
472 if [ -z $BSDOBJDIR ] ; then
473 BSDOBJDIR=/usr/obj
474 fi
475 if [ -d $BSDOBJDIR ] ; then
476 rm -rf $BSDOBJDIR
477 fi
478
479 cd $NETBSDSRCDIR && make cleandir
480
481 ---cut here---
482
483 Critical utilities:
484 ^^^^^^^^^^^^^^^^^^^
485 usr.bin/make
486 usr.bin/yacc
487 usr.bin/lex
488 usr.bin/xlint
489 usr.bin/config
490
491 Other problems and possible solutions:
492 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
493 Symptom:Complaints involving a Makefile.
494 Fix: Rebuild usr.bin/make:
495 cd usr.bin/make && make && make install
496 Or, a failsafe method if that doesn't work:
497 cd usr.bin/make && cc -DMAKE_NATIVE *.c -I. -o make \
498 && install make /usr/bin
499
500 Fix: Make sure .mk files are up to date.
501 cd share/mk && make install
502
503 Symptom:Kernel `config' fails to configure any kernel, including GENERIC.
504 Fix: Rebuild usr.bin/config
505
506 Symptom:Obsolete intermediate files are used during compilation
507 Fix: Try the following sequence of commands in the directory in question.
508 make cleandir; rm `make print-objdir`; make cleandir; make obj
509 (If you built the tree without "make obj" in the past, obsolete files
510 may remain. The command tries to clean everything up)
511
512 Symptom:.../sysinst/run.c:xx: warning: initialization from incompatible
513 pointer type
514 Fix: Rebuild and install usr.bin/menuc
515
516 Symptom:mklocale not found during build in share/locale/ctype
517 Fix: Build and install usr.bin/mklocale
518
519 Symptom:undefined reference to `__assert13' or `__unsetenv13'
520 Fix: Rebuild and install lib/libc
521
522 Symptom:usr.bin/config fails to build.
523 Fix: Try building with -DMAKE_BOOTSTRAP added to CFLAGS in Makefile.
524
525 Symptom:undefined reference to `getprogname' or `setprogname'
526 Fix: Rebuild and install lib/libc
527
528 Symptom:Update build fails in src/tools/gcc complaining that a variable
529 (e.g. CPPFLAGS) has changed since the previous run.
530 Fix: Run "nbmake-${ARCH} clean" in src/tools/gcc or do a clean build.
531
532 Symptom:cvs [update aborted]: cannot open directory /cvsroot/src/...:
533 No such file or directory.
534 Cause: If a directory is created by mistake, then it is sometimes
535 deleted from the CVS repository using administrative commands
536 that bypass the normal cvs access controls. If your cvs working tree
537 contains references to a directory that has been deleted on the
538 server in this way, then "cvs update" reports this error.
539 Fix: Recursively delete the affected directory from your working tree
540 and try the update again.
541