HACKS revision 1.106
1# $NetBSD: HACKS,v 1.106 2008/07/29 14:24:06 lukem Exp $ 2# 3# This file is intended to document workarounds for currently unsolved 4# (mostly) compiler bugs. 5# 6# Format: 7# hack title 8# cdate creation date 9# mdate mod date 10# who responsible developer 11# port ... 12# affected ports, space separated, if not "all" 13# file affected file : revision : line from : line to 14# affected files and revision and line numbers describing hack 15# multiple lines if necessary. 16# pr NNNN ... 17# problem reports this hack works around, if known. Space 18# separated. 19# regress src/regress/directory/where/test/found 20# regression test directories, if available. 21# descr 22# insert short informal description (multi-line). (Longer ones 23# should be in the PR database. More formal descriptions might 24# be in the regress tree. See above). 25# kcah 26# closing bracket. 27# 28# this is a comment. 29 30hack netstat ieee1394 address printing. 31mdate 14 Nov 2000 32who matt 33file lib/libc/net/getnameinfo.c : 1.32 : 497 : 503 34descr 35 Because the current implementation of IP over IEEE1394, the 36 fw device address contains more than just the IEEE1394 EUI-64. 37 So when printing out IEEE1394 addresses, ignore the extra stuff. 38kcah 39 40hack xterm vs. libterm 41mdate 01 Aug 2000 42who jdc 43file xsrc/xc/programs/xterm/main.c : 1.2 : 3609 : 3614 44pr 10383 45descr 46 In order to extend the termcap string over 1023 bytes, a ZZ entry was 47 introduced to point to a memory location containing the full entry. 48 Without this hack, xterm will export a termcap containing the ZZ 49 entry, which will then be ignored by libterm. As xterm modifies the 50 exported termcap, this would cause those modifications to be ignored. 51kcah 52 53hack wi-at-big-endian-bus 54cdate 15 Mar 2002 55who martin 56file dev/ic/wireg.h 57descr Add an option to access the underlying bus in big endian byte order 58 to work around deficiencies in bus_space_{read,write}_* macros. 59 Those don't allow the implementation of a proper pcmcia bus space 60 tag. 61kcah 62 63hack specific knowledge of colours in curses code 64cdate Sun Apr 6 11:05:24 BST 2003 65who jdc 66file lib/libcurses/color.c : r1.24 67descr 68 Swap red/blue and yellow/cyan colours for COLOR_OTHER. 69 Fix is to enhance libtermcap to understand terminfo-style % sequences. 70 See also: 71 http://mail-index.NetBSD.org/tech-userlevel/2003/04/06/0000.html 72kcah 73 74hack Compensation for differing types of LINUX_USRSTACK and USRSTACK 75cdate 21 Aug 2003 76who he 77file sys/miscfs/procfs/procfs_linux.c : 1.14 78descr 79 Not all ports have LINUX_USRSTACK and/or USRSTACK defined as 80 literals/constants, but refer to variables of a type which is 81 not "unsigned long", causing compilation of procfs_linux.c to 82 fail with "makes integer from pointer without a cast". This 83 is observed on e.g. the sun3 port. Ideally the "types" for 84 symbols should be consistent across all ports. 85kcah 86 87hack gcc-strict-aliasing 88cdate 6 August 2004 89who junyoung 90pr 26516 91file src/usr.sbin/racoon/racoon/Makefile : 1.21 92descr 93 GCC issues a warning "dereferencing type-punned pointer will break 94 strict-aliasing rules" when compiling 95 crypto/dist/kame/racoon/crypto/openssl.c with -O[23s]. Note that this 96 is due to use of type casting in a non-standard way in the code and 97 not a compiler bug. Once a new release of KAME with a proper fix 98 applied is imported this should be backed out. 99kcah 100 101hack gcc4 wrong uninitialized variable 102mdate 10 May 2006 103who mrg 104file bin/ksh/eval.c : 1.6 105file bin/sh/histedit.c : 1.39 106file bin/sh/parser.c : 1.60 107file crypto/dist/heimdal/kdc/524.c : 1.10 108file crypto/dist/ssh/sftp.c : 1.20 109file crypto/dist/ssh/ssh-keysign.c : 1.11 110file dist/ipf/lib/hostname.c : 1.2 111file dist/ipf/tools/ipmon.c : 1.8 112file dist/ntp/ntpd/ntp_request.c : 1.4 113file dist/ntp/ntpd/refclock_shm.c : 1.4 114file dist/ntp/sntp/timing.c : 1.3 115file dist/pppd/pppstats/pppstats.c : 1.3 116file dist/smbfs/lib/smb/rap.c : 1.6 117file dist/tcpdump/print-zephyr.c : 1.5 118file distrib/utils/sysinst/aout2elf.c : 1.12 119file gnu/libexec/uucp/uucico/uucico.c : 1.6 120file lib/libc/citrus/citrus_csmapper.c : 1.6 121file lib/libc/citrus/citrus_pivot_factory.c : 1.5 122file lib/libc/inet/inet_cidr_ntop.c : 1.3 123file lib/libc/inet/inet_ntop.c : 1.3 124file lib/libc/stdio/vfwprintf.c : 1.8 125file libexec/ld.elf_so/arch/m68k/mdreloc.c : 1.20 126file libexec/ld.elf_so/arch/powerpc/ppc_reloc.c : 1.40 127file libexec/ld.elf_so/arch/sh3/mdreloc.c : 1.22 128file libexec/ld.elf_so/arch/sparc/mdreloc.c : 1.39 129file libexec/ld.elf_so/arch/sparc64/mdreloc.c : 1.39 130file libexec/ld.elf_so/arch/vax/mdreloc.c : 1.21 131file libexec/ld.elf_so/arch/x86_64/mdreloc.c : 1.27 132file sbin/fsck_ext2fs/dir.c : 1.19 133file sbin/routed/rtquery/rtquery.c : 1.18 134file sys/arch/amd64/amd64/pmap.c : 1.26 135file sys/arch/i386/pci/piixpcib.c : 1.4 136file sys/arch/m68k/m68k/pmap_motorola.c : 1.4 137file sys/crypto/cast128/cast128.c : 1.9 138file sys/ddb/db_command.c : 1.86 139file sys/dev/cardbus/cardbus_map.c : 1.21 140file sys/dev/fss.c : 1.25 141file sys/dev/ic/igsfb.c : 1.39 142file sys/dev/ic/mb86950.c : 1.5 143file sys/dev/ic/midway.c : 1.71 144file sys/dev/kttcp.c : 1.18 145file sys/dev/rasops/rasops_bitops.h : 1.9 146file sys/dev/pci/cmpci.c : 1.31 147file sys/dev/pci/machfb.c : 1.45 148file sys/dev/usb/ohci.c : 1.174 149file sys/dev/usb/uhci.c : 1.196 150file sys/dev/rasops/rasops_bitops.h : 1.9 151file sys/dist/ipf/netinet/ip_nat.c : 1.10 152file sys/dist/ipf/netinet/ip_rpcb_pxy.c : 1.8 153file sys/dist/pf/net/pf.c : 1.22 154file sys/fs/udf/udf_vnops.c : 1.4 155file sys/kern/kern_sig.c : 1.219 156file sys/kern/tty.c : 1.181 157file sys/net/bpf.c : 1.116 158file sys/net/zlib.c : 1.26 159file sys/netccitt/if_x25subr.c : 1.37 160file sys/netinet/in.c : 1.107 161file sys/netsmb/smb_smb.c : 1.27 162file sys/netsmb/smb_trantcp.c : 1.22 163file sys/nfs/nfs_serv.c : 1.108 164file sys/nfs/nfs_socket.c : 1.129 165file sys/nfs/nfs_syscalls.c : 1.91 166file sys/ufs/lfs/lfs_vfsops.c : 1.207 [also (char *)] 167file usr.bin/ftp/ftp.c : 1.140 168file usr.bin/find/function.c : 1.54 169file usr.bin/mail/tty.c : 1.20 170file usr.bin/msgc/msg_sys.def : 1.33-1.34 171file usr.bin/nl/nl.c : 1.7 172file usr.bin/systat/keyboard.c : 1.23 173file usr.bin/usbhidctl/usbhid.c : 1.29 174file usr.bin/vi/cl/cl_read.c : 1.5 175file usr.bin/vi/ex/ex_cscope.c : 1.12 176file usr.bin/vi/ex/ex_tag.c : 1.19 177file usr.bin/vi/vi/v_txt.c : 1.15 178file usr.sbin/altq/altqstat/qdisc_rio.c : 1.4 179file usr.sbin/cron/do_command.c : 1.19 180file usr.sbin/timed/timed/slave.c : 1.15 181descr 182 GCC 4.1 gets many uninitialised variable warnings wrong. We should 183 really audit all the old hacks like this when older compilers are 184 removed from the tree, as many are probably no longer required. 185 The problem is that it does not recognize initialization via function 186 call pointer. I.e. 187 int p; 188 foo(&p); 189 does not mark p as initialized. 190kcah 191 192hack gcc4 pointer sign and strict aliasing problems 193mdate 10 May 2006 194who mrg 195file bin/ed/Makefile : 1.33 196file distrib/utils/sysinst/Makefile.inc : 1.44 197file distrib/utils/x_dhclient/Makefile : 1.15 198file games/bcd/Makefile : 1.5 199file games/dab/Makefile : 1.5 200file games/larn/Makefile : 1.17 201file games/pom/Makefile : 1.5 202file lib/libasn1/Makefile : 1.26 203file lib/libcrypt/Makefile : 1.17 204file lib/libgssapi/Makefile : 1.16 205file lib/libhdb/Makefile : 1.20 206file lib/libkadm5clnt/Makefile : 1.21 207file lib/libkadm5srv/Makefile : 1.25 208file lib/libkrb5/Makefile : 1.35 209file lib/libssh/Makefile : 1.6 210file lib/libtelnet/Makefile : 1.26 211file libexec/getty/Makefile : 1.14 212file libexec/kadmind/Makefile : 1.19 213file libexec/kpasswdd/Makefile : 1.14 214file sbin/atactl/Makefile : 1.3 215file sbin/cgdconfig/Makefile : 1.7 216file sbin/clri/Makefile : 1.13 217file sbin/dkctl/Makefile : 1.4 218file sbin/dump/Makefile : 1.33 219file sbin/fdisk/Makefile : 1.35 220file sbin/fsck_ext2fs/Makefile : 1.11 221file sbin/fsck_ffs/Makefile : 1.29 222file sbin/fsdb/Makefile : 1.18 223file sbin/mount_smbfs/Makefile : 1.4 224file sbin/newfs/Makefile : 1.30 225file sbin/newfs_sysvbfs/Makefile : 1.2 226file sbin/restore/Makefile : 1.23 227file sbin/veriexecctl/Makefile : 1.11 228file sys/lib/libsa/Makefile : 1.59 229file sys/arch/evbarm/adi_brh/brh_machdep.c : 1.24 230file usr.bin/awk/Makefile : 1.9 231file usr.bin/crontab/Makefile : 1.24 232file usr.bin/ctags/Makefile : 1.8 233file usr.bin/gzip/Makefile : 1.10 234file usr.bin/ssh/sftp/Makefile : 1.10 235file usr.bin/ssh/ssh/Makefile : 1.25 236file usr.bin/vi/build/Makefile : 1.26 237file usr.bin/telnet/Makefile : 1.40 238file usr.bin/tn3270/tn3270/Makefile : 1.36 239file usr.bin/tr/Makefile : 1.4 240file usr.sbin/amd/amd/Makefile : 1.27 241file usr.sbin/amd/amq/Makefile : 1.14 242file usr.sbin/amd/libamu/Makefile : 1.20 243file usr.sbin/amd/pawd/Makefile : 1.5 244file usr.sbin/bind/Makefile.inc : 1.22 245file usr.sbin/bind/libdns/Makefile : 1.3 246file usr.sbin/bind/named/Makefile : 1.17 247file usr.sbin/bootp/bootptest/Makefile : 1.2 248file usr.sbin/chrtbl/Makefile : 1.6 249file usr.sbin/cron/Makefile : 1.12 250file usr.sbin/dhcp/Makefile.inc : 1.20 251file usr.sbin/dumplfs/Makefile : 1.11 252file usr.sbin/hprop/Makefile : 1.13 253file usr.sbin/installboot/Makefile : 1.35 254file usr.sbin/ipf/ipftest/Makefile : 1.32 255file usr.sbin/isdn/isdnd/Makefile : 1.6 256file usr.sbin/isdn/isdnmonitor/Makefile : 1.3 257file usr.sbin/isdn/isdntel/Makefile : 1.2 258file usr.sbin/isdn/isdntrace/Makefile : 126 259file usr.sbin/mopd/common/Makefile : 1.10 260file usr.sbin/mopd/mopd/Makefile : 1.9 261file usr.sbin/mopd/mopprobe/Makefile : 1.7 262file usr.sbin/makefs/Makefile : 1.17 263file usr.sbin/mscdlabel/Makefile : 1.5 264file usr.sbin/pkg_install/add/Makefile : 1.7 265file usr.sbin/pkg_install/create/Makefile : 1.5 266file usr.sbin/pkg_install/lib/Makefile : 1.28 267file usr.sbin/ntp/ntpd/Makefile : 1.10/1.11 268file usr.sbin/ntp/ntptime/Makefile : 1.4/1.5 269file usr.sbin/pppd/Makefile.inc : 1.3 270file usr.sbin/pppd/pppd/Makefile : 1.38 271file usr.sbin/rarpd/Makefile : 1.10 272file usr.sbin/rbootd/Makefile : 1.10 273file usr.sbin/rpc.pcnfsd/Makefile : 1.17 274file usr.sbin/rtadvd/Makefile : 1.9 275file usr.sbin/tcpdump/Makefile : 1.42 276file usr.sbin/wiconfig/Makefile : 1.3 277descr 278 GCC 4.1 warns on pointer sign comparision/assignments and lots of 279 code does not conform. For now we use -Wno-pointer-sign and 280 -fno-strict-aliasing. 281kcah 282 283hack cross-building hack on Darwin 284mdate 20 July 2008 285who agc 286file src/distrib/common/Makefile.mdset : 1.33 287descr 288 Darwin has problems with getopt() when used in mdsetimage -v, 289 due to the difference between BSD and libiberty() getopt 290 implementations, more fully described in 291 http://mail-index.netbsd.org/current-users/2008/06/27/msg003242.html 292 and the subsequent thread. For just now, we just have an ugly 293 workaround not to call mdsetimage with the -v argument on Darwin 294kcah 295 296port vax 297 298 hack gcc4/vax ICE 299 cdate 300 who tsutsui 301 file sys/arch/vax/conf/Makefile.vax 302 descr 303 GCC4 on vax gets ICE on compiling sys/ddb/db_command.c. 304 -fno-tree-ter prevents it so add it to COPTS. 305 kcah 306 307 hack gcc4/vax compiler crash 308 cdate Fri Jun 30 22:39:12 PDT 2006 309 who mrg 310 file bin/csh/Makefile : 1.27 311 file lib/i18n_module/UTF7/Makefile : 1.2 312 descr 313 GCC4 on vax crashes. -O0 stops it happening so far... 314 kcah 315 316 hack gcc 2.95/vax doesn't like abort being used as function pointer 317 cdate Tue Dec 13 05:54:50 GMT 2005 318 who jmc 319 file lib/libc/rpc/svc_vc.c 1.15 320 descr 321 Provide a local definition for abort which doesn't include 322 the noreturn attribute which trips up gcc 2.95 on vax. 323 kcah 324 325 hack gcc 2.95/vax doesn't have stdbool.h and gettext needs it 326 cdate Mon May 9 12:16:22 CDT 2005 327 who jmc 328 file gnu/usr.bin/gettext/Makefile.inc.prog 1.5 329 gnu/usr.bin/gettext/libgrep/Makefile 1.3 330 gnu/usr.bin/gettext/libnlspr/Makefile 1.5 331 gnu/usr.bin/gettext/libnlsut/Makefile 1.3 332 descr 333 The latest gettext assumes a C99 environment or at least 334 configure checks to work around this. As we don't use configure 335 provide a stdbool.h for vax builds locally in directories from 336 the template provided by the gettext code. 337 kcah 338 339 hack gcc 2.95/vax cannot handle __builtin_ffs() 340 cdate Fri Aug 23 21:31:15 CEST 2002 341 who ragge 342 file sys/lib/libkern/libkern.h : 1.42 343 descr 344 __builtin_ffs() is ifdef'd away if __vax__. Matt Thomas has 345 added this feature to GCC 3 so it can be removed when switching. 346 kcah 347 348 hack gcc 2.95/vax libbz2 349 mdate 27 Jun 2002 350 who thorpej 351 file lib/libbz2/Makefile 352 descr 353 libbz2 is mis-compiled with optimization with GCC 2.95.3 354 on VAX. -O0 works around this problem. 355 kcah 356 357 hack vax Toolchain bug 358 cdate 28 Mar 2003 359 who he 360 file sys/arch/vax/vax/intvec.S : 1.5 361 descr 362 Workaround for PR toolchain/20924. The assembler apparently 363 tries to range-check byte offsets when it doesn't have 364 sufficient information to make that decision. 365 Workaround uses `brw' instead of `brb' instruction. 366 kcah 367 368 hack vax gcc 2.95.3 -Wuninitialized workarounds 369 cdate 6 Nov 2003 370 who he 371 file sys/dev/bi/if_ni.c : 1.22 372 file sys/arch/vax/vax/ctu.c : 1.20 373 descr 374 Workaround for gcc 2.95.3 failing to detect that certain 375 variables will be initialized; so that this code compiles 376 with -Wuninitialized. Should be reviewed and possibly 377 reverted when gcc 3.3.2 is ready for vax. 378 kcah 379 380 hack vax gcc 2.95.3 structure initialization 381 cdat 13 May 2004 382 who cl 383 file sys/miscfs/kernfs/kernfs_vnops.c : 1.104 384 descr 385 Workaround for gcc 2.95.3 failing to initialize structures 386 and/or unions inside structures using nested designators. 387 Should be reverted when gcc >=3.3.3 is ready for vax. 388 kcah 389 390 hack vax gcc 2.95.3 needs -I. to build nslexer.c 391 cdat 6 Jun 2004 392 who mhitch 393 file lib/libc/arch/vax/Makefile.inc : 1.6 394 descr 395 It appears necessary to add -I. to CPPFLAGS when building 396 nslesxer.c. This may be caused by gcc 2.95.3 being used. 397 Should be reverted when a newer gcc is ready for vax. 398 kcah 399 400 hack vax gcc 2.95.3 doesn't understand "-std=c99" 401 cdat 5 April 2005 402 who tron 403 file src/share/mk/bsd.sys.mk 404 descr 405 We cannot use "-std=c99" for compiler warning level 4 and above 406 because gcc 2.95.3 doesn't support that option. 407 kcah 408 409 hack declare boolean_t in two IPF user-mode programs 410 cdate Tue Mar 7 19:19:20 CET 2006 411 who he 412 file dist/ipf/ipsend/iptests.c : 1.8 413 dist/ipf/ipsend/sock.c : 1.7 414 descr 415 The IPF user-mode programs ipsend and iptest first 416 include <sys/types.h> without _KERNEL defined, and 417 later include <sys/file.h> with _KERNEL defined. 418 This causes a build failure when building for vax, 419 since <sys/device.h> ends up being included without 420 bollean_t being defined by <sys/types.h>. 421 Build failure and further details documented in 422 PR#32907. 423 kcah 424 425 hack pcc 0.9.9 large string literals 426 cdat 8 July 2008 427 who gmcgarry 428 file sys/conf/param.c : 1.58 429 descr 430 Workaround for pcc 0.9.9 not handling large string literals 431 which causes kernels with 'options INCLUDE_CONFIG_FILE' to 432 fail compilation. 433 There is a proposal on the pcc mailing list to stuff config 434 file in ELF section. 435 kcah 436 437port arm 438 439 hack gcc-unsigned-compare 440 cdate 09 Mar 2002 441 mdate 18 Mar 2002 442 who bjh21 443 file dist/bind/lib/nameser/ns_parse.c : 1.3 444 file dist/dhcp/minires/ns_parse.c : 1.3 445 file dist/dhcp/omapip/result.c : 1.2 446 file dist/dhcp/server/failover.c : 1.3 447 file gnu/dist/toolchain/bfd/bfd.c : 1.2 448 file gnu/dist/toolchain/bfd/format.c : 1.2 449 file gnu/dist/toolchain/gdb/target.c : 1.2 450 file sys/kern/vfs_subr.c : 1.172 451 descr When checking that a potentially-unsigned enum is >= 0, assign 452 it to an int first. This is necessary to avoid "comparison is 453 always true" warnings with -fshort-enums. Casting to an int 454 really should be enough, but turns out not to be. 455 kcah 456 457 458port sh3 459 460 hack gcc4-sh3-bz2 461 cdate Sun May 21 03:34:57 UTC 2006 462 mdate Fri May 16 13:13:00 UTC 2008 463 who mrg, tsutsui 464 file lib/libbz2/Makefile : 1.10 465 descr 466 The in-tree GCC 4.1-based compiler generated too-far 467 pc-relative addresses. Hack is to build with 468 -fno-loop-optimize. 469 kcah 470 471 472port m68000 473 474 hack gcc4-m68000 475 cdate Fri Feb 8 10:29:37 PST 2008 476 mdate Sun May 4 15:37:19 UTC 2008 477 who mrg, tsutsui 478 file rescue/Makefile : 1.21 479 file sbin/dump_lfs/Makefile : 1.9 480 file sbin/fsck_ffs/Makefile : 1.35 481 file sbin/fsdb/Makefile : 1.22 482 file share/mk/sys.mk : 1.96 483 file usr.sbin/ndbootd/Makefile : 1.5 484 descr 485 Several internal compiler errors with gcc -O1 486 around 64bit integer arithmetic. 487 This hack uses -O1 and adds some -fno-tree-foo options 488 to avoid the problem. 489 This might be related with GCC Bugzilla Bug 32424. 490 kcah 491 492 493port sparc64 494 495 hack disable optimzations for uvm_bio.c on 32 bit kernels 496 cdate Sun Mar 21 14:14:04 MET 2004 497 who martin 498 file sys/arch/sparc64/conf/Makefile.sparc64 : 1.53-1.54 499 file sys/arch/sparc64/conf/files.sparc64 : 1.93 500 descr 501 The sparc compiler miscompiles uvm_bio.c when using 502 any optimization. This results in ubc_release panics. 503 kcah 504 505port mips 506 507 hack mips-shared-linker-load-address 508 cdate Fri Oct 7 08:33:10 UTC 2005 509 who simonb 510 file src/sys/kern/exec_elf32.c : 1.107 511 descr 512 With COMPAT_16 or previous enabled (which enables 513 ELF_INTERP_NON_RELOCATABLE) a recent ld.elf_so will 514 load and run at address 0. The check to fix this in 515 rev 1.107 only checks the first psection of the ELF 516 executable, which may not be loadable. A more correct 517 fix is to check the first loadable psection instead of 518 just the first psection. 519 kcah 520 521 hack mips-duplicate-ras-end-label 522 cdate Sat Sep 2 23:29:42 2006 523 who martin 524 file src/regress/sys/kern/ras/ras3/Makefile : 1.3 525 descr 526 Add -fno-reorder-blocks to CFLAGS to avoid duplicate 527 labels by duplicated __asm output from RAS_END() 528 macro. 529 kcah 530 531 hack mips-mcount-assembler-warning 532 cdate Tue Jul 29 14:16:52 UTC 2008 533 who lukem 534 file src/lib/libc/gmon/Makefile.inc : 1.8 535 descr 536 Workaround for PR port-mips/39192. 537 common/lib/libc/gmon/mcount.c generates a (fatal) 538 assembler warning on MIPS: 539 Warning: No .cprestore pseudo-op used in PIC code 540 Add COPTS.count.c+=-Wa,--no-warn to avoid -Wa,--fatal-warnings 541 kcah 542 543port i386 544 545 hack use volatile intermediate variable to enforce rounding 546 cdate Tue Aug 1 22:15:55 MEST 2006 547 who drochner 548 file src/lib/libm/src/lrintf.c : 1.4 549 file src/lib/libm/src/s_rintf.c : 1.8 550 descr 551 gcc-4 does subsequent operations on "float" values within 552 the i387 FPU without rounding the intermediate results 553 kcah 554