blob: 83c44eefe698ba97a72700b8cac63a37fb558c82 [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>
Paul Gortmaker187f1882011-11-23 20:12:59 -05006#include <linux/bug.h>
Ingo Molnar0ac17592006-03-23 03:00:37 -08007#include <linux/mutex.h>
Alexey Dobriyan50ac2d62008-08-12 15:09:02 -07008#include <linux/cpumask.h>
9#include <linux/nodemask.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
11struct seq_operations;
12struct file;
Jan Blunckc32c2f62008-02-14 19:38:43 -080013struct path;
Linus Torvalds1da177e2005-04-16 15:20:36 -070014struct inode;
Ram Pai6092d042008-03-27 13:06:20 +010015struct dentry;
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
17struct seq_file {
18 char *buf;
19 size_t size;
20 size_t from;
21 size_t count;
22 loff_t index;
Eric Biederman8f19d472009-02-18 14:48:16 -080023 loff_t read_pos;
Mathieu Desnoyers2b47c362007-10-16 23:27:21 -070024 u64 version;
Ingo Molnar0ac17592006-03-23 03:00:37 -080025 struct mutex lock;
Helge Deller15ad7cd2006-12-06 20:40:36 -080026 const struct seq_operations *op;
Kay Sieversf1514632011-07-12 20:48:39 +020027 int poll_event;
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 void *private;
29};
30
31struct seq_operations {
32 void * (*start) (struct seq_file *m, loff_t *pos);
33 void (*stop) (struct seq_file *m, void *v);
34 void * (*next) (struct seq_file *m, void *v, loff_t *pos);
35 int (*show) (struct seq_file *m, void *v);
36};
37
Al Viro521b5d02008-03-28 00:46:41 -040038#define SEQ_SKIP 1
39
Miklos Szeredif8439802009-09-21 14:48:36 +020040/**
41 * seq_get_buf - get buffer to write arbitrary data to
42 * @m: the seq_file handle
43 * @bufp: the beginning of the buffer is stored here
44 *
45 * Return the number of bytes available in the buffer, or zero if
46 * there's no space.
47 */
48static inline size_t seq_get_buf(struct seq_file *m, char **bufp)
49{
50 BUG_ON(m->count > m->size);
51 if (m->count < m->size)
52 *bufp = m->buf + m->count;
53 else
54 *bufp = NULL;
55
56 return m->size - m->count;
57}
58
59/**
60 * seq_commit - commit data to the buffer
61 * @m: the seq_file handle
62 * @num: the number of bytes to commit
63 *
64 * Commit @num bytes of data written to a buffer previously acquired
65 * by seq_buf_get. To signal an error condition, or that the data
66 * didn't fit in the available space, pass a negative @num value.
67 */
68static inline void seq_commit(struct seq_file *m, int num)
69{
70 if (num < 0) {
71 m->count = m->size;
72 } else {
73 BUG_ON(m->count + num > m->size);
74 m->count += num;
75 }
76}
77
Al Viro8c9379e2011-12-08 20:18:57 -050078char *mangle_path(char *s, const char *p, const char *esc);
Helge Deller15ad7cd2006-12-06 20:40:36 -080079int seq_open(struct file *, const struct seq_operations *);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
81loff_t seq_lseek(struct file *, loff_t, int);
82int seq_release(struct inode *, struct file *);
83int seq_escape(struct seq_file *, const char *, const char *);
84int seq_putc(struct seq_file *m, char c);
85int seq_puts(struct seq_file *m, const char *s);
Peter Oberparleiter0b923602009-06-17 16:28:05 -070086int seq_write(struct seq_file *seq, const void *data, size_t len);
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Joe Perchesb9075fa2011-10-31 17:11:33 -070088__printf(2, 3) int seq_printf(struct seq_file *, const char *, ...);
Steven Whitehousea4808142012-06-11 13:16:35 +010089__printf(2, 0) int seq_vprintf(struct seq_file *, const char *, va_list args);
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Al Viro8c9379e2011-12-08 20:18:57 -050091int seq_path(struct seq_file *, const struct path *, const char *);
92int seq_dentry(struct seq_file *, struct dentry *, const char *);
93int seq_path_root(struct seq_file *m, const struct path *path,
94 const struct path *root, const char *esc);
Rusty Russellcb78a0c2008-12-30 09:05:14 +103095int seq_bitmap(struct seq_file *m, const unsigned long *bits,
96 unsigned int nr_bits);
97static inline int seq_cpumask(struct seq_file *m, const struct cpumask *mask)
Alexey Dobriyan50ac2d62008-08-12 15:09:02 -070098{
Rusty Russellaf76aba2009-03-30 22:05:11 -060099 return seq_bitmap(m, cpumask_bits(mask), nr_cpu_ids);
Alexey Dobriyan50ac2d62008-08-12 15:09:02 -0700100}
101
102static inline int seq_nodemask(struct seq_file *m, nodemask_t *mask)
103{
104 return seq_bitmap(m, mask->bits, MAX_NUMNODES);
105}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106
Rusty Russellaf76aba2009-03-30 22:05:11 -0600107int seq_bitmap_list(struct seq_file *m, const unsigned long *bits,
Lai Jiangshan3eda2012008-10-18 20:28:19 -0700108 unsigned int nr_bits);
109
Rusty Russellaf76aba2009-03-30 22:05:11 -0600110static inline int seq_cpumask_list(struct seq_file *m,
111 const struct cpumask *mask)
Lai Jiangshan3eda2012008-10-18 20:28:19 -0700112{
Rusty Russellaf76aba2009-03-30 22:05:11 -0600113 return seq_bitmap_list(m, cpumask_bits(mask), nr_cpu_ids);
Lai Jiangshan3eda2012008-10-18 20:28:19 -0700114}
115
116static inline int seq_nodemask_list(struct seq_file *m, nodemask_t *mask)
117{
118 return seq_bitmap_list(m, mask->bits, MAX_NUMNODES);
119}
120
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
122int single_release(struct inode *, struct file *);
Pavel Emelyanov39699032007-10-10 02:28:42 -0700123void *__seq_open_private(struct file *, const struct seq_operations *, int);
124int seq_open_private(struct file *, const struct seq_operations *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125int seq_release_private(struct inode *, struct file *);
KAMEZAWA Hiroyuki1ac101a2012-03-23 15:02:54 -0700126int seq_put_decimal_ull(struct seq_file *m, char delimiter,
127 unsigned long long num);
KAMEZAWA Hiroyukibda7bad2012-03-23 15:02:54 -0700128int seq_put_decimal_ll(struct seq_file *m, char delimiter,
129 long long num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131#define SEQ_START_TOKEN ((void *)1)
Pavel Emelianovbcf67e12007-07-10 17:22:26 -0700132/*
133 * Helpers for iteration over list_head-s in seq_files
134 */
135
136extern struct list_head *seq_list_start(struct list_head *head,
137 loff_t pos);
138extern struct list_head *seq_list_start_head(struct list_head *head,
139 loff_t pos);
140extern struct list_head *seq_list_next(void *v, struct list_head *head,
141 loff_t *ppos);
142
Li Zefan66655de2010-02-08 23:18:22 +0000143/*
144 * Helpers for iteration over hlist_head-s in seq_files
145 */
146
147extern struct hlist_node *seq_hlist_start(struct hlist_head *head,
stephen hemminger1cc52322010-02-22 07:57:17 +0000148 loff_t pos);
Li Zefan66655de2010-02-08 23:18:22 +0000149extern struct hlist_node *seq_hlist_start_head(struct hlist_head *head,
stephen hemminger1cc52322010-02-22 07:57:17 +0000150 loff_t pos);
Li Zefan66655de2010-02-08 23:18:22 +0000151extern struct hlist_node *seq_hlist_next(void *v, struct hlist_head *head,
stephen hemminger1cc52322010-02-22 07:57:17 +0000152 loff_t *ppos);
Li Zefan66655de2010-02-08 23:18:22 +0000153
stephen hemminger1cc52322010-02-22 07:57:17 +0000154extern struct hlist_node *seq_hlist_start_rcu(struct hlist_head *head,
155 loff_t pos);
156extern struct hlist_node *seq_hlist_start_head_rcu(struct hlist_head *head,
157 loff_t pos);
158extern struct hlist_node *seq_hlist_next_rcu(void *v,
159 struct hlist_head *head,
160 loff_t *ppos);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161#endif