include/spl/sys/procfs_list.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21 /*
  22  * Copyright (c) 2018 by Delphix. All rights reserved.
  23  */
  24
  25 #ifndef _SPL_PROCFS_LIST_H
  26 #define _SPL_PROCFS_LIST_H
  27
  28 #include <sys/kstat.h>
  29 #include <sys/mutex.h>
  30 #include <linux/proc_fs.h>
  31 #include <linux/seq_file.h>
  32
  33 typedef struct procfs_list procfs_list_t;
  34 struct procfs_list {
  35         /* Accessed only by user of a procfs_list */
  36         void            *pl_private;
  37
  38         /*
  39          * Accessed both by user of a procfs_list and by procfs_list
  40          * implementation
  41          */
  42         kmutex_t        pl_lock;
  43         list_t          pl_list;
  44
  45         /* Accessed only by procfs_list implementation */
  46         uint64_t        pl_next_id;
  47         int             (*pl_show)(struct seq_file *f, void *p);
  48         int             (*pl_show_header)(struct seq_file *f);
  49         int             (*pl_clear)(procfs_list_t *procfs_list);
  50         size_t          pl_node_offset;
  51         kstat_proc_entry_t      pl_kstat_entry;
  52 };
  53
  54 typedef struct procfs_list_node {
  55         list_node_t     pln_link;
  56         uint64_t        pln_id;
  57 } procfs_list_node_t;
  58
  59 void procfs_list_install(const char *module,
  60     const char *name,
  61     procfs_list_t *procfs_list,
  62     int (*show)(struct seq_file *f, void *p),
  63     int (*show_header)(struct seq_file *f),
  64     int (*clear)(procfs_list_t *procfs_list),
  65     size_t procfs_list_node_off);
  66 void procfs_list_uninstall(procfs_list_t *procfs_list);
  67 void procfs_list_destroy(procfs_list_t *procfs_list);
  68
  69 void procfs_list_add(procfs_list_t *procfs_list, void *p);
  70
  71 #endif  /* _SPL_PROCFS_LIST_H */