File: zenprofiler.h

package info (click to toggle)
gmime2 2.0.14-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 5,092 kB
  • ctags: 3,177
  • sloc: ansic: 29,973; sh: 8,234; makefile: 413; perl: 6
file content (334 lines) | stat: -rw-r--r-- 9,574 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 *  Authors: Jeffrey Stedfast <fejj@ximian.com>
 *
 *  Copyright 2001-2004 Ximian, Inc. (www.ximian.com)
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Street #330, Boston, MA 02111-1307, USA.
 *
 */


#ifndef __ZENPROFILER_H__
#define __ZENPROFILER_H__

#include <glib.h>
#include <stdio.h>
#include <ctype.h>
#ifdef ENABLE_THREADS
#include <pthread.h>
#endif

#ifndef ENABLE_ZENTIMER
#ifdef ENABLE_ZENPROFILER
#define ENABLE_ZENTIMER
#endif
#endif /* ENABLE_ZENTIMER */

#include "zentimer.h"

#ifdef __cplusplus
extern "C" {
#pragma }
#endif /* __cplusplus */

#ifdef ENABLE_ZENPROFILER

struct zenfunc_t {
	char *name;
	unsigned num;
	ztime_t total;
};

static struct {
	FILE *log;
	ztimer_t ztimer;
	ztime_t total;
	GHashTable *hash;
	GSList *list;
} zenprof = { NULL, ZTIMER_INITIALIZER, { 0, 0 }, NULL, NULL };

#ifdef ENABLE_THREADS
static pthread_mutex_t zen_lock = PTHREAD_MUTEX_INITIALIZER;
#define ZENPROFILER_LOCK()   pthread_mutex_lock (&zen_lock)
#define ZENPROFILER_UNLOCK() pthread_mutex_unlock (&zen_lock)
#else
#define ZENPROFILER_LOCK()
#define ZENPROFILER_UNLOCK()
#endif /* ENABLE_THREADS */

static char *
zengetname (char *func)
{
	char *ptr;
	
	for (ptr = func; *ptr && *ptr != '('; ptr++);
	
	return g_strstrip (g_strndup (func, ptr - func));
}


/**
 * ZenProfilerInit:
 * @logfile: File to save profiling information (or %NULL to log to stderr)
 *
 * Initializes the Zen Profiler.
 **/
static void
ZenProfilerInit (const char *logfile)
{
	zenprof.hash = g_hash_table_new (g_str_hash, g_str_equal);
	
	ZenTimerMTStart (zenprof.ztimer);
	
	if (logfile)
		zenprof.log = fopen (logfile, "w+");
}


static void
zen_report_internal (char *name, ztimer_t ztimer)
{
	struct zenfunc_t *zenfunc;
	ztime_t diff;
	char *key;
	
	ZENPROFILER_LOCK();
	
	if (!g_hash_table_lookup_extended (zenprof.hash, name, (gpointer *) &key, (gpointer *) &zenfunc)) {
		zenfunc = g_new0 (struct zenfunc_t, 1);
		zenfunc->name = name;
		zenfunc->total.sec = 0;
		zenfunc->total.msec = 0;
		zenfunc->num = 0;
		g_hash_table_insert (zenprof.hash, zenfunc->name, zenfunc);
		zenprof.list = g_slist_prepend (zenprof.list, zenfunc);
	} else
		g_free (name);
	
	ztime_diff (ztimer.start, ztimer.stop, &diff);
	
	zenfunc->total.sec += diff.sec;
	zenfunc->total.msec += diff.msec;
	while (zenfunc->total.msec >= 1000) {
		zenfunc->total.msec -= 1000;
		zenfunc->total.sec += 1;
	}
	zenfunc->num++;
	
	ZENPROFILER_UNLOCK();
}


/**
 * ZenProfilerLazy:
 * @func: Function call to profile.
 *
 * Profiles the provided function call. This is basically the lazy way out.
 *
 * Sample usage:  ZenProfilerLazy(printf ("how long does this take??\n"));
 **/
#define ZenProfilerLazy(func) G_STMT_START {                  \
	{                                                     \
		ztimer_t ztimer;                              \
		char *name;                                   \
		                                              \
		ZenTimerMTStart (ztimer);                     \
		func;                                         \
		ZenTimerMTStop (ztimer);                      \
		                                              \
		name = zengetname (#func);                    \
		                                              \
		zen_report_internal (name, ztimer);           \
	}                                                     \
} G_STMT_END

/**
 * ZenProfilerStart:
 * @ztimer: a ztimer_t
 *
 * Initializes @zstart.
 **/
#define ZenProfilerStart(ztimer) ZenTimerMTStart (ztimer)


/**
 * ZenProfilerStop:
 * @ztimer: a ztimer_t
 *
 * Initializes @zstop.
 **/
#define ZenProfilerStop(ztimer) ZenTimerMTStop (ztimer)


/**
 * ZenProfilerReport:
 * @ztimer: a ztimer_t
 *
 * Cache the results for later reporting.
 **/
#define ZenProfilerReport(ztimer) G_STMT_START {              \
	{                                                     \
		char *name;                                   \
		                                              \
		name = g_strdup (__FUNCTION__);               \
		                                              \
		zen_report_internal (name, ztimer);           \
	}                                                     \
} G_STMT_END


/**
 * ZenProfiler_return:
 * @ztimer: a ztimer_t
 *
 * Stop the timer, report the results, and then return from the function.
 *
 * Note: equivalent to: ZenProfilerStop(@ztimer); ZenProfilerReport(@ztimer); return;
 **/
