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_cachefs.c
41 * Caching filesystem (Solaris 2.x)
46 #endif /* HAVE_CONFIG_H */
50 /* forward declarations */
51 static char *cachefs_match(am_opts *fo);
52 static int cachefs_init(mntfs *mf);
53 static int cachefs_mount(am_node *am, mntfs *mf);
54 static int cachefs_umount(am_node *am, mntfs *mf);
67 amfs_error_lookup_child,
68 amfs_error_mount_child,
70 0, /* cachefs_readlink */
71 0, /* cachefs_mounted */
72 0, /* cachefs_umounted */
73 amfs_generic_find_srvr,
74 0, /* cachefs_get_wchan */
75 FS_MKMNT | FS_NOTIMEOUT | FS_UBACKGROUND | FS_AMQINFO, /* nfs_fs_flags */
77 AUTOFS_CACHEFS_FS_FLAGS,
78 #endif /* HAVE_FS_AUTOFS */
83 * Check that f/s has all needed fields.
84 * Returns: matched string if found, NULL otherwise.
87 cachefs_match(am_opts *fo)
90 if (!fo->opt_rfs || !fo->opt_fs || !fo->opt_cachedir) {
91 plog(XLOG_USER, "cachefs: must specify cachedir, rfs, and fs");
95 dlog("CACHEFS: using cache directory \"%s\"", fo->opt_cachedir);
97 /* determine magic cookie to put in mtab */
98 return xstrdup(fo->opt_cachedir);
104 * Returns: 0 if OK, non-zero (errno) if failed.
107 cachefs_init(mntfs *mf)
110 * Save cache directory name
112 if (!mf->mf_private) {
113 mf->mf_private = (voidp) xstrdup(mf->mf_fo->opt_cachedir);
114 mf->mf_prfree = (void (*)(voidp)) free;
122 * mntpt is the mount point ($fs) [XXX: was 'dir']
123 * backdir is the mounted pathname ($rfs) [XXX: was 'fs_name']
124 * cachedir is the cache directory ($cachedir)
127 mount_cachefs(char *mntdir, char *backdir, char *cachedir,
128 char *opts, int on_autofs)
134 MTYPE_TYPE type = MOUNT_TYPE_CACHEFS; /* F/S mount type */
136 memset((voidp) &ca, 0, sizeof(ca)); /* Paranoid */
139 * Fill in the mount structure
141 memset((voidp) &mnt, 0, sizeof(mnt));
142 mnt.mnt_dir = mntdir;
143 mnt.mnt_fsname = backdir;
144 mnt.mnt_type = MNTTAB_TYPE_CACHEFS;
147 flags = compute_mount_flags(&mnt);
148 #ifdef HAVE_FS_AUTOFS
150 flags |= autofs_compute_mount_flags(&mnt);
151 #endif /* HAVE_FS_AUTOFS */
153 /* Fill in cachefs mount arguments */
157 * (1) cache directory is NOT checked for sanity beforehand, nor is it
158 * purged. Maybe it should be purged first?
159 * (2) cache directory is NOT locked. Should we?
163 ca.cfs_options.opt_flags = CFS_WRITE_AROUND | CFS_ACCESS_BACKFS;
164 /* cache population size */
165 ca.cfs_options.opt_popsize = DEF_POP_SIZE; /* default: 64K */
167 ca.cfs_options.opt_fgsize = DEF_FILEGRP_SIZE; /* default: 256 */
169 /* CFS ID for file system (must be unique) */
170 ca.cfs_fsid = cachedir;
172 /* CFS fscdir name */
173 memset(ca.cfs_cacheid, 0, sizeof(ca.cfs_cacheid));
175 * Append cacheid and mountpoint.
176 * sizeof(cfs_cacheid) should be C_MAX_MOUNT_FSCDIRNAME as per
177 * <sys/fs/cachefs_fs.h> (checked on Solaris 8).
179 xsnprintf(ca.cfs_cacheid, sizeof(ca.cfs_cacheid),
180 "%s:%s", ca.cfs_fsid, mntdir);
181 /* convert '/' to '_' (Solaris does that...) */
183 while ((cp = strpbrk(cp, "/")) != NULL)
186 /* path for this cache dir */
187 ca.cfs_cachedir = cachedir;
189 /* back filesystem dir */
190 ca.cfs_backfs = backdir;
192 /* same as nfs values (XXX: need to handle these options) */
199 * Call generic mount routine
201 return mount_fs(&mnt, flags, (caddr_t) &ca, 0, type, 0, NULL, mnttab_file_name, on_autofs);
206 cachefs_mount(am_node *am, mntfs *mf)
208 int on_autofs = mf->mf_flags & MFF_ON_AUTOFS;
211 error = mount_cachefs(mf->mf_mount,
213 mf->mf_fo->opt_cachedir,
218 /* according to Solaris, if errno==ESRCH, "options to not match" */
220 plog(XLOG_ERROR, "mount_cachefs: options to no match: %m");
222 plog(XLOG_ERROR, "mount_cachefs: %m");
231 cachefs_umount(am_node *am, mntfs *mf)
233 int unmount_flags = (mf->mf_flags & MFF_ON_AUTOFS) ? AMU_UMOUNT_AUTOFS : 0;
236 error = UMOUNT_FS(mf->mf_mount, mnttab_file_name, unmount_flags);
239 * In the case of cachefs, we must fsck the cache directory. Otherwise,
240 * it will remain inconsistent, and the next cachefs mount will fail
241 * with the error "no space left on device" (ENOSPC).
243 * XXX: this is hacky! use fork/exec/wait instead...
246 char *cachedir = NULL;
249 cachedir = (char *) mf->mf_private;
250 plog(XLOG_INFO, "running fsck on cache directory \"%s\"", cachedir);
251 xsnprintf(cmd, sizeof(cmd), "fsck -F cachefs %s", cachedir);