123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503 |
- /***************************************************************************
- * _ _ ____ _
- * Project ___| | | | _ \| |
- * / __| | | | |_) | |
- * | (__| |_| | _ <| |___
- * \___|\___/|_| \_\_____|
- *
- * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
- *
- * This software is licensed as described in the file COPYING, which
- * you should have received as part of this distribution. The terms
- * are also available at https://curl.haxx.se/docs/copyright.html.
- *
- * You may opt to use, copy, modify, merge, publish, distribute and/or sell
- * copies of the Software, and permit persons to whom the Software is
- * furnished to do so, under the terms of the COPYING file.
- *
- * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
- * KIND, either express or implied.
- *
- ***************************************************************************/
- #include "curl_setup.h"
- #ifdef CURLDEBUG
- #include <curl/curl.h>
- #include "urldata.h"
- #define MEMDEBUG_NODEFINES /* don't redefine the standard functions */
- /* The last 3 #include files should be in this order */
- #include "curl_printf.h"
- #include "curl_memory.h"
- #include "memdebug.h"
- /*
- * Until 2011-08-17 libcurl's Memory Tracking feature also performed
- * automatic malloc and free filling operations using 0xA5 and 0x13
- * values. Our own preinitialization of dynamically allocated memory
- * might be useful when not using third party memory debuggers, but
- * on the other hand this would fool memory debuggers into thinking
- * that all dynamically allocated memory is properly initialized.
- *
- * As a default setting, libcurl's Memory Tracking feature no longer
- * performs preinitialization of dynamically allocated memory on its
- * own. If you know what you are doing, and really want to retain old
- * behavior, you can achieve this compiling with preprocessor symbols
- * CURL_MT_MALLOC_FILL and CURL_MT_FREE_FILL defined with appropriate
- * values.
- */
- #ifdef CURL_MT_MALLOC_FILL
- # if (CURL_MT_MALLOC_FILL < 0) || (CURL_MT_MALLOC_FILL > 0xff)
- # error "invalid CURL_MT_MALLOC_FILL or out of range"
- # endif
- #endif
- #ifdef CURL_MT_FREE_FILL
- # if (CURL_MT_FREE_FILL < 0) || (CURL_MT_FREE_FILL > 0xff)
- # error "invalid CURL_MT_FREE_FILL or out of range"
- # endif
- #endif
- #if defined(CURL_MT_MALLOC_FILL) && defined(CURL_MT_FREE_FILL)
- # if (CURL_MT_MALLOC_FILL == CURL_MT_FREE_FILL)
- # error "CURL_MT_MALLOC_FILL same as CURL_MT_FREE_FILL"
- # endif
- #endif
- #ifdef CURL_MT_MALLOC_FILL
- # define mt_malloc_fill(buf,len) memset((buf), CURL_MT_MALLOC_FILL, (len))
- #else
- # define mt_malloc_fill(buf,len) Curl_nop_stmt
- #endif
- #ifdef CURL_MT_FREE_FILL
- # define mt_free_fill(buf,len) memset((buf), CURL_MT_FREE_FILL, (len))
- #else
- # define mt_free_fill(buf,len) Curl_nop_stmt
- #endif
- struct memdebug {
- size_t size;
- union {
- curl_off_t o;
- double d;
- void *p;
- } mem[1];
- /* I'm hoping this is the thing with the strictest alignment
- * requirements. That also means we waste some space :-( */
- };
- /*
- * Note that these debug functions are very simple and they are meant to
- * remain so. For advanced analysis, record a log file and write perl scripts
- * to analyze them!
- *
- * Don't use these with multithreaded test programs!
- */
- FILE *curl_dbg_logfile = NULL;
- static bool memlimit = FALSE; /* enable memory limit */
- static long memsize = 0; /* set number of mallocs allowed */
- /* this sets the log file name */
- void curl_dbg_memdebug(const char *logname)
- {
- if(!curl_dbg_logfile) {
- if(logname && *logname)
- curl_dbg_logfile = fopen(logname, FOPEN_WRITETEXT);
- else
- curl_dbg_logfile = stderr;
- #ifdef MEMDEBUG_LOG_SYNC
- /* Flush the log file after every line so the log isn't lost in a crash */
- if(curl_dbg_logfile)
- setbuf(curl_dbg_logfile, (char *)NULL);
- #endif
- }
- }
- /* This function sets the number of malloc() calls that should return
- successfully! */
- void curl_dbg_memlimit(long limit)
- {
- if(!memlimit) {
- memlimit = TRUE;
- memsize = limit;
- }
- }
- /* returns TRUE if this isn't allowed! */
- static bool countcheck(const char *func, int line, const char *source)
- {
- /* if source is NULL, then the call is made internally and this check
- should not be made */
- if(memlimit && source) {
- if(!memsize) {
- if(source) {
- /* log to file */
- curl_dbg_log("LIMIT %s:%d %s reached memlimit\n",
- source, line, func);
- /* log to stderr also */
- fprintf(stderr, "LIMIT %s:%d %s reached memlimit\n",
- source, line, func);
- fflush(curl_dbg_logfile); /* because it might crash now */
- }
- errno = ENOMEM;
- return TRUE; /* RETURN ERROR! */
- }
- else
- memsize--; /* countdown */
- }
- return FALSE; /* allow this */
- }
- void *curl_dbg_malloc(size_t wantedsize, int line, const char *source)
- {
- struct memdebug *mem;
- size_t size;
- DEBUGASSERT(wantedsize != 0);
- if(countcheck("malloc", line, source))
- return NULL;
- /* alloc at least 64 bytes */
- size = sizeof(struct memdebug) + wantedsize;
- mem = (Curl_cmalloc)(size);
- if(mem) {
- /* fill memory with junk */
- mt_malloc_fill(mem->mem, wantedsize);
- mem->size = wantedsize;
- }
- if(source)
- curl_dbg_log("MEM %s:%d malloc(%zu) = %p\n",
- source, line, wantedsize,
- mem ? (void *)mem->mem : (void *)0);
- return (mem ? mem->mem : NULL);
- }
- void *curl_dbg_calloc(size_t wanted_elements, size_t wanted_size,
- int line, const char *source)
- {
- struct memdebug *mem;
- size_t size, user_size;
- DEBUGASSERT(wanted_elements != 0);
- DEBUGASSERT(wanted_size != 0);
- if(countcheck("calloc", line, source))
- return NULL;
- /* alloc at least 64 bytes */
- user_size = wanted_size * wanted_elements;
- size = sizeof(struct memdebug) + user_size;
- mem = (Curl_ccalloc)(1, size);
- if(mem)
- mem->size = user_size;
- if(source)
- curl_dbg_log("MEM %s:%d calloc(%zu,%zu) = %p\n",
- source, line, wanted_elements, wanted_size,
- mem ? (void *)mem->mem : (void *)0);
- return (mem ? mem->mem : NULL);
- }
- char *curl_dbg_strdup(const char *str, int line, const char *source)
- {
- char *mem;
- size_t len;
- DEBUGASSERT(str != NULL);
- if(countcheck("strdup", line, source))
- return NULL;
- len = strlen(str) + 1;
- mem = curl_dbg_malloc(len, 0, NULL); /* NULL prevents logging */
- if(mem)
- memcpy(mem, str, len);
- if(source)
- curl_dbg_log("MEM %s:%d strdup(%p) (%zu) = %p\n",
- source, line, (const void *)str, len, (const void *)mem);
- return mem;
- }
- #if defined(WIN32) && defined(UNICODE)
- wchar_t *curl_dbg_wcsdup(const wchar_t *str, int line, const char *source)
- {
- wchar_t *mem;
- size_t wsiz, bsiz;
- DEBUGASSERT(str != NULL);
- if(countcheck("wcsdup", line, source))
- return NULL;
- wsiz = wcslen(str) + 1;
- bsiz = wsiz * sizeof(wchar_t);
- mem = curl_dbg_malloc(bsiz, 0, NULL); /* NULL prevents logging */
- if(mem)
- memcpy(mem, str, bsiz);
- if(source)
- curl_dbg_log("MEM %s:%d wcsdup(%p) (%zu) = %p\n",
- source, line, (void *)str, bsiz, (void *)mem);
- return mem;
- }
- #endif
- /* We provide a realloc() that accepts a NULL as pointer, which then
- performs a malloc(). In order to work with ares. */
- void *curl_dbg_realloc(void *ptr, size_t wantedsize,
- int line, const char *source)
- {
- struct memdebug *mem = NULL;
- size_t size = sizeof(struct memdebug) + wantedsize;
- DEBUGASSERT(wantedsize != 0);
- if(countcheck("realloc", line, source))
- return NULL;
- #ifdef __INTEL_COMPILER
- # pragma warning(push)
- # pragma warning(disable:1684)
- /* 1684: conversion from pointer to same-sized integral type */
- #endif
- if(ptr)
- mem = (void *)((char *)ptr - offsetof(struct memdebug, mem));
- #ifdef __INTEL_COMPILER
- # pragma warning(pop)
- #endif
- mem = (Curl_crealloc)(mem, size);
- if(source)
- curl_dbg_log("MEM %s:%d realloc(%p, %zu) = %p\n",
- source, line, (void *)ptr, wantedsize,
- mem ? (void *)mem->mem : (void *)0);
- if(mem) {
- mem->size = wantedsize;
- return mem->mem;
- }
- return NULL;
- }
- void curl_dbg_free(void *ptr, int line, const char *source)
- {
- if(ptr) {
- struct memdebug *mem;
- #ifdef __INTEL_COMPILER
- # pragma warning(push)
- # pragma warning(disable:1684)
- /* 1684: conversion from pointer to same-sized integral type */
- #endif
- mem = (void *)((char *)ptr - offsetof(struct memdebug, mem));
- #ifdef __INTEL_COMPILER
- # pragma warning(pop)
- #endif
- /* destroy */
- mt_free_fill(mem->mem, mem->size);
- /* free for real */
- (Curl_cfree)(mem);
- }
- if(source && ptr)
- curl_dbg_log("MEM %s:%d free(%p)\n", source, line, (void *)ptr);
- }
- curl_socket_t curl_dbg_socket(int domain, int type, int protocol,
- int line, const char *source)
- {
- const char *fmt = (sizeof(curl_socket_t) == sizeof(int)) ?
- "FD %s:%d socket() = %d\n" :
- (sizeof(curl_socket_t) == sizeof(long)) ?
- "FD %s:%d socket() = %ld\n" :
- "FD %s:%d socket() = %zd\n";
- curl_socket_t sockfd;
- if(countcheck("socket", line, source))
- return CURL_SOCKET_BAD;
- sockfd = socket(domain, type, protocol);
- if(source && (sockfd != CURL_SOCKET_BAD))
- curl_dbg_log(fmt, source, line, sockfd);
- return sockfd;
- }
- SEND_TYPE_RETV curl_dbg_send(SEND_TYPE_ARG1 sockfd,
- SEND_QUAL_ARG2 SEND_TYPE_ARG2 buf,
- SEND_TYPE_ARG3 len, SEND_TYPE_ARG4 flags, int line,
- const char *source)
- {
- SEND_TYPE_RETV rc;
- if(countcheck("send", line, source))
- return -1;
- rc = send(sockfd, buf, len, flags);
- if(source)
- curl_dbg_log("SEND %s:%d send(%lu) = %ld\n",
- source, line, (unsigned long)len, (long)rc);
- return rc;
- }
- RECV_TYPE_RETV curl_dbg_recv(RECV_TYPE_ARG1 sockfd, RECV_TYPE_ARG2 buf,
- RECV_TYPE_ARG3 len, RECV_TYPE_ARG4 flags, int line,
- const char *source)
- {
- RECV_TYPE_RETV rc;
- if(countcheck("recv", line, source))
- return -1;
- rc = recv(sockfd, buf, len, flags);
- if(source)
- curl_dbg_log("RECV %s:%d recv(%lu) = %ld\n",
- source, line, (unsigned long)len, (long)rc);
- return rc;
- }
- #ifdef HAVE_SOCKETPAIR
- int curl_dbg_socketpair(int domain, int type, int protocol,
- curl_socket_t socket_vector[2],
- int line, const char *source)
- {
- const char *fmt = (sizeof(curl_socket_t) == sizeof(int)) ?
- "FD %s:%d socketpair() = %d %d\n" :
- (sizeof(curl_socket_t) == sizeof(long)) ?
- "FD %s:%d socketpair() = %ld %ld\n" :
- "FD %s:%d socketpair() = %zd %zd\n";
- int res = socketpair(domain, type, protocol, socket_vector);
- if(source && (0 == res))
- curl_dbg_log(fmt, source, line, socket_vector[0], socket_vector[1]);
- return res;
- }
- #endif
- curl_socket_t curl_dbg_accept(curl_socket_t s, void *saddr, void *saddrlen,
- int line, const char *source)
- {
- const char *fmt = (sizeof(curl_socket_t) == sizeof(int)) ?
- "FD %s:%d accept() = %d\n" :
- (sizeof(curl_socket_t) == sizeof(long)) ?
- "FD %s:%d accept() = %ld\n" :
- "FD %s:%d accept() = %zd\n";
- struct sockaddr *addr = (struct sockaddr *)saddr;
- curl_socklen_t *addrlen = (curl_socklen_t *)saddrlen;
- curl_socket_t sockfd = accept(s, addr, addrlen);
- if(source && (sockfd != CURL_SOCKET_BAD))
- curl_dbg_log(fmt, source, line, sockfd);
- return sockfd;
- }
- /* separate function to allow libcurl to mark a "faked" close */
- void curl_dbg_mark_sclose(curl_socket_t sockfd, int line, const char *source)
- {
- const char *fmt = (sizeof(curl_socket_t) == sizeof(int)) ?
- "FD %s:%d sclose(%d)\n":
- (sizeof(curl_socket_t) == sizeof(long)) ?
- "FD %s:%d sclose(%ld)\n":
- "FD %s:%d sclose(%zd)\n";
- if(source)
- curl_dbg_log(fmt, source, line, sockfd);
- }
- /* this is our own defined way to close sockets on *ALL* platforms */
- int curl_dbg_sclose(curl_socket_t sockfd, int line, const char *source)
- {
- int res = sclose(sockfd);
- curl_dbg_mark_sclose(sockfd, line, source);
- return res;
- }
- FILE *curl_dbg_fopen(const char *file, const char *mode,
- int line, const char *source)
- {
- FILE *res = fopen(file, mode);
- if(source)
- curl_dbg_log("FILE %s:%d fopen(\"%s\",\"%s\") = %p\n",
- source, line, file, mode, (void *)res);
- return res;
- }
- int curl_dbg_fclose(FILE *file, int line, const char *source)
- {
- int res;
- DEBUGASSERT(file != NULL);
- if(source)
- curl_dbg_log("FILE %s:%d fclose(%p)\n",
- source, line, (void *)file);
- res = fclose(file);
- return res;
- }
- #define LOGLINE_BUFSIZE 1024
- /* this does the writing to the memory tracking log file */
- void curl_dbg_log(const char *format, ...)
- {
- char *buf;
- int nchars;
- va_list ap;
- if(!curl_dbg_logfile)
- return;
- buf = (Curl_cmalloc)(LOGLINE_BUFSIZE);
- if(!buf)
- return;
- va_start(ap, format);
- nchars = mvsnprintf(buf, LOGLINE_BUFSIZE, format, ap);
- va_end(ap);
- if(nchars > LOGLINE_BUFSIZE - 1)
- nchars = LOGLINE_BUFSIZE - 1;
- if(nchars > 0)
- fwrite(buf, 1, (size_t)nchars, curl_dbg_logfile);
- (Curl_cfree)(buf);
- }
- #endif /* CURLDEBUG */
|