xref: /xnu-11215.61.5/bsd/vfs/vfs_support.c (revision 4f1223e81cd707a65cc109d0b8ad6653699da3c4)

/*
 * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1998-1999 Apple Computer, Inc.  All rights reserved.
 *
 *  File:  vfs/vfs_support.c
 *
 *	The default VFS routines. A VFS plugin can use these
 *	functions in case it does not want to implement all. These functions
 *	take care of releasing locks and free up memory that they are
 *	supposed to.
 *
 *	nop_* routines always return 0 [success]
 *	err_* routines always return ENOTSUP
 *
 *	This file could be auto-generated from vnode_if.src. but that needs
 *	support for freeing cnp.
 *
 * HISTORY
 *  15-Jul-1998 Earsh Nandkeshwar ([email protected])
 *      Fixed up readdirattr for its existance now.
 *  18-Aug-1998 Umesh Vaishampayan ([email protected])
 *      Created.
 */

#include <vfs/vfs_support.h>
#include <sys/kauth.h>
#include <sys/ubc.h>    /* ubc_upl_abort_range() */


struct vnop_create_args /* {
                         *  struct vnode *a_dvp;
                         *  struct vnode **a_vpp;
                         *  struct componentname *a_cnp;
                         *  struct vnode_vattr *a_vap;
                         *  vfs_context_t a_context;
                         *  } */;

int
nop_create(__unused struct vnop_create_args *ap)
{
#if DIAGNOSTIC
	if ((ap->a_cnp->cn_flags & HASBUF) == 0) {
		panic("nop_create: no name");
	}
#endif
	return 0;
}

int
err_create(struct vnop_create_args *ap)
{
	(void)nop_create(ap);
	return ENOTSUP;
}


struct vnop_whiteout_args /* {
                           *  struct vnode *a_dvp;
                           *  struct componentname *a_cnp;
                           *  int a_flags;
                           *  vfs_context_t a_context;
                           *  } */;

int
nop_whiteout(__unused struct vnop_whiteout_args *ap)
{
	return 0;
}

int
err_whiteout(__unused struct vnop_whiteout_args *ap)
{
	return ENOTSUP;
}


struct vnop_mknod_args /* {
                        *  struct vnode *a_dvp;
                        *  struct vnode **a_vpp;
                        *  struct componentname *a_cnp;
                        *  struct vnode_vattr *a_vap;
                        *  vfs_context_t a_context;
                        *  } */;

int
nop_mknod(__unused struct vnop_mknod_args *ap)
{
#if DIAGNOSTIC
	if ((ap->a_cnp->cn_flags & HASBUF) == 0) {
		panic("nop_mknod: no name");
	}
#endif
	return 0;
}

int
err_mknod(struct vnop_mknod_args *ap)
{
	(void)nop_mknod(ap);
	return ENOTSUP;
}

struct vnop_open_args /* {
                       *  struct vnode *a_vp;
                       *  int  a_mode;
                       *  vfs_context_t a_context;
                       *  } */;

int
nop_open(__unused struct vnop_open_args *ap)
{
	return 0;
}

int
err_open(__unused struct vnop_open_args *ap)
{
	return ENOTSUP;
}


struct vnop_close_args /* {
                        *  struct vnode *a_vp;
                        *  int  a_fflag;
                        *  vfs_context_t a_context;
                        *  } */;

int
nop_close(__unused struct vnop_close_args *ap)
{
	return 0;
}

int
err_close(__unused struct vnop_close_args *ap)
{
	return ENOTSUP;
}


struct vnop_access_args /* {
                         *  struct vnode *a_vp;
                         *  int  a_mode;
                         *  vfs_context_t a_context;
                         *  } */;

int
nop_access(__unused struct vnop_access_args *ap)
{
	return 0;
}

int
err_access(__unused struct vnop_access_args *ap)
{
	return ENOTSUP;
}


struct vnop_getattr_args /* {
                          *  struct vnode *a_vp;
                          *  struct vnode_vattr *a_vap;
                          *  vfs_context_t a_context;
                          *  } */;

int
nop_getattr(__unused struct vnop_getattr_args *ap)
{
	return 0;
}

