blob: 5b5369c3c209c66c904f2a505e1bdaf8e0cbac56 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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>
Ingo Molnar0ac17592006-03-23 03:00:37 -08007#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008
9struct seq_operations;
10struct file;
Jan Blunckc32c2f62008-02-14 19:38:43 -080011struct path;
Linus Torvalds1da177e2005-04-16 15:20:36 -070012struct inode;
Ram Pai6092d042008-03-27 13:06:20 +010013struct dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070014
15struct seq_file {
16 char *buf;
17 size_t size;
18 size_t from;
19 size_t count;
20 loff_t index;
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -070021 u64 version;
Ingo Molnar0ac17592006-03-23 03:00:37 -080022 struct mutex lock;
Helge Deller15ad7cd2006-12-06 20:40:36 -080023 const struct seq_operations *op;
Linus Torvalds1da177e2005-04-16 15:20:36 -070024 void *private;
25};
26
27struct 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
Al Viro521b5d02008-03-28 00:46:41 -040034#define SEQ_SKIP 1
35
Helge Deller15ad7cd2006-12-06 20:40:36 -080036int seq_open(struct file *, const struct seq_operations *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070037ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
38loff_t seq_lseek(struct file *, loff_t, int);
39int seq_release(struct inode *, struct file *);
40int seq_escape(struct seq_file *, const char *, const char *);
41int seq_putc(struct seq_file *m, char c);
42int seq_puts(struct seq_file *m, const char *s);
43
44int seq_printf(struct seq_file *, const char *, ...)
45 __attribute__ ((format (printf,2,3)));
46
Jan Blunckc32c2f62008-02-14 19:38:43 -080047int seq_path(struct seq_file *, struct path *, char *);
Ram Pai6092d042008-03-27 13:06:20 +010048int seq_dentry(struct seq_file *, struct dentry *, char *);
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +010049int seq_path_root(struct seq_file *m, struct path *path, struct path *root,
50 char *esc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
53int single_release(struct inode *, struct file *);
Pavel Emelyanov39699032007-10-10 02:28:42 -070054void *__seq_open_private(struct file *, const struct seq_operations *, int);
55int seq_open_private(struct file *, const struct seq_operations *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070056int seq_release_private(struct inode *, struct file *);
57
58#define SEQ_START_TOKEN ((void *)1)
59
Pavel Emelianovbcf67e12007-07-10 17:22:26 -070060/*
61 * Helpers for iteration over list_head-s in seq_files
62 */
63
64extern struct list_head *seq_list_start(struct list_head *head,
65 loff_t pos);
66extern struct list_head *seq_list_start_head(struct list_head *head,
67 loff_t pos);
68extern struct list_head *seq_list_next(void *v, struct list_head *head,
69 loff_t *ppos);
70
Linus Torvalds1da177e2005-04-16 15:20:36 -070071#endif
72#endif