2 * Copyright (C) 2009 Red Hat Inc, Steven Rostedt <srostedt@redhat.com>
4 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation;
8 * version 2.1 of the License (not later!)
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26 #include "event-parse.h"
27 #include "event-utils.h"
30 * The TRACE_SEQ_POISON is to catch the use of using
31 * a trace_seq structure after it was destroyed.
33 #define TRACE_SEQ_POISON ((void *)0xdeadbeef)
34 #define TRACE_SEQ_CHECK(s) \
36 if ((s)->buffer == TRACE_SEQ_POISON) \
37 die("Usage of trace_seq after it was destroyed"); \
41 * trace_seq_init - initialize the trace_seq structure
42 * @s: a pointer to the trace_seq structure to initialize
44 void trace_seq_init(struct trace_seq
*s
)
48 s
->buffer_size
= TRACE_SEQ_BUF_SIZE
;
49 s
->buffer
= malloc_or_die(s
->buffer_size
);
53 * trace_seq_destroy - free up memory of a trace_seq
54 * @s: a pointer to the trace_seq to free the buffer
56 * Only frees the buffer, not the trace_seq struct itself.
58 void trace_seq_destroy(struct trace_seq
*s
)
64 s
->buffer
= TRACE_SEQ_POISON
;
67 static void expand_buffer(struct trace_seq
*s
)
69 s
->buffer_size
+= TRACE_SEQ_BUF_SIZE
;
70 s
->buffer
= realloc(s
->buffer
, s
->buffer_size
);
72 die("Can't allocate trace_seq buffer memory");
76 * trace_seq_printf - sequence printing of trace information
77 * @s: trace sequence descriptor
78 * @fmt: printf format string
80 * It returns 0 if the trace oversizes the buffer's free
83 * The tracer may use either sequence operations or its own
84 * copy to user routines. To simplify formating of a trace
85 * trace_seq_printf is used to store strings into a special
86 * buffer (@s). Then the output may be either used by
87 * the sequencer or pulled into another buffer.
90 trace_seq_printf(struct trace_seq
*s
, const char *fmt
, ...)
99 len
= (s
->buffer_size
- 1) - s
->len
;
102 ret
= vsnprintf(s
->buffer
+ s
->len
, len
, fmt
, ap
);
116 * trace_seq_vprintf - sequence printing of trace information
117 * @s: trace sequence descriptor
118 * @fmt: printf format string
120 * The tracer may use either sequence operations or its own
121 * copy to user routines. To simplify formating of a trace
122 * trace_seq_printf is used to store strings into a special
123 * buffer (@s). Then the output may be either used by
124 * the sequencer or pulled into another buffer.
127 trace_seq_vprintf(struct trace_seq
*s
, const char *fmt
, va_list args
)
135 len
= (s
->buffer_size
- 1) - s
->len
;
137 ret
= vsnprintf(s
->buffer
+ s
->len
, len
, fmt
, args
);
150 * trace_seq_puts - trace sequence printing of simple string
151 * @s: trace sequence descriptor
152 * @str: simple string to record
154 * The tracer may use either the sequence operations or its own
155 * copy to user routines. This function records a simple string
156 * into a special buffer (@s) for later retrieval by a sequencer
157 * or other mechanism.
159 int trace_seq_puts(struct trace_seq
*s
, const char *str
)
167 while (len
> ((s
->buffer_size
- 1) - s
->len
))
170 memcpy(s
->buffer
+ s
->len
, str
, len
);
176 int trace_seq_putc(struct trace_seq
*s
, unsigned char c
)
180 while (s
->len
>= (s
->buffer_size
- 1))
183 s
->buffer
[s
->len
++] = c
;
188 void trace_seq_terminate(struct trace_seq
*s
)
192 /* There's always one character left on the buffer */
193 s
->buffer
[s
->len
] = 0;
196 int trace_seq_do_printf(struct trace_seq
*s
)
199 return printf("%.*s", s
->len
, s
->buffer
);