chiark / gitweb /
fix udevinfo output
[elogind.git] / udevinfo.c
index a2f5601b7c9b8518af3c88be5361f54bbe27a8ef..58584d62f807d5851ff4df0e6e701d760f28e176 100644 (file)
@@ -1,9 +1,8 @@
 /*
- * udevinfo - fetches attributes for a device
+ * udevinfo.c - fetches attributes for a device
  *
  * Copyright (C) 2004 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 the
  *     Free Software Foundation version 2 of the License.
 #include <unistd.h>
 #include <errno.h>
 
+#include "libsysfs/sysfs/libsysfs.h"
+#include "udev_libc_wrapper.h"
 #include "udev.h"
+#include "udev_utils.h"
 #include "udev_version.h"
+#include "udev_db.h"
 #include "logging.h"
-#include "udevdb.h"
-#include "libsysfs/libsysfs.h"
-
-
-# define SYSFS_VALUE_MAX 200
 
-char **main_argv;
-int main_argc;
-char **main_envp;
 
-static int print_all_attributes(const char *path)
+#ifdef USE_LOG
+void log_message (int priority, const char *format, ...)
 {
-       struct dlist *attributes;
-       struct sysfs_attribute *attr;
-       struct sysfs_directory *sysfs_dir;
-       char value[SYSFS_VALUE_MAX];
-       int len;
-       int retval = 0;
+       va_list args;
 
-       sysfs_dir = sysfs_open_directory(path);
-       if (sysfs_dir == NULL)
-               return -1;
+       if (priority > udev_log_priority)
+               return;
 
-       attributes = sysfs_get_dir_attributes(sysfs_dir);
-       if (attributes == NULL) {
-               retval = -1;
-               goto exit;
-       }
+       va_start(args, format);
+       vsyslog(priority, format, args);
+       va_end(args);
+}
+#endif
 
-       dlist_for_each_data(attributes, attr, struct sysfs_attribute) {
-               if (attr->value != NULL) {
-                       strncpy(value, attr->value, SYSFS_VALUE_MAX);
-                       len = strlen(value);
-                       if (len == 0)
-                               continue;
-
-                       /* remove trailing newline */
-                       if (value[len-1] == '\n') {
-                               value[len-1] = '\0';
-                               len--;
-                       }
+static void print_all_attributes(struct dlist *attr_list)
+{
+       struct sysfs_attribute *attr;
+       char value[VALUE_SIZE];
+       size_t len;
+
+       dlist_for_each_data(attr_list, attr, struct sysfs_attribute) {
+               if (attr->value == NULL)
+                       continue;
+               len = strlcpy(value, attr->value, sizeof(value));
+               if (len >= sizeof(value)) {
+                       dbg("attribute value of '%s' too long, skip", attr->name);
+                       continue;
+               }
 
-                       /* skip nonprintable values */
-                       while (len) {
-                               if (isprint(value[len-1]) == 0)
-                                       break;
-                               len--;
-                       }
-                       if (len == 0)
-                               printf("    SYSFS_%s=\"%s\"\n", attr->name, value);
+               /* remove trailing newlines */
+               while (len && value[len-1] == '\n')
+                       value[--len] = '\0';
+               /* skip nonprintable attributes */
+               while (len && isprint(value[len-1]))
+                       len--;
+               if (len) {
+                       dbg("attribute value of '%s' non-printable, skip", attr->name);
+                       continue;
                }
+               replace_untrusted_chars(value);
+               printf("    SYSFS{%s}==\"%s\"\n", attr->name, value);
        }
        printf("\n");
-
-exit:
-       sysfs_close_directory(sysfs_dir);
-
-       return retval;
 }
 
