inetcomm: Add an implementation of IPOP3Transport::CommandSTAT.
[wine/multimedia.git] / dlls / kernel32 / virtual.c
blob38a408a14fe954a53c551953088cf40dab943c32
1 /*
2 * Win32 virtual memory functions
4 * Copyright 1997 Alexandre Julliard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
21 #include "config.h"
22 #include "wine/port.h"
24 #include <fcntl.h>
25 #include <stdarg.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <sys/types.h>
29 #ifdef HAVE_UNISTD_H
30 # include <unistd.h>
31 #endif
33 #define NONAMELESSUNION
34 #define NONAMELESSSTRUCT
35 #include "ntstatus.h"
36 #define WIN32_NO_STATUS
37 #include "windef.h"
38 #include "winbase.h"
39 #include "winnls.h"
40 #include "winternl.h"
41 #include "winerror.h"
42 #include "wine/exception.h"
43 #include "wine/debug.h"
45 #include "kernel_private.h"
47 WINE_DECLARE_DEBUG_CHANNEL(seh);
49 static unsigned int page_size;
52 /***********************************************************************
53 * VirtualAlloc (KERNEL32.@)
55 * Reserves or commits a region of pages in virtual address space.
57 * PARAMS
58 * addr [I] Address of region to reserve or commit.
59 * size [I] Size of region.
60 * type [I] Type of allocation.
61 * protect [I] Type of access protection.
63 * RETURNS
64 * Success: Base address of allocated region of pages.
65 * Failure: NULL.
67 LPVOID WINAPI VirtualAlloc( LPVOID addr, SIZE_T size, DWORD type, DWORD protect )
69 return VirtualAllocEx( GetCurrentProcess(), addr, size, type, protect );
73 /***********************************************************************
74 * VirtualAllocEx (KERNEL32.@)
76 * Seems to be just as VirtualAlloc, but with process handle.
78 * PARAMS
79 * hProcess [I] Handle to process to do mem operation.
80 * addr [I] Address of region to reserve or commit.
81 * size [I] Size of region.
82 * type [I] Type of allocation.
83 * protect [I] Type of access protection.
86 * RETURNS
87 * Success: Base address of allocated region of pages.
88 * Failure: NULL.
90 LPVOID WINAPI VirtualAllocEx( HANDLE hProcess, LPVOID addr, SIZE_T size,
91 DWORD type, DWORD protect )
93 LPVOID ret = addr;
94 NTSTATUS status;
96 if ((status = NtAllocateVirtualMemory( hProcess, &ret, 0, &size, type, protect )))
98 SetLastError( RtlNtStatusToDosError(status) );
99 ret = NULL;
101 return ret;
105 /***********************************************************************
106 * VirtualFree (KERNEL32.@)
108 * Releases or decommits a region of pages in virtual address space.
110 * PARAMS
111 * addr [I] Address of region of committed pages.
112 * size [I] Size of region.
113 * type [I] Type of operation.
115 * RETURNS
116 * Success: TRUE.
117 * Failure: FALSE.
119 BOOL WINAPI VirtualFree( LPVOID addr, SIZE_T size, DWORD type )
121 return VirtualFreeEx( GetCurrentProcess(), addr, size, type );
125 /***********************************************************************
126 * VirtualFreeEx (KERNEL32.@)
128 * Releases or decommits a region of pages in virtual address space.
130 * PARAMS
131 * process [I] Handle to process.
132 * addr [I] Address of region to free.
133 * size [I] Size of region.
134 * type [I] Type of operation.
136 * RETURNS
137 * Success: TRUE.
138 * Failure: FALSE.
140 BOOL WINAPI VirtualFreeEx( HANDLE process, LPVOID addr, SIZE_T size, DWORD type )
142 NTSTATUS status = NtFreeVirtualMemory( process, &addr, &size, type );
143 if (status) SetLastError( RtlNtStatusToDosError(status) );
144 return !status;
148 /***********************************************************************
149 * VirtualLock (KERNEL32.@)
151 * Locks the specified region of virtual address space.
153 * PARAMS
154 * addr [I] Address of first byte of range to lock.
155 * size [I] Number of bytes in range to lock.
157 * RETURNS
158 * Success: TRUE.
159 * Failure: FALSE.
161 * NOTES
162 * Always returns TRUE.
165 BOOL WINAPI VirtualLock( LPVOID addr, SIZE_T size )
167 NTSTATUS status = NtLockVirtualMemory( GetCurrentProcess(), &addr, &size, 1 );
168 if (status) SetLastError( RtlNtStatusToDosError(status) );
169 return !status;
173 /***********************************************************************
174 * VirtualUnlock (KERNEL32.@)
176 * Unlocks a range of pages in the virtual address space.
178 * PARAMS
179 * addr [I] Address of first byte of range.
180 * size [I] Number of bytes in range.
182 * RETURNS
183 * Success: TRUE.
184 * Failure: FALSE.
186 * NOTES
187 * Always returns TRUE.
190 BOOL WINAPI VirtualUnlock( LPVOID addr, SIZE_T size )
192 NTSTATUS status = NtUnlockVirtualMemory( GetCurrentProcess(), &addr, &size, 1 );
193 if (status) SetLastError( RtlNtStatusToDosError(status) );
194 return !status;
198 /***********************************************************************
199 * VirtualProtect (KERNEL32.@)
201 * Changes the access protection on a region of committed pages.
203 * PARAMS
204 * addr [I] Address of region of committed pages.
205 * size [I] Size of region.
206 * new_prot [I] Desired access protection.
207 * old_prot [O] Address of variable to get old protection.
209 * RETURNS
210 * Success: TRUE.
211 * Failure: FALSE.
213 BOOL WINAPI VirtualProtect( LPVOID addr, SIZE_T size, DWORD new_prot, LPDWORD old_prot)
215 return VirtualProtectEx( GetCurrentProcess(), addr, size, new_prot, old_prot );
219 /***********************************************************************
220 * VirtualProtectEx (KERNEL32.@)
222 * Changes the access protection on a region of committed pages in the
223 * virtual address space of a specified process.
225 * PARAMS
226 * process [I] Handle of process.
227 * addr [I] Address of region of committed pages.
228 * size [I] Size of region.
229 * new_prot [I] Desired access protection.
230 * old_prot [O] Address of variable to get old protection.
232 * RETURNS
233 * Success: TRUE.
234 * Failure: FALSE.
236 BOOL WINAPI VirtualProtectEx( HANDLE process, LPVOID addr, SIZE_T size,
237 DWORD new_prot, LPDWORD old_prot )
239 NTSTATUS status = NtProtectVirtualMemory( process, &addr, &size, new_prot, old_prot );
240 if (status) SetLastError( RtlNtStatusToDosError(status) );
241 return !status;
245 /***********************************************************************
246 * VirtualQuery (KERNEL32.@)
248 * Provides info about a range of pages in virtual address space.
250 * PARAMS
251 * addr [I] Address of region.
252 * info [O] Address of info buffer.
253 * len [I] Size of buffer.
255 * RETURNS
256 * Number of bytes returned in information buffer or 0 if
257 * addr >= 0xc0000000 (kernel space).
259 SIZE_T WINAPI VirtualQuery( LPCVOID addr, PMEMORY_BASIC_INFORMATION info,
260 SIZE_T len )
262 return VirtualQueryEx( GetCurrentProcess(), addr, info, len );
266 /***********************************************************************
267 * VirtualQueryEx (KERNEL32.@)
269 * Provides info about a range of pages in virtual address space of a
270 * specified process.
272 * PARAMS
273 * process [I] Handle to process.
274 * addr [I] Address of region.
275 * info [O] Address of info buffer.
276 * len [I] Size of buffer.
278 * RETURNS
279 * Number of bytes returned in information buffer.
281 SIZE_T WINAPI VirtualQueryEx( HANDLE process, LPCVOID addr,
282 PMEMORY_BASIC_INFORMATION info, SIZE_T len )
284 SIZE_T ret;
285 NTSTATUS status;
287 if ((status = NtQueryVirtualMemory( process, addr, MemoryBasicInformation, info, len, &ret )))
289 SetLastError( RtlNtStatusToDosError(status) );
290 ret = 0;
292 return ret;
296 /***********************************************************************
297 * CreateFileMappingA (KERNEL32.@)
299 * Creates a named or unnamed file-mapping object for the specified file.
301 * PARAMS
302 * hFile [I] Handle to the file to map.
303 * sa [I] Optional security attributes.
304 * protect [I] Protection for mapping object.
305 * size_high [I] High-order 32 bits of object size.
306 * size_low [I] Low-order 32 bits of object size.
307 * name [I] Name of file-mapping object.
309 * RETURNS
310 * Success: Handle.
311 * Failure: NULL. Mapping object does not exist.
313 HANDLE WINAPI CreateFileMappingA( HANDLE hFile, SECURITY_ATTRIBUTES *sa,
314 DWORD protect, DWORD size_high, DWORD size_low, LPCSTR name )
316 WCHAR buffer[MAX_PATH];
318 if (!name) return CreateFileMappingW( hFile, sa, protect, size_high, size_low, NULL );
320 if (!MultiByteToWideChar( CP_ACP, 0, name, -1, buffer, MAX_PATH ))
322 SetLastError( ERROR_FILENAME_EXCED_RANGE );
323 return 0;
325 return CreateFileMappingW( hFile, sa, protect, size_high, size_low, buffer );
329 /***********************************************************************
330 * CreateFileMappingW (KERNEL32.@)
332 * See CreateFileMappingA.
334 HANDLE WINAPI CreateFileMappingW( HANDLE hFile, LPSECURITY_ATTRIBUTES sa,
335 DWORD protect, DWORD size_high,
336 DWORD size_low, LPCWSTR name )
338 static const int sec_flags = SEC_FILE | SEC_IMAGE | SEC_RESERVE | SEC_COMMIT | SEC_NOCACHE;
340 HANDLE ret;
341 NTSTATUS status;
342 DWORD access, sec_type;
343 LARGE_INTEGER size;
345 sec_type = protect & sec_flags;
346 protect &= ~sec_flags;
347 if (!sec_type) sec_type = SEC_COMMIT;
349 switch(protect)
351 case 0:
352 protect = PAGE_READONLY; /* Win9x compatibility */
353 /* fall through */
354 case PAGE_READONLY:
355 case PAGE_WRITECOPY:
356 access = STANDARD_RIGHTS_REQUIRED | SECTION_QUERY | SECTION_MAP_READ;
357 break;
358 case PAGE_READWRITE:
359 access = STANDARD_RIGHTS_REQUIRED | SECTION_QUERY | SECTION_MAP_READ | SECTION_MAP_WRITE;
360 break;
361 case PAGE_EXECUTE:
362 access = STANDARD_RIGHTS_REQUIRED | SECTION_QUERY | SECTION_MAP_EXECUTE;
363 break;
364 case PAGE_EXECUTE_READ:
365 case PAGE_EXECUTE_WRITECOPY:
366 access = STANDARD_RIGHTS_REQUIRED | SECTION_QUERY | SECTION_MAP_READ | SECTION_MAP_EXECUTE;
367 break;
368 case PAGE_EXECUTE_READWRITE:
369 access = STANDARD_RIGHTS_REQUIRED | SECTION_QUERY | SECTION_MAP_READ | SECTION_MAP_WRITE | SECTION_MAP_EXECUTE;
370 break;
371 default:
372 SetLastError( ERROR_INVALID_PARAMETER );
373 return 0;
376 if (hFile == INVALID_HANDLE_VALUE)
378 hFile = 0;
379 if (!size_low && !size_high)
381 SetLastError( ERROR_INVALID_PARAMETER );
382 return 0;
386 size.u.LowPart = size_low;
387 size.u.HighPart = size_high;
389 if (sa || name)
391 OBJECT_ATTRIBUTES attr;
392 UNICODE_STRING nameW;
394 attr.Length = sizeof(attr);
395 attr.RootDirectory = 0;
396 attr.ObjectName = NULL;
397 attr.Attributes = OBJ_OPENIF | ((sa && sa->bInheritHandle) ? OBJ_INHERIT : 0);
398 attr.SecurityDescriptor = sa ? sa->lpSecurityDescriptor : NULL;
399 attr.SecurityQualityOfService = NULL;
400 if (name)
402 RtlInitUnicodeString( &nameW, name );
403 attr.ObjectName = &nameW;
404 attr.RootDirectory = get_BaseNamedObjects_handle();
406 status = NtCreateSection( &ret, access, &attr, &size, protect, sec_type, hFile );
408 else status = NtCreateSection( &ret, access, NULL, &size, protect, sec_type, hFile );
410 if (status == STATUS_OBJECT_NAME_EXISTS)
411 SetLastError( ERROR_ALREADY_EXISTS );
412 else
413 SetLastError( RtlNtStatusToDosError(status) );
414 return ret;
418 /***********************************************************************
419 * OpenFileMappingA (KERNEL32.@)
421 * Opens a named file-mapping object.
423 * PARAMS
424 * access [I] Access mode.
425 * inherit [I] Inherit flag.
426 * name [I] Name of file-mapping object.
428 * RETURNS
429 * Success: Handle.
430 * Failure: NULL.
432 HANDLE WINAPI OpenFileMappingA( DWORD access, BOOL inherit, LPCSTR name )
434 WCHAR buffer[MAX_PATH];
436 if (!name) return OpenFileMappingW( access, inherit, NULL );
438 if (!MultiByteToWideChar( CP_ACP, 0, name, -1, buffer, MAX_PATH ))
440 SetLastError( ERROR_FILENAME_EXCED_RANGE );
441 return 0;
443 return OpenFileMappingW( access, inherit, buffer );
447 /***********************************************************************
448 * OpenFileMappingW (KERNEL32.@)
450 * See OpenFileMappingA.
452 HANDLE WINAPI OpenFileMappingW( DWORD access, BOOL inherit, LPCWSTR name)
454 OBJECT_ATTRIBUTES attr;
455 UNICODE_STRING nameW;
456 HANDLE ret;
457 NTSTATUS status;
459 if (!name)
461 SetLastError( ERROR_INVALID_PARAMETER );
462 return 0;
464 attr.Length = sizeof(attr);
465 attr.RootDirectory = get_BaseNamedObjects_handle();
466 attr.ObjectName = &nameW;
467 attr.Attributes = inherit ? OBJ_INHERIT : 0;
468 attr.SecurityDescriptor = NULL;
469 attr.SecurityQualityOfService = NULL;
470 RtlInitUnicodeString( &nameW, name );
472 if (access == FILE_MAP_COPY) access = FILE_MAP_READ;
474 if ((status = NtOpenSection( &ret, access, &attr )))
476 SetLastError( RtlNtStatusToDosError(status) );
477 ret = 0;
479 return ret;
483 /***********************************************************************
484 * MapViewOfFile (KERNEL32.@)
486 * Maps a view of a file into the address space.
488 * PARAMS
489 * mapping [I] File-mapping object to map.
490 * access [I] Access mode.
491 * offset_high [I] High-order 32 bits of file offset.
492 * offset_low [I] Low-order 32 bits of file offset.
493 * count [I] Number of bytes to map.
495 * RETURNS
496 * Success: Starting address of mapped view.
497 * Failure: NULL.
499 LPVOID WINAPI MapViewOfFile( HANDLE mapping, DWORD access,
500 DWORD offset_high, DWORD offset_low, SIZE_T count )
502 return MapViewOfFileEx( mapping, access, offset_high,
503 offset_low, count, NULL );
507 /***********************************************************************
508 * MapViewOfFileEx (KERNEL32.@)
510 * Maps a view of a file into the address space.
512 * PARAMS
513 * handle [I] File-mapping object to map.
514 * access [I] Access mode.
515 * offset_high [I] High-order 32 bits of file offset.
516 * offset_low [I] Low-order 32 bits of file offset.
517 * count [I] Number of bytes to map.
518 * addr [I] Suggested starting address for mapped view.
520 * RETURNS
521 * Success: Starting address of mapped view.
522 * Failure: NULL.
524 LPVOID WINAPI MapViewOfFileEx( HANDLE handle, DWORD access,
525 DWORD offset_high, DWORD offset_low, SIZE_T count, LPVOID addr )
527 NTSTATUS status;
528 LARGE_INTEGER offset;
529 ULONG protect;
531 offset.u.LowPart = offset_low;
532 offset.u.HighPart = offset_high;
534 if (access & FILE_MAP_WRITE) protect = PAGE_READWRITE;
535 else if (access & FILE_MAP_READ) protect = PAGE_READONLY;
536 else if (access & FILE_MAP_COPY) protect = PAGE_WRITECOPY;
537 else protect = PAGE_NOACCESS;
539 if ((status = NtMapViewOfSection( handle, GetCurrentProcess(), &addr, 0, 0, &offset,
540 &count, ViewShare, 0, protect )))
542 SetLastError( RtlNtStatusToDosError(status) );
543 addr = NULL;
545 return addr;
549 /***********************************************************************
550 * UnmapViewOfFile (KERNEL32.@)
552 * Unmaps a mapped view of a file.
554 * PARAMS
555 * addr [I] Address where mapped view begins.
557 * RETURNS
558 * Success: TRUE.
559 * Failure: FALSE.
562 BOOL WINAPI UnmapViewOfFile( LPCVOID addr )
564 NTSTATUS status = NtUnmapViewOfSection( GetCurrentProcess(), (void *)addr );
565 if (status) SetLastError( RtlNtStatusToDosError(status) );
566 return !status;
570 /***********************************************************************
571 * FlushViewOfFile (KERNEL32.@)
573 * Writes to the disk a byte range within a mapped view of a file.
575 * PARAMS
576 * base [I] Start address of byte range to flush.
577 * size [I] Number of bytes in range.
579 * RETURNS
580 * Success: TRUE.
581 * Failure: FALSE.
583 BOOL WINAPI FlushViewOfFile( LPCVOID base, SIZE_T size )
585 NTSTATUS status = NtFlushVirtualMemory( GetCurrentProcess(), &base, &size, 0 );
586 if (status)
588 if (status == STATUS_NOT_MAPPED_DATA) status = STATUS_SUCCESS;
589 else SetLastError( RtlNtStatusToDosError(status) );
591 return !status;
595 /***********************************************************************
596 * IsBadReadPtr (KERNEL32.@)
598 * Check for read access on a memory block.
600 * ptr [I] Address of memory block.
601 * size [I] Size of block.
603 * RETURNS
604 * Success: TRUE.
605 * Failure: FALSE. Process has read access to entire block.
607 BOOL WINAPI IsBadReadPtr( LPCVOID ptr, UINT size )
609 if (!size) return FALSE; /* handle 0 size case w/o reference */
610 if (!ptr) return TRUE;
612 if (!page_size) page_size = getpagesize();
613 __TRY
615 volatile const char *p = ptr;
616 char dummy;
617 UINT count = size;
619 while (count > page_size)
621 dummy = *p;
622 p += page_size;
623 count -= page_size;
625 dummy = p[0];
626 dummy = p[count - 1];
628 __EXCEPT_PAGE_FAULT
630 TRACE_(seh)("%p caused page fault during read\n", ptr);
631 return TRUE;
633 __ENDTRY
634 return FALSE;
638 /***********************************************************************
639 * IsBadWritePtr (KERNEL32.@)
641 * Check for write access on a memory block.
643 * PARAMS
644 * ptr [I] Address of memory block.
645 * size [I] Size of block in bytes.
647 * RETURNS
648 * Success: TRUE.
649 * Failure: FALSE. Process has write access to entire block.
651 BOOL WINAPI IsBadWritePtr( LPVOID ptr, UINT size )
653 if (!size) return FALSE; /* handle 0 size case w/o reference */
654 if (!ptr) return TRUE;
656 if (!page_size) page_size = getpagesize();
657 __TRY
659 volatile char *p = ptr;
660 UINT count = size;
662 while (count > page_size)
664 *p |= 0;
665 p += page_size;
666 count -= page_size;
668 p[0] |= 0;
669 p[count - 1] |= 0;
671 __EXCEPT_PAGE_FAULT
673 TRACE_(seh)("%p caused page fault during write\n", ptr);
674 return TRUE;
676 __ENDTRY
677 return FALSE;
681 /***********************************************************************
682 * IsBadHugeReadPtr (KERNEL32.@)
684 * Check for read access on a memory block.
686 * PARAMS
687 * ptr [I] Address of memory block.
688 * size [I] Size of block.
690 * RETURNS
691 * Success: TRUE.
692 * Failure: FALSE. Process has read access to entire block.
694 BOOL WINAPI IsBadHugeReadPtr( LPCVOID ptr, UINT size )
696 return IsBadReadPtr( ptr, size );
700 /***********************************************************************
701 * IsBadHugeWritePtr (KERNEL32.@)
703 * Check for write access on a memory block.
705 * PARAMS
706 * ptr [I] Address of memory block.
707 * size [I] Size of block.
709 * RETURNS
710 * Success: TRUE.
711 * Failure: FALSE. Process has write access to entire block.
713 BOOL WINAPI IsBadHugeWritePtr( LPVOID ptr, UINT size )
715 return IsBadWritePtr( ptr, size );
719 /***********************************************************************
720 * IsBadCodePtr (KERNEL32.@)
722 * Check for read access on a memory address.
724 * PARAMS
725 * ptr [I] Address of function.
727 * RETURNS
728 * Success: TRUE.
729 * Failure: FALSE. Process has read access to specified memory.
731 BOOL WINAPI IsBadCodePtr( FARPROC ptr )
733 return IsBadReadPtr( ptr, 1 );
737 /***********************************************************************
738 * IsBadStringPtrA (KERNEL32.@)
740 * Check for read access on a range of memory pointed to by a string pointer.
742 * PARAMS
743 * str [I] Address of string.
744 * max [I] Maximum size of string.
746 * RETURNS
747 * Success: TRUE.
748 * Failure: FALSE. Read access to all bytes in string.
750 BOOL WINAPI IsBadStringPtrA( LPCSTR str, UINT max )
752 if (!str) return TRUE;
754 __TRY
756 volatile const char *p = str;
757 while (p != str + max) if (!*p++) break;
759 __EXCEPT_PAGE_FAULT
761 TRACE_(seh)("%p caused page fault during read\n", str);
762 return TRUE;
764 __ENDTRY
765 return FALSE;
769 /***********************************************************************
770 * IsBadStringPtrW (KERNEL32.@)
772 * See IsBadStringPtrA.
774 BOOL WINAPI IsBadStringPtrW( LPCWSTR str, UINT max )
776 if (!str) return TRUE;
778 __TRY
780 volatile const WCHAR *p = str;
781 while (p != str + max) if (!*p++) break;
783 __EXCEPT_PAGE_FAULT
785 TRACE_(seh)("%p caused page fault during read\n", str);
786 return TRUE;
788 __ENDTRY
789 return FALSE;