blob: 5da70c3f4417ef857e9d9ed6fba2d70cc9bcfcc5 [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>
YOSHIFUJI Hideaki12188542008-03-26 02:36:06 +09008#include <net/net_namespace.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07009
10struct seq_operations;
11struct file;
Jan Blunckc32c2f62008-02-14 19:38:43 -080012struct path;
Linus Torvalds1da177e2005-04-16 15:20:36 -070013struct inode;
14
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
Helge Deller15ad7cd2006-12-06 20:40:36 -080034int seq_open(struct file *, const struct seq_operations *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070035ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
36loff_t seq_lseek(struct file *, loff_t, int);
37int seq_release(struct inode *, struct file *);
38int seq_escape(struct seq_file *, const char *, const char *);
39int seq_putc(struct seq_file *m, char c);
40int seq_puts(struct seq_file *m, const char *s);
41
42int seq_printf(struct seq_file *, const char *, ...)
43 __attribute__ ((format (printf,2,3)));
44
Jan Blunckc32c2f62008-02-14 19:38:43 -080045int seq_path(struct seq_file *, struct path *, char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070046
47int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
48int single_release(struct inode *, struct file *);
Pavel Emelyanov39699032007-10-10 02:28:42 -070049void *__seq_open_private(struct file *, const struct seq_operations *, int);
50int seq_open_private(struct file *, const struct seq_operations *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051int seq_release_private(struct inode *, struct file *);
52
53#define SEQ_START_TOKEN ((void *)1)
54
Pavel Emelianovbcf67e12007-07-10 17:22:26 -070055/*
56 * Helpers for iteration over list_head-s in seq_files
57 */
58
59extern struct list_head *seq_list_start(struct list_head *head,
60 loff_t pos);
61extern struct list_head *seq_list_start_head(struct list_head *head,
62 loff_t pos);
63extern struct list_head *seq_list_next(void *v, struct list_head *head,
64 loff_t *ppos);
65
Denis V. Lunev0e5f8be2008-03-27 14:25:53 -070066#ifdef CONFIG_NET
Denis V. Luneve372c412007-11-19 22:31:54 -080067struct net;
68struct seq_net_private {
YOSHIFUJI Hideaki12188542008-03-26 02:36:06 +090069#ifdef CONFIG_NET_NS
Denis V. Luneve372c412007-11-19 22:31:54 -080070 struct net *net;
YOSHIFUJI Hideaki12188542008-03-26 02:36:06 +090071#endif
Denis V. Luneve372c412007-11-19 22:31:54 -080072};
73
74int seq_open_net(struct inode *, struct file *,
75 const struct seq_operations *, int);
76int seq_release_net(struct inode *, struct file *);
77static inline struct net *seq_file_net(struct seq_file *seq)
78{
YOSHIFUJI Hideaki12188542008-03-26 02:36:06 +090079#ifdef CONFIG_NET_NS
Denis V. Luneve372c412007-11-19 22:31:54 -080080 return ((struct seq_net_private *)seq->private)->net;
YOSHIFUJI Hideaki12188542008-03-26 02:36:06 +090081#else
82 return &init_net;
83#endif
Denis V. Luneve372c412007-11-19 22:31:54 -080084}
Denis V. Lunev0e5f8be2008-03-27 14:25:53 -070085#endif /* CONFIG_NET */
Denis V. Luneve372c412007-11-19 22:31:54 -080086
Linus Torvalds1da177e2005-04-16 15:20:36 -070087#endif
88#endif