Loading...
1#ifndef _LINUX_SEQ_FILE_H
2#define _LINUX_SEQ_FILE_H
3
4#include <linux/types.h>
5#include <linux/string.h>
6#include <linux/bug.h>
7#include <linux/mutex.h>
8#include <linux/cpumask.h>
9#include <linux/nodemask.h>
10
11struct seq_operations;
12struct file;
13struct path;
14struct inode;
15struct dentry;
16struct user_namespace;
17
18struct seq_file {
19 char *buf;
20 size_t size;
21 size_t from;
22 size_t count;
23 size_t pad_until;
24 loff_t index;
25 loff_t read_pos;
26 u64 version;
27 struct mutex lock;
28 const struct seq_operations *op;
29 int poll_event;
30#ifdef CONFIG_USER_NS
31 struct user_namespace *user_ns;
32#endif
33 void *private;
34};
35
36struct 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
43#define SEQ_SKIP 1
44
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 */
53static 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 */
73static 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
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 */
91static inline void seq_setwidth(struct seq_file *m, size_t size)
92{
93 m->pad_until = m->count + size;
94}
95void seq_pad(struct seq_file *m, char c);
96
97char *mangle_path(char *s, const char *p, const char *esc);
98int seq_open(struct file *, const struct seq_operations *);
99ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
100loff_t seq_lseek(struct file *, loff_t, int);
101int seq_release(struct inode *, struct file *);
102int seq_escape(struct seq_file *, const char *, const char *);
103int seq_putc(struct seq_file *m, char c);
104int seq_puts(struct seq_file *m, const char *s);
105int seq_write(struct seq_file *seq, const void *data, size_t len);
106
107__printf(2, 3) int seq_printf(struct seq_file *, const char *, ...);
108__printf(2, 0) int seq_vprintf(struct seq_file *, const char *, va_list args);
109
110int seq_path(struct seq_file *, const struct path *, const char *);
111int seq_dentry(struct seq_file *, struct dentry *, const char *);
112int seq_path_root(struct seq_file *m, const struct path *path,
113 const struct path *root, const char *esc);
114int seq_bitmap(struct seq_file *m, const unsigned long *bits,
115 unsigned int nr_bits);
116static inline int seq_cpumask(struct seq_file *m, const struct cpumask *mask)
117{
118 return seq_bitmap(m, cpumask_bits(mask), nr_cpu_ids);
119}
120
121static inline int seq_nodemask(struct seq_file *m, nodemask_t *mask)
122{
123 return seq_bitmap(m, mask->bits, MAX_NUMNODES);
124}
125
126int seq_bitmap_list(struct seq_file *m, const unsigned long *bits,
127 unsigned int nr_bits);
128
129static inline int seq_cpumask_list(struct seq_file *m,
130 const struct cpumask *mask)
131{
132 return seq_bitmap_list(m, cpumask_bits(mask), nr_cpu_ids);
133}
134
135static 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
140int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
141int single_open_size(struct file *, int (*)(struct seq_file *, void *), void *, size_t);
142int single_release(struct inode *, struct file *);
143void *__seq_open_private(struct file *, const struct seq_operations *, int);
144int seq_open_private(struct file *, const struct seq_operations *, int);
145int seq_release_private(struct inode *, struct file *);
146int seq_put_decimal_ull(struct seq_file *m, char delimiter,
147 unsigned long long num);
148int seq_put_decimal_ll(struct seq_file *m, char delimiter,
149 long long num);
150
151static 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
161#define SEQ_START_TOKEN ((void *)1)
162/*
163 * Helpers for iteration over list_head-s in seq_files
164 */
165
166extern struct list_head *seq_list_start(struct list_head *head,
167 loff_t pos);
168extern struct list_head *seq_list_start_head(struct list_head *head,
169 loff_t pos);
170extern struct list_head *seq_list_next(void *v, struct list_head *head,
171 loff_t *ppos);
172
173/*
174 * Helpers for iteration over hlist_head-s in seq_files
175 */
176
177extern struct hlist_node *seq_hlist_start(struct hlist_head *head,
178 loff_t pos);
179extern struct hlist_node *seq_hlist_start_head(struct hlist_head *head,
180 loff_t pos);
181extern struct hlist_node *seq_hlist_next(void *v, struct hlist_head *head,
182 loff_t *ppos);
183
184extern struct hlist_node *seq_hlist_start_rcu(struct hlist_head *head,
185 loff_t pos);
186extern struct hlist_node *seq_hlist_start_head_rcu(struct hlist_head *head,
187 loff_t pos);
188extern struct hlist_node *seq_hlist_next_rcu(void *v,
189 struct hlist_head *head,
190 loff_t *ppos);
191
192/* Helpers for iterating over per-cpu hlist_head-s in seq_files */
193extern struct hlist_node *seq_hlist_start_percpu(struct hlist_head __percpu *head, int *cpu, loff_t pos);
194
195extern struct hlist_node *seq_hlist_next_percpu(void *v, struct hlist_head __percpu *head, int *cpu, loff_t *pos);
196
197#endif
1/* SPDX-License-Identifier: GPL-2.0 */
2#ifndef _LINUX_SEQ_FILE_H
3#define _LINUX_SEQ_FILE_H
4
5#include <linux/types.h>
6#include <linux/string.h>
7#include <linux/bug.h>
8#include <linux/mutex.h>
9#include <linux/cpumask.h>
10#include <linux/nodemask.h>
11#include <linux/fs.h>
12#include <linux/cred.h>
13
14struct seq_operations;
15
16struct seq_file {
17 char *buf;
18 size_t size;
19 size_t from;
20 size_t count;
21 size_t pad_until;
22 loff_t index;
23 loff_t read_pos;
24 struct mutex lock;
25 const struct seq_operations *op;
26 int poll_event;
27 const struct file *file;
28 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
38#define SEQ_SKIP 1
39
40/**
41 * seq_has_overflowed - check if the buffer has overflowed
42 * @m: the seq_file handle
43 *
44 * seq_files have a buffer which may overflow. When this happens a larger
45 * buffer is reallocated and all the data will be printed again.
46 * The overflow state is true when m->count == m->size.
47 *
48 * Returns true if the buffer received more than it can hold.
49 */
50static inline bool seq_has_overflowed(struct seq_file *m)
51{
52 return m->count == m->size;
53}
54
55/**
56 * seq_get_buf - get buffer to write arbitrary data to
57 * @m: the seq_file handle
58 * @bufp: the beginning of the buffer is stored here
59 *
60 * Return the number of bytes available in the buffer, or zero if
61 * there's no space.
62 */
63static inline size_t seq_get_buf(struct seq_file *m, char **bufp)
64{
65 BUG_ON(m->count > m->size);
66 if (m->count < m->size)
67 *bufp = m->buf + m->count;
68 else
69 *bufp = NULL;
70
71 return m->size - m->count;
72}
73
74/**
75 * seq_commit - commit data to the buffer
76 * @m: the seq_file handle
77 * @num: the number of bytes to commit
78 *
79 * Commit @num bytes of data written to a buffer previously acquired
80 * by seq_buf_get. To signal an error condition, or that the data
81 * didn't fit in the available space, pass a negative @num value.
82 */
83static inline void seq_commit(struct seq_file *m, int num)
84{
85 if (num < 0) {
86 m->count = m->size;
87 } else {
88 BUG_ON(m->count + num > m->size);
89 m->count += num;
90 }
91}
92
93/**
94 * seq_setwidth - set padding width
95 * @m: the seq_file handle
96 * @size: the max number of bytes to pad.
97 *
98 * Call seq_setwidth() for setting max width, then call seq_printf() etc. and
99 * finally call seq_pad() to pad the remaining bytes.
100 */
101static inline void seq_setwidth(struct seq_file *m, size_t size)
102{
103 m->pad_until = m->count + size;
104}
105void seq_pad(struct seq_file *m, char c);
106
107char *mangle_path(char *s, const char *p, const char *esc);
108int seq_open(struct file *, const struct seq_operations *);
109ssize_t seq_read(struct file *, char __user *, size_t, loff_t *);
110loff_t seq_lseek(struct file *, loff_t, int);
111int seq_release(struct inode *, struct file *);
112int seq_write(struct seq_file *seq, const void *data, size_t len);
113
114__printf(2, 0)
115void seq_vprintf(struct seq_file *m, const char *fmt, va_list args);
116__printf(2, 3)
117void seq_printf(struct seq_file *m, const char *fmt, ...);
118void seq_putc(struct seq_file *m, char c);
119void seq_puts(struct seq_file *m, const char *s);
120void seq_put_decimal_ull_width(struct seq_file *m, const char *delimiter,
121 unsigned long long num, unsigned int width);
122void seq_put_decimal_ull(struct seq_file *m, const char *delimiter,
123 unsigned long long num);
124void seq_put_decimal_ll(struct seq_file *m, const char *delimiter, long long num);
125void seq_put_hex_ll(struct seq_file *m, const char *delimiter,
126 unsigned long long v, unsigned int width);
127
128void seq_escape(struct seq_file *m, const char *s, const char *esc);
129void seq_escape_mem_ascii(struct seq_file *m, const char *src, size_t isz);
130
131void seq_hex_dump(struct seq_file *m, const char *prefix_str, int prefix_type,
132 int rowsize, int groupsize, const void *buf, size_t len,
133 bool ascii);
134
135int seq_path(struct seq_file *, const struct path *, const char *);
136int seq_file_path(struct seq_file *, struct file *, const char *);
137int seq_dentry(struct seq_file *, struct dentry *, const char *);
138int seq_path_root(struct seq_file *m, const struct path *path,
139 const struct path *root, const char *esc);
140
141int single_open(struct file *, int (*)(struct seq_file *, void *), void *);
142int single_open_size(struct file *, int (*)(struct seq_file *, void *), void *, size_t);
143int single_release(struct inode *, struct file *);
144void *__seq_open_private(struct file *, const struct seq_operations *, int);
145int seq_open_private(struct file *, const struct seq_operations *, int);
146int seq_release_private(struct inode *, struct file *);
147
148#define DEFINE_SEQ_ATTRIBUTE(__name) \
149static int __name ## _open(struct inode *inode, struct file *file) \
150{ \
151 int ret = seq_open(file, &__name ## _sops); \
152 if (!ret && inode->i_private) { \
153 struct seq_file *seq_f = file->private_data; \
154 seq_f->private = inode->i_private; \
155 } \
156 return ret; \
157} \
158 \
159static const struct file_operations __name ## _fops = { \
160 .owner = THIS_MODULE, \
161 .open = __name ## _open, \
162 .read = seq_read, \
163 .llseek = seq_lseek, \
164 .release = seq_release, \
165}
166
167#define DEFINE_SHOW_ATTRIBUTE(__name) \
168static int __name ## _open(struct inode *inode, struct file *file) \
169{ \
170 return single_open(file, __name ## _show, inode->i_private); \
171} \
172 \
173static const struct file_operations __name ## _fops = { \
174 .owner = THIS_MODULE, \
175 .open = __name ## _open, \
176 .read = seq_read, \
177 .llseek = seq_lseek, \
178 .release = single_release, \
179}
180
181#define DEFINE_PROC_SHOW_ATTRIBUTE(__name) \
182static int __name ## _open(struct inode *inode, struct file *file) \
183{ \
184 return single_open(file, __name ## _show, inode->i_private); \
185} \
186 \
187static const struct proc_ops __name ## _proc_ops = { \
188 .proc_open = __name ## _open, \
189 .proc_read = seq_read, \
190 .proc_lseek = seq_lseek, \
191 .proc_release = single_release, \
192}
193
194static inline struct user_namespace *seq_user_ns(struct seq_file *seq)
195{
196#ifdef CONFIG_USER_NS
197 return seq->file->f_cred->user_ns;
198#else
199 extern struct user_namespace init_user_ns;
200 return &init_user_ns;
201#endif
202}
203
204/**
205 * seq_show_options - display mount options with appropriate escapes.
206 * @m: the seq_file handle
207 * @name: the mount option name
208 * @value: the mount option name's value, can be NULL
209 */
210static inline void seq_show_option(struct seq_file *m, const char *name,
211 const char *value)
212{
213 seq_putc(m, ',');
214 seq_escape(m, name, ",= \t\n\\");
215 if (value) {
216 seq_putc(m, '=');
217 seq_escape(m, value, ", \t\n\\");
218 }
219}
220
221/**
222 * seq_show_option_n - display mount options with appropriate escapes
223 * where @value must be a specific length.
224 * @m: the seq_file handle
225 * @name: the mount option name
226 * @value: the mount option name's value, cannot be NULL
227 * @length: the length of @value to display
228 *
229 * This is a macro since this uses "length" to define the size of the
230 * stack buffer.
231 */
232#define seq_show_option_n(m, name, value, length) { \
233 char val_buf[length + 1]; \
234 strncpy(val_buf, value, length); \
235 val_buf[length] = '\0'; \
236 seq_show_option(m, name, val_buf); \
237}
238
239#define SEQ_START_TOKEN ((void *)1)
240/*
241 * Helpers for iteration over list_head-s in seq_files
242 */
243
244extern struct list_head *seq_list_start(struct list_head *head,
245 loff_t pos);
246extern struct list_head *seq_list_start_head(struct list_head *head,
247 loff_t pos);
248extern struct list_head *seq_list_next(void *v, struct list_head *head,
249 loff_t *ppos);
250
251/*
252 * Helpers for iteration over hlist_head-s in seq_files
253 */
254
255extern struct hlist_node *seq_hlist_start(struct hlist_head *head,
256 loff_t pos);
257extern struct hlist_node *seq_hlist_start_head(struct hlist_head *head,
258 loff_t pos);
259extern struct hlist_node *seq_hlist_next(void *v, struct hlist_head *head,
260 loff_t *ppos);
261
262extern struct hlist_node *seq_hlist_start_rcu(struct hlist_head *head,
263 loff_t pos);
264extern struct hlist_node *seq_hlist_start_head_rcu(struct hlist_head *head,
265 loff_t pos);
266extern struct hlist_node *seq_hlist_next_rcu(void *v,
267 struct hlist_head *head,
268 loff_t *ppos);
269
270/* Helpers for iterating over per-cpu hlist_head-s in seq_files */
271extern struct hlist_node *seq_hlist_start_percpu(struct hlist_head __percpu *head, int *cpu, loff_t pos);
272
273extern struct hlist_node *seq_hlist_next_percpu(void *v, struct hlist_head __percpu *head, int *cpu, loff_t *pos);
274
275void seq_file_init(void);
276#endif