138494Sobrien/* 2310490Scy * Copyright (c) 1997-2014 Erez Zadok 338494Sobrien * Copyright (c) 1990 Jan-Simon Pendry 438494Sobrien * Copyright (c) 1990 Imperial College of Science, Technology & Medicine 538494Sobrien * Copyright (c) 1990 The Regents of the University of California. 638494Sobrien * All rights reserved. 738494Sobrien * 838494Sobrien * This code is derived from software contributed to Berkeley by 938494Sobrien * Jan-Simon Pendry at Imperial College, London. 1038494Sobrien * 1138494Sobrien * Redistribution and use in source and binary forms, with or without 1238494Sobrien * modification, are permitted provided that the following conditions 1338494Sobrien * are met: 1438494Sobrien * 1. Redistributions of source code must retain the above copyright 1538494Sobrien * notice, this list of conditions and the following disclaimer. 1638494Sobrien * 2. Redistributions in binary form must reproduce the above copyright 1738494Sobrien * notice, this list of conditions and the following disclaimer in the 1838494Sobrien * documentation and/or other materials provided with the distribution. 19310490Scy * 3. Neither the name of the University nor the names of its contributors 2038494Sobrien * may be used to endorse or promote products derived from this software 2138494Sobrien * without specific prior written permission. 2238494Sobrien * 2338494Sobrien * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 2438494Sobrien * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2538494Sobrien * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2638494Sobrien * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2738494Sobrien * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2838494Sobrien * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2938494Sobrien * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 3038494Sobrien * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 3138494Sobrien * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 3238494Sobrien * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3338494Sobrien * SUCH DAMAGE. 3438494Sobrien * 3538494Sobrien * 36174294Sobrien * File: am-utils/amd/ops_cachefs.c 3738494Sobrien * 3838494Sobrien */ 3938494Sobrien 4038494Sobrien/* 4138494Sobrien * Caching filesystem (Solaris 2.x) 4238494Sobrien */ 4338494Sobrien 4438494Sobrien#ifdef HAVE_CONFIG_H 4538494Sobrien# include <config.h> 4638494Sobrien#endif /* HAVE_CONFIG_H */ 4738494Sobrien#include <am_defs.h> 4838494Sobrien#include <amd.h> 4938494Sobrien 5038494Sobrien/* forward declarations */ 5138494Sobrienstatic char *cachefs_match(am_opts *fo); 5238494Sobrienstatic int cachefs_init(mntfs *mf); 53174294Sobrienstatic int cachefs_mount(am_node *am, mntfs *mf); 54174294Sobrienstatic int cachefs_umount(am_node *am, mntfs *mf); 5538494Sobrien 5638494Sobrien 5738494Sobrien/* 5838494Sobrien * Ops structure 5938494Sobrien */ 6038494Sobrienam_ops cachefs_ops = 6138494Sobrien{ 6238494Sobrien "cachefs", 6338494Sobrien cachefs_match, 6438494Sobrien cachefs_init, 65174294Sobrien cachefs_mount, 66174294Sobrien cachefs_umount, 67174294Sobrien amfs_error_lookup_child, 68174294Sobrien amfs_error_mount_child, 6938494Sobrien amfs_error_readdir, 7038494Sobrien 0, /* cachefs_readlink */ 71174294Sobrien 0, /* cachefs_mounted */ 72174294Sobrien 0, /* cachefs_umounted */ 73174294Sobrien amfs_generic_find_srvr, 74174294Sobrien 0, /* cachefs_get_wchan */ 75174294Sobrien FS_MKMNT | FS_NOTIMEOUT | FS_UBACKGROUND | FS_AMQINFO, /* nfs_fs_flags */ 76174294Sobrien#ifdef HAVE_FS_AUTOFS 77174294Sobrien AUTOFS_CACHEFS_FS_FLAGS, 78174294Sobrien#endif /* HAVE_FS_AUTOFS */ 7938494Sobrien}; 8038494Sobrien 8138494Sobrien 8238494Sobrien/* 8338494Sobrien * Check that f/s has all needed fields. 8438494Sobrien * Returns: matched string if found, NULL otherwise. 8538494Sobrien */ 8638494Sobrienstatic char * 8738494Sobriencachefs_match(am_opts *fo) 8838494Sobrien{ 8938494Sobrien /* sanity check */ 9038494Sobrien if (!fo->opt_rfs || !fo->opt_fs || !fo->opt_cachedir) { 9138494Sobrien plog(XLOG_USER, "cachefs: must specify cachedir, rfs, and fs"); 9238494Sobrien return NULL; 9338494Sobrien } 9438494Sobrien 9538494Sobrien dlog("CACHEFS: using cache directory \"%s\"", fo->opt_cachedir); 9638494Sobrien 9738494Sobrien /* determine magic cookie to put in mtab */ 98310490Scy return xstrdup(fo->opt_cachedir); 9938494Sobrien} 10038494Sobrien 10138494Sobrien 10238494Sobrien/* 10338494Sobrien * Initialize. 10438494Sobrien * Returns: 0 if OK, non-zero (errno) if failed. 10538494Sobrien */ 10638494Sobrienstatic int 10738494Sobriencachefs_init(mntfs *mf) 10838494Sobrien{ 10938494Sobrien /* 11038494Sobrien * Save cache directory name 11138494Sobrien */ 112174294Sobrien if (!mf->mf_private) { 113310490Scy mf->mf_private = (voidp) xstrdup(mf->mf_fo->opt_cachedir); 11438494Sobrien mf->mf_prfree = (void (*)(voidp)) free; 11538494Sobrien } 11638494Sobrien 11738494Sobrien return 0; 11838494Sobrien} 11938494Sobrien 12038494Sobrien 12138494Sobrien/* 12238494Sobrien * mntpt is the mount point ($fs) [XXX: was 'dir'] 12338494Sobrien * backdir is the mounted pathname ($rfs) [XXX: was 'fs_name'] 12438494Sobrien * cachedir is the cache directory ($cachedir) 12538494Sobrien */ 12638494Sobrienstatic int 127174294Sobrienmount_cachefs(char *mntdir, char *backdir, char *cachedir, 128174294Sobrien char *opts, int on_autofs) 12938494Sobrien{ 13038494Sobrien cachefs_args_t ca; 13138494Sobrien mntent_t mnt; 13238494Sobrien int flags; 13338494Sobrien char *cp; 13438494Sobrien MTYPE_TYPE type = MOUNT_TYPE_CACHEFS; /* F/S mount type */ 13538494Sobrien 13638494Sobrien memset((voidp) &ca, 0, sizeof(ca)); /* Paranoid */ 13738494Sobrien 13838494Sobrien /* 13938494Sobrien * Fill in the mount structure 14038494Sobrien */ 14138494Sobrien memset((voidp) &mnt, 0, sizeof(mnt)); 142174294Sobrien mnt.mnt_dir = mntdir; 14338494Sobrien mnt.mnt_fsname = backdir; 14438494Sobrien mnt.mnt_type = MNTTAB_TYPE_CACHEFS; 14538494Sobrien mnt.mnt_opts = opts; 14638494Sobrien 14738494Sobrien flags = compute_mount_flags(&mnt); 148174294Sobrien#ifdef HAVE_FS_AUTOFS 149174294Sobrien if (on_autofs) 150174294Sobrien flags |= autofs_compute_mount_flags(&mnt); 151174294Sobrien#endif /* HAVE_FS_AUTOFS */ 15238494Sobrien 15338494Sobrien /* Fill in cachefs mount arguments */ 15438494Sobrien 15538494Sobrien /* 15638494Sobrien * XXX: Caveats 15738494Sobrien * (1) cache directory is NOT checked for sanity beforehand, nor is it 15838494Sobrien * purged. Maybe it should be purged first? 15938494Sobrien * (2) cache directory is NOT locked. Should we? 16038494Sobrien */ 16138494Sobrien 16238494Sobrien /* mount flags */ 16338494Sobrien ca.cfs_options.opt_flags = CFS_WRITE_AROUND | CFS_ACCESS_BACKFS; 16438494Sobrien /* cache population size */ 16538494Sobrien ca.cfs_options.opt_popsize = DEF_POP_SIZE; /* default: 64K */ 16638494Sobrien /* filegrp size */ 16738494Sobrien ca.cfs_options.opt_fgsize = DEF_FILEGRP_SIZE; /* default: 256 */ 16838494Sobrien 16938494Sobrien /* CFS ID for file system (must be unique) */ 17038494Sobrien ca.cfs_fsid = cachedir; 17138494Sobrien 17238494Sobrien /* CFS fscdir name */ 17338494Sobrien memset(ca.cfs_cacheid, 0, sizeof(ca.cfs_cacheid)); 174174294Sobrien /* 175174294Sobrien * Append cacheid and mountpoint. 176174294Sobrien * sizeof(cfs_cacheid) should be C_MAX_MOUNT_FSCDIRNAME as per 177174294Sobrien * <sys/fs/cachefs_fs.h> (checked on Solaris 8). 178174294Sobrien */ 179174294Sobrien xsnprintf(ca.cfs_cacheid, sizeof(ca.cfs_cacheid), 180174294Sobrien "%s:%s", ca.cfs_fsid, mntdir); 18138494Sobrien /* convert '/' to '_' (Solaris does that...) */ 18238494Sobrien cp = ca.cfs_cacheid; 18338494Sobrien while ((cp = strpbrk(cp, "/")) != NULL) 18438494Sobrien *cp = '_'; 18538494Sobrien 18638494Sobrien /* path for this cache dir */ 18738494Sobrien ca.cfs_cachedir = cachedir; 18838494Sobrien 18938494Sobrien /* back filesystem dir */ 19038494Sobrien ca.cfs_backfs = backdir; 19138494Sobrien 19238494Sobrien /* same as nfs values (XXX: need to handle these options) */ 19338494Sobrien ca.cfs_acregmin = 0; 19438494Sobrien ca.cfs_acregmax = 0; 19538494Sobrien ca.cfs_acdirmin = 0; 19638494Sobrien ca.cfs_acdirmax = 0; 19738494Sobrien 19838494Sobrien /* 19938494Sobrien * Call generic mount routine 20038494Sobrien */ 201174294Sobrien return mount_fs(&mnt, flags, (caddr_t) &ca, 0, type, 0, NULL, mnttab_file_name, on_autofs); 20238494Sobrien} 20338494Sobrien 20438494Sobrien 20538494Sobrienstatic int 206174294Sobriencachefs_mount(am_node *am, mntfs *mf) 20738494Sobrien{ 208174294Sobrien int on_autofs = mf->mf_flags & MFF_ON_AUTOFS; 20938494Sobrien int error; 21038494Sobrien 21138494Sobrien error = mount_cachefs(mf->mf_mount, 21238494Sobrien mf->mf_fo->opt_rfs, 21338494Sobrien mf->mf_fo->opt_cachedir, 214174294Sobrien mf->mf_mopts, 215174294Sobrien on_autofs); 21638494Sobrien if (error) { 21738494Sobrien errno = error; 21838494Sobrien /* according to Solaris, if errno==ESRCH, "options to not match" */ 21938494Sobrien if (error == ESRCH) 22038494Sobrien plog(XLOG_ERROR, "mount_cachefs: options to no match: %m"); 22138494Sobrien else 22238494Sobrien plog(XLOG_ERROR, "mount_cachefs: %m"); 22338494Sobrien return error; 22438494Sobrien } 22538494Sobrien 22638494Sobrien return 0; 22738494Sobrien} 22838494Sobrien 22938494Sobrien 23038494Sobrienstatic int 231174294Sobriencachefs_umount(am_node *am, mntfs *mf) 23238494Sobrien{ 233174294Sobrien int unmount_flags = (mf->mf_flags & MFF_ON_AUTOFS) ? AMU_UMOUNT_AUTOFS : 0; 23438494Sobrien int error; 23538494Sobrien 236174294Sobrien error = UMOUNT_FS(mf->mf_mount, mnttab_file_name, unmount_flags); 23738494Sobrien 23838494Sobrien /* 23938494Sobrien * In the case of cachefs, we must fsck the cache directory. Otherwise, 24038494Sobrien * it will remain inconsistent, and the next cachefs mount will fail 24138494Sobrien * with the error "no space left on device" (ENOSPC). 24238494Sobrien * 24338494Sobrien * XXX: this is hacky! use fork/exec/wait instead... 24438494Sobrien */ 24538494Sobrien if (!error) { 24638494Sobrien char *cachedir = NULL; 24738494Sobrien char cmd[128]; 24838494Sobrien 24938494Sobrien cachedir = (char *) mf->mf_private; 25038494Sobrien plog(XLOG_INFO, "running fsck on cache directory \"%s\"", cachedir); 251174294Sobrien xsnprintf(cmd, sizeof(cmd), "fsck -F cachefs %s", cachedir); 25238494Sobrien system(cmd); 25338494Sobrien } 25438494Sobrien 25538494Sobrien return error; 25638494Sobrien} 257