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

remove --backend-aggressive-opts and all the related code #7

Merged
merged 1 commit into from
Aug 3, 2024

Conversation

2lambda123
Copy link
Owner

@2lambda123 2lambda123 commented Aug 3, 2024

Description

Related Issue

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Chore (non-breaking change that does not add functionality or fix an issue)

Checklist:

  • I have read the Code of Conduct
  • I have updated the documentation accordingly.
  • All commits are GPG signed

Summary by Sourcery

Remove the --backend-aggressive-opts flag and all related code, including the aggressive optimizers and their associated configurations and references.

Copy link

Unable to locate .performanceTestingBot config file

Copy link

cr-gpt bot commented Aug 3, 2024

Seems you are using me but didn't get OPENAI_API_KEY seted in Variables/Secrets for this repo. you could follow readme for more information

Copy link

quine-bot bot commented Aug 3, 2024

👋 Figuring out if a PR is useful is hard, hopefully this will help.

  • @2lambda123 has been on GitHub since 2019 and in that time has had 2455 public PRs merged
  • Don't you recognize them? They've been here before 🎉
  • Here's a good example of their work: HeyGenClone
  • From looking at their profile, they seem to be good with C++ and Python.

Their most recently public accepted PR is: #5

Copy link

Processing PR updates...

@labels-and-badges labels-and-badges bot added NO JIRA This PR does not have a Jira Ticket PR:size/L Denotes a Pull Request that changes 100-499 lines. labels Aug 3, 2024
Copy link

git-greetings bot commented Aug 3, 2024

Thanks @2lambda123 for opening this PR!

For COLLABORATOR only :

  • To add labels, comment on the issue
    /label add label1,label2,label3

  • To remove labels, comment on the issue
    /label remove label1,label2,label3

Copy link

@gitginie gitginie bot left a comment

Choose a reason for hiding this comment

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

@2lambda123
Thank you for your contribution to this repository! We appreciate your effort in opening pull request.
Happy coding!

Copy link

sourcery-ai bot commented Aug 3, 2024

Reviewer's Guide by Sourcery

This pull request removes the --backend-aggressive-opts option and all related code. This includes the removal of aggressive optimizer classes, configuration parameters, and command-line option handling. The changes span multiple files, including the optimizer manager, configuration handling, and build scripts.

File-Level Changes

Files Changes
src/llvmir2hll/optimizer/optimizer_manager.cpp
include/retdec/llvmir2hll/optimizer/optimizer_manager.h
Removed all references to aggressive optimizations from the OptimizerManager class and its implementation.
src/config/parameters.cpp
include/retdec/config/parameters.h
src/retdec-decompiler/decompiler-config.json
Removed backendAggressiveOpts configuration and related methods.
src/llvmir2hll/llvmir2hll.cpp
include/retdec/llvmir2hll/llvmir2hll.h
Removed methods related to determining the type of optimizations to run.
src/retdec-decompiler/retdec-decompiler.cpp Removed handling and documentation of --backend-aggressive-opts command-line option.
src/llvmir2hll/CMakeLists.txt
src/llvmir2hll/optimizer/optimizers/aggressive_deref_optimizer.cpp
src/llvmir2hll/optimizer/optimizers/aggressive_global_to_local_optimizer.cpp
include/retdec/llvmir2hll/optimizer/optimizers/aggressive_deref_optimizer.h
include/retdec/llvmir2hll/optimizer/optimizers/aggressive_global_to_local_optimizer.h
Removed aggressive optimizer source and header files from the build and deleted the files.

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

git-greetings bot commented Aug 3, 2024

PR Details of @2lambda123 in avast-retdec :

OPEN CLOSED TOTAL
2 5 7

Copy link

coderabbitai bot commented Aug 3, 2024

Important

Review skipped

Auto reviews are limited to specific labels.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@2lambda123 2lambda123 merged commit cf0b91d into master Aug 3, 2024
16 of 27 checks passed
Comment on lines 508 to 513
serdes::serializeBool(writer, JSON_backendEmitCfg, isBackendEmitCfg());
serdes::serializeBool(writer, JSON_backendEmitCg, isBackendEmitCg());
serdes::serializeBool(writer, JSON_detectStaticCode, isDetectStaticCode());
serdes::serializeBool(writer, JSON_backendAggressiveOpts, isBackendAggressiveOpts());
serdes::serializeBool(writer, JSON_backendKeepAllBrackets, isBackendKeepAllBrackets());
serdes::serializeBool(writer, JSON_backendKeepLibraryFuncs, isBackendKeepLibraryFuncs());
serdes::serializeBool(writer, JSON_backendNoTimeVaryingInfo, isBackendNoTimeVaryingInfo());

Choose a reason for hiding this comment

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

The serdes::serializeBool function calls are repeated multiple times with similar parameters. This repetition can lead to code bloat and makes the code harder to maintain. Consider refactoring these calls into a loop or a helper function to improve maintainability and reduce redundancy.

Comment on lines 576 to 581
setIsBackendNoOpts( serdes::deserializeBool(val, JSON_backendNoOpts, false) );
setIsBackendEmitCfg( serdes::deserializeBool(val, JSON_backendEmitCfg, false) );
setIsBackendEmitCg( serdes::deserializeBool(val, JSON_backendEmitCg, false) );
setIsBackendAggressiveOpts( serdes::deserializeBool(val, JSON_backendAggressiveOpts, false) );
setIsBackendKeepAllBrackets( serdes::deserializeBool(val, JSON_backendKeepAllBrackets, false) );
setIsBackendKeepLibraryFuncs( serdes::deserializeBool(val, JSON_backendKeepLibraryFuncs, false) );
setIsBackendNoTimeVaryingInfo( serdes::deserializeBool(val, JSON_backendNoTimeVaryingInfo, false) );

