| blob | 96e9ca74e7b5adbb8d0a67cdd9868ca45b3677e7 |
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- D E B U G --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1992-2005, Free Software Foundation, Inc. --
10 -- --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 2, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING. If not, write --
19 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, USA. --
21 -- --
22 -- As a special exception, if other files instantiate generics from this --
23 -- unit, or you link this unit with other files to produce an executable, --
24 -- this unit does not by itself cause the resulting executable to be --
25 -- covered by the GNU General Public License. This exception does not --
26 -- however invalidate any other reasons why the executable file might be --
27 -- covered by the GNU Public License. --
28 -- --
29 -- GNAT was originally developed by the GNAT team at New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
31 -- --
32 ------------------------------------------------------------------------------
36 ---------------------------------
37 -- Summary of Debug Flag Usage --
38 ---------------------------------
40 -- Debug flags for compiler (GNAT1)
42 -- da Generate messages tracking semantic analyzer progress
43 -- db Show encoding of type names for debug output
44 -- dc List names of units as they are compiled
45 -- dd Dynamic allocation of tables messages generated
46 -- de List the entity table
47 -- df Full tree/source print (includes withed units)
48 -- dg Print source from tree (generated code only)
49 -- dh Generate listing showing loading of name table hash chains
50 -- di Generate messages for visibility linking/delinking
51 -- dj Suppress "junk null check" for access parameter values
52 -- dk Generate GNATBUG message on abort, even if previous errors
53 -- dl Generate unit load trace messages
54 -- dm Allow VMS features even if not OpenVMS version
55 -- dn Generate messages for node/list allocation
56 -- do Print source from tree (original code only)
57 -- dp Generate messages for parser scope stack push/pops
58 -- dq No auto-alignment of small records
59 -- dr Generate parser resynchronization messages
60 -- ds Print source from tree (including original and generated stuff)
61 -- dt Print full tree
62 -- du Uncheck categorization pragmas
63 -- dv Output trace of overload resolution
64 -- dw Print trace of semantic scope stack
65 -- dx Force expansion on, even if no code being generated
66 -- dy Print tree of package Standard
67 -- dz Print source of package Standard
69 -- dA All entities included in representation information output
70 -- dB Output debug encoding of type names and variants
71 -- dC Output debugging information on check suppression
72 -- dD Delete elaboration checks in inner level routines
73 -- dE Apply elaboration checks to predefined units
74 -- dF Front end data layout enabled.
75 -- dG Generate all warnings including those normally suppressed
76 -- dH Hold (kill) call to gigi
77 -- dI Inhibit internal name numbering in gnatG listing
78 -- dJ Output debugging trace info for JGNAT (Java VM version of GNAT)
79 -- dK Kill all error messages
80 -- dL Output trace information on elaboration checking
81 -- dM Asssume all variables are modified (no current values)
82 -- dN No file name information in exception messages
83 -- dO Output immediate error messages
84 -- dP Do not check for controlled objects in preelaborable packages
85 -- dQ
86 -- dR Bypass check for correct version of s-rpc
87 -- dS Never convert numbers to machine numbers in Sem_Eval
88 -- dT Convert to machine numbers only for constant declarations
89 -- dU Enable garbage collection of unreachable entities
90 -- dV Enable viewing of all symbols in debugger
91 -- dW Disable warnings on calls for IN OUT parameters
92 -- dX
93 -- dY Enable configurable run-time mode
94 -- dZ Generate listing showing the contents of the dispatch tables
96 -- d.a
97 -- d.b
98 -- d.c
99 -- d.d
100 -- d.e
101 -- d.f Inhibit folding of static expressions
102 -- d.g
103 -- d.h
104 -- d.i
105 -- d.j
106 -- d.k
107 -- d.l
108 -- d.m
109 -- d.n
110 -- d.o
111 -- d.p
112 -- d.q
113 -- d.r
114 -- d.s
115 -- d.t
116 -- d.u
117 -- d.v
118 -- d.w
119 -- d.x No exception handlers
120 -- d.y
121 -- d.z
123 -- d1 Error msgs have node numbers where possible
124 -- d2 Eliminate error flags in verbose form error messages
125 -- d3 Dump bad node in Comperr on an abort
126 -- d4 Inhibit automatic krunch of predefined library unit files
127 -- d5 Debug output for tree read/write
128 -- d6 Default access unconstrained to thin pointers
129 -- d7 Do not output version & file time stamp in -gnatv or -gnatl mode
130 -- d8 Force opposite endianness in packed stuff
131 -- d9
133 -- Debug flags for binder (GNATBIND)
135 -- da All links (including internal units) listed if there is a cycle
136 -- db
137 -- dc List units as they are chosen
138 -- dd
139 -- de Elaboration dependencies including system units
140 -- df
141 -- dg
142 -- dh
143 -- di Ignore_Errors mode for reading ali files
144 -- dj
145 -- dk
146 -- dl
147 -- dm
148 -- dn List details of manipulation of Num_Pred values
149 -- do
150 -- dp
151 -- dq
152 -- dr
153 -- ds
154 -- dt
155 -- du List units as they are acquired
156 -- dv
157 -- dw
158 -- dx Force binder to read xref information from ali files
159 -- dy
160 -- dz
162 -- d1
163 -- d2
164 -- d3
165 -- d4
166 -- d5
167 -- d6
168 -- d7
169 -- d8
170 -- d9
172 -- Debug flags used in package Make and its clients (e.g. GNATMAKE)
174 -- da
175 -- db
176 -- dc
177 -- dd
178 -- de
179 -- df
180 -- dg
181 -- dh
182 -- di
183 -- dj
184 -- dk
185 -- dl
186 -- dm
187 -- dn Do not delete temp files created by gnatmake
188 -- do
189 -- dp Prints the contents of the Q used by Make.Compile_Sources
190 -- dq Prints source files as they are enqueued and dequeued
191 -- dr
192 -- ds
193 -- dt Display time stamps when there is a mismatch
194 -- du List units as their ali files are acquired
195 -- dv
196 -- dw Prints the list of units withed by the unit currently explored
197 -- dx
198 -- dy
199 -- dz
201 -- d1
202 -- d2
203 -- d3
204 -- d4
205 -- d5
206 -- d6
207 -- d7
208 -- d8
209 -- d9
211 --------------------------------------------
212 -- Documentation for Compiler Debug Flags --
213 --------------------------------------------
215 -- da Generate messages tracking semantic analyzer progress. A message
216 -- is output showing each node as it gets analyzed, expanded,
217 -- resolved, or evaluated. This option is useful for finding out
218 -- exactly where a bomb during semantic analysis is occurring.
220 -- db In Exp_Dbug, certain type names are encoded to include debugging
221 -- information. This debug switch causes lines to be output showing
222 -- the encodings used.
224 -- dc List names of units as they are compiled. One line of output will
225 -- be generated at the start of compiling each unit (package or
226 -- subprogram).
228 -- dd Dynamic allocation of tables messages generated. Each time a
229 -- table is reallocated, a line is output indicating the expansion.
231 -- de List the entity table
233 -- df Full tree/source print (includes withed units). Normally the tree
234 -- output (dt) or recreated source output (dg,do,ds) includes only
235 -- the main unit. If df is set, then the output in either case
236 -- includes all compiled units (see also dg,do,ds,dt). Note that to
237 -- be effective, this swich must be used in combination with one or
238 -- more of dt, dg, do or ds.
240 -- dg Print the source recreated from the generated tree. In the case
241 -- where the tree has been rewritten this output includes only the
242 -- generated code, not the original code (see also df,do,ds,dz).
243 -- This flag differs from -gnatG in that the output also includes
244 -- non-source generated null statements, and freeze nodes, which
245 -- are normally omitted in -gnatG mode.
247 -- dh Generates a table at the end of a compilation showing how the hash
248 -- table chains built by the Namet package are loaded. This is useful
249 -- in ensuring that the hashing algorithm (in Namet.Hash) is working
250 -- effectively with typical sets of program identifiers.
252 -- di Generate messages for visibility linking/delinking
254 -- dj Suppress "junk null check" for access parameters. This flag permits
255 -- Ada programs to pass null parameters to access parameters, and to
256 -- explicitly check such access values against the null literal.
257 -- Neither of these is valid Ada, but both were allowed in versions of
258 -- GNAT before 3.10, so this switch can ease the transition process.
260 -- dk Immediate kill on abort. Normally on an abort (i.e. a call to
261 -- Comperr.Compiler_Abort), the GNATBUG message is not given if
262 -- there is a previous error. This debug switch bypasses this test
263 -- and gives the message unconditionally (useful for debugging).
265 -- dl Generate unit load trace messages. A line of traceback output is
266 -- generated each time a request is made to the library manager to
267 -- load a new unit.
269 -- dm Some features are permitted only in OpenVMS ports of GNAT (e.g.
270 -- the specification of passing by descriptor). Normally any use
271 -- of these features will be flagged as an error, but this debug
272 -- flag allows acceptance of these features in non OpenVMS ports.
273 -- Of course they may not have any useful effect, and in particular
274 -- attempting to generate code with this flag set may blow up.
275 -- The flag also forces the use of 64-bits for Long_Integer.
277 -- dn Generate messages for node/list allocation. Each time a node or
278 -- list header is allocated, a line of output is generated. Certain
279 -- other basic tree operations also cause a line of output to be
280 -- generated. This option is useful in seeing where the parser is
281 -- blowing up.;
283 -- do Print the source recreated from the generated tree. In the case
284 -- where the tree has been rewritten, this output includes only the
285 -- original code, not the generated code (see also df,dg,ds,dz).
287 -- dp Generate messages for parser scope stack push/pops. A line of
288 -- output by the parser each time the parser scope stack is either
289 -- pushed or popped. Useful in debugging situations where the
290 -- parser scope stack ends up incorrectly synchronized
292 -- dq In layout version 1.38, 2002/01/12, a circuit was implemented
293 -- to give decent default alignment to short records that had no
294 -- specific alignment set. This debug option restores the previous
295 -- behavior of giving such records poor alignments, typically 1.
296 -- This may be useful in dealing with transition.
298 -- dr Generate parser resynchronization messages. Normally the parser
299 -- resynchronizes quietly. With this debug option, two messages
300 -- are generated, one when the parser starts a resynchronization
301 -- skip, and another when it resumes parsing. Useful in debugging
302 -- inadequate error recovery situations.
304 -- ds Print the source recreated from the generated tree. In the case
305 -- where the tree has been rewritten this output includes both the
306 -- generated code and the original code with the generated code
307 -- being enlosed in curly brackets (see also df,do,ds,dz)
309 -- dt Print full tree. The generated tree is output (see also df,dy)
311 -- du Uncheck categorization pragmas. This debug switch causes the
312 -- categorization pragmas (Pure, Preelaborate etc) to be ignored
313 -- so that normal checks are not made (this is particularly useful
314 -- for adding temporary debugging code to units that have pragmas
315 -- that are inconsistent with the debugging code added.
317 -- dv Output trace of overload resolution. Outputs messages for
318 -- overload attempts that involve cascaded errors, or where
319 -- an interepretation is incompatible with the context.
321 -- dw Write semantic scope stack messages. Each time a scope is created
322 -- or removed, a message is output (see the Sem_Ch8.New_Scope and
323 -- Sem_Ch8.Pop_Scope subprograms).
325 -- dx Force expansion on, even if no code being generated. Normally the
326 -- expander is inhibited if no code is generated. This switch forces
327 -- expansion to proceed normally even if the backend is not being
328 -- called. This is particularly useful for debugging purposes when
329 -- using the front-end only version of the compiler (which normally
330 -- would never do any expansion).
332 -- dy Print tree of package Standard. Normally the tree print out does
333 -- not include package Standard, even if the -df switch is set. This
334 -- switch forces output of the internal tree built for Standard.
336 -- dz Print source of package Standard. Normally the source print out
337 -- does not include package Standard, even if the -df switch is set.
338 -- This switch forces output of the source recreated from the internal
339 -- tree built for Standard. Note that this differs from -gnatS in
340 -- that it prints from the actual tree using the normal Sprint
341 -- circuitry for printing trees.
343 -- dA Forces output of representation information, including full
344 -- information for all internal type and object entities, as well
345 -- as all user defined type and object entities including private
346 -- and incomplete types. This debug switch also automatically sets
347 -- the equivalent of -gnatR3m.
349 -- dB Output debug encodings for types and variants. See Exp_Dbug for
350 -- exact form of the generated output.
352 -- dC Output trace information showing the decisions made during
353 -- check suppression activity in unit Checks.
355 -- dD Delete new elaboration checks. This flag causes GNAT to return
356 -- to the 3.13a elaboration semantics, and to suppress the fixing
357 -- of two bugs. The first is in the context of inner routines in
358 -- dynamic elaboration mode, when the subprogram we are in was
359 -- called at elaboration time by a unit that was also compiled with
360 -- dynamic elaboration checks. In this case, if A calls B calls C,
361 -- and all are in different units, we need an elaboration check at
362 -- each call. These nested checks were only put in recently (see
363 -- version 1.80 of Sem_Elab) and we provide this debug flag to
364 -- revert to the previous behavior in case of regressions. The
365 -- other behavior reverted by this flag is the treatment of the
366 -- Elaborate_Body pragma in static elaboration mode. This used to
367 -- be treated as not needing elaboration checking, but in fact in
368 -- general Elaborate_All is still required because of nested calls.
370 -- dE Apply compile time elaboration checking for with relations between
371 -- predefined units. Normally no checks are made (it seems that at
372 -- least on the SGI, such checks run into trouble).
374 -- dF Front end data layout enabled. Normally front end data layout
375 -- is only enabled if the target parameter Backend_Layout is False.
376 -- This debugging switch enables it unconditionally.
378 -- dG Generate all warnings. Normally Errout suppresses warnings on
379 -- units that are not part of the main extended source, and also
380 -- suppresses warnings on instantiations in the main extended
381 -- source that duplicate warnings already posted on the template.
382 -- This switch stops both kinds of deletion and causes Errout to
383 -- post all warnings sent to it.
385 -- dH Inhibit call to gigi. This is useful for testing front end data
386 -- layout, and may be useful in other debugging situations where
387 -- you do not want gigi to intefere with the testing.
389 -- dI Inhibit internal name numbering in gnatDG listing. For internal
390 -- names of the form <uppercase-letters><digits><suffix>, the output
391 -- will be modified to <uppercase-letters>...<suffix>. This is used
392 -- in the fixed bugs run to minimize system and version dependency
393 -- in filed -gnatDG output.
395 -- dJ Generate debugging trace output for the JGNAT back end. This
396 -- consists of symbolic Java Byte Code sequences for all generated
397 -- classes plus additional information to indicate local variables
398 -- and methods.
400 -- dK Kill all error messages. This debug flag suppresses the output
401 -- of all error messages. It is used in regression tests where the
402 -- error messages are target dependent and irrelevant.
404 -- dL Output trace information on elaboration checking. This debug
405 -- switch causes output to be generated showing each call or
406 -- instantiation as it is checked, and the progress of the recursive
407 -- trace through calls at elaboration time.
409 -- dM Assume all variables have been modified, and ignore current value
410 -- indications. This debug flag disconnects the tracking of constant
411 -- values (see Exp_Ch2.Expand_Current_Value).
413 -- dN Do not generate file name information in exception messages
415 -- dO Output immediate error messages. This causes error messages to
416 -- be output as soon as they are generated (disconnecting several
417 -- circuits for improvement of messages, deletion of duplicate
418 -- messages etc). Useful to diagnose compiler bombs caused by
419 -- erroneous handling of error situations
421 -- dP Do not check for controlled objects in preelaborable packages.
422 -- RM 10.2.1(9) forbids the use of library level controlled objects
423 -- in preelaborable packages, but this restriction is a huge pain,
424 -- especially in the predefined library units.
426 -- dR Bypass the check for a proper version of s-rpc being present
427 -- to use the -gnatz? switch. This allows debugging of the use
428 -- of stubs generation without needing to have GLADE (or some
429 -- other PCS installed).
431 -- dS Omit conversion of fpt numbers to exact machine numbers in
432 -- non-static evaluation contexts (see Check_Non_Static_Context).
433 -- This is intended for testing out timing problems with this
434 -- conversion circuit.
436 -- dT Similar to dS, but omits the conversions only in the case where
437 -- the parent is not a constant declaration.
439 -- dU Enable garbage collection of unreachable entities. This enables
440 -- both the reachability analysis and changing the Is_Public and
441 -- Is_Eliminated flags.
443 -- dV Enable viewing of all symbols in debugger. Causes debug information
444 -- to be generated for all symbols, including internal symbols. This
445 -- is enabled by default for -gnatD, but this switch allows this to
446 -- be enabled without generating modified source files. Note that the
447 -- use of -gnatdV ensures in the dwarf/elf case that all symbols that
448 -- are present in the elf tables are also in the dwarf tables (which
449 -- seems to be required by some tools). Another effect of dV is to
450 -- generate full qualified names, including internal names generated
451 -- for blocks and loops.
453 -- dW Disable warnings when a possibly uninitialized scalar value is
454 -- passed to an IN OUT parameter of a procedure. This usage is a
455 -- quite improper bounded error [erroneous in Ada 83] situation,
456 -- and would normally generate a warning. However, to ease the
457 -- task of transitioning incorrect legacy code, we provide this
458 -- undocumented feature for suppressing these warnings.
460 -- dY Enable configurable run-time mode, just as though the System file
461 -- had Configurable_Run_Time_Mode set to True. This is useful in
462 -- testing high integrity mode.
464 -- d.f Suppress folding of static expressions. This of course results
465 -- in seriously non-conforming behavior, but is useful sometimes
466 -- when tracking down handling of complex expressions.
468 -- d.x No exception handlers in generated code. This causes exception
469 -- handlers to be eliminated from the generated code. They are still
470 -- fully compiled and analyzed, they just get eliminated from the
471 -- code generation step.
473 -- d1 Error messages have node numbers where possible. Normally error
474 -- messages have only source locations. This option is useful when
475 -- debugging errors caused by expanded code, where the source location
476 -- does not give enough information.
478 -- d2 Suppress output of the error position flags for verbose form error
479 -- messages. The messages are still interspersed in the listing, but
480 -- without any error flags or extra blank lines. Also causes an extra
481 -- <<< to be output at the right margin. This is intended to be the
482 -- easiest format for checking conformance of ACATS B tests. This
483 -- flag also suppresses the additional messages explaining why a
484 -- non-static expression is non-static (see Sem_Eval.Why_Not_Static).
485 -- This avoids having to worry about these messages in ACATS testing.
487 -- d3 Causes Comperr to dump the contents of the node for which an abort
488 -- was detected (normally only the Node_Id of the node is output).
490 -- d4 Inhibits automatic krunching of predefined library unit file names.
491 -- Normally, as described in the spec of package Krunch, such files
492 -- are automatically krunched to 8 characters, with special treatment
493 -- of the prefixes Ada, System, and Interfaces. Setting this debug
494 -- switch disables this special treatment.
496 -- d5 Causes the tree read/write circuit to output detailed information
497 -- tracking the data that is read and written element by element.
499 -- d6 Normally access-to-unconstrained-array types are represented
500 -- using fat (double) pointers. Using this debug flag causes them
501 -- to default to thin. This can be used to test the performance
502 -- implications of using thin pointers, and also to test that the
503 -- compiler functions correctly with this choice.
505 -- d7 Normally a -gnatl or -gnatv listing includes the time stamp
506 -- of the source file. This debug flag suppresses this output,
507 -- and also suppresses the message with the version number.
508 -- This is useful in certain regression tests.
510 -- d8 This forces the packed stuff to generate code assuming the
511 -- opposite endianness from the actual correct value. Useful in
512 -- testing out code generation from the packed routines.
514 ------------------------------------------
515 -- Documentation for Binder Debug Flags --
516 ------------------------------------------
518 -- da Normally if there is an elaboration circularity, then in describing
519 -- the cycle, links involving internal units are omitted, since they
520 -- are irrelevant and confusing. This debug flag causes all links to
521 -- be listed, and is useful when diagnosing circularities introduced
522 -- by incorrect changes to the run-time library itself.
524 -- dc List units as they are chosen. As units are selected for addition to
525 -- the elaboration order, a line of output is generated showing which
526 -- unit has been selected.
528 -- de Similar to the effect of -e (output complete list of elaboration
529 -- dependencies) except that internal units are included in the
530 -- listing.
532 -- di Normally gnatbind calls Read_Ali with Ignore_Errors set to
533 -- False, since the binder really needs correct version ALI
534 -- files to do its job. This debug flag causes Ignore_Errors
535 -- mode to be set for the binder (and is particularly useful
536 -- for testing ignore errors mode).
538 -- dn List details of manipulation of Num_Pred values during execution of
539 -- the algorithm used to determine a correct order of elaboration. This
540 -- is useful in diagnosing any problems in its behavior.
542 -- du List unit name and file name for each unit as it is read in
544 -- dx Force the binder to read (and then ignore) the xref information
545 -- in ali files (used to check that read circuit is working OK).
547 ------------------------------------------------------------
548 -- Documentation for the Debug Flags used in package Make --
549 ------------------------------------------------------------
551 -- Please note that such flags apply to all of Make clients,
552 -- such as gnatmake.
554 -- dn Do not delete temporary files creates by Make at the end
555 -- of execution, such as temporary config pragma files, mapping
556 -- files or project path files.
558 -- dp Prints the Q used by routine Make.Compile_Sources every time
559 -- we go around the main compile loop of Make.Compile_Sources
561 -- dq Prints source files as they are enqueued and dequeued in the Q
562 -- used by routine Make.Compile_Sources. Useful to figure out the
563 -- order in which sources are recompiled.
565 -- dt When a time stamp mismatch has been found for an ALI file,
566 -- display the source file name, the time stamp expected and
567 -- the time stamp found.
569 -- du List unit name and file name for each unit as it is read in
571 -- dw Prints the list of units withed by the unit currently explored
572 -- during the main loop of Make.Compile_Sources.
574 ----------------------
575 -- Get_Debug_Flag_K --
576 ----------------------
579 begin
583 --------------------
584 -- Set_Debug_Flag --
585 --------------------
592 begin
636 else
668 ---------------------------
669 -- Set_Dotted_Debug_Flag --
670 ---------------------------
677 begin
721 else