lh | 9ed821d | 2023-04-07 01:36:19 -0700 | [diff] [blame] | 1 | /* |
| 2 | * fs/sysfs/dir.c - sysfs core and dir operation 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 | #undef DEBUG |
| 14 | |
| 15 | #include <linux/fs.h> |
| 16 | #include <linux/mount.h> |
| 17 | #include <linux/module.h> |
| 18 | #include <linux/kobject.h> |
| 19 | #include <linux/namei.h> |
| 20 | #include <linux/idr.h> |
| 21 | #include <linux/completion.h> |
| 22 | #include <linux/mutex.h> |
| 23 | #include <linux/slab.h> |
| 24 | #include <linux/security.h> |
| 25 | #include <linux/hash.h> |
| 26 | #include "sysfs.h" |
| 27 | |
| 28 | DEFINE_MUTEX(sysfs_mutex); |
| 29 | DEFINE_SPINLOCK(sysfs_assoc_lock); |
| 30 | |
| 31 | #define to_sysfs_dirent(X) rb_entry((X), struct sysfs_dirent, s_rb); |
| 32 | |
| 33 | static DEFINE_SPINLOCK(sysfs_ino_lock); |
| 34 | static DEFINE_IDA(sysfs_ino_ida); |
| 35 | |
| 36 | /** |
| 37 | * sysfs_name_hash |
| 38 | * @ns: Namespace tag to hash |
| 39 | * @name: Null terminated string to hash |
| 40 | * |
| 41 | * Returns 31 bit hash of ns + name (so it fits in an off_t ) |
| 42 | */ |
| 43 | static unsigned int sysfs_name_hash(const void *ns, const char *name) |
| 44 | { |
| 45 | unsigned long hash = init_name_hash(); |
| 46 | unsigned int len = strlen(name); |
| 47 | while (len--) |
| 48 | hash = partial_name_hash(*name++, hash); |
| 49 | hash = ( end_name_hash(hash) ^ hash_ptr( (void *)ns, 31 ) ); |
| 50 | hash &= 0x7fffffffU; |
| 51 | /* Reserve hash numbers 0, 1 and INT_MAX for magic directory entries */ |
| 52 | if (hash < 1) |
| 53 | hash += 2; |
| 54 | if (hash >= INT_MAX) |
| 55 | hash = INT_MAX - 1; |
| 56 | return hash; |
| 57 | } |
| 58 | |
| 59 | static int sysfs_name_compare(unsigned int hash, const void *ns, |
| 60 | const char *name, const struct sysfs_dirent *sd) |
| 61 | { |
| 62 | if (hash != sd->s_hash) |
| 63 | return hash - sd->s_hash; |
| 64 | if (ns != sd->s_ns) |
| 65 | return ns - sd->s_ns; |
| 66 | return strcmp(name, sd->s_name); |
| 67 | } |
| 68 | |
| 69 | static int sysfs_sd_compare(const struct sysfs_dirent *left, |
| 70 | const struct sysfs_dirent *right) |
| 71 | { |
| 72 | return sysfs_name_compare(left->s_hash, left->s_ns, left->s_name, |
| 73 | right); |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * sysfs_link_subling - link sysfs_dirent into sibling rbtree |
| 78 | * @sd: sysfs_dirent of interest |
| 79 | * |
| 80 | * Link @sd into its sibling rbtree which starts from |
| 81 | * sd->s_parent->s_dir.children. |
| 82 | * |
| 83 | * Locking: |
| 84 | * mutex_lock(sysfs_mutex) |
| 85 | * |
| 86 | * RETURNS: |
| 87 | * 0 on susccess -EEXIST on failure. |
| 88 | */ |
| 89 | static int sysfs_link_sibling(struct sysfs_dirent *sd) |
| 90 | { |
| 91 | struct rb_node **node = &sd->s_parent->s_dir.children.rb_node; |
| 92 | struct rb_node *parent = NULL; |
| 93 | |
| 94 | if (sysfs_type(sd) == SYSFS_DIR) |
| 95 | sd->s_parent->s_dir.subdirs++; |
| 96 | |
| 97 | while (*node) { |
| 98 | struct sysfs_dirent *pos; |
| 99 | int result; |
| 100 | |
| 101 | pos = to_sysfs_dirent(*node); |
| 102 | parent = *node; |
| 103 | result = sysfs_sd_compare(sd, pos); |
| 104 | if (result < 0) |
| 105 | node = &pos->s_rb.rb_left; |
| 106 | else if (result > 0) |
| 107 | node = &pos->s_rb.rb_right; |
| 108 | else |
| 109 | return -EEXIST; |
| 110 | } |
| 111 | /* add new node and rebalance the tree */ |
| 112 | rb_link_node(&sd->s_rb, parent, node); |
| 113 | rb_insert_color(&sd->s_rb, &sd->s_parent->s_dir.children); |
| 114 | return 0; |
| 115 | } |
| 116 | |
| 117 | /** |
| 118 | * sysfs_unlink_sibling - unlink sysfs_dirent from sibling rbtree |
| 119 | * @sd: sysfs_dirent of interest |
| 120 | * |
| 121 | * Unlink @sd from its sibling rbtree which starts from |
| 122 | * sd->s_parent->s_dir.children. |
| 123 | * |
| 124 | * Locking: |
| 125 | * mutex_lock(sysfs_mutex) |
| 126 | */ |
| 127 | static void sysfs_unlink_sibling(struct sysfs_dirent *sd) |
| 128 | { |
| 129 | if (sysfs_type(sd) == SYSFS_DIR) |
| 130 | sd->s_parent->s_dir.subdirs--; |
| 131 | |
| 132 | rb_erase(&sd->s_rb, &sd->s_parent->s_dir.children); |
| 133 | } |
| 134 | |
| 135 | /** |
| 136 | * sysfs_get_active - get an active reference to sysfs_dirent |
| 137 | * @sd: sysfs_dirent to get an active reference to |
| 138 | * |
| 139 | * Get an active reference of @sd. This function is noop if @sd |
| 140 | * is NULL. |
| 141 | * |
| 142 | * RETURNS: |
| 143 | * Pointer to @sd on success, NULL on failure. |
| 144 | */ |
| 145 | struct sysfs_dirent *sysfs_get_active(struct sysfs_dirent *sd) |
| 146 | { |
| 147 | if (unlikely(!sd)) |
| 148 | return NULL; |
| 149 | |
| 150 | while (1) { |
| 151 | int v, t; |
| 152 | |
| 153 | v = atomic_read(&sd->s_active); |
| 154 | if (unlikely(v < 0)) |
| 155 | return NULL; |
| 156 | |
| 157 | t = atomic_cmpxchg(&sd->s_active, v, v + 1); |
| 158 | if (likely(t == v)) { |
| 159 | rwsem_acquire_read(&sd->dep_map, 0, 1, _RET_IP_); |
| 160 | return sd; |
| 161 | } |
| 162 | if (t < 0) |
| 163 | return NULL; |
| 164 | |
| 165 | cpu_relax(); |
| 166 | } |
| 167 | } |
| 168 | |
| 169 | /** |
| 170 | * sysfs_put_active - put an active reference to sysfs_dirent |
| 171 | * @sd: sysfs_dirent to put an active reference to |
| 172 | * |
| 173 | * Put an active reference to @sd. This function is noop if @sd |
| 174 | * is NULL. |
| 175 | */ |
| 176 | void sysfs_put_active(struct sysfs_dirent *sd) |
| 177 | { |
| 178 | int v; |
| 179 | |
| 180 | if (unlikely(!sd)) |
| 181 | return; |
| 182 | |
| 183 | rwsem_release(&sd->dep_map, 1, _RET_IP_); |
| 184 | v = atomic_dec_return(&sd->s_active); |
| 185 | if (likely(v != SD_DEACTIVATED_BIAS)) |
| 186 | return; |
| 187 | |
| 188 | /* atomic_dec_return() is a mb(), we'll always see the updated |
| 189 | * sd->u.completion. |
| 190 | */ |
| 191 | complete(sd->u.completion); |
| 192 | } |
| 193 | |
| 194 | /** |
| 195 | * sysfs_deactivate - deactivate sysfs_dirent |
| 196 | * @sd: sysfs_dirent to deactivate |
| 197 | * |
| 198 | * Deny new active references and drain existing ones. |
| 199 | */ |
| 200 | static void sysfs_deactivate(struct sysfs_dirent *sd) |
| 201 | { |
| 202 | DECLARE_COMPLETION_ONSTACK(wait); |
| 203 | int v; |
| 204 | |
| 205 | BUG_ON(!(sd->s_flags & SYSFS_FLAG_REMOVED)); |
| 206 | |
| 207 | if (!(sysfs_type(sd) & SYSFS_ACTIVE_REF)) |
| 208 | return; |
| 209 | |
| 210 | sd->u.completion = (void *)&wait; |
| 211 | |
| 212 | rwsem_acquire(&sd->dep_map, 0, 0, _RET_IP_); |
| 213 | /* atomic_add_return() is a mb(), put_active() will always see |
| 214 | * the updated sd->u.completion. |
| 215 | */ |
| 216 | v = atomic_add_return(SD_DEACTIVATED_BIAS, &sd->s_active); |
| 217 | |
| 218 | if (v != SD_DEACTIVATED_BIAS) { |
| 219 | lock_contended(&sd->dep_map, _RET_IP_); |
| 220 | wait_for_completion(&wait); |
| 221 | } |
| 222 | |
| 223 | lock_acquired(&sd->dep_map, _RET_IP_); |
| 224 | rwsem_release(&sd->dep_map, 1, _RET_IP_); |
| 225 | } |
| 226 | |
| 227 | static int sysfs_alloc_ino(unsigned int *pino) |
| 228 | { |
| 229 | int ino, rc; |
| 230 | |
| 231 | retry: |
| 232 | spin_lock(&sysfs_ino_lock); |
| 233 | rc = ida_get_new_above(&sysfs_ino_ida, 2, &ino); |
| 234 | spin_unlock(&sysfs_ino_lock); |
| 235 | |
| 236 | if (rc == -EAGAIN) { |
| 237 | if (ida_pre_get(&sysfs_ino_ida, GFP_KERNEL)) |
| 238 | goto retry; |
| 239 | rc = -ENOMEM; |
| 240 | } |
| 241 | |
| 242 | *pino = ino; |
| 243 | return rc; |
| 244 | } |
| 245 | |
| 246 | static void sysfs_free_ino(unsigned int ino) |
| 247 | { |
| 248 | spin_lock(&sysfs_ino_lock); |
| 249 | ida_remove(&sysfs_ino_ida, ino); |
| 250 | spin_unlock(&sysfs_ino_lock); |
| 251 | } |
| 252 | |
| 253 | void release_sysfs_dirent(struct sysfs_dirent * sd) |
| 254 | { |
| 255 | struct sysfs_dirent *parent_sd; |
| 256 | |
| 257 | repeat: |
| 258 | /* Moving/renaming is always done while holding reference. |
| 259 | * sd->s_parent won't change beneath us. |
| 260 | */ |
| 261 | parent_sd = sd->s_parent; |
| 262 | |
| 263 | if (sysfs_type(sd) == SYSFS_KOBJ_LINK) |
| 264 | sysfs_put(sd->s_symlink.target_sd); |
| 265 | if (sysfs_type(sd) & SYSFS_COPY_NAME) |
| 266 | kfree(sd->s_name); |
| 267 | if (sd->s_iattr && sd->s_iattr->ia_secdata) |
| 268 | security_release_secctx(sd->s_iattr->ia_secdata, |
| 269 | sd->s_iattr->ia_secdata_len); |
| 270 | kfree(sd->s_iattr); |
| 271 | sysfs_free_ino(sd->s_ino); |
| 272 | kmem_cache_free(sysfs_dir_cachep, sd); |
| 273 | |
| 274 | sd = parent_sd; |
| 275 | if (sd && atomic_dec_and_test(&sd->s_count)) |
| 276 | goto repeat; |
| 277 | } |
| 278 | |
| 279 | static int sysfs_dentry_delete(const struct dentry *dentry) |
| 280 | { |
| 281 | struct sysfs_dirent *sd = dentry->d_fsdata; |
| 282 | return !!(sd->s_flags & SYSFS_FLAG_REMOVED); |
| 283 | } |
| 284 | |
| 285 | static int sysfs_dentry_revalidate(struct dentry *dentry, struct nameidata *nd) |
| 286 | { |
| 287 | struct sysfs_dirent *sd; |
| 288 | int is_dir; |
| 289 | |
| 290 | if (nd->flags & LOOKUP_RCU) |
| 291 | return -ECHILD; |
| 292 | |
| 293 | sd = dentry->d_fsdata; |
| 294 | mutex_lock(&sysfs_mutex); |
| 295 | |
| 296 | /* The sysfs dirent has been deleted */ |
| 297 | if (sd->s_flags & SYSFS_FLAG_REMOVED) |
| 298 | goto out_bad; |
| 299 | |
| 300 | /* The sysfs dirent has been moved? */ |
| 301 | if (dentry->d_parent->d_fsdata != sd->s_parent) |
| 302 | goto out_bad; |
| 303 | |
| 304 | /* The sysfs dirent has been renamed */ |
| 305 | if (strcmp(dentry->d_name.name, sd->s_name) != 0) |
| 306 | goto out_bad; |
| 307 | |
| 308 | mutex_unlock(&sysfs_mutex); |
| 309 | out_valid: |
| 310 | return 1; |
| 311 | out_bad: |
| 312 | /* Remove the dentry from the dcache hashes. |
| 313 | * If this is a deleted dentry we use d_drop instead of d_delete |
| 314 | * so sysfs doesn't need to cope with negative dentries. |
| 315 | * |
| 316 | * If this is a dentry that has simply been renamed we |
| 317 | * use d_drop to remove it from the dcache lookup on its |
| 318 | * old parent. If this dentry persists later when a lookup |
| 319 | * is performed at its new name the dentry will be readded |
| 320 | * to the dcache hashes. |
| 321 | */ |
| 322 | is_dir = (sysfs_type(sd) == SYSFS_DIR); |
| 323 | mutex_unlock(&sysfs_mutex); |
| 324 | if (is_dir) { |
| 325 | /* If we have submounts we must allow the vfs caches |
| 326 | * to lie about the state of the filesystem to prevent |
| 327 | * leaks and other nasty things. |
| 328 | */ |
| 329 | if (have_submounts(dentry)) |
| 330 | goto out_valid; |
| 331 | shrink_dcache_parent(dentry); |
| 332 | } |
| 333 | d_drop(dentry); |
| 334 | return 0; |
| 335 | } |
| 336 | |
| 337 | static void sysfs_dentry_iput(struct dentry *dentry, struct inode *inode) |
| 338 | { |
| 339 | struct sysfs_dirent * sd = dentry->d_fsdata; |
| 340 | |
| 341 | sysfs_put(sd); |
| 342 | iput(inode); |
| 343 | } |
| 344 | |
| 345 | static const struct dentry_operations sysfs_dentry_ops = { |
| 346 | .d_revalidate = sysfs_dentry_revalidate, |
| 347 | .d_delete = sysfs_dentry_delete, |
| 348 | .d_iput = sysfs_dentry_iput, |
| 349 | }; |
| 350 | |
| 351 | struct sysfs_dirent *sysfs_new_dirent(const char *name, umode_t mode, int type) |
| 352 | { |
| 353 | char *dup_name = NULL; |
| 354 | struct sysfs_dirent *sd; |
| 355 | |
| 356 | if (type & SYSFS_COPY_NAME) { |
| 357 | name = dup_name = kstrdup(name, GFP_KERNEL); |
| 358 | if (!name) |
| 359 | return NULL; |
| 360 | } |
| 361 | |
| 362 | sd = kmem_cache_zalloc(sysfs_dir_cachep, GFP_KERNEL); |
| 363 | if (!sd) |
| 364 | goto err_out1; |
| 365 | |
| 366 | if (sysfs_alloc_ino(&sd->s_ino)) |
| 367 | goto err_out2; |
| 368 | |
| 369 | atomic_set(&sd->s_count, 1); |
| 370 | atomic_set(&sd->s_active, 0); |
| 371 | |
| 372 | sd->s_name = name; |
| 373 | sd->s_mode = mode; |
| 374 | sd->s_flags = type; |
| 375 | |
| 376 | return sd; |
| 377 | |
| 378 | err_out2: |
| 379 | kmem_cache_free(sysfs_dir_cachep, sd); |
| 380 | err_out1: |
| 381 | kfree(dup_name); |
| 382 | return NULL; |
| 383 | } |
| 384 | |
| 385 | /** |
| 386 | * sysfs_addrm_start - prepare for sysfs_dirent add/remove |
| 387 | * @acxt: pointer to sysfs_addrm_cxt to be used |
| 388 | * @parent_sd: parent sysfs_dirent |
| 389 | * |
| 390 | * This function is called when the caller is about to add or |
| 391 | * remove sysfs_dirent under @parent_sd. This function acquires |
| 392 | * sysfs_mutex. @acxt is used to keep and pass context to |
| 393 | * other addrm functions. |
| 394 | * |
| 395 | * LOCKING: |
| 396 | * Kernel thread context (may sleep). sysfs_mutex is locked on |
| 397 | * return. |
| 398 | */ |
| 399 | void sysfs_addrm_start(struct sysfs_addrm_cxt *acxt, |
| 400 | struct sysfs_dirent *parent_sd) |
| 401 | { |
| 402 | memset(acxt, 0, sizeof(*acxt)); |
| 403 | acxt->parent_sd = parent_sd; |
| 404 | |
| 405 | mutex_lock(&sysfs_mutex); |
| 406 | } |
| 407 | |
| 408 | /** |
| 409 | * __sysfs_add_one - add sysfs_dirent to parent without warning |
| 410 | * @acxt: addrm context to use |
| 411 | * @sd: sysfs_dirent to be added |
| 412 | * |
| 413 | * Get @acxt->parent_sd and set sd->s_parent to it and increment |
| 414 | * nlink of parent inode if @sd is a directory and link into the |
| 415 | * children list of the parent. |
| 416 | * |
| 417 | * This function should be called between calls to |
| 418 | * sysfs_addrm_start() and sysfs_addrm_finish() and should be |
| 419 | * passed the same @acxt as passed to sysfs_addrm_start(). |
| 420 | * |
| 421 | * LOCKING: |
| 422 | * Determined by sysfs_addrm_start(). |
| 423 | * |
| 424 | * RETURNS: |
| 425 | * 0 on success, -EEXIST if entry with the given name already |
| 426 | * exists. |
| 427 | */ |
| 428 | int __sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd) |
| 429 | { |
| 430 | struct sysfs_inode_attrs *ps_iattr; |
| 431 | int ret; |
| 432 | |
| 433 | if (!!sysfs_ns_type(acxt->parent_sd) != !!sd->s_ns) { |
| 434 | WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n", |
| 435 | sysfs_ns_type(acxt->parent_sd)? "required": "invalid", |
| 436 | acxt->parent_sd->s_name, sd->s_name); |
| 437 | return -EINVAL; |
| 438 | } |
| 439 | |
| 440 | sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name); |
| 441 | sd->s_parent = sysfs_get(acxt->parent_sd); |
| 442 | |
| 443 | ret = sysfs_link_sibling(sd); |
| 444 | if (ret) |
| 445 | return ret; |
| 446 | |
| 447 | /* Update timestamps on the parent */ |
| 448 | ps_iattr = acxt->parent_sd->s_iattr; |
| 449 | if (ps_iattr) { |
| 450 | struct iattr *ps_iattrs = &ps_iattr->ia_iattr; |
| 451 | ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME; |
| 452 | } |
| 453 | |
| 454 | return 0; |
| 455 | } |
| 456 | |
| 457 | /** |
| 458 | * sysfs_pathname - return full path to sysfs dirent |
| 459 | * @sd: sysfs_dirent whose path we want |
| 460 | * @path: caller allocated buffer of size PATH_MAX |
| 461 | * |
| 462 | * Gives the name "/" to the sysfs_root entry; any path returned |
| 463 | * is relative to wherever sysfs is mounted. |
| 464 | */ |
| 465 | static char *sysfs_pathname(struct sysfs_dirent *sd, char *path) |
| 466 | { |
| 467 | if (sd->s_parent) { |
| 468 | sysfs_pathname(sd->s_parent, path); |
| 469 | strlcat(path, "/", PATH_MAX); |
| 470 | } |
| 471 | strlcat(path, sd->s_name, PATH_MAX); |
| 472 | return path; |
| 473 | } |
| 474 | |
| 475 | /** |
| 476 | * sysfs_add_one - add sysfs_dirent to parent |
| 477 | * @acxt: addrm context to use |
| 478 | * @sd: sysfs_dirent to be added |
| 479 | * |
| 480 | * Get @acxt->parent_sd and set sd->s_parent to it and increment |
| 481 | * nlink of parent inode if @sd is a directory and link into the |
| 482 | * children list of the parent. |
| 483 | * |
| 484 | * This function should be called between calls to |
| 485 | * sysfs_addrm_start() and sysfs_addrm_finish() and should be |
| 486 | * passed the same @acxt as passed to sysfs_addrm_start(). |
| 487 | * |
| 488 | * LOCKING: |
| 489 | * Determined by sysfs_addrm_start(). |
| 490 | * |
| 491 | * RETURNS: |
| 492 | * 0 on success, -EEXIST if entry with the given name already |
| 493 | * exists. |
| 494 | */ |
| 495 | int sysfs_add_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd) |
| 496 | { |
| 497 | int ret; |
| 498 | |
| 499 | ret = __sysfs_add_one(acxt, sd); |
| 500 | if (ret == -EEXIST) { |
| 501 | char *path = kzalloc(PATH_MAX, GFP_KERNEL); |
| 502 | WARN(1, KERN_WARNING |
| 503 | "sysfs: cannot create duplicate filename '%s'\n", |
| 504 | (path == NULL) ? sd->s_name |
| 505 | : (sysfs_pathname(acxt->parent_sd, path), |
| 506 | strlcat(path, "/", PATH_MAX), |
| 507 | strlcat(path, sd->s_name, PATH_MAX), |
| 508 | path)); |
| 509 | kfree(path); |
| 510 | } |
| 511 | |
| 512 | return ret; |
| 513 | } |
| 514 | |
| 515 | /** |
| 516 | * sysfs_remove_one - remove sysfs_dirent from parent |
| 517 | * @acxt: addrm context to use |
| 518 | * @sd: sysfs_dirent to be removed |
| 519 | * |
| 520 | * Mark @sd removed and drop nlink of parent inode if @sd is a |
| 521 | * directory. @sd is unlinked from the children list. |
| 522 | * |
| 523 | * This function should be called between calls to |
| 524 | * sysfs_addrm_start() and sysfs_addrm_finish() and should be |
| 525 | * passed the same @acxt as passed to sysfs_addrm_start(). |
| 526 | * |
| 527 | * LOCKING: |
| 528 | * Determined by sysfs_addrm_start(). |
| 529 | */ |
| 530 | void sysfs_remove_one(struct sysfs_addrm_cxt *acxt, struct sysfs_dirent *sd) |
| 531 | { |
| 532 | struct sysfs_inode_attrs *ps_iattr; |
| 533 | |
| 534 | BUG_ON(sd->s_flags & SYSFS_FLAG_REMOVED); |
| 535 | |
| 536 | sysfs_unlink_sibling(sd); |
| 537 | |
| 538 | /* Update timestamps on the parent */ |
| 539 | ps_iattr = acxt->parent_sd->s_iattr; |
| 540 | if (ps_iattr) { |
| 541 | struct iattr *ps_iattrs = &ps_iattr->ia_iattr; |
| 542 | ps_iattrs->ia_ctime = ps_iattrs->ia_mtime = CURRENT_TIME; |
| 543 | } |
| 544 | |
| 545 | sd->s_flags |= SYSFS_FLAG_REMOVED; |
| 546 | sd->u.removed_list = acxt->removed; |
| 547 | acxt->removed = sd; |
| 548 | } |
| 549 | |
| 550 | /** |
| 551 | * sysfs_addrm_finish - finish up sysfs_dirent add/remove |
| 552 | * @acxt: addrm context to finish up |
| 553 | * |
| 554 | * Finish up sysfs_dirent add/remove. Resources acquired by |
| 555 | * sysfs_addrm_start() are released and removed sysfs_dirents are |
| 556 | * cleaned up. |
| 557 | * |
| 558 | * LOCKING: |
| 559 | * sysfs_mutex is released. |
| 560 | */ |
| 561 | void sysfs_addrm_finish(struct sysfs_addrm_cxt *acxt) |
| 562 | { |
| 563 | /* release resources acquired by sysfs_addrm_start() */ |
| 564 | mutex_unlock(&sysfs_mutex); |
| 565 | |
| 566 | /* kill removed sysfs_dirents */ |
| 567 | while (acxt->removed) { |
| 568 | struct sysfs_dirent *sd = acxt->removed; |
| 569 | |
| 570 | acxt->removed = sd->u.removed_list; |
| 571 | |
| 572 | sysfs_deactivate(sd); |
| 573 | unmap_bin_file(sd); |
| 574 | sysfs_put(sd); |
| 575 | } |
| 576 | } |
| 577 | |
| 578 | /** |
| 579 | * sysfs_find_dirent - find sysfs_dirent with the given name |
| 580 | * @parent_sd: sysfs_dirent to search under |
| 581 | * @name: name to look for |
| 582 | * |
| 583 | * Look for sysfs_dirent with name @name under @parent_sd. |
| 584 | * |
| 585 | * LOCKING: |
| 586 | * mutex_lock(sysfs_mutex) |
| 587 | * |
| 588 | * RETURNS: |
| 589 | * Pointer to sysfs_dirent if found, NULL if not. |
| 590 | */ |
| 591 | struct sysfs_dirent *sysfs_find_dirent(struct sysfs_dirent *parent_sd, |
| 592 | const void *ns, |
| 593 | const unsigned char *name) |
| 594 | { |
| 595 | struct rb_node *node = parent_sd->s_dir.children.rb_node; |
| 596 | unsigned int hash; |
| 597 | |
| 598 | if (!!sysfs_ns_type(parent_sd) != !!ns) { |
| 599 | WARN(1, KERN_WARNING "sysfs: ns %s in '%s' for '%s'\n", |
| 600 | sysfs_ns_type(parent_sd)? "required": "invalid", |
| 601 | parent_sd->s_name, name); |
| 602 | return NULL; |
| 603 | } |
| 604 | |
| 605 | hash = sysfs_name_hash(ns, name); |
| 606 | while (node) { |
| 607 | struct sysfs_dirent *sd; |
| 608 | int result; |
| 609 | |
| 610 | sd = to_sysfs_dirent(node); |
| 611 | result = sysfs_name_compare(hash, ns, name, sd); |
| 612 | if (result < 0) |
| 613 | node = node->rb_left; |
| 614 | else if (result > 0) |
| 615 | node = node->rb_right; |
| 616 | else |
| 617 | return sd; |
| 618 | } |
| 619 | return NULL; |
| 620 | } |
| 621 | |
| 622 | /** |
| 623 | * sysfs_get_dirent - find and get sysfs_dirent with the given name |
| 624 | * @parent_sd: sysfs_dirent to search under |
| 625 | * @name: name to look for |
| 626 | * |
| 627 | * Look for sysfs_dirent with name @name under @parent_sd and get |
| 628 | * it if found. |
| 629 | * |
| 630 | * LOCKING: |
| 631 | * Kernel thread context (may sleep). Grabs sysfs_mutex. |
| 632 | * |
| 633 | * RETURNS: |
| 634 | * Pointer to sysfs_dirent if found, NULL if not. |
| 635 | */ |
| 636 | struct sysfs_dirent *sysfs_get_dirent(struct sysfs_dirent *parent_sd, |
| 637 | const void *ns, |
| 638 | const unsigned char *name) |
| 639 | { |
| 640 | struct sysfs_dirent *sd; |
| 641 | |
| 642 | mutex_lock(&sysfs_mutex); |
| 643 | sd = sysfs_find_dirent(parent_sd, ns, name); |
| 644 | sysfs_get(sd); |
| 645 | mutex_unlock(&sysfs_mutex); |
| 646 | |
| 647 | return sd; |
| 648 | } |
| 649 | EXPORT_SYMBOL_GPL(sysfs_get_dirent); |
| 650 | |
| 651 | static int create_dir(struct kobject *kobj, struct sysfs_dirent *parent_sd, |
| 652 | enum kobj_ns_type type, const void *ns, const char *name, |
| 653 | struct sysfs_dirent **p_sd) |
| 654 | { |
| 655 | umode_t mode = S_IFDIR| S_IRWXU | S_IRUGO | S_IXUGO; |
| 656 | struct sysfs_addrm_cxt acxt; |
| 657 | struct sysfs_dirent *sd; |
| 658 | int rc; |
| 659 | |
| 660 | /* allocate */ |
| 661 | sd = sysfs_new_dirent(name, mode, SYSFS_DIR); |
| 662 | if (!sd) |
| 663 | return -ENOMEM; |
| 664 | |
| 665 | sd->s_flags |= (type << SYSFS_NS_TYPE_SHIFT); |
| 666 | sd->s_ns = ns; |
| 667 | sd->s_dir.kobj = kobj; |
| 668 | |
| 669 | /* link in */ |
| 670 | sysfs_addrm_start(&acxt, parent_sd); |
| 671 | rc = sysfs_add_one(&acxt, sd); |
| 672 | sysfs_addrm_finish(&acxt); |
| 673 | |
| 674 | if (rc == 0) |
| 675 | *p_sd = sd; |
| 676 | else |
| 677 | sysfs_put(sd); |
| 678 | |
| 679 | return rc; |
| 680 | } |
| 681 | |
| 682 | int sysfs_create_subdir(struct kobject *kobj, const char *name, |
| 683 | struct sysfs_dirent **p_sd) |
| 684 | { |
| 685 | return create_dir(kobj, kobj->sd, |
| 686 | KOBJ_NS_TYPE_NONE, NULL, name, p_sd); |
| 687 | } |
| 688 | |
| 689 | /** |
| 690 | * sysfs_read_ns_type: return associated ns_type |
| 691 | * @kobj: the kobject being queried |
| 692 | * |
| 693 | * Each kobject can be tagged with exactly one namespace type |
| 694 | * (i.e. network or user). Return the ns_type associated with |
| 695 | * this object if any |
| 696 | */ |
| 697 | static enum kobj_ns_type sysfs_read_ns_type(struct kobject *kobj) |
| 698 | { |
| 699 | const struct kobj_ns_type_operations *ops; |
| 700 | enum kobj_ns_type type; |
| 701 | |
| 702 | ops = kobj_child_ns_ops(kobj); |
| 703 | if (!ops) |
| 704 | return KOBJ_NS_TYPE_NONE; |
| 705 | |
| 706 | type = ops->type; |
| 707 | BUG_ON(type <= KOBJ_NS_TYPE_NONE); |
| 708 | BUG_ON(type >= KOBJ_NS_TYPES); |
| 709 | BUG_ON(!kobj_ns_type_registered(type)); |
| 710 | |
| 711 | return type; |
| 712 | } |
| 713 | |
| 714 | /** |
| 715 | * sysfs_create_dir - create a directory for an object. |
| 716 | * @kobj: object we're creating directory for. |
| 717 | */ |
| 718 | int sysfs_create_dir(struct kobject * kobj) |
| 719 | { |
| 720 | enum kobj_ns_type type; |
| 721 | struct sysfs_dirent *parent_sd, *sd; |
| 722 | const void *ns = NULL; |
| 723 | int error = 0; |
| 724 | |
| 725 | BUG_ON(!kobj); |
| 726 | |
| 727 | if (kobj->parent) |
| 728 | parent_sd = kobj->parent->sd; |
| 729 | else |
| 730 | parent_sd = &sysfs_root; |
| 731 | |
| 732 | if (!parent_sd) |
| 733 | return -ENOENT; |
| 734 | |
| 735 | if (sysfs_ns_type(parent_sd)) |
| 736 | ns = kobj->ktype->namespace(kobj); |
| 737 | type = sysfs_read_ns_type(kobj); |
| 738 | |
| 739 | error = create_dir(kobj, parent_sd, type, ns, kobject_name(kobj), &sd); |
| 740 | if (!error) |
| 741 | kobj->sd = sd; |
| 742 | return error; |
| 743 | } |
| 744 | |
| 745 | static struct dentry * sysfs_lookup(struct inode *dir, struct dentry *dentry, |
| 746 | struct nameidata *nd) |
| 747 | { |
| 748 | struct dentry *ret = NULL; |
| 749 | struct dentry *parent = dentry->d_parent; |
| 750 | struct sysfs_dirent *parent_sd = parent->d_fsdata; |
| 751 | struct sysfs_dirent *sd; |
| 752 | struct inode *inode; |
| 753 | enum kobj_ns_type type; |
| 754 | const void *ns; |
| 755 | |
| 756 | mutex_lock(&sysfs_mutex); |
| 757 | |
| 758 | type = sysfs_ns_type(parent_sd); |
| 759 | ns = sysfs_info(dir->i_sb)->ns[type]; |
| 760 | |
| 761 | sd = sysfs_find_dirent(parent_sd, ns, dentry->d_name.name); |
| 762 | |
| 763 | /* no such entry */ |
| 764 | if (!sd) { |
| 765 | ret = ERR_PTR(-ENOENT); |
| 766 | goto out_unlock; |
| 767 | } |
| 768 | |
| 769 | /* attach dentry and inode */ |
| 770 | inode = sysfs_get_inode(dir->i_sb, sd); |
| 771 | if (!inode) { |
| 772 | ret = ERR_PTR(-ENOMEM); |
| 773 | goto out_unlock; |
| 774 | } |
| 775 | |
| 776 | /* instantiate and hash dentry */ |
| 777 | ret = d_find_alias(inode); |
| 778 | if (!ret) { |
| 779 | d_set_d_op(dentry, &sysfs_dentry_ops); |
| 780 | dentry->d_fsdata = sysfs_get(sd); |
| 781 | d_add(dentry, inode); |
| 782 | } else { |
| 783 | d_move(ret, dentry); |
| 784 | iput(inode); |
| 785 | } |
| 786 | |
| 787 | out_unlock: |
| 788 | mutex_unlock(&sysfs_mutex); |
| 789 | return ret; |
| 790 | } |
| 791 | |
| 792 | const struct inode_operations sysfs_dir_inode_operations = { |
| 793 | .lookup = sysfs_lookup, |
| 794 | .permission = sysfs_permission, |
| 795 | .setattr = sysfs_setattr, |
| 796 | .getattr = sysfs_getattr, |
| 797 | .setxattr = sysfs_setxattr, |
| 798 | }; |
| 799 | |
| 800 | static void remove_dir(struct sysfs_dirent *sd) |
| 801 | { |
| 802 | struct sysfs_addrm_cxt acxt; |
| 803 | |
| 804 | sysfs_addrm_start(&acxt, sd->s_parent); |
| 805 | sysfs_remove_one(&acxt, sd); |
| 806 | sysfs_addrm_finish(&acxt); |
| 807 | } |
| 808 | |
| 809 | void sysfs_remove_subdir(struct sysfs_dirent *sd) |
| 810 | { |
| 811 | remove_dir(sd); |
| 812 | } |
| 813 | |
| 814 | |
| 815 | static void __sysfs_remove_dir(struct sysfs_dirent *dir_sd) |
| 816 | { |
| 817 | struct sysfs_addrm_cxt acxt; |
| 818 | struct rb_node *pos; |
| 819 | |
| 820 | if (!dir_sd) |
| 821 | return; |
| 822 | |
| 823 | pr_debug("sysfs %s: removing dir\n", dir_sd->s_name); |
| 824 | sysfs_addrm_start(&acxt, dir_sd); |
| 825 | pos = rb_first(&dir_sd->s_dir.children); |
| 826 | while (pos) { |
| 827 | struct sysfs_dirent *sd = to_sysfs_dirent(pos); |
| 828 | pos = rb_next(pos); |
| 829 | if (sysfs_type(sd) != SYSFS_DIR) |
| 830 | sysfs_remove_one(&acxt, sd); |
| 831 | } |
| 832 | sysfs_addrm_finish(&acxt); |
| 833 | |
| 834 | remove_dir(dir_sd); |
| 835 | } |
| 836 | |
| 837 | /** |
| 838 | * sysfs_remove_dir - remove an object's directory. |
| 839 | * @kobj: object. |
| 840 | * |
| 841 | * The only thing special about this is that we remove any files in |
| 842 | * the directory before we remove the directory, and we've inlined |
| 843 | * what used to be sysfs_rmdir() below, instead of calling separately. |
| 844 | */ |
| 845 | |
| 846 | void sysfs_remove_dir(struct kobject * kobj) |
| 847 | { |
| 848 | struct sysfs_dirent *sd = kobj->sd; |
| 849 | |
| 850 | spin_lock(&sysfs_assoc_lock); |
| 851 | kobj->sd = NULL; |
| 852 | spin_unlock(&sysfs_assoc_lock); |
| 853 | |
| 854 | __sysfs_remove_dir(sd); |
| 855 | } |
| 856 | |
| 857 | int sysfs_rename(struct sysfs_dirent *sd, |
| 858 | struct sysfs_dirent *new_parent_sd, const void *new_ns, |
| 859 | const char *new_name) |
| 860 | { |
| 861 | const char *dup_name = NULL; |
| 862 | int error; |
| 863 | |
| 864 | mutex_lock(&sysfs_mutex); |
| 865 | |
| 866 | error = 0; |
| 867 | if ((sd->s_parent == new_parent_sd) && (sd->s_ns == new_ns) && |
| 868 | (strcmp(sd->s_name, new_name) == 0)) |
| 869 | goto out; /* nothing to rename */ |
| 870 | |
| 871 | error = -EEXIST; |
| 872 | if (sysfs_find_dirent(new_parent_sd, new_ns, new_name)) |
| 873 | goto out; |
| 874 | |
| 875 | /* rename sysfs_dirent */ |
| 876 | if (strcmp(sd->s_name, new_name) != 0) { |
| 877 | error = -ENOMEM; |
| 878 | new_name = dup_name = kstrdup(new_name, GFP_KERNEL); |
| 879 | if (!new_name) |
| 880 | goto out; |
| 881 | |
| 882 | dup_name = sd->s_name; |
| 883 | sd->s_name = new_name; |
| 884 | } |
| 885 | |
| 886 | /* Move to the appropriate place in the appropriate directories rbtree. */ |
| 887 | sysfs_unlink_sibling(sd); |
| 888 | sysfs_get(new_parent_sd); |
| 889 | sysfs_put(sd->s_parent); |
| 890 | sd->s_ns = new_ns; |
| 891 | sd->s_hash = sysfs_name_hash(sd->s_ns, sd->s_name); |
| 892 | sd->s_parent = new_parent_sd; |
| 893 | sysfs_link_sibling(sd); |
| 894 | |
| 895 | error = 0; |
| 896 | out: |
| 897 | mutex_unlock(&sysfs_mutex); |
| 898 | kfree(dup_name); |
| 899 | return error; |
| 900 | } |
| 901 | |
| 902 | int sysfs_rename_dir(struct kobject *kobj, const char *new_name) |
| 903 | { |
| 904 | struct sysfs_dirent *parent_sd = kobj->sd->s_parent; |
| 905 | const void *new_ns = NULL; |
| 906 | |
| 907 | if (sysfs_ns_type(parent_sd)) |
| 908 | new_ns = kobj->ktype->namespace(kobj); |
| 909 | |
| 910 | return sysfs_rename(kobj->sd, parent_sd, new_ns, new_name); |
| 911 | } |
| 912 | |
| 913 | int sysfs_move_dir(struct kobject *kobj, struct kobject *new_parent_kobj) |
| 914 | { |
| 915 | struct sysfs_dirent *sd = kobj->sd; |
| 916 | struct sysfs_dirent *new_parent_sd; |
| 917 | const void *new_ns = NULL; |
| 918 | |
| 919 | BUG_ON(!sd->s_parent); |
| 920 | if (sysfs_ns_type(sd->s_parent)) |
| 921 | new_ns = kobj->ktype->namespace(kobj); |
| 922 | new_parent_sd = new_parent_kobj && new_parent_kobj->sd ? |
| 923 | new_parent_kobj->sd : &sysfs_root; |
| 924 | |
| 925 | return sysfs_rename(sd, new_parent_sd, new_ns, sd->s_name); |
| 926 | } |
| 927 | |
| 928 | /* Relationship between s_mode and the DT_xxx types */ |
| 929 | static inline unsigned char dt_type(struct sysfs_dirent *sd) |
| 930 | { |
| 931 | return (sd->s_mode >> 12) & 15; |
| 932 | } |
| 933 | |
| 934 | static int sysfs_dir_release(struct inode *inode, struct file *filp) |
| 935 | { |
| 936 | sysfs_put(filp->private_data); |
| 937 | return 0; |
| 938 | } |
| 939 | |
| 940 | static struct sysfs_dirent *sysfs_dir_pos(const void *ns, |
| 941 | struct sysfs_dirent *parent_sd, loff_t hash, struct sysfs_dirent *pos) |
| 942 | { |
| 943 | if (pos) { |
| 944 | int valid = !(pos->s_flags & SYSFS_FLAG_REMOVED) && |
| 945 | pos->s_parent == parent_sd && |
| 946 | hash == pos->s_hash; |
| 947 | sysfs_put(pos); |
| 948 | if (!valid) |
| 949 | pos = NULL; |
| 950 | } |
| 951 | if (!pos && (hash > 1) && (hash < INT_MAX)) { |
| 952 | struct rb_node *node = parent_sd->s_dir.children.rb_node; |
| 953 | while (node) { |
| 954 | pos = to_sysfs_dirent(node); |
| 955 | |
| 956 | if (hash < pos->s_hash) |
| 957 | node = node->rb_left; |
| 958 | else if (hash > pos->s_hash) |
| 959 | node = node->rb_right; |
| 960 | else |
| 961 | break; |
| 962 | } |
| 963 | } |
| 964 | /* Skip over entries in the wrong namespace */ |
| 965 | while (pos && pos->s_ns != ns) { |
| 966 | struct rb_node *node = rb_next(&pos->s_rb); |
| 967 | if (!node) |
| 968 | pos = NULL; |
| 969 | else |
| 970 | pos = to_sysfs_dirent(node); |
| 971 | } |
| 972 | return pos; |
| 973 | } |
| 974 | |
| 975 | static struct sysfs_dirent *sysfs_dir_next_pos(const void *ns, |
| 976 | struct sysfs_dirent *parent_sd, ino_t ino, struct sysfs_dirent *pos) |
| 977 | { |
| 978 | pos = sysfs_dir_pos(ns, parent_sd, ino, pos); |
| 979 | if (pos) do { |
| 980 | struct rb_node *node = rb_next(&pos->s_rb); |
| 981 | if (!node) |
| 982 | pos = NULL; |
| 983 | else |
| 984 | pos = to_sysfs_dirent(node); |
| 985 | } while (pos && pos->s_ns != ns); |
| 986 | return pos; |
| 987 | } |
| 988 | |
| 989 | static int sysfs_readdir(struct file * filp, void * dirent, filldir_t filldir) |
| 990 | { |
| 991 | struct dentry *dentry = filp->f_path.dentry; |
| 992 | struct sysfs_dirent * parent_sd = dentry->d_fsdata; |
| 993 | struct sysfs_dirent *pos = filp->private_data; |
| 994 | enum kobj_ns_type type; |
| 995 | const void *ns; |
| 996 | ino_t ino; |
| 997 | loff_t off; |
| 998 | |
| 999 | type = sysfs_ns_type(parent_sd); |
| 1000 | ns = sysfs_info(dentry->d_sb)->ns[type]; |
| 1001 | |
| 1002 | if (filp->f_pos == 0) { |
| 1003 | ino = parent_sd->s_ino; |
| 1004 | if (filldir(dirent, ".", 1, filp->f_pos, ino, DT_DIR) == 0) |
| 1005 | filp->f_pos++; |
| 1006 | else |
| 1007 | return 0; |
| 1008 | } |
| 1009 | if (filp->f_pos == 1) { |
| 1010 | if (parent_sd->s_parent) |
| 1011 | ino = parent_sd->s_parent->s_ino; |
| 1012 | else |
| 1013 | ino = parent_sd->s_ino; |
| 1014 | if (filldir(dirent, "..", 2, filp->f_pos, ino, DT_DIR) == 0) |
| 1015 | filp->f_pos++; |
| 1016 | else |
| 1017 | return 0; |
| 1018 | } |
| 1019 | mutex_lock(&sysfs_mutex); |
| 1020 | off = filp->f_pos; |
| 1021 | for (pos = sysfs_dir_pos(ns, parent_sd, filp->f_pos, pos); |
| 1022 | pos; |
| 1023 | pos = sysfs_dir_next_pos(ns, parent_sd, filp->f_pos, pos)) { |
| 1024 | const char * name; |
| 1025 | unsigned int type; |
| 1026 | int len, ret; |
| 1027 | |
| 1028 | name = pos->s_name; |
| 1029 | len = strlen(name); |
| 1030 | ino = pos->s_ino; |
| 1031 | type = dt_type(pos); |
| 1032 | off = filp->f_pos = pos->s_hash; |
| 1033 | filp->private_data = sysfs_get(pos); |
| 1034 | |
| 1035 | mutex_unlock(&sysfs_mutex); |
| 1036 | ret = filldir(dirent, name, len, off, ino, type); |
| 1037 | mutex_lock(&sysfs_mutex); |
| 1038 | if (ret < 0) |
| 1039 | break; |
| 1040 | } |
| 1041 | mutex_unlock(&sysfs_mutex); |
| 1042 | |
| 1043 | /* don't reference last entry if its refcount is dropped */ |
| 1044 | if (!pos) { |
| 1045 | filp->private_data = NULL; |
| 1046 | |
| 1047 | /* EOF and not changed as 0 or 1 in read/write path */ |
| 1048 | if (off == filp->f_pos && off > 1) |
| 1049 | filp->f_pos = INT_MAX; |
| 1050 | } |
| 1051 | return 0; |
| 1052 | } |
| 1053 | |
| 1054 | static loff_t sysfs_dir_llseek(struct file *file, loff_t offset, int whence) |
| 1055 | { |
| 1056 | struct inode *inode = file->f_path.dentry->d_inode; |
| 1057 | loff_t ret; |
| 1058 | |
| 1059 | mutex_lock(&inode->i_mutex); |
| 1060 | ret = generic_file_llseek(file, offset, whence); |
| 1061 | mutex_unlock(&inode->i_mutex); |
| 1062 | |
| 1063 | return ret; |
| 1064 | } |
| 1065 | |
| 1066 | const struct file_operations sysfs_dir_operations = { |
| 1067 | .read = generic_read_dir, |
| 1068 | .readdir = sysfs_readdir, |
| 1069 | .release = sysfs_dir_release, |
| 1070 | .llseek = sysfs_dir_llseek, |
| 1071 | }; |