1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
5 -- V X A D D R 2 L I N E --
9 -- Copyright (C) 2002-2007, AdaCore --
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 -- This program is meant to be used with vxworks to compute symbolic
27 -- backtraces on the host from non-symbolic backtraces obtained on the target.
29 -- The basic idea is to automate the computation of the necessary address
30 -- adjustments prior to calling addr2line when the application has only been
31 -- partially linked on the host.
33 -- Variants for various targets are supported, and the command line should
36 -- <target>-addr2line [-a <target_arch>] <exe_file> <ref_address>
37 -- <backtrace addresses>
41 -- selects the target architecture. In the absence of this parameter the
42 -- default variant is chosen based on the Detect_Arch result. Generally,
43 -- this parameter will only be used if vxaddr2line is recompiled manually.
44 -- Otherwise, the command name will always be of the form
45 -- <target>-vxaddr2line where there is no ambiguity on the target's
49 -- The name of the partially linked binary file for the application.
52 -- Runtime address (on the target) of a reference symbol you choose,
53 -- which name shall match the value of the Ref_Symbol variable declared
54 -- below. A symbol with a small offset from the beginning of the text
55 -- segment is better, so "adainit" is a good choice.
57 -- <backtrace addresses> :
58 -- The call chain addresses you obtained at run time on the target and
59 -- for which you want a symbolic association.
61 -- TO ADD A NEW ARCHITECTURE add an appropriate value to Architecture type
62 -- (in a format <host>_<target>), and then an appropriate value to Config_List
65 with Text_IO
; use Text_IO
;
66 with Ada
.Integer_Text_IO
; use Ada
.Integer_Text_IO
;
67 with Ada
.Command_Line
; use Ada
.Command_Line
;
68 with Ada
.Strings
.Fixed
; use Ada
.Strings
.Fixed
;
70 with GNAT
.OS_Lib
; use GNAT
.OS_Lib
;
71 with GNAT
.Directory_Operations
; use GNAT
.Directory_Operations
;
72 with GNAT
.Expect
; use GNAT
.Expect
;
73 with GNAT
.Regpat
; use GNAT
.Regpat
;
75 procedure VxAddr2Line
is
77 Ref_Symbol
: constant String := "adainit";
78 -- This is the name of the reference symbol which runtime address shall
79 -- be provided as the <ref_address> argument.
81 -- All supported architectures
90 type Arch_Record
is record
91 Addr2line_Binary
: String_Access
;
92 -- Name of the addr2line utility to use
94 Nm_Binary
: String_Access
;
95 -- Name of the host nm utility, which will be used to find out the
96 -- offset of the reference symbol in the text segment of the partially
99 Addr_Digits_To_Skip
: Integer;
100 -- When addresses such as 0xfffffc0001dfed50 are provided, for instance
101 -- on ALPHA, indicate the number of leading digits that can be ignored,
102 -- which will avoid computational overflows. Typically only useful when
103 -- 64bit addresses are provided.
105 Bt_Offset_From_Call
: Integer;
106 -- Offset from a backtrace address to the address of the corresponding
107 -- call instruction. This should always be 0, except on platforms where
108 -- the backtrace addresses actually correspond to return and not call
109 -- points. In such cases, a negative value is most likely.
112 -- Configuration for each of the architectures
113 Arch_List
: array (Architecture
'Range) of Arch_Record
:=
115 (Addr2line_Binary
=> null,
117 Addr_Digits_To_Skip
=> 0,
118 Bt_Offset_From_Call
=> -4),
120 (Addr2line_Binary
=> null,
122 Addr_Digits_To_Skip
=> 0,
123 Bt_Offset_From_Call
=> -4),
125 (Addr2line_Binary
=> null,
127 Addr_Digits_To_Skip
=> 0,
128 Bt_Offset_From_Call
=> -2),
130 (Addr2line_Binary
=> null,
132 Addr_Digits_To_Skip
=> 0,
133 Bt_Offset_From_Call
=> 0),
135 (Addr2line_Binary
=> null,
137 Addr_Digits_To_Skip
=> 0,
138 Bt_Offset_From_Call
=> -2),
140 (Addr2line_Binary
=> null,
142 Addr_Digits_To_Skip
=> 8,
143 Bt_Offset_From_Call
=> 0)
146 -- Current architecture
147 Cur_Arch
: Architecture
;
149 -- State of architecture detection
150 Detect_Success
: Boolean := False;
152 -----------------------
153 -- Local subprograms --
154 -----------------------
156 procedure Error
(Msg
: String);
157 pragma No_Return
(Error
);
158 -- Prints the message and then terminates the program
161 -- Displays the short help message and then terminates the program
163 function Get_Reference_Offset
return Integer;
164 -- Computes the static offset of the reference symbol by calling nm
166 function Get_Value_From_Hex_Arg
(Arg
: Natural) return Integer;
167 -- Threats the argument number Arg as a C-style hexadecimal literal
168 -- and returns its integer value
170 function Hex_Image
(Value
: Integer) return String_Access
;
171 -- Returns access to a string that contains hexadecimal image of Value
173 -- Separate functions that provide build-time customization:
175 procedure Detect_Arch
;
176 -- Saves in Cur_Arch the current architecture, based on the name of
177 -- vxaddr2line instance and properties of the host. Detect_Success is False
178 -- if detection fails
184 procedure Detect_Arch
is
185 Name
: constant String := Base_Name
(Command_Name
);
186 Proc
: constant String :=
187 Name
(Name
'First .. Index
(Name
, "-") - 1);
188 Target
: constant String :=
189 Name
(Name
'First .. Index
(Name
, "vxaddr2line") - 1);
192 Detect_Success
:= False;
198 if Proc
= "alpha" then
199 Cur_Arch
:= DEC_ALPHA
;
201 -- Let's detect the host.
202 -- ??? A naive implementation that can't distinguish between Unixes
203 if Directory_Separator
= '/' then
204 Cur_Arch
:= Architecture
'Value ("solaris_" & Proc
);
206 Cur_Arch
:= Architecture
'Value ("windows_" & Proc
);
210 if Arch_List
(Cur_Arch
).Addr2line_Binary
= null then
211 Arch_List
(Cur_Arch
).Addr2line_Binary
:= new String'
212 (Target & "addr2line");
214 if Arch_List (Cur_Arch).Nm_Binary = null then
215 Arch_List (Cur_Arch).Nm_Binary := new String'
219 Detect_Success
:= True;
230 procedure Error
(Msg
: String) is
237 --------------------------
238 -- Get_Reference_Offset --
239 --------------------------
241 function Get_Reference_Offset
return Integer is
242 Nm_Cmd
: constant String_Access
:=
243 Locate_Exec_On_Path
(Arch_List
(Cur_Arch
).Nm_Binary
.all);
245 Nm_Args
: constant Argument_List
:=
247 new String'(Argument
(1)));
249 Forever
: aliased String := "^@@@@";
250 Reference
: aliased String := Ref_Symbol
& "\s+\S\s+([\da-fA-F]+)";
252 Pd
: Process_Descriptor
;
253 Result
: Expect_Match
;
256 -- If Nm is not found, abort
258 if Nm_Cmd
= null then
259 Error
("Couldn't find " & Arch_List
(Cur_Arch
).Nm_Binary
.all);
263 (Pd
, Nm_Cmd
.all, Nm_Args
, Buffer_Size
=> 0, Err_To_Out
=> True);
265 -- Expect a string containing the reference symbol
268 Regexp_Array
'(1 => Reference'Unchecked_Access),
271 -- If we are here, the pattern was matched successfully
274 Match_String : constant String := Expect_Out_Match (Pd);
275 Matches : Match_Array (0 .. 1);
279 Match (Reference, Match_String, Matches);
280 Value := Integer'Value
282 & Match_String (Matches (1).First .. Matches (1).Last) & "#");
284 -- Expect a string that will never be emitted, so that the
285 -- process can be correctly terminated (with Process_Died)
288 Regexp_Array'(1 => Forever
'Unchecked_Access),
296 -- We cannot get here
301 when Invalid_Process
=>
302 Error
("Could not spawn a process " & Nm_Cmd
.all);
306 -- The process died without matching the reference symbol or the
307 -- format wasn't recognized.
309 Error
("Unexpected output from " & Nm_Cmd
.all);
310 end Get_Reference_Offset
;
312 ----------------------------
313 -- Get_Value_From_Hex_Arg --
314 ----------------------------
316 function Get_Value_From_Hex_Arg
(Arg
: Natural) return Integer is
317 Cur_Arg
: constant String := Argument
(Arg
);
321 -- Skip "0x" prefix if present
323 if Cur_Arg
'Length > 2 and then Cur_Arg
(1 .. 2) = "0x" then
329 -- Add architecture-specific offset
331 Offset
:= Offset
+ Arch_List
(Cur_Arch
).Addr_Digits_To_Skip
;
335 return Integer'Value ("16#" & Cur_Arg
(Offset
.. Cur_Arg
'Last) & "#");
336 end Get_Value_From_Hex_Arg
;
342 function Hex_Image
(Value
: Integer) return String_Access
is
343 Result
: String (1 .. 20);
347 Put
(Result
, Value
, 16);
348 Start_Pos
:= Index
(Result
, "16#") + 3;
349 return new String'(Result (Start_Pos .. Result'Last - 1));
358 Put_Line ("Usage : " & Base_Name (Command_Name)
360 & Ref_Symbol & " offset on target> <addr1> ...");
365 Ref_Static_Offset, Ref_Runtime_Address, Bt_Address : Integer;
367 Addr2line_Cmd : String_Access;
369 Addr2line_Args : Argument_List (1 .. 501);
370 -- We expect that there won't be more than 500 backtrace frames
372 Addr2line_Args_Count : Natural;
376 -- Start of processing for VxAddr2Line
382 -- There should be at least two arguments
384 if Argument_Count < 2 then
388 -- ??? HARD LIMIT! There should be at most 501 arguments
390 if Argument_Count > 501 then
391 Error ("Too many backtrace frames");
394 -- Do we have a valid architecture?
396 if not Detect_Success then
397 Put_Line ("Couldn't detect the architecture");
402 Locate_Exec_On_Path (Arch_List (Cur_Arch).Addr2line_Binary.all);
404 -- If Addr2line is not found, abort
406 if Addr2line_Cmd = null then
407 Error ("Couldn't find " & Arch_List (Cur_Arch).Addr2line_Binary.all);
410 -- The first argument specifies the image file. Check if it exists
412 if not Is_Regular_File (Argument (1)) then
413 Error ("Couldn't find the executable " & Argument (1));
416 -- The second argument specifies the reference symbol runtime address.
417 -- Let's parse and store it
419 Ref_Runtime_Address := Get_Value_From_Hex_Arg (2);
421 -- Run nm command to get the reference symbol static offset
423 Ref_Static_Offset := Get_Reference_Offset;
425 -- Build addr2line parameters. First, the standard part
427 Addr2line_Args (1) := new String'("--exe=" & Argument
(1));
428 Addr2line_Args_Count
:= 1;
430 -- Now, append to this the adjusted backtraces in arguments 4 and further
432 for J
in 3 .. Argument_Count
loop
434 -- Basically, for each address in the runtime backtrace ...
436 -- o We compute its offset relatively to the runtime address of the
441 -- o We add this offset to the static one for the reference symbol in
442 -- the executable to find the executable offset corresponding to the
443 -- backtrace address.
445 Bt_Address
:= Get_Value_From_Hex_Arg
(J
);
448 Bt_Address
- Ref_Runtime_Address
450 + Arch_List
(Cur_Arch
).Bt_Offset_From_Call
;
452 Addr2line_Args_Count
:= Addr2line_Args_Count
+ 1;
453 Addr2line_Args
(Addr2line_Args_Count
) := Hex_Image
(Bt_Address
);
456 -- Run the resulting command
458 Spawn
(Addr2line_Cmd
.all,
459 Addr2line_Args
(1 .. Addr2line_Args_Count
), Success
);
462 Error
("Couldn't spawn " & Addr2line_Cmd
.all);
468 -- Mask all exceptions