summaryrefslogtreecommitdiff
path: root/src/libstrongswan/utils/leak_detective.h
blob: 7a29e81d793294bdb399be3649e4c9867f5ece00 (plain)
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
/*
 * Copyright (C) 2008 Martin Willi
 * Hochschule fuer Technik Rapperswil
 *
 * 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.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * 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.
 */

/**
 * @defgroup leak_detective leak_detective
 * @{ @ingroup utils
 */

#ifndef LEAK_DETECTIVE_H_
#define LEAK_DETECTIVE_H_

typedef struct leak_detective_t leak_detective_t;

#include <library.h>

/**
 * Leak detective finds leaks and bad frees using malloc hooks.
 *
 * Currently leaks are reported to stderr on destruction.
 *
 * @todo Build an API for leak detective, allowing leak enumeration, statistics
 * and dynamic whitelisting.
 */
struct leak_detective_t {

	/**
	 * Report leaks to stderr.
	 *
	 * @param detailed 		TRUE to resolve line/filename of leak (slow)
	 */
	void (*report)(leak_detective_t *this, bool detailed);

	/**
	 * Number of detected leaks.
	 *
	 * @return				number of leaks
	 */
	int (*leaks)(leak_detective_t *this);

	/**
	 * Report current memory usage to out.
	 *
	 * @param out			target to write usage report to
	 */
	void (*usage)(leak_detective_t *this, FILE *out);

	/**
	 * Enable/disable leak detective hooks for the current thread.
	 *
	 * @param				TRUE to enable, FALSE to disable
	 * @return				state active before calling set_state
	 */
	bool (*set_state)(leak_detective_t *this, bool enabled);

	/**
	 * Destroy a leak_detective instance.
	 */
	void (*destroy)(leak_detective_t *this);
};

/**
 * Create a leak_detective instance.
 */
leak_detective_t *leak_detective_create();

#endif /** LEAK_DETECTIVE_H_ @}*/