int
err_getattr(__unused struct vnop_getattr_args *ap)
{
	return ENOTSUP;
}


struct vnop_setattr_args /* {
                          *  struct vnode *a_vp;
                          *  struct vnode_vattr *a_vap;
                          *  vfs_context_t a_context;
                          *  } */;

int
nop_setattr(__unused struct vnop_setattr_args *ap)
{
	return 0;
}

int
err_setattr(__unused struct vnop_setattr_args *ap)
{
	return ENOTSUP;
}

struct vnop_read_args /*  {
                       *  struct vnode *a_vp;
                       *  struct uio *a_uio;
                       *  int a_ioflag;
                       *  vfs_context_t a_context;
                       *  } */;

int
nop_read(__unused struct vnop_read_args *ap)
{
	return 0;
}

int
err_read(__unused struct vnop_read_args *ap)
{
	return ENOTSUP;
}


struct vnop_write_args /*  {
                        *  struct vnode *a_vp;
                        *  struct uio *a_uio;
                        *  int a_ioflag;
                        *  vfs_context_t a_context;
                        *  } */;

int
nop_write(__unused struct vnop_write_args *ap)
{
	return 0;
}

int
err_write(__unused struct vnop_write_args *ap)
{
	return ENOTSUP;
}


struct vnop_ioctl_args /* {
                        *  struct vnode *a_vp;
                        *  u_long a_command;
                        *  caddr_t a_data;
                        *  int a_fflag;
                        *  kauth_cred_t a_cred;
                        *  struct proc *a_p;
                        *  } */;

int
nop_ioctl(__unused struct vnop_ioctl_args *ap)
{
	return 0;
}

int
err_ioctl(__unused struct vnop_ioctl_args *ap)
{
	return ENOTSUP;
}


struct vnop_select_args /* {
                         *  struct vnode *a_vp;
                         *  int a_which;
                         *  int a_fflags;
                         *  kauth_cred_t a_cred;
                         *  void *a_wql;
                         *  struct proc *a_p;
                         *  } */;

int
nop_select(__unused struct vnop_select_args *ap)
{
	return 0;
}

int
err_select(__unused struct vnop_select_args *ap)
{
	return ENOTSUP;
}


struct vnop_exchange_args /* {
                           *  struct vnode *a_fvp;
                           *  struct vnode *a_tvp;
                           *  int a_options;
                           *  vfs_context_t a_context;
                           *  } */;

int
nop_exchange(__unused struct vnop_exchange_args *ap)
{
	return 0;
}

int
err_exchange(__unused struct vnop_exchange_args *ap)
{
	return ENOTSUP;
}


struct vnop_revoke_args /* {
                         *  struct vnode *a_vp;
                         *  int a_flags;
                         *  vfs_context_t a_context;
                         *  } */;

int
nop_revoke(struct vnop_revoke_args *ap)
{
	return vn_revoke(ap->a_vp, ap->a_flags, ap->a_context);
}

int
err_revoke(struct vnop_revoke_args *ap)
{
	(void)nop_revoke(ap);
	return ENOTSUP;
}


struct vnop_mmap_args /* {
                       *  struct vnode *a_vp;
                       *  int a_fflags;
                       *  kauth_cred_t a_cred;
                       *  struct proc *a_p;
                       *  } */;

int
nop_mmap(__unused struct vnop_mmap_args *ap)
{
	return 0;
}

int
err_mmap(__unused struct vnop_mmap_args *ap)
{
	return ENOTSUP;
}


struct vnop_fsync_args /* {
                        *  struct vnode *a_vp;
                        *  int a_waitfor;
                        *  vfs_context_t a_context;
                        *  } */;

int
nop_fsync(__unused struct vnop_fsync_args *ap)
{
	return 0;
}

int
err_fsync(__unused struct vnop_fsync_args *ap)
{
	return ENOTSUP;
}


struct vnop_remove_args /* {
                         *  struct vnode *a_dvp;
                         *  struct vnode *a_vp;
                         *  struct componentname *a_cnp;
                         *  int a_flags;
                         *  vfs_context_t a_context;
                         *  } */;

int
nop_remove(__unused struct vnop_remove_args *ap)
{
	return 0;
}

