LXR linux/include/linux/seq

   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
  10struct seq_operations;
  11struct file;
  12struct path;
  13struct inode;
  14struct dentry;
  15
  16struct 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
  29struct 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
  38int seq_open(struct file *, const struct seq_operations *);
  39ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
  40loff_t seq_lseek(struct file *, loff_t, int);
  41int seq_release(struct inode *, struct file *);
  42int seq_escape(struct seq_file *, const char *, const char *);
  43int seq_putc(struct seq_file *m, char c);
  44int seq_puts(struct seq_file *m, const char *s);
  45
  46int seq_printf(struct seq_file *, const char *, ...)
  47        __attribute__ ((format (printf,2,3)));
  48
  49int seq_path(struct seq_file *, struct path *, char *);
  50int seq_dentry(struct seq_file *, struct dentry *, char *);
  51int seq_path_root(struct seq_file *m, struct path *path, struct path *root,
  52                  char *esc);
  53int seq_bitmap(struct seq_file *m, unsigned long *bits, unsigned int nr_bits);
  54static inline int seq_cpumask(struct seq_file *m, cpumask_t *mask)
  55{
  56        return seq_bitmap(m, mask->bits, NR_CPUS);
  57}
  58
  59static inline int seq_nodemask(struct seq_file *m, nodemask_t *mask)
  60{
  61        return seq_bitmap(m, mask->bits, MAX_NUMNODES);
  62}
  63
  64int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
  65int single_release(struct inode *, struct file *);
  66void *__seq_open_private(struct file *, const struct seq_operations *, int);
  67int seq_open_private(struct file *, const struct seq_operations *, int);
  68int seq_release_private(struct inode *, struct file *);
  69
  70#define SEQ_START_TOKEN ((void *)1)
  71
  72/*
  73 * Helpers for iteration over list_head-s in seq_files
  74 */
  75
  76extern struct list_head *seq_list_start(struct list_head *head,
  77                loff_t pos);
  78extern struct list_head *seq_list_start_head(struct list_head *head,
  79                loff_t pos);
  80extern struct list_head *seq_list_next(void *v, struct list_head *head,
  81                loff_t *ppos);
  82
  83#endif
  84