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