Whamcloud - gitweb
LU-5275 lprocfs: reduce scope of params_tree.h
[fs/lustre-release.git] / libcfs / include / libcfs / params_tree.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
19  *
20  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21  * CA 95054 USA or visit www.sun.com if you need additional information or
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2012, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * API and structure definitions for params_tree.
37  *
38  * Author: LiuYing <emoly.liu@oracle.com>
39  */
40 #ifndef __PARAMS_TREE_H__
41 #define __PARAMS_TREE_H__
42
43 #include <linux/fs.h>
44 #include <linux/proc_fs.h>
45 #include <linux/rwsem.h>
46 #include <linux/spinlock.h>
47
48 #ifdef CONFIG_PROC_FS
49 # define LPROCFS
50 #endif /* CONFIG_PROC_FS */
51
52 #ifdef LPROCFS
53 # ifndef HAVE_ONLY_PROCFS_SEQ
54 /* in lprocfs_stat.c, to protect the private data for proc entries */
55 extern struct rw_semaphore              _lprocfs_lock;
56
57 static inline int LPROCFS_ENTRY_CHECK(struct inode *inode)
58 {
59         struct proc_dir_entry *dp = PDE(inode);
60         int deleted = 0;
61
62         spin_lock(&(dp)->pde_unload_lock);
63         if (dp->proc_fops == NULL)
64                 deleted = 1;
65         spin_unlock(&(dp)->pde_unload_lock);
66         if (deleted)
67                 return -ENODEV;
68         return 0;
69 }
70
71 #  define LPROCFS_SRCH_ENTRY()                  \
72         do {                                    \
73                 down_read(&_lprocfs_lock);      \
74         } while (0)
75
76 #  define LPROCFS_SRCH_EXIT()                   \
77         do {                                    \
78                 up_read(&_lprocfs_lock);        \
79         } while (0)
80
81 #  define LPROCFS_WRITE_ENTRY()                 \
82         do {                                    \
83                 down_write(&_lprocfs_lock);     \
84         } while (0)
85
86 #  define LPROCFS_WRITE_EXIT()                  \
87         do {                                    \
88                 up_write(&_lprocfs_lock);       \
89         } while (0)
90
91 #  define PDE_DATA(inode)       (PDE(inode)->data)
92
93 # else /* HAVE_ONLY_PROCFS_SEQ */
94
95 static inline int LPROCFS_ENTRY_CHECK(struct inode *inode)
96 {
97         return 0;
98 }
99
100 #define LPROCFS_WRITE_ENTRY() do {} while(0)
101 #define LPROCFS_WRITE_EXIT()  do {} while(0)
102
103 # endif /* !HAVE_ONLY_PROCFS_SEQ */
104 #endif /* LPROCFS */
105 #endif  /* __PARAMS_TREE_H__ */