summaryrefslogtreecommitdiff
path: root/usr/src/man/man8/dtrace.8
blob: 57e23462f9921b92bbbfee89b914a737c2e877b6 (plain)
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
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
'\" te
.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (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]
.TH DTRACE 8 "Dec 10, 2017"
.SH NAME
dtrace \- DTrace dynamic tracing compiler and tracing utility
.SH SYNOPSIS
.LP
.nf
\fBdtrace\fR [\fB-32\fR | \fB-64\fR] [\fB-aACeFGHhlqSvVwZ\fR] [\fB-b\fR \fIbufsz\fR] [\fB-c\fR \fIcmd\fR]
     [\fB-D\fR \fIname\fR [\fI=value\fR]] [\fB-I\fR \fIpath\fR] [\fB-L\fR \fIpath\fR] [\fB-o\fR \fIoutput\fR]
     [\fB-s\fR \fIscript\fR] [\fB-U\fR \fIname\fR] [\fB-x\fR \fIarg\fR [\fI=val\fR]]
     [\fB-X\fR a | c | s | t] [\fB-p\fR \fIpid\fR]
     [\fB-P\fR \fIprovider\fR [[\fIpredicate\fR] \fIaction\fR]]
     [\fB-m\fR [\fIprovider:\fR] \fImodule\fR [[\fIpredicate\fR] \fIaction\fR]]
     [\fB-f\fR [[\fIprovider:\fR] \fImodule:\fR] \fIfunction\fR [[\fIpredicate\fR] \fIaction\fR]]
     [\fB-n\fR [[[\fIprovider:\fR] \fImodule:\fR] \fIfunction:\fR] \fIname\fR [[\fIpredicate\fR] \fIaction\fR]]
     [\fB-i\fR \fIprobe-id\fR [[\fIpredicate\fR] \fIaction\fR]]
.fi

