Blame view

fs/seq_file.c 24.7 KB
b24413180   Greg Kroah-Hartman   License cleanup: ...
1
  // SPDX-License-Identifier: GPL-2.0
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
2
3
4
5
6
7
  /*
   * linux/fs/seq_file.c
   *
   * helper functions for making synthetic files from sequences of records.
   * initial implementation -- AV, Oct 2001.
   */
a39630157   Joe Perches   fs/seq_file.c: se...
8
  #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
096523203   Alexey Dobriyan   seq_file: allocat...
9
  #include <linux/cache.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
10
  #include <linux/fs.h>
630d9c472   Paul Gortmaker   fs: reduce the us...
11
  #include <linux/export.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
12
  #include <linux/seq_file.h>
058504edd   Heiko Carstens   fs/seq_file: fall...
13
  #include <linux/vmalloc.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
14
  #include <linux/slab.h>
adb37c4c6   Eric W. Biederman   userns: Make seq_...
15
  #include <linux/cred.h>
058504edd   Heiko Carstens   fs/seq_file: fall...
16
  #include <linux/mm.h>
37607102c   Andy Shevchenko   seq_file: provide...
17
  #include <linux/printk.h>
25c6bb76e   Andy Shevchenko   seq_file: reuse s...
18
  #include <linux/string_helpers.h>
d4d50710a   Christoph Hellwig   seq_file: add seq...
19
  #include <linux/uio.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
20

7c0f6ba68   Linus Torvalds   Replace <asm/uacc...
21
  #include <linux/uaccess.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
22
  #include <asm/page.h>
096523203   Alexey Dobriyan   seq_file: allocat...
23
  static struct kmem_cache *seq_file_cache __ro_after_init;
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
24
25
26
27
  static void seq_set_overflow(struct seq_file *m)
  {
  	m->count = m->size;
  }
