xref: /freebsd/sys/compat/linuxkpi/common/include/linux/seq_file.h (revision e6bfd18d21b225af6a0ed67ceeaf1293b7b9eba5)
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  * $FreeBSD$
28  */
29 
30 #ifndef _LINUXKPI_LINUX_SEQ_FILE_H_
31 #define _LINUXKPI_LINUX_SEQ_FILE_H_
32 
33 #include <linux/types.h>
34 #include <linux/fs.h>
35 
36 #undef file
37 #define inode vnode
38 
39 MALLOC_DECLARE(M_LSEQ);
40 
41 #define	DEFINE_SHOW_ATTRIBUTE(__name)					\
42 static int __name ## _open(struct inode *inode, struct linux_file *file)	\
43 {									\
44 	return single_open(file, __name ## _show, inode->i_private);	\
45 }									\
46 									\
47 static const struct file_operations __name ## _fops = {			\
48 	.owner		= THIS_MODULE,					\
49 	.open		= __name ## _open,				\
50 	.read		= seq_read,					\
51 	.llseek		= seq_lseek,					\
52 	.release	= single_release,				\
53 }
54 
55 struct seq_file {
56 	struct sbuf *buf;
57 	size_t size;
58 	const struct seq_operations *op;
59 	const struct linux_file *file;
60 	void *private;
61 };
62 
63 struct seq_operations {
64 	void * (*start) (struct seq_file *m, off_t *pos);
65 	void (*stop) (struct seq_file *m, void *v);
66 	void * (*next) (struct seq_file *m, void *v, off_t *pos);
67 	int (*show) (struct seq_file *m, void *v);
68 };
69 
70 ssize_t seq_read(struct linux_file *, char *, size_t, off_t *);
71 int seq_write(struct seq_file *seq, const void *data, size_t len);
72 void seq_putc(struct seq_file *m, char c);
73 void seq_puts(struct seq_file *m, const char *str);
74 bool seq_has_overflowed(struct seq_file *m);
75 
76 void *__seq_open_private(struct linux_file *, const struct seq_operations *, int);
77 int seq_release_private(struct inode *, struct linux_file *);
78 
79 int seq_open(struct linux_file *f, const struct seq_operations *op);
80 int seq_release(struct inode *inode, struct linux_file *file);
81 
82 off_t seq_lseek(struct linux_file *file, off_t offset, int whence);
83 int single_open(struct linux_file *, int (*)(struct seq_file *, void *), void *);
84 int single_open_size(struct linux_file *, int (*)(struct seq_file *, void *), void *, size_t);
85 int single_release(struct inode *, struct linux_file *);
86 
87 void lkpi_seq_vprintf(struct seq_file *m, const char *fmt, va_list args);
88 void lkpi_seq_printf(struct seq_file *m, const char *fmt, ...);
89 
90 #define	seq_vprintf(...)	lkpi_seq_vprintf(__VA_ARGS__)
91 #define	seq_printf(...)		lkpi_seq_printf(__VA_ARGS__)
92 
93 #define	file			linux_file
94 
95 #endif	/* _LINUXKPI_LINUX_SEQ_FILE_H_ */
96