2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
16 #include <sys/types.h>
19 #include <urcu/list.h>
21 #include <lttng/domain-internal.h>
22 #include <common/mi-lttng.h>
24 #include "../command.h"
26 static char *opt_channel_name
;
27 static char *opt_session_name
;
28 static int opt_kernel
;
29 static int opt_userspace
;
32 static char *opt_type
;
34 #ifdef LTTNG_EMBED_HELP
35 static const char help_msg
[] =
36 #include <lttng-add-context.1.h>
50 static struct lttng_handle
*handle
;
51 static struct mi_writer
*writer
;
54 * Taken from the LTTng ABI
58 CONTEXT_PERF_COUNTER
= 1, /* Backward compat. */
67 CONTEXT_PTHREAD_ID
= 10,
68 CONTEXT_HOSTNAME
= 11,
70 CONTEXT_PERF_CPU_COUNTER
= 13,
71 CONTEXT_PERF_THREAD_COUNTER
= 14,
72 CONTEXT_APP_CONTEXT
= 15,
73 CONTEXT_INTERRUPTIBLE
= 16,
74 CONTEXT_PREEMPTIBLE
= 17,
75 CONTEXT_NEED_RESCHEDULE
= 18,
76 CONTEXT_MIGRATABLE
= 19,
77 CONTEXT_CALLSTACK_KERNEL
= 20,
78 CONTEXT_CALLSTACK_USER
= 21,
79 CONTEXT_CGROUP_NS
= 22,
102 * Taken from the Perf ABI (all enum perf_*)
105 PERF_TYPE_HARDWARE
= 0,
106 PERF_TYPE_SOFTWARE
= 1,
107 PERF_TYPE_HW_CACHE
= 3,
111 enum perf_count_hard
{
112 PERF_COUNT_HW_CPU_CYCLES
= 0,
113 PERF_COUNT_HW_INSTRUCTIONS
= 1,
114 PERF_COUNT_HW_CACHE_REFERENCES
= 2,
115 PERF_COUNT_HW_CACHE_MISSES
= 3,
116 PERF_COUNT_HW_BRANCH_INSTRUCTIONS
= 4,
117 PERF_COUNT_HW_BRANCH_MISSES
= 5,
118 PERF_COUNT_HW_BUS_CYCLES
= 6,
119 PERF_COUNT_HW_STALLED_CYCLES_FRONTEND
= 7,
120 PERF_COUNT_HW_STALLED_CYCLES_BACKEND
= 8,
123 enum perf_count_soft
{
124 PERF_COUNT_SW_CPU_CLOCK
= 0,
125 PERF_COUNT_SW_TASK_CLOCK
= 1,
126 PERF_COUNT_SW_PAGE_FAULTS
= 2,
127 PERF_COUNT_SW_CONTEXT_SWITCHES
= 3,
128 PERF_COUNT_SW_CPU_MIGRATIONS
= 4,
129 PERF_COUNT_SW_PAGE_FAULTS_MIN
= 5,
130 PERF_COUNT_SW_PAGE_FAULTS_MAJ
= 6,
131 PERF_COUNT_SW_ALIGNMENT_FAULTS
= 7,
132 PERF_COUNT_SW_EMULATION_FAULTS
= 8,
136 * Generalized hardware cache events:
138 * { L1-D, L1-I, LLC, ITLB, DTLB, BPU } x
139 * { read, write, prefetch } x
140 * { accesses, misses }
142 enum perf_hw_cache_id
{
143 PERF_COUNT_HW_CACHE_L1D
= 0,
144 PERF_COUNT_HW_CACHE_L1I
= 1,
145 PERF_COUNT_HW_CACHE_LL
= 2,
146 PERF_COUNT_HW_CACHE_DTLB
= 3,
147 PERF_COUNT_HW_CACHE_ITLB
= 4,
148 PERF_COUNT_HW_CACHE_BPU
= 5,
150 PERF_COUNT_HW_CACHE_MAX
, /* non-ABI */
153 enum perf_hw_cache_op_id
{
154 PERF_COUNT_HW_CACHE_OP_READ
= 0,
155 PERF_COUNT_HW_CACHE_OP_WRITE
= 1,
156 PERF_COUNT_HW_CACHE_OP_PREFETCH
= 2,
158 PERF_COUNT_HW_CACHE_OP_MAX
, /* non-ABI */
161 enum perf_hw_cache_op_result_id
{
162 PERF_COUNT_HW_CACHE_RESULT_ACCESS
= 0,
163 PERF_COUNT_HW_CACHE_RESULT_MISS
= 1,
165 PERF_COUNT_HW_CACHE_RESULT_MAX
, /* non-ABI */
168 static struct poptOption long_options
[] = {
169 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
170 {"help", 'h', POPT_ARG_NONE
, 0, OPT_HELP
, 0, 0},
171 {"session", 's', POPT_ARG_STRING
, &opt_session_name
, 0, 0, 0},
172 {"channel", 'c', POPT_ARG_STRING
, &opt_channel_name
, 0, 0, 0},
173 {"kernel", 'k', POPT_ARG_VAL
, &opt_kernel
, 1, 0, 0},
174 {"userspace", 'u', POPT_ARG_NONE
, 0, OPT_USERSPACE
, 0, 0},
175 {"jul", 'j', POPT_ARG_NONE
, 0, OPT_JUL
, 0, 0},
176 {"log4j", 'l', POPT_ARG_NONE
, 0, OPT_LOG4J
, 0, 0},
177 {"type", 't', POPT_ARG_STRING
, &opt_type
, OPT_TYPE
, 0, 0},
178 {"list", 0, POPT_ARG_NONE
, NULL
, OPT_LIST
, NULL
, NULL
},
179 {"list-options", 0, POPT_ARG_NONE
, NULL
, OPT_LIST_OPTIONS
, NULL
, NULL
},
180 {0, 0, 0, 0, 0, 0, 0}
186 #define PERF_HW(optstr, name, type, hide) \
188 optstr, type, PERF_COUNT_HW_##name, hide \
191 #define PERF_SW(optstr, name, type, hide) \
193 optstr, type, PERF_COUNT_SW_##name, hide \
196 #define _PERF_HW_CACHE(optstr, name, type, op, result, hide) \
199 PERF_COUNT_HW_CACHE_##name, \
200 PERF_COUNT_HW_CACHE_OP_##op, \
201 PERF_COUNT_HW_CACHE_RESULT_##result, \
205 #define PERF_HW_CACHE(optstr, name, type, hide) \
206 _PERF_HW_CACHE(optstr "-loads", name, type, \
207 READ, ACCESS, hide), \
208 _PERF_HW_CACHE(optstr "-load-misses", name, type, \
210 _PERF_HW_CACHE(optstr "-stores", name, type, \
211 WRITE, ACCESS, hide), \
212 _PERF_HW_CACHE(optstr "-store-misses", name, type, \
213 WRITE, MISS, hide), \
214 _PERF_HW_CACHE(optstr "-prefetches", name, type, \
215 PREFETCH, ACCESS, hide), \
216 _PERF_HW_CACHE(optstr "-prefetch-misses", name, type, \
217 PREFETCH, MISS, hide)
220 const struct ctx_opts
{
221 /* Needed for end-of-list item. */
226 ctx_opts(const char *symbol_
, context_type ctx_type_
, bool hide_help_
= false)
227 : symbol((char *) symbol_
), ctx_type(ctx_type_
), hide_help(hide_help_
)
230 ctx_opts(const char *symbol_
, context_type ctx_type_
, perf_count_hard perf_count_hard
, bool hide_help_
)
231 : ctx_opts(symbol_
, ctx_type_
, hide_help_
)
233 u
.perf
.type
= PERF_TYPE_HARDWARE
;
234 u
.perf
.config
= perf_count_hard
;
237 ctx_opts(const char *symbol_
, context_type ctx_type_
, perf_count_soft perf_count_soft
, bool hide_help_
)
238 : ctx_opts(symbol_
, ctx_type_
, hide_help_
)
240 u
.perf
.type
= PERF_TYPE_SOFTWARE
;
241 u
.perf
.config
= perf_count_soft
;
244 ctx_opts(const char *symbol_
, context_type ctx_type_
,
245 perf_hw_cache_id perf_hw_cache_id
,
246 perf_hw_cache_op_id perf_hw_cache_op_id
,
247 perf_hw_cache_op_result_id perf_hw_cache_op_result_id
,
249 : ctx_opts(symbol_
, ctx_type_
, hide_help_
)
251 u
.perf
.type
= PERF_TYPE_HW_CACHE
;
252 u
.perf
.config
= perf_hw_cache_id
| perf_hw_cache_op_id
<< 8 | perf_hw_cache_op_result_id
<< 16;
256 enum context_type ctx_type
;
257 bool hide_help
; /* Hide from --help */
270 * These (char *) casts (as well as those in the PERF_* macros) are
271 * safe because we never free these instances of `struct ctx_opts`.
273 { (char *) "pid", CONTEXT_PID
},
274 { (char *) "procname", CONTEXT_PROCNAME
},
275 { (char *) "prio", CONTEXT_PRIO
},
276 { (char *) "nice", CONTEXT_NICE
},
277 { (char *) "vpid", CONTEXT_VPID
},
278 { (char *) "tid", CONTEXT_TID
},
279 { (char *) "pthread_id", CONTEXT_PTHREAD_ID
},
280 { (char *) "vtid", CONTEXT_VTID
},
281 { (char *) "ppid", CONTEXT_PPID
},
282 { (char *) "vppid", CONTEXT_VPPID
},
283 { (char *) "hostname", CONTEXT_HOSTNAME
},
284 { (char *) "ip", CONTEXT_IP
},
285 { (char *) "interruptible", CONTEXT_INTERRUPTIBLE
},
286 { (char *) "preemptible", CONTEXT_PREEMPTIBLE
},
287 { (char *) "need_reschedule", CONTEXT_NEED_RESCHEDULE
},
288 { (char *) "migratable", CONTEXT_MIGRATABLE
},
289 { (char *) "callstack-kernel", CONTEXT_CALLSTACK_KERNEL
},
290 #if HAVE_MODULES_USERSPACE_CALLSTACK_CONTEXT
291 { (char *) "callstack-user", CONTEXT_CALLSTACK_USER
},
293 { (char *) "cgroup_ns", CONTEXT_CGROUP_NS
},
294 { (char *) "ipc_ns", CONTEXT_IPC_NS
},
295 { (char *) "mnt_ns", CONTEXT_MNT_NS
},
296 { (char *) "net_ns", CONTEXT_NET_NS
},
297 { (char *) "pid_ns", CONTEXT_PID_NS
},
298 { (char *) "time_ns", CONTEXT_TIME_NS
},
299 { (char *) "user_ns", CONTEXT_USER_NS
},
300 { (char *) "uts_ns", CONTEXT_UTS_NS
},
301 { (char *) "uid", CONTEXT_UID
},
302 { (char *) "euid", CONTEXT_EUID
},
303 { (char *) "suid", CONTEXT_SUID
},
304 { (char *) "gid", CONTEXT_GID
},
305 { (char *) "egid", CONTEXT_EGID
},
306 { (char *) "sgid", CONTEXT_SGID
},
307 { (char *) "vuid", CONTEXT_VUID
},
308 { (char *) "veuid", CONTEXT_VEUID
},
309 { (char *) "vsuid", CONTEXT_VSUID
},
310 { (char *) "vgid", CONTEXT_VGID
},
311 { (char *) "vegid", CONTEXT_VEGID
},
312 { (char *) "vsgid", CONTEXT_VSGID
},
316 /* Perf per-CPU counters */
317 PERF_HW("perf:cpu:cpu-cycles", CPU_CYCLES
,
318 CONTEXT_PERF_CPU_COUNTER
, 0),
319 PERF_HW("perf:cpu:cycles", CPU_CYCLES
,
320 CONTEXT_PERF_CPU_COUNTER
, 0),
321 PERF_HW("perf:cpu:stalled-cycles-frontend", STALLED_CYCLES_FRONTEND
,
322 CONTEXT_PERF_CPU_COUNTER
, 0),
323 PERF_HW("perf:cpu:idle-cycles-frontend", STALLED_CYCLES_FRONTEND
,
324 CONTEXT_PERF_CPU_COUNTER
, 0),
325 PERF_HW("perf:cpu:stalled-cycles-backend", STALLED_CYCLES_BACKEND
,
326 CONTEXT_PERF_CPU_COUNTER
, 0),
327 PERF_HW("perf:cpu:idle-cycles-backend", STALLED_CYCLES_BACKEND
,
328 CONTEXT_PERF_CPU_COUNTER
, 0),
329 PERF_HW("perf:cpu:instructions", INSTRUCTIONS
,
330 CONTEXT_PERF_CPU_COUNTER
, 0),
331 PERF_HW("perf:cpu:cache-references", CACHE_REFERENCES
,
332 CONTEXT_PERF_CPU_COUNTER
, 0),
333 PERF_HW("perf:cpu:cache-misses", CACHE_MISSES
,
334 CONTEXT_PERF_CPU_COUNTER
, 0),
335 PERF_HW("perf:cpu:branch-instructions", BRANCH_INSTRUCTIONS
,
336 CONTEXT_PERF_CPU_COUNTER
, 0),
337 PERF_HW("perf:cpu:branches", BRANCH_INSTRUCTIONS
,
338 CONTEXT_PERF_CPU_COUNTER
, 0),
339 PERF_HW("perf:cpu:branch-misses", BRANCH_MISSES
,
340 CONTEXT_PERF_CPU_COUNTER
, 0),
341 PERF_HW("perf:cpu:bus-cycles", BUS_CYCLES
,
342 CONTEXT_PERF_CPU_COUNTER
, 0),
344 PERF_HW_CACHE("perf:cpu:L1-dcache", L1D
,
345 CONTEXT_PERF_CPU_COUNTER
, 0),
346 PERF_HW_CACHE("perf:cpu:L1-icache", L1I
,
347 CONTEXT_PERF_CPU_COUNTER
, 0),
348 PERF_HW_CACHE("perf:cpu:LLC", LL
,
349 CONTEXT_PERF_CPU_COUNTER
, 0),
350 PERF_HW_CACHE("perf:cpu:dTLB", DTLB
,
351 CONTEXT_PERF_CPU_COUNTER
, 0),
352 _PERF_HW_CACHE("perf:cpu:iTLB-loads", ITLB
,
353 CONTEXT_PERF_CPU_COUNTER
, READ
, ACCESS
, 0),
354 _PERF_HW_CACHE("perf:cpu:iTLB-load-misses", ITLB
,
355 CONTEXT_PERF_CPU_COUNTER
, READ
, MISS
, 0),
356 _PERF_HW_CACHE("perf:cpu:branch-loads", BPU
,
357 CONTEXT_PERF_CPU_COUNTER
, READ
, ACCESS
, 0),
358 _PERF_HW_CACHE("perf:cpu:branch-load-misses", BPU
,
359 CONTEXT_PERF_CPU_COUNTER
, READ
, MISS
, 0),
361 PERF_SW("perf:cpu:cpu-clock", CPU_CLOCK
,
362 CONTEXT_PERF_CPU_COUNTER
, 0),
363 PERF_SW("perf:cpu:task-clock", TASK_CLOCK
,
364 CONTEXT_PERF_CPU_COUNTER
, 0),
365 PERF_SW("perf:cpu:page-fault", PAGE_FAULTS
,
366 CONTEXT_PERF_CPU_COUNTER
, 0),
367 PERF_SW("perf:cpu:faults", PAGE_FAULTS
,
368 CONTEXT_PERF_CPU_COUNTER
, 0),
369 PERF_SW("perf:cpu:major-faults", PAGE_FAULTS_MAJ
,
370 CONTEXT_PERF_CPU_COUNTER
, 0),
371 PERF_SW("perf:cpu:minor-faults", PAGE_FAULTS_MIN
,
372 CONTEXT_PERF_CPU_COUNTER
, 0),
373 PERF_SW("perf:cpu:context-switches", CONTEXT_SWITCHES
,
374 CONTEXT_PERF_CPU_COUNTER
, 0),
375 PERF_SW("perf:cpu:cs", CONTEXT_SWITCHES
,
376 CONTEXT_PERF_CPU_COUNTER
, 0),
377 PERF_SW("perf:cpu:cpu-migrations", CPU_MIGRATIONS
,
378 CONTEXT_PERF_CPU_COUNTER
, 0),
379 PERF_SW("perf:cpu:migrations", CPU_MIGRATIONS
,
380 CONTEXT_PERF_CPU_COUNTER
, 0),
381 PERF_SW("perf:cpu:alignment-faults", ALIGNMENT_FAULTS
,
382 CONTEXT_PERF_CPU_COUNTER
, 0),
383 PERF_SW("perf:cpu:emulation-faults", EMULATION_FAULTS
,
384 CONTEXT_PERF_CPU_COUNTER
, 0),
386 /* Perf per-thread counters */
387 PERF_HW("perf:thread:cpu-cycles", CPU_CYCLES
,
388 CONTEXT_PERF_THREAD_COUNTER
, 0),
389 PERF_HW("perf:thread:cycles", CPU_CYCLES
,
390 CONTEXT_PERF_THREAD_COUNTER
, 0),
391 PERF_HW("perf:thread:stalled-cycles-frontend", STALLED_CYCLES_FRONTEND
,
392 CONTEXT_PERF_THREAD_COUNTER
, 0),
393 PERF_HW("perf:thread:idle-cycles-frontend", STALLED_CYCLES_FRONTEND
,
394 CONTEXT_PERF_THREAD_COUNTER
, 0),
395 PERF_HW("perf:thread:stalled-cycles-backend", STALLED_CYCLES_BACKEND
,
396 CONTEXT_PERF_THREAD_COUNTER
, 0),
397 PERF_HW("perf:thread:idle-cycles-backend", STALLED_CYCLES_BACKEND
,
398 CONTEXT_PERF_THREAD_COUNTER
, 0),
399 PERF_HW("perf:thread:instructions", INSTRUCTIONS
,
400 CONTEXT_PERF_THREAD_COUNTER
, 0),
401 PERF_HW("perf:thread:cache-references", CACHE_REFERENCES
,
402 CONTEXT_PERF_THREAD_COUNTER
, 0),
403 PERF_HW("perf:thread:cache-misses", CACHE_MISSES
,
404 CONTEXT_PERF_THREAD_COUNTER
, 0),
405 PERF_HW("perf:thread:branch-instructions", BRANCH_INSTRUCTIONS
,
406 CONTEXT_PERF_THREAD_COUNTER
, 0),
407 PERF_HW("perf:thread:branches", BRANCH_INSTRUCTIONS
,
408 CONTEXT_PERF_THREAD_COUNTER
, 0),
409 PERF_HW("perf:thread:branch-misses", BRANCH_MISSES
,
410 CONTEXT_PERF_THREAD_COUNTER
, 0),
411 PERF_HW("perf:thread:bus-cycles", BUS_CYCLES
,
412 CONTEXT_PERF_THREAD_COUNTER
, 0),
414 PERF_HW_CACHE("perf:thread:L1-dcache", L1D
,
415 CONTEXT_PERF_THREAD_COUNTER
, 0),
416 PERF_HW_CACHE("perf:thread:L1-icache", L1I
,
417 CONTEXT_PERF_THREAD_COUNTER
, 0),
418 PERF_HW_CACHE("perf:thread:LLC", LL
,
419 CONTEXT_PERF_THREAD_COUNTER
, 0),
420 PERF_HW_CACHE("perf:thread:dTLB", DTLB
,
421 CONTEXT_PERF_THREAD_COUNTER
, 0),
422 _PERF_HW_CACHE("perf:thread:iTLB-loads", ITLB
,
423 CONTEXT_PERF_THREAD_COUNTER
, READ
, ACCESS
, 0),
424 _PERF_HW_CACHE("perf:thread:iTLB-load-misses", ITLB
,
425 CONTEXT_PERF_THREAD_COUNTER
, READ
, MISS
, 0),
426 _PERF_HW_CACHE("perf:thread:branch-loads", BPU
,
427 CONTEXT_PERF_THREAD_COUNTER
, READ
, ACCESS
, 0),
428 _PERF_HW_CACHE("perf:thread:branch-load-misses", BPU
,
429 CONTEXT_PERF_THREAD_COUNTER
, READ
, MISS
, 0),
431 PERF_SW("perf:thread:cpu-clock", CPU_CLOCK
,
432 CONTEXT_PERF_THREAD_COUNTER
, 0),
433 PERF_SW("perf:thread:task-clock", TASK_CLOCK
,
434 CONTEXT_PERF_THREAD_COUNTER
, 0),
435 PERF_SW("perf:thread:page-fault", PAGE_FAULTS
,
436 CONTEXT_PERF_THREAD_COUNTER
, 0),
437 PERF_SW("perf:thread:faults", PAGE_FAULTS
,
438 CONTEXT_PERF_THREAD_COUNTER
, 0),
439 PERF_SW("perf:thread:major-faults", PAGE_FAULTS_MAJ
,
440 CONTEXT_PERF_THREAD_COUNTER
, 0),
441 PERF_SW("perf:thread:minor-faults", PAGE_FAULTS_MIN
,
442 CONTEXT_PERF_THREAD_COUNTER
, 0),
443 PERF_SW("perf:thread:context-switches", CONTEXT_SWITCHES
,
444 CONTEXT_PERF_THREAD_COUNTER
, 0),
445 PERF_SW("perf:thread:cs", CONTEXT_SWITCHES
,
446 CONTEXT_PERF_THREAD_COUNTER
, 0),
447 PERF_SW("perf:thread:cpu-migrations", CPU_MIGRATIONS
,
448 CONTEXT_PERF_THREAD_COUNTER
, 0),
449 PERF_SW("perf:thread:migrations", CPU_MIGRATIONS
,
450 CONTEXT_PERF_THREAD_COUNTER
, 0),
451 PERF_SW("perf:thread:alignment-faults", ALIGNMENT_FAULTS
,
452 CONTEXT_PERF_THREAD_COUNTER
, 0),
453 PERF_SW("perf:thread:emulation-faults", EMULATION_FAULTS
,
454 CONTEXT_PERF_THREAD_COUNTER
, 0),
457 * Perf per-CPU counters, backward compatibilty for names.
458 * Hidden from help listing.
460 PERF_HW("perf:cpu-cycles", CPU_CYCLES
,
461 CONTEXT_PERF_COUNTER
, 1),
462 PERF_HW("perf:cycles", CPU_CYCLES
,
463 CONTEXT_PERF_COUNTER
, 1),
464 PERF_HW("perf:stalled-cycles-frontend", STALLED_CYCLES_FRONTEND
,
465 CONTEXT_PERF_COUNTER
, 1),
466 PERF_HW("perf:idle-cycles-frontend", STALLED_CYCLES_FRONTEND
,
467 CONTEXT_PERF_COUNTER
, 1),
468 PERF_HW("perf:stalled-cycles-backend", STALLED_CYCLES_BACKEND
,
469 CONTEXT_PERF_COUNTER
, 1),
470 PERF_HW("perf:idle-cycles-backend", STALLED_CYCLES_BACKEND
,
471 CONTEXT_PERF_COUNTER
, 1),
472 PERF_HW("perf:instructions", INSTRUCTIONS
,
473 CONTEXT_PERF_COUNTER
, 1),
474 PERF_HW("perf:cache-references", CACHE_REFERENCES
,
475 CONTEXT_PERF_COUNTER
, 1),
476 PERF_HW("perf:cache-misses", CACHE_MISSES
,
477 CONTEXT_PERF_COUNTER
, 1),
478 PERF_HW("perf:branch-instructions", BRANCH_INSTRUCTIONS
,
479 CONTEXT_PERF_COUNTER
, 1),
480 PERF_HW("perf:branches", BRANCH_INSTRUCTIONS
,
481 CONTEXT_PERF_COUNTER
, 1),
482 PERF_HW("perf:branch-misses", BRANCH_MISSES
,
483 CONTEXT_PERF_COUNTER
, 1),
484 PERF_HW("perf:bus-cycles", BUS_CYCLES
,
485 CONTEXT_PERF_COUNTER
, 1),
487 PERF_HW_CACHE("perf:L1-dcache", L1D
,
488 CONTEXT_PERF_COUNTER
, 1),
489 PERF_HW_CACHE("perf:L1-icache", L1I
,
490 CONTEXT_PERF_COUNTER
, 1),
491 PERF_HW_CACHE("perf:LLC", LL
,
492 CONTEXT_PERF_COUNTER
, 1),
493 PERF_HW_CACHE("perf:dTLB", DTLB
,
494 CONTEXT_PERF_COUNTER
, 1),
495 _PERF_HW_CACHE("perf:iTLB-loads", ITLB
,
496 CONTEXT_PERF_COUNTER
, READ
, ACCESS
, 1),
497 _PERF_HW_CACHE("perf:iTLB-load-misses", ITLB
,
498 CONTEXT_PERF_COUNTER
, READ
, MISS
, 1),
499 _PERF_HW_CACHE("perf:branch-loads", BPU
,
500 CONTEXT_PERF_COUNTER
, READ
, ACCESS
, 1),
501 _PERF_HW_CACHE("perf:branch-load-misses", BPU
,
502 CONTEXT_PERF_COUNTER
, READ
, MISS
, 1),
504 PERF_SW("perf:cpu-clock", CPU_CLOCK
,
505 CONTEXT_PERF_COUNTER
, 1),
506 PERF_SW("perf:task-clock", TASK_CLOCK
,
507 CONTEXT_PERF_COUNTER
, 1),
508 PERF_SW("perf:page-fault", PAGE_FAULTS
,
509 CONTEXT_PERF_COUNTER
, 1),
510 PERF_SW("perf:faults", PAGE_FAULTS
,
511 CONTEXT_PERF_COUNTER
, 1),
512 PERF_SW("perf:major-faults", PAGE_FAULTS_MAJ
,
513 CONTEXT_PERF_COUNTER
, 1),
514 PERF_SW("perf:minor-faults", PAGE_FAULTS_MIN
,
515 CONTEXT_PERF_COUNTER
, 1),
516 PERF_SW("perf:context-switches", CONTEXT_SWITCHES
,
517 CONTEXT_PERF_COUNTER
, 1),
518 PERF_SW("perf:cs", CONTEXT_SWITCHES
,
519 CONTEXT_PERF_COUNTER
, 1),
520 PERF_SW("perf:cpu-migrations", CPU_MIGRATIONS
,
521 CONTEXT_PERF_COUNTER
, 1),
522 PERF_SW("perf:migrations", CPU_MIGRATIONS
,
523 CONTEXT_PERF_COUNTER
, 1),
524 PERF_SW("perf:alignment-faults", ALIGNMENT_FAULTS
,
525 CONTEXT_PERF_COUNTER
, 1),
526 PERF_SW("perf:emulation-faults", EMULATION_FAULTS
,
527 CONTEXT_PERF_COUNTER
, 1),
533 #undef _PERF_HW_CACHE
538 * Context type for command line option parsing.
541 struct ctx_opts
*opt
;
542 struct cds_list_head list
;
546 * List of context type. Use to enable multiple context on a single command
549 struct ctx_type_list
{
550 struct cds_list_head head
;
552 .head
= CDS_LIST_HEAD_INIT(ctx_type_list
.head
),
558 * Find context numerical value from string.
560 * Return -1 if not found.
562 static int find_ctx_type_idx(const char *opt
)
566 while (ctx_opts
[i
].symbol
!= NULL
) {
567 if (strcmp(opt
, ctx_opts
[i
].symbol
) == 0) {
580 enum lttng_domain_type
get_domain(void)
583 return LTTNG_DOMAIN_KERNEL
;
584 } else if (opt_userspace
) {
585 return LTTNG_DOMAIN_UST
;
586 } else if (opt_jul
) {
587 return LTTNG_DOMAIN_JUL
;
588 } else if (opt_log4j
) {
589 return LTTNG_DOMAIN_LOG4J
;
606 ret
= fileno(stdout
);
608 PERROR("Unable to retrieve fileno of stdout");
613 writer
= mi_lttng_writer_create(ret
, lttng_opt_mi
);
619 /* Open command element */
620 ret
= mi_lttng_writer_command_open(writer
,
621 mi_lttng_element_command_add_context
);
627 /* Open output element */
628 ret
= mi_lttng_writer_open_element(writer
,
629 mi_lttng_element_command_output
);
639 int mi_close(enum cmd_error_code success
)
648 /* Close output element */
649 ret
= mi_lttng_writer_close_element(writer
);
656 ret
= mi_lttng_writer_write_element_bool(writer
,
657 mi_lttng_element_command_success
, !success
);
663 /* Command element close */
664 ret
= mi_lttng_writer_command_close(writer
);
674 void populate_context(struct lttng_event_context
*context
,
675 const struct ctx_opts
*opt
)
679 context
->ctx
= (enum lttng_event_context_type
) opt
->ctx_type
;
680 switch (context
->ctx
) {
681 case LTTNG_EVENT_CONTEXT_PERF_COUNTER
:
682 case LTTNG_EVENT_CONTEXT_PERF_CPU_COUNTER
:
683 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER
:
684 context
->u
.perf_counter
.type
= opt
->u
.perf
.type
;
685 context
->u
.perf_counter
.config
= opt
->u
.perf
.config
;
686 strncpy(context
->u
.perf_counter
.name
, opt
->symbol
,
687 LTTNG_SYMBOL_NAME_LEN
);
688 context
->u
.perf_counter
.name
[LTTNG_SYMBOL_NAME_LEN
- 1] = '\0';
689 /* Replace : and - by _ */
690 while ((ptr
= strchr(context
->u
.perf_counter
.name
, '-')) != NULL
) {
693 while ((ptr
= strchr(context
->u
.perf_counter
.name
, ':')) != NULL
) {
697 case LTTNG_EVENT_CONTEXT_APP_CONTEXT
:
698 context
->u
.app_ctx
.provider_name
=
699 opt
->u
.app_ctx
.provider_name
;
700 context
->u
.app_ctx
.ctx_name
=
701 opt
->u
.app_ctx
.ctx_name
;
709 * Pretty print context type.
712 int print_ctx_type(void)
718 struct lttng_event_context context
;
720 memset(&context
, 0, sizeof(context
));
729 /* Open a contexts element */
730 ret
= mi_lttng_writer_open_element(writer
, config_element_contexts
);
737 while (ctx_opts
[i
].symbol
!= NULL
) {
738 if (!ctx_opts
[i
].hide_help
) {
740 populate_context(&context
, &ctx_opts
[i
]);
741 ret
= mi_lttng_context(writer
, &context
, 1);
747 ret
= mi_lttng_writer_write_element_string(
749 mi_lttng_element_context_symbol
,
756 ret
= mi_lttng_writer_close_element(writer
);
762 fprintf(ofp
, "%s\n", ctx_opts
[i
].symbol
);
769 /* Close contexts element */
770 ret
= mi_lttng_writer_close_element(writer
);
777 ret
= mi_close((cmd_error_code
) ret
);
785 * Add context to channel or event.
787 static int add_context(char *session_name
)
789 int ret
= CMD_SUCCESS
, warn
= 0, success
= 0;
790 struct lttng_event_context context
;
791 struct lttng_domain dom
;
792 struct ctx_type
*type
;
794 memset(&context
, 0, sizeof(context
));
795 memset(&dom
, 0, sizeof(dom
));
797 dom
.type
= get_domain();
798 handle
= lttng_create_handle(session_name
, &dom
);
799 if (handle
== NULL
) {
805 /* Open a contexts element */
806 ret
= mi_lttng_writer_open_element(writer
, config_element_contexts
);
812 /* Iterate over all the context types given */
813 cds_list_for_each_entry(type
, &ctx_type_list
.head
, list
) {
814 DBG("Adding context...");
816 populate_context(&context
, type
->opt
);
819 /* We leave context open the update the success of the command */
820 ret
= mi_lttng_context(writer
, &context
, 1);
826 ret
= mi_lttng_writer_write_element_string(writer
,
827 mi_lttng_element_context_symbol
,
835 ret
= lttng_add_context(handle
, &context
, NULL
, opt_channel_name
);
837 ERR("%s: %s", type
->opt
->symbol
, lttng_strerror(ret
));
841 if (opt_channel_name
) {
842 MSG("%s context %s added to channel %s",
843 lttng_domain_type_str(dom
.type
),
847 MSG("%s context %s added to all channels",
848 lttng_domain_type_str(dom
.type
),
855 /* Is the single operation a success ? */
856 ret
= mi_lttng_writer_write_element_bool(writer
,
857 mi_lttng_element_success
, success
);
863 /* Close the context element */
864 ret
= mi_lttng_writer_close_element(writer
);
873 /* Close contexts element */
874 ret
= mi_lttng_writer_close_element(writer
);
883 lttng_destroy_handle(handle
);
886 * This means that at least one add_context failed and tells the user to
887 * look on stderr for error(s).
896 void destroy_ctx_type(struct ctx_type
*type
)
902 free(type
->opt
->symbol
);
909 struct ctx_type
*create_ctx_type(void)
911 struct ctx_type
*type
= (ctx_type
*) zmalloc(sizeof(*type
));
914 PERROR("malloc ctx_type");
918 type
->opt
= (struct ctx_opts
*) zmalloc(sizeof(*type
->opt
));
920 PERROR("malloc ctx_type options");
921 destroy_ctx_type(type
);
930 int find_ctx_type_perf_raw(const char *ctx
, struct ctx_type
*type
)
934 char *tmp_list
, *cur_list
;
936 cur_list
= tmp_list
= strdup(ctx
);
938 PERROR("strdup temp list");
943 /* Looking for "perf:[cpu|thread]:raw:<mask>:<name>". */
947 next
= strtok(cur_list
, ":");
954 if (strncmp(next
, "perf", 4) != 0) {
960 if (strncmp(next
, "cpu", 3) == 0) {
961 type
->opt
->ctx_type
= CONTEXT_PERF_CPU_COUNTER
;
962 } else if (strncmp(next
, "thread", 4) == 0) {
963 type
->opt
->ctx_type
= CONTEXT_PERF_THREAD_COUNTER
;
970 if (strncmp(next
, "raw", 3) != 0) {
979 if (strlen(next
) < 2 || next
[0] != 'r') {
980 ERR("Wrong perf raw mask format: expected rNNN");
985 type
->opt
->u
.perf
.config
= strtoll(next
+ 1, &endptr
, 16);
986 if (errno
!= 0 || !endptr
|| *endptr
) {
987 ERR("Wrong perf raw mask format: expected rNNN");
997 ERR("Too many ':' in perf raw format");
1004 if (field_pos
< 5) {
1005 ERR("Invalid perf counter specifier, expected a specifier of "
1006 "the form perf:cpu:raw:rNNN:<name> or "
1007 "perf:thread:raw:rNNN:<name>");
1021 struct ctx_type
*get_context_type(const char *ctx
)
1024 struct ctx_type
*type
= NULL
;
1025 const char app_ctx_prefix
[] = "$app.";
1026 char *provider_name
= NULL
, *ctx_name
= NULL
;
1027 size_t i
, len
, colon_pos
= 0, provider_name_len
, ctx_name_len
;
1033 type
= create_ctx_type();
1038 /* Check if ctx matches a known static context. */
1039 opt_index
= find_ctx_type_idx(ctx
);
1040 if (opt_index
>= 0) {
1041 *type
->opt
= ctx_opts
[opt_index
];
1042 type
->opt
->symbol
= strdup(ctx_opts
[opt_index
].symbol
);
1046 /* Check if ctx is a raw perf context. */
1047 ret
= find_ctx_type_perf_raw(ctx
, type
);
1049 type
->opt
->u
.perf
.type
= PERF_TYPE_RAW
;
1050 type
->opt
->symbol
= strdup(ctx
);
1051 if (!type
->opt
->symbol
) {
1052 PERROR("Copy perf field name");
1059 * No match found against static contexts; check if it is an app
1063 if (len
<= sizeof(app_ctx_prefix
) - 1) {
1067 /* String starts with $app. */
1068 if (strncmp(ctx
, app_ctx_prefix
, sizeof(app_ctx_prefix
) - 1)) {
1072 /* Validate that the ':' separator is present. */
1073 for (i
= sizeof(app_ctx_prefix
); i
< len
; i
++) {
1074 const char c
= ctx
[i
];
1083 * No colon found or no ctx name ("$app.provider:") or no provider name
1084 * given ("$app.:..."), which is invalid.
1086 if (!colon_pos
|| colon_pos
== len
||
1087 colon_pos
== sizeof(app_ctx_prefix
)) {
1088 ERR("Invalid application context provided: no provider or context name provided.");
1092 provider_name_len
= colon_pos
- sizeof(app_ctx_prefix
) + 2;
1093 provider_name
= (char *) zmalloc(provider_name_len
);
1094 if (!provider_name
) {
1095 PERROR("malloc provider_name");
1098 strncpy(provider_name
, ctx
+ sizeof(app_ctx_prefix
) - 1,
1099 provider_name_len
- 1);
1100 type
->opt
->u
.app_ctx
.provider_name
= provider_name
;
1102 ctx_name_len
= len
- colon_pos
;
1103 ctx_name
= (char *) zmalloc(ctx_name_len
);
1105 PERROR("malloc ctx_name");
1108 strncpy(ctx_name
, ctx
+ colon_pos
+ 1, ctx_name_len
- 1);
1109 type
->opt
->u
.app_ctx
.ctx_name
= ctx_name
;
1110 type
->opt
->ctx_type
= CONTEXT_APP_CONTEXT
;
1111 type
->opt
->symbol
= strdup(ctx
);
1115 free(provider_name
);
1117 destroy_ctx_type(type
);
1122 * Add context to channel or event.
1124 int cmd_add_context(int argc
, const char **argv
)
1126 int opt
, ret
= CMD_SUCCESS
, command_ret
= CMD_SUCCESS
;
1127 static poptContext pc
;
1128 struct ctx_type
*type
, *tmptype
;
1129 char *session_name
= NULL
;
1130 const char *leftover
= NULL
;
1137 pc
= poptGetContext(NULL
, argc
, argv
, long_options
, 0);
1138 poptReadDefaultConfig(pc
, 0);
1140 while ((opt
= poptGetNextOpt(pc
)) != -1) {
1146 ret
= print_ctx_type();
1150 type
= get_context_type(opt_type
);
1152 ERR("Unknown context type %s", opt_type
);
1156 cds_list_add_tail(&type
->list
, &ctx_type_list
.head
);
1168 case OPT_LIST_OPTIONS
:
1169 list_cmd_options(stdout
, long_options
);
1172 ret
= CMD_UNDEFINED
;
1177 leftover
= poptGetArg(pc
);
1179 ERR("Unknown argument: %s", leftover
);
1184 ret
= print_missing_or_multiple_domains(
1185 opt_kernel
+ opt_userspace
+ opt_jul
+ opt_log4j
, true);
1192 ERR("Missing mandatory -t TYPE");
1197 if (!opt_session_name
) {
1198 session_name
= get_session_name();
1199 if (session_name
== NULL
) {
1204 session_name
= opt_session_name
;
1212 command_ret
= add_context(session_name
);
1213 ret
= mi_close((cmd_error_code
) command_ret
);
1219 if (!opt_session_name
) {
1224 if (writer
&& mi_lttng_writer_destroy(writer
)) {
1225 /* Preserve original error code */
1226 ret
= ret
? ret
: LTTNG_ERR_MI_IO_FAIL
;
1229 /* Cleanup allocated memory */
1230 cds_list_for_each_entry_safe(type
, tmptype
, &ctx_type_list
.head
, list
) {
1231 destroy_ctx_type(type
);
1234 /* Overwrite ret if an error occurred during add_context() */
1235 ret
= command_ret
? command_ret
: ret
;
1237 poptFreeContext(pc
);