include/linux/seq_file.h

   1 #ifndef _LINUX_SEQ_FILE_H
   2 #define _LINUX_SEQ_FILE_H
   3 #ifdef __KERNEL__
   4
   5 #include <linux/types.h>
   6 #include <linux/string.h>
   7 #include <linux/mutex.h>
   8
   9 struct seq_operations;
  10 struct file;
  11 struct path;
  12 struct inode;
  13
  14 struct seq_file {
  15         char *buf;
  16         size_t size;
  17         size_t from;
  18         size_t count;
  19         loff_t index;
  20         u64 version;
  21         struct mutex lock;
  22         const struct seq_operations *op;
  23         void *private;
  24 };
  25
  26 struct seq_operations {
  27         void * (*start) (struct seq_file *m, loff_t *pos);
  28         void (*stop) (struct seq_file *m, void *v);
  29         void * (*next) (struct seq_file *m, void *v, loff_t *pos);
  30         int (*show) (struct seq_file *m, void *v);
  31 };
  32
  33 int seq_open(struct file *, const struct seq_operations *);
  34 ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
  35 loff_t seq_lseek(struct file *, loff_t, int);
  36 int seq_release(struct inode *, struct file *);
  37 int seq_escape(struct seq_file *, const char *, const char *);
  38 int seq_putc(struct seq_file *m, char c);
  39 int seq_puts(struct seq_file *m, const char *s);
  40
  41 int seq_printf(struct seq_file *, const char *, ...)
  42         __attribute__ ((format (printf,2,3)));
  43
  44 int seq_path(struct seq_file *, struct path *, char *);
  45
  46 int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
  47 int single_release(struct inode *, struct file *);
  48 void *__seq_open_private(struct file *, const struct seq_operations *, int);
  49 int seq_open_private(struct file *, const struct seq_operations *, int);
  50 int seq_release_private(struct inode *, struct file *);
  51
  52 #define SEQ_START_TOKEN ((void *)1)
  53
  54 /*
  55  * Helpers for iteration over list_head-s in seq_files
  56  */
  57
  58 extern struct list_head *seq_list_start(struct list_head *head,
  59                 loff_t pos);
  60 extern struct list_head *seq_list_start_head(struct list_head *head,
  61                 loff_t pos);
  62 extern struct list_head *seq_list_next(void *v, struct list_head *head,
  63                 loff_t *ppos);
  64
  65 struct net;
  66 struct seq_net_private {
  67         struct net *net;
  68 };
  69
  70 int seq_open_net(struct inode *, struct file *,
  71                  const struct seq_operations *, int);
  72 int seq_release_net(struct inode *, struct file *);
  73 static inline struct net *seq_file_net(struct seq_file *seq)
  74 {
  75         return ((struct seq_net_private *)seq->private)->net;
  76 }
  77
  78 #endif
  79 #endif