4 * helper functions for making synthetic files from sequences of records.
5 * initial implementation -- AV, Oct 2001.
9 #include <linux/export.h>
10 #include <linux/seq_file.h>
11 #include <linux/vmalloc.h>
12 #include <linux/slab.h>
13 #include <linux/cred.h>
16 #include <asm/uaccess.h>
19 static void seq_set_overflow(struct seq_file
*m
)
24 static void *seq_buf_alloc(unsigned long size
)
29 * __GFP_NORETRY to avoid oom-killings with high-order allocations -
30 * it's better to fall back to vmalloc() than to kill things.
32 buf
= kmalloc(size
, GFP_KERNEL
| __GFP_NORETRY
| __GFP_NOWARN
);
33 if (!buf
&& size
> PAGE_SIZE
)
39 * seq_open - initialize sequential file
40 * @file: file we initialize
41 * @op: method table describing the sequence
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".
52 int seq_open(struct file
*file
, const struct seq_operations
*op
)
54 struct seq_file
*p
= file
->private_data
;
57 p
= kmalloc(sizeof(*p
), GFP_KERNEL
);
60 file
->private_data
= p
;
62 memset(p
, 0, sizeof(*p
));
66 p
->user_ns
= file
->f_cred
->user_ns
;
70 * Wrappers around seq_open(e.g. swaps_open) need to be
71 * aware of this. If they set f_version themselves, they
72 * should call seq_open first and then set f_version.
77 * seq_files support lseek() and pread(). They do not implement
78 * write() at all, but we clear FMODE_PWRITE here for historical
81 * If a client of seq_files a) implements file.write() and b) wishes to
82 * support pwrite() then that client will need to implement its own
83 * file.open() which calls seq_open() and then sets FMODE_PWRITE.
85 file
->f_mode
&= ~FMODE_PWRITE
;
88 EXPORT_SYMBOL(seq_open
);
90 static int traverse(struct seq_file
*m
, loff_t offset
)
92 loff_t pos
= 0, index
;
98 m
->count
= m
->from
= 0;
104 m
->buf
= seq_buf_alloc(m
->size
= PAGE_SIZE
);
108 p
= m
->op
->start(m
, &index
);
113 error
= m
->op
->show(m
, p
);
116 if (unlikely(error
)) {
120 if (seq_has_overflowed(m
))
122 if (pos
+ m
->count
> offset
) {
123 m
->from
= offset
- pos
;
135 p
= m
->op
->next(m
, p
, &index
);
145 m
->buf
= seq_buf_alloc(m
->size
<<= 1);
146 return !m
->buf
? -ENOMEM
: -EAGAIN
;
150 * seq_read - ->read() method for sequential files.
151 * @file: the file to read from
152 * @buf: the buffer to read to
153 * @size: the maximum number of bytes to read
154 * @ppos: the current position in the file
156 * Ready-made ->f_op->read()
158 ssize_t
seq_read(struct file
*file
, char __user
*buf
, size_t size
, loff_t
*ppos
)
160 struct seq_file
*m
= file
->private_data
;
167 mutex_lock(&m
->lock
);
170 * seq_file->op->..m_start/m_stop/m_next may do special actions
171 * or optimisations based on the file->f_version, so we want to
172 * pass the file->f_version to those methods.
174 * seq_file->version is just copy of f_version, and seq_file
175 * methods can treat it simply as file version.
176 * It is copied in first and copied out after all operations.
177 * It is convenient to have it as part of structure to avoid the
178 * need of passing another argument to all the seq_file methods.
180 m
->version
= file
->f_version
;
182 /* Don't assume *ppos is where we left it */
183 if (unlikely(*ppos
!= m
->read_pos
)) {
184 while ((err
= traverse(m
, *ppos
)) == -EAGAIN
)
187 /* With prejudice... */
198 /* grab buffer if we didn't have one */
200 m
->buf
= seq_buf_alloc(m
->size
= PAGE_SIZE
);
204 /* if not empty - flush it first */
206 n
= min(m
->count
, size
);
207 err
= copy_to_user(buf
, m
->buf
+ m
->from
, n
);
222 /* we need at least one record in buffer */
224 p
= m
->op
->start(m
, &pos
);
229 err
= m
->op
->show(m
, p
);
234 if (unlikely(!m
->count
)) {
235 p
= m
->op
->next(m
, p
, &pos
);
239 if (m
->count
< m
->size
)
244 m
->buf
= seq_buf_alloc(m
->size
<<= 1);
249 p
= m
->op
->start(m
, &pos
);
255 /* they want more? let's try to get some more */
256 while (m
->count
< size
) {
257 size_t offs
= m
->count
;
259 p
= m
->op
->next(m
, p
, &next
);
260 if (!p
|| IS_ERR(p
)) {
264 err
= m
->op
->show(m
, p
);
265 if (seq_has_overflowed(m
) || err
) {
267 if (likely(err
<= 0))
273 n
= min(m
->count
, size
);
274 err
= copy_to_user(buf
, m
->buf
, n
);
289 m
->read_pos
+= copied
;
291 file
->f_version
= m
->version
;
292 mutex_unlock(&m
->lock
);
301 EXPORT_SYMBOL(seq_read
);
304 * seq_lseek - ->llseek() method for sequential files.
305 * @file: the file in question
306 * @offset: new position
307 * @whence: 0 for absolute, 1 for relative position
309 * Ready-made ->f_op->llseek()
311 loff_t
seq_lseek(struct file
*file
, loff_t offset
, int whence
)
313 struct seq_file
*m
= file
->private_data
;
314 loff_t retval
= -EINVAL
;
316 mutex_lock(&m
->lock
);
317 m
->version
= file
->f_version
;
320 offset
+= file
->f_pos
;
325 if (offset
!= m
->read_pos
) {
326 while ((retval
= traverse(m
, offset
)) == -EAGAIN
)
329 /* with extreme prejudice... */
336 m
->read_pos
= offset
;
337 retval
= file
->f_pos
= offset
;
340 file
->f_pos
= offset
;
343 file
->f_version
= m
->version
;
344 mutex_unlock(&m
->lock
);
347 EXPORT_SYMBOL(seq_lseek
);
350 * seq_release - free the structures associated with sequential file.
351 * @file: file in question
354 * Frees the structures associated with sequential file; can be used
355 * as ->f_op->release() if you don't have private data to destroy.
357 int seq_release(struct inode
*inode
, struct file
*file
)
359 struct seq_file
*m
= file
->private_data
;
364 EXPORT_SYMBOL(seq_release
);
367 * seq_escape - print string into buffer, escaping some characters
370 * @esc: set of characters that need escaping
372 * Puts string into buffer, replacing each occurrence of character from
373 * @esc with usual octal escape. Returns 0 in case of success, -1 - in
376 int seq_escape(struct seq_file
*m
, const char *s
, const char *esc
)
378 char *end
= m
->buf
+ m
->size
;
382 for (p
= m
->buf
+ m
->count
; (c
= *s
) != '\0' && p
< end
; s
++) {
383 if (!strchr(esc
, c
)) {
389 *p
++ = '0' + ((c
& 0300) >> 6);
390 *p
++ = '0' + ((c
& 070) >> 3);
391 *p
++ = '0' + (c
& 07);
397 m
->count
= p
- m
->buf
;
400 EXPORT_SYMBOL(seq_escape
);
402 int seq_vprintf(struct seq_file
*m
, const char *f
, va_list args
)
406 if (m
->count
< m
->size
) {
407 len
= vsnprintf(m
->buf
+ m
->count
, m
->size
- m
->count
, f
, args
);
408 if (m
->count
+ len
< m
->size
) {
416 EXPORT_SYMBOL(seq_vprintf
);
418 int seq_printf(struct seq_file
*m
, const char *f
, ...)
424 ret
= seq_vprintf(m
, f
, args
);
429 EXPORT_SYMBOL(seq_printf
);
432 * mangle_path - mangle and copy path to buffer beginning
434 * @p: beginning of path in above buffer
435 * @esc: set of characters that need escaping
437 * Copy the path from @p to @s, replacing each occurrence of character from
438 * @esc with usual octal escape.
439 * Returns pointer past last written character in @s, or NULL in case of
442 char *mangle_path(char *s
, const char *p
, const char *esc
)
448 } else if (!strchr(esc
, c
)) {
450 } else if (s
+ 4 > p
) {
454 *s
++ = '0' + ((c
& 0300) >> 6);
455 *s
++ = '0' + ((c
& 070) >> 3);
456 *s
++ = '0' + (c
& 07);
461 EXPORT_SYMBOL(mangle_path
);
464 * seq_path - seq_file interface to print a pathname
465 * @m: the seq_file handle
466 * @path: the struct path to print
467 * @esc: set of characters to escape in the output
469 * return the absolute path of 'path', as represented by the
470 * dentry / mnt pair in the path parameter.
472 int seq_path(struct seq_file
*m
, const struct path
*path
, const char *esc
)
475 size_t size
= seq_get_buf(m
, &buf
);
479 char *p
= d_path(path
, buf
, size
);
481 char *end
= mangle_path(buf
, p
, esc
);
490 EXPORT_SYMBOL(seq_path
);
493 * Same as seq_path, but relative to supplied root.
495 int seq_path_root(struct seq_file
*m
, const struct path
*path
,
496 const struct path
*root
, const char *esc
)
499 size_t size
= seq_get_buf(m
, &buf
);
500 int res
= -ENAMETOOLONG
;
505 p
= __d_path(path
, root
, buf
, size
);
510 char *end
= mangle_path(buf
, p
, esc
);
519 return res
< 0 && res
!= -ENAMETOOLONG
? res
: 0;
523 * returns the path of the 'dentry' from the root of its filesystem.
525 int seq_dentry(struct seq_file
*m
, struct dentry
*dentry
, const char *esc
)
528 size_t size
= seq_get_buf(m
, &buf
);
532 char *p
= dentry_path(dentry
, buf
, size
);
534 char *end
= mangle_path(buf
, p
, esc
);
544 static void *single_start(struct seq_file
*p
, loff_t
*pos
)
546 return NULL
+ (*pos
== 0);
549 static void *single_next(struct seq_file
*p
, void *v
, loff_t
*pos
)
555 static void single_stop(struct seq_file
*p
, void *v
)
559 int single_open(struct file
*file
, int (*show
)(struct seq_file
*, void *),
562 struct seq_operations
*op
= kmalloc(sizeof(*op
), GFP_KERNEL
);
566 op
->start
= single_start
;
567 op
->next
= single_next
;
568 op
->stop
= single_stop
;
570 res
= seq_open(file
, op
);
572 ((struct seq_file
*)file
->private_data
)->private = data
;
578 EXPORT_SYMBOL(single_open
);
580 int single_open_size(struct file
*file
, int (*show
)(struct seq_file
*, void *),
581 void *data
, size_t size
)
583 char *buf
= seq_buf_alloc(size
);
587 ret
= single_open(file
, show
, data
);
592 ((struct seq_file
*)file
->private_data
)->buf
= buf
;
593 ((struct seq_file
*)file
->private_data
)->size
= size
;
596 EXPORT_SYMBOL(single_open_size
);
598 int single_release(struct inode
*inode
, struct file
*file
)
600 const struct seq_operations
*op
= ((struct seq_file
*)file
->private_data
)->op
;
601 int res
= seq_release(inode
, file
);
605 EXPORT_SYMBOL(single_release
);
607 int seq_release_private(struct inode
*inode
, struct file
*file
)
609 struct seq_file
*seq
= file
->private_data
;
613 return seq_release(inode
, file
);
615 EXPORT_SYMBOL(seq_release_private
);
617 void *__seq_open_private(struct file
*f
, const struct seq_operations
*ops
,
622 struct seq_file
*seq
;
624 private = kzalloc(psize
, GFP_KERNEL
);
628 rc
= seq_open(f
, ops
);
632 seq
= f
->private_data
;
633 seq
->private = private;
641 EXPORT_SYMBOL(__seq_open_private
);
643 int seq_open_private(struct file
*filp
, const struct seq_operations
*ops
,
646 return __seq_open_private(filp
, ops
, psize
) ? 0 : -ENOMEM
;
648 EXPORT_SYMBOL(seq_open_private
);
650 int seq_putc(struct seq_file
*m
, char c
)
652 if (m
->count
< m
->size
) {
653 m
->buf
[m
->count
++] = c
;
658 EXPORT_SYMBOL(seq_putc
);
660 int seq_puts(struct seq_file
*m
, const char *s
)
663 if (m
->count
+ len
< m
->size
) {
664 memcpy(m
->buf
+ m
->count
, s
, len
);
671 EXPORT_SYMBOL(seq_puts
);
674 * A helper routine for putting decimal numbers without rich format of printf().
675 * only 'unsigned long long' is supported.
676 * This routine will put one byte delimiter + number into seq_file.
677 * This routine is very quick when you show lots of numbers.
678 * In usual cases, it will be better to use seq_printf(). It's easier to read.
680 int seq_put_decimal_ull(struct seq_file
*m
, char delimiter
,
681 unsigned long long num
)
685 if (m
->count
+ 2 >= m
->size
) /* we'll write 2 bytes at least */
689 m
->buf
[m
->count
++] = delimiter
;
692 m
->buf
[m
->count
++] = num
+ '0';
696 len
= num_to_str(m
->buf
+ m
->count
, m
->size
- m
->count
, num
);
705 EXPORT_SYMBOL(seq_put_decimal_ull
);
707 int seq_put_decimal_ll(struct seq_file
*m
, char delimiter
,
711 if (m
->count
+ 3 >= m
->size
) {
716 m
->buf
[m
->count
++] = delimiter
;
720 return seq_put_decimal_ull(m
, delimiter
, num
);
723 EXPORT_SYMBOL(seq_put_decimal_ll
);
726 * seq_write - write arbitrary data to buffer
727 * @seq: seq_file identifying the buffer to which data should be written
728 * @data: data address
729 * @len: number of bytes
731 * Return 0 on success, non-zero otherwise.
733 int seq_write(struct seq_file
*seq
, const void *data
, size_t len
)
735 if (seq
->count
+ len
< seq
->size
) {
736 memcpy(seq
->buf
+ seq
->count
, data
, len
);
740 seq_set_overflow(seq
);
743 EXPORT_SYMBOL(seq_write
);
746 * seq_pad - write padding spaces to buffer
747 * @m: seq_file identifying the buffer to which data should be written
748 * @c: the byte to append after padding if non-zero
750 void seq_pad(struct seq_file
*m
, char c
)
752 int size
= m
->pad_until
- m
->count
;
754 seq_printf(m
, "%*s", size
, "");
758 EXPORT_SYMBOL(seq_pad
);
760 struct list_head
*seq_list_start(struct list_head
*head
, loff_t pos
)
762 struct list_head
*lh
;
764 list_for_each(lh
, head
)
770 EXPORT_SYMBOL(seq_list_start
);
772 struct list_head
*seq_list_start_head(struct list_head
*head
, loff_t pos
)
777 return seq_list_start(head
, pos
- 1);
779 EXPORT_SYMBOL(seq_list_start_head
);
781 struct list_head
*seq_list_next(void *v
, struct list_head
*head
, loff_t
*ppos
)
783 struct list_head
*lh
;
785 lh
= ((struct list_head
*)v
)->next
;
787 return lh
== head
? NULL
: lh
;
789 EXPORT_SYMBOL(seq_list_next
);
792 * seq_hlist_start - start an iteration of a hlist
793 * @head: the head of the hlist
794 * @pos: the start position of the sequence
796 * Called at seq_file->op->start().
798 struct hlist_node
*seq_hlist_start(struct hlist_head
*head
, loff_t pos
)
800 struct hlist_node
*node
;
802 hlist_for_each(node
, head
)
807 EXPORT_SYMBOL(seq_hlist_start
);
810 * seq_hlist_start_head - start an iteration of a hlist
811 * @head: the head of the hlist
812 * @pos: the start position of the sequence
814 * Called at seq_file->op->start(). Call this function if you want to
815 * print a header at the top of the output.
817 struct hlist_node
*seq_hlist_start_head(struct hlist_head
*head
, loff_t pos
)
820 return SEQ_START_TOKEN
;
822 return seq_hlist_start(head
, pos
- 1);
824 EXPORT_SYMBOL(seq_hlist_start_head
);
827 * seq_hlist_next - move to the next position of the hlist
828 * @v: the current iterator
829 * @head: the head of the hlist
830 * @ppos: the current position
832 * Called at seq_file->op->next().
834 struct hlist_node
*seq_hlist_next(void *v
, struct hlist_head
*head
,
837 struct hlist_node
*node
= v
;
840 if (v
== SEQ_START_TOKEN
)
845 EXPORT_SYMBOL(seq_hlist_next
);
848 * seq_hlist_start_rcu - start an iteration of a hlist protected by RCU
849 * @head: the head of the hlist
850 * @pos: the start position of the sequence
852 * Called at seq_file->op->start().
854 * This list-traversal primitive may safely run concurrently with
855 * the _rcu list-mutation primitives such as hlist_add_head_rcu()
856 * as long as the traversal is guarded by rcu_read_lock().
858 struct hlist_node
*seq_hlist_start_rcu(struct hlist_head
*head
,
861 struct hlist_node
*node
;
863 __hlist_for_each_rcu(node
, head
)
868 EXPORT_SYMBOL(seq_hlist_start_rcu
);
871 * seq_hlist_start_head_rcu - start an iteration of a hlist protected by RCU
872 * @head: the head of the hlist
873 * @pos: the start position of the sequence
875 * Called at seq_file->op->start(). Call this function if you want to
876 * print a header at the top of the output.
878 * This list-traversal primitive may safely run concurrently with
879 * the _rcu list-mutation primitives such as hlist_add_head_rcu()
880 * as long as the traversal is guarded by rcu_read_lock().
882 struct hlist_node
*seq_hlist_start_head_rcu(struct hlist_head
*head
,
886 return SEQ_START_TOKEN
;
888 return seq_hlist_start_rcu(head
, pos
- 1);
890 EXPORT_SYMBOL(seq_hlist_start_head_rcu
);
893 * seq_hlist_next_rcu - move to the next position of the hlist protected by RCU
894 * @v: the current iterator
895 * @head: the head of the hlist
896 * @ppos: the current position
898 * Called at seq_file->op->next().
900 * This list-traversal primitive may safely run concurrently with
901 * the _rcu list-mutation primitives such as hlist_add_head_rcu()
902 * as long as the traversal is guarded by rcu_read_lock().
904 struct hlist_node
*seq_hlist_next_rcu(void *v
,
905 struct hlist_head
*head
,
908 struct hlist_node
*node
= v
;
911 if (v
== SEQ_START_TOKEN
)
912 return rcu_dereference(head
->first
);
914 return rcu_dereference(node
->next
);
916 EXPORT_SYMBOL(seq_hlist_next_rcu
);
919 * seq_hlist_start_precpu - start an iteration of a percpu hlist array
920 * @head: pointer to percpu array of struct hlist_heads
921 * @cpu: pointer to cpu "cursor"
922 * @pos: start position of sequence
924 * Called at seq_file->op->start().
927 seq_hlist_start_percpu(struct hlist_head __percpu
*head
, int *cpu
, loff_t pos
)
929 struct hlist_node
*node
;
931 for_each_possible_cpu(*cpu
) {
932 hlist_for_each(node
, per_cpu_ptr(head
, *cpu
)) {
939 EXPORT_SYMBOL(seq_hlist_start_percpu
);
942 * seq_hlist_next_percpu - move to the next position of the percpu hlist array
943 * @v: pointer to current hlist_node
944 * @head: pointer to percpu array of struct hlist_heads
945 * @cpu: pointer to cpu "cursor"
946 * @pos: start position of sequence
948 * Called at seq_file->op->next().
951 seq_hlist_next_percpu(void *v
, struct hlist_head __percpu
*head
,
952 int *cpu
, loff_t
*pos
)
954 struct hlist_node
*node
= v
;
961 for (*cpu
= cpumask_next(*cpu
, cpu_possible_mask
); *cpu
< nr_cpu_ids
;
962 *cpu
= cpumask_next(*cpu
, cpu_possible_mask
)) {
963 struct hlist_head
*bucket
= per_cpu_ptr(head
, *cpu
);
965 if (!hlist_empty(bucket
))
966 return bucket
->first
;
970 EXPORT_SYMBOL(seq_hlist_next_percpu
);