mirror of
https://github.com/curl/curl.git
synced 2026-06-16 15:55:37 +03:00
ae647a7941
In order to better track down cases where we don't exit cleanly and directly on OOM errors, this mode warns if there is another memory operation found *after* the torture limit was reached. runtests sets this strict mode. memdebug adds two new helper functions needed to make this work. curl_dbg_overlook() lets the code mark a memory allocation as fine to not notice and yet do another one after even if this one returns error. curl_dbg_restart() marks the code as - at this point the code ignores the OOM status and it is fine to do another memory call afterwards without it being considered a problem.
524 lines
14 KiB
C
524 lines
14 KiB
C
/***************************************************************************
|
|
* _ _ ____ _
|
|
* Project ___| | | | _ \| |
|
|
* / __| | | | |_) | |
|
|
* | (__| |_| | _ <| |___
|
|
* \___|\___/|_| \_\_____|
|
|
*
|
|
* Copyright (C) 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.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.
|
|
*
|
|
* SPDX-License-Identifier: curl
|
|
*
|
|
***************************************************************************/
|
|
|
|
#include "curl_setup.h"
|
|
|
|
#ifdef CURLDEBUG
|
|
|
|
#include <curl/curl.h>
|
|
|
|
#include "urldata.h"
|
|
#include "curlx/fopen.h" /* for CURLX_FOPEN_LOW(), CURLX_FREOPEN_LOW() */
|
|
|
|
/* The last 2 #include files should be in this order */
|
|
#include "curl_memory.h"
|
|
#include "memdebug.h"
|
|
|
|
struct memdebug {
|
|
size_t size;
|
|
union {
|
|
curl_off_t o;
|
|
double d;
|
|
void *p;
|
|
} mem[1];
|
|
/* I am hoping this is the thing with the strictest alignment
|
|
* requirements. That also means we waste some space :-( */
|
|
};
|
|
|
|
/*
|
|
* Note that these debug functions are simple and they are meant to remain so.
|
|
* For advanced analysis, record a log file and write perl scripts to analyze
|
|
* them!
|
|
*
|
|
* Do not use these with multithreaded test programs!
|
|
*/
|
|
|
|
FILE *curl_dbg_logfile = NULL;
|
|
static bool registered_cleanup = FALSE; /* atexit registered cleanup */
|
|
static bool memlimit = FALSE; /* enable memory limit */
|
|
static long memsize = 0; /* set number of mallocs allowed */
|
|
|
|
/* LeakSantizier (LSAN) calls _exit() instead of exit() when a leak is detected
|
|
on exit so the logfile must be closed explicitly or data could be lost.
|
|
Though _exit() does not call atexit handlers such as this, LSAN's call to
|
|
_exit() comes after the atexit handlers are called. curl/curl#6620 */
|
|
static void curl_dbg_cleanup(void)
|
|
{
|
|
if(curl_dbg_logfile &&
|
|
curl_dbg_logfile != stderr &&
|
|
curl_dbg_logfile != stdout) {
|
|
/* !checksrc! disable BANNEDFUNC 1 */
|
|
fclose(curl_dbg_logfile);
|
|
}
|
|
curl_dbg_logfile = NULL;
|
|
}
|
|
|
|
/* this sets the log filename */
|
|
void curl_dbg_memdebug(const char *logname)
|
|
{
|
|
if(!curl_dbg_logfile) {
|
|
if(logname && *logname)
|
|
curl_dbg_logfile = CURLX_FOPEN_LOW(logname, FOPEN_WRITETEXT);
|
|
else
|
|
curl_dbg_logfile = stderr;
|
|
#ifdef MEMDEBUG_LOG_SYNC
|
|
/* Flush the log file after every line so the log is not lost in a crash */
|
|
if(curl_dbg_logfile)
|
|
setbuf(curl_dbg_logfile, (char *)NULL);
|
|
#endif
|
|
}
|
|
if(!registered_cleanup)
|
|
registered_cleanup = !atexit(curl_dbg_cleanup);
|
|
}
|
|
|
|
/* 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 is not 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) {
|
|
/* log to file */
|
|
curl_dbg_log("LIMIT %s:%d %s reached memlimit\n", source, line, func);
|
|
/* log to stderr also */
|
|
curl_mfprintf(stderr, "LIMIT %s:%d %s reached memlimit\n",
|
|
source, line, func);
|
|
fflush(curl_dbg_logfile); /* because it might crash now */
|
|
/* !checksrc! disable ERRNOVAR 1 */
|
|
errno = ENOMEM;
|
|
return TRUE; /* RETURN ERROR! */
|
|
}
|
|
else
|
|
memsize--; /* countdown */
|
|
}
|
|
|
|
return FALSE; /* allow this */
|
|
}
|
|
|
|
ALLOC_FUNC
|
|
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)) {
|
|
curl_dbg_log("FAIL %s:%d malloc(%zu) = NULL\n",
|
|
source, line, wantedsize);
|
|
return NULL;
|
|
}
|
|
|
|
/* alloc at least 64 bytes */
|
|
size = sizeof(struct memdebug) + wantedsize;
|
|
|
|
mem = (Curl_cmalloc)(size);
|
|
if(mem) {
|
|
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;
|
|
}
|
|
|
|
ALLOC_FUNC
|
|
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)) {
|
|
curl_dbg_log("FAIL %s:%d calloc(%zu,%zu) = NULL\n",
|
|
source, line, wanted_elements, wanted_size);
|
|
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;
|
|
}
|
|
|
|
ALLOC_FUNC
|
|
char *curl_dbg_strdup(const char *str, int line, const char *source)
|
|
{
|
|
char *mem;
|
|
size_t len;
|
|
|
|
DEBUGASSERT(str != NULL);
|
|
|
|
len = strlen(str) + 1;
|
|
|
|
if(countcheck("strdup", line, source)) {
|
|
curl_dbg_log("FAIL %s:%d strdup(%zu bytes) = NULL\n", source, line,
|
|
len);
|
|
return NULL;
|
|
}
|
|
|
|
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)
|
|
ALLOC_FUNC
|
|
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)) {
|
|
curl_dbg_log("FAIL %s:%d wcdup() = NULL\n", source, line);
|
|
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, (const 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)) {
|
|
curl_dbg_log("FAIL %s:%d realloc(%zu) = NULL\n",
|
|
source, line, wantedsize);
|
|
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
|
|
|
|
/* 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)
|
|
{
|
|
curl_socket_t sockfd;
|
|
|
|
if(countcheck("socket", line, source)) {
|
|
curl_dbg_log("FAIL %s:%d socket() = [bad]\n",
|
|
source, line);
|
|
return CURL_SOCKET_BAD;
|
|
}
|
|
|
|
/* !checksrc! disable BANNEDFUNC 1 */
|
|
sockfd = socket(domain, type, protocol);
|
|
|
|
if(source && (sockfd != CURL_SOCKET_BAD))
|
|
curl_dbg_log("FD %s:%d socket() = %" FMT_SOCKET_T "\n",
|
|
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)) {
|
|
curl_dbg_log("FAIL %s:%d send() = -1\n", source, line);
|
|
return -1;
|
|
}
|
|
/* !checksrc! disable BANNEDFUNC 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)) {
|
|
curl_dbg_log("FAIL %s:%d recv() = -1\n", source, line);
|
|
return -1;
|
|
}
|
|
/* !checksrc! disable BANNEDFUNC 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)
|
|
{
|
|
/* !checksrc! disable BANNEDFUNC 1 */
|
|
int res = socketpair(domain, type, protocol, socket_vector);
|
|
|
|
if(source && (res == 0))
|
|
curl_dbg_log("FD %s:%d socketpair() = "
|
|
"%" FMT_SOCKET_T " %" FMT_SOCKET_T "\n",
|
|
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)
|
|
{
|
|
struct sockaddr *addr = (struct sockaddr *)saddr;
|
|
curl_socklen_t *addrlen = (curl_socklen_t *)saddrlen;
|
|
|
|
/* !checksrc! disable BANNEDFUNC 1 */
|
|
curl_socket_t sockfd = accept(s, addr, addrlen);
|
|
|
|
if(source && (sockfd != CURL_SOCKET_BAD))
|
|
curl_dbg_log("FD %s:%d accept() = %" FMT_SOCKET_T "\n",
|
|
source, line, sockfd);
|
|
|
|
return sockfd;
|
|
}
|
|
|
|
#ifdef HAVE_ACCEPT4
|
|
curl_socket_t curl_dbg_accept4(curl_socket_t s, void *saddr, void *saddrlen,
|
|
int flags,
|
|
int line, const char *source)
|
|
{
|
|
struct sockaddr *addr = (struct sockaddr *)saddr;
|
|
curl_socklen_t *addrlen = (curl_socklen_t *)saddrlen;
|
|
|
|
/* !checksrc! disable BANNEDFUNC 1 */
|
|
curl_socket_t sockfd = accept4(s, addr, addrlen, flags);
|
|
|
|
if(source && (sockfd != CURL_SOCKET_BAD))
|
|
curl_dbg_log("FD %s:%d accept() = %" FMT_SOCKET_T "\n",
|
|
source, line, sockfd);
|
|
|
|
return sockfd;
|
|
}
|
|
#endif
|
|
|
|
/* separate function to allow libcurl to mark a "faked" close */
|
|
void curl_dbg_mark_sclose(curl_socket_t sockfd, int line, const char *source)
|
|
{
|
|
if(source)
|
|
curl_dbg_log("FD %s:%d sclose(%" FMT_SOCKET_T ")\n",
|
|
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 = CURL_SCLOSE(sockfd);
|
|
curl_dbg_mark_sclose(sockfd, line, source);
|
|
return res;
|
|
}
|
|
|
|
ALLOC_FUNC
|
|
FILE *curl_dbg_fopen(const char *file, const char *mode,
|
|
int line, const char *source)
|
|
{
|
|
FILE *res = CURLX_FOPEN_LOW(file, mode);
|
|
if(source)
|
|
curl_dbg_log("FILE %s:%d fopen(\"%s\",\"%s\") = %p\n",
|
|
source, line, file, mode, (void *)res);
|
|
|
|
return res;
|
|
}
|
|
|
|
ALLOC_FUNC
|
|
FILE *curl_dbg_freopen(const char *file, const char *mode, FILE *fh,
|
|
int line, const char *source)
|
|
{
|
|
FILE *res = CURLX_FREOPEN_LOW(file, mode, fh);
|
|
if(source)
|
|
curl_dbg_log("FILE %s:%d freopen(\"%s\",\"%s\",%p) = %p\n",
|
|
source, line, file, mode, (void *)fh, (void *)res);
|
|
|
|
return res;
|
|
}
|
|
|
|
ALLOC_FUNC
|
|
FILE *curl_dbg_fdopen(int filedes, const char *mode,
|
|
int line, const char *source)
|
|
{
|
|
/* !checksrc! disable BANNEDFUNC 1 */
|
|
FILE *res = fdopen(filedes, mode);
|
|
if(source)
|
|
curl_dbg_log("FILE %s:%d fdopen(\"%d\",\"%s\") = %p\n",
|
|
source, line, filedes, 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);
|
|
|
|
/* !checksrc! disable BANNEDFUNC 1 */
|
|
res = fclose(file);
|
|
|
|
return res;
|
|
}
|
|
|
|
/* this does the writing to the memory tracking log file */
|
|
void curl_dbg_log(const char *format, ...)
|
|
{
|
|
char buf[1024];
|
|
int nchars;
|
|
va_list ap;
|
|
|
|
if(!curl_dbg_logfile)
|
|
return;
|
|
|
|
va_start(ap, format);
|
|
nchars = curl_mvsnprintf(buf, sizeof(buf), format, ap);
|
|
va_end(ap);
|
|
|
|
if(nchars > (int)sizeof(buf) - 1)
|
|
nchars = (int)sizeof(buf) - 1;
|
|
|
|
if(nchars > 0)
|
|
(fwrite)(buf, 1, (size_t)nchars, curl_dbg_logfile);
|
|
}
|
|
|
|
void curl_dbg_allow(int line, const char *source, int index)
|
|
{
|
|
curl_dbg_log("OVERLOOK %s:%d\n", source, line + index);
|
|
}
|
|
|
|
void curl_dbg_clear(int line, const char *source)
|
|
{
|
|
curl_dbg_log("RESTART %s:%d\n", source, line);
|
|
}
|
|
|
|
|
|
#endif /* CURLDEBUG */
|