seq_file.c 24.4 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
Linus Torvalds's avatar
Linus Torvalds committed
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.
 */

9
#include <linux/cache.h>
Linus Torvalds's avatar
Linus Torvalds committed
10
#include <linux/fs.h>
11
#include <linux/export.h>
Linus Torvalds's avatar
Linus Torvalds committed
12
#include <linux/seq_file.h>
13
#include <linux/vmalloc.h>
Linus Torvalds's avatar
Linus Torvalds committed
14
#include <linux/slab.h>
15
#include <linux/cred.h>
16
#include <linux/mm.h>
17
#include <linux/printk.h>
18
#include <linux/string_helpers.h>
Linus Torvalds's avatar
Linus Torvalds committed
19

20
#include <linux/uaccess.h>
Linus Torvalds's avatar
Linus Torvalds committed
21 22
#include <asm/page.h>

23 24
static struct kmem_cache *seq_file_cache __ro_after_init;

25 26 27 28 29
static void seq_set_overflow(struct seq_file *m)
{
	m->count = m->size;
}

30 31
static void *seq_buf_alloc(unsigned long size)
{
32
	return kvmalloc(size, GFP_KERNEL_ACCOUNT);
33 34
}

Linus Torvalds's avatar
Linus Torvalds committed
35 36 37 38 39 40 41 42 43 44 45 46
/**
 *	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.
47
 *	Returning SEQ_SKIP means "discard this element and move on".
48 49
 *	Note: seq_open() will allocate a struct seq_file and store its
 *	pointer in @file->private_data. This pointer should not be modified.
Linus Torvalds's avatar
Linus Torvalds committed
50
 */
51
int seq_open(struct file *file, const struct seq_operations *op)
Linus Torvalds's avatar
Linus Torvalds committed
52
{
53 54 55 56
	struct seq_file *p;

	WARN_ON(file->private_data);

57
	p = kmem_cache_zalloc(seq_file_cache, GFP_KERNEL);
58 59 60 61
	if (!p)
		return -ENOMEM;

	file->private_data = p;
62

63
	mutex_init(&p->lock);
Linus Torvalds's avatar
Linus Torvalds committed
64
	p->op = op;
65 66 67 68

	// No refcounting: the lifetime of 'p' is constrained
	// to the lifetime of the file.
	p->file = file;
Linus Torvalds's avatar
Linus Torvalds committed
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;
Linus Torvalds's avatar
Linus Torvalds committed
87 88 89 90
	return 0;
}
EXPORT_SYMBOL(seq_open);

91 92
static int traverse(struct seq_file *m, loff_t offset)
{
93
	loff_t pos = 0;
94 95 96 97
	int error = 0;
	void *p;

	m->version = 0;
98
	m->index = 0;
99
	m->count = m->from = 0;
100
	if (!offset)
101
		return 0;
102

103
	if (!m->buf) {
104
		m->buf = seq_buf_alloc(m->size = PAGE_SIZE);
105 106 107
		if (!m->buf)
			return -ENOMEM;
	}
108
	p = m->op->start(m, &m->index);
109 110 111 112 113 114 115 116 117 118 119
	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;
		}
120
		if (seq_has_overflowed(m))
121 122 123 124 125 126 127 128
			goto Eoverflow;
		if (pos + m->count > offset) {
			m->from = offset - pos;
			m->count -= m->from;
			break;
		}
		pos += m->count;
		m->count = 0;
129 130
		p = m->op->next(m, p, &m->index);
		if (pos == offset)
131 132 133 134 135 136 137
			break;
	}
	m->op->stop(m, p);
	return error;

Eoverflow:
	m->op->stop(m, p);
138
	kvfree(m->buf);
139
	m->count = 0;
140
	m->buf = seq_buf_alloc(m->size <<= 1);
141 142 143
	return !m->buf ? -ENOMEM : -EAGAIN;
}