int
err_remove(struct vnop_remove_args *ap)
{
	(void)nop_remove(ap);
	return ENOTSUP;
}


struct vnop_link_args /* {
                       *  struct vnode *a_vp;
                       *  struct vnode *a_tdvp;
                       *  struct componentname *a_cnp;
                       *  vfs_context_t a_context;
                       *  } */;

int
nop_link(__unused struct vnop_link_args *ap)
{
	return 0;
}

int
err_link(struct vnop_link_args *ap)
{
	(void)nop_link(ap);
	return ENOTSUP;
}


struct vnop_rename_args /* {
                         *  struct vnode *a_fdvp;
                         *  struct vnode *a_fvp;
                         *  struct componentname *a_fcnp;
                         *  struct vnode *a_tdvp;
                         *  struct vnode *a_tvp;
                         *  struct componentname *a_tcnp;
                         *  vfs_context_t a_context;
                         *  } */;

int
nop_rename(__unused struct vnop_rename_args *ap)
{
	return 0;
}

int
err_rename(struct vnop_rename_args *ap)
{
	(void)nop_rename(ap);
	return ENOTSUP;
}


struct vnop_mkdir_args /* {
                        *  struct vnode *a_dvp;
                        *  struct vnode **a_vpp;
                        *  struct componentname *a_cnp;
                        *  struct vnode_vattr *a_vap;
                        *  vfs_context_t a_context;
                        *  } */;

int
nop_mkdir(__unused struct vnop_mkdir_args *ap)
{
	return 0;
}

int
err_mkdir(__unused struct vnop_mkdir_args *ap)
{
	return ENOTSUP;
}


struct vnop_rmdir_args /* {
                        *  struct vnode *a_dvp;
                        *  struct vnode *a_vp;
                        *  struct componentname *a_cnp;
                        *  vfs_context_t a_context;
                        *  } */;

int
nop_rmdir(__unused struct vnop_rmdir_args *ap)
{
	return 0;
}

int
err_rmdir(struct vnop_rmdir_args *ap)
{
	(void)nop_rmdir(ap);
	return ENOTSUP;
}


struct vnop_symlink_args /* {
                          *  struct vnode *a_dvp;
                          *  struct vnode **a_vpp;
                          *  struct componentname *a_cnp;
                          *  struct vnode_vattr *a_vap;
                          *  char *a_target;
                          *  vfs_context_t a_context;
                          *  } */;

int
nop_symlink(__unused struct vnop_symlink_args *ap)
{
#if DIAGNOSTIC
	if ((ap->a_cnp->cn_flags & HASBUF) == 0) {
		panic("nop_symlink: no name");
	}
#endif
	return 0;
}

int
err_symlink(struct vnop_symlink_args *ap)
{
	(void)nop_symlink(ap);
	return ENOTSUP;
}


struct vnop_readdir_args /* {
                          *  vnode_t a_vp;
                          *  struct uio *a_uio;
                          *  int a_flags;
                          *  int *a_eofflag;
                          *  int *a_numdirent;
                          *  vfs_context_t a_context;
                          *  } */;

int
nop_readdir(__unused struct vnop_readdir_args *ap)
{
	return 0;
}

int
err_readdir(__unused struct vnop_readdir_args *ap)
{
	return ENOTSUP;
}


struct vnop_readdirattr_args /* {
                              *  struct vnodeop_desc *a_desc;
                              *  vnode_t a_vp;
                              *  struct attrlist *a_alist;
                              *  struct uio *a_uio;
                              *  u_long a_maxcount;
                              *  u_long a_options;
                              *  u_long *a_newstate;
                              *  int *a_eofflag;
                              *  u_long *a_actualcount;
                              *  vfs_context_t a_context;
                              *  } */;

int
nop_readdirattr(struct vnop_readdirattr_args *ap)
{
	*(ap->a_actualcount) = 0;
	*(ap->a_eofflag) = 0;
	return 0;
}

int
err_readdirattr(struct vnop_readdirattr_args *ap)
{
	(void)nop_readdirattr(ap);
	return ENOTSUP;
}


struct vnop_readlink_args /* {
                           *  struct vnode *vp;
                           *  struct uio *uio;
                           *  vfs_context_t a_context;
                           *  } */;

