1 /****************************************************************************
7 * C Implementation File *
9 * Copyright (C) 2000-2007, 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 2, or (at your option) any later ver- *
14 * sion. GNAT is distributed in the hope that it will be useful, but WITH- *
15 * OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY *
16 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License *
17 * for more details. You should have received a copy of the GNU General *
18 * Public License distributed with GNAT; see file COPYING. If not, write *
19 * to the Free Software Foundation, 51 Franklin Street, Fifth Floor, *
20 * Boston, MA 02110-1301, USA. *
22 * As a special exception, if you link this file with other files to *
23 * produce an executable, this file does not by itself cause the resulting *
24 * executable to be covered by the GNU General Public License. This except- *
25 * ion does not however invalidate any other reasons why the executable *
26 * file might be covered by the GNU Public License. *
28 * GNAT was originally developed by the GNAT team at New York University. *
29 * Extensive contributions were provided by Ada Core Technologies Inc. *
31 ****************************************************************************/
33 /* This unit reads the allocation tracking log produced by augmented
34 __gnat_malloc and __gnat_free procedures (see file memtrack.adb) and
35 provides GNATMEM tool with gdb-compliant output. The output is
36 processed by GNATMEM to detect dynamic memory allocation errors.
38 See GNATMEM section in GNAT User's Guide for more information.
40 NOTE: This capability is currently supported on the following targets:
44 Solaris (sparc and x86) (*)
45 Windows 98/95/NT (x86)
48 (*) on these targets, the compilation must be done with -funwind-tables to
49 be able to build the stack backtrace.
55 static FILE *gmemfile;
57 /* tb_len is the number of call level supported by this module */
59 static void * tracebk [tb_len];
60 static int cur_tb_len, cur_tb_pos;
66 struct struct_storage_elmt {
74 __gnat_convert_addresses (void *addrs[], int n_addrs, void *buf, int *len);
75 /* Place in BUF a string representing the symbolic translation of N_ADDRS raw
76 addresses provided in ADDRS. LEN is filled with the result length.
78 This is a GNAT specific interface to the libaddr2line convert_addresses
79 routine. The latter examines debug info from a provided executable file
80 name to perform the translation into symbolic form of an input sequence of
81 raw binary addresses. It attempts to open the file from the provided name
82 "as is", so an an absolute path must be provided to ensure the file is
83 always found. We compute this name once, at initialization time. */
85 static const char * exename = 0;
87 extern void convert_addresses (const char * , void *[], int, void *, int *);
88 extern char *__gnat_locate_exec_on_path (char *);
89 /* ??? Both of these extern functions are prototyped in adaint.h, which
90 also refers to "time_t" hence needs complex extra header inclusions to
91 be satisfied on every target. */
94 __gnat_convert_addresses (void *addrs[], int n_addrs, void *buf, int *len)
97 convert_addresses (exename, addrs, n_addrs, buf, len);
102 /* reads backtrace information from gmemfile placing them in tracebk
103 array. cur_tb_len is the size of this array
107 gmem_read_backtrace (void)
109 fread (&cur_tb_len, sizeof (int), 1, gmemfile);
110 fread (tracebk, sizeof (void *), cur_tb_len, gmemfile);
114 /* initialize gmem feature from the dumpname file. It returns t0 timestamp
115 if the dumpname has been generated by GMEM (instrumented malloc/free)
119 long long __gnat_gmem_initialize (char *dumpname)
124 gmemfile = fopen (dumpname, "rb");
125 fread (header, 10, 1, gmemfile);
127 /* check for GMEM magic-tag */
128 if (memcmp (header, "GMEM DUMP\n", 10))
134 fread (&t0, sizeof (long long), 1, gmemfile);
139 /* initialize addr2line library */
141 void __gnat_gmem_a2l_initialize (char *exearg)
143 /* Resolve the executable filename to use in later invocations of
144 the libaddr2line symbolization service. */
145 exename = __gnat_locate_exec_on_path (exearg);
148 /* Read next allocation of deallocation information from the GMEM file and
149 write an alloc/free information in buf to be processed by gnatmem */
152 __gnat_gmem_read_next (struct struct_storage_elmt *buf)
158 j = fgetc (gmemfile);
169 buf->Elmt = LOG_ALLOC;
170 fread (&(buf->Address), sizeof (void *), 1, gmemfile);
171 fread (&(buf->Size), sizeof (size_t), 1, gmemfile);
172 fread (&(buf->Timestamp), sizeof (long long), 1, gmemfile);
175 buf->Elmt = LOG_DEALL;
176 fread (&(buf->Address), sizeof (void *), 1, gmemfile);
177 fread (&(buf->Timestamp), sizeof (long long), 1, gmemfile);
180 puts ("GNATMEM dump file corrupt");
184 gmem_read_backtrace ();
188 /* Read the next frame from the current traceback, and move the cursor to the
191 void __gnat_gmem_read_next_frame (void** addr)
193 if (cur_tb_pos >= cur_tb_len) {
196 *addr = (void*)*(tracebk + cur_tb_pos);
201 /* Converts addr into a symbolic traceback, and stores the result in buf
202 with a format suitable for gnatmem */
204 void __gnat_gmem_symbolic (void * addr, char* buf, int* length)
206 void * addresses [] = { addr };
208 __gnat_convert_addresses (addresses, 1, buf, length);