2 * Copyright (c) 1997-2014 Erez Zadok
3 * Copyright (c) 1990 Jan-Simon Pendry
4 * Copyright (c) 1990 Imperial College of Science, Technology & Medicine
5 * Copyright (c) 1990 The Regents of the University of California.
8 * This code is derived from software contributed to Berkeley by
9 * Jan-Simon Pendry at Imperial College, London.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * File: am-utils/amd/ops_TEMPLATE.c
41 * An empty template for an amd pseudo filesystem "foofs".
45 * NOTE: if this is an Amd file system, prepend "amfs_" to all foofs symbols
46 * and renamed the file name to amfs_foofs.c. If it is a native file system
47 * (such as pcfs, isofs, or ffs), then you can keep the names as is, and
48 * just rename the file to ops_foofs.c.
53 #endif /* HAVE_CONFIG_H */
57 /* forward declarations */
58 static char *foofs_match(am_opts *fo);
59 static int foofs_init(mntfs *mf);
60 static int foofs_mount(am_node *mp, mntfs *mf);
61 static int foofs_umount(am_node *mp, mntfs *mf);
62 static am_node *foofs_lookuppn(am_node *mp, char *fname, int *error_return, int op);
63 static int foofs_readdir(am_node *mp, void cookie, voidp dp, voidp ep, u_int count);
64 static am_node *foofs_readlink(am_node *mp, int *error_return);
65 static void foofs_mounted(am_node *am, mntfs *mf);
66 static void foofs_umounted(am_node *mp, mntfs *mf);
67 static fserver *foofs_ffserver(mntfs *mf);
72 * Define only those you need, others set to 0 (NULL)
76 "foofs", /* name of file system */
77 foofs_match, /* match */
78 foofs_init, /* initialize */
79 foofs_mount, /* mount vnode */
80 foofs_umount, /* unmount vnode */
81 foofs_lookup_child, /* lookup path-name */
82 foofs_mount_child, /* mount path-name */
83 foofs_readdir, /* read directory */
84 foofs_readlink, /* read link */
85 foofs_mounted, /* after-mount extra actions */
86 foofs_umounted, /* after-umount extra actions */
87 foofs_ffserver, /* find a file server */
88 foofs_get_wchan, /* return the waiting channel */
89 FS_MKMNT | FS_BACKGROUND | FS_AMQINFO, /* nfs_fs_flags */
91 AUTOFS_TEMPLATE_FS_FLAGS,
92 #endif /* HAVE_FS_AUTOFS */
97 * Check that f/s has all needed fields.
98 * Returns: matched string if found, NULL otherwise.
101 foofs_match(am_opts *fo)
103 char *cp = "fill this with a way to find the match";
105 plog(XLOG_INFO, "entering foofs_match...");
110 return NULL; /* not OK */
116 * Returns: 0 if OK, non-zero (errno) if failed.
119 foofs_init(mntfs *mf)
123 plog(XLOG_INFO, "entering foofs_init...");
125 error = EPERM; /* XXX: fixme */
132 * Returns: 0 if OK, non-zero (errno) if failed.
135 foofs_mount(am_node *mp)
139 plog(XLOG_INFO, "entering foofs_mount...");
141 error = EPERM; /* XXX: fixme */
148 * Returns: 0 if OK, non-zero (errno) if failed.
151 foofs_fmount(mntfs *mf)
155 plog(XLOG_INFO, "entering foofs_fmount...");
157 error = EPERM; /* XXX: fixme */
164 * Returns: 0 if OK, non-zero (errno) if failed.
167 foofs_umount(am_node *mp)
171 plog(XLOG_INFO, "entering foofs_umount...");
173 error = EPERM; /* XXX: fixme */
180 * Returns: 0 if OK, non-zero (errno) if failed.
183 foofs_fumount(mntfs *mf)
187 plog(XLOG_INFO, "entering foofs_fumount...");
189 error = EPERM; /* XXX: fixme */
196 * Returns: the am_node that was found, or NULL if failed.
197 * If failed, also fills in errno in error_return.
200 foofs_lookuppn(am_node *mp, char *fname, int *error_return, int op)
204 plog(XLOG_INFO, "entering foofs_lookuppn...");
206 error = EPERM; /* XXX: fixme */
208 *error_return = error;
215 * Returns: 0 if OK, non-zero (errno) if failed.
216 * If OK, fills in ep with chain of directory entries.
219 foofs_readdir(am_node *mp, void cookie, voidp dp, voidp ep, u_int count)
223 plog(XLOG_INFO, "entering foofs_readdir...");
225 error = EPERM; /* XXX: fixme */
232 * Returns: am_node found, or NULL if not found.
233 * If failed, fills in errno in error_return.
236 foofs_readlink(am_node *mp, int *error_return)
240 plog(XLOG_INFO, "entering foofs_readlink...");
242 error = EPERM; /* XXX: fixme */
244 *error_return = error;
250 * Async mount callback function.
251 * After the base mount went OK, sometimes
252 * there are additional actions that are needed. See union_mounted() and
256 foofs_mounted(mntfs *mf)
258 plog(XLOG_INFO, "entering foofs_mounted...");
265 * Async unmount callback function.
266 * After the base umount() succeeds, we may want to take extra actions,
267 * such as informing remote mount daemons that we've unmounted them.
268 * See amfs_auto_umounted(), host_umounted(), nfs_umounted().
271 foofs_umounted(am_node *mp)
273 plog(XLOG_INFO, "entering foofs_umounted...");
280 * Find a file server.
281 * Returns: fserver of found server, or NULL if not found.
284 foofs_ffserver(mntfs *mf)
286 plog(XLOG_INFO, "entering foofs_ffserver...");
293 * Normally just return mf. Only inherit needs to do special tricks.
296 foofs_get_wchan(mntfs *mf)
298 plog(XLOG_INFO, "entering foofs_get_wchan...");