seq_file.c 21.1 KB
Newer Older
L
Linus Torvalds 已提交
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>
9
#include <linux/export.h>
L
Linus Torvalds 已提交
10
#include <linux/seq_file.h>
11
#include <linux/vmalloc.h>
L
Linus Torvalds 已提交
12
#include <linux/slab.h>
13
#include <linux/cred.h>
14
#include <linux/mm.h>
L
Linus Torvalds 已提交
15 16 17 18

#include <asm/uaccess.h>
#include <asm/page.h>

19 20 21 22 23
static void seq_set_overflow(struct seq_file *m)
{
	m->count = m->size;
}

24 25 26 27
static void *seq_buf_alloc(unsigned long size)
{
	void *buf;

28 29 30 31 32
	/*
	 * __GFP_NORETRY to avoid oom-killings with high-order allocations -
	 * it's better to fall back to vmalloc() than to kill things.
	 */
	buf = kmalloc(size, GFP_KERNEL | __GFP_NORETRY | __GFP_NOWARN);
33 34 35 36 37
	if (!buf && size > PAGE_SIZE)
		buf = vmalloc(size);
	return buf;
}

L
Linus Torvalds 已提交
38 39 40 41 42 43 44 45 46 47 48 49
/**
 *	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.
50
 *	Returning SEQ_SKIP means "discard this element and move on".
L
Linus Torvalds 已提交
51
 */
52
int seq_open(struct file *file, const struct seq_operations *op)
L
Linus Torvalds 已提交
53
{
54 55 56 57 58 59 60 61 62
	struct seq_file *p;

	WARN_ON(file->private_data);

	p = kzalloc(sizeof(*p), GFP_KERNEL);
	if (!p)
		return -ENOMEM;

	file->private_data = p;
63

I
Ingo Molnar 已提交
64
	mutex_init(&p->lock);
L
Linus Torvalds 已提交
65
	p->op = op;
66 67 68
#ifdef CONFIG_USER_NS
	p->user_ns = file->f_cred->user_ns;
#endif
L
Linus Torvalds 已提交
69 70 71 72 73 74 75 76

	/*
	 * 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;

77 78 79 80 81 82 83 84 85 86
	/*
	 * 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;
L
Linus Torvalds 已提交
87 88 89 90
	return 0;
}
EXPORT_SYMBOL(seq_open);

91 92 93 94 95 96 97 98 99 100 101 102 103 104
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) {
105
		m->buf = seq_buf_alloc(m->size = PAGE_SIZE);
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
		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;
		}
121
		if (seq_has_overflowed(m))
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
			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);
139
	m->index = index;
140 141 142 143
	return error;

Eoverflow:
	m->op->stop(m, p);
144
	kvfree(m->buf);
145
	m->count = 0;
146
	m->buf = seq_buf_alloc(m->size <<= 1);
147 148 149
	return !m->buf ? -ENOMEM : -EAGAIN;
}

L
Linus Torvalds 已提交
150 151
/**
 *	seq_read -	->read() method for sequential files.
152 153 154 155
 *	@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
L
Linus Torvalds 已提交
156 157 158 159 160
 *
 *	Ready-made ->f_op->read()
 */
ssize_t seq_read(struct file *file, char __user *buf, size_t size, loff_t *ppos)
{
161
	struct seq_file *m = file->private_data;
L
Linus Torvalds 已提交
162 163 164 165 166 167
	size_t copied = 0;
	loff_t pos;
	size_t n;
	void *p;
	int err = 0;

I
Ingo Molnar 已提交
168
	mutex_lock(&m->lock);
169

170 171 172 173 174 175 176 177 178 179 180 181 182
	/*
	 * 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;

183 184 185 186 187 188 189 190 191 192 193
	/* Don't assume *ppos is where we left it */
	if (unlikely(*ppos != m->read_pos)) {
		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;
194 195
		} else {
			m->read_pos = *ppos;
196 197 198
		}
	}

L
Linus Torvalds 已提交
199 200
	/* grab buffer if we didn't have one */
	if (!m->buf) {
201
		m->buf = seq_buf_alloc(m->size = PAGE_SIZE);
L
Linus Torvalds 已提交
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
		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 */
222 223
	pos = m->index;
	p = m->op->start(m, &pos);
L
Linus Torvalds 已提交
224 225 226 227 228
	while (1) {
		err = PTR_ERR(p);
		if (!p || IS_ERR(p))
			break;
		err = m->op->show(m, p);
229
		if (err < 0)
L
Linus Torvalds 已提交
230
			break;
231 232
		if (unlikely(err))
			m->count = 0;
233 234 235 236 237
		if (unlikely(!m->count)) {
			p = m->op->next(m, p, &pos);
			m->index = pos;
			continue;
		}
L
Linus Torvalds 已提交
238 239 240
		if (m->count < m->size)
			goto Fill;
		m->op->stop(m, p);
241
		kvfree(m->buf);
242
		m->count = 0;
243
		m->buf = seq_buf_alloc(m->size <<= 1);
L
Linus Torvalds 已提交
244 245 246
		if (!m->buf)
			goto Enomem;
		m->version = 0;
247 248
		pos = m->index;
		p = m->op->start(m, &pos);
L
Linus Torvalds 已提交
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
	}
	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);
264
		if (seq_has_overflowed(m) || err) {
L
Linus Torvalds 已提交
265
			m->count = offs;
266 267
			if (likely(err <= 0))
				break;
L
Linus Torvalds 已提交
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
		}
		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;
286
	else {
L
Linus Torvalds 已提交
287
		*ppos += copied;
288 289
		m->read_pos += copied;
	}
L
Linus Torvalds 已提交
290
	file->f_version = m->version;
I
Ingo Molnar 已提交
291
	mutex_unlock(&m->lock);
L
Linus Torvalds 已提交
292 293 294 295 296 297 298 299 300 301 302 303
	return copied;
Enomem:
	err = -ENOMEM;
	goto Done;
Efault:
	err = -EFAULT;
	goto Done;
}
EXPORT_SYMBOL(seq_read);

