2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include <sys/types.h>
28 #include <urcu/list.h>
30 #include "../command.h"
32 #define PRINT_LINE_LEN 80
34 static char *opt_event_name
;
35 static char *opt_channel_name
;
36 static char *opt_session_name
;
37 static int opt_kernel
;
38 static int opt_userspace
;
39 static char *opt_type
;
41 /* Not implemented yet */
42 static char *opt_cmd_name
;
53 static struct lttng_handle
*handle
;
56 * Taken from the LTTng ABI
60 CONTEXT_PERF_COUNTER
= 1,
69 CONTEXT_PTHREAD_ID
= 10,
70 CONTEXT_HOSTNAME
= 11,
74 * Taken from the Perf ABI (all enum perf_*)
77 PERF_TYPE_HARDWARE
= 0,
78 PERF_TYPE_SOFTWARE
= 1,
79 PERF_TYPE_HW_CACHE
= 3,
82 enum perf_count_hard
{
83 PERF_COUNT_HW_CPU_CYCLES
= 0,
84 PERF_COUNT_HW_INSTRUCTIONS
= 1,
85 PERF_COUNT_HW_CACHE_REFERENCES
= 2,
86 PERF_COUNT_HW_CACHE_MISSES
= 3,
87 PERF_COUNT_HW_BRANCH_INSTRUCTIONS
= 4,
88 PERF_COUNT_HW_BRANCH_MISSES
= 5,
89 PERF_COUNT_HW_BUS_CYCLES
= 6,
90 PERF_COUNT_HW_STALLED_CYCLES_FRONTEND
= 7,
91 PERF_COUNT_HW_STALLED_CYCLES_BACKEND
= 8,
94 enum perf_count_soft
{
95 PERF_COUNT_SW_CPU_CLOCK
= 0,
96 PERF_COUNT_SW_TASK_CLOCK
= 1,
97 PERF_COUNT_SW_PAGE_FAULTS
= 2,
98 PERF_COUNT_SW_CONTEXT_SWITCHES
= 3,
99 PERF_COUNT_SW_CPU_MIGRATIONS
= 4,
100 PERF_COUNT_SW_PAGE_FAULTS_MIN
= 5,
101 PERF_COUNT_SW_PAGE_FAULTS_MAJ
= 6,
102 PERF_COUNT_SW_ALIGNMENT_FAULTS
= 7,
103 PERF_COUNT_SW_EMULATION_FAULTS
= 8,
107 * Generalized hardware cache events:
109 * { L1-D, L1-I, LLC, ITLB, DTLB, BPU } x
110 * { read, write, prefetch } x
111 * { accesses, misses }
113 enum perf_hw_cache_id
{
114 PERF_COUNT_HW_CACHE_L1D
= 0,
115 PERF_COUNT_HW_CACHE_L1I
= 1,
116 PERF_COUNT_HW_CACHE_LL
= 2,
117 PERF_COUNT_HW_CACHE_DTLB
= 3,
118 PERF_COUNT_HW_CACHE_ITLB
= 4,
119 PERF_COUNT_HW_CACHE_BPU
= 5,
121 PERF_COUNT_HW_CACHE_MAX
, /* non-ABI */
124 enum perf_hw_cache_op_id
{
125 PERF_COUNT_HW_CACHE_OP_READ
= 0,
126 PERF_COUNT_HW_CACHE_OP_WRITE
= 1,
127 PERF_COUNT_HW_CACHE_OP_PREFETCH
= 2,
129 PERF_COUNT_HW_CACHE_OP_MAX
, /* non-ABI */
132 enum perf_hw_cache_op_result_id
{
133 PERF_COUNT_HW_CACHE_RESULT_ACCESS
= 0,
134 PERF_COUNT_HW_CACHE_RESULT_MISS
= 1,
136 PERF_COUNT_HW_CACHE_RESULT_MAX
, /* non-ABI */
139 static struct poptOption long_options
[] = {
140 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
141 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
142 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
143 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
144 {"event", 'e', POPT_ARG_STRING
, &opt_event_name
, 0, 0, 0},
145 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
146 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
147 {"type", 't', POPT_ARG_STRING
, &opt_type
, OPT_TYPE
, 0, 0},
148 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
149 {0, 0, 0, 0, 0, 0, 0}
155 #define PERF_HW(opt, name) \
157 "perf:" #opt, CONTEXT_PERF_COUNTER, \
158 .u.perf = { PERF_TYPE_HARDWARE, PERF_COUNT_HW_##name, },\
161 #define PERF_SW(opt, name) \
163 "perf:" #opt, CONTEXT_PERF_COUNTER, \
164 .u.perf = { PERF_TYPE_SOFTWARE, PERF_COUNT_SW_##name, },\
167 #define _PERF_HW_CACHE(optstr, name, op, result) \
169 "perf:" optstr, CONTEXT_PERF_COUNTER, \
171 PERF_TYPE_HW_CACHE, \
172 (uint64_t) PERF_COUNT_HW_CACHE_##name \
173 | ((uint64_t) PERF_COUNT_HW_CACHE_OP_##op << 8) \
174 | ((uint64_t) PERF_COUNT_HW_CACHE_RESULT_##result << 16), \
178 #define PERF_HW_CACHE(opt, name) \
179 _PERF_HW_CACHE(#opt "-loads", name, READ, ACCESS), \
180 _PERF_HW_CACHE(#opt "-load-misses", name, READ, MISS), \
181 _PERF_HW_CACHE(#opt "-stores", name, WRITE, ACCESS), \
182 _PERF_HW_CACHE(#opt "-store-misses", name, WRITE, MISS), \
183 _PERF_HW_CACHE(#opt "-prefetches", name, PREFETCH, ACCESS), \
184 _PERF_HW_CACHE(#opt "-prefetch-misses", name, PREFETCH, MISS) \
187 const struct ctx_opts
{
189 enum context_type ctx_type
;
197 { "pid", CONTEXT_PID
},
198 { "procname", CONTEXT_PROCNAME
},
199 { "prio", CONTEXT_PRIO
},
200 { "nice", CONTEXT_NICE
},
201 { "vpid", CONTEXT_VPID
},
202 { "tid", CONTEXT_TID
},
203 { "pthread_id", CONTEXT_PTHREAD_ID
},
204 { "vtid", CONTEXT_VTID
},
205 { "ppid", CONTEXT_PPID
},
206 { "vppid", CONTEXT_VPPID
},
207 { "hostname", CONTEXT_HOSTNAME
},
209 PERF_HW(cpu
-cycles
, CPU_CYCLES
),
210 PERF_HW(cycles
, CPU_CYCLES
),
211 PERF_HW(stalled
-cycles
-frontend
, STALLED_CYCLES_FRONTEND
),
212 PERF_HW(idle
-cycles
-frontend
, STALLED_CYCLES_FRONTEND
),
213 PERF_HW(stalled
-cycles
-backend
, STALLED_CYCLES_BACKEND
),
214 PERF_HW(idle
-cycles
-backend
, STALLED_CYCLES_BACKEND
),
215 PERF_HW(instructions
, INSTRUCTIONS
),
216 PERF_HW(cache
-references
, CACHE_REFERENCES
),
217 PERF_HW(cache
-misses
, CACHE_MISSES
),
218 PERF_HW(branch
-instructions
, BRANCH_INSTRUCTIONS
),
219 PERF_HW(branches
, BRANCH_INSTRUCTIONS
),
220 PERF_HW(branch
-misses
, BRANCH_MISSES
),
221 PERF_HW(bus
-cycles
, BUS_CYCLES
),
223 PERF_HW_CACHE(L1
-dcache
, L1D
),
224 PERF_HW_CACHE(L1
-icache
, L1I
),
225 PERF_HW_CACHE(LLC
, LL
),
226 PERF_HW_CACHE(dTLB
, DTLB
),
227 _PERF_HW_CACHE("iTLB-loads", ITLB
, READ
, ACCESS
),
228 _PERF_HW_CACHE("iTLB-load-misses", ITLB
, READ
, MISS
),
229 _PERF_HW_CACHE("branch-loads", BPU
, READ
, ACCESS
),
230 _PERF_HW_CACHE("branch-load-misses", BPU
, READ
, MISS
),
233 PERF_SW(cpu
-clock
, CPU_CLOCK
),
234 PERF_SW(task
-clock
, TASK_CLOCK
),
235 PERF_SW(page
-fault
, PAGE_FAULTS
),
236 PERF_SW(faults
, PAGE_FAULTS
),
237 PERF_SW(major
-faults
, PAGE_FAULTS_MAJ
),
238 PERF_SW(minor
-faults
, PAGE_FAULTS_MIN
),
239 PERF_SW(context
-switches
, CONTEXT_SWITCHES
),
240 PERF_SW(cs
, CONTEXT_SWITCHES
),
241 PERF_SW(cpu
-migrations
, CPU_MIGRATIONS
),
242 PERF_SW(migrations
, CPU_MIGRATIONS
),
243 PERF_SW(alignment
-faults
, ALIGNMENT_FAULTS
),
244 PERF_SW(emulation
-faults
, EMULATION_FAULTS
),
245 { NULL
, -1 }, /* Closure */
252 * Context type for command line option parsing.
255 const struct ctx_opts
*opt
;
256 struct cds_list_head list
;
260 * List of context type. Use to enable multiple context on a single command
263 struct ctx_type_list
{
264 struct cds_list_head head
;
266 .head
= CDS_LIST_HEAD_INIT(ctx_type_list
.head
),
270 * Pretty print context type.
272 static void print_ctx_type(FILE *ofp
)
274 const char *indent
= " ";
275 int indent_len
= strlen(indent
);
278 fprintf(ofp
, "%s", indent
);
280 while (ctx_opts
[i
].symbol
!= NULL
) {
281 if (len
> indent_len
) {
282 if (len
+ strlen(ctx_opts
[i
].symbol
) + 2
285 fprintf(ofp
, "%s", indent
);
288 len
+= fprintf(ofp
, ", ");
291 len
+= fprintf(ofp
, "%s", ctx_opts
[i
].symbol
);
299 static void usage(FILE *ofp
)
301 fprintf(ofp
, "usage: lttng add-context -t TYPE [-k|-u] [OPTIONS]\n");
303 fprintf(ofp
, "If no channel and no event is given (-c/-e), the context\n");
304 fprintf(ofp
, "is added to all events and all channels.\n");
306 fprintf(ofp
, "Otherwise the context is added only to the channel (-c)\n");
307 fprintf(ofp
, "and/or event (-e) indicated.\n");
309 fprintf(ofp
, "Exactly one domain (-k or -u) must be specified.\n");
311 fprintf(ofp
, "Options:\n");
312 fprintf(ofp
, " -h, --help Show this help\n");
313 fprintf(ofp
, " --list-options Simple listing of options\n");
314 fprintf(ofp
, " -s, --session NAME Apply to session name\n");
315 fprintf(ofp
, " -c, --channel NAME Apply to channel\n");
316 fprintf(ofp
, " -e, --event NAME Apply to event\n");
317 fprintf(ofp
, " -k, --kernel Apply to the kernel tracer\n");
318 fprintf(ofp
, " -u, --userspace Apply to the user-space tracer\n");
320 fprintf(ofp
, "Context:\n");
321 fprintf(ofp
, " -t, --type TYPE Context type. You can repeat that option on\n");
322 fprintf(ofp
, " the command line to specify multiple contexts at once.\n");
323 fprintf(ofp
, " (--kernel preempts --userspace)\n");
324 fprintf(ofp
, " TYPE can be one of the strings below:\n");
327 fprintf(ofp
, "Example:\n");
328 fprintf(ofp
, "This command will add the context information 'prio' and two perf\n"
329 "counters (hardware branch misses and cache misses), to all events\n"
330 "in the trace data output:\n");
331 fprintf(ofp
, "# lttng add-context -k -t prio -t perf:branch-misses -t perf:cache-misses\n");
336 * Find context numerical value from string.
338 static int find_ctx_type_idx(const char *opt
)
342 while (ctx_opts
[i
].symbol
!= NULL
) {
343 if (strcmp(opt
, ctx_opts
[i
].symbol
) == 0) {
355 * Add context to channel or event.
357 static int add_context(char *session_name
)
359 int ret
= CMD_SUCCESS
, warn
= 0;
360 struct lttng_event_context context
;
361 struct lttng_domain dom
;
362 struct ctx_type
*type
;
365 memset(&context
, 0, sizeof(context
));
366 memset(&dom
, 0, sizeof(dom
));
369 dom
.type
= LTTNG_DOMAIN_KERNEL
;
370 } else if (opt_userspace
) {
371 dom
.type
= LTTNG_DOMAIN_UST
;
373 ERR("Please specify a tracer (-k/--kernel or -u/--userspace)");
378 handle
= lttng_create_handle(session_name
, &dom
);
379 if (handle
== NULL
) {
384 /* Iterate over all the context types given */
385 cds_list_for_each_entry(type
, &ctx_type_list
.head
, list
) {
386 context
.ctx
= (enum lttng_event_context_type
) type
->opt
->ctx_type
;
387 if (context
.ctx
== LTTNG_EVENT_CONTEXT_PERF_COUNTER
) {
388 context
.u
.perf_counter
.type
= type
->opt
->u
.perf
.type
;
389 context
.u
.perf_counter
.config
= type
->opt
->u
.perf
.config
;
390 strcpy(context
.u
.perf_counter
.name
, type
->opt
->symbol
);
391 /* Replace : and - by _ */
392 while ((ptr
= strchr(context
.u
.perf_counter
.name
, '-')) != NULL
) {
395 while ((ptr
= strchr(context
.u
.perf_counter
.name
, ':')) != NULL
) {
399 DBG("Adding context...");
401 ret
= lttng_add_context(handle
, &context
, opt_event_name
,
404 ERR("%s: %s", type
->opt
->symbol
, lttng_strerror(ret
));
408 if (opt_channel_name
&& opt_event_name
) {
409 MSG("%s context %s added to event %s channel %s",
410 opt_kernel
? "kernel" : "UST", type
->opt
->symbol
,
411 opt_channel_name
, opt_event_name
);
412 } else if (opt_channel_name
&& !opt_event_name
) {
413 MSG("%s context %s added to channel %s",
414 opt_kernel
? "kernel" : "UST", type
->opt
->symbol
,
416 } else if (!opt_channel_name
&& opt_event_name
) {
417 MSG("%s context %s added to event %s",
418 opt_kernel
? "kernel" : "UST", type
->opt
->symbol
,
421 MSG("%s context %s added to all channels",
422 opt_kernel
? "kernel" : "UST", type
->opt
->symbol
)
430 lttng_destroy_handle(handle
);
433 * This means that at least one add_context failed and tells the user to
434 * look on stderr for error(s).
443 * Add context to channel or event.
445 int cmd_add_context(int argc
, const char **argv
)
447 int index
, opt
, ret
= CMD_SUCCESS
;
448 static poptContext pc
;
449 struct ctx_type
*type
, *tmptype
;
450 char *session_name
= NULL
;
458 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
459 poptReadDefaultConfig(pc
, 0);
461 while ((opt
= poptGetNextOpt(pc
)) != -1) {
468 * Look up the index of opt_type in ctx_opts[] first, so we don't
469 * have to free(type) on failure.
471 index
= find_ctx_type_idx(opt_type
);
473 ERR("Unknown context type %s", opt_type
);
478 type
= malloc(sizeof(struct ctx_type
));
480 perror("malloc ctx_type");
485 type
->opt
= &ctx_opts
[index
];
486 if (type
->opt
->ctx_type
== -1) {
487 ERR("Unknown context type %s", opt_type
);
492 cds_list_add(&type
->list
, &ctx_type_list
.head
);
498 opt_cmd_name
= poptGetOptArg(pc
);
501 case OPT_LIST_OPTIONS
:
502 list_cmd_options(stdout
, long_options
);
512 ERR("Missing mandatory -t TYPE");
518 if (!opt_session_name
) {
519 session_name
= get_session_name();
520 if (session_name
== NULL
) {
525 session_name
= opt_session_name
;
528 ret
= add_context(session_name
);
530 if (!opt_session_name
) {
535 /* Cleanup allocated memory */
536 cds_list_for_each_entry_safe(type
, tmptype
, &ctx_type_list
.head
, list
) {