fs/proc/root.c

/* */
This source file includes following definitions.
proc_register
proc_unregister
make_inode_number
proc_register_dynamic
proc_self_followlink
proc_self_readlink
proc_root_init
proc_match
proc_lookup
proc_root_lookup
proc_readdir
proc_root_readdir
   1 /*
   2  *  linux/fs/proc/root.c
   3  *
   4  *  Copyright (C) 1991, 1992 Linus Torvalds
   5  *
   6  *  proc root directory handling functions
   7  */
   8 
   9 #include <asm/segment.h>
  10 
  11 #include <linux/errno.h>
  12 #include <linux/sched.h>
  13 #include <linux/proc_fs.h>
  14 #include <linux/stat.h>
  15 #include <linux/config.h>
  16 #ifdef CONFIG_APM
  17 #include <linux/apm_bios.h>
  18 #endif
  19 #include <asm/bitops.h>
  20 
  21 /*
  22  * Offset of the first process in the /proc root directory..
  23  */
  24 #define FIRST_PROCESS_ENTRY 256
  25 
  26 static int proc_root_readdir(struct inode *, struct file *, void *, filldir_t);
  27 static int proc_root_lookup(struct inode *,const char *,int,struct inode **);
  28 
  29 static unsigned char proc_alloc_map[PROC_NDYNAMIC / 8] = {0};
  30 
  31 /*
  32  * These are the generic /proc directory operations. They
  33  * use the in-memory "struct proc_dir_entry" tree to parse
  34  * the /proc directory.
  35  *
  36  * NOTE! The /proc/scsi directory currently does not correctly
  37  * build up the proc_dir_entry tree, and will show up empty.
  38  */
  39 static struct file_operations proc_dir_operations = {
  40         NULL,                   /* lseek - default */
  41         NULL,                   /* read - bad */
  42         NULL,                   /* write - bad */
  43         proc_readdir,           /* readdir */
  44         NULL,                   /* select - default */
  45         NULL,                   /* ioctl - default */
  46         NULL,                   /* mmap */
  47         NULL,                   /* no special open code */
  48         NULL,                   /* no special release code */
  49         NULL                    /* can't fsync */
  50 };
  51 
  52 /*
  53  * proc directories can do almost nothing..
  54  */
  55 struct inode_operations proc_dir_inode_operations = {
  56         &proc_dir_operations,   /* default net directory file-ops */
  57         NULL,                   /* create */
  58         proc_lookup,            /* lookup */
  59         NULL,                   /* link */
  60         NULL,                   /* unlink */
  61         NULL,                   /* symlink */
  62         NULL,                   /* mkdir */
  63         NULL,                   /* rmdir */
  64         NULL,                   /* mknod */
  65         NULL,                   /* rename */
  66         NULL,                   /* readlink */
  67         NULL,                   /* follow_link */
  68         NULL,                   /* readpage */
  69         NULL,                   /* writepage */
  70         NULL,                   /* bmap */
  71         NULL,                   /* truncate */
  72         NULL                    /* permission */
  73 };
  74 
  75 /*
  76  * The root /proc directory is special, as it has the
  77  * <pid> directories. Thus we don't use the generic
  78  * directory handling functions for that..
  79  */
  80 static struct file_operations proc_root_operations = {
  81         NULL,                   /* lseek - default */
  82         NULL,                   /* read - bad */
  83         NULL,                   /* write - bad */
  84         proc_root_readdir,      /* readdir */
  85         NULL,                   /* select - default */
  86         NULL,                   /* ioctl - default */
  87         NULL,                   /* mmap */
  88         NULL,                   /* no special open code */
  89         NULL,                   /* no special release code */
  90         NULL                    /* no fsync */
  91 };
  92 
  93 /*
  94  * proc root can do almost nothing..
  95  */
  96 static struct inode_operations proc_root_inode_operations = {
  97         &proc_root_operations,  /* default base directory file-ops */
  98         NULL,                   /* create */
  99         proc_root_lookup,       /* lookup */
 100         NULL,                   /* link */
 101         NULL,                   /* unlink */
 102         NULL,                   /* symlink */
 103         NULL,                   /* mkdir */
 104         NULL,                   /* rmdir */
 105         NULL,                   /* mknod */
 106         NULL,                   /* rename */
 107         NULL,                   /* readlink */
 108         NULL,                   /* follow_link */
 109         NULL,                   /* readpage */
 110         NULL,                   /* writepage */
 111         NULL,                   /* bmap */
 112         NULL,                   /* truncate */
 113         NULL                    /* permission */
 114 };
 115 
 116 /*
 117  * This is the root "inode" in the /proc tree..
 118  */
 119 struct proc_dir_entry proc_root = {
 120         PROC_ROOT_INO, 5, "/proc",
 121         S_IFDIR | S_IRUGO | S_IXUGO, 2, 0, 0,
 122         0, &proc_root_inode_operations,
 123         NULL, NULL,
 124         NULL,
 125         &proc_root, NULL
 126 };
 127 
 128 struct proc_dir_entry proc_net = {
 129         PROC_NET, 3, "net",
 130         S_IFDIR | S_IRUGO | S_IXUGO, 2, 0, 0,
 131         0, &proc_dir_inode_operations,
 132         NULL, NULL,
 133         NULL,
 134         NULL, NULL      
 135 };
 136 
 137 struct proc_dir_entry proc_scsi = {
 138         PROC_SCSI, 4, "scsi",
 139         S_IFDIR | S_IRUGO | S_IXUGO, 2, 0, 0,
 140         0, &proc_dir_inode_operations,
 141         NULL, NULL,
 142         NULL, &proc_root, NULL
 143 };
 144 
 145 struct proc_dir_entry proc_sys_root = {
 146         PROC_SYS, 3, "sys",                     /* inode, name */
 147         S_IFDIR | S_IRUGO | S_IXUGO, 2, 0, 0,   /* mode, nlink, uid, gid */
 148         0, &proc_dir_inode_operations,          /* size, ops */
 149         NULL, NULL,                             /* get_info, fill_inode */
 150         NULL,                                   /* next */
 151         NULL, NULL                              /* parent, subdir */
 152 };
 153 
 154 int proc_register(struct proc_dir_entry * dir, struct proc_dir_entry * dp)
     /*  */
 155 {
 156         dp->next = dir->subdir;
 157         dp->parent = dir;
 158         dir->subdir = dp;
 159         if (S_ISDIR(dp->mode))
 160                 dir->nlink++;
 161         return 0;
 162 }
 163 
 164 int proc_unregister(struct proc_dir_entry * dir, int ino)
     /*  */
 165 {
 166         struct proc_dir_entry **p = &dir->subdir, *dp;
 167 
 168         while ((dp = *p) != NULL) {
 169                 if (dp->low_ino == ino) {
 170                         *p = dp->next;
 171                         dp->next = NULL;
 172                         if (S_ISDIR(dp->mode))
 173                                 dir->nlink--;
 174                         if (ino >= PROC_DYNAMIC_FIRST &&
 175                             ino < PROC_DYNAMIC_FIRST+PROC_NDYNAMIC)
 176                                 clear_bit(ino-PROC_DYNAMIC_FIRST, 
 177                                           (void *) proc_alloc_map);
 178                         return 0;
 179                 }
 180                 p = &dp->next;
 181         }
 182         return -EINVAL;
 183 }       
 184 
 185 static int make_inode_number(void)
     /*  */
 186 {
 187         int i = find_first_zero_bit((void *) proc_alloc_map, PROC_NDYNAMIC);
 188         if (i<0 || i>=PROC_NDYNAMIC) 
 189                 return -1;
 190         set_bit(i, (void *) proc_alloc_map);
 191         return PROC_DYNAMIC_FIRST + i;
 192 }
 193 
 194 int proc_register_dynamic(struct proc_dir_entry * dir,
     /*  */
 195                           struct proc_dir_entry * dp)
 196 {
 197         int i = make_inode_number();
 198         if (i < 0)
 199                 return -EAGAIN;
 200         dp->low_ino = i;
 201         dp->next = dir->subdir;
 202         dp->parent = dir;
 203         dir->subdir = dp;
 204         if (S_ISDIR(dp->mode))
 205                 dir->nlink++;
 206         return 0;
 207 }
 208 
 209 /*
 210  * /proc/self:
 211  */
 212 static int proc_self_followlink(struct inode * dir, struct inode * inode,
     /*  */
 213                         int flag, int mode, struct inode ** res_inode)
 214 {
 215         iput(dir);
 216         *res_inode = proc_get_inode(inode->i_sb, (current->pid << 16) + PROC_PID_INO, &proc_pid);
 217         iput(inode);
 218         if (!*res_inode)
 219                 return -ENOENT;
 220         return 0;
 221 }
 222 
 223 static int proc_self_readlink(struct inode * inode, char * buffer, int buflen)
     /*  */
 224 {
 225         int len;
 226         char tmp[30];
 227 
 228         iput(inode);
 229         len = 1 + sprintf(tmp, "%d", current->pid);
 230         if (buflen < len)
 231                 len = buflen;
 232         memcpy_tofs(buffer, tmp, len);
 233         return len;
 234 }
 235 
 236 static struct inode_operations proc_self_inode_operations = {
 237         NULL,                   /* no file-ops */
 238         NULL,                   /* create */
 239         NULL,                   /* lookup */
 240         NULL,                   /* link */
 241         NULL,                   /* unlink */
 242         NULL,                   /* symlink */
 243         NULL,                   /* mkdir */
 244         NULL,                   /* rmdir */
 245         NULL,                   /* mknod */
 246         NULL,                   /* rename */
 247         proc_self_readlink,     /* readlink */
 248         proc_self_followlink,   /* follow_link */
 249         NULL,                   /* readpage */
 250         NULL,                   /* writepage */
 251         NULL,                   /* bmap */
 252         NULL,                   /* truncate */
 253         NULL                    /* permission */
 254 };
 255 
 256 void proc_root_init(void)
     /*  */
 257 {
 258         static int done = 0;
 259 
 260         if (done)
 261                 return;
 262         done = 1;
 263         proc_base_init();
 264         proc_register(&proc_root, &(struct proc_dir_entry) {
 265                 PROC_LOADAVG, 7, "loadavg",
 266                 S_IFREG | S_IRUGO, 1, 0, 0,
 267         });
 268         proc_register(&proc_root, &(struct proc_dir_entry) {
 269                 PROC_UPTIME, 6, "uptime",
 270                 S_IFREG | S_IRUGO, 1, 0, 0,
 271         });
 272         proc_register(&proc_root, &(struct proc_dir_entry) {
 273                 PROC_MEMINFO, 7, "meminfo",
 274                 S_IFREG | S_IRUGO, 1, 0, 0,
 275         });
 276         proc_register(&proc_root, &(struct proc_dir_entry) {
 277                 PROC_KMSG, 4, "kmsg",
 278                 S_IFREG | S_IRUSR, 1, 0, 0,
 279         });
 280         proc_register(&proc_root, &(struct proc_dir_entry) {
 281                 PROC_VERSION, 7, "version",
 282                 S_IFREG | S_IRUGO, 1, 0, 0,
 283         });
 284 #ifdef CONFIG_PCI
 285         proc_register(&proc_root, &(struct proc_dir_entry) {
 286                 PROC_PCI, 3, "pci",
 287                 S_IFREG | S_IRUGO, 1, 0, 0,
 288         });
 289 #endif
 290         proc_register(&proc_root, &(struct proc_dir_entry) {
 291                 PROC_CPUINFO, 7, "cpuinfo",
 292                 S_IFREG | S_IRUGO, 1, 0, 0,
 293         });
 294         proc_register(&proc_root, &(struct proc_dir_entry) {
 295                 PROC_SELF, 4, "self",
 296                 S_IFLNK | S_IRUGO | S_IWUGO | S_IXUGO, 1, 0, 0,
 297                 64, &proc_self_inode_operations,
 298         });
 299         proc_register(&proc_root, &proc_net);
 300 
 301 #ifdef CONFIG_SCSI
 302         proc_register(&proc_root, &proc_scsi);
 303 #endif
 304 
 305         proc_register(&proc_root, &proc_sys_root);
 306 
 307 #ifdef CONFIG_DEBUG_MALLOC
 308         proc_register(&proc_root, &(struct proc_dir_entry) {
 309                 PROC_MALLOC, 6, "malloc",
 310                 S_IFREG | S_IRUGO, 1, 0, 0,
 311         });
 312 #endif
 313         proc_register(&proc_root, &(struct proc_dir_entry) {
 314                 PROC_KCORE, 5, "kcore",
 315                 S_IFREG | S_IRUSR, 1, 0, 0,
 316         });
 317 
 318 #ifdef CONFIG_MODULES
 319         proc_register(&proc_root, &(struct proc_dir_entry) {
 320                 PROC_MODULES, 7, "modules",
 321                 S_IFREG | S_IRUGO, 1, 0, 0,
 322         });
 323         proc_register(&proc_root, &(struct proc_dir_entry) {
 324                 PROC_KSYMS, 5, "ksyms",
 325                 S_IFREG | S_IRUGO, 1, 0, 0,
 326         });
 327 #endif
 328         proc_register(&proc_root, &(struct proc_dir_entry) {
 329                 PROC_STAT, 4, "stat",
 330                 S_IFREG | S_IRUGO, 1, 0, 0,
 331         });
 332         proc_register(&proc_root, &(struct proc_dir_entry) {
 333                 PROC_DEVICES, 7, "devices",
 334                 S_IFREG | S_IRUGO, 1, 0, 0,
 335         });
 336         proc_register(&proc_root, &(struct proc_dir_entry) {
 337                 PROC_INTERRUPTS, 10,"interrupts",
 338                 S_IFREG | S_IRUGO, 1, 0, 0,
 339         });
 340         proc_register(&proc_root, &(struct proc_dir_entry) {
 341                 PROC_FILESYSTEMS, 11,"filesystems",
 342                 S_IFREG | S_IRUGO, 1, 0, 0,
 343         });
 344         proc_register(&proc_root, &(struct proc_dir_entry) {
 345                 PROC_DMA, 3, "dma",
 346                 S_IFREG | S_IRUGO, 1, 0, 0,
 347         });
 348         proc_register(&proc_root, &(struct proc_dir_entry) {
 349                 PROC_IOPORTS, 7, "ioports",
 350                 S_IFREG | S_IRUGO, 1, 0, 0,
 351         });
 352 #ifdef CONFIG_APM
 353         proc_register(&proc_root, &(struct proc_dir_entry) {
 354                 PROC_APM, 3, "apm",
 355                 S_IFREG | S_IRUGO, 1, 0, 0,
 356         });
 357 #endif
 358         proc_register(&proc_root, &(struct proc_dir_entry) {
 359                 PROC_CMDLINE, 7, "cmdline",
 360                 S_IFREG | S_IRUGO, 1, 0, 0,
 361         });
 362                    
 363         if (prof_shift) {
 364                 proc_register(&proc_root, &(struct proc_dir_entry) {
 365                         PROC_PROFILE, 7, "profile",
 366                         S_IFREG | S_IRUGO | S_IWUSR, 1, 0, 0,
 367                 });
 368         }
 369 }
 370 
 371 
 372 int proc_match(int len,const char * name,struct proc_dir_entry * de)
     /*  */
 373 {
 374         if (!de || !de->low_ino)
 375                 return 0;
 376         /* "" means "." ---> so paths like "/usr/lib//libc.a" work */
 377         if (!len && (de->name[0]=='.') && (de->name[1]=='\0'))
 378                 return 1;
 379         if (de->namelen != len)
 380                 return 0;
 381         return !memcmp(name, de->name, len);
 382 }
 383 
 384 int proc_lookup(struct inode * dir,const char * name, int len,
     /*  */
 385         struct inode ** result)
 386 {
 387         struct proc_dir_entry * de;
 388         int ino;
 389 
 390         *result = NULL;
 391         if (!dir || !S_ISDIR(dir->i_mode)) {
 392                 iput(dir);
 393                 return -ENOTDIR;
 394         }
 395 
 396         de = (struct proc_dir_entry *) dir->u.generic_ip;
 397         if (!de) {
 398                 iput(dir);
 399                 return -EINVAL;
 400         }
 401 
 402         /* Special case "." and "..": they aren't on the directory list */
 403         *result = dir;
 404         if (!len)
 405                 return 0;
 406         if (name[0] == '.') {
 407                 if (len == 1)
 408                         return 0;
 409                 if (name[1] == '.' && len == 2) {
 410                         struct inode * inode;
 411                         inode = proc_get_inode(dir->i_sb, de->parent->low_ino, de->parent);
 412                         iput(dir);
 413                         if (!inode)
 414                                 return -EINVAL;
 415                         *result = inode;
 416                         return 0;
 417                 }
 418         }
 419 
 420         *result = NULL;
 421         for (de = de->subdir; de ; de = de->next) {
 422                 if (proc_match(len, name, de))
 423                         break;
 424         }
 425         if (!de) {
 426                 iput(dir);
 427                 return -ENOENT;
 428         }
 429 
 430         ino = de->low_ino | (dir->i_ino & ~(0xffff));
 431 
 432         if (!(*result = proc_get_inode(dir->i_sb, ino, de))) {
 433                 iput(dir);
 434                 return -EINVAL;
 435         }
 436         iput(dir);
 437         return 0;
 438 }
 439 
 440 static int proc_root_lookup(struct inode * dir,const char * name, int len,
     /*  */
 441         struct inode ** result)
 442 {
 443         unsigned int pid, c;
 444         int i, ino, retval;
 445 
 446         dir->i_count++;
 447         retval = proc_lookup(dir, name, len, result);
 448         if (retval != -ENOENT) {
 449                 iput(dir);
 450                 return retval;
 451         }
 452         
 453         pid = 0;
 454         while (len-- > 0) {
 455                 c = *name - '0';
 456                 name++;
 457                 if (c > 9) {
 458                         pid = 0;
 459                         break;
 460                 }
 461                 pid *= 10;
 462                 pid += c;
 463                 if (pid & 0xffff0000) {
 464                         pid = 0;
 465                         break;
 466                 }
 467         }
 468         for (i = 0 ; i < NR_TASKS ; i++)
 469                 if (task[i] && task[i]->pid == pid)
 470                         break;
 471         if (!pid || i >= NR_TASKS) {
 472                 iput(dir);
 473                 return -ENOENT;
 474         }
 475         ino = (pid << 16) + PROC_PID_INO;
 476         if (!(*result = proc_get_inode(dir->i_sb, ino, &proc_pid))) {
 477                 iput(dir);
 478                 return -EINVAL;
 479         }
 480         iput(dir);
 481         return 0;
 482 }
 483 
 484 /*
 485  * This returns non-zero if at EOF, so that the /proc
 486  * root directory can use this and check if it should
 487  * continue with the <pid> entries..
 488  *
 489  * Note that the VFS-layer doesn't care about the return
 490  * value of the readdir() call, as long as it's non-negative
 491  * for success..
 492  */
 493 int proc_readdir(struct inode * inode, struct file * filp,
     /*  */
 494         void * dirent, filldir_t filldir)
 495 {
 496         struct proc_dir_entry * de;
 497         unsigned int ino;
 498         int i;
 499 
 500         if (!inode || !S_ISDIR(inode->i_mode))
 501                 return -ENOTDIR;
 502         ino = inode->i_ino;
 503         de = (struct proc_dir_entry *) inode->u.generic_ip;
 504         if (!de)
 505                 return -EINVAL;
 506         i = filp->f_pos;
 507         switch (i) {
 508                 case 0:
 509                         if (filldir(dirent, ".", 1, i, ino) < 0)
 510                                 return 0;
 511                         i++;
 512                         filp->f_pos++;
 513                         /* fall through */
 514                 case 1:
 515                         if (filldir(dirent, "..", 2, i, de->parent->low_ino) < 0)
 516                                 return 0;
 517                         i++;
 518                         filp->f_pos++;
 519                         /* fall through */
 520                 default:
 521                         ino &= ~0xffff;
 522                         de = de->subdir;
 523                         i -= 2;
 524                         for (;;) {
 525                                 if (!de)
 526                                         return 1;
 527                                 if (!i)
 528                                         break;
 529                                 de = de->next;
 530                                 i--;
 531                         }
 532 
 533                         do {
 534                                 if (filldir(dirent, de->name, de->namelen, filp->f_pos, ino | de->low_ino) < 0)
 535                                         return 0;
 536                                 filp->f_pos++;
 537                                 de = de->next;
 538                         } while (de);
 539         }
 540         return 1;
 541 }
 542 
 543 #define NUMBUF 10
 544 
 545 static int proc_root_readdir(struct inode * inode, struct file * filp,
     /*  */
 546         void * dirent, filldir_t filldir)
 547 {
 548         char buf[NUMBUF];
 549         unsigned int nr,pid;
 550         unsigned long i,j;
 551 
 552         nr = filp->f_pos;
 553         if (nr < FIRST_PROCESS_ENTRY) {
 554                 int error = proc_readdir(inode, filp, dirent, filldir);
 555                 if (error <= 0)
 556                         return error;
 557                 filp->f_pos = nr = FIRST_PROCESS_ENTRY;
 558         }
 559 
 560         for (nr -= FIRST_PROCESS_ENTRY; nr < NR_TASKS; nr++, filp->f_pos++) {
 561                 struct task_struct * p = task[nr];
 562 
 563                 if (!p || !(pid = p->pid))
 564                         continue;
 565 
 566                 j = NUMBUF;
 567                 i = pid;
 568                 do {
 569                         j--;
 570                         buf[j] = '0' + (i % 10);
 571                         i /= 10;
 572                 } while (i);
 573 
 574                 if (filldir(dirent, buf+j, NUMBUF-j, filp->f_pos, (pid << 16) + PROC_PID_INO) < 0)
 575                         break;
 576         }
 577         return 0;
 578 }
/* */
root/fs/proc/root.c

DEFINITIONS
