diff options
Diffstat (limited to 'gcc/ada/gnatmem.adb')
| -rw-r--r-- | gcc/ada/gnatmem.adb | 936 |
1 files changed, 291 insertions, 645 deletions
diff --git a/gcc/ada/gnatmem.adb b/gcc/ada/gnatmem.adb index 624bf90f3bf..a852b26f8bc 100644 --- a/gcc/ada/gnatmem.adb +++ b/gcc/ada/gnatmem.adb @@ -6,7 +6,7 @@ -- -- -- B o d y -- -- -- --- Copyright (C) 1997-2002, Ada Core Technologies, Inc. -- +-- Copyright (C) 1997-2003, Ada Core Technologies, Inc. -- -- -- -- GNAT is free software; you can redistribute it and/or modify it under -- -- terms of the GNU General Public License as published by the Free Soft- -- @@ -26,40 +26,41 @@ -- GNATMEM is a utility that tracks memory leaks. It is based on a simple -- idea: --- - run the application under gdb --- - set a breakpoint on __gnat_malloc and __gnat_free --- - record a reference to the allocated memory on each allocation call --- - suppress this reference on deallocation --- - at the end of the program, remaining references are potential leaks. + +-- - Read the allocation log generated by the application linked using +-- instrumented memory allocation and dealocation (see memtrack.adb for +-- this circuitry). To get access to this functionality, the application +-- must be relinked with library libgmem.a: + +-- $ gnatmake my_prog -largs -lgmem + +-- The running my_prog will produce a file named gmem.out that will be +-- parsed by gnatmem. + +-- - Record a reference to the allocated memory on each allocation call. + +-- - Suppress this reference on deallocation. + +-- - At the end of the program, remaining references are potential leaks. -- sort them out the best possible way in order to locate the root of -- the leak. --- --- GNATMEM can also be used with instrumented allocation/deallocation --- routine (see a-raise.c with symbol GMEM defined). This is not supported --- in all platforms, again refer to a-raise.c for further information. --- In this case the application must be relinked with library libgmem.a: --- --- $ gnatmake my_prog -largs -lgmem --- --- The running my_prog will produce a file named gmem.out that will be --- parsed by gnatmem. --- + +-- This capability is not supported on all platforms, please refer to +-- memtrack.adb for further information. + -- In order to help finding out the real leaks, the notion of "allocation -- root" is defined. An allocation root is a specific point in the program -- execution generating memory allocation where data is collected (such as --- number of allocations, quantify of memory allocated, high water mark, --- etc.). +-- number of allocations, amount of memory allocated, high water mark, etc.) -with Ada.Command_Line; use Ada.Command_Line; +with GNAT.Command_Line; use GNAT.Command_Line; with Ada.Text_IO; use Ada.Text_IO; -with Ada.Text_IO.C_Streams; with Ada.Float_Text_IO; with Ada.Integer_Text_IO; with Gnatvsn; use Gnatvsn; with GNAT.Heap_Sort_G; -with GNAT.OS_Lib; +with GNAT.OS_Lib; use GNAT.OS_Lib; with GNAT.HTable; use GNAT.HTable; -with Interfaces.C_Streams; use Interfaces.C_Streams; with System; use System; with System.Storage_Elements; use System.Storage_Elements; @@ -67,61 +68,32 @@ with Memroot; use Memroot; procedure Gnatmem is - ------------------------------------------------ - -- Potentially Target Dependent Subprograms. -- - ------------------------------------------------ - - function Get_Current_TTY return String; - -- Give the current tty on which the program is run. This is needed to - -- separate the output of the debugger from the output of the program. - -- The output of this function will be used to call the gdb command "tty" - -- in the gdb script in order to get the program output on the current tty - -- while the gdb output is redirected and processed by gnatmem. - - function popen (File, Mode : System.Address) return FILEs; - pragma Import (C, popen, "popen"); - -- Execute the program 'File'. If the mode is "r" the standard output - -- of the program is redirected and the FILEs handler of the - -- redirection is returned. - - procedure System_Cmd (X : System.Address); - pragma Import (C, System_Cmd, "system"); - -- Execute the program "X". - - subtype Cstring is String (1 .. Integer'Last); - type Cstring_Ptr is access all Cstring; - - function ttyname (Dec : Integer) return Cstring_Ptr; - pragma Import (C, ttyname, "__gnat_ttyname"); - -- Return a null-terminated string containing the current tty - - Dir_Sep : constant Character := '/'; - ------------------------ -- Other Declarations -- ------------------------ - type Gdb_Output_Elmt is (Eof, Alloc, Deall); - -- Eof = End of gdb output file - -- Alloc = found a ALLOC mark in the gdb output - -- Deall = found a DEALL mark in the gdb output - Gdb_Output_Format_Error : exception; + type Storage_Elmt is record + Elmt : Character; + -- * = End of log file + -- A = found a ALLOC mark in the log + -- D = found a DEALL mark in the log + Address : Integer_Address; + Size : Storage_Count; + end record; + -- This needs a comment ??? - function Read_Next return Gdb_Output_Elmt; - -- Read the output of the debugger till it finds either the end of the - -- output, or the 'ALLOC' mark or the 'DEALL' mark. In the second case, - -- it sets the Tmp_Size and Tmp_Address global variables, in the - -- third case it sets the Tmp_Address variable. + Log_Name, Program_Name : String_Access; + -- These need comments, and should be on separate lines ??? - procedure Create_Gdb_Script; - -- Create the GDB script and save it in a temporary file + function Read_Next return Storage_Elmt; + -- Reads next dynamic storage operation from the log file. function Mem_Image (X : Storage_Count) return String; -- X is a size in storage_element. Returns a value - -- in Megabytes, Kiloytes or Bytes as appropriate. + -- in Megabytes, Kilobytes or Bytes as appropriate. procedure Process_Arguments; - -- Read command line arguments; + -- Read command line arguments procedure Usage; -- Prints out the option help @@ -135,19 +107,6 @@ procedure Gnatmem is -- Initialises the convert_addresses interface by supplying it with -- the name of the executable file Exename - procedure Gmem_Read_Next (Buf : out String; Last : out Natural); - -- Reads the next allocation/deallocation entry and its backtrace - -- and prepares in the string Buf (up to the position of Last) the - -- expression compatible with gnatmem parser: - -- Allocation entry produces the expression "ALLOC^[size]^0x[address]^" - -- Deallocation entry produces the expression "DEALLOC^0x[address]^" - - Argc : constant Integer := Argument_Count; - Gnatmem_Tmp : aliased constant String := "gnatmem.tmp"; - - Mode_R : aliased constant String (1 .. 2) := 'r' & ASCII.NUL; - Mode_W : aliased constant String (1 .. 3) := "w+" & ASCII.NUL; - ----------------------------------- -- HTable address --> Allocation -- ----------------------------------- @@ -170,12 +129,8 @@ procedure Gnatmem is Equal => "="); BT_Depth : Integer := 1; - FD : FILEs; - FT : File_Type; - File_Pos : Integer := 0; - Exec_Pos : Integer := 0; - Target_Pos : Integer := 0; - Run_Gdb : Boolean := True; + + -- The following need comments ??? Global_Alloc_Size : Storage_Count := 0; Global_High_Water_Mark : Storage_Count := 0; @@ -183,17 +138,21 @@ procedure Gnatmem is Global_Nb_Dealloc : Integer := 0; Nb_Root : Integer := 0; Nb_Wrong_Deall : Integer := 0; - Target_Name : String (1 .. 80); - Target_Protocol : String (1 .. 80); - Target_Name_Len : Integer; - Target_Protocol_Len : Integer; - Cross_Case : Boolean := False; - - Tmp_Size : Storage_Count := 0; - Tmp_Address : Integer_Address; + Minimum_NB_Leaks : Integer := 1; + Tmp_Alloc : Allocation; Quiet_Mode : Boolean := False; + ------------------------------- + -- Allocation roots sorting -- + ------------------------------- + + Sort_Order : String (1 .. 3) := "nwh"; + -- This is the default order in which sorting criteria will be applied + -- n - Total number of unfreed allocations + -- w - Final watermark + -- h - High watermark + -------------------------------- -- GMEM functionality binding -- -------------------------------- @@ -201,7 +160,9 @@ procedure Gnatmem is function Gmem_Initialize (Dumpname : String) return Boolean is function Initialize (Dumpname : System.Address) return Boolean; pragma Import (C, Initialize, "__gnat_gmem_initialize"); + S : aliased String := Dumpname & ASCII.NUL; + begin return Initialize (S'Address); end Gmem_Initialize; @@ -209,51 +170,23 @@ procedure Gnatmem is procedure Gmem_A2l_Initialize (Exename : String) is procedure A2l_Initialize (Exename : System.Address); pragma Import (C, A2l_Initialize, "__gnat_gmem_a2l_initialize"); + S : aliased String := Exename & ASCII.NUL; + begin A2l_Initialize (S'Address); end Gmem_A2l_Initialize; - procedure Gmem_Read_Next (Buf : out String; Last : out Natural) is + function Read_Next return Storage_Elmt is procedure Read_Next (buf : System.Address); pragma Import (C, Read_Next, "__gnat_gmem_read_next"); - function Strlen (str : System.Address) return Natural; - pragma Import (C, Strlen, "strlen"); - - S : String (1 .. 1000); - begin - Read_Next (S'Address); - Last := Strlen (S'Address); - Buf (1 .. Last) := S (1 .. Last); - end Gmem_Read_Next; - - --------------------- - -- Get_Current_TTY -- - --------------------- - function Get_Current_TTY return String is - Res : Cstring_Ptr; - stdout : constant Integer := 1; - Max_TTY_Name : constant Integer := 500; + S : Storage_Elmt; begin - if isatty (stdout) /= 1 then - return ""; - end if; - - Res := ttyname (1); - if Res /= null then - for J in Cstring'First .. Max_TTY_Name loop - if Res (J) = ASCII.NUL then - return Res (Cstring'First .. J - 1); - end if; - end loop; - end if; - - -- if we fall thru the ttyname result was dubious. Just forget it. - - return ""; - end Get_Current_TTY; + Read_Next (S'Address); + return S; + end Read_Next; ------- -- H -- @@ -264,141 +197,6 @@ procedure Gnatmem is return Address_Range (A mod Integer_Address (Address_Range'Last)); end H; - ----------------------- - -- Create_Gdb_Script -- - ----------------------- - - procedure Create_Gdb_Script is - FD : File_Type; - - begin - begin - Create (FD, Out_File, Gnatmem_Tmp); - exception - when others => - Put_Line ("Cannot create temporary file : " & Gnatmem_Tmp); - GNAT.OS_Lib.OS_Exit (1); - end; - - declare - TTY : constant String := Get_Current_TTY; - begin - if TTY'Length > 0 then - Put_Line (FD, "tty " & TTY); - end if; - end; - - if Cross_Case then - Put (FD, "target "); - Put (FD, Target_Protocol (1 .. Target_Protocol_Len)); - Put (FD, " "); - Put (FD, Argument (Target_Pos)); - New_Line (FD); - Put (FD, "load "); - Put_Line (FD, Argument (Exec_Pos)); - - else - -- In the native case, run the program before setting the - -- breakpoints so that gnatmem will also work with shared - -- libraries. - - Put_Line (FD, "set lang c"); - Put_Line (FD, "break main"); - Put_Line (FD, "set lang auto"); - Put (FD, "run"); - for J in Exec_Pos + 1 .. Argc loop - Put (FD, " "); - Put (FD, Argument (J)); - end loop; - New_Line (FD); - - -- At this point, gdb knows about __gnat_malloc and __gnat_free - end if; - - -- Make sure that outputting long backtraces do not pause - - Put_Line (FD, "set height 0"); - Put_Line (FD, "set width 0"); - - if Quiet_Mode then - Put_Line (FD, "break __gnat_malloc"); - Put_Line (FD, "command"); - Put_Line (FD, " silent"); - Put_Line (FD, " set lang c"); - Put_Line (FD, " set print address on"); - Put_Line (FD, " up"); - Put_Line (FD, " set $gm_addr = $pc"); - Put_Line (FD, " printf ""\n\n"""); - Put_Line (FD, " printf ""ALLOC^0x%x^\n"", $gm_addr"); - Put_Line (FD, " set print address off"); - Put_Line (FD, " set lang auto"); - else - Put_Line (FD, "break __gnat_malloc"); - Put_Line (FD, "command"); - Put_Line (FD, " silent"); - Put_Line (FD, " set lang c"); - Put_Line (FD, " set $gm_size = size"); - Put_Line (FD, " set print address on"); - Put_Line (FD, " up"); - Put_Line (FD, " set $gm_addr = $pc"); - Put_Line (FD, " printf ""\n\n"""); - Put_Line (FD, " printf ""ALLOC^%d^0x%x^\n"", $gm_size, $gm_addr"); - Put_Line (FD, " set print address off"); - Put_Line (FD, " set lang auto"); - end if; - - Put (FD, " backtrace"); - - if BT_Depth /= 0 then - Put (FD, Integer'Image (BT_Depth + 1)); - end if; - - New_Line (FD); - - Put_Line (FD, " printf ""\n\n"""); - Put_Line (FD, " continue"); - Put_Line (FD, "end"); - Put_Line (FD, "#"); - Put_Line (FD, "#"); - Put_Line (FD, "break __gnat_free"); - Put_Line (FD, "command"); - Put_Line (FD, " silent"); - Put_Line (FD, " set print address on"); - Put_Line (FD, " printf ""\n\n"""); - Put_Line (FD, " printf ""DEALL^0x%x^\n"", ptr"); - Put_Line (FD, " set print address off"); - Put_Line (FD, " up"); - - Put (FD, " backtrace"); - - if BT_Depth /= 0 then - Put (FD, Integer'Image (BT_Depth + 1)); - end if; - - New_Line (FD); - - Put_Line (FD, " printf ""\n\n"""); - Put_Line (FD, " continue"); - Put_Line (FD, "end"); - Put_Line (FD, "#"); - Put_Line (FD, "#"); - Put_Line (FD, "#"); - - if Cross_Case then - Put (FD, "run "); - Put_Line (FD, Argument (Exec_Pos)); - - if Target_Protocol (1 .. Target_Protocol_Len) = "wtx" then - Put (FD, "unload "); - Put_Line (FD, Argument (Exec_Pos)); - end if; - else - Put_Line (FD, "continue"); - end if; - - Close (FD); - end Create_Gdb_Script; - --------------- -- Mem_Image -- --------------- @@ -419,7 +217,7 @@ procedure Gnatmem is else Ada.Integer_Text_IO.Put (Buff (1 .. 4), Integer (X)); - return Buff (1 .. 4) & " Bytes"; + return Buff (1 .. 4) & " Bytes"; end if; end Mem_Image; @@ -430,36 +228,26 @@ procedure Gnatmem is procedure Usage is begin New_Line; - Put ("GNATMEM "); + Put ("GNATMEM Pro "); Put (Gnat_Version_String); - Put_Line (" Copyright 1997-2002 Free Software Foundation, Inc."); + Put_Line (" Copyright 1997-2003 Free Software Foundation, Inc."); New_Line; - if Cross_Case then - Put_Line (Command_Name - & " [-q] [n] [-o file] target entry_point ..."); - Put_Line (Command_Name & " [-q] [n] [-i file]"); - - else - Put_Line ("GDB mode"); - Put_Line (" " & Command_Name - & " [-q] [n] [-o file] program arg1 arg2 ..."); - Put_Line (" " & Command_Name - & " [-q] [n] [-i file]"); - New_Line; - Put_Line ("GMEM mode"); - Put_Line (" " & Command_Name - & " [-q] [n] -i gmem.out program arg1 arg2 ..."); - New_Line; - end if; - + Put_Line ("Usage: gnatmem switches [depth] exename"); + New_Line; + Put_Line (" depth backtrace depth to take into account, default is" + & Integer'Image (BT_Depth)); + Put_Line (" exename the name of the executable to be analyzed"); + New_Line; + Put_Line ("Switches:"); + Put_Line (" -b n same as depth parameter"); + Put_Line (" -i file read the allocation log from specific file"); + Put_Line (" default is gmem.out in the current directory"); + Put_Line (" -m n masks roots with less than n leaks, default is 1"); + Put_Line (" specify 0 to see even released allocation roots"); Put_Line (" -q quiet, minimum output"); - Put_Line (" n number of frames for allocation root backtraces"); - Put_Line (" default is 1."); - Put_Line (" -o file save gdb output in 'file' and process data"); - Put_Line (" post mortem. also keep the gdb script around"); - Put_Line (" -i file don't run gdb output. Do only post mortem"); - Put_Line (" processing from file"); + Put_Line (" -s order sort allocation roots according to an order of"); + Put_Line (" sort criteria"); GNAT.OS_Lib.OS_Exit (1); end Usage; @@ -468,365 +256,182 @@ procedure Gnatmem is ----------------------- procedure Process_Arguments is - Arg : Integer; - - procedure Check_File (Arg_Pos : Integer; For_Creat : Boolean := False); - -- Check that Argument (Arg_Pos) is an existing file if For_Creat is - -- false or if it is possible to create it if For_Creat is true - - procedure Check_File (Arg_Pos : Integer; For_Creat : Boolean := False) is - Name : aliased constant String := Argument (Arg_Pos) & ASCII.NUL; - X : int; - - begin - if For_Creat then - FD := fopen (Name'Address, Mode_W'Address); - else - FD := fopen (Name'Address, Mode_R'Address); - end if; - - if FD = NULL_Stream then - New_Line; - if For_Creat then - Put_Line ("Cannot create file : " & Argument (Arg_Pos)); - else - Put_Line ("Cannot locate file : " & Argument (Arg_Pos)); - end if; - New_Line; - Usage; - else - X := fclose (FD); - end if; - end Check_File; - - -- Start of processing for Process_Arguments - begin + -- Parse the options first - -- Is it a cross version? - - declare - Std_Name : constant String := "gnatmem"; - Name : constant String := Command_Name; - End_Pref : constant Integer := Name'Last - Std_Name'Length; - - begin - if Name'Length > Std_Name'Length + 9 - and then - Name (End_Pref + 1 .. Name'Last) = Std_Name - and then - Name (End_Pref - 8 .. End_Pref) = "-vxworks-" - then - Cross_Case := True; - - Target_Name_Len := End_Pref - 1; - for J in reverse Name'First .. End_Pref - 1 loop - if Name (J) = Dir_Sep then - Target_Name_Len := Target_Name_Len - J; - exit; - end if; - end loop; - - Target_Name (1 .. Target_Name_Len) - := Name (End_Pref - Target_Name_Len .. End_Pref - 1); - - if Target_Name (1 .. 5) = "alpha" then - Target_Protocol (1 .. 7) := "vxworks"; - Target_Protocol_Len := 7; - else - Target_Protocol (1 .. 3) := "wtx"; - Target_Protocol_Len := 3; - end if; - end if; - end; - - Arg := 1; - - if Argc < Arg then - Usage; - end if; - - -- Deal with "-q" - - if Argument (Arg) = "-q" then - - Quiet_Mode := True; - Arg := Arg + 1; - - if Argc < Arg then - Usage; - end if; - end if; - - -- Deal with back trace depth - - if Argument (Arg) (1) in '0' .. '9' then - begin - BT_Depth := Integer'Value (Argument (Arg)); - exception - when others => - Usage; - end; - - Arg := Arg + 1; - - if Argc < Arg then - Usage; - end if; - end if; + loop + case Getopt ("b: m: i: q s:") is + when ASCII.Nul => exit; - -- Deal with "-o file" or "-i file" + when 'b' => + begin + BT_Depth := Natural'Value (Parameter); + exception + when Constraint_Error => + Usage; + end; - while Arg <= Argc and then Argument (Arg) (1) = '-' loop - Arg := Arg + 1; + when 'm' => + begin + Minimum_NB_Leaks := Natural'Value (Parameter); + exception + when Constraint_Error => + Usage; + end; - if Argc < Arg then - Usage; - end if; + when 'i' => + Log_Name := new String'(Parameter); - case Argument (Arg - 1) (2) is - when 'o' => - Check_File (Arg, For_Creat => True); - File_Pos := Arg; + when 'q' => + Quiet_Mode := True; - when 'i' => - Check_File (Arg); - File_Pos := Arg; - Run_Gdb := False; - if Gmem_Initialize (Argument (Arg)) then - Gmem_Mode := True; - end if; + when 's' => + declare + S : String (Sort_Order'Range) := Parameter; + begin + for J in Sort_Order'Range loop + if S (J) = 'n' or else S (J) = 'w' + or else S (J) = 'h' then + Sort_Order (J) := S (J); + else + raise Constraint_Error; + end if; + end loop; + exception + when Constraint_Error => + Put_Line ("Invalid sort criteria string."); + GNAT.OS_Lib.OS_Exit (1); + end; when others => - Put_Line ("Unknown option : " & Argument (Arg)); - Usage; + null; end case; - - Arg := Arg + 1; - - if Argc < Arg and then Run_Gdb then - Usage; - end if; end loop; - -- In the cross case, we first get the target + -- Set default log file if -i hasn't been specified - if Cross_Case then - Target_Pos := Arg; - Arg := Arg + 1; - - if Argc < Arg and then Run_Gdb then - Usage; - end if; + if Log_Name = null then + Log_Name := new String'("gmem.out"); end if; - -- Now all the following arguments are to be passed to gdb + -- Get the optional backtrace length and program name - if Run_Gdb then - Exec_Pos := Arg; - Check_File (Exec_Pos); + declare + Str1 : constant String := GNAT.Command_Line.Get_Argument; + Str2 : constant String := GNAT.Command_Line.Get_Argument; - elsif Gmem_Mode then - if Arg > Argc then + begin + if Str1 = "" then Usage; - else - Exec_Pos := Arg; - Check_File (Exec_Pos); - Gmem_A2l_Initialize (Argument (Exec_Pos)); end if; - -- ... in other cases further arguments are disallowed - - elsif Arg <= Argc then - Usage; - end if; - end Process_Arguments; - - --------------- - -- Read_Next -- - --------------- - - function Read_Next return Gdb_Output_Elmt is - Max_Line : constant Integer := 100; - Line : String (1 .. Max_Line); - Last : Integer := 0; + if Str2 = "" then + Program_Name := new String'(Str1); + else + BT_Depth := Natural'Value (Str1); + Program_Name := new String'(Str2); + end if; - Curs1, Curs2 : Integer; - Separator : constant Character := '^'; + exception + when Constraint_Error => + Usage; + end; - function Next_Separator return Integer; - -- Return the index of the next separator after Curs1 in Line + -- Ensure presence of executable suffix in Program_Name - function Next_Separator return Integer is - Curs : Integer := Curs1; + declare + Suffix : String_Access := Get_Executable_Suffix; + Tmp : String_Access; begin - loop - if Curs > Last then - raise Gdb_Output_Format_Error; + if Suffix.all /= "" + and then + Program_Name.all + (Program_Name.all'Last - Suffix.all'Length + 1 .. + Program_Name.all'Last) /= Suffix.all + then + Tmp := new String'(Program_Name.all & Suffix.all); + Free (Program_Name); + Program_Name := Tmp; + end if; - elsif Line (Curs) = Separator then - return Curs; - end if; + Free (Suffix); - Curs := Curs + 1; - end loop; - end Next_Separator; + -- Search the executable on the path. If not found in the PATH, we + -- default to the current directory. Otherwise, libaddr2line will + -- fail with an error: - -- Start of processing for Read_Next + -- (null): Bad address - begin - Line (1) := ' '; + Tmp := Locate_Exec_On_Path (Program_Name.all); - loop - if Gmem_Mode then - Gmem_Read_Next (Line, Last); - else - Get_Line (FT, Line, Last); + if Tmp = null then + Tmp := new String'('.' & Directory_Separator & Program_Name.all); end if; - if Line (1 .. 14) = "Program exited" then - return Eof; - - elsif Line (1 .. 5) = "ALLOC" then - -- ALLOC ^ <size> ^0x <addr> ^ - - -- Read the size - - Curs1 := 7; - Curs2 := Next_Separator - 1; - - if not Quiet_Mode then - Tmp_Size := Storage_Count'Value (Line (Curs1 .. Curs2)); - end if; + Free (Program_Name); + Program_Name := Tmp; + end; - -- Read the address, skip "^0x" + if not Is_Regular_File (Log_Name.all) then + Put_Line ("Couldn't find " & Log_Name.all); + GNAT.OS_Lib.OS_Exit (1); + end if; - Curs1 := Curs2 + 4; - Curs2 := Next_Separator - 1; - Tmp_Address := Integer_Address'Value ( - "16#" & Line (Curs1 .. Curs2) & "#"); - return Alloc; + if not Gmem_Initialize (Log_Name.all) then + Put_Line ("File " & Log_Name.all & " is not a gnatmem log file"); + GNAT.OS_Lib.OS_Exit (1); + end if; - elsif Line (1 .. 5) = "DEALL" then - -- DEALL ^ 0x <addr> ^ + if not Is_Regular_File (Program_Name.all) then + Put_Line ("Couldn't find " & Program_Name.all); + end if; - -- Read the address, skip "^0x" + Gmem_A2l_Initialize (Program_Name.all); - Curs1 := 9; - Curs2 := Next_Separator - 1; - Tmp_Address := Integer_Address'Value ( - "16#" & Line (Curs1 .. Curs2) & "#"); - return Deall; - end if; - end loop; exception - when End_Error => - New_Line; - Put_Line ("### incorrect user program termination detected."); - Put_Line (" following data may not be meaningful"); - New_Line; - return Eof; - end Read_Next; + when GNAT.Command_Line.Invalid_Switch => + Ada.Text_IO.Put_Line ("Invalid switch : " + & GNAT.Command_Line.Full_Switch); + Usage; + end Process_Arguments; + + Cur_Elmt : Storage_Elmt; -- Start of processing for Gnatmem begin Process_Arguments; - if Run_Gdb then - Create_Gdb_Script; - end if; - - -- Now we start the gdb session using the following syntax - - -- gdb --nx --nw -batch -x gnatmem.tmp - - -- If there is a -o option we redirect the gdb output in the specified - -- file, otherwise we just read directly from a pipe. - - if File_Pos /= 0 then - declare - Name : aliased String := Argument (File_Pos) & ASCII.NUL; - - begin - if Run_Gdb then - if Cross_Case then - declare - Cmd : aliased String := Target_Name (1 .. Target_Name_Len) - & "-gdb --nx --nw -batch -x " & Gnatmem_Tmp & " > " - & Name; - begin - System_Cmd (Cmd'Address); - end; - else - - declare - Cmd : aliased String - := "gdb --nx --nw " & Argument (Exec_Pos) - & " -batch -x " & Gnatmem_Tmp & " > " - & Name; - begin - System_Cmd (Cmd'Address); - end; - end if; - end if; - - if not Gmem_Mode then - FD := fopen (Name'Address, Mode_R'Address); - end if; - end; - - else - if Cross_Case then - declare - Cmd : aliased String := Target_Name (1 .. Target_Name_Len) - & "-gdb --nx --nw -batch -x " & Gnatmem_Tmp & ASCII.NUL; - begin - FD := popen (Cmd'Address, Mode_R'Address); - end; - else - declare - Cmd : aliased String := "gdb --nx --nw " & Argument (Exec_Pos) - & " -batch -x " & Gnatmem_Tmp & ASCII.NUL; - - begin - FD := popen (Cmd'Address, Mode_R'Address); - end; - end if; - end if; - - -- Open the FD file as a regular Text_IO file - - if not Gmem_Mode then - Ada.Text_IO.C_Streams.Open (FT, In_File, FD); - end if; - - -- Main loop analysing the data generated by the debugger - -- for each allocation, the backtrace is kept and stored in a htable - -- whose entry is the address. Fore ach deallocation, we look for the + -- Main loop analysing the data generated by the instrumented routines. + -- For each allocation, the backtrace is kept and stored in a htable + -- whose entry is the address. For each deallocation, we look for the -- corresponding allocation and cancel it. Main : loop - case Read_Next is - when EOF => + Cur_Elmt := Read_Next; + + case Cur_Elmt.Elmt is + when '*' => exit Main; - when Alloc => + when 'A' => -- Update global counters if the allocated size is meaningful if Quiet_Mode then - Tmp_Alloc.Root := Read_BT (BT_Depth, FT); + Tmp_Alloc.Root := Read_BT (BT_Depth); + if Nb_Alloc (Tmp_Alloc.Root) = 0 then Nb_Root := Nb_Root + 1; end if; + Set_Nb_Alloc (Tmp_Alloc.Root, Nb_Alloc (Tmp_Alloc.Root) + 1); - Address_HTable.Set (Tmp_Address, Tmp_Alloc); + Address_HTable.Set (Cur_Elmt.Address, Tmp_Alloc); - elsif Tmp_Size > 0 then + elsif Cur_Elmt.Size > 0 then - Global_Alloc_Size := Global_Alloc_Size + Tmp_Size; + Global_Alloc_Size := Global_Alloc_Size + Cur_Elmt.Size; Global_Nb_Alloc := Global_Nb_Alloc + 1; if Global_High_Water_Mark < Global_Alloc_Size then @@ -835,7 +440,7 @@ begin -- Read the corresponding back trace - Tmp_Alloc.Root := Read_BT (BT_Depth, FT); + Tmp_Alloc.Root := Read_BT (BT_Depth); -- Update the number of allocation root if this is a new one @@ -846,12 +451,12 @@ begin -- Update allocation root specific counters Set_Alloc_Size (Tmp_Alloc.Root, - Alloc_Size (Tmp_Alloc.Root) + Tmp_Size); + Alloc_Size (Tmp_Alloc.Root) + Cur_Elmt.Size); Set_Nb_Alloc (Tmp_Alloc.Root, Nb_Alloc (Tmp_Alloc.Root) + 1); - if High_Water_Mark (Tmp_Alloc.Root) - < Alloc_Size (Tmp_Alloc.Root) + if High_Water_Mark (Tmp_Alloc.Root) < + Alloc_Size (Tmp_Alloc.Root) then Set_High_Water_Mark (Tmp_Alloc.Root, Alloc_Size (Tmp_Alloc.Root)); @@ -859,27 +464,27 @@ begin -- Associate this allocation root to the allocated address - Tmp_Alloc.Size := Tmp_Size; - Address_HTable.Set (Tmp_Address, Tmp_Alloc); + Tmp_Alloc.Size := Cur_Elmt.Size; + Address_HTable.Set (Cur_Elmt.Address, Tmp_Alloc); - -- non meaninful output, just consumes the backtrace + -- non meaningful output, just consumes the backtrace else - Tmp_Alloc.Root := Read_BT (BT_Depth, FT); + Tmp_Alloc.Root := Read_BT (BT_Depth); end if; - when Deall => + when 'D' => -- Get the corresponding Dealloc_Size and Root - Tmp_Alloc := Address_HTable.Get (Tmp_Address); + Tmp_Alloc := Address_HTable.Get (Cur_Elmt.Address); if Tmp_Alloc.Root = No_Root_Id then -- There was no prior allocation at this address, something is - -- very wrong. Mark this allocation root as problematic a + -- very wrong. Mark this allocation root as problematic - Tmp_Alloc.Root := Read_BT (BT_Depth, FT); + Tmp_Alloc.Root := Read_BT (BT_Depth); if Nb_Alloc (Tmp_Alloc.Root) = 0 then Set_Nb_Alloc (Tmp_Alloc.Root, Nb_Alloc (Tmp_Alloc.Root) - 1); @@ -892,6 +497,7 @@ begin if not Quiet_Mode then Global_Alloc_Size := Global_Alloc_Size - Tmp_Alloc.Size; end if; + Global_Nb_Dealloc := Global_Nb_Dealloc + 1; -- Update allocation root specific counters @@ -900,31 +506,26 @@ begin Set_Alloc_Size (Tmp_Alloc.Root, Alloc_Size (Tmp_Alloc.Root) - Tmp_Alloc.Size); end if; + Set_Nb_Alloc (Tmp_Alloc.Root, Nb_Alloc (Tmp_Alloc.Root) - 1); -- update the number of allocation root if this one disappear - if Nb_Alloc (Tmp_Alloc.Root) = 0 then + if Nb_Alloc (Tmp_Alloc.Root) = 0 + and then Minimum_NB_Leaks > 0 then Nb_Root := Nb_Root - 1; end if; -- De-associate the deallocated address - Address_HTable.Remove (Tmp_Address); + Address_HTable.Remove (Cur_Elmt.Address); end if; + + when others => + raise Program_Error; end case; end loop Main; - -- We can get rid of the temp file now - - if Run_Gdb and then File_Pos = 0 then - declare - X : int; - begin - X := unlink (Gnatmem_Tmp'Address); - end; - end if; - -- Print out general information about overall allocation if not Quiet_Mode then @@ -956,6 +557,7 @@ begin Bogus_Dealls : Root_Array (1 .. Nb_Wrong_Deall); Deall_Index : Natural := 0; + Nb_Alloc_J : Natural := 0; procedure Move (From : Natural; To : Natural); function Lt (Op1, Op2 : Natural) return Boolean; @@ -967,14 +569,54 @@ begin end Move; function Lt (Op1, Op2 : Natural) return Boolean is + function Apply_Sort_Criterion (S : Character) return Integer; + -- Applies a specific sort criterion; returns -1, 0 or 1 if Op1 is + -- smaller than, equal, or greater than Op2 according to criterion + + function Apply_Sort_Criterion (S : Character) return Integer is + LOp1, LOp2 : Integer; + begin + case S is + when 'n' => + LOp1 := Nb_Alloc (Leaks (Op1)); + LOp2 := Nb_Alloc (Leaks (Op2)); + + when 'w' => + LOp1 := Integer (Alloc_Size (Leaks (Op1))); + LOp2 := Integer (Alloc_Size (Leaks (Op2))); + + when 'h' => + LOp1 := Integer (High_Water_Mark (Leaks (Op1))); + LOp2 := Integer (High_Water_Mark (Leaks (Op2))); + + when others => + return 0; -- Can't actually happen + end case; + + if LOp1 < LOp2 then + return -1; + elsif LOp1 > LOp2 then + return 1; + else + return 0; + end if; + exception + when Constraint_Error => + return 0; + end Apply_Sort_Criterion; + + Result : Integer; + begin - if Nb_Alloc (Leaks (Op1)) > Nb_Alloc (Leaks (Op2)) then - return True; - elsif Nb_Alloc (Leaks (Op1)) = Nb_Alloc (Leaks (Op2)) then - return Alloc_Size (Leaks (Op1)) > Alloc_Size (Leaks (Op2)); - else - return False; - end if; + for S in Sort_Order'Range loop + Result := Apply_Sort_Criterion (Sort_Order (S)); + if Result = -1 then + return False; + elsif Result = 1 then + return True; + end if; + end loop; + return False; end Lt; -- Start of processing for Print_Back_Traces @@ -985,7 +627,7 @@ begin Tmp_Alloc.Root := Get_First; while Tmp_Alloc.Root /= No_Root_Id loop - if Nb_Alloc (Tmp_Alloc.Root) = 0 then + if Nb_Alloc (Tmp_Alloc.Root) = 0 and then Minimum_NB_Leaks > 0 then null; elsif Nb_Alloc (Tmp_Alloc.Root) < 0 then @@ -1009,7 +651,7 @@ begin end if; for J in 1 .. Bogus_Dealls'Last loop - Print_BT (Bogus_Dealls (J)); + Print_BT (Bogus_Dealls (J), Short => Quiet_Mode); New_Line; end loop; end if; @@ -1023,34 +665,38 @@ begin Root_Sort.Sort (Nb_Root); for J in 1 .. Leaks'Last loop - if Quiet_Mode then - if Nb_Alloc (Leaks (J)) = 1 then - Put_Line (Integer'Image (Nb_Alloc (Leaks (J))) - & " leak at :"); + Nb_Alloc_J := Nb_Alloc (Leaks (J)); + if Nb_Alloc_J >= Minimum_NB_Leaks then + if Quiet_Mode then + if Nb_Alloc_J = 1 then + Put_Line (" 1 leak at :"); + else + Put_Line (Integer'Image (Nb_Alloc_J) & " leaks at :"); + end if; + else - Put_Line (Integer'Image (Nb_Alloc (Leaks (J))) - & " leaks at :"); - end if; - else - Put_Line ("Allocation Root #" & Integer'Image (J)); - Put_Line ("-------------------"); + Put_Line ("Allocation Root #" & Integer'Image (J)); + Put_Line ("-------------------"); - Put (" Number of non freed allocations :"); - Ada.Integer_Text_IO.Put (Nb_Alloc (Leaks (J)), 4); - New_Line; + Put (" Number of non freed allocations :"); + Ada.Integer_Text_IO.Put (Nb_Alloc_J, 4); + New_Line; + + Put_Line + (" Final Water Mark (non freed mem) :" + & Mem_Image (Alloc_Size (Leaks (J)))); - Put_Line (" Final Water Mark (non freed mem) :" - & Mem_Image (Alloc_Size (Leaks (J)))); + Put_Line + (" High Water Mark :" + & Mem_Image (High_Water_Mark (Leaks (J)))); - Put_Line (" High Water Mark :" - & Mem_Image (High_Water_Mark (Leaks (J)))); + Put_Line (" Backtrace :"); + end if; - Put_Line (" Backtrace :"); + Print_BT (Leaks (J), Short => Quiet_Mode); + New_Line; end if; - Print_BT (Leaks (J)); - New_Line; end loop; end if; end Print_Back_Traces; - end Gnatmem; |