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>
35 #define PRINT_LINE_LEN 80
37 static char *opt_event_name
;
38 static char *opt_channel_name
;
39 static char *opt_session_name
;
40 static int *opt_kernel
;
41 static int opt_pid_all
;
42 static int opt_userspace
;
50 static struct lttng_handle
*handle
;
53 * Taken from the LTTng ABI
57 CONTEXT_PERF_COUNTER
= 1,
69 * Taken from the Perf ABI (all enum perf_*)
72 PERF_TYPE_HARDWARE
= 0,
73 PERF_TYPE_SOFTWARE
= 1,
74 PERF_TYPE_HW_CACHE
= 3,
77 enum perf_count_hard
{
78 PERF_COUNT_HW_CPU_CYCLES
= 0,
79 PERF_COUNT_HW_INSTRUCTIONS
= 1,
80 PERF_COUNT_HW_CACHE_REFERENCES
= 2,
81 PERF_COUNT_HW_CACHE_MISSES
= 3,
82 PERF_COUNT_HW_BRANCH_INSTRUCTIONS
= 4,
83 PERF_COUNT_HW_BRANCH_MISSES
= 5,
84 PERF_COUNT_HW_BUS_CYCLES
= 6,
85 PERF_COUNT_HW_STALLED_CYCLES_FRONTEND
= 7,
86 PERF_COUNT_HW_STALLED_CYCLES_BACKEND
= 8,
89 enum perf_count_soft
{
90 PERF_COUNT_SW_CPU_CLOCK
= 0,
91 PERF_COUNT_SW_TASK_CLOCK
= 1,
92 PERF_COUNT_SW_PAGE_FAULTS
= 2,
93 PERF_COUNT_SW_CONTEXT_SWITCHES
= 3,
94 PERF_COUNT_SW_CPU_MIGRATIONS
= 4,
95 PERF_COUNT_SW_PAGE_FAULTS_MIN
= 5,
96 PERF_COUNT_SW_PAGE_FAULTS_MAJ
= 6,
97 PERF_COUNT_SW_ALIGNMENT_FAULTS
= 7,
98 PERF_COUNT_SW_EMULATION_FAULTS
= 8,
102 * Generalized hardware cache events:
104 * { L1-D, L1-I, LLC, ITLB, DTLB, BPU } x
105 * { read, write, prefetch } x
106 * { accesses, misses }
108 enum perf_hw_cache_id
{
109 PERF_COUNT_HW_CACHE_L1D
= 0,
110 PERF_COUNT_HW_CACHE_L1I
= 1,
111 PERF_COUNT_HW_CACHE_LL
= 2,
112 PERF_COUNT_HW_CACHE_DTLB
= 3,
113 PERF_COUNT_HW_CACHE_ITLB
= 4,
114 PERF_COUNT_HW_CACHE_BPU
= 5,
116 PERF_COUNT_HW_CACHE_MAX
, /* non-ABI */
119 enum perf_hw_cache_op_id
{
120 PERF_COUNT_HW_CACHE_OP_READ
= 0,
121 PERF_COUNT_HW_CACHE_OP_WRITE
= 1,
122 PERF_COUNT_HW_CACHE_OP_PREFETCH
= 2,
124 PERF_COUNT_HW_CACHE_OP_MAX
, /* non-ABI */
127 enum perf_hw_cache_op_result_id
{
128 PERF_COUNT_HW_CACHE_RESULT_ACCESS
= 0,
129 PERF_COUNT_HW_CACHE_RESULT_MISS
= 1,
131 PERF_COUNT_HW_CACHE_RESULT_MAX
, /* non-ABI */
134 static struct poptOption long_options
[] = {
135 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
136 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
137 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
138 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
139 {"event", 'e', POPT_ARG_STRING
, &opt_event_name
, 0, 0, 0},
140 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
141 {"userspace", 'u', POPT_ARG_VAL
, &opt_userspace
, 1, 0, 0},
142 {"all", 0, POPT_ARG_VAL
, &opt_pid_all
, 1, 0, 0},
143 {"pid", 'p', POPT_ARG_INT
, &opt_pid
, 0, 0, 0},
144 {"type", 't', POPT_ARG_STRING
, 0, OPT_TYPE
, 0, 0},
145 {0, 0, 0, 0, 0, 0, 0}
151 #define PERF_HW(opt, name) \
153 "perf:" #opt, CONTEXT_PERF_COUNTER, \
154 .u.perf = { PERF_TYPE_HARDWARE, PERF_COUNT_HW_##name, },\
157 #define PERF_SW(opt, name) \
159 "perf:" #opt, CONTEXT_PERF_COUNTER, \
160 .u.perf = { PERF_TYPE_SOFTWARE, PERF_COUNT_SW_##name, },\
163 #define _PERF_HW_CACHE(optstr, name, op, result) \
165 "perf:" optstr, CONTEXT_PERF_COUNTER, \
167 PERF_TYPE_HW_CACHE, \
168 (uint64_t) PERF_COUNT_HW_CACHE_##name \
169 | ((uint64_t) PERF_COUNT_HW_CACHE_OP_##op << 8) \
170 | ((uint64_t) PERF_COUNT_HW_CACHE_RESULT_##result << 16), \
174 #define PERF_HW_CACHE(opt, name) \
175 _PERF_HW_CACHE(#opt "-loads", name, READ, ACCESS), \
176 _PERF_HW_CACHE(#opt "-load-misses", name, READ, MISS), \
177 _PERF_HW_CACHE(#opt "-stores", name, WRITE, ACCESS), \
178 _PERF_HW_CACHE(#opt "-store-misses", name, WRITE, MISS), \
179 _PERF_HW_CACHE(#opt "-prefetches", name, PREFETCH, ACCESS), \
180 _PERF_HW_CACHE(#opt "-prefetch-misses", name, PREFETCH, MISS) \
183 const struct ctx_opts
{
185 enum context_type ctx_type
;
193 { "pid", CONTEXT_PID
},
194 { "comm", CONTEXT_COMM
},
195 { "prio", CONTEXT_PRIO
},
196 { "nice", CONTEXT_NICE
},
197 { "vpid", CONTEXT_VPID
},
198 { "tid", CONTEXT_TID
},
199 { "vtid", CONTEXT_VTID
},
200 { "ppid", CONTEXT_PPID
},
201 { "vppid", CONTEXT_VPPID
},
203 PERF_HW(cpu
-cycles
, CPU_CYCLES
),
204 PERF_HW(cycles
, CPU_CYCLES
),
205 PERF_HW(stalled
-cycles
-frontend
, STALLED_CYCLES_FRONTEND
),
206 PERF_HW(idle
-cycles
-frontend
, STALLED_CYCLES_FRONTEND
),
207 PERF_HW(stalled
-cycles
-backend
, STALLED_CYCLES_BACKEND
),
208 PERF_HW(idle
-cycles
-backend
, STALLED_CYCLES_BACKEND
),
209 PERF_HW(instructions
, INSTRUCTIONS
),
210 PERF_HW(cache
-references
, CACHE_REFERENCES
),
211 PERF_HW(cache
-misses
, CACHE_MISSES
),
212 PERF_HW(branch
-instructions
, BRANCH_INSTRUCTIONS
),
213 PERF_HW(branches
, BRANCH_INSTRUCTIONS
),
214 PERF_HW(branch
-misses
, BRANCH_MISSES
),
215 PERF_HW(bus
-cycles
, BUS_CYCLES
),
217 PERF_HW_CACHE(L1
-dcache
, L1D
),
218 PERF_HW_CACHE(L1
-icache
, L1I
),
219 PERF_HW_CACHE(LLC
, LL
),
220 PERF_HW_CACHE(dTLB
, DTLB
),
221 _PERF_HW_CACHE("iTLB-loads", ITLB
, READ
, ACCESS
),
222 _PERF_HW_CACHE("iTLB-load-misses", ITLB
, READ
, MISS
),
223 _PERF_HW_CACHE("branch-loads", BPU
, READ
, ACCESS
),
224 _PERF_HW_CACHE("branch-load-misses", BPU
, READ
, MISS
),
227 PERF_SW(cpu
-clock
, CPU_CLOCK
),
228 PERF_SW(task
-clock
, TASK_CLOCK
),
229 PERF_SW(page
-fault
, PAGE_FAULTS
),
230 PERF_SW(faults
, PAGE_FAULTS
),
231 PERF_SW(major
-faults
, PAGE_FAULTS_MAJ
),
232 PERF_SW(minor
-faults
, PAGE_FAULTS_MIN
),
233 PERF_SW(context
-switches
, CONTEXT_SWITCHES
),
234 PERF_SW(cs
, CONTEXT_SWITCHES
),
235 PERF_SW(cpu
-migrations
, CPU_MIGRATIONS
),
236 PERF_SW(migrations
, CPU_MIGRATIONS
),
237 PERF_SW(alignment
-faults
, ALIGNMENT_FAULTS
),
238 PERF_SW(emulation
-faults
, EMULATION_FAULTS
),
239 { NULL
, -1 }, /* Closure */
246 * Context type for command line option parsing.
249 const struct ctx_opts
*opt
;
250 struct cds_list_head list
;
254 * List of context type. Use to enable multiple context on a single command
257 struct ctx_type_list
{
258 struct cds_list_head head
;
260 .head
= CDS_LIST_HEAD_INIT(ctx_type_list
.head
),
264 * Pretty print context type.
266 static void print_ctx_type(FILE *ofp
)
268 const char *indent
= " ";
269 int indent_len
= strlen(indent
);
272 fprintf(ofp
, "%s", indent
);
274 while (ctx_opts
[i
].symbol
!= NULL
) {
275 if (len
> indent_len
) {
276 if (len
+ strlen(ctx_opts
[i
].symbol
) + 2
279 fprintf(ofp
, "%s", indent
);
282 len
+= fprintf(ofp
, ", ");
285 len
+= fprintf(ofp
, "%s", ctx_opts
[i
].symbol
);
293 static void usage(FILE *ofp
)
295 fprintf(ofp
, "usage: lttng add-context -t TYPE\n");
297 fprintf(ofp
, "If no event name is given (-e), the context will be added to\n");
298 fprintf(ofp
, "all events in the channel.\n");
299 fprintf(ofp
, "If no channel and no event is given (-c/-e), the context\n");
300 fprintf(ofp
, "will be added to all events in all channels.\n");
302 fprintf(ofp
, "Options:\n");
303 fprintf(ofp
, " -h, --help Show this help\n");
304 fprintf(ofp
, " -s, --session Apply on session name\n");
305 fprintf(ofp
, " -c, --channel NAME Apply on channel\n");
306 fprintf(ofp
, " -e, --event NAME Apply on event\n");
307 fprintf(ofp
, " -k, --kernel Apply for the kernel tracer\n");
308 fprintf(ofp
, " -u, --userspace Apply for the user-space tracer\n");
309 fprintf(ofp
, " --all If -u, apply on all traceable apps\n");
310 fprintf(ofp
, " -p, --pid PID If -u, apply on a specific PID\n");
311 fprintf(ofp
, " -t, --type TYPE Context type. You can repeat that option on\n");
312 fprintf(ofp
, " the command line.\n");
313 fprintf(ofp
, " TYPE can be one of the strings below:\n");
316 fprintf(ofp
, "Example:\n");
317 fprintf(ofp
, "This command will add the context information 'prio' and two perf\n"
318 "counters: hardware branch misses and cache misses, to all events\n"
319 "in the trace data output:\n");
320 fprintf(ofp
, "# lttng add-context -k -t prio -t perf:branch-misses -t perf:cache-misses\n");
325 * Find context numerical value from string.
327 static int find_ctx_type_idx(const char *opt
)
331 while (ctx_opts
[i
].symbol
!= NULL
) {
332 if (strcmp(opt
, ctx_opts
[i
].symbol
) == 0) {
344 * Add context to channel or event.
346 static int add_context(char *session_name
)
348 int ret
= CMD_SUCCESS
;
349 struct lttng_event_context context
;
350 struct lttng_domain dom
;
351 struct ctx_type
*type
;
355 dom
.type
= LTTNG_DOMAIN_KERNEL
;
358 handle
= lttng_create_handle(session_name
, &dom
);
359 if (handle
== NULL
) {
364 /* Iterate over all context type given */
365 cds_list_for_each_entry(type
, &ctx_type_list
.head
, list
) {
367 context
.ctx
= type
->opt
->ctx_type
;
368 if (context
.ctx
== LTTNG_EVENT_CONTEXT_PERF_COUNTER
) {
369 context
.u
.perf_counter
.type
= type
->opt
->u
.perf
.type
;
370 context
.u
.perf_counter
.config
= type
->opt
->u
.perf
.config
;
371 strcpy(context
.u
.perf_counter
.name
, type
->opt
->symbol
);
372 /* Replace : and - by _ */
373 while ((ptr
= strchr(context
.u
.perf_counter
.name
, '-')) != NULL
) {
376 while ((ptr
= strchr(context
.u
.perf_counter
.name
, ':')) != NULL
) {
381 DBG("Adding kernel context");
382 ret
= lttng_add_context(handle
, &context
, opt_event_name
,
385 fprintf(stderr
, "%s: ", type
->opt
->symbol
);
388 MSG("Kernel context %s added", type
->opt
->symbol
);
390 } else if (opt_userspace
) { /* User-space tracer action */
392 * TODO: Waiting on lttng UST 2.0
395 } else if (opt_pid
!= 0) {
397 ret
= CMD_NOT_IMPLEMENTED
;
400 ERR("Please specify a tracer (--kernel or --userspace)");
406 lttng_destroy_handle(handle
);
412 * Add context on channel or event.
414 int cmd_add_context(int argc
, const char **argv
)
416 int index
, opt
, ret
= CMD_SUCCESS
;
418 static poptContext pc
;
419 struct ctx_type
*type
, *tmptype
;
420 char *session_name
= NULL
;
427 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
428 poptReadDefaultConfig(pc
, 0);
430 while ((opt
= poptGetNextOpt(pc
)) != -1) {
437 /* Mandatory field */
438 tmp
= poptGetOptArg(pc
);
445 type
= malloc(sizeof(struct ctx_type
));
447 perror("malloc ctx_type");
451 index
= find_ctx_type_idx(tmp
);
453 ERR("Unknown context type %s", tmp
);
456 type
->opt
= &ctx_opts
[index
];
457 if (type
->opt
->ctx_type
== -1) {
458 ERR("Unknown context type %s", tmp
);
460 cds_list_add(&type
->list
, &ctx_type_list
.head
);
471 if (!opt_session_name
) {
472 session_name
= get_session_name();
473 if (session_name
== NULL
) {
478 session_name
= opt_session_name
;
481 ret
= add_context(session_name
);
483 /* Cleanup allocated memory */
484 cds_list_for_each_entry_safe(type
, tmptype
, &ctx_type_list
.head
, list
) {