#include <cafe/os/OSSystemLog.h> BOOL OSLogReport(u32 retrievalOptions, void* pWorkspace, u32 workSpaceSize);
|retrievalOptions||Bitmap of options which may reduce the amount of reported events. Multiple options may be expressed by bitwise OR-ing them together. For more information, see OS Log Retrieval Options.|
|pWorkspace||The act of retrieving and displaying the contents of the event
log requires a workspace buffer. The caller may specify a larger buffer to see
deeper event log history. The size of the specified workspace must be greater
|workSpaceSize||Size of available memory referred to by pWorkspace.|
||default||Corresponding with a numeric value of zero, this definition does not specify
any options. Default behavior is assumed, reporting all logged events, subject
to filter policy established by
||core exclusion||Exclude events logged by specific cores.|
||usermode log level exclusion||Exclude specific usermode event levels. Note that events at these levels may still be occupying space in the log. These options just prevent them from being reported.|
||kernelmode log level exclusion||Exclude specific kernelmode event levels. Note that events at these levels may still be occupying space in the log. These options just prevent them from being reported.|
||retrieve all||When set, no events shall be excluded during the retrieval process. Any
other retrievalOptions bits for excluding events are ignored. Filter policy
TRUE if successful,
FALSE if unsuccessful.
Displays the contents of the event log using
OSReport. Each log
entry is reported with at least one line of output, potentially more for entries
containing variable length or printable data.
There are several fields in the reported log entry. The following example log output line will be considered when describing reported log fields below.
001 7779825 U2 15 e. 1-003 00000068 00000069 0000006a 0000006b En functionCallWithFourArgs @ line 666
||Log session, which may increment across OS restarts. In some cases the OS event log will persist across normal OS restarts. This field is used to differentiate booted log sessions.|
||Timestamp since system startup in units of microseconds.|
||CPU core ID on which the code that submitted the log entry was executing.|
||Process ID of the executing code that submitted the log entry.|
||Level of the logged event.|
||Category of the logged event.|
||Arbitrary word arguments passed when log was submitted. These fields are
optional and may not be present for some entries. Only these OS Log API are
capable of submitting arguments:
||When OS Log API
||When OS Log API
Specification of retrievalOptions argument may exclude some events which
currently exist in the log. Events that currently exist in the log but are
excluded because of subsequent policy established by
not reported unless the
OS_LOG_RETRIEVAL_OPT_IGNORE_FILTERS_MASK option is
2015-03-11 Various style fixes.
2013-05-08 Automated cleanup pass.
2012-05-23 Initial version.