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/slab.h>
17 #include <linux/mount.h>
18 #include <linux/init.h>
19 #include <linux/idr.h>
20 #include <linux/namei.h>
21 #include <linux/bitops.h>
22 #include <linux/spinlock.h>
23 #include <linux/completion.h>
24 #include <asm/uaccess.h>
28 DEFINE_SPINLOCK(proc_subdir_lock);
30 static int proc_match(int len, const char *name, struct proc_dir_entry *de)
32 if (de->namelen != len)
34 return !memcmp(name, de->name, len);
37 /* buffer size is one page but our output routines use some slack for overruns */
38 #define PROC_BLOCK_SIZE (PAGE_SIZE - 1024)
41 __proc_file_read(struct file *file, char __user *buf, size_t nbytes,
44 struct inode * inode = file->f_path.dentry->d_inode;
50 struct proc_dir_entry * dp;
51 unsigned long long pos;
54 * Gaah, please just use "seq_file" instead. The legacy /proc
55 * interfaces cut loff_t down to off_t for reads, and ignore
56 * the offset entirely for writes..
59 if (pos > MAX_NON_LFS)
61 if (nbytes > MAX_NON_LFS - pos)
62 nbytes = MAX_NON_LFS - pos;
65 if (!(page = (char*) __get_free_page(GFP_TEMPORARY)))
68 while ((nbytes > 0) && !eof) {
69 count = min_t(size_t, PROC_BLOCK_SIZE, nbytes);
74 * How to be a proc read function
75 * ------------------------------
77 * int f(char *buffer, char **start, off_t offset,
78 * int count, int *peof, void *dat)
80 * Assume that the buffer is "count" bytes in size.
82 * If you know you have supplied all the data you
85 * You have three ways to return data:
86 * 0) Leave *start = NULL. (This is the default.)
87 * Put the data of the requested offset at that
88 * offset within the buffer. Return the number (n)
89 * of bytes there are from the beginning of the
90 * buffer up to the last byte of data. If the
91 * number of supplied bytes (= n - offset) is
92 * greater than zero and you didn't signal eof
93 * and the reader is prepared to take more data
94 * you will be called again with the requested
95 * offset advanced by the number of bytes
96 * absorbed. This interface is useful for files
97 * no larger than the buffer.
98 * 1) Set *start = an unsigned long value less than
99 * the buffer address but greater than zero.
100 * Put the data of the requested offset at the
101 * beginning of the buffer. Return the number of
102 * bytes of data placed there. If this number is
103 * greater than zero and you didn't signal eof
104 * and the reader is prepared to take more data
105 * you will be called again with the requested
106 * offset advanced by *start. This interface is
107 * useful when you have a large file consisting
108 * of a series of blocks which you want to count
109 * and return as wholes.
111 * 2) Set *start = an address within the buffer.
112 * Put the data of the requested offset at *start.
113 * Return the number of bytes of data placed there.
114 * If this number is greater than zero and you
115 * didn't signal eof and the reader is prepared to
116 * take more data you will be called again with the
117 * requested offset advanced by the number of bytes
120 n = dp->read_proc(page, &start, *ppos,
121 count, &eof, dp->data);
125 if (n == 0) /* end of file */
127 if (n < 0) { /* error */
136 "proc_file_read: Apparent buffer overflow!\n");
144 start = page + *ppos;
145 } else if (start < page) {
148 "proc_file_read: Apparent buffer overflow!\n");
153 * Don't reduce n because doing so might
154 * cut off part of a data block.
157 "proc_file_read: Read count exceeded\n");
159 } else /* start >= page */ {
160 unsigned long startoff = (unsigned long)(start - page);
161 if (n > (PAGE_SIZE - startoff)) {
163 "proc_file_read: Apparent buffer overflow!\n");
164 n = PAGE_SIZE - startoff;
170 n -= copy_to_user(buf, start < page ? page : start, n);
177 *ppos += start < page ? (unsigned long)start : n;
182 free_page((unsigned long) page);
187 proc_file_read(struct file *file, char __user *buf, size_t nbytes,
190 struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
193 spin_lock(&pde->pde_unload_lock);
194 if (!pde->proc_fops) {
195 spin_unlock(&pde->pde_unload_lock);
199 spin_unlock(&pde->pde_unload_lock);
201 rv = __proc_file_read(file, buf, nbytes, ppos);
208 proc_file_write(struct file *file, const char __user *buffer,
209 size_t count, loff_t *ppos)
211 struct proc_dir_entry *pde = PDE(file->f_path.dentry->d_inode);
214 if (pde->write_proc) {
215 spin_lock(&pde->pde_unload_lock);
216 if (!pde->proc_fops) {
217 spin_unlock(&pde->pde_unload_lock);
221 spin_unlock(&pde->pde_unload_lock);
223 /* FIXME: does this routine need ppos? probably... */
224 rv = pde->write_proc(file, buffer, count, pde->data);
232 proc_file_lseek(struct file *file, loff_t offset, int orig)
234 loff_t retval = -EINVAL;
237 offset += file->f_pos;
240 if (offset < 0 || offset > MAX_NON_LFS)
242 file->f_pos = retval = offset;
247 static const struct file_operations proc_file_operations = {
248 .llseek = proc_file_lseek,
249 .read = proc_file_read,
250 .write = proc_file_write,
253 static int proc_notify_change(struct dentry *dentry, struct iattr *iattr)
255 struct inode *inode = dentry->d_inode;
256 struct proc_dir_entry *de = PDE(inode);
259 error = inode_change_ok(inode, iattr);
263 error = inode_setattr(inode, iattr);
267 de->uid = inode->i_uid;
268 de->gid = inode->i_gid;
269 de->mode = inode->i_mode;
274 static int proc_getattr(struct vfsmount *mnt, struct dentry *dentry,
277 struct inode *inode = dentry->d_inode;
278 struct proc_dir_entry *de = PROC_I(inode)->pde;
280 inode->i_nlink = de->nlink;
282 generic_fillattr(inode, stat);
286 static const struct inode_operations proc_file_inode_operations = {
287 .setattr = proc_notify_change,
291 * This function parses a name such as "tty/driver/serial", and
292 * returns the struct proc_dir_entry for "/proc/tty/driver", and
293 * returns "serial" in residual.
295 static int __xlate_proc_name(const char *name, struct proc_dir_entry **ret,
296 const char **residual)
298 const char *cp = name, *next;
299 struct proc_dir_entry *de;
307 next = strchr(cp, '/');
312 for (de = de->subdir; de ; de = de->next) {
313 if (proc_match(len, cp, de))
317 WARN(1, "name '%s'\n", name);
327 static int xlate_proc_name(const char *name, struct proc_dir_entry **ret,
328 const char **residual)
332 spin_lock(&proc_subdir_lock);
333 rv = __xlate_proc_name(name, ret, residual);
334 spin_unlock(&proc_subdir_lock);
338 static DEFINE_IDA(proc_inum_ida);
339 static DEFINE_SPINLOCK(proc_inum_lock); /* protects the above */
341 #define PROC_DYNAMIC_FIRST 0xF0000000U
344 * Return an inode number between PROC_DYNAMIC_FIRST and
345 * 0xffffffff, or zero on failure.
347 * Current inode allocations in the proc-fs (hex-numbers):
350 * 00000001-00000fff static entries (goners)
353 * 00001000-00001fff unused
354 * 0001xxxx-7fffxxxx pid-dir entries for pid 1-7fff
355 * 80000000-efffffff unused
356 * f0000000-ffffffff dynamic entries
359 * Once we split the thing into several virtual filesystems,
360 * we will get rid of magical ranges (and this comment, BTW).
362 static unsigned int get_inode_number(void)
368 if (ida_pre_get(&proc_inum_ida, GFP_KERNEL) == 0)
371 spin_lock(&proc_inum_lock);
372 error = ida_get_new(&proc_inum_ida, &i);
373 spin_unlock(&proc_inum_lock);
374 if (error == -EAGAIN)
379 if (i > UINT_MAX - PROC_DYNAMIC_FIRST) {
380 spin_lock(&proc_inum_lock);
381 ida_remove(&proc_inum_ida, i);
382 spin_unlock(&proc_inum_lock);
385 return PROC_DYNAMIC_FIRST + i;
388 static void release_inode_number(unsigned int inum)
390 spin_lock(&proc_inum_lock);
391 ida_remove(&proc_inum_ida, inum - PROC_DYNAMIC_FIRST);
392 spin_unlock(&proc_inum_lock);
395 static void *proc_follow_link(struct dentry *dentry, struct nameidata *nd)
397 nd_set_link(nd, PDE(dentry->d_inode)->data);
401 static const struct inode_operations proc_link_inode_operations = {
402 .readlink = generic_readlink,
403 .follow_link = proc_follow_link,
407 * As some entries in /proc are volatile, we want to
408 * get rid of unused dentries. This could be made
409 * smarter: we could keep a "volatile" flag in the
410 * inode to indicate which ones to keep.
412 static int proc_delete_dentry(struct dentry * dentry)
417 static const struct dentry_operations proc_dentry_operations =
419 .d_delete = proc_delete_dentry,
423 * Don't create negative dentries here, return -ENOENT by hand
426 struct dentry *proc_lookup_de(struct proc_dir_entry *de, struct inode *dir,
427 struct dentry *dentry)
429 struct inode *inode = NULL;
432 spin_lock(&proc_subdir_lock);
433 for (de = de->subdir; de ; de = de->next) {
434 if (de->namelen != dentry->d_name.len)
436 if (!memcmp(dentry->d_name.name, de->name, de->namelen)) {
441 spin_unlock(&proc_subdir_lock);
443 inode = proc_get_inode(dir->i_sb, ino, de);
447 spin_unlock(&proc_subdir_lock);
451 dentry->d_op = &proc_dentry_operations;
452 d_add(dentry, inode);
457 return ERR_PTR(error);
460 struct dentry *proc_lookup(struct inode *dir, struct dentry *dentry,
461 struct nameidata *nd)
463 return proc_lookup_de(PDE(dir), dir, dentry);
467 * This returns non-zero if at EOF, so that the /proc
468 * root directory can use this and check if it should
469 * continue with the <pid> entries..
471 * Note that the VFS-layer doesn't care about the return
472 * value of the readdir() call, as long as it's non-negative
475 int proc_readdir_de(struct proc_dir_entry *de, struct file *filp, void *dirent,
480 struct inode *inode = filp->f_path.dentry->d_inode;
487 if (filldir(dirent, ".", 1, i, ino, DT_DIR) < 0)
493 if (filldir(dirent, "..", 2, i,
494 parent_ino(filp->f_path.dentry),
501 spin_lock(&proc_subdir_lock);
507 spin_unlock(&proc_subdir_lock);
517 struct proc_dir_entry *next;
519 /* filldir passes info to user space */
521 spin_unlock(&proc_subdir_lock);
522 if (filldir(dirent, de->name, de->namelen, filp->f_pos,
523 de->low_ino, de->mode >> 12) < 0) {
527 spin_lock(&proc_subdir_lock);
533 spin_unlock(&proc_subdir_lock);
540 int proc_readdir(struct file *filp, void *dirent, filldir_t filldir)
542 struct inode *inode = filp->f_path.dentry->d_inode;
544 return proc_readdir_de(PDE(inode), filp, dirent, filldir);
548 * These are the generic /proc directory operations. They
549 * use the in-memory "struct proc_dir_entry" tree to parse
550 * the /proc directory.
552 static const struct file_operations proc_dir_operations = {
553 .llseek = generic_file_llseek,
554 .read = generic_read_dir,
555 .readdir = proc_readdir,
559 * proc directories can do almost nothing..
561 static const struct inode_operations proc_dir_inode_operations = {
562 .lookup = proc_lookup,
563 .getattr = proc_getattr,
564 .setattr = proc_notify_change,
567 static int proc_register(struct proc_dir_entry * dir, struct proc_dir_entry * dp)
570 struct proc_dir_entry *tmp;
572 i = get_inode_number();
577 if (S_ISDIR(dp->mode)) {
578 if (dp->proc_iops == NULL) {
579 dp->proc_fops = &proc_dir_operations;
580 dp->proc_iops = &proc_dir_inode_operations;
583 } else if (S_ISLNK(dp->mode)) {
584 if (dp->proc_iops == NULL)
585 dp->proc_iops = &proc_link_inode_operations;
586 } else if (S_ISREG(dp->mode)) {
587 if (dp->proc_fops == NULL)
588 dp->proc_fops = &proc_file_operations;
589 if (dp->proc_iops == NULL)
590 dp->proc_iops = &proc_file_inode_operations;
593 spin_lock(&proc_subdir_lock);
595 for (tmp = dir->subdir; tmp; tmp = tmp->next)
596 if (strcmp(tmp->name, dp->name) == 0) {
597 WARN(1, KERN_WARNING "proc_dir_entry '%s/%s' already registered\n",
598 dir->name, dp->name);
602 dp->next = dir->subdir;
605 spin_unlock(&proc_subdir_lock);
610 static struct proc_dir_entry *__proc_create(struct proc_dir_entry **parent,
615 struct proc_dir_entry *ent = NULL;
616 const char *fn = name;
619 /* make sure name is valid */
620 if (!name || !strlen(name)) goto out;
622 if (xlate_proc_name(name, parent, &fn) != 0)
625 /* At this point there must not be any '/' characters beyond *fn */
631 ent = kmalloc(sizeof(struct proc_dir_entry) + len + 1, GFP_KERNEL);
634 memset(ent, 0, sizeof(struct proc_dir_entry));
635 memcpy(((char *) ent) + sizeof(struct proc_dir_entry), fn, len + 1);
636 ent->name = ((char *) ent) + sizeof(*ent);
640 atomic_set(&ent->count, 1);
642 spin_lock_init(&ent->pde_unload_lock);
643 ent->pde_unload_completion = NULL;
644 INIT_LIST_HEAD(&ent->pde_openers);
649 struct proc_dir_entry *proc_symlink(const char *name,
650 struct proc_dir_entry *parent, const char *dest)
652 struct proc_dir_entry *ent;
654 ent = __proc_create(&parent, name,
655 (S_IFLNK | S_IRUGO | S_IWUGO | S_IXUGO),1);
658 ent->data = kmalloc((ent->size=strlen(dest))+1, GFP_KERNEL);
660 strcpy((char*)ent->data,dest);
661 if (proc_register(parent, ent) < 0) {
673 EXPORT_SYMBOL(proc_symlink);
675 struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
676 struct proc_dir_entry *parent)
678 struct proc_dir_entry *ent;
680 ent = __proc_create(&parent, name, S_IFDIR | mode, 2);
682 if (proc_register(parent, ent) < 0) {
690 struct proc_dir_entry *proc_net_mkdir(struct net *net, const char *name,
691 struct proc_dir_entry *parent)
693 struct proc_dir_entry *ent;
695 ent = __proc_create(&parent, name, S_IFDIR | S_IRUGO | S_IXUGO, 2);
698 if (proc_register(parent, ent) < 0) {
705 EXPORT_SYMBOL_GPL(proc_net_mkdir);
707 struct proc_dir_entry *proc_mkdir(const char *name,
708 struct proc_dir_entry *parent)
710 return proc_mkdir_mode(name, S_IRUGO | S_IXUGO, parent);
712 EXPORT_SYMBOL(proc_mkdir);
714 struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
715 struct proc_dir_entry *parent)
717 struct proc_dir_entry *ent;
721 if ((mode & S_IALLUGO) == 0)
722 mode |= S_IRUGO | S_IXUGO;
725 if ((mode & S_IFMT) == 0)
727 if ((mode & S_IALLUGO) == 0)
732 ent = __proc_create(&parent, name, mode, nlink);
734 if (proc_register(parent, ent) < 0) {
741 EXPORT_SYMBOL(create_proc_entry);
743 struct proc_dir_entry *proc_create_data(const char *name, mode_t mode,
744 struct proc_dir_entry *parent,
745 const struct file_operations *proc_fops,
748 struct proc_dir_entry *pde;
752 if ((mode & S_IALLUGO) == 0)
753 mode |= S_IRUGO | S_IXUGO;
756 if ((mode & S_IFMT) == 0)
758 if ((mode & S_IALLUGO) == 0)
763 pde = __proc_create(&parent, name, mode, nlink);
766 pde->proc_fops = proc_fops;
768 if (proc_register(parent, pde) < 0)
776 EXPORT_SYMBOL(proc_create_data);
778 static void free_proc_entry(struct proc_dir_entry *de)
780 unsigned int ino = de->low_ino;
782 if (ino < PROC_DYNAMIC_FIRST)
785 release_inode_number(ino);
787 if (S_ISLNK(de->mode))
792 void pde_put(struct proc_dir_entry *pde)
794 if (atomic_dec_and_test(&pde->count))
795 free_proc_entry(pde);
799 * Remove a /proc entry and free it if it's not currently in use.
801 void remove_proc_entry(const char *name, struct proc_dir_entry *parent)
803 struct proc_dir_entry **p;
804 struct proc_dir_entry *de = NULL;
805 const char *fn = name;
808 spin_lock(&proc_subdir_lock);
809 if (__xlate_proc_name(name, &parent, &fn) != 0) {
810 spin_unlock(&proc_subdir_lock);
815 for (p = &parent->subdir; *p; p=&(*p)->next ) {
816 if (proc_match(len, fn, *p)) {
823 spin_unlock(&proc_subdir_lock);
825 WARN(1, "name '%s'\n", name);
829 spin_lock(&de->pde_unload_lock);
831 * Stop accepting new callers into module. If you're
832 * dynamically allocating ->proc_fops, save a pointer somewhere.
834 de->proc_fops = NULL;
835 /* Wait until all existing callers into module are done. */
836 if (de->pde_users > 0) {
837 DECLARE_COMPLETION_ONSTACK(c);
839 if (!de->pde_unload_completion)
840 de->pde_unload_completion = &c;
842 spin_unlock(&de->pde_unload_lock);
844 wait_for_completion(de->pde_unload_completion);
846 goto continue_removing;
848 spin_unlock(&de->pde_unload_lock);
851 spin_lock(&de->pde_unload_lock);
852 while (!list_empty(&de->pde_openers)) {
853 struct pde_opener *pdeo;
855 pdeo = list_first_entry(&de->pde_openers, struct pde_opener, lh);
857 spin_unlock(&de->pde_unload_lock);
858 pdeo->release(pdeo->inode, pdeo->file);
860 spin_lock(&de->pde_unload_lock);
862 spin_unlock(&de->pde_unload_lock);
864 if (S_ISDIR(de->mode))
867 WARN(de->subdir, KERN_WARNING "%s: removing non-empty directory "
868 "'%s/%s', leaking at least '%s'\n", __func__,
869 de->parent->name, de->name, de->subdir->name);
872 EXPORT_SYMBOL(remove_proc_entry);