reactos/ntoskrnl/rtl/libsupp.c

   1 /*
   2  * COPYRIGHT:       See COPYING in the top level directory
   3  * PROJECT:         ReactOS kernel
   4  * FILE:            ntoskrnl/rtl/libsupp.c
   5  * PURPOSE:         RTL Support Routines
   6  * PROGRAMMERS:     Alex Ionescu (alex@relsoft.net)
   7  *                  Gunnar Dalsnes
   8  */
   9
  10 /* INCLUDES ******************************************************************/
  11
  12 #include <ntoskrnl.h>
  13 #define NDEBUG
  14 #include <debug.h>
  15
  16 #define TAG_ATMT 'TotA' /* Atom table */
  17
  18 extern ULONG NtGlobalFlag;
  19
  20 typedef struct _RTL_RANGE_ENTRY
  21 {
  22     LIST_ENTRY Entry;
  23     RTL_RANGE Range;
  24 } RTL_RANGE_ENTRY, *PRTL_RANGE_ENTRY;
  25
  26 PAGED_LOOKASIDE_LIST RtlpRangeListEntryLookasideList;
  27 SIZE_T RtlpAllocDeallocQueryBufferSize = 128;
  28
  29 /* FUNCTIONS *****************************************************************/
  30
  31 VOID
  32 NTAPI
  33 RtlInitializeRangeListPackage(VOID)
  34 {
  35     /* Setup the lookaside list for allocations (not used yet) */
  36     ExInitializePagedLookasideList(&RtlpRangeListEntryLookasideList,
  37                                    NULL,
  38                                    NULL,
  39                                    POOL_COLD_ALLOCATION,
  40                                    sizeof(RTL_RANGE_ENTRY),
  41                                    'elRR',
  42                                    16);
  43 }
  44
  45 BOOLEAN
  46 NTAPI
  47 RtlpCheckForActiveDebugger(BOOLEAN Type)
  48 {
  49     /* This check is meaningless in kernel-mode */
  50     return Type;
  51 }
  52
  53 BOOLEAN
  54 NTAPI
  55 RtlpSetInDbgPrint(IN BOOLEAN NewValue)
  56 {
  57     /* This check is meaningless in kernel-mode */
  58     return FALSE;
  59 }
  60
  61 KPROCESSOR_MODE
  62 NTAPI
  63 RtlpGetMode()
  64 {
  65    return KernelMode;
  66 }
  67
  68 PVOID
  69 NTAPI
  70 RtlpAllocateMemory(ULONG Bytes,
  71                    ULONG Tag)
  72 {
  73     return ExAllocatePoolWithTag(PagedPool,
  74                                  (SIZE_T)Bytes,
  75                                  Tag);
  76 }
  77
  78
  79 #define TAG_USTR        'RTSU'
  80 #define TAG_ASTR        'RTSA'
  81 #define TAG_OSTR        'RTSO'
  82 VOID
  83 NTAPI
  84 RtlpFreeMemory(PVOID Mem,
  85                ULONG Tag)
  86 {
  87     if (Tag == TAG_ASTR || Tag == TAG_OSTR || Tag == TAG_USTR)
  88         ExFreePool(Mem);
  89     else
  90         ExFreePoolWithTag(Mem, Tag);
  91 }
  92
  93 /*
  94  * @implemented
  95  */
  96 VOID NTAPI
  97 RtlAcquirePebLock(VOID)
  98 {
  99
 100 }
 101
 102 /*
 103  * @implemented
 104  */
 105 VOID NTAPI
 106 RtlReleasePebLock(VOID)
 107 {
 108
 109 }
 110
 111 NTSTATUS
 112 NTAPI
 113 LdrShutdownThread(VOID)
 114 {
 115     return STATUS_SUCCESS;
 116 }
 117
 118
 119 PPEB
 120 NTAPI
 121 RtlGetCurrentPeb(VOID)
 122 {
 123    return ((PEPROCESS)(KeGetCurrentThread()->ApcState.Process))->Peb;
 124 }
 125
 126 NTSTATUS
 127 NTAPI
 128 RtlDeleteHeapLock(
 129     PRTL_CRITICAL_SECTION CriticalSection)
 130 {
 131     ASSERT(FALSE);
 132     return STATUS_SUCCESS;
 133 }
 134
 135 NTSTATUS
 136 NTAPI
 137 RtlEnterHeapLock(
 138     PRTL_CRITICAL_SECTION CriticalSection)
 139 {
 140     ASSERT(FALSE);
 141     return STATUS_SUCCESS;
 142 }
 143
 144 NTSTATUS
 145 NTAPI
 146 RtlInitializeHeapLock(
 147     PRTL_CRITICAL_SECTION CriticalSection)
 148 {
 149    ASSERT(FALSE);
 150    return STATUS_SUCCESS;
 151 }
 152
 153 NTSTATUS
 154 NTAPI
 155 RtlLeaveHeapLock(
 156     PRTL_CRITICAL_SECTION CriticalSection)
 157 {
 158     ASSERT(FALSE);
 159     return STATUS_SUCCESS;
 160 }
 161
 162 #if DBG
 163 VOID FASTCALL
 164 CHECK_PAGED_CODE_RTL(char *file, int line)
 165 {
 166   if(KeGetCurrentIrql() > APC_LEVEL)
 167   {
 168     DbgPrint("%s:%i: Pagable code called at IRQL > APC_LEVEL (%d)\n", file, line, KeGetCurrentIrql());
 169     ASSERT(FALSE);
 170   }
 171 }
 172 #endif
 173
 174 VOID
 175 NTAPI
 176 RtlpCheckLogException(IN PEXCEPTION_RECORD ExceptionRecord,
 177                       IN PCONTEXT ContextRecord,
 178                       IN PVOID ContextData,
 179                       IN ULONG Size)
 180 {
 181     /* Check the global flag */
 182     if (NtGlobalFlag & FLG_ENABLE_EXCEPTION_LOGGING)
 183     {
 184         /* FIXME: Log this exception */
 185     }
 186 }
 187
 188 BOOLEAN
 189 NTAPI
 190 RtlpHandleDpcStackException(IN PEXCEPTION_REGISTRATION_RECORD RegistrationFrame,
 191                             IN ULONG_PTR RegistrationFrameEnd,
 192                             IN OUT PULONG_PTR StackLow,
 193                             IN OUT PULONG_PTR StackHigh)
 194 {
 195     PKPRCB Prcb;
 196     ULONG_PTR DpcStack;
 197
 198     /* Check if we are at DISPATCH or higher */
 199     if (KeGetCurrentIrql() >= DISPATCH_LEVEL)
 200     {
 201         /* Get the PRCB and DPC Stack */
 202         Prcb = KeGetCurrentPrcb();
 203         DpcStack = (ULONG_PTR)Prcb->DpcStack;
 204
 205         /* Check if we are in a DPC and the stack matches */
 206         if ((Prcb->DpcRoutineActive) &&
 207             (RegistrationFrameEnd <= DpcStack) &&
 208             ((ULONG_PTR)RegistrationFrame >= DpcStack - KERNEL_STACK_SIZE))
 209         {
 210             /* Update the limits to the DPC Stack's */
 211             *StackHigh = DpcStack;
 212             *StackLow = DpcStack - KERNEL_STACK_SIZE;
 213             return TRUE;
 214         }
 215     }
 216
 217     /* Not in DPC stack */
 218     return FALSE;
 219 }
 220
 221 #ifndef _ARM_
 222
 223 BOOLEAN
 224 NTAPI
 225 RtlpCaptureStackLimits(IN ULONG_PTR Ebp,
 226                        IN ULONG_PTR *StackBegin,
 227                        IN ULONG_PTR *StackEnd)
 228 {
 229     PKTHREAD Thread = KeGetCurrentThread();
 230
 231     /* Don't even try at ISR level or later */
 232     if (KeGetCurrentIrql() > DISPATCH_LEVEL) return FALSE;
 233
 234     /* Start with defaults */
 235     *StackBegin = Thread->StackLimit;
 236     *StackEnd = (ULONG_PTR)Thread->StackBase;
 237
 238     /* Check if EBP is inside the stack */
 239     if ((*StackBegin <= Ebp) && (Ebp <= *StackEnd))
 240     {
 241         /* Then make the stack start at EBP */
 242         *StackBegin = Ebp;
 243     }
 244     else
 245     {
 246         /* Now we're going to assume we're on the DPC stack */
 247         *StackEnd = (ULONG_PTR)(KeGetPcr()->Prcb->DpcStack);
 248         *StackBegin = *StackEnd - KERNEL_STACK_SIZE;
 249
 250         /* Check if we seem to be on the DPC stack */
 251         if ((*StackEnd) && (*StackBegin < Ebp) && (Ebp <= *StackEnd))
 252         {
 253             /* We're on the DPC stack */
 254             *StackBegin = Ebp;
 255         }
 256         else
 257         {
 258             /* We're somewhere else entirely... use EBP for safety */
 259             *StackBegin = Ebp;
 260             *StackEnd = (ULONG_PTR)PAGE_ALIGN(*StackBegin);
 261         }
 262     }
 263
 264     /* Return success */
 265     return TRUE;
 266 }
 267
 268 /*
 269  * @implemented
 270  */
 271 ULONG
 272 NTAPI
 273 RtlWalkFrameChain(OUT PVOID *Callers,
 274                   IN ULONG Count,
 275                   IN ULONG Flags)
 276 {
 277     ULONG_PTR Stack, NewStack, StackBegin, StackEnd = 0;
 278     ULONG Eip;
 279     BOOLEAN Result, StopSearch = FALSE;
 280     ULONG i = 0;
 281     PKTHREAD Thread = KeGetCurrentThread();
 282     PTEB Teb;
 283     PKTRAP_FRAME TrapFrame;
 284
 285     /* Get current EBP */
 286 #if defined(_M_IX86)
 287 #if defined __GNUC__
 288     __asm__("mov %%ebp, %0" : "=r" (Stack) : );
 289 #elif defined(_MSC_VER)
 290     __asm mov Stack, ebp
 291 #endif
 292 #elif defined(_M_MIPS)
 293         __asm__("move $sp, %0" : "=r" (Stack) : );
 294 #elif defined(_M_PPC)
 295     __asm__("mr %0,1" : "=r" (Stack) : );
 296 #elif defined(_M_ARM)
 297     __asm__("mov sp, %0" : "=r"(Stack) : );
 298 #else
 299 #error Unknown architecture
 300 #endif
 301
 302     /* Set it as the stack begin limit as well */
 303     StackBegin = (ULONG_PTR)Stack;
 304
 305     /* Check if we're called for non-logging mode */
 306     if (!Flags)
 307     {
 308         /* Get the actual safe limits */
 309         Result = RtlpCaptureStackLimits((ULONG_PTR)Stack,
 310                                         &StackBegin,
 311                                         &StackEnd);
 312         if (!Result) return 0;
 313     }
 314
 315     /* Use a SEH block for maximum protection */
 316     _SEH2_TRY
 317     {
 318         /* Check if we want the user-mode stack frame */
 319         if (Flags == 1)
 320         {
 321             /* Get the trap frame and TEB */
 322             TrapFrame = Thread->TrapFrame;
 323             Teb = Thread->Teb;
 324
 325             /* Make sure we can trust the TEB and trap frame */
 326             if (!(Teb) ||
 327                 !((PVOID)((ULONG_PTR)TrapFrame & 0x80000000)) ||
 328                 ((PVOID)TrapFrame <= (PVOID)Thread->StackLimit) ||
 329                 ((PVOID)TrapFrame >= (PVOID)Thread->StackBase) ||
 330                 (KeIsAttachedProcess()) ||
 331                 (KeGetCurrentIrql() >= DISPATCH_LEVEL))
 332             {
 333                 /* Invalid or unsafe attempt to get the stack */
 334                 return 0;
 335             }
 336
 337             /* Get the stack limits */
 338             StackBegin = (ULONG_PTR)Teb->Tib.StackLimit;
 339             StackEnd = (ULONG_PTR)Teb->Tib.StackBase;
 340 #ifdef _M_IX86
 341             Stack = TrapFrame->Ebp;
 342 #elif defined(_M_PPC)
 343             Stack = TrapFrame->Gpr1;
 344 #endif
 345
 346             /* Validate them */
 347             if (StackEnd <= StackBegin) return 0;
 348             ProbeForRead((PVOID)StackBegin,
 349                          StackEnd - StackBegin,
 350                          sizeof(CHAR));
 351         }
 352
 353         /* Loop the frames */
 354         for (i = 0; i < Count; i++)
 355         {
 356             /*
 357              * Leave if we're past the stack,
 358              * if we're before the stack,
 359              * or if we've reached ourselves.
 360              */
 361             if ((Stack >= StackEnd) ||
 362                 (!i ? (Stack < StackBegin) : (Stack <= StackBegin)) ||
 363                 ((StackEnd - Stack) < (2 * sizeof(ULONG_PTR))))
 364             {
 365                 /* We're done or hit a bad address */
 366                 break;
 367             }
 368
 369             /* Get new stack and EIP */
 370             NewStack = *(PULONG_PTR)Stack;
 371             Eip = *(PULONG_PTR)(Stack + sizeof(ULONG_PTR));
 372
 373             /* Check if the new pointer is above the oldone and past the end */
 374             if (!((Stack < NewStack) && (NewStack < StackEnd)))
 375             {
 376                 /* Stop searching after this entry */
 377                 StopSearch = TRUE;
 378             }
 379
 380             /* Also make sure that the EIP isn't a stack address */
 381             if ((StackBegin < Eip) && (Eip < StackEnd)) break;
 382
 383             /* Check if we reached a user-mode address */
 384             if (!(Flags) && !(Eip & 0x80000000)) break;
 385
 386             /* Save this frame */
 387             Callers[i] = (PVOID)Eip;
 388
 389             /* Check if we should continue */
 390             if (StopSearch)
 391             {
 392                 /* Return the next index */
 393                 i++;
 394                 break;
 395             }
 396
 397             /* Move to the next stack */
 398             Stack = NewStack;
 399         }
 400     }
 401     _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER)
 402     {
 403         /* No index */
 404         i = 0;
 405     }
 406     _SEH2_END;
 407
 408     /* Return frames parsed */
 409     return i;
 410 }
 411
 412 #endif
 413
 414 /* RTL Atom Tables ************************************************************/
 415
 416 NTSTATUS
 417 RtlpInitAtomTableLock(PRTL_ATOM_TABLE AtomTable)
 418 {
 419    ExInitializeFastMutex(&AtomTable->FastMutex);
 420
 421    return STATUS_SUCCESS;
 422 }
 423
 424
 425 VOID
 426 RtlpDestroyAtomTableLock(PRTL_ATOM_TABLE AtomTable)
 427 {
 428 }
 429
 430
 431 BOOLEAN
 432 RtlpLockAtomTable(PRTL_ATOM_TABLE AtomTable)
 433 {
 434    ExAcquireFastMutex(&AtomTable->FastMutex);
 435    return TRUE;
 436 }
 437
 438 VOID
 439 RtlpUnlockAtomTable(PRTL_ATOM_TABLE AtomTable)
 440 {
 441    ExReleaseFastMutex(&AtomTable->FastMutex);
 442 }
 443
 444 BOOLEAN
 445 RtlpCreateAtomHandleTable(PRTL_ATOM_TABLE AtomTable)
 446 {
 447    AtomTable->ExHandleTable = ExCreateHandleTable(NULL);
 448    return (AtomTable->ExHandleTable != NULL);
 449 }
 450
 451 VOID
 452 RtlpDestroyAtomHandleTable(PRTL_ATOM_TABLE AtomTable)
 453 {
 454    if (AtomTable->ExHandleTable)
 455    {
 456       ExSweepHandleTable(AtomTable->ExHandleTable,
 457                          NULL,
 458                          NULL);
 459       ExDestroyHandleTable(AtomTable->ExHandleTable, NULL);
 460       AtomTable->ExHandleTable = NULL;
 461    }
 462 }
 463
 464 PRTL_ATOM_TABLE
 465 RtlpAllocAtomTable(ULONG Size)
 466 {
 467    PRTL_ATOM_TABLE Table = ExAllocatePool(NonPagedPool,
 468                                           Size);
 469    if (Table != NULL)
 470    {
 471       RtlZeroMemory(Table,
 472                     Size);
 473    }
 474
 475    return Table;
 476 }
 477
 478 VOID
 479 RtlpFreeAtomTable(PRTL_ATOM_TABLE AtomTable)
 480 {
 481    ExFreePool(AtomTable);
 482 }
 483
 484 PRTL_ATOM_TABLE_ENTRY
 485 RtlpAllocAtomTableEntry(ULONG Size)
 486 {
 487     PRTL_ATOM_TABLE_ENTRY Entry;
 488
 489     Entry = ExAllocatePoolWithTag(NonPagedPool, Size, TAG_ATMT);
 490     if (Entry != NULL)
 491     {
 492         RtlZeroMemory(Entry, Size);
 493     }
 494
 495     return Entry;
 496 }
 497
 498 VOID
 499 RtlpFreeAtomTableEntry(PRTL_ATOM_TABLE_ENTRY Entry)
 500 {
 501     ExFreePoolWithTag(Entry, TAG_ATMT);
 502 }
 503
 504 VOID
 505 RtlpFreeAtomHandle(PRTL_ATOM_TABLE AtomTable, PRTL_ATOM_TABLE_ENTRY Entry)
 506 {
 507    ExDestroyHandle(AtomTable->ExHandleTable,
 508                    (HANDLE)((ULONG_PTR)Entry->HandleIndex << 2),
 509                    NULL);
 510 }
 511
 512 BOOLEAN
 513 RtlpCreateAtomHandle(PRTL_ATOM_TABLE AtomTable, PRTL_ATOM_TABLE_ENTRY Entry)
 514 {
 515    HANDLE_TABLE_ENTRY ExEntry;
 516    HANDLE Handle;
 517    USHORT HandleIndex;
 518
 519    /* Initialize ex handle table entry */
 520    ExEntry.Object = Entry;
 521    ExEntry.GrantedAccess = 0x1; /* FIXME - valid handle */
 522
 523    /* Create ex handle */
 524    Handle = ExCreateHandle(AtomTable->ExHandleTable,
 525                            &ExEntry);
 526    if (!Handle) return FALSE;
 527
 528    /* Calculate HandleIndex (by getting rid of the first two bits) */
 529    HandleIndex = (USHORT)((ULONG_PTR)Handle >> 2);
 530
 531    /* Index must be less than 0xC000 */
 532    if (HandleIndex >= 0xC000)
 533    {
 534        /* Destroy ex handle */
 535        ExDestroyHandle(AtomTable->ExHandleTable,
 536                        Handle,
 537                        NULL);
 538
 539        /* Return failure */
 540        return FALSE;
 541    }
 542
 543    /* Initialize atom table entry */
 544    Entry->HandleIndex = HandleIndex;
 545    Entry->Atom = 0xC000 + HandleIndex;
 546
 547    /* Return success */
 548    return TRUE;
 549 }
 550
 551 PRTL_ATOM_TABLE_ENTRY
 552 RtlpGetAtomEntry(PRTL_ATOM_TABLE AtomTable, ULONG Index)
 553 {
 554    PHANDLE_TABLE_ENTRY ExEntry;
 555    PRTL_ATOM_TABLE_ENTRY Entry = NULL;
 556
 557    /* NOTE: There's no need to explicitly enter a critical region because it's
 558             guaranteed that we're in a critical region right now (as we hold
 559             the atom table lock) */
 560
 561    ExEntry = ExMapHandleToPointer(AtomTable->ExHandleTable,
 562                                   (HANDLE)((ULONG_PTR)Index << 2));
 563    if (ExEntry != NULL)
 564    {
 565       Entry = ExEntry->Object;
 566
 567       ExUnlockHandleTableEntry(AtomTable->ExHandleTable,
 568                                ExEntry);
 569    }
 570
 571    return Entry;
 572 }
 573
 574 /*
 575  * Ldr Resource support code
 576  */
 577
 578 IMAGE_RESOURCE_DIRECTORY *find_entry_by_name( IMAGE_RESOURCE_DIRECTORY *dir,
 579                                               LPCWSTR name, void *root,
 580                                               int want_dir );
 581 IMAGE_RESOURCE_DIRECTORY *find_entry_by_id( IMAGE_RESOURCE_DIRECTORY *dir,
 582                                             USHORT id, void *root, int want_dir );
 583 IMAGE_RESOURCE_DIRECTORY *find_first_entry( IMAGE_RESOURCE_DIRECTORY *dir,
 584                                             void *root, int want_dir );
 585
 586 /**********************************************************************
 587  *  find_entry
 588  *
 589  * Find a resource entry
 590  */
 591 NTSTATUS find_entry( PVOID BaseAddress, LDR_RESOURCE_INFO *info,
 592                      ULONG level, void **ret, int want_dir )
 593 {
 594     ULONG size;
 595     void *root;
 596     IMAGE_RESOURCE_DIRECTORY *resdirptr;
 597
 598     root = RtlImageDirectoryEntryToData( BaseAddress, TRUE, IMAGE_DIRECTORY_ENTRY_RESOURCE, &size );
 599     if (!root) return STATUS_RESOURCE_DATA_NOT_FOUND;
 600     resdirptr = root;
 601
 602     if (!level--) goto done;
 603     if (!(*ret = find_entry_by_name( resdirptr, (LPCWSTR)info->Type, root, want_dir || level )))
 604         return STATUS_RESOURCE_TYPE_NOT_FOUND;
 605     if (!level--) return STATUS_SUCCESS;
 606
 607     resdirptr = *ret;
 608     if (!(*ret = find_entry_by_name( resdirptr, (LPCWSTR)info->Name, root, want_dir || level )))
 609         return STATUS_RESOURCE_NAME_NOT_FOUND;
 610     if (!level--) return STATUS_SUCCESS;
 611     if (level) return STATUS_INVALID_PARAMETER;  /* level > 3 */
 612
 613     resdirptr = *ret;
 614
 615     if ((*ret = find_first_entry( resdirptr, root, want_dir ))) return STATUS_SUCCESS;
 616
 617     return STATUS_RESOURCE_DATA_NOT_FOUND;
 618
 619 done:
 620     *ret = resdirptr;
 621     return STATUS_SUCCESS;
 622 }
 623
 624
 625 /* EOF */