xref: /linux-6.15/include/linux/trace_seq.h (revision 9096032f)
1 #ifndef _LINUX_TRACE_SEQ_H
2 #define _LINUX_TRACE_SEQ_H
3 
4 #include <linux/fs.h>
5 
6 #include <asm/page.h>
7 
8 /*
9  * Trace sequences are used to allow a function to call several other functions
10  * to create a string of data to use (up to a max of PAGE_SIZE).
11  */
12 
13 struct trace_seq {
14 	unsigned char		buffer[PAGE_SIZE];
15 	unsigned int		len;
16 	unsigned int		readpos;
17 	int			full;
18 };
19 
20 static inline void
21 trace_seq_init(struct trace_seq *s)
22 {
23 	s->len = 0;
24 	s->readpos = 0;
25 	s->full = 0;
26 }
27 
28 /*
29  * Currently only defined when tracing is enabled.
30  */
31 #ifdef CONFIG_TRACING
32 extern __printf(2, 3)
33 int trace_seq_printf(struct trace_seq *s, const char *fmt, ...);
34 extern __printf(2, 0)
35 int trace_seq_vprintf(struct trace_seq *s, const char *fmt, va_list args);
36 extern int
37 trace_seq_bprintf(struct trace_seq *s, const char *fmt, const u32 *binary);
38 extern int trace_print_seq(struct seq_file *m, struct trace_seq *s);
39 extern int trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
40 			     int cnt);
41 extern int trace_seq_puts(struct trace_seq *s, const char *str);
42 extern int trace_seq_putc(struct trace_seq *s, unsigned char c);
43 extern int trace_seq_putmem(struct trace_seq *s, const void *mem, unsigned int len);
44 extern int trace_seq_putmem_hex(struct trace_seq *s, const void *mem,
45 				unsigned int len);
46 extern int trace_seq_path(struct trace_seq *s, const struct path *path);
47 
48 extern int trace_seq_bitmask(struct trace_seq *s, const unsigned long *maskp,
49 			     int nmaskbits);
50 
51 #else /* CONFIG_TRACING */
52 static inline int trace_seq_printf(struct trace_seq *s, const char *fmt, ...)
53 {
54 	return 0;
55 }
56 static inline int
57 trace_seq_bprintf(struct trace_seq *s, const char *fmt, const u32 *binary)
58 {
59 	return 0;
60 }
61 
62 static inline int
63 trace_seq_bitmask(struct trace_seq *s, const unsigned long *maskp,
64 		  int nmaskbits)
65 {
66 	return 0;
67 }
68 
69 static inline int trace_print_seq(struct seq_file *m, struct trace_seq *s)
70 {
71 	return 0;
72 }
73 static inline int trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
74 				    int cnt)
75 {
76 	return 0;
77 }
78 static inline int trace_seq_puts(struct trace_seq *s, const char *str)
79 {
80 	return 0;
81 }
82 static inline int trace_seq_putc(struct trace_seq *s, unsigned char c)
83 {
84 	return 0;
85 }
86 static inline int
87 trace_seq_putmem(struct trace_seq *s, const void *mem, unsigned int len)
88 {
89 	return 0;
90 }
91 static inline int trace_seq_putmem_hex(struct trace_seq *s, const void *mem,
92 				       unsigned int len)
93 {
94 	return 0;
95 }
96 static inline int trace_seq_path(struct trace_seq *s, const struct path *path)
97 {
98 	return 0;
99 }
100 #endif /* CONFIG_TRACING */
101 
102 #endif /* _LINUX_TRACE_SEQ_H */
103