summaryrefslogtreecommitdiffstats
path: root/www/c3ref/free.html
diff options
context:
space:
mode:
Diffstat (limited to 'www/c3ref/free.html')
-rw-r--r--www/c3ref/free.html207
1 files changed, 207 insertions, 0 deletions
diff --git a/www/c3ref/free.html b/www/c3ref/free.html
new file mode 100644
index 0000000..7d4e147
--- /dev/null
+++ b/www/c3ref/free.html
@@ -0,0 +1,207 @@
+<!DOCTYPE html>
+<html><head>
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta http-equiv="content-type" content="text/html; charset=UTF-8">
+<link href="../sqlite.css" rel="stylesheet">
+<title>Memory Allocation Subsystem</title>
+<!-- path=../ -->
+</head>
+<body>
+<div class=nosearch>
+<a href="../index.html">
+<img class="logo" src="../images/sqlite370_banner.gif" alt="SQLite" border="0">
+</a>
+<div><!-- IE hack to prevent disappearing logo --></div>
+<div class="tagline desktoponly">
+Small. Fast. Reliable.<br>Choose any three.
+</div>
+<div class="menu mainmenu">
+<ul>
+<li><a href="../index.html">Home</a>
+<li class='mobileonly'><a href="javascript:void(0)" onclick='toggle_div("submenu")'>Menu</a>
+<li class='wideonly'><a href='../about.html'>About</a>
+<li class='desktoponly'><a href="../docs.html">Documentation</a>
+<li class='desktoponly'><a href="../download.html">Download</a>
+<li class='wideonly'><a href='../copyright.html'>License</a>
+<li class='desktoponly'><a href="../support.html">Support</a>
+<li class='desktoponly'><a href="../prosupport.html">Purchase</a>
+<li class='search' id='search_menubutton'>
+<a href="javascript:void(0)" onclick='toggle_search()'>Search</a>
+</ul>
+</div>
+<div class="menu submenu" id="submenu">
+<ul>
+<li><a href='../about.html'>About</a>
+<li><a href='../docs.html'>Documentation</a>
+<li><a href='../download.html'>Download</a>
+<li><a href='../support.html'>Support</a>
+<li><a href='../prosupport.html'>Purchase</a>
+</ul>
+</div>
+<div class="searchmenu" id="searchmenu">
+<form method="GET" action="../search">
+<select name="s" id="searchtype">
+<option value="d">Search Documentation</option>
+<option value="c">Search Changelog</option>
+</select>
+<input type="text" name="q" id="searchbox" value="">
+<input type="submit" value="Go">
+</form>
+</div>
+</div>
+<script>
+function toggle_div(nm) {
+var w = document.getElementById(nm);
+if( w.style.display=="block" ){
+w.style.display = "none";
+}else{
+w.style.display = "block";
+}
+}
+function toggle_search() {
+var w = document.getElementById("searchmenu");
+if( w.style.display=="block" ){
+w.style.display = "none";
+} else {
+w.style.display = "block";
+setTimeout(function(){
+document.getElementById("searchbox").focus()
+}, 30);
+}
+}
+function div_off(nm){document.getElementById(nm).style.display="none";}
+window.onbeforeunload = function(e){div_off("submenu");}
+/* Disable the Search feature if we are not operating from CGI, since */
+/* Search is accomplished using CGI and will not work without it. */
+if( !location.origin || !location.origin.match || !location.origin.match(/http/) ){
+document.getElementById("search_menubutton").style.display = "none";
+}
+/* Used by the Hide/Show button beside syntax diagrams, to toggle the */
+function hideorshow(btn,obj){
+var x = document.getElementById(obj);
+var b = document.getElementById(btn);
+if( x.style.display!='none' ){
+x.style.display = 'none';
+b.innerHTML='show';
+}else{
+x.style.display = '';
+b.innerHTML='hide';
+}
+return false;
+}
+var antiRobot = 0;
+function antiRobotGo(){
+if( antiRobot!=3 ) return;
+antiRobot = 7;
+var j = document.getElementById("mtimelink");
+if(j && j.hasAttribute("data-href")) j.href=j.getAttribute("data-href");
+}
+function antiRobotDefense(){
+document.body.onmousedown=function(){
+antiRobot |= 2;
+antiRobotGo();
+document.body.onmousedown=null;
+}
+document.body.onmousemove=function(){
+antiRobot |= 2;
+antiRobotGo();
+document.body.onmousemove=null;
+}
+setTimeout(function(){
+antiRobot |= 1;
+antiRobotGo();
+}, 100)
+antiRobotGo();
+}
+antiRobotDefense();
+</script>
+<!-- keywords: sqlite3_free sqlite3_malloc sqlite3_malloc64 sqlite3_msize sqlite3_realloc sqlite3_realloc64 -->
+<div class=nosearch>
+<a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
+<h2>Memory Allocation Subsystem</h2>
+</div>
+<blockquote><pre>
+void *sqlite3_malloc(int);
+void *sqlite3_malloc64(sqlite3_uint64);
+void *sqlite3_realloc(void*, int);
+void *sqlite3_realloc64(void*, sqlite3_uint64);
+void sqlite3_free(void*);
+sqlite3_uint64 sqlite3_msize(void*);
+</pre></blockquote>
+<p>
+The SQLite core uses these three routines for all of its own
+internal memory allocation needs. "Core" in the previous sentence
+does not include operating-system specific <a href="../vfs.html">VFS</a> implementation. The
+Windows VFS uses native malloc() and free() for some operations.</p>
+
+<p>The sqlite3_malloc() routine returns a pointer to a block
+of memory at least N bytes in length, where N is the parameter.
+If sqlite3_malloc() is unable to obtain sufficient free
+memory, it returns a NULL pointer. If the parameter N to
+sqlite3_malloc() is zero or negative then sqlite3_malloc() returns
+a NULL pointer.</p>
+
+<p>The sqlite3_malloc64(N) routine works just like
+sqlite3_malloc(N) except that N is an unsigned 64-bit integer instead
+of a signed 32-bit integer.</p>
+
+<p>Calling sqlite3_free() with a pointer previously returned
+by sqlite3_malloc() or sqlite3_realloc() releases that memory so
+that it might be reused. The sqlite3_free() routine is
+a no-op if is called with a NULL pointer. Passing a NULL pointer
+to sqlite3_free() is harmless. After being freed, memory
+should neither be read nor written. Even reading previously freed
+memory might result in a segmentation fault or other severe error.
+Memory corruption, a segmentation fault, or other severe error
+might result if sqlite3_free() is called with a non-NULL pointer that
+was not obtained from sqlite3_malloc() or sqlite3_realloc().</p>
+
+<p>The sqlite3_realloc(X,N) interface attempts to resize a
+prior memory allocation X to be at least N bytes.
+If the X parameter to sqlite3_realloc(X,N)
+is a NULL pointer then its behavior is identical to calling
+sqlite3_malloc(N).
+If the N parameter to sqlite3_realloc(X,N) is zero or
+negative then the behavior is exactly the same as calling
+sqlite3_free(X).
+sqlite3_realloc(X,N) returns a pointer to a memory allocation
+of at least N bytes in size or NULL if insufficient memory is available.
+If M is the size of the prior allocation, then min(N,M) bytes
+of the prior allocation are copied into the beginning of buffer returned
+by sqlite3_realloc(X,N) and the prior allocation is freed.
+If sqlite3_realloc(X,N) returns NULL and N is positive, then the
+prior allocation is not freed.</p>
+
+<p>The sqlite3_realloc64(X,N) interfaces works the same as
+sqlite3_realloc(X,N) except that N is a 64-bit unsigned integer instead
+of a 32-bit signed integer.</p>
+
+<p>If X is a memory allocation previously obtained from sqlite3_malloc(),
+sqlite3_malloc64(), sqlite3_realloc(), or sqlite3_realloc64(), then
+sqlite3_msize(X) returns the size of that memory allocation in bytes.
+The value returned by sqlite3_msize(X) might be larger than the number
+of bytes requested when X was allocated. If X is a NULL pointer then
+sqlite3_msize(X) returns zero. If X points to something that is not
+the beginning of memory allocation, or if it points to a formerly
+valid memory allocation that has now been freed, then the behavior
+of sqlite3_msize(X) is undefined and possibly harmful.</p>
+
+<p>The memory returned by sqlite3_malloc(), sqlite3_realloc(),
+sqlite3_malloc64(), and sqlite3_realloc64()
+is always aligned to at least an 8 byte boundary, or to a
+4 byte boundary if the <a href="../compile.html#4_byte_aligned_malloc">SQLITE_4_BYTE_ALIGNED_MALLOC</a> compile-time
+option is used.</p>
+
+<p>The pointer arguments to <a href="../c3ref/free.html">sqlite3_free()</a> and <a href="../c3ref/free.html">sqlite3_realloc()</a>
+must be either NULL or else pointers obtained from a prior
+invocation of <a href="../c3ref/free.html">sqlite3_malloc()</a> or <a href="../c3ref/free.html">sqlite3_realloc()</a> that have
+not yet been released.</p>
+
+<p>The application must not read or write any part of
+a block of memory after it has been released using
+<a href="../c3ref/free.html">sqlite3_free()</a> or <a href="../c3ref/free.html">sqlite3_realloc()</a>.
+</p><p>See also lists of
+ <a href="../c3ref/objlist.html">Objects</a>,
+ <a href="../c3ref/constlist.html">Constants</a>, and
+ <a href="../c3ref/funclist.html">Functions</a>.</p>
+