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