bb_event(3EXT)

NAME | SYNOPSIS | API RESTRICTIONS | ARGUMENTS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO

NAME

bb_event- adds an event to the black box

SYNOPSIS

$(OS_DIR)/lib/libblackbox.a
#include <sys/blackbox.h>

void bb_event(const char *tag, bb_severity_t severity, const char *fmt, ...);

API RESTRICTIONS

The function or functions documented here may not be used safely in all application contexts with all APIs provided in the ChorusOS 5.0 product.

See API(5FEA) for details.

ARGUMENTS

tag(IN):

a label for this event, to enable fine-grained filtering

severity(IN):

an integer between 0 and 31, indicating the severity of the event. Larger values indicate higher severities.

fmt(IN):

the format (e.g. printf()) of the message.

DESCRIPTION

bb_event() adds an event to the black box.

The data to be logged is given by a printf()-style format string and a varargs-style set of arguments corresponding to the format specifiers in the format string. bb_event() expands the format string and the arguments as described in sprintf().

The format characters allowed are those specified in sprintf(), with the addition of %x, %p (as specified in printf()), and without the %ll (long long), or %b ("bits") conversion characters. Also, bb_event() does not check the validity of a %s pointer in supervisor mode.

A maximum of (BB_MSG_MAX-1) characters of the data, after format string expansion, will be stored in the black box. Process

Process names and tags are limited to BB_PNAME_MAX and BB_TAG_MAX respectively.

If the given severity is out of range (not between 0 and 31 inclusive), the event will be treated as if it had a severity of 0, and will be subject to filtering as such.

This routine will never block for I/O or on a condition variable.

RETURN VALUES

None.

ERRORS

No errors are defined.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Evolving

SEE ALSO

printf(3STDC)

sprintf(3STDC)

ChorusOS 5.0  Last Revised December 2001

NAME | SYNOPSIS | API RESTRICTIONS | ARGUMENTS | DESCRIPTION | RETURN VALUES | ERRORS | ATTRIBUTES | SEE ALSO