chiark / gitweb /
udevd: implement a more efficient queue file format
[elogind.git] / udev / lib / libudev-queue.c
index 3ca533b1e0ece48a2b210512f74eab6baa9a1dfa..cf1ddf3a07397bc4926bc74565b7078ff9bb1ed3 100644 (file)
@@ -2,19 +2,12 @@
  * libudev - interface to udev device information
  *
  * Copyright (C) 2008 Kay Sievers <kay.sievers@vrfy.org>
+ * Copyright (C) 2009 Alan Jenkins <alan-jenkins@tuffmail.co.uk>
  *
- * 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, either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  */
 
 #include <stdio.h>
@@ -25,6 +18,7 @@
 #include <string.h>
 #include <dirent.h>
 #include <fcntl.h>
+#include <limits.h>
 #include <sys/stat.h>
 
 #include "libudev.h"
@@ -33,9 +27,8 @@
 struct udev_queue {
        struct udev *udev;
        int refcount;
-       unsigned long long int last_seen_udev_seqnum;
-       struct list_node queue_list;
-       struct list_node failed_list;
+       struct udev_list_node queue_list;
+       struct udev_list_node failed_list;
 };
 
 struct udev_queue *udev_queue_new(struct udev *udev)
@@ -45,14 +38,13 @@ struct udev_queue *udev_queue_new(struct udev *udev)
        if (udev == NULL)
                return NULL;
 
-       udev_queue = malloc(sizeof(struct udev_queue));
+       udev_queue = calloc(1, sizeof(struct udev_queue));
        if (udev_queue == NULL)
                return NULL;
-       memset(udev_queue, 0x00, sizeof(struct udev_queue));
        udev_queue->refcount = 1;
        udev_queue->udev = udev;
-       list_init(&udev_queue->queue_list);
-       list_init(&udev_queue->failed_list);
+       udev_list_init(&udev_queue->queue_list);
+       udev_list_init(&udev_queue->failed_list);
        return udev_queue;
 }
 
@@ -71,8 +63,8 @@ void udev_queue_unref(struct udev_queue *udev_queue)
        udev_queue->refcount--;
        if (udev_queue->refcount > 0)
                return;
-       list_cleanup(udev_queue->udev, &udev_queue->queue_list);
-       list_cleanup(udev_queue->udev, &udev_queue->failed_list);
+       udev_list_cleanup_entries(udev_queue->udev, &udev_queue->queue_list);
+       udev_list_cleanup_entries(udev_queue->udev, &udev_queue->failed_list);
        free(udev_queue);
 }
 
@@ -83,7 +75,7 @@ struct udev *udev_queue_get_udev(struct udev_queue *udev_queue)
        return udev_queue->udev;
 }
 
-unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queue)
+unsigned long long int udev_get_kernel_seqnum(struct udev *udev)
 {
        char filename[UTIL_PATH_SIZE];
        unsigned long long int seqnum;
@@ -91,10 +83,7 @@ unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queu
        char buf[32];
        ssize_t len;
 
-       if (udev_queue == NULL)
-               return -EINVAL;
-       util_strlcpy(filename, udev_get_sys_path(udev_queue->udev), sizeof(filename));
-       util_strlcat(filename, "/kernel/uevent_seqnum", sizeof(filename));
+       util_strscpyl(filename, sizeof(filename), udev_get_sys_path(udev), "/kernel/uevent_seqnum", NULL);
        fd = open(filename, O_RDONLY);
        if (fd < 0)
                return 0;
@@ -104,122 +93,272 @@ unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queu
                return 0;
        buf[len-1] = '\0';
        seqnum = strtoull(buf, NULL, 10);
-       info(udev_queue->udev, "seqnum=%llu\n", seqnum);
        return seqnum;
 }
 
-unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue)
+unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queue)
 {
-       char filename[UTIL_PATH_SIZE];
        unsigned long long int seqnum;
-       int fd;
-       char buf[32];
-       ssize_t len;
 
        if (udev_queue == NULL)
                return -EINVAL;
-       util_strlcpy(filename, udev_get_dev_path(udev_queue->udev), sizeof(filename));
-       util_strlcat(filename, "/.udev/uevent_seqnum", sizeof(filename));
-       fd = open(filename, O_RDONLY);
-       if (fd < 0)
+
+       seqnum = udev_get_kernel_seqnum(udev_queue->udev);
+       dbg(udev_queue->udev, "seqnum=%llu\n", seqnum);
+       return seqnum;
+}
+
+int udev_queue_read_seqnum(FILE *queue_file, unsigned long long int *seqnum)
+{
+       if (fread(seqnum, sizeof(unsigned long long int), 1, queue_file) != 1)
+               return -1;
+
+       return 0;
+}
+
+ssize_t udev_queue_skip_devpath(FILE *queue_file)
+{
+       unsigned short int len;
+
+       if (fread(&len, sizeof(unsigned short int), 1, queue_file) == 1) {
+               char devpath[len];
+
+               /* use fread to skip, fseek might drop buffered data */
+               if (fread(devpath, 1, len, queue_file) == len)
+                       return len;
+       }
+
+       return -1;
+}
+
+ssize_t udev_queue_read_devpath(FILE *queue_file, char *devpath, size_t size)
+{
+       unsigned short int read_bytes = 0;
+       unsigned short int len;
+
+       if (fread(&len, sizeof(unsigned short int), 1, queue_file) != 1)
+               return -1;
+
+       read_bytes = (len < size - 1) ? len : size - 1;
+       if (fread(devpath, 1, read_bytes, queue_file) != read_bytes)
+               return -1;
+       devpath[read_bytes] = '\0';
+
+       /* if devpath was too long, skip unread characters */
+       if (read_bytes != len) {
+               unsigned short int skip_bytes = len - read_bytes;
+               char buf[skip_bytes];
+
+               if (fread(buf, 1, skip_bytes, queue_file) != skip_bytes)
+                       return -1;
+       }
+
+       return read_bytes;
+}
+
+static FILE *open_queue_file(struct udev_queue *udev_queue, unsigned long long int *seqnum_start)
+{
+       char filename[UTIL_PATH_SIZE];
+       FILE *queue_file;
+
+       util_strscpyl(filename, sizeof(filename), udev_get_dev_path(udev_queue->udev), "/.udev/queue.bin", NULL);
+       queue_file = fopen(filename, "r");
+       if (queue_file == NULL)
+               return NULL;
+
+       if (udev_queue_read_seqnum(queue_file, seqnum_start) < 0) {
+               err(udev_queue->udev, "corrupt queue file\n");
+               fclose(queue_file);
+               return NULL;
+       }
+
+       return queue_file;
+}
+
+
+unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue)
+{
+       unsigned long long int seqnum_udev;
+       FILE *queue_file;
+
+       queue_file = open_queue_file(udev_queue, &seqnum_udev);
+       if (queue_file == NULL)
                return 0;
-       len = read(fd, buf, sizeof(buf));
-       close(fd);
-       if (len <= 2)
+
+       while (1) {
+               unsigned long long int seqnum;
+               ssize_t devpath_len;
+
+               if (udev_queue_read_seqnum(queue_file, &seqnum) < 0)
+                       break;
+               devpath_len = udev_queue_skip_devpath(queue_file);
+               if (devpath_len < 0)
+                       break;
+               if (devpath_len > 0)
+                       seqnum_udev = seqnum;
+       }
+
+       fclose(queue_file);
+       return seqnum_udev;
+}
+
+int udev_queue_get_udev_is_active(struct udev_queue *udev_queue)
+{
+       unsigned long long int seqnum_start;
+       FILE *queue_file;
+
+       queue_file = open_queue_file(udev_queue, &seqnum_start);
+       if (queue_file == NULL)
                return 0;
-       buf[len-1] = '\0';
-       seqnum = strtoull(buf, NULL, 10);
-       info(udev_queue->udev, "seqnum=%llu\n", seqnum);
-       udev_queue->last_seen_udev_seqnum = seqnum;
-       return seqnum;
+
+       fclose(queue_file);
+       return 1;
 }
 
 int udev_queue_get_queue_is_empty(struct udev_queue *udev_queue)
 {
-       char queuename[UTIL_PATH_SIZE];
-       struct stat statbuf;
        unsigned long long int seqnum_kernel;
+       unsigned long long int seqnum_udev = 0;
+       int queued = 0;
+       int is_empty = 0;
+       FILE *queue_file;
 
        if (udev_queue == NULL)
                return -EINVAL;
-       util_strlcpy(queuename, udev_get_dev_path(udev_queue->udev), sizeof(queuename));
-       util_strlcat(queuename, "/.udev/queue", sizeof(queuename));
-       if (stat(queuename, &statbuf) == 0) {
-               info(udev_queue->udev, "queue is not empty\n");
-               return 0;
-       }
-       seqnum_kernel = udev_queue_get_kernel_seqnum(udev_queue);
-       if (seqnum_kernel <= udev_queue->last_seen_udev_seqnum) {
-               info(udev_queue->udev, "queue is empty\n");
+       queue_file = open_queue_file(udev_queue, &seqnum_udev);
+       if (queue_file == NULL)
                return 1;
+
+       while (1) {
+               unsigned long long int seqnum;
+               ssize_t devpath_len;
+
+               if (udev_queue_read_seqnum(queue_file, &seqnum) < 0)
+                       break;
+               devpath_len = udev_queue_skip_devpath(queue_file);
+               if (devpath_len < 0)
+                       break;
+
+               if (devpath_len > 0) {
+                       queued++;
+                       seqnum_udev = seqnum;
+               } else {
+                       queued--;
+               }
        }
-       udev_queue_get_udev_seqnum(udev_queue);
-       if (seqnum_kernel <= udev_queue->last_seen_udev_seqnum) {
-               info(udev_queue->udev, "queue is empty\n");
-               return 1;
+
+       if (queued > 0) {
+               dbg(udev_queue->udev, "queue is not empty\n");
+               goto out;
        }
-       info(udev_queue->udev, "queue is empty, but kernel events still pending [%llu]<->[%llu]\n",
-            seqnum_kernel, udev_queue->last_seen_udev_seqnum);
-       return 0;
+
+       seqnum_kernel = udev_queue_get_kernel_seqnum(udev_queue);
+       if (seqnum_udev < seqnum_kernel) {
+               dbg(udev_queue->udev, "queue is empty but kernel events still pending [%llu]<->[%llu]\n",
+                                       seqnum_kernel, seqnum_udev);
+               goto out;
+       }
+
+       dbg(udev_queue->udev, "queue is empty\n");
+       is_empty = 1;
+
+out:
+       fclose(queue_file);
+       return is_empty;
 }
 
-int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned long long int seqnum)
+int udev_queue_get_seqnum_sequence_is_finished(struct udev_queue *udev_queue,
+                                              unsigned long long int start, unsigned long long int end)
 {
-       char filename[UTIL_PATH_SIZE];
-       struct stat statbuf;
+       unsigned long long int seqnum = 0;
+       ssize_t devpath_len;
+       int unfinished;
+       FILE *queue_file;
 
        if (udev_queue == NULL)
                return -EINVAL;
-       /* if we have not seen this seqnum, check if it is/was already queued */
-       if (seqnum < udev_queue->last_seen_udev_seqnum) {
-               udev_queue_get_udev_seqnum(udev_queue);
-               if (seqnum < udev_queue->last_seen_udev_seqnum)
-                       return 0;
+       queue_file = open_queue_file(udev_queue, &seqnum);
+       if (queue_file == NULL)
+               return 1;
+       if (start < seqnum)
+               start = seqnum;
+       if (start > end)
+               return 1;
+       if (end - start > INT_MAX - 1)
+               return -EOVERFLOW;
+       unfinished = (end - start) + 1;
+
+       while (unfinished > 0) {
+               if (udev_queue_read_seqnum(queue_file, &seqnum) < 0)
+                       break;
+               devpath_len = udev_queue_skip_devpath(queue_file);
+               if (devpath_len < 0)
+                       break;
+
+               if (devpath_len == 0) {
+                       if (seqnum >= start && seqnum <= end)
+                               unfinished--;
+               }
        }
-       snprintf(filename, sizeof(filename), "%s/.udev/queue/%llu",
-                udev_get_dev_path(udev_queue->udev), seqnum);
-       if (stat(filename, &statbuf) == 0)
+       fclose(queue_file);
+
+       return (unfinished == 0);
+}
+
+int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned long long int seqnum)
+{
+       if (!udev_queue_get_seqnum_sequence_is_finished(udev_queue, seqnum, seqnum))
                return 0;
-       info(udev_queue->udev, "seqnum: %llu finished\n", seqnum);
+
+       dbg(udev_queue->udev, "seqnum: %llu finished\n", seqnum);
        return 1;
 }
 
 struct udev_list_entry *udev_queue_get_queued_list_entry(struct udev_queue *udev_queue)
 {
-       char path[UTIL_PATH_SIZE];
-       DIR *dir;
-       struct dirent *dent;
+       unsigned long long int seqnum;
+       FILE *queue_file;
 
        if (udev_queue == NULL)
                return NULL;
-       list_cleanup(udev_queue->udev, &udev_queue->queue_list);
-       util_strlcpy(path, udev_get_dev_path(udev_queue->udev), sizeof(path));
-       util_strlcat(path, "/.udev/queue", sizeof(path));
-       dir = opendir(path);
-       if (dir == NULL)
+       udev_list_cleanup_entries(udev_queue->udev, &udev_queue->queue_list);
+
+       queue_file = open_queue_file(udev_queue, &seqnum);
+       if (queue_file == NULL)
                return NULL;
-       for (dent = readdir(dir); dent != NULL; dent = readdir(dir)) {
-               char filename[UTIL_PATH_SIZE];
+
+       while (1) {
                char syspath[UTIL_PATH_SIZE];
-               size_t syslen;
+               char *s;
+               size_t l;
                ssize_t len;
+               char seqnum_str[32];
+               struct udev_list_entry *list_entry;
 
-               if (dent->d_name[0] == '.')
-                       continue;
-               util_strlcpy(filename, path, sizeof(filename));
-               util_strlcat(filename, "/", sizeof(filename));
-               util_strlcat(filename, dent->d_name, sizeof(filename));
+               if (udev_queue_read_seqnum(queue_file, &seqnum) < 0)
+                       break;
+               snprintf(seqnum_str, sizeof(seqnum_str), "%llu", seqnum);
 
-               syslen = util_strlcpy(syspath, udev_get_sys_path(udev_queue->udev), sizeof(syspath));
-               len = readlink(filename, &syspath[syslen], sizeof(syspath)-syslen);
-               if (len < 0 || len >= (ssize_t)(sizeof(syspath)-syslen))
-                       continue;
-               syspath[syslen + len] = '\0';
-               info(udev_queue->udev, "found '%s' [%s]\n", syspath, dent->d_name);
-               list_entry_add(udev_queue->udev, &udev_queue->queue_list, syspath, dent->d_name, 0, 0);
+               s = syspath;
+               l = util_strpcpyl(&s, sizeof(syspath), udev_get_sys_path(udev_queue->udev), NULL);
+               len = udev_queue_read_devpath(queue_file, s, l);
+               if (len < 0)
+                       break;
+
+               if (len > 0) {
+                       udev_list_entry_add(udev_queue->udev, &udev_queue->queue_list, syspath, seqnum_str, 0, 0);
+               } else {
+                       udev_list_entry_foreach(list_entry, udev_list_get_entry(&udev_queue->queue_list)) {
+                               if (strcmp(seqnum_str, udev_list_entry_get_value(list_entry)) == 0) {
+                                       udev_list_entry_delete(list_entry);
+                                       break;
+                               }
+                       }
+               }
        }
-       closedir(dir);
-       return list_get_entry(&udev_queue->queue_list);
+       fclose(queue_file);
+
+       return udev_list_get_entry(&udev_queue->queue_list);
 }
 
 struct udev_list_entry *udev_queue_get_failed_list_entry(struct udev_queue *udev_queue)
@@ -230,57 +369,33 @@ struct udev_list_entry *udev_queue_get_failed_list_entry(struct udev_queue *udev
 
        if (udev_queue == NULL)
                return NULL;
-       list_cleanup(udev_queue->udev, &udev_queue->failed_list);
-       util_strlcpy(path, udev_get_dev_path(udev_queue->udev), sizeof(path));
-       util_strlcat(path, "/.udev/failed", sizeof(path));
+       udev_list_cleanup_entries(udev_queue->udev, &udev_queue->failed_list);
+       util_strscpyl(path, sizeof(path), udev_get_dev_path(udev_queue->udev), "/.udev/failed", NULL);
        dir = opendir(path);
        if (dir == NULL)
                return NULL;
        for (dent = readdir(dir); dent != NULL; dent = readdir(dir)) {
                char filename[UTIL_PATH_SIZE];
                char syspath[UTIL_PATH_SIZE];
-               struct stat statbuf;
-               size_t syslen;
+               char *s;
+               size_t l;
                ssize_t len;
+               struct stat statbuf;
 
                if (dent->d_name[0] == '.')
                        continue;
-               util_strlcpy(filename, path, sizeof(filename));
-               util_strlcat(filename, "/", sizeof(filename));
-               util_strlcat(filename, dent->d_name, sizeof(filename));
-
-               syslen = util_strlcpy(syspath, udev_get_sys_path(udev_queue->udev), sizeof(syspath));
-               len = readlink(filename, &syspath[syslen], sizeof(syspath)-syslen);
-               if (len < 0 || len >= (ssize_t)(sizeof(syspath)-syslen))
+               s = syspath;
+               l = util_strpcpyl(&s, sizeof(syspath), udev_get_sys_path(udev_queue->udev), NULL);
+               len = readlinkat(dirfd(dir), dent->d_name, s, l);
+               if (len < 0 || (size_t)len >= l)
                        continue;
-               syspath[syslen + len] = '\0';
-               info(udev_queue->udev, "found '%s' [%s]\n", syspath, dent->d_name);
-               util_strlcpy(filename, syspath, sizeof(filename));
-               util_strlcat(filename, "/uevent", sizeof(filename));
+               s[len] = '\0';
+               dbg(udev_queue->udev, "found '%s' [%s]\n", syspath, dent->d_name);
+               util_strscpyl(filename, sizeof(filename), syspath, "/uevent", NULL);
                if (stat(filename, &statbuf) != 0)
                        continue;
-               list_entry_add(udev_queue->udev, &udev_queue->failed_list, syspath, NULL, 0, 0);
+               udev_list_entry_add(udev_queue->udev, &udev_queue->failed_list, syspath, NULL, 0, 0);
        }
        closedir(dir);
-       return list_get_entry(&udev_queue->failed_list);
-}
-
-int queue_export_udev_seqnum(struct udev_queue *udev_queue, unsigned long long int seqnum)
-{
-       return 0;
-}
-
-extern int queue_export_device_queued(struct udev_queue *udev_queue, struct udev_device *udev_device)
-{
-       return 0;
-}
-
-extern int queue_export_device_finished(struct udev_queue *udev_queue, struct udev_device *udev_device)
-{
-       return 0;
-}
-
-extern int queue_export_device_failed(struct udev_queue *udev_queue, struct udev_device *udev_device)
-{
-       return 0;
+       return udev_list_get_entry(&udev_queue->failed_list);
 }