annotate gcc/ada/libgnat/s-traceb.ads @ 131:84e7813d76e9

gcc-8.2
author mir3636
date Thu, 25 Oct 2018 07:37:49 +0900
parents 04ced10e8804
children 1830386684a0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 ------------------------------------------------------------------------------
kono
parents:
diff changeset
2 -- --
kono
parents:
diff changeset
3 -- GNAT COMPILER COMPONENTS --
kono
parents:
diff changeset
4 -- --
kono
parents:
diff changeset
5 -- S Y S T E M . T R A C E B A C K --
kono
parents:
diff changeset
6 -- --
kono
parents:
diff changeset
7 -- S p e c --
kono
parents:
diff changeset
8 -- --
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
9 -- Copyright (C) 1999-2018, Free Software Foundation, Inc. --
111
kono
parents:
diff changeset
10 -- --
kono
parents:
diff changeset
11 -- GNAT is free software; you can redistribute it and/or modify it under --
kono
parents:
diff changeset
12 -- terms of the GNU General Public License as published by the Free Soft- --
kono
parents:
diff changeset
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
kono
parents:
diff changeset
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
kono
parents:
diff changeset
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
kono
parents:
diff changeset
16 -- or FITNESS FOR A PARTICULAR PURPOSE. --
kono
parents:
diff changeset
17 -- --
kono
parents:
diff changeset
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
kono
parents:
diff changeset
19 -- additional permissions described in the GCC Runtime Library Exception, --
kono
parents:
diff changeset
20 -- version 3.1, as published by the Free Software Foundation. --
kono
parents:
diff changeset
21 -- --
kono
parents:
diff changeset
22 -- You should have received a copy of the GNU General Public License and --
kono
parents:
diff changeset
23 -- a copy of the GCC Runtime Library Exception along with this program; --
kono
parents:
diff changeset
24 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
kono
parents:
diff changeset
25 -- <http://www.gnu.org/licenses/>. --
kono
parents:
diff changeset
26 -- --
kono
parents:
diff changeset
27 -- GNAT was originally developed by the GNAT team at New York University. --
kono
parents:
diff changeset
28 -- Extensive contributions were provided by Ada Core Technologies Inc. --
kono
parents:
diff changeset
29 -- --
kono
parents:
diff changeset
30 ------------------------------------------------------------------------------
kono
parents:
diff changeset
31
kono
parents:
diff changeset
32 -- This package provides a method for generating a traceback of the current
kono
parents:
diff changeset
33 -- execution location. The traceback shows the locations of calls in the call
kono
parents:
diff changeset
34 -- chain, up to either the top or a designated number of levels.
kono
parents:
diff changeset
35
kono
parents:
diff changeset
36 pragma Compiler_Unit_Warning;
kono
parents:
diff changeset
37
kono
parents:
diff changeset
38 pragma Polling (Off);
kono
parents:
diff changeset
39 -- We must turn polling off for this unit, because otherwise we get
kono
parents:
diff changeset
40 -- elaboration circularities with System.Exception_Tables.
kono
parents:
diff changeset
41
kono
parents:
diff changeset
42 with System.Traceback_Entries;
kono
parents:
diff changeset
43
kono
parents:
diff changeset
44 package System.Traceback is
kono
parents:
diff changeset
45
kono
parents:
diff changeset
46 ----------------
kono
parents:
diff changeset
47 -- Call_Chain --
kono
parents:
diff changeset
48 ----------------
kono
parents:
diff changeset
49
kono
parents:
diff changeset
50 procedure Call_Chain
kono
parents:
diff changeset
51 (Traceback : in out System.Traceback_Entries.Tracebacks_Array;
kono
parents:
diff changeset
52 Max_Len : Natural;
kono
parents:
diff changeset
53 Len : out Natural;
kono
parents:
diff changeset
54 Exclude_Min : System.Address := System.Null_Address;
kono
parents:
diff changeset
55 Exclude_Max : System.Address := System.Null_Address;
kono
parents:
diff changeset
56 Skip_Frames : Natural := 1);
kono
parents:
diff changeset
57 -- Store up to Max_Len code locations in Traceback, corresponding to the
kono
parents:
diff changeset
58 -- current call chain.
kono
parents:
diff changeset
59 --
kono
parents:
diff changeset
60 -- Traceback is an array of addresses where the result will be stored.
kono
parents:
diff changeset
61 --
kono
parents:
diff changeset
62 -- Max_Len is the length of the Traceback array. If the call chain is
kono
parents:
diff changeset
63 -- longer than this, then additional entries are discarded, and the
kono
parents:
diff changeset
64 -- traceback is missing some of the highest level entries.
kono
parents:
diff changeset
65 --
kono
parents:
diff changeset
66 -- Len is the number of addresses returned in the Traceback array
kono
parents:
diff changeset
67 --
kono
parents:
diff changeset
68 -- Exclude_Min/Exclude_Max, if non null, provide a range of addresses
kono
parents:
diff changeset
69 -- to ignore from the computation of the traceback.
kono
parents:
diff changeset
70 --
kono
parents:
diff changeset
71 -- Skip_Frames says how many of the most recent calls should at least
kono
parents:
diff changeset
72 -- be excluded from the result, regardless of the exclusion bounds and
kono
parents:
diff changeset
73 -- starting with this procedure itself: 1 means exclude the frame for
kono
parents:
diff changeset
74 -- this procedure, 2 means 1 + exclude the frame for this procedure's
kono
parents:
diff changeset
75 -- caller, ...
kono
parents:
diff changeset
76 --
kono
parents:
diff changeset
77 -- On return, the Traceback array is filled in, and Len indicates the
kono
parents:
diff changeset
78 -- number of stored entries. The first entry is the most recent call,
kono
parents:
diff changeset
79 -- and the last entry is the highest level call.
kono
parents:
diff changeset
80
kono
parents:
diff changeset
81 function C_Call_Chain
kono
parents:
diff changeset
82 (Traceback : System.Address;
kono
parents:
diff changeset
83 Max_Len : Natural) return Natural;
kono
parents:
diff changeset
84 pragma Export (C, C_Call_Chain, "system__traceback__c_call_chain");
kono
parents:
diff changeset
85 -- Version that can be used directly from C
kono
parents:
diff changeset
86
kono
parents:
diff changeset
87 end System.Traceback;