058504edd   Heiko Carstens   fs/seq_file: fall...
28
29
  static void *seq_buf_alloc(unsigned long size)
  {
d64d01a15   Alexey Dobriyan   seq_file: account...
30
  	return kvmalloc(size, GFP_KERNEL_ACCOUNT);
058504edd   Heiko Carstens   fs/seq_file: fall...
31
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
32
33
34
35
36
37
38
39
40
41
42
43
  /**
   *	seq_open -	initialize sequential file
   *	@file: file we initialize
   *	@op: method table describing the sequence
   *
   *	seq_open() sets @file, associating it with a sequence described
   *	by @op.  @op->start() sets the iterator up and returns the first
   *	element of sequence. @op->stop() shuts it down.  @op->next()
   *	returns the next element of sequence.  @op->show() prints element
   *	into the buffer.  In case of error ->start() and ->next() return
   *	ERR_PTR(error).  In the end of sequence they return %NULL. ->show()
   *	returns 0 in case of success and negative number in case of error.
521b5d0c4   Al Viro   [PATCH] teach seq...
44
   *	Returning SEQ_SKIP means "discard this element and move on".
460b865e5   Yann Droneaud   fs: document seq_...
45
46
   *	Note: seq_open() will allocate a struct seq_file and store its
   *	pointer in @file->private_data. This pointer should not be modified.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
47
   */
15ad7cdcf   Helge Deller   [PATCH] struct se...
48
  int seq_open(struct file *file, const struct seq_operations *op)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
49
  {
189f9841d   Yann Droneaud   fs: allocate stru...
50
51
52
  	struct seq_file *p;
  
  	WARN_ON(file->private_data);
096523203   Alexey Dobriyan   seq_file: allocat...
53
  	p = kmem_cache_zalloc(seq_file_cache, GFP_KERNEL);
189f9841d   Yann Droneaud   fs: allocate stru...
54
55
56
57
  	if (!p)
  		return -ENOMEM;
  
  	file->private_data = p;
1abe77b0f   Al Viro   [PATCH] allow cal...
58

0ac1759ab   Ingo Molnar   [PATCH] sem2mutex...
59
  	mutex_init(&p->lock);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
60
  	p->op = op;
34dbbcdbf   Linus Torvalds   Make file credent...
61
62
63
64
  
  	// No refcounting: the lifetime of 'p' is constrained
  	// to the lifetime of the file.
  	p->file = file;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
65
66
  
  	/*
8f19d4729   Eric Biederman   seq_file: properl...
67
68
69
70
71
72
73
74
75
  	 * seq_files support lseek() and pread().  They do not implement
  	 * write() at all, but we clear FMODE_PWRITE here for historical
  	 * reasons.
  	 *
  	 * If a client of seq_files a) implements file.write() and b) wishes to
  	 * support pwrite() then that client will need to implement its own
  	 * file.open() which calls seq_open() and then sets FMODE_PWRITE.
  	 */
  	file->f_mode &= ~FMODE_PWRITE;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
76
77
78
  	return 0;
  }
  EXPORT_SYMBOL(seq_open);
33da8892a   Eric Biederman   seq_file: move tr...
79
80
  static int traverse(struct seq_file *m, loff_t offset)
  {
1f4aace60   NeilBrown   fs/seq_file.c: si...
81
  	loff_t pos = 0;
33da8892a   Eric Biederman   seq_file: move tr...
82
83
  	int error = 0;
  	void *p;
1f4aace60   NeilBrown   fs/seq_file.c: si...
84
  	m->index = 0;
33da8892a   Eric Biederman   seq_file: move tr...
85
  	m->count = m->from = 0;
1f4aace60   NeilBrown   fs/seq_file.c: si...
86
  	if (!offset)
33da8892a   Eric Biederman   seq_file: move tr...
87
  		return 0;
1f4aace60   NeilBrown   fs/seq_file.c: si...
88

33da8892a   Eric Biederman   seq_file: move tr...
89
  	if (!m->buf) {
058504edd   Heiko Carstens   fs/seq_file: fall...
90
  		m->buf = seq_buf_alloc(m->size = PAGE_SIZE);
33da8892a   Eric Biederman   seq_file: move tr...
91
92
93
  		if (!m->buf)
  			return -ENOMEM;
  	}
1f4aace60   NeilBrown   fs/seq_file.c: si...
94
  	p = m->op->start(m, &m->index);
33da8892a   Eric Biederman   seq_file: move tr...
95
96
97
98
99
100
101
102
103
104
105
  	while (p) {
  		error = PTR_ERR(p);
  		if (IS_ERR(p))
  			break;
  		error = m->op->show(m, p);
  		if (error < 0)
  			break;
  		if (unlikely(error)) {
  			error = 0;
  			m->count = 0;
  		}
1f33c41c0   Joe Perches   seq_file: Rename ...
106
  		if (seq_has_overflowed(m))
33da8892a   Eric Biederman   seq_file: move tr...
107
  			goto Eoverflow;
6a2aeab59   NeilBrown   seq_file: fix pro...
108
  		p = m->op->next(m, p, &m->index);
33da8892a   Eric Biederman   seq_file: move tr...
109
110
111
  		if (pos + m->count > offset) {
  			m->from = offset - pos;
  			m->count -= m->from;
33da8892a   Eric Biederman   seq_file: move tr...
112
113
114
115
  			break;
  		}
  		pos += m->count;
  		m->count = 0;
1f4aace60   NeilBrown   fs/seq_file.c: si...
116
  		if (pos == offset)
33da8892a   Eric Biederman   seq_file: move tr...
117
  			break;
33da8892a   Eric Biederman   seq_file: move tr...
118
119
120
121
122
123
  	}
  	m->op->stop(m, p);
  	return error;
  
  Eoverflow:
  	m->op->stop(m, p);
058504edd   Heiko Carstens   fs/seq_file: fall...
124
  	kvfree(m->buf);
801a76050   Al Viro   seq_file: always ...
125
  	m->count = 0;
058504edd   Heiko Carstens   fs/seq_file: fall...
126
  	m->buf = seq_buf_alloc(m->size <<= 1);
33da8892a   Eric Biederman   seq_file: move tr...
127
128
  	return !m->buf ? -ENOMEM : -EAGAIN;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
129
130
  /**
   *	seq_read -	->read() method for sequential files.
67be2dd1b   Martin Waitz   [PATCH] DocBook: ...
131
132
133
134
   *	@file: the file to read from
   *	@buf: the buffer to read to
   *	@size: the maximum number of bytes to read
   *	@ppos: the current position in the file
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
135
136
137
138
139
   *
   *	Ready-made ->f_op->read()
   */
  ssize_t seq_read(struct file *file, char __user *buf, size_t size, loff_t *ppos)
  {
d4d50710a   Christoph Hellwig   seq_file: add seq...
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
  	struct iovec iov = { .iov_base = buf, .iov_len = size};
  	struct kiocb kiocb;
  	struct iov_iter iter;
  	ssize_t ret;
  
  	init_sync_kiocb(&kiocb, file);
  	iov_iter_init(&iter, READ, &iov, 1, size);
  
  	kiocb.ki_pos = *ppos;
  	ret = seq_read_iter(&kiocb, &iter);
  	*ppos = kiocb.ki_pos;
  	return ret;
  }
  EXPORT_SYMBOL(seq_read);
  
  /*
   * Ready-made ->f_op->read_iter()
   */
  ssize_t seq_read_iter(struct kiocb *iocb, struct iov_iter *iter)
  {
  	struct seq_file *m = iocb->ki_filp->private_data;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
161
  	size_t copied = 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
162
163
164
  	size_t n;
  	void *p;
  	int err = 0;
4bbf439b0   Al Viro   fix return values...
165
166
  	if (!iov_iter_count(iter))
  		return 0;
0ac1759ab   Ingo Molnar   [PATCH] sem2mutex...
167
  	mutex_lock(&m->lock);
8f19d4729   Eric Biederman   seq_file: properl...
168

7904ac842   Earl Chew   seq_file: fix mis...
169
  	/*
e522751d6   Tomasz Majchrzak   seq_file: reset i...
170
171
172
  	 * if request is to read from zero offset, reset iterator to first
  	 * record as it might have been already advanced by previous requests
  	 */
d4d50710a   Christoph Hellwig   seq_file: add seq...
173
  	if (iocb->ki_pos == 0) {
e522751d6   Tomasz Majchrzak   seq_file: reset i...
174
  		m->index = 0;
cf5eebae2   Miklos Szeredi   seq_file: fix inc...
175
176
  		m->count = 0;
  	}
e522751d6   Tomasz Majchrzak   seq_file: reset i...
177

d4d50710a   Christoph Hellwig   seq_file: add seq...
178
179
180
  	/* Don't assume ki_pos is where we left it */
  	if (unlikely(iocb->ki_pos != m->read_pos)) {
  		while ((err = traverse(m, iocb->ki_pos)) == -EAGAIN)
8f19d4729   Eric Biederman   seq_file: properl...
181
182
183
184
  			;
  		if (err) {
  			/* With prejudice... */
  			m->read_pos = 0;
8f19d4729   Eric Biederman   seq_file: properl...
185
186
187
  			m->index = 0;
  			m->count = 0;
  			goto Done;
7904ac842   Earl Chew   seq_file: fix mis...
188
  		} else {
d4d50710a   Christoph Hellwig   seq_file: add seq...
189
  			m->read_pos = iocb->ki_pos;
8f19d4729   Eric Biederman   seq_file: properl...
190
191
  		}
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
192
193
  	/* grab buffer if we didn't have one */
  	if (!m->buf) {
058504edd   Heiko Carstens   fs/seq_file: fall...
194
  		m->buf = seq_buf_alloc(m->size = PAGE_SIZE);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
195
196
197
  		if (!m->buf)
  			goto Enomem;
  	}
4bbf439b0   Al Viro   fix return values...
198
  	// something left in the buffer - copy it out first
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
199
  	if (m->count) {
4bbf439b0   Al Viro   fix return values...
200
  		n = copy_to_iter(m->buf + m->from, m->count, iter);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
201
202
  		m->count -= n;
  		m->from += n;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
203
  		copied += n;
4bbf439b0   Al Viro   fix return values...
204
  		if (m->count)	// hadn't managed to copy everything
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
205
206
  			goto Done;
  	}
4bbf439b0   Al Viro   fix return values...
207
  	// get a non-empty record in the buffer
1f4aace60   NeilBrown   fs/seq_file.c: si...
208
209
  	m->from = 0;
  	p = m->op->start(m, &m->index);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
210
  	while (1) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
211
  		err = PTR_ERR(p);
4bbf439b0   Al Viro   fix return values...
212
  		if (!p || IS_ERR(p))	// EOF or an error
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
213
214
  			break;
  		err = m->op->show(m, p);
4bbf439b0   Al Viro   fix return values...
215
  		if (err < 0)		// hard error
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
216
  			break;
4bbf439b0   Al Viro   fix return values...
217
  		if (unlikely(err))	// ->show() says "skip it"
521b5d0c4   Al Viro   [PATCH] teach seq...
218
  			m->count = 0;
4bbf439b0   Al Viro   fix return values...
219
  		if (unlikely(!m->count)) { // empty record
1f4aace60   NeilBrown   fs/seq_file.c: si...
220
  			p = m->op->next(m, p, &m->index);
4cdfe84b5   Al Viro   [PATCH] deal with...
221
222
  			continue;
  		}
4bbf439b0   Al Viro   fix return values...
223
  		if (!seq_has_overflowed(m)) // got it
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
224
  			goto Fill;
4bbf439b0   Al Viro   fix return values...
225
  		// need a bigger buffer
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
226
  		m->op->stop(m, p);
058504edd   Heiko Carstens   fs/seq_file: fall...
227
  		kvfree(m->buf);
801a76050   Al Viro   seq_file: always ...
228
  		m->count = 0;
058504edd   Heiko Carstens   fs/seq_file: fall...
229
  		m->buf = seq_buf_alloc(m->size <<= 1);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
230
231
  		if (!m->buf)
  			goto Enomem;
1f4aace60   NeilBrown   fs/seq_file.c: si...
232
  		p = m->op->start(m, &m->index);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
233
  	}
4bbf439b0   Al Viro   fix return values...
234
  	// EOF or an error
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
235
236
237
238
  	m->op->stop(m, p);
  	m->count = 0;
  	goto Done;
  Fill:
4bbf439b0   Al Viro   fix return values...
239
240
241
  	// one non-empty record is in the buffer; if they want more,
  	// try to fit more in, but in any case we need to advance
  	// the iterator once for every record shown.
1f4aace60   NeilBrown   fs/seq_file.c: si...
242
  	while (1) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
243
  		size_t offs = m->count;
1f4aace60   NeilBrown   fs/seq_file.c: si...
244
245
246
  		loff_t pos = m->index;
  
  		p = m->op->next(m, p, &m->index);
3bfa7e141   Vasily Averin   fs/seq_file.c: se...
247
  		if (pos == m->index) {
a39630157   Joe Perches   fs/seq_file.c: se...
248
249
250
  			pr_info_ratelimited("buggy .next function %ps did not update position index
  ",
  					    m->op->next);
1f4aace60   NeilBrown   fs/seq_file.c: si...
251
  			m->index++;
3bfa7e141   Vasily Averin   fs/seq_file.c: se...
252
  		}
4bbf439b0   Al Viro   fix return values...
253
  		if (!p || IS_ERR(p))	// no next record for us
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
254
  			break;
4bbf439b0   Al Viro   fix return values...
255
  		if (m->count >= iov_iter_count(iter))
1f4aace60   NeilBrown   fs/seq_file.c: si...
256
  			break;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
257
  		err = m->op->show(m, p);
4bbf439b0   Al Viro   fix return values...
258
  		if (err > 0) {		// ->show() says "skip it"
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
259
  			m->count = offs;
4bbf439b0   Al Viro   fix return values...
260
261
262
  		} else if (err || seq_has_overflowed(m)) {
  			m->count = offs;
  			break;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
263
  		}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
264
265
  	}
  	m->op->stop(m, p);
4bbf439b0   Al Viro   fix return values...
266
  	n = copy_to_iter(m->buf, m->count, iter);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
267
268
  	copied += n;
  	m->count -= n;
1f4aace60   NeilBrown   fs/seq_file.c: si...
269
  	m->from = n;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
270
  Done:
4bbf439b0   Al Viro   fix return values...
271
272
273
  	if (unlikely(!copied)) {
  		copied = m->count ? -EFAULT : err;
  	} else {
d4d50710a   Christoph Hellwig   seq_file: add seq...
274
  		iocb->ki_pos += copied;
8f19d4729   Eric Biederman   seq_file: properl...
275
276
  		m->read_pos += copied;
  	}
0ac1759ab   Ingo Molnar   [PATCH] sem2mutex...
277
  	mutex_unlock(&m->lock);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
278
279
280
281
  	return copied;
  Enomem:
  	err = -ENOMEM;
  	goto Done;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
282
  }
d4d50710a   Christoph Hellwig   seq_file: add seq...
283
  EXPORT_SYMBOL(seq_read_iter);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
284

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
285
286
  /**
   *	seq_lseek -	->llseek() method for sequential files.
67be2dd1b   Martin Waitz   [PATCH] DocBook: ...
287
288
   *	@file: the file in question
   *	@offset: new position
254adaa46   Randy Dunlap   seq_file: fix new...
289
   *	@whence: 0 for absolute, 1 for relative position
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
290
291
292
   *
   *	Ready-made ->f_op->llseek()
   */
965c8e59c   Andrew Morton   lseek: the "whenc...
293
  loff_t seq_lseek(struct file *file, loff_t offset, int whence)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
294
  {
8209e2f46   Joe Perches   fs/seq_file.c: Re...
295
  	struct seq_file *m = file->private_data;
16abef0e9   David Sterba   fs: use loff_t ty...
296
  	loff_t retval = -EINVAL;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
297

0ac1759ab   Ingo Molnar   [PATCH] sem2mutex...
298
  	mutex_lock(&m->lock);
965c8e59c   Andrew Morton   lseek: the "whenc...
299
  	switch (whence) {
5e62adef9   Andrew Morton   fs/seq_file.c:seq...
300
301
  	case SEEK_CUR:
  		offset += file->f_pos;
df561f668   Gustavo A. R. Silva   treewide: Use fal...
302
  		fallthrough;
5e62adef9   Andrew Morton   fs/seq_file.c:seq...
303
304
305
306
307
308
309
310
311
312
313
  	case SEEK_SET:
  		if (offset < 0)
  			break;
  		retval = offset;
  		if (offset != m->read_pos) {
  			while ((retval = traverse(m, offset)) == -EAGAIN)
  				;
  			if (retval) {
  				/* with extreme prejudice... */
  				file->f_pos = 0;
  				m->read_pos = 0;
5e62adef9   Andrew Morton   fs/seq_file.c:seq...
314
315
316
317
318
  				m->index = 0;
  				m->count = 0;
  			} else {
  				m->read_pos = offset;
  				retval = file->f_pos = offset;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
319
  			}
05e16745c   Gu Zheng   seq_file: always ...
320
321
  		} else {
  			file->f_pos = offset;
5e62adef9   Andrew Morton   fs/seq_file.c:seq...
322
  		}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
323
  	}
00c5746da   Alexey Dobriyan   mutex_unlock() la...
324
  	mutex_unlock(&m->lock);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
325
326
327
328
329
330
331
  	return retval;
  }
  EXPORT_SYMBOL(seq_lseek);
  
  /**
   *	seq_release -	free the structures associated with sequential file.
   *	@file: file in question
6131ffaa1   Al Viro   more file_inode()...
332
   *	@inode: its inode
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
333
334
335
336
337
338
   *
   *	Frees the structures associated with sequential file; can be used
   *	as ->f_op->release() if you don't have private data to destroy.
   */
  int seq_release(struct inode *inode, struct file *file)
  {
8209e2f46   Joe Perches   fs/seq_file.c: Re...
339
  	struct seq_file *m = file->private_data;
058504edd   Heiko Carstens   fs/seq_file: fall...
340
  	kvfree(m->buf);
096523203   Alexey Dobriyan   seq_file: allocat...
341
  	kmem_cache_free(seq_file_cache, m);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
342
343
344
345
346
347
348
349
350
351
352
  	return 0;
  }
  EXPORT_SYMBOL(seq_release);
  
  /**
   *	seq_escape -	print string into buffer, escaping some characters
   *	@m:	target buffer
   *	@s:	string
   *	@esc:	set of characters that need escaping
   *
   *	Puts string into buffer, replacing each occurrence of character from
6798a8caa   Joe Perches   fs/seq_file: conv...
353
354
   *	@esc with usual octal escape.
   *	Use seq_has_overflowed() to check for errors.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
355
   */
6798a8caa   Joe Perches   fs/seq_file: conv...
356
  void seq_escape(struct seq_file *m, const char *s, const char *esc)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
357
  {
25c6bb76e   Andy Shevchenko   seq_file: reuse s...
358
359
360
  	char *buf;
  	size_t size = seq_get_buf(m, &buf);
  	int ret;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
361

25c6bb76e   Andy Shevchenko   seq_file: reuse s...
362
363
  	ret = string_escape_str(s, buf, size, ESCAPE_OCTAL, esc);
  	seq_commit(m, ret < size ? ret : -1);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
364
365
  }
  EXPORT_SYMBOL(seq_escape);
ea053e164   J. Bruce Fields   nfsd: escape high...
366
367
368
369
370
371
372
373
374
375
  void seq_escape_mem_ascii(struct seq_file *m, const char *src, size_t isz)
  {
  	char *buf;
  	size_t size = seq_get_buf(m, &buf);
  	int ret;
  
  	ret = string_escape_mem_ascii(src, isz, buf, size);
  	seq_commit(m, ret < size ? ret : -1);
  }
  EXPORT_SYMBOL(seq_escape_mem_ascii);
6798a8caa   Joe Perches   fs/seq_file: conv...
376
  void seq_vprintf(struct seq_file *m, const char *f, va_list args)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
377
  {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
378
379
380
  	int len;
  
  	if (m->count < m->size) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
381
  		len = vsnprintf(m->buf + m->count, m->size - m->count, f, args);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
382
383
  		if (m->count + len < m->size) {
  			m->count += len;
6798a8caa   Joe Perches   fs/seq_file: conv...
384
  			return;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
385
386
  		}
  	}
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
387
  	seq_set_overflow(m);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
388
  }
