fs/sysfs/symlink.c

   1 /*
   2  * fs/sysfs/symlink.c - sysfs symlink implementation
   3  *
   4  * Copyright (c) 2001-3 Patrick Mochel
   5  * Copyright (c) 2007 SUSE Linux Products GmbH
   6  * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
   7  *
   8  * This file is released under the GPLv2.
   9  *
  10  * Please see Documentation/filesystems/sysfs.txt for more information.
  11  */
  12
  13 #include <linux/fs.h>
  14 #include <linux/mount.h>
  15 #include <linux/module.h>
  16 #include <linux/kobject.h>
  17 #include <linux/namei.h>
  18 #include <linux/mutex.h>
  19 #include <linux/security.h>
  20
  21 #include "sysfs.h"
  22
  23 static int sysfs_do_create_link(struct kobject *kobj, struct kobject *target,
  24                                 const char *name, int warn)
  25 {
  26         struct sysfs_dirent *parent_sd = NULL;
  27         struct sysfs_dirent *target_sd = NULL;
  28         struct sysfs_dirent *sd = NULL;
  29         struct sysfs_addrm_cxt acxt;
  30         int error;
  31
  32         BUG_ON(!name);
  33
  34         if (!kobj)
  35                 parent_sd = &sysfs_root;
  36         else
  37                 parent_sd = kobj->sd;
  38
  39         error = -EFAULT;
  40         if (!parent_sd)
  41                 goto out_put;
  42
  43         /* target->sd can go away beneath us but is protected with
  44          * sysfs_assoc_lock.  Fetch target_sd from it.
  45          */
  46         spin_lock(&sysfs_assoc_lock);
  47         if (target->sd)
  48                 target_sd = sysfs_get(target->sd);
  49         spin_unlock(&sysfs_assoc_lock);
  50
  51         error = -ENOENT;
  52         if (!target_sd)
  53                 goto out_put;
  54
  55         error = -ENOMEM;
  56         sd = sysfs_new_dirent(name, S_IFLNK|S_IRWXUGO, SYSFS_KOBJ_LINK);
  57         if (!sd)
  58                 goto out_put;
  59
  60         sd->s_symlink.target_sd = target_sd;
  61         target_sd = NULL;       /* reference is now owned by the symlink */
  62
  63         sysfs_addrm_start(&acxt, parent_sd);
  64         if (warn)
  65                 error = sysfs_add_one(&acxt, sd);
  66         else
  67                 error = __sysfs_add_one(&acxt, sd);
  68         sysfs_addrm_finish(&acxt);
  69
  70         if (error)
  71                 goto out_put;
  72
  73         return 0;
  74
  75  out_put:
  76         sysfs_put(target_sd);
  77         sysfs_put(sd);
  78         return error;
  79 }
  80
  81 /**
  82  *      sysfs_create_link - create symlink between two objects.
  83  *      @kobj:  object whose directory we're creating the link in.
  84  *      @target:        object we're pointing to.
  85  *      @name:          name of the symlink.
  86  */
  87 int sysfs_create_link(struct kobject *kobj, struct kobject *target,
  88                       const char *name)
  89 {
  90         return sysfs_do_create_link(kobj, target, name, 1);
  91 }
  92
  93 /**
  94  *      sysfs_create_link_nowarn - create symlink between two objects.
  95  *      @kobj:  object whose directory we're creating the link in.
  96  *      @target:        object we're pointing to.
  97  *      @name:          name of the symlink.
  98  *
  99  *      This function does the same as sysf_create_link(), but it
 100  *      doesn't warn if the link already exists.
 101  */
 102 int sysfs_create_link_nowarn(struct kobject *kobj, struct kobject *target,
 103                              const char *name)
 104 {
 105         return sysfs_do_create_link(kobj, target, name, 0);
 106 }
 107
 108 /**
 109  *      sysfs_remove_link - remove symlink in object's directory.
 110  *      @kobj:  object we're acting for.
 111  *      @name:  name of the symlink to remove.
 112  */
 113
 114 void sysfs_remove_link(struct kobject * kobj, const char * name)
 115 {
 116         struct sysfs_dirent *parent_sd = NULL;
 117
 118         if (!kobj)
 119                 parent_sd = &sysfs_root;
 120         else
 121                 parent_sd = kobj->sd;
 122
 123         sysfs_hash_and_remove(parent_sd, name);
 124 }
 125
 126 /**
 127  *      sysfs_rename_link - rename symlink in object's directory.
 128  *      @kobj:  object we're acting for.
 129  *      @targ:  object we're pointing to.
 130  *      @old:   previous name of the symlink.
 131  *      @new:   new name of the symlink.
 132  *
 133  *      A helper function for the common rename symlink idiom.
 134  */
 135 int sysfs_rename_link(struct kobject *kobj, struct kobject *targ,
 136                         const char *old, const char *new)
 137 {
 138         struct sysfs_dirent *parent_sd, *sd = NULL;
 139         int result;
 140
 141         if (!kobj)
 142                 parent_sd = &sysfs_root;
 143         else
 144                 parent_sd = kobj->sd;
 145
 146         result = -ENOENT;
 147         sd = sysfs_get_dirent(parent_sd, old);
 148         if (!sd)
 149                 goto out;
 150
 151         result = -EINVAL;
 152         if (sysfs_type(sd) != SYSFS_KOBJ_LINK)
 153                 goto out;
 154         if (sd->s_symlink.target_sd->s_dir.kobj != targ)
 155                 goto out;
 156
 157         result = sysfs_rename(sd, parent_sd, new);
 158
 159 out:
 160         sysfs_put(sd);
 161         return result;
 162 }
 163
 164 static int sysfs_get_target_path(struct sysfs_dirent *parent_sd,
 165                                  struct sysfs_dirent *target_sd, char *path)
 166 {
 167         struct sysfs_dirent *base, *sd;
 168         char *s = path;
 169         int len = 0;
 170
 171         /* go up to the root, stop at the base */
 172         base = parent_sd;
 173         while (base->s_parent) {
 174                 sd = target_sd->s_parent;
 175                 while (sd->s_parent && base != sd)
 176                         sd = sd->s_parent;
 177
 178                 if (base == sd)
 179                         break;
 180
 181                 strcpy(s, "../");
 182                 s += 3;
 183                 base = base->s_parent;
 184         }
 185
 186         /* determine end of target string for reverse fillup */
 187         sd = target_sd;
 188         while (sd->s_parent && sd != base) {
 189                 len += strlen(sd->s_name) + 1;
 190                 sd = sd->s_parent;
 191         }
 192
 193         /* check limits */
 194         if (len < 2)
 195                 return -EINVAL;
 196         len--;
 197         if ((s - path) + len > PATH_MAX)
 198                 return -ENAMETOOLONG;
 199
 200         /* reverse fillup of target string from target to base */
 201         sd = target_sd;
 202         while (sd->s_parent && sd != base) {
 203                 int slen = strlen(sd->s_name);
 204
 205                 len -= slen;
 206                 strncpy(s + len, sd->s_name, slen);
 207                 if (len)
 208                         s[--len] = '/';
 209
 210                 sd = sd->s_parent;
 211         }
 212
 213         return 0;
 214 }
 215
 216 static int sysfs_getlink(struct dentry *dentry, char * path)
 217 {
 218         struct sysfs_dirent *sd = dentry->d_fsdata;
 219         struct sysfs_dirent *parent_sd = sd->s_parent;
 220         struct sysfs_dirent *target_sd = sd->s_symlink.target_sd;
 221         int error;
 222
 223         mutex_lock(&sysfs_mutex);
 224         error = sysfs_get_target_path(parent_sd, target_sd, path);
 225         mutex_unlock(&sysfs_mutex);
 226
 227         return error;
 228 }
 229
 230 static void *sysfs_follow_link(struct dentry *dentry, struct nameidata *nd)
 231 {
 232         int error = -ENOMEM;
 233         unsigned long page = get_zeroed_page(GFP_KERNEL);
 234         if (page) {
 235                 error = sysfs_getlink(dentry, (char *) page);
 236                 if (error < 0)
 237                         free_page((unsigned long)page);
 238         }
 239         nd_set_link(nd, error ? ERR_PTR(error) : (char *)page);
 240         return NULL;
 241 }
 242
 243 static void sysfs_put_link(struct dentry *dentry, struct nameidata *nd, void *cookie)
 244 {
 245         char *page = nd_get_link(nd);
 246         if (!IS_ERR(page))
 247                 free_page((unsigned long)page);
 248 }
 249
 250 const struct inode_operations sysfs_symlink_inode_operations = {
 251         .setxattr       = sysfs_setxattr,
 252         .readlink       = generic_readlink,
 253         .follow_link    = sysfs_follow_link,
 254         .put_link       = sysfs_put_link,
 255         .setattr        = sysfs_setattr,
 256         .getattr        = sysfs_getattr,
 257         .permission     = sysfs_permission,
 258 };
 259
 260
 261 EXPORT_SYMBOL_GPL(sysfs_create_link);
 262 EXPORT_SYMBOL_GPL(sysfs_remove_link);