Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 1 | #ifndef HEADER_CURL_MEMDEBUG_H |
| 2 | #define HEADER_CURL_MEMDEBUG_H |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 3 | #ifdef CURLDEBUG |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 4 | /*************************************************************************** |
| 5 | * _ _ ____ _ |
| 6 | * Project ___| | | | _ \| | |
| 7 | * / __| | | | |_) | | |
| 8 | * | (__| |_| | _ <| |___ |
| 9 | * \___|\___/|_| \_\_____| |
| 10 | * |
Alex Deymo | 486467e | 2017-12-19 19:04:07 +0100 | [diff] [blame] | 11 | * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 12 | * |
| 13 | * This software is licensed as described in the file COPYING, which |
| 14 | * you should have received as part of this distribution. The terms |
Alex Deymo | 8f1a214 | 2016-06-28 14:49:26 -0700 | [diff] [blame] | 15 | * are also available at https://curl.haxx.se/docs/copyright.html. |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 16 | * |
| 17 | * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 18 | * copies of the Software, and permit persons to whom the Software is |
| 19 | * furnished to do so, under the terms of the COPYING file. |
| 20 | * |
| 21 | * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 22 | * KIND, either express or implied. |
| 23 | * |
| 24 | ***************************************************************************/ |
| 25 | |
| 26 | /* |
| 27 | * CAUTION: this header is designed to work when included by the app-side |
| 28 | * as well as the library. Do not mix with library internals! |
| 29 | */ |
| 30 | |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 31 | #define CURL_MT_LOGFNAME_BUFSIZE 512 |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 32 | |
| 33 | #define logfile curl_debuglogfile |
| 34 | |
| 35 | extern FILE *logfile; |
| 36 | |
| 37 | /* memory functions */ |
| 38 | CURL_EXTERN void *curl_domalloc(size_t size, int line, const char *source); |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 39 | CURL_EXTERN void *curl_docalloc(size_t elements, size_t size, int line, |
| 40 | const char *source); |
| 41 | CURL_EXTERN void *curl_dorealloc(void *ptr, size_t size, int line, |
| 42 | const char *source); |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 43 | CURL_EXTERN void curl_dofree(void *ptr, int line, const char *source); |
| 44 | CURL_EXTERN char *curl_dostrdup(const char *str, int line, const char *source); |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 45 | #if defined(WIN32) && defined(UNICODE) |
| 46 | CURL_EXTERN wchar_t *curl_dowcsdup(const wchar_t *str, int line, |
| 47 | const char *source); |
| 48 | #endif |
| 49 | |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 50 | CURL_EXTERN void curl_memdebug(const char *logname); |
| 51 | CURL_EXTERN void curl_memlimit(long limit); |
| 52 | CURL_EXTERN void curl_memlog(const char *format, ...); |
| 53 | |
| 54 | /* file descriptor manipulators */ |
| 55 | CURL_EXTERN curl_socket_t curl_socket(int domain, int type, int protocol, |
Alex Deymo | 8f1a214 | 2016-06-28 14:49:26 -0700 | [diff] [blame] | 56 | int line, const char *source); |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 57 | CURL_EXTERN void curl_mark_sclose(curl_socket_t sockfd, |
Alex Deymo | 8f1a214 | 2016-06-28 14:49:26 -0700 | [diff] [blame] | 58 | int line, const char *source); |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 59 | CURL_EXTERN int curl_sclose(curl_socket_t sockfd, |
Alex Deymo | 8f1a214 | 2016-06-28 14:49:26 -0700 | [diff] [blame] | 60 | int line, const char *source); |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 61 | CURL_EXTERN curl_socket_t curl_accept(curl_socket_t s, void *a, void *alen, |
| 62 | int line, const char *source); |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 63 | #ifdef HAVE_SOCKETPAIR |
| 64 | CURL_EXTERN int curl_socketpair(int domain, int type, int protocol, |
| 65 | curl_socket_t socket_vector[2], |
Alex Deymo | 8f1a214 | 2016-06-28 14:49:26 -0700 | [diff] [blame] | 66 | int line, const char *source); |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 67 | #endif |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 68 | |
Alex Deymo | 486467e | 2017-12-19 19:04:07 +0100 | [diff] [blame] | 69 | /* send/receive sockets */ |
| 70 | CURL_EXTERN SEND_TYPE_RETV curl_dosend(SEND_TYPE_ARG1 sockfd, |
| 71 | SEND_QUAL_ARG2 SEND_TYPE_ARG2 buf, |
| 72 | SEND_TYPE_ARG3 len, |
| 73 | SEND_TYPE_ARG4 flags, int line, |
| 74 | const char *source); |
| 75 | CURL_EXTERN RECV_TYPE_RETV curl_dorecv(RECV_TYPE_ARG1 sockfd, |
| 76 | RECV_TYPE_ARG2 buf, RECV_TYPE_ARG3 len, |
| 77 | RECV_TYPE_ARG4 flags, int line, |
| 78 | const char *source); |
| 79 | |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 80 | /* FILE functions */ |
| 81 | CURL_EXTERN FILE *curl_fopen(const char *file, const char *mode, int line, |
| 82 | const char *source); |
| 83 | #ifdef HAVE_FDOPEN |
| 84 | CURL_EXTERN FILE *curl_fdopen(int filedes, const char *mode, int line, |
| 85 | const char *source); |
| 86 | #endif |
| 87 | CURL_EXTERN int curl_fclose(FILE *file, int line, const char *source); |
| 88 | |
| 89 | #ifndef MEMDEBUG_NODEFINES |
| 90 | |
| 91 | /* Set this symbol on the command-line, recompile all lib-sources */ |
| 92 | #undef strdup |
| 93 | #define strdup(ptr) curl_dostrdup(ptr, __LINE__, __FILE__) |
| 94 | #define malloc(size) curl_domalloc(size, __LINE__, __FILE__) |
| 95 | #define calloc(nbelem,size) curl_docalloc(nbelem, size, __LINE__, __FILE__) |
| 96 | #define realloc(ptr,size) curl_dorealloc(ptr, size, __LINE__, __FILE__) |
| 97 | #define free(ptr) curl_dofree(ptr, __LINE__, __FILE__) |
Alex Deymo | 486467e | 2017-12-19 19:04:07 +0100 | [diff] [blame] | 98 | #define send(a,b,c,d) curl_dosend(a,b,c,d, __LINE__, __FILE__) |
| 99 | #define recv(a,b,c,d) curl_dorecv(a,b,c,d, __LINE__, __FILE__) |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 100 | |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 101 | #ifdef WIN32 |
| 102 | # ifdef UNICODE |
| 103 | # undef wcsdup |
| 104 | # define wcsdup(ptr) curl_dowcsdup(ptr, __LINE__, __FILE__) |
| 105 | # undef _wcsdup |
| 106 | # define _wcsdup(ptr) curl_dowcsdup(ptr, __LINE__, __FILE__) |
| 107 | # undef _tcsdup |
| 108 | # define _tcsdup(ptr) curl_dowcsdup(ptr, __LINE__, __FILE__) |
| 109 | # else |
| 110 | # undef _tcsdup |
| 111 | # define _tcsdup(ptr) curl_dostrdup(ptr, __LINE__, __FILE__) |
| 112 | # endif |
| 113 | #endif |
| 114 | |
Alex Deymo | 8f1a214 | 2016-06-28 14:49:26 -0700 | [diff] [blame] | 115 | #undef socket |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 116 | #define socket(domain,type,protocol)\ |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 117 | curl_socket(domain, type, protocol, __LINE__, __FILE__) |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 118 | #undef accept /* for those with accept as a macro */ |
| 119 | #define accept(sock,addr,len)\ |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 120 | curl_accept(sock, addr, len, __LINE__, __FILE__) |
| 121 | #ifdef HAVE_SOCKETPAIR |
| 122 | #define socketpair(domain,type,protocol,socket_vector)\ |
| 123 | curl_socketpair(domain, type, protocol, socket_vector, __LINE__, __FILE__) |
| 124 | #endif |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 125 | |
| 126 | #ifdef HAVE_GETADDRINFO |
| 127 | #if defined(getaddrinfo) && defined(__osf__) |
| 128 | /* OSF/1 and Tru64 have getaddrinfo as a define already, so we cannot define |
| 129 | our macro as for other platforms. Instead, we redefine the new name they |
| 130 | define getaddrinfo to become! */ |
| 131 | #define ogetaddrinfo(host,serv,hint,res) \ |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 132 | curl_dogetaddrinfo(host, serv, hint, res, __LINE__, __FILE__) |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 133 | #else |
| 134 | #undef getaddrinfo |
| 135 | #define getaddrinfo(host,serv,hint,res) \ |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 136 | curl_dogetaddrinfo(host, serv, hint, res, __LINE__, __FILE__) |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 137 | #endif |
| 138 | #endif /* HAVE_GETADDRINFO */ |
| 139 | |
| 140 | #ifdef HAVE_GETNAMEINFO |
| 141 | #undef getnameinfo |
| 142 | #define getnameinfo(sa,salen,host,hostlen,serv,servlen,flags) \ |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 143 | curl_dogetnameinfo(sa, salen, host, hostlen, serv, servlen, flags, \ |
| 144 | __LINE__, __FILE__) |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 145 | #endif /* HAVE_GETNAMEINFO */ |
| 146 | |
| 147 | #ifdef HAVE_FREEADDRINFO |
| 148 | #undef freeaddrinfo |
| 149 | #define freeaddrinfo(data) \ |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 150 | curl_dofreeaddrinfo(data, __LINE__, __FILE__) |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 151 | #endif /* HAVE_FREEADDRINFO */ |
| 152 | |
| 153 | /* sclose is probably already defined, redefine it! */ |
| 154 | #undef sclose |
| 155 | #define sclose(sockfd) curl_sclose(sockfd,__LINE__,__FILE__) |
| 156 | |
| 157 | #define fake_sclose(sockfd) curl_mark_sclose(sockfd,__LINE__,__FILE__) |
| 158 | |
| 159 | #undef fopen |
| 160 | #define fopen(file,mode) curl_fopen(file,mode,__LINE__,__FILE__) |
| 161 | #undef fdopen |
| 162 | #define fdopen(file,mode) curl_fdopen(file,mode,__LINE__,__FILE__) |
| 163 | #define fclose(file) curl_fclose(file,__LINE__,__FILE__) |
| 164 | |
| 165 | #endif /* MEMDEBUG_NODEFINES */ |
| 166 | |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 167 | #endif /* CURLDEBUG */ |
| 168 | |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 169 | /* |
| 170 | ** Following section applies even when CURLDEBUG is not defined. |
| 171 | */ |
| 172 | |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 173 | #ifndef fake_sclose |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 174 | #define fake_sclose(x) Curl_nop_stmt |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 175 | #endif |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 176 | |
| 177 | /* |
| 178 | * Curl_safefree defined as a macro to allow MemoryTracking feature |
| 179 | * to log free() calls at same location where Curl_safefree is used. |
| 180 | * This macro also assigns NULL to given pointer when free'd. |
| 181 | */ |
| 182 | |
| 183 | #define Curl_safefree(ptr) \ |
| 184 | do { free((ptr)); (ptr) = NULL;} WHILE_FALSE |
| 185 | |
| 186 | #endif /* HEADER_CURL_MEMDEBUG_H */ |