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