2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; only version 2
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 #include <sys/types.h>
29 #include <urcu/list.h>
31 #include "../command.h"
33 #define PRINT_LINE_LEN 80
35 static char *opt_event_name
;
36 static char *opt_channel_name
;
37 static char *opt_session_name
;
38 static int opt_kernel
;
39 static int opt_userspace
;
40 static char *opt_type
;
42 /* Not implemented yet */
43 static char *opt_cmd_name
;
54 static struct lttng_handle
*handle
;
57 * Taken from the LTTng ABI
61 CONTEXT_PERF_COUNTER
= 1,
73 * Taken from the Perf ABI (all enum perf_*)
76 PERF_TYPE_HARDWARE
= 0,
77 PERF_TYPE_SOFTWARE
= 1,
78 PERF_TYPE_HW_CACHE
= 3,
81 enum perf_count_hard
{
82 PERF_COUNT_HW_CPU_CYCLES
= 0,
83 PERF_COUNT_HW_INSTRUCTIONS
= 1,
84 PERF_COUNT_HW_CACHE_REFERENCES
= 2,
85 PERF_COUNT_HW_CACHE_MISSES
= 3,
86 PERF_COUNT_HW_BRANCH_INSTRUCTIONS
= 4,
87 PERF_COUNT_HW_BRANCH_MISSES
= 5,
88 PERF_COUNT_HW_BUS_CYCLES
= 6,
89 PERF_COUNT_HW_STALLED_CYCLES_FRONTEND
= 7,
90 PERF_COUNT_HW_STALLED_CYCLES_BACKEND
= 8,
93 enum perf_count_soft
{
94 PERF_COUNT_SW_CPU_CLOCK
= 0,
95 PERF_COUNT_SW_TASK_CLOCK
= 1,
96 PERF_COUNT_SW_PAGE_FAULTS
= 2,
97 PERF_COUNT_SW_CONTEXT_SWITCHES
= 3,
98 PERF_COUNT_SW_CPU_MIGRATIONS
= 4,
99 PERF_COUNT_SW_PAGE_FAULTS_MIN
= 5,
100 PERF_COUNT_SW_PAGE_FAULTS_MAJ
= 6,
101 PERF_COUNT_SW_ALIGNMENT_FAULTS
= 7,
102 PERF_COUNT_SW_EMULATION_FAULTS
= 8,
106 * Generalized hardware cache events:
108 * { L1-D, L1-I, LLC, ITLB, DTLB, BPU } x
109 * { read, write, prefetch } x
110 * { accesses, misses }
112 enum perf_hw_cache_id
{
113 PERF_COUNT_HW_CACHE_L1D
= 0,
114 PERF_COUNT_HW_CACHE_L1I
= 1,
115 PERF_COUNT_HW_CACHE_LL
= 2,
116 PERF_COUNT_HW_CACHE_DTLB
= 3,
117 PERF_COUNT_HW_CACHE_ITLB
= 4,
118 PERF_COUNT_HW_CACHE_BPU
= 5,
120 PERF_COUNT_HW_CACHE_MAX
, /* non-ABI */
123 enum perf_hw_cache_op_id
{
124 PERF_COUNT_HW_CACHE_OP_READ
= 0,
125 PERF_COUNT_HW_CACHE_OP_WRITE
= 1,
126 PERF_COUNT_HW_CACHE_OP_PREFETCH
= 2,
128 PERF_COUNT_HW_CACHE_OP_MAX
, /* non-ABI */
131 enum perf_hw_cache_op_result_id
{
132 PERF_COUNT_HW_CACHE_RESULT_ACCESS
= 0,
133 PERF_COUNT_HW_CACHE_RESULT_MISS
= 1,
135 PERF_COUNT_HW_CACHE_RESULT_MAX
, /* non-ABI */
138 static struct poptOption long_options
[] = {
139 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
140 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
141 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
142 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
143 {"event", 'e', POPT_ARG_STRING
, &opt_event_name
, 0, 0, 0},
144 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
146 /* Not implemented yet */
147 {"pid", 'p', POPT_ARG_INT
, &opt_pid
, 0, 0, 0},
148 {"userspace", 'u', POPT_ARG_STRING
| POPT_ARGFLAG_OPTIONAL
, &opt_cmd_name
, OPT_USERSPACE
, 0, 0},
150 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
152 {"type", 't', POPT_ARG_STRING
, &opt_type
, OPT_TYPE
, 0, 0},
153 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
154 {0, 0, 0, 0, 0, 0, 0}
160 #define PERF_HW(opt, name) \
162 "perf:" #opt, CONTEXT_PERF_COUNTER, \
163 .u.perf = { PERF_TYPE_HARDWARE, PERF_COUNT_HW_##name, },\
166 #define PERF_SW(opt, name) \
168 "perf:" #opt, CONTEXT_PERF_COUNTER, \
169 .u.perf = { PERF_TYPE_SOFTWARE, PERF_COUNT_SW_##name, },\
172 #define _PERF_HW_CACHE(optstr, name, op, result) \
174 "perf:" optstr, CONTEXT_PERF_COUNTER, \
176 PERF_TYPE_HW_CACHE, \
177 (uint64_t) PERF_COUNT_HW_CACHE_##name \
178 | ((uint64_t) PERF_COUNT_HW_CACHE_OP_##op << 8) \
179 | ((uint64_t) PERF_COUNT_HW_CACHE_RESULT_##result << 16), \
183 #define PERF_HW_CACHE(opt, name) \
184 _PERF_HW_CACHE(#opt "-loads", name, READ, ACCESS), \
185 _PERF_HW_CACHE(#opt "-load-misses", name, READ, MISS), \
186 _PERF_HW_CACHE(#opt "-stores", name, WRITE, ACCESS), \
187 _PERF_HW_CACHE(#opt "-store-misses", name, WRITE, MISS), \
188 _PERF_HW_CACHE(#opt "-prefetches", name, PREFETCH, ACCESS), \
189 _PERF_HW_CACHE(#opt "-prefetch-misses", name, PREFETCH, MISS) \
192 const struct ctx_opts
{
194 enum context_type ctx_type
;
202 { "pid", CONTEXT_PID
},
203 { "procname", CONTEXT_PROCNAME
},
204 { "prio", CONTEXT_PRIO
},
205 { "nice", CONTEXT_NICE
},
206 { "vpid", CONTEXT_VPID
},
207 { "tid", CONTEXT_TID
},
208 { "vtid", CONTEXT_VTID
},
209 { "ppid", CONTEXT_PPID
},
210 { "vppid", CONTEXT_VPPID
},
212 PERF_HW(cpu
-cycles
, CPU_CYCLES
),
213 PERF_HW(cycles
, CPU_CYCLES
),
214 PERF_HW(stalled
-cycles
-frontend
, STALLED_CYCLES_FRONTEND
),
215 PERF_HW(idle
-cycles
-frontend
, STALLED_CYCLES_FRONTEND
),
216 PERF_HW(stalled
-cycles
-backend
, STALLED_CYCLES_BACKEND
),
217 PERF_HW(idle
-cycles
-backend
, STALLED_CYCLES_BACKEND
),
218 PERF_HW(instructions
, INSTRUCTIONS
),
219 PERF_HW(cache
-references
, CACHE_REFERENCES
),
220 PERF_HW(cache
-misses
, CACHE_MISSES
),
221 PERF_HW(branch
-instructions
, BRANCH_INSTRUCTIONS
),
222 PERF_HW(branches
, BRANCH_INSTRUCTIONS
),
223 PERF_HW(branch
-misses
, BRANCH_MISSES
),
224 PERF_HW(bus
-cycles
, BUS_CYCLES
),
226 PERF_HW_CACHE(L1
-dcache
, L1D
),
227 PERF_HW_CACHE(L1
-icache
, L1I
),
228 PERF_HW_CACHE(LLC
, LL
),
229 PERF_HW_CACHE(dTLB
, DTLB
),
230 _PERF_HW_CACHE("iTLB-loads", ITLB
, READ
, ACCESS
),
231 _PERF_HW_CACHE("iTLB-load-misses", ITLB
, READ
, MISS
),
232 _PERF_HW_CACHE("branch-loads", BPU
, READ
, ACCESS
),
233 _PERF_HW_CACHE("branch-load-misses", BPU
, READ
, MISS
),
236 PERF_SW(cpu
-clock
, CPU_CLOCK
),
237 PERF_SW(task
-clock
, TASK_CLOCK
),
238 PERF_SW(page
-fault
, PAGE_FAULTS
),
239 PERF_SW(faults
, PAGE_FAULTS
),
240 PERF_SW(major
-faults
, PAGE_FAULTS_MAJ
),
241 PERF_SW(minor
-faults
, PAGE_FAULTS_MIN
),
242 PERF_SW(context
-switches
, CONTEXT_SWITCHES
),
243 PERF_SW(cs
, CONTEXT_SWITCHES
),
244 PERF_SW(cpu
-migrations
, CPU_MIGRATIONS
),
245 PERF_SW(migrations
, CPU_MIGRATIONS
),
246 PERF_SW(alignment
-faults
, ALIGNMENT_FAULTS
),
247 PERF_SW(emulation
-faults
, EMULATION_FAULTS
),
248 { NULL
, -1 }, /* Closure */
255 * Context type for command line option parsing.
258 const struct ctx_opts
*opt
;
259 struct cds_list_head list
;
263 * List of context type. Use to enable multiple context on a single command
266 struct ctx_type_list
{
267 struct cds_list_head head
;
269 .head
= CDS_LIST_HEAD_INIT(ctx_type_list
.head
),
273 * Pretty print context type.
275 static void print_ctx_type(FILE *ofp
)
277 const char *indent
= " ";
278 int indent_len
= strlen(indent
);
281 fprintf(ofp
, "%s", indent
);
283 while (ctx_opts
[i
].symbol
!= NULL
) {
284 if (len
> indent_len
) {
285 if (len
+ strlen(ctx_opts
[i
].symbol
) + 2
288 fprintf(ofp
, "%s", indent
);
291 len
+= fprintf(ofp
, ", ");
294 len
+= fprintf(ofp
, "%s", ctx_opts
[i
].symbol
);
302 static void usage(FILE *ofp
)
304 fprintf(ofp
, "usage: lttng add-context -t TYPE\n");
306 fprintf(ofp
, "If no event name is given (-e), the context will be added to the channel\n");
307 fprintf(ofp
, "If no channel and no event is given (-c/-e), the context\n");
308 fprintf(ofp
, "will be added to all events and all channels.\n");
310 fprintf(ofp
, "Options:\n");
311 fprintf(ofp
, " -h, --help Show this help\n");
312 fprintf(ofp
, " --list-options Simple listing of options\n");
313 fprintf(ofp
, " -s, --session Apply on session name\n");
314 fprintf(ofp
, " -c, --channel NAME Apply on channel\n");
315 fprintf(ofp
, " -e, --event NAME Apply on event\n");
316 fprintf(ofp
, " -k, --kernel Apply for the kernel tracer\n");
318 fprintf(ofp
, " -u, --userspace [CMD] Apply for the user-space tracer\n");
319 fprintf(ofp
, " If no CMD, the domain used is UST global\n");
320 fprintf(ofp
, " or else the domain is UST EXEC_NAME\n");
321 fprintf(ofp
, " -p, --pid PID If -u, apply to specific PID (domain: UST PID)\n");
323 fprintf(ofp
, " -u, --userspace Apply for the user-space tracer\n");
325 fprintf(ofp
, " -t, --type TYPE Context type. You can repeat that option on\n");
326 fprintf(ofp
, " the command line.\n");
327 fprintf(ofp
, " TYPE can be one of the strings below:\n");
330 fprintf(ofp
, "Example:\n");
331 fprintf(ofp
, "This command will add the context information 'prio' and two perf\n"
332 "counters: hardware branch misses and cache misses, to all events\n"
333 "in the trace data output:\n");
334 fprintf(ofp
, "# lttng add-context -k -t prio -t perf:branch-misses -t perf:cache-misses\n");
339 * Find context numerical value from string.
341 static int find_ctx_type_idx(const char *opt
)
345 while (ctx_opts
[i
].symbol
!= NULL
) {
346 if (strcmp(opt
, ctx_opts
[i
].symbol
) == 0) {
358 * Add context to channel or event.
360 static int add_context(char *session_name
)
362 int ret
= CMD_SUCCESS
;
363 struct lttng_event_context context
;
364 struct lttng_domain dom
;
365 struct ctx_type
*type
;
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 context type given */
385 cds_list_for_each_entry(type
, &ctx_type_list
.head
, list
) {
386 context
.ctx
= 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 fprintf(stderr
, "%s: ", type
->opt
->symbol
);
407 MSG("%s context %s added to %s event in %s",
408 opt_kernel
? "kernel" : "UST", type
->opt
->symbol
,
409 opt_event_name
? opt_event_name
: "all",
410 opt_channel_name
? opt_channel_name
: "all channels");
415 lttng_destroy_handle(handle
);
421 * Add context on channel or event.
423 int cmd_add_context(int argc
, const char **argv
)
425 int index
, opt
, ret
= CMD_SUCCESS
;
426 static poptContext pc
;
427 struct ctx_type
*type
, *tmptype
;
428 char *session_name
= NULL
;
435 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
436 poptReadDefaultConfig(pc
, 0);
438 while ((opt
= poptGetNextOpt(pc
)) != -1) {
445 type
= malloc(sizeof(struct ctx_type
));
447 perror("malloc ctx_type");
451 index
= find_ctx_type_idx(opt_type
);
453 ERR("Unknown context type %s", opt_type
);
456 type
->opt
= &ctx_opts
[index
];
457 if (type
->opt
->ctx_type
== -1) {
458 ERR("Unknown context type %s", opt_type
);
460 cds_list_add(&type
->list
, &ctx_type_list
.head
);
466 opt_cmd_name
= poptGetOptArg(pc
);
469 case OPT_LIST_OPTIONS
:
470 list_cmd_options(stdout
, long_options
);
480 if (!opt_session_name
) {
481 session_name
= get_session_name();
482 if (session_name
== NULL
) {
487 session_name
= opt_session_name
;
490 ret
= add_context(session_name
);
492 /* Cleanup allocated memory */
493 cds_list_for_each_entry_safe(type
, tmptype
, &ctx_type_list
.head
, list
) {