/**
 *	seq_lseek -	->llseek() method for sequential files.
304 305
 *	@file: the file in question
 *	@offset: new position
306
 *	@whence: 0 for absolute, 1 for relative position
L
Linus Torvalds 已提交
307 308 309
 *
 *	Ready-made ->f_op->llseek()
 */
310
loff_t seq_lseek(struct file *file, loff_t offset, int whence)
L
Linus Torvalds 已提交
311
{
312
	struct seq_file *m = file->private_data;
313
	loff_t retval = -EINVAL;
L
Linus Torvalds 已提交
314

I
Ingo Molnar 已提交
315
	mutex_lock(&m->lock);
L
Linus Torvalds 已提交
316
	m->version = file->f_version;
317
	switch (whence) {
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
	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;
L
Linus Torvalds 已提交
337
			}
338 339
		} else {
			file->f_pos = offset;
340
		}
L
Linus Torvalds 已提交
341 342
	}
	file->f_version = m->version;
343
	mutex_unlock(&m->lock);
L
Linus Torvalds 已提交
344 345 346 347 348 349 350
	return retval;
}
EXPORT_SYMBOL(seq_lseek);

/**
 *	seq_release -	free the structures associated with sequential file.
 *	@file: file in question
A
Al Viro 已提交
351
 *	@inode: its inode
L
Linus Torvalds 已提交
352 353 354 355 356 357
 *
 *	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)
{
358
	struct seq_file *m = file->private_data;
359
	kvfree(m->buf);
L
Linus Torvalds 已提交
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
	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;
		}
393
		seq_set_overflow(m);
L
Linus Torvalds 已提交
394 395 396 397 398 399 400
		return -1;
        }
	m->count = p - m->buf;
        return 0;
}
EXPORT_SYMBOL(seq_escape);

401
int seq_vprintf(struct seq_file *m, const char *f, va_list args)
L
Linus Torvalds 已提交
402 403 404 405 406 407 408 409 410 411
{
	int len;

	if (m->count < m->size) {
		len = vsnprintf(m->buf + m->count, m->size - m->count, f, args);
		if (m->count + len < m->size) {
			m->count += len;
			return 0;
		}
	}
412
	seq_set_overflow(m);
L
Linus Torvalds 已提交
413 414
	return -1;
}
415 416 417 418 419 420 421 422 423 424 425 426 427
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;
}
L
Linus Torvalds 已提交
428 429
EXPORT_SYMBOL(seq_printf);

430
/**
431 432 433 434
 *	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
435 436 437 438 439 440
 *
 *      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.
 */
A
Al Viro 已提交
441
char *mangle_path(char *s, const char *p, const char *esc)
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
{
	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;
}
460
EXPORT_SYMBOL(mangle_path);
461

462 463 464 465 466 467 468 469
/**
 * 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.
470
 */
