share/man/man9/VOP_MMAP.9

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