FreeBSD/Linux Kernel Cross Reference
sys/man/vm_write.man
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_write.man,v $
29 .\" Revision 2.6 93/03/18 15:17:11 mrt
30 .\" corrected types
31 .\" [93/03/12 16:55:47 lli]
32 .\"
33 .\" Revision 2.5 91/12/13 14:22:35 jsb
34 .\" Moved alignment restrictions to a BUGS section.
35 .\" [91/12/11 rpd]
36 .\"
37 .\" Revision 2.4 91/05/14 17:16:44 mrt
38 .\" Correcting copyright
39 .\"
40 .\" Revision 2.3 91/02/14 14:16:48 mrt
41 .\" Changed to new Mach copyright
42 .\" [91/02/12 18:17:49 mrt]
43 .\"
44 .\" Revision 2.2 90/08/07 18:48:25 rpd
45 .\" Created.
46 .\"
47 .TH vm_write 2 1/13/87
48 .CM 4
49 .SH NAME
50 .nf
51 vm_write \- allows a task's memory to be written by another task
52 .SH SYNOPSIS
53 .nf
54 .ft B
55 #include <mach.h>
56
57 .nf
58 .ft B
59 kern_return_t vm_write(target_task, address, data, data_count)
60 mach_port_t target_task;
61 vm_address_t address;
62 vm_offset_t data;
63 mach_msg_number_type_t data_count;
64 .fi
65 .ft P
66 .SH ARGUMENTS
67 .TP 15
68 .B
69 target_task
70 Task whose memory is to be written.
71 .TP 15
72 .B
73 address
74 Starting address in task to be affected.
75 .TP 15
76 .B
77 data
78 An array of bytes to be written.
79 .TP 15
80 .B
81 data_count
82 The size of the
83 .B data
84 array.
85 .SH DESCRIPTION
86 \fBvm_write\fR allows a task's virtual memory to be written
87 by another task.
88 .SH DIAGNOSTICS
89 .TP 25
90 KERN_SUCCESS
91 Memory written.
92 .TP 25
93 KERN_PROTECTION_FAILURE
94 The address region in the target task
95 is protected against writing.
96 .TP 25
97 KERN_INVALID_ADDRESS
98 Illegal or non_allocated address specified or
99 there is not \fBdata_count\fR
100 of allocated memory starting at \fBaddress\fR.
101 .SH BUGS
102 The current implementation requires that \fBaddress\fR,
103 \fBdata\fR, and \fBdata_count\fR all be page-aligned.
104 Otherwise, KERN_INVALID_ARGUMENT is returned.
105 .SH SEE ALSO
106 vm_copy(2),
107 vm_protect(2),
108 vm_read(2),
109 vm_statistics(2).
Cache object: 9f002cc15f93f6fa300035bb3e26f9a1
|