Home | History | Annotate | Line # | Download | only in doc
HACKS revision 1.26
      1 # $NetBSD: HACKS,v 1.26 2003/12/07 12:52:33 simonb 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 
    100 port	vax
    101 
    102 	hack	gcc 2.95/vax cannot handle __builtin_ffs()
    103 	cdate	Fri Aug 23 21:31:15 CEST 2002
    104 	who	ragge
    105 	file	sys/lib/libkern/libkern.h : 1.42
    106 	descr
    107 		__builtin_ffs() is ifdef'd away if __vax__. Matt Thomas has
    108 		added this feature to GCC 3 so it can be removed when switching.
    109 	kcah
    110 
    111 	hack	gcc-vax-libbz2
    112 	mdate	27 Jun 2002
    113 	who	thorpej
    114 	file	lib/libbz2/Makefile
    115 	descr
    116 		libbz2 is mis-compiled with optimization with GCC 2.95.3
    117 		on VAX.  -O0 works around this problem.
    118 	kcah
    119 
    120 	hack	gawk
    121 	mdate	8 Nov 2003
    122 	who	ragge
    123 	file	gnu/usr.bin/gawk/Makefile
    124 	descr
    125 		gawk is mis-compiled with optimization with GCC 2.95.3
    126 		on VAX.  -O0 works around this problem.
    127 	kcah
    128 
    129 	hack	vax Toolchain bug
    130 	cdate	28 Mar 2003
    131 	who	he
    132 	file	sys/arch/vax/vax/intvec.S : 1.5
    133 	descr
    134 		Workaround for PR toolchain/20924.  The assembler apparently
    135 		tries to range-check byte offsets when it doesn't have
    136 		sufficient information to make that decision.
    137 		Workaround uses `brw' instead of `brb' instruction.
    138 	kcah
    139 
    140 	hack	vax gcc 2.95.3 -Wuninitialized workarounds
    141 	cdate	6 Nov 2003
    142 	who	he
    143 	file	sys/dev/bi/if_ni.c : 1.22
    144 	file	sys/arch/vax/vax/ctu.c : 1.20
    145 	descr
    146 		Workaround for gcc 2.95.3 failing to detect that certain
    147 		variables will be initialized; so that this code compiles
    148 		with -Wuninitialized.  Should be reviewed and possibly
    149 		reverted when gcc 3.3.2 is ready for vax.
    150 	kcah
    151 
    152 
    153 port	sparc64
    154 
    155 	hack	binutil-2.11-sparc64-pltrela
    156 	mdate	14 Aug 2001
    157 	who	eeh
    158 	file	libexec/ld.elf_so/arch/sparc64/mdreloc.c
    159 	descr
    160 		The first for PLT entries are reserved.  There is some
    161 		disagreement whether they should have associated relocation
    162 		entries.  Both the SPARC 32-bit and 64-bit ELF specifications
    163 		say that they should have relocation entries, but the 32-bit
    164 		SPARC binutils do not generate them, and now the 64-bit SPARC
    165 		binutils have stopped generating them too.
    166 
    167 		To provide binary compatibility, we will check the first entry,
    168 		if it is reserved it should not be of the type JMP_SLOT.  If it
    169 		is JMP_SLOT, then the 4 reserved entries were not generated and
    170 		our index is 4 entries too far, so we frob the rela pointer.
    171 	kcah
    172 
    173 
    174 port	arm
    175 
    176 	hack	gcc-unsigned-compare
    177 	cdate	09 Mar 2002
    178 	mdate	18 Mar 2002
    179 	who	bjh21
    180 	file	dist/bind/lib/nameser/ns_parse.c : 1.3
    181 	file	dist/dhcp/minires/ns_parse.c : 1.3
    182 	file	dist/dhcp/omapip/result.c : 1.2
    183 	file	dist/dhcp/server/failover.c : 1.3
    184 	file	gnu/dist/gawk/eval.c : 1.4
    185 	file	gnu/dist/toolchain/bfd/bfd.c : 1.2
    186 	file	gnu/dist/toolchain/bfd/format.c : 1.2
    187 	file	gnu/dist/toolchain/gdb/target.c : 1.2
    188 	file	sys/kern/vfs_subr.c : 1.172
    189 	descr	When checking that a potentially-unsigned enum is >= 0, assign
    190 		it to an int first.  This is necessary to avoid "comparison is
    191 		always true" warnings with -fshort-enums.  Casting to an int
    192 		really should be enough, but turns out not to be.
    193 	kcah
    194 
    195 	hack	gcc 3.3.x bug
    196 	cdate	Sun Oct 26 01:50:16 UTC 2003
    197 	who	lukem
    198 	file	usr.bin/newsyslog/newsyslog.c
    199 	pr	22986 23002 23217
    200 	descr
    201 		newsyslog fails with
    202 			newsyslog: config line 7: bad flags
    203 		solved when compiled with -fno-gcse-lm
    204 	kcah
    205 
    206 	hack	gcc 3.3.2/arm sys/kern/uipc_socket.c
    207 	cdate	Tue Oct 28 18:02:16 GMT 2003
    208 	who	skrll
    209 	file	sys/conf/arm/Makefile.arm : 1.19
    210 	descr
    211 		Performing a build.sh tools on a CATS with NFS mounted 
    212 		obj and src directories results in "panic: receive 1"
    213 		The hack is to compile sys/kern/uipc_socket.c with
    214 		-fno-strict-aliasing
    215 	kcah
    216 
    217 
    218 port	pc532
    219 
    220 	hack	egcs-pc532-ip6_mroute
    221 	cdate	09 Jul 2002
    222 	who	simonb
    223 	file	sys/arch/pc532/conf/Makefile.pc532 : 1.70
    224 	file	sys/arch/pc532/conf/files.pc532 : 1.47
    225 	descr
    226 		egcs 1.1.2 gets an "internal error--insn does not satisfy its
    227 		constraints" error compiling ip6_mroute.c with -O2 or greater.
    228 		-O1 works around this problem.
    229 	kcah
    230 
    231 	hack	gcc-pc532-duffs_device
    232 	cdate	Mon Oct 27 07:23:05 UTC 2003
    233 	who	simonb
    234 	file	sys/arch/pc532/conf/Makefile.pc532 : 1.71
    235 	file	sys/arch/pc532/conf/files.pc532 : 1.52
    236 	pr	GCC PR optimization/5230
    237 	descr
    238 		gcc incorrectly gives an "unreachable code at beginning of
    239 		switch statement" for a Duff's device construct in
    240 		arch/pc532/dev/ncr.c.  There is no way to disable just this
    241 		warning, so -Wno-error is turned on for this file.
    242 	kcah
    243 
    244 	hack	gcc332-cppmacro-ice
    245 	cdate	Sun Dec  7 12:48:33 UTC 2003
    246 	who	simonb
    247 	file	gnu/usr.bin/gcc3/libcpp/Makefile : 1.2
    248 	descr
    249 		gcc 3.3.2 gets an ICE when compiling cppmacro.c with -O2.
    250 		The hack is to use -O1 for this file.  Fixed in gcc
    251 		-current mainline, unable to work out where the fix is
    252 		right now.
    253 	kcah
    254 
    255 
    256 port	sh3
    257 
    258 	hack	gcc-sh3-sed
    259 	mdate	23 Apr 2002
    260 	who	thorpej
    261 	file	usr.bin/sed/Makefile	: 1.9 : 9 : 13
    262 	descr
    263 		The in-tree GCC 2.95.3-based compiler ICEs when building
    264 		with optimization for SuperH.  Hack is to build with -O0.
    265 	kcah
    266 
    267 
    268 port	sh5
    269 
    270 	hack	SuperH SH5 Toolchain Bugs
    271 	cdate	11 Jul 2002
    272 	who	scw
    273 	file	usr.sbin/ndbootd/ndbootd.c : 1.6
    274 	file	usr.sbin/traceroute/traceroute.c : 1.48
    275 	descr
    276 		The SuperH SH5 toolchain (2.97-sh5-010522) gets an internal
    277 		compiler error when assigning a bit-wise inverted value
    278 		under some circumstances.
    279 		Work around it by splitting the statement into two.
    280 	kcah
    281 
    282 	hack	SuperH SH5 Toolchain Bugs
    283 	cdate	17 May 2003
    284 	who	scw
    285 	file	lib/libpthread/pthread_lock.c : 1.7
    286 	descr
    287 		The SuperH SH5 toolchain generates incorrect PIC code when
    288 		faced with a symbol which is declared extern, but has local
    289 		scope due to being defined within an asm() statement (without
    290 		being declared .globl in that statement). Work around it by
    291 		adding the .globl.
    292 	kcah
    293 
    294 
    295 port	sun2
    296 
    297 	hack	gcc 3.3.2/mdsetimage
    298 	cdate	Tue Oct 28 18:43:05 EST 2003
    299 	who	fredette
    300 	file	gnu/usr.sbin/mdsetimage/Makefile : 1.15
    301 	descr
    302 		mdsetimage.c causes cc1 to barf for as-yet unknown reasons.
    303 		this hack uses -O0 to avoid the problem.
    304 	kcah
    305 
    306 	hack	gcc 3.3.2/installboot/ffs.c
    307 	cdate	Tue Oct 28 18:43:05 EST 2003
    308 	who	fredette
    309 	file	usr.sbin/installboot/Makefile : 1.26
    310 	descr
    311 		ffs.c causes cc1 to barf for as-yet unknown reasons.  this
    312 		hack uses -O0 to avoid the problem.
    313 	kcah
    314 
    315 
    316 port	sun2, m68k
    317 
    318 	hack	gcc 3.3.2/gcc/ra-colorize.c
    319 	cdate	Wed Nov  5 11:03:13 EST 2003
    320 	who	mrg
    321 	file	gnu/usr.bin/gcc/backend/Makefile : 1.11
    322 	descr
    323 		ra-colorize.c causes a whole spew of unreferenced .L* local
    324 		symbols.  using -O0 (or even -O2 reportedly) avoids the problem.
    325 	kcah
    326