quartz: Use proper alloc/free functions for COM objects.
[wine] / dlls / ntdll / rtl.c
1 /*
2  * NT basis DLL
3  *
4  * This file contains the Rtl* API functions. These should be implementable.
5  *
6  * Copyright 1996-1998 Marcus Meissner
7  * Copyright 1999      Alex Korobka
8  * Copyright 2003      Thomas Mertes
9  * Crc32 code Copyright 1986 Gary S. Brown (Public domain)
10  *
11  * This library is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public
13  * License as published by the Free Software Foundation; either
14  * version 2.1 of the License, or (at your option) any later version.
15  *
16  * This library is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with this library; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25
26 #include "config.h"
27 #include "wine/port.h"
28
29 #include <stdlib.h>
30 #include <stdarg.h>
31 #include <stdio.h>
32 #include <string.h>
33 #include "ntstatus.h"
34 #define NONAMELESSSTRUCT
35 #define WIN32_NO_STATUS
36 #include "windef.h"
37 #include "winternl.h"
38 #include "wine/debug.h"
39 #include "wine/exception.h"
40 #include "ntdll_misc.h"
41
42 WINE_DEFAULT_DEBUG_CHANNEL(ntdll);
43
44 static RTL_CRITICAL_SECTION peb_lock;
45 static RTL_CRITICAL_SECTION_DEBUG critsect_debug =
46 {
47     0, 0, &peb_lock,
48     { &critsect_debug.ProcessLocksList, &critsect_debug.ProcessLocksList },
49       0, 0, { (DWORD_PTR)(__FILE__ ": peb_lock") }
50 };
51 static RTL_CRITICAL_SECTION peb_lock = { &critsect_debug, -1, 0, 0, 0, 0 };
52
53 /* CRC polynomial 0xedb88320 */
54 static const DWORD CRC_table[256] =
55 {
56     0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
57     0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
58     0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
59     0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
60     0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
61     0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
62     0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
63     0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
64     0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
65     0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
66     0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
67     0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
68     0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
69     0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
70     0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
71     0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
72     0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
73     0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
74     0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
75     0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
76     0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
77     0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
78     0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
79     0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
80     0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
81     0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
82     0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
83     0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
84     0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
85     0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
86     0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
87     0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
88     0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
89     0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
90     0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
91     0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
92     0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
93     0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
94     0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
95     0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
96     0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
97     0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
98     0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
99 };
100
101 /*
102  *      resource functions
103  */
104
105 /***********************************************************************
106  *           RtlInitializeResource      (NTDLL.@)
107  *
108  * xxxResource() functions implement multiple-reader-single-writer lock.
109  * The code is based on information published in WDJ January 1999 issue.
110  */
111 void WINAPI RtlInitializeResource(LPRTL_RWLOCK rwl)
112 {
113     if( rwl )
114     {
115         rwl->iNumberActive = 0;
116         rwl->uExclusiveWaiters = 0;
117         rwl->uSharedWaiters = 0;
118         rwl->hOwningThreadId = 0;
119         rwl->dwTimeoutBoost = 0; /* no info on this one, default value is 0 */
120         RtlInitializeCriticalSection( &rwl->rtlCS );
121         NtCreateSemaphore( &rwl->hExclusiveReleaseSemaphore, SEMAPHORE_ALL_ACCESS, NULL, 0, 65535 );
122         NtCreateSemaphore( &rwl->hSharedReleaseSemaphore, SEMAPHORE_ALL_ACCESS, NULL, 0, 65535 );
123     }
124 }
125
126
127 /***********************************************************************
128  *           RtlDeleteResource          (NTDLL.@)
129  */
130 void WINAPI RtlDeleteResource(LPRTL_RWLOCK rwl)
131 {
132     if( rwl )
133     {
134         RtlEnterCriticalSection( &rwl->rtlCS );
135         if( rwl->iNumberActive || rwl->uExclusiveWaiters || rwl->uSharedWaiters )
136             MESSAGE("Deleting active MRSW lock (%p), expect failure\n", rwl );
137         rwl->hOwningThreadId = 0;
138         rwl->uExclusiveWaiters = rwl->uSharedWaiters = 0;
139         rwl->iNumberActive = 0;
140         NtClose( rwl->hExclusiveReleaseSemaphore );
141         NtClose( rwl->hSharedReleaseSemaphore );
142         RtlLeaveCriticalSection( &rwl->rtlCS );
143         RtlDeleteCriticalSection( &rwl->rtlCS );
144     }
145 }
146
147
148 /***********************************************************************
149  *          RtlAcquireResourceExclusive (NTDLL.@)
150  */
151 BYTE WINAPI RtlAcquireResourceExclusive(LPRTL_RWLOCK rwl, BYTE fWait)
152 {
153     BYTE retVal = 0;
154     if( !rwl ) return 0;
155
156 start:
157     RtlEnterCriticalSection( &rwl->rtlCS );
158     if( rwl->iNumberActive == 0 ) /* lock is free */
159     {
160         rwl->iNumberActive = -1;
161         retVal = 1;
162     }
163     else if( rwl->iNumberActive < 0 ) /* exclusive lock in progress */
164     {
165          if( rwl->hOwningThreadId == (HANDLE)GetCurrentThreadId() )
166          {
167              retVal = 1;
168              rwl->iNumberActive--;
169              goto done;
170          }
171 wait:
172          if( fWait )
173          {
174              NTSTATUS status;
175
176              rwl->uExclusiveWaiters++;
177
178              RtlLeaveCriticalSection( &rwl->rtlCS );
179              status = NtWaitForSingleObject( rwl->hExclusiveReleaseSemaphore, FALSE, NULL );
180              if( HIWORD(status) )
181                  goto done;
182              goto start; /* restart the acquisition to avoid deadlocks */
183          }
184     }
185     else  /* one or more shared locks are in progress */
186          if( fWait )
187              goto wait;
188
189     if( retVal == 1 )
190         rwl->hOwningThreadId = (HANDLE)GetCurrentThreadId();
191 done:
192     RtlLeaveCriticalSection( &rwl->rtlCS );
193     return retVal;
194 }
195
196 /***********************************************************************
197  *          RtlAcquireResourceShared    (NTDLL.@)
198  */
199 BYTE WINAPI RtlAcquireResourceShared(LPRTL_RWLOCK rwl, BYTE fWait)
200 {
201     NTSTATUS status = STATUS_UNSUCCESSFUL;
202     BYTE retVal = 0;
203     if( !rwl ) return 0;
204
205 start:
206     RtlEnterCriticalSection( &rwl->rtlCS );
207     if( rwl->iNumberActive < 0 )
208     {
209         if( rwl->hOwningThreadId == (HANDLE)GetCurrentThreadId() )
210         {
211             rwl->iNumberActive--;
212             retVal = 1;
213             goto done;
214         }
215
216         if( fWait )
217         {
218             rwl->uSharedWaiters++;
219             RtlLeaveCriticalSection( &rwl->rtlCS );
220             status = NtWaitForSingleObject( rwl->hSharedReleaseSemaphore, FALSE, NULL );
221             if( HIWORD(status) )
222                 goto done;
223             goto start;
224         }
225     }
226     else
227     {
228         if( status != STATUS_WAIT_0 ) /* otherwise RtlReleaseResource() has already done it */
229             rwl->iNumberActive++;
230         retVal = 1;
231     }
232 done:
233     RtlLeaveCriticalSection( &rwl->rtlCS );
234     return retVal;
235 }
236
237
238 /***********************************************************************
239  *           RtlReleaseResource         (NTDLL.@)
240  */
241 void WINAPI RtlReleaseResource(LPRTL_RWLOCK rwl)
242 {
243     RtlEnterCriticalSection( &rwl->rtlCS );
244
245     if( rwl->iNumberActive > 0 ) /* have one or more readers */
246     {
247         if( --rwl->iNumberActive == 0 )
248         {
249             if( rwl->uExclusiveWaiters )
250             {
251 wake_exclusive:
252                 rwl->uExclusiveWaiters--;
253                 NtReleaseSemaphore( rwl->hExclusiveReleaseSemaphore, 1, NULL );
254             }
255         }
256     }
257     else
258     if( rwl->iNumberActive < 0 ) /* have a writer, possibly recursive */
259     {
260         if( ++rwl->iNumberActive == 0 )
261         {
262             rwl->hOwningThreadId = 0;
263             if( rwl->uExclusiveWaiters )
264                 goto wake_exclusive;
265             else
266                 if( rwl->uSharedWaiters )
267                 {
268                     UINT n = rwl->uSharedWaiters;
269                     rwl->iNumberActive = rwl->uSharedWaiters; /* prevent new writers from joining until
270                                                                * all queued readers have done their thing */
271                     rwl->uSharedWaiters = 0;
272                     NtReleaseSemaphore( rwl->hSharedReleaseSemaphore, n, NULL );
273                 }
274         }
275     }
276     RtlLeaveCriticalSection( &rwl->rtlCS );
277 }
278
279
280 /***********************************************************************
281  *           RtlDumpResource            (NTDLL.@)
282  */
283 void WINAPI RtlDumpResource(LPRTL_RWLOCK rwl)
284 {
285     if( rwl )
286     {
287         MESSAGE("RtlDumpResource(%p):\n\tactive count = %i\n\twaiting readers = %i\n\twaiting writers = %i\n",
288                 rwl, rwl->iNumberActive, rwl->uSharedWaiters, rwl->uExclusiveWaiters );
289         if( rwl->iNumberActive )
290             MESSAGE("\towner thread = %p\n", rwl->hOwningThreadId );
291     }
292 }
293
294 /*
295  *      misc functions
296  */
297
298 /******************************************************************************
299  *      DbgPrint        [NTDLL.@]
300  */
301 NTSTATUS WINAPIV DbgPrint(LPCSTR fmt, ...)
302 {
303   char buf[512];
304   va_list args;
305
306   va_start(args, fmt);
307   vsprintf(buf,fmt, args);
308   va_end(args);
309
310   MESSAGE("DbgPrint says: %s",buf);
311   /* hmm, raise exception? */
312   return STATUS_SUCCESS;
313 }
314
315
316 /******************************************************************************
317  *      DbgPrintEx      [NTDLL.@]
318  */
319 NTSTATUS WINAPIV DbgPrintEx(ULONG iComponentId, ULONG Level, LPCSTR fmt, ...)
320 {
321     NTSTATUS ret;
322     va_list args;
323
324     va_start(args, fmt);
325     ret = vDbgPrintEx(iComponentId, Level, fmt, args);
326     va_end(args);
327     return ret;
328 }
329
330 /******************************************************************************
331  *      vDbgPrintEx     [NTDLL.@]
332  */
333 NTSTATUS WINAPI vDbgPrintEx( ULONG id, ULONG level, LPCSTR fmt, va_list args )
334 {
335     return vDbgPrintExWithPrefix( "", id, level, fmt, args );
336 }
337
338 /******************************************************************************
339  *      vDbgPrintExWithPrefix  [NTDLL.@]
340  */
341 NTSTATUS WINAPI vDbgPrintExWithPrefix( LPCSTR prefix, ULONG id, ULONG level, LPCSTR fmt, va_list args )
342 {
343     char buf[1024];
344
345     vsprintf(buf, fmt, args);
346
347     switch (level & DPFLTR_MASK)
348     {
349     case DPFLTR_ERROR_LEVEL:   ERR("%s%x: %s", prefix, id, buf); break;
350     case DPFLTR_WARNING_LEVEL: WARN("%s%x: %s", prefix, id, buf); break;
351     case DPFLTR_TRACE_LEVEL:
352     case DPFLTR_INFO_LEVEL:
353     default:                   TRACE("%s%x: %s", prefix, id, buf); break;
354     }
355     return STATUS_SUCCESS;
356 }
357
358 /******************************************************************************
359  *  RtlAcquirePebLock           [NTDLL.@]
360  */
361 VOID WINAPI RtlAcquirePebLock(void)
362 {
363     RtlEnterCriticalSection( &peb_lock );
364 }
365
366 /******************************************************************************
367  *  RtlReleasePebLock           [NTDLL.@]
368  */
369 VOID WINAPI RtlReleasePebLock(void)
370 {
371     RtlLeaveCriticalSection( &peb_lock );
372 }
373
374 /******************************************************************************
375  *  RtlNewSecurityObject                [NTDLL.@]
376  */
377 NTSTATUS WINAPI
378 RtlNewSecurityObject( PSECURITY_DESCRIPTOR ParentDescriptor,
379                       PSECURITY_DESCRIPTOR CreatorDescriptor,
380                       PSECURITY_DESCRIPTOR *NewDescriptor,
381                       BOOLEAN IsDirectoryObject,
382                       HANDLE Token,
383                       PGENERIC_MAPPING GenericMapping )
384 {
385     FIXME("(%p %p %p %d %p %p) stub!\n", ParentDescriptor, CreatorDescriptor,
386           NewDescriptor, IsDirectoryObject, Token, GenericMapping);
387     return STATUS_NOT_IMPLEMENTED;
388 }
389
390 /******************************************************************************
391  *  RtlDeleteSecurityObject             [NTDLL.@]
392  */
393 NTSTATUS WINAPI
394 RtlDeleteSecurityObject( PSECURITY_DESCRIPTOR *ObjectDescriptor )
395 {
396     FIXME("(%p) stub!\n", ObjectDescriptor);
397     return STATUS_NOT_IMPLEMENTED;
398 }
399
400 /**************************************************************************
401  *                 _chkstk                              [NTDLL.@]
402  *
403  * Glorified "enter xxxx".
404  */
405 #ifdef __i386__
406 __ASM_GLOBAL_FUNC( _chkstk,
407                    "negl %eax\n\t"
408                    "addl %esp,%eax\n\t"
409                    "xchgl %esp,%eax\n\t"
410                    "movl 0(%eax),%eax\n\t"  /* copy return address from old location */
411                    "movl %eax,0(%esp)\n\t"
412                    "ret" )
413 #endif
414
415 /**************************************************************************
416  *                 _alloca_probe                        [NTDLL.@]
417  *
418  * Glorified "enter xxxx".
419  */
420 #ifdef __i386__
421 __ASM_GLOBAL_FUNC( _alloca_probe,
422                    "negl %eax\n\t"
423                    "addl %esp,%eax\n\t"
424                    "xchgl %esp,%eax\n\t"
425                    "movl 0(%eax),%eax\n\t"  /* copy return address from old location */
426                    "movl %eax,0(%esp)\n\t"
427                    "ret" )
428 #endif
429
430
431 /******************************************************************************
432  *  RtlInitializeGenericTable           [NTDLL.@]
433  */
434 PVOID WINAPI RtlInitializeGenericTable(PVOID pTable, PVOID arg2, PVOID arg3, PVOID arg4, PVOID arg5)
435 {
436   FIXME("(%p,%p,%p,%p,%p) stub!\n", pTable, arg2, arg3, arg4, arg5);
437   return NULL;
438 }
439
440 /******************************************************************************
441  *  RtlMoveMemory   [NTDLL.@]
442  *
443  * Move a block of memory that may overlap.
444  *
445  * PARAMS
446  *  Destination [O] End destination for block
447  *  Source      [O] Where to start copying from
448  *  Length      [I] Number of bytes to copy
449  *
450  * RETURNS
451  *  Nothing.
452  */
453 #undef RtlMoveMemory
454 VOID WINAPI RtlMoveMemory( VOID *Destination, CONST VOID *Source, SIZE_T Length )
455 {
456     memmove(Destination, Source, Length);
457 }
458
459 /******************************************************************************
460  *  RtlFillMemory   [NTDLL.@]
461  *
462  * Set a block of memory with a value.
463  *
464  * PARAMS
465  *  Destination [O] Block to fill
466  *  Length      [I] Number of bytes to fill
467  *  Fill        [I] Value to set
468  *
469  * RETURNS
470  *  Nothing.
471  */
472 #undef RtlFillMemory
473 VOID WINAPI RtlFillMemory( VOID *Destination, SIZE_T Length, BYTE Fill )
474 {
475     memset(Destination, Fill, Length);
476 }
477
478 /******************************************************************************
479  *  RtlZeroMemory   [NTDLL.@]
480  *
481  * Set a block of memory with 0's.
482  *
483  * PARAMS
484  *  Destination [O] Block to fill
485  *  Length      [I] Number of bytes to fill
486  *
487  * RETURNS
488  *  Nothing.
489  */
490 #undef RtlZeroMemory
491 VOID WINAPI RtlZeroMemory( VOID *Destination, SIZE_T Length )
492 {
493     memset(Destination, 0, Length);
494 }
495
496 /******************************************************************************
497  *  RtlCompareMemory   [NTDLL.@]
498  *
499  * Compare one block of memory with another
500  *
501  * PARAMS
502  *  Source1 [I] Source block
503  *  Source2 [I] Block to compare to Source1
504  *  Length  [I] Number of bytes to compare
505  *
506  * RETURNS
507  *  The length of the first byte at which Source1 and Source2 differ, or Length
508  *  if they are the same.
509  */
510 SIZE_T WINAPI RtlCompareMemory( const VOID *Source1, const VOID *Source2, SIZE_T Length)
511 {
512     SIZE_T i;
513     for(i=0; (i<Length) && (((const BYTE*)Source1)[i]==((const BYTE*)Source2)[i]); i++);
514     return i;
515 }
516
517 /******************************************************************************
518  *  RtlCompareMemoryUlong   [NTDLL.@]
519  *
520  * Compare a block of memory with a value, a ULONG at a time
521  *
522  * PARAMS
523  *  Source1 [I] Source block. This must be ULONG aligned
524  *  Length  [I] Number of bytes to compare. This should be a multiple of 4
525  *  dwVal   [I] Value to compare to
526  *
527  * RETURNS
528  *  The byte position of the first byte at which Source1 is not dwVal.
529  */
530 SIZE_T WINAPI RtlCompareMemoryUlong(const ULONG *Source1, SIZE_T Length, ULONG dwVal)
531 {
532     SIZE_T i;
533     for(i = 0; i < Length/sizeof(ULONG) && Source1[i] == dwVal; i++);
534     return i * sizeof(ULONG);
535 }
536
537 /******************************************************************************
538  *  RtlAssert                           [NTDLL.@]
539  *
540  * Fail a debug assertion.
541  *
542  * RETURNS
543  *  Nothing. This call does not return control to its caller.
544  *
545  * NOTES
546  * Not implemented in non-debug versions.
547  */
548 void WINAPI RtlAssert(LPVOID x1,LPVOID x2,DWORD x3, DWORD x4)
549 {
550         FIXME("(%p,%p,0x%08x,0x%08x),stub\n",x1,x2,x3,x4);
551 }
552
553 /*************************************************************************
554  * RtlFillMemoryUlong   [NTDLL.@]
555  *
556  * Fill memory with a 32 bit (dword) value.
557  *
558  * PARAMS
559  *  lpDest  [I] Bitmap pointer
560  *  ulCount [I] Number of dwords to write
561  *  ulValue [I] Value to fill with
562  *
563  * RETURNS
564  *  Nothing.
565  */
566 VOID WINAPI RtlFillMemoryUlong(ULONG* lpDest, ULONG ulCount, ULONG ulValue)
567 {
568   TRACE("(%p,%d,%d)\n", lpDest, ulCount, ulValue);
569
570   ulCount /= sizeof(ULONG);
571   while(ulCount--)
572     *lpDest++ = ulValue;
573 }
574
575 /*********************************************************************
576  *                  RtlComputeCrc32   [NTDLL.@]
577  *
578  * Calculate the CRC32 checksum of a block of bytes
579  *
580  * PARAMS
581  *  dwInitial [I] Initial CRC value
582  *  pData     [I] Data block
583  *  iLen      [I] Length of the byte block
584  *
585  * RETURNS
586  *  The cumulative CRC32 of dwInitial and iLen bytes of the pData block.
587  */
588 DWORD WINAPI RtlComputeCrc32(DWORD dwInitial, const BYTE *pData, INT iLen)
589 {
590   DWORD crc = ~dwInitial;
591
592   TRACE("(%d,%p,%d)\n", dwInitial, pData, iLen);
593
594   while (iLen > 0)
595   {
596     crc = CRC_table[(crc ^ *pData) & 0xff] ^ (crc >> 8);
597     pData++;
598     iLen--;
599   }
600   return ~crc;
601 }
602
603
604 /*************************************************************************
605  * RtlUlonglongByteSwap    [NTDLL.@]
606  *
607  * Swap the bytes of an unsigned long long value.
608  *
609  * PARAMS
610  *  i [I] Value to swap bytes of
611  *
612  * RETURNS
613  *  The value with its bytes swapped.
614  */
615 ULONGLONG __cdecl RtlUlonglongByteSwap(ULONGLONG i)
616 {
617   return ((ULONGLONG)RtlUlongByteSwap(i) << 32) | RtlUlongByteSwap(i>>32);
618 }
619
620 /*************************************************************************
621  * RtlUlongByteSwap    [NTDLL.@]
622  *
623  * Swap the bytes of an unsigned int value.
624  *
625  * NOTES
626  *  ix86 version takes argument in %ecx. Other systems use the inline version.
627  */
628 #ifdef __i386__
629 __ASM_GLOBAL_FUNC(NTDLL_RtlUlongByteSwap,
630                   "movl %ecx,%eax\n\t"
631                   "bswap %eax\n\t"
632                   "ret")
633 #endif
634
635 /*************************************************************************
636  * RtlUshortByteSwap    [NTDLL.@]
637  *
638  * Swap the bytes of an unsigned short value.
639  *
640  * NOTES
641  *  i386 version takes argument in %cx. Other systems use the inline version.
642  */
643 #ifdef __i386__
644 __ASM_GLOBAL_FUNC(NTDLL_RtlUshortByteSwap,
645                   "movb %ch,%al\n\t"
646                   "movb %cl,%ah\n\t"
647                   "ret")
648 #endif
649
650
651 /*************************************************************************
652  * RtlUniform   [NTDLL.@]
653  *
654  * Generates an uniform random number
655  *
656  * PARAMS
657  *  seed [O] The seed of the Random function
658  *
659  * RETURNS
660  *  It returns a random number uniformly distributed over [0..MAXLONG-1].
661  *
662  * NOTES
663  *  Generates an uniform random number using D.H. Lehmer's 1948 algorithm.
664  *  In our case the algorithm is:
665  *
666  *|  result = (*seed * 0x7fffffed + 0x7fffffc3) % MAXLONG;
667  *|
668  *|  *seed = result;
669  *
670  * DIFFERENCES
671  *  The native documentation states that the random number is
672  *  uniformly distributed over [0..MAXLONG]. In reality the native
673  *  function and our function return a random number uniformly
674  *  distributed over [0..MAXLONG-1].
675  */
676 ULONG WINAPI RtlUniform (PULONG seed)
677 {
678     ULONG result;
679
680    /*
681     * Instead of the algorithm stated above, we use the algorithm
682     * below, which is totally equivalent (see the tests), but does
683     * not use a division and therefore is faster.
684     */
685     result = *seed * 0xffffffed + 0x7fffffc3;
686     if (result == 0xffffffff || result == 0x7ffffffe) {
687         result = (result + 2) & MAXLONG;
688     } else if (result == 0x7fffffff) {
689         result = 0;
690     } else if ((result & 0x80000000) == 0) {
691         result = result + (~result & 1);
692     } else {
693         result = (result + (result & 1)) & MAXLONG;
694     } /* if */
695     *seed = result;
696     return result;
697 }
698
699
700 /*************************************************************************
701  * RtlRandom   [NTDLL.@]
702  *
703  * Generates a random number
704  *
705  * PARAMS
706  *  seed [O] The seed of the Random function
707  *
708  * RETURNS
709  *  It returns a random number distributed over [0..MAXLONG-1].
710  */
711 ULONG WINAPI RtlRandom (PULONG seed)
712 {
713     static ULONG saved_value[128] =
714     { /*   0 */ 0x4c8bc0aa, 0x4c022957, 0x2232827a, 0x2f1e7626, 0x7f8bdafb, 0x5c37d02a, 0x0ab48f72, 0x2f0c4ffa,
715       /*   8 */ 0x290e1954, 0x6b635f23, 0x5d3885c0, 0x74b49ff8, 0x5155fa54, 0x6214ad3f, 0x111e9c29, 0x242a3a09,
716       /*  16 */ 0x75932ae1, 0x40ac432e, 0x54f7ba7a, 0x585ccbd5, 0x6df5c727, 0x0374dad1, 0x7112b3f1, 0x735fc311,
717       /*  24 */ 0x404331a9, 0x74d97781, 0x64495118, 0x323e04be, 0x5974b425, 0x4862e393, 0x62389c1d, 0x28a68b82,
718       /*  32 */ 0x0f95da37, 0x7a50bbc6, 0x09b0091c, 0x22cdb7b4, 0x4faaed26, 0x66417ccd, 0x189e4bfa, 0x1ce4e8dd,
719       /*  40 */ 0x5274c742, 0x3bdcf4dc, 0x2d94e907, 0x32eac016, 0x26d33ca3, 0x60415a8a, 0x31f57880, 0x68c8aa52,
720       /*  48 */ 0x23eb16da, 0x6204f4a1, 0x373927c1, 0x0d24eb7c, 0x06dd7379, 0x2b3be507, 0x0f9c55b1, 0x2c7925eb,
721       /*  56 */ 0x36d67c9a, 0x42f831d9, 0x5e3961cb, 0x65d637a8, 0x24bb3820, 0x4d08e33d, 0x2188754f, 0x147e409e,
722       /*  64 */ 0x6a9620a0, 0x62e26657, 0x7bd8ce81, 0x11da0abb, 0x5f9e7b50, 0x23e444b6, 0x25920c78, 0x5fc894f0,
723       /*  72 */ 0x5e338cbb, 0x404237fd, 0x1d60f80f, 0x320a1743, 0x76013d2b, 0x070294ee, 0x695e243b, 0x56b177fd,
724       /*  80 */ 0x752492e1, 0x6decd52f, 0x125f5219, 0x139d2e78, 0x1898d11e, 0x2f7ee785, 0x4db405d8, 0x1a028a35,
725       /*  88 */ 0x63f6f323, 0x1f6d0078, 0x307cfd67, 0x3f32a78a, 0x6980796c, 0x462b3d83, 0x34b639f2, 0x53fce379,
726       /*  96 */ 0x74ba50f4, 0x1abc2c4b, 0x5eeaeb8d, 0x335a7a0d, 0x3973dd20, 0x0462d66b, 0x159813ff, 0x1e4643fd,
727       /* 104 */ 0x06bc5c62, 0x3115e3fc, 0x09101613, 0x47af2515, 0x4f11ec54, 0x78b99911, 0x3db8dd44, 0x1ec10b9b,
728       /* 112 */ 0x5b5506ca, 0x773ce092, 0x567be81a, 0x5475b975, 0x7a2cde1a, 0x494536f5, 0x34737bb4, 0x76d9750b,
729       /* 120 */ 0x2a1f6232, 0x2e49644d, 0x7dddcbe7, 0x500cebdb, 0x619dab9e, 0x48c626fe, 0x1cda3193, 0x52dabe9d };
730     ULONG rand;
731     int pos;
732     ULONG result;
733
734     rand = (*seed * 0x7fffffed + 0x7fffffc3) % 0x7fffffff;
735     *seed = (rand * 0x7fffffed + 0x7fffffc3) % 0x7fffffff;
736     pos = *seed & 0x7f;
737     result = saved_value[pos];
738     saved_value[pos] = rand;
739     return(result);
740 }
741
742
743 /*************************************************************************
744  * RtlAreAllAccessesGranted   [NTDLL.@]
745  *
746  * Check if all desired accesses are granted
747  *
748  * RETURNS
749  *  TRUE: All desired accesses are granted
750  *  FALSE: Otherwise
751  */
752 BOOLEAN WINAPI RtlAreAllAccessesGranted(
753     ACCESS_MASK GrantedAccess,
754     ACCESS_MASK DesiredAccess)
755 {
756     return (GrantedAccess & DesiredAccess) == DesiredAccess;
757 }
758
759
760 /*************************************************************************
761  * RtlAreAnyAccessesGranted   [NTDLL.@]
762  *
763  * Check if at least one of the desired accesses is granted
764  *
765  * PARAMS
766  *  GrantedAccess [I] Access mask of granted accesses
767  *  DesiredAccess [I] Access mask of desired accesses
768  *
769  * RETURNS
770  *  TRUE: At least one of the desired accesses is granted
771  *  FALSE: Otherwise
772  */
773 BOOLEAN WINAPI RtlAreAnyAccessesGranted(
774     ACCESS_MASK GrantedAccess,
775     ACCESS_MASK DesiredAccess)
776 {
777     return (GrantedAccess & DesiredAccess) != 0;
778 }
779
780
781 /*************************************************************************
782  * RtlMapGenericMask   [NTDLL.@]
783  *
784  * Determine the nongeneric access rights specified by an access mask
785  *
786  * RETURNS
787  *  Nothing.
788  */
789 void WINAPI RtlMapGenericMask(
790     PACCESS_MASK AccessMask,
791     const GENERIC_MAPPING *GenericMapping)
792 {
793     if (*AccessMask & GENERIC_READ) {
794         *AccessMask |= GenericMapping->GenericRead;
795     } /* if */
796
797     if (*AccessMask & GENERIC_WRITE) {
798         *AccessMask |= GenericMapping->GenericWrite;
799     } /* if */
800
801     if (*AccessMask & GENERIC_EXECUTE) {
802         *AccessMask |= GenericMapping->GenericExecute;
803     } /* if */
804
805     if (*AccessMask & GENERIC_ALL) {
806         *AccessMask |= GenericMapping->GenericAll;
807     } /* if */
808
809     *AccessMask &= 0x0FFFFFFF;
810 }
811
812
813 /*************************************************************************
814  * RtlCopyLuid   [NTDLL.@]
815  *
816  * Copy a local unique ID.
817  *
818  * PARAMS
819  *  LuidDest [O] Destination for the copied Luid
820  *  LuidSrc  [I] Source Luid to copy to LuidDest
821  *
822  * RETURNS
823  *  Nothing.
824  */
825 void WINAPI RtlCopyLuid (PLUID LuidDest, const LUID *LuidSrc)
826 {
827     *LuidDest = *LuidSrc;
828 }
829
830
831 /*************************************************************************
832  * RtlEqualLuid   [NTDLL.@]
833  *
834  * Compare two local unique ID's.
835  *
836  * PARAMS
837  *  Luid1 [I] First Luid to compare to Luid2
838  *  Luid2 [I] Second Luid to compare to Luid1
839  *
840  * RETURNS
841  *  TRUE: The two LUID's are equal.
842  *  FALSE: Otherwise
843  */
844 BOOLEAN WINAPI RtlEqualLuid (const LUID *Luid1, const LUID *Luid2)
845 {
846   return (Luid1->LowPart ==  Luid2->LowPart && Luid1->HighPart == Luid2->HighPart);
847 }
848
849
850 /*************************************************************************
851  * RtlCopyLuidAndAttributesArray   [NTDLL.@]
852  *
853  * Copy an array of local unique ID's and attributes.
854  *
855  * PARAMS
856  *  Count [I] Number of Luid/attributes in Src
857  *  Src   [I] Source Luid/attributes to copy
858  *  Dest  [O] Destination for copied Luid/attributes
859  *
860  * RETURNS
861  *  Nothing.
862  *
863  * NOTES
864  *  Dest must be large enough to hold Src.
865  */
866 void WINAPI RtlCopyLuidAndAttributesArray(
867     ULONG Count,
868     const LUID_AND_ATTRIBUTES *Src,
869     PLUID_AND_ATTRIBUTES Dest)
870 {
871     ULONG i;
872
873     for (i = 0; i < Count; i++) Dest[i] = Src[i];
874 }
875
876 NTSTATUS WINAPI RtlIpv4StringToAddressExW(PULONG IP, PULONG Port,
877                                           LPCWSTR Buffer, PULONG MaxSize)
878 {
879     FIXME("(%p,%p,%p,%p): stub\n", IP, Port, Buffer, MaxSize);
880
881     return STATUS_SUCCESS;
882 }
883
884 NTSTATUS WINAPI RtlIpv4AddressToStringExW (PULONG IP, PULONG Port,
885                                            LPWSTR Buffer, PULONG MaxSize)
886 {
887     FIXME("(%p,%p,%p,%p): stub\n", IP, Port, Buffer, MaxSize);
888
889     return STATUS_SUCCESS;
890 }
891
892 static DWORD_PTR get_pointer_obfuscator( void )
893 {
894     static DWORD_PTR pointer_obfuscator;
895
896     if (!pointer_obfuscator)
897     {
898         ULONG seed = NtGetTickCount();
899         ULONG_PTR rand;
900
901         /* generate a random value for the obfuscator */
902         rand = RtlUniform( &seed );
903
904         /* handle 64bit pointers */
905         rand ^= RtlUniform( &seed ) << ((sizeof (DWORD_PTR) - sizeof (ULONG))*8);
906
907         /* set the high bits so dereferencing obfuscated pointers will (usually) crash */
908         rand |= 0xc0000000 << ((sizeof (DWORD_PTR) - sizeof (ULONG))*8);
909
910         interlocked_cmpxchg_ptr( (void**) &pointer_obfuscator, (void*) rand, NULL );
911     }
912
913     return pointer_obfuscator;
914 }
915
916 /*************************************************************************
917  * RtlEncodePointer   [NTDLL.@]
918  */
919 PVOID WINAPI RtlEncodePointer( PVOID ptr )
920 {
921     DWORD_PTR ptrval = (DWORD_PTR) ptr;
922     return (PVOID)(ptrval ^ get_pointer_obfuscator());
923 }
924
925 PVOID WINAPI RtlDecodePointer( PVOID ptr )
926 {
927     DWORD_PTR ptrval = (DWORD_PTR) ptr;
928     return (PVOID)(ptrval ^ get_pointer_obfuscator());
929 }
930
931 VOID WINAPI RtlInitializeSListHead(PSLIST_HEADER ListHeader)
932 {
933     TRACE("(%p)\n", ListHeader);
934 #ifdef _WIN64
935     FIXME("stub\n");
936 #else
937     ListHeader->Alignment = 0;
938 #endif
939 }
940
941 WORD WINAPI RtlQueryDepthSList(PSLIST_HEADER ListHeader)
942 {
943     TRACE("(%p)\n", ListHeader);
944 #ifdef _WIN64
945     FIXME("stub\n");
946     return NULL;
947 #else
948     return ListHeader->s.Depth;
949 #endif
950 }
951
952 PSLIST_ENTRY WINAPI RtlFirstEntrySList(const SLIST_HEADER* ListHeader)
953 {
954     TRACE("(%p)\n", ListHeader);
955 #ifdef _WIN64
956     FIXME("stub\n");
957     return NULL;
958 #else
959     return ListHeader->s.Next.Next;
960 #endif
961 }
962
963 PSLIST_ENTRY WINAPI RtlInterlockedFlushSList(PSLIST_HEADER ListHeader)
964 {
965     SLIST_HEADER oldHeader, newHeader;
966     TRACE("(%p)\n", ListHeader);
967 #ifdef _WIN64
968     FIXME("stub\n");
969     return NULL;
970 #else
971     if (ListHeader->s.Depth == 0)
972         return NULL;
973     newHeader.Alignment = 0;
974     do
975     {
976         oldHeader = *ListHeader;
977         newHeader.s.Sequence = ListHeader->s.Sequence + 1;
978     } while (interlocked_cmpxchg64((__int64*)&ListHeader->Alignment,
979                                    newHeader.Alignment,
980                                    oldHeader.Alignment) != oldHeader.Alignment);
981     return oldHeader.s.Next.Next;
982 #endif
983 }
984
985 PSLIST_ENTRY WINAPI RtlInterlockedPushEntrySList(PSLIST_HEADER ListHeader,
986                                                  PSLIST_ENTRY ListEntry)
987 {
988     SLIST_HEADER oldHeader, newHeader;
989     TRACE("(%p, %p)\n", ListHeader, ListEntry);
990 #ifdef _WIN64
991     FIXME("stub\n");
992     return NULL;
993 #else
994     newHeader.s.Next.Next = ListEntry;
995     do
996     {
997         oldHeader = *ListHeader;
998         ListEntry->Next = ListHeader->s.Next.Next;
999         newHeader.s.Depth = ListHeader->s.Depth + 1;
1000         newHeader.s.Sequence = ListHeader->s.Sequence + 1;
1001     } while (interlocked_cmpxchg64((__int64*)&ListHeader->Alignment,
1002                                    newHeader.Alignment,
1003                                    oldHeader.Alignment) != oldHeader.Alignment);
1004     return oldHeader.s.Next.Next;
1005 #endif
1006 }
1007
1008 PSLIST_ENTRY WINAPI RtlInterlockedPopEntrySList(PSLIST_HEADER ListHeader)
1009 {
1010     SLIST_HEADER oldHeader, newHeader;
1011     PSLIST_ENTRY entry;
1012     TRACE("(%p)\n", ListHeader);
1013 #ifdef _WIN64
1014     FIXME("stub\n");
1015     return NULL;
1016 #else
1017     do
1018     {
1019         oldHeader = *ListHeader;
1020         entry = ListHeader->s.Next.Next;
1021         if (entry == NULL)
1022             return NULL;
1023         /* entry could be deleted by another thread */
1024         __TRY
1025         {
1026             newHeader.s.Next.Next = entry->Next;
1027             newHeader.s.Depth = ListHeader->s.Depth - 1;
1028             newHeader.s.Sequence = ListHeader->s.Sequence + 1;
1029         }
1030         __EXCEPT_PAGE_FAULT
1031         {
1032         }
1033         __ENDTRY
1034     } while (interlocked_cmpxchg64((__int64*)&ListHeader->Alignment,
1035                                    newHeader.Alignment,
1036                                    oldHeader.Alignment) != oldHeader.Alignment);
1037     return entry;
1038 #endif
1039 }
1040
1041 /*************************************************************************
1042  * RtlInterlockedPushListSList   [NTDLL.@]
1043  */
1044 PSLIST_ENTRY WINAPI RtlInterlockedPushListSList(PSLIST_HEADER ListHeader,
1045                                                 PSLIST_ENTRY FirstEntry,
1046                                                 PSLIST_ENTRY LastEntry,
1047                                                 ULONG Count)
1048 {
1049     SLIST_HEADER oldHeader, newHeader;
1050     TRACE("(%p, %p, %p, %d)\n", ListHeader, FirstEntry, LastEntry, Count);
1051 #ifdef _WIN64
1052     FIXME("stub\n");
1053     return NULL;
1054 #else
1055     newHeader.s.Next.Next = FirstEntry;
1056     do
1057     {
1058         oldHeader = *ListHeader;
1059         newHeader.s.Depth = ListHeader->s.Depth + Count;
1060         newHeader.s.Sequence = ListHeader->s.Sequence + 1;
1061         LastEntry->Next = ListHeader->s.Next.Next;
1062     } while (interlocked_cmpxchg64((__int64*)&ListHeader->Alignment,
1063                                    newHeader.Alignment,
1064                                    oldHeader.Alignment) != oldHeader.Alignment);
1065     return oldHeader.s.Next.Next;
1066 #endif
1067 }