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