-/* callback for database dump */
-static int print_record(char *path, struct udevice *dev)
+static int print_record(struct udevice *udev)
 {
-       printf("P: %s\n", path);
-       printf("N: %s\n", dev->name);
-       printf("M: %#o\n", dev->mode);
-       printf("S: %s\n", dev->symlink);
-       printf("O: %s\n", dev->owner);
-       printf("G: %s\n", dev->group);
-       printf("\n");
+       struct name_entry *name_loop;
+
+       printf("P: %s\n", udev->devpath);
+       printf("N: %s\n", udev->name);
+       list_for_each_entry(name_loop, &udev->symlink_list, node)
+               printf("S: %s\n", name_loop->name);
+
        return 0;
 }
 
-enum query_type {
-       NONE,
-       NAME,
-       PATH,
-       SYMLINK,
-       MODE,
-       OWNER,
-       GROUP
-};
-
 static int print_device_chain(const char *path)
 {
        struct sysfs_class_device *class_dev;
        struct sysfs_class_device *class_dev_parent;
        struct sysfs_attribute *attr;
        struct sysfs_device *sysfs_dev;
-       struct sysfs_device *sysfs_dev_parent;
+       struct dlist *attr_list;
        int retval = 0;
 
        /*  get the class dev */
        class_dev = sysfs_open_class_device_path(path);
        if (class_dev == NULL) {
-               printf("couldn't get the class device\n");
+               fprintf(stderr, "couldn't get the class device\n");
                return -1;
        }
 
-       /* read the 'dev' file for major/minor*/
+       printf("\nudevinfo starts with the device the node belongs to and then walks up the\n"
+              "device chain, to print for every device found, all possibly useful attributes\n"
+              "in the udev key format.\n"
+              "Only attributes within one device section may be used together in one rule,\n"
+              "to match the device for which the node will be created.\n"
+              "\n");
+
+       /* look for the 'dev' file */
        attr = sysfs_get_classdev_attr(class_dev, "dev");
-       if (attr == NULL) {
-               printf("couldn't get the \"dev\" file\n");
-               retval = -1;
-               goto exit;
-       }
-       printf("\ndevice '%s' has major:minor %s", class_dev->path, attr->value);
-       sysfs_close_attribute(attr);
+       if (attr != NULL)
+               printf("device '%s' has major:minor %s", class_dev->path, attr->value);
 
        /* open sysfs class device directory and print all attributes */
        printf("  looking at class device '%s':\n", class_dev->path);
-       if (print_all_attributes(class_dev->path) != 0) {
-               printf("couldn't open class device directory\n");
+       printf("    SUBSYSTEM==\"%s\"\n", class_dev->classname);
+
+       attr_list = sysfs_get_classdev_attributes(class_dev);
+       if (attr_list == NULL) {
+               fprintf(stderr, "couldn't open class device directory\n");
                retval = -1;
                goto exit;
        }
+       print_all_attributes(attr_list);
 
        /* get the device link (if parent exists look here) */
        class_dev_parent = sysfs_get_classdev_parent(class_dev);
-       if (class_dev_parent != NULL) {
-               //sysfs_close_class_device(class_dev);
-               class_dev = class_dev_parent;
-       }
-       sysfs_dev = sysfs_get_classdev_device(class_dev);
+       if (class_dev_parent != NULL)
+               sysfs_dev = sysfs_get_classdev_device(class_dev_parent);
+       else 
+               sysfs_dev = sysfs_get_classdev_device(class_dev);
+       
        if (sysfs_dev != NULL)
-               printf("follow the class device's \"device\"\n");
+               printf("follow the \"device\"-link to the physical device:\n");
 
        /* look the device chain upwards */
        while (sysfs_dev != NULL) {
                printf("  looking at the device chain at '%s':\n", sysfs_dev->path);
-               printf("    BUS=\"%s\"\n", sysfs_dev->bus);
-               printf("    ID=\"%s\"\n", sysfs_dev->bus_id);
-
-               /* open sysfs device directory and print all attributes */
-               print_all_attributes(sysfs_dev->path);
-
-               sysfs_dev_parent = sysfs_get_device_parent(sysfs_dev);
-               if (sysfs_dev_parent == NULL)
+               printf("    BUS==\"%s\"\n", sysfs_dev->bus);
+               printf("    ID==\"%s\"\n", sysfs_dev->bus_id);
+               printf("    DRIVER==\"%s\"\n", sysfs_dev->driver_name);
+
+               attr_list = sysfs_get_device_attributes(sysfs_dev);
+               if (attr_list != NULL)
+                       print_all_attributes(attr_list);
+               else
+                       printf("\n");
+
+               sysfs_dev = sysfs_get_device_parent(sysfs_dev);
+               if (sysfs_dev == NULL)
                        break;
-
-               //sysfs_close_device(sysfs_dev);
-               sysfs_dev = sysfs_dev_parent;
        }
-       sysfs_close_device(sysfs_dev);
 
 exit:
-       //sysfs_close_class_device(class_dev);
+       sysfs_close_class_device(class_dev);
        return retval;
 }
 
-static int process_options(void)
+static int print_dump(const char *devpath, const char *name) {
+       printf("%s=%s/%s\n", devpath, udev_root, name);
+       return 0;
+}
+
+int main(int argc, char *argv[], char *envp[])
 {
        static const char short_options[] = "adn:p:q:rVh";
        int option;
-       int retval = 1;
-       struct udevice dev;
+       struct udevice udev;
        int root = 0;
        int attributes = 0;
-       enum query_type query = NONE;
-       char result[NAME_SIZE] = "";
-       char path[NAME_SIZE] = "";
-       char name[NAME_SIZE] = "";
-       char temp[NAME_SIZE];
+       enum query_type {
+               QUERY_NONE,
+               QUERY_NAME,
+               QUERY_PATH,
+               QUERY_SYMLINK,
+               QUERY_ENV,
+               QUERY_ALL,
+       } query = QUERY_NONE;
+       char path[PATH_SIZE] = "";
+       char name[PATH_SIZE] = "";
+       char temp[PATH_SIZE];
+       struct name_entry *name_loop;
        char *pos;
+       int retval = 0;
+
+       logging_init("udevinfo");
+
+       udev_init_config();
+       udev_init_device(&udev, NULL, NULL, NULL);
 
        /* get command line options */
        while (1) {
-               option = getopt(main_argc, main_argv, short_options);
+               option = getopt(argc, argv, short_options);
                if (option == -1)
                        break;
 
@@ -205,49 +207,45 @@ static int process_options(void)
                switch (option) {
                case 'n':
                        dbg("udev name: %s\n", optarg);
-                       strfieldcpy(name, optarg);
+                       strlcpy(name, optarg, sizeof(name));
                        break;
 
                case 'p':
                        dbg("udev path: %s\n", optarg);
-                       strfieldcpy(path, optarg);
+                       strlcpy(path, optarg, sizeof(path));
                        break;
 
                case 'q':
                        dbg("udev query: %s\n", optarg);
 
                        if (strcmp(optarg, "name") == 0) {
-                               query = NAME;
+                               query = QUERY_NAME;
                                break;
                        }
 
                        if (strcmp(optarg, "symlink") == 0) {
-                               query = SYMLINK;
+                               query = QUERY_SYMLINK;
                                break;
                        }
 
-                       if (strcmp(optarg, "mode") == 0) {
-                               query = MODE;
-                               break;
-                       }
-
-                       if (strcmp(optarg, "owner") == 0) {
-                               query = OWNER;
+                       if (strcmp(optarg, "path") == 0) {
+                               query = QUERY_PATH;
                                break;
                        }
 
-                       if (strcmp(optarg, "group") == 0) {
-                               query = GROUP;
+                       if (strcmp(optarg, "env") == 0) {
+                               query = QUERY_ENV;
                                break;
                        }
 
-                       if (strcmp(optarg, "path") == 0) {
-                               query = PATH;
+                       if (strcmp(optarg, "all") == 0) {
+                               query = QUERY_ALL;
                                break;
                        }
 
-                       printf("unknown query type\n");
-                       exit(1);
+                       fprintf(stderr, "unknown query type\n");
+                       retval = 1;
+                       goto exit;
 
                case 'r':
                        root = 1;
@@ -258,21 +256,15 @@ static int process_options(void)
                        break;
 
                case 'd':
-                       retval = udevdb_open_ro();
-                       if (retval != 0) {
-                               printf("unable to open udev database\n");
-                               exit(2);
-                       }
-                       udevdb_call_foreach(print_record);
-                       udevdb_exit();
-                       exit(0);
+                       udev_db_dump_names(print_dump);
+                       goto exit;
 
                case 'V':
                        printf("udevinfo, version %s\n", UDEV_VERSION);
-                       exit(0);
+                       goto exit;
 
                case 'h':
-                       retval = 0;
+                       retval = 2;
                case '?':
                default:
                        goto help;
@@ -280,13 +272,7 @@ static int process_options(void)
        }
 
        /* process options */
-       if (query != NONE) {
-               retval = udevdb_open_ro();
-               if (retval != 0) {
-                       printf("unable to open udev database\n");
-                       return -EACCES;
-               }
-
+       if (query != QUERY_NONE) {
                if (path[0] != '\0') {
                        /* remove sysfs_path if given */
                        if (strncmp(path, sysfs_path, strlen(sysfs_path)) == 0) {
@@ -294,131 +280,123 @@ static int process_options(void)
                        } else {
                                if (path[0] != '/') {
                                        /* prepend '/' if missing */
-                                       strcat(temp, "/");
-                                       strncat(temp, path, sizeof(path));
+                                       strcpy(temp, "/");
+                                       strlcpy(temp, path, sizeof(temp));
                                        pos = temp;
                                } else {
                                        pos = path;
                                }
                        }
-                       retval = udevdb_get_dev(pos, &dev);
+                       retval = udev_db_get_device(&udev, pos);
                        if (retval != 0) {
-                               printf("device not found in database\n");
+                               fprintf(stderr, "no record for '%s' in database\n", pos);
                                goto exit;
                        }
                        goto print;
                }
 
                if (name[0] != '\0') {
+                       char devpath[PATH_SIZE];
+                       int len;
+
                        /* remove udev_root if given */
-                       if (strncmp(name, udev_root, strlen(udev_root)) == 0) {
-                               pos = name + strlen(udev_root);
+                       len = strlen(udev_root);
+                       if (strncmp(name, udev_root, len) == 0) {
+                               pos = &name[len+1];
                        } else
                                pos = name;
-                       retval = udevdb_get_dev_byname(pos, path, &dev);
+
+                       retval = udev_db_search_name(devpath, sizeof(devpath), pos);
                        if (retval != 0) {
-                               printf("device not found in database\n");
+                               fprintf(stderr, "device not found in database\n");
                                goto exit;
                        }
+                       udev_db_get_device(&udev, devpath);
                        goto print;
                }
 
-               printf("query needs device path(-p) or node name(-n) specified\n");
+               fprintf(stderr, "query needs device path(-p) or node name(-n) specified\n");
+               retval = 3;
                goto exit;
 
 print:
                switch(query) {
-               case NAME:
+               case QUERY_NAME:
                        if (root)
-                               strfieldcpy(result, udev_root);
-                       strncat(result, dev.name, sizeof(result));
-                       break;
-
-               case SYMLINK:
-                       strfieldcpy(result, dev.symlink);
-                       break;
-
-               case MODE:
-                       sprintf(result, "%#o", dev.mode);
-                       break;
-
-               case GROUP:
-                       strfieldcpy(result, dev.group);
-                       break;
-
-               case OWNER:
-                       strfieldcpy(result, dev.owner);
-                       break;
-
-               case PATH:
-                       strfieldcpy(result, path);
-                       break;
-
-               default:
+                               printf("%s/%s\n", udev_root, udev.name);
+                       else
+                               printf("%s\n", udev.name);
+                       goto exit;
+               case QUERY_SYMLINK:
+                       if (list_empty(&udev.symlink_list))
+                               goto exit;
+                       if (root)
+                               list_for_each_entry(name_loop, &udev.symlink_list, node)
+                                       printf("%s/%s ", udev_root, name_loop->name);
+                       else
+                               list_for_each_entry(name_loop, &udev.symlink_list, node)
+                                       printf("%s ", name_loop->name);
+                       printf("\n");
+                       goto exit;
+               case QUERY_PATH:
+                       printf("%s\n", udev.devpath);
                        goto exit;
+               case QUERY_ENV:
+                       list_for_each_entry(name_loop, &udev.env_list, node)
+                               printf("%s\n", name_loop->name);
+                       goto exit;
+               case QUERY_ALL:
+                       print_record(&udev);
+                       goto exit;
+               default:
+                       goto help;
                }
-               printf("%s\n", result);
-
-exit:
-               udevdb_exit();
-               return retval;
        }
 
        if (attributes) {
                if (path[0] == '\0') {
-                       printf("attribute walk on device chain needs path(-p) specified\n");
-                       return -EINVAL;
+                       fprintf(stderr, "attribute walk on device chain needs path(-p) specified\n");
+                       retval = 4;
+                       goto exit;
                } else {
                        if (strncmp(path, sysfs_path, strlen(sysfs_path)) != 0) {
                                /* prepend sysfs mountpoint if not given */
-                               strfieldcpy(temp, path);
-                               strfieldcpy(path, sysfs_path);
-                               strncat(path, temp, sizeof(path));
+                               snprintf(temp, sizeof(temp), "%s%s", sysfs_path, path);
+                               temp[sizeof(temp)-1] = '\0';
+                               strlcpy(path, temp, sizeof(temp));
                        }
                        print_device_chain(path);
-                       return 0;
+                       goto exit;
                }
        }
 
        if (root) {
                printf("%s\n", udev_root);
-               return 0;
+               goto exit;
        }
 
 help:
-       printf("Usage: [-anpqrdVh]\n"
+       fprintf(stderr, "Usage: udevinfo [-anpqrVh]\n"
               "  -q TYPE  query database for the specified value:\n"
               "             'name'    name of device node\n"
               "             'symlink' pointing to node\n"
-              "             'mode'    permissions of node\n"
-              "             'owner'   of node\n"
-              "             'group'   of node\n"
               "             'path'    sysfs device path\n"
+              "             'env'     the device related imported environment\n"
+              "             'all'     all values\n"
+              "\n"
               "  -p PATH  sysfs device path used for query or chain\n"
-              "  -n NAME  node name used for query\n"
+              "  -n NAME  node/symlink name used for query\n"
               "\n"
               "  -r       print udev root\n"
-              "  -a       print all attributes along the chain of the device\n"
-              "  -d       dump whole database\n"
+              "  -a       print all SYSFS_attributes along the device chain\n"
+              "  -d       print the relationship of devpath and the node name for all\n"
+              "           devices available in the database\n"
               "  -V       print udev version\n"
               "  -h       print this help text\n"
               "\n");
-       return retval;
-}
-
-int main(int argc, char *argv[], char *envp[])
-{
-       int retval;
 
-       main_argv = argv;
-       main_argc = argc;
-       main_envp = envp;
-
-       /* initialize our configuration */
-       udev_init_config();
-
-       retval = process_options();
-       if (retval != 0)
-               exit(1);
-       exit(0);
+exit:
+       udev_cleanup_device(&udev);
+       logging_close();
+       return retval;
 }