blob: a66304a09955b0d36e7b7f67193657a444355e77 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_SEQ_FILE_H
2#define _LINUX_SEQ_FILE_H
Linus Torvalds1da177e2005-04-16 15:20:36 -07003
4#include <linux/types.h>
5#include <linux/string.h>
Ingo Molnar0ac17592006-03-23 03:00:37 -08006#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007
8struct seq_operations;
9struct file;
Jan Blunckc32c2f62008-02-14 19:38:43 -080010struct path;
Linus Torvalds1da177e2005-04-16 15:20:36 -070011struct inode;
Ram Pai6092d042008-03-27 13:06:20 +010012struct dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
14struct seq_file {
15 char *buf;
16 size_t size;
17 size_t from;
18 size_t count;
19 loff_t index;
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -070020 u64 version;
Ingo Molnar0ac17592006-03-23 03:00:37 -080021 struct mutex lock;
Helge Deller15ad7cd2006-12-06 20:40:36 -080022 const struct seq_operations *op;
Linus Torvalds1da177e2005-04-16 15:20:36 -070023 void *private;
24};
25
26struct 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
Al Viro521b5d02008-03-28 00:46:41 -040033#define SEQ_SKIP 1
34
Helge Deller15ad7cd2006-12-06 20:40:36 -080035int seq_open(struct file *, const struct seq_operations *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070036ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
37loff_t seq_lseek(struct file *, loff_t, int);
38int seq_release(struct inode *, struct file *);
39int seq_escape(struct seq_file *, const char *, const char *);
40int seq_putc(struct seq_file *m, char c);
41int seq_puts(struct seq_file *m, const char *s);
42
43int seq_printf(struct seq_file *, const char *, ...)
44 __attribute__ ((format (printf,2,3)));
45
Jan Blunckc32c2f62008-02-14 19:38:43 -080046int seq_path(struct seq_file *, struct path *, char *);
Ram Pai6092d042008-03-27 13:06:20 +010047int seq_dentry(struct seq_file *, struct dentry *, char *);
Miklos Szeredi9d1bc6012008-03-27 13:06:21 +010048int seq_path_root(struct seq_file *m, struct path *path, struct path *root,
49 char *esc);
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
51int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
52int single_release(struct inode *, struct file *);
Pavel Emelyanov39699032007-10-10 02:28:42 -070053void *__seq_open_private(struct file *, const struct seq_operations *, int);
54int seq_open_private(struct file *, const struct seq_operations *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070055int seq_release_private(struct inode *, struct file *);
56
57#define SEQ_START_TOKEN ((void *)1)
58
Pavel Emelianovbcf67e12007-07-10 17:22:26 -070059/*
60 * Helpers for iteration over list_head-s in seq_files
61 */
62
63extern struct list_head *seq_list_start(struct list_head *head,
64 loff_t pos);
65extern struct list_head *seq_list_start_head(struct list_head *head,
66 loff_t pos);
67extern struct list_head *seq_list_next(void *v, struct list_head *head,
68 loff_t *ppos);
69
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#endif