include/linux/seq_file.h

   1 #ifndef _LINUX_SEQ_FILE_H
   2 #define _LINUX_SEQ_FILE_H
   3
   4 #include <linux/types.h>
   5 #include <linux/string.h>
   6 #include <linux/mutex.h>
   7
   8 struct seq_operations;
   9 struct file;
  10 struct path;
  11 struct inode;
  12 struct dentry;
  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 #define SEQ_SKIP 1
  34
  35 int seq_open(struct file *, const struct seq_operations *);
  36 ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
  37 loff_t seq_lseek(struct file *, loff_t, int);
  38 int seq_release(struct inode *, struct file *);
  39 int seq_escape(struct seq_file *, const char *, const char *);
  40 int seq_putc(struct seq_file *m, char c);
  41 int seq_puts(struct seq_file *m, const char *s);
  42
  43 int seq_printf(struct seq_file *, const char *, ...)
  44         __attribute__ ((format (printf,2,3)));
  45
  46 int seq_path(struct seq_file *, struct path *, char *);
  47 int seq_dentry(struct seq_file *, struct dentry *, char *);
  48 int seq_path_root(struct seq_file *m, struct path *path, struct path *root,
  49                   char *esc);
  50
  51 int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
  52 int single_release(struct inode *, struct file *);
  53 void *__seq_open_private(struct file *, const struct seq_operations *, int);
  54 int seq_open_private(struct file *, const struct seq_operations *, int);
  55 int seq_release_private(struct inode *, struct file *);
  56
  57 #define SEQ_START_TOKEN ((void *)1)
  58
  59 /*
  60  * Helpers for iteration over list_head-s in seq_files
  61  */
  62
  63 extern struct list_head *seq_list_start(struct list_head *head,
  64                 loff_t pos);
  65 extern struct list_head *seq_list_start_head(struct list_head *head,
  66                 loff_t pos);
  67 extern struct list_head *seq_list_next(void *v, struct list_head *head,
  68                 loff_t *ppos);
  69
  70 #endif