share/man/man9/VOP_MMAP.9

   1 .\" Copyright (c) 1996 Doug Rabson
   2 .\"
   3 .\" All rights reserved.
   4 .\"
   5 .\" This program is free software.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man9/VOP_MMAP.9,v 1.4 1999/08/28 00:21:14 peter Exp $
  28 .\" $DragonFly: src/share/man/man9/VOP_MMAP.9,v 1.4 2006/05/26 19:39:40 swildner Exp $
  29 .\"
  30 .Dd July 24, 1996
  31 .Os
  32 .Dt VOP_MMAP 9
  33 .Sh NAME
  34 .Nm VOP_MMAP
  35 .Nd map a file into memory
  36 .Sh SYNOPSIS
  37 .In sys/param.h
  38 .In sys/vnode.h
  39 .Ft int
  40 .Fn VOP_MMAP "struct vnode *vp" "int fflags" "struct ucred *cred" "struct proc *p"
  41 .Sh DESCRIPTION
  42 Map the contents of a file into memory using the VM system.
  43 .Pp
  44 Its arguments are:
  45 .Bl -tag -width fflags
  46 .It Ar vp
  47 the vnode of the file
  48 .It Ar fflags
  49 some flags ???
  50 .It Ar cred
  51 the caller's credentials
  52 .It Ar p
  53 the calling process
  54 .El
  55 .Pp
  56 Most filesystems do not implement this entry point.
  57 .Sh PSEUDOCODE
  58 .Bd -literal
  59 int
  60 vop_mmap(struct vnode *vp, int fflags,
  61            struct ucred *cred, struct proc *p)
  62 {
  63     return EINVAL;
  64 }
  65 .Ed
  66 .Sh SEE ALSO
  67 .Xr vnode 9
  68 .Sh AUTHORS
  69 This man page was written by
  70 .An Doug Rabson .