Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
Tejun Heo | 6d66f5c | 2007-09-20 17:31:38 +0900 | [diff] [blame] | 2 | * fs/sysfs/file.c - sysfs regular (text) file 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. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 11 | */ |
| 12 | |
| 13 | #include <linux/module.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 14 | #include <linux/kobject.h> |
Andrew Morton | 815d2d5 | 2008-03-04 15:09:07 -0800 | [diff] [blame] | 15 | #include <linux/kallsyms.h> |
Robert P. J. Day | c6f8773 | 2008-03-13 22:41:52 -0400 | [diff] [blame] | 16 | #include <linux/slab.h> |
Oliver Neukum | 94bebf4 | 2006-12-20 10:52:44 +0100 | [diff] [blame] | 17 | #include <linux/list.h> |
Dave Young | 52e8c20 | 2007-07-26 11:03:54 +0000 | [diff] [blame] | 18 | #include <linux/mutex.h> |
Tejun Heo | 13c589d | 2013-10-01 17:42:02 -0400 | [diff] [blame] | 19 | #include <linux/seq_file.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 20 | |
| 21 | #include "sysfs.h" |
Tejun Heo | 414985a | 2013-11-28 14:54:34 -0500 | [diff] [blame] | 22 | #include "../kernfs/kernfs-internal.h" |
Tejun Heo | f6acf8b | 2013-11-28 14:54:21 -0500 | [diff] [blame] | 23 | |
| 24 | /* |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 25 | * Determine ktype->sysfs_ops for the given kernfs_node. This function |
Tejun Heo | 375b611 | 2013-10-01 17:41:57 -0400 | [diff] [blame] | 26 | * must be called while holding an active reference. |
| 27 | */ |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 28 | static const struct sysfs_ops *sysfs_file_ops(struct kernfs_node *kn) |
Tejun Heo | 375b611 | 2013-10-01 17:41:57 -0400 | [diff] [blame] | 29 | { |
Tejun Heo | adc5e8b | 2013-12-11 14:11:54 -0500 | [diff] [blame] | 30 | struct kobject *kobj = kn->parent->priv; |
Tejun Heo | 375b611 | 2013-10-01 17:41:57 -0400 | [diff] [blame] | 31 | |
Tejun Heo | df23fc3 | 2013-12-11 14:11:56 -0500 | [diff] [blame] | 32 | if (kn->flags & KERNFS_LOCKDEP) |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 33 | lockdep_assert_held(kn); |
Tejun Heo | 375b611 | 2013-10-01 17:41:57 -0400 | [diff] [blame] | 34 | return kobj->ktype ? kobj->ktype->sysfs_ops : NULL; |
| 35 | } |
| 36 | |
Tejun Heo | 13c589d | 2013-10-01 17:42:02 -0400 | [diff] [blame] | 37 | /* |
| 38 | * Reads on sysfs are handled through seq_file, which takes care of hairy |
| 39 | * details like buffering and seeking. The following function pipes |
| 40 | * sysfs_ops->show() result through seq_file. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 41 | */ |
Tejun Heo | c2b19da | 2013-11-28 14:54:16 -0500 | [diff] [blame] | 42 | static int sysfs_kf_seq_show(struct seq_file *sf, void *v) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 43 | { |
Tejun Heo | c525aad | 2013-12-11 14:11:55 -0500 | [diff] [blame] | 44 | struct kernfs_open_file *of = sf->private; |
Tejun Heo | adc5e8b | 2013-12-11 14:11:54 -0500 | [diff] [blame] | 45 | struct kobject *kobj = of->kn->parent->priv; |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 46 | const struct sysfs_ops *ops = sysfs_file_ops(of->kn); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 47 | ssize_t count; |
Tejun Heo | c2b19da | 2013-11-28 14:54:16 -0500 | [diff] [blame] | 48 | char *buf; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | |
Tejun Heo | 13c589d | 2013-10-01 17:42:02 -0400 | [diff] [blame] | 50 | /* acquire buffer and ensure that it's >= PAGE_SIZE */ |
| 51 | count = seq_get_buf(sf, &buf); |
| 52 | if (count < PAGE_SIZE) { |
| 53 | seq_commit(sf, -1); |
| 54 | return 0; |
| 55 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 56 | |
Tejun Heo | 13c589d | 2013-10-01 17:42:02 -0400 | [diff] [blame] | 57 | /* |
Tejun Heo | c2b19da | 2013-11-28 14:54:16 -0500 | [diff] [blame] | 58 | * Invoke show(). Control may reach here via seq file lseek even |
| 59 | * if @ops->show() isn't implemented. |
Tejun Heo | 13c589d | 2013-10-01 17:42:02 -0400 | [diff] [blame] | 60 | */ |
Tejun Heo | c2b19da | 2013-11-28 14:54:16 -0500 | [diff] [blame] | 61 | if (ops->show) { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 62 | count = ops->show(kobj, of->kn->priv, buf); |
Tejun Heo | c2b19da | 2013-11-28 14:54:16 -0500 | [diff] [blame] | 63 | if (count < 0) |
| 64 | return count; |
| 65 | } |
Tejun Heo | 0ab6608 | 2007-06-14 03:45:16 +0900 | [diff] [blame] | 66 | |
Miao Xie | 8118a85 | 2007-11-21 14:55:19 -0800 | [diff] [blame] | 67 | /* |
| 68 | * The code works fine with PAGE_SIZE return but it's likely to |
| 69 | * indicate truncated result or overflow in normal use cases. |
| 70 | */ |
Andrew Morton | 815d2d5 | 2008-03-04 15:09:07 -0800 | [diff] [blame] | 71 | if (count >= (ssize_t)PAGE_SIZE) { |
| 72 | print_symbol("fill_read_buffer: %s returned bad count\n", |
| 73 | (unsigned long)ops->show); |
| 74 | /* Try to struggle along */ |
| 75 | count = PAGE_SIZE - 1; |
| 76 | } |
Tejun Heo | 13c589d | 2013-10-01 17:42:02 -0400 | [diff] [blame] | 77 | seq_commit(sf, count); |
| 78 | return 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 79 | } |
| 80 | |
Tejun Heo | c525aad | 2013-12-11 14:11:55 -0500 | [diff] [blame] | 81 | static ssize_t sysfs_kf_bin_read(struct kernfs_open_file *of, char *buf, |
Tejun Heo | c2b19da | 2013-11-28 14:54:16 -0500 | [diff] [blame] | 82 | size_t count, loff_t pos) |
Tejun Heo | 2f0c6b7 | 2013-10-01 17:42:06 -0400 | [diff] [blame] | 83 | { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 84 | struct bin_attribute *battr = of->kn->priv; |
Tejun Heo | adc5e8b | 2013-12-11 14:11:54 -0500 | [diff] [blame] | 85 | struct kobject *kobj = of->kn->parent->priv; |
Tejun Heo | c2b19da | 2013-11-28 14:54:16 -0500 | [diff] [blame] | 86 | loff_t size = file_inode(of->file)->i_size; |
Tejun Heo | 2f0c6b7 | 2013-10-01 17:42:06 -0400 | [diff] [blame] | 87 | |
Tejun Heo | c2b19da | 2013-11-28 14:54:16 -0500 | [diff] [blame] | 88 | if (!count) |
Tejun Heo | 2f0c6b7 | 2013-10-01 17:42:06 -0400 | [diff] [blame] | 89 | return 0; |
| 90 | |
| 91 | if (size) { |
Tejun Heo | c2b19da | 2013-11-28 14:54:16 -0500 | [diff] [blame] | 92 | if (pos > size) |
Tejun Heo | 2f0c6b7 | 2013-10-01 17:42:06 -0400 | [diff] [blame] | 93 | return 0; |
Tejun Heo | c2b19da | 2013-11-28 14:54:16 -0500 | [diff] [blame] | 94 | if (pos + count > size) |
| 95 | count = size - pos; |
Tejun Heo | 2f0c6b7 | 2013-10-01 17:42:06 -0400 | [diff] [blame] | 96 | } |
| 97 | |
Tejun Heo | c2b19da | 2013-11-28 14:54:16 -0500 | [diff] [blame] | 98 | if (!battr->read) |
| 99 | return -EIO; |
| 100 | |
| 101 | return battr->read(of->file, kobj, battr, buf, pos, count); |
| 102 | } |
| 103 | |
Tejun Heo | 50b38ca | 2013-11-28 14:54:17 -0500 | [diff] [blame] | 104 | /* kernfs write callback for regular sysfs files */ |
Tejun Heo | c525aad | 2013-12-11 14:11:55 -0500 | [diff] [blame] | 105 | static ssize_t sysfs_kf_write(struct kernfs_open_file *of, char *buf, |
Tejun Heo | 50b38ca | 2013-11-28 14:54:17 -0500 | [diff] [blame] | 106 | size_t count, loff_t pos) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 107 | { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 108 | const struct sysfs_ops *ops = sysfs_file_ops(of->kn); |
Tejun Heo | adc5e8b | 2013-12-11 14:11:54 -0500 | [diff] [blame] | 109 | struct kobject *kobj = of->kn->parent->priv; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 110 | |
Tejun Heo | 50b38ca | 2013-11-28 14:54:17 -0500 | [diff] [blame] | 111 | if (!count) |
| 112 | return 0; |
| 113 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 114 | return ops->store(kobj, of->kn->priv, buf, count); |
Tejun Heo | 50b38ca | 2013-11-28 14:54:17 -0500 | [diff] [blame] | 115 | } |
| 116 | |
| 117 | /* kernfs write callback for bin sysfs files */ |
Tejun Heo | c525aad | 2013-12-11 14:11:55 -0500 | [diff] [blame] | 118 | static ssize_t sysfs_kf_bin_write(struct kernfs_open_file *of, char *buf, |
Tejun Heo | 50b38ca | 2013-11-28 14:54:17 -0500 | [diff] [blame] | 119 | size_t count, loff_t pos) |
| 120 | { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 121 | struct bin_attribute *battr = of->kn->priv; |
Tejun Heo | adc5e8b | 2013-12-11 14:11:54 -0500 | [diff] [blame] | 122 | struct kobject *kobj = of->kn->parent->priv; |
Tejun Heo | 50b38ca | 2013-11-28 14:54:17 -0500 | [diff] [blame] | 123 | loff_t size = file_inode(of->file)->i_size; |
| 124 | |
| 125 | if (size) { |
| 126 | if (size <= pos) |
| 127 | return 0; |
| 128 | count = min_t(ssize_t, count, size - pos); |
Tejun Heo | 8ef445f | 2013-10-01 17:42:01 -0400 | [diff] [blame] | 129 | } |
Tejun Heo | 50b38ca | 2013-11-28 14:54:17 -0500 | [diff] [blame] | 130 | if (!count) |
| 131 | return 0; |
Tejun Heo | 0ab6608 | 2007-06-14 03:45:16 +0900 | [diff] [blame] | 132 | |
Tejun Heo | 50b38ca | 2013-11-28 14:54:17 -0500 | [diff] [blame] | 133 | if (!battr->write) |
| 134 | return -EIO; |
Tejun Heo | f9b9a62 | 2013-10-01 17:42:05 -0400 | [diff] [blame] | 135 | |
Tejun Heo | 50b38ca | 2013-11-28 14:54:17 -0500 | [diff] [blame] | 136 | return battr->write(of->file, kobj, battr, buf, pos, count); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 137 | } |
| 138 | |
Tejun Heo | c525aad | 2013-12-11 14:11:55 -0500 | [diff] [blame] | 139 | static int sysfs_kf_bin_mmap(struct kernfs_open_file *of, |
Tejun Heo | fdbffaa | 2013-11-28 14:54:18 -0500 | [diff] [blame] | 140 | struct vm_area_struct *vma) |
| 141 | { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 142 | struct bin_attribute *battr = of->kn->priv; |
Tejun Heo | adc5e8b | 2013-12-11 14:11:54 -0500 | [diff] [blame] | 143 | struct kobject *kobj = of->kn->parent->priv; |
Tejun Heo | fdbffaa | 2013-11-28 14:54:18 -0500 | [diff] [blame] | 144 | |
Tejun Heo | fdbffaa | 2013-11-28 14:54:18 -0500 | [diff] [blame] | 145 | return battr->mmap(of->file, kobj, battr, vma); |
| 146 | } |
| 147 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 148 | void sysfs_notify(struct kobject *kobj, const char *dir, const char *attr) |
NeilBrown | 4508a7a | 2006-03-20 17:53:53 +1100 | [diff] [blame] | 149 | { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 150 | struct kernfs_node *kn = kobj->sd, *tmp; |
NeilBrown | 4508a7a | 2006-03-20 17:53:53 +1100 | [diff] [blame] | 151 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 152 | if (kn && dir) |
| 153 | kn = kernfs_find_and_get(kn, dir); |
Tejun Heo | 024f647 | 2013-11-28 14:54:27 -0500 | [diff] [blame] | 154 | else |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 155 | kernfs_get(kn); |
Tejun Heo | 5122503 | 2007-06-14 04:27:25 +0900 | [diff] [blame] | 156 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 157 | if (kn && attr) { |
| 158 | tmp = kernfs_find_and_get(kn, attr); |
| 159 | kernfs_put(kn); |
| 160 | kn = tmp; |
Tejun Heo | 024f647 | 2013-11-28 14:54:27 -0500 | [diff] [blame] | 161 | } |
| 162 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 163 | if (kn) { |
| 164 | kernfs_notify(kn); |
| 165 | kernfs_put(kn); |
Tejun Heo | 024f647 | 2013-11-28 14:54:27 -0500 | [diff] [blame] | 166 | } |
NeilBrown | 4508a7a | 2006-03-20 17:53:53 +1100 | [diff] [blame] | 167 | } |
| 168 | EXPORT_SYMBOL_GPL(sysfs_notify); |
| 169 | |
Tejun Heo | f6acf8b | 2013-11-28 14:54:21 -0500 | [diff] [blame] | 170 | static const struct kernfs_ops sysfs_file_kfops_empty = { |
| 171 | }; |
| 172 | |
| 173 | static const struct kernfs_ops sysfs_file_kfops_ro = { |
| 174 | .seq_show = sysfs_kf_seq_show, |
| 175 | }; |
| 176 | |
| 177 | static const struct kernfs_ops sysfs_file_kfops_wo = { |
| 178 | .write = sysfs_kf_write, |
| 179 | }; |
| 180 | |
| 181 | static const struct kernfs_ops sysfs_file_kfops_rw = { |
| 182 | .seq_show = sysfs_kf_seq_show, |
| 183 | .write = sysfs_kf_write, |
| 184 | }; |
| 185 | |
| 186 | static const struct kernfs_ops sysfs_bin_kfops_ro = { |
| 187 | .read = sysfs_kf_bin_read, |
| 188 | }; |
| 189 | |
| 190 | static const struct kernfs_ops sysfs_bin_kfops_wo = { |
| 191 | .write = sysfs_kf_bin_write, |
| 192 | }; |
| 193 | |
| 194 | static const struct kernfs_ops sysfs_bin_kfops_rw = { |
| 195 | .read = sysfs_kf_bin_read, |
| 196 | .write = sysfs_kf_bin_write, |
Tejun Heo | 9b2db6e | 2013-12-10 09:29:17 -0500 | [diff] [blame] | 197 | }; |
| 198 | |
| 199 | static const struct kernfs_ops sysfs_bin_kfops_mmap = { |
| 200 | .read = sysfs_kf_bin_read, |
| 201 | .write = sysfs_kf_bin_write, |
Tejun Heo | f6acf8b | 2013-11-28 14:54:21 -0500 | [diff] [blame] | 202 | .mmap = sysfs_kf_bin_mmap, |
| 203 | }; |
| 204 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 205 | int sysfs_add_file_mode_ns(struct kernfs_node *parent, |
Tejun Heo | a7dc66d | 2013-11-28 14:54:23 -0500 | [diff] [blame] | 206 | const struct attribute *attr, bool is_bin, |
Tejun Heo | 496f739 | 2013-11-28 14:54:24 -0500 | [diff] [blame] | 207 | umode_t mode, const void *ns) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 208 | { |
Tejun Heo | 517e64f | 2013-11-28 14:54:29 -0500 | [diff] [blame] | 209 | struct lock_class_key *key = NULL; |
Tejun Heo | f6acf8b | 2013-11-28 14:54:21 -0500 | [diff] [blame] | 210 | const struct kernfs_ops *ops; |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 211 | struct kernfs_node *kn; |
Tejun Heo | 471bd7b | 2013-11-28 14:54:22 -0500 | [diff] [blame] | 212 | loff_t size; |
Tejun Heo | a26cd72 | 2007-06-14 03:45:14 +0900 | [diff] [blame] | 213 | |
Tejun Heo | a7dc66d | 2013-11-28 14:54:23 -0500 | [diff] [blame] | 214 | if (!is_bin) { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 215 | struct kobject *kobj = parent->priv; |
Tejun Heo | f6acf8b | 2013-11-28 14:54:21 -0500 | [diff] [blame] | 216 | const struct sysfs_ops *sysfs_ops = kobj->ktype->sysfs_ops; |
| 217 | |
| 218 | /* every kobject with an attribute needs a ktype assigned */ |
| 219 | if (WARN(!sysfs_ops, KERN_ERR |
| 220 | "missing sysfs attribute operations for kobject: %s\n", |
| 221 | kobject_name(kobj))) |
| 222 | return -EINVAL; |
| 223 | |
| 224 | if (sysfs_ops->show && sysfs_ops->store) |
| 225 | ops = &sysfs_file_kfops_rw; |
| 226 | else if (sysfs_ops->show) |
| 227 | ops = &sysfs_file_kfops_ro; |
| 228 | else if (sysfs_ops->store) |
| 229 | ops = &sysfs_file_kfops_wo; |
| 230 | else |
| 231 | ops = &sysfs_file_kfops_empty; |
Tejun Heo | 471bd7b | 2013-11-28 14:54:22 -0500 | [diff] [blame] | 232 | |
| 233 | size = PAGE_SIZE; |
Tejun Heo | f6acf8b | 2013-11-28 14:54:21 -0500 | [diff] [blame] | 234 | } else { |
| 235 | struct bin_attribute *battr = (void *)attr; |
| 236 | |
Tejun Heo | 9b2db6e | 2013-12-10 09:29:17 -0500 | [diff] [blame] | 237 | if (battr->mmap) |
| 238 | ops = &sysfs_bin_kfops_mmap; |
| 239 | else if (battr->read && battr->write) |
Tejun Heo | f6acf8b | 2013-11-28 14:54:21 -0500 | [diff] [blame] | 240 | ops = &sysfs_bin_kfops_rw; |
| 241 | else if (battr->read) |
| 242 | ops = &sysfs_bin_kfops_ro; |
| 243 | else if (battr->write) |
| 244 | ops = &sysfs_bin_kfops_wo; |
| 245 | else |
| 246 | ops = &sysfs_file_kfops_empty; |
Tejun Heo | 471bd7b | 2013-11-28 14:54:22 -0500 | [diff] [blame] | 247 | |
| 248 | size = battr->size; |
Tejun Heo | f6acf8b | 2013-11-28 14:54:21 -0500 | [diff] [blame] | 249 | } |
| 250 | |
Tejun Heo | 517e64f | 2013-11-28 14:54:29 -0500 | [diff] [blame] | 251 | #ifdef CONFIG_DEBUG_LOCK_ALLOC |
| 252 | if (!attr->ignore_lockdep) |
| 253 | key = attr->key ?: (struct lock_class_key *)&attr->skey; |
| 254 | #endif |
Tejun Heo | 2063d60 | 2013-12-11 16:02:57 -0500 | [diff] [blame] | 255 | kn = __kernfs_create_file(parent, attr->name, mode, size, ops, |
| 256 | (void *)attr, ns, true, key); |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 257 | if (IS_ERR(kn)) { |
| 258 | if (PTR_ERR(kn) == -EEXIST) |
| 259 | sysfs_warn_dup(parent, attr->name); |
| 260 | return PTR_ERR(kn); |
Tejun Heo | 496f739 | 2013-11-28 14:54:24 -0500 | [diff] [blame] | 261 | } |
| 262 | return 0; |
| 263 | } |
| 264 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 265 | int sysfs_add_file(struct kernfs_node *parent, const struct attribute *attr, |
Tejun Heo | a7dc66d | 2013-11-28 14:54:23 -0500 | [diff] [blame] | 266 | bool is_bin) |
James Bottomley | 0f42389 | 2008-03-20 20:47:52 -0500 | [diff] [blame] | 267 | { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 268 | return sysfs_add_file_mode_ns(parent, attr, is_bin, attr->mode, NULL); |
James Bottomley | 0f42389 | 2008-03-20 20:47:52 -0500 | [diff] [blame] | 269 | } |
| 270 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 271 | /** |
Tejun Heo | 58292cbe | 2013-09-11 22:29:04 -0400 | [diff] [blame] | 272 | * sysfs_create_file_ns - create an attribute file for an object with custom ns |
| 273 | * @kobj: object we're creating for |
| 274 | * @attr: attribute descriptor |
| 275 | * @ns: namespace the new file should belong to |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 276 | */ |
Tejun Heo | 58292cbe | 2013-09-11 22:29:04 -0400 | [diff] [blame] | 277 | int sysfs_create_file_ns(struct kobject *kobj, const struct attribute *attr, |
| 278 | const void *ns) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 279 | { |
Tejun Heo | 608e266 | 2007-06-14 04:27:22 +0900 | [diff] [blame] | 280 | BUG_ON(!kobj || !kobj->sd || !attr); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 281 | |
Tejun Heo | a7dc66d | 2013-11-28 14:54:23 -0500 | [diff] [blame] | 282 | return sysfs_add_file_mode_ns(kobj->sd, attr, false, attr->mode, ns); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 283 | |
| 284 | } |
Tejun Heo | 58292cbe | 2013-09-11 22:29:04 -0400 | [diff] [blame] | 285 | EXPORT_SYMBOL_GPL(sysfs_create_file_ns); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 286 | |
Andi Kleen | 1c205ae | 2010-01-05 12:48:01 +0100 | [diff] [blame] | 287 | int sysfs_create_files(struct kobject *kobj, const struct attribute **ptr) |
| 288 | { |
| 289 | int err = 0; |
| 290 | int i; |
| 291 | |
| 292 | for (i = 0; ptr[i] && !err; i++) |
| 293 | err = sysfs_create_file(kobj, ptr[i]); |
| 294 | if (err) |
| 295 | while (--i >= 0) |
| 296 | sysfs_remove_file(kobj, ptr[i]); |
| 297 | return err; |
| 298 | } |
Greg Kroah-Hartman | 1b86675 | 2013-08-21 16:17:47 -0700 | [diff] [blame] | 299 | EXPORT_SYMBOL_GPL(sysfs_create_files); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 300 | |
| 301 | /** |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 302 | * sysfs_add_file_to_group - add an attribute file to a pre-existing group. |
| 303 | * @kobj: object we're acting for. |
| 304 | * @attr: attribute descriptor. |
| 305 | * @group: group name. |
| 306 | */ |
| 307 | int sysfs_add_file_to_group(struct kobject *kobj, |
| 308 | const struct attribute *attr, const char *group) |
| 309 | { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 310 | struct kernfs_node *parent; |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 311 | int error; |
| 312 | |
Tejun Heo | ccf73cf | 2013-11-28 14:54:30 -0500 | [diff] [blame] | 313 | if (group) { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 314 | parent = kernfs_find_and_get(kobj->sd, group); |
Tejun Heo | ccf73cf | 2013-11-28 14:54:30 -0500 | [diff] [blame] | 315 | } else { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 316 | parent = kobj->sd; |
| 317 | kernfs_get(parent); |
Tejun Heo | ccf73cf | 2013-11-28 14:54:30 -0500 | [diff] [blame] | 318 | } |
James Bottomley | 11f24fb | 2008-01-02 18:44:05 -0600 | [diff] [blame] | 319 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 320 | if (!parent) |
Tejun Heo | 608e266 | 2007-06-14 04:27:22 +0900 | [diff] [blame] | 321 | return -ENOENT; |
| 322 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 323 | error = sysfs_add_file(parent, attr, false); |
| 324 | kernfs_put(parent); |
Tejun Heo | 608e266 | 2007-06-14 04:27:22 +0900 | [diff] [blame] | 325 | |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 326 | return error; |
| 327 | } |
| 328 | EXPORT_SYMBOL_GPL(sysfs_add_file_to_group); |
| 329 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 330 | /** |
Kay Sievers | 31e5abe | 2005-04-18 21:57:32 -0700 | [diff] [blame] | 331 | * sysfs_chmod_file - update the modified mode value on an object attribute. |
| 332 | * @kobj: object we're acting for. |
| 333 | * @attr: attribute descriptor. |
| 334 | * @mode: file permissions. |
| 335 | * |
| 336 | */ |
Jean Delvare | 49c1940 | 2010-07-02 16:54:05 +0200 | [diff] [blame] | 337 | int sysfs_chmod_file(struct kobject *kobj, const struct attribute *attr, |
Al Viro | 48176a9 | 2011-07-24 03:40:40 -0400 | [diff] [blame] | 338 | umode_t mode) |
Kay Sievers | 31e5abe | 2005-04-18 21:57:32 -0700 | [diff] [blame] | 339 | { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 340 | struct kernfs_node *kn; |
Maneesh Soni | bc062b1 | 2005-07-29 12:13:35 -0700 | [diff] [blame] | 341 | struct iattr newattrs; |
Tejun Heo | 5122503 | 2007-06-14 04:27:25 +0900 | [diff] [blame] | 342 | int rc; |
Kay Sievers | 31e5abe | 2005-04-18 21:57:32 -0700 | [diff] [blame] | 343 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 344 | kn = kernfs_find_and_get(kobj->sd, attr->name); |
| 345 | if (!kn) |
Tejun Heo | 5d60418 | 2013-11-23 17:21:52 -0500 | [diff] [blame] | 346 | return -ENOENT; |
Tejun Heo | 5122503 | 2007-06-14 04:27:25 +0900 | [diff] [blame] | 347 | |
Tejun Heo | adc5e8b | 2013-12-11 14:11:54 -0500 | [diff] [blame] | 348 | newattrs.ia_mode = (mode & S_IALLUGO) | (kn->mode & ~S_IALLUGO); |
Eric W. Biederman | 4c6974f | 2009-11-07 23:27:02 -0800 | [diff] [blame] | 349 | newattrs.ia_valid = ATTR_MODE; |
Tejun Heo | f88123e | 2007-09-20 16:05:10 +0900 | [diff] [blame] | 350 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 351 | rc = kernfs_setattr(kn, &newattrs); |
Tejun Heo | 5d60418 | 2013-11-23 17:21:52 -0500 | [diff] [blame] | 352 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 353 | kernfs_put(kn); |
Tejun Heo | 5122503 | 2007-06-14 04:27:25 +0900 | [diff] [blame] | 354 | return rc; |
Kay Sievers | 31e5abe | 2005-04-18 21:57:32 -0700 | [diff] [blame] | 355 | } |
| 356 | EXPORT_SYMBOL_GPL(sysfs_chmod_file); |
| 357 | |
Kay Sievers | 31e5abe | 2005-04-18 21:57:32 -0700 | [diff] [blame] | 358 | /** |
Tejun Heo | 58292cbe | 2013-09-11 22:29:04 -0400 | [diff] [blame] | 359 | * sysfs_remove_file_ns - remove an object attribute with a custom ns tag |
| 360 | * @kobj: object we're acting for |
| 361 | * @attr: attribute descriptor |
| 362 | * @ns: namespace tag of the file to remove |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 363 | * |
Tejun Heo | 58292cbe | 2013-09-11 22:29:04 -0400 | [diff] [blame] | 364 | * Hash the attribute name and namespace tag and kill the victim. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 365 | */ |
Tejun Heo | 58292cbe | 2013-09-11 22:29:04 -0400 | [diff] [blame] | 366 | void sysfs_remove_file_ns(struct kobject *kobj, const struct attribute *attr, |
| 367 | const void *ns) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 368 | { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 369 | struct kernfs_node *parent = kobj->sd; |
Eric W. Biederman | 487505c | 2011-10-12 21:53:38 +0000 | [diff] [blame] | 370 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 371 | kernfs_remove_by_name_ns(parent, attr->name, ns); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 372 | } |
Tejun Heo | 58292cbe | 2013-09-11 22:29:04 -0400 | [diff] [blame] | 373 | EXPORT_SYMBOL_GPL(sysfs_remove_file_ns); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 374 | |
Tejun Heo | 6b0afc2 | 2014-02-03 14:03:01 -0500 | [diff] [blame] | 375 | /** |
| 376 | * sysfs_remove_file_self - remove an object attribute from its own method |
| 377 | * @kobj: object we're acting for |
| 378 | * @attr: attribute descriptor |
| 379 | * |
| 380 | * See kernfs_remove_self() for details. |
| 381 | */ |
| 382 | bool sysfs_remove_file_self(struct kobject *kobj, const struct attribute *attr) |
| 383 | { |
| 384 | struct kernfs_node *parent = kobj->sd; |
| 385 | struct kernfs_node *kn; |
| 386 | bool ret; |
| 387 | |
| 388 | kn = kernfs_find_and_get(parent, attr->name); |
| 389 | if (WARN_ON_ONCE(!kn)) |
| 390 | return false; |
| 391 | |
| 392 | ret = kernfs_remove_self(kn); |
| 393 | |
| 394 | kernfs_put(kn); |
| 395 | return ret; |
| 396 | } |
| 397 | |
Greg Kroah-Hartman | 1b18dc2 | 2013-08-21 16:28:26 -0700 | [diff] [blame] | 398 | void sysfs_remove_files(struct kobject *kobj, const struct attribute **ptr) |
Andi Kleen | 1c205ae | 2010-01-05 12:48:01 +0100 | [diff] [blame] | 399 | { |
| 400 | int i; |
| 401 | for (i = 0; ptr[i]; i++) |
| 402 | sysfs_remove_file(kobj, ptr[i]); |
| 403 | } |
Greg Kroah-Hartman | 1b86675 | 2013-08-21 16:17:47 -0700 | [diff] [blame] | 404 | EXPORT_SYMBOL_GPL(sysfs_remove_files); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 405 | |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 406 | /** |
| 407 | * sysfs_remove_file_from_group - remove an attribute file from a group. |
| 408 | * @kobj: object we're acting for. |
| 409 | * @attr: attribute descriptor. |
| 410 | * @group: group name. |
| 411 | */ |
| 412 | void sysfs_remove_file_from_group(struct kobject *kobj, |
| 413 | const struct attribute *attr, const char *group) |
| 414 | { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 415 | struct kernfs_node *parent; |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 416 | |
Tejun Heo | ccf73cf | 2013-11-28 14:54:30 -0500 | [diff] [blame] | 417 | if (group) { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 418 | parent = kernfs_find_and_get(kobj->sd, group); |
Tejun Heo | ccf73cf | 2013-11-28 14:54:30 -0500 | [diff] [blame] | 419 | } else { |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 420 | parent = kobj->sd; |
| 421 | kernfs_get(parent); |
Tejun Heo | ccf73cf | 2013-11-28 14:54:30 -0500 | [diff] [blame] | 422 | } |
| 423 | |
Tejun Heo | 324a56e | 2013-12-11 14:11:53 -0500 | [diff] [blame] | 424 | if (parent) { |
| 425 | kernfs_remove_by_name(parent, attr->name); |
| 426 | kernfs_put(parent); |
Alan Stern | dfa87c8 | 2007-02-20 15:02:44 -0500 | [diff] [blame] | 427 | } |
| 428 | } |
| 429 | EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group); |
| 430 | |
Tejun Heo | 3124eb1 | 2013-10-01 17:42:09 -0400 | [diff] [blame] | 431 | /** |
| 432 | * sysfs_create_bin_file - create binary file for object. |
| 433 | * @kobj: object. |
| 434 | * @attr: attribute descriptor. |
| 435 | */ |
| 436 | int sysfs_create_bin_file(struct kobject *kobj, |
| 437 | const struct bin_attribute *attr) |
| 438 | { |
| 439 | BUG_ON(!kobj || !kobj->sd || !attr); |
| 440 | |
Tejun Heo | a7dc66d | 2013-11-28 14:54:23 -0500 | [diff] [blame] | 441 | return sysfs_add_file(kobj->sd, &attr->attr, true); |
Tejun Heo | 3124eb1 | 2013-10-01 17:42:09 -0400 | [diff] [blame] | 442 | } |
| 443 | EXPORT_SYMBOL_GPL(sysfs_create_bin_file); |
| 444 | |
| 445 | /** |
| 446 | * sysfs_remove_bin_file - remove binary file for object. |
| 447 | * @kobj: object. |
| 448 | * @attr: attribute descriptor. |
| 449 | */ |
| 450 | void sysfs_remove_bin_file(struct kobject *kobj, |
| 451 | const struct bin_attribute *attr) |
| 452 | { |
Tejun Heo | 879f40d | 2013-11-23 17:21:49 -0500 | [diff] [blame] | 453 | kernfs_remove_by_name(kobj->sd, attr->attr.name); |
Tejun Heo | 3124eb1 | 2013-10-01 17:42:09 -0400 | [diff] [blame] | 454 | } |
| 455 | EXPORT_SYMBOL_GPL(sysfs_remove_bin_file); |