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