1 .\"
2 .\" Mach Operating System
3 .\" Copyright (c) 1991,1990 Carnegie Mellon University
4 .\" All Rights Reserved.
5 .\"
6 .\" Permission to use, copy, modify and distribute this software and its
7 .\" documentation is hereby granted, provided that both the copyright
8 .\" notice and this permission notice appear in all copies of the
9 .\" software, derivative works or modified versions, and any portions
10 .\" thereof, and that both notices appear in supporting documentation.
11 .\"
12 .\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
13 .\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
14 .\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
15 .\"
16 .\" Carnegie Mellon requests users of this software to return to
17 .\"
18 .\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
19 .\" School of Computer Science
20 .\" Carnegie Mellon University
21 .\" Pittsburgh PA 15213-3890
22 .\"
23 .\" any improvements or extensions that they make and grant Carnegie Mellon
24 .\" the rights to redistribute these changes.
25 .\"
26 .\"
27 .\" HISTORY
28 .\" $Log: vm_deallocate.man,v $
29 .\" Revision 2.5 93/03/18 15:16:41 mrt
30 .\" corrected types
31 .\" [93/03/12 16:55:15 lli]
32 .\"
33 .\" Revision 2.4 91/05/14 17:15:29 mrt
34 .\" Correcting copyright
35 .\"
36 .\" Revision 2.3 91/02/14 14:16:09 mrt
37 .\" Changed to new Mach copyright
38 .\" [91/02/12 18:17:03 mrt]
39 .\"
40 .\" Revision 2.2 90/08/07 18:47:22 rpd
41 .\" Created.
42 .\"
43 .TH vm_deallocate 2 9/19/86
44 .CM 4
45 .SH NAME
46 .nf
47 vm_deallocate \- releases a region of a task's address space
48 .SH SYNOPSIS
49 .nf
50 .ft B
51 #include <mach.h>
52
53 .nf
54 .ft B
55 kern_return_t vm_deallocate(target_task, address, size)
56 mach_port_t target_task;
57 vm_address_t address;
58 vm_size_t size;
59
60
61 .fi
62 .ft P
63 .SH ARGUMENTS
64 .TP 15
65 .B
66 target_task
67 Task whose virtual memory is to be affected.
68 .TP 15
69 .B
70 address
71 Starting address (will be rounded down to a page boundary).
72 .TP 15
73 .B
74 size
75 Number of bytes to deallocate (will be rounded up to give a
76 page boundary).
77
78 .SH DESCRIPTION
79 .B vm_deallocate
80 relinquishes access to a region of a task's
81 address space, causing further access to that memory to fail.
82 This address range will be available for reallocation.
83 Note, that because of the rounding to virtual page boundaries, more
84 than
85 .B size
86 bytes may be deallocated. Use
87 .B vm_page_size
88 or
89 .B vm_statistics
90 to
91 find out the current virtual page size.
92
93 This call may be used to deallocte memory that was passed to a task
94 in a message (via out of line data). In that case, the rounding should
95 cause no trouble, since the region of memory was allocated as a set
96 of pages.
97
98 The
99 .B vm_deallocate
100 call affects only the task specified by the
101 .B target_task
102 .
103 Other tasks which may have access to this memory may continue to reference it.
104
105 .SH DIAGNOSTICS
106 .TP 25
107 KERN_SUCCESS
108 Memory deallocated.
109 .TP 25
110 KERN_INVALID_ADDRESS
111 Illegal or non-allocated address specified.
112
113 .SH SEE ALSO
114 .B vm_allocate, vm_statistics, msg_receive
115
Cache object: 54baaa41aca78a97a741f00fb5fee878
|