Blame view

fs/seq_file.c 24.4 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.
   */
096523203   Alexey Dobriyan   seq_file: allocat...
8
  #include <linux/cache.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
9
  #include <linux/fs.h>
630d9c472   Paul Gortmaker   fs: reduce the us...
10
  #include <linux/export.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
11
  #include <linux/seq_file.h>
058504edd   Heiko Carstens   fs/seq_file: fall...
12
  #include <linux/vmalloc.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
13
  #include <linux/slab.h>
adb37c4c6   Eric W. Biederman   userns: Make seq_...
14
  #include <linux/cred.h>
058504edd   Heiko Carstens   fs/seq_file: fall...
15
  #include <linux/mm.h>
37607102c   Andy Shevchenko   seq_file: provide...
16
  #include <linux/printk.h>
25c6bb76e   Andy Shevchenko   seq_file: reuse s...
17
  #include <linux/string_helpers.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
18

7c0f6ba68   Linus Torvalds   Replace <asm/uacc...
19
  #include <linux/uaccess.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
20
  #include <asm/page.h>
096523203   Alexey Dobriyan   seq_file: allocat...
21
  static struct kmem_cache *seq_file_cache __ro_after_init;
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
22
23
24
25
  static void seq_set_overflow(struct seq_file *m)
  {
  	m->count = m->size;
  }
058504edd   Heiko Carstens   fs/seq_file: fall...
26
27
  static void *seq_buf_alloc(unsigned long size)
  {
d64d01a15   Alexey Dobriyan   seq_file: account...
28
  	return kvmalloc(size, GFP_KERNEL_ACCOUNT);
058504edd   Heiko Carstens   fs/seq_file: fall...
29
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
30
31
32
33
34
35
36
37
38
39
40
41
  /**
   *	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...
42
   *	Returning SEQ_SKIP means "discard this element and move on".
460b865e5   Yann Droneaud   fs: document seq_...
43
44
   *	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
45
   */
15ad7cdcf   Helge Deller   [PATCH] struct se...
46
  int seq_open(struct file *file, const struct seq_operations *op)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
47
  {
189f9841d   Yann Droneaud   fs: allocate stru...
48
49
50
  	struct seq_file *p;
  
  	WARN_ON(file->private_data);
096523203   Alexey Dobriyan   seq_file: allocat...
51
  	p = kmem_cache_zalloc(seq_file_cache, GFP_KERNEL);
189f9841d   Yann Droneaud   fs: allocate stru...
52
53
54
55
  	if (!p)
  		return -ENOMEM;
  
  	file->private_data = p;
1abe77b0f   Al Viro   [PATCH] allow cal...
56

0ac1759ab   Ingo Molnar   [PATCH] sem2mutex...
57
  	mutex_init(&p->lock);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
58
  	p->op = op;
34dbbcdbf   Linus Torvalds   Make file credent...
59
60
61
62
  
  	// 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
63
64
65
66
67
68
69
  
  	/*
  	 * Wrappers around seq_open(e.g. swaps_open) need to be
  	 * aware of this. If they set f_version themselves, they
  	 * should call seq_open first and then set f_version.
  	 */
  	file->f_version = 0;
8f19d4729   Eric Biederman   seq_file: properl...
70
71
72
73
74
75
76
77
78
79
  	/*
  	 * 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
80
81
82
  	return 0;
  }
  EXPORT_SYMBOL(seq_open);
33da8892a   Eric Biederman   seq_file: move tr...
83
84
  static int traverse(struct seq_file *m, loff_t offset)
  {
1f4aace60   NeilBrown   fs/seq_file.c: si...
85
  	loff_t pos = 0;
33da8892a   Eric Biederman   seq_file: move tr...
86
87
88
89
  	int error = 0;
  	void *p;
  
  	m->version = 0;
1f4aace60   NeilBrown   fs/seq_file.c: si...
90
  	m->index = 0;
33da8892a   Eric Biederman   seq_file: move tr...
91
  	m->count = m->from = 0;
1f4aace60   NeilBrown   fs/seq_file.c: si...
92
  	if (!offset)
33da8892a   Eric Biederman   seq_file: move tr...
93
  		return 0;
1f4aace60   NeilBrown   fs/seq_file.c: si...
94

33da8892a   Eric Biederman   seq_file: move tr...
95
  	if (!m->buf) {
058504edd   Heiko Carstens   fs/seq_file: fall...
96
  		m->buf = seq_buf_alloc(m->size = PAGE_SIZE);
33da8892a   Eric Biederman   seq_file: move tr...
97
98
99
  		if (!m->buf)
  			return -ENOMEM;
  	}
1f4aace60   NeilBrown   fs/seq_file.c: si...
100
  	p = m->op->start(m, &m->index);
33da8892a   Eric Biederman   seq_file: move tr...
101
102
103
104
105
106
107
108
109
110
111
  	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 ...
112
  		if (seq_has_overflowed(m))
33da8892a   Eric Biederman   seq_file: move tr...
113
114
115
116
  			goto Eoverflow;
  		if (pos + m->count > offset) {
  			m->from = offset - pos;
  			m->count -= m->from;
33da8892a   Eric Biederman   seq_file: move tr...
117
118
119
120
  			break;
  		}
  		pos += m->count;
  		m->count = 0;
1f4aace60   NeilBrown   fs/seq_file.c: si...
121
122
  		p = m->op->next(m, p, &m->index);
  		if (pos == offset)
33da8892a   Eric Biederman   seq_file: move tr...
123
  			break;
33da8892a   Eric Biederman   seq_file: move tr...
124
125
126
127
128
129
  	}
  	m->op->stop(m, p);
  	return error;
  
  Eoverflow:
  	m->op->stop(m, p);
058504edd   Heiko Carstens   fs/seq_file: fall...
130
  	kvfree(m->buf);
801a76050   Al Viro   seq_file: always ...
131
  	m->count = 0;
058504edd   Heiko Carstens   fs/seq_file: fall...
132
  	m->buf = seq_buf_alloc(m->size <<= 1);
33da8892a   Eric Biederman   seq_file: move tr...
133
134
  	return !m->buf ? -ENOMEM : -EAGAIN;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
135
136
  /**
   *	seq_read -	->read() method for sequential files.
67be2dd1b   Martin Waitz   [PATCH] DocBook: ...
137
138
139
140
   *	@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
141
142
143
144
145
   *
   *	Ready-made ->f_op->read()
   */
  ssize_t seq_read(struct file *file, char __user *buf, size_t size, loff_t *ppos)
  {
8209e2f46   Joe Perches   fs/seq_file.c: Re...
146
  	struct seq_file *m = file->private_data;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
147
  	size_t copied = 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
148
149
150
  	size_t n;
  	void *p;
  	int err = 0;
0ac1759ab   Ingo Molnar   [PATCH] sem2mutex...
151
  	mutex_lock(&m->lock);
8f19d4729   Eric Biederman   seq_file: properl...
152

7904ac842   Earl Chew   seq_file: fix mis...
153
154
155
156
157
158
159
160
161
162
163
164
  	/*
  	 * seq_file->op->..m_start/m_stop/m_next may do special actions
  	 * or optimisations based on the file->f_version, so we want to
  	 * pass the file->f_version to those methods.
  	 *
  	 * seq_file->version is just copy of f_version, and seq_file
  	 * methods can treat it simply as file version.
  	 * It is copied in first and copied out after all operations.
  	 * It is convenient to have it as  part of structure to avoid the
  	 * need of passing another argument to all the seq_file methods.
  	 */
  	m->version = file->f_version;
e522751d6   Tomasz Majchrzak   seq_file: reset i...
165
166
167
168
  	/*
  	 * if request is to read from zero offset, reset iterator to first
  	 * record as it might have been already advanced by previous requests
  	 */
cf5eebae2   Miklos Szeredi   seq_file: fix inc...
169
  	if (*ppos == 0) {
e522751d6   Tomasz Majchrzak   seq_file: reset i...
170
  		m->index = 0;
cf5eebae2   Miklos Szeredi   seq_file: fix inc...
171
172
173
  		m->version = 0;
  		m->count = 0;
  	}
e522751d6   Tomasz Majchrzak   seq_file: reset i...
174

8f19d4729   Eric Biederman   seq_file: properl...
175
176
  	/* Don't assume *ppos is where we left it */
  	if (unlikely(*ppos != m->read_pos)) {
8f19d4729   Eric Biederman   seq_file: properl...
177
178
179
180
181
182
183
184
185
  		while ((err = traverse(m, *ppos)) == -EAGAIN)
  			;
  		if (err) {
  			/* With prejudice... */
  			m->read_pos = 0;
  			m->version = 0;
  			m->index = 0;
  			m->count = 0;
  			goto Done;
7904ac842   Earl Chew   seq_file: fix mis...
186
187
  		} else {
  			m->read_pos = *ppos;
8f19d4729   Eric Biederman   seq_file: properl...
188
189
  		}
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
190
191
  	/* grab buffer if we didn't have one */
  	if (!m->buf) {
058504edd   Heiko Carstens   fs/seq_file: fall...
192
  		m->buf = seq_buf_alloc(m->size = PAGE_SIZE);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
193
194
195
196
197
198
199
200
201
202
203
204
205
206
  		if (!m->buf)
  			goto Enomem;
  	}
  	/* if not empty - flush it first */
  	if (m->count) {
  		n = min(m->count, size);
  		err = copy_to_user(buf, m->buf + m->from, n);
  		if (err)
  			goto Efault;
  		m->count -= n;
  		m->from += n;
  		size -= n;
  		buf += n;
  		copied += n;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
207
208
209
210
  		if (!size)
  			goto Done;
  	}
  	/* we need at least one record in buffer */
1f4aace60   NeilBrown   fs/seq_file.c: si...
211
212
  	m->from = 0;
  	p = m->op->start(m, &m->index);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
213
  	while (1) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
214
215
216
217
  		err = PTR_ERR(p);
  		if (!p || IS_ERR(p))
  			break;
  		err = m->op->show(m, p);
521b5d0c4   Al Viro   [PATCH] teach seq...
218
  		if (err < 0)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
219
  			break;
521b5d0c4   Al Viro   [PATCH] teach seq...
220
221
  		if (unlikely(err))
  			m->count = 0;
4cdfe84b5   Al Viro   [PATCH] deal with...
222
  		if (unlikely(!m->count)) {
1f4aace60   NeilBrown   fs/seq_file.c: si...
223
  			p = m->op->next(m, p, &m->index);
4cdfe84b5   Al Viro   [PATCH] deal with...
224
225
  			continue;
  		}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
226
227
228
  		if (m->count < m->size)
  			goto Fill;
  		m->op->stop(m, p);
058504edd   Heiko Carstens   fs/seq_file: fall...
229
  		kvfree(m->buf);
801a76050   Al Viro   seq_file: always ...
230
  		m->count = 0;
058504edd   Heiko Carstens   fs/seq_file: fall...
231
  		m->buf = seq_buf_alloc(m->size <<= 1);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
232
233
  		if (!m->buf)
  			goto Enomem;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
234
  		m->version = 0;
1f4aace60   NeilBrown   fs/seq_file.c: si...
235
  		p = m->op->start(m, &m->index);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
236
237
238
239
240
241
  	}
  	m->op->stop(m, p);
  	m->count = 0;
  	goto Done;
  Fill:
  	/* they want more? let's try to get some more */
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
247
248
249
  		loff_t pos = m->index;
  
  		p = m->op->next(m, p, &m->index);
  		if (pos == m->index)
  			/* Buggy ->next function */
  			m->index++;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
250
251
252
253
  		if (!p || IS_ERR(p)) {
  			err = PTR_ERR(p);
  			break;
  		}
1f4aace60   NeilBrown   fs/seq_file.c: si...
254
255
  		if (m->count >= size)
  			break;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
256
  		err = m->op->show(m, p);
1f33c41c0   Joe Perches   seq_file: Rename ...
257
  		if (seq_has_overflowed(m) || err) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
258
  			m->count = offs;
521b5d0c4   Al Viro   [PATCH] teach seq...
259
260
  			if (likely(err <= 0))
  				break;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
261
  		}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
262
263
264
265
266
267
268
269
  	}
  	m->op->stop(m, p);
  	n = min(m->count, size);
  	err = copy_to_user(buf, m->buf, n);
  	if (err)
  		goto Efault;
  	copied += n;
  	m->count -= n;
1f4aace60   NeilBrown   fs/seq_file.c: si...
270
  	m->from = n;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
271
272
273
  Done:
  	if (!copied)
  		copied = err;
8f19d4729   Eric Biederman   seq_file: properl...
274
  	else {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
275
  		*ppos += copied;
8f19d4729   Eric Biederman   seq_file: properl...
276
277
  		m->read_pos += copied;
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
278
  	file->f_version = m->version;
0ac1759ab   Ingo Molnar   [PATCH] sem2mutex...
279
  	mutex_unlock(&m->lock);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
280
281
282
283
284
285
286
287
288
  	return copied;
  Enomem:
  	err = -ENOMEM;
  	goto Done;
  Efault:
  	err = -EFAULT;
  	goto Done;
  }
  EXPORT_SYMBOL(seq_read);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
289
290
  /**
   *	seq_lseek -	->llseek() method for sequential files.
67be2dd1b   Martin Waitz   [PATCH] DocBook: ...
291
292
   *	@file: the file in question
   *	@offset: new position
254adaa46   Randy Dunlap   seq_file: fix new...
293
   *	@whence: 0 for absolute, 1 for relative position
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
294
295
296
   *
   *	Ready-made ->f_op->llseek()
   */
965c8e59c   Andrew Morton   lseek: the "whenc...
297
  loff_t seq_lseek(struct file *file, loff_t offset, int whence)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
298
  {
8209e2f46   Joe Perches   fs/seq_file.c: Re...
299
  	struct seq_file *m = file->private_data;
16abef0e9   David Sterba   fs: use loff_t ty...
300
  	loff_t retval = -EINVAL;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
301

0ac1759ab   Ingo Molnar   [PATCH] sem2mutex...
302
  	mutex_lock(&m->lock);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
303
  	m->version = file->f_version;
965c8e59c   Andrew Morton   lseek: the "whenc...
304
  	switch (whence) {
5e62adef9   Andrew Morton   fs/seq_file.c:seq...
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
  	case SEEK_CUR:
  		offset += file->f_pos;
  	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;
  				m->version = 0;
  				m->index = 0;
  				m->count = 0;
  			} else {
  				m->read_pos = offset;
  				retval = file->f_pos = offset;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
324
  			}
05e16745c   Gu Zheng   seq_file: always ...
325
326
  		} else {
  			file->f_pos = offset;
5e62adef9   Andrew Morton   fs/seq_file.c:seq...
327
  		}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
328
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
329
  	file->f_version = m->version;
00c5746da   Alexey Dobriyan   mutex_unlock() la...
330
  	mutex_unlock(&m->lock);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
331
332
333
334
335
336
337
  	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()...
338
   *	@inode: its inode
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
339
340
341
342
343
344
   *
   *	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...
345
  	struct seq_file *m = file->private_data;
058504edd   Heiko Carstens   fs/seq_file: fall...
346
  	kvfree(m->buf);
096523203   Alexey Dobriyan   seq_file: allocat...
347
  	kmem_cache_free(seq_file_cache, m);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
348
349
350
351
352
353
354
355
356
357
358
  	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...
359
360
   *	@esc with usual octal escape.
   *	Use seq_has_overflowed() to check for errors.
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
361
   */
6798a8caa   Joe Perches   fs/seq_file: conv...
362
  void seq_escape(struct seq_file *m, const char *s, const char *esc)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
363
  {
25c6bb76e   Andy Shevchenko   seq_file: reuse s...
364
365
366
  	char *buf;
  	size_t size = seq_get_buf(m, &buf);
  	int ret;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
367

25c6bb76e   Andy Shevchenko   seq_file: reuse s...
368
369
  	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
370
371
  }
  EXPORT_SYMBOL(seq_escape);
6798a8caa   Joe Perches   fs/seq_file: conv...
372
  void seq_vprintf(struct seq_file *m, const char *f, va_list args)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
373
  {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
374
375
376
  	int len;
  
  	if (m->count < m->size) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
377
  		len = vsnprintf(m->buf + m->count, m->size - m->count, f, args);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
378
379
  		if (m->count + len < m->size) {
  			m->count += len;
6798a8caa   Joe Perches   fs/seq_file: conv...
380
  			return;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
381
382
  		}
  	}
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
383
  	seq_set_overflow(m);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
384
  }
