xref: /linux-6.15/include/linux/trace_seq.h (revision 5bb7889f)
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 ssize_t trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
40 				 size_t 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, size_t len);
44 extern int trace_seq_putmem_hex(struct trace_seq *s, const void *mem,
45 				size_t len);
46 extern void *trace_seq_reserve(struct trace_seq *s, size_t len);
47 extern int trace_seq_path(struct trace_seq *s, const struct path *path);
48 
49 extern int trace_seq_bitmask(struct trace_seq *s, const unsigned long *maskp,
50 			     int nmaskbits);
51 
52 #else /* CONFIG_TRACING */
53 static inline int trace_seq_printf(struct trace_seq *s, const char *fmt, ...)
54 {
55 	return 0;
56 }
57 static inline int
58 trace_seq_bprintf(struct trace_seq *s, const char *fmt, const u32 *binary)
59 {
60 	return 0;
61 }
62 
63 static inline int
64 trace_seq_bitmask(struct trace_seq *s, const unsigned long *maskp,
65 		  int nmaskbits)
66 {
67 	return 0;
68 }
69 
70 static inline int trace_print_seq(struct seq_file *m, struct trace_seq *s)
71 {
72 	return 0;
73 }
74 static inline ssize_t trace_seq_to_user(struct trace_seq *s, char __user *ubuf,
75 				 size_t cnt)
76 {
77 	return 0;
78 }
79 static inline int trace_seq_puts(struct trace_seq *s, const char *str)
80 {
81 	return 0;
82 }
83 static inline int trace_seq_putc(struct trace_seq *s, unsigned char c)
84 {
85 	return 0;
86 }
87 static inline int
88 trace_seq_putmem(struct trace_seq *s, const void *mem, size_t len)
89 {
90 	return 0;
91 }
92 static inline int trace_seq_putmem_hex(struct trace_seq *s, const void *mem,
93 				       size_t len)
94 {
95 	return 0;
96 }
97 static inline void *trace_seq_reserve(struct trace_seq *s, size_t len)
98 {
99 	return NULL;
100 }
101 static inline int trace_seq_path(struct trace_seq *s, const struct path *path)
102 {
103 	return 0;
104 }
105 #endif /* CONFIG_TRACING */
106 
107 #endif /* _LINUX_TRACE_SEQ_H */
108