a4808147d   Steven Whitehouse   seq_file: Add seq...
389
  EXPORT_SYMBOL(seq_vprintf);
6798a8caa   Joe Perches   fs/seq_file: conv...
390
  void seq_printf(struct seq_file *m, const char *f, ...)
a4808147d   Steven Whitehouse   seq_file: Add seq...
391
  {
a4808147d   Steven Whitehouse   seq_file: Add seq...
392
393
394
  	va_list args;
  
  	va_start(args, f);
6798a8caa   Joe Perches   fs/seq_file: conv...
395
  	seq_vprintf(m, f, args);
a4808147d   Steven Whitehouse   seq_file: Add seq...
396
  	va_end(args);
a4808147d   Steven Whitehouse   seq_file: Add seq...
397
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
398
  EXPORT_SYMBOL(seq_printf);
74e2f334f   Török Edwin   vfs, seqfile: mak...
399
  /**
958086d17   Török Edwin   vfs, seqfile: fix...
400
401
402
403
   *	mangle_path -	mangle and copy path to buffer beginning
   *	@s: buffer start
   *	@p: beginning of path in above buffer
   *	@esc: set of characters that need escaping
74e2f334f   Török Edwin   vfs, seqfile: mak...
404
405
406
407
408
409
   *
   *      Copy the path from @p to @s, replacing each occurrence of character from
   *      @esc with usual octal escape.
   *      Returns pointer past last written character in @s, or NULL in case of
   *      failure.
   */
8c9379e97   Al Viro   constify seq_file...
410
  char *mangle_path(char *s, const char *p, const char *esc)
6092d0481   Ram Pai   [patch 1/7] vfs: ...
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
  {
  	while (s <= p) {
  		char c = *p++;
  		if (!c) {
  			return s;
  		} else if (!strchr(esc, c)) {
  			*s++ = c;
  		} else if (s + 4 > p) {
  			break;
  		} else {
  			*s++ = '\\';
  			*s++ = '0' + ((c & 0300) >> 6);
  			*s++ = '0' + ((c & 070) >> 3);
  			*s++ = '0' + (c & 07);
  		}
  	}
  	return NULL;
  }
604094f46   Ingo Molnar   vfs, seqfile: exp...
429
  EXPORT_SYMBOL(mangle_path);
6092d0481   Ram Pai   [patch 1/7] vfs: ...
430

52afeefb9   Arjan van de Ven   expand some comme...
431
432
433
434
435
436
437
438
  /**
   * seq_path - seq_file interface to print a pathname
   * @m: the seq_file handle
   * @path: the struct path to print
   * @esc: set of characters to escape in the output
   *
   * return the absolute path of 'path', as represented by the
   * dentry / mnt pair in the path parameter.
6092d0481   Ram Pai   [patch 1/7] vfs: ...
439
   */
8c9379e97   Al Viro   constify seq_file...
440
  int seq_path(struct seq_file *m, const struct path *path, const char *esc)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
441
  {
f84398068   Miklos Szeredi   vfs: seq_file: ad...
442
443
444
445
446
447
  	char *buf;
  	size_t size = seq_get_buf(m, &buf);
  	int res = -1;
  
  	if (size) {
  		char *p = d_path(path, buf, size);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
448
  		if (!IS_ERR(p)) {
f84398068   Miklos Szeredi   vfs: seq_file: ad...
449
450
451
  			char *end = mangle_path(buf, p, esc);
  			if (end)
  				res = end - buf;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
452
453
  		}
  	}
f84398068   Miklos Szeredi   vfs: seq_file: ad...
454
455
456
  	seq_commit(m, res);
  
  	return res;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
457
458
  }
  EXPORT_SYMBOL(seq_path);
2726d5662   Miklos Szeredi   vfs: add seq_file...
459
460
461
462
463
464
465
466
467
468
469
470
471
  /**
   * seq_file_path - seq_file interface to print a pathname of a file
   * @m: the seq_file handle
   * @file: the struct file to print
   * @esc: set of characters to escape in the output
   *
   * return the absolute path to the file.
   */
  int seq_file_path(struct seq_file *m, struct file *file, const char *esc)
  {
  	return seq_path(m, &file->f_path, esc);
  }
  EXPORT_SYMBOL(seq_file_path);
6092d0481   Ram Pai   [patch 1/7] vfs: ...
472
  /*
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
473
   * Same as seq_path, but relative to supplied root.
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
474
   */
8c9379e97   Al Viro   constify seq_file...
475
476
  int seq_path_root(struct seq_file *m, const struct path *path,
  		  const struct path *root, const char *esc)
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
477
  {
f84398068   Miklos Szeredi   vfs: seq_file: ad...
478
479
480
481
482
  	char *buf;
  	size_t size = seq_get_buf(m, &buf);
  	int res = -ENAMETOOLONG;
  
  	if (size) {
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
483
  		char *p;
f84398068   Miklos Szeredi   vfs: seq_file: ad...
484
  		p = __d_path(path, root, buf, size);
02125a826   Al Viro   fix apparmor dere...
485
486
  		if (!p)
  			return SEQ_SKIP;
f84398068   Miklos Szeredi   vfs: seq_file: ad...
487
  		res = PTR_ERR(p);
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
488
  		if (!IS_ERR(p)) {
f84398068   Miklos Szeredi   vfs: seq_file: ad...
489
490
491
492
493
  			char *end = mangle_path(buf, p, esc);
  			if (end)
  				res = end - buf;
  			else
  				res = -ENAMETOOLONG;
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
494
495
  		}
  	}
f84398068   Miklos Szeredi   vfs: seq_file: ad...
496
  	seq_commit(m, res);
02125a826   Al Viro   fix apparmor dere...
497
  	return res < 0 && res != -ENAMETOOLONG ? res : 0;
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
498
499
500
  }
  
  /*
6092d0481   Ram Pai   [patch 1/7] vfs: ...
501
502
   * returns the path of the 'dentry' from the root of its filesystem.
   */
8c9379e97   Al Viro   constify seq_file...
503
  int seq_dentry(struct seq_file *m, struct dentry *dentry, const char *esc)
6092d0481   Ram Pai   [patch 1/7] vfs: ...
504
  {
f84398068   Miklos Szeredi   vfs: seq_file: ad...
505
506
507
508
509
510
  	char *buf;
  	size_t size = seq_get_buf(m, &buf);
  	int res = -1;
  
  	if (size) {
  		char *p = dentry_path(dentry, buf, size);
6092d0481   Ram Pai   [patch 1/7] vfs: ...
511
  		if (!IS_ERR(p)) {
f84398068   Miklos Szeredi   vfs: seq_file: ad...
512
513
514
  			char *end = mangle_path(buf, p, esc);
  			if (end)
  				res = end - buf;
6092d0481   Ram Pai   [patch 1/7] vfs: ...
515
516
  		}
  	}
f84398068   Miklos Szeredi   vfs: seq_file: ad...
517
518
519
  	seq_commit(m, res);
  
  	return res;
6092d0481   Ram Pai   [patch 1/7] vfs: ...
520
  }
c8d3fe028   Omar Sandoval   Btrfs: show subvo...
521
  EXPORT_SYMBOL(seq_dentry);
6092d0481   Ram Pai   [patch 1/7] vfs: ...
522

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
  static void *single_start(struct seq_file *p, loff_t *pos)
  {
  	return NULL + (*pos == 0);
  }
  
  static void *single_next(struct seq_file *p, void *v, loff_t *pos)
  {
  	++*pos;
  	return NULL;
  }
  
  static void single_stop(struct seq_file *p, void *v)
  {
  }
  
  int single_open(struct file *file, int (*show)(struct seq_file *, void *),
  		void *data)
  {
d64d01a15   Alexey Dobriyan   seq_file: account...
541
  	struct seq_operations *op = kmalloc(sizeof(*op), GFP_KERNEL_ACCOUNT);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
  	int res = -ENOMEM;
  
  	if (op) {
  		op->start = single_start;
  		op->next = single_next;
  		op->stop = single_stop;
  		op->show = show;
  		res = seq_open(file, op);
  		if (!res)
  			((struct seq_file *)file->private_data)->private = data;
  		else
  			kfree(op);
  	}
  	return res;
  }
  EXPORT_SYMBOL(single_open);
2043f495c   Al Viro   new helper: singl...
558
559
560
  int single_open_size(struct file *file, int (*show)(struct seq_file *, void *),
  		void *data, size_t size)
  {
058504edd   Heiko Carstens   fs/seq_file: fall...
561
  	char *buf = seq_buf_alloc(size);
2043f495c   Al Viro   new helper: singl...
562
563
564
565
566
  	int ret;
  	if (!buf)
  		return -ENOMEM;
  	ret = single_open(file, show, data);
  	if (ret) {
058504edd   Heiko Carstens   fs/seq_file: fall...
567
  		kvfree(buf);
2043f495c   Al Viro   new helper: singl...
568
569
570
571
572
573
574
  		return ret;
  	}
  	((struct seq_file *)file->private_data)->buf = buf;
  	((struct seq_file *)file->private_data)->size = size;
  	return 0;
  }
  EXPORT_SYMBOL(single_open_size);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
575
576
  int single_release(struct inode *inode, struct file *file)
  {
15ad7cdcf   Helge Deller   [PATCH] struct se...
577
  	const struct seq_operations *op = ((struct seq_file *)file->private_data)->op;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
  	int res = seq_release(inode, file);
  	kfree(op);
  	return res;
  }
  EXPORT_SYMBOL(single_release);
  
  int seq_release_private(struct inode *inode, struct file *file)
  {
  	struct seq_file *seq = file->private_data;
  
  	kfree(seq->private);
  	seq->private = NULL;
  	return seq_release(inode, file);
  }
  EXPORT_SYMBOL(seq_release_private);
39699037a   Pavel Emelyanov   [FS] seq_file: In...
593
594
595
596
597
598
  void *__seq_open_private(struct file *f, const struct seq_operations *ops,
  		int psize)
  {
  	int rc;
  	void *private;
  	struct seq_file *seq;
d64d01a15   Alexey Dobriyan   seq_file: account...
599
  	private = kzalloc(psize, GFP_KERNEL_ACCOUNT);
39699037a   Pavel Emelyanov   [FS] seq_file: In...
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
  	if (private == NULL)
  		goto out;
  
  	rc = seq_open(f, ops);
  	if (rc < 0)
  		goto out_free;
  
  	seq = f->private_data;
  	seq->private = private;
  	return private;
  
  out_free:
  	kfree(private);
  out:
  	return NULL;
  }
  EXPORT_SYMBOL(__seq_open_private);
  
  int seq_open_private(struct file *filp, const struct seq_operations *ops,
  		int psize)
  {
  	return __seq_open_private(filp, ops, psize) ? 0 : -ENOMEM;
  }
  EXPORT_SYMBOL(seq_open_private);
6798a8caa   Joe Perches   fs/seq_file: conv...
624
  void seq_putc(struct seq_file *m, char c)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
625
  {
6798a8caa   Joe Perches   fs/seq_file: conv...
626
627
628
629
  	if (m->count >= m->size)
  		return;
  
  	m->buf[m->count++] = c;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
630
631
  }
  EXPORT_SYMBOL(seq_putc);
6798a8caa   Joe Perches   fs/seq_file: conv...
632
  void seq_puts(struct seq_file *m, const char *s)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
633
634
  {
  	int len = strlen(s);
6798a8caa   Joe Perches   fs/seq_file: conv...
635
636
637
638
  
  	if (m->count + len >= m->size) {
  		seq_set_overflow(m);
  		return;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
639
  	}
6798a8caa   Joe Perches   fs/seq_file: conv...
640
641
  	memcpy(m->buf + m->count, s, len);
  	m->count += len;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
642
643
  }
  EXPORT_SYMBOL(seq_puts);
bcf67e162   Pavel Emelianov   Make common helpe...
644

d1be35cb6   Andrei Vagin   proc: add seq_put...
645
  /**
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
646
647
   * A helper routine for putting decimal numbers without rich format of printf().
   * only 'unsigned long long' is supported.
d1be35cb6   Andrei Vagin   proc: add seq_put...
648
649
650
651
652
653
   * @m: seq_file identifying the buffer to which data should be written
   * @delimiter: a string which is printed before the number
   * @num: the number
   * @width: a minimum field width
   *
   * This routine will put strlen(delimiter) + number into seq_filed.
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
654
655
656
   * This routine is very quick when you show lots of numbers.
   * In usual cases, it will be better to use seq_printf(). It's easier to read.
   */
d1be35cb6   Andrei Vagin   proc: add seq_put...
657
658
  void seq_put_decimal_ull_width(struct seq_file *m, const char *delimiter,
  			 unsigned long long num, unsigned int width)
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
659
660
661
662
663
  {
  	int len;
  
  	if (m->count + 2 >= m->size) /* we'll write 2 bytes at least */
  		goto overflow;
48dffbf82   Andrei Vagin   proc: optimize si...
664
665
666
667
668
669
  	if (delimiter && delimiter[0]) {
  		if (delimiter[1] == 0)
  			seq_putc(m, delimiter[0]);
  		else
  			seq_puts(m, delimiter);
  	}
75ba1d07f   Joe Perches   seq/proc: modify ...
670

d1be35cb6   Andrei Vagin   proc: add seq_put...
671
672
673
674
  	if (!width)
  		width = 1;
  
  	if (m->count + width >= m->size)
75ba1d07f   Joe Perches   seq/proc: modify ...
675
  		goto overflow;
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
676

d1be35cb6   Andrei Vagin   proc: add seq_put...
677
  	len = num_to_str(m->buf + m->count, m->size - m->count, num, width);
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
678
679
  	if (!len)
  		goto overflow;
75ba1d07f   Joe Perches   seq/proc: modify ...
680

1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
681
  	m->count += len;
6798a8caa   Joe Perches   fs/seq_file: conv...
682
  	return;
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
683
  overflow:
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
684
  	seq_set_overflow(m);
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
685
  }
d1be35cb6   Andrei Vagin   proc: add seq_put...
686
687
688
689
690
691
  
  void seq_put_decimal_ull(struct seq_file *m, const char *delimiter,
  			 unsigned long long num)
  {
  	return seq_put_decimal_ull_width(m, delimiter, num, 0);
  }
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
692
  EXPORT_SYMBOL(seq_put_decimal_ull);
0e3dc0191   Andrei Vagin   procfs: add seq_p...
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
  /**
   * seq_put_hex_ll - put a number in hexadecimal notation
   * @m: seq_file identifying the buffer to which data should be written
   * @delimiter: a string which is printed before the number
   * @v: the number
   * @width: a minimum field width
   *
   * seq_put_hex_ll(m, "", v, 8) is equal to seq_printf(m, "%08llx", v)
   *
   * This routine is very quick when you show lots of numbers.
   * In usual cases, it will be better to use seq_printf(). It's easier to read.
   */
  void seq_put_hex_ll(struct seq_file *m, const char *delimiter,
  				unsigned long long v, unsigned int width)
  {
  	unsigned int len;
  	int i;
  
  	if (delimiter && delimiter[0]) {
  		if (delimiter[1] == 0)
  			seq_putc(m, delimiter[0]);
  		else
  			seq_puts(m, delimiter);
  	}
  
  	/* If x is 0, the result of __builtin_clzll is undefined */
  	if (v == 0)
  		len = 1;
  	else
  		len = (sizeof(v) * 8 - __builtin_clzll(v) + 3) / 4;
  
  	if (len < width)
  		len = width;
  
  	if (m->count + len > m->size) {
  		seq_set_overflow(m);
  		return;
  	}
  
  	for (i = len - 1; i >= 0; i--) {
  		m->buf[m->count + i] = hex_asc[0xf & v];
  		v = v >> 4;
  	}
  	m->count += len;
  }
75ba1d07f   Joe Perches   seq/proc: modify ...
738
  void seq_put_decimal_ll(struct seq_file *m, const char *delimiter, long long num)
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
739
  {
75ba1d07f   Joe Perches   seq/proc: modify ...
740
741
742
743
  	int len;
  
  	if (m->count + 3 >= m->size) /* we'll write 2 bytes at least */
  		goto overflow;
48dffbf82   Andrei Vagin   proc: optimize si...
744
745
746
747
748
749
  	if (delimiter && delimiter[0]) {
  		if (delimiter[1] == 0)
  			seq_putc(m, delimiter[0]);
  		else
  			seq_puts(m, delimiter);
  	}
75ba1d07f   Joe Perches   seq/proc: modify ...
750
751
752
  
  	if (m->count + 2 >= m->size)
  		goto overflow;
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
753
  	if (num < 0) {
75ba1d07f   Joe Perches   seq/proc: modify ...
754
  		m->buf[m->count++] = '-';
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
755
  		num = -num;
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
756
  	}
75ba1d07f   Joe Perches   seq/proc: modify ...
757
758
759
760
761
  
  	if (num < 10) {
  		m->buf[m->count++] = num + '0';
  		return;
  	}
d1be35cb6   Andrei Vagin   proc: add seq_put...
762
  	len = num_to_str(m->buf + m->count, m->size - m->count, num, 0);
75ba1d07f   Joe Perches   seq/proc: modify ...
763
764
765
766
767
768
769
770
  	if (!len)
  		goto overflow;
  
  	m->count += len;
  	return;
  
  overflow:
  	seq_set_overflow(m);
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
771
772
  }
  EXPORT_SYMBOL(seq_put_decimal_ll);
0b923606e   Peter Oberparleiter   seq_file: add fun...
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
  /**
   * seq_write - write arbitrary data to buffer
   * @seq: seq_file identifying the buffer to which data should be written
   * @data: data address
   * @len: number of bytes
   *
   * Return 0 on success, non-zero otherwise.
   */
  int seq_write(struct seq_file *seq, const void *data, size_t len)
  {
  	if (seq->count + len < seq->size) {
  		memcpy(seq->buf + seq->count, data, len);
  		seq->count += len;
  		return 0;
  	}
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
788
  	seq_set_overflow(seq);
0b923606e   Peter Oberparleiter   seq_file: add fun...
789
790
791
  	return -1;
  }
  EXPORT_SYMBOL(seq_write);
839cc2a94   Tetsuo Handa   seq_file: introdu...
792
793
794
795
796
797
798
799
  /**
   * seq_pad - write padding spaces to buffer
   * @m: seq_file identifying the buffer to which data should be written
   * @c: the byte to append after padding if non-zero
   */
  void seq_pad(struct seq_file *m, char c)
  {
  	int size = m->pad_until - m->count;
8cfa67b4d   Andrei Vagin   procfs: optimize ...
800
801
802
803
804
805
806
807
  	if (size > 0) {
  		if (size + m->count > m->size) {
  			seq_set_overflow(m);
  			return;
  		}
  		memset(m->buf + m->count, ' ', size);
  		m->count += size;
  	}
839cc2a94   Tetsuo Handa   seq_file: introdu...
808
809
810
811
  	if (c)
  		seq_putc(m, c);
  }
  EXPORT_SYMBOL(seq_pad);
37607102c   Andy Shevchenko   seq_file: provide...
812
813
814
815
816
817
818
  /* A complete analogue of print_hex_dump() */
  void seq_hex_dump(struct seq_file *m, const char *prefix_str, int prefix_type,
  		  int rowsize, int groupsize, const void *buf, size_t len,
  		  bool ascii)
  {
  	const u8 *ptr = buf;
  	int i, linelen, remaining = len;
8b91a318e   Andy Shevchenko   fs/seq_file: use ...
819
820
  	char *buffer;
  	size_t size;
37607102c   Andy Shevchenko   seq_file: provide...
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
  	int ret;
  
  	if (rowsize != 16 && rowsize != 32)
  		rowsize = 16;
  
  	for (i = 0; i < len && !seq_has_overflowed(m); i += rowsize) {
  		linelen = min(remaining, rowsize);
  		remaining -= rowsize;
  
  		switch (prefix_type) {
  		case DUMP_PREFIX_ADDRESS:
  			seq_printf(m, "%s%p: ", prefix_str, ptr + i);
  			break;
  		case DUMP_PREFIX_OFFSET:
  			seq_printf(m, "%s%.8x: ", prefix_str, i);
  			break;
  		default:
  			seq_printf(m, "%s", prefix_str);
  			break;
  		}
8b91a318e   Andy Shevchenko   fs/seq_file: use ...
841
  		size = seq_get_buf(m, &buffer);
37607102c   Andy Shevchenko   seq_file: provide...
842
  		ret = hex_dump_to_buffer(ptr + i, linelen, rowsize, groupsize,
8b91a318e   Andy Shevchenko   fs/seq_file: use ...
843
844
845
846
847
  					 buffer, size, ascii);
  		seq_commit(m, ret < size ? ret : -1);
  
  		seq_putc(m, '
  ');
37607102c   Andy Shevchenko   seq_file: provide...
848
849
850
  	}
  }
  EXPORT_SYMBOL(seq_hex_dump);
bcf67e162   Pavel Emelianov   Make common helpe...
851
852
853
854
855
856
857
858
859
860
  struct list_head *seq_list_start(struct list_head *head, loff_t pos)
  {
  	struct list_head *lh;
  
  	list_for_each(lh, head)
  		if (pos-- == 0)
  			return lh;
  
  	return NULL;
  }
bcf67e162   Pavel Emelianov   Make common helpe...
861
862
863
864
865
866
867
868
869
  EXPORT_SYMBOL(seq_list_start);
  
  struct list_head *seq_list_start_head(struct list_head *head, loff_t pos)
  {
  	if (!pos)
  		return head;
  
  	return seq_list_start(head, pos - 1);
  }
bcf67e162   Pavel Emelianov   Make common helpe...
870
871
872
873
874
875
876
877
878
879
  EXPORT_SYMBOL(seq_list_start_head);
  
  struct list_head *seq_list_next(void *v, struct list_head *head, loff_t *ppos)
  {
  	struct list_head *lh;
  
  	lh = ((struct list_head *)v)->next;
  	++*ppos;
  	return lh == head ? NULL : lh;
  }
bcf67e162   Pavel Emelianov   Make common helpe...
880
  EXPORT_SYMBOL(seq_list_next);
66655de6d   Li Zefan   seq_file: Add hel...
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
  
  /**
   * seq_hlist_start - start an iteration of a hlist
   * @head: the head of the hlist
   * @pos:  the start position of the sequence
   *
   * Called at seq_file->op->start().
   */
  struct hlist_node *seq_hlist_start(struct hlist_head *head, loff_t pos)
  {
  	struct hlist_node *node;
  
  	hlist_for_each(node, head)
  		if (pos-- == 0)
  			return node;
  	return NULL;
  }
  EXPORT_SYMBOL(seq_hlist_start);
  
  /**
   * seq_hlist_start_head - start an iteration of a hlist
   * @head: the head of the hlist
   * @pos:  the start position of the sequence
   *
   * Called at seq_file->op->start(). Call this function if you want to
   * print a header at the top of the output.
   */
  struct hlist_node *seq_hlist_start_head(struct hlist_head *head, loff_t pos)
  {
  	if (!pos)
  		return SEQ_START_TOKEN;
  
  	return seq_hlist_start(head, pos - 1);
  }
  EXPORT_SYMBOL(seq_hlist_start_head);
  
  /**
   * seq_hlist_next - move to the next position of the hlist
   * @v:    the current iterator
   * @head: the head of the hlist
138860b95   Randy Dunlap   seq_file: fix new...
921
   * @ppos: the current position
66655de6d   Li Zefan   seq_file: Add hel...
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
   *
   * Called at seq_file->op->next().
   */
  struct hlist_node *seq_hlist_next(void *v, struct hlist_head *head,
  				  loff_t *ppos)
  {
  	struct hlist_node *node = v;
  
  	++*ppos;
  	if (v == SEQ_START_TOKEN)
  		return head->first;
  	else
  		return node->next;
  }
  EXPORT_SYMBOL(seq_hlist_next);
1cc523271   stephen hemminger   seq_file: add RCU...
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
  
  /**
   * seq_hlist_start_rcu - start an iteration of a hlist protected by RCU
   * @head: the head of the hlist
   * @pos:  the start position of the sequence
   *
   * Called at seq_file->op->start().
   *
   * This list-traversal primitive may safely run concurrently with
   * the _rcu list-mutation primitives such as hlist_add_head_rcu()
   * as long as the traversal is guarded by rcu_read_lock().
   */
  struct hlist_node *seq_hlist_start_rcu(struct hlist_head *head,
  				       loff_t pos)
  {
  	struct hlist_node *node;
  
  	__hlist_for_each_rcu(node, head)
  		if (pos-- == 0)
  			return node;
  	return NULL;
  }
  EXPORT_SYMBOL(seq_hlist_start_rcu);
  
  /**
   * seq_hlist_start_head_rcu - start an iteration of a hlist protected by RCU
   * @head: the head of the hlist
   * @pos:  the start position of the sequence
   *
   * Called at seq_file->op->start(). Call this function if you want to
   * print a header at the top of the output.
   *
   * This list-traversal primitive may safely run concurrently with
   * the _rcu list-mutation primitives such as hlist_add_head_rcu()
   * as long as the traversal is guarded by rcu_read_lock().
   */
  struct hlist_node *seq_hlist_start_head_rcu(struct hlist_head *head,
  					    loff_t pos)
  {
  	if (!pos)
  		return SEQ_START_TOKEN;
  
  	return seq_hlist_start_rcu(head, pos - 1);
  }
  EXPORT_SYMBOL(seq_hlist_start_head_rcu);
  
  /**
   * seq_hlist_next_rcu - move to the next position of the hlist protected by RCU
   * @v:    the current iterator
   * @head: the head of the hlist
138860b95   Randy Dunlap   seq_file: fix new...
987
   * @ppos: the current position
1cc523271   stephen hemminger   seq_file: add RCU...
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
   *
   * Called at seq_file->op->next().
   *
   * This list-traversal primitive may safely run concurrently with
   * the _rcu list-mutation primitives such as hlist_add_head_rcu()
   * as long as the traversal is guarded by rcu_read_lock().
   */
  struct hlist_node *seq_hlist_next_rcu(void *v,
  				      struct hlist_head *head,
  				      loff_t *ppos)
  {
  	struct hlist_node *node = v;
  
  	++*ppos;
  	if (v == SEQ_START_TOKEN)
  		return rcu_dereference(head->first);
  	else
  		return rcu_dereference(node->next);
  }
  EXPORT_SYMBOL(seq_hlist_next_rcu);
0bc77381c   Jeff Layton   seq_file: add seq...
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
  
  /**
   * seq_hlist_start_precpu - start an iteration of a percpu hlist array
   * @head: pointer to percpu array of struct hlist_heads
   * @cpu:  pointer to cpu "cursor"
   * @pos:  start position of sequence
   *
   * Called at seq_file->op->start().
   */
  struct hlist_node *
  seq_hlist_start_percpu(struct hlist_head __percpu *head, int *cpu, loff_t pos)
  {
  	struct hlist_node *node;
  
  	for_each_possible_cpu(*cpu) {
  		hlist_for_each(node, per_cpu_ptr(head, *cpu)) {
  			if (pos-- == 0)
  				return node;
  		}
  	}
  	return NULL;
  }
  EXPORT_SYMBOL(seq_hlist_start_percpu);
  
  /**
   * seq_hlist_next_percpu - move to the next position of the percpu hlist array
   * @v:    pointer to current hlist_node
   * @head: pointer to percpu array of struct hlist_heads
   * @cpu:  pointer to cpu "cursor"
   * @pos:  start position of sequence
   *
   * Called at seq_file->op->next().
   */
  struct hlist_node *
  seq_hlist_next_percpu(void *v, struct hlist_head __percpu *head,
  			int *cpu, loff_t *pos)
  {
  	struct hlist_node *node = v;
  
  	++*pos;
  
  	if (node->next)
  		return node->next;
  
  	for (*cpu = cpumask_next(*cpu, cpu_possible_mask); *cpu < nr_cpu_ids;
  	     *cpu = cpumask_next(*cpu, cpu_possible_mask)) {
  		struct hlist_head *bucket = per_cpu_ptr(head, *cpu);
  
  		if (!hlist_empty(bucket))
  			return bucket->first;
  	}
  	return NULL;
  }
  EXPORT_SYMBOL(seq_hlist_next_percpu);
096523203   Alexey Dobriyan   seq_file: allocat...
1062
1063
1064
  
  void __init seq_file_init(void)
  {
d64d01a15   Alexey Dobriyan   seq_file: account...
1065
  	seq_file_cache = KMEM_CACHE(seq_file, SLAB_ACCOUNT|SLAB_PANIC);
096523203   Alexey Dobriyan   seq_file: allocat...
1066
  }