This commit was manufactured by cvs2svn to create tag
[linux-2.6.git] / fs / proc / generic.c
1 /*
2  * proc/fs/generic.c --- generic routines for the proc-fs
3  *
4  * This file contains generic proc-fs routines for handling
5  * directories and files.
6  * 
7  * Copyright (C) 1991, 1992 Linus Torvalds.
8  * Copyright (C) 1997 Theodore Ts'o
9  */
10
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/smp_lock.h>
18 #include <linux/init.h>
19 #include <linux/idr.h>
20 #include <asm/uaccess.h>
21 #include <asm/bitops.h>
22
23 static ssize_t proc_file_read(struct file *file, char __user *buf,
24                               size_t nbytes, loff_t *ppos);
25 static ssize_t proc_file_write(struct file *file, const char __user *buffer,
26                                size_t count, loff_t *ppos);
27 static loff_t proc_file_lseek(struct file *, loff_t, int);
28
29 int proc_match(int len, const char *name, struct proc_dir_entry *de)
30 {
31         if (de->namelen != len)
32                 return 0;
33         return !memcmp(name, de->name, len);
34 }
35
36 static struct file_operations proc_file_operations = {
37         .llseek         = proc_file_lseek,
38         .read           = proc_file_read,
39         .write          = proc_file_write,
40 };
41
42 /* buffer size is one page but our output routines use some slack for overruns */
43 #define PROC_BLOCK_SIZE (PAGE_SIZE - 1024)
44
45 static ssize_t
46 proc_file_read(struct file *file, char __user *buf, size_t nbytes,
47                loff_t *ppos)
48 {
49         struct inode * inode = file->f_dentry->d_inode;
50         char    *page;
51         ssize_t retval=0;
52         int     eof=0;
53         ssize_t n, count;
54         char    *start;
55         struct proc_dir_entry * dp;
56
57         dp = PDE(inode);
58         if (!(page = (char*) __get_free_page(GFP_KERNEL)))
59                 return -ENOMEM;
60
61         while ((nbytes > 0) && !eof) {
62                 count = min_t(ssize_t, PROC_BLOCK_SIZE, nbytes);
63
64                 start = NULL;
65                 if (dp->get_info) {
66                         /* Handle old net routines */
67                         n = dp->get_info(page, &start, *ppos, count);
68                         if (n < count)
69                                 eof = 1;
70                 } else if (dp->read_proc) {
71                         /*
72                          * How to be a proc read function
73                          * ------------------------------
74                          * Prototype:
75                          *    int f(char *buffer, char **start, off_t offset,
76                          *          int count, int *peof, void *dat)
77                          *
78                          * Assume that the buffer is "count" bytes in size.
79                          *
80                          * If you know you have supplied all the data you
81                          * have, set *peof.
82                          *
83                          * You have three ways to return data:
84                          * 0) Leave *start = NULL.  (This is the default.)
85                          *    Put the data of the requested offset at that
86                          *    offset within the buffer.  Return the number (n)
87                          *    of bytes there are from the beginning of the
88                          *    buffer up to the last byte of data.  If the
89                          *    number of supplied bytes (= n - offset) is 
90                          *    greater than zero and you didn't signal eof
91                          *    and the reader is prepared to take more data
92                          *    you will be called again with the requested
93                          *    offset advanced by the number of bytes 
94                          *    absorbed.  This interface is useful for files
95                          *    no larger than the buffer.
96                          * 1) Set *start = an unsigned long value less than
97                          *    the buffer address but greater than zero.
98                          *    Put the data of the requested offset at the
99                          *    beginning of the buffer.  Return the number of
100                          *    bytes of data placed there.  If this number is
101                          *    greater than zero and you didn't signal eof
102                          *    and the reader is prepared to take more data
103                          *    you will be called again with the requested
104                          *    offset advanced by *start.  This interface is
105                          *    useful when you have a large file consisting
106                          *    of a series of blocks which you want to count
107                          *    and return as wholes.
108                          *    (Hack by Paul.Russell@rustcorp.com.au)
109                          * 2) Set *start = an address within the buffer.
110                          *    Put the data of the requested offset at *start.
111                          *    Return the number of bytes of data placed there.
112                          *    If this number is greater than zero and you
113                          *    didn't signal eof and the reader is prepared to
114                          *    take more data you will be called again with the
115                          *    requested offset advanced by the number of bytes
116                          *    absorbed.
117                          */
118                         n = dp->read_proc(page, &start, *ppos,
119                                           count, &eof, dp->data);
120                 } else
121                         break;
122
123                 if (n == 0)   /* end of file */
124                         break;
125                 if (n < 0) {  /* error */
126                         if (retval == 0)
127                                 retval = n;
128                         break;
129                 }
130
131                 if (start == NULL) {
132                         if (n > PAGE_SIZE) {
133                                 printk(KERN_ERR
134                                        "proc_file_read: Apparent buffer overflow!\n");
135                                 n = PAGE_SIZE;
136                         }
137                         n -= *ppos;
138                         if (n <= 0)
139                                 break;
140                         if (n > count)
141                                 n = count;
142                         start = page + *ppos;
143                 } else if (start < page) {
144                         if (n > PAGE_SIZE) {
145                                 printk(KERN_ERR
146                                        "proc_file_read: Apparent buffer overflow!\n");
147                                 n = PAGE_SIZE;
148                         }
149                         if (n > count) {
150                                 /*
151                                  * Don't reduce n because doing so might
152                                  * cut off part of a data block.
153                                  */
154                                 printk(KERN_WARNING
155                                        "proc_file_read: Read count exceeded\n");
156                         }
157                 } else /* start >= page */ {
158                         unsigned long startoff = (unsigned long)(start - page);
159                         if (n > (PAGE_SIZE - startoff)) {
160                                 printk(KERN_ERR
161                                        "proc_file_read: Apparent buffer overflow!\n");
162                                 n = PAGE_SIZE - startoff;
163                         }
164                         if (n > count)
165                                 n = count;
166                 }
167                 
168                 n -= copy_to_user(buf, start < page ? page : start, n);
169                 if (n == 0) {
170                         if (retval == 0)
171                                 retval = -EFAULT;
172                         break;
173                 }
174
175                 *ppos += start < page ? (unsigned long)start : n;
176                 nbytes -= n;
177                 buf += n;
178                 retval += n;
179         }
180         free_page((unsigned long) page);
181         return retval;
182 }
183
184 static ssize_t
185 proc_file_write(struct file *file, const char __user *buffer,
186                 size_t count, loff_t *ppos)
187 {
188         struct inode *inode = file->f_dentry->d_inode;
189         struct proc_dir_entry * dp;
190         
191         dp = PDE(inode);
192
193         if (!dp->write_proc)
194                 return -EIO;
195
196         /* FIXME: does this routine need ppos?  probably... */
197         return dp->write_proc(file, buffer, count, dp->data);
198 }
199
200
201 static loff_t
202 proc_file_lseek(struct file *file, loff_t offset, int orig)
203 {
204     lock_kernel();
205
206     switch (orig) {
207     case 0:
208         if (offset < 0)
209             goto out;
210         file->f_pos = offset;
211         unlock_kernel();
212         return(file->f_pos);
213     case 1:
214         if (offset + file->f_pos < 0)
215             goto out;
216         file->f_pos += offset;
217         unlock_kernel();
218         return(file->f_pos);
219     case 2:
220         goto out;
221     default:
222         goto out;
223     }
224
225 out:
226     unlock_kernel();
227     return -EINVAL;
228 }
229
230 static int proc_notify_change(struct dentry *dentry, struct iattr *iattr)
231 {
232         struct inode *inode = dentry->d_inode;
233         int error = inode_setattr(inode, iattr);
234         if (!error) {
235                 struct proc_dir_entry *de = PDE(inode);
236                 de->uid = inode->i_uid;
237                 de->gid = inode->i_gid;
238                 de->mode = inode->i_mode;
239         }
240
241         return error;
242 }
243
244 static struct inode_operations proc_file_inode_operations = {
245         .setattr        = proc_notify_change,
246 };
247
248 /*
249  * This function parses a name such as "tty/driver/serial", and
250  * returns the struct proc_dir_entry for "/proc/tty/driver", and
251  * returns "serial" in residual.
252  */
253 static int xlate_proc_name(const char *name,
254                            struct proc_dir_entry **ret, const char **residual)
255 {
256         const char              *cp = name, *next;
257         struct proc_dir_entry   *de;
258         int                     len;
259
260         de = &proc_root;
261         while (1) {
262                 next = strchr(cp, '/');
263                 if (!next)
264                         break;
265
266                 len = next - cp;
267                 for (de = de->subdir; de ; de = de->next) {
268                         if (proc_match(len, cp, de))
269                                 break;
270                 }
271                 if (!de)
272                         return -ENOENT;
273                 cp += len + 1;
274         }
275         *residual = cp;
276         *ret = de;
277         return 0;
278 }
279
280 static DEFINE_IDR(proc_inum_idr);
281 static spinlock_t proc_inum_lock = SPIN_LOCK_UNLOCKED; /* protects the above */
282
283 #define PROC_DYNAMIC_FIRST 0xF0000000UL
284
285 /*
286  * Return an inode number between PROC_DYNAMIC_FIRST and
287  * 0xffffffff, or zero on failure.
288  */
289 static unsigned int get_inode_number(void)
290 {
291         unsigned int i, inum = 0;
292
293 retry:
294         if (idr_pre_get(&proc_inum_idr, GFP_KERNEL) == 0)
295                 return 0;
296
297         spin_lock(&proc_inum_lock);
298         i = idr_get_new(&proc_inum_idr, NULL);
299         spin_unlock(&proc_inum_lock);
300
301         if (i == -1)
302                 goto retry;
303
304         inum = (i & MAX_ID_MASK) + PROC_DYNAMIC_FIRST;
305
306         /* inum will never be more than 0xf0ffffff, so no check
307          * for overflow.
308          */
309
310         return inum;
311 }
312
313 static void release_inode_number(unsigned int inum)
314 {
315         int id = (inum - PROC_DYNAMIC_FIRST) | ~MAX_ID_MASK;
316
317         spin_lock(&proc_inum_lock);
318         idr_remove(&proc_inum_idr, id);
319         spin_unlock(&proc_inum_lock);
320 }
321
322 static int proc_follow_link(struct dentry *dentry, struct nameidata *nd)
323 {
324         nd_set_link(nd, PDE(dentry->d_inode)->data);
325         return 0;
326 }
327
328 static struct inode_operations proc_link_inode_operations = {
329         .readlink       = generic_readlink,
330         .follow_link    = proc_follow_link,
331 };
332
333 /*
334  * As some entries in /proc are volatile, we want to 
335  * get rid of unused dentries.  This could be made 
336  * smarter: we could keep a "volatile" flag in the 
337  * inode to indicate which ones to keep.
338  */
339 static int proc_delete_dentry(struct dentry * dentry)
340 {
341         return 1;
342 }
343
344 static struct dentry_operations proc_dentry_operations =
345 {
346         .d_delete       = proc_delete_dentry,
347 };
348
349 /*
350  * Don't create negative dentries here, return -ENOENT by hand
351  * instead.
352  */
353 struct dentry *proc_lookup(struct inode * dir, struct dentry *dentry, struct nameidata *nd)
354 {
355         struct inode *inode = NULL;
356         struct proc_dir_entry * de;
357         int error = -ENOENT;
358
359         lock_kernel();
360         de = PDE(dir);
361         if (de) {
362                 for (de = de->subdir; de ; de = de->next) {
363                         if (de->namelen != dentry->d_name.len)
364                                 continue;
365                         if (!memcmp(dentry->d_name.name, de->name, de->namelen)) {
366                                 unsigned int ino = de->low_ino;
367
368                                 error = -EINVAL;
369                                 inode = proc_get_inode(dir->i_sb, ino, de);
370                                 break;
371                         }
372                 }
373         }
374         unlock_kernel();
375
376         if (inode) {
377                 dentry->d_op = &proc_dentry_operations;
378                 d_add(dentry, inode);
379                 return NULL;
380         }
381         return ERR_PTR(error);
382 }
383
384 /*
385  * This returns non-zero if at EOF, so that the /proc
386  * root directory can use this and check if it should
387  * continue with the <pid> entries..
388  *
389  * Note that the VFS-layer doesn't care about the return
390  * value of the readdir() call, as long as it's non-negative
391  * for success..
392  */
393 int proc_readdir(struct file * filp,
394         void * dirent, filldir_t filldir)
395 {
396         struct proc_dir_entry * de;
397         unsigned int ino;
398         int i;
399         struct inode *inode = filp->f_dentry->d_inode;
400         int ret = 0;
401
402         lock_kernel();
403
404         ino = inode->i_ino;
405         de = PDE(inode);
406         if (!de) {
407                 ret = -EINVAL;
408                 goto out;
409         }
410         i = filp->f_pos;
411         switch (i) {
412                 case 0:
413                         if (filldir(dirent, ".", 1, i, ino, DT_DIR) < 0)
414                                 goto out;
415                         i++;
416                         filp->f_pos++;
417                         /* fall through */
418                 case 1:
419                         if (filldir(dirent, "..", 2, i,
420                                     parent_ino(filp->f_dentry),
421                                     DT_DIR) < 0)
422                                 goto out;
423                         i++;
424                         filp->f_pos++;
425                         /* fall through */
426                 default:
427                         de = de->subdir;
428                         i -= 2;
429                         for (;;) {
430                                 if (!de) {
431                                         ret = 1;
432                                         goto out;
433                                 }
434                                 if (!i)
435                                         break;
436                                 de = de->next;
437                                 i--;
438                         }
439
440                         do {
441                                 if (filldir(dirent, de->name, de->namelen, filp->f_pos,
442                                             de->low_ino, de->mode >> 12) < 0)
443                                         goto out;
444                                 filp->f_pos++;
445                                 de = de->next;
446                         } while (de);
447         }
448         ret = 1;
449 out:    unlock_kernel();
450         return ret;     
451 }
452
453 /*
454  * These are the generic /proc directory operations. They
455  * use the in-memory "struct proc_dir_entry" tree to parse
456  * the /proc directory.
457  */
458 static struct file_operations proc_dir_operations = {
459         .read                   = generic_read_dir,
460         .readdir                = proc_readdir,
461 };
462
463 /*
464  * proc directories can do almost nothing..
465  */
466 static struct inode_operations proc_dir_inode_operations = {
467         .lookup         = proc_lookup,
468         .setattr        = proc_notify_change,
469 };
470
471 static int proc_register(struct proc_dir_entry * dir, struct proc_dir_entry * dp)
472 {
473         unsigned int i;
474         
475         i = get_inode_number();
476         if (i == 0)
477                 return -EAGAIN;
478         dp->low_ino = i;
479         dp->next = dir->subdir;
480         dp->parent = dir;
481         dir->subdir = dp;
482         if (S_ISDIR(dp->mode)) {
483                 if (dp->proc_iops == NULL) {
484                         dp->proc_fops = &proc_dir_operations;
485                         dp->proc_iops = &proc_dir_inode_operations;
486                 }
487                 dir->nlink++;
488         } else if (S_ISLNK(dp->mode)) {
489                 if (dp->proc_iops == NULL)
490                         dp->proc_iops = &proc_link_inode_operations;
491         } else if (S_ISREG(dp->mode)) {
492                 if (dp->proc_fops == NULL)
493                         dp->proc_fops = &proc_file_operations;
494                 if (dp->proc_iops == NULL)
495                         dp->proc_iops = &proc_file_inode_operations;
496         }
497         return 0;
498 }
499
500 /*
501  * Kill an inode that got unregistered..
502  */
503 static void proc_kill_inodes(struct proc_dir_entry *de)
504 {
505         struct list_head *p;
506         struct super_block *sb = proc_mnt->mnt_sb;
507
508         /*
509          * Actually it's a partial revoke().
510          */
511         file_list_lock();
512         list_for_each(p, &sb->s_files) {
513                 struct file * filp = list_entry(p, struct file, f_list);
514                 struct dentry * dentry = filp->f_dentry;
515                 struct inode * inode;
516                 struct file_operations *fops;
517
518                 if (dentry->d_op != &proc_dentry_operations)
519                         continue;
520                 inode = dentry->d_inode;
521                 if (PDE(inode) != de)
522                         continue;
523                 fops = filp->f_op;
524                 filp->f_op = NULL;
525                 fops_put(fops);
526         }
527         file_list_unlock();
528 }
529
530 static struct proc_dir_entry *proc_create(struct proc_dir_entry **parent,
531                                           const char *name,
532                                           mode_t mode,
533                                           nlink_t nlink)
534 {
535         struct proc_dir_entry *ent = NULL;
536         const char *fn = name;
537         int len;
538
539         /* make sure name is valid */
540         if (!name || !strlen(name)) goto out;
541
542         if (!(*parent) && xlate_proc_name(name, parent, &fn) != 0)
543                 goto out;
544         len = strlen(fn);
545
546         ent = kmalloc(sizeof(struct proc_dir_entry) + len + 1, GFP_KERNEL);
547         if (!ent) goto out;
548
549         memset(ent, 0, sizeof(struct proc_dir_entry));
550         memcpy(((char *) ent) + sizeof(struct proc_dir_entry), fn, len + 1);
551         ent->name = ((char *) ent) + sizeof(*ent);
552         ent->namelen = len;
553         ent->mode = mode;
554         ent->nlink = nlink;
555  out:
556         return ent;
557 }
558
559 struct proc_dir_entry *proc_symlink(const char *name,
560                 struct proc_dir_entry *parent, const char *dest)
561 {
562         struct proc_dir_entry *ent;
563
564         ent = proc_create(&parent,name,
565                           (S_IFLNK | S_IRUGO | S_IWUGO | S_IXUGO),1);
566
567         if (ent) {
568                 ent->data = kmalloc((ent->size=strlen(dest))+1, GFP_KERNEL);
569                 if (ent->data) {
570                         strcpy((char*)ent->data,dest);
571                         if (proc_register(parent, ent) < 0) {
572                                 kfree(ent->data);
573                                 kfree(ent);
574                                 ent = NULL;
575                         }
576                 } else {
577                         kfree(ent);
578                         ent = NULL;
579                 }
580         }
581         return ent;
582 }
583
584 struct proc_dir_entry *proc_mkdir_mode(const char *name, mode_t mode,
585                 struct proc_dir_entry *parent)
586 {
587         struct proc_dir_entry *ent;
588
589         ent = proc_create(&parent, name, S_IFDIR | mode, 2);
590         if (ent) {
591                 ent->proc_fops = &proc_dir_operations;
592                 ent->proc_iops = &proc_dir_inode_operations;
593
594                 if (proc_register(parent, ent) < 0) {
595                         kfree(ent);
596                         ent = NULL;
597                 }
598         }
599         return ent;
600 }
601
602 struct proc_dir_entry *proc_mkdir(const char *name,
603                 struct proc_dir_entry *parent)
604 {
605         return proc_mkdir_mode(name, S_IRUGO | S_IXUGO, parent);
606 }
607
608 struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
609                                          struct proc_dir_entry *parent)
610 {
611         struct proc_dir_entry *ent;
612         nlink_t nlink;
613
614         if (S_ISDIR(mode)) {
615                 if ((mode & S_IALLUGO) == 0)
616                         mode |= S_IRUGO | S_IXUGO;
617                 nlink = 2;
618         } else {
619                 if ((mode & S_IFMT) == 0)
620                         mode |= S_IFREG;
621                 if ((mode & S_IALLUGO) == 0)
622                         mode |= S_IRUGO;
623                 nlink = 1;
624         }
625
626         ent = proc_create(&parent,name,mode,nlink);
627         if (ent) {
628                 if (S_ISDIR(mode)) {
629                         ent->proc_fops = &proc_dir_operations;
630                         ent->proc_iops = &proc_dir_inode_operations;
631                 }
632                 if (proc_register(parent, ent) < 0) {
633                         kfree(ent);
634                         ent = NULL;
635                 }
636         }
637         return ent;
638 }
639
640 void free_proc_entry(struct proc_dir_entry *de)
641 {
642         unsigned int ino = de->low_ino;
643
644         if (ino < PROC_DYNAMIC_FIRST)
645                 return;
646
647         release_inode_number(ino);
648
649         if (S_ISLNK(de->mode) && de->data)
650                 kfree(de->data);
651         kfree(de);
652 }
653
654 /*
655  * Remove a /proc entry and free it if it's not currently in use.
656  * If it is in use, we set the 'deleted' flag.
657  */
658 void remove_proc_entry(const char *name, struct proc_dir_entry *parent)
659 {
660         struct proc_dir_entry **p;
661         struct proc_dir_entry *de;
662         const char *fn = name;
663         int len;
664
665         if (!parent && xlate_proc_name(name, &parent, &fn) != 0)
666                 goto out;
667         len = strlen(fn);
668         for (p = &parent->subdir; *p; p=&(*p)->next ) {
669                 if (!proc_match(len, fn, *p))
670                         continue;
671                 de = *p;
672                 *p = de->next;
673                 de->next = NULL;
674                 if (S_ISDIR(de->mode))
675                         parent->nlink--;
676                 proc_kill_inodes(de);
677                 de->nlink = 0;
678                 BUG_ON(de->subdir);
679                 if (!atomic_read(&de->count))
680                         free_proc_entry(de);
681                 else {
682                         de->deleted = 1;
683                         printk("remove_proc_entry: %s/%s busy, count=%d\n",
684                                 parent->name, de->name, atomic_read(&de->count));
685                 }
686                 break;
687         }
688 out:
689         return;
690 }