~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~ [ freetext search ] ~ [ file search ] ~

Linux Cross Reference
Linux/include/linux/proc_fs.h

Version: ~ [ 2.4.0 ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 #ifndef _LINUX_PROC_FS_H
  2 #define _LINUX_PROC_FS_H
  3 
  4 #include <linux/config.h>
  5 #include <linux/malloc.h>
  6 
  7 /*
  8  * The proc filesystem constants/structures
  9  */
 10 
 11 /*
 12  * Offset of the first process in the /proc root directory..
 13  */
 14 #define FIRST_PROCESS_ENTRY 256
 15 
 16 
 17 /*
 18  * We always define these enumerators
 19  */
 20 
 21 enum {
 22         PROC_ROOT_INO = 1,
 23 };
 24 
 25 /* Finally, the dynamically allocatable proc entries are reserved: */
 26 
 27 #define PROC_DYNAMIC_FIRST 4096
 28 #define PROC_NDYNAMIC      4096
 29 
 30 #define PROC_SUPER_MAGIC 0x9fa0
 31 
 32 /*
 33  * This is not completely implemented yet. The idea is to
 34  * create an in-memory tree (like the actual /proc filesystem
 35  * tree) of these proc_dir_entries, so that we can dynamically
 36  * add new files to /proc.
 37  *
 38  * The "next" pointer creates a linked list of one /proc directory,
 39  * while parent/subdir create the directory structure (every
 40  * /proc file has a parent, but "subdir" is NULL for all
 41  * non-directory entries).
 42  *
 43  * "get_info" is called at "read", while "owner" is used to protect module
 44  * from unloading while proc_dir_entry is in use
 45  */
 46 
 47 typedef int (read_proc_t)(char *page, char **start, off_t off,
 48                           int count, int *eof, void *data);
 49 typedef int (write_proc_t)(struct file *file, const char *buffer,
 50                            unsigned long count, void *data);
 51 typedef int (get_info_t)(char *, char **, off_t, int);
 52 
 53 struct proc_dir_entry {
 54         unsigned short low_ino;
 55         unsigned short namelen;
 56         const char *name;
 57         mode_t mode;
 58         nlink_t nlink;
 59         uid_t uid;
 60         gid_t gid;
 61         unsigned long size;
 62         struct inode_operations * proc_iops;
 63         struct file_operations * proc_fops;
 64         get_info_t *get_info;
 65         struct module *owner;
 66         struct proc_dir_entry *next, *parent, *subdir;
 67         void *data;
 68         read_proc_t *read_proc;
 69         write_proc_t *write_proc;
 70         atomic_t count;         /* use count */
 71         int deleted;            /* delete flag */
 72         kdev_t  rdev;
 73 };
 74 
 75 #define PROC_INODE_PROPER(inode) ((inode)->i_ino & ~0xffff)
 76 
 77 #ifdef CONFIG_PROC_FS
 78 
 79 extern struct proc_dir_entry proc_root;
 80 extern struct proc_dir_entry *proc_root_fs;
 81 extern struct proc_dir_entry *proc_net;
 82 extern struct proc_dir_entry *proc_bus;
 83 extern struct proc_dir_entry *proc_root_driver;
 84 extern struct proc_dir_entry *proc_root_kcore;
 85 
 86 extern void proc_root_init(void);
 87 extern void proc_misc_init(void);
 88 
 89 struct dentry *proc_pid_lookup(struct inode *dir, struct dentry * dentry);
 90 void proc_pid_delete_inode(struct inode *inode);
 91 int proc_pid_readdir(struct file * filp, void * dirent, filldir_t filldir);
 92 
 93 extern struct proc_dir_entry *create_proc_entry(const char *name, mode_t mode,
 94                                                 struct proc_dir_entry *parent);
 95 extern void remove_proc_entry(const char *name, struct proc_dir_entry *parent);
 96 
 97 extern struct vfsmount *proc_mnt;
 98 extern struct super_block *proc_read_super(struct super_block *,void *,int);
 99 extern struct inode * proc_get_inode(struct super_block *, int, struct proc_dir_entry *);
100 
101 extern int proc_match(int, const char *,struct proc_dir_entry *);
102 
103 /*
104  * These are generic /proc routines that use the internal
105  * "struct proc_dir_entry" tree to traverse the filesystem.
106  *
107  * The /proc root directory has extended versions to take care
108  * of the /proc/<pid> subdirectories.
109  */
110 extern int proc_readdir(struct file *, void *, filldir_t);
111 extern struct dentry *proc_lookup(struct inode *, struct dentry *);
112 
113 extern struct file_operations proc_kcore_operations;
114 extern struct file_operations proc_kmsg_operations;
115 extern struct file_operations ppc_htab_operations;
116 
117 /*
118  * proc_tty.c
119  */
120 extern void proc_tty_init(void);
121 extern void proc_tty_register_driver(struct tty_driver *driver);
122 extern void proc_tty_unregister_driver(struct tty_driver *driver);
123 
124 /*
125  * proc_devtree.c
126  */
127 extern void proc_device_tree_init(void);
128 
129 extern struct proc_dir_entry *proc_symlink(const char *,
130                 struct proc_dir_entry *, const char *);
131 extern struct proc_dir_entry *proc_mknod(const char *,mode_t,
132                 struct proc_dir_entry *,kdev_t);
133 extern struct proc_dir_entry *proc_mkdir(const char *,struct proc_dir_entry *);
134 
135 extern inline struct proc_dir_entry *create_proc_read_entry(const char *name,
136         mode_t mode, struct proc_dir_entry *base, 
137         read_proc_t *read_proc, void * data)
138 {
139         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
140         if (res) {
141                 res->read_proc=read_proc;
142                 res->data=data;
143         }
144         return res;
145 }
146  
147 extern inline struct proc_dir_entry *create_proc_info_entry(const char *name,
148         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
149 {
150         struct proc_dir_entry *res=create_proc_entry(name,mode,base);
151         if (res) res->get_info=get_info;
152         return res;
153 }
154  
155 extern inline struct proc_dir_entry *proc_net_create(const char *name,
156         mode_t mode, get_info_t *get_info)
157 {
158         return create_proc_info_entry(name,mode,proc_net,get_info);
159 }
160 
161 extern inline void proc_net_remove(const char *name)
162 {
163         remove_proc_entry(name,proc_net);
164 }
165 
166 #else
167 
168 extern inline struct proc_dir_entry *proc_net_create(const char *name, mode_t mode, 
169         get_info_t *get_info) {return NULL;}
170 extern inline void proc_net_remove(const char *name) {}
171 
172 extern inline struct proc_dir_entry *create_proc_entry(const char *name,
173         mode_t mode, struct proc_dir_entry *parent) { return NULL; }
174 
175 extern inline void remove_proc_entry(const char *name, struct proc_dir_entry *parent) {};
176 extern inline struct proc_dir_entry *proc_symlink(const char *name,
177                 struct proc_dir_entry *parent,char *dest) {return NULL;}
178 extern inline struct proc_dir_entry *proc_mknod(const char *name,mode_t mode,
179                 struct proc_dir_entry *parent,kdev_t rdev) {return NULL;}
180 extern inline struct proc_dir_entry *proc_mkdir(const char *name,
181         struct proc_dir_entry *parent) {return NULL;}
182 
183 extern inline struct proc_dir_entry *create_proc_read_entry(const char *name,
184         mode_t mode, struct proc_dir_entry *base, 
185         int (*read_proc)(char *, char **, off_t, int, int *, void *),
186         void * data) { return NULL; }
187 extern inline struct proc_dir_entry *create_proc_info_entry(const char *name,
188         mode_t mode, struct proc_dir_entry *base, get_info_t *get_info)
189         { return NULL; }
190 
191 extern inline void proc_tty_register_driver(struct tty_driver *driver) {};
192 extern inline void proc_tty_unregister_driver(struct tty_driver *driver) {};
193 
194 extern struct proc_dir_entry proc_root;
195 
196 #endif /* CONFIG_PROC_FS */
197 
198 #endif /* _LINUX_PROC_FS_H */
199 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~ [ freetext search ] ~ [ file search ] ~

This page was automatically generated by the LXR engine.
Visit the LXR main site for more information.