Blame view

fs/seq_file.c 21.7 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
4
5
6
7
8
  /*
   * linux/fs/seq_file.c
   *
   * helper functions for making synthetic files from sequences of records.
   * initial implementation -- AV, Oct 2001.
   */
  
  #include <linux/fs.h>
630d9c472   Paul Gortmaker   fs: reduce the us...
9
  #include <linux/export.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
10
11
  #include <linux/seq_file.h>
  #include <linux/slab.h>
adb37c4c6   Eric W. Biederman   userns: Make seq_...
12
  #include <linux/cred.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
13
14
15
  
  #include <asm/uaccess.h>
  #include <asm/page.h>
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
  
  /*
   * seq_files have a buffer which can may overflow. When this happens a larger
   * buffer is reallocated and all the data will be printed again.
   * The overflow state is true when m->count == m->size.
   */
  static bool seq_overflow(struct seq_file *m)
  {
  	return m->count == m->size;
  }
  
  static void seq_set_overflow(struct seq_file *m)
  {
  	m->count = m->size;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
31
32
33
34
35
36
37
38
39
40
41
42
  /**
   *	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...
43
   *	Returning SEQ_SKIP means "discard this element and move on".
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
44
   */
15ad7cdcf   Helge Deller   [PATCH] struct se...
45
  int seq_open(struct file *file, const struct seq_operations *op)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
46
  {
1abe77b0f   Al Viro   [PATCH] allow cal...
47
48
49
50
51
52
53
54
  	struct seq_file *p = file->private_data;
  
  	if (!p) {
  		p = kmalloc(sizeof(*p), GFP_KERNEL);
  		if (!p)
  			return -ENOMEM;
  		file->private_data = p;
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
55
  	memset(p, 0, sizeof(*p));
0ac1759ab   Ingo Molnar   [PATCH] sem2mutex...
56
  	mutex_init(&p->lock);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
57
  	p->op = op;
adb37c4c6   Eric W. Biederman   userns: Make seq_...
58
59
60
  #ifdef CONFIG_USER_NS
  	p->user_ns = file->f_cred->user_ns;
  #endif
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
61
62
63
64
65
66
67
  
  	/*
  	 * 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...
68
69
70
71
72
73
74
75
76
77
  	/*
  	 * 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
78
79
80
  	return 0;
  }
  EXPORT_SYMBOL(seq_open);
33da8892a   Eric Biederman   seq_file: move tr...
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
  static int traverse(struct seq_file *m, loff_t offset)
  {
  	loff_t pos = 0, index;
  	int error = 0;
  	void *p;
  
  	m->version = 0;
  	index = 0;
  	m->count = m->from = 0;
  	if (!offset) {
  		m->index = index;
  		return 0;
  	}
  	if (!m->buf) {
  		m->buf = kmalloc(m->size = PAGE_SIZE, GFP_KERNEL);
  		if (!m->buf)
  			return -ENOMEM;
  	}
  	p = m->op->start(m, &index);
  	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;
  		}
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
111
  		if (seq_overflow(m))
33da8892a   Eric Biederman   seq_file: move tr...
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
  			goto Eoverflow;
  		if (pos + m->count > offset) {
  			m->from = offset - pos;
  			m->count -= m->from;
  			m->index = index;
  			break;
  		}
  		pos += m->count;
  		m->count = 0;
  		if (pos == offset) {
  			index++;
  			m->index = index;
  			break;
  		}
  		p = m->op->next(m, p, &index);
  	}
  	m->op->stop(m, p);
f01d1d546   Alexey Dobriyan   seq_file: fix big...
129
  	m->index = index;
33da8892a   Eric Biederman   seq_file: move tr...
130
131
132
133
134
  	return error;
  
  Eoverflow:
  	m->op->stop(m, p);
  	kfree(m->buf);
801a76050   Al Viro   seq_file: always ...
135
  	m->count = 0;
33da8892a   Eric Biederman   seq_file: move tr...
136
137
138
  	m->buf = kmalloc(m->size <<= 1, GFP_KERNEL);
  	return !m->buf ? -ENOMEM : -EAGAIN;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
139
140
  /**
   *	seq_read -	->read() method for sequential files.
67be2dd1b   Martin Waitz   [PATCH] DocBook: ...
141
142
143
144
   *	@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
145
146
147
148
149
   *
   *	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...
150
  	struct seq_file *m = file->private_data;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
151
152
153
154
155
  	size_t copied = 0;
  	loff_t pos;
  	size_t n;
  	void *p;
  	int err = 0;
0ac1759ab   Ingo Molnar   [PATCH] sem2mutex...
156
  	mutex_lock(&m->lock);
8f19d4729   Eric Biederman   seq_file: properl...
157

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

0ac1759ab   Ingo Molnar   [PATCH] sem2mutex...
300
  	mutex_lock(&m->lock);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
301
  	m->version = file->f_version;
965c8e59c   Andrew Morton   lseek: the "whenc...
302
  	switch (whence) {
5e62adef9   Andrew Morton   fs/seq_file.c:seq...
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
  	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
322
  			}
05e16745c   Gu Zheng   seq_file: always ...
323
324
  		} else {
  			file->f_pos = offset;
5e62adef9   Andrew Morton   fs/seq_file.c:seq...
325
  		}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
326
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
327
  	file->f_version = m->version;
00c5746da   Alexey Dobriyan   mutex_unlock() la...
328
  	mutex_unlock(&m->lock);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
329
330
331
332
333
334
335
  	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()...
336
   *	@inode: its inode
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
337
338
339
340
341
342
   *
   *	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...
343
  	struct seq_file *m = file->private_data;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
  	kfree(m->buf);
  	kfree(m);
  	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
   *	@esc with usual octal escape.  Returns 0 in case of success, -1 - in
   *	case of overflow.
   */
  int seq_escape(struct seq_file *m, const char *s, const char *esc)
  {
  	char *end = m->buf + m->size;
          char *p;
  	char c;
  
          for (p = m->buf + m->count; (c = *s) != '\0' && p < end; s++) {
  		if (!strchr(esc, c)) {
  			*p++ = c;
  			continue;
  		}
  		if (p + 3 < end) {
  			*p++ = '\\';
  			*p++ = '0' + ((c & 0300) >> 6);
  			*p++ = '0' + ((c & 070) >> 3);
  			*p++ = '0' + (c & 07);
  			continue;
  		}
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
378
  		seq_set_overflow(m);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
379
380
381
382
383
384
  		return -1;
          }
  	m->count = p - m->buf;
          return 0;
  }
  EXPORT_SYMBOL(seq_escape);
a4808147d   Steven Whitehouse   seq_file: Add seq...
385
  int seq_vprintf(struct seq_file *m, const char *f, va_list args)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
386
  {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
387
388
389
  	int len;
  
  	if (m->count < m->size) {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
390
  		len = vsnprintf(m->buf + m->count, m->size - m->count, f, args);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
391
392
393
394
395
  		if (m->count + len < m->size) {
  			m->count += len;
  			return 0;
  		}
  	}
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
396
  	seq_set_overflow(m);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
397
398
  	return -1;
  }
a4808147d   Steven Whitehouse   seq_file: Add seq...
399
400
401
402
403
404
405
406
407
408
409
410
411
  EXPORT_SYMBOL(seq_vprintf);
  
  int seq_printf(struct seq_file *m, const char *f, ...)
  {
  	int ret;
  	va_list args;
  
  	va_start(args, f);
  	ret = seq_vprintf(m, f, args);
  	va_end(args);
  
  	return ret;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
412
  EXPORT_SYMBOL(seq_printf);
74e2f334f   Török Edwin   vfs, seqfile: mak...
413
  /**
958086d17   Török Edwin   vfs, seqfile: fix...
414
415
416
417
   *	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...
418
419
420
421
422
423
   *
   *      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...
424
  char *mangle_path(char *s, const char *p, const char *esc)
6092d0481   Ram Pai   [patch 1/7] vfs: ...
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
  {
  	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...
443
  EXPORT_SYMBOL(mangle_path);
6092d0481   Ram Pai   [patch 1/7] vfs: ...
444

52afeefb9   Arjan van de Ven   expand some comme...
445
446
447
448
449
450
451
452
  /**
   * 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: ...
453
   */
8c9379e97   Al Viro   constify seq_file...
454
  int seq_path(struct seq_file *m, const struct path *path, const char *esc)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
455
  {
f84398068   Miklos Szeredi   vfs: seq_file: ad...
456
457
458
459
460
461
  	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
462
  		if (!IS_ERR(p)) {
f84398068   Miklos Szeredi   vfs: seq_file: ad...
463
464
465
  			char *end = mangle_path(buf, p, esc);
  			if (end)
  				res = end - buf;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
466
467
  		}
  	}
f84398068   Miklos Szeredi   vfs: seq_file: ad...
468
469
470
  	seq_commit(m, res);
  
  	return res;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
471
472
  }
  EXPORT_SYMBOL(seq_path);
6092d0481   Ram Pai   [patch 1/7] vfs: ...
473
  /*
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
474
   * Same as seq_path, but relative to supplied root.
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
475
   */
8c9379e97   Al Viro   constify seq_file...
476
477
  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: ...
478
  {
f84398068   Miklos Szeredi   vfs: seq_file: ad...
479
480
481
482
483
  	char *buf;
  	size_t size = seq_get_buf(m, &buf);
  	int res = -ENAMETOOLONG;
  
  	if (size) {
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
484
  		char *p;
f84398068   Miklos Szeredi   vfs: seq_file: ad...
485
  		p = __d_path(path, root, buf, size);
02125a826   Al Viro   fix apparmor dere...
486
487
  		if (!p)
  			return SEQ_SKIP;
f84398068   Miklos Szeredi   vfs: seq_file: ad...
488
  		res = PTR_ERR(p);
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
489
  		if (!IS_ERR(p)) {
f84398068   Miklos Szeredi   vfs: seq_file: ad...
490
491
492
493
494
  			char *end = mangle_path(buf, p, esc);
  			if (end)
  				res = end - buf;
  			else
  				res = -ENAMETOOLONG;
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
495
496
  		}
  	}
f84398068   Miklos Szeredi   vfs: seq_file: ad...
497
  	seq_commit(m, res);
02125a826   Al Viro   fix apparmor dere...
498
  	return res < 0 && res != -ENAMETOOLONG ? res : 0;
9d1bc6013   Miklos Szeredi   [patch 2/7] vfs: ...
499
500
501
  }
  
  /*
6092d0481   Ram Pai   [patch 1/7] vfs: ...
502
503
   * returns the path of the 'dentry' from the root of its filesystem.
   */
8c9379e97   Al Viro   constify seq_file...
504
  int seq_dentry(struct seq_file *m, struct dentry *dentry, const char *esc)
6092d0481   Ram Pai   [patch 1/7] vfs: ...
505
  {
f84398068   Miklos Szeredi   vfs: seq_file: ad...
506
507
508
509
510
511
  	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: ...
512
  		if (!IS_ERR(p)) {
f84398068   Miklos Szeredi   vfs: seq_file: ad...
513
514
515
  			char *end = mangle_path(buf, p, esc);
  			if (end)
  				res = end - buf;
6092d0481   Ram Pai   [patch 1/7] vfs: ...
516
517
  		}
  	}
f84398068   Miklos Szeredi   vfs: seq_file: ad...
518
519
520
  	seq_commit(m, res);
  
  	return res;
6092d0481   Ram Pai   [patch 1/7] vfs: ...
521
  }
cb78a0ce6   Rusty Russell   bitmap: fix seq_b...
522
523
  int seq_bitmap(struct seq_file *m, const unsigned long *bits,
  				   unsigned int nr_bits)
50ac2d694   Alexey Dobriyan   seq_file: add seq...
524
  {
85dd030ed   Lai Jiangshan   seq_file: don't c...
525
526
527
528
529
530
531
  	if (m->count < m->size) {
  		int len = bitmap_scnprintf(m->buf + m->count,
  				m->size - m->count, bits, nr_bits);
  		if (m->count + len < m->size) {
  			m->count += len;
  			return 0;
  		}
50ac2d694   Alexey Dobriyan   seq_file: add seq...
532
  	}
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
533
  	seq_set_overflow(m);
50ac2d694   Alexey Dobriyan   seq_file: add seq...
534
535
  	return -1;
  }
85dd030ed   Lai Jiangshan   seq_file: don't c...
536
  EXPORT_SYMBOL(seq_bitmap);
50ac2d694   Alexey Dobriyan   seq_file: add seq...
537

af76aba00   Rusty Russell   cpumask: fix seq_...
538
  int seq_bitmap_list(struct seq_file *m, const unsigned long *bits,
3eda20118   Lai Jiangshan   seq_file: add seq...
539
540
541
542
543
544
545
546
547
548
  		unsigned int nr_bits)
  {
  	if (m->count < m->size) {
  		int len = bitmap_scnlistprintf(m->buf + m->count,
  				m->size - m->count, bits, nr_bits);
  		if (m->count + len < m->size) {
  			m->count += len;
  			return 0;
  		}
  	}
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
549
  	seq_set_overflow(m);
3eda20118   Lai Jiangshan   seq_file: add seq...
550
551
552
  	return -1;
  }
  EXPORT_SYMBOL(seq_bitmap_list);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
  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)
  {
  	struct seq_operations *op = kmalloc(sizeof(*op), GFP_KERNEL);
  	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...
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
  int single_open_size(struct file *file, int (*show)(struct seq_file *, void *),
  		void *data, size_t size)
  {
  	char *buf = kmalloc(size, GFP_KERNEL);
  	int ret;
  	if (!buf)
  		return -ENOMEM;
  	ret = single_open(file, show, data);
  	if (ret) {
  		kfree(buf);
  		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
605
606
  int single_release(struct inode *inode, struct file *file)
  {
15ad7cdcf   Helge Deller   [PATCH] struct se...
607
  	const struct seq_operations *op = ((struct seq_file *)file->private_data)->op;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
  	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...
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
  void *__seq_open_private(struct file *f, const struct seq_operations *ops,
  		int psize)
  {
  	int rc;
  	void *private;
  	struct seq_file *seq;
  
  	private = kzalloc(psize, GFP_KERNEL);
  	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);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
  int seq_putc(struct seq_file *m, char c)
  {
  	if (m->count < m->size) {
  		m->buf[m->count++] = c;
  		return 0;
  	}
  	return -1;
  }
  EXPORT_SYMBOL(seq_putc);
  
  int seq_puts(struct seq_file *m, const char *s)
  {
  	int len = strlen(s);
  	if (m->count + len < m->size) {
  		memcpy(m->buf + m->count, s, len);
  		m->count += len;
  		return 0;
  	}
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
673
  	seq_set_overflow(m);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
674
675
676
  	return -1;
  }
  EXPORT_SYMBOL(seq_puts);
bcf67e162   Pavel Emelianov   Make common helpe...
677

1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
678
679
680
681
682
683
684
685
686
687
688
689
690
691
  /*
   * A helper routine for putting decimal numbers without rich format of printf().
   * only 'unsigned long long' is supported.
   * This routine will put one byte delimiter + number into seq_file.
   * 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.
   */
  int seq_put_decimal_ull(struct seq_file *m, char delimiter,
  			unsigned long long num)
  {
  	int len;
  
  	if (m->count + 2 >= m->size) /* we'll write 2 bytes at least */
  		goto overflow;
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
692
693
  	if (delimiter)
  		m->buf[m->count++] = delimiter;
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
694
695
696
697
698
699
700
701
702
703
704
705
  
  	if (num < 10) {
  		m->buf[m->count++] = num + '0';
  		return 0;
  	}
  
  	len = num_to_str(m->buf + m->count, m->size - m->count, num);
  	if (!len)
  		goto overflow;
  	m->count += len;
  	return 0;
  overflow:
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
706
  	seq_set_overflow(m);
1ac101a5d   KAMEZAWA Hiroyuki   procfs: add num_t...
707
708
709
  	return -1;
  }
  EXPORT_SYMBOL(seq_put_decimal_ull);
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
710
711
712
713
714
  int seq_put_decimal_ll(struct seq_file *m, char delimiter,
  			long long num)
  {
  	if (num < 0) {
  		if (m->count + 3 >= m->size) {
e075f5915   KAMEZAWA Hiroyuki   seq_file: add seq...
715
  			seq_set_overflow(m);
bda7bad62   KAMEZAWA Hiroyuki   procfs: speed up ...
716
717
718
719
720
721
722
723
724
725
726
  			return -1;
  		}
  		if (delimiter)
  			m->buf[m->count++] = delimiter;
  		num = -num;
  		delimiter = '-';
  	}
  	return seq_put_decimal_ull(m, delimiter, num);
  
  }
  EXPORT_SYMBOL(seq_put_decimal_ll);
0b923606e   Peter Oberparleiter   seq_file: add fun...
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
  /**
   * 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...
742
  	seq_set_overflow(seq);
0b923606e   Peter Oberparleiter   seq_file: add fun...
743
744
745
  	return -1;
  }
  EXPORT_SYMBOL(seq_write);
839cc2a94   Tetsuo Handa   seq_file: introdu...
746
747
748
749
750
751
752
753
754
755
756
757
758
759
  /**
   * 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;
  	if (size > 0)
  		seq_printf(m, "%*s", size, "");
  	if (c)
  		seq_putc(m, c);
  }
  EXPORT_SYMBOL(seq_pad);
bcf67e162   Pavel Emelianov   Make common helpe...
760
761
762
763
764
765
766
767
768
769
  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...
770
771
772
773
774
775
776
777
778
  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...
779
780
781
782
783
784
785
786
787
788
  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...
789
  EXPORT_SYMBOL(seq_list_next);
66655de6d   Li Zefan   seq_file: Add hel...
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
  
  /**
   * 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...
830
   * @ppos: the current position
66655de6d   Li Zefan   seq_file: Add hel...
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
   *
   * 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...
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
  
  /**
   * 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...
896
   * @ppos: the current position
1cc523271   stephen hemminger   seq_file: add RCU...
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
   *
   * 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...
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
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
  
  /**
   * 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);