| 1 |
<!DOCTYPE html> |
| 2 |
<html><head> |
| 3 |
<meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 4 |
<meta http-equiv="content-type" content="text/html; charset=UTF-8"> |
| 5 |
<link href="../sqlite.css" rel="stylesheet"> |
| 6 |
<title>Memory Allocation Subsystem</title> |
| 7 |
<!-- path=../ --> |
| 8 |
</head> |
| 9 |
<body> |
| 10 |
<div class=nosearch> |
| 11 |
<a href="../index.html"> |
| 12 |
<img class="logo" src="../images/sqlite370_banner.svg" alt="SQLite" border="0"> |
| 13 |
</a> |
| 14 |
<div><!-- IE hack to prevent disappearing logo --></div> |
| 15 |
<div class="tagline desktoponly"> |
| 16 |
Small. Fast. Reliable.<br>Choose any three. |
| 17 |
</div> |
| 18 |
<div class="menu mainmenu"> |
| 19 |
<ul> |
| 20 |
<li><a href="../index.html">Home</a> |
| 21 |
<li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a> |
| 22 |
<li class='wideonly'><a href='../about.html'>About</a> |
| 23 |
<li class='desktoponly'><a href="../docs.html">Documentation</a> |
| 24 |
<li class='desktoponly'><a href="../download.html">Download</a> |
| 25 |
<li class='wideonly'><a href='../copyright.html'>License</a> |
| 26 |
<li class='desktoponly'><a href="../support.html">Support</a> |
| 27 |
<li class='desktoponly'><a href="../prosupport.html">Purchase</a> |
| 28 |
<li class='search' id='search_menubutton'> |
| 29 |
<a href="javascript:void(0)" onclick='toggle_search()'>Search</a> |
| 30 |
</ul> |
| 31 |
</div> |
| 32 |
<div class="menu submenu" id="submenu"> |
| 33 |
<ul> |
| 34 |
<li><a href='../about.html'>About</a> |
| 35 |
<li><a href='../docs.html'>Documentation</a> |
| 36 |
<li><a href='../download.html'>Download</a> |
| 37 |
<li><a href='../support.html'>Support</a> |
| 38 |
<li><a href='../prosupport.html'>Purchase</a> |
| 39 |
</ul> |
| 40 |
</div> |
| 41 |
<div class="searchmenu" id="searchmenu"> |
| 42 |
<form method="GET" action="../search"> |
| 43 |
<select name="s" id="searchtype"> |
| 44 |
<option value="d">Search Documentation</option> |
| 45 |
<option value="c">Search Changelog</option> |
| 46 |
</select> |
| 47 |
<input type="text" name="q" id="searchbox" value=""> |
| 48 |
<input type="submit" value="Go"> |
| 49 |
</form> |
| 50 |
</div> |
| 51 |
</div> |
| 52 |
<script> |
| 53 |
function toggle_div(nm) { |
| 54 |
var w = document.getElementById(nm); |
| 55 |
if( w.style.display=="block" ){ |
| 56 |
w.style.display = "none"; |
| 57 |
}else{ |
| 58 |
w.style.display = "block"; |
| 59 |
} |
| 60 |
} |
| 61 |
function toggle_search() { |
| 62 |
var w = document.getElementById("searchmenu"); |
| 63 |
if( w.style.display=="block" ){ |
| 64 |
w.style.display = "none"; |
| 65 |
} else { |
| 66 |
w.style.display = "block"; |
| 67 |
setTimeout(function(){ |
| 68 |
document.getElementById("searchbox").focus() |
| 69 |
}, 30); |
| 70 |
} |
| 71 |
} |
| 72 |
function div_off(nm){document.getElementById(nm).style.display="none";} |
| 73 |
window.onbeforeunload = function(e){div_off("submenu");} |
| 74 |
/* Disable the Search feature if we are not operating from CGI, since */ |
| 75 |
/* Search is accomplished using CGI and will not work without it. */ |
| 76 |
if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){ |
| 77 |
document.getElementById("search_menubutton").style.display = "none"; |
| 78 |
} |
| 79 |
/* Used by the Hide/Show button beside syntax diagrams, to toggle the */ |
| 80 |
function hideorshow(btn,obj){ |
| 81 |
var x = document.getElementById(obj); |
| 82 |
var b = document.getElementById(btn); |
| 83 |
if( x.style.display!='none' ){ |
| 84 |
x.style.display = 'none'; |
| 85 |
b.innerHTML='show'; |
| 86 |
}else{ |
| 87 |
x.style.display = ''; |
| 88 |
b.innerHTML='hide'; |
| 89 |
} |
| 90 |
return false; |
| 91 |
} |
| 92 |
var antiRobot = 0; |
| 93 |
function antiRobotGo(){ |
| 94 |
if( antiRobot!=3 ) return; |
| 95 |
antiRobot = 7; |
| 96 |
var j = document.getElementById("mtimelink"); |
| 97 |
if(j && j.hasAttribute("data-href")) j.href=j.getAttribute("data-href"); |
| 98 |
} |
| 99 |
function antiRobotDefense(){ |
| 100 |
document.body.onmousedown=function(){ |
| 101 |
antiRobot |= 2; |
| 102 |
antiRobotGo(); |
| 103 |
document.body.onmousedown=null; |
| 104 |
} |
| 105 |
document.body.onmousemove=function(){ |
| 106 |
antiRobot |= 2; |
| 107 |
antiRobotGo(); |
| 108 |
document.body.onmousemove=null; |
| 109 |
} |
| 110 |
setTimeout(function(){ |
| 111 |
antiRobot |= 1; |
| 112 |
antiRobotGo(); |
| 113 |
}, 100) |
| 114 |
antiRobotGo(); |
| 115 |
} |
| 116 |
antiRobotDefense(); |
| 117 |
</script> |
| 118 |
<!-- keywords: sqlite3_free sqlite3_malloc sqlite3_malloc64 sqlite3_msize sqlite3_realloc sqlite3_realloc64 --> |
| 119 |
<div class=nosearch> |
| 120 |
<a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a> |
| 121 |
<h2>Memory Allocation Subsystem</h2> |
| 122 |
</div> |
| 123 |
<blockquote><pre> |
| 124 |
void *sqlite3_malloc(int); |
| 125 |
void *sqlite3_malloc64(sqlite3_uint64); |
| 126 |
void *sqlite3_realloc(void*, int); |
| 127 |
void *sqlite3_realloc64(void*, sqlite3_uint64); |
| 128 |
void sqlite3_free(void*); |
| 129 |
sqlite3_uint64 sqlite3_msize(void*); |
| 130 |
</pre></blockquote> |
| 131 |
<p> |
| 132 |
The SQLite core uses these three routines for all of its own |
| 133 |
internal memory allocation needs. "Core" in the previous sentence |
| 134 |
does not include operating-system specific <a href="../vfs.html">VFS</a> implementation. The |
| 135 |
Windows VFS uses native malloc() and free() for some operations.</p> |
| 136 |
|
| 137 |
<p>The sqlite3_malloc() routine returns a pointer to a block |
| 138 |
of memory at least N bytes in length, where N is the parameter. |
| 139 |
If sqlite3_malloc() is unable to obtain sufficient free |
| 140 |
memory, it returns a NULL pointer. If the parameter N to |
| 141 |
sqlite3_malloc() is zero or negative then sqlite3_malloc() returns |
| 142 |
a NULL pointer.</p> |
| 143 |
|
| 144 |
<p>The sqlite3_malloc64(N) routine works just like |
| 145 |
sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead |
| 146 |
of a signed 32-bit integer.</p> |
| 147 |
|
| 148 |
<p>Calling sqlite3_free() with a pointer previously returned |
| 149 |
by sqlite3_malloc() or sqlite3_realloc() releases that memory so |
| 150 |
that it might be reused. The sqlite3_free() routine is |
| 151 |
a no-op if it is called with a NULL pointer. Passing a NULL pointer |
| 152 |
to sqlite3_free() is harmless. After being freed, memory |
| 153 |
should neither be read nor written. Even reading previously freed |
| 154 |
memory might result in a segmentation fault or other severe error. |
| 155 |
Memory corruption, a segmentation fault, or other severe error |
| 156 |
might result if sqlite3_free() is called with a non-NULL pointer that |
| 157 |
was not obtained from sqlite3_malloc() or sqlite3_realloc().</p> |
| 158 |
|
| 159 |
<p>The sqlite3_realloc(X,N) interface attempts to resize a |
| 160 |
prior memory allocation X to be at least N bytes. |
| 161 |
If the X parameter to sqlite3_realloc(X,N) |
| 162 |
is a NULL pointer then its behavior is identical to calling |
| 163 |
sqlite3_malloc(N). |
| 164 |
If the N parameter to sqlite3_realloc(X,N) is zero or |
| 165 |
negative then the behavior is exactly the same as calling |
| 166 |
sqlite3_free(X). |
| 167 |
sqlite3_realloc(X,N) returns a pointer to a memory allocation |
| 168 |
of at least N bytes in size or NULL if insufficient memory is available. |
| 169 |
If M is the size of the prior allocation, then min(N,M) bytes of the |
| 170 |
prior allocation are copied into the beginning of the buffer returned |
| 171 |
by sqlite3_realloc(X,N) and the prior allocation is freed. |
| 172 |
If sqlite3_realloc(X,N) returns NULL and N is positive, then the |
| 173 |
prior allocation is not freed.</p> |
| 174 |
|
| 175 |
<p>The sqlite3_realloc64(X,N) interface works the same as |
| 176 |
sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead |
| 177 |
of a 32-bit signed integer.</p> |
| 178 |
|
| 179 |
<p>If X is a memory allocation previously obtained from sqlite3_malloc(), |
| 180 |
sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then |
| 181 |
sqlite3_msize(X) returns the size of that memory allocation in bytes. |
| 182 |
The value returned by sqlite3_msize(X) might be larger than the number |
| 183 |
of bytes requested when X was allocated. If X is a NULL pointer then |
| 184 |
sqlite3_msize(X) returns zero. If X points to something that is not |
| 185 |
the beginning of memory allocation, or if it points to a formerly |
| 186 |
valid memory allocation that has now been freed, then the behavior |
| 187 |
of sqlite3_msize(X) is undefined and possibly harmful.</p> |
| 188 |
|
| 189 |
<p>The memory returned by sqlite3_malloc(), sqlite3_realloc(), |
| 190 |
sqlite3_malloc64(), and sqlite3_realloc64() |
| 191 |
is always aligned to at least an 8 byte boundary, or to a |
| 192 |
4 byte boundary if the <a href="../compile.html#4_byte_aligned_malloc">SQLITE_4_BYTE_ALIGNED_MALLOC</a> compile-time |
| 193 |
option is used.</p> |
| 194 |
|
| 195 |
<p>The pointer arguments to <a href="../c3ref/free.html">sqlite3_free()</a> and <a href="../c3ref/free.html">sqlite3_realloc()</a> |
| 196 |
must be either NULL or else pointers obtained from a prior |
| 197 |
invocation of <a href="../c3ref/free.html">sqlite3_malloc()</a> or <a href="../c3ref/free.html">sqlite3_realloc()</a> that have |
| 198 |
not yet been released.</p> |
| 199 |
|
| 200 |
<p>The application must not read or write any part of |
| 201 |
a block of memory after it has been released using |
| 202 |
<a href="../c3ref/free.html">sqlite3_free()</a> or <a href="../c3ref/free.html">sqlite3_realloc()</a>. |
| 203 |
</p><p>See also lists of |
| 204 |
<a href="../c3ref/objlist.html">Objects</a>, |
| 205 |
<a href="../c3ref/constlist.html">Constants</a>, and |
| 206 |
<a href="../c3ref/funclist.html">Functions</a>.</p> |
| 207 |
|