1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
9 -- Copyright (C) 2009-2014, Free Software Foundation, Inc. --
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 3, 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 COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
24 ------------------------------------------------------------------------------
26 with Aspects
; use Aspects
;
27 with Atree
; use Atree
;
28 with Debug
; use Debug
;
29 with Errout
; use Errout
;
31 with Lib
.Util
; use Lib
.Util
;
32 with Namet
; use Namet
;
33 with Nlists
; use Nlists
;
35 with Output
; use Output
;
39 with Sem_Util
; use Sem_Util
;
40 with Sinfo
; use Sinfo
;
41 with Sinput
; use Sinput
;
42 with Snames
; use Snames
;
45 with GNAT
.HTable
; use GNAT
.HTable
;
46 with GNAT
.Heap_Sort_G
;
49 package body Par_SCO
is
51 --------------------------
52 -- First-pass SCO table --
53 --------------------------
55 -- The Short_Circuit_And_Or pragma enables one to use AND and OR operators
56 -- in source code while the ones used with booleans will be interpreted as
57 -- their short circuit alternatives (AND THEN and OR ELSE). Thus, the true
58 -- meaning of these operators is known only after the semantic analysis.
60 -- However, decision SCOs include short circuit operators only. The SCO
61 -- information generation pass must be done before expansion, hence before
62 -- the semantic analysis. Because of this, the SCO information generation
63 -- is done in two passes.
65 -- The first one (SCO_Record_Raw, before semantic analysis) completes the
66 -- SCO_Raw_Table assuming all AND/OR operators are short circuit ones.
67 -- Then, the semantic analysis determines which operators are promoted to
68 -- short circuit ones. Finally, the second pass (SCO_Record_Filtered)
69 -- translates the SCO_Raw_Table to SCO_Table, taking care of removing the
70 -- remaining AND/OR operators and of adjusting decisions accordingly
71 -- (splitting decisions, removing empty ones, etc.).
73 type SCO_Generation_State_Type
is (None
, Raw
, Filtered
);
74 SCO_Generation_State
: SCO_Generation_State_Type
:= None
;
75 -- Keep track of the SCO generation state: this will prevent us from
76 -- running some steps multiple times (the second pass has to be started
77 -- from multiple places).
79 package SCO_Raw_Table
is new GNAT
.Table
(
80 Table_Component_Type
=> SCO_Table_Entry
,
81 Table_Index_Type
=> Nat
,
84 Table_Increment
=> 300);
86 -----------------------
87 -- Unit Number Table --
88 -----------------------
90 -- This table parallels the SCO_Unit_Table, keeping track of the unit
91 -- numbers corresponding to the entries made in this table, so that before
92 -- writing out the SCO information to the ALI file, we can fill in the
93 -- proper dependency numbers and file names.
95 -- Note that the zero'th entry is here for convenience in sorting the
96 -- table, the real lower bound is 1.
98 package SCO_Unit_Number_Table
is new Table
.Table
(
99 Table_Component_Type
=> Unit_Number_Type
,
100 Table_Index_Type
=> SCO_Unit_Index
,
101 Table_Low_Bound
=> 0, -- see note above on sort
103 Table_Increment
=> 200,
104 Table_Name
=> "SCO_Unit_Number_Entry");
106 ------------------------------------------
107 -- Condition/Operator/Pragma Hash Table --
108 ------------------------------------------
110 -- We need to be able to get to conditions quickly for handling the calls
111 -- to Set_SCO_Condition efficiently, and similarly to get to pragmas to
112 -- handle calls to Set_SCO_Pragma_Enabled (the same holds for operators and
113 -- Set_SCO_Logical_Operator). For this purpose we identify the conditions,
114 -- operators and pragmas in the table by their starting sloc, and use this
115 -- hash table to map from these sloc values to SCO_Table indexes.
117 type Header_Num
is new Integer range 0 .. 996;
118 -- Type for hash table headers
120 function Hash
(F
: Source_Ptr
) return Header_Num
;
121 -- Function to Hash source pointer value
123 function Equal
(F1
, F2
: Source_Ptr
) return Boolean;
124 -- Function to test two keys for equality
126 function "<" (S1
, S2
: Source_Location
) return Boolean;
127 -- Function to test for source locations order
129 package SCO_Raw_Hash_Table
is new Simple_HTable
130 (Header_Num
, Int
, 0, Source_Ptr
, Hash
, Equal
);
131 -- The actual hash table
133 --------------------------
134 -- Internal Subprograms --
135 --------------------------
137 function Has_Decision
(N
: Node_Id
) return Boolean;
138 -- N is the node for a subexpression. Returns True if the subexpression
139 -- contains a nested decision (i.e. either is a logical operator, or
140 -- contains a logical operator in its subtree).
142 -- This must be used in the first pass (SCO_Record_Raw) only: here AND/OR
143 -- operators are considered as short circuit, just in case the
144 -- Short_Circuit_And_Or pragma is used: only real short circuit operations
145 -- will be kept in the secord pass.
147 type Tristate
is (False, True, Unknown
);
149 function Is_Logical_Operator
(N
: Node_Id
) return Tristate
;
150 -- N is the node for a subexpression. This procedure determines whether N
151 -- is a logical operator: True for short circuit conditions, Unknown for OR
152 -- and AND (the Short_Circuit_And_Or pragma may be used) and False
153 -- otherwise. Note that in cases where True is returned, callers assume
154 -- Nkind (N) in N_Op.
156 function To_Source_Location
(S
: Source_Ptr
) return Source_Location
;
157 -- Converts Source_Ptr value to Source_Location (line/col) format
159 procedure Process_Decisions
162 Pragma_Sloc
: Source_Ptr
);
163 -- If N is Empty, has no effect. Otherwise scans the tree for the node N,
164 -- to output any decisions it contains. T is one of IEGPWX (for context of
165 -- expression: if/exit when/entry guard/pragma/while/expression). If T is
166 -- other than X, the node N is the if expression involved, and a decision
167 -- is always present (at the very least a simple decision is present at the
170 procedure Process_Decisions
173 Pragma_Sloc
: Source_Ptr
);
174 -- Calls above procedure for each element of the list L
176 procedure Set_Raw_Table_Entry
182 Pragma_Sloc
: Source_Ptr
:= No_Location
;
183 Pragma_Aspect_Name
: Name_Id
:= No_Name
);
184 -- Append an entry to SCO_Raw_Table with fields set as per arguments
186 type Dominant_Info
is record
188 -- F/T/S/E for a valid dominance marker, or ' ' for no dominant
191 -- Node providing the Sloc(s) for the dominance marker
193 No_Dominant
: constant Dominant_Info
:= (' ', Empty
);
195 procedure Record_Instance
(Id
: Instance_Id
; Inst_Sloc
: Source_Ptr
);
196 -- Add one entry from the instance table to the corresponding SCO table
198 procedure Traverse_Declarations_Or_Statements
200 D
: Dominant_Info
:= No_Dominant
;
201 P
: Node_Id
:= Empty
);
202 -- Process L, a list of statements or declarations dominated by D.
203 -- If P is present, it is processed as though it had been prepended to L.
205 function Traverse_Declarations_Or_Statements
207 D
: Dominant_Info
:= No_Dominant
;
208 P
: Node_Id
:= Empty
) return Dominant_Info
;
209 -- Same as above, and returns dominant information corresponding to the
210 -- last node with SCO in L.
212 -- The following Traverse_* routines perform appropriate calls to
213 -- Traverse_Declarations_Or_Statements to traverse specific node kinds.
214 -- Parameter D, when present, indicates the dominant of the first
215 -- declaration or statement within N.
217 -- Why is Traverse_Sync_Definition commented specificaly and
218 -- the others are not???
220 procedure Traverse_Generic_Package_Declaration
(N
: Node_Id
);
221 procedure Traverse_Handled_Statement_Sequence
223 D
: Dominant_Info
:= No_Dominant
);
224 procedure Traverse_Package_Body
(N
: Node_Id
);
225 procedure Traverse_Package_Declaration
227 D
: Dominant_Info
:= No_Dominant
);
228 procedure Traverse_Subprogram_Or_Task_Body
230 D
: Dominant_Info
:= No_Dominant
);
232 procedure Traverse_Sync_Definition
(N
: Node_Id
);
233 -- Traverse a protected definition or task definition
235 procedure Write_SCOs_To_ALI_File
is new Put_SCOs
;
236 -- Write SCO information to the ALI file using routines in Lib.Util
243 procedure Dump_Entry
(Index
: Nat
; T
: SCO_Table_Entry
);
244 -- Dump a SCO table entry
250 procedure Dump_Entry
(Index
: Nat
; T
: SCO_Table_Entry
) is
257 Write_Str
(" C1 = '");
263 Write_Str
(" C2 = '");
268 if T
.From
/= No_Source_Location
then
269 Write_Str
(" From = ");
270 Write_Int
(Int
(T
.From
.Line
));
272 Write_Int
(Int
(T
.From
.Col
));
275 if T
.To
/= No_Source_Location
then
276 Write_Str
(" To = ");
277 Write_Int
(Int
(T
.To
.Line
));
279 Write_Int
(Int
(T
.To
.Col
));
285 Write_Str
(" False");
291 -- Start of processing for dsco
294 -- Dump SCO unit table
296 Write_Line
("SCO Unit Table");
297 Write_Line
("--------------");
299 for Index
in 1 .. SCO_Unit_Table
.Last
loop
301 UTE
: SCO_Unit_Table_Entry
renames SCO_Unit_Table
.Table
(Index
);
305 Write_Int
(Int
(Index
));
306 Write_Str
(" Dep_Num = ");
307 Write_Int
(Int
(UTE
.Dep_Num
));
308 Write_Str
(" From = ");
309 Write_Int
(Int
(UTE
.From
));
310 Write_Str
(" To = ");
311 Write_Int
(Int
(UTE
.To
));
313 Write_Str
(" File_Name = """);
315 if UTE
.File_Name
/= null then
316 Write_Str
(UTE
.File_Name
.all);
324 -- Dump SCO Unit number table if it contains any entries
326 if SCO_Unit_Number_Table
.Last
>= 1 then
328 Write_Line
("SCO Unit Number Table");
329 Write_Line
("---------------------");
331 for Index
in 1 .. SCO_Unit_Number_Table
.Last
loop
333 Write_Int
(Int
(Index
));
334 Write_Str
(". Unit_Number = ");
335 Write_Int
(Int
(SCO_Unit_Number_Table
.Table
(Index
)));
340 -- Dump SCO raw-table
343 Write_Line
("SCO Raw Table");
344 Write_Line
("---------");
346 if SCO_Generation_State
= Filtered
then
347 Write_Line
("Empty (free'd after second pass)");
349 for Index
in 1 .. SCO_Raw_Table
.Last
loop
350 Dump_Entry
(Index
, SCO_Raw_Table
.Table
(Index
));
354 -- Dump SCO table itself
357 Write_Line
("SCO Filtered Table");
358 Write_Line
("---------");
360 for Index
in 1 .. SCO_Table
.Last
loop
361 Dump_Entry
(Index
, SCO_Table
.Table
(Index
));
369 function Equal
(F1
, F2
: Source_Ptr
) return Boolean is
378 function "<" (S1
, S2
: Source_Location
) return Boolean is
380 return S1
.Line
< S2
.Line
381 or else (S1
.Line
= S2
.Line
and then S1
.Col
< S2
.Col
);
388 function Has_Decision
(N
: Node_Id
) return Boolean is
390 function Check_Node
(N
: Node_Id
) return Traverse_Result
;
391 -- Determine if Nkind (N) indicates the presence of a decision (i.e.
392 -- N is a logical operator, which is a decision in itself, or an
393 -- IF-expression whose Condition attribute is a decision).
399 function Check_Node
(N
: Node_Id
) return Traverse_Result
is
401 -- If we are not sure this is a logical operator (AND and OR may be
402 -- turned into logical operators with the Short_Circuit_And_Or
403 -- pragma), assume it is. Putative decisions will be discarded if
404 -- needed in the secord pass.
406 if Is_Logical_Operator
(N
) /= False
407 or else Nkind
(N
) = N_If_Expression
415 function Traverse
is new Traverse_Func
(Check_Node
);
417 -- Start of processing for Has_Decision
420 return Traverse
(N
) = Abandon
;
427 function Hash
(F
: Source_Ptr
) return Header_Num
is
429 return Header_Num
(Nat
(F
) mod 997);
436 procedure Initialize
is
438 SCO_Unit_Number_Table
.Init
;
440 -- The SCO_Unit_Number_Table entry with index 0 is intentionally set
441 -- aside to be used as temporary for sorting.
443 SCO_Unit_Number_Table
.Increment_Last
;
446 -------------------------
447 -- Is_Logical_Operator --
448 -------------------------
450 function Is_Logical_Operator
(N
: Node_Id
) return Tristate
is
452 if Nkind_In
(N
, N_Op_Not
, N_And_Then
, N_Or_Else
) then
454 elsif Nkind_In
(N
, N_Op_And
, N_Op_Or
) then
459 end Is_Logical_Operator
;
461 -----------------------
462 -- Process_Decisions --
463 -----------------------
465 -- Version taking a list
467 procedure Process_Decisions
470 Pragma_Sloc
: Source_Ptr
)
476 while Present
(N
) loop
477 Process_Decisions
(N
, T
, Pragma_Sloc
);
481 end Process_Decisions
;
483 -- Version taking a node
485 Current_Pragma_Sloc
: Source_Ptr
:= No_Location
;
486 -- While processing a pragma, this is set to the sloc of the N_Pragma node
488 procedure Process_Decisions
491 Pragma_Sloc
: Source_Ptr
)
494 -- This is used to mark the location of a decision sequence in the SCO
495 -- table. We use it for backing out a simple decision in an expression
496 -- context that contains only NOT operators.
498 X_Not_Decision
: Boolean;
499 -- This flag keeps track of whether a decision sequence in the SCO table
500 -- contains only NOT operators, and is for an expression context (T=X).
501 -- The flag will be set False if T is other than X, or if an operator
502 -- other than NOT is in the sequence.
504 function Process_Node
(N
: Node_Id
) return Traverse_Result
;
505 -- Processes one node in the traversal, looking for logical operators,
506 -- and if one is found, outputs the appropriate table entries.
508 procedure Output_Decision_Operand
(N
: Node_Id
);
509 -- The node N is the top level logical operator of a decision, or it is
510 -- one of the operands of a logical operator belonging to a single
511 -- complex decision. This routine outputs the sequence of table entries
512 -- corresponding to the node. Note that we do not process the sub-
513 -- operands to look for further decisions, that processing is done in
514 -- Process_Decision_Operand, because we can't get decisions mixed up in
515 -- the global table. Call has no effect if N is Empty.
517 procedure Output_Element
(N
: Node_Id
);
518 -- Node N is an operand of a logical operator that is not itself a
519 -- logical operator, or it is a simple decision. This routine outputs
520 -- the table entry for the element, with C1 set to ' '. Last is set
521 -- False, and an entry is made in the condition hash table.
523 procedure Output_Header
(T
: Character);
524 -- Outputs a decision header node. T is I/W/E/P for IF/WHILE/EXIT WHEN/
525 -- PRAGMA, and 'X' for the expression case.
527 procedure Process_Decision_Operand
(N
: Node_Id
);
528 -- This is called on node N, the top level node of a decision, or on one
529 -- of its operands or suboperands after generating the full output for
530 -- the complex decision. It process the suboperands of the decision
531 -- looking for nested decisions.
533 -----------------------------
534 -- Output_Decision_Operand --
535 -----------------------------
537 procedure Output_Decision_Operand
(N
: Node_Id
) is
539 -- C1 holds a character that identifies the operation while C2
540 -- indicates whether we are sure (' ') or not ('?') this operation
541 -- belongs to the decision. '?' entries will be filtered out in the
542 -- second (SCO_Record_Filtered) pass.
552 T
:= Is_Logical_Operator
(N
);
557 if Nkind
(N
) = N_Op_Not
then
564 if Nkind_In
(N
, N_Op_Or
, N_Or_Else
) then
566 else pragma Assert
(Nkind_In
(N
, N_Op_And
, N_And_Then
));
584 SCO_Raw_Hash_Table
.Set
(Sloc
(N
), SCO_Raw_Table
.Last
);
586 Output_Decision_Operand
(L
);
587 Output_Decision_Operand
(Right_Opnd
(N
));
589 -- Not a logical operator
594 end Output_Decision_Operand
;
600 procedure Output_Element
(N
: Node_Id
) is
604 Sloc_Range
(N
, FSloc
, LSloc
);
611 SCO_Raw_Hash_Table
.Set
(FSloc
, SCO_Raw_Table
.Last
);
618 procedure Output_Header
(T
: Character) is
619 Loc
: Source_Ptr
:= No_Location
;
620 -- Node whose Sloc is used for the decision
622 Nam
: Name_Id
:= No_Name
;
623 -- For the case of an aspect, aspect name
627 when 'I' |
'E' |
'W' |
'a' |
'A' =>
629 -- For IF, EXIT, WHILE, or aspects, the token SLOC is that of
630 -- the parent of the expression.
632 Loc
:= Sloc
(Parent
(N
));
634 if T
= 'a' or else T
= 'A' then
635 Nam
:= Chars
(Identifier
(Parent
(N
)));
640 -- For entry guard, the token sloc is from the N_Entry_Body.
641 -- For PRAGMA, we must get the location from the pragma node.
642 -- Argument N is the pragma argument, and we have to go up
643 -- two levels (through the pragma argument association) to
644 -- get to the pragma node itself. For the guard on a select
645 -- alternative, we do not have access to the token location for
646 -- the WHEN, so we use the first sloc of the condition itself
647 -- (note: we use First_Sloc, not Sloc, because this is what is
648 -- referenced by dominance markers).
650 -- Doesn't this requirement of using First_Sloc need to be
651 -- documented in the spec ???
653 if Nkind_In
(Parent
(N
), N_Accept_Alternative
,
655 N_Terminate_Alternative
)
657 Loc
:= First_Sloc
(N
);
659 Loc
:= Sloc
(Parent
(Parent
(N
)));
664 -- For an expression, no Sloc
668 -- No other possibilities
680 Pragma_Sloc
=> Pragma_Sloc
,
681 Pragma_Aspect_Name
=> Nam
);
683 -- For an aspect specification, which will be rewritten into a
684 -- pragma, enter a hash table entry now.
687 SCO_Raw_Hash_Table
.Set
(Loc
, SCO_Raw_Table
.Last
);
691 ------------------------------
692 -- Process_Decision_Operand --
693 ------------------------------
695 procedure Process_Decision_Operand
(N
: Node_Id
) is
697 if Is_Logical_Operator
(N
) /= False then
698 if Nkind
(N
) /= N_Op_Not
then
699 Process_Decision_Operand
(Left_Opnd
(N
));
700 X_Not_Decision
:= False;
703 Process_Decision_Operand
(Right_Opnd
(N
));
706 Process_Decisions
(N
, 'X', Pragma_Sloc
);
708 end Process_Decision_Operand
;
714 function Process_Node
(N
: Node_Id
) return Traverse_Result
is
718 -- Logical operators, output table entries and then process
719 -- operands recursively to deal with nested conditions.
721 when N_And_Then | N_Or_Else | N_Op_Not | N_Op_And | N_Op_Or
=>
726 -- If outer level, then type comes from call, otherwise it
727 -- is more deeply nested and counts as X for expression.
729 if N
= Process_Decisions
.N
then
730 T
:= Process_Decisions
.T
;
735 -- Output header for sequence
737 X_Not_Decision
:= T
= 'X' and then Nkind
(N
) = N_Op_Not
;
738 Mark
:= SCO_Raw_Table
.Last
;
741 -- Output the decision
743 Output_Decision_Operand
(N
);
745 -- If the decision was in an expression context (T = 'X')
746 -- and contained only NOT operators, then we don't output
749 if X_Not_Decision
then
750 SCO_Raw_Table
.Set_Last
(Mark
);
752 -- Otherwise, set Last in last table entry to mark end
755 SCO_Raw_Table
.Table
(SCO_Raw_Table
.Last
).Last
:= True;
758 -- Process any embedded decisions
760 Process_Decision_Operand
(N
);
766 -- Really hard to believe this is correct given the special
767 -- handling for if expressions below ???
769 when N_Case_Expression
=>
772 -- If expression, processed like an if statement
774 when N_If_Expression
=>
776 Cond
: constant Node_Id
:= First
(Expressions
(N
));
777 Thnx
: constant Node_Id
:= Next
(Cond
);
778 Elsx
: constant Node_Id
:= Next
(Thnx
);
780 Process_Decisions
(Cond
, 'I', Pragma_Sloc
);
781 Process_Decisions
(Thnx
, 'X', Pragma_Sloc
);
782 Process_Decisions
(Elsx
, 'X', Pragma_Sloc
);
786 -- All other cases, continue scan
794 procedure Traverse
is new Traverse_Proc
(Process_Node
);
796 -- Start of processing for Process_Decisions
803 -- See if we have simple decision at outer level and if so then
804 -- generate the decision entry for this simple decision. A simple
805 -- decision is a boolean expression (which is not a logical operator
806 -- or short circuit form) appearing as the operand of an IF, WHILE,
807 -- EXIT WHEN, or special PRAGMA construct.
809 if T
/= 'X' and then Is_Logical_Operator
(N
) = False then
813 -- Change Last in last table entry to True to mark end of
814 -- sequence, which is this case is only one element long.
816 SCO_Raw_Table
.Table
(SCO_Raw_Table
.Last
).Last
:= True;
820 end Process_Decisions
;
828 procedure Write_Info_Char
(C
: Character) renames Write_Char
;
829 -- Write one character;
831 procedure Write_Info_Initiate
(Key
: Character) renames Write_Char
;
832 -- Start new one and write one character;
834 procedure Write_Info_Nat
(N
: Nat
);
837 procedure Write_Info_Terminate
renames Write_Eol
;
838 -- Terminate current line
844 procedure Write_Info_Nat
(N
: Nat
) is
849 procedure Debug_Put_SCOs
is new Put_SCOs
;
851 -- Start of processing for pscos
857 ---------------------
858 -- Record_Instance --
859 ---------------------
861 procedure Record_Instance
(Id
: Instance_Id
; Inst_Sloc
: Source_Ptr
) is
862 Inst_Src
: constant Source_File_Index
:=
863 Get_Source_File_Index
(Inst_Sloc
);
865 SCO_Instance_Table
.Append
866 ((Inst_Dep_Num
=> Dependency_Num
(Unit
(Inst_Src
)),
867 Inst_Loc
=> To_Source_Location
(Inst_Sloc
),
868 Enclosing_Instance
=> SCO_Instance_Index
(Instance
(Inst_Src
))));
870 (SCO_Instance_Table
.Last
= SCO_Instance_Index
(Id
));
877 procedure SCO_Output
is
878 procedure Populate_SCO_Instance_Table
is
879 new Sinput
.Iterate_On_Instances
(Record_Instance
);
881 pragma Assert
(SCO_Generation_State
= Filtered
);
883 if Debug_Flag_Dot_OO
then
887 Populate_SCO_Instance_Table
;
889 -- Sort the unit tables based on dependency numbers
891 Unit_Table_Sort
: declare
893 function Lt
(Op1
, Op2
: Natural) return Boolean;
894 -- Comparison routine for sort call
896 procedure Move
(From
: Natural; To
: Natural);
897 -- Move routine for sort call
903 function Lt
(Op1
, Op2
: Natural) return Boolean is
907 (SCO_Unit_Number_Table
.Table
(SCO_Unit_Index
(Op1
)))
910 (SCO_Unit_Number_Table
.Table
(SCO_Unit_Index
(Op2
)));
917 procedure Move
(From
: Natural; To
: Natural) is
919 SCO_Unit_Table
.Table
(SCO_Unit_Index
(To
)) :=
920 SCO_Unit_Table
.Table
(SCO_Unit_Index
(From
));
921 SCO_Unit_Number_Table
.Table
(SCO_Unit_Index
(To
)) :=
922 SCO_Unit_Number_Table
.Table
(SCO_Unit_Index
(From
));
925 package Sorting
is new GNAT
.Heap_Sort_G
(Move
, Lt
);
927 -- Start of processing for Unit_Table_Sort
930 Sorting
.Sort
(Integer (SCO_Unit_Table
.Last
));
933 -- Loop through entries in the unit table to set file name and
934 -- dependency number entries.
936 for J
in 1 .. SCO_Unit_Table
.Last
loop
938 U
: constant Unit_Number_Type
:= SCO_Unit_Number_Table
.Table
(J
);
939 UTE
: SCO_Unit_Table_Entry
renames SCO_Unit_Table
.Table
(J
);
941 Get_Name_String
(Reference_Name
(Source_Index
(U
)));
942 UTE
.File_Name
:= new String'(Name_Buffer (1 .. Name_Len));
943 UTE.Dep_Num := Dependency_Num (U);
947 -- Now the tables are all setup for output to the ALI file
949 Write_SCOs_To_ALI_File;
952 -------------------------
953 -- SCO_Pragma_Disabled --
954 -------------------------
956 function SCO_Pragma_Disabled (Loc : Source_Ptr) return Boolean is
960 if Loc = No_Location then
964 Index := SCO_Raw_Hash_Table.Get (Loc);
966 -- The test here for zero is to deal with possible previous errors, and
967 -- for the case of pragma statement SCOs, for which we always set the
968 -- Pragma_Sloc even if the particular pragma cannot be specifically
973 T : SCO_Table_Entry renames SCO_Raw_Table.Table (Index);
983 -- Aspect decision (enabled)
988 -- Aspect decision (not enabled)
993 -- Nullified disabled SCO
1005 end SCO_Pragma_Disabled;
1007 --------------------
1008 -- SCO_Record_Raw --
1009 --------------------
1011 procedure SCO_Record_Raw (U : Unit_Number_Type) is
1015 procedure Traverse_Aux_Decls (N : Node_Id);
1016 -- Traverse the Aux_Decls_Node of compilation unit N
1018 ------------------------
1019 -- Traverse_Aux_Decls --
1020 ------------------------
1022 procedure Traverse_Aux_Decls (N : Node_Id) is
1023 ADN : constant Node_Id := Aux_Decls_Node (N);
1025 Traverse_Declarations_Or_Statements (Config_Pragmas (ADN));
1026 Traverse_Declarations_Or_Statements (Pragmas_After (ADN));
1028 -- Declarations and Actions do not correspond to source constructs,
1029 -- they contain only nodes from expansion, so at this point they
1030 -- should still be empty:
1032 pragma Assert (No (Declarations (ADN)));
1033 pragma Assert (No (Actions (ADN)));
1034 end Traverse_Aux_Decls;
1036 -- Start of processing for SCO_Record_Raw
1039 -- It is legitimate to run this pass multiple times (once per unit) so
1040 -- run it even if it was already run before.
1042 pragma Assert (SCO_Generation_State in None .. Raw);
1043 SCO_Generation_State := Raw;
1045 -- Ignore call if not generating code and generating SCO's
1047 if not (Generate_SCO and then Operating_Mode = Generate_Code) then
1051 -- Ignore call if this unit already recorded
1053 for J in 1 .. SCO_Unit_Number_Table.Last loop
1054 if U = SCO_Unit_Number_Table.Table (J) then
1059 -- Otherwise record starting entry
1061 From := SCO_Raw_Table.Last + 1;
1063 -- Get Unit (checking case of subunit)
1065 Lu := Unit (Cunit (U));
1067 if Nkind (Lu) = N_Subunit then
1068 Lu := Proper_Body (Lu);
1071 -- Traverse the unit
1073 Traverse_Aux_Decls (Cunit (U));
1077 N_Package_Declaration |
1079 N_Subprogram_Declaration |
1081 N_Generic_Package_Declaration |
1084 N_Generic_Instantiation =>
1086 Traverse_Declarations_Or_Statements (L => No_List, P => Lu);
1090 -- All other cases of compilation units (e.g. renamings), generate
1091 -- no SCO information.
1096 -- Make entry for new unit in unit tables, we will fill in the file
1097 -- name and dependency numbers later.
1099 SCO_Unit_Table.Append (
1102 File_Index => Get_Source_File_Index (Sloc (Lu)),
1104 To => SCO_Raw_Table.Last));
1106 SCO_Unit_Number_Table.Append (U);
1109 -----------------------
1110 -- Set_SCO_Condition --
1111 -----------------------
1113 procedure Set_SCO_Condition (Cond : Node_Id; Val : Boolean) is
1115 -- SCO annotations are not processed after the filtering pass
1117 pragma Assert (not Generate_SCO or else SCO_Generation_State = Raw);
1119 Orig : constant Node_Id := Original_Node (Cond);
1124 Constant_Condition_Code : constant array (Boolean) of Character :=
1125 (False => 'f
', True => 't
');
1127 Sloc_Range (Orig, Start, Dummy);
1128 Index := SCO_Raw_Hash_Table.Get (Start);
1130 -- Index can be zero for boolean expressions that do not have SCOs
1131 -- (simple decisions outside of a control flow structure), or in case
1132 -- of a previous error.
1138 pragma Assert (SCO_Raw_Table.Table (Index).C1 = ' ');
1139 SCO_Raw_Table.Table (Index).C2 := Constant_Condition_Code (Val);
1141 end Set_SCO_Condition;
1143 ------------------------------
1144 -- Set_SCO_Logical_Operator --
1145 ------------------------------
1147 procedure Set_SCO_Logical_Operator (Op : Node_Id) is
1149 -- SCO annotations are not processed after the filtering pass
1151 pragma Assert (not Generate_SCO or else SCO_Generation_State = Raw);
1153 Orig : constant Node_Id := Original_Node (Op);
1154 Orig_Sloc : constant Source_Ptr := Sloc (Orig);
1155 Index : constant Nat := SCO_Raw_Hash_Table.Get (Orig_Sloc);
1158 -- All (putative) logical operators are supposed to have their own entry
1159 -- in the SCOs table. However, the semantic analysis may invoke this
1160 -- subprogram with nodes that are out of the SCO generation scope.
1163 SCO_Raw_Table.Table (Index).C2 := ' ';
1165 end Set_SCO_Logical_Operator;
1167 ----------------------------
1168 -- Set_SCO_Pragma_Enabled --
1169 ----------------------------
1171 procedure Set_SCO_Pragma_Enabled (Loc : Source_Ptr) is
1173 -- SCO annotations are not processed after the filtering pass
1175 pragma Assert (not Generate_SCO or else SCO_Generation_State = Raw);
1180 -- Nothing to do if not generating SCO, or if we're not processing the
1181 -- original source occurrence of the pragma.
1183 if not (Generate_SCO
1184 and then In_Extended_Main_Source_Unit (Loc)
1185 and then not (In_Instance or In_Inlined_Body))
1190 -- Note: the reason we use the Sloc value as the key is that in the
1191 -- generic case, the call to this procedure is made on a copy of the
1192 -- original node, so we can't use the Node_Id value.
1194 Index := SCO_Raw_Hash_Table.Get (Loc);
1196 -- A zero index here indicates that semantic analysis found an
1197 -- activated pragma at Loc which does not have a corresponding pragma
1198 -- or aspect at the syntax level. This may occur in legitimate cases
1199 -- because of expanded code (such are Pre/Post conditions generated for
1200 -- formal parameter validity checks), or as a consequence of a previous
1208 T : SCO_Table_Entry renames SCO_Raw_Table.Table (Index);
1211 -- Note: may be called multiple times for the same sloc, so
1212 -- account for the fact that the entry may already have been
1216 -- Aspect (decision SCO)
1224 -- Pragma (statement SCO)
1227 pragma Assert (T.C2 = 'p
' or else T.C2 = 'P
');
1231 raise Program_Error;
1235 end Set_SCO_Pragma_Enabled;
1237 -------------------------
1238 -- Set_Raw_Table_Entry --
1239 -------------------------
1241 procedure Set_Raw_Table_Entry
1247 Pragma_Sloc : Source_Ptr := No_Location;
1248 Pragma_Aspect_Name : Name_Id := No_Name)
1250 pragma Assert (SCO_Generation_State = Raw);
1252 SCO_Raw_Table.Append
1255 From => To_Source_Location (From),
1256 To => To_Source_Location (To),
1258 Pragma_Sloc => Pragma_Sloc,
1259 Pragma_Aspect_Name => Pragma_Aspect_Name));
1260 end Set_Raw_Table_Entry;
1262 ------------------------
1263 -- To_Source_Location --
1264 ------------------------
1266 function To_Source_Location (S : Source_Ptr) return Source_Location is
1268 if S = No_Location then
1269 return No_Source_Location;
1272 (Line => Get_Logical_Line_Number (S),
1273 Col => Get_Column_Number (S));
1275 end To_Source_Location;
1277 -----------------------------------------
1278 -- Traverse_Declarations_Or_Statements --
1279 -----------------------------------------
1281 -- Tables used by Traverse_Declarations_Or_Statements for temporarily
1282 -- holding statement and decision entries. These are declared globally
1283 -- since they are shared by recursive calls to this procedure.
1285 type SC_Entry is record
1291 -- Used to store a single entry in the following table, From:To represents
1292 -- the range of entries in the CS line entry, and typ is the type, with
1293 -- space meaning that no type letter will accompany the entry.
1295 package SC is new Table.Table (
1296 Table_Component_Type => SC_Entry,
1297 Table_Index_Type => Nat,
1298 Table_Low_Bound => 1,
1299 Table_Initial => 1000,
1300 Table_Increment => 200,
1301 Table_Name => "SCO_SC");
1302 -- Used to store statement components for a CS entry to be output
1303 -- as a result of the call to this procedure. SC.Last is the last
1304 -- entry stored, so the current statement sequence is represented
1305 -- by SC_Array (SC_First .. SC.Last), where SC_First is saved on
1306 -- entry to each recursive call to the routine.
1308 -- Extend_Statement_Sequence adds an entry to this array, and then
1309 -- Set_Statement_Entry clears the entries starting with SC_First,
1310 -- copying these entries to the main SCO output table. The reason that
1311 -- we do the temporary caching of results in this array is that we want
1312 -- the SCO table entries for a given CS line to be contiguous, and the
1313 -- processing may output intermediate entries such as decision entries.
1315 type SD_Entry is record
1321 -- Used to store a single entry in the following table. Nod is the node to
1322 -- be searched for decisions for the case of Process_Decisions_Defer with a
1323 -- node argument (with Lst set to No_List. Lst is the list to be searched
1324 -- for decisions for the case of Process_Decisions_Defer with a List
1325 -- argument (in which case Nod is set to Empty). Plo is the sloc of the
1326 -- enclosing pragma, if any.
1328 package SD is new Table.Table (
1329 Table_Component_Type => SD_Entry,
1330 Table_Index_Type => Nat,
1331 Table_Low_Bound => 1,
1332 Table_Initial => 1000,
1333 Table_Increment => 200,
1334 Table_Name => "SCO_SD");
1335 -- Used to store possible decision information. Instead of calling the
1336 -- Process_Decisions procedures directly, we call Process_Decisions_Defer,
1337 -- which simply stores the arguments in this table. Then when we clear
1338 -- out a statement sequence using Set_Statement_Entry, after generating
1339 -- the CS lines for the statements, the entries in this table result in
1340 -- calls to Process_Decision. The reason for doing things this way is to
1341 -- ensure that decisions are output after the CS line for the statements
1342 -- in which the decisions occur.
1344 procedure Traverse_Declarations_Or_Statements
1346 D : Dominant_Info := No_Dominant;
1347 P : Node_Id := Empty)
1349 Discard_Dom : Dominant_Info;
1350 pragma Warnings (Off, Discard_Dom);
1352 Discard_Dom := Traverse_Declarations_Or_Statements (L, D, P);
1353 end Traverse_Declarations_Or_Statements;
1355 function Traverse_Declarations_Or_Statements
1357 D : Dominant_Info := No_Dominant;
1358 P : Node_Id := Empty) return Dominant_Info
1360 Current_Dominant : Dominant_Info := D;
1361 -- Dominance information for the current basic block
1363 Current_Test : Node_Id;
1364 -- Conditional node (N_If_Statement or N_Elsiif being processed
1368 SC_First : constant Nat := SC.Last + 1;
1369 SD_First : constant Nat := SD.Last + 1;
1370 -- Record first entries used in SC/SD at this recursive level
1372 procedure Extend_Statement_Sequence (N : Node_Id; Typ : Character);
1373 -- Extend the current statement sequence to encompass the node N. Typ
1374 -- is the letter that identifies the type of statement/declaration that
1375 -- is being added to the sequence.
1377 procedure Set_Statement_Entry;
1378 -- Output CS entries for all statements saved in table SC, and end the
1379 -- current CS sequence. Then output entries for all decisions nested in
1380 -- these statements, which have been deferred so far.
1382 procedure Process_Decisions_Defer (N : Node_Id; T : Character);
1383 pragma Inline (Process_Decisions_Defer);
1384 -- This routine is logically the same as Process_Decisions, except that
1385 -- the arguments are saved in the SD table for later processing when
1386 -- Set_Statement_Entry is called, which goes through the saved entries
1387 -- making the corresponding calls to Process_Decision.
1389 procedure Process_Decisions_Defer (L : List_Id; T : Character);
1390 pragma Inline (Process_Decisions_Defer);
1391 -- Same case for list arguments, deferred call to Process_Decisions
1393 procedure Traverse_One (N : Node_Id);
1394 -- Traverse one declaration or statement
1396 procedure Traverse_Aspects (N : Node_Id);
1397 -- Helper for Traverse_One: traverse N's aspect specifications
1399 -------------------------
1400 -- Set_Statement_Entry --
1401 -------------------------
1403 procedure Set_Statement_Entry is
1404 SC_Last : constant Int := SC.Last;
1405 SD_Last : constant Int := SD.Last;
1408 -- Output statement entries from saved entries in SC table
1410 for J in SC_First .. SC_Last loop
1411 if J = SC_First then
1413 if Current_Dominant /= No_Dominant then
1415 From, To : Source_Ptr;
1417 Sloc_Range (Current_Dominant.N, From, To);
1418 if Current_Dominant.K /= 'E
' then
1423 C2 => Current_Dominant.K,
1427 Pragma_Sloc => No_Location,
1428 Pragma_Aspect_Name => No_Name);
1434 SCE : SC_Entry renames SC.Table (J);
1435 Pragma_Sloc : Source_Ptr := No_Location;
1436 Pragma_Aspect_Name : Name_Id := No_Name;
1438 -- For the case of a statement SCO for a pragma controlled by
1439 -- Set_SCO_Pragma_Enabled, set Pragma_Sloc so that the SCO (and
1440 -- those of any nested decision) is emitted only if the pragma
1443 if SCE.Typ = 'p
' then
1444 Pragma_Sloc := SCE.From;
1445 SCO_Raw_Hash_Table.Set
1446 (Pragma_Sloc, SCO_Raw_Table.Last + 1);
1447 Pragma_Aspect_Name := Pragma_Name (SCE.N);
1448 pragma Assert (Pragma_Aspect_Name /= No_Name);
1450 elsif SCE.Typ = 'P
' then
1451 Pragma_Aspect_Name := Pragma_Name (SCE.N);
1452 pragma Assert (Pragma_Aspect_Name /= No_Name);
1460 Last => (J = SC_Last),
1461 Pragma_Sloc => Pragma_Sloc,
1462 Pragma_Aspect_Name => Pragma_Aspect_Name);
1466 -- Last statement of basic block, if present, becomes new current
1469 if SC_Last >= SC_First then
1470 Current_Dominant := ('S
', SC.Table (SC_Last).N);
1473 -- Clear out used section of SC table
1475 SC.Set_Last (SC_First - 1);
1477 -- Output any embedded decisions
1479 for J in SD_First .. SD_Last loop
1481 SDE : SD_Entry renames SD.Table (J);
1483 if Present (SDE.Nod) then
1484 Process_Decisions (SDE.Nod, SDE.Typ, SDE.Plo);
1486 Process_Decisions (SDE.Lst, SDE.Typ, SDE.Plo);
1491 -- Clear out used section of SD table
1493 SD.Set_Last (SD_First - 1);
1494 end Set_Statement_Entry;
1496 -------------------------------
1497 -- Extend_Statement_Sequence --
1498 -------------------------------
1500 procedure Extend_Statement_Sequence (N : Node_Id; Typ : Character) is
1504 To_Node : Node_Id := Empty;
1507 Sloc_Range (N, F, T);
1510 when N_Accept_Statement =>
1511 if Present (Parameter_Specifications (N)) then
1512 To_Node := Last (Parameter_Specifications (N));
1513 elsif Present (Entry_Index (N)) then
1514 To_Node := Entry_Index (N);
1517 when N_Case_Statement =>
1518 To_Node := Expression (N);
1520 when N_If_Statement | N_Elsif_Part =>
1521 To_Node := Condition (N);
1523 when N_Extended_Return_Statement =>
1524 To_Node := Last (Return_Object_Declarations (N));
1526 when N_Loop_Statement =>
1527 To_Node := Iteration_Scheme (N);
1529 when N_Selective_Accept |
1530 N_Timed_Entry_Call |
1531 N_Conditional_Entry_Call |
1532 N_Asynchronous_Select |
1533 N_Single_Protected_Declaration |
1534 N_Single_Task_Declaration =>
1537 when N_Protected_Type_Declaration | N_Task_Type_Declaration =>
1538 if Has_Aspects (N) then
1539 To_Node := Last (Aspect_Specifications (N));
1541 elsif Present (Discriminant_Specifications (N)) then
1542 To_Node := Last (Discriminant_Specifications (N));
1545 To_Node := Defining_Identifier (N);
1553 if Present (To_Node) then
1554 Sloc_Range (To_Node, Dummy, T);
1557 SC.Append ((N, F, T, Typ));
1558 end Extend_Statement_Sequence;
1560 -----------------------------
1561 -- Process_Decisions_Defer --
1562 -----------------------------
1564 procedure Process_Decisions_Defer (N : Node_Id; T : Character) is
1566 SD.Append ((N, No_List, T, Current_Pragma_Sloc));
1567 end Process_Decisions_Defer;
1569 procedure Process_Decisions_Defer (L : List_Id; T : Character) is
1571 SD.Append ((Empty, L, T, Current_Pragma_Sloc));
1572 end Process_Decisions_Defer;
1574 ----------------------
1575 -- Traverse_Aspects --
1576 ----------------------
1578 procedure Traverse_Aspects (N : Node_Id) is
1584 AN := First (Aspect_Specifications (N));
1585 while Present (AN) loop
1586 AE := Expression (AN);
1588 -- SCOs are generated before semantic analysis/expansion:
1589 -- PPCs are not split yet.
1591 pragma Assert (not Split_PPC (AN));
1595 case Get_Aspect_Id (AN) is
1597 -- Aspects rewritten into pragmas controlled by a Check_Policy:
1598 -- Current_Pragma_Sloc must be set to the sloc of the aspect
1599 -- specification. The corresponding pragma will have the same
1603 Aspect_Precondition |
1605 Aspect_Postcondition |
1610 -- Aspects whose checks are generated in client units,
1611 -- regardless of whether or not the check is activated in the
1612 -- unit which contains the declaration: create decision as
1613 -- unconditionally enabled aspect (but still make a pragma
1614 -- entry since Set_SCO_Pragma_Enabled will be called when
1615 -- analyzing actual checks, possibly in other units).
1617 -- Pre/post can have checks in client units too because of
1618 -- inheritance, so should they be moved here???
1620 when Aspect_Predicate |
1621 Aspect_Static_Predicate |
1622 Aspect_Dynamic_Predicate |
1623 Aspect_Type_Invariant =>
1627 -- Other aspects: just process any decision nested in the
1628 -- aspect expression.
1632 if Has_Decision (AE) then
1638 if C1 /= ASCII.NUL then
1639 pragma Assert (Current_Pragma_Sloc = No_Location);
1641 if C1 = 'a
' or else C1 = 'A
' then
1642 Current_Pragma_Sloc := Sloc (AN);
1645 Process_Decisions_Defer (AE, C1);
1647 Current_Pragma_Sloc := No_Location;
1652 end Traverse_Aspects;
1658 procedure Traverse_One (N : Node_Id) is
1660 -- Initialize or extend current statement sequence. Note that for
1661 -- special cases such as IF and Case statements we will modify
1662 -- the range to exclude internal statements that should not be
1663 -- counted as part of the current statement sequence.
1667 -- Package declaration
1669 when N_Package_Declaration =>
1670 Set_Statement_Entry;
1671 Traverse_Package_Declaration (N, Current_Dominant);
1673 -- Generic package declaration
1675 when N_Generic_Package_Declaration =>
1676 Set_Statement_Entry;
1677 Traverse_Generic_Package_Declaration (N);
1681 when N_Package_Body =>
1682 Set_Statement_Entry;
1683 Traverse_Package_Body (N);
1685 -- Subprogram declaration or subprogram body stub
1687 when N_Subprogram_Declaration | N_Subprogram_Body_Stub =>
1688 Process_Decisions_Defer
1689 (Parameter_Specifications (Specification (N)), 'X
');
1691 -- Entry declaration
1693 when N_Entry_Declaration =>
1694 Process_Decisions_Defer (Parameter_Specifications (N), 'X
');
1696 -- Generic subprogram declaration
1698 when N_Generic_Subprogram_Declaration =>
1699 Process_Decisions_Defer
1700 (Generic_Formal_Declarations (N), 'X
');
1701 Process_Decisions_Defer
1702 (Parameter_Specifications (Specification (N)), 'X
');
1704 -- Task or subprogram body
1706 when N_Task_Body | N_Subprogram_Body =>
1707 Set_Statement_Entry;
1708 Traverse_Subprogram_Or_Task_Body (N);
1712 when N_Entry_Body =>
1714 Cond : constant Node_Id :=
1715 Condition (Entry_Body_Formal_Part (N));
1717 Inner_Dominant : Dominant_Info := No_Dominant;
1720 Set_Statement_Entry;
1722 if Present (Cond) then
1723 Process_Decisions_Defer (Cond, 'G
');
1725 -- For an entry body with a barrier, the entry body
1726 -- is dominanted by a True evaluation of the barrier.
1728 Inner_Dominant := ('T
', N);
1731 Traverse_Subprogram_Or_Task_Body (N, Inner_Dominant);
1736 when N_Protected_Body =>
1737 Set_Statement_Entry;
1738 Traverse_Declarations_Or_Statements (Declarations (N));
1740 -- Exit statement, which is an exit statement in the SCO sense,
1741 -- so it is included in the current statement sequence, but
1742 -- then it terminates this sequence. We also have to process
1743 -- any decisions in the exit statement expression.
1745 when N_Exit_Statement =>
1746 Extend_Statement_Sequence (N, 'E
');
1747 Process_Decisions_Defer (Condition (N), 'E
');
1748 Set_Statement_Entry;
1750 -- If condition is present, then following statement is
1751 -- only executed if the condition evaluates to False.
1753 if Present (Condition (N)) then
1754 Current_Dominant := ('F
', N);
1756 Current_Dominant := No_Dominant;
1759 -- Label, which breaks the current statement sequence, but the
1760 -- label itself is not included in the next statement sequence,
1761 -- since it generates no code.
1764 Set_Statement_Entry;
1765 Current_Dominant := No_Dominant;
1767 -- Block statement, which breaks the current statement sequence
1769 when N_Block_Statement =>
1770 Set_Statement_Entry;
1772 -- The first statement in the handled sequence of statements
1773 -- is dominated by the elaboration of the last declaration.
1775 Current_Dominant := Traverse_Declarations_Or_Statements
1776 (L => Declarations (N),
1777 D => Current_Dominant);
1779 Traverse_Handled_Statement_Sequence
1780 (N => Handled_Statement_Sequence (N),
1781 D => Current_Dominant);
1783 -- If statement, which breaks the current statement sequence,
1784 -- but we include the condition in the current sequence.
1786 when N_If_Statement =>
1788 Extend_Statement_Sequence (N, 'I
');
1789 Process_Decisions_Defer (Condition (N), 'I
');
1790 Set_Statement_Entry;
1792 -- Now we traverse the statements in the THEN part
1794 Traverse_Declarations_Or_Statements
1795 (L => Then_Statements (N),
1798 -- Loop through ELSIF parts if present
1800 if Present (Elsif_Parts (N)) then
1802 Saved_Dominant : constant Dominant_Info :=
1805 Elif : Node_Id := First (Elsif_Parts (N));
1808 while Present (Elif) loop
1810 -- An Elsif is executed only if the previous test
1811 -- got a FALSE outcome.
1813 Current_Dominant := ('F
', Current_Test);
1815 -- Now update current test information
1817 Current_Test := Elif;
1819 -- We generate a statement sequence for the
1820 -- construct "ELSIF condition", so that we have
1821 -- a statement for the resulting decisions.
1823 Extend_Statement_Sequence (Elif, 'I
');
1824 Process_Decisions_Defer (Condition (Elif), 'I
');
1825 Set_Statement_Entry;
1827 -- An ELSIF part is never guaranteed to have
1828 -- been executed, following statements are only
1829 -- dominated by the initial IF statement.
1831 Current_Dominant := Saved_Dominant;
1833 -- Traverse the statements in the ELSIF
1835 Traverse_Declarations_Or_Statements
1836 (L => Then_Statements (Elif),
1843 -- Finally traverse the ELSE statements if present
1845 Traverse_Declarations_Or_Statements
1846 (L => Else_Statements (N),
1847 D => ('F
', Current_Test));
1849 -- CASE statement, which breaks the current statement sequence,
1850 -- but we include the expression in the current sequence.
1852 when N_Case_Statement =>
1853 Extend_Statement_Sequence (N, 'C
');
1854 Process_Decisions_Defer (Expression (N), 'X
');
1855 Set_Statement_Entry;
1857 -- Process case branches, all of which are dominated by the
1863 Alt := First (Alternatives (N));
1864 while Present (Alt) loop
1865 Traverse_Declarations_Or_Statements
1866 (L => Statements (Alt),
1867 D => Current_Dominant);
1874 when N_Accept_Statement =>
1875 Extend_Statement_Sequence (N, 'A
');
1876 Set_Statement_Entry;
1878 -- Process sequence of statements, dominant is the ACCEPT
1881 Traverse_Handled_Statement_Sequence
1882 (N => Handled_Statement_Sequence (N),
1883 D => Current_Dominant);
1887 when N_Selective_Accept =>
1888 Extend_Statement_Sequence (N, 'S
');
1889 Set_Statement_Entry;
1891 -- Process alternatives
1896 S_Dom : Dominant_Info;
1899 Alt := First (Select_Alternatives (N));
1900 while Present (Alt) loop
1901 S_Dom := Current_Dominant;
1902 Guard := Condition (Alt);
1904 if Present (Guard) then
1908 Pragma_Sloc => No_Location);
1909 Current_Dominant := ('T
', Guard);
1914 Current_Dominant := S_Dom;
1919 Traverse_Declarations_Or_Statements
1920 (L => Else_Statements (N),
1921 D => Current_Dominant);
1923 when N_Timed_Entry_Call | N_Conditional_Entry_Call =>
1924 Extend_Statement_Sequence (N, 'S
');
1925 Set_Statement_Entry;
1927 -- Process alternatives
1929 Traverse_One (Entry_Call_Alternative (N));
1931 if Nkind (N) = N_Timed_Entry_Call then
1932 Traverse_One (Delay_Alternative (N));
1934 Traverse_Declarations_Or_Statements
1935 (L => Else_Statements (N),
1936 D => Current_Dominant);
1939 when N_Asynchronous_Select =>
1940 Extend_Statement_Sequence (N, 'S
');
1941 Set_Statement_Entry;
1943 Traverse_One (Triggering_Alternative (N));
1944 Traverse_Declarations_Or_Statements
1945 (L => Statements (Abortable_Part (N)),
1946 D => Current_Dominant);
1948 when N_Accept_Alternative =>
1949 Traverse_Declarations_Or_Statements
1950 (L => Statements (N),
1951 D => Current_Dominant,
1952 P => Accept_Statement (N));
1954 when N_Entry_Call_Alternative =>
1955 Traverse_Declarations_Or_Statements
1956 (L => Statements (N),
1957 D => Current_Dominant,
1958 P => Entry_Call_Statement (N));
1960 when N_Delay_Alternative =>
1961 Traverse_Declarations_Or_Statements
1962 (L => Statements (N),
1963 D => Current_Dominant,
1964 P => Delay_Statement (N));
1966 when N_Triggering_Alternative =>
1967 Traverse_Declarations_Or_Statements
1968 (L => Statements (N),
1969 D => Current_Dominant,
1970 P => Triggering_Statement (N));
1972 when N_Terminate_Alternative =>
1974 -- It is dubious to emit a statement SCO for a TERMINATE
1975 -- alternative, since no code is actually executed if the
1976 -- alternative is selected -- the tasking runtime call just
1979 Extend_Statement_Sequence (N, ' ');
1980 Set_Statement_Entry;
1982 -- Unconditional exit points, which are included in the current
1983 -- statement sequence, but then terminate it
1985 when N_Requeue_Statement |
1987 N_Raise_Statement =>
1988 Extend_Statement_Sequence (N, ' ');
1989 Set_Statement_Entry;
1990 Current_Dominant := No_Dominant;
1992 -- Simple return statement. which is an exit point, but we
1993 -- have to process the return expression for decisions.
1995 when N_Simple_Return_Statement =>
1996 Extend_Statement_Sequence (N, ' ');
1997 Process_Decisions_Defer (Expression (N), 'X
');
1998 Set_Statement_Entry;
1999 Current_Dominant := No_Dominant;
2001 -- Extended return statement
2003 when N_Extended_Return_Statement =>
2004 Extend_Statement_Sequence (N, 'R
');
2005 Process_Decisions_Defer
2006 (Return_Object_Declarations (N), 'X
');
2007 Set_Statement_Entry;
2009 Traverse_Handled_Statement_Sequence
2010 (N => Handled_Statement_Sequence (N),
2011 D => Current_Dominant);
2013 Current_Dominant := No_Dominant;
2015 -- Loop ends the current statement sequence, but we include
2016 -- the iteration scheme if present in the current sequence.
2017 -- But the body of the loop starts a new sequence, since it
2018 -- may not be executed as part of the current sequence.
2020 when N_Loop_Statement =>
2022 ISC : constant Node_Id := Iteration_Scheme (N);
2023 Inner_Dominant : Dominant_Info := No_Dominant;
2026 if Present (ISC) then
2028 -- If iteration scheme present, extend the current
2029 -- statement sequence to include the iteration scheme
2030 -- and process any decisions it contains.
2034 if Present (Condition (ISC)) then
2035 Extend_Statement_Sequence (N, 'W
');
2036 Process_Decisions_Defer (Condition (ISC), 'W
');
2038 -- Set more specific dominant for inner statements
2039 -- (the control sloc for the decision is that of
2040 -- the WHILE token).
2042 Inner_Dominant := ('T
', ISC);
2047 Extend_Statement_Sequence (N, 'F
');
2048 Process_Decisions_Defer
2049 (Loop_Parameter_Specification (ISC), 'X
');
2053 Set_Statement_Entry;
2055 if Inner_Dominant = No_Dominant then
2056 Inner_Dominant := Current_Dominant;
2059 Traverse_Declarations_Or_Statements
2060 (L => Statements (N),
2061 D => Inner_Dominant);
2068 -- Record sloc of pragma (pragmas don't nest)
2070 pragma Assert (Current_Pragma_Sloc = No_Location);
2071 Current_Pragma_Sloc := Sloc (N);
2073 -- Processing depends on the kind of pragma
2076 Nam : constant Name_Id := Pragma_Name (N);
2078 First (Pragma_Argument_Associations (N));
2084 Name_Assert_And_Cut |
2087 Name_Loop_Invariant |
2089 Name_Postcondition =>
2091 -- For Assert/Check/Precondition/Postcondition, we
2092 -- must generate a P entry for the decision. Note
2093 -- that this is done unconditionally at this stage.
2094 -- Output for disabled pragmas is suppressed later
2095 -- on when we output the decision line in Put_SCOs,
2096 -- depending on setting by Set_SCO_Pragma_Enabled.
2098 if Nam = Name_Check then
2102 Process_Decisions_Defer (Expression (Arg), 'P
');
2105 -- Pre/postconditions can be inherited so SCO should
2106 -- never be deactivated???
2109 if Present (Arg) and then Present (Next (Arg)) then
2111 -- Case of a dyadic pragma Debug: first argument
2112 -- is a P decision, any nested decision in the
2113 -- second argument is an X decision.
2115 Process_Decisions_Defer (Expression (Arg), 'P
');
2119 Process_Decisions_Defer (Expression (Arg), 'X
');
2122 -- For all other pragmas, we generate decision entries
2123 -- for any embedded expressions, and the pragma is
2126 -- Should generate P decisions (not X) for assertion
2127 -- related pragmas: [Type_]Invariant,
2128 -- [{Static,Dynamic}_]Predicate???
2131 Process_Decisions_Defer (N, 'X
');
2135 -- Add statement SCO
2137 Extend_Statement_Sequence (N, Typ);
2139 Current_Pragma_Sloc := No_Location;
2142 -- Object declaration. Ignored if Prev_Ids is set, since the
2143 -- parser generates multiple instances of the whole declaration
2144 -- if there is more than one identifier declared, and we only
2145 -- want one entry in the SCOs, so we take the first, for which
2146 -- Prev_Ids is False.
2148 when N_Object_Declaration | N_Number_Declaration =>
2149 if not Prev_Ids (N) then
2150 Extend_Statement_Sequence (N, 'o
');
2152 if Has_Decision (N) then
2153 Process_Decisions_Defer (N, 'X
');
2157 -- All other cases, which extend the current statement sequence
2158 -- but do not terminate it, even if they have nested decisions.
2160 when N_Protected_Type_Declaration | N_Task_Type_Declaration =>
2161 Extend_Statement_Sequence (N, 't
');
2162 Process_Decisions_Defer (Discriminant_Specifications (N), 'X
');
2163 Set_Statement_Entry;
2165 Traverse_Sync_Definition (N);
2167 when N_Single_Protected_Declaration | N_Single_Task_Declaration =>
2168 Extend_Statement_Sequence (N, 'o
');
2169 Set_Statement_Entry;
2171 Traverse_Sync_Definition (N);
2175 -- Determine required type character code, or ASCII.NUL if
2176 -- no SCO should be generated for this node.
2179 NK : constant Node_Kind := Nkind (N);
2184 when N_Full_Type_Declaration |
2185 N_Incomplete_Type_Declaration |
2186 N_Private_Type_Declaration |
2187 N_Private_Extension_Declaration =>
2190 when N_Subtype_Declaration =>
2193 when N_Renaming_Declaration =>
2196 when N_Generic_Instantiation =>
2199 when N_Representation_Clause |
2200 N_Use_Package_Clause |
2202 N_Package_Body_Stub |
2204 N_Protected_Body_Stub =>
2207 when N_Procedure_Call_Statement =>
2211 if NK in N_Statement_Other_Than_Procedure_Call then
2218 if Typ /= ASCII.NUL then
2219 Extend_Statement_Sequence (N, Typ);
2223 -- Process any embedded decisions
2225 if Has_Decision (N) then
2226 Process_Decisions_Defer (N, 'X
');
2230 -- Process aspects if present
2232 Traverse_Aspects (N);
2235 -- Start of processing for Traverse_Declarations_Or_Statements
2238 -- Process single prefixed node
2244 -- Loop through statements or declarations
2246 if Is_Non_Empty_List (L) then
2248 while Present (N) loop
2250 -- Note: For separate bodies, we see the tree after Par.Labl has
2251 -- introduced implicit labels, so we need to ignore those nodes.
2253 if Nkind (N) /= N_Implicit_Label_Declaration then
2262 -- End sequence of statements and flush deferred decisions
2264 if Present (P) or else Is_Non_Empty_List (L) then
2265 Set_Statement_Entry;
2268 return Current_Dominant;
2269 end Traverse_Declarations_Or_Statements;
2271 ------------------------------------------
2272 -- Traverse_Generic_Package_Declaration --
2273 ------------------------------------------
2275 procedure Traverse_Generic_Package_Declaration (N : Node_Id) is
2277 Process_Decisions (Generic_Formal_Declarations (N), 'X
', No_Location);
2278 Traverse_Package_Declaration (N);
2279 end Traverse_Generic_Package_Declaration;
2281 -----------------------------------------
2282 -- Traverse_Handled_Statement_Sequence --
2283 -----------------------------------------
2285 procedure Traverse_Handled_Statement_Sequence
2287 D : Dominant_Info := No_Dominant)
2292 -- For package bodies without a statement part, the parser adds an empty
2293 -- one, to normalize the representation. The null statement therein,
2294 -- which does not come from source, does not get a SCO.
2296 if Present (N) and then Comes_From_Source (N) then
2297 Traverse_Declarations_Or_Statements (Statements (N), D);
2299 if Present (Exception_Handlers (N)) then
2300 Handler := First (Exception_Handlers (N));
2301 while Present (Handler) loop
2302 Traverse_Declarations_Or_Statements
2303 (L => Statements (Handler),
2304 D => ('E
', Handler));
2309 end Traverse_Handled_Statement_Sequence;
2311 ---------------------------
2312 -- Traverse_Package_Body --
2313 ---------------------------
2315 procedure Traverse_Package_Body (N : Node_Id) is
2316 Dom : Dominant_Info;
2318 -- The first statement in the handled sequence of statements is
2319 -- dominated by the elaboration of the last declaration.
2321 Dom := Traverse_Declarations_Or_Statements (Declarations (N));
2323 Traverse_Handled_Statement_Sequence
2324 (Handled_Statement_Sequence (N), Dom);
2325 end Traverse_Package_Body;
2327 ----------------------------------
2328 -- Traverse_Package_Declaration --
2329 ----------------------------------
2331 procedure Traverse_Package_Declaration
2333 D : Dominant_Info := No_Dominant)
2335 Spec : constant Node_Id := Specification (N);
2336 Dom : Dominant_Info;
2340 Traverse_Declarations_Or_Statements (Visible_Declarations (Spec), D);
2342 -- First private declaration is dominated by last visible declaration
2344 Traverse_Declarations_Or_Statements (Private_Declarations (Spec), Dom);
2345 end Traverse_Package_Declaration;
2347 ------------------------------
2348 -- Traverse_Sync_Definition --
2349 ------------------------------
2351 procedure Traverse_Sync_Definition (N : Node_Id) is
2352 Dom_Info : Dominant_Info := ('S
', N);
2353 -- The first declaration is dominated by the protected or task [type]
2357 -- N's protected or task definition
2360 -- Sync_Def's Visible_Declarations
2364 when N_Single_Protected_Declaration | N_Protected_Type_Declaration =>
2365 Sync_Def := Protected_Definition (N);
2367 when N_Single_Task_Declaration | N_Task_Type_Declaration =>
2368 Sync_Def := Task_Definition (N);
2371 raise Program_Error;
2374 Vis_Decl := Visible_Declarations (Sync_Def);
2376 Dom_Info := Traverse_Declarations_Or_Statements
2380 -- If visible declarations are present, the first private declaration
2381 -- is dominated by the last visible declaration.
2383 Traverse_Declarations_Or_Statements
2384 (L => Private_Declarations (Sync_Def),
2386 end Traverse_Sync_Definition;
2388 --------------------------------------
2389 -- Traverse_Subprogram_Or_Task_Body --
2390 --------------------------------------
2392 procedure Traverse_Subprogram_Or_Task_Body
2394 D : Dominant_Info := No_Dominant)
2396 Decls : constant List_Id := Declarations (N);
2397 Dom_Info : Dominant_Info := D;
2399 -- If declarations are present, the first statement is dominated by the
2400 -- last declaration.
2402 Dom_Info := Traverse_Declarations_Or_Statements
2403 (L => Decls, D => Dom_Info);
2405 Traverse_Handled_Statement_Sequence
2406 (N => Handled_Statement_Sequence (N),
2408 end Traverse_Subprogram_Or_Task_Body;
2410 -------------------------
2411 -- SCO_Record_Filtered --
2412 -------------------------
2414 procedure SCO_Record_Filtered is
2415 type Decision is record
2417 -- Type of the SCO decision (see comments for SCO_Table_Entry.C1)
2419 Sloc : Source_Location;
2422 -- Index in the SCO_Raw_Table for the root operator/condition for the
2423 -- expression that controls the decision.
2425 -- Decision descriptor: used to gather information about a candidate
2428 package Pending_Decisions is new Table.Table
2429 (Table_Component_Type => Decision,
2430 Table_Index_Type => Nat,
2431 Table_Low_Bound => 1,
2432 Table_Initial => 1000,
2433 Table_Increment => 200,
2434 Table_Name => "Filter_Pending_Decisions");
2435 -- Table used to hold decisions to process during the collection pass
2437 function Is_Decision (Idx : Nat) return Boolean;
2438 -- Return if the expression tree starting at Idx has adjacent nested
2439 -- nodes that make a decision.
2441 procedure Search_Nested_Decisions (Idx : in out Nat);
2442 -- Collect decisions to add to the filtered SCO table starting at the
2443 -- node at Idx in the SCO raw table. This node must not be part of an
2444 -- already-processed decision. Set Idx to the first node index passed
2445 -- the whole expression tree.
2447 procedure Skip_Decision
2449 Process_Nested_Decisions : Boolean);
2450 -- Skip all the nodes that belong to the decision starting at Idx. If
2451 -- Process_Nested_Decision, call Search_Nested_Decisions on the first
2452 -- nested nodes that do not belong to the decision. Set Idx to the first
2453 -- node index passed the whole expression tree.
2455 procedure Collect_Decisions
2458 -- Collect decisions to add to the filtered SCO table starting at the
2459 -- D decision (including it and its nested operators/conditions). Set
2460 -- Next to the first node index passed the whole decision.
2462 procedure Compute_Range
2464 From : out Source_Location;
2465 To : out Source_Location);
2466 -- Compute the source location range for the expression tree starting at
2467 -- Idx in the SCO raw table. Store its bounds in From and To.
2469 procedure Add_Expression_Tree (Idx : in out Nat);
2470 -- Add SCO raw table entries for the decision controlling expression
2471 -- tree starting at Idx to the filtered SCO table.
2473 procedure Process_Pending_Decisions
2474 (Original_Decision : SCO_Table_Entry);
2475 -- Complete the filtered SCO table using collected decisions. Output
2476 -- decisions inherit the pragma information from the original decision.
2482 function Is_Decision (Idx : Nat) return Boolean is
2488 T : SCO_Table_Entry renames SCO_Raw_Table.Table (Index);
2497 -- This is a decision iff the only operand of the NOT
2498 -- operator could be a standalone decision.
2504 -- This node is a logical operator (and thus could be a
2505 -- standalone decision) iff it is a short circuit
2515 -----------------------------
2516 -- Search_Nested_Decisions --
2517 -----------------------------
2519 procedure Search_Nested_Decisions (Idx : in out Nat)
2524 T : SCO_Table_Entry renames SCO_Raw_Table.Table (Idx);
2543 -- This in not a logical operator: start looking for
2544 -- nested decisions from here. Recurse over the left
2545 -- child and let the loop take care of the right one.
2548 Search_Nested_Decisions (Idx);
2551 -- We found a nested decision
2563 end Search_Nested_Decisions;
2569 procedure Skip_Decision
2571 Process_Nested_Decisions : Boolean)
2576 T : SCO_Table_Entry renames SCO_Raw_Table.Table (Idx);
2587 -- This NOT operator belongs to the outside decision:
2593 if T.C2 = '?
' and then Process_Nested_Decisions then
2595 -- This in not a logical operator: start looking for
2596 -- nested decisions from here. Recurse over the left
2597 -- child and let the loop take care of the right one.
2599 Search_Nested_Decisions (Idx);
2602 -- This is a logical operator, so it belongs to the
2603 -- outside decision: skip its left child, then let the
2604 -- loop take care of the right one.
2606 Skip_Decision (Idx, Process_Nested_Decisions);
2613 -----------------------
2614 -- Collect_Decisions --
2615 -----------------------
2617 procedure Collect_Decisions
2623 if D.Kind /= 'X
' or else Is_Decision (D.Top) then
2624 Pending_Decisions.Append (D);
2627 Skip_Decision (Idx, True);
2629 end Collect_Decisions;
2635 procedure Compute_Range
2637 From : out Source_Location;
2638 To : out Source_Location)
2640 Sloc_F, Sloc_T : Source_Location := No_Source_Location;
2642 procedure Process_One;
2643 -- Process one node of the tree, and recurse over children. Update
2644 -- Idx during the traversal.
2650 procedure Process_One is
2652 if Sloc_F = No_Source_Location
2654 SCO_Raw_Table.Table (Idx).From < Sloc_F
2656 Sloc_F := SCO_Raw_Table.Table (Idx).From;
2658 if Sloc_T = No_Source_Location
2660 Sloc_T < SCO_Raw_Table.Table (Idx).To
2662 Sloc_T := SCO_Raw_Table.Table (Idx).To;
2665 if SCO_Raw_Table.Table (Idx).C1 = ' ' then
2667 -- This is a condition: nothing special to do
2671 elsif SCO_Raw_Table.Table (Idx).C1 = '!' then
2673 -- The "not" operator has only one operand
2679 -- This is an AND THEN or OR ELSE logical operator: follow the
2680 -- left, then the right operands.
2689 -- Start of processing for Compute_Range
2697 -------------------------
2698 -- Add_Expression_Tree --
2699 -------------------------
2701 procedure Add_Expression_Tree (Idx : in out Nat)
2703 Node_Idx : constant Nat := Idx;
2704 T : SCO_Table_Entry renames SCO_Raw_Table.Table (Node_Idx);
2705 From, To : Source_Location;
2711 -- This is a single condition. Add an entry for it and move on
2713 SCO_Table.Append (T);
2718 -- This is a NOT operator: add an entry for it and browse its
2721 SCO_Table.Append (T);
2723 Add_Expression_Tree (Idx);
2727 -- This must be an AND/OR/AND THEN/OR ELSE operator
2731 -- This is not a short circuit operator: consider this one
2732 -- and all its children as a single condition.
2734 Compute_Range (Idx, From, To);
2741 Pragma_Sloc => No_Location,
2742 Pragma_Aspect_Name => No_Name));
2745 -- This is a real short circuit operator: add an entry for
2746 -- it and browse its children.
2748 SCO_Table.Append (T);
2750 Add_Expression_Tree (Idx);
2751 Add_Expression_Tree (Idx);
2754 end Add_Expression_Tree;
2756 -------------------------------
2757 -- Process_Pending_Decisions --
2758 -------------------------------
2760 procedure Process_Pending_Decisions
2761 (Original_Decision : SCO_Table_Entry)
2764 for Index in 1 .. Pending_Decisions.Last loop
2766 D : Decision renames Pending_Decisions.Table (Index);
2770 -- Add a SCO table entry for the decision itself
2772 pragma Assert (D.Kind /= ' ');
2775 ((To => No_Source_Location,
2780 Pragma_Sloc => Original_Decision.Pragma_Sloc,
2781 Pragma_Aspect_Name =>
2782 Original_Decision.Pragma_Aspect_Name));
2784 -- Then add ones for its nested operators/operands. Do not
2785 -- forget to tag its *last* entry as such.
2787 Add_Expression_Tree (Idx);
2788 SCO_Table.Table (SCO_Table.Last).Last := True;
2792 -- Clear the pending decisions list
2793 Pending_Decisions.Set_Last (0);
2794 end Process_Pending_Decisions;
2796 -- Start of processing for SCO_Record_Filtered
2799 -- Filtering must happen only once: do nothing if it this pass was
2802 if SCO_Generation_State = Filtered then
2805 pragma Assert (SCO_Generation_State = Raw);
2806 SCO_Generation_State := Filtered;
2809 -- Loop through all SCO entries under SCO units
2811 for Unit_Idx in 1 .. SCO_Unit_Table.Last loop
2813 Unit : SCO_Unit_Table_Entry
2814 renames SCO_Unit_Table.Table (Unit_Idx);
2816 Idx : Nat := Unit.From;
2817 -- Index of the current SCO raw table entry
2819 New_From : constant Nat := SCO_Table.Last + 1;
2820 -- After copying SCO enties of interest to the final table, we
2821 -- will have to change the From/To indexes this unit targets.
2822 -- This constant keeps track of the new From index.
2825 while Idx <= Unit.To loop
2827 T : SCO_Table_Entry renames SCO_Raw_Table.Table (Idx);
2832 -- Decision (of any kind, including pragmas and aspects)
2834 when 'E
' | 'G
' | 'I
' | 'W
' | 'X
' | 'P
' | 'a
' | 'A
' =>
2835 if SCO_Pragma_Disabled (T.Pragma_Sloc) then
2837 -- Skip SCO entries for decisions in disabled
2838 -- constructs (pragmas or aspects).
2841 Skip_Decision (Idx, False);
2849 Process_Pending_Decisions (T);
2852 -- There is no translation/filtering to do for other kind
2853 -- of SCO items (statements, dominance markers, etc.).
2855 when '|
' | '&' | '!' | ' ' =>
2857 -- SCO logical operators and conditions cannot exist
2858 -- on their own: they must be inside a decision (such
2859 -- entries must have been skipped by
2860 -- Collect_Decisions).
2862 raise Program_Error;
2865 SCO_Table.Append (T);
2871 -- Now, update the SCO entry indexes in the unit entry
2873 Unit.From := New_From;
2874 Unit.To := SCO_Table.Last;
2878 -- Then clear the raw table to free bytes
2881 end SCO_Record_Filtered;