Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | #ifndef _LINUX_SEQ_FILE_H |
| 2 | #define _LINUX_SEQ_FILE_H |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 3 | |
| 4 | #include <linux/types.h> |
| 5 | #include <linux/string.h> |
Paul Gortmaker | 187f188 | 2011-11-23 20:12:59 -0500 | [diff] [blame] | 6 | #include <linux/bug.h> |
Ingo Molnar | 0ac1759 | 2006-03-23 03:00:37 -0800 | [diff] [blame] | 7 | #include <linux/mutex.h> |
Alexey Dobriyan | 50ac2d6 | 2008-08-12 15:09:02 -0700 | [diff] [blame] | 8 | #include <linux/cpumask.h> |
| 9 | #include <linux/nodemask.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 10 | |
| 11 | struct seq_operations; |
| 12 | struct file; |
Jan Blunck | c32c2f6 | 2008-02-14 19:38:43 -0800 | [diff] [blame] | 13 | struct path; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 14 | struct inode; |
Ram Pai | 6092d04 | 2008-03-27 13:06:20 +0100 | [diff] [blame] | 15 | struct dentry; |
Eric W. Biederman | adb37c4 | 2012-05-23 18:01:20 -0600 | [diff] [blame] | 16 | struct user_namespace; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 17 | |
| 18 | struct seq_file { |
| 19 | char *buf; |
| 20 | size_t size; |
| 21 | size_t from; |
| 22 | size_t count; |
Tetsuo Handa | 839cc2a | 2013-11-14 14:31:56 -0800 | [diff] [blame] | 23 | size_t pad_until; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 24 | loff_t index; |
Eric Biederman | 8f19d47 | 2009-02-18 14:48:16 -0800 | [diff] [blame] | 25 | loff_t read_pos; |
Mathieu Desnoyers | 2b47c36 | 2007-10-16 23:27:21 -0700 | [diff] [blame] | 26 | u64 version; |
Ingo Molnar | 0ac1759 | 2006-03-23 03:00:37 -0800 | [diff] [blame] | 27 | struct mutex lock; |
Helge Deller | 15ad7cd | 2006-12-06 20:40:36 -0800 | [diff] [blame] | 28 | const struct seq_operations *op; |
Kay Sievers | f151463 | 2011-07-12 20:48:39 +0200 | [diff] [blame] | 29 | int poll_event; |
Eric W. Biederman | adb37c4 | 2012-05-23 18:01:20 -0600 | [diff] [blame] | 30 | #ifdef CONFIG_USER_NS |
| 31 | struct user_namespace *user_ns; |
| 32 | #endif |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 33 | void *private; |
| 34 | }; |
| 35 | |
| 36 | struct seq_operations { |
| 37 | void * (*start) (struct seq_file *m, loff_t *pos); |
| 38 | void (*stop) (struct seq_file *m, void *v); |
| 39 | void * (*next) (struct seq_file *m, void *v, loff_t *pos); |
| 40 | int (*show) (struct seq_file *m, void *v); |
| 41 | }; |
| 42 | |
Al Viro | 521b5d0 | 2008-03-28 00:46:41 -0400 | [diff] [blame] | 43 | #define SEQ_SKIP 1 |
| 44 | |
Miklos Szeredi | f843980 | 2009-09-21 14:48:36 +0200 | [diff] [blame] | 45 | /** |
| 46 | * seq_get_buf - get buffer to write arbitrary data to |
| 47 | * @m: the seq_file handle |
| 48 | * @bufp: the beginning of the buffer is stored here |
| 49 | * |
| 50 | * Return the number of bytes available in the buffer, or zero if |
| 51 | * there's no space. |
| 52 | */ |
| 53 | static inline size_t seq_get_buf(struct seq_file *m, char **bufp) |
| 54 | { |
| 55 | BUG_ON(m->count > m->size); |
| 56 | if (m->count < m->size) |
| 57 | *bufp = m->buf + m->count; |
| 58 | else |
| 59 | *bufp = NULL; |
| 60 | |
| 61 | return m->size - m->count; |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * seq_commit - commit data to the buffer |
| 66 | * @m: the seq_file handle |
| 67 | * @num: the number of bytes to commit |
| 68 | * |
| 69 | * Commit @num bytes of data written to a buffer previously acquired |
| 70 | * by seq_buf_get. To signal an error condition, or that the data |
| 71 | * didn't fit in the available space, pass a negative @num value. |
| 72 | */ |
| 73 | static inline void seq_commit(struct seq_file *m, int num) |
| 74 | { |
| 75 | if (num < 0) { |
| 76 | m->count = m->size; |
| 77 | } else { |
| 78 | BUG_ON(m->count + num > m->size); |
| 79 | m->count += num; |
| 80 | } |
| 81 | } |
| 82 | |
Tetsuo Handa | 839cc2a | 2013-11-14 14:31:56 -0800 | [diff] [blame] | 83 | /** |
| 84 | * seq_setwidth - set padding width |
| 85 | * @m: the seq_file handle |
| 86 | * @size: the max number of bytes to pad. |
| 87 | * |
| 88 | * Call seq_setwidth() for setting max width, then call seq_printf() etc. and |
| 89 | * finally call seq_pad() to pad the remaining bytes. |
| 90 | */ |
| 91 | static inline void seq_setwidth(struct seq_file *m, size_t size) |
| 92 | { |
| 93 | m->pad_until = m->count + size; |
| 94 | } |
| 95 | void seq_pad(struct seq_file *m, char c); |
| 96 | |
Al Viro | 8c9379e | 2011-12-08 20:18:57 -0500 | [diff] [blame] | 97 | char *mangle_path(char *s, const char *p, const char *esc); |
Helge Deller | 15ad7cd | 2006-12-06 20:40:36 -0800 | [diff] [blame] | 98 | int seq_open(struct file *, const struct seq_operations *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 99 | ssize_t seq_read(struct file *, char __user *, size_t, loff_t *); |
| 100 | loff_t seq_lseek(struct file *, loff_t, int); |
| 101 | int seq_release(struct inode *, struct file *); |
| 102 | int seq_escape(struct seq_file *, const char *, const char *); |
| 103 | int seq_putc(struct seq_file *m, char c); |
| 104 | int seq_puts(struct seq_file *m, const char *s); |
Peter Oberparleiter | 0b92360 | 2009-06-17 16:28:05 -0700 | [diff] [blame] | 105 | int seq_write(struct seq_file *seq, const void *data, size_t len); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 106 | |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 107 | __printf(2, 3) int seq_printf(struct seq_file *, const char *, ...); |
Steven Whitehouse | a480814 | 2012-06-11 13:16:35 +0100 | [diff] [blame] | 108 | __printf(2, 0) int seq_vprintf(struct seq_file *, const char *, va_list args); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 109 | |
Al Viro | 8c9379e | 2011-12-08 20:18:57 -0500 | [diff] [blame] | 110 | int seq_path(struct seq_file *, const struct path *, const char *); |
| 111 | int seq_dentry(struct seq_file *, struct dentry *, const char *); |
| 112 | int seq_path_root(struct seq_file *m, const struct path *path, |
| 113 | const struct path *root, const char *esc); |
Rusty Russell | cb78a0c | 2008-12-30 09:05:14 +1030 | [diff] [blame] | 114 | int seq_bitmap(struct seq_file *m, const unsigned long *bits, |
| 115 | unsigned int nr_bits); |
| 116 | static inline int seq_cpumask(struct seq_file *m, const struct cpumask *mask) |
Alexey Dobriyan | 50ac2d6 | 2008-08-12 15:09:02 -0700 | [diff] [blame] | 117 | { |
Rusty Russell | af76aba | 2009-03-30 22:05:11 -0600 | [diff] [blame] | 118 | return seq_bitmap(m, cpumask_bits(mask), nr_cpu_ids); |
Alexey Dobriyan | 50ac2d6 | 2008-08-12 15:09:02 -0700 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | static inline int seq_nodemask(struct seq_file *m, nodemask_t *mask) |
| 122 | { |
| 123 | return seq_bitmap(m, mask->bits, MAX_NUMNODES); |
| 124 | } |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 125 | |
Rusty Russell | af76aba | 2009-03-30 22:05:11 -0600 | [diff] [blame] | 126 | int seq_bitmap_list(struct seq_file *m, const unsigned long *bits, |
Lai Jiangshan | 3eda201 | 2008-10-18 20:28:19 -0700 | [diff] [blame] | 127 | unsigned int nr_bits); |
| 128 | |
Rusty Russell | af76aba | 2009-03-30 22:05:11 -0600 | [diff] [blame] | 129 | static inline int seq_cpumask_list(struct seq_file *m, |
| 130 | const struct cpumask *mask) |
Lai Jiangshan | 3eda201 | 2008-10-18 20:28:19 -0700 | [diff] [blame] | 131 | { |
Rusty Russell | af76aba | 2009-03-30 22:05:11 -0600 | [diff] [blame] | 132 | return seq_bitmap_list(m, cpumask_bits(mask), nr_cpu_ids); |
Lai Jiangshan | 3eda201 | 2008-10-18 20:28:19 -0700 | [diff] [blame] | 133 | } |
| 134 | |
| 135 | static inline int seq_nodemask_list(struct seq_file *m, nodemask_t *mask) |
| 136 | { |
| 137 | return seq_bitmap_list(m, mask->bits, MAX_NUMNODES); |
| 138 | } |
| 139 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 140 | int single_open(struct file *, int (*)(struct seq_file *, void *), void *); |
Al Viro | 2043f49 | 2013-03-31 13:43:23 -0400 | [diff] [blame] | 141 | int single_open_size(struct file *, int (*)(struct seq_file *, void *), void *, size_t); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 142 | int single_release(struct inode *, struct file *); |
Pavel Emelyanov | 3969903 | 2007-10-10 02:28:42 -0700 | [diff] [blame] | 143 | void *__seq_open_private(struct file *, const struct seq_operations *, int); |
| 144 | int seq_open_private(struct file *, const struct seq_operations *, int); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 145 | int seq_release_private(struct inode *, struct file *); |
KAMEZAWA Hiroyuki | 1ac101a | 2012-03-23 15:02:54 -0700 | [diff] [blame] | 146 | int seq_put_decimal_ull(struct seq_file *m, char delimiter, |
| 147 | unsigned long long num); |
KAMEZAWA Hiroyuki | bda7bad | 2012-03-23 15:02:54 -0700 | [diff] [blame] | 148 | int seq_put_decimal_ll(struct seq_file *m, char delimiter, |
| 149 | long long num); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 150 | |
Eric W. Biederman | adb37c4 | 2012-05-23 18:01:20 -0600 | [diff] [blame] | 151 | static inline struct user_namespace *seq_user_ns(struct seq_file *seq) |
| 152 | { |
| 153 | #ifdef CONFIG_USER_NS |
| 154 | return seq->user_ns; |
| 155 | #else |
| 156 | extern struct user_namespace init_user_ns; |
| 157 | return &init_user_ns; |
| 158 | #endif |
| 159 | } |
| 160 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 161 | #define SEQ_START_TOKEN ((void *)1) |
Pavel Emelianov | bcf67e1 | 2007-07-10 17:22:26 -0700 | [diff] [blame] | 162 | /* |
| 163 | * Helpers for iteration over list_head-s in seq_files |
| 164 | */ |
| 165 | |
| 166 | extern struct list_head *seq_list_start(struct list_head *head, |
| 167 | loff_t pos); |
| 168 | extern struct list_head *seq_list_start_head(struct list_head *head, |
| 169 | loff_t pos); |
| 170 | extern struct list_head *seq_list_next(void *v, struct list_head *head, |
| 171 | loff_t *ppos); |
| 172 | |
Li Zefan | 66655de | 2010-02-08 23:18:22 +0000 | [diff] [blame] | 173 | /* |
| 174 | * Helpers for iteration over hlist_head-s in seq_files |
| 175 | */ |
| 176 | |
| 177 | extern struct hlist_node *seq_hlist_start(struct hlist_head *head, |
stephen hemminger | 1cc5232 | 2010-02-22 07:57:17 +0000 | [diff] [blame] | 178 | loff_t pos); |
Li Zefan | 66655de | 2010-02-08 23:18:22 +0000 | [diff] [blame] | 179 | extern struct hlist_node *seq_hlist_start_head(struct hlist_head *head, |
stephen hemminger | 1cc5232 | 2010-02-22 07:57:17 +0000 | [diff] [blame] | 180 | loff_t pos); |
Li Zefan | 66655de | 2010-02-08 23:18:22 +0000 | [diff] [blame] | 181 | extern struct hlist_node *seq_hlist_next(void *v, struct hlist_head *head, |
stephen hemminger | 1cc5232 | 2010-02-22 07:57:17 +0000 | [diff] [blame] | 182 | loff_t *ppos); |
Li Zefan | 66655de | 2010-02-08 23:18:22 +0000 | [diff] [blame] | 183 | |
stephen hemminger | 1cc5232 | 2010-02-22 07:57:17 +0000 | [diff] [blame] | 184 | extern struct hlist_node *seq_hlist_start_rcu(struct hlist_head *head, |
| 185 | loff_t pos); |
| 186 | extern struct hlist_node *seq_hlist_start_head_rcu(struct hlist_head *head, |
| 187 | loff_t pos); |
| 188 | extern struct hlist_node *seq_hlist_next_rcu(void *v, |
| 189 | struct hlist_head *head, |
| 190 | loff_t *ppos); |
Jeff Layton | 0bc7738 | 2013-06-21 08:58:21 -0400 | [diff] [blame] | 191 | |
| 192 | /* Helpers for iterating over per-cpu hlist_head-s in seq_files */ |
| 193 | extern struct hlist_node *seq_hlist_start_percpu(struct hlist_head __percpu *head, int *cpu, loff_t pos); |
| 194 | |
| 195 | extern struct hlist_node *seq_hlist_next_percpu(void *v, struct hlist_head __percpu *head, int *cpu, loff_t *pos); |
| 196 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 197 | #endif |