Ros-diffs

ros-diffs@reactos.org

81390 discussions

[reactos] 03/03: [NTOS:SE] Refactor SeTokenCanImpersonate
by George Bișoc 09 Jun '23

09 Jun '23

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=59e74584ac5c48e9edb2b… commit 59e74584ac5c48e9edb2bf494c2224bd5ca6fa90 Author: George Bișoc <george.bisoc(a)reactos.org> AuthorDate: Tue Jun 6 19:06:11 2023 +0200 Commit: George Bișoc <george.bisoc(a)reactos.org> CommitDate: Fri Jun 9 11:53:56 2023 +0200 [NTOS:SE] Refactor SeTokenCanImpersonate - Refactor most of the code, since there's quite some stuff that don't make much sense. For instance ImpersonationLevel is basically the requested impersonation level a server asks for. PsImpersonateClient doesn't explicitly say that SecurityAnonymous and SecurityIdentification are not allowed. If the server was to give such levels it simply means it doesn't want to impersonate the client. Another thing that doesn't make much sense is that we check if the client is associated with an anonymous token, then avoid impersonating regular anonymous tokens that weren't created by the system. Only system can create such tokens and an anonymous token basically means a token with hidden security info. - Check that the server is within the same client logon session. - If the server is granted the SeImpersonatePrivilege privilege, allow impersonation regardless of the conditions we want to check for. - Update the documentation and code comments. --- ntoskrnl/se/token.c | 127 ++++++++++++++++++++++++++++++++++------------------ 1 file changed, 83 insertions(+), 44 deletions(-) diff --git a/ntoskrnl/se/token.c b/ntoskrnl/se/token.c index bdb360e8672..dae5a411dff 100644 --- a/ntoskrnl/se/token.c +++ b/ntoskrnl/se/token.c @@ -2158,22 +2158,47 @@ SeTokenIsWriteRestricted( /** * @brief - * Ensures that client impersonation can occur by checking if the token - * we're going to assign as the impersonation token can be actually impersonated - * in the first place. The routine is used primarily by PsImpersonateClient. + * Determines whether the server is allowed to impersonate on behalf + * of a client or not. For further details, see Remarks. * * @param[in] ProcessToken - * Token from a process. + * A pointer to the primary access token of the server process + * that requests impersonation of the client target. * * @param[in] TokenToImpersonate - * Token that we are going to impersonate. + * A pointer to an access token that represents a client that is to + * be impersonated. * * @param[in] ImpersonationLevel - * Security impersonation level grade. + * The requested impersonation level. * * @return * Returns TRUE if the conditions checked are met for token impersonation, * FALSE otherwise. + * + * @remarks + * The server has to meet the following criteria in order to impersonate + * a client, that is: + * + * - The server must not impersonate a client beyond the level that + * the client imposed on itself. + * + * - The server must be authenticated on the same logon session of + * the target client. + * + * - IF NOT then the server's user ID has to match to that of the + * target client. + * + * - The server must not be restricted in order to impersonate a + * client that is not restricted. + * + * If the associated access token that represents the security properties + * of the server is granted the SeImpersonatePrivilege privilege the server + * is given immediate impersonation, regardless of the conditions above. + * If the client in question is associated with an anonymous token then + * the server is given immediate impersonation. Or if the server simply + * doesn't ask for impersonation but instead it wants to get the security + * identification of a client, the server is given immediate impersonation. */ BOOLEAN NTAPI @@ -2186,73 +2211,87 @@ SeTokenCanImpersonate( PAGED_CODE(); /* - * SecurityAnonymous and SecurityIdentification levels do not - * allow impersonation. + * The server may want to obtain identification details of a client + * instead of impersonating so just give the server a pass. */ - if (ImpersonationLevel == SecurityAnonymous || - ImpersonationLevel == SecurityIdentification) + if (ImpersonationLevel < SecurityIdentification) { - return FALSE; + DPRINT("The server doesn't ask for impersonation\n"); + return TRUE; } /* Time to lock our tokens */ SepAcquireTokenLockShared(ProcessToken); SepAcquireTokenLockShared(TokenToImpersonate); - /* What kind of authentication ID does the token have? */ + /* + * As the name implies, an anonymous token has invisible security + * identification details. By the general rule these tokens do not + * pose a danger in terms of power escalation so give the server a pass. + */ if (RtlEqualLuid(&TokenToImpersonate->AuthenticationId, &SeAnonymousAuthenticationId)) { - /* - * OK, it looks like the token has an anonymous - * authentication. Is that token created by the system? - */ - if (TokenToImpersonate->TokenSource.SourceName != SeSystemTokenSource.SourceName && - !RtlEqualLuid(&TokenToImpersonate->TokenSource.SourceIdentifier, &SeSystemTokenSource.SourceIdentifier)) - { - /* It isn't, we can't impersonate regular tokens */ - DPRINT("SeTokenCanImpersonate(): Token has an anonymous authentication ID, can't impersonate!\n"); - CanImpersonate = FALSE; - goto Quit; - } + DPRINT("The token to impersonate has an anonymous authentication ID, allow impersonation either way\n"); + CanImpersonate = TRUE; + goto Quit; } - /* Are the SID values from both tokens equal? */ - if (!RtlEqualSid(ProcessToken->UserAndGroups->Sid, - TokenToImpersonate->UserAndGroups->Sid)) + /* Allow impersonation for the process server if it's granted the impersonation privilege */ + if ((ProcessToken->TokenFlags & TOKEN_HAS_IMPERSONATE_PRIVILEGE) != 0) { - /* They aren't, bail out */ - DPRINT("SeTokenCanImpersonate(): Tokens SIDs are not equal!\n"); - CanImpersonate = FALSE; + DPRINT("The process is granted the impersonation privilege, allow impersonation\n"); + CanImpersonate = TRUE; goto Quit; } /* - * Make sure the tokens aren't diverged in terms of - * restrictions, that is, one token is restricted - * but the other one isn't. + * Deny impersonation for the server if it wants to impersonate a client + * beyond what the impersonation level originally permits. */ - if (SeTokenIsRestricted(ProcessToken) != - SeTokenIsRestricted(TokenToImpersonate)) + if (ImpersonationLevel > TokenToImpersonate->ImpersonationLevel) { - /* - * One token is restricted so we cannot - * continue further at this point, bail out. - */ - DPRINT("SeTokenCanImpersonate(): One token is restricted, can't continue!\n"); + DPRINT1("Cannot impersonate a client above the permitted impersonation level!\n"); CanImpersonate = FALSE; goto Quit; } + /* Is the server authenticated on the same client originating session? */ + if (!RtlEqualLuid(&ProcessToken->AuthenticationId, + &TokenToImpersonate->OriginatingLogonSession)) + { + /* It's not, check that at least both the server and client are the same user */ + if (!RtlEqualSid(ProcessToken->UserAndGroups[0].Sid, + TokenToImpersonate->UserAndGroups[0].Sid)) + { + DPRINT1("Server and client aren't the same user!\n"); + CanImpersonate = FALSE; + goto Quit; + } + + /* + * Make sure the tokens haven't diverged in terms of restrictions + * that is one token is restricted but the other one isn't. If that + * would have been the case then the server would have impersonated + * a less restricted client thus potentially triggering an elevation, + * which is not what we want. + */ + if (SeTokenIsRestricted(ProcessToken) != + SeTokenIsRestricted(TokenToImpersonate)) + { + DPRINT1("Attempting to impersonate a less restricted client token, bail out!\n"); + CanImpersonate = FALSE; + goto Quit; + } + } + /* If we've reached that far then we can impersonate! */ - DPRINT("SeTokenCanImpersonate(): We can impersonate.\n"); + DPRINT("We can impersonate\n"); CanImpersonate = TRUE; Quit: - /* We're done, unlock the tokens now */ - SepReleaseTokenLock(ProcessToken); SepReleaseTokenLock(TokenToImpersonate); - + SepReleaseTokenLock(ProcessToken); return CanImpersonate; }

1 0

[reactos] 02/03: [NTOS:PS] Do not reference the copied token twice and properly assign the impersonation level in case the server can't impersonate
by George Bișoc 09 Jun '23

09 Jun '23

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=8e2fe925f25cd14688ed8… commit 8e2fe925f25cd14688ed82f4b84e2d1a8fb172cb Author: George Bișoc <george.bisoc(a)reactos.org> AuthorDate: Tue Jun 6 17:24:15 2023 +0200 Commit: George Bișoc <george.bisoc(a)reactos.org> CommitDate: Fri Jun 9 11:53:55 2023 +0200 [NTOS:PS] Do not reference the copied token twice and properly assign the impersonation level in case the server can't impersonate As it currently stands the PsImpersonateClient routine does the following approach. If impersonation couldn't be granted to a client the routine will make a copy of the client's access token. As it makes a copy of the said token PsImpersonateClient will reference the copied token after impersonation info have been filled out. In the same code path we are assigning the desired level for impersonation to thread impersonation info. This is wrong for two reasons: - On a copy situation the SeCopyClientToken routine holds a reference as the object has been created. Referencing it at the bottom of the PsImpersonateClient routine will make it that the token is referenced twice and whenever a server stops impersonation the token still has an extra reference count which keeps the token still alive in object database and memory space. - If client impersonation is not possible the thread impersonation info should have been assigned SecurityIdentification level to further indicate that the actual impersonation of the thread is not currently in force but instead we are assigning the impersonation level that is supplied by the caller. For instance if the requested level is SecurityDelegation but impersonation is not possible the level will be assigned that of SecurityDelegation yet the token has an impersonation level of SecurityIdentification. This could lead to erratic behaviors as well as potential impersonation escalation. Fix the aforementioned issues by avoiding a double reference and properly assign the impersonation level to SecurityIdentification if the server is not able to impersonate the target client. --- ntoskrnl/ps/security.c | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/ntoskrnl/ps/security.c b/ntoskrnl/ps/security.c index 23145529743..4d47764fc07 100644 --- a/ntoskrnl/ps/security.c +++ b/ntoskrnl/ps/security.c @@ -615,6 +615,7 @@ PsImpersonateClient(IN PETHREAD Thread, { PPS_IMPERSONATION_INFORMATION Impersonation, OldData; PTOKEN OldToken = NULL, ProcessToken = NULL; + BOOLEAN CopiedToken = FALSE; PACCESS_TOKEN NewToken, ImpersonationToken; PEJOB Job; NTSTATUS Status; @@ -706,7 +707,13 @@ PsImpersonateClient(IN PETHREAD Thread, return Status; } - /* Since we cannot impersonate, assign the newly copied token */ + /* + * Since we cannot impersonate, assign the newly copied token. + * SeCopyClientToken already holds a reference to the copied token, + * let the code path below know that it must not reference it twice. + */ + CopiedToken = TRUE; + ImpersonationLevel = SecurityIdentification; ImpersonationToken = NewToken; } @@ -721,6 +728,11 @@ PsImpersonateClient(IN PETHREAD Thread, if ((Job->SecurityLimitFlags & JOB_OBJECT_SECURITY_NO_ADMIN) && SeTokenIsAdmin(ImpersonationToken)) { + if (CopiedToken) + { + ObDereferenceObject(ImpersonationToken); + } + return STATUS_ACCESS_DENIED; } @@ -728,6 +740,11 @@ PsImpersonateClient(IN PETHREAD Thread, if ((Job->SecurityLimitFlags & JOB_OBJECT_SECURITY_RESTRICTED_TOKEN) && SeTokenIsRestricted(ImpersonationToken)) { + if (CopiedToken) + { + ObDereferenceObject(ImpersonationToken); + } + return STATUS_ACCESS_DENIED; } @@ -758,7 +775,12 @@ PsImpersonateClient(IN PETHREAD Thread, Impersonation->CopyOnOpen = CopyOnOpen; Impersonation->EffectiveOnly = EffectiveOnly; Impersonation->Token = ImpersonationToken; - ObReferenceObject(ImpersonationToken); + + /* Do not reference the token again if we copied it */ + if (!CopiedToken) + { + ObReferenceObject(ImpersonationToken); + } /* Unlock the thread */ PspUnlockThreadSecurityExclusive(Thread);

1 0

[reactos] 01/03: [NTOS:SE] Grant the SYSTEM process the missing privileges
by George Bișoc 09 Jun '23

09 Jun '23

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=f483e42f8912156287fd9… commit f483e42f8912156287fd922b985d722f58d85bca Author: George Bișoc <george.bisoc(a)reactos.org> AuthorDate: Tue Jun 6 18:07:39 2023 +0200 Commit: George Bișoc <george.bisoc(a)reactos.org> CommitDate: Fri Jun 9 11:53:51 2023 +0200 [NTOS:SE] Grant the SYSTEM process the missing privileges - Add the missing privileges to the SYSTEM privileges which might be needed, notably SeUndockPrivilege, SeManageVolumePrivilege, SeCreateGlobalPrivilege and SeImpersonatePrivilege. Specifically SeImpersonatePrivilege is important here because with it we allow system components of the core OS to perform certain system tasks. - Declare the Groups array with a maximum of 3 elements in SepCreateSystemProcessToken and 1 element in SepCreateSystemAnonymousLogonToken respectively, because previously this array was oversized with most of free space left as a waste. - Avoid hardcoding the size value of the Privilege array, instead initialize it by hand and compute the exact number of elements with RTL_NUMBER_OF. --- ntoskrnl/se/token.c | 123 +++++++++++++++++++--------------------------------- 1 file changed, 44 insertions(+), 79 deletions(-) diff --git a/ntoskrnl/se/token.c b/ntoskrnl/se/token.c index c048294c868..bdb360e8672 100644 --- a/ntoskrnl/se/token.c +++ b/ntoskrnl/se/token.c @@ -3,7 +3,7 @@ * LICENSE: GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later) * PURPOSE: Security access token implementation base support routines * COPYRIGHT: Copyright David Welch <welch(a)cwcom.net> - * Copyright 2021-2022 George Bișoc <george.bisoc(a)reactos.org> + * Copyright 2021-2023 George Bișoc <george.bisoc(a)reactos.org> */ /* INCLUDES *******************************************************************/ @@ -1752,16 +1752,13 @@ PTOKEN NTAPI SepCreateSystemProcessToken(VOID) { - LUID_AND_ATTRIBUTES Privileges[25]; ULONG GroupAttributes, OwnerAttributes; - SID_AND_ATTRIBUTES Groups[32]; LARGE_INTEGER Expiration; SID_AND_ATTRIBUTES UserSid; ULONG GroupsLength; PSID PrimaryGroup; OBJECT_ATTRIBUTES ObjectAttributes; PSID Owner; - ULONG i; PTOKEN Token; NTSTATUS Status; @@ -1783,80 +1780,46 @@ SepCreateSystemProcessToken(VOID) Owner = SeAliasAdminsSid; /* Groups are Administrators, World, and Authenticated Users */ - Groups[0].Sid = SeAliasAdminsSid; - Groups[0].Attributes = OwnerAttributes; - Groups[1].Sid = SeWorldSid; - Groups[1].Attributes = GroupAttributes; - Groups[2].Sid = SeAuthenticatedUsersSid; - Groups[2].Attributes = GroupAttributes; + SID_AND_ATTRIBUTES Groups[] = + { + {SeAliasAdminsSid, OwnerAttributes}, + {SeWorldSid, GroupAttributes}, + {SeAuthenticatedUsersSid, GroupAttributes} + }; GroupsLength = sizeof(SID_AND_ATTRIBUTES) + SeLengthSid(Groups[0].Sid) + SeLengthSid(Groups[1].Sid) + SeLengthSid(Groups[2].Sid); - ASSERT(GroupsLength <= sizeof(Groups)); + ASSERT(GroupsLength <= (sizeof(Groups) * sizeof(ULONG))); /* Setup the privileges */ - i = 0; - Privileges[i].Attributes = SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED; - Privileges[i++].Luid = SeTcbPrivilege; - - Privileges[i].Attributes = 0; - Privileges[i++].Luid = SeCreateTokenPrivilege; - - Privileges[i].Attributes = 0; - Privileges[i++].Luid = SeTakeOwnershipPrivilege; - - Privileges[i].Attributes = SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED; - Privileges[i++].Luid = SeCreatePagefilePrivilege; - - Privileges[i].Attributes = SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED; - Privileges[i++].Luid = SeLockMemoryPrivilege; - - Privileges[i].Attributes = 0; - Privileges[i++].Luid = SeAssignPrimaryTokenPrivilege; - - Privileges[i].Attributes = 0; - Privileges[i++].Luid = SeIncreaseQuotaPrivilege; - - Privileges[i].Attributes = SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED; - Privileges[i++].Luid = SeIncreaseBasePriorityPrivilege; - - Privileges[i].Attributes = SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED; - Privileges[i++].Luid = SeCreatePermanentPrivilege; - - Privileges[i].Attributes = SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED; - Privileges[i++].Luid = SeDebugPrivilege; - - Privileges[i].Attributes = SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED; - Privileges[i++].Luid = SeAuditPrivilege; - - Privileges[i].Attributes = 0; - Privileges[i++].Luid = SeSecurityPrivilege; - - Privileges[i].Attributes = 0; - Privileges[i++].Luid = SeSystemEnvironmentPrivilege; - - Privileges[i].Attributes = SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED; - Privileges[i++].Luid = SeChangeNotifyPrivilege; - - Privileges[i].Attributes = 0; - Privileges[i++].Luid = SeBackupPrivilege; - - Privileges[i].Attributes = 0; - Privileges[i++].Luid = SeRestorePrivilege; - - Privileges[i].Attributes = 0; - Privileges[i++].Luid = SeShutdownPrivilege; - - Privileges[i].Attributes = 0; - Privileges[i++].Luid = SeLoadDriverPrivilege; - - Privileges[i].Attributes = SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED; - Privileges[i++].Luid = SeProfileSingleProcessPrivilege; - - Privileges[i].Attributes = 0; - Privileges[i++].Luid = SeSystemtimePrivilege; - ASSERT(i == 20); + LUID_AND_ATTRIBUTES Privileges[] = + { + {SeTcbPrivilege, SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED}, + {SeCreateTokenPrivilege, 0}, + {SeTakeOwnershipPrivilege, 0}, + {SeCreatePagefilePrivilege, SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED}, + {SeLockMemoryPrivilege, SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED}, + {SeAssignPrimaryTokenPrivilege, 0}, + {SeIncreaseQuotaPrivilege, 0}, + {SeIncreaseBasePriorityPrivilege, SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED}, + {SeCreatePermanentPrivilege, SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED}, + {SeDebugPrivilege, SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED}, + {SeAuditPrivilege, SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED}, + {SeSecurityPrivilege, 0}, + {SeSystemEnvironmentPrivilege, 0}, + {SeChangeNotifyPrivilege, SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED}, + {SeBackupPrivilege, 0}, + {SeRestorePrivilege, 0}, + {SeShutdownPrivilege, 0}, + {SeLoadDriverPrivilege, 0}, + {SeProfileSingleProcessPrivilege, SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED}, + {SeSystemtimePrivilege, 0}, + {SeUndockPrivilege, 0}, + {SeManageVolumePrivilege, 0}, + {SeImpersonatePrivilege, SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED}, + {SeCreateGlobalPrivilege, SE_PRIVILEGE_ENABLED_BY_DEFAULT | SE_PRIVILEGE_ENABLED}, + }; /* Setup the object attributes */ InitializeObjectAttributes(&ObjectAttributes, NULL, 0, NULL, NULL); @@ -1872,10 +1835,10 @@ SepCreateSystemProcessToken(VOID) &SeSystemAuthenticationId, &Expiration, &UserSid, - 3, + RTL_NUMBER_OF(Groups), Groups, GroupsLength, - 20, + RTL_NUMBER_OF(Privileges), Privileges, Owner, PrimaryGroup, @@ -1902,7 +1865,7 @@ CODE_SEG("INIT") PTOKEN SepCreateSystemAnonymousLogonToken(VOID) { - SID_AND_ATTRIBUTES Groups[32], UserSid; + SID_AND_ATTRIBUTES UserSid; PSID PrimaryGroup; PTOKEN Token; ULONG GroupsLength; @@ -1921,11 +1884,13 @@ SepCreateSystemAnonymousLogonToken(VOID) PrimaryGroup = SeAnonymousLogonSid; /* The only group for the token is the World */ - Groups[0].Sid = SeWorldSid; - Groups[0].Attributes = SE_GROUP_ENABLED | SE_GROUP_MANDATORY | SE_GROUP_ENABLED_BY_DEFAULT; + SID_AND_ATTRIBUTES Groups[] = + { + {SeWorldSid, SE_GROUP_ENABLED | SE_GROUP_MANDATORY | SE_GROUP_ENABLED_BY_DEFAULT} + }; GroupsLength = sizeof(SID_AND_ATTRIBUTES) + SeLengthSid(Groups[0].Sid); - ASSERT(GroupsLength <= sizeof(Groups)); + ASSERT(GroupsLength <= (sizeof(Groups) * sizeof(ULONG))); /* Initialise the object attributes for the token */ InitializeObjectAttributes(&ObjectAttributes, NULL, 0, NULL, NULL); @@ -1941,7 +1906,7 @@ SepCreateSystemAnonymousLogonToken(VOID) &SeAnonymousAuthenticationId, &Expiration, &UserSid, - 1, + RTL_NUMBER_OF(Groups), Groups, GroupsLength, 0,

1 0

[reactos] 01/01: [GITHUB] Draft PRs should be exempt from closure by the stale PR bot
by George Bișoc 09 Jun '23

09 Jun '23

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=d8bfe2a2618c3d2f4a303… commit d8bfe2a2618c3d2f4a3038c7fd4f221978c865ba Author: George Bișoc <george.bisoc(a)reactos.org> AuthorDate: Fri Jun 9 11:41:52 2023 +0200 Commit: George Bișoc <george.bisoc(a)reactos.org> CommitDate: Fri Jun 9 11:43:04 2023 +0200 [GITHUB] Draft PRs should be exempt from closure by the stale PR bot --- .github/workflows/stale.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 5ffbec47d18..51f61b8b51d 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -26,6 +26,7 @@ jobs: days-before-close: 14 days-before-issue-close: -1 exempt-all-assignees: true + exempt-draft-pr: true stale-pr-message: 'This PR is stale because it received no updates in the last 4 months. Without removing the stale label, or commenting on this ticket it will be closed in 2 weeks.' stale-issue-label: 'no-issue-activity' stale-pr-label: 'no-pr-activity'

1 0

[reactos] 01/01: [GITHUB] Temporarily disable MSBuild
by George Bișoc 08 Jun '23

08 Jun '23

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=56a450147c2915618d3f8… commit 56a450147c2915618d3f8527801b7dc69364738e Author: George Bișoc <george.bisoc(a)reactos.org> AuthorDate: Fri Jun 2 22:50:48 2023 +0200 Commit: George Bișoc <george.bisoc(a)reactos.org> CommitDate: Tue Jun 6 20:06:01 2023 +0200 [GITHUB] Temporarily disable MSBuild Due to a update of MSBuild build worker, MSBuild keeps failing which is a nuisance. Temporarily disable that worker until a proper fix is shipped. CORE-18911 --- .github/workflows/build.yml | 51 +++++++++++++++++++++++---------------------- 1 file changed, 26 insertions(+), 25 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e10e19c50ea..11dbe13ece6 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -272,28 +272,29 @@ jobs: name: reactos-syms-clang-cl-${{matrix.arch}}-${{matrix.config}}-${{github.sha}} path: build/msvc_pdb - build-msbuild-i386: - name: MSBuild (i386) - runs-on: windows-2019 - steps: - - name: Install Flex and Bison - run: | - curl -O https://svn.reactos.org/storage/vperevertkin/flexbison.7z - 7z x flexbison.7z -O${{github.workspace}}\bin - echo "${{github.workspace}}\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append - echo "BISON_PKGDATADIR=${{github.workspace}}\bin\share\bison" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - echo "M4=${{github.workspace}}\bin\m4.exe" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append - - name: Add CL to PATH - uses: ilammy/msvc-dev-cmd@v1 - with: - arch: amd64_x86 - - uses: actions/checkout@v2 - with: - path: src - - name: Configure - run: | - mkdir build - cd build - cmake -G "Visual Studio 16 2019" -A Win32 -DCMAKE_TOOLCHAIN_FILE:FILEPATH=toolchain-msvc.cmake -DARCH:STRING=i386 -DENABLE_ROSTESTS=1 -DENABLE_ROSAPPS=1 ${{github.workspace}}\src - - name: Build - run: cmake --build ${{github.workspace}}\build --target bootcd --target livecd +# Disable MSBuild for the moment being until a proper fix is provided -- see CORE-18911 +# build-msbuild-i386: +# name: MSBuild (i386) +# runs-on: windows-2019 +# steps: +# - name: Install Flex and Bison +# run: | +# curl -O https://svn.reactos.org/storage/vperevertkin/flexbison.7z +# 7z x flexbison.7z -O${{github.workspace}}\bin +# echo "${{github.workspace}}\bin" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append +# echo "BISON_PKGDATADIR=${{github.workspace}}\bin\share\bison" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append +# echo "M4=${{github.workspace}}\bin\m4.exe" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append +# - name: Add CL to PATH +# uses: ilammy/msvc-dev-cmd@v1 +# with: +# arch: amd64_x86 +# - uses: actions/checkout@v2 +# with: +# path: src +# - name: Configure +# run: | +# mkdir build +# cd build +# cmake -G "Visual Studio 16 2019" -A Win32 -DCMAKE_TOOLCHAIN_FILE:FILEPATH=toolchain-msvc.cmake -DARCH:STRING=i386 -DENABLE_ROSTESTS=1 -DENABLE_ROSAPPS=1 ${{github.workspace}}\src +# - name: Build +# run: cmake --build ${{github.workspace}}\build --target bootcd --target livecd

1 0

[reactos] 01/01: [FREELDR] Cleanup some FldrCreateComponentKey() calls and archwsup.c
by Hermès Bélusca-Maïto 05 Jun '23

05 Jun '23

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=8061a6f6f4bfd4383084f… commit 8061a6f6f4bfd4383084f6b6f9d3e23061e4953d Author: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> AuthorDate: Mon Jun 5 13:31:20 2023 +0200 Commit: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> CommitDate: Mon Jun 5 22:39:47 2023 +0200 [FREELDR] Cleanup some FldrCreateComponentKey() calls and archwsup.c --- boot/freeldr/freeldr/arch/archwsup.c | 106 +++++++++++++++++++------ boot/freeldr/freeldr/arch/arm/macharm.c | 2 +- boot/freeldr/freeldr/arch/i386/hwacpi.c | 4 +- boot/freeldr/freeldr/arch/i386/hwapm.c | 2 +- boot/freeldr/freeldr/arch/i386/hwpci.c | 12 +-- boot/freeldr/freeldr/arch/i386/pc/machpc.c | 57 +++++-------- boot/freeldr/freeldr/arch/i386/pc/pchw.c | 5 +- boot/freeldr/freeldr/arch/i386/pc98/pc98hw.c | 31 +++----- boot/freeldr/freeldr/arch/i386/xbox/machxbox.c | 18 ++--- boot/freeldr/freeldr/include/arch/archwsup.h | 42 ++++------ 10 files changed, 145 insertions(+), 134 deletions(-) diff --git a/boot/freeldr/freeldr/arch/archwsup.c b/boot/freeldr/freeldr/arch/archwsup.c index e4e44875b49..f112270ad25 100644 --- a/boot/freeldr/freeldr/arch/archwsup.c +++ b/boot/freeldr/freeldr/arch/archwsup.c @@ -11,9 +11,57 @@ #include <freeldr.h> #include <debug.h> +DBG_DEFAULT_CHANNEL(HWDETECT); /* GLOBALS ********************************************************************/ +/* Strings corresponding to CONFIGURATION_TYPE */ +const PCSTR ArcTypes[MaximumType + 1] = // CmTypeName +{ + "System", + "CentralProcessor", + "FloatingPointProcessor", + "PrimaryICache", + "PrimaryDCache", + "SecondaryICache", + "SecondaryDCache", + "SecondaryCache", + "EisaAdapter", + "TcAdapter", + "ScsiAdapter", + "DtiAdapter", + "MultifunctionAdapter", + "DiskController", + "TapeController", + "CdRomController", + "WormController", + "SerialController", + "NetworkController", + "DisplayController", + "ParallelController", + "PointerController", + "KeyboardController", + "AudioController", + "OtherController", + "DiskPeripheral", + "FloppyDiskPeripheral", + "TapePeripheral", + "ModemPeripheral", + "MonitorPeripheral", + "PrinterPeripheral", + "PointerPeripheral", + "KeyboardPeripheral", + "TerminalPeripheral", + "OtherPeripheral", + "LinePeripheral", + "NetworkPeripheral", + "SystemMemory", + "DockingInformation", + "RealModeIrqRoutingTable", + "RealModePCIEnumeration", + "Undefined" +}; + PCONFIGURATION_COMPONENT_DATA FldrArcHwTreeRoot; // ARC Disk Information @@ -51,12 +99,11 @@ AddReactOSArcDiskInfo( // ARC Component Configuration Routines // -VOID -NTAPI -FldrSetIdentifier(IN PCONFIGURATION_COMPONENT_DATA ComponentData, - IN PCHAR IdentifierString) +static VOID +FldrSetIdentifier( + _In_ PCONFIGURATION_COMPONENT Component, + _In_ PCSTR IdentifierString) { - PCONFIGURATION_COMPONENT Component = &ComponentData->ComponentEntry; SIZE_T IdentifierLength; PCHAR Identifier; @@ -74,10 +121,10 @@ FldrSetIdentifier(IN PCONFIGURATION_COMPONENT_DATA ComponentData, } VOID -NTAPI -FldrSetConfigurationData(IN PCONFIGURATION_COMPONENT_DATA ComponentData, - IN PCM_PARTIAL_RESOURCE_LIST ResourceList, - IN ULONG Size) +FldrSetConfigurationData( + _Inout_ PCONFIGURATION_COMPONENT_DATA ComponentData, + _In_ PCM_PARTIAL_RESOURCE_LIST ResourceList, + _In_ ULONG Size) { /* Set component information */ ComponentData->ConfigurationData = ResourceList; @@ -85,8 +132,9 @@ FldrSetConfigurationData(IN PCONFIGURATION_COMPONENT_DATA ComponentData, } VOID -NTAPI -FldrCreateSystemKey(OUT PCONFIGURATION_COMPONENT_DATA *SystemNode) +FldrCreateSystemKey( + _Out_ PCONFIGURATION_COMPONENT_DATA* SystemNode, + _In_ PCSTR IdentifierString) { PCONFIGURATION_COMPONENT Component; @@ -108,14 +156,18 @@ FldrCreateSystemKey(OUT PCONFIGURATION_COMPONENT_DATA *SystemNode) Component->Key = 0; Component->AffinityMask = 0xFFFFFFFF; + /* Set identifier */ + if (IdentifierString) + FldrSetIdentifier(Component, IdentifierString); + /* Return the node */ *SystemNode = FldrArcHwTreeRoot; } static VOID -NTAPI -FldrLinkToParent(IN PCONFIGURATION_COMPONENT_DATA Parent, - IN PCONFIGURATION_COMPONENT_DATA Child) +FldrLinkToParent( + _In_ PCONFIGURATION_COMPONENT_DATA Parent, + _In_ PCONFIGURATION_COMPONENT_DATA Child) { PCONFIGURATION_COMPONENT_DATA Sibling; @@ -143,17 +195,17 @@ FldrLinkToParent(IN PCONFIGURATION_COMPONENT_DATA Parent, } VOID -NTAPI -FldrCreateComponentKey(IN PCONFIGURATION_COMPONENT_DATA SystemNode, - IN CONFIGURATION_CLASS Class, - IN CONFIGURATION_TYPE Type, - IN IDENTIFIER_FLAG Flags, - IN ULONG Key, - IN ULONG Affinity, - IN PCHAR IdentifierString, - IN PCM_PARTIAL_RESOURCE_LIST ResourceList, - IN ULONG Size, - OUT PCONFIGURATION_COMPONENT_DATA *ComponentKey) +FldrCreateComponentKey( + _In_ PCONFIGURATION_COMPONENT_DATA SystemNode, + _In_ CONFIGURATION_CLASS Class, + _In_ CONFIGURATION_TYPE Type, + _In_ IDENTIFIER_FLAG Flags, + _In_ ULONG Key, + _In_ ULONG Affinity, + _In_ PCSTR IdentifierString, + _In_ PCM_PARTIAL_RESOURCE_LIST ResourceList, + _In_ ULONG Size, + _Out_ PCONFIGURATION_COMPONENT_DATA* ComponentKey) { PCONFIGURATION_COMPONENT_DATA ComponentData; PCONFIGURATION_COMPONENT Component; @@ -180,12 +232,14 @@ FldrCreateComponentKey(IN PCONFIGURATION_COMPONENT_DATA SystemNode, /* Set identifier */ if (IdentifierString) - FldrSetIdentifier(ComponentData, IdentifierString); + FldrSetIdentifier(Component, IdentifierString); /* Set configuration data */ if (ResourceList) FldrSetConfigurationData(ComponentData, ResourceList, Size); + TRACE("Created key: %s\\%d\n", ArcTypes[min(Type, MaximumType)], Key); + /* Return the child */ *ComponentKey = ComponentData; } diff --git a/boot/freeldr/freeldr/arch/arm/macharm.c b/boot/freeldr/freeldr/arch/arm/macharm.c index b62ba474df5..2179a59bd3a 100644 --- a/boot/freeldr/freeldr/arch/arm/macharm.c +++ b/boot/freeldr/freeldr/arch/arm/macharm.c @@ -100,7 +100,7 @@ ArmHwDetect(VOID) /* Create the root node */ if (ArmHwDetectRan++) return RootNode; - FldrCreateSystemKey(&RootNode); + FldrCreateSystemKey(&RootNode, ""); /* * TODO: diff --git a/boot/freeldr/freeldr/arch/i386/hwacpi.c b/boot/freeldr/freeldr/arch/i386/hwacpi.c index 120de9ecb57..ccd42b144e0 100644 --- a/boot/freeldr/freeldr/arch/i386/hwacpi.c +++ b/boot/freeldr/freeldr/arch/i386/hwacpi.c @@ -116,8 +116,8 @@ DetectAcpiBios(PCONFIGURATION_COMPONENT_DATA SystemKey, ULONG *BusNumber) FldrCreateComponentKey(SystemKey, AdapterClass, MultiFunctionAdapter, - 0x0, - 0x0, + 0, + 0, 0xFFFFFFFF, "ACPI BIOS", PartialResourceList, diff --git a/boot/freeldr/freeldr/arch/i386/hwapm.c b/boot/freeldr/freeldr/arch/i386/hwapm.c index 313cf905419..cd0dfb0288b 100644 --- a/boot/freeldr/freeldr/arch/i386/hwapm.c +++ b/boot/freeldr/freeldr/arch/i386/hwapm.c @@ -73,7 +73,7 @@ DetectApmBios(PCONFIGURATION_COMPONENT_DATA SystemKey, ULONG *BusNumber) FldrCreateComponentKey(SystemKey, AdapterClass, MultiFunctionAdapter, - 0x0, + 0, 0, 0xFFFFFFFF, "APM", diff --git a/boot/freeldr/freeldr/arch/i386/hwpci.c b/boot/freeldr/freeldr/arch/i386/hwpci.c index 94bd4b59ecd..54d1cfcce16 100644 --- a/boot/freeldr/freeldr/arch/i386/hwpci.c +++ b/boot/freeldr/freeldr/arch/i386/hwpci.c @@ -161,8 +161,8 @@ DetectPciIrqRoutingTable(PCONFIGURATION_COMPONENT_DATA BusKey) FldrCreateComponentKey(BusKey, PeripheralClass, RealModeIrqRoutingTable, - 0x0, - 0x0, + 0, + 0, 0xFFFFFFFF, "PCI Real-mode IRQ Routing Table", PartialResourceList, @@ -202,8 +202,8 @@ DetectPciBios(PCONFIGURATION_COMPONENT_DATA SystemKey, ULONG *BusNumber) FldrCreateComponentKey(SystemKey, AdapterClass, MultiFunctionAdapter, - 0x0, - 0x0, + 0, + 0, 0xFFFFFFFF, "PCI BIOS", PartialResourceList, @@ -268,8 +268,8 @@ DetectPciBios(PCONFIGURATION_COMPONENT_DATA SystemKey, ULONG *BusNumber) FldrCreateComponentKey(SystemKey, AdapterClass, MultiFunctionAdapter, - 0x0, - 0x0, + 0, + 0, 0xFFFFFFFF, "PCI", PartialResourceList, diff --git a/boot/freeldr/freeldr/arch/i386/pc/machpc.c b/boot/freeldr/freeldr/arch/i386/pc/machpc.c index 43baec3b491..f20fa2b9a52 100644 --- a/boot/freeldr/freeldr/arch/i386/pc/machpc.c +++ b/boot/freeldr/freeldr/arch/i386/pc/machpc.c @@ -357,8 +357,8 @@ DetectPnpBios(PCONFIGURATION_COMPONENT_DATA SystemKey, ULONG *BusNumber) FldrCreateComponentKey(SystemKey, AdapterClass, MultiFunctionAdapter, - 0x0, - 0x0, + 0, + 0, 0xFFFFFFFF, "PNP BIOS", PartialResourceList, @@ -687,14 +687,12 @@ DetectSerialPointerPeripheral(PCONFIGURATION_COMPONENT_DATA ControllerKey, PeripheralClass, PointerPeripheral, Input, - 0x0, + 0, 0xFFFFFFFF, Identifier, PartialResourceList, Size, &PeripheralKey); - - TRACE("Created key: PointerPeripheral\\0\n"); } } @@ -723,7 +721,7 @@ DetectSerialPorts(PCONFIGURATION_COMPONENT_DATA BusKey, GET_SERIAL_PORT MachGetS PCM_SERIAL_DEVICE_DATA SerialDeviceData; ULONG Irq; ULONG Base; - CHAR Buffer[80]; + CHAR Identifier[80]; ULONG ControllerNumber = 0; PCONFIGURATION_COMPONENT_DATA ControllerKey; ULONG i; @@ -740,7 +738,7 @@ DetectSerialPorts(PCONFIGURATION_COMPONENT_DATA BusKey, GET_SERIAL_PORT MachGetS TRACE("Found COM%u port at 0x%x\n", i + 1, Base); /* Set 'Identifier' value */ - sprintf(Buffer, "COM%ld", i + 1); + RtlStringCbPrintfA(Identifier, sizeof(Identifier), "COM%ld", i + 1); /* Build full device descriptor */ Size = sizeof(CM_PARTIAL_RESOURCE_LIST) + @@ -796,7 +794,7 @@ DetectSerialPorts(PCONFIGURATION_COMPONENT_DATA BusKey, GET_SERIAL_PORT MachGetS Output | Input | ConsoleIn | ConsoleOut, ControllerNumber, 0xFFFFFFFF, - Buffer, + Identifier, PartialResourceList, Size, &ControllerKey); @@ -817,7 +815,7 @@ DetectParallelPorts(PCONFIGURATION_COMPONENT_DATA BusKey) PCM_PARTIAL_RESOURCE_LIST PartialResourceList; PCM_PARTIAL_RESOURCE_DESCRIPTOR PartialDescriptor; ULONG Irq[MAX_LPT_PORTS] = {7, 5, (ULONG) - 1}; - CHAR Buffer[80]; + CHAR Identifier[80]; PCONFIGURATION_COMPONENT_DATA ControllerKey; PUSHORT BasePtr; ULONG Base; @@ -843,7 +841,7 @@ DetectParallelPorts(PCONFIGURATION_COMPONENT_DATA BusKey) TRACE("Parallel port %u: %x\n", ControllerNumber, Base); /* Set 'Identifier' value */ - sprintf(Buffer, "PARALLEL%ld", i + 1); + RtlStringCbPrintfA(Identifier, sizeof(Identifier), "PARALLEL%ld", i + 1); /* Build full device descriptor */ Size = sizeof(CM_PARTIAL_RESOURCE_LIST); @@ -891,7 +889,7 @@ DetectParallelPorts(PCONFIGURATION_COMPONENT_DATA BusKey) Output, ControllerNumber, 0xFFFFFFFF, - Buffer, + Identifier, PartialResourceList, Size, &ControllerKey); @@ -1027,13 +1025,12 @@ DetectKeyboardPeripheral(PCONFIGURATION_COMPONENT_DATA ControllerKey) PeripheralClass, KeyboardPeripheral, Input | ConsoleIn, - 0x0, + 0, 0xFFFFFFFF, "PCAT_ENHANCED", PartialResourceList, Size, &PeripheralKey); - TRACE("Created key: KeyboardPeripheral\\0\n"); } } @@ -1094,13 +1091,12 @@ DetectKeyboardController(PCONFIGURATION_COMPONENT_DATA BusKey) ControllerClass, KeyboardController, Input | ConsoleIn, - 0x0, + 0, 0xFFFFFFFF, NULL, PartialResourceList, Size, &ControllerKey); - TRACE("Created key: KeyboardController\\0\n"); DetectKeyboardPeripheral(ControllerKey); } @@ -1254,13 +1250,12 @@ DetectPS2Mouse(PCONFIGURATION_COMPONENT_DATA BusKey) ControllerClass, PointerController, Input, - 0x0, + 0, 0xFFFFFFFF, NULL, PartialResourceList, sizeof(CM_PARTIAL_RESOURCE_LIST), &ControllerKey); - TRACE("Created key: PointerController\\0\n"); if (DetectPS2AuxDevice()) { @@ -1286,13 +1281,12 @@ DetectPS2Mouse(PCONFIGURATION_COMPONENT_DATA BusKey) ControllerClass, PointerPeripheral, Input, - 0x0, + 0, 0xFFFFFFFF, "MICROSOFT PS2 MOUSE", PartialResourceList, Size, &PeripheralKey); - TRACE("Created key: PointerPeripheral\\0\n"); } } } @@ -1306,7 +1300,7 @@ BOOLEAN BiosVesaReadEdid(VOID); static VOID DetectDisplayController(PCONFIGURATION_COMPONENT_DATA BusKey) { - CHAR Buffer[80]; + PCSTR Identifier; PCONFIGURATION_COMPONENT_DATA ControllerKey; USHORT VesaVersion; @@ -1325,25 +1319,20 @@ DetectDisplayController(PCONFIGURATION_COMPONENT_DATA BusKey) } if (VesaVersion >= 0x0200) - { - strcpy(Buffer, "VBE Display"); - } + Identifier = "VBE Display"; else - { - strcpy(Buffer, "VGA Display"); - } + Identifier = "VGA Display"; FldrCreateComponentKey(BusKey, ControllerClass, DisplayController, - 0x0, - 0x0, + Output | ConsoleOut, + 0, 0xFFFFFFFF, - Buffer, + Identifier, NULL, 0, &ControllerKey); - TRACE("Created key: DisplayController\\0\n"); /* FIXME: Add display peripheral (monitor) data */ if (VesaVersion != 0) @@ -1354,7 +1343,6 @@ DetectDisplayController(PCONFIGURATION_COMPONENT_DATA BusKey) if (BiosVesaReadEdid()) { TRACE("EDID data read successfully!\n"); - } } } @@ -1388,8 +1376,8 @@ DetectIsaBios(PCONFIGURATION_COMPONENT_DATA SystemKey, ULONG *BusNumber) FldrCreateComponentKey(SystemKey, AdapterClass, MultiFunctionAdapter, - 0x0, - 0x0, + 0, + 0, 0xFFFFFFFF, "ISA", PartialResourceList, @@ -1434,9 +1422,8 @@ PcHwDetect(VOID) TRACE("DetectHardware()\n"); /* Create the 'System' key */ - FldrCreateSystemKey(&SystemKey); // TODO: Discover and set the other machine types - FldrSetIdentifier(SystemKey, "AT/AT COMPATIBLE"); + FldrCreateSystemKey(&SystemKey, "AT/AT COMPATIBLE"); GetHarddiskConfigurationData = PcGetHarddiskConfigurationData; FindPciBios = PcFindPciBios; diff --git a/boot/freeldr/freeldr/arch/i386/pc/pchw.c b/boot/freeldr/freeldr/arch/i386/pc/pchw.c index 6ade22f7d42..1dfa46bd120 100644 --- a/boot/freeldr/freeldr/arch/i386/pc/pchw.c +++ b/boot/freeldr/freeldr/arch/i386/pc/pchw.c @@ -223,7 +223,7 @@ DetectBiosFloppyPeripheral(PCONFIGURATION_COMPONENT_DATA ControllerKey) Ptr = GetInt1eTable(); /* Set 'Identifier' value */ - sprintf(Identifier, "FLOPPY%d", FloppyNumber + 1); + RtlStringCbPrintfA(Identifier, sizeof(Identifier), "FLOPPY%d", FloppyNumber + 1); Size = sizeof(CM_PARTIAL_RESOURCE_LIST) + sizeof(CM_FLOPPY_DEVICE_DATA); @@ -333,7 +333,6 @@ DetectBiosFloppyController(PCONFIGURATION_COMPONENT_DATA BusKey) PartialResourceList, Size, &ControllerKey); - TRACE("Created key: DiskController\\0\n"); if (FloppyCount) DetectBiosFloppyPeripheral(ControllerKey); @@ -414,7 +413,7 @@ DetectBiosDisks(PCONFIGURATION_COMPONENT_DATA SystemKey, /* Create and fill subkey for each harddisk */ for (i = 0; i < DiskCount; i++) { - PCHAR Identifier; + PCSTR Identifier; DriveNumber = 0x80 + i; diff --git a/boot/freeldr/freeldr/arch/i386/pc98/pc98hw.c b/boot/freeldr/freeldr/arch/i386/pc98/pc98hw.c index 8e4f2355e57..a404237a6c0 100644 --- a/boot/freeldr/freeldr/arch/i386/pc98/pc98hw.c +++ b/boot/freeldr/freeldr/arch/i386/pc98/pc98hw.c @@ -220,7 +220,6 @@ DetectBiosFloppyPeripheral(PCONFIGURATION_COMPONENT_DATA ControllerKey) PartialResourceList, Size, &PeripheralKey); - TRACE("Created key: FloppyDiskPeripheral\\%d\n", FloppyNumber); } } @@ -306,7 +305,6 @@ DetectBiosFloppyController(PCONFIGURATION_COMPONENT_DATA BusKey) PartialResourceList, Size, &ControllerKey); - TRACE("Created key: DiskController\\0\n"); if (FloppyCount) DetectBiosFloppyPeripheral(ControllerKey); @@ -444,7 +442,7 @@ DetectBiosDisks( /* Create and fill subkey for each harddisk */ for (i = 0; i < DiskCount; i++) { - PCHAR Identifier; + PCSTR Identifier; DriveNumber = 0x80 + i; @@ -463,7 +461,6 @@ DetectBiosDisks( PartialResourceList, Size, &DiskKey); - TRACE("Created key: DiskPeripheral\\%d\n", i); } } @@ -501,7 +498,6 @@ DetectPointerPeripheral(PCONFIGURATION_COMPONENT_DATA ControllerKey) PartialResourceList, Size, &PeripheralKey); - TRACE("Created key: PointerPeripheral\\0\n"); } static VOID @@ -577,7 +573,6 @@ DetectPointerController(PCONFIGURATION_COMPONENT_DATA BusKey) PartialResourceList, Size, &ControllerKey); - TRACE("Created key: PointerController\\0\n"); DetectPointerPeripheral(ControllerKey); } @@ -589,7 +584,7 @@ DetectKeyboardPeripheral(PCONFIGURATION_COMPONENT_DATA ControllerKey) PCM_PARTIAL_RESOURCE_DESCRIPTOR PartialDescriptor; PCM_KEYBOARD_DEVICE_DATA KeyboardData; PCONFIGURATION_COMPONENT_DATA PeripheralKey; - CHAR Identifier[80]; + PCSTR Identifier; ULONG Size; REGS Regs; UCHAR KeyboardType = ((*(PUCHAR)MEM_KEYB_TYPE & 0x40) >> 5) | @@ -636,11 +631,11 @@ DetectKeyboardPeripheral(PCONFIGURATION_COMPONENT_DATA ControllerKey) ((Regs.b.al & 0x01) << 1); if (KeyboardType == 0) - RtlStringCbPrintfA(Identifier, sizeof(Identifier), "PC98_NmodeKEY"); + Identifier = "PC98_NmodeKEY"; else if (KeyboardType == 2) - RtlStringCbPrintfA(Identifier, sizeof(Identifier), "PC98_106KEY"); + Identifier = "PC98_106KEY"; else - RtlStringCbPrintfA(Identifier, sizeof(Identifier), "PC98_LaptopKEY"); + Identifier = "PC98_LaptopKEY"; /* Create controller key */ FldrCreateComponentKey(ControllerKey, @@ -653,7 +648,6 @@ DetectKeyboardPeripheral(PCONFIGURATION_COMPONENT_DATA ControllerKey) PartialResourceList, Size, &PeripheralKey); - TRACE("Created key: KeyboardPeripheral\\0\n"); } static VOID @@ -714,7 +708,6 @@ DetectKeyboardController(PCONFIGURATION_COMPONENT_DATA BusKey) PartialResourceList, Size, &ControllerKey); - TRACE("Created key: KeyboardController\\0\n"); DetectKeyboardPeripheral(ControllerKey); } @@ -801,7 +794,6 @@ DetectParallelPorts(PCONFIGURATION_COMPONENT_DATA BusKey) PartialResourceList, Size, &ControllerKey); - TRACE("Created key: ParallelController\\0\n"); } static VOID @@ -898,7 +890,6 @@ DetectSerialPorts(PCONFIGURATION_COMPONENT_DATA BusKey) PartialResourceList, Size, &ControllerKey); - TRACE("Created key: SerialController\\%d\n", ControllerNumber); ++ControllerNumber; } @@ -963,7 +954,6 @@ DetectSerialPorts(PCONFIGURATION_COMPONENT_DATA BusKey) PartialResourceList, Size, &ControllerKey); - TRACE("Created key: SerialController\\%d\n", ControllerNumber); ++ControllerNumber; } @@ -994,7 +984,7 @@ DetectCBusBios(PCONFIGURATION_COMPONENT_DATA SystemKey, ULONG *BusNumber) FldrCreateComponentKey(SystemKey, AdapterClass, MultiFunctionAdapter, - 0x0, + 0, 0, 0xFFFFFFFF, "ISA", @@ -1043,7 +1033,7 @@ DetectNesaBios(PCONFIGURATION_COMPONENT_DATA SystemKey, ULONG *BusNumber) FldrCreateComponentKey(SystemKey, AdapterClass, MultiFunctionAdapter, - 0x0, + 0, 0, 0xFFFFFFFF, "EISA", @@ -1178,8 +1168,8 @@ DetectPnpBios(PCONFIGURATION_COMPONENT_DATA SystemKey, ULONG *BusNumber) FldrCreateComponentKey(SystemKey, AdapterClass, MultiFunctionAdapter, - 0x0, - 0x0, + 0, + 0, 0xFFFFFFFF, "PNP BIOS", PartialResourceList, @@ -1198,8 +1188,7 @@ Pc98HwDetect(VOID) TRACE("DetectHardware()\n"); /* Create the 'System' key */ - FldrCreateSystemKey(&SystemKey); - FldrSetIdentifier(SystemKey, "NEC PC-98"); + FldrCreateSystemKey(&SystemKey, "NEC PC-98"); GetHarddiskConfigurationData = Pc98GetHarddiskConfigurationData; FindPciBios = PcFindPciBios; diff --git a/boot/freeldr/freeldr/arch/i386/xbox/machxbox.c b/boot/freeldr/freeldr/arch/i386/xbox/machxbox.c index 0aba6db9c49..0574cd307a5 100644 --- a/boot/freeldr/freeldr/arch/i386/xbox/machxbox.c +++ b/boot/freeldr/freeldr/arch/i386/xbox/machxbox.c @@ -157,7 +157,6 @@ XboxGetHarddiskConfigurationData(UCHAR DriveNumber, ULONG* pSize) static VOID DetectDisplayController(PCONFIGURATION_COMPONENT_DATA BusKey) { - CHAR Buffer[80]; PCONFIGURATION_COMPONENT_DATA ControllerKey; PCM_PARTIAL_RESOURCE_LIST PartialResourceList; PCM_PARTIAL_RESOURCE_DESCRIPTOR PartialDescriptor; @@ -166,8 +165,6 @@ DetectDisplayController(PCONFIGURATION_COMPONENT_DATA BusKey) if (FrameBufferSize == 0) return; - strcpy(Buffer, "NV2A Framebuffer"); - Size = sizeof(CM_PARTIAL_RESOURCE_LIST); PartialResourceList = FrLdrHeapAlloc(Size, TAG_HW_RESOURCE_LIST); if (PartialResourceList == NULL) @@ -193,15 +190,13 @@ DetectDisplayController(PCONFIGURATION_COMPONENT_DATA BusKey) FldrCreateComponentKey(BusKey, ControllerClass, DisplayController, - 0x0, - 0x0, + Output | ConsoleOut, + 0, 0xFFFFFFFF, - Buffer, + "NV2A Framebuffer", PartialResourceList, Size, &ControllerKey); - - TRACE("Created key: DisplayController\\0\n"); } static @@ -232,8 +227,8 @@ DetectIsaBios(PCONFIGURATION_COMPONENT_DATA SystemKey, ULONG *BusNumber) FldrCreateComponentKey(SystemKey, AdapterClass, MultiFunctionAdapter, - 0x0, - 0x0, + 0, + 0, 0xFFFFFFFF, "ISA", PartialResourceList, @@ -276,8 +271,7 @@ XboxHwDetect(VOID) TRACE("DetectHardware()\n"); /* Create the 'System' key */ - FldrCreateSystemKey(&SystemKey); - FldrSetIdentifier(SystemKey, "Original Xbox (PC/AT like)"); + FldrCreateSystemKey(&SystemKey, "Original Xbox (PC/AT like)"); GetHarddiskConfigurationData = XboxGetHarddiskConfigurationData; FindPciBios = XboxFindPciBios; diff --git a/boot/freeldr/freeldr/include/arch/archwsup.h b/boot/freeldr/freeldr/include/arch/archwsup.h index bbf50dcbfe6..c8f2cd0ef3e 100644 --- a/boot/freeldr/freeldr/include/arch/archwsup.h +++ b/boot/freeldr/freeldr/include/arch/archwsup.h @@ -33,39 +33,27 @@ AddReactOSArcDiskInfo( // ARC Component Configuration Routines // VOID -NTAPI -FldrSetIdentifier( - IN PCONFIGURATION_COMPONENT_DATA ComponentData, - IN PCHAR IdentifierString -); - -VOID -NTAPI FldrSetConfigurationData( - IN PCONFIGURATION_COMPONENT_DATA ComponentData, - IN PCM_PARTIAL_RESOURCE_LIST ResourceList, - IN ULONG Size -); + _Inout_ PCONFIGURATION_COMPONENT_DATA ComponentData, + _In_ PCM_PARTIAL_RESOURCE_LIST ResourceList, + _In_ ULONG Size); VOID -NTAPI FldrCreateSystemKey( - OUT PCONFIGURATION_COMPONENT_DATA *SystemKey -); + _Out_ PCONFIGURATION_COMPONENT_DATA* SystemNode, + _In_ PCSTR IdentifierString); VOID -NTAPI FldrCreateComponentKey( - IN PCONFIGURATION_COMPONENT_DATA SystemKey, - IN CONFIGURATION_CLASS Class, - IN CONFIGURATION_TYPE Type, - IN IDENTIFIER_FLAG Flags, - IN ULONG Key, - IN ULONG Affinity, - IN PCHAR IdentifierString, - IN PCM_PARTIAL_RESOURCE_LIST ResourceList, - IN ULONG Size, - OUT PCONFIGURATION_COMPONENT_DATA *ComponentKey -); + _In_ PCONFIGURATION_COMPONENT_DATA SystemNode, + _In_ CONFIGURATION_CLASS Class, + _In_ CONFIGURATION_TYPE Type, + _In_ IDENTIFIER_FLAG Flags, + _In_ ULONG Key, + _In_ ULONG Affinity, + _In_ PCSTR IdentifierString, + _In_ PCM_PARTIAL_RESOURCE_LIST ResourceList, + _In_ ULONG Size, + _Out_ PCONFIGURATION_COMPONENT_DATA* ComponentKey); /* EOF */

1 0

[reactos] 07/07: [NTOS:IO] iorsrce.c: Add DBG traces for bus/device enumeration functions.
by Hermès Bélusca-Maïto 04 Jun '23

04 Jun '23

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=0b695a6f701296ffa4209… commit 0b695a6f701296ffa420939b1d3ada5b44f2487f Author: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> AuthorDate: Sun May 28 22:44:08 2023 +0200 Commit: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> CommitDate: Sun Jun 4 21:40:08 2023 +0200 [NTOS:IO] iorsrce.c: Add DBG traces for bus/device enumeration functions. --- ntoskrnl/io/iomgr/iorsrce.c | 74 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) diff --git a/ntoskrnl/io/iomgr/iorsrce.c b/ntoskrnl/io/iomgr/iorsrce.c index d5f40023728..01f2b104a84 100644 --- a/ntoskrnl/io/iomgr/iorsrce.c +++ b/ntoskrnl/io/iomgr/iorsrce.c @@ -12,8 +12,19 @@ /* INCLUDES *****************************************************************/ #include <ntoskrnl.h> +#define NDEBUG #include <debug.h> +#ifndef NDEBUG + #define IORSRCTRACE(...) DbgPrint(__VA_ARGS__) +#else + #if defined(_MSC_VER) + #define IORSRCTRACE __noop + #else + #define IORSRCTRACE(...) do { if(0) { DbgPrint(__VA_ARGS__); } } while(0) + #endif +#endif + /* GLOBALS *******************************************************************/ static CONFIGURATION_INFORMATION @@ -150,6 +161,14 @@ IopQueryDeviceDescription( UNICODE_STRING TempString; WCHAR TempBuffer[14]; + IORSRCTRACE("\nIopQueryDeviceDescription(Query: 0x%p)\n" + " RootKey: '%wZ'\n" + " RootKeyHandle: 0x%p\n" + " Bus: %lu\n", + Query, + &RootKey, RootKeyHandle, + Bus); + /* Temporary string */ TempString.MaximumLength = sizeof(TempBuffer); TempString.Length = 0; @@ -164,9 +183,12 @@ IopQueryDeviceDescription( { ControllerNumber = *Query->ControllerNumber; MaximumControllerNumber = ControllerNumber + 1; + IORSRCTRACE(" Getting controller #%lu\n", ControllerNumber); } else { + IORSRCTRACE(" Enumerating controllers in '%wZ'...\n", &ControllerRootRegName); + /* Find out how many controllers there are */ InitializeObjectAttributes(&ObjectAttributes, &ControllerRootRegName, @@ -234,6 +256,8 @@ IopQueryDeviceDescription( if (!NT_SUCCESS(Status)) break; + IORSRCTRACE(" Retrieving controller '%wZ'\n", &ControllerRootRegName); + /* Open the registry key */ InitializeObjectAttributes(&ObjectAttributes, &ControllerRootRegName, @@ -289,6 +313,9 @@ IopQueryDeviceDescription( /* We now have bus *AND* controller information, is it enough? */ if (!Query->PeripheralType || !(*Query->PeripheralType)) { + IORSRCTRACE(" --> Bus #%lu Controller #%lu Callout: '%wZ'\n", + Bus, ControllerNumber, &ControllerRootRegName); + Status = Query->CalloutRoutine(Query->Context, &ControllerRootRegName, *Query->BusType, @@ -316,9 +343,12 @@ IopQueryDeviceDescription( { PeripheralNumber = *Query->PeripheralNumber; MaximumPeripheralNumber = PeripheralNumber + 1; + IORSRCTRACE(" Getting peripheral #%lu\n", PeripheralNumber); } else { + IORSRCTRACE(" Enumerating peripherals in '%wZ'...\n", &ControllerRootRegName); + /* Find out how many peripherals there are */ InitializeObjectAttributes(&ObjectAttributes, &ControllerRootRegName, @@ -385,6 +415,8 @@ IopQueryDeviceDescription( if (!NT_SUCCESS(Status)) break; + IORSRCTRACE(" Retrieving peripheral '%wZ'\n", &ControllerRootRegName); + /* Open the registry key */ InitializeObjectAttributes(&ObjectAttributes, &ControllerRootRegName, @@ -435,6 +467,9 @@ IopQueryDeviceDescription( /* We now have everything the caller could possibly want */ if (NT_SUCCESS(Status)) { + IORSRCTRACE(" --> Bus #%lu Controller #%lu Peripheral #%lu Callout: '%wZ'\n", + Bus, ControllerNumber, PeripheralNumber, &ControllerRootRegName); + Status = Query->CalloutRoutine(Query->Context, &ControllerRootRegName, *Query->BusType, @@ -531,6 +566,16 @@ IopQueryBusDescription( PKEY_VALUE_FULL_INFORMATION BusInformation[IoQueryDeviceMaxData] = {NULL, NULL, NULL}; + IORSRCTRACE("\nIopQueryBusDescription(Query: 0x%p)\n" + " RootKey: '%wZ'\n" + " RootKeyHandle: 0x%p\n" + " KeyIsRoot: %s\n" + " Bus: 0x%p (%lu)\n", + Query, + &RootKey, RootKeyHandle, + KeyIsRoot ? "TRUE" : "FALSE", + Bus, Bus ? *Bus : -1); + /* Retrieve the necessary buffer space */ Status = ZwQueryKey(RootKeyHandle, KeyFullInformation, @@ -587,6 +632,8 @@ IopQueryBusDescription( if (!NT_SUCCESS(Status)) break; + IORSRCTRACE(" Seen: '%.*ws'\n", BasicInformation->NameLength/sizeof(WCHAR), BasicInformation->Name); + /* What bus are we going to go down? (only check if this is a root key) */ if (KeyIsRoot) { @@ -622,6 +669,8 @@ IopQueryBusDescription( RtlAppendUnicodeToString(&SubRootRegName, L"\\"); RtlAppendUnicodeStringToString(&SubRootRegName, &BusString); + IORSRCTRACE(" SubRootRegName: '%wZ'\n", &SubRootRegName); + if (!KeyIsRoot) { /* Parsing a sub-bus key */ @@ -631,6 +680,8 @@ IopQueryBusDescription( /* Identifier string first */ RtlInitUnicodeString(&SubBusString, IoDeviceInfoNames[SubBusLoop]); + IORSRCTRACE(" Getting bus value: '%wZ'\n", &SubBusString); + /* Retrieve the necessary buffer space */ ZwQueryValueKey(SubRootKeyHandle, &SubBusString, @@ -670,6 +721,8 @@ IopQueryBusDescription( { if (Query->ControllerType == NULL) { + IORSRCTRACE(" --> Bus #%lu Callout: '%wZ'\n", *Bus, &SubRootRegName); + /* We don't want controller information: call the callback */ Status = Query->CalloutRoutine(Query->Context, &SubRootRegName, @@ -685,6 +738,8 @@ IopQueryBusDescription( } else { + IORSRCTRACE(" --> Getting device on Bus #%lu : '%wZ'\n", *Bus, &SubRootRegName); + /* We want controller information: get it */ Status = IopQueryDeviceDescription(Query, SubRootRegName, @@ -1143,6 +1198,25 @@ IoQueryDeviceDescription( HANDLE RootRegHandle; IO_QUERY Query; + IORSRCTRACE("\nIoQueryDeviceDescription()\n" + " BusType: 0x%p (%lu)\n" + " BusNumber: 0x%p (%lu)\n" + " ControllerType: 0x%p (%lu)\n" + " ControllerNumber: 0x%p (%lu)\n" + " PeripheralType: 0x%p (%lu)\n" + " PeripheralNumber: 0x%p (%lu)\n" + " CalloutRoutine: 0x%p\n" + " Context: 0x%p\n" + "--> Query: 0x%p\n", + BusType, BusType ? *BusType : -1, + BusNumber, BusNumber ? *BusNumber : -1, + ControllerType, ControllerType ? *ControllerType : -1, + ControllerNumber, ControllerNumber ? *ControllerNumber : -1, + PeripheralType, PeripheralType ? *PeripheralType : -1, + PeripheralNumber, PeripheralNumber ? *PeripheralNumber : -1, + CalloutRoutine, Context, + &Query); + /* Set up the string */ RootRegKey.Length = 0; RootRegKey.MaximumLength = 2048;

1 0

[reactos] 06/07: [NTOS:IO] Reformat iorsrce.c, no functional code changes.
by Hermès Bélusca-Maïto 04 Jun '23

04 Jun '23

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=2674e26cbb0de1ea71c01… commit 2674e26cbb0de1ea71c01348f46b1b937baae4d5 Author: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> AuthorDate: Sat May 27 22:48:50 2023 +0200 Commit: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> CommitDate: Sun Jun 4 21:40:07 2023 +0200 [NTOS:IO] Reformat iorsrce.c, no functional code changes. - Fix whitespace; add SAL annotations, doxygen documentation... - Deduplicate the array of description strings corresponding to IO_QUERY_DEVICE_DATA_FORMAT. - Unhardcode the "[3]" into 'IoQueryDeviceMaxData': the maximum number of device data queried. --- ntoskrnl/include/internal/io.h | 16 +- ntoskrnl/io/iomgr/iorsrce.c | 1703 +++++++++++++++++++++------------------- sdk/include/xdk/iofuncs.h | 2 +- 3 files changed, 918 insertions(+), 803 deletions(-) diff --git a/ntoskrnl/include/internal/io.h b/ntoskrnl/include/internal/io.h index d877bd6fa97..13b0b6364ea 100644 --- a/ntoskrnl/include/internal/io.h +++ b/ntoskrnl/include/internal/io.h @@ -1330,17 +1330,17 @@ IopStartRamdisk( // Configuration Routines // NTSTATUS -NTAPI -IopFetchConfigurationInformation(OUT PWSTR * SymbolicLinkList, - IN GUID Guid, - IN ULONG ExpectedInterfaces, - IN PULONG Interfaces +IopFetchConfigurationInformation( + _Out_ PWSTR* SymbolicLinkList, + _In_ GUID Guid, + _In_ ULONG ExpectedInterfaces, + _Out_ PULONG Interfaces ); VOID -NTAPI -IopStoreSystemPartitionInformation(IN PUNICODE_STRING NtSystemPartitionDeviceName, - IN PUNICODE_STRING OsLoaderPathName +IopStoreSystemPartitionInformation( + _In_ PUNICODE_STRING NtSystemPartitionDeviceName, + _In_ PUNICODE_STRING OsLoaderPathName ); // diff --git a/ntoskrnl/io/iomgr/iorsrce.c b/ntoskrnl/io/iomgr/iorsrce.c index d3e1abf3039..d5f40023728 100644 --- a/ntoskrnl/io/iomgr/iorsrce.c +++ b/ntoskrnl/io/iomgr/iorsrce.c @@ -1,12 +1,12 @@ /* - * COPYRIGHT: See COPYING in the top level directory - * PROJECT: ReactOS kernel - * FILE: ntoskrnl/io/iomgr/iorsrce.c - * PURPOSE: Hardware resource managment - * - * PROGRAMMERS: David Welch (welch(a)mcmail.com) - * Alex Ionescu (alex(a)relsoft.net) - * Pierre Schweitzer (pierre.schweitzer(a)reactos.org) + * PROJECT: ReactOS Kernel + * LICENSE: GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later) + * PURPOSE: Hardware resource management + * COPYRIGHT: Copyright 1998 David Welch <welch(a)mcmail.com> + * Copyright 2001 Eric Kohl <eric.kohl(a)reactos.org> + * Copyright 2004-2013 Alex Ionescu <alex.ionescu(a)reactos.org> + * Copyright 2010 Cameron Gutman <cameron.gutman(a)reactos.org> + * Copyright 2010 Pierre Schweitzer <pierre(a)reactos.org> */ /* INCLUDES *****************************************************************/ @@ -19,19 +19,22 @@ static CONFIGURATION_INFORMATION _SystemConfigurationInformation = { 0, 0, 0, 0, 0, 0, 0, FALSE, FALSE, 0, 0 }; -/* API Parameters to Pass in IopQueryBusDescription */ -typedef struct IO_QUERY { - PINTERFACE_TYPE BusType; - PULONG BusNumber; - PCONFIGURATION_TYPE ControllerType; - PULONG ControllerNumber; - PCONFIGURATION_TYPE PeripheralType; - PULONG PeripheralNumber; - PIO_QUERY_DEVICE_ROUTINE CalloutRoutine; - PVOID Context; +/* API parameters to pass to IopQueryBusDescription() */ +typedef struct _IO_QUERY +{ + PINTERFACE_TYPE BusType; + PULONG BusNumber; + PCONFIGURATION_TYPE ControllerType; + PULONG ControllerNumber; + PCONFIGURATION_TYPE PeripheralType; + PULONG PeripheralNumber; + PIO_QUERY_DEVICE_ROUTINE CalloutRoutine; + PVOID Context; } IO_QUERY, *PIO_QUERY; -PWSTR ArcTypes[42] = { +/* Strings corresponding to CONFIGURATION_TYPE */ +PCWSTR ArcTypes[MaximumType + 1] = +{ L"System", L"CentralProcessor", L"FloatingPointProcessor", @@ -76,626 +79,702 @@ PWSTR ArcTypes[42] = { L"Undefined" }; +/* Strings corresponding to IO_QUERY_DEVICE_DATA_FORMAT */ +PCWSTR IoDeviceInfoNames[IoQueryDeviceMaxData] = +{ + L"Identifier", + L"Configuration Data", + L"Component Information" +}; + /* PRIVATE FUNCTIONS **********************************************************/ -/* - * IopQueryDeviceDescription +/** + * @brief + * Reads and returns Hardware information from the appropriate hardware + * registry key. Helper stub of IopQueryBusDescription(). * - * FUNCTION: - * Reads and returns Hardware information from the appropriate hardware - * registry key. Helper sub of IopQueryBusDescription. + * @param[in] Query + * What the parent function wants. * - * ARGUMENTS: - * Query - What the parent function wants. - * RootKey - Which key to look in - * RootKeyHandle - Handle to the key - * Bus - Bus Number. - * BusInformation - The Configuration Information Sent + * @param[in] RootKey + * Which key to look in. * - * RETURNS: - * Status - */ - -NTSTATUS NTAPI + * @param[in] RootKeyHandle + * Handle to the key. + * + * @param[in] Bus + * The bus number. + * + * @param[in] BusInformation + * The configuration information being sent. + * + * @return A status code. + **/ +static NTSTATUS IopQueryDeviceDescription( - PIO_QUERY Query, - UNICODE_STRING RootKey, - HANDLE RootKeyHandle, - ULONG Bus, - PKEY_VALUE_FULL_INFORMATION *BusInformation) + _In_ PIO_QUERY Query, + _In_ UNICODE_STRING RootKey, + _In_ HANDLE RootKeyHandle, + _In_ ULONG Bus, + _In_ PKEY_VALUE_FULL_INFORMATION* BusInformation) { - NTSTATUS Status = STATUS_SUCCESS; - - /* Controller Stuff */ - UNICODE_STRING ControllerString; - UNICODE_STRING ControllerRootRegName = RootKey; - UNICODE_STRING ControllerRegName; - HANDLE ControllerKeyHandle; - PKEY_FULL_INFORMATION ControllerFullInformation = NULL; - PKEY_VALUE_FULL_INFORMATION ControllerInformation[3] = {NULL, NULL, NULL}; - ULONG ControllerNumber; - ULONG ControllerLoop; - ULONG MaximumControllerNumber; - - /* Peripheral Stuff */ - UNICODE_STRING PeripheralString; - HANDLE PeripheralKeyHandle; - PKEY_FULL_INFORMATION PeripheralFullInformation; - PKEY_VALUE_FULL_INFORMATION PeripheralInformation[3] = {NULL, NULL, NULL}; - ULONG PeripheralNumber; - ULONG PeripheralLoop; - ULONG MaximumPeripheralNumber; - - /* Global Registry Stuff */ - OBJECT_ATTRIBUTES ObjectAttributes; - ULONG LenFullInformation; - ULONG LenKeyFullInformation; - UNICODE_STRING TempString; - WCHAR TempBuffer[14]; - PWSTR Strings[3] = { - L"Identifier", - L"Configuration Data", - L"Component Information" - }; - - /* Temporary String */ - TempString.MaximumLength = sizeof(TempBuffer); - TempString.Length = 0; - TempString.Buffer = TempBuffer; - - /* Add Controller Name to String */ - RtlAppendUnicodeToString(&ControllerRootRegName, L"\\"); - RtlAppendUnicodeToString(&ControllerRootRegName, ArcTypes[*Query->ControllerType]); - - /* Set the Controller Number if specified */ - if (Query->ControllerNumber && *(Query->ControllerNumber)) - { - ControllerNumber = *Query->ControllerNumber; - MaximumControllerNumber = ControllerNumber + 1; - } else { - /* Find out how many Controller Numbers there are */ - InitializeObjectAttributes( - &ObjectAttributes, - &ControllerRootRegName, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = ZwOpenKey(&ControllerKeyHandle, KEY_READ, &ObjectAttributes); - if (NT_SUCCESS(Status)) - { - /* How much buffer space */ - ZwQueryKey(ControllerKeyHandle, KeyFullInformation, NULL, 0, &LenFullInformation); - - /* Allocate it */ - ControllerFullInformation = ExAllocatePoolWithTag(PagedPool, LenFullInformation, TAG_IO_RESOURCE); - - /* Get the Information */ - Status = ZwQueryKey(ControllerKeyHandle, KeyFullInformation, ControllerFullInformation, LenFullInformation, &LenFullInformation); - ZwClose(ControllerKeyHandle); - ControllerKeyHandle = NULL; - } - - /* No controller was found, go back to function. */ - if (!NT_SUCCESS(Status)) - { - if (ControllerFullInformation != NULL) - ExFreePoolWithTag(ControllerFullInformation, TAG_IO_RESOURCE); - return Status; - } - - /* Find out Controller Numbers */ - ControllerNumber = 0; - MaximumControllerNumber = ControllerFullInformation->SubKeys; - - /* Free Memory */ - ExFreePoolWithTag(ControllerFullInformation, TAG_IO_RESOURCE); - ControllerFullInformation = NULL; - } - - /* Save String */ - ControllerRegName = ControllerRootRegName; - - /* Loop through controllers */ - for (; ControllerNumber < MaximumControllerNumber; ControllerNumber++) - { - /* Load String */ - ControllerRootRegName = ControllerRegName; - - /* Controller Number to Registry String */ - Status = RtlIntegerToUnicodeString(ControllerNumber, 10, &TempString); - - /* Create String */ - Status |= RtlAppendUnicodeToString(&ControllerRootRegName, L"\\"); - Status |= RtlAppendUnicodeStringToString(&ControllerRootRegName, &TempString); - - /* Something messed up */ - if (!NT_SUCCESS(Status)) break; - - /* Open the Registry Key */ - InitializeObjectAttributes( - &ObjectAttributes, - &ControllerRootRegName, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = ZwOpenKey(&ControllerKeyHandle, KEY_READ, &ObjectAttributes); - - /* Read the Configuration Data... */ - if (NT_SUCCESS(Status)) - { - for (ControllerLoop = 0; ControllerLoop < 3; ControllerLoop++) - { - /* Identifier String First */ - RtlInitUnicodeString(&ControllerString, Strings[ControllerLoop]); - - /* How much buffer space */ - Status = ZwQueryValueKey(ControllerKeyHandle, &ControllerString, KeyValueFullInformation, NULL, 0, &LenKeyFullInformation); - - if (!NT_SUCCESS(Status) && Status != STATUS_BUFFER_TOO_SMALL && Status != STATUS_BUFFER_OVERFLOW) - continue; + NTSTATUS Status = STATUS_SUCCESS; + + /* Controller data */ + UNICODE_STRING ControllerString; + UNICODE_STRING ControllerRootRegName = RootKey; + UNICODE_STRING ControllerRegName; + HANDLE ControllerKeyHandle; + PKEY_FULL_INFORMATION ControllerFullInformation = NULL; + PKEY_VALUE_FULL_INFORMATION ControllerInformation[IoQueryDeviceMaxData] = + {NULL, NULL, NULL}; + ULONG ControllerNumber; + ULONG ControllerLoop; + ULONG MaximumControllerNumber; + + /* Peripheral data */ + UNICODE_STRING PeripheralString; + HANDLE PeripheralKeyHandle; + PKEY_FULL_INFORMATION PeripheralFullInformation; + PKEY_VALUE_FULL_INFORMATION PeripheralInformation[IoQueryDeviceMaxData] = + {NULL, NULL, NULL}; + ULONG PeripheralNumber; + ULONG PeripheralLoop; + ULONG MaximumPeripheralNumber; + + /* Global Registry data */ + OBJECT_ATTRIBUTES ObjectAttributes; + ULONG LenFullInformation; + ULONG LenKeyFullInformation; + UNICODE_STRING TempString; + WCHAR TempBuffer[14]; + + /* Temporary string */ + TempString.MaximumLength = sizeof(TempBuffer); + TempString.Length = 0; + TempString.Buffer = TempBuffer; + + /* Append controller name to string */ + RtlAppendUnicodeToString(&ControllerRootRegName, L"\\"); + RtlAppendUnicodeToString(&ControllerRootRegName, ArcTypes[*Query->ControllerType]); + + /* Set the controller number if specified */ + if (Query->ControllerNumber && *(Query->ControllerNumber)) + { + ControllerNumber = *Query->ControllerNumber; + MaximumControllerNumber = ControllerNumber + 1; + } + else + { + /* Find out how many controllers there are */ + InitializeObjectAttributes(&ObjectAttributes, + &ControllerRootRegName, + OBJ_CASE_INSENSITIVE, + NULL, + NULL); - /* Allocate it */ - ControllerInformation[ControllerLoop] = ExAllocatePoolWithTag(PagedPool, LenKeyFullInformation, TAG_IO_RESOURCE); - - /* Get the Information */ - Status = ZwQueryValueKey(ControllerKeyHandle, &ControllerString, KeyValueFullInformation, ControllerInformation[ControllerLoop], LenKeyFullInformation, &LenKeyFullInformation); - } - - /* Clean Up */ - ZwClose(ControllerKeyHandle); - ControllerKeyHandle = NULL; - } - - /* Something messed up */ - if (!NT_SUCCESS(Status)) - goto EndLoop; - - /* We now have Bus *AND* Controller Information.. is it enough? */ - if (!Query->PeripheralType || !(*Query->PeripheralType)) - { - Status = Query->CalloutRoutine( - Query->Context, - &ControllerRootRegName, - *Query->BusType, - Bus, - BusInformation, - *Query->ControllerType, - ControllerNumber, - ControllerInformation, - 0, - 0, - NULL); - goto EndLoop; - } - - /* Not enough...caller also wants peripheral name */ - Status = RtlAppendUnicodeToString(&ControllerRootRegName, L"\\"); - Status |= RtlAppendUnicodeToString(&ControllerRootRegName, ArcTypes[*Query->PeripheralType]); - - /* Something messed up */ - if (!NT_SUCCESS(Status)) goto EndLoop; - - /* Set the Peripheral Number if specified */ - if (Query->PeripheralNumber && *Query->PeripheralNumber) - { - PeripheralNumber = *Query->PeripheralNumber; - MaximumPeripheralNumber = PeripheralNumber + 1; - } else { - /* Find out how many Peripheral Numbers there are */ - InitializeObjectAttributes( - &ObjectAttributes, - &ControllerRootRegName, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = ZwOpenKey(&PeripheralKeyHandle, KEY_READ, &ObjectAttributes); - - if (NT_SUCCESS(Status)) - { - /* How much buffer space */ - ZwQueryKey(PeripheralKeyHandle, KeyFullInformation, NULL, 0, &LenFullInformation); + Status = ZwOpenKey(&ControllerKeyHandle, KEY_READ, &ObjectAttributes); + + if (NT_SUCCESS(Status)) + { + /* Retrieve the necessary buffer space */ + ZwQueryKey(ControllerKeyHandle, + KeyFullInformation, + NULL, 0, + &LenFullInformation); /* Allocate it */ - PeripheralFullInformation = ExAllocatePoolWithTag(PagedPool, LenFullInformation, TAG_IO_RESOURCE); - - /* Get the Information */ - Status = ZwQueryKey(PeripheralKeyHandle, KeyFullInformation, PeripheralFullInformation, LenFullInformation, &LenFullInformation); - ZwClose(PeripheralKeyHandle); - PeripheralKeyHandle = NULL; - } - - /* No controller was found, go back to function but clean up first */ - if (!NT_SUCCESS(Status)) - { - Status = STATUS_SUCCESS; - goto EndLoop; - } + ControllerFullInformation = ExAllocatePoolWithTag(PagedPool, LenFullInformation, TAG_IO_RESOURCE); + + /* Get the information */ + Status = ZwQueryKey(ControllerKeyHandle, + KeyFullInformation, + ControllerFullInformation, + LenFullInformation, + &LenFullInformation); + ZwClose(ControllerKeyHandle); + ControllerKeyHandle = NULL; + } + + /* No controller was found, bail out */ + if (!NT_SUCCESS(Status)) + { + if (ControllerFullInformation != NULL) + ExFreePoolWithTag(ControllerFullInformation, TAG_IO_RESOURCE); + return Status; + } - /* Find out Peripheral Number */ - PeripheralNumber = 0; - MaximumPeripheralNumber = PeripheralFullInformation->SubKeys; + /* Find out the controllers */ + ControllerNumber = 0; + MaximumControllerNumber = ControllerFullInformation->SubKeys; - /* Free Memory */ - ExFreePoolWithTag(PeripheralFullInformation, TAG_IO_RESOURCE); - PeripheralFullInformation = NULL; - } + /* Cleanup */ + ExFreePoolWithTag(ControllerFullInformation, TAG_IO_RESOURCE); + ControllerFullInformation = NULL; + } - /* Save Name */ - ControllerRegName = ControllerRootRegName; + /* Save string */ + ControllerRegName = ControllerRootRegName; - /* Loop through Peripherals */ - for (; PeripheralNumber < MaximumPeripheralNumber; PeripheralNumber++) - { - /* Restore Name */ - ControllerRootRegName = ControllerRegName; + /* Loop through controllers */ + for (; ControllerNumber < MaximumControllerNumber; ControllerNumber++) + { + /* Load string */ + ControllerRootRegName = ControllerRegName; - /* Peripheral Number to Registry String */ - Status = RtlIntegerToUnicodeString(PeripheralNumber, 10, &TempString); + /* Convert controller number to registry string */ + Status = RtlIntegerToUnicodeString(ControllerNumber, 10, &TempString); - /* Create String */ - Status |= RtlAppendUnicodeToString(&ControllerRootRegName, L"\\"); - Status |= RtlAppendUnicodeStringToString(&ControllerRootRegName, &TempString); + /* Create string */ + Status |= RtlAppendUnicodeToString(&ControllerRootRegName, L"\\"); + Status |= RtlAppendUnicodeStringToString(&ControllerRootRegName, &TempString); - /* Something messed up */ - if (!NT_SUCCESS(Status)) break; + /* Something messed up */ + if (!NT_SUCCESS(Status)) + break; - /* Open the Registry Key */ - InitializeObjectAttributes( - &ObjectAttributes, - &ControllerRootRegName, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); + /* Open the registry key */ + InitializeObjectAttributes(&ObjectAttributes, + &ControllerRootRegName, + OBJ_CASE_INSENSITIVE, + NULL, + NULL); - Status = ZwOpenKey(&PeripheralKeyHandle, KEY_READ, &ObjectAttributes); + Status = ZwOpenKey(&ControllerKeyHandle, KEY_READ, &ObjectAttributes); - if (NT_SUCCESS(Status)) - { - for (PeripheralLoop = 0; PeripheralLoop < 3; PeripheralLoop++) + /* Read the configuration data */ + if (NT_SUCCESS(Status)) + { + for (ControllerLoop = 0; ControllerLoop < RTL_NUMBER_OF(IoDeviceInfoNames); ControllerLoop++) { - /* Identifier String First */ - RtlInitUnicodeString(&PeripheralString, Strings[PeripheralLoop]); + /* Identifier string first */ + RtlInitUnicodeString(&ControllerString, IoDeviceInfoNames[ControllerLoop]); + + /* Retrieve the necessary buffer space */ + Status = ZwQueryValueKey(ControllerKeyHandle, + &ControllerString, + KeyValueFullInformation, + NULL, 0, + &LenKeyFullInformation); + + if (!NT_SUCCESS(Status) && + (Status != STATUS_BUFFER_TOO_SMALL) && + (Status != STATUS_BUFFER_OVERFLOW)) + { + continue; + } + + /* Allocate it */ + ControllerInformation[ControllerLoop] = ExAllocatePoolWithTag(PagedPool, LenKeyFullInformation, TAG_IO_RESOURCE); + + /* Get the information */ + Status = ZwQueryValueKey(ControllerKeyHandle, + &ControllerString, + KeyValueFullInformation, + ControllerInformation[ControllerLoop], + LenKeyFullInformation, + &LenKeyFullInformation); + } - /* How much buffer space */ - Status = ZwQueryValueKey(PeripheralKeyHandle, &PeripheralString, KeyValueFullInformation, NULL, 0, &LenKeyFullInformation); + /* Cleanup */ + ZwClose(ControllerKeyHandle); + ControllerKeyHandle = NULL; + } - if (!NT_SUCCESS(Status) && Status != STATUS_BUFFER_TOO_SMALL && Status != STATUS_BUFFER_OVERFLOW) - { - PeripheralInformation[PeripheralLoop] = NULL; - continue; - } + /* Something messed up */ + if (!NT_SUCCESS(Status)) + goto EndLoop; - /* Allocate it */ - PeripheralInformation[PeripheralLoop] = ExAllocatePoolWithTag(PagedPool, LenKeyFullInformation, TAG_IO_RESOURCE); + /* We now have bus *AND* controller information, is it enough? */ + if (!Query->PeripheralType || !(*Query->PeripheralType)) + { + Status = Query->CalloutRoutine(Query->Context, + &ControllerRootRegName, + *Query->BusType, + Bus, + BusInformation, + *Query->ControllerType, + ControllerNumber, + ControllerInformation, + 0, + 0, + NULL); + goto EndLoop; + } - /* Get the Information */ - Status = ZwQueryValueKey(PeripheralKeyHandle, &PeripheralString, KeyValueFullInformation, PeripheralInformation[PeripheralLoop], LenKeyFullInformation, &LenKeyFullInformation); - } + /* Not enough: the caller also wants peripheral name */ + Status = RtlAppendUnicodeToString(&ControllerRootRegName, L"\\"); + Status |= RtlAppendUnicodeToString(&ControllerRootRegName, ArcTypes[*Query->PeripheralType]); - /* Clean Up */ - ZwClose(PeripheralKeyHandle); - PeripheralKeyHandle = NULL; + /* Something messed up */ + if (!NT_SUCCESS(Status)) + goto EndLoop; + + /* Set the peripheral number if specified */ + if (Query->PeripheralNumber && *Query->PeripheralNumber) + { + PeripheralNumber = *Query->PeripheralNumber; + MaximumPeripheralNumber = PeripheralNumber + 1; + } + else + { + /* Find out how many peripherals there are */ + InitializeObjectAttributes(&ObjectAttributes, + &ControllerRootRegName, + OBJ_CASE_INSENSITIVE, + NULL, + NULL); + + Status = ZwOpenKey(&PeripheralKeyHandle, KEY_READ, &ObjectAttributes); - /* We now have everything the caller could possibly want */ if (NT_SUCCESS(Status)) { - Status = Query->CalloutRoutine( - Query->Context, - &ControllerRootRegName, - *Query->BusType, - Bus, - BusInformation, - *Query->ControllerType, - ControllerNumber, - ControllerInformation, - *Query->PeripheralType, - PeripheralNumber, - PeripheralInformation); + /* Retrieve the necessary buffer space */ + ZwQueryKey(PeripheralKeyHandle, + KeyFullInformation, + NULL, 0, + &LenFullInformation); + + /* Allocate it */ + PeripheralFullInformation = ExAllocatePoolWithTag(PagedPool, LenFullInformation, TAG_IO_RESOURCE); + + /* Get the information */ + Status = ZwQueryKey(PeripheralKeyHandle, + KeyFullInformation, + PeripheralFullInformation, + LenFullInformation, + &LenFullInformation); + ZwClose(PeripheralKeyHandle); + PeripheralKeyHandle = NULL; } - /* Free the allocated memory */ - for (PeripheralLoop = 0; PeripheralLoop < 3; PeripheralLoop++) + /* No controller was found, cleanup and bail out */ + if (!NT_SUCCESS(Status)) { - if (PeripheralInformation[PeripheralLoop]) - { - ExFreePoolWithTag(PeripheralInformation[PeripheralLoop], TAG_IO_RESOURCE); - PeripheralInformation[PeripheralLoop] = NULL; - } + Status = STATUS_SUCCESS; + goto EndLoop; } - /* Something Messed up */ - if (!NT_SUCCESS(Status)) break; - } - } + /* Find out peripheral number */ + PeripheralNumber = 0; + MaximumPeripheralNumber = PeripheralFullInformation->SubKeys; + + /* Cleanup */ + ExFreePoolWithTag(PeripheralFullInformation, TAG_IO_RESOURCE); + PeripheralFullInformation = NULL; + } + + /* Save name */ + ControllerRegName = ControllerRootRegName; + + /* Loop through peripherals */ + for (; PeripheralNumber < MaximumPeripheralNumber; PeripheralNumber++) + { + /* Restore name */ + ControllerRootRegName = ControllerRegName; + + /* Convert peripheral number to registry string */ + Status = RtlIntegerToUnicodeString(PeripheralNumber, 10, &TempString); + + /* Create string */ + Status |= RtlAppendUnicodeToString(&ControllerRootRegName, L"\\"); + Status |= RtlAppendUnicodeStringToString(&ControllerRootRegName, &TempString); + + /* Something messed up */ + if (!NT_SUCCESS(Status)) + break; + + /* Open the registry key */ + InitializeObjectAttributes(&ObjectAttributes, + &ControllerRootRegName, + OBJ_CASE_INSENSITIVE, + NULL, + NULL); + + Status = ZwOpenKey(&PeripheralKeyHandle, KEY_READ, &ObjectAttributes); + + if (NT_SUCCESS(Status)) + { + for (PeripheralLoop = 0; PeripheralLoop < RTL_NUMBER_OF(IoDeviceInfoNames); PeripheralLoop++) + { + /* Identifier string first */ + RtlInitUnicodeString(&PeripheralString, IoDeviceInfoNames[PeripheralLoop]); + + /* Retrieve the necessary buffer space */ + Status = ZwQueryValueKey(PeripheralKeyHandle, + &PeripheralString, + KeyValueFullInformation, + NULL, 0, + &LenKeyFullInformation); + + if (!NT_SUCCESS(Status) && + (Status != STATUS_BUFFER_TOO_SMALL) && + (Status != STATUS_BUFFER_OVERFLOW)) + { + PeripheralInformation[PeripheralLoop] = NULL; + continue; + } + + /* Allocate it */ + PeripheralInformation[PeripheralLoop] = ExAllocatePoolWithTag(PagedPool, LenKeyFullInformation, TAG_IO_RESOURCE); + + /* Get the information */ + Status = ZwQueryValueKey(PeripheralKeyHandle, + &PeripheralString, + KeyValueFullInformation, + PeripheralInformation[PeripheralLoop], + LenKeyFullInformation, + &LenKeyFullInformation); + } + + /* Cleanup */ + ZwClose(PeripheralKeyHandle); + PeripheralKeyHandle = NULL; + + /* We now have everything the caller could possibly want */ + if (NT_SUCCESS(Status)) + { + Status = Query->CalloutRoutine(Query->Context, + &ControllerRootRegName, + *Query->BusType, + Bus, + BusInformation, + *Query->ControllerType, + ControllerNumber, + ControllerInformation, + *Query->PeripheralType, + PeripheralNumber, + PeripheralInformation); + } + + /* Free the allocated memory */ + for (PeripheralLoop = 0; PeripheralLoop < RTL_NUMBER_OF(IoDeviceInfoNames); PeripheralLoop++) + { + if (PeripheralInformation[PeripheralLoop]) + { + ExFreePoolWithTag(PeripheralInformation[PeripheralLoop], TAG_IO_RESOURCE); + PeripheralInformation[PeripheralLoop] = NULL; + } + } + + /* Something messed up */ + if (!NT_SUCCESS(Status)) + break; + } + } EndLoop: - /* Free the allocated memory */ - for (ControllerLoop = 0; ControllerLoop < 3; ControllerLoop++) - { - if (ControllerInformation[ControllerLoop]) - { - ExFreePoolWithTag(ControllerInformation[ControllerLoop], TAG_IO_RESOURCE); - ControllerInformation[ControllerLoop] = NULL; - } - } - - /* Something Messed up */ - if (!NT_SUCCESS(Status)) break; - } - - return Status; + /* Free the allocated memory */ + for (ControllerLoop = 0; ControllerLoop < RTL_NUMBER_OF(IoDeviceInfoNames); ControllerLoop++) + { + if (ControllerInformation[ControllerLoop]) + { + ExFreePoolWithTag(ControllerInformation[ControllerLoop], TAG_IO_RESOURCE); + ControllerInformation[ControllerLoop] = NULL; + } + } + + /* Something messed up */ + if (!NT_SUCCESS(Status)) + break; + } + + return Status; } -/* - * IopQueryBusDescription +/** + * @brief + * Reads and returns Hardware information from the appropriate hardware + * registry key. Helper stub of IoQueryDeviceDescription(). Has two modes + * of operation, either looking for root bus types or for sub-bus + * information. * - * FUNCTION: - * Reads and returns Hardware information from the appropriate hardware - * registry key. Helper sub of IoQueryDeviceDescription. Has two modes - * of operation, either looking for Root Bus Types or for sub-Bus - * information. + * @param[in] Query + * What the parent function wants. * - * ARGUMENTS: - * Query - What the parent function wants. - * RootKey - Which key to look in - * RootKeyHandle - Handle to the key - * Bus - Bus Number. - * KeyIsRoot - Whether we are looking for Root Bus Types or - * information under them. + * @param[in] RootKey + * Which key to look in. * - * RETURNS: - * Status - */ - -NTSTATUS NTAPI + * @param[in] RootKeyHandle + * Handle to the key. + * + * @param[in,out] Bus + * Pointer to the current bus number. + * + * @param[in] KeyIsRoot + * Whether we are looking for root bus types or information under them. + * + * @return A status code. + **/ +static NTSTATUS IopQueryBusDescription( - PIO_QUERY Query, - UNICODE_STRING RootKey, - HANDLE RootKeyHandle, - PULONG Bus, - BOOLEAN KeyIsRoot) + _In_ PIO_QUERY Query, + _In_ UNICODE_STRING RootKey, + _In_ HANDLE RootKeyHandle, + _Inout_ PULONG Bus, + _In_ BOOLEAN KeyIsRoot) { - NTSTATUS Status; - ULONG BusLoop; - UNICODE_STRING SubRootRegName; - UNICODE_STRING BusString; - UNICODE_STRING SubBusString; - ULONG LenBasicInformation = 0; - ULONG LenFullInformation; - ULONG LenKeyFullInformation; - ULONG LenKey; - HANDLE SubRootKeyHandle; - PKEY_FULL_INFORMATION FullInformation; - PKEY_BASIC_INFORMATION BasicInformation = NULL; - OBJECT_ATTRIBUTES ObjectAttributes; - PKEY_VALUE_FULL_INFORMATION BusInformation[3] = {NULL, NULL, NULL}; - - /* How much buffer space */ - Status = ZwQueryKey(RootKeyHandle, KeyFullInformation, NULL, 0, &LenFullInformation); - - if (!NT_SUCCESS(Status) && Status != STATUS_BUFFER_TOO_SMALL && Status != STATUS_BUFFER_OVERFLOW) - return Status; - - /* Allocate it */ - FullInformation = ExAllocatePoolWithTag(PagedPool, LenFullInformation, TAG_IO_RESOURCE); - - if (!FullInformation) - return STATUS_NO_MEMORY; - - /* Get the Information */ - Status = ZwQueryKey(RootKeyHandle, KeyFullInformation, FullInformation, LenFullInformation, &LenFullInformation); - - /* Everything was fine */ - if (NT_SUCCESS(Status)) - { - /* Buffer needed for all the keys under this one */ - LenBasicInformation = FullInformation->MaxNameLen + sizeof(KEY_BASIC_INFORMATION); - - /* Allocate it */ - BasicInformation = ExAllocatePoolWithTag(PagedPool, LenBasicInformation, TAG_IO_RESOURCE); - } - - /* Deallocate the old Buffer */ - ExFreePoolWithTag(FullInformation, TAG_IO_RESOURCE); - - /* Try to find a Bus */ - for (BusLoop = 0; NT_SUCCESS(Status); BusLoop++) - { - /* Bus parameter was passed and number was matched */ - if ((Query->BusNumber) && (*(Query->BusNumber)) == *Bus) break; - - /* Enumerate the Key */ - Status = ZwEnumerateKey( - RootKeyHandle, - BusLoop, - KeyBasicInformation, - BasicInformation, - LenBasicInformation, - &LenKey); - - /* Everything enumerated */ - if (!NT_SUCCESS(Status)) break; - - /* What Bus are we going to go down? (only check if this is a Root Key) */ - if (KeyIsRoot) - { - if (wcsncmp(BasicInformation->Name, L"MultifunctionAdapter", BasicInformation->NameLength / 2) && - wcsncmp(BasicInformation->Name, L"EisaAdapter", BasicInformation->NameLength / 2) && - wcsncmp(BasicInformation->Name, L"TcAdapter", BasicInformation->NameLength / 2)) - { - /* Nothing found, check next */ + NTSTATUS Status; + ULONG BusLoop; + UNICODE_STRING SubRootRegName; + UNICODE_STRING BusString; + UNICODE_STRING SubBusString; + ULONG LenBasicInformation = 0; + ULONG LenFullInformation; + ULONG LenKeyFullInformation; + ULONG LenKey; + HANDLE SubRootKeyHandle; + PKEY_FULL_INFORMATION FullInformation; + PKEY_BASIC_INFORMATION BasicInformation = NULL; + OBJECT_ATTRIBUTES ObjectAttributes; + PKEY_VALUE_FULL_INFORMATION BusInformation[IoQueryDeviceMaxData] = + {NULL, NULL, NULL}; + + /* Retrieve the necessary buffer space */ + Status = ZwQueryKey(RootKeyHandle, + KeyFullInformation, + NULL, 0, + &LenFullInformation); + + if (!NT_SUCCESS(Status) && + (Status != STATUS_BUFFER_TOO_SMALL) && + (Status != STATUS_BUFFER_OVERFLOW)) + { + return Status; + } + + /* Allocate it */ + FullInformation = ExAllocatePoolWithTag(PagedPool, LenFullInformation, TAG_IO_RESOURCE); + + if (!FullInformation) + return STATUS_NO_MEMORY; + + /* Get the information */ + Status = ZwQueryKey(RootKeyHandle, + KeyFullInformation, + FullInformation, + LenFullInformation, + &LenFullInformation); + if (NT_SUCCESS(Status)) + { + /* Buffer needed for all the keys under this one */ + LenBasicInformation = FullInformation->MaxNameLen + sizeof(KEY_BASIC_INFORMATION); + + /* Allocate it */ + BasicInformation = ExAllocatePoolWithTag(PagedPool, LenBasicInformation, TAG_IO_RESOURCE); + } + + /* Deallocate the old buffer */ + ExFreePoolWithTag(FullInformation, TAG_IO_RESOURCE); + + /* Try to find a bus */ + for (BusLoop = 0; NT_SUCCESS(Status); BusLoop++) + { + /* Bus parameter was passed and number was matched */ + if (Query->BusNumber && (*(Query->BusNumber) == *Bus)) + break; + + /* Enumerate the Key */ + Status = ZwEnumerateKey(RootKeyHandle, + BusLoop, + KeyBasicInformation, + BasicInformation, + LenBasicInformation, + &LenKey); + + /* Stop if everything was enumerated */ + if (!NT_SUCCESS(Status)) + break; + + /* What bus are we going to go down? (only check if this is a root key) */ + if (KeyIsRoot) + { + if (wcsncmp(BasicInformation->Name, L"MultifunctionAdapter", BasicInformation->NameLength / sizeof(WCHAR)) && + wcsncmp(BasicInformation->Name, L"EisaAdapter", BasicInformation->NameLength / sizeof(WCHAR)) && + wcsncmp(BasicInformation->Name, L"TcAdapter", BasicInformation->NameLength / sizeof(WCHAR))) + { + /* Nothing found, check next */ + continue; + } + } + + /* Enumerate the bus */ + BusString.Buffer = BasicInformation->Name; + BusString.Length = (USHORT)BasicInformation->NameLength; + BusString.MaximumLength = (USHORT)BasicInformation->NameLength; + + /* Open a handle to the root registry key */ + InitializeObjectAttributes(&ObjectAttributes, + &BusString, + OBJ_CASE_INSENSITIVE, + RootKeyHandle, + NULL); + + Status = ZwOpenKey(&SubRootKeyHandle, KEY_READ, &ObjectAttributes); + + /* Go on if we failed */ + if (!NT_SUCCESS(Status)) continue; - } - } - - /* Enumerate the Bus. */ - BusString.Buffer = BasicInformation->Name; - BusString.Length = (USHORT)BasicInformation->NameLength; - BusString.MaximumLength = (USHORT)BasicInformation->NameLength; - - /* Open a handle to the Root Registry Key */ - InitializeObjectAttributes( - &ObjectAttributes, - &BusString, - OBJ_CASE_INSENSITIVE, - RootKeyHandle, - NULL); - - Status = ZwOpenKey(&SubRootKeyHandle, KEY_READ, &ObjectAttributes); - - /* Go on if we can't */ - if (!NT_SUCCESS(Status)) continue; - - /* Key opened. Create the path */ - SubRootRegName = RootKey; - RtlAppendUnicodeToString(&SubRootRegName, L"\\"); - RtlAppendUnicodeStringToString(&SubRootRegName, &BusString); - - if (!KeyIsRoot) - { - /* Parsing a SubBus-key */ - int SubBusLoop; - PWSTR Strings[3] = { - L"Identifier", - L"Configuration Data", - L"Component Information"}; - - for (SubBusLoop = 0; SubBusLoop < 3; SubBusLoop++) - { - /* Identifier String First */ - RtlInitUnicodeString(&SubBusString, Strings[SubBusLoop]); - - /* How much buffer space */ - ZwQueryValueKey(SubRootKeyHandle, &SubBusString, KeyValueFullInformation, NULL, 0, &LenKeyFullInformation); - /* Allocate it */ - BusInformation[SubBusLoop] = ExAllocatePoolWithTag(PagedPool, LenKeyFullInformation, TAG_IO_RESOURCE); - - /* Get the Information */ - Status = ZwQueryValueKey(SubRootKeyHandle, &SubBusString, KeyValueFullInformation, BusInformation[SubBusLoop], LenKeyFullInformation, &LenKeyFullInformation); - } - - if (NT_SUCCESS(Status)) - { - /* Do we have something */ - if (BusInformation[1] != NULL && - BusInformation[1]->DataLength != 0 && - /* Does it match what we want? */ - (((PCM_FULL_RESOURCE_DESCRIPTOR)((ULONG_PTR)BusInformation[1] + BusInformation[1]->DataOffset))->InterfaceType == *(Query->BusType))) + /* Key opened, create the path */ + SubRootRegName = RootKey; + RtlAppendUnicodeToString(&SubRootRegName, L"\\"); + RtlAppendUnicodeStringToString(&SubRootRegName, &BusString); + + if (!KeyIsRoot) + { + /* Parsing a sub-bus key */ + ULONG SubBusLoop; + for (SubBusLoop = 0; SubBusLoop < RTL_NUMBER_OF(IoDeviceInfoNames); SubBusLoop++) { - /* Found a bus */ - (*Bus)++; - - /* Is it the bus we wanted */ - if (Query->BusNumber == NULL || *(Query->BusNumber) == *Bus) - { - /* If we don't want Controller Information, we're done... call the callback */ - if (Query->ControllerType == NULL) - { - Status = Query->CalloutRoutine( - Query->Context, - &SubRootRegName, - *(Query->BusType), - *Bus, - BusInformation, - 0, - 0, - NULL, - 0, - 0, - NULL); - } else { - /* We want Controller Info...get it */ - Status = IopQueryDeviceDescription(Query, SubRootRegName, RootKeyHandle, *Bus, (PKEY_VALUE_FULL_INFORMATION*)BusInformation); - } - } + /* Identifier string first */ + RtlInitUnicodeString(&SubBusString, IoDeviceInfoNames[SubBusLoop]); + + /* Retrieve the necessary buffer space */ + ZwQueryValueKey(SubRootKeyHandle, + &SubBusString, + KeyValueFullInformation, + NULL, 0, + &LenKeyFullInformation); + + /* Allocate it */ + BusInformation[SubBusLoop] = ExAllocatePoolWithTag(PagedPool, LenKeyFullInformation, TAG_IO_RESOURCE); + + /* Get the information */ + Status = ZwQueryValueKey(SubRootKeyHandle, + &SubBusString, + KeyValueFullInformation, + BusInformation[SubBusLoop], + LenKeyFullInformation, + &LenKeyFullInformation); } - } - /* Free the allocated memory */ - for (SubBusLoop = 0; SubBusLoop < 3; SubBusLoop++) - { - if (BusInformation[SubBusLoop]) + if (NT_SUCCESS(Status)) { - ExFreePoolWithTag(BusInformation[SubBusLoop], TAG_IO_RESOURCE); - BusInformation[SubBusLoop] = NULL; + PKEY_VALUE_FULL_INFORMATION BusConfigData = + BusInformation[IoQueryDeviceConfigurationData]; + + /* Do we have something? */ + if (BusConfigData != NULL && + BusConfigData->DataLength != 0 && + /* Does it match what we want? */ + (((PCM_FULL_RESOURCE_DESCRIPTOR)((ULONG_PTR)BusConfigData + + BusConfigData->DataOffset))->InterfaceType == *(Query->BusType))) + { + /* Found a bus */ + (*Bus)++; + + /* Is it the bus we wanted? */ + if (Query->BusNumber == NULL || *(Query->BusNumber) == *Bus) + { + if (Query->ControllerType == NULL) + { + /* We don't want controller information: call the callback */ + Status = Query->CalloutRoutine(Query->Context, + &SubRootRegName, + *(Query->BusType), + *Bus, + BusInformation, + 0, + 0, + NULL, + 0, + 0, + NULL); + } + else + { + /* We want controller information: get it */ + Status = IopQueryDeviceDescription(Query, + SubRootRegName, + RootKeyHandle, + *Bus, + (PKEY_VALUE_FULL_INFORMATION*)BusInformation); + } + } + } } - } - /* Exit the Loop if we found the bus */ - if (Query->BusNumber != NULL && *(Query->BusNumber) == *Bus) - { - ZwClose(SubRootKeyHandle); - SubRootKeyHandle = NULL; - continue; - } - } + /* Free the allocated memory */ + for (SubBusLoop = 0; SubBusLoop < RTL_NUMBER_OF(IoDeviceInfoNames); SubBusLoop++) + { + if (BusInformation[SubBusLoop]) + { + ExFreePoolWithTag(BusInformation[SubBusLoop], TAG_IO_RESOURCE); + BusInformation[SubBusLoop] = NULL; + } + } - /* Enumerate the buses below us recursively if we haven't found the bus yet */ - Status = IopQueryBusDescription(Query, SubRootRegName, SubRootKeyHandle, Bus, !KeyIsRoot); + /* Exit the loop if we found the bus */ + if (Query->BusNumber && (*(Query->BusNumber) == *Bus)) + { + ZwClose(SubRootKeyHandle); + SubRootKeyHandle = NULL; + continue; + } + } + + /* Enumerate the buses below us recursively if we haven't found the bus yet */ + Status = IopQueryBusDescription(Query, SubRootRegName, SubRootKeyHandle, Bus, !KeyIsRoot); - /* Everything enumerated */ - if (Status == STATUS_NO_MORE_ENTRIES) Status = STATUS_SUCCESS; + /* Everything enumerated */ + if (Status == STATUS_NO_MORE_ENTRIES) Status = STATUS_SUCCESS; - ZwClose(SubRootKeyHandle); - SubRootKeyHandle = NULL; - } + ZwClose(SubRootKeyHandle); + SubRootKeyHandle = NULL; + } - /* Free the last remaining Allocated Memory */ - if (BasicInformation) - ExFreePoolWithTag(BasicInformation, TAG_IO_RESOURCE); + /* Free the last remaining allocated memory */ + if (BasicInformation) + ExFreePoolWithTag(BasicInformation, TAG_IO_RESOURCE); - return Status; + return Status; } NTSTATUS -NTAPI -IopFetchConfigurationInformation(OUT PWSTR * SymbolicLinkList, - IN GUID Guid, - IN ULONG ExpectedInterfaces, - IN PULONG Interfaces) +IopFetchConfigurationInformation( + _Out_ PWSTR* SymbolicLinkList, + _In_ GUID Guid, + _In_ ULONG ExpectedInterfaces, + _Out_ PULONG Interfaces) { NTSTATUS Status; - ULONG IntInterfaces = 0; - PWSTR IntSymbolicLinkList; + ULONG interfaces = 0; + PWSTR symbolicLinkList; /* Get the associated enabled interfaces with the given GUID */ Status = IoGetDeviceInterfaces(&Guid, NULL, 0, SymbolicLinkList); if (!NT_SUCCESS(Status)) { /* Zero output and leave */ - if (SymbolicLinkList != 0) - { - *SymbolicLinkList = 0; - } + if (SymbolicLinkList) + *SymbolicLinkList = NULL; return STATUS_UNSUCCESSFUL; } - IntSymbolicLinkList = *SymbolicLinkList; + symbolicLinkList = *SymbolicLinkList; /* Count the number of enabled interfaces by counting the number of symbolic links */ - while (*IntSymbolicLinkList != UNICODE_NULL) + while (*symbolicLinkList != UNICODE_NULL) { - IntInterfaces++; - IntSymbolicLinkList += wcslen(IntSymbolicLinkList) + (sizeof(UNICODE_NULL) / sizeof(WCHAR)); + interfaces++; + symbolicLinkList += (wcslen(symbolicLinkList) + 1); } /* Matching result will define the result */ - Status = (IntInterfaces >= ExpectedInterfaces) ? STATUS_SUCCESS : STATUS_UNSUCCESSFUL; + Status = (interfaces >= ExpectedInterfaces) ? STATUS_SUCCESS : STATUS_UNSUCCESSFUL; /* Finally, give back to the caller the number of found interfaces */ - *Interfaces = IntInterfaces; + *Interfaces = interfaces; return Status; } VOID -NTAPI -IopStoreSystemPartitionInformation(IN PUNICODE_STRING NtSystemPartitionDeviceName, - IN PUNICODE_STRING OsLoaderPathName) +IopStoreSystemPartitionInformation( + _In_ PUNICODE_STRING NtSystemPartitionDeviceName, + _In_ PUNICODE_STRING OsLoaderPathName) { NTSTATUS Status; UNICODE_STRING LinkTarget, KeyName; @@ -733,9 +812,7 @@ IopStoreSystemPartitionInformation(IN PUNICODE_STRING NtSystemPartitionDeviceNam LinkTarget.Buffer = LinkTargetBuffer; /* Query target */ - Status = ZwQuerySymbolicLinkObject(LinkHandle, - &LinkTarget, - NULL); + Status = ZwQuerySymbolicLinkObject(LinkHandle, &LinkTarget, NULL); /* We are done with symbolic link */ ObCloseHandle(LinkHandle, KernelMode); @@ -779,7 +856,7 @@ IopStoreSystemPartitionInformation(IN PUNICODE_STRING NtSystemPartitionDeviceNam return; } - /* Prepare first data writing... */ + /* Prepare first data writing */ RtlInitUnicodeString(&KeyName, L"SystemPartition"); /* Write SystemPartition value which is the target of the symbolic link */ @@ -794,7 +871,7 @@ IopStoreSystemPartitionInformation(IN PUNICODE_STRING NtSystemPartitionDeviceNam DPRINT("Failed writing SystemPartition value, Status=%lx\n", Status); } - /* Prepare for second data writing... */ + /* Prepare for second data writing */ RtlInitUnicodeString(&KeyName, L"OsLoaderPath"); /* Remove trailing slash if any (one slash only excepted) */ @@ -823,50 +900,70 @@ IopStoreSystemPartitionInformation(IN PUNICODE_STRING NtSystemPartitionDeviceNam /* PUBLIC FUNCTIONS ***********************************************************/ -/* - * @implemented - */ -PCONFIGURATION_INFORMATION NTAPI +/** + * @brief + * Returns a pointer to the I/O manager's global configuration + * information structure. + * + * This structure contains the current values for how many physical storage + * media, SCSI HBA, serial, and parallel devices have device objects created + * to represent them by drivers as they are loaded. + **/ +PCONFIGURATION_INFORMATION +NTAPI IoGetConfigurationInformation(VOID) { - return(&_SystemConfigurationInformation); + return &_SystemConfigurationInformation; } -/* +/** * @halfplemented - */ -NTSTATUS NTAPI -IoReportResourceUsage(PUNICODE_STRING DriverClassName, - PDRIVER_OBJECT DriverObject, - PCM_RESOURCE_LIST DriverList, - ULONG DriverListSize, - PDEVICE_OBJECT DeviceObject, - PCM_RESOURCE_LIST DeviceList, - ULONG DeviceListSize, - BOOLEAN OverrideConflict, - PBOOLEAN ConflictDetected) - /* - * FUNCTION: Reports hardware resources in the - * \Registry\Machine\Hardware\ResourceMap tree, so that a subsequently - * loaded driver cannot attempt to use the same resources. - * ARGUMENTS: - * DriverClassName - The class of driver under which the resource - * information should be stored. - * DriverObject - The driver object that was input to the - * DriverEntry. - * DriverList - Resources that claimed for the driver rather than - * per-device. - * DriverListSize - Size in bytes of the DriverList. - * DeviceObject - The device object for which resources should be - * claimed. - * DeviceList - List of resources which should be claimed for the - * device. - * DeviceListSize - Size of the per-device resource list in bytes. - * OverrideConflict - True if the resources should be cliamed - * even if a conflict is found. - * ConflictDetected - Points to a variable that receives TRUE if - * a conflict is detected with another driver. - */ + * + * @brief + * Reports hardware resources in the \Registry\Machine\Hardware\ResourceMap + * tree, so that a subsequently loaded driver cannot attempt to use the + * same resources. + * + * @param[in] DriverClassName + * The driver class under which the resource information should be stored. + * + * @param[in] DriverObject + * The driver object that was provided to the DriverEntry routine. + * + * @param[in] DriverList + * Resources claimed for the all the driver's devices, rather than per-device. + * + * @param[in] DriverListSize + * Size in bytes of the DriverList. + * + * @param[in] DeviceObject + * The device object for which resources should be claimed. + * + * @param[in] DeviceList + * List of resources that should be claimed for the device. + * + * @param[in] DeviceListSize + * Size of the per-device resource list in bytes. + * + * @param[in] OverrideConflict + * TRUE if the resources should be claimed even if a conflict is found. + * + * @param[out] ConflictDetected + * Points to a variable that receives TRUE if a conflict is detected + * with another driver. + **/ +NTSTATUS +NTAPI +IoReportResourceUsage( + _In_opt_ PUNICODE_STRING DriverClassName, + _In_ PDRIVER_OBJECT DriverObject, + _In_reads_bytes_opt_(DriverListSize) PCM_RESOURCE_LIST DriverList, + _In_opt_ ULONG DriverListSize, + _In_opt_ PDEVICE_OBJECT DeviceObject, + _In_reads_bytes_opt_(DeviceListSize) PCM_RESOURCE_LIST DeviceList, + _In_opt_ ULONG DeviceListSize, + _In_ BOOLEAN OverrideConflict, + _Out_ PBOOLEAN ConflictDetected) { NTSTATUS Status; PCM_RESOURCE_LIST ResourceList; @@ -908,13 +1005,13 @@ IoReportResourceUsage(PUNICODE_STRING DriverClassName, return STATUS_SUCCESS; } -NTSTATUS -NTAPI -IopLegacyResourceAllocation(IN ARBITER_REQUEST_SOURCE AllocationType, - IN PDRIVER_OBJECT DriverObject, - IN PDEVICE_OBJECT DeviceObject OPTIONAL, - IN PIO_RESOURCE_REQUIREMENTS_LIST ResourceRequirements, - IN OUT PCM_RESOURCE_LIST *AllocatedResources) +static NTSTATUS +IopLegacyResourceAllocation( + _In_ ARBITER_REQUEST_SOURCE AllocationType, + _In_ PDRIVER_OBJECT DriverObject, + _In_opt_ PDEVICE_OBJECT DeviceObject, + _In_opt_ PIO_RESOURCE_REQUIREMENTS_LIST ResourceRequirements, + _Inout_ PCM_RESOURCE_LIST* AllocatedResources) { NTSTATUS Status; @@ -924,7 +1021,7 @@ IopLegacyResourceAllocation(IN ARBITER_REQUEST_SOURCE AllocationType, { /* We can get there by calling IoAssignResources() with RequestedResources = NULL. * TODO: not sure what we should do, but we shouldn't crash. - * */ + */ UNIMPLEMENTED; return STATUS_NOT_IMPLEMENTED; } @@ -950,21 +1047,25 @@ IopLegacyResourceAllocation(IN ARBITER_REQUEST_SOURCE AllocationType, */ NTSTATUS NTAPI -IoAssignResources(IN PUNICODE_STRING RegistryPath, - IN PUNICODE_STRING DriverClassName, - IN PDRIVER_OBJECT DriverObject, - IN PDEVICE_OBJECT DeviceObject, - IN PIO_RESOURCE_REQUIREMENTS_LIST RequestedResources, - IN OUT PCM_RESOURCE_LIST* AllocatedResources) +IoAssignResources( + _In_ PUNICODE_STRING RegistryPath, + _In_opt_ PUNICODE_STRING DriverClassName, + _In_ PDRIVER_OBJECT DriverObject, + _In_opt_ PDEVICE_OBJECT DeviceObject, + _In_opt_ PIO_RESOURCE_REQUIREMENTS_LIST RequestedResources, + _Inout_ PCM_RESOURCE_LIST* AllocatedResources) { PDEVICE_NODE DeviceNode; + UNREFERENCED_PARAMETER(RegistryPath); + UNREFERENCED_PARAMETER(DriverClassName); + /* Do we have a DO? */ if (DeviceObject) { /* Get its device node */ DeviceNode = IopGetDeviceNode(DeviceObject); - if ((DeviceNode) && !(DeviceNode->Flags & DNF_LEGACY_RESOURCE_DEVICENODE)) + if (DeviceNode && !(DeviceNode->Flags & DNF_LEGACY_RESOURCE_DEVICENODE)) { /* New drivers should not call this API */ KeBugCheckEx(PNP_DETECTED_FATAL_ERROR, @@ -987,7 +1088,8 @@ IoAssignResources(IN PUNICODE_STRING RegistryPath, } /* Initialize output if given */ - if (AllocatedResources) *AllocatedResources = NULL; + if (AllocatedResources) + *AllocatedResources = NULL; /* Call internal helper function */ return IopLegacyResourceAllocation(ArbiterRequestLegacyAssigned, @@ -997,194 +1099,207 @@ IoAssignResources(IN PUNICODE_STRING RegistryPath, AllocatedResources); } -/* - * FUNCTION: - * Reads and returns Hardware information from the appropriate hardware registry key. +/** + * @brief + * Reads and returns Hardware information from the appropriate + * hardware registry key. * - * ARGUMENTS: - * BusType - MCA, ISA, EISA...specifies the Bus Type - * BusNumber - Which bus of above should be queried - * ControllerType - Specifices the Controller Type - * ControllerNumber - Which of the controllers to query. - * CalloutRoutine - Which function to call for each valid query. - * Context - Value to pass to the callback. + * @param[in] BusType + * Specifies the bus type, for example: MCA, ISA, EISA, etc. * - * RETURNS: - * Status + * @param[in] BusNumber + * The number of the specified bus type to query. * - * STATUS: - * @implemented - */ - -NTSTATUS NTAPI -IoQueryDeviceDescription(PINTERFACE_TYPE BusType OPTIONAL, - PULONG BusNumber OPTIONAL, - PCONFIGURATION_TYPE ControllerType OPTIONAL, - PULONG ControllerNumber OPTIONAL, - PCONFIGURATION_TYPE PeripheralType OPTIONAL, - PULONG PeripheralNumber OPTIONAL, - PIO_QUERY_DEVICE_ROUTINE CalloutRoutine, - PVOID Context) + * @param[in] ControllerType + * Specifies the controller type + * + * @param[in] ControllerNumber + * The number of the specified controller type to query. + * + * @param[in] CalloutRoutine + * A user-provided callback function to call for each valid query. + * + * @param[in] Context + * A callback-specific context value. + * + * @return A status code. + **/ +NTSTATUS +NTAPI +IoQueryDeviceDescription( + _In_opt_ PINTERFACE_TYPE BusType, + _In_opt_ PULONG BusNumber, + _In_opt_ PCONFIGURATION_TYPE ControllerType, + _In_opt_ PULONG ControllerNumber, + _In_opt_ PCONFIGURATION_TYPE PeripheralType, + _In_opt_ PULONG PeripheralNumber, + _In_ PIO_QUERY_DEVICE_ROUTINE CalloutRoutine, + _In_opt_ PVOID Context) { - NTSTATUS Status; - ULONG BusLoopNumber = -1; /* Root Bus */ - OBJECT_ATTRIBUTES ObjectAttributes; - UNICODE_STRING RootRegKey; - HANDLE RootRegHandle; - IO_QUERY Query; - - /* Set up the String */ - RootRegKey.Length = 0; - RootRegKey.MaximumLength = 2048; - RootRegKey.Buffer = ExAllocatePoolWithTag(PagedPool, RootRegKey.MaximumLength, TAG_IO_RESOURCE); - RtlAppendUnicodeToString(&RootRegKey, L"\\REGISTRY\\MACHINE\\HARDWARE\\DESCRIPTION\\SYSTEM"); - - /* Open a handle to the Root Registry Key */ - InitializeObjectAttributes( - &ObjectAttributes, - &RootRegKey, - OBJ_CASE_INSENSITIVE, - NULL, - NULL); - - Status = ZwOpenKey(&RootRegHandle, KEY_READ, &ObjectAttributes); - - if (NT_SUCCESS(Status)) - { - /* Use a helper function to loop though this key and get the info */ - Query.BusType = BusType; - Query.BusNumber = BusNumber; - Query.ControllerType = ControllerType; - Query.ControllerNumber = ControllerNumber; - Query.PeripheralType = PeripheralType; - Query.PeripheralNumber = PeripheralNumber; - Query.CalloutRoutine = CalloutRoutine; - Query.Context = Context; - Status = IopQueryBusDescription(&Query, RootRegKey, RootRegHandle, &BusLoopNumber, TRUE); - - /* Close registry */ - ZwClose(RootRegHandle); - } - - /* Free Memory */ - ExFreePoolWithTag(RootRegKey.Buffer, TAG_IO_RESOURCE); - - return Status; + NTSTATUS Status; + ULONG BusLoopNumber = -1; /* Root Bus */ + OBJECT_ATTRIBUTES ObjectAttributes; + UNICODE_STRING RootRegKey; + HANDLE RootRegHandle; + IO_QUERY Query; + + /* Set up the string */ + RootRegKey.Length = 0; + RootRegKey.MaximumLength = 2048; + RootRegKey.Buffer = ExAllocatePoolWithTag(PagedPool, RootRegKey.MaximumLength, TAG_IO_RESOURCE); + RtlAppendUnicodeToString(&RootRegKey, L"\\REGISTRY\\MACHINE\\HARDWARE\\DESCRIPTION\\SYSTEM"); + + /* Open a handle to the Root Registry Key */ + InitializeObjectAttributes(&ObjectAttributes, + &RootRegKey, + OBJ_CASE_INSENSITIVE, + NULL, + NULL); + + Status = ZwOpenKey(&RootRegHandle, KEY_READ, &ObjectAttributes); + + if (NT_SUCCESS(Status)) + { + /* Use a helper function to loop though this key and get the information */ + Query.BusType = BusType; + Query.BusNumber = BusNumber; + Query.ControllerType = ControllerType; + Query.ControllerNumber = ControllerNumber; + Query.PeripheralType = PeripheralType; + Query.PeripheralNumber = PeripheralNumber; + Query.CalloutRoutine = CalloutRoutine; + Query.Context = Context; + Status = IopQueryBusDescription(&Query, + RootRegKey, + RootRegHandle, + &BusLoopNumber, + TRUE); + + /* Close registry key */ + ZwClose(RootRegHandle); + } + + /* Cleanup */ + ExFreePoolWithTag(RootRegKey.Buffer, TAG_IO_RESOURCE); + + return Status; } -/* - * @implemented - */ -NTSTATUS NTAPI -IoReportHalResourceUsage(PUNICODE_STRING HalDescription, - PCM_RESOURCE_LIST RawList, - PCM_RESOURCE_LIST TranslatedList, - ULONG ListSize) -/* - * FUNCTION: - * Reports hardware resources of the HAL in the - * \Registry\Machine\Hardware\ResourceMap tree. - * ARGUMENTS: - * HalDescription: Descriptive name of the HAL. - * RawList: List of raw (bus specific) resources which should be - * claimed for the HAL. - * TranslatedList: List of translated (system wide) resources which - * should be claimed for the HAL. - * ListSize: Size in bytes of the raw and translated resource lists. - * Both lists have the same size. - * RETURNS: - * Status. - */ +/** + * @brief + * Reports hardware resources of the HAL in the + * \Registry\Machine\Hardware\ResourceMap tree. + * + * @param[in] HalName + * Descriptive name of the HAL. + * + * @param[in] RawResourceList + * List of raw (bus specific) resources which should be claimed + * for the HAL. + * + * @param[in] TranslatedResourceList + * List of translated (system wide) resources which should be claimed + * for the HAL. + * + * @param[in] ResourceListSize + * Size in bytes of the raw and translated resource lists. + * Both lists have the same size. + * + * @return A status code. + **/ +NTSTATUS +NTAPI +IoReportHalResourceUsage( + _In_ PUNICODE_STRING HalName, + _In_ PCM_RESOURCE_LIST RawResourceList, + _In_ PCM_RESOURCE_LIST TranslatedResourceList, + _In_ ULONG ResourceListSize) { - OBJECT_ATTRIBUTES ObjectAttributes; - UNICODE_STRING Name; - ULONG Disposition; - NTSTATUS Status; - HANDLE ResourcemapKey; - HANDLE HalKey; - HANDLE DescriptionKey; - - /* Open/Create 'RESOURCEMAP' key. */ - RtlInitUnicodeString(&Name, - L"\\Registry\\Machine\\HARDWARE\\RESOURCEMAP"); - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE | OBJ_OPENIF, - 0, - NULL); - Status = ZwCreateKey(&ResourcemapKey, - KEY_ALL_ACCESS, - &ObjectAttributes, - 0, - NULL, - REG_OPTION_VOLATILE, - &Disposition); - if (!NT_SUCCESS(Status)) - return(Status); - - /* Open/Create 'Hardware Abstraction Layer' key */ - RtlInitUnicodeString(&Name, - L"Hardware Abstraction Layer"); - InitializeObjectAttributes(&ObjectAttributes, - &Name, - OBJ_CASE_INSENSITIVE | OBJ_OPENIF, - ResourcemapKey, - NULL); - Status = ZwCreateKey(&HalKey, - KEY_ALL_ACCESS, - &ObjectAttributes, - 0, - NULL, - REG_OPTION_VOLATILE, - &Disposition); - ZwClose(ResourcemapKey); - if (!NT_SUCCESS(Status)) - return(Status); - - /* Create 'HalDescription' key */ - InitializeObjectAttributes(&ObjectAttributes, - HalDescription, - OBJ_CASE_INSENSITIVE, - HalKey, - NULL); - Status = ZwCreateKey(&DescriptionKey, - KEY_ALL_ACCESS, - &ObjectAttributes, - 0, - NULL, - REG_OPTION_VOLATILE, - &Disposition); - ZwClose(HalKey); - if (!NT_SUCCESS(Status)) - return(Status); - - /* Add '.Raw' value. */ - RtlInitUnicodeString(&Name, - L".Raw"); - Status = ZwSetValueKey(DescriptionKey, - &Name, - 0, - REG_RESOURCE_LIST, - RawList, - ListSize); - if (!NT_SUCCESS(Status)) + NTSTATUS Status; + OBJECT_ATTRIBUTES ObjectAttributes; + UNICODE_STRING Name; + ULONG Disposition; + HANDLE ResourceMapKey; + HANDLE HalKey; + HANDLE DescriptionKey; + + /* Open/Create 'RESOURCEMAP' key */ + RtlInitUnicodeString(&Name, L"\\Registry\\Machine\\HARDWARE\\RESOURCEMAP"); + InitializeObjectAttributes(&ObjectAttributes, + &Name, + OBJ_CASE_INSENSITIVE | OBJ_OPENIF, + 0, + NULL); + Status = ZwCreateKey(&ResourceMapKey, + KEY_ALL_ACCESS, + &ObjectAttributes, + 0, + NULL, + REG_OPTION_VOLATILE, + &Disposition); + if (!NT_SUCCESS(Status)) + return Status; + + /* Open/Create 'Hardware Abstraction Layer' key */ + RtlInitUnicodeString(&Name, L"Hardware Abstraction Layer"); + InitializeObjectAttributes(&ObjectAttributes, + &Name, + OBJ_CASE_INSENSITIVE | OBJ_OPENIF, + ResourceMapKey, + NULL); + Status = ZwCreateKey(&HalKey, + KEY_ALL_ACCESS, + &ObjectAttributes, + 0, + NULL, + REG_OPTION_VOLATILE, + &Disposition); + ZwClose(ResourceMapKey); + if (!NT_SUCCESS(Status)) + return Status; + + /* Create 'HalName' key */ + InitializeObjectAttributes(&ObjectAttributes, + HalName, + OBJ_CASE_INSENSITIVE, + HalKey, + NULL); + Status = ZwCreateKey(&DescriptionKey, + KEY_ALL_ACCESS, + &ObjectAttributes, + 0, + NULL, + REG_OPTION_VOLATILE, + &Disposition); + ZwClose(HalKey); + if (!NT_SUCCESS(Status)) + return Status; + + /* Add '.Raw' value */ + RtlInitUnicodeString(&Name, L".Raw"); + Status = ZwSetValueKey(DescriptionKey, + &Name, + 0, + REG_RESOURCE_LIST, + RawResourceList, + ResourceListSize); + if (!NT_SUCCESS(Status)) { - ZwClose(DescriptionKey); - return(Status); + ZwClose(DescriptionKey); + return Status; } - /* Add '.Translated' value. */ - RtlInitUnicodeString(&Name, - L".Translated"); - Status = ZwSetValueKey(DescriptionKey, - &Name, - 0, - REG_RESOURCE_LIST, - TranslatedList, - ListSize); - ZwClose(DescriptionKey); - - return(Status); + /* Add '.Translated' value */ + RtlInitUnicodeString(&Name, L".Translated"); + Status = ZwSetValueKey(DescriptionKey, + &Name, + 0, + REG_RESOURCE_LIST, + TranslatedResourceList, + ResourceListSize); + ZwClose(DescriptionKey); + + return Status; } /* EOF */ diff --git a/sdk/include/xdk/iofuncs.h b/sdk/include/xdk/iofuncs.h index 534edfd66b4..e6e431d26a7 100644 --- a/sdk/include/xdk/iofuncs.h +++ b/sdk/include/xdk/iofuncs.h @@ -1492,7 +1492,7 @@ IoQueryDeviceDescription( _In_opt_ PCONFIGURATION_TYPE PeripheralType, _In_opt_ PULONG PeripheralNumber, _In_ PIO_QUERY_DEVICE_ROUTINE CalloutRoutine, - _Inout_opt_ PVOID Context); + _In_opt_ PVOID Context); _IRQL_requires_max_(APC_LEVEL) NTKERNELAPI

1 0

[reactos] 05/07: [DDK] Add some documentation about the VIDEO_HARDWARE_CONFIGURATION_DATA structure.
by Hermès Bélusca-Maïto 04 Jun '23

04 Jun '23

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=509359b3ec9d438b9e85e… commit 509359b3ec9d438b9e85e3198a6709e8a16c29ad Author: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> AuthorDate: Sat Jun 3 22:51:28 2023 +0200 Commit: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> CommitDate: Sun Jun 4 21:40:06 2023 +0200 [DDK] Add some documentation about the VIDEO_HARDWARE_CONFIGURATION_DATA structure. --- sdk/include/ddk/video.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/sdk/include/ddk/video.h b/sdk/include/ddk/video.h index 1500e03bb9b..d4f32002b15 100644 --- a/sdk/include/ddk/video.h +++ b/sdk/include/ddk/video.h @@ -551,6 +551,14 @@ typedef enum _DMA_FLAGS { VideoPortDmaInitOnly } DMA_FLAGS; +/* + * Data returned with VpControllerData. + * + * The first two fields, InterfaceType and BusNumber, are common + * with the CM_FULL_RESOURCE_DESCRIPTOR header. + * The other fields are of legacy layout, instead of the newer + * CM_PARTIAL_RESOURCE_LIST one. + */ typedef struct _VIDEO_HARDWARE_CONFIGURATION_DATA { INTERFACE_TYPE InterfaceType; ULONG BusNumber;

1 0

[reactos] 04/07: [DDK] Correct PERF_CONFIGURATION_DATA definition.
by Hermès Bélusca-Maïto 04 Jun '23

04 Jun '23

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=2e305b251b6bc713bb102… commit 2e305b251b6bc713bb1023bd6a14f3405718524d Author: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> AuthorDate: Sat Jun 3 22:50:59 2023 +0200 Commit: Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org> CommitDate: Sun Jun 4 21:40:05 2023 +0200 [DDK] Correct PERF_CONFIGURATION_DATA definition. --- sdk/include/ddk/storport.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sdk/include/ddk/storport.h b/sdk/include/ddk/storport.h index 7941ee9fab0..901d761cc88 100644 --- a/sdk/include/ddk/storport.h +++ b/sdk/include/ddk/storport.h @@ -2117,7 +2117,8 @@ typedef struct _PERF_CONFIGURATION_DATA ULONG Size; ULONG Flags; ULONG ConcurrentChannels; - ULONG FirstRedirectionMessageNumber, LastRedirectionMessageNumber; + ULONG FirstRedirectionMessageNumber; + ULONG LastRedirectionMessageNumber; ULONG DeviceNode; ULONG Reserved; PGROUP_AFFINITY MessageTargets;

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

Ros-diffs