debugobjects: add documentation
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / fs / sysfs / symlink.c
blob817f5966edcac2c2e36033902f2ac2ce0f89f626
1 /*
2 * fs/sysfs/symlink.c - sysfs symlink implementation
4 * Copyright (c) 2001-3 Patrick Mochel
5 * Copyright (c) 2007 SUSE Linux Products GmbH
6 * Copyright (c) 2007 Tejun Heo <teheo@suse.de>
8 * This file is released under the GPLv2.
10 * Please see Documentation/filesystems/sysfs.txt for more information.
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>
20 #include "sysfs.h"
22 /**
23 * sysfs_create_link - create symlink between two objects.
24 * @kobj: object whose directory we're creating the link in.
25 * @target: object we're pointing to.
26 * @name: name of the symlink.
28 int sysfs_create_link(struct kobject * kobj, struct kobject * target, const char * name)
30 struct sysfs_dirent *parent_sd = NULL;
31 struct sysfs_dirent *target_sd = NULL;
32 struct sysfs_dirent *sd = NULL;
33 struct sysfs_addrm_cxt acxt;
34 int error;
36 BUG_ON(!name);
38 if (!kobj)
39 parent_sd = &sysfs_root;
40 else
41 parent_sd = kobj->sd;
43 error = -EFAULT;
44 if (!parent_sd)
45 goto out_put;
47 /* target->sd can go away beneath us but is protected with
48 * sysfs_assoc_lock. Fetch target_sd from it.
50 spin_lock(&sysfs_assoc_lock);
51 if (target->sd)
52 target_sd = sysfs_get(target->sd);
53 spin_unlock(&sysfs_assoc_lock);
55 error = -ENOENT;
56 if (!target_sd)
57 goto out_put;
59 error = -ENOMEM;
60 sd = sysfs_new_dirent(name, S_IFLNK|S_IRWXUGO, SYSFS_KOBJ_LINK);
61 if (!sd)
62 goto out_put;
64 sd->s_symlink.target_sd = target_sd;
65 target_sd = NULL; /* reference is now owned by the symlink */
67 sysfs_addrm_start(&acxt, parent_sd);
68 error = sysfs_add_one(&acxt, sd);
69 sysfs_addrm_finish(&acxt);
71 if (error)
72 goto out_put;
74 return 0;
76 out_put:
77 sysfs_put(target_sd);
78 sysfs_put(sd);
79 return error;
82 /**
83 * sysfs_remove_link - remove symlink in object's directory.
84 * @kobj: object we're acting for.
85 * @name: name of the symlink to remove.
88 void sysfs_remove_link(struct kobject * kobj, const char * name)
90 struct sysfs_dirent *parent_sd = NULL;
92 if (!kobj)
93 parent_sd = &sysfs_root;
94 else
95 parent_sd = kobj->sd;
97 sysfs_hash_and_remove(parent_sd, name);
100 static int sysfs_get_target_path(struct sysfs_dirent *parent_sd,
101 struct sysfs_dirent *target_sd, char *path)
103 struct sysfs_dirent *base, *sd;
104 char *s = path;
105 int len = 0;
107 /* go up to the root, stop at the base */
108 base = parent_sd;
109 while (base->s_parent) {
110 sd = target_sd->s_parent;
111 while (sd->s_parent && base != sd)
112 sd = sd->s_parent;
114 if (base == sd)
115 break;
117 strcpy(s, "../");
118 s += 3;
119 base = base->s_parent;
122 /* determine end of target string for reverse fillup */
123 sd = target_sd;
124 while (sd->s_parent && sd != base) {
125 len += strlen(sd->s_name) + 1;
126 sd = sd->s_parent;
129 /* check limits */
130 if (len < 2)
131 return -EINVAL;
132 len--;
133 if ((s - path) + len > PATH_MAX)
134 return -ENAMETOOLONG;
136 /* reverse fillup of target string from target to base */
137 sd = target_sd;
138 while (sd->s_parent && sd != base) {
139 int slen = strlen(sd->s_name);
141 len -= slen;
142 strncpy(s + len, sd->s_name, slen);
143 if (len)
144 s[--len] = '/';
146 sd = sd->s_parent;
149 return 0;
152 static int sysfs_getlink(struct dentry *dentry, char * path)
154 struct sysfs_dirent *sd = dentry->d_fsdata;
155 struct sysfs_dirent *parent_sd = sd->s_parent;
156 struct sysfs_dirent *target_sd = sd->s_symlink.target_sd;
157 int error;
159 mutex_lock(&sysfs_mutex);
160 error = sysfs_get_target_path(parent_sd, target_sd, path);
161 mutex_unlock(&sysfs_mutex);
163 return error;
166 static void *sysfs_follow_link(struct dentry *dentry, struct nameidata *nd)
168 int error = -ENOMEM;
169 unsigned long page = get_zeroed_page(GFP_KERNEL);
170 if (page)
171 error = sysfs_getlink(dentry, (char *) page);
172 nd_set_link(nd, error ? ERR_PTR(error) : (char *)page);
173 return NULL;
176 static void sysfs_put_link(struct dentry *dentry, struct nameidata *nd, void *cookie)
178 char *page = nd_get_link(nd);
179 if (!IS_ERR(page))
180 free_page((unsigned long)page);
183 const struct inode_operations sysfs_symlink_inode_operations = {
184 .readlink = generic_readlink,
185 .follow_link = sysfs_follow_link,
186 .put_link = sysfs_put_link,
190 EXPORT_SYMBOL_GPL(sysfs_create_link);
191 EXPORT_SYMBOL_GPL(sysfs_remove_link);