Print Buffer

Print Buffer Functions. More...

Defines
#define	STP_PRINT_BUF_LEN   8000
	Size of buffer, not including terminating NULL.
#define	TIMESTAMP_SIZE   19
#define	STP_PRINT_BUF_START   (TIMESTAMP_SIZE + 1)
#define	_stp_print(str)
	Write a String or C string into the print buffer.
Functions
void	_stp_print_flush (void)
	Send the print buffer now.
void	_stp_printf (const char *fmt,...)
	Print into the print buffer.
void	_stp_vprintf (const char *fmt, va_list args)
	Print into the print buffer.
void	_stp_print_cstr (const char *str)
	Write a C string into the print buffer.
char *	_stp_print_clear (void)
	Clear the scratch buffer.
void	_stp_print_string (String str)
	Write a String into the print buffer.

---

Detailed Description

Print Buffer Functions.

The print buffer is for collecting output to send to the user daemon. This is a per-cpu static buffer. The buffer is sent when _stp_print_flush() is called.

The reason to do this is to allow multiple small prints to be combined then timestamped and sent together to stpd. It could flush automatically on newlines, but what about stack traces which span many lines? So try this and see how it works for us.

---

Define Documentation

#define _stp_print (  str   )

Value: ({ \ if (__builtin_types_compatible_p (typeof (str), char[])) { \ char *x = (char *)str; \ _stp_print_cstr(x); \ } else { \ String x = (String)str; \ _stp_print_string(x); \ } \ }) Write a String or C string into the print buffer. This macro selects the proper function to call. Parameters: str  A String or C string (char *) See also: _stp_print_cstr _stp_print_string Definition at line 188 of file print.c.

---

Function Documentation

char* _stp_print_clear (  void   )

Clear the scratch buffer. 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 156 of file print.c.

void _stp_print_cstr (  const char *  str  )

Write a C string into the print buffer. Copies a string into a print buffer. Safe because overflowing the buffer is not allowed. Size is limited by length of print buffer, STP_PRINT_BUF_LEN. This is more efficient than using _stp_printf() if you don't need fancy formatting. Parameters: str  A C string. See also: _stp_print Definition at line 138 of file print.c. References STP_PRINT_BUF_LEN. Referenced by _stp_print_string().

void _stp_print_flush (  void   )

Send the print buffer now. Output accumulates in the print buffer until this is called. Size is limited by length of print buffer, STP_PRINT_BUF_LEN. Definition at line 65 of file print.c.

void _stp_print_string (  String  str  )

Write a String into the print buffer. Copies a String into a print buffer. Safe because overflowing the buffer is not allowed. Size is limited by length of print buffer, STP_PRINT_BUF_LEN. This is more efficient than using _stp_printf() if you don't need fancy formatting. Parameters: str  A String. See also: _stp_print Definition at line 176 of file print.c. References _stp_print_cstr().

void _stp_printf (  const char *  fmt,   ... )

Print into the print buffer. Like printf, except output goes to the print buffer. Safe because overflowing the buffer is not allowed. Size is limited by length of print buffer, STP_PRINT_BUF_LEN. Parameters: fmt  A printf-style format string followed by a variable number of args. See also: _stp_print_flush() Definition at line 99 of file print.c. References STP_PRINT_BUF_LEN. Referenced by _stp_symbol_print().

void _stp_vprintf (  const char *  fmt, va_list  args )

Print into the print buffer. Use this if your function already has a va_list. You probably want _stp_printf(). Definition at line 117 of file print.c. References STP_PRINT_BUF_LEN.