ipconfig: Update German translation.
[wine/multimedia.git] / server / handle.c
blob2aaec37ed46aa603fc8f161ce22b9d87c6dea1bb
1 /*
2 * Server-side handle management
4 * Copyright (C) 1998 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 <assert.h>
25 #include <limits.h>
26 #include <string.h>
27 #include <stdarg.h>
28 #include <stdio.h>
29 #include <stdlib.h>
31 #include "ntstatus.h"
32 #define WIN32_NO_STATUS
33 #include "windef.h"
34 #include "winternl.h"
36 #include "handle.h"
37 #include "process.h"
38 #include "thread.h"
39 #include "security.h"
40 #include "request.h"
42 struct handle_entry
44 struct object *ptr; /* object */
45 unsigned int access; /* access rights */
48 struct handle_table
50 struct object obj; /* object header */
51 struct process *process; /* process owning this table */
52 int count; /* number of allocated entries */
53 int last; /* last used entry */
54 int free; /* first entry that may be free */
55 struct handle_entry *entries; /* handle entries */
58 static struct handle_table *global_table;
60 /* reserved handle access rights */
61 #define RESERVED_SHIFT 26
62 #define RESERVED_INHERIT (HANDLE_FLAG_INHERIT << RESERVED_SHIFT)
63 #define RESERVED_CLOSE_PROTECT (HANDLE_FLAG_PROTECT_FROM_CLOSE << RESERVED_SHIFT)
64 #define RESERVED_ALL (RESERVED_INHERIT | RESERVED_CLOSE_PROTECT)
66 #define MIN_HANDLE_ENTRIES 32
67 #define MAX_HANDLE_ENTRIES 0x00ffffff
70 /* handle to table index conversion */
72 /* handles are a multiple of 4 under NT; handle 0 is not used */
73 static inline obj_handle_t index_to_handle( int index )
75 return (obj_handle_t)((index + 1) << 2);
77 static inline int handle_to_index( obj_handle_t handle )
79 return (handle >> 2) - 1;
82 /* global handle conversion */
84 #define HANDLE_OBFUSCATOR 0x544a4def
86 static inline int handle_is_global( obj_handle_t handle)
88 return (handle ^ HANDLE_OBFUSCATOR) <= (MAX_HANDLE_ENTRIES << 2);
90 static inline obj_handle_t handle_local_to_global( obj_handle_t handle )
92 if (!handle) return 0;
93 return handle ^ HANDLE_OBFUSCATOR;
95 static inline obj_handle_t handle_global_to_local( obj_handle_t handle )
97 return handle ^ HANDLE_OBFUSCATOR;
101 static void handle_table_dump( struct object *obj, int verbose );
102 static void handle_table_destroy( struct object *obj );
104 static const struct object_ops handle_table_ops =
106 sizeof(struct handle_table), /* size */
107 handle_table_dump, /* dump */
108 no_get_type, /* get_type */
109 no_add_queue, /* add_queue */
110 NULL, /* remove_queue */
111 NULL, /* signaled */
112 NULL, /* satisfied */
113 no_signal, /* signal */
114 no_get_fd, /* get_fd */
115 no_map_access, /* map_access */
116 default_get_sd, /* get_sd */
117 default_set_sd, /* set_sd */
118 no_lookup_name, /* lookup_name */
119 no_open_file, /* open_file */
120 no_close_handle, /* close_handle */
121 handle_table_destroy /* destroy */
124 /* dump a handle table */
125 static void handle_table_dump( struct object *obj, int verbose )
127 int i;
128 struct handle_table *table = (struct handle_table *)obj;
129 struct handle_entry *entry = table->entries;
131 assert( obj->ops == &handle_table_ops );
133 fprintf( stderr, "Handle table last=%d count=%d process=%p\n",
134 table->last, table->count, table->process );
135 if (!verbose) return;
136 entry = table->entries;
137 for (i = 0; i <= table->last; i++, entry++)
139 if (!entry->ptr) continue;
140 fprintf( stderr, " %04x: %p %08x ",
141 index_to_handle(i), entry->ptr, entry->access );
142 entry->ptr->ops->dump( entry->ptr, 0 );
146 /* destroy a handle table */
147 static void handle_table_destroy( struct object *obj )
149 int i;
150 struct handle_table *table = (struct handle_table *)obj;
151 struct handle_entry *entry;
153 assert( obj->ops == &handle_table_ops );
155 /* first notify all objects that handles are being closed */
156 if (table->process)
158 for (i = 0, entry = table->entries; i <= table->last; i++, entry++)
160 struct object *obj = entry->ptr;
161 if (obj) obj->ops->close_handle( obj, table->process, index_to_handle(i) );
165 for (i = 0, entry = table->entries; i <= table->last; i++, entry++)
167 struct object *obj = entry->ptr;
168 entry->ptr = NULL;
169 if (obj) release_object( obj );
171 free( table->entries );
174 /* close all the process handles and free the handle table */
175 void close_process_handles( struct process *process )
177 struct handle_table *table = process->handles;
179 process->handles = NULL;
180 if (table) release_object( table );
183 /* allocate a new handle table */
184 struct handle_table *alloc_handle_table( struct process *process, int count )
186 struct handle_table *table;
188 if (count < MIN_HANDLE_ENTRIES) count = MIN_HANDLE_ENTRIES;
189 if (!(table = alloc_object( &handle_table_ops )))
190 return NULL;
191 table->process = process;
192 table->count = count;
193 table->last = -1;
194 table->free = 0;
195 if ((table->entries = mem_alloc( count * sizeof(*table->entries) ))) return table;
196 release_object( table );
197 return NULL;
200 /* grow a handle table */
201 static int grow_handle_table( struct handle_table *table )
203 struct handle_entry *new_entries;
204 int count = min( table->count * 2, MAX_HANDLE_ENTRIES );
206 if (count == table->count ||
207 !(new_entries = realloc( table->entries, count * sizeof(struct handle_entry) )))
209 set_error( STATUS_INSUFFICIENT_RESOURCES );
210 return 0;
212 table->entries = new_entries;
213 table->count = count;
214 return 1;
217 /* allocate the first free entry in the handle table */
218 static obj_handle_t alloc_entry( struct handle_table *table, void *obj, unsigned int access )
220 struct handle_entry *entry = table->entries + table->free;
221 int i;
223 for (i = table->free; i <= table->last; i++, entry++) if (!entry->ptr) goto found;
224 if (i >= table->count)
226 if (!grow_handle_table( table )) return 0;
227 entry = table->entries + i; /* the entries may have moved */
229 table->last = i;
230 found:
231 table->free = i + 1;
232 entry->ptr = grab_object( obj );
233 entry->access = access;
234 return index_to_handle(i);
237 /* allocate a handle for an object, incrementing its refcount */
238 /* return the handle, or 0 on error */
239 obj_handle_t alloc_handle_no_access_check( struct process *process, void *ptr, unsigned int access, unsigned int attr )
241 struct object *obj = ptr;
243 access &= ~RESERVED_ALL;
244 if (attr & OBJ_INHERIT) access |= RESERVED_INHERIT;
245 if (!process->handles)
247 set_error( STATUS_NO_MEMORY );
248 return 0;
250 return alloc_entry( process->handles, obj, access );
253 /* allocate a handle for an object, checking the dacl allows the process to */
254 /* access it and incrementing its refcount */
255 /* return the handle, or 0 on error */
256 obj_handle_t alloc_handle( struct process *process, void *ptr, unsigned int access, unsigned int attr )
258 struct object *obj = ptr;
259 access = obj->ops->map_access( obj, access );
260 if (access && !check_object_access( obj, &access )) return 0;
261 return alloc_handle_no_access_check( process, ptr, access, attr );
264 /* allocate a global handle for an object, incrementing its refcount */
265 /* return the handle, or 0 on error */
266 static obj_handle_t alloc_global_handle_no_access_check( void *obj, unsigned int access )
268 if (!global_table)
270 if (!(global_table = (struct handle_table *)alloc_handle_table( NULL, 0 )))
271 return 0;
272 make_object_static( &global_table->obj );
274 return handle_local_to_global( alloc_entry( global_table, obj, access ));
277 /* allocate a global handle for an object, checking the dacl allows the */
278 /* process to access it and incrementing its refcount and incrementing its refcount */
279 /* return the handle, or 0 on error */
280 static obj_handle_t alloc_global_handle( void *obj, unsigned int access )
282 if (access && !check_object_access( obj, &access )) return 0;
283 return alloc_global_handle_no_access_check( obj, access );
286 /* return a handle entry, or NULL if the handle is invalid */
287 static struct handle_entry *get_handle( struct process *process, obj_handle_t handle )
289 struct handle_table *table = process->handles;
290 struct handle_entry *entry;
291 int index;
293 if (handle_is_global(handle))
295 handle = handle_global_to_local(handle);
296 table = global_table;
298 if (!table) return NULL;
299 index = handle_to_index( handle );
300 if (index < 0) return NULL;
301 if (index > table->last) return NULL;
302 entry = table->entries + index;
303 if (!entry->ptr) return NULL;
304 return entry;
307 /* attempt to shrink a table */
308 static void shrink_handle_table( struct handle_table *table )
310 struct handle_entry *entry = table->entries + table->last;
311 struct handle_entry *new_entries;
312 int count = table->count;
314 while (table->last >= 0)
316 if (entry->ptr) break;
317 table->last--;
318 entry--;
320 if (table->last >= count / 4) return; /* no need to shrink */
321 if (count < MIN_HANDLE_ENTRIES * 2) return; /* too small to shrink */
322 count /= 2;
323 if (!(new_entries = realloc( table->entries, count * sizeof(*new_entries) ))) return;
324 table->count = count;
325 table->entries = new_entries;
328 /* copy the handle table of the parent process */
329 /* return 1 if OK, 0 on error */
330 struct handle_table *copy_handle_table( struct process *process, struct process *parent )
332 struct handle_table *parent_table = parent->handles;
333 struct handle_table *table;
334 int i;
336 assert( parent_table );
337 assert( parent_table->obj.ops == &handle_table_ops );
339 if (!(table = (struct handle_table *)alloc_handle_table( process, parent_table->count )))
340 return NULL;
342 if ((table->last = parent_table->last) >= 0)
344 struct handle_entry *ptr = table->entries;
345 memcpy( ptr, parent_table->entries, (table->last + 1) * sizeof(struct handle_entry) );
346 for (i = 0; i <= table->last; i++, ptr++)
348 if (!ptr->ptr) continue;
349 if (ptr->access & RESERVED_INHERIT) grab_object( ptr->ptr );
350 else ptr->ptr = NULL; /* don't inherit this entry */
353 /* attempt to shrink the table */
354 shrink_handle_table( table );
355 return table;
358 /* close a handle and decrement the refcount of the associated object */
359 unsigned int close_handle( struct process *process, obj_handle_t handle )
361 struct handle_table *table;
362 struct handle_entry *entry;
363 struct object *obj;
365 if (!(entry = get_handle( process, handle ))) return STATUS_INVALID_HANDLE;
366 if (entry->access & RESERVED_CLOSE_PROTECT) return STATUS_HANDLE_NOT_CLOSABLE;
367 obj = entry->ptr;
368 if (!obj->ops->close_handle( obj, process, handle )) return STATUS_HANDLE_NOT_CLOSABLE;
369 entry->ptr = NULL;
370 table = handle_is_global(handle) ? global_table : process->handles;
371 if (entry < table->entries + table->free) table->free = entry - table->entries;
372 if (entry == table->entries + table->last) shrink_handle_table( table );
373 release_object( obj );
374 return STATUS_SUCCESS;
377 /* retrieve the object corresponding to one of the magic pseudo-handles */
378 static inline struct object *get_magic_handle( obj_handle_t handle )
380 switch(handle)
382 case 0xfffffffe: /* current thread pseudo-handle */
383 return &current->obj;
384 case 0x7fffffff: /* current process pseudo-handle */
385 case 0xffffffff: /* current process pseudo-handle */
386 return (struct object *)current->process;
387 default:
388 return NULL;
392 /* retrieve the object corresponding to a handle, incrementing its refcount */
393 struct object *get_handle_obj( struct process *process, obj_handle_t handle,
394 unsigned int access, const struct object_ops *ops )
396 struct handle_entry *entry;
397 struct object *obj;
399 if (!(obj = get_magic_handle( handle )))
401 if (!(entry = get_handle( process, handle )))
403 set_error( STATUS_INVALID_HANDLE );
404 return NULL;
406 if ((entry->access & access) != access)
408 set_error( STATUS_ACCESS_DENIED );
409 return NULL;
411 obj = entry->ptr;
413 if (ops && (obj->ops != ops))
415 set_error( STATUS_OBJECT_TYPE_MISMATCH ); /* not the right type */
416 return NULL;
418 return grab_object( obj );
421 /* retrieve the access rights of a given handle */
422 unsigned int get_handle_access( struct process *process, obj_handle_t handle )
424 struct handle_entry *entry;
426 if (get_magic_handle( handle )) return ~RESERVED_ALL; /* magic handles have all access rights */
427 if (!(entry = get_handle( process, handle ))) return 0;
428 return entry->access & ~RESERVED_ALL;
431 /* find the first inherited handle of the given type */
432 /* this is needed for window stations and desktops (don't ask...) */
433 obj_handle_t find_inherited_handle( struct process *process, const struct object_ops *ops )
435 struct handle_table *table = process->handles;
436 struct handle_entry *ptr;
437 int i;
439 if (!table) return 0;
441 for (i = 0, ptr = table->entries; i <= table->last; i++, ptr++)
443 if (!ptr->ptr) continue;
444 if (ptr->ptr->ops != ops) continue;
445 if (ptr->access & RESERVED_INHERIT) return index_to_handle(i);
447 return 0;
450 /* enumerate handles of a given type */
451 /* this is needed for window stations and desktops */
452 obj_handle_t enumerate_handles( struct process *process, const struct object_ops *ops,
453 unsigned int *index )
455 struct handle_table *table = process->handles;
456 unsigned int i;
457 struct handle_entry *entry;
459 if (!table) return 0;
461 for (i = *index, entry = &table->entries[i]; i <= table->last; i++, entry++)
463 if (!entry->ptr) continue;
464 if (entry->ptr->ops != ops) continue;
465 *index = i + 1;
466 return index_to_handle(i);
468 return 0;
471 /* get/set the handle reserved flags */
472 /* return the old flags (or -1 on error) */
473 static int set_handle_flags( struct process *process, obj_handle_t handle, int mask, int flags )
475 struct handle_entry *entry;
476 unsigned int old_access;
478 if (get_magic_handle( handle ))
480 /* we can retrieve but not set info for magic handles */
481 if (mask) set_error( STATUS_ACCESS_DENIED );
482 return 0;
484 if (!(entry = get_handle( process, handle )))
486 set_error( STATUS_INVALID_HANDLE );
487 return -1;
489 old_access = entry->access;
490 mask = (mask << RESERVED_SHIFT) & RESERVED_ALL;
491 flags = (flags << RESERVED_SHIFT) & mask;
492 entry->access = (entry->access & ~mask) | flags;
493 return (old_access & RESERVED_ALL) >> RESERVED_SHIFT;
496 /* duplicate a handle */
497 obj_handle_t duplicate_handle( struct process *src, obj_handle_t src_handle, struct process *dst,
498 unsigned int access, unsigned int attr, unsigned int options )
500 obj_handle_t res;
501 struct handle_entry *entry;
502 unsigned int src_access;
503 struct object *obj = get_handle_obj( src, src_handle, 0, NULL );
505 if (!obj) return 0;
506 if ((entry = get_handle( src, src_handle )))
507 src_access = entry->access;
508 else /* pseudo-handle, give it full access */
509 src_access = obj->ops->map_access( obj, GENERIC_ALL );
510 src_access &= ~RESERVED_ALL;
512 if (options & DUP_HANDLE_SAME_ACCESS)
513 access = src_access;
514 else
515 access = obj->ops->map_access( obj, access ) & ~RESERVED_ALL;
517 /* asking for the more access rights than src_access? */
518 if (access & ~src_access)
520 if (options & DUP_HANDLE_MAKE_GLOBAL)
521 res = alloc_global_handle( obj, access );
522 else
523 res = alloc_handle( dst, obj, access, attr );
525 else
527 if (options & DUP_HANDLE_MAKE_GLOBAL)
528 res = alloc_global_handle_no_access_check( obj, access );
529 else
530 res = alloc_handle_no_access_check( dst, obj, access, attr );
533 release_object( obj );
534 return res;
537 /* open a new handle to an existing object */
538 obj_handle_t open_object( const struct namespace *namespace, const struct unicode_str *name,
539 const struct object_ops *ops, unsigned int access, unsigned int attr )
541 obj_handle_t handle = 0;
542 struct object *obj = find_object( namespace, name, attr );
543 if (obj)
545 if (ops && obj->ops != ops)
546 set_error( STATUS_OBJECT_TYPE_MISMATCH );
547 else
548 handle = alloc_handle( current->process, obj, access, attr );
549 release_object( obj );
551 else
552 set_error( STATUS_OBJECT_NAME_NOT_FOUND );
553 return handle;
556 /* return the size of the handle table of a given process */
557 unsigned int get_handle_table_count( struct process *process )
559 if (!process->handles) return 0;
560 return process->handles->count;
563 /* close a handle */
564 DECL_HANDLER(close_handle)
566 unsigned int err = close_handle( current->process, req->handle );
567 set_error( err );
570 /* set a handle information */
571 DECL_HANDLER(set_handle_info)
573 reply->old_flags = set_handle_flags( current->process, req->handle, req->mask, req->flags );
576 /* duplicate a handle */
577 DECL_HANDLER(dup_handle)
579 struct process *src, *dst;
581 reply->handle = 0;
582 if ((src = get_process_from_handle( req->src_process, PROCESS_DUP_HANDLE )))
584 if (req->options & DUP_HANDLE_MAKE_GLOBAL)
586 reply->handle = duplicate_handle( src, req->src_handle, NULL,
587 req->access, req->attributes, req->options );
589 else if ((dst = get_process_from_handle( req->dst_process, PROCESS_DUP_HANDLE )))
591 reply->handle = duplicate_handle( src, req->src_handle, dst,
592 req->access, req->attributes, req->options );
593 release_object( dst );
595 /* close the handle no matter what happened */
596 if (req->options & DUP_HANDLE_CLOSE_SOURCE) reply->closed = !close_handle( src, req->src_handle );
597 reply->self = (src == current->process);
598 release_object( src );
602 DECL_HANDLER(get_object_info)
604 struct object *obj;
605 WCHAR *name;
607 if (!(obj = get_handle_obj( current->process, req->handle, 0, NULL ))) return;
609 reply->access = get_handle_access( current->process, req->handle );
610 reply->ref_count = obj->refcount;
611 if ((name = get_object_full_name( obj, &reply->total )))
612 set_reply_data_ptr( name, min( reply->total, get_reply_max_size() ));
613 release_object( obj );
616 DECL_HANDLER(set_security_object)
618 data_size_t sd_size = get_req_data_size();
619 const struct security_descriptor *sd = get_req_data();
620 struct object *obj;
621 unsigned int access = 0;
623 if (!sd_is_valid( sd, sd_size ))
625 set_error( STATUS_ACCESS_VIOLATION );
626 return;
629 if (req->security_info & OWNER_SECURITY_INFORMATION ||
630 req->security_info & GROUP_SECURITY_INFORMATION)
631 access |= WRITE_OWNER;
632 if (req->security_info & SACL_SECURITY_INFORMATION)
633 access |= ACCESS_SYSTEM_SECURITY;
634 if (req->security_info & DACL_SECURITY_INFORMATION)
635 access |= WRITE_DAC;
637 if (!(obj = get_handle_obj( current->process, req->handle, access, NULL ))) return;
639 obj->ops->set_sd( obj, sd, req->security_info );
640 release_object( obj );
643 DECL_HANDLER(get_security_object)
645 const struct security_descriptor *sd;
646 struct object *obj;
647 unsigned int access = READ_CONTROL;
648 struct security_descriptor req_sd;
649 int present;
650 const SID *owner, *group;
651 const ACL *sacl, *dacl;
653 if (req->security_info & SACL_SECURITY_INFORMATION)
654 access |= ACCESS_SYSTEM_SECURITY;
656 if (!(obj = get_handle_obj( current->process, req->handle, access, NULL ))) return;
658 sd = obj->ops->get_sd( obj );
659 if (sd)
661 req_sd.control = sd->control & ~SE_SELF_RELATIVE;
663 owner = sd_get_owner( sd );
664 if (req->security_info & OWNER_SECURITY_INFORMATION)
665 req_sd.owner_len = sd->owner_len;
666 else
667 req_sd.owner_len = 0;
669 group = sd_get_group( sd );
670 if (req->security_info & GROUP_SECURITY_INFORMATION)
671 req_sd.group_len = sd->group_len;
672 else
673 req_sd.group_len = 0;
675 req_sd.control |= SE_SACL_PRESENT;
676 sacl = sd_get_sacl( sd, &present );
677 if (req->security_info & SACL_SECURITY_INFORMATION && present)
678 req_sd.sacl_len = sd->sacl_len;
679 else
680 req_sd.sacl_len = 0;
682 req_sd.control |= SE_DACL_PRESENT;
683 dacl = sd_get_dacl( sd, &present );
684 if (req->security_info & DACL_SECURITY_INFORMATION && present)
685 req_sd.dacl_len = sd->dacl_len;
686 else
687 req_sd.dacl_len = 0;
689 reply->sd_len = sizeof(req_sd) + req_sd.owner_len + req_sd.group_len +
690 req_sd.sacl_len + req_sd.dacl_len;
691 if (reply->sd_len <= get_reply_max_size())
693 char *ptr = set_reply_data_size(reply->sd_len);
695 memcpy( ptr, &req_sd, sizeof(req_sd) );
696 ptr += sizeof(req_sd);
697 memcpy( ptr, owner, req_sd.owner_len );
698 ptr += req_sd.owner_len;
699 memcpy( ptr, group, req_sd.group_len );
700 ptr += req_sd.group_len;
701 memcpy( ptr, sacl, req_sd.sacl_len );
702 ptr += req_sd.sacl_len;
703 memcpy( ptr, dacl, req_sd.dacl_len );
705 else
706 set_error(STATUS_BUFFER_TOO_SMALL);
709 release_object( obj );