NetBSD/share/man/man9/access.9

81 lines
2.9 KiB
Groff

.\" $NetBSD: access.9,v 1.1 1996/06/16 10:38:35 pk Exp $
.\"
.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Paul Kranenburg.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the NetBSD
.\" Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\" contributors may be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd Jun 16, 1996
.Dt ACCESS 9
.Os NetBSD
.Sh NAME
.Nm access
.Nd check memory regions for accessability
.Sh SYNOPSIS
.Ft int
.Fn kernacc "caddr_t addr" "int len" "int rw"
.Ft int
.Fn useracc "caddr_t addr" "int len" "int rw"
.Sh DESCRIPTION
The
.Fn kernacc
and
.Fn useracc
functions check whether operations of the type specified in
.Fa rw
are permitted in the range of virtual addresses given by
.Fa addr
and
.Fa len .
The possible values of
.Fa rw
are
.Dv B_READ
and
.Dv B_WRITE .
.Fn kernacc
checks addresses in the kernel address space, while
.Fn useracc
considers
.Fa addr
to represent an user space address. The process context to use for this
operation is taken from the global variable
.Va curproc .
.Pp
.Sh RETURN VALUES
Both functions return 1 if the type of access specified by
.Fa rw
is permitted. Otherwise 0 is returned.
.Pp
.Sh BUGS
The process pointer should be passed in as an argument.