int
nop_readlink(__unused struct vnop_readlink_args *ap)
{
	return 0;
}

int
err_readlink(__unused struct vnop_readlink_args *ap)
{
	return ENOTSUP;
}


struct vnop_inactive_args /* {
                           *  struct vnode *a_vp;
                           *  vfs_context_t a_context;
                           *  } */;

int
nop_inactive(__unused struct vnop_inactive_args *ap)
{
	return 0;
}

int
err_inactive(struct vnop_inactive_args *ap)
{
	(void)nop_inactive(ap);
	return ENOTSUP;
}


struct vnop_reclaim_args /* {
                          *  struct vnode *a_vp;
                          *  vfs_context_t a_context;
                          *  } */;

int
nop_reclaim(__unused struct vnop_reclaim_args *ap)
{
	return 0;
}

int
err_reclaim(__unused struct vnop_reclaim_args *ap)
{
	return ENOTSUP;
}


struct vnop_strategy_args /* {
                           *  struct buf *a_bp;
                           *  } */;

int
nop_strategy(__unused struct vnop_strategy_args *ap)
{
	return 0;
}

int
err_strategy(__unused struct vnop_strategy_args *ap)
{
	return ENOTSUP;
}


struct vnop_pathconf_args /* {
                           *  struct vnode *a_vp;
                           *  int a_name;
                           *  int32_t *a_retval;
                           *  vfs_context_t a_context;
                           *  } */;

int
nop_pathconf(__unused struct vnop_pathconf_args *ap)
{
	return 0;
}

int
err_pathconf(__unused struct vnop_pathconf_args *ap)
{
	return ENOTSUP;
}


struct vnop_advlock_args /* {
                          *  struct vnode *a_vp;
                          *  caddr_t a_id;
                          *  int a_op;
                          *  struct flock *a_fl;
                          *  int a_flags;
                          *  vfs_context_t a_context;
                          *  } */;

int
nop_advlock(__unused struct vnop_advlock_args *ap)
{
	return 0;
}

int
err_advlock(__unused struct vnop_advlock_args *ap)
{
	return ENOTSUP;
}



struct vnop_allocate_args /* {
                           *  struct vnode *a_vp;
                           *  off_t a_length;
                           *  u_int32_t a_flags;
                           *  off_t *a_bytesallocated;
                           *  off_t a_offset;
                           *  vfs_context_t a_context;
                           *  } */;

int
nop_allocate(struct vnop_allocate_args *ap)
{
	*(ap->a_bytesallocated) = 0;
	return 0;
}

int
err_allocate(struct vnop_allocate_args *ap)
{
	(void)nop_allocate(ap);
	return ENOTSUP;
}

struct vnop_bwrite_args /* {
                         *  struct buf *a_bp;
                         *  } */;

int
nop_bwrite(struct vnop_bwrite_args *ap)
{
	return (int)buf_bwrite(ap->a_bp);
}

int
err_bwrite(__unused struct vnop_bwrite_args *ap)
{
	return ENOTSUP;
}


struct vnop_pagein_args /* {
                         *  struct vnode        *a_vp,
                         *  upl_t		a_pl,
                         *  vm_offset_t	a_pl_offset,
                         *  off_t		a_foffset,
                         *  size_t		a_size,
                         *  int		a_flags
                         *  vfs_context_t a_context;
                         *  } */;

int
nop_pagein(struct vnop_pagein_args *ap)
{
	if (!(ap->a_flags & UPL_NOCOMMIT)) {
		assert(ap->a_size <= UINT32_MAX);
		ubc_upl_abort_range(ap->a_pl, ap->a_pl_offset, (upl_size_t)ap->a_size, UPL_ABORT_FREE_ON_EMPTY | UPL_ABORT_ERROR);
	}
	return EINVAL;
}

int
err_pagein(struct vnop_pagein_args *ap)
{
	if (!(ap->a_flags & UPL_NOCOMMIT)) {
		assert(ap->a_size <= UINT32_MAX);
		ubc_upl_abort_range(ap->a_pl, ap->a_pl_offset, (upl_size_t)ap->a_size, UPL_ABORT_FREE_ON_EMPTY | UPL_ABORT_ERROR);
	}
	return ENOTSUP;
}


