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 <sys/types.h> 32 #include <sys/sbuf.h> 33 34 #include <linux/types.h> 35 #include <linux/fs.h> 36 #include <linux/string_helpers.h> 37 #include <linux/printk.h> 38 39 #undef file 40 #define inode vnode 41 42 #define SEQ_SKIP 1 43 44 MALLOC_DECLARE(M_LSEQ); 45 46 #define DEFINE_SHOW_ATTRIBUTE(__name) \ 47 static int __name ## _open(struct inode *inode, struct linux_file *file) \ 48 { \ 49 return single_open(file, __name ## _show, inode->i_private); \ 50 } \ 51 \ 52 static const struct file_operations __name ## _fops = { \ 53 .owner = THIS_MODULE, \ 54 .open = __name ## _open, \ 55 .read = seq_read, \ 56 .llseek = seq_lseek, \ 57 .release = single_release, \ 58 } 59 60 #define DEFINE_SHOW_STORE_ATTRIBUTE(__name) \ 61 static int __name ## _open(struct inode *inode, struct linux_file *file) \ 62 { \ 63 return single_open(file, __name ## _show, inode->i_private); \ 64 } \ 65 \ 66 static const struct file_operations __name ## _fops = { \ 67 .owner = THIS_MODULE, \ 68 .open = __name ## _open, \ 69 .read = seq_read, \ 70 .write = __name ## _write, \ 71 .llseek = seq_lseek, \ 72 .release = single_release, \ 73 } 74 75 struct seq_file { 76 struct sbuf *buf; 77 size_t size; 78 const struct seq_operations *op; 79 const struct linux_file *file; 80 void *private; 81 }; 82 83 struct seq_operations { 84 void * (*start) (struct seq_file *m, off_t *pos); 85 void (*stop) (struct seq_file *m, void *v); 86 void * (*next) (struct seq_file *m, void *v, off_t *pos); 87 int (*show) (struct seq_file *m, void *v); 88 }; 89 90 ssize_t seq_read(struct linux_file *, char __user *, size_t, off_t *); 91 int seq_write(struct seq_file *seq, const void *data, size_t len); 92 void seq_putc(struct seq_file *m, char c); 93 void seq_puts(struct seq_file *m, const char *str); 94 bool seq_has_overflowed(struct seq_file *m); 95 96 void *__seq_open_private(struct linux_file *, const struct seq_operations *, int); 97 int seq_release_private(struct inode *, struct linux_file *); 98 99 int seq_open(struct linux_file *f, const struct seq_operations *op); 100 int seq_release(struct inode *inode, struct linux_file *file); 101 102 off_t seq_lseek(struct linux_file *file, off_t offset, int whence); 103 int single_open(struct linux_file *, int (*)(struct seq_file *, void *), void *); 104 int single_open_size(struct linux_file *, int (*)(struct seq_file *, void *), void *, size_t); 105 int single_release(struct inode *, struct linux_file *); 106 107 void lkpi_seq_vprintf(struct seq_file *m, const char *fmt, va_list args); 108 void lkpi_seq_printf(struct seq_file *m, const char *fmt, ...); 109 110 #define seq_vprintf(...) lkpi_seq_vprintf(__VA_ARGS__) 111 #define seq_printf(...) lkpi_seq_printf(__VA_ARGS__) 112 113 int __lkpi_hexdump_sbuf_printf(void *, const char *, ...) __printflike(2, 3); 114 115 static inline void 116 seq_hex_dump(struct seq_file *m, const char *prefix_str, int prefix_type, 117 int rowsize, int groupsize, const void *buf, size_t len, bool ascii) 118 { 119 lkpi_hex_dump(__lkpi_hexdump_sbuf_printf, m->buf, NULL, prefix_str, prefix_type, 120 rowsize, groupsize, buf, len, ascii, true); 121 } 122 123 #define file linux_file 124 125 #endif /* _LINUXKPI_LINUX_SEQ_FILE_H_ */ 126