Debian Codegraph @

www/c3ref/c_status_malloc_count.html

raw
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>Status Parameters</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: SQLITE_STATUS_MALLOC_COUNT SQLITE_STATUS_MALLOC_SIZE SQLITE_STATUS_MEMORY_USED SQLITE_STATUS_PAGECACHE_OVERFLOW SQLITE_STATUS_PAGECACHE_SIZE SQLITE_STATUS_PAGECACHE_USED SQLITE_STATUS_PARSER_STACK SQLITE_STATUS_SCRATCH_OVERFLOW SQLITE_STATUS_SCRATCH_SIZE SQLITE_STATUS_SCRATCH_USED {status parameters} -->
119 <div class=nosearch>
120 <a href="../c3ref/intro.html"><h2>SQLite C Interface</h2></a>
121 <h2>Status Parameters</h2>
122 </div>
123 <blockquote><pre>
124 #define SQLITE_STATUS_MEMORY_USED 0
125 #define SQLITE_STATUS_PAGECACHE_USED 1
126 #define SQLITE_STATUS_PAGECACHE_OVERFLOW 2
127 #define SQLITE_STATUS_SCRATCH_USED 3 /* NOT USED */
128 #define SQLITE_STATUS_SCRATCH_OVERFLOW 4 /* NOT USED */
129 #define SQLITE_STATUS_MALLOC_SIZE 5
130 #define SQLITE_STATUS_PARSER_STACK 6
131 #define SQLITE_STATUS_PAGECACHE_SIZE 7
132 #define SQLITE_STATUS_SCRATCH_SIZE 8 /* NOT USED */
133 #define SQLITE_STATUS_MALLOC_COUNT 9
134 </pre></blockquote>
135 <p>
136 These integer constants designate various run-time status parameters
137 that can be returned by <a href="../c3ref/status.html">sqlite3_status()</a>.</p>
138
139 <p><dl>
140 <a name="sqlitestatusmemoryused"></a>
141 <dt>SQLITE_STATUS_MEMORY_USED</dt>
142 <dd>This parameter is the current amount of memory checked out
143 using <a href="../c3ref/free.html">sqlite3_malloc()</a>, either directly or indirectly. The
144 figure includes calls made to <a href="../c3ref/free.html">sqlite3_malloc()</a> by the application
145 and internal memory usage by the SQLite library. Auxiliary page-cache
146 memory controlled by <a href="../c3ref/c_config_covering_index_scan.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a> is not included in
147 this parameter. The amount returned is the sum of the allocation
148 sizes as reported by the xSize method in <a href="../c3ref/mem_methods.html">sqlite3_mem_methods</a>.</dd></p>
149
150 <p><a name="sqlitestatusmallocsize"></a>
151 <dt>SQLITE_STATUS_MALLOC_SIZE</dt>
152 <dd>This parameter records the largest memory allocation request
153 handed to <a href="../c3ref/free.html">sqlite3_malloc()</a> or <a href="../c3ref/free.html">sqlite3_realloc()</a> (or their
154 internal equivalents). Only the value returned in the
155 *pHighwater parameter to <a href="../c3ref/status.html">sqlite3_status()</a> is of interest.
156 The value written into the *pCurrent parameter is undefined.</dd></p>
157
158 <p><a name="sqlitestatusmalloccount"></a>
159 <dt>SQLITE_STATUS_MALLOC_COUNT</dt>
160 <dd>This parameter records the number of separate memory allocations
161 currently checked out.</dd></p>
162
163 <p><a name="sqlitestatuspagecacheused"></a>
164 <dt>SQLITE_STATUS_PAGECACHE_USED</dt>
165 <dd>This parameter returns the number of pages used out of the
166 <a href="../malloc.html#pagecache">pagecache memory allocator</a> that was configured using
167 <a href="../c3ref/c_config_covering_index_scan.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a>. The
168 value returned is in pages, not in bytes.</dd></p>
169
170 <p><a name="sqlitestatuspagecacheoverflow"></a>
171
172 <dt>SQLITE_STATUS_PAGECACHE_OVERFLOW</dt>
173 <dd>This parameter returns the number of bytes of page cache
174 allocation which could not be satisfied by the <a href="../c3ref/c_config_covering_index_scan.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a>
175 buffer and where forced to overflow to <a href="../c3ref/free.html">sqlite3_malloc()</a>. The
176 returned value includes allocations that overflowed because they
177 were too large (they were larger than the "sz" parameter to
178 <a href="../c3ref/c_config_covering_index_scan.html#sqliteconfigpagecache">SQLITE_CONFIG_PAGECACHE</a>) and allocations that overflowed because
179 no space was left in the page cache.</dd></p>
180
181 <p><a name="sqlitestatuspagecachesize"></a>
182 <dt>SQLITE_STATUS_PAGECACHE_SIZE</dt>
183 <dd>This parameter records the largest memory allocation request
184 handed to the <a href="../malloc.html#pagecache">pagecache memory allocator</a>. Only the value returned in the
185 *pHighwater parameter to <a href="../c3ref/status.html">sqlite3_status()</a> is of interest.
186 The value written into the *pCurrent parameter is undefined.</dd></p>
187
188 <p><a name="sqlitestatusscratchused"></a>
189 <dt>SQLITE_STATUS_SCRATCH_USED</dt>
190 <dd>No longer used.</dd></p>
191
192 <p><a name="sqlitestatusscratchoverflow"></a>
193 <dt>SQLITE_STATUS_SCRATCH_OVERFLOW</dt>
194 <dd>No longer used.</dd></p>
195
196 <p><a name="sqlitestatusscratchsize"></a>
197 <dt>SQLITE_STATUS_SCRATCH_SIZE</dt>
198 <dd>No longer used.</dd></p>
199
200 <p><a name="sqlitestatusparserstack"></a>
201 <dt>SQLITE_STATUS_PARSER_STACK</dt>
202 <dd>The *pHighwater parameter records the deepest parser stack.
203 The *pCurrent value is undefined. The *pHighwater value is only
204 meaningful if SQLite is compiled with <a href="../compile.html#yytrackmaxstackdepth">YYTRACKMAXSTACKDEPTH</a>.</dd>
205 </dl></p>
206
207 <p>New status parameters may be added from time to time.
208 </p><p>See also lists of
209 <a href="../c3ref/objlist.html">Objects</a>,
210 <a href="../c3ref/constlist.html">Constants</a>, and
211 <a href="../c3ref/funclist.html">Functions</a>.</p>
212