man pages section 3: Extended Library Functions, Volume 2

dtrace_aggregate_snap (3DTRACE)

Name

dtrace_aggregate_snap - Retrieves aggregation data from the kernel

Synopsis

cc [ flag... ] file... -ldtrace [ library... ]      
#include <dtrace.h>       

int dtrace_aggregate_snap(dtrace_hdl_t *dtp)

Description

This function is called to transfer data from the in-kernel aggregation buffers to the userspace (consumer). The data is not processed at this point.

Return Values

Upon successful completion, the dtrace_aggregate_snap() function returns 0.

On failure, the dtrace_aggregate_snap() function returns -1 and sets the DTrace error number to indicate the reason for the failure. See the dtrace_errno(3DTRACE) man page for more information.

Errors

The dtrace_aggregate_snap() function will fail if:

EINVAL

dtp is NULL.

EFAULT

The system encountered an error while copying aggregation data out of the kernel.

EDT_NOTACTIVE

The DTrace handle is not active because the dtrace_go(3DTRACE) function has not been called yet.

Attributes

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

ATTRIBUTE TYPE ATTRIBUTE VALUE Architecture all Availability system/dtrace Interface Stability Committed MT-Level Safe

See Also

libdtrace(3LIB), dtrace_errno(3DTRACE), dtrace_aggregate_print(3DTRACE), dtrace_aggregate_walk(3DTRACE)