Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 1 | #ifndef _LINUX_TRACE_SEQ_H |
| 2 | #define _LINUX_TRACE_SEQ_H |
| 3 | |
Steven Rostedt | 6d72373 | 2009-04-10 14:53:50 -0400 | [diff] [blame] | 4 | #include <linux/fs.h> |
| 5 | |
Wu Zhangjin | 78be691 | 2009-06-14 14:52:30 +0800 | [diff] [blame] | 6 | #include <asm/page.h> |
| 7 | |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 8 | /* |
| 9 | * Trace sequences are used to allow a function to call several other functions |
Jiri Olsa | 6d3f1e1 | 2009-10-23 19:36:19 -0400 | [diff] [blame] | 10 | * to create a string of data to use (up to a max of PAGE_SIZE). |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 11 | */ |
| 12 | |
| 13 | struct trace_seq { |
| 14 | unsigned char buffer[PAGE_SIZE]; |
| 15 | unsigned int len; |
| 16 | unsigned int readpos; |
Johannes Berg | d184b31 | 2009-11-25 16:10:14 +0100 | [diff] [blame] | 17 | int full; |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 18 | }; |
| 19 | |
| 20 | static inline void |
| 21 | trace_seq_init(struct trace_seq *s) |
| 22 | { |
| 23 | s->len = 0; |
| 24 | s->readpos = 0; |
Johannes Berg | d184b31 | 2009-11-25 16:10:14 +0100 | [diff] [blame] | 25 | s->full = 0; |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 26 | } |
| 27 | |
Steven Rostedt (Red Hat) | 7b039cb | 2014-06-26 09:42:41 -0400 | [diff] [blame] | 28 | /** |
| 29 | * trace_seq_buffer_ptr - return pointer to next location in buffer |
| 30 | * @s: trace sequence descriptor |
| 31 | * |
| 32 | * Returns the pointer to the buffer where the next write to |
| 33 | * the buffer will happen. This is useful to save the location |
| 34 | * that is about to be written to and then return the result |
| 35 | * of that write. |
| 36 | */ |
| 37 | static inline unsigned char * |
| 38 | trace_seq_buffer_ptr(struct trace_seq *s) |
| 39 | { |
| 40 | return s->buffer + s->len; |
| 41 | } |
| 42 | |
Steven Rostedt (Red Hat) | 19a7fe2 | 2014-11-12 10:29:54 -0500 | [diff] [blame] | 43 | /** |
| 44 | * trace_seq_has_overflowed - return true if the trace_seq took too much |
| 45 | * @s: trace sequence descriptor |
| 46 | * |
| 47 | * Returns true if too much data was added to the trace_seq and it is |
| 48 | * now full and will not take anymore. |
| 49 | */ |
| 50 | static inline bool trace_seq_has_overflowed(struct trace_seq *s) |
| 51 | { |
| 52 | return s->full || s->len > PAGE_SIZE - 1; |
| 53 | } |
| 54 | |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 55 | /* |
| 56 | * Currently only defined when tracing is enabled. |
| 57 | */ |
| 58 | #ifdef CONFIG_TRACING |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 59 | extern __printf(2, 3) |
Steven Rostedt (Red Hat) | dba3944 | 2014-11-12 18:07:22 -0500 | [diff] [blame^] | 60 | void trace_seq_printf(struct trace_seq *s, const char *fmt, ...); |
Joe Perches | b9075fa | 2011-10-31 17:11:33 -0700 | [diff] [blame] | 61 | extern __printf(2, 0) |
Steven Rostedt (Red Hat) | dba3944 | 2014-11-12 18:07:22 -0500 | [diff] [blame^] | 62 | void trace_seq_vprintf(struct trace_seq *s, const char *fmt, va_list args); |
| 63 | extern void |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 64 | trace_seq_bprintf(struct trace_seq *s, const char *fmt, const u32 *binary); |
Steven Rostedt | a63ce5b | 2009-12-07 09:11:39 -0500 | [diff] [blame] | 65 | extern int trace_print_seq(struct seq_file *m, struct trace_seq *s); |
Steven Rostedt (Red Hat) | 36aabff | 2014-06-20 17:38:01 -0400 | [diff] [blame] | 66 | extern int trace_seq_to_user(struct trace_seq *s, char __user *ubuf, |
| 67 | int cnt); |
Steven Rostedt (Red Hat) | dba3944 | 2014-11-12 18:07:22 -0500 | [diff] [blame^] | 68 | extern void trace_seq_puts(struct trace_seq *s, const char *str); |
| 69 | extern void trace_seq_putc(struct trace_seq *s, unsigned char c); |
| 70 | extern void trace_seq_putmem(struct trace_seq *s, const void *mem, unsigned int len); |
| 71 | extern void trace_seq_putmem_hex(struct trace_seq *s, const void *mem, |
Steven Rostedt (Red Hat) | 36aabff | 2014-06-20 17:38:01 -0400 | [diff] [blame] | 72 | unsigned int len); |
Al Viro | 38eff28 | 2012-03-14 21:51:10 -0400 | [diff] [blame] | 73 | extern int trace_seq_path(struct trace_seq *s, const struct path *path); |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 74 | |
Steven Rostedt (Red Hat) | dba3944 | 2014-11-12 18:07:22 -0500 | [diff] [blame^] | 75 | extern void trace_seq_bitmask(struct trace_seq *s, const unsigned long *maskp, |
Steven Rostedt (Red Hat) | 4449bf9 | 2014-05-06 13:10:24 -0400 | [diff] [blame] | 76 | int nmaskbits); |
| 77 | |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 78 | #else /* CONFIG_TRACING */ |
Steven Rostedt (Red Hat) | dba3944 | 2014-11-12 18:07:22 -0500 | [diff] [blame^] | 79 | static inline void trace_seq_printf(struct trace_seq *s, const char *fmt, ...) |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 80 | { |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 81 | } |
Steven Rostedt (Red Hat) | dba3944 | 2014-11-12 18:07:22 -0500 | [diff] [blame^] | 82 | static inline void |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 83 | trace_seq_bprintf(struct trace_seq *s, const char *fmt, const u32 *binary) |
| 84 | { |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 85 | } |
| 86 | |
Steven Rostedt (Red Hat) | dba3944 | 2014-11-12 18:07:22 -0500 | [diff] [blame^] | 87 | static inline void |
Steven Rostedt (Red Hat) | 4449bf9 | 2014-05-06 13:10:24 -0400 | [diff] [blame] | 88 | trace_seq_bitmask(struct trace_seq *s, const unsigned long *maskp, |
| 89 | int nmaskbits) |
| 90 | { |
Steven Rostedt (Red Hat) | 4449bf9 | 2014-05-06 13:10:24 -0400 | [diff] [blame] | 91 | } |
| 92 | |
Steven Rostedt | a63ce5b | 2009-12-07 09:11:39 -0500 | [diff] [blame] | 93 | static inline int trace_print_seq(struct seq_file *m, struct trace_seq *s) |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 94 | { |
Steven Rostedt | a63ce5b | 2009-12-07 09:11:39 -0500 | [diff] [blame] | 95 | return 0; |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 96 | } |
Steven Rostedt (Red Hat) | 36aabff | 2014-06-20 17:38:01 -0400 | [diff] [blame] | 97 | static inline int trace_seq_to_user(struct trace_seq *s, char __user *ubuf, |
| 98 | int cnt) |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 99 | { |
| 100 | return 0; |
| 101 | } |
Steven Rostedt (Red Hat) | dba3944 | 2014-11-12 18:07:22 -0500 | [diff] [blame^] | 102 | static inline void trace_seq_puts(struct trace_seq *s, const char *str) |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 103 | { |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 104 | } |
Steven Rostedt (Red Hat) | dba3944 | 2014-11-12 18:07:22 -0500 | [diff] [blame^] | 105 | static inline void trace_seq_putc(struct trace_seq *s, unsigned char c) |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 106 | { |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 107 | } |
Steven Rostedt (Red Hat) | dba3944 | 2014-11-12 18:07:22 -0500 | [diff] [blame^] | 108 | static inline void |
Steven Rostedt (Red Hat) | 36aabff | 2014-06-20 17:38:01 -0400 | [diff] [blame] | 109 | trace_seq_putmem(struct trace_seq *s, const void *mem, unsigned int len) |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 110 | { |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 111 | } |
Steven Rostedt (Red Hat) | dba3944 | 2014-11-12 18:07:22 -0500 | [diff] [blame^] | 112 | static inline void trace_seq_putmem_hex(struct trace_seq *s, const void *mem, |
Steven Rostedt (Red Hat) | 36aabff | 2014-06-20 17:38:01 -0400 | [diff] [blame] | 113 | unsigned int len) |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 114 | { |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 115 | } |
Al Viro | 38eff28 | 2012-03-14 21:51:10 -0400 | [diff] [blame] | 116 | static inline int trace_seq_path(struct trace_seq *s, const struct path *path) |
Steven Rostedt | 9504504 | 2009-04-11 12:59:57 -0400 | [diff] [blame] | 117 | { |
| 118 | return 0; |
| 119 | } |
| 120 | #endif /* CONFIG_TRACING */ |
| 121 | |
| 122 | #endif /* _LINUX_TRACE_SEQ_H */ |