diff options
Diffstat (limited to 'runtime/docs/html/group__alloc.html')
| -rw-r--r-- | runtime/docs/html/group__alloc.html | 247 |
1 files changed, 247 insertions, 0 deletions
diff --git a/runtime/docs/html/group__alloc.html b/runtime/docs/html/group__alloc.html new file mode 100644 index 00000000..1a3e32b2 --- /dev/null +++ b/runtime/docs/html/group__alloc.html @@ -0,0 +1,247 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>SystemTap: Memory Functions</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.1 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> +<h1>Memory Functions</h1>Basic malloc/calloc/free functions. +<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><b>errorcode</b> { <b>ERR_NONE</b> = 0, +<b>ERR_NO_MEM</b> + }</td></tr> + +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alloc.html#ga1">_stp_alloc</a> (size_t len)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocates memory within a probe. <a href="#ga1"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alloc.html#ga2">_stp_calloc</a> (size_t len)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocates and clears memory within a probe. <a href="#ga2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alloc.html#ga3">_stp_valloc</a> (size_t len)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocates and clears memory outside a probe. <a href="#ga3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alloc.html#ga4">_stp_free</a> (void *ptr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Frees memory allocated by _stp_alloc or _stp_calloc. <a href="#ga4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__alloc.html#ga5">_stp_vfree</a> (void *ptr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Frees memory allocated by _stp_valloc. <a href="#ga5"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Variables</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga0" doxytag="alloc::_stp_error"></a> +enum errorcode </td><td class="memItemRight" valign="bottom"><b>_stp_error</b> = ERR_NONE</td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Basic malloc/calloc/free functions. +<p> +These will be changed so that memory allocation errors will call a handler. The default will send a signal to the user-space daemon that will trigger the module to be unloaded. <p> +<dl compact><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Need error handling for memory allocations</dd></dl> +<p> +<dl compact><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>Some of these currently use kmalloc (GFP_ATOMIC) for small allocations. This should be evaluated for performance and stability.</dd></dl> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="ga1" doxytag="alloc.c::_stp_alloc"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void* _stp_alloc </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">size_t </td> + <td class="mdname1" valign="top" nowrap> <em>len</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Allocates memory within a probe. +<p> +This is used for small allocations from within a running probe where the process cannot sleep. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Number of bytes to allocate. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>a valid pointer on success or NULL on failure. </dd></dl> +<dl compact><dt><b><a class="el" href="bug.html#_bug000001">Bug:</a></b></dt><dd>Currently uses kmalloc (GFP_ATOMIC). </dd></dl> + +<p> +Definition at line <a class="el" href="alloc_8c-source.html#l00031">31</a> of file <a class="el" href="alloc_8c-source.html">alloc.c</a>. +<p> +Referenced by <a class="el" href="alloc_8c-source.html#l00047">_stp_calloc()</a>, and <a class="el" href="map_8c-source.html#l00588">_stp_map_set_str()</a>. </td> + </tr> +</table> +<a class="anchor" name="ga2" doxytag="alloc.c::_stp_calloc"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void* _stp_calloc </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">size_t </td> + <td class="mdname1" valign="top" nowrap> <em>len</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Allocates and clears memory within a probe. +<p> +This is used for small allocations from within a running probe where the process cannot sleep. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Number of bytes to allocate. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>a valid pointer on success or NULL on failure. </dd></dl> +<dl compact><dt><b><a class="el" href="bug.html#_bug000002">Bug:</a></b></dt><dd>Currently uses kmalloc (GFP_ATOMIC). </dd></dl> + +<p> +Definition at line <a class="el" href="alloc_8c-source.html#l00047">47</a> of file <a class="el" href="alloc_8c-source.html">alloc.c</a>. +<p> +References <a class="el" href="alloc_8c-source.html#l00031">_stp_alloc()</a>. +<p> +Referenced by <a class="el" href="map_8c-source.html#l00673">_stp_map_set_stat()</a>, and <a class="el" href="map_8c-source.html#l00588">_stp_map_set_str()</a>. </td> + </tr> +</table> +<a class="anchor" name="ga4" doxytag="alloc.c::_stp_free"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void _stp_free </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void * </td> + <td class="mdname1" valign="top" nowrap> <em>ptr</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Frees memory allocated by _stp_alloc or _stp_calloc. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>ptr</em> </td><td>pointer to memory to free </td></tr> + </table> +</dl> + +<p> +Definition at line <a class="el" href="alloc_8c-source.html#l00076">76</a> of file <a class="el" href="alloc_8c-source.html">alloc.c</a>. +<p> +Referenced by <a class="el" href="map_8c-source.html#l00813">_stp_list_clear()</a>, <a class="el" href="map_8c-source.html#l00118">_stp_map_key_del()</a>, and <a class="el" href="map_8c-source.html#l00588">_stp_map_set_str()</a>. </td> + </tr> +</table> +<a class="anchor" name="ga3" doxytag="alloc.c::_stp_valloc"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void* _stp_valloc </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">size_t </td> + <td class="mdname1" valign="top" nowrap> <em>len</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Allocates and clears memory outside a probe. +<p> +This is typically used in the module initialization to allocate new maps, lists, etc. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Number of bytes to allocate. </td></tr> + </table> +</dl> +<dl compact><dt><b>Returns:</b></dt><dd>a valid pointer on success or NULL on failure. </dd></dl> + +<p> +Definition at line <a class="el" href="alloc_8c-source.html#l00062">62</a> of file <a class="el" href="alloc_8c-source.html">alloc.c</a>. +<p> +Referenced by <a class="el" href="map_8c-source.html#l00057">_stp_map_new()</a>. </td> + </tr> +</table> +<a class="anchor" name="ga5" doxytag="alloc.c::_stp_vfree"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">void _stp_vfree </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">void * </td> + <td class="mdname1" valign="top" nowrap> <em>ptr</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Frees memory allocated by _stp_valloc. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>ptr</em> </td><td>pointer to memory to free </td></tr> + </table> +</dl> + +<p> +Definition at line <a class="el" href="alloc_8c-source.html#l00086">86</a> of file <a class="el" href="alloc_8c-source.html">alloc.c</a>. +<p> +Referenced by <a class="el" href="map_8c-source.html#l00205">_stp_map_del()</a>. </td> + </tr> +</table> +</body></html> |