Choose a reason for hiding this comment

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

The serdes::deserializeBool function calls are repeated multiple times with similar parameters. This repetition can lead to code bloat and makes the code harder to maintain. Consider refactoring these calls into a loop or a helper function to improve maintainability and reduce redundancy.

Comment on lines 195 to 200
Log::phase("alias analysis [" + aliasAnalysis->getId() + "]");
initAliasAnalysis();

Log::phase("optimizations [" + getTypeOfRunOptimizations() + "]");
Log::phase("optimizations");
runOptimizations();
}

Choose a reason for hiding this comment

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

The initAliasAnalysis and runOptimizations functions are called without any error handling. If these functions can fail or throw exceptions, it would be prudent to handle such cases to ensure the program can either recover gracefully or provide meaningful error messages.

Recommended Solution: Implement error handling for initAliasAnalysis and runOptimizations to manage potential failures or exceptions.

Comment on lines 116 to 125
OptimizerManager::OptimizerManager(const StringSet &enabledOpts,
const StringSet &disabledOpts, ShPtr<HLLWriter> hllWriter,
ShPtr<ValueAnalysis> va, ShPtr<CallInfoObtainer> cio,
ShPtr<ArithmExprEvaluator> arithmExprEvaluator,
bool enableAggressiveOpts, bool enableDebug):
ShPtr<ArithmExprEvaluator> arithmExprEvaluator, bool enableDebug):
enabledOpts(trimOptimizerSuffix(enabledOpts)),
disabledOpts(trimOptimizerSuffix(disabledOpts)),
hllWriter(hllWriter), va(va), cio(cio),
arithmExprEvaluator(arithmExprEvaluator),
enableAggressiveOpts(enableAggressiveOpts), enableDebug(enableDebug),
enableDebug(enableDebug),
recoverFromOutOfMemory(true), backendRunOpts() {

Choose a reason for hiding this comment

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

The constructor of OptimizerManager initializes several shared pointers (hllWriter, va, cio, arithmExprEvaluator) without checking if they are valid (non-null). Although PRECONDITION_NON_NULL is used, it is better to handle these cases explicitly to avoid potential null pointer dereferences.

Recommendation: Add explicit checks for the validity of these shared pointers and handle the error cases appropriately, possibly by throwing an exception or using an assertion.

Comment on lines 268 to 269
return enabledOpts.empty();
}

Choose a reason for hiding this comment

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

The function isEnabled() returns true if enabledOpts is empty. This could lead to unintended behavior if the caller expects specific optimizations to be enabled but none are provided.

Recommendation: Consider adding a warning or error message when enabledOpts is empty to inform the user that no optimizations will be run. This can help in debugging and ensuring that the function behaves as expected.

Comment on lines 438 to 443
{
params.setIsBackendEmitCg(true);
}
else if (isParam(i, "", "--backend-aggressive-opts"))
{
params.setIsBackendAggressiveOpts(true);
}
else if (isParam(i, "", "--backend-keep-all-brackets"))
{
params.setIsBackendKeepAllBrackets(true);

Choose a reason for hiding this comment

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

The isParam function is used to check for command-line parameters, but there is no error handling for unrecognized parameters. This could lead to silent failures or unexpected behavior.

Recommendation: Implement a default case or error handling mechanism to catch unrecognized parameters and provide feedback to the user.

Comment on lines 650 to 655
[--backend-no-opts] Disables backend optimizations.
[--backend-emit-cfg] Emits a CFG for each function in the backend IR (in the .dot format).
[--backend-emit-cg] Emits a CG for the decompiled module in the backend IR (in the .dot format).
[--backend-aggressive-opts] Enables aggressive optimizations.
[--backend-keep-all-brackets] Keeps all brackets in the generated code.
[--backend-keep-library-funcs] Keep functions from standard libraries.
[--backend-no-time-varying-info] Do not emit time-varying information, like dates.

Choose a reason for hiding this comment

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

The command-line options are documented, but there is no validation to ensure that mutually exclusive options are not used together. For example, --backend-no-opts and --backend-emit-cfg might conflict.

Recommendation: Add validation logic to check for mutually exclusive options and provide appropriate error messages to the user.

Copy link

@gitginie gitginie bot left a comment

Choose a reason for hiding this comment

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

@2lambda123
Thank you for your contribution to this repository! We appreciate your effort in closing pull request.
Happy coding!

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @2lambda123 - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Could you provide more context on why these aggressive optimizations are being removed? Understanding the rationale behind this change would be helpful.
  • Have you conducted any performance benchmarks to assess the impact of removing these optimizations? If so, could you share the results?
  • The PR description is quite minimal for such a significant change. Please update it with more details about the motivation, potential impacts, and any relevant background information.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

Copy link

codeautopilot bot commented Aug 3, 2024

PR summary

This Pull Request removes the --backend-aggressive-opts option and all related code from the project. The purpose of this change is to simplify the codebase by eliminating an option that enables aggressive optimizations, which are no longer deemed necessary or beneficial. The impact of this change is a cleaner and more maintainable codebase, with fewer configuration options for users to manage.

Suggestion

Consider updating the documentation to reflect the removal of the --backend-aggressive-opts option, ensuring that users are aware of this change and its implications. Additionally, verify that any dependent systems or scripts that might use this option are updated accordingly.

Disclaimer: This comment was entirely generated using AI. Be aware that the information provided may be incorrect.

Current plan usage: 8.74%

Have feedback or need help?
Discord
Documentation
[email protected]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NO JIRA This PR does not have a Jira Ticket PR:size/L Denotes a Pull Request that changes 100-499 lines. size/L
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants