NetBSD/share/man/man9/access.9

.\"	$NetBSD: access.9,v 1.6 1999/03/06 22:09:29 mycroft 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 FOUNDATION 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 June 16, 1996
.Dt ACCESS 9
.Os NetBSD
.Sh NAME
.Nm access ,
.Nm kernacc ,
.Nm useracc
.Nd check memory regions for accessability
.Sh SYNOPSIS
.Ft int
.Fn kernacc "caddr_t addr" "size_t len" "int rw"
.Ft int
.Fn useracc "caddr_t addr" "size_t 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.
Fix formatting errors (bad sentence breaks). 1999-03-07 01:09:29 +03:00			`.\" $NetBSD: access.9,v 1.6 1999/03/06 22:09:29 mycroft Exp $`
kernacc() & useracc() manual pages. 1996-06-16 14:38:35 +04:00			`.\"`
			`.\" 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`
Fix tipo inherited from old version of TNF copyright form. s/REGENTS/FOUNDATION/. 1997-10-09 01:59:52 +04:00			`.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS`
			`.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR`
kernacc() & useracc() manual pages. 1996-06-16 14:38:35 +04:00			`.\" 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.`
			`.\"`
Add David Brownlee's new intro pages, with editing. (PR #534[23]) Also, while here, expand apparently incorrectly .Dd month abbreviations. (I thought about doing this in tmac/doc-common...heh...that would have allowed a possible reverse map back to abbreviations.) 1998-04-22 11:14:30 +04:00			`.Dd June 16, 1996`
kernacc() & useracc() manual pages. 1996-06-16 14:38:35 +04:00			`.Dt ACCESS 9`
			`.Os NetBSD`
			`.Sh NAME`
add missing .Nm sections 1997-11-11 13:06:37 +03:00			`.Nm access ,`
			`.Nm kernacc ,`
			`.Nm useracc`
kernacc() & useracc() manual pages. 1996-06-16 14:38:35 +04:00			`.Nd check memory regions for accessability`
			`.Sh SYNOPSIS`
			`.Ft int`
Use size_t to pass the length of the memory region to operate on to chgkprot(), kernacc(), useracc(), vslock() and vsunlock(); (unsigned) ints are not adequate on all platforms. 1998-05-09 19:04:39 +04:00			`.Fn kernacc "caddr_t addr" "size_t len" "int rw"`
kernacc() & useracc() manual pages. 1996-06-16 14:38:35 +04:00			`.Ft int`
Use size_t to pass the length of the memory region to operate on to chgkprot(), kernacc(), useracc(), vslock() and vsunlock(); (unsigned) ints are not adequate on all platforms. 1998-05-09 19:04:39 +04:00			`.Fn useracc "caddr_t addr" "size_t len" "int rw"`
kernacc() & useracc() manual pages. 1996-06-16 14:38:35 +04:00			`.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`
Fix formatting errors (bad sentence breaks). 1999-03-07 01:09:29 +03:00			`to represent an user space address.`
			`The process context to use for this operation is taken from the global variable`
kernacc() & useracc() manual pages. 1996-06-16 14:38:35 +04:00			`.Va curproc .`
			`.Pp`
			`.Sh RETURN VALUES`
			`Both functions return 1 if the type of access specified by`
			`.Fa rw`
Fix formatting errors (bad sentence breaks). 1999-03-07 01:09:29 +03:00			`is permitted.`
			`Otherwise 0 is returned.`
kernacc() & useracc() manual pages. 1996-06-16 14:38:35 +04:00			`.Pp`
			`.Sh BUGS`
			`The process pointer should be passed in as an argument.`