fs/seq_file.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * linux/fs/seq_file.c
   4  *
   5  * helper functions for making synthetic files from sequences of records.
   6  * initial implementation -- AV, Oct 2001.
   7  */
   8
   9 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  10
  11 #include <linux/cache.h>
  12 #include <linux/fs.h>
  13 #include <linux/export.h>
  14 #include <linux/seq_file.h>
  15 #include <linux/vmalloc.h>
  16 #include <linux/slab.h>
  17 #include <linux/cred.h>
  18 #include <linux/mm.h>
  19 #include <linux/printk.h>
  20 #include <linux/string_helpers.h>
  21 #include <linux/uio.h>
  22
  23 #include <linux/uaccess.h>
  24 #include <asm/page.h>
  25
  26 static struct kmem_cache *seq_file_cache __ro_after_init;
  27
  28 static void seq_set_overflow(struct seq_file *m)
  29 {
  30         m->count = m->size;
  31 }
  32
  33 static void *seq_buf_alloc(unsigned long size)
  34 {
  35         return kvmalloc(size, GFP_KERNEL_ACCOUNT);
  36 }
  37
  38 /**
  39  *      seq_open -      initialize sequential file
  40  *      @file: file we initialize
  41  *      @op: method table describing the sequence
  42  *
  43  *      seq_open() sets @file, associating it with a sequence described
  44  *      by @op.  @op->start() sets the iterator up and returns the first
  45  *      element of sequence. @op->stop() shuts it down.  @op->next()
  46  *      returns the next element of sequence.  @op->show() prints element
  47  *      into the buffer.  In case of error ->start() and ->next() return
  48  *      ERR_PTR(error).  In the end of sequence they return %NULL. ->show()
  49  *      returns 0 in case of success and negative number in case of error.
  50  *      Returning SEQ_SKIP means "discard this element and move on".
  51  *      Note: seq_open() will allocate a struct seq_file and store its
  52  *      pointer in @file->private_data. This pointer should not be modified.
  53  */
  54 int seq_open(struct file *file, const struct seq_operations *op)
  55 {
  56         struct seq_file *p;
  57
  58         WARN_ON(file->private_data);
  59
  60         p = kmem_cache_zalloc(seq_file_cache, GFP_KERNEL);
  61         if (!p)
  62                 return -ENOMEM;
  63
  64         file->private_data = p;
  65
  66         mutex_init(&p->lock);
  67         p->op = op;
  68
  69         // No refcounting: the lifetime of 'p' is constrained
  70         // to the lifetime of the file.
  71         p->file = file;
  72
  73         /*
  74          * seq_files support lseek() and pread().  They do not implement
  75          * write() at all, but we clear FMODE_PWRITE here for historical
  76          * reasons.
  77          *
  78          * If a client of seq_files a) implements file.write() and b) wishes to
  79          * support pwrite() then that client will need to implement its own
  80          * file.open() which calls seq_open() and then sets FMODE_PWRITE.
  81          */
  82         file->f_mode &= ~FMODE_PWRITE;
  83         return 0;
  84 }
  85 EXPORT_SYMBOL(seq_open);
  86
  87 static int traverse(struct seq_file *m, loff_t offset)
  88 {
  89         loff_t pos = 0;
  90         int error = 0;
  91         void *p;
  92
  93         m->index = 0;
  94         m->count = m->from = 0;
  95         if (!offset)
  96                 return 0;
  97
  98         if (!m->buf) {
  99                 m->buf = seq_buf_alloc(m->size = PAGE_SIZE);
 100                 if (!m->buf)
 101                         return -ENOMEM;
 102         }
 103         p = m->op->start(m, &m->index);
 104         while (p) {
 105                 error = PTR_ERR(p);
 106                 if (IS_ERR(p))
 107                         break;
 108                 error = m->op->show(m, p);
 109                 if (error < 0)
 110                         break;
 111                 if (unlikely(error)) {
 112                         error = 0;
 113                         m->count = 0;
 114                 }
 115                 if (seq_has_overflowed(m))
 116                         goto Eoverflow;
 117                 p = m->op->next(m, p, &m->index);
 118                 if (pos + m->count > offset) {
 119                         m->from = offset - pos;
 120                         m->count -= m->from;
 121                         break;
 122                 }
 123                 pos += m->count;
 124                 m->count = 0;
 125                 if (pos == offset)
 126                         break;
 127         }
 128         m->op->stop(m, p);
 129         return error;
 130
 131 Eoverflow:
 132         m->op->stop(m, p);
 133         kvfree(m->buf);
 134         m->count = 0;
 135         m->buf = seq_buf_alloc(m->size <<= 1);
 136         return !m->buf ? -ENOMEM : -EAGAIN;
 137 }
 138
 139 /**
 140  *      seq_read -      ->read() method for sequential files.
 141  *      @file: the file to read from
 142  *      @buf: the buffer to read to
 143  *      @size: the maximum number of bytes to read
 144  *      @ppos: the current position in the file
 145  *
 146  *      Ready-made ->f_op->read()
 147  */
 148 ssize_t seq_read(struct file *file, char __user *buf, size_t size, loff_t *ppos)
 149 {
 150         struct iovec iov = { .iov_base = buf, .iov_len = size};
 151         struct kiocb kiocb;
 152         struct iov_iter iter;
 153         ssize_t ret;
 154
 155         init_sync_kiocb(&kiocb, file);
 156         iov_iter_init(&iter, READ, &iov, 1, size);
 157
 158         kiocb.ki_pos = *ppos;
 159         ret = seq_read_iter(&kiocb, &iter);
 160         *ppos = kiocb.ki_pos;
 161         return ret;
 162 }
 163 EXPORT_SYMBOL(seq_read);
 164
 165 /*
 166  * Ready-made ->f_op->read_iter()
 167  */
 168 ssize_t seq_read_iter(struct kiocb *iocb, struct iov_iter *iter)
 169 {
 170         struct seq_file *m = iocb->ki_filp->private_data;
 171         size_t size = iov_iter_count(iter);
 172         size_t copied = 0;
 173         size_t n;
 174         void *p;
 175         int err = 0;
 176
 177         mutex_lock(&m->lock);
 178
 179         /*
 180          * if request is to read from zero offset, reset iterator to first
 181          * record as it might have been already advanced by previous requests
 182          */
 183         if (iocb->ki_pos == 0) {
 184                 m->index = 0;
 185                 m->count = 0;
 186         }
 187
 188         /* Don't assume ki_pos is where we left it */
 189         if (unlikely(iocb->ki_pos != m->read_pos)) {
 190                 while ((err = traverse(m, iocb->ki_pos)) == -EAGAIN)
 191                         ;
 192                 if (err) {
 193                         /* With prejudice... */
 194                         m->read_pos = 0;
 195                         m->index = 0;
 196                         m->count = 0;
 197                         goto Done;
 198                 } else {
 199                         m->read_pos = iocb->ki_pos;
 200                 }
 201         }
 202
 203         /* grab buffer if we didn't have one */
 204         if (!m->buf) {
 205                 m->buf = seq_buf_alloc(m->size = PAGE_SIZE);
 206                 if (!m->buf)
 207                         goto Enomem;
 208         }
 209         /* if not empty - flush it first */
 210         if (m->count) {
 211                 n = min(m->count, size);
 212                 if (copy_to_iter(m->buf + m->from, n, iter) != n)
 213                         goto Efault;
 214                 m->count -= n;
 215                 m->from += n;
 216                 size -= n;
 217                 copied += n;
 218                 if (!size)
 219                         goto Done;
 220         }
 221         /* we need at least one record in buffer */
 222         m->from = 0;
 223         p = m->op->start(m, &m->index);
 224         while (1) {
 225                 err = PTR_ERR(p);
 226                 if (!p || IS_ERR(p))
 227                         break;
 228                 err = m->op->show(m, p);
 229                 if (err < 0)
 230                         break;
 231                 if (unlikely(err))
 232                         m->count = 0;
 233                 if (unlikely(!m->count)) {
 234                         p = m->op->next(m, p, &m->index);
 235                         continue;
 236                 }
 237                 if (m->count < m->size)
 238                         goto Fill;
 239                 m->op->stop(m, p);
 240                 kvfree(m->buf);
 241                 m->count = 0;
 242                 m->buf = seq_buf_alloc(m->size <<= 1);
 243                 if (!m->buf)
 244                         goto Enomem;
 245                 p = m->op->start(m, &m->index);
 246         }
 247         m->op->stop(m, p);
 248         m->count = 0;
 249         goto Done;
 250 Fill:
 251         /* they want more? let's try to get some more */
 252         while (1) {
 253                 size_t offs = m->count;
 254                 loff_t pos = m->index;
 255
 256                 p = m->op->next(m, p, &m->index);
 257                 if (pos == m->index) {
 258                         pr_info_ratelimited("buggy .next function %ps did not update position index\n",
 259                                             m->op->next);
 260                         m->index++;
 261                 }
 262                 if (!p || IS_ERR(p)) {
 263                         err = PTR_ERR(p);
 264                         break;
 265                 }
 266                 if (m->count >= size)
 267                         break;
 268                 err = m->op->show(m, p);
 269                 if (seq_has_overflowed(m) || err) {
 270                         m->count = offs;
 271                         if (likely(err <= 0))
 272                                 break;
 273                 }
 274         }
 275         m->op->stop(m, p);
 276         n = min(m->count, size);
 277         if (copy_to_iter(m->buf, n, iter) != n)
 278                 goto Efault;
 279         copied += n;
 280         m->count -= n;
 281         m->from = n;
 282 Done:
 283         if (!copied)
 284                 copied = err;
 285         else {
 286                 iocb->ki_pos += copied;
 287                 m->read_pos += copied;
 288         }
 289         mutex_unlock(&m->lock);
 290         return copied;
 291 Enomem:
 292         err = -ENOMEM;
 293         goto Done;
 294 Efault:
 295         err = -EFAULT;
 296         goto Done;
 297 }
 298 EXPORT_SYMBOL(seq_read_iter);
 299
 300 /**
 301  *      seq_lseek -     ->llseek() method for sequential files.
 302  *      @file: the file in question
 303  *      @offset: new position
 304  *      @whence: 0 for absolute, 1 for relative position
 305  *
 306  *      Ready-made ->f_op->llseek()
 307  */
 308 loff_t seq_lseek(struct file *file, loff_t offset, int whence)
 309 {
 310         struct seq_file *m = file->private_data;
 311         loff_t retval = -EINVAL;
 312
 313         mutex_lock(&m->lock);
 314         switch (whence) {
 315         case SEEK_CUR:
 316                 offset += file->f_pos;
 317                 fallthrough;
 318         case SEEK_SET:
 319                 if (offset < 0)
 320                         break;
 321                 retval = offset;
 322                 if (offset != m->read_pos) {
 323                         while ((retval = traverse(m, offset)) == -EAGAIN)
 324                                 ;
 325                         if (retval) {
 326                                 /* with extreme prejudice... */
 327                                 file->f_pos = 0;
 328                                 m->read_pos = 0;
 329                                 m->index = 0;
 330                                 m->count = 0;
 331                         } else {
 332                                 m->read_pos = offset;
 333                                 retval = file->f_pos = offset;
 334                         }
 335                 } else {
 336                         file->f_pos = offset;
 337                 }
 338         }
 339         mutex_unlock(&m->lock);
 340         return retval;
 341 }
 342 EXPORT_SYMBOL(seq_lseek);
 343
 344 /**
 345  *      seq_release -   free the structures associated with sequential file.
 346  *      @file: file in question
 347  *      @inode: its inode
 348  *
 349  *      Frees the structures associated with sequential file; can be used
 350  *      as ->f_op->release() if you don't have private data to destroy.
 351  */
 352 int seq_release(struct inode *inode, struct file *file)
 353 {
 354         struct seq_file *m = file->private_data;
 355         kvfree(m->buf);
 356         kmem_cache_free(seq_file_cache, m);
 357         return 0;
 358 }
 359 EXPORT_SYMBOL(seq_release);
 360
 361 /**
 362  *      seq_escape -    print string into buffer, escaping some characters
 363  *      @m:     target buffer
 364  *      @s:     string
 365  *      @esc:   set of characters that need escaping
 366  *
 367  *      Puts string into buffer, replacing each occurrence of character from
 368  *      @esc with usual octal escape.
 369  *      Use seq_has_overflowed() to check for errors.
 370  */
 371 void seq_escape(struct seq_file *m, const char *s, const char *esc)
 372 {
 373         char *buf;
 374         size_t size = seq_get_buf(m, &buf);
 375         int ret;
 376
 377         ret = string_escape_str(s, buf, size, ESCAPE_OCTAL, esc);
 378         seq_commit(m, ret < size ? ret : -1);
 379 }
 380 EXPORT_SYMBOL(seq_escape);
 381
 382 void seq_escape_mem_ascii(struct seq_file *m, const char *src, size_t isz)
 383 {
 384         char *buf;
 385         size_t size = seq_get_buf(m, &buf);
 386         int ret;
 387
 388         ret = string_escape_mem_ascii(src, isz, buf, size);
 389         seq_commit(m, ret < size ? ret : -1);
 390 }
 391 EXPORT_SYMBOL(seq_escape_mem_ascii);
 392
 393 void seq_vprintf(struct seq_file *m, const char *f, va_list args)
 394 {
 395         int len;
 396
 397         if (m->count < m->size) {
 398                 len = vsnprintf(m->buf + m->count, m->size - m->count, f, args);
 399                 if (m->count + len < m->size) {
 400                         m->count += len;
 401                         return;
 402                 }
 403         }
 404         seq_set_overflow(m);
 405 }
 406 EXPORT_SYMBOL(seq_vprintf);
 407
 408 void seq_printf(struct seq_file *m, const char *f, ...)
 409 {
 410         va_list args;
 411
 412         va_start(args, f);
 413         seq_vprintf(m, f, args);
 414         va_end(args);
 415 }
 416 EXPORT_SYMBOL(seq_printf);
 417
 418 /**
 419  *      mangle_path -   mangle and copy path to buffer beginning
 420  *      @s: buffer start
 421  *      @p: beginning of path in above buffer
 422  *      @esc: set of characters that need escaping
 423  *
 424  *      Copy the path from @p to @s, replacing each occurrence of character from
 425  *      @esc with usual octal escape.
 426  *      Returns pointer past last written character in @s, or NULL in case of
 427  *      failure.
 428  */
 429 char *mangle_path(char *s, const char *p, const char *esc)
 430 {
 431         while (s <= p) {
 432                 char c = *p++;
 433                 if (!c) {
 434                         return s;
 435                 } else if (!strchr(esc, c)) {
 436                         *s++ = c;
 437                 } else if (s + 4 > p) {
 438                         break;
 439                 } else {
 440                         *s++ = '\\';
 441                         *s++ = '0' + ((c & 0300) >> 6);
 442                         *s++ = '0' + ((c & 070) >> 3);
 443                         *s++ = '0' + (c & 07);
 444                 }
 445         }
 446         return NULL;
 447 }
 448 EXPORT_SYMBOL(mangle_path);
 449
 450 /**
 451  * seq_path - seq_file interface to print a pathname
 452  * @m: the seq_file handle
 453  * @path: the struct path to print
 454  * @esc: set of characters to escape in the output
 455  *
 456  * return the absolute path of 'path', as represented by the
 457  * dentry / mnt pair in the path parameter.
 458  */
 459 int seq_path(struct seq_file *m, const struct path *path, const char *esc)
 460 {
 461         char *buf;
 462         size_t size = seq_get_buf(m, &buf);
 463         int res = -1;
 464
 465         if (size) {
 466                 char *p = d_path(path, buf, size);
 467                 if (!IS_ERR(p)) {
 468                         char *end = mangle_path(buf, p, esc);
 469                         if (end)
 470                                 res = end - buf;
 471                 }
 472         }
 473         seq_commit(m, res);
 474
 475         return res;
 476 }
 477 EXPORT_SYMBOL(seq_path);
 478
 479 /**
 480  * seq_file_path - seq_file interface to print a pathname of a file
 481  * @m: the seq_file handle
 482  * @file: the struct file to print
 483  * @esc: set of characters to escape in the output
 484  *
 485  * return the absolute path to the file.
 486  */
 487 int seq_file_path(struct seq_file *m, struct file *file, const char *esc)
 488 {
 489         return seq_path(m, &file->f_path, esc);
 490 }
 491 EXPORT_SYMBOL(seq_file_path);
 492
 493 /*
 494  * Same as seq_path, but relative to supplied root.
 495  */
 496 int seq_path_root(struct seq_file *m, const struct path *path,
 497                   const struct path *root, const char *esc)
 498 {
 499         char *buf;
 500         size_t size = seq_get_buf(m, &buf);
 501         int res = -ENAMETOOLONG;
 502
 503         if (size) {
 504                 char *p;
 505
 506                 p = __d_path(path, root, buf, size);
 507                 if (!p)
 508                         return SEQ_SKIP;
 509                 res = PTR_ERR(p);
 510                 if (!IS_ERR(p)) {
 511                         char *end = mangle_path(buf, p, esc);
 512                         if (end)
 513                                 res = end - buf;
 514                         else
 515                                 res = -ENAMETOOLONG;
 516                 }
 517         }
 518         seq_commit(m, res);
 519
 520         return res < 0 && res != -ENAMETOOLONG ? res : 0;
 521 }
 522
 523 /*
 524  * returns the path of the 'dentry' from the root of its filesystem.
 525  */
 526 int seq_dentry(struct seq_file *m, struct dentry *dentry, const char *esc)
 527 {
 528         char *buf;
 529         size_t size = seq_get_buf(m, &buf);
 530         int res = -1;
 531
 532         if (size) {
 533                 char *p = dentry_path(dentry, buf, size);
 534                 if (!IS_ERR(p)) {
 535                         char *end = mangle_path(buf, p, esc);
 536                         if (end)
 537                                 res = end - buf;
 538                 }
 539         }
 540         seq_commit(m, res);
 541
 542         return res;
 543 }
 544 EXPORT_SYMBOL(seq_dentry);
 545
 546 static void *single_start(struct seq_file *p, loff_t *pos)
 547 {
 548         return NULL + (*pos == 0);
 549 }
 550
 551 static void *single_next(struct seq_file *p, void *v, loff_t *pos)
 552 {
 553         ++*pos;
 554         return NULL;
 555 }
 556
 557 static void single_stop(struct seq_file *p, void *v)
 558 {
 559 }
 560
 561 int single_open(struct file *file, int (*show)(struct seq_file *, void *),
 562                 void *data)
 563 {
 564         struct seq_operations *op = kmalloc(sizeof(*op), GFP_KERNEL_ACCOUNT);
 565         int res = -ENOMEM;
 566
 567         if (op) {
 568                 op->start = single_start;
 569                 op->next = single_next;
 570                 op->stop = single_stop;
 571                 op->show = show;
 572                 res = seq_open(file, op);
 573                 if (!res)
 574                         ((struct seq_file *)file->private_data)->private = data;
 575                 else
 576                         kfree(op);
 577         }
 578         return res;
 579 }
 580 EXPORT_SYMBOL(single_open);
 581
 582 int single_open_size(struct file *file, int (*show)(struct seq_file *, void *),
 583                 void *data, size_t size)
 584 {
 585         char *buf = seq_buf_alloc(size);
 586         int ret;
 587         if (!buf)
 588                 return -ENOMEM;
 589         ret = single_open(file, show, data);
 590         if (ret) {
 591                 kvfree(buf);
 592                 return ret;
 593         }
 594         ((struct seq_file *)file->private_data)->buf = buf;
 595         ((struct seq_file *)file->private_data)->size = size;
 596         return 0;
 597 }
 598 EXPORT_SYMBOL(single_open_size);
 599
 600 int single_release(struct inode *inode, struct file *file)
 601 {
 602         const struct seq_operations *op = ((struct seq_file *)file->private_data)->op;
 603         int res = seq_release(inode, file);
 604         kfree(op);
 605         return res;
 606 }
 607 EXPORT_SYMBOL(single_release);
 608
 609 int seq_release_private(struct inode *inode, struct file *file)
 610 {
 611         struct seq_file *seq = file->private_data;
 612
 613         kfree(seq->private);
 614         seq->private = NULL;
 615         return seq_release(inode, file);
 616 }
 617 EXPORT_SYMBOL(seq_release_private);
 618
 619 void *__seq_open_private(struct file *f, const struct seq_operations *ops,
 620                 int psize)
 621 {
 622         int rc;
 623         void *private;
 624         struct seq_file *seq;
 625
 626         private = kzalloc(psize, GFP_KERNEL_ACCOUNT);
 627         if (private == NULL)
 628                 goto out;
 629
 630         rc = seq_open(f, ops);
 631         if (rc < 0)
 632                 goto out_free;
 633
 634         seq = f->private_data;
 635         seq->private = private;
 636         return private;
 637
 638 out_free:
 639         kfree(private);
 640 out:
 641         return NULL;
 642 }
 643 EXPORT_SYMBOL(__seq_open_private);
 644
 645 int seq_open_private(struct file *filp, const struct seq_operations *ops,
 646                 int psize)
 647 {
 648         return __seq_open_private(filp, ops, psize) ? 0 : -ENOMEM;
 649 }
 650 EXPORT_SYMBOL(seq_open_private);
 651
 652 void seq_putc(struct seq_file *m, char c)
 653 {
 654         if (m->count >= m->size)
 655                 return;
 656
 657         m->buf[m->count++] = c;
 658 }
 659 EXPORT_SYMBOL(seq_putc);
 660
 661 void seq_puts(struct seq_file *m, const char *s)
 662 {
 663         int len = strlen(s);
 664
 665         if (m->count + len >= m->size) {
 666                 seq_set_overflow(m);
 667                 return;
 668         }
 669         memcpy(m->buf + m->count, s, len);
 670         m->count += len;
 671 }
 672 EXPORT_SYMBOL(seq_puts);
 673
 674 /**
 675  * A helper routine for putting decimal numbers without rich format of printf().
 676  * only 'unsigned long long' is supported.
 677  * @m: seq_file identifying the buffer to which data should be written
 678  * @delimiter: a string which is printed before the number
 679  * @num: the number
 680  * @width: a minimum field width
 681  *
 682  * This routine will put strlen(delimiter) + number into seq_filed.
 683  * This routine is very quick when you show lots of numbers.
 684  * In usual cases, it will be better to use seq_printf(). It's easier to read.
 685  */
 686 void seq_put_decimal_ull_width(struct seq_file *m, const char *delimiter,
 687                          unsigned long long num, unsigned int width)
 688 {
 689         int len;
 690
 691         if (m->count + 2 >= m->size) /* we'll write 2 bytes at least */
 692                 goto overflow;
 693
 694         if (delimiter && delimiter[0]) {
 695                 if (delimiter[1] == 0)
 696                         seq_putc(m, delimiter[0]);
 697                 else
 698                         seq_puts(m, delimiter);
 699         }
 700
 701         if (!width)
 702                 width = 1;
 703
 704         if (m->count + width >= m->size)
 705                 goto overflow;
 706
 707         len = num_to_str(m->buf + m->count, m->size - m->count, num, width);
 708         if (!len)
 709                 goto overflow;
 710
 711         m->count += len;
 712         return;
 713
 714 overflow:
 715         seq_set_overflow(m);
 716 }
 717
 718 void seq_put_decimal_ull(struct seq_file *m, const char *delimiter,
 719                          unsigned long long num)
 720 {
 721         return seq_put_decimal_ull_width(m, delimiter, num, 0);
 722 }
 723 EXPORT_SYMBOL(seq_put_decimal_ull);
 724
 725 /**
 726  * seq_put_hex_ll - put a number in hexadecimal notation
 727  * @m: seq_file identifying the buffer to which data should be written
 728  * @delimiter: a string which is printed before the number
 729  * @v: the number
 730  * @width: a minimum field width
 731  *
 732  * seq_put_hex_ll(m, "", v, 8) is equal to seq_printf(m, "%08llx", v)
 733  *
 734  * This routine is very quick when you show lots of numbers.
 735  * In usual cases, it will be better to use seq_printf(). It's easier to read.
 736  */
 737 void seq_put_hex_ll(struct seq_file *m, const char *delimiter,
 738                                 unsigned long long v, unsigned int width)
 739 {
 740         unsigned int len;
 741         int i;
 742
 743         if (delimiter && delimiter[0]) {
 744                 if (delimiter[1] == 0)
 745                         seq_putc(m, delimiter[0]);
 746                 else
 747                         seq_puts(m, delimiter);
 748         }
 749
 750         /* If x is 0, the result of __builtin_clzll is undefined */
 751         if (v == 0)
 752                 len = 1;
 753         else
 754                 len = (sizeof(v) * 8 - __builtin_clzll(v) + 3) / 4;
 755
 756         if (len < width)
 757                 len = width;
 758
 759         if (m->count + len > m->size) {
 760                 seq_set_overflow(m);
 761                 return;
 762         }
 763
 764         for (i = len - 1; i >= 0; i--) {
 765                 m->buf[m->count + i] = hex_asc[0xf & v];
 766                 v = v >> 4;
 767         }
 768         m->count += len;
 769 }
 770
 771 void seq_put_decimal_ll(struct seq_file *m, const char *delimiter, long long num)
 772 {
 773         int len;
 774
 775         if (m->count + 3 >= m->size) /* we'll write 2 bytes at least */
 776                 goto overflow;
 777
 778         if (delimiter && delimiter[0]) {
 779                 if (delimiter[1] == 0)
 780                         seq_putc(m, delimiter[0]);
 781                 else
 782                         seq_puts(m, delimiter);
 783         }
 784
 785         if (m->count + 2 >= m->size)
 786                 goto overflow;
 787
 788         if (num < 0) {
 789                 m->buf[m->count++] = '-';
 790                 num = -num;
 791         }
 792
 793         if (num < 10) {
 794                 m->buf[m->count++] = num + '0';
 795                 return;
 796         }
 797
 798         len = num_to_str(m->buf + m->count, m->size - m->count, num, 0);
 799         if (!len)
 800                 goto overflow;
 801
 802         m->count += len;
 803         return;
 804
 805 overflow:
 806         seq_set_overflow(m);
 807 }
 808 EXPORT_SYMBOL(seq_put_decimal_ll);
 809
 810 /**
 811  * seq_write - write arbitrary data to buffer
 812  * @seq: seq_file identifying the buffer to which data should be written
 813  * @data: data address
 814  * @len: number of bytes
 815  *
 816  * Return 0 on success, non-zero otherwise.
 817  */
 818 int seq_write(struct seq_file *seq, const void *data, size_t len)
 819 {
 820         if (seq->count + len < seq->size) {
 821                 memcpy(seq->buf + seq->count, data, len);
 822                 seq->count += len;
 823                 return 0;
 824         }
 825         seq_set_overflow(seq);
 826         return -1;
 827 }
 828 EXPORT_SYMBOL(seq_write);
 829
 830 /**
 831  * seq_pad - write padding spaces to buffer
 832  * @m: seq_file identifying the buffer to which data should be written
 833  * @c: the byte to append after padding if non-zero
 834  */
 835 void seq_pad(struct seq_file *m, char c)
 836 {
 837         int size = m->pad_until - m->count;
 838         if (size > 0) {
 839                 if (size + m->count > m->size) {
 840                         seq_set_overflow(m);
 841                         return;
 842                 }
 843                 memset(m->buf + m->count, ' ', size);
 844                 m->count += size;
 845         }
 846         if (c)
 847                 seq_putc(m, c);
 848 }
 849 EXPORT_SYMBOL(seq_pad);
 850
 851 /* A complete analogue of print_hex_dump() */
 852 void seq_hex_dump(struct seq_file *m, const char *prefix_str, int prefix_type,
 853                   int rowsize, int groupsize, const void *buf, size_t len,
 854                   bool ascii)
 855 {
 856         const u8 *ptr = buf;
 857         int i, linelen, remaining = len;
 858         char *buffer;
 859         size_t size;
 860         int ret;
 861
 862         if (rowsize != 16 && rowsize != 32)
 863                 rowsize = 16;
 864
 865         for (i = 0; i < len && !seq_has_overflowed(m); i += rowsize) {
 866                 linelen = min(remaining, rowsize);
 867                 remaining -= rowsize;
 868
 869                 switch (prefix_type) {
 870                 case DUMP_PREFIX_ADDRESS:
 871                         seq_printf(m, "%s%p: ", prefix_str, ptr + i);
 872                         break;
 873                 case DUMP_PREFIX_OFFSET:
 874                         seq_printf(m, "%s%.8x: ", prefix_str, i);
 875                         break;
 876                 default:
 877                         seq_printf(m, "%s", prefix_str);
 878                         break;
 879                 }
 880
 881                 size = seq_get_buf(m, &buffer);
 882                 ret = hex_dump_to_buffer(ptr + i, linelen, rowsize, groupsize,
 883                                          buffer, size, ascii);
 884                 seq_commit(m, ret < size ? ret : -1);
 885
 886                 seq_putc(m, '\n');
 887         }
 888 }
 889 EXPORT_SYMBOL(seq_hex_dump);
 890
 891 struct list_head *seq_list_start(struct list_head *head, loff_t pos)
 892 {
 893         struct list_head *lh;
 894
 895         list_for_each(lh, head)
 896                 if (pos-- == 0)
 897                         return lh;
 898
 899         return NULL;
 900 }
 901 EXPORT_SYMBOL(seq_list_start);
 902
 903 struct list_head *seq_list_start_head(struct list_head *head, loff_t pos)
 904 {
 905         if (!pos)
 906                 return head;
 907
 908         return seq_list_start(head, pos - 1);
 909 }
 910 EXPORT_SYMBOL(seq_list_start_head);
 911
 912 struct list_head *seq_list_next(void *v, struct list_head *head, loff_t *ppos)
 913 {
 914         struct list_head *lh;
 915
 916         lh = ((struct list_head *)v)->next;
 917         ++*ppos;
 918         return lh == head ? NULL : lh;
 919 }
 920 EXPORT_SYMBOL(seq_list_next);
 921
 922 /**
 923  * seq_hlist_start - start an iteration of a hlist
 924  * @head: the head of the hlist
 925  * @pos:  the start position of the sequence
 926  *
 927  * Called at seq_file->op->start().
 928  */
 929 struct hlist_node *seq_hlist_start(struct hlist_head *head, loff_t pos)
 930 {
 931         struct hlist_node *node;
 932
 933         hlist_for_each(node, head)
 934                 if (pos-- == 0)
 935                         return node;
 936         return NULL;
 937 }
 938 EXPORT_SYMBOL(seq_hlist_start);
 939
 940 /**
 941  * seq_hlist_start_head - start an iteration of a hlist
 942  * @head: the head of the hlist
 943  * @pos:  the start position of the sequence
 944  *
 945  * Called at seq_file->op->start(). Call this function if you want to
 946  * print a header at the top of the output.
 947  */
 948 struct hlist_node *seq_hlist_start_head(struct hlist_head *head, loff_t pos)
 949 {
 950         if (!pos)
 951                 return SEQ_START_TOKEN;
 952
 953         return seq_hlist_start(head, pos - 1);
 954 }
 955 EXPORT_SYMBOL(seq_hlist_start_head);
 956
 957 /**
 958  * seq_hlist_next - move to the next position of the hlist
 959  * @v:    the current iterator
 960  * @head: the head of the hlist
 961  * @ppos: the current position
 962  *
 963  * Called at seq_file->op->next().
 964  */
 965 struct hlist_node *seq_hlist_next(void *v, struct hlist_head *head,
 966                                   loff_t *ppos)
 967 {
 968         struct hlist_node *node = v;
 969
 970         ++*ppos;
 971         if (v == SEQ_START_TOKEN)
 972                 return head->first;
 973         else
 974                 return node->next;
 975 }
 976 EXPORT_SYMBOL(seq_hlist_next);
 977
 978 /**
 979  * seq_hlist_start_rcu - start an iteration of a hlist protected by RCU
 980  * @head: the head of the hlist
 981  * @pos:  the start position of the sequence
 982  *
 983  * Called at seq_file->op->start().
 984  *
 985  * This list-traversal primitive may safely run concurrently with
 986  * the _rcu list-mutation primitives such as hlist_add_head_rcu()
 987  * as long as the traversal is guarded by rcu_read_lock().
 988  */
 989 struct hlist_node *seq_hlist_start_rcu(struct hlist_head *head,
 990                                        loff_t pos)
 991 {
 992         struct hlist_node *node;
 993
 994         __hlist_for_each_rcu(node, head)
 995                 if (pos-- == 0)
 996                         return node;
 997         return NULL;
 998 }
 999 EXPORT_SYMBOL(seq_hlist_start_rcu);
