Driver core: fix race in sysfs between sysfs_remove_file() and read()/write()
[linux-2.6.git] / fs / sysfs / file.c
index d72c1ce..cba4c1c 100644 (file)
@@ -3,9 +3,11 @@
  */
 
 #include <linux/module.h>
-#include <linux/dnotify.h>
+#include <linux/fsnotify.h>
 #include <linux/kobject.h>
 #include <linux/namei.h>
+#include <linux/poll.h>
+#include <linux/list.h>
 #include <asm/uaccess.h>
 #include <asm/semaphore.h>
 
@@ -49,16 +51,29 @@ static struct sysfs_ops subsys_sysfs_ops = {
        .store  = subsys_attr_store,
 };
 
+/**
+ *     add_to_collection - add buffer to a collection
+ *     @buffer:        buffer to be added
+ *     @node           inode of set to add to
+ */
 
-struct sysfs_buffer {
-       size_t                  count;
-       loff_t                  pos;
-       char                    * page;
-       struct sysfs_ops        * ops;
-       struct semaphore        sem;
-       int                     needs_read_fill;
-};
+static inline void
+add_to_collection(struct sysfs_buffer *buffer, struct inode *node)
+{
+       struct sysfs_buffer_collection *set = node->i_private;
 
+       mutex_lock(&node->i_mutex);
+       list_add(&buffer->associates, &set->associates);
+       mutex_unlock(&node->i_mutex);
+}
+
+static inline void
+remove_from_collection(struct sysfs_buffer *buffer, struct inode *node)
+{
+       mutex_lock(&node->i_mutex);
+       list_del(&buffer->associates);
+       mutex_unlock(&node->i_mutex);
+}
 
 /**
  *     fill_read_buffer - allocate and fill buffer from object.
@@ -72,6 +87,7 @@ struct sysfs_buffer {
  */
 static int fill_read_buffer(struct dentry * dentry, struct sysfs_buffer * buffer)
 {
+       struct sysfs_dirent * sd = dentry->d_fsdata;
        struct attribute * attr = to_attr(dentry);
        struct kobject * kobj = to_kobj(dentry->d_parent);
        struct sysfs_ops * ops = buffer->ops;
@@ -83,6 +99,7 @@ static int fill_read_buffer(struct dentry * dentry, struct sysfs_buffer * buffer
        if (!buffer->page)
                return -ENOMEM;
 
+       buffer->event = atomic_read(&sd->s_event);
        count = ops->show(kobj,attr,buffer->page);
        buffer->needs_read_fill = 0;
        BUG_ON(count > (ssize_t)PAGE_SIZE);
@@ -149,19 +166,22 @@ sysfs_read_file(struct file *file, char __user *buf, size_t count, loff_t *ppos)
        ssize_t retval = 0;
 
        down(&buffer->sem);
+       if (buffer->orphaned) {
+               retval = -ENODEV;
+               goto out;
+       }
        if (buffer->needs_read_fill) {
-               if ((retval = fill_read_buffer(file->f_dentry,buffer)))
+               if ((retval = fill_read_buffer(file->f_path.dentry,buffer)))
                        goto out;
        }
-       pr_debug("%s: count = %d, ppos = %lld, buf = %s\n",
-                __FUNCTION__,count,*ppos,buffer->page);
+       pr_debug("%s: count = %zd, ppos = %lld, buf = %s\n",
+                __FUNCTION__, count, *ppos, buffer->page);
        retval = flush_read_buffer(buffer,buf,count,ppos);
 out:
        up(&buffer->sem);
        return retval;
 }
 
-
 /**
  *     fill_write_buffer - copy buffer from userspace.
  *     @buffer:        data buffer for file.
@@ -183,9 +203,12 @@ fill_write_buffer(struct sysfs_buffer * buffer, const char __user * buf, size_t
                return -ENOMEM;
 
        if (count >= PAGE_SIZE)
-               count = PAGE_SIZE;
+               count = PAGE_SIZE - 1;
        error = copy_from_user(buffer->page,buf,count);
        buffer->needs_read_fill = 1;
+       /* if buf is assumed to contain a string, terminate it by \0,
+          so e.g. sscanf() can scan the string easily */
+       buffer->page[count] = 0;
        return error ? -EFAULT : count;
 }
 
