msxml3: Properly free namespace structure pointer.
[wine/testsucceed.git] / dlls / ntdll / rtl.c
blob301b30c4f8139d036d1f7687f38070a729d495b4
1 /*
2 * NT basis DLL
4 * This file contains the Rtl* API functions. These should be implementable.
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)
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.
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.
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
26 #include "config.h"
27 #include "wine/port.h"
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"
42 WINE_DEFAULT_DEBUG_CHANNEL(ntdll);
44 static RTL_CRITICAL_SECTION peb_lock;
45 static RTL_CRITICAL_SECTION_DEBUG critsect_debug =
47 0, 0, &peb_lock,
48 { &critsect_debug.ProcessLocksList, &critsect_debug.ProcessLocksList },
49 0, 0, { (DWORD_PTR)(__FILE__ ": peb_lock") }
51 static RTL_CRITICAL_SECTION peb_lock = { &critsect_debug, -1, 0, 0, 0, 0 };
53 /* CRC polynomial 0xedb88320 */
54 static const DWORD CRC_table[256] =
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
102 * resource functions
105 /***********************************************************************
106 * RtlInitializeResource (NTDLL.@)
108 * xxxResource() functions implement multiple-reader-single-writer lock.
109 * The code is based on information published in WDJ January 1999 issue.
111 void WINAPI RtlInitializeResource(LPRTL_RWLOCK rwl)
113 if( rwl )
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 rwl->rtlCS.DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": RTL_RWLOCK.rtlCS");
122 NtCreateSemaphore( &rwl->hExclusiveReleaseSemaphore, SEMAPHORE_ALL_ACCESS, NULL, 0, 65535 );
123 NtCreateSemaphore( &rwl->hSharedReleaseSemaphore, SEMAPHORE_ALL_ACCESS, NULL, 0, 65535 );
128 /***********************************************************************
129 * RtlDeleteResource (NTDLL.@)
131 void WINAPI RtlDeleteResource(LPRTL_RWLOCK rwl)
133 if( rwl )
135 RtlEnterCriticalSection( &rwl->rtlCS );
136 if( rwl->iNumberActive || rwl->uExclusiveWaiters || rwl->uSharedWaiters )
137 MESSAGE("Deleting active MRSW lock (%p), expect failure\n", rwl );
138 rwl->hOwningThreadId = 0;
139 rwl->uExclusiveWaiters = rwl->uSharedWaiters = 0;
140 rwl->iNumberActive = 0;
141 NtClose( rwl->hExclusiveReleaseSemaphore );
142 NtClose( rwl->hSharedReleaseSemaphore );
143 RtlLeaveCriticalSection( &rwl->rtlCS );
144 rwl->rtlCS.DebugInfo->Spare[0] = 0;
145 RtlDeleteCriticalSection( &rwl->rtlCS );
150 /***********************************************************************
151 * RtlAcquireResourceExclusive (NTDLL.@)
153 BYTE WINAPI RtlAcquireResourceExclusive(LPRTL_RWLOCK rwl, BYTE fWait)
155 BYTE retVal = 0;
156 if( !rwl ) return 0;
158 start:
159 RtlEnterCriticalSection( &rwl->rtlCS );
160 if( rwl->iNumberActive == 0 ) /* lock is free */
162 rwl->iNumberActive = -1;
163 retVal = 1;
165 else if( rwl->iNumberActive < 0 ) /* exclusive lock in progress */
167 if( rwl->hOwningThreadId == ULongToHandle(GetCurrentThreadId()) )
169 retVal = 1;
170 rwl->iNumberActive--;
171 goto done;
173 wait:
174 if( fWait )
176 NTSTATUS status;
178 rwl->uExclusiveWaiters++;
180 RtlLeaveCriticalSection( &rwl->rtlCS );
181 status = NtWaitForSingleObject( rwl->hExclusiveReleaseSemaphore, FALSE, NULL );
182 if( HIWORD(status) )
183 goto done;
184 goto start; /* restart the acquisition to avoid deadlocks */
187 else /* one or more shared locks are in progress */
188 if( fWait )
189 goto wait;
191 if( retVal == 1 )
192 rwl->hOwningThreadId = ULongToHandle(GetCurrentThreadId());
193 done:
194 RtlLeaveCriticalSection( &rwl->rtlCS );
195 return retVal;
198 /***********************************************************************
199 * RtlAcquireResourceShared (NTDLL.@)
201 BYTE WINAPI RtlAcquireResourceShared(LPRTL_RWLOCK rwl, BYTE fWait)
203 NTSTATUS status = STATUS_UNSUCCESSFUL;
204 BYTE retVal = 0;
205 if( !rwl ) return 0;
207 start:
208 RtlEnterCriticalSection( &rwl->rtlCS );
209 if( rwl->iNumberActive < 0 )
211 if( rwl->hOwningThreadId == ULongToHandle(GetCurrentThreadId()) )
213 rwl->iNumberActive--;
214 retVal = 1;
215 goto done;
218 if( fWait )
220 rwl->uSharedWaiters++;
221 RtlLeaveCriticalSection( &rwl->rtlCS );
222 status = NtWaitForSingleObject( rwl->hSharedReleaseSemaphore, FALSE, NULL );
223 if( HIWORD(status) )
224 goto done;
225 goto start;
228 else
230 if( status != STATUS_WAIT_0 ) /* otherwise RtlReleaseResource() has already done it */
231 rwl->iNumberActive++;
232 retVal = 1;
234 done:
235 RtlLeaveCriticalSection( &rwl->rtlCS );
236 return retVal;
240 /***********************************************************************
241 * RtlReleaseResource (NTDLL.@)
243 void WINAPI RtlReleaseResource(LPRTL_RWLOCK rwl)
245 RtlEnterCriticalSection( &rwl->rtlCS );
247 if( rwl->iNumberActive > 0 ) /* have one or more readers */
249 if( --rwl->iNumberActive == 0 )
251 if( rwl->uExclusiveWaiters )
253 wake_exclusive:
254 rwl->uExclusiveWaiters--;
255 NtReleaseSemaphore( rwl->hExclusiveReleaseSemaphore, 1, NULL );
259 else
260 if( rwl->iNumberActive < 0 ) /* have a writer, possibly recursive */
262 if( ++rwl->iNumberActive == 0 )
264 rwl->hOwningThreadId = 0;
265 if( rwl->uExclusiveWaiters )
266 goto wake_exclusive;
267 else
268 if( rwl->uSharedWaiters )
270 UINT n = rwl->uSharedWaiters;
271 rwl->iNumberActive = rwl->uSharedWaiters; /* prevent new writers from joining until
272 * all queued readers have done their thing */
273 rwl->uSharedWaiters = 0;
274 NtReleaseSemaphore( rwl->hSharedReleaseSemaphore, n, NULL );
278 RtlLeaveCriticalSection( &rwl->rtlCS );
282 /***********************************************************************
283 * RtlDumpResource (NTDLL.@)
285 void WINAPI RtlDumpResource(LPRTL_RWLOCK rwl)
287 if( rwl )
289 MESSAGE("RtlDumpResource(%p):\n\tactive count = %i\n\twaiting readers = %i\n\twaiting writers = %i\n",
290 rwl, rwl->iNumberActive, rwl->uSharedWaiters, rwl->uExclusiveWaiters );
291 if( rwl->iNumberActive )
292 MESSAGE("\towner thread = %p\n", rwl->hOwningThreadId );
297 * misc functions
300 /******************************************************************************
301 * DbgPrint [NTDLL.@]
303 NTSTATUS WINAPIV DbgPrint(LPCSTR fmt, ...)
305 char buf[512];
306 __ms_va_list args;
308 __ms_va_start(args, fmt);
309 NTDLL__vsnprintf(buf, sizeof(buf), fmt, args);
310 __ms_va_end(args);
312 MESSAGE("DbgPrint says: %s",buf);
313 /* hmm, raise exception? */
314 return STATUS_SUCCESS;
318 /******************************************************************************
319 * DbgPrintEx [NTDLL.@]
321 NTSTATUS WINAPIV DbgPrintEx(ULONG iComponentId, ULONG Level, LPCSTR fmt, ...)
323 NTSTATUS ret;
324 __ms_va_list args;
326 __ms_va_start(args, fmt);
327 ret = vDbgPrintEx(iComponentId, Level, fmt, args);
328 __ms_va_end(args);
329 return ret;
332 /******************************************************************************
333 * vDbgPrintEx [NTDLL.@]
335 NTSTATUS WINAPI vDbgPrintEx( ULONG id, ULONG level, LPCSTR fmt, __ms_va_list args )
337 return vDbgPrintExWithPrefix( "", id, level, fmt, args );
340 /******************************************************************************
341 * vDbgPrintExWithPrefix [NTDLL.@]
343 NTSTATUS WINAPI vDbgPrintExWithPrefix( LPCSTR prefix, ULONG id, ULONG level, LPCSTR fmt, __ms_va_list args )
345 char buf[1024];
347 NTDLL__vsnprintf(buf, sizeof(buf), fmt, args);
349 switch (level & DPFLTR_MASK)
351 case DPFLTR_ERROR_LEVEL: ERR("%s%x: %s", prefix, id, buf); break;
352 case DPFLTR_WARNING_LEVEL: WARN("%s%x: %s", prefix, id, buf); break;
353 case DPFLTR_TRACE_LEVEL:
354 case DPFLTR_INFO_LEVEL:
355 default: TRACE("%s%x: %s", prefix, id, buf); break;
357 return STATUS_SUCCESS;
360 /******************************************************************************
361 * RtlAcquirePebLock [NTDLL.@]
363 VOID WINAPI RtlAcquirePebLock(void)
365 RtlEnterCriticalSection( &peb_lock );
368 /******************************************************************************
369 * RtlReleasePebLock [NTDLL.@]
371 VOID WINAPI RtlReleasePebLock(void)
373 RtlLeaveCriticalSection( &peb_lock );
376 /******************************************************************************
377 * RtlNewSecurityObject [NTDLL.@]
379 NTSTATUS WINAPI
380 RtlNewSecurityObject( PSECURITY_DESCRIPTOR ParentDescriptor,
381 PSECURITY_DESCRIPTOR CreatorDescriptor,
382 PSECURITY_DESCRIPTOR *NewDescriptor,
383 BOOLEAN IsDirectoryObject,
384 HANDLE Token,
385 PGENERIC_MAPPING GenericMapping )
387 FIXME("(%p %p %p %d %p %p) stub!\n", ParentDescriptor, CreatorDescriptor,
388 NewDescriptor, IsDirectoryObject, Token, GenericMapping);
389 return STATUS_NOT_IMPLEMENTED;
392 /******************************************************************************
393 * RtlDeleteSecurityObject [NTDLL.@]
395 NTSTATUS WINAPI
396 RtlDeleteSecurityObject( PSECURITY_DESCRIPTOR *ObjectDescriptor )
398 FIXME("(%p) stub!\n", ObjectDescriptor);
399 return STATUS_NOT_IMPLEMENTED;
402 /**************************************************************************
403 * _chkstk [NTDLL.@]
405 * Glorified "enter xxxx".
407 #ifdef __i386__
408 __ASM_STDCALL_FUNC( _chkstk, 0,
409 "negl %eax\n\t"
410 "addl %esp,%eax\n\t"
411 "xchgl %esp,%eax\n\t"
412 "movl 0(%eax),%eax\n\t" /* copy return address from old location */
413 "movl %eax,0(%esp)\n\t"
414 "ret" )
415 #endif
417 /**************************************************************************
418 * _alloca_probe [NTDLL.@]
420 * Glorified "enter xxxx".
422 #ifdef __i386__
423 __ASM_STDCALL_FUNC( _alloca_probe, 0,
424 "negl %eax\n\t"
425 "addl %esp,%eax\n\t"
426 "xchgl %esp,%eax\n\t"
427 "movl 0(%eax),%eax\n\t" /* copy return address from old location */
428 "movl %eax,0(%esp)\n\t"
429 "ret" )
430 #endif
433 /******************************************************************************
434 * RtlInitializeGenericTable [NTDLL.@]
436 PVOID WINAPI RtlInitializeGenericTable(PVOID pTable, PVOID arg2, PVOID arg3, PVOID arg4, PVOID arg5)
438 FIXME("(%p,%p,%p,%p,%p) stub!\n", pTable, arg2, arg3, arg4, arg5);
439 return NULL;
442 /******************************************************************************
443 * RtlEnumerateGenericTableWithoutSplaying [NTDLL.@]
445 PVOID RtlEnumerateGenericTableWithoutSplaying(PVOID pTable, PVOID *RestartKey)
447 static int warn_once;
449 if (!warn_once++)
450 FIXME("(%p,%p) stub!\n", pTable, RestartKey);
451 return NULL;
454 /******************************************************************************
455 * RtlNumberGenericTableElements [NTDLL.@]
457 ULONG RtlNumberGenericTableElements(PVOID pTable)
459 FIXME("(%p) stub!\n", pTable);
460 return 0;
463 /******************************************************************************
464 * RtlMoveMemory [NTDLL.@]
466 * Move a block of memory that may overlap.
468 * PARAMS
469 * Destination [O] End destination for block
470 * Source [O] Where to start copying from
471 * Length [I] Number of bytes to copy
473 * RETURNS
474 * Nothing.
476 #undef RtlMoveMemory
477 VOID WINAPI RtlMoveMemory( VOID *Destination, CONST VOID *Source, SIZE_T Length )
479 memmove(Destination, Source, Length);
482 /******************************************************************************
483 * RtlFillMemory [NTDLL.@]
485 * Set a block of memory with a value.
487 * PARAMS
488 * Destination [O] Block to fill
489 * Length [I] Number of bytes to fill
490 * Fill [I] Value to set
492 * RETURNS
493 * Nothing.
495 #undef RtlFillMemory
496 VOID WINAPI RtlFillMemory( VOID *Destination, SIZE_T Length, BYTE Fill )
498 memset(Destination, Fill, Length);
501 /******************************************************************************
502 * RtlZeroMemory [NTDLL.@]
504 * Set a block of memory with 0's.
506 * PARAMS
507 * Destination [O] Block to fill
508 * Length [I] Number of bytes to fill
510 * RETURNS
511 * Nothing.
513 #undef RtlZeroMemory
514 VOID WINAPI RtlZeroMemory( VOID *Destination, SIZE_T Length )
516 memset(Destination, 0, Length);
519 /******************************************************************************
520 * RtlCompareMemory [NTDLL.@]
522 * Compare one block of memory with another
524 * PARAMS
525 * Source1 [I] Source block
526 * Source2 [I] Block to compare to Source1
527 * Length [I] Number of bytes to compare
529 * RETURNS
530 * The length of the first byte at which Source1 and Source2 differ, or Length
531 * if they are the same.
533 SIZE_T WINAPI RtlCompareMemory( const VOID *Source1, const VOID *Source2, SIZE_T Length)
535 SIZE_T i;
536 for(i=0; (i<Length) && (((const BYTE*)Source1)[i]==((const BYTE*)Source2)[i]); i++);
537 return i;
540 /******************************************************************************
541 * RtlCompareMemoryUlong [NTDLL.@]
543 * Compare a block of memory with a value, a ULONG at a time
545 * PARAMS
546 * Source1 [I] Source block. This must be ULONG aligned
547 * Length [I] Number of bytes to compare. This should be a multiple of 4
548 * dwVal [I] Value to compare to
550 * RETURNS
551 * The byte position of the first byte at which Source1 is not dwVal.
553 SIZE_T WINAPI RtlCompareMemoryUlong(const ULONG *Source1, SIZE_T Length, ULONG dwVal)
555 SIZE_T i;
556 for(i = 0; i < Length/sizeof(ULONG) && Source1[i] == dwVal; i++);
557 return i * sizeof(ULONG);
560 /******************************************************************************
561 * RtlAssert [NTDLL.@]
563 * Fail a debug assertion.
565 * RETURNS
566 * Nothing. This call does not return control to its caller.
568 * NOTES
569 * Not implemented in non-debug versions.
571 void WINAPI RtlAssert(LPVOID x1,LPVOID x2,DWORD x3, DWORD x4)
573 FIXME("(%p,%p,0x%08x,0x%08x),stub\n",x1,x2,x3,x4);
576 /*************************************************************************
577 * RtlFillMemoryUlong [NTDLL.@]
579 * Fill memory with a 32 bit (dword) value.
581 * PARAMS
582 * lpDest [I] Bitmap pointer
583 * ulCount [I] Number of dwords to write
584 * ulValue [I] Value to fill with
586 * RETURNS
587 * Nothing.
589 VOID WINAPI RtlFillMemoryUlong(ULONG* lpDest, ULONG ulCount, ULONG ulValue)
591 TRACE("(%p,%d,%d)\n", lpDest, ulCount, ulValue);
593 ulCount /= sizeof(ULONG);
594 while(ulCount--)
595 *lpDest++ = ulValue;
598 /*********************************************************************
599 * RtlComputeCrc32 [NTDLL.@]
601 * Calculate the CRC32 checksum of a block of bytes
603 * PARAMS
604 * dwInitial [I] Initial CRC value
605 * pData [I] Data block
606 * iLen [I] Length of the byte block
608 * RETURNS
609 * The cumulative CRC32 of dwInitial and iLen bytes of the pData block.
611 DWORD WINAPI RtlComputeCrc32(DWORD dwInitial, const BYTE *pData, INT iLen)
613 DWORD crc = ~dwInitial;
615 TRACE("(%d,%p,%d)\n", dwInitial, pData, iLen);
617 while (iLen > 0)
619 crc = CRC_table[(crc ^ *pData) & 0xff] ^ (crc >> 8);
620 pData++;
621 iLen--;
623 return ~crc;
627 /*************************************************************************
628 * RtlUlonglongByteSwap [NTDLL.@]
630 * Swap the bytes of an unsigned long long value.
632 * PARAMS
633 * i [I] Value to swap bytes of
635 * RETURNS
636 * The value with its bytes swapped.
638 ULONGLONG __cdecl RtlUlonglongByteSwap(ULONGLONG i)
640 return ((ULONGLONG)RtlUlongByteSwap(i) << 32) | RtlUlongByteSwap(i>>32);
643 /*************************************************************************
644 * RtlUlongByteSwap [NTDLL.@]
646 * Swap the bytes of an unsigned int value.
648 * NOTES
649 * ix86 version takes argument in %ecx. Other systems use the inline version.
651 #ifdef __i386__
652 __ASM_GLOBAL_FUNC(NTDLL_RtlUlongByteSwap,
653 "movl %ecx,%eax\n\t"
654 "bswap %eax\n\t"
655 "ret")
656 #endif
658 /*************************************************************************
659 * RtlUshortByteSwap [NTDLL.@]
661 * Swap the bytes of an unsigned short value.
663 * NOTES
664 * i386 version takes argument in %cx. Other systems use the inline version.
666 #ifdef __i386__
667 __ASM_GLOBAL_FUNC(NTDLL_RtlUshortByteSwap,
668 "movb %ch,%al\n\t"
669 "movb %cl,%ah\n\t"
670 "ret")
671 #endif
674 /*************************************************************************
675 * RtlUniform [NTDLL.@]
677 * Generates an uniform random number
679 * PARAMS
680 * seed [O] The seed of the Random function
682 * RETURNS
683 * It returns a random number uniformly distributed over [0..MAXLONG-1].
685 * NOTES
686 * Generates an uniform random number using D.H. Lehmer's 1948 algorithm.
687 * In our case the algorithm is:
689 *| result = (*seed * 0x7fffffed + 0x7fffffc3) % MAXLONG;
691 *| *seed = result;
693 * DIFFERENCES
694 * The native documentation states that the random number is
695 * uniformly distributed over [0..MAXLONG]. In reality the native
696 * function and our function return a random number uniformly
697 * distributed over [0..MAXLONG-1].
699 ULONG WINAPI RtlUniform (PULONG seed)
701 ULONG result;
704 * Instead of the algorithm stated above, we use the algorithm
705 * below, which is totally equivalent (see the tests), but does
706 * not use a division and therefore is faster.
708 result = *seed * 0xffffffed + 0x7fffffc3;
709 if (result == 0xffffffff || result == 0x7ffffffe) {
710 result = (result + 2) & MAXLONG;
711 } else if (result == 0x7fffffff) {
712 result = 0;
713 } else if ((result & 0x80000000) == 0) {
714 result = result + (~result & 1);
715 } else {
716 result = (result + (result & 1)) & MAXLONG;
717 } /* if */
718 *seed = result;
719 return result;
723 /*************************************************************************
724 * RtlRandom [NTDLL.@]
726 * Generates a random number
728 * PARAMS
729 * seed [O] The seed of the Random function
731 * RETURNS
732 * It returns a random number distributed over [0..MAXLONG-1].
734 ULONG WINAPI RtlRandom (PULONG seed)
736 static ULONG saved_value[128] =
737 { /* 0 */ 0x4c8bc0aa, 0x4c022957, 0x2232827a, 0x2f1e7626, 0x7f8bdafb, 0x5c37d02a, 0x0ab48f72, 0x2f0c4ffa,
738 /* 8 */ 0x290e1954, 0x6b635f23, 0x5d3885c0, 0x74b49ff8, 0x5155fa54, 0x6214ad3f, 0x111e9c29, 0x242a3a09,
739 /* 16 */ 0x75932ae1, 0x40ac432e, 0x54f7ba7a, 0x585ccbd5, 0x6df5c727, 0x0374dad1, 0x7112b3f1, 0x735fc311,
740 /* 24 */ 0x404331a9, 0x74d97781, 0x64495118, 0x323e04be, 0x5974b425, 0x4862e393, 0x62389c1d, 0x28a68b82,
741 /* 32 */ 0x0f95da37, 0x7a50bbc6, 0x09b0091c, 0x22cdb7b4, 0x4faaed26, 0x66417ccd, 0x189e4bfa, 0x1ce4e8dd,
742 /* 40 */ 0x5274c742, 0x3bdcf4dc, 0x2d94e907, 0x32eac016, 0x26d33ca3, 0x60415a8a, 0x31f57880, 0x68c8aa52,
743 /* 48 */ 0x23eb16da, 0x6204f4a1, 0x373927c1, 0x0d24eb7c, 0x06dd7379, 0x2b3be507, 0x0f9c55b1, 0x2c7925eb,
744 /* 56 */ 0x36d67c9a, 0x42f831d9, 0x5e3961cb, 0x65d637a8, 0x24bb3820, 0x4d08e33d, 0x2188754f, 0x147e409e,
745 /* 64 */ 0x6a9620a0, 0x62e26657, 0x7bd8ce81, 0x11da0abb, 0x5f9e7b50, 0x23e444b6, 0x25920c78, 0x5fc894f0,
746 /* 72 */ 0x5e338cbb, 0x404237fd, 0x1d60f80f, 0x320a1743, 0x76013d2b, 0x070294ee, 0x695e243b, 0x56b177fd,
747 /* 80 */ 0x752492e1, 0x6decd52f, 0x125f5219, 0x139d2e78, 0x1898d11e, 0x2f7ee785, 0x4db405d8, 0x1a028a35,
748 /* 88 */ 0x63f6f323, 0x1f6d0078, 0x307cfd67, 0x3f32a78a, 0x6980796c, 0x462b3d83, 0x34b639f2, 0x53fce379,
749 /* 96 */ 0x74ba50f4, 0x1abc2c4b, 0x5eeaeb8d, 0x335a7a0d, 0x3973dd20, 0x0462d66b, 0x159813ff, 0x1e4643fd,
750 /* 104 */ 0x06bc5c62, 0x3115e3fc, 0x09101613, 0x47af2515, 0x4f11ec54, 0x78b99911, 0x3db8dd44, 0x1ec10b9b,
751 /* 112 */ 0x5b5506ca, 0x773ce092, 0x567be81a, 0x5475b975, 0x7a2cde1a, 0x494536f5, 0x34737bb4, 0x76d9750b,
752 /* 120 */ 0x2a1f6232, 0x2e49644d, 0x7dddcbe7, 0x500cebdb, 0x619dab9e, 0x48c626fe, 0x1cda3193, 0x52dabe9d };
753 ULONG rand;
754 int pos;
755 ULONG result;
757 rand = (*seed * 0x7fffffed + 0x7fffffc3) % 0x7fffffff;
758 *seed = (rand * 0x7fffffed + 0x7fffffc3) % 0x7fffffff;
759 pos = *seed & 0x7f;
760 result = saved_value[pos];
761 saved_value[pos] = rand;
762 return(result);
766 /*************************************************************************
767 * RtlAreAllAccessesGranted [NTDLL.@]
769 * Check if all desired accesses are granted
771 * RETURNS
772 * TRUE: All desired accesses are granted
773 * FALSE: Otherwise
775 BOOLEAN WINAPI RtlAreAllAccessesGranted(
776 ACCESS_MASK GrantedAccess,
777 ACCESS_MASK DesiredAccess)
779 return (GrantedAccess & DesiredAccess) == DesiredAccess;
783 /*************************************************************************
784 * RtlAreAnyAccessesGranted [NTDLL.@]
786 * Check if at least one of the desired accesses is granted
788 * PARAMS
789 * GrantedAccess [I] Access mask of granted accesses
790 * DesiredAccess [I] Access mask of desired accesses
792 * RETURNS
793 * TRUE: At least one of the desired accesses is granted
794 * FALSE: Otherwise
796 BOOLEAN WINAPI RtlAreAnyAccessesGranted(
797 ACCESS_MASK GrantedAccess,
798 ACCESS_MASK DesiredAccess)
800 return (GrantedAccess & DesiredAccess) != 0;
804 /*************************************************************************
805 * RtlMapGenericMask [NTDLL.@]
807 * Determine the nongeneric access rights specified by an access mask
809 * RETURNS
810 * Nothing.
812 void WINAPI RtlMapGenericMask(
813 PACCESS_MASK AccessMask,
814 const GENERIC_MAPPING *GenericMapping)
816 if (*AccessMask & GENERIC_READ) {
817 *AccessMask |= GenericMapping->GenericRead;
818 } /* if */
820 if (*AccessMask & GENERIC_WRITE) {
821 *AccessMask |= GenericMapping->GenericWrite;
822 } /* if */
824 if (*AccessMask & GENERIC_EXECUTE) {
825 *AccessMask |= GenericMapping->GenericExecute;
826 } /* if */
828 if (*AccessMask & GENERIC_ALL) {
829 *AccessMask |= GenericMapping->GenericAll;
830 } /* if */
832 *AccessMask &= 0x0FFFFFFF;
836 /*************************************************************************
837 * RtlCopyLuid [NTDLL.@]
839 * Copy a local unique ID.
841 * PARAMS
842 * LuidDest [O] Destination for the copied Luid
843 * LuidSrc [I] Source Luid to copy to LuidDest
845 * RETURNS
846 * Nothing.
848 void WINAPI RtlCopyLuid (PLUID LuidDest, const LUID *LuidSrc)
850 *LuidDest = *LuidSrc;
854 /*************************************************************************
855 * RtlEqualLuid [NTDLL.@]
857 * Compare two local unique ID's.
859 * PARAMS
860 * Luid1 [I] First Luid to compare to Luid2
861 * Luid2 [I] Second Luid to compare to Luid1
863 * RETURNS
864 * TRUE: The two LUID's are equal.
865 * FALSE: Otherwise
867 BOOLEAN WINAPI RtlEqualLuid (const LUID *Luid1, const LUID *Luid2)
869 return (Luid1->LowPart == Luid2->LowPart && Luid1->HighPart == Luid2->HighPart);
873 /*************************************************************************
874 * RtlCopyLuidAndAttributesArray [NTDLL.@]
876 * Copy an array of local unique ID's and attributes.
878 * PARAMS
879 * Count [I] Number of Luid/attributes in Src
880 * Src [I] Source Luid/attributes to copy
881 * Dest [O] Destination for copied Luid/attributes
883 * RETURNS
884 * Nothing.
886 * NOTES
887 * Dest must be large enough to hold Src.
889 void WINAPI RtlCopyLuidAndAttributesArray(
890 ULONG Count,
891 const LUID_AND_ATTRIBUTES *Src,
892 PLUID_AND_ATTRIBUTES Dest)
894 ULONG i;
896 for (i = 0; i < Count; i++) Dest[i] = Src[i];
899 NTSTATUS WINAPI RtlIpv4StringToAddressExW(PULONG IP, PULONG Port,
900 LPCWSTR Buffer, PULONG MaxSize)
902 FIXME("(%p,%p,%p,%p): stub\n", IP, Port, Buffer, MaxSize);
904 return STATUS_SUCCESS;
907 NTSTATUS WINAPI RtlIpv4AddressToStringExW (PULONG IP, PULONG Port,
908 LPWSTR Buffer, PULONG MaxSize)
910 FIXME("(%p,%p,%p,%p): stub\n", IP, Port, Buffer, MaxSize);
912 return STATUS_SUCCESS;
915 static DWORD_PTR get_pointer_obfuscator( void )
917 static DWORD_PTR pointer_obfuscator;
919 if (!pointer_obfuscator)
921 ULONG seed = NtGetTickCount();
922 ULONG_PTR rand;
924 /* generate a random value for the obfuscator */
925 rand = RtlUniform( &seed );
927 /* handle 64bit pointers */
928 rand ^= (ULONG_PTR)RtlUniform( &seed ) << ((sizeof (DWORD_PTR) - sizeof (ULONG))*8);
930 /* set the high bits so dereferencing obfuscated pointers will (usually) crash */
931 rand |= (ULONG_PTR)0xc0000000 << ((sizeof (DWORD_PTR) - sizeof (ULONG))*8);
933 interlocked_cmpxchg_ptr( (void**) &pointer_obfuscator, (void*) rand, NULL );
936 return pointer_obfuscator;
939 /*************************************************************************
940 * RtlEncodePointer [NTDLL.@]
942 PVOID WINAPI RtlEncodePointer( PVOID ptr )
944 DWORD_PTR ptrval = (DWORD_PTR) ptr;
945 return (PVOID)(ptrval ^ get_pointer_obfuscator());
948 PVOID WINAPI RtlDecodePointer( PVOID ptr )
950 DWORD_PTR ptrval = (DWORD_PTR) ptr;
951 return (PVOID)(ptrval ^ get_pointer_obfuscator());
954 /*************************************************************************
955 * RtlInitializeSListHead [NTDLL.@]
957 VOID WINAPI RtlInitializeSListHead(PSLIST_HEADER list)
959 #ifdef _WIN64
960 list->s.Alignment = list->s.Region = 0;
961 list->Header16.HeaderType = 1; /* we use the 16-byte header */
962 #else
963 list->Alignment = 0;
964 #endif
967 /*************************************************************************
968 * RtlQueryDepthSList [NTDLL.@]
970 WORD WINAPI RtlQueryDepthSList(PSLIST_HEADER list)
972 #ifdef _WIN64
973 return list->Header16.Depth;
974 #else
975 return list->s.Depth;
976 #endif
979 /*************************************************************************
980 * RtlFirstEntrySList [NTDLL.@]
982 PSLIST_ENTRY WINAPI RtlFirstEntrySList(const SLIST_HEADER* list)
984 #ifdef _WIN64
985 return (SLIST_ENTRY *)((ULONG_PTR)list->Header16.NextEntry << 4);
986 #else
987 return list->s.Next.Next;
988 #endif
991 /*************************************************************************
992 * RtlInterlockedFlushSList [NTDLL.@]
994 PSLIST_ENTRY WINAPI RtlInterlockedFlushSList(PSLIST_HEADER list)
996 SLIST_HEADER old, new;
998 #ifdef _WIN64
999 if (!list->Header16.Depth) return NULL;
1000 new.s.Alignment = new.s.Region = 0;
1001 new.Header16.HeaderType = 1; /* we use the 16-byte header */
1004 old = *list;
1005 new.Header16.Sequence = old.Header16.Sequence + 1;
1006 } while (!interlocked_cmpxchg128((__int64 *)list, new.s.Region, new.s.Alignment, (__int64 *)&old));
1007 return (SLIST_ENTRY *)((ULONG_PTR)old.Header16.NextEntry << 4);
1008 #else
1009 if (!list->s.Depth) return NULL;
1010 new.Alignment = 0;
1013 old = *list;
1014 new.s.Sequence = old.s.Sequence + 1;
1015 } while (interlocked_cmpxchg64((__int64 *)&list->Alignment, new.Alignment,
1016 old.Alignment) != old.Alignment);
1017 return old.s.Next.Next;
1018 #endif
1021 /*************************************************************************
1022 * RtlInterlockedPushEntrySList [NTDLL.@]
1024 PSLIST_ENTRY WINAPI RtlInterlockedPushEntrySList(PSLIST_HEADER list, PSLIST_ENTRY entry)
1026 SLIST_HEADER old, new;
1028 #ifdef _WIN64
1029 new.Header16.NextEntry = (ULONG_PTR)entry >> 4;
1032 old = *list;
1033 entry->Next = (SLIST_ENTRY *)((ULONG_PTR)old.Header16.NextEntry << 4);
1034 new.Header16.Depth = old.Header16.Depth + 1;
1035 new.Header16.Sequence = old.Header16.Sequence + 1;
1036 } while (!interlocked_cmpxchg128((__int64 *)list, new.s.Region, new.s.Alignment, (__int64 *)&old));
1037 return (SLIST_ENTRY *)((ULONG_PTR)old.Header16.NextEntry << 4);
1038 #else
1039 new.s.Next.Next = entry;
1042 old = *list;
1043 entry->Next = old.s.Next.Next;
1044 new.s.Depth = old.s.Depth + 1;
1045 new.s.Sequence = old.s.Sequence + 1;
1046 } while (interlocked_cmpxchg64((__int64 *)&list->Alignment, new.Alignment,
1047 old.Alignment) != old.Alignment);
1048 return old.s.Next.Next;
1049 #endif
1052 /*************************************************************************
1053 * RtlInterlockedPopEntrySList [NTDLL.@]
1055 PSLIST_ENTRY WINAPI RtlInterlockedPopEntrySList(PSLIST_HEADER list)
1057 SLIST_HEADER old, new;
1058 PSLIST_ENTRY entry;
1060 #ifdef _WIN64
1063 old = *list;
1064 if (!(entry = (SLIST_ENTRY *)((ULONG_PTR)old.Header16.NextEntry << 4))) return NULL;
1065 /* entry could be deleted by another thread */
1066 __TRY
1068 new.Header16.NextEntry = (ULONG_PTR)entry->Next >> 4;
1069 new.Header16.Depth = old.Header16.Depth - 1;
1070 new.Header16.Sequence = old.Header16.Sequence + 1;
1072 __EXCEPT_PAGE_FAULT
1075 __ENDTRY
1076 } while (!interlocked_cmpxchg128((__int64 *)list, new.s.Region, new.s.Alignment, (__int64 *)&old));
1077 #else
1080 old = *list;
1081 if (!(entry = old.s.Next.Next)) return NULL;
1082 /* entry could be deleted by another thread */
1083 __TRY
1085 new.s.Next.Next = entry->Next;
1086 new.s.Depth = old.s.Depth - 1;
1087 new.s.Sequence = old.s.Sequence + 1;
1089 __EXCEPT_PAGE_FAULT
1092 __ENDTRY
1093 } while (interlocked_cmpxchg64((__int64 *)&list->Alignment, new.Alignment,
1094 old.Alignment) != old.Alignment);
1095 #endif
1096 return entry;
1099 /*************************************************************************
1100 * RtlInterlockedPushListSList [NTDLL.@]
1102 PSLIST_ENTRY WINAPI RtlInterlockedPushListSList(PSLIST_HEADER list, PSLIST_ENTRY first,
1103 PSLIST_ENTRY last, ULONG count)
1105 SLIST_HEADER old, new;
1107 #ifdef _WIN64
1108 new.Header16.NextEntry = (ULONG_PTR)first >> 4;
1111 old = *list;
1112 new.Header16.Depth = old.Header16.Depth + count;
1113 new.Header16.Sequence = old.Header16.Sequence + 1;
1114 last->Next = (SLIST_ENTRY *)((ULONG_PTR)old.Header16.NextEntry << 4);
1115 } while (!interlocked_cmpxchg128((__int64 *)list, new.s.Region, new.s.Alignment, (__int64 *)&old));
1116 return (SLIST_ENTRY *)((ULONG_PTR)old.Header16.NextEntry << 4);
1117 #else
1118 new.s.Next.Next = first;
1121 old = *list;
1122 new.s.Depth = old.s.Depth + count;
1123 new.s.Sequence = old.s.Sequence + 1;
1124 last->Next = old.s.Next.Next;
1125 } while (interlocked_cmpxchg64((__int64 *)&list->Alignment, new.Alignment,
1126 old.Alignment) != old.Alignment);
1127 return old.s.Next.Next;
1128 #endif
1131 /******************************************************************************
1132 * RtlGetCompressionWorkSpaceSize [NTDLL.@]
1134 NTSTATUS WINAPI RtlGetCompressionWorkSpaceSize(USHORT CompressionFormatAndEngine,
1135 PULONG CompressBufferWorkSpaceSize,
1136 PULONG CompressFragmentWorkSpaceSize)
1138 FIXME("0x%04x, %p, %p: stub!\n", CompressionFormatAndEngine, CompressBufferWorkSpaceSize,
1139 CompressFragmentWorkSpaceSize);
1141 return STATUS_NOT_IMPLEMENTED;
1144 /******************************************************************************
1145 * RtlCompressBuffer [NTDLL.@]
1147 NTSTATUS WINAPI RtlCompressBuffer(USHORT CompressionFormatAndEngine, PUCHAR UncompressedBuffer,
1148 ULONG UncompressedBufferSize, PUCHAR CompressedBuffer,
1149 ULONG CompressedBufferSize, ULONG UncompressedChunkSize,
1150 PULONG FinalCompressedSize, PVOID WorkSpace)
1152 FIXME("0x%04x, %p, %u, %p, %u, %u, %p, %p :stub\n", CompressionFormatAndEngine, UncompressedBuffer,
1153 UncompressedBufferSize, CompressedBuffer, CompressedBufferSize, UncompressedChunkSize,
1154 FinalCompressedSize, WorkSpace);
1156 return STATUS_NOT_IMPLEMENTED;
1159 /******************************************************************************
1160 * RtlDecompressBuffer [NTDLL.@]
1162 NTSTATUS WINAPI RtlDecompressBuffer(USHORT CompressionFormat, PUCHAR UncompressedBuffer,
1163 ULONG UncompressedBufferSize, PUCHAR CompressedBuffer,
1164 ULONG CompressedBufferSize, PULONG FinalUncompressedSize)
1166 FIXME("0x%04x, %p, %u, %p, %u, %p :stub\n", CompressionFormat, UncompressedBuffer, UncompressedBufferSize,
1167 CompressedBuffer, CompressedBufferSize, FinalUncompressedSize);
1169 return STATUS_NOT_IMPLEMENTED;
1172 /***********************************************************************
1173 * RtlSetThreadErrorMode [NTDLL.@]
1175 * Set the thread local error mode.
1177 * PARAMS
1178 * mode [I] The new error mode
1179 * oldmode [O] Destination of the old error mode (may be NULL)
1181 * RETURNS
1182 * Success: STATUS_SUCCESS
1183 * Failure: STATUS_INVALID_PARAMETER_1
1185 NTSTATUS WINAPI RtlSetThreadErrorMode( DWORD mode, LPDWORD oldmode )
1187 if (mode & ~0x70)
1188 return STATUS_INVALID_PARAMETER_1;
1190 if (oldmode)
1191 *oldmode = NtCurrentTeb()->HardErrorDisabled;
1193 NtCurrentTeb()->HardErrorDisabled = mode;
1194 return STATUS_SUCCESS;
1197 /***********************************************************************
1198 * RtlGetThreadErrorMode [NTDLL.@]
1200 * Get the thread local error mode.
1202 * PARAMS
1203 * None.
1205 * RETURNS
1206 * The current thread local error mode.
1208 DWORD WINAPI RtlGetThreadErrorMode( void )
1210 return NtCurrentTeb()->HardErrorDisabled;