blob: 0800a24b4348150392739328fc823e50814fa249 [file] [log] [blame]
Steven Rostedt (Red Hat)3a161d92014-06-25 15:54:42 -04001#ifndef _LINUX_SEQ_BUF_H
2#define _LINUX_SEQ_BUF_H
3
4#include <linux/fs.h>
5
6/*
7 * Trace sequences are used to allow a function to call several other functions
8 * to create a string of data to use.
9 */
10
11/**
12 * seq_buf - seq buffer structure
13 * @buffer: pointer to the buffer
14 * @size: size of the buffer
15 * @len: the amount of data inside the buffer
16 * @readpos: The next position to read in the buffer.
17 */
18struct seq_buf {
Steven Rostedt (Red Hat)9a777792014-10-29 13:59:58 -040019 char *buffer;
20 size_t size;
21 size_t len;
22 loff_t readpos;
Steven Rostedt (Red Hat)3a161d92014-06-25 15:54:42 -040023};
24
Steven Rostedt (Red Hat)0736c032014-10-29 14:17:52 -040025static inline void seq_buf_clear(struct seq_buf *s)
26{
27 s->len = 0;
28 s->readpos = 0;
29}
30
Steven Rostedt (Red Hat)3a161d92014-06-25 15:54:42 -040031static inline void
32seq_buf_init(struct seq_buf *s, unsigned char *buf, unsigned int size)
33{
34 s->buffer = buf;
35 s->size = size;
Steven Rostedt (Red Hat)0736c032014-10-29 14:17:52 -040036 seq_buf_clear(s);
Steven Rostedt (Red Hat)3a161d92014-06-25 15:54:42 -040037}
38
39/*
40 * seq_buf have a buffer that might overflow. When this happens
41 * the len and size are set to be equal.
42 */
43static inline bool
44seq_buf_has_overflowed(struct seq_buf *s)
45{
Steven Rostedt (Red Hat)8cd709a2014-10-29 15:26:09 -040046 return s->len > s->size;
Steven Rostedt (Red Hat)3a161d92014-06-25 15:54:42 -040047}
48
49static inline void
50seq_buf_set_overflow(struct seq_buf *s)
51{
Steven Rostedt (Red Hat)8cd709a2014-10-29 15:26:09 -040052 s->len = s->size + 1;
Steven Rostedt (Red Hat)3a161d92014-06-25 15:54:42 -040053}
54
55/*
56 * How much buffer is left on the seq_buf?
57 */
58static inline unsigned int
59seq_buf_buffer_left(struct seq_buf *s)
60{
61 if (seq_buf_has_overflowed(s))
62 return 0;
63
Steven Rostedt (Red Hat)8cd709a2014-10-29 15:26:09 -040064 return s->size - s->len;
Steven Rostedt (Red Hat)3a161d92014-06-25 15:54:42 -040065}
66
Steven Rostedt (Red Hat)eeab9812014-11-06 16:38:28 -050067/* How much buffer was written? */
68static inline unsigned int seq_buf_used(struct seq_buf *s)
69{
70 return min(s->len, s->size);
71}
72
Steven Rostedt (Red Hat)3a161d92014-06-25 15:54:42 -040073extern __printf(2, 3)
74int seq_buf_printf(struct seq_buf *s, const char *fmt, ...);
75extern __printf(2, 0)
76int seq_buf_vprintf(struct seq_buf *s, const char *fmt, va_list args);
77extern int
78seq_buf_bprintf(struct seq_buf *s, const char *fmt, const u32 *binary);
79extern int seq_buf_print_seq(struct seq_file *m, struct seq_buf *s);
80extern int seq_buf_to_user(struct seq_buf *s, char __user *ubuf,
81 int cnt);
82extern int seq_buf_puts(struct seq_buf *s, const char *str);
83extern int seq_buf_putc(struct seq_buf *s, unsigned char c);
84extern int seq_buf_putmem(struct seq_buf *s, const void *mem, unsigned int len);
85extern int seq_buf_putmem_hex(struct seq_buf *s, const void *mem,
86 unsigned int len);
Steven Rostedt (Red Hat)dd231802014-10-29 13:48:37 -040087extern int seq_buf_path(struct seq_buf *s, const struct path *path, const char *esc);
Steven Rostedt (Red Hat)3a161d92014-06-25 15:54:42 -040088
89extern int seq_buf_bitmask(struct seq_buf *s, const unsigned long *maskp,
90 int nmaskbits);
91
92#endif /* _LINUX_SEQ_BUF_H */