ntdll: Implemented NtReadFileScatter.
[wine] / dlls / ntdll / om.c
1 /*
2  *      Object management functions
3  *
4  * Copyright 1999, 2000 Juergen Schmied
5  * Copyright 2005 Vitaliy Margolen
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20  */
21
22 #include "config.h"
23
24 #include <stdarg.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #ifdef HAVE_IO_H
28 # include <io.h>
29 #endif
30 #ifdef HAVE_UNISTD_H
31 # include <unistd.h>
32 #endif
33
34 #include "ntstatus.h"
35 #define WIN32_NO_STATUS
36 #include "wine/debug.h"
37 #include "windef.h"
38 #include "winternl.h"
39 #include "ntdll_misc.h"
40 #include "wine/server.h"
41
42 WINE_DEFAULT_DEBUG_CHANNEL(ntdll);
43
44
45 /*
46  *      Generic object functions
47  */
48
49 /******************************************************************************
50  * NtQueryObject [NTDLL.@]
51  * ZwQueryObject [NTDLL.@]
52  */
53 NTSTATUS WINAPI NtQueryObject(IN HANDLE handle,
54                               IN OBJECT_INFORMATION_CLASS info_class,
55                               OUT PVOID ptr, IN ULONG len, OUT PULONG used_len)
56 {
57     NTSTATUS status;
58
59     TRACE("(%p,0x%08x,%p,0x%08x,%p): stub\n",
60           handle, info_class, ptr, len, used_len);
61
62     if (used_len) *used_len = 0;
63
64     switch (info_class)
65     {
66     case ObjectBasicInformation:
67         {
68             POBJECT_BASIC_INFORMATION p = (POBJECT_BASIC_INFORMATION)ptr;
69
70             if (len < sizeof(*p)) return STATUS_INVALID_BUFFER_SIZE;
71
72             SERVER_START_REQ( get_object_info )
73             {
74                 req->handle = handle;
75                 status = wine_server_call( req );
76                 if (status == STATUS_SUCCESS)
77                 {
78                     memset( p, 0, sizeof(*p) );
79                     p->GrantedAccess = reply->access;
80                     p->PointerCount = reply->ref_count;
81                     p->HandleCount = 1; /* at least one */
82                     if (used_len) *used_len = sizeof(*p);
83                 }
84             }
85             SERVER_END_REQ;
86         }
87         break;
88     case ObjectDataInformation:
89         {
90             OBJECT_DATA_INFORMATION* p = (OBJECT_DATA_INFORMATION*)ptr;
91
92             if (len < sizeof(*p)) return STATUS_INVALID_BUFFER_SIZE;
93
94             SERVER_START_REQ( set_handle_info )
95             {
96                 req->handle = handle;
97                 req->flags  = 0;
98                 req->mask   = 0;
99                 status = wine_server_call( req );
100                 if (status == STATUS_SUCCESS)
101                 {
102                     p->InheritHandle = (reply->old_flags & HANDLE_FLAG_INHERIT) ? TRUE : FALSE;
103                     p->ProtectFromClose = (reply->old_flags & HANDLE_FLAG_PROTECT_FROM_CLOSE) ? TRUE : FALSE;
104                     if (used_len) *used_len = sizeof(*p);
105                 }
106             }
107             SERVER_END_REQ;
108         }
109         break;
110     default:
111         FIXME("Unsupported information class %u\n", info_class);
112         status = STATUS_NOT_IMPLEMENTED;
113         break;
114     }
115     return status;
116 }
117
118 /******************************************************************
119  *              NtSetInformationObject [NTDLL.@]
120  *              ZwSetInformationObject [NTDLL.@]
121  *
122  */
123 NTSTATUS WINAPI NtSetInformationObject(IN HANDLE handle,
124                                        IN OBJECT_INFORMATION_CLASS info_class,
125                                        IN PVOID ptr, IN ULONG len)
126 {
127     NTSTATUS status;
128
129     TRACE("(%p,0x%08x,%p,0x%08x): stub\n",
130           handle, info_class, ptr, len);
131
132     switch (info_class)
133     {
134     case ObjectDataInformation:
135         {
136             OBJECT_DATA_INFORMATION* p = (OBJECT_DATA_INFORMATION*)ptr;
137
138             if (len < sizeof(*p)) return STATUS_INVALID_BUFFER_SIZE;
139
140             SERVER_START_REQ( set_handle_info )
141             {
142                 req->handle = handle;
143                 req->flags  = 0;
144                 req->mask   = HANDLE_FLAG_INHERIT | HANDLE_FLAG_PROTECT_FROM_CLOSE;
145                 if (p->InheritHandle)    req->flags |= HANDLE_FLAG_INHERIT;
146                 if (p->ProtectFromClose) req->flags |= HANDLE_FLAG_PROTECT_FROM_CLOSE;
147                 status = wine_server_call( req );
148             }
149             SERVER_END_REQ;
150         }
151         break;
152     default:
153         FIXME("Unsupported information class %u\n", info_class);
154         status = STATUS_NOT_IMPLEMENTED;
155         break;
156     }
157     return status;
158 }
159
160 /******************************************************************************
161  *  NtQuerySecurityObject       [NTDLL.@]
162  *
163  * An ntdll analogue to GetKernelObjectSecurity().
164  *
165  */
166 NTSTATUS WINAPI
167 NtQuerySecurityObject(
168         IN HANDLE Object,
169         IN SECURITY_INFORMATION RequestedInformation,
170         OUT PSECURITY_DESCRIPTOR pSecurityDescriptor,
171         IN ULONG Length,
172         OUT PULONG ResultLength)
173 {
174     PISECURITY_DESCRIPTOR_RELATIVE psd = pSecurityDescriptor;
175     NTSTATUS status;
176     unsigned int buffer_size = 512;
177     BOOLEAN need_more_memory = FALSE;
178
179     TRACE("(%p,0x%08x,%p,0x%08x,%p)\n",
180         Object, RequestedInformation, pSecurityDescriptor, Length, ResultLength);
181
182     do
183     {
184         char *buffer = RtlAllocateHeap(GetProcessHeap(), 0, buffer_size);
185         if (!buffer)
186             return STATUS_NO_MEMORY;
187
188         SERVER_START_REQ( get_security_object )
189         {
190             req->handle = Object;
191             req->security_info = RequestedInformation;
192             wine_server_set_reply( req, buffer, buffer_size );
193             status = wine_server_call( req );
194             if (status == STATUS_SUCCESS)
195             {
196                 struct security_descriptor *sd = (struct security_descriptor *)buffer;
197                 if (reply->sd_len)
198                 {
199                     *ResultLength = sizeof(SECURITY_DESCRIPTOR_RELATIVE) +
200                         sd->owner_len + sd->group_len + sd->sacl_len + sd->dacl_len;
201                     if (Length >= *ResultLength)
202                     {
203                         psd->Revision = SECURITY_DESCRIPTOR_REVISION;
204                         psd->Sbz1 = 0;
205                         psd->Control = sd->control | SE_SELF_RELATIVE;
206                         psd->Owner = sd->owner_len ? sizeof(SECURITY_DESCRIPTOR_RELATIVE) : 0;
207                         psd->Group = sd->group_len ? sizeof(SECURITY_DESCRIPTOR_RELATIVE) + sd->owner_len : 0;
208                         psd->Sacl = sd->sacl_len ? sizeof(SECURITY_DESCRIPTOR_RELATIVE) + sd->owner_len + sd->group_len : 0;
209                         psd->Dacl = sd->dacl_len ? sizeof(SECURITY_DESCRIPTOR_RELATIVE) + sd->owner_len + sd->group_len + sd->sacl_len : 0;
210                         /* owner, group, sacl and dacl are the same type as in the server
211                          * and in the same order so we copy the memory in one block */
212                         memcpy((char *)pSecurityDescriptor + sizeof(SECURITY_DESCRIPTOR_RELATIVE),
213                                buffer + sizeof(struct security_descriptor),
214                                sd->owner_len + sd->group_len + sd->sacl_len + sd->dacl_len);
215                     }
216                     else
217                         status = STATUS_BUFFER_TOO_SMALL;
218                 }
219                 else
220                 {
221                     *ResultLength = sizeof(SECURITY_DESCRIPTOR_RELATIVE);
222                     if (Length >= *ResultLength)
223                     {
224                         memset(psd, 0, sizeof(*psd));
225                         psd->Revision = SECURITY_DESCRIPTOR_REVISION;
226                         psd->Control = SE_SELF_RELATIVE;
227                     }
228                     else
229                         status = STATUS_BUFFER_TOO_SMALL;
230                 }
231             }
232             else if (status == STATUS_BUFFER_TOO_SMALL)
233             {
234                 buffer_size = reply->sd_len;
235                 need_more_memory = TRUE;
236             }
237         }
238         SERVER_END_REQ;
239         RtlFreeHeap(GetProcessHeap(), 0, buffer);
240     } while (need_more_memory);
241
242     return status;
243 }
244
245
246 /******************************************************************************
247  *  NtDuplicateObject           [NTDLL.@]
248  *  ZwDuplicateObject           [NTDLL.@]
249  */
250 NTSTATUS WINAPI NtDuplicateObject( HANDLE source_process, HANDLE source,
251                                    HANDLE dest_process, PHANDLE dest,
252                                    ACCESS_MASK access, ULONG attributes, ULONG options )
253 {
254     NTSTATUS ret;
255     SERVER_START_REQ( dup_handle )
256     {
257         req->src_process = source_process;
258         req->src_handle  = source;
259         req->dst_process = dest_process;
260         req->access      = access;
261         req->attributes  = attributes;
262         req->options     = options;
263
264         if (!(ret = wine_server_call( req )))
265         {
266             if (dest) *dest = reply->handle;
267             if (reply->closed)
268             {
269                 if (reply->self)
270                 {
271                     int fd = server_remove_fd_from_cache( source );
272                     if (fd != -1) close( fd );
273                 }
274             }
275             else if (options & DUPLICATE_CLOSE_SOURCE)
276                 WARN( "failed to close handle %p in process %p\n", source, source_process );
277         }
278     }
279     SERVER_END_REQ;
280     return ret;
281 }
282
283 /**************************************************************************
284  *                 NtClose                              [NTDLL.@]
285  *
286  * Close a handle reference to an object.
287  * 
288  * PARAMS
289  *  Handle [I] handle to close
290  *
291  * RETURNS
292  *  Success: ERROR_SUCCESS.
293  *  Failure: An NTSTATUS error code.
294  */
295 NTSTATUS WINAPI NtClose( HANDLE Handle )
296 {
297     NTSTATUS ret;
298     int fd = server_remove_fd_from_cache( Handle );
299
300     SERVER_START_REQ( close_handle )
301     {
302         req->handle = Handle;
303         ret = wine_server_call( req );
304     }
305     SERVER_END_REQ;
306     if (fd != -1) close( fd );
307     return ret;
308 }
309
310 /*
311  *      Directory functions
312  */
313
314 /**************************************************************************
315  * NtOpenDirectoryObject [NTDLL.@]
316  * ZwOpenDirectoryObject [NTDLL.@]
317  *
318  * Open a namespace directory object.
319  * 
320  * PARAMS
321  *  DirectoryHandle  [O] Destination for the new directory handle
322  *  DesiredAccess    [I] Desired access to the directory
323  *  ObjectAttributes [I] Structure describing the directory
324  *
325  * RETURNS
326  *  Success: ERROR_SUCCESS.
327  *  Failure: An NTSTATUS error code.
328  */
329 NTSTATUS WINAPI NtOpenDirectoryObject(PHANDLE DirectoryHandle, ACCESS_MASK DesiredAccess,
330                                       POBJECT_ATTRIBUTES ObjectAttributes)
331 {
332     NTSTATUS ret;
333     TRACE("(%p,0x%08x)\n", DirectoryHandle, DesiredAccess);
334     dump_ObjectAttributes(ObjectAttributes);
335
336     if (!DirectoryHandle) return STATUS_ACCESS_VIOLATION;
337     if (!ObjectAttributes) return STATUS_INVALID_PARAMETER;
338     /* Have to test it here because server won't know difference between
339      * ObjectName == NULL and ObjectName == "" */
340     if (!ObjectAttributes->ObjectName)
341     {
342         if (ObjectAttributes->RootDirectory)
343             return STATUS_OBJECT_NAME_INVALID;
344         else
345             return STATUS_OBJECT_PATH_SYNTAX_BAD;
346     }
347
348     SERVER_START_REQ(open_directory)
349     {
350         req->access = DesiredAccess;
351         req->attributes = ObjectAttributes->Attributes;
352         req->rootdir = ObjectAttributes->RootDirectory;
353         if (ObjectAttributes->ObjectName)
354             wine_server_add_data(req, ObjectAttributes->ObjectName->Buffer,
355                                  ObjectAttributes->ObjectName->Length);
356         ret = wine_server_call( req );
357         *DirectoryHandle = reply->handle;
358     }
359     SERVER_END_REQ;
360     return ret;
361 }
362
363 /******************************************************************************
364  *  NtCreateDirectoryObject     [NTDLL.@]
365  *  ZwCreateDirectoryObject     [NTDLL.@]
366  *
367  * Create a namespace directory object.
368  * 
369  * PARAMS
370  *  DirectoryHandle  [O] Destination for the new directory handle
371  *  DesiredAccess    [I] Desired access to the directory
372  *  ObjectAttributes [I] Structure describing the directory
373  *
374  * RETURNS
375  *  Success: ERROR_SUCCESS.
376  *  Failure: An NTSTATUS error code.
377  */
378 NTSTATUS WINAPI NtCreateDirectoryObject(PHANDLE DirectoryHandle, ACCESS_MASK DesiredAccess,
379                                         POBJECT_ATTRIBUTES ObjectAttributes)
380 {
381     NTSTATUS ret;
382     TRACE("(%p,0x%08x)\n", DirectoryHandle, DesiredAccess);
383     dump_ObjectAttributes(ObjectAttributes);
384
385     if (!DirectoryHandle) return STATUS_ACCESS_VIOLATION;
386
387     SERVER_START_REQ(create_directory)
388     {
389         req->access = DesiredAccess;
390         req->attributes = ObjectAttributes ? ObjectAttributes->Attributes : 0;
391         req->rootdir = ObjectAttributes ? ObjectAttributes->RootDirectory : 0;
392         if (ObjectAttributes && ObjectAttributes->ObjectName)
393             wine_server_add_data(req, ObjectAttributes->ObjectName->Buffer,
394                                  ObjectAttributes->ObjectName->Length);
395         ret = wine_server_call( req );
396         *DirectoryHandle = reply->handle;
397     }
398     SERVER_END_REQ;
399     return ret;
400 }
401
402 /******************************************************************************
403  * NtQueryDirectoryObject [NTDLL.@]
404  * ZwQueryDirectoryObject [NTDLL.@]
405  *
406  * Read information from a namespace directory.
407  * 
408  * PARAMS
409  *  handle        [I]   Handle to a directory object
410  *  buffer        [O]   Buffer to hold the read data
411  *  size          [I]   Size of the buffer in bytes
412  *  single_entry  [I]   If TRUE, return a single entry, if FALSE, return as many as fit in the buffer
413  *  restart       [I]   If TRUE, start scanning from the start, if FALSE, scan from Context
414  *  context       [I/O] Indicates what point of the directory the scan is at
415  *  ret_size      [O]   Caller supplied storage for the number of bytes written (or NULL)
416  *
417  * RETURNS
418  *  Success: ERROR_SUCCESS.
419  *  Failure: An NTSTATUS error code.
420  */
421 NTSTATUS WINAPI NtQueryDirectoryObject(HANDLE handle, PDIRECTORY_BASIC_INFORMATION buffer,
422                                        ULONG size, BOOLEAN single_entry, BOOLEAN restart,
423                                        PULONG context, PULONG ret_size)
424 {
425     NTSTATUS ret;
426
427     if (restart) *context = 0;
428
429     if (single_entry)
430     {
431         if (size <= sizeof(*buffer) + 2*sizeof(WCHAR)) return STATUS_BUFFER_OVERFLOW;
432
433         SERVER_START_REQ( get_directory_entry )
434         {
435             req->handle = handle;
436             req->index = *context;
437             wine_server_set_reply( req, buffer + 1, size - sizeof(*buffer) - 2*sizeof(WCHAR) );
438             if (!(ret = wine_server_call( req )))
439             {
440                 buffer->ObjectName.Buffer = (WCHAR *)(buffer + 1);
441                 buffer->ObjectName.Length = reply->name_len;
442                 buffer->ObjectName.MaximumLength = reply->name_len + sizeof(WCHAR);
443                 buffer->ObjectTypeName.Buffer = (WCHAR *)(buffer + 1) + reply->name_len/sizeof(WCHAR) + 1;
444                 buffer->ObjectTypeName.Length = wine_server_reply_size( reply ) - reply->name_len;
445                 buffer->ObjectTypeName.MaximumLength = buffer->ObjectTypeName.Length + sizeof(WCHAR);
446                 /* make room for the terminating null */
447                 memmove( buffer->ObjectTypeName.Buffer, buffer->ObjectTypeName.Buffer - 1,
448                          buffer->ObjectTypeName.Length );
449                 buffer->ObjectName.Buffer[buffer->ObjectName.Length/sizeof(WCHAR)] = 0;
450                 buffer->ObjectTypeName.Buffer[buffer->ObjectTypeName.Length/sizeof(WCHAR)] = 0;
451                 (*context)++;
452             }
453         }
454         SERVER_END_REQ;
455         if (ret_size)
456             *ret_size = buffer->ObjectName.MaximumLength + buffer->ObjectTypeName.MaximumLength + sizeof(*buffer);
457     }
458     else
459     {
460         FIXME("multiple entries not implemented\n");
461         ret = STATUS_NOT_IMPLEMENTED;
462     }
463
464     return ret;
465 }
466
467 /*
468  *      Link objects
469  */
470
471 /******************************************************************************
472  *  NtOpenSymbolicLinkObject    [NTDLL.@]
473  *  ZwOpenSymbolicLinkObject    [NTDLL.@]
474  *
475  * Open a namespace symbolic link object.
476  * 
477  * PARAMS
478  *  LinkHandle       [O] Destination for the new symbolic link handle
479  *  DesiredAccess    [I] Desired access to the symbolic link
480  *  ObjectAttributes [I] Structure describing the symbolic link
481  *
482  * RETURNS
483  *  Success: ERROR_SUCCESS.
484  *  Failure: An NTSTATUS error code.
485  */
486 NTSTATUS WINAPI NtOpenSymbolicLinkObject(OUT PHANDLE LinkHandle, IN ACCESS_MASK DesiredAccess,
487                                          IN POBJECT_ATTRIBUTES ObjectAttributes)
488 {
489     NTSTATUS ret;
490     TRACE("(%p,0x%08x,%p)\n",LinkHandle, DesiredAccess, ObjectAttributes);
491     dump_ObjectAttributes(ObjectAttributes);
492
493     if (!LinkHandle) return STATUS_ACCESS_VIOLATION;
494     if (!ObjectAttributes) return STATUS_INVALID_PARAMETER;
495     /* Have to test it here because server won't know difference between
496      * ObjectName == NULL and ObjectName == "" */
497     if (!ObjectAttributes->ObjectName)
498     {
499         if (ObjectAttributes->RootDirectory)
500             return STATUS_OBJECT_NAME_INVALID;
501         else
502             return STATUS_OBJECT_PATH_SYNTAX_BAD;
503     }
504
505     SERVER_START_REQ(open_symlink)
506     {
507         req->access = DesiredAccess;
508         req->attributes = ObjectAttributes->Attributes;
509         req->rootdir = ObjectAttributes->RootDirectory;
510         if (ObjectAttributes->ObjectName)
511             wine_server_add_data(req, ObjectAttributes->ObjectName->Buffer,
512                                  ObjectAttributes->ObjectName->Length);
513         ret = wine_server_call( req );
514         *LinkHandle = reply->handle;
515     }
516     SERVER_END_REQ;
517     return ret;
518 }
519
520 /******************************************************************************
521  *  NtCreateSymbolicLinkObject  [NTDLL.@]
522  *  ZwCreateSymbolicLinkObject  [NTDLL.@]
523  *
524  * Open a namespace symbolic link object.
525  * 
526  * PARAMS
527  *  SymbolicLinkHandle [O] Destination for the new symbolic link handle
528  *  DesiredAccess      [I] Desired access to the symbolic link
529  *  ObjectAttributes   [I] Structure describing the symbolic link
530  *  TargetName         [I] Name of the target symbolic link points to
531  *
532  * RETURNS
533  *  Success: ERROR_SUCCESS.
534  *  Failure: An NTSTATUS error code.
535  */
536 NTSTATUS WINAPI NtCreateSymbolicLinkObject(OUT PHANDLE SymbolicLinkHandle,IN ACCESS_MASK DesiredAccess,
537                                            IN POBJECT_ATTRIBUTES ObjectAttributes,
538                                            IN PUNICODE_STRING TargetName)
539 {
540     NTSTATUS ret;
541     TRACE("(%p,0x%08x,%p, -> %s)\n", SymbolicLinkHandle, DesiredAccess, ObjectAttributes,
542                                       debugstr_us(TargetName));
543     dump_ObjectAttributes(ObjectAttributes);
544
545     if (!SymbolicLinkHandle || !TargetName) return STATUS_ACCESS_VIOLATION;
546     if (!TargetName->Buffer) return STATUS_INVALID_PARAMETER;
547
548     SERVER_START_REQ(create_symlink)
549     {
550         req->access = DesiredAccess;
551         req->attributes = ObjectAttributes ? ObjectAttributes->Attributes : 0;
552         req->rootdir = ObjectAttributes ? ObjectAttributes->RootDirectory : 0;
553         if (ObjectAttributes && ObjectAttributes->ObjectName)
554         {
555             req->name_len = ObjectAttributes->ObjectName->Length;
556             wine_server_add_data(req, ObjectAttributes->ObjectName->Buffer,
557                                  ObjectAttributes->ObjectName->Length);
558         }
559         else
560             req->name_len = 0;
561         wine_server_add_data(req, TargetName->Buffer, TargetName->Length);
562         ret = wine_server_call( req );
563         *SymbolicLinkHandle = reply->handle;
564     }
565     SERVER_END_REQ;
566     return ret;
567 }
568
569 /******************************************************************************
570  *  NtQuerySymbolicLinkObject   [NTDLL.@]
571  *  ZwQuerySymbolicLinkObject   [NTDLL.@]
572  *
573  * Query a namespace symbolic link object target name.
574  * 
575  * PARAMS
576  *  LinkHandle     [I] Handle to a symbolic link object
577  *  LinkTarget     [O] Destination for the symbolic link target
578  *  ReturnedLength [O] Size of returned data
579  *
580  * RETURNS
581  *  Success: ERROR_SUCCESS.
582  *  Failure: An NTSTATUS error code.
583  */
584 NTSTATUS WINAPI NtQuerySymbolicLinkObject(IN HANDLE LinkHandle, IN OUT PUNICODE_STRING LinkTarget,
585                                           OUT PULONG ReturnedLength OPTIONAL)
586 {
587     NTSTATUS ret;
588     TRACE("(%p,%p,%p)\n", LinkHandle, LinkTarget, ReturnedLength);
589
590     if (!LinkTarget) return STATUS_ACCESS_VIOLATION;
591
592     SERVER_START_REQ(query_symlink)
593     {
594         req->handle = LinkHandle;
595         wine_server_set_reply( req, LinkTarget->Buffer, LinkTarget->MaximumLength );
596         if (!(ret = wine_server_call( req )))
597         {
598             LinkTarget->Length = wine_server_reply_size(reply);
599             if (ReturnedLength) *ReturnedLength = LinkTarget->Length;
600         }
601     }
602     SERVER_END_REQ;
603     return ret;
604 }
605
606 /******************************************************************************
607  *  NtAllocateUuids   [NTDLL.@]
608  */
609 NTSTATUS WINAPI NtAllocateUuids(
610         PULARGE_INTEGER Time,
611         PULONG Range,
612         PULONG Sequence)
613 {
614         FIXME("(%p,%p,%p), stub.\n", Time, Range, Sequence);
615         return 0;
616 }