@@ -236,19 +259,25 @@ sysfs_write_file(struct file *file, const char __user *buf, size_t count, loff_t
        ssize_t len;
 
        down(&buffer->sem);
+       if (buffer->orphaned) {
+               len = -ENODEV;
+               goto out;
+       }
        len = fill_write_buffer(buffer, buf, count);
        if (len > 0)
-               len = flush_write_buffer(file->f_dentry, buffer, len);
+               len = flush_write_buffer(file->f_path.dentry, buffer, len);
        if (len > 0)
                *ppos += len;
+out:
        up(&buffer->sem);
        return len;
 }
 
-static int check_perm(struct inode * inode, struct file * file)
+static int sysfs_open_file(struct inode *inode, struct file *file)
 {
-       struct kobject *kobj = sysfs_get_kobject(file->f_dentry->d_parent);
-       struct attribute * attr = to_attr(file->f_dentry);
+       struct kobject *kobj = sysfs_get_kobject(file->f_path.dentry->d_parent);
+       struct attribute * attr = to_attr(file->f_path.dentry);
+       struct sysfs_buffer_collection *set;
        struct sysfs_buffer * buffer;
        struct sysfs_ops * ops = NULL;
        int error = 0;
@@ -278,6 +307,18 @@ static int check_perm(struct inode * inode, struct file * file)
        if (!ops)
                goto Eaccess;
 
+       /* make sure we have a collection to add our buffers to */
+       mutex_lock(&inode->i_mutex);
+       if (!(set = inode->i_private)) {
+               if (!(set = inode->i_private = kmalloc(sizeof(struct sysfs_buffer_collection), GFP_KERNEL))) {
+                       error = -ENOMEM;
+                       goto Done;
+               } else {
+                       INIT_LIST_HEAD(&set->associates);
+               }
+       }
+       mutex_unlock(&inode->i_mutex);
+
        /* File needs write support.
         * The inode's perms must say it's ok, 
         * and we must have a store method.
@@ -301,12 +342,13 @@ static int check_perm(struct inode * inode, struct file * file)
        /* No error? Great, allocate a buffer for the file, and store it
         * it in file->private_data for easy access.
         */
-       buffer = kmalloc(sizeof(struct sysfs_buffer),GFP_KERNEL);
+       buffer = kzalloc(sizeof(struct sysfs_buffer), GFP_KERNEL);
        if (buffer) {
-               memset(buffer,0,sizeof(struct sysfs_buffer));
+               INIT_LIST_HEAD(&buffer->associates);
                init_MUTEX(&buffer->sem);
                buffer->needs_read_fill = 1;
                buffer->ops = ops;
+               add_to_collection(buffer, inode);
                file->private_data = buffer;
        } else
                error = -ENOMEM;
@@ -324,18 +366,15 @@ static int check_perm(struct inode * inode, struct file * file)
        return error;
 }
 
-static int sysfs_open_file(struct inode * inode, struct file * filp)
-{
-       return check_perm(inode,filp);
-}
-
 static int sysfs_release(struct inode * inode, struct file * filp)
 {
-       struct kobject * kobj = to_kobj(filp->f_dentry->d_parent);
-       struct attribute * attr = to_attr(filp->f_dentry);
+       struct kobject * kobj = to_kobj(filp->f_path.dentry->d_parent);
+       struct attribute * attr = to_attr(filp->f_path.dentry);
        struct module * owner = attr->owner;
        struct sysfs_buffer * buffer = filp->private_data;
 
+       if (buffer)
+               remove_from_collection(buffer, inode);
        if (kobj) 
                kobject_put(kobj);
        /* After this point, attr should not be accessed. */
@@ -349,12 +388,84 @@ static int sysfs_release(struct inode * inode, struct file * filp)
        return 0;
 }
 
