From: David Goulet Date: Thu, 21 Jul 2011 20:40:24 +0000 (-0400) Subject: Add string options for add-context X-Git-Tag: v2.0-pre2~8 X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=90b9a26847f0eecba018f52e15f91bf992a23712;hp=159c7ff4ea99cd808f89787f66a23152483137d4 Add string options for add-context List of strings can be used for context type, perf type and perf id. Signed-off-by: David Goulet --- diff --git a/doc/quickstart.txt b/doc/quickstart.txt index 1234fea6d..abf61e76c 100644 --- a/doc/quickstart.txt +++ b/doc/quickstart.txt @@ -100,10 +100,10 @@ You can on the same line activate multiple context: 5) Enable perf counter for an event: Again, a new powerful feature is the possibility to add perf counter data -(using the perf API by Ingo Molnar) to the trace on a per event basis. Let say -we want to get the CPU cycles at each define event: +(using the perf API by Ingo Molnar and Thomas Gleixner) to the trace on a per +event basis. Let say we want to get the CPU cycles at each define event: -# lttng add-context -k -e sched_switch -t 1 --perf-name aname --perf-type 0 --perf-id 0 +# lttng add-context -k -e sched_switch -t perf --perf-type hw --perf-id cpu_cycles You'll have to use the add-context help for all possible perf counter values. diff --git a/lttng/commands/add_context.c b/lttng/commands/add_context.c index dd5769e7a..e31157d3d 100644 --- a/lttng/commands/add_context.c +++ b/lttng/commands/add_context.c @@ -17,6 +17,7 @@ */ #define _GNU_SOURCE +#include #include #include #include @@ -33,13 +34,12 @@ static char *opt_event_name; static char *opt_channel_name; -static char *opt_perf_name; static char *opt_session_name; static int *opt_kernel; static int opt_pid_all; static int opt_userspace; -static int opt_perf_type = -1; -static int opt_perf_id = -1; +static char *opt_perf_type; +static char *opt_perf_id; static pid_t opt_pid; enum { @@ -47,17 +47,50 @@ enum { OPT_TYPE, }; -struct ctx_type_list { - struct cds_list_head head; +/* + * Taken from the LTTng ABI + */ +enum context_type { + CONTEXT_PID = 0, + CONTEXT_PERF_COUNTER = 1, + CONTEXT_COMM = 2, + CONTEXT_PRIO = 3, + CONTEXT_NICE = 4, + CONTEXT_VPID = 5, + CONTEXT_TID = 6, + CONTEXT_VTID = 7, + CONTEXT_PPID = 8, + CONTEXT_VPPID = 9, }; -struct ctx_type { - int type; - struct cds_list_head list; +/* + * Taken from the Perf ABI (all enum perf_*) + */ +enum perf_type { + PERF_TYPE_HARDWARE = 0, + PERF_TYPE_SOFTWARE = 1, }; -static struct ctx_type_list ctx_type_list = { - .head = CDS_LIST_HEAD_INIT(ctx_type_list.head), +enum perf_count_hard { + PERF_COUNT_HW_CPU_CYCLES = 0, + PERF_COUNT_HW_INSTRUCTIONS = 1, + PERF_COUNT_HW_CACHE_REFERENCES = 2, + PERF_COUNT_HW_CACHE_MISSES = 3, + PERF_COUNT_HW_BRANCH_INSTRUCTIONS = 4, + PERF_COUNT_HW_BRANCH_MISSES = 5, + PERF_COUNT_HW_BUS_CYCLES = 6, +}; + +enum perf_count_soft { + PERF_COUNT_SW_CPU_CLOCK = 0, + PERF_COUNT_SW_TASK_CLOCK = 1, + PERF_COUNT_SW_PAGE_FAULTS = 2, + PERF_COUNT_SW_CONTEXT_SWITCHES = 3, + PERF_COUNT_SW_CPU_MIGRATIONS = 4, + PERF_COUNT_SW_PAGE_FAULTS_MIN = 5, + PERF_COUNT_SW_PAGE_FAULTS_MAJ = 6, + PERF_COUNT_SW_ALIGNMENT_FAULTS = 7, + PERF_COUNT_SW_EMULATION_FAULTS = 8, }; static struct poptOption long_options[] = { @@ -70,21 +103,170 @@ static struct poptOption long_options[] = { {"userspace", 'u', POPT_ARG_VAL, &opt_userspace, 1, 0, 0}, {"all", 0, POPT_ARG_VAL, &opt_pid_all, 1, 0, 0}, {"pid", 'p', POPT_ARG_INT, &opt_pid, 0, 0, 0}, - {"type", 't', POPT_ARG_INT, 0, OPT_TYPE, 0, 0}, - {"perf-name", 0, POPT_ARG_STRING, &opt_perf_name, 0, 0, 0}, - {"perf-type", 0, POPT_ARG_INT, &opt_perf_type, 0, 0, 0}, - {"perf-id", 0, POPT_ARG_INT, &opt_perf_id, 0, 0, 0}, + {"type", 't', POPT_ARG_STRING, 0, OPT_TYPE, 0, 0}, + {"perf-type", 0, POPT_ARG_STRING, &opt_perf_type, 0, 0, 0}, + {"perf-id", 0, POPT_ARG_STRING, &opt_perf_id, 0, 0, 0}, {0, 0, 0, 0, 0, 0, 0} }; +/* + * Context type for command line option parsing. + */ +struct ctx_type { + int type; + struct cds_list_head list; +}; + +/* + * Perf counter type + */ +static struct ctx_perf_type { + enum perf_type value; + char *symbol; +} ctx_perf_type[] = { + { PERF_TYPE_HARDWARE, "hw" }, + { PERF_TYPE_SOFTWARE, "sw" }, +}; + +/* + * Perf counter IDs + */ +static struct ctx_perf { + enum perf_type type; + union { + enum perf_count_hard hard; + enum perf_count_soft soft; + } id; + char *symbol; +} ctx_perf[] = { + /* Hardware counter */ + { PERF_TYPE_HARDWARE, .id.hard = PERF_COUNT_HW_CPU_CYCLES, "cpu_cycles" }, + { PERF_TYPE_HARDWARE, .id.hard = PERF_COUNT_HW_INSTRUCTIONS, "instr" }, + { PERF_TYPE_HARDWARE, .id.hard = PERF_COUNT_HW_CACHE_REFERENCES, "cache_refs" }, + { PERF_TYPE_HARDWARE, .id.hard = PERF_COUNT_HW_CACHE_MISSES, "cache_miss" }, + { PERF_TYPE_HARDWARE, .id.hard = PERF_COUNT_HW_BRANCH_INSTRUCTIONS, "branch_instr" }, + { PERF_TYPE_HARDWARE, .id.hard = PERF_COUNT_HW_BRANCH_MISSES, "branch_miss" }, + { PERF_TYPE_HARDWARE, .id.hard = PERF_COUNT_HW_BUS_CYCLES, "bus_cycles" }, + /* Sofware counter */ + { PERF_TYPE_SOFTWARE, .id.soft = PERF_COUNT_SW_CPU_CLOCK, "cpu_clock" }, + { PERF_TYPE_SOFTWARE, .id.soft = PERF_COUNT_SW_TASK_CLOCK, "task_clock" }, + { PERF_TYPE_SOFTWARE, .id.soft = PERF_COUNT_SW_PAGE_FAULTS, "page_faults" }, + { PERF_TYPE_SOFTWARE, .id.soft = PERF_COUNT_SW_CONTEXT_SWITCHES, "ctx_switches" }, + { PERF_TYPE_SOFTWARE, .id.soft = PERF_COUNT_SW_CPU_MIGRATIONS, "cpu_migration" }, + { PERF_TYPE_SOFTWARE, .id.soft = PERF_COUNT_SW_PAGE_FAULTS_MIN, "page_faults_minor" }, + { PERF_TYPE_SOFTWARE, .id.soft = PERF_COUNT_SW_PAGE_FAULTS_MAJ, "page_faults_major" }, + { PERF_TYPE_SOFTWARE, .id.soft = PERF_COUNT_SW_ALIGNMENT_FAULTS, "align_faults" }, + { PERF_TYPE_SOFTWARE, .id.soft = PERF_COUNT_SW_EMULATION_FAULTS, "emu_faults" }, + /* Closure */ + { -1, .id.hard = -1 , NULL }, +}; + +/* + * Context options + */ +static struct ctx_opts { + enum context_type value; + char *symbol; +} ctx_opts[] = { + { CONTEXT_PID, "pid" }, + { CONTEXT_PERF_COUNTER, "perf" }, + { CONTEXT_COMM, "comm" }, + { CONTEXT_PRIO, "prio" }, + { CONTEXT_NICE, "nice" }, + { CONTEXT_VPID, "vpid" }, + { CONTEXT_TID, "tid" }, + { CONTEXT_VTID, "vtid" }, + { CONTEXT_PPID, "ppid" }, + { CONTEXT_VPPID, "vppid" }, + { -1, NULL }, /* Closure */ +}; + +/* + * List of context type. Use to enable multiple context on a single command + * line entry. + */ +struct ctx_type_list { + struct cds_list_head head; +} ctx_type_list = { + .head = CDS_LIST_HEAD_INIT(ctx_type_list.head), +}; + +/* + * Pretty print perf type. + */ +static void print_perf_type(FILE *ofp) +{ + fprintf(ofp, " "); + fprintf(ofp, "%s = %d, ", ctx_perf_type[0].symbol, ctx_perf_type[0].value); + fprintf(ofp, "%s = %d\n", ctx_perf_type[1].symbol, ctx_perf_type[1].value); +} + +/* + * Pretty print context type. + */ +static void print_ctx_type(FILE *ofp) +{ + int i = 0; + + fprintf(ofp, " "); + while (ctx_opts[i].symbol != NULL) { + fprintf(ofp, "%s = %d, ", ctx_opts[i].symbol, ctx_opts[i].value); + i++; + if (!(i%3)) { + fprintf(ofp, "\n "); + } + } +} + +/* + * Pretty print perf hardware counter. + */ +static void print_perf_hw(FILE *ofp) +{ + int i = 0, count = 0; + + fprintf(ofp, " "); + while (ctx_perf[i].symbol != NULL) { + if (ctx_perf[i].type == PERF_TYPE_HARDWARE) { + fprintf(ofp, "%s = %d, ", ctx_perf[i].symbol, ctx_perf[i].id.hard); + count++; + if (!(count % 3)) { + fprintf(ofp, "\n "); + } + } + i++; + } + fprintf(ofp, "\n"); +} + +/* + * Pretty print perf software counter. + */ +static void print_perf_sw(FILE *ofp) +{ + int i = 0, count = 0; + + fprintf(ofp, " "); + while (ctx_perf[i].symbol != NULL) { + if (ctx_perf[i].type == PERF_TYPE_SOFTWARE) { + fprintf(ofp, "%s = %d, ", ctx_perf[i].symbol, ctx_perf[i].id.soft); + count++; + if (!(count % 3)) { + fprintf(ofp, "\n "); + } + } + i++; + } + fprintf(ofp, "\n"); +} + /* * usage */ static void usage(FILE *ofp) { - fprintf(ofp, "usage: lttng add-context [options] [context_options]\n"); + fprintf(ofp, "usage: lttng add-context -t TYPE [options] [context_options]\n"); fprintf(ofp, "\n"); - fprintf(ofp, "If no event name is given (-e), the context will be added to " "all events in the channel.\n"); fprintf(ofp, "If no channel and no event is given (-c/-e), the context " @@ -99,51 +281,138 @@ static void usage(FILE *ofp) fprintf(ofp, " -u, --userspace Apply for the user-space tracer\n"); fprintf(ofp, " --all If -u, apply on all traceable apps\n"); fprintf(ofp, " -p, --pid PID If -u, apply on a specific PID\n"); - fprintf(ofp, " -t, --type TYPE Context type. TYPE must be a numerical value:\n"); - fprintf(ofp, " KERNEL_CONTEXT_PID = 0\n"); - fprintf(ofp, " KERNEL_CONTEXT_PERF_COUNTER = 1\n"); - fprintf(ofp, " KERNEL_CONTEXT_COMM = 2\n"); - fprintf(ofp, " KERNEL_CONTEXT_PRIO = 3\n"); - fprintf(ofp, " KERNEL_CONTEXT_NICE = 4\n"); - fprintf(ofp, " KERNEL_CONTEXT_VPID = 5\n"); - fprintf(ofp, " KERNEL_CONTEXT_TID = 6\n"); - fprintf(ofp, " KERNEL_CONTEXT_VTID = 7\n"); - fprintf(ofp, " KERNEL_CONTEXT_PPID = 8\n"); - fprintf(ofp, " KERNEL_CONTEXT_VPPID = 9\n"); + fprintf(ofp, " -t, --type TYPE Context type. You can repeat that option on the command line.\n"); + fprintf(ofp, " TYPE can be a digit or a string below:\n"); + print_ctx_type(ofp); fprintf(ofp, "\n"); fprintf(ofp, "Context options:\n"); - fprintf(ofp, " --perf-name NAME Perf event name\n"); - fprintf(ofp, " --perf-type TYPE Perf event type. TYPE must be a numeric value:\n"); - fprintf(ofp, " PERF_TYPE_HARDWARE = 0\n"); - fprintf(ofp, " PERF_TYPE_SOFTWARE = 1\n"); - fprintf(ofp, " --perf-id ID Perf event id. ID must be a numeric value:\n"); - fprintf(ofp, " Hardware IDs (0):\n"); - fprintf(ofp, " PERF_COUNT_HW_CPU_CYCLES = 0\n"); - fprintf(ofp, " PERF_COUNT_HW_INSTRUCTIONS = 1\n"); - fprintf(ofp, " PERF_COUNT_HW_CACHE_REFERENCES = 2\n"); - fprintf(ofp, " PERF_COUNT_HW_CACHE_MISSES = 3\n"); - fprintf(ofp, " PERF_COUNT_HW_BRANCH_INSTRUCTIONS = 4\n"); - fprintf(ofp, " PERF_COUNT_HW_BRANCH_MISSES = 5\n"); - fprintf(ofp, " PERF_COUNT_HW_BUS_CYCLES = 6\n"); - fprintf(ofp, " Software IDs (1):\n"); - fprintf(ofp, " PERF_COUNT_SW_CPU_CLOCK = 0\n"); - fprintf(ofp, " PERF_COUNT_SW_TASK_CLOCK = 1\n"); - fprintf(ofp, " PERF_COUNT_SW_PAGE_FAULTS = 2\n"); - fprintf(ofp, " PERF_COUNT_SW_CONTEXT_SWITCHES = 3\n"); - fprintf(ofp, " PERF_COUNT_SW_CPU_MIGRATIONS = 4\n"); - fprintf(ofp, " PERF_COUNT_SW_PAGE_FAULTS_MIN = 5\n"); - fprintf(ofp, " PERF_COUNT_SW_PAGE_FAULTS_MAJ = 6\n"); + fprintf(ofp, " --perf-type TYPE Perf event type. TYPE can be a digit or a string below:\n"); + print_perf_type(ofp); + fprintf(ofp, " --perf-id ID Perf event id. ID can be a digit or a string below:\n"); + fprintf(ofp, " Hardware IDs (%s: %d):\n", ctx_perf_type[0].symbol, ctx_perf_type[0].value); + print_perf_hw(ofp); + fprintf(ofp, " Software IDs (%s: %d):\n", ctx_perf_type[1].symbol, ctx_perf_type[1].value); + print_perf_sw(ofp); + fprintf(ofp, "Example:\n"); + fprintf(ofp, "This command will add the context information 'prio' and a perf counter hardware branch miss to\n" + "the 'sys_enter' event in the trace data output.\n"); + fprintf(ofp, "# lttng add-context -k -e sys_enter -t prio -t perf --perf-type hw --perf-id branch_miss\n"); fprintf(ofp, "\n"); } /* - * add_context - * - * Add context to channel or event. + * Return perf hardware counter index. + */ +static int find_perf_idx(const char *opt) +{ + int ret = -1, i = 0; + + while (ctx_perf[i].symbol != NULL) { + if (strcmp(opt, ctx_perf[i].symbol) == 0) { + ret = i; + goto end; + } + i++; + } + +end: + return ret; +} + +/* + * Return perf type index in global array. + */ +static int find_perf_type_idx(const char *opt) +{ + int ret = -1, i = 0; + + while (ctx_perf_type[i].symbol != NULL) { + if (strcmp(opt, ctx_perf_type[i].symbol) == 0) { + ret = i; + goto end; + } + i++; + } + +end: + return ret; +} + +/* + * Return perf counter index + */ +static int find_perf_symbol_idx(int type, int id) +{ + int ret = -1, i = 0; + + while (ctx_perf[i].symbol != NULL) { + if (ctx_perf[i].type == type) { + switch (type) { + case PERF_TYPE_HARDWARE: + if (ctx_perf[i].id.hard == id) { + ret = i; + goto end; + } + break; + case PERF_TYPE_SOFTWARE: + if (ctx_perf[i].id.soft == id) { + ret = i; + goto end; + } + break; + } + } + i++; + } + +end: + return ret; +} + +/* + * Find context numerical value from string. + */ +static int find_ctx_type_idx(const char *opt) +{ + int ret = -1, i = 0; + + while (ctx_opts[i].symbol != NULL) { + if (strcmp(opt, ctx_opts[i].symbol) == 0) { + ret = i; + goto end; + } + i++; + } + +end: + return ret; +} + +/* + * Return context symbol index + */ +static int find_ctx_symbol_idx(int type) +{ + int ret = -1, i = 0; + + while (ctx_opts[i].symbol != NULL) { + if (type == ctx_opts[i].value) { + ret = i; + goto end; + } + i++; + } + +end: + return ret; +} + +/* + * Add context to channel or event. */ static int add_context(void) { - int ret = CMD_SUCCESS; + int ret = CMD_SUCCESS, index; struct lttng_event_context context; struct lttng_domain dom; struct ctx_type *type; @@ -157,22 +426,41 @@ static int add_context(void) cds_list_for_each_entry(type, &ctx_type_list.head, list) { context.ctx = type->type; if (type->type == LTTNG_KERNEL_CONTEXT_PERF_COUNTER) { - /* Not defined */ - if (opt_perf_type == -1) { - ERR("No perf event type given. Please use --perf-type TYPE."); - goto error; + /* Check perf type */ + if (isdigit(*opt_perf_type)) { + context.u.perf_counter.type = atoi(opt_perf_type); + } else { + index = find_perf_type_idx(opt_perf_type); + if (index == -1) { + ERR("Bad event type given. Please use --perf-type TYPE."); + goto error; + } + context.u.perf_counter.type = ctx_perf_type[index].value; } - context.u.perf_counter.type = opt_perf_type; - if (opt_perf_id == -1) { - ERR("No perf event id given. Please use --perf-id ID."); - goto error; + + /* Check perf counter ID */ + if (isdigit(*opt_perf_id)) { + context.u.perf_counter.config = atoi(opt_perf_id); + index = find_perf_symbol_idx(context.u.perf_counter.type, + context.u.perf_counter.config); + } else { + index = find_perf_idx(opt_perf_id); + switch (context.u.perf_counter.type) { + case PERF_TYPE_HARDWARE: + context.u.perf_counter.config = ctx_perf[index].id.hard; + break; + case PERF_TYPE_SOFTWARE: + context.u.perf_counter.config = ctx_perf[index].id.soft; + break; + } } - context.u.perf_counter.config = opt_perf_id; - if (opt_perf_name == NULL) { - ERR("No perf name given. Please use --perf-name NAME."); + + if (index == -1) { + ERR("Bad perf event id given. Please use --perf-id ID."); goto error; } - strncpy(context.u.perf_counter.name, opt_perf_name, + + strncpy(context.u.perf_counter.name, ctx_perf[index].symbol, LTTNG_SYMBOL_NAME_LEN); } @@ -187,9 +475,10 @@ static int add_context(void) goto error; } else { if (type->type == LTTNG_KERNEL_CONTEXT_PERF_COUNTER) { - MSG("Perf counter context added"); + MSG("Perf counter %s added", context.u.perf_counter.name); } else { - MSG("Kernel context %d added", type->type); + index = find_ctx_symbol_idx(type->type); + MSG("Kernel context %s added", ctx_opts[index].symbol); } } } else if (opt_userspace) { /* User-space tracer action */ @@ -212,13 +501,11 @@ error: } /* - * cmd_add_context - * - * Add context on channel or event. + * Add context on channel or event. */ int cmd_add_context(int argc, const char **argv) { - int opt, ret = CMD_SUCCESS; + int index, opt, ret = CMD_SUCCESS; char *tmp; static poptContext pc; struct ctx_type *type; @@ -252,8 +539,22 @@ int cmd_add_context(int argc, const char **argv) ret = -1; goto end; } - type->type = atoi(tmp); - cds_list_add(&type->list, &ctx_type_list.head); + /* Numerical value are allowed also */ + if (isdigit(*tmp)) { + type->type = atoi(tmp); + } else { + index = find_ctx_type_idx(tmp); + if (index < 0) { + ERR("Unknown context type %s", tmp); + goto end; + } + type->type = ctx_opts[index].value; + } + if (type->type == -1) { + ERR("Unknown context type %s", tmp); + } else { + cds_list_add(&type->list, &ctx_type_list.head); + } free(tmp); break; default: