From 3d4bc8bea6b45893bd4b49f44df26bd602b4cba5 Mon Sep 17 00:00:00 2001 From: hunt Date: Thu, 7 Apr 2005 15:17:29 +0000 Subject: Update to use relayfs. --- runtime/docs/html/group__scbuf.html | 70 ++++++++++++++++++++++++++++--------- 1 file changed, 54 insertions(+), 16 deletions(-) (limited to 'runtime/docs/html/group__scbuf.html') diff --git a/runtime/docs/html/group__scbuf.html b/runtime/docs/html/group__scbuf.html index c5e0d6e0..89033737 100644 --- a/runtime/docs/html/group__scbuf.html +++ b/runtime/docs/html/group__scbuf.html @@ -17,29 +17,26 @@ void _stp_sprint (const char *fmt,...)  Sprint into the scratch buffer.
- -void _stp_sprint_str (const char *str) +void _stp_sprint_str (const char *str) -void _stp_scbuf_clear (void) + Write a string into the scratch buffer.
+char * _stp_scbuf_clear (void)  Clear the scratch buffer.
-

Variables

- -char _stp_scbuf [8191+1] - - Scratch buffer for printing, building strings, etc.

Detailed Description

Scratch Buffer Functions.

-The scratch buffer is for collecting output before storing in a map, printing, etc. This is a per-cpu static buffer. It is necessary because of the limited stack space available in the kernel.


Function Documentation

+The scratch buffer is for collecting output before storing in a map, printing, etc. This is a per-cpu static buffer. It is necessary because of the limited stack space available in the kernel.

+

Todo:
Need careful review of these to insure safety.
+

Function Documentation

- + @@ -60,11 +57,12 @@ The scratch buffer is for collecting output before storing in a map, printing, e

Clear the scratch buffer.

-Output from _stp_sprint() will accumulate in the buffer until this is called. +This function should be called before anything is written to the scratch buffer. Output will accumulate in the buffer until this function is called again.

Returns:
A pointer to the buffer.
+

-Definition at line 59 of file scbuf.c. +Definition at line 74 of file scbuf.c.

-References _stp_scbuf, and STP_BUF_LEN. +References STP_BUF_LEN.

void _stp_scbuf_clear char* _stp_scbuf_clear void 

@@ -103,7 +101,7 @@ References _stp_scbuf, and

Sprint into the scratch buffer.

-Like printf, except output goes into _stp_scbuf, which will contain the null-terminated output. Safe because overflowing _stp_scbuf is not allowed. Size is limited by length of scratch buffer, STP_BUF_LEN.

+Like printf, except output goes into a global scratch buffer which will contain the null-terminated output. Safe because overflowing the buffer is not allowed. Size is limited by length of scratch buffer, STP_BUF_LEN.

Parameters:
@@ -112,11 +110,51 @@ Like printf, except output goes into
See also:
_stp_scbuf_clear

-Definition at line 32 of file scbuf.c. +Definition at line 34 of file scbuf.c.

-References _stp_scbuf, and STP_BUF_LEN. +References STP_BUF_LEN.

Referenced by _stp_symbol_sprint().

fmt A printf-style format string followed by a variable number of args.
+

+ + + + +
+ + + + + + + + + +
void _stp_sprint_str const char *  str  ) 
+
+ + + + + +
+   + + +

+Write a string into the scratch buffer. +

+Copies a string into a global scratch buffer. Safe because overflowing the buffer is not allowed. Size is limited by length of scratch buffer, STP_BUF_LEN. This is more efficient than using _stp_sprint().

+

Parameters:
+ + +
str A string.
+
+ +

+Definition at line 56 of file scbuf.c. +

+References STP_BUF_LEN.

-- cgit