Linus Torvalds's avatar
Linus Torvalds committed
144 145
/**
 *	seq_read -	->read() method for sequential files.
146 147 148 149
 *	@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
Linus Torvalds's avatar
Linus Torvalds committed
150 151 152 153 154
 *
 *	Ready-made ->f_op->read()
 */
ssize_t seq_read(struct file *file, char __user *buf, size_t size, loff_t *ppos)
{
155
	struct seq_file *m = file->private_data;
Linus Torvalds's avatar
Linus Torvalds committed
156 157 158 159 160
	size_t copied = 0;
	size_t n;
	void *p;
	int err = 0;

161
	mutex_lock(&m->lock);
162

163 164 165 166 167 168 169 170 171 172 173 174 175
	/*
	 * 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;

176 177 178 179
	/*
	 * if request is to read from zero offset, reset iterator to first
	 * record as it might have been already advanced by previous requests
	 */
180
	if (*ppos == 0) {
181
		m->index = 0;
182 183 184
		m->version = 0;
		m->count = 0;
	}
185

186 187 188 189 190 191 192 193 194 195 196
	/* 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;
197 198
		} else {
			m->read_pos = *ppos;
199 200 201
		}
	}

Linus Torvalds's avatar
Linus Torvalds committed
202 203
	/* grab buffer if we didn't have one */
	if (!m->buf) {
204
		m->buf = seq_buf_alloc(m->size = PAGE_SIZE);
Linus Torvalds's avatar
Linus Torvalds committed
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
		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 (!size)
			goto Done;
	}
	/* we need at least one record in buffer */
223 224
	m->from = 0;
	p = m->op->start(m, &m->index);
Linus Torvalds's avatar
Linus Torvalds committed
225 226 227 228 229
	while (1) {
		err = PTR_ERR(p);
		if (!p || IS_ERR(p))
			break;
		err = m->op->show(m, p);
230
		if (err < 0)
Linus Torvalds's avatar
Linus Torvalds committed
231
			break;
232 233
		if (unlikely(err))
			m->count = 0;
234
		if (unlikely(!m->count)) {
235
			p = m->op->next(m, p, &m->index);
236 237
			continue;
		}
Linus Torvalds's avatar
Linus Torvalds committed
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);
Linus Torvalds's avatar
Linus Torvalds committed
244 245 246
		if (!m->buf)
			goto Enomem;
		m->version = 0;
247
		p = m->op->start(m, &m->index);
Linus Torvalds's avatar
Linus Torvalds committed
248 249 250 251 252 253
	}
	m->op->stop(m, p);
	m->count = 0;
	goto Done;
Fill:
	/* they want more? let's try to get some more */
254
	while (1) {
Linus Torvalds's avatar
Linus Torvalds committed
255
		size_t offs = m->count;
256 257 258 259 260 261
		loff_t pos = m->index;

		p = m->op->next(m, p, &m->index);
		if (pos == m->index)
			/* Buggy ->next function */
			m->index++;
Linus Torvalds's avatar
Linus Torvalds committed
262 263 264 265
		if (!p || IS_ERR(p)) {
			err = PTR_ERR(p);
			break;
		}
266 267
		if (m->count >= size)
			break;
Linus Torvalds's avatar
Linus Torvalds committed
268
		err = m->op->show(m, p);
269
		if (seq_has_overflowed(m) || err) {
Linus Torvalds's avatar
Linus Torvalds committed
270
			m->count = offs;
271 272
			if (likely(err <= 0))
				break;
Linus Torvalds's avatar
Linus Torvalds committed
273 274 275 276 277 278 279 280 281
		}
	}
	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;
282
	m->from = n;
Linus Torvalds's avatar
Linus Torvalds committed
283 284 285
Done:
	if (!copied)
		copied = err;
286
	else {
Linus Torvalds's avatar
Linus Torvalds committed
287
		*ppos += copied;
288 289
		m->read_pos += copied;
	}
Linus Torvalds's avatar
Linus Torvalds committed
290
	file->f_version = m->version;
291
	mutex_unlock(&m->lock);
