glue/inotify-glue.c

   1 /*
   2  * inotify-glue.c
   3  *
   4  * Copyright (C) 2004 Novell, Inc.
   5  *
   6  */
   7
   8 /*
   9  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  24  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  25  * DEALINGS IN THE SOFTWARE.
  26  */
  27
  28 #include <stdio.h>
  29 #include <stdlib.h>
  30 #include <string.h>
  31 #include <fcntl.h>
  32 #include <unistd.h>
  33 #include <errno.h>
  34 #include <sys/ioctl.h>
  35 #include <sys/select.h>
  36
  37 #include "inotify.h"
  38
  39 #define SYSFS_PREFIX           "/sys/class/misc/inotify"
  40
  41 #define SYSFS_MAX_USER_DEVICES  SYSFS_PREFIX "/max_user_devices"
  42 #define SYSFS_MAX_USER_WATCHES  SYSFS_PREFIX "/max_user_watches"
  43 #define SYSFS_MAX_QUEUED_EVENTS SYSFS_PREFIX "/max_queued_events"
  44
  45 /* Inotify sysfs knobs, initialized to their pre-sysfs defaults */
  46 static int max_user_devices = 8;
  47 static int max_user_watches = 8192;
  48 static unsigned int max_queued_events = 256;
  49
  50 /* Paranoid code to read an integer from a sysfs (well, any) file. */
  51 static void
  52 read_int (const char *filename, int *var)
  53 {
  54         int fd, n;
  55         char buffer[32];
  56         char *buffer_endptr = NULL;
  57
  58         fd = open (filename, O_RDONLY);
  59         if (fd == -1)
  60                 return;
  61         if (read (fd, buffer, 31) > 0) {
  62                 n = (int) strtol (buffer, &buffer_endptr, 10);
  63                 if (*buffer != '\0' && *buffer_endptr == '\0')
  64                         *var = n;
  65         }
  66         close (fd);
  67 }
  68
  69
  70 void
  71 inotify_glue_init (void)
  72 {
  73         static int initialized = 0;
  74         if (initialized)
  75                 return;
  76         initialized = 1;
  77
  78         read_int (SYSFS_MAX_USER_DEVICES, &max_user_devices);
  79         read_int (SYSFS_MAX_USER_WATCHES, &max_user_watches);
  80         read_int (SYSFS_MAX_QUEUED_EVENTS, &max_queued_events);
  81 }
  82
  83
  84 int
  85 inotify_glue_watch (int fd, const char *filename, __u32 mask)
  86 {
  87         struct inotify_watch_request iwr;
  88         int file_fd, wd;
  89
  90         file_fd = open (filename, O_RDONLY);
  91         if (file_fd < 0) {
  92                 perror ("open");
  93                 return -1;
  94         }
  95         iwr.fd = file_fd;
  96         iwr.mask = mask;
  97
  98         wd = ioctl (fd, INOTIFY_WATCH, &iwr);
  99         if (wd < 0) {
 100                 int _errno = errno;
 101                 perror ("ioctl");
 102                 switch (_errno) {
 103                 case ENOSPC:
 104                         fprintf(stderr, "Maximum watch limit hit. Try adjusting /sys/class/misc/inotify/max_user_watches\n");
 105                         break;
 106                 case EFAULT:
 107                         fprintf(stderr, "This usually indicates an inotify version incompatibility.\n");
 108                         break;
 109                 default:
 110                         break;
 111                 }
 112         }
 113
 114         if (close (file_fd))
 115                 perror ("close");
 116
 117         return wd;
 118 }
 119
 120
 121 int
 122 inotify_glue_ignore (int fd, __s32 wd)
 123 {
 124         int ret;
 125
 126         ret = ioctl (fd, INOTIFY_IGNORE, &wd);
 127         if (ret < 0)
 128                 perror ("ioctl");
 129
 130         return ret;
 131 }
 132
 133
 134 #define MAX_PENDING_COUNT           5
 135 #define PENDING_PAUSE_MICROSECONDS  2000
 136 #define PENDING_THRESHOLD(qsize)    ((qsize) >> 1)
 137 #define PENDING_MARGINAL_COST(p)    ((unsigned int)(1 << (p)))
 138
 139 void
 140 inotify_snarf_events (int fd, int timeout_secs, int *nr, void **buffer_out)
 141 {
 142         struct timeval timeout;
 143         fd_set read_fds;
 144         int select_retval;
 145         unsigned int prev_pending = 0, pending_count = 0;
 146         static struct inotify_event *buffer = NULL;
 147         static size_t buffer_size;
 148
 149         /* Allocate our buffer the first time we try to read events. */
 150         if (buffer == NULL) {
 151                 /* guess the avg len */
 152                 buffer_size = sizeof (struct inotify_event) + 16;
 153                 buffer_size *= max_queued_events;
 154                 buffer = malloc (buffer_size);
 155                 if (!buffer) {
 156                         perror ("malloc");
 157                         *buffer_out = NULL;
 158                         return;
 159                 }
 160         }
 161
 162         /* Set nr to 0, so it will be sure to contain something
 163            valid if the select times out. */
 164         *nr = 0;
 165
 166         /* Wait for the file descriptor to be ready to read. */
 167
 168         timeout.tv_sec = timeout_secs;
 169         timeout.tv_usec = 0;
 170
 171         FD_ZERO (&read_fds);
 172         FD_SET (fd, &read_fds);
 173
 174         select_retval = select (fd + 1, &read_fds, NULL, NULL, &timeout);
 175
 176         /* If we time out or get an error, just return */
 177         if (select_retval <= 0)
 178                 return;
 179
 180         /* Reading events in groups significantly helps performance.
 181          * If there are some events (but not too many!) ready, wait a
 182          * bit more to see if more events come in. */
 183
 184         while (pending_count < MAX_PENDING_COUNT) {
 185                 unsigned int pending;
 186
 187                 if (ioctl (fd, FIONREAD, &pending) == -1)
 188                         break;
 189                 pending /= sizeof (struct inotify_event) + 16;  /* guess len */
 190
 191                 /* Don't wait if the number of pending events is too close
 192                  * to the maximum queue size. */
 193                 if (pending > PENDING_THRESHOLD (max_queued_events))
 194                         break;
 195
 196                 /* With each successive iteration, the minimum rate for
 197                  * further sleep doubles. */
 198                 if (pending-prev_pending < PENDING_MARGINAL_COST(pending_count))
 199                         break;
 200
 201                 prev_pending = pending;
 202                 ++pending_count;
 203
 204                 timeout.tv_sec = 0;
 205                 timeout.tv_usec = PENDING_PAUSE_MICROSECONDS;
 206                 select (0, NULL, NULL, NULL, &timeout);
 207         }
 208
 209         *nr = read (fd, buffer, buffer_size);
 210
 211         *buffer_out = buffer;
 212 }