-struct file_operations sysfs_file_operations = {
+/* Sysfs attribute files are pollable.  The idea is that you read
+ * the content and then you use 'poll' or 'select' to wait for
+ * the content to change.  When the content changes (assuming the
+ * manager for the kobject supports notification), poll will
+ * return POLLERR|POLLPRI, and select will return the fd whether
+ * it is waiting for read, write, or exceptions.
+ * Once poll/select indicates that the value has changed, you
+ * need to close and re-open the file, as simply seeking and reading
+ * again will not get new data, or reset the state of 'poll'.
+ * Reminder: this only works for attributes which actively support
+ * it, and it is not possible to test an attribute from userspace
+ * to see if it supports poll (Nether 'poll' or 'select' return
+ * an appropriate error code).  When in doubt, set a suitable timeout value.
+ */
+static unsigned int sysfs_poll(struct file *filp, poll_table *wait)
+{
+       struct sysfs_buffer * buffer = filp->private_data;
+       struct kobject * kobj = to_kobj(filp->f_path.dentry->d_parent);
+       struct sysfs_dirent * sd = filp->f_path.dentry->d_fsdata;
+       int res = 0;
+
+       poll_wait(filp, &kobj->poll, wait);
+
+       if (buffer->event != atomic_read(&sd->s_event)) {
+               res = POLLERR|POLLPRI;
+               buffer->needs_read_fill = 1;
+       }
+
+       return res;
+}
+
+
+static struct dentry *step_down(struct dentry *dir, const char * name)
+{
+       struct dentry * de;
+
+       if (dir == NULL || dir->d_inode == NULL)
+               return NULL;
+
+       mutex_lock(&dir->d_inode->i_mutex);
+       de = lookup_one_len(name, dir, strlen(name));
+       mutex_unlock(&dir->d_inode->i_mutex);
+       dput(dir);
+       if (IS_ERR(de))
+               return NULL;
+       if (de->d_inode == NULL) {
+               dput(de);
+               return NULL;
+       }
+       return de;
+}
+
+void sysfs_notify(struct kobject * k, char *dir, char *attr)
+{
+       struct dentry *de = k->dentry;
+       if (de)
+               dget(de);
+       if (de && dir)
+               de = step_down(de, dir);
+       if (de && attr)
+               de = step_down(de, attr);
+       if (de) {
+               struct sysfs_dirent * sd = de->d_fsdata;
+               if (sd)
+                       atomic_inc(&sd->s_event);
+               wake_up_interruptible(&k->poll);
+               dput(de);
+       }
+}
+EXPORT_SYMBOL_GPL(sysfs_notify);
+
+const struct file_operations sysfs_file_operations = {
        .read           = sysfs_read_file,
        .write          = sysfs_write_file,
        .llseek         = generic_file_llseek,
        .open           = sysfs_open_file,
        .release        = sysfs_release,
+       .poll           = sysfs_poll,
 };
 
 
@@ -362,11 +473,13 @@ int sysfs_add_file(struct dentry * dir, const struct attribute * attr, int type)
 {
        struct sysfs_dirent * parent_sd = dir->d_fsdata;
        umode_t mode = (attr->mode & S_IALLUGO) | S_IFREG;
-       int error = 0;
+       int error = -EEXIST;
 
-       down(&dir->d_inode->i_sem);
-       error = sysfs_make_dirent(parent_sd, NULL, (void *) attr, mode, type);
-       up(&dir->d_inode->i_sem);
+       mutex_lock(&dir->d_inode->i_mutex);
+       if (!sysfs_dirent_exist(parent_sd, attr->name))
+               error = sysfs_make_dirent(parent_sd, NULL, (void *)attr,
+                                         mode, type);
+       mutex_unlock(&dir->d_inode->i_mutex);
 
        return error;
 }
@@ -391,9 +504,6 @@ int sysfs_create_file(struct kobject * kobj, const struct attribute * attr)
  * sysfs_update_file - update the modified timestamp on an object attribute.
  * @kobj: object we're acting for.
  * @attr: attribute descriptor.
- *
- * Also call dnotify for the dentry, which lots of userspace programs
- * use.
  */
 int sysfs_update_file(struct kobject * kobj, const struct attribute * attr)
 {
@@ -401,29 +511,24 @@ int sysfs_update_file(struct kobject * kobj, const struct attribute * attr)
        struct dentry * victim;
        int res = -ENOENT;
 
-       down(&dir->d_inode->i_sem);
+       mutex_lock(&dir->d_inode->i_mutex);
        victim = lookup_one_len(attr->name, dir, strlen(attr->name));
        if (!IS_ERR(victim)) {
                /* make sure dentry is really there */
                if (victim->d_inode && 
                    (victim->d_parent->d_inode == dir->d_inode)) {
                        victim->d_inode->i_mtime = CURRENT_TIME;
-                       dnotify_parent(victim, DN_MODIFY);
-
-                       /**
-                        * Drop reference from initial sysfs_get_dentry().
-                        */
-                       dput(victim);
+                       fsnotify_modify(victim);
                        res = 0;
                } else
                        d_drop(victim);
                
                /**
-                * Drop the reference acquired from sysfs_get_dentry() above.
+                * Drop the reference acquired from lookup_one_len() above.
                 */
                dput(victim);
        }
-       up(&dir->d_inode->i_sem);
+       mutex_unlock(&dir->d_inode->i_mutex);
 
        return res;
 }
@@ -440,24 +545,26 @@ int sysfs_chmod_file(struct kobject *kobj, struct attribute *attr, mode_t mode)
 {
        struct dentry *dir = kobj->dentry;
        struct dentry *victim;
-       struct sysfs_dirent *sd;
-       umode_t umode = (mode & S_IALLUGO) | S_IFREG;
+       struct inode * inode;
+       struct iattr newattrs;
        int res = -ENOENT;
 
-       down(&dir->d_inode->i_sem);
+       mutex_lock(&dir->d_inode->i_mutex);
        victim = lookup_one_len(attr->name, dir, strlen(attr->name));
        if (!IS_ERR(victim)) {
                if (victim->d_inode &&
                    (victim->d_parent->d_inode == dir->d_inode)) {
-                       sd = victim->d_fsdata;
-                       attr->mode = mode;
-                       sd->s_mode = umode;
-                       victim->d_inode->i_mode = umode;
-                       dput(victim);
-                       res = 0;
+                       inode = victim->d_inode;
+                       mutex_lock(&inode->i_mutex);
+                       newattrs.ia_mode = (mode & S_IALLUGO) |
+                                               (inode->i_mode & ~S_IALLUGO);
+                       newattrs.ia_valid = ATTR_MODE | ATTR_CTIME;
+                       res = notify_change(victim, &newattrs);
+                       mutex_unlock(&inode->i_mutex);
                }
+               dput(victim);
        }
-       up(&dir->d_inode->i_sem);
+       mutex_unlock(&dir->d_inode->i_mutex);
 
        return res;
 }
@@ -474,11 +581,10 @@ EXPORT_SYMBOL_GPL(sysfs_chmod_file);
 
 void sysfs_remove_file(struct kobject * kobj, const struct attribute * attr)
 {
-       sysfs_hash_and_remove(kobj->dentry,attr->name);
+       sysfs_hash_and_remove(kobj->dentry, attr->name);
 }
 
 
 EXPORT_SYMBOL_GPL(sysfs_create_file);
 EXPORT_SYMBOL_GPL(sysfs_remove_file);
 EXPORT_SYMBOL_GPL(sysfs_update_file);
-