Home | History | Annotate | Line # | Download | only in doc
HACKS revision 1.32.2.3
      1 # $NetBSD: HACKS,v 1.32.2.3 2004/08/11 19:52:10 jmc 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 
     30 hack	netstat ieee1394 address printing.
     31 mdate	14 Nov 2000
     32 who	matt
     33 file	lib/libc/net/getnameinfo.c	: 1.32 : 497 : 503
     34 descr
     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.
     38 kcah
     39 
     40 hack	xterm vs. libterm
     41 mdate	01 Aug 2000
     42 who	jdc
     43 file	xsrc/xc/programs/xterm/main.c	: 1.2 : 3609 : 3614
     44 pr	10383
     45 descr
     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.
     51 kcah
     52 
     53 hack	wi-at-big-endian-bus
     54 cdate	15 Mar 2002
     55 who	martin
     56 file	dev/ic/wireg.h
     57 descr	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.
     61 kcah
     62 
     63 hack	specific knowledge of colours in curses code
     64 cdate	Sun Apr  6 11:05:24 BST 2003
     65 who	jdc
     66 file	lib/libcurses/color.c : r1.24
     67 descr
     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
     72 kcah
     73 
     74 hack	Compensation for differing types of LINUX_USRSTACK and USRSTACK
     75 cdate	21 Aug 2003
     76 who	he
     77 file	sys/miscfs/procfs/procfs_linux.c : 1.14
     78 descr
     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.
     85 kcah
     86 
     87 hack	GCC2 isn't C99
     88 cdate	5 December 2003
     89 who	mrg
     90 file	gnu/dist/binutils/ld/ldlex.c: r1.2
     91 descr
     92 	ldlex.c is generated from ldlex.l and we get macro redefinition
     93 	errors from it if __STDC_VERSION__ is not C99 compliant.  This
     94 	hack forces NetBSD 1.6 and later systems to also include <stdint.h>
     95 	to get the relevant definitions.  This hack should be backed out
     96 	when all platforms have switched away from GCC2.
     97 kcah
     98 
     99 hack	gcc-strict-aliasing
    100 cdate	6 August 2004
    101 who	junyoung
    102 pr	26516
    103 file	src/usr.sbin/racoon/racoon/Makefile : 1.21
    104 descr
    105 	GCC issues a warning "dereferencing type-punned pointer will break
    106 	strict-aliasing rules" when compiling
    107 	crypto/dist/kame/racoon/crypto/openssl.c with -O[23s]. Note that this
    108 	is due to invalid use of type casting in the code and not a compiler
    109 	bug. Once a new release of KAME with a proper fix applied is imported
    110 	this should be backed out.
    111 kcah
    112 
    113 
    114 port	vax
    115 
    116 	hack	gcc 2.95/vax cannot handle __builtin_ffs()
    117 	cdate	Fri Aug 23 21:31:15 CEST 2002
    118 	who	ragge
    119 	file	sys/lib/libkern/libkern.h : 1.42
    120 	descr
    121 		__builtin_ffs() is ifdef'd away if __vax__. Matt Thomas has
    122 		added this feature to GCC 3 so it can be removed when switching.
    123 	kcah
    124 
    125 	hack	gcc-vax-libbz2
    126 	mdate	27 Jun 2002
    127 	who	thorpej
    128 	file	lib/libbz2/Makefile
    129 	descr
    130 		libbz2 is mis-compiled with optimization with GCC 2.95.3
    131 		on VAX.  -O0 works around this problem.
    132 	kcah
    133 
    134 	hack	gawk
    135 	mdate	8 Nov 2003
    136 	who	ragge
    137 	file	gnu/usr.bin/gawk/Makefile
    138 	descr
    139 		gawk is mis-compiled with optimization with GCC 2.95.3
    140 		on VAX.  -O0 works around this problem.
    141 	kcah
    142 
    143 	hack	vax Toolchain bug
    144 	cdate	28 Mar 2003
    145 	who	he
    146 	file	sys/arch/vax/vax/intvec.S : 1.5
    147 	descr
    148 		Workaround for PR toolchain/20924.  The assembler apparently
    149 		tries to range-check byte offsets when it doesn't have
    150 		sufficient information to make that decision.
    151 		Workaround uses `brw' instead of `brb' instruction.
    152 	kcah
    153 
    154 	hack	vax gcc 2.95.3 -Wuninitialized workarounds
    155 	cdate	6 Nov 2003
    156 	who	he
    157 	file	sys/dev/bi/if_ni.c : 1.22
    158 	file	sys/arch/vax/vax/ctu.c : 1.20
    159 	descr
    160 		Workaround for gcc 2.95.3 failing to detect that certain
    161 		variables will be initialized; so that this code compiles
    162 		with -Wuninitialized.  Should be reviewed and possibly
    163 		reverted when gcc 3.3.2 is ready for vax.
    164 	kcah
    165 
    166 	hack	vax gcc 2.95.3 structure initialization
    167 	cdat	13 May 2004
    168 	who	cl
    169 	file	sys/miscfs/kernfs/kernfs_vnops.c : 1.104
    170 	descr
    171 		Workaround for gcc 2.95.3 failing to initialize structures
    172 		and/or unions inside structures using nested designators.
    173 		Should be reverted when gcc >=3.3.3 is ready for vax.
    174 	kcah
    175 
    176 port	sparc64
    177 
    178 	hack	binutil-2.11-sparc64-pltrela
    179 	mdate	14 Aug 2001
    180 	who	eeh
    181 	file	libexec/ld.elf_so/arch/sparc64/mdreloc.c
    182 	descr
    183 		The first for PLT entries are reserved.  There is some
    184 		disagreement whether they should have associated relocation
    185 		entries.  Both the SPARC 32-bit and 64-bit ELF specifications
    186 		say that they should have relocation entries, but the 32-bit
    187 		SPARC binutils do not generate them, and now the 64-bit SPARC
    188 		binutils have stopped generating them too.
    189 
    190 		To provide binary compatibility, we will check the first entry,
    191 		if it is reserved it should not be of the type JMP_SLOT.  If it
    192 		is JMP_SLOT, then the 4 reserved entries were not generated and
    193 		our index is 4 entries too far, so we frob the rela pointer.
    194 	kcah
    195 
    196 
    197 port	arm
    198 
    199 	hack	gcc-unsigned-compare
    200 	cdate	09 Mar 2002
    201 	mdate	18 Mar 2002
    202 	who	bjh21
    203 	file	dist/bind/lib/nameser/ns_parse.c : 1.3
    204 	file	dist/dhcp/minires/ns_parse.c : 1.3
    205 	file	dist/dhcp/omapip/result.c : 1.2
    206 	file	dist/dhcp/server/failover.c : 1.3
    207 	file	gnu/dist/gawk/eval.c : 1.4
    208 	file	gnu/dist/toolchain/bfd/bfd.c : 1.2
    209 	file	gnu/dist/toolchain/bfd/format.c : 1.2
    210 	file	gnu/dist/toolchain/gdb/target.c : 1.2
    211 	file	sys/kern/vfs_subr.c : 1.172
    212 	descr	When checking that a potentially-unsigned enum is >= 0, assign
    213 		it to an int first.  This is necessary to avoid "comparison is
    214 		always true" warnings with -fshort-enums.  Casting to an int
    215 		really should be enough, but turns out not to be.
    216 	kcah
    217 
    218 	hack	gcc 3.3.2/arm sys/kern/uipc_socket.c
    219 	cdate	Tue Oct 28 18:02:16 GMT 2003
    220 	who	skrll
    221 	file	sys/conf/arm/Makefile.arm : 1.19
    222 	descr
    223 		Performing a build.sh tools on a CATS with NFS mounted 
    224 		obj and src directories results in "panic: receive 1"
    225 		The hack is to compile sys/kern/uipc_socket.c with
    226 		-fno-strict-aliasing
    227 	kcah
    228 
    229 
    230 port	pc532
    231 
    232 	hack	egcs-pc532-ip6_mroute
    233 	cdate	09 Jul 2002
    234 	who	simonb
    235 	file	sys/arch/pc532/conf/Makefile.pc532 : 1.70
    236 	file	sys/arch/pc532/conf/files.pc532 : 1.47
    237 	descr
    238 		egcs 1.1.2 gets an "internal error--insn does not satisfy its
    239 		constraints" error compiling ip6_mroute.c with -O2 or greater.
    240 		-O1 works around this problem.
    241 	kcah
    242 
    243 	hack	gcc-pc532-duffs_device
    244 	cdate	Mon Oct 27 07:23:05 UTC 2003
    245 	who	simonb
    246 	file	sys/arch/pc532/conf/Makefile.pc532 : 1.71
    247 	file	sys/arch/pc532/conf/files.pc532 : 1.52
    248 	pr	GCC PR optimization/5230
    249 	descr
    250 		gcc incorrectly gives an "unreachable code at beginning of
    251 		switch statement" for a Duff's device construct in
    252 		arch/pc532/dev/ncr.c.  There is no way to disable just this
    253 		warning, so -Wno-error is turned on for this file.
    254 	kcah
    255 
    256 	hack	gcc332-cppmacro-ice
    257 	cdate	Sun Dec  7 12:48:33 UTC 2003
    258 	who	simonb
    259 	file	gnu/usr.bin/gcc3/libcpp/Makefile : 1.2
    260 	descr
    261 		gcc 3.3.2 gets an ICE when compiling cppmacro.c with -O2.
    262 		The hack is to use -O1 for this file.  Fixed in gcc
    263 		-current mainline, unable to work out where the fix is
    264 		right now.
    265 	kcah
    266 
    267 
    268 port	sh3
    269 
    270 	hack	gcc-sh3-sed
    271 	mdate	23 Apr 2002
    272 	who	thorpej
    273 	file	usr.bin/sed/Makefile	: 1.9 : 9 : 13
    274 	descr
    275 		The in-tree GCC 2.95.3-based compiler ICEs when building
    276 		with optimization for SuperH.  Hack is to build with -O0.
    277 	kcah
    278 
    279 
    280 port	sh5
    281 
    282 	hack	SuperH SH5 Toolchain Bugs
    283 	cdate	11 Jul 2002
    284 	who	scw
    285 	file	usr.sbin/ndbootd/ndbootd.c : 1.6
    286 	file	usr.sbin/traceroute/traceroute.c : 1.48
    287 	descr
    288 		The SuperH SH5 toolchain (2.97-sh5-010522) gets an internal
    289 		compiler error when assigning a bit-wise inverted value
    290 		under some circumstances.
    291 		Work around it by splitting the statement into two.
    292 	kcah
    293 
    294 	hack	SuperH SH5 Toolchain Bugs
    295 	cdate	17 May 2003
    296 	who	scw
    297 	file	lib/libpthread/pthread_lock.c : 1.7
    298 	descr
    299 		The SuperH SH5 toolchain generates incorrect PIC code when
    300 		faced with a symbol which is declared extern, but has local
    301 		scope due to being defined within an asm() statement (without
    302 		being declared .globl in that statement). Work around it by
    303 		adding the .globl.
    304 	kcah
    305 
    306 	hack	gcc 3.3.2 on sh5 - ICE compiling reload1.c at -O2
    307 	cdate	Sun Dec  7 19:44:05 GMT 2003
    308 	who	scw
    309 	file	gnu/usr.bin/gcc3/backend/Makefile : 1.13
    310 	descr
    311 		Gcc3 for sh5 gets an ICE compiling reload1.c at -O2.
    312 		Drop to -O1 for now when building for sh5.
    313 	kcah
    314 
    315 	hack	gcc 3.3.2 on sh5 - ICE compiling elf32.c/elf64.c at -O2
    316 	cdate	Sun Dec  7 21:10:46 GMT 2003
    317 	who	scw
    318 	file	gnu/lib/libbfd/Makefile : 1.39
    319 	descr
    320 		Gcc3 for sh5 gets an ICE compiling libbfd's elf32.c
    321 		and elf64.c at -O2.
    322 		Drop to -O1 for now when building for sh5.
    323 	kcah
    324 
    325 
    326 	hack	gcc 3.3.2 on sh5 - fatal warning compiling function.c
    327 	cdate	Sun Dec  7 19:44:05 GMT 2003
    328 	who	scw
    329 	file	gnu/usr.bin/gcc3/backend/Makefile : 1.13
    330 	descr
    331 		Gcc3 for sh5 issues a warning:
    332 		.../gnu/dist/gcc/gcc/function.c:4742: warning: `and' of
    333 		    mutually exclusive equal-tests is always 0.
    334 		This causes the build to fail because of -Werror.
    335 		Work-around by defining NOGCCERROR when building for sh5.
    336 	kcah
    337 
    338 	hack	gcc 3.3.2 on sh5 - ICE compiling dist/bind/bin/named/ns_main.c
    339 	cdate	Sun Dec  7 19:44:05 GMT 2003
    340 	who	scw
    341 	file	usr.sbin/bind/named/Makefile : 1.15
    342 	descr
    343 		Gcc3 for sh5 gets an ICE compiling ns_main.c at -O2.
    344 		Drop to -O1 for now when building for sh5.
    345 	kcah
    346 
    347 
    348 port	sun2
    349 
    350 	hack	gcc 3.3.2/mdsetimage
    351 	cdate	Tue Oct 28 18:43:05 EST 2003
    352 	who	fredette
    353 	file	gnu/usr.sbin/mdsetimage/Makefile : 1.15
    354 	descr
    355 		mdsetimage.c causes cc1 to barf for as-yet unknown reasons.
    356 		this hack uses -O0 to avoid the problem.
    357 	kcah
    358 
    359 	hack	gcc 3.3.2/installboot/ffs.c
    360 	cdate	Tue Oct 28 18:43:05 EST 2003
    361 	who	fredette
    362 	file	usr.sbin/installboot/Makefile : 1.26
    363 	descr
    364 		ffs.c causes cc1 to barf for as-yet unknown reasons.  this
    365 		hack uses -O0 to avoid the problem.
    366 	kcah
    367 
    368 
    369 port	sun2, m68k
    370 
    371 	hack	gcc 3.3.2/gcc/ra-colorize.c
    372 	cdate	Wed Nov  5 11:03:13 EST 2003
    373 	who	mrg
    374 	file	gnu/usr.bin/gcc/backend/Makefile : 1.11
    375 	descr
    376 		ra-colorize.c causes a whole spew of unreferenced .L* local
    377 		symbols.  using -O0 (or even -O2 reportedly) avoids the problem.
    378 	kcah
    379 
    380 port	sparc64
    381 
    382 	hack	disable optimzations for uvm_bio.c on 32 bit kernels
    383 	cdate	Sun Mar 21 14:14:04 MET 2004
    384 	who	martin
    385 	file	sys/arch/sparc64/conf/Makefile.sparc64 : 1.53-1.54
    386 	file	sys/arch/sparc64/conf/files.sparc64 : 1.93
    387 	descr
    388 		The sparc compiler miscompiles uvm_bio.c when using
    389 		any optimization. This results in ubc_release panics.
    390 	kcah
    391