Blame view
lib/seq_buf.c
7.82 KB
3a161d99c tracing: Create s... |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
/* * seq_buf.c * * Copyright (C) 2014 Red Hat Inc, Steven Rostedt <srostedt@redhat.com> * * The seq_buf is a handy tool that allows you to pass a descriptor around * to a buffer that other functions can write to. It is similar to the * seq_file functionality but has some differences. * * To use it, the seq_buf must be initialized with seq_buf_init(). * This will set up the counters within the descriptor. You can call * seq_buf_init() more than once to reset the seq_buf to start * from scratch. */ #include <linux/uaccess.h> #include <linux/seq_file.h> #include <linux/seq_buf.h> |
3a161d99c tracing: Create s... |
18 |
/** |
9b7721538 seq_buf: Add seq_... |
19 20 21 22 23 24 25 26 27 |
* seq_buf_can_fit - can the new data fit in the current buffer? * @s: the seq_buf descriptor * @len: The length to see if it can fit in the current buffer * * Returns true if there's enough unused space in the seq_buf buffer * to fit the amount of new data according to @len. */ static bool seq_buf_can_fit(struct seq_buf *s, size_t len) { |
8cd709ae7 tracing: Have seq... |
28 |
return s->len + len <= s->size; |
9b7721538 seq_buf: Add seq_... |
29 30 31 |
} /** |
3a161d99c tracing: Create s... |
32 33 34 35 36 37 38 39 |
* seq_buf_print_seq - move the contents of seq_buf into a seq_file * @m: the seq_file descriptor that is the destination * @s: the seq_buf descriptor that is the source. * * Returns zero on success, non zero otherwise */ int seq_buf_print_seq(struct seq_file *m, struct seq_buf *s) { |
eeab98154 seq_buf: Create s... |
40 |
unsigned int len = seq_buf_used(s); |
3a161d99c tracing: Create s... |
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
return seq_write(m, s->buffer, len); } /** * seq_buf_vprintf - sequence printing of information. * @s: seq_buf descriptor * @fmt: printf format string * @args: va_list of arguments from a printf() type function * * Writes a vnprintf() format into the sequencce buffer. * * Returns zero on success, -1 on overflow. */ int seq_buf_vprintf(struct seq_buf *s, const char *fmt, va_list args) { int len; WARN_ON(s->size == 0); if (s->len < s->size) { len = vsnprintf(s->buffer + s->len, s->size - s->len, fmt, args); |
4a8fe4e18 seq_buf: Fix seq_... |
63 |
if (s->len + len < s->size) { |
3a161d99c tracing: Create s... |
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
s->len += len; return 0; } } seq_buf_set_overflow(s); return -1; } /** * seq_buf_printf - sequence printing of information * @s: seq_buf descriptor * @fmt: printf format string * * Writes a printf() format into the sequence buffer. * * Returns zero on success, -1 on overflow. */ int seq_buf_printf(struct seq_buf *s, const char *fmt, ...) { va_list ap; int ret; va_start(ap, fmt); ret = seq_buf_vprintf(s, fmt, ap); va_end(ap); return ret; } |
2448913ed seq-buf: Make seq... |
92 |
#ifdef CONFIG_BINARY_PRINTF |
3a161d99c tracing: Create s... |
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
/** * seq_buf_bprintf - Write the printf string from binary arguments * @s: seq_buf descriptor * @fmt: The format string for the @binary arguments * @binary: The binary arguments for @fmt. * * When recording in a fast path, a printf may be recorded with just * saving the format and the arguments as they were passed to the * function, instead of wasting cycles converting the arguments into * ASCII characters. Instead, the arguments are saved in a 32 bit * word array that is defined by the format string constraints. * * This function will take the format and the binary array and finish * the conversion into the ASCII string within the buffer. * * Returns zero on success, -1 on overflow. */ int seq_buf_bprintf(struct seq_buf *s, const char *fmt, const u32 *binary) { unsigned int len = seq_buf_buffer_left(s); int ret; WARN_ON(s->size == 0); if (s->len < s->size) { ret = bstr_printf(s->buffer + s->len, len, fmt, binary); |
4d4eb4d4f seq_buf: Fix seq_... |
119 |
if (s->len + ret < s->size) { |
3a161d99c tracing: Create s... |
120 121 122 123 124 125 126 |
s->len += ret; return 0; } } seq_buf_set_overflow(s); return -1; } |
2448913ed seq-buf: Make seq... |
127 |
#endif /* CONFIG_BINARY_PRINTF */ |
3a161d99c tracing: Create s... |
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
/** * seq_buf_puts - sequence printing of simple string * @s: seq_buf descriptor * @str: simple string to record * * Copy a simple string into the sequence buffer. * * Returns zero on success, -1 on overflow */ int seq_buf_puts(struct seq_buf *s, const char *str) { unsigned int len = strlen(str); WARN_ON(s->size == 0); |
9b7721538 seq_buf: Add seq_... |
143 |
if (seq_buf_can_fit(s, len)) { |
3a161d99c tracing: Create s... |
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 |
memcpy(s->buffer + s->len, str, len); s->len += len; return 0; } seq_buf_set_overflow(s); return -1; } /** * seq_buf_putc - sequence printing of simple character * @s: seq_buf descriptor * @c: simple character to record * * Copy a single character into the sequence buffer. * * Returns zero on success, -1 on overflow */ int seq_buf_putc(struct seq_buf *s, unsigned char c) { WARN_ON(s->size == 0); |
9b7721538 seq_buf: Add seq_... |
164 |
if (seq_buf_can_fit(s, 1)) { |
3a161d99c tracing: Create s... |
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
s->buffer[s->len++] = c; return 0; } seq_buf_set_overflow(s); return -1; } /** * seq_buf_putmem - write raw data into the sequenc buffer * @s: seq_buf descriptor * @mem: The raw memory to copy into the buffer * @len: The length of the raw memory to copy (in bytes) * * There may be cases where raw memory needs to be written into the * buffer and a strcpy() would not work. Using this function allows * for such cases. * * Returns zero on success, -1 on overflow */ int seq_buf_putmem(struct seq_buf *s, const void *mem, unsigned int len) { WARN_ON(s->size == 0); |
9b7721538 seq_buf: Add seq_... |
187 |
if (seq_buf_can_fit(s, len)) { |
3a161d99c tracing: Create s... |
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
memcpy(s->buffer + s->len, mem, len); s->len += len; return 0; } seq_buf_set_overflow(s); return -1; } #define MAX_MEMHEX_BYTES 8U #define HEX_CHARS (MAX_MEMHEX_BYTES*2 + 1) /** * seq_buf_putmem_hex - write raw memory into the buffer in ASCII hex * @s: seq_buf descriptor * @mem: The raw memory to write its hex ASCII representation of * @len: The length of the raw memory to copy (in bytes) * * This is similar to seq_buf_putmem() except instead of just copying the * raw memory into the buffer it writes its ASCII representation of it * in hex characters. * * Returns zero on success, -1 on overflow */ int seq_buf_putmem_hex(struct seq_buf *s, const void *mem, unsigned int len) { unsigned char hex[HEX_CHARS]; const unsigned char *data = mem; unsigned int start_len; int i, j; WARN_ON(s->size == 0); while (len) { start_len = min(len, HEX_CHARS - 1); #ifdef __BIG_ENDIAN for (i = 0, j = 0; i < start_len; i++) { #else for (i = start_len-1, j = 0; i >= 0; i--) { #endif hex[j++] = hex_asc_hi(data[i]); hex[j++] = hex_asc_lo(data[i]); } if (WARN_ON_ONCE(j == 0 || j/2 > len)) break; /* j increments twice per loop */ len -= j / 2; hex[j++] = ' '; seq_buf_putmem(s, hex, j); if (seq_buf_has_overflowed(s)) return -1; } return 0; } /** * seq_buf_path - copy a path into the sequence buffer * @s: seq_buf descriptor * @path: path to write into the sequence buffer. |
dd23180aa tracing: Convert ... |
249 |
* @esc: set of characters to escape in the output |
3a161d99c tracing: Create s... |
250 251 252 |
* * Write a path name into the sequence buffer. * |
dd23180aa tracing: Convert ... |
253 |
* Returns the number of written bytes on success, -1 on overflow |
3a161d99c tracing: Create s... |
254 |
*/ |
dd23180aa tracing: Convert ... |
255 |
int seq_buf_path(struct seq_buf *s, const struct path *path, const char *esc) |
3a161d99c tracing: Create s... |
256 |
{ |
01cb06a4c tracing: Add seq_... |
257 258 |
char *buf; size_t size = seq_buf_get_buf(s, &buf); |
dd23180aa tracing: Convert ... |
259 |
int res = -1; |
3a161d99c tracing: Create s... |
260 261 |
WARN_ON(s->size == 0); |
dd23180aa tracing: Convert ... |
262 263 264 265 266 267 |
if (size) { char *p = d_path(path, buf, size); if (!IS_ERR(p)) { char *end = mangle_path(buf, p, esc); if (end) res = end - buf; |
3a161d99c tracing: Create s... |
268 269 |
} } |
01cb06a4c tracing: Add seq_... |
270 |
seq_buf_commit(s, res); |
dd23180aa tracing: Convert ... |
271 272 |
return res; |
3a161d99c tracing: Create s... |
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 |
} /** * seq_buf_to_user - copy the squence buffer to user space * @s: seq_buf descriptor * @ubuf: The userspace memory location to copy to * @cnt: The amount to copy * * Copies the sequence buffer into the userspace memory pointed to * by @ubuf. It starts from the last read position (@s->readpos) * and writes up to @cnt characters or till it reaches the end of * the content in the buffer (@s->len), which ever comes first. * * On success, it returns a positive number of the number of bytes * it copied. * * On failure it returns -EBUSY if all of the content in the * sequence has been already read, which includes nothing in the * sequence (@s->len == @s->readpos). * * Returns -EFAULT if the copy to userspace fails. */ int seq_buf_to_user(struct seq_buf *s, char __user *ubuf, int cnt) { int len; int ret; if (!cnt) return 0; |
ff078d8fc tracing: Use seq_... |
302 303 304 |
len = seq_buf_used(s); if (len <= s->readpos) |
3a161d99c tracing: Create s... |
305 |
return -EBUSY; |
ff078d8fc tracing: Use seq_... |
306 |
len -= s->readpos; |
3a161d99c tracing: Create s... |
307 308 309 310 311 312 313 314 315 316 317 |
if (cnt > len) cnt = len; ret = copy_to_user(ubuf, s->buffer + s->readpos, cnt); if (ret == cnt) return -EFAULT; cnt -= ret; s->readpos += cnt; return cnt; } |