summaryrefslogtreecommitdiff
path: root/share/man
diff options
context:
space:
mode:
authorWilbern Cobb <wcobb@cvs.openbsd.org>2003-01-11 06:21:08 +0000
committerWilbern Cobb <wcobb@cvs.openbsd.org>2003-01-11 06:21:08 +0000
commit41889bd5848567a57bf5122526946bb9083fba20 (patch)
tree5f960f5277c00e23b4fb8110b5bccf0369b6bcf1 /share/man
parentfd233e2a22f71ac3f64651db3b6b5e98f1b42191 (diff)
Remove the vm_* manpages, these functions were replaced in uvm.
ok art@
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man9/Makefile9
-rw-r--r--share/man/man9/vm_allocate.9119
-rw-r--r--share/man/man9/vm_deallocate.996
-rw-r--r--share/man/man9/vm_map_copy.9102
-rw-r--r--share/man/man9/vm_map_inherit.9111
-rw-r--r--share/man/man9/vm_map_protect.9103
6 files changed, 2 insertions, 538 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 588fd4421ae..7858d1c45a9 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -1,4 +1,4 @@
-# $OpenBSD: Makefile,v 1.61 2003/01/10 03:23:01 kjc Exp $
+# $OpenBSD: Makefile,v 1.62 2003/01/11 06:21:07 wcobb Exp $
# $NetBSD: Makefile,v 1.4 1996/01/09 03:23:01 thorpej Exp $
# Makefile for section 9 (kernel function and variable) manual pages.
@@ -18,9 +18,7 @@ MAN= altq.9 audio.9 autoconf.9 boot.9 bus_dma.9 bus_space.9 copy.9 \
time.9 timeout.9 tvtohz.9 uiomove.9 uvm.9 \
vaccess.9 vclean.9 vcount.9 vdevgone.9 vfinddev.9 vflush.9 vget.9 \
vgone.9 vhold.9 vinvalbuf.9 vput.9 vref.9 vrele.9 \
- vm_allocate.9 vm_map_copy.9 vm_deallocate.9 \
- vm_map_inherit.9 vm_map_protect.9 vnode.9 vn_lock.9 \
- vwaitforio.9 vwaitforio.9
+ vnode.9 vn_lock.9 vwaitforio.9 vwaitforio.9
MLINKS+=autoconf.9 config_init.9 autoconf.9 config_search.9 \
autoconf.9 config_rootsearch.9 autoconf.9 config_found_sm.9 \
@@ -154,9 +152,6 @@ MLINKS+=timeout.9 timeout_add.9 timeout.9 timeout_set.9 \
timeout.9 timeout_initialized.9 timeout.9 untimeout.9 \
timeout.9 timeout_triggered.9
MLINKS+=uiomove.9 uio.9
-MLINKS+=vm_map_copy.9 vm_copy.9
-MLINKS+=vm_map_inherit.9 vm_inherit.9
-MLINKS+=vm_map_protect.9 vm_protect.9
MLINKS+=malloc.9 MALLOC.9 malloc.9 free.9 malloc.9 FREE.9
MLINKS+=kern.9 imax.9 kern.9 imin.9 kern.9 lmax.9 kern.9 lmin.9 \
kern.9 max.9 kern.9 min.9 kern.9 ulmax.9 kern.9 ulmin.9 kern.9 abs.9 \
diff --git a/share/man/man9/vm_allocate.9 b/share/man/man9/vm_allocate.9
deleted file mode 100644
index 7c684f1e656..00000000000
--- a/share/man/man9/vm_allocate.9
+++ /dev/null
@@ -1,119 +0,0 @@
-.\"
-.\" $OpenBSD: vm_allocate.9,v 1.3 2001/11/06 21:54:41 miod Exp $
-.\"
-.\" Mach Operating System
-.\" Copyright (c) 1991,1990 Carnegie Mellon University
-.\" All Rights Reserved.
-.\"
-.\" Permission to use, copy, modify and distribute this software and its
-.\" documentation is hereby granted, provided that both the copyright
-.\" notice and this permission notice appear in all copies of the
-.\" software, derivative works or modified versions, and any portions
-.\" thereof, and that both notices appear in supporting documentation.
-.\"
-.\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
-.\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
-.\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
-.\"
-.\" Carnegie Mellon requests users of this software to return to
-.\"
-.\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
-.\" School of Computer Science
-.\" Carnegie Mellon University
-.\" Pittsburgh PA 15213-3890
-.\"
-.\" any improvements or extensions that they make and grant Carnegie Mellon
-.\" the rights to redistribute these changes.
-.\"
-.TH vm_allocate 9 9/19/93
-.CM 4
-.SH NAME
-.nf
-vm_allocate \- allocates virtual memory for a task
-.SH SYNOPSIS
-.nf
-.ft B
-#include <uvm/uvm_extern.h>
-
-.nf
-.ft B
-int vm_allocate(map, address, size, anywhere)
- vm_map_t map;
- vm_address_t *address; /* in/out */
- vm_size_t size;
- boolean_t anywhere;
-
-
-.fi
-.ft P
-.SH ARGUMENTS
-.TP 15
-.B
-map
-Virtual address space to be affected.
-.TP 15
-.B
-address
-Starting address. If the
-.B anywhere
-option is false,
-an attempt is made to allocate virtual memory starting at
-this virtual address. If this address is not at the beginning
-of a virtual page, it will be rounded down to one.
-If there is not enough space at this address, no memory will be allocated.
-If the anywhere option is true, the input value of this address will
-be ignored, and the space will be allocated wherever it is available.
-In either case, the address at which memory was actually allocated will
-be returned in
-.B address
-.
-.TP 15
-.B
-size
-Number of bytes to allocate (rounded by the system in a
-machine dependent way to an integral number of virtual pages).
-.TP 15
-.B
-anywhere
-If true, the kernel should find and allocate any region of
-the specified size, and return the address of the resulting region in
-.B address
-. If false, virtual memory will be allocated starting at
-.B address
-, rounded to a virtual page boundary if there
-is sufficient space.
-
-.SH DESCRIPTION
-.B vm_allocate
-allocates a region of virtual memory, placing it in the
-specified task's address space. The physical memory is not actually
-allocated until the new virtual memory is referenced. By default,
-the kernel rounds all addresses down
-to the nearest page boundary and all memory sizes up to the nearest page
-size. The global variable
-.B cnt.vm_page_size
-contains the page size.
-Initially, the pages of allocated memory will be protected
-to allow all forms of access, and will be inherited in child tasks as
-a copy. Subsequent calls to
-.B vm_map_protect
-and
-.B vm_map_inherit
-may
-be used to change these properties. The allocated region is always
-zero-filled.
-
-.SH DIAGNOSTICS
-.TP 25
-KERN_SUCCESS
-Memory allocated.
-.TP 25
-KERN_INVALID_ADDRESS
-Illegal address specified.
-.TP 25
-KERN_NO_SPACE
-Not enough space left to satisfy this request
-
-.SH SEE ALSO
-.B vm_deallocate, vm_map_inherit, vm_map_protect
-
diff --git a/share/man/man9/vm_deallocate.9 b/share/man/man9/vm_deallocate.9
deleted file mode 100644
index 702f32f747c..00000000000
--- a/share/man/man9/vm_deallocate.9
+++ /dev/null
@@ -1,96 +0,0 @@
-.\" $OpenBSD: vm_deallocate.9,v 1.5 2001/11/06 21:54:41 miod Exp $
-.\"
-.\" Mach Operating System
-.\" Copyright (c) 1991,1990 Carnegie Mellon University
-.\" All Rights Reserved.
-.\"
-.\" Permission to use, copy, modify and distribute this software and its
-.\" documentation is hereby granted, provided that both the copyright
-.\" notice and this permission notice appear in all copies of the
-.\" software, derivative works or modified versions, and any portions
-.\" thereof, and that both notices appear in supporting documentation.
-.\"
-.\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
-.\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
-.\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
-.\"
-.\" Carnegie Mellon requests users of this software to return to
-.\"
-.\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
-.\" School of Computer Science
-.\" Carnegie Mellon University
-.\" Pittsburgh PA 15213-3890
-.\"
-.\" any improvements or extensions that they make and grant Carnegie Mellon
-.\" the rights to redistribute these changes.
-.\"
-.TH vm_deallocate 9 9/19/93
-.CM 4
-.SH NAME
-.nf
-vm_deallocate \- releases a region of a task's address space
-.SH SYNOPSIS
-.nf
-.ft B
-#include <uvm/uvm_extern.h>
-
-.nf
-.ft B
-int vm_deallocate(map, address, size)
- vm_map_t map;
- vm_address_t address;
- vm_size_t size;
-
-
-.fi
-.ft P
-.SH ARGUMENTS
-.TP 15
-.B
-map
-Virtual memory map to be affected.
-.TP 15
-.B
-address
-Starting address (will be rounded down to a page boundary).
-.TP 15
-.B
-size
-Number of bytes to deallocate (will be rounded up to give a
-page boundary).
-
-.SH DESCRIPTION
-.B vm_deallocate
-relinquishes access to a region of a map's
-address space, causing further access to that memory to fail.
-This address range will be available for reallocation.
-Note, that because of the rounding to virtual page boundaries, more
-than
-.B size
-bytes may be deallocated. Use
-.B cnt.vm_page_size
-find out the current virtual page size.
-
-This call may be used to deallocate memory that was passed to a task
-in a message (via out of line data). In that case, the rounding should
-cause no trouble, since the region of memory was allocated as a set
-of pages.
-
-The
-.B vm_deallocate
-call affects only the map specified by the
-.B map
-.
-Other maps which may have access to this memory may continue to reference it.
-
-.SH DIAGNOSTICS
-.TP 25
-KERN_SUCCESS
-Memory deallocated.
-.TP 25
-KERN_INVALID_ADDRESS
-Illegal or non-allocated address specified.
-
-.SH SEE ALSO
-.B vm_allocate
-
diff --git a/share/man/man9/vm_map_copy.9 b/share/man/man9/vm_map_copy.9
deleted file mode 100644
index 6d2e9761fee..00000000000
--- a/share/man/man9/vm_map_copy.9
+++ /dev/null
@@ -1,102 +0,0 @@
-.\"
-.\" $OpenBSD: vm_map_copy.9,v 1.4 2001/11/06 21:54:41 miod Exp $
-.\"
-.\" Mach Operating System
-.\" Copyright (c) 1991,1990 Carnegie Mellon University
-.\" All Rights Reserved.
-.\"
-.\" Permission to use, copy, modify and distribute this software and its
-.\" documentation is hereby granted, provided that both the copyright
-.\" notice and this permission notice appear in all copies of the
-.\" software, derivative works or modified versions, and any portions
-.\" thereof, and that both notices appear in supporting documentation.
-.\"
-.\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
-.\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
-.\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
-.\"
-.\" Carnegie Mellon requests users of this software to return to
-.\"
-.\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
-.\" School of Computer Science
-.\" Carnegie Mellon University
-.\" Pittsburgh PA 15213-3890
-.\"
-.\" any improvements or extensions that they make and grant Carnegie Mellon
-.\" the rights to redistribute these changes.
-.\"
-.TH vm_map_copy 9 9/19/93
-.CM 4
-.SH NAME
-.nf
-vm_map_copy \- copies memory to a destination address
-.SH SYNOPSIS
-.nf
-.ft B
-#include <uvm/uvm_map.h>
-
-.nf
-.ft B
-void vm_map_copy (dst_map, src_map, dst_addr, len, sc_addr, dst_alloc, src_destroy)
- vm_map_t src_map, dst_map;
- vm_offset_t src_addr, dst_addr;
- vm_size_t len;
- boolean_t dst_alloc, src_destroy;
-.fi
-.ft P
-.SH ARGUMENTS
-.TP 15
-.B
-dst_map
-Virtual memory map to be affected.
-.TP 15
-.B
-src_map
-Virtual memory map to copy from.
-.TP 15
-.B
-dst_addr
-Address in \fBdst_map\fR
-of the start of the destination range.
-.TP 15
-.B
-len
-Number of bytes to copy.
-.TP 15
-.B
-src_addr
-Address in \fBsrc_map\fR
-of the start of the source range.
-.TP 15
-.B
-dst_alloc
-Allocate space for destination if none exists.
-.TP 15
-.B
-src_destroy
-Destroy the source after copy completion.
-.SH DESCRIPTION
-\fBvm_map_copy\fR causes the source memory range to be copied to
-the destination address. The source and destination memory ranges
-may overlap. The destination address range must already be allocated and
-writable; the source range must be readable.
-
-\fBvm_map_copy\fR is equivalent to vm_read followed by vm_write.
-.SH DIAGNOSTICS
-.TP 25
-KERN_SUCCESS
-Memory copied.
-.TP 25
-KERN_PROTECTION_FAILURE
-Either the destination region was
-not writable, or the source region was not readable.
-.TP 25
-KERN_INVALID_ADDRESS
-Illegal or non-allocated address specified or
-insufficient memory allocated at one of the addresses.
-.SH BUGS
-The current implementation requires that \fBsrc_addr\fR,
-\fBlen\fR, and \fBdst_addr\fR all be page-aligned.
-Otherwise, KERN_INVALID_ARGUMENT is returned.
-.SH SEE ALSO
-vm_map_protect(9),
diff --git a/share/man/man9/vm_map_inherit.9 b/share/man/man9/vm_map_inherit.9
deleted file mode 100644
index 0c8b3bc4e3d..00000000000
--- a/share/man/man9/vm_map_inherit.9
+++ /dev/null
@@ -1,111 +0,0 @@
-.\" $OpenBSD: vm_map_inherit.9,v 1.6 2001/11/06 21:54:41 miod Exp $
-.\"
-.\" Mach Operating System
-.\" Copyright (c) 1991,1990 Carnegie Mellon University
-.\" All Rights Reserved.
-.\"
-.\" Permission to use, copy, modify and distribute this software and its
-.\" documentation is hereby granted, provided that both the copyright
-.\" notice and this permission notice appear in all copies of the
-.\" software, derivative works or modified versions, and any portions
-.\" thereof, and that both notices appear in supporting documentation.
-.\"
-.\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
-.\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
-.\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
-.\"
-.\" Carnegie Mellon requests users of this software to return to
-.\"
-.\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
-.\" School of Computer Science
-.\" Carnegie Mellon University
-.\" Pittsburgh PA 15213-3890
-.\"
-.\" any improvements or extensions that they make and grant Carnegie Mellon
-.\" the rights to redistribute these changes.
-.\"
-.TH vm_map_inherit 9 9/19/93
-.CM 4
-.SH NAME
-.nf
-vm_map_inherit \- specifies inheritance of address space
-.SH SYNOPSIS
-.nf
-.ft B
-#include <uvm/uvm_map.h>
-
-.nf
-.ft B
-int vm_inherit(map, start, end, new_inheritance)
- vm_map_t map;
- vm_offset_t start, end;
- vm_inherit_t new_inheritance;
-
-
-.fi
-.ft P
-.SH ARGUMENTS
-.TP 15
-.B
-map
-Virtual memory map to be affected.
-.TP 15
-.B
-start
-Starting address (will be rounded down to a page
-boundary).
-.TP 15
-.B
-end
-Ending address (will be rounded down to a page
-boundary).
-.TP 15
-.B
-new_inheritance
-How this memory is to be inherited in child maps.
-Inheritance is specified by using one of these following three values:
-.TP 15
-.B
-VM_INHERIT_SHARE
-Child maps will share this memory with this map.
-.TP 15
-.B
-VM_INHERIT_COPY
-Child maps will receive a copy of this region.
-.TP 15
-.B
-VM_INHERIT_NONE
-This region will be absent from child maps.
-
-.SH DESCRIPTION
-.B vm_map_inherit
-specifies how a region of a virtual address space
-is to be passed to child maps at the time of map creation.
-Inheritance is an attribute of virtual pages; thus the addresses
-and size of memory to be set will be rounded out to refer to
-whole pages.
-
-Setting
-.B vm_map_inherit
-to
-.B VM_INHERIT_SHARE
-and forking a child
-map is the only way two
-.B tasks
-can share physical memory.
-Remember that all the
-.B theads
-of a given task share all the same
-memory.
-
-.SH DIAGNOSTICS
-.TP 25
-KERN_SUCCESS
-Memory protected.
-.TP 25
-KERN_INVALID_ADDRESS
-Illegal address specified.
-
-.SH SEE ALSO
-.B vm_map_fork
-
diff --git a/share/man/man9/vm_map_protect.9 b/share/man/man9/vm_map_protect.9
deleted file mode 100644
index 38c4e279e48..00000000000
--- a/share/man/man9/vm_map_protect.9
+++ /dev/null
@@ -1,103 +0,0 @@
-.\"
-.\" $OpenBSD: vm_map_protect.9,v 1.3 2001/11/06 21:54:41 miod Exp $
-.\"
-.\" Mach Operating System
-.\" Copyright (c) 1991,1990 Carnegie Mellon University
-.\" All Rights Reserved.
-.\"
-.\" Permission to use, copy, modify and distribute this software and its
-.\" documentation is hereby granted, provided that both the copyright
-.\" notice and this permission notice appear in all copies of the
-.\" software, derivative works or modified versions, and any portions
-.\" thereof, and that both notices appear in supporting documentation.
-.\"
-.\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
-.\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
-.\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
-.\"
-.\" Carnegie Mellon requests users of this software to return to
-.\"
-.\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
-.\" School of Computer Science
-.\" Carnegie Mellon University
-.\" Pittsburgh PA 15213-3890
-.\"
-.\" any improvements or extensions that they make and grant Carnegie Mellon
-.\" the rights to redistribute these changes.
-.\"
-.TH vm_map_protect 9 9/19/93
-.CM 4
-.SH NAME
-.nf
-vm_map_protect \- change protection of memory
-.SH SYNOPSIS
-.nf
-.ft B
-#include <uvm/uvm_map.h>
-
-.nf
-.ft B
-int vm_map_protect(map, start, end, new_prot, set_max)
- vm_map_t map;
- vm_offset_t start, end;
- vm_prot_t new_protection;
- boolean_t set_maximum;
-
-
-.fi
-.ft P
-.SH ARGUMENTS
-.TP 15
-.B
-map
-Virtual memory map to be affected.
-.TP 15
-.B
-start
-Starting address (will be rounded down to a
-page boundary).
-.TP 15
-.B
-end
-Ending address (will be rounded down to a
-page boundary).
-.TP 15
-.B
-new_prot
-A new protection value for this region; a set of:
-\fBVM_PROT_READ\fR, \fBVM_PROT_WRITE\fR, \fBVM_PROT_EXECUTE\fR.
-.TP 15
-.B
-set_max
-If set, make the protection change apply to the
-maximum protection associated with this address range;
-otherwise, the current protection on this
-range is changed. If the maximum protection is reduced below the
-current protection, both will be changed to reflect the new maximum.
-
-.SH DESCRIPTION
-.B vm_map_protect
-sets the virtual memory access privileges for a
-range of allocated addresses in a task's virtual address space.
-The protection argument describes a combination of read, write,
-and execute accesses that should be \fBpermitted\fR.
-
-The enforcement of virtual memory protection is machine-dependent.
-Nominally read access requires VM_PROT_READ permission, write access
-requires VM_PROT_WRITE permission, and execute access requires
-VM_PROT_EXECUTE permission. However, some combinations of access
-rights may not be supported. In particular, the kernel interface
-allows write access to require VM_PROT_READ and VM_PROT_WRITE
-permission and execute access to require VM_PROT_READ permission.
-
-.SH DIAGNOSTICS
-.TP 25
-KERN_SUCCESS
-Memory protected.
-.TP 25
-KERN_PROTECTION_FAILURE
-An attempt was made to increase the current
-or maximum protection beyond the existing maximum protection value.
-.TP 25
-KERN_INVALID_ADDRESS
-Illegal or non-allocated address specified.