Linus Torvalds's avatar
Linus Torvalds committed
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
Linus Torvalds's avatar
Linus Torvalds committed
307 308 309
 *
 *	Ready-made ->f_op->llseek()
 */
310
loff_t seq_lseek(struct file *file, loff_t offset, int whence)
Linus Torvalds's avatar
Linus Torvalds committed
311
{
312
	struct seq_file *m = file->private_data;
313
	loff_t retval = -EINVAL;
Linus Torvalds's avatar
Linus Torvalds committed
314

315
	mutex_lock(&m->lock);
Linus Torvalds's avatar
Linus Torvalds committed
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;
Linus Torvalds's avatar
Linus Torvalds committed
337
			}
338 339
		} else {
			file->f_pos = offset;
340
		}
Linus Torvalds's avatar
Linus Torvalds committed
341 342
	}
	file->f_version = m->version;
343
	mutex_unlock(&m->lock);
Linus Torvalds's avatar
Linus Torvalds committed
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
351
 *	@inode: its inode
Linus Torvalds's avatar
Linus Torvalds committed
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);
360
	kmem_cache_free(seq_file_cache, m);
Linus Torvalds's avatar
Linus Torvalds committed
361 362 363 364 365 366 367 368 369 370 371
	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
372 373
 *	@esc with usual octal escape.
 *	Use seq_has_overflowed() to check for errors.
Linus Torvalds's avatar
Linus Torvalds committed
374
 */
375
void seq_escape(struct seq_file *m, const char *s, const char *esc)
Linus Torvalds's avatar
Linus Torvalds committed
376
{
377 378 379
	char *buf;
	size_t size = seq_get_buf(m, &buf);
	int ret;
Linus Torvalds's avatar
Linus Torvalds committed
380

381 382
	ret = string_escape_str(s, buf, size, ESCAPE_OCTAL, esc);
	seq_commit(m, ret < size ? ret : -1);
Linus Torvalds's avatar
Linus Torvalds committed
383 384 385
}
EXPORT_SYMBOL(seq_escape);

386
void seq_vprintf(struct seq_file *m, const char *f, va_list args)
Linus Torvalds's avatar
Linus Torvalds committed
387 388 389 390 391 392 393
{
	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;
394
			return;
Linus Torvalds's avatar
Linus Torvalds committed
395 396
		}
	}
397
	seq_set_overflow(m);
Linus Torvalds's avatar
Linus Torvalds committed
398
}
399 400
EXPORT_SYMBOL(seq_vprintf);

401
void seq_printf(struct seq_file *m, const char *f, ...)
402 403 404 405
{
	va_list args;

	va_start(args, f);
406
	seq_vprintf(m, f, args);
407 408
	va_end(args);
}
Linus Torvalds's avatar
Linus Torvalds committed
409 410
EXPORT_SYMBOL(seq_printf);

411
/**
412 413 414 415
 *	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
416 417 418 419 420 421
 *
 *      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.
 */
Al Viro's avatar
Al Viro committed
422
char *mangle_path(char *s, const char *p, const char *esc)
423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
{
	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;
}
441
EXPORT_SYMBOL(mangle_path);
442

443 444 445 446 447 448 449 450
/**
 * 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.
451
 */
Al Viro's avatar
Al Viro committed
452
int seq_path(struct seq_file *m, const struct path *path, const char *esc)
Linus Torvalds's avatar
Linus Torvalds committed
453
{
454 455 456 457 458 459
	char *buf;
	size_t size = seq_get_buf(m, &buf);
	int res = -1;

	if (size) {
		char *p = d_path(path, buf, size);
Linus Torvalds's avatar
Linus Torvalds committed
460
		if (!IS_ERR(p)) {
461 462 463
			char *end = mangle_path(buf, p, esc);
			if (end)
				res = end - buf;
Linus Torvalds's avatar
Linus Torvalds committed
464 465
		}
	}
466 467 468
	seq_commit(m, res);

	return res;
Linus Torvalds's avatar
Linus Torvalds committed
469 470 471
}
EXPORT_SYMBOL(seq_path);