.SH DESCRIPTION
.LP
DTrace is a comprehensive dynamic tracing framework.
DTrace provides a powerful infrastructure that permits administrators,
developers, and service personnel to concisely answer arbitrary questions about
the behavior of the operating system and user programs.
.sp
.LP
The \fIDynamic Tracing Guide\fR describes how to use DTrace to observe,
debug, and tune system behavior. Refer to this book for a detailed description
of DTrace features, including the bundled DTrace observability tools,
instrumentation providers, and the D programming language.
.sp
.LP
The \fBdtrace\fR command provides a generic interface to the essential services
provided by the DTrace facility, including:
.RS +4
.TP
.ie t \(bu
.el o
Options that list the set of probes and providers currently published by DTrace
.RE
.RS +4
.TP
.ie t \(bu
.el o
Options that enable probes directly using any of the probe description
specifiers (provider, module, function, name)
.RE
.RS +4
.TP
.ie t \(bu
.el o
Options that run the D compiler and compile one or more D program files or
programs written directly on the command line
.RE
.RS +4
.TP
.ie t \(bu
.el o
Options that generate anonymous tracing programs
.RE
.RS +4
.TP
.ie t \(bu
.el o
Options that generate program stability reports
.RE
.RS +4
.TP
.ie t \(bu
.el o
Options that modify DTrace tracing and buffering behavior and enable additional
D compiler features
.RE
.sp
.LP
You can use \fBdtrace\fR to create D scripts by using it in a \fB#!\fR
declaration to create an interpreter file. You can also use \fBdtrace\fR to
attempt to compile D programs and determine their properties without actually
enabling tracing using the \fB-e\fR option. See \fBOPTIONS\fR. See the
\fIDynamic Tracing Guide\fR for detailed examples of how to use the
\fBdtrace\fR utility to perform these tasks.
.SH OPTIONS
.LP
The arguments accepted by the \fB-P\fR, \fB-m\fR, \fB-f\fR, \fB-n\fR, and
\fB-i\fR options can include an optional D language \fIpredicate\fR enclosed in
slashes \fB//\fR and optional D language \fIaction\fR statement list enclosed
in braces \fB{}\fR. D program code specified on the command line must be
appropriately quoted to avoid interpretation of meta-characters by the shell.
.sp
.LP
The following options are supported:
.sp
.ne 2
.na
\fB\fB-32\fR | \fB-64\fR\fR
.ad
.sp .6
.RS 4n
The D compiler produces programs using the native data model of the operating
system kernel. You can use the \fBisainfo\fR \fB-b\fR command to determine the
current operating system data model. If the \fB-32\fR option is specified,
\fBdtrace\fR forces the D compiler to compile a D program using the 32-bit data
model. If the \fB-64\fR option is specified, \fBdtrace\fR forces the D compiler
to compile a D program using the 64-bit data model. These options are typically
not required as \fBdtrace\fR selects the native data model as the default. The
data model affects the sizes of integer types and other language properties. D
programs compiled for either data model can be executed on both 32-bit and
64-bit kernels. The \fB-32\fR and \fB-64\fR options also determine the ELF file
format (ELF32 or ELF64) produced by the \fB-G\fR option.
.RE

.sp
.ne 2
.na
\fB\fB-a\fR\fR
.ad
.sp .6
.RS 4n
Claim anonymous tracing state and display the traced data. You can combine the
\fB-a\fR option with the \fB-e\fR option to force \fBdtrace\fR to exit
immediately after consuming the anonymous tracing state rather than continuing
to wait for new data. See the \fIDynamic Tracing Guide\fR for more
information about anonymous tracing.
.RE

.sp
.ne 2
.na
\fB\fB-A\fR\fR
.ad
.sp .6
.RS 4n
Generate \fBdriver.conf\fR(5) directives for anonymous tracing. This option
constructs a set of \fBdtrace\fR(4D) configuration file directives to enable
the specified probes for anonymous tracing and then exits. By default,
\fBdtrace\fR attempts to store the directives to the file
\fB/kernel/drv/dtrace.conf\fR. You can modify this behavior if you use the
\fB-o\fR option to specify an alternate output file.
.RE

.sp
.ne 2
.na
\fB\fB-b\fR \fIbufsz\fR\fR
.ad
.sp .6
.RS 4n
Set principal trace buffer size (\fIbufsz\fR). The trace buffer size can
include any of the size suffixes \fBk\fR, \fBm\fR, \fBg\fR, or \fBt\fR. If the
buffer space cannot be allocated, \fBdtrace\fR attempts to reduce the buffer
size or exit depending on the setting of the \fBbufresize\fR property.
.RE

.sp
.ne 2
.na
\fB\fB-c\fR \fIcmd\fR\fR
.ad
.sp .6
.RS 4n
Run the specified command \fIcmd\fR and exit upon its completion. If more than
one \fB-c\fR option is present on the command line, \fBdtrace\fR exits when all
commands have exited, reporting the exit status for each child process as it
terminates. The process-ID of the first command is made available to any D
programs specified on the command line or using the \fB-s\fR option through the
\fB$target\fR macro variable. Refer to the \fIDynamic Tracing Guide\fR
for more information on macro variables.
.RE

.sp
.ne 2
.na
\fB\fB-C\fR\fR
.ad
.sp .6
.RS 4n
Run the C preprocessor \fBcpp\fR(1) over D programs before compiling them. You
can pass options to the C preprocessor using the \fB-D\fR, \fB-U\fR, \fB-I\fR,
and \fB-H\fR options. You can select the degree of C standard conformance if
you use the \fB-X\fR option. For a description of the set of tokens defined by
the D compiler when invoking the C preprocessor, see \fB-X\fR.
.RE

.sp
.ne 2
.na
\fB\fB-D\fR \fIname\fR \fB[=\fR\fIvalue\fR\fB]\fR\fR
.ad
.sp .6
.RS 4n
Define \fIname\fR when invoking \fBcpp\fR(1) (enabled using the \fB-C\fR
option). If you specify the equals sign (\fB=\fR) and additional \fIvalue\fR,
the name is assigned the corresponding value. This option passes the \fB-D\fR
option to each \fBcpp\fR invocation.
.RE

.sp
.ne 2
.na
\fB\fB-e\fR\fR
.ad
.sp .6
.RS 4n
Exit after compiling any requests and consuming anonymous tracing state
(\fB-a\fR option) but prior to enabling any probes. You can combine this option
with the \fB-a\fR option to print anonymous tracing data and exit. You can also
combine this option with D compiler options. This combination verifies that the
programs compile without actually executing them and enabling the corresponding
instrumentation.
.RE

.sp
.ne 2
.na
\fB\fB-f\fR\fB[[\fR\fIprovider\fR\fB:]\fR\fImodule\fR\fB:]\fR\fIfunction\fR\fB[
[\fR\fIpredicate\fR\fB]\fR\fIaction\fR\fB]]\fR\fR
.ad
.sp .6
.RS 4n
Specify function name to trace or list (\fB-l\fR option). The corresponding
argument can include any of the probe description forms
\fIprovider:module:function\fR, \fImodule:function\fR, or \fIfunction\fR.
Unspecified probe description fields are left blank and match any probes
regardless of the values in those fields. If no qualifiers other than
\fIfunction\fR are specified in the description, all probes with the
corresponding \fIfunction\fR are matched. The \fB-f\fR argument can be suffixed
with an optional D probe clause. You can specify more than one \fB-f\fR option
on the command line at a time.
.RE

.sp
.ne 2
.na
\fB\fB-F\fR\fR
.ad
.sp .6
.RS 4n
Coalesce trace output by identifying function entry and return. Function entry
probe reports are indented and their output is prefixed with \fB->\fR. Function
return probe reports are unindented and their output is prefixed with
\fB<-\fR\&. System call entry probe reports are indented and their output is
prefixed with \fB=>\fR. System call return probe reports are unindented and
their output is prefixed with \fB<=\fR\&.
.RE

.sp
.ne 2
.na
\fB\fB-G\fR\fR
.ad
.sp .6
.RS 4n
Generate an ELF file containing an embedded DTrace program. The DTrace probes
specified in the program are saved inside of a relocatable ELF object which can
be linked into another program. If the \fB-o\fR option is present, the ELF file
is saved using the pathname specified as the argument for this operand. If the
\fB-o\fR option is not present and the DTrace program is contained with a file
whose name is \fB\fIfilename\fR.d\fR, then the ELF file is saved using the name
\fB\fIfilename\fR.o\fR. Otherwise the ELF file is saved using the name
\fBd.out\fR.
.RE

.sp
.ne 2
.na
\fB\fB-H\fR\fR
.ad
.sp .6
.RS 4n
Print the pathnames of included files when invoking \fBcpp\fR(1) (enabled using
the \fB-C\fR option). This option passes the \fB-H\fR option to each \fBcpp\fR
invocation, causing it to display the list of pathnames, one for each line, to
\fBstderr\fR.
.RE

.sp
.ne 2
.na
\fB\fB-h\fR\fR
.ad
.sp .6
.RS 4n
Generate a header file containing macros that correspond to probes in the
specified provider definitions. This option should be used to generate a header
file that is included by other source files for later use with the \fB-G\fR
option. If the \fB-o\fR option is present, the header file is saved using the
pathname specified as the argument for that option. If the \fB-o\fR option is
not present and the DTrace program is contained with a file whose name is
\fIfilename\fR\fB\&.d\fR, then the header file is saved using the name
\fIfilename\fR\fB\&.h\fR.
.RE

.sp
.ne 2
.na
\fB\fB-i\fR \fIprobe-id\fR\fB[[\fR\fIpredicate\fR] \fIaction\fR\fB]\fR\fR
.ad
.sp .6
.RS 4n
Specify probe identifier (\fIprobe-id\fR) to trace or list (\fB-l\fR option).
You can specify probe IDs using decimal integers as shown by \fBdtrace\fR
\fB-l\fR. The \fB-i\fR argument can be suffixed with an optional D probe
clause. You can specify more than one \fB-i\fR option at a time.
.RE

.sp
.ne 2
.na
\fB\fB-I\fR \fIpath\fR\fR
.ad
.sp .6
.RS 4n
Add the specified directory \fIpath\fR to the search path for \fB#include\fR
files when invoking \fBcpp\fR(1) (enabled using the \fB-C\fR option). This
option passes the \fB-I\fR option to each \fBcpp\fR invocation. The specified
\fIpath\fR is inserted into the search path ahead of the default directory
list.
.RE

.sp
.ne 2
.na
\fB\fB-L\fR \fIpath\fR\fR
.ad
.sp .6
.RS 4n
Add the specified directory \fIpath\fR to the search path for DTrace libraries.
DTrace libraries are used to contain common definitions that can be used when
writing D programs. The specified \fIpath\fR is added after the default library
search path.
.RE

.sp
.ne 2
.na
\fB\fB-l\fR\fR
.ad
.sp .6
.RS 4n
List probes instead of enabling them. If the \fB-l\fR option is specified,
\fBdtrace\fR produces a report of the probes matching the descriptions given
using the \fB-P\fR, \fB-m\fR, \fB-f\fR, \fB-n\fR, \fB-i\fR, and \fB-s\fR
options. If none of these options are specified, this option lists all probes.
.RE

.sp
.ne 2
.na
\fB\fB-m\fR [[\fIprovider:\fR] \fImodule:\fR [[\fIpredicate\fR]
\fIaction\fR]]\fR
.ad
.sp .6
.RS 4n
Specify module name to trace or list (\fB-l\fR option). The corresponding
argument can include any of the probe description forms \fIprovider:module\fR
or \fImodule\fR. Unspecified probe description fields are left blank and match
any probes regardless of the values in those fields. If no qualifiers other
than \fImodule\fR are specified in the description, all probes with a
corresponding \fImodule\fR are matched. The \fB-m\fR argument can be suffixed
with an optional D probe clause. More than one \fB-m\fR option can be specified
on the command line at a time.
.RE

.sp
.ne 2
.na
\fB\fB-n\fR [[[\fIprovider:\fR] \fImodule:\fR] \fIfunction:\fR] \fIname\fR
[[\fIpredicate\fR] \fIaction\fR]\fR
.ad
.sp .6
.RS 4n
Specify probe name to trace or list (\fB-l\fR option). The corresponding
argument can include any of the probe description forms
\fIprovider:module:function:name\fR, \fImodule:function:name\fR,
\fIfunction:name\fR, or \fIname\fR. Unspecified probe description fields are
left blank and match any probes regardless of the values in those fields. If no
qualifiers other than \fIname\fR are specified in the description, all probes
with a corresponding \fIname\fR are matched. The \fB-n\fR argument can be
suffixed with an optional D probe clause. More than one \fB-n\fR option can be
specified on the command line at a time.
.RE

.sp
.ne 2
.na
\fB\fB-o\fR \fIoutput\fR\fR
.ad
.sp .6
.RS 4n
Specify the \fIoutput\fR file for the \fB-A\fR, \fB-G\fR, \fB-h\fR, and
\fB-l\fR options, or for the traced data itself. If the \fB-A\fR option is
present and \fB-o\fR is not present, the default output file is
\fB/kernel/drv/dtrace.conf\fR. If the \fB-G\fR option is present and the
\fB-s\fR option's argument is of the form \fB\fIfilename\fR.d\fR and \fB-o\fR
is not present, the default output file is \fB\fIfilename\fR.o\fR. Otherwise
the default output file is \fBd.out\fR.
.RE

.sp
.ne 2
.na
\fB\fB-p\fR \fIpid\fR\fR
.ad
.sp .6
.RS 4n
Grab the specified process-ID \fIpid\fR, cache its symbol tables, and exit upon
its completion. If more than one \fB-p\fR option is present on the command
line, \fBdtrace\fR exits when all commands have exited, reporting the exit
status for each process as it terminates. The first process-ID is made
available to any D programs specified on the command line or using the \fB-s\fR
option through the \fB$target\fR macro variable. Refer to the \fIDynamic
Tracing Guide\fR for more information on macro variables.
.RE

.sp
.ne 2
.na
\fB\fB-P\fR \fIprovider\fR \fB[[\fR\fIpredicate\fR\fB]\fR \fIaction\fR]\fR
.ad
.sp .6
.RS 4n
Specify provider name to trace or list (\fB-l\fR option). The remaining probe
description fields module, function, and name are left blank and match any
probes regardless of the values in those fields. The \fB-P\fR argument can be
suffixed with an optional D probe clause. You can specify more than one
\fB-P\fR option on the command line at a time.
.RE

.sp
.ne 2
.na
\fB\fB-q\fR\fR
.ad
.sp .6
.RS 4n
Set quiet mode. \fBdtrace\fR suppresses messages such as the number of probes
matched by the specified options and D programs and does not print column
headers, the CPU ID, the probe ID, or insert newlines into the output. Only
data traced and formatted by D program statements such as \fBtrace()\fR and
\fBprintf()\fR is displayed to \fBstdout\fR.
.RE

.sp
.ne 2
.na
\fB\fB-s\fR\fR
.ad
.sp .6
.RS 4n
Compile the specified D program source file. If the \fB-e\fR option is present,
the program is compiled but instrumentation is not enabled. If the \fB-l\fR
option is present, the program is compiled and the set of probes matched by it
is listed, but instrumentation is not enabled. If none of \fB-e\fR, \fB-l\fR,
\fB-G\fR, or \fB-A\fR are present, the instrumentation specified by the D
program is enabled and tracing begins.
.RE

.sp
.ne 2
.na
\fB\fB-S\fR\fR
.ad
.sp .6
.RS 4n
Show D compiler intermediate code. The D compiler produces a report of the
intermediate code generated for each D program to \fBstderr\fR.
.RE

.sp
.ne 2
.na
\fB\fB-U\fR \fIname\fR\fR
.ad
.sp .6
.RS 4n
Undefine the specified \fIname\fR when invoking \fBcpp\fR(1) (enabled using the
\fB-C\fR option). This option passes the \fB-U\fR option to each \fBcpp\fR
invocation.
.RE

.sp
.ne 2
.na
\fB\fB-v\fR\fR
.ad
.sp .6
.RS 4n
Set verbose mode. If the \fB-v\fR option is specified, \fBdtrace\fR produces a
program stability report showing the minimum interface stability and dependency
level for the specified D programs. DTrace stability levels are explained in
further detail in the \fIDynamic Tracing Guide\fR.
.RE

.sp
.ne 2
.na
\fB\fB-V\fR\fR
.ad
.sp .6
.RS 4n
Report the highest D programming interface version supported by \fBdtrace\fR.
The version information is printed to \fBstdout\fR and the \fBdtrace\fR command
exits. Refer to the \fIDynamic Tracing Guide\fR for more information
about DTrace versioning features.
.RE

.sp
.ne 2
.na
\fB\fB-w\fR\fR
.ad
.sp .6
.RS 4n
Permit destructive actions in D programs specified using the \fB-s\fR,
\fB-P\fR, \fB-m\fR, \fB-f\fR, \fB-n\fR, or \fB-i\fR options. If the \fB-w\fR
option is not specified, \fBdtrace\fR does not permit the compilation or
enabling of a D program that contains destructive actions.
.RE

.sp
.ne 2
.na
\fB\fB-x\fR \fIarg\fR [\fI=val\fR]\fR
.ad
.sp .6
.RS 4n
Enable or modify a DTrace runtime option or D compiler option. The list of
options is found in the \fIDynamic Tracing Guide\fR. Boolean options
are enabled by specifying their name. Options with values are set by separating
the option name and value with an equals sign (\fB=\fR).
.RE

.sp
.ne 2
.na
\fB\fB-X\fR \fBa | c | s | t\fR\fR
.ad
.sp .6
.RS 4n
Specify the degree of conformance to the ISO C standard that should be selected
when invoking \fBcpp\fR(1) (enabled using the \fB-C\fR option). The \fB-X\fR
option argument affects the value and presence of the \fB__STDC__\fR macro
depending upon the value of the argument letter.
.sp
The \fB-X\fR option supports the following arguments:
.sp
.ne 2
.na
\fB\fBa\fR\fR
.ad
.RS 5n
Default. ISO C plus K&R compatibility extensions, with semantic changes
required by ISO C. This is the default mode if \fB-X\fR is not specified. The
predefined macro \fB__STDC__\fR has a value of 0 when \fBcpp\fR is invoked in
conjunction with the \fB-Xa\fR option.
.RE

.sp
.ne 2
.na
\fB\fBc\fR\fR
.ad
.RS 5n
Conformance. Strictly conformant ISO C, without K&R C compatibility extensions.
The predefined macro \fB__STDC__\fR has a value of 1 when \fBcpp\fR is invoked
in conjunction with the \fB-Xc\fR option.
.RE

.sp
.ne 2
.na
\fB\fBs\fR\fR
.ad
.RS 5n
K&R C only. The macro \fB__STDC__\fR is not defined when \fBcpp\fR is invoked
in conjunction with the \fB-Xs\fR option.
.RE

.sp
.ne 2
.na
\fB\fBt\fR\fR
.ad
.RS 5n
Transition. ISO C plus K&R C compatibility extensions, without semantic changes
required by ISO C. The predefined macro \fB__STDC__\fR has a value of 0 when
\fBcpp\fR is invoked in conjunction with the \fB-Xt\fR option.
.RE

As the \fB-X\fR option only affects how the D compiler invokes the C
preprocessor, the \fB-Xa\fR and \fB-Xt\fR options are equivalent from the
perspective of D and both are provided only to ease re-use of settings from a C
build environment.
.sp
Regardless of the \fB-X\fR mode, the following additional C preprocessor
definitions are always specified and valid in all modes:
.RS +4
.TP
.ie t \(bu
.el o
\fB__sun\fR
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fB__unix\fR
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fB__SVR4\fR
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fB__sparc\fR (on SPARC systems only)
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fB__sparcv9\fR (on SPARC systems only when 64-bit programs are compiled)
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fB__i386\fR (on x86 systems only when 32-bit programs are compiled)
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fB__amd64\fR (on x86 systems only when 64-bit programs are compiled)
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fB__\fI`uname -s`\fR_\fI`uname -r`\fR\fR (for example, \fB__SunOS_5_10\fR)
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fB__SUNW_D=1\fR
.RE
.RS +4
.TP
.ie t \(bu
.el o
\fB__SUNW_D_VERSION=0x\fIMMmmmuuu\fR\fR
.sp
Where \fIMM\fR is the major release value in hexadecimal, \fImmm\fR is the
minor release value in hexadecimal, and \fIuuu\fR is the micro release value in
hexadecimal. Refer to the \fIDynamic Tracing Guide\fR for more
information about DTrace versioning.
.RE
.RE

.sp
.ne 2
.na
\fB\fB-Z\fR\fR
.ad
.sp .6
.RS 4n
Permit probe descriptions that match zero probes. If the \fB-Z\fR option is not
specified, \fBdtrace\fR reports an error and exits if any probe descriptions
specified in D program files (\fB-s\fR option) or on the command line
(\fB-P\fR, \fB-m\fR, \fB-f\fR, \fB-n\fR, or \fB-i\fR options) contain
descriptions that do not match any known probes.
.RE

.SH OPERANDS
.LP
You can specify zero or more additional arguments on the \fBdtrace\fR command
line to define a set of macro variables (\fB$1\fR, \fB$2\fR, and so forth). The
additional arguments can be used in D programs specified using the \fB-s\fR
option or on the command line. The use of macro variables is described further
in the \fIDynamic Tracing Guide\fR.
.SH EXIT STATUS
.LP
The following exit values are returned:
.sp
.ne 2
.na
\fB0\fR
.ad
.RS 5n
Successful completion.
.sp
For D program requests, an exit status of \fB0\fR indicates that programs were
successfully compiled, probes were successfully enabled, or anonymous state was
successfully retrieved. \fBdtrace\fR returns \fB0\fR even if the specified
tracing requests encountered errors or drops.
.RE

.sp
.ne 2
.na
\fB\fB1\fR\fR
.ad
.RS 5n
An error occurred.
.sp
For D program requests, an exit status of \fB1\fR indicates that program
compilation failed or that the specified request could not be satisfied.
.RE

.sp
.ne 2
.na
\fB\fB2\fR\fR
.ad
.RS 5n
Invalid command line options or arguments were specified.
.RE

.SH ATTRIBUTES
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	See below.
.TE

.sp
.LP
The command-line syntax is Committed. The human-readable output is Uncommitted.
.SH SEE ALSO
.LP
.BR cpp (1),
.BR isainfo (1),
.BR ssh (1),
.BR libdtrace (3LIB),
.BR dtrace (4D),
.BR driver.conf (5),
.BR attributes (7)
.sp
.LP
\fIDynamic Tracing Guide\fR:
.sp
.LP
https://illumos.org/books/dtrace/

.SH NOTES
.LP
When using the \fB-p\fR flag, \fBdtrace\fR stops the target processes while it
is inspecting them and reporting results. A process can do nothing while it is
stopped. This means that, if, for example, the X server is inspected by
\fBdtrace\fR running in a window under the X server's control, the whole window
system can become deadlocked, because the \fBproc\fR tool would be attempting
to display its results to a window that cannot be refreshed. In such a case,
logging in from another system using \fBssh\fR(1) and killing the offending
\fBproc\fR tool clears the deadlock.