1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 1994,2003 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _SYS_TNF_WRITER_H
#define _SYS_TNF_WRITER_H
#pragma ident "%Z%%M% %I% %E% SMI"
/*
* Public interface for writing predefined TNF types
*/
#include <sys/types.h>
#include <sys/tnf_com.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* Defines
*/
#define TNF_OFFSETOF(s, m) ((size_t)(&(((s *)0)->m)))
#define TNF_ALIGN(type) TNF_OFFSETOF(struct { char _c; type _t; }, _t)
/*
* Typedefs
*/
typedef char *tnf_record_p; /* trace buffer memory ptr */
typedef tnf_ref32_t tnf_reference_t; /* generic reference */
typedef struct _tnf_ops tnf_ops_t; /* opaque */
typedef struct _tnf_tag_version tnf_tag_version_t;
typedef struct _tnf_tag_data tnf_tag_data_t;
/*
* In-memory reader's classification of TNF types
*/
typedef enum {
TNF_UNKNOWN = 0,
TNF_INT32,
TNF_UINT32,
TNF_INT64,
TNF_UINT64,
TNF_FLOAT32,
TNF_FLOAT64,
TNF_STRING,
TNF_ARRAY,
TNF_STRUCT,
TNF_OPAQUE,
#ifdef _LP64
TNF_ULONG = TNF_UINT64,
TNF_LONG = TNF_INT64
#else
TNF_ULONG = TNF_UINT32,
TNF_LONG = TNF_INT32
#endif
} tnf_arg_kind_t;
/*
* Structures
*/
struct _tnf_tag_version {
size_t version_size; /* sizeof(tnf_tag_version_t) */
size_t tag_data_size; /* sizeof(tnf_tag_data_t) */
};
struct _tnf_tag_data {
tnf_tag_version_t *tag_version; /* TNF_TAG_VERSION */
tnf_record_p (*tag_desc)(tnf_ops_t *, tnf_tag_data_t *);
tnf_record_p tag_index; /* trace buffer address */
const char *tag_name; /* name */
tnf_tag_data_t ****tag_props; /* properties */
size_t tag_size; /* type_size, header_size */
size_t tag_align; /* alignment */
size_t tag_ref_size; /* reference size */
tnf_arg_kind_t tag_kind; /* type of object */
tnf_tag_data_t **tag_base; /* element_type, derived_base */
tnf_tag_data_t ***tag_slots; /* slot_types, header_types */
char **tag_slot_names; /* slot_names */
};
/*
* TNF tag version
* A client can scan a binary's relocation table for data relocation
* entries corresponding to __tnf_tag_version_1. These identify
* tags. The actual version information is stored in an associated
* structure called __tnf_tag_version_1_info
*/
extern tnf_tag_version_t __tnf_tag_version_1_info;
extern tnf_tag_version_t __tnf_tag_version_1;
#pragma weak __tnf_tag_version_1 /* placeholder: never defined */
#define TNF_TAG_VERSION &__tnf_tag_version_1
/*
* TNF primitive types
*/
extern tnf_tag_data_t *tnf_char_tag_data;
#define tnf_char(ops, item, ref) (item)
extern tnf_tag_data_t *tnf_int8_tag_data;
#define tnf_int8(ops, item, ref) (item)
extern tnf_tag_data_t *tnf_uint8_tag_data;
#define tnf_uint8(ops, item, ref) (item)
extern tnf_tag_data_t *tnf_int16_tag_data;
#define tnf_int16(ops, item, ref) (item)
extern tnf_tag_data_t *tnf_uint16_tag_data;
#define tnf_uint16(ops, item, ref) (item)
extern tnf_tag_data_t *tnf_int32_tag_data;
#define tnf_int32(ops, item, ref) (item)
extern tnf_tag_data_t *tnf_uint32_tag_data;
#define tnf_uint32(ops, item, ref) (item)
extern tnf_tag_data_t *tnf_int64_tag_data;
#define tnf_int64(ops, item, ref) (item)
extern tnf_tag_data_t *tnf_uint64_tag_data;
#define tnf_uint64(ops, item, ref) (item)
extern tnf_tag_data_t *tnf_float32_tag_data;
#define tnf_float32(ops, item, ref) (item)
extern tnf_tag_data_t *tnf_float64_tag_data;
#define tnf_float64(ops, item, ref) (item)
/*
* ``Portable'' primitive types
* These are defined as the well-defined TNF types they map into.
* XXX Machine-dependent
*/
typedef tnf_uint8_t tnf_uchar_t;
#define tnf_uchar(ops, item, ref) tnf_uint8(ops, item, ref)
#define tnf_uchar_tag_data tnf_uint8_tag_data
typedef tnf_int16_t tnf_short_t;
#define tnf_short(ops, item, ref) tnf_int16(ops, item, ref)
#define tnf_short_tag_data tnf_int16_tag_data
typedef tnf_uint16_t tnf_ushort_t;
#define tnf_ushort(ops, item, ref) tnf_uint16(ops, item, ref)
#define tnf_ushort_tag_data tnf_uint16_tag_data
typedef tnf_int32_t tnf_int_t;
#define tnf_int(ops, item, ref) tnf_int32(ops, item, ref)
#define tnf_int_tag_data tnf_int32_tag_data
typedef tnf_uint32_t tnf_uint_t;
#define tnf_uint(ops, item, ref) tnf_uint32(ops, item, ref)
#define tnf_uint_tag_data tnf_uint32_tag_data
#if defined(_LP64)
typedef tnf_int64_t tnf_long_t;
#define tnf_long(ops, item, ref) tnf_int64(ops, item, ref)
#define tnf_long_tag_data tnf_int64_tag_data
typedef tnf_uint64_t tnf_ulong_t;
#define tnf_ulong(ops, item, ref) tnf_uint64(ops, item, ref)
#define tnf_ulong_tag_data tnf_uint64_tag_data
#else
typedef tnf_int32_t tnf_long_t;
#define tnf_long(ops, item, ref) tnf_int32(ops, item, ref)
#define tnf_long_tag_data tnf_int32_tag_data
typedef tnf_uint32_t tnf_ulong_t;
#define tnf_ulong(ops, item, ref) tnf_uint32(ops, item, ref)
#define tnf_ulong_tag_data tnf_uint32_tag_data
#endif /* defined(_LP64) */
typedef tnf_int64_t tnf_longlong_t;
#define tnf_longlong(ops, item, ref) tnf_int64(ops, item, ref)
#define tnf_longlong_tag_data tnf_int64_tag_data
typedef tnf_uint64_t tnf_ulonglong_t;
#define tnf_ulonglong(ops, item, ref) tnf_uint64(ops, item, ref)
#define tnf_ulonglong_tag_data tnf_uint64_tag_data
typedef tnf_float32_t tnf_float_t;
#define tnf_float(ops, item, ref) tnf_float32(ops, item, ref)
#define tnf_float_tag_data tnf_float32_tag_data
typedef tnf_float64_t tnf_double_t;
#define tnf_double(ops, item, ref) tnf_float64(ops, item, ref)
#define tnf_double_tag_data tnf_float64_tag_data
/*
* Derived and aggregate TNF types
*/
/* Not explicitly represented in type system */
#define tnf_ref32(ops, item, ref) \
tnf_ref32_1(ops, item, ref)
extern tnf_tag_data_t *tnf_tag_tag_data;
typedef tnf_ref32_t tnf_tag_t;
#define tnf_tag(ops, item, ref) \
(tnf_ref32(ops, item, ref) | TNF_REF32_T_TAG)
extern tnf_tag_data_t *tnf_string_tag_data;
typedef tnf_reference_t tnf_string_t;
#define tnf_string(ops, item, ref) \
tnf_string_1(ops, item, ref, tnf_string_tag_data)
extern tnf_tag_data_t *tnf_name_tag_data;
typedef tnf_string_t tnf_name_t;
#define tnf_name(ops, item, ref) \
tnf_string_1(ops, item, ref, tnf_name_tag_data)
extern tnf_tag_data_t *tnf_size_tag_data;
typedef tnf_ulong_t tnf_size_t;
#define tnf_size(ops, item, ref) \
tnf_ulong(ops, item, ref)
extern tnf_tag_data_t *tnf_opaque_tag_data;
#if defined(_LP64)
typedef tnf_uint64_t tnf_opaque_t;
#define tnf_opaque(ops, item, ref) \
((tnf_uint64_t)(item))
#else
typedef tnf_uint32_t tnf_opaque_t;
#define tnf_opaque(ops, item, ref) \
((tnf_uint32_t)(item))
#endif /* defined(_LP64) */
/*
* TNF types for tracing
*/
extern tnf_tag_data_t *tnf_time_base_tag_data;
typedef tnf_int64_t tnf_time_base_t;
#define tnf_time_base(ops, item, ref) \
tnf_int64(ops, item, ref)
extern tnf_tag_data_t *tnf_time_delta_tag_data;
typedef tnf_uint32_t tnf_time_delta_t;
#define tnf_time_delta(ops, item, ref) \
tnf_uint32(ops, item, ref)
extern tnf_tag_data_t *tnf_probe_event_tag_data;
typedef tnf_ref32_t tnf_probe_event_t;
#define tnf_probe_event(ops, item, ref) \
((tnf_ref32_t)(item) | TNF_REF32_T_PAIR)
/* process ID */
extern tnf_tag_data_t *tnf_pid_tag_data;
typedef tnf_int32_t tnf_pid_t;
#define tnf_pid(ops, item, ref) \
tnf_int32(ops, item, ref)
/* LWP ID */
extern tnf_tag_data_t *tnf_lwpid_tag_data;
typedef tnf_uint32_t tnf_lwpid_t;
#define tnf_lwpid(ops, item, ref) \
tnf_uint32(ops, item, ref)
#ifdef _KERNEL
/* kernel thread ID */
extern tnf_tag_data_t *tnf_kthread_id_tag_data;
typedef tnf_opaque_t tnf_kthread_id_t;
#define tnf_kthread_id(ops, item, ref) \
tnf_opaque(ops, item, ref)
/* processor ID */
extern tnf_tag_data_t *tnf_cpuid_tag_data;
typedef tnf_int32_t tnf_cpuid_t;
#define tnf_cpuid(ops, item, ref) \
tnf_int32(ops, item, ref)
/* device ID */
extern tnf_tag_data_t *tnf_device_tag_data;
typedef tnf_ulong_t tnf_device_t;
#define tnf_device(ops, item, ref) \
tnf_ulong(ops, item, ref)
/* kernel symbol */
extern tnf_tag_data_t *tnf_symbol_tag_data;
typedef tnf_opaque_t tnf_symbol_t;
#define tnf_symbol(ops, item, ref) \
tnf_opaque(ops, item, ref)
/* array of symbols */
extern tnf_tag_data_t *tnf_symbols_tag_data;
typedef tnf_ref32_t tnf_symbols_t;
#if defined(__sparc)
#define tnf_symbols(ops, item, ref) \
tnf_opaque32_array_1(ops, item, ref, tnf_symbols_tag_data)
#else /* defined(__sparc) */
#define tnf_symbols(ops, item, ref) \
tnf_opaque_array_1(ops, item, ref, tnf_symbols_tag_data)
#endif /* defined(__sparc) */
/* system call number */
extern tnf_tag_data_t *tnf_sysnum_tag_data;
typedef tnf_int16_t tnf_sysnum_t;
#define tnf_sysnum(ops, item, ref) \
tnf_int16(ops, item, ref)
/* thread microstate XXX enum */
/* XXX should have a new type tnf_enum of appropriate size to map C enum's */
/* XXX cast below is to avoid lint warnings */
extern tnf_tag_data_t *tnf_microstate_tag_data;
typedef tnf_int32_t tnf_microstate_t;
#define tnf_microstate(ops, item, ref) \
tnf_int32(ops, (tnf_int32_t)(item), ref)
/* file offset */
extern tnf_tag_data_t *tnf_offset_tag_data;
typedef tnf_int64_t tnf_offset_t;
#define tnf_offset(ops, item, ref) \
tnf_int64(ops, item, ref)
/* address fault type XXX enum */
/* XXX should have a new type tnf_enum of appropriate size to map C enum's */
/* XXX cast below is to avoid lint warnings */
extern tnf_tag_data_t *tnf_fault_type_tag_data;
typedef tnf_int32_t tnf_fault_type_t;
#define tnf_fault_type(ops, item, ref) \
tnf_int32(ops, (tnf_int32_t)(item), ref)
/* segment access type XXX enum */
/* XXX should have a new type tnf_enum of appropriate size to map C enum's */
/* XXX cast below is to avoid lint warnings */
extern tnf_tag_data_t *tnf_seg_access_tag_data;
typedef tnf_int32_t tnf_seg_access_t;
#define tnf_seg_access(ops, item, ref) \
tnf_int32(ops, (tnf_int32_t)(item), ref)
/* buffered I/O flags */
extern tnf_tag_data_t *tnf_bioflags_tag_data;
typedef tnf_int32_t tnf_bioflags_t;
#define tnf_bioflags(ops, item, ref) \
tnf_int32(ops, item, ref)
/* disk block addresses */
extern tnf_tag_data_t *tnf_diskaddr_tag_data;
typedef tnf_int64_t tnf_diskaddr_t;
#define tnf_diskaddr(ops, item, ref) \
tnf_int64(ops, item, ref)
#endif /* _KERNEL */
/*
* Type extension interface
*/
extern tnf_tag_data_t ***tnf_user_struct_properties;
/*
* Data encoders
*/
extern tnf_ref32_t tnf_ref32_1(tnf_ops_t *,
tnf_record_p,
tnf_record_p);
extern tnf_reference_t tnf_string_1(tnf_ops_t *,
const char *,
tnf_record_p,
tnf_tag_data_t *);
#ifdef _KERNEL
extern tnf_reference_t tnf_opaque_array_1(tnf_ops_t *,
tnf_opaque_t *,
tnf_record_p,
tnf_tag_data_t *);
#ifdef __sparc
extern tnf_reference_t tnf_opaque32_array_1(tnf_ops_t *,
tnf_uint32_t *,
tnf_record_p,
tnf_tag_data_t *);
#endif /* __sparc */
#endif /* _KERNEL */
/*
* Tag descriptors
*/
extern tnf_record_p tnf_struct_tag_1(tnf_ops_t *, tnf_tag_data_t *);
/*
* Buffer memory allocator
*/
extern void *tnf_allocate(tnf_ops_t *, size_t);
/*
* Weak symbol definitions to allow unprobed operation
*/
#if !defined(_KERNEL) && !defined(_TNF_LIBRARY)
#pragma weak __tnf_tag_version_1_info
#pragma weak tnf_char_tag_data
#pragma weak tnf_int8_tag_data
#pragma weak tnf_uint8_tag_data
#pragma weak tnf_int16_tag_data
#pragma weak tnf_uint16_tag_data
#pragma weak tnf_int32_tag_data
#pragma weak tnf_uint32_tag_data
#pragma weak tnf_int64_tag_data
#pragma weak tnf_uint64_tag_data
#pragma weak tnf_float32_tag_data
#pragma weak tnf_float64_tag_data
#pragma weak tnf_tag_tag_data
#pragma weak tnf_string_tag_data
#pragma weak tnf_name_tag_data
#pragma weak tnf_opaque_tag_data
#pragma weak tnf_size_tag_data
#pragma weak tnf_probe_event_tag_data
#pragma weak tnf_time_delta_tag_data
#pragma weak tnf_user_struct_properties
#pragma weak tnf_ref32_1
#pragma weak tnf_string_1
#pragma weak tnf_struct_tag_1
#pragma weak tnf_allocate
#endif /* !defined(_KERNEL) || !defined(_TNF_LIBRARY) */
#ifdef __cplusplus
}
#endif
#endif /* _SYS_TNF_WRITER_H */
|