1000
1001 /**
1002  * seq_hlist_start_head_rcu - start an iteration of a hlist protected by RCU
1003  * @head: the head of the hlist
1004  * @pos:  the start position of the sequence
1005  *
1006  * Called at seq_file->op->start(). Call this function if you want to
1007  * print a header at the top of the output.
1008  *
1009  * This list-traversal primitive may safely run concurrently with
1010  * the _rcu list-mutation primitives such as hlist_add_head_rcu()
1011  * as long as the traversal is guarded by rcu_read_lock().
1012  */
1013 struct hlist_node *seq_hlist_start_head_rcu(struct hlist_head *head,
1014                                             loff_t pos)
1015 {
1016         if (!pos)
1017                 return SEQ_START_TOKEN;
1018
1019         return seq_hlist_start_rcu(head, pos - 1);
1020 }
1021 EXPORT_SYMBOL(seq_hlist_start_head_rcu);
1022
1023 /**
1024  * seq_hlist_next_rcu - move to the next position of the hlist protected by RCU
1025  * @v:    the current iterator
1026  * @head: the head of the hlist
1027  * @ppos: the current position
1028  *
1029  * Called at seq_file->op->next().
1030  *
1031  * This list-traversal primitive may safely run concurrently with
1032  * the _rcu list-mutation primitives such as hlist_add_head_rcu()
1033  * as long as the traversal is guarded by rcu_read_lock().
1034  */
1035 struct hlist_node *seq_hlist_next_rcu(void *v,
1036                                       struct hlist_head *head,
1037                                       loff_t *ppos)
1038 {
1039         struct hlist_node *node = v;
1040
1041         ++*ppos;
1042         if (v == SEQ_START_TOKEN)
1043                 return rcu_dereference(head->first);
1044         else
1045                 return rcu_dereference(node->next);
1046 }
1047 EXPORT_SYMBOL(seq_hlist_next_rcu);
1048
1049 /**
1050  * seq_hlist_start_precpu - start an iteration of a percpu hlist array
1051  * @head: pointer to percpu array of struct hlist_heads
1052  * @cpu:  pointer to cpu "cursor"
1053  * @pos:  start position of sequence
1054  *
1055  * Called at seq_file->op->start().
1056  */
1057 struct hlist_node *
1058 seq_hlist_start_percpu(struct hlist_head __percpu *head, int *cpu, loff_t pos)
1059 {
1060         struct hlist_node *node;
1061
1062         for_each_possible_cpu(*cpu) {
1063                 hlist_for_each(node, per_cpu_ptr(head, *cpu)) {
1064                         if (pos-- == 0)
1065                                 return node;
1066                 }
1067         }
1068         return NULL;
1069 }
1070 EXPORT_SYMBOL(seq_hlist_start_percpu);
1071
1072 /**
1073  * seq_hlist_next_percpu - move to the next position of the percpu hlist array
1074  * @v:    pointer to current hlist_node
1075  * @head: pointer to percpu array of struct hlist_heads
1076  * @cpu:  pointer to cpu "cursor"
1077  * @pos:  start position of sequence
1078  *
1079  * Called at seq_file->op->next().
1080  */
1081 struct hlist_node *
1082 seq_hlist_next_percpu(void *v, struct hlist_head __percpu *head,
1083                         int *cpu, loff_t *pos)
1084 {
1085         struct hlist_node *node = v;
1086
1087         ++*pos;
1088
1089         if (node->next)
1090                 return node->next;
1091
1092         for (*cpu = cpumask_next(*cpu, cpu_possible_mask); *cpu < nr_cpu_ids;
1093              *cpu = cpumask_next(*cpu, cpu_possible_mask)) {
1094                 struct hlist_head *bucket = per_cpu_ptr(head, *cpu);
1095
1096                 if (!hlist_empty(bucket))
1097                         return bucket->first;
1098         }
1099         return NULL;
1100 }
1101 EXPORT_SYMBOL(seq_hlist_next_percpu);
1102
1103 void __init seq_file_init(void)
1104 {
1105         seq_file_cache = KMEM_CACHE(seq_file, SLAB_ACCOUNT|SLAB_PANIC);
1106 }