19bb35f94ff0b9f1957a123195707db3f3078499
[kopensolaris-gnu/glibc.git] / malloc / memusage.c
1 /* Profile heap and stack memory usage of running program.
2    Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4    Contributed by Ulrich Drepper <drepper@cygnus.com>, 1998.
5
6    The GNU C Library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10
11    The GNU C Library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with the GNU C Library; if not, write to the Free
18    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19    02111-1307 USA.  */
20
21 #include <dlfcn.h>
22 #include <errno.h>
23 #include <fcntl.h>
24 #include <inttypes.h>
25 #include <signal.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <unistd.h>
30 #include <sys/time.h>
31
32 #include <memusage.h>
33
34 /* Pointer to the real functions.  These are determined used `dlsym'
35    when really needed.  */
36 static void *(*mallocp) (size_t);
37 static void *(*reallocp) (void *, size_t);
38 static void *(*callocp) (size_t, size_t);
39 static void (*freep) (void *);
40
41 enum
42 {
43   idx_malloc = 0,
44   idx_realloc,
45   idx_calloc,
46   idx_free,
47   idx_last
48 };
49
50
51 struct header
52 {
53   size_t length;
54   size_t magic;
55 };
56
57 #define MAGIC 0xfeedbeaf
58
59
60 static unsigned long int calls[idx_last];
61 static unsigned long int failed[idx_last];
62 static unsigned long long int total[idx_last];
63 static unsigned long long int grand_total;
64 static unsigned long int histogram[65536 / 16];
65 static unsigned long int large;
66 static unsigned long int calls_total;
67 static unsigned long int inplace;
68 static unsigned long int decreasing;
69 static long int current_use[2];
70 static long int peak_use[3];
71 static uintptr_t start_sp;
72
73 /* A few macros to make the source more readable.  */
74 #define current_heap    current_use[0]
75 #define current_stack   current_use[1]
76 #define peak_heap       peak_use[0]
77 #define peak_stack      peak_use[1]
78 #define peak_total      peak_use[2]
79
80 #define DEFAULT_BUFFER_SIZE     1024
81 static size_t buffer_size;
82
83 static int fd = -1;
84
85 static int not_me;
86 static int initialized;
87 extern const char *__progname;
88
89 struct entry
90 {
91   size_t heap;
92   size_t stack;
93   uint32_t time_low;
94   uint32_t time_high;
95 };
96
97 static struct entry buffer[DEFAULT_BUFFER_SIZE];
98 static size_t buffer_cnt;
99 static struct entry first;
100
101
102 /* Update the global data after a successful function call.  */
103 static void
104 update_data (struct header *result, size_t len, size_t old_len)
105 {
106   long int total_use;
107
108   if (result != NULL)
109     {
110       /* Record the information we need and mark the block using a
111          magic number.  */
112       result->length = len;
113       result->magic = MAGIC;
114     }
115
116   /* Compute current heap usage and compare it with the maximum value.  */
117   current_heap += len - old_len;
118   if (current_heap > peak_heap)
119     peak_heap = current_heap;
120
121   /* Compute current stack usage and compare it with the maximum value.  */
122 #ifdef STACK_GROWS_UPWARD
123   current_stack = GETSP () - start_sp;
124 #else
125   current_stack = start_sp - GETSP ();
126 #endif
127   if (current_stack > peak_stack)
128     peak_stack = current_stack;
129
130   /* Add up heap and stack usage and compare it with the maximum value.  */
131   total_use = current_heap + current_stack;
132   if (total_use > peak_total)
133     peak_total = total_use;
134
135   /* Store the value only if we are writing to a file.  */
136   if (fd != -1)
137     {
138       buffer[buffer_cnt].heap = current_heap;
139       buffer[buffer_cnt].stack = current_stack;
140       GETTIME (buffer[buffer_cnt].time_low, buffer[buffer_cnt].time_high);
141       ++buffer_cnt;
142
143       /* Write out buffer if it is full.  */
144       if (buffer_cnt == buffer_size)
145         {
146           write (fd, buffer, buffer_cnt * sizeof (struct entry));
147           buffer_cnt = 0;
148         }
149     }
150 }
151
152
153 /* Interrupt handler.  */
154 static void
155 int_handler (int signo)
156 {
157   /* Nothing gets allocated.  Just record the stack pointer position.  */
158   update_data (NULL, 0, 0);
159 }
160
161
162 /* Find out whether this is the program we are supposed to profile.
163    For this the name in the variable `__progname' must match the one
164    given in the environment variable MEMUSAGE_PROG_NAME.  If the variable
165    is not present every program assumes it should be profiling.
166
167    If this is the program open a file descriptor to the output file.
168    We will write to it whenever the buffer overflows.  The name of the
169    output file is determined by the environment variable MEMUSAGE_OUTPUT.
170
171    If the environment variable MEMUSAGE_BUFFER_SIZE is set its numerical
172    value determines the size of the internal buffer.  The number gives
173    the number of elements in the buffer.  By setting the number to one
174    one effectively selects unbuffered operation.
175
176    If MEMUSAGE_NO_TIMER is not present an alarm handler is installed
177    which at the highest possible frequency records the stack pointer.  */
178 static void
179 me (void)
180 {
181   const char *env = getenv ("MEMUSAGE_PROG_NAME");
182   size_t prog_len = strlen (__progname);
183
184   initialized = -1;
185   mallocp = (void *(*) (size_t)) dlsym (RTLD_NEXT, "malloc");
186   reallocp = (void *(*) (void *, size_t)) dlsym (RTLD_NEXT, "realloc");
187   callocp = (void *(*) (size_t, size_t)) dlsym (RTLD_NEXT, "calloc");
188   freep = (void (*) (void *)) dlsym (RTLD_NEXT, "free");
189   initialized = 1;
190
191   if (env != NULL)
192     {
193       /* Check for program name.  */
194       size_t len = strlen (env);
195       if (len > prog_len || strcmp (env, &__progname[prog_len - len]) != 0
196           || (prog_len != len && __progname[prog_len - len - 1] != '/'))
197         not_me = 1;
198     }
199
200   /* Only open the file if it's really us.  */
201   if (!not_me && fd == -1)
202     {
203       const char *outname;
204
205       if (!start_sp)
206         start_sp = GETSP ();
207
208       outname = getenv ("MEMUSAGE_OUTPUT");
209       if (outname != NULL && outname[0] != '\0'
210           && (access (outname, R_OK | W_OK) == 0 || errno == ENOENT))
211         {
212           fd = creat (outname, 0666);
213
214           if (fd == -1)
215             /* Don't do anything in future calls if we cannot write to
216                the output file.  */
217             not_me = 1;
218           else
219             {
220               /* Write the first entry.  */
221               first.heap = 0;
222               first.stack = 0;
223               GETTIME (first.time_low, first.time_high);
224               /* Write it two times since we need the starting and end time. */
225               write (fd, &first, sizeof (first));
226
227               /* Determine the buffer size.  We use the default if the
228                  environment variable is not present.  */
229               buffer_size = DEFAULT_BUFFER_SIZE;
230               if (getenv ("MEMUSAGE_BUFFER_SIZE") != NULL)
231                 {
232                   buffer_size = atoi (getenv ("MEMUSAGE_BUFFER_SIZE"));
233                   if (buffer_size == 0 || buffer_size > DEFAULT_BUFFER_SIZE)
234                     buffer_size = DEFAULT_BUFFER_SIZE;
235                 }
236
237               /* Possibly enable timer-based stack pointer retrieval.  */
238               if (getenv ("MEMUSAGE_NO_TIMER") == NULL)
239                 {
240                   struct sigaction act;
241
242                   act.sa_handler = (sighandler_t) &int_handler;
243                   act.sa_flags = SA_RESTART;
244                   sigfillset (&act.sa_mask);
245
246                   if (sigaction (SIGPROF, &act, NULL) >= 0)
247                     {
248                       struct itimerval timer;
249
250                       timer.it_value.tv_sec = 0;
251                       timer.it_value.tv_usec = 1;
252                       timer.it_interval = timer.it_value;
253                       setitimer (ITIMER_PROF, &timer, NULL);
254                     }
255                 }
256             }
257         }
258     }
259 }
260
261
262 /* Record the initial stack position.  */
263 static void
264 __attribute__ ((constructor))
265 init (void)
266 {
267   start_sp = GETSP ();
268   if (! initialized)
269     me ();
270 }
271
272
273 /* `malloc' replacement.  We keep track of the memory usage if this is the
274    correct program.  */
275 void *
276 malloc (size_t len)
277 {
278   struct header *result = NULL;
279
280   /* Determine real implementation if not already happened.  */
281   if (__builtin_expect (initialized <= 0, 0))
282     {
283       if (initialized == -1)
284         return NULL;
285       me ();
286     }
287
288   /* If this is not the correct program just use the normal function.  */
289   if (not_me)
290     return (*mallocp) (len);
291
292   /* Keep track of number of calls.  */
293   ++calls[idx_malloc];
294   /* Keep track of total memory consumption for `malloc'.  */
295   total[idx_malloc] += len;
296   /* Keep track of total memory requirement.  */
297   grand_total += len;
298   /* Remember the size of the request.  */
299   if (len < 65536)
300     ++histogram[len / 16];
301   else
302     ++large;
303   /* Total number of calls of any of the functions.  */
304   ++calls_total;
305
306   /* Do the real work.  */
307   result = (struct header *) (*mallocp) (len + sizeof (struct header));
308   if (result == NULL)
309     {
310       ++failed[idx_malloc];
311       return NULL;
312     }
313
314   /* Update the allocation data and write out the records if necessary.  */
315   update_data (result, len, 0);
316
317   /* Return the pointer to the user buffer.  */
318   return (void *) (result + 1);
319 }
320
321
322 /* `realloc' replacement.  We keep track of the memory usage if this is the
323    correct program.  */
324 void *
325 realloc (void *old, size_t len)
326 {
327   struct header *result = NULL;
328   struct header *real;
329   size_t old_len;
330
331   /* Determine real implementation if not already happened.  */
332   if (__builtin_expect (initialized <= 0, 0))
333     {
334       if (initialized == -1)
335         return NULL;
336       me ();
337     }
338
339   /* If this is not the correct program just use the normal function.  */
340   if (not_me)
341     return (*reallocp) (old, len);
342
343   if (old == NULL)
344     {
345       /* This is really a `malloc' call.  */
346       real = NULL;
347       old_len = 0;
348     }
349   else
350     {
351       real = ((struct header *) old) - 1;
352       if (real->magic != MAGIC)
353         /* This is no memory allocated here.  */
354         return (*reallocp) (old, len);
355       old_len = real->length;
356     }
357
358   /* Keep track of number of calls.  */
359   ++calls[idx_realloc];
360   /* Keep track of total memory consumption for `realloc'.  */
361   total[idx_realloc] += len;
362   /* Keep track of total memory requirement.  */
363   grand_total += len;
364   /* Remember the size of the request.  */
365   if (len < 65536)
366     ++histogram[len / 16];
367   else
368     ++large;
369   /* Total number of calls of any of the functions.  */
370   ++calls_total;
371
372   /* Do the real work.  */
373   result = (struct header *) (*reallocp) (real, len + sizeof (struct header));
374   if (result == NULL)
375     {
376       ++failed[idx_realloc];
377       return NULL;
378     }
379
380   /* Record whether the reduction/increase happened in place.  */
381   if (real == result)
382     ++inplace;
383   /* Was the buffer increased?  */
384   if (old_len > len)
385     ++decreasing;
386
387   /* Update the allocation data and write out the records if necessary.  */
388   update_data (result, len, old_len);
389
390   /* Return the pointer to the user buffer.  */
391   return (void *) (result + 1);
392 }
393
394
395 /* `calloc' replacement.  We keep track of the memory usage if this is the
396    correct program.  */
397 void *
398 calloc (size_t n, size_t len)
399 {
400   struct header *result;
401   size_t size = n * len;
402
403   /* Determine real implementation if not already happened.  */
404   if (__builtin_expect (initialized <= 0, 0))
405     {
406       if (initialized == -1)
407         return NULL;
408       me ();
409     }
410
411   /* If this is not the correct program just use the normal function.  */
412   if (not_me)
413     return (*callocp) (n, len);
414
415   /* Keep track of number of calls.  */
416   ++calls[idx_calloc];
417   /* Keep track of total memory consumption for `calloc'.  */
418   total[idx_calloc] += size;
419   /* Keep track of total memory requirement.  */
420   grand_total += size;
421   /* Remember the size of the request.  */
422   if (size < 65536)
423     ++histogram[size / 16];
424   else
425     ++large;
426   /* Total number of calls of any of the functions.  */
427   ++calls_total;
428
429   /* Do the real work.  */
430   result = (struct header *) (*mallocp) (size + sizeof (struct header));
431   if (result == NULL)
432     {
433       ++failed[idx_calloc];
434       return NULL;
435     }
436
437   /* Update the allocation data and write out the records if necessary.  */
438   update_data (result, size, 0);
439
440   /* Do what `calloc' would have done and return the buffer to the caller.  */
441   return memset (result + 1, '\0', size);
442 }
443
444
445 /* `free' replacement.  We keep track of the memory usage if this is the
446    correct program.  */
447 void
448 free (void *ptr)
449 {
450   struct header *real;
451
452   /* Determine real implementation if not already happened.  */
453   if (__builtin_expect (initialized <= 0, 0))
454     {
455       if (initialized == -1)
456         return;
457       me ();
458     }
459
460   /* If this is not the correct program just use the normal function.  */
461   if (not_me)
462     {
463       (*freep) (ptr);
464       return;
465     }
466
467   /* `free (NULL)' has no effect.  */
468   if (ptr == NULL)
469     {
470       ++calls[idx_free];
471       return;
472     }
473
474   /* Determine the pointer to the header.  */
475   real = ((struct header *) ptr) - 1;
476   if (real->magic != MAGIC)
477     {
478       /* This block wasn't allocated here.  */
479       (*freep) (ptr);
480       return;
481     }
482
483   /* Keep track of number of calls.  */
484   ++calls[idx_free];
485   /* Keep track of total memory freed using `free'.  */
486   total[idx_free] += real->length;
487
488   /* Update the allocation data and write out the records if necessary.  */
489   update_data (NULL, 0, real->length);
490
491   /* Do the real work.  */
492   (*freep) (real);
493 }
494
495
496 /* Write some statistics to standard error.  */
497 static void
498 __attribute__ ((destructor))
499 dest (void)
500 {
501   int percent, cnt;
502   unsigned long int maxcalls;
503
504   /* If we haven't done anything here just return.  */
505   if (not_me)
506     return;
507   /* If we should call any of the memory functions don't do any profiling.  */
508   not_me = 1;
509
510   /* Finish the output file.  */
511   if (fd != -1)
512     {
513       /* Write the partially filled buffer.  */
514       write (fd, buffer, buffer_cnt * sizeof (struct entry));
515       /* Go back to the beginning of the file.  We allocated two records
516          here when we opened the file.  */
517       lseek (fd, 0, SEEK_SET);
518       /* Write out a record containing the total size.  */
519       first.stack = peak_total;
520       write (fd, &first, sizeof (struct entry));
521       /* Write out another record containing the maximum for heap and
522          stack.  */
523       first.heap = peak_heap;
524       first.stack = peak_stack;
525       GETTIME (first.time_low, first.time_high);
526       write (fd, &first, sizeof (struct entry));
527
528       /* Close the file.  */
529       close (fd);
530       fd = -1;
531     }
532
533   /* Write a colorful statistic.  */
534   fprintf (stderr, "\n\
535 \e[01;32mMemory usage summary:\e[0;0m heap total: %llu, heap peak: %lu, stack peak: %lu\n\
536 \e[04;34m         total calls   total memory   failed calls\e[0m\n\
537 \e[00;34m malloc|\e[0m %10lu   %12llu   %s%12lu\e[00;00m\n\
538 \e[00;34mrealloc|\e[0m %10lu   %12llu   %s%12lu\e[00;00m   (in place: %ld, dec: %ld)\n\
539 \e[00;34m calloc|\e[0m %10lu   %12llu   %s%12lu\e[00;00m\n\
540 \e[00;34m   free|\e[0m %10lu   %12llu\n",
541            grand_total, (unsigned long int) peak_heap,
542            (unsigned long int) peak_stack,
543            calls[idx_malloc], total[idx_malloc],
544            failed[idx_malloc] ? "\e[01;41m" : "", failed[idx_malloc],
545            calls[idx_realloc], total[idx_realloc],
546            failed[idx_realloc] ? "\e[01;41m" : "", failed[idx_realloc],
547            inplace, decreasing,
548            calls[idx_calloc], total[idx_calloc],
549            failed[idx_calloc] ? "\e[01;41m" : "", failed[idx_calloc],
550            calls[idx_free], total[idx_free]);
551
552   /* Write out a histoogram of the sizes of the allocations.  */
553   fprintf (stderr, "\e[01;32mHistogram for block sizes:\e[0;0m\n");
554
555   /* Determine the maximum of all calls for each size range.  */
556   maxcalls = large;
557   for (cnt = 0; cnt < 65536; cnt += 16)
558     if (histogram[cnt / 16] > maxcalls)
559       maxcalls = histogram[cnt / 16];
560
561   for (cnt = 0; cnt < 65536; cnt += 16)
562     /* Only write out the nonzero entries.  */
563     if (histogram[cnt / 16] != 0)
564       {
565         percent = (histogram[cnt / 16] * 100) / calls_total;
566         fprintf (stderr, "%5d-%-5d%12lu ", cnt, cnt + 15,
567                  histogram[cnt / 16]);
568         if (percent == 0)
569           fputs (" <1% \e[41;37m", stderr);
570         else
571           fprintf (stderr, "%3d%% \e[41;37m", percent);
572
573         /* Draw a bar with a length corresponding to the current
574            percentage.  */
575         percent = (histogram[cnt / 16] * 50) / maxcalls;
576         while (percent-- > 0)
577           fputc ('=', stderr);
578          fputs ("\e[0;0m\n", stderr);
579       }
580
581   if (large != 0)
582     {
583       percent = (large * 100) / calls_total;
584       fprintf (stderr, "   large   %12lu ", large);
585       if (percent == 0)
586         fputs (" <1% \e[41;37m", stderr);
587       else
588         fprintf (stderr, "%3d%% \e[41;37m", percent);
589       percent = (large * 50) / maxcalls;
590       while (percent-- > 0)
591         fputc ('=', stderr);
592       fputs ("\e[0;0m\n", stderr);
593     }
594 }