trcgen or trcgent Subroutine

Base Operating System and Extensions Technical Reference, Volume 2

trcgen or trcgent Subroutine

Purpose

Records a trace event for a generic trace channel.

Library

Runtime Services Library (librts.a)

Syntax

#include <sys/trchkid.h>

void trcgen(Channel, HkWord, DataWord, Length, Buffer)
unsigned int Channel, HkWord, DataWord, Length;
char *Buffer;

void trcgent(Channel, HkWord, DataWord, Length, Buffer)
unsigned int Channel, HkWord, DataWord, Length;
char *Buffer;

Description

The trcgen subroutine records a trace event for a generic trace entry consisting of a hook word, a data word, and a variable number of bytes of trace data. The trcgent subroutine records a trace event for a generic trace entry consisting of a hook word, a data word, a variable number of bytes of trace data, and a time stamp.

The trcgen subroutine and trcgent subroutine are located in pinned kernel memory.

Parameters

Buffer

Specifies a pointer to a buffer of trace data. The maximum size of the trace data is 4096 bytes.

Channel

Specifies a channel number for the trace session, obtained from the trcstart subroutine.

DataWord

Specifies a word of user-defined data.

HkWord

Specifies an integer consisting of two bytes of user-defined data (HkData), a hook ID (HkID), and a hook type (Hk_Type).

HkData

Specifies two bytes of user-defined data.

HkID

Specifies a hook identifier. For user programs, the hook ID value ranges from 010 to 0FF.

Hk_Type

Specifies a 4-bit value that identifies the amount of trace data to be recorded:

Value	Records
1	Hook word
9	Hook word and a time stamp
2	Hook word and one data word
A	Hook word, one data word, and a time stamp
6	Hook word and up to five data words
E	Hook word, up to five data words, and a time stamp.

Length

Specifies the length in bytes of the Buffer parameter.

Implementation Specifics

This subroutine is part of Base Operating System (BOS) Runtime.

Related Information

The trchook subroutine, trcoff subroutine, trcon subroutine, trcstart subroutine, trcstop subroutine.

The trace daemon.

The trcgenk kernel service, trcgenkt kernel service.