#define ZenProfiler_return(ztimer) G_STMT_START {             \
	ZenProfilerStop (ztimer);                             \
	ZenProfilerReport (ztimer);                           \
	return;                                               \
} G_STMT_END


/**
 * ZenProfiler_return_val:
 * @ztimer: a ztimer_t
 *
 * Same as ZenProfiler_return() but returns the specified value.
 **/
#define ZenProfiler_return_val(ztimer, retval) G_STMT_START { \
	ZenProfilerStop (ztimer);                             \
	ZenProfilerReport (ztimer);                           \
	return retval;                                        \
} G_STMT_END


#define ZENLOG (zenprof.log ? zenprof.log : stderr)

static void
zen_log (gpointer key, gpointer value, gpointer user_data)
{
	struct zenfunc_t *zenfunc = (struct zenfunc_t *) value;
	char percent[7], total[20], calls[20], average[20];
	unsigned long secs, millisecs;
	double pcnt = 0.0;
	
	if (zenfunc) {
		millisecs = zenfunc->total.sec * 1000 + zenfunc->total.msec;
		pcnt = ((double) millisecs) / ((double) zenprof.total.sec * 1000 + zenprof.total.msec) * 100;
		millisecs = (unsigned long) (millisecs / zenfunc->num);
		
		secs = 0;
		while (millisecs >= 1000) {
			millisecs -= 1000;
			secs++;
		}
		
		sprintf (percent, "%2.2f", pcnt);
		sprintf (calls, "%d", zenfunc->num);
		sprintf (total, "%lu.%03d", zenfunc->total.sec, zenfunc->total.msec);
		sprintf (average, "%lu.%03d", secs, millisecs);
		
		fprintf (ZENLOG, "%6s %9s  %7s  %7s %7s %7s  %s\n",
			 percent, total, "n/a", calls, "n/a", average, zenfunc->name);
		
		g_free (zenfunc->name);
		g_free (zenfunc);
	}
}


static int
zenfunccmp (gconstpointer a, gconstpointer b)
{
	const struct zenfunc_t *afunc = (const struct zenfunc_t *) a;
	const struct zenfunc_t *bfunc = (const struct zenfunc_t *) b;
	unsigned long amsec, bmsec;
	
	amsec = afunc->total.sec * 1000 + afunc->total.msec;
	bmsec = bfunc->total.sec * 1000 + bfunc->total.msec;
	
	return bmsec - amsec;
}


/**
 * ZenProfilerShutdown:
 *
 * Write out our profiling info and cleanup the mess we made.
 **/
static void
ZenProfilerShutdown (void)
{
	GSList *slist;
	
	ZenTimerMTStop (zenprof.ztimer);
	
	ztime_diff (zenprof.ztimer.start, zenprof.ztimer.stop, &zenprof.total);
	
	fprintf (ZENLOG, "ZenProfiler\n\n");
	fprintf (ZENLOG, "Flat profile:\n\n");
	fprintf (ZENLOG, "  %%   cumulative   self              self   total\n");
	fprintf (ZENLOG, " time   seconds   seconds    calls  s/call  s/call  name\n");
	fprintf (ZENLOG, "------ ---------  -------  ------- ------- -------  ----\n");
	zenprof.list = g_slist_sort (zenprof.list, zenfunccmp);
	for (slist = zenprof.list; slist; slist = slist->next)
		zen_log (NULL, slist->data, NULL);
	g_hash_table_destroy (zenprof.hash);
	g_slist_free (zenprof.list);
	fprintf (ZENLOG, "\n %%         the percentage of the total running time of the\n");
	fprintf (ZENLOG, "time       program used by this function.\n\n");
	fprintf (ZENLOG, "cumulative a running sum of the number of seconds accounted\n");
	fprintf (ZENLOG, " seconds   for by this function and those listed above it.\n\n");
	fprintf (ZENLOG, " self      the number of seconds accounted for by this\n");
	fprintf (ZENLOG, "seconds    function alone.  This is the major sort for this\n");
	fprintf (ZENLOG, "           listing.\n\n");
	fprintf (ZENLOG, "calls      the number of times this function was invoked, if\n");
	fprintf (ZENLOG, "           this function is profiled, else blank.\n\n");
	fprintf (ZENLOG, " self      the average number of seconds spent in this\n");
	fprintf (ZENLOG, "s/call     function per call, if this function is profiled,\n");
	fprintf (ZENLOG, "           else blank.\n\n");
	fprintf (ZENLOG, " total     the average number of seconds spent in this\n");
	fprintf (ZENLOG, " s/call    function and its descendents per call, if this \n");
	fprintf (ZENLOG, "           function is profiled, else blank.\n\n");
	fprintf (ZENLOG, "name       the name of the function.\n\n");
	
	if (zenprof.log)
		fclose (zenprof.log);
}

#else /* ENABLE_ZENPROFILER */

#define ZenProfilerInit(logfile)
#define ZenProfilerLazy(func) func
#define ZenProfilerStart(zstart)
#define ZenProfilerStop(zstop)
#define ZenProfilerReport(ztimer)
#define ZenProfiler_return(ztimer) return
#define ZenProfiler_return_val(ztimer, retval) return (retval)
#define ZenShutdown()

#endif /* ENABLE_ZENPROFILER */

#define zen(func) ZenProfilerLazy(func)

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* __ZENPROFILER_H__ */