23
23
***************************************************************************/
25
#include <curl/curl.h> /* for the typedefs */
26
* Nasty internal details ahead...
28
* File curl_memory.h must be included by _all_ *.c source files
29
* that use memory related functions strdup, malloc, calloc, realloc
30
* or free, and given source file is used to build libcurl library.
32
* There is nearly no exception to above rule. All libcurl source
33
* files in 'lib' subdirectory as well as those living deep inside
34
* 'packages' subdirectories and linked together in order to build
35
* libcurl library shall follow it.
37
* File lib/strdup.c is an exception, given that it provides a strdup
38
* clone implementation while using malloc. Extra care needed inside
39
* this one. TODO: revisit this paragraph and related code.
41
* The need for curl_memory.h inclusion is due to libcurl's feature
42
* of allowing library user to provide memory replacement functions,
43
* memory callbacks, at runtime with curl_global_init_mem()
45
* Any *.c source file used to build libcurl library that does not
46
* include curl_memory.h and uses any memory function of the five
47
* mentioned above will compile without any indication, but it will
48
* trigger weird memory related issues at runtime.
50
* OTOH some source files from 'lib' subdirectory may additionally be
51
* used directly as source code when using some curlx_ functions by
52
* third party programs that don't even use libcurl at all. When using
53
* these source files in this way it is necessary these are compiled
54
* with CURLX_NO_MEMORY_CALLBACKS defined, in order to ensure that no
55
* attempt of calling libcurl's memory callbacks is done from code
56
* which can not use this machinery.
58
* Notice that libcurl's 'memory tracking' system works chaining into
59
* the memory callback machinery. This implies that when compiling
60
* 'lib' source files with CURLX_NO_MEMORY_CALLBACKS defined this file
61
* disengages usage of libcurl's 'memory tracking' system, defining
62
* MEMDEBUG_NODEFINES and overriding CURLDEBUG purpose.
64
* CURLX_NO_MEMORY_CALLBACKS takes precedence over CURLDEBUG. This is
65
* done in order to allow building a 'memory tracking' enabled libcurl
66
* and at the same time allow building programs which do not use it.
68
* Programs and libraries in 'tests' subdirectories have specific
69
* purposes and needs, and as such each one will use whatever fits
70
* best, depending additionally wether it links with libcurl or not.
72
* Caveat emptor. Proper curlx_* separation is a work in progress
73
* the same as CURLX_NO_MEMORY_CALLBACKS usage, some adjustments may
74
* still be required. IOW don't use them yet, there are sharp edges.
77
#ifdef HEADER_CURL_MEMDEBUG_H
78
#error "Header memdebug.h shall not be included before curl_memory.h"
81
#ifndef CURLX_NO_MEMORY_CALLBACKS
83
#include <curl/curl.h> /* for the callback typedefs */
27
85
extern curl_malloc_callback Curl_cmalloc;
28
86
extern curl_free_callback Curl_cfree;
29
87
extern curl_realloc_callback Curl_crealloc;
30
88
extern curl_strdup_callback Curl_cstrdup;
31
89
extern curl_calloc_callback Curl_ccalloc;
91
extern curl_wcsdup_callback Curl_cwcsdup;
34
/* Only do this define-mania if we're not using the memdebug system, as that
35
has preference on this magic. */
97
* libcurl's 'memory tracking' system defines strdup, malloc, calloc,
98
* realloc and free, along with others, in memdebug.h in a different
99
* way although still using memory callbacks forward declared above.
100
* When using the 'memory tracking' system (CURLDEBUG defined) we do
101
* not define here the five memory functions given that definitions
102
* from memdebug.h are the ones that shall be used.
37
106
#define strdup(ptr) Curl_cstrdup(ptr)
added
removed
lib/curl_memory.h
