1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2016-2018, Matthew Macy <mmacy@freebsd.org> 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28 #ifndef _LINUXKPI_LINUX_SEQ_FILE_H_ 29 #define _LINUXKPI_LINUX_SEQ_FILE_H_ 30 31 #include <linux/types.h> 32 #include <linux/fs.h> 33 34 #undef file 35 #define inode vnode 36 37 MALLOC_DECLARE(M_LSEQ); 38 39 #define DEFINE_SHOW_ATTRIBUTE(__name) \ 40 static int __name ## _open(struct inode *inode, struct linux_file *file) \ 41 { \ 42 return single_open(file, __name ## _show, inode->i_private); \ 43 } \ 44 \ 45 static const struct file_operations __name ## _fops = { \ 46 .owner = THIS_MODULE, \ 47 .open = __name ## _open, \ 48 .read = seq_read, \ 49 .llseek = seq_lseek, \ 50 .release = single_release, \ 51 } 52 53 struct seq_file { 54 struct sbuf *buf; 55 size_t size; 56 const struct seq_operations *op; 57 const struct linux_file *file; 58 void *private; 59 }; 60 61 struct seq_operations { 62 void * (*start) (struct seq_file *m, off_t *pos); 63 void (*stop) (struct seq_file *m, void *v); 64 void * (*next) (struct seq_file *m, void *v, off_t *pos); 65 int (*show) (struct seq_file *m, void *v); 66 }; 67 68 ssize_t seq_read(struct linux_file *, char *, size_t, off_t *); 69 int seq_write(struct seq_file *seq, const void *data, size_t len); 70 void seq_putc(struct seq_file *m, char c); 71 void seq_puts(struct seq_file *m, const char *str); 72 bool seq_has_overflowed(struct seq_file *m); 73 74 void *__seq_open_private(struct linux_file *, const struct seq_operations *, int); 75 int seq_release_private(struct inode *, struct linux_file *); 76 77 int seq_open(struct linux_file *f, const struct seq_operations *op); 78 int seq_release(struct inode *inode, struct linux_file *file); 79 80 off_t seq_lseek(struct linux_file *file, off_t offset, int whence); 81 int single_open(struct linux_file *, int (*)(struct seq_file *, void *), void *); 82 int single_open_size(struct linux_file *, int (*)(struct seq_file *, void *), void *, size_t); 83 int single_release(struct inode *, struct linux_file *); 84 85 void lkpi_seq_vprintf(struct seq_file *m, const char *fmt, va_list args); 86 void lkpi_seq_printf(struct seq_file *m, const char *fmt, ...); 87 88 #define seq_vprintf(...) lkpi_seq_vprintf(__VA_ARGS__) 89 #define seq_printf(...) lkpi_seq_printf(__VA_ARGS__) 90 91 #define file linux_file 92 93 #endif /* _LINUXKPI_LINUX_SEQ_FILE_H_ */ 94