472 473 474 475 476 477 478 479 480 481 482 483 484 485
/**
 * 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);

486 487 488
/*
 * Same as seq_path, but relative to supplied root.
 */
Al Viro's avatar
Al Viro committed
489 490
int seq_path_root(struct seq_file *m, const struct path *path,
		  const struct path *root, const char *esc)
491
{
492 493 494 495 496
	char *buf;
	size_t size = seq_get_buf(m, &buf);
	int res = -ENAMETOOLONG;

	if (size) {
497 498
		char *p;

499
		p = __d_path(path, root, buf, size);
500 501
		if (!p)
			return SEQ_SKIP;
502
		res = PTR_ERR(p);
503
		if (!IS_ERR(p)) {
504 505 506 507 508
			char *end = mangle_path(buf, p, esc);
			if (end)
				res = end - buf;
			else
				res = -ENAMETOOLONG;
509 510
		}
	}
511 512
	seq_commit(m, res);

513
	return res < 0 && res != -ENAMETOOLONG ? res : 0;
514 515
}

516 517 518
/*
 * returns the path of the 'dentry' from the root of its filesystem.
 */
Al Viro's avatar
Al Viro committed
519
int seq_dentry(struct seq_file *m, struct dentry *dentry, const char *esc)
520
{
521 522 523 524 525 526
	char *buf;
	size_t size = seq_get_buf(m, &buf);
	int res = -1;

	if (size) {
		char *p = dentry_path(dentry, buf, size);
527
		if (!IS_ERR(p)) {
528 529 530
			char *end = mangle_path(buf, p, esc);
			if (end)
				res = end - buf;
531 532
		}
	}
533 534 535
	seq_commit(m, res);

	return res;
536
}
537
EXPORT_SYMBOL(seq_dentry);
538

Linus Torvalds's avatar
Linus Torvalds committed
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
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)
{
557
	struct seq_operations *op = kmalloc(sizeof(*op), GFP_KERNEL_ACCOUNT);
Linus Torvalds's avatar
Linus Torvalds committed
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
	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);

Al Viro's avatar
Al Viro committed
575 576 577
int single_open_size(struct file *file, int (*show)(struct seq_file *, void *),
		void *data, size_t size)
{
578
	char *buf = seq_buf_alloc(size);
Al Viro's avatar
Al Viro committed
579 580 581 582 583
	int ret;
	if (!buf)
		return -ENOMEM;
	ret = single_open(file, show, data);
	if (ret) {
584
		kvfree(buf);
Al Viro's avatar
Al Viro committed
585 586 587 588 589 590 591 592
		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);

Linus Torvalds's avatar
Linus Torvalds committed
593 594
int single_release(struct inode *inode, struct file *file)
{
595
	const struct seq_operations *op = ((struct seq_file *)file->private_data)->op;
Linus Torvalds's avatar
Linus Torvalds committed
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611
	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);

612 613 614 615 616 617 618
void *__seq_open_private(struct file *f, const struct seq_operations *ops,
		int psize)
{
	int rc;
	void *private;
	struct seq_file *seq;

619
	private = kzalloc(psize, GFP_KERNEL_ACCOUNT);
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
	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);

645
void seq_putc(struct seq_file *m, char c)
Linus Torvalds's avatar
Linus Torvalds committed
646
{
647 648 649 650
	if (m->count >= m->size)
		return;

	m->buf[m->count++] = c;
Linus Torvalds's avatar
Linus Torvalds committed
651 652 653
}
EXPORT_SYMBOL(seq_putc);

654
void seq_puts(struct seq_file *m, const char *s)
Linus Torvalds's avatar
Linus Torvalds committed
655 656
{
	int len = strlen(s);
657 658 659 660

	if (m->count + len >= m->size) {
		seq_set_overflow(m);
		return;
Linus Torvalds's avatar
Linus Torvalds committed
661
	}
662 663
	memcpy(m->buf + m->count, s, len);
	m->count += len;
Linus Torvalds's avatar
Linus Torvalds committed
664 665
}
EXPORT_SYMBOL(seq_puts);
666

667
/**
668 669
 * A helper routine for putting decimal numbers without rich format of printf().
 * only 'unsigned long long' is supported.
670 671 672 673 674 675
 * @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.
676 677 678
 * 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.
 */
679 680
void seq_put_decimal_ull_width(struct seq_file *m, const char *delimiter,
			 unsigned long long num, unsigned int width)
681 682 683 684 685 686
{
	int len;

	if (m->count + 2 >= m->size) /* we'll write 2 bytes at least */
		goto overflow;

687 688 689 690 691 692
	if (delimiter && delimiter[0]) {
		if (delimiter[1] == 0)
			seq_putc(m, delimiter[0]);
		else
			seq_puts(m, delimiter);
	}
693

694 695 696 697
	if (!width)
		width = 1;

	if (m->count + width >= m->size)
698
		goto overflow;
699

700
	len = num_to_str(m->buf + m->count, m->size - m->count, num, width);
701 702
	if (!len)
		goto overflow;
703

704
	m->count += len;
705 706
	return;

707
overflow:
708
	seq_set_overflow(m);
709
}
710 711 712 713 714 715

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);
}
716 717
EXPORT_SYMBOL(seq_put_decimal_ull);

