Merged revisions 211274 via svnmerge from
[asterisk/asterisk.git] / main / astfd.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, Digium, Inc.
5  *
6  * Tilghman Lesher <tlesher@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Debugging routines for file descriptor leaks
22  *
23  * \author Tilghman Lesher <tlesher@digium.com>
24  */
25
26 #include "asterisk.h"
27
28 #ifdef DEBUG_FD_LEAKS
29
30 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
31
32 #include <stdio.h>
33 #include <string.h>
34 #include <stddef.h>
35 #include <time.h>
36 #include <sys/time.h>
37 #include <sys/resource.h>
38
39 #include "asterisk/cli.h"
40 #include "asterisk/logger.h"
41 #include "asterisk/options.h"
42 #include "asterisk/lock.h"
43 #include "asterisk/strings.h"
44 #include "asterisk/unaligned.h"
45
46 static struct fdleaks {
47         char file[40];
48         int line;
49         char function[25];
50         char callname[10];
51         char callargs[60];
52         unsigned int isopen:1;
53 } fdleaks[1024] = { { "", }, };
54
55 #define COPY(dst, src)                                             \
56         do {                                                           \
57                 int dlen = sizeof(dst), slen = strlen(src);                \
58                 if (slen + 1 > dlen) {                                     \
59                         char *slash = strrchr(src, '/');                       \
60                         if (slash) {                                           \
61                                 ast_copy_string(dst, slash + 1, dlen);             \
62                         } else {                                               \
63                                 ast_copy_string(dst, src + slen - dlen + 1, dlen); \
64                         }                                                      \
65                 } else {                                                   \
66                         ast_copy_string(dst, src, dlen);                       \
67                 }                                                          \
68         } while (0)
69
70 #define STORE_COMMON(offset, name, ...)     \
71         COPY(fdleaks[offset].file, file);       \
72         fdleaks[offset].line = line;            \
73         COPY(fdleaks[offset].function, func);   \
74         strcpy(fdleaks[offset].callname, name); \
75         snprintf(fdleaks[offset].callargs, sizeof(fdleaks[offset].callargs), __VA_ARGS__); \
76         fdleaks[offset].isopen = 1;
77
78 #undef open
79 int __ast_fdleak_open(const char *file, int line, const char *func, const char *path, int flags, ...)
80 {
81         int res;
82         va_list ap;
83         int mode;
84
85         if (flags & O_CREAT) {
86                 va_start(ap, flags);
87                 mode = va_arg(ap, int);
88                 va_end(ap);
89                 res = open(path, flags, mode);
90                 if (res > -1 && res < (sizeof(fdleaks) / sizeof(fdleaks[0]))) {
91                         char sflags[80];
92                         snprintf(sflags, sizeof(sflags), "O_CREAT%s%s%s%s%s%s%s%s",
93                                 flags & O_APPEND ? "|O_APPEND" : "",
94                                 flags & O_EXCL ? "|O_EXCL" : "",
95                                 flags & O_NONBLOCK ? "|O_NONBLOCK" : "",
96                                 flags & O_TRUNC ? "|O_TRUNC" : "",
97                                 flags & O_RDWR ? "|O_RDWR" : "",
98                                 flags & O_RDONLY ? "|O_RDONLY" : "",
99                                 flags & O_WRONLY ? "|O_WRONLY" : "",
100                                 "");
101                         flags &= ~(O_CREAT | O_APPEND | O_EXCL | O_NONBLOCK | O_TRUNC | O_RDWR | O_RDONLY | O_WRONLY);
102                         if (flags) {
103                                 STORE_COMMON(res, "open", "\"%s\",%s|%d,%04o", path, sflags, flags, mode);
104                         } else {
105                                 STORE_COMMON(res, "open", "\"%s\",%s,%04o", path, sflags, mode);
106                         }
107                 }
108         } else {
109                 res = open(path, flags);
110                 if (res > -1 && res < (sizeof(fdleaks) / sizeof(fdleaks[0]))) {
111                         STORE_COMMON(res, "open", "\"%s\",%d", path, flags);
112                 }
113         }
114         return res;
115 }
116
117 #undef pipe
118 int __ast_fdleak_pipe(int *fds, const char *file, int line, const char *func)
119 {
120         int i, res = pipe(fds);
121         if (res) {
122                 return res;
123         }
124         for (i = 0; i < 2; i++) {
125                 STORE_COMMON(fds[i], "pipe", "{%d,%d}", fds[0], fds[1]);
126         }
127         return 0;
128 }
129
130 #undef socket
131 int __ast_fdleak_socket(int domain, int type, int protocol, const char *file, int line, const char *func)
132 {
133         char sdomain[20], stype[20], *sproto;
134         struct protoent *pe;
135         int res = socket(domain, type, protocol);
136         if (res < 0 || res > 1023) {
137                 return res;
138         }
139
140         pe = getprotobynumber(protocol);
141         sproto = pe->p_name;
142
143         if (domain == PF_UNIX) {
144                 ast_copy_string(sdomain, "PF_UNIX", sizeof(sdomain));
145         } else if (domain == PF_INET) {
146                 ast_copy_string(sdomain, "PF_INET", sizeof(sdomain));
147         } else {
148                 snprintf(sdomain, sizeof(sdomain), "%d", domain);
149         }
150
151         if (type == SOCK_DGRAM) {
152                 ast_copy_string(stype, "SOCK_DGRAM", sizeof(stype));
153                 if (protocol == 0) {
154                         sproto = "udp";
155                 }
156         } else if (type == SOCK_STREAM) {
157                 ast_copy_string(stype, "SOCK_STREAM", sizeof(stype));
158                 if (protocol == 0) {
159                         sproto = "tcp";
160                 }
161         } else {
162                 snprintf(stype, sizeof(stype), "%d", type);
163         }
164
165         STORE_COMMON(res, "socket", "%s,%s,\"%s\"", sdomain, stype, sproto);
166         return res;
167 }
168
169 #undef close
170 int __ast_fdleak_close(int fd)
171 {
172         int res = close(fd);
173         if (!res && fd > -1 && fd < 1024) {
174                 fdleaks[fd].isopen = 0;
175         }
176         return res;
177 }
178
179 #undef fopen
180 FILE *__ast_fdleak_fopen(const char *path, const char *mode, const char *file, int line, const char *func)
181 {
182         FILE *res = fopen(path, mode);
183         int fd;
184         if (!res) {
185                 return res;
186         }
187         fd = fileno(res);
188         STORE_COMMON(fd, "fopen", "\"%s\",\"%s\"", path, mode);
189         return res;
190 }
191
192 #undef fclose
193 int __ast_fdleak_fclose(FILE *ptr)
194 {
195         int fd, res;
196         if (!ptr) {
197                 return fclose(ptr);
198         }
199
200         fd = fileno(ptr);
201         if ((res = fclose(ptr)) || fd < 0 || fd > 1023) {
202                 return res;
203         }
204         fdleaks[fd].isopen = 0;
205         return res;
206 }
207
208 #undef dup2
209 int __ast_fdleak_dup2(int oldfd, int newfd, const char *file, int line, const char *func)
210 {
211         int res = dup2(oldfd, newfd);
212         if (res < 0 || res > 1023) {
213                 return res;
214         }
215         STORE_COMMON(res, "dup2", "%d,%d", oldfd, newfd);
216         return res;
217 }
218
219 #undef dup
220 int __ast_fdleak_dup(int oldfd, const char *file, int line, const char *func)
221 {
222         int res = dup(oldfd);
223         if (res < 0 || res > 1023) {
224                 return res;
225         }
226         STORE_COMMON(res, "dup2", "%d", oldfd);
227         return res;
228 }
229
230 static char *handle_show_fd(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
231 {
232         int i;
233         char line[24];
234         struct rlimit rl;
235         switch (cmd) {
236         case CLI_INIT:
237                 e->command = "core show fd";
238                 e->usage =
239                         "Usage: core show fd\n"
240                         "       List all file descriptors currently in use and where\n"
241                         "       each was opened, and with what command.\n";
242                 return NULL;
243         case CLI_GENERATE:
244                 return NULL;
245         }
246         getrlimit(RLIMIT_FSIZE, &rl);
247         if (rl.rlim_cur == RLIM_INFINITY || rl.rlim_max == RLIM_INFINITY) {
248                 ast_copy_string(line, "unlimited", sizeof(line));
249         } else {
250                 snprintf(line, sizeof(line), "%d/%d", (int) rl.rlim_cur, (int) rl.rlim_max);
251         }
252         ast_cli(a->fd, "Current maxfiles: %s\n", line);
253         for (i = 0; i < 1024; i++) {
254                 if (fdleaks[i].isopen) {
255                         snprintf(line, sizeof(line), "%d", fdleaks[i].line);
256                         ast_cli(a->fd, "%5d %15s:%-7.7s (%-25s): %s(%s)\n", i, fdleaks[i].file, line, fdleaks[i].function, fdleaks[i].callname, fdleaks[i].callargs);
257                 }
258         }
259         return CLI_SUCCESS;
260 }
261
262 static struct ast_cli_entry cli_show_fd = AST_CLI_DEFINE(handle_show_fd, "Show open file descriptors");
263
264 int ast_fd_init(void)
265 {
266         return ast_cli_register(&cli_show_fd);
267 }
268
269 #else  /* !defined(DEBUG_FD_LEAKS) */
270 int ast_fd_init(void)
271 {
272         return 0;
273 }
274 #endif /* defined(DEBUG_FD_LEAKS) */
275