Fixed CHECK_STRING display.
[wine/multimedia.git] / scheduler / handle.c
blob80257ccbf882fd11487a376dc9380668eb17695c
1 /*
2 * Win32 process handles
4 * Copyright 1998 Alexandre Julliard
5 */
7 #include <assert.h>
8 #include <stdio.h>
9 #include "winbase.h"
10 #include "winerror.h"
11 #include "heap.h"
12 #include "process.h"
13 #include "server.h"
14 #include "thread.h"
15 #include "debug.h"
17 #define HTABLE_SIZE 0x30 /* Handle table initial size */
18 #define HTABLE_INC 0x10 /* Handle table increment */
20 /* Reserved access rights */
21 #define RESERVED_ALL (0x0007 << RESERVED_SHIFT)
22 #define RESERVED_SHIFT 25
23 #define RESERVED_INHERIT (HANDLE_FLAG_INHERIT<<RESERVED_SHIFT)
24 #define RESERVED_CLOSE_PROTECT (HANDLE_FLAG_PROTECT_FROM_CLOSE<<RESERVED_SHIFT)
27 /***********************************************************************
28 * HANDLE_GrowTable
30 static BOOL32 HANDLE_GrowTable( PDB32 *process, INT32 incr )
32 HANDLE_TABLE *table;
34 SYSTEM_LOCK();
35 table = process->handle_table;
36 table = HeapReAlloc( process->system_heap,
37 HEAP_ZERO_MEMORY | HEAP_NO_SERIALIZE, table,
38 sizeof(HANDLE_TABLE) +
39 (table->count + incr - 1) * sizeof(HANDLE_ENTRY) );
40 if (table)
42 table->count += incr;
43 process->handle_table = table;
45 SYSTEM_UNLOCK();
46 return (table != NULL);
50 /***********************************************************************
51 * HANDLE_CreateTable
53 * Create a process handle table, optionally inheriting the parent's handles.
55 BOOL32 HANDLE_CreateTable( PDB32 *pdb, BOOL32 inherit )
57 DWORD size;
59 /* Process must not already have a handle table */
60 assert( !pdb->handle_table );
62 /* If this is the first process, simply allocate a table */
63 if (!pdb->parent) inherit = FALSE;
65 SYSTEM_LOCK();
66 size = inherit ? pdb->parent->handle_table->count : HTABLE_SIZE;
67 if ((pdb->handle_table = HeapAlloc( pdb->system_heap,
68 HEAP_ZERO_MEMORY | HEAP_NO_SERIALIZE,
69 sizeof(HANDLE_TABLE) +
70 (size-1) * sizeof(HANDLE_ENTRY) )))
72 pdb->handle_table->count = size;
73 if (inherit)
75 HANDLE_ENTRY *src = pdb->parent->handle_table->entries;
76 HANDLE_ENTRY *dst = pdb->handle_table->entries;
77 HANDLE32 h;
79 for (h = 0; h < size; h++, src++, dst++)
81 /* Check if handle is valid and inheritable */
82 if (src->ptr && (src->access & RESERVED_INHERIT))
84 dst->access = src->access;
85 dst->ptr = src->ptr;
86 dst->server = src->server;
87 K32OBJ_IncCount( dst->ptr );
91 /* Handle 1 is the process itself (unless the parent decided otherwise) */
92 if (!pdb->handle_table->entries[1].ptr)
94 pdb->handle_table->entries[1].ptr = &pdb->header;
95 pdb->handle_table->entries[1].access = PROCESS_ALL_ACCESS;
96 pdb->handle_table->entries[1].server = -1; /* FIXME */
97 K32OBJ_IncCount( &pdb->header );
100 SYSTEM_UNLOCK();
101 return (pdb->handle_table != NULL);
105 /***********************************************************************
106 * HANDLE_Alloc
108 * Allocate a handle for a kernel object and increment its refcount.
110 HANDLE32 HANDLE_Alloc( PDB32 *pdb, K32OBJ *ptr, DWORD access,
111 BOOL32 inherit, int server_handle )
113 HANDLE32 h;
114 HANDLE_ENTRY *entry;
116 assert( ptr );
118 /* Set the inherit reserved flag */
119 access &= ~RESERVED_ALL;
120 if (inherit) access |= RESERVED_INHERIT;
122 SYSTEM_LOCK();
123 K32OBJ_IncCount( ptr );
124 /* Don't try to allocate handle 0 */
125 entry = pdb->handle_table->entries + 1;
126 for (h = 1; h < pdb->handle_table->count; h++, entry++)
127 if (!entry->ptr) break;
128 if ((h < pdb->handle_table->count) || HANDLE_GrowTable( pdb, HTABLE_INC ))
130 entry = &pdb->handle_table->entries[h];
131 entry->access = access;
132 entry->ptr = ptr;
133 entry->server = server_handle;
134 SYSTEM_UNLOCK();
135 return h;
137 K32OBJ_DecCount( ptr );
138 SYSTEM_UNLOCK();
139 if (server_handle != -1) CLIENT_CloseHandle( server_handle );
140 SetLastError( ERROR_OUTOFMEMORY );
141 return INVALID_HANDLE_VALUE32;
145 /***********************************************************************
146 * HANDLE_GetObjPtr
148 * Retrieve a pointer to a kernel object and increments its reference count.
149 * The refcount must be decremented when the pointer is no longer used.
151 K32OBJ *HANDLE_GetObjPtr( PDB32 *pdb, HANDLE32 handle,
152 K32OBJ_TYPE type, DWORD access,
153 int *server_handle )
155 K32OBJ *ptr = NULL;
157 SYSTEM_LOCK();
158 if (HANDLE_IS_GLOBAL( handle ))
160 handle = HANDLE_GLOBAL_TO_LOCAL( handle );
161 pdb = PROCESS_Initial();
163 if ((handle > 0) && (handle < pdb->handle_table->count))
165 HANDLE_ENTRY *entry = &pdb->handle_table->entries[handle];
166 if ((entry->access & access) != access)
167 WARN(win32, "Handle %08x bad access (acc=%08lx req=%08lx)\n",
168 handle, entry->access, access );
169 ptr = entry->ptr;
170 if (server_handle) *server_handle = entry->server;
172 else if (handle == CURRENT_THREAD_PSEUDOHANDLE)
174 ptr = (K32OBJ *)THREAD_Current();
175 if (server_handle) *server_handle = CURRENT_THREAD_PSEUDOHANDLE;
177 else if (handle == CURRENT_PROCESS_PSEUDOHANDLE)
179 ptr = (K32OBJ *)PROCESS_Current();
180 if (server_handle) *server_handle = CURRENT_PROCESS_PSEUDOHANDLE;
183 if (ptr && ((type == K32OBJ_UNKNOWN) || (ptr->type == type)))
184 K32OBJ_IncCount( ptr );
185 else
186 ptr = NULL;
188 SYSTEM_UNLOCK();
189 if (!ptr) SetLastError( ERROR_INVALID_HANDLE );
190 return ptr;
194 /***********************************************************************
195 * HANDLE_GetServerHandle
197 * Retrieve the server handle associated to an object.
199 int HANDLE_GetServerHandle( PDB32 *pdb, HANDLE32 handle,
200 K32OBJ_TYPE type, DWORD access )
202 int server_handle;
203 K32OBJ *obj;
205 SYSTEM_LOCK();
206 if ((obj = HANDLE_GetObjPtr( pdb, handle, type, access, &server_handle )))
207 K32OBJ_DecCount( obj );
208 else
209 server_handle = -1;
210 SYSTEM_UNLOCK();
211 return server_handle;
215 /***********************************************************************
216 * HANDLE_SetObjPtr
218 * Change the object pointer of a handle, and increment the refcount.
219 * Use with caution!
221 BOOL32 HANDLE_SetObjPtr( PDB32 *pdb, HANDLE32 handle, K32OBJ *ptr,
222 DWORD access )
224 BOOL32 ret = FALSE;
226 SYSTEM_LOCK();
227 if ((handle > 0) && (handle < pdb->handle_table->count))
229 HANDLE_ENTRY *entry = &pdb->handle_table->entries[handle];
230 K32OBJ *old_ptr = entry->ptr;
231 K32OBJ_IncCount( ptr );
232 entry->access = access;
233 entry->ptr = ptr;
234 if (old_ptr) K32OBJ_DecCount( old_ptr );
235 ret = TRUE;
237 SYSTEM_UNLOCK();
238 if (!ret) SetLastError( ERROR_INVALID_HANDLE );
239 return ret;
243 /*********************************************************************
244 * HANDLE_GetAccess
246 static BOOL32 HANDLE_GetAccess( PDB32 *pdb, HANDLE32 handle, LPDWORD access )
248 BOOL32 ret = FALSE;
250 SYSTEM_LOCK();
251 if ((handle > 0) && (handle < pdb->handle_table->count))
253 HANDLE_ENTRY *entry = &pdb->handle_table->entries[handle];
254 if (entry->ptr)
256 *access = entry->access & ~RESERVED_ALL;
257 ret = TRUE;
260 SYSTEM_UNLOCK();
261 if (!ret) SetLastError( ERROR_INVALID_HANDLE );
262 return ret;
266 /*********************************************************************
267 * HANDLE_Close
269 static BOOL32 HANDLE_Close( PDB32 *pdb, HANDLE32 handle )
271 BOOL32 ret = FALSE;
272 K32OBJ *ptr;
274 if (HANDLE_IS_GLOBAL( handle ))
276 handle = HANDLE_GLOBAL_TO_LOCAL( handle );
277 pdb = PROCESS_Initial();
279 SYSTEM_LOCK();
280 if ((handle > 0) && (handle < pdb->handle_table->count))
282 HANDLE_ENTRY *entry = &pdb->handle_table->entries[handle];
283 if ((ptr = entry->ptr))
285 if (!(entry->access & RESERVED_CLOSE_PROTECT))
287 entry->access = 0;
288 entry->ptr = NULL;
289 if (entry->server != -1)
290 CLIENT_CloseHandle( entry->server );
291 K32OBJ_DecCount( ptr );
292 ret = TRUE;
294 /* FIXME: else SetLastError */
297 SYSTEM_UNLOCK();
298 if (!ret) SetLastError( ERROR_INVALID_HANDLE );
299 return ret;
303 /*********************************************************************
304 * HANDLE_CloseAll
306 * Close all handles pointing to a given object (or all handles of the
307 * process if the object is NULL)
309 void HANDLE_CloseAll( PDB32 *pdb, K32OBJ *obj )
311 HANDLE_ENTRY *entry;
312 K32OBJ *ptr;
313 HANDLE32 handle;
315 SYSTEM_LOCK();
316 entry = pdb->handle_table->entries;
317 for (handle = 0; handle < pdb->handle_table->count; handle++, entry++)
319 if (!(ptr = entry->ptr)) continue; /* empty slot */
320 if (obj && (ptr != obj)) continue; /* not the right object */
321 entry->access = 0;
322 entry->ptr = NULL;
323 if (entry->server != -1) CLIENT_CloseHandle( entry->server );
324 K32OBJ_DecCount( ptr );
326 SYSTEM_UNLOCK();
330 /*********************************************************************
331 * CloseHandle (KERNEL32.23)
333 BOOL32 WINAPI CloseHandle( HANDLE32 handle )
335 return HANDLE_Close( PROCESS_Current(), handle );
339 /*********************************************************************
340 * GetHandleInformation (KERNEL32.336)
342 BOOL32 WINAPI GetHandleInformation( HANDLE32 handle, LPDWORD flags )
344 BOOL32 ret = FALSE;
345 PDB32 *pdb = PROCESS_Current();
347 SYSTEM_LOCK();
348 if ((handle > 0) && (handle < pdb->handle_table->count))
350 HANDLE_ENTRY *entry = &pdb->handle_table->entries[handle];
351 if (entry->ptr)
353 if (flags)
354 *flags = (entry->access & RESERVED_ALL) >> RESERVED_SHIFT;
355 ret = TRUE;
358 SYSTEM_UNLOCK();
359 if (!ret) SetLastError( ERROR_INVALID_HANDLE );
360 return ret;
364 /*********************************************************************
365 * SetHandleInformation (KERNEL32.653)
367 BOOL32 WINAPI SetHandleInformation( HANDLE32 handle, DWORD mask, DWORD flags )
369 BOOL32 ret = FALSE;
370 PDB32 *pdb = PROCESS_Current();
372 mask = (mask << RESERVED_SHIFT) & RESERVED_ALL;
373 flags = (flags << RESERVED_SHIFT) & RESERVED_ALL;
374 SYSTEM_LOCK();
375 if ((handle > 0) && (handle < pdb->handle_table->count))
377 HANDLE_ENTRY *entry = &pdb->handle_table->entries[handle];
378 if (entry->ptr)
380 entry->access = (entry->access & ~mask) | flags;
381 ret = TRUE;
384 SYSTEM_UNLOCK();
385 if (!ret) SetLastError( ERROR_INVALID_HANDLE );
386 return ret;
390 /*********************************************************************
391 * DuplicateHandle (KERNEL32.192)
393 BOOL32 WINAPI DuplicateHandle( HANDLE32 source_process, HANDLE32 source,
394 HANDLE32 dest_process, HANDLE32 *dest,
395 DWORD access, BOOL32 inherit, DWORD options )
397 PDB32 *src_pdb = NULL, *dst_pdb = NULL;
398 K32OBJ *obj = NULL;
399 BOOL32 ret = FALSE;
400 HANDLE32 handle;
401 int src_process, src_handle, dst_process, dst_handle;
403 SYSTEM_LOCK();
405 if (!(src_pdb = PROCESS_GetPtr( source_process, PROCESS_DUP_HANDLE, &src_process )))
406 goto done;
407 if (!(obj = HANDLE_GetObjPtr( src_pdb, source, K32OBJ_UNKNOWN, 0, &src_handle )))
408 goto done;
410 /* Now that we are sure the source is valid, handle the options */
412 if (options & DUPLICATE_SAME_ACCESS)
413 HANDLE_GetAccess( src_pdb, source, &access );
414 if (options & DUPLICATE_CLOSE_SOURCE)
415 HANDLE_Close( src_pdb, source );
417 /* And duplicate the handle in the dest process */
419 if (!(dst_pdb = PROCESS_GetPtr( dest_process, PROCESS_DUP_HANDLE, &dst_process )))
420 goto done;
422 if ((src_process != -1) && (src_handle != -1) && (dst_process != -1))
423 dst_handle = CLIENT_DuplicateHandle( src_process, src_handle, dst_process, -1,
424 access, inherit, options );
425 else
426 dst_handle = -1;
428 if ((handle = HANDLE_Alloc( dst_pdb, obj, access, inherit,
429 dst_handle )) != INVALID_HANDLE_VALUE32)
431 if (dest) *dest = handle;
432 ret = TRUE;
435 done:
436 if (dst_pdb) K32OBJ_DecCount( &dst_pdb->header );
437 if (obj) K32OBJ_DecCount( obj );
438 if (src_pdb) K32OBJ_DecCount( &src_pdb->header );
439 SYSTEM_UNLOCK();
440 return ret;
444 /***********************************************************************
445 * ConvertToGlobalHandle (KERNEL32)
447 HANDLE32 WINAPI ConvertToGlobalHandle(HANDLE32 hSrc)
449 int src_handle, dst_handle;
450 HANDLE32 handle;
451 K32OBJ *obj = NULL;
452 DWORD access;
454 if (HANDLE_IS_GLOBAL(hSrc))
455 return hSrc;
457 if (!(obj = HANDLE_GetObjPtr( PROCESS_Current(), hSrc, K32OBJ_UNKNOWN, 0, &src_handle )))
458 return 0;
460 HANDLE_GetAccess( PROCESS_Current(), hSrc, &access );
462 if (src_handle != -1)
463 dst_handle = CLIENT_DuplicateHandle( GetCurrentProcess(), src_handle, -1, -1, 0, FALSE,
464 DUP_HANDLE_MAKE_GLOBAL | DUP_HANDLE_SAME_ACCESS );
465 else
466 dst_handle = -1;
468 if ((handle = HANDLE_Alloc( PROCESS_Initial(), obj, access, FALSE,
469 dst_handle )) != INVALID_HANDLE_VALUE32)
470 handle = HANDLE_LOCAL_TO_GLOBAL(handle);
471 else
472 handle = 0;
474 CloseHandle( hSrc );
475 return handle;