diff options
Diffstat (limited to 'runtime/docs/html/group__io.html')
| -rw-r--r-- | runtime/docs/html/group__io.html | 98 |
1 files changed, 38 insertions, 60 deletions
diff --git a/runtime/docs/html/group__io.html b/runtime/docs/html/group__io.html index 357e250b..76051d30 100644 --- a/runtime/docs/html/group__io.html +++ b/runtime/docs/html/group__io.html @@ -4,32 +4,37 @@ <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> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> <h1>I/O</h1>I/O functions. <a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> +<tr><td colspan="2"><br><h2>Defines</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga9" doxytag="io::STP_LOG_BUF_LEN"></a> +#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__io.html#ga9">STP_LOG_BUF_LEN</a> 2047</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">private buffer for <a class="el" href="group__io.html#ga2">_stp_log()</a> <br></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__io.html#ga0">dlog</a> (const char *fmt,...)</td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__io.html#ga2">_stp_log</a> (const char *fmt,...)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Logs Data. <a href="#ga0"></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__io.html#ga1">_stp_print</a> (const char *fmt,...)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Logs Data. <a href="#ga2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__io.html#ga7">_stp_netlink_open</a> (void)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints to the trace buffer. <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__io.html#ga2">_stp_print_str</a> (char *str)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opens netlink and relayfs connections to stpd. <a href="#ga7"></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__io.html#ga8">_stp_netlink_close</a> (void)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints to the trace buffer. <a href="#ga2"></a><br></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes netlink and relayfs connections to stpd. <a href="#ga8"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> I/O functions. <p> <hr><h2>Function Documentation</h2> -<a class="anchor" name="ga1" doxytag="io.c::_stp_print"></a><p> +<a class="anchor" name="ga2" doxytag="io.c::_stp_log"></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_print </td> + <td class="md" nowrap valign="top">void _stp_log </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const char * </td> <td class="mdname" nowrap> <em>fmt</em>, </td> @@ -57,33 +62,34 @@ I/O functions. <td> <p> -Prints to the trace buffer. +Logs Data. <p> -This function uses the same formatting as printk. It currently writes to the system log.<p> -<dl compact><dt><b>Parameters:</b></dt><dd> +This function prints to the system log if stpd has not connected yet. Otherwise it sends the message immediately to stpd. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>fmt</em> </td><td>A variable number of args. </td></tr> </table> </dl> -<p> -<dl compact><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>Needs replaced with something much faster that does not use the system log. </dd></dl> +<dl compact><dt><b>Note:</b></dt><dd>Lines are limited in length by printk buffer. If there is no newline in the format string, then other syslog output could get appended to the SystemTap line. </dd></dl> +<dl compact><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>Evaluate if this function is necessary. </dd></dl> <p> -Definition at line <a class="el" href="io_8c-source.html#l00043">43</a> of file <a class="el" href="io_8c-source.html">io.c</a>. +Definition at line <a class="el" href="io_8c-source.html#l00029">29</a> of file <a class="el" href="io_8c-source.html">io.c</a>. +<p> +References <a class="el" href="io_8c-source.html#l00016">STP_LOG_BUF_LEN</a>. <p> -Referenced by <a class="el" href="sym_8c-source.html#l00059">_stp_symbol_print()</a>. </td> +Referenced by <a class="el" href="map_8c-source.html#l00831">_stp_list_clear()</a>, <a class="el" href="probes_8c-source.html#l00034">_stp_register_jprobes()</a>, <a class="el" href="probes_8c-source.html#l00079">_stp_register_kprobes()</a>, <a class="el" href="stack_8c-source.html#l00171">_stp_stack_sprint()</a>, <a class="el" href="string_8c-source.html#l00042">_stp_string_init()</a>, <a class="el" href="probes_8c-source.html#l00020">_stp_unregister_jprobes()</a>, and <a class="el" href="probes_8c-source.html#l00065">_stp_unregister_kprobes()</a>. </td> </tr> </table> -<a class="anchor" name="ga2" doxytag="io.c::_stp_print_str"></a><p> +<a class="anchor" name="ga8" doxytag="io.c::_stp_netlink_close"></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_print_str </td> + <td class="md" nowrap valign="top">void _stp_netlink_close </td> <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">char * </td> - <td class="mdname1" valign="top" nowrap> <em>str</em> </td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> @@ -99,42 +105,26 @@ Referenced by <a class="el" href="sym_8c-source.html#l00059">_stp_symbol_print() <td> <p> -Prints to the trace buffer. -<p> -This function will write a string to the trace buffer. It currently writes to the system log.<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>str</em> </td><td>String. </td></tr> - </table> -</dl> +Closes netlink and relayfs connections to stpd. <p> -<dl compact><dt><b><a class="el" href="todo.html#_todo000005">Todo:</a></b></dt><dd>Needs replaced with something much faster that does not use the system log. </dd></dl> +This must be called after all I/O is done, probably at the end of module cleanup. <dl compact><dt><b>Returns:</b></dt><dd>0 on success. -1 if there is a problem establishing a connection. </dd></dl> <p> -Definition at line <a class="el" href="io_8c-source.html#l00060">60</a> of file <a class="el" href="io_8c-source.html">io.c</a>. </td> +Definition at line <a class="el" href="io_8c-source.html#l00103">103</a> of file <a class="el" href="io_8c-source.html">io.c</a>. </td> </tr> </table> -<a class="anchor" name="ga0" doxytag="io.c::dlog"></a><p> +<a class="anchor" name="ga7" doxytag="io.c::_stp_netlink_open"></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 dlog </td> + <td class="md" nowrap valign="top">int _stp_netlink_open </td> <td class="md" valign="top">( </td> - <td class="md" nowrap valign="top">const char * </td> - <td class="mdname" nowrap> <em>fmt</em>, </td> - </tr> - <tr> - <td class="md" nowrap align="right"></td> - <td class="md"></td> - <td class="md" nowrap> </td> - <td class="mdname" nowrap> <em>...</em></td> - </tr> - <tr> - <td class="md"></td> - <td class="md">) </td> - <td class="md" colspan="2"></td> + <td class="md" nowrap valign="top">void </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> </tr> </table> </td> @@ -148,23 +138,11 @@ Definition at line <a class="el" href="io_8c-source.html#l00060">60</a> of file <td> <p> -Logs Data. -<p> -This function is compatible with printk. In fact it currently sends all output to vprintk, after sending "STP: ". This allows us to easily detect SystemTap output in the log file.<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>fmt</em> </td><td>A variable number of args. </td></tr> - </table> -</dl> -<p> -<dl compact><dt><b><a class="el" href="bug.html#_bug000003">Bug:</a></b></dt><dd>Lines are limited in length by printk buffer. If there is no newline in the format string, then other syslog output could get appended to the SystemTap line.</dd></dl> -<p> -<dl compact><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>Either deprecate or redefine this as a way to log debug or status messages, separate from the normal program output. </dd></dl> - +Opens netlink and relayfs connections to stpd. <p> -Definition at line <a class="el" href="io_8c-source.html#l00025">25</a> of file <a class="el" href="io_8c-source.html">io.c</a>. +This must be called before any I/O is done, probably at the start of module initialization. <p> -Referenced by <a class="el" href="map_8c-source.html#l00813">_stp_list_clear()</a>, <a class="el" href="probes_8c-source.html#l00032">_stp_register_jprobes()</a>, <a class="el" href="probes_8c-source.html#l00077">_stp_register_kprobes()</a>, <a class="el" href="probes_8c-source.html#l00018">_stp_unregister_jprobes()</a>, and <a class="el" href="probes_8c-source.html#l00063">_stp_unregister_kprobes()</a>. </td> +Definition at line <a class="el" href="io_8c-source.html#l00087">87</a> of file <a class="el" href="io_8c-source.html">io.c</a>. </td> </tr> </table> </body></html> |