file.c 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795
  1. /*
  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.
  11. */
  12. #include <linux/module.h>
  13. #include <linux/kobject.h>
  14. #include <linux/kallsyms.h>
  15. #include <linux/slab.h>
  16. #include <linux/fsnotify.h>
  17. #include <linux/namei.h>
  18. #include <linux/poll.h>
  19. #include <linux/list.h>
  20. #include <linux/mutex.h>
  21. #include <linux/limits.h>
  22. #include <linux/uaccess.h>
  23. #include "sysfs.h"
  24. /*
  25. * There's one sysfs_buffer for each open file and one
  26. * sysfs_open_dirent for each sysfs_dirent with one or more open
  27. * files.
  28. *
  29. * filp->private_data points to sysfs_buffer and
  30. * sysfs_dirent->s_attr.open points to sysfs_open_dirent. s_attr.open
  31. * is protected by sysfs_open_dirent_lock.
  32. */
  33. static DEFINE_SPINLOCK(sysfs_open_dirent_lock);
  34. struct sysfs_open_dirent {
  35. atomic_t refcnt;
  36. atomic_t event;
  37. wait_queue_head_t poll;
  38. struct list_head buffers; /* goes through sysfs_buffer.list */
  39. };
  40. struct sysfs_buffer {
  41. size_t count;
  42. loff_t pos;
  43. char *page;
  44. const struct sysfs_ops *ops;
  45. struct mutex mutex;
  46. int needs_read_fill;
  47. int event;
  48. struct list_head list;
  49. };
  50. /**
  51. * fill_read_buffer - allocate and fill buffer from object.
  52. * @dentry: dentry pointer.
  53. * @buffer: data buffer for file.
  54. *
  55. * Allocate @buffer->page, if it hasn't been already, then call the
  56. * kobject's show() method to fill the buffer with this attribute's
  57. * data.
  58. * This is called only once, on the file's first read unless an error
  59. * is returned.
  60. */
  61. static int fill_read_buffer(struct dentry *dentry, struct sysfs_buffer *buffer)
  62. {
  63. struct sysfs_dirent *attr_sd = dentry->d_fsdata;
  64. struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
  65. const struct sysfs_ops *ops = buffer->ops;
  66. int ret = 0;
  67. ssize_t count;
  68. if (!buffer->page)
  69. buffer->page = (char *) get_zeroed_page(GFP_KERNEL);
  70. if (!buffer->page)
  71. return -ENOMEM;
  72. /* need attr_sd for attr and ops, its parent for kobj */
  73. if (!sysfs_get_active(attr_sd))
  74. return -ENODEV;
  75. buffer->event = atomic_read(&attr_sd->s_attr.open->event);
  76. count = ops->show(kobj, attr_sd->s_attr.attr, buffer->page);
  77. sysfs_put_active(attr_sd);
  78. /*
  79. * The code works fine with PAGE_SIZE return but it's likely to
  80. * indicate truncated result or overflow in normal use cases.
  81. */
  82. if (count >= (ssize_t)PAGE_SIZE) {
  83. print_symbol("fill_read_buffer: %s returned bad count\n",
  84. (unsigned long)ops->show);
  85. /* Try to struggle along */
  86. count = PAGE_SIZE - 1;
  87. }
  88. if (count >= 0) {
  89. buffer->needs_read_fill = 0;
  90. buffer->count = count;
  91. } else {
  92. ret = count;
  93. }
  94. return ret;
  95. }
  96. /**
  97. * sysfs_read_file - read an attribute.
  98. * @file: file pointer.
  99. * @buf: buffer to fill.
  100. * @count: number of bytes to read.
  101. * @ppos: starting offset in file.
  102. *
  103. * Userspace wants to read an attribute file. The attribute descriptor
  104. * is in the file's ->d_fsdata. The target object is in the directory's
  105. * ->d_fsdata.
  106. *
  107. * We call fill_read_buffer() to allocate and fill the buffer from the
  108. * object's show() method exactly once (if the read is happening from
  109. * the beginning of the file). That should fill the entire buffer with
  110. * all the data the object has to offer for that attribute.
  111. * We then call flush_read_buffer() to copy the buffer to userspace
  112. * in the increments specified.
  113. */
  114. static ssize_t
  115. sysfs_read_file(struct file *file, char __user *buf, size_t count, loff_t *ppos)
  116. {
  117. struct sysfs_buffer *buffer = file->private_data;
  118. ssize_t retval = 0;
  119. mutex_lock(&buffer->mutex);
  120. if (buffer->needs_read_fill || *ppos == 0) {
  121. retval = fill_read_buffer(file->f_path.dentry, buffer);
  122. if (retval)
  123. goto out;
  124. }
  125. pr_debug("%s: count = %zd, ppos = %lld, buf = %s\n",
  126. __func__, count, *ppos, buffer->page);
  127. retval = simple_read_from_buffer(buf, count, ppos, buffer->page,
  128. buffer->count);
  129. out:
  130. mutex_unlock(&buffer->mutex);
  131. return retval;
  132. }
  133. /**
  134. * fill_write_buffer - copy buffer from userspace.
  135. * @buffer: data buffer for file.
  136. * @buf: data from user.
  137. * @count: number of bytes in @userbuf.
  138. *
  139. * Allocate @buffer->page if it hasn't been already, then
  140. * copy the user-supplied buffer into it.
  141. */
  142. static int fill_write_buffer(struct sysfs_buffer *buffer,
  143. const char __user *buf, size_t count)
  144. {
  145. int error;
  146. if (!buffer->page)
  147. buffer->page = (char *)get_zeroed_page(GFP_KERNEL);
  148. if (!buffer->page)
  149. return -ENOMEM;
  150. if (count >= PAGE_SIZE)
  151. count = PAGE_SIZE - 1;
  152. error = copy_from_user(buffer->page, buf, count);
  153. buffer->needs_read_fill = 1;
  154. /* if buf is assumed to contain a string, terminate it by \0,
  155. so e.g. sscanf() can scan the string easily */
  156. buffer->page[count] = 0;
  157. return error ? -EFAULT : count;
  158. }
  159. /**
  160. * flush_write_buffer - push buffer to kobject.
  161. * @dentry: dentry to the attribute
  162. * @buffer: data buffer for file.
  163. * @count: number of bytes
  164. *
  165. * Get the correct pointers for the kobject and the attribute we're
  166. * dealing with, then call the store() method for the attribute,
  167. * passing the buffer that we acquired in fill_write_buffer().
  168. */
  169. static int flush_write_buffer(struct dentry *dentry,
  170. struct sysfs_buffer *buffer, size_t count)
  171. {
  172. struct sysfs_dirent *attr_sd = dentry->d_fsdata;
  173. struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
  174. const struct sysfs_ops *ops = buffer->ops;
  175. int rc;
  176. /* need attr_sd for attr and ops, its parent for kobj */
  177. if (!sysfs_get_active(attr_sd))
  178. return -ENODEV;
  179. rc = ops->store(kobj, attr_sd->s_attr.attr, buffer->page, count);
  180. sysfs_put_active(attr_sd);
  181. return rc;
  182. }
  183. /**
  184. * sysfs_write_file - write an attribute.
  185. * @file: file pointer
  186. * @buf: data to write
  187. * @count: number of bytes
  188. * @ppos: starting offset
  189. *
  190. * Similar to sysfs_read_file(), though working in the opposite direction.
  191. * We allocate and fill the data from the user in fill_write_buffer(),
  192. * then push it to the kobject in flush_write_buffer().
  193. * There is no easy way for us to know if userspace is only doing a partial
  194. * write, so we don't support them. We expect the entire buffer to come
  195. * on the first write.
  196. * Hint: if you're writing a value, first read the file, modify only the
  197. * the value you're changing, then write entire buffer back.
  198. */
  199. static ssize_t sysfs_write_file(struct file *file, const char __user *buf,
  200. size_t count, loff_t *ppos)
  201. {
  202. struct sysfs_buffer *buffer = file->private_data;
  203. ssize_t len;
  204. mutex_lock(&buffer->mutex);
  205. len = fill_write_buffer(buffer, buf, count);
  206. if (len > 0)
  207. len = flush_write_buffer(file->f_path.dentry, buffer, len);
  208. if (len > 0)
  209. *ppos += len;
  210. mutex_unlock(&buffer->mutex);
  211. return len;
  212. }
  213. /**
  214. * sysfs_get_open_dirent - get or create sysfs_open_dirent
  215. * @sd: target sysfs_dirent
  216. * @buffer: sysfs_buffer for this instance of open
  217. *
  218. * If @sd->s_attr.open exists, increment its reference count;
  219. * otherwise, create one. @buffer is chained to the buffers
  220. * list.
  221. *
  222. * LOCKING:
  223. * Kernel thread context (may sleep).
  224. *
  225. * RETURNS:
  226. * 0 on success, -errno on failure.
  227. */
  228. static int sysfs_get_open_dirent(struct sysfs_dirent *sd,
  229. struct sysfs_buffer *buffer)
  230. {
  231. struct sysfs_open_dirent *od, *new_od = NULL;
  232. retry:
  233. spin_lock_irq(&sysfs_open_dirent_lock);
  234. if (!sd->s_attr.open && new_od) {
  235. sd->s_attr.open = new_od;
  236. new_od = NULL;
  237. }
  238. od = sd->s_attr.open;
  239. if (od) {
  240. atomic_inc(&od->refcnt);
  241. list_add_tail(&buffer->list, &od->buffers);
  242. }
  243. spin_unlock_irq(&sysfs_open_dirent_lock);
  244. if (od) {
  245. kfree(new_od);
  246. return 0;
  247. }
  248. /* not there, initialize a new one and retry */
  249. new_od = kmalloc(sizeof(*new_od), GFP_KERNEL);
  250. if (!new_od)
  251. return -ENOMEM;
  252. atomic_set(&new_od->refcnt, 0);
  253. atomic_set(&new_od->event, 1);
  254. init_waitqueue_head(&new_od->poll);
  255. INIT_LIST_HEAD(&new_od->buffers);
  256. goto retry;
  257. }
  258. /**
  259. * sysfs_put_open_dirent - put sysfs_open_dirent
  260. * @sd: target sysfs_dirent
  261. * @buffer: associated sysfs_buffer
  262. *
  263. * Put @sd->s_attr.open and unlink @buffer from the buffers list.
  264. * If reference count reaches zero, disassociate and free it.
  265. *
  266. * LOCKING:
  267. * None.
  268. */
  269. static void sysfs_put_open_dirent(struct sysfs_dirent *sd,
  270. struct sysfs_buffer *buffer)
  271. {
  272. struct sysfs_open_dirent *od = sd->s_attr.open;
  273. unsigned long flags;
  274. spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
  275. list_del(&buffer->list);
  276. if (atomic_dec_and_test(&od->refcnt))
  277. sd->s_attr.open = NULL;
  278. else
  279. od = NULL;
  280. spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
  281. kfree(od);
  282. }
  283. static int sysfs_open_file(struct inode *inode, struct file *file)
  284. {
  285. struct sysfs_dirent *attr_sd = file->f_path.dentry->d_fsdata;
  286. struct kobject *kobj = attr_sd->s_parent->s_dir.kobj;
  287. struct sysfs_buffer *buffer;
  288. const struct sysfs_ops *ops;
  289. int error = -EACCES;
  290. /* need attr_sd for attr and ops, its parent for kobj */
  291. if (!sysfs_get_active(attr_sd))
  292. return -ENODEV;
  293. /* every kobject with an attribute needs a ktype assigned */
  294. if (kobj->ktype && kobj->ktype->sysfs_ops)
  295. ops = kobj->ktype->sysfs_ops;
  296. else {
  297. WARN(1, KERN_ERR
  298. "missing sysfs attribute operations for kobject: %s\n",
  299. kobject_name(kobj));
  300. goto err_out;
  301. }
  302. /* File needs write support.
  303. * The inode's perms must say it's ok,
  304. * and we must have a store method.
  305. */
  306. if (file->f_mode & FMODE_WRITE) {
  307. if (!(inode->i_mode & S_IWUGO) || !ops->store)
  308. goto err_out;
  309. }
  310. /* File needs read support.
  311. * The inode's perms must say it's ok, and we there
  312. * must be a show method for it.
  313. */
  314. if (file->f_mode & FMODE_READ) {
  315. if (!(inode->i_mode & S_IRUGO) || !ops->show)
  316. goto err_out;
  317. }
  318. /* No error? Great, allocate a buffer for the file, and store it
  319. * it in file->private_data for easy access.
  320. */
  321. error = -ENOMEM;
  322. buffer = kzalloc(sizeof(struct sysfs_buffer), GFP_KERNEL);
  323. if (!buffer)
  324. goto err_out;
  325. mutex_init(&buffer->mutex);
  326. buffer->needs_read_fill = 1;
  327. buffer->ops = ops;
  328. file->private_data = buffer;
  329. /* make sure we have open dirent struct */
  330. error = sysfs_get_open_dirent(attr_sd, buffer);
  331. if (error)
  332. goto err_free;
  333. /* open succeeded, put active references */
  334. sysfs_put_active(attr_sd);
  335. return 0;
  336. err_free:
  337. kfree(buffer);
  338. err_out:
  339. sysfs_put_active(attr_sd);
  340. return error;
  341. }
  342. static int sysfs_release(struct inode *inode, struct file *filp)
  343. {
  344. struct sysfs_dirent *sd = filp->f_path.dentry->d_fsdata;
  345. struct sysfs_buffer *buffer = filp->private_data;
  346. sysfs_put_open_dirent(sd, buffer);
  347. if (buffer->page)
  348. free_page((unsigned long)buffer->page);
  349. kfree(buffer);
  350. return 0;
  351. }
  352. /* Sysfs attribute files are pollable. The idea is that you read
  353. * the content and then you use 'poll' or 'select' to wait for
  354. * the content to change. When the content changes (assuming the
  355. * manager for the kobject supports notification), poll will
  356. * return POLLERR|POLLPRI, and select will return the fd whether
  357. * it is waiting for read, write, or exceptions.
  358. * Once poll/select indicates that the value has changed, you
  359. * need to close and re-open the file, or seek to 0 and read again.
  360. * Reminder: this only works for attributes which actively support
  361. * it, and it is not possible to test an attribute from userspace
  362. * to see if it supports poll (Neither 'poll' nor 'select' return
  363. * an appropriate error code). When in doubt, set a suitable timeout value.
  364. */
  365. static unsigned int sysfs_poll(struct file *filp, poll_table *wait)
  366. {
  367. struct sysfs_buffer *buffer = filp->private_data;
  368. struct sysfs_dirent *attr_sd = filp->f_path.dentry->d_fsdata;
  369. struct sysfs_open_dirent *od = attr_sd->s_attr.open;
  370. /* need parent for the kobj, grab both */
  371. if (!sysfs_get_active(attr_sd))
  372. goto trigger;
  373. poll_wait(filp, &od->poll, wait);
  374. sysfs_put_active(attr_sd);
  375. if (buffer->event != atomic_read(&od->event))
  376. goto trigger;
  377. return DEFAULT_POLLMASK;
  378. trigger:
  379. buffer->needs_read_fill = 1;
  380. return DEFAULT_POLLMASK|POLLERR|POLLPRI;
  381. }
  382. void sysfs_notify_dirent(struct sysfs_dirent *sd)
  383. {
  384. struct sysfs_open_dirent *od;
  385. unsigned long flags;
  386. spin_lock_irqsave(&sysfs_open_dirent_lock, flags);
  387. if (!WARN_ON(sysfs_type(sd) != SYSFS_KOBJ_ATTR)) {
  388. od = sd->s_attr.open;
  389. if (od) {
  390. atomic_inc(&od->event);
  391. wake_up_interruptible(&od->poll);
  392. }
  393. }
  394. spin_unlock_irqrestore(&sysfs_open_dirent_lock, flags);
  395. }
  396. EXPORT_SYMBOL_GPL(sysfs_notify_dirent);
  397. void sysfs_notify(struct kobject *k, const char *dir, const char *attr)
  398. {
  399. struct sysfs_dirent *sd = k->sd;
  400. mutex_lock(&sysfs_mutex);
  401. if (sd && dir)
  402. sd = sysfs_find_dirent(sd, NULL, dir);
  403. if (sd && attr)
  404. sd = sysfs_find_dirent(sd, NULL, attr);
  405. if (sd)
  406. sysfs_notify_dirent(sd);
  407. mutex_unlock(&sysfs_mutex);
  408. }
  409. EXPORT_SYMBOL_GPL(sysfs_notify);
  410. const struct file_operations sysfs_file_operations = {
  411. .read = sysfs_read_file,
  412. .write = sysfs_write_file,
  413. .llseek = generic_file_llseek,
  414. .open = sysfs_open_file,
  415. .release = sysfs_release,
  416. .poll = sysfs_poll,
  417. };
  418. static int sysfs_attr_ns(struct kobject *kobj, const struct attribute *attr,
  419. const void **pns)
  420. {
  421. struct sysfs_dirent *dir_sd = kobj->sd;
  422. const struct sysfs_ops *ops;
  423. const void *ns = NULL;
  424. int err;
  425. if (!dir_sd) {
  426. WARN(1, KERN_ERR "sysfs: kobject %s without dirent\n",
  427. kobject_name(kobj));
  428. return -ENOENT;
  429. }
  430. err = 0;
  431. if (!sysfs_ns_type(dir_sd))
  432. goto out;
  433. err = -EINVAL;
  434. if (!kobj->ktype)
  435. goto out;
  436. ops = kobj->ktype->sysfs_ops;
  437. if (!ops)
  438. goto out;
  439. if (!ops->namespace)
  440. goto out;
  441. err = 0;
  442. ns = ops->namespace(kobj, attr);
  443. out:
  444. if (err) {
  445. WARN(1, KERN_ERR
  446. "missing sysfs namespace attribute operation for kobject: %s\n",
  447. kobject_name(kobj));
  448. }
  449. *pns = ns;
  450. return err;
  451. }
  452. int sysfs_add_file_mode(struct sysfs_dirent *dir_sd,
  453. const struct attribute *attr, int type, umode_t amode)
  454. {
  455. umode_t mode = (amode & S_IALLUGO) | S_IFREG;
  456. struct sysfs_addrm_cxt acxt;
  457. struct sysfs_dirent *sd;
  458. const void *ns;
  459. int rc;
  460. rc = sysfs_attr_ns(dir_sd->s_dir.kobj, attr, &ns);
  461. if (rc)
  462. return rc;
  463. sd = sysfs_new_dirent(attr->name, mode, type);
  464. if (!sd)
  465. return -ENOMEM;
  466. sd->s_ns = ns;
  467. sd->s_attr.attr = (void *)attr;
  468. sysfs_dirent_init_lockdep(sd);
  469. sysfs_addrm_start(&acxt, dir_sd);
  470. rc = sysfs_add_one(&acxt, sd);
  471. sysfs_addrm_finish(&acxt);
  472. if (rc)
  473. sysfs_put(sd);
  474. return rc;
  475. }
  476. int sysfs_add_file(struct sysfs_dirent *dir_sd, const struct attribute *attr,
  477. int type)
  478. {
  479. return sysfs_add_file_mode(dir_sd, attr, type, attr->mode);
  480. }
  481. /**
  482. * sysfs_create_file - create an attribute file for an object.
  483. * @kobj: object we're creating for.
  484. * @attr: attribute descriptor.
  485. */
  486. int sysfs_create_file(struct kobject *kobj, const struct attribute *attr)
  487. {
  488. BUG_ON(!kobj || !kobj->sd || !attr);
  489. return sysfs_add_file(kobj->sd, attr, SYSFS_KOBJ_ATTR);
  490. }
  491. EXPORT_SYMBOL_GPL(sysfs_create_file);
  492. int sysfs_create_files(struct kobject *kobj, const struct attribute **ptr)
  493. {
  494. int err = 0;
  495. int i;
  496. for (i = 0; ptr[i] && !err; i++)
  497. err = sysfs_create_file(kobj, ptr[i]);
  498. if (err)
  499. while (--i >= 0)
  500. sysfs_remove_file(kobj, ptr[i]);
  501. return err;
  502. }
  503. EXPORT_SYMBOL_GPL(sysfs_create_files);
  504. /**
  505. * sysfs_add_file_to_group - add an attribute file to a pre-existing group.
  506. * @kobj: object we're acting for.
  507. * @attr: attribute descriptor.
  508. * @group: group name.
  509. */
  510. int sysfs_add_file_to_group(struct kobject *kobj,
  511. const struct attribute *attr, const char *group)
  512. {
  513. struct sysfs_dirent *dir_sd;
  514. int error;
  515. if (group)
  516. dir_sd = sysfs_get_dirent(kobj->sd, NULL, group);
  517. else
  518. dir_sd = sysfs_get(kobj->sd);
  519. if (!dir_sd)
  520. return -ENOENT;
  521. error = sysfs_add_file(dir_sd, attr, SYSFS_KOBJ_ATTR);
  522. sysfs_put(dir_sd);
  523. return error;
  524. }
  525. EXPORT_SYMBOL_GPL(sysfs_add_file_to_group);
  526. /**
  527. * sysfs_chmod_file - update the modified mode value on an object attribute.
  528. * @kobj: object we're acting for.
  529. * @attr: attribute descriptor.
  530. * @mode: file permissions.
  531. *
  532. */
  533. int sysfs_chmod_file(struct kobject *kobj, const struct attribute *attr,
  534. umode_t mode)
  535. {
  536. struct sysfs_dirent *sd;
  537. struct iattr newattrs;
  538. const void *ns;
  539. int rc;
  540. rc = sysfs_attr_ns(kobj, attr, &ns);
  541. if (rc)
  542. return rc;
  543. mutex_lock(&sysfs_mutex);
  544. rc = -ENOENT;
  545. sd = sysfs_find_dirent(kobj->sd, ns, attr->name);
  546. if (!sd)
  547. goto out;
  548. newattrs.ia_mode = (mode & S_IALLUGO) | (sd->s_mode & ~S_IALLUGO);
  549. newattrs.ia_valid = ATTR_MODE;
  550. rc = sysfs_sd_setattr(sd, &newattrs);
  551. out:
  552. mutex_unlock(&sysfs_mutex);
  553. return rc;
  554. }
  555. EXPORT_SYMBOL_GPL(sysfs_chmod_file);
  556. /**
  557. * sysfs_remove_file - remove an object attribute.
  558. * @kobj: object we're acting for.
  559. * @attr: attribute descriptor.
  560. *
  561. * Hash the attribute name and kill the victim.
  562. */
  563. void sysfs_remove_file(struct kobject *kobj, const struct attribute *attr)
  564. {
  565. const void *ns;
  566. if (sysfs_attr_ns(kobj, attr, &ns))
  567. return;
  568. sysfs_hash_and_remove(kobj->sd, ns, attr->name);
  569. }
  570. EXPORT_SYMBOL_GPL(sysfs_remove_file);
  571. void sysfs_remove_files(struct kobject *kobj, const struct attribute **ptr)
  572. {
  573. int i;
  574. for (i = 0; ptr[i]; i++)
  575. sysfs_remove_file(kobj, ptr[i]);
  576. }
  577. EXPORT_SYMBOL_GPL(sysfs_remove_files);
  578. /**
  579. * sysfs_remove_file_from_group - remove an attribute file from a group.
  580. * @kobj: object we're acting for.
  581. * @attr: attribute descriptor.
  582. * @group: group name.
  583. */
  584. void sysfs_remove_file_from_group(struct kobject *kobj,
  585. const struct attribute *attr, const char *group)
  586. {
  587. struct sysfs_dirent *dir_sd;
  588. if (group)
  589. dir_sd = sysfs_get_dirent(kobj->sd, NULL, group);
  590. else
  591. dir_sd = sysfs_get(kobj->sd);
  592. if (dir_sd) {
  593. sysfs_hash_and_remove(dir_sd, NULL, attr->name);
  594. sysfs_put(dir_sd);
  595. }
  596. }
  597. EXPORT_SYMBOL_GPL(sysfs_remove_file_from_group);
  598. struct sysfs_schedule_callback_struct {
  599. struct list_head workq_list;
  600. struct kobject *kobj;
  601. void (*func)(void *);
  602. void *data;
  603. struct module *owner;
  604. struct work_struct work;
  605. };
  606. static struct workqueue_struct *sysfs_workqueue;
  607. static DEFINE_MUTEX(sysfs_workq_mutex);
  608. static LIST_HEAD(sysfs_workq);
  609. static void sysfs_schedule_callback_work(struct work_struct *work)
  610. {
  611. struct sysfs_schedule_callback_struct *ss = container_of(work,
  612. struct sysfs_schedule_callback_struct, work);
  613. (ss->func)(ss->data);
  614. kobject_put(ss->kobj);
  615. module_put(ss->owner);
  616. mutex_lock(&sysfs_workq_mutex);
  617. list_del(&ss->workq_list);
  618. mutex_unlock(&sysfs_workq_mutex);
  619. kfree(ss);
  620. }
  621. /**
  622. * sysfs_schedule_callback - helper to schedule a callback for a kobject
  623. * @kobj: object we're acting for.
  624. * @func: callback function to invoke later.
  625. * @data: argument to pass to @func.
  626. * @owner: module owning the callback code
  627. *
  628. * sysfs attribute methods must not unregister themselves or their parent
  629. * kobject (which would amount to the same thing). Attempts to do so will
  630. * deadlock, since unregistration is mutually exclusive with driver
  631. * callbacks.
  632. *
  633. * Instead methods can call this routine, which will attempt to allocate
  634. * and schedule a workqueue request to call back @func with @data as its
  635. * argument in the workqueue's process context. @kobj will be pinned
  636. * until @func returns.
  637. *
  638. * Returns 0 if the request was submitted, -ENOMEM if storage could not
  639. * be allocated, -ENODEV if a reference to @owner isn't available,
  640. * -EAGAIN if a callback has already been scheduled for @kobj.
  641. */
  642. int sysfs_schedule_callback(struct kobject *kobj, void (*func)(void *),
  643. void *data, struct module *owner)
  644. {
  645. struct sysfs_schedule_callback_struct *ss, *tmp;
  646. if (!try_module_get(owner))
  647. return -ENODEV;
  648. mutex_lock(&sysfs_workq_mutex);
  649. list_for_each_entry_safe(ss, tmp, &sysfs_workq, workq_list)
  650. if (ss->kobj == kobj) {
  651. module_put(owner);
  652. mutex_unlock(&sysfs_workq_mutex);
  653. return -EAGAIN;
  654. }
  655. mutex_unlock(&sysfs_workq_mutex);
  656. if (sysfs_workqueue == NULL) {
  657. sysfs_workqueue = create_singlethread_workqueue("sysfsd");
  658. if (sysfs_workqueue == NULL) {
  659. module_put(owner);
  660. return -ENOMEM;
  661. }
  662. }
  663. ss = kmalloc(sizeof(*ss), GFP_KERNEL);
  664. if (!ss) {
  665. module_put(owner);
  666. return -ENOMEM;
  667. }
  668. kobject_get(kobj);
  669. ss->kobj = kobj;
  670. ss->func = func;
  671. ss->data = data;
  672. ss->owner = owner;
  673. INIT_WORK(&ss->work, sysfs_schedule_callback_work);
  674. INIT_LIST_HEAD(&ss->workq_list);
  675. mutex_lock(&sysfs_workq_mutex);
  676. list_add_tail(&ss->workq_list, &sysfs_workq);
  677. mutex_unlock(&sysfs_workq_mutex);
  678. queue_work(sysfs_workqueue, &ss->work);
  679. return 0;
  680. }
  681. EXPORT_SYMBOL_GPL(sysfs_schedule_callback);