sys/compat/linuxkpi/common/include/linux/seq_file.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   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 _LINUX_SEQ_FILE_H_
  31 #define _LINUX_SEQ_FILE_H_
  32
  33 #include <linux/types.h>
  34 #include <linux/fs.h>
  35 #include <sys/sbuf.h>
  36
  37 #undef file
  38 #define inode vnode
  39
  40 #define DEFINE_SHOW_ATTRIBUTE(__name)                                   \
  41 static int __name ## _open(struct inode *inode, struct linux_file *file)        \
  42 {                                                                       \
  43         return single_open(file, __name ## _show, inode->i_private);    \
  44 }                                                                       \
  45                                                                         \
  46 static const struct file_operations __name ## _fops = {                 \
  47         .owner          = THIS_MODULE,                                  \
  48         .open           = __name ## _open,                              \
  49         .read           = seq_read,                                     \
  50         .llseek         = seq_lseek,                                    \
  51         .release        = single_release,                               \
  52 }
  53
  54 struct seq_operations;
  55
  56 struct seq_file {
  57         struct sbuf     *buf;
  58
  59         const struct seq_operations *op;
  60         const struct linux_file *file;
  61         void *private;
  62 };
  63
  64 struct seq_operations {
  65         void * (*start) (struct seq_file *m, off_t *pos);
  66         void (*stop) (struct seq_file *m, void *v);
  67         void * (*next) (struct seq_file *m, void *v, off_t *pos);
  68         int (*show) (struct seq_file *m, void *v);
  69 };
  70
  71 ssize_t seq_read(struct linux_file *, char *, size_t, off_t *);
  72 int seq_write(struct seq_file *seq, const void *data, size_t len);
  73
  74 int seq_open(struct linux_file *f, const struct seq_operations *op);
  75 int seq_release(struct inode *inode, struct linux_file *file);
  76
  77 off_t seq_lseek(struct linux_file *file, off_t offset, int whence);
  78 int single_open(struct linux_file *, int (*)(struct seq_file *, void *), void *);
  79 int single_release(struct inode *, struct linux_file *);
  80
  81 #define seq_printf(m, fmt, ...) sbuf_printf((m)->buf, (fmt), ##__VA_ARGS__)
  82
  83 #define seq_puts(m, str)        sbuf_printf((m)->buf, str)
  84 #define seq_putc(m, str)        sbuf_putc((m)->buf, str)
  85
  86 #define file                    linux_file
  87
  88 #endif  /* _LINUX_SEQ_FILE_H_ */