/
ktrace.h
467 lines (409 loc) · 10.6 KB
/
ktrace.h
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
/* $NetBSD: ktrace.h,v 1.67 2021/09/14 22:01:40 christos Exp $ */
/*
* Copyright (c) 1988, 1993
* The Regents of the University of California. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* @(#)ktrace.h 8.2 (Berkeley) 2/19/95
*/
#ifndef _SYS_KTRACE_H_
#define _SYS_KTRACE_H_
#include <sys/mutex.h>
#include <sys/lwp.h>
#include <sys/signal.h>
#include <sys/time.h>
#include <sys/uio.h>
/*
* operations to ktrace system call (KTROP(op))
*/
#define KTROP_SET 0 /* set trace points */
#define KTROP_CLEAR 1 /* clear trace points */
#define KTROP_CLEARFILE 2 /* stop all tracing to file */
#define KTROP_MASK 0x3
#define KTROP(o) ((o)&KTROP_MASK) /* macro to extract operation */
/*
* flags (ORed in with operation)
*/
#define KTRFLAG_DESCEND 4 /* perform op on all children too */
/*
* ktrace record header
*/
struct ktr_header {
int ktr_len; /* length of record minus length of old header */
#if BYTE_ORDER == LITTLE_ENDIAN
short ktr_type; /* trace record type */
short ktr_version; /* trace record version */
#else
short ktr_version; /* trace record version */
short ktr_type; /* trace record type */
#endif
pid_t ktr_pid; /* process id */
char ktr_comm[MAXCOMLEN+1]; /* command name */
union {
struct { /* v0 */
struct {
int32_t tv_sec;
long tv_usec;
} _tv;
const void *_buf;
} _v0;
struct { /* v1 */
struct {
int32_t tv_sec;
long tv_nsec;
} _ts;
lwpid_t _lid;
} _v1;
struct { /* v2 */
struct timespec _ts;
lwpid_t _lid;
} _v2;
} _v;
};
#define ktr_lid _v._v2._lid
#define ktr_olid _v._v1._lid
#define ktr_time _v._v2._ts
#define ktr_otv _v._v0._tv
#define ktr_ots _v._v1._ts
#define ktr_ts _v._v2._ts
#define ktr_unused _v._v0._buf
#define KTR_SHIMLEN offsetof(struct ktr_header, ktr_pid)
/*
* Test for kernel trace point
*/
#define KTRPOINT(p, type) \
(((p)->p_traceflag & (1<<(type))) != 0)
/*
* ktrace record types
*/
/*
* KTR_SYSCALL - system call record
*/
#define KTR_SYSCALL 1
struct ktr_syscall {
int ktr_code; /* syscall number */
int ktr_argsize; /* size of arguments */
/*
* followed by ktr_argsize/sizeof(register_t) "register_t"s
*/
};
/*
* KTR_SYSRET - return from system call record
*/
#define KTR_SYSRET 2
struct ktr_sysret {
short ktr_code;
short ktr_eosys; /* XXX unused */
int ktr_error;
__register_t ktr_retval;
__register_t ktr_retval_1;
};
/*
* KTR_NAMEI - namei record
*/
#define KTR_NAMEI 3
/* record contains pathname */
/*
* KTR_GENIO - trace generic process i/o
*/
#define KTR_GENIO 4
struct ktr_genio {
int ktr_fd;
enum uio_rw ktr_rw;
/*
* followed by data successfully read/written
*/
};
/*
* KTR_PSIG - trace processed signal
*/
#define KTR_PSIG 5
struct ktr_psig {
int signo;
sig_t action;
sigset_t mask;
int code;
/*
* followed by optional siginfo_t
*/
};
/*
* KTR_CSW - trace context switches
*/
#define KTR_CSW 6
struct ktr_csw {
int out; /* 1 if switch out, 0 if switch in */
int user; /* 1 if usermode (ivcsw), 0 if kernel (vcsw) */
};
/*
* KTR_EMUL - emulation change
*/
#define KTR_EMUL 7
/* record contains emulation name */
/*
* KTR_USER - user record
*/
#define KTR_USER 8
#define KTR_USER_MAXIDLEN 20
#define KTR_USER_MAXLEN 2048 /* maximum length of passed data */
struct ktr_user {
char ktr_id[KTR_USER_MAXIDLEN]; /* string id of caller */
/*
* Followed by ktr_len - sizeof(struct ktr_user) of user data.
*/
};
/*
* KTR_EXEC_ARG, KTR_EXEC_ENV - Arguments and environment from exec
*/
#define KTR_EXEC_ARG 10
#define KTR_EXEC_ENV 11
/* record contains arg/env string */
/*
* KTR_SAUPCALL - scheduler activated upcall.
*
* The structure is no longer used, but retained for compatibility.
*/
#define KTR_SAUPCALL 13
struct ktr_saupcall {
int ktr_type;
int ktr_nevent;
int ktr_nint;
void *ktr_sas;
void *ktr_ap;
/*
* followed by nevent sa_t's from sas[]
*/
};
/*
* KTR_MIB - MIB name and data
*/
#define KTR_MIB 14
/* Record contains MIB name */
/*
* KTR_EXEC_FD - Opened file descriptor from exec
*/
#define KTR_EXEC_FD 15
struct ktr_execfd {
int ktr_fd;
u_int ktr_dtype; /* one of DTYPE_* constants */
};
/*
* kernel trace points (in p_traceflag)
*/
#define KTRFAC_MASK 0x00ffffff
#define KTRFAC_SYSCALL (1<<KTR_SYSCALL)
#define KTRFAC_SYSRET (1<<KTR_SYSRET)
#define KTRFAC_NAMEI (1<<KTR_NAMEI)
#define KTRFAC_GENIO (1<<KTR_GENIO)
#define KTRFAC_PSIG (1<<KTR_PSIG)
#define KTRFAC_CSW (1<<KTR_CSW)
#define KTRFAC_EMUL (1<<KTR_EMUL)
#define KTRFAC_USER (1<<KTR_USER)
#define KTRFAC_EXEC_ARG (1<<KTR_EXEC_ARG)
#define KTRFAC_EXEC_ENV (1<<KTR_EXEC_ENV)
#define KTRFAC_MIB (1<<KTR_MIB)
#define KTRFAC_EXEC_FD (1<<KTR_EXEC_FD)
#define __KTRACE_FLAG_BITS \
"\177\020" \
"b\1SYSCALL\0" \
"b\2SYSRET\0" \
"b\3NAMEI\0" \
"b\4GENIO\0" \
"b\5PSIG\0" \
"b\6CSW\0" \
"b\7EMUL\0" \
"b\10USER\0" \
"b\12EXEC_ARG\0" \
"b\13EXEC_ENV\0" \
"b\15SAUPCALL\0" \
"b\16MIB\0" \
"b\17EXEC_FD\0" \
"f\30\4VERSION\0" \
"b\36TRC_EMUL\0" \
"b\37INHERIT\0" \
"b\40PERSISTENT\0"
/*
* trace flags (also in p_traceflags)
*/
#define KTRFAC_PERSISTENT 0x80000000 /* persistent trace across sugid
exec (exclusive) */
#define KTRFAC_INHERIT 0x40000000 /* pass trace flags to children */
#define KTRFAC_TRC_EMUL 0x10000000 /* ktrace KTR_EMUL before next trace */
#define KTRFAC_VER_MASK 0x0f000000 /* record version mask */
#define KTRFAC_VER_SHIFT 24 /* record version shift */
#define KTRFAC_VERSION(tf) (((tf) & KTRFAC_VER_MASK) >> KTRFAC_VER_SHIFT)
#define KTRFACv0 (0 << KTRFAC_VER_SHIFT)
#define KTRFACv1 (1 << KTRFAC_VER_SHIFT)
#define KTRFACv2 (2 << KTRFAC_VER_SHIFT)
#ifndef _KERNEL
#include <sys/cdefs.h>
__BEGIN_DECLS
int ktrace(const char *, int, int, pid_t);
int fktrace(int, int, int, pid_t);
int utrace(const char *, void *, size_t);
__END_DECLS
#else
void ktrinit(void);
void ktrderef(struct proc *);
void ktradref(struct proc *);
extern kmutex_t ktrace_lock;
extern int ktrace_on;
int ktruser(const char *, void *, size_t, int);
bool ktr_point(int);
void ktr_csw(int, int);
void ktr_emul(void);
void ktr_geniov(int, enum uio_rw, struct iovec *, size_t, int);
void ktr_genio(int, enum uio_rw, const void *, size_t, int);
void ktr_mibio(int, enum uio_rw, const void *, size_t, int);
void ktr_namei(const char *, size_t);
void ktr_namei2(const char *, size_t, const char *, size_t);
void ktr_psig(int, sig_t, const sigset_t *, const ksiginfo_t *);
void ktr_syscall(register_t, const register_t [], int);
void ktr_sysret(register_t, int, register_t *);
void ktr_kuser(const char *, const void *, size_t);
void ktr_mib(const int *a , u_int b);
void ktr_execarg(const void *, size_t);
void ktr_execenv(const void *, size_t);
void ktr_execfd(int, u_int);
int ktrace_common(lwp_t *, int, int, int, file_t **);
static __inline int
ktrenter(lwp_t *l)
{
if ((l->l_pflag & LP_KTRACTIVE) != 0)
return 1;
l->l_pflag |= LP_KTRACTIVE;
return 0;
}
static __inline void
ktrexit(lwp_t *l)
{
l->l_pflag &= ~LP_KTRACTIVE;
}
static __inline bool
ktrpoint(int fac)
{
return __predict_false(ktrace_on) && __predict_false(ktr_point(1 << fac));
}
static __inline void
ktrcsw(int a, int b)
{
if (__predict_false(ktrace_on))
ktr_csw(a, b);
}
static __inline void
ktremul(void)
{
if (__predict_false(ktrace_on))
ktr_emul();
}
static __inline void
ktrgenio(int a, enum uio_rw b, const void *c, size_t d, int e)
{
if (__predict_false(ktrace_on))
ktr_genio(a, b, c, d, e);
}
static __inline void
ktrgeniov(int a, enum uio_rw b, struct iovec *c, int d, int e)
{
if (__predict_false(ktrace_on))
ktr_geniov(a, b, c, d, e);
}
static __inline void
ktrmibio(int a, enum uio_rw b, const void *c, size_t d, int e)
{
if (__predict_false(ktrace_on))
ktr_mibio(a, b, c, d, e);
}
static __inline void
ktrnamei(const char *a, size_t b)
{
if (__predict_false(ktrace_on))
ktr_namei(a, b);
}
static __inline void
ktrnamei2(const char *a, size_t b, const char *c, size_t d)
{
if (__predict_false(ktrace_on))
ktr_namei2(a, b, c, d);
}
static __inline void
ktrpsig(int a, sig_t b, const sigset_t *c, const ksiginfo_t * d)
{
if (__predict_false(ktrace_on))
ktr_psig(a, b, c, d);
}
static __inline void
ktrsyscall(register_t code, const register_t args[], int narg)
{
if (__predict_false(ktrace_on))
ktr_syscall(code, args, narg);
}
static __inline void
ktrsysret(register_t a, int b, register_t *c)
{
if (__predict_false(ktrace_on))
ktr_sysret(a, b, c);
}
static __inline void
ktrkuser(const char *a, const void *b, size_t c)
{
if (__predict_false(ktrace_on))
ktr_kuser(a, b, c);
}
static __inline void
ktrmib(const int *a , u_int b)
{
if (__predict_false(ktrace_on))
ktr_mib(a, b);
}
static __inline void
ktrexecarg(const void *a, size_t b)
{
if (__predict_false(ktrace_on))
ktr_execarg(a, b);
}
static __inline void
ktrexecenv(const void *a, size_t b)
{
if (__predict_false(ktrace_on))
ktr_execenv(a, b);
}
static __inline void
ktrexecfd(int fd, u_int dtype)
{
if (__predict_false(ktrace_on))
ktr_execfd(fd, dtype);
}
struct ktrace_entry;
int ktealloc(struct ktrace_entry **, void **, lwp_t *, int, size_t);
void ktesethdrlen(struct ktrace_entry *, size_t);
void ktraddentry(lwp_t *, struct ktrace_entry *, int);
/* Flags for ktraddentry (3rd arg) */
#define KTA_NOWAIT 0x0000
#define KTA_WAITOK 0x0001
#define KTA_LARGE 0x0002
#endif /* !_KERNEL */
#endif /* _SYS_KTRACE_H_ */