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