1 /***************************************************************************
3 * Project ___| | | | _ \| |
5 * | (__| |_| | _ <| |___
6 * \___|\___/|_| \_\_____|
8 * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
10 * This software is licensed as described in the file COPYING, which
11 * you should have received as part of this distribution. The terms
12 * are also available at https://curl.haxx.se/docs/copyright.html.
14 * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 * copies of the Software, and permit persons to whom the Software is
16 * furnished to do so, under the terms of the COPYING file.
18 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 * KIND, either express or implied.
21 ***************************************************************************/
23 #include "curl_setup.h"
27 #include <curl/curl.h>
31 #define MEMDEBUG_NODEFINES /* don't redefine the standard functions */
33 /* The last 3 #include files should be in this order */
34 #include "curl_printf.h"
35 #include "curl_memory.h"
45 /* I'm hoping this is the thing with the strictest alignment
46 * requirements. That also means we waste some space :-( */
50 * Note that these debug functions are very simple and they are meant to
51 * remain so. For advanced analysis, record a log file and write perl scripts
54 * Don't use these with multithreaded test programs!
57 FILE *curl_dbg_logfile = NULL;
58 static bool memlimit = FALSE; /* enable memory limit */
59 static long memsize = 0; /* set number of mallocs allowed */
61 /* this sets the log file name */
62 void curl_dbg_memdebug(const char *logname)
64 if(!curl_dbg_logfile) {
65 if(logname && *logname)
66 curl_dbg_logfile = fopen(logname, FOPEN_WRITETEXT);
68 curl_dbg_logfile = stderr;
69 #ifdef MEMDEBUG_LOG_SYNC
70 /* Flush the log file after every line so the log isn't lost in a crash */
72 setbuf(curl_dbg_logfile, (char *)NULL);
77 /* This function sets the number of malloc() calls that should return
79 void curl_dbg_memlimit(long limit)
87 /* returns TRUE if this isn't allowed! */
88 static bool countcheck(const char *func, int line, const char *source)
90 /* if source is NULL, then the call is made internally and this check
92 if(memlimit && source) {
96 curl_dbg_log("LIMIT %s:%d %s reached memlimit\n",
98 /* log to stderr also */
99 fprintf(stderr, "LIMIT %s:%d %s reached memlimit\n",
101 fflush(curl_dbg_logfile); /* because it might crash now */
104 return TRUE; /* RETURN ERROR! */
107 memsize--; /* countdown */
112 return FALSE; /* allow this */
115 void *curl_dbg_malloc(size_t wantedsize, int line, const char *source)
117 struct memdebug *mem;
120 DEBUGASSERT(wantedsize != 0);
122 if(countcheck("malloc", line, source))
125 /* alloc at least 64 bytes */
126 size = sizeof(struct memdebug) + wantedsize;
128 mem = (Curl_cmalloc)(size);
130 mem->size = wantedsize;
134 curl_dbg_log("MEM %s:%d malloc(%zu) = %p\n",
135 source, line, wantedsize,
136 mem ? (void *)mem->mem : (void *)0);
138 return (mem ? mem->mem : NULL);
141 void *curl_dbg_calloc(size_t wanted_elements, size_t wanted_size,
142 int line, const char *source)
144 struct memdebug *mem;
145 size_t size, user_size;
147 DEBUGASSERT(wanted_elements != 0);
148 DEBUGASSERT(wanted_size != 0);
150 if(countcheck("calloc", line, source))
153 /* alloc at least 64 bytes */
154 user_size = wanted_size * wanted_elements;
155 size = sizeof(struct memdebug) + user_size;
157 mem = (Curl_ccalloc)(1, size);
159 mem->size = user_size;
162 curl_dbg_log("MEM %s:%d calloc(%zu,%zu) = %p\n",
163 source, line, wanted_elements, wanted_size,
164 mem ? (void *)mem->mem : (void *)0);
166 return (mem ? mem->mem : NULL);
169 char *curl_dbg_strdup(const char *str, int line, const char *source)
174 DEBUGASSERT(str != NULL);
176 if(countcheck("strdup", line, source))
179 len = strlen(str) + 1;
181 mem = curl_dbg_malloc(len, 0, NULL); /* NULL prevents logging */
183 memcpy(mem, str, len);
186 curl_dbg_log("MEM %s:%d strdup(%p) (%zu) = %p\n",
187 source, line, (const void *)str, len, (const void *)mem);
192 #if defined(WIN32) && defined(UNICODE)
193 wchar_t *curl_dbg_wcsdup(const wchar_t *str, int line, const char *source)
198 DEBUGASSERT(str != NULL);
200 if(countcheck("wcsdup", line, source))
203 wsiz = wcslen(str) + 1;
204 bsiz = wsiz * sizeof(wchar_t);
206 mem = curl_dbg_malloc(bsiz, 0, NULL); /* NULL prevents logging */
208 memcpy(mem, str, bsiz);
211 curl_dbg_log("MEM %s:%d wcsdup(%p) (%zu) = %p\n",
212 source, line, (void *)str, bsiz, (void *)mem);
218 /* We provide a realloc() that accepts a NULL as pointer, which then
219 performs a malloc(). In order to work with ares. */
220 void *curl_dbg_realloc(void *ptr, size_t wantedsize,
221 int line, const char *source)
223 struct memdebug *mem = NULL;
225 size_t size = sizeof(struct memdebug) + wantedsize;
227 DEBUGASSERT(wantedsize != 0);
229 if(countcheck("realloc", line, source))
232 #ifdef __INTEL_COMPILER
233 # pragma warning(push)
234 # pragma warning(disable:1684)
235 /* 1684: conversion from pointer to same-sized integral type */
239 mem = (void *)((char *)ptr - offsetof(struct memdebug, mem));
241 #ifdef __INTEL_COMPILER
242 # pragma warning(pop)
245 mem = (Curl_crealloc)(mem, size);
247 curl_dbg_log("MEM %s:%d realloc(%p, %zu) = %p\n",
248 source, line, (void *)ptr, wantedsize,
249 mem ? (void *)mem->mem : (void *)0);
252 mem->size = wantedsize;
259 void curl_dbg_free(void *ptr, int line, const char *source)
262 struct memdebug *mem;
264 #ifdef __INTEL_COMPILER
265 # pragma warning(push)
266 # pragma warning(disable:1684)
267 /* 1684: conversion from pointer to same-sized integral type */
270 mem = (void *)((char *)ptr - offsetof(struct memdebug, mem));
272 #ifdef __INTEL_COMPILER
273 # pragma warning(pop)
281 curl_dbg_log("MEM %s:%d free(%p)\n", source, line, (void *)ptr);
284 curl_socket_t curl_dbg_socket(int domain, int type, int protocol,
285 int line, const char *source)
287 const char *fmt = (sizeof(curl_socket_t) == sizeof(int)) ?
288 "FD %s:%d socket() = %d\n" :
289 (sizeof(curl_socket_t) == sizeof(long)) ?
290 "FD %s:%d socket() = %ld\n" :
291 "FD %s:%d socket() = %zd\n";
293 curl_socket_t sockfd;
295 if(countcheck("socket", line, source))
296 return CURL_SOCKET_BAD;
298 sockfd = socket(domain, type, protocol);
300 if(source && (sockfd != CURL_SOCKET_BAD))
301 curl_dbg_log(fmt, source, line, sockfd);
306 SEND_TYPE_RETV curl_dbg_send(SEND_TYPE_ARG1 sockfd,
307 SEND_QUAL_ARG2 SEND_TYPE_ARG2 buf,
308 SEND_TYPE_ARG3 len, SEND_TYPE_ARG4 flags, int line,
312 if(countcheck("send", line, source))
314 rc = send(sockfd, buf, len, flags);
316 curl_dbg_log("SEND %s:%d send(%lu) = %ld\n",
317 source, line, (unsigned long)len, (long)rc);
321 RECV_TYPE_RETV curl_dbg_recv(RECV_TYPE_ARG1 sockfd, RECV_TYPE_ARG2 buf,
322 RECV_TYPE_ARG3 len, RECV_TYPE_ARG4 flags, int line,
326 if(countcheck("recv", line, source))
328 rc = recv(sockfd, buf, len, flags);
330 curl_dbg_log("RECV %s:%d recv(%lu) = %ld\n",
331 source, line, (unsigned long)len, (long)rc);
335 #ifdef HAVE_SOCKETPAIR
336 int curl_dbg_socketpair(int domain, int type, int protocol,
337 curl_socket_t socket_vector[2],
338 int line, const char *source)
340 const char *fmt = (sizeof(curl_socket_t) == sizeof(int)) ?
341 "FD %s:%d socketpair() = %d %d\n" :
342 (sizeof(curl_socket_t) == sizeof(long)) ?
343 "FD %s:%d socketpair() = %ld %ld\n" :
344 "FD %s:%d socketpair() = %zd %zd\n";
346 int res = socketpair(domain, type, protocol, socket_vector);
348 if(source && (0 == res))
349 curl_dbg_log(fmt, source, line, socket_vector[0], socket_vector[1]);
355 curl_socket_t curl_dbg_accept(curl_socket_t s, void *saddr, void *saddrlen,
356 int line, const char *source)
358 const char *fmt = (sizeof(curl_socket_t) == sizeof(int)) ?
359 "FD %s:%d accept() = %d\n" :
360 (sizeof(curl_socket_t) == sizeof(long)) ?
361 "FD %s:%d accept() = %ld\n" :
362 "FD %s:%d accept() = %zd\n";
364 struct sockaddr *addr = (struct sockaddr *)saddr;
365 curl_socklen_t *addrlen = (curl_socklen_t *)saddrlen;
367 curl_socket_t sockfd = accept(s, addr, addrlen);
369 if(source && (sockfd != CURL_SOCKET_BAD))
370 curl_dbg_log(fmt, source, line, sockfd);
375 /* separate function to allow libcurl to mark a "faked" close */
376 void curl_dbg_mark_sclose(curl_socket_t sockfd, int line, const char *source)
378 const char *fmt = (sizeof(curl_socket_t) == sizeof(int)) ?
379 "FD %s:%d sclose(%d)\n":
380 (sizeof(curl_socket_t) == sizeof(long)) ?
381 "FD %s:%d sclose(%ld)\n":
382 "FD %s:%d sclose(%zd)\n";
385 curl_dbg_log(fmt, source, line, sockfd);
388 /* this is our own defined way to close sockets on *ALL* platforms */
389 int curl_dbg_sclose(curl_socket_t sockfd, int line, const char *source)
391 int res = sclose(sockfd);
392 curl_dbg_mark_sclose(sockfd, line, source);
396 FILE *curl_dbg_fopen(const char *file, const char *mode,
397 int line, const char *source)
399 FILE *res = fopen(file, mode);
402 curl_dbg_log("FILE %s:%d fopen(\"%s\",\"%s\") = %p\n",
403 source, line, file, mode, (void *)res);
408 FILE *curl_dbg_fdopen(int filedes, const char *mode,
409 int line, const char *source)
411 FILE *res = fdopen(filedes, mode);
413 curl_dbg_log("FILE %s:%d fdopen(\"%d\",\"%s\") = %p\n",
414 source, line, filedes, mode, (void *)res);
418 int curl_dbg_fclose(FILE *file, int line, const char *source)
422 DEBUGASSERT(file != NULL);
425 curl_dbg_log("FILE %s:%d fclose(%p)\n",
426 source, line, (void *)file);
433 #define LOGLINE_BUFSIZE 1024
435 /* this does the writing to the memory tracking log file */
436 void curl_dbg_log(const char *format, ...)
442 if(!curl_dbg_logfile)
445 buf = (Curl_cmalloc)(LOGLINE_BUFSIZE);
449 va_start(ap, format);
450 nchars = mvsnprintf(buf, LOGLINE_BUFSIZE, format, ap);
453 if(nchars > LOGLINE_BUFSIZE - 1)
454 nchars = LOGLINE_BUFSIZE - 1;
457 fwrite(buf, 1, (size_t)nchars, curl_dbg_logfile);
462 #endif /* CURLDEBUG */