kernfs.h revision 1.40.32.1 1 /* $NetBSD: kernfs.h,v 1.40.32.1 2020/02/12 19:59:22 martin Exp $ */
2
3 /*
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
6 *
7 * This code is derived from software donated to Berkeley by
8 * Jan-Simon Pendry.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 * @(#)kernfs.h 8.6 (Berkeley) 3/29/95
35 */
36
37 #define _PATH_KERNFS "/kern" /* Default mountpoint */
38
39 #ifdef _KERNEL
40 #include <sys/queue.h>
41 #include <sys/tree.h>
42 #include <sys/mutex.h>
43
44 /*
45 * The different types of node in a kernfs filesystem
46 */
47 typedef enum {
48 KFSkern, /* the filesystem itself (.) */
49 KFSroot, /* the filesystem root (..) */
50 KFSnull, /* none aplicable */
51 KFStime, /* boottime */
52 KFSint, /* integer */
53 KFSstring, /* string */
54 KFShostname, /* hostname */
55 KFSavenrun, /* loadavg */
56 KFSdevice, /* device file (rootdev/rrootdev) */
57 KFSmsgbuf, /* msgbuf */
58 KFSsubdir, /* directory */
59 KFSlasttype, /* last used type */
60 KFSmaxtype = (1<<6) - 1 /* last possible type */
61 } kfstype;
62
63 /*
64 * Control data for the kern file system.
65 */
66 struct kern_target {
67 u_char kt_type;
68 u_char kt_namlen;
69 const char *kt_name;
70 void *kt_data;
71 kfstype kt_tag;
72 u_char kt_vtype;
73 mode_t kt_mode;
74 };
75
76 struct dyn_kern_target {
77 struct kern_target dkt_kt;
78 SIMPLEQ_ENTRY(dyn_kern_target) dkt_queue;
79 };
80
81 struct kernfs_subdir {
82 SIMPLEQ_HEAD(,dyn_kern_target) ks_entries;
83 unsigned int ks_nentries;
84 unsigned int ks_dirs;
85 const struct kern_target *ks_parent;
86 };
87
88 struct kernfs_node {
89 LIST_ENTRY(kernfs_node) kfs_hash; /* hash chain */
90 TAILQ_ENTRY(kernfs_node) kfs_list; /* flat list */
91 struct vnode *kfs_vnode; /* vnode associated with this kernfs_node */
92 kfstype kfs_type; /* type of kernfs node */
93 mode_t kfs_mode; /* mode bits for stat() */
94 long kfs_fileno; /* unique file id */
95 const struct kern_target *kfs_kt;
96 void *kfs_v; /* dynamic node private data */
97 long kfs_cookie; /* fileno cookie */
98 };
99
100 struct kernfs_mount {
101 TAILQ_HEAD(, kernfs_node) nodelist;
102 long fileno_cookie;
103 };
104
105 #define UIO_MX 32
106
107 #define KERNFS_FILENO(kt, typ, cookie) \
108 ((kt >= &kern_targets[0] && kt < &kern_targets[static_nkern_targets]) \
109 ? 2 + ((kt) - &kern_targets[0]) \
110 : (((cookie + 1) << 6) | (typ)))
111 #define KERNFS_TYPE_FILENO(typ, cookie) \
112 (((cookie + 1) << 6) | (typ))
113
114 #define VFSTOKERNFS(mp) ((struct kernfs_mount *)((mp)->mnt_data))
115 #define VTOKERN(vp) ((struct kernfs_node *)(vp)->v_data)
116 #define KERNFSTOV(kfs) ((kfs)->kfs_vnode)
117
118 #define KERNFS_MAXNAMLEN 255
119
120 extern const struct kern_target kern_targets[];
121 extern int nkern_targets;
122 extern const int static_nkern_targets;
123 extern int (**kernfs_vnodeop_p)(void *);
124 extern int (**kernfs_specop_p)(void *);
125 extern struct vfsops kernfs_vfsops;
126 extern dev_t rrootdev;
127 extern kmutex_t kfs_lock;
128
129 int kernfs_root(struct mount *, struct vnode **);
130
131 /*
132 * Data types for the kernfs file operations.
133 */
134 typedef enum {
135 KERNFS_XREAD,
136 KERNFS_XWRITE,
137 KERNFS_FILEOP_CLOSE,
138 KERNFS_FILEOP_GETATTR,
139 KERNFS_FILEOP_IOCTL,
140 KERNFS_FILEOP_OPEN,
141 KERNFS_FILEOP_READ,
142 KERNFS_FILEOP_WRITE,
143 } kfsfileop;
144
145 struct kernfs_fileop {
146 kfstype kf_type;
147 kfsfileop kf_fileop;
148 union {
149 int (*_kf_vop)(void *);
150 int (*_kf_xread)
151 (const struct kernfs_node *, char **, size_t);
152 int (*_kf_xwrite)
153 (const struct kernfs_node *, char *, size_t);
154 } _kf_opfn;
155 SPLAY_ENTRY(kernfs_fileop) kf_node;
156 };
157
158 #define kf_vop _kf_opfn._kf_vop
159 #define kf_xread _kf_opfn._kf_xread
160 #define kf_xwrite _kf_opfn._kf_xwrite
161
162 typedef struct kern_target kernfs_parentdir_t;
163 typedef struct dyn_kern_target kernfs_entry_t;
164
165 /*
166 * Functions for adding kernfs datatypes and nodes.
167 */
168 kfstype kernfs_alloctype(int, const struct kernfs_fileop *);
169 #define KERNFS_ALLOCTYPE(kf) kernfs_alloctype(sizeof((kf)) / \
170 sizeof((kf)[0]), (kf))
171 #define KERNFS_ALLOCENTRY(dkt, m_type, m_flags) \
172 dkt = (struct dyn_kern_target *)malloc( \
173 sizeof(struct dyn_kern_target), (m_type), (m_flags))
174 #define KERNFS_INITENTRY(dkt, type, name, data, tag, vtype, mode) do { \
175 (dkt)->dkt_kt.kt_type = (type); \
176 (dkt)->dkt_kt.kt_namlen = strlen((name)); \
177 (dkt)->dkt_kt.kt_name = (name); \
178 (dkt)->dkt_kt.kt_data = (data); \
179 (dkt)->dkt_kt.kt_tag = (tag); \
180 (dkt)->dkt_kt.kt_vtype = (vtype); \
181 (dkt)->dkt_kt.kt_mode = (mode); \
182 } while (/*CONSTCOND*/0)
183 #define KERNFS_ENTOPARENTDIR(dkt) &(dkt)->dkt_kt
184 int kernfs_addentry(kernfs_parentdir_t *, kernfs_entry_t *);
185
186 #ifdef IPSEC
187 __weak_extern(key_freesp)
188 __weak_extern(key_getspbyid)
189 __weak_extern(key_setdumpsa_spi)
190 __weak_extern(key_setdumpsp)
191 __weak_extern(satailq)
192 __weak_extern(sptailq)
193 #endif
194
195 #endif /* _KERNEL */
196