struct vnop_pageout_args /* {
                          *  struct vnode       *a_vp,
                          *  upl_t		a_pl,
                          *  vm_offset_t	a_pl_offset,
                          *  off_t		a_foffset,
                          *  size_t		a_size,
                          *  int		a_flags
                          *  vfs_context_t a_context;
                          *  } */;

int
nop_pageout(struct vnop_pageout_args *ap)
{
	if (!(ap->a_flags & UPL_NOCOMMIT)) {
		assert(ap->a_size <= UINT32_MAX);
		ubc_upl_abort_range(ap->a_pl, ap->a_pl_offset, (upl_size_t)ap->a_size, UPL_ABORT_FREE_ON_EMPTY | UPL_ABORT_ERROR);
	}
	return EINVAL;
}

int
err_pageout(struct vnop_pageout_args *ap)
{
	if (!(ap->a_flags & UPL_NOCOMMIT)) {
		assert(ap->a_size <= UINT32_MAX);
		ubc_upl_abort_range(ap->a_pl, ap->a_pl_offset, (upl_size_t)ap->a_size, UPL_ABORT_FREE_ON_EMPTY | UPL_ABORT_ERROR);
	}
	return ENOTSUP;
}


struct vnop_searchfs /* {
                      *  struct vnode *a_vp;
                      *  void *a_searchparams1;
                      *  void *a_searchparams2;
                      *  struct attrlist *a_searchattrs;
                      *  u_long a_maxmatches;
                      *  struct timeval *a_timelimit;
                      *  struct attrlist *a_returnattrs;
                      *  u_long *a_nummatches;
                      *  u_long a_scriptcode;
                      *  u_long a_options;
                      *  struct uio	*a_uio;
                      *  struct searchstate	*a_searchstate;
                      *  vfs_context_t a_context;
                      *  } */;

int
nop_searchfs(struct vnop_searchfs_args *ap)
{
	*(ap->a_nummatches) = 0;
	return 0;
}

int
err_searchfs(struct vnop_searchfs_args *ap)
{
	(void)nop_searchfs(ap);
	return ENOTSUP;
}

struct vnop_copyfile_args /*{
                           *  struct vnodeop_desc *a_desc;
                           *  struct vnode *a_fvp;
                           *  struct vnode *a_tdvp;
                           *  struct vnode *a_tvp;
                           *  struct componentname *a_tcnp;
                           *  int a_flags;
                           *  }*/;

int
nop_copyfile(__unused struct vnop_copyfile_args *ap)
{
	return 0;
}


int
err_copyfile(struct vnop_copyfile_args *ap)
{
	(void)nop_copyfile(ap);
	return ENOTSUP;
}


struct vnop_blktooff_args /* {
                           *  struct vnode *a_vp;
                           *  daddr64_t a_lblkno;
                           *  off_t *a_offset;
                           *  } */;

int
nop_blktooff(struct vnop_blktooff_args *ap)
{
	*ap->a_offset = (off_t)-1;      /* failure */
	return 0;
}

int
err_blktooff(struct vnop_blktooff_args *ap)
{
	(void)nop_blktooff(ap);
	return ENOTSUP;
}

struct vnop_offtoblk_args /* {
                           *  struct vnode *a_vp;
                           *  off_t a_offset;
                           *  daddr64_t *a_lblkno;
                           *  } */;

int
nop_offtoblk(struct vnop_offtoblk_args *ap)
{
	*ap->a_lblkno = (daddr64_t)-1;  /* failure */
	return 0;
}

int
err_offtoblk(struct vnop_offtoblk_args *ap)
{
	(void)nop_offtoblk(ap);
	return ENOTSUP;
}

struct vnop_blockmap_args /* {
                           *  struct vnode *a_vp;
                           *  off_t a_foffset;
                           *  size_t a_size;
                           *  daddr64_t *a_bpn;
                           *  size_t *a_run;
                           *  void *a_poff;
                           *  int a_flags;
                           *  } */;

int
nop_blockmap(__unused struct vnop_blockmap_args *ap)
{
	return 0;
}

int
err_blockmap(__unused struct vnop_blockmap_args *ap)
{
	return ENOTSUP;
}