2 * proc/fs/generic.c --- generic routines for the proc-fs
4 * This file contains generic proc-fs routines for handling
5 * directories and files.
7 * Copyright (C) 1991, 1992 Linus Torvalds.
8 * Copyright (C) 1997 Theodore Ts'o
11 #include <linux/errno.h>
12 #include <linux/time.h>
13 #include <linux/proc_fs.h>
14 #include <linux/stat.h>
15 #include <linux/module.h>
16 #include <linux/mount.h>
17 #include <linux/init.h>
18 #include <linux/idr.h>
19 #include <linux/namei.h>
20 #include <linux/bitops.h>
21 #include <linux/spinlock.h>
22 #include <linux/completion.h>
23 #include <asm/uaccess.h>
27 DEFINE_SPINLOCK(proc_subdir_lock);
29 static int proc_match(int len, const char *name, struct proc_dir_entry *de)
31 if (de->namelen != len)
33 return !memcmp(name, de->name, len);
36 /* buffer size is one page but our output routines use some slack for overruns */
37 #define PROC_BLOCK_SIZE (PAGE_SIZE - 1024)
40 __proc_file_read(struct file *file, char __user *buf, size_t nbytes,
43 struct inode * inode = file->f_path.dentry->d_inode;
49 struct proc_dir_entry * dp;
50 unsigned long long pos;
53 * Gaah, please just use "seq_file" instead. The legacy /proc
54 * interfaces cut loff_t down to off_t for reads, and ignore
55 * the offset entirely for writes..
58 if (pos > MAX_NON_LFS)
60 if (nbytes > MAX_NON_LFS - pos)
61 nbytes = MAX_NON_LFS - pos;
64 if (!(page = (char*) __get_free_page(GFP_TEMPORARY)))
67 while ((nbytes > 0) && !eof) {
68 count = min_t(size_t, PROC_BLOCK_SIZE, nbytes);
73 * How to be a proc read function
74 * ------------------------------
76 * int f(char *buffer, char **start, off_t offset,
77 * int count, int *peof, void *dat)
79 * Assume that the buffer is "count" bytes in size.
81 * If you know you have supplied all the data you
84 * You have three ways to return data:
85 * 0) Leave *start = NULL. (This is the default.)
86 * Put the data of the requested offset at that
87 * offset within the buffer. Return the number (n)
88 * of bytes there are from the beginning of the
89 * buffer up to the last byte of data. If the
90 * number of supplied bytes (= n - offset) is
91 * greater than zero and you didn't signal eof
92 * and the reader is prepared to take more data
93 * you will be called again with the requested
94 * offset advanced by the number of bytes
95 * absorbed. This interface is useful for files
96 * no larger than the buffer.
97 * 1) Set *start = an unsigned long value less than
98 * the buffer address but greater than zero.
99 * Put the data of the requested offset at the
100 * beginning of the buffer. Return the number of
101 * bytes of data placed there. If this number is
102 * greater than zero and you didn't signal eof
103 * and the reader is prepared to take more data
104 * you will be called again with the requested
105 * offset advanced by *start. This interface is
106 * useful when you have a large file consisting
107 * of a series of blocks which you want to count
108 * and return as wholes.
109 * (Hack by Paul.Russell@rustcorp.com.au)
110 * 2) Set *start = an address within the buffer.
111 * Put the data of the requested offset at *start.
112 * Return the number of bytes of data placed there.
113 * If this number is greater than zero and you
114 * didn't signal eof and the reader is prepared to
115 * take more data you will be called again with the
116 * requested offset advanced by the number of bytes
119 n = dp->read_proc(page, &start, *ppos,
120 count, &eof, dp->data);
124 if (n == 0) /* end of file */
126 if (n < 0) { /* error */
135 "proc_file_read: Apparent buffer overflow!\n");
143 start = page + *ppos;
144 } else if (start < page) {
147 "proc_file_read: Apparent buffer overflow!\n");
152 * Don't reduce n because doing so might
153 * cut off part of a data block.
156 "proc_file_read: Read count exceeded\n");
158 } else /* start >= page */ {
159 unsigned long startoff = (unsigned long)(start - page);
160 if (n > (PAGE_SIZE - startoff)) {
162 "proc_file_read: Apparent buffer overflow!\n");
163 n = PAGE_SIZE - startoff;
169 n -= copy_to_user(buf, start < page ? page : start, n);
176 *ppos += start < page ? (unsigned long)start : n;
181 free_page((unsigned long) page);
186 proc_file_read(struct file *file, char __user *buf, size_t nbytes,
189 struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
192 spin_lock(&pde->pde_unload_lock);
193 if (!pde->proc_fops) {
194 spin_unlock(&pde->pde_unload_lock);
198 spin_unlock(&pde->pde_unload_lock);
200 rv = __proc_file_read(file, buf, nbytes, ppos);
207 proc_file_write(struct file *file, const char __user *buffer,
208 size_t count, loff_t *ppos)
210 struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
213 if (pde->write_proc) {
214 spin_lock(&pde->pde_unload_lock);
215 if (!pde->proc_fops) {
216 spin_unlock(&pde->pde_unload_lock);
220 spin_unlock(&pde->pde_unload_lock);
222 /* FIXME: does this routine need ppos? probably... */
223 rv = pde->write_proc(file, buffer, count, pde->data);
231 proc_file_lseek(struct file *file, loff_t offset, int orig)
233 loff_t retval = -EINVAL;
236 offset += file->f_pos;
239 if (offset < 0 || offset > MAX_NON_LFS)
241 file->f_pos = retval = offset;
246 static const struct file_operations proc_file_operations = {
247 .llseek = proc_file_lseek,
248 .read = proc_file_read,
249 .write = proc_file_write,
252 static int proc_notify_change(struct dentry *dentry, struct iattr *iattr)
254 struct inode *inode = dentry->d_inode;
255 struct proc_dir_entry *de = PDE(inode);
258 error = inode_change_ok(inode, iattr);
262 error = inode_setattr(inode, iattr);
266 de->uid = inode->i_uid;
267 de->gid = inode->i_gid;
268 de->mode = inode->i_mode;
273 static int proc_getattr(struct vfsmount *mnt, struct dentry *dentry,
276 struct inode *inode = dentry->d_inode;
277 struct proc_dir_entry *de = PROC_I(inode)->pde;
279 inode->i_nlink = de->nlink;
281 generic_fillattr(inode, stat);
285 static const struct inode_operations proc_file_inode_operations = {
286 .setattr = proc_notify_change,
290 * This function parses a name such as "tty/driver/serial", and
291 * returns the struct proc_dir_entry for "/proc/tty/driver", and
292 * returns "serial" in residual.
294 static int __xlate_proc_name(const char *name, struct proc_dir_entry **ret,
295 const char **residual)
297 const char *cp = name, *next;
298 struct proc_dir_entry *de;
306 next = strchr(cp, '/');
311 for (de = de->subdir; de ; de = de->next) {
312 if (proc_match(len, cp, de))
316 WARN(1, "name '%s'\n", name);
326 static int xlate_proc_name(const char *name, struct proc_dir_entry **ret,
327 const char **residual)
331 spin_lock(&proc_subdir_lock);
332 rv = __xlate_proc_name(name, ret, residual);
333 spin_unlock(&proc_subdir_lock);
337 static DEFINE_IDA(proc_inum_ida);
338 static DEFINE_SPINLOCK(proc_inum_lock); /* protects the above */
340 #define PROC_DYNAMIC_FIRST 0xF0000000U
343 * Return an inode number between PROC_DYNAMIC_FIRST and
344 * 0xffffffff, or zero on failure.
346 * Current inode allocations in the proc-fs (hex-numbers):
349 * 00000001-00000fff static entries (goners)
352 * 00001000-00001fff unused
353 * 0001xxxx-7fffxxxx pid-dir entries for pid 1-7fff
354 * 80000000-efffffff unused
355 * f0000000-ffffffff dynamic entries
358 * Once we split the thing into several virtual filesystems,
359 * we will get rid of magical ranges (and this comment, BTW).
361 static unsigned int get_inode_number(void)
367 if (ida_pre_get(&proc_inum_ida, GFP_KERNEL) == 0)
370 spin_lock(&proc_inum_lock);
371 error = ida_get_new(&proc_inum_ida, &i);
372 spin_unlock(&proc_inum_lock);
373 if (error == -EAGAIN)
378 if (i > UINT_MAX - PROC_DYNAMIC_FIRST) {
379 spin_lock(&proc_inum_lock);
380 ida_remove(&proc_inum_ida, i);
381 spin_unlock(&proc_inum_lock);
384 return PROC_DYNAMIC_FIRST + i;
387 static void release_inode_number(unsigned int inum)
389 spin_lock(&proc_inum_lock);
390 ida_remove(&proc_inum_ida, inum - PROC_DYNAMIC_FIRST);
391 spin_unlock(&proc_inum_lock);
394 static void *proc_follow_link(struct dentry *dentry, struct nameidata *nd)
396 nd_set_link(nd, PDE(dentry->d_inode)->data);
400 static const struct inode_operations proc_link_inode_operations = {
401 .readlink = generic_readlink,
402 .follow_link = proc_follow_link,
406 * As some entries in /proc are volatile, we want to
407 * get rid of unused dentries. This could be made
408 * smarter: we could keep a "volatile" flag in the
409 * inode to indicate which ones to keep.
411 static int proc_delete_dentry(struct dentry * dentry)
416 static const struct dentry_operations proc_dentry_operations =
418 .d_delete = proc_delete_dentry,
422 * Don't create negative dentries here, return -ENOENT by hand
425 struct dentry *proc_lookup_de(struct proc_dir_entry *de, struct inode *dir,
426 struct dentry *dentry)
428 struct inode *inode = NULL;
431 spin_lock(&proc_subdir_lock);
432 for (de = de->subdir; de ; de = de->next) {
433 if (de->namelen != dentry->d_name.len)
435 if (!memcmp(dentry->d_name.name, de->name, de->namelen)) {
440 spin_unlock(&proc_subdir_lock);
442 inode = proc_get_inode(dir->i_sb, ino, de);
446 spin_unlock(&proc_subdir_lock);
450 dentry->d_op = &proc_dentry_operations;
451 d_add(dentry, inode);
456 return ERR_PTR(error);
459 struct dentry *proc_lookup(struct inode *dir, struct dentry *dentry,
460 struct nameidata *nd)
462 return proc_lookup_de(PDE(dir), dir, dentry);
466 * This returns non-zero if at EOF, so that the /proc
467 * root directory can use this and check if it should
468 * continue with the <pid> entries..
470 * Note that the VFS-layer doesn't care about the return
471 * value of the readdir() call, as long as it's non-negative
474 int proc_readdir_de(struct proc_dir_entry *de, struct file *filp, void *dirent,
479 struct inode *inode = filp->f_path.dentry->d_inode;
486 if (filldir(dirent, ".", 1, i, ino, DT_DIR) < 0)
492 if (filldir(dirent, "..", 2, i,
493 parent_ino(filp->f_path.dentry),
500 spin_lock(&proc_subdir_lock);
506 spin_unlock(&proc_subdir_lock);
516 struct proc_dir_entry *next;
518 /* filldir passes info to user space */
520 spin_unlock(&proc_subdir_lock);
521 if (filldir(dirent, de->name, de->namelen, filp->f_pos,
522 de->low_ino, de->mode >> 12) < 0) {
526 spin_lock(&proc_subdir_lock);
532 spin_unlock(&proc_subdir_lock);
539 int proc_readdir(struct file *filp, void *dirent, filldir_t filldir)
541 struct inode *inode = filp->f_path.dentry->d_inode;
543 return proc_readdir_de(PDE(inode), filp, dirent, filldir);
547 * These are the generic /proc directory operations. They
548 * use the in-memory "struct proc_dir_entry" tree to parse
549 * the /proc directory.
551 static const struct file_operations proc_dir_operations = {
552 .llseek = generic_file_llseek,
553 .read = generic_read_dir,
554 .readdir = proc_readdir,
558 * proc directories can do almost nothing..
560 static const struct inode_operations proc_dir_inode_operations = {
561 .lookup = proc_lookup,
562 .getattr = proc_getattr,
563 .setattr = proc_notify_change,
566 static int proc_register(struct proc_dir_entry * dir, struct proc_dir_entry * dp)
569 struct proc_dir_entry *tmp;
571 i = get_inode_number();
576 if (S_ISDIR(dp->mode)) {
577 if (dp->proc_iops == NULL) {
578 dp->proc_fops = &proc_dir_operations;
579 dp->proc_iops = &proc_dir_inode_operations;
582 } else if (S_ISLNK(dp->mode)) {
583 if (dp->proc_iops == NULL)
584 dp->proc_iops = &proc_link_inode_operations;
585 } else if (S_ISREG(dp->mode)) {
586 if (dp->proc_fops == NULL)
587 dp->proc_fops = &proc_file_operations;
588 if (dp->proc_iops == NULL)
589 dp->proc_iops = &proc_file_inode_operations;
592 spin_lock(&proc_subdir_lock);
594 for (tmp = dir->subdir; tmp; tmp = tmp->next)
595 if (strcmp(tmp->name, dp->name) == 0) {
596 WARN(1, KERN_WARNING "proc_dir_entry '%s/%s' already registered\n",
597 dir->name, dp->name);
601 dp->next = dir->subdir;
604 spin_unlock(&proc_subdir_lock);
609 static struct proc_dir_entry *__proc_create(struct proc_dir_entry **parent,
614 struct proc_dir_entry *ent = NULL;
615 const char *fn = name;
618 /* make sure name is valid */
619 if (!name || !strlen(name)) goto out;
621 if (xlate_proc_name(name, parent, &fn) != 0)
624 /* At this point there must not be any '/' characters beyond *fn */
630 ent = kmalloc(sizeof(struct proc_dir_entry) + len + 1, GFP_KERNEL);
633 memset(ent, 0, sizeof(struct proc_dir_entry));
634 memcpy(((char *) ent) + sizeof(struct proc_dir_entry), fn, len + 1);
635 ent->name = ((char *) ent) + sizeof(*ent);
639 atomic_set(&ent->count, 1);
641 spin_lock_init(&ent->pde_unload_lock);
642 ent->pde_unload_completion = NULL;
643 INIT_LIST_HEAD(&ent->pde_openers);
648 struct proc_dir_entry *proc_symlink(const char *name,
649 struct proc_dir_entry *parent, const char *dest)
651 struct proc_dir_entry *ent;
653 ent = __proc_create(&parent, name,
654 (S_IFLNK | S_IRUGO | S_IWUGO | S_IXUGO),1);
657 ent->data = kmalloc((ent->size=strlen(dest))+1, GFP_KERNEL);
659 strcpy((char*)ent->data,dest);
660 if (proc_register(parent, ent) < 0) {
672 EXPORT_SYMBOL(proc_symlink);
674 struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
675 struct proc_dir_entry *parent)
677 struct proc_dir_entry *ent;
679 ent = __proc_create(&parent, name, S_IFDIR | mode, 2);
681 if (proc_register(parent, ent) < 0) {
689 struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
690 struct proc_dir_entry *parent)
692 struct proc_dir_entry *ent;
694 ent = __proc_create(&parent, name, S_IFDIR | S_IRUGO | S_IXUGO, 2);
697 if (proc_register(parent, ent) < 0) {
704 EXPORT_SYMBOL_GPL(proc_net_mkdir);
706 struct proc_dir_entry *proc_mkdir(const char *name,
707 struct proc_dir_entry *parent)
709 return proc_mkdir_mode(name, S_IRUGO | S_IXUGO, parent);
711 EXPORT_SYMBOL(proc_mkdir);
713 struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
714 struct proc_dir_entry *parent)
716 struct proc_dir_entry *ent;
720 if ((mode & S_IALLUGO) == 0)
721 mode |= S_IRUGO | S_IXUGO;
724 if ((mode & S_IFMT) == 0)
726 if ((mode & S_IALLUGO) == 0)
731 ent = __proc_create(&parent, name, mode, nlink);
733 if (proc_register(parent, ent) < 0) {
740 EXPORT_SYMBOL(create_proc_entry);
742 struct proc_dir_entry *proc_create_data(const char *name, mode_t mode,
743 struct proc_dir_entry *parent,
744 const struct file_operations *proc_fops,
747 struct proc_dir_entry *pde;
751 if ((mode & S_IALLUGO) == 0)
752 mode |= S_IRUGO | S_IXUGO;
755 if ((mode & S_IFMT) == 0)
757 if ((mode & S_IALLUGO) == 0)
762 pde = __proc_create(&parent, name, mode, nlink);
765 pde->proc_fops = proc_fops;
767 if (proc_register(parent, pde) < 0)
775 EXPORT_SYMBOL(proc_create_data);
777 static void free_proc_entry(struct proc_dir_entry *de)
779 unsigned int ino = de->low_ino;
781 if (ino < PROC_DYNAMIC_FIRST)
784 release_inode_number(ino);
786 if (S_ISLNK(de->mode))
791 void pde_put(struct proc_dir_entry *pde)
793 if (atomic_dec_and_test(&pde->count))
794 free_proc_entry(pde);
798 * Remove a /proc entry and free it if it's not currently in use.
800 void remove_proc_entry(const char *name, struct proc_dir_entry *parent)
802 struct proc_dir_entry **p;
803 struct proc_dir_entry *de = NULL;
804 const char *fn = name;
807 spin_lock(&proc_subdir_lock);
808 if (__xlate_proc_name(name, &parent, &fn) != 0) {
809 spin_unlock(&proc_subdir_lock);
814 for (p = &parent->subdir; *p; p=&(*p)->next ) {
815 if (proc_match(len, fn, *p)) {
822 spin_unlock(&proc_subdir_lock);
824 WARN(1, "name '%s'\n", name);
828 spin_lock(&de->pde_unload_lock);
830 * Stop accepting new callers into module. If you're
831 * dynamically allocating ->proc_fops, save a pointer somewhere.
833 de->proc_fops = NULL;
834 /* Wait until all existing callers into module are done. */
835 if (de->pde_users > 0) {
836 DECLARE_COMPLETION_ONSTACK(c);
838 if (!de->pde_unload_completion)
839 de->pde_unload_completion = &c;
841 spin_unlock(&de->pde_unload_lock);
843 wait_for_completion(de->pde_unload_completion);
845 goto continue_removing;
847 spin_unlock(&de->pde_unload_lock);
850 spin_lock(&de->pde_unload_lock);
851 while (!list_empty(&de->pde_openers)) {
852 struct pde_opener *pdeo;
854 pdeo = list_first_entry(&de->pde_openers, struct pde_opener, lh);
856 spin_unlock(&de->pde_unload_lock);
857 pdeo->release(pdeo->inode, pdeo->file);
859 spin_lock(&de->pde_unload_lock);
861 spin_unlock(&de->pde_unload_lock);
863 if (S_ISDIR(de->mode))
866 WARN(de->subdir, KERN_WARNING "%s: removing non-empty directory "
867 "'%s/%s', leaking at least '%s'\n", __func__,
868 de->parent->name, de->name, de->subdir->name);
871 EXPORT_SYMBOL(remove_proc_entry);