Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split OSREPORT logging type #9360

Merged
merged 1 commit into from Dec 26, 2020
Merged

Conversation

Minty-Meeo
Copy link
Member

The enumerated LOG_TYPE "OSREPORT" is currently used in both EXI_DeviceIPL.cpp and HLE_OS.cpp. In many games, the multitude of game functions detected by HLE_OS.cpp for OSREPORT logging results in poor log readability. This Pull Request remedies that by adding a new enumerated LOG_TYPE "OSREPORT_HLE" for log usage in HLE_OS.cpp.

In the future, further changing how logging in HLE_OS.cpp works may be desirable. As it is, game functions are detected that send a single character to the log. This is a major source of poor readability.

The enumerated LOG_TYPE "OSREPORT" is currently used in both EXI_DeviceIPL.cpp and HLE_OS.cpp.  In many games, the multitude of game functions detected by HLE_OS.cpp for OSREPORT logging results in poor log readability.  This Pull Request remedies that by adding a new enumerated LOG_TYPE "OSREPORT_HLE" for log usage in HLE_OS.cpp.

In the future, further changing how logging in HLE_OS.cpp works may be desirable.  As it is, game functions are detected that send a single character to the log.  This is a major source of poor readability.
@Pokechu22
Copy link
Contributor

IMO it might be better to create a new category for EXI_DeviceIPL and use that for everything that's logged there, rather than leaving OSREPORT for just the EXI logs. Though, that could make things a bit confusing if you specifically want the EXI OSReport logs.

@Minty-Meeo
Copy link
Member Author

Minty-Meeo commented Dec 25, 2020

I left the original enumerated LOG_TYPE "OSREPORT" as is to minimally effect people's existing log configuration and existing code. In the GUI, however, the toggle is now named OSReport EXI. I'm not strongly opposed to changing it, these are just my thoughts.

Copy link
Contributor

@sepalani sepalani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR LGTM.

Some remarks to keep in mind:

  • The apploader requires an HLE OSReport, so the apploader messages will go through OSReport HLE
  • This point is wrong (that send a single character to the log) and just means you patched the wrong function which might be a signature false-positive, a stubbed function or the game literally sends one character at a time through the log

@leoetlino
Copy link
Member

Yeah I think it makes more sense to keep EXI OSReport in OSREPORT...

@leoetlino leoetlino merged commit d2f9991 into dolphin-emu:master Dec 26, 2020
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
4 participants