A
Al Viro 已提交
471
int seq_path(struct seq_file *m, const struct path *path, const char *esc)
L
Linus Torvalds 已提交
472
{
473 474 475 476 477 478
	char *buf;
	size_t size = seq_get_buf(m, &buf);
	int res = -1;

	if (size) {
		char *p = d_path(path, buf, size);
L
Linus Torvalds 已提交
479
		if (!IS_ERR(p)) {
480 481 482
			char *end = mangle_path(buf, p, esc);
			if (end)
				res = end - buf;
L
Linus Torvalds 已提交
483 484
		}
	}
485 486 487
	seq_commit(m, res);

	return res;
L
Linus Torvalds 已提交
488 489 490
}
EXPORT_SYMBOL(seq_path);

491 492 493
/*
 * Same as seq_path, but relative to supplied root.
 */
A
Al Viro 已提交
494 495
int seq_path_root(struct seq_file *m, const struct path *path,
		  const struct path *root, const char *esc)
496
{
497 498 499 500 501
	char *buf;
	size_t size = seq_get_buf(m, &buf);
	int res = -ENAMETOOLONG;

	if (size) {
502 503
		char *p;

504
		p = __d_path(path, root, buf, size);
505 506
		if (!p)
			return SEQ_SKIP;
507
		res = PTR_ERR(p);
508
		if (!IS_ERR(p)) {
509 510 511 512 513
			char *end = mangle_path(buf, p, esc);
			if (end)
				res = end - buf;
			else
				res = -ENAMETOOLONG;
514 515
		}
	}
516 517
	seq_commit(m, res);

518
	return res < 0 && res != -ENAMETOOLONG ? res : 0;
519 520
}

521 522 523
/*
 * returns the path of the 'dentry' from the root of its filesystem.
 */
A
Al Viro 已提交
524
int seq_dentry(struct seq_file *m, struct dentry *dentry, const char *esc)
525
{
526 527 528 529 530 531
	char *buf;
	size_t size = seq_get_buf(m, &buf);
	int res = -1;

	if (size) {
		char *p = dentry_path(dentry, buf, size);
532
		if (!IS_ERR(p)) {
533 534 535
			char *end = mangle_path(buf, p, esc);
			if (end)
				res = end - buf;
536 537
		}
	}
538 539 540
	seq_commit(m, res);

	return res;
541 542
}

L
Linus Torvalds 已提交
543 544 545 546 547 548 549 550 551 552 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
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);

A
Al Viro 已提交
579 580 581
int single_open_size(struct file *file, int (*show)(struct seq_file *, void *),
		void *data, size_t size)
{
582
	char *buf = seq_buf_alloc(size);
A
Al Viro 已提交
583 584 585 586 587
	int ret;
	if (!buf)
		return -ENOMEM;
	ret = single_open(file, show, data);
	if (ret) {
588
		kvfree(buf);
A
Al Viro 已提交
589 590 591 592 593 594 595 596
		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);

L
Linus Torvalds 已提交
597 598
int single_release(struct inode *inode, struct file *file)
{
599
	const struct seq_operations *op = ((struct seq_file *)file->private_data)->op;
L
Linus Torvalds 已提交
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
	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);

616 617 618 619 620 621 622 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
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);

L
Linus Torvalds 已提交
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666
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;
	}
667
	seq_set_overflow(m);
L
Linus Torvalds 已提交
668 669 670
	return -1;
}
EXPORT_SYMBOL(seq_puts);
671

672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
/*
 * 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;

687 688
	if (delimiter)
		m->buf[m->count++] = delimiter;
689 690 691 692 693 694 695 696 697 698 699 700

	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:
701
	seq_set_overflow(m);
702 703 704 705
	return -1;
}
EXPORT_SYMBOL(seq_put_decimal_ull);

706 707 708 709 710
int seq_put_decimal_ll(struct seq_file *m, char delimiter,
			long long num)
{
	if (num < 0) {
		if (m->count + 3 >= m->size) {
711
			seq_set_overflow(m);
712 713 714 715 716 717 718 719 720 721 722 723
			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);

724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
/**
 * 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;
	}
739
	seq_set_overflow(seq);
740 741 742 743
	return -1;
}
EXPORT_SYMBOL(seq_write);

744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
/**
 * 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);

759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
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;
}
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);
}
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;
}
EXPORT_SYMBOL(seq_list_next);
789 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

/**
 * 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
829
 * @ppos: the current position
830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
 *
 * 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);
845 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

/**
 * 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
895
 * @ppos: the current position
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
 *
 * 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);
916 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

/**
 * 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);