1.\" $NetBSD: vslock.9,v 1.1 1996/06/15 20:47:29 pk Exp $
2.\"
3.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Paul Kranenburg.
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.\" 3. All advertising materials mentioning features or use of this software
18.\" must display the following acknowledgement:
19.\" This product includes software developed by the NetBSD
20.\" Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\" contributors may be used to endorse or promote products derived
23.\" from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
29.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.\" $Id$
38.\"
39.Dd Jun 15, 1996
40.Dt VSLOCK 9
41.Os FreeBSD
42.Sh NAME
43.Nm vslock ,
44.Nm vsunlock
45.Nd lock/unlock user space addresses in memory
46.Sh SYNOPSIS
47.Fd #include <sys/types.h>
48.Fd #include <vm/vm.h>
49.Fd #include <vm/vm_extern.h>
50.Ft void
51.Fn vslock "caddr_t addr" "u_int len"
52.Ft void
53.Fn vsunlock "caddr_t addr" "u_int len" "int dirtied"
54.Sh DESCRIPTION
55The
56.Fn vslock
57and
58.Fn vsunlock
59functions respectively lock and unlock a range of
60addresses belonging to the currently running process into memory.
61The actual amount of memory locked is a multiple of the machine's page size.
62The starting page number is computed by truncating
63.Fa addr
64to the nearest preceding page boundary, and by rounding up
65.Fa addr +
66.Fa len
67to the next page boundary.
68The process context to use for this operation is taken from the
69global variable
70.Va curproc .
71.Pp
72.\" .Sh SEE ALSO
73.\" .Xr physio 9
74.Sh BUGS
75The process pointer should be passed in as an argument.
2.\"
3.\" Copyright (c) 1996 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Paul Kranenburg.
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.\" 3. All advertising materials mentioning features or use of this software
18.\" must display the following acknowledgement:
19.\" This product includes software developed by the NetBSD
20.\" Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\" contributors may be used to endorse or promote products derived
23.\" from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
29.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.\" $Id$
38.\"
39.Dd Jun 15, 1996
40.Dt VSLOCK 9
41.Os FreeBSD
42.Sh NAME
43.Nm vslock ,
44.Nm vsunlock
45.Nd lock/unlock user space addresses in memory
46.Sh SYNOPSIS
47.Fd #include <sys/types.h>
48.Fd #include <vm/vm.h>
49.Fd #include <vm/vm_extern.h>
50.Ft void
51.Fn vslock "caddr_t addr" "u_int len"
52.Ft void
53.Fn vsunlock "caddr_t addr" "u_int len" "int dirtied"
54.Sh DESCRIPTION
55The
56.Fn vslock
57and
58.Fn vsunlock
59functions respectively lock and unlock a range of
60addresses belonging to the currently running process into memory.
61The actual amount of memory locked is a multiple of the machine's page size.
62The starting page number is computed by truncating
63.Fa addr
64to the nearest preceding page boundary, and by rounding up
65.Fa addr +
66.Fa len
67to the next page boundary.
68The process context to use for this operation is taken from the
69global variable
70.Va curproc .
71.Pp
72.\" .Sh SEE ALSO
73.\" .Xr physio 9
74.Sh BUGS
75The process pointer should be passed in as an argument.