Blame view
fs/seq_file.c
24.7 KB
b24413180
|
1 |
// SPDX-License-Identifier: GPL-2.0 |
1da177e4c
|
2 3 4 5 6 7 |
/* * linux/fs/seq_file.c * * helper functions for making synthetic files from sequences of records. * initial implementation -- AV, Oct 2001. */ |
096523203
|
8 |
#include <linux/cache.h> |
1da177e4c
|
9 |
#include <linux/fs.h> |
630d9c472
|
10 |
#include <linux/export.h> |
1da177e4c
|
11 |
#include <linux/seq_file.h> |
058504edd
|
12 |
#include <linux/vmalloc.h> |
1da177e4c
|
13 |
#include <linux/slab.h> |
adb37c4c6
|
14 |
#include <linux/cred.h> |
058504edd
|
15 |
#include <linux/mm.h> |
37607102c
|
16 |
#include <linux/printk.h> |
25c6bb76e
|
17 |
#include <linux/string_helpers.h> |
1da177e4c
|
18 |
|
7c0f6ba68
|
19 |
#include <linux/uaccess.h> |
1da177e4c
|
20 |
#include <asm/page.h> |
096523203
|
21 |
static struct kmem_cache *seq_file_cache __ro_after_init; |
e075f5915
|
22 23 24 25 |
static void seq_set_overflow(struct seq_file *m) { m->count = m->size; } |
058504edd
|
26 27 |
static void *seq_buf_alloc(unsigned long size) { |
d64d01a15
|
28 |
return kvmalloc(size, GFP_KERNEL_ACCOUNT); |
058504edd
|
29 |
} |
1da177e4c
|
30 31 32 33 34 35 36 37 38 39 40 41 |
/** * seq_open - initialize sequential file * @file: file we initialize * @op: method table describing the sequence * * seq_open() sets @file, associating it with a sequence described * by @op. @op->start() sets the iterator up and returns the first * element of sequence. @op->stop() shuts it down. @op->next() * returns the next element of sequence. @op->show() prints element * into the buffer. In case of error ->start() and ->next() return * ERR_PTR(error). In the end of sequence they return %NULL. ->show() * returns 0 in case of success and negative number in case of error. |
521b5d0c4
|
42 |
* Returning SEQ_SKIP means "discard this element and move on". |
460b865e5
|
43 44 |
* Note: seq_open() will allocate a struct seq_file and store its * pointer in @file->private_data. This pointer should not be modified. |
1da177e4c
|
45 |
*/ |
15ad7cdcf
|
46 |
int seq_open(struct file *file, const struct seq_operations *op) |
1da177e4c
|
47 |
{ |
189f9841d
|
48 49 50 |
struct seq_file *p; WARN_ON(file->private_data); |
096523203
|
51 |
p = kmem_cache_zalloc(seq_file_cache, GFP_KERNEL); |
189f9841d
|
52 53 54 55 |
if (!p) return -ENOMEM; file->private_data = p; |
1abe77b0f
|
56 |
|
0ac1759ab
|
57 |
mutex_init(&p->lock); |
1da177e4c
|
58 |
p->op = op; |
34dbbcdbf
|
59 60 61 62 |
// No refcounting: the lifetime of 'p' is constrained // to the lifetime of the file. p->file = file; |
1da177e4c
|
63 64 65 66 67 68 69 |
/* * Wrappers around seq_open(e.g. swaps_open) need to be * aware of this. If they set f_version themselves, they * should call seq_open first and then set f_version. */ file->f_version = 0; |
8f19d4729
|
70 71 72 73 74 75 76 77 78 79 |
/* * seq_files support lseek() and pread(). They do not implement * write() at all, but we clear FMODE_PWRITE here for historical * reasons. * * If a client of seq_files a) implements file.write() and b) wishes to * support pwrite() then that client will need to implement its own * file.open() which calls seq_open() and then sets FMODE_PWRITE. */ file->f_mode &= ~FMODE_PWRITE; |
1da177e4c
|
80 81 82 |
return 0; } EXPORT_SYMBOL(seq_open); |
33da8892a
|
83 84 |
static int traverse(struct seq_file *m, loff_t offset) { |
1f4aace60
|
85 |
loff_t pos = 0; |
33da8892a
|
86 87 88 89 |
int error = 0; void *p; m->version = 0; |
1f4aace60
|
90 |
m->index = 0; |
33da8892a
|
91 |
m->count = m->from = 0; |
1f4aace60
|
92 |
if (!offset) |
33da8892a
|
93 |
return 0; |
1f4aace60
|
94 |
|
33da8892a
|
95 |
if (!m->buf) { |
058504edd
|
96 |
m->buf = seq_buf_alloc(m->size = PAGE_SIZE); |
33da8892a
|
97 98 99 |
if (!m->buf) return -ENOMEM; } |
1f4aace60
|
100 |
p = m->op->start(m, &m->index); |
33da8892a
|
101 102 103 104 105 106 107 108 109 110 111 |
while (p) { error = PTR_ERR(p); if (IS_ERR(p)) break; error = m->op->show(m, p); if (error < 0) break; if (unlikely(error)) { error = 0; m->count = 0; } |
1f33c41c0
|
112 |
if (seq_has_overflowed(m)) |
33da8892a
|
113 |
goto Eoverflow; |
6a2aeab59
|
114 |
p = m->op->next(m, p, &m->index); |
33da8892a
|
115 116 117 |
if (pos + m->count > offset) { m->from = offset - pos; m->count -= m->from; |
33da8892a
|
118 119 120 121 |
break; } pos += m->count; m->count = 0; |
1f4aace60
|
122 |
if (pos == offset) |
33da8892a
|
123 |
break; |
33da8892a
|
124 125 126 127 128 129 |
} m->op->stop(m, p); return error; Eoverflow: m->op->stop(m, p); |
058504edd
|
130 |
kvfree(m->buf); |
801a76050
|
131 |
m->count = 0; |
058504edd
|
132 |
m->buf = seq_buf_alloc(m->size <<= 1); |
33da8892a
|
133 134 |
return !m->buf ? -ENOMEM : -EAGAIN; } |
1da177e4c
|
135 136 |
/** * seq_read - ->read() method for sequential files. |
67be2dd1b
|
137 138 139 140 |
* @file: the file to read from * @buf: the buffer to read to * @size: the maximum number of bytes to read * @ppos: the current position in the file |
1da177e4c
|
141 142 143 144 145 |
* * Ready-made ->f_op->read() */ ssize_t seq_read(struct file *file, char __user *buf, size_t size, loff_t *ppos) { |
8209e2f46
|
146 |
struct seq_file *m = file->private_data; |
1da177e4c
|
147 |
size_t copied = 0; |
1da177e4c
|
148 149 150 |
size_t n; void *p; int err = 0; |
0ac1759ab
|
151 |
mutex_lock(&m->lock); |
8f19d4729
|
152 |
|
7904ac842
|
153 154 155 156 157 158 159 160 161 162 163 164 |
/* * seq_file->op->..m_start/m_stop/m_next may do special actions * or optimisations based on the file->f_version, so we want to * pass the file->f_version to those methods. * * seq_file->version is just copy of f_version, and seq_file * methods can treat it simply as file version. * It is copied in first and copied out after all operations. * It is convenient to have it as part of structure to avoid the * need of passing another argument to all the seq_file methods. */ m->version = file->f_version; |
e522751d6
|
165 166 167 168 |
/* * if request is to read from zero offset, reset iterator to first * record as it might have been already advanced by previous requests */ |
cf5eebae2
|
169 |
if (*ppos == 0) { |
e522751d6
|
170 |
m->index = 0; |
cf5eebae2
|
171 172 173 |
m->version = 0; m->count = 0; } |
e522751d6
|
174 |
|
8f19d4729
|
175 176 |
/* Don't assume *ppos is where we left it */ if (unlikely(*ppos != m->read_pos)) { |
8f19d4729
|
177 178 179 180 181 182 183 184 185 |
while ((err = traverse(m, *ppos)) == -EAGAIN) ; if (err) { /* With prejudice... */ m->read_pos = 0; m->version = 0; m->index = 0; m->count = 0; goto Done; |
7904ac842
|
186 187 |
} else { m->read_pos = *ppos; |
8f19d4729
|
188 189 |
} } |
1da177e4c
|
190 191 |
/* grab buffer if we didn't have one */ if (!m->buf) { |
058504edd
|
192 |
m->buf = seq_buf_alloc(m->size = PAGE_SIZE); |
1da177e4c
|
193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
if (!m->buf) goto Enomem; } /* if not empty - flush it first */ if (m->count) { n = min(m->count, size); err = copy_to_user(buf, m->buf + m->from, n); if (err) goto Efault; m->count -= n; m->from += n; size -= n; buf += n; copied += n; |
1da177e4c
|
207 208 209 210 |
if (!size) goto Done; } /* we need at least one record in buffer */ |
1f4aace60
|
211 212 |
m->from = 0; p = m->op->start(m, &m->index); |
1da177e4c
|
213 |
while (1) { |
1da177e4c
|
214 215 216 217 |
err = PTR_ERR(p); if (!p || IS_ERR(p)) break; err = m->op->show(m, p); |
521b5d0c4
|
218 |
if (err < 0) |
1da177e4c
|
219 |
break; |
521b5d0c4
|
220 221 |
if (unlikely(err)) m->count = 0; |
4cdfe84b5
|
222 |
if (unlikely(!m->count)) { |
1f4aace60
|
223 |
p = m->op->next(m, p, &m->index); |
4cdfe84b5
|
224 225 |
continue; } |
1da177e4c
|
226 227 228 |
if (m->count < m->size) goto Fill; m->op->stop(m, p); |
058504edd
|
229 |
kvfree(m->buf); |
801a76050
|
230 |
m->count = 0; |
058504edd
|
231 |
m->buf = seq_buf_alloc(m->size <<= 1); |
1da177e4c
|
232 233 |
if (!m->buf) goto Enomem; |
1da177e4c
|
234 |
m->version = 0; |
1f4aace60
|
235 |
p = m->op->start(m, &m->index); |
1da177e4c
|
236 237 238 239 240 241 |
} m->op->stop(m, p); m->count = 0; goto Done; Fill: /* they want more? let's try to get some more */ |
1f4aace60
|
242 |
while (1) { |
1da177e4c
|
243 |
size_t offs = m->count; |
1f4aace60
|
244 245 246 247 248 249 |
loff_t pos = m->index; p = m->op->next(m, p, &m->index); if (pos == m->index) /* Buggy ->next function */ m->index++; |
1da177e4c
|
250 251 252 253 |
if (!p || IS_ERR(p)) { err = PTR_ERR(p); break; } |
1f4aace60
|
254 255 |
if (m->count >= size) break; |
1da177e4c
|
256 |
err = m->op->show(m, p); |
1f33c41c0
|
257 |
if (seq_has_overflowed(m) || err) { |
1da177e4c
|
258 |
m->count = offs; |
521b5d0c4
|
259 260 |
if (likely(err <= 0)) break; |
1da177e4c
|
261 |
} |
1da177e4c
|
262 263 264 265 266 267 268 269 |
} m->op->stop(m, p); n = min(m->count, size); err = copy_to_user(buf, m->buf, n); if (err) goto Efault; copied += n; m->count -= n; |
1f4aace60
|
270 |
m->from = n; |
1da177e4c
|
271 272 273 |
Done: if (!copied) copied = err; |
8f19d4729
|
274 |
else { |
1da177e4c
|
275 |
*ppos += copied; |
8f19d4729
|
276 277 |
m->read_pos += copied; } |
1da177e4c
|
278 |
file->f_version = m->version; |
0ac1759ab
|
279 |
mutex_unlock(&m->lock); |
1da177e4c
|
280 281 282 283 284 285 286 287 288 |
return copied; Enomem: err = -ENOMEM; goto Done; Efault: err = -EFAULT; goto Done; } EXPORT_SYMBOL(seq_read); |
1da177e4c
|
289 290 |
/** * seq_lseek - ->llseek() method for sequential files. |
67be2dd1b
|
291 292 |
* @file: the file in question * @offset: new position |
254adaa46
|
293 |
* @whence: 0 for absolute, 1 for relative position |
1da177e4c
|
294 295 296 |
* * Ready-made ->f_op->llseek() */ |
965c8e59c
|
297 |
loff_t seq_lseek(struct file *file, loff_t offset, int whence) |
1da177e4c
|
298 |
{ |
8209e2f46
|
299 |
struct seq_file *m = file->private_data; |
16abef0e9
|
300 |
loff_t retval = -EINVAL; |
1da177e4c
|
301 |
|
0ac1759ab
|
302 |
mutex_lock(&m->lock); |
1da177e4c
|
303 |
m->version = file->f_version; |
965c8e59c
|
304 |
switch (whence) { |
5e62adef9
|
305 306 |
case SEEK_CUR: offset += file->f_pos; |
0a4c92657
|
307 |
/* fall through */ |
5e62adef9
|
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 |
case SEEK_SET: if (offset < 0) break; retval = offset; if (offset != m->read_pos) { while ((retval = traverse(m, offset)) == -EAGAIN) ; if (retval) { /* with extreme prejudice... */ file->f_pos = 0; m->read_pos = 0; m->version = 0; m->index = 0; m->count = 0; } else { m->read_pos = offset; retval = file->f_pos = offset; |
1da177e4c
|
325 |
} |
05e16745c
|
326 327 |
} else { file->f_pos = offset; |
5e62adef9
|
328 |
} |
1da177e4c
|
329 |
} |
1da177e4c
|
330 |
file->f_version = m->version; |
00c5746da
|
331 |
mutex_unlock(&m->lock); |
1da177e4c
|
332 333 334 335 336 337 338 |
return retval; } EXPORT_SYMBOL(seq_lseek); /** * seq_release - free the structures associated with sequential file. * @file: file in question |
6131ffaa1
|
339 |
* @inode: its inode |
1da177e4c
|
340 341 342 343 344 345 |
* * Frees the structures associated with sequential file; can be used * as ->f_op->release() if you don't have private data to destroy. */ int seq_release(struct inode *inode, struct file *file) { |
8209e2f46
|
346 |
struct seq_file *m = file->private_data; |
058504edd
|
347 |
kvfree(m->buf); |
096523203
|
348 |
kmem_cache_free(seq_file_cache, m); |
1da177e4c
|
349 350 351 352 353 354 355 356 357 358 359 |
return 0; } EXPORT_SYMBOL(seq_release); /** * seq_escape - print string into buffer, escaping some characters * @m: target buffer * @s: string * @esc: set of characters that need escaping * * Puts string into buffer, replacing each occurrence of character from |
6798a8caa
|
360 361 |
* @esc with usual octal escape. * Use seq_has_overflowed() to check for errors. |
1da177e4c
|
362 |
*/ |
6798a8caa
|
363 |
void seq_escape(struct seq_file *m, const char *s, const char *esc) |
1da177e4c
|
364 |
{ |
25c6bb76e
|
365 366 367 |
char *buf; size_t size = seq_get_buf(m, &buf); int ret; |
1da177e4c
|
368 |
|
25c6bb76e
|
369 370 |
ret = string_escape_str(s, buf, size, ESCAPE_OCTAL, esc); seq_commit(m, ret < size ? ret : -1); |
1da177e4c
|
371 372 |
} EXPORT_SYMBOL(seq_escape); |
ea053e164
|
373 374 375 376 377 378 379 380 381 382 |
void seq_escape_mem_ascii(struct seq_file *m, const char *src, size_t isz) { char *buf; size_t size = seq_get_buf(m, &buf); int ret; ret = string_escape_mem_ascii(src, isz, buf, size); seq_commit(m, ret < size ? ret : -1); } EXPORT_SYMBOL(seq_escape_mem_ascii); |
6798a8caa
|
383 |
void seq_vprintf(struct seq_file *m, const char *f, va_list args) |
1da177e4c
|
384 |
{ |
1da177e4c
|
385 386 387 |
int len; if (m->count < m->size) { |
1da177e4c
|
388 |
len = vsnprintf(m->buf + m->count, m->size - m->count, f, args); |
1da177e4c
|
389 390 |
if (m->count + len < m->size) { m->count += len; |
6798a8caa
|
391 |
return; |
1da177e4c
|
392 393 |
} } |
e075f5915
|
394 |
seq_set_overflow(m); |
1da177e4c
|
395 |
} |
a4808147d
|
396 |
EXPORT_SYMBOL(seq_vprintf); |
6798a8caa
|
397 |
void seq_printf(struct seq_file *m, const char *f, ...) |
a4808147d
|
398 |
{ |
a4808147d
|
399 400 401 |
va_list args; va_start(args, f); |
6798a8caa
|
402 |
seq_vprintf(m, f, args); |
a4808147d
|
403 |
va_end(args); |
a4808147d
|
404 |
} |
1da177e4c
|
405 |
EXPORT_SYMBOL(seq_printf); |
74e2f334f
|
406 |
/** |
958086d17
|
407 408 409 410 |
* mangle_path - mangle and copy path to buffer beginning * @s: buffer start * @p: beginning of path in above buffer * @esc: set of characters that need escaping |
74e2f334f
|
411 412 413 414 415 416 |
* * Copy the path from @p to @s, replacing each occurrence of character from * @esc with usual octal escape. * Returns pointer past last written character in @s, or NULL in case of * failure. */ |
8c9379e97
|
417 |
char *mangle_path(char *s, const char *p, const char *esc) |
6092d0481
|
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 |
{ while (s <= p) { char c = *p++; if (!c) { return s; } else if (!strchr(esc, c)) { *s++ = c; } else if (s + 4 > p) { break; } else { *s++ = '\\'; *s++ = '0' + ((c & 0300) >> 6); *s++ = '0' + ((c & 070) >> 3); *s++ = '0' + (c & 07); } } return NULL; } |
604094f46
|
436 |
EXPORT_SYMBOL(mangle_path); |
6092d0481
|
437 |
|
52afeefb9
|
438 439 440 441 442 443 444 445 |
/** * seq_path - seq_file interface to print a pathname * @m: the seq_file handle * @path: the struct path to print * @esc: set of characters to escape in the output * * return the absolute path of 'path', as represented by the * dentry / mnt pair in the path parameter. |
6092d0481
|
446 |
*/ |
8c9379e97
|
447 |
int seq_path(struct seq_file *m, const struct path *path, const char *esc) |
1da177e4c
|
448 |
{ |
f84398068
|
449 450 451 452 453 454 |
char *buf; size_t size = seq_get_buf(m, &buf); int res = -1; if (size) { char *p = d_path(path, buf, size); |
1da177e4c
|
455 |
if (!IS_ERR(p)) { |
f84398068
|
456 457 458 |
char *end = mangle_path(buf, p, esc); if (end) res = end - buf; |
1da177e4c
|
459 460 |
} } |
f84398068
|
461 462 463 |
seq_commit(m, res); return res; |
1da177e4c
|
464 465 |
} EXPORT_SYMBOL(seq_path); |
2726d5662
|
466 467 468 469 470 471 472 473 474 475 476 477 478 |
/** * seq_file_path - seq_file interface to print a pathname of a file * @m: the seq_file handle * @file: the struct file to print * @esc: set of characters to escape in the output * * return the absolute path to the file. */ int seq_file_path(struct seq_file *m, struct file *file, const char *esc) { return seq_path(m, &file->f_path, esc); } EXPORT_SYMBOL(seq_file_path); |
6092d0481
|
479 |
/* |
9d1bc6013
|
480 |
* Same as seq_path, but relative to supplied root. |
9d1bc6013
|
481 |
*/ |
8c9379e97
|
482 483 |
int seq_path_root(struct seq_file *m, const struct path *path, const struct path *root, const char *esc) |
9d1bc6013
|
484 |
{ |
f84398068
|
485 486 487 488 489 |
char *buf; size_t size = seq_get_buf(m, &buf); int res = -ENAMETOOLONG; if (size) { |
9d1bc6013
|
490 |
char *p; |
f84398068
|
491 |
p = __d_path(path, root, buf, size); |
02125a826
|
492 493 |
if (!p) return SEQ_SKIP; |
f84398068
|
494 |
res = PTR_ERR(p); |
9d1bc6013
|
495 |
if (!IS_ERR(p)) { |
f84398068
|
496 497 498 499 500 |
char *end = mangle_path(buf, p, esc); if (end) res = end - buf; else res = -ENAMETOOLONG; |
9d1bc6013
|
501 502 |
} } |
f84398068
|
503 |
seq_commit(m, res); |
02125a826
|
504 |
return res < 0 && res != -ENAMETOOLONG ? res : 0; |
9d1bc6013
|
505 506 507 |
} /* |
6092d0481
|
508 509 |
* returns the path of the 'dentry' from the root of its filesystem. */ |
8c9379e97
|
510 |
int seq_dentry(struct seq_file *m, struct dentry *dentry, const char *esc) |
6092d0481
|
511 |
{ |
f84398068
|
512 513 514 515 516 517 |
char *buf; size_t size = seq_get_buf(m, &buf); int res = -1; if (size) { char *p = dentry_path(dentry, buf, size); |
6092d0481
|
518 |
if (!IS_ERR(p)) { |
f84398068
|
519 520 521 |
char *end = mangle_path(buf, p, esc); if (end) res = end - buf; |
6092d0481
|
522 523 |
} } |
f84398068
|
524 525 526 |
seq_commit(m, res); return res; |
6092d0481
|
527 |
} |
c8d3fe028
|
528 |
EXPORT_SYMBOL(seq_dentry); |
6092d0481
|
529 |
|
1da177e4c
|
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 |
static void *single_start(struct seq_file *p, loff_t *pos) { return NULL + (*pos == 0); } static void *single_next(struct seq_file *p, void *v, loff_t *pos) { ++*pos; return NULL; } static void single_stop(struct seq_file *p, void *v) { } int single_open(struct file *file, int (*show)(struct seq_file *, void *), void *data) { |
d64d01a15
|
548 |
struct seq_operations *op = kmalloc(sizeof(*op), GFP_KERNEL_ACCOUNT); |
1da177e4c
|
549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 |
int res = -ENOMEM; if (op) { op->start = single_start; op->next = single_next; op->stop = single_stop; op->show = show; res = seq_open(file, op); if (!res) ((struct seq_file *)file->private_data)->private = data; else kfree(op); } return res; } EXPORT_SYMBOL(single_open); |
2043f495c
|
565 566 567 |
int single_open_size(struct file *file, int (*show)(struct seq_file *, void *), void *data, size_t size) { |
058504edd
|
568 |
char *buf = seq_buf_alloc(size); |
2043f495c
|
569 570 571 572 573 |
int ret; if (!buf) return -ENOMEM; ret = single_open(file, show, data); if (ret) { |
058504edd
|
574 |
kvfree(buf); |
2043f495c
|
575 576 577 578 579 580 581 |
return ret; } ((struct seq_file *)file->private_data)->buf = buf; ((struct seq_file *)file->private_data)->size = size; return 0; } EXPORT_SYMBOL(single_open_size); |
1da177e4c
|
582 583 |
int single_release(struct inode *inode, struct file *file) { |
15ad7cdcf
|
584 |
const struct seq_operations *op = ((struct seq_file *)file->private_data)->op; |
1da177e4c
|
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 |
int res = seq_release(inode, file); kfree(op); return res; } EXPORT_SYMBOL(single_release); int seq_release_private(struct inode *inode, struct file *file) { struct seq_file *seq = file->private_data; kfree(seq->private); seq->private = NULL; return seq_release(inode, file); } EXPORT_SYMBOL(seq_release_private); |
39699037a
|
600 601 602 603 604 605 |
void *__seq_open_private(struct file *f, const struct seq_operations *ops, int psize) { int rc; void *private; struct seq_file *seq; |
d64d01a15
|
606 |
private = kzalloc(psize, GFP_KERNEL_ACCOUNT); |
39699037a
|
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 |
if (private == NULL) goto out; rc = seq_open(f, ops); if (rc < 0) goto out_free; seq = f->private_data; seq->private = private; return private; out_free: kfree(private); out: return NULL; } EXPORT_SYMBOL(__seq_open_private); int seq_open_private(struct file *filp, const struct seq_operations *ops, int psize) { return __seq_open_private(filp, ops, psize) ? 0 : -ENOMEM; } EXPORT_SYMBOL(seq_open_private); |
6798a8caa
|
631 |
void seq_putc(struct seq_file *m, char c) |
1da177e4c
|
632 |
{ |
6798a8caa
|
633 634 635 636 |
if (m->count >= m->size) return; m->buf[m->count++] = c; |
1da177e4c
|
637 638 |
} EXPORT_SYMBOL(seq_putc); |
6798a8caa
|
639 |
void seq_puts(struct seq_file *m, const char *s) |
1da177e4c
|
640 641 |
{ int len = strlen(s); |
6798a8caa
|
642 643 644 645 |
if (m->count + len >= m->size) { seq_set_overflow(m); return; |
1da177e4c
|
646 |
} |
6798a8caa
|
647 648 |
memcpy(m->buf + m->count, s, len); m->count += len; |
1da177e4c
|
649 650 |
} EXPORT_SYMBOL(seq_puts); |
bcf67e162
|
651 |
|
d1be35cb6
|
652 |
/** |
1ac101a5d
|
653 654 |
* A helper routine for putting decimal numbers without rich format of printf(). * only 'unsigned long long' is supported. |
d1be35cb6
|
655 656 657 658 659 660 |
* @m: seq_file identifying the buffer to which data should be written * @delimiter: a string which is printed before the number * @num: the number * @width: a minimum field width * * This routine will put strlen(delimiter) + number into seq_filed. |
1ac101a5d
|
661 662 663 |
* This routine is very quick when you show lots of numbers. * In usual cases, it will be better to use seq_printf(). It's easier to read. */ |
d1be35cb6
|
664 665 |
void seq_put_decimal_ull_width(struct seq_file *m, const char *delimiter, unsigned long long num, unsigned int width) |
1ac101a5d
|
666 667 668 669 670 |
{ int len; if (m->count + 2 >= m->size) /* we'll write 2 bytes at least */ goto overflow; |
48dffbf82
|
671 672 673 674 675 676 |
if (delimiter && delimiter[0]) { if (delimiter[1] == 0) seq_putc(m, delimiter[0]); else seq_puts(m, delimiter); } |
75ba1d07f
|
677 |
|
d1be35cb6
|
678 679 680 681 |
if (!width) width = 1; if (m->count + width >= m->size) |
75ba1d07f
|
682 |
goto overflow; |
1ac101a5d
|
683 |
|
d1be35cb6
|
684 |
len = num_to_str(m->buf + m->count, m->size - m->count, num, width); |
1ac101a5d
|
685 686 |
if (!len) goto overflow; |
75ba1d07f
|
687 |
|
1ac101a5d
|
688 |
m->count += len; |
6798a8caa
|
689 |
return; |
1ac101a5d
|
690 |
overflow: |
e075f5915
|
691 |
seq_set_overflow(m); |
1ac101a5d
|
692 |
} |
d1be35cb6
|
693 694 695 696 697 698 |
void seq_put_decimal_ull(struct seq_file *m, const char *delimiter, unsigned long long num) { return seq_put_decimal_ull_width(m, delimiter, num, 0); } |
1ac101a5d
|
699 |
EXPORT_SYMBOL(seq_put_decimal_ull); |
0e3dc0191
|
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 |
/** * seq_put_hex_ll - put a number in hexadecimal notation * @m: seq_file identifying the buffer to which data should be written * @delimiter: a string which is printed before the number * @v: the number * @width: a minimum field width * * seq_put_hex_ll(m, "", v, 8) is equal to seq_printf(m, "%08llx", v) * * This routine is very quick when you show lots of numbers. * In usual cases, it will be better to use seq_printf(). It's easier to read. */ void seq_put_hex_ll(struct seq_file *m, const char *delimiter, unsigned long long v, unsigned int width) { unsigned int len; int i; if (delimiter && delimiter[0]) { if (delimiter[1] == 0) seq_putc(m, delimiter[0]); else seq_puts(m, delimiter); } /* If x is 0, the result of __builtin_clzll is undefined */ if (v == 0) len = 1; else len = (sizeof(v) * 8 - __builtin_clzll(v) + 3) / 4; if (len < width) len = width; if (m->count + len > m->size) { seq_set_overflow(m); return; } for (i = len - 1; i >= 0; i--) { m->buf[m->count + i] = hex_asc[0xf & v]; v = v >> 4; } m->count += len; } |
75ba1d07f
|
745 |
void seq_put_decimal_ll(struct seq_file *m, const char *delimiter, long long num) |
bda7bad62
|
746 |
{ |
75ba1d07f
|
747 748 749 750 |
int len; if (m->count + 3 >= m->size) /* we'll write 2 bytes at least */ goto overflow; |
48dffbf82
|
751 752 753 754 755 756 |
if (delimiter && delimiter[0]) { if (delimiter[1] == 0) seq_putc(m, delimiter[0]); else seq_puts(m, delimiter); } |
75ba1d07f
|
757 758 759 |
if (m->count + 2 >= m->size) goto overflow; |
bda7bad62
|
760 |
if (num < 0) { |
75ba1d07f
|
761 |
m->buf[m->count++] = '-'; |
bda7bad62
|
762 |
num = -num; |
bda7bad62
|
763 |
} |
75ba1d07f
|
764 765 766 767 768 |
if (num < 10) { m->buf[m->count++] = num + '0'; return; } |
d1be35cb6
|
769 |
len = num_to_str(m->buf + m->count, m->size - m->count, num, 0); |
75ba1d07f
|
770 771 772 773 774 775 776 777 |
if (!len) goto overflow; m->count += len; return; overflow: seq_set_overflow(m); |
bda7bad62
|
778 779 |
} EXPORT_SYMBOL(seq_put_decimal_ll); |
0b923606e
|
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 |
/** * seq_write - write arbitrary data to buffer * @seq: seq_file identifying the buffer to which data should be written * @data: data address * @len: number of bytes * * Return 0 on success, non-zero otherwise. */ int seq_write(struct seq_file *seq, const void *data, size_t len) { if (seq->count + len < seq->size) { memcpy(seq->buf + seq->count, data, len); seq->count += len; return 0; } |
e075f5915
|
795 |
seq_set_overflow(seq); |
0b923606e
|
796 797 798 |
return -1; } EXPORT_SYMBOL(seq_write); |
839cc2a94
|
799 800 801 802 803 804 805 806 |
/** * seq_pad - write padding spaces to buffer * @m: seq_file identifying the buffer to which data should be written * @c: the byte to append after padding if non-zero */ void seq_pad(struct seq_file *m, char c) { int size = m->pad_until - m->count; |
8cfa67b4d
|
807 808 809 810 811 812 813 814 |
if (size > 0) { if (size + m->count > m->size) { seq_set_overflow(m); return; } memset(m->buf + m->count, ' ', size); m->count += size; } |
839cc2a94
|
815 816 817 818 |
if (c) seq_putc(m, c); } EXPORT_SYMBOL(seq_pad); |
37607102c
|
819 820 821 822 823 824 825 |
/* A complete analogue of print_hex_dump() */ void seq_hex_dump(struct seq_file *m, const char *prefix_str, int prefix_type, int rowsize, int groupsize, const void *buf, size_t len, bool ascii) { const u8 *ptr = buf; int i, linelen, remaining = len; |
8b91a318e
|
826 827 |
char *buffer; size_t size; |
37607102c
|
828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 |
int ret; if (rowsize != 16 && rowsize != 32) rowsize = 16; for (i = 0; i < len && !seq_has_overflowed(m); i += rowsize) { linelen = min(remaining, rowsize); remaining -= rowsize; switch (prefix_type) { case DUMP_PREFIX_ADDRESS: seq_printf(m, "%s%p: ", prefix_str, ptr + i); break; case DUMP_PREFIX_OFFSET: seq_printf(m, "%s%.8x: ", prefix_str, i); break; default: seq_printf(m, "%s", prefix_str); break; } |
8b91a318e
|
848 |
size = seq_get_buf(m, &buffer); |
37607102c
|
849 |
ret = hex_dump_to_buffer(ptr + i, linelen, rowsize, groupsize, |
8b91a318e
|
850 851 852 853 854 |
buffer, size, ascii); seq_commit(m, ret < size ? ret : -1); seq_putc(m, ' '); |
37607102c
|
855 856 857 |
} } EXPORT_SYMBOL(seq_hex_dump); |
bcf67e162
|
858 859 860 861 862 863 864 865 866 867 |
struct list_head *seq_list_start(struct list_head *head, loff_t pos) { struct list_head *lh; list_for_each(lh, head) if (pos-- == 0) return lh; return NULL; } |
bcf67e162
|
868 869 870 871 872 873 874 875 876 |
EXPORT_SYMBOL(seq_list_start); struct list_head *seq_list_start_head(struct list_head *head, loff_t pos) { if (!pos) return head; return seq_list_start(head, pos - 1); } |
bcf67e162
|
877 878 879 880 881 882 883 884 885 886 |
EXPORT_SYMBOL(seq_list_start_head); struct list_head *seq_list_next(void *v, struct list_head *head, loff_t *ppos) { struct list_head *lh; lh = ((struct list_head *)v)->next; ++*ppos; return lh == head ? NULL : lh; } |
bcf67e162
|
887 |
EXPORT_SYMBOL(seq_list_next); |
66655de6d
|
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 |
/** * seq_hlist_start - start an iteration of a hlist * @head: the head of the hlist * @pos: the start position of the sequence * * Called at seq_file->op->start(). */ struct hlist_node *seq_hlist_start(struct hlist_head *head, loff_t pos) { struct hlist_node *node; hlist_for_each(node, head) if (pos-- == 0) return node; return NULL; } EXPORT_SYMBOL(seq_hlist_start); /** * seq_hlist_start_head - start an iteration of a hlist * @head: the head of the hlist * @pos: the start position of the sequence * * Called at seq_file->op->start(). Call this function if you want to * print a header at the top of the output. */ struct hlist_node *seq_hlist_start_head(struct hlist_head *head, loff_t pos) { if (!pos) return SEQ_START_TOKEN; return seq_hlist_start(head, pos - 1); } EXPORT_SYMBOL(seq_hlist_start_head); /** * seq_hlist_next - move to the next position of the hlist * @v: the current iterator * @head: the head of the hlist |
138860b95
|
928 |
* @ppos: the current position |
66655de6d
|
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 |
* * Called at seq_file->op->next(). */ struct hlist_node *seq_hlist_next(void *v, struct hlist_head *head, loff_t *ppos) { struct hlist_node *node = v; ++*ppos; if (v == SEQ_START_TOKEN) return head->first; else return node->next; } EXPORT_SYMBOL(seq_hlist_next); |
1cc523271
|
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 |
/** * seq_hlist_start_rcu - start an iteration of a hlist protected by RCU * @head: the head of the hlist * @pos: the start position of the sequence * * Called at seq_file->op->start(). * * This list-traversal primitive may safely run concurrently with * the _rcu list-mutation primitives such as hlist_add_head_rcu() * as long as the traversal is guarded by rcu_read_lock(). */ struct hlist_node *seq_hlist_start_rcu(struct hlist_head *head, loff_t pos) { struct hlist_node *node; __hlist_for_each_rcu(node, head) if (pos-- == 0) return node; return NULL; } EXPORT_SYMBOL(seq_hlist_start_rcu); /** * seq_hlist_start_head_rcu - start an iteration of a hlist protected by RCU * @head: the head of the hlist * @pos: the start position of the sequence * * Called at seq_file->op->start(). Call this function if you want to * print a header at the top of the output. * * This list-traversal primitive may safely run concurrently with * the _rcu list-mutation primitives such as hlist_add_head_rcu() * as long as the traversal is guarded by rcu_read_lock(). */ struct hlist_node *seq_hlist_start_head_rcu(struct hlist_head *head, loff_t pos) { if (!pos) return SEQ_START_TOKEN; return seq_hlist_start_rcu(head, pos - 1); } EXPORT_SYMBOL(seq_hlist_start_head_rcu); /** * seq_hlist_next_rcu - move to the next position of the hlist protected by RCU * @v: the current iterator * @head: the head of the hlist |
138860b95
|
994 |
* @ppos: the current position |
1cc523271
|
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 |
* * Called at seq_file->op->next(). * * This list-traversal primitive may safely run concurrently with * the _rcu list-mutation primitives such as hlist_add_head_rcu() * as long as the traversal is guarded by rcu_read_lock(). */ struct hlist_node *seq_hlist_next_rcu(void *v, struct hlist_head *head, loff_t *ppos) { struct hlist_node *node = v; ++*ppos; if (v == SEQ_START_TOKEN) return rcu_dereference(head->first); else return rcu_dereference(node->next); } EXPORT_SYMBOL(seq_hlist_next_rcu); |
0bc77381c
|
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 |
/** * seq_hlist_start_precpu - start an iteration of a percpu hlist array * @head: pointer to percpu array of struct hlist_heads * @cpu: pointer to cpu "cursor" * @pos: start position of sequence * * Called at seq_file->op->start(). */ struct hlist_node * seq_hlist_start_percpu(struct hlist_head __percpu *head, int *cpu, loff_t pos) { struct hlist_node *node; for_each_possible_cpu(*cpu) { hlist_for_each(node, per_cpu_ptr(head, *cpu)) { if (pos-- == 0) return node; } } return NULL; } EXPORT_SYMBOL(seq_hlist_start_percpu); /** * seq_hlist_next_percpu - move to the next position of the percpu hlist array * @v: pointer to current hlist_node * @head: pointer to percpu array of struct hlist_heads * @cpu: pointer to cpu "cursor" * @pos: start position of sequence * * Called at seq_file->op->next(). */ struct hlist_node * seq_hlist_next_percpu(void *v, struct hlist_head __percpu *head, int *cpu, loff_t *pos) { struct hlist_node *node = v; ++*pos; if (node->next) return node->next; for (*cpu = cpumask_next(*cpu, cpu_possible_mask); *cpu < nr_cpu_ids; *cpu = cpumask_next(*cpu, cpu_possible_mask)) { struct hlist_head *bucket = per_cpu_ptr(head, *cpu); if (!hlist_empty(bucket)) return bucket->first; } return NULL; } EXPORT_SYMBOL(seq_hlist_next_percpu); |
096523203
|
1069 1070 1071 |
void __init seq_file_init(void) { |
d64d01a15
|
1072 |
seq_file_cache = KMEM_CACHE(seq_file, SLAB_ACCOUNT|SLAB_PANIC); |
096523203
|
1073 |
} |