Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #ifndef _LINUX_SEQ_FILE_H |
2 | #define _LINUX_SEQ_FILE_H | |
1da177e4 LT |
3 | |
4 | #include <linux/types.h> | |
5 | #include <linux/string.h> | |
187f1882 | 6 | #include <linux/bug.h> |
0ac1759a | 7 | #include <linux/mutex.h> |
50ac2d69 AD |
8 | #include <linux/cpumask.h> |
9 | #include <linux/nodemask.h> | |
1da177e4 LT |
10 | |
11 | struct seq_operations; | |
12 | struct file; | |
c32c2f63 | 13 | struct path; |
1da177e4 | 14 | struct inode; |
6092d048 | 15 | struct dentry; |
adb37c4c | 16 | struct user_namespace; |
1da177e4 LT |
17 | |
18 | struct seq_file { | |
19 | char *buf; | |
20 | size_t size; | |
21 | size_t from; | |
22 | size_t count; | |
839cc2a9 | 23 | size_t pad_until; |
1da177e4 | 24 | loff_t index; |
8f19d472 | 25 | loff_t read_pos; |
2b47c361 | 26 | u64 version; |
0ac1759a | 27 | struct mutex lock; |
15ad7cdc | 28 | const struct seq_operations *op; |
f1514638 | 29 | int poll_event; |
adb37c4c EB |
30 | #ifdef CONFIG_USER_NS |
31 | struct user_namespace *user_ns; | |
32 | #endif | |
1da177e4 LT |
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 | ||
521b5d0c AV |
43 | #define SEQ_SKIP 1 |
44 | ||
1f33c41c JP |
45 | /** |
46 | * seq_has_overflowed - check if the buffer has overflowed | |
47 | * @m: the seq_file handle | |
48 | * | |
49 | * seq_files have a buffer which may overflow. When this happens a larger | |
50 | * buffer is reallocated and all the data will be printed again. | |
51 | * The overflow state is true when m->count == m->size. | |
52 | * | |
53 | * Returns true if the buffer received more than it can hold. | |
54 | */ | |
55 | static inline bool seq_has_overflowed(struct seq_file *m) | |
56 | { | |
57 | return m->count == m->size; | |
58 | } | |
59 | ||
f8439806 MS |
60 | /** |
61 | * seq_get_buf - get buffer to write arbitrary data to | |
62 | * @m: the seq_file handle | |
63 | * @bufp: the beginning of the buffer is stored here | |
64 | * | |
65 | * Return the number of bytes available in the buffer, or zero if | |
66 | * there's no space. | |
67 | */ | |
68 | static inline size_t seq_get_buf(struct seq_file *m, char **bufp) | |
69 | { | |
70 | BUG_ON(m->count > m->size); | |
71 | if (m->count < m->size) | |
72 | *bufp = m->buf + m->count; | |
73 | else | |
74 | *bufp = NULL; | |
75 | ||
76 | return m->size - m->count; | |
77 | } | |
78 | ||
79 | /** | |
80 | * seq_commit - commit data to the buffer | |
81 | * @m: the seq_file handle | |
82 | * @num: the number of bytes to commit | |
83 | * | |
84 | * Commit @num bytes of data written to a buffer previously acquired | |
85 | * by seq_buf_get. To signal an error condition, or that the data | |
86 | * didn't fit in the available space, pass a negative @num value. | |
87 | */ | |
88 | static inline void seq_commit(struct seq_file *m, int num) | |
89 | { | |
90 | if (num < 0) { | |
91 | m->count = m->size; | |
92 | } else { | |
93 | BUG_ON(m->count + num > m->size); | |
94 | m->count += num; | |
95 | } | |
96 | } | |
97 | ||
839cc2a9 TH |
98 | /** |
99 | * seq_setwidth - set padding width | |
100 | * @m: the seq_file handle | |
101 | * @size: the max number of bytes to pad. | |
102 | * | |
103 | * Call seq_setwidth() for setting max width, then call seq_printf() etc. and | |
104 | * finally call seq_pad() to pad the remaining bytes. | |
105 | */ | |
106 | static inline void seq_setwidth(struct seq_file *m, size_t size) | |
107 | { | |
108 | m->pad_until = m->count + size; | |
109 | } | |
110 | void seq_pad(struct seq_file *m, char c); | |
111 | ||
8c9379e9 | 112 | char *mangle_path(char *s, const char *p, const char *esc); |
15ad7cdc | 113 | int seq_open(struct file *, const struct seq_operations *); |
1da177e4 LT |
114 | ssize_t seq_read(struct file *, char __user *, size_t, loff_t *); |
115 | loff_t seq_lseek(struct file *, loff_t, int); | |
116 | int seq_release(struct inode *, struct file *); | |
117 | int seq_escape(struct seq_file *, const char *, const char *); | |
118 | int seq_putc(struct seq_file *m, char c); | |
119 | int seq_puts(struct seq_file *m, const char *s); | |
0b923606 | 120 | int seq_write(struct seq_file *seq, const void *data, size_t len); |
1da177e4 | 121 | |
b9075fa9 | 122 | __printf(2, 3) int seq_printf(struct seq_file *, const char *, ...); |
a4808147 | 123 | __printf(2, 0) int seq_vprintf(struct seq_file *, const char *, va_list args); |
1da177e4 | 124 | |
8c9379e9 AV |
125 | int seq_path(struct seq_file *, const struct path *, const char *); |
126 | int seq_dentry(struct seq_file *, struct dentry *, const char *); | |
127 | int seq_path_root(struct seq_file *m, const struct path *path, | |
128 | const struct path *root, const char *esc); | |
3eda2011 | 129 | |
1da177e4 | 130 | int single_open(struct file *, int (*)(struct seq_file *, void *), void *); |
2043f495 | 131 | int single_open_size(struct file *, int (*)(struct seq_file *, void *), void *, size_t); |
1da177e4 | 132 | int single_release(struct inode *, struct file *); |
39699037 PE |
133 | void *__seq_open_private(struct file *, const struct seq_operations *, int); |
134 | int seq_open_private(struct file *, const struct seq_operations *, int); | |
1da177e4 | 135 | int seq_release_private(struct inode *, struct file *); |
1ac101a5 KH |
136 | int seq_put_decimal_ull(struct seq_file *m, char delimiter, |
137 | unsigned long long num); | |
bda7bad6 KH |
138 | int seq_put_decimal_ll(struct seq_file *m, char delimiter, |
139 | long long num); | |
1da177e4 | 140 | |
adb37c4c EB |
141 | static inline struct user_namespace *seq_user_ns(struct seq_file *seq) |
142 | { | |
143 | #ifdef CONFIG_USER_NS | |
144 | return seq->user_ns; | |
145 | #else | |
146 | extern struct user_namespace init_user_ns; | |
147 | return &init_user_ns; | |
148 | #endif | |
149 | } | |
150 | ||
1da177e4 | 151 | #define SEQ_START_TOKEN ((void *)1) |
bcf67e16 PE |
152 | /* |
153 | * Helpers for iteration over list_head-s in seq_files | |
154 | */ | |
155 | ||
156 | extern struct list_head *seq_list_start(struct list_head *head, | |
157 | loff_t pos); | |
158 | extern struct list_head *seq_list_start_head(struct list_head *head, | |
159 | loff_t pos); | |
160 | extern struct list_head *seq_list_next(void *v, struct list_head *head, | |
161 | loff_t *ppos); | |
162 | ||
66655de6 LZ |
163 | /* |
164 | * Helpers for iteration over hlist_head-s in seq_files | |
165 | */ | |
166 | ||
167 | extern struct hlist_node *seq_hlist_start(struct hlist_head *head, | |
1cc52327 | 168 | loff_t pos); |
66655de6 | 169 | extern struct hlist_node *seq_hlist_start_head(struct hlist_head *head, |
1cc52327 | 170 | loff_t pos); |
66655de6 | 171 | extern struct hlist_node *seq_hlist_next(void *v, struct hlist_head *head, |
1cc52327 | 172 | loff_t *ppos); |
173 | ||
174 | extern struct hlist_node *seq_hlist_start_rcu(struct hlist_head *head, | |
175 | loff_t pos); | |
176 | extern struct hlist_node *seq_hlist_start_head_rcu(struct hlist_head *head, | |
177 | loff_t pos); | |
178 | extern struct hlist_node *seq_hlist_next_rcu(void *v, | |
179 | struct hlist_head *head, | |
180 | loff_t *ppos); | |
0bc77381 JL |
181 | |
182 | /* Helpers for iterating over per-cpu hlist_head-s in seq_files */ | |
183 | extern struct hlist_node *seq_hlist_start_percpu(struct hlist_head __percpu *head, int *cpu, loff_t pos); | |
184 | ||
185 | extern struct hlist_node *seq_hlist_next_percpu(void *v, struct hlist_head __percpu *head, int *cpu, loff_t *pos); | |
186 | ||
1da177e4 | 187 | #endif |