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 #include <linux/cpumask.h>
   8 #include <linux/nodemask.h>
   9
  10 struct seq_operations;
  11 struct file;
  12 struct path;
  13 struct inode;
  14 struct dentry;
  15
  16 struct seq_file {
  17         char *buf;
  18         size_t size;
  19         size_t from;
  20         size_t count;
  21         loff_t index;
  22         loff_t read_pos;
  23         u64 version;
  24         struct mutex lock;
  25         const struct seq_operations *op;
  26         void *private;
  27 };
  28
  29 struct seq_operations {
  30         void * (*start) (struct seq_file *m, loff_t *pos);
  31         void (*stop) (struct seq_file *m, void *v);
  32         void * (*next) (struct seq_file *m, void *v, loff_t *pos);
  33         int (*show) (struct seq_file *m, void *v);
  34 };
  35
  36 #define SEQ_SKIP 1
  37
  38 char *mangle_path(char *s, char *p, char *esc);
  39 int seq_open(struct file *, const struct seq_operations *);
  40 ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
  41 loff_t seq_lseek(struct file *, loff_t, int);
  42 int seq_release(struct inode *, struct file *);
  43 int seq_escape(struct seq_file *, const char *, const char *);
  44 int seq_putc(struct seq_file *m, char c);
  45 int seq_puts(struct seq_file *m, const char *s);
  46 int seq_write(struct seq_file *seq, const void *data, size_t len);
  47
  48 int seq_printf(struct seq_file *, const char *, ...)
  49         __attribute__ ((format (printf,2,3)));
  50
  51 int seq_path(struct seq_file *, struct path *, char *);
  52 int seq_dentry(struct seq_file *, struct dentry *, char *);
  53 int seq_path_root(struct seq_file *m, struct path *path, struct path *root,
  54                   char *esc);
  55 int seq_bitmap(struct seq_file *m, const unsigned long *bits,
  56                                    unsigned int nr_bits);
  57 static inline int seq_cpumask(struct seq_file *m, const struct cpumask *mask)
  58 {
  59         return seq_bitmap(m, cpumask_bits(mask), nr_cpu_ids);
  60 }
  61
  62 static inline int seq_nodemask(struct seq_file *m, nodemask_t *mask)
  63 {
  64         return seq_bitmap(m, mask->bits, MAX_NUMNODES);
  65 }
  66
  67 int seq_bitmap_list(struct seq_file *m, const unsigned long *bits,
  68                 unsigned int nr_bits);
  69
  70 static inline int seq_cpumask_list(struct seq_file *m,
  71                                    const struct cpumask *mask)
  72 {
  73         return seq_bitmap_list(m, cpumask_bits(mask), nr_cpu_ids);
  74 }
  75
  76 static inline int seq_nodemask_list(struct seq_file *m, nodemask_t *mask)
  77 {
  78         return seq_bitmap_list(m, mask->bits, MAX_NUMNODES);
  79 }
  80
  81 int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
  82 int single_release(struct inode *, struct file *);
  83 void *__seq_open_private(struct file *, const struct seq_operations *, int);
  84 int seq_open_private(struct file *, const struct seq_operations *, int);
  85 int seq_release_private(struct inode *, struct file *);
  86
  87 #define SEQ_START_TOKEN ((void *)1)
  88
  89 /*
  90  * Helpers for iteration over list_head-s in seq_files
  91  */
  92
  93 extern struct list_head *seq_list_start(struct list_head *head,
  94                 loff_t pos);
  95 extern struct list_head *seq_list_start_head(struct list_head *head,
  96                 loff_t pos);
  97 extern struct list_head *seq_list_next(void *v, struct list_head *head,
  98                 loff_t *ppos);
  99
 100 #endif