a4808147d   Steven Whitehouse   seq_file: Add seq...
385
  EXPORT_SYMBOL(seq_vprintf);
6798a8caa   Joe Perches   fs/seq_file: conv...
386
  void seq_printf(struct seq_file *m, const char *f, ...)
a4808147d   Steven Whitehouse   seq_file: Add seq...
387
  {
a4808147d   Steven Whitehouse   seq_file: Add seq...
388
389
390
  	va_list args;
  
  	va_start(args, f);
6798a8caa   Joe Perches   fs/seq_file: conv...
391
  	seq_vprintf(m, f, args);
a4808147d   Steven Whitehouse   seq_file: Add seq...
392
  	va_end(args);
a4808147d   Steven Whitehouse   seq_file: Add seq...
393
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
394
  EXPORT_SYMBOL(seq_printf);
74e2f334f   Török Edwin   vfs, seqfile: mak...
395
  /**
958086d17   Török Edwin   vfs, seqfile: fix...
396
397
398
399
   *	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...
400
401
402
403
404
405
   *
   *      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...
406
  char *mangle_path(char *s, const char *p, const char *esc)
6092d0481   Ram Pai   [patch 1/7] vfs: ...
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
  {
  	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...
425
  EXPORT_SYMBOL(mangle_path);
6092d0481   Ram Pai   [patch 1/7] vfs: ...
426

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

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

d1be35cb6   Andrei Vagin   proc: add seq_put...
641
  /**
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
642
643
   * 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...
644
645
646
647
648
649
   * @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...
650
651
652
   * 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...
653
654
  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...
655
656
657
658
659
  {
  	int len;
  
  	if (m->count + 2 >= m->size) /* we'll write 2 bytes at least */
  		goto overflow;
48dffbf82   Andrei Vagin   proc: optimize si...
660
661
662
663
664
665
  	if (delimiter && delimiter[0]) {
  		if (delimiter[1] == 0)
  			seq_putc(m, delimiter[0]);
  		else
  			seq_puts(m, delimiter);
  	}
75ba1d07f   Joe Perches   seq/proc: modify ...
666

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

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

1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
677
  	m->count += len;
6798a8caa   Joe Perches   fs/seq_file: conv...
678
  	return;
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
679
  overflow:
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
680
  	seq_set_overflow(m);
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
681
  }
