2N/A/*
2N/A * CDDL HEADER START
2N/A *
2N/A * The contents of this file are subject to the terms of the
2N/A * Common Development and Distribution License, Version 1.0 only
2N/A * (the "License"). You may not use this file except in compliance
2N/A * with the License.
2N/A *
2N/A * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
2N/A * or http://www.opensolaris.org/os/licensing.
2N/A * See the License for the specific language governing permissions
2N/A * and limitations under the License.
2N/A *
2N/A * When distributing Covered Code, include this CDDL HEADER in each
2N/A * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
2N/A * If applicable, add the following below this CDDL HEADER, with the
2N/A * fields enclosed by brackets "[]" replaced with your own identifying
2N/A * information: Portions Copyright [yyyy] [name of copyright owner]
2N/A *
2N/A * CDDL HEADER END
2N/A */
2N/A/*
2N/A * Copyright 1994,2003 Sun Microsystems, Inc. All rights reserved.
2N/A * Use is subject to license terms.
2N/A */
2N/A
2N/A#ifndef _SYS_TNF_WRITER_H
2N/A#define _SYS_TNF_WRITER_H
2N/A
2N/A#pragma ident "%Z%%M% %I% %E% SMI"
2N/A
2N/A/*
2N/A * Public interface for writing predefined TNF types
2N/A */
2N/A#include <sys/types.h>
2N/A#include <sys/tnf_com.h>
2N/A
2N/A#ifdef __cplusplus
2N/Aextern "C" {
2N/A#endif
2N/A
2N/A/*
2N/A * Defines
2N/A */
2N/A
2N/A#define TNF_OFFSETOF(s, m) ((size_t)(&(((s *)0)->m)))
2N/A#define TNF_ALIGN(type) TNF_OFFSETOF(struct { char _c; type _t; }, _t)
2N/A
2N/A/*
2N/A * Typedefs
2N/A */
2N/A
2N/Atypedef char *tnf_record_p; /* trace buffer memory ptr */
2N/Atypedef tnf_ref32_t tnf_reference_t; /* generic reference */
2N/A
2N/Atypedef struct _tnf_ops tnf_ops_t; /* opaque */
2N/Atypedef struct _tnf_tag_version tnf_tag_version_t;
2N/Atypedef struct _tnf_tag_data tnf_tag_data_t;
2N/A
2N/A/*
2N/A * In-memory reader's classification of TNF types
2N/A */
2N/A
2N/Atypedef enum {
2N/A TNF_UNKNOWN = 0,
2N/A TNF_INT32,
2N/A TNF_UINT32,
2N/A TNF_INT64,
2N/A TNF_UINT64,
2N/A TNF_FLOAT32,
2N/A TNF_FLOAT64,
2N/A TNF_STRING,
2N/A TNF_ARRAY,
2N/A TNF_STRUCT,
2N/A TNF_OPAQUE,
2N/A#ifdef _LP64
2N/A TNF_ULONG = TNF_UINT64,
2N/A TNF_LONG = TNF_INT64
2N/A#else
2N/A TNF_ULONG = TNF_UINT32,
2N/A TNF_LONG = TNF_INT32
2N/A#endif
2N/A} tnf_arg_kind_t;
2N/A
2N/A/*
2N/A * Structures
2N/A */
2N/A
2N/Astruct _tnf_tag_version {
2N/A size_t version_size; /* sizeof(tnf_tag_version_t) */
2N/A size_t tag_data_size; /* sizeof(tnf_tag_data_t) */
2N/A};
2N/A
2N/Astruct _tnf_tag_data {
2N/A tnf_tag_version_t *tag_version; /* TNF_TAG_VERSION */
2N/A tnf_record_p (*tag_desc)(tnf_ops_t *, tnf_tag_data_t *);
2N/A tnf_record_p tag_index; /* trace buffer address */
2N/A const char *tag_name; /* name */
2N/A tnf_tag_data_t ****tag_props; /* properties */
2N/A size_t tag_size; /* type_size, header_size */
2N/A size_t tag_align; /* alignment */
2N/A size_t tag_ref_size; /* reference size */
2N/A tnf_arg_kind_t tag_kind; /* type of object */
2N/A tnf_tag_data_t **tag_base; /* element_type, derived_base */
2N/A tnf_tag_data_t ***tag_slots; /* slot_types, header_types */
2N/A char **tag_slot_names; /* slot_names */
2N/A};
2N/A
2N/A/*
2N/A * TNF tag version
2N/A * A client can scan a binary's relocation table for data relocation
2N/A * entries corresponding to __tnf_tag_version_1. These identify
2N/A * tags. The actual version information is stored in an associated
2N/A * structure called __tnf_tag_version_1_info
2N/A */
2N/A
2N/Aextern tnf_tag_version_t __tnf_tag_version_1_info;
2N/A
2N/Aextern tnf_tag_version_t __tnf_tag_version_1;
2N/A#pragma weak __tnf_tag_version_1 /* placeholder: never defined */
2N/A#define TNF_TAG_VERSION &__tnf_tag_version_1
2N/A
2N/A/*
2N/A * TNF primitive types
2N/A */
2N/A
2N/Aextern tnf_tag_data_t *tnf_char_tag_data;
2N/A#define tnf_char(ops, item, ref) (item)
2N/A
2N/Aextern tnf_tag_data_t *tnf_int8_tag_data;
2N/A#define tnf_int8(ops, item, ref) (item)
2N/A
2N/Aextern tnf_tag_data_t *tnf_uint8_tag_data;
2N/A#define tnf_uint8(ops, item, ref) (item)
2N/A
2N/Aextern tnf_tag_data_t *tnf_int16_tag_data;
2N/A#define tnf_int16(ops, item, ref) (item)
2N/A
2N/Aextern tnf_tag_data_t *tnf_uint16_tag_data;
2N/A#define tnf_uint16(ops, item, ref) (item)
2N/A
2N/Aextern tnf_tag_data_t *tnf_int32_tag_data;
2N/A#define tnf_int32(ops, item, ref) (item)
2N/A
2N/Aextern tnf_tag_data_t *tnf_uint32_tag_data;
2N/A#define tnf_uint32(ops, item, ref) (item)
2N/A
2N/Aextern tnf_tag_data_t *tnf_int64_tag_data;
2N/A#define tnf_int64(ops, item, ref) (item)
2N/A
2N/Aextern tnf_tag_data_t *tnf_uint64_tag_data;
2N/A#define tnf_uint64(ops, item, ref) (item)
2N/A
2N/Aextern tnf_tag_data_t *tnf_float32_tag_data;
2N/A#define tnf_float32(ops, item, ref) (item)
2N/A
2N/Aextern tnf_tag_data_t *tnf_float64_tag_data;
2N/A#define tnf_float64(ops, item, ref) (item)
2N/A
2N/A/*
2N/A * ``Portable'' primitive types
2N/A * These are defined as the well-defined TNF types they map into.
2N/A * XXX Machine-dependent
2N/A */
2N/A
2N/Atypedef tnf_uint8_t tnf_uchar_t;
2N/A#define tnf_uchar(ops, item, ref) tnf_uint8(ops, item, ref)
2N/A#define tnf_uchar_tag_data tnf_uint8_tag_data
2N/A
2N/Atypedef tnf_int16_t tnf_short_t;
2N/A#define tnf_short(ops, item, ref) tnf_int16(ops, item, ref)
2N/A#define tnf_short_tag_data tnf_int16_tag_data
2N/A
2N/Atypedef tnf_uint16_t tnf_ushort_t;
2N/A#define tnf_ushort(ops, item, ref) tnf_uint16(ops, item, ref)
2N/A#define tnf_ushort_tag_data tnf_uint16_tag_data
2N/A
2N/Atypedef tnf_int32_t tnf_int_t;
2N/A#define tnf_int(ops, item, ref) tnf_int32(ops, item, ref)
2N/A#define tnf_int_tag_data tnf_int32_tag_data
2N/A
2N/Atypedef tnf_uint32_t tnf_uint_t;
2N/A#define tnf_uint(ops, item, ref) tnf_uint32(ops, item, ref)
2N/A#define tnf_uint_tag_data tnf_uint32_tag_data
2N/A
2N/A#if defined(_LP64)
2N/A
2N/Atypedef tnf_int64_t tnf_long_t;
2N/A#define tnf_long(ops, item, ref) tnf_int64(ops, item, ref)
2N/A#define tnf_long_tag_data tnf_int64_tag_data
2N/A
2N/Atypedef tnf_uint64_t tnf_ulong_t;
2N/A#define tnf_ulong(ops, item, ref) tnf_uint64(ops, item, ref)
2N/A#define tnf_ulong_tag_data tnf_uint64_tag_data
2N/A
2N/A#else
2N/A
2N/Atypedef tnf_int32_t tnf_long_t;
2N/A#define tnf_long(ops, item, ref) tnf_int32(ops, item, ref)
2N/A#define tnf_long_tag_data tnf_int32_tag_data
2N/A
2N/Atypedef tnf_uint32_t tnf_ulong_t;
2N/A#define tnf_ulong(ops, item, ref) tnf_uint32(ops, item, ref)
2N/A#define tnf_ulong_tag_data tnf_uint32_tag_data
2N/A
2N/A#endif /* defined(_LP64) */
2N/A
2N/Atypedef tnf_int64_t tnf_longlong_t;
2N/A#define tnf_longlong(ops, item, ref) tnf_int64(ops, item, ref)
2N/A#define tnf_longlong_tag_data tnf_int64_tag_data
2N/A
2N/Atypedef tnf_uint64_t tnf_ulonglong_t;
2N/A#define tnf_ulonglong(ops, item, ref) tnf_uint64(ops, item, ref)
2N/A#define tnf_ulonglong_tag_data tnf_uint64_tag_data
2N/A
2N/Atypedef tnf_float32_t tnf_float_t;
2N/A#define tnf_float(ops, item, ref) tnf_float32(ops, item, ref)
2N/A#define tnf_float_tag_data tnf_float32_tag_data
2N/A
2N/Atypedef tnf_float64_t tnf_double_t;
2N/A#define tnf_double(ops, item, ref) tnf_float64(ops, item, ref)
2N/A#define tnf_double_tag_data tnf_float64_tag_data
2N/A
2N/A/*
2N/A * Derived and aggregate TNF types
2N/A */
2N/A
2N/A/* Not explicitly represented in type system */
2N/A#define tnf_ref32(ops, item, ref) \
2N/A tnf_ref32_1(ops, item, ref)
2N/A
2N/Aextern tnf_tag_data_t *tnf_tag_tag_data;
2N/Atypedef tnf_ref32_t tnf_tag_t;
2N/A#define tnf_tag(ops, item, ref) \
2N/A (tnf_ref32(ops, item, ref) | TNF_REF32_T_TAG)
2N/A
2N/Aextern tnf_tag_data_t *tnf_string_tag_data;
2N/Atypedef tnf_reference_t tnf_string_t;
2N/A#define tnf_string(ops, item, ref) \
2N/A tnf_string_1(ops, item, ref, tnf_string_tag_data)
2N/A
2N/Aextern tnf_tag_data_t *tnf_name_tag_data;
2N/Atypedef tnf_string_t tnf_name_t;
2N/A#define tnf_name(ops, item, ref) \
2N/A tnf_string_1(ops, item, ref, tnf_name_tag_data)
2N/A
2N/Aextern tnf_tag_data_t *tnf_size_tag_data;
2N/Atypedef tnf_ulong_t tnf_size_t;
2N/A#define tnf_size(ops, item, ref) \
2N/A tnf_ulong(ops, item, ref)
2N/A
2N/Aextern tnf_tag_data_t *tnf_opaque_tag_data;
2N/A
2N/A#if defined(_LP64)
2N/A
2N/Atypedef tnf_uint64_t tnf_opaque_t;
2N/A#define tnf_opaque(ops, item, ref) \
2N/A ((tnf_uint64_t)(item))
2N/A
2N/A#else
2N/A
2N/Atypedef tnf_uint32_t tnf_opaque_t;
2N/A#define tnf_opaque(ops, item, ref) \
2N/A ((tnf_uint32_t)(item))
2N/A
2N/A#endif /* defined(_LP64) */
2N/A
2N/A/*
2N/A * TNF types for tracing
2N/A */
2N/A
2N/Aextern tnf_tag_data_t *tnf_time_base_tag_data;
2N/Atypedef tnf_int64_t tnf_time_base_t;
2N/A#define tnf_time_base(ops, item, ref) \
2N/A tnf_int64(ops, item, ref)
2N/A
2N/Aextern tnf_tag_data_t *tnf_time_delta_tag_data;
2N/Atypedef tnf_uint32_t tnf_time_delta_t;
2N/A#define tnf_time_delta(ops, item, ref) \
2N/A tnf_uint32(ops, item, ref)
2N/A
2N/Aextern tnf_tag_data_t *tnf_probe_event_tag_data;
2N/Atypedef tnf_ref32_t tnf_probe_event_t;
2N/A#define tnf_probe_event(ops, item, ref) \
2N/A ((tnf_ref32_t)(item) | TNF_REF32_T_PAIR)
2N/A
2N/A/* process ID */
2N/Aextern tnf_tag_data_t *tnf_pid_tag_data;
2N/Atypedef tnf_int32_t tnf_pid_t;
2N/A#define tnf_pid(ops, item, ref) \
2N/A tnf_int32(ops, item, ref)
2N/A
2N/A/* LWP ID */
2N/Aextern tnf_tag_data_t *tnf_lwpid_tag_data;
2N/Atypedef tnf_uint32_t tnf_lwpid_t;
2N/A#define tnf_lwpid(ops, item, ref) \
2N/A tnf_uint32(ops, item, ref)
2N/A
2N/A#ifdef _KERNEL
2N/A
2N/A/* kernel thread ID */
2N/Aextern tnf_tag_data_t *tnf_kthread_id_tag_data;
2N/Atypedef tnf_opaque_t tnf_kthread_id_t;
2N/A#define tnf_kthread_id(ops, item, ref) \
2N/A tnf_opaque(ops, item, ref)
2N/A
2N/A/* processor ID */
2N/Aextern tnf_tag_data_t *tnf_cpuid_tag_data;
2N/Atypedef tnf_int32_t tnf_cpuid_t;
2N/A#define tnf_cpuid(ops, item, ref) \
2N/A tnf_int32(ops, item, ref)
2N/A
2N/A/* device ID */
2N/Aextern tnf_tag_data_t *tnf_device_tag_data;
2N/Atypedef tnf_ulong_t tnf_device_t;
2N/A#define tnf_device(ops, item, ref) \
2N/A tnf_ulong(ops, item, ref)
2N/A
2N/A/* kernel symbol */
2N/Aextern tnf_tag_data_t *tnf_symbol_tag_data;
2N/Atypedef tnf_opaque_t tnf_symbol_t;
2N/A#define tnf_symbol(ops, item, ref) \
2N/A tnf_opaque(ops, item, ref)
2N/A
2N/A/* array of symbols */
2N/Aextern tnf_tag_data_t *tnf_symbols_tag_data;
2N/Atypedef tnf_ref32_t tnf_symbols_t;
2N/A
2N/A#if defined(__sparc)
2N/A#define tnf_symbols(ops, item, ref) \
2N/A tnf_opaque32_array_1(ops, item, ref, tnf_symbols_tag_data)
2N/A#else /* defined(__sparc) */
2N/A#define tnf_symbols(ops, item, ref) \
2N/A tnf_opaque_array_1(ops, item, ref, tnf_symbols_tag_data)
2N/A#endif /* defined(__sparc) */
2N/A
2N/A/* system call number */
2N/Aextern tnf_tag_data_t *tnf_sysnum_tag_data;
2N/Atypedef tnf_int16_t tnf_sysnum_t;
2N/A#define tnf_sysnum(ops, item, ref) \
2N/A tnf_int16(ops, item, ref)
2N/A
2N/A/* thread microstate XXX enum */
2N/A/* XXX should have a new type tnf_enum of appropriate size to map C enum's */
2N/A/* XXX cast below is to avoid lint warnings */
2N/Aextern tnf_tag_data_t *tnf_microstate_tag_data;
2N/Atypedef tnf_int32_t tnf_microstate_t;
2N/A#define tnf_microstate(ops, item, ref) \
2N/A tnf_int32(ops, (tnf_int32_t)(item), ref)
2N/A
2N/A/* file offset */
2N/Aextern tnf_tag_data_t *tnf_offset_tag_data;
2N/Atypedef tnf_int64_t tnf_offset_t;
2N/A#define tnf_offset(ops, item, ref) \
2N/A tnf_int64(ops, item, ref)
2N/A
2N/A/* address fault type XXX enum */
2N/A/* XXX should have a new type tnf_enum of appropriate size to map C enum's */
2N/A/* XXX cast below is to avoid lint warnings */
2N/Aextern tnf_tag_data_t *tnf_fault_type_tag_data;
2N/Atypedef tnf_int32_t tnf_fault_type_t;
2N/A#define tnf_fault_type(ops, item, ref) \
2N/A tnf_int32(ops, (tnf_int32_t)(item), ref)
2N/A
2N/A/* segment access type XXX enum */
2N/A/* XXX should have a new type tnf_enum of appropriate size to map C enum's */
2N/A/* XXX cast below is to avoid lint warnings */
2N/Aextern tnf_tag_data_t *tnf_seg_access_tag_data;
2N/Atypedef tnf_int32_t tnf_seg_access_t;
2N/A#define tnf_seg_access(ops, item, ref) \
2N/A tnf_int32(ops, (tnf_int32_t)(item), ref)
2N/A
2N/A/* buffered I/O flags */
2N/Aextern tnf_tag_data_t *tnf_bioflags_tag_data;
2N/Atypedef tnf_int32_t tnf_bioflags_t;
2N/A#define tnf_bioflags(ops, item, ref) \
2N/A tnf_int32(ops, item, ref)
2N/A
2N/A/* disk block addresses */
2N/Aextern tnf_tag_data_t *tnf_diskaddr_tag_data;
2N/Atypedef tnf_int64_t tnf_diskaddr_t;
2N/A#define tnf_diskaddr(ops, item, ref) \
2N/A tnf_int64(ops, item, ref)
2N/A
2N/A#endif /* _KERNEL */
2N/A
2N/A/*
2N/A * Type extension interface
2N/A */
2N/A
2N/Aextern tnf_tag_data_t ***tnf_user_struct_properties;
2N/A
2N/A/*
2N/A * Data encoders
2N/A */
2N/A
2N/Aextern tnf_ref32_t tnf_ref32_1(tnf_ops_t *,
2N/A tnf_record_p,
2N/A tnf_record_p);
2N/A
2N/Aextern tnf_reference_t tnf_string_1(tnf_ops_t *,
2N/A const char *,
2N/A tnf_record_p,
2N/A tnf_tag_data_t *);
2N/A
2N/A#ifdef _KERNEL
2N/A
2N/Aextern tnf_reference_t tnf_opaque_array_1(tnf_ops_t *,
2N/A tnf_opaque_t *,
2N/A tnf_record_p,
2N/A tnf_tag_data_t *);
2N/A
2N/A#ifdef __sparc
2N/Aextern tnf_reference_t tnf_opaque32_array_1(tnf_ops_t *,
2N/A tnf_uint32_t *,
2N/A tnf_record_p,
2N/A tnf_tag_data_t *);
2N/A#endif /* __sparc */
2N/A
2N/A#endif /* _KERNEL */
2N/A
2N/A/*
2N/A * Tag descriptors
2N/A */
2N/A
2N/Aextern tnf_record_p tnf_struct_tag_1(tnf_ops_t *, tnf_tag_data_t *);
2N/A
2N/A/*
2N/A * Buffer memory allocator
2N/A */
2N/A
2N/Aextern void *tnf_allocate(tnf_ops_t *, size_t);
2N/A
2N/A/*
2N/A * Weak symbol definitions to allow unprobed operation
2N/A */
2N/A
2N/A#if !defined(_KERNEL) && !defined(_TNF_LIBRARY)
2N/A
2N/A#pragma weak __tnf_tag_version_1_info
2N/A
2N/A#pragma weak tnf_char_tag_data
2N/A#pragma weak tnf_int8_tag_data
2N/A#pragma weak tnf_uint8_tag_data
2N/A#pragma weak tnf_int16_tag_data
2N/A#pragma weak tnf_uint16_tag_data
2N/A#pragma weak tnf_int32_tag_data
2N/A#pragma weak tnf_uint32_tag_data
2N/A#pragma weak tnf_int64_tag_data
2N/A#pragma weak tnf_uint64_tag_data
2N/A#pragma weak tnf_float32_tag_data
2N/A#pragma weak tnf_float64_tag_data
2N/A
2N/A#pragma weak tnf_tag_tag_data
2N/A#pragma weak tnf_string_tag_data
2N/A#pragma weak tnf_name_tag_data
2N/A#pragma weak tnf_opaque_tag_data
2N/A#pragma weak tnf_size_tag_data
2N/A
2N/A#pragma weak tnf_probe_event_tag_data
2N/A#pragma weak tnf_time_delta_tag_data
2N/A
2N/A#pragma weak tnf_user_struct_properties
2N/A
2N/A#pragma weak tnf_ref32_1
2N/A#pragma weak tnf_string_1
2N/A#pragma weak tnf_struct_tag_1
2N/A#pragma weak tnf_allocate
2N/A
2N/A#endif /* !defined(_KERNEL) || !defined(_TNF_LIBRARY) */
2N/A
2N/A#ifdef __cplusplus
2N/A}
2N/A#endif
2N/A
2N/A#endif /* _SYS_TNF_WRITER_H */
2N/A