Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
9504504c SR |
2 | #ifndef _LINUX_TRACE_SEQ_H |
3 | #define _LINUX_TRACE_SEQ_H | |
4 | ||
3a161d99 | 5 | #include <linux/seq_buf.h> |
6d723736 | 6 | |
78be6914 WZ |
7 | #include <asm/page.h> |
8 | ||
9504504c SR |
9 | /* |
10 | * Trace sequences are used to allow a function to call several other functions | |
6d3f1e12 | 11 | * to create a string of data to use (up to a max of PAGE_SIZE). |
9504504c SR |
12 | */ |
13 | ||
14 | struct trace_seq { | |
15 | unsigned char buffer[PAGE_SIZE]; | |
3a161d99 | 16 | struct seq_buf seq; |
d184b31c | 17 | int full; |
9504504c SR |
18 | }; |
19 | ||
20 | static inline void | |
21 | trace_seq_init(struct trace_seq *s) | |
22 | { | |
3a161d99 | 23 | seq_buf_init(&s->seq, s->buffer, PAGE_SIZE); |
d184b31c | 24 | s->full = 0; |
9504504c SR |
25 | } |
26 | ||
5ac48378 SRRH |
27 | /** |
28 | * trace_seq_used - amount of actual data written to buffer | |
29 | * @s: trace sequence descriptor | |
30 | * | |
31 | * Returns the amount of data written to the buffer. | |
32 | * | |
33 | * IMPORTANT! | |
34 | * | |
35 | * Use this instead of @s->seq.len if you need to pass the amount | |
36 | * of data from the buffer to another buffer (userspace, or what not). | |
37 | * The @s->seq.len on overflow is bigger than the buffer size and | |
38 | * using it can cause access to undefined memory. | |
39 | */ | |
40 | static inline int trace_seq_used(struct trace_seq *s) | |
41 | { | |
42 | return seq_buf_used(&s->seq); | |
43 | } | |
44 | ||
7b039cb4 SRRH |
45 | /** |
46 | * trace_seq_buffer_ptr - return pointer to next location in buffer | |
47 | * @s: trace sequence descriptor | |
48 | * | |
49 | * Returns the pointer to the buffer where the next write to | |
50 | * the buffer will happen. This is useful to save the location | |
51 | * that is about to be written to and then return the result | |
52 | * of that write. | |
53 | */ | |
54 | static inline unsigned char * | |
55 | trace_seq_buffer_ptr(struct trace_seq *s) | |
56 | { | |
5ac48378 | 57 | return s->buffer + seq_buf_used(&s->seq); |
7b039cb4 SRRH |
58 | } |
59 | ||
19a7fe20 SRRH |
60 | /** |
61 | * trace_seq_has_overflowed - return true if the trace_seq took too much | |
62 | * @s: trace sequence descriptor | |
63 | * | |
64 | * Returns true if too much data was added to the trace_seq and it is | |
65 | * now full and will not take anymore. | |
66 | */ | |
67 | static inline bool trace_seq_has_overflowed(struct trace_seq *s) | |
68 | { | |
3a161d99 | 69 | return s->full || seq_buf_has_overflowed(&s->seq); |
19a7fe20 SRRH |
70 | } |
71 | ||
9504504c SR |
72 | /* |
73 | * Currently only defined when tracing is enabled. | |
74 | */ | |
75 | #ifdef CONFIG_TRACING | |
b9075fa9 | 76 | extern __printf(2, 3) |
dba39448 | 77 | void trace_seq_printf(struct trace_seq *s, const char *fmt, ...); |
b9075fa9 | 78 | extern __printf(2, 0) |
dba39448 SRRH |
79 | void trace_seq_vprintf(struct trace_seq *s, const char *fmt, va_list args); |
80 | extern void | |
9504504c | 81 | trace_seq_bprintf(struct trace_seq *s, const char *fmt, const u32 *binary); |
a63ce5b3 | 82 | extern int trace_print_seq(struct seq_file *m, struct trace_seq *s); |
36aabfff SRRH |
83 | extern int trace_seq_to_user(struct trace_seq *s, char __user *ubuf, |
84 | int cnt); | |
dba39448 SRRH |
85 | extern void trace_seq_puts(struct trace_seq *s, const char *str); |
86 | extern void trace_seq_putc(struct trace_seq *s, unsigned char c); | |
87 | extern void trace_seq_putmem(struct trace_seq *s, const void *mem, unsigned int len); | |
88 | extern void trace_seq_putmem_hex(struct trace_seq *s, const void *mem, | |
36aabfff | 89 | unsigned int len); |
38eff289 | 90 | extern int trace_seq_path(struct trace_seq *s, const struct path *path); |
9504504c | 91 | |
dba39448 | 92 | extern void trace_seq_bitmask(struct trace_seq *s, const unsigned long *maskp, |
4449bf92 SRRH |
93 | int nmaskbits); |
94 | ||
ef56e047 PM |
95 | extern int trace_seq_hex_dump(struct trace_seq *s, const char *prefix_str, |
96 | int prefix_type, int rowsize, int groupsize, | |
97 | const void *buf, size_t len, bool ascii); | |
98 | ||
9504504c | 99 | #else /* CONFIG_TRACING */ |
dba39448 | 100 | static inline void trace_seq_printf(struct trace_seq *s, const char *fmt, ...) |
9504504c | 101 | { |
9504504c | 102 | } |
dba39448 | 103 | static inline void |
9504504c SR |
104 | trace_seq_bprintf(struct trace_seq *s, const char *fmt, const u32 *binary) |
105 | { | |
9504504c SR |
106 | } |
107 | ||
dba39448 | 108 | static inline void |
4449bf92 SRRH |
109 | trace_seq_bitmask(struct trace_seq *s, const unsigned long *maskp, |
110 | int nmaskbits) | |
111 | { | |
4449bf92 SRRH |
112 | } |
113 | ||
a63ce5b3 | 114 | static inline int trace_print_seq(struct seq_file *m, struct trace_seq *s) |
9504504c | 115 | { |
a63ce5b3 | 116 | return 0; |
9504504c | 117 | } |
36aabfff SRRH |
118 | static inline int trace_seq_to_user(struct trace_seq *s, char __user *ubuf, |
119 | int cnt) | |
9504504c SR |
120 | { |
121 | return 0; | |
122 | } | |
dba39448 | 123 | static inline void trace_seq_puts(struct trace_seq *s, const char *str) |
9504504c | 124 | { |
9504504c | 125 | } |
dba39448 | 126 | static inline void trace_seq_putc(struct trace_seq *s, unsigned char c) |
9504504c | 127 | { |
9504504c | 128 | } |
dba39448 | 129 | static inline void |
36aabfff | 130 | trace_seq_putmem(struct trace_seq *s, const void *mem, unsigned int len) |
9504504c | 131 | { |
9504504c | 132 | } |
dba39448 | 133 | static inline void trace_seq_putmem_hex(struct trace_seq *s, const void *mem, |
36aabfff | 134 | unsigned int len) |
9504504c | 135 | { |
9504504c | 136 | } |
38eff289 | 137 | static inline int trace_seq_path(struct trace_seq *s, const struct path *path) |
9504504c SR |
138 | { |
139 | return 0; | |
140 | } | |
141 | #endif /* CONFIG_TRACING */ | |
142 | ||
143 | #endif /* _LINUX_TRACE_SEQ_H */ |