trouble.texi 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197
  1. @c Copyright (C) 1988-2015 Free Software Foundation, Inc.
  2. @c This is part of the GCC manual.
  3. @c For copying conditions, see the file gcc.texi.
  4. @node Trouble
  5. @chapter Known Causes of Trouble with GCC
  6. @cindex bugs, known
  7. @cindex installation trouble
  8. @cindex known causes of trouble
  9. This section describes known problems that affect users of GCC@. Most
  10. of these are not GCC bugs per se---if they were, we would fix them.
  11. But the result for a user may be like the result of a bug.
  12. Some of these problems are due to bugs in other software, some are
  13. missing features that are too much work to add, and some are places
  14. where people's opinions differ as to what is best.
  15. @menu
  16. * Actual Bugs:: Bugs we will fix later.
  17. * Interoperation:: Problems using GCC with other compilers,
  18. and with certain linkers, assemblers and debuggers.
  19. * Incompatibilities:: GCC is incompatible with traditional C.
  20. * Fixed Headers:: GCC uses corrected versions of system header files.
  21. This is necessary, but doesn't always work smoothly.
  22. * Standard Libraries:: GCC uses the system C library, which might not be
  23. compliant with the ISO C standard.
  24. * Disappointments:: Regrettable things we can't change, but not quite bugs.
  25. * C++ Misunderstandings:: Common misunderstandings with GNU C++.
  26. * Non-bugs:: Things we think are right, but some others disagree.
  27. * Warnings and Errors:: Which problems in your code get warnings,
  28. and which get errors.
  29. @end menu
  30. @node Actual Bugs
  31. @section Actual Bugs We Haven't Fixed Yet
  32. @itemize @bullet
  33. @item
  34. The @code{fixincludes} script interacts badly with automounters; if the
  35. directory of system header files is automounted, it tends to be
  36. unmounted while @code{fixincludes} is running. This would seem to be a
  37. bug in the automounter. We don't know any good way to work around it.
  38. @end itemize
  39. @node Interoperation
  40. @section Interoperation
  41. This section lists various difficulties encountered in using GCC
  42. together with other compilers or with the assemblers, linkers,
  43. libraries and debuggers on certain systems.
  44. @itemize @bullet
  45. @item
  46. On many platforms, GCC supports a different ABI for C++ than do other
  47. compilers, so the object files compiled by GCC cannot be used with object
  48. files generated by another C++ compiler.
  49. An area where the difference is most apparent is name mangling. The use
  50. of different name mangling is intentional, to protect you from more subtle
  51. problems.
  52. Compilers differ as to many internal details of C++ implementation,
  53. including: how class instances are laid out, how multiple inheritance is
  54. implemented, and how virtual function calls are handled. If the name
  55. encoding were made the same, your programs would link against libraries
  56. provided from other compilers---but the programs would then crash when
  57. run. Incompatible libraries are then detected at link time, rather than
  58. at run time.
  59. @item
  60. On some BSD systems, including some versions of Ultrix, use of profiling
  61. causes static variable destructors (currently used only in C++) not to
  62. be run.
  63. @item
  64. On a SPARC, GCC aligns all values of type @code{double} on an 8-byte
  65. boundary, and it expects every @code{double} to be so aligned. The Sun
  66. compiler usually gives @code{double} values 8-byte alignment, with one
  67. exception: function arguments of type @code{double} may not be aligned.
  68. As a result, if a function compiled with Sun CC takes the address of an
  69. argument of type @code{double} and passes this pointer of type
  70. @code{double *} to a function compiled with GCC, dereferencing the
  71. pointer may cause a fatal signal.
  72. One way to solve this problem is to compile your entire program with GCC@.
  73. Another solution is to modify the function that is compiled with
  74. Sun CC to copy the argument into a local variable; local variables
  75. are always properly aligned. A third solution is to modify the function
  76. that uses the pointer to dereference it via the following function
  77. @code{access_double} instead of directly with @samp{*}:
  78. @smallexample
  79. inline double
  80. access_double (double *unaligned_ptr)
  81. @{
  82. union d2i @{ double d; int i[2]; @};
  83. union d2i *p = (union d2i *) unaligned_ptr;
  84. union d2i u;
  85. u.i[0] = p->i[0];
  86. u.i[1] = p->i[1];
  87. return u.d;
  88. @}
  89. @end smallexample
  90. @noindent
  91. Storing into the pointer can be done likewise with the same union.
  92. @item
  93. On Solaris, the @code{malloc} function in the @file{libmalloc.a} library
  94. may allocate memory that is only 4 byte aligned. Since GCC on the
  95. SPARC assumes that doubles are 8 byte aligned, this may result in a
  96. fatal signal if doubles are stored in memory allocated by the
  97. @file{libmalloc.a} library.
  98. The solution is to not use the @file{libmalloc.a} library. Use instead
  99. @code{malloc} and related functions from @file{libc.a}; they do not have
  100. this problem.
  101. @item
  102. On the HP PA machine, ADB sometimes fails to work on functions compiled
  103. with GCC@. Specifically, it fails to work on functions that use
  104. @code{alloca} or variable-size arrays. This is because GCC doesn't
  105. generate HP-UX unwind descriptors for such functions. It may even be
  106. impossible to generate them.
  107. @item
  108. Debugging (@option{-g}) is not supported on the HP PA machine, unless you use
  109. the preliminary GNU tools.
  110. @item
  111. Taking the address of a label may generate errors from the HP-UX
  112. PA assembler. GAS for the PA does not have this problem.
  113. @item
  114. Using floating point parameters for indirect calls to static functions
  115. will not work when using the HP assembler. There simply is no way for GCC
  116. to specify what registers hold arguments for static functions when using
  117. the HP assembler. GAS for the PA does not have this problem.
  118. @item
  119. In extremely rare cases involving some very large functions you may
  120. receive errors from the HP linker complaining about an out of bounds
  121. unconditional branch offset. This used to occur more often in previous
  122. versions of GCC, but is now exceptionally rare. If you should run
  123. into it, you can work around by making your function smaller.
  124. @item
  125. GCC compiled code sometimes emits warnings from the HP-UX assembler of
  126. the form:
  127. @smallexample
  128. (warning) Use of GR3 when
  129. frame >= 8192 may cause conflict.
  130. @end smallexample
  131. These warnings are harmless and can be safely ignored.
  132. @item
  133. In extremely rare cases involving some very large functions you may
  134. receive errors from the AIX Assembler complaining about a displacement
  135. that is too large. If you should run into it, you can work around by
  136. making your function smaller.
  137. @item
  138. The @file{libstdc++.a} library in GCC relies on the SVR4 dynamic
  139. linker semantics which merges global symbols between libraries and
  140. applications, especially necessary for C++ streams functionality.
  141. This is not the default behavior of AIX shared libraries and dynamic
  142. linking. @file{libstdc++.a} is built on AIX with ``runtime-linking''
  143. enabled so that symbol merging can occur. To utilize this feature,
  144. the application linked with @file{libstdc++.a} must include the
  145. @option{-Wl,-brtl} flag on the link line. G++ cannot impose this
  146. because this option may interfere with the semantics of the user
  147. program and users may not always use @samp{g++} to link his or her
  148. application. Applications are not required to use the
  149. @option{-Wl,-brtl} flag on the link line---the rest of the
  150. @file{libstdc++.a} library which is not dependent on the symbol
  151. merging semantics will continue to function correctly.
  152. @item
  153. An application can interpose its own definition of functions for
  154. functions invoked by @file{libstdc++.a} with ``runtime-linking''
  155. enabled on AIX@. To accomplish this the application must be linked
  156. with ``runtime-linking'' option and the functions explicitly must be
  157. exported by the application (@option{-Wl,-brtl,-bE:exportfile}).
  158. @item
  159. AIX on the RS/6000 provides support (NLS) for environments outside of
  160. the United States. Compilers and assemblers use NLS to support
  161. locale-specific representations of various objects including
  162. floating-point numbers (@samp{.} vs @samp{,} for separating decimal
  163. fractions). There have been problems reported where the library linked
  164. with GCC does not produce the same floating-point formats that the
  165. assembler accepts. If you have this problem, set the @env{LANG}
  166. environment variable to @samp{C} or @samp{En_US}.
  167. @item
  168. @opindex fdollars-in-identifiers
  169. Even if you specify @option{-fdollars-in-identifiers},
  170. you cannot successfully use @samp{$} in identifiers on the RS/6000 due
  171. to a restriction in the IBM assembler. GAS supports these
  172. identifiers.
  173. @end itemize
  174. @node Incompatibilities
  175. @section Incompatibilities of GCC
  176. @cindex incompatibilities of GCC
  177. @opindex traditional
  178. There are several noteworthy incompatibilities between GNU C and K&R
  179. (non-ISO) versions of C@.
  180. @itemize @bullet
  181. @cindex string constants
  182. @cindex read-only strings
  183. @cindex shared strings
  184. @item
  185. GCC normally makes string constants read-only. If several
  186. identical-looking string constants are used, GCC stores only one
  187. copy of the string.
  188. @cindex @code{mktemp}, and constant strings
  189. One consequence is that you cannot call @code{mktemp} with a string
  190. constant argument. The function @code{mktemp} always alters the
  191. string its argument points to.
  192. @cindex @code{sscanf}, and constant strings
  193. @cindex @code{fscanf}, and constant strings
  194. @cindex @code{scanf}, and constant strings
  195. Another consequence is that @code{sscanf} does not work on some very
  196. old systems when passed a string constant as its format control string
  197. or input. This is because @code{sscanf} incorrectly tries to write
  198. into the string constant. Likewise @code{fscanf} and @code{scanf}.
  199. The solution to these problems is to change the program to use
  200. @code{char}-array variables with initialization strings for these
  201. purposes instead of string constants.
  202. @item
  203. @code{-2147483648} is positive.
  204. This is because 2147483648 cannot fit in the type @code{int}, so
  205. (following the ISO C rules) its data type is @code{unsigned long int}.
  206. Negating this value yields 2147483648 again.
  207. @item
  208. GCC does not substitute macro arguments when they appear inside of
  209. string constants. For example, the following macro in GCC
  210. @smallexample
  211. #define foo(a) "a"
  212. @end smallexample
  213. @noindent
  214. will produce output @code{"a"} regardless of what the argument @var{a} is.
  215. @cindex @code{setjmp} incompatibilities
  216. @cindex @code{longjmp} incompatibilities
  217. @item
  218. When you use @code{setjmp} and @code{longjmp}, the only automatic
  219. variables guaranteed to remain valid are those declared
  220. @code{volatile}. This is a consequence of automatic register
  221. allocation. Consider this function:
  222. @smallexample
  223. jmp_buf j;
  224. foo ()
  225. @{
  226. int a, b;
  227. a = fun1 ();
  228. if (setjmp (j))
  229. return a;
  230. a = fun2 ();
  231. /* @r{@code{longjmp (j)} may occur in @code{fun3}.} */
  232. return a + fun3 ();
  233. @}
  234. @end smallexample
  235. Here @code{a} may or may not be restored to its first value when the
  236. @code{longjmp} occurs. If @code{a} is allocated in a register, then
  237. its first value is restored; otherwise, it keeps the last value stored
  238. in it.
  239. @opindex W
  240. If you use the @option{-W} option with the @option{-O} option, you will
  241. get a warning when GCC thinks such a problem might be possible.
  242. @item
  243. Programs that use preprocessing directives in the middle of macro
  244. arguments do not work with GCC@. For example, a program like this
  245. will not work:
  246. @smallexample
  247. @group
  248. foobar (
  249. #define luser
  250. hack)
  251. @end group
  252. @end smallexample
  253. ISO C does not permit such a construct.
  254. @item
  255. K&R compilers allow comments to cross over an inclusion boundary
  256. (i.e.@: started in an include file and ended in the including file).
  257. @cindex external declaration scope
  258. @cindex scope of external declarations
  259. @cindex declaration scope
  260. @item
  261. Declarations of external variables and functions within a block apply
  262. only to the block containing the declaration. In other words, they
  263. have the same scope as any other declaration in the same place.
  264. In some other C compilers, an @code{extern} declaration affects all the
  265. rest of the file even if it happens within a block.
  266. @item
  267. In traditional C, you can combine @code{long}, etc., with a typedef name,
  268. as shown here:
  269. @smallexample
  270. typedef int foo;
  271. typedef long foo bar;
  272. @end smallexample
  273. In ISO C, this is not allowed: @code{long} and other type modifiers
  274. require an explicit @code{int}.
  275. @cindex typedef names as function parameters
  276. @item
  277. PCC allows typedef names to be used as function parameters.
  278. @item
  279. Traditional C allows the following erroneous pair of declarations to
  280. appear together in a given scope:
  281. @smallexample
  282. typedef int foo;
  283. typedef foo foo;
  284. @end smallexample
  285. @item
  286. GCC treats all characters of identifiers as significant. According to
  287. K&R-1 (2.2), ``No more than the first eight characters are significant,
  288. although more may be used.''. Also according to K&R-1 (2.2), ``An
  289. identifier is a sequence of letters and digits; the first character must
  290. be a letter. The underscore _ counts as a letter.'', but GCC also
  291. allows dollar signs in identifiers.
  292. @cindex whitespace
  293. @item
  294. PCC allows whitespace in the middle of compound assignment operators
  295. such as @samp{+=}. GCC, following the ISO standard, does not
  296. allow this.
  297. @cindex apostrophes
  298. @cindex @code{'}
  299. @item
  300. GCC complains about unterminated character constants inside of
  301. preprocessing conditionals that fail. Some programs have English
  302. comments enclosed in conditionals that are guaranteed to fail; if these
  303. comments contain apostrophes, GCC will probably report an error. For
  304. example, this code would produce an error:
  305. @smallexample
  306. #if 0
  307. You can't expect this to work.
  308. #endif
  309. @end smallexample
  310. The best solution to such a problem is to put the text into an actual
  311. C comment delimited by @samp{/*@dots{}*/}.
  312. @item
  313. Many user programs contain the declaration @samp{long time ();}. In the
  314. past, the system header files on many systems did not actually declare
  315. @code{time}, so it did not matter what type your program declared it to
  316. return. But in systems with ISO C headers, @code{time} is declared to
  317. return @code{time_t}, and if that is not the same as @code{long}, then
  318. @samp{long time ();} is erroneous.
  319. The solution is to change your program to use appropriate system headers
  320. (@code{<time.h>} on systems with ISO C headers) and not to declare
  321. @code{time} if the system header files declare it, or failing that to
  322. use @code{time_t} as the return type of @code{time}.
  323. @cindex @code{float} as function value type
  324. @item
  325. When compiling functions that return @code{float}, PCC converts it to
  326. a double. GCC actually returns a @code{float}. If you are concerned
  327. with PCC compatibility, you should declare your functions to return
  328. @code{double}; you might as well say what you mean.
  329. @cindex structures
  330. @cindex unions
  331. @item
  332. When compiling functions that return structures or unions, GCC
  333. output code normally uses a method different from that used on most
  334. versions of Unix. As a result, code compiled with GCC cannot call
  335. a structure-returning function compiled with PCC, and vice versa.
  336. The method used by GCC is as follows: a structure or union which is
  337. 1, 2, 4 or 8 bytes long is returned like a scalar. A structure or union
  338. with any other size is stored into an address supplied by the caller
  339. (usually in a special, fixed register, but on some machines it is passed
  340. on the stack). The target hook @code{TARGET_STRUCT_VALUE_RTX}
  341. tells GCC where to pass this address.
  342. By contrast, PCC on most target machines returns structures and unions
  343. of any size by copying the data into an area of static storage, and then
  344. returning the address of that storage as if it were a pointer value.
  345. The caller must copy the data from that memory area to the place where
  346. the value is wanted. GCC does not use this method because it is
  347. slower and nonreentrant.
  348. On some newer machines, PCC uses a reentrant convention for all
  349. structure and union returning. GCC on most of these machines uses a
  350. compatible convention when returning structures and unions in memory,
  351. but still returns small structures and unions in registers.
  352. @opindex fpcc-struct-return
  353. You can tell GCC to use a compatible convention for all structure and
  354. union returning with the option @option{-fpcc-struct-return}.
  355. @cindex preprocessing tokens
  356. @cindex preprocessing numbers
  357. @item
  358. GCC complains about program fragments such as @samp{0x74ae-0x4000}
  359. which appear to be two hexadecimal constants separated by the minus
  360. operator. Actually, this string is a single @dfn{preprocessing token}.
  361. Each such token must correspond to one token in C@. Since this does not,
  362. GCC prints an error message. Although it may appear obvious that what
  363. is meant is an operator and two values, the ISO C standard specifically
  364. requires that this be treated as erroneous.
  365. A @dfn{preprocessing token} is a @dfn{preprocessing number} if it
  366. begins with a digit and is followed by letters, underscores, digits,
  367. periods and @samp{e+}, @samp{e-}, @samp{E+}, @samp{E-}, @samp{p+},
  368. @samp{p-}, @samp{P+}, or @samp{P-} character sequences. (In strict C90
  369. mode, the sequences @samp{p+}, @samp{p-}, @samp{P+} and @samp{P-} cannot
  370. appear in preprocessing numbers.)
  371. To make the above program fragment valid, place whitespace in front of
  372. the minus sign. This whitespace will end the preprocessing number.
  373. @end itemize
  374. @node Fixed Headers
  375. @section Fixed Header Files
  376. GCC needs to install corrected versions of some system header files.
  377. This is because most target systems have some header files that won't
  378. work with GCC unless they are changed. Some have bugs, some are
  379. incompatible with ISO C, and some depend on special features of other
  380. compilers.
  381. Installing GCC automatically creates and installs the fixed header
  382. files, by running a program called @code{fixincludes}. Normally, you
  383. don't need to pay attention to this. But there are cases where it
  384. doesn't do the right thing automatically.
  385. @itemize @bullet
  386. @item
  387. If you update the system's header files, such as by installing a new
  388. system version, the fixed header files of GCC are not automatically
  389. updated. They can be updated using the @command{mkheaders} script
  390. installed in
  391. @file{@var{libexecdir}/gcc/@var{target}/@var{version}/install-tools/}.
  392. @item
  393. On some systems, header file directories contain
  394. machine-specific symbolic links in certain places. This makes it
  395. possible to share most of the header files among hosts running the
  396. same version of the system on different machine models.
  397. The programs that fix the header files do not understand this special
  398. way of using symbolic links; therefore, the directory of fixed header
  399. files is good only for the machine model used to build it.
  400. It is possible to make separate sets of fixed header files for the
  401. different machine models, and arrange a structure of symbolic links so
  402. as to use the proper set, but you'll have to do this by hand.
  403. @end itemize
  404. @node Standard Libraries
  405. @section Standard Libraries
  406. @opindex Wall
  407. GCC by itself attempts to be a conforming freestanding implementation.
  408. @xref{Standards,,Language Standards Supported by GCC}, for details of
  409. what this means. Beyond the library facilities required of such an
  410. implementation, the rest of the C library is supplied by the vendor of
  411. the operating system. If that C library doesn't conform to the C
  412. standards, then your programs might get warnings (especially when using
  413. @option{-Wall}) that you don't expect.
  414. For example, the @code{sprintf} function on SunOS 4.1.3 returns
  415. @code{char *} while the C standard says that @code{sprintf} returns an
  416. @code{int}. The @code{fixincludes} program could make the prototype for
  417. this function match the Standard, but that would be wrong, since the
  418. function will still return @code{char *}.
  419. If you need a Standard compliant library, then you need to find one, as
  420. GCC does not provide one. The GNU C library (called @code{glibc})
  421. provides ISO C, POSIX, BSD, SystemV and X/Open compatibility for
  422. GNU/Linux and HURD-based GNU systems; no recent version of it supports
  423. other systems, though some very old versions did. Version 2.2 of the
  424. GNU C library includes nearly complete C99 support. You could also ask
  425. your operating system vendor if newer libraries are available.
  426. @node Disappointments
  427. @section Disappointments and Misunderstandings
  428. These problems are perhaps regrettable, but we don't know any practical
  429. way around them.
  430. @itemize @bullet
  431. @item
  432. Certain local variables aren't recognized by debuggers when you compile
  433. with optimization.
  434. This occurs because sometimes GCC optimizes the variable out of
  435. existence. There is no way to tell the debugger how to compute the
  436. value such a variable ``would have had'', and it is not clear that would
  437. be desirable anyway. So GCC simply does not mention the eliminated
  438. variable when it writes debugging information.
  439. You have to expect a certain amount of disagreement between the
  440. executable and your source code, when you use optimization.
  441. @cindex conflicting types
  442. @cindex scope of declaration
  443. @item
  444. Users often think it is a bug when GCC reports an error for code
  445. like this:
  446. @smallexample
  447. int foo (struct mumble *);
  448. struct mumble @{ @dots{} @};
  449. int foo (struct mumble *x)
  450. @{ @dots{} @}
  451. @end smallexample
  452. This code really is erroneous, because the scope of @code{struct
  453. mumble} in the prototype is limited to the argument list containing it.
  454. It does not refer to the @code{struct mumble} defined with file scope
  455. immediately below---they are two unrelated types with similar names in
  456. different scopes.
  457. But in the definition of @code{foo}, the file-scope type is used
  458. because that is available to be inherited. Thus, the definition and
  459. the prototype do not match, and you get an error.
  460. This behavior may seem silly, but it's what the ISO standard specifies.
  461. It is easy enough for you to make your code work by moving the
  462. definition of @code{struct mumble} above the prototype. It's not worth
  463. being incompatible with ISO C just to avoid an error for the example
  464. shown above.
  465. @item
  466. Accesses to bit-fields even in volatile objects works by accessing larger
  467. objects, such as a byte or a word. You cannot rely on what size of
  468. object is accessed in order to read or write the bit-field; it may even
  469. vary for a given bit-field according to the precise usage.
  470. If you care about controlling the amount of memory that is accessed, use
  471. volatile but do not use bit-fields.
  472. @item
  473. GCC comes with shell scripts to fix certain known problems in system
  474. header files. They install corrected copies of various header files in
  475. a special directory where only GCC will normally look for them. The
  476. scripts adapt to various systems by searching all the system header
  477. files for the problem cases that we know about.
  478. If new system header files are installed, nothing automatically arranges
  479. to update the corrected header files. They can be updated using the
  480. @command{mkheaders} script installed in
  481. @file{@var{libexecdir}/gcc/@var{target}/@var{version}/install-tools/}.
  482. @item
  483. @cindex floating point precision
  484. On 68000 and x86 systems, for instance, you can get paradoxical results
  485. if you test the precise values of floating point numbers. For example,
  486. you can find that a floating point value which is not a NaN is not equal
  487. to itself. This results from the fact that the floating point registers
  488. hold a few more bits of precision than fit in a @code{double} in memory.
  489. Compiled code moves values between memory and floating point registers
  490. at its convenience, and moving them into memory truncates them.
  491. @opindex ffloat-store
  492. You can partially avoid this problem by using the @option{-ffloat-store}
  493. option (@pxref{Optimize Options}).
  494. @item
  495. On AIX and other platforms without weak symbol support, templates
  496. need to be instantiated explicitly and symbols for static members
  497. of templates will not be generated.
  498. @item
  499. On AIX, GCC scans object files and library archives for static
  500. constructors and destructors when linking an application before the
  501. linker prunes unreferenced symbols. This is necessary to prevent the
  502. AIX linker from mistakenly assuming that static constructor or
  503. destructor are unused and removing them before the scanning can occur.
  504. All static constructors and destructors found will be referenced even
  505. though the modules in which they occur may not be used by the program.
  506. This may lead to both increased executable size and unexpected symbol
  507. references.
  508. @end itemize
  509. @node C++ Misunderstandings
  510. @section Common Misunderstandings with GNU C++
  511. @cindex misunderstandings in C++
  512. @cindex surprises in C++
  513. @cindex C++ misunderstandings
  514. C++ is a complex language and an evolving one, and its standard
  515. definition (the ISO C++ standard) was only recently completed. As a
  516. result, your C++ compiler may occasionally surprise you, even when its
  517. behavior is correct. This section discusses some areas that frequently
  518. give rise to questions of this sort.
  519. @menu
  520. * Static Definitions:: Static member declarations are not definitions
  521. * Name lookup:: Name lookup, templates, and accessing members of base classes
  522. * Temporaries:: Temporaries may vanish before you expect
  523. * Copy Assignment:: Copy Assignment operators copy virtual bases twice
  524. @end menu
  525. @node Static Definitions
  526. @subsection Declare @emph{and} Define Static Members
  527. @cindex C++ static data, declaring and defining
  528. @cindex static data in C++, declaring and defining
  529. @cindex declaring static data in C++
  530. @cindex defining static data in C++
  531. When a class has static data members, it is not enough to @emph{declare}
  532. the static member; you must also @emph{define} it. For example:
  533. @smallexample
  534. class Foo
  535. @{
  536. @dots{}
  537. void method();
  538. static int bar;
  539. @};
  540. @end smallexample
  541. This declaration only establishes that the class @code{Foo} has an
  542. @code{int} named @code{Foo::bar}, and a member function named
  543. @code{Foo::method}. But you still need to define @emph{both}
  544. @code{method} and @code{bar} elsewhere. According to the ISO
  545. standard, you must supply an initializer in one (and only one) source
  546. file, such as:
  547. @smallexample
  548. int Foo::bar = 0;
  549. @end smallexample
  550. Other C++ compilers may not correctly implement the standard behavior.
  551. As a result, when you switch to @command{g++} from one of these compilers,
  552. you may discover that a program that appeared to work correctly in fact
  553. does not conform to the standard: @command{g++} reports as undefined
  554. symbols any static data members that lack definitions.
  555. @node Name lookup
  556. @subsection Name Lookup, Templates, and Accessing Members of Base Classes
  557. @cindex base class members
  558. @cindex two-stage name lookup
  559. @cindex dependent name lookup
  560. The C++ standard prescribes that all names that are not dependent on
  561. template parameters are bound to their present definitions when parsing
  562. a template function or class.@footnote{The C++ standard just uses the
  563. term ``dependent'' for names that depend on the type or value of
  564. template parameters. This shorter term will also be used in the rest of
  565. this section.} Only names that are dependent are looked up at the point
  566. of instantiation. For example, consider
  567. @smallexample
  568. void foo(double);
  569. struct A @{
  570. template <typename T>
  571. void f () @{
  572. foo (1); // @r{1}
  573. int i = N; // @r{2}
  574. T t;
  575. t.bar(); // @r{3}
  576. foo (t); // @r{4}
  577. @}
  578. static const int N;
  579. @};
  580. @end smallexample
  581. Here, the names @code{foo} and @code{N} appear in a context that does
  582. not depend on the type of @code{T}. The compiler will thus require that
  583. they are defined in the context of use in the template, not only before
  584. the point of instantiation, and will here use @code{::foo(double)} and
  585. @code{A::N}, respectively. In particular, it will convert the integer
  586. value to a @code{double} when passing it to @code{::foo(double)}.
  587. Conversely, @code{bar} and the call to @code{foo} in the fourth marked
  588. line are used in contexts that do depend on the type of @code{T}, so
  589. they are only looked up at the point of instantiation, and you can
  590. provide declarations for them after declaring the template, but before
  591. instantiating it. In particular, if you instantiate @code{A::f<int>},
  592. the last line will call an overloaded @code{::foo(int)} if one was
  593. provided, even if after the declaration of @code{struct A}.
  594. This distinction between lookup of dependent and non-dependent names is
  595. called two-stage (or dependent) name lookup. G++ implements it
  596. since version 3.4.
  597. Two-stage name lookup sometimes leads to situations with behavior
  598. different from non-template codes. The most common is probably this:
  599. @smallexample
  600. template <typename T> struct Base @{
  601. int i;
  602. @};
  603. template <typename T> struct Derived : public Base<T> @{
  604. int get_i() @{ return i; @}
  605. @};
  606. @end smallexample
  607. In @code{get_i()}, @code{i} is not used in a dependent context, so the
  608. compiler will look for a name declared at the enclosing namespace scope
  609. (which is the global scope here). It will not look into the base class,
  610. since that is dependent and you may declare specializations of
  611. @code{Base} even after declaring @code{Derived}, so the compiler can't
  612. really know what @code{i} would refer to. If there is no global
  613. variable @code{i}, then you will get an error message.
  614. In order to make it clear that you want the member of the base class,
  615. you need to defer lookup until instantiation time, at which the base
  616. class is known. For this, you need to access @code{i} in a dependent
  617. context, by either using @code{this->i} (remember that @code{this} is of
  618. type @code{Derived<T>*}, so is obviously dependent), or using
  619. @code{Base<T>::i}. Alternatively, @code{Base<T>::i} might be brought
  620. into scope by a @code{using}-declaration.
  621. Another, similar example involves calling member functions of a base
  622. class:
  623. @smallexample
  624. template <typename T> struct Base @{
  625. int f();
  626. @};
  627. template <typename T> struct Derived : Base<T> @{
  628. int g() @{ return f(); @};
  629. @};
  630. @end smallexample
  631. Again, the call to @code{f()} is not dependent on template arguments
  632. (there are no arguments that depend on the type @code{T}, and it is also
  633. not otherwise specified that the call should be in a dependent context).
  634. Thus a global declaration of such a function must be available, since
  635. the one in the base class is not visible until instantiation time. The
  636. compiler will consequently produce the following error message:
  637. @smallexample
  638. x.cc: In member function `int Derived<T>::g()':
  639. x.cc:6: error: there are no arguments to `f' that depend on a template
  640. parameter, so a declaration of `f' must be available
  641. x.cc:6: error: (if you use `-fpermissive', G++ will accept your code, but
  642. allowing the use of an undeclared name is deprecated)
  643. @end smallexample
  644. To make the code valid either use @code{this->f()}, or
  645. @code{Base<T>::f()}. Using the @option{-fpermissive} flag will also let
  646. the compiler accept the code, by marking all function calls for which no
  647. declaration is visible at the time of definition of the template for
  648. later lookup at instantiation time, as if it were a dependent call.
  649. We do not recommend using @option{-fpermissive} to work around invalid
  650. code, and it will also only catch cases where functions in base classes
  651. are called, not where variables in base classes are used (as in the
  652. example above).
  653. Note that some compilers (including G++ versions prior to 3.4) get these
  654. examples wrong and accept above code without an error. Those compilers
  655. do not implement two-stage name lookup correctly.
  656. @node Temporaries
  657. @subsection Temporaries May Vanish Before You Expect
  658. @cindex temporaries, lifetime of
  659. @cindex portions of temporary objects, pointers to
  660. It is dangerous to use pointers or references to @emph{portions} of a
  661. temporary object. The compiler may very well delete the object before
  662. you expect it to, leaving a pointer to garbage. The most common place
  663. where this problem crops up is in classes like string classes,
  664. especially ones that define a conversion function to type @code{char *}
  665. or @code{const char *}---which is one reason why the standard
  666. @code{string} class requires you to call the @code{c_str} member
  667. function. However, any class that returns a pointer to some internal
  668. structure is potentially subject to this problem.
  669. For example, a program may use a function @code{strfunc} that returns
  670. @code{string} objects, and another function @code{charfunc} that
  671. operates on pointers to @code{char}:
  672. @smallexample
  673. string strfunc ();
  674. void charfunc (const char *);
  675. void
  676. f ()
  677. @{
  678. const char *p = strfunc().c_str();
  679. @dots{}
  680. charfunc (p);
  681. @dots{}
  682. charfunc (p);
  683. @}
  684. @end smallexample
  685. @noindent
  686. In this situation, it may seem reasonable to save a pointer to the C
  687. string returned by the @code{c_str} member function and use that rather
  688. than call @code{c_str} repeatedly. However, the temporary string
  689. created by the call to @code{strfunc} is destroyed after @code{p} is
  690. initialized, at which point @code{p} is left pointing to freed memory.
  691. Code like this may run successfully under some other compilers,
  692. particularly obsolete cfront-based compilers that delete temporaries
  693. along with normal local variables. However, the GNU C++ behavior is
  694. standard-conforming, so if your program depends on late destruction of
  695. temporaries it is not portable.
  696. The safe way to write such code is to give the temporary a name, which
  697. forces it to remain until the end of the scope of the name. For
  698. example:
  699. @smallexample
  700. const string& tmp = strfunc ();
  701. charfunc (tmp.c_str ());
  702. @end smallexample
  703. @node Copy Assignment
  704. @subsection Implicit Copy-Assignment for Virtual Bases
  705. When a base class is virtual, only one subobject of the base class
  706. belongs to each full object. Also, the constructors and destructors are
  707. invoked only once, and called from the most-derived class. However, such
  708. objects behave unspecified when being assigned. For example:
  709. @smallexample
  710. struct Base@{
  711. char *name;
  712. Base(char *n) : name(strdup(n))@{@}
  713. Base& operator= (const Base& other)@{
  714. free (name);
  715. name = strdup (other.name);
  716. @}
  717. @};
  718. struct A:virtual Base@{
  719. int val;
  720. A():Base("A")@{@}
  721. @};
  722. struct B:virtual Base@{
  723. int bval;
  724. B():Base("B")@{@}
  725. @};
  726. struct Derived:public A, public B@{
  727. Derived():Base("Derived")@{@}
  728. @};
  729. void func(Derived &d1, Derived &d2)
  730. @{
  731. d1 = d2;
  732. @}
  733. @end smallexample
  734. The C++ standard specifies that @samp{Base::Base} is only called once
  735. when constructing or copy-constructing a Derived object. It is
  736. unspecified whether @samp{Base::operator=} is called more than once when
  737. the implicit copy-assignment for Derived objects is invoked (as it is
  738. inside @samp{func} in the example).
  739. G++ implements the ``intuitive'' algorithm for copy-assignment: assign all
  740. direct bases, then assign all members. In that algorithm, the virtual
  741. base subobject can be encountered more than once. In the example, copying
  742. proceeds in the following order: @samp{val}, @samp{name} (via
  743. @code{strdup}), @samp{bval}, and @samp{name} again.
  744. If application code relies on copy-assignment, a user-defined
  745. copy-assignment operator removes any uncertainties. With such an
  746. operator, the application can define whether and how the virtual base
  747. subobject is assigned.
  748. @node Non-bugs
  749. @section Certain Changes We Don't Want to Make
  750. This section lists changes that people frequently request, but which
  751. we do not make because we think GCC is better without them.
  752. @itemize @bullet
  753. @item
  754. Checking the number and type of arguments to a function which has an
  755. old-fashioned definition and no prototype.
  756. Such a feature would work only occasionally---only for calls that appear
  757. in the same file as the called function, following the definition. The
  758. only way to check all calls reliably is to add a prototype for the
  759. function. But adding a prototype eliminates the motivation for this
  760. feature. So the feature is not worthwhile.
  761. @item
  762. Warning about using an expression whose type is signed as a shift count.
  763. Shift count operands are probably signed more often than unsigned.
  764. Warning about this would cause far more annoyance than good.
  765. @item
  766. Warning about assigning a signed value to an unsigned variable.
  767. Such assignments must be very common; warning about them would cause
  768. more annoyance than good.
  769. @item
  770. Warning when a non-void function value is ignored.
  771. C contains many standard functions that return a value that most
  772. programs choose to ignore. One obvious example is @code{printf}.
  773. Warning about this practice only leads the defensive programmer to
  774. clutter programs with dozens of casts to @code{void}. Such casts are
  775. required so frequently that they become visual noise. Writing those
  776. casts becomes so automatic that they no longer convey useful
  777. information about the intentions of the programmer. For functions
  778. where the return value should never be ignored, use the
  779. @code{warn_unused_result} function attribute (@pxref{Function
  780. Attributes}).
  781. @item
  782. @opindex fshort-enums
  783. Making @option{-fshort-enums} the default.
  784. This would cause storage layout to be incompatible with most other C
  785. compilers. And it doesn't seem very important, given that you can get
  786. the same result in other ways. The case where it matters most is when
  787. the enumeration-valued object is inside a structure, and in that case
  788. you can specify a field width explicitly.
  789. @item
  790. Making bit-fields unsigned by default on particular machines where ``the
  791. ABI standard'' says to do so.
  792. The ISO C standard leaves it up to the implementation whether a bit-field
  793. declared plain @code{int} is signed or not. This in effect creates two
  794. alternative dialects of C@.
  795. @opindex fsigned-bitfields
  796. @opindex funsigned-bitfields
  797. The GNU C compiler supports both dialects; you can specify the signed
  798. dialect with @option{-fsigned-bitfields} and the unsigned dialect with
  799. @option{-funsigned-bitfields}. However, this leaves open the question of
  800. which dialect to use by default.
  801. Currently, the preferred dialect makes plain bit-fields signed, because
  802. this is simplest. Since @code{int} is the same as @code{signed int} in
  803. every other context, it is cleanest for them to be the same in bit-fields
  804. as well.
  805. Some computer manufacturers have published Application Binary Interface
  806. standards which specify that plain bit-fields should be unsigned. It is
  807. a mistake, however, to say anything about this issue in an ABI@. This is
  808. because the handling of plain bit-fields distinguishes two dialects of C@.
  809. Both dialects are meaningful on every type of machine. Whether a
  810. particular object file was compiled using signed bit-fields or unsigned
  811. is of no concern to other object files, even if they access the same
  812. bit-fields in the same data structures.
  813. A given program is written in one or the other of these two dialects.
  814. The program stands a chance to work on most any machine if it is
  815. compiled with the proper dialect. It is unlikely to work at all if
  816. compiled with the wrong dialect.
  817. Many users appreciate the GNU C compiler because it provides an
  818. environment that is uniform across machines. These users would be
  819. inconvenienced if the compiler treated plain bit-fields differently on
  820. certain machines.
  821. Occasionally users write programs intended only for a particular machine
  822. type. On these occasions, the users would benefit if the GNU C compiler
  823. were to support by default the same dialect as the other compilers on
  824. that machine. But such applications are rare. And users writing a
  825. program to run on more than one type of machine cannot possibly benefit
  826. from this kind of compatibility.
  827. This is why GCC does and will treat plain bit-fields in the same
  828. fashion on all types of machines (by default).
  829. There are some arguments for making bit-fields unsigned by default on all
  830. machines. If, for example, this becomes a universal de facto standard,
  831. it would make sense for GCC to go along with it. This is something
  832. to be considered in the future.
  833. (Of course, users strongly concerned about portability should indicate
  834. explicitly in each bit-field whether it is signed or not. In this way,
  835. they write programs which have the same meaning in both C dialects.)
  836. @item
  837. @opindex ansi
  838. @opindex std
  839. Undefining @code{__STDC__} when @option{-ansi} is not used.
  840. Currently, GCC defines @code{__STDC__} unconditionally. This provides
  841. good results in practice.
  842. Programmers normally use conditionals on @code{__STDC__} to ask whether
  843. it is safe to use certain features of ISO C, such as function
  844. prototypes or ISO token concatenation. Since plain @command{gcc} supports
  845. all the features of ISO C, the correct answer to these questions is
  846. ``yes''.
  847. Some users try to use @code{__STDC__} to check for the availability of
  848. certain library facilities. This is actually incorrect usage in an ISO
  849. C program, because the ISO C standard says that a conforming
  850. freestanding implementation should define @code{__STDC__} even though it
  851. does not have the library facilities. @samp{gcc -ansi -pedantic} is a
  852. conforming freestanding implementation, and it is therefore required to
  853. define @code{__STDC__}, even though it does not come with an ISO C
  854. library.
  855. Sometimes people say that defining @code{__STDC__} in a compiler that
  856. does not completely conform to the ISO C standard somehow violates the
  857. standard. This is illogical. The standard is a standard for compilers
  858. that claim to support ISO C, such as @samp{gcc -ansi}---not for other
  859. compilers such as plain @command{gcc}. Whatever the ISO C standard says
  860. is relevant to the design of plain @command{gcc} without @option{-ansi} only
  861. for pragmatic reasons, not as a requirement.
  862. GCC normally defines @code{__STDC__} to be 1, and in addition
  863. defines @code{__STRICT_ANSI__} if you specify the @option{-ansi} option,
  864. or a @option{-std} option for strict conformance to some version of ISO C@.
  865. On some hosts, system include files use a different convention, where
  866. @code{__STDC__} is normally 0, but is 1 if the user specifies strict
  867. conformance to the C Standard. GCC follows the host convention when
  868. processing system include files, but when processing user files it follows
  869. the usual GNU C convention.
  870. @item
  871. Undefining @code{__STDC__} in C++.
  872. Programs written to compile with C++-to-C translators get the
  873. value of @code{__STDC__} that goes with the C compiler that is
  874. subsequently used. These programs must test @code{__STDC__}
  875. to determine what kind of C preprocessor that compiler uses:
  876. whether they should concatenate tokens in the ISO C fashion
  877. or in the traditional fashion.
  878. These programs work properly with GNU C++ if @code{__STDC__} is defined.
  879. They would not work otherwise.
  880. In addition, many header files are written to provide prototypes in ISO
  881. C but not in traditional C@. Many of these header files can work without
  882. change in C++ provided @code{__STDC__} is defined. If @code{__STDC__}
  883. is not defined, they will all fail, and will all need to be changed to
  884. test explicitly for C++ as well.
  885. @item
  886. Deleting ``empty'' loops.
  887. Historically, GCC has not deleted ``empty'' loops under the
  888. assumption that the most likely reason you would put one in a program is
  889. to have a delay, so deleting them will not make real programs run any
  890. faster.
  891. However, the rationale here is that optimization of a nonempty loop
  892. cannot produce an empty one. This held for carefully written C compiled
  893. with less powerful optimizers but is not always the case for carefully
  894. written C++ or with more powerful optimizers.
  895. Thus GCC will remove operations from loops whenever it can determine
  896. those operations are not externally visible (apart from the time taken
  897. to execute them, of course). In case the loop can be proved to be finite,
  898. GCC will also remove the loop itself.
  899. Be aware of this when performing timing tests, for instance the
  900. following loop can be completely removed, provided
  901. @code{some_expression} can provably not change any global state.
  902. @smallexample
  903. @{
  904. int sum = 0;
  905. int ix;
  906. for (ix = 0; ix != 10000; ix++)
  907. sum += some_expression;
  908. @}
  909. @end smallexample
  910. Even though @code{sum} is accumulated in the loop, no use is made of
  911. that summation, so the accumulation can be removed.
  912. @item
  913. Making side effects happen in the same order as in some other compiler.
  914. @cindex side effects, order of evaluation
  915. @cindex order of evaluation, side effects
  916. It is never safe to depend on the order of evaluation of side effects.
  917. For example, a function call like this may very well behave differently
  918. from one compiler to another:
  919. @smallexample
  920. void func (int, int);
  921. int i = 2;
  922. func (i++, i++);
  923. @end smallexample
  924. There is no guarantee (in either the C or the C++ standard language
  925. definitions) that the increments will be evaluated in any particular
  926. order. Either increment might happen first. @code{func} might get the
  927. arguments @samp{2, 3}, or it might get @samp{3, 2}, or even @samp{2, 2}.
  928. @item
  929. Making certain warnings into errors by default.
  930. Some ISO C testsuites report failure when the compiler does not produce
  931. an error message for a certain program.
  932. @opindex pedantic-errors
  933. ISO C requires a ``diagnostic'' message for certain kinds of invalid
  934. programs, but a warning is defined by GCC to count as a diagnostic. If
  935. GCC produces a warning but not an error, that is correct ISO C support.
  936. If testsuites call this ``failure'', they should be run with the GCC
  937. option @option{-pedantic-errors}, which will turn these warnings into
  938. errors.
  939. @end itemize
  940. @node Warnings and Errors
  941. @section Warning Messages and Error Messages
  942. @cindex error messages
  943. @cindex warnings vs errors
  944. @cindex messages, warning and error
  945. The GNU compiler can produce two kinds of diagnostics: errors and
  946. warnings. Each kind has a different purpose:
  947. @itemize @w{}
  948. @item
  949. @dfn{Errors} report problems that make it impossible to compile your
  950. program. GCC reports errors with the source file name and line
  951. number where the problem is apparent.
  952. @item
  953. @dfn{Warnings} report other unusual conditions in your code that
  954. @emph{may} indicate a problem, although compilation can (and does)
  955. proceed. Warning messages also report the source file name and line
  956. number, but include the text @samp{warning:} to distinguish them
  957. from error messages.
  958. @end itemize
  959. Warnings may indicate danger points where you should check to make sure
  960. that your program really does what you intend; or the use of obsolete
  961. features; or the use of nonstandard features of GNU C or C++. Many
  962. warnings are issued only if you ask for them, with one of the @option{-W}
  963. options (for instance, @option{-Wall} requests a variety of useful
  964. warnings).
  965. @opindex pedantic
  966. @opindex pedantic-errors
  967. GCC always tries to compile your program if possible; it never
  968. gratuitously rejects a program whose meaning is clear merely because
  969. (for instance) it fails to conform to a standard. In some cases,
  970. however, the C and C++ standards specify that certain extensions are
  971. forbidden, and a diagnostic @emph{must} be issued by a conforming
  972. compiler. The @option{-pedantic} option tells GCC to issue warnings in
  973. such cases; @option{-pedantic-errors} says to make them errors instead.
  974. This does not mean that @emph{all} non-ISO constructs get warnings
  975. or errors.
  976. @xref{Warning Options,,Options to Request or Suppress Warnings}, for
  977. more detail on these and related command-line options.