d1be35cb6   Andrei Vagin   proc: add seq_put...
682
683
684
685
686
687
  
  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...
688
  EXPORT_SYMBOL(seq_put_decimal_ull);
0e3dc0191   Andrei Vagin   procfs: add seq_p...
689
690
691
692
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
  /**
   * 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 ...
734
  void seq_put_decimal_ll(struct seq_file *m, const char *delimiter, long long num)
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
735
  {
75ba1d07f   Joe Perches   seq/proc: modify ...
736
737
738
739
  	int len;
  
  	if (m->count + 3 >= m->size) /* we'll write 2 bytes at least */
  		goto overflow;
48dffbf82   Andrei Vagin   proc: optimize si...
740
741
742
743
744
745
  	if (delimiter && delimiter[0]) {
  		if (delimiter[1] == 0)
  			seq_putc(m, delimiter[0]);
  		else
  			seq_puts(m, delimiter);
  	}
75ba1d07f   Joe Perches   seq/proc: modify ...
746
747
748
  
  	if (m->count + 2 >= m->size)
  		goto overflow;
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
749
  	if (num < 0) {
75ba1d07f   Joe Perches   seq/proc: modify ...
750
  		m->buf[m->count++] = '-';
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
751
  		num = -num;
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
752
  	}
75ba1d07f   Joe Perches   seq/proc: modify ...
753
754
755
756
757
  
  	if (num < 10) {
  		m->buf[m->count++] = num + '0';
  		return;
  	}
