Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 9be6586ca9368ac08e469351ef5e9322083acad0 / . / doc / xmlmem.html
blob: 2542df19b204a1ff08dde1586a1265694de0baae [file] [log] [blame]
Daniel Veillard43d3f612001-11-10 11:57:23 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]2<html>
3<head>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]4<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type">
5<style type="text/css"><!--
Daniel Veillard373a4752002-02-21 14:46:29 +0000[diff] [blame]6TD {font-family: Verdana,Arial,Helvetica}
7BODY {font-family: Verdana,Arial,Helvetica; margin-top: 2em; margin-left: 0em; margin-right: 0em}
8H1 {font-family: Verdana,Arial,Helvetica}
9H2 {font-family: Verdana,Arial,Helvetica}
10H3 {font-family: Verdana,Arial,Helvetica}
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]11A:link, A:visited, A:active { text-decoration: underline }
12--></style>
13<title>Memory Management</title>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]14</head>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]15<body bgcolor="#8b7765" text="#000000" link="#000000" vlink="#000000">
16<table border="0" width="100%" cellpadding="5" cellspacing="0" align="center"><tr>
17<td width="180">
18<a href="http://www.gnome.org/"><img src="smallfootonly.gif" alt="Gnome Logo"></a><a href="http://www.w3.org/Status"><img src="w3c.png" alt="W3C Logo"></a><a href="http://www.redhat.com/"><img src="redhat.gif" alt="Red Hat Logo"></a>
19</td>
20<td><table border="0" width="90%" cellpadding="2" cellspacing="0" align="center" bgcolor="#000000"><tr><td><table width="100%" border="0" cellspacing="1" cellpadding="3" bgcolor="#fffacd"><tr><td align="center">
21<h1>The XML C library for Gnome</h1>
22<h2>Memory Management</h2>
23</td></tr></table></td></tr></table></td>
24</tr></table>
25<table border="0" cellpadding="4" cellspacing="0" width="100%" align="center"><tr><td bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="2" width="100%"><tr>
26<td valign="top" width="200" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td>
27<table width="100%" border="0" cellspacing="1" cellpadding="3">
28<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Main Menu</b></center></td></tr>
Daniel Veillard8acca112002-01-21 09:52:27 +0000[diff] [blame]29<tr><td bgcolor="#fffacd"><ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]30<li><a href="index.html">Home</a></li>
31<li><a href="intro.html">Introduction</a></li>
32<li><a href="FAQ.html">FAQ</a></li>
33<li><a href="docs.html">Documentation</a></li>
34<li><a href="bugs.html">Reporting bugs and getting help</a></li>
35<li><a href="help.html">How to help</a></li>
36<li><a href="downloads.html">Downloads</a></li>
37<li><a href="news.html">News</a></li>
Daniel Veillard7b602b42002-01-08 13:26:00 +0000[diff] [blame]38<li><a href="XMLinfo.html">XML</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]39<li><a href="XSLT.html">XSLT</a></li>
Daniel Veillard6dbcaf82002-02-20 14:37:47 +0000[diff] [blame]40<li><a href="python.html">Python and bindings</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]41<li><a href="architecture.html">libxml architecture</a></li>
42<li><a href="tree.html">The tree output</a></li>
43<li><a href="interface.html">The SAX interface</a></li>
44<li><a href="xmldtd.html">Validation &amp; DTDs</a></li>
45<li><a href="xmlmem.html">Memory Management</a></li>
46<li><a href="encoding.html">Encodings support</a></li>
47<li><a href="xmlio.html">I/O Interfaces</a></li>
48<li><a href="catalog.html">Catalog support</a></li>
49<li><a href="library.html">The parser interfaces</a></li>
50<li><a href="entities.html">Entities or no entities</a></li>
51<li><a href="namespaces.html">Namespaces</a></li>
52<li><a href="upgrade.html">Upgrading 1.x code</a></li>
Daniel Veillard52dcab32001-10-30 12:51:17 +0000[diff] [blame]53<li><a href="threads.html">Thread safety</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]54<li><a href="DOM.html">DOM Principles</a></li>
55<li><a href="example.html">A real example</a></li>
56<li><a href="contribs.html">Contributions</a></li>
57<li>
58<a href="xml.html">flat page</a>, <a href="site.xsl">stylesheet</a>
59</li>
60</ul></td></tr>
61</table>
62<table width="100%" border="0" cellspacing="1" cellpadding="3">
Daniel Veillard3bf65be2002-01-23 12:36:34 +0000[diff] [blame]63<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>API Indexes</b></center></td></tr>
64<tr><td bgcolor="#fffacd"><ul>
Daniel Veillardf8592562002-01-23 17:58:17 +0000[diff] [blame]65<li><a href="APIchunk0.html">Alphabetic</a></li>
Daniel Veillard3bf65be2002-01-23 12:36:34 +0000[diff] [blame]66<li><a href="APIconstructors.html">Constructors</a></li>
67<li><a href="APIfunctions.html">Functions/Types</a></li>
68<li><a href="APIfiles.html">Modules</a></li>
69<li><a href="APIsymbols.html">Symbols</a></li>
70</ul></td></tr>
71</table>
72<table width="100%" border="0" cellspacing="1" cellpadding="3">
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]73<tr><td colspan="1" bgcolor="#eecfa1" align="center"><center><b>Related links</b></center></td></tr>
Daniel Veillard8acca112002-01-21 09:52:27 +0000[diff] [blame]74<tr><td bgcolor="#fffacd"><ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]75<li><a href="http://mail.gnome.org/archives/xml/">Mail archive</a></li>
76<li><a href="http://xmlsoft.org/XSLT/">XSLT libxslt</a></li>
Daniel Veillard4a859202002-01-08 11:49:22 +0000[diff] [blame]77<li><a href="http://phd.cs.unibo.it/gdome2/">DOM gdome2</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]78<li><a href="ftp://xmlsoft.org/">FTP</a></li>
79<li><a href="http://www.fh-frankfurt.de/~igor/projects/libxml/">Windows binaries</a></li>
Daniel Veillarddb9dfd92001-11-26 17:25:02 +0000[diff] [blame]80<li><a href="http://garypennington.net/libxml2/">Solaris binaries</a></li>
Daniel Veillardc6271d22001-10-27 07:50:58 +0000[diff] [blame]81<li><a href="http://bugzilla.gnome.org/buglist.cgi?product=libxml">Bug Tracker</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]82</ul></td></tr>
83</table>
84</td></tr></table></td>
85<td valign="top" bgcolor="#8b7765"><table border="0" cellspacing="0" cellpadding="1" width="100%"><tr><td><table border="0" cellspacing="0" cellpadding="1" width="100%" bgcolor="#000000"><tr><td><table border="0" cellpadding="3" cellspacing="1" width="100%"><tr><td bgcolor="#fffacd">
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]86<p>Table of Content:</p>
87<ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]88<li><a href="#General3">General overview</a></li>
Daniel Veillard9c466822001-10-25 12:03:39 +0000[diff] [blame]89<li><a href="#setting">Setting libxml set of memory routines</a></li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]90<li><a href="#cleanup">Cleaning up after parsing</a></li>
91<li><a href="#Debugging">Debugging routines</a></li>
92<li><a href="#General4">General memory requirements</a></li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]93</ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]94<h3><a name="General3">General overview</a></h3>
95<p>The module <code><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlmemory.h</a></code>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]96provides the interfaces to the libxml memory system:</p>
97<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]98<li>libxml does not use the libc memory allocator directly but xmlFree(),
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]99 xmlMalloc() and xmlRealloc()</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]100<li>those routines can be reallocated to a specific set of routine, by
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]101 default the libc ones i.e. free(), malloc() and realloc()</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]102<li>the xmlmemory.c module includes a set of debugging routine</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]103</ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]104<h3><a name="setting">Setting libxml set of memory routines</a></h3>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]105<p>It is sometimes useful to not use the default memory allocator, either for
106debugging, analysis or to implement a specific behaviour on memory management
107(like on embedded systems). Two function calls are available to do so:</p>
108<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]109<li>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]110<a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemGet
111 ()</a> which return the current set of functions in use by the parser</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]112<li>
113<a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemSetup()</a>
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]114 which allow to set up a new set of memory allocation functions</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]115</ul>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]116<p>Of course a call to xmlMemSetup() should probably be done before calling
117any other libxml routines (unless you are sure your allocations routines are
118compatibles).</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]119<h3><a name="cleanup">Cleaning up after parsing</a></h3>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]120<p>Libxml is not stateless, there is a few set of memory structures needing
121allocation before the parser is fully functionnal (some encoding structures
122for example). This also mean that once parsing is finished there is a tiny
123amount of memory (a few hundred bytes) which can be recollected if you don't
124reuse the parser immediately:</p>
125<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]126<li>
127<a href="http://xmlsoft.org/html/libxml-parser.html">xmlCleanupParser
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]128 ()</a> is a centralized routine to free the parsing states. Note that it
129 won't deallocate any produced tree if any (use the xmlFreeDoc() and
130 related routines for this).</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]131<li>
132<a href="http://xmlsoft.org/html/libxml-parser.html">xmlInitParser
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]133 ()</a> is the dual routine allowing to preallocate the parsing state
134 which can be useful for example to avoid initialization reentrancy
135 problems when using libxml in multithreaded applications</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]136</ul>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]137<p>Generally xmlCleanupParser() is safe, if needed the state will be rebuild
138at the next invocation of parser routines, but be careful of the consequences
139in multithreaded applications.</p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]140<h3><a name="Debugging">Debugging routines</a></h3>
141<p>When configured using --with-mem-debug flag (off by default), libxml uses
142a set of memory allocation debugging routineskeeping track of all allocated
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]143blocks and the location in the code where the routine was called. A couple of
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]144other debugging routines allow to dump the memory allocated infos to a file
145or call a specific routine when a given block number is allocated:</p>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]146<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]147<li>
148<a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMallocLoc()</a><a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlReallocLoc()</a>
149 and <a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemStrdupLoc()</a>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]150 are the memory debugging replacement allocation routines</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]151<li>
152<a href="http://xmlsoft.org/html/libxml-xmlmemory.html">xmlMemoryDump
Daniel Veillardaf43f632002-03-08 15:05:20 +0000[diff] [blame]153 ()</a> dumps all the informations about the allocated memory block lefts
154 in the <code>.memdump</code> file</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]155</ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]156<p>When developping libxml memory debug is enabled, the tests programs call
157xmlMemoryDump () and the &quot;make test&quot; regression tests will check for any
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]158memory leak during the full regression test sequence, this helps a lot
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]159ensuring that libxml does not leak memory and bullet proof memory
160allocations use (some libc implementations are known to be far too permissive
161resulting in major portability problems!).</p>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]162<p>If the .memdump reports a leak, it displays the allocation function and
163also tries to give some informations about the content and structure of the
164allocated blocks left. This is sufficient in most cases to find the culprit,
165but not always. Assuming the allocation problem is reproductible, it is
166possible to find more easilly:</p>
167<ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]168<li>write down the block number xxxx not allocated</li>
169<li>export the environement variable XML_MEM_BREAKPOINT=xxxx</li>
170<li>run the program under a debugger and set a breakpoint on
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]171 xmlMallocBreakpoint() a specific function called when this precise block
172 is allocated</li>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]173<li>when the breakpoint is reached you can then do a fine analysis of the
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]174 allocation an step to see the condition resulting in the missing
175 deallocation.</li>
176</ol>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]177<p>I used to use a commercial tool to debug libxml memory problems but after
178noticing that it was not detecting memory leaks that simple mechanism was
179used and proved extremely efficient until now.</p>
180<h3><a name="General4">General memory requirements</a></h3>
181<p>How much libxml memory require ? It's hard to tell in average it depends
182of a number of things:</p>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]183<ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]184<li>the parser itself should work in a fixed amout of memory, except for
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]185 information maintained about the stacks of names and entities locations.
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]186 The I/O and encoding handlers will probably account for a few KBytes.
187 This is true for both the XML and HTML parser (though the HTML parser
188 need more state).</li>
189<li>If you are generating the DOM tree then memory requirements will grow
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]190 nearly lineary with the size of the data. In general for a balanced
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]191 textual document the internal memory requirement is about 4 times the
192 size of the UTF8 serialization of this document (exmple the XML-1.0
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]193 recommendation is a bit more of 150KBytes and takes 650KBytes of main
194 memory when parsed). Validation will add a amount of memory required for
195 maintaining the external Dtd state which should be linear with the
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]196 complexity of the content model defined by the Dtd</li>
197<li>If you don't care about the advanced features of libxml like
198 validation, DOM, XPath or XPointer, but really need to work fixed memory
199 requirements, then the SAX interface should be used.</li>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]200</ul>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]201<p>
Daniel Veillard3f4c40f2002-02-13 09:19:28 +0000[diff] [blame]202<p><a href="bugs.html">Daniel Veillard</a></p>
Daniel Veillardb8cfbd12001-10-25 10:53:28 +0000[diff] [blame]203</td></tr></table></td></tr></table></td></tr></table></td>
204</tr></table></td></tr></table>
Daniel Veillard189446d2000-10-13 10:23:06 +0000[diff] [blame]205</body>
206</html>