diff options
Diffstat (limited to 'runtime/docs/html/print_8c-source.html')
| -rw-r--r-- | runtime/docs/html/print_8c-source.html | 208 |
1 files changed, 208 insertions, 0 deletions
diff --git a/runtime/docs/html/print_8c-source.html b/runtime/docs/html/print_8c-source.html new file mode 100644 index 00000000..c020fff3 --- /dev/null +++ b/runtime/docs/html/print_8c-source.html @@ -0,0 +1,208 @@ +<!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: print.c Source File</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="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>print.c</h1><div class="fragment"><pre class="fragment">00001 <span class="preprocessor">#ifndef _PRINT_C_ </span><span class="comment">/* -*- linux-c -*- */</span> +00002 <span class="preprocessor">#define _PRINT_C_</span> +00003 <span class="preprocessor"></span> +00004 <span class="preprocessor">#include <linux/config.h></span> +00005 +00006 <span class="preprocessor">#include "<a class="code" href="io_8c.html">io.c</a>"</span> +00007 <span class="comment"></span> +00008 <span class="comment">/** @file print.c</span> +00009 <span class="comment"> * @addtogroup print Print Buffer</span> +00010 <span class="comment"> * Print Buffer Functions.</span> +00011 <span class="comment"> * The print buffer is for collecting output to send to the user daemon.</span> +00012 <span class="comment"> * This is a per-cpu static buffer. The buffer is sent when</span> +00013 <span class="comment"> * _stp_print_flush() is called.</span> +00014 <span class="comment"> *</span> +00015 <span class="comment"> * The reason to do this is to allow multiple small prints to be combined then</span> +00016 <span class="comment"> * timestamped and sent together to stpd. It could flush automatically on newlines,</span> +00017 <span class="comment"> * but what about stack traces which span many lines? So try this and see how it works for us.</span> +00018 <span class="comment"> * @{</span> +00019 <span class="comment"> */</span> +00020 <span class="comment"></span> +00021 <span class="comment">/** Size of buffer, not including terminating NULL */</span> +<a name="l00022"></a><a class="code" href="group__print.html#ga8">00022</a> <span class="preprocessor">#define STP_PRINT_BUF_LEN 8000</span> +00023 <span class="preprocessor"></span> +00024 <span class="keyword">static</span> <span class="keywordtype">int</span> _stp_pbuf_len[NR_CPUS]; +00025 +00026 <span class="preprocessor">#ifdef STP_NETLINK_ONLY</span> +00027 <span class="preprocessor"></span><span class="preprocessor">#define STP_PRINT_BUF_START 0</span> +00028 <span class="preprocessor"></span><span class="keyword">static</span> <span class="keywordtype">char</span> _stp_pbuf[NR_CPUS][<a class="code" href="group__print.html#ga8">STP_PRINT_BUF_LEN</a> + 1]; +00029 +00030 <span class="keywordtype">void</span> <a class="code" href="group__print.html#ga2">_stp_print_flush</a> (<span class="keywordtype">void</span>) +00031 { +00032 <span class="keywordtype">int</span> cpu = smp_processor_id(); +00033 <span class="keywordtype">char</span> *buf = &_stp_pbuf[cpu][0]; +00034 <span class="keywordtype">int</span> len = _stp_pbuf_len[cpu]; +00035 +00036 <span class="keywordflow">if</span> (len == 0) +00037 <span class="keywordflow">return</span>; +00038 +00039 <span class="keywordflow">if</span> ( app.logging == 0) { +00040 _stp_pbuf_len[cpu] = 0; +00041 <span class="keywordflow">return</span>; +00042 } +00043 +00044 <span class="comment">/* enforce newline at end */</span> +00045 <span class="keywordflow">if</span> (buf[len - 1] != <span class="charliteral">'\n'</span>) { +00046 buf[len++] = <span class="charliteral">'\n'</span>; +00047 buf[len] = <span class="charliteral">'\0'</span>; +00048 } +00049 +00050 send_reply (STP_REALTIME_DATA, buf, len + 1, stpd_pid); +00051 _stp_pbuf_len[cpu] = 0; +00052 } +00053 +00054 <span class="preprocessor">#else </span><span class="comment">/* ! STP_NETLINK_ONLY */</span> +00055 <span class="comment">/* size of timestamp, in bytes, including space */</span> +00056 <span class="preprocessor">#define TIMESTAMP_SIZE 19</span> +00057 <span class="preprocessor"></span><span class="preprocessor">#define STP_PRINT_BUF_START (TIMESTAMP_SIZE + 1)</span> +00058 <span class="preprocessor"></span><span class="keyword">static</span> <span class="keywordtype">char</span> _stp_pbuf[NR_CPUS][<a class="code" href="group__print.html#ga8">STP_PRINT_BUF_LEN</a> + STP_PRINT_BUF_START + 1]; +00059 <span class="comment"></span> +00060 <span class="comment">/** Send the print buffer now.</span> +00061 <span class="comment"> * Output accumulates in the print buffer until this is called.</span> +00062 <span class="comment"> * Size is limited by length of print buffer, #STP_PRINT_BUF_LEN.</span> +00063 <span class="comment"> */</span> +00064 +<a name="l00065"></a><a class="code" href="group__print.html#ga2">00065</a> <span class="keywordtype">void</span> <a class="code" href="group__print.html#ga2">_stp_print_flush</a> (<span class="keywordtype">void</span>) +00066 { +00067 <span class="keywordtype">int</span> cpu = smp_processor_id(); +00068 <span class="keywordtype">char</span> *buf = &_stp_pbuf[cpu][0]; +00069 <span class="keywordtype">char</span> *ptr = buf + STP_PRINT_BUF_START; +00070 <span class="keyword">struct </span>timeval tv; +00071 +00072 <span class="keywordflow">if</span> (_stp_pbuf_len[cpu] == 0) +00073 <span class="keywordflow">return</span>; +00074 +00075 <span class="comment">/* enforce newline at end */</span> +00076 <span class="keywordflow">if</span> (ptr[_stp_pbuf_len[cpu]-1] != <span class="charliteral">'\n'</span>) { +00077 ptr[_stp_pbuf_len[cpu]++] = <span class="charliteral">'\n'</span>; +00078 ptr[_stp_pbuf_len[cpu]] = <span class="charliteral">'\0'</span>; +00079 } +00080 +00081 do_gettimeofday(&tv); +00082 scnprintf (buf, TIMESTAMP_SIZE+1, <span class="stringliteral">"[%li.%06li] "</span>, tv.tv_sec, tv.tv_usec); +00083 buf[TIMESTAMP_SIZE] = <span class="charliteral">' '</span>; +00084 relayapp_write(buf, _stp_pbuf_len[cpu] + TIMESTAMP_SIZE + 2); +00085 _stp_pbuf_len[cpu] = 0; +00086 } +00087 <span class="preprocessor">#endif </span><span class="comment">/* STP_NETLINK_ONLY */</span> +00088 <span class="comment"></span> +00089 <span class="comment">/** Print into the print buffer.</span> +00090 <span class="comment"> * Like printf, except output goes to the print buffer.</span> +00091 <span class="comment"> * Safe because overflowing the buffer is not allowed.</span> +00092 <span class="comment"> * Size is limited by length of print buffer, #STP_PRINT_BUF_LEN.</span> +00093 <span class="comment"> * </span> +00094 <span class="comment"> * @param fmt A printf-style format string followed by a </span> +00095 <span class="comment"> * variable number of args.</span> +00096 <span class="comment"> * @sa _stp_print_flush()</span> +00097 <span class="comment"> */</span> +00098 +<a name="l00099"></a><a class="code" href="group__print.html#ga3">00099</a> <span class="keywordtype">void</span> <a class="code" href="group__print.html#ga3">_stp_printf</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, ...) +00100 { +00101 <span class="keywordtype">int</span> num; +00102 va_list args; +00103 <span class="keywordtype">int</span> cpu = smp_processor_id(); +00104 <span class="keywordtype">char</span> *buf = &_stp_pbuf[cpu][STP_PRINT_BUF_START] + _stp_pbuf_len[cpu]; +00105 va_start(args, fmt); +00106 num = vscnprintf(buf, <a class="code" href="group__print.html#ga8">STP_PRINT_BUF_LEN</a> - _stp_pbuf_len[cpu], fmt, args); +00107 va_end(args); +00108 <span class="keywordflow">if</span> (num > 0) +00109 _stp_pbuf_len[cpu] += num; +00110 } +00111 <span class="comment"></span> +00112 <span class="comment">/** Print into the print buffer.</span> +00113 <span class="comment"> * Use this if your function already has a va_list.</span> +00114 <span class="comment"> * You probably want _stp_printf().</span> +00115 <span class="comment"> */</span> +00116 +<a name="l00117"></a><a class="code" href="group__print.html#ga4">00117</a> <span class="keywordtype">void</span> <a class="code" href="group__print.html#ga4">_stp_vprintf</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, va_list args) +00118 { +00119 <span class="keywordtype">int</span> num; +00120 <span class="keywordtype">int</span> cpu = smp_processor_id(); +00121 <span class="keywordtype">char</span> *buf = &_stp_pbuf[cpu][STP_PRINT_BUF_START] + _stp_pbuf_len[cpu]; +00122 num = vscnprintf(buf, <a class="code" href="group__print.html#ga8">STP_PRINT_BUF_LEN</a> -_stp_pbuf_len[cpu], fmt, args); +00123 <span class="keywordflow">if</span> (num > 0) +00124 _stp_pbuf_len[cpu] += num; +00125 } +00126 <span class="comment"></span> +00127 <span class="comment">/** Write a C string into the print buffer.</span> +00128 <span class="comment"> * Copies a string into a print buffer.</span> +00129 <span class="comment"> * Safe because overflowing the buffer is not allowed.</span> +00130 <span class="comment"> * Size is limited by length of print buffer, #STP_PRINT_BUF_LEN.</span> +00131 <span class="comment"> * This is more efficient than using _stp_printf() if you don't</span> +00132 <span class="comment"> * need fancy formatting.</span> +00133 <span class="comment"> *</span> +00134 <span class="comment"> * @param str A C string.</span> +00135 <span class="comment"> * @sa _stp_print</span> +00136 <span class="comment"> */</span> +00137 +<a name="l00138"></a><a class="code" href="group__print.html#ga5">00138</a> <span class="keywordtype">void</span> <a class="code" href="group__print.html#ga5">_stp_print_cstr</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *str) +00139 { +00140 <span class="keywordtype">int</span> cpu = smp_processor_id(); +00141 <span class="keywordtype">char</span> *buf = &_stp_pbuf[cpu][STP_PRINT_BUF_START] + _stp_pbuf_len[cpu]; +00142 <span class="keywordtype">int</span> num = strlen (str); +00143 <span class="keywordflow">if</span> (num > <a class="code" href="group__print.html#ga8">STP_PRINT_BUF_LEN</a> - _stp_pbuf_len[cpu]) +00144 num = <a class="code" href="group__print.html#ga8">STP_PRINT_BUF_LEN</a> - _stp_pbuf_len[cpu]; +00145 strncpy (buf, str, num+1); +00146 _stp_pbuf_len[cpu] += num; +00147 } +00148 <span class="comment"></span> +00149 <span class="comment">/** Clear the scratch buffer.</span> +00150 <span class="comment"> * This function should be called before anything is written to </span> +00151 <span class="comment"> * the scratch buffer. Output will accumulate in the buffer</span> +00152 <span class="comment"> * until this function is called again. </span> +00153 <span class="comment"> * @returns A pointer to the buffer.</span> +00154 <span class="comment"> */</span> +00155 +<a name="l00156"></a><a class="code" href="group__print.html#ga6">00156</a> <span class="keywordtype">char</span> *<a class="code" href="group__print.html#ga6">_stp_print_clear</a> (<span class="keywordtype">void</span>) +00157 { +00158 <span class="keywordtype">int</span> cpu = smp_processor_id(); +00159 _stp_pbuf_len[cpu] = 0; +00160 <span class="keywordflow">return</span> &_stp_pbuf[cpu][STP_PRINT_BUF_START]; +00161 } +00162 +00163 <span class="preprocessor">#include "<a class="code" href="string_8c.html">string.c</a>"</span> +00164 <span class="comment"></span> +00165 <span class="comment">/** Write a String into the print buffer.</span> +00166 <span class="comment"> * Copies a String into a print buffer.</span> +00167 <span class="comment"> * Safe because overflowing the buffer is not allowed.</span> +00168 <span class="comment"> * Size is limited by length of print buffer, #STP_PRINT_BUF_LEN.</span> +00169 <span class="comment"> * This is more efficient than using _stp_printf() if you don't</span> +00170 <span class="comment"> * need fancy formatting.</span> +00171 <span class="comment"> *</span> +00172 <span class="comment"> * @param str A String.</span> +00173 <span class="comment"> * @sa _stp_print</span> +00174 <span class="comment"> */</span> +00175 +<a name="l00176"></a><a class="code" href="group__print.html#ga7">00176</a> <span class="keywordtype">void</span> <a class="code" href="group__print.html#ga7">_stp_print_string</a> (String str) +00177 { +00178 <span class="keywordflow">if</span> (str->len) +00179 <a class="code" href="group__print.html#ga5">_stp_print_cstr</a> (str->buf); +00180 } +00181 <span class="comment"></span> +00182 <span class="comment">/** Write a String or C string into the print buffer.</span> +00183 <span class="comment"> * This macro selects the proper function to call.</span> +00184 <span class="comment"> * @param str A String or C string (char *)</span> +00185 <span class="comment"> * @sa _stp_print_cstr _stp_print_string</span> +00186 <span class="comment"> */</span> +00187 +<a name="l00188"></a><a class="code" href="group__print.html#ga11">00188</a> <span class="preprocessor">#define _stp_print(str) \</span> +00189 <span class="preprocessor"> ({ \</span> +00190 <span class="preprocessor"> if (__builtin_types_compatible_p (typeof (str), char[])) { \</span> +00191 <span class="preprocessor"> char *x = (char *)str; \</span> +00192 <span class="preprocessor"> _stp_print_cstr(x); \</span> +00193 <span class="preprocessor"> } else { \</span> +00194 <span class="preprocessor"> String x = (String)str; \</span> +00195 <span class="preprocessor"> _stp_print_string(x); \</span> +00196 <span class="preprocessor"> } \</span> +00197 <span class="preprocessor"> })</span> +00198 <span class="preprocessor"></span><span class="comment"></span> +00199 <span class="comment">/** @} */</span> +00200 <span class="preprocessor">#endif </span><span class="comment">/* _PRINT_C_ */</span> +</pre></div></body></html> |