d1be35cb6   Andrei Vagin   proc: add seq_put...
758
  	len = num_to_str(m->buf + m->count, m->size - m->count, num, 0);
75ba1d07f   Joe Perches   seq/proc: modify ...
759
760
761
762
763
764
765
766
  	if (!len)
  		goto overflow;
  
  	m->count += len;
  	return;
  
  overflow:
  	seq_set_overflow(m);
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
767
768
  }
  EXPORT_SYMBOL(seq_put_decimal_ll);
0b923606e   Peter Oberparleiter   seq_file: add fun...
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
  /**
   * 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...
784
  	seq_set_overflow(seq);
0b923606e   Peter Oberparleiter   seq_file: add fun...
785
786
787
  	return -1;
  }
  EXPORT_SYMBOL(seq_write);
839cc2a94   Tetsuo Handa   seq_file: introdu...
788
789
790
791
792
793
794
795
  /**
   * 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 ...
796
797
798
799
800
801
802
803
  	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...
804
805
806
807
  	if (c)
  		seq_putc(m, c);
  }
  EXPORT_SYMBOL(seq_pad);
37607102c   Andy Shevchenko   seq_file: provide...
808
809
810
811
812
813
814
  /* 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 ...
815
816
  	char *buffer;
  	size_t size;
37607102c   Andy Shevchenko   seq_file: provide...
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
  	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 ...
837
  		size = seq_get_buf(m, &buffer);
37607102c   Andy Shevchenko   seq_file: provide...
838
  		ret = hex_dump_to_buffer(ptr + i, linelen, rowsize, groupsize,
8b91a318e   Andy Shevchenko   fs/seq_file: use ...
839
840
841
842
843
  					 buffer, size, ascii);
  		seq_commit(m, ret < size ? ret : -1);
  
  		seq_putc(m, '
  ');
37607102c   Andy Shevchenko   seq_file: provide...
844
845
846
  	}
  }
  EXPORT_SYMBOL(seq_hex_dump);
bcf67e162   Pavel Emelianov   Make common helpe...
847
848
849
850
851
852
853
854
855
856
  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...
857
858
859
860
861
862
863
864
865
  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...
866
867
868
869
870
871
872
873
874
875
  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...
876
  EXPORT_SYMBOL(seq_list_next);
66655de6d   Li Zefan   seq_file: Add hel...
877
878
879
880
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
  
  /**
   * 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...
917
   * @ppos: the current position
66655de6d   Li Zefan   seq_file: Add hel...
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
   *
   * 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...
933
934
935
936
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
  
  /**
   * 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...
983
   * @ppos: the current position
1cc523271   stephen hemminger   seq_file: add RCU...
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
   *
   * 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...
1004
1005
1006
1007
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
  
  /**
   * 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...
1058
1059
1060
  
  void __init seq_file_init(void)
  {
d64d01a15   Alexey Dobriyan   seq_file: account...
1061
  	seq_file_cache = KMEM_CACHE(seq_file, SLAB_ACCOUNT|SLAB_PANIC);
096523203   Alexey Dobriyan   seq_file: allocat...
1062
  }