lttng {add,list,remove}-trigger: rename user id to owner uid
[lttng-tools.git] / src / bin / lttng / commands / add_trigger.c
index b976ffce92432eb269455aec266d13e67b246513..b1ec6dd4780b11008a9583765b7ade979207e7d0 100644 (file)
@@ -40,23 +40,18 @@ enum {
        OPT_CONDITION,
        OPT_ACTION,
        OPT_ID,
-       OPT_USER_ID,
+       OPT_OWNER_UID,
        OPT_RATE_POLICY,
 
        OPT_NAME,
        OPT_FILTER,
        OPT_EXCLUDE_NAMES,
        OPT_EVENT_NAME,
-       OPT_LOGLEVEL,
-       OPT_LOGLEVEL_ONLY,
+       OPT_LOG_LEVEL,
 
        OPT_DOMAIN,
-
-       OPT_FUNCTION,
-       OPT_PROBE,
-       OPT_USERSPACE_PROBE,
-       OPT_SYSCALL,
-       OPT_TRACEPOINT,
+       OPT_TYPE,
+       OPT_LOCATION,
 
        OPT_MAX_SIZE,
        OPT_DATA_URL,
@@ -71,18 +66,12 @@ static const struct argpar_opt_descr event_rule_opt_descrs[] = {
        { OPT_FILTER, 'f', "filter", true },
        { OPT_NAME, 'n', "name", true },
        { OPT_EXCLUDE_NAMES, 'x', "exclude-names", true },
-       { OPT_LOGLEVEL, '\0', "loglevel", true },
-       { OPT_LOGLEVEL_ONLY, '\0', "loglevel-only", true },
+       { OPT_LOG_LEVEL, 'l', "log-level", true },
        { OPT_EVENT_NAME, 'E', "event-name", true },
 
        { OPT_DOMAIN, 'd', "domain", true },
-
-       /* Event rule types */
-       { OPT_FUNCTION, '\0', "function", true },
-       { OPT_PROBE, '\0', "probe", true },
-       { OPT_USERSPACE_PROBE, '\0', "userspace-probe", true },
-       { OPT_SYSCALL, '\0', "syscall" },
-       { OPT_TRACEPOINT, '\0', "tracepoint" },
+       { OPT_TYPE, 't', "type", true },
+       { OPT_LOCATION, 'L', "location", true },
 
        /* Capture descriptor */
        { OPT_CAPTURE, '\0', "capture", true },
@@ -126,19 +115,37 @@ end:
 }
 
 static
-bool assign_event_rule_type(enum lttng_event_rule_type *dest,
-               enum lttng_event_rule_type src)
+bool assign_event_rule_type(enum lttng_event_rule_type *dest, const char *arg)
 {
        bool ret;
 
-       if (*dest == LTTNG_EVENT_RULE_TYPE_UNKNOWN || *dest == src) {
-               *dest = src;
-               ret = true;
+       if (*dest != LTTNG_EVENT_RULE_TYPE_UNKNOWN) {
+               ERR("More than one `--type` was specified.");
+               goto error;
+       }
+
+       if (strcmp(arg, "tracepoint") == 0 || strcmp(arg, "logging") == 0) {
+               *dest = LTTNG_EVENT_RULE_TYPE_TRACEPOINT;
+       } else if (strcmp (arg, "kprobe") == 0 || strcmp(arg, "kernel-probe") == 0) {
+               *dest = LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE;
+       } else if (strcmp (arg, "uprobe") == 0 || strcmp(arg, "userspace-probe") == 0) {
+               *dest = LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE;
+       } else if (strcmp (arg, "function") == 0) {
+               *dest = LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION;
+       } else if (strcmp (arg, "syscall") == 0) {
+               *dest = LTTNG_EVENT_RULE_TYPE_SYSCALL;
        } else {
-               ERR("Multiple event types specified.");
-               ret = false;
+               ERR("Invalid `--type` value: %s", arg);
+               goto error;
        }
 
+       ret = true;
+       goto end;
+
+error:
+       ret = false;
+
+end:
        return ret;
 }
 
@@ -175,45 +182,108 @@ int create_exclusion_list_and_validate(const char *event_name,
                char ***exclusion_list);
 
 /*
- * Parse `str` as a log level in domain `domain_type`. Return -1 if the string
- * is not recognized as a valid log level.
+ * Parse `str` as a log level in domain `domain_type`.
+ *
+ * Return the log level in `*log_level`.  Return true in `*log_level_only` if
+ * the string specifies exactly this log level, false if it specifies at least
+ * this log level.
+ *
+ * Return true if the string was successfully parsed as a log level string.
  */
-static
-int parse_loglevel_string(const char *str, enum lttng_domain_type domain_type)
+static bool parse_log_level_string(const char *str,
+               enum lttng_domain_type domain_type,
+               int *log_level,
+               bool *log_level_only)
 {
+       bool ret;
+
        switch (domain_type) {
        case LTTNG_DOMAIN_UST:
        {
-               enum lttng_loglevel loglevel;
-               const int ret = loglevel_name_to_value(str, &loglevel);
+               enum lttng_loglevel log_level_min, log_level_max;
+               if (!loglevel_parse_range_string(
+                                   str, &log_level_min, &log_level_max)) {
+                       goto error;
+               }
+
+               /* Only support VAL and VAL.. for now. */
+               if (log_level_min != log_level_max &&
+                               log_level_max != LTTNG_LOGLEVEL_EMERG) {
+                       goto error;
+               }
 
-               return ret == -1 ? ret : (int) loglevel;
+               *log_level = (int) log_level_min;
+               *log_level_only = log_level_min == log_level_max;
+               break;
        }
        case LTTNG_DOMAIN_LOG4J:
        {
-               enum lttng_loglevel_log4j loglevel;
-               const int ret = loglevel_log4j_name_to_value(str, &loglevel);
+               enum lttng_loglevel_log4j log_level_min, log_level_max;
+               if (!loglevel_log4j_parse_range_string(
+                                   str, &log_level_min, &log_level_max)) {
+                       goto error;
+               }
+
+               /* Only support VAL and VAL.. for now. */
+               if (log_level_min != log_level_max &&
+                               log_level_max != LTTNG_LOGLEVEL_LOG4J_FATAL) {
+                       goto error;
+               }
 
-               return ret == -1 ? ret : (int) loglevel;
+               *log_level = (int) log_level_min;
+               *log_level_only = log_level_min == log_level_max;
+               break;
        }
        case LTTNG_DOMAIN_JUL:
        {
-               enum lttng_loglevel_jul loglevel;
-               const int ret = loglevel_jul_name_to_value(str, &loglevel);
+               enum lttng_loglevel_jul log_level_min, log_level_max;
+               if (!loglevel_jul_parse_range_string(
+                                   str, &log_level_min, &log_level_max)) {
+                       goto error;
+               }
+
+               /* Only support VAL and VAL.. for now. */
+               if (log_level_min != log_level_max &&
+                               log_level_max != LTTNG_LOGLEVEL_JUL_SEVERE) {
+                       goto error;
+               }
 
-               return ret == -1 ? ret : (int) loglevel;
+               *log_level = (int) log_level_min;
+               *log_level_only = log_level_min == log_level_max;
+               break;
        }
        case LTTNG_DOMAIN_PYTHON:
        {
-               enum lttng_loglevel_python loglevel;
-               const int ret = loglevel_python_name_to_value(str, &loglevel);
+               enum lttng_loglevel_python log_level_min, log_level_max;
+               if (!loglevel_python_parse_range_string(
+                                   str, &log_level_min, &log_level_max)) {
+                       goto error;
+               }
+
+               /* Only support VAL and VAL.. for now. */
+               if (log_level_min != log_level_max &&
+                               log_level_max !=
+                                               LTTNG_LOGLEVEL_PYTHON_CRITICAL) {
+                       goto error;
+               }
 
-               return ret == -1 ? ret : (int) loglevel;
+               *log_level = (int) log_level_min;
+               *log_level_only = log_level_min == log_level_max;
+               break;
        }
        default:
                /* Invalid domain type. */
                abort();
        }
+
+       ret = true;
+       goto end;
+
+error:
+       ret = false;
+
+end:
+       return ret;
 }
 
 static int parse_kernel_probe_opts(const char *source,
@@ -557,16 +627,15 @@ struct parse_event_rule_res parse_event_rule(int *argc, const char ***argv)
        char *exclude_names = NULL;
        char **exclusion_list = NULL;
 
-       /* Holds the argument of --probe / --userspace-probe. */
-       char *probe_source = NULL;
-       char *probe_event_name = NULL;
+       /* For userspace / kernel probe and function. */
+       char *location = NULL;
+       char *event_name = NULL;
 
        /* Filter. */
        char *filter = NULL;
 
        /* Log level. */
-       char *loglevel_str = NULL;
-       bool loglevel_only = false;
+       char *log_level_str = NULL;
 
        lttng_dynamic_pointer_array_init(&res.capture_descriptors,
                                destroy_event_expr);
@@ -600,65 +669,34 @@ struct parse_event_rule_res parse_event_rule(int *argc, const char ***argv)
                        switch (item_opt->descr->id) {
                        /* Domains. */
                        case OPT_DOMAIN:
-                               if (!assign_domain_type(&domain_type, item_opt->arg)) {
+                               if (!assign_domain_type(&domain_type,
+                                               item_opt->arg)) {
                                        goto error;
                                }
 
                                break;
-
-                       /* Event rule types */
-                       case OPT_FUNCTION:
+                       case OPT_TYPE:
                                if (!assign_event_rule_type(&event_rule_type,
-                                               LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION)) {
+                                               item_opt->arg)) {
                                        goto error;
                                }
 
                                break;
-                       case OPT_PROBE:
-                               if (!assign_event_rule_type(&event_rule_type,
-                                               LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE)) {
-                                       goto error;
-                               }
-
-                               if (!assign_string(&probe_source, item_opt->arg,
-                                                   "--probe")) {
-                                       goto error;
-                               }
-
-                               break;
-                       case OPT_USERSPACE_PROBE:
-                               if (!assign_event_rule_type(&event_rule_type,
-                                               LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE)) {
-                                       goto error;
-                               }
-
-                               if (!assign_string(&probe_source, item_opt->arg,
-                                                   "--userspace-probe")) {
+                       case OPT_LOCATION:
+                               if (!assign_string(&location,
+                                               item_opt->arg,
+                                               "--location/-L")) {
                                        goto error;
                                }
 
                                break;
                        case OPT_EVENT_NAME:
-                               if (!assign_string(&probe_event_name,
+                               if (!assign_string(&event_name,
                                                    item_opt->arg,
                                                    "--event-name/-E")) {
                                        goto error;
                                }
 
-                               break;
-                       case OPT_SYSCALL:
-                               if (!assign_event_rule_type(&event_rule_type,
-                                               LTTNG_EVENT_RULE_TYPE_SYSCALL)) {
-                                       goto error;
-                               }
-
-                               break;
-                       case OPT_TRACEPOINT:
-                               if (!assign_event_rule_type(&event_rule_type,
-                                               LTTNG_EVENT_RULE_TYPE_TRACEPOINT)) {
-                                       goto error;
-                               }
-
                                break;
                        case OPT_FILTER:
                                if (!assign_string(&filter, item_opt->arg,
@@ -682,15 +720,12 @@ struct parse_event_rule_res parse_event_rule(int *argc, const char ***argv)
                                }
 
                                break;
-                       case OPT_LOGLEVEL:
-                       case OPT_LOGLEVEL_ONLY:
-                               if (!assign_string(&loglevel_str, item_opt->arg,
-                                                   "--loglevel/--loglevel-only")) {
+                       case OPT_LOG_LEVEL:
+                               if (!assign_string(&log_level_str,
+                                                   item_opt->arg, "--log-level/-l")) {
                                        goto error;
                                }
 
-                               loglevel_only = item_opt->descr->id ==
-                                               OPT_LOGLEVEL_ONLY;
                                break;
                        case OPT_CAPTURE:
                        {
@@ -779,20 +814,36 @@ struct parse_event_rule_res parse_event_rule(int *argc, const char ***argv)
        }
 
        /*
+        * Option --location is only applicable to (and mandatory for) event
+        * rules of type {k,u}probe and function.
+        *
         * Option --event-name is only applicable to event rules of type probe.
-        * If omitted, it defaults to the probe location.
+        * If omitted, it defaults to the location.
         */
        switch (event_rule_type) {
        case LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE:
        case LTTNG_EVENT_RULE_TYPE_USERSPACE_PROBE:
-               if (!probe_event_name) {
-                       probe_event_name = strdup(probe_source);
+       case LTTNG_EVENT_RULE_TYPE_KERNEL_FUNCTION:
+               if (!location) {
+                       ERR("Event rule of type %s requires a --location.",
+                       lttng_event_rule_type_str(event_rule_type));
+                       goto error;
+               }
+
+               if (!event_name) {
+                       event_name = strdup(location);
                }
 
                break;
 
        default:
-               if (probe_event_name) {
+               if (location) {
+                       ERR("Can't use --location with %s event rules.",
+                       lttng_event_rule_type_str(event_rule_type));
+                       goto error;
+               }
+
+               if (event_name) {
                        ERR("Can't use --event-name with %s event rules.",
                                        lttng_event_rule_type_str(
                                                        event_rule_type));
@@ -865,9 +916,16 @@ struct parse_event_rule_res parse_event_rule(int *argc, const char ***argv)
                }
        }
 
-       if (loglevel_str && event_rule_type != LTTNG_EVENT_RULE_TYPE_TRACEPOINT) {
-               ERR("Log levels are only applicable to tracepoint event rules.");
-               goto error;
+       if (log_level_str) {
+               if (event_rule_type != LTTNG_EVENT_RULE_TYPE_TRACEPOINT) {
+                       ERR("Log levels are only applicable to tracepoint event rules.");
+                       goto error;
+               }
+
+               if (domain_type == LTTNG_DOMAIN_KERNEL) {
+                       ERR("Log levels are not supported by the kernel tracer.");
+                       goto error;
+               }
        }
 
        /* Finally, create the event rule object. */
@@ -919,26 +977,25 @@ struct parse_event_rule_res parse_event_rule(int *argc, const char ***argv)
                        }
                }
 
-               if (loglevel_str) {
-                       int loglevel;
-
-                       if (domain_type == LTTNG_DOMAIN_KERNEL) {
-                               ERR("Log levels are not supported by the kernel tracer.");
-                               goto error;
-                       }
-
-                       loglevel = parse_loglevel_string(
-                                       loglevel_str, domain_type);
-                       if (loglevel < 0) {
-                               ERR("Failed to parse `%s` as a log level.",
-                                               loglevel_str);
+               /*
+                * ".." is the same as passing no log level option and
+                * correspond the the "ANY" case.
+                */
+               if (log_level_str && strcmp(log_level_str, "..") != 0) {
+                       int log_level;
+                       bool log_level_only;
+
+                       if (!parse_log_level_string(log_level_str, domain_type,
+                                           &log_level, &log_level_only)) {
+                               ERR("Failed to parse log level string `%s`.",
+                                               log_level_str);
                                goto error;
                        }
 
-                       if (loglevel_only) {
-                               log_level_rule = lttng_log_level_rule_exactly_create(loglevel);
+                       if (log_level_only) {
+                               log_level_rule = lttng_log_level_rule_exactly_create(log_level);
                        } else {
-                               log_level_rule = lttng_log_level_rule_at_least_as_severe_as_create(loglevel);
+                               log_level_rule = lttng_log_level_rule_at_least_as_severe_as_create(log_level);
                        }
 
                        if (log_level_rule == NULL) {
@@ -964,7 +1021,7 @@ struct parse_event_rule_res parse_event_rule(int *argc, const char ***argv)
                enum lttng_event_rule_status event_rule_status;
 
                ret = parse_kernel_probe_opts(
-                               probe_source, &kernel_probe_location);
+                               location, &kernel_probe_location);
                if (ret) {
                        ERR("Failed to parse kernel probe location.");
                        goto error;
@@ -979,10 +1036,10 @@ struct parse_event_rule_res parse_event_rule(int *argc, const char ***argv)
 
                event_rule_status =
                                lttng_event_rule_kernel_probe_set_event_name(
-                                               res.er, probe_event_name);
+                                               res.er, event_name);
                if (event_rule_status != LTTNG_EVENT_RULE_STATUS_OK) {
                        ERR("Failed to set kprobe event rule's name to '%s'.",
-                                       probe_event_name);
+                                       event_name);
                        goto error;
                }
 
@@ -994,7 +1051,7 @@ struct parse_event_rule_res parse_event_rule(int *argc, const char ***argv)
                enum lttng_event_rule_status event_rule_status;
 
                ret = parse_userspace_probe_opts(
-                               probe_source, &userspace_probe_location);
+                               location, &userspace_probe_location);
                if (ret) {
                        ERR("Failed to parse user space probe location.");
                        goto error;
@@ -1008,10 +1065,10 @@ struct parse_event_rule_res parse_event_rule(int *argc, const char ***argv)
 
                event_rule_status =
                                lttng_event_rule_userspace_probe_set_event_name(
-                                               res.er, probe_event_name);
+                                               res.er, event_name);
                if (event_rule_status != LTTNG_EVENT_RULE_STATUS_OK) {
                        ERR("Failed to set user space probe event rule's name to '%s'.",
-                                       probe_event_name);
+                                       event_name);
                        goto error;
                }
 
@@ -1071,9 +1128,9 @@ end:
        free(filter);
        free(name);
        free(exclude_names);
-       free(loglevel_str);
-       free(probe_source);
-       free(probe_event_name);
+       free(log_level_str);
+       free(location);
+       free(event_name);
 
        strutils_free_null_terminated_array_of_strings(exclusion_list);
        lttng_kernel_probe_location_destroy(kernel_probe_location);
@@ -2032,7 +2089,7 @@ struct argpar_opt_descr add_trigger_options[] = {
        { OPT_CONDITION, '\0', "condition", true },
        { OPT_ACTION, '\0', "action", true },
        { OPT_NAME, '\0', "name", true },
-       { OPT_USER_ID, '\0', "user-id", true },
+       { OPT_OWNER_UID, '\0', "owner-uid", true },
        ARGPAR_OPT_DESCR_SENTINEL,
 };
 
@@ -2059,7 +2116,7 @@ int cmd_add_trigger(int argc, const char **argv)
        char *error = NULL;
        char *name = NULL;
        int i;
-       char *user_id = NULL;
+       char *owner_uid = NULL;
 
        lttng_dynamic_pointer_array_init(&actions, lttng_actions_destructor);
 
@@ -2165,10 +2222,10 @@ int cmd_add_trigger(int argc, const char **argv)
 
                        break;
                }
-               case OPT_USER_ID:
+               case OPT_OWNER_UID:
                {
-                       if (!assign_string(&user_id, item_opt->arg,
-                                       "--user-id")) {
+                       if (!assign_string(&owner_uid, item_opt->arg,
+                                       "--owner-uid")) {
                                goto error;
                        }
 
@@ -2227,15 +2284,15 @@ int cmd_add_trigger(int argc, const char **argv)
                }
        }
 
-       if (user_id) {
+       if (owner_uid) {
                enum lttng_trigger_status trigger_status;
                char *end;
                long long uid;
 
                errno = 0;
-               uid = strtol(user_id, &end, 10);
-               if (end == user_id || *end != '\0' || errno != 0) {
-                       ERR("Failed to parse `%s` as a user id.", user_id);
+               uid = strtol(owner_uid, &end, 10);
+               if (end == owner_uid || *end != '\0' || errno != 0) {
+                       ERR("Failed to parse `%s` as a user id.", owner_uid);
                }
 
                trigger_status = lttng_trigger_set_owner_uid(trigger, uid);
@@ -2268,6 +2325,6 @@ end:
        lttng_trigger_destroy(trigger);
        free(error);
        free(name);
-       free(user_id);
+       free(owner_uid);
        return ret;
 }
This page took 0.030886 seconds and 4 git commands to generate.