718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
/**
 * 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;
}

764
void seq_put_decimal_ll(struct seq_file *m, const char *delimiter, long long num)
765
{
766 767 768 769 770
	int len;

	if (m->count + 3 >= m->size) /* we'll write 2 bytes at least */
		goto overflow;

771 772 773 774 775 776
	if (delimiter && delimiter[0]) {
		if (delimiter[1] == 0)
			seq_putc(m, delimiter[0]);
		else
			seq_puts(m, delimiter);
	}
777 778 779 780

	if (m->count + 2 >= m->size)
		goto overflow;

781
	if (num < 0) {
782
		m->buf[m->count++] = '-';
783 784
		num = -num;
	}
785 786 787 788 789 790

	if (num < 10) {
		m->buf[m->count++] = num + '0';
		return;
	}

791
	len = num_to_str(m->buf + m->count, m->size - m->count, num, 0);
792 793 794 795 796 797 798 799
	if (!len)
		goto overflow;

	m->count += len;
	return;

overflow:
	seq_set_overflow(m);
800 801 802
}
EXPORT_SYMBOL(seq_put_decimal_ll);

803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
/**
 * 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;
	}
818
	seq_set_overflow(seq);
819 820 821 822
	return -1;
}
EXPORT_SYMBOL(seq_write);

823 824 825 826 827 828 829 830
/**
 * 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;
831 832 833 834 835 836 837 838
	if (size > 0) {
		if (size + m->count > m->size) {
			seq_set_overflow(m);
			return;
		}
		memset(m->buf + m->count, ' ', size);
		m->count += size;
	}
839 840 841 842 843
	if (c)
		seq_putc(m, c);
}
EXPORT_SYMBOL(seq_pad);

844 845 846 847 848 849 850
/* 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;
851 852
	char *buffer;
	size_t size;
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
	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;
		}

874
		size = seq_get_buf(m, &buffer);
875
		ret = hex_dump_to_buffer(ptr + i, linelen, rowsize, groupsize,
876 877 878 879
					 buffer, size, ascii);
		seq_commit(m, ret < size ? ret : -1);

		seq_putc(m, '\n');
880 881 882 883
	}
}
EXPORT_SYMBOL(seq_hex_dump);

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
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);
914 915 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

/**
 * 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
954
 * @ppos: the current position
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
 *
 * 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);
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019

/**
 * 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
1020
 * @ppos: the current position
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
 *
 * 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);
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094

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

void __init seq_file_init(void)
{
1098
	seq_file_cache = KMEM_CACHE(seq_file, SLAB_ACCOUNT|SLAB_PANIC);
1099
}