chiark / gitweb /
Docs: udev.xml: Clarify through a change in word ordering
[elogind.git] / udev / udevadm-info.c
index a2858e5dc94a161992892fe01220f49479272a15..9357f672083e86a36fc22b160d487c3b72a9f706 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2004-2008 Kay Sievers <kay.sievers@vrfy.org>
+ * Copyright (C) 2004-2009 Kay Sievers <kay.sievers@vrfy.org>
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -15,8 +15,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include "config.h"
-
 #include <stdlib.h>
 #include <string.h>
 #include <stdio.h>
 #include <dirent.h>
 #include <errno.h>
 #include <getopt.h>
+#include <fcntl.h>
 #include <sys/stat.h>
 #include <sys/types.h>
 
 #include "udev.h"
 
-static void print_all_attributes(struct udev_device *device, const char *key)
+static bool skip_attribute(const char *name)
 {
-       DIR *dir;
-       struct dirent *dent;
-
-       dir = opendir(udev_device_get_syspath(device));
-       if (dir != NULL) {
-               for (dent = readdir(dir); dent != NULL; dent = readdir(dir)) {
-                       struct stat statbuf;
-                       char filename[UTIL_PATH_SIZE];
-                       const char *value;
-                       size_t len;
-
-                       if (dent->d_name[0] == '.')
-                               continue;
-
-                       if (strcmp(dent->d_name, "uevent") == 0)
-                               continue;
-                       if (strcmp(dent->d_name, "dev") == 0)
-                               continue;
-
-                       util_strlcpy(filename, udev_device_get_syspath(device), sizeof(filename));
-                       util_strlcat(filename, "/", sizeof(filename));
-                       util_strlcat(filename, dent->d_name, sizeof(filename));
-                       if (lstat(filename, &statbuf) != 0)
-                               continue;
-                       if (S_ISLNK(statbuf.st_mode))
-                               continue;
-
-                       value = udev_device_get_attr_value(device, dent->d_name);
-                       if (value == NULL)
-                               continue;
-                       dbg(udev, "attr '%s'='%s'(%zi)\n", dent->d_name, value, len);
-
-                       /* skip nonprintable attributes */
-                       len = strlen(value);
-                       while (len > 0 && isprint(value[len-1]))
-                               len--;
-                       if (len > 0) {
-                               dbg(info, "attribute value of '%s' non-printable, skip\n", dent->d_name);
-                               continue;
-                       }
+       static const char const *skip[] = {
+               "uevent",
+               "dev",
+               "modalias",
+               "resource",
+               "driver",
+               "subsystem",
+               "module",
+       };
+       unsigned int i;
 
-                       printf("    %s{%s}==\"%s\"\n", key, dent->d_name, value);
+       for (i = 0; i < ARRAY_SIZE(skip); i++)
+               if (strcmp(name, skip[i]) == 0)
+                       return true;
+       return false;
+}
+
+static void print_all_attributes(struct udev_device *device, const char *key)
+{
+       struct udev_list_entry *sysattr;
+
+       udev_list_entry_foreach(sysattr, udev_device_get_sysattr_list_entry(device)) {
+               struct udev *udev = udev_device_get_udev(device);
+               const char *name;
+               const char *value;
+               size_t len;
+
+               name = udev_list_entry_get_name(sysattr);
+               if (skip_attribute(name))
+                       continue;
+
+               value = udev_device_get_sysattr_value(device, name);
+               if (value == NULL)
+                       continue;
+               dbg(udev, "attr '%s'='%s'\n", name, value);
+
+               /* skip nonprintable attributes */
+               len = strlen(value);
+               while (len > 0 && isprint(value[len-1]))
+                       len--;
+               if (len > 0) {
+                       dbg(udev, "attribute value of '%s' non-printable, skip\n", name);
+                       continue;
                }
-               closedir(dir);
+
+               printf("    %s{%s}==\"%s\"\n", key, name, value);
        }
        printf("\n");
 }
@@ -88,7 +89,7 @@ static int print_device_chain(struct udev_device *device)
        const char *str;
 
        printf("\n"
-              "Udevinfo starts with the device specified by the devpath and then\n"
+              "Udevadm info starts with the device specified by the devpath and then\n"
               "walks up the chain of parent devices. It prints for every device\n"
               "found, all possible attributes in the udev rules key format.\n"
               "A rule to match, can be composed by the attributes of the device\n"
@@ -128,136 +129,37 @@ static int print_device_chain(struct udev_device *device)
        return 0;
 }
 
-static int print_record_devlinks_cb(struct udev_device *device, const char *value, void *data)
-{
-       size_t len;
-
-       len = strlen(udev_get_dev_path(udev_device_get_udev(device)));
-       printf("S: %s\n", &value[len+1]);
-       return 0;
-}
-
-static int print_record_properties_cb(struct udev_device *device, const char *key, const char *value, void *data)
-{
-       printf("E: %s=%s\n", key, value);
-       return 0;
-}
-
 static void print_record(struct udev_device *device)
 {
        size_t len;
+       const char *str;
        int i;
+       struct udev_list_entry *list_entry;
 
        printf("P: %s\n", udev_device_get_devpath(device));
+
        len = strlen(udev_get_dev_path(udev_device_get_udev(device)));
-       printf("N: %s\n", &udev_device_get_devname(device)[len+1]);
-       i = device_get_devlink_priority(device);
+       str = udev_device_get_devnode(device);
+       if (str != NULL)
+               printf("N: %s\n", &str[len+1]);
+
+       i = udev_device_get_devlink_priority(device);
        if (i != 0)
                printf("L: %i\n", i);
-       i = device_get_num_fake_partitions(device);
-       if (i != 0)
-               printf("A:%u\n", i);
-       i = device_get_ignore_remove(device);
-       if (i != 0)
-               printf("R:%u\n", i);
-       udev_device_get_devlinks(device, print_record_devlinks_cb, NULL);
-       udev_device_get_properties(device, print_record_properties_cb, NULL);
-       printf("\n");
-}
-
-static int export_all_cb(struct udev *udev,
-                        const char *devpath, const char *subsystem, const char *name,
-                        void *data)
-{
-       struct udev_device *device;
 
-       device = udev_device_new_from_devpath(udev, devpath);
-       if (device == NULL)
-               return 0;
-       if (udev_device_get_devname(device) != NULL)
-               print_record(device);
-       udev_device_unref(device);
-       return 0;
-}
-
-static struct udev_device *lookup_device_by_name(struct udev *udev, const char *name)
-{
-       struct udev_device *udev_device = NULL;
-       LIST_HEAD(name_list);
-       int count;
-       struct name_entry *device;
-
-       count = udev_db_get_devices_by_name(udev, name, &name_list);
-       if (count <= 0)
-               goto out;
-
-       info(udev, "found %i devices for '%s'\n", count, name);
-
-       /* select the device that matches */
-       list_for_each_entry(device, &name_list, node) {
-               struct udevice *udevice_loop;
-               char filename[UTIL_PATH_SIZE];
-               struct stat statbuf;
-
-               udevice_loop = udev_device_init(udev);
-               if (udevice_loop == NULL)
-                       break;
-               if (udev_db_get_device(udevice_loop, device->name) != 0)
-                       goto next;
-               info(udev, "found db entry '%s'\n", device->name);
-               /* make sure, we don't get a link of a different device */
-               util_strlcpy(filename, udev_get_dev_path(udev), sizeof(filename));
-               util_strlcat(filename, "/", sizeof(filename));
-               util_strlcat(filename, name, sizeof(filename));
-               if (stat(filename, &statbuf) != 0)
-                       goto next;
-               if (major(udevice_loop->devt) > 0 && udevice_loop->devt != statbuf.st_rdev) {
-                       info(udev, "skip '%s', dev_t doesn't match\n", udevice_loop->name);
-                       goto next;
-               }
-               udev_device = udev_device_new_from_devpath(udev, udevice_loop->dev->devpath);
-               udev_device_cleanup(udevice_loop);
-               break;
-next:
-               udev_device_cleanup(udevice_loop);
-       }
-out:
-       name_list_cleanup(udev, &name_list);
-       return udev_device;
-}
-
-static int add_devlink_cb(struct udev_device *device, const char *value, void *data)
-{
-       char **links = data;
-
-       if (*links == NULL) {
-               *links = strdup(value);
-       } else {
-               char *str;
-
-               asprintf(&str, "%s %s", *links, value);
-               free(*links);
-               *links = str;
+       udev_list_entry_foreach(list_entry, udev_device_get_devlinks_list_entry(device)) {
+               len = strlen(udev_get_dev_path(udev_device_get_udev(device)));
+               printf("S: %s\n", &udev_list_entry_get_name(list_entry)[len+1]);
        }
-       return 0;
-}
 
-static int add_devlink_noroot_cb(struct udev_device *device, const char *value, void *data)
-{
-       size_t len;
-
-       len = strlen(udev_get_dev_path(udev_device_get_udev(device)));
-       value = &value[len+1];
-       return add_devlink_cb(device, value, data);
-}
-
-static int print_property_cb(struct udev_device *device, const char *key, const char *value, void *data)
-{
-       printf("%s=%s\n", key, value);
-       return 0;
+       udev_list_entry_foreach(list_entry, udev_device_get_properties_list_entry(device))
+               printf("E: %s=%s\n",
+                      udev_list_entry_get_name(list_entry),
+                      udev_list_entry_get_value(list_entry));
+       printf("\n");
 }
 
-static int stat_device(const char *name, int export, const char *prefix)
+static int stat_device(const char *name, bool export, const char *prefix)
 {
        struct stat statbuf;
 
@@ -276,29 +178,52 @@ static int stat_device(const char *name, int export, const char *prefix)
        return 0;
 }
 
+static int export_devices(struct udev *udev)
+{
+       struct udev_enumerate *udev_enumerate;
+       struct udev_list_entry *list_entry;
+
+       udev_enumerate = udev_enumerate_new(udev);
+       if (udev_enumerate == NULL)
+               return -1;
+       udev_enumerate_scan_devices(udev_enumerate);
+       udev_list_entry_foreach(list_entry, udev_enumerate_get_list_entry(udev_enumerate)) {
+               struct udev_device *device;
+
+               device = udev_device_new_from_syspath(udev, udev_list_entry_get_name(list_entry));
+               if (device != NULL) {
+                       print_record(device);
+                       udev_device_unref(device);
+               }
+       }
+       udev_enumerate_unref(udev_enumerate);
+       return 0;
+}
+
 int udevadm_info(struct udev *udev, int argc, char *argv[])
 {
        struct udev_device *device = NULL;
-       int root = 0;
-       int export = 0;
+       bool root = 0;
+       bool export = 0;
        const char *export_prefix = NULL;
        char path[UTIL_PATH_SIZE];
        char name[UTIL_PATH_SIZE];
-       char *links;
+       struct udev_list_entry *list_entry;
        int rc = 0;
 
        static const struct option options[] = {
-               { "name", 1, NULL, 'n' },
-               { "path", 1, NULL, 'p' },
-               { "query", 1, NULL, 'q' },
-               { "attribute-walk", 0, NULL, 'a' },
-               { "export-db", 0, NULL, 'e' },
-               { "root", 0, NULL, 'r' },
-               { "device-id-of-file", 1, NULL, 'd' },
-               { "export", 0, NULL, 'x' },
-               { "export-prefix", 1, NULL, 'P' },
-               { "version", 0, NULL, 1 }, /* -V outputs braindead format */
-               { "help", 0, NULL, 'h' },
+               { "name", required_argument, NULL, 'n' },
+               { "path", required_argument, NULL, 'p' },
+               { "query", required_argument, NULL, 'q' },
+               { "attribute-walk", no_argument, NULL, 'a' },
+               { "export-db", no_argument, NULL, 'e' },
+               { "root", no_argument, NULL, 'r' },
+               { "run", no_argument, NULL, 'R' },
+               { "device-id-of-file", required_argument, NULL, 'd' },
+               { "export", no_argument, NULL, 'x' },
+               { "export-prefix", required_argument, NULL, 'P' },
+               { "version", no_argument, NULL, 'V' },
+               { "help", no_argument, NULL, 'h' },
                {}
        };
 
@@ -315,14 +240,15 @@ int udevadm_info(struct udev *udev, int argc, char *argv[])
                QUERY_NAME,
                QUERY_PATH,
                QUERY_SYMLINK,
-               QUERY_ENV,
+               QUERY_PROPERTY,
                QUERY_ALL,
        } query = QUERY_NONE;
 
-       while (1) {
+       for (;;) {
                int option;
+               struct stat statbuf;
 
-               option = getopt_long(argc, argv, "aed:n:p:q:rxPVh", options, NULL);
+               option = getopt_long(argc, argv, "aed:n:p:q:rxP:RVh", options, NULL);
                if (option == -1)
                        break;
 
@@ -335,12 +261,34 @@ int udevadm_info(struct udev *udev, int argc, char *argv[])
                                goto exit;
                        }
                        /* remove /dev if given */
-                       if (strncmp(optarg, udev_get_dev_path(udev), strlen(udev_get_dev_path(udev))) == 0)
-                               util_strlcpy(name, &optarg[strlen(udev_get_dev_path(udev))+1], sizeof(name));
+                       if (strncmp(optarg, udev_get_dev_path(udev), strlen(udev_get_dev_path(udev))) != 0)
+                               util_strscpyl(name, sizeof(name), udev_get_dev_path(udev), "/", optarg, NULL);
                        else
-                               util_strlcpy(name, optarg, sizeof(name));
+                               util_strscpy(name, sizeof(name), optarg);
                        util_remove_trailing_chars(name, '/');
-                       device = lookup_device_by_name(udev, name);
+                       if (stat(name, &statbuf) < 0) {
+                               fprintf(stderr, "device node not found\n");
+                               rc = 2;
+                               goto exit;
+                       } else {
+                               char type;
+
+                               if (S_ISBLK(statbuf.st_mode)) {
+                                       type = 'b';
+                               } else if (S_ISCHR(statbuf.st_mode)) {
+                                       type = 'c';
+                               } else {
+                                       fprintf(stderr, "device node has wrong file type\n");
+                                       rc = 2;
+                                       goto exit;
+                               }
+                               device = udev_device_new_from_devnum(udev, type, statbuf.st_rdev);
+                               if (device == NULL) {
+                                       fprintf(stderr, "device node not found\n");
+                                       rc = 2;
+                                       goto exit;
+                               }
+                       }
                        break;
                case 'p':
                        if (device != NULL) {
@@ -348,83 +296,82 @@ int udevadm_info(struct udev *udev, int argc, char *argv[])
                                rc = 2;
                                goto exit;
                        }
-                       /* remove /sys if given */
-                       if (strncmp(optarg, udev_get_sys_path(udev), strlen(udev_get_sys_path(udev))) == 0)
-                               util_strlcpy(path, &optarg[strlen(udev_get_sys_path(udev))], sizeof(path));
+                       /* add sys dir if needed */
+                       if (strncmp(optarg, udev_get_sys_path(udev), strlen(udev_get_sys_path(udev))) != 0)
+                               util_strscpyl(path, sizeof(path), udev_get_sys_path(udev), optarg, NULL);
                        else
-                               util_strlcpy(path, optarg, sizeof(path));
+                               util_strscpy(path, sizeof(path), optarg);
                        util_remove_trailing_chars(path, '/');
-                       device = udev_device_new_from_devpath(udev, path);
+                       device = udev_device_new_from_syspath(udev, path);
+                       if (device == NULL) {
+                               fprintf(stderr, "device path not found\n");
+                               rc = 2;
+                               goto exit;
+                       }
                        break;
                case 'q':
                        action = ACTION_QUERY;
-                       if (strcmp(optarg, "name") == 0) {
+                       if (strcmp(optarg, "property") == 0 || strcmp(optarg, "env") == 0) {
+                               query = QUERY_PROPERTY;
+                       } else if (strcmp(optarg, "name") == 0) {
                                query = QUERY_NAME;
-                               break;
-                       }
-                       if (strcmp(optarg, "symlink") == 0) {
+                       } else if (strcmp(optarg, "symlink") == 0) {
                                query = QUERY_SYMLINK;
-                               break;
-                       }
-                       if (strcmp(optarg, "path") == 0) {
+                       } else if (strcmp(optarg, "path") == 0) {
                                query = QUERY_PATH;
-                               break;
-                       }
-                       if (strcmp(optarg, "env") == 0) {
-                               query = QUERY_ENV;
-                               break;
-                       }
-                       if (strcmp(optarg, "all") == 0) {
+                       } else if (strcmp(optarg, "all") == 0) {
                                query = QUERY_ALL;
-                               break;
+                       } else {
+                               fprintf(stderr, "unknown query type\n");
+                               rc = 3;
+                               goto exit;
                        }
-                       fprintf(stderr, "unknown query type\n");
-                       rc = 2;
-                       goto exit;
+                       break;
                case 'r':
                        if (action == ACTION_NONE)
                                action = ACTION_ROOT;
-                       root = 1;
+                       root = true;
                        break;
+               case 'R':
+                       printf("%s\n", udev_get_run_path(udev));
+                       goto exit;
                case 'd':
                        action = ACTION_DEVICE_ID_FILE;
-                       util_strlcpy(name, optarg, sizeof(name));
+                       util_strscpy(name, sizeof(name), optarg);
                        break;
                case 'a':
                        action = ACTION_ATTRIBUTE_WALK;
                        break;
                case 'e':
-                       udev_enumerate_devices(udev, NULL, export_all_cb, NULL);
+                       export_devices(udev);
                        goto exit;
                case 'x':
-                       export = 1;
+                       export = true;
                        break;
                case 'P':
                        export_prefix = optarg;
                        break;
-               case 1:
-                       printf("%s\n", VERSION);
-                       goto exit;
                case 'V':
-                       printf("udevinfo, version %s\n", VERSION);
+                       printf("%s\n", VERSION);
                        goto exit;
                case 'h':
                        printf("Usage: udevadm info OPTIONS\n"
-                              "  --query=<type>             query database for the specified value:\n"
+                              "  --query=<type>             query device information:\n"
                               "      name                     name of device node\n"
                               "      symlink                  pointing to node\n"
-                              "      path                     sysfs device path\n"
-                              "      env                      the device related imported environment\n"
+                              "      path                     sys device path\n"
+                              "      property                 the device properties\n"
                               "      all                      all values\n"
-                              "  --path=<devpath>           sysfs device path used for query or chain\n"
-                              "  --name=<name>              node or symlink name used for query\n"
-                              "  --root                     prepend to query result or print udev_root\n"
-                              "  --attribute-walk           print all key matches while walking along chain\n"
+                              "  --path=<syspath>           sys device path used for query or attribute walk\n"
+                              "  --name=<name>              node or symlink name used for query or attribute walk\n"
+                              "  --root                     prepend dev directory to path names\n"
+                              "  --attribute-walk           print all key matches while walking along the chain\n"
                               "                             of parent devices\n"
-                              "  --device-id-of-file=<file> print major/minor of underlying device\n"
+                              "  --device-id-of-file=<file> print major:minor of device containing this file\n"
+                              "  --export                   export key/value pairs\n"
+                              "  --export-prefix            export the key name with a prefix\n"
                               "  --export-db                export the content of the udev database\n"
-                              "  --help                     print this text\n"
-                              "\n");
+                              "  --help\n\n");
                        goto exit;
                default:
                        goto exit;
@@ -440,30 +387,60 @@ int udevadm_info(struct udev *udev, int argc, char *argv[])
                }
 
                switch(query) {
-               case QUERY_NAME:
+               case QUERY_NAME: {
+                       const char *node = udev_device_get_devnode(device);
+
+                       if (node == NULL) {
+                               fprintf(stderr, "no device node found\n");
+                               rc = 5;
+                               goto exit;
+                       }
+
                        if (root) {
-                               printf("%s\n", udev_device_get_devname(device));
+                               printf("%s\n", udev_device_get_devnode(device));
                        } else {
-                               size_t len;
+                               size_t len = strlen(udev_get_dev_path(udev));
 
-                               len = strlen(udev_get_dev_path(udev));
-                               printf("%s\n", &udev_device_get_devname(device)[len+1]);
+                               printf("%s\n", &udev_device_get_devnode(device)[len+1]);
                        }
                        break;
+               }
                case QUERY_SYMLINK:
-                       links = NULL;
-                       if (root)
-                               udev_device_get_devlinks(device, add_devlink_cb, &links);
-                       else
-                               udev_device_get_devlinks(device, add_devlink_noroot_cb, &links);
-                       printf("%s\n", links);
-                       free(links);
+                       list_entry = udev_device_get_devlinks_list_entry(device);
+                       while (list_entry != NULL) {
+                               if (root) {
+                                       printf("%s", udev_list_entry_get_name(list_entry));
+                               } else {
+                                       size_t len;
+
+                                       len = strlen(udev_get_dev_path(udev_device_get_udev(device)));
+                                       printf("%s", &udev_list_entry_get_name(list_entry)[len+1]);
+                               }
+                               list_entry = udev_list_entry_get_next(list_entry);
+                               if (list_entry != NULL)
+                                       printf(" ");
+                       }
+                       printf("\n");
                        break;
                case QUERY_PATH:
                        printf("%s\n", udev_device_get_devpath(device));
                        goto exit;
-               case QUERY_ENV:
-                       udev_device_get_properties(device, print_property_cb, NULL);
+               case QUERY_PROPERTY:
+                       list_entry = udev_device_get_properties_list_entry(device);
+                       while (list_entry != NULL) {
+                               if (export) {
+                                       const char *prefix = export_prefix;
+
+                                       if (prefix == NULL)
+                                               prefix = "";
+                                       printf("%s%s='%s'\n", prefix,
+                                              udev_list_entry_get_name(list_entry),
+                                              udev_list_entry_get_value(list_entry));
+                               } else {
+                                       printf("%s=%s\n", udev_list_entry_get_name(list_entry), udev_list_entry_get_value(list_entry));
+                               }
+                               list_entry = udev_list_entry_get_next(list_entry);
+                       }
                        break;
                case QUERY_ALL:
                        print_record(device);
@@ -476,14 +453,14 @@ int udevadm_info(struct udev *udev, int argc, char *argv[])
        case ACTION_ATTRIBUTE_WALK:
                if (device == NULL) {
                        fprintf(stderr, "query needs a valid device specified by --path= or --name=\n");
-                       rc = 5;
+                       rc = 4;
                        goto exit;
                }
                print_device_chain(device);
                break;
        case ACTION_DEVICE_ID_FILE:
                if (stat_device(name, export, export_prefix) != 0)
-                       rc = 6;
+                       rc = 1;
                break;
        case ACTION_ROOT:
                printf("%s\n", udev_get_dev_path(udev));