| blob | 90036e2332b416f9c97a0e7fc14fd40e5cd0aee2 |
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- D E B U G --
6 -- --
7 -- B o d y --
8 -- --
9 -- Copyright (C) 1992-2004 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, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, 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 Enable Frontend ZCX even when it is not supported
93 -- dY Enable configurable run-time mode
94 -- dZ
96 -- d.a
97 -- d.b
98 -- d.c
99 -- d.d
100 -- d.e
101 -- d.f
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
125 -- d1 Error msgs have node numbers where possible
126 -- d2 Eliminate error flags in verbose form error messages
127 -- d3 Dump bad node in Comperr on an abort
128 -- d4 Inhibit automatic krunch of predefined library unit files
129 -- d5 Debug output for tree read/write
130 -- d6 Default access unconstrained to thin pointers
131 -- d7 Do not output version & file time stamp in -gnatv or -gnatl mode
132 -- d8 Force opposite endianness in packed stuff
133 -- d9
135 -- Debug flags for binder (GNATBIND)
137 -- da
138 -- db
139 -- dc List units as they are chosen
140 -- dd
141 -- de Elaboration dependencies including system units
142 -- df
143 -- dg
144 -- dh
145 -- di Ignore_Errors mode for reading ali files
146 -- dj
147 -- dk
148 -- dl
149 -- dm
150 -- dn List details of manipulation of Num_Pred values
151 -- do
152 -- dp
153 -- dq
154 -- dr
155 -- ds
156 -- dt
157 -- du List units as they are acquired
158 -- dv
159 -- dw
160 -- dx Force binder to read xref information from ali files
161 -- dy
162 -- dz
164 -- d1
165 -- d2
166 -- d3
167 -- d4
168 -- d5
169 -- d6
170 -- d7
171 -- d8
172 -- d9
174 -- Debug flags used in package Make and its clients (e.g. GNATMAKE)
176 -- da
177 -- db
178 -- dc
179 -- dd
180 -- de
181 -- df
182 -- dg
183 -- dh
184 -- di
185 -- dj
186 -- dk
187 -- dl
188 -- dm
189 -- dn Do not delete temp files created by gnatmake
190 -- do
191 -- dp Prints the contents of the Q used by Make.Compile_Sources
192 -- dq Prints source files as they are enqueued and dequeued
193 -- dr
194 -- ds
195 -- dt Display time stamps when there is a mismatch
196 -- du List units as their ali files are acquired
197 -- dv
198 -- dw Prints the list of units withed by the unit currently explored
199 -- dx
200 -- dy
201 -- dz
203 -- d1
204 -- d2
205 -- d3
206 -- d4
207 -- d5
208 -- d6
209 -- d7
210 -- d8
211 -- d9
213 --------------------------------------------
214 -- Documentation for Compiler Debug Flags --
215 --------------------------------------------
217 -- da Generate messages tracking semantic analyzer progress. A message
218 -- is output showing each node as it gets analyzed, expanded,
219 -- resolved, or evaluated. This option is useful for finding out
220 -- exactly where a bomb during semantic analysis is occurring.
222 -- db In Exp_Dbug, certain type names are encoded to include debugging
223 -- information. This debug switch causes lines to be output showing
224 -- the encodings used.
226 -- dc List names of units as they are compiled. One line of output will
227 -- be generated at the start of compiling each unit (package or
228 -- subprogram).
230 -- dd Dynamic allocation of tables messages generated. Each time a
231 -- table is reallocated, a line is output indicating the expansion.
233 -- de List the entity table
235 -- df Full tree/source print (includes withed units). Normally the tree
236 -- output (dt) or recreated source output (dg,do,ds) includes only
237 -- the main unit. If df is set, then the output in either case
238 -- includes all compiled units (see also dg,do,ds,dt). Note that to
239 -- be effective, this swich must be used in combination with one or
240 -- more of dt, dg, do or ds.
242 -- dg Print the source recreated from the generated tree. In the case
243 -- where the tree has been rewritten this output includes only the
244 -- generated code, not the original code (see also df,do,ds,dz).
245 -- This flag differs from -gnatG in that the output also includes
246 -- non-source generated null statements, and freeze nodes, which
247 -- are normally omitted in -gnatG mode.
249 -- dh Generates a table at the end of a compilation showing how the hash
250 -- table chains built by the Namet package are loaded. This is useful
251 -- in ensuring that the hashing algorithm (in Namet.Hash) is working
252 -- effectively with typical sets of program identifiers.
254 -- di Generate messages for visibility linking/delinking
256 -- dj Suppress "junk null check" for access parameters. This flag permits
257 -- Ada programs to pass null parameters to access parameters, and to
258 -- explicitly check such access values against the null literal.
259 -- Neither of these is valid Ada, but both were allowed in versions of
260 -- GNAT before 3.10, so this switch can ease the transition process.
262 -- dk Immediate kill on abort. Normally on an abort (i.e. a call to
263 -- Comperr.Compiler_Abort), the GNATBUG message is not given if
264 -- there is a previous error. This debug switch bypasses this test
265 -- and gives the message unconditionally (useful for debugging).
267 -- dl Generate unit load trace messages. A line of traceback output is
268 -- generated each time a request is made to the library manager to
269 -- load a new unit.
271 -- dm Some features are permitted only in OpenVMS ports of GNAT (e.g.
272 -- the specification of passing by descriptor). Normally any use
273 -- of these features will be flagged as an error, but this debug
274 -- flag allows acceptance of these features in non OpenVMS ports.
275 -- Of course they may not have any useful effect, and in particular
276 -- attempting to generate code with this flag set may blow up.
277 -- The flag also forces the use of 64-bits for Long_Integer.
279 -- dn Generate messages for node/list allocation. Each time a node or
280 -- list header is allocated, a line of output is generated. Certain
281 -- other basic tree operations also cause a line of output to be
282 -- generated. This option is useful in seeing where the parser is
283 -- blowing up.;
285 -- do Print the source recreated from the generated tree. In the case
286 -- where the tree has been rewritten, this output includes only the
287 -- original code, not the generated code (see also df,dg,ds,dz).
289 -- dp Generate messages for parser scope stack push/pops. A line of
290 -- output by the parser each time the parser scope stack is either
291 -- pushed or popped. Useful in debugging situations where the
292 -- parser scope stack ends up incorrectly synchronized
294 -- dq In layout version 1.38, 2002/01/12, a circuit was implemented
295 -- to give decent default alignment to short records that had no
296 -- specific alignment set. This debug option restores the previous
297 -- behavior of giving such records poor alignments, typically 1.
298 -- This may be useful in dealing with transition.
300 -- dr Generate parser resynchronization messages. Normally the parser
301 -- resynchronizes quietly. With this debug option, two messages
302 -- are generated, one when the parser starts a resynchronization
303 -- skip, and another when it resumes parsing. Useful in debugging
304 -- inadequate error recovery situations.
306 -- ds Print the source recreated from the generated tree. In the case
307 -- where the tree has been rewritten this output includes both the
308 -- generated code and the original code with the generated code
309 -- being enlosed in curly brackets (see also df,do,ds,dz)
311 -- dt Print full tree. The generated tree is output (see also df,dy)
313 -- du Uncheck categorization pragmas. This debug switch causes the
314 -- categorization pragmas (Pure, Preelaborate etc) to be ignored
315 -- so that normal checks are not made (this is particularly useful
316 -- for adding temporary debugging code to units that have pragmas
317 -- that are inconsistent with the debugging code added.
319 -- dv Output trace of overload resolution. Outputs messages for
320 -- overload attempts that involve cascaded errors, or where
321 -- an interepretation is incompatible with the context.
323 -- dw Write semantic scope stack messages. Each time a scope is created
324 -- or removed, a message is output (see the Sem_Ch8.New_Scope and
325 -- Sem_Ch8.Pop_Scope subprograms).
327 -- dx Force expansion on, even if no code being generated. Normally the
328 -- expander is inhibited if no code is generated. This switch forces
329 -- expansion to proceed normally even if the backend is not being
330 -- called. This is particularly useful for debugging purposes when
331 -- using the front-end only version of the compiler (which normally
332 -- would never do any expansion).
334 -- dy Print tree of package Standard. Normally the tree print out does
335 -- not include package Standard, even if the -df switch is set. This
336 -- switch forces output of the internal tree built for Standard.
338 -- dz Print source of package Standard. Normally the source print out
339 -- does not include package Standard, even if the -df switch is set.
340 -- This switch forces output of the source recreated from the internal
341 -- tree built for Standard. Note that this differs from -gnatS in
342 -- that it prints from the actual tree using the normal Sprint
343 -- circuitry for printing trees.
345 -- dA Forces output of representation information, including full
346 -- information for all internal type and object entities, as well
347 -- as all user defined type and object entities including private
348 -- and incomplete types. This debug switch also automatically sets
349 -- the equivalent of -gnatR3m.
351 -- dB Output debug encodings for types and variants. See Exp_Dbug for
352 -- exact form of the generated output.
354 -- dC Output trace information showing the decisions made during
355 -- check suppression activity in unit Checks.
357 -- dD Delete new elaboration checks. This flag causes GNAT to return
358 -- to the 3.13a elaboration semantics, and to suppress the fixing
359 -- of two bugs. The first is in the context of inner routines in
360 -- dynamic elaboration mode, when the subprogram we are in was
361 -- called at elaboration time by a unit that was also compiled with
362 -- dynamic elaboration checks. In this case, if A calls B calls C,
363 -- and all are in different units, we need an elaboration check at
364 -- each call. These nested checks were only put in recently (see
365 -- version 1.80 of Sem_Elab) and we provide this debug flag to
366 -- revert to the previous behavior in case of regressions. The
367 -- other behavior reverted by this flag is the treatment of the
368 -- Elaborate_Body pragma in static elaboration mode. This used to
369 -- be treated as not needing elaboration checking, but in fact in
370 -- general Elaborate_All is still required because of nested calls.
372 -- dE Apply compile time elaboration checking for with relations between
373 -- predefined units. Normally no checks are made (it seems that at
374 -- least on the SGI, such checks run into trouble).
376 -- dF Front end data layout enabled. Normally front end data layout
377 -- is only enabled if the target parameter Backend_Layout is False.
378 -- This debugging switch enables it unconditionally.
380 -- dG Generate all warnings. Normally Errout suppresses warnings on
381 -- units that are not part of the main extended source, and also
382 -- suppresses warnings on instantiations in the main extended
383 -- source that duplicate warnings already posted on the template.
384 -- This switch stops both kinds of deletion and causes Errout to
385 -- post all warnings sent to it.
387 -- dH Inhibit call to gigi. This is useful for testing front end data
388 -- layout, and may be useful in other debugging situations where
389 -- you do not want gigi to intefere with the testing.
391 -- dI Inhibit internal name numbering in gnatDG listing. For internal
392 -- names of the form <uppercase-letters><digits><suffix>, the output
393 -- will be modified to <uppercase-letters>...<suffix>. This is used
394 -- in the fixed bugs run to minimize system and version dependency
395 -- in filed -gnatDG output.
397 -- dJ Generate debugging trace output for the JGNAT back end. This
398 -- consists of symbolic Java Byte Code sequences for all generated
399 -- classes plus additional information to indicate local variables
400 -- and methods.
402 -- dK Kill all error messages. This debug flag suppresses the output
403 -- of all error messages. It is used in regression tests where the
404 -- error messages are target dependent and irrelevant.
406 -- dL Output trace information on elaboration checking. This debug
407 -- switch causes output to be generated showing each call or
408 -- instantiation as it is checked, and the progress of the recursive
409 -- trace through calls at elaboration time.
411 -- dM Assume all variables have been modified, and ignore current value
412 -- indications. This debug flag disconnects the tracking of constant
413 -- values (see Exp_Ch2.Expand_Current_Value).
415 -- dN Do not generate file name information in exception messages.
417 -- dO Output immediate error messages. This causes error messages to
418 -- be output as soon as they are generated (disconnecting several
419 -- circuits for improvement of messages, deletion of duplicate
420 -- messages etc). Useful to diagnose compiler bombs caused by
421 -- erroneous handling of error situations
423 -- dP Do not check for controlled objects in preelaborable packages.
424 -- RM 10.2.1(9) forbids the use of library level controlled objects
425 -- in preelaborable packages, but this restriction is a huge pain,
426 -- especially in the predefined library units.
428 -- dR Bypass the check for a proper version of s-rpc being present
429 -- to use the -gnatz? switch. This allows debugging of the use
430 -- of stubs generation without needing to have GLADE (or some
431 -- other PCS installed).
433 -- dS Omit conversion of fpt numbers to exact machine numbers in
434 -- non-static evaluation contexts (see Check_Non_Static_Context).
435 -- This is intended for testing out timing problems with this
436 -- conversion circuit.
438 -- dT Similar to dS, but omits the conversions only in the case where
439 -- the parent is not a constant declaration.
441 -- dU Enable garbage collection of unreachable entities. This enables
442 -- both the reachability analysis and changing the Is_Public and
443 -- Is_Eliminated flags.
445 -- dV Enable viewing of all symbols in debugger. Causes debug information
446 -- to be generated for all symbols, including internal symbols. This
447 -- is enabled by default for -gnatD, but this switch allows this to
448 -- be enabled without generating modified source files. Note that the
449 -- use of -gnatdV ensures in the dwarf/elf case that all symbols that
450 -- are present in the elf tables are also in the dwarf tables (which
451 -- seems to be required by some tools). Another effect of dV is to
452 -- generate full qualified names, including internal names generated
453 -- for blocks and loops.
455 -- dW Disable warnings when a possibly uninitialized scalar value is
456 -- passed to an IN OUT parameter of a procedure. This usage is a
457 -- quite improper bounded error [erroneous in Ada 83] situation,
458 -- and would normally generate a warning. However, to ease the
459 -- task of transitioning incorrect legacy code, we provide this
460 -- undocumented feature for suppressing these warnings.
462 -- dX Enable frontend ZCX even when it is not supported. Equivalent to
463 -- -gnatZ but without verifying that System.Front_End_ZCX_Support
464 -- is set. This causes the front end to generate suitable tables
465 -- for ZCX handling even when the runtime cannot handle ZCX. This
466 -- is used for testing the front end for correct ZCX operation, and
467 -- in particular is useful for multi-target testing.
469 -- dY Enable configurable run-time mode, just as though the System file
470 -- had Configurable_Run_Time_Mode set to True. This is useful in
471 -- testing high integrity mode.
473 -- d.x No exception handlers in generated code. This causes exception
474 -- handlers to be eliminated from the generated code. They are still
475 -- fully compiled and analyzed, they just get eliminated from the
476 -- code generation step.
478 -- d1 Error messages have node numbers where possible. Normally error
479 -- messages have only source locations. This option is useful when
480 -- debugging errors caused by expanded code, where the source location
481 -- does not give enough information.
483 -- d2 Suppress output of the error position flags for verbose form error
484 -- messages. The messages are still interspersed in the listing, but
485 -- without any error flags or extra blank lines. Also causes an extra
486 -- <<< to be output at the right margin. This is intended to be the
487 -- easiest format for checking conformance of ACATS B tests. This
488 -- flag also suppresses the additional messages explaining why a
489 -- non-static expression is non-static (see Sem_Eval.Why_Not_Static).
490 -- This avoids having to worry about these messages in ACATS testing.
492 -- d3 Causes Comperr to dump the contents of the node for which an abort
493 -- was detected (normally only the Node_Id of the node is output).
495 -- d4 Inhibits automatic krunching of predefined library unit file names.
496 -- Normally, as described in the spec of package Krunch, such files
497 -- are automatically krunched to 8 characters, with special treatment
498 -- of the prefixes Ada, System, and Interfaces. Setting this debug
499 -- switch disables this special treatment.
501 -- d5 Causes the tree read/write circuit to output detailed information
502 -- tracking the data that is read and written element by element.
504 -- d6 Normally access-to-unconstrained-array types are represented
505 -- using fat (double) pointers. Using this debug flag causes them
506 -- to default to thin. This can be used to test the performance
507 -- implications of using thin pointers, and also to test that the
508 -- compiler functions correctly with this choice.
510 -- d7 Normally a -gnatl or -gnatv listing includes the time stamp
511 -- of the source file. This debug flag suppresses this output,
512 -- and also suppresses the message with the version number.
513 -- This is useful in certain regression tests.
515 -- d8 This forces the packed stuff to generate code assuming the
516 -- opposite endianness from the actual correct value. Useful in
517 -- testing out code generation from the packed routines.
519 ------------------------------------------
520 -- Documentation for Binder Debug Flags --
521 ------------------------------------------
523 -- dc List units as they are chosen. As units are selected for addition to
524 -- the elaboration order, a line of output is generated showing which
525 -- unit has been selected.
527 -- de Similar to the effect of -e (output complete list of elaboration
528 -- dependencies) except that internal units are included in the
529 -- listing.
531 -- di Normally gnatbind calls Read_Ali with Ignore_Errors set to
532 -- False, since the binder really needs correct version ALI
533 -- files to do its job. This debug flag causes Ignore_Errors
534 -- mode to be set for the binder (and is particularly useful
535 -- for testing ignore errors mode).
537 -- dn List details of manipulation of Num_Pred values during execution of
538 -- the algorithm used to determine a correct order of elaboration. This
539 -- is useful in diagnosing any problems in its behavior.
541 -- du List unit name and file name for each unit as it is read in
543 -- dx Force the binder to read (and then ignore) the xref information
544 -- in ali files (used to check that read circuit is working OK).
546 ------------------------------------------------------------
547 -- Documentation for the Debug Flags used in package Make --
548 ------------------------------------------------------------
550 -- Please note that such flags apply to all of Make clients,
551 -- such as gnatmake.
553 -- dn Do not delete temporary files creates by Make at the end
554 -- of execution, such as temporary config pragma files, mapping
555 -- files or project path files.
557 -- dp Prints the Q used by routine Make.Compile_Sources every time
558 -- we go around the main compile loop of Make.Compile_Sources
560 -- dq Prints source files as they are enqueued and dequeued in the Q
561 -- used by routine Make.Compile_Sources. Useful to figure out the
562 -- order in which sources are recompiled.
564 -- dt When a time stamp mismatch has been found for an ALI file,
565 -- display the source file name, the time stamp expected and
566 -- the time stamp found.
568 -- du List unit name and file name for each unit as it is read in
570 -- dw Prints the list of units withed by the unit currently explored
571 -- during the main loop of Make.Compile_Sources.
573 ----------------------
574 -- Get_Debug_Flag_K --
575 ----------------------
578 begin
582 --------------------
583 -- Set_Debug_Flag --
584 --------------------
591 begin
635 else
667 ---------------------------
668 -- Set_Dotted_Debug_Flag